StripeAPI.Operations.GetCountrySpecs

Contains the different functions to run the operation getCountrySpecs

Documentation

getCountrySpecs

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

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

-> Maybe Text

expand: Specifies which fields in the response should be expanded.

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe Text

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

-> Maybe GetCountrySpecsRequestBody

The request body to send

-> m (Either HttpException (Response GetCountrySpecsResponse))

Monad containing the result of the operation

GET /v1/country_specs

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

getCountrySpecsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCountrySpecsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/country_specs

The same as getCountrySpecs but returns the raw ByteString

getCountrySpecsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCountrySpecsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCountrySpecsResponse))

GET /v1/country_specs

Monadic version of getCountrySpecs (use with runWithConfiguration)

getCountrySpecsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetCountrySpecsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/country_specs

Monadic version of getCountrySpecsRaw (use with runWithConfiguration)

data GetCountrySpecsRequestBody

Defines the data type for the schema getCountrySpecsRequestBody

Constructors

GetCountrySpecsRequestBody

Instances

Eq GetCountrySpecsRequestBody

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

(==) :: GetCountrySpecsRequestBody -> GetCountrySpecsRequestBody -> Bool

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

Show GetCountrySpecsRequestBody

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

showsPrec :: Int -> GetCountrySpecsRequestBody -> ShowS

show :: GetCountrySpecsRequestBody -> String

showList :: [GetCountrySpecsRequestBody] -> ShowS

ToJSON GetCountrySpecsRequestBody

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

toJSON :: GetCountrySpecsRequestBody -> Value

toEncoding :: GetCountrySpecsRequestBody -> Encoding

toJSONList :: [GetCountrySpecsRequestBody] -> Value

toEncodingList :: [GetCountrySpecsRequestBody] -> Encoding

FromJSON GetCountrySpecsRequestBody

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

parseJSON :: Value -> Parser GetCountrySpecsRequestBody

parseJSONList :: Value -> Parser [GetCountrySpecsRequestBody]

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 data type for the schema GetCountrySpecsResponseBody200

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.

• getCountrySpecsResponseBody200Object :: GetCountrySpecsResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• 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]

data GetCountrySpecsResponseBody200Object'

Defines the enum schema GetCountrySpecsResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetCountrySpecsResponseBody200Object'EnumOther Value

GetCountrySpecsResponseBody200Object'EnumTyped Text

GetCountrySpecsResponseBody200Object'EnumStringList

Instances

Eq GetCountrySpecsResponseBody200Object'

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

(==) :: GetCountrySpecsResponseBody200Object' -> GetCountrySpecsResponseBody200Object' -> Bool

(/=) :: GetCountrySpecsResponseBody200Object' -> GetCountrySpecsResponseBody200Object' -> Bool

Show GetCountrySpecsResponseBody200Object'

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

showsPrec :: Int -> GetCountrySpecsResponseBody200Object' -> ShowS

show :: GetCountrySpecsResponseBody200Object' -> String

showList :: [GetCountrySpecsResponseBody200Object'] -> ShowS

ToJSON GetCountrySpecsResponseBody200Object'

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

toJSON :: GetCountrySpecsResponseBody200Object' -> Value

toEncoding :: GetCountrySpecsResponseBody200Object' -> Encoding

toJSONList :: [GetCountrySpecsResponseBody200Object'] -> Value

toEncodingList :: [GetCountrySpecsResponseBody200Object'] -> Encoding

FromJSON GetCountrySpecsResponseBody200Object'

Defined in StripeAPI.Operations.GetCountrySpecs

Methods

parseJSON :: Value -> Parser GetCountrySpecsResponseBody200Object'

parseJSONList :: Value -> Parser [GetCountrySpecsResponseBody200Object']