StripeAPI.Operations.GetSkus

Contains the different functions to run the operation getSkus

Documentation

getSkus

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Bool

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

-> Maybe Text

attributes: Only return SKUs that have the specified key-value pairs in this partially constructed dictionary. Can be specified only if `product` is also supplied. For instance, if the associated product has attributes `["color", "size"]`, passing in `attributes[color]=red` returns all the SKUs for this product that have `color` set to `red`.

-> 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 SKUs with the given IDs.

-> Maybe Bool

in_stock: Only return SKUs that are either in stock or out of stock (e.g., pass `false` to list all SKUs that are out of stock). If no value is provided, all SKUs are returned.

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

product: The ID of the product whose SKUs will be retrieved. Must be a product with type `good`. | Constraints: Maximum length of 5000

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

The request body to send

-> m (Either HttpException (Response GetSkusResponse))

Monad containing the result of the operation

GET /v1/skus

<p>Returns a list of your SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.</p>

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

GET /v1/skus

The same as getSkus but returns the raw ByteString

getSkusM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetSkusRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetSkusResponse))

GET /v1/skus

Monadic version of getSkus (use with runWithConfiguration)

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

GET /v1/skus

Monadic version of getSkusRaw (use with runWithConfiguration)

data GetSkusRequestBody

Defines the data type for the schema getSkusRequestBody

Constructors

GetSkusRequestBody

Instances

Eq GetSkusRequestBody

Defined in StripeAPI.Operations.GetSkus

Methods

(==) :: GetSkusRequestBody -> GetSkusRequestBody -> Bool

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

Show GetSkusRequestBody

Defined in StripeAPI.Operations.GetSkus

Methods

showsPrec :: Int -> GetSkusRequestBody -> ShowS

show :: GetSkusRequestBody -> String

showList :: [GetSkusRequestBody] -> ShowS

ToJSON GetSkusRequestBody

Defined in StripeAPI.Operations.GetSkus

Methods

toJSON :: GetSkusRequestBody -> Value

toEncoding :: GetSkusRequestBody -> Encoding

toJSONList :: [GetSkusRequestBody] -> Value

toEncodingList :: [GetSkusRequestBody] -> Encoding

FromJSON GetSkusRequestBody

Defined in StripeAPI.Operations.GetSkus

Methods

parseJSON :: Value -> Parser GetSkusRequestBody

parseJSONList :: Value -> Parser [GetSkusRequestBody]

data GetSkusResponse

Represents a response of the operation getSkus.

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), GetSkusResponseError is used.

Constructors

GetSkusResponseError String

Means either no matching case available or a parse error

GetSkusResponse200 GetSkusResponseBody200

Successful response.

GetSkusResponseDefault Error

Error response.

Instances

Eq GetSkusResponse

Defined in StripeAPI.Operations.GetSkus

Methods

(==) :: GetSkusResponse -> GetSkusResponse -> Bool

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

Show GetSkusResponse

Defined in StripeAPI.Operations.GetSkus

Methods

showsPrec :: Int -> GetSkusResponse -> ShowS

show :: GetSkusResponse -> String

showList :: [GetSkusResponse] -> ShowS

data GetSkusResponseBody200

Defines the data type for the schema GetSkusResponseBody200

Constructors

GetSkusResponseBody200

Fields

• getSkusResponseBody200Data :: [] Sku

  data

• getSkusResponseBody200HasMore :: Bool

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

• getSkusResponseBody200Object :: GetSkusResponseBody200Object'

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

• getSkusResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

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

Instances

Eq GetSkusResponseBody200

Defined in StripeAPI.Operations.GetSkus

Methods

(==) :: GetSkusResponseBody200 -> GetSkusResponseBody200 -> Bool

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

Show GetSkusResponseBody200

Defined in StripeAPI.Operations.GetSkus

Methods

showsPrec :: Int -> GetSkusResponseBody200 -> ShowS

show :: GetSkusResponseBody200 -> String

showList :: [GetSkusResponseBody200] -> ShowS

ToJSON GetSkusResponseBody200

Defined in StripeAPI.Operations.GetSkus

Methods

toJSON :: GetSkusResponseBody200 -> Value

toEncoding :: GetSkusResponseBody200 -> Encoding

toJSONList :: [GetSkusResponseBody200] -> Value

toEncodingList :: [GetSkusResponseBody200] -> Encoding

FromJSON GetSkusResponseBody200

Defined in StripeAPI.Operations.GetSkus

Methods

parseJSON :: Value -> Parser GetSkusResponseBody200

parseJSONList :: Value -> Parser [GetSkusResponseBody200]

data GetSkusResponseBody200Object'

Defines the enum schema GetSkusResponseBody200Object'

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

Constructors

GetSkusResponseBody200Object'EnumOther Value

GetSkusResponseBody200Object'EnumTyped Text

GetSkusResponseBody200Object'EnumStringList

Instances

Eq GetSkusResponseBody200Object'

Defined in StripeAPI.Operations.GetSkus

Methods

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

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

Show GetSkusResponseBody200Object'

Defined in StripeAPI.Operations.GetSkus

Methods

showsPrec :: Int -> GetSkusResponseBody200Object' -> ShowS

show :: GetSkusResponseBody200Object' -> String

showList :: [GetSkusResponseBody200Object'] -> ShowS

ToJSON GetSkusResponseBody200Object'

Defined in StripeAPI.Operations.GetSkus

Methods

toJSON :: GetSkusResponseBody200Object' -> Value

toEncoding :: GetSkusResponseBody200Object' -> Encoding

toJSONList :: [GetSkusResponseBody200Object'] -> Value

toEncodingList :: [GetSkusResponseBody200Object'] -> Encoding

FromJSON GetSkusResponseBody200Object'

Defined in StripeAPI.Operations.GetSkus

Methods

parseJSON :: Value -> Parser GetSkusResponseBody200Object'

parseJSONList :: Value -> Parser [GetSkusResponseBody200Object']