Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Types.CouponMini

Description

Contains the types generated from the schema CouponMini

Documentation

data CouponMini Source #

Defines the object schema located at components.schemas.CouponMini in the specification.

Constructors

CouponMini

Fields

couponMiniCode :: Maybe Text
code: The code the customer enters to redeem the coupon.
couponMiniCoupon_type :: Maybe CouponMiniCoupon_type
coupon_type: Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.
couponMiniDiscount :: Maybe CouponDiscount
discount: Details of the discount a coupon applies. Will contain a `type` property and one of the following properties: `percent`, `fixed`, `trial`.
couponMiniExpired_at :: Maybe JsonDateTime
expired_at: The date and time the coupon was expired early or reached its `max_redemptions`.
couponMiniId :: Maybe Text
id
couponMiniName :: Maybe Text
name: The internal name for the coupon.
couponMiniObject :: Maybe Text
object
couponMiniState :: Maybe CouponMiniState
state: Indicates if the coupon is redeemable, and if it is not, why.

Instances

Instances details

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

mkCouponMini :: CouponMini Source #

Create a new CouponMini with all required fields.

data CouponMiniCoupon_type Source #

Defines the enum schema located at components.schemas.CouponMini.properties.coupon_type in the specification.

Whether the coupon is "single_code" or "bulk". Bulk coupons will require a `unique_code_template` and will generate unique codes through the `/generate` endpoint.

Constructors

CouponMiniCoupon_typeOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CouponMiniCoupon_typeTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
CouponMiniCoupon_typeEnumBulk	Represents the JSON value `"bulk"`
CouponMiniCoupon_typeEnumSingle_code	Represents the JSON value `"single_code"`

Instances

Instances details

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

data CouponMiniState Source #

Defines the enum schema located at components.schemas.CouponMini.properties.state in the specification.

Indicates if the coupon is redeemable, and if it is not, why.

Constructors

CouponMiniStateOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
CouponMiniStateTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
CouponMiniStateEnumExpired	Represents the JSON value `"expired"`
CouponMiniStateEnumMaxed_out	Represents the JSON value `"maxed_out"`
CouponMiniStateEnumRedeemable	Represents the JSON value `"redeemable"`

Instances

Instances details

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