Class: Recurly::Resources::CustomFieldDefinition

Inherits:

Recurly::Resource

• Object
• Recurly::Resource
• Recurly::Resources::CustomFieldDefinition

Defined in:

lib/recurly/resources/custom_field_definition.rb

Instance Attribute Summary

• #created_at ⇒ DateTime

  Created at.

• #deleted_at ⇒ DateTime

  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.

• #display_name ⇒ String

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

• #id ⇒ String

  Custom field definition ID.

• #name ⇒ String

  Used by the API to identify the field or reading and writing.

• #object ⇒ String

  Object type.

• #related_type ⇒ String

  Related Recurly object type.

• #tooltip ⇒ String

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

• #updated_at ⇒ DateTime

  Last updated at.

• #user_access ⇒ String

  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.

Attributes inherited from Recurly::Resource

#attributes

Method Summary

Methods inherited from Recurly::Resource

#==, #get_response, #inspect, #requires_client?, #to_json, #to_s

Methods included from Schema::SchemaFactory

#schema

Methods included from Schema::ResourceCaster

#cast

Methods included from Schema::SchemaValidator

#get_did_you_mean, #validate!, #validate_attribute!

Instance Attribute Details

#created_at ⇒ DateTime

Returns Created at.

Returns:

• (DateTime) —

  Created at

# File 'lib/recurly/resources/custom_field_definition.rb', line 11

define_attribute :created_at, DateTime

#deleted_at ⇒ DateTime

Returns 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.

Returns:

• (DateTime) —

  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.

# File 'lib/recurly/resources/custom_field_definition.rb', line 15

define_attribute :deleted_at, DateTime

#display_name ⇒ String

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

Returns:

• (String) —

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

# File 'lib/recurly/resources/custom_field_definition.rb', line 19

define_attribute :display_name, String

#id ⇒ String

Returns Custom field definition ID.

Returns:

• (String) —

  Custom field definition ID

# File 'lib/recurly/resources/custom_field_definition.rb', line 23

define_attribute :id, String

#name ⇒ String

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

Returns:

• (String) —

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

# File 'lib/recurly/resources/custom_field_definition.rb', line 27

define_attribute :name, String

#object ⇒ String

Returns Object type.

Returns:

• (String) —

  Object type

# File 'lib/recurly/resources/custom_field_definition.rb', line 31

define_attribute :object, String

#related_type ⇒ String

Returns Related Recurly object type.

Returns:

• (String) —

  Related Recurly object type

# File 'lib/recurly/resources/custom_field_definition.rb', line 35

define_attribute :related_type, String

#tooltip ⇒ String

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

Returns:

• (String) —

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

# File 'lib/recurly/resources/custom_field_definition.rb', line 39

define_attribute :tooltip, String

#updated_at ⇒ DateTime

Returns Last updated at.

Returns:

• (DateTime) —

  Last updated at

# File 'lib/recurly/resources/custom_field_definition.rb', line 43

define_attribute :updated_at, DateTime

#user_access ⇒ String

Returns 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.

Returns:

• (String) —

  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.

# File 'lib/recurly/resources/custom_field_definition.rb', line 47

define_attribute :user_access, String