Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Operations.GetCustomers
Description
Contains the different functions to run the operation getCustomers
Synopsis
- getCustomers :: forall m. MonadHTTP m => GetCustomersParameters -> ClientT m (Response GetCustomersResponse)
- data GetCustomersParameters = GetCustomersParameters {
- getCustomersParametersQueryCreated :: Maybe GetCustomersParametersQueryCreated'Variants
- getCustomersParametersQueryEmail :: Maybe Text
- getCustomersParametersQueryEndingBefore :: Maybe Text
- getCustomersParametersQueryExpand :: Maybe [Text]
- getCustomersParametersQueryLimit :: Maybe Int
- getCustomersParametersQueryStartingAfter :: Maybe Text
- mkGetCustomersParameters :: GetCustomersParameters
- data GetCustomersParametersQueryCreated'OneOf1 = GetCustomersParametersQueryCreated'OneOf1 {}
- mkGetCustomersParametersQueryCreated'OneOf1 :: GetCustomersParametersQueryCreated'OneOf1
- data GetCustomersParametersQueryCreated'Variants
- data GetCustomersResponse
- data GetCustomersResponseBody200 = GetCustomersResponseBody200 {}
- mkGetCustomersResponseBody200 :: [Customer] -> Bool -> Text -> GetCustomersResponseBody200
Documentation
Arguments
:: forall m. MonadHTTP m | |
=> GetCustomersParameters | Contains all available parameters of this operation (query and path parameters) |
-> ClientT m (Response GetCustomersResponse) | Monadic computation which returns the result of the operation |
GET /v1/customers
<p>Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.</p>
data GetCustomersParameters Source #
Defines the object schema located at paths./v1/customers.GET.parameters
in the specification.
Constructors
GetCustomersParameters | |
Fields
|
Instances
Eq GetCustomersParameters Source # | |
Defined in StripeAPI.Operations.GetCustomers Methods (==) :: GetCustomersParameters -> GetCustomersParameters -> Bool # (/=) :: GetCustomersParameters -> GetCustomersParameters -> Bool # | |
Show GetCustomersParameters Source # | |
Defined in StripeAPI.Operations.GetCustomers Methods showsPrec :: Int -> GetCustomersParameters -> ShowS # show :: GetCustomersParameters -> String # showList :: [GetCustomersParameters] -> ShowS # | |
ToJSON GetCustomersParameters Source # | |
Defined in StripeAPI.Operations.GetCustomers Methods toJSON :: GetCustomersParameters -> Value # toEncoding :: GetCustomersParameters -> Encoding # toJSONList :: [GetCustomersParameters] -> Value # | |
FromJSON GetCustomersParameters Source # | |
Defined in StripeAPI.Operations.GetCustomers Methods parseJSON :: Value -> Parser GetCustomersParameters # parseJSONList :: Value -> Parser [GetCustomersParameters] # |
mkGetCustomersParameters :: GetCustomersParameters Source #
Create a new GetCustomersParameters
with all required fields.
data GetCustomersParametersQueryCreated'OneOf1 Source #
Defines the object schema located at paths./v1/customers.GET.parameters.properties.queryCreated.anyOf
in the specification.
Constructors
GetCustomersParametersQueryCreated'OneOf1 | |
Instances
mkGetCustomersParametersQueryCreated'OneOf1 :: GetCustomersParametersQueryCreated'OneOf1 Source #
Create a new GetCustomersParametersQueryCreated'OneOf1
with all required fields.
data GetCustomersParametersQueryCreated'Variants Source #
Defines the oneOf schema located at paths./v1/customers.GET.parameters.properties.queryCreated.anyOf
in the specification.
Represents the parameter named 'created'
Constructors
GetCustomersParametersQueryCreated'GetCustomersParametersQueryCreated'OneOf1 GetCustomersParametersQueryCreated'OneOf1 | |
GetCustomersParametersQueryCreated'Int Int |
Instances
data GetCustomersResponse Source #
Represents a response of the operation getCustomers
.
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), GetCustomersResponseError
is used.
Constructors
GetCustomersResponseError String | Means either no matching case available or a parse error |
GetCustomersResponse200 GetCustomersResponseBody200 | Successful response. |
GetCustomersResponseDefault Error | Error response. |
Instances
Eq GetCustomersResponse Source # | |
Defined in StripeAPI.Operations.GetCustomers Methods (==) :: GetCustomersResponse -> GetCustomersResponse -> Bool # (/=) :: GetCustomersResponse -> GetCustomersResponse -> Bool # | |
Show GetCustomersResponse Source # | |
Defined in StripeAPI.Operations.GetCustomers Methods showsPrec :: Int -> GetCustomersResponse -> ShowS # show :: GetCustomersResponse -> String # showList :: [GetCustomersResponse] -> ShowS # |
data GetCustomersResponseBody200 Source #
Defines the object schema located at paths./v1/customers.GET.responses.200.content.application/json.schema
in the specification.
Constructors
GetCustomersResponseBody200 | |
Fields
|
Instances
mkGetCustomersResponseBody200 Source #
Arguments
:: [Customer] | |
-> Bool | |
-> Text | |
-> GetCustomersResponseBody200 |
Create a new GetCustomersResponseBody200
with all required fields.