Class: ZendeskAPI::Organization

Inherits:

Resource

• Object
• Data
• DataResource
• Resource
• ZendeskAPI::Organization

Defined in:

lib/zendesk_api/resources.rb

Class Method Summary

• .incremental_export(client, start_time) ⇒ Collection

  Gets a incremental export of organizations from the start_time until now.

Instance Method Summary

• #ability ⇒ ZendeskAPI::Ability

  The associated object.

• #ability=(value) ⇒ ZendeskAPI::Ability

  The associated object.

• #group ⇒ ZendeskAPI::Group

  The associated object.

• #group=(value) ⇒ ZendeskAPI::Group

  The associated object.

• #organization_memberships(options = {}) ⇒ ZendeskAPI::OrganizationMembership

  The associated object.

• #organization_memberships=(value) ⇒ ZendeskAPI::OrganizationMembership

  The associated object.

• #tags(options = {}) ⇒ ZendeskAPI::Tag

  The associated object.

• #tags=(value) ⇒ ZendeskAPI::Tag

  The associated object.

• #tickets(options = {}) ⇒ ZendeskAPI::Ticket

  The associated object.

• #tickets=(value) ⇒ ZendeskAPI::Ticket

  The associated object.

• #users(options = {}) ⇒ ZendeskAPI::User

  The associated object.

• #users=(value) ⇒ ZendeskAPI::User

  The associated object.

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

.incremental_export(client, start_time) ⇒ Collection

Gets a incremental export of organizations from the start_time until now.

Parameters:

• client (Client) —

  The Client object to be used

• start_time (Integer) —

  The start_time parameter

Returns:

• (Collection) —

  Collection of ZendeskAPI::Organization

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

def self.incremental_export(client, start_time)
  ZendeskAPI::Collection.new(client, self, :path => "incremental/organizations?start_time=#{start_time.to_i}")
end

Instance Method Details

#ability ⇒ ZendeskAPI::Ability

Returns The associated object

Returns:

• (ZendeskAPI::Ability) —

  The associated object

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

has Ability, :inline => true

#ability=(value) ⇒ ZendeskAPI::Ability

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::Ability) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::Ability) —

  The associated object

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

has Ability, :inline => true

#group ⇒ ZendeskAPI::Group

Returns The associated object

Returns:

• (ZendeskAPI::Group) —

  The associated object

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

has Group

#group=(value) ⇒ ZendeskAPI::Group

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::Group) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::Group) —

  The associated object

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

has Group

#organization_memberships(options = {}) ⇒ ZendeskAPI::OrganizationMembership

Returns The associated object

Parameters:

• options (Hash) (defaults to: {}) —

  Options to pass to the collection object

Returns:

• (ZendeskAPI::OrganizationMembership) —

  The associated object

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

has_many OrganizationMembership

#organization_memberships=(value) ⇒ ZendeskAPI::OrganizationMembership

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::OrganizationMembership) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::OrganizationMembership) —

  The associated object

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

has_many OrganizationMembership

#tags(options = {}) ⇒ ZendeskAPI::Tag

Returns The associated object

Parameters:

• options (Hash) (defaults to: {}) —

  Options to pass to the collection object

Returns:

• (ZendeskAPI::Tag) —

  The associated object

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

has_many Tag, :extend => Tag::Update, :inline => :create

#tags=(value) ⇒ ZendeskAPI::Tag

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::Tag) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::Tag) —

  The associated object

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

has_many Tag, :extend => Tag::Update, :inline => :create

#tickets(options = {}) ⇒ ZendeskAPI::Ticket

Returns The associated object

Parameters:

• options (Hash) (defaults to: {}) —

  Options to pass to the collection object

Returns:

• (ZendeskAPI::Ticket) —

  The associated object

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

has_many Ticket

#tickets=(value) ⇒ ZendeskAPI::Ticket

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::Ticket) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::Ticket) —

  The associated object

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

has_many Ticket

#users(options = {}) ⇒ ZendeskAPI::User

Returns The associated object

Parameters:

• options (Hash) (defaults to: {}) —

  Options to pass to the collection object

Returns:

• (ZendeskAPI::User) —

  The associated object

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

has_many User

#users=(value) ⇒ ZendeskAPI::User

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::User) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::User) —

  The associated object

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

has_many User