Class: Readiness::Zendesk::RequesterRoles

Inherits:
Client
  • Object
show all
Defined in:
lib/support_readiness/zendesk/requester_roles.rb

Overview

Defines the class RequesterRoles within the module Readiness::Zendesk.

Author:

  • Jason Colyer

Since:

  • 1.0.107

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Client

auth_error, bad_request_error, convert_actions, convert_conditions, convert_standard_names_to_ids, convert_ticket_form_agent_conditions, convert_ticket_form_brands, convert_ticket_form_end_user_conditions, convert_ticket_form_names_to_ids, convert_view_names_to_ids, convert_view_restrictions, covert_ticket_form_field_ids, create_package!, erb_renderer, handle_request_error, not_found_error, not_processible_error, put_into_archive, recursively_deflate_directory, timestamp_filename, to_clean_json, to_clean_json_with_key, to_hash, to_nearly_clean_json, to_nearly_clean_json_with_key, to_param_string, write_entries

Constructor Details

#initialize(object = {}) ⇒ RequesterRoles

Creates a new Readiness::Zendesk::RequesterRoles instance

Examples:

require 'support_readiness'
Readiness::Zendesk::RequesterRoles.new

Parameters:

Author:

  • Jason Colyer

Since:

  • 1.0.107



24
25
26
27
 
# File 'lib/support_readiness/zendesk/requester_roles.rb', line 24

def initialize(object = {})
  @id = object['id']
  @name = object['name']
end

Instance Attribute Details

#id ⇒ Object

Since:

  • 1.0.107



13
14
15
 
# File 'lib/support_readiness/zendesk/requester_roles.rb', line 13

def id
  @id
end

#name ⇒ Object

Since:

  • 1.0.107



13
14
15
 
# File 'lib/support_readiness/zendesk/requester_roles.rb', line 13

def name
  @name
end

Class Method Details

.find_by_name(name) ⇒ Object

Locates a via type within Zendesk by name

Examples:

require 'support_readiness'
role = Readiness::Zendesk::RequesterRoles.find_by_name('Agent')
pp role.id
# => 4

Parameters:

  • name (String) —

    The via type name to look for

Returns:

Author:

  • Jason Colyer

Since:

  • 1.0.107



62
63
64
 
# File 'lib/support_readiness/zendesk/requester_roles.rb', line 62

def self.find_by_name(name)
  RequesterRoles.list.detect { |r| r.name == name }
end

.list ⇒ Array

Lists requester roles

Examples:

require 'support_readiness'
types = Readiness::Zendesk::RequesterRoles.list
pp types.first.name
# => "Web form"

Parameters:

  • client (Object) —

    An instance of Client

Returns:

  • (Array)

Author:

  • Jason Colyer

Since:

  • 1.0.107



41
42
43
44
45
46
47
48
 
# File 'lib/support_readiness/zendesk/requester_roles.rb', line 41

def self.list
  [
    { 'id' => 4, 'name' => 'Agent' },
    { 'id' => 'LIGHT_AGENT', 'name' => 'Light Agent' },
    { 'id' => 0, 'name' => 'End User' },
    { 'id' => 2, 'name' => 'Admin' }
  ].map { |r| RequesterRoles.new(r) }
end