Module: Five9Tools::Misc

Included in:
Admin::Client
Defined in:
lib/five9tools/admin/misc.rb

Class Method Summary collapse

Class Method Details

.check_dnc_for_numbers(params = {}) ⇒ Object

Api request for checkDncForNumbers.

Examples:

Accepts the following parameters as a hash:

{"checkDncForNumbers"=>{"numbers"=>"?"}}


300
301
302
303
304
305
306
307
308
309
310
311
# File 'lib/five9tools/admin/misc.rb', line 300

def check_dnc_for_numbers(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:check_dnc_for_numbers, message: params)
      res[:check_dnc_for_numbers_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.close_session(params = {}) ⇒ Object

Api request for closeSession.

Examples:

Accepts the following parameters as a hash:

{"closeSession"=>nil}


96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/five9tools/admin/misc.rb', line 96

def close_session(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:close_session, message: params)
      res[:close_session_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.force_stop_campaign(params = {}) ⇒ Object

Api request for forceStopCampaign.

Examples:

Accepts the following parameters as a hash:

{"forceStopCampaign"=>{"campaignName"=>"?"}}


79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/five9tools/admin/misc.rb', line 79

def force_stop_campaign(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:force_stop_campaign, message: params)
      res[:force_stop_campaign_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.is_import_running(params = {}) ⇒ Object

Api request for isImportRunning.

Examples:

Accepts the following parameters as a hash:

{"isImportRunning"=>{"identifier"=>{"identifier"=>"?"}, "waitTime"=>"?"}}


11
12
13
14
15
16
17
18
19
20
21
22
# File 'lib/five9tools/admin/misc.rb', line 11

def is_import_running(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:is_import_running, message: params)
      res[:is_import_running_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.is_report_running(params = {}) ⇒ Object

Api request for isReportRunning.

Examples:

Accepts the following parameters as a hash:

{"isReportRunning"=>{"identifier"=>"?", "timeout"=>"?"}}


198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/five9tools/admin/misc.rb', line 198

def is_report_running(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:is_report_running, message: params)
      res[:is_report_running_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.rename_campaign(params = {}) ⇒ Object

Api request for renameCampaign.

Examples:

Accepts the following parameters as a hash:

{"renameCampaign"=>{"campaignName"=>"?", "campaignNewName"=>"?"}}


215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/five9tools/admin/misc.rb', line 215

def rename_campaign(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:rename_campaign, message: params)
      res[:rename_campaign_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.rename_disposition(params = {}) ⇒ Object

Api request for renameDisposition.

Examples:

Accepts the following parameters as a hash:

{"renameDisposition"=>{"dispositionName"=>"?", "dispositionNewName"=>"?"}}


181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/five9tools/admin/misc.rb', line 181

def rename_disposition(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:rename_disposition, message: params)
      res[:rename_disposition_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.reset_campaign(params = {}) ⇒ Object

Api request for resetCampaign.

Examples:

Accepts the following parameters as a hash:

{"resetCampaign"=>{"campaignName"=>"?"}}


62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/five9tools/admin/misc.rb', line 62

def reset_campaign(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:reset_campaign, message: params)
      res[:reset_campaign_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.reset_campaign_dispositions(params = {}) ⇒ Object

Api request for resetCampaignDispositions.

Examples:

Accepts the following parameters as a hash:

{"resetCampaignDispositions"=>{"campaignName"=>"?", "dispositions"=>"?", "after"=>"?", "before"=>"?"}}


232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/five9tools/admin/misc.rb', line 232

def reset_campaign_dispositions(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:reset_campaign_dispositions, message: params)
      res[:reset_campaign_dispositions_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.reset_list_position(params = {}) ⇒ Object

Api request for resetListPosition.

Examples:

Accepts the following parameters as a hash:

{"resetListPosition"=>{"campaignName"=>"?"}}


334
335
336
337
338
339
340
341
342
343
344
345
# File 'lib/five9tools/admin/misc.rb', line 334

def reset_list_position(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:reset_list_position, message: params)
      res[:reset_list_position_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.run_report(params = {}) ⇒ Object

Api request for runReport.

Examples:

Accepts the following parameters as a hash:

{"runReport"=>{"folderName"=>"?", "reportName"=>"?", "criteria"=>{"reportObjects"=>{"objectNames"=>"?", "objectType"=>"?"}, "time"=>{"end"=>"?", "start"=>"?"}}}}


351
352
353
354
355
356
357
358
359
360
361
362
# File 'lib/five9tools/admin/misc.rb', line 351

def run_report(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:run_report, message: params)
      res[:run_report_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.set_campaign_strategies(params = {}) ⇒ Object

Api request for setCampaignStrategies.

Examples:

Accepts the following parameters as a hash:

{"setCampaignStrategies"=>{"campaignName"=>"?", "campaignStrategies"=>{"strategies"=>{"description"=>"?", "enabled"=>"?", "filter"=>{"conditionGroupingType"=>"?", "conditions"=>{"compareOperator"=>"?", "leftValue"=>"?", "rightValue"=>"?"}, "customGrouping"=>"?"}, "name"=>"?", "schedule"=>{"redialAfterMins"=>"?", "startFromDay"=>"?"}, "startAfterTimeMins"=>"?"}}}}


147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/five9tools/admin/misc.rb', line 147

def set_campaign_strategies(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:set_campaign_strategies, message: params)
      res[:set_campaign_strategies_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.set_default_ivr_schedule(params = {}) ⇒ Object

Api request for setDefaultIVRSchedule.

Examples:

Accepts the following parameters as a hash:

{"setDefaultIVRSchedule"=>{"campaignName"=>"?", "scriptName"=>"?", "params"=>{"name"=>"?", "value"=>"?"}, "isVisualModeEnabled"=>"?", "isChatEnabled"=>"?"}}


45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/five9tools/admin/misc.rb', line 45

def set_default_ivr_schedule(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:set_default_ivr_schedule, message: params)
      res[:set_default_ivr_schedule_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.set_dialing_rules(params = {}) ⇒ Object

Api request for setDialingRules.

Examples:

Accepts the following parameters as a hash:

{"setDialingRules"=>{"setRules"=>{"applyToManualCalls"=>"?", "contactText"=>"?", "dateRange"=>{"daysOfWeek"=>"?", "endDate"=>"?", "startDate"=>"?"}, "fixedTimeZone"=>"?", "name"=>"?", "state"=>"?", "timeRange"=>{"startHour"=>"?", "startMinute"=>"?", "stopHour"=>"?", "stopMinute"=>"?"}}, "removeRules"=>"?"}}


283
284
285
286
287
288
289
290
291
292
293
294
# File 'lib/five9tools/admin/misc.rb', line 283

def set_dialing_rules(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:set_dialing_rules, message: params)
      res[:set_dialing_rules_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.set_ivr_icons(params = {}) ⇒ Object

Api request for setIvrIcons.

Examples:

Accepts the following parameters as a hash:

{"setIvrIcons"=>{"ivrScriptName"=>"?", "ivrIcons"=>{"largeIcon"=>"cid:1213443401460", "mediumIcon"=>"cid:1406259721318", "smallIcon"=>"cid:1254852683434"}}}


130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/five9tools/admin/misc.rb', line 130

def set_ivr_icons(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:set_ivr_icons, message: params)
      res[:set_ivr_icons_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.set_ivr_script_ownership(params = {}) ⇒ Object

Api request for setIvrScriptOwnership.

Examples:

Accepts the following parameters as a hash:

{"setIvrScriptOwnership"=>{"ivrScriptName"=>"?", "othersCanCopy"=>"?"}}


266
267
268
269
270
271
272
273
274
275
276
277
# File 'lib/five9tools/admin/misc.rb', line 266

def set_ivr_script_ownership(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:set_ivr_script_ownership, message: params)
      res[:set_ivr_script_ownership_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.set_locale(params = {}) ⇒ Object

Api request for setLocale.

Examples:

Accepts the following parameters as a hash:

{"setLocale"=>{"localeName"=>"?"}}


113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/five9tools/admin/misc.rb', line 113

def set_locale(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:set_locale, message: params)
      res[:set_locale_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.set_skill_voicemail_greeting(params = {}) ⇒ Object

Api request for setSkillVoicemailGreeting.

Examples:

Accepts the following parameters as a hash:

{"setSkillVoicemailGreeting"=>{"skillName"=>"?", "wavFile"=>"cid:477747584523"}}


249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/five9tools/admin/misc.rb', line 249

def set_skill_voicemail_greeting(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:set_skill_voicemail_greeting, message: params)
      res[:set_skill_voicemail_greeting_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.set_user_voicemail_greeting(params = {}) ⇒ Object

Api request for setUserVoicemailGreeting.

Examples:

Accepts the following parameters as a hash:

{"setUserVoicemailGreeting"=>{"userName"=>"?", "wavFile"=>"cid:897249546949"}}


317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/five9tools/admin/misc.rb', line 317

def set_user_voicemail_greeting(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:set_user_voicemail_greeting, message: params)
      res[:set_user_voicemail_greeting_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.start_campaign(params = {}) ⇒ Object

Api request for startCampaign.

Examples:

Accepts the following parameters as a hash:

{"startCampaign"=>{"campaignName"=>"?"}}


164
165
166
167
168
169
170
171
172
173
174
175
# File 'lib/five9tools/admin/misc.rb', line 164

def start_campaign(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:start_campaign, message: params)
      res[:start_campaign_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end

.stop_campaign(params = {}) ⇒ Object

Api request for stopCampaign.

Examples:

Accepts the following parameters as a hash:

{"stopCampaign"=>{"campaignName"=>"?"}}


28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/five9tools/admin/misc.rb', line 28

def stop_campaign(params = {})
  if params.is_a?(Hash)
    begin
      res = self.call(:stop_campaign, message: params)
      res[:stop_campaign_response].values[0]
    rescue => e
      e.to_s
    end
  else
    "Implement something for simple use case"
  end
end