purecloudplatformclientv2 86.0.0 → 91.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +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,14 @@
|
|
1
|
+
---
|
2
|
+
title: CoachingAppointmentReference
|
3
|
+
---
|
4
|
+
## PureCloud::CoachingAppointmentReference
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
---
|
2
|
+
title: CoachingAppointmentResponse
|
3
|
+
---
|
4
|
+
## PureCloud::CoachingAppointmentResponse
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **name** | **String** | The name of coaching appointment | [optional] |
|
12
|
+
| **description** | **String** | The description of coaching appointment | [optional] |
|
13
|
+
| **date_start** | **DateTime** | The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
14
|
+
| **length_in_minutes** | **Integer** | The duration of coaching appointment in minutes | [optional] |
|
15
|
+
| **status** | **String** | The status of coaching appointment | [optional] |
|
16
|
+
| **facilitator** | [**UserReference**](UserReference.html) | The facilitator of coaching appointment | [optional] |
|
17
|
+
| **attendees** | [**Array<UserReference>**](UserReference.html) | The list of attendees attending the coaching | [optional] |
|
18
|
+
| **created_by** | [**UserReference**](UserReference.html) | The user who created the coaching appointment | [optional] |
|
19
|
+
| **date_created** | **DateTime** | The date/time the coaching appointment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
20
|
+
| **modified_by** | [**UserReference**](UserReference.html) | The last user to modify the coaching appointment | [optional] |
|
21
|
+
| **date_modified** | **DateTime** | The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
22
|
+
| **conversations** | [**Array<ConversationReference>**](ConversationReference.html) | The list of conversations associated with coaching appointment. | [optional] |
|
23
|
+
| **documents** | [**Array<DocumentReference>**](DocumentReference.html) | The list of documents associated with coaching appointment. | [optional] |
|
24
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
25
|
+
{: class="table table-striped"}
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
---
|
2
|
+
title: CoachingAppointmentResponseList
|
3
|
+
---
|
4
|
+
## PureCloud::CoachingAppointmentResponseList
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **entities** | [**Array<CoachingAppointmentResponse>**](CoachingAppointmentResponse.html) | | [optional] |
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
13
|
+
| **total** | **Integer** | | [optional] |
|
14
|
+
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
20
|
+
{: class="table table-striped"}
|
21
|
+
|
22
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: CoachingAppointmentStatusDto
|
3
|
+
---
|
4
|
+
## PureCloud::CoachingAppointmentStatusDto
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **appointment** | [**CoachingAppointmentReference**](CoachingAppointmentReference.html) | The coaching appointment this status belongs to | [optional] |
|
11
|
+
| **created_by** | [**UserReference**](UserReference.html) | User who updated the status | [optional] |
|
12
|
+
| **date_created** | **DateTime** | Creation time of the status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
13
|
+
| **status** | **String** | The status of the coaching appointment | |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: CoachingAppointmentStatusDtoList
|
3
|
+
---
|
4
|
+
## PureCloud::CoachingAppointmentStatusDtoList
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **entities** | [**Array<CoachingAppointmentStatusDto>**](CoachingAppointmentStatusDto.html) | | [optional] |
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
13
|
+
| **total** | **Integer** | | [optional] |
|
14
|
+
| **page_count** | **Integer** | | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
---
|
2
|
+
title: CoachingNotification
|
3
|
+
---
|
4
|
+
## PureCloud::CoachingNotification
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **name** | **String** | The name of the appointment for this notification. | [optional] |
|
12
|
+
| **marked_as_read** | **BOOLEAN** | Indicates if notification is read or unread | [optional] |
|
13
|
+
| **action_type** | **String** | Action causing the notification. | [optional] |
|
14
|
+
| **relationship** | **String** | The relationship of this user to this notification's appointment | [optional] |
|
15
|
+
| **date_start** | **DateTime** | The start time of the appointment relating to this notification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
16
|
+
| **length_in_minutes** | **Integer** | The duration of the appointment on this notification | [optional] |
|
17
|
+
| **status** | **String** | The status of the appointment for this notification | [optional] |
|
18
|
+
| **user** | [**UserReference**](UserReference.html) | The user of this notification | [optional] |
|
19
|
+
| **appointment** | [**CoachingAppointmentReference**](CoachingAppointmentReference.html) | The appointment | [optional] |
|
20
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
|
+
{: class="table table-striped"}
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
---
|
2
|
+
title: CoachingNotificationList
|
3
|
+
---
|
4
|
+
## PureCloud::CoachingNotificationList
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **entities** | [**Array<CoachingNotification>**](CoachingNotification.html) | | [optional] |
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
13
|
+
| **total** | **Integer** | | [optional] |
|
14
|
+
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
20
|
+
{: class="table table-striped"}
|
21
|
+
|
22
|
+
|
@@ -9,7 +9,7 @@ title: ConversationAggregationQuery
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
|
11
11
|
| **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
|
12
|
-
| **time_zone** | **String** |
|
12
|
+
| **time_zone** | **String** | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
|
13
13
|
| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
|
14
14
|
| **filter** | [**ConversationAggregateQueryFilter**](ConversationAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
|
15
15
|
| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
|
@@ -29,6 +29,7 @@ title: ConversationEventTopicCall
|
|
29
29
|
| **disconnect_reasons** | [**Array<ConversationEventTopicDisconnectReason>**](ConversationEventTopicDisconnectReason.html) | | [optional] |
|
30
30
|
| **fax_status** | [**ConversationEventTopicFaxStatus**](ConversationEventTopicFaxStatus.html) | | [optional] |
|
31
31
|
| **uui_data** | **String** | | [optional] |
|
32
|
+
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
32
33
|
| **additional_properties** | **Object** | | [optional] |
|
33
34
|
{: class="table table-striped"}
|
34
35
|
|
@@ -27,6 +27,7 @@ title: ConversationEventTopicCallback
|
|
27
27
|
| **disconnected_time** | **DateTime** | | [optional] |
|
28
28
|
| **callback_scheduled_time** | **DateTime** | | [optional] |
|
29
29
|
| **automated_callback_config_id** | **String** | | [optional] |
|
30
|
+
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
30
31
|
| **additional_properties** | **Object** | | [optional] |
|
31
32
|
{: class="table table-striped"}
|
32
33
|
|
@@ -20,6 +20,7 @@ title: ConversationEventTopicChat
|
|
20
20
|
| **connected_time** | **DateTime** | | [optional] |
|
21
21
|
| **disconnected_time** | **DateTime** | | [optional] |
|
22
22
|
| **journey_context** | [**ConversationEventTopicJourneyContext**](ConversationEventTopicJourneyContext.html) | | [optional] |
|
23
|
+
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
23
24
|
| **additional_properties** | **Object** | | [optional] |
|
24
25
|
{: class="table table-striped"}
|
25
26
|
|
@@ -22,6 +22,7 @@ title: ConversationEventTopicCobrowse
|
|
22
22
|
| **provider_event_time** | **DateTime** | | [optional] |
|
23
23
|
| **connected_time** | **DateTime** | | [optional] |
|
24
24
|
| **disconnected_time** | **DateTime** | | [optional] |
|
25
|
+
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
25
26
|
| **additional_properties** | **Object** | | [optional] |
|
26
27
|
{: class="table table-striped"}
|
27
28
|
|
@@ -25,6 +25,7 @@ title: ConversationEventTopicEmail
|
|
25
25
|
| **direction** | **String** | | [optional] |
|
26
26
|
| **draft_attachments** | [**Array<ConversationEventTopicAttachment>**](ConversationEventTopicAttachment.html) | | [optional] |
|
27
27
|
| **spam** | **BOOLEAN** | | [optional] |
|
28
|
+
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
28
29
|
| **additional_properties** | **Object** | | [optional] |
|
29
30
|
{: class="table table-striped"}
|
30
31
|
|
@@ -24,6 +24,7 @@ title: ConversationEventTopicMessage
|
|
24
24
|
| **type** | **String** | | [optional] |
|
25
25
|
| **recipient_country** | **String** | | [optional] |
|
26
26
|
| **recipient_type** | **String** | | [optional] |
|
27
|
+
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
27
28
|
| **additional_properties** | **Object** | | [optional] |
|
28
29
|
{: class="table table-striped"}
|
29
30
|
|
@@ -18,6 +18,7 @@ title: ConversationEventTopicScreenshare
|
|
18
18
|
| **disconnect_type** | **String** | | [optional] |
|
19
19
|
| **connected_time** | **DateTime** | | [optional] |
|
20
20
|
| **disconnected_time** | **DateTime** | | [optional] |
|
21
|
+
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
21
22
|
| **additional_properties** | **Object** | | [optional] |
|
22
23
|
{: class="table table-striped"}
|
23
24
|
|
@@ -22,6 +22,7 @@ title: ConversationEventTopicSocialExpression
|
|
22
22
|
| **start_hold_time** | **DateTime** | | [optional] |
|
23
23
|
| **connected_time** | **DateTime** | | [optional] |
|
24
24
|
| **disconnected_time** | **DateTime** | | [optional] |
|
25
|
+
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
25
26
|
| **additional_properties** | **Object** | | [optional] |
|
26
27
|
{: class="table table-striped"}
|
27
28
|
|
@@ -21,6 +21,7 @@ title: ConversationEventTopicVideo
|
|
21
21
|
| **connected_time** | **DateTime** | | [optional] |
|
22
22
|
| **disconnected_time** | **DateTime** | | [optional] |
|
23
23
|
| **msids** | **Array<String>** | | [optional] |
|
24
|
+
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
24
25
|
| **additional_properties** | **Object** | | [optional] |
|
25
26
|
{: class="table table-striped"}
|
26
27
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationReference
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationReference
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
---
|
2
|
+
title: CreateCoachingAppointmentRequest
|
3
|
+
---
|
4
|
+
## PureCloud::CreateCoachingAppointmentRequest
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **name** | **String** | The name of coaching appointment. | |
|
11
|
+
| **description** | **String** | The description of coaching appointment. | |
|
12
|
+
| **date_start** | **DateTime** | The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
13
|
+
| **length_in_minutes** | **Integer** | The duration of coaching appointment in minutes. | |
|
14
|
+
| **facilitator_id** | **String** | The facilitator ID of coaching appointment. | [optional] |
|
15
|
+
| **attendee_ids** | **Array<String>** | IDs of attendees in the coaching appointment. | |
|
16
|
+
| **conversation_ids** | **Array<String>** | IDs of conversations associated with this coaching appointment. | |
|
17
|
+
| **document_ids** | **Array<String>** | IDs of documents associated with this coaching appointment. | |
|
18
|
+
{: class="table table-striped"}
|
19
|
+
|
20
|
+
|
data/docs/CreateQueueRequest.md
CHANGED
@@ -17,6 +17,7 @@ title: CreateQueueRequest
|
|
17
17
|
| **created_by** | **String** | The ID of the user that created the queue. | [optional] |
|
18
18
|
| **member_count** | **Integer** | The number of users in the queue. | [optional] |
|
19
19
|
| **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM | [optional] |
|
20
|
+
| **routing_rules** | [**Array<RoutingRule>**](RoutingRule.html) | The routing rules for the queue, used for routing to known or preferred agents. | [optional] |
|
20
21
|
| **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
|
21
22
|
| **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | [optional] |
|
22
23
|
| **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | [optional] |
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: DocumentReference
|
3
|
+
---
|
4
|
+
## PureCloud::DocumentReference
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
data/docs/EntityListing.md
CHANGED
@@ -7,7 +7,11 @@ title: EntityListing
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **entities** | **Array<
|
10
|
+
| **entities** | [**Array<DataTableImportJob>**](DataTableImportJob.html) | | [optional] |
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
13
|
+
| **total** | **Integer** | | [optional] |
|
14
|
+
| **page_count** | **Integer** | | [optional] |
|
11
15
|
{: class="table table-striped"}
|
12
16
|
|
13
17
|
|
@@ -9,7 +9,7 @@ title: EvaluationAggregationQuery
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
|
11
11
|
| **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
|
12
|
-
| **time_zone** | **String** |
|
12
|
+
| **time_zone** | **String** | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
|
13
13
|
| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
|
14
14
|
| **filter** | [**EvaluationAggregateQueryFilter**](EvaluationAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
|
15
15
|
| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
|
data/docs/ExternalContact.md
CHANGED
@@ -30,6 +30,8 @@ title: ExternalContact
|
|
30
30
|
| **external_organization** | [**ExternalOrganization**](ExternalOrganization.html) | | [optional] |
|
31
31
|
| **survey_opt_out** | **BOOLEAN** | | [optional] |
|
32
32
|
| **external_system_url** | **String** | A string that identifies an external system-of-record resource that may have more detailed information on the contact. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace. | [optional] |
|
33
|
+
| **schema** | [**DataSchema**](DataSchema.html) | The schema defining custom fields for this contact | [optional] |
|
34
|
+
| **custom_fields** | **Hash<String, Object>** | Custom fields defined in the schema referenced by schemaId and schemaVersion. | [optional] |
|
33
35
|
| **external_data_sources** | [**Array<ExternalDataSource>**](ExternalDataSource.html) | Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. | [optional] |
|
34
36
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
35
37
|
{: class="table table-striped"}
|
@@ -25,6 +25,8 @@ title: ExternalOrganization
|
|
25
25
|
| **modify_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
26
26
|
| **create_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
27
27
|
| **trustor** | [**Trustor**](Trustor.html) | | [optional] |
|
28
|
+
| **schema** | [**DataSchema**](DataSchema.html) | The schema defining custom fields for this contact | [optional] |
|
29
|
+
| **custom_fields** | **Hash<String, Object>** | Custom fields defined in the schema referenced by schemaId and schemaVersion. | [optional] |
|
28
30
|
| **external_data_sources** | [**Array<ExternalDataSource>**](ExternalDataSource.html) | Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param. | [optional] |
|
29
31
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
30
32
|
{: class="table table-striped"}
|
@@ -9,7 +9,7 @@ title: FlowAggregationQuery
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
|
11
11
|
| **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
|
12
|
-
| **time_zone** | **String** |
|
12
|
+
| **time_zone** | **String** | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
|
13
13
|
| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
|
14
14
|
| **filter** | [**FlowAggregateQueryFilter**](FlowAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
|
15
15
|
| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
|
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: FlowExecutionLaunchRequest
|
3
|
+
---
|
4
|
+
## PureCloud::FlowExecutionLaunchRequest
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **flow_id** | **String** | ID of the flow to launch. | |
|
11
|
+
| **flow_version** | **String** | The version of the flow to launch. Omit this value (or supply null/empty) to use the latest published version. | [optional] |
|
12
|
+
| **input_data** | **Hash<String, Object>** | Input values to the flow. Valid values are defined by a flow's input JSON schema. | [optional] |
|
13
|
+
| **name** | **String** | A displayable name to assign to the new flow execution | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
---
|
2
|
+
title: FlowExecutionLaunchResponse
|
3
|
+
---
|
4
|
+
## PureCloud::FlowExecutionLaunchResponse
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The flow execution ID | [optional] |
|
11
|
+
| **name** | **String** | The flow execution name. | [optional] |
|
12
|
+
| **flow_version** | [**DomainEntityRef**](DomainEntityRef.html) | The version of the flow that launched | [optional] |
|
13
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
---
|
2
|
+
title: FlowRuntimeExecution
|
3
|
+
---
|
4
|
+
## PureCloud::FlowRuntimeExecution
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The flow execution ID | [optional] |
|
11
|
+
| **name** | **String** | The flow execution name. | [optional] |
|
12
|
+
| **flow_version** | [**FlowVersion**](FlowVersion.html) | The Version of the flow definition of the flow execution. | |
|
13
|
+
| **date_launched** | **DateTime** | The time the flow was launched. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
14
|
+
| **status** | **String** | The flow's running status, which indicates whether the flow is running normally or completed, etc. | |
|
15
|
+
| **date_completed** | **DateTime** | The time the flow completed, if applicable. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
16
|
+
| **completion_reason** | **String** | The completion reason set at the flow completion time, if applicable. | [optional] |
|
17
|
+
| **flow_error_info** | [**ErrorBody**](ErrorBody.html) | Additional information if the flow is in error | [optional] |
|
18
|
+
| **output_data** | **Hash<String, Object>** | List of the flow's output variables, if any. Output variables are only supplied for Completed flows. | [optional] |
|
19
|
+
| **conversation** | [**DomainEntityRef**](DomainEntityRef.html) | The conversation to which this Flow execution is related | [optional] |
|
20
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
|
+
{: class="table table-striped"}
|
22
|
+
|
23
|
+
|
data/docs/GenericSAML.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
---
|
2
|
+
title: GenericSAML
|
3
|
+
---
|
4
|
+
## PureCloud::GenericSAML
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **name** | **String** | | [optional] |
|
12
|
+
| **logo_image_data** | **String** | | [optional] |
|
13
|
+
| **relying_party_identifier** | **String** | | [optional] |
|
14
|
+
| **endpoint_compression** | **BOOLEAN** | | [optional] |
|
15
|
+
| **certificate** | **String** | | [optional] |
|
16
|
+
| **issuer_uri** | **String** | | [optional] |
|
17
|
+
| **sso_target_uri** | **String** | | [optional] |
|
18
|
+
| **disabled** | **BOOLEAN** | | [optional] |
|
19
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
20
|
+
{: class="table table-striped"}
|
21
|
+
|
22
|
+
|
data/docs/GroupsApi.md
CHANGED
@@ -425,11 +425,11 @@ Name | Type | Description | Notes
|
|
425
425
|
|
426
426
|
## [**GroupProfile**](GroupProfile.html) get_group_profile(group_id, opts)
|
427
427
|
|
428
|
-
|
428
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
429
429
|
|
430
430
|
Get group profile
|
431
431
|
|
432
|
-
|
432
|
+
This api is deprecated. Use /api/v2/groups instead
|
433
433
|
|
434
434
|
Wraps GET /api/v2/groups/{groupId}/profile
|
435
435
|
|
@@ -634,11 +634,11 @@ Name | Type | Description | Notes
|
|
634
634
|
|
635
635
|
## [**GroupProfileEntityListing**](GroupProfileEntityListing.html) get_profiles_groups(opts)
|
636
636
|
|
637
|
-
|
637
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
638
638
|
|
639
639
|
Get group profile listing
|
640
640
|
|
641
|
-
|
641
|
+
This api is deprecated. Use /api/v2/groups instead.
|
642
642
|
|
643
643
|
Wraps GET /api/v2/profiles/groups
|
644
644
|
|