Class: Readiness::Zendesk::Triggers

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

Overview

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

Author:

  • Jason Colyer

Since:

  • 1.0.0

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 = {}) ⇒ Triggers

Creates a new Readiness::Zendesk::Triggers instance

Examples:

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

Parameters:

Author:

  • Jason Colyer

Since:

  • 1.0.0



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/support_readiness/zendesk/triggers.rb', line 24

def initialize(object = {})
  @actions = object['actions']
  @active = object['active']
  @category_id = object['category_id']
  @conditions = object['conditions']
  @description = object['description']
  @id = object['id']
  @position = object['position']
  @title = object['title']
end

Instance Attribute Details

#actions ⇒ Object

Since:

  • 1.0.0



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

def actions
  @actions
end

#active ⇒ Object

Since:

  • 1.0.0



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

def active
  @active
end

#category_id ⇒ Object

Since:

  • 1.0.0



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

def category_id
  @category_id
end

#conditions ⇒ Object

Since:

  • 1.0.0



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

def conditions
  @conditions
end

#description ⇒ Object

Since:

  • 1.0.0



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

def description
  @description
end

#id ⇒ Object

Since:

  • 1.0.0



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

def id
  @id
end

#position ⇒ Object

Since:

  • 1.0.0



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

def position
  @position
end

#title ⇒ Object

Since:

  • 1.0.0



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

def title
  @title
end

Class Method Details

.create!(client, trigger) ⇒ Object

Creates a trigger. Will exit if unsuccessful

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
trigger = Readiness::Zendesk::Triggers.new
trigger.title = 'Roger Wilco'
trigger.conditions = {
  all: [
    { field: 'status', operator: 'is', value: 'open' },
    { field: 'priority', operator: 'less_than', value: 'high' }
  ],
  any: []
}
trigger.actions = [
  { field: 'group_id', value: '20455932' }
]
trigger.category_id = '10026'
create = Readiness::Zendesk::Triggers.create!(client, trigger)
pp create.id
# => 25

Parameters:

Returns:

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



152
153
154
155
156
 
# File 'lib/support_readiness/zendesk/triggers.rb', line 152

def self.create!(client, trigger)
  response = client.connection.post 'triggers', to_clean_json_with_key(trigger, 'trigger')
  handle_request_error(1, 'Zendesk', response.status, { action: 'Create trigger', message: Oj.load(response.body)}) unless response.status == 201
  Triggers.new(Oj.load(response.body)['trigger'])
end

.delete!(client, trigger) ⇒ Boolean

Deletes a trigger. Will exit if unsuccessful

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
trigger = Readiness::Zendesk::Triggers.find!(client, 198)
delete = Readiness::Zendesk::Triggers.delete!(client, trigger)
pp delete
# => true

Parameters:

Returns:

  • (Boolean)

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



236
237
238
239
240
 
# File 'lib/support_readiness/zendesk/triggers.rb', line 236

def self.delete!(client, trigger)
  response = client.connection.delete "triggers/#{trigger.id}"
  handle_request_error(1, 'Zendesk', response.status, { action: 'Delete a trigger', id: trigger.id, message: Oj.load(response.body)}) unless response.status == 204
  true
end

.delete_many!(client, tids) ⇒ Boolean

Deletes multiple triggers via a batch job

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
deletes = Readiness::Zendesk::Triggers.delete_many!(client, [25, 23, 27, 22])
pp deletes
# => true

Parameters:

  • client (Object) —

    An instance of Client

  • tids (Array) —

    An array of trigger IDs

Returns:

  • (Boolean)

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



261
262
263
264
265
 
# File 'lib/support_readiness/zendesk/triggers.rb', line 261

def self.delete_many!(client, tids)
  response = client.connection.delete("triggers/destroy_many?ids=#{tids.join(',')}")
  handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many triggers', message: Oj.load(response.body)}) unless response.status == 204
  true
end

.find(client, tid) ⇒ Hash

Locates a trigger within Zendesk. This will not exit on error (except Authentication errors)

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
trigger = Readiness::Zendesk::Triggers.find(client, 25)
pp trigger.title
# => "Close and Save"

Parameters:

  • client (Object) —

    An instance of Client

  • tid (Integer) —

    The trigger ID to find

Returns:

  • (Hash)

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



87
88
89
90
91
92
93
 
# File 'lib/support_readiness/zendesk/triggers.rb', line 87

def self.find(client, tid)
  response = client.connection.get("triggers/#{tid}")
  handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: tid }) unless response.status == 200
  return Triggers.new(Oj.load(response.body)['trigger']) if response.status == 200

  Oj.load(response.body)
end

.find!(client, tid) ⇒ Object

Locates a trigger within Zendesk. This will exit on error

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
trigger = Readiness::Zendesk::Triggers.find!(client, 25)
pp trigger.title
# => "Close and Save"

Parameters:

  • client (Object) —

    An instance of Client

  • tid (Integer) —

    The trigger ID to find

Returns:

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



114
115
116
117
118
 
# File 'lib/support_readiness/zendesk/triggers.rb', line 114

def self.find!(client, tid)
  response = client.connection.get("triggers/#{tid}")
  handle_request_error(1, 'Zendesk', response.status, { action: 'Find trigger', id: tid }) unless response.status == 200
  Triggers.new(Oj.load(response.body)['trigger'])
end

.list(client) ⇒ Array

Lists triggers

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
triggers = Readiness::Zendesk::Triggers.list(client)
pp triggers.first.id
# => 25

Parameters:

  • client (Object) —

    An instance of Client

Returns:

  • (Array)

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/support_readiness/zendesk/triggers.rb', line 53

def self.list(client)
  array = []
  opts = "page[size]=100"
  loop do
    response = client.connection.get("triggers?#{opts}")
    handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
    body = Oj.load(response.body)
    array += body['triggers'].map { |t| Triggers.new(t) }
    break unless body['meta']['has_more']

    opts = body['links']['next'].split('?').last
  end
  array
end

.update!(client, trigger) ⇒ Object

Updates a trigger. Will exit if unsuccessful

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
trigger = Readiness::Zendesk::Triggers.find!(client, 25)
trigger.title = 'Assign to priority group'
update = Readiness::Zendesk::Triggers.update!(client, trigger)
pp update.title
# => "Assign to priority group"

Parameters:

Returns:

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



179
180
181
182
183
 
# File 'lib/support_readiness/zendesk/triggers.rb', line 179

def self.update!(client, trigger)
  response = client.connection.put "triggers/#{trigger.id}", to_clean_json_with_key(trigger, 'trigger')
  handle_request_error(1, 'Zendesk', response.status, { action: 'Update trigger', id: trigger.id, message: Oj.load(response.body)}) unless response.status == 200
  Triggers.new(Oj.load(response.body)['trigger'])
end

.update_many!(client, triggers) ⇒ Array

Updates multiple triggers

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
trigger1 = Readiness::Zendesk::Triggers.find!(client, 25)
trigger1.category_id = '10027'
trigger2 = Readiness::Zendesk::Triggers.find!(client, 26)
trigger2.category_id = '10027'
triggers = [trigger1, trigger2]
updates = Readiness::Zendesk::Triggers.update_many!(client, triggers)
pp updates.map { |u| u.category_id }
# => ["10027", "10027"]

Parameters:

Returns:

See Also:

Author:

  • Jason Colyer

Since:

  • 1.0.0



209
210
211
212
213
214
 
# File 'lib/support_readiness/zendesk/triggers.rb', line 209

def self.update_many!(client, triggers)
  data = { triggers: triggers.map { |t| to_hash(t).compact } }.to_json
  response = client.connection.put('triggers/update_many', data)
  handle_request_error(1, 'Zendesk', response.status, { action: 'Update many triggers', message: Oj.load(response.body)}) unless response.status == 200
  Oj.load(response.body)['triggers'].map { |t| Triggers.new(t) }
end