Safe Haskell	Safe-Inferred
Language	Haskell2010

RecurlyClient.Types.ItemMini

Description

Contains the types generated from the schema ItemMini

Synopsis

Documentation

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

Just the important parts.

Constructors

Fields

itemMiniCode :: Maybe Text
code: Unique code to identify the item.
Constraints:
- Maximum length of 50
- Must match pattern '/^[a-z0-9_+-]+$/'
itemMiniDescription :: Maybe Text
description: Optional, description.
itemMiniId :: Maybe Text
id
Constraints:
- Maximum length of 13
itemMiniName :: Maybe Text
name: This name describes your item and will appear on the invoice when it's purchased on a one time basis.
Constraints:
- Maximum length of 255
itemMiniObject :: Maybe Text
object
itemMiniState :: Maybe ItemMiniState
state: The current state of the item.

Instances details

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

Create a new ItemMini with all required fields.

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

The current state of the item.

Constructors

ItemMiniStateOther Value	This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
ItemMiniStateTyped Text	This constructor can be used to send values to the server which are not present in the specification yet.
ItemMiniStateEnumActive	Represents the JSON value `"active"`
ItemMiniStateEnumInactive	Represents the JSON value `"inactive"`

Instances details

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