| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetPaymentMethods
Description
Contains the different functions to run the operation getPaymentMethods
Synopsis
- getPaymentMethods :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetPaymentMethodsRequestBody -> m (Either HttpException (Response GetPaymentMethodsResponse))
- getPaymentMethodsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetPaymentMethodsRequestBody -> m (Either HttpException (Response ByteString))
- getPaymentMethodsM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetPaymentMethodsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetPaymentMethodsResponse))
- getPaymentMethodsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetPaymentMethodsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetPaymentMethodsRequestBody = GetPaymentMethodsRequestBody {
- data GetPaymentMethodsResponse
- data GetPaymentMethodsResponseBody200 = GetPaymentMethodsResponseBody200 {}
- data GetPaymentMethodsResponseBody200Object'
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> String | customer: The ID of the customer whose PaymentMethods will be retrieved. | Constraints: Maximum length of 5000 |
| -> 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. |
| -> 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. |
| -> String | type: A required filter on the list, based on the object `type` field. | Constraints: Maximum length of 5000 |
| -> GetPaymentMethodsRequestBody | The request body to send |
| -> m (Either HttpException (Response GetPaymentMethodsResponse)) | Monad containing the result of the operation |
GET /v1/payment_methods
<p>Returns a list of PaymentMethods for a given Customer</p>
getPaymentMethodsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetPaymentMethodsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/payment_methods
The same as getPaymentMethods but returns the raw ByteString
getPaymentMethodsM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetPaymentMethodsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetPaymentMethodsResponse)) Source #
GET /v1/payment_methods
Monadic version of getPaymentMethods (use with runWithConfiguration)
getPaymentMethodsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> String -> GetPaymentMethodsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/payment_methods
Monadic version of getPaymentMethodsRaw (use with runWithConfiguration)
data GetPaymentMethodsRequestBody Source #
Defines the data type for the schema getPaymentMethodsRequestBody
Constructors
| GetPaymentMethodsRequestBody | |
Instances
data GetPaymentMethodsResponse Source #
Represents a response of the operation getPaymentMethods.
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), GetPaymentMethodsResponseError is used.
Constructors
| GetPaymentMethodsResponseError String | Means either no matching case available or a parse error |
| GetPaymentMethodsResponse200 GetPaymentMethodsResponseBody200 | Successful response. |
| GetPaymentMethodsResponseDefault Error | Error response. |
Instances
| Eq GetPaymentMethodsResponse Source # | |
Defined in StripeAPI.Operations.GetPaymentMethods Methods (==) :: GetPaymentMethodsResponse -> GetPaymentMethodsResponse -> Bool # (/=) :: GetPaymentMethodsResponse -> GetPaymentMethodsResponse -> Bool # | |
| Show GetPaymentMethodsResponse Source # | |
Defined in StripeAPI.Operations.GetPaymentMethods Methods showsPrec :: Int -> GetPaymentMethodsResponse -> ShowS # show :: GetPaymentMethodsResponse -> String # showList :: [GetPaymentMethodsResponse] -> ShowS # | |
data GetPaymentMethodsResponseBody200 Source #
Defines the data type for the schema GetPaymentMethodsResponseBody200
Constructors
| GetPaymentMethodsResponseBody200 | |
Fields
| |
Instances
data GetPaymentMethodsResponseBody200Object' Source #
Defines the enum schema GetPaymentMethodsResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetPaymentMethodsResponseBody200Object'EnumOther Value | |
| GetPaymentMethodsResponseBody200Object'EnumTyped String | |
| GetPaymentMethodsResponseBody200Object'EnumStringList |