StripeAPI.Operations.GetSetupAttempts

Contains the different functions to run the operation getSetupAttempts

Documentation

getSetupAttempts

Arguments

:: forall m. MonadHTTP m

=> GetSetupAttemptsParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetSetupAttemptsResponse)

Monadic computation which returns the result of the operation

GET /v1/setup_attempts

<p>Returns a list of SetupAttempts associated with a provided SetupIntent.</p>

data GetSetupAttemptsParameters

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

Constructors

GetSetupAttemptsParameters

Fields

• getSetupAttemptsParametersQueryCreated :: Maybe GetSetupAttemptsParametersQueryCreated'Variants

  queryCreated: Represents the parameter named 'created'

  A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

• getSetupAttemptsParametersQueryEndingBefore :: 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
• getSetupAttemptsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getSetupAttemptsParametersQueryLimit :: 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.

• getSetupAttemptsParametersQuerySetupIntent :: Text

  querySetup_intent: Represents the parameter named 'setup_intent'

  Only return SetupAttempts created by the SetupIntent specified by this ID.

  Constraints:

  • Maximum length of 5000
• getSetupAttemptsParametersQueryStartingAfter :: 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

Instances

Eq GetSetupAttemptsParameters

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

(==) :: GetSetupAttemptsParameters -> GetSetupAttemptsParameters -> Bool

(/=) :: GetSetupAttemptsParameters -> GetSetupAttemptsParameters -> Bool

Show GetSetupAttemptsParameters

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

showsPrec :: Int -> GetSetupAttemptsParameters -> ShowS

show :: GetSetupAttemptsParameters -> String

showList :: [GetSetupAttemptsParameters] -> ShowS

ToJSON GetSetupAttemptsParameters

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

toJSON :: GetSetupAttemptsParameters -> Value

toEncoding :: GetSetupAttemptsParameters -> Encoding

toJSONList :: [GetSetupAttemptsParameters] -> Value

toEncodingList :: [GetSetupAttemptsParameters] -> Encoding

FromJSON GetSetupAttemptsParameters

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

parseJSON :: Value -> Parser GetSetupAttemptsParameters

parseJSONList :: Value -> Parser [GetSetupAttemptsParameters]

mkGetSetupAttemptsParameters

Arguments

:: Text

getSetupAttemptsParametersQuerySetupIntent

-> GetSetupAttemptsParameters

Create a new GetSetupAttemptsParameters with all required fields.

data GetSetupAttemptsParametersQueryCreated'OneOf1

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

Constructors

GetSetupAttemptsParametersQueryCreated'OneOf1

Fields

• getSetupAttemptsParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getSetupAttemptsParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getSetupAttemptsParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getSetupAttemptsParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetSetupAttemptsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

(==) :: GetSetupAttemptsParametersQueryCreated'OneOf1 -> GetSetupAttemptsParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetSetupAttemptsParametersQueryCreated'OneOf1 -> GetSetupAttemptsParametersQueryCreated'OneOf1 -> Bool

Show GetSetupAttemptsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

showsPrec :: Int -> GetSetupAttemptsParametersQueryCreated'OneOf1 -> ShowS

show :: GetSetupAttemptsParametersQueryCreated'OneOf1 -> String

showList :: [GetSetupAttemptsParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetSetupAttemptsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

toJSON :: GetSetupAttemptsParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetSetupAttemptsParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetSetupAttemptsParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetSetupAttemptsParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetSetupAttemptsParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

parseJSON :: Value -> Parser GetSetupAttemptsParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetSetupAttemptsParametersQueryCreated'OneOf1]

mkGetSetupAttemptsParametersQueryCreated'OneOf1 :: GetSetupAttemptsParametersQueryCreated'OneOf1

Create a new GetSetupAttemptsParametersQueryCreated'OneOf1 with all required fields.

data GetSetupAttemptsParametersQueryCreated'Variants

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

Represents the parameter named 'created'

A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

Constructors

GetSetupAttemptsParametersQueryCreated'GetSetupAttemptsParametersQueryCreated'OneOf1 GetSetupAttemptsParametersQueryCreated'OneOf1

GetSetupAttemptsParametersQueryCreated'Int Int

Instances

Eq GetSetupAttemptsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

(==) :: GetSetupAttemptsParametersQueryCreated'Variants -> GetSetupAttemptsParametersQueryCreated'Variants -> Bool

(/=) :: GetSetupAttemptsParametersQueryCreated'Variants -> GetSetupAttemptsParametersQueryCreated'Variants -> Bool

Show GetSetupAttemptsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

showsPrec :: Int -> GetSetupAttemptsParametersQueryCreated'Variants -> ShowS

show :: GetSetupAttemptsParametersQueryCreated'Variants -> String

showList :: [GetSetupAttemptsParametersQueryCreated'Variants] -> ShowS

ToJSON GetSetupAttemptsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

toJSON :: GetSetupAttemptsParametersQueryCreated'Variants -> Value

toEncoding :: GetSetupAttemptsParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetSetupAttemptsParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetSetupAttemptsParametersQueryCreated'Variants] -> Encoding

FromJSON GetSetupAttemptsParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

parseJSON :: Value -> Parser GetSetupAttemptsParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetSetupAttemptsParametersQueryCreated'Variants]

data GetSetupAttemptsResponse

Represents a response of the operation getSetupAttempts.

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), GetSetupAttemptsResponseError is used.

Constructors

GetSetupAttemptsResponseError String

Means either no matching case available or a parse error

GetSetupAttemptsResponse200 GetSetupAttemptsResponseBody200

Successful response.

GetSetupAttemptsResponseDefault Error

Error response.

Instances

Eq GetSetupAttemptsResponse

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

(==) :: GetSetupAttemptsResponse -> GetSetupAttemptsResponse -> Bool

(/=) :: GetSetupAttemptsResponse -> GetSetupAttemptsResponse -> Bool

Show GetSetupAttemptsResponse

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

showsPrec :: Int -> GetSetupAttemptsResponse -> ShowS

show :: GetSetupAttemptsResponse -> String

showList :: [GetSetupAttemptsResponse] -> ShowS

data GetSetupAttemptsResponseBody200

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

Constructors

GetSetupAttemptsResponseBody200

Fields

• getSetupAttemptsResponseBody200Data :: [SetupAttempt]

  data

• getSetupAttemptsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getSetupAttemptsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/setup_attempts'

Instances

Eq GetSetupAttemptsResponseBody200

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

(==) :: GetSetupAttemptsResponseBody200 -> GetSetupAttemptsResponseBody200 -> Bool

(/=) :: GetSetupAttemptsResponseBody200 -> GetSetupAttemptsResponseBody200 -> Bool

Show GetSetupAttemptsResponseBody200

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

showsPrec :: Int -> GetSetupAttemptsResponseBody200 -> ShowS

show :: GetSetupAttemptsResponseBody200 -> String

showList :: [GetSetupAttemptsResponseBody200] -> ShowS

ToJSON GetSetupAttemptsResponseBody200

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

toJSON :: GetSetupAttemptsResponseBody200 -> Value

toEncoding :: GetSetupAttemptsResponseBody200 -> Encoding

toJSONList :: [GetSetupAttemptsResponseBody200] -> Value

toEncodingList :: [GetSetupAttemptsResponseBody200] -> Encoding

FromJSON GetSetupAttemptsResponseBody200

Defined in StripeAPI.Operations.GetSetupAttempts

Methods

parseJSON :: Value -> Parser GetSetupAttemptsResponseBody200

parseJSONList :: Value -> Parser [GetSetupAttemptsResponseBody200]

mkGetSetupAttemptsResponseBody200

Arguments

:: [SetupAttempt]

getSetupAttemptsResponseBody200Data

-> Bool

getSetupAttemptsResponseBody200HasMore

-> Text

getSetupAttemptsResponseBody200Url

-> GetSetupAttemptsResponseBody200

Create a new GetSetupAttemptsResponseBody200 with all required fields.