Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetIdentityVerificationSessions

Contains the different functions to run the operation getIdentityVerificationSessions

6 types
4 values

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourceGetIdentityVerificationSessions.hs

valuegetIdentityVerificationSessions

:: MonadHTTP m
=> GetIdentityVerificationSessionsParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetIdentityVerificationSessionsResponse)
Monadic computation which returns the result of the operation

GET /v1/identity/verification_sessions

<p>Returns a list of VerificationSessions</p>

datadata GetIdentityVerificationSessionsParameters

Defines the object schema located at paths./v1/identity/verification_sessions.GET.parameters in the specification.

Constructors

GetIdentityVerificationSessionsParameters
- getIdentityVerificationSessionsParametersQueryCreated :: Maybe GetIdentityVerificationSessionsParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
- getIdentityVerificationSessionsParametersQueryEndingBefore :: Maybe Text
  queryEnding_before: Represents the parameter named 'ending_before'
  A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
  Constraints:
  - Maximum length of 5000
- getIdentityVerificationSessionsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getIdentityVerificationSessionsParametersQueryLimit :: Maybe Int
  queryLimit: Represents the parameter named 'limit'
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- getIdentityVerificationSessionsParametersQueryStartingAfter :: Maybe Text
  queryStarting_after: Represents the parameter named 'starting_after'
  A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
  Constraints:
  - Maximum length of 5000
- getIdentityVerificationSessionsParametersQueryStatus :: Maybe GetIdentityVerificationSessionsParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return VerificationSessions with this status. Learn more about the lifecycle of sessions.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIdentityVerificationSessionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
Show GetIdentityVerificationSessionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
FromJSON GetIdentityVerificationSessionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
ToJSON GetIdentityVerificationSessionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions

valuemkGetIdentityVerificationSessionsParameters :: GetIdentityVerificationSessionsParameters

Create a new GetIdentityVerificationSessionsParameters with all required fields.

datadata GetIdentityVerificationSessionsParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/identity/verification_sessions.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetIdentityVerificationSessionsParametersQueryCreated'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIdentityVerificationSessionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
Show GetIdentityVerificationSessionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
FromJSON GetIdentityVerificationSessionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
ToJSON GetIdentityVerificationSessionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions

value

mkGetIdentityVerificationSessionsParametersQueryCreated'OneOf1 :: GetIdentityVerificationSessionsParametersQueryCreated'OneOf1

Create a new GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 with all required fields.

datadata GetIdentityVerificationSessionsParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/identity/verification_sessions.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetIdentityVerificationSessionsParametersQueryCreated'GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 GetIdentityVerificationSessionsParametersQueryCreated'OneOf1
GetIdentityVerificationSessionsParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIdentityVerificationSessionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
Show GetIdentityVerificationSessionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
FromJSON GetIdentityVerificationSessionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
ToJSON GetIdentityVerificationSessionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions

datadata GetIdentityVerificationSessionsParametersQueryStatus'

Defines the enum schema located at paths./v1/identity/verification_sessions.GET.parameters.properties.queryStatus in the specification.

Represents the parameter named 'status'

Only return VerificationSessions with this status. Learn more about the lifecycle of sessions.

Constructors

GetIdentityVerificationSessionsParametersQueryStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetIdentityVerificationSessionsParametersQueryStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetIdentityVerificationSessionsParametersQueryStatus'EnumCanceled
Represents the JSON value "canceled"
GetIdentityVerificationSessionsParametersQueryStatus'EnumProcessing
Represents the JSON value "processing"
GetIdentityVerificationSessionsParametersQueryStatus'EnumRequiresInput
Represents the JSON value "requires_input"
GetIdentityVerificationSessionsParametersQueryStatus'EnumVerified
Represents the JSON value "verified"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIdentityVerificationSessionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
Show GetIdentityVerificationSessionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
FromJSON GetIdentityVerificationSessionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
ToJSON GetIdentityVerificationSessionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions

datadata GetIdentityVerificationSessionsResponse

Represents a response of the operation getIdentityVerificationSessions.

The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), GetIdentityVerificationSessionsResponseError is used.

Constructors

GetIdentityVerificationSessionsResponseError String
Means either no matching case available or a parse error
GetIdentityVerificationSessionsResponse200 GetIdentityVerificationSessionsResponseBody200
Successful response.
GetIdentityVerificationSessionsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetIdentityVerificationSessionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
Show GetIdentityVerificationSessionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions

datadata GetIdentityVerificationSessionsResponseBody200

Defines the object schema located at paths./v1/identity/verification_sessions.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetIdentityVerificationSessionsResponseBody200
- getIdentityVerificationSessionsResponseBody200Data :: [Identity'verificationSession]
  data
- getIdentityVerificationSessionsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getIdentityVerificationSessionsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/identity/verification_sessions'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIdentityVerificationSessionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
Show GetIdentityVerificationSessionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
FromJSON GetIdentityVerificationSessionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions
ToJSON GetIdentityVerificationSessionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIdentityVerificationSessions

valuemkGetIdentityVerificationSessionsResponseBody200

:: [Identity'verificationSession]
getIdentityVerificationSessionsResponseBody200Data
-> Bool
getIdentityVerificationSessionsResponseBody200HasMore
-> Text
getIdentityVerificationSessionsResponseBody200Url
-> GetIdentityVerificationSessionsResponseBody200

Create a new GetIdentityVerificationSessionsResponseBody200 with all required fields.