Class: Zendesk2::TicketField

Inherits:

Object

• Object
• Zendesk2::TicketField

Extended by:

Attributes

Includes:

Model

Defined in:

lib/zendesk2/ticket_field.rb

Instance Attribute Summary

Attributes included from Model

#errors

Instance Method Summary

• #active ⇒ Boolean

  Whether this field is available.

• #agent_description ⇒ String

  A description of the ticket field that only agents can see.

• #collapsed_for_agents ⇒ String

  If this field should be shown to agents by default or be hidden alongside infrequently used fields.

• #created_at ⇒ Date

  The time the ticket field was created.

• #custom_field_options ⇒ Array

  Required and presented for a ticket field of type “tagger”.

• #description ⇒ String

  The description of the purpose of this ticket field, shown to users.

• #destroy! ⇒ Object
• #editable_in_portal ⇒ Boolean

  Whether this field is editable by end users.

• #id ⇒ integer

  Automatically assigned upon creation.

• #position ⇒ Integer

  A relative position for the ticket fields, determines the order of ticket fields on a ticket.

• #regexp_for_validation ⇒ String

  Regular expression field only.

• #removable ⇒ Boolean

  If this field is not a system basic field that must be present for all tickets on the account.

• #required ⇒ Boolean

  If it’s required for this field to have a value when updated by agents.

• #required_in_portal ⇒ Boolean

  If it’s required for this field to have a value when updated by end users.

• #save! ⇒ Object
• #system_field_options ⇒ Array

  Presented for a ticket field of type “tickettype”, “priority” or “status”.

• #tag ⇒ String

  A tag value to set for checkbox fields when checked.

• #title ⇒ String

  The title of the ticket field.

• #title_in_portal ⇒ String

  The title of the ticket field when shown to end users.

• #type ⇒ String

  The type of the ticket field.

• #updated_at ⇒ Date

  The time of the last update of the ticket field.

• #url ⇒ String

  The URL for this resource.

• #visible_in_portal ⇒ Boolean

  Whether this field is available to end users.

Methods included from Attributes

assoc_accessor, assoc_reader, assoc_writer

Methods included from Model

#destroy, #destroyed?, #missing_attributes, #save, #update!

Instance Method Details

#active ⇒ Boolean

# File 'lib/zendesk2/ticket_field.rb', line 11

attribute :active, type: :boolean

#agent_description ⇒ String

# File 'lib/zendesk2/ticket_field.rb', line 49

attribute :agent_description, type: :string

#collapsed_for_agents ⇒ String

# File 'lib/zendesk2/ticket_field.rb', line 13

attribute :collapsed_for_agents, type: :string

#created_at ⇒ Date

# File 'lib/zendesk2/ticket_field.rb', line 15

attribute :created_at, type: :time

#custom_field_options ⇒ Array

# File 'lib/zendesk2/ticket_field.rb', line 17

attribute :custom_field_options, type: :array

#description ⇒ String

# File 'lib/zendesk2/ticket_field.rb', line 19

attribute :description, type: :string

#destroy! ⇒ Object

# File 'lib/zendesk2/ticket_field.rb', line 65

def destroy!
  requires :identity

  cistern.destroy_ticket_field('ticket_field' => { 'id' => identity })
end

#editable_in_portal ⇒ Boolean

# File 'lib/zendesk2/ticket_field.rb', line 21

attribute :editable_in_portal, type: :boolean

#id ⇒ integer

# File 'lib/zendesk2/ticket_field.rb', line 8

identity :id, type: :integer

#position ⇒ Integer

# File 'lib/zendesk2/ticket_field.rb', line 23

attribute :position, type: :integer

#regexp_for_validation ⇒ String

# File 'lib/zendesk2/ticket_field.rb', line 25

attribute :regexp_for_validation, type: :string

#removable ⇒ Boolean

# File 'lib/zendesk2/ticket_field.rb', line 27

attribute :removable, type: :boolean

#required ⇒ Boolean

# File 'lib/zendesk2/ticket_field.rb', line 29

attribute :required, type: :boolean

#required_in_portal ⇒ Boolean

# File 'lib/zendesk2/ticket_field.rb', line 31

attribute :required_in_portal, type: :boolean

#save! ⇒ Object

# File 'lib/zendesk2/ticket_field.rb', line 51

def save!
  data = if new_record?
           requires :type, :title

           cistern.create_ticket_field('ticket_field' => attributes)
         else
           requires :identity

           cistern.update_ticket_field('ticket_field' => attributes)
         end.body['ticket_field']

  merge_attributes(data)
end

#system_field_options ⇒ Array

# File 'lib/zendesk2/ticket_field.rb', line 33

attribute :system_field_options, type: :array

#tag ⇒ String

# File 'lib/zendesk2/ticket_field.rb', line 35

attribute :tag, type: :string

#title ⇒ String

# File 'lib/zendesk2/ticket_field.rb', line 37

attribute :title, type: :string

#title_in_portal ⇒ String

# File 'lib/zendesk2/ticket_field.rb', line 39

attribute :title_in_portal, type: :string

#type ⇒ String

# File 'lib/zendesk2/ticket_field.rb', line 41

attribute :type, type: :string

#updated_at ⇒ Date

# File 'lib/zendesk2/ticket_field.rb', line 43

attribute :updated_at, type: :time

#url ⇒ String

# File 'lib/zendesk2/ticket_field.rb', line 45

attribute :url, type: :string

#visible_in_portal ⇒ Boolean

# File 'lib/zendesk2/ticket_field.rb', line 47

attribute :visible_in_portal, type: :boolean