Class: Recurly::Resources::CustomFieldDefinition

Inherits:
Recurly::Resource show all
Defined in:
lib/recurly/resources/custom_field_definition.rb

Instance Attribute Summary collapse

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_atDateTime

Returns Created at.

Returns:

  • (DateTime)

    Created at



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

define_attribute :created_at, DateTime

#deleted_atDateTime

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.



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

define_attribute :deleted_at, DateTime

#display_nameString

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.



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

define_attribute :display_name, String

#idString

Returns Custom field definition ID.

Returns:

  • (String)

    Custom field definition ID



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

define_attribute :id, String

#nameString

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.



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

define_attribute :name, String

#objectString

Returns Object type.

Returns:

  • (String)

    Object type



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

define_attribute :object, String

Returns Related Recurly object type.

Returns:

  • (String)

    Related Recurly object type



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

define_attribute :related_type, String

#tooltipString

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.



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

define_attribute :tooltip, String

#updated_atDateTime

Returns Last updated at.

Returns:

  • (DateTime)

    Last updated at



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

define_attribute :updated_at, DateTime

#user_accessString

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.

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.



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

define_attribute :user_access, String