purecloudplatformclientv2 86.0.0 → 91.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/ApiUsageQuery.md +16 -0
- data/docs/ApiUsageQueryResult.md +14 -0
- data/docs/ApiUsageRow.md +25 -0
- data/docs/ArchitectApi.md +132 -0
- data/docs/AuditApi.md +60 -0
- data/docs/AuditQueryEntity.md +14 -0
- data/docs/AuditQueryExecutionStatusResponse.md +1 -0
- data/docs/AuditQueryRequest.md +1 -0
- data/docs/AuditQueryService.md +14 -0
- data/docs/AuditQueryServiceMapping.md +13 -0
- data/docs/AuditQuerySort.md +14 -0
- data/docs/BuAgentScheduleActivity.md +2 -0
- data/docs/BuRescheduleRequest.md +2 -2
- data/docs/CoachingAnnotation.md +21 -0
- data/docs/CoachingAnnotationCreateRequest.md +14 -0
- data/docs/CoachingAnnotationList.md +22 -0
- data/docs/CoachingApi.md +1132 -0
- data/docs/CoachingAppointmentReference.md +14 -0
- data/docs/CoachingAppointmentResponse.md +27 -0
- data/docs/CoachingAppointmentResponseList.md +22 -0
- data/docs/CoachingAppointmentStatusDto.md +16 -0
- data/docs/CoachingAppointmentStatusDtoList.md +17 -0
- data/docs/CoachingNotification.md +23 -0
- data/docs/CoachingNotificationList.md +22 -0
- data/docs/ConversationAggregationQuery.md +1 -1
- data/docs/ConversationEventTopicCall.md +1 -0
- data/docs/ConversationEventTopicCallback.md +1 -0
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationEventTopicCobrowse.md +1 -0
- data/docs/ConversationEventTopicEmail.md +1 -0
- data/docs/ConversationEventTopicMessage.md +1 -0
- data/docs/ConversationEventTopicScreenshare.md +1 -0
- data/docs/ConversationEventTopicSocialExpression.md +1 -0
- data/docs/ConversationEventTopicVideo.md +1 -0
- data/docs/ConversationReference.md +14 -0
- data/docs/CreateCoachingAppointmentRequest.md +20 -0
- data/docs/CreateQueueRequest.md +1 -0
- data/docs/DocumentReference.md +14 -0
- data/docs/EntityListing.md +5 -1
- data/docs/EvaluationAggregationQuery.md +1 -1
- data/docs/ExternalContact.md +2 -0
- data/docs/ExternalOrganization.md +2 -0
- data/docs/FlowAggregationQuery.md +1 -1
- data/docs/FlowExecutionLaunchRequest.md +16 -0
- data/docs/FlowExecutionLaunchResponse.md +16 -0
- data/docs/FlowRuntimeExecution.md +23 -0
- data/docs/GenericSAML.md +22 -0
- data/docs/GroupsApi.md +4 -4
- data/docs/IdentityProviderApi.md +187 -0
- data/docs/IpAddressAuthentication.md +13 -0
- data/docs/KnowledgeSearchResponse.md +1 -1
- data/docs/NluDomainVersion.md +1 -0
- data/docs/OAuthApi.md +208 -0
- data/docs/OrganizationApi.md +126 -0
- data/docs/Prompt.md +2 -2
- data/docs/Queue.md +1 -0
- data/docs/QueueConversationEventTopicCall.md +1 -0
- data/docs/QueueConversationEventTopicCallback.md +1 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationEventTopicEmail.md +1 -0
- data/docs/QueueConversationEventTopicMessage.md +1 -0
- data/docs/QueueConversationEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationEventTopicVideo.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
- data/docs/QueueConversationVideoEventTopicCall.md +1 -0
- data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
- data/docs/QueueConversationVideoEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
- data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
- data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
- data/docs/QueueRequest.md +1 -0
- data/docs/RecordingApi.md +12 -0
- data/docs/ReportingDataExportTopicDataExportNotification.md +1 -0
- data/docs/ScimEmail.md +1 -1
- data/docs/SurveyAggregationQuery.md +1 -1
- data/docs/UpdateCoachingAppointmentRequest.md +18 -0
- data/docs/UploadUrlRequest.md +1 -0
- data/docs/UsageApi.md +144 -0
- data/docs/UsageExecutionResult.md +14 -0
- data/docs/UserAggregationQuery.md +1 -1
- data/docs/UserQueue.md +1 -0
- data/docs/UsersApi.md +5 -5
- data/docs/ViewFilter.md +2 -0
- data/docs/VoicemailMessagesTopicOwner.md +13 -0
- data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +14 -0
- data/docs/VoicemailMessagesTopicVoicemailMessage.md +2 -0
- data/docs/WemLearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md +14 -0
- data/docs/WemLearningAssignmentRuleRunTopicLearningModuleReference.md +14 -0
- data/docs/WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated.md +13 -0
- data/docs/WemLearningAssignmentTopicLearningAssignmentNotification.md +22 -0
- data/docs/WemLearningAssignmentTopicLearningModuleReference.md +14 -0
- data/docs/WemLearningAssignmentTopicUserReference.md +13 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +23 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +24 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +15 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +17 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +14 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +13 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +15 -0
- data/docs/WorkforceManagementApi.md +3 -3
- data/lib/purecloudplatformclientv2.rb +44 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +55 -0
- data/lib/purecloudplatformclientv2/api/coaching_api.rb +1296 -0
- data/lib/purecloudplatformclientv2/api/groups_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
- data/lib/purecloudplatformclientv2/api/o_auth_api.rb +224 -0
- data/lib/purecloudplatformclientv2/api/organization_api.rb +120 -0
- data/lib/purecloudplatformclientv2/api/recording_api.rb +78 -0
- data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/api_usage_query.rb +303 -0
- data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb +244 -0
- data/lib/purecloudplatformclientv2/models/api_usage_row.rb +514 -0
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
- data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +244 -0
- data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +34 -6
- data/lib/purecloudplatformclientv2/models/audit_query_request.rb +34 -6
- data/lib/purecloudplatformclientv2/models/audit_query_service.rb +244 -0
- data/lib/purecloudplatformclientv2/models/audit_query_service_mapping.rb +204 -0
- data/lib/purecloudplatformclientv2/models/audit_query_sort.rb +266 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
- data/lib/purecloudplatformclientv2/models/bu_reschedule_request.rb +2 -12
- data/lib/purecloudplatformclientv2/models/coaching_annotation.rb +429 -0
- data/lib/purecloudplatformclientv2/models/coaching_annotation_create_request.rb +252 -0
- data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +587 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto.rb +299 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_status_dto_list.rb +303 -0
- data/lib/purecloudplatformclientv2/models/coaching_notification.rb +504 -0
- data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb +426 -0
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/document_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +104 -4
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
- data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/flow_execution_launch_request.rb +288 -0
- data/lib/purecloudplatformclientv2/models/flow_execution_launch_response.rb +281 -0
- data/lib/purecloudplatformclientv2/models/flow_runtime_execution.rb +494 -0
- data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
- data/lib/purecloudplatformclientv2/models/ip_address_authentication.rb +203 -0
- data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
- data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +41 -1
- data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset.rb +15 -1
- data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +15 -1
- data/lib/purecloudplatformclientv2/models/queue.rb +29 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
- data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +337 -0
- data/lib/purecloudplatformclientv2/models/upload_url_request.rb +43 -4
- data/lib/purecloudplatformclientv2/models/usage_execution_result.rb +228 -0
- data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
- data/lib/purecloudplatformclientv2/models/view_filter.rb +58 -4
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_assignment_rule_run_notification.rb +228 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_module_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_wem_learning_assignments_created.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_assignment_notification.rb +440 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_module_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +90 -2
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **week_date** | **String** | | [optional] |
|
|
12
|
+
| **creation_method** | **String** | | [optional] |
|
|
13
|
+
| **description** | **String** | | [optional] |
|
|
14
|
+
| **legacy** | **BOOLEAN** | | [optional] |
|
|
15
|
+
| **reference_start_date** | **DateTime** | | [optional] |
|
|
16
|
+
| **source_days** | [**Array<WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer>**](WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.html) | | [optional] |
|
|
17
|
+
| **modifications** | [**Array<WfmBuShortTermForecastImportCompleteTopicBuForecastModification>**](WfmBuShortTermForecastImportCompleteTopicBuForecastModification.html) | | [optional] |
|
|
18
|
+
| **time_zone** | **String** | | [optional] |
|
|
19
|
+
| **planning_groups_version** | **Integer** | | [optional] |
|
|
20
|
+
| **week_count** | **Integer** | | [optional] |
|
|
21
|
+
| **metadata** | [**WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata**](WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.html) | | [optional] |
|
|
22
|
+
{: class="table table-striped"}
|
|
23
|
+
|
|
24
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **status** | **String** | | [optional] |
|
|
11
|
+
| **result** | [**WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast**](WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.html) | | [optional] |
|
|
12
|
+
| **operation_id** | **String** | | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **day_of_week** | **String** | | [optional] |
|
|
11
|
+
| **weight** | **Integer** | | [optional] |
|
|
12
|
+
| **date** | **String** | | [optional] |
|
|
13
|
+
| **file_name** | **String** | | [optional] |
|
|
14
|
+
| **data_key** | **String** | | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **interval_index** | **Integer** | | [optional] |
|
|
11
|
+
| **value** | **Float** | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WfmBuShortTermForecastImportCompleteTopicUserReference
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::WfmBuShortTermForecastImportCompleteTopicUserReference
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **version** | **Integer** | | [optional] |
|
|
11
|
+
| **modified_by** | [**WfmBuShortTermForecastImportCompleteTopicUserReference**](WfmBuShortTermForecastImportCompleteTopicUserReference.html) | | [optional] |
|
|
12
|
+
| **date_modified** | **DateTime** | | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -1626,7 +1626,7 @@ end
|
|
|
1626
1626
|
Name | Type | Description | Notes
|
|
1627
1627
|
------------- | ------------- | ------------- | -------------
|
|
1628
1628
|
**business_unit_id** | **String**| The ID of the business unit, or 'mine' for the business unit of the logged-in user. | |
|
|
1629
|
-
**feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents,
|
|
1629
|
+
**feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlans |
|
|
1630
1630
|
**division_id** | **String**| | [optional] |
|
|
1631
1631
|
{: class="table table-striped"}
|
|
1632
1632
|
|
|
@@ -2836,7 +2836,7 @@ end
|
|
|
2836
2836
|
|
|
2837
2837
|
Name | Type | Description | Notes
|
|
2838
2838
|
------------- | ------------- | ------------- | -------------
|
|
2839
|
-
**feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents,
|
|
2839
|
+
**feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlans |
|
|
2840
2840
|
**division_id** | **String**| | [optional] |
|
|
2841
2841
|
{: class="table table-striped"}
|
|
2842
2842
|
|
|
@@ -4840,7 +4840,7 @@ Name | Type | Description | Notes
|
|
|
4840
4840
|
**page_size** | **Integer**| | [optional] |
|
|
4841
4841
|
**page_number** | **Integer**| | [optional] |
|
|
4842
4842
|
**expand** | **String**| | [optional] <br />**Values**: details |
|
|
4843
|
-
**feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents,
|
|
4843
|
+
**feature** | **String**| | [optional] <br />**Values**: AgentSchedule, AgentTimeOffRequest, ActivityCodes, Agents, BuActivityCodes, BusinessUnits, HistoricalAdherence, IntradayMonitoring, BuIntradayMonitoring, ManagementUnits, RealTimeAdherence, Schedules, BuSchedules, ServiceGoalGroups, ServiceGoalTemplates, PlanningGroups, ShiftTrading, ShortTermForecasts, BuShortTermForecasts, TimeOffRequests, WorkPlans |
|
|
4844
4844
|
**division_id** | **String**| | [optional] |
|
|
4845
4845
|
{: class="table table-striped"}
|
|
4846
4846
|
|
|
@@ -87,6 +87,9 @@ require 'purecloudplatformclientv2/models/analytics_user_details_query_response'
|
|
|
87
87
|
require 'purecloudplatformclientv2/models/analytics_user_presence_record'
|
|
88
88
|
require 'purecloudplatformclientv2/models/annotation'
|
|
89
89
|
require 'purecloudplatformclientv2/models/answer_option'
|
|
90
|
+
require 'purecloudplatformclientv2/models/api_usage_query'
|
|
91
|
+
require 'purecloudplatformclientv2/models/api_usage_query_result'
|
|
92
|
+
require 'purecloudplatformclientv2/models/api_usage_row'
|
|
90
93
|
require 'purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_client'
|
|
91
94
|
require 'purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_dependency_tracking_build_notification'
|
|
92
95
|
require 'purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_home_organization'
|
|
@@ -138,11 +141,15 @@ require 'purecloudplatformclientv2/models/audit_facet'
|
|
|
138
141
|
require 'purecloudplatformclientv2/models/audit_filter'
|
|
139
142
|
require 'purecloudplatformclientv2/models/audit_log_message'
|
|
140
143
|
require 'purecloudplatformclientv2/models/audit_message'
|
|
144
|
+
require 'purecloudplatformclientv2/models/audit_query_entity'
|
|
141
145
|
require 'purecloudplatformclientv2/models/audit_query_execution_results_response'
|
|
142
146
|
require 'purecloudplatformclientv2/models/audit_query_execution_status_response'
|
|
143
147
|
require 'purecloudplatformclientv2/models/audit_query_filter'
|
|
144
148
|
require 'purecloudplatformclientv2/models/audit_query_request'
|
|
145
149
|
require 'purecloudplatformclientv2/models/audit_query_response'
|
|
150
|
+
require 'purecloudplatformclientv2/models/audit_query_service'
|
|
151
|
+
require 'purecloudplatformclientv2/models/audit_query_service_mapping'
|
|
152
|
+
require 'purecloudplatformclientv2/models/audit_query_sort'
|
|
146
153
|
require 'purecloudplatformclientv2/models/audit_search_result'
|
|
147
154
|
require 'purecloudplatformclientv2/models/audit_user'
|
|
148
155
|
require 'purecloudplatformclientv2/models/authz_division'
|
|
@@ -311,6 +318,16 @@ require 'purecloudplatformclientv2/models/chat_message_user'
|
|
|
311
318
|
require 'purecloudplatformclientv2/models/client_app'
|
|
312
319
|
require 'purecloudplatformclientv2/models/client_app_configuration_info'
|
|
313
320
|
require 'purecloudplatformclientv2/models/client_app_entity_listing'
|
|
321
|
+
require 'purecloudplatformclientv2/models/coaching_annotation'
|
|
322
|
+
require 'purecloudplatformclientv2/models/coaching_annotation_create_request'
|
|
323
|
+
require 'purecloudplatformclientv2/models/coaching_annotation_list'
|
|
324
|
+
require 'purecloudplatformclientv2/models/coaching_appointment_reference'
|
|
325
|
+
require 'purecloudplatformclientv2/models/coaching_appointment_response'
|
|
326
|
+
require 'purecloudplatformclientv2/models/coaching_appointment_response_list'
|
|
327
|
+
require 'purecloudplatformclientv2/models/coaching_appointment_status_dto'
|
|
328
|
+
require 'purecloudplatformclientv2/models/coaching_appointment_status_dto_list'
|
|
329
|
+
require 'purecloudplatformclientv2/models/coaching_notification'
|
|
330
|
+
require 'purecloudplatformclientv2/models/coaching_notification_list'
|
|
314
331
|
require 'purecloudplatformclientv2/models/cobrowse_conversation'
|
|
315
332
|
require 'purecloudplatformclientv2/models/cobrowse_conversation_entity_listing'
|
|
316
333
|
require 'purecloudplatformclientv2/models/cobrowse_media_participant'
|
|
@@ -495,6 +512,7 @@ require 'purecloudplatformclientv2/models/conversation_message_event_topic_uri_r
|
|
|
495
512
|
require 'purecloudplatformclientv2/models/conversation_message_event_topic_wrapup'
|
|
496
513
|
require 'purecloudplatformclientv2/models/conversation_properties'
|
|
497
514
|
require 'purecloudplatformclientv2/models/conversation_query'
|
|
515
|
+
require 'purecloudplatformclientv2/models/conversation_reference'
|
|
498
516
|
require 'purecloudplatformclientv2/models/conversation_routing_data'
|
|
499
517
|
require 'purecloudplatformclientv2/models/conversation_screen_share_event_topic_conversation_routing_data'
|
|
500
518
|
require 'purecloudplatformclientv2/models/conversation_screen_share_event_topic_detail'
|
|
@@ -552,6 +570,7 @@ require 'purecloudplatformclientv2/models/create_call_response'
|
|
|
552
570
|
require 'purecloudplatformclientv2/models/create_callback_command'
|
|
553
571
|
require 'purecloudplatformclientv2/models/create_callback_on_conversation_command'
|
|
554
572
|
require 'purecloudplatformclientv2/models/create_callback_response'
|
|
573
|
+
require 'purecloudplatformclientv2/models/create_coaching_appointment_request'
|
|
555
574
|
require 'purecloudplatformclientv2/models/create_email_request'
|
|
556
575
|
require 'purecloudplatformclientv2/models/create_integration_request'
|
|
557
576
|
require 'purecloudplatformclientv2/models/create_management_unit_api_request'
|
|
@@ -696,6 +715,7 @@ require 'purecloudplatformclientv2/models/document_category_input'
|
|
|
696
715
|
require 'purecloudplatformclientv2/models/document_entity_listing'
|
|
697
716
|
require 'purecloudplatformclientv2/models/document_faq'
|
|
698
717
|
require 'purecloudplatformclientv2/models/document_listing'
|
|
718
|
+
require 'purecloudplatformclientv2/models/document_reference'
|
|
699
719
|
require 'purecloudplatformclientv2/models/document_thumbnail'
|
|
700
720
|
require 'purecloudplatformclientv2/models/document_update'
|
|
701
721
|
require 'purecloudplatformclientv2/models/document_upload'
|
|
@@ -870,6 +890,8 @@ require 'purecloudplatformclientv2/models/flow_diagnostic_info'
|
|
|
870
890
|
require 'purecloudplatformclientv2/models/flow_division_view'
|
|
871
891
|
require 'purecloudplatformclientv2/models/flow_division_view_entity_listing'
|
|
872
892
|
require 'purecloudplatformclientv2/models/flow_entity_listing'
|
|
893
|
+
require 'purecloudplatformclientv2/models/flow_execution_launch_request'
|
|
894
|
+
require 'purecloudplatformclientv2/models/flow_execution_launch_response'
|
|
873
895
|
require 'purecloudplatformclientv2/models/flow_observation_data_container'
|
|
874
896
|
require 'purecloudplatformclientv2/models/flow_observation_query'
|
|
875
897
|
require 'purecloudplatformclientv2/models/flow_observation_query_clause'
|
|
@@ -878,6 +900,7 @@ require 'purecloudplatformclientv2/models/flow_observation_query_predicate'
|
|
|
878
900
|
require 'purecloudplatformclientv2/models/flow_observation_query_response'
|
|
879
901
|
require 'purecloudplatformclientv2/models/flow_outcome'
|
|
880
902
|
require 'purecloudplatformclientv2/models/flow_outcome_listing'
|
|
903
|
+
require 'purecloudplatformclientv2/models/flow_runtime_execution'
|
|
881
904
|
require 'purecloudplatformclientv2/models/flow_version'
|
|
882
905
|
require 'purecloudplatformclientv2/models/flow_version_entity_listing'
|
|
883
906
|
require 'purecloudplatformclientv2/models/forecast_abandon_rate_response'
|
|
@@ -900,6 +923,7 @@ require 'purecloudplatformclientv2/models/gkn_documentation_search_request'
|
|
|
900
923
|
require 'purecloudplatformclientv2/models/gkn_documentation_search_response'
|
|
901
924
|
require 'purecloudplatformclientv2/models/g_suite'
|
|
902
925
|
require 'purecloudplatformclientv2/models/generate_bu_forecast_request'
|
|
926
|
+
require 'purecloudplatformclientv2/models/generic_saml'
|
|
903
927
|
require 'purecloudplatformclientv2/models/geolocation'
|
|
904
928
|
require 'purecloudplatformclientv2/models/geolocation_event_geolocation'
|
|
905
929
|
require 'purecloudplatformclientv2/models/geolocation_settings'
|
|
@@ -960,6 +984,7 @@ require 'purecloudplatformclientv2/models/interaction_stats_rule'
|
|
|
960
984
|
require 'purecloudplatformclientv2/models/interaction_stats_rule_container'
|
|
961
985
|
require 'purecloudplatformclientv2/models/intraday_performance_prediction_data'
|
|
962
986
|
require 'purecloudplatformclientv2/models/intraday_planning_group_request'
|
|
987
|
+
require 'purecloudplatformclientv2/models/ip_address_authentication'
|
|
963
988
|
require 'purecloudplatformclientv2/models/ip_address_range'
|
|
964
989
|
require 'purecloudplatformclientv2/models/ip_address_range_listing'
|
|
965
990
|
require 'purecloudplatformclientv2/models/item_validation_limits'
|
|
@@ -1767,6 +1792,7 @@ require 'purecloudplatformclientv2/models/update_action_input'
|
|
|
1767
1792
|
require 'purecloudplatformclientv2/models/update_activity_code_request'
|
|
1768
1793
|
require 'purecloudplatformclientv2/models/update_business_unit_request'
|
|
1769
1794
|
require 'purecloudplatformclientv2/models/update_business_unit_settings'
|
|
1795
|
+
require 'purecloudplatformclientv2/models/update_coaching_appointment_request'
|
|
1770
1796
|
require 'purecloudplatformclientv2/models/update_draft_input'
|
|
1771
1797
|
require 'purecloudplatformclientv2/models/update_management_unit_request'
|
|
1772
1798
|
require 'purecloudplatformclientv2/models/update_notification_response'
|
|
@@ -1779,6 +1805,7 @@ require 'purecloudplatformclientv2/models/update_user'
|
|
|
1779
1805
|
require 'purecloudplatformclientv2/models/upload_url_request'
|
|
1780
1806
|
require 'purecloudplatformclientv2/models/upload_url_response'
|
|
1781
1807
|
require 'purecloudplatformclientv2/models/usage'
|
|
1808
|
+
require 'purecloudplatformclientv2/models/usage_execution_result'
|
|
1782
1809
|
require 'purecloudplatformclientv2/models/usage_item'
|
|
1783
1810
|
require 'purecloudplatformclientv2/models/user'
|
|
1784
1811
|
require 'purecloudplatformclientv2/models/user_action_category'
|
|
@@ -1875,6 +1902,8 @@ require 'purecloudplatformclientv2/models/voicemail_mailbox_info'
|
|
|
1875
1902
|
require 'purecloudplatformclientv2/models/voicemail_media_info'
|
|
1876
1903
|
require 'purecloudplatformclientv2/models/voicemail_message'
|
|
1877
1904
|
require 'purecloudplatformclientv2/models/voicemail_message_entity_listing'
|
|
1905
|
+
require 'purecloudplatformclientv2/models/voicemail_messages_topic_owner'
|
|
1906
|
+
require 'purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record'
|
|
1878
1907
|
require 'purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message'
|
|
1879
1908
|
require 'purecloudplatformclientv2/models/voicemail_organization_policy'
|
|
1880
1909
|
require 'purecloudplatformclientv2/models/voicemail_retention_policy'
|
|
@@ -1908,6 +1937,12 @@ require 'purecloudplatformclientv2/models/wem_coaching_appointment_topic_coachin
|
|
|
1908
1937
|
require 'purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_document'
|
|
1909
1938
|
require 'purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification'
|
|
1910
1939
|
require 'purecloudplatformclientv2/models/wem_coaching_appointment_topic_user_reference'
|
|
1940
|
+
require 'purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_assignment_rule_run_notification'
|
|
1941
|
+
require 'purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_module_reference'
|
|
1942
|
+
require 'purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_wem_learning_assignments_created'
|
|
1943
|
+
require 'purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_assignment_notification'
|
|
1944
|
+
require 'purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_module_reference'
|
|
1945
|
+
require 'purecloudplatformclientv2/models/wem_learning_assignment_topic_user_reference'
|
|
1911
1946
|
require 'purecloudplatformclientv2/models/wfm_agent'
|
|
1912
1947
|
require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_topic_user_reference'
|
|
1913
1948
|
require 'purecloudplatformclientv2/models/wfm_agent_schedule_update_topic_wfm_agent_schedule_update'
|
|
@@ -1940,6 +1975,13 @@ require 'purecloudplatformclientv2/models/wfm_bu_schedule_topic_local_date'
|
|
|
1940
1975
|
require 'purecloudplatformclientv2/models/wfm_bu_schedule_topic_management_unit'
|
|
1941
1976
|
require 'purecloudplatformclientv2/models/wfm_bu_schedule_topic_user_reference'
|
|
1942
1977
|
require 'purecloudplatformclientv2/models/wfm_bu_schedule_topic_wfm_versioned_entity_metadata'
|
|
1978
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification'
|
|
1979
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast'
|
|
1980
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification'
|
|
1981
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer'
|
|
1982
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value'
|
|
1983
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference'
|
|
1984
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata'
|
|
1943
1985
|
require 'purecloudplatformclientv2/models/wfm_bulk_shift_trade_state_update_notification_topic_bulk_shift_trade_state_update_notification'
|
|
1944
1986
|
require 'purecloudplatformclientv2/models/wfm_bulk_shift_trade_state_update_notification_topic_bulk_shift_trade_state_update_result'
|
|
1945
1987
|
require 'purecloudplatformclientv2/models/wfm_bulk_shift_trade_state_update_notification_topic_bulk_shift_trade_state_update_result_listing'
|
|
@@ -2026,6 +2068,7 @@ require 'purecloudplatformclientv2/api/architect_api'
|
|
|
2026
2068
|
require 'purecloudplatformclientv2/api/audit_api'
|
|
2027
2069
|
require 'purecloudplatformclientv2/api/authorization_api'
|
|
2028
2070
|
require 'purecloudplatformclientv2/api/billing_api'
|
|
2071
|
+
require 'purecloudplatformclientv2/api/coaching_api'
|
|
2029
2072
|
require 'purecloudplatformclientv2/api/content_management_api'
|
|
2030
2073
|
require 'purecloudplatformclientv2/api/conversations_api'
|
|
2031
2074
|
require 'purecloudplatformclientv2/api/data_extensions_api'
|
|
@@ -2064,6 +2107,7 @@ require 'purecloudplatformclientv2/api/telephony_api'
|
|
|
2064
2107
|
require 'purecloudplatformclientv2/api/telephony_providers_edge_api'
|
|
2065
2108
|
require 'purecloudplatformclientv2/api/tokens_api'
|
|
2066
2109
|
require 'purecloudplatformclientv2/api/uploads_api'
|
|
2110
|
+
require 'purecloudplatformclientv2/api/usage_api'
|
|
2067
2111
|
require 'purecloudplatformclientv2/api/user_recordings_api'
|
|
2068
2112
|
require 'purecloudplatformclientv2/api/users_api'
|
|
2069
2113
|
require 'purecloudplatformclientv2/api/utilities_api'
|
|
@@ -4983,6 +4983,71 @@ module PureCloud
|
|
|
4983
4983
|
return data, status_code, headers
|
|
4984
4984
|
end
|
|
4985
4985
|
|
|
4986
|
+
# Get a flow execution's details. Flow execution details are available for several days after the flow is started.
|
|
4987
|
+
#
|
|
4988
|
+
# @param flow_execution_id flow execution ID
|
|
4989
|
+
# @param [Hash] opts the optional parameters
|
|
4990
|
+
# @return [FlowRuntimeExecution]
|
|
4991
|
+
def get_flows_execution(flow_execution_id, opts = {})
|
|
4992
|
+
data, _status_code, _headers = get_flows_execution_with_http_info(flow_execution_id, opts)
|
|
4993
|
+
return data
|
|
4994
|
+
end
|
|
4995
|
+
|
|
4996
|
+
# Get a flow execution's details. Flow execution details are available for several days after the flow is started.
|
|
4997
|
+
#
|
|
4998
|
+
# @param flow_execution_id flow execution ID
|
|
4999
|
+
# @param [Hash] opts the optional parameters
|
|
5000
|
+
# @return [Array<(FlowRuntimeExecution, Fixnum, Hash)>] FlowRuntimeExecution data, response status code and response headers
|
|
5001
|
+
def get_flows_execution_with_http_info(flow_execution_id, opts = {})
|
|
5002
|
+
if @api_client.config.debugging
|
|
5003
|
+
@api_client.config.logger.debug "Calling API: ArchitectApi.get_flows_execution ..."
|
|
5004
|
+
end
|
|
5005
|
+
|
|
5006
|
+
|
|
5007
|
+
# verify the required parameter 'flow_execution_id' is set
|
|
5008
|
+
fail ArgumentError, "Missing the required parameter 'flow_execution_id' when calling ArchitectApi.get_flows_execution" if flow_execution_id.nil?
|
|
5009
|
+
|
|
5010
|
+
|
|
5011
|
+
|
|
5012
|
+
|
|
5013
|
+
|
|
5014
|
+
# resource path
|
|
5015
|
+
local_var_path = "/api/v2/flows/executions/{flowExecutionId}".sub('{format}','json').sub('{' + 'flowExecutionId' + '}', flow_execution_id.to_s)
|
|
5016
|
+
|
|
5017
|
+
# query parameters
|
|
5018
|
+
query_params = {}
|
|
5019
|
+
|
|
5020
|
+
# header parameters
|
|
5021
|
+
header_params = {}
|
|
5022
|
+
|
|
5023
|
+
# HTTP header 'Accept' (if needed)
|
|
5024
|
+
local_header_accept = ['application/json']
|
|
5025
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
5026
|
+
|
|
5027
|
+
# HTTP header 'Content-Type'
|
|
5028
|
+
local_header_content_type = ['application/json']
|
|
5029
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
5030
|
+
|
|
5031
|
+
# form parameters
|
|
5032
|
+
form_params = {}
|
|
5033
|
+
|
|
5034
|
+
# http body (model)
|
|
5035
|
+
post_body = nil
|
|
5036
|
+
|
|
5037
|
+
auth_names = ['PureCloud OAuth']
|
|
5038
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
5039
|
+
:header_params => header_params,
|
|
5040
|
+
:query_params => query_params,
|
|
5041
|
+
:form_params => form_params,
|
|
5042
|
+
:body => post_body,
|
|
5043
|
+
:auth_names => auth_names,
|
|
5044
|
+
:return_type => 'FlowRuntimeExecution')
|
|
5045
|
+
if @api_client.config.debugging
|
|
5046
|
+
@api_client.config.logger.debug "API called: ArchitectApi#get_flows_execution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
5047
|
+
end
|
|
5048
|
+
return data, status_code, headers
|
|
5049
|
+
end
|
|
5050
|
+
|
|
4986
5051
|
# Get a flow outcome
|
|
4987
5052
|
# Returns a specified flow outcome
|
|
4988
5053
|
# @param flow_outcome_id flow outcome ID
|
|
@@ -6659,6 +6724,71 @@ module PureCloud
|
|
|
6659
6724
|
return data, status_code, headers
|
|
6660
6725
|
end
|
|
6661
6726
|
|
|
6727
|
+
# Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
|
|
6728
|
+
# The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.
|
|
6729
|
+
# @param flow_launch_request
|
|
6730
|
+
# @param [Hash] opts the optional parameters
|
|
6731
|
+
# @return [FlowExecutionLaunchResponse]
|
|
6732
|
+
def post_flows_executions(flow_launch_request, opts = {})
|
|
6733
|
+
data, _status_code, _headers = post_flows_executions_with_http_info(flow_launch_request, opts)
|
|
6734
|
+
return data
|
|
6735
|
+
end
|
|
6736
|
+
|
|
6737
|
+
# Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type.
|
|
6738
|
+
# The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.
|
|
6739
|
+
# @param flow_launch_request
|
|
6740
|
+
# @param [Hash] opts the optional parameters
|
|
6741
|
+
# @return [Array<(FlowExecutionLaunchResponse, Fixnum, Hash)>] FlowExecutionLaunchResponse data, response status code and response headers
|
|
6742
|
+
def post_flows_executions_with_http_info(flow_launch_request, opts = {})
|
|
6743
|
+
if @api_client.config.debugging
|
|
6744
|
+
@api_client.config.logger.debug "Calling API: ArchitectApi.post_flows_executions ..."
|
|
6745
|
+
end
|
|
6746
|
+
|
|
6747
|
+
|
|
6748
|
+
# verify the required parameter 'flow_launch_request' is set
|
|
6749
|
+
fail ArgumentError, "Missing the required parameter 'flow_launch_request' when calling ArchitectApi.post_flows_executions" if flow_launch_request.nil?
|
|
6750
|
+
|
|
6751
|
+
|
|
6752
|
+
|
|
6753
|
+
|
|
6754
|
+
|
|
6755
|
+
# resource path
|
|
6756
|
+
local_var_path = "/api/v2/flows/executions".sub('{format}','json')
|
|
6757
|
+
|
|
6758
|
+
# query parameters
|
|
6759
|
+
query_params = {}
|
|
6760
|
+
|
|
6761
|
+
# header parameters
|
|
6762
|
+
header_params = {}
|
|
6763
|
+
|
|
6764
|
+
# HTTP header 'Accept' (if needed)
|
|
6765
|
+
local_header_accept = ['application/json']
|
|
6766
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
6767
|
+
|
|
6768
|
+
# HTTP header 'Content-Type'
|
|
6769
|
+
local_header_content_type = ['application/json']
|
|
6770
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
6771
|
+
|
|
6772
|
+
# form parameters
|
|
6773
|
+
form_params = {}
|
|
6774
|
+
|
|
6775
|
+
# http body (model)
|
|
6776
|
+
post_body = @api_client.object_to_http_body(flow_launch_request)
|
|
6777
|
+
|
|
6778
|
+
auth_names = ['PureCloud OAuth']
|
|
6779
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
6780
|
+
:header_params => header_params,
|
|
6781
|
+
:query_params => query_params,
|
|
6782
|
+
:form_params => form_params,
|
|
6783
|
+
:body => post_body,
|
|
6784
|
+
:auth_names => auth_names,
|
|
6785
|
+
:return_type => 'FlowExecutionLaunchResponse')
|
|
6786
|
+
if @api_client.config.debugging
|
|
6787
|
+
@api_client.config.logger.debug "API called: ArchitectApi#post_flows_executions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
6788
|
+
end
|
|
6789
|
+
return data, status_code, headers
|
|
6790
|
+
end
|
|
6791
|
+
|
|
6662
6792
|
# Create a flow outcome
|
|
6663
6793
|
# Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId}
|
|
6664
6794
|
# @param [Hash] opts the optional parameters
|
|
@@ -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_servicemapping(opts = {})
|
|
32
|
+
data, _status_code, _headers = get_audits_query_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_servicemapping_with_http_info(opts = {})
|
|
41
|
+
if @api_client.config.debugging
|
|
42
|
+
@api_client.config.logger.debug "Calling API: AuditApi.get_audits_query_servicemapping ..."
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = "/api/v2/audits/query/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_servicemapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
78
|
+
end
|
|
79
|
+
return data, status_code, headers
|
|
80
|
+
end
|
|
81
|
+
|
|
27
82
|
# Get status of audit query execution
|
|
28
83
|
#
|
|
29
84
|
# @param transaction_id Transaction ID
|