purecloudplatformclientv2 92.0.0 → 93.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 +2 -2
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/AnalyticsSession.md +4 -0
- data/docs/ArchitectApi.md +51 -49
- data/docs/CoachingApi.md +8 -7
- data/docs/CommonCampaign.md +17 -0
- data/docs/CommonCampaignDivisionView.md +17 -0
- data/docs/CommonCampaignDivisionViewEntityListing.md +22 -0
- data/docs/CommonCampaignEntityListing.md +22 -0
- data/docs/ConversationAssociation.md +1 -1
- data/docs/ConversationEventTopicMessage.md +1 -0
- data/docs/ConversationsApi.md +4 -4
- data/docs/ExternalContactsApi.md +4 -4
- data/docs/HistoricalAdherenceActuals.md +15 -0
- data/docs/HistoricalAdherenceDayMetrics.md +23 -0
- data/docs/HistoricalAdherenceExceptionInfo.md +21 -0
- data/docs/HistoricalAdherenceQueryResult.md +21 -0
- data/docs/KnowledgeSearchRequest.md +3 -3
- data/docs/MessagingCampaign.md +28 -0
- data/docs/MessagingCampaignDivisionView.md +16 -0
- data/docs/MessagingCampaignDivisionViewEntityListing.md +22 -0
- data/docs/MessagingCampaignEntityListing.md +22 -0
- data/docs/ObservationValue.md +3 -1
- data/docs/OutboundApi.md +881 -76
- data/docs/QueueConversationEventTopicMessage.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
- data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
- data/docs/ReportingExportJobRequest.md +2 -0
- data/docs/ReportingExportJobResponse.md +3 -0
- data/docs/SCIMApi.md +96 -108
- data/docs/ScimConfigResourceType.md +1 -1
- data/docs/ScimUserExtensions.md +2 -2
- data/docs/ScimUserRole.md +1 -1
- data/docs/ScimUserRoutingLanguage.md +2 -2
- data/docs/ScimUserRoutingSkill.md +2 -2
- data/docs/ScimV2CreateUser.md +3 -3
- data/docs/ScimV2Group.md +1 -1
- data/docs/ScimV2SchemaAttribute.md +11 -11
- data/docs/ScimV2SchemaDefinition.md +4 -4
- data/docs/ScimV2SchemaListResponse.md +1 -1
- data/docs/ScimV2User.md +4 -4
- data/docs/SmsConfig.md +15 -0
- data/docs/SmsPhoneNumberRef.md +14 -0
- data/docs/UserRoutingLanguage.md +3 -3
- data/docs/UserRoutingLanguagePost.md +1 -1
- data/docs/UserRoutingSkill.md +1 -1
- data/docs/VoicemailUserPolicy.md +1 -0
- data/docs/WfmBusinessUnitReference.md +14 -0
- data/docs/WfmHistoricalAdherenceResponse.md +1 -0
- data/docs/WfmHistoricalAdherenceResultWrapper.md +15 -0
- data/docs/WfmHistoricalDataUploadRequestStatusTopicDateTime.md +16 -0
- data/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md +20 -0
- data/docs/WfmScheduleReference.md +16 -0
- data/lib/purecloudplatformclientv2.rb +19 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -6
- data/lib/purecloudplatformclientv2/api/coaching_api.rb +10 -9
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +1215 -155
- data/lib/purecloudplatformclientv2/api/scim_api.rb +88 -88
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +124 -4
- data/lib/purecloudplatformclientv2/models/common_campaign.rb +320 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_division_view.rb +320 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_association.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/historical_adherence_actuals.rb +268 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb +462 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb +466 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb +430 -0
- data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +0 -15
- data/lib/purecloudplatformclientv2/models/messaging_campaign.rb +621 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view.rb +279 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/observation_value.rb +70 -2
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +53 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +78 -1
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_user_role.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +5 -5
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +4 -3
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/sms_config.rb +269 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_ref.rb +232 -0
- data/lib/purecloudplatformclientv2/models/user_routing_language.rb +4 -4
- data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +1 -1
- data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +30 -4
- data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +4 -4
- data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper.rb +258 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time.rb +276 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update.rb +390 -0
- data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +280 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +41 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dc87d022da76d4f1ffbd8840cedd23d72d180c0d
|
4
|
+
data.tar.gz: bde4e44867c8c2800ef18a111ce017d92c61877f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 66c0c83208a7af22553f3b6ce41ba2b4db13d25193cc68a887d76d324c1ad176f5be3cbe4e0e9e5cb4e637f7cea52238df463362940759ae2bbbd6b82e046cf8
|
7
|
+
data.tar.gz: 4520d8aababcbdb0a068613d2ddcb2a49169505097633c78b40a8ca7a53e404779cad117588caf6710d0a7b23e3890ff18155fe1d2373d6856efe64601728295
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
title: Platform API Client SDK - Ruby
|
3
3
|
---
|
4
|
-
![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=
|
4
|
+
![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=93.0.0)
|
5
5
|
|
6
6
|
Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
|
7
7
|
|
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
|
|
10
10
|
### from rubygems.org
|
11
11
|
|
12
12
|
```{"language":"ruby"}
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 93.0.0'
|
14
14
|
```
|
15
15
|
|
16
16
|
### Install from Git
|
data/docs/AnalyticsEvaluation.md
CHANGED
@@ -18,8 +18,8 @@ title: AnalyticsEvaluation
|
|
18
18
|
| **calibration_id** | **String** | The calibration id used for the purpose of training evaluators | [optional] |
|
19
19
|
| **rescored** | **BOOLEAN** | Whether this evaluation has ever been rescored | [optional] |
|
20
20
|
| **deleted** | **BOOLEAN** | Whether this evaluation has been deleted | [optional] |
|
21
|
-
| **o_total_critical_score** | **Integer** | | [optional] |
|
22
21
|
| **o_total_score** | **Integer** | | [optional] |
|
22
|
+
| **o_total_critical_score** | **Integer** | | [optional] |
|
23
23
|
{: class="table table-striped"}
|
24
24
|
|
25
25
|
|
data/docs/AnalyticsSession.md
CHANGED
@@ -60,6 +60,10 @@ title: AnalyticsSession
|
|
60
60
|
| **remote** | **String** | Name, phone number, or email address of the remote party. | [optional] |
|
61
61
|
| **media_count** | **Integer** | Count of any media (images, files, etc) included in this session | [optional] |
|
62
62
|
| **flow_out_type** | **String** | Type of flow out that occurred, e.g. voicemail, callback, or acd | [optional] |
|
63
|
+
| **requested_routings** | **Array<String>** | All routing types for requested/attempted routing methods. | [optional] |
|
64
|
+
| **used_routing** | **String** | Complete routing method | [optional] |
|
65
|
+
| **selected_agent_id** | **String** | Selected agent id | [optional] |
|
66
|
+
| **selected_agent_rank** | **Integer** | Selected agent GPR rank | [optional] |
|
63
67
|
{: class="table table-striped"}
|
64
68
|
|
65
69
|
|
data/docs/ArchitectApi.md
CHANGED
@@ -243,7 +243,7 @@ Delete specified user prompt
|
|
243
243
|
|
244
244
|
Wraps DELETE /api/v2/architect/prompts/{promptId}
|
245
245
|
|
246
|
-
Requires
|
246
|
+
Requires ALL permissions:
|
247
247
|
|
248
248
|
* architect:userPrompt:delete
|
249
249
|
|
@@ -311,7 +311,7 @@ Delete specified user prompt resource
|
|
311
311
|
|
312
312
|
Wraps DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}
|
313
313
|
|
314
|
-
Requires
|
314
|
+
Requires ALL permissions:
|
315
315
|
|
316
316
|
* architect:userPrompt:edit
|
317
317
|
|
@@ -378,7 +378,7 @@ Delete specified user prompt resource audio
|
|
378
378
|
|
379
379
|
Wraps DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio
|
380
380
|
|
381
|
-
Requires
|
381
|
+
Requires ALL permissions:
|
382
382
|
|
383
383
|
* architect:userPrompt:edit
|
384
384
|
|
@@ -445,7 +445,7 @@ Multiple IDs can be specified, in which case all specified prompts will be delet
|
|
445
445
|
|
446
446
|
Wraps DELETE /api/v2/architect/prompts
|
447
447
|
|
448
|
-
Requires
|
448
|
+
Requires ALL permissions:
|
449
449
|
|
450
450
|
* architect:userPrompt:delete
|
451
451
|
|
@@ -638,7 +638,7 @@ Delete a system prompt resource override.
|
|
638
638
|
|
639
639
|
Wraps DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
|
640
640
|
|
641
|
-
Requires
|
641
|
+
Requires ALL permissions:
|
642
642
|
|
643
643
|
* architect:systemPrompt:edit
|
644
644
|
|
@@ -969,7 +969,7 @@ Get Dependency Tracking objects that have a given display name
|
|
969
969
|
|
970
970
|
Wraps GET /api/v2/architect/dependencytracking
|
971
971
|
|
972
|
-
Requires
|
972
|
+
Requires ALL permissions:
|
973
973
|
|
974
974
|
* architect:dependencyTracking:view
|
975
975
|
|
@@ -1019,11 +1019,11 @@ Name | Type | Description | Notes
|
|
1019
1019
|
**name** | **String**| Object name to search for | |
|
1020
1020
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1021
1021
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1022
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1022
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1023
1023
|
**consumed_resources** | **BOOLEAN**| Include resources each result item consumes | [optional] |
|
1024
1024
|
**consuming_resources** | **BOOLEAN**| Include resources that consume each result item | [optional] |
|
1025
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1026
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1025
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1026
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1027
1027
|
{: class="table table-striped"}
|
1028
1028
|
|
1029
1029
|
|
@@ -1050,7 +1050,7 @@ Get Dependency Tracking build status for an organization
|
|
1050
1050
|
|
1051
1051
|
Wraps GET /api/v2/architect/dependencytracking/build
|
1052
1052
|
|
1053
|
-
Requires
|
1053
|
+
Requires ALL permissions:
|
1054
1054
|
|
1055
1055
|
* architect:dependencyTracking:view
|
1056
1056
|
|
@@ -1109,7 +1109,7 @@ Get resources that are consumed by a given Dependency Tracking object
|
|
1109
1109
|
|
1110
1110
|
Wraps GET /api/v2/architect/dependencytracking/consumedresources
|
1111
1111
|
|
1112
|
-
Requires
|
1112
|
+
Requires ALL permissions:
|
1113
1113
|
|
1114
1114
|
* architect:dependencyTracking:view
|
1115
1115
|
|
@@ -1158,8 +1158,8 @@ Name | Type | Description | Notes
|
|
1158
1158
|
------------- | ------------- | ------------- | -------------
|
1159
1159
|
**id** | **String**| Consuming object ID | |
|
1160
1160
|
**version** | **String**| Consuming object version | |
|
1161
|
-
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1162
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1161
|
+
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1162
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1163
1163
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1164
1164
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1165
1165
|
{: class="table table-striped"}
|
@@ -1188,7 +1188,7 @@ Get resources that consume a given Dependency Tracking object
|
|
1188
1188
|
|
1189
1189
|
Wraps GET /api/v2/architect/dependencytracking/consumingresources
|
1190
1190
|
|
1191
|
-
Requires
|
1191
|
+
Requires ALL permissions:
|
1192
1192
|
|
1193
1193
|
* architect:dependencyTracking:view
|
1194
1194
|
|
@@ -1236,8 +1236,8 @@ end
|
|
1236
1236
|
Name | Type | Description | Notes
|
1237
1237
|
------------- | ------------- | ------------- | -------------
|
1238
1238
|
**id** | **String**| Consumed object ID | |
|
1239
|
-
**object_type** | **String**| Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1240
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1239
|
+
**object_type** | **String**| Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1240
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1241
1241
|
**version** | **String**| Object version | [optional] |
|
1242
1242
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1243
1243
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
@@ -1268,7 +1268,7 @@ Get Dependency Tracking objects that consume deleted resources
|
|
1268
1268
|
|
1269
1269
|
Wraps GET /api/v2/architect/dependencytracking/deletedresourceconsumers
|
1270
1270
|
|
1271
|
-
Requires
|
1271
|
+
Requires ALL permissions:
|
1272
1272
|
|
1273
1273
|
* architect:dependencyTracking:view
|
1274
1274
|
|
@@ -1314,10 +1314,10 @@ end
|
|
1314
1314
|
Name | Type | Description | Notes
|
1315
1315
|
------------- | ------------- | ------------- | -------------
|
1316
1316
|
**name** | **String**| Name to search for | [optional] |
|
1317
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1317
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1318
1318
|
**flow_filter** | **String**| Show only checkedIn or published flows | [optional] <br />**Values**: checkedIn, published |
|
1319
1319
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
1320
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1320
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1321
1321
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1322
1322
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1323
1323
|
{: class="table table-striped"}
|
@@ -1346,7 +1346,7 @@ Get a Dependency Tracking object
|
|
1346
1346
|
|
1347
1347
|
Wraps GET /api/v2/architect/dependencytracking/object
|
1348
1348
|
|
1349
|
-
Requires
|
1349
|
+
Requires ALL permissions:
|
1350
1350
|
|
1351
1351
|
* architect:dependencyTracking:view
|
1352
1352
|
|
@@ -1395,11 +1395,11 @@ Name | Type | Description | Notes
|
|
1395
1395
|
------------- | ------------- | ------------- | -------------
|
1396
1396
|
**id** | **String**| Object ID | |
|
1397
1397
|
**version** | **String**| Object version | [optional] |
|
1398
|
-
**object_type** | **String**| Object type | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1398
|
+
**object_type** | **String**| Object type | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1399
1399
|
**consumed_resources** | **BOOLEAN**| Include resources this item consumes | [optional] |
|
1400
1400
|
**consuming_resources** | **BOOLEAN**| Include resources that consume this item | [optional] |
|
1401
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1402
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1401
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1402
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1403
1403
|
**consumed_resource_request** | **BOOLEAN**| Indicate that this is going to look up a consumed resource object | [optional] |
|
1404
1404
|
{: class="table table-striped"}
|
1405
1405
|
|
@@ -1427,7 +1427,7 @@ Get a Dependency Tracking type.
|
|
1427
1427
|
|
1428
1428
|
Wraps GET /api/v2/architect/dependencytracking/types/{typeId}
|
1429
1429
|
|
1430
|
-
Requires
|
1430
|
+
Requires ALL permissions:
|
1431
1431
|
|
1432
1432
|
* architect:dependencyTracking:view
|
1433
1433
|
|
@@ -1492,7 +1492,7 @@ Get Dependency Tracking types.
|
|
1492
1492
|
|
1493
1493
|
Wraps GET /api/v2/architect/dependencytracking/types
|
1494
1494
|
|
1495
|
-
Requires
|
1495
|
+
Requires ALL permissions:
|
1496
1496
|
|
1497
1497
|
* architect:dependencyTracking:view
|
1498
1498
|
|
@@ -1560,7 +1560,7 @@ Get Dependency Tracking objects that depend on updated resources
|
|
1560
1560
|
|
1561
1561
|
Wraps GET /api/v2/architect/dependencytracking/updatedresourceconsumers
|
1562
1562
|
|
1563
|
-
Requires
|
1563
|
+
Requires ALL permissions:
|
1564
1564
|
|
1565
1565
|
* architect:dependencyTracking:view
|
1566
1566
|
|
@@ -1605,9 +1605,9 @@ end
|
|
1605
1605
|
Name | Type | Description | Notes
|
1606
1606
|
------------- | ------------- | ------------- | -------------
|
1607
1607
|
**name** | **String**| Name to search for | [optional] |
|
1608
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1608
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1609
1609
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
1610
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1610
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW |
|
1611
1611
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1612
1612
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1613
1613
|
{: class="table table-striped"}
|
@@ -1914,7 +1914,7 @@ Get specified user prompt
|
|
1914
1914
|
|
1915
1915
|
Wraps GET /api/v2/architect/prompts/{promptId}
|
1916
1916
|
|
1917
|
-
Requires
|
1917
|
+
Requires ALL permissions:
|
1918
1918
|
|
1919
1919
|
* architect:userPrompt:view
|
1920
1920
|
|
@@ -1979,7 +1979,7 @@ Get generated prompt history
|
|
1979
1979
|
|
1980
1980
|
Wraps GET /api/v2/architect/prompts/{promptId}/history/{historyId}
|
1981
1981
|
|
1982
|
-
Requires
|
1982
|
+
Requires ALL permissions:
|
1983
1983
|
|
1984
1984
|
* architect:userPrompt:view
|
1985
1985
|
|
@@ -2059,7 +2059,7 @@ Get specified user prompt resource
|
|
2059
2059
|
|
2060
2060
|
Wraps GET /api/v2/architect/prompts/{promptId}/resources/{languageCode}
|
2061
2061
|
|
2062
|
-
Requires
|
2062
|
+
Requires ALL permissions:
|
2063
2063
|
|
2064
2064
|
* architect:userPrompt:view
|
2065
2065
|
|
@@ -2127,7 +2127,7 @@ The returned list is pageable, and query parameters can be used for filtering.
|
|
2127
2127
|
|
2128
2128
|
Wraps GET /api/v2/architect/prompts/{promptId}/resources
|
2129
2129
|
|
2130
|
-
Requires
|
2130
|
+
Requires ALL permissions:
|
2131
2131
|
|
2132
2132
|
* architect:userPrompt:view
|
2133
2133
|
|
@@ -2198,7 +2198,7 @@ The returned list is pageable, and query parameters can be used for filtering.
|
|
2198
2198
|
|
2199
2199
|
Wraps GET /api/v2/architect/prompts
|
2200
2200
|
|
2201
|
-
Requires
|
2201
|
+
Requires ALL permissions:
|
2202
2202
|
|
2203
2203
|
* architect:userPrompt:view
|
2204
2204
|
|
@@ -2433,7 +2433,8 @@ opts = {
|
|
2433
2433
|
page_size: 25, # Integer | Page size
|
2434
2434
|
sort_by: "name", # String | Sort by
|
2435
2435
|
sort_order: "ASC", # String | Sort order
|
2436
|
-
name: "name_example" # String | Name of the Schedule Group to filter by.
|
2436
|
+
name: "name_example", # String | Name of the Schedule Group to filter by.
|
2437
|
+
schedule_ids: "schedule_ids_example" # String | A comma-delimited list of Schedule IDs to filter by.
|
2437
2438
|
}
|
2438
2439
|
|
2439
2440
|
begin
|
@@ -2454,6 +2455,7 @@ Name | Type | Description | Notes
|
|
2454
2455
|
**sort_by** | **String**| Sort by | [optional] [default to name] |
|
2455
2456
|
**sort_order** | **String**| Sort order | [optional] [default to ASC] |
|
2456
2457
|
**name** | **String**| Name of the Schedule Group to filter by. | [optional] |
|
2458
|
+
**schedule_ids** | **String**| A comma-delimited list of Schedule IDs to filter by. | [optional] |
|
2457
2459
|
{: class="table table-striped"}
|
2458
2460
|
|
2459
2461
|
|
@@ -2554,7 +2556,7 @@ Get a system prompt
|
|
2554
2556
|
|
2555
2557
|
Wraps GET /api/v2/architect/systemprompts/{promptId}
|
2556
2558
|
|
2557
|
-
Requires
|
2559
|
+
Requires ALL permissions:
|
2558
2560
|
|
2559
2561
|
* architect:systemPrompt:view
|
2560
2562
|
|
@@ -2619,7 +2621,7 @@ Get generated prompt history
|
|
2619
2621
|
|
2620
2622
|
Wraps GET /api/v2/architect/systemprompts/{promptId}/history/{historyId}
|
2621
2623
|
|
2622
|
-
Requires
|
2624
|
+
Requires ALL permissions:
|
2623
2625
|
|
2624
2626
|
* architect:systemPrompt:view
|
2625
2627
|
|
@@ -2699,7 +2701,7 @@ Get a system prompt resource.
|
|
2699
2701
|
|
2700
2702
|
Wraps GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
|
2701
2703
|
|
2702
|
-
Requires
|
2704
|
+
Requires ALL permissions:
|
2703
2705
|
|
2704
2706
|
* architect:systemPrompt:view
|
2705
2707
|
|
@@ -2767,7 +2769,7 @@ Get system prompt resources.
|
|
2767
2769
|
|
2768
2770
|
Wraps GET /api/v2/architect/systemprompts/{promptId}/resources
|
2769
2771
|
|
2770
|
-
Requires
|
2772
|
+
Requires ALL permissions:
|
2771
2773
|
|
2772
2774
|
* architect:systemPrompt:view
|
2773
2775
|
|
@@ -2842,7 +2844,7 @@ Get System Prompts
|
|
2842
2844
|
|
2843
2845
|
Wraps GET /api/v2/architect/systemprompts
|
2844
2846
|
|
2845
|
-
Requires
|
2847
|
+
Requires ALL permissions:
|
2846
2848
|
|
2847
2849
|
* architect:systemPrompt:view
|
2848
2850
|
|
@@ -3952,7 +3954,7 @@ This returns a simplified version of /flow consisting of name and type. If one o
|
|
3952
3954
|
|
3953
3955
|
Wraps GET /api/v2/flows/divisionviews
|
3954
3956
|
|
3955
|
-
Requires
|
3957
|
+
Requires ALL permissions:
|
3956
3958
|
|
3957
3959
|
* architect:flow:search
|
3958
3960
|
|
@@ -4250,7 +4252,7 @@ Asynchronous. Notification topic: v2.architect.dependencytracking.build
|
|
4250
4252
|
|
4251
4253
|
Wraps POST /api/v2/architect/dependencytracking/build
|
4252
4254
|
|
4253
|
-
Requires
|
4255
|
+
Requires ALL permissions:
|
4254
4256
|
|
4255
4257
|
* architect:dependencyTracking:rebuild
|
4256
4258
|
|
@@ -4438,7 +4440,7 @@ Asynchronous. Notification topic: v2.architect.prompts.{promptId}
|
|
4438
4440
|
|
4439
4441
|
Wraps POST /api/v2/architect/prompts/{promptId}/history
|
4440
4442
|
|
4441
|
-
Requires
|
4443
|
+
Requires ALL permissions:
|
4442
4444
|
|
4443
4445
|
* architect:userPrompt:view
|
4444
4446
|
|
@@ -4503,7 +4505,7 @@ Create a new user prompt resource
|
|
4503
4505
|
|
4504
4506
|
Wraps POST /api/v2/architect/prompts/{promptId}/resources
|
4505
4507
|
|
4506
|
-
Requires
|
4508
|
+
Requires ALL permissions:
|
4507
4509
|
|
4508
4510
|
* architect:userPrompt:edit
|
4509
4511
|
|
@@ -4571,7 +4573,7 @@ Create a new user prompt
|
|
4571
4573
|
|
4572
4574
|
Wraps POST /api/v2/architect/prompts
|
4573
4575
|
|
4574
|
-
Requires
|
4576
|
+
Requires ALL permissions:
|
4575
4577
|
|
4576
4578
|
* architect:userPrompt:add
|
4577
4579
|
|
@@ -4766,7 +4768,7 @@ Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId}
|
|
4766
4768
|
|
4767
4769
|
Wraps POST /api/v2/architect/systemprompts/{promptId}/history
|
4768
4770
|
|
4769
|
-
Requires
|
4771
|
+
Requires ALL permissions:
|
4770
4772
|
|
4771
4773
|
* architect:systemPrompt:view
|
4772
4774
|
|
@@ -4831,7 +4833,7 @@ Create system prompt resource override.
|
|
4831
4833
|
|
4832
4834
|
Wraps POST /api/v2/architect/systemprompts/{promptId}/resources
|
4833
4835
|
|
4834
|
-
Requires
|
4836
|
+
Requires ALL permissions:
|
4835
4837
|
|
4836
4838
|
* architect:systemPrompt:edit
|
4837
4839
|
|
@@ -5961,7 +5963,7 @@ Update specified user prompt
|
|
5961
5963
|
|
5962
5964
|
Wraps PUT /api/v2/architect/prompts/{promptId}
|
5963
5965
|
|
5964
|
-
Requires
|
5966
|
+
Requires ALL permissions:
|
5965
5967
|
|
5966
5968
|
* architect:userPrompt:edit
|
5967
5969
|
|
@@ -6029,7 +6031,7 @@ Update specified user prompt resource
|
|
6029
6031
|
|
6030
6032
|
Wraps PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode}
|
6031
6033
|
|
6032
|
-
Requires
|
6034
|
+
Requires ALL permissions:
|
6033
6035
|
|
6034
6036
|
* architect:userPrompt:edit
|
6035
6037
|
|
@@ -6236,7 +6238,7 @@ Updates a system prompt resource override.
|
|
6236
6238
|
|
6237
6239
|
Wraps PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode}
|
6238
6240
|
|
6239
|
-
Requires
|
6241
|
+
Requires ALL permissions:
|
6240
6242
|
|
6241
6243
|
* architect:systemPrompt:edit
|
6242
6244
|
|
data/docs/CoachingApi.md
CHANGED
@@ -28,7 +28,7 @@ Method | Description
|
|
28
28
|
|
29
29
|
<a name="delete_coaching_appointment"></a>
|
30
30
|
|
31
|
-
##
|
31
|
+
## [**CoachingAppointmentReference**](CoachingAppointmentReference.html) delete_coaching_appointment(appointment_id)
|
32
32
|
|
33
33
|
|
34
34
|
|
@@ -65,7 +65,8 @@ appointment_id = "appointment_id_example" # String | The ID of the coaching appo
|
|
65
65
|
|
66
66
|
begin
|
67
67
|
#Delete an existing appointment
|
68
|
-
api_instance.delete_coaching_appointment(appointment_id)
|
68
|
+
result = api_instance.delete_coaching_appointment(appointment_id)
|
69
|
+
p result
|
69
70
|
rescue PureCloud::ApiError => e
|
70
71
|
puts "Exception when calling CoachingApi->delete_coaching_appointment: #{e}"
|
71
72
|
end
|
@@ -81,7 +82,7 @@ Name | Type | Description | Notes
|
|
81
82
|
|
82
83
|
### Return type
|
83
84
|
|
84
|
-
|
85
|
+
[**CoachingAppointmentReference**](CoachingAppointmentReference.html)
|
85
86
|
|
86
87
|
### HTTP request headers
|
87
88
|
|
@@ -472,7 +473,7 @@ api_instance = PureCloud::CoachingApi.new
|
|
472
473
|
user_ids = ["user_ids_example"] # Array<String> | The user IDs for which to retrieve appointments
|
473
474
|
|
474
475
|
opts = {
|
475
|
-
interval: "interval_example", # String | Interval
|
476
|
+
interval: "interval_example", # String | Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
476
477
|
page_number: 1, # Integer | Page number
|
477
478
|
page_size: 25, # Integer | Page size
|
478
479
|
statuses: ["statuses_example"], # Array<String> | Appointment Statuses to filter by
|
@@ -494,7 +495,7 @@ end
|
|
494
495
|
Name | Type | Description | Notes
|
495
496
|
------------- | ------------- | ------------- | -------------
|
496
497
|
**user_ids** | [**Array<String>**](String.html)| The user IDs for which to retrieve appointments | |
|
497
|
-
**interval** | **String**| Interval
|
498
|
+
**interval** | **String**| Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
498
499
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
499
500
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
500
501
|
**statuses** | [**Array<String>**](String.html)| Appointment Statuses to filter by | [optional] <br />**Values**: Scheduled, InProgress, Completed, InvalidSchedule |
|
@@ -548,7 +549,7 @@ end
|
|
548
549
|
api_instance = PureCloud::CoachingApi.new
|
549
550
|
|
550
551
|
opts = {
|
551
|
-
interval: "interval_example", # String | Interval
|
552
|
+
interval: "interval_example", # String | Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
552
553
|
page_number: 1, # Integer | Page number
|
553
554
|
page_size: 25, # Integer | Page size
|
554
555
|
statuses: ["statuses_example"], # Array<String> | Appointment Statuses to filter by
|
@@ -569,7 +570,7 @@ end
|
|
569
570
|
|
570
571
|
Name | Type | Description | Notes
|
571
572
|
------------- | ------------- | ------------- | -------------
|
572
|
-
**interval** | **String**| Interval
|
573
|
+
**interval** | **String**| Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
573
574
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
574
575
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
575
576
|
**statuses** | [**Array<String>**](String.html)| Appointment Statuses to filter by | [optional] <br />**Values**: Scheduled, InProgress, Completed |
|