purecloudplatformclientv2 20.0.0 → 21.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/AdherenceSettings.md +18 -0
- data/docs/AgentManagementUnitReference.md +14 -0
- data/docs/AnalyticsSession.md +1 -0
- data/docs/AnalyticsView.md +1 -1
- data/docs/ArchitectApi.md +19 -15
- data/docs/CallForwarding.md +4 -2
- data/docs/CallMediaParticipant.md +1 -0
- data/docs/CallRoute.md +14 -0
- data/docs/CallTarget.md +14 -0
- data/docs/Contact.md +1 -1
- data/docs/ConversationNotificationMessage.md +3 -0
- data/docs/ConversationNotificationMessageDetails.md +2 -0
- data/docs/ConversationNotificationMessages.md +2 -0
- data/docs/ConversationNotificationMessages1.md +3 -0
- data/docs/ConversationsApi.md +196 -0
- data/docs/CreateEmailRequest.md +2 -0
- data/docs/CreateQueueRequest.md +2 -0
- data/docs/CreateSecureSession.md +16 -0
- data/docs/ExternalContact.md +1 -0
- data/docs/ImportScriptStatusResponse.md +15 -0
- data/docs/InboundRoute.md +1 -0
- data/docs/JsonNode.md +1 -1
- data/docs/ManagementUnit.md +5 -3
- data/docs/ManagementUnitReference.md +14 -0
- data/docs/ManagementUnitSettings.md +19 -0
- data/docs/Message.md +3 -0
- data/docs/MessageConversationNotificationMessageDetails.md +2 -0
- data/docs/MessageConversationNotificationMessageMediaParticipant.md +3 -0
- data/docs/MessageConversationNotificationMessages.md +2 -0
- data/docs/MessageConversationNotificationParticipants.md +3 -0
- data/docs/MessageDetails.md +2 -0
- data/docs/QualityApi.md +3 -1
- data/docs/Queue.md +2 -0
- data/docs/SchedulingSettings.md +14 -0
- data/docs/ScriptsApi.md +64 -0
- data/docs/SecureSession.md +19 -0
- data/docs/SecureSessionEntityListing.md +13 -0
- data/docs/ShortTermForecastingSettings.md +13 -0
- data/docs/SignedData.md +13 -0
- data/docs/SignedDataApi.md +73 -0
- data/docs/TimeOffRequestSettings.md +15 -0
- data/docs/UpdateUser.md +2 -2
- data/docs/UserConversationSummaryNotification.md +1 -0
- data/docs/UserQueue.md +2 -0
- data/docs/UserReference.md +14 -0
- data/docs/WorkforceManagementApi.md +61 -0
- data/lib/purecloudplatformclientv2.rb +16 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +24 -6
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +243 -0
- data/lib/purecloudplatformclientv2/api/quality_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/scripts_api.rb +74 -0
- data/lib/purecloudplatformclientv2/api/signed_data_api.rb +90 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +63 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/adherence_settings.rb +335 -0
- data/lib/purecloudplatformclientv2/models/agent_management_unit_reference.rb +229 -0
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +41 -1
- data/lib/purecloudplatformclientv2/models/analytics_view.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_forwarding.rb +71 -1
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/call_route.rb +230 -0
- data/lib/purecloudplatformclientv2/models/call_target.rb +242 -0
- data/lib/purecloudplatformclientv2/models/contact.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_message.rb +90 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_message_details.rb +68 -4
- data/lib/purecloudplatformclientv2/models/conversation_notification_messages.rb +68 -4
- data/lib/purecloudplatformclientv2/models/conversation_notification_messages_1.rb +90 -1
- data/lib/purecloudplatformclientv2/models/create_email_request.rb +56 -4
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +53 -1
- data/lib/purecloudplatformclientv2/models/create_secure_session.rb +290 -0
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/external_contact.rb +26 -1
- data/lib/purecloudplatformclientv2/models/import_script_status_response.rb +251 -0
- data/lib/purecloudplatformclientv2/models/inbound_route.rb +27 -1
- data/lib/purecloudplatformclientv2/models/interaction_stat_alert_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stat_rule_notification.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/intraday_data_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +2 -2
- data/lib/purecloudplatformclientv2/models/json_node.rb +17 -17
- data/lib/purecloudplatformclientv2/models/management_unit.rb +59 -7
- data/lib/purecloudplatformclientv2/models/management_unit_reference.rb +229 -0
- data/lib/purecloudplatformclientv2/models/management_unit_settings.rb +364 -0
- data/lib/purecloudplatformclientv2/models/message.rb +93 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_details.rb +68 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_media_participant.rb +93 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_messages.rb +68 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_participants.rb +93 -4
- data/lib/purecloudplatformclientv2/models/message_details.rb +67 -1
- data/lib/purecloudplatformclientv2/models/participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue.rb +53 -1
- data/lib/purecloudplatformclientv2/models/scheduling_settings.rb +229 -0
- data/lib/purecloudplatformclientv2/models/secure_session.rb +382 -0
- data/lib/purecloudplatformclientv2/models/secure_session_entity_listing.rb +203 -0
- data/lib/purecloudplatformclientv2/models/short_term_forecasting_settings.rb +203 -0
- data/lib/purecloudplatformclientv2/models/signed_data.rb +201 -0
- data/lib/purecloudplatformclientv2/models/time_off_request_settings.rb +255 -0
- data/lib/purecloudplatformclientv2/models/update_user.rb +2 -1
- data/lib/purecloudplatformclientv2/models/user_conversation_summary_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/user_queue.rb +53 -1
- data/lib/purecloudplatformclientv2/models/user_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +34 -2
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: TimeOffRequestSettings
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::TimeOffRequestSettings
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **submission_range_enforced** | **BOOLEAN** | Whether to enforce a submission range for agent time off requests | [optional] |
|
|
11
|
+
| **submission_earliest_days_from_now** | **Integer** | The earliest number of days from now for which an agent can submit a time off request. Use negative numbers to indicate days in the past | [optional] |
|
|
12
|
+
| **submission_latest_days_from_now** | **Integer** | The latest number of days from now for which an agent can submit a time off request | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
data/docs/UpdateUser.md
CHANGED
|
@@ -12,8 +12,8 @@ title: UpdateUser
|
|
|
12
12
|
| **chat** | [**Chat**](Chat.html) | | [optional] |
|
|
13
13
|
| **department** | **String** | | [optional] |
|
|
14
14
|
| **email** | **String** | | [optional] |
|
|
15
|
-
| **primary_contact_info** | [**Array<Contact>**](Contact.html) |
|
|
16
|
-
| **addresses** | [**Array<Contact>**](Contact.html) | Email
|
|
15
|
+
| **primary_contact_info** | [**Array<Contact>**](Contact.html) | The address(s) used for primary contact. Updates to the corresponding address in the addresses list will be reflected here. | [optional] |
|
|
16
|
+
| **addresses** | [**Array<Contact>**](Contact.html) | Email address, phone number, and/or extension for this user. One entry is allowed per media type | [optional] |
|
|
17
17
|
| **title** | **String** | | [optional] |
|
|
18
18
|
| **username** | **String** | | [optional] |
|
|
19
19
|
| **manager** | **String** | | [optional] |
|
|
@@ -11,6 +11,7 @@ title: UserConversationSummaryNotification
|
|
|
11
11
|
| **call** | [**UserConversationSummaryNotificationCall**](UserConversationSummaryNotificationCall.html) | | [optional] |
|
|
12
12
|
| **callback** | [**UserConversationSummaryNotificationMediaSummary**](UserConversationSummaryNotificationMediaSummary.html) | | [optional] |
|
|
13
13
|
| **email** | [**UserConversationSummaryNotificationMediaSummary**](UserConversationSummaryNotificationMediaSummary.html) | | [optional] |
|
|
14
|
+
| **message** | [**UserConversationSummaryNotificationMediaSummary**](UserConversationSummaryNotificationMediaSummary.html) | | [optional] |
|
|
14
15
|
| **chat** | [**UserConversationSummaryNotificationMediaSummary**](UserConversationSummaryNotificationMediaSummary.html) | | [optional] |
|
|
15
16
|
| **social_expression** | [**UserConversationSummaryNotificationMediaSummary**](UserConversationSummaryNotificationMediaSummary.html) | | [optional] |
|
|
16
17
|
| **video** | [**UserConversationSummaryNotificationMediaSummary**](UserConversationSummaryNotificationMediaSummary.html) | | [optional] |
|
data/docs/UserQueue.md
CHANGED
|
@@ -23,6 +23,8 @@ title: UserQueue
|
|
|
23
23
|
| **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |
|
|
24
24
|
| **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | |
|
|
25
25
|
| **queue_flow** | [**UriReference**](UriReference.html) | The in-queue flow to use for conversations waiting in queue. | [optional] |
|
|
26
|
+
| **whisper** | [**UriReference**](UriReference.html) | The prompt used for whisper audio on the queue, if configured. | [optional] |
|
|
27
|
+
| **auto_answer_only** | **BOOLEAN** | Specifies whether the configured whisper audio should play for all ACD calls, or only for those which are auto-answered. | [optional] |
|
|
26
28
|
| **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
|
|
27
29
|
| **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
|
|
28
30
|
| **default_scripts** | [**Hash<String, Script>**](Script.html) | The default script Ids for the communication types. | [optional] |
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: UserReference
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::UserReference
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -18,6 +18,7 @@ Method | Description
|
|
|
18
18
|
[**get_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequest) | Get a time off request for the current user by id
|
|
19
19
|
[**get_workforcemanagement_timeoffrequests**](WorkforceManagementApi.html#get_workforcemanagement_timeoffrequests) | Get a list of time off requests for the current user
|
|
20
20
|
[**patch_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#patch_workforcemanagement_timeoffrequest) | Mark a time off request for the current user as read or unread
|
|
21
|
+
[**post_workforcemanagement_agents_managementunits**](WorkforceManagementApi.html#post_workforcemanagement_agents_managementunits) | Get the management units to which the agents belong
|
|
21
22
|
[**post_workforcemanagement_managementunit_historicaladherencequery**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_historicaladherencequery) | Request a historical adherence report
|
|
22
23
|
[**post_workforcemanagement_managementunit_intraday**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_intraday) | Get intraday data for the given date for the requested queueIds
|
|
23
24
|
[**post_workforcemanagement_managementunit_schedules_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_schedules_search) | Get user schedules within the given time range
|
|
@@ -637,6 +638,66 @@ nil (empty response body)
|
|
|
637
638
|
|
|
638
639
|
|
|
639
640
|
|
|
641
|
+
<a name="post_workforcemanagement_agents_managementunits"></a>
|
|
642
|
+
|
|
643
|
+
## -[**Array<AgentManagementUnitReference>**](AgentManagementUnitReference.html) post_workforcemanagement_agents_managementunits(opts)
|
|
644
|
+
|
|
645
|
+
Get the management units to which the agents belong
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
Wraps POST /api/v2/workforcemanagement/agents/managementunits
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
### Example
|
|
653
|
+
~~~ruby
|
|
654
|
+
# load the gem
|
|
655
|
+
require 'purecloudplatformclientv2'
|
|
656
|
+
# setup authorization
|
|
657
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
658
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
659
|
+
environment = "mypurecloud.com"
|
|
660
|
+
|
|
661
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
662
|
+
|
|
663
|
+
PureCloud.configure do |config|
|
|
664
|
+
config.access_token = @authToken
|
|
665
|
+
end
|
|
666
|
+
|
|
667
|
+
api_instance = PureCloud::WorkforceManagementApi.new
|
|
668
|
+
|
|
669
|
+
opts = {
|
|
670
|
+
body: [PureCloud::Array<String>.new] # Array<String> | body
|
|
671
|
+
}
|
|
672
|
+
|
|
673
|
+
begin
|
|
674
|
+
#Get the management units to which the agents belong
|
|
675
|
+
result = api_instance.post_workforcemanagement_agents_managementunits(opts)
|
|
676
|
+
p result
|
|
677
|
+
rescue PureCloud::ApiError => e
|
|
678
|
+
puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_agents_managementunits: #{e}"
|
|
679
|
+
end
|
|
680
|
+
~~~
|
|
681
|
+
|
|
682
|
+
### Parameters
|
|
683
|
+
|
|
684
|
+
Name | Type | Description | Notes
|
|
685
|
+
------------- | ------------- | ------------- | -------------
|
|
686
|
+
**body** | **Array<String>**| body | [optional] |
|
|
687
|
+
{: class="table table-striped"}
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
### Return type
|
|
691
|
+
|
|
692
|
+
[**Array<AgentManagementUnitReference>**](AgentManagementUnitReference.html)
|
|
693
|
+
|
|
694
|
+
### HTTP request headers
|
|
695
|
+
|
|
696
|
+
- **Content-Type**: application/json
|
|
697
|
+
- **Accept**: application/json
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
640
701
|
<a name="post_workforcemanagement_managementunit_historicaladherencequery"></a>
|
|
641
702
|
|
|
642
703
|
## -[**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
|
|
@@ -37,6 +37,7 @@ require 'purecloudplatformclientv2/models/acw_settings'
|
|
|
37
37
|
require 'purecloudplatformclientv2/models/address'
|
|
38
38
|
require 'purecloudplatformclientv2/models/addressable_entity_user'
|
|
39
39
|
require 'purecloudplatformclientv2/models/addressable_license_definition'
|
|
40
|
+
require 'purecloudplatformclientv2/models/adherence_settings'
|
|
40
41
|
require 'purecloudplatformclientv2/models/adjacents'
|
|
41
42
|
require 'purecloudplatformclientv2/models/agent'
|
|
42
43
|
require 'purecloudplatformclientv2/models/agent_activity'
|
|
@@ -48,6 +49,7 @@ require 'purecloudplatformclientv2/models/agent_activity_notification_presence'
|
|
|
48
49
|
require 'purecloudplatformclientv2/models/agent_activity_notification_presence_presence_definition'
|
|
49
50
|
require 'purecloudplatformclientv2/models/agent_activity_notification_routing_status'
|
|
50
51
|
require 'purecloudplatformclientv2/models/agent_evaluator_activity'
|
|
52
|
+
require 'purecloudplatformclientv2/models/agent_management_unit_reference'
|
|
51
53
|
require 'purecloudplatformclientv2/models/aggregate_data_container'
|
|
52
54
|
require 'purecloudplatformclientv2/models/aggregate_metric_data'
|
|
53
55
|
require 'purecloudplatformclientv2/models/aggregate_query_response'
|
|
@@ -129,6 +131,8 @@ require 'purecloudplatformclientv2/models/call_media_participant'
|
|
|
129
131
|
require 'purecloudplatformclientv2/models/call_media_policy'
|
|
130
132
|
require 'purecloudplatformclientv2/models/call_media_policy_conditions'
|
|
131
133
|
require 'purecloudplatformclientv2/models/call_record'
|
|
134
|
+
require 'purecloudplatformclientv2/models/call_route'
|
|
135
|
+
require 'purecloudplatformclientv2/models/call_target'
|
|
132
136
|
require 'purecloudplatformclientv2/models/callable_contacts_diagnostic'
|
|
133
137
|
require 'purecloudplatformclientv2/models/callable_time'
|
|
134
138
|
require 'purecloudplatformclientv2/models/callable_time_set'
|
|
@@ -324,6 +328,7 @@ require 'purecloudplatformclientv2/models/create_callback_on_conversation_comman
|
|
|
324
328
|
require 'purecloudplatformclientv2/models/create_callback_response'
|
|
325
329
|
require 'purecloudplatformclientv2/models/create_email_request'
|
|
326
330
|
require 'purecloudplatformclientv2/models/create_queue_request'
|
|
331
|
+
require 'purecloudplatformclientv2/models/create_secure_session'
|
|
327
332
|
require 'purecloudplatformclientv2/models/create_share_request'
|
|
328
333
|
require 'purecloudplatformclientv2/models/create_share_request_member'
|
|
329
334
|
require 'purecloudplatformclientv2/models/create_share_response'
|
|
@@ -552,6 +557,7 @@ require 'purecloudplatformclientv2/models/history_listing'
|
|
|
552
557
|
require 'purecloudplatformclientv2/models/ivr'
|
|
553
558
|
require 'purecloudplatformclientv2/models/ivr_entity_listing'
|
|
554
559
|
require 'purecloudplatformclientv2/models/identity_now'
|
|
560
|
+
require 'purecloudplatformclientv2/models/import_script_status_response'
|
|
555
561
|
require 'purecloudplatformclientv2/models/import_status'
|
|
556
562
|
require 'purecloudplatformclientv2/models/import_status_notification'
|
|
557
563
|
require 'purecloudplatformclientv2/models/inbound_domain'
|
|
@@ -635,6 +641,8 @@ require 'purecloudplatformclientv2/models/lock_info'
|
|
|
635
641
|
require 'purecloudplatformclientv2/models/logical_interface_entity_listing'
|
|
636
642
|
require 'purecloudplatformclientv2/models/management_unit'
|
|
637
643
|
require 'purecloudplatformclientv2/models/management_unit_listing'
|
|
644
|
+
require 'purecloudplatformclientv2/models/management_unit_reference'
|
|
645
|
+
require 'purecloudplatformclientv2/models/management_unit_settings'
|
|
638
646
|
require 'purecloudplatformclientv2/models/max_participants'
|
|
639
647
|
require 'purecloudplatformclientv2/models/media_participant_request'
|
|
640
648
|
require 'purecloudplatformclientv2/models/media_policies'
|
|
@@ -834,6 +842,7 @@ require 'purecloudplatformclientv2/models/schedule_entity_listing'
|
|
|
834
842
|
require 'purecloudplatformclientv2/models/schedule_group'
|
|
835
843
|
require 'purecloudplatformclientv2/models/schedule_group_entity_listing'
|
|
836
844
|
require 'purecloudplatformclientv2/models/schedule_interval'
|
|
845
|
+
require 'purecloudplatformclientv2/models/scheduling_settings'
|
|
837
846
|
require 'purecloudplatformclientv2/models/schema_category'
|
|
838
847
|
require 'purecloudplatformclientv2/models/schema_category_entity_listing'
|
|
839
848
|
require 'purecloudplatformclientv2/models/schema_reference_entity_listing'
|
|
@@ -856,6 +865,8 @@ require 'purecloudplatformclientv2/models/search_criteria'
|
|
|
856
865
|
require 'purecloudplatformclientv2/models/search_request'
|
|
857
866
|
require 'purecloudplatformclientv2/models/search_sort'
|
|
858
867
|
require 'purecloudplatformclientv2/models/section'
|
|
868
|
+
require 'purecloudplatformclientv2/models/secure_session'
|
|
869
|
+
require 'purecloudplatformclientv2/models/secure_session_entity_listing'
|
|
859
870
|
require 'purecloudplatformclientv2/models/security_profile'
|
|
860
871
|
require 'purecloudplatformclientv2/models/security_profile_entity_listing'
|
|
861
872
|
require 'purecloudplatformclientv2/models/segment'
|
|
@@ -871,6 +882,8 @@ require 'purecloudplatformclientv2/models/share'
|
|
|
871
882
|
require 'purecloudplatformclientv2/models/share_entity_listing'
|
|
872
883
|
require 'purecloudplatformclientv2/models/shared_entity'
|
|
873
884
|
require 'purecloudplatformclientv2/models/shared_response'
|
|
885
|
+
require 'purecloudplatformclientv2/models/short_term_forecasting_settings'
|
|
886
|
+
require 'purecloudplatformclientv2/models/signed_data'
|
|
874
887
|
require 'purecloudplatformclientv2/models/site'
|
|
875
888
|
require 'purecloudplatformclientv2/models/site_entity_listing'
|
|
876
889
|
require 'purecloudplatformclientv2/models/skill_entity_listing'
|
|
@@ -916,6 +929,7 @@ require 'purecloudplatformclientv2/models/time_interval'
|
|
|
916
929
|
require 'purecloudplatformclientv2/models/time_off_request'
|
|
917
930
|
require 'purecloudplatformclientv2/models/time_off_request_list'
|
|
918
931
|
require 'purecloudplatformclientv2/models/time_off_request_patch'
|
|
932
|
+
require 'purecloudplatformclientv2/models/time_off_request_settings'
|
|
919
933
|
require 'purecloudplatformclientv2/models/time_off_request_update_notification'
|
|
920
934
|
require 'purecloudplatformclientv2/models/time_off_request_update_notification_user'
|
|
921
935
|
require 'purecloudplatformclientv2/models/time_slot'
|
|
@@ -984,6 +998,7 @@ require 'purecloudplatformclientv2/models/user_queue'
|
|
|
984
998
|
require 'purecloudplatformclientv2/models/user_queue_entity_listing'
|
|
985
999
|
require 'purecloudplatformclientv2/models/user_recording'
|
|
986
1000
|
require 'purecloudplatformclientv2/models/user_recording_entity_listing'
|
|
1001
|
+
require 'purecloudplatformclientv2/models/user_reference'
|
|
987
1002
|
require 'purecloudplatformclientv2/models/user_routing_skill'
|
|
988
1003
|
require 'purecloudplatformclientv2/models/user_routing_skill_post'
|
|
989
1004
|
require 'purecloudplatformclientv2/models/user_routing_status_notification'
|
|
@@ -1086,6 +1101,7 @@ require 'purecloudplatformclientv2/api/response_management_api'
|
|
|
1086
1101
|
require 'purecloudplatformclientv2/api/routing_api'
|
|
1087
1102
|
require 'purecloudplatformclientv2/api/scripts_api'
|
|
1088
1103
|
require 'purecloudplatformclientv2/api/search_api'
|
|
1104
|
+
require 'purecloudplatformclientv2/api/signed_data_api'
|
|
1089
1105
|
require 'purecloudplatformclientv2/api/stations_api'
|
|
1090
1106
|
require 'purecloudplatformclientv2/api/suggest_api'
|
|
1091
1107
|
require 'purecloudplatformclientv2/api/telephony_providers_edge_api'
|
|
@@ -864,8 +864,8 @@ module PureCloud
|
|
|
864
864
|
fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumedresources" if object_type.nil?
|
|
865
865
|
|
|
866
866
|
# verify enum value
|
|
867
|
-
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
|
|
868
|
-
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
|
|
867
|
+
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
|
|
868
|
+
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
|
|
869
869
|
end
|
|
870
870
|
|
|
871
871
|
|
|
@@ -956,8 +956,8 @@ module PureCloud
|
|
|
956
956
|
fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumingresources" if object_type.nil?
|
|
957
957
|
|
|
958
958
|
# verify enum value
|
|
959
|
-
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
|
|
960
|
-
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
|
|
959
|
+
unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(object_type)
|
|
960
|
+
fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW"
|
|
961
961
|
end
|
|
962
962
|
|
|
963
963
|
|
|
@@ -1181,8 +1181,8 @@ module PureCloud
|
|
|
1181
1181
|
|
|
1182
1182
|
|
|
1183
1183
|
|
|
1184
|
-
if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(opts[:'object_type'])
|
|
1185
|
-
fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW'
|
|
1184
|
+
if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BRIDGEACTION', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'EMAILROUTE', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'USER', 'USERPROMPT', 'VOICEXML', 'WORKFLOW'].include?(opts[:'object_type'])
|
|
1185
|
+
fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW'
|
|
1186
1186
|
end
|
|
1187
1187
|
|
|
1188
1188
|
|
|
@@ -2023,6 +2023,8 @@ module PureCloud
|
|
|
2023
2023
|
# @option opts [String] :name Name
|
|
2024
2024
|
# @option opts [String] :description Description
|
|
2025
2025
|
# @option opts [String] :name_or_description Name or description
|
|
2026
|
+
# @option opts [String] :sort_by Sort by (default to id)
|
|
2027
|
+
# @option opts [String] :sort_order Sort order (default to asc)
|
|
2026
2028
|
# @return [PromptEntityListing]
|
|
2027
2029
|
def get_architect_prompts(opts = {})
|
|
2028
2030
|
data, _status_code, _headers = get_architect_prompts_with_http_info(opts)
|
|
@@ -2037,6 +2039,8 @@ module PureCloud
|
|
|
2037
2039
|
# @option opts [String] :name Name
|
|
2038
2040
|
# @option opts [String] :description Description
|
|
2039
2041
|
# @option opts [String] :name_or_description Name or description
|
|
2042
|
+
# @option opts [String] :sort_by Sort by
|
|
2043
|
+
# @option opts [String] :sort_order Sort order
|
|
2040
2044
|
# @return [Array<(PromptEntityListing, Fixnum, Hash)>] PromptEntityListing data, response status code and response headers
|
|
2041
2045
|
def get_architect_prompts_with_http_info(opts = {})
|
|
2042
2046
|
if @api_client.config.debugging
|
|
@@ -2062,6 +2066,18 @@ module PureCloud
|
|
|
2062
2066
|
|
|
2063
2067
|
|
|
2064
2068
|
|
|
2069
|
+
|
|
2070
|
+
|
|
2071
|
+
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
|
|
2078
|
+
|
|
2079
|
+
|
|
2080
|
+
|
|
2065
2081
|
|
|
2066
2082
|
|
|
2067
2083
|
|
|
@@ -2083,6 +2099,8 @@ module PureCloud
|
|
|
2083
2099
|
query_params[:'name'] = opts[:'name'] if opts[:'name']
|
|
2084
2100
|
query_params[:'description'] = opts[:'description'] if opts[:'description']
|
|
2085
2101
|
query_params[:'nameOrDescription'] = opts[:'name_or_description'] if opts[:'name_or_description']
|
|
2102
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
|
2103
|
+
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
|
2086
2104
|
|
|
2087
2105
|
# header parameters
|
|
2088
2106
|
header_params = {}
|
|
@@ -386,6 +386,166 @@ module PureCloud
|
|
|
386
386
|
return data, status_code, headers
|
|
387
387
|
end
|
|
388
388
|
|
|
389
|
+
# Fetch info on a secure session
|
|
390
|
+
#
|
|
391
|
+
# @param conversation_id conversation ID
|
|
392
|
+
# @param participant_id participant ID
|
|
393
|
+
# @param secure_session_id secure IVR session ID
|
|
394
|
+
# @param [Hash] opts the optional parameters
|
|
395
|
+
# @return [SecureSession]
|
|
396
|
+
def get_conversation_participant_secureivrsession(conversation_id, participant_id, secure_session_id, opts = {})
|
|
397
|
+
data, _status_code, _headers = get_conversation_participant_secureivrsession_with_http_info(conversation_id, participant_id, secure_session_id, opts)
|
|
398
|
+
return data
|
|
399
|
+
end
|
|
400
|
+
|
|
401
|
+
# Fetch info on a secure session
|
|
402
|
+
#
|
|
403
|
+
# @param conversation_id conversation ID
|
|
404
|
+
# @param participant_id participant ID
|
|
405
|
+
# @param secure_session_id secure IVR session ID
|
|
406
|
+
# @param [Hash] opts the optional parameters
|
|
407
|
+
# @return [Array<(SecureSession, Fixnum, Hash)>] SecureSession data, response status code and response headers
|
|
408
|
+
def get_conversation_participant_secureivrsession_with_http_info(conversation_id, participant_id, secure_session_id, opts = {})
|
|
409
|
+
if @api_client.config.debugging
|
|
410
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi.get_conversation_participant_secureivrsession ..."
|
|
411
|
+
end
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
# verify the required parameter 'conversation_id' is set
|
|
415
|
+
fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversation_participant_secureivrsession" if conversation_id.nil?
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
# verify the required parameter 'participant_id' is set
|
|
423
|
+
fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversation_participant_secureivrsession" if participant_id.nil?
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
# verify the required parameter 'secure_session_id' is set
|
|
431
|
+
fail ArgumentError, "Missing the required parameter 'secure_session_id' when calling ConversationsApi.get_conversation_participant_secureivrsession" if secure_session_id.nil?
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
# resource path
|
|
438
|
+
local_var_path = "/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s).sub('{' + 'secureSessionId' + '}', secure_session_id.to_s)
|
|
439
|
+
|
|
440
|
+
# query parameters
|
|
441
|
+
query_params = {}
|
|
442
|
+
|
|
443
|
+
# header parameters
|
|
444
|
+
header_params = {}
|
|
445
|
+
|
|
446
|
+
# HTTP header 'Accept' (if needed)
|
|
447
|
+
local_header_accept = ['application/json']
|
|
448
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
449
|
+
|
|
450
|
+
# HTTP header 'Content-Type'
|
|
451
|
+
local_header_content_type = ['application/json']
|
|
452
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
453
|
+
|
|
454
|
+
# form parameters
|
|
455
|
+
form_params = {}
|
|
456
|
+
|
|
457
|
+
# http body (model)
|
|
458
|
+
post_body = nil
|
|
459
|
+
|
|
460
|
+
auth_names = ['PureCloud Auth']
|
|
461
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
462
|
+
:header_params => header_params,
|
|
463
|
+
:query_params => query_params,
|
|
464
|
+
:form_params => form_params,
|
|
465
|
+
:body => post_body,
|
|
466
|
+
:auth_names => auth_names,
|
|
467
|
+
:return_type => 'SecureSession')
|
|
468
|
+
if @api_client.config.debugging
|
|
469
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_conversation_participant_secureivrsession\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
470
|
+
end
|
|
471
|
+
return data, status_code, headers
|
|
472
|
+
end
|
|
473
|
+
|
|
474
|
+
# Get a list of secure sessions for this participant.
|
|
475
|
+
#
|
|
476
|
+
# @param conversation_id conversation ID
|
|
477
|
+
# @param participant_id participant ID
|
|
478
|
+
# @param [Hash] opts the optional parameters
|
|
479
|
+
# @return [SecureSessionEntityListing]
|
|
480
|
+
def get_conversation_participant_secureivrsessions(conversation_id, participant_id, opts = {})
|
|
481
|
+
data, _status_code, _headers = get_conversation_participant_secureivrsessions_with_http_info(conversation_id, participant_id, opts)
|
|
482
|
+
return data
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
# Get a list of secure sessions for this participant.
|
|
486
|
+
#
|
|
487
|
+
# @param conversation_id conversation ID
|
|
488
|
+
# @param participant_id participant ID
|
|
489
|
+
# @param [Hash] opts the optional parameters
|
|
490
|
+
# @return [Array<(SecureSessionEntityListing, Fixnum, Hash)>] SecureSessionEntityListing data, response status code and response headers
|
|
491
|
+
def get_conversation_participant_secureivrsessions_with_http_info(conversation_id, participant_id, opts = {})
|
|
492
|
+
if @api_client.config.debugging
|
|
493
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi.get_conversation_participant_secureivrsessions ..."
|
|
494
|
+
end
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
# verify the required parameter 'conversation_id' is set
|
|
498
|
+
fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.get_conversation_participant_secureivrsessions" if conversation_id.nil?
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
# verify the required parameter 'participant_id' is set
|
|
506
|
+
fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.get_conversation_participant_secureivrsessions" if participant_id.nil?
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
# resource path
|
|
513
|
+
local_var_path = "/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
|
|
514
|
+
|
|
515
|
+
# query parameters
|
|
516
|
+
query_params = {}
|
|
517
|
+
|
|
518
|
+
# header parameters
|
|
519
|
+
header_params = {}
|
|
520
|
+
|
|
521
|
+
# HTTP header 'Accept' (if needed)
|
|
522
|
+
local_header_accept = ['application/json']
|
|
523
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
524
|
+
|
|
525
|
+
# HTTP header 'Content-Type'
|
|
526
|
+
local_header_content_type = ['application/json']
|
|
527
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
528
|
+
|
|
529
|
+
# form parameters
|
|
530
|
+
form_params = {}
|
|
531
|
+
|
|
532
|
+
# http body (model)
|
|
533
|
+
post_body = nil
|
|
534
|
+
|
|
535
|
+
auth_names = ['PureCloud Auth']
|
|
536
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
537
|
+
:header_params => header_params,
|
|
538
|
+
:query_params => query_params,
|
|
539
|
+
:form_params => form_params,
|
|
540
|
+
:body => post_body,
|
|
541
|
+
:auth_names => auth_names,
|
|
542
|
+
:return_type => 'SecureSessionEntityListing')
|
|
543
|
+
if @api_client.config.debugging
|
|
544
|
+
@api_client.config.logger.debug "API called: ConversationsApi#get_conversation_participant_secureivrsessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
545
|
+
end
|
|
546
|
+
return data, status_code, headers
|
|
547
|
+
end
|
|
548
|
+
|
|
389
549
|
# Get the wrap-up for this conversation participant.
|
|
390
550
|
#
|
|
391
551
|
# @param conversation_id conversation ID
|
|
@@ -4747,6 +4907,89 @@ module PureCloud
|
|
|
4747
4907
|
return data, status_code, headers
|
|
4748
4908
|
end
|
|
4749
4909
|
|
|
4910
|
+
# Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
|
|
4911
|
+
#
|
|
4912
|
+
# @param conversation_id conversation ID
|
|
4913
|
+
# @param participant_id participant ID
|
|
4914
|
+
# @param [Hash] opts the optional parameters
|
|
4915
|
+
# @option opts [CreateSecureSession] :body
|
|
4916
|
+
# @return [SecureSession]
|
|
4917
|
+
def post_conversation_participant_secureivrsessions(conversation_id, participant_id, opts = {})
|
|
4918
|
+
data, _status_code, _headers = post_conversation_participant_secureivrsessions_with_http_info(conversation_id, participant_id, opts)
|
|
4919
|
+
return data
|
|
4920
|
+
end
|
|
4921
|
+
|
|
4922
|
+
# Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
|
|
4923
|
+
#
|
|
4924
|
+
# @param conversation_id conversation ID
|
|
4925
|
+
# @param participant_id participant ID
|
|
4926
|
+
# @param [Hash] opts the optional parameters
|
|
4927
|
+
# @option opts [CreateSecureSession] :body
|
|
4928
|
+
# @return [Array<(SecureSession, Fixnum, Hash)>] SecureSession data, response status code and response headers
|
|
4929
|
+
def post_conversation_participant_secureivrsessions_with_http_info(conversation_id, participant_id, opts = {})
|
|
4930
|
+
if @api_client.config.debugging
|
|
4931
|
+
@api_client.config.logger.debug "Calling API: ConversationsApi.post_conversation_participant_secureivrsessions ..."
|
|
4932
|
+
end
|
|
4933
|
+
|
|
4934
|
+
|
|
4935
|
+
# verify the required parameter 'conversation_id' is set
|
|
4936
|
+
fail ArgumentError, "Missing the required parameter 'conversation_id' when calling ConversationsApi.post_conversation_participant_secureivrsessions" if conversation_id.nil?
|
|
4937
|
+
|
|
4938
|
+
|
|
4939
|
+
|
|
4940
|
+
|
|
4941
|
+
|
|
4942
|
+
|
|
4943
|
+
# verify the required parameter 'participant_id' is set
|
|
4944
|
+
fail ArgumentError, "Missing the required parameter 'participant_id' when calling ConversationsApi.post_conversation_participant_secureivrsessions" if participant_id.nil?
|
|
4945
|
+
|
|
4946
|
+
|
|
4947
|
+
|
|
4948
|
+
|
|
4949
|
+
|
|
4950
|
+
|
|
4951
|
+
|
|
4952
|
+
|
|
4953
|
+
|
|
4954
|
+
|
|
4955
|
+
|
|
4956
|
+
# resource path
|
|
4957
|
+
local_var_path = "/api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'participantId' + '}', participant_id.to_s)
|
|
4958
|
+
|
|
4959
|
+
# query parameters
|
|
4960
|
+
query_params = {}
|
|
4961
|
+
|
|
4962
|
+
# header parameters
|
|
4963
|
+
header_params = {}
|
|
4964
|
+
|
|
4965
|
+
# HTTP header 'Accept' (if needed)
|
|
4966
|
+
local_header_accept = ['application/json']
|
|
4967
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
4968
|
+
|
|
4969
|
+
# HTTP header 'Content-Type'
|
|
4970
|
+
local_header_content_type = ['application/json']
|
|
4971
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
4972
|
+
|
|
4973
|
+
# form parameters
|
|
4974
|
+
form_params = {}
|
|
4975
|
+
|
|
4976
|
+
# http body (model)
|
|
4977
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
|
4978
|
+
|
|
4979
|
+
auth_names = ['PureCloud Auth']
|
|
4980
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
4981
|
+
:header_params => header_params,
|
|
4982
|
+
:query_params => query_params,
|
|
4983
|
+
:form_params => form_params,
|
|
4984
|
+
:body => post_body,
|
|
4985
|
+
:auth_names => auth_names,
|
|
4986
|
+
:return_type => 'SecureSession')
|
|
4987
|
+
if @api_client.config.debugging
|
|
4988
|
+
@api_client.config.logger.debug "API called: ConversationsApi#post_conversation_participant_secureivrsessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4989
|
+
end
|
|
4990
|
+
return data, status_code, headers
|
|
4991
|
+
end
|
|
4992
|
+
|
|
4750
4993
|
# Place a new call as part of a callback conversation.
|
|
4751
4994
|
#
|
|
4752
4995
|
# @param conversation_id conversationId
|