Class: PureCloud::OutboundApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/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.



7
8
9
 
# File 'lib/purecloud/api/outbound_api.rb', line 7

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/outbound_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

#create_audits(opts = {}) ⇒ AuditSearchResult

Retrieves audits for dialer.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (DialerAuditRequest) —

    AuditSearch

  • :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:



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

def create_audits(opts = {})
  data, status_code, headers = create_audits_with_http_info(opts)
  return data
end

#create_audits_with_http_info(opts = {}) ⇒ Array<(AuditSearchResult, Fixnum, Hash)>

Retrieves audits for dialer.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (DialerAuditRequest) —

    AuditSearch

  • :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



36
37
38
39
40
41
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 36

def create_audits_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_audits ..."
  end
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_audits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_callabletimesets(opts = {}) ⇒ CallableTimeSet

Create callable time set

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



171
172
173
174
 
# File 'lib/purecloud/api/outbound_api.rb', line 171

def create_callabletimesets(opts = {})
  data, status_code, headers = create_callabletimesets_with_http_info(opts)
  return data
end

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

Create callable time set

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CallableTimeSet data, response status code and response headers



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
218
219
220
221
222
 
# File 'lib/purecloud/api/outbound_api.rb', line 181

def create_callabletimesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_callabletimesets ..."
  end
  
  # resource path
  path = "/api/v1/outbound/callabletimesets".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_callabletimesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_callanalysisresponsesets(opts = {}) ⇒ ResponseSet

Create a dialer call analysis response set.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



496
497
498
499
 
# File 'lib/purecloud/api/outbound_api.rb', line 496

def create_callanalysisresponsesets(opts = {})
  data, status_code, headers = create_callanalysisresponsesets_with_http_info(opts)
  return data
end

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

Create a dialer call analysis response set.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ResponseSet data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 506

def create_callanalysisresponsesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_callanalysisresponsesets ..."
  end
  
  # resource path
  path = "/api/v1/outbound/callanalysisresponsesets".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_callanalysisresponsesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_campaign_callback_schedule(campaign_id, opts = {}) ⇒ ContactCallbackRequest

Schedule a Callback for a Dialer Campaign

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Options Hash (opts):

Returns:



1148
1149
1150
1151
 
# File 'lib/purecloud/api/outbound_api.rb', line 1148

def create_campaign_callback_schedule(campaign_id, opts = {})
  data, status_code, headers = create_campaign_callback_schedule_with_http_info(campaign_id, opts)
  return data
end

#create_campaign_callback_schedule_with_http_info(campaign_id, opts = {}) ⇒ Array<(ContactCallbackRequest, Fixnum, Hash)>

Schedule a Callback for a Dialer Campaign

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ContactCallbackRequest data, response status code and response headers



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
1203
 
# File 'lib/purecloud/api/outbound_api.rb', line 1159

def create_campaign_callback_schedule_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_campaign_callback_schedule ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling create_campaign_callback_schedule" if campaign_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_campaign_callback_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_campaigns(opts = {}) ⇒ Campaign

Create a campaign.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



836
837
838
839
 
# File 'lib/purecloud/api/outbound_api.rb', line 836

def create_campaigns(opts = {})
  data, status_code, headers = create_campaigns_with_http_info(opts)
  return data
end

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

Create a campaign.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Campaign data, response status code and response headers



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
882
883
884
885
886
887
 
# File 'lib/purecloud/api/outbound_api.rb', line 846

def create_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_campaigns ..."
  end
  
  # resource path
  path = "/api/v1/outbound/campaigns".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_contact_list_contacts(contact_list_id, opts = {}) ⇒ Contact

Add contacts to a contact list.

Parameters:

  • contact_list_id —

    Contact List ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Contact>) —

    Contact

  • :priority (BOOLEAN)

Returns:



1735
1736
1737
1738
 
# File 'lib/purecloud/api/outbound_api.rb', line 1735

def create_contact_list_contacts(contact_list_id, opts = {})
  data, status_code, headers = create_contact_list_contacts_with_http_info(contact_list_id, opts)
  return data
end

#create_contact_list_contacts_with_http_info(contact_list_id, opts = {}) ⇒ Array<(Contact, Fixnum, Hash)>

Add contacts to a contact list.

Parameters:

  • contact_list_id —

    Contact List ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<Contact>) —

    Contact

  • :priority (BOOLEAN)

Returns:

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

    Contact data, response status code and response headers



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
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
 
# File 'lib/purecloud/api/outbound_api.rb', line 1747

def create_contact_list_contacts_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_contact_list_contacts ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling create_contact_list_contacts" if contact_list_id.nil?
  
  # resource path
  path = "/api/v1/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']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Contact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#create_contact_list_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_contact_list_export(contact_list_id, opts = {}) ⇒ String

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:

  • (String) 


1999
2000
2001
2002
 
# File 'lib/purecloud/api/outbound_api.rb', line 1999

def create_contact_list_export(contact_list_id, opts = {})
  data, status_code, headers = create_contact_list_export_with_http_info(contact_list_id, opts)
  return data
end

#create_contact_list_export_with_http_info(contact_list_id, opts = {}) ⇒ Array<(String, 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<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
 
# File 'lib/purecloud/api/outbound_api.rb', line 2009

def create_contact_list_export_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_contact_list_export ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling create_contact_list_export" if contact_list_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_contact_list_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_contactlists(opts = {}) ⇒ ContactList

Create a contact List.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1423
1424
1425
1426
 
# File 'lib/purecloud/api/outbound_api.rb', line 1423

def create_contactlists(opts = {})
  data, status_code, headers = create_contactlists_with_http_info(opts)
  return data
end

#create_contactlists_penetrationrates(opts = {}) ⇒ Array<PenetrationRate>

Get penetration rates for a list of penetration rate identifiers (contact list id and qualifier id)

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



1481
1482
1483
1484
 
# File 'lib/purecloud/api/outbound_api.rb', line 1481

def create_contactlists_penetrationrates(opts = {})
  data, status_code, headers = create_contactlists_penetrationrates_with_http_info(opts)
  return data
end

#create_contactlists_penetrationrates_with_http_info(opts = {}) ⇒ Array<(Array<PenetrationRate>, Fixnum, Hash)>

Get penetration rates for a list of penetration rate identifiers (contact list id and qualifier id)

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Array<PenetrationRate> data, response status code and response headers



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
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
 
# File 'lib/purecloud/api/outbound_api.rb', line 1491

def create_contactlists_penetrationrates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_contactlists_penetrationrates ..."
  end
  
  # resource path
  path = "/api/v1/outbound/contactlists/penetrationrates".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<PenetrationRate>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#create_contactlists_penetrationrates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create a contact List.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ContactList data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 1433

def create_contactlists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_contactlists ..."
  end
  
  # resource path
  path = "/api/v1/outbound/contactlists".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_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) 


2187
2188
2189
2190
 
# File 'lib/purecloud/api/outbound_api.rb', line 2187

def create_conversation_dnc(conversation_id, opts = {})
  create_conversation_dnc_with_http_info(conversation_id, opts)
  return nil
end

#create_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



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
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
 
# File 'lib/purecloud/api/outbound_api.rb', line 2197

def create_conversation_dnc_with_http_info(conversation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_conversation_dnc ..."
  end
  
  # verify the required parameter 'conversation_id' is set
  fail "Missing the required parameter 'conversation_id' when calling create_conversation_dnc" if conversation_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_conversation_dnc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_dnc_list_export(dnc_list_id, opts = {}) ⇒ String

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:

  • (String) 


2590
2591
2592
2593
 
# File 'lib/purecloud/api/outbound_api.rb', line 2590

def create_dnc_list_export(dnc_list_id, opts = {})
  data, status_code, headers = create_dnc_list_export_with_http_info(dnc_list_id, opts)
  return data
end

#create_dnc_list_export_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(String, 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<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 2600

def create_dnc_list_export_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_dnc_list_export ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling create_dnc_list_export" if dnc_list_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_dnc_list_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Add phone numbers to a Dialer DNC list.

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    DNC Phone Numbers

Returns:

  • (nil) 


2713
2714
2715
2716
 
# File 'lib/purecloud/api/outbound_api.rb', line 2713

def create_dnc_list_phonenumbers(dnc_list_id, opts = {})
  create_dnc_list_phonenumbers_with_http_info(dnc_list_id, opts)
  return nil
end

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

Add phone numbers to a Dialer DNC list.

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    DNC Phone Numbers

Returns:

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

    nil, response status code and response headers



2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
 
# File 'lib/purecloud/api/outbound_api.rb', line 2724

def create_dnc_list_phonenumbers_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_dnc_list_phonenumbers ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling create_dnc_list_phonenumbers" if dnc_list_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_dnc_list_phonenumbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_dnclists(opts = {}) ⇒ DncList

Create dialer DNC list

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



2338
2339
2340
2341
 
# File 'lib/purecloud/api/outbound_api.rb', line 2338

def create_dnclists(opts = {})
  data, status_code, headers = create_dnclists_with_http_info(opts)
  return data
end

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

Create dialer DNC list

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DncList data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 2348

def create_dnclists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_dnclists ..."
  end
  
  # resource path
  path = "/api/v1/outbound/dnclists".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_dnclists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_preview_dispositioncall(preview_id, opts = {}) ⇒ String

Disposition preview call

Parameters:

  • preview_id —

    preview ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (String) 


2892
2893
2894
2895
 
# File 'lib/purecloud/api/outbound_api.rb', line 2892

def create_preview_dispositioncall(preview_id, opts = {})
  data, status_code, headers = create_preview_dispositioncall_with_http_info(preview_id, opts)
  return data
end

#create_preview_dispositioncall_with_http_info(preview_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Disposition preview call

Parameters:

  • preview_id —

    preview ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    String data, response status code and response headers



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
 
# File 'lib/purecloud/api/outbound_api.rb', line 2903

def create_preview_dispositioncall_with_http_info(preview_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_preview_dispositioncall ..."
  end
  
  # verify the required parameter 'preview_id' is set
  fail "Missing the required parameter 'preview_id' when calling create_preview_dispositioncall" if preview_id.nil?
  
  # resource path
  path = "/api/v1/outbound/previews/{previewId}/dispositioncall".sub('{format}','json').sub('{' + 'previewId' + '}', preview_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_preview_dispositioncall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_preview_placecall(preview_id, opts = {}) ⇒ DialerCall

place preview call

Parameters:

  • preview_id —

    preview ID

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

    the optional parameters

Options Hash (opts):

Returns:



2955
2956
2957
2958
 
# File 'lib/purecloud/api/outbound_api.rb', line 2955

def create_preview_placecall(preview_id, opts = {})
  data, status_code, headers = create_preview_placecall_with_http_info(preview_id, opts)
  return data
end

#create_preview_placecall_with_http_info(preview_id, opts = {}) ⇒ Array<(DialerCall, Fixnum, Hash)>

place preview call

Parameters:

  • preview_id —

    preview ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DialerCall data, response status code and response headers



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
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
 
# File 'lib/purecloud/api/outbound_api.rb', line 2966

def create_preview_placecall_with_http_info(preview_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_preview_placecall ..."
  end
  
  # verify the required parameter 'preview_id' is set
  fail "Missing the required parameter 'preview_id' when calling create_preview_placecall" if preview_id.nil?
  
  # resource path
  path = "/api/v1/outbound/previews/{previewId}/placecall".sub('{format}','json').sub('{' + 'previewId' + '}', preview_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DialerCall')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#create_preview_placecall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_rulesets(opts = {}) ⇒ RuleSet

Create a Dialer Call Analysis Response Set.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



3099
3100
3101
3102
 
# File 'lib/purecloud/api/outbound_api.rb', line 3099

def create_rulesets(opts = {})
  data, status_code, headers = create_rulesets_with_http_info(opts)
  return data
end

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

Create a Dialer Call Analysis Response Set.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RuleSet data, response status code and response headers



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
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
 
# File 'lib/purecloud/api/outbound_api.rb', line 3109

def create_rulesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_rulesets ..."
  end
  
  # resource path
  path = "/api/v1/outbound/rulesets".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_sequences(opts = {}) ⇒ CampaignSequence

Create a new campaign sequence.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



3906
3907
3908
3909
 
# File 'lib/purecloud/api/outbound_api.rb', line 3906

def create_sequences(opts = {})
  data, status_code, headers = create_sequences_with_http_info(opts)
  return data
end

#create_sequences_with_http_info(opts = {}) ⇒ Array<(CampaignSequence, Fixnum, Hash)>

Create a new campaign sequence.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CampaignSequence data, response status code and response headers



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
3950
3951
3952
3953
3954
3955
3956
3957
 
# File 'lib/purecloud/api/outbound_api.rb', line 3916

def create_sequences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#create_sequences ..."
  end
  
  # resource path
  path = "/api/v1/outbound/sequences".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, 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#create_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_callable_time_set(callable_time_set_id, opts = {}) ⇒ String

Delete callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

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

    the optional parameters

Returns:

  • (String) 


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

def delete_callable_time_set(callable_time_set_id, opts = {})
  data, status_code, headers = delete_callable_time_set_with_http_info(callable_time_set_id, opts)
  return data
end

#delete_callable_time_set_with_http_info(callable_time_set_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

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

    the optional parameters

Returns:

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

    String data, 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
 
# File 'lib/purecloud/api/outbound_api.rb', line 363

def delete_callable_time_set_with_http_info(callable_time_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_callable_time_set ..."
  end
  
  # verify the required parameter 'callable_time_set_id' is set
  fail "Missing the required parameter 'callable_time_set_id' when calling delete_callable_time_set" if callable_time_set_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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#delete_callable_time_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_callanalysisresponsesets_call_analysis_set(call_analysis_set_id, opts = {}) ⇒ String

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:

  • (String) 


678
679
680
681
 
# File 'lib/purecloud/api/outbound_api.rb', line 678

def delete_callanalysisresponsesets_call_analysis_set(call_analysis_set_id, opts = {})
  data, status_code, headers = delete_callanalysisresponsesets_call_analysis_set_with_http_info(call_analysis_set_id, opts)
  return data
end

#delete_callanalysisresponsesets_call_analysis_set_with_http_info(call_analysis_set_id, opts = {}) ⇒ Array<(String, 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<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 688

def delete_callanalysisresponsesets_call_analysis_set_with_http_info(call_analysis_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_callanalysisresponsesets_call_analysis_set ..."
  end
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail "Missing the required parameter 'call_analysis_set_id' when calling delete_callanalysisresponsesets_call_analysis_set" if call_analysis_set_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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#delete_callanalysisresponsesets_call_analysis_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_campaign(campaign_id, opts = {}) ⇒ String

Delete a campaign.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

  • (String) 


1018
1019
1020
1021
 
# File 'lib/purecloud/api/outbound_api.rb', line 1018

def delete_campaign(campaign_id, opts = {})
  data, status_code, headers = delete_campaign_with_http_info(campaign_id, opts)
  return data
end

#delete_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a campaign.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 1028

def delete_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_campaign ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling delete_campaign" if campaign_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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#delete_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_contact_list(contact_list_id, opts = {}) ⇒ String

Delete a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Returns:

  • (String) 


1672
1673
1674
1675
 
# File 'lib/purecloud/api/outbound_api.rb', line 1672

def delete_contact_list(contact_list_id, opts = {})
  data, status_code, headers = delete_contact_list_with_http_info(contact_list_id, opts)
  return data
end

#delete_contact_list_contacts_by_contact_id(contact_list_id, contact_id, opts = {}) ⇒ String

Delete a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

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

    the optional parameters

Returns:

  • (String) 


1934
1935
1936
1937
 
# File 'lib/purecloud/api/outbound_api.rb', line 1934

def delete_contact_list_contacts_by_contact_id(contact_list_id, contact_id, opts = {})
  data, status_code, headers = delete_contact_list_contacts_by_contact_id_with_http_info(contact_list_id, contact_id, opts)
  return data
end

#delete_contact_list_contacts_by_contact_id_with_http_info(contact_list_id, contact_id, opts = {}) ⇒ Array<(String, 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<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



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
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
 
# File 'lib/purecloud/api/outbound_api.rb', line 1945

def delete_contact_list_contacts_by_contact_id_with_http_info(contact_list_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_contact_list_contacts_by_contact_id ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling delete_contact_list_contacts_by_contact_id" if contact_list_id.nil?
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling delete_contact_list_contacts_by_contact_id" if contact_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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#delete_contact_list_contacts_by_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_contact_list_with_http_info(contact_list_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
 
# File 'lib/purecloud/api/outbound_api.rb', line 1682

def delete_contact_list_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_contact_list ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling delete_contact_list" if contact_list_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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#delete_contact_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dnc_list(dnc_list_id, opts = {}) ⇒ String

Delete dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Returns:

  • (String) 


2529
2530
2531
2532
 
# File 'lib/purecloud/api/outbound_api.rb', line 2529

def delete_dnc_list(dnc_list_id, opts = {})
  data, status_code, headers = delete_dnc_list_with_http_info(dnc_list_id, opts)
  return data
end

#delete_dnc_list_with_http_info(dnc_list_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 2539

def delete_dnc_list_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_dnc_list ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling delete_dnc_list" if dnc_list_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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#delete_dnc_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_rule_set(rule_set_id, opts = {}) ⇒ String

Delete a Rule set.

Parameters:

  • rule_set_id —

    Rule Set ID

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

    the optional parameters

Returns:

  • (String) 


3281
3282
3283
3284
 
# File 'lib/purecloud/api/outbound_api.rb', line 3281

def delete_rule_set(rule_set_id, opts = {})
  data, status_code, headers = delete_rule_set_with_http_info(rule_set_id, opts)
  return data
end

#delete_rule_set_with_http_info(rule_set_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a Rule set.

Parameters:

  • rule_set_id —

    Rule Set ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



3291
3292
3293
3294
3295
3296
3297
3298
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 3291

def delete_rule_set_with_http_info(rule_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_rule_set ..."
  end
  
  # verify the required parameter 'rule_set_id' is set
  fail "Missing the required parameter 'rule_set_id' when calling delete_rule_set" if rule_set_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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#delete_rule_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_schedules_campaign(campaign_id, opts = {}) ⇒ String

Delete a dialer campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

  • (String) 


3522
3523
3524
3525
 
# File 'lib/purecloud/api/outbound_api.rb', line 3522

def delete_schedules_campaign(campaign_id, opts = {})
  data, status_code, headers = delete_schedules_campaign_with_http_info(campaign_id, opts)
  return data
end

#delete_schedules_campaign_with_http_info(campaign_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a dialer campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
 
# File 'lib/purecloud/api/outbound_api.rb', line 3532

def delete_schedules_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_schedules_campaign ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling delete_schedules_campaign" if campaign_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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#delete_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_schedules_sequence(sequence_id, opts = {}) ⇒ String

Delete a dialer sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

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

    the optional parameters

Returns:

  • (String) 


3763
3764
3765
3766
 
# File 'lib/purecloud/api/outbound_api.rb', line 3763

def delete_schedules_sequence(sequence_id, opts = {})
  data, status_code, headers = delete_schedules_sequence_with_http_info(sequence_id, opts)
  return data
end

#delete_schedules_sequence_with_http_info(sequence_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a dialer sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
 
# File 'lib/purecloud/api/outbound_api.rb', line 3773

def delete_schedules_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_schedules_sequence ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling delete_schedules_sequence" if sequence_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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#delete_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_sequence(sequence_id, opts = {}) ⇒ String

Delete a dialer campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

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

    the optional parameters

Returns:

  • (String) 


4088
4089
4090
4091
 
# File 'lib/purecloud/api/outbound_api.rb', line 4088

def delete_sequence(sequence_id, opts = {})
  data, status_code, headers = delete_sequence_with_http_info(sequence_id, opts)
  return data
end

#delete_sequence_with_http_info(sequence_id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Delete a dialer campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 4098

def delete_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#delete_sequence ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling delete_sequence" if sequence_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:DELETE, 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#delete_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_callable_time_set(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:



229
230
231
232
 
# File 'lib/purecloud/api/outbound_api.rb', line 229

def get_callable_time_set(callable_time_set_id, opts = {})
  data, status_code, headers = get_callable_time_set_with_http_info(callable_time_set_id, opts)
  return data
end

#get_callable_time_set_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



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
283
 
# File 'lib/purecloud/api/outbound_api.rb', line 239

def get_callable_time_set_with_http_info(callable_time_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_callable_time_set ..."
  end
  
  # verify the required parameter 'callable_time_set_id' is set
  fail "Missing the required parameter 'callable_time_set_id' when calling get_callable_time_set" if callable_time_set_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_callable_time_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_callabletimesets(opts = {}) ⇒ CallableTimeSetEntityListing

Query callable time set list

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

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



94
95
96
97
 
# File 'lib/purecloud/api/outbound_api.rb', line 94

def get_callabletimesets(opts = {})
  data, status_code, headers = get_callabletimesets_with_http_info(opts)
  return data
end

#get_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

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



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
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/purecloud/api/outbound_api.rb', line 109

def get_callabletimesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_callabletimesets ..."
  end
  
  if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
    fail '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 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  path = "/api/v1/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[:'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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_callabletimesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_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

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



419
420
421
422
 
# File 'lib/purecloud/api/outbound_api.rb', line 419

def get_callanalysisresponsesets(opts = {})
  data, status_code, headers = get_callanalysisresponsesets_with_http_info(opts)
  return data
end

#get_callanalysisresponsesets_call_analysis_set(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:



554
555
556
557
 
# File 'lib/purecloud/api/outbound_api.rb', line 554

def get_callanalysisresponsesets_call_analysis_set(call_analysis_set_id, opts = {})
  data, status_code, headers = get_callanalysisresponsesets_call_analysis_set_with_http_info(call_analysis_set_id, opts)
  return data
end

#get_callanalysisresponsesets_call_analysis_set_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



564
565
566
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 564

def get_callanalysisresponsesets_call_analysis_set_with_http_info(call_analysis_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_callanalysisresponsesets_call_analysis_set ..."
  end
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail "Missing the required parameter 'call_analysis_set_id' when calling get_callanalysisresponsesets_call_analysis_set" if call_analysis_set_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_callanalysisresponsesets_call_analysis_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_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

  • :page_number (Integer) —

    Page number

  • :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



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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/purecloud/api/outbound_api.rb', line 434

def get_callanalysisresponsesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_callanalysisresponsesets ..."
  end
  
  if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
    fail '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 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  path = "/api/v1/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[:'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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_callanalysisresponsesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get dialer campaign.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:



894
895
896
897
 
# File 'lib/purecloud/api/outbound_api.rb', line 894

def get_campaign(campaign_id, opts = {})
  data, status_code, headers = get_campaign_with_http_info(campaign_id, opts)
  return data
end

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

Get campaign diagnostics

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:



1210
1211
1212
1213
 
# File 'lib/purecloud/api/outbound_api.rb', line 1210

def get_campaign_diagnostics(campaign_id, opts = {})
  data, status_code, headers = get_campaign_diagnostics_with_http_info(campaign_id, opts)
  return data
end

#get_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



1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 1220

def get_campaign_diagnostics_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaign_diagnostics ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling get_campaign_diagnostics" if campaign_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_campaign_diagnostics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_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:



1271
1272
1273
1274
 
# File 'lib/purecloud/api/outbound_api.rb', line 1271

def get_campaign_stats(campaign_id, opts = {})
  data, status_code, headers = get_campaign_stats_with_http_info(campaign_id, opts)
  return data
end

#get_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



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 1281

def get_campaign_stats_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaign_stats ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling get_campaign_stats" if campaign_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_campaign_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_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



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
946
947
948
 
# File 'lib/purecloud/api/outbound_api.rb', line 904

def get_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaign ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling get_campaign" if campaign_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_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

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :contact_list_id (String) —

    Contact List ID

  • :dnc_list_id (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

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



749
750
751
752
 
# File 'lib/purecloud/api/outbound_api.rb', line 749

def get_campaigns(opts = {})
  data, status_code, headers = get_campaigns_with_http_info(opts)
  return data
end

#get_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

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :contact_list_id (String) —

    Contact List ID

  • :dnc_list_id (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

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    CampaignEntityListing data, 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
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/purecloud/api/outbound_api.rb', line 769

def get_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_campaigns ..."
  end
  
  if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
    fail '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 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  path = "/api/v1/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[:'contactListId'] = opts[:'contact_list_id'] if opts[:'contact_list_id']
  query_params[:'dncListId'] = opts[:'dnc_list_id'] if opts[:'dnc_list_id']
  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[:'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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get dialer contactList.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status

  • :import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

Returns:



1542
1543
1544
1545
 
# File 'lib/purecloud/api/outbound_api.rb', line 1542

def get_contact_list(contact_list_id, opts = {})
  data, status_code, headers = get_contact_list_with_http_info(contact_list_id, opts)
  return data
end

#get_contact_list_by_campaign_id_penetrationrate(contact_list_id, campaign_id, opts = {}) ⇒ PenetrationRate

Get Dialer campaign&#39;s penetration rate Get dialer campaign&#39;s penetration rate.

Parameters:

  • contact_list_id —

    ContactList ID

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:



2122
2123
2124
2125
 
# File 'lib/purecloud/api/outbound_api.rb', line 2122

def get_contact_list_by_campaign_id_penetrationrate(contact_list_id, campaign_id, opts = {})
  data, status_code, headers = get_contact_list_by_campaign_id_penetrationrate_with_http_info(contact_list_id, campaign_id, opts)
  return data
end

#get_contact_list_by_campaign_id_penetrationrate_with_http_info(contact_list_id, campaign_id, opts = {}) ⇒ Array<(PenetrationRate, Fixnum, Hash)>

Get Dialer campaign&#39;s penetration rate Get dialer campaign&#39;s penetration rate.

Parameters:

  • contact_list_id —

    ContactList ID

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:

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

    PenetrationRate data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 2133

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#get_contact_list_contacts_by_contact_id(contact_list_id, contact_id, opts = {}) ⇒ Contact

Get dialer contactList.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

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

    the optional parameters

Returns:



1800
1801
1802
1803
 
# File 'lib/purecloud/api/outbound_api.rb', line 1800

def get_contact_list_contacts_by_contact_id(contact_list_id, contact_id, opts = {})
  data, status_code, headers = get_contact_list_contacts_by_contact_id_with_http_info(contact_list_id, contact_id, opts)
  return data
end

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

Get dialer contactList.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

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

    the optional parameters

Returns:

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

    Contact data, response status code and response headers



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
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
 
# File 'lib/purecloud/api/outbound_api.rb', line 1811

def get_contact_list_contacts_by_contact_id_with_http_info(contact_list_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_contact_list_contacts_by_contact_id ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling get_contact_list_contacts_by_contact_id" if contact_list_id.nil?
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling get_contact_list_contacts_by_contact_id" if contact_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#get_contact_list_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:



2060
2061
2062
2063
 
# File 'lib/purecloud/api/outbound_api.rb', line 2060

def get_contact_list_importstatus(contact_list_id, opts = {})
  data, status_code, headers = get_contact_list_importstatus_with_http_info(contact_list_id, opts)
  return data
end

#get_contact_list_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



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
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
 
# File 'lib/purecloud/api/outbound_api.rb', line 2070

def get_contact_list_importstatus_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_contact_list_importstatus ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling get_contact_list_importstatus" if contact_list_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_contact_list_importstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get dialer contactList.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status

  • :import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

Returns:

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

    ContactList data, response status code and response headers



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
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'lib/purecloud/api/outbound_api.rb', line 1555

def get_contact_list_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_contact_list ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling get_contact_list" if contact_list_id.nil?
  
  # resource path
  path = "/api/v1/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[:'importStatus'] = opts[:'import_status'] if opts[:'import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_contact_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_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

  • :import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



1340
1341
1342
1343
 
# File 'lib/purecloud/api/outbound_api.rb', line 1340

def get_contactlists(opts = {})
  data, status_code, headers = get_contactlists_with_http_info(opts)
  return data
end

#get_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

  • :import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    ContactListEntityListing data, response status code and response headers



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
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
 
# File 'lib/purecloud/api/outbound_api.rb', line 1358

def get_contactlists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_contactlists ..."
  end
  
  if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
    fail '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 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  path = "/api/v1/outbound/contactlists".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'importStatus'] = opts[:'import_status'] if opts[:'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[:'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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_contactlists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dnc_list(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

  • :import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

Returns:



2399
2400
2401
2402
 
# File 'lib/purecloud/api/outbound_api.rb', line 2399

def get_dnc_list(dnc_list_id, opts = {})
  data, status_code, headers = get_dnc_list_with_http_info(dnc_list_id, opts)
  return data
end

#get_dnc_list_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:



2651
2652
2653
2654
 
# File 'lib/purecloud/api/outbound_api.rb', line 2651

def get_dnc_list_importstatus(dnc_list_id, opts = {})
  data, status_code, headers = get_dnc_list_importstatus_with_http_info(dnc_list_id, opts)
  return data
end

#get_dnc_list_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



2661
2662
2663
2664
2665
2666
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 2661

def get_dnc_list_importstatus_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_dnc_list_importstatus ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling get_dnc_list_importstatus" if dnc_list_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_dnc_list_importstatus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dnc_list_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

  • :import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

Returns:

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

    DncList data, response status code and response headers



2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 2412

def get_dnc_list_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_dnc_list ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling get_dnc_list" if dnc_list_id.nil?
  
  # resource path
  path = "/api/v1/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[:'importStatus'] = opts[:'import_status'] if opts[:'import_status']
  query_params[:'includeSize'] = opts[:'include_size'] if opts[:'include_size']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_dnc_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dnclists(opts = {}) ⇒ DncListEntityListing

Query dialer DNC lists

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include_import_status (BOOLEAN) —

    Import status

  • :import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



2255
2256
2257
2258
 
# File 'lib/purecloud/api/outbound_api.rb', line 2255

def get_dnclists(opts = {})
  data, status_code, headers = get_dnclists_with_http_info(opts)
  return data
end

#get_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

  • :import_status (BOOLEAN) —

    Import status

  • :include_size (BOOLEAN) —

    Include size

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    DncListEntityListing data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 2273

def get_dnclists_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_dnclists ..."
  end
  
  if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
    fail '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 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  path = "/api/v1/outbound/dnclists".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'includeImportStatus'] = opts[:'include_import_status'] if opts[:'include_import_status']
  query_params[:'importStatus'] = opts[:'import_status'] if opts[:'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[:'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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_dnclists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_preview(preview_id, opts = {}) ⇒ Preview

Get dialer preview

Parameters:

  • preview_id —

    preview ID

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

    the optional parameters

Returns:



2830
2831
2832
2833
 
# File 'lib/purecloud/api/outbound_api.rb', line 2830

def get_preview(preview_id, opts = {})
  data, status_code, headers = get_preview_with_http_info(preview_id, opts)
  return data
end

#get_preview_with_http_info(preview_id, opts = {}) ⇒ Array<(Preview, Fixnum, Hash)>

Get dialer preview

Parameters:

  • preview_id —

    preview ID

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

    the optional parameters

Returns:

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

    Preview data, response status code and response headers



2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
 
# File 'lib/purecloud/api/outbound_api.rb', line 2840

def get_preview_with_http_info(preview_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_preview ..."
  end
  
  # verify the required parameter 'preview_id' is set
  fail "Missing the required parameter 'preview_id' when calling get_preview" if preview_id.nil?
  
  # resource path
  path = "/api/v1/outbound/previews/{previewId}".sub('{format}','json').sub('{' + 'previewId' + '}', preview_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

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

#get_previews(opts = {}) ⇒ Array<Preview>

Get dialer preview for user

Parameters:

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

    the optional parameters

Returns:



2773
2774
2775
2776
 
# File 'lib/purecloud/api/outbound_api.rb', line 2773

def get_previews(opts = {})
  data, status_code, headers = get_previews_with_http_info(opts)
  return data
end

#get_previews_with_http_info(opts = {}) ⇒ Array<(Array<Preview>, Fixnum, Hash)>

Get dialer preview for user

Parameters:

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

    the optional parameters

Returns:

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

    Array<Preview> data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 2782

def get_previews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_previews ..."
  end
  
  # resource path
  path = "/api/v1/outbound/previews".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Preview>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#get_previews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_rule_set(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:



3157
3158
3159
3160
 
# File 'lib/purecloud/api/outbound_api.rb', line 3157

def get_rule_set(rule_set_id, opts = {})
  data, status_code, headers = get_rule_set_with_http_info(rule_set_id, opts)
  return data
end

#get_rule_set_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



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
3204
3205
3206
3207
3208
3209
3210
3211
 
# File 'lib/purecloud/api/outbound_api.rb', line 3167

def get_rule_set_with_http_info(rule_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_rule_set ..."
  end
  
  # verify the required parameter 'rule_set_id' is set
  fail "Missing the required parameter 'rule_set_id' when calling get_rule_set" if rule_set_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_rule_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_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

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



3022
3023
3024
3025
 
# File 'lib/purecloud/api/outbound_api.rb', line 3022

def get_rulesets(opts = {})
  data, status_code, headers = get_rulesets_with_http_info(opts)
  return data
end

#get_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

  • :page_number (Integer) —

    Page number

  • :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



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
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
 
# File 'lib/purecloud/api/outbound_api.rb', line 3037

def get_rulesets_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_rulesets ..."
  end
  
  if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
    fail '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 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  path = "/api/v1/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[:'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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_rulesets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a dialer campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Returns:



3398
3399
3400
3401
 
# File 'lib/purecloud/api/outbound_api.rb', line 3398

def get_schedules_campaign(campaign_id, opts = {})
  data, status_code, headers = get_schedules_campaign_with_http_info(campaign_id, opts)
  return data
end

#get_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



3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
 
# File 'lib/purecloud/api/outbound_api.rb', line 3408

def get_schedules_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_campaign ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling get_schedules_campaign" if campaign_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Query for a list of dialer campaign schedules.

Parameters:

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

    the optional parameters

Returns:



3341
3342
3343
3344
 
# File 'lib/purecloud/api/outbound_api.rb', line 3341

def get_schedules_campaigns(opts = {})
  data, status_code, headers = get_schedules_campaigns_with_http_info(opts)
  return data
end

#get_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



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 3350

def get_schedules_campaigns_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_campaigns ..."
  end
  
  # resource path
  path = "/api/v1/outbound/schedules/campaigns".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_schedules_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schedules_sequence(sequence_id, opts = {}) ⇒ SequenceSchedule

Get a dialer sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

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

    the optional parameters

Returns:



3639
3640
3641
3642
 
# File 'lib/purecloud/api/outbound_api.rb', line 3639

def get_schedules_sequence(sequence_id, opts = {})
  data, status_code, headers = get_schedules_sequence_with_http_info(sequence_id, opts)
  return data
end

#get_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



3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
 
# File 'lib/purecloud/api/outbound_api.rb', line 3649

def get_schedules_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_sequence ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling get_schedules_sequence" if sequence_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_schedules_sequences(opts = {}) ⇒ Array<SequenceSchedule>

Query for a list of dialer sequence schedules.

Parameters:

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

    the optional parameters

Returns:



3582
3583
3584
3585
 
# File 'lib/purecloud/api/outbound_api.rb', line 3582

def get_schedules_sequences(opts = {})
  data, status_code, headers = get_schedules_sequences_with_http_info(opts)
  return data
end

#get_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



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 3591

def get_schedules_sequences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_schedules_sequences ..."
  end
  
  # resource path
  path = "/api/v1/outbound/schedules/sequences".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_schedules_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_sequence(sequence_id, opts = {}) ⇒ CampaignSequence

Get a dialer campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

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

    the optional parameters

Returns:



3964
3965
3966
3967
 
# File 'lib/purecloud/api/outbound_api.rb', line 3964

def get_sequence(sequence_id, opts = {})
  data, status_code, headers = get_sequence_with_http_info(sequence_id, opts)
  return data
end

#get_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



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
4015
4016
4017
4018
 
# File 'lib/purecloud/api/outbound_api.rb', line 3974

def get_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_sequence ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling get_sequence" if sequence_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_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

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



3829
3830
3831
3832
 
# File 'lib/purecloud/api/outbound_api.rb', line 3829

def get_sequences(opts = {})
  data, status_code, headers = get_sequences_with_http_info(opts)
  return data
end

#get_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

  • :page_number (Integer) —

    Page number

  • :filter_type (String) —

    Filter type

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:



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
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
 
# File 'lib/purecloud/api/outbound_api.rb', line 3844

def get_sequences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_sequences ..."
  end
  
  if opts[:'filter_type'] && !['EQUALS', 'REGEX', 'CONTAINS', 'PREFIX', 'LESSTHAN', 'LESSTHANEQUALTO', 'GREATERTHAN', 'GREATERTHANEQUALTO', 'BEGINSWITH', 'ENDSWITH'].include?(opts[:'filter_type'])
    fail '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 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  # resource path
  path = "/api/v1/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[:'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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_sequences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_wrapupcodemappings(opts = {}) ⇒ WrapUpCodeMapping

Get the Dialer wrap up code mapping.

Parameters:

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

    the optional parameters

Returns:



4148
4149
4150
4151
 
# File 'lib/purecloud/api/outbound_api.rb', line 4148

def get_wrapupcodemappings(opts = {})
  data, status_code, headers = get_wrapupcodemappings_with_http_info(opts)
  return data
end

#get_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



4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
 
# File 'lib/purecloud/api/outbound_api.rb', line 4157

def get_wrapupcodemappings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#get_wrapupcodemappings ..."
  end
  
  # resource path
  path = "/api/v1/outbound/wrapupcodemappings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:GET, 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_wrapupcodemappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

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

    the optional parameters

Options Hash (opts):

Returns:



291
292
293
294
 
# File 'lib/purecloud/api/outbound_api.rb', line 291

def update_callable_time_set(callable_time_set_id, opts = {})
  data, status_code, headers = update_callable_time_set_with_http_info(callable_time_set_id, opts)
  return data
end

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

Update callable time set

Parameters:

  • callable_time_set_id —

    Callable Time Set ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CallableTimeSet data, response status code and response headers



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/purecloud/api/outbound_api.rb', line 302

def update_callable_time_set_with_http_info(callable_time_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_callable_time_set ..."
  end
  
  # verify the required parameter 'callable_time_set_id' is set
  fail "Missing the required parameter 'callable_time_set_id' when calling update_callable_time_set" if callable_time_set_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_callable_time_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

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

    the optional parameters

Options Hash (opts):

Returns:



616
617
618
619
 
# File 'lib/purecloud/api/outbound_api.rb', line 616

def update_callanalysisresponsesets_call_analysis_set(call_analysis_set_id, opts = {})
  data, status_code, headers = update_callanalysisresponsesets_call_analysis_set_with_http_info(call_analysis_set_id, opts)
  return data
end

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

Update a dialer call analysis response set.

Parameters:

  • call_analysis_set_id —

    Call Analysis Response Set ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ResponseSet data, response status code and response headers



627
628
629
630
631
632
633
634
635
636
637
638
639
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 627

def update_callanalysisresponsesets_call_analysis_set_with_http_info(call_analysis_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_callanalysisresponsesets_call_analysis_set ..."
  end
  
  # verify the required parameter 'call_analysis_set_id' is set
  fail "Missing the required parameter 'call_analysis_set_id' when calling update_callanalysisresponsesets_call_analysis_set" if call_analysis_set_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_callanalysisresponsesets_call_analysis_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a campaign.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Options Hash (opts):

Returns:



956
957
958
959
 
# File 'lib/purecloud/api/outbound_api.rb', line 956

def update_campaign(campaign_id, opts = {})
  data, status_code, headers = update_campaign_with_http_info(campaign_id, opts)
  return data
end

#update_campaign_agents_by_user_id(campaign_id, user_id, opts = {}) ⇒ String

Send notification that an agent&#39;s state changed New agent state.

Parameters:

  • campaign_id —

    Campaign ID

  • user_id —

    Agent&#39;s user ID

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

    the optional parameters

Options Hash (opts):

  • :body (Agent) —

    agent

Returns:

  • (String) 


1081
1082
1083
1084
 
# File 'lib/purecloud/api/outbound_api.rb', line 1081

def update_campaign_agents_by_user_id(campaign_id, user_id, opts = {})
  data, status_code, headers = update_campaign_agents_by_user_id_with_http_info(campaign_id, user_id, opts)
  return data
end

#update_campaign_agents_by_user_id_with_http_info(campaign_id, user_id, 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

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

    the optional parameters

Options Hash (opts):

  • :body (Agent) —

    agent

Returns:

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

    String data, response status code and response headers



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
1138
1139
1140
 
# File 'lib/purecloud/api/outbound_api.rb', line 1093

def update_campaign_agents_by_user_id_with_http_info(campaign_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_campaign_agents_by_user_id ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling update_campaign_agents_by_user_id" if campaign_id.nil?
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling update_campaign_agents_by_user_id" if user_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_campaign_agents_by_user_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a campaign.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Campaign data, response status code and response headers



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
1010
1011
 
# File 'lib/purecloud/api/outbound_api.rb', line 967

def update_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_campaign ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling update_campaign" if campaign_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Options Hash (opts):

Returns:



1610
1611
1612
1613
 
# File 'lib/purecloud/api/outbound_api.rb', line 1610

def update_contact_list(contact_list_id, opts = {})
  data, status_code, headers = update_contact_list_with_http_info(contact_list_id, opts)
  return data
end

#update_contact_list_contacts_by_contact_id(contact_list_id, contact_id, opts = {}) ⇒ Contact

Update a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

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

    the optional parameters

Options Hash (opts):

Returns:



1867
1868
1869
1870
 
# File 'lib/purecloud/api/outbound_api.rb', line 1867

def update_contact_list_contacts_by_contact_id(contact_list_id, contact_id, opts = {})
  data, status_code, headers = update_contact_list_contacts_by_contact_id_with_http_info(contact_list_id, contact_id, opts)
  return data
end

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

Update a contact.

Parameters:

  • contact_list_id —

    Contact List ID

  • contact_id —

    Contact ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Contact data, response status code and response headers



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
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
 
# File 'lib/purecloud/api/outbound_api.rb', line 1879

def update_contact_list_contacts_by_contact_id_with_http_info(contact_list_id, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_contact_list_contacts_by_contact_id ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling update_contact_list_contacts_by_contact_id" if contact_list_id.nil?
  
  # verify the required parameter 'contact_id' is set
  fail "Missing the required parameter 'contact_id' when calling update_contact_list_contacts_by_contact_id" if contact_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Contact')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OutboundApi#update_contact_list_contacts_by_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a contact list.

Parameters:

  • contact_list_id —

    ContactList ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ContactList data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 1621

def update_contact_list_with_http_info(contact_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_contact_list ..."
  end
  
  # verify the required parameter 'contact_list_id' is set
  fail "Missing the required parameter 'contact_list_id' when calling update_contact_list" if contact_list_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_contact_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Options Hash (opts):

Returns:



2467
2468
2469
2470
 
# File 'lib/purecloud/api/outbound_api.rb', line 2467

def update_dnc_list(dnc_list_id, opts = {})
  data, status_code, headers = update_dnc_list_with_http_info(dnc_list_id, opts)
  return data
end

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

Update dialer DNC list

Parameters:

  • dnc_list_id —

    DncList ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    DncList data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 2478

def update_dnc_list_with_http_info(dnc_list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_dnc_list ..."
  end
  
  # verify the required parameter 'dnc_list_id' is set
  fail "Missing the required parameter 'dnc_list_id' when calling update_dnc_list" if dnc_list_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_dnc_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a RuleSet.

Parameters:

  • rule_set_id —

    Rule Set ID

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

    the optional parameters

Options Hash (opts):

Returns:



3219
3220
3221
3222
 
# File 'lib/purecloud/api/outbound_api.rb', line 3219

def update_rule_set(rule_set_id, opts = {})
  data, status_code, headers = update_rule_set_with_http_info(rule_set_id, opts)
  return data
end

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

Update a RuleSet.

Parameters:

  • rule_set_id —

    Rule Set ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    RuleSet data, response status code and response headers



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
3269
3270
3271
3272
3273
3274
 
# File 'lib/purecloud/api/outbound_api.rb', line 3230

def update_rule_set_with_http_info(rule_set_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_rule_set ..."
  end
  
  # verify the required parameter 'rule_set_id' is set
  fail "Missing the required parameter 'rule_set_id' when calling update_rule_set" if rule_set_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_rule_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update a new campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Options Hash (opts):

Returns:



3460
3461
3462
3463
 
# File 'lib/purecloud/api/outbound_api.rb', line 3460

def update_schedules_campaign(campaign_id, opts = {})
  data, status_code, headers = update_schedules_campaign_with_http_info(campaign_id, opts)
  return data
end

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

Update a new campaign schedule.

Parameters:

  • campaign_id —

    Campaign ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CampaignSchedule data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 3471

def update_schedules_campaign_with_http_info(campaign_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_schedules_campaign ..."
  end
  
  # verify the required parameter 'campaign_id' is set
  fail "Missing the required parameter 'campaign_id' when calling update_schedules_campaign" if campaign_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_schedules_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_schedules_sequence(sequence_id, opts = {}) ⇒ SequenceSchedule

Update a new sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

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

    the optional parameters

Options Hash (opts):

Returns:



3701
3702
3703
3704
 
# File 'lib/purecloud/api/outbound_api.rb', line 3701

def update_schedules_sequence(sequence_id, opts = {})
  data, status_code, headers = update_schedules_sequence_with_http_info(sequence_id, opts)
  return data
end

#update_schedules_sequence_with_http_info(sequence_id, opts = {}) ⇒ Array<(SequenceSchedule, Fixnum, Hash)>

Update a new sequence schedule.

Parameters:

  • sequence_id —

    Sequence ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    SequenceSchedule data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 3712

def update_schedules_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_schedules_sequence ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling update_schedules_sequence" if sequence_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_schedules_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_sequence(sequence_id, opts = {}) ⇒ CampaignSequence

Update a new campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

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

    the optional parameters

Options Hash (opts):

Returns:



4026
4027
4028
4029
 
# File 'lib/purecloud/api/outbound_api.rb', line 4026

def update_sequence(sequence_id, opts = {})
  data, status_code, headers = update_sequence_with_http_info(sequence_id, opts)
  return data
end

#update_sequence_with_http_info(sequence_id, opts = {}) ⇒ Array<(CampaignSequence, Fixnum, Hash)>

Update a new campaign sequence.

Parameters:

  • sequence_id —

    Campaign Sequence ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CampaignSequence data, response status code and response headers



4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
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
 
# File 'lib/purecloud/api/outbound_api.rb', line 4037

def update_sequence_with_http_info(sequence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_sequence ..."
  end
  
  # verify the required parameter 'sequence_id' is set
  fail "Missing the required parameter 'sequence_id' when calling update_sequence" if sequence_id.nil?
  
  # resource path
  path = "/api/v1/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)
  _header_accept = ['application/json']
  _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_sequence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_wrapupcodemappings(opts = {}) ⇒ WrapUpCodeMapping

Update the Dialer wrap up code mapping.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



4205
4206
4207
4208
 
# File 'lib/purecloud/api/outbound_api.rb', line 4205

def update_wrapupcodemappings(opts = {})
  data, status_code, headers = update_wrapupcodemappings_with_http_info(opts)
  return data
end

#update_wrapupcodemappings_with_http_info(opts = {}) ⇒ Array<(WrapUpCodeMapping, Fixnum, Hash)>

Update the Dialer wrap up code mapping.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    WrapUpCodeMapping data, response status code and response headers



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
 
# File 'lib/purecloud/api/outbound_api.rb', line 4215

def update_wrapupcodemappings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: OutboundApi#update_wrapupcodemappings ..."
  end
  
  # resource path
  path = "/api/v1/outbound/wrapupcodemappings".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, 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#update_wrapupcodemappings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end