purecloudplatformclientv2 85.0.1 → 86.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.
Files changed (244) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AnalyticsEvaluation.md +1 -1
  4. data/docs/Call.md +1 -0
  5. data/docs/CallBasic.md +1 -0
  6. data/docs/Callback.md +1 -0
  7. data/docs/CallbackBasic.md +1 -0
  8. data/docs/Cobrowsesession.md +1 -0
  9. data/docs/{PartialUploadResponse.md → ContextEntity.md} +3 -3
  10. data/docs/ContextIntent.md +13 -0
  11. data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
  12. data/docs/ConversationChat.md +1 -0
  13. data/docs/ConversationEventTopicCallback.md +1 -0
  14. data/docs/Coretype.md +23 -0
  15. data/docs/CoretypeListing.md +15 -0
  16. data/docs/DataExtensionsApi.md +198 -0
  17. data/docs/DataSchemaListing.md +15 -0
  18. data/docs/DetectedDialogAct.md +14 -0
  19. data/docs/DetectedIntent.md +15 -0
  20. data/docs/DetectedNamedEntity.md +16 -0
  21. data/docs/DetectedNamedEntityValue.md +14 -0
  22. data/docs/DialogflowAgent.md +3 -2
  23. data/docs/Edge.md +1 -1
  24. data/docs/Email.md +1 -0
  25. data/docs/EntityListing.md +1 -5
  26. data/docs/ExternalContactsApi.md +1001 -144
  27. data/docs/FlowDivisionView.md +2 -0
  28. data/docs/IntentDefinition.md +15 -0
  29. data/docs/IntentFeedback.md +16 -0
  30. data/docs/ItemValidationLimits.md +14 -0
  31. data/docs/Items.md +14 -0
  32. data/docs/LanguageUnderstandingApi.md +1160 -0
  33. data/docs/MaxLength.md +14 -0
  34. data/docs/Message.md +1 -0
  35. data/docs/MinLength.md +14 -0
  36. data/docs/NamedEntityAnnotation.md +13 -0
  37. data/docs/NamedEntityTypeBinding.md +14 -0
  38. data/docs/NamedEntityTypeDefinition.md +15 -0
  39. data/docs/NamedEntityTypeItem.md +14 -0
  40. data/docs/NamedEntityTypeMechanism.md +15 -0
  41. data/docs/NluConfusionMatrixColumn.md +14 -0
  42. data/docs/NluConfusionMatrixRow.md +14 -0
  43. data/docs/NluDetectionContext.md +14 -0
  44. data/docs/NluDetectionInput.md +13 -0
  45. data/docs/NluDetectionOutput.md +14 -0
  46. data/docs/NluDetectionRequest.md +14 -0
  47. data/docs/NluDetectionResponse.md +15 -0
  48. data/docs/NluDomain.md +19 -0
  49. data/docs/NluDomainListing.md +22 -0
  50. data/docs/NluDomainVersion.md +24 -0
  51. data/docs/NluDomainVersionListing.md +22 -0
  52. data/docs/NluDomainVersionQualityReport.md +15 -0
  53. data/docs/NluDomainVersionTrainingResponse.md +14 -0
  54. data/docs/NluFeedbackListing.md +22 -0
  55. data/docs/NluFeedbackRequest.md +15 -0
  56. data/docs/NluFeedbackResponse.md +18 -0
  57. data/docs/NluQualityReportSummary.md +13 -0
  58. data/docs/NluQualityReportSummaryMetric.md +14 -0
  59. data/docs/NluUtterance.md +13 -0
  60. data/docs/NluUtteranceSegment.md +14 -0
  61. data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
  62. data/docs/QueueConversationEventTopicCallback.md +1 -0
  63. data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
  64. data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
  65. data/docs/ReportingExportJobRequest.md +1 -0
  66. data/docs/ReportingExportJobResponse.md +2 -0
  67. data/docs/RoutingApi.md +65 -0
  68. data/docs/SCIMApi.md +12 -12
  69. data/docs/Schema.md +17 -0
  70. data/docs/SchemaQuantityLimits.md +26 -0
  71. data/docs/ScimV2EnterpriseUser.md +1 -0
  72. data/docs/Screenshare.md +1 -0
  73. data/docs/SocialExpression.md +1 -0
  74. data/docs/{TimeOffRequestLookup.md → TimeOffRequest.md} +2 -2
  75. data/docs/TimeOffRequestListing.md +13 -0
  76. data/docs/UploadUrlRequest.md +15 -0
  77. data/docs/UploadUrlResponse.md +14 -0
  78. data/docs/UploadsApi.md +78 -0
  79. data/docs/ValidationLimits.md +18 -0
  80. data/docs/Video.md +1 -0
  81. data/docs/WorkforceManagementApi.md +297 -448
  82. data/lib/purecloudplatformclientv2.rb +50 -57
  83. data/lib/purecloudplatformclientv2/api/data_extensions_api.rb +207 -0
  84. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +868 -4
  85. data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +1304 -0
  86. data/lib/purecloudplatformclientv2/api/routing_api.rb +64 -0
  87. data/lib/purecloudplatformclientv2/api/scim_api.rb +8 -8
  88. data/lib/purecloudplatformclientv2/api/uploads_api.rb +92 -0
  89. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +314 -571
  90. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  91. data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
  92. data/lib/purecloudplatformclientv2/models/bulk_update_shift_trade_state_result_item.rb +2 -2
  93. data/lib/purecloudplatformclientv2/models/call.rb +30 -4
  94. data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
  95. data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
  96. data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
  97. data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
  98. data/lib/purecloudplatformclientv2/models/{partial_upload_response.rb → context_entity.rb} +14 -9
  99. data/lib/purecloudplatformclientv2/models/{list_wrapper_wfm_forecast_modification.rb → context_intent.rb} +14 -10
  100. data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb +26 -1
  101. data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
  102. data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
  103. data/lib/purecloudplatformclientv2/models/{rescheduling_options_response.rb → coretype.rb} +97 -102
  104. data/lib/purecloudplatformclientv2/models/{service_goal_group_list.rb → coretype_listing.rb} +34 -11
  105. data/lib/purecloudplatformclientv2/models/data_schema_listing.rb +253 -0
  106. data/lib/purecloudplatformclientv2/models/{forecast_result_response.rb → detected_dialog_act.rb} +16 -16
  107. data/lib/purecloudplatformclientv2/models/{intraday_queue.rb → detected_intent.rb} +23 -23
  108. data/lib/purecloudplatformclientv2/models/detected_named_entity.rb +280 -0
  109. data/lib/purecloudplatformclientv2/models/detected_named_entity_value.rb +228 -0
  110. data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +31 -3
  111. data/lib/purecloudplatformclientv2/models/edge.rb +1 -0
  112. data/lib/purecloudplatformclientv2/models/email.rb +30 -4
  113. data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
  114. data/lib/purecloudplatformclientv2/models/flow_division_view.rb +53 -1
  115. data/lib/purecloudplatformclientv2/models/{create_service_goal_group_request.rb → intent_definition.rb} +30 -19
  116. data/lib/purecloudplatformclientv2/models/{wfm_intraday_queue_listing.rb → intent_feedback.rb} +71 -18
  117. data/lib/purecloudplatformclientv2/models/{service_goal_group_goals.rb → item_validation_limits.rb} +18 -45
  118. data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_response.rb → items.rb} +33 -10
  119. data/lib/purecloudplatformclientv2/models/max_length.rb +238 -0
  120. data/lib/purecloudplatformclientv2/models/message.rb +30 -4
  121. data/lib/purecloudplatformclientv2/models/{forecast_generation_route_group_result.rb → min_length.rb} +26 -18
  122. data/lib/purecloudplatformclientv2/models/{list_wrapper_forecast_source_day_pointer.rb → named_entity_annotation.rb} +14 -10
  123. data/lib/purecloudplatformclientv2/models/{copy_short_term_forecast_request.rb → named_entity_type_binding.rb} +18 -19
  124. data/lib/purecloudplatformclientv2/models/{generate_week_schedule_request.rb → named_entity_type_definition.rb} +38 -13
  125. data/lib/purecloudplatformclientv2/models/{wfm_abandon_rate.rb → named_entity_type_item.rb} +19 -18
  126. data/lib/purecloudplatformclientv2/models/{short_term_forecast_response.rb → named_entity_type_mechanism.rb} +48 -36
  127. data/lib/purecloudplatformclientv2/models/{copy_week_schedule_request.rb → nlu_confusion_matrix_column.rb} +18 -18
  128. data/lib/purecloudplatformclientv2/models/{wfm_average_speed_of_answer.rb → nlu_confusion_matrix_row.rb} +24 -18
  129. data/lib/purecloudplatformclientv2/models/nlu_detection_context.rb +228 -0
  130. data/lib/purecloudplatformclientv2/models/{scheduling_run_list_response.rb → nlu_detection_input.rb} +14 -10
  131. data/lib/purecloudplatformclientv2/models/nlu_detection_output.rb +232 -0
  132. data/lib/purecloudplatformclientv2/models/nlu_detection_request.rb +233 -0
  133. data/lib/purecloudplatformclientv2/models/{route_group_list.rb → nlu_detection_response.rb} +39 -22
  134. data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_item_response.rb → nlu_domain.rb} +66 -60
  135. data/lib/purecloudplatformclientv2/models/{intraday_query_data_command.rb → nlu_domain_listing.rb} +156 -53
  136. data/lib/purecloudplatformclientv2/models/{short_term_forecast.rb → nlu_domain_version.rb} +132 -87
  137. data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +428 -0
  138. data/lib/purecloudplatformclientv2/models/{intraday_metric.rb → nlu_domain_version_quality_report.rb} +57 -28
  139. data/lib/purecloudplatformclientv2/models/{user_schedules_partial_upload_request.rb → nlu_domain_version_training_response.rb} +33 -16
  140. data/lib/purecloudplatformclientv2/models/{import_week_schedule_request.rb → nlu_feedback_listing.rb} +158 -46
  141. data/lib/purecloudplatformclientv2/models/{wfm_service_level.rb → nlu_feedback_request.rb} +36 -25
  142. data/lib/purecloudplatformclientv2/models/{service_goal_group.rb → nlu_feedback_response.rb} +32 -37
  143. data/lib/purecloudplatformclientv2/models/{generate_short_term_forecast_request.rb → nlu_quality_report_summary.rb} +12 -10
  144. data/lib/purecloudplatformclientv2/models/nlu_quality_report_summary_metric.rb +238 -0
  145. data/lib/purecloudplatformclientv2/models/nlu_utterance.rb +209 -0
  146. data/lib/purecloudplatformclientv2/models/nlu_utterance_segment.rb +233 -0
  147. data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_media_participant.rb +26 -1
  148. data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
  149. data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
  150. data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
  151. data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +32 -4
  152. data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +57 -1
  153. data/lib/purecloudplatformclientv2/models/{import_short_term_forecast_request.rb → schema.rb} +50 -35
  154. data/lib/purecloudplatformclientv2/models/schema_quantity_limits.rb +539 -0
  155. data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +30 -4
  156. data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
  157. data/lib/purecloudplatformclientv2/models/shift_trade_match_violation.rb +2 -2
  158. data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
  159. data/lib/purecloudplatformclientv2/models/{time_off_request_lookup.rb → time_off_request.rb} +1 -1
  160. data/lib/purecloudplatformclientv2/models/{time_off_request_lookup_list.rb → time_off_request_listing.rb} +2 -2
  161. data/lib/purecloudplatformclientv2/models/{create_queue_media_association_request.rb → upload_url_request.rb} +23 -26
  162. data/lib/purecloudplatformclientv2/models/upload_url_response.rb +230 -0
  163. data/lib/purecloudplatformclientv2/models/{wfm_forecast_modification_attributes.rb → validation_limits.rb} +76 -38
  164. data/lib/purecloudplatformclientv2/models/video.rb +30 -4
  165. data/lib/purecloudplatformclientv2/version.rb +1 -1
  166. metadata +102 -116
  167. data/docs/AsyncWeekScheduleResponse.md +0 -16
  168. data/docs/CopyShortTermForecastRequest.md +0 -14
  169. data/docs/CopyWeekScheduleRequest.md +0 -14
  170. data/docs/CreateQueueMediaAssociationRequest.md +0 -15
  171. data/docs/CreateServiceGoalGroupRequest.md +0 -15
  172. data/docs/ForecastGenerationResult.md +0 -13
  173. data/docs/ForecastGenerationRouteGroupResult.md +0 -14
  174. data/docs/ForecastResultResponse.md +0 -14
  175. data/docs/ForecastTimeSeriesResult.md +0 -14
  176. data/docs/GenerateShortTermForecastRequest.md +0 -13
  177. data/docs/GenerateShortTermForecastResponse.md +0 -16
  178. data/docs/GenerateWeekScheduleRequest.md +0 -14
  179. data/docs/GenerateWeekScheduleResponse.md +0 -15
  180. data/docs/ImportShortTermForecastRequest.md +0 -16
  181. data/docs/ImportWeekScheduleRequest.md +0 -17
  182. data/docs/IntradayDataGroup.md +0 -19
  183. data/docs/IntradayForecastData.md +0 -15
  184. data/docs/IntradayHistoricalAgentData.md +0 -14
  185. data/docs/IntradayHistoricalQueueData.md +0 -20
  186. data/docs/IntradayMetric.md +0 -14
  187. data/docs/IntradayPerformancePredictionAgentData.md +0 -13
  188. data/docs/IntradayPerformancePredictionQueueData.md +0 -15
  189. data/docs/IntradayQueryDataCommand.md +0 -17
  190. data/docs/IntradayQueue.md +0 -15
  191. data/docs/IntradayResponse.md +0 -20
  192. data/docs/IntradayScheduleData.md +0 -14
  193. data/docs/ListWrapperForecastSourceDayPointer.md +0 -13
  194. data/docs/ListWrapperWfmForecastModification.md +0 -13
  195. data/docs/QueueMediaAssociation.md +0 -16
  196. data/docs/RescheduleRequest.md +0 -20
  197. data/docs/RescheduleResult.md +0 -13
  198. data/docs/ReschedulingOptionsResponse.md +0 -22
  199. data/docs/RouteGroup.md +0 -18
  200. data/docs/RouteGroupAttributes.md +0 -16
  201. data/docs/RouteGroupList.md +0 -14
  202. data/docs/SchedulingRunListResponse.md +0 -13
  203. data/docs/SchedulingRunResponse.md +0 -28
  204. data/docs/ServiceGoalGroup.md +0 -18
  205. data/docs/ServiceGoalGroupGoals.md +0 -15
  206. data/docs/ServiceGoalGroupList.md +0 -14
  207. data/docs/ShortTermForecast.md +0 -22
  208. data/docs/ShortTermForecastListItemResponse.md +0 -18
  209. data/docs/ShortTermForecastListResponse.md +0 -13
  210. data/docs/ShortTermForecastResponse.md +0 -15
  211. data/docs/TimeOffRequestEntityList.md +0 -13
  212. data/docs/TimeOffRequestLookupList.md +0 -13
  213. data/docs/UnscheduledAgentWarning.md +0 -14
  214. data/docs/UpdateWeekScheduleRequest.md +0 -21
  215. data/docs/UserSchedulesPartialUploadRequest.md +0 -13
  216. data/docs/WfmAbandonRate.md +0 -14
  217. data/docs/WfmAverageSpeedOfAnswer.md +0 -14
  218. data/docs/WfmForecastModification.md +0 -20
  219. data/docs/WfmForecastModificationAttributes.md +0 -16
  220. data/docs/WfmIntradayQueueListing.md +0 -14
  221. data/docs/WfmServiceLevel.md +0 -15
  222. data/lib/purecloudplatformclientv2/models/async_week_schedule_response.rb +0 -295
  223. data/lib/purecloudplatformclientv2/models/forecast_generation_result.rb +0 -204
  224. data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +0 -256
  225. data/lib/purecloudplatformclientv2/models/generate_short_term_forecast_response.rb +0 -294
  226. data/lib/purecloudplatformclientv2/models/generate_week_schedule_response.rb +0 -269
  227. data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +0 -384
  228. data/lib/purecloudplatformclientv2/models/intraday_forecast_data.rb +0 -254
  229. data/lib/purecloudplatformclientv2/models/intraday_historical_agent_data.rb +0 -228
  230. data/lib/purecloudplatformclientv2/models/intraday_historical_queue_data.rb +0 -384
  231. data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_agent_data.rb +0 -202
  232. data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_queue_data.rb +0 -254
  233. data/lib/purecloudplatformclientv2/models/intraday_response.rb +0 -404
  234. data/lib/purecloudplatformclientv2/models/intraday_schedule_data.rb +0 -228
  235. data/lib/purecloudplatformclientv2/models/queue_media_association.rb +0 -283
  236. data/lib/purecloudplatformclientv2/models/reschedule_request.rb +0 -418
  237. data/lib/purecloudplatformclientv2/models/reschedule_result.rb +0 -202
  238. data/lib/purecloudplatformclientv2/models/route_group.rb +0 -363
  239. data/lib/purecloudplatformclientv2/models/route_group_attributes.rb +0 -307
  240. data/lib/purecloudplatformclientv2/models/scheduling_run_response.rb +0 -609
  241. data/lib/purecloudplatformclientv2/models/time_off_request_entity_list.rb +0 -203
  242. data/lib/purecloudplatformclientv2/models/unscheduled_agent_warning.rb +0 -242
  243. data/lib/purecloudplatformclientv2/models/update_week_schedule_request.rb +0 -438
  244. data/lib/purecloudplatformclientv2/models/wfm_forecast_modification.rb +0 -435
data/docs/AsyncWeekScheduleResponse.md DELETED
@@ -1,16 +0,0 @@
1
- ---
2
- title: AsyncWeekScheduleResponse
3
- ---
4
- ## PureCloud::AsyncWeekScheduleResponse
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **result** | [**WeekSchedule**](WeekSchedule.html) | Week schedule result. The value will be null if the data is sent through notification or if response is large. | [optional] |
11
- | **download_url** | **String** | The url to fetch the result for large responses. The value is null if result contains the data | [optional] |
12
- | **status** | **String** | The status of the request | [optional] |
13
- | **operation_id** | **String** | The operation id to watch for on the notification topic if status == Processing | [optional] |
14
- {: class="table table-striped"}
15
-
16
-
data/docs/CopyShortTermForecastRequest.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: CopyShortTermForecastRequest
3
- ---
4
- ## PureCloud::CopyShortTermForecastRequest
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **week_date** | **String** | The first day of the short term forecast in yyyy-MM-dd format. Must be the management unit's start day of week | |
11
- | **description** | **String** | Description for the new forecast | |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/CopyWeekScheduleRequest.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: CopyWeekScheduleRequest
3
- ---
4
- ## PureCloud::CopyWeekScheduleRequest
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **description** | **String** | Description of the copied week schedule | |
11
- | **week_date** | **String** | Week in yyyy-MM-dd format to which the schedule is copied | |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/CreateQueueMediaAssociationRequest.md DELETED
@@ -1,15 +0,0 @@
1
- ---
2
- title: CreateQueueMediaAssociationRequest
3
- ---
4
- ## PureCloud::CreateQueueMediaAssociationRequest
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
- | **queue** | [**QueueReference**](QueueReference.html) | The queue to associate with the service goal group | [optional] |
12
- | **media_types** | **Array<String>** | The media types of the given queue to associate with the service goal group | [optional] |
13
- {: class="table table-striped"}
14
-
15
-
data/docs/CreateServiceGoalGroupRequest.md DELETED
@@ -1,15 +0,0 @@
1
- ---
2
- title: CreateServiceGoalGroupRequest
3
- ---
4
- ## PureCloud::CreateServiceGoalGroupRequest
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **name** | **String** | name | |
11
- | **goals** | [**ServiceGoalGroupGoals**](ServiceGoalGroupGoals.html) | Goals defined for this service goal group | [optional] |
12
- | **queue_media_associations** | [**Array<CreateQueueMediaAssociationRequest>**](CreateQueueMediaAssociationRequest.html) | List of queues and media types from that queue to associate with this service goal group | [optional] |
13
- {: class="table table-striped"}
14
-
15
-
data/docs/ForecastGenerationResult.md DELETED
@@ -1,13 +0,0 @@
1
- ---
2
- title: ForecastGenerationResult
3
- ---
4
- ## PureCloud::ForecastGenerationResult
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **route_group_results** | [**Array<ForecastGenerationRouteGroupResult>**](ForecastGenerationRouteGroupResult.html) | Generation results, broken down by route group | [optional] |
11
- {: class="table table-striped"}
12
-
13
-
data/docs/ForecastGenerationRouteGroupResult.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: ForecastGenerationRouteGroupResult
3
- ---
4
- ## PureCloud::ForecastGenerationRouteGroupResult
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **route_group** | [**RouteGroupAttributes**](RouteGroupAttributes.html) | The route group this result represents | [optional] |
11
- | **metric_results** | [**Array<ForecastTimeSeriesResult>**](ForecastTimeSeriesResult.html) | The generation results for the associated route group | [optional] |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/ForecastResultResponse.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: ForecastResultResponse
3
- ---
4
- ## PureCloud::ForecastResultResponse
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **result** | [**RouteGroupList**](RouteGroupList.html) | The forecast result. If null, fetch the result from the url in downloadUrl | [optional] |
11
- | **download_url** | **String** | The downloadUrl to fetch the result if it is too large to be sent directly | [optional] |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/ForecastTimeSeriesResult.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: ForecastTimeSeriesResult
3
- ---
4
- ## PureCloud::ForecastTimeSeriesResult
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **metric** | **String** | The metric this result applies to | [optional] |
11
- | **forecasting_method** | **String** | The forecasting method that was used for this metric | [optional] |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/GenerateShortTermForecastRequest.md DELETED
@@ -1,13 +0,0 @@
1
- ---
2
- title: GenerateShortTermForecastRequest
3
- ---
4
- ## PureCloud::GenerateShortTermForecastRequest
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **description** | **String** | Description for the generated forecast. Pass an empty string for no description | |
11
- {: class="table table-striped"}
12
-
13
-
data/docs/GenerateShortTermForecastResponse.md DELETED
@@ -1,16 +0,0 @@
1
- ---
2
- title: GenerateShortTermForecastResponse
3
- ---
4
- ## PureCloud::GenerateShortTermForecastResponse
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **status** | **String** | The status of the request | [optional] |
11
- | **result** | [**ShortTermForecast**](ShortTermForecast.html) | The resulting forecast. May be sent asynchronously via notification depending on the complexity of the forecast | [optional] |
12
- | **operation_id** | **String** | The operation id to watch for on the notification topic | [optional] |
13
- | **progress** | **Integer** | Percent progress. Subscribe to the corresponding notification to view progress and await the result | [optional] |
14
- {: class="table table-striped"}
15
-
16
-
data/docs/GenerateWeekScheduleRequest.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: GenerateWeekScheduleRequest
3
- ---
4
- ## PureCloud::GenerateWeekScheduleRequest
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **description** | **String** | Description for the generated week schedule | |
11
- | **short_term_forecast_id** | **String** | ID of short term forecast used for schedule generation | |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/GenerateWeekScheduleResponse.md DELETED
@@ -1,15 +0,0 @@
1
- ---
2
- title: GenerateWeekScheduleResponse
3
- ---
4
- ## PureCloud::GenerateWeekScheduleResponse
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **download_url** | **String** | The url to fetch the result for large responses. The value is null if result contains the data | [optional] |
11
- | **status** | **String** | The status of the request | [optional] |
12
- | **operation_id** | **String** | The operation id to watch for on the notification topic if status == Processing | [optional] |
13
- {: class="table table-striped"}
14
-
15
-
data/docs/ImportShortTermForecastRequest.md DELETED
@@ -1,16 +0,0 @@
1
- ---
2
- title: ImportShortTermForecastRequest
3
- ---
4
- ## PureCloud::ImportShortTermForecastRequest
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **file_name** | **String** | The file name, if applicable, this data was extracted from (display purposes only) | [optional] |
11
- | **description** | **String** | Description for the imported forecast. Pass an empty string for no description | |
12
- | **route_group_list** | [**RouteGroupList**](RouteGroupList.html) | The raw data to import | |
13
- | **partial_upload_ids** | **Array<String>** | IDs of partial uploads to include in this imported forecast. Only relevant for large forecasts | [optional] |
14
- {: class="table table-striped"}
15
-
16
-
data/docs/ImportWeekScheduleRequest.md DELETED
@@ -1,17 +0,0 @@
1
- ---
2
- title: ImportWeekScheduleRequest
3
- ---
4
- ## PureCloud::ImportWeekScheduleRequest
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **description** | **String** | Description for the schedule | |
11
- | **user_schedules** | [**Hash<String, UserSchedule>**](UserSchedule.html) | User schedules | [optional] |
12
- | **published** | **BOOLEAN** | Whether the schedule is published | [optional] |
13
- | **short_term_forecast_id** | **String** | Short term forecast that should be associated with this schedule | [optional] |
14
- | **partial_upload_ids** | **Array<String>** | IDs of partial uploads of user schedules to import week schedule. It is applicable only for large schedules where activity count in schedule is greater than 17500 | [optional] |
15
- {: class="table table-striped"}
16
-
17
-
data/docs/IntradayDataGroup.md DELETED
@@ -1,19 +0,0 @@
1
- ---
2
- title: IntradayDataGroup
3
- ---
4
- ## PureCloud::IntradayDataGroup
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **media_type** | **String** | The media type associated with this intraday group | [optional] |
11
- | **forecast_data_per_interval** | [**Array<IntradayForecastData>**](IntradayForecastData.html) | Forecast data for this date range | [optional] |
12
- | **schedule_data_per_interval** | [**Array<IntradayScheduleData>**](IntradayScheduleData.html) | Schedule data for this date range | [optional] |
13
- | **historical_agent_data_per_interval** | [**Array<IntradayHistoricalAgentData>**](IntradayHistoricalAgentData.html) | Historical agent data for this date range | [optional] |
14
- | **historical_queue_data_per_interval** | [**Array<IntradayHistoricalQueueData>**](IntradayHistoricalQueueData.html) | Historical queue data for this date range | [optional] |
15
- | **performance_prediction_agent_data_per_interval** | [**Array<IntradayPerformancePredictionAgentData>**](IntradayPerformancePredictionAgentData.html) | Performance prediction data for this date range | [optional] |
16
- | **performance_prediction_queue_data_per_interval** | [**Array<IntradayPerformancePredictionQueueData>**](IntradayPerformancePredictionQueueData.html) | Performance prediction data for this date range | [optional] |
17
- {: class="table table-striped"}
18
-
19
-
data/docs/IntradayForecastData.md DELETED
@@ -1,15 +0,0 @@
1
- ---
2
- title: IntradayForecastData
3
- ---
4
- ## PureCloud::IntradayForecastData
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **offered** | **Float** | The number of interactions routed into the queue for the given media type(s) for an agent to answer | [optional] |
11
- | **average_talk_time_seconds** | **Float** | The average time in seconds an agent spends interacting with a customer | [optional] |
12
- | **average_after_call_work_seconds** | **Float** | The average time in seconds spent in after-call work. After-call work is the work that an agent performs immediately following an interaction | [optional] |
13
- {: class="table table-striped"}
14
-
15
-
data/docs/IntradayHistoricalAgentData.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: IntradayHistoricalAgentData
3
- ---
4
- ## PureCloud::IntradayHistoricalAgentData
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **on_queue_time_seconds** | **Float** | The total on-queue time in seconds for all agents in this group | [optional] |
11
- | **interacting_time_seconds** | **Float** | The total time spent interacting in seconds for all agents in this group | [optional] |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/IntradayHistoricalQueueData.md DELETED
@@ -1,20 +0,0 @@
1
- ---
2
- title: IntradayHistoricalQueueData
3
- ---
4
- ## PureCloud::IntradayHistoricalQueueData
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **offered** | **Integer** | The number of interactions routed into the queue for the given media type(s) for an agent to answer | [optional] |
11
- | **completed** | **Integer** | The number of interactions completed | [optional] |
12
- | **answered** | **Integer** | The number of interactions answered by an agent in a given period | [optional] |
13
- | **abandoned** | **Integer** | The number of customers who disconnect before connecting with an agent | [optional] |
14
- | **average_talk_time_seconds** | **Float** | The average time in seconds an agent spends interacting with a customer per talk segment for a defined period of time | [optional] |
15
- | **average_after_call_work_seconds** | **Float** | The average time in seconds spent in after-call work. After-call work is the work that an agent performs immediately following an interaction | [optional] |
16
- | **service_level_percent** | **Float** | Percent of interactions answered in X seconds, where X is the service level objective configured in the service goal group matching this intraday group | [optional] |
17
- | **average_speed_of_answer_seconds** | **Float** | The average time in seconds it takes to answer an interaction once the interaction becomes available to be routed | [optional] |
18
- {: class="table table-striped"}
19
-
20
-
data/docs/IntradayMetric.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: IntradayMetric
3
- ---
4
- ## PureCloud::IntradayMetric
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **category** | **String** | The metric category | [optional] |
11
- | **version** | **String** | The current version id for this metric category | [optional] |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/IntradayPerformancePredictionAgentData.md DELETED
@@ -1,13 +0,0 @@
1
- ---
2
- title: IntradayPerformancePredictionAgentData
3
- ---
4
- ## PureCloud::IntradayPerformancePredictionAgentData
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **interacting_time_seconds** | **Float** | The total time spent interacting in seconds for all agents in this group | [optional] |
11
- {: class="table table-striped"}
12
-
13
-
data/docs/IntradayPerformancePredictionQueueData.md DELETED
@@ -1,15 +0,0 @@
1
- ---
2
- title: IntradayPerformancePredictionQueueData
3
- ---
4
- ## PureCloud::IntradayPerformancePredictionQueueData
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **service_level_percent** | **Float** | Predicted percent of interactions answered in X seconds, where X is the service level objective configured in the service goal group matching this intraday group | [optional] |
11
- | **average_speed_of_answer_seconds** | **Float** | Predicted average time in seconds it takes to answer an interaction once the interaction becomes available to be routed | [optional] |
12
- | **number_of_interactions** | **Float** | Predicted number of interactions | [optional] |
13
- {: class="table table-striped"}
14
-
15
-
data/docs/IntradayQueryDataCommand.md DELETED
@@ -1,17 +0,0 @@
1
- ---
2
- title: IntradayQueryDataCommand
3
- ---
4
- ## PureCloud::IntradayQueryDataCommand
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **start_date** | **DateTime** | Start date of the requested date range in ISO-8601 format | |
11
- | **end_date** | **DateTime** | End date of the requested date range in ISO-8601 format. Must be within the same 7 day schedule week as defined by the management unit's start day of week | |
12
- | **metrics** | [**Array<IntradayMetric>**](IntradayMetric.html) | The metrics to validate | |
13
- | **queue_ids** | **Array<String>** | The queue IDs for which to fetch data. Omitting or passing an empty list will return all available queues | [optional] |
14
- | **interval_length_minutes** | **Integer** | The period/interval for which to aggregate the data. Optional, defaults to 15 | [optional] |
15
- {: class="table table-striped"}
16
-
17
-
data/docs/IntradayQueue.md DELETED
@@ -1,15 +0,0 @@
1
- ---
2
- title: IntradayQueue
3
- ---
4
- ## PureCloud::IntradayQueue
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **id** | **String** | Queue ID | [optional] |
11
- | **name** | **String** | Queue name | [optional] |
12
- | **media_types** | **Array<String>** | The media types valid for this queue as defined by the service goal groups in this management unit | [optional] |
13
- {: class="table table-striped"}
14
-
15
-
data/docs/IntradayResponse.md DELETED
@@ -1,20 +0,0 @@
1
- ---
2
- title: IntradayResponse
3
- ---
4
- ## PureCloud::IntradayResponse
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **start_date** | **DateTime** | The start of the date range for which this data applies. This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
11
- | **end_date** | **DateTime** | The end of the date range for which this data applies. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
12
- | **interval_length_minutes** | **Integer** | The aggregation period in minutes, which determines the interval duration of the returned data | [optional] |
13
- | **number_of_intervals** | **Integer** | The total number of time intervals represented by this data | [optional] |
14
- | **metrics** | [**Array<IntradayMetric>**](IntradayMetric.html) | The metrics to which this data corresponds | [optional] |
15
- | **no_data_reason** | **String** | If not null, the reason there was no data for the request | [optional] |
16
- | **queue_ids** | **Array<String>** | The IDs of the queues this data corresponds to | [optional] |
17
- | **intraday_data_groupings** | [**Array<IntradayDataGroup>**](IntradayDataGroup.html) | Intraday data grouped by a single media type and set of queue IDs | [optional] |
18
- {: class="table table-striped"}
19
-
20
-
data/docs/IntradayScheduleData.md DELETED
@@ -1,14 +0,0 @@
1
- ---
2
- title: IntradayScheduleData
3
- ---
4
- ## PureCloud::IntradayScheduleData
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **on_queue_time_seconds** | **Integer** | The total scheduled on-queue time in seconds for all agents in this group | [optional] |
11
- | **scheduled_time_seconds** | **Integer** | The total scheduled time in seconds for all agents in this group | [optional] |
12
- {: class="table table-striped"}
13
-
14
-
data/docs/ListWrapperForecastSourceDayPointer.md DELETED
@@ -1,13 +0,0 @@
1
- ---
2
- title: ListWrapperForecastSourceDayPointer
3
- ---
4
- ## PureCloud::ListWrapperForecastSourceDayPointer
5
-
6
- ## Properties
7
-
8
- |Name | Type | Description | Notes|
9
- |------------ | ------------- | ------------- | -------------|
10
- | **values** | [**Array<ForecastSourceDayPointer>**](ForecastSourceDayPointer.html) | | [optional] |
11
- {: class="table table-striped"}
12
-
13
-