Class: Zendesk2::Category

Inherits:

Object

• Object
• Zendesk2::Category

Includes:

Model

Defined in:

lib/zendesk2/category.rb

Instance Attribute Summary

Attributes included from Model

#errors

Instance Method Summary

• #created_at ⇒ Time

  The time the category was created.

• #description ⇒ String

  The description of the category.

• #destroy! ⇒ Object
• #id ⇒ Integer

  Automatically assigned during creation.

• #name ⇒ String

  The name of the category.

• #position ⇒ Integer

  The position of this category relative to other categories.

• #save! ⇒ Object
• #updated_at ⇒ Time

  The time of the last update of the category.

• #url ⇒ String

  The API url of this category.

Methods included from Model

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

Instance Method Details

#created_at ⇒ Time

# File 'lib/zendesk2/category.rb', line 9

attribute :created_at, type: :time

#description ⇒ String

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

attribute :description, type: :string

#destroy! ⇒ Object

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

def destroy!
  requires :identity

  cistern.destroy_category('category' => { 'id' => identity })
end

#id ⇒ Integer

# File 'lib/zendesk2/category.rb', line 6

identity :id, type: :integer

#name ⇒ String

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

attribute :name, type: :string

#position ⇒ Integer

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

attribute :position, type: :integer

#save! ⇒ Object

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

def save!
  data = if new_record?
           requires :name

           cistern.create_category(params).body['category']
         else
           requires :identity

           cistern.update_category(params).body['category']
         end

  merge_attributes(data)
end

#updated_at ⇒ Time

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

attribute :updated_at, type: :time

#url ⇒ String

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

attribute :url, type: :string