purecloudplatformclientv2 15.0.0 → 16.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/Action.md +21 -0
- data/docs/ActionConfig.md +14 -0
- data/docs/ActionContract.md +14 -0
- data/docs/ActionContractInput.md +14 -0
- data/docs/ActionEntityListing.md +22 -0
- data/docs/ActionInput.md +15 -0
- data/docs/ActionOutput.md +18 -0
- data/docs/ActiveAlertCount.md +13 -0
- data/docs/AggregationQuery.md +1 -1
- data/docs/AlertingApi.md +54 -0
- data/docs/ArchitectApi.md +31 -25
- data/docs/CallConversationNotificationCallMediaParticipant.md +1 -0
- data/docs/CallConversationNotificationParticipants.md +1 -0
- data/docs/CallbackConversationNotificationCallbackMediaParticipant.md +1 -0
- data/docs/CallbackConversationNotificationParticipants.md +1 -0
- data/docs/Category.md +13 -0
- data/docs/CategoryEntityListing.md +17 -0
- data/docs/ChatConversationNotificationChatMediaParticipant.md +1 -0
- data/docs/ChatConversationNotificationParticipants.md +1 -0
- data/docs/CobrowseConversationNotificationCobrowseMediaParticipant.md +1 -0
- data/docs/CobrowseConversationNotificationParticipants.md +1 -0
- data/docs/ConversationNotificationCall.md +1 -0
- data/docs/ConversationNotificationCalls.md +1 -0
- data/docs/ConversationNotificationEmail.md +1 -0
- data/docs/ConversationNotificationEmails.md +1 -0
- data/docs/ConversationNotificationParticipant.md +1 -0
- data/docs/ConversationNotificationParticipants.md +1 -0
- data/docs/ConversationsApi.md +3 -3
- data/docs/Document.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/DraftValidationResult.md +14 -0
- data/docs/EmailConversationNotificationEmailMediaParticipant.md +2 -0
- data/docs/EmailConversationNotificationParticipants.md +2 -0
- data/docs/FaxDocument.md +1 -1
- data/docs/IntegrationsApi.md +1355 -0
- data/docs/JsonNode.md +4 -4
- data/docs/ManagementUnit.md +1 -1
- data/docs/ManagementUnitListing.md +22 -0
- data/docs/OutboundApi.md +59 -0
- data/docs/PostActionInput.md +18 -0
- data/docs/PostInputContract.md +13 -0
- data/docs/PostOutputContract.md +13 -0
- data/docs/PublishDraftInput.md +13 -0
- data/docs/RecordingApi.md +123 -0
- data/docs/RequestConfig.md +17 -0
- data/docs/ResponseConfig.md +15 -0
- data/docs/ScreenShareConversationNotificationParticipants.md +1 -0
- data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md +1 -0
- data/docs/SocialConversationNotificationParticipants.md +1 -0
- data/docs/SocialConversationNotificationSocialMediaParticipant.md +1 -0
- data/docs/TestExecutionOperationResult.md +17 -0
- data/docs/TestExecutionResult.md +16 -0
- data/docs/UpdateActionInput.md +16 -0
- data/docs/UpdateDraftInput.md +18 -0
- data/docs/VideoConversationNotificationParticipants.md +1 -0
- data/docs/VideoConversationNotificationVideoMediaParticipant.md +1 -0
- data/docs/WorkforceManagementApi.md +2 -4
- data/lib/purecloudplatformclientv2.rb +23 -1
- data/lib/purecloudplatformclientv2/api/alerting_api.rb +55 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +52 -20
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +1723 -0
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/recording_api.rb +140 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -12
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action.rb +409 -0
- data/lib/purecloudplatformclientv2/models/action_config.rb +229 -0
- data/lib/purecloudplatformclientv2/models/action_contract.rb +229 -0
- data/lib/purecloudplatformclientv2/models/action_contract_input.rb +239 -0
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/action_input.rb +255 -0
- data/lib/purecloudplatformclientv2/models/action_output.rb +333 -0
- data/lib/purecloudplatformclientv2/models/active_alert_count.rb +202 -0
- data/lib/purecloudplatformclientv2/models/aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_call_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_callback_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/category.rb +203 -0
- data/lib/purecloudplatformclientv2/models/category_entity_listing.rb +303 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_chat_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/condition.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_notification_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_calls.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/document.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/draft_validation_result.rb +231 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +54 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +54 -4
- data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule.rb +2 -2
- data/lib/purecloudplatformclientv2/models/json_node.rb +72 -72
- data/lib/purecloudplatformclientv2/models/management_unit.rb +7 -7
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/post_action_input.rb +358 -0
- data/lib/purecloudplatformclientv2/models/post_input_contract.rb +208 -0
- data/lib/purecloudplatformclientv2/models/post_output_contract.rb +208 -0
- data/lib/purecloudplatformclientv2/models/publish_draft_input.rb +208 -0
- data/lib/purecloudplatformclientv2/models/request_config.rb +309 -0
- data/lib/purecloudplatformclientv2/models/response_config.rb +257 -0
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_screen_share_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_social_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/test_execution_operation_result.rb +306 -0
- data/lib/purecloudplatformclientv2/models/test_execution_result.rb +282 -0
- data/lib/purecloudplatformclientv2/models/{publish_flow_notification_notification.rb → update_action_input.rb} +35 -26
- data/lib/purecloudplatformclientv2/models/update_draft_input.rb +338 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_video_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +91 -47
- data/docs/PublishFlowNotificationNotification.md +0 -16
@@ -33,6 +33,7 @@ title: CallbackConversationNotificationCallbackMediaParticipant
|
|
33
33
|
| **external_organization** | [**CallbackConversationNotificationUriReference**](CallbackConversationNotificationUriReference.html) | | [optional] |
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
35
35
|
| **peer** | **String** | | [optional] |
|
36
|
+
| **screen_recording_state** | **String** | | [optional] |
|
36
37
|
| **outbound_preview** | [**ConversationNotificationDialerPreview**](ConversationNotificationDialerPreview.html) | | [optional] |
|
37
38
|
| **voicemail** | [**ConversationNotificationVoicemail**](ConversationNotificationVoicemail.html) | | [optional] |
|
38
39
|
| **callback_numbers** | **Array<String>** | | [optional] |
|
@@ -33,6 +33,7 @@ title: CallbackConversationNotificationParticipants
|
|
33
33
|
| **external_organization** | [**CallbackConversationNotificationUriReference**](CallbackConversationNotificationUriReference.html) | | [optional] |
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
35
35
|
| **peer** | **String** | | [optional] |
|
36
|
+
| **screen_recording_state** | **String** | | [optional] |
|
36
37
|
| **outbound_preview** | [**ConversationNotificationDialerPreview**](ConversationNotificationDialerPreview.html) | | [optional] |
|
37
38
|
| **voicemail** | [**ConversationNotificationVoicemail**](ConversationNotificationVoicemail.html) | | [optional] |
|
38
39
|
| **callback_numbers** | **Array<String>** | | [optional] |
|
data/docs/Category.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
---
|
2
|
+
title: Category
|
3
|
+
---
|
4
|
+
## PureCloud::Category
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **name** | **String** | Category name | [optional] |
|
11
|
+
{: class="table table-striped"}
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: CategoryEntityListing
|
3
|
+
---
|
4
|
+
## PureCloud::CategoryEntityListing
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **entities** | [**Array<Category>**](Category.html) | | [optional] |
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
13
|
+
| **total** | **Integer** | | [optional] |
|
14
|
+
| **page_count** | **Integer** | | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -33,6 +33,7 @@ title: ChatConversationNotificationChatMediaParticipant
|
|
33
33
|
| **external_organization** | [**ChatConversationNotificationUriReference**](ChatConversationNotificationUriReference.html) | | [optional] |
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
35
35
|
| **peer** | **String** | | [optional] |
|
36
|
+
| **screen_recording_state** | **String** | | [optional] |
|
36
37
|
| **room_id** | **String** | | [optional] |
|
37
38
|
{: class="table table-striped"}
|
38
39
|
|
@@ -33,6 +33,7 @@ title: ChatConversationNotificationParticipants
|
|
33
33
|
| **external_organization** | [**ChatConversationNotificationUriReference**](ChatConversationNotificationUriReference.html) | | [optional] |
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
35
35
|
| **peer** | **String** | | [optional] |
|
36
|
+
| **screen_recording_state** | **String** | | [optional] |
|
36
37
|
| **room_id** | **String** | | [optional] |
|
37
38
|
{: class="table table-striped"}
|
38
39
|
|
@@ -33,6 +33,7 @@ title: CobrowseConversationNotificationCobrowseMediaParticipant
|
|
33
33
|
| **external_organization** | [**CobrowseConversationNotificationUriReference**](CobrowseConversationNotificationUriReference.html) | | [optional] |
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
35
35
|
| **peer** | **String** | | [optional] |
|
36
|
+
| **screen_recording_state** | **String** | | [optional] |
|
36
37
|
| **cobrowse_session_id** | **String** | | [optional] |
|
37
38
|
| **cobrowse_role** | **String** | | [optional] |
|
38
39
|
| **viewer_url** | **String** | | [optional] |
|
@@ -33,6 +33,7 @@ title: CobrowseConversationNotificationParticipants
|
|
33
33
|
| **external_organization** | [**CobrowseConversationNotificationUriReference**](CobrowseConversationNotificationUriReference.html) | | [optional] |
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
35
35
|
| **peer** | **String** | | [optional] |
|
36
|
+
| **screen_recording_state** | **String** | | [optional] |
|
36
37
|
| **cobrowse_session_id** | **String** | | [optional] |
|
37
38
|
| **cobrowse_role** | **String** | | [optional] |
|
38
39
|
| **viewer_url** | **String** | | [optional] |
|
@@ -28,6 +28,7 @@ title: ConversationNotificationCall
|
|
28
28
|
| **disconnected_time** | **DateTime** | | [optional] |
|
29
29
|
| **disconnect_reasons** | [**Array<ConversationNotificationDisconnectReasons>**](ConversationNotificationDisconnectReasons.html) | | [optional] |
|
30
30
|
| **fax_status** | [**ConversationNotificationFaxStatus**](ConversationNotificationFaxStatus.html) | | [optional] |
|
31
|
+
| **uui_data** | **String** | | [optional] |
|
31
32
|
| **additional_properties** | **Object** | | [optional] |
|
32
33
|
{: class="table table-striped"}
|
33
34
|
|
@@ -28,6 +28,7 @@ title: ConversationNotificationCalls
|
|
28
28
|
| **disconnected_time** | **DateTime** | | [optional] |
|
29
29
|
| **disconnect_reasons** | [**Array<ConversationNotificationDisconnectReasons>**](ConversationNotificationDisconnectReasons.html) | | [optional] |
|
30
30
|
| **fax_status** | [**ConversationNotificationFaxStatus**](ConversationNotificationFaxStatus.html) | | [optional] |
|
31
|
+
| **uui_data** | **String** | | [optional] |
|
31
32
|
| **additional_properties** | **Object** | | [optional] |
|
32
33
|
{: class="table table-striped"}
|
33
34
|
|
@@ -21,6 +21,7 @@ title: ConversationNotificationEmail
|
|
21
21
|
| **start_hold_time** | **DateTime** | | [optional] |
|
22
22
|
| **connected_time** | **DateTime** | | [optional] |
|
23
23
|
| **disconnected_time** | **DateTime** | | [optional] |
|
24
|
+
| **message_id** | **String** | | [optional] |
|
24
25
|
| **additional_properties** | **Object** | | [optional] |
|
25
26
|
{: class="table table-striped"}
|
26
27
|
|
@@ -21,6 +21,7 @@ title: ConversationNotificationEmails
|
|
21
21
|
| **start_hold_time** | **DateTime** | | [optional] |
|
22
22
|
| **connected_time** | **DateTime** | | [optional] |
|
23
23
|
| **disconnected_time** | **DateTime** | | [optional] |
|
24
|
+
| **message_id** | **String** | | [optional] |
|
24
25
|
| **additional_properties** | **Object** | | [optional] |
|
25
26
|
{: class="table table-striped"}
|
26
27
|
|
@@ -25,6 +25,7 @@ title: ConversationNotificationParticipant
|
|
25
25
|
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
26
26
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
27
27
|
| **monitored_participant_id** | **String** | | [optional] |
|
28
|
+
| **screen_recording_state** | **String** | | [optional] |
|
28
29
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
29
30
|
| **calls** | [**Array<ConversationNotificationCalls>**](ConversationNotificationCalls.html) | | [optional] |
|
30
31
|
| **callbacks** | [**Array<ConversationNotificationCallbacks>**](ConversationNotificationCallbacks.html) | | [optional] |
|
@@ -25,6 +25,7 @@ title: ConversationNotificationParticipants
|
|
25
25
|
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
26
26
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
27
27
|
| **monitored_participant_id** | **String** | | [optional] |
|
28
|
+
| **screen_recording_state** | **String** | | [optional] |
|
28
29
|
| **attributes** | **Hash<String, String>** | | [optional] |
|
29
30
|
| **calls** | [**Array<ConversationNotificationCalls>**](ConversationNotificationCalls.html) | | [optional] |
|
30
31
|
| **callbacks** | [**Array<ConversationNotificationCallbacks>**](ConversationNotificationCallbacks.html) | | [optional] |
|
data/docs/ConversationsApi.md
CHANGED
@@ -69,7 +69,7 @@ Method | Description
|
|
69
69
|
[**post_analytics_conversations_details_query**](ConversationsApi.html#post_analytics_conversations_details_query) | Query for conversation details
|
70
70
|
[**post_conversation_participant_callbacks**](ConversationsApi.html#post_conversation_participant_callbacks) | Create a new callback for the specified participant on the conversation.
|
71
71
|
[**post_conversation_participant_replace**](ConversationsApi.html#post_conversation_participant_replace) | Replace this participant with the specified user and/or address
|
72
|
-
[**post_conversations_call**](ConversationsApi.html#post_conversations_call) |
|
72
|
+
[**post_conversations_call**](ConversationsApi.html#post_conversations_call) | Place a new call as part of a callback conversation.
|
73
73
|
[**post_conversations_call_participant_consult**](ConversationsApi.html#post_conversations_call_participant_consult) | Initiate and update consult transfer
|
74
74
|
[**post_conversations_call_participant_monitor**](ConversationsApi.html#post_conversations_call_participant_monitor) | Listen in on the conversation from the point of view of a given participant.
|
75
75
|
[**post_conversations_call_participant_replace**](ConversationsApi.html#post_conversations_call_participant_replace) | Replace this participant with the specified user and/or address
|
@@ -3876,7 +3876,7 @@ nil (empty response body)
|
|
3876
3876
|
|
3877
3877
|
## -[**Conversation**](Conversation.html) post_conversations_call(conversation_id, body)
|
3878
3878
|
|
3879
|
-
|
3879
|
+
Place a new call as part of a callback conversation.
|
3880
3880
|
|
3881
3881
|
|
3882
3882
|
|
@@ -3906,7 +3906,7 @@ body = PureCloud::CallCommand.new # CallCommand | Conversation
|
|
3906
3906
|
|
3907
3907
|
|
3908
3908
|
begin
|
3909
|
-
#
|
3909
|
+
#Place a new call as part of a callback conversation.
|
3910
3910
|
result = api_instance.post_conversations_call(conversation_id, body)
|
3911
3911
|
p result
|
3912
3912
|
rescue PureCloud::ApiError => e
|
data/docs/Document.md
CHANGED
@@ -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
|
-
| **sharing_uri** | **String** | | [optional] |
|
39
38
|
| **download_sharing_uri** | **String** | | [optional] |
|
39
|
+
| **sharing_uri** | **String** | | [optional] |
|
40
40
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
41
41
|
{: class="table table-striped"}
|
42
42
|
|
@@ -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
|
-
| **default** | **BOOLEAN** | | [optional] |
|
19
18
|
| **base** | **BOOLEAN** | | [optional] |
|
19
|
+
| **default** | **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
|
-
| **default** | **BOOLEAN** | | [optional] |
|
19
18
|
| **base** | **BOOLEAN** | | [optional] |
|
19
|
+
| **default** | **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
|
-
| **default** | **BOOLEAN** | | [optional] |
|
19
18
|
| **base** | **BOOLEAN** | | [optional] |
|
19
|
+
| **default** | **BOOLEAN** | | [optional] |
|
20
20
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
21
|
{: class="table table-striped"}
|
22
22
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: DraftValidationResult
|
3
|
+
---
|
4
|
+
## PureCloud::DraftValidationResult
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **valid** | **BOOLEAN** | Indicates if configuration is valid | [optional] |
|
11
|
+
| **errors** | [**Array<ErrorBody>**](ErrorBody.html) | List of errors causing validation failure | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -33,9 +33,11 @@ title: EmailConversationNotificationEmailMediaParticipant
|
|
33
33
|
| **external_organization** | [**EmailConversationNotificationUriReference**](EmailConversationNotificationUriReference.html) | | [optional] |
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
35
35
|
| **peer** | **String** | | [optional] |
|
36
|
+
| **screen_recording_state** | **String** | | [optional] |
|
36
37
|
| **subject** | **String** | | [optional] |
|
37
38
|
| **messages_sent** | **Integer** | | [optional] |
|
38
39
|
| **auto_generated** | **BOOLEAN** | | [optional] |
|
40
|
+
| **message_id** | **String** | | [optional] |
|
39
41
|
{: class="table table-striped"}
|
40
42
|
|
41
43
|
|
@@ -33,9 +33,11 @@ title: EmailConversationNotificationParticipants
|
|
33
33
|
| **external_organization** | [**EmailConversationNotificationUriReference**](EmailConversationNotificationUriReference.html) | | [optional] |
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
35
35
|
| **peer** | **String** | | [optional] |
|
36
|
+
| **screen_recording_state** | **String** | | [optional] |
|
36
37
|
| **subject** | **String** | | [optional] |
|
37
38
|
| **messages_sent** | **Integer** | | [optional] |
|
38
39
|
| **auto_generated** | **BOOLEAN** | | [optional] |
|
40
|
+
| **message_id** | **String** | | [optional] |
|
39
41
|
{: class="table table-striped"}
|
40
42
|
|
41
43
|
|
data/docs/FaxDocument.md
CHANGED
@@ -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
|
-
| **sharing_uri** | **String** | | [optional] |
|
26
25
|
| **download_sharing_uri** | **String** | | [optional] |
|
26
|
+
| **sharing_uri** | **String** | | [optional] |
|
27
27
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
28
28
|
{: class="table table-striped"}
|
29
29
|
|
@@ -0,0 +1,1355 @@
|
|
1
|
+
---
|
2
|
+
title: IntegrationsApi
|
3
|
+
---
|
4
|
+
|
5
|
+
## PureCloud::IntegrationsApi
|
6
|
+
|
7
|
+
All URIs are relative to *https://api.mypurecloud.com*
|
8
|
+
|
9
|
+
Method | Description
|
10
|
+
------------- | ------------- | -------------
|
11
|
+
[**delete_integrations_action**](IntegrationsApi.html#delete_integrations_action) | Delete an Action
|
12
|
+
[**delete_integrations_action_draft**](IntegrationsApi.html#delete_integrations_action_draft) | Delete a Draft
|
13
|
+
[**get_integrations_action**](IntegrationsApi.html#get_integrations_action) | Retrieves a single Action matching id.
|
14
|
+
[**get_integrations_action_draft**](IntegrationsApi.html#get_integrations_action_draft) | Retrieve a Draft
|
15
|
+
[**get_integrations_action_draft_schema**](IntegrationsApi.html#get_integrations_action_draft_schema) | Retrieve schema for a Draft based on filename.
|
16
|
+
[**get_integrations_action_draft_template**](IntegrationsApi.html#get_integrations_action_draft_template) | Retrieve templates for a Draft based on filename.
|
17
|
+
[**get_integrations_action_draft_validation**](IntegrationsApi.html#get_integrations_action_draft_validation) | Validate current Draft configuration.
|
18
|
+
[**get_integrations_action_schema**](IntegrationsApi.html#get_integrations_action_schema) | Retrieve schema for an action based on filename.
|
19
|
+
[**get_integrations_action_template**](IntegrationsApi.html#get_integrations_action_template) | Retrieve text of templates for an action based on filename.
|
20
|
+
[**get_integrations_actions**](IntegrationsApi.html#get_integrations_actions) | Retrieves all actions associated with filters passed in via query param.
|
21
|
+
[**get_integrations_actions_categories**](IntegrationsApi.html#get_integrations_actions_categories) | Retrieves all categories of available Actions
|
22
|
+
[**get_integrations_actions_drafts**](IntegrationsApi.html#get_integrations_actions_drafts) | Retrieves all action drafts associated with the filters passed in via query param.
|
23
|
+
[**patch_integrations_action**](IntegrationsApi.html#patch_integrations_action) | Patch an Action
|
24
|
+
[**patch_integrations_action_draft**](IntegrationsApi.html#patch_integrations_action_draft) | Update an existing Draft
|
25
|
+
[**post_integrations_action_draft**](IntegrationsApi.html#post_integrations_action_draft) | Create a new Draft from existing Action
|
26
|
+
[**post_integrations_action_draft_publish**](IntegrationsApi.html#post_integrations_action_draft_publish) | Publish a Draft and make it the active Action configuration
|
27
|
+
[**post_integrations_action_draft_test**](IntegrationsApi.html#post_integrations_action_draft_test) | Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.
|
28
|
+
[**post_integrations_action_execute**](IntegrationsApi.html#post_integrations_action_execute) | Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.
|
29
|
+
[**post_integrations_action_test**](IntegrationsApi.html#post_integrations_action_test) | Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
|
30
|
+
[**post_integrations_actions**](IntegrationsApi.html#post_integrations_actions) | Create a new Action
|
31
|
+
[**post_integrations_actions_drafts**](IntegrationsApi.html#post_integrations_actions_drafts) | Create a new Draft
|
32
|
+
{: class="table table-striped"}
|
33
|
+
|
34
|
+
<a name="delete_integrations_action"></a>
|
35
|
+
|
36
|
+
## - delete_integrations_action(action_id)
|
37
|
+
|
38
|
+
Delete an Action
|
39
|
+
|
40
|
+
|
41
|
+
|
42
|
+
Wraps DELETE /api/v2/integrations/actions/{actionId}
|
43
|
+
|
44
|
+
|
45
|
+
### Example
|
46
|
+
~~~ruby
|
47
|
+
# load the gem
|
48
|
+
require 'purecloudplatformclientv2'
|
49
|
+
# setup authorization
|
50
|
+
@secret = ENV['PURECLOUD_SECRET']
|
51
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
52
|
+
environment = "mypurecloud.com"
|
53
|
+
|
54
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
55
|
+
|
56
|
+
PureCloud.configure do |config|
|
57
|
+
config.access_token = @authToken
|
58
|
+
end
|
59
|
+
|
60
|
+
api_instance = PureCloud::IntegrationsApi.new
|
61
|
+
|
62
|
+
action_id = "action_id_example" # String | actionId
|
63
|
+
|
64
|
+
|
65
|
+
begin
|
66
|
+
#Delete an Action
|
67
|
+
api_instance.delete_integrations_action(action_id)
|
68
|
+
rescue PureCloud::ApiError => e
|
69
|
+
puts "Exception when calling IntegrationsApi->delete_integrations_action: #{e}"
|
70
|
+
end
|
71
|
+
~~~
|
72
|
+
|
73
|
+
### Parameters
|
74
|
+
|
75
|
+
Name | Type | Description | Notes
|
76
|
+
------------- | ------------- | ------------- | -------------
|
77
|
+
**action_id** | **String**| actionId | |
|
78
|
+
{: class="table table-striped"}
|
79
|
+
|
80
|
+
|
81
|
+
### Return type
|
82
|
+
|
83
|
+
nil (empty response body)
|
84
|
+
|
85
|
+
### HTTP request headers
|
86
|
+
|
87
|
+
- **Content-Type**: application/json
|
88
|
+
- **Accept**: application/json
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
<a name="delete_integrations_action_draft"></a>
|
93
|
+
|
94
|
+
## - delete_integrations_action_draft(action_id)
|
95
|
+
|
96
|
+
Delete a Draft
|
97
|
+
|
98
|
+
|
99
|
+
|
100
|
+
Wraps DELETE /api/v2/integrations/actions/{actionId}/draft
|
101
|
+
|
102
|
+
|
103
|
+
### Example
|
104
|
+
~~~ruby
|
105
|
+
# load the gem
|
106
|
+
require 'purecloudplatformclientv2'
|
107
|
+
# setup authorization
|
108
|
+
@secret = ENV['PURECLOUD_SECRET']
|
109
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
110
|
+
environment = "mypurecloud.com"
|
111
|
+
|
112
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
113
|
+
|
114
|
+
PureCloud.configure do |config|
|
115
|
+
config.access_token = @authToken
|
116
|
+
end
|
117
|
+
|
118
|
+
api_instance = PureCloud::IntegrationsApi.new
|
119
|
+
|
120
|
+
action_id = "action_id_example" # String | actionId
|
121
|
+
|
122
|
+
|
123
|
+
begin
|
124
|
+
#Delete a Draft
|
125
|
+
api_instance.delete_integrations_action_draft(action_id)
|
126
|
+
rescue PureCloud::ApiError => e
|
127
|
+
puts "Exception when calling IntegrationsApi->delete_integrations_action_draft: #{e}"
|
128
|
+
end
|
129
|
+
~~~
|
130
|
+
|
131
|
+
### Parameters
|
132
|
+
|
133
|
+
Name | Type | Description | Notes
|
134
|
+
------------- | ------------- | ------------- | -------------
|
135
|
+
**action_id** | **String**| actionId | |
|
136
|
+
{: class="table table-striped"}
|
137
|
+
|
138
|
+
|
139
|
+
### Return type
|
140
|
+
|
141
|
+
nil (empty response body)
|
142
|
+
|
143
|
+
### HTTP request headers
|
144
|
+
|
145
|
+
- **Content-Type**: application/json
|
146
|
+
- **Accept**: application/json
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
<a name="get_integrations_action"></a>
|
151
|
+
|
152
|
+
## -[**Action**](Action.html) get_integrations_action(action_id, opts)
|
153
|
+
|
154
|
+
Retrieves a single Action matching id.
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
Wraps GET /api/v2/integrations/actions/{actionId}
|
159
|
+
|
160
|
+
|
161
|
+
### Example
|
162
|
+
~~~ruby
|
163
|
+
# load the gem
|
164
|
+
require 'purecloudplatformclientv2'
|
165
|
+
# setup authorization
|
166
|
+
@secret = ENV['PURECLOUD_SECRET']
|
167
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
168
|
+
environment = "mypurecloud.com"
|
169
|
+
|
170
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
171
|
+
|
172
|
+
PureCloud.configure do |config|
|
173
|
+
config.access_token = @authToken
|
174
|
+
end
|
175
|
+
|
176
|
+
api_instance = PureCloud::IntegrationsApi.new
|
177
|
+
|
178
|
+
action_id = "action_id_example" # String | actionId
|
179
|
+
|
180
|
+
opts = {
|
181
|
+
expand: "expand_example", # String | Indicates fields of the response which should be expanded.
|
182
|
+
include_config: false # BOOLEAN | Show config when available
|
183
|
+
}
|
184
|
+
|
185
|
+
begin
|
186
|
+
#Retrieves a single Action matching id.
|
187
|
+
result = api_instance.get_integrations_action(action_id, opts)
|
188
|
+
p result
|
189
|
+
rescue PureCloud::ApiError => e
|
190
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action: #{e}"
|
191
|
+
end
|
192
|
+
~~~
|
193
|
+
|
194
|
+
### Parameters
|
195
|
+
|
196
|
+
Name | Type | Description | Notes
|
197
|
+
------------- | ------------- | ------------- | -------------
|
198
|
+
**action_id** | **String**| actionId | |
|
199
|
+
**expand** | **String**| Indicates fields of the response which should be expanded. | [optional] <br />**Values**: contract |
|
200
|
+
**include_config** | **BOOLEAN**| Show config when available | [optional] [default to false] |
|
201
|
+
{: class="table table-striped"}
|
202
|
+
|
203
|
+
|
204
|
+
### Return type
|
205
|
+
|
206
|
+
[**Action**](Action.html)
|
207
|
+
|
208
|
+
### HTTP request headers
|
209
|
+
|
210
|
+
- **Content-Type**: application/json
|
211
|
+
- **Accept**: application/json
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
<a name="get_integrations_action_draft"></a>
|
216
|
+
|
217
|
+
## -[**Action**](Action.html) get_integrations_action_draft(action_id, opts)
|
218
|
+
|
219
|
+
Retrieve a Draft
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/draft
|
224
|
+
|
225
|
+
|
226
|
+
### Example
|
227
|
+
~~~ruby
|
228
|
+
# load the gem
|
229
|
+
require 'purecloudplatformclientv2'
|
230
|
+
# setup authorization
|
231
|
+
@secret = ENV['PURECLOUD_SECRET']
|
232
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
233
|
+
environment = "mypurecloud.com"
|
234
|
+
|
235
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
236
|
+
|
237
|
+
PureCloud.configure do |config|
|
238
|
+
config.access_token = @authToken
|
239
|
+
end
|
240
|
+
|
241
|
+
api_instance = PureCloud::IntegrationsApi.new
|
242
|
+
|
243
|
+
action_id = "action_id_example" # String | actionId
|
244
|
+
|
245
|
+
opts = {
|
246
|
+
expand: "expand_example", # String | Indicates fields of the response which should be expanded.
|
247
|
+
include_config: false # BOOLEAN | Show config when available
|
248
|
+
}
|
249
|
+
|
250
|
+
begin
|
251
|
+
#Retrieve a Draft
|
252
|
+
result = api_instance.get_integrations_action_draft(action_id, opts)
|
253
|
+
p result
|
254
|
+
rescue PureCloud::ApiError => e
|
255
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_draft: #{e}"
|
256
|
+
end
|
257
|
+
~~~
|
258
|
+
|
259
|
+
### Parameters
|
260
|
+
|
261
|
+
Name | Type | Description | Notes
|
262
|
+
------------- | ------------- | ------------- | -------------
|
263
|
+
**action_id** | **String**| actionId | |
|
264
|
+
**expand** | **String**| Indicates fields of the response which should be expanded. | [optional] <br />**Values**: contract |
|
265
|
+
**include_config** | **BOOLEAN**| Show config when available | [optional] [default to false] |
|
266
|
+
{: class="table table-striped"}
|
267
|
+
|
268
|
+
|
269
|
+
### Return type
|
270
|
+
|
271
|
+
[**Action**](Action.html)
|
272
|
+
|
273
|
+
### HTTP request headers
|
274
|
+
|
275
|
+
- **Content-Type**: application/json
|
276
|
+
- **Accept**: application/json
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
<a name="get_integrations_action_draft_schema"></a>
|
281
|
+
|
282
|
+
## -[**JsonSchemaDocument**](JsonSchemaDocument.html) get_integrations_action_draft_schema(action_id, file_name)
|
283
|
+
|
284
|
+
Retrieve schema for a Draft based on filename.
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}
|
289
|
+
|
290
|
+
|
291
|
+
### Example
|
292
|
+
~~~ruby
|
293
|
+
# load the gem
|
294
|
+
require 'purecloudplatformclientv2'
|
295
|
+
# setup authorization
|
296
|
+
@secret = ENV['PURECLOUD_SECRET']
|
297
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
298
|
+
environment = "mypurecloud.com"
|
299
|
+
|
300
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
301
|
+
|
302
|
+
PureCloud.configure do |config|
|
303
|
+
config.access_token = @authToken
|
304
|
+
end
|
305
|
+
|
306
|
+
api_instance = PureCloud::IntegrationsApi.new
|
307
|
+
|
308
|
+
action_id = "action_id_example" # String | actionId
|
309
|
+
|
310
|
+
file_name = "file_name_example" # String | Name of schema file to be retrieved for this draft.
|
311
|
+
|
312
|
+
|
313
|
+
begin
|
314
|
+
#Retrieve schema for a Draft based on filename.
|
315
|
+
result = api_instance.get_integrations_action_draft_schema(action_id, file_name)
|
316
|
+
p result
|
317
|
+
rescue PureCloud::ApiError => e
|
318
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_draft_schema: #{e}"
|
319
|
+
end
|
320
|
+
~~~
|
321
|
+
|
322
|
+
### Parameters
|
323
|
+
|
324
|
+
Name | Type | Description | Notes
|
325
|
+
------------- | ------------- | ------------- | -------------
|
326
|
+
**action_id** | **String**| actionId | |
|
327
|
+
**file_name** | **String**| Name of schema file to be retrieved for this draft. | |
|
328
|
+
{: class="table table-striped"}
|
329
|
+
|
330
|
+
|
331
|
+
### Return type
|
332
|
+
|
333
|
+
[**JsonSchemaDocument**](JsonSchemaDocument.html)
|
334
|
+
|
335
|
+
### HTTP request headers
|
336
|
+
|
337
|
+
- **Content-Type**: application/json
|
338
|
+
- **Accept**: application/json
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
<a name="get_integrations_action_draft_template"></a>
|
343
|
+
|
344
|
+
## -String** get_integrations_action_draft_template(action_id, file_name)
|
345
|
+
|
346
|
+
Retrieve templates for a Draft based on filename.
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/draft/templates/{fileName}
|
351
|
+
|
352
|
+
|
353
|
+
### Example
|
354
|
+
~~~ruby
|
355
|
+
# load the gem
|
356
|
+
require 'purecloudplatformclientv2'
|
357
|
+
# setup authorization
|
358
|
+
@secret = ENV['PURECLOUD_SECRET']
|
359
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
360
|
+
environment = "mypurecloud.com"
|
361
|
+
|
362
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
363
|
+
|
364
|
+
PureCloud.configure do |config|
|
365
|
+
config.access_token = @authToken
|
366
|
+
end
|
367
|
+
|
368
|
+
api_instance = PureCloud::IntegrationsApi.new
|
369
|
+
|
370
|
+
action_id = "action_id_example" # String | actionId
|
371
|
+
|
372
|
+
file_name = "file_name_example" # String | Name of template file to be retrieved for this action draft.
|
373
|
+
|
374
|
+
|
375
|
+
begin
|
376
|
+
#Retrieve templates for a Draft based on filename.
|
377
|
+
result = api_instance.get_integrations_action_draft_template(action_id, file_name)
|
378
|
+
p result
|
379
|
+
rescue PureCloud::ApiError => e
|
380
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_draft_template: #{e}"
|
381
|
+
end
|
382
|
+
~~~
|
383
|
+
|
384
|
+
### Parameters
|
385
|
+
|
386
|
+
Name | Type | Description | Notes
|
387
|
+
------------- | ------------- | ------------- | -------------
|
388
|
+
**action_id** | **String**| actionId | |
|
389
|
+
**file_name** | **String**| Name of template file to be retrieved for this action draft. | |
|
390
|
+
{: class="table table-striped"}
|
391
|
+
|
392
|
+
|
393
|
+
### Return type
|
394
|
+
|
395
|
+
**String**
|
396
|
+
|
397
|
+
### HTTP request headers
|
398
|
+
|
399
|
+
- **Content-Type**: application/json
|
400
|
+
- **Accept**: text/plain
|
401
|
+
|
402
|
+
|
403
|
+
|
404
|
+
<a name="get_integrations_action_draft_validation"></a>
|
405
|
+
|
406
|
+
## -[**DraftValidationResult**](DraftValidationResult.html) get_integrations_action_draft_validation(action_id)
|
407
|
+
|
408
|
+
Validate current Draft configuration.
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/draft/validation
|
413
|
+
|
414
|
+
|
415
|
+
### Example
|
416
|
+
~~~ruby
|
417
|
+
# load the gem
|
418
|
+
require 'purecloudplatformclientv2'
|
419
|
+
# setup authorization
|
420
|
+
@secret = ENV['PURECLOUD_SECRET']
|
421
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
422
|
+
environment = "mypurecloud.com"
|
423
|
+
|
424
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
425
|
+
|
426
|
+
PureCloud.configure do |config|
|
427
|
+
config.access_token = @authToken
|
428
|
+
end
|
429
|
+
|
430
|
+
api_instance = PureCloud::IntegrationsApi.new
|
431
|
+
|
432
|
+
action_id = "action_id_example" # String | actionId
|
433
|
+
|
434
|
+
|
435
|
+
begin
|
436
|
+
#Validate current Draft configuration.
|
437
|
+
result = api_instance.get_integrations_action_draft_validation(action_id)
|
438
|
+
p result
|
439
|
+
rescue PureCloud::ApiError => e
|
440
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_draft_validation: #{e}"
|
441
|
+
end
|
442
|
+
~~~
|
443
|
+
|
444
|
+
### Parameters
|
445
|
+
|
446
|
+
Name | Type | Description | Notes
|
447
|
+
------------- | ------------- | ------------- | -------------
|
448
|
+
**action_id** | **String**| actionId | |
|
449
|
+
{: class="table table-striped"}
|
450
|
+
|
451
|
+
|
452
|
+
### Return type
|
453
|
+
|
454
|
+
[**DraftValidationResult**](DraftValidationResult.html)
|
455
|
+
|
456
|
+
### HTTP request headers
|
457
|
+
|
458
|
+
- **Content-Type**: application/json
|
459
|
+
- **Accept**: application/json
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
<a name="get_integrations_action_schema"></a>
|
464
|
+
|
465
|
+
## -[**JsonSchemaDocument**](JsonSchemaDocument.html) get_integrations_action_schema(action_id, file_name)
|
466
|
+
|
467
|
+
Retrieve schema for an action based on filename.
|
468
|
+
|
469
|
+
|
470
|
+
|
471
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/schemas/{fileName}
|
472
|
+
|
473
|
+
|
474
|
+
### Example
|
475
|
+
~~~ruby
|
476
|
+
# load the gem
|
477
|
+
require 'purecloudplatformclientv2'
|
478
|
+
# setup authorization
|
479
|
+
@secret = ENV['PURECLOUD_SECRET']
|
480
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
481
|
+
environment = "mypurecloud.com"
|
482
|
+
|
483
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
484
|
+
|
485
|
+
PureCloud.configure do |config|
|
486
|
+
config.access_token = @authToken
|
487
|
+
end
|
488
|
+
|
489
|
+
api_instance = PureCloud::IntegrationsApi.new
|
490
|
+
|
491
|
+
action_id = "action_id_example" # String | actionId
|
492
|
+
|
493
|
+
file_name = "file_name_example" # String | Name of schema file to be retrieved for this action.
|
494
|
+
|
495
|
+
|
496
|
+
begin
|
497
|
+
#Retrieve schema for an action based on filename.
|
498
|
+
result = api_instance.get_integrations_action_schema(action_id, file_name)
|
499
|
+
p result
|
500
|
+
rescue PureCloud::ApiError => e
|
501
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_schema: #{e}"
|
502
|
+
end
|
503
|
+
~~~
|
504
|
+
|
505
|
+
### Parameters
|
506
|
+
|
507
|
+
Name | Type | Description | Notes
|
508
|
+
------------- | ------------- | ------------- | -------------
|
509
|
+
**action_id** | **String**| actionId | |
|
510
|
+
**file_name** | **String**| Name of schema file to be retrieved for this action. | |
|
511
|
+
{: class="table table-striped"}
|
512
|
+
|
513
|
+
|
514
|
+
### Return type
|
515
|
+
|
516
|
+
[**JsonSchemaDocument**](JsonSchemaDocument.html)
|
517
|
+
|
518
|
+
### HTTP request headers
|
519
|
+
|
520
|
+
- **Content-Type**: application/json
|
521
|
+
- **Accept**: application/json
|
522
|
+
|
523
|
+
|
524
|
+
|
525
|
+
<a name="get_integrations_action_template"></a>
|
526
|
+
|
527
|
+
## -String** get_integrations_action_template(action_id, file_name)
|
528
|
+
|
529
|
+
Retrieve text of templates for an action based on filename.
|
530
|
+
|
531
|
+
|
532
|
+
|
533
|
+
Wraps GET /api/v2/integrations/actions/{actionId}/templates/{fileName}
|
534
|
+
|
535
|
+
|
536
|
+
### Example
|
537
|
+
~~~ruby
|
538
|
+
# load the gem
|
539
|
+
require 'purecloudplatformclientv2'
|
540
|
+
# setup authorization
|
541
|
+
@secret = ENV['PURECLOUD_SECRET']
|
542
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
543
|
+
environment = "mypurecloud.com"
|
544
|
+
|
545
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
546
|
+
|
547
|
+
PureCloud.configure do |config|
|
548
|
+
config.access_token = @authToken
|
549
|
+
end
|
550
|
+
|
551
|
+
api_instance = PureCloud::IntegrationsApi.new
|
552
|
+
|
553
|
+
action_id = "action_id_example" # String | actionId
|
554
|
+
|
555
|
+
file_name = "file_name_example" # String | Name of template file to be retrieved for this action.
|
556
|
+
|
557
|
+
|
558
|
+
begin
|
559
|
+
#Retrieve text of templates for an action based on filename.
|
560
|
+
result = api_instance.get_integrations_action_template(action_id, file_name)
|
561
|
+
p result
|
562
|
+
rescue PureCloud::ApiError => e
|
563
|
+
puts "Exception when calling IntegrationsApi->get_integrations_action_template: #{e}"
|
564
|
+
end
|
565
|
+
~~~
|
566
|
+
|
567
|
+
### Parameters
|
568
|
+
|
569
|
+
Name | Type | Description | Notes
|
570
|
+
------------- | ------------- | ------------- | -------------
|
571
|
+
**action_id** | **String**| actionId | |
|
572
|
+
**file_name** | **String**| Name of template file to be retrieved for this action. | |
|
573
|
+
{: class="table table-striped"}
|
574
|
+
|
575
|
+
|
576
|
+
### Return type
|
577
|
+
|
578
|
+
**String**
|
579
|
+
|
580
|
+
### HTTP request headers
|
581
|
+
|
582
|
+
- **Content-Type**: application/json
|
583
|
+
- **Accept**: text/plain
|
584
|
+
|
585
|
+
|
586
|
+
|
587
|
+
<a name="get_integrations_actions"></a>
|
588
|
+
|
589
|
+
## -[**ActionEntityListing**](ActionEntityListing.html) get_integrations_actions(opts)
|
590
|
+
|
591
|
+
Retrieves all actions associated with filters passed in via query param.
|
592
|
+
|
593
|
+
|
594
|
+
|
595
|
+
Wraps GET /api/v2/integrations/actions
|
596
|
+
|
597
|
+
|
598
|
+
### Example
|
599
|
+
~~~ruby
|
600
|
+
# load the gem
|
601
|
+
require 'purecloudplatformclientv2'
|
602
|
+
# setup authorization
|
603
|
+
@secret = ENV['PURECLOUD_SECRET']
|
604
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
605
|
+
environment = "mypurecloud.com"
|
606
|
+
|
607
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
608
|
+
|
609
|
+
PureCloud.configure do |config|
|
610
|
+
config.access_token = @authToken
|
611
|
+
end
|
612
|
+
|
613
|
+
api_instance = PureCloud::IntegrationsApi.new
|
614
|
+
|
615
|
+
opts = {
|
616
|
+
category: "category_example", # String | Filter by category name
|
617
|
+
secure: "secure_example", # String | Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
618
|
+
page_size: 25, # Integer | The total page size requested
|
619
|
+
page_number: 1, # Integer | The page number requested
|
620
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
621
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
622
|
+
next_page: "next_page_example", # String | next page token
|
623
|
+
previous_page: "previous_page_example" # String | Previous page token
|
624
|
+
}
|
625
|
+
|
626
|
+
begin
|
627
|
+
#Retrieves all actions associated with filters passed in via query param.
|
628
|
+
result = api_instance.get_integrations_actions(opts)
|
629
|
+
p result
|
630
|
+
rescue PureCloud::ApiError => e
|
631
|
+
puts "Exception when calling IntegrationsApi->get_integrations_actions: #{e}"
|
632
|
+
end
|
633
|
+
~~~
|
634
|
+
|
635
|
+
### Parameters
|
636
|
+
|
637
|
+
Name | Type | Description | Notes
|
638
|
+
------------- | ------------- | ------------- | -------------
|
639
|
+
**category** | **String**| Filter by category name | [optional] |
|
640
|
+
**secure** | **String**| Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. | [optional] <br />**Values**: true, false |
|
641
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
642
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
643
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
644
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
645
|
+
**next_page** | **String**| next page token | [optional] |
|
646
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
647
|
+
{: class="table table-striped"}
|
648
|
+
|
649
|
+
|
650
|
+
### Return type
|
651
|
+
|
652
|
+
[**ActionEntityListing**](ActionEntityListing.html)
|
653
|
+
|
654
|
+
### HTTP request headers
|
655
|
+
|
656
|
+
- **Content-Type**: application/json
|
657
|
+
- **Accept**: application/json
|
658
|
+
|
659
|
+
|
660
|
+
|
661
|
+
<a name="get_integrations_actions_categories"></a>
|
662
|
+
|
663
|
+
## -[**CategoryEntityListing**](CategoryEntityListing.html) get_integrations_actions_categories(opts)
|
664
|
+
|
665
|
+
Retrieves all categories of available Actions
|
666
|
+
|
667
|
+
|
668
|
+
|
669
|
+
Wraps GET /api/v2/integrations/actions/categories
|
670
|
+
|
671
|
+
|
672
|
+
### Example
|
673
|
+
~~~ruby
|
674
|
+
# load the gem
|
675
|
+
require 'purecloudplatformclientv2'
|
676
|
+
# setup authorization
|
677
|
+
@secret = ENV['PURECLOUD_SECRET']
|
678
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
679
|
+
environment = "mypurecloud.com"
|
680
|
+
|
681
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
682
|
+
|
683
|
+
PureCloud.configure do |config|
|
684
|
+
config.access_token = @authToken
|
685
|
+
end
|
686
|
+
|
687
|
+
api_instance = PureCloud::IntegrationsApi.new
|
688
|
+
|
689
|
+
opts = {
|
690
|
+
secure: "secure_example", # String | Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions.
|
691
|
+
page_size: 25, # Integer | The total page size requested
|
692
|
+
page_number: 1, # Integer | The page number requested
|
693
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
694
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
695
|
+
next_page: "next_page_example", # String | next page token
|
696
|
+
previous_page: "previous_page_example" # String | Previous page token
|
697
|
+
}
|
698
|
+
|
699
|
+
begin
|
700
|
+
#Retrieves all categories of available Actions
|
701
|
+
result = api_instance.get_integrations_actions_categories(opts)
|
702
|
+
p result
|
703
|
+
rescue PureCloud::ApiError => e
|
704
|
+
puts "Exception when calling IntegrationsApi->get_integrations_actions_categories: #{e}"
|
705
|
+
end
|
706
|
+
~~~
|
707
|
+
|
708
|
+
### Parameters
|
709
|
+
|
710
|
+
Name | Type | Description | Notes
|
711
|
+
------------- | ------------- | ------------- | -------------
|
712
|
+
**secure** | **String**| Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions. | [optional] <br />**Values**: true, false |
|
713
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
714
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
715
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
716
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
717
|
+
**next_page** | **String**| next page token | [optional] |
|
718
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
719
|
+
{: class="table table-striped"}
|
720
|
+
|
721
|
+
|
722
|
+
### Return type
|
723
|
+
|
724
|
+
[**CategoryEntityListing**](CategoryEntityListing.html)
|
725
|
+
|
726
|
+
### HTTP request headers
|
727
|
+
|
728
|
+
- **Content-Type**: application/json
|
729
|
+
- **Accept**: application/json
|
730
|
+
|
731
|
+
|
732
|
+
|
733
|
+
<a name="get_integrations_actions_drafts"></a>
|
734
|
+
|
735
|
+
## -[**ActionEntityListing**](ActionEntityListing.html) get_integrations_actions_drafts(opts)
|
736
|
+
|
737
|
+
Retrieves all action drafts associated with the filters passed in via query param.
|
738
|
+
|
739
|
+
|
740
|
+
|
741
|
+
Wraps GET /api/v2/integrations/actions/drafts
|
742
|
+
|
743
|
+
|
744
|
+
### Example
|
745
|
+
~~~ruby
|
746
|
+
# load the gem
|
747
|
+
require 'purecloudplatformclientv2'
|
748
|
+
# setup authorization
|
749
|
+
@secret = ENV['PURECLOUD_SECRET']
|
750
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
751
|
+
environment = "mypurecloud.com"
|
752
|
+
|
753
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
754
|
+
|
755
|
+
PureCloud.configure do |config|
|
756
|
+
config.access_token = @authToken
|
757
|
+
end
|
758
|
+
|
759
|
+
api_instance = PureCloud::IntegrationsApi.new
|
760
|
+
|
761
|
+
opts = {
|
762
|
+
category: "category_example", # String | Filter by category name
|
763
|
+
secure: "secure_example", # String | Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
764
|
+
page_size: 25, # Integer | The total page size requested
|
765
|
+
page_number: 1, # Integer | The page number requested
|
766
|
+
sort_by: "sort_by_example", # String | variable name requested to sort by
|
767
|
+
expand: nil, # Array<Object> | variable name requested by expand list
|
768
|
+
next_page: "next_page_example", # String | next page token
|
769
|
+
previous_page: "previous_page_example" # String | Previous page token
|
770
|
+
}
|
771
|
+
|
772
|
+
begin
|
773
|
+
#Retrieves all action drafts associated with the filters passed in via query param.
|
774
|
+
result = api_instance.get_integrations_actions_drafts(opts)
|
775
|
+
p result
|
776
|
+
rescue PureCloud::ApiError => e
|
777
|
+
puts "Exception when calling IntegrationsApi->get_integrations_actions_drafts: #{e}"
|
778
|
+
end
|
779
|
+
~~~
|
780
|
+
|
781
|
+
### Parameters
|
782
|
+
|
783
|
+
Name | Type | Description | Notes
|
784
|
+
------------- | ------------- | ------------- | -------------
|
785
|
+
**category** | **String**| Filter by category name | [optional] |
|
786
|
+
**secure** | **String**| Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. | [optional] <br />**Values**: true, false |
|
787
|
+
**page_size** | **Integer**| The total page size requested | [optional] [default to 25] |
|
788
|
+
**page_number** | **Integer**| The page number requested | [optional] [default to 1] |
|
789
|
+
**sort_by** | **String**| variable name requested to sort by | [optional] |
|
790
|
+
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional] |
|
791
|
+
**next_page** | **String**| next page token | [optional] |
|
792
|
+
**previous_page** | **String**| Previous page token | [optional] |
|
793
|
+
{: class="table table-striped"}
|
794
|
+
|
795
|
+
|
796
|
+
### Return type
|
797
|
+
|
798
|
+
[**ActionEntityListing**](ActionEntityListing.html)
|
799
|
+
|
800
|
+
### HTTP request headers
|
801
|
+
|
802
|
+
- **Content-Type**: application/json
|
803
|
+
- **Accept**: application/json
|
804
|
+
|
805
|
+
|
806
|
+
|
807
|
+
<a name="patch_integrations_action"></a>
|
808
|
+
|
809
|
+
## -[**Action**](Action.html) patch_integrations_action(action_id, body)
|
810
|
+
|
811
|
+
Patch an Action
|
812
|
+
|
813
|
+
|
814
|
+
|
815
|
+
Wraps PATCH /api/v2/integrations/actions/{actionId}
|
816
|
+
|
817
|
+
|
818
|
+
### Example
|
819
|
+
~~~ruby
|
820
|
+
# load the gem
|
821
|
+
require 'purecloudplatformclientv2'
|
822
|
+
# setup authorization
|
823
|
+
@secret = ENV['PURECLOUD_SECRET']
|
824
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
825
|
+
environment = "mypurecloud.com"
|
826
|
+
|
827
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
828
|
+
|
829
|
+
PureCloud.configure do |config|
|
830
|
+
config.access_token = @authToken
|
831
|
+
end
|
832
|
+
|
833
|
+
api_instance = PureCloud::IntegrationsApi.new
|
834
|
+
|
835
|
+
action_id = "action_id_example" # String | actionId
|
836
|
+
|
837
|
+
body = PureCloud::UpdateActionInput.new # UpdateActionInput | Input used to patch the Action.
|
838
|
+
|
839
|
+
|
840
|
+
begin
|
841
|
+
#Patch an Action
|
842
|
+
result = api_instance.patch_integrations_action(action_id, body)
|
843
|
+
p result
|
844
|
+
rescue PureCloud::ApiError => e
|
845
|
+
puts "Exception when calling IntegrationsApi->patch_integrations_action: #{e}"
|
846
|
+
end
|
847
|
+
~~~
|
848
|
+
|
849
|
+
### Parameters
|
850
|
+
|
851
|
+
Name | Type | Description | Notes
|
852
|
+
------------- | ------------- | ------------- | -------------
|
853
|
+
**action_id** | **String**| actionId | |
|
854
|
+
**body** | [**UpdateActionInput**](UpdateActionInput.html)| Input used to patch the Action. | |
|
855
|
+
{: class="table table-striped"}
|
856
|
+
|
857
|
+
|
858
|
+
### Return type
|
859
|
+
|
860
|
+
[**Action**](Action.html)
|
861
|
+
|
862
|
+
### HTTP request headers
|
863
|
+
|
864
|
+
- **Content-Type**: application/json
|
865
|
+
- **Accept**: application/json
|
866
|
+
|
867
|
+
|
868
|
+
|
869
|
+
<a name="patch_integrations_action_draft"></a>
|
870
|
+
|
871
|
+
## -[**Action**](Action.html) patch_integrations_action_draft(action_id, body)
|
872
|
+
|
873
|
+
Update an existing Draft
|
874
|
+
|
875
|
+
|
876
|
+
|
877
|
+
Wraps PATCH /api/v2/integrations/actions/{actionId}/draft
|
878
|
+
|
879
|
+
|
880
|
+
### Example
|
881
|
+
~~~ruby
|
882
|
+
# load the gem
|
883
|
+
require 'purecloudplatformclientv2'
|
884
|
+
# setup authorization
|
885
|
+
@secret = ENV['PURECLOUD_SECRET']
|
886
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
887
|
+
environment = "mypurecloud.com"
|
888
|
+
|
889
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
890
|
+
|
891
|
+
PureCloud.configure do |config|
|
892
|
+
config.access_token = @authToken
|
893
|
+
end
|
894
|
+
|
895
|
+
api_instance = PureCloud::IntegrationsApi.new
|
896
|
+
|
897
|
+
action_id = "action_id_example" # String | actionId
|
898
|
+
|
899
|
+
body = PureCloud::UpdateDraftInput.new # UpdateDraftInput | Input used to patch the Action Draft.
|
900
|
+
|
901
|
+
|
902
|
+
begin
|
903
|
+
#Update an existing Draft
|
904
|
+
result = api_instance.patch_integrations_action_draft(action_id, body)
|
905
|
+
p result
|
906
|
+
rescue PureCloud::ApiError => e
|
907
|
+
puts "Exception when calling IntegrationsApi->patch_integrations_action_draft: #{e}"
|
908
|
+
end
|
909
|
+
~~~
|
910
|
+
|
911
|
+
### Parameters
|
912
|
+
|
913
|
+
Name | Type | Description | Notes
|
914
|
+
------------- | ------------- | ------------- | -------------
|
915
|
+
**action_id** | **String**| actionId | |
|
916
|
+
**body** | [**UpdateDraftInput**](UpdateDraftInput.html)| Input used to patch the Action Draft. | |
|
917
|
+
{: class="table table-striped"}
|
918
|
+
|
919
|
+
|
920
|
+
### Return type
|
921
|
+
|
922
|
+
[**Action**](Action.html)
|
923
|
+
|
924
|
+
### HTTP request headers
|
925
|
+
|
926
|
+
- **Content-Type**: application/json
|
927
|
+
- **Accept**: application/json
|
928
|
+
|
929
|
+
|
930
|
+
|
931
|
+
<a name="post_integrations_action_draft"></a>
|
932
|
+
|
933
|
+
## -[**Action**](Action.html) post_integrations_action_draft(action_id)
|
934
|
+
|
935
|
+
Create a new Draft from existing Action
|
936
|
+
|
937
|
+
|
938
|
+
|
939
|
+
Wraps POST /api/v2/integrations/actions/{actionId}/draft
|
940
|
+
|
941
|
+
|
942
|
+
### Example
|
943
|
+
~~~ruby
|
944
|
+
# load the gem
|
945
|
+
require 'purecloudplatformclientv2'
|
946
|
+
# setup authorization
|
947
|
+
@secret = ENV['PURECLOUD_SECRET']
|
948
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
949
|
+
environment = "mypurecloud.com"
|
950
|
+
|
951
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
952
|
+
|
953
|
+
PureCloud.configure do |config|
|
954
|
+
config.access_token = @authToken
|
955
|
+
end
|
956
|
+
|
957
|
+
api_instance = PureCloud::IntegrationsApi.new
|
958
|
+
|
959
|
+
action_id = "action_id_example" # String | actionId
|
960
|
+
|
961
|
+
|
962
|
+
begin
|
963
|
+
#Create a new Draft from existing Action
|
964
|
+
result = api_instance.post_integrations_action_draft(action_id)
|
965
|
+
p result
|
966
|
+
rescue PureCloud::ApiError => e
|
967
|
+
puts "Exception when calling IntegrationsApi->post_integrations_action_draft: #{e}"
|
968
|
+
end
|
969
|
+
~~~
|
970
|
+
|
971
|
+
### Parameters
|
972
|
+
|
973
|
+
Name | Type | Description | Notes
|
974
|
+
------------- | ------------- | ------------- | -------------
|
975
|
+
**action_id** | **String**| actionId | |
|
976
|
+
{: class="table table-striped"}
|
977
|
+
|
978
|
+
|
979
|
+
### Return type
|
980
|
+
|
981
|
+
[**Action**](Action.html)
|
982
|
+
|
983
|
+
### HTTP request headers
|
984
|
+
|
985
|
+
- **Content-Type**: application/json
|
986
|
+
- **Accept**: application/json
|
987
|
+
|
988
|
+
|
989
|
+
|
990
|
+
<a name="post_integrations_action_draft_publish"></a>
|
991
|
+
|
992
|
+
## -[**Action**](Action.html) post_integrations_action_draft_publish(action_id, body)
|
993
|
+
|
994
|
+
Publish a Draft and make it the active Action configuration
|
995
|
+
|
996
|
+
|
997
|
+
|
998
|
+
Wraps POST /api/v2/integrations/actions/{actionId}/draft/publish
|
999
|
+
|
1000
|
+
|
1001
|
+
### Example
|
1002
|
+
~~~ruby
|
1003
|
+
# load the gem
|
1004
|
+
require 'purecloudplatformclientv2'
|
1005
|
+
# setup authorization
|
1006
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1007
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1008
|
+
environment = "mypurecloud.com"
|
1009
|
+
|
1010
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1011
|
+
|
1012
|
+
PureCloud.configure do |config|
|
1013
|
+
config.access_token = @authToken
|
1014
|
+
end
|
1015
|
+
|
1016
|
+
api_instance = PureCloud::IntegrationsApi.new
|
1017
|
+
|
1018
|
+
action_id = "action_id_example" # String | actionId
|
1019
|
+
|
1020
|
+
body = PureCloud::PublishDraftInput.new # PublishDraftInput | Input used to patch the Action.
|
1021
|
+
|
1022
|
+
|
1023
|
+
begin
|
1024
|
+
#Publish a Draft and make it the active Action configuration
|
1025
|
+
result = api_instance.post_integrations_action_draft_publish(action_id, body)
|
1026
|
+
p result
|
1027
|
+
rescue PureCloud::ApiError => e
|
1028
|
+
puts "Exception when calling IntegrationsApi->post_integrations_action_draft_publish: #{e}"
|
1029
|
+
end
|
1030
|
+
~~~
|
1031
|
+
|
1032
|
+
### Parameters
|
1033
|
+
|
1034
|
+
Name | Type | Description | Notes
|
1035
|
+
------------- | ------------- | ------------- | -------------
|
1036
|
+
**action_id** | **String**| actionId | |
|
1037
|
+
**body** | [**PublishDraftInput**](PublishDraftInput.html)| Input used to patch the Action. | |
|
1038
|
+
{: class="table table-striped"}
|
1039
|
+
|
1040
|
+
|
1041
|
+
### Return type
|
1042
|
+
|
1043
|
+
[**Action**](Action.html)
|
1044
|
+
|
1045
|
+
### HTTP request headers
|
1046
|
+
|
1047
|
+
- **Content-Type**: application/json
|
1048
|
+
- **Accept**: application/json
|
1049
|
+
|
1050
|
+
|
1051
|
+
|
1052
|
+
<a name="post_integrations_action_draft_test"></a>
|
1053
|
+
|
1054
|
+
## -[**TestExecutionResult**](TestExecutionResult.html) post_integrations_action_draft_test(action_id, body)
|
1055
|
+
|
1056
|
+
Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.
|
1057
|
+
|
1058
|
+
|
1059
|
+
|
1060
|
+
Wraps POST /api/v2/integrations/actions/{actionId}/draft/test
|
1061
|
+
|
1062
|
+
|
1063
|
+
### Example
|
1064
|
+
~~~ruby
|
1065
|
+
# load the gem
|
1066
|
+
require 'purecloudplatformclientv2'
|
1067
|
+
# setup authorization
|
1068
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1069
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1070
|
+
environment = "mypurecloud.com"
|
1071
|
+
|
1072
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1073
|
+
|
1074
|
+
PureCloud.configure do |config|
|
1075
|
+
config.access_token = @authToken
|
1076
|
+
end
|
1077
|
+
|
1078
|
+
api_instance = PureCloud::IntegrationsApi.new
|
1079
|
+
|
1080
|
+
action_id = "action_id_example" # String | actionId
|
1081
|
+
|
1082
|
+
body = nil # Object | Map of parameters used for variable substitution.
|
1083
|
+
|
1084
|
+
|
1085
|
+
begin
|
1086
|
+
#Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.
|
1087
|
+
result = api_instance.post_integrations_action_draft_test(action_id, body)
|
1088
|
+
p result
|
1089
|
+
rescue PureCloud::ApiError => e
|
1090
|
+
puts "Exception when calling IntegrationsApi->post_integrations_action_draft_test: #{e}"
|
1091
|
+
end
|
1092
|
+
~~~
|
1093
|
+
|
1094
|
+
### Parameters
|
1095
|
+
|
1096
|
+
Name | Type | Description | Notes
|
1097
|
+
------------- | ------------- | ------------- | -------------
|
1098
|
+
**action_id** | **String**| actionId | |
|
1099
|
+
**body** | **Object**| Map of parameters used for variable substitution. | |
|
1100
|
+
{: class="table table-striped"}
|
1101
|
+
|
1102
|
+
|
1103
|
+
### Return type
|
1104
|
+
|
1105
|
+
[**TestExecutionResult**](TestExecutionResult.html)
|
1106
|
+
|
1107
|
+
### HTTP request headers
|
1108
|
+
|
1109
|
+
- **Content-Type**: application/json
|
1110
|
+
- **Accept**: application/json
|
1111
|
+
|
1112
|
+
|
1113
|
+
|
1114
|
+
<a name="post_integrations_action_execute"></a>
|
1115
|
+
|
1116
|
+
## -Object** post_integrations_action_execute(action_id, body)
|
1117
|
+
|
1118
|
+
Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.
|
1119
|
+
|
1120
|
+
|
1121
|
+
|
1122
|
+
Wraps POST /api/v2/integrations/actions/{actionId}/execute
|
1123
|
+
|
1124
|
+
|
1125
|
+
### Example
|
1126
|
+
~~~ruby
|
1127
|
+
# load the gem
|
1128
|
+
require 'purecloudplatformclientv2'
|
1129
|
+
# setup authorization
|
1130
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1131
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1132
|
+
environment = "mypurecloud.com"
|
1133
|
+
|
1134
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1135
|
+
|
1136
|
+
PureCloud.configure do |config|
|
1137
|
+
config.access_token = @authToken
|
1138
|
+
end
|
1139
|
+
|
1140
|
+
api_instance = PureCloud::IntegrationsApi.new
|
1141
|
+
|
1142
|
+
action_id = "action_id_example" # String | actionId
|
1143
|
+
|
1144
|
+
body = nil # Object | Map of parameters used for variable substitution.
|
1145
|
+
|
1146
|
+
|
1147
|
+
begin
|
1148
|
+
#Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.
|
1149
|
+
result = api_instance.post_integrations_action_execute(action_id, body)
|
1150
|
+
p result
|
1151
|
+
rescue PureCloud::ApiError => e
|
1152
|
+
puts "Exception when calling IntegrationsApi->post_integrations_action_execute: #{e}"
|
1153
|
+
end
|
1154
|
+
~~~
|
1155
|
+
|
1156
|
+
### Parameters
|
1157
|
+
|
1158
|
+
Name | Type | Description | Notes
|
1159
|
+
------------- | ------------- | ------------- | -------------
|
1160
|
+
**action_id** | **String**| actionId | |
|
1161
|
+
**body** | **Object**| Map of parameters used for variable substitution. | |
|
1162
|
+
{: class="table table-striped"}
|
1163
|
+
|
1164
|
+
|
1165
|
+
### Return type
|
1166
|
+
|
1167
|
+
**Object**
|
1168
|
+
|
1169
|
+
### HTTP request headers
|
1170
|
+
|
1171
|
+
- **Content-Type**: application/json
|
1172
|
+
- **Accept**: application/json
|
1173
|
+
|
1174
|
+
|
1175
|
+
|
1176
|
+
<a name="post_integrations_action_test"></a>
|
1177
|
+
|
1178
|
+
## -[**TestExecutionResult**](TestExecutionResult.html) post_integrations_action_test(action_id, body)
|
1179
|
+
|
1180
|
+
Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
|
1181
|
+
|
1182
|
+
|
1183
|
+
|
1184
|
+
Wraps POST /api/v2/integrations/actions/{actionId}/test
|
1185
|
+
|
1186
|
+
|
1187
|
+
### Example
|
1188
|
+
~~~ruby
|
1189
|
+
# load the gem
|
1190
|
+
require 'purecloudplatformclientv2'
|
1191
|
+
# setup authorization
|
1192
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1193
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1194
|
+
environment = "mypurecloud.com"
|
1195
|
+
|
1196
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1197
|
+
|
1198
|
+
PureCloud.configure do |config|
|
1199
|
+
config.access_token = @authToken
|
1200
|
+
end
|
1201
|
+
|
1202
|
+
api_instance = PureCloud::IntegrationsApi.new
|
1203
|
+
|
1204
|
+
action_id = "action_id_example" # String | actionId
|
1205
|
+
|
1206
|
+
body = nil # Object | Map of parameters used for variable substitution.
|
1207
|
+
|
1208
|
+
|
1209
|
+
begin
|
1210
|
+
#Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
|
1211
|
+
result = api_instance.post_integrations_action_test(action_id, body)
|
1212
|
+
p result
|
1213
|
+
rescue PureCloud::ApiError => e
|
1214
|
+
puts "Exception when calling IntegrationsApi->post_integrations_action_test: #{e}"
|
1215
|
+
end
|
1216
|
+
~~~
|
1217
|
+
|
1218
|
+
### Parameters
|
1219
|
+
|
1220
|
+
Name | Type | Description | Notes
|
1221
|
+
------------- | ------------- | ------------- | -------------
|
1222
|
+
**action_id** | **String**| actionId | |
|
1223
|
+
**body** | **Object**| Map of parameters used for variable substitution. | |
|
1224
|
+
{: class="table table-striped"}
|
1225
|
+
|
1226
|
+
|
1227
|
+
### Return type
|
1228
|
+
|
1229
|
+
[**TestExecutionResult**](TestExecutionResult.html)
|
1230
|
+
|
1231
|
+
### HTTP request headers
|
1232
|
+
|
1233
|
+
- **Content-Type**: application/json
|
1234
|
+
- **Accept**: application/json
|
1235
|
+
|
1236
|
+
|
1237
|
+
|
1238
|
+
<a name="post_integrations_actions"></a>
|
1239
|
+
|
1240
|
+
## -[**Action**](Action.html) post_integrations_actions(body)
|
1241
|
+
|
1242
|
+
Create a new Action
|
1243
|
+
|
1244
|
+
|
1245
|
+
|
1246
|
+
Wraps POST /api/v2/integrations/actions
|
1247
|
+
|
1248
|
+
|
1249
|
+
### Example
|
1250
|
+
~~~ruby
|
1251
|
+
# load the gem
|
1252
|
+
require 'purecloudplatformclientv2'
|
1253
|
+
# setup authorization
|
1254
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1255
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1256
|
+
environment = "mypurecloud.com"
|
1257
|
+
|
1258
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1259
|
+
|
1260
|
+
PureCloud.configure do |config|
|
1261
|
+
config.access_token = @authToken
|
1262
|
+
end
|
1263
|
+
|
1264
|
+
api_instance = PureCloud::IntegrationsApi.new
|
1265
|
+
|
1266
|
+
body = PureCloud::PostActionInput.new # PostActionInput | Input used to create Action.
|
1267
|
+
|
1268
|
+
|
1269
|
+
begin
|
1270
|
+
#Create a new Action
|
1271
|
+
result = api_instance.post_integrations_actions(body)
|
1272
|
+
p result
|
1273
|
+
rescue PureCloud::ApiError => e
|
1274
|
+
puts "Exception when calling IntegrationsApi->post_integrations_actions: #{e}"
|
1275
|
+
end
|
1276
|
+
~~~
|
1277
|
+
|
1278
|
+
### Parameters
|
1279
|
+
|
1280
|
+
Name | Type | Description | Notes
|
1281
|
+
------------- | ------------- | ------------- | -------------
|
1282
|
+
**body** | [**PostActionInput**](PostActionInput.html)| Input used to create Action. | |
|
1283
|
+
{: class="table table-striped"}
|
1284
|
+
|
1285
|
+
|
1286
|
+
### Return type
|
1287
|
+
|
1288
|
+
[**Action**](Action.html)
|
1289
|
+
|
1290
|
+
### HTTP request headers
|
1291
|
+
|
1292
|
+
- **Content-Type**: application/json
|
1293
|
+
- **Accept**: application/json
|
1294
|
+
|
1295
|
+
|
1296
|
+
|
1297
|
+
<a name="post_integrations_actions_drafts"></a>
|
1298
|
+
|
1299
|
+
## -[**Action**](Action.html) post_integrations_actions_drafts(body)
|
1300
|
+
|
1301
|
+
Create a new Draft
|
1302
|
+
|
1303
|
+
|
1304
|
+
|
1305
|
+
Wraps POST /api/v2/integrations/actions/drafts
|
1306
|
+
|
1307
|
+
|
1308
|
+
### Example
|
1309
|
+
~~~ruby
|
1310
|
+
# load the gem
|
1311
|
+
require 'purecloudplatformclientv2'
|
1312
|
+
# setup authorization
|
1313
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1314
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1315
|
+
environment = "mypurecloud.com"
|
1316
|
+
|
1317
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1318
|
+
|
1319
|
+
PureCloud.configure do |config|
|
1320
|
+
config.access_token = @authToken
|
1321
|
+
end
|
1322
|
+
|
1323
|
+
api_instance = PureCloud::IntegrationsApi.new
|
1324
|
+
|
1325
|
+
body = PureCloud::PostActionInput.new # PostActionInput | Input used to create Action Draft.
|
1326
|
+
|
1327
|
+
|
1328
|
+
begin
|
1329
|
+
#Create a new Draft
|
1330
|
+
result = api_instance.post_integrations_actions_drafts(body)
|
1331
|
+
p result
|
1332
|
+
rescue PureCloud::ApiError => e
|
1333
|
+
puts "Exception when calling IntegrationsApi->post_integrations_actions_drafts: #{e}"
|
1334
|
+
end
|
1335
|
+
~~~
|
1336
|
+
|
1337
|
+
### Parameters
|
1338
|
+
|
1339
|
+
Name | Type | Description | Notes
|
1340
|
+
------------- | ------------- | ------------- | -------------
|
1341
|
+
**body** | [**PostActionInput**](PostActionInput.html)| Input used to create Action Draft. | |
|
1342
|
+
{: class="table table-striped"}
|
1343
|
+
|
1344
|
+
|
1345
|
+
### Return type
|
1346
|
+
|
1347
|
+
[**Action**](Action.html)
|
1348
|
+
|
1349
|
+
### HTTP request headers
|
1350
|
+
|
1351
|
+
- **Content-Type**: application/json
|
1352
|
+
- **Accept**: application/json
|
1353
|
+
|
1354
|
+
|
1355
|
+
|