purecloudplatformclientv2 95.0.0 → 96.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (140) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AnalyticsProposedAgent.md +14 -0
  4. data/docs/AnalyticsSession.md +2 -0
  5. data/docs/ArrayNode.md +4 -4
  6. data/docs/AuditApi.md +60 -0
  7. data/docs/BuAgentSchedulesQueryResponse.md +1 -0
  8. data/docs/CoachingApi.md +80 -2
  9. data/docs/CoachingAppointmentAggregateRequest.md +16 -0
  10. data/docs/CoachingAppointmentAggregateResponse.md +13 -0
  11. data/docs/CoachingAppointmentResponse.md +1 -0
  12. data/docs/ConversationMetrics.md +15 -0
  13. data/docs/ExternalOrganizationTrustorLink.md +1 -2
  14. data/docs/GenericSAML.md +1 -1
  15. data/docs/JsonNode.md +4 -4
  16. data/docs/OAuthClient.md +1 -0
  17. data/docs/OAuthClientListing.md +1 -0
  18. data/docs/OAuthClientRequest.md +1 -0
  19. data/docs/OrgOAuthClient.md +1 -0
  20. data/docs/Permissions.md +0 -2
  21. data/docs/QueryRequestClause.md +14 -0
  22. data/docs/QueryRequestFilter.md +14 -0
  23. data/docs/QueryRequestPredicate.md +14 -0
  24. data/docs/QueryResponseData.md +14 -0
  25. data/docs/QueryResponseGroupedData.md +14 -0
  26. data/docs/QueryResponseMetric.md +14 -0
  27. data/docs/QueryResponseStats.md +13 -0
  28. data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
  29. data/docs/ReportingExportJobResponse.md +1 -0
  30. data/docs/RoutingApi.md +1 -1
  31. data/docs/SearchApi.md +2 -1
  32. data/docs/SpeechTextAnalyticsApi.md +66 -0
  33. data/docs/StatEventFlowOutcomeTopicDatum.md +14 -0
  34. data/docs/StatEventFlowOutcomeTopicMetric.md +15 -0
  35. data/docs/StatEventFlowOutcomeTopicStatsNotification.md +14 -0
  36. data/docs/StatEventFlowTopicDatum.md +14 -0
  37. data/docs/StatEventFlowTopicMetric.md +15 -0
  38. data/docs/StatEventFlowTopicStatsNotification.md +14 -0
  39. data/docs/StatEventWrapUpCodeTopicDatum.md +14 -0
  40. data/docs/StatEventWrapUpCodeTopicMetric.md +15 -0
  41. data/docs/StatEventWrapUpCodeTopicStatsNotification.md +14 -0
  42. data/docs/UserScheduleAdherence.md +1 -0
  43. data/docs/UserSearchRequest.md +1 -0
  44. data/docs/UsersApi.md +2 -1
  45. data/docs/WemCoachingAppointmentTopicCoachingAppointmentNotification.md +1 -0
  46. data/docs/WfmBusinessUnitReference.md +1 -1
  47. data/docs/WfmScheduleReference.md +3 -3
  48. data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUriReference.md +14 -0
  49. data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.md +1 -0
  50. data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference.md +13 -0
  51. data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUriReference.md +14 -0
  52. data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserReference.md +13 -0
  53. data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate.md +28 -0
  54. data/docs/WfmUserScheduleAdherenceUpdatedTopicUriReference.md +14 -0
  55. data/docs/WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.md +1 -0
  56. data/lib/purecloudplatformclientv2.rb +26 -0
  57. data/lib/purecloudplatformclientv2/api/audit_api.rb +55 -0
  58. data/lib/purecloudplatformclientv2/api/coaching_api.rb +127 -0
  59. data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
  60. data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +65 -0
  61. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  62. data/lib/purecloudplatformclientv2/models/acw_settings.rb +2 -2
  63. data/lib/purecloudplatformclientv2/models/analytics_proposed_agent.rb +228 -0
  64. data/lib/purecloudplatformclientv2/models/analytics_session.rb +58 -4
  65. data/lib/purecloudplatformclientv2/models/array_node.rb +54 -54
  66. data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
  67. data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +2 -2
  68. data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +2 -2
  69. data/lib/purecloudplatformclientv2/models/audit_query_request.rb +2 -2
  70. data/lib/purecloudplatformclientv2/models/audit_query_service.rb +2 -2
  71. data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +2 -2
  72. data/lib/purecloudplatformclientv2/models/bu_agent_schedules_query_response.rb +30 -4
  73. data/lib/purecloudplatformclientv2/models/coaching_appointment_aggregate_request.rb +294 -0
  74. data/lib/purecloudplatformclientv2/models/coaching_appointment_aggregate_response.rb +204 -0
  75. data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +27 -1
  76. data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
  77. data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +2 -2
  78. data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_media_participant.rb +2 -2
  79. data/lib/purecloudplatformclientv2/models/conversation_metrics.rb +254 -0
  80. data/lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb +2 -2
  81. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  82. data/lib/purecloudplatformclientv2/models/external_organization_trustor_link.rb +8 -34
  83. data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
  84. data/lib/purecloudplatformclientv2/models/generic_saml.rb +12 -12
  85. data/lib/purecloudplatformclientv2/models/ip_address_range.rb +2 -2
  86. data/lib/purecloudplatformclientv2/models/journey_aggregate_query_predicate.rb +2 -2
  87. data/lib/purecloudplatformclientv2/models/json_node.rb +54 -54
  88. data/lib/purecloudplatformclientv2/models/message.rb +2 -2
  89. data/lib/purecloudplatformclientv2/models/message_data.rb +2 -2
  90. data/lib/purecloudplatformclientv2/models/message_media_participant.rb +2 -2
  91. data/lib/purecloudplatformclientv2/models/messaging_integration.rb +2 -2
  92. data/lib/purecloudplatformclientv2/models/messaging_sticker.rb +2 -2
  93. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +27 -1
  94. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +27 -1
  95. data/lib/purecloudplatformclientv2/models/o_auth_client_request.rb +30 -4
  96. data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +27 -1
  97. data/lib/purecloudplatformclientv2/models/participant.rb +2 -2
  98. data/lib/purecloudplatformclientv2/models/participant_basic.rb +2 -2
  99. data/lib/purecloudplatformclientv2/models/permissions.rb +1 -52
  100. data/lib/purecloudplatformclientv2/models/query_request_clause.rb +254 -0
  101. data/lib/purecloudplatformclientv2/models/query_request_filter.rb +254 -0
  102. data/lib/purecloudplatformclientv2/models/query_request_predicate.rb +252 -0
  103. data/lib/purecloudplatformclientv2/models/query_response_data.rb +230 -0
  104. data/lib/purecloudplatformclientv2/models/query_response_grouped_data.rb +232 -0
  105. data/lib/purecloudplatformclientv2/models/query_response_metric.rb +242 -0
  106. data/lib/purecloudplatformclientv2/models/query_response_stats.rb +202 -0
  107. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +2 -2
  108. data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media_participant.rb +2 -2
  109. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +2 -2
  110. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +2 -2
  111. data/lib/purecloudplatformclientv2/models/recipient.rb +2 -2
  112. data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +26 -1
  113. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +32 -1
  114. data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
  115. data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_request.rb +2 -2
  116. data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_response.rb +2 -2
  117. data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_datum.rb +228 -0
  118. data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_metric.rb +253 -0
  119. data/lib/purecloudplatformclientv2/models/stat_event_flow_outcome_topic_stats_notification.rb +230 -0
  120. data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_datum.rb +228 -0
  121. data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_metric.rb +253 -0
  122. data/lib/purecloudplatformclientv2/models/stat_event_flow_topic_stats_notification.rb +230 -0
  123. data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_datum.rb +228 -0
  124. data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_metric.rb +253 -0
  125. data/lib/purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_stats_notification.rb +230 -0
  126. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +27 -1
  127. data/lib/purecloudplatformclientv2/models/user_search_request.rb +30 -4
  128. data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +29 -4
  129. data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +6 -1
  130. data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +16 -1
  131. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_uri_reference.rb +226 -0
  132. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_user_schedule_adherence_update.rb +26 -1
  133. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_queue_reference.rb +201 -0
  134. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_uri_reference.rb +226 -0
  135. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_reference.rb +201 -0
  136. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_schedule_adherence_update.rb +606 -0
  137. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_uri_reference.rb +226 -0
  138. data/lib/purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update.rb +26 -1
  139. data/lib/purecloudplatformclientv2/version.rb +1 -1
  140. metadata +55 -3
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: WfmUserScheduleAdherenceUpdatedTeamTopicUriReference
3
+ ---
4
+ ## PureCloud::WfmUserScheduleAdherenceUpdatedTeamTopicUriReference
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -0,0 +1,13 @@
1
+ ---
2
+ title: WfmUserScheduleAdherenceUpdatedTeamTopicUserReference
3
+ ---
4
+ ## PureCloud::WfmUserScheduleAdherenceUpdatedTeamTopicUserReference
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ {: class="table table-striped"}
12
+
13
+
@@ -0,0 +1,28 @@
1
+ ---
2
+ title: WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate
3
+ ---
4
+ ## PureCloud::WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **user** | [**WfmUserScheduleAdherenceUpdatedTeamTopicUserReference**](WfmUserScheduleAdherenceUpdatedTeamTopicUserReference.html) | | [optional] |
11
+ | **management_unit_id** | **String** | | [optional] |
12
+ | **team** | [**WfmUserScheduleAdherenceUpdatedTeamTopicUriReference**](WfmUserScheduleAdherenceUpdatedTeamTopicUriReference.html) | | [optional] |
13
+ | **scheduled_activity_category** | **String** | | [optional] |
14
+ | **system_presence** | **String** | | [optional] |
15
+ | **organization_secondary_presence_id** | **String** | | [optional] |
16
+ | **routing_status** | **String** | | [optional] |
17
+ | **actual_activity_category** | **String** | | [optional] |
18
+ | **is_out_of_office** | **BOOLEAN** | | [optional] |
19
+ | **adherence_state** | **String** | | [optional] |
20
+ | **impact** | **String** | | [optional] |
21
+ | **adherence_change_time** | **DateTime** | | [optional] |
22
+ | **presence_update_time** | **DateTime** | | [optional] |
23
+ | **active_queues** | [**Array<WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference>**](WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference.html) | | [optional] |
24
+ | **active_queues_modified_time** | **DateTime** | | [optional] |
25
+ | **removed_from_management_unit** | **BOOLEAN** | | [optional] |
26
+ {: class="table table-striped"}
27
+
28
+
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: WfmUserScheduleAdherenceUpdatedTopicUriReference
3
+ ---
4
+ ## PureCloud::WfmUserScheduleAdherenceUpdatedTopicUriReference
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **id** | **String** | | [optional] |
11
+ | **name** | **String** | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
@@ -9,6 +9,7 @@ title: WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **user** | [**WfmUserScheduleAdherenceUpdatedTopicUserReference**](WfmUserScheduleAdherenceUpdatedTopicUserReference.html) | | [optional] |
11
11
  | **management_unit_id** | **String** | | [optional] |
12
+ | **team** | [**WfmUserScheduleAdherenceUpdatedTopicUriReference**](WfmUserScheduleAdherenceUpdatedTopicUriReference.html) | | [optional] |
12
13
  | **scheduled_activity_category** | **String** | | [optional] |
13
14
  | **system_presence** | **String** | | [optional] |
14
15
  | **organization_secondary_presence_id** | **String** | | [optional] |
@@ -77,6 +77,7 @@ require 'purecloudplatformclientv2/models/analytics_media_endpoint_stat'
77
77
  require 'purecloudplatformclientv2/models/analytics_participant'
78
78
  require 'purecloudplatformclientv2/models/analytics_participant_without_attributes'
79
79
  require 'purecloudplatformclientv2/models/analytics_property'
80
+ require 'purecloudplatformclientv2/models/analytics_proposed_agent'
80
81
  require 'purecloudplatformclientv2/models/analytics_query_aggregation'
81
82
  require 'purecloudplatformclientv2/models/analytics_routing_status_record'
82
83
  require 'purecloudplatformclientv2/models/analytics_scored_agent'
@@ -326,6 +327,8 @@ require 'purecloudplatformclientv2/models/client_app_entity_listing'
326
327
  require 'purecloudplatformclientv2/models/coaching_annotation'
327
328
  require 'purecloudplatformclientv2/models/coaching_annotation_create_request'
328
329
  require 'purecloudplatformclientv2/models/coaching_annotation_list'
330
+ require 'purecloudplatformclientv2/models/coaching_appointment_aggregate_request'
331
+ require 'purecloudplatformclientv2/models/coaching_appointment_aggregate_response'
329
332
  require 'purecloudplatformclientv2/models/coaching_appointment_reference'
330
333
  require 'purecloudplatformclientv2/models/coaching_appointment_response'
331
334
  require 'purecloudplatformclientv2/models/coaching_appointment_response_list'
@@ -527,6 +530,7 @@ require 'purecloudplatformclientv2/models/conversation_message_event_topic_messa
527
530
  require 'purecloudplatformclientv2/models/conversation_message_event_topic_scored_agent'
528
531
  require 'purecloudplatformclientv2/models/conversation_message_event_topic_uri_reference'
529
532
  require 'purecloudplatformclientv2/models/conversation_message_event_topic_wrapup'
533
+ require 'purecloudplatformclientv2/models/conversation_metrics'
530
534
  require 'purecloudplatformclientv2/models/conversation_properties'
531
535
  require 'purecloudplatformclientv2/models/conversation_query'
532
536
  require 'purecloudplatformclientv2/models/conversation_reference'
@@ -1310,6 +1314,13 @@ require 'purecloudplatformclientv2/models/quality_audit_page'
1310
1314
  require 'purecloudplatformclientv2/models/query_division'
1311
1315
  require 'purecloudplatformclientv2/models/query_facet_info'
1312
1316
  require 'purecloudplatformclientv2/models/query_request'
1317
+ require 'purecloudplatformclientv2/models/query_request_clause'
1318
+ require 'purecloudplatformclientv2/models/query_request_filter'
1319
+ require 'purecloudplatformclientv2/models/query_request_predicate'
1320
+ require 'purecloudplatformclientv2/models/query_response_data'
1321
+ require 'purecloudplatformclientv2/models/query_response_grouped_data'
1322
+ require 'purecloudplatformclientv2/models/query_response_metric'
1323
+ require 'purecloudplatformclientv2/models/query_response_stats'
1313
1324
  require 'purecloudplatformclientv2/models/query_result'
1314
1325
  require 'purecloudplatformclientv2/models/query_results'
1315
1326
  require 'purecloudplatformclientv2/models/queue'
@@ -1727,12 +1738,21 @@ require 'purecloudplatformclientv2/models/source_planning_group_request'
1727
1738
  require 'purecloudplatformclientv2/models/stat_event_campaign_topic_datum'
1728
1739
  require 'purecloudplatformclientv2/models/stat_event_campaign_topic_metric'
1729
1740
  require 'purecloudplatformclientv2/models/stat_event_campaign_topic_stats_notification'
1741
+ require 'purecloudplatformclientv2/models/stat_event_flow_outcome_topic_datum'
1742
+ require 'purecloudplatformclientv2/models/stat_event_flow_outcome_topic_metric'
1743
+ require 'purecloudplatformclientv2/models/stat_event_flow_outcome_topic_stats_notification'
1744
+ require 'purecloudplatformclientv2/models/stat_event_flow_topic_datum'
1745
+ require 'purecloudplatformclientv2/models/stat_event_flow_topic_metric'
1746
+ require 'purecloudplatformclientv2/models/stat_event_flow_topic_stats_notification'
1730
1747
  require 'purecloudplatformclientv2/models/stat_event_queue_topic_datum'
1731
1748
  require 'purecloudplatformclientv2/models/stat_event_queue_topic_metric'
1732
1749
  require 'purecloudplatformclientv2/models/stat_event_queue_topic_stats_notification'
1733
1750
  require 'purecloudplatformclientv2/models/stat_event_user_topic_datum'
1734
1751
  require 'purecloudplatformclientv2/models/stat_event_user_topic_metric'
1735
1752
  require 'purecloudplatformclientv2/models/stat_event_user_topic_stats_notification'
1753
+ require 'purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_datum'
1754
+ require 'purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_metric'
1755
+ require 'purecloudplatformclientv2/models/stat_event_wrap_up_code_topic_stats_notification'
1736
1756
  require 'purecloudplatformclientv2/models/station'
1737
1757
  require 'purecloudplatformclientv2/models/station_entity_listing'
1738
1758
  require 'purecloudplatformclientv2/models/station_settings'
@@ -2083,9 +2103,15 @@ require 'purecloudplatformclientv2/models/wfm_user_notification_topic_time_off_r
2083
2103
  require 'purecloudplatformclientv2/models/wfm_user_notification_topic_user_reference'
2084
2104
  require 'purecloudplatformclientv2/models/wfm_user_notification_topic_wfm_user_notification'
2085
2105
  require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_queue_reference'
2106
+ require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_uri_reference'
2086
2107
  require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_user_reference'
2087
2108
  require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_mu_topic_user_schedule_adherence_update'
2109
+ require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_queue_reference'
2110
+ require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_uri_reference'
2111
+ require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_reference'
2112
+ require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_team_topic_user_schedule_adherence_update'
2088
2113
  require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_queue_reference'
2114
+ require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_uri_reference'
2089
2115
  require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_reference'
2090
2116
  require 'purecloudplatformclientv2/models/wfm_user_schedule_adherence_updated_topic_user_schedule_adherence_update'
2091
2117
  require 'purecloudplatformclientv2/models/wfm_versioned_entity_metadata'
@@ -24,6 +24,61 @@ module PureCloud
24
24
  @api_client = api_client
25
25
  end
26
26
 
27
+ # Get service mapping information used in audits.
28
+ #
29
+ # @param [Hash] opts the optional parameters
30
+ # @return [AuditQueryServiceMapping]
31
+ def get_audits_query_realtime_servicemapping(opts = {})
32
+ data, _status_code, _headers = get_audits_query_realtime_servicemapping_with_http_info(opts)
33
+ return data
34
+ end
35
+
36
+ # Get service mapping information used in audits.
37
+ #
38
+ # @param [Hash] opts the optional parameters
39
+ # @return [Array<(AuditQueryServiceMapping, Fixnum, Hash)>] AuditQueryServiceMapping data, response status code and response headers
40
+ def get_audits_query_realtime_servicemapping_with_http_info(opts = {})
41
+ if @api_client.config.debugging
42
+ @api_client.config.logger.debug "Calling API: AuditApi.get_audits_query_realtime_servicemapping ..."
43
+ end
44
+
45
+ # resource path
46
+ local_var_path = "/api/v2/audits/query/realtime/servicemapping".sub('{format}','json')
47
+
48
+ # query parameters
49
+ query_params = {}
50
+
51
+ # header parameters
52
+ header_params = {}
53
+
54
+ # HTTP header 'Accept' (if needed)
55
+ local_header_accept = ['application/json']
56
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
57
+
58
+ # HTTP header 'Content-Type'
59
+ local_header_content_type = ['application/json']
60
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
61
+
62
+ # form parameters
63
+ form_params = {}
64
+
65
+ # http body (model)
66
+ post_body = nil
67
+
68
+ auth_names = ['PureCloud OAuth']
69
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => 'AuditQueryServiceMapping')
76
+ if @api_client.config.debugging
77
+ @api_client.config.logger.debug "API called: AuditApi#get_audits_query_realtime_servicemapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
+ end
79
+ return data, status_code, headers
80
+ end
81
+
27
82
  # Get service mapping information used in audits.
28
83
  #
29
84
  # @param [Hash] opts the optional parameters
@@ -479,6 +479,9 @@ module PureCloud
479
479
  # @option opts [Array<String>] :statuses Appointment Statuses to filter by
480
480
  # @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
481
481
  # @option opts [String] :sort_order Sort (by due date) either Asc or Desc
482
+ # @option opts [Array<String>] :relationships Relationships to filter by
483
+ # @option opts [String] :completion_interval 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
484
+ # @option opts [String] :overdue Overdue status to filter by
482
485
  # @return [CoachingAppointmentResponseList]
483
486
  def get_coaching_appointments(user_ids, opts = {})
484
487
  data, _status_code, _headers = get_coaching_appointments_with_http_info(user_ids, opts)
@@ -495,6 +498,9 @@ module PureCloud
495
498
  # @option opts [Array<String>] :statuses Appointment Statuses to filter by
496
499
  # @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
497
500
  # @option opts [String] :sort_order Sort (by due date) either Asc or Desc
501
+ # @option opts [Array<String>] :relationships Relationships to filter by
502
+ # @option opts [String] :completion_interval 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
503
+ # @option opts [String] :overdue Overdue status to filter by
498
504
  # @return [Array<(CoachingAppointmentResponseList, Fixnum, Hash)>] CoachingAppointmentResponseList data, response status code and response headers
499
505
  def get_coaching_appointments_with_http_info(user_ids, opts = {})
500
506
  if @api_client.config.debugging
@@ -549,6 +555,28 @@ module PureCloud
549
555
 
550
556
 
551
557
 
558
+
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+ if opts[:'overdue'] && !['Any', 'True', 'False'].include?(opts[:'overdue'])
574
+ fail ArgumentError, 'invalid value for "overdue", must be one of Any, True, False'
575
+ end
576
+
577
+
578
+
579
+
552
580
  # resource path
553
581
  local_var_path = "/api/v2/coaching/appointments".sub('{format}','json')
554
582
 
@@ -561,6 +589,9 @@ module PureCloud
561
589
  query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if opts[:'statuses']
562
590
  query_params[:'facilitatorIds'] = @api_client.build_collection_param(opts[:'facilitator_ids'], :multi) if opts[:'facilitator_ids']
563
591
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
592
+ query_params[:'relationships'] = @api_client.build_collection_param(opts[:'relationships'], :multi) if opts[:'relationships']
593
+ query_params[:'completionInterval'] = opts[:'completion_interval'] if opts[:'completion_interval']
594
+ query_params[:'overdue'] = opts[:'overdue'] if opts[:'overdue']
564
595
 
565
596
  # header parameters
566
597
  header_params = {}
@@ -602,6 +633,9 @@ module PureCloud
602
633
  # @option opts [Array<String>] :statuses Appointment Statuses to filter by
603
634
  # @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
604
635
  # @option opts [String] :sort_order Sort (by due date) either Asc or Desc
636
+ # @option opts [Array<String>] :relationships Relationships to filter by
637
+ # @option opts [String] :completion_interval 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
638
+ # @option opts [String] :overdue Overdue status to filter by
605
639
  # @return [CoachingAppointmentResponseList]
606
640
  def get_coaching_appointments_me(opts = {})
607
641
  data, _status_code, _headers = get_coaching_appointments_me_with_http_info(opts)
@@ -617,6 +651,9 @@ module PureCloud
617
651
  # @option opts [Array<String>] :statuses Appointment Statuses to filter by
618
652
  # @option opts [Array<String>] :facilitator_ids The facilitator IDs for which to retrieve appointments
619
653
  # @option opts [String] :sort_order Sort (by due date) either Asc or Desc
654
+ # @option opts [Array<String>] :relationships Relationships to filter by
655
+ # @option opts [String] :completion_interval 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
656
+ # @option opts [String] :overdue Overdue status to filter by
620
657
  # @return [Array<(CoachingAppointmentResponseList, Fixnum, Hash)>] CoachingAppointmentResponseList data, response status code and response headers
621
658
  def get_coaching_appointments_me_with_http_info(opts = {})
622
659
  if @api_client.config.debugging
@@ -663,6 +700,28 @@ module PureCloud
663
700
 
664
701
 
665
702
 
703
+
704
+
705
+
706
+
707
+
708
+
709
+
710
+
711
+
712
+
713
+
714
+
715
+
716
+
717
+
718
+ if opts[:'overdue'] && !['Any', 'True', 'False'].include?(opts[:'overdue'])
719
+ fail ArgumentError, 'invalid value for "overdue", must be one of Any, True, False'
720
+ end
721
+
722
+
723
+
724
+
666
725
  # resource path
667
726
  local_var_path = "/api/v2/coaching/appointments/me".sub('{format}','json')
668
727
 
@@ -674,6 +733,9 @@ module PureCloud
674
733
  query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if opts[:'statuses']
675
734
  query_params[:'facilitatorIds'] = @api_client.build_collection_param(opts[:'facilitator_ids'], :multi) if opts[:'facilitator_ids']
676
735
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
736
+ query_params[:'relationships'] = @api_client.build_collection_param(opts[:'relationships'], :multi) if opts[:'relationships']
737
+ query_params[:'completionInterval'] = opts[:'completion_interval'] if opts[:'completion_interval']
738
+ query_params[:'overdue'] = opts[:'overdue'] if opts[:'overdue']
677
739
 
678
740
  # header parameters
679
741
  header_params = {}
@@ -1311,5 +1373,70 @@ module PureCloud
1311
1373
  end
1312
1374
  return data, status_code, headers
1313
1375
  end
1376
+
1377
+ # Retrieve aggregated appointment data
1378
+ #
1379
+ # @param body Aggregate Request
1380
+ # @param [Hash] opts the optional parameters
1381
+ # @return [CoachingAppointmentAggregateResponse]
1382
+ def post_coaching_appointments_aggregates_query(body, opts = {})
1383
+ data, _status_code, _headers = post_coaching_appointments_aggregates_query_with_http_info(body, opts)
1384
+ return data
1385
+ end
1386
+
1387
+ # Retrieve aggregated appointment data
1388
+ #
1389
+ # @param body Aggregate Request
1390
+ # @param [Hash] opts the optional parameters
1391
+ # @return [Array<(CoachingAppointmentAggregateResponse, Fixnum, Hash)>] CoachingAppointmentAggregateResponse data, response status code and response headers
1392
+ def post_coaching_appointments_aggregates_query_with_http_info(body, opts = {})
1393
+ if @api_client.config.debugging
1394
+ @api_client.config.logger.debug "Calling API: CoachingApi.post_coaching_appointments_aggregates_query ..."
1395
+ end
1396
+
1397
+
1398
+ # verify the required parameter 'body' is set
1399
+ fail ArgumentError, "Missing the required parameter 'body' when calling CoachingApi.post_coaching_appointments_aggregates_query" if body.nil?
1400
+
1401
+
1402
+
1403
+
1404
+
1405
+ # resource path
1406
+ local_var_path = "/api/v2/coaching/appointments/aggregates/query".sub('{format}','json')
1407
+
1408
+ # query parameters
1409
+ query_params = {}
1410
+
1411
+ # header parameters
1412
+ header_params = {}
1413
+
1414
+ # HTTP header 'Accept' (if needed)
1415
+ local_header_accept = ['application/json']
1416
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
1417
+
1418
+ # HTTP header 'Content-Type'
1419
+ local_header_content_type = ['application/json']
1420
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
1421
+
1422
+ # form parameters
1423
+ form_params = {}
1424
+
1425
+ # http body (model)
1426
+ post_body = @api_client.object_to_http_body(body)
1427
+
1428
+ auth_names = ['PureCloud OAuth']
1429
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
1430
+ :header_params => header_params,
1431
+ :query_params => query_params,
1432
+ :form_params => form_params,
1433
+ :body => post_body,
1434
+ :auth_names => auth_names,
1435
+ :return_type => 'CoachingAppointmentAggregateResponse')
1436
+ if @api_client.config.debugging
1437
+ @api_client.config.logger.debug "API called: CoachingApi#post_coaching_appointments_aggregates_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1438
+ end
1439
+ return data, status_code, headers
1440
+ end
1314
1441
  end
1315
1442
  end
@@ -1497,8 +1497,8 @@ module PureCloud
1497
1497
 
1498
1498
 
1499
1499
 
1500
- if opts[:'messenger_type'] && !['sms', 'facebook', 'twitter', 'line', 'whatsapp'].include?(opts[:'messenger_type'])
1501
- fail ArgumentError, 'invalid value for "messenger_type", must be one of sms, facebook, twitter, line, whatsapp'
1500
+ if opts[:'messenger_type'] && !['sms', 'facebook', 'twitter', 'line', 'whatsapp', 'webmessaging'].include?(opts[:'messenger_type'])
1501
+ fail ArgumentError, 'invalid value for "messenger_type", must be one of sms, facebook, twitter, line, whatsapp, webmessaging'
1502
1502
  end
1503
1503
 
1504
1504
 
@@ -24,6 +24,71 @@ module PureCloud
24
24
  @api_client = api_client
25
25
  end
26
26
 
27
+ # Get Speech and Text Analytics for a specific conversation
28
+ #
29
+ # @param conversation_id Conversation Id
30
+ # @param [Hash] opts the optional parameters
31
+ # @return [ConversationMetrics]
32
+ def get_speechandtextanalytics_conversation(conversation_id, opts = {})
33
+ data, _status_code, _headers = get_speechandtextanalytics_conversation_with_http_info(conversation_id, opts)
34
+ return data
35
+ end
36
+
37
+ # Get Speech and Text Analytics for a specific conversation
38
+ #
39
+ # @param conversation_id Conversation Id
40
+ # @param [Hash] opts the optional parameters
41
+ # @return [Array<(ConversationMetrics, Fixnum, Hash)>] ConversationMetrics data, response status code and response headers
42
+ def get_speechandtextanalytics_conversation_with_http_info(conversation_id, opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug "Calling API: SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation ..."
45
+ end
46
+
47
+
48
+ # verify the required parameter 'conversation_id' is set
49
+ fail ArgumentError, "Missing the required parameter 'conversation_id' when calling SpeechTextAnalyticsApi.get_speechandtextanalytics_conversation" if conversation_id.nil?
50
+
51
+
52
+
53
+
54
+
55
+ # resource path
56
+ local_var_path = "/api/v2/speechandtextanalytics/conversations/{conversationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
57
+
58
+ # query parameters
59
+ query_params = {}
60
+
61
+ # header parameters
62
+ header_params = {}
63
+
64
+ # HTTP header 'Accept' (if needed)
65
+ local_header_accept = ['application/json']
66
+ local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
67
+
68
+ # HTTP header 'Content-Type'
69
+ local_header_content_type = ['application/json']
70
+ header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
71
+
72
+ # form parameters
73
+ form_params = {}
74
+
75
+ # http body (model)
76
+ post_body = nil
77
+
78
+ auth_names = ['PureCloud OAuth']
79
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
80
+ :header_params => header_params,
81
+ :query_params => query_params,
82
+ :form_params => form_params,
83
+ :body => post_body,
84
+ :auth_names => auth_names,
85
+ :return_type => 'ConversationMetrics')
86
+ if @api_client.config.debugging
87
+ @api_client.config.logger.debug "API called: SpeechTextAnalyticsApi#get_speechandtextanalytics_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
+ end
89
+ return data, status_code, headers
90
+ end
91
+
27
92
  # Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
28
93
  #
29
94
  # @param conversation_id Conversation ID