Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetProducts

Contains the different functions to run the operation getProducts

5 types
4 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetProducts.hs

valuegetProducts

:: 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>

datadata GetProductsParameters

Defines the object schema located at paths./v1/products.GET.parameters in the specification.

Constructors

GetProductsParameters
- getProductsParametersQueryActive :: Maybe Bool
  queryActive: Represents the parameter named 'active'
  Only return products that are active or inactive (e.g., pass `false` to list all inactive products).
- getProductsParametersQueryCreated :: Maybe GetProductsParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
  Only return products that were created during the given date interval.
- getProductsParametersQueryEndingBefore :: Maybe Text
  queryEnding_before: Represents the parameter named '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
- getProductsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getProductsParametersQueryIds :: Maybe [Text]
  queryIds: Represents the parameter named 'ids'
  Only return products with the given IDs.
- getProductsParametersQueryLimit :: Maybe Int
  queryLimit: Represents the parameter named 'limit'
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- getProductsParametersQueryShippable :: Maybe Bool
  queryShippable: Represents the parameter named 'shippable'
  Only return products that can be shipped (i.e., physical, not digital products).
- getProductsParametersQueryStartingAfter :: Maybe Text
  queryStarting_after: Represents the parameter named '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
- getProductsParametersQueryUrl :: Maybe Text
  queryUrl: Represents the parameter named 'url'
  Only return products with the given url.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetProductsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
Show GetProductsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
FromJSON GetProductsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
ToJSON GetProductsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts

valuemkGetProductsParameters :: GetProductsParameters

Create a new GetProductsParameters with all required fields.

datadata GetProductsParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/products.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetProductsParametersQueryCreated'OneOf1
- getProductsParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getProductsParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getProductsParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getProductsParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetProductsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
Show GetProductsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
FromJSON GetProductsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
ToJSON GetProductsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts

valuemkGetProductsParametersQueryCreated'OneOf1 :: GetProductsParametersQueryCreated'OneOf1

Create a new GetProductsParametersQueryCreated'OneOf1 with all required fields.

datadata GetProductsParametersQueryCreated'Variants

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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetProductsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
Show GetProductsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
FromJSON GetProductsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
ToJSON GetProductsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts

datadata GetProductsResponse

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.

Instances2Eq, Show

Eq GetProductsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
Show GetProductsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts

datadata GetProductsResponseBody200

Defines the object schema located at paths./v1/products.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetProductsResponseBody200
- getProductsResponseBody200Data :: [Product]
  data: Details about each object.
- getProductsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getProductsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/products'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetProductsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
Show GetProductsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
FromJSON GetProductsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts
ToJSON GetProductsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetProducts

valuemkGetProductsResponseBody200

:: [Product]
getProductsResponseBody200Data
-> Bool
getProductsResponseBody200HasMore
-> Text
getProductsResponseBody200Url
-> GetProductsResponseBody200

Create a new GetProductsResponseBody200 with all required fields.