| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetChargesChargeRefunds
Description
Contains the different functions to run the operation getChargesChargeRefunds
Synopsis
- getChargesChargeRefunds :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetChargesChargeRefundsRequestBody -> m (Either HttpException (Response GetChargesChargeRefundsResponse))
- getChargesChargeRefundsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetChargesChargeRefundsRequestBody -> m (Either HttpException (Response ByteString))
- getChargesChargeRefundsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetChargesChargeRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetChargesChargeRefundsResponse))
- getChargesChargeRefundsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetChargesChargeRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetChargesChargeRefundsRequestBody = GetChargesChargeRefundsRequestBody {
- data GetChargesChargeRefundsResponse
- data GetChargesChargeRefundsResponseBody200 = GetChargesChargeRefundsResponseBody200 {}
- data GetChargesChargeRefundsResponseBody200Object'
Documentation
getChargesChargeRefunds Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Text | charge |
| -> 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. |
| -> 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. |
| -> Maybe GetChargesChargeRefundsRequestBody | The request body to send |
| -> m (Either HttpException (Response GetChargesChargeRefundsResponse)) | Monad containing the result of the operation |
GET /v1/charges/{charge}/refunds<p>You can see a list of the refunds belonging to a specific charge. Note that the 10 most recent refunds are always available by default on the charge object. If you need more than those 10, you can use this API method and the <code>limit</code> and <code>starting_after</code> parameters to page through additional refunds.</p>
getChargesChargeRefundsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetChargesChargeRefundsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/charges/{charge}/refundsThe same as getChargesChargeRefunds but returns the raw ByteString
getChargesChargeRefundsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetChargesChargeRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetChargesChargeRefundsResponse)) Source #
GET /v1/charges/{charge}/refundsMonadic version of getChargesChargeRefunds (use with runWithConfiguration)
getChargesChargeRefundsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe GetChargesChargeRefundsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/charges/{charge}/refundsMonadic version of getChargesChargeRefundsRaw (use with runWithConfiguration)
data GetChargesChargeRefundsRequestBody Source #
Defines the data type for the schema getChargesChargeRefundsRequestBody
Constructors
| GetChargesChargeRefundsRequestBody | |
Instances
data GetChargesChargeRefundsResponse Source #
Represents a response of the operation getChargesChargeRefunds.
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), GetChargesChargeRefundsResponseError is used.
Constructors
| GetChargesChargeRefundsResponseError String | Means either no matching case available or a parse error |
| GetChargesChargeRefundsResponse200 GetChargesChargeRefundsResponseBody200 | Successful response. |
| GetChargesChargeRefundsResponseDefault Error | Error response. |
Instances
data GetChargesChargeRefundsResponseBody200 Source #
Defines the data type for the schema GetChargesChargeRefundsResponseBody200
Constructors
| GetChargesChargeRefundsResponseBody200 | |
Fields
| |
Instances
data GetChargesChargeRefundsResponseBody200Object' Source #
Defines the enum schema GetChargesChargeRefundsResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetChargesChargeRefundsResponseBody200Object'EnumOther Value | |
| GetChargesChargeRefundsResponseBody200Object'EnumTyped Text | |
| GetChargesChargeRefundsResponseBody200Object'EnumStringList |