purecloudplatformclientv2 95.0.0 → 96.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/AnalyticsProposedAgent.md +14 -0
- data/docs/AnalyticsSession.md +2 -0
- data/docs/ArrayNode.md +4 -4
- data/docs/AuditApi.md +60 -0
- data/docs/BuAgentSchedulesQueryResponse.md +1 -0
- data/docs/CoachingApi.md +80 -2
- data/docs/CoachingAppointmentAggregateRequest.md +16 -0
- data/docs/CoachingAppointmentAggregateResponse.md +13 -0
- data/docs/CoachingAppointmentResponse.md +1 -0
- data/docs/ConversationMetrics.md +15 -0
- data/docs/ExternalOrganizationTrustorLink.md +1 -2
- data/docs/GenericSAML.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/OAuthClient.md +1 -0
- data/docs/OAuthClientListing.md +1 -0
- data/docs/OAuthClientRequest.md +1 -0
- data/docs/OrgOAuthClient.md +1 -0
- data/docs/Permissions.md +0 -2
- data/docs/QueryRequestClause.md +14 -0
- data/docs/QueryRequestFilter.md +14 -0
- data/docs/QueryRequestPredicate.md +14 -0
- data/docs/QueryResponseData.md +14 -0
- data/docs/QueryResponseGroupedData.md +14 -0
- data/docs/QueryResponseMetric.md +14 -0
- data/docs/QueryResponseStats.md +13 -0
- data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
- data/docs/ReportingExportJobResponse.md +1 -0
- data/docs/RoutingApi.md +1 -1
- data/docs/SearchApi.md +2 -1
- data/docs/SpeechTextAnalyticsApi.md +66 -0
- data/docs/StatEventFlowOutcomeTopicDatum.md +14 -0
- data/docs/StatEventFlowOutcomeTopicMetric.md +15 -0
- data/docs/StatEventFlowOutcomeTopicStatsNotification.md +14 -0
- data/docs/StatEventFlowTopicDatum.md +14 -0
- data/docs/StatEventFlowTopicMetric.md +15 -0
- data/docs/StatEventFlowTopicStatsNotification.md +14 -0
- data/docs/StatEventWrapUpCodeTopicDatum.md +14 -0
- data/docs/StatEventWrapUpCodeTopicMetric.md +15 -0
- data/docs/StatEventWrapUpCodeTopicStatsNotification.md +14 -0
- data/docs/UserScheduleAdherence.md +1 -0
- data/docs/UserSearchRequest.md +1 -0
- data/docs/UsersApi.md +2 -1
- data/docs/WemCoachingAppointmentTopicCoachingAppointmentNotification.md +1 -0
- data/docs/WfmBusinessUnitReference.md +1 -1
- data/docs/WfmScheduleReference.md +3 -3
- data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUriReference.md +14 -0
- data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.md +1 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference.md +13 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUriReference.md +14 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserReference.md +13 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate.md +28 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTopicUriReference.md +14 -0
- data/docs/WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.md +1 -0
- data/lib/purecloudplatformclientv2.rb +26 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +55 -0
- data/lib/purecloudplatformclientv2/api/coaching_api.rb +127 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/acw_settings.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_proposed_agent.rb +228 -0
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +58 -4
- data/lib/purecloudplatformclientv2/models/array_node.rb +54 -54
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
- data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_service.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/bu_agent_schedules_query_response.rb +30 -4
- data/lib/purecloudplatformclientv2/models/coaching_appointment_aggregate_request.rb +294 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_aggregate_response.rb +204 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_metrics.rb +254 -0
- data/lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/external_organization_trustor_link.rb +8 -34
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/generic_saml.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ip_address_range.rb +2 -2
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/json_node.rb +54 -54
- data/lib/purecloudplatformclientv2/models/message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +2 -2
- data/lib/purecloudplatformclientv2/models/messaging_sticker.rb +2 -2
- data/lib/purecloudplatformclientv2/models/o_auth_client.rb +27 -1
- data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +27 -1
- data/lib/purecloudplatformclientv2/models/o_auth_client_request.rb +30 -4
- data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +27 -1
- data/lib/purecloudplatformclientv2/models/participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +2 -2
- data/lib/purecloudplatformclientv2/models/permissions.rb +1 -52
- data/lib/purecloudplatformclientv2/models/query_request_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/query_request_filter.rb +254 -0
- data/lib/purecloudplatformclientv2/models/query_request_predicate.rb +252 -0
- data/lib/purecloudplatformclientv2/models/query_response_data.rb +230 -0
- data/lib/purecloudplatformclientv2/models/query_response_grouped_data.rb +232 -0
- data/lib/purecloudplatformclientv2/models/query_response_metric.rb +242 -0
- data/lib/purecloudplatformclientv2/models/query_response_stats.rb +202 -0
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/recipient.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +32 -1
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_datum.rb +228 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_metric.rb +253 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_stats_notification.rb +230 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_datum.rb +228 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_metric.rb +253 -0
- data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_stats_notification.rb +230 -0
- data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_datum.rb +228 -0
- data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_metric.rb +253 -0
- data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_stats_notification.rb +230 -0
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +27 -1
- data/lib/purecloudplatformclientv2/models/user_search_request.rb +30 -4
- data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +29 -4
- data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +6 -1
- data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +16 -1
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_uri_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_user_schedule_adherence_update.rb +26 -1
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_queue_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_uri_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_schedule_adherence_update.rb +606 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_uri_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb +26 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +55 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cb8e99675d14270767d1e2194da9b2411db45abd
|
4
|
+
data.tar.gz: e1aadce8c7009bcb1b54ffc482ab2bf15f5dd82a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9d589bd3414aa88095f063cfae21bbf3c1a70edd1cf2b4785c4457156cd3468b38224858826b2aa1a075c2aaefb02babe976f23f31a504a606e4274de45b07c5
|
7
|
+
data.tar.gz: b5998050319cd49d33db11781de5abba6be321c727c6e54152f582f82358cea023f9199d65cf4b929c6518deb3b3ff830b5fab1e58d26fa146edb3dd0592e955
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
title: Platform API Client SDK - Ruby
|
3
3
|
---
|
4
|
-
![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=
|
4
|
+
![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=96.0.0)
|
5
5
|
|
6
6
|
Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
|
7
7
|
|
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
|
|
10
10
|
### from rubygems.org
|
11
11
|
|
12
12
|
```{"language":"ruby"}
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 96.0.0'
|
14
14
|
```
|
15
15
|
|
16
16
|
### Install from Git
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: AnalyticsProposedAgent
|
3
|
+
---
|
4
|
+
## PureCloud::AnalyticsProposedAgent
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **proposed_agent_id** | **String** | Unique identifier of an agent that was proposed by predictive routing | [optional] |
|
11
|
+
| **agent_rank** | **Integer** | Proposed agent rank for this conversation from predictive routing (lower is better) | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
data/docs/AnalyticsSession.md
CHANGED
@@ -64,6 +64,8 @@ title: AnalyticsSession
|
|
64
64
|
| **used_routing** | **String** | Complete routing method | [optional] |
|
65
65
|
| **selected_agent_id** | **String** | Selected agent id | [optional] |
|
66
66
|
| **selected_agent_rank** | **Integer** | Selected agent GPR rank | [optional] |
|
67
|
+
| **agent_assistant_id** | **String** | Unique identifier of the active virtual agent assistant | [optional] |
|
68
|
+
| **proposed_agents** | [**Array<AnalyticsProposedAgent>**](AnalyticsProposedAgent.html) | Proposed agents | [optional] |
|
67
69
|
{: class="table table-striped"}
|
68
70
|
|
69
71
|
|
data/docs/ArrayNode.md
CHANGED
@@ -12,11 +12,8 @@ title: ArrayNode
|
|
12
12
|
| **number** | **BOOLEAN** | | [optional] |
|
13
13
|
| **boolean** | **BOOLEAN** | | [optional] |
|
14
14
|
| **object** | **BOOLEAN** | | [optional] |
|
15
|
-
| **value_node** | **BOOLEAN** | | [optional] |
|
16
|
-
| **container_node** | **BOOLEAN** | | [optional] |
|
17
|
-
| **missing_node** | **BOOLEAN** | | [optional] |
|
18
|
-
| **pojo** | **BOOLEAN** | | [optional] |
|
19
15
|
| **floating_point_number** | **BOOLEAN** | | [optional] |
|
16
|
+
| **pojo** | **BOOLEAN** | | [optional] |
|
20
17
|
| **integral_number** | **BOOLEAN** | | [optional] |
|
21
18
|
| **short** | **BOOLEAN** | | [optional] |
|
22
19
|
| **int** | **BOOLEAN** | | [optional] |
|
@@ -26,6 +23,9 @@ title: ArrayNode
|
|
26
23
|
| **big_integer** | **BOOLEAN** | | [optional] |
|
27
24
|
| **textual** | **BOOLEAN** | | [optional] |
|
28
25
|
| **binary** | **BOOLEAN** | | [optional] |
|
26
|
+
| **value_node** | **BOOLEAN** | | [optional] |
|
27
|
+
| **container_node** | **BOOLEAN** | | [optional] |
|
28
|
+
| **missing_node** | **BOOLEAN** | | [optional] |
|
29
29
|
| **array** | **BOOLEAN** | | [optional] |
|
30
30
|
| **null** | **BOOLEAN** | | [optional] |
|
31
31
|
{: class="table table-striped"}
|
data/docs/AuditApi.md
CHANGED
@@ -8,6 +8,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
+
[**get_audits_query_realtime_servicemapping**](AuditApi.html#get_audits_query_realtime_servicemapping) | Get service mapping information used in audits.
|
11
12
|
[**get_audits_query_servicemapping**](AuditApi.html#get_audits_query_servicemapping) | Get service mapping information used in audits.
|
12
13
|
[**get_audits_query_transaction_id**](AuditApi.html#get_audits_query_transaction_id) | Get status of audit query execution
|
13
14
|
[**get_audits_query_transaction_id_results**](AuditApi.html#get_audits_query_transaction_id_results) | Get results of audit query
|
@@ -15,6 +16,65 @@ Method | Description
|
|
15
16
|
[**post_audits_query_realtime**](AuditApi.html#post_audits_query_realtime) | This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
|
16
17
|
{: class="table table-striped"}
|
17
18
|
|
19
|
+
<a name="get_audits_query_realtime_servicemapping"></a>
|
20
|
+
|
21
|
+
## [**AuditQueryServiceMapping**](AuditQueryServiceMapping.html) get_audits_query_realtime_servicemapping
|
22
|
+
|
23
|
+
|
24
|
+
|
25
|
+
Get service mapping information used in audits.
|
26
|
+
|
27
|
+
|
28
|
+
|
29
|
+
Wraps GET /api/v2/audits/query/realtime/servicemapping
|
30
|
+
|
31
|
+
Requires ALL permissions:
|
32
|
+
|
33
|
+
* audits:audit:view
|
34
|
+
|
35
|
+
|
36
|
+
### Example
|
37
|
+
```{"language":"ruby"}
|
38
|
+
# load the gem
|
39
|
+
require 'purecloudplatformclientv2'
|
40
|
+
# setup authorization
|
41
|
+
@secret = ENV['PURECLOUD_SECRET']
|
42
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
43
|
+
environment = "mypurecloud.com"
|
44
|
+
|
45
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
46
|
+
|
47
|
+
PureCloud.configure do |config|
|
48
|
+
config.access_token = @authToken
|
49
|
+
end
|
50
|
+
|
51
|
+
api_instance = PureCloud::AuditApi.new
|
52
|
+
|
53
|
+
begin
|
54
|
+
#Get service mapping information used in audits.
|
55
|
+
result = api_instance.get_audits_query_realtime_servicemapping
|
56
|
+
p result
|
57
|
+
rescue PureCloud::ApiError => e
|
58
|
+
puts "Exception when calling AuditApi->get_audits_query_realtime_servicemapping: #{e}"
|
59
|
+
end
|
60
|
+
```
|
61
|
+
|
62
|
+
### Parameters
|
63
|
+
This endpoint does not need any parameter.
|
64
|
+
{: class="table table-striped"}
|
65
|
+
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
[**AuditQueryServiceMapping**](AuditQueryServiceMapping.html)
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: application/json
|
74
|
+
- **Accept**: application/json
|
75
|
+
|
76
|
+
|
77
|
+
|
18
78
|
<a name="get_audits_query_servicemapping"></a>
|
19
79
|
|
20
80
|
## [**AuditQueryServiceMapping**](AuditQueryServiceMapping.html) get_audits_query_servicemapping
|
@@ -8,6 +8,7 @@ title: BuAgentSchedulesQueryResponse
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **agent_schedules** | [**Array<BuAgentScheduleQueryResponse>**](BuAgentScheduleQueryResponse.html) | The requested agent schedules | [optional] |
|
11
|
+
| **business_unit_time_zone** | **String** | The time zone configured for the business unit to which these schedules apply | [optional] |
|
11
12
|
{: class="table table-striped"}
|
12
13
|
|
13
14
|
|
data/docs/CoachingApi.md
CHANGED
@@ -24,6 +24,7 @@ Method | Description
|
|
24
24
|
[**patch_coaching_notification**](CoachingApi.html#patch_coaching_notification) | Update an existing notification.
|
25
25
|
[**post_coaching_appointment_annotations**](CoachingApi.html#post_coaching_appointment_annotations) | Create a new annotation.
|
26
26
|
[**post_coaching_appointments**](CoachingApi.html#post_coaching_appointments) | Create a new appointment
|
27
|
+
[**post_coaching_appointments_aggregates_query**](CoachingApi.html#post_coaching_appointments_aggregates_query) | Retrieve aggregated appointment data
|
27
28
|
{: class="table table-striped"}
|
28
29
|
|
29
30
|
<a name="delete_coaching_appointment"></a>
|
@@ -478,7 +479,10 @@ opts = {
|
|
478
479
|
page_size: 25, # Integer | Page size
|
479
480
|
statuses: ["statuses_example"], # Array<String> | Appointment Statuses to filter by
|
480
481
|
facilitator_ids: ["facilitator_ids_example"], # Array<String> | The facilitator IDs for which to retrieve appointments
|
481
|
-
sort_order: "sort_order_example" # String | Sort (by due date) either Asc or Desc
|
482
|
+
sort_order: "sort_order_example", # String | Sort (by due date) either Asc or Desc
|
483
|
+
relationships: ["relationships_example"], # Array<String> | Relationships to filter by
|
484
|
+
completion_interval: "completion_interval_example", # String | Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
485
|
+
overdue: "overdue_example" # String | Overdue status to filter by
|
482
486
|
}
|
483
487
|
|
484
488
|
begin
|
@@ -501,6 +505,9 @@ Name | Type | Description | Notes
|
|
501
505
|
**statuses** | [**Array<String>**](String.html)| Appointment Statuses to filter by | [optional] <br />**Values**: Scheduled, InProgress, Completed, InvalidSchedule |
|
502
506
|
**facilitator_ids** | [**Array<String>**](String.html)| The facilitator IDs for which to retrieve appointments | [optional] |
|
503
507
|
**sort_order** | **String**| Sort (by due date) either Asc or Desc | [optional] <br />**Values**: Desc, Asc |
|
508
|
+
**relationships** | [**Array<String>**](String.html)| Relationships to filter by | [optional] <br />**Values**: Creator, Facilitator, Attendee |
|
509
|
+
**completion_interval** | **String**| Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
510
|
+
**overdue** | **String**| Overdue status to filter by | [optional] <br />**Values**: Any, True, False |
|
504
511
|
{: class="table table-striped"}
|
505
512
|
|
506
513
|
|
@@ -554,7 +561,10 @@ opts = {
|
|
554
561
|
page_size: 25, # Integer | Page size
|
555
562
|
statuses: ["statuses_example"], # Array<String> | Appointment Statuses to filter by
|
556
563
|
facilitator_ids: ["facilitator_ids_example"], # Array<String> | The facilitator IDs for which to retrieve appointments
|
557
|
-
sort_order: "sort_order_example" # String | Sort (by due date) either Asc or Desc
|
564
|
+
sort_order: "sort_order_example", # String | Sort (by due date) either Asc or Desc
|
565
|
+
relationships: ["relationships_example"], # Array<String> | Relationships to filter by
|
566
|
+
completion_interval: "completion_interval_example", # String | Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
567
|
+
overdue: "overdue_example" # String | Overdue status to filter by
|
558
568
|
}
|
559
569
|
|
560
570
|
begin
|
@@ -576,6 +586,9 @@ Name | Type | Description | Notes
|
|
576
586
|
**statuses** | [**Array<String>**](String.html)| Appointment Statuses to filter by | [optional] <br />**Values**: Scheduled, InProgress, Completed |
|
577
587
|
**facilitator_ids** | [**Array<String>**](String.html)| The facilitator IDs for which to retrieve appointments | [optional] |
|
578
588
|
**sort_order** | **String**| Sort (by due date) either Asc or Desc | [optional] <br />**Values**: Desc, Asc |
|
589
|
+
**relationships** | [**Array<String>**](String.html)| Relationships to filter by | [optional] <br />**Values**: Creator, Facilitator, Attendee |
|
590
|
+
**completion_interval** | **String**| Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
591
|
+
**overdue** | **String**| Overdue status to filter by | [optional] <br />**Values**: Any, True, False |
|
579
592
|
{: class="table table-striped"}
|
580
593
|
|
581
594
|
|
@@ -1137,3 +1150,68 @@ Name | Type | Description | Notes
|
|
1137
1150
|
|
1138
1151
|
|
1139
1152
|
|
1153
|
+
<a name="post_coaching_appointments_aggregates_query"></a>
|
1154
|
+
|
1155
|
+
## [**CoachingAppointmentAggregateResponse**](CoachingAppointmentAggregateResponse.html) post_coaching_appointments_aggregates_query(body)
|
1156
|
+
|
1157
|
+
|
1158
|
+
|
1159
|
+
Retrieve aggregated appointment data
|
1160
|
+
|
1161
|
+
|
1162
|
+
|
1163
|
+
Wraps POST /api/v2/coaching/appointments/aggregates/query
|
1164
|
+
|
1165
|
+
Requires ANY permissions:
|
1166
|
+
|
1167
|
+
* coaching:appointment:view
|
1168
|
+
|
1169
|
+
|
1170
|
+
### Example
|
1171
|
+
```{"language":"ruby"}
|
1172
|
+
# load the gem
|
1173
|
+
require 'purecloudplatformclientv2'
|
1174
|
+
# setup authorization
|
1175
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1176
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1177
|
+
environment = "mypurecloud.com"
|
1178
|
+
|
1179
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1180
|
+
|
1181
|
+
PureCloud.configure do |config|
|
1182
|
+
config.access_token = @authToken
|
1183
|
+
end
|
1184
|
+
|
1185
|
+
api_instance = PureCloud::CoachingApi.new
|
1186
|
+
|
1187
|
+
body = PureCloud::CoachingAppointmentAggregateRequest.new # CoachingAppointmentAggregateRequest | Aggregate Request
|
1188
|
+
|
1189
|
+
|
1190
|
+
begin
|
1191
|
+
#Retrieve aggregated appointment data
|
1192
|
+
result = api_instance.post_coaching_appointments_aggregates_query(body)
|
1193
|
+
p result
|
1194
|
+
rescue PureCloud::ApiError => e
|
1195
|
+
puts "Exception when calling CoachingApi->post_coaching_appointments_aggregates_query: #{e}"
|
1196
|
+
end
|
1197
|
+
```
|
1198
|
+
|
1199
|
+
### Parameters
|
1200
|
+
|
1201
|
+
Name | Type | Description | Notes
|
1202
|
+
------------- | ------------- | ------------- | -------------
|
1203
|
+
**body** | [**CoachingAppointmentAggregateRequest**](CoachingAppointmentAggregateRequest.html)| Aggregate Request | |
|
1204
|
+
{: class="table table-striped"}
|
1205
|
+
|
1206
|
+
|
1207
|
+
### Return type
|
1208
|
+
|
1209
|
+
[**CoachingAppointmentAggregateResponse**](CoachingAppointmentAggregateResponse.html)
|
1210
|
+
|
1211
|
+
### HTTP request headers
|
1212
|
+
|
1213
|
+
- **Content-Type**: application/json
|
1214
|
+
- **Accept**: application/json
|
1215
|
+
|
1216
|
+
|
1217
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: CoachingAppointmentAggregateRequest
|
3
|
+
---
|
4
|
+
## PureCloud::CoachingAppointmentAggregateRequest
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **interval** | **String** | Interval to aggregate across. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
|
11
|
+
| **metrics** | **Array<String>** | A list of metrics to aggregate. If omitted, all metrics are returned. | [optional] |
|
12
|
+
| **group_by** | **Array<String>** | An optional list of items by which to group the result data. | [optional] |
|
13
|
+
| **filter** | [**QueryRequestFilter**](QueryRequestFilter.html) | The filter applied to the data | |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
---
|
2
|
+
title: CoachingAppointmentAggregateResponse
|
3
|
+
---
|
4
|
+
## PureCloud::CoachingAppointmentAggregateResponse
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **results** | [**Array<QueryResponseGroupedData>**](QueryResponseGroupedData.html) | The results of the query | [optional] |
|
11
|
+
{: class="table table-striped"}
|
12
|
+
|
13
|
+
|
@@ -21,6 +21,7 @@ title: CoachingAppointmentResponse
|
|
21
21
|
| **date_modified** | **DateTime** | The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
22
22
|
| **conversations** | [**Array<ConversationReference>**](ConversationReference.html) | The list of conversations associated with coaching appointment. | [optional] |
|
23
23
|
| **documents** | [**Array<DocumentReference>**](DocumentReference.html) | The list of documents associated with coaching appointment. | [optional] |
|
24
|
+
| **is_overdue** | **BOOLEAN** | Whether the appointment is overdue. | [optional] |
|
24
25
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
25
26
|
{: class="table table-striped"}
|
26
27
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationMetrics
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationMetrics
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **conversation** | [**AddressableEntityRef**](AddressableEntityRef.html) | The Conversation Reference | [optional] |
|
11
|
+
| **sentiment_score** | **Float** | The Sentiment Score | [optional] |
|
12
|
+
| **sentiment_trend** | **Float** | The Sentiment Trend | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -7,11 +7,10 @@ title: ExternalOrganizationTrustorLink
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
10
|
| **external_organization_id** | **String** | The id of a PureCloud External Organization entity in the External Contacts system that will be used to represent the trustor org | [optional] |
|
12
11
|
| **trustor_org_id** | **String** | The id of a PureCloud organization that has granted trust to this PureCloud organization | [optional] |
|
13
12
|
| **date_created** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
14
|
-
| **
|
13
|
+
| **external_organization_uri** | **String** | The URI for the External Organization that is linked to the trustor org | [optional] |
|
15
14
|
{: class="table table-striped"}
|
16
15
|
|
17
16
|
|
data/docs/GenericSAML.md
CHANGED
@@ -9,8 +9,8 @@ title: GenericSAML
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
|
-
| **relying_party_identifier** | **String** | | [optional] |
|
13
12
|
| **logo_image_data** | **String** | | [optional] |
|
13
|
+
| **relying_party_identifier** | **String** | | [optional] |
|
14
14
|
| **endpoint_compression** | **BOOLEAN** | | [optional] |
|
15
15
|
| **certificate** | **String** | | [optional] |
|
16
16
|
| **issuer_uri** | **String** | | [optional] |
|
data/docs/JsonNode.md
CHANGED
@@ -12,11 +12,8 @@ title: JsonNode
|
|
12
12
|
| **number** | **BOOLEAN** | | [optional] |
|
13
13
|
| **boolean** | **BOOLEAN** | | [optional] |
|
14
14
|
| **object** | **BOOLEAN** | | [optional] |
|
15
|
-
| **value_node** | **BOOLEAN** | | [optional] |
|
16
|
-
| **container_node** | **BOOLEAN** | | [optional] |
|
17
|
-
| **missing_node** | **BOOLEAN** | | [optional] |
|
18
|
-
| **pojo** | **BOOLEAN** | | [optional] |
|
19
15
|
| **floating_point_number** | **BOOLEAN** | | [optional] |
|
16
|
+
| **pojo** | **BOOLEAN** | | [optional] |
|
20
17
|
| **integral_number** | **BOOLEAN** | | [optional] |
|
21
18
|
| **short** | **BOOLEAN** | | [optional] |
|
22
19
|
| **int** | **BOOLEAN** | | [optional] |
|
@@ -26,6 +23,9 @@ title: JsonNode
|
|
26
23
|
| **big_integer** | **BOOLEAN** | | [optional] |
|
27
24
|
| **textual** | **BOOLEAN** | | [optional] |
|
28
25
|
| **binary** | **BOOLEAN** | | [optional] |
|
26
|
+
| **value_node** | **BOOLEAN** | | [optional] |
|
27
|
+
| **container_node** | **BOOLEAN** | | [optional] |
|
28
|
+
| **missing_node** | **BOOLEAN** | | [optional] |
|
29
29
|
| **array** | **BOOLEAN** | | [optional] |
|
30
30
|
| **null** | **BOOLEAN** | | [optional] |
|
31
31
|
{: class="table table-striped"}
|
data/docs/OAuthClient.md
CHANGED
@@ -22,6 +22,7 @@ title: OAuthClient
|
|
22
22
|
| **scope** | **Array<String>** | The scope requested by this client. Scopes only apply to clients not using the client_credential grant | [optional] |
|
23
23
|
| **role_divisions** | [**Array<RoleDivision>**](RoleDivision.html) | Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant | [optional] |
|
24
24
|
| **state** | **String** | The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. | [optional] |
|
25
|
+
| **date_to_delete** | **DateTime** | The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
25
26
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
26
27
|
{: class="table table-striped"}
|
27
28
|
|
data/docs/OAuthClientListing.md
CHANGED
@@ -21,6 +21,7 @@ title: OAuthClientListing
|
|
21
21
|
| **scope** | **Array<String>** | The scope requested by this client. Scopes only apply to clients not using the client_credential grant | [optional] |
|
22
22
|
| **role_divisions** | [**Array<RoleDivision>**](RoleDivision.html) | Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant | [optional] |
|
23
23
|
| **state** | **String** | The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. | [optional] |
|
24
|
+
| **date_to_delete** | **DateTime** | The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
24
25
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
25
26
|
{: class="table table-striped"}
|
26
27
|
|
data/docs/OAuthClientRequest.md
CHANGED
@@ -16,6 +16,7 @@ title: OAuthClientRequest
|
|
16
16
|
| **scope** | **Array<String>** | The scope requested by this client. Scopes only apply to clients not using the client_credential grant | [optional] |
|
17
17
|
| **role_divisions** | [**Array<RoleDivision>**](RoleDivision.html) | Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant | [optional] |
|
18
18
|
| **state** | **String** | The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. | [optional] |
|
19
|
+
| **date_to_delete** | **DateTime** | The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
19
20
|
{: class="table table-striped"}
|
20
21
|
|
21
22
|
|
data/docs/OrgOAuthClient.md
CHANGED
@@ -17,6 +17,7 @@ title: OrgOAuthClient
|
|
17
17
|
| **scope** | **Array<String>** | The scope requested by this client. Scopes only apply to clients not using the client_credential grant | [optional] |
|
18
18
|
| **role_divisions** | [**Array<RoleDivision>**](RoleDivision.html) | Set of roles and their corresponding divisions associated with this client. Roles and divisions only apply to clients using the client_credential grant | [optional] |
|
19
19
|
| **state** | **String** | The state of the OAuth client. Active: The OAuth client can be used to create access tokens. This is the default state. Disabled: Access tokens created by the client are invalid and new ones cannot be created. Inactive: Access tokens cannot be created with this OAuth client and it will be deleted. | [optional] |
|
20
|
+
| **date_to_delete** | **DateTime** | The time at which this client will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
20
21
|
| **organization** | [**NamedEntity**](NamedEntity.html) | The oauth client's organization. | [optional] |
|
21
22
|
{: class="table table-striped"}
|
22
23
|
|
data/docs/Permissions.md
CHANGED
@@ -7,8 +7,6 @@ title: Permissions
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
-
| **name** | **String** | | [optional] |
|
12
10
|
| **ids** | **Array<String>** | List of permission ids. | |
|
13
11
|
{: class="table table-striped"}
|
14
12
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: QueryRequestClause
|
3
|
+
---
|
4
|
+
## PureCloud::QueryRequestClause
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **type** | **String** | The logic used to combine the predicates | |
|
11
|
+
| **predicates** | [**Array<QueryRequestPredicate>**](QueryRequestPredicate.html) | The list of predicates used to filter the data | |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|