RecurlyClient.Types.CustomFieldDefinition

Contains the types generated from the schema CustomFieldDefinition

Documentation

data CustomFieldDefinition

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

Constructors

CustomFieldDefinition

Fields

• customFieldDefinitionCreated_at :: Maybe JsonDateTime

  created_at

• customFieldDefinitionDeleted_at :: Maybe JsonDateTime

  deleted_at: Definitions are initially soft deleted, and once all the values are removed from the accouts or subscriptions, will be hard deleted an no longer visible.

• customFieldDefinitionDisplay_name :: Maybe Text

  display_name: Used to label the field when viewing and editing the field in Recurly's admin UI.

  Constraints:

  • Maximum length of 50
• customFieldDefinitionId :: Maybe Text

  id

• customFieldDefinitionName :: Maybe Text

  name: Used by the API to identify the field or reading and writing. The name can only be used once per Recurly object type.

  Constraints:

  • Maximum length of 50
  • Must match pattern '/^[a-z0-9_-]+$/i'
• customFieldDefinitionObject :: Maybe Text

  object

• customFieldDefinitionRelated_type :: Maybe CustomFieldDefinitionRelated_type

  related_type

• customFieldDefinitionTooltip :: Maybe Text

  tooltip: Displayed as a tooltip when editing the field in the Recurly admin UI.

  Constraints:

  • Maximum length of 255
  • Must match pattern '/^[a-z0-9_-]+$/i'
• customFieldDefinitionUpdated_at :: Maybe JsonDateTime

  updated_at

• customFieldDefinitionUser_access :: Maybe CustomFieldDefinitionUser_access

  user_access: The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.

Instances

FromJSON CustomFieldDefinition

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

parseJSON :: Value -> Parser CustomFieldDefinition

parseJSONList :: Value -> Parser [CustomFieldDefinition]

ToJSON CustomFieldDefinition

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

toJSON :: CustomFieldDefinition -> Value

toEncoding :: CustomFieldDefinition -> Encoding

toJSONList :: [CustomFieldDefinition] -> Value

toEncodingList :: [CustomFieldDefinition] -> Encoding

Show CustomFieldDefinition

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

showsPrec :: Int -> CustomFieldDefinition -> ShowS

show :: CustomFieldDefinition -> String

showList :: [CustomFieldDefinition] -> ShowS

Eq CustomFieldDefinition

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

(==) :: CustomFieldDefinition -> CustomFieldDefinition -> Bool

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

mkCustomFieldDefinition :: CustomFieldDefinition

Create a new CustomFieldDefinition with all required fields.

data CustomFieldDefinitionRelated_type

Defines the enum schema located at components.schemas.CustomFieldDefinition.properties.related_type in the specification.

Constructors

CustomFieldDefinitionRelated_typeOther Value

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

CustomFieldDefinitionRelated_typeTyped Text

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

CustomFieldDefinitionRelated_typeEnumAccount

Represents the JSON value "account"

CustomFieldDefinitionRelated_typeEnumItem

Represents the JSON value "item"

CustomFieldDefinitionRelated_typeEnumPlan

Represents the JSON value "plan"

CustomFieldDefinitionRelated_typeEnumSubscription

Represents the JSON value "subscription"

CustomFieldDefinitionRelated_typeEnumCharge

Represents the JSON value "charge"

Instances

FromJSON CustomFieldDefinitionRelated_type

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

parseJSON :: Value -> Parser CustomFieldDefinitionRelated_type

parseJSONList :: Value -> Parser [CustomFieldDefinitionRelated_type]

ToJSON CustomFieldDefinitionRelated_type

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

toJSON :: CustomFieldDefinitionRelated_type -> Value

toEncoding :: CustomFieldDefinitionRelated_type -> Encoding

toJSONList :: [CustomFieldDefinitionRelated_type] -> Value

toEncodingList :: [CustomFieldDefinitionRelated_type] -> Encoding

Show CustomFieldDefinitionRelated_type

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

showsPrec :: Int -> CustomFieldDefinitionRelated_type -> ShowS

show :: CustomFieldDefinitionRelated_type -> String

showList :: [CustomFieldDefinitionRelated_type] -> ShowS

Eq CustomFieldDefinitionRelated_type

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

(==) :: CustomFieldDefinitionRelated_type -> CustomFieldDefinitionRelated_type -> Bool

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

data CustomFieldDefinitionUser_access

Defines the enum schema located at components.schemas.CustomFieldDefinition.properties.user_access in the specification.

The access control applied inside Recurly's admin UI: - `api_only` - No one will be able to view or edit this field's data via the admin UI. - `read_only` - Users with the Customers role will be able to view this field's data via the admin UI, but editing will only be available via the API. - `write` - Users with the Customers role will be able to view and edit this field's data via the admin UI. - `set_only` - Users with the Customers role will be able to set this field's data via the admin console.

Constructors

CustomFieldDefinitionUser_accessOther Value

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

CustomFieldDefinitionUser_accessTyped Text

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

CustomFieldDefinitionUser_accessEnumApi_only

Represents the JSON value "api_only"

CustomFieldDefinitionUser_accessEnumRead_only

Represents the JSON value "read_only"

CustomFieldDefinitionUser_accessEnumWrite

Represents the JSON value "write"

CustomFieldDefinitionUser_accessEnumSet_only

Represents the JSON value "set_only"

Instances

FromJSON CustomFieldDefinitionUser_access

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

parseJSON :: Value -> Parser CustomFieldDefinitionUser_access

parseJSONList :: Value -> Parser [CustomFieldDefinitionUser_access]

ToJSON CustomFieldDefinitionUser_access

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

toJSON :: CustomFieldDefinitionUser_access -> Value

toEncoding :: CustomFieldDefinitionUser_access -> Encoding

toJSONList :: [CustomFieldDefinitionUser_access] -> Value

toEncodingList :: [CustomFieldDefinitionUser_access] -> Encoding

Show CustomFieldDefinitionUser_access

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

showsPrec :: Int -> CustomFieldDefinitionUser_access -> ShowS

show :: CustomFieldDefinitionUser_access -> String

showList :: [CustomFieldDefinitionUser_access] -> ShowS

Eq CustomFieldDefinitionUser_access

Defined in RecurlyClient.Types.CustomFieldDefinition

Methods

(==) :: CustomFieldDefinitionUser_access -> CustomFieldDefinitionUser_access -> Bool

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