purecloudplatformclientv2 87.0.0 → 92.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/AmazonLexRequest.md +14 -0
- 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 +130 -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/AuditRealtimeQueryRequest.md +18 -0
- data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
- data/docs/BuAgentScheduleActivity.md +2 -0
- data/docs/BuRescheduleRequest.md +2 -2
- data/docs/ButtonComponent.md +16 -0
- data/docs/CoachingApi.md +1 -1
- data/docs/ContentActions.md +17 -0
- data/docs/ContentAttachment.md +19 -0
- data/docs/ContentGeneric.md +19 -0
- data/docs/ContentList.md +19 -0
- data/docs/ContentLocation.md +17 -0
- data/docs/ContentNotificationTemplate.md +17 -0
- data/docs/ContentQuickReply.md +16 -0
- data/docs/ConversationAggregationQuery.md +1 -1
- data/docs/CreateQueueRequest.md +1 -0
- data/docs/EdgeGroup.md +1 -0
- data/docs/EntityListing.md +1 -5
- 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/GoogleDialogflowCustomSettings.md +13 -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/LanguageUnderstandingApi.md +164 -30
- data/docs/ListItemComponent.md +19 -0
- data/docs/MessageContent.md +19 -0
- data/docs/NluDomainVersion.md +3 -1
- data/docs/NotificationTemplateBody.md +14 -0
- data/docs/NotificationTemplateFooter.md +13 -0
- data/docs/NotificationTemplateHeader.md +16 -0
- data/docs/NotificationTemplateParameter.md +14 -0
- data/docs/OAuthApi.md +208 -0
- data/docs/OrganizationApi.md +126 -0
- data/docs/PostTextMessage.md +15 -0
- data/docs/PostTextRequest.md +23 -0
- data/docs/PostTextResponse.md +20 -0
- data/docs/Prompt.md +2 -2
- data/docs/Queue.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/SurveyForm.md +0 -2
- data/docs/TextbotsApi.md +78 -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/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 +45 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +129 -0
- data/lib/purecloudplatformclientv2/api/groups_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
- data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +189 -30
- 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/textbots_api.rb +92 -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/amazon_lex_request.rb +232 -0
- 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/audit_realtime_query_request.rb +360 -0
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -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/button_component.rb +281 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/coaching_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
- data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
- data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
- data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
- data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
- data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
- data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -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/create_queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +4 -104
- 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/google_dialogflow_custom_settings.rb +202 -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/list_item_component.rb +373 -0
- data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
- data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +72 -1
- data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
- data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
- data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
- data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
- data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
- data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
- data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
- 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_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/survey_form.rb +1 -53
- 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/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 +92 -2
data/docs/ViewFilter.md
CHANGED
@@ -85,6 +85,8 @@ title: ViewFilter
|
|
85
85
|
| **location_ids** | **Array<String>** | The location Ids used to filter the view | [optional] |
|
86
86
|
| **flow_out_types** | **Array<String>** | A list of flow out types | [optional] |
|
87
87
|
| **provider_list** | **Array<String>** | A list of providers | [optional] |
|
88
|
+
| **callback_number_list** | **Array<String>** | A list of callback numbers or substrings of numbers (ex: [\"317\", \"13172222222\"]) | [optional] |
|
89
|
+
| **callback_interval** | **String** | An interval of time to filter for scheduled callbacks. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
88
90
|
{: class="table table-striped"}
|
89
91
|
|
90
92
|
|
@@ -0,0 +1,13 @@
|
|
1
|
+
---
|
2
|
+
title: VoicemailMessagesTopicOwner
|
3
|
+
---
|
4
|
+
## PureCloud::VoicemailMessagesTopicOwner
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | | [optional] |
|
11
|
+
{: class="table table-striped"}
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: VoicemailMessagesTopicVoicemailCopyRecord
|
3
|
+
---
|
4
|
+
## PureCloud::VoicemailMessagesTopicVoicemailCopyRecord
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **user** | [**VoicemailMessagesTopicOwner**](VoicemailMessagesTopicOwner.html) | | [optional] |
|
11
|
+
| **group** | [**VoicemailMessagesTopicOwner**](VoicemailMessagesTopicOwner.html) | | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -19,6 +19,8 @@ title: VoicemailMessagesTopicVoicemailMessage
|
|
19
19
|
| **note** | **String** | | [optional] |
|
20
20
|
| **deleted** | **BOOLEAN** | | [optional] |
|
21
21
|
| **modified_by_user_id** | **String** | | [optional] |
|
22
|
+
| **copied_to** | [**Array<VoicemailMessagesTopicVoicemailCopyRecord>**](VoicemailMessagesTopicVoicemailCopyRecord.html) | | [optional] |
|
23
|
+
| **copied_from** | [**VoicemailMessagesTopicVoicemailCopyRecord**](VoicemailMessagesTopicVoicemailCopyRecord.html) | | [optional] |
|
22
24
|
{: class="table table-striped"}
|
23
25
|
|
24
26
|
|
@@ -0,0 +1,23 @@
|
|
1
|
+
---
|
2
|
+
title: WfmBuShortTermForecastImportCompleteTopicBuForecastModification
|
3
|
+
---
|
4
|
+
## PureCloud::WfmBuShortTermForecastImportCompleteTopicBuForecastModification
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **type** | **String** | | [optional] |
|
11
|
+
| **start_interval_index** | **Integer** | | [optional] |
|
12
|
+
| **end_interval_index** | **Integer** | | [optional] |
|
13
|
+
| **metric** | **String** | | [optional] |
|
14
|
+
| **legacy_metric** | **String** | | [optional] |
|
15
|
+
| **value** | **Float** | | [optional] |
|
16
|
+
| **values** | [**Array<WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue>**](WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.html) | | [optional] |
|
17
|
+
| **enabled** | **BOOLEAN** | | [optional] |
|
18
|
+
| **granularity** | **String** | | [optional] |
|
19
|
+
| **display_granularity** | **String** | | [optional] |
|
20
|
+
| **planning_group_ids** | **Array<String>** | | [optional] |
|
21
|
+
{: class="table table-striped"}
|
22
|
+
|
23
|
+
|
@@ -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
|
|
@@ -62,6 +62,7 @@ require 'purecloudplatformclientv2/models/aggregate_view_data'
|
|
62
62
|
require 'purecloudplatformclientv2/models/aggregation_range'
|
63
63
|
require 'purecloudplatformclientv2/models/aggregation_result'
|
64
64
|
require 'purecloudplatformclientv2/models/aggregation_result_entry'
|
65
|
+
require 'purecloudplatformclientv2/models/amazon_lex_request'
|
65
66
|
require 'purecloudplatformclientv2/models/analytics_conversation'
|
66
67
|
require 'purecloudplatformclientv2/models/analytics_conversation_async_query_response'
|
67
68
|
require 'purecloudplatformclientv2/models/analytics_conversation_query_response'
|
@@ -87,6 +88,9 @@ require 'purecloudplatformclientv2/models/analytics_user_details_query_response'
|
|
87
88
|
require 'purecloudplatformclientv2/models/analytics_user_presence_record'
|
88
89
|
require 'purecloudplatformclientv2/models/annotation'
|
89
90
|
require 'purecloudplatformclientv2/models/answer_option'
|
91
|
+
require 'purecloudplatformclientv2/models/api_usage_query'
|
92
|
+
require 'purecloudplatformclientv2/models/api_usage_query_result'
|
93
|
+
require 'purecloudplatformclientv2/models/api_usage_row'
|
90
94
|
require 'purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_client'
|
91
95
|
require 'purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_dependency_tracking_build_notification'
|
92
96
|
require 'purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_home_organization'
|
@@ -138,11 +142,17 @@ require 'purecloudplatformclientv2/models/audit_facet'
|
|
138
142
|
require 'purecloudplatformclientv2/models/audit_filter'
|
139
143
|
require 'purecloudplatformclientv2/models/audit_log_message'
|
140
144
|
require 'purecloudplatformclientv2/models/audit_message'
|
145
|
+
require 'purecloudplatformclientv2/models/audit_query_entity'
|
141
146
|
require 'purecloudplatformclientv2/models/audit_query_execution_results_response'
|
142
147
|
require 'purecloudplatformclientv2/models/audit_query_execution_status_response'
|
143
148
|
require 'purecloudplatformclientv2/models/audit_query_filter'
|
144
149
|
require 'purecloudplatformclientv2/models/audit_query_request'
|
145
150
|
require 'purecloudplatformclientv2/models/audit_query_response'
|
151
|
+
require 'purecloudplatformclientv2/models/audit_query_service'
|
152
|
+
require 'purecloudplatformclientv2/models/audit_query_service_mapping'
|
153
|
+
require 'purecloudplatformclientv2/models/audit_query_sort'
|
154
|
+
require 'purecloudplatformclientv2/models/audit_realtime_query_request'
|
155
|
+
require 'purecloudplatformclientv2/models/audit_realtime_query_results_response'
|
146
156
|
require 'purecloudplatformclientv2/models/audit_search_result'
|
147
157
|
require 'purecloudplatformclientv2/models/audit_user'
|
148
158
|
require 'purecloudplatformclientv2/models/authz_division'
|
@@ -231,6 +241,7 @@ require 'purecloudplatformclientv2/models/business_unit_list_item'
|
|
231
241
|
require 'purecloudplatformclientv2/models/business_unit_listing'
|
232
242
|
require 'purecloudplatformclientv2/models/business_unit_reference'
|
233
243
|
require 'purecloudplatformclientv2/models/business_unit_settings'
|
244
|
+
require 'purecloudplatformclientv2/models/button_component'
|
234
245
|
require 'purecloudplatformclientv2/models/calibration'
|
235
246
|
require 'purecloudplatformclientv2/models/calibration_assignment'
|
236
247
|
require 'purecloudplatformclientv2/models/calibration_create'
|
@@ -354,9 +365,14 @@ require 'purecloudplatformclientv2/models/contact_phone_number_column'
|
|
354
365
|
require 'purecloudplatformclientv2/models/contact_sort'
|
355
366
|
require 'purecloudplatformclientv2/models/contactlist_download_ready_export_uri'
|
356
367
|
require 'purecloudplatformclientv2/models/contactlist_import_status_import_status'
|
368
|
+
require 'purecloudplatformclientv2/models/content_actions'
|
369
|
+
require 'purecloudplatformclientv2/models/content_attachment'
|
357
370
|
require 'purecloudplatformclientv2/models/content_attribute_filter_item'
|
358
371
|
require 'purecloudplatformclientv2/models/content_facet_filter_item'
|
359
372
|
require 'purecloudplatformclientv2/models/content_filter_item'
|
373
|
+
require 'purecloudplatformclientv2/models/content_generic'
|
374
|
+
require 'purecloudplatformclientv2/models/content_list'
|
375
|
+
require 'purecloudplatformclientv2/models/content_location'
|
360
376
|
require 'purecloudplatformclientv2/models/content_management_single_document_topic_document_data_v2'
|
361
377
|
require 'purecloudplatformclientv2/models/content_management_single_document_topic_lock_data'
|
362
378
|
require 'purecloudplatformclientv2/models/content_management_single_document_topic_user_data'
|
@@ -365,7 +381,9 @@ require 'purecloudplatformclientv2/models/content_management_workspace_documents
|
|
365
381
|
require 'purecloudplatformclientv2/models/content_management_workspace_documents_topic_lock_data'
|
366
382
|
require 'purecloudplatformclientv2/models/content_management_workspace_documents_topic_user_data'
|
367
383
|
require 'purecloudplatformclientv2/models/content_management_workspace_documents_topic_workspace_data'
|
384
|
+
require 'purecloudplatformclientv2/models/content_notification_template'
|
368
385
|
require 'purecloudplatformclientv2/models/content_query_request'
|
386
|
+
require 'purecloudplatformclientv2/models/content_quick_reply'
|
369
387
|
require 'purecloudplatformclientv2/models/content_sort_item'
|
370
388
|
require 'purecloudplatformclientv2/models/context_entity'
|
371
389
|
require 'purecloudplatformclientv2/models/context_intent'
|
@@ -883,6 +901,8 @@ require 'purecloudplatformclientv2/models/flow_diagnostic_info'
|
|
883
901
|
require 'purecloudplatformclientv2/models/flow_division_view'
|
884
902
|
require 'purecloudplatformclientv2/models/flow_division_view_entity_listing'
|
885
903
|
require 'purecloudplatformclientv2/models/flow_entity_listing'
|
904
|
+
require 'purecloudplatformclientv2/models/flow_execution_launch_request'
|
905
|
+
require 'purecloudplatformclientv2/models/flow_execution_launch_response'
|
886
906
|
require 'purecloudplatformclientv2/models/flow_observation_data_container'
|
887
907
|
require 'purecloudplatformclientv2/models/flow_observation_query'
|
888
908
|
require 'purecloudplatformclientv2/models/flow_observation_query_clause'
|
@@ -891,6 +911,7 @@ require 'purecloudplatformclientv2/models/flow_observation_query_predicate'
|
|
891
911
|
require 'purecloudplatformclientv2/models/flow_observation_query_response'
|
892
912
|
require 'purecloudplatformclientv2/models/flow_outcome'
|
893
913
|
require 'purecloudplatformclientv2/models/flow_outcome_listing'
|
914
|
+
require 'purecloudplatformclientv2/models/flow_runtime_execution'
|
894
915
|
require 'purecloudplatformclientv2/models/flow_version'
|
895
916
|
require 'purecloudplatformclientv2/models/flow_version_entity_listing'
|
896
917
|
require 'purecloudplatformclientv2/models/forecast_abandon_rate_response'
|
@@ -913,9 +934,11 @@ require 'purecloudplatformclientv2/models/gkn_documentation_search_request'
|
|
913
934
|
require 'purecloudplatformclientv2/models/gkn_documentation_search_response'
|
914
935
|
require 'purecloudplatformclientv2/models/g_suite'
|
915
936
|
require 'purecloudplatformclientv2/models/generate_bu_forecast_request'
|
937
|
+
require 'purecloudplatformclientv2/models/generic_saml'
|
916
938
|
require 'purecloudplatformclientv2/models/geolocation'
|
917
939
|
require 'purecloudplatformclientv2/models/geolocation_event_geolocation'
|
918
940
|
require 'purecloudplatformclientv2/models/geolocation_settings'
|
941
|
+
require 'purecloudplatformclientv2/models/google_dialogflow_custom_settings'
|
919
942
|
require 'purecloudplatformclientv2/models/greeting'
|
920
943
|
require 'purecloudplatformclientv2/models/greeting_audio_file'
|
921
944
|
require 'purecloudplatformclientv2/models/greeting_listing'
|
@@ -973,6 +996,7 @@ require 'purecloudplatformclientv2/models/interaction_stats_rule'
|
|
973
996
|
require 'purecloudplatformclientv2/models/interaction_stats_rule_container'
|
974
997
|
require 'purecloudplatformclientv2/models/intraday_performance_prediction_data'
|
975
998
|
require 'purecloudplatformclientv2/models/intraday_planning_group_request'
|
999
|
+
require 'purecloudplatformclientv2/models/ip_address_authentication'
|
976
1000
|
require 'purecloudplatformclientv2/models/ip_address_range'
|
977
1001
|
require 'purecloudplatformclientv2/models/ip_address_range_listing'
|
978
1002
|
require 'purecloudplatformclientv2/models/item_validation_limits'
|
@@ -1037,6 +1061,7 @@ require 'purecloudplatformclientv2/models/line_integration_entity_listing'
|
|
1037
1061
|
require 'purecloudplatformclientv2/models/line_integration_request'
|
1038
1062
|
require 'purecloudplatformclientv2/models/line_status'
|
1039
1063
|
require 'purecloudplatformclientv2/models/line_user_id'
|
1064
|
+
require 'purecloudplatformclientv2/models/list_item_component'
|
1040
1065
|
require 'purecloudplatformclientv2/models/list_wrapper_interval'
|
1041
1066
|
require 'purecloudplatformclientv2/models/list_wrapper_shift_start_variance'
|
1042
1067
|
require 'purecloudplatformclientv2/models/local_encryption_configuration'
|
@@ -1080,6 +1105,7 @@ require 'purecloudplatformclientv2/models/media_transcription'
|
|
1080
1105
|
require 'purecloudplatformclientv2/models/media_utilization'
|
1081
1106
|
require 'purecloudplatformclientv2/models/member_entity'
|
1082
1107
|
require 'purecloudplatformclientv2/models/message'
|
1108
|
+
require 'purecloudplatformclientv2/models/message_content'
|
1083
1109
|
require 'purecloudplatformclientv2/models/message_conversation'
|
1084
1110
|
require 'purecloudplatformclientv2/models/message_conversation_entity_listing'
|
1085
1111
|
require 'purecloudplatformclientv2/models/message_data'
|
@@ -1139,6 +1165,10 @@ require 'purecloudplatformclientv2/models/nlu_utterance'
|
|
1139
1165
|
require 'purecloudplatformclientv2/models/nlu_utterance_segment'
|
1140
1166
|
require 'purecloudplatformclientv2/models/note'
|
1141
1167
|
require 'purecloudplatformclientv2/models/note_listing'
|
1168
|
+
require 'purecloudplatformclientv2/models/notification_template_body'
|
1169
|
+
require 'purecloudplatformclientv2/models/notification_template_footer'
|
1170
|
+
require 'purecloudplatformclientv2/models/notification_template_header'
|
1171
|
+
require 'purecloudplatformclientv2/models/notification_template_parameter'
|
1142
1172
|
require 'purecloudplatformclientv2/models/notifications_response'
|
1143
1173
|
require 'purecloudplatformclientv2/models/number'
|
1144
1174
|
require 'purecloudplatformclientv2/models/number_plan'
|
@@ -1224,6 +1254,9 @@ require 'purecloudplatformclientv2/models/policy_errors'
|
|
1224
1254
|
require 'purecloudplatformclientv2/models/post_action_input'
|
1225
1255
|
require 'purecloudplatformclientv2/models/post_input_contract'
|
1226
1256
|
require 'purecloudplatformclientv2/models/post_output_contract'
|
1257
|
+
require 'purecloudplatformclientv2/models/post_text_message'
|
1258
|
+
require 'purecloudplatformclientv2/models/post_text_request'
|
1259
|
+
require 'purecloudplatformclientv2/models/post_text_response'
|
1227
1260
|
require 'purecloudplatformclientv2/models/prediction_results'
|
1228
1261
|
require 'purecloudplatformclientv2/models/presence_definition'
|
1229
1262
|
require 'purecloudplatformclientv2/models/presence_detail_query_clause'
|
@@ -1793,6 +1826,7 @@ require 'purecloudplatformclientv2/models/update_user'
|
|
1793
1826
|
require 'purecloudplatformclientv2/models/upload_url_request'
|
1794
1827
|
require 'purecloudplatformclientv2/models/upload_url_response'
|
1795
1828
|
require 'purecloudplatformclientv2/models/usage'
|
1829
|
+
require 'purecloudplatformclientv2/models/usage_execution_result'
|
1796
1830
|
require 'purecloudplatformclientv2/models/usage_item'
|
1797
1831
|
require 'purecloudplatformclientv2/models/user'
|
1798
1832
|
require 'purecloudplatformclientv2/models/user_action_category'
|
@@ -1889,6 +1923,8 @@ require 'purecloudplatformclientv2/models/voicemail_mailbox_info'
|
|
1889
1923
|
require 'purecloudplatformclientv2/models/voicemail_media_info'
|
1890
1924
|
require 'purecloudplatformclientv2/models/voicemail_message'
|
1891
1925
|
require 'purecloudplatformclientv2/models/voicemail_message_entity_listing'
|
1926
|
+
require 'purecloudplatformclientv2/models/voicemail_messages_topic_owner'
|
1927
|
+
require 'purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record'
|
1892
1928
|
require 'purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message'
|
1893
1929
|
require 'purecloudplatformclientv2/models/voicemail_organization_policy'
|
1894
1930
|
require 'purecloudplatformclientv2/models/voicemail_retention_policy'
|
@@ -1960,6 +1996,13 @@ require 'purecloudplatformclientv2/models/wfm_bu_schedule_topic_local_date'
|
|
1960
1996
|
require 'purecloudplatformclientv2/models/wfm_bu_schedule_topic_management_unit'
|
1961
1997
|
require 'purecloudplatformclientv2/models/wfm_bu_schedule_topic_user_reference'
|
1962
1998
|
require 'purecloudplatformclientv2/models/wfm_bu_schedule_topic_wfm_versioned_entity_metadata'
|
1999
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification'
|
2000
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast'
|
2001
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification'
|
2002
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer'
|
2003
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value'
|
2004
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference'
|
2005
|
+
require 'purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata'
|
1963
2006
|
require 'purecloudplatformclientv2/models/wfm_bulk_shift_trade_state_update_notification_topic_bulk_shift_trade_state_update_notification'
|
1964
2007
|
require 'purecloudplatformclientv2/models/wfm_bulk_shift_trade_state_update_notification_topic_bulk_shift_trade_state_update_result'
|
1965
2008
|
require 'purecloudplatformclientv2/models/wfm_bulk_shift_trade_state_update_notification_topic_bulk_shift_trade_state_update_result_listing'
|
@@ -2083,8 +2126,10 @@ require 'purecloudplatformclientv2/api/stations_api'
|
|
2083
2126
|
require 'purecloudplatformclientv2/api/suggest_api'
|
2084
2127
|
require 'purecloudplatformclientv2/api/telephony_api'
|
2085
2128
|
require 'purecloudplatformclientv2/api/telephony_providers_edge_api'
|
2129
|
+
require 'purecloudplatformclientv2/api/textbots_api'
|
2086
2130
|
require 'purecloudplatformclientv2/api/tokens_api'
|
2087
2131
|
require 'purecloudplatformclientv2/api/uploads_api'
|
2132
|
+
require 'purecloudplatformclientv2/api/usage_api'
|
2088
2133
|
require 'purecloudplatformclientv2/api/user_recordings_api'
|
2089
2134
|
require 'purecloudplatformclientv2/api/users_api'
|
2090
2135
|
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
|