StripeAPI.Operations.GetCountrySpecs

Contains the different functions to run the operation getCountrySpecs

Documentation

getCountrySpecs

Arguments

:: forall m. MonadHTTP m

=> GetCountrySpecsParameters

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

-> ClientT m (Response GetCountrySpecsResponse)

Monadic computation which returns the result of the operation

GET /v1/country_specs

<p>Lists all Country Spec objects available in the API.</p>

data GetCountrySpecsParameters

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

Constructors

GetCountrySpecsParameters

Fields

• getCountrySpecsParametersQueryEndingBefore :: 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
• getCountrySpecsParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

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

• getCountrySpecsParametersQueryStartingAfter :: 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 GetCountrySpecsParameters

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

(==) :: GetCountrySpecsParameters -> GetCountrySpecsParameters -> Bool

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

Show GetCountrySpecsParameters

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

showsPrec :: Int -> GetCountrySpecsParameters -> ShowS

show :: GetCountrySpecsParameters -> String

showList :: [GetCountrySpecsParameters] -> ShowS

ToJSON GetCountrySpecsParameters

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

toJSON :: GetCountrySpecsParameters -> Value

toEncoding :: GetCountrySpecsParameters -> Encoding

toJSONList :: [GetCountrySpecsParameters] -> Value

toEncodingList :: [GetCountrySpecsParameters] -> Encoding

FromJSON GetCountrySpecsParameters

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

parseJSON :: Value -> Parser GetCountrySpecsParameters

parseJSONList :: Value -> Parser [GetCountrySpecsParameters]

mkGetCountrySpecsParameters :: GetCountrySpecsParameters

Create a new GetCountrySpecsParameters with all required fields.

data GetCountrySpecsResponse

Represents a response of the operation getCountrySpecs.

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

Constructors

GetCountrySpecsResponseError String

Means either no matching case available or a parse error

GetCountrySpecsResponse200 GetCountrySpecsResponseBody200

Successful response.

GetCountrySpecsResponseDefault Error

Error response.

Instances

Eq GetCountrySpecsResponse

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

(==) :: GetCountrySpecsResponse -> GetCountrySpecsResponse -> Bool

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

Show GetCountrySpecsResponse

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

showsPrec :: Int -> GetCountrySpecsResponse -> ShowS

show :: GetCountrySpecsResponse -> String

showList :: [GetCountrySpecsResponse] -> ShowS

data GetCountrySpecsResponseBody200

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

Constructors

GetCountrySpecsResponseBody200

Fields

• getCountrySpecsResponseBody200Data :: [CountrySpec]

  data

• getCountrySpecsResponseBody200HasMore :: Bool

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

• getCountrySpecsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetCountrySpecsResponseBody200

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

(==) :: GetCountrySpecsResponseBody200 -> GetCountrySpecsResponseBody200 -> Bool

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

Show GetCountrySpecsResponseBody200

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

showsPrec :: Int -> GetCountrySpecsResponseBody200 -> ShowS

show :: GetCountrySpecsResponseBody200 -> String

showList :: [GetCountrySpecsResponseBody200] -> ShowS

ToJSON GetCountrySpecsResponseBody200

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

toJSON :: GetCountrySpecsResponseBody200 -> Value

toEncoding :: GetCountrySpecsResponseBody200 -> Encoding

toJSONList :: [GetCountrySpecsResponseBody200] -> Value

toEncodingList :: [GetCountrySpecsResponseBody200] -> Encoding

FromJSON GetCountrySpecsResponseBody200

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

parseJSON :: Value -> Parser GetCountrySpecsResponseBody200

parseJSONList :: Value -> Parser [GetCountrySpecsResponseBody200]

mkGetCountrySpecsResponseBody200

Arguments

:: [CountrySpec]

getCountrySpecsResponseBody200Data

-> Bool

getCountrySpecsResponseBody200HasMore

-> Text

getCountrySpecsResponseBody200Url

-> GetCountrySpecsResponseBody200

Create a new GetCountrySpecsResponseBody200 with all required fields.