Class: PureCloud::OutboundApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/outbound_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OutboundApi

Returns a new instance of OutboundApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_outbound_attemptlimit(attempt_limits_id, opts = {}) ⇒ nil

Delete attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 32

def delete_outbound_attemptlimit(attempt_limits_id, opts = {})
  delete_outbound_attemptlimit_with_http_info(attempt_limits_id, opts)
  return nil
end

#delete_outbound_attemptlimit_with_http_info(attempt_limits_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 42

def delete_outbound_attemptlimit_with_http_info(attempt_limits_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_attemptlimit ..."
  end
  
  
  # verify the required parameter 'attempt_limits_id' is set
  fail ArgumentError, "Missing the required parameter 'attempt_limits_id' when calling OutboundApi.delete_outbound_attemptlimit" if attempt_limits_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits/{attemptLimitsId}".sub('{format}','json').sub('{' + 'attemptLimitsId' + '}', attempt_limits_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_attemptlimit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_callabletimeset(callable_time_set_id, opts = {}) ⇒ nil

Delete callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


96
97
98
99
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 96

def delete_outbound_callabletimeset(callable_time_set_id, opts = {})
  delete_outbound_callabletimeset_with_http_info(callable_time_set_id, opts)
  return nil
end

#delete_outbound_callabletimeset_with_http_info(callable_time_set_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 106

def delete_outbound_callabletimeset_with_http_info(callable_time_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_callabletimeset ..."
  end
  
  
  # verify the required parameter 'callable_time_set_id' is set
  fail ArgumentError, "Missing the required parameter 'callable_time_set_id' when calling OutboundApi.delete_outbound_callabletimeset" if callable_time_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_callabletimeset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_callanalysisresponseset(call_analysis_set_id, opts = {}) ⇒ nil

Delete a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


160
161
162
163
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 160

def delete_outbound_callanalysisresponseset(call_analysis_set_id, opts = {})
  delete_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts)
  return nil
end

#delete_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 170

def delete_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_callanalysisresponseset ..."
  end
  
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail ArgumentError, "Missing the required parameter 'call_analysis_set_id' when calling OutboundApi.delete_outbound_callanalysisresponseset" if call_analysis_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_callanalysisresponseset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_campaign(campaign_id, opts = {}) ⇒ Campaign

Delete a campaign.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



224
225
226
227
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 224

def delete_outbound_campaign(campaign_id, opts = {})
  data, _status_code, _headers = delete_outbound_campaign_with_http_info(campaign_id, opts)
  return data
end

#delete_outbound_campaign_progress(campaign_id, opts = {}) ⇒ nil

Reset campaign progress and recycle the campaign

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


289
290
291
292
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 289

def delete_outbound_campaign_progress(campaign_id, opts = {})
  delete_outbound_campaign_progress_with_http_info(campaign_id, opts)
  return nil
end

#delete_outbound_campaign_progress_with_http_info(campaign_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Reset campaign progress and recycle the campaign

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 299

def delete_outbound_campaign_progress_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_campaign_progress ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.delete_outbound_campaign_progress" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/progress".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_campaign_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Delete a campaign.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Campaign, Fixnum, Hash)>) —

    Campaign data, response status code and response headers



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 234

def delete_outbound_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.delete_outbound_campaign" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_campaignrule(campaign_rule_id, opts = {}) ⇒ nil

Delete Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


353
354
355
356
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 353

def delete_outbound_campaignrule(campaign_rule_id, opts = {})
  delete_outbound_campaignrule_with_http_info(campaign_rule_id, opts)
  return nil
end

#delete_outbound_campaignrule_with_http_info(campaign_rule_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 363

def delete_outbound_campaignrule_with_http_info(campaign_rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_campaignrule ..."
  end
  
  
  # verify the required parameter 'campaign_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_rule_id' when calling OutboundApi.delete_outbound_campaignrule" if campaign_rule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules/{campaignRuleId}".sub('{format}','json').sub('{' + 'campaignRuleId' + '}', campaign_rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_campaignrule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_contactlist(contact_list_id, opts = {}) ⇒ nil

Delete a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


417
418
419
420
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 417

def delete_outbound_contactlist(contact_list_id, opts = {})
  delete_outbound_contactlist_with_http_info(contact_list_id, opts)
  return nil
end

#delete_outbound_contactlist_contact(contact_list_id, contact_id, opts = {}) ⇒ nil

Delete a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


482
483
484
485
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 482

def delete_outbound_contactlist_contact(contact_list_id, contact_id, opts = {})
  delete_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts)
  return nil
end

#delete_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 493

def delete_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_contactlist_contact ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.delete_outbound_contactlist_contact" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling OutboundApi.delete_outbound_contactlist_contact" if contact_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_contactlist_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_contactlist_contacts(contact_list_id, contact_ids, opts = {}) ⇒ nil

Delete contacts from a contact list.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_ids —

    ContactIds to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


556
557
558
559
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 556

def delete_outbound_contactlist_contacts(contact_list_id, contact_ids, opts = {})
  delete_outbound_contactlist_contacts_with_http_info(contact_list_id, contact_ids, opts)
  return nil
end

#delete_outbound_contactlist_contacts_with_http_info(contact_list_id, contact_ids, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete contacts from a contact list.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_ids —

    ContactIds to delete.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 567

def delete_outbound_contactlist_contacts_with_http_info(contact_list_id, contact_ids, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_contactlist_contacts ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.delete_outbound_contactlist_contacts" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'contact_ids' is set
  fail ArgumentError, "Missing the required parameter 'contact_ids' when calling OutboundApi.delete_outbound_contactlist_contacts" if contact_ids.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'contactIds'] = @api_client.build_collection_param(contact_ids, :multi)

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_contactlist_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_contactlist_with_http_info(contact_list_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 427

def delete_outbound_contactlist_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_contactlist ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.delete_outbound_contactlist" if contact_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_contactlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_contactlistfilter(contact_list_filter_id, opts = {}) ⇒ nil

Delete Contact List Filter

Parameters:

  • contact_list_filter_id —

    Contact List Filter ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


630
631
632
633
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 630

def delete_outbound_contactlistfilter(contact_list_filter_id, opts = {})
  delete_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts)
  return nil
end

#delete_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete Contact List Filter

Parameters:

  • contact_list_filter_id —

    Contact List Filter ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 640

def delete_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_contactlistfilter ..."
  end
  
  
  # verify the required parameter 'contact_list_filter_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_filter_id' when calling OutboundApi.delete_outbound_contactlistfilter" if contact_list_filter_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlistfilters/{contactListFilterId}".sub('{format}','json').sub('{' + 'contactListFilterId' + '}', contact_list_filter_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_contactlistfilter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_contactlists(id, opts = {}) ⇒ nil

Delete multiple contact lists.

Parameters:

  • id —

    contact list id(s) to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


694
695
696
697
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 694

def delete_outbound_contactlists(id, opts = {})
  delete_outbound_contactlists_with_http_info(id, opts)
  return nil
end

#delete_outbound_contactlists_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete multiple contact lists.

Parameters:

  • id —

    contact list id(s) to delete

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 704

def delete_outbound_contactlists_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_contactlists ..."
  end
  
  
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling OutboundApi.delete_outbound_contactlists" if id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = @api_client.build_collection_param(id, :multi)

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_dnclist(dnc_list_id, opts = {}) ⇒ nil

Delete dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


759
760
761
762
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 759

def delete_outbound_dnclist(dnc_list_id, opts = {})
  delete_outbound_dnclist_with_http_info(dnc_list_id, opts)
  return nil
end

#delete_outbound_dnclist_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 769

def delete_outbound_dnclist_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_dnclist ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.delete_outbound_dnclist" if dnc_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_dnclist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_messagingcampaign(messaging_campaign_id, opts = {}) ⇒ MessagingCampaign

Delete an Outbound Messaging Campaign

Parameters:

  • messaging_campaign_id —

    The Messaging Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



823
824
825
826
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 823

def delete_outbound_messagingcampaign(messaging_campaign_id, opts = {})
  data, _status_code, _headers = delete_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts)
  return data
end

#delete_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts = {}) ⇒ Array<(MessagingCampaign, Fixnum, Hash)>

Delete an Outbound Messaging Campaign

Parameters:

  • messaging_campaign_id —

    The Messaging Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MessagingCampaign, Fixnum, Hash)>) —

    MessagingCampaign data, response status code and response headers



833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 833

def delete_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_messagingcampaign ..."
  end
  
  
  # verify the required parameter 'messaging_campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.delete_outbound_messagingcampaign" if messaging_campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MessagingCampaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_messagingcampaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_ruleset(rule_set_id, opts = {}) ⇒ nil

Delete a Rule set.

Parameters:

  • rule_set_id —

    Rule Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


888
889
890
891
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 888

def delete_outbound_ruleset(rule_set_id, opts = {})
  delete_outbound_ruleset_with_http_info(rule_set_id, opts)
  return nil
end

#delete_outbound_ruleset_with_http_info(rule_set_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a Rule set.

Parameters:

  • rule_set_id —

    Rule Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 898

def delete_outbound_ruleset_with_http_info(rule_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_ruleset ..."
  end
  
  
  # verify the required parameter 'rule_set_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_set_id' when calling OutboundApi.delete_outbound_ruleset" if rule_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_schedules_campaign(campaign_id, opts = {}) ⇒ nil

Delete a dialer campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


952
953
954
955
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 952

def delete_outbound_schedules_campaign(campaign_id, opts = {})
  delete_outbound_schedules_campaign_with_http_info(campaign_id, opts)
  return nil
end

#delete_outbound_schedules_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a dialer campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 962

def delete_outbound_schedules_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_schedules_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.delete_outbound_schedules_campaign" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_schedules_sequence(sequence_id, opts = {}) ⇒ nil

Delete a dialer sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1016
1017
1018
1019
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1016

def delete_outbound_schedules_sequence(sequence_id, opts = {})
  delete_outbound_schedules_sequence_with_http_info(sequence_id, opts)
  return nil
end

#delete_outbound_schedules_sequence_with_http_info(sequence_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a dialer sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1026

def delete_outbound_schedules_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_schedules_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.delete_outbound_schedules_sequence" if sequence_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_outbound_sequence(sequence_id, opts = {}) ⇒ nil

Delete a dialer campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1080
1081
1082
1083
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1080

def delete_outbound_sequence(sequence_id, opts = {})
  delete_outbound_sequence_with_http_info(sequence_id, opts)
  return nil
end

#delete_outbound_sequence_with_http_info(sequence_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a dialer campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1090

def delete_outbound_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.delete_outbound_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.delete_outbound_sequence" if sequence_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#delete_outbound_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_attemptlimit(attempt_limits_id, opts = {}) ⇒ AttemptLimits

Get attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1144
1145
1146
1147
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1144

def get_outbound_attemptlimit(attempt_limits_id, opts = {})
  data, _status_code, _headers = get_outbound_attemptlimit_with_http_info(attempt_limits_id, opts)
  return data
end

#get_outbound_attemptlimit_with_http_info(attempt_limits_id, opts = {}) ⇒ Array<(AttemptLimits, Fixnum, Hash)>

Get attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AttemptLimits, Fixnum, Hash)>) —

    AttemptLimits data, response status code and response headers



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1154

def get_outbound_attemptlimit_with_http_info(attempt_limits_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_attemptlimit ..."
  end
  
  
  # verify the required parameter 'attempt_limits_id' is set
  fail ArgumentError, "Missing the required parameter 'attempt_limits_id' when calling OutboundApi.get_outbound_attemptlimit" if attempt_limits_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits/{attemptLimitsId}".sub('{format}','json').sub('{' + 'attemptLimitsId' + '}', attempt_limits_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AttemptLimits')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_attemptlimit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_attemptlimits(opts = {}) ⇒ AttemptLimitsEntityListing

Query attempt limits list

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page (default to false)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



1215
1216
1217
1218
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1215

def get_outbound_attemptlimits(opts = {})
  data, _status_code, _headers = get_outbound_attemptlimits_with_http_info(opts)
  return data
end

#get_outbound_attemptlimits_with_http_info(opts = {}) ⇒ Array<(AttemptLimitsEntityListing, Fixnum, Hash)>

Query attempt limits list

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(AttemptLimitsEntityListing, Fixnum, Hash)>) —

    AttemptLimitsEntityListing data, response status code and response headers



1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1231

def get_outbound_attemptlimits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_attemptlimits ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AttemptLimitsEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_attemptlimits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_callabletimeset(callable_time_set_id, opts = {}) ⇒ CallableTimeSet

Get callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1335
1336
1337
1338
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1335

def get_outbound_callabletimeset(callable_time_set_id, opts = {})
  data, _status_code, _headers = get_outbound_callabletimeset_with_http_info(callable_time_set_id, opts)
  return data
end

#get_outbound_callabletimeset_with_http_info(callable_time_set_id, opts = {}) ⇒ Array<(CallableTimeSet, Fixnum, Hash)>

Get callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CallableTimeSet, Fixnum, Hash)>) —

    CallableTimeSet data, response status code and response headers



1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1345

def get_outbound_callabletimeset_with_http_info(callable_time_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_callabletimeset ..."
  end
  
  
  # verify the required parameter 'callable_time_set_id' is set
  fail ArgumentError, "Missing the required parameter 'callable_time_set_id' when calling OutboundApi.get_outbound_callabletimeset" if callable_time_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallableTimeSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_callabletimeset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_callabletimesets(opts = {}) ⇒ CallableTimeSetEntityListing

Query callable time set list

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page (default to false)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



1406
1407
1408
1409
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1406

def get_outbound_callabletimesets(opts = {})
  data, _status_code, _headers = get_outbound_callabletimesets_with_http_info(opts)
  return data
end

#get_outbound_callabletimesets_with_http_info(opts = {}) ⇒ Array<(CallableTimeSetEntityListing, Fixnum, Hash)>

Query callable time set list

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1422

def get_outbound_callabletimesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_callabletimesets ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallableTimeSetEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_callabletimesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_callanalysisresponseset(call_analysis_set_id, opts = {}) ⇒ ResponseSet

Get a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1526
1527
1528
1529
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1526

def get_outbound_callanalysisresponseset(call_analysis_set_id, opts = {})
  data, _status_code, _headers = get_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts)
  return data
end

#get_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts = {}) ⇒ Array<(ResponseSet, Fixnum, Hash)>

Get a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ResponseSet, Fixnum, Hash)>) —

    ResponseSet data, response status code and response headers



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1536

def get_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_callanalysisresponseset ..."
  end
  
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail ArgumentError, "Missing the required parameter 'call_analysis_set_id' when calling OutboundApi.get_outbound_callanalysisresponseset" if call_analysis_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_callanalysisresponseset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_callanalysisresponsesets(opts = {}) ⇒ ResponseSetEntityListing

Query a list of dialer call analysis response sets.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page (default to false)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



1597
1598
1599
1600
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1597

def get_outbound_callanalysisresponsesets(opts = {})
  data, _status_code, _headers = get_outbound_callanalysisresponsesets_with_http_info(opts)
  return data
end

#get_outbound_callanalysisresponsesets_with_http_info(opts = {}) ⇒ Array<(ResponseSetEntityListing, Fixnum, Hash)>

Query a list of dialer call analysis response sets.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(ResponseSetEntityListing, Fixnum, Hash)>) —

    ResponseSetEntityListing data, response status code and response headers



1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1613

def get_outbound_callanalysisresponsesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_callanalysisresponsesets ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseSetEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_callanalysisresponsesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaign(campaign_id, opts = {}) ⇒ Campaign

Get dialer campaign.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1717
1718
1719
1720
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1717

def get_outbound_campaign(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaign_with_http_info(campaign_id, opts)
  return data
end

#get_outbound_campaign_diagnostics(campaign_id, opts = {}) ⇒ CampaignDiagnostics

Get campaign diagnostics

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1782
1783
1784
1785
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1782

def get_outbound_campaign_diagnostics(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaign_diagnostics_with_http_info(campaign_id, opts)
  return data
end

#get_outbound_campaign_diagnostics_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignDiagnostics, Fixnum, Hash)>

Get campaign diagnostics

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignDiagnostics, Fixnum, Hash)>) —

    CampaignDiagnostics data, response status code and response headers



1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1792

def get_outbound_campaign_diagnostics_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaign_diagnostics ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaign_diagnostics" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/diagnostics".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignDiagnostics')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaign_diagnostics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaign_interactions(campaign_id, opts = {}) ⇒ CampaignInteractions

Get dialer campaign interactions.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1847
1848
1849
1850
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1847

def get_outbound_campaign_interactions(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaign_interactions_with_http_info(campaign_id, opts)
  return data
end

#get_outbound_campaign_interactions_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignInteractions, Fixnum, Hash)>

Get dialer campaign interactions.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignInteractions, Fixnum, Hash)>) —

    CampaignInteractions data, response status code and response headers



1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1857

def get_outbound_campaign_interactions_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaign_interactions ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaign_interactions" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/interactions".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignInteractions')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaign_interactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaign_progress(campaign_id, opts = {}) ⇒ CampaignProgress

Get campaign progress

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1912
1913
1914
1915
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1912

def get_outbound_campaign_progress(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaign_progress_with_http_info(campaign_id, opts)
  return data
end

#get_outbound_campaign_progress_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignProgress, Fixnum, Hash)>

Get campaign progress

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignProgress, Fixnum, Hash)>) —

    CampaignProgress data, response status code and response headers



1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1922

def get_outbound_campaign_progress_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaign_progress ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaign_progress" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/progress".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignProgress')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaign_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaign_stats(campaign_id, opts = {}) ⇒ CampaignStats

Get statistics about a Dialer Campaign

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1977
1978
1979
1980
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1977

def get_outbound_campaign_stats(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaign_stats_with_http_info(campaign_id, opts)
  return data
end

#get_outbound_campaign_stats_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignStats, Fixnum, Hash)>

Get statistics about a Dialer Campaign

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignStats, Fixnum, Hash)>) —

    CampaignStats data, response status code and response headers



1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1987

def get_outbound_campaign_stats_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaign_stats ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaign_stats" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/stats".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignStats')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaign_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Get dialer campaign.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Campaign, Fixnum, Hash)>) —

    Campaign data, response status code and response headers



1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 1727

def get_outbound_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaign" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaignrule(campaign_rule_id, opts = {}) ⇒ CampaignRule

Get Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2042
2043
2044
2045
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2042

def get_outbound_campaignrule(campaign_rule_id, opts = {})
  data, _status_code, _headers = get_outbound_campaignrule_with_http_info(campaign_rule_id, opts)
  return data
end

#get_outbound_campaignrule_with_http_info(campaign_rule_id, opts = {}) ⇒ Array<(CampaignRule, Fixnum, Hash)>

Get Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignRule, Fixnum, Hash)>) —

    CampaignRule data, response status code and response headers



2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2052

def get_outbound_campaignrule_with_http_info(campaign_rule_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaignrule ..."
  end
  
  
  # verify the required parameter 'campaign_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_rule_id' when calling OutboundApi.get_outbound_campaignrule" if campaign_rule_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules/{campaignRuleId}".sub('{format}','json').sub('{' + 'campaignRuleId' + '}', campaign_rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaignrule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaignrules(opts = {}) ⇒ CampaignRuleEntityListing

Query Campaign Rule list

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page (default to false)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



2113
2114
2115
2116
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2113

def get_outbound_campaignrules(opts = {})
  data, _status_code, _headers = get_outbound_campaignrules_with_http_info(opts)
  return data
end

#get_outbound_campaignrules_with_http_info(opts = {}) ⇒ Array<(CampaignRuleEntityListing, Fixnum, Hash)>

Query Campaign Rule list

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(CampaignRuleEntityListing, Fixnum, Hash)>) —

    CampaignRuleEntityListing data, response status code and response headers



2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2129

def get_outbound_campaignrules_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaignrules ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignRuleEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaignrules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaigns(opts = {}) ⇒ CampaignEntityListing

Query a list of dialer campaigns.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :contact_list_id (String) —

    Contact List ID

  • :dnc_list_ids (String) —

    DNC list ID

  • :distribution_queue_id (String) —

    Distribution queue ID

  • :edge_group_id (String) —

    Edge group ID

  • :call_analysis_response_set_id (String) —

    Call analysis response set ID

  • :division_id (Array<String>) —

    Division ID(s)

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



2245
2246
2247
2248
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2245

def get_outbound_campaigns(opts = {})
  data, _status_code, _headers = get_outbound_campaigns_with_http_info(opts)
  return data
end

#get_outbound_campaigns_all(opts = {}) ⇒ CommonCampaignEntityListing

Query across all types of campaigns by division

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :id (Array<String>) —

    Campaign ID(s)

  • :name (String) —

    Campaign name(s)

  • :division_id (Array<String>) —

    Division ID(s)

  • :media_type (Array<String>) —

    Media type(s)

  • :sort_order (String) —

    Sort order (default to a)

Returns:



2419
2420
2421
2422
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2419

def get_outbound_campaigns_all(opts = {})
  data, _status_code, _headers = get_outbound_campaigns_all_with_http_info(opts)
  return data
end

#get_outbound_campaigns_all_divisionviews(opts = {}) ⇒ CommonCampaignDivisionViewEntityListing

Query across all types of campaigns

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :id (Array<String>) —

    Campaign ID(s)

  • :name (String) —

    Campaign name(s)

  • :division_id (Array<String>) —

    Division ID(s)

  • :media_type (Array<String>) —

    Media type(s)

  • :sort_order (String) —

    Sort order (default to a)

Returns:



2541
2542
2543
2544
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2541

def get_outbound_campaigns_all_divisionviews(opts = {})
  data, _status_code, _headers = get_outbound_campaigns_all_divisionviews_with_http_info(opts)
  return data
end

#get_outbound_campaigns_all_divisionviews_with_http_info(opts = {}) ⇒ Array<(CommonCampaignDivisionViewEntityListing, Fixnum, Hash)>

Query across all types of campaigns

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :id (Array<String>) —

    Campaign ID(s)

  • :name (String) —

    Campaign name(s)

  • :division_id (Array<String>) —

    Division ID(s)

  • :media_type (Array<String>) —

    Media type(s)

  • :sort_order (String) —

    Sort order

Returns:



2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2557

def get_outbound_campaigns_all_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_all_divisionviews ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/all/divisionviews".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'mediaType'] = @api_client.build_collection_param(opts[:'media_type'], :multi) if opts[:'media_type']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CommonCampaignDivisionViewEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_all_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaigns_all_with_http_info(opts = {}) ⇒ Array<(CommonCampaignEntityListing, Fixnum, Hash)>

Query across all types of campaigns by division

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :id (Array<String>) —

    Campaign ID(s)

  • :name (String) —

    Campaign name(s)

  • :division_id (Array<String>) —

    Division ID(s)

  • :media_type (Array<String>) —

    Media type(s)

  • :sort_order (String) —

    Sort order

Returns:



2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2435

def get_outbound_campaigns_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_all ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/all".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'mediaType'] = @api_client.build_collection_param(opts[:'media_type'], :multi) if opts[:'media_type']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CommonCampaignEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaigns_divisionview(campaign_id, opts = {}) ⇒ CampaignDivisionView

Get a basic Campaign information object This returns a simplified version of a Campaign, consisting of name and division.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2657
2658
2659
2660
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2657

def get_outbound_campaigns_divisionview(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts)
  return data
end

#get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignDivisionView, Fixnum, Hash)>

Get a basic Campaign information object This returns a simplified version of a Campaign, consisting of name and division.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignDivisionView, Fixnum, Hash)>) —

    CampaignDivisionView data, response status code and response headers



2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2667

def get_outbound_campaigns_divisionview_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_divisionview ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_campaigns_divisionview" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/divisionviews/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignDivisionView')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaigns_divisionviews(opts = {}) ⇒ CampaignDivisionViewListing

Query a list of basic Campaign information objects This returns a simplified version of a Campaign, consisting of name and division.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



2728
2729
2730
2731
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2728

def get_outbound_campaigns_divisionviews(opts = {})
  data, _status_code, _headers = get_outbound_campaigns_divisionviews_with_http_info(opts)
  return data
end

#get_outbound_campaigns_divisionviews_with_http_info(opts = {}) ⇒ Array<(CampaignDivisionViewListing, Fixnum, Hash)>

Query a list of basic Campaign information objects This returns a simplified version of a Campaign, consisting of name and division.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2744

def get_outbound_campaigns_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_divisionviews ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/divisionviews".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignDivisionViewListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_campaigns_with_http_info(opts = {}) ⇒ Array<(CampaignEntityListing, Fixnum, Hash)>

Query a list of dialer campaigns.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :contact_list_id (String) —

    Contact List ID

  • :dnc_list_ids (String) —

    DNC list ID

  • :distribution_queue_id (String) —

    Distribution queue ID

  • :edge_group_id (String) —

    Edge group ID

  • :call_analysis_response_set_id (String) —

    Call analysis response set ID

  • :division_id (Array<String>) —

    Division ID(s)

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(CampaignEntityListing, Fixnum, Hash)>) —

    CampaignEntityListing data, response status code and response headers



2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2267

def get_outbound_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'contactListId'] = opts[:'contact_list_id'] if opts[:'contact_list_id']
  query_params[:'dncListIds'] = opts[:'dnc_list_ids'] if opts[:'dnc_list_ids']
  query_params[:'distributionQueueId'] = opts[:'distribution_queue_id'] if opts[:'distribution_queue_id']
  query_params[:'edgeGroupId'] = opts[:'edge_group_id'] if opts[:'edge_group_id']
  query_params[:'callAnalysisResponseSetId'] = opts[:'call_analysis_response_set_id'] if opts[:'call_analysis_response_set_id']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_contactlist(contact_list_id, opts = {}) ⇒ ContactList

Get a dialer contact list.

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

Returns:



2850
2851
2852
2853
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2850

def get_outbound_contactlist(contact_list_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlist_with_http_info(contact_list_id, opts)
  return data
end

#get_outbound_contactlist_contact(contact_list_id, contact_id, opts = {}) ⇒ DialerContact

Get a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



2932
2933
2934
2935
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2932

def get_outbound_contactlist_contact(contact_list_id, contact_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts)
  return data
end

#get_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts = {}) ⇒ Array<(DialerContact, Fixnum, Hash)>

Get a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DialerContact, Fixnum, Hash)>) —

    DialerContact data, response status code and response headers



2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2943

def get_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist_contact ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist_contact" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling OutboundApi.get_outbound_contactlist_contact" if contact_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DialerContact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_contactlist_export(contact_list_id, opts = {}) ⇒ ExportUri

Get the URI of a contact list export.

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :download (String) —

    Redirect to download uri (default to false)

Returns:



3007
3008
3009
3010
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3007

def get_outbound_contactlist_export(contact_list_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlist_export_with_http_info(contact_list_id, opts)
  return data
end

#get_outbound_contactlist_export_with_http_info(contact_list_id, opts = {}) ⇒ Array<(ExportUri, Fixnum, Hash)>

Get the URI of a contact list export.

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :download (String) —

    Redirect to download uri

Returns:

  • (Array<(ExportUri, Fixnum, Hash)>) —

    ExportUri data, response status code and response headers



3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3018

def get_outbound_contactlist_export_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist_export ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist_export" if contact_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/export".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'download'] = opts[:'download'] if opts[:'download']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExportUri')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_contactlist_importstatus(contact_list_id, opts = {}) ⇒ ImportStatus

Get dialer contactList import status.

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3080
3081
3082
3083
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3080

def get_outbound_contactlist_importstatus(contact_list_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlist_importstatus_with_http_info(contact_list_id, opts)
  return data
end

#get_outbound_contactlist_importstatus_with_http_info(contact_list_id, opts = {}) ⇒ Array<(ImportStatus, Fixnum, Hash)>

Get dialer contactList import status.

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ImportStatus, Fixnum, Hash)>) —

    ImportStatus data, response status code and response headers



3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3090

def get_outbound_contactlist_importstatus_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist_importstatus ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist_importstatus" if contact_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/importstatus".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ImportStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist_importstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_contactlist_timezonemappingpreview(contact_list_id, opts = {}) ⇒ TimeZoneMappingPreview

Preview the result of applying Automatic Time Zone Mapping to a contact list

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3145
3146
3147
3148
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3145

def get_outbound_contactlist_timezonemappingpreview(contact_list_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlist_timezonemappingpreview_with_http_info(contact_list_id, opts)
  return data
end

#get_outbound_contactlist_timezonemappingpreview_with_http_info(contact_list_id, opts = {}) ⇒ Array<(TimeZoneMappingPreview, Fixnum, Hash)>

Preview the result of applying Automatic Time Zone Mapping to a contact list

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TimeZoneMappingPreview, Fixnum, Hash)>) —

    TimeZoneMappingPreview data, response status code and response headers



3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3155

def get_outbound_contactlist_timezonemappingpreview_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist_timezonemappingpreview ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist_timezonemappingpreview" if contact_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TimeZoneMappingPreview')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist_timezonemappingpreview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_contactlist_with_http_info(contact_list_id, opts = {}) ⇒ Array<(ContactList, Fixnum, Hash)>

Get a dialer contact list.

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

Returns:

  • (Array<(ContactList, Fixnum, Hash)>) —

    ContactList data, response status code and response headers



2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 2862

def get_outbound_contactlist_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlist ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlist" if contact_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_contactlistfilter(contact_list_filter_id, opts = {}) ⇒ ContactListFilter

Get Contact list filter

Parameters:

  • contact_list_filter_id —

    Contact List Filter ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3210
3211
3212
3213
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3210

def get_outbound_contactlistfilter(contact_list_filter_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts)
  return data
end

#get_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts = {}) ⇒ Array<(ContactListFilter, Fixnum, Hash)>

Get Contact list filter

Parameters:

  • contact_list_filter_id —

    Contact List Filter ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ContactListFilter, Fixnum, Hash)>) —

    ContactListFilter data, response status code and response headers



3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3220

def get_outbound_contactlistfilter_with_http_info(contact_list_filter_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlistfilter ..."
  end
  
  
  # verify the required parameter 'contact_list_filter_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_filter_id' when calling OutboundApi.get_outbound_contactlistfilter" if contact_list_filter_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlistfilters/{contactListFilterId}".sub('{format}','json').sub('{' + 'contactListFilterId' + '}', contact_list_filter_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactListFilter')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlistfilter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_contactlistfilters(opts = {}) ⇒ ContactListFilterEntityListing

Query Contact list filters

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page (default to false)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

  • :contact_list_id (String) —

    Contact List ID

Returns:



3282
3283
3284
3285
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3282

def get_outbound_contactlistfilters(opts = {})
  data, _status_code, _headers = get_outbound_contactlistfilters_with_http_info(opts)
  return data
end

#get_outbound_contactlistfilters_with_http_info(opts = {}) ⇒ Array<(ContactListFilterEntityListing, Fixnum, Hash)>

Query Contact list filters

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :contact_list_id (String) —

    Contact List ID

Returns:



3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3299

def get_outbound_contactlistfilters_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlistfilters ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlistfilters".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'contactListId'] = opts[:'contact_list_id'] if opts[:'contact_list_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactListFilterEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlistfilters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_contactlists(opts = {}) ⇒ ContactListEntityListing

Query a list of contact lists.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page (default to false)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :division_id (Array<String>) —

    Division ID(s)

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



3420
3421
3422
3423
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3420

def get_outbound_contactlists(opts = {})
  data, _status_code, _headers = get_outbound_contactlists_with_http_info(opts)
  return data
end

#get_outbound_contactlists_divisionview(contact_list_id, opts = {}) ⇒ ContactListDivisionView

Get a basic ContactList information object This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.

Parameters:

  • contact_list_id —

    Contactlist ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

Returns:



3574
3575
3576
3577
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3574

def get_outbound_contactlists_divisionview(contact_list_id, opts = {})
  data, _status_code, _headers = get_outbound_contactlists_divisionview_with_http_info(contact_list_id, opts)
  return data
end

#get_outbound_contactlists_divisionview_with_http_info(contact_list_id, opts = {}) ⇒ Array<(ContactListDivisionView, Fixnum, Hash)>

Get a basic ContactList information object This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.

Parameters:

  • contact_list_id —

    Contactlist ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status

  • :include_size (BOOLEAN) —

    Include size

Returns:

  • (Array<(ContactListDivisionView, Fixnum, Hash)>) —

    ContactListDivisionView data, response status code and response headers



3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3586

def get_outbound_contactlists_divisionview_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlists_divisionview ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.get_outbound_contactlists_divisionview" if contact_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/divisionviews/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactListDivisionView')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlists_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_contactlists_divisionviews(opts = {}) ⇒ ContactListDivisionViewListing

Query a list of simplified contact list objects. This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



3663
3664
3665
3666
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3663

def get_outbound_contactlists_divisionviews(opts = {})
  data, _status_code, _headers = get_outbound_contactlists_divisionviews_with_http_info(opts)
  return data
end

#get_outbound_contactlists_divisionviews_with_http_info(opts = {}) ⇒ Array<(ContactListDivisionViewListing, Fixnum, Hash)>

Query a list of simplified contact list objects. This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status

  • :include_size (BOOLEAN) —

    Include size

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3681

def get_outbound_contactlists_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlists_divisionviews ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/divisionviews".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactListDivisionViewListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlists_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_contactlists_with_http_info(opts = {}) ⇒ Array<(ContactListEntityListing, Fixnum, Hash)>

Query a list of contact lists.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status

  • :include_size (BOOLEAN) —

    Include size

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :division_id (Array<String>) —

    Division ID(s)

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(ContactListEntityListing, Fixnum, Hash)>) —

    ContactListEntityListing data, response status code and response headers



3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3440

def get_outbound_contactlists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_contactlists ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactListEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_dnclist(dnc_list_id, opts = {}) ⇒ DncList

Get dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

Returns:



3801
3802
3803
3804
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3801

def get_outbound_dnclist(dnc_list_id, opts = {})
  data, _status_code, _headers = get_outbound_dnclist_with_http_info(dnc_list_id, opts)
  return data
end

#get_outbound_dnclist_export(dnc_list_id, opts = {}) ⇒ ExportUri

Get the URI of a DNC list export.

Parameters:

  • dnc_list_id —

    DncList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :download (String) —

    Redirect to download uri (default to false)

Returns:



3883
3884
3885
3886
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3883

def get_outbound_dnclist_export(dnc_list_id, opts = {})
  data, _status_code, _headers = get_outbound_dnclist_export_with_http_info(dnc_list_id, opts)
  return data
end

#get_outbound_dnclist_export_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(ExportUri, Fixnum, Hash)>

Get the URI of a DNC list export.

Parameters:

  • dnc_list_id —

    DncList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :download (String) —

    Redirect to download uri

Returns:

  • (Array<(ExportUri, Fixnum, Hash)>) —

    ExportUri data, response status code and response headers



3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3894

def get_outbound_dnclist_export_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclist_export ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.get_outbound_dnclist_export" if dnc_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/export".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'download'] = opts[:'download'] if opts[:'download']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ExportUri')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_dnclist_importstatus(dnc_list_id, opts = {}) ⇒ ImportStatus

Get dialer dncList import status.

Parameters:

  • dnc_list_id —

    DncList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



3956
3957
3958
3959
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3956

def get_outbound_dnclist_importstatus(dnc_list_id, opts = {})
  data, _status_code, _headers = get_outbound_dnclist_importstatus_with_http_info(dnc_list_id, opts)
  return data
end

#get_outbound_dnclist_importstatus_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(ImportStatus, Fixnum, Hash)>

Get dialer dncList import status.

Parameters:

  • dnc_list_id —

    DncList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ImportStatus, Fixnum, Hash)>) —

    ImportStatus data, response status code and response headers



3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3966

def get_outbound_dnclist_importstatus_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclist_importstatus ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.get_outbound_dnclist_importstatus" if dnc_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/importstatus".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ImportStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclist_importstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_dnclist_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(DncList, Fixnum, Hash)>

Get dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

Returns:

  • (Array<(DncList, Fixnum, Hash)>) —

    DncList data, response status code and response headers



3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 3813

def get_outbound_dnclist_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclist ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.get_outbound_dnclist" if dnc_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DncList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_dnclists(opts = {}) ⇒ DncListEntityListing

Query dialer DNC lists

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page (default to false)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :dnc_source_type (String) —

    DncSourceType

  • :division_id (Array<String>) —

    Division ID(s)

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



4031
4032
4033
4034
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4031

def get_outbound_dnclists(opts = {})
  data, _status_code, _headers = get_outbound_dnclists_with_http_info(opts)
  return data
end

#get_outbound_dnclists_divisionview(dnc_list_id, opts = {}) ⇒ DncListDivisionView

Get a basic DncList information object This returns a simplified version of a DncList, consisting of the name, division, import status, and size.

Parameters:

  • dnc_list_id —

    Dnclist ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

Returns:



4189
4190
4191
4192
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4189

def get_outbound_dnclists_divisionview(dnc_list_id, opts = {})
  data, _status_code, _headers = get_outbound_dnclists_divisionview_with_http_info(dnc_list_id, opts)
  return data
end

#get_outbound_dnclists_divisionview_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(DncListDivisionView, Fixnum, Hash)>

Get a basic DncList information object This returns a simplified version of a DncList, consisting of the name, division, import status, and size.

Parameters:

  • dnc_list_id —

    Dnclist ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status

  • :include_size (BOOLEAN) —

    Include size

Returns:

  • (Array<(DncListDivisionView, Fixnum, Hash)>) —

    DncListDivisionView data, response status code and response headers



4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4201

def get_outbound_dnclists_divisionview_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclists_divisionview ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.get_outbound_dnclists_divisionview" if dnc_list_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/divisionviews/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DncListDivisionView')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclists_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_dnclists_divisionviews(opts = {}) ⇒ DncListDivisionViewListing

Query a list of simplified dnc list objects. This return a simplified version of dnc lists, consisting of the name, division, import status, and size.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status (default to false)

  • :include_size (BOOLEAN) —

    Include size (default to false)

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



4278
4279
4280
4281
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4278

def get_outbound_dnclists_divisionviews(opts = {})
  data, _status_code, _headers = get_outbound_dnclists_divisionviews_with_http_info(opts)
  return data
end

#get_outbound_dnclists_divisionviews_with_http_info(opts = {}) ⇒ Array<(DncListDivisionViewListing, Fixnum, Hash)>

Query a list of simplified dnc list objects. This return a simplified version of dnc lists, consisting of the name, division, import status, and size.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Include import status

  • :include_size (BOOLEAN) —

    Include size

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(DncListDivisionViewListing, Fixnum, Hash)>) —

    DncListDivisionViewListing data, response status code and response headers



4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4296

def get_outbound_dnclists_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclists_divisionviews ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/divisionviews".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DncListDivisionViewListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclists_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_dnclists_with_http_info(opts = {}) ⇒ Array<(DncListEntityListing, Fixnum, Hash)>

Query dialer DNC lists

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :dnc_source_type (String) —

    DncSourceType

  • :division_id (Array<String>) —

    Division ID(s)

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(DncListEntityListing, Fixnum, Hash)>) —

    DncListEntityListing data, response status code and response headers



4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4051

def get_outbound_dnclists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_dnclists ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'dnc_source_type'] && !['rds', 'dnc.com', 'gryphon'].include?(opts[:'dnc_source_type'])
    fail ArgumentError, 'invalid value for "dnc_source_type", must be one of rds, dnc.com, gryphon'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'dncSourceType'] = opts[:'dnc_source_type'] if opts[:'dnc_source_type']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DncListEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_dnclists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_event(event_id, opts = {}) ⇒ EventLog

Get Dialer Event

Parameters:

  • event_id —

    Event Log ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4414
4415
4416
4417
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4414

def get_outbound_event(event_id, opts = {})
  data, _status_code, _headers = get_outbound_event_with_http_info(event_id, opts)
  return data
end

#get_outbound_event_with_http_info(event_id, opts = {}) ⇒ Array<(EventLog, Fixnum, Hash)>

Get Dialer Event

Parameters:

  • event_id —

    Event Log ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EventLog, Fixnum, Hash)>) —

    EventLog data, response status code and response headers



4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4424

def get_outbound_event_with_http_info(event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_event ..."
  end
  
  
  # verify the required parameter 'event_id' is set
  fail ArgumentError, "Missing the required parameter 'event_id' when calling OutboundApi.get_outbound_event" if event_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/events/{eventId}".sub('{format}','json').sub('{' + 'eventId' + '}', event_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EventLog')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_events(opts = {}) ⇒ DialerEventEntityListing

Query Event Logs

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :category (String) —

    Category

  • :level (String) —

    Level

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



4485
4486
4487
4488
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4485

def get_outbound_events(opts = {})
  data, _status_code, _headers = get_outbound_events_with_http_info(opts)
  return data
end

#get_outbound_events_with_http_info(opts = {}) ⇒ Array<(DialerEventEntityListing, Fixnum, Hash)>

Query Event Logs

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :category (String) —

    Category

  • :level (String) —

    Level

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(DialerEventEntityListing, Fixnum, Hash)>) —

    DialerEventEntityListing data, response status code and response headers



4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4501

def get_outbound_events_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_events ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/events".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'category'] = opts[:'category'] if opts[:'category']
  query_params[:'level'] = opts[:'level'] if opts[:'level']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DialerEventEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_messagingcampaign(messaging_campaign_id, opts = {}) ⇒ MessagingCampaign

Get an Outbound Messaging Campaign

Parameters:

  • messaging_campaign_id —

    The Messaging Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4605
4606
4607
4608
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4605

def get_outbound_messagingcampaign(messaging_campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts)
  return data
end

#get_outbound_messagingcampaign_progress(messaging_campaign_id, opts = {}) ⇒ CampaignProgress

Get messaging campaign’s progress

Parameters:

  • messaging_campaign_id —

    The Messaging Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4670
4671
4672
4673
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4670

def get_outbound_messagingcampaign_progress(messaging_campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_messagingcampaign_progress_with_http_info(messaging_campaign_id, opts)
  return data
end

#get_outbound_messagingcampaign_progress_with_http_info(messaging_campaign_id, opts = {}) ⇒ Array<(CampaignProgress, Fixnum, Hash)>

Get messaging campaign&#39;s progress

Parameters:

  • messaging_campaign_id —

    The Messaging Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignProgress, Fixnum, Hash)>) —

    CampaignProgress data, response status code and response headers



4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4680

def get_outbound_messagingcampaign_progress_with_http_info(messaging_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaign_progress ..."
  end
  
  
  # verify the required parameter 'messaging_campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.get_outbound_messagingcampaign_progress" if messaging_campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignProgress')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaign_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts = {}) ⇒ Array<(MessagingCampaign, Fixnum, Hash)>

Get an Outbound Messaging Campaign

Parameters:

  • messaging_campaign_id —

    The Messaging Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MessagingCampaign, Fixnum, Hash)>) —

    MessagingCampaign data, response status code and response headers



4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4615

def get_outbound_messagingcampaign_with_http_info(messaging_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaign ..."
  end
  
  
  # verify the required parameter 'messaging_campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.get_outbound_messagingcampaign" if messaging_campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MessagingCampaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_messagingcampaigns(opts = {}) ⇒ MessagingCampaignEntityListing

Query a list of Messaging Campaigns

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    The field to sort by (default to name)

  • :sort_order (String) —

    The direction to sort (default to ascending)

  • :name (String) —

    Name

  • :contact_list_id (String) —

    Contact List ID

  • :division_id (Array<String>) —

    Division ID(s)

  • :type (String) —

    Campaign Type

  • :sender_sms_phone_number (String) —

    Sender SMS Phone Number

  • :id (Array<String>) —

    A list of messaging campaign ids to bulk fetch

Returns:



4744
4745
4746
4747
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4744

def get_outbound_messagingcampaigns(opts = {})
  data, _status_code, _headers = get_outbound_messagingcampaigns_with_http_info(opts)
  return data
end

#get_outbound_messagingcampaigns_divisionview(messaging_campaign_id, opts = {}) ⇒ MessagingCampaignDivisionView

Get a basic Messaging Campaign information object This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.

Parameters:

  • messaging_campaign_id —

    The Messaging Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4892
4893
4894
4895
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4892

def get_outbound_messagingcampaigns_divisionview(messaging_campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_messagingcampaigns_divisionview_with_http_info(messaging_campaign_id, opts)
  return data
end

#get_outbound_messagingcampaigns_divisionview_with_http_info(messaging_campaign_id, opts = {}) ⇒ Array<(MessagingCampaignDivisionView, Fixnum, Hash)>

Get a basic Messaging Campaign information object This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.

Parameters:

  • messaging_campaign_id —

    The Messaging Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4902

def get_outbound_messagingcampaigns_divisionview_with_http_info(messaging_campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaigns_divisionview ..."
  end
  
  
  # verify the required parameter 'messaging_campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.get_outbound_messagingcampaigns_divisionview" if messaging_campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MessagingCampaignDivisionView')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaigns_divisionview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_messagingcampaigns_divisionviews(opts = {}) ⇒ MessagingCampaignDivisionViewEntityListing

Query a list of basic Messaging Campaign information objects This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_order (String) —

    The direction to sort (default to a)

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :sender_sms_phone_number (String) —

    Sender SMS Phone Number

Returns:



4962
4963
4964
4965
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4962

def get_outbound_messagingcampaigns_divisionviews(opts = {})
  data, _status_code, _headers = get_outbound_messagingcampaigns_divisionviews_with_http_info(opts)
  return data
end

#get_outbound_messagingcampaigns_divisionviews_with_http_info(opts = {}) ⇒ Array<(MessagingCampaignDivisionViewEntityListing, Fixnum, Hash)>

Query a list of basic Messaging Campaign information objects This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    The direction to sort

  • :name (String) —

    Name

  • :id (Array<String>) —

    id

  • :sender_sms_phone_number (String) —

    Sender SMS Phone Number

Returns:



4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4977

def get_outbound_messagingcampaigns_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaigns_divisionviews ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/divisionviews".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'senderSmsPhoneNumber'] = opts[:'sender_sms_phone_number'] if opts[:'sender_sms_phone_number']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MessagingCampaignDivisionViewEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaigns_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_messagingcampaigns_with_http_info(opts = {}) ⇒ Array<(MessagingCampaignEntityListing, Fixnum, Hash)>

Query a list of Messaging Campaigns

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    The field to sort by

  • :sort_order (String) —

    The direction to sort

  • :name (String) —

    Name

  • :contact_list_id (String) —

    Contact List ID

  • :division_id (Array<String>) —

    Division ID(s)

  • :type (String) —

    Campaign Type

  • :sender_sms_phone_number (String) —

    Sender SMS Phone Number

  • :id (Array<String>) —

    A list of messaging campaign ids to bulk fetch

Returns:



4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 4763

def get_outbound_messagingcampaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_messagingcampaigns ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_by'] && !['campaignStatus', 'name', 'type'].include?(opts[:'sort_by'])
    fail ArgumentError, 'invalid value for "sort_by", must be one of campaignStatus, name, type'
  end
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'type'] && !['SMS'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of SMS'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'contactListId'] = opts[:'contact_list_id'] if opts[:'contact_list_id']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
  query_params[:'type'] = opts[:'type'] if opts[:'type']
  query_params[:'senderSmsPhoneNumber'] = opts[:'sender_sms_phone_number'] if opts[:'sender_sms_phone_number']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MessagingCampaignEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_messagingcampaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_ruleset(rule_set_id, opts = {}) ⇒ RuleSet

Get a Rule Set by ID.

Parameters:

  • rule_set_id —

    Rule Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5070
5071
5072
5073
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5070

def get_outbound_ruleset(rule_set_id, opts = {})
  data, _status_code, _headers = get_outbound_ruleset_with_http_info(rule_set_id, opts)
  return data
end

#get_outbound_ruleset_with_http_info(rule_set_id, opts = {}) ⇒ Array<(RuleSet, Fixnum, Hash)>

Get a Rule Set by ID.

Parameters:

  • rule_set_id —

    Rule Set ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RuleSet, Fixnum, Hash)>) —

    RuleSet data, response status code and response headers



5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5080

def get_outbound_ruleset_with_http_info(rule_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_ruleset ..."
  end
  
  
  # verify the required parameter 'rule_set_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_set_id' when calling OutboundApi.get_outbound_ruleset" if rule_set_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RuleSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_rulesets(opts = {}) ⇒ RuleSetEntityListing

Query a list of Rule Sets.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page (default to false)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



5141
5142
5143
5144
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5141

def get_outbound_rulesets(opts = {})
  data, _status_code, _headers = get_outbound_rulesets_with_http_info(opts)
  return data
end

#get_outbound_rulesets_with_http_info(opts = {}) ⇒ Array<(RuleSetEntityListing, Fixnum, Hash)>

Query a list of Rule Sets.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

  • (Array<(RuleSetEntityListing, Fixnum, Hash)>) —

    RuleSetEntityListing data, response status code and response headers



5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5157

def get_outbound_rulesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_rulesets ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RuleSetEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_schedules_campaign(campaign_id, opts = {}) ⇒ CampaignSchedule

Get a dialer campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5261
5262
5263
5264
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5261

def get_outbound_schedules_campaign(campaign_id, opts = {})
  data, _status_code, _headers = get_outbound_schedules_campaign_with_http_info(campaign_id, opts)
  return data
end

#get_outbound_schedules_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(CampaignSchedule, Fixnum, Hash)>

Get a dialer campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignSchedule, Fixnum, Hash)>) —

    CampaignSchedule data, response status code and response headers



5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5271

def get_outbound_schedules_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_schedules_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.get_outbound_schedules_campaign" if campaign_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_schedules_campaigns(opts = {}) ⇒ Array<CampaignSchedule>

Query for a list of dialer campaign schedules.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5325
5326
5327
5328
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5325

def get_outbound_schedules_campaigns(opts = {})
  data, _status_code, _headers = get_outbound_schedules_campaigns_with_http_info(opts)
  return data
end

#get_outbound_schedules_campaigns_with_http_info(opts = {}) ⇒ Array<(Array<CampaignSchedule>, Fixnum, Hash)>

Query for a list of dialer campaign schedules.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<CampaignSchedule>, Fixnum, Hash)>) —

    Array<CampaignSchedule> data, response status code and response headers



5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5334

def get_outbound_schedules_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_schedules_campaigns ..."
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<CampaignSchedule>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_schedules_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_schedules_sequence(sequence_id, opts = {}) ⇒ SequenceSchedule

Get a dialer sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5381
5382
5383
5384
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5381

def get_outbound_schedules_sequence(sequence_id, opts = {})
  data, _status_code, _headers = get_outbound_schedules_sequence_with_http_info(sequence_id, opts)
  return data
end

#get_outbound_schedules_sequence_with_http_info(sequence_id, opts = {}) ⇒ Array<(SequenceSchedule, Fixnum, Hash)>

Get a dialer sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SequenceSchedule, Fixnum, Hash)>) —

    SequenceSchedule data, response status code and response headers



5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5391

def get_outbound_schedules_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_schedules_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.get_outbound_schedules_sequence" if sequence_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SequenceSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_schedules_sequences(opts = {}) ⇒ Array<SequenceSchedule>

Query for a list of dialer sequence schedules.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5445
5446
5447
5448
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5445

def get_outbound_schedules_sequences(opts = {})
  data, _status_code, _headers = get_outbound_schedules_sequences_with_http_info(opts)
  return data
end

#get_outbound_schedules_sequences_with_http_info(opts = {}) ⇒ Array<(Array<SequenceSchedule>, Fixnum, Hash)>

Query for a list of dialer sequence schedules.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<SequenceSchedule>, Fixnum, Hash)>) —

    Array<SequenceSchedule> data, response status code and response headers



5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5454

def get_outbound_schedules_sequences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_schedules_sequences ..."
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<SequenceSchedule>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_schedules_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_sequence(sequence_id, opts = {}) ⇒ CampaignSequence

Get a dialer campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5501
5502
5503
5504
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5501

def get_outbound_sequence(sequence_id, opts = {})
  data, _status_code, _headers = get_outbound_sequence_with_http_info(sequence_id, opts)
  return data
end

#get_outbound_sequence_with_http_info(sequence_id, opts = {}) ⇒ Array<(CampaignSequence, Fixnum, Hash)>

Get a dialer campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignSequence, Fixnum, Hash)>) —

    CampaignSequence data, response status code and response headers



5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5511

def get_outbound_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.get_outbound_sequence" if sequence_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignSequence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_sequences(opts = {}) ⇒ CampaignSequenceEntityListing

Query a list of dialer campaign sequences.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100. (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page (default to false)

  • :filter_type (String) —

    Filter type (default to Prefix)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order (default to a)

Returns:



5572
5573
5574
5575
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5572

def get_outbound_sequences(opts = {})
  data, _status_code, _headers = get_outbound_sequences_with_http_info(opts)
  return data
end

#get_outbound_sequences_with_http_info(opts = {}) ⇒ Array<(CampaignSequenceEntityListing, Fixnum, Hash)>

Query a list of dialer campaign sequences.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size. The max that will be returned is 100.

  • :page_number (Integer) —

    Page number

  • :allow_empty_result (BOOLEAN) —

    Whether to return an empty page when there are no results for that page

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5588

def get_outbound_sequences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_sequences ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
    fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'allowEmptyResult'] = opts[:'allow_empty_result'] if opts[:'allow_empty_result']
  query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignSequenceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_settings(opts = {}) ⇒ OutboundSettings

Get the outbound settings for this organization

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5691
5692
5693
5694
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5691

def get_outbound_settings(opts = {})
  data, _status_code, _headers = get_outbound_settings_with_http_info(opts)
  return data
end

#get_outbound_settings_with_http_info(opts = {}) ⇒ Array<(OutboundSettings, Fixnum, Hash)>

Get the outbound settings for this organization

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(OutboundSettings, Fixnum, Hash)>) —

    OutboundSettings data, response status code and response headers



5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5700

def get_outbound_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_settings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/settings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OutboundSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_outbound_wrapupcodemappings(opts = {}) ⇒ WrapUpCodeMapping

Get the Dialer wrap up code mapping.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5746
5747
5748
5749
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5746

def get_outbound_wrapupcodemappings(opts = {})
  data, _status_code, _headers = get_outbound_wrapupcodemappings_with_http_info(opts)
  return data
end

#get_outbound_wrapupcodemappings_with_http_info(opts = {}) ⇒ Array<(WrapUpCodeMapping, Fixnum, Hash)>

Get the Dialer wrap up code mapping.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WrapUpCodeMapping, Fixnum, Hash)>) —

    WrapUpCodeMapping data, response status code and response headers



5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5755

def get_outbound_wrapupcodemappings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_wrapupcodemappings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/outbound/wrapupcodemappings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapUpCodeMapping')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_outbound_wrapupcodemappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_outbound_settings(body, opts = {}) ⇒ nil

Update the outbound settings for this organization

Parameters:

  • body —

    outboundSettings

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


5802
5803
5804
5805
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5802

def patch_outbound_settings(body, opts = {})
  patch_outbound_settings_with_http_info(body, opts)
  return nil
end

#patch_outbound_settings_with_http_info(body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the outbound settings for this organization

Parameters:

  • body —

    outboundSettings

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5812

def patch_outbound_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.patch_outbound_settings ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.patch_outbound_settings" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/settings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#patch_outbound_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_attemptlimits(body, opts = {}) ⇒ AttemptLimits

Create attempt limits

Parameters:

  • body —

    AttemptLimits

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



5866
5867
5868
5869
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5866

def post_outbound_attemptlimits(body, opts = {})
  data, _status_code, _headers = post_outbound_attemptlimits_with_http_info(body, opts)
  return data
end

#post_outbound_attemptlimits_with_http_info(body, opts = {}) ⇒ Array<(AttemptLimits, Fixnum, Hash)>

Create attempt limits

Parameters:

  • body —

    AttemptLimits

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AttemptLimits, Fixnum, Hash)>) —

    AttemptLimits data, response status code and response headers



5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5876

def post_outbound_attemptlimits_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_attemptlimits ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_attemptlimits" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AttemptLimits')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_attemptlimits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_audits(body, opts = {}) ⇒ AuditSearchResult

Retrieves audits for dialer.

Parameters:

  • body —

    AuditSearch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Sort by (default to entity.name)

  • :sort_order (String) —

    Sort order (default to ascending)

  • :facets_only (BOOLEAN) —

    Facets only (default to false)

Returns:



5936
5937
5938
5939
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5936

def post_outbound_audits(body, opts = {})
  data, _status_code, _headers = post_outbound_audits_with_http_info(body, opts)
  return data
end

#post_outbound_audits_with_http_info(body, opts = {}) ⇒ Array<(AuditSearchResult, Fixnum, Hash)>

Retrieves audits for dialer.

Parameters:

  • body —

    AuditSearch

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :facets_only (BOOLEAN) —

    Facets only

Returns:

  • (Array<(AuditSearchResult, Fixnum, Hash)>) —

    AuditSearchResult data, response status code and response headers



5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 5951

def post_outbound_audits_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_audits ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_audits" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/audits".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'facetsOnly'] = opts[:'facets_only'] if opts[:'facets_only']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuditSearchResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_callabletimesets(body, opts = {}) ⇒ CallableTimeSet

Create callable time set

Parameters:

  • body —

    DialerCallableTimeSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6041
6042
6043
6044
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6041

def post_outbound_callabletimesets(body, opts = {})
  data, _status_code, _headers = post_outbound_callabletimesets_with_http_info(body, opts)
  return data
end

#post_outbound_callabletimesets_with_http_info(body, opts = {}) ⇒ Array<(CallableTimeSet, Fixnum, Hash)>

Create callable time set

Parameters:

  • body —

    DialerCallableTimeSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CallableTimeSet, Fixnum, Hash)>) —

    CallableTimeSet data, response status code and response headers



6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6051

def post_outbound_callabletimesets_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_callabletimesets ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_callabletimesets" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallableTimeSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_callabletimesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_callanalysisresponsesets(body, opts = {}) ⇒ ResponseSet

Create a dialer call analysis response set.

Parameters:

  • body —

    ResponseSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6106
6107
6108
6109
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6106

def post_outbound_callanalysisresponsesets(body, opts = {})
  data, _status_code, _headers = post_outbound_callanalysisresponsesets_with_http_info(body, opts)
  return data
end

#post_outbound_callanalysisresponsesets_with_http_info(body, opts = {}) ⇒ Array<(ResponseSet, Fixnum, Hash)>

Create a dialer call analysis response set.

Parameters:

  • body —

    ResponseSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ResponseSet, Fixnum, Hash)>) —

    ResponseSet data, response status code and response headers



6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6116

def post_outbound_callanalysisresponsesets_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_callanalysisresponsesets ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_callanalysisresponsesets" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_callanalysisresponsesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_campaign_callback_schedule(campaign_id, body, opts = {}) ⇒ ContactCallbackRequest

Schedule a Callback for a Dialer Campaign (Deprecated) This endpoint is deprecated and may have unexpected results. Please use "/conversations/conversationId/participants/participantId/callbacks instead."

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    ContactCallbackRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6172
6173
6174
6175
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6172

def post_outbound_campaign_callback_schedule(campaign_id, body, opts = {})
  data, _status_code, _headers = post_outbound_campaign_callback_schedule_with_http_info(campaign_id, body, opts)
  return data
end

#post_outbound_campaign_callback_schedule_with_http_info(campaign_id, body, opts = {}) ⇒ Array<(ContactCallbackRequest, Fixnum, Hash)>

Schedule a Callback for a Dialer Campaign (Deprecated) This endpoint is deprecated and may have unexpected results. Please use &quot;/conversations/conversationId/participants/participantId/callbacks instead.&quot;

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    ContactCallbackRequest

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ContactCallbackRequest, Fixnum, Hash)>) —

    ContactCallbackRequest data, response status code and response headers



6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6183

def post_outbound_campaign_callback_schedule_with_http_info(campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_campaign_callback_schedule ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.post_outbound_campaign_callback_schedule" if campaign_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_campaign_callback_schedule" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/callback/schedule".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactCallbackRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_campaign_callback_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_campaignrules(body, opts = {}) ⇒ CampaignRule

Create Campaign Rule

Parameters:

  • body —

    CampaignRule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6246
6247
6248
6249
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6246

def post_outbound_campaignrules(body, opts = {})
  data, _status_code, _headers = post_outbound_campaignrules_with_http_info(body, opts)
  return data
end

#post_outbound_campaignrules_with_http_info(body, opts = {}) ⇒ Array<(CampaignRule, Fixnum, Hash)>

Create Campaign Rule

Parameters:

  • body —

    CampaignRule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignRule, Fixnum, Hash)>) —

    CampaignRule data, response status code and response headers



6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6256

def post_outbound_campaignrules_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_campaignrules ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_campaignrules" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_campaignrules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_campaigns(body, opts = {}) ⇒ Campaign

Create a campaign.

Parameters:

  • body —

    Campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6311
6312
6313
6314
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6311

def post_outbound_campaigns(body, opts = {})
  data, _status_code, _headers = post_outbound_campaigns_with_http_info(body, opts)
  return data
end

#post_outbound_campaigns_progress(body, opts = {}) ⇒ Array<CampaignProgress>

Get progress for a list of campaigns

Parameters:

  • body —

    Campaign IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6376
6377
6378
6379
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6376

def post_outbound_campaigns_progress(body, opts = {})
  data, _status_code, _headers = post_outbound_campaigns_progress_with_http_info(body, opts)
  return data
end

#post_outbound_campaigns_progress_with_http_info(body, opts = {}) ⇒ Array<(Array<CampaignProgress>, Fixnum, Hash)>

Get progress for a list of campaigns

Parameters:

  • body —

    Campaign IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<CampaignProgress>, Fixnum, Hash)>) —

    Array<CampaignProgress> data, response status code and response headers



6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6386

def post_outbound_campaigns_progress_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_campaigns_progress ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_campaigns_progress" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/progress".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<CampaignProgress>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_campaigns_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_campaigns_with_http_info(body, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Create a campaign.

Parameters:

  • body —

    Campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Campaign, Fixnum, Hash)>) —

    Campaign data, response status code and response headers



6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6321

def post_outbound_campaigns_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_campaigns ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_campaigns" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_contactlist_clear(contact_list_id, opts = {}) ⇒ nil

Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.

Parameters:

  • contact_list_id —

    Contact List ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


6441
6442
6443
6444
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6441

def post_outbound_contactlist_clear(contact_list_id, opts = {})
  post_outbound_contactlist_clear_with_http_info(contact_list_id, opts)
  return nil
end

#post_outbound_contactlist_clear_with_http_info(contact_list_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.

Parameters:

  • contact_list_id —

    Contact List ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6451

def post_outbound_contactlist_clear_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_clear ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.post_outbound_contactlist_clear" if contact_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/clear".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlist_clear\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_contactlist_contacts(contact_list_id, body, opts = {}) ⇒ Array<DialerContact>

Add contacts to a contact list.

Parameters:

  • contact_list_id —

    Contact List ID

  • body —

    Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :priority (BOOLEAN) —

    Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.

  • :clear_system_data (BOOLEAN) —

    Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won&#39;t.

  • :do_not_queue (BOOLEAN) —

    Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the &#39;priority&#39; parameter.

Returns:



6509
6510
6511
6512
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6509

def post_outbound_contactlist_contacts(contact_list_id, body, opts = {})
  data, _status_code, _headers = post_outbound_contactlist_contacts_with_http_info(contact_list_id, body, opts)
  return data
end

#post_outbound_contactlist_contacts_bulk(contact_list_id, body, opts = {}) ⇒ Array<DialerContact>

Get contacts from a contact list.

Parameters:

  • contact_list_id —

    Contact List ID

  • body —

    ContactIds to get.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6608
6609
6610
6611
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6608

def post_outbound_contactlist_contacts_bulk(contact_list_id, body, opts = {})
  data, _status_code, _headers = post_outbound_contactlist_contacts_bulk_with_http_info(contact_list_id, body, opts)
  return data
end

#post_outbound_contactlist_contacts_bulk_with_http_info(contact_list_id, body, opts = {}) ⇒ Array<(Array<DialerContact>, Fixnum, Hash)>

Get contacts from a contact list.

Parameters:

  • contact_list_id —

    Contact List ID

  • body —

    ContactIds to get.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<DialerContact>, Fixnum, Hash)>) —

    Array<DialerContact> data, response status code and response headers



6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6619

def post_outbound_contactlist_contacts_bulk_with_http_info(contact_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_contacts_bulk ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.post_outbound_contactlist_contacts_bulk" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_contactlist_contacts_bulk" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/bulk".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<DialerContact>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlist_contacts_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_contactlist_contacts_with_http_info(contact_list_id, body, opts = {}) ⇒ Array<(Array<DialerContact>, Fixnum, Hash)>

Add contacts to a contact list.

Parameters:

  • contact_list_id —

    Contact List ID

  • body —

    Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :priority (BOOLEAN) —

    Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.

  • :clear_system_data (BOOLEAN) —

    Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won&#39;t.

  • :do_not_queue (BOOLEAN) —

    Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the &#39;priority&#39; parameter.

Returns:

  • (Array<(Array<DialerContact>, Fixnum, Hash)>) —

    Array<DialerContact> data, response status code and response headers



6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6523

def post_outbound_contactlist_contacts_with_http_info(contact_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_contacts ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.post_outbound_contactlist_contacts" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_contactlist_contacts" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'priority'] = opts[:'priority'] if opts[:'priority']
  query_params[:'clearSystemData'] = opts[:'clear_system_data'] if opts[:'clear_system_data']
  query_params[:'doNotQueue'] = opts[:'do_not_queue'] if opts[:'do_not_queue']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<DialerContact>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlist_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_contactlist_export(contact_list_id, opts = {}) ⇒ DomainEntityRef

Initiate the export of a contact list. Returns 200 if received OK.

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6682
6683
6684
6685
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6682

def post_outbound_contactlist_export(contact_list_id, opts = {})
  data, _status_code, _headers = post_outbound_contactlist_export_with_http_info(contact_list_id, opts)
  return data
end

#post_outbound_contactlist_export_with_http_info(contact_list_id, opts = {}) ⇒ Array<(DomainEntityRef, Fixnum, Hash)>

Initiate the export of a contact list. Returns 200 if received OK.

Parameters:

  • contact_list_id —

    ContactList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DomainEntityRef, Fixnum, Hash)>) —

    DomainEntityRef data, response status code and response headers



6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6692

def post_outbound_contactlist_export_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlist_export ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.post_outbound_contactlist_export" if contact_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/export".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainEntityRef')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_contactlistfilters(body, opts = {}) ⇒ ContactListFilter

Create Contact List Filter

Parameters:

  • body —

    ContactListFilter

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6747
6748
6749
6750
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6747

def post_outbound_contactlistfilters(body, opts = {})
  data, _status_code, _headers = post_outbound_contactlistfilters_with_http_info(body, opts)
  return data
end

#post_outbound_contactlistfilters_preview(body, opts = {}) ⇒ FilterPreviewResponse

Get a preview of the output of a contact list filter

Parameters:

  • body —

    ContactListFilter

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6812
6813
6814
6815
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6812

def post_outbound_contactlistfilters_preview(body, opts = {})
  data, _status_code, _headers = post_outbound_contactlistfilters_preview_with_http_info(body, opts)
  return data
end

#post_outbound_contactlistfilters_preview_with_http_info(body, opts = {}) ⇒ Array<(FilterPreviewResponse, Fixnum, Hash)>

Get a preview of the output of a contact list filter

Parameters:

  • body —

    ContactListFilter

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(FilterPreviewResponse, Fixnum, Hash)>) —

    FilterPreviewResponse data, response status code and response headers



6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6822

def post_outbound_contactlistfilters_preview_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlistfilters_preview ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_contactlistfilters_preview" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlistfilters/preview".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FilterPreviewResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlistfilters_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_contactlistfilters_with_http_info(body, opts = {}) ⇒ Array<(ContactListFilter, Fixnum, Hash)>

Create Contact List Filter

Parameters:

  • body —

    ContactListFilter

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ContactListFilter, Fixnum, Hash)>) —

    ContactListFilter data, response status code and response headers



6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6757

def post_outbound_contactlistfilters_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlistfilters ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_contactlistfilters" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlistfilters".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactListFilter')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlistfilters\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_contactlists(body, opts = {}) ⇒ ContactList

Create a contact List.

Parameters:

  • body —

    ContactList

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



6877
6878
6879
6880
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6877

def post_outbound_contactlists(body, opts = {})
  data, _status_code, _headers = post_outbound_contactlists_with_http_info(body, opts)
  return data
end

#post_outbound_contactlists_with_http_info(body, opts = {}) ⇒ Array<(ContactList, Fixnum, Hash)>

Create a contact List.

Parameters:

  • body —

    ContactList

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ContactList, Fixnum, Hash)>) —

    ContactList data, response status code and response headers



6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6887

def post_outbound_contactlists_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_contactlists ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_contactlists" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_conversation_dnc(conversation_id, opts = {}) ⇒ nil

Add phone numbers to a Dialer DNC list.

Parameters:

  • conversation_id —

    Conversation ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


6942
6943
6944
6945
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6942

def post_outbound_conversation_dnc(conversation_id, opts = {})
  post_outbound_conversation_dnc_with_http_info(conversation_id, opts)
  return nil
end

#post_outbound_conversation_dnc_with_http_info(conversation_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add phone numbers to a Dialer DNC list.

Parameters:

  • conversation_id —

    Conversation ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 6952

def post_outbound_conversation_dnc_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_conversation_dnc ..."
  end
  
  
  # verify the required parameter 'conversation_id' is set
  fail ArgumentError, "Missing the required parameter 'conversation_id' when calling OutboundApi.post_outbound_conversation_dnc" if conversation_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/conversations/{conversationId}/dnc".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_conversation_dnc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_dnclist_export(dnc_list_id, opts = {}) ⇒ DomainEntityRef

Initiate the export of a dnc list. Returns 200 if received OK.

Parameters:

  • dnc_list_id —

    DncList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7006
7007
7008
7009
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7006

def post_outbound_dnclist_export(dnc_list_id, opts = {})
  data, _status_code, _headers = post_outbound_dnclist_export_with_http_info(dnc_list_id, opts)
  return data
end

#post_outbound_dnclist_export_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(DomainEntityRef, Fixnum, Hash)>

Initiate the export of a dnc list. Returns 200 if received OK.

Parameters:

  • dnc_list_id —

    DncList ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DomainEntityRef, Fixnum, Hash)>) —

    DomainEntityRef data, response status code and response headers



7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7016

def post_outbound_dnclist_export_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_dnclist_export ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.post_outbound_dnclist_export" if dnc_list_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/export".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainEntityRef')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_dnclist_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_dnclist_phonenumbers(dnc_list_id, body, opts = {}) ⇒ nil

Add phone numbers to a Dialer DNC list. Only Internal DNC lists may be appended to

Parameters:

  • dnc_list_id —

    DncList ID

  • body —

    DNC Phone Numbers

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


7072
7073
7074
7075
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7072

def post_outbound_dnclist_phonenumbers(dnc_list_id, body, opts = {})
  post_outbound_dnclist_phonenumbers_with_http_info(dnc_list_id, body, opts)
  return nil
end

#post_outbound_dnclist_phonenumbers_with_http_info(dnc_list_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add phone numbers to a Dialer DNC list. Only Internal DNC lists may be appended to

Parameters:

  • dnc_list_id —

    DncList ID

  • body —

    DNC Phone Numbers

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7083

def post_outbound_dnclist_phonenumbers_with_http_info(dnc_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_dnclist_phonenumbers ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.post_outbound_dnclist_phonenumbers" if dnc_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_dnclist_phonenumbers" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}/phonenumbers".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_dnclist_phonenumbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_dnclists(body, opts = {}) ⇒ DncList

Create dialer DNC list

Parameters:

  • body —

    DncList

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7145
7146
7147
7148
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7145

def post_outbound_dnclists(body, opts = {})
  data, _status_code, _headers = post_outbound_dnclists_with_http_info(body, opts)
  return data
end

#post_outbound_dnclists_with_http_info(body, opts = {}) ⇒ Array<(DncList, Fixnum, Hash)>

Create dialer DNC list

Parameters:

  • body —

    DncList

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DncList, Fixnum, Hash)>) —

    DncList data, response status code and response headers



7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7155

def post_outbound_dnclists_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_dnclists ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_dnclists" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DncList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_dnclists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_messagingcampaigns(body, opts = {}) ⇒ MessagingCampaign

Create a Messaging Campaign

Parameters:

  • body —

    Messaging Campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7210
7211
7212
7213
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7210

def post_outbound_messagingcampaigns(body, opts = {})
  data, _status_code, _headers = post_outbound_messagingcampaigns_with_http_info(body, opts)
  return data
end

#post_outbound_messagingcampaigns_progress(body, opts = {}) ⇒ Array<CampaignProgress>

Get progress for a list of messaging campaigns

Parameters:

  • body —

    Messaging Campaign IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7275
7276
7277
7278
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7275

def post_outbound_messagingcampaigns_progress(body, opts = {})
  data, _status_code, _headers = post_outbound_messagingcampaigns_progress_with_http_info(body, opts)
  return data
end

#post_outbound_messagingcampaigns_progress_with_http_info(body, opts = {}) ⇒ Array<(Array<CampaignProgress>, Fixnum, Hash)>

Get progress for a list of messaging campaigns

Parameters:

  • body —

    Messaging Campaign IDs

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<CampaignProgress>, Fixnum, Hash)>) —

    Array<CampaignProgress> data, response status code and response headers



7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7285

def post_outbound_messagingcampaigns_progress_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_messagingcampaigns_progress ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_messagingcampaigns_progress" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/progress".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<CampaignProgress>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_messagingcampaigns_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_messagingcampaigns_with_http_info(body, opts = {}) ⇒ Array<(MessagingCampaign, Fixnum, Hash)>

Create a Messaging Campaign

Parameters:

  • body —

    Messaging Campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MessagingCampaign, Fixnum, Hash)>) —

    MessagingCampaign data, response status code and response headers



7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7220

def post_outbound_messagingcampaigns_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_messagingcampaigns ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_messagingcampaigns" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MessagingCampaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_messagingcampaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_rulesets(body, opts = {}) ⇒ RuleSet

Create a Dialer Call Analysis Response Set.

Parameters:

  • body —

    RuleSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7340
7341
7342
7343
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7340

def post_outbound_rulesets(body, opts = {})
  data, _status_code, _headers = post_outbound_rulesets_with_http_info(body, opts)
  return data
end

#post_outbound_rulesets_with_http_info(body, opts = {}) ⇒ Array<(RuleSet, Fixnum, Hash)>

Create a Dialer Call Analysis Response Set.

Parameters:

  • body —

    RuleSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RuleSet, Fixnum, Hash)>) —

    RuleSet data, response status code and response headers



7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7350

def post_outbound_rulesets_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_rulesets ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_rulesets" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RuleSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_outbound_sequences(body, opts = {}) ⇒ CampaignSequence

Create a new campaign sequence.

Parameters:

  • body —

    Organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7405
7406
7407
7408
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7405

def post_outbound_sequences(body, opts = {})
  data, _status_code, _headers = post_outbound_sequences_with_http_info(body, opts)
  return data
end

#post_outbound_sequences_with_http_info(body, opts = {}) ⇒ Array<(CampaignSequence, Fixnum, Hash)>

Create a new campaign sequence.

Parameters:

  • body —

    Organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignSequence, Fixnum, Hash)>) —

    CampaignSequence data, response status code and response headers



7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7415

def post_outbound_sequences_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.post_outbound_sequences ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.post_outbound_sequences" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignSequence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#post_outbound_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_attemptlimit(attempt_limits_id, body, opts = {}) ⇒ AttemptLimits

Update attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

  • body —

    AttemptLimits

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7471
7472
7473
7474
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7471

def put_outbound_attemptlimit(attempt_limits_id, body, opts = {})
  data, _status_code, _headers = put_outbound_attemptlimit_with_http_info(attempt_limits_id, body, opts)
  return data
end

#put_outbound_attemptlimit_with_http_info(attempt_limits_id, body, opts = {}) ⇒ Array<(AttemptLimits, Fixnum, Hash)>

Update attempt limits

Parameters:

  • attempt_limits_id —

    Attempt limits ID

  • body —

    AttemptLimits

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(AttemptLimits, Fixnum, Hash)>) —

    AttemptLimits data, response status code and response headers



7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7482

def put_outbound_attemptlimit_with_http_info(attempt_limits_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_attemptlimit ..."
  end
  
  
  # verify the required parameter 'attempt_limits_id' is set
  fail ArgumentError, "Missing the required parameter 'attempt_limits_id' when calling OutboundApi.put_outbound_attemptlimit" if attempt_limits_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_attemptlimit" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/attemptlimits/{attemptLimitsId}".sub('{format}','json').sub('{' + 'attemptLimitsId' + '}', attempt_limits_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AttemptLimits')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_attemptlimit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_callabletimeset(callable_time_set_id, body, opts = {}) ⇒ CallableTimeSet

Update callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

  • body —

    DialerCallableTimeSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7546
7547
7548
7549
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7546

def put_outbound_callabletimeset(callable_time_set_id, body, opts = {})
  data, _status_code, _headers = put_outbound_callabletimeset_with_http_info(callable_time_set_id, body, opts)
  return data
end

#put_outbound_callabletimeset_with_http_info(callable_time_set_id, body, opts = {}) ⇒ Array<(CallableTimeSet, Fixnum, Hash)>

Update callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

  • body —

    DialerCallableTimeSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CallableTimeSet, Fixnum, Hash)>) —

    CallableTimeSet data, response status code and response headers



7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7557

def put_outbound_callabletimeset_with_http_info(callable_time_set_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_callabletimeset ..."
  end
  
  
  # verify the required parameter 'callable_time_set_id' is set
  fail ArgumentError, "Missing the required parameter 'callable_time_set_id' when calling OutboundApi.put_outbound_callabletimeset" if callable_time_set_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_callabletimeset" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callabletimesets/{callableTimeSetId}".sub('{format}','json').sub('{' + 'callableTimeSetId' + '}', callable_time_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CallableTimeSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_callabletimeset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_callanalysisresponseset(call_analysis_set_id, body, opts = {}) ⇒ ResponseSet

Update a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

  • body —

    ResponseSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7621
7622
7623
7624
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7621

def put_outbound_callanalysisresponseset(call_analysis_set_id, body, opts = {})
  data, _status_code, _headers = put_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, body, opts)
  return data
end

#put_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, body, opts = {}) ⇒ Array<(ResponseSet, Fixnum, Hash)>

Update a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

  • body —

    ResponseSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ResponseSet, Fixnum, Hash)>) —

    ResponseSet data, response status code and response headers



7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7632

def put_outbound_callanalysisresponseset_with_http_info(call_analysis_set_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_callanalysisresponseset ..."
  end
  
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail ArgumentError, "Missing the required parameter 'call_analysis_set_id' when calling OutboundApi.put_outbound_callanalysisresponseset" if call_analysis_set_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_callanalysisresponseset" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId}".sub('{format}','json').sub('{' + 'callAnalysisSetId' + '}', call_analysis_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResponseSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_callanalysisresponseset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_campaign(campaign_id, body, opts = {}) ⇒ Campaign

Update a campaign.

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    Campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7696
7697
7698
7699
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7696

def put_outbound_campaign(campaign_id, body, opts = {})
  data, _status_code, _headers = put_outbound_campaign_with_http_info(campaign_id, body, opts)
  return data
end

#put_outbound_campaign_agent(campaign_id, user_id, body, opts = {}) ⇒ String

Send notification that an agent’s state changed New agent state.

Parameters:

  • campaign_id —

    Campaign ID

  • user_id —

    Agent&#39;s user ID

  • body —

    agent

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


7772
7773
7774
7775
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7772

def put_outbound_campaign_agent(campaign_id, user_id, body, opts = {})
  data, _status_code, _headers = put_outbound_campaign_agent_with_http_info(campaign_id, user_id, body, opts)
  return data
end

#put_outbound_campaign_agent_with_http_info(campaign_id, user_id, body, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Send notification that an agent&#39;s state changed New agent state.

Parameters:

  • campaign_id —

    Campaign ID

  • user_id —

    Agent&#39;s user ID

  • body —

    agent

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7784

def put_outbound_campaign_agent_with_http_info(campaign_id, user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_campaign_agent ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.put_outbound_campaign_agent" if campaign_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling OutboundApi.put_outbound_campaign_agent" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_campaign_agent" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}/agents/{userId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s).sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_campaign_agent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_campaign_with_http_info(campaign_id, body, opts = {}) ⇒ Array<(Campaign, Fixnum, Hash)>

Update a campaign.

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    Campaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Campaign, Fixnum, Hash)>) —

    Campaign data, response status code and response headers



7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7707

def put_outbound_campaign_with_http_info(campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.put_outbound_campaign" if campaign_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_campaign" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Campaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_campaignrule(campaign_rule_id, body, opts = {}) ⇒ CampaignRule

Update Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

  • body —

    CampaignRule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7856
7857
7858
7859
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7856

def put_outbound_campaignrule(campaign_rule_id, body, opts = {})
  data, _status_code, _headers = put_outbound_campaignrule_with_http_info(campaign_rule_id, body, opts)
  return data
end

#put_outbound_campaignrule_with_http_info(campaign_rule_id, body, opts = {}) ⇒ Array<(CampaignRule, Fixnum, Hash)>

Update Campaign Rule

Parameters:

  • campaign_rule_id —

    Campaign Rule ID

  • body —

    CampaignRule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignRule, Fixnum, Hash)>) —

    CampaignRule data, response status code and response headers



7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7867

def put_outbound_campaignrule_with_http_info(campaign_rule_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_campaignrule ..."
  end
  
  
  # verify the required parameter 'campaign_rule_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_rule_id' when calling OutboundApi.put_outbound_campaignrule" if campaign_rule_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_campaignrule" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/campaignrules/{campaignRuleId}".sub('{format}','json').sub('{' + 'campaignRuleId' + '}', campaign_rule_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignRule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_campaignrule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_contactlist(contact_list_id, body, opts = {}) ⇒ ContactList

Update a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

  • body —

    ContactList

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



7931
7932
7933
7934
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7931

def put_outbound_contactlist(contact_list_id, body, opts = {})
  data, _status_code, _headers = put_outbound_contactlist_with_http_info(contact_list_id, body, opts)
  return data
end

#put_outbound_contactlist_contact(contact_list_id, contact_id, body, opts = {}) ⇒ DialerContact

Update a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

  • body —

    Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8007
8008
8009
8010
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8007

def put_outbound_contactlist_contact(contact_list_id, contact_id, body, opts = {})
  data, _status_code, _headers = put_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, body, opts)
  return data
end

#put_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, body, opts = {}) ⇒ Array<(DialerContact, Fixnum, Hash)>

Update a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

  • body —

    Contact

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DialerContact, Fixnum, Hash)>) —

    DialerContact data, response status code and response headers



8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8019

def put_outbound_contactlist_contact_with_http_info(contact_list_id, contact_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_contactlist_contact ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.put_outbound_contactlist_contact" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'contact_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_id' when calling OutboundApi.put_outbound_contactlist_contact" if contact_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_contactlist_contact" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}/contacts/{contactId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s).sub('{' + 'contactId' + '}', contact_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DialerContact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_contactlist_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_contactlist_with_http_info(contact_list_id, body, opts = {}) ⇒ Array<(ContactList, Fixnum, Hash)>

Update a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

  • body —

    ContactList

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ContactList, Fixnum, Hash)>) —

    ContactList data, response status code and response headers



7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 7942

def put_outbound_contactlist_with_http_info(contact_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_contactlist ..."
  end
  
  
  # verify the required parameter 'contact_list_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_id' when calling OutboundApi.put_outbound_contactlist" if contact_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_contactlist" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlists/{contactListId}".sub('{format}','json').sub('{' + 'contactListId' + '}', contact_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_contactlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_contactlistfilter(contact_list_filter_id, body, opts = {}) ⇒ ContactListFilter

Update Contact List Filter

Parameters:

  • contact_list_filter_id —

    Contact List Filter ID

  • body —

    ContactListFilter

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8091
8092
8093
8094
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8091

def put_outbound_contactlistfilter(contact_list_filter_id, body, opts = {})
  data, _status_code, _headers = put_outbound_contactlistfilter_with_http_info(contact_list_filter_id, body, opts)
  return data
end

#put_outbound_contactlistfilter_with_http_info(contact_list_filter_id, body, opts = {}) ⇒ Array<(ContactListFilter, Fixnum, Hash)>

Update Contact List Filter

Parameters:

  • contact_list_filter_id —

    Contact List Filter ID

  • body —

    ContactListFilter

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ContactListFilter, Fixnum, Hash)>) —

    ContactListFilter data, response status code and response headers



8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8102

def put_outbound_contactlistfilter_with_http_info(contact_list_filter_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_contactlistfilter ..."
  end
  
  
  # verify the required parameter 'contact_list_filter_id' is set
  fail ArgumentError, "Missing the required parameter 'contact_list_filter_id' when calling OutboundApi.put_outbound_contactlistfilter" if contact_list_filter_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_contactlistfilter" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/contactlistfilters/{contactListFilterId}".sub('{format}','json').sub('{' + 'contactListFilterId' + '}', contact_list_filter_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactListFilter')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_contactlistfilter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_dnclist(dnc_list_id, body, opts = {}) ⇒ DncList

Update dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

  • body —

    DncList

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8166
8167
8168
8169
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8166

def put_outbound_dnclist(dnc_list_id, body, opts = {})
  data, _status_code, _headers = put_outbound_dnclist_with_http_info(dnc_list_id, body, opts)
  return data
end

#put_outbound_dnclist_with_http_info(dnc_list_id, body, opts = {}) ⇒ Array<(DncList, Fixnum, Hash)>

Update dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

  • body —

    DncList

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(DncList, Fixnum, Hash)>) —

    DncList data, response status code and response headers



8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8177

def put_outbound_dnclist_with_http_info(dnc_list_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_dnclist ..."
  end
  
  
  # verify the required parameter 'dnc_list_id' is set
  fail ArgumentError, "Missing the required parameter 'dnc_list_id' when calling OutboundApi.put_outbound_dnclist" if dnc_list_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_dnclist" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/dnclists/{dncListId}".sub('{format}','json').sub('{' + 'dncListId' + '}', dnc_list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DncList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_dnclist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_messagingcampaign(messaging_campaign_id, body, opts = {}) ⇒ MessagingCampaign

Update an Outbound Messaging Campaign

Parameters:

  • messaging_campaign_id —

    The Messaging Campaign ID

  • body —

    MessagingCampaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8241
8242
8243
8244
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8241

def put_outbound_messagingcampaign(messaging_campaign_id, body, opts = {})
  data, _status_code, _headers = put_outbound_messagingcampaign_with_http_info(messaging_campaign_id, body, opts)
  return data
end

#put_outbound_messagingcampaign_with_http_info(messaging_campaign_id, body, opts = {}) ⇒ Array<(MessagingCampaign, Fixnum, Hash)>

Update an Outbound Messaging Campaign

Parameters:

  • messaging_campaign_id —

    The Messaging Campaign ID

  • body —

    MessagingCampaign

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(MessagingCampaign, Fixnum, Hash)>) —

    MessagingCampaign data, response status code and response headers



8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8252

def put_outbound_messagingcampaign_with_http_info(messaging_campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_messagingcampaign ..."
  end
  
  
  # verify the required parameter 'messaging_campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'messaging_campaign_id' when calling OutboundApi.put_outbound_messagingcampaign" if messaging_campaign_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_messagingcampaign" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/messagingcampaigns/{messagingCampaignId}".sub('{format}','json').sub('{' + 'messagingCampaignId' + '}', messaging_campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'MessagingCampaign')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_messagingcampaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_ruleset(rule_set_id, body, opts = {}) ⇒ RuleSet

Update a RuleSet.

Parameters:

  • rule_set_id —

    Rule Set ID

  • body —

    RuleSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8316
8317
8318
8319
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8316

def put_outbound_ruleset(rule_set_id, body, opts = {})
  data, _status_code, _headers = put_outbound_ruleset_with_http_info(rule_set_id, body, opts)
  return data
end

#put_outbound_ruleset_with_http_info(rule_set_id, body, opts = {}) ⇒ Array<(RuleSet, Fixnum, Hash)>

Update a RuleSet.

Parameters:

  • rule_set_id —

    Rule Set ID

  • body —

    RuleSet

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RuleSet, Fixnum, Hash)>) —

    RuleSet data, response status code and response headers



8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8327

def put_outbound_ruleset_with_http_info(rule_set_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_ruleset ..."
  end
  
  
  # verify the required parameter 'rule_set_id' is set
  fail ArgumentError, "Missing the required parameter 'rule_set_id' when calling OutboundApi.put_outbound_ruleset" if rule_set_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_ruleset" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/rulesets/{ruleSetId}".sub('{format}','json').sub('{' + 'ruleSetId' + '}', rule_set_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RuleSet')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_ruleset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_schedules_campaign(campaign_id, body, opts = {}) ⇒ CampaignSchedule

Update a new campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    CampaignSchedule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8391
8392
8393
8394
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8391

def put_outbound_schedules_campaign(campaign_id, body, opts = {})
  data, _status_code, _headers = put_outbound_schedules_campaign_with_http_info(campaign_id, body, opts)
  return data
end

#put_outbound_schedules_campaign_with_http_info(campaign_id, body, opts = {}) ⇒ Array<(CampaignSchedule, Fixnum, Hash)>

Update a new campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

  • body —

    CampaignSchedule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignSchedule, Fixnum, Hash)>) —

    CampaignSchedule data, response status code and response headers



8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8402

def put_outbound_schedules_campaign_with_http_info(campaign_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_schedules_campaign ..."
  end
  
  
  # verify the required parameter 'campaign_id' is set
  fail ArgumentError, "Missing the required parameter 'campaign_id' when calling OutboundApi.put_outbound_schedules_campaign" if campaign_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_schedules_campaign" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/campaigns/{campaignId}".sub('{format}','json').sub('{' + 'campaignId' + '}', campaign_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_schedules_sequence(sequence_id, body, opts = {}) ⇒ SequenceSchedule

Update a new sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

  • body —

    SequenceSchedule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8466
8467
8468
8469
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8466

def put_outbound_schedules_sequence(sequence_id, body, opts = {})
  data, _status_code, _headers = put_outbound_schedules_sequence_with_http_info(sequence_id, body, opts)
  return data
end

#put_outbound_schedules_sequence_with_http_info(sequence_id, body, opts = {}) ⇒ Array<(SequenceSchedule, Fixnum, Hash)>

Update a new sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

  • body —

    SequenceSchedule

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SequenceSchedule, Fixnum, Hash)>) —

    SequenceSchedule data, response status code and response headers



8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8477

def put_outbound_schedules_sequence_with_http_info(sequence_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_schedules_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.put_outbound_schedules_sequence" if sequence_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_schedules_sequence" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/schedules/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SequenceSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_sequence(sequence_id, body, opts = {}) ⇒ CampaignSequence

Update a new campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

  • body —

    Organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8541
8542
8543
8544
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8541

def put_outbound_sequence(sequence_id, body, opts = {})
  data, _status_code, _headers = put_outbound_sequence_with_http_info(sequence_id, body, opts)
  return data
end

#put_outbound_sequence_with_http_info(sequence_id, body, opts = {}) ⇒ Array<(CampaignSequence, Fixnum, Hash)>

Update a new campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

  • body —

    Organization

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CampaignSequence, Fixnum, Hash)>) —

    CampaignSequence data, response status code and response headers



8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8552

def put_outbound_sequence_with_http_info(sequence_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_sequence ..."
  end
  
  
  # verify the required parameter 'sequence_id' is set
  fail ArgumentError, "Missing the required parameter 'sequence_id' when calling OutboundApi.put_outbound_sequence" if sequence_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_sequence" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/sequences/{sequenceId}".sub('{format}','json').sub('{' + 'sequenceId' + '}', sequence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CampaignSequence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_outbound_wrapupcodemappings(body, opts = {}) ⇒ WrapUpCodeMapping

Update the Dialer wrap up code mapping.

Parameters:

  • body —

    wrapUpCodeMapping

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



8615
8616
8617
8618
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8615

def put_outbound_wrapupcodemappings(body, opts = {})
  data, _status_code, _headers = put_outbound_wrapupcodemappings_with_http_info(body, opts)
  return data
end

#put_outbound_wrapupcodemappings_with_http_info(body, opts = {}) ⇒ Array<(WrapUpCodeMapping, Fixnum, Hash)>

Update the Dialer wrap up code mapping.

Parameters:

  • body —

    wrapUpCodeMapping

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(WrapUpCodeMapping, Fixnum, Hash)>) —

    WrapUpCodeMapping data, response status code and response headers



8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
 
# File 'lib/purecloudplatformclientv2/api/outbound_api.rb', line 8625

def put_outbound_wrapupcodemappings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi.put_outbound_wrapupcodemappings ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling OutboundApi.put_outbound_wrapupcodemappings" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/outbound/wrapupcodemappings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapUpCodeMapping')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#put_outbound_wrapupcodemappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end