purecloudplatformclientv2 27.1.0 → 28.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AdditionalMessage.md +13 -0
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/ArchitectApi.md +40 -28
- data/docs/Attachment.md +5 -5
- data/docs/ConversationNotificationAttachment.md +18 -0
- data/docs/ConversationNotificationDraftAttachments.md +18 -0
- data/docs/ConversationNotificationEmail.md +1 -0
- data/docs/ConversationNotificationEmails.md +1 -0
- data/docs/ConversationsApi.md +964 -198
- data/docs/DataTable.md +17 -0
- data/docs/DataTableRowEntityListing.md +22 -0
- data/docs/DataTablesDomainEntityListing.md +22 -0
- data/docs/Document.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/Email.md +1 -0
- data/docs/EmailConversationNotificationAttachment.md +18 -0
- data/docs/EmailConversationNotificationEmailMediaParticipant.md +1 -0
- data/docs/EmailConversationNotificationParticipants.md +1 -0
- data/docs/EmailMediaParticipant.md +1 -0
- data/docs/FaxDocument.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/MessageConversation.md +17 -0
- data/docs/MessageConversationEntityListing.md +22 -0
- data/docs/MessageData.md +25 -0
- data/docs/MessageMediaParticipant.md +44 -0
- data/docs/Question.md +1 -1
- data/docs/Recipient.md +20 -0
- data/docs/RecipientListing.md +22 -0
- data/docs/RoutingApi.md +632 -0
- data/docs/SMSAvailablePhoneNumberEntityListing.md +13 -0
- data/docs/SmsAddressProvision.md +21 -0
- data/docs/SmsAvailablePhoneNumber.md +22 -0
- data/docs/SmsPhoneNumber.md +25 -0
- data/docs/SmsPhoneNumberEntityListing.md +22 -0
- data/docs/SmsPhoneNumberProvision.md +18 -0
- data/docs/TextMessageListing.md +22 -0
- data/lib/purecloudplatformclientv2.rb +20 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +108 -34
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +1247 -317
- data/lib/purecloudplatformclientv2/api/routing_api.rb +829 -43
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/additional_message.rb +207 -0
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +41 -1
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
- data/lib/purecloudplatformclientv2/models/attachment.rb +5 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_attachment.rb +326 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_draft_attachments.rb +326 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +28 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +28 -1
- data/lib/purecloudplatformclientv2/models/data_table.rb +306 -0
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email.rb +32 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_attachment.rb +326 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +31 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +31 -4
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +32 -4
- data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/json_node.rb +72 -72
- data/lib/purecloudplatformclientv2/models/message_conversation.rb +309 -0
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/message_data.rb +572 -0
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1068 -0
- data/lib/purecloudplatformclientv2/models/question.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recipient.rb +383 -0
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/sms_address_provision.rb +440 -0
- data/lib/purecloudplatformclientv2/models/sms_available_phone_number.rb +465 -0
- data/lib/purecloudplatformclientv2/models/sms_available_phone_number_entity_listing.rb +203 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +546 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_provision.rb +360 -0
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +42 -2
|
@@ -447,6 +447,70 @@ module PureCloud
|
|
|
447
447
|
return data, status_code, headers
|
|
448
448
|
end
|
|
449
449
|
|
|
450
|
+
# Delete a phone number provisioned for SMS.
|
|
451
|
+
#
|
|
452
|
+
# @param address_id Address ID
|
|
453
|
+
# @param [Hash] opts the optional parameters
|
|
454
|
+
# @return [nil]
|
|
455
|
+
def delete_routing_sms_phonenumber(address_id, opts = {})
|
|
456
|
+
delete_routing_sms_phonenumber_with_http_info(address_id, opts)
|
|
457
|
+
return nil
|
|
458
|
+
end
|
|
459
|
+
|
|
460
|
+
# Delete a phone number provisioned for SMS.
|
|
461
|
+
#
|
|
462
|
+
# @param address_id Address ID
|
|
463
|
+
# @param [Hash] opts the optional parameters
|
|
464
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
465
|
+
def delete_routing_sms_phonenumber_with_http_info(address_id, opts = {})
|
|
466
|
+
if @api_client.config.debugging
|
|
467
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_sms_phonenumber ..."
|
|
468
|
+
end
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
# verify the required parameter 'address_id' is set
|
|
472
|
+
fail ArgumentError, "Missing the required parameter 'address_id' when calling RoutingApi.delete_routing_sms_phonenumber" if address_id.nil?
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
# resource path
|
|
479
|
+
local_var_path = "/api/v2/routing/sms/phonenumbers/{addressId}".sub('{format}','json').sub('{' + 'addressId' + '}', address_id.to_s)
|
|
480
|
+
|
|
481
|
+
# query parameters
|
|
482
|
+
query_params = {}
|
|
483
|
+
|
|
484
|
+
# header parameters
|
|
485
|
+
header_params = {}
|
|
486
|
+
|
|
487
|
+
# HTTP header 'Accept' (if needed)
|
|
488
|
+
local_header_accept = ['application/json']
|
|
489
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
490
|
+
|
|
491
|
+
# HTTP header 'Content-Type'
|
|
492
|
+
local_header_content_type = ['application/json']
|
|
493
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
494
|
+
|
|
495
|
+
# form parameters
|
|
496
|
+
form_params = {}
|
|
497
|
+
|
|
498
|
+
# http body (model)
|
|
499
|
+
post_body = nil
|
|
500
|
+
|
|
501
|
+
auth_names = ['PureCloud Auth']
|
|
502
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
|
503
|
+
:header_params => header_params,
|
|
504
|
+
:query_params => query_params,
|
|
505
|
+
:form_params => form_params,
|
|
506
|
+
:body => post_body,
|
|
507
|
+
:auth_names => auth_names)
|
|
508
|
+
if @api_client.config.debugging
|
|
509
|
+
@api_client.config.logger.debug "API called: RoutingApi#delete_routing_sms_phonenumber\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
510
|
+
end
|
|
511
|
+
return data, status_code, headers
|
|
512
|
+
end
|
|
513
|
+
|
|
450
514
|
# Delete utilization settings and revert to system defaults.
|
|
451
515
|
#
|
|
452
516
|
# @param [Hash] opts the optional parameters
|
|
@@ -1076,6 +1140,144 @@ module PureCloud
|
|
|
1076
1140
|
return data, status_code, headers
|
|
1077
1141
|
end
|
|
1078
1142
|
|
|
1143
|
+
# Get a recipient
|
|
1144
|
+
#
|
|
1145
|
+
# @param recipient_id Recipient ID
|
|
1146
|
+
# @param [Hash] opts the optional parameters
|
|
1147
|
+
# @return [Recipient]
|
|
1148
|
+
def get_routing_message_recipient(recipient_id, opts = {})
|
|
1149
|
+
data, _status_code, _headers = get_routing_message_recipient_with_http_info(recipient_id, opts)
|
|
1150
|
+
return data
|
|
1151
|
+
end
|
|
1152
|
+
|
|
1153
|
+
# Get a recipient
|
|
1154
|
+
#
|
|
1155
|
+
# @param recipient_id Recipient ID
|
|
1156
|
+
# @param [Hash] opts the optional parameters
|
|
1157
|
+
# @return [Array<(Recipient, Fixnum, Hash)>] Recipient data, response status code and response headers
|
|
1158
|
+
def get_routing_message_recipient_with_http_info(recipient_id, opts = {})
|
|
1159
|
+
if @api_client.config.debugging
|
|
1160
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.get_routing_message_recipient ..."
|
|
1161
|
+
end
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
# verify the required parameter 'recipient_id' is set
|
|
1165
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling RoutingApi.get_routing_message_recipient" if recipient_id.nil?
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
# resource path
|
|
1172
|
+
local_var_path = "/api/v2/routing/message/recipients/{recipientId}".sub('{format}','json').sub('{' + 'recipientId' + '}', recipient_id.to_s)
|
|
1173
|
+
|
|
1174
|
+
# query parameters
|
|
1175
|
+
query_params = {}
|
|
1176
|
+
|
|
1177
|
+
# header parameters
|
|
1178
|
+
header_params = {}
|
|
1179
|
+
|
|
1180
|
+
# HTTP header 'Accept' (if needed)
|
|
1181
|
+
local_header_accept = ['application/json']
|
|
1182
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
1183
|
+
|
|
1184
|
+
# HTTP header 'Content-Type'
|
|
1185
|
+
local_header_content_type = ['application/json']
|
|
1186
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
1187
|
+
|
|
1188
|
+
# form parameters
|
|
1189
|
+
form_params = {}
|
|
1190
|
+
|
|
1191
|
+
# http body (model)
|
|
1192
|
+
post_body = nil
|
|
1193
|
+
|
|
1194
|
+
auth_names = ['PureCloud Auth']
|
|
1195
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1196
|
+
:header_params => header_params,
|
|
1197
|
+
:query_params => query_params,
|
|
1198
|
+
:form_params => form_params,
|
|
1199
|
+
:body => post_body,
|
|
1200
|
+
:auth_names => auth_names,
|
|
1201
|
+
:return_type => 'Recipient')
|
|
1202
|
+
if @api_client.config.debugging
|
|
1203
|
+
@api_client.config.logger.debug "API called: RoutingApi#get_routing_message_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1204
|
+
end
|
|
1205
|
+
return data, status_code, headers
|
|
1206
|
+
end
|
|
1207
|
+
|
|
1208
|
+
# Get recipients
|
|
1209
|
+
#
|
|
1210
|
+
# @param [Hash] opts the optional parameters
|
|
1211
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
|
1212
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
|
1213
|
+
# @return [RecipientListing]
|
|
1214
|
+
def get_routing_message_recipients(opts = {})
|
|
1215
|
+
data, _status_code, _headers = get_routing_message_recipients_with_http_info(opts)
|
|
1216
|
+
return data
|
|
1217
|
+
end
|
|
1218
|
+
|
|
1219
|
+
# Get recipients
|
|
1220
|
+
#
|
|
1221
|
+
# @param [Hash] opts the optional parameters
|
|
1222
|
+
# @option opts [Integer] :page_size Page size
|
|
1223
|
+
# @option opts [Integer] :page_number Page number
|
|
1224
|
+
# @return [Array<(RecipientListing, Fixnum, Hash)>] RecipientListing data, response status code and response headers
|
|
1225
|
+
def get_routing_message_recipients_with_http_info(opts = {})
|
|
1226
|
+
if @api_client.config.debugging
|
|
1227
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.get_routing_message_recipients ..."
|
|
1228
|
+
end
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
# resource path
|
|
1243
|
+
local_var_path = "/api/v2/routing/message/recipients".sub('{format}','json')
|
|
1244
|
+
|
|
1245
|
+
# query parameters
|
|
1246
|
+
query_params = {}
|
|
1247
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
1248
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
1249
|
+
|
|
1250
|
+
# header parameters
|
|
1251
|
+
header_params = {}
|
|
1252
|
+
|
|
1253
|
+
# HTTP header 'Accept' (if needed)
|
|
1254
|
+
local_header_accept = ['application/json']
|
|
1255
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
1256
|
+
|
|
1257
|
+
# HTTP header 'Content-Type'
|
|
1258
|
+
local_header_content_type = ['application/json']
|
|
1259
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
1260
|
+
|
|
1261
|
+
# form parameters
|
|
1262
|
+
form_params = {}
|
|
1263
|
+
|
|
1264
|
+
# http body (model)
|
|
1265
|
+
post_body = nil
|
|
1266
|
+
|
|
1267
|
+
auth_names = ['PureCloud Auth']
|
|
1268
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1269
|
+
:header_params => header_params,
|
|
1270
|
+
:query_params => query_params,
|
|
1271
|
+
:form_params => form_params,
|
|
1272
|
+
:body => post_body,
|
|
1273
|
+
:auth_names => auth_names,
|
|
1274
|
+
:return_type => 'RecipientListing')
|
|
1275
|
+
if @api_client.config.debugging
|
|
1276
|
+
@api_client.config.logger.debug "API called: RoutingApi#get_routing_message_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1277
|
+
end
|
|
1278
|
+
return data, status_code, headers
|
|
1279
|
+
end
|
|
1280
|
+
|
|
1079
1281
|
# Get details about this queue.
|
|
1080
1282
|
#
|
|
1081
1283
|
# @param queue_id Queue ID
|
|
@@ -1766,29 +1968,105 @@ module PureCloud
|
|
|
1766
1968
|
return data, status_code, headers
|
|
1767
1969
|
end
|
|
1768
1970
|
|
|
1769
|
-
# Get
|
|
1770
|
-
#
|
|
1971
|
+
# Get a list of available phone numbers for SMS provisioning.
|
|
1972
|
+
# This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.
|
|
1973
|
+
# @param country_code The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned
|
|
1974
|
+
# @param phone_number_type Type of available phone numbers searched
|
|
1771
1975
|
# @param [Hash] opts the optional parameters
|
|
1772
|
-
# @
|
|
1773
|
-
|
|
1774
|
-
|
|
1976
|
+
# @option opts [String] :region Region/province/state that can be used to restrict the numbers returned
|
|
1977
|
+
# @option opts [String] :city City that can be used to restrict the numbers returned
|
|
1978
|
+
# @option opts [String] :area_code Area code that can be used to restrict the numbers returned
|
|
1979
|
+
# @option opts [String] :pattern A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit.
|
|
1980
|
+
# @option opts [String] :address_requirement This indicates whether the phone number requires to have an Address registered.
|
|
1981
|
+
# @return [SMSAvailablePhoneNumberEntityListing]
|
|
1982
|
+
def get_routing_sms_availablephonenumbers(country_code, phone_number_type, opts = {})
|
|
1983
|
+
data, _status_code, _headers = get_routing_sms_availablephonenumbers_with_http_info(country_code, phone_number_type, opts)
|
|
1775
1984
|
return data
|
|
1776
1985
|
end
|
|
1777
1986
|
|
|
1778
|
-
# Get
|
|
1779
|
-
#
|
|
1987
|
+
# Get a list of available phone numbers for SMS provisioning.
|
|
1988
|
+
# This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.
|
|
1989
|
+
# @param country_code The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned
|
|
1990
|
+
# @param phone_number_type Type of available phone numbers searched
|
|
1780
1991
|
# @param [Hash] opts the optional parameters
|
|
1781
|
-
# @
|
|
1782
|
-
|
|
1992
|
+
# @option opts [String] :region Region/province/state that can be used to restrict the numbers returned
|
|
1993
|
+
# @option opts [String] :city City that can be used to restrict the numbers returned
|
|
1994
|
+
# @option opts [String] :area_code Area code that can be used to restrict the numbers returned
|
|
1995
|
+
# @option opts [String] :pattern A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit.
|
|
1996
|
+
# @option opts [String] :address_requirement This indicates whether the phone number requires to have an Address registered.
|
|
1997
|
+
# @return [Array<(SMSAvailablePhoneNumberEntityListing, Fixnum, Hash)>] SMSAvailablePhoneNumberEntityListing data, response status code and response headers
|
|
1998
|
+
def get_routing_sms_availablephonenumbers_with_http_info(country_code, phone_number_type, opts = {})
|
|
1783
1999
|
if @api_client.config.debugging
|
|
1784
|
-
@api_client.config.logger.debug "Calling API: RoutingApi.
|
|
2000
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.get_routing_sms_availablephonenumbers ..."
|
|
2001
|
+
end
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
# verify the required parameter 'country_code' is set
|
|
2005
|
+
fail ArgumentError, "Missing the required parameter 'country_code' when calling RoutingApi.get_routing_sms_availablephonenumbers" if country_code.nil?
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
# verify the required parameter 'phone_number_type' is set
|
|
2013
|
+
fail ArgumentError, "Missing the required parameter 'phone_number_type' when calling RoutingApi.get_routing_sms_availablephonenumbers" if phone_number_type.nil?
|
|
2014
|
+
|
|
2015
|
+
# verify enum value
|
|
2016
|
+
unless ['local', 'mobile', 'tollfree'].include?(phone_number_type)
|
|
2017
|
+
fail ArgumentError, "invalid value for 'phone_number_type', must be one of local, mobile, tollfree"
|
|
2018
|
+
end
|
|
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
|
+
if opts[:'address_requirement'] && !['none', 'any', 'local', 'foreign'].include?(opts[:'address_requirement'])
|
|
2052
|
+
fail ArgumentError, 'invalid value for "address_requirement", must be one of none, any, local, foreign'
|
|
1785
2053
|
end
|
|
1786
2054
|
|
|
2055
|
+
|
|
2056
|
+
|
|
2057
|
+
|
|
1787
2058
|
# resource path
|
|
1788
|
-
local_var_path = "/api/v2/routing/
|
|
2059
|
+
local_var_path = "/api/v2/routing/sms/availablephonenumbers".sub('{format}','json')
|
|
1789
2060
|
|
|
1790
2061
|
# query parameters
|
|
1791
2062
|
query_params = {}
|
|
2063
|
+
query_params[:'countryCode'] = country_code
|
|
2064
|
+
query_params[:'phoneNumberType'] = phone_number_type
|
|
2065
|
+
query_params[:'region'] = opts[:'region'] if opts[:'region']
|
|
2066
|
+
query_params[:'city'] = opts[:'city'] if opts[:'city']
|
|
2067
|
+
query_params[:'areaCode'] = opts[:'area_code'] if opts[:'area_code']
|
|
2068
|
+
query_params[:'pattern'] = opts[:'pattern'] if opts[:'pattern']
|
|
2069
|
+
query_params[:'addressRequirement'] = opts[:'address_requirement'] if opts[:'address_requirement']
|
|
1792
2070
|
|
|
1793
2071
|
# header parameters
|
|
1794
2072
|
header_params = {}
|
|
@@ -1814,43 +2092,43 @@ module PureCloud
|
|
|
1814
2092
|
:form_params => form_params,
|
|
1815
2093
|
:body => post_body,
|
|
1816
2094
|
:auth_names => auth_names,
|
|
1817
|
-
:return_type => '
|
|
2095
|
+
:return_type => 'SMSAvailablePhoneNumberEntityListing')
|
|
1818
2096
|
if @api_client.config.debugging
|
|
1819
|
-
@api_client.config.logger.debug "API called: RoutingApi#
|
|
2097
|
+
@api_client.config.logger.debug "API called: RoutingApi#get_routing_sms_availablephonenumbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1820
2098
|
end
|
|
1821
2099
|
return data, status_code, headers
|
|
1822
2100
|
end
|
|
1823
2101
|
|
|
1824
|
-
# Get
|
|
2102
|
+
# Get a phone number provisioned for SMS.
|
|
1825
2103
|
#
|
|
1826
|
-
# @param
|
|
2104
|
+
# @param address_id Address ID
|
|
1827
2105
|
# @param [Hash] opts the optional parameters
|
|
1828
|
-
# @return [
|
|
1829
|
-
def
|
|
1830
|
-
data, _status_code, _headers =
|
|
2106
|
+
# @return [SmsPhoneNumber]
|
|
2107
|
+
def get_routing_sms_phonenumber(address_id, opts = {})
|
|
2108
|
+
data, _status_code, _headers = get_routing_sms_phonenumber_with_http_info(address_id, opts)
|
|
1831
2109
|
return data
|
|
1832
2110
|
end
|
|
1833
2111
|
|
|
1834
|
-
# Get
|
|
2112
|
+
# Get a phone number provisioned for SMS.
|
|
1835
2113
|
#
|
|
1836
|
-
# @param
|
|
2114
|
+
# @param address_id Address ID
|
|
1837
2115
|
# @param [Hash] opts the optional parameters
|
|
1838
|
-
# @return [Array<(
|
|
1839
|
-
def
|
|
2116
|
+
# @return [Array<(SmsPhoneNumber, Fixnum, Hash)>] SmsPhoneNumber data, response status code and response headers
|
|
2117
|
+
def get_routing_sms_phonenumber_with_http_info(address_id, opts = {})
|
|
1840
2118
|
if @api_client.config.debugging
|
|
1841
|
-
@api_client.config.logger.debug "Calling API: RoutingApi.
|
|
2119
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.get_routing_sms_phonenumber ..."
|
|
1842
2120
|
end
|
|
1843
2121
|
|
|
1844
2122
|
|
|
1845
|
-
# verify the required parameter '
|
|
1846
|
-
fail ArgumentError, "Missing the required parameter '
|
|
2123
|
+
# verify the required parameter 'address_id' is set
|
|
2124
|
+
fail ArgumentError, "Missing the required parameter 'address_id' when calling RoutingApi.get_routing_sms_phonenumber" if address_id.nil?
|
|
1847
2125
|
|
|
1848
2126
|
|
|
1849
2127
|
|
|
1850
2128
|
|
|
1851
2129
|
|
|
1852
2130
|
# resource path
|
|
1853
|
-
local_var_path = "/api/v2/routing/
|
|
2131
|
+
local_var_path = "/api/v2/routing/sms/phonenumbers/{addressId}".sub('{format}','json').sub('{' + 'addressId' + '}', address_id.to_s)
|
|
1854
2132
|
|
|
1855
2133
|
# query parameters
|
|
1856
2134
|
query_params = {}
|
|
@@ -1879,37 +2157,39 @@ module PureCloud
|
|
|
1879
2157
|
:form_params => form_params,
|
|
1880
2158
|
:body => post_body,
|
|
1881
2159
|
:auth_names => auth_names,
|
|
1882
|
-
:return_type => '
|
|
2160
|
+
:return_type => 'SmsPhoneNumber')
|
|
1883
2161
|
if @api_client.config.debugging
|
|
1884
|
-
@api_client.config.logger.debug "API called: RoutingApi#
|
|
2162
|
+
@api_client.config.logger.debug "API called: RoutingApi#get_routing_sms_phonenumber\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1885
2163
|
end
|
|
1886
2164
|
return data, status_code, headers
|
|
1887
2165
|
end
|
|
1888
2166
|
|
|
1889
|
-
# Get list of
|
|
2167
|
+
# Get a list of provisioned phone numbers.
|
|
1890
2168
|
#
|
|
1891
2169
|
# @param [Hash] opts the optional parameters
|
|
2170
|
+
# @option opts [String] :phone_number Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.
|
|
2171
|
+
# @option opts [String] :phone_number_type Filter on phone number type
|
|
2172
|
+
# @option opts [String] :phone_number_status Filter on phone number status
|
|
1892
2173
|
# @option opts [Integer] :page_size Page size (default to 25)
|
|
1893
2174
|
# @option opts [Integer] :page_number Page number (default to 1)
|
|
1894
|
-
# @
|
|
1895
|
-
|
|
1896
|
-
|
|
1897
|
-
def get_routing_wrapupcodes(opts = {})
|
|
1898
|
-
data, _status_code, _headers = get_routing_wrapupcodes_with_http_info(opts)
|
|
2175
|
+
# @return [SmsPhoneNumberEntityListing]
|
|
2176
|
+
def get_routing_sms_phonenumbers(opts = {})
|
|
2177
|
+
data, _status_code, _headers = get_routing_sms_phonenumbers_with_http_info(opts)
|
|
1899
2178
|
return data
|
|
1900
2179
|
end
|
|
1901
2180
|
|
|
1902
|
-
# Get list of
|
|
2181
|
+
# Get a list of provisioned phone numbers.
|
|
1903
2182
|
#
|
|
1904
2183
|
# @param [Hash] opts the optional parameters
|
|
2184
|
+
# @option opts [String] :phone_number Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used.
|
|
2185
|
+
# @option opts [String] :phone_number_type Filter on phone number type
|
|
2186
|
+
# @option opts [String] :phone_number_status Filter on phone number status
|
|
1905
2187
|
# @option opts [Integer] :page_size Page size
|
|
1906
2188
|
# @option opts [Integer] :page_number Page number
|
|
1907
|
-
# @
|
|
1908
|
-
|
|
1909
|
-
# @return [Array<(WrapupCodeEntityListing, Fixnum, Hash)>] WrapupCodeEntityListing data, response status code and response headers
|
|
1910
|
-
def get_routing_wrapupcodes_with_http_info(opts = {})
|
|
2189
|
+
# @return [Array<(SmsPhoneNumberEntityListing, Fixnum, Hash)>] SmsPhoneNumberEntityListing data, response status code and response headers
|
|
2190
|
+
def get_routing_sms_phonenumbers_with_http_info(opts = {})
|
|
1911
2191
|
if @api_client.config.debugging
|
|
1912
|
-
@api_client.config.logger.debug "Calling API: RoutingApi.
|
|
2192
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.get_routing_sms_phonenumbers ..."
|
|
1913
2193
|
end
|
|
1914
2194
|
|
|
1915
2195
|
|
|
@@ -1921,6 +2201,9 @@ module PureCloud
|
|
|
1921
2201
|
|
|
1922
2202
|
|
|
1923
2203
|
|
|
2204
|
+
if opts[:'phone_number_type'] && !['local', 'mobile', 'tollfree'].include?(opts[:'phone_number_type'])
|
|
2205
|
+
fail ArgumentError, 'invalid value for "phone_number_type", must be one of local, mobile, tollfree'
|
|
2206
|
+
end
|
|
1924
2207
|
|
|
1925
2208
|
|
|
1926
2209
|
|
|
@@ -1928,6 +2211,9 @@ module PureCloud
|
|
|
1928
2211
|
|
|
1929
2212
|
|
|
1930
2213
|
|
|
2214
|
+
if opts[:'phone_number_status'] && !['active', 'invalid', 'porting'].include?(opts[:'phone_number_status'])
|
|
2215
|
+
fail ArgumentError, 'invalid value for "phone_number_status", must be one of active, invalid, porting'
|
|
2216
|
+
end
|
|
1931
2217
|
|
|
1932
2218
|
|
|
1933
2219
|
|
|
@@ -1936,9 +2222,229 @@ module PureCloud
|
|
|
1936
2222
|
|
|
1937
2223
|
|
|
1938
2224
|
|
|
1939
|
-
|
|
1940
|
-
|
|
1941
|
-
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
|
|
2229
|
+
|
|
2230
|
+
|
|
2231
|
+
|
|
2232
|
+
|
|
2233
|
+
# resource path
|
|
2234
|
+
local_var_path = "/api/v2/routing/sms/phonenumbers".sub('{format}','json')
|
|
2235
|
+
|
|
2236
|
+
# query parameters
|
|
2237
|
+
query_params = {}
|
|
2238
|
+
query_params[:'phoneNumber'] = opts[:'phone_number'] if opts[:'phone_number']
|
|
2239
|
+
query_params[:'phoneNumberType'] = opts[:'phone_number_type'] if opts[:'phone_number_type']
|
|
2240
|
+
query_params[:'phoneNumberStatus'] = opts[:'phone_number_status'] if opts[:'phone_number_status']
|
|
2241
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
2242
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
2243
|
+
|
|
2244
|
+
# header parameters
|
|
2245
|
+
header_params = {}
|
|
2246
|
+
|
|
2247
|
+
# HTTP header 'Accept' (if needed)
|
|
2248
|
+
local_header_accept = ['application/json']
|
|
2249
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
2250
|
+
|
|
2251
|
+
# HTTP header 'Content-Type'
|
|
2252
|
+
local_header_content_type = ['application/json']
|
|
2253
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
2254
|
+
|
|
2255
|
+
# form parameters
|
|
2256
|
+
form_params = {}
|
|
2257
|
+
|
|
2258
|
+
# http body (model)
|
|
2259
|
+
post_body = nil
|
|
2260
|
+
|
|
2261
|
+
auth_names = ['PureCloud Auth']
|
|
2262
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
2263
|
+
:header_params => header_params,
|
|
2264
|
+
:query_params => query_params,
|
|
2265
|
+
:form_params => form_params,
|
|
2266
|
+
:body => post_body,
|
|
2267
|
+
:auth_names => auth_names,
|
|
2268
|
+
:return_type => 'SmsPhoneNumberEntityListing')
|
|
2269
|
+
if @api_client.config.debugging
|
|
2270
|
+
@api_client.config.logger.debug "API called: RoutingApi#get_routing_sms_phonenumbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2271
|
+
end
|
|
2272
|
+
return data, status_code, headers
|
|
2273
|
+
end
|
|
2274
|
+
|
|
2275
|
+
# Get the utilization settings.
|
|
2276
|
+
#
|
|
2277
|
+
# @param [Hash] opts the optional parameters
|
|
2278
|
+
# @return [Utilization]
|
|
2279
|
+
def get_routing_utilization(opts = {})
|
|
2280
|
+
data, _status_code, _headers = get_routing_utilization_with_http_info(opts)
|
|
2281
|
+
return data
|
|
2282
|
+
end
|
|
2283
|
+
|
|
2284
|
+
# Get the utilization settings.
|
|
2285
|
+
#
|
|
2286
|
+
# @param [Hash] opts the optional parameters
|
|
2287
|
+
# @return [Array<(Utilization, Fixnum, Hash)>] Utilization data, response status code and response headers
|
|
2288
|
+
def get_routing_utilization_with_http_info(opts = {})
|
|
2289
|
+
if @api_client.config.debugging
|
|
2290
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.get_routing_utilization ..."
|
|
2291
|
+
end
|
|
2292
|
+
|
|
2293
|
+
# resource path
|
|
2294
|
+
local_var_path = "/api/v2/routing/utilization".sub('{format}','json')
|
|
2295
|
+
|
|
2296
|
+
# query parameters
|
|
2297
|
+
query_params = {}
|
|
2298
|
+
|
|
2299
|
+
# header parameters
|
|
2300
|
+
header_params = {}
|
|
2301
|
+
|
|
2302
|
+
# HTTP header 'Accept' (if needed)
|
|
2303
|
+
local_header_accept = ['application/json']
|
|
2304
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
2305
|
+
|
|
2306
|
+
# HTTP header 'Content-Type'
|
|
2307
|
+
local_header_content_type = ['application/json']
|
|
2308
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
2309
|
+
|
|
2310
|
+
# form parameters
|
|
2311
|
+
form_params = {}
|
|
2312
|
+
|
|
2313
|
+
# http body (model)
|
|
2314
|
+
post_body = nil
|
|
2315
|
+
|
|
2316
|
+
auth_names = ['PureCloud Auth']
|
|
2317
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
2318
|
+
:header_params => header_params,
|
|
2319
|
+
:query_params => query_params,
|
|
2320
|
+
:form_params => form_params,
|
|
2321
|
+
:body => post_body,
|
|
2322
|
+
:auth_names => auth_names,
|
|
2323
|
+
:return_type => 'Utilization')
|
|
2324
|
+
if @api_client.config.debugging
|
|
2325
|
+
@api_client.config.logger.debug "API called: RoutingApi#get_routing_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2326
|
+
end
|
|
2327
|
+
return data, status_code, headers
|
|
2328
|
+
end
|
|
2329
|
+
|
|
2330
|
+
# Get details about this wrap-up code.
|
|
2331
|
+
#
|
|
2332
|
+
# @param code_id Wrapup Code ID
|
|
2333
|
+
# @param [Hash] opts the optional parameters
|
|
2334
|
+
# @return [WrapupCode]
|
|
2335
|
+
def get_routing_wrapupcode(code_id, opts = {})
|
|
2336
|
+
data, _status_code, _headers = get_routing_wrapupcode_with_http_info(code_id, opts)
|
|
2337
|
+
return data
|
|
2338
|
+
end
|
|
2339
|
+
|
|
2340
|
+
# Get details about this wrap-up code.
|
|
2341
|
+
#
|
|
2342
|
+
# @param code_id Wrapup Code ID
|
|
2343
|
+
# @param [Hash] opts the optional parameters
|
|
2344
|
+
# @return [Array<(WrapupCode, Fixnum, Hash)>] WrapupCode data, response status code and response headers
|
|
2345
|
+
def get_routing_wrapupcode_with_http_info(code_id, opts = {})
|
|
2346
|
+
if @api_client.config.debugging
|
|
2347
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.get_routing_wrapupcode ..."
|
|
2348
|
+
end
|
|
2349
|
+
|
|
2350
|
+
|
|
2351
|
+
# verify the required parameter 'code_id' is set
|
|
2352
|
+
fail ArgumentError, "Missing the required parameter 'code_id' when calling RoutingApi.get_routing_wrapupcode" if code_id.nil?
|
|
2353
|
+
|
|
2354
|
+
|
|
2355
|
+
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
# resource path
|
|
2359
|
+
local_var_path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s)
|
|
2360
|
+
|
|
2361
|
+
# query parameters
|
|
2362
|
+
query_params = {}
|
|
2363
|
+
|
|
2364
|
+
# header parameters
|
|
2365
|
+
header_params = {}
|
|
2366
|
+
|
|
2367
|
+
# HTTP header 'Accept' (if needed)
|
|
2368
|
+
local_header_accept = ['application/json']
|
|
2369
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
2370
|
+
|
|
2371
|
+
# HTTP header 'Content-Type'
|
|
2372
|
+
local_header_content_type = ['application/json']
|
|
2373
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
2374
|
+
|
|
2375
|
+
# form parameters
|
|
2376
|
+
form_params = {}
|
|
2377
|
+
|
|
2378
|
+
# http body (model)
|
|
2379
|
+
post_body = nil
|
|
2380
|
+
|
|
2381
|
+
auth_names = ['PureCloud Auth']
|
|
2382
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
2383
|
+
:header_params => header_params,
|
|
2384
|
+
:query_params => query_params,
|
|
2385
|
+
:form_params => form_params,
|
|
2386
|
+
:body => post_body,
|
|
2387
|
+
:auth_names => auth_names,
|
|
2388
|
+
:return_type => 'WrapupCode')
|
|
2389
|
+
if @api_client.config.debugging
|
|
2390
|
+
@api_client.config.logger.debug "API called: RoutingApi#get_routing_wrapupcode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2391
|
+
end
|
|
2392
|
+
return data, status_code, headers
|
|
2393
|
+
end
|
|
2394
|
+
|
|
2395
|
+
# Get list of wrapup codes.
|
|
2396
|
+
#
|
|
2397
|
+
# @param [Hash] opts the optional parameters
|
|
2398
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
|
2399
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
|
2400
|
+
# @option opts [String] :name Name
|
|
2401
|
+
# @option opts [String] :sort_by Sort by (default to name)
|
|
2402
|
+
# @return [WrapupCodeEntityListing]
|
|
2403
|
+
def get_routing_wrapupcodes(opts = {})
|
|
2404
|
+
data, _status_code, _headers = get_routing_wrapupcodes_with_http_info(opts)
|
|
2405
|
+
return data
|
|
2406
|
+
end
|
|
2407
|
+
|
|
2408
|
+
# Get list of wrapup codes.
|
|
2409
|
+
#
|
|
2410
|
+
# @param [Hash] opts the optional parameters
|
|
2411
|
+
# @option opts [Integer] :page_size Page size
|
|
2412
|
+
# @option opts [Integer] :page_number Page number
|
|
2413
|
+
# @option opts [String] :name Name
|
|
2414
|
+
# @option opts [String] :sort_by Sort by
|
|
2415
|
+
# @return [Array<(WrapupCodeEntityListing, Fixnum, Hash)>] WrapupCodeEntityListing data, response status code and response headers
|
|
2416
|
+
def get_routing_wrapupcodes_with_http_info(opts = {})
|
|
2417
|
+
if @api_client.config.debugging
|
|
2418
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.get_routing_wrapupcodes ..."
|
|
2419
|
+
end
|
|
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
|
+
# resource path
|
|
2446
|
+
local_var_path = "/api/v2/routing/wrapupcodes".sub('{format}','json')
|
|
2447
|
+
|
|
1942
2448
|
# query parameters
|
|
1943
2449
|
query_params = {}
|
|
1944
2450
|
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
@@ -2792,6 +3298,136 @@ module PureCloud
|
|
|
2792
3298
|
return data, status_code, headers
|
|
2793
3299
|
end
|
|
2794
3300
|
|
|
3301
|
+
# Provision an Address for SMS
|
|
3302
|
+
#
|
|
3303
|
+
# @param body SmsAddress
|
|
3304
|
+
# @param [Hash] opts the optional parameters
|
|
3305
|
+
# @return [SmsPhoneNumber]
|
|
3306
|
+
def post_routing_sms_addresses(body, opts = {})
|
|
3307
|
+
data, _status_code, _headers = post_routing_sms_addresses_with_http_info(body, opts)
|
|
3308
|
+
return data
|
|
3309
|
+
end
|
|
3310
|
+
|
|
3311
|
+
# Provision an Address for SMS
|
|
3312
|
+
#
|
|
3313
|
+
# @param body SmsAddress
|
|
3314
|
+
# @param [Hash] opts the optional parameters
|
|
3315
|
+
# @return [Array<(SmsPhoneNumber, Fixnum, Hash)>] SmsPhoneNumber data, response status code and response headers
|
|
3316
|
+
def post_routing_sms_addresses_with_http_info(body, opts = {})
|
|
3317
|
+
if @api_client.config.debugging
|
|
3318
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.post_routing_sms_addresses ..."
|
|
3319
|
+
end
|
|
3320
|
+
|
|
3321
|
+
|
|
3322
|
+
# verify the required parameter 'body' is set
|
|
3323
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_sms_addresses" if body.nil?
|
|
3324
|
+
|
|
3325
|
+
|
|
3326
|
+
|
|
3327
|
+
|
|
3328
|
+
|
|
3329
|
+
# resource path
|
|
3330
|
+
local_var_path = "/api/v2/routing/sms/addresses".sub('{format}','json')
|
|
3331
|
+
|
|
3332
|
+
# query parameters
|
|
3333
|
+
query_params = {}
|
|
3334
|
+
|
|
3335
|
+
# header parameters
|
|
3336
|
+
header_params = {}
|
|
3337
|
+
|
|
3338
|
+
# HTTP header 'Accept' (if needed)
|
|
3339
|
+
local_header_accept = ['application/json']
|
|
3340
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
3341
|
+
|
|
3342
|
+
# HTTP header 'Content-Type'
|
|
3343
|
+
local_header_content_type = ['application/json']
|
|
3344
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
3345
|
+
|
|
3346
|
+
# form parameters
|
|
3347
|
+
form_params = {}
|
|
3348
|
+
|
|
3349
|
+
# http body (model)
|
|
3350
|
+
post_body = @api_client.object_to_http_body(body)
|
|
3351
|
+
|
|
3352
|
+
auth_names = ['PureCloud Auth']
|
|
3353
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
3354
|
+
:header_params => header_params,
|
|
3355
|
+
:query_params => query_params,
|
|
3356
|
+
:form_params => form_params,
|
|
3357
|
+
:body => post_body,
|
|
3358
|
+
:auth_names => auth_names,
|
|
3359
|
+
:return_type => 'SmsPhoneNumber')
|
|
3360
|
+
if @api_client.config.debugging
|
|
3361
|
+
@api_client.config.logger.debug "API called: RoutingApi#post_routing_sms_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3362
|
+
end
|
|
3363
|
+
return data, status_code, headers
|
|
3364
|
+
end
|
|
3365
|
+
|
|
3366
|
+
# Provision a phone number for SMS
|
|
3367
|
+
#
|
|
3368
|
+
# @param body SmsPhoneNumber
|
|
3369
|
+
# @param [Hash] opts the optional parameters
|
|
3370
|
+
# @return [SmsPhoneNumber]
|
|
3371
|
+
def post_routing_sms_phonenumbers(body, opts = {})
|
|
3372
|
+
data, _status_code, _headers = post_routing_sms_phonenumbers_with_http_info(body, opts)
|
|
3373
|
+
return data
|
|
3374
|
+
end
|
|
3375
|
+
|
|
3376
|
+
# Provision a phone number for SMS
|
|
3377
|
+
#
|
|
3378
|
+
# @param body SmsPhoneNumber
|
|
3379
|
+
# @param [Hash] opts the optional parameters
|
|
3380
|
+
# @return [Array<(SmsPhoneNumber, Fixnum, Hash)>] SmsPhoneNumber data, response status code and response headers
|
|
3381
|
+
def post_routing_sms_phonenumbers_with_http_info(body, opts = {})
|
|
3382
|
+
if @api_client.config.debugging
|
|
3383
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.post_routing_sms_phonenumbers ..."
|
|
3384
|
+
end
|
|
3385
|
+
|
|
3386
|
+
|
|
3387
|
+
# verify the required parameter 'body' is set
|
|
3388
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_sms_phonenumbers" if body.nil?
|
|
3389
|
+
|
|
3390
|
+
|
|
3391
|
+
|
|
3392
|
+
|
|
3393
|
+
|
|
3394
|
+
# resource path
|
|
3395
|
+
local_var_path = "/api/v2/routing/sms/phonenumbers".sub('{format}','json')
|
|
3396
|
+
|
|
3397
|
+
# query parameters
|
|
3398
|
+
query_params = {}
|
|
3399
|
+
|
|
3400
|
+
# header parameters
|
|
3401
|
+
header_params = {}
|
|
3402
|
+
|
|
3403
|
+
# HTTP header 'Accept' (if needed)
|
|
3404
|
+
local_header_accept = ['application/json']
|
|
3405
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
3406
|
+
|
|
3407
|
+
# HTTP header 'Content-Type'
|
|
3408
|
+
local_header_content_type = ['application/json']
|
|
3409
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
3410
|
+
|
|
3411
|
+
# form parameters
|
|
3412
|
+
form_params = {}
|
|
3413
|
+
|
|
3414
|
+
# http body (model)
|
|
3415
|
+
post_body = @api_client.object_to_http_body(body)
|
|
3416
|
+
|
|
3417
|
+
auth_names = ['PureCloud Auth']
|
|
3418
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
3419
|
+
:header_params => header_params,
|
|
3420
|
+
:query_params => query_params,
|
|
3421
|
+
:form_params => form_params,
|
|
3422
|
+
:body => post_body,
|
|
3423
|
+
:auth_names => auth_names,
|
|
3424
|
+
:return_type => 'SmsPhoneNumber')
|
|
3425
|
+
if @api_client.config.debugging
|
|
3426
|
+
@api_client.config.logger.debug "API called: RoutingApi#post_routing_sms_phonenumbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3427
|
+
end
|
|
3428
|
+
return data, status_code, headers
|
|
3429
|
+
end
|
|
3430
|
+
|
|
2795
3431
|
# Create a wrap-up code
|
|
2796
3432
|
#
|
|
2797
3433
|
# @param body WrapupCode
|
|
@@ -3017,6 +3653,81 @@ module PureCloud
|
|
|
3017
3653
|
return data, status_code, headers
|
|
3018
3654
|
end
|
|
3019
3655
|
|
|
3656
|
+
# Update a recipient
|
|
3657
|
+
#
|
|
3658
|
+
# @param recipient_id Recipient ID
|
|
3659
|
+
# @param body Recipient
|
|
3660
|
+
# @param [Hash] opts the optional parameters
|
|
3661
|
+
# @return [Recipient]
|
|
3662
|
+
def put_routing_message_recipient(recipient_id, body, opts = {})
|
|
3663
|
+
data, _status_code, _headers = put_routing_message_recipient_with_http_info(recipient_id, body, opts)
|
|
3664
|
+
return data
|
|
3665
|
+
end
|
|
3666
|
+
|
|
3667
|
+
# Update a recipient
|
|
3668
|
+
#
|
|
3669
|
+
# @param recipient_id Recipient ID
|
|
3670
|
+
# @param body Recipient
|
|
3671
|
+
# @param [Hash] opts the optional parameters
|
|
3672
|
+
# @return [Array<(Recipient, Fixnum, Hash)>] Recipient data, response status code and response headers
|
|
3673
|
+
def put_routing_message_recipient_with_http_info(recipient_id, body, opts = {})
|
|
3674
|
+
if @api_client.config.debugging
|
|
3675
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.put_routing_message_recipient ..."
|
|
3676
|
+
end
|
|
3677
|
+
|
|
3678
|
+
|
|
3679
|
+
# verify the required parameter 'recipient_id' is set
|
|
3680
|
+
fail ArgumentError, "Missing the required parameter 'recipient_id' when calling RoutingApi.put_routing_message_recipient" if recipient_id.nil?
|
|
3681
|
+
|
|
3682
|
+
|
|
3683
|
+
|
|
3684
|
+
|
|
3685
|
+
|
|
3686
|
+
|
|
3687
|
+
# verify the required parameter 'body' is set
|
|
3688
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_message_recipient" if body.nil?
|
|
3689
|
+
|
|
3690
|
+
|
|
3691
|
+
|
|
3692
|
+
|
|
3693
|
+
|
|
3694
|
+
# resource path
|
|
3695
|
+
local_var_path = "/api/v2/routing/message/recipients/{recipientId}".sub('{format}','json').sub('{' + 'recipientId' + '}', recipient_id.to_s)
|
|
3696
|
+
|
|
3697
|
+
# query parameters
|
|
3698
|
+
query_params = {}
|
|
3699
|
+
|
|
3700
|
+
# header parameters
|
|
3701
|
+
header_params = {}
|
|
3702
|
+
|
|
3703
|
+
# HTTP header 'Accept' (if needed)
|
|
3704
|
+
local_header_accept = ['application/json']
|
|
3705
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
3706
|
+
|
|
3707
|
+
# HTTP header 'Content-Type'
|
|
3708
|
+
local_header_content_type = ['application/json']
|
|
3709
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
3710
|
+
|
|
3711
|
+
# form parameters
|
|
3712
|
+
form_params = {}
|
|
3713
|
+
|
|
3714
|
+
# http body (model)
|
|
3715
|
+
post_body = @api_client.object_to_http_body(body)
|
|
3716
|
+
|
|
3717
|
+
auth_names = ['PureCloud Auth']
|
|
3718
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
3719
|
+
:header_params => header_params,
|
|
3720
|
+
:query_params => query_params,
|
|
3721
|
+
:form_params => form_params,
|
|
3722
|
+
:body => post_body,
|
|
3723
|
+
:auth_names => auth_names,
|
|
3724
|
+
:return_type => 'Recipient')
|
|
3725
|
+
if @api_client.config.debugging
|
|
3726
|
+
@api_client.config.logger.debug "API called: RoutingApi#put_routing_message_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3727
|
+
end
|
|
3728
|
+
return data, status_code, headers
|
|
3729
|
+
end
|
|
3730
|
+
|
|
3020
3731
|
# Update a queue
|
|
3021
3732
|
#
|
|
3022
3733
|
# @param queue_id Queue ID
|
|
@@ -3092,6 +3803,81 @@ module PureCloud
|
|
|
3092
3803
|
return data, status_code, headers
|
|
3093
3804
|
end
|
|
3094
3805
|
|
|
3806
|
+
# Update a phone number provisioned for SMS.
|
|
3807
|
+
#
|
|
3808
|
+
# @param address_id Address ID
|
|
3809
|
+
# @param body SmsPhoneNumber
|
|
3810
|
+
# @param [Hash] opts the optional parameters
|
|
3811
|
+
# @return [SmsPhoneNumber]
|
|
3812
|
+
def put_routing_sms_phonenumber(address_id, body, opts = {})
|
|
3813
|
+
data, _status_code, _headers = put_routing_sms_phonenumber_with_http_info(address_id, body, opts)
|
|
3814
|
+
return data
|
|
3815
|
+
end
|
|
3816
|
+
|
|
3817
|
+
# Update a phone number provisioned for SMS.
|
|
3818
|
+
#
|
|
3819
|
+
# @param address_id Address ID
|
|
3820
|
+
# @param body SmsPhoneNumber
|
|
3821
|
+
# @param [Hash] opts the optional parameters
|
|
3822
|
+
# @return [Array<(SmsPhoneNumber, Fixnum, Hash)>] SmsPhoneNumber data, response status code and response headers
|
|
3823
|
+
def put_routing_sms_phonenumber_with_http_info(address_id, body, opts = {})
|
|
3824
|
+
if @api_client.config.debugging
|
|
3825
|
+
@api_client.config.logger.debug "Calling API: RoutingApi.put_routing_sms_phonenumber ..."
|
|
3826
|
+
end
|
|
3827
|
+
|
|
3828
|
+
|
|
3829
|
+
# verify the required parameter 'address_id' is set
|
|
3830
|
+
fail ArgumentError, "Missing the required parameter 'address_id' when calling RoutingApi.put_routing_sms_phonenumber" if address_id.nil?
|
|
3831
|
+
|
|
3832
|
+
|
|
3833
|
+
|
|
3834
|
+
|
|
3835
|
+
|
|
3836
|
+
|
|
3837
|
+
# verify the required parameter 'body' is set
|
|
3838
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_sms_phonenumber" if body.nil?
|
|
3839
|
+
|
|
3840
|
+
|
|
3841
|
+
|
|
3842
|
+
|
|
3843
|
+
|
|
3844
|
+
# resource path
|
|
3845
|
+
local_var_path = "/api/v2/routing/sms/phonenumbers/{addressId}".sub('{format}','json').sub('{' + 'addressId' + '}', address_id.to_s)
|
|
3846
|
+
|
|
3847
|
+
# query parameters
|
|
3848
|
+
query_params = {}
|
|
3849
|
+
|
|
3850
|
+
# header parameters
|
|
3851
|
+
header_params = {}
|
|
3852
|
+
|
|
3853
|
+
# HTTP header 'Accept' (if needed)
|
|
3854
|
+
local_header_accept = ['application/json']
|
|
3855
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
3856
|
+
|
|
3857
|
+
# HTTP header 'Content-Type'
|
|
3858
|
+
local_header_content_type = ['application/json']
|
|
3859
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
3860
|
+
|
|
3861
|
+
# form parameters
|
|
3862
|
+
form_params = {}
|
|
3863
|
+
|
|
3864
|
+
# http body (model)
|
|
3865
|
+
post_body = @api_client.object_to_http_body(body)
|
|
3866
|
+
|
|
3867
|
+
auth_names = ['PureCloud Auth']
|
|
3868
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
3869
|
+
:header_params => header_params,
|
|
3870
|
+
:query_params => query_params,
|
|
3871
|
+
:form_params => form_params,
|
|
3872
|
+
:body => post_body,
|
|
3873
|
+
:auth_names => auth_names,
|
|
3874
|
+
:return_type => 'SmsPhoneNumber')
|
|
3875
|
+
if @api_client.config.debugging
|
|
3876
|
+
@api_client.config.logger.debug "API called: RoutingApi#put_routing_sms_phonenumber\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3877
|
+
end
|
|
3878
|
+
return data, status_code, headers
|
|
3879
|
+
end
|
|
3880
|
+
|
|
3095
3881
|
# Update the utilization settings.
|
|
3096
3882
|
#
|
|
3097
3883
|
# @param body utilization
|