Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetIdentityVerificationSessions

Description

Contains the different functions to run the operation getIdentityVerificationSessions

Synopsis

getIdentityVerificationSessions :: forall m. MonadHTTP m => GetIdentityVerificationSessionsParameters -> ClientT m (Response GetIdentityVerificationSessionsResponse)
data GetIdentityVerificationSessionsParameters = GetIdentityVerificationSessionsParameters {
}
mkGetIdentityVerificationSessionsParameters :: GetIdentityVerificationSessionsParameters
data GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 = GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 {
}
mkGetIdentityVerificationSessionsParametersQueryCreated'OneOf1 :: GetIdentityVerificationSessionsParametersQueryCreated'OneOf1
data GetIdentityVerificationSessionsParametersQueryCreated'Variants
- = GetIdentityVerificationSessionsParametersQueryCreated'GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 GetIdentityVerificationSessionsParametersQueryCreated'OneOf1
- | GetIdentityVerificationSessionsParametersQueryCreated'Int Int
data GetIdentityVerificationSessionsParametersQueryStatus'
data GetIdentityVerificationSessionsResponse
data GetIdentityVerificationSessionsResponseBody200 = GetIdentityVerificationSessionsResponseBody200 {
}
mkGetIdentityVerificationSessionsResponseBody200 :: [Identity'verificationSession] -> Bool -> Text -> GetIdentityVerificationSessionsResponseBody200

Documentation

getIdentityVerificationSessions Source #

Arguments

:: forall m. 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>

data GetIdentityVerificationSessionsParameters Source #

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

Constructors

GetIdentityVerificationSessionsParameters

Fields

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.

Instances

Instances details

Eq GetIdentityVerificationSessionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods (==) :: GetIdentityVerificationSessionsParameters -> GetIdentityVerificationSessionsParameters -> Bool # (/=) :: GetIdentityVerificationSessionsParameters -> GetIdentityVerificationSessionsParameters -> Bool #
Show GetIdentityVerificationSessionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods showsPrec :: Int -> GetIdentityVerificationSessionsParameters -> ShowS # show :: GetIdentityVerificationSessionsParameters -> String # showList :: [GetIdentityVerificationSessionsParameters] -> ShowS #
ToJSON GetIdentityVerificationSessionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods toJSON :: GetIdentityVerificationSessionsParameters -> Value # toEncoding :: GetIdentityVerificationSessionsParameters -> Encoding # toJSONList :: [GetIdentityVerificationSessionsParameters] -> Value # toEncodingList :: [GetIdentityVerificationSessionsParameters] -> Encoding #
FromJSON GetIdentityVerificationSessionsParameters Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods parseJSON :: Value -> Parser GetIdentityVerificationSessionsParameters # parseJSONList :: Value -> Parser [GetIdentityVerificationSessionsParameters] #

mkGetIdentityVerificationSessionsParameters :: GetIdentityVerificationSessionsParameters Source #

Create a new GetIdentityVerificationSessionsParameters with all required fields.

data GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 Source #

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

Constructors

GetIdentityVerificationSessionsParametersQueryCreated'OneOf1
Fields getIdentityVerificationSessionsParametersQueryCreated'OneOf1Gt :: Maybe Int gt getIdentityVerificationSessionsParametersQueryCreated'OneOf1Gte :: Maybe Int gte getIdentityVerificationSessionsParametersQueryCreated'OneOf1Lt :: Maybe Int lt getIdentityVerificationSessionsParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

Eq GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods (==) :: GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 -> GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 -> Bool # (/=) :: GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 -> GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 -> Bool #
Show GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods showsPrec :: Int -> GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 -> ShowS # show :: GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 -> String # showList :: [GetIdentityVerificationSessionsParametersQueryCreated'OneOf1] -> ShowS #
ToJSON GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods toJSON :: GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 -> Value # toEncoding :: GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 -> Encoding # toJSONList :: [GetIdentityVerificationSessionsParametersQueryCreated'OneOf1] -> Value # toEncodingList :: [GetIdentityVerificationSessionsParametersQueryCreated'OneOf1] -> Encoding #
FromJSON GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods parseJSON :: Value -> Parser GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 # parseJSONList :: Value -> Parser [GetIdentityVerificationSessionsParametersQueryCreated'OneOf1] #

mkGetIdentityVerificationSessionsParametersQueryCreated'OneOf1 :: GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 Source #

Create a new GetIdentityVerificationSessionsParametersQueryCreated'OneOf1 with all required fields.

data GetIdentityVerificationSessionsParametersQueryCreated'Variants Source #

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

Instances

Instances details

Eq GetIdentityVerificationSessionsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods (==) :: GetIdentityVerificationSessionsParametersQueryCreated'Variants -> GetIdentityVerificationSessionsParametersQueryCreated'Variants -> Bool # (/=) :: GetIdentityVerificationSessionsParametersQueryCreated'Variants -> GetIdentityVerificationSessionsParametersQueryCreated'Variants -> Bool #
Show GetIdentityVerificationSessionsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods showsPrec :: Int -> GetIdentityVerificationSessionsParametersQueryCreated'Variants -> ShowS # show :: GetIdentityVerificationSessionsParametersQueryCreated'Variants -> String # showList :: [GetIdentityVerificationSessionsParametersQueryCreated'Variants] -> ShowS #
ToJSON GetIdentityVerificationSessionsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods toJSON :: GetIdentityVerificationSessionsParametersQueryCreated'Variants -> Value # toEncoding :: GetIdentityVerificationSessionsParametersQueryCreated'Variants -> Encoding # toJSONList :: [GetIdentityVerificationSessionsParametersQueryCreated'Variants] -> Value # toEncodingList :: [GetIdentityVerificationSessionsParametersQueryCreated'Variants] -> Encoding #
FromJSON GetIdentityVerificationSessionsParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods parseJSON :: Value -> Parser GetIdentityVerificationSessionsParametersQueryCreated'Variants # parseJSONList :: Value -> Parser [GetIdentityVerificationSessionsParametersQueryCreated'Variants] #

data GetIdentityVerificationSessionsParametersQueryStatus' Source #

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"`

Instances

Instances details

Eq GetIdentityVerificationSessionsParametersQueryStatus' Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods (==) :: GetIdentityVerificationSessionsParametersQueryStatus' -> GetIdentityVerificationSessionsParametersQueryStatus' -> Bool # (/=) :: GetIdentityVerificationSessionsParametersQueryStatus' -> GetIdentityVerificationSessionsParametersQueryStatus' -> Bool #
Show GetIdentityVerificationSessionsParametersQueryStatus' Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods showsPrec :: Int -> GetIdentityVerificationSessionsParametersQueryStatus' -> ShowS # show :: GetIdentityVerificationSessionsParametersQueryStatus' -> String # showList :: [GetIdentityVerificationSessionsParametersQueryStatus'] -> ShowS #
ToJSON GetIdentityVerificationSessionsParametersQueryStatus' Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods toJSON :: GetIdentityVerificationSessionsParametersQueryStatus' -> Value # toEncoding :: GetIdentityVerificationSessionsParametersQueryStatus' -> Encoding # toJSONList :: [GetIdentityVerificationSessionsParametersQueryStatus'] -> Value # toEncodingList :: [GetIdentityVerificationSessionsParametersQueryStatus'] -> Encoding #
FromJSON GetIdentityVerificationSessionsParametersQueryStatus' Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods parseJSON :: Value -> Parser GetIdentityVerificationSessionsParametersQueryStatus' # parseJSONList :: Value -> Parser [GetIdentityVerificationSessionsParametersQueryStatus'] #

data GetIdentityVerificationSessionsResponse Source #

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.

Instances

Instances details

Eq GetIdentityVerificationSessionsResponse Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods (==) :: GetIdentityVerificationSessionsResponse -> GetIdentityVerificationSessionsResponse -> Bool # (/=) :: GetIdentityVerificationSessionsResponse -> GetIdentityVerificationSessionsResponse -> Bool #
Show GetIdentityVerificationSessionsResponse Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods showsPrec :: Int -> GetIdentityVerificationSessionsResponse -> ShowS # show :: GetIdentityVerificationSessionsResponse -> String # showList :: [GetIdentityVerificationSessionsResponse] -> ShowS #

data GetIdentityVerificationSessionsResponseBody200 Source #

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

Constructors

GetIdentityVerificationSessionsResponseBody200

Fields

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'

Instances

Instances details

Eq GetIdentityVerificationSessionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods (==) :: GetIdentityVerificationSessionsResponseBody200 -> GetIdentityVerificationSessionsResponseBody200 -> Bool # (/=) :: GetIdentityVerificationSessionsResponseBody200 -> GetIdentityVerificationSessionsResponseBody200 -> Bool #
Show GetIdentityVerificationSessionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods showsPrec :: Int -> GetIdentityVerificationSessionsResponseBody200 -> ShowS # show :: GetIdentityVerificationSessionsResponseBody200 -> String # showList :: [GetIdentityVerificationSessionsResponseBody200] -> ShowS #
ToJSON GetIdentityVerificationSessionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods toJSON :: GetIdentityVerificationSessionsResponseBody200 -> Value # toEncoding :: GetIdentityVerificationSessionsResponseBody200 -> Encoding # toJSONList :: [GetIdentityVerificationSessionsResponseBody200] -> Value # toEncodingList :: [GetIdentityVerificationSessionsResponseBody200] -> Encoding #
FromJSON GetIdentityVerificationSessionsResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetIdentityVerificationSessions Methods parseJSON :: Value -> Parser GetIdentityVerificationSessionsResponseBody200 # parseJSONList :: Value -> Parser [GetIdentityVerificationSessionsResponseBody200] #

mkGetIdentityVerificationSessionsResponseBody200 Source #

Arguments

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

Create a new GetIdentityVerificationSessionsResponseBody200 with all required fields.