| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetIssuingSettlements
Description
Contains the different functions to run the operation getIssuingSettlements
Synopsis
- getIssuingSettlements :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetIssuingSettlementsRequestBody -> m (Either HttpException (Response GetIssuingSettlementsResponse))
- getIssuingSettlementsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetIssuingSettlementsRequestBody -> m (Either HttpException (Response ByteString))
- getIssuingSettlementsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetIssuingSettlementsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetIssuingSettlementsResponse))
- getIssuingSettlementsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetIssuingSettlementsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetIssuingSettlementsRequestBody = GetIssuingSettlementsRequestBody {
- data GetIssuingSettlementsResponse
- data GetIssuingSettlementsResponseBody200 = GetIssuingSettlementsResponseBody200 {}
- data GetIssuingSettlementsResponseBody200Object'
Documentation
getIssuingSettlements Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe String | created: Only return issuing settlements that were created during the given date interval. |
| -> 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 |
| -> GetIssuingSettlementsRequestBody | The request body to send |
| -> m (Either HttpException (Response GetIssuingSettlementsResponse)) | Monad containing the result of the operation |
GET /v1/issuing/settlements
<p>Returns a list of Issuing <code>Settlement</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>
getIssuingSettlementsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetIssuingSettlementsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/issuing/settlements
The same as getIssuingSettlements but returns the raw ByteString
getIssuingSettlementsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetIssuingSettlementsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetIssuingSettlementsResponse)) Source #
GET /v1/issuing/settlements
Monadic version of getIssuingSettlements (use with runWithConfiguration)
getIssuingSettlementsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> GetIssuingSettlementsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/issuing/settlements
Monadic version of getIssuingSettlementsRaw (use with runWithConfiguration)
data GetIssuingSettlementsRequestBody Source #
Defines the data type for the schema getIssuingSettlementsRequestBody
Constructors
| GetIssuingSettlementsRequestBody | |
Instances
data GetIssuingSettlementsResponse Source #
Represents a response of the operation getIssuingSettlements.
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), GetIssuingSettlementsResponseError is used.
Constructors
| GetIssuingSettlementsResponseError String | Means either no matching case available or a parse error |
| GetIssuingSettlementsResponse200 GetIssuingSettlementsResponseBody200 | Successful response. |
| GetIssuingSettlementsResponseDefault Error | Error response. |
Instances
data GetIssuingSettlementsResponseBody200 Source #
Defines the data type for the schema GetIssuingSettlementsResponseBody200
Constructors
| GetIssuingSettlementsResponseBody200 | |
Fields
| |
Instances
data GetIssuingSettlementsResponseBody200Object' Source #
Defines the enum schema GetIssuingSettlementsResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetIssuingSettlementsResponseBody200Object'EnumOther Value | |
| GetIssuingSettlementsResponseBody200Object'EnumTyped String | |
| GetIssuingSettlementsResponseBody200Object'EnumStringList |