Safe Haskell | None |
---|---|
Language | Haskell2010 |
StripeAPI.Operations.GetProducts
Description
Contains the different functions to run the operation getProducts
Synopsis
- getProducts :: forall m. MonadHTTP m => GetProductsParameters -> ClientT m (Response GetProductsResponse)
- data GetProductsParameters = GetProductsParameters {
- getProductsParametersQueryActive :: Maybe Bool
- getProductsParametersQueryCreated :: Maybe GetProductsParametersQueryCreated'Variants
- getProductsParametersQueryEndingBefore :: Maybe Text
- getProductsParametersQueryExpand :: Maybe [Text]
- getProductsParametersQueryIds :: Maybe [Text]
- getProductsParametersQueryLimit :: Maybe Int
- getProductsParametersQueryShippable :: Maybe Bool
- getProductsParametersQueryStartingAfter :: Maybe Text
- getProductsParametersQueryUrl :: Maybe Text
- mkGetProductsParameters :: GetProductsParameters
- data GetProductsParametersQueryCreated'OneOf1 = GetProductsParametersQueryCreated'OneOf1 {}
- mkGetProductsParametersQueryCreated'OneOf1 :: GetProductsParametersQueryCreated'OneOf1
- data GetProductsParametersQueryCreated'Variants
- data GetProductsResponse
- data GetProductsResponseBody200 = GetProductsResponseBody200 {}
- mkGetProductsResponseBody200 :: [Product] -> Bool -> Text -> GetProductsResponseBody200
Documentation
Arguments
:: forall m. MonadHTTP m | |
=> GetProductsParameters | Contains all available parameters of this operation (query and path parameters) |
-> ClientT m (Response GetProductsResponse) | Monadic computation which returns the result of the operation |
GET /v1/products
<p>Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.</p>
data GetProductsParameters Source #
Defines the object schema located at paths./v1/products.GET.parameters
in the specification.
Constructors
GetProductsParameters | |
Fields
|
Instances
Eq GetProductsParameters Source # | |
Defined in StripeAPI.Operations.GetProducts Methods (==) :: GetProductsParameters -> GetProductsParameters -> Bool # (/=) :: GetProductsParameters -> GetProductsParameters -> Bool # | |
Show GetProductsParameters Source # | |
Defined in StripeAPI.Operations.GetProducts Methods showsPrec :: Int -> GetProductsParameters -> ShowS # show :: GetProductsParameters -> String # showList :: [GetProductsParameters] -> ShowS # | |
ToJSON GetProductsParameters Source # | |
Defined in StripeAPI.Operations.GetProducts Methods toJSON :: GetProductsParameters -> Value # toEncoding :: GetProductsParameters -> Encoding # toJSONList :: [GetProductsParameters] -> Value # toEncodingList :: [GetProductsParameters] -> Encoding # | |
FromJSON GetProductsParameters Source # | |
Defined in StripeAPI.Operations.GetProducts Methods parseJSON :: Value -> Parser GetProductsParameters # parseJSONList :: Value -> Parser [GetProductsParameters] # |
mkGetProductsParameters :: GetProductsParameters Source #
Create a new GetProductsParameters
with all required fields.
data GetProductsParametersQueryCreated'OneOf1 Source #
Defines the object schema located at paths./v1/products.GET.parameters.properties.queryCreated.anyOf
in the specification.
Constructors
GetProductsParametersQueryCreated'OneOf1 | |
Instances
mkGetProductsParametersQueryCreated'OneOf1 :: GetProductsParametersQueryCreated'OneOf1 Source #
Create a new GetProductsParametersQueryCreated'OneOf1
with all required fields.
data GetProductsParametersQueryCreated'Variants Source #
Defines the oneOf schema located at paths./v1/products.GET.parameters.properties.queryCreated.anyOf
in the specification.
Represents the parameter named 'created'
Only return products that were created during the given date interval.
Constructors
GetProductsParametersQueryCreated'GetProductsParametersQueryCreated'OneOf1 GetProductsParametersQueryCreated'OneOf1 | |
GetProductsParametersQueryCreated'Int Int |
Instances
data GetProductsResponse Source #
Represents a response of the operation getProducts
.
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), GetProductsResponseError
is used.
Constructors
GetProductsResponseError String | Means either no matching case available or a parse error |
GetProductsResponse200 GetProductsResponseBody200 | Successful response. |
GetProductsResponseDefault Error | Error response. |
Instances
Eq GetProductsResponse Source # | |
Defined in StripeAPI.Operations.GetProducts Methods (==) :: GetProductsResponse -> GetProductsResponse -> Bool # (/=) :: GetProductsResponse -> GetProductsResponse -> Bool # | |
Show GetProductsResponse Source # | |
Defined in StripeAPI.Operations.GetProducts Methods showsPrec :: Int -> GetProductsResponse -> ShowS # show :: GetProductsResponse -> String # showList :: [GetProductsResponse] -> ShowS # |
data GetProductsResponseBody200 Source #
Defines the object schema located at paths./v1/products.GET.responses.200.content.application/json.schema
in the specification.
Constructors
GetProductsResponseBody200 | |
Fields
|
Instances
mkGetProductsResponseBody200 Source #
Arguments
:: [Product] | |
-> Bool | |
-> Text | |
-> GetProductsResponseBody200 |
Create a new GetProductsResponseBody200
with all required fields.