Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.GetPromotionCodes

Description

Contains the different functions to run the operation getPromotionCodes

Synopsis

getPromotionCodes :: forall m. MonadHTTP m => GetPromotionCodesParameters -> ClientT m (Response GetPromotionCodesResponse)
data GetPromotionCodesParameters = GetPromotionCodesParameters {
}
mkGetPromotionCodesParameters :: GetPromotionCodesParameters
data GetPromotionCodesParametersQueryCreated'OneOf1 = GetPromotionCodesParametersQueryCreated'OneOf1 {
}
mkGetPromotionCodesParametersQueryCreated'OneOf1 :: GetPromotionCodesParametersQueryCreated'OneOf1
data GetPromotionCodesParametersQueryCreated'Variants
- = GetPromotionCodesParametersQueryCreated'GetPromotionCodesParametersQueryCreated'OneOf1 GetPromotionCodesParametersQueryCreated'OneOf1
- | GetPromotionCodesParametersQueryCreated'Int Int
data GetPromotionCodesResponse
data GetPromotionCodesResponseBody200 = GetPromotionCodesResponseBody200 {
}
mkGetPromotionCodesResponseBody200 :: [PromotionCode] -> Bool -> Text -> GetPromotionCodesResponseBody200

Documentation

getPromotionCodes Source #

Arguments

:: forall m. MonadHTTP m
=> GetPromotionCodesParameters	Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetPromotionCodesResponse)	Monadic computation which returns the result of the operation

GET /v1/promotion_codes

<p>Returns a list of your promotion codes.</p>

data GetPromotionCodesParameters Source #

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

Constructors

GetPromotionCodesParameters

Fields

getPromotionCodesParametersQueryActive :: Maybe Bool
queryActive: Represents the parameter named 'active'
Filter promotion codes by whether they are active.
getPromotionCodesParametersQueryCode :: Maybe Text
queryCode: Represents the parameter named 'code'
Only return promotion codes that have this case-insensitive code.
Constraints:
- Maximum length of 5000
getPromotionCodesParametersQueryCoupon :: Maybe Text
queryCoupon: Represents the parameter named 'coupon'
Only return promotion codes for this coupon.
Constraints:
- Maximum length of 5000
getPromotionCodesParametersQueryCreated :: Maybe GetPromotionCodesParametersQueryCreated'Variants
queryCreated: Represents the parameter named 'created'
A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
getPromotionCodesParametersQueryCustomer :: Maybe Text
queryCustomer: Represents the parameter named 'customer'
Only return promotion codes that are restricted to this customer.
Constraints:
- Maximum length of 5000
getPromotionCodesParametersQueryEndingBefore :: 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
getPromotionCodesParametersQueryExpand :: Maybe [Text]
queryExpand: Represents the parameter named 'expand'
Specifies which fields in the response should be expanded.
getPromotionCodesParametersQueryLimit :: 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.
getPromotionCodesParametersQueryStartingAfter :: 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

Instances

Instances details

Eq GetPromotionCodesParameters Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods (==) :: GetPromotionCodesParameters -> GetPromotionCodesParameters -> Bool # (/=) :: GetPromotionCodesParameters -> GetPromotionCodesParameters -> Bool #
Show GetPromotionCodesParameters Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods showsPrec :: Int -> GetPromotionCodesParameters -> ShowS # show :: GetPromotionCodesParameters -> String # showList :: [GetPromotionCodesParameters] -> ShowS #
ToJSON GetPromotionCodesParameters Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods toJSON :: GetPromotionCodesParameters -> Value # toEncoding :: GetPromotionCodesParameters -> Encoding # toJSONList :: [GetPromotionCodesParameters] -> Value # toEncodingList :: [GetPromotionCodesParameters] -> Encoding #
FromJSON GetPromotionCodesParameters Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods parseJSON :: Value -> Parser GetPromotionCodesParameters # parseJSONList :: Value -> Parser [GetPromotionCodesParameters] #

mkGetPromotionCodesParameters :: GetPromotionCodesParameters Source #

Create a new GetPromotionCodesParameters with all required fields.

data GetPromotionCodesParametersQueryCreated'OneOf1 Source #

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

Constructors

GetPromotionCodesParametersQueryCreated'OneOf1
Fields getPromotionCodesParametersQueryCreated'OneOf1Gt :: Maybe Int gt getPromotionCodesParametersQueryCreated'OneOf1Gte :: Maybe Int gte getPromotionCodesParametersQueryCreated'OneOf1Lt :: Maybe Int lt getPromotionCodesParametersQueryCreated'OneOf1Lte :: Maybe Int lte

Instances

Instances details

Eq GetPromotionCodesParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods (==) :: GetPromotionCodesParametersQueryCreated'OneOf1 -> GetPromotionCodesParametersQueryCreated'OneOf1 -> Bool # (/=) :: GetPromotionCodesParametersQueryCreated'OneOf1 -> GetPromotionCodesParametersQueryCreated'OneOf1 -> Bool #
Show GetPromotionCodesParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods showsPrec :: Int -> GetPromotionCodesParametersQueryCreated'OneOf1 -> ShowS # show :: GetPromotionCodesParametersQueryCreated'OneOf1 -> String # showList :: [GetPromotionCodesParametersQueryCreated'OneOf1] -> ShowS #
ToJSON GetPromotionCodesParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods toJSON :: GetPromotionCodesParametersQueryCreated'OneOf1 -> Value # toEncoding :: GetPromotionCodesParametersQueryCreated'OneOf1 -> Encoding # toJSONList :: [GetPromotionCodesParametersQueryCreated'OneOf1] -> Value # toEncodingList :: [GetPromotionCodesParametersQueryCreated'OneOf1] -> Encoding #
FromJSON GetPromotionCodesParametersQueryCreated'OneOf1 Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods parseJSON :: Value -> Parser GetPromotionCodesParametersQueryCreated'OneOf1 # parseJSONList :: Value -> Parser [GetPromotionCodesParametersQueryCreated'OneOf1] #

mkGetPromotionCodesParametersQueryCreated'OneOf1 :: GetPromotionCodesParametersQueryCreated'OneOf1 Source #

Create a new GetPromotionCodesParametersQueryCreated'OneOf1 with all required fields.

data GetPromotionCodesParametersQueryCreated'Variants Source #

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

Represents the parameter named 'created'

A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

Constructors

GetPromotionCodesParametersQueryCreated'GetPromotionCodesParametersQueryCreated'OneOf1 GetPromotionCodesParametersQueryCreated'OneOf1
GetPromotionCodesParametersQueryCreated'Int Int

Instances

Instances details

Eq GetPromotionCodesParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods (==) :: GetPromotionCodesParametersQueryCreated'Variants -> GetPromotionCodesParametersQueryCreated'Variants -> Bool # (/=) :: GetPromotionCodesParametersQueryCreated'Variants -> GetPromotionCodesParametersQueryCreated'Variants -> Bool #
Show GetPromotionCodesParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods showsPrec :: Int -> GetPromotionCodesParametersQueryCreated'Variants -> ShowS # show :: GetPromotionCodesParametersQueryCreated'Variants -> String # showList :: [GetPromotionCodesParametersQueryCreated'Variants] -> ShowS #
ToJSON GetPromotionCodesParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods toJSON :: GetPromotionCodesParametersQueryCreated'Variants -> Value # toEncoding :: GetPromotionCodesParametersQueryCreated'Variants -> Encoding # toJSONList :: [GetPromotionCodesParametersQueryCreated'Variants] -> Value # toEncodingList :: [GetPromotionCodesParametersQueryCreated'Variants] -> Encoding #
FromJSON GetPromotionCodesParametersQueryCreated'Variants Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods parseJSON :: Value -> Parser GetPromotionCodesParametersQueryCreated'Variants # parseJSONList :: Value -> Parser [GetPromotionCodesParametersQueryCreated'Variants] #

data GetPromotionCodesResponse Source #

Represents a response of the operation getPromotionCodes.

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

Constructors

GetPromotionCodesResponseError String	Means either no matching case available or a parse error
GetPromotionCodesResponse200 GetPromotionCodesResponseBody200	Successful response.
GetPromotionCodesResponseDefault Error	Error response.

Instances

Instances details

Eq GetPromotionCodesResponse Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods (==) :: GetPromotionCodesResponse -> GetPromotionCodesResponse -> Bool # (/=) :: GetPromotionCodesResponse -> GetPromotionCodesResponse -> Bool #
Show GetPromotionCodesResponse Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods showsPrec :: Int -> GetPromotionCodesResponse -> ShowS # show :: GetPromotionCodesResponse -> String # showList :: [GetPromotionCodesResponse] -> ShowS #

data GetPromotionCodesResponseBody200 Source #

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

Constructors

GetPromotionCodesResponseBody200
Fields getPromotionCodesResponseBody200Data :: [PromotionCode] data getPromotionCodesResponseBody200HasMore :: Bool has_more: True if this list has another page of items after this one that can be fetched. getPromotionCodesResponseBody200Url :: Text url: The URL where this list can be accessed. Constraints: Maximum length of 5000 Must match pattern '^/v1/promotion_codes'

Instances

Instances details

Eq GetPromotionCodesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods (==) :: GetPromotionCodesResponseBody200 -> GetPromotionCodesResponseBody200 -> Bool # (/=) :: GetPromotionCodesResponseBody200 -> GetPromotionCodesResponseBody200 -> Bool #
Show GetPromotionCodesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods showsPrec :: Int -> GetPromotionCodesResponseBody200 -> ShowS # show :: GetPromotionCodesResponseBody200 -> String # showList :: [GetPromotionCodesResponseBody200] -> ShowS #
ToJSON GetPromotionCodesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods toJSON :: GetPromotionCodesResponseBody200 -> Value # toEncoding :: GetPromotionCodesResponseBody200 -> Encoding # toJSONList :: [GetPromotionCodesResponseBody200] -> Value # toEncodingList :: [GetPromotionCodesResponseBody200] -> Encoding #
FromJSON GetPromotionCodesResponseBody200 Source #
Instance details Defined in StripeAPI.Operations.GetPromotionCodes Methods parseJSON :: Value -> Parser GetPromotionCodesResponseBody200 # parseJSONList :: Value -> Parser [GetPromotionCodesResponseBody200] #

mkGetPromotionCodesResponseBody200 Source #

Arguments

:: [PromotionCode]	`getPromotionCodesResponseBody200Data`
-> Bool	`getPromotionCodesResponseBody200HasMore`
-> Text	`getPromotionCodesResponseBody200Url`
-> GetPromotionCodesResponseBody200

Create a new GetPromotionCodesResponseBody200 with all required fields.