| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetExchangeRates
Description
Contains the different functions to run the operation getExchangeRates
Synopsis
- getExchangeRates :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetExchangeRatesRequestBody -> m (Either HttpException (Response GetExchangeRatesResponse))
- getExchangeRatesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetExchangeRatesRequestBody -> m (Either HttpException (Response ByteString))
- getExchangeRatesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetExchangeRatesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetExchangeRatesResponse))
- getExchangeRatesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetExchangeRatesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetExchangeRatesRequestBody = GetExchangeRatesRequestBody {
- data GetExchangeRatesResponse
- data GetExchangeRatesResponseBody200 = GetExchangeRatesResponseBody200 {}
- data GetExchangeRatesResponseBody200Object'
Documentation
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 the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X 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 total number of supported payout currencies, and the default is the max. |
| -> Maybe Text | starting_after: A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list. | Constraints: Maximum length of 5000 |
| -> Maybe GetExchangeRatesRequestBody | The request body to send |
| -> m (Either HttpException (Response GetExchangeRatesResponse)) | Monad containing the result of the operation |
GET /v1/exchange_rates
<p>Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.</p>
getExchangeRatesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetExchangeRatesRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/exchange_rates
The same as getExchangeRates but returns the raw ByteString
getExchangeRatesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetExchangeRatesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetExchangeRatesResponse)) Source #
GET /v1/exchange_rates
Monadic version of getExchangeRates (use with runWithConfiguration)
getExchangeRatesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetExchangeRatesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/exchange_rates
Monadic version of getExchangeRatesRaw (use with runWithConfiguration)
data GetExchangeRatesRequestBody Source #
Defines the data type for the schema getExchangeRatesRequestBody
Constructors
| GetExchangeRatesRequestBody | |
Instances
data GetExchangeRatesResponse Source #
Represents a response of the operation getExchangeRates.
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), GetExchangeRatesResponseError is used.
Constructors
| GetExchangeRatesResponseError String | Means either no matching case available or a parse error |
| GetExchangeRatesResponse200 GetExchangeRatesResponseBody200 | Successful response. |
| GetExchangeRatesResponseDefault Error | Error response. |
Instances
| Eq GetExchangeRatesResponse Source # | |
Defined in StripeAPI.Operations.GetExchangeRates Methods (==) :: GetExchangeRatesResponse -> GetExchangeRatesResponse -> Bool # (/=) :: GetExchangeRatesResponse -> GetExchangeRatesResponse -> Bool # | |
| Show GetExchangeRatesResponse Source # | |
Defined in StripeAPI.Operations.GetExchangeRates Methods showsPrec :: Int -> GetExchangeRatesResponse -> ShowS # show :: GetExchangeRatesResponse -> String # showList :: [GetExchangeRatesResponse] -> ShowS # | |
data GetExchangeRatesResponseBody200 Source #
Defines the data type for the schema GetExchangeRatesResponseBody200
Constructors
| GetExchangeRatesResponseBody200 | |
Fields
| |
Instances
data GetExchangeRatesResponseBody200Object' Source #
Defines the enum schema GetExchangeRatesResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetExchangeRatesResponseBody200Object'EnumOther Value | |
| GetExchangeRatesResponseBody200Object'EnumTyped Text | |
| GetExchangeRatesResponseBody200Object'EnumStringList |