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.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AdditionalMessage.md +13 -0
  4. data/docs/AnalyticsParticipant.md +1 -0
  5. data/docs/ArchitectApi.md +40 -28
  6. data/docs/Attachment.md +5 -5
  7. data/docs/ConversationNotificationAttachment.md +18 -0
  8. data/docs/ConversationNotificationDraftAttachments.md +18 -0
  9. data/docs/ConversationNotificationEmail.md +1 -0
  10. data/docs/ConversationNotificationEmails.md +1 -0
  11. data/docs/ConversationsApi.md +964 -198
  12. data/docs/DataTable.md +17 -0
  13. data/docs/DataTableRowEntityListing.md +22 -0
  14. data/docs/DataTablesDomainEntityListing.md +22 -0
  15. data/docs/Document.md +1 -1
  16. data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
  17. data/docs/DomainOrganizationRole.md +1 -1
  18. data/docs/DomainOrganizationRoleCreate.md +1 -1
  19. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  20. data/docs/Email.md +1 -0
  21. data/docs/EmailConversationNotificationAttachment.md +18 -0
  22. data/docs/EmailConversationNotificationEmailMediaParticipant.md +1 -0
  23. data/docs/EmailConversationNotificationParticipants.md +1 -0
  24. data/docs/EmailMediaParticipant.md +1 -0
  25. data/docs/FaxDocument.md +1 -1
  26. data/docs/JsonNode.md +4 -4
  27. data/docs/MessageConversation.md +17 -0
  28. data/docs/MessageConversationEntityListing.md +22 -0
  29. data/docs/MessageData.md +25 -0
  30. data/docs/MessageMediaParticipant.md +44 -0
  31. data/docs/Question.md +1 -1
  32. data/docs/Recipient.md +20 -0
  33. data/docs/RecipientListing.md +22 -0
  34. data/docs/RoutingApi.md +632 -0
  35. data/docs/SMSAvailablePhoneNumberEntityListing.md +13 -0
  36. data/docs/SmsAddressProvision.md +21 -0
  37. data/docs/SmsAvailablePhoneNumber.md +22 -0
  38. data/docs/SmsPhoneNumber.md +25 -0
  39. data/docs/SmsPhoneNumberEntityListing.md +22 -0
  40. data/docs/SmsPhoneNumberProvision.md +18 -0
  41. data/docs/TextMessageListing.md +22 -0
  42. data/lib/purecloudplatformclientv2.rb +20 -0
  43. data/lib/purecloudplatformclientv2/api/architect_api.rb +108 -34
  44. data/lib/purecloudplatformclientv2/api/conversations_api.rb +1247 -317
  45. data/lib/purecloudplatformclientv2/api/routing_api.rb +829 -43
  46. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  47. data/lib/purecloudplatformclientv2/models/additional_message.rb +207 -0
  48. data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
  49. data/lib/purecloudplatformclientv2/models/analytics_participant.rb +41 -1
  50. data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
  51. data/lib/purecloudplatformclientv2/models/attachment.rb +5 -0
  52. data/lib/purecloudplatformclientv2/models/conversation_notification_attachment.rb +326 -0
  53. data/lib/purecloudplatformclientv2/models/conversation_notification_draft_attachments.rb +326 -0
  54. data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +28 -1
  55. data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +28 -1
  56. data/lib/purecloudplatformclientv2/models/data_table.rb +306 -0
  57. data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +428 -0
  58. data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +428 -0
  59. data/lib/purecloudplatformclientv2/models/document.rb +12 -12
  60. data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
  61. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  62. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  63. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  64. data/lib/purecloudplatformclientv2/models/email.rb +32 -4
  65. data/lib/purecloudplatformclientv2/models/email_conversation_notification_attachment.rb +326 -0
  66. data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +31 -4
  67. data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +31 -4
  68. data/lib/purecloudplatformclientv2/models/email_media_participant.rb +32 -4
  69. data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
  70. data/lib/purecloudplatformclientv2/models/json_node.rb +72 -72
  71. data/lib/purecloudplatformclientv2/models/message_conversation.rb +309 -0
  72. data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +428 -0
  73. data/lib/purecloudplatformclientv2/models/message_data.rb +572 -0
  74. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1068 -0
  75. data/lib/purecloudplatformclientv2/models/question.rb +13 -13
  76. data/lib/purecloudplatformclientv2/models/recipient.rb +383 -0
  77. data/lib/purecloudplatformclientv2/models/recipient_listing.rb +428 -0
  78. data/lib/purecloudplatformclientv2/models/sms_address_provision.rb +440 -0
  79. data/lib/purecloudplatformclientv2/models/sms_available_phone_number.rb +465 -0
  80. data/lib/purecloudplatformclientv2/models/sms_available_phone_number_entity_listing.rb +203 -0
  81. data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +546 -0
  82. data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +428 -0
  83. data/lib/purecloudplatformclientv2/models/sms_phone_number_provision.rb +360 -0
  84. data/lib/purecloudplatformclientv2/models/text_message_listing.rb +428 -0
  85. data/lib/purecloudplatformclientv2/version.rb +1 -1
  86. metadata +42 -2
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: DataTable
3
+ ---
4
+ ## PureCloud::DataTable
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **description** | **String** | The description from the JSON schema (equates to the Description field on the JSON schema.) | [optional] |
13
+ | **schema** | [**JsonSchemaDocument**](JsonSchemaDocument.html) | the schema as stored in the system. | [optional] |
14
+ | **self_uri** | **String** | The URI for this object | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: DataTableRowEntityListing
3
+ ---
4
+ ## PureCloud::DataTableRowEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | **Array<Hash<String, Object>>** | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: DataTablesDomainEntityListing
3
+ ---
4
+ ## PureCloud::DataTablesDomainEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<DataTable>**](DataTable.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -35,8 +35,8 @@ title: Document
35
35
  | **lock_info** | [**LockInfo**](LockInfo.html) | | [optional] |
36
36
  | **acl** | **Array<String>** | A list of permitted action rights for the user making the request | [optional] |
37
37
  | **sharing_status** | **String** | | [optional] |
38
- | **download_sharing_uri** | **String** | | [optional] |
39
38
  | **sharing_uri** | **String** | | [optional] |
39
+ | **download_sharing_uri** | **String** | | [optional] |
40
40
  | **self_uri** | **String** | The URI for this object | [optional] |
41
41
  {: class="table table-striped"}
42
42
 
@@ -12,8 +12,8 @@ title: DomainEdgeSoftwareVersionDto
12
12
  | **edge_version** | **String** | | [optional] |
13
13
  | **publish_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
14
  | **edge_uri** | **String** | | [optional] |
15
- | **latest_release** | **BOOLEAN** | | [optional] |
16
15
  | **current** | **BOOLEAN** | | [optional] |
16
+ | **latest_release** | **BOOLEAN** | | [optional] |
17
17
  | **self_uri** | **String** | The URI for this object | [optional] |
18
18
  {: class="table table-striped"}
19
19
 
@@ -15,8 +15,8 @@ title: DomainOrganizationRole
15
15
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **base** | **BOOLEAN** | | [optional] |
19
18
  | **default** | **BOOLEAN** | | [optional] |
19
+ | **base** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
@@ -15,8 +15,8 @@ title: DomainOrganizationRoleCreate
15
15
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **base** | **BOOLEAN** | | [optional] |
19
18
  | **default** | **BOOLEAN** | | [optional] |
19
+ | **base** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
@@ -15,8 +15,8 @@ title: DomainOrganizationRoleUpdate
15
15
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **base** | **BOOLEAN** | | [optional] |
19
18
  | **default** | **BOOLEAN** | | [optional] |
19
+ | **base** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
@@ -25,6 +25,7 @@ title: Email
25
25
  | **script_id** | **String** | The UUID of the script to use. | [optional] |
26
26
  | **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
27
27
  | **message_id** | **String** | A globally unique identifier for the stored content of this communication. | [optional] |
28
+ | **draft_attachments** | [**Array<Attachment>**](Attachment.html) | A list of uploaded attachments on the email draft. | [optional] |
28
29
  {: class="table table-striped"}
29
30
 
30
31
 
@@ -0,0 +1,18 @@
1
+ ---
2
+ title: EmailConversationNotificationAttachment
3
+ ---
4
+ ## PureCloud::EmailConversationNotificationAttachment
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **attachment_id** | **String** | | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **content_uri** | **String** | | [optional] |
13
+ | **content_type** | **String** | | [optional] |
14
+ | **content_length** | **Integer** | | [optional] |
15
+ | **additional_properties** | **Object** | | [optional] |
16
+ {: class="table table-striped"}
17
+
18
+
@@ -38,6 +38,7 @@ title: EmailConversationNotificationEmailMediaParticipant
38
38
  | **messages_sent** | **Integer** | | [optional] |
39
39
  | **auto_generated** | **BOOLEAN** | | [optional] |
40
40
  | **message_id** | **String** | | [optional] |
41
+ | **draft_attachments** | [**Array<ConversationNotificationDraftAttachments>**](ConversationNotificationDraftAttachments.html) | | [optional] |
41
42
  {: class="table table-striped"}
42
43
 
43
44
 
@@ -38,6 +38,7 @@ title: EmailConversationNotificationParticipants
38
38
  | **messages_sent** | **Integer** | | [optional] |
39
39
  | **auto_generated** | **BOOLEAN** | | [optional] |
40
40
  | **message_id** | **String** | | [optional] |
41
+ | **draft_attachments** | [**Array<ConversationNotificationDraftAttachments>**](ConversationNotificationDraftAttachments.html) | | [optional] |
41
42
  {: class="table table-striped"}
42
43
 
43
44
 
@@ -36,6 +36,7 @@ title: EmailMediaParticipant
36
36
  | **subject** | **String** | The subject of the email. | [optional] |
37
37
  | **messages_sent** | **Integer** | The number of messages that have been sent in this email conversation. | [optional] |
38
38
  | **auto_generated** | **BOOLEAN** | Indicates that the email was auto-generated like an Out of Office reply. | [optional] |
39
+ | **draft_attachments** | [**Array<Attachment>**](Attachment.html) | A list of uploaded attachments on the email draft. | [optional] |
39
40
  {: class="table table-striped"}
40
41
 
41
42
 
@@ -22,8 +22,8 @@ title: FaxDocument
22
22
  | **caller_address** | **String** | | [optional] |
23
23
  | **receiver_address** | **String** | | [optional] |
24
24
  | **thumbnails** | [**Array<DocumentThumbnail>**](DocumentThumbnail.html) | | [optional] |
25
- | **download_sharing_uri** | **String** | | [optional] |
26
25
  | **sharing_uri** | **String** | | [optional] |
26
+ | **download_sharing_uri** | **String** | | [optional] |
27
27
  | **self_uri** | **String** | The URI for this object | [optional] |
28
28
  {: class="table table-striped"}
29
29
 
@@ -7,11 +7,14 @@ title: JsonNode
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
+ | **array** | **BOOLEAN** | | [optional] |
11
+ | **null** | **BOOLEAN** | | [optional] |
10
12
  | **node_type** | **String** | | [optional] |
13
+ | **float** | **BOOLEAN** | | [optional] |
11
14
  | **object** | **BOOLEAN** | | [optional] |
12
15
  | **boolean** | **BOOLEAN** | | [optional] |
13
16
  | **number** | **BOOLEAN** | | [optional] |
14
- | **float** | **BOOLEAN** | | [optional] |
17
+ | **value_node** | **BOOLEAN** | | [optional] |
15
18
  | **container_node** | **BOOLEAN** | | [optional] |
16
19
  | **missing_node** | **BOOLEAN** | | [optional] |
17
20
  | **pojo** | **BOOLEAN** | | [optional] |
@@ -25,9 +28,6 @@ title: JsonNode
25
28
  | **big_integer** | **BOOLEAN** | | [optional] |
26
29
  | **textual** | **BOOLEAN** | | [optional] |
27
30
  | **binary** | **BOOLEAN** | | [optional] |
28
- | **value_node** | **BOOLEAN** | | [optional] |
29
- | **array** | **BOOLEAN** | | [optional] |
30
- | **null** | **BOOLEAN** | | [optional] |
31
31
  {: class="table table-striped"}
32
32
 
33
33
 
@@ -0,0 +1,17 @@
1
+ ---
2
+ title: MessageConversation
3
+ ---
4
+ ## PureCloud::MessageConversation
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **participants** | [**Array<MessageMediaParticipant>**](MessageMediaParticipant.html) | The list of participants involved in the conversation. | [optional] |
13
+ | **other_media_uris** | **Array<String>** | The list of other media channels involved in the conversation. | [optional] |
14
+ | **self_uri** | **String** | The URI for this object | [optional] |
15
+ {: class="table table-striped"}
16
+
17
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: MessageConversationEntityListing
3
+ ---
4
+ ## PureCloud::MessageConversationEntityListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<EmailConversation>**](EmailConversation.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -0,0 +1,25 @@
1
+ ---
2
+ title: MessageData
3
+ ---
4
+ ## PureCloud::MessageData
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **provider_message_id** | **String** | The unique identifier of the message from provider | [optional] |
13
+ | **timestamp** | **DateTime** | The time when the message was received or sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
14
+ | **from_address** | **String** | The sender of the text message. | [optional] |
15
+ | **to_address** | **String** | The recipient of the text message. | [optional] |
16
+ | **direction** | **String** | The direction of the message. | [optional] |
17
+ | **messenger_type** | **String** | Type of text messenger. | [optional] |
18
+ | **text_body** | **String** | The body of the text message. | |
19
+ | **status** | **String** | The status of the message. | |
20
+ | **media** | [**Array<MessageMedia>**](MessageMedia.html) | The media details associated to a message. | [optional] |
21
+ | **created_by** | [**User**](User.html) | User who sent this message. | [optional] |
22
+ | **self_uri** | **String** | The URI for this object | [optional] |
23
+ {: class="table table-striped"}
24
+
25
+
@@ -0,0 +1,44 @@
1
+ ---
2
+ title: MessageMediaParticipant
3
+ ---
4
+ ## PureCloud::MessageMediaParticipant
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The unique participant ID. | [optional] |
11
+ | **name** | **String** | The display friendly name of the participant. | [optional] |
12
+ | **address** | **String** | The participant address. | [optional] |
13
+ | **start_time** | **DateTime** | The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **connected_time** | **DateTime** | The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ | **end_time** | **DateTime** | The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
16
+ | **start_hold_time** | **DateTime** | The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
17
+ | **purpose** | **String** | The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr | [optional] |
18
+ | **state** | **String** | The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting | [optional] |
19
+ | **direction** | **String** | The participant's direction. Values can be: 'inbound' or 'outbound' | [optional] |
20
+ | **disconnect_type** | **String** | The reason the participant was disconnected from the conversation. | [optional] |
21
+ | **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] |
22
+ | **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] |
23
+ | **wrapup_prompt** | **String** | The wrap-up prompt indicating the type of wrap-up to be performed. | [optional] |
24
+ | **user** | [**UriReference**](UriReference.html) | The PureCloud user for this participant. | [optional] |
25
+ | **queue** | [**UriReference**](UriReference.html) | The PureCloud queue for this participant. | [optional] |
26
+ | **attributes** | **Hash<String, String>** | A list of ad-hoc attributes for the participant. | [optional] |
27
+ | **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
28
+ | **script** | [**UriReference**](UriReference.html) | The Engage script that should be used by this participant. | [optional] |
29
+ | **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
30
+ | **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
31
+ | **provider** | **String** | The source provider for the communication. | [optional] |
32
+ | **external_contact** | [**UriReference**](UriReference.html) | If this participant represents an external contact, then this will be the reference for the external contact. | [optional] |
33
+ | **external_organization** | [**UriReference**](UriReference.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
34
+ | **wrapup** | [**Wrapup**](Wrapup.html) | Wrapup for this participant, if it has been applied. | [optional] |
35
+ | **peer** | **String** | The peer communication corresponding to a matching leg for this communication. | [optional] |
36
+ | **to_address** | [**Address**](Address.html) | Address for the participant on receiving side of the message conversation. If the address is a phone number, E.164 format is recommended. | [optional] |
37
+ | **from_address** | [**Address**](Address.html) | Address for the participant on the sending side of the message conversation. If the address is a phone number, E.164 format is recommended. | [optional] |
38
+ | **messages** | [**Array<MessageDetails>**](MessageDetails.html) | Message instance details on the communication. | [optional] |
39
+ | **type** | **String** | Indicates the type of message platform from which the message originated. | [optional] |
40
+ | **recipient_country** | **String** | Indicates the country where the recipient is associated in ISO 3166-1 alpha-2 format. | [optional] |
41
+ | **recipient_type** | **String** | The type of the recipient. Eg: Provisioned phoneNumber is the recipient for sms message type. | [optional] |
42
+ {: class="table table-striped"}
43
+
44
+
@@ -17,8 +17,8 @@ title: Question
17
17
  | **answer_options** | [**Array<AnswerOption>**](AnswerOption.html) | Options from which to choose an answer for this question. Only used by Multiple Choice type questions. | [optional] |
18
18
  | **max_response_characters** | **Integer** | How many characters are allowed in the text response to this question. Used by NPS and Free Text question types. | [optional] |
19
19
  | **explanation_prompt** | **String** | Prompt for details explaining the chosen NPS score. Used by NPS questions. | [optional] |
20
- | **is_kill** | **BOOLEAN** | | [optional] |
21
20
  | **is_critical** | **BOOLEAN** | | [optional] |
21
+ | **is_kill** | **BOOLEAN** | | [optional] |
22
22
  {: class="table table-striped"}
23
23
 
24
24
 
@@ -0,0 +1,20 @@
1
+ ---
2
+ title: Recipient
3
+ ---
4
+ ## PureCloud::Recipient
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ | **flow** | [**Flow**](Flow.html) | An automate flow object which defines the set of actions to be taken, when a message is received by this provisioned phone number. | [optional] |
13
+ | **date_created** | **DateTime** | Date this recipient was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **date_modified** | **DateTime** | Date this recipient was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
+ | **created_by** | [**User**](User.html) | User that created this recipient | [optional] |
16
+ | **modified_by** | [**User**](User.html) | User that modified this recipient | [optional] |
17
+ | **self_uri** | **String** | The URI for this object | [optional] |
18
+ {: class="table table-striped"}
19
+
20
+
@@ -0,0 +1,22 @@
1
+ ---
2
+ title: RecipientListing
3
+ ---
4
+ ## PureCloud::RecipientListing
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **entities** | [**Array<Recipient>**](Recipient.html) | | [optional] |
11
+ | **page_size** | **Integer** | | [optional] |
12
+ | **page_number** | **Integer** | | [optional] |
13
+ | **total** | **Integer** | | [optional] |
14
+ | **self_uri** | **String** | | [optional] |
15
+ | **first_uri** | **String** | | [optional] |
16
+ | **previous_uri** | **String** | | [optional] |
17
+ | **next_uri** | **String** | | [optional] |
18
+ | **last_uri** | **String** | | [optional] |
19
+ | **page_count** | **Integer** | | [optional] |
20
+ {: class="table table-striped"}
21
+
22
+
@@ -14,6 +14,7 @@ Method | Description
14
14
  [**delete_routing_queue_user**](RoutingApi.html#delete_routing_queue_user) | Delete queue member
15
15
  [**delete_routing_queue_wrapupcode**](RoutingApi.html#delete_routing_queue_wrapupcode) | Delete a wrap-up code from a queue
16
16
  [**delete_routing_skill**](RoutingApi.html#delete_routing_skill) | Delete Routing Skill
17
+ [**delete_routing_sms_phonenumber**](RoutingApi.html#delete_routing_sms_phonenumber) | Delete a phone number provisioned for SMS.
17
18
  [**delete_routing_utilization**](RoutingApi.html#delete_routing_utilization) | Delete utilization settings and revert to system defaults.
18
19
  [**delete_routing_wrapupcode**](RoutingApi.html#delete_routing_wrapupcode) | Delete wrap-up code
19
20
  [**delete_user_routingskill**](RoutingApi.html#delete_user_routingskill) | Remove routing skill from user
@@ -23,6 +24,8 @@ Method | Description
23
24
  [**get_routing_email_domains**](RoutingApi.html#get_routing_email_domains) | Get domains
24
25
  [**get_routing_email_setup**](RoutingApi.html#get_routing_email_setup) | Get email setup
25
26
  [**get_routing_languages**](RoutingApi.html#get_routing_languages) | Get the list of supported languages.
27
+ [**get_routing_message_recipient**](RoutingApi.html#get_routing_message_recipient) | Get a recipient
28
+ [**get_routing_message_recipients**](RoutingApi.html#get_routing_message_recipients) | Get recipients
26
29
  [**get_routing_queue**](RoutingApi.html#get_routing_queue) | Get details about this queue.
27
30
  [**get_routing_queue_estimatedwaittime**](RoutingApi.html#get_routing_queue_estimatedwaittime) | Get Estimated Wait Time
28
31
  [**get_routing_queue_mediatype_estimatedwaittime**](RoutingApi.html#get_routing_queue_mediatype_estimatedwaittime) | Get Estimated Wait Time
@@ -31,6 +34,9 @@ Method | Description
31
34
  [**get_routing_queues**](RoutingApi.html#get_routing_queues) | Get list of queues.
32
35
  [**get_routing_skill**](RoutingApi.html#get_routing_skill) | Get Routing Skill
33
36
  [**get_routing_skills**](RoutingApi.html#get_routing_skills) | Get the list of routing skills.
37
+ [**get_routing_sms_availablephonenumbers**](RoutingApi.html#get_routing_sms_availablephonenumbers) | Get a list of available phone numbers for SMS provisioning.
38
+ [**get_routing_sms_phonenumber**](RoutingApi.html#get_routing_sms_phonenumber) | Get a phone number provisioned for SMS.
39
+ [**get_routing_sms_phonenumbers**](RoutingApi.html#get_routing_sms_phonenumbers) | Get a list of provisioned phone numbers.
34
40
  [**get_routing_utilization**](RoutingApi.html#get_routing_utilization) | Get the utilization settings.
35
41
  [**get_routing_wrapupcode**](RoutingApi.html#get_routing_wrapupcode) | Get details about this wrap-up code.
36
42
  [**get_routing_wrapupcodes**](RoutingApi.html#get_routing_wrapupcodes) | Get list of wrapup codes.
@@ -45,10 +51,14 @@ Method | Description
45
51
  [**post_routing_queue_wrapupcodes**](RoutingApi.html#post_routing_queue_wrapupcodes) | Add up to 100 wrap-up codes to a queue
46
52
  [**post_routing_queues**](RoutingApi.html#post_routing_queues) | Create queue
47
53
  [**post_routing_skills**](RoutingApi.html#post_routing_skills) | Create Skill
54
+ [**post_routing_sms_addresses**](RoutingApi.html#post_routing_sms_addresses) | Provision an Address for SMS
55
+ [**post_routing_sms_phonenumbers**](RoutingApi.html#post_routing_sms_phonenumbers) | Provision a phone number for SMS
48
56
  [**post_routing_wrapupcodes**](RoutingApi.html#post_routing_wrapupcodes) | Create a wrap-up code
49
57
  [**post_user_routingskills**](RoutingApi.html#post_user_routingskills) | Add routing skill to user
50
58
  [**put_routing_email_domain_route**](RoutingApi.html#put_routing_email_domain_route) | Update a route
59
+ [**put_routing_message_recipient**](RoutingApi.html#put_routing_message_recipient) | Update a recipient
51
60
  [**put_routing_queue**](RoutingApi.html#put_routing_queue) | Update a queue
61
+ [**put_routing_sms_phonenumber**](RoutingApi.html#put_routing_sms_phonenumber) | Update a phone number provisioned for SMS.
52
62
  [**put_routing_utilization**](RoutingApi.html#put_routing_utilization) | Update the utilization settings.
53
63
  [**put_routing_wrapupcode**](RoutingApi.html#put_routing_wrapupcode) | Update wrap-up code
54
64
  [**put_user_routingskill**](RoutingApi.html#put_user_routingskill) | Update routing skill proficiency or state.
@@ -415,6 +425,64 @@ nil (empty response body)
415
425
 
416
426
 
417
427
 
428
+ <a name="delete_routing_sms_phonenumber"></a>
429
+
430
+ ## - delete_routing_sms_phonenumber(address_id)
431
+
432
+ Delete a phone number provisioned for SMS.
433
+
434
+
435
+
436
+ Wraps DELETE /api/v2/routing/sms/phonenumbers/{addressId}
437
+
438
+
439
+ ### Example
440
+ ~~~ruby
441
+ # load the gem
442
+ require 'purecloudplatformclientv2'
443
+ # setup authorization
444
+ @secret = ENV['PURECLOUD_SECRET']
445
+ @id = ENV['PURECLOUD_CLIENT_ID']
446
+ environment = "mypurecloud.com"
447
+
448
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
449
+
450
+ PureCloud.configure do |config|
451
+ config.access_token = @authToken
452
+ end
453
+
454
+ api_instance = PureCloud::RoutingApi.new
455
+
456
+ address_id = "address_id_example" # String | Address ID
457
+
458
+
459
+ begin
460
+ #Delete a phone number provisioned for SMS.
461
+ api_instance.delete_routing_sms_phonenumber(address_id)
462
+ rescue PureCloud::ApiError => e
463
+ puts "Exception when calling RoutingApi->delete_routing_sms_phonenumber: #{e}"
464
+ end
465
+ ~~~
466
+
467
+ ### Parameters
468
+
469
+ Name | Type | Description | Notes
470
+ ------------- | ------------- | ------------- | -------------
471
+ **address_id** | **String**| Address ID | |
472
+ {: class="table table-striped"}
473
+
474
+
475
+ ### Return type
476
+
477
+ nil (empty response body)
478
+
479
+ ### HTTP request headers
480
+
481
+ - **Content-Type**: application/json
482
+ - **Accept**: application/json
483
+
484
+
485
+
418
486
  <a name="delete_routing_utilization"></a>
419
487
 
420
488
  ## - delete_routing_utilization
@@ -946,6 +1014,127 @@ Name | Type | Description | Notes
946
1014
 
947
1015
 
948
1016
 
1017
+ <a name="get_routing_message_recipient"></a>
1018
+
1019
+ ## -[**Recipient**](Recipient.html) get_routing_message_recipient(recipient_id)
1020
+
1021
+ Get a recipient
1022
+
1023
+
1024
+
1025
+ Wraps GET /api/v2/routing/message/recipients/{recipientId}
1026
+
1027
+
1028
+ ### Example
1029
+ ~~~ruby
1030
+ # load the gem
1031
+ require 'purecloudplatformclientv2'
1032
+ # setup authorization
1033
+ @secret = ENV['PURECLOUD_SECRET']
1034
+ @id = ENV['PURECLOUD_CLIENT_ID']
1035
+ environment = "mypurecloud.com"
1036
+
1037
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1038
+
1039
+ PureCloud.configure do |config|
1040
+ config.access_token = @authToken
1041
+ end
1042
+
1043
+ api_instance = PureCloud::RoutingApi.new
1044
+
1045
+ recipient_id = "recipient_id_example" # String | Recipient ID
1046
+
1047
+
1048
+ begin
1049
+ #Get a recipient
1050
+ result = api_instance.get_routing_message_recipient(recipient_id)
1051
+ p result
1052
+ rescue PureCloud::ApiError => e
1053
+ puts "Exception when calling RoutingApi->get_routing_message_recipient: #{e}"
1054
+ end
1055
+ ~~~
1056
+
1057
+ ### Parameters
1058
+
1059
+ Name | Type | Description | Notes
1060
+ ------------- | ------------- | ------------- | -------------
1061
+ **recipient_id** | **String**| Recipient ID | |
1062
+ {: class="table table-striped"}
1063
+
1064
+
1065
+ ### Return type
1066
+
1067
+ [**Recipient**](Recipient.html)
1068
+
1069
+ ### HTTP request headers
1070
+
1071
+ - **Content-Type**: application/json
1072
+ - **Accept**: application/json
1073
+
1074
+
1075
+
1076
+ <a name="get_routing_message_recipients"></a>
1077
+
1078
+ ## -[**RecipientListing**](RecipientListing.html) get_routing_message_recipients(opts)
1079
+
1080
+ Get recipients
1081
+
1082
+
1083
+
1084
+ Wraps GET /api/v2/routing/message/recipients
1085
+
1086
+
1087
+ ### Example
1088
+ ~~~ruby
1089
+ # load the gem
1090
+ require 'purecloudplatformclientv2'
1091
+ # setup authorization
1092
+ @secret = ENV['PURECLOUD_SECRET']
1093
+ @id = ENV['PURECLOUD_CLIENT_ID']
1094
+ environment = "mypurecloud.com"
1095
+
1096
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1097
+
1098
+ PureCloud.configure do |config|
1099
+ config.access_token = @authToken
1100
+ end
1101
+
1102
+ api_instance = PureCloud::RoutingApi.new
1103
+
1104
+ opts = {
1105
+ page_size: 25, # Integer | Page size
1106
+ page_number: 1 # Integer | Page number
1107
+ }
1108
+
1109
+ begin
1110
+ #Get recipients
1111
+ result = api_instance.get_routing_message_recipients(opts)
1112
+ p result
1113
+ rescue PureCloud::ApiError => e
1114
+ puts "Exception when calling RoutingApi->get_routing_message_recipients: #{e}"
1115
+ end
1116
+ ~~~
1117
+
1118
+ ### Parameters
1119
+
1120
+ Name | Type | Description | Notes
1121
+ ------------- | ------------- | ------------- | -------------
1122
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
1123
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1124
+ {: class="table table-striped"}
1125
+
1126
+
1127
+ ### Return type
1128
+
1129
+ [**RecipientListing**](RecipientListing.html)
1130
+
1131
+ ### HTTP request headers
1132
+
1133
+ - **Content-Type**: application/json
1134
+ - **Accept**: application/json
1135
+
1136
+
1137
+
949
1138
  <a name="get_routing_queue"></a>
950
1139
 
951
1140
  ## -[**Queue**](Queue.html) get_routing_queue(queue_id)
@@ -1463,6 +1652,207 @@ Name | Type | Description | Notes
1463
1652
 
1464
1653
 
1465
1654
 
1655
+ <a name="get_routing_sms_availablephonenumbers"></a>
1656
+
1657
+ ## -[**SMSAvailablePhoneNumberEntityListing**](SMSAvailablePhoneNumberEntityListing.html) get_routing_sms_availablephonenumbers(country_code, phone_number_type, opts)
1658
+
1659
+ Get a list of available phone numbers for SMS provisioning.
1660
+
1661
+ This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.
1662
+
1663
+ Wraps GET /api/v2/routing/sms/availablephonenumbers
1664
+
1665
+
1666
+ ### Example
1667
+ ~~~ruby
1668
+ # load the gem
1669
+ require 'purecloudplatformclientv2'
1670
+ # setup authorization
1671
+ @secret = ENV['PURECLOUD_SECRET']
1672
+ @id = ENV['PURECLOUD_CLIENT_ID']
1673
+ environment = "mypurecloud.com"
1674
+
1675
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1676
+
1677
+ PureCloud.configure do |config|
1678
+ config.access_token = @authToken
1679
+ end
1680
+
1681
+ api_instance = PureCloud::RoutingApi.new
1682
+
1683
+ country_code = "country_code_example" # String | The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned
1684
+
1685
+ phone_number_type = "phone_number_type_example" # String | Type of available phone numbers searched
1686
+
1687
+ opts = {
1688
+ region: "region_example", # String | Region/province/state that can be used to restrict the numbers returned
1689
+ city: "city_example", # String | City that can be used to restrict the numbers returned
1690
+ area_code: "area_code_example", # String | Area code that can be used to restrict the numbers returned
1691
+ pattern: "pattern_example", # String | A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit.
1692
+ address_requirement: "address_requirement_example" # String | This indicates whether the phone number requires to have an Address registered.
1693
+ }
1694
+
1695
+ begin
1696
+ #Get a list of available phone numbers for SMS provisioning.
1697
+ result = api_instance.get_routing_sms_availablephonenumbers(country_code, phone_number_type, opts)
1698
+ p result
1699
+ rescue PureCloud::ApiError => e
1700
+ puts "Exception when calling RoutingApi->get_routing_sms_availablephonenumbers: #{e}"
1701
+ end
1702
+ ~~~
1703
+
1704
+ ### Parameters
1705
+
1706
+ Name | Type | Description | Notes
1707
+ ------------- | ------------- | ------------- | -------------
1708
+ **country_code** | **String**| The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned | |
1709
+ **phone_number_type** | **String**| Type of available phone numbers searched | <br />**Values**: local, mobile, tollfree |
1710
+ **region** | **String**| Region/province/state that can be used to restrict the numbers returned | [optional] |
1711
+ **city** | **String**| City that can be used to restrict the numbers returned | [optional] |
1712
+ **area_code** | **String**| Area code that can be used to restrict the numbers returned | [optional] |
1713
+ **pattern** | **String**| A pattern to match phone numbers. Valid characters are &#39;*&#39; and [0-9a-zA-Z]. The &#39;*&#39; character will match any single digit. | [optional] |
1714
+ **address_requirement** | **String**| This indicates whether the phone number requires to have an Address registered. | [optional] <br />**Values**: none, any, local, foreign |
1715
+ {: class="table table-striped"}
1716
+
1717
+
1718
+ ### Return type
1719
+
1720
+ [**SMSAvailablePhoneNumberEntityListing**](SMSAvailablePhoneNumberEntityListing.html)
1721
+
1722
+ ### HTTP request headers
1723
+
1724
+ - **Content-Type**: application/json
1725
+ - **Accept**: application/json
1726
+
1727
+
1728
+
1729
+ <a name="get_routing_sms_phonenumber"></a>
1730
+
1731
+ ## -[**SmsPhoneNumber**](SmsPhoneNumber.html) get_routing_sms_phonenumber(address_id)
1732
+
1733
+ Get a phone number provisioned for SMS.
1734
+
1735
+
1736
+
1737
+ Wraps GET /api/v2/routing/sms/phonenumbers/{addressId}
1738
+
1739
+
1740
+ ### Example
1741
+ ~~~ruby
1742
+ # load the gem
1743
+ require 'purecloudplatformclientv2'
1744
+ # setup authorization
1745
+ @secret = ENV['PURECLOUD_SECRET']
1746
+ @id = ENV['PURECLOUD_CLIENT_ID']
1747
+ environment = "mypurecloud.com"
1748
+
1749
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1750
+
1751
+ PureCloud.configure do |config|
1752
+ config.access_token = @authToken
1753
+ end
1754
+
1755
+ api_instance = PureCloud::RoutingApi.new
1756
+
1757
+ address_id = "address_id_example" # String | Address ID
1758
+
1759
+
1760
+ begin
1761
+ #Get a phone number provisioned for SMS.
1762
+ result = api_instance.get_routing_sms_phonenumber(address_id)
1763
+ p result
1764
+ rescue PureCloud::ApiError => e
1765
+ puts "Exception when calling RoutingApi->get_routing_sms_phonenumber: #{e}"
1766
+ end
1767
+ ~~~
1768
+
1769
+ ### Parameters
1770
+
1771
+ Name | Type | Description | Notes
1772
+ ------------- | ------------- | ------------- | -------------
1773
+ **address_id** | **String**| Address ID | |
1774
+ {: class="table table-striped"}
1775
+
1776
+
1777
+ ### Return type
1778
+
1779
+ [**SmsPhoneNumber**](SmsPhoneNumber.html)
1780
+
1781
+ ### HTTP request headers
1782
+
1783
+ - **Content-Type**: application/json
1784
+ - **Accept**: application/json
1785
+
1786
+
1787
+
1788
+ <a name="get_routing_sms_phonenumbers"></a>
1789
+
1790
+ ## -[**SmsPhoneNumberEntityListing**](SmsPhoneNumberEntityListing.html) get_routing_sms_phonenumbers(opts)
1791
+
1792
+ Get a list of provisioned phone numbers.
1793
+
1794
+
1795
+
1796
+ Wraps GET /api/v2/routing/sms/phonenumbers
1797
+
1798
+
1799
+ ### Example
1800
+ ~~~ruby
1801
+ # load the gem
1802
+ require 'purecloudplatformclientv2'
1803
+ # setup authorization
1804
+ @secret = ENV['PURECLOUD_SECRET']
1805
+ @id = ENV['PURECLOUD_CLIENT_ID']
1806
+ environment = "mypurecloud.com"
1807
+
1808
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1809
+
1810
+ PureCloud.configure do |config|
1811
+ config.access_token = @authToken
1812
+ end
1813
+
1814
+ api_instance = PureCloud::RoutingApi.new
1815
+
1816
+ opts = {
1817
+ phone_number: "phone_number_example", # String | 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.
1818
+ phone_number_type: "phone_number_type_example", # String | Filter on phone number type
1819
+ phone_number_status: "phone_number_status_example", # String | Filter on phone number status
1820
+ page_size: 25, # Integer | Page size
1821
+ page_number: 1 # Integer | Page number
1822
+ }
1823
+
1824
+ begin
1825
+ #Get a list of provisioned phone numbers.
1826
+ result = api_instance.get_routing_sms_phonenumbers(opts)
1827
+ p result
1828
+ rescue PureCloud::ApiError => e
1829
+ puts "Exception when calling RoutingApi->get_routing_sms_phonenumbers: #{e}"
1830
+ end
1831
+ ~~~
1832
+
1833
+ ### Parameters
1834
+
1835
+ Name | Type | Description | Notes
1836
+ ------------- | ------------- | ------------- | -------------
1837
+ **phone_number** | **String**| Filter on phone number address. Allowable characters are the digits &#39;0-9&#39; and the wild card character &#39;\\*&#39;. If just digits are present, a contains search is done on the address pattern. For example, &#39;317&#39; could be matched anywhere in the address. An &#39;\\*&#39; will match multiple digits. For example, to match a specific area code within the US a pattern like &#39;1317*&#39; could be used. | [optional] |
1838
+ **phone_number_type** | **String**| Filter on phone number type | [optional] <br />**Values**: local, mobile, tollfree |
1839
+ **phone_number_status** | **String**| Filter on phone number status | [optional] <br />**Values**: active, invalid, porting |
1840
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
1841
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
1842
+ {: class="table table-striped"}
1843
+
1844
+
1845
+ ### Return type
1846
+
1847
+ [**SmsPhoneNumberEntityListing**](SmsPhoneNumberEntityListing.html)
1848
+
1849
+ ### HTTP request headers
1850
+
1851
+ - **Content-Type**: application/json
1852
+ - **Accept**: application/json
1853
+
1854
+
1855
+
1466
1856
  <a name="get_routing_utilization"></a>
1467
1857
 
1468
1858
  ## -[**Utilization**](Utilization.html) get_routing_utilization
@@ -2320,6 +2710,124 @@ Name | Type | Description | Notes
2320
2710
 
2321
2711
 
2322
2712
 
2713
+ <a name="post_routing_sms_addresses"></a>
2714
+
2715
+ ## -[**SmsPhoneNumber**](SmsPhoneNumber.html) post_routing_sms_addresses(body)
2716
+
2717
+ Provision an Address for SMS
2718
+
2719
+
2720
+
2721
+ Wraps POST /api/v2/routing/sms/addresses
2722
+
2723
+
2724
+ ### Example
2725
+ ~~~ruby
2726
+ # load the gem
2727
+ require 'purecloudplatformclientv2'
2728
+ # setup authorization
2729
+ @secret = ENV['PURECLOUD_SECRET']
2730
+ @id = ENV['PURECLOUD_CLIENT_ID']
2731
+ environment = "mypurecloud.com"
2732
+
2733
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2734
+
2735
+ PureCloud.configure do |config|
2736
+ config.access_token = @authToken
2737
+ end
2738
+
2739
+ api_instance = PureCloud::RoutingApi.new
2740
+
2741
+ body = PureCloud::SmsAddressProvision.new # SmsAddressProvision | SmsAddress
2742
+
2743
+
2744
+ begin
2745
+ #Provision an Address for SMS
2746
+ result = api_instance.post_routing_sms_addresses(body)
2747
+ p result
2748
+ rescue PureCloud::ApiError => e
2749
+ puts "Exception when calling RoutingApi->post_routing_sms_addresses: #{e}"
2750
+ end
2751
+ ~~~
2752
+
2753
+ ### Parameters
2754
+
2755
+ Name | Type | Description | Notes
2756
+ ------------- | ------------- | ------------- | -------------
2757
+ **body** | [**SmsAddressProvision**](SmsAddressProvision.html)| SmsAddress | |
2758
+ {: class="table table-striped"}
2759
+
2760
+
2761
+ ### Return type
2762
+
2763
+ [**SmsPhoneNumber**](SmsPhoneNumber.html)
2764
+
2765
+ ### HTTP request headers
2766
+
2767
+ - **Content-Type**: application/json
2768
+ - **Accept**: application/json
2769
+
2770
+
2771
+
2772
+ <a name="post_routing_sms_phonenumbers"></a>
2773
+
2774
+ ## -[**SmsPhoneNumber**](SmsPhoneNumber.html) post_routing_sms_phonenumbers(body)
2775
+
2776
+ Provision a phone number for SMS
2777
+
2778
+
2779
+
2780
+ Wraps POST /api/v2/routing/sms/phonenumbers
2781
+
2782
+
2783
+ ### Example
2784
+ ~~~ruby
2785
+ # load the gem
2786
+ require 'purecloudplatformclientv2'
2787
+ # setup authorization
2788
+ @secret = ENV['PURECLOUD_SECRET']
2789
+ @id = ENV['PURECLOUD_CLIENT_ID']
2790
+ environment = "mypurecloud.com"
2791
+
2792
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
2793
+
2794
+ PureCloud.configure do |config|
2795
+ config.access_token = @authToken
2796
+ end
2797
+
2798
+ api_instance = PureCloud::RoutingApi.new
2799
+
2800
+ body = PureCloud::SmsPhoneNumberProvision.new # SmsPhoneNumberProvision | SmsPhoneNumber
2801
+
2802
+
2803
+ begin
2804
+ #Provision a phone number for SMS
2805
+ result = api_instance.post_routing_sms_phonenumbers(body)
2806
+ p result
2807
+ rescue PureCloud::ApiError => e
2808
+ puts "Exception when calling RoutingApi->post_routing_sms_phonenumbers: #{e}"
2809
+ end
2810
+ ~~~
2811
+
2812
+ ### Parameters
2813
+
2814
+ Name | Type | Description | Notes
2815
+ ------------- | ------------- | ------------- | -------------
2816
+ **body** | [**SmsPhoneNumberProvision**](SmsPhoneNumberProvision.html)| SmsPhoneNumber | |
2817
+ {: class="table table-striped"}
2818
+
2819
+
2820
+ ### Return type
2821
+
2822
+ [**SmsPhoneNumber**](SmsPhoneNumber.html)
2823
+
2824
+ ### HTTP request headers
2825
+
2826
+ - **Content-Type**: application/json
2827
+ - **Accept**: application/json
2828
+
2829
+
2830
+
2323
2831
  <a name="post_routing_wrapupcodes"></a>
2324
2832
 
2325
2833
  ## -[**WrapupCode**](WrapupCode.html) post_routing_wrapupcodes(body)
@@ -2506,6 +3014,68 @@ Name | Type | Description | Notes
2506
3014
 
2507
3015
 
2508
3016
 
3017
+ <a name="put_routing_message_recipient"></a>
3018
+
3019
+ ## -[**Recipient**](Recipient.html) put_routing_message_recipient(recipient_id, body)
3020
+
3021
+ Update a recipient
3022
+
3023
+
3024
+
3025
+ Wraps PUT /api/v2/routing/message/recipients/{recipientId}
3026
+
3027
+
3028
+ ### Example
3029
+ ~~~ruby
3030
+ # load the gem
3031
+ require 'purecloudplatformclientv2'
3032
+ # setup authorization
3033
+ @secret = ENV['PURECLOUD_SECRET']
3034
+ @id = ENV['PURECLOUD_CLIENT_ID']
3035
+ environment = "mypurecloud.com"
3036
+
3037
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3038
+
3039
+ PureCloud.configure do |config|
3040
+ config.access_token = @authToken
3041
+ end
3042
+
3043
+ api_instance = PureCloud::RoutingApi.new
3044
+
3045
+ recipient_id = "recipient_id_example" # String | Recipient ID
3046
+
3047
+ body = PureCloud::Recipient.new # Recipient | Recipient
3048
+
3049
+
3050
+ begin
3051
+ #Update a recipient
3052
+ result = api_instance.put_routing_message_recipient(recipient_id, body)
3053
+ p result
3054
+ rescue PureCloud::ApiError => e
3055
+ puts "Exception when calling RoutingApi->put_routing_message_recipient: #{e}"
3056
+ end
3057
+ ~~~
3058
+
3059
+ ### Parameters
3060
+
3061
+ Name | Type | Description | Notes
3062
+ ------------- | ------------- | ------------- | -------------
3063
+ **recipient_id** | **String**| Recipient ID | |
3064
+ **body** | [**Recipient**](Recipient.html)| Recipient | |
3065
+ {: class="table table-striped"}
3066
+
3067
+
3068
+ ### Return type
3069
+
3070
+ [**Recipient**](Recipient.html)
3071
+
3072
+ ### HTTP request headers
3073
+
3074
+ - **Content-Type**: application/json
3075
+ - **Accept**: application/json
3076
+
3077
+
3078
+
2509
3079
  <a name="put_routing_queue"></a>
2510
3080
 
2511
3081
  ## -[**Queue**](Queue.html) put_routing_queue(queue_id, body)
@@ -2568,6 +3138,68 @@ Name | Type | Description | Notes
2568
3138
 
2569
3139
 
2570
3140
 
3141
+ <a name="put_routing_sms_phonenumber"></a>
3142
+
3143
+ ## -[**SmsPhoneNumber**](SmsPhoneNumber.html) put_routing_sms_phonenumber(address_id, body)
3144
+
3145
+ Update a phone number provisioned for SMS.
3146
+
3147
+
3148
+
3149
+ Wraps PUT /api/v2/routing/sms/phonenumbers/{addressId}
3150
+
3151
+
3152
+ ### Example
3153
+ ~~~ruby
3154
+ # load the gem
3155
+ require 'purecloudplatformclientv2'
3156
+ # setup authorization
3157
+ @secret = ENV['PURECLOUD_SECRET']
3158
+ @id = ENV['PURECLOUD_CLIENT_ID']
3159
+ environment = "mypurecloud.com"
3160
+
3161
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
3162
+
3163
+ PureCloud.configure do |config|
3164
+ config.access_token = @authToken
3165
+ end
3166
+
3167
+ api_instance = PureCloud::RoutingApi.new
3168
+
3169
+ address_id = "address_id_example" # String | Address ID
3170
+
3171
+ body = PureCloud::SmsPhoneNumber.new # SmsPhoneNumber | SmsPhoneNumber
3172
+
3173
+
3174
+ begin
3175
+ #Update a phone number provisioned for SMS.
3176
+ result = api_instance.put_routing_sms_phonenumber(address_id, body)
3177
+ p result
3178
+ rescue PureCloud::ApiError => e
3179
+ puts "Exception when calling RoutingApi->put_routing_sms_phonenumber: #{e}"
3180
+ end
3181
+ ~~~
3182
+
3183
+ ### Parameters
3184
+
3185
+ Name | Type | Description | Notes
3186
+ ------------- | ------------- | ------------- | -------------
3187
+ **address_id** | **String**| Address ID | |
3188
+ **body** | [**SmsPhoneNumber**](SmsPhoneNumber.html)| SmsPhoneNumber | |
3189
+ {: class="table table-striped"}
3190
+
3191
+
3192
+ ### Return type
3193
+
3194
+ [**SmsPhoneNumber**](SmsPhoneNumber.html)
3195
+
3196
+ ### HTTP request headers
3197
+
3198
+ - **Content-Type**: application/json
3199
+ - **Accept**: application/json
3200
+
3201
+
3202
+
2571
3203
  <a name="put_routing_utilization"></a>
2572
3204
 
2573
3205
  ## -[**Utilization**](Utilization.html) put_routing_utilization(body)