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
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SMSAvailablePhoneNumberEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SMSAvailablePhoneNumberEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<SmsAvailablePhoneNumber>**](SmsAvailablePhoneNumber.html) | | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SmsAddressProvision
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SmsAddressProvision
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | Name associated with this address | |
|
|
12
|
+
| **street** | **String** | The number and street address where this address is located. | |
|
|
13
|
+
| **city** | **String** | The city in which this address is in | |
|
|
14
|
+
| **region** | **String** | The state or region this address is in | |
|
|
15
|
+
| **postal_code** | **String** | The postal code this address is in | |
|
|
16
|
+
| **country_code** | **String** | The ISO country code of this address | |
|
|
17
|
+
| **auto_correct_address** | **BOOLEAN** | This is used when the address is created. If the value is not set or true, then the system will, if necessary, auto-correct the address you provide. Set this value to false if the system should not auto-correct the address. | [optional] |
|
|
18
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
19
|
+
{: class="table table-striped"}
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SmsAvailablePhoneNumber
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SmsAvailablePhoneNumber
|
|
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
|
+
| **phone_number** | **String** | A phone number available for provisioning in E.164 format. E.g. +13175555555 or +34234234234 | [optional] |
|
|
13
|
+
| **country_code** | **String** | The ISO 3166-1 alpha-2 country code of the country this phone number is associated with. | [optional] |
|
|
14
|
+
| **region** | **String** | The region/province/state the phone number is associated with. | [optional] |
|
|
15
|
+
| **city** | **String** | The city the phone number is associated with. | [optional] |
|
|
16
|
+
| **capabilities** | **Array<String>** | The capabilities of the phone number available for provisioning. | [optional] |
|
|
17
|
+
| **phone_number_type** | **String** | The type of phone number available for provisioning. | [optional] |
|
|
18
|
+
| **address_requirement** | **String** | The address requirement needed for provisioning this number. If there is a requirement, the address must be the residence or place of business of the individual or entity using the phone number. | [optional] |
|
|
19
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SmsPhoneNumber
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SmsPhoneNumber
|
|
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
|
+
| **phone_number** | **String** | A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234 | |
|
|
13
|
+
| **phone_number_type** | **String** | Type of the phone number provisioned. | [optional] |
|
|
14
|
+
| **provisioned_through_pure_cloud** | **BOOLEAN** | Is set to false, if the phone number is provisioned through a SMS provider, outside of PureCloud | [optional] |
|
|
15
|
+
| **phone_number_status** | **String** | Status of the provisioned phone number. | [optional] |
|
|
16
|
+
| **country_code** | **String** | The ISO 3166-1 alpha-2 country code of the country this phone number is associated with. | [optional] |
|
|
17
|
+
| **date_created** | **DateTime** | Date this phone number was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
18
|
+
| **date_modified** | **DateTime** | Date this phone number was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
19
|
+
| **created_by** | [**User**](User.html) | User that provisioned this phone number | [optional] |
|
|
20
|
+
| **modified_by** | [**User**](User.html) | User that last modified this phone number | [optional] |
|
|
21
|
+
| **version** | **Integer** | Version number required for updates. | [optional] |
|
|
22
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
23
|
+
{: class="table table-striped"}
|
|
24
|
+
|
|
25
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SmsPhoneNumberEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SmsPhoneNumberEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<SmsPhoneNumber>**](SmsPhoneNumber.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,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: SmsPhoneNumberProvision
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::SmsPhoneNumberProvision
|
|
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
|
+
| **phone_number** | **String** | A phone number to be used for SMS communications. E.g. +13175555555 or +34234234234 | |
|
|
13
|
+
| **phone_number_type** | **String** | Type of the phone number provisioned. | |
|
|
14
|
+
| **country_code** | **String** | The ISO 3166-1 alpha-2 country code of the country this phone number is associated with. | |
|
|
15
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: TextMessageListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::TextMessageListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<MessageData>**](MessageData.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
|
+
|
|
@@ -34,6 +34,7 @@ require 'purecloudplatformclientv2/models/active_alert_count'
|
|
|
34
34
|
require 'purecloudplatformclientv2/models/activity_code'
|
|
35
35
|
require 'purecloudplatformclientv2/models/activity_code_container'
|
|
36
36
|
require 'purecloudplatformclientv2/models/acw_settings'
|
|
37
|
+
require 'purecloudplatformclientv2/models/additional_message'
|
|
37
38
|
require 'purecloudplatformclientv2/models/address'
|
|
38
39
|
require 'purecloudplatformclientv2/models/addressable_entity_user'
|
|
39
40
|
require 'purecloudplatformclientv2/models/addressable_license_definition'
|
|
@@ -302,6 +303,7 @@ require 'purecloudplatformclientv2/models/conversation_chat'
|
|
|
302
303
|
require 'purecloudplatformclientv2/models/conversation_entity_listing'
|
|
303
304
|
require 'purecloudplatformclientv2/models/conversation_notification'
|
|
304
305
|
require 'purecloudplatformclientv2/models/conversation_notification_address'
|
|
306
|
+
require 'purecloudplatformclientv2/models/conversation_notification_attachment'
|
|
305
307
|
require 'purecloudplatformclientv2/models/conversation_notification_call'
|
|
306
308
|
require 'purecloudplatformclientv2/models/conversation_notification_callback'
|
|
307
309
|
require 'purecloudplatformclientv2/models/conversation_notification_callbacks'
|
|
@@ -313,6 +315,7 @@ require 'purecloudplatformclientv2/models/conversation_notification_cobrowsesess
|
|
|
313
315
|
require 'purecloudplatformclientv2/models/conversation_notification_dialer_preview'
|
|
314
316
|
require 'purecloudplatformclientv2/models/conversation_notification_disconnect_reason'
|
|
315
317
|
require 'purecloudplatformclientv2/models/conversation_notification_disconnect_reasons'
|
|
318
|
+
require 'purecloudplatformclientv2/models/conversation_notification_draft_attachments'
|
|
316
319
|
require 'purecloudplatformclientv2/models/conversation_notification_email'
|
|
317
320
|
require 'purecloudplatformclientv2/models/conversation_notification_emails'
|
|
318
321
|
require 'purecloudplatformclientv2/models/conversation_notification_error_details'
|
|
@@ -359,6 +362,9 @@ require 'purecloudplatformclientv2/models/did'
|
|
|
359
362
|
require 'purecloudplatformclientv2/models/did_entity_listing'
|
|
360
363
|
require 'purecloudplatformclientv2/models/did_pool'
|
|
361
364
|
require 'purecloudplatformclientv2/models/did_pool_entity_listing'
|
|
365
|
+
require 'purecloudplatformclientv2/models/data_table'
|
|
366
|
+
require 'purecloudplatformclientv2/models/data_table_row_entity_listing'
|
|
367
|
+
require 'purecloudplatformclientv2/models/data_tables_domain_entity_listing'
|
|
362
368
|
require 'purecloudplatformclientv2/models/default_greeting_list'
|
|
363
369
|
require 'purecloudplatformclientv2/models/delete_retention'
|
|
364
370
|
require 'purecloudplatformclientv2/models/dependency'
|
|
@@ -468,6 +474,7 @@ require 'purecloudplatformclientv2/models/email_attachment'
|
|
|
468
474
|
require 'purecloudplatformclientv2/models/email_conversation'
|
|
469
475
|
require 'purecloudplatformclientv2/models/email_conversation_entity_listing'
|
|
470
476
|
require 'purecloudplatformclientv2/models/email_conversation_notification'
|
|
477
|
+
require 'purecloudplatformclientv2/models/email_conversation_notification_attachment'
|
|
471
478
|
require 'purecloudplatformclientv2/models/email_conversation_notification_detail'
|
|
472
479
|
require 'purecloudplatformclientv2/models/email_conversation_notification_email_media_participant'
|
|
473
480
|
require 'purecloudplatformclientv2/models/email_conversation_notification_error_body'
|
|
@@ -675,6 +682,8 @@ require 'purecloudplatformclientv2/models/media_summary_detail'
|
|
|
675
682
|
require 'purecloudplatformclientv2/models/media_transcription'
|
|
676
683
|
require 'purecloudplatformclientv2/models/member_entity'
|
|
677
684
|
require 'purecloudplatformclientv2/models/message'
|
|
685
|
+
require 'purecloudplatformclientv2/models/message_conversation'
|
|
686
|
+
require 'purecloudplatformclientv2/models/message_conversation_entity_listing'
|
|
678
687
|
require 'purecloudplatformclientv2/models/message_conversation_notification'
|
|
679
688
|
require 'purecloudplatformclientv2/models/message_conversation_notification_detail'
|
|
680
689
|
require 'purecloudplatformclientv2/models/message_conversation_notification_error_body'
|
|
@@ -686,8 +695,10 @@ require 'purecloudplatformclientv2/models/message_conversation_notification_mess
|
|
|
686
695
|
require 'purecloudplatformclientv2/models/message_conversation_notification_participants'
|
|
687
696
|
require 'purecloudplatformclientv2/models/message_conversation_notification_uri_reference'
|
|
688
697
|
require 'purecloudplatformclientv2/models/message_conversation_notification_wrapup'
|
|
698
|
+
require 'purecloudplatformclientv2/models/message_data'
|
|
689
699
|
require 'purecloudplatformclientv2/models/message_details'
|
|
690
700
|
require 'purecloudplatformclientv2/models/message_media'
|
|
701
|
+
require 'purecloudplatformclientv2/models/message_media_participant'
|
|
691
702
|
require 'purecloudplatformclientv2/models/message_media_policy'
|
|
692
703
|
require 'purecloudplatformclientv2/models/message_media_policy_conditions'
|
|
693
704
|
require 'purecloudplatformclientv2/models/meta_data'
|
|
@@ -809,6 +820,8 @@ require 'purecloudplatformclientv2/models/queue_member_notification'
|
|
|
809
820
|
require 'purecloudplatformclientv2/models/queue_utilization_diagnostic'
|
|
810
821
|
require 'purecloudplatformclientv2/models/reaction'
|
|
811
822
|
require 'purecloudplatformclientv2/models/recall_entry'
|
|
823
|
+
require 'purecloudplatformclientv2/models/recipient'
|
|
824
|
+
require 'purecloudplatformclientv2/models/recipient_listing'
|
|
812
825
|
require 'purecloudplatformclientv2/models/recording'
|
|
813
826
|
require 'purecloudplatformclientv2/models/recording_data_v2_notification'
|
|
814
827
|
require 'purecloudplatformclientv2/models/recording_data_v2_notification_conversation_data'
|
|
@@ -866,6 +879,7 @@ require 'purecloudplatformclientv2/models/rule_set_notification_rule'
|
|
|
866
879
|
require 'purecloudplatformclientv2/models/rule_set_notification_rules'
|
|
867
880
|
require 'purecloudplatformclientv2/models/rule_set_notification_uri_reference'
|
|
868
881
|
require 'purecloudplatformclientv2/models/run_now_response'
|
|
882
|
+
require 'purecloudplatformclientv2/models/sms_available_phone_number_entity_listing'
|
|
869
883
|
require 'purecloudplatformclientv2/models/salesforce'
|
|
870
884
|
require 'purecloudplatformclientv2/models/schedule'
|
|
871
885
|
require 'purecloudplatformclientv2/models/schedule_entity_listing'
|
|
@@ -919,6 +933,11 @@ require 'purecloudplatformclientv2/models/site'
|
|
|
919
933
|
require 'purecloudplatformclientv2/models/site_entity_listing'
|
|
920
934
|
require 'purecloudplatformclientv2/models/skill_entity_listing'
|
|
921
935
|
require 'purecloudplatformclientv2/models/skills_to_remove'
|
|
936
|
+
require 'purecloudplatformclientv2/models/sms_address_provision'
|
|
937
|
+
require 'purecloudplatformclientv2/models/sms_available_phone_number'
|
|
938
|
+
require 'purecloudplatformclientv2/models/sms_phone_number'
|
|
939
|
+
require 'purecloudplatformclientv2/models/sms_phone_number_entity_listing'
|
|
940
|
+
require 'purecloudplatformclientv2/models/sms_phone_number_provision'
|
|
922
941
|
require 'purecloudplatformclientv2/models/social_conversation_notification'
|
|
923
942
|
require 'purecloudplatformclientv2/models/social_conversation_notification_detail'
|
|
924
943
|
require 'purecloudplatformclientv2/models/social_conversation_notification_error_body'
|
|
@@ -958,6 +977,7 @@ require 'purecloudplatformclientv2/models/tag_value_entity_listing'
|
|
|
958
977
|
require 'purecloudplatformclientv2/models/term_attribute'
|
|
959
978
|
require 'purecloudplatformclientv2/models/test_execution_operation_result'
|
|
960
979
|
require 'purecloudplatformclientv2/models/test_execution_result'
|
|
980
|
+
require 'purecloudplatformclientv2/models/text_message_listing'
|
|
961
981
|
require 'purecloudplatformclientv2/models/ticker'
|
|
962
982
|
require 'purecloudplatformclientv2/models/time_allowed'
|
|
963
983
|
require 'purecloudplatformclientv2/models/time_interval'
|
|
@@ -634,7 +634,7 @@ module PureCloud
|
|
|
634
634
|
end
|
|
635
635
|
|
|
636
636
|
# deletes a specific datatable by id
|
|
637
|
-
# deletes an entire datatable (including schema and data) with a given
|
|
637
|
+
# deletes an entire datatable (including schema and data) with a given id)
|
|
638
638
|
# @param datatable_id id of datatable
|
|
639
639
|
# @param [Hash] opts the optional parameters
|
|
640
640
|
# @return [nil]
|
|
@@ -644,7 +644,7 @@ module PureCloud
|
|
|
644
644
|
end
|
|
645
645
|
|
|
646
646
|
# deletes a specific datatable by id
|
|
647
|
-
# deletes an entire datatable (including schema and data) with a given
|
|
647
|
+
# deletes an entire datatable (including schema and data) with a given id)
|
|
648
648
|
# @param datatable_id id of datatable
|
|
649
649
|
# @param [Hash] opts the optional parameters
|
|
650
650
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
@@ -3835,23 +3835,23 @@ module PureCloud
|
|
|
3835
3835
|
return data, status_code, headers
|
|
3836
3836
|
end
|
|
3837
3837
|
|
|
3838
|
-
# Returns a specific datatable by
|
|
3838
|
+
# Returns a specific datatable by id
|
|
3839
3839
|
# Given a datableid returns the schema associated with it.
|
|
3840
3840
|
# @param datatable_id id of datatable
|
|
3841
3841
|
# @param [Hash] opts the optional parameters
|
|
3842
|
-
# @option opts [
|
|
3843
|
-
# @return [
|
|
3842
|
+
# @option opts [String] :expand Expand instructions for the result
|
|
3843
|
+
# @return [DataTable]
|
|
3844
3844
|
def get_flows_datatable(datatable_id, opts = {})
|
|
3845
3845
|
data, _status_code, _headers = get_flows_datatable_with_http_info(datatable_id, opts)
|
|
3846
3846
|
return data
|
|
3847
3847
|
end
|
|
3848
3848
|
|
|
3849
|
-
# Returns a specific datatable by
|
|
3849
|
+
# Returns a specific datatable by id
|
|
3850
3850
|
# Given a datableid returns the schema associated with it.
|
|
3851
3851
|
# @param datatable_id id of datatable
|
|
3852
3852
|
# @param [Hash] opts the optional parameters
|
|
3853
|
-
# @option opts [
|
|
3854
|
-
# @return [Array<(
|
|
3853
|
+
# @option opts [String] :expand Expand instructions for the result
|
|
3854
|
+
# @return [Array<(DataTable, Fixnum, Hash)>] DataTable data, response status code and response headers
|
|
3855
3855
|
def get_flows_datatable_with_http_info(datatable_id, opts = {})
|
|
3856
3856
|
if @api_client.config.debugging
|
|
3857
3857
|
@api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_datatable ..."
|
|
@@ -3868,6 +3868,10 @@ module PureCloud
|
|
|
3868
3868
|
|
|
3869
3869
|
|
|
3870
3870
|
|
|
3871
|
+
if opts[:'expand'] && !['schema'].include?(opts[:'expand'])
|
|
3872
|
+
fail ArgumentError, 'invalid value for "expand", must be one of schema'
|
|
3873
|
+
end
|
|
3874
|
+
|
|
3871
3875
|
|
|
3872
3876
|
|
|
3873
3877
|
|
|
@@ -3876,7 +3880,7 @@ module PureCloud
|
|
|
3876
3880
|
|
|
3877
3881
|
# query parameters
|
|
3878
3882
|
query_params = {}
|
|
3879
|
-
query_params[:'
|
|
3883
|
+
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
|
3880
3884
|
|
|
3881
3885
|
# header parameters
|
|
3882
3886
|
header_params = {}
|
|
@@ -3902,7 +3906,7 @@ module PureCloud
|
|
|
3902
3906
|
:form_params => form_params,
|
|
3903
3907
|
:body => post_body,
|
|
3904
3908
|
:auth_names => auth_names,
|
|
3905
|
-
:return_type => '
|
|
3909
|
+
:return_type => 'DataTable')
|
|
3906
3910
|
if @api_client.config.debugging
|
|
3907
3911
|
@api_client.config.logger.debug "API called: ArchitectApi#get_flows_datatable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3908
3912
|
end
|
|
@@ -3997,8 +4001,10 @@ module PureCloud
|
|
|
3997
4001
|
# Returns all of the rows for the datatable with the given id. By default this will just be a shortened list returning the key for each row. Set expand to all to return all of the row contents.
|
|
3998
4002
|
# @param datatable_id id of datatable
|
|
3999
4003
|
# @param [Hash] opts the optional parameters
|
|
4004
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
|
4005
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
|
4000
4006
|
# @option opts [BOOLEAN] :showbrief If true returns just the key value of the row (default to true)
|
|
4001
|
-
# @return [
|
|
4007
|
+
# @return [DataTableRowEntityListing]
|
|
4002
4008
|
def get_flows_datatable_rows(datatable_id, opts = {})
|
|
4003
4009
|
data, _status_code, _headers = get_flows_datatable_rows_with_http_info(datatable_id, opts)
|
|
4004
4010
|
return data
|
|
@@ -4008,8 +4014,10 @@ module PureCloud
|
|
|
4008
4014
|
# Returns all of the rows for the datatable with the given id. By default this will just be a shortened list returning the key for each row. Set expand to all to return all of the row contents.
|
|
4009
4015
|
# @param datatable_id id of datatable
|
|
4010
4016
|
# @param [Hash] opts the optional parameters
|
|
4017
|
+
# @option opts [Integer] :page_size Page size
|
|
4018
|
+
# @option opts [Integer] :page_number Page number
|
|
4011
4019
|
# @option opts [BOOLEAN] :showbrief If true returns just the key value of the row
|
|
4012
|
-
# @return [Array<(
|
|
4020
|
+
# @return [Array<(DataTableRowEntityListing, Fixnum, Hash)>] DataTableRowEntityListing data, response status code and response headers
|
|
4013
4021
|
def get_flows_datatable_rows_with_http_info(datatable_id, opts = {})
|
|
4014
4022
|
if @api_client.config.debugging
|
|
4015
4023
|
@api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_datatable_rows ..."
|
|
@@ -4026,6 +4034,18 @@ module PureCloud
|
|
|
4026
4034
|
|
|
4027
4035
|
|
|
4028
4036
|
|
|
4037
|
+
|
|
4038
|
+
|
|
4039
|
+
|
|
4040
|
+
|
|
4041
|
+
|
|
4042
|
+
|
|
4043
|
+
|
|
4044
|
+
|
|
4045
|
+
|
|
4046
|
+
|
|
4047
|
+
|
|
4048
|
+
|
|
4029
4049
|
|
|
4030
4050
|
|
|
4031
4051
|
|
|
@@ -4034,6 +4054,8 @@ module PureCloud
|
|
|
4034
4054
|
|
|
4035
4055
|
# query parameters
|
|
4036
4056
|
query_params = {}
|
|
4057
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
4058
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
4037
4059
|
query_params[:'showbrief'] = opts[:'showbrief'] if opts[:'showbrief']
|
|
4038
4060
|
|
|
4039
4061
|
# header parameters
|
|
@@ -4060,7 +4082,7 @@ module PureCloud
|
|
|
4060
4082
|
:form_params => form_params,
|
|
4061
4083
|
:body => post_body,
|
|
4062
4084
|
:auth_names => auth_names,
|
|
4063
|
-
:return_type => '
|
|
4085
|
+
:return_type => 'DataTableRowEntityListing')
|
|
4064
4086
|
if @api_client.config.debugging
|
|
4065
4087
|
@api_client.config.logger.debug "API called: ArchitectApi#get_flows_datatable_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4066
4088
|
end
|
|
@@ -4070,8 +4092,12 @@ module PureCloud
|
|
|
4070
4092
|
# Retrieve a list of datatables for the org
|
|
4071
4093
|
# Returns a metadata list of the datatables associated with this org, including ID, name and description.
|
|
4072
4094
|
# @param [Hash] opts the optional parameters
|
|
4073
|
-
# @option opts [
|
|
4074
|
-
# @
|
|
4095
|
+
# @option opts [String] :expand Expand instructions for the result
|
|
4096
|
+
# @option opts [Integer] :page_size Page size (default to 25)
|
|
4097
|
+
# @option opts [Integer] :page_number Page number (default to 1)
|
|
4098
|
+
# @option opts [String] :sort_by Sort by (default to id)
|
|
4099
|
+
# @option opts [String] :sort_order Sort order (default to ascending)
|
|
4100
|
+
# @return [DataTablesDomainEntityListing]
|
|
4075
4101
|
def get_flows_datatables(opts = {})
|
|
4076
4102
|
data, _status_code, _headers = get_flows_datatables_with_http_info(opts)
|
|
4077
4103
|
return data
|
|
@@ -4080,8 +4106,12 @@ module PureCloud
|
|
|
4080
4106
|
# Retrieve a list of datatables for the org
|
|
4081
4107
|
# Returns a metadata list of the datatables associated with this org, including ID, name and description.
|
|
4082
4108
|
# @param [Hash] opts the optional parameters
|
|
4083
|
-
# @option opts [
|
|
4084
|
-
# @
|
|
4109
|
+
# @option opts [String] :expand Expand instructions for the result
|
|
4110
|
+
# @option opts [Integer] :page_size Page size
|
|
4111
|
+
# @option opts [Integer] :page_number Page number
|
|
4112
|
+
# @option opts [String] :sort_by Sort by
|
|
4113
|
+
# @option opts [String] :sort_order Sort order
|
|
4114
|
+
# @return [Array<(DataTablesDomainEntityListing, Fixnum, Hash)>] DataTablesDomainEntityListing data, response status code and response headers
|
|
4085
4115
|
def get_flows_datatables_with_http_info(opts = {})
|
|
4086
4116
|
if @api_client.config.debugging
|
|
4087
4117
|
@api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_datatables ..."
|
|
@@ -4090,6 +4120,42 @@ module PureCloud
|
|
|
4090
4120
|
|
|
4091
4121
|
|
|
4092
4122
|
|
|
4123
|
+
if opts[:'expand'] && !['schema'].include?(opts[:'expand'])
|
|
4124
|
+
fail ArgumentError, 'invalid value for "expand", must be one of schema'
|
|
4125
|
+
end
|
|
4126
|
+
|
|
4127
|
+
|
|
4128
|
+
|
|
4129
|
+
|
|
4130
|
+
|
|
4131
|
+
|
|
4132
|
+
|
|
4133
|
+
|
|
4134
|
+
|
|
4135
|
+
|
|
4136
|
+
|
|
4137
|
+
|
|
4138
|
+
|
|
4139
|
+
|
|
4140
|
+
|
|
4141
|
+
|
|
4142
|
+
|
|
4143
|
+
|
|
4144
|
+
|
|
4145
|
+
if opts[:'sort_by'] && !['id', 'name'].include?(opts[:'sort_by'])
|
|
4146
|
+
fail ArgumentError, 'invalid value for "sort_by", must be one of id, name'
|
|
4147
|
+
end
|
|
4148
|
+
|
|
4149
|
+
|
|
4150
|
+
|
|
4151
|
+
|
|
4152
|
+
|
|
4153
|
+
|
|
4154
|
+
|
|
4155
|
+
if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
|
|
4156
|
+
fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
|
|
4157
|
+
end
|
|
4158
|
+
|
|
4093
4159
|
|
|
4094
4160
|
|
|
4095
4161
|
|
|
@@ -4098,7 +4164,11 @@ module PureCloud
|
|
|
4098
4164
|
|
|
4099
4165
|
# query parameters
|
|
4100
4166
|
query_params = {}
|
|
4101
|
-
query_params[:'
|
|
4167
|
+
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
|
4168
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
|
4169
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
|
4170
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
4171
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
4102
4172
|
|
|
4103
4173
|
# header parameters
|
|
4104
4174
|
header_params = {}
|
|
@@ -4124,7 +4194,7 @@ module PureCloud
|
|
|
4124
4194
|
:form_params => form_params,
|
|
4125
4195
|
:body => post_body,
|
|
4126
4196
|
:auth_names => auth_names,
|
|
4127
|
-
:return_type => '
|
|
4197
|
+
:return_type => 'DataTablesDomainEntityListing')
|
|
4128
4198
|
if @api_client.config.debugging
|
|
4129
4199
|
@api_client.config.logger.debug "API called: ArchitectApi#get_flows_datatables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4130
4200
|
end
|
|
@@ -5333,7 +5403,7 @@ module PureCloud
|
|
|
5333
5403
|
# This will create a new datatable with fields that match the property definitions in the JSON schema. The name of the table from the title field of the json-schema. See also http://json-schema.org/
|
|
5334
5404
|
# @param body datatable json-schema
|
|
5335
5405
|
# @param [Hash] opts the optional parameters
|
|
5336
|
-
# @return [
|
|
5406
|
+
# @return [DataTable]
|
|
5337
5407
|
def post_flows_datatables(body, opts = {})
|
|
5338
5408
|
data, _status_code, _headers = post_flows_datatables_with_http_info(body, opts)
|
|
5339
5409
|
return data
|
|
@@ -5343,7 +5413,7 @@ module PureCloud
|
|
|
5343
5413
|
# This will create a new datatable with fields that match the property definitions in the JSON schema. The name of the table from the title field of the json-schema. See also http://json-schema.org/
|
|
5344
5414
|
# @param body datatable json-schema
|
|
5345
5415
|
# @param [Hash] opts the optional parameters
|
|
5346
|
-
# @return [Array<(
|
|
5416
|
+
# @return [Array<(DataTable, Fixnum, Hash)>] DataTable data, response status code and response headers
|
|
5347
5417
|
def post_flows_datatables_with_http_info(body, opts = {})
|
|
5348
5418
|
if @api_client.config.debugging
|
|
5349
5419
|
@api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_datatables ..."
|
|
@@ -5387,7 +5457,7 @@ module PureCloud
|
|
|
5387
5457
|
:form_params => form_params,
|
|
5388
5458
|
:body => post_body,
|
|
5389
5459
|
:auth_names => auth_names,
|
|
5390
|
-
:return_type => '
|
|
5460
|
+
:return_type => 'DataTable')
|
|
5391
5461
|
if @api_client.config.debugging
|
|
5392
5462
|
@api_client.config.logger.debug "API called: ArchitectApi#post_flows_datatables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5393
5463
|
end
|
|
@@ -5925,25 +5995,25 @@ module PureCloud
|
|
|
5925
5995
|
return data, status_code, headers
|
|
5926
5996
|
end
|
|
5927
5997
|
|
|
5928
|
-
# Updates a specific datatable by
|
|
5929
|
-
# Updates a schema for a datatable with the given
|
|
5998
|
+
# Updates a specific datatable by id
|
|
5999
|
+
# Updates a schema for a datatable with the given id - updates are additive only, no changes or removals of existing fields.
|
|
5930
6000
|
# @param datatable_id id of datatable
|
|
5931
6001
|
# @param [Hash] opts the optional parameters
|
|
5932
|
-
# @option opts [
|
|
5933
|
-
# @option opts [
|
|
5934
|
-
# @return [
|
|
6002
|
+
# @option opts [String] :expand Expand instructions for the result
|
|
6003
|
+
# @option opts [DataTable] :body datatable json-schema
|
|
6004
|
+
# @return [DataTable]
|
|
5935
6005
|
def put_flows_datatable(datatable_id, opts = {})
|
|
5936
6006
|
data, _status_code, _headers = put_flows_datatable_with_http_info(datatable_id, opts)
|
|
5937
6007
|
return data
|
|
5938
6008
|
end
|
|
5939
6009
|
|
|
5940
|
-
# Updates a specific datatable by
|
|
5941
|
-
# Updates a schema for a datatable with the given
|
|
6010
|
+
# Updates a specific datatable by id
|
|
6011
|
+
# Updates a schema for a datatable with the given id - updates are additive only, no changes or removals of existing fields.
|
|
5942
6012
|
# @param datatable_id id of datatable
|
|
5943
6013
|
# @param [Hash] opts the optional parameters
|
|
5944
|
-
# @option opts [
|
|
5945
|
-
# @option opts [
|
|
5946
|
-
# @return [Array<(
|
|
6014
|
+
# @option opts [String] :expand Expand instructions for the result
|
|
6015
|
+
# @option opts [DataTable] :body datatable json-schema
|
|
6016
|
+
# @return [Array<(DataTable, Fixnum, Hash)>] DataTable data, response status code and response headers
|
|
5947
6017
|
def put_flows_datatable_with_http_info(datatable_id, opts = {})
|
|
5948
6018
|
if @api_client.config.debugging
|
|
5949
6019
|
@api_client.config.logger.debug "Calling API: ArchitectApi.put_flows_datatable ..."
|
|
@@ -5960,6 +6030,10 @@ module PureCloud
|
|
|
5960
6030
|
|
|
5961
6031
|
|
|
5962
6032
|
|
|
6033
|
+
if opts[:'expand'] && !['schema'].include?(opts[:'expand'])
|
|
6034
|
+
fail ArgumentError, 'invalid value for "expand", must be one of schema'
|
|
6035
|
+
end
|
|
6036
|
+
|
|
5963
6037
|
|
|
5964
6038
|
|
|
5965
6039
|
|
|
@@ -5974,7 +6048,7 @@ module PureCloud
|
|
|
5974
6048
|
|
|
5975
6049
|
# query parameters
|
|
5976
6050
|
query_params = {}
|
|
5977
|
-
query_params[:'
|
|
6051
|
+
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
|
5978
6052
|
|
|
5979
6053
|
# header parameters
|
|
5980
6054
|
header_params = {}
|
|
@@ -6000,7 +6074,7 @@ module PureCloud
|
|
|
6000
6074
|
:form_params => form_params,
|
|
6001
6075
|
:body => post_body,
|
|
6002
6076
|
:auth_names => auth_names,
|
|
6003
|
-
:return_type => '
|
|
6077
|
+
:return_type => 'DataTable')
|
|
6004
6078
|
if @api_client.config.debugging
|
|
6005
6079
|
@api_client.config.logger.debug "API called: ArchitectApi#put_flows_datatable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
6006
6080
|
end
|