StripeAPI.Operations.GetApplePayDomains

Contains the different functions to run the operation getApplePayDomains

Documentation

getApplePayDomains

Arguments

:: forall m. MonadHTTP m

=> GetApplePayDomainsParameters

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

-> ClientT m (Response GetApplePayDomainsResponse)

Monadic computation which returns the result of the operation

GET /v1/apple_pay/domains

<p>List apple pay domains.</p>

data GetApplePayDomainsParameters

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

Constructors

GetApplePayDomainsParameters

Fields

• getApplePayDomainsParametersQueryDomainName :: Maybe Text

  queryDomain_name: Represents the parameter named 'domain_name'

  Constraints:

  • Maximum length of 5000
• getApplePayDomainsParametersQueryEndingBefore :: 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
• getApplePayDomainsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

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

• getApplePayDomainsParametersQueryStartingAfter :: 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 GetApplePayDomainsParameters

Defined in StripeAPI.Operations.GetApplePayDomains

Methods

(==) :: GetApplePayDomainsParameters -> GetApplePayDomainsParameters -> Bool

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

Show GetApplePayDomainsParameters

Defined in StripeAPI.Operations.GetApplePayDomains

Methods

showsPrec :: Int -> GetApplePayDomainsParameters -> ShowS

show :: GetApplePayDomainsParameters -> String

showList :: [GetApplePayDomainsParameters] -> ShowS

ToJSON GetApplePayDomainsParameters

Defined in StripeAPI.Operations.GetApplePayDomains

Methods

toJSON :: GetApplePayDomainsParameters -> Value

toEncoding :: GetApplePayDomainsParameters -> Encoding

toJSONList :: [GetApplePayDomainsParameters] -> Value

toEncodingList :: [GetApplePayDomainsParameters] -> Encoding

FromJSON GetApplePayDomainsParameters

Defined in StripeAPI.Operations.GetApplePayDomains

Methods

parseJSON :: Value -> Parser GetApplePayDomainsParameters

parseJSONList :: Value -> Parser [GetApplePayDomainsParameters]

mkGetApplePayDomainsParameters :: GetApplePayDomainsParameters

Create a new GetApplePayDomainsParameters with all required fields.

data GetApplePayDomainsResponse

Represents a response of the operation getApplePayDomains.

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

Constructors

GetApplePayDomainsResponseError String

Means either no matching case available or a parse error

GetApplePayDomainsResponse200 GetApplePayDomainsResponseBody200

Successful response.

GetApplePayDomainsResponseDefault Error

Error response.

Instances

Eq GetApplePayDomainsResponse

Defined in StripeAPI.Operations.GetApplePayDomains

Methods

(==) :: GetApplePayDomainsResponse -> GetApplePayDomainsResponse -> Bool

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

Show GetApplePayDomainsResponse

Defined in StripeAPI.Operations.GetApplePayDomains

Methods

showsPrec :: Int -> GetApplePayDomainsResponse -> ShowS

show :: GetApplePayDomainsResponse -> String

showList :: [GetApplePayDomainsResponse] -> ShowS

data GetApplePayDomainsResponseBody200

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

Constructors

GetApplePayDomainsResponseBody200

Fields

• getApplePayDomainsResponseBody200Data :: [ApplePayDomain]

  data

• getApplePayDomainsResponseBody200HasMore :: Bool

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

• getApplePayDomainsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetApplePayDomainsResponseBody200

Defined in StripeAPI.Operations.GetApplePayDomains

Methods

(==) :: GetApplePayDomainsResponseBody200 -> GetApplePayDomainsResponseBody200 -> Bool

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

Show GetApplePayDomainsResponseBody200

Defined in StripeAPI.Operations.GetApplePayDomains

Methods

showsPrec :: Int -> GetApplePayDomainsResponseBody200 -> ShowS

show :: GetApplePayDomainsResponseBody200 -> String

showList :: [GetApplePayDomainsResponseBody200] -> ShowS

ToJSON GetApplePayDomainsResponseBody200

Defined in StripeAPI.Operations.GetApplePayDomains

Methods

toJSON :: GetApplePayDomainsResponseBody200 -> Value

toEncoding :: GetApplePayDomainsResponseBody200 -> Encoding

toJSONList :: [GetApplePayDomainsResponseBody200] -> Value

toEncodingList :: [GetApplePayDomainsResponseBody200] -> Encoding

FromJSON GetApplePayDomainsResponseBody200

Defined in StripeAPI.Operations.GetApplePayDomains

Methods

parseJSON :: Value -> Parser GetApplePayDomainsResponseBody200

parseJSONList :: Value -> Parser [GetApplePayDomainsResponseBody200]

mkGetApplePayDomainsResponseBody200

Arguments

:: [ApplePayDomain]

getApplePayDomainsResponseBody200Data

-> Bool

getApplePayDomainsResponseBody200HasMore

-> Text

getApplePayDomainsResponseBody200Url

-> GetApplePayDomainsResponseBody200

Create a new GetApplePayDomainsResponseBody200 with all required fields.