Class: ZendeskAPI::Topic

Inherits:

Resource

• Object
• Data
• DataResource
• Resource
• ZendeskAPI::Topic

Defined in:

lib/zendesk_api/resources.rb,
lib/zendesk_api/resources.rb

Defined Under Namespace

Classes: TopicComment, TopicVote

Instance Attribute Summary

Attributes inherited from DataResource

#error, #error_message

Attributes inherited from Data

#association, #attributes, #errors, #response

Class Method Summary

• .import(client, attributes) ⇒ Object
• .import!(client, attributes) ⇒ Object

Instance Method Summary

• #votes(opts = {}) ⇒ Object

Methods included from Destroy

#destroy, #destroy!, #destroyed?, included

Methods included from Update

included

Methods included from Save

#clear_associations, #save, #save!, #save_associations

Methods included from ResponseHandler

#handle_response

Methods included from Create

included

Methods included from Read

included, #reload!

Methods included from Sideloading

included, #set_includes

Methods included from Verbs

#any, #delete, #post, #put

Methods inherited from Data

#==, #id, inherited, #initialize, #loaded_associations, #method_missing, namespace, new_from_response, #new_record?, #path, resource_name, resource_path, singular_resource_name, subclasses, #to_json, #to_s

Methods included from Associations

included, #wrap_resource

Constructor Details

This class inherits a constructor from ZendeskAPI::Data

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ZendeskAPI::Data

Class Method Details

.import(client, attributes) ⇒ Object

# File 'lib/zendesk_api/resources.rb', line 248

def self.import(client, attributes)
  topic = new(client, attributes)
  return unless topic.save(:path => "import/topics")
  topic
end

.import!(client, attributes) ⇒ Object

# File 'lib/zendesk_api/resources.rb', line 242

def self.import!(client, attributes)
  new(client, attributes).tap do |topic|
    topic.save!(:path => "import/topics")
  end
end

Instance Method Details

#votes(opts = {}) ⇒ Object

# File 'lib/zendesk_api/resources.rb', line 235

def votes(opts = {})
  return @votes if @votes && !opts[:reload]

  association = ZendeskAPI::Association.new(:class => TopicVote, :parent => self, :path => 'votes')
  @votes = ZendeskAPI::Collection.new(@client, TopicVote, opts.merge(:association => association))
end