Class: ZendeskAPI::View

Inherits:

Rule

• Object
• Data
• DataResource
• Resource
• Rule
• ZendeskAPI::View

Includes:

Conditions

Defined in:

lib/zendesk_api/resources.rb

Class Method Summary

• .preview(client, options = {}) ⇒ Object

Instance Method Summary

• #add_all_condition(field, operator, value) ⇒ Object included from Conditions
• #add_any_condition(field, operator, value) ⇒ Object included from Conditions
• #add_column(column) ⇒ Object
• #all_conditions=(all_conditions) ⇒ Object included from Conditions
• #any_conditions=(any_conditions) ⇒ Object included from Conditions
• #columns=(columns) ⇒ Object
• #execution ⇒ ZendeskAPI::RuleExecution

  The associated object.

• #execution=(value) ⇒ ZendeskAPI::RuleExecution

  The associated object.

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

  The associated object.

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

  The associated object.

• #rows(options = {}) ⇒ ZendeskAPI::ViewRow

  The associated object.

• #rows=(value) ⇒ ZendeskAPI::ViewRow

  The associated object.

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

  The associated object.

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

  The associated object.

• #view_count ⇒ ZendeskAPI::ViewCount

  The associated object.

• #view_count=(value) ⇒ ZendeskAPI::ViewCount

  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

.preview(client, options = {}) ⇒ Object

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

def self.preview(client, options = {})
  Collection.new(client, ViewRow, options.merge(:path => "views/preview", :verb => :post))
end

Instance Method Details

#add_all_condition(field, operator, value) ⇒ Object Originally defined in module Conditions

#add_any_condition(field, operator, value) ⇒ Object Originally defined in module Conditions

#add_column(column) ⇒ Object

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

def add_column(column)
  columns = execution.columns.map(&:id)
  columns << column
  self.columns = columns
end

#all_conditions=(all_conditions) ⇒ Object Originally defined in module Conditions

#any_conditions=(any_conditions) ⇒ Object Originally defined in module Conditions

#columns=(columns) ⇒ Object

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

def columns=(columns)
  self.output ||= {}
  self.output[:columns] = columns
end

#execution ⇒ ZendeskAPI::RuleExecution

Returns The associated object

Returns:

• (ZendeskAPI::RuleExecution) —

  The associated object

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

has :execution, :class => RuleExecution

#execution=(value) ⇒ ZendeskAPI::RuleExecution

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::RuleExecution) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::RuleExecution) —

  The associated object

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

has :execution, :class => RuleExecution

#feed(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 572

has_many :feed, :class => Ticket, :path => "feed"

#feed=(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 572

has_many :feed, :class => Ticket, :path => "feed"

#rows(options = {}) ⇒ ZendeskAPI::ViewRow

Returns The associated object

Parameters:

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

  Options to pass to the collection object

Returns:

• (ZendeskAPI::ViewRow) —

  The associated object

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

has_many :rows, :class => ViewRow, :path => "execute"

#rows=(value) ⇒ ZendeskAPI::ViewRow

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::ViewRow) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::ViewRow) —

  The associated object

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

has_many :rows, :class => ViewRow, :path => "execute"

#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 571

has_many :tickets, :class => 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 571

has_many :tickets, :class => Ticket

#view_count ⇒ ZendeskAPI::ViewCount

Returns The associated object

Returns:

• (ZendeskAPI::ViewCount) —

  The associated object

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

has ViewCount, :path => "count"

#view_count=(value) ⇒ ZendeskAPI::ViewCount

Returns The associated object

Parameters:

• value (Hash or ZendeskAPI::ViewCount) —

  The associated object or its attributes

Returns:

• (ZendeskAPI::ViewCount) —

  The associated object

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

has ViewCount, :path => "count"