Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetIssuingAuthorizations

Contains the different functions to run the operation getIssuingAuthorizations

Synopsis

value getIssuingAuthorizations
data GetIssuingAuthorizationsParameters
value mkGetIssuingAuthorizationsParameters
data GetIssuingAuthorizationsParametersQueryCreated'OneOf1
value mkGetIssuingAuthorizationsParametersQueryCreated'OneOf1
data GetIssuingAuthorizationsParametersQueryCreated'Variants
data GetIssuingAuthorizationsParametersQueryStatus'
data GetIssuingAuthorizationsResponse
data GetIssuingAuthorizationsResponseBody200
value mkGetIssuingAuthorizationsResponseBody200

Packagestripeapi-3.0.0.0
Exports10
LanguageHaskell2010
LicenceMIT
SourceGetIssuingAuthorizations.hs

valuegetIssuingAuthorizations

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

GET /v1/issuing/authorizations

<p>Returns a list of Issuing <code>Authorization</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

datadata GetIssuingAuthorizationsParameters

Source#

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

Constructors

GetIssuingAuthorizationsParameters
- getIssuingAuthorizationsParametersQueryCard :: Maybe Text
  queryCard: Represents the parameter named 'card'
  Only return authorizations that belong to the given card.
  Constraints:
  - Maximum length of 5000
- getIssuingAuthorizationsParametersQueryCardholder :: Maybe Text
  queryCardholder: Represents the parameter named 'cardholder'
  Only return authorizations that belong to the given cardholder.
  Constraints:
  - Maximum length of 5000
- getIssuingAuthorizationsParametersQueryCreated :: Maybe GetIssuingAuthorizationsParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
  Only return authorizations that were created during the given date interval.
- getIssuingAuthorizationsParametersQueryEndingBefore :: 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
- getIssuingAuthorizationsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getIssuingAuthorizationsParametersQueryLimit :: 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.
- getIssuingAuthorizationsParametersQueryStartingAfter :: 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
- getIssuingAuthorizationsParametersQueryStatus :: Maybe GetIssuingAuthorizationsParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIssuingAuthorizationsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
Show GetIssuingAuthorizationsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
FromJSON GetIssuingAuthorizationsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
ToJSON GetIssuingAuthorizationsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations

valuemkGetIssuingAuthorizationsParameters :: GetIssuingAuthorizationsParameters

Source#

Create a new GetIssuingAuthorizationsParameters with all required fields.

datadata GetIssuingAuthorizationsParametersQueryCreated'OneOf1

Source#

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

Constructors

GetIssuingAuthorizationsParametersQueryCreated'OneOf1
- getIssuingAuthorizationsParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getIssuingAuthorizationsParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getIssuingAuthorizationsParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getIssuingAuthorizationsParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIssuingAuthorizationsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
Show GetIssuingAuthorizationsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
FromJSON GetIssuingAuthorizationsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
ToJSON GetIssuingAuthorizationsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations

valuemkGetIssuingAuthorizationsParametersQueryCreated'OneOf1 :: GetIssuingAuthorizationsParametersQueryCreated'OneOf1

Source#

Create a new GetIssuingAuthorizationsParametersQueryCreated'OneOf1 with all required fields.

datadata GetIssuingAuthorizationsParametersQueryCreated'Variants

Source#

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

Represents the parameter named 'created'

Only return authorizations that were created during the given date interval.

Constructors

GetIssuingAuthorizationsParametersQueryCreated'GetIssuingAuthorizationsParametersQueryCreated'OneOf1 GetIssuingAuthorizationsParametersQueryCreated'OneOf1
GetIssuingAuthorizationsParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIssuingAuthorizationsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
Show GetIssuingAuthorizationsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
FromJSON GetIssuingAuthorizationsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
ToJSON GetIssuingAuthorizationsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations

datadata GetIssuingAuthorizationsParametersQueryStatus'

Source#

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

Represents the parameter named 'status'

Only return authorizations with the given status. One of `pending`, `closed`, or `reversed`.

Constructors

GetIssuingAuthorizationsParametersQueryStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetIssuingAuthorizationsParametersQueryStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetIssuingAuthorizationsParametersQueryStatus'EnumClosed
Represents the JSON value "closed"
GetIssuingAuthorizationsParametersQueryStatus'EnumPending
Represents the JSON value "pending"
GetIssuingAuthorizationsParametersQueryStatus'EnumReversed
Represents the JSON value "reversed"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIssuingAuthorizationsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
Show GetIssuingAuthorizationsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
FromJSON GetIssuingAuthorizationsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
ToJSON GetIssuingAuthorizationsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations

datadata GetIssuingAuthorizationsResponse

Source#

Represents a response of the operation getIssuingAuthorizations.

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

Constructors

GetIssuingAuthorizationsResponseError String
Means either no matching case available or a parse error
GetIssuingAuthorizationsResponse200 GetIssuingAuthorizationsResponseBody200
Successful response.
GetIssuingAuthorizationsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetIssuingAuthorizationsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
Show GetIssuingAuthorizationsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations

datadata GetIssuingAuthorizationsResponseBody200

Source#

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

Constructors

GetIssuingAuthorizationsResponseBody200
- getIssuingAuthorizationsResponseBody200Data :: [Issuing'authorization]
  data
- getIssuingAuthorizationsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getIssuingAuthorizationsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/issuing/authorizations'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetIssuingAuthorizationsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
Show GetIssuingAuthorizationsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
FromJSON GetIssuingAuthorizationsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations
ToJSON GetIssuingAuthorizationsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetIssuingAuthorizations

valuemkGetIssuingAuthorizationsResponseBody200

:: [Issuing'authorization]
getIssuingAuthorizationsResponseBody200Data
-> Bool
getIssuingAuthorizationsResponseBody200HasMore
-> Text
getIssuingAuthorizationsResponseBody200Url
-> GetIssuingAuthorizationsResponseBody200

Source#

Create a new GetIssuingAuthorizationsResponseBody200 with all required fields.