| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetCountrySpecs
Description
Contains the different functions to run the operation getCountrySpecs
Synopsis
- getCountrySpecs :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCountrySpecsRequestBody -> m (Either HttpException (Response GetCountrySpecsResponse))
- getCountrySpecsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCountrySpecsRequestBody -> m (Either HttpException (Response ByteString))
- getCountrySpecsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCountrySpecsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCountrySpecsResponse))
- getCountrySpecsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCountrySpecsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetCountrySpecsRequestBody = GetCountrySpecsRequestBody {
- data GetCountrySpecsResponse
- data GetCountrySpecsResponseBody200 = GetCountrySpecsResponseBody200 {}
- data GetCountrySpecsResponseBody200Object'
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe String | 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 String | 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 String | 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 |
| -> 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 String -> Maybe String -> Maybe Integer -> Maybe String -> GetCountrySpecsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/country_specs
The same as getCountrySpecs but returns the raw ByteString
getCountrySpecsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCountrySpecsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetCountrySpecsResponse)) Source #
GET /v1/country_specs
Monadic version of getCountrySpecs (use with runWithConfiguration)
getCountrySpecsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetCountrySpecsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/country_specs
Monadic version of getCountrySpecsRaw (use with runWithConfiguration)
data GetCountrySpecsRequestBody Source #
Defines the data type for the schema getCountrySpecsRequestBody
Constructors
| GetCountrySpecsRequestBody | |
Instances
data GetCountrySpecsResponse Source #
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 Source # | |
Defined in StripeAPI.Operations.GetCountrySpecs Methods (==) :: GetCountrySpecsResponse -> GetCountrySpecsResponse -> Bool # (/=) :: GetCountrySpecsResponse -> GetCountrySpecsResponse -> Bool # | |
| Show GetCountrySpecsResponse Source # | |
Defined in StripeAPI.Operations.GetCountrySpecs Methods showsPrec :: Int -> GetCountrySpecsResponse -> ShowS # show :: GetCountrySpecsResponse -> String # showList :: [GetCountrySpecsResponse] -> ShowS # | |
data GetCountrySpecsResponseBody200 Source #
Defines the data type for the schema GetCountrySpecsResponseBody200
Constructors
| GetCountrySpecsResponseBody200 | |
Fields
| |
Instances
data GetCountrySpecsResponseBody200Object' Source #
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 String | |
| GetCountrySpecsResponseBody200Object'EnumStringList |