Class: HelpScoutDocs::Category

Inherits:

Method

• Object
• Method
• HelpScoutDocs::Category

Defined in:

lib/help_scout_docs/methods/category.rb

Instance Attribute Summary

Attributes inherited from Method

#client, #method, #options

Instance Method Summary

• #get(id, options = {}) ⇒ Object

  Get a category.

• #list(collection_id, options = {}) ⇒ Object (also: #by_collection)

  List categories.

Methods inherited from Method

#client?, #initialize, #initialize_client

Constructor Details

This class inherits a constructor from HelpScoutDocs::Method

Instance Method Details

#get(id, options = {}) ⇒ Object

Get a category

# File 'lib/help_scout_docs/methods/category.rb', line 12

def get(id, options={})
  get_request("categories/#{id}", options)
end

#list(collection_id, options = {}) ⇒ Object Also known as: by_collection

List categories

# File 'lib/help_scout_docs/methods/category.rb', line 5

def list(collection_id, options={})
  get_request("collections/#{collection_id}/categories", options)
end