StripeAPI.Operations.GetProducts

Contains the different functions to run the operation getProducts

Documentation

getProducts

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Bool

active: Only return products that are active or inactive (e.g., pass `false` to list all inactive products).

-> Maybe Text

created: Only return products that were created during the given date interval.

-> 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. | Constraints: Maximum length of 5000

-> Maybe Text

expand: Specifies which fields in the response should be expanded.

-> Maybe Text

ids: Only return products with the given IDs.

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

shippable: Only return products that can be shipped (i.e., physical, not digital products).

-> 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. | Constraints: Maximum length of 5000

-> Maybe Text

type: Only return products of this type. | Constraints: Maximum length of 5000

-> Maybe Text

url: Only return products with the given url. | Constraints: Maximum length of 5000

-> Maybe GetProductsRequestBody

The request body to send

-> m (Either HttpException (Response GetProductsResponse))

Monad containing 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>

getProductsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetProductsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/products

The same as getProducts but returns the raw ByteString

getProductsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetProductsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetProductsResponse))

GET /v1/products

Monadic version of getProducts (use with runWithConfiguration)

getProductsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe GetProductsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/products

Monadic version of getProductsRaw (use with runWithConfiguration)

data GetProductsRequestBody

Defines the data type for the schema getProductsRequestBody

Constructors

GetProductsRequestBody

Instances

Eq GetProductsRequestBody

Defined in StripeAPI.Operations.GetProducts

Methods

(==) :: GetProductsRequestBody -> GetProductsRequestBody -> Bool

(/=) :: GetProductsRequestBody -> GetProductsRequestBody -> Bool

Show GetProductsRequestBody

Defined in StripeAPI.Operations.GetProducts

Methods

showsPrec :: Int -> GetProductsRequestBody -> ShowS

show :: GetProductsRequestBody -> String

showList :: [GetProductsRequestBody] -> ShowS

ToJSON GetProductsRequestBody

Defined in StripeAPI.Operations.GetProducts

Methods

toJSON :: GetProductsRequestBody -> Value

toEncoding :: GetProductsRequestBody -> Encoding

toJSONList :: [GetProductsRequestBody] -> Value

toEncodingList :: [GetProductsRequestBody] -> Encoding

FromJSON GetProductsRequestBody

Defined in StripeAPI.Operations.GetProducts

Methods

parseJSON :: Value -> Parser GetProductsRequestBody

parseJSONList :: Value -> Parser [GetProductsRequestBody]

data 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.

Instances

Eq GetProductsResponse

Defined in StripeAPI.Operations.GetProducts

Methods

(==) :: GetProductsResponse -> GetProductsResponse -> Bool

(/=) :: GetProductsResponse -> GetProductsResponse -> Bool

Show GetProductsResponse

Defined in StripeAPI.Operations.GetProducts

Methods

showsPrec :: Int -> GetProductsResponse -> ShowS

show :: GetProductsResponse -> String

showList :: [GetProductsResponse] -> ShowS

data GetProductsResponseBody200

Defines the data type for the schema GetProductsResponseBody200

Constructors

GetProductsResponseBody200

Fields

• getProductsResponseBody200Data :: [] Product

  data

• getProductsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getProductsResponseBody200Object :: GetProductsResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getProductsResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/products'

Instances

Eq GetProductsResponseBody200

Defined in StripeAPI.Operations.GetProducts

Methods

(==) :: GetProductsResponseBody200 -> GetProductsResponseBody200 -> Bool

(/=) :: GetProductsResponseBody200 -> GetProductsResponseBody200 -> Bool

Show GetProductsResponseBody200

Defined in StripeAPI.Operations.GetProducts

Methods

showsPrec :: Int -> GetProductsResponseBody200 -> ShowS

show :: GetProductsResponseBody200 -> String

showList :: [GetProductsResponseBody200] -> ShowS

ToJSON GetProductsResponseBody200

Defined in StripeAPI.Operations.GetProducts

Methods

toJSON :: GetProductsResponseBody200 -> Value

toEncoding :: GetProductsResponseBody200 -> Encoding

toJSONList :: [GetProductsResponseBody200] -> Value

toEncodingList :: [GetProductsResponseBody200] -> Encoding

FromJSON GetProductsResponseBody200

Defined in StripeAPI.Operations.GetProducts

Methods

parseJSON :: Value -> Parser GetProductsResponseBody200

parseJSONList :: Value -> Parser [GetProductsResponseBody200]

data GetProductsResponseBody200Object'

Defines the enum schema GetProductsResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetProductsResponseBody200Object'EnumOther Value

GetProductsResponseBody200Object'EnumTyped Text

GetProductsResponseBody200Object'EnumStringList

Instances

Eq GetProductsResponseBody200Object'

Defined in StripeAPI.Operations.GetProducts

Methods

(==) :: GetProductsResponseBody200Object' -> GetProductsResponseBody200Object' -> Bool

(/=) :: GetProductsResponseBody200Object' -> GetProductsResponseBody200Object' -> Bool

Show GetProductsResponseBody200Object'

Defined in StripeAPI.Operations.GetProducts

Methods

showsPrec :: Int -> GetProductsResponseBody200Object' -> ShowS

show :: GetProductsResponseBody200Object' -> String

showList :: [GetProductsResponseBody200Object'] -> ShowS

ToJSON GetProductsResponseBody200Object'

Defined in StripeAPI.Operations.GetProducts

Methods

toJSON :: GetProductsResponseBody200Object' -> Value

toEncoding :: GetProductsResponseBody200Object' -> Encoding

toJSONList :: [GetProductsResponseBody200Object'] -> Value

toEncodingList :: [GetProductsResponseBody200Object'] -> Encoding

FromJSON GetProductsResponseBody200Object'

Defined in StripeAPI.Operations.GetProducts

Methods

parseJSON :: Value -> Parser GetProductsResponseBody200Object'

parseJSONList :: Value -> Parser [GetProductsResponseBody200Object']