purecloudplatformclientv2 47.0.0 → 48.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 +3 -3
- data/docs/AnalyticsApi.md +66 -0
- data/docs/AnalyticsSession.md +1 -1
- data/docs/AuthorizationApi.md +9 -5
- data/docs/Condition.md +4 -4
- data/docs/ContactColumnToDataActionFieldMapping.md +12 -0
- data/docs/ConversationProperties.md +21 -0
- data/docs/DataActionConditionPredicate.md +12 -0
- data/docs/GroupsApi.md +1 -1
- data/docs/OrgUser.md +1 -0
- data/docs/OutboundApi.md +2 -2
- data/docs/QualityApi.md +376 -0
- data/docs/RoutingApi.md +85 -12
- data/docs/ScorableSurvey.md +18 -0
- data/docs/SearchApi.md +2 -42
- data/docs/SuggestApi.md +2 -2
- data/docs/Survey.md +22 -0
- data/docs/SurveyFormAndScoringSet.md +14 -0
- data/docs/SurveyQuestionGroupScore.md +17 -0
- data/docs/SurveyQuestionScore.md +19 -0
- data/docs/SurveyScoringSet.md +15 -0
- data/docs/Token.md +13 -0
- data/docs/TrustUser.md +1 -0
- data/docs/User.md +1 -0
- data/docs/UserMe.md +1 -0
- data/docs/UsersApi.md +8 -8
- data/docs/UtilitiesApi.md +59 -0
- data/docs/ViewFilter.md +13 -0
- data/lib/purecloudplatformclientv2.rb +10 -0
- data/lib/purecloudplatformclientv2/api/alerting_api.rb +11 -11
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +91 -26
- data/lib/purecloudplatformclientv2/api/architect_api.rb +81 -81
- data/lib/purecloudplatformclientv2/api/attributes_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +45 -36
- data/lib/purecloudplatformclientv2/api/billing_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/content_management_api.rb +38 -38
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +100 -100
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +30 -30
- data/lib/purecloudplatformclientv2/api/fax_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/flows_api.rb +1 -1
- data/lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/geolocation_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/greetings_api.rb +16 -16
- data/lib/purecloudplatformclientv2/api/groups_api.rb +14 -14
- data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +28 -28
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +41 -41
- data/lib/purecloudplatformclientv2/api/languages_api.rb +10 -10
- data/lib/purecloudplatformclientv2/api/license_api.rb +8 -8
- data/lib/purecloudplatformclientv2/api/locations_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +14 -14
- data/lib/purecloudplatformclientv2/api/mobile_devices_api.rb +5 -5
- data/lib/purecloudplatformclientv2/api/notifications_api.rb +7 -7
- data/lib/purecloudplatformclientv2/api/o_auth_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/objects_api.rb +8 -8
- data/lib/purecloudplatformclientv2/api/organization_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/organization_authorization_api.rb +23 -23
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +98 -98
- data/lib/purecloudplatformclientv2/api/presence_api.rb +9 -9
- data/lib/purecloudplatformclientv2/api/quality_api.rb +450 -52
- data/lib/purecloudplatformclientv2/api/recording_api.rb +37 -37
- data/lib/purecloudplatformclientv2/api/response_management_api.rb +11 -11
- data/lib/purecloudplatformclientv2/api/routing_api.rb +173 -70
- data/lib/purecloudplatformclientv2/api/scripts_api.rb +11 -11
- data/lib/purecloudplatformclientv2/api/search_api.rb +16 -16
- data/lib/purecloudplatformclientv2/api/stations_api.rb +5 -5
- data/lib/purecloudplatformclientv2/api/suggest_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +125 -125
- data/lib/purecloudplatformclientv2/api/tokens_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/user_recordings_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/users_api.rb +61 -61
- data/lib/purecloudplatformclientv2/api/utilities_api.rb +58 -3
- data/lib/purecloudplatformclientv2/api/voicemail_api.rb +24 -24
- data/lib/purecloudplatformclientv2/api/web_chat_api.rb +8 -8
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +64 -64
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/configuration.rb +9 -2
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +1 -1
- data/lib/purecloudplatformclientv2/models/condition.rb +6 -6
- data/lib/purecloudplatformclientv2/models/contact_column_to_data_action_field_mapping.rb +176 -0
- data/lib/purecloudplatformclientv2/models/conversation_properties.rb +410 -0
- data/lib/purecloudplatformclientv2/models/data_action_condition_predicate.rb +176 -0
- data/lib/purecloudplatformclientv2/models/observation_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/org_user.rb +27 -1
- data/lib/purecloudplatformclientv2/models/scorable_survey.rb +343 -0
- data/lib/purecloudplatformclientv2/models/survey.rb +444 -0
- data/lib/purecloudplatformclientv2/models/survey_form_and_scoring_set.rb +226 -0
- data/lib/purecloudplatformclientv2/models/survey_question_group_score.rb +303 -0
- data/lib/purecloudplatformclientv2/models/survey_question_score.rb +351 -0
- data/lib/purecloudplatformclientv2/models/survey_scoring_set.rb +253 -0
- data/lib/purecloudplatformclientv2/models/token.rb +207 -0
- data/lib/purecloudplatformclientv2/models/trust_user.rb +27 -1
- data/lib/purecloudplatformclientv2/models/user.rb +27 -1
- data/lib/purecloudplatformclientv2/models/user_me.rb +27 -1
- data/lib/purecloudplatformclientv2/models/view_filter.rb +354 -4
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +22 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ff0ca57a2d4cf5eb9ae302359138b6b11a7bf496
|
4
|
+
data.tar.gz: a445d5c1285890f9855e5a92ff4a15afe44a8f44
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '0024457384529513aca3c8e4edac347d64b4473eff3b572cecc13f9d25c530328d7b31016b1aaa228e0ecff9eabfa4c50584f2e2905fe6340995328438d2e0c6'
|
7
|
+
data.tar.gz: d8d38d7863a7bf5abf7c39dbf5e96969598348315ef10d6616942455688bffb2fc8bc72097dddd1b1a1f312fcc6fa2e8cb95a3e5ed2985409da9687bac1148cb
|
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', '~> 48.0.0'
|
14
14
|
~~~
|
15
15
|
|
16
16
|
### Install from Git
|
@@ -29,7 +29,7 @@ require 'purecloudplatformclientv2'
|
|
29
29
|
|
30
30
|
# Setup authorization
|
31
31
|
PureCloud.configure do |config|
|
32
|
-
# Configure OAuth2 access token for authorization: PureCloud
|
32
|
+
# Configure OAuth2 access token for authorization: PureCloud OAuth
|
33
33
|
config.access_token = 'YOUR ACCESS TOKEN'
|
34
34
|
end
|
35
35
|
|
data/docs/AnalyticsApi.md
CHANGED
@@ -30,6 +30,7 @@ Method | Description
|
|
30
30
|
[**post_analytics_reporting_exports**](AnalyticsApi.html#post_analytics_reporting_exports) | Generate a view export request
|
31
31
|
[**post_analytics_reporting_schedule_runreport**](AnalyticsApi.html#post_analytics_reporting_schedule_runreport) | Place a scheduled report immediately into the reporting queue
|
32
32
|
[**post_analytics_reporting_schedules**](AnalyticsApi.html#post_analytics_reporting_schedules) | Create a scheduled report job
|
33
|
+
[**post_analytics_surveys_aggregates_query**](AnalyticsApi.html#post_analytics_surveys_aggregates_query) | Query for survey aggregates
|
33
34
|
[**post_analytics_users_aggregates_query**](AnalyticsApi.html#post_analytics_users_aggregates_query) | Query for user aggregates
|
34
35
|
[**post_analytics_users_details_query**](AnalyticsApi.html#post_analytics_users_details_query) | Query for user details
|
35
36
|
[**post_analytics_users_observations_query**](AnalyticsApi.html#post_analytics_users_observations_query) | Query for user observations
|
@@ -1460,6 +1461,71 @@ Name | Type | Description | Notes
|
|
1460
1461
|
|
1461
1462
|
|
1462
1463
|
|
1464
|
+
<a name="post_analytics_surveys_aggregates_query"></a>
|
1465
|
+
|
1466
|
+
## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_surveys_aggregates_query(body)
|
1467
|
+
|
1468
|
+
|
1469
|
+
|
1470
|
+
Query for survey aggregates
|
1471
|
+
|
1472
|
+
|
1473
|
+
|
1474
|
+
Wraps POST /api/v2/analytics/surveys/aggregates/query
|
1475
|
+
|
1476
|
+
Requires ANY permissions:
|
1477
|
+
|
1478
|
+
* analytics:surveyAggregate:view
|
1479
|
+
|
1480
|
+
|
1481
|
+
### Example
|
1482
|
+
~~~ruby
|
1483
|
+
# load the gem
|
1484
|
+
require 'purecloudplatformclientv2'
|
1485
|
+
# setup authorization
|
1486
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1487
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1488
|
+
environment = "mypurecloud.com"
|
1489
|
+
|
1490
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1491
|
+
|
1492
|
+
PureCloud.configure do |config|
|
1493
|
+
config.access_token = @authToken
|
1494
|
+
end
|
1495
|
+
|
1496
|
+
api_instance = PureCloud::AnalyticsApi.new
|
1497
|
+
|
1498
|
+
body = PureCloud::AggregationQuery.new # AggregationQuery | query
|
1499
|
+
|
1500
|
+
|
1501
|
+
begin
|
1502
|
+
#Query for survey aggregates
|
1503
|
+
result = api_instance.post_analytics_surveys_aggregates_query(body)
|
1504
|
+
p result
|
1505
|
+
rescue PureCloud::ApiError => e
|
1506
|
+
puts "Exception when calling AnalyticsApi->post_analytics_surveys_aggregates_query: #{e}"
|
1507
|
+
end
|
1508
|
+
~~~
|
1509
|
+
|
1510
|
+
### Parameters
|
1511
|
+
|
1512
|
+
Name | Type | Description | Notes
|
1513
|
+
------------- | ------------- | ------------- | -------------
|
1514
|
+
**body** | [**AggregationQuery**](AggregationQuery.html)| query | |
|
1515
|
+
{: class="table table-striped"}
|
1516
|
+
|
1517
|
+
|
1518
|
+
### Return type
|
1519
|
+
|
1520
|
+
[**AggregateQueryResponse**](AggregateQueryResponse.html)
|
1521
|
+
|
1522
|
+
### HTTP request headers
|
1523
|
+
|
1524
|
+
- **Content-Type**: application/json
|
1525
|
+
- **Accept**: application/json
|
1526
|
+
|
1527
|
+
|
1528
|
+
|
1463
1529
|
<a name="post_analytics_users_aggregates_query"></a>
|
1464
1530
|
|
1465
1531
|
## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
|
data/docs/AnalyticsSession.md
CHANGED
@@ -30,7 +30,7 @@ title: AnalyticsSession
|
|
30
30
|
| **callback_user_name** | **String** | The name of the user requesting a call back | [optional] |
|
31
31
|
| **callback_numbers** | **Array<String>** | List of numbers to callback | [optional] |
|
32
32
|
| **callback_scheduled_time** | **DateTime** | Scheduled callback date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
33
|
-
| **script_id** | **String** |
|
33
|
+
| **script_id** | **String** | A unique identifier for a script | [optional] |
|
34
34
|
| **peer_id** | **String** | A unique identifier for a peer | [optional] |
|
35
35
|
| **skip_enabled** | **BOOLEAN** | (Dialer) Whether the agent can skip the dialer contact | [optional] |
|
36
36
|
| **timeout_seconds** | **Integer** | The number of seconds before PureCloud begins the call for a call back. 0 disables automatic calling | [optional] |
|
data/docs/AuthorizationApi.md
CHANGED
@@ -21,7 +21,7 @@ Method | Description
|
|
21
21
|
[**get_authorization_permissions**](AuthorizationApi.html#get_authorization_permissions) | Get all permissions.
|
22
22
|
[**get_authorization_products**](AuthorizationApi.html#get_authorization_products) | Get the list of enabled products
|
23
23
|
[**get_authorization_role**](AuthorizationApi.html#get_authorization_role) | Get a single organization role.
|
24
|
-
[**get_authorization_role_comparedefault_right_role_id**](AuthorizationApi.html#get_authorization_role_comparedefault_right_role_id) | Get an org role to default role comparison
|
24
|
+
[**get_authorization_role_comparedefault_right_role_id**](AuthorizationApi.html#get_authorization_role_comparedefault_right_role_id) | Get an org role to default role comparison
|
25
25
|
[**get_authorization_role_subjectgrants**](AuthorizationApi.html#get_authorization_role_subjectgrants) | Get the subjects' granted divisions in the specified role.
|
26
26
|
[**get_authorization_role_users**](AuthorizationApi.html#get_authorization_role_users) | Get a list of the users in a specified role.
|
27
27
|
[**get_authorization_roles**](AuthorizationApi.html#get_authorization_roles) | Retrieve a list of all roles defined for the organization
|
@@ -911,7 +911,7 @@ Name | Type | Description | Notes
|
|
911
911
|
|
912
912
|
|
913
913
|
|
914
|
-
Get an org role to default role comparison
|
914
|
+
Get an org role to default role comparison
|
915
915
|
|
916
916
|
Compares any organization role to a default role id and show differences
|
917
917
|
|
@@ -945,7 +945,7 @@ right_role_id = "right_role_id_example" # String | Right Role id
|
|
945
945
|
|
946
946
|
|
947
947
|
begin
|
948
|
-
#Get an org role to default role comparison
|
948
|
+
#Get an org role to default role comparison
|
949
949
|
result = api_instance.get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id)
|
950
950
|
p result
|
951
951
|
rescue PureCloud::ApiError => e
|
@@ -1603,7 +1603,7 @@ Name | Type | Description | Notes
|
|
1603
1603
|
|
1604
1604
|
<a name="post_authorization_role"></a>
|
1605
1605
|
|
1606
|
-
## - post_authorization_role(role_id, body)
|
1606
|
+
## - post_authorization_role(role_id, body, opts)
|
1607
1607
|
|
1608
1608
|
|
1609
1609
|
|
@@ -1639,10 +1639,13 @@ role_id = "role_id_example" # String | Role ID
|
|
1639
1639
|
|
1640
1640
|
body = PureCloud::SubjectDivisions.new # SubjectDivisions | Subjects and Divisions
|
1641
1641
|
|
1642
|
+
opts = {
|
1643
|
+
subject_type: "PC_USER" # String | what the type of the subject is, PC_GROUP or PC_USER
|
1644
|
+
}
|
1642
1645
|
|
1643
1646
|
begin
|
1644
1647
|
#Bulk-grant subjects and divisions with an organization role.
|
1645
|
-
api_instance.post_authorization_role(role_id, body)
|
1648
|
+
api_instance.post_authorization_role(role_id, body, opts)
|
1646
1649
|
rescue PureCloud::ApiError => e
|
1647
1650
|
puts "Exception when calling AuthorizationApi->post_authorization_role: #{e}"
|
1648
1651
|
end
|
@@ -1654,6 +1657,7 @@ Name | Type | Description | Notes
|
|
1654
1657
|
------------- | ------------- | ------------- | -------------
|
1655
1658
|
**role_id** | **String**| Role ID | |
|
1656
1659
|
**body** | [**SubjectDivisions**](SubjectDivisions.html)| Subjects and Divisions | |
|
1660
|
+
**subject_type** | **String**| what the type of the subject is, PC_GROUP or PC_USER | [optional] [default to PC_USER] |
|
1657
1661
|
{: class="table table-striped"}
|
1658
1662
|
|
1659
1663
|
|
data/docs/Condition.md
CHANGED
@@ -10,12 +10,12 @@ title: Condition
|
|
10
10
|
| **type** | **String** | The type of the condition. | [optional] |
|
11
11
|
| **inverted** | **BOOLEAN** | If true, inverts the result of evaluating this Condition. Default is false. | [optional] |
|
12
12
|
| **attribute_name** | **String** | An attribute name associated with this Condition. Required for a contactAttributeCondition. | [optional] |
|
13
|
-
| **value** | **String** | A value associated with this Condition. This could be text, a number, or a relative time.
|
14
|
-
| **value_type** | **String** | The type of the value associated with this Condition. | [optional] |
|
15
|
-
| **operator** | **String** | An operation with which to evaluate the Condition. | [optional] |
|
13
|
+
| **value** | **String** | A value associated with this Condition. This could be text, a number, or a relative time. Not used for a DataActionCondition. | [optional] |
|
14
|
+
| **value_type** | **String** | The type of the value associated with this Condition. Not used for a DataActionCondition. | [optional] |
|
15
|
+
| **operator** | **String** | An operation with which to evaluate the Condition. Not used for a DataActionCondition. | [optional] |
|
16
16
|
| **codes** | **Array<String>** | List of wrap-up code identifiers. Required for a wrapupCondition. | [optional] |
|
17
17
|
| **property** | **String** | A value associated with the property type of this Condition. Required for a contactPropertyCondition. | [optional] |
|
18
|
-
| **property_type** | **String** | The type of the property associated with this Condition. | [optional] |
|
18
|
+
| **property_type** | **String** | The type of the property associated with this Condition. Required for a contactPropertyCondition. | [optional] |
|
19
19
|
{: class="table table-striped"}
|
20
20
|
|
21
21
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
---
|
2
|
+
title: ContactColumnToDataActionFieldMapping
|
3
|
+
---
|
4
|
+
## PureCloud::ContactColumnToDataActionFieldMapping
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
{: class="table table-striped"}
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
---
|
2
|
+
title: ConversationProperties
|
3
|
+
---
|
4
|
+
## PureCloud::ConversationProperties
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **is_waiting** | **BOOLEAN** | Indicates filtering for waiting | [optional] |
|
11
|
+
| **is_active** | **BOOLEAN** | Indicates filtering for active | [optional] |
|
12
|
+
| **is_acd** | **BOOLEAN** | Indicates filtering for Acd | [optional] |
|
13
|
+
| **is_screenshare** | **BOOLEAN** | Indicates filtering for screenshare | [optional] |
|
14
|
+
| **is_cobrowse** | **BOOLEAN** | Indicates filtering for Cobrowse | [optional] |
|
15
|
+
| **is_voicemail** | **BOOLEAN** | Indicates filtering for Voice mail | [optional] |
|
16
|
+
| **is_flagged** | **BOOLEAN** | Indicates filtering for flagged | [optional] |
|
17
|
+
| **filter_wrap_up_notes** | **BOOLEAN** | Indicates filtering for WrapUpNotes | [optional] |
|
18
|
+
| **match_all** | **BOOLEAN** | Indicates comparison operation, TRUE indicates filters will use AND logic, FALSE indicates OR logic | [optional] |
|
19
|
+
{: class="table table-striped"}
|
20
|
+
|
21
|
+
|
data/docs/GroupsApi.md
CHANGED
@@ -407,7 +407,7 @@ Name | Type | Description | Notes
|
|
407
407
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
408
408
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
409
409
|
**sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
|
410
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
|
410
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, languagePreference |
|
411
411
|
{: class="table table-striped"}
|
412
412
|
|
413
413
|
|
data/docs/OrgUser.md
CHANGED
@@ -34,6 +34,7 @@ title: OrgUser
|
|
34
34
|
| **skills** | [**Array<UserRoutingSkill>**](UserRoutingSkill.html) | Routing (ACD) skills possessed by the user | [optional] |
|
35
35
|
| **languages** | [**Array<UserRoutingLanguage>**](UserRoutingLanguage.html) | Routing (ACD) languages possessed by the user | [optional] |
|
36
36
|
| **acd_auto_answer** | **BOOLEAN** | acd auto answer | [optional] |
|
37
|
+
| **language_preference** | **String** | preferred language by the user | [optional] |
|
37
38
|
| **organization** | [**Organization**](Organization.html) | | [optional] |
|
38
39
|
{: class="table table-striped"}
|
39
40
|
|
data/docs/OutboundApi.md
CHANGED
@@ -4850,7 +4850,7 @@ body = [PureCloud::WritableDialerContact.new] # Array<WritableDialerContact> | C
|
|
4850
4850
|
opts = {
|
4851
4851
|
priority: true, # BOOLEAN | Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue.
|
4852
4852
|
clear_system_data: true, # BOOLEAN | Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't.
|
4853
|
-
do_not_queue: true # BOOLEAN | Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed; False means that updated contacts will be
|
4853
|
+
do_not_queue: true # BOOLEAN | Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts they will not be called until a campaign recycle; False means that updated contacts will be re-queued, according to the 'priority' parameter.
|
4854
4854
|
}
|
4855
4855
|
|
4856
4856
|
begin
|
@@ -4870,7 +4870,7 @@ Name | Type | Description | Notes
|
|
4870
4870
|
**body** | [**Array<WritableDialerContact>**](WritableDialerContact.html)| Contact | |
|
4871
4871
|
**priority** | **BOOLEAN**| Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue. | [optional] |
|
4872
4872
|
**clear_system_data** | **BOOLEAN**| Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't. | [optional] |
|
4873
|
-
**do_not_queue** | **BOOLEAN**| Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed; False means that updated contacts will be
|
4873
|
+
**do_not_queue** | **BOOLEAN**| Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts they will not be called until a campaign recycle; False means that updated contacts will be re-queued, according to the 'priority' parameter. | [optional] |
|
4874
4874
|
{: class="table table-striped"}
|
4875
4875
|
|
4876
4876
|
|
data/docs/QualityApi.md
CHANGED
@@ -20,6 +20,7 @@ Method | Description
|
|
20
20
|
[**get_quality_calibrations**](QualityApi.html#get_quality_calibrations) | Get the list of calibrations
|
21
21
|
[**get_quality_conversation_audits**](QualityApi.html#get_quality_conversation_audits) | Get audits for conversation or recording
|
22
22
|
[**get_quality_conversation_evaluation**](QualityApi.html#get_quality_conversation_evaluation) | Get an evaluation
|
23
|
+
[**get_quality_conversation_surveys**](QualityApi.html#get_quality_conversation_surveys) | Get the surveys for a conversation
|
23
24
|
[**get_quality_evaluations_query**](QualityApi.html#get_quality_evaluations_query) | Queries Evaluations and returns a paged list
|
24
25
|
[**get_quality_evaluators_activity**](QualityApi.html#get_quality_evaluators_activity) | Get an evaluator activity
|
25
26
|
[**get_quality_form**](QualityApi.html#get_quality_form) | Get an evaluation form
|
@@ -41,8 +42,11 @@ Method | Description
|
|
41
42
|
[**get_quality_publishedforms_evaluations**](QualityApi.html#get_quality_publishedforms_evaluations) | Get the published evaluation forms.
|
42
43
|
[**get_quality_publishedforms_survey**](QualityApi.html#get_quality_publishedforms_survey) | Get the most recent published version of a survey form.
|
43
44
|
[**get_quality_publishedforms_surveys**](QualityApi.html#get_quality_publishedforms_surveys) | Get the published survey forms.
|
45
|
+
[**get_quality_survey**](QualityApi.html#get_quality_survey) | Get a survey for a conversation
|
46
|
+
[**get_quality_surveys_scorable**](QualityApi.html#get_quality_surveys_scorable) | Get a survey as an end-customer, for the purposes of scoring it.
|
44
47
|
[**patch_quality_forms_survey**](QualityApi.html#patch_quality_forms_survey) | Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.
|
45
48
|
[**post_analytics_evaluations_aggregates_query**](QualityApi.html#post_analytics_evaluations_aggregates_query) | Query for evaluation aggregates
|
49
|
+
[**post_analytics_surveys_aggregates_query**](QualityApi.html#post_analytics_surveys_aggregates_query) | Query for survey aggregates
|
46
50
|
[**post_quality_calibrations**](QualityApi.html#post_quality_calibrations) | Create a calibration
|
47
51
|
[**post_quality_conversation_evaluations**](QualityApi.html#post_quality_conversation_evaluations) | Create an evaluation
|
48
52
|
[**post_quality_evaluations_scoring**](QualityApi.html#post_quality_evaluations_scoring) | Score evaluation
|
@@ -54,12 +58,14 @@ Method | Description
|
|
54
58
|
[**post_quality_publishedforms_evaluations**](QualityApi.html#post_quality_publishedforms_evaluations) | Publish an evaluation form.
|
55
59
|
[**post_quality_publishedforms_surveys**](QualityApi.html#post_quality_publishedforms_surveys) | Publish a survey form.
|
56
60
|
[**post_quality_spotability**](QualityApi.html#post_quality_spotability) | Retrieve the spotability statistic
|
61
|
+
[**post_quality_surveys_scoring**](QualityApi.html#post_quality_surveys_scoring) | Score survey
|
57
62
|
[**put_quality_calibration**](QualityApi.html#put_quality_calibration) | Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
|
58
63
|
[**put_quality_conversation_evaluation**](QualityApi.html#put_quality_conversation_evaluation) | Update an evaluation
|
59
64
|
[**put_quality_form**](QualityApi.html#put_quality_form) | Update an evaluation form.
|
60
65
|
[**put_quality_forms_evaluation**](QualityApi.html#put_quality_forms_evaluation) | Update an evaluation form.
|
61
66
|
[**put_quality_forms_survey**](QualityApi.html#put_quality_forms_survey) | Update a survey form.
|
62
67
|
[**put_quality_keywordset**](QualityApi.html#put_quality_keywordset) | Update a keywordSet to the specified keywordSet via PUT.
|
68
|
+
[**put_quality_surveys_scorable**](QualityApi.html#put_quality_surveys_scorable) | Update a survey as an end-customer, for the purposes of scoring it.
|
63
69
|
{: class="table table-striped"}
|
64
70
|
|
65
71
|
<a name="delete_quality_calibration"></a>
|
@@ -912,6 +918,70 @@ Name | Type | Description | Notes
|
|
912
918
|
|
913
919
|
|
914
920
|
|
921
|
+
<a name="get_quality_conversation_surveys"></a>
|
922
|
+
|
923
|
+
## -[**Array<Survey>**](Survey.html) get_quality_conversation_surveys(conversation_id)
|
924
|
+
|
925
|
+
|
926
|
+
|
927
|
+
Get the surveys for a conversation
|
928
|
+
|
929
|
+
|
930
|
+
|
931
|
+
Wraps GET /api/v2/quality/conversations/{conversationId}/surveys
|
932
|
+
|
933
|
+
Requires NO permissions:
|
934
|
+
|
935
|
+
|
936
|
+
|
937
|
+
### Example
|
938
|
+
~~~ruby
|
939
|
+
# load the gem
|
940
|
+
require 'purecloudplatformclientv2'
|
941
|
+
# setup authorization
|
942
|
+
@secret = ENV['PURECLOUD_SECRET']
|
943
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
944
|
+
environment = "mypurecloud.com"
|
945
|
+
|
946
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
947
|
+
|
948
|
+
PureCloud.configure do |config|
|
949
|
+
config.access_token = @authToken
|
950
|
+
end
|
951
|
+
|
952
|
+
api_instance = PureCloud::QualityApi.new
|
953
|
+
|
954
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
955
|
+
|
956
|
+
|
957
|
+
begin
|
958
|
+
#Get the surveys for a conversation
|
959
|
+
result = api_instance.get_quality_conversation_surveys(conversation_id)
|
960
|
+
p result
|
961
|
+
rescue PureCloud::ApiError => e
|
962
|
+
puts "Exception when calling QualityApi->get_quality_conversation_surveys: #{e}"
|
963
|
+
end
|
964
|
+
~~~
|
965
|
+
|
966
|
+
### Parameters
|
967
|
+
|
968
|
+
Name | Type | Description | Notes
|
969
|
+
------------- | ------------- | ------------- | -------------
|
970
|
+
**conversation_id** | **String**| conversationId | |
|
971
|
+
{: class="table table-striped"}
|
972
|
+
|
973
|
+
|
974
|
+
### Return type
|
975
|
+
|
976
|
+
[**Array<Survey>**](Survey.html)
|
977
|
+
|
978
|
+
### HTTP request headers
|
979
|
+
|
980
|
+
- **Content-Type**: application/json
|
981
|
+
- **Accept**: application/json
|
982
|
+
|
983
|
+
|
984
|
+
|
915
985
|
<a name="get_quality_evaluations_query"></a>
|
916
986
|
|
917
987
|
## -[**EvaluationEntityListing**](EvaluationEntityListing.html) get_quality_evaluations_query(opts)
|
@@ -2436,6 +2506,125 @@ Name | Type | Description | Notes
|
|
2436
2506
|
|
2437
2507
|
|
2438
2508
|
|
2509
|
+
<a name="get_quality_survey"></a>
|
2510
|
+
|
2511
|
+
## -[**Survey**](Survey.html) get_quality_survey(survey_id)
|
2512
|
+
|
2513
|
+
|
2514
|
+
|
2515
|
+
Get a survey for a conversation
|
2516
|
+
|
2517
|
+
|
2518
|
+
|
2519
|
+
Wraps GET /api/v2/quality/surveys/{surveyId}
|
2520
|
+
|
2521
|
+
Requires NO permissions:
|
2522
|
+
|
2523
|
+
|
2524
|
+
|
2525
|
+
### Example
|
2526
|
+
~~~ruby
|
2527
|
+
# load the gem
|
2528
|
+
require 'purecloudplatformclientv2'
|
2529
|
+
# setup authorization
|
2530
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2531
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2532
|
+
environment = "mypurecloud.com"
|
2533
|
+
|
2534
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2535
|
+
|
2536
|
+
PureCloud.configure do |config|
|
2537
|
+
config.access_token = @authToken
|
2538
|
+
end
|
2539
|
+
|
2540
|
+
api_instance = PureCloud::QualityApi.new
|
2541
|
+
|
2542
|
+
survey_id = "survey_id_example" # String | surveyId
|
2543
|
+
|
2544
|
+
|
2545
|
+
begin
|
2546
|
+
#Get a survey for a conversation
|
2547
|
+
result = api_instance.get_quality_survey(survey_id)
|
2548
|
+
p result
|
2549
|
+
rescue PureCloud::ApiError => e
|
2550
|
+
puts "Exception when calling QualityApi->get_quality_survey: #{e}"
|
2551
|
+
end
|
2552
|
+
~~~
|
2553
|
+
|
2554
|
+
### Parameters
|
2555
|
+
|
2556
|
+
Name | Type | Description | Notes
|
2557
|
+
------------- | ------------- | ------------- | -------------
|
2558
|
+
**survey_id** | **String**| surveyId | |
|
2559
|
+
{: class="table table-striped"}
|
2560
|
+
|
2561
|
+
|
2562
|
+
### Return type
|
2563
|
+
|
2564
|
+
[**Survey**](Survey.html)
|
2565
|
+
|
2566
|
+
### HTTP request headers
|
2567
|
+
|
2568
|
+
- **Content-Type**: application/json
|
2569
|
+
- **Accept**: application/json
|
2570
|
+
|
2571
|
+
|
2572
|
+
|
2573
|
+
<a name="get_quality_surveys_scorable"></a>
|
2574
|
+
|
2575
|
+
## -[**ScorableSurvey**](ScorableSurvey.html) get_quality_surveys_scorable(opts)
|
2576
|
+
|
2577
|
+
|
2578
|
+
|
2579
|
+
Get a survey as an end-customer, for the purposes of scoring it.
|
2580
|
+
|
2581
|
+
|
2582
|
+
|
2583
|
+
Wraps GET /api/v2/quality/surveys/scorable
|
2584
|
+
|
2585
|
+
Requires NO permissions:
|
2586
|
+
|
2587
|
+
|
2588
|
+
|
2589
|
+
### Example
|
2590
|
+
~~~ruby
|
2591
|
+
# load the gem
|
2592
|
+
require 'purecloudplatformclientv2'
|
2593
|
+
|
2594
|
+
api_instance = PureCloud::QualityApi.new
|
2595
|
+
|
2596
|
+
opts = {
|
2597
|
+
customer_survey_url: "customer_survey_url_example" # String | customerSurveyUrl
|
2598
|
+
}
|
2599
|
+
|
2600
|
+
begin
|
2601
|
+
#Get a survey as an end-customer, for the purposes of scoring it.
|
2602
|
+
result = api_instance.get_quality_surveys_scorable(opts)
|
2603
|
+
p result
|
2604
|
+
rescue PureCloud::ApiError => e
|
2605
|
+
puts "Exception when calling QualityApi->get_quality_surveys_scorable: #{e}"
|
2606
|
+
end
|
2607
|
+
~~~
|
2608
|
+
|
2609
|
+
### Parameters
|
2610
|
+
|
2611
|
+
Name | Type | Description | Notes
|
2612
|
+
------------- | ------------- | ------------- | -------------
|
2613
|
+
**customer_survey_url** | **String**| customerSurveyUrl | [optional] |
|
2614
|
+
{: class="table table-striped"}
|
2615
|
+
|
2616
|
+
|
2617
|
+
### Return type
|
2618
|
+
|
2619
|
+
[**ScorableSurvey**](ScorableSurvey.html)
|
2620
|
+
|
2621
|
+
### HTTP request headers
|
2622
|
+
|
2623
|
+
- **Content-Type**: application/json
|
2624
|
+
- **Accept**: application/json
|
2625
|
+
|
2626
|
+
|
2627
|
+
|
2439
2628
|
<a name="patch_quality_forms_survey"></a>
|
2440
2629
|
|
2441
2630
|
## -[**SurveyForm**](SurveyForm.html) patch_quality_forms_survey(form_id, body)
|
@@ -2569,6 +2758,71 @@ Name | Type | Description | Notes
|
|
2569
2758
|
|
2570
2759
|
|
2571
2760
|
|
2761
|
+
<a name="post_analytics_surveys_aggregates_query"></a>
|
2762
|
+
|
2763
|
+
## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_surveys_aggregates_query(body)
|
2764
|
+
|
2765
|
+
|
2766
|
+
|
2767
|
+
Query for survey aggregates
|
2768
|
+
|
2769
|
+
|
2770
|
+
|
2771
|
+
Wraps POST /api/v2/analytics/surveys/aggregates/query
|
2772
|
+
|
2773
|
+
Requires ANY permissions:
|
2774
|
+
|
2775
|
+
* analytics:surveyAggregate:view
|
2776
|
+
|
2777
|
+
|
2778
|
+
### Example
|
2779
|
+
~~~ruby
|
2780
|
+
# load the gem
|
2781
|
+
require 'purecloudplatformclientv2'
|
2782
|
+
# setup authorization
|
2783
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2784
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2785
|
+
environment = "mypurecloud.com"
|
2786
|
+
|
2787
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2788
|
+
|
2789
|
+
PureCloud.configure do |config|
|
2790
|
+
config.access_token = @authToken
|
2791
|
+
end
|
2792
|
+
|
2793
|
+
api_instance = PureCloud::QualityApi.new
|
2794
|
+
|
2795
|
+
body = PureCloud::AggregationQuery.new # AggregationQuery | query
|
2796
|
+
|
2797
|
+
|
2798
|
+
begin
|
2799
|
+
#Query for survey aggregates
|
2800
|
+
result = api_instance.post_analytics_surveys_aggregates_query(body)
|
2801
|
+
p result
|
2802
|
+
rescue PureCloud::ApiError => e
|
2803
|
+
puts "Exception when calling QualityApi->post_analytics_surveys_aggregates_query: #{e}"
|
2804
|
+
end
|
2805
|
+
~~~
|
2806
|
+
|
2807
|
+
### Parameters
|
2808
|
+
|
2809
|
+
Name | Type | Description | Notes
|
2810
|
+
------------- | ------------- | ------------- | -------------
|
2811
|
+
**body** | [**AggregationQuery**](AggregationQuery.html)| query | |
|
2812
|
+
{: class="table table-striped"}
|
2813
|
+
|
2814
|
+
|
2815
|
+
### Return type
|
2816
|
+
|
2817
|
+
[**AggregateQueryResponse**](AggregateQueryResponse.html)
|
2818
|
+
|
2819
|
+
### HTTP request headers
|
2820
|
+
|
2821
|
+
- **Content-Type**: application/json
|
2822
|
+
- **Accept**: application/json
|
2823
|
+
|
2824
|
+
|
2825
|
+
|
2572
2826
|
<a name="post_quality_calibrations"></a>
|
2573
2827
|
|
2574
2828
|
## -[**Calibration**](Calibration.html) post_quality_calibrations(body, opts)
|
@@ -3295,6 +3549,70 @@ Name | Type | Description | Notes
|
|
3295
3549
|
|
3296
3550
|
|
3297
3551
|
|
3552
|
+
<a name="post_quality_surveys_scoring"></a>
|
3553
|
+
|
3554
|
+
## -[**SurveyScoringSet**](SurveyScoringSet.html) post_quality_surveys_scoring(body)
|
3555
|
+
|
3556
|
+
|
3557
|
+
|
3558
|
+
Score survey
|
3559
|
+
|
3560
|
+
|
3561
|
+
|
3562
|
+
Wraps POST /api/v2/quality/surveys/scoring
|
3563
|
+
|
3564
|
+
Requires NO permissions:
|
3565
|
+
|
3566
|
+
|
3567
|
+
|
3568
|
+
### Example
|
3569
|
+
~~~ruby
|
3570
|
+
# load the gem
|
3571
|
+
require 'purecloudplatformclientv2'
|
3572
|
+
# setup authorization
|
3573
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3574
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3575
|
+
environment = "mypurecloud.com"
|
3576
|
+
|
3577
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3578
|
+
|
3579
|
+
PureCloud.configure do |config|
|
3580
|
+
config.access_token = @authToken
|
3581
|
+
end
|
3582
|
+
|
3583
|
+
api_instance = PureCloud::QualityApi.new
|
3584
|
+
|
3585
|
+
body = PureCloud::SurveyFormAndScoringSet.new # SurveyFormAndScoringSet | surveyAndScoringSet
|
3586
|
+
|
3587
|
+
|
3588
|
+
begin
|
3589
|
+
#Score survey
|
3590
|
+
result = api_instance.post_quality_surveys_scoring(body)
|
3591
|
+
p result
|
3592
|
+
rescue PureCloud::ApiError => e
|
3593
|
+
puts "Exception when calling QualityApi->post_quality_surveys_scoring: #{e}"
|
3594
|
+
end
|
3595
|
+
~~~
|
3596
|
+
|
3597
|
+
### Parameters
|
3598
|
+
|
3599
|
+
Name | Type | Description | Notes
|
3600
|
+
------------- | ------------- | ------------- | -------------
|
3601
|
+
**body** | [**SurveyFormAndScoringSet**](SurveyFormAndScoringSet.html)| surveyAndScoringSet | |
|
3602
|
+
{: class="table table-striped"}
|
3603
|
+
|
3604
|
+
|
3605
|
+
### Return type
|
3606
|
+
|
3607
|
+
[**SurveyScoringSet**](SurveyScoringSet.html)
|
3608
|
+
|
3609
|
+
### HTTP request headers
|
3610
|
+
|
3611
|
+
- **Content-Type**: application/json
|
3612
|
+
- **Accept**: application/json
|
3613
|
+
|
3614
|
+
|
3615
|
+
|
3298
3616
|
<a name="put_quality_calibration"></a>
|
3299
3617
|
|
3300
3618
|
## -[**Calibration**](Calibration.html) put_quality_calibration(calibration_id, body)
|
@@ -3707,3 +4025,61 @@ Name | Type | Description | Notes
|
|
3707
4025
|
|
3708
4026
|
|
3709
4027
|
|
4028
|
+
<a name="put_quality_surveys_scorable"></a>
|
4029
|
+
|
4030
|
+
## -[**ScorableSurvey**](ScorableSurvey.html) put_quality_surveys_scorable(body, opts)
|
4031
|
+
|
4032
|
+
|
4033
|
+
|
4034
|
+
Update a survey as an end-customer, for the purposes of scoring it.
|
4035
|
+
|
4036
|
+
|
4037
|
+
|
4038
|
+
Wraps PUT /api/v2/quality/surveys/scorable
|
4039
|
+
|
4040
|
+
Requires NO permissions:
|
4041
|
+
|
4042
|
+
|
4043
|
+
|
4044
|
+
### Example
|
4045
|
+
~~~ruby
|
4046
|
+
# load the gem
|
4047
|
+
require 'purecloudplatformclientv2'
|
4048
|
+
|
4049
|
+
api_instance = PureCloud::QualityApi.new
|
4050
|
+
|
4051
|
+
body = PureCloud::ScorableSurvey.new # ScorableSurvey | survey
|
4052
|
+
|
4053
|
+
opts = {
|
4054
|
+
customer_survey_url: "customer_survey_url_example" # String | customerSurveyUrl
|
4055
|
+
}
|
4056
|
+
|
4057
|
+
begin
|
4058
|
+
#Update a survey as an end-customer, for the purposes of scoring it.
|
4059
|
+
result = api_instance.put_quality_surveys_scorable(body, opts)
|
4060
|
+
p result
|
4061
|
+
rescue PureCloud::ApiError => e
|
4062
|
+
puts "Exception when calling QualityApi->put_quality_surveys_scorable: #{e}"
|
4063
|
+
end
|
4064
|
+
~~~
|
4065
|
+
|
4066
|
+
### Parameters
|
4067
|
+
|
4068
|
+
Name | Type | Description | Notes
|
4069
|
+
------------- | ------------- | ------------- | -------------
|
4070
|
+
**body** | [**ScorableSurvey**](ScorableSurvey.html)| survey | |
|
4071
|
+
**customer_survey_url** | **String**| customerSurveyUrl | [optional] |
|
4072
|
+
{: class="table table-striped"}
|
4073
|
+
|
4074
|
+
|
4075
|
+
### Return type
|
4076
|
+
|
4077
|
+
[**ScorableSurvey**](ScorableSurvey.html)
|
4078
|
+
|
4079
|
+
### HTTP request headers
|
4080
|
+
|
4081
|
+
- **Content-Type**: application/json
|
4082
|
+
- **Accept**: application/json
|
4083
|
+
|
4084
|
+
|
4085
|
+
|