Module: Five9Tools::Create

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

Class Method Summary collapse

Class Method Details

.create_agent_group(params = {}) ⇒ Object

Api request for createAgentGroup.

Examples:

Accepts the following parameters as a hash:

{"createAgentGroup"=>{"group"=>{"agents"=>"?", "description"=>"?", "id"=>"?", "name"=>"?"}}}


49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/five9tools/admin/create.rb', line 49

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

.create_autodial_campaign(params = {}) ⇒ Object

Api request for createAutodialCampaign.

Examples:

Accepts the following parameters as a hash:

{"createAutodialCampaign"=>{"campaign"=>{"description"=>"?", "mode"=>"?", "name"=>"?", "profileName"=>"?", "state"=>"?", "trainingMode"=>"?", "type"=>"?", "autoRecord"=>"?", "callWrapup"=>{"agentNotReady"=>"?", "dispostionName"=>"?", "enabled"=>"?", "reasonCodeName"=>"?", "timeout"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}}, "ftpHost"=>"?", "ftpPassword"=>"?", "ftpUser"=>"?", "recordingNameAsSid"=>"?", "useFtp"=>"?", "analyzeLevel"=>"?", "CRMRedialTimeout"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}, "dnisAsAni"=>"?", "enableListDialingRatios"=>"?", "listDialingMode"=>"?", "noOutOfNumbersAlert"=>"?", "stateDialingRule"=>"?", "timeZoneAssignment"=>"?", "agentAvailability"=>"?", "agentSkillName"=>"?", "defaultIvrSchedule"=>{"name"=>"?", "scriptName"=>"?", "scriptParameters"=>{"name"=>"?", "value"=>"?"}}, "dialIfAgentsAvailable"=>"?", "maxNumOfLines"=>"?"}}}


66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/five9tools/admin/create.rb', line 66

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

.create_call_variable(params = {}) ⇒ Object

Api request for createCallVariable.

Examples:

Accepts the following parameters as a hash:

{"createCallVariable"=>{"variable"=>{"applyToAllDispositions"=>"?", "defaultValue"=>"?", "description"=>"?", "dispositions"=>"?", "group"=>"?", "name"=>"?", "reporting"=>"?", "restrictions"=>{"type"=>"?", "value"=>"?"}, "sensitiveData"=>"?", "type"=>"?"}}}


32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/five9tools/admin/create.rb', line 32

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

.create_call_variables_group(params = {}) ⇒ Object

Api request for createCallVariablesGroup.

Examples:

Accepts the following parameters as a hash:

{"createCallVariablesGroup"=>{"name"=>"?", "description"=>"?"}}


83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/five9tools/admin/create.rb', line 83

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

.create_campaign_profile(params = {}) ⇒ Object

Api request for createCampaignProfile.

Examples:

Accepts the following parameters as a hash:

{"createCampaignProfile"=>{"campaignProfile"=>{"ANI"=>"?", "description"=>"?", "dialingSchedule"=>{"dialASAPSortOrder"=>"?", "dialASAPTimeout"=>"?", "dialASAPTimeoutPeriod"=>"?", "dialingOrder"=>"?", "dialingSchedules"=>{"number"=>"?", "startTime"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}, "stopTime"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}}, "includeNumbers"=>"?"}, "dialingTimeout"=>"?", "initialCallPriority"=>"?", "maxCharges"=>"?", "name"=>"?", "numberOfAttempts"=>"?"}}}


202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/five9tools/admin/create.rb', line 202

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

.create_contact_field(params = {}) ⇒ Object

Api request for createContactField.

Examples:

Accepts the following parameters as a hash:

{"createContactField"=>{"field"=>{"displayAs"=>"?", "mapTo"=>"?", "name"=>"?", "restrictions"=>{"type"=>"?", "value"=>"?"}, "system"=>"?", "type"=>"?"}}}


236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/five9tools/admin/create.rb', line 236

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

.create_disposition(params = {}) ⇒ Object

Api request for createDisposition.

Examples:

Accepts the following parameters as a hash:

{"createDisposition"=>{"disposition"=>{"agentMustCompleteWorksheet"=>"?", "agentMustConfirm"=>"?", "description"=>"?", "name"=>"?", "resetAttemptsCounter"=>"?", "sendEmailNotification"=>"?", "sendIMNotification"=>"?", "trackAsFirstCallResolution"=>"?", "type"=>"?", "typeParameters"=>{"allowChangeTimer"=>"?", "attempts"=>"?", "timer"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}, "useTimer"=>"?"}}}}


151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/five9tools/admin/create.rb', line 151

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

.create_inbound_campaign(params = {}) ⇒ Object

Api request for createInboundCampaign.

Examples:

Accepts the following parameters as a hash:

{"createInboundCampaign"=>{"campaign"=>{"description"=>"?", "mode"=>"?", "name"=>"?", "profileName"=>"?", "state"=>"?", "trainingMode"=>"?", "type"=>"?", "autoRecord"=>"?", "callWrapup"=>{"agentNotReady"=>"?", "dispostionName"=>"?", "enabled"=>"?", "reasonCodeName"=>"?", "timeout"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}}, "ftpHost"=>"?", "ftpPassword"=>"?", "ftpUser"=>"?", "recordingNameAsSid"=>"?", "useFtp"=>"?", "defaultIvrSchedule"=>{"ivrSchedule"=>{"name"=>"?", "scriptName"=>"?", "scriptParameters"=>{"name"=>"?", "value"=>"?"}}, "visualModeSettings"=>{"callbackEnabled"=>"?", "chatEnabled"=>"?", "cssTheme"=>"?", "emailEnabled"=>"?", "sentimentFeedbackEnabled"=>"?", "videoEnabled"=>"?", "visualModeEnabled"=>"?", "xFrameOption"=>"?", "xFrameOptionUrl"=>"?", "xFrameOptionsEnabled"=>"?"}}, "maxNumOfLines"=>"?"}}}


219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/five9tools/admin/create.rb', line 219

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

.create_ivr_script(params = {}) ⇒ Object

Api request for createIVRScript.

Examples:

Accepts the following parameters as a hash:

{"createIVRScript"=>{"name"=>"?"}}


15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/five9tools/admin/create.rb', line 15

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

.create_list(params = {}) ⇒ Object

Api request for createList.

Examples:

Accepts the following parameters as a hash:

{"createList"=>{"listName"=>"?"}}


168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/five9tools/admin/create.rb', line 168

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

.create_outbound_campaign(params = {}) ⇒ Object

Api request for createOutboundCampaign.

Examples:

Accepts the following parameters as a hash:

{"createOutboundCampaign"=>{"campaign"=>{"description"=>"?", "mode"=>"?", "name"=>"?", "profileName"=>"?", "state"=>"?", "trainingMode"=>"?", "type"=>"?", "autoRecord"=>"?", "callWrapup"=>{"agentNotReady"=>"?", "dispostionName"=>"?", "enabled"=>"?", "reasonCodeName"=>"?", "timeout"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}}, "ftpHost"=>"?", "ftpPassword"=>"?", "ftpUser"=>"?", "recordingNameAsSid"=>"?", "useFtp"=>"?", "analyzeLevel"=>"?", "CRMRedialTimeout"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}, "dnisAsAni"=>"?", "enableListDialingRatios"=>"?", "listDialingMode"=>"?", "noOutOfNumbersAlert"=>"?", "stateDialingRule"=>"?", "timeZoneAssignment"=>"?", "actionOnAnswerMachine"=>{"actionArgument"=>"?", "actionType"=>"?", "maxWaitTime"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}}, "actionOnQueueExpiration"=>{"actionArgument"=>"?", "actionType"=>"?", "maxWaitTime"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}}, "callAnalysisMode"=>"?", "callsAgentRatio"=>"?", "dialNumberOnTimeout"=>"?", "dialingMode"=>"?", "dialingPriority"=>"?", "dialingRatio"=>"?", "distributionAlgorithm"=>"?", "distributionTimeFrame"=>"?", "limitPreviewTime"=>"?", "maxDroppedCallsPercentage"=>"?", "maxPreviewTime"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}, "maxQueueTime"=>{"days"=>"?", "hours"=>"?", "minutes"=>"?", "seconds"=>"?"}, "monitorDroppedCalls"=>"?", "previewDialImmediately"=>"?", "useTelemarketingMaxQueTimeEq1"=>"?"}}}


253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/five9tools/admin/create.rb', line 253

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

.create_reason_code(params = {}) ⇒ Object

Api request for createReasonCode.

Examples:

Accepts the following parameters as a hash:

{"createReasonCode"=>{"reasonCode"=>{"enabled"=>"?", "name"=>"?", "paidTime"=>"?", "shortcut"=>"?", "type"=>"?"}}}


100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/five9tools/admin/create.rb', line 100

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

.create_skill(params = {}) ⇒ Object

Api request for createSkill.

Examples:

Accepts the following parameters as a hash:

{"createSkill"=>{"skillInfo"=>{"skill"=>{"description"=>"?", "id"=>"?", "messageOfTheDay"=>"?", "name"=>"?", "routeVoiceMails"=>"?"}, "users"=>"\n                    \n                    \n                    \n                    \n                    \n                    \n                    \n           e "}}}


117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/five9tools/admin/create.rb', line 117

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

.create_speed_dial_number(params = {}) ⇒ Object

Api request for createSpeedDialNumber.

Examples:

Accepts the following parameters as a hash:

{"createSpeedDialNumber"=>{"code"=>"?", "number"=>"?", "description"=>"?"}}


287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/five9tools/admin/create.rb', line 287

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

.create_user(params = {}) ⇒ Object

Api request for createUser.

Examples:

Accepts the following parameters as a hash:

{"createUser"=>{"userInfo"=>{"agentGroups"=>"?", "cannedReports"=>{"index"=>"?", "name"=>"?"}, "generalInfo"=>{"active"=>"?", "canChangePassword"=>"?", "EMail"=>"?", "extension"=>"?", "federationId"=>"?", "firstName"=>"?", "fullName"=>"?", "IEXScheduled"=>"?", "id"=>"?", "lastName"=>"?", "locale"=>"?", "mediaTypeConfig"=>{"mediaTypes"=>{"enabled"=>"?", "intlligentRouting"=>"?", "maxAlowed"=>"?", "type"=>"?"}}, "mustChangePassword"=>"?", "osLogin"=>"?", "password"=>"?", "phoneNumber"=>"?", "startDate"=>"?", "unifiedCommunicationId"=>"?", "userName"=>"?", "userProfileName"=>"?"}, "roles"=>{"admin"=>{"permissions"=>{"type"=>"?", "value"=>"?"}}, "agent"=>{"alwaysRecorded"=>"?", "attachVmToEmail"=>"?", "permissions"=>{"type"=>"?", "value"=>"?"}, "sendEmailOnVm"=>"?"}, "crmManager"=>{"permissions"=>{"type"=>"?", "value"=>"?"}}, "reporting"=>{"permissions"=>{"type"=>"?", "value"=>"?"}}, "supervisor"=>{"permissions"=>{"type"=>"?", "value"=>"?"}}}, "skills"=>{"id"=>"?", "level"=>"?", "skillName"=>"?", "userName"=>"?"}}}}


185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/five9tools/admin/create.rb', line 185

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

.create_user_profile(params = {}) ⇒ Object

Api request for createUserProfile.

Examples:

Accepts the following parameters as a hash:

{"createUserProfile"=>{"userProfile"=>{"description"=>"?", "IEXScheduled"=>"?", "locale"=>"?", "mediaTypeConfig"=>{"mediaTypes"=>{"enabled"=>"?", "intlligentRouting"=>"?", "maxAlowed"=>"?", "type"=>"?"}}, "name"=>"?", "roles"=>{"admin"=>{"permissions"=>{"type"=>"?", "value"=>"?"}}, "agent"=>{"alwaysRecorded"=>"?", "attachVmToEmail"=>"?", "permissions"=>{"type"=>"?", "value"=>"?"}, "sendEmailOnVm"=>"?"}, "crmManager"=>{"permissions"=>{"type"=>"?", "value"=>"?"}}, "reporting"=>{"permissions"=>{"type"=>"?", "value"=>"?"}}, "supervisor"=>{"permissions"=>{"type"=>"?", "value"=>"?"}}}, "skills"=>"?", "users"=>"?"}}}


134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/five9tools/admin/create.rb', line 134

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

.create_web_connector(params = {}) ⇒ Object

Api request for createWebConnector.

Examples:

Accepts the following parameters as a hash:

{"createWebConnector"=>{"connector"=>{"addWorksheet"=>"?", "agentApplication"=>"?", "clearTriggerDispositions"=>"?", "constants"=>{"key"=>"?", "value"=>"?"}, "ctiWebServices"=>"?", "description"=>"?", "executeInBrowser"=>"?", "name"=>"?", "postConstants"=>{"key"=>"?", "value"=>"?"}, "postMethod"=>"?", "postVariables"=>{"key"=>"?", "value"=>"?"}, "startPageText"=>"?", "trigger"=>"?", "triggerDispositions"=>"?", "url"=>"?", "variables"=>{"key"=>"?", "value"=>"?"}}}}


270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/five9tools/admin/create.rb', line 270

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