StripeAPI.Types.Radar_ValueList

Contains the types generated from the schema Radar_ValueList

Documentation

data Radar'valueList

Defines the object schema located at components.schemas.radar.value_list in the specification.

Value lists allow you to group values together which can then be referenced in rules.

Related guide: Default Stripe Lists.

Constructors

Radar'valueList

Fields

• radar'valueListAlias :: Text

  alias: The name of the value list for use in rules.

  Constraints:

  • Maximum length of 5000
• radar'valueListCreated :: Int

  created: Time at which the object was created. Measured in seconds since the Unix epoch.

• radar'valueListCreatedBy :: Text

  created_by: The name or email address of the user who created this value list.

  Constraints:

  • Maximum length of 5000
• radar'valueListId :: Text

  id: Unique identifier for the object.

  Constraints:

  • Maximum length of 5000
• radar'valueListItemType :: Radar'valueListItemType'

  item_type: The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, or `case_sensitive_string`.

• radar'valueListListItems :: Radar'valueListListItems'

  list_items: List of items contained within this value list.

• radar'valueListLivemode :: Bool

  livemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

• radar'valueListMetadata :: Object

  metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

• radar'valueListName :: Text

  name: The name of the value list.

  Constraints:

  • Maximum length of 5000

Instances

Eq Radar'valueList

Defined in StripeAPI.Types.Radar_ValueList

Methods

(==) :: Radar'valueList -> Radar'valueList -> Bool

(/=) :: Radar'valueList -> Radar'valueList -> Bool

Show Radar'valueList

Defined in StripeAPI.Types.Radar_ValueList

Methods

showsPrec :: Int -> Radar'valueList -> ShowS

show :: Radar'valueList -> String

showList :: [Radar'valueList] -> ShowS

ToJSON Radar'valueList

Defined in StripeAPI.Types.Radar_ValueList

Methods

toJSON :: Radar'valueList -> Value

toEncoding :: Radar'valueList -> Encoding

toJSONList :: [Radar'valueList] -> Value

toEncodingList :: [Radar'valueList] -> Encoding

FromJSON Radar'valueList

Defined in StripeAPI.Types.Radar_ValueList

Methods

parseJSON :: Value -> Parser Radar'valueList

parseJSONList :: Value -> Parser [Radar'valueList]

mkRadar'valueList

Arguments

:: Text

radar'valueListAlias

-> Int

radar'valueListCreated

-> Text

radar'valueListCreatedBy

-> Text

radar'valueListId

-> Radar'valueListItemType'

radar'valueListItemType

-> Radar'valueListListItems'

radar'valueListListItems

-> Bool

radar'valueListLivemode

-> Object

radar'valueListMetadata

-> Text

radar'valueListName

-> Radar'valueList

Create a new Radar'valueList with all required fields.

data Radar'valueListItemType'

Defines the enum schema located at components.schemas.radar.value_list.properties.item_type in the specification.

The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, or `case_sensitive_string`.

Constructors

Radar'valueListItemType'Other Value

This case is used if the value encountered during decoding does not match any of the provided cases in the specification.

Radar'valueListItemType'Typed Text

This constructor can be used to send values to the server which are not present in the specification yet.

Radar'valueListItemType'EnumCardBin

Represents the JSON value "card_bin"

Radar'valueListItemType'EnumCardFingerprint

Represents the JSON value "card_fingerprint"

Radar'valueListItemType'EnumCaseSensitiveString

Represents the JSON value "case_sensitive_string"

Radar'valueListItemType'EnumCountry

Represents the JSON value "country"

Radar'valueListItemType'EnumEmail

Represents the JSON value "email"

Radar'valueListItemType'EnumIpAddress

Represents the JSON value "ip_address"

Radar'valueListItemType'EnumString

Represents the JSON value "string"

Instances

Eq Radar'valueListItemType'

Defined in StripeAPI.Types.Radar_ValueList

Methods

(==) :: Radar'valueListItemType' -> Radar'valueListItemType' -> Bool

(/=) :: Radar'valueListItemType' -> Radar'valueListItemType' -> Bool

Show Radar'valueListItemType'

Defined in StripeAPI.Types.Radar_ValueList

Methods

showsPrec :: Int -> Radar'valueListItemType' -> ShowS

show :: Radar'valueListItemType' -> String

showList :: [Radar'valueListItemType'] -> ShowS

ToJSON Radar'valueListItemType'

Defined in StripeAPI.Types.Radar_ValueList

Methods

toJSON :: Radar'valueListItemType' -> Value

toEncoding :: Radar'valueListItemType' -> Encoding

toJSONList :: [Radar'valueListItemType'] -> Value

toEncodingList :: [Radar'valueListItemType'] -> Encoding

FromJSON Radar'valueListItemType'

Defined in StripeAPI.Types.Radar_ValueList

Methods

parseJSON :: Value -> Parser Radar'valueListItemType'

parseJSONList :: Value -> Parser [Radar'valueListItemType']

data Radar'valueListListItems'

Defines the object schema located at components.schemas.radar.value_list.properties.list_items in the specification.

List of items contained within this value list.

Constructors

Radar'valueListListItems'

Fields

• radar'valueListListItems'Data :: [Radar'valueListItem]

  data: Details about each object.

• radar'valueListListItems'HasMore :: Bool

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

• radar'valueListListItems'Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000

Instances

Eq Radar'valueListListItems'

Defined in StripeAPI.Types.Radar_ValueList

Methods

(==) :: Radar'valueListListItems' -> Radar'valueListListItems' -> Bool

(/=) :: Radar'valueListListItems' -> Radar'valueListListItems' -> Bool

Show Radar'valueListListItems'

Defined in StripeAPI.Types.Radar_ValueList

Methods

showsPrec :: Int -> Radar'valueListListItems' -> ShowS

show :: Radar'valueListListItems' -> String

showList :: [Radar'valueListListItems'] -> ShowS

ToJSON Radar'valueListListItems'

Defined in StripeAPI.Types.Radar_ValueList

Methods

toJSON :: Radar'valueListListItems' -> Value

toEncoding :: Radar'valueListListItems' -> Encoding

toJSONList :: [Radar'valueListListItems'] -> Value

toEncodingList :: [Radar'valueListListItems'] -> Encoding

FromJSON Radar'valueListListItems'

Defined in StripeAPI.Types.Radar_ValueList

Methods

parseJSON :: Value -> Parser Radar'valueListListItems'

parseJSONList :: Value -> Parser [Radar'valueListListItems']

mkRadar'valueListListItems'

Arguments

:: [Radar'valueListItem]

radar'valueListListItems'Data

-> Bool

radar'valueListListItems'HasMore

-> Text

radar'valueListListItems'Url

-> Radar'valueListListItems'

Create a new Radar'valueListListItems' with all required fields.