purecloudplatformclientv2 22.0.0 → 23.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActivityCode.md +8 -5
- data/docs/ActivityCodeContainer.md +1 -0
- data/docs/AdherenceSettings.md +1 -1
- data/docs/ArchitectApi.md +14 -14
- data/docs/AuthorizationApi.md +3 -1
- data/docs/BatchDownloadJobResult.md +20 -0
- data/docs/BatchDownloadJobStatusResult.md +20 -0
- data/docs/BatchDownloadJobSubmission.md +13 -0
- data/docs/BatchDownloadJobSubmissionResult.md +15 -0
- data/docs/BatchDownloadRequest.md +14 -0
- data/docs/Call.md +2 -0
- data/docs/CallBasic.md +2 -0
- data/docs/CallForwardingNotification.md +17 -0
- data/docs/CallForwardingNotificationCall.md +13 -0
- data/docs/CallForwardingNotificationCalls.md +13 -0
- data/docs/CallForwardingNotificationTarget.md +14 -0
- data/docs/CallForwardingNotificationTargets.md +14 -0
- data/docs/CallForwardingNotificationUser.md +13 -0
- data/docs/CallRoute.md +0 -1
- data/docs/{SignedData.md → ContactColumnTimeZone.md} +2 -3
- data/docs/CreateActivityCodeRequest.md +18 -0
- data/docs/CreateQueueRequest.md +12 -11
- data/docs/ExternalContact.md +1 -0
- data/docs/IgnoredActivityCategories.md +13 -0
- data/docs/ManagementUnit.md +4 -3
- data/docs/ManagementUnitSettings.md +1 -3
- data/docs/MessageDetails.md +1 -0
- data/docs/MessageMedia.md +14 -0
- data/docs/MoveAgentResponse.md +14 -0
- data/docs/MoveAgentsRequest.md +14 -0
- data/docs/MoveAgentsResponse.md +15 -0
- data/docs/NTPSettings.md +13 -0
- data/docs/OrganizationAuthorizationApi.md +2 -2
- data/docs/OutOfOfficeNotification.md +1 -0
- data/docs/OutboundApi.md +63 -0
- data/docs/Queue.md +12 -11
- data/docs/Recording.md +1 -0
- data/docs/RecordingApi.md +120 -0
- data/docs/RecordingMessagingMessage.md +18 -0
- data/docs/RoutingApi.md +2 -2
- data/docs/SchedulingSettings.md +1 -0
- data/docs/ShrinkageOverride.md +14 -0
- data/docs/ShrinkageOverrides.md +14 -0
- data/docs/Site.md +1 -0
- data/docs/TrustCreate.md +2 -1
- data/docs/TrustGroup.md +26 -0
- data/docs/{TrustUserCreate.md → TrustMemberCreate.md} +4 -4
- data/docs/TrustRequest.md +2 -1
- data/docs/TrustRequestCreate.md +2 -1
- data/docs/UserQueue.md +12 -11
- data/docs/WfmVersionedEntityMetadata.md +15 -0
- data/docs/WorkforceManagementApi.md +128 -3
- data/docs/{Entity.md → WrapUpCodeReference.md} +2 -2
- data/lib/purecloudplatformclientv2.rb +26 -4
- data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +75 -0
- data/lib/purecloudplatformclientv2/api/recording_api.rb +130 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +138 -2
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/activity_code.rb +95 -12
- data/lib/purecloudplatformclientv2/models/activity_code_container.rb +35 -4
- data/lib/purecloudplatformclientv2/models/adherence_settings.rb +2 -4
- data/lib/purecloudplatformclientv2/models/batch_download_job_result.rb +383 -0
- data/lib/purecloudplatformclientv2/models/batch_download_job_status_result.rb +385 -0
- data/lib/purecloudplatformclientv2/models/batch_download_job_submission.rb +209 -0
- data/lib/purecloudplatformclientv2/models/batch_download_job_submission_result.rb +253 -0
- data/lib/purecloudplatformclientv2/models/batch_download_request.rb +228 -0
- data/lib/purecloudplatformclientv2/models/call.rb +56 -4
- data/lib/purecloudplatformclientv2/models/call_basic.rb +56 -4
- data/lib/purecloudplatformclientv2/models/call_forwarding_notification.rb +303 -0
- data/lib/purecloudplatformclientv2/models/call_forwarding_notification_call.rb +203 -0
- data/lib/purecloudplatformclientv2/models/call_forwarding_notification_calls.rb +203 -0
- data/lib/purecloudplatformclientv2/models/call_forwarding_notification_target.rb +226 -0
- data/lib/purecloudplatformclientv2/models/call_forwarding_notification_targets.rb +226 -0
- data/lib/purecloudplatformclientv2/models/{signed_data.rb → call_forwarding_notification_user.rb} +8 -8
- data/lib/purecloudplatformclientv2/models/call_route.rb +4 -30
- data/lib/purecloudplatformclientv2/models/contact_column_time_zone.rb +176 -0
- data/lib/purecloudplatformclientv2/models/create_activity_code_request.rb +358 -0
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +38 -12
- 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/external_contact.rb +26 -1
- data/lib/purecloudplatformclientv2/models/ignored_activity_categories.rb +204 -0
- data/lib/purecloudplatformclientv2/models/management_unit.rb +36 -5
- data/lib/purecloudplatformclientv2/models/management_unit_settings.rb +9 -61
- data/lib/purecloudplatformclientv2/models/message_details.rb +32 -4
- data/lib/purecloudplatformclientv2/models/message_media.rb +228 -0
- data/lib/purecloudplatformclientv2/models/move_agent_response.rb +243 -0
- data/lib/purecloudplatformclientv2/models/move_agents_request.rb +236 -0
- data/lib/purecloudplatformclientv2/models/move_agents_response.rb +257 -0
- data/lib/purecloudplatformclientv2/models/ntp_settings.rb +204 -0
- data/lib/purecloudplatformclientv2/models/out_of_office_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/prediction_results.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue.rb +38 -12
- data/lib/purecloudplatformclientv2/models/recording.rb +29 -1
- data/lib/purecloudplatformclientv2/models/recording_messaging_message.rb +327 -0
- data/lib/purecloudplatformclientv2/models/scheduling_settings.rb +30 -4
- data/lib/purecloudplatformclientv2/models/shrinkage_override.rb +233 -0
- data/lib/purecloudplatformclientv2/models/shrinkage_overrides.rb +230 -0
- data/lib/purecloudplatformclientv2/models/site.rb +27 -1
- data/lib/purecloudplatformclientv2/models/trust_create.rb +32 -9
- data/lib/purecloudplatformclientv2/models/trust_group.rb +603 -0
- data/lib/purecloudplatformclientv2/models/{trust_user_create.rb → trust_member_create.rb} +3 -3
- data/lib/purecloudplatformclientv2/models/trust_request.rb +28 -5
- data/lib/purecloudplatformclientv2/models/trust_request_create.rb +32 -9
- data/lib/purecloudplatformclientv2/models/user_queue.rb +38 -12
- data/lib/purecloudplatformclientv2/models/wfm_versioned_entity_metadata.rb +260 -0
- data/lib/purecloudplatformclientv2/models/{entity.rb → wrap_up_code_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +54 -10
- data/docs/SignedDataApi.md +0 -73
- data/lib/purecloudplatformclientv2/api/signed_data_api.rb +0 -90
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 78315726d020789782230ca20f6919b7723da6a8
|
|
4
|
+
data.tar.gz: 825b15fb9c37450faffec95ccdfb83dd6b9f9a8a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c93e75d80cbd1e423317d2190ddad6a9788885efee217591acbed01a53e20f2dacbaa60a4a126a36fdd54e475ec57b3790bc9cd32319adbec177093c4ccd9bd1
|
|
7
|
+
data.tar.gz: 3437925a228e1b7d96e5863c9ed85dd0372af47735e7449453620ada3d7f162d834e7ff24b9a9569ca67fdd1564cb69c41b6d78952346de3603226735feb47e3
|
data/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: PureCloud Ruby Gem
|
|
3
3
|
---
|
|
4
|
-

|
|
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
|
~~~ ruby
|
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 23.0.0'
|
|
14
14
|
~~~
|
|
15
15
|
|
|
16
16
|
### Install from Git
|
data/docs/ActivityCode.md
CHANGED
|
@@ -7,14 +7,17 @@ title: ActivityCode
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **
|
|
11
|
-
| **
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | The name of the activity code. Default activity codes will be created with an empty name | [optional] |
|
|
12
|
+
| **is_active** | **BOOLEAN** | Whether this activity code is active or has been deleted | [optional] |
|
|
12
13
|
| **is_default** | **BOOLEAN** | Whether this is a default activity code | [optional] |
|
|
13
|
-
| **category** | **String** | The activity code's category | [optional] |
|
|
14
|
+
| **category** | **String** | The activity code's category. | [optional] |
|
|
14
15
|
| **length_in_minutes** | **Integer** | The default length of the activity in minutes | [optional] |
|
|
15
16
|
| **counts_as_paid_time** | **BOOLEAN** | Whether an agent is paid while performing this activity | [optional] |
|
|
16
|
-
| **counts_as_work_time** | **BOOLEAN** | Indicates whether or not the activity should be counted as work time | [optional] |
|
|
17
|
-
| **
|
|
17
|
+
| **counts_as_work_time** | **BOOLEAN** | Indicates whether or not the activity should be counted as contiguous work time for calculating daily constraints | [optional] |
|
|
18
|
+
| **agent_time_off_selectable** | **BOOLEAN** | Whether an agent can select this activity code when creating or editing a time off request. Null if the activity's category is not time off. | [optional] |
|
|
19
|
+
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for the associated management unit's list of activity codes | |
|
|
20
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
18
21
|
{: class="table table-striped"}
|
|
19
22
|
|
|
20
23
|
|
|
@@ -8,6 +8,7 @@ title: ActivityCodeContainer
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **activity_codes** | [**Hash<String, ActivityCode>**](ActivityCode.html) | Map of activity code id to activity code | [optional] |
|
|
11
|
+
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for the associated management unit's list of activity codes | |
|
|
11
12
|
{: class="table table-striped"}
|
|
12
13
|
|
|
13
14
|
|
data/docs/AdherenceSettings.md
CHANGED
|
@@ -12,7 +12,7 @@ title: AdherenceSettings
|
|
|
12
12
|
| **adherence_exception_threshold_seconds** | **Integer** | The threshold in seconds for which agents should not be penalized for being momentarily out of adherence | [optional] |
|
|
13
13
|
| **non_on_queue_activities_equivalent** | **BOOLEAN** | Whether to treat all non-on-queue activities as equivalent for adherence purposes | [optional] |
|
|
14
14
|
| **track_on_queue_activity** | **BOOLEAN** | Whether to track on-queue activities | [optional] |
|
|
15
|
-
| **ignored_activity_categories** | **
|
|
15
|
+
| **ignored_activity_categories** | [**IgnoredActivityCategories**](IgnoredActivityCategories.html) | Activity categories that should be ignored for adherence purposes | [optional] |
|
|
16
16
|
{: class="table table-striped"}
|
|
17
17
|
|
|
18
18
|
|
data/docs/ArchitectApi.md
CHANGED
|
@@ -665,11 +665,11 @@ Name | Type | Description | Notes
|
|
|
665
665
|
**name** | **String**| Object name to search for | |
|
|
666
666
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
667
667
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
668
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
668
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
669
669
|
**consumed_resources** | **BOOLEAN**| Include resources each result item consumes | [optional] |
|
|
670
670
|
**consuming_resources** | **BOOLEAN**| Include resources that consume each result item | [optional] |
|
|
671
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
672
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
671
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
672
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
673
673
|
{: class="table table-striped"}
|
|
674
674
|
|
|
675
675
|
|
|
@@ -790,8 +790,8 @@ Name | Type | Description | Notes
|
|
|
790
790
|
------------- | ------------- | ------------- | -------------
|
|
791
791
|
**id** | **String**| Consuming object ID | |
|
|
792
792
|
**version** | **String**| Consuming object version | |
|
|
793
|
-
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
794
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
793
|
+
**object_type** | **String**| Consuming object type. Only versioned types are allowed here. | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
794
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consumed resources to show | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
795
795
|
{: class="table table-striped"}
|
|
796
796
|
|
|
797
797
|
|
|
@@ -856,8 +856,8 @@ end
|
|
|
856
856
|
Name | Type | Description | Notes
|
|
857
857
|
------------- | ------------- | ------------- | -------------
|
|
858
858
|
**id** | **String**| Consumed object ID | |
|
|
859
|
-
**object_type** | **String**| Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
860
|
-
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
859
|
+
**object_type** | **String**| Consumed object type | <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
860
|
+
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
861
861
|
{: class="table table-striped"}
|
|
862
862
|
|
|
863
863
|
|
|
@@ -924,10 +924,10 @@ end
|
|
|
924
924
|
Name | Type | Description | Notes
|
|
925
925
|
------------- | ------------- | ------------- | -------------
|
|
926
926
|
**name** | **String**| Name to search for | [optional] |
|
|
927
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
927
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
928
928
|
**flow_filter** | **String**| Show only checkedIn or published flows | [optional] <br />**Values**: checkedIn, published |
|
|
929
929
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
|
930
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
930
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
931
931
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
932
932
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
933
933
|
{: class="table table-striped"}
|
|
@@ -998,11 +998,11 @@ Name | Type | Description | Notes
|
|
|
998
998
|
------------- | ------------- | ------------- | -------------
|
|
999
999
|
**id** | **String**| Object ID | |
|
|
1000
1000
|
**version** | **String**| Object version | [optional] |
|
|
1001
|
-
**object_type** | **String**| Object type | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1001
|
+
**object_type** | **String**| Object type | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1002
1002
|
**consumed_resources** | **BOOLEAN**| Include resources this item consumes | [optional] |
|
|
1003
1003
|
**consuming_resources** | **BOOLEAN**| Include resources that consume this item | [optional] |
|
|
1004
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1005
|
-
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1004
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Types of consumed resources to return, if consumed resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1005
|
+
**consuming_resource_type** | [**Array<String>**](String.html)| Types of consuming resources to return, if consuming resources are requested | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1006
1006
|
{: class="table table-striped"}
|
|
1007
1007
|
|
|
1008
1008
|
|
|
@@ -1189,9 +1189,9 @@ end
|
|
|
1189
1189
|
Name | Type | Description | Notes
|
|
1190
1190
|
------------- | ------------- | ------------- | -------------
|
|
1191
1191
|
**name** | **String**| Name to search for | [optional] |
|
|
1192
|
-
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1192
|
+
**object_type** | [**Array<String>**](String.html)| Object type(s) to search for | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1193
1193
|
**consumed_resources** | **BOOLEAN**| Return consumed resources? | [optional] [default to false] |
|
|
1194
|
-
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1194
|
+
**consumed_resource_type** | [**Array<String>**](String.html)| Resource type(s) to return | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, EMAILROUTE, EMERGENCYGROUP, GROUP, INBOUNDCALLFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, USER, USERPROMPT, VOICEXML, WORKFLOW |
|
|
1195
1195
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1196
1196
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
1197
1197
|
{: class="table table-striped"}
|
data/docs/AuthorizationApi.md
CHANGED
|
@@ -417,7 +417,8 @@ opts = {
|
|
|
417
417
|
name: "name_example", # String |
|
|
418
418
|
permission: nil, # Array<Object> |
|
|
419
419
|
default_role_id: nil, # Array<Object> |
|
|
420
|
-
user_count: true # BOOLEAN |
|
|
420
|
+
user_count: true, # BOOLEAN |
|
|
421
|
+
id: ["id_example"] # Array<String> | id
|
|
421
422
|
}
|
|
422
423
|
|
|
423
424
|
begin
|
|
@@ -443,6 +444,7 @@ Name | Type | Description | Notes
|
|
|
443
444
|
**permission** | [**Array<Object>**](Object.html)| | [optional] |
|
|
444
445
|
**default_role_id** | [**Array<Object>**](Object.html)| | [optional] |
|
|
445
446
|
**user_count** | **BOOLEAN**| | [optional] [default to true] |
|
|
447
|
+
**id** | [**Array<String>**](String.html)| id | [optional] |
|
|
446
448
|
{: class="table table-striped"}
|
|
447
449
|
|
|
448
450
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: BatchDownloadJobResult
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::BatchDownloadJobResult
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **conversation_id** | **String** | Conversation id of the result | [optional] |
|
|
13
|
+
| **recording_id** | **String** | Recording id of the result | [optional] |
|
|
14
|
+
| **result_url** | **String** | URL of results... HTTP GET from this location to download results for this item | [optional] |
|
|
15
|
+
| **content_type** | **String** | Content type of this result | [optional] |
|
|
16
|
+
| **error_msg** | **String** | An error message, in case of failed processing will indicate the cause of the failure | [optional] |
|
|
17
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: BatchDownloadJobStatusResult
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::BatchDownloadJobStatusResult
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **job_id** | **String** | JobId returned when job was initially submitted | [optional] |
|
|
13
|
+
| **expected_result_count** | **Integer** | Number of results expected when job is completed | [optional] |
|
|
14
|
+
| **result_count** | **Integer** | Current number of results available | [optional] |
|
|
15
|
+
| **error_count** | **Integer** | Number of error results produced so far | [optional] |
|
|
16
|
+
| **results** | [**Array<BatchDownloadJobResult>**](BatchDownloadJobResult.html) | Current set of results for the job | [optional] |
|
|
17
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: BatchDownloadJobSubmission
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::BatchDownloadJobSubmission
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **batch_download_request_list** | [**Array<BatchDownloadRequest>**](BatchDownloadRequest.html) | List of items requested | |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: BatchDownloadJobSubmissionResult
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::BatchDownloadJobSubmissionResult
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: BatchDownloadRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::BatchDownloadRequest
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **conversation_id** | **String** | Conversation id requested | [optional] |
|
|
11
|
+
| **recording_id** | **String** | Recording id requested, optional. Leave null for all recordings on the conversation | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/Call.md
CHANGED
|
@@ -29,6 +29,8 @@ title: Call
|
|
|
29
29
|
| **script_id** | **String** | The UUID of the script to use. | [optional] |
|
|
30
30
|
| **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
31
31
|
| **uui_data** | **String** | User to User Information (UUI) data managed by SIP session application. | [optional] |
|
|
32
|
+
| **_self** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
|
|
33
|
+
| **other** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
|
|
32
34
|
{: class="table table-striped"}
|
|
33
35
|
|
|
34
36
|
|
data/docs/CallBasic.md
CHANGED
|
@@ -29,6 +29,8 @@ title: CallBasic
|
|
|
29
29
|
| **script_id** | **String** | The UUID of the script to use. | [optional] |
|
|
30
30
|
| **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
31
31
|
| **uui_data** | **String** | User to User Information (UUI) data managed by SIP session application. | [optional] |
|
|
32
|
+
| **_self** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
|
|
33
|
+
| **other** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
|
|
32
34
|
{: class="table table-striped"}
|
|
33
35
|
|
|
34
36
|
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CallForwardingNotification
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CallForwardingNotification
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **user** | [**DocumentDataV2NotificationWorkspace**](DocumentDataV2NotificationWorkspace.html) | | [optional] |
|
|
11
|
+
| **enabled** | **BOOLEAN** | | [optional] |
|
|
12
|
+
| **calls** | [**Array<CallForwardingNotificationCalls>**](CallForwardingNotificationCalls.html) | | [optional] |
|
|
13
|
+
| **voicemail** | **String** | | [optional] |
|
|
14
|
+
| **modified_date** | **DateTime** | | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CallForwardingNotificationCall
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CallForwardingNotificationCall
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **targets** | [**Array<CallForwardingNotificationTargets>**](CallForwardingNotificationTargets.html) | | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CallForwardingNotificationCalls
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CallForwardingNotificationCalls
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **targets** | [**Array<CallForwardingNotificationTargets>**](CallForwardingNotificationTargets.html) | | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CallForwardingNotificationTarget
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CallForwardingNotificationTarget
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | | [optional] |
|
|
11
|
+
| **value** | **String** | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CallForwardingNotificationTargets
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CallForwardingNotificationTargets
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **type** | **String** | | [optional] |
|
|
11
|
+
| **value** | **String** | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CallForwardingNotificationUser
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CallForwardingNotificationUser
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
data/docs/CallRoute.md
CHANGED
|
@@ -8,7 +8,6 @@ title: CallRoute
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **targets** | [**Array<CallTarget>**](CallTarget.html) | A list of CallTargets to be called when the CallRoute is executed | [optional] |
|
|
11
|
-
| **timeout_milliseconds** | **Integer** | The amount of time until the call times out | [optional] |
|
|
12
11
|
{: class="table table-striped"}
|
|
13
12
|
|
|
14
13
|
|
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
---
|
|
2
|
-
title:
|
|
2
|
+
title: ContactColumnTimeZone
|
|
3
3
|
---
|
|
4
|
-
## PureCloud::
|
|
4
|
+
## PureCloud::ContactColumnTimeZone
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **jwt** | **String** | | [optional] |
|
|
11
10
|
{: class="table table-striped"}
|
|
12
11
|
|
|
13
12
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: CreateActivityCodeRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::CreateActivityCodeRequest
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **name** | **String** | The name of the activity code | |
|
|
11
|
+
| **category** | **String** | The activity code's category | |
|
|
12
|
+
| **length_in_minutes** | **Integer** | The default length of the activity in minutes | |
|
|
13
|
+
| **counts_as_paid_time** | **BOOLEAN** | Whether an agent is paid while performing this activity | |
|
|
14
|
+
| **counts_as_work_time** | **BOOLEAN** | Indicates whether or not the activity should be counted as work time | |
|
|
15
|
+
| **agent_time_off_selectable** | **BOOLEAN** | Whether an agent can select this activity code when creating or editing a time off request | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
data/docs/CreateQueueRequest.md
CHANGED
|
@@ -9,22 +9,23 @@ title: CreateQueueRequest
|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
|
-
| **description** | **String** | The
|
|
13
|
-
| **version** | **Integer** | The current version of the
|
|
14
|
-
| **
|
|
15
|
-
| **
|
|
16
|
-
| **
|
|
17
|
-
| **
|
|
18
|
-
| **
|
|
19
|
-
| **
|
|
20
|
-
| **
|
|
12
|
+
| **description** | **String** | The queue description. | [optional] |
|
|
13
|
+
| **version** | **Integer** | The current version of the queue. | [optional] |
|
|
14
|
+
| **division** | [**UriReference**](UriReference.html) | The division to which this queue belongs. | [optional] |
|
|
15
|
+
| **date_created** | **DateTime** | The date the queue was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **date_modified** | **DateTime** | The date of the last modification to the queue. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
17
|
+
| **modified_by** | **String** | The ID of the user that last modified the queue. | [optional] |
|
|
18
|
+
| **created_by** | **String** | The ID of the user that created the queue. | [optional] |
|
|
19
|
+
| **state** | **String** | Indicates if the queue is active, inactive, or deleted. | [optional] |
|
|
20
|
+
| **modified_by_app** | **String** | The application that last modified the queue. | [optional] |
|
|
21
|
+
| **created_by_app** | **String** | The application that created the queue. | [optional] |
|
|
21
22
|
| **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid Key Values: CALL, CALLBACK, CHAT, EMAIL, SOCIAL_EXPRESSION | |
|
|
22
23
|
| **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
|
|
23
24
|
| **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | |
|
|
24
25
|
| **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | |
|
|
25
26
|
| **queue_flow** | [**UriReference**](UriReference.html) | The in-queue flow to use for conversations waiting in queue. | [optional] |
|
|
26
|
-
| **whisper** | [**UriReference**](UriReference.html) |
|
|
27
|
-
| **auto_answer_only** | **BOOLEAN** | Specifies whether the configured whisper
|
|
27
|
+
| **whisper** | [**UriReference**](UriReference.html) | ID of the whisper configured for this queue, if any. | [optional] |
|
|
28
|
+
| **auto_answer_only** | **BOOLEAN** | Specifies whether the configured whisper should play for all ACD calls, or only for those which are auto-answered. | [optional] |
|
|
28
29
|
| **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
|
|
29
30
|
| **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
|
|
30
31
|
| **default_scripts** | [**Hash<String, Script>**](Script.html) | The default script Ids for the communication types. | [optional] |
|