Module: Five9Tools::Add

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

Class Method Summary collapse

Class Method Details

.add_dispositions_to_campaign(params = {}) ⇒ Object

Api request for addDispositionsToCampaign.

Examples:

Accepts the following parameters as a hash:

{"addDispositionsToCampaign"=>{"campaignName"=>"?", "dispositions"=>"?", "isSkipPreviewDisposition"=>"?"}}


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

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

.add_dnis_to_campaign(params = {}) ⇒ Object

Api request for addDNISToCampaign.

Examples:

Accepts the following parameters as a hash:

{"addDNISToCampaign"=>{"campaignName"=>"?", "DNISList"=>"?"}}


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

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

.add_lists_to_campaign(params = {}) ⇒ Object

Api request for addListsToCampaign.

Examples:

Accepts the following parameters as a hash:

{"addListsToCampaign"=>{"campaignName"=>"?", "lists"=>{"campaignName"=>"?", "dialingPriority"=>"?", "dialingRatio"=>"?", "listName"=>"?", "priority"=>"?"}}}


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

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

.add_numbers_to_dnc(params = {}) ⇒ Object

Api request for addNumbersToDnc.

Examples:

Accepts the following parameters as a hash:

{"addNumbersToDnc"=>{"numbers"=>"?"}}


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

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

.add_prompt_tts(params = {}) ⇒ Object

Api request for addPromptTTS.

Examples:

Accepts the following parameters as a hash:

{"addPromptTTS"=>{"prompt"=>{"description"=>"?", "languages"=>"?", "name"=>"?", "type"=>"?"}, "ttsInfo"=>{"language"=>"?", "sayAs"=>"?", "sayAsFormat"=>"?", "text"=>"?", "voice"=>"?"}}}


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

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

.add_prompt_wav(params = {}) ⇒ Object

Api request for addPromptWav.

Examples:

Accepts the following parameters as a hash:

{"addPromptWav"=>{"prompt"=>{"description"=>"?", "languages"=>"?", "name"=>"?", "type"=>"?"}, "wavFile"=>"cid:1502868595416"}}


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

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

.add_prompt_wav_inline(params = {}) ⇒ Object

Api request for addPromptWavInline.

Examples:

Accepts the following parameters as a hash:

{"addPromptWavInline"=>{"prompt"=>{"description"=>"?", "languages"=>"?", "name"=>"?", "type"=>"?"}, "wavFile"=>"cid:1027282953513"}}


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

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

.add_record_to_list(params = {}) ⇒ Object

Api request for addRecordToList.

Examples:

Accepts the following parameters as a hash:

{"addRecordToList"=>{"listName"=>"?", "listUpdateSettings"=>{"allowDataCleanup"=>"?", "callbackFormat"=>"?", "callbackUrl"=>"?", "countryCode"=>"?", "failOnFieldParseError"=>"?", "fieldsMapping"=>{"columnNumber"=>"?", "fieldName"=>"?", "key"=>"?"}, "reportEmail"=>"?", "separator"=>"?", "skipHeaderLine"=>"?", "callNowColumnNumber"=>"?", "callNowMode"=>"?", "callTime"=>"?", "callTimeColumnNumber"=>"?", "cleanListBeforeUpdate"=>"?", "crmAddMode"=>"?", "crmUpdateMode"=>"?", "listAddMode"=>"?"}, "record"=>{"fields"=>"?"}}}


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

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

.add_record_to_list_simple(params = {}) ⇒ Object

Api request for addRecordToListSimple.

Examples:

Accepts the following parameters as a hash:

{"addRecordToListSimple"=>{"listName"=>"?", "listUpdateSimpleSettings"=>{"callAsap"=>"?", "countryCode"=>"?", "fieldsMapping"=>{"columnNumber"=>"?", "fieldName"=>"?", "key"=>"?"}, "timeToCall"=>"?", "updateCRM"=>"?"}, "record"=>{"fields"=>"?"}}}


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

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

.add_skill_audio_file(params = {}) ⇒ Object

Api request for addSkillAudioFile.

Examples:

Accepts the following parameters as a hash:

{"addSkillAudioFile"=>{"skillName"=>"?", "promptName"=>"?"}}


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

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

.add_skills_to_campaign(params = {}) ⇒ Object

Api request for addSkillsToCampaign.

Examples:

Accepts the following parameters as a hash:

{"addSkillsToCampaign"=>{"campaignName"=>"?", "skills"=>"?"}}


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

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

.add_to_list(params = {}) ⇒ Object

Api request for addToList.

Examples:

Accepts the following parameters as a hash:

{"addToList"=>{"listName"=>"?", "listUpdateSettings"=>{"allowDataCleanup"=>"?", "callbackFormat"=>"?", "callbackUrl"=>"?", "countryCode"=>"?", "failOnFieldParseError"=>"?", "fieldsMapping"=>{"columnNumber"=>"?", "fieldName"=>"?", "key"=>"?"}, "reportEmail"=>"?", "separator"=>"?", "skipHeaderLine"=>"?", "callNowColumnNumber"=>"?", "callNowMode"=>"?", "callTime"=>"?", "callTimeColumnNumber"=>"?", "cleanListBeforeUpdate"=>"?", "crmAddMode"=>"?", "crmUpdateMode"=>"?", "listAddMode"=>"?"}, "importData"=>{"values"=>{"item"=>"?"}}}}


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

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

.add_to_list_csv(params = {}) ⇒ Object

Api request for addToListCsv.

Examples:

Accepts the following parameters as a hash:

{"addToListCsv"=>{"listName"=>"?", "listUpdateSettings"=>{"allowDataCleanup"=>"?", "callbackFormat"=>"?", "callbackUrl"=>"?", "countryCode"=>"?", "failOnFieldParseError"=>"?", "fieldsMapping"=>{"columnNumber"=>"?", "fieldName"=>"?", "key"=>"?"}, "reportEmail"=>"?", "separator"=>"?", "skipHeaderLine"=>"?", "callNowColumnNumber"=>"?", "callNowMode"=>"?", "callTime"=>"?", "callTimeColumnNumber"=>"?", "cleanListBeforeUpdate"=>"?", "crmAddMode"=>"?", "crmUpdateMode"=>"?", "listAddMode"=>"?"}, "csvData"=>"?"}}


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

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

.add_to_list_ftp(params = {}) ⇒ Object

Api request for addToListFtp.

Examples:

Accepts the following parameters as a hash:

{"addToListFtp"=>{"listName"=>"?", "updateSettings"=>{"allowDataCleanup"=>"?", "callbackFormat"=>"?", "callbackUrl"=>"?", "countryCode"=>"?", "failOnFieldParseError"=>"?", "fieldsMapping"=>{"columnNumber"=>"?", "fieldName"=>"?", "key"=>"?"}, "reportEmail"=>"?", "separator"=>"?", "skipHeaderLine"=>"?", "callNowColumnNumber"=>"?", "callNowMode"=>"?", "callTime"=>"?", "callTimeColumnNumber"=>"?", "cleanListBeforeUpdate"=>"?", "crmAddMode"=>"?", "crmUpdateMode"=>"?", "listAddMode"=>"?"}, "ftpSettings"=>{"hostname"=>"?", "password"=>"?", "path"=>"?", "username"=>"?"}}}


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

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

.async_add_records_to_list(params = {}) ⇒ Object

Api request for asyncAddRecordsToList.

Examples:

Accepts the following parameters as a hash:

{"asyncAddRecordsToList"=>{"listName"=>"?", "listUpdateSettings"=>{"allowDataCleanup"=>"?", "callbackFormat"=>"?", "callbackUrl"=>"?", "countryCode"=>"?", "failOnFieldParseError"=>"?", "fieldsMapping"=>{"columnNumber"=>"?", "fieldName"=>"?", "key"=>"?"}, "reportEmail"=>"?", "separator"=>"?", "skipHeaderLine"=>"?", "callNowColumnNumber"=>"?", "callNowMode"=>"?", "callTime"=>"?", "callTimeColumnNumber"=>"?", "cleanListBeforeUpdate"=>"?", "crmAddMode"=>"?", "crmUpdateMode"=>"?", "listAddMode"=>"?"}, "importData"=>{"values"=>{"item"=>"?"}}, "resetDispositionsInCampaignsImportData"=>"?"}}


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

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

.user_skill_add(params = {}) ⇒ Object

Api request for userSkillAdd.

Examples:

Accepts the following parameters as a hash:

{"userSkillAdd"=>{"userSkill"=>{"id"=>"?", "level"=>"?", "skillName"=>"?", "userName"=>"?"}}}


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

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