purecloudplatformclientv2 44.0.0 → 45.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/ADFS.md +1 -1
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/AnalyticsSurvey.md +2 -1
- data/docs/ArchitectApi.md +52 -127
- data/docs/ContactListDivisionView.md +20 -0
- data/docs/ContactListDivisionViewListing.md +22 -0
- data/docs/ContactListNotification.md +1 -0
- data/docs/ConversationQuery.md +1 -1
- data/docs/CreateOutboundMessagingConversationRequest.md +1 -1
- data/docs/CreateWorkPlan.md +2 -0
- data/docs/CustomerInteractionCenter.md +1 -1
- data/docs/DataExportNotificationNotification.md +1 -0
- data/docs/DncListNotification.md +1 -0
- data/docs/DncListNotificationUriReference.md +14 -0
- data/docs/GSuite.md +1 -1
- data/docs/HelpLink.md +15 -0
- data/docs/IdentityNow.md +1 -1
- data/docs/IntegrationType.md +8 -0
- data/docs/IntradayDataUpdateNotification.md +2 -2
- data/docs/Okta.md +1 -1
- data/docs/OneLogin.md +1 -1
- data/docs/OutboundApi.md +152 -0
- data/docs/PingIdentity.md +1 -1
- data/docs/QualityApi.md +66 -0
- data/docs/ReportingExportJobResponse.md +1 -0
- data/docs/RoutingApi.md +74 -0
- data/docs/Salesforce.md +1 -1
- data/docs/UserScheduleAdherenceUpdateNotification.md +2 -2
- data/docs/WfmAgentScheduleUpdateNotificationNotification.md +18 -0
- data/docs/WfmAgentScheduleUpdateNotificationNotificationActivities.md +18 -0
- data/docs/WfmAgentScheduleUpdateNotificationNotificationFullDayTimeOffMarkers.md +19 -0
- data/docs/WfmAgentScheduleUpdateNotificationNotificationShifts.md +15 -0
- data/docs/WfmAgentScheduleUpdateNotificationNotificationUpdates.md +14 -0
- data/docs/WfmAgentScheduleUpdateNotificationNotificationUserReference.md +13 -0
- data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmAgentScheduleUpdate.md +14 -0
- data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmFullDayTimeOffMarker.md +19 -0
- data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmScheduleActivity.md +18 -0
- data/docs/WfmAgentScheduleUpdateNotificationNotificationWfmScheduleShift.md +15 -0
- data/docs/WfmScheduleNotificationNotification.md +1 -0
- data/docs/WorkPlan.md +2 -0
- data/docs/WorkPlanListItemResponse.md +16 -5
- data/docs/WorkforceManagementApi.md +2 -2
- data/lib/purecloudplatformclientv2.rb +14 -3
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +230 -0
- data/lib/purecloudplatformclientv2/api/quality_api.rb +66 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +100 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -7
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
- data/lib/purecloudplatformclientv2/models/analytics_survey.rb +34 -8
- data/lib/purecloudplatformclientv2/models/contact_list_division_view.rb +397 -0
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/contact_list_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_work_plan.rb +53 -1
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_export_notification_notification.rb +31 -6
- data/lib/purecloudplatformclientv2/models/dnc_list_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/dnc_list_notification_uri_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/document_audit.rb +2 -2
- data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{intraday_data_update_notification_date_time.rb → help_link.rb} +24 -45
- data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type.rb +211 -1
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_details.rb +2 -2
- data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
- data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +34 -3
- data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification.rb +332 -0
- data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_activities.rb +326 -0
- data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_full_day_time_off_markers.rb +351 -0
- data/lib/purecloudplatformclientv2/models/{intraday_data_update_notification_start_date.rb → wfm_agent_schedule_update_notification_notification_shifts.rb} +22 -45
- data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_updates.rb +242 -0
- data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_agent_schedule_update.rb +242 -0
- data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_full_day_time_off_marker.rb +351 -0
- data/lib/purecloudplatformclientv2/models/wfm_agent_schedule_update_notification_notification_wfm_schedule_activity.rb +326 -0
- data/lib/purecloudplatformclientv2/models/{user_schedule_adherence_update_notification_date_time.rb → wfm_agent_schedule_update_notification_notification_wfm_schedule_shift.rb} +22 -45
- data/lib/purecloudplatformclientv2/models/wfm_schedule_notification_notification.rb +28 -3
- data/lib/purecloudplatformclientv2/models/work_plan.rb +53 -1
- data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +313 -18
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +30 -8
- data/docs/IntradayDataUpdateNotificationDateTime.md +0 -16
- data/docs/IntradayDataUpdateNotificationStartDate.md +0 -16
- data/docs/UserScheduleAdherenceUpdateNotificationDateTime.md +0 -16
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ContactListDivisionView
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ContactListDivisionView
|
|
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
|
+
| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
|
|
13
|
+
| **column_names** | **Array<String>** | The names of the contact data columns. | |
|
|
14
|
+
| **phone_columns** | [**Array<ContactPhoneNumberColumn>**](ContactPhoneNumberColumn.html) | Indicates which columns are phone numbers. | |
|
|
15
|
+
| **import_status** | [**ImportStatus**](ImportStatus.html) | The status of the import process. | [optional] |
|
|
16
|
+
| **size** | **Integer** | The number of contacts in the ContactList. | [optional] |
|
|
17
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
18
|
+
{: class="table table-striped"}
|
|
19
|
+
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ContactListDivisionViewListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ContactListDivisionViewListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<ContactListDivisionView>**](ContactListDivisionView.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -21,6 +21,7 @@ title: ContactListNotification
|
|
|
21
21
|
| **attempt_limits** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
22
22
|
| **automatic_time_zone_mapping** | **BOOLEAN** | | [optional] |
|
|
23
23
|
| **zip_code_column_name** | **String** | | [optional] |
|
|
24
|
+
| **division** | [**ContactListNotificationUriReference**](ContactListNotificationUriReference.html) | | [optional] |
|
|
24
25
|
| **additional_properties** | **Object** | | [optional] |
|
|
25
26
|
{: class="table table-striped"}
|
|
26
27
|
|
data/docs/ConversationQuery.md
CHANGED
|
@@ -7,7 +7,7 @@ title: ConversationQuery
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **interval** | **String** | Specifies the date and time range of data being queried. Results will include conversations that started, ended, or
|
|
10
|
+
| **interval** | **String** | Specifies the date and time range of data being queried. Results will include conversations that both started on a day touched by the interval AND either started, ended, or any activity during the interval. Conversations that started before the earliest day of the interval will not be searched. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
|
|
11
11
|
| **conversation_filters** | [**Array<AnalyticsQueryFilter>**](AnalyticsQueryFilter.html) | Filters that target conversation-level data | [optional] |
|
|
12
12
|
| **evaluation_filters** | [**Array<AnalyticsQueryFilter>**](AnalyticsQueryFilter.html) | Filters that target quality management evaluation-level data | [optional] |
|
|
13
13
|
| **survey_filters** | [**Array<AnalyticsQueryFilter>**](AnalyticsQueryFilter.html) | Filters that target quality management survey-level data | [optional] |
|
|
@@ -8,7 +8,7 @@ title: CreateOutboundMessagingConversationRequest
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
10
|
| **queue_id** | **String** | The ID of the queue to be associated with the message. This will determine the fromAddress of the message. | |
|
|
11
|
-
| **to_address** | **String** | The messaging address of the recipient of the message. | |
|
|
11
|
+
| **to_address** | **String** | The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234 | |
|
|
12
12
|
| **to_address_messenger_type** | **String** | The messaging address messenger type. | |
|
|
13
13
|
| **use_existing_conversation** | **BOOLEAN** | An override to use an existing conversation. If set to true, an existing conversation will be used if there is one within the conversation window. If set to false, create request fails if there is a conversation within the conversation window. | [optional] |
|
|
14
14
|
| **external_contact_id** | **String** | The external contact Id of the recipient of the message. | [optional] |
|
data/docs/CreateWorkPlan.md
CHANGED
|
@@ -14,6 +14,8 @@ title: CreateWorkPlan
|
|
|
14
14
|
| **weekly_exact_paid_minutes** | **Integer** | Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false | [optional] |
|
|
15
15
|
| **weekly_minimum_paid_minutes** | **Integer** | Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | [optional] |
|
|
16
16
|
| **weekly_maximum_paid_minutes** | **Integer** | Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | [optional] |
|
|
17
|
+
| **constrain_paid_time_granularity** | **BOOLEAN** | Whether paid time granularity should be constrained for this workplan | [optional] |
|
|
18
|
+
| **paid_time_granularity_minutes** | **Integer** | Granularity in minutes allowed for shift paid time in this work plan. Used if constrainPaidTimeGranularity == true | [optional] |
|
|
17
19
|
| **constrain_minimum_time_between_shifts** | **BOOLEAN** | Whether the minimum time between shifts constraint is enabled for this work plan | [optional] |
|
|
18
20
|
| **minimum_time_between_shifts_minutes** | **Integer** | Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true | [optional] |
|
|
19
21
|
| **maximum_days** | **Integer** | Maximum number days in a week allowed to be scheduled for this work plan | [optional] |
|
|
@@ -10,8 +10,8 @@ title: CustomerInteractionCenter
|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **certificate** | **String** | | [optional] |
|
|
13
|
-
| **issuer_uri** | **String** | | [optional] |
|
|
14
13
|
| **sso_target_uri** | **String** | | [optional] |
|
|
14
|
+
| **issuer_uri** | **String** | | [optional] |
|
|
15
15
|
| **disabled** | **BOOLEAN** | | [optional] |
|
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
17
17
|
{: class="table table-striped"}
|
|
@@ -17,6 +17,7 @@ title: DataExportNotificationNotification
|
|
|
17
17
|
| **read** | **BOOLEAN** | | [optional] |
|
|
18
18
|
| **created_date_time** | **DateTime** | | [optional] |
|
|
19
19
|
| **modified_date_time** | **DateTime** | | [optional] |
|
|
20
|
+
| **percentage_complete** | **Float** | | [optional] |
|
|
20
21
|
{: class="table table-striped"}
|
|
21
22
|
|
|
22
23
|
|
data/docs/DncListNotification.md
CHANGED
|
@@ -18,6 +18,7 @@ title: DncListNotification
|
|
|
18
18
|
| **login_id** | **String** | | [optional] |
|
|
19
19
|
| **dnc_codes** | **Array<String>** | | [optional] |
|
|
20
20
|
| **license_id** | **String** | | [optional] |
|
|
21
|
+
| **division** | [**DocumentDataV2NotificationCreatedBy**](DocumentDataV2NotificationCreatedBy.html) | | [optional] |
|
|
21
22
|
| **additional_properties** | **Object** | | [optional] |
|
|
22
23
|
{: class="table table-striped"}
|
|
23
24
|
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: DncListNotificationUriReference
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::DncListNotificationUriReference
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/GSuite.md
CHANGED
|
@@ -11,8 +11,8 @@ title: GSuite
|
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **relying_party_identifier** | **String** | | [optional] |
|
|
13
13
|
| **certificate** | **String** | | [optional] |
|
|
14
|
-
| **issuer_uri** | **String** | | [optional] |
|
|
15
14
|
| **sso_target_uri** | **String** | | [optional] |
|
|
15
|
+
| **issuer_uri** | **String** | | [optional] |
|
|
16
16
|
| **disabled** | **BOOLEAN** | | [optional] |
|
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
18
18
|
{: class="table table-striped"}
|
data/docs/HelpLink.md
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: HelpLink
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::HelpLink
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **uri** | **String** | URI of the help resource | [optional] |
|
|
11
|
+
| **title** | **String** | Link text of the resource | [optional] |
|
|
12
|
+
| **description** | **String** | Description of the document or resource | [optional] |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
data/docs/IdentityNow.md
CHANGED
|
@@ -11,8 +11,8 @@ title: IdentityNow
|
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **relying_party_identifier** | **String** | | [optional] |
|
|
13
13
|
| **certificate** | **String** | | [optional] |
|
|
14
|
-
| **issuer_uri** | **String** | | [optional] |
|
|
15
14
|
| **sso_target_uri** | **String** | | [optional] |
|
|
15
|
+
| **issuer_uri** | **String** | | [optional] |
|
|
16
16
|
| **disabled** | **BOOLEAN** | | [optional] |
|
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
18
18
|
{: class="table table-striped"}
|
data/docs/IntegrationType.md
CHANGED
|
@@ -17,6 +17,14 @@ title: IntegrationType
|
|
|
17
17
|
| **config_advanced_schema_uri** | **String** | URI of the schema describing the advanced JSON document needed to configure an integration of this type. | [optional] |
|
|
18
18
|
| **help_uri** | **String** | URI of a page with more information about the integration type | [optional] |
|
|
19
19
|
| **terms_of_service_uri** | **String** | URI of a page with terms and conditions for the integration type | [optional] |
|
|
20
|
+
| **vendor_name** | **String** | Name of the vendor of this integration type | [optional] |
|
|
21
|
+
| **vendor_website_uri** | **String** | URI of the vendor's website | [optional] |
|
|
22
|
+
| **marketplace_uri** | **String** | URI of the marketplace listing for this integration type | [optional] |
|
|
23
|
+
| **faq_uri** | **String** | URI of frequently asked questions about the integration type | [optional] |
|
|
24
|
+
| **privacy_policy_uri** | **String** | URI of a privacy policy for users of the integration type | [optional] |
|
|
25
|
+
| **support_contact_uri** | **String** | URI for vendor support | [optional] |
|
|
26
|
+
| **sales_contact_uri** | **String** | URI for vendor sales information | [optional] |
|
|
27
|
+
| **help_links** | [**Array<HelpLink>**](HelpLink.html) | List of links to additional help resources | [optional] |
|
|
20
28
|
| **credentials** | [**Hash<String, CredentialSpecification>**](CredentialSpecification.html) | Map of credentials for integrations of this type. The key is the name of a credential that can be provided in the credentials property of the integration configuration. | [optional] |
|
|
21
29
|
| **non_installable** | **BOOLEAN** | Indicates if the integration type is installable or not. | [optional] |
|
|
22
30
|
| **max_instances** | **Integer** | The maximum number of integration instances allowable for this integration type | [optional] |
|
|
@@ -7,8 +7,8 @@ title: IntradayDataUpdateNotification
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **start_date** |
|
|
11
|
-
| **end_date** |
|
|
10
|
+
| **start_date** | **DateTime** | | [optional] |
|
|
11
|
+
| **end_date** | **DateTime** | | [optional] |
|
|
12
12
|
| **interval_length_minutes** | **Integer** | | [optional] |
|
|
13
13
|
| **number_of_intervals** | **Integer** | | [optional] |
|
|
14
14
|
| **metrics** | [**Array<IntradayDataUpdateNotificationMetrics>**](IntradayDataUpdateNotificationMetrics.html) | | [optional] |
|
data/docs/Okta.md
CHANGED
|
@@ -10,8 +10,8 @@ title: Okta
|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **certificate** | **String** | | [optional] |
|
|
13
|
-
| **issuer_uri** | **String** | | [optional] |
|
|
14
13
|
| **sso_target_uri** | **String** | | [optional] |
|
|
14
|
+
| **issuer_uri** | **String** | | [optional] |
|
|
15
15
|
| **disabled** | **BOOLEAN** | | [optional] |
|
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
17
17
|
{: class="table table-striped"}
|
data/docs/OneLogin.md
CHANGED
|
@@ -10,8 +10,8 @@ title: OneLogin
|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **certificate** | **String** | | [optional] |
|
|
13
|
-
| **issuer_uri** | **String** | | [optional] |
|
|
14
13
|
| **sso_target_uri** | **String** | | [optional] |
|
|
14
|
+
| **issuer_uri** | **String** | | [optional] |
|
|
15
15
|
| **disabled** | **BOOLEAN** | | [optional] |
|
|
16
16
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
17
17
|
{: class="table table-striped"}
|
data/docs/OutboundApi.md
CHANGED
|
@@ -47,6 +47,7 @@ Method | Description
|
|
|
47
47
|
[**get_outbound_contactlistfilter**](OutboundApi.html#get_outbound_contactlistfilter) | Get Contact list filter
|
|
48
48
|
[**get_outbound_contactlistfilters**](OutboundApi.html#get_outbound_contactlistfilters) | Query Contact list filters
|
|
49
49
|
[**get_outbound_contactlists**](OutboundApi.html#get_outbound_contactlists) | Query a list of contact lists.
|
|
50
|
+
[**get_outbound_contactlists_divisionviews**](OutboundApi.html#get_outbound_contactlists_divisionviews) | Query a list of simplified contact list objects.
|
|
50
51
|
[**get_outbound_dnclist**](OutboundApi.html#get_outbound_dnclist) | Get dialer DNC list
|
|
51
52
|
[**get_outbound_dnclist_export**](OutboundApi.html#get_outbound_dnclist_export) | Get the URI of a DNC list export.
|
|
52
53
|
[**get_outbound_dnclist_importstatus**](OutboundApi.html#get_outbound_dnclist_importstatus) | Get dialer dncList import status.
|
|
@@ -72,6 +73,7 @@ Method | Description
|
|
|
72
73
|
[**post_outbound_campaignrules**](OutboundApi.html#post_outbound_campaignrules) | Create Campaign Rule
|
|
73
74
|
[**post_outbound_campaigns**](OutboundApi.html#post_outbound_campaigns) | Create a campaign.
|
|
74
75
|
[**post_outbound_campaigns_progress**](OutboundApi.html#post_outbound_campaigns_progress) | Get progress for a list of campaigns
|
|
76
|
+
[**post_outbound_contactlist_clear**](OutboundApi.html#post_outbound_contactlist_clear) | Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
|
|
75
77
|
[**post_outbound_contactlist_contacts**](OutboundApi.html#post_outbound_contactlist_contacts) | Add contacts to a contact list.
|
|
76
78
|
[**post_outbound_contactlist_contacts_bulk**](OutboundApi.html#post_outbound_contactlist_contacts_bulk) | Get contacts from a contact list.
|
|
77
79
|
[**post_outbound_contactlist_export**](OutboundApi.html#post_outbound_contactlist_export) | Initiate the export of a contact list.
|
|
@@ -2753,6 +2755,88 @@ Name | Type | Description | Notes
|
|
|
2753
2755
|
|
|
2754
2756
|
|
|
2755
2757
|
|
|
2758
|
+
<a name="get_outbound_contactlists_divisionviews"></a>
|
|
2759
|
+
|
|
2760
|
+
## -[**ContactListDivisionViewListing**](ContactListDivisionViewListing.html) get_outbound_contactlists_divisionviews(opts)
|
|
2761
|
+
|
|
2762
|
+
|
|
2763
|
+
|
|
2764
|
+
Query a list of simplified contact list objects.
|
|
2765
|
+
|
|
2766
|
+
This return a simplified version of contact lists, consisting of the name, divisions, columns, and phone columns.
|
|
2767
|
+
|
|
2768
|
+
Wraps GET /api/v2/outbound/contactlists/divisionviews
|
|
2769
|
+
|
|
2770
|
+
Requires ANY permissions:
|
|
2771
|
+
|
|
2772
|
+
* outbound:contactList:search
|
|
2773
|
+
|
|
2774
|
+
|
|
2775
|
+
### Example
|
|
2776
|
+
~~~ruby
|
|
2777
|
+
# load the gem
|
|
2778
|
+
require 'purecloudplatformclientv2'
|
|
2779
|
+
# setup authorization
|
|
2780
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2781
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2782
|
+
environment = "mypurecloud.com"
|
|
2783
|
+
|
|
2784
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2785
|
+
|
|
2786
|
+
PureCloud.configure do |config|
|
|
2787
|
+
config.access_token = @authToken
|
|
2788
|
+
end
|
|
2789
|
+
|
|
2790
|
+
api_instance = PureCloud::OutboundApi.new
|
|
2791
|
+
|
|
2792
|
+
opts = {
|
|
2793
|
+
include_import_status: false, # BOOLEAN | Include import status
|
|
2794
|
+
include_size: false, # BOOLEAN | Include size
|
|
2795
|
+
page_size: 25, # Integer | Page size. The max that will be returned is 100.
|
|
2796
|
+
page_number: 1, # Integer | Page number
|
|
2797
|
+
filter_type: "Prefix", # String | Filter type
|
|
2798
|
+
name: "name_example", # String | Name
|
|
2799
|
+
id: ["id_example"], # Array<String> | id
|
|
2800
|
+
sort_by: "sort_by_example", # String | Sort by
|
|
2801
|
+
sort_order: "a" # String | Sort order
|
|
2802
|
+
}
|
|
2803
|
+
|
|
2804
|
+
begin
|
|
2805
|
+
#Query a list of simplified contact list objects.
|
|
2806
|
+
result = api_instance.get_outbound_contactlists_divisionviews(opts)
|
|
2807
|
+
p result
|
|
2808
|
+
rescue PureCloud::ApiError => e
|
|
2809
|
+
puts "Exception when calling OutboundApi->get_outbound_contactlists_divisionviews: #{e}"
|
|
2810
|
+
end
|
|
2811
|
+
~~~
|
|
2812
|
+
|
|
2813
|
+
### Parameters
|
|
2814
|
+
|
|
2815
|
+
Name | Type | Description | Notes
|
|
2816
|
+
------------- | ------------- | ------------- | -------------
|
|
2817
|
+
**include_import_status** | **BOOLEAN**| Include import status | [optional] [default to false] |
|
|
2818
|
+
**include_size** | **BOOLEAN**| Include size | [optional] [default to false] |
|
|
2819
|
+
**page_size** | **Integer**| Page size. The max that will be returned is 100. | [optional] [default to 25] |
|
|
2820
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2821
|
+
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
2822
|
+
**name** | **String**| Name | [optional] |
|
|
2823
|
+
**id** | [**Array<String>**](String.html)| id | [optional] |
|
|
2824
|
+
**sort_by** | **String**| Sort by | [optional] |
|
|
2825
|
+
**sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending |
|
|
2826
|
+
{: class="table table-striped"}
|
|
2827
|
+
|
|
2828
|
+
|
|
2829
|
+
### Return type
|
|
2830
|
+
|
|
2831
|
+
[**ContactListDivisionViewListing**](ContactListDivisionViewListing.html)
|
|
2832
|
+
|
|
2833
|
+
### HTTP request headers
|
|
2834
|
+
|
|
2835
|
+
- **Content-Type**: application/json
|
|
2836
|
+
- **Accept**: application/json
|
|
2837
|
+
|
|
2838
|
+
|
|
2839
|
+
|
|
2756
2840
|
<a name="get_outbound_dnclist"></a>
|
|
2757
2841
|
|
|
2758
2842
|
## -[**DncList**](DncList.html) get_outbound_dnclist(dnc_list_id, opts)
|
|
@@ -3000,6 +3084,8 @@ opts = {
|
|
|
3000
3084
|
page_number: 1, # Integer | Page number
|
|
3001
3085
|
filter_type: "Prefix", # String | Filter type
|
|
3002
3086
|
name: "name_example", # String | Name
|
|
3087
|
+
dnc_source_type: "dnc_source_type_example", # String | DncSourceType
|
|
3088
|
+
division_id: ["division_id_example"], # Array<String> | Division ID(s)
|
|
3003
3089
|
sort_by: "sort_by_example", # String | Sort by
|
|
3004
3090
|
sort_order: "sort_order_example" # String | Sort order
|
|
3005
3091
|
}
|
|
@@ -3023,6 +3109,8 @@ Name | Type | Description | Notes
|
|
|
3023
3109
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
3024
3110
|
**filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
|
|
3025
3111
|
**name** | **String**| Name | [optional] |
|
|
3112
|
+
**dnc_source_type** | **String**| DncSourceType | [optional] <br />**Values**: rds, dnc.com, gryphon |
|
|
3113
|
+
**division_id** | [**Array<String>**](String.html)| Division ID(s) | [optional] |
|
|
3026
3114
|
**sort_by** | **String**| Sort by | [optional] |
|
|
3027
3115
|
**sort_order** | **String**| Sort order | [optional] <br />**Values**: ascending, descending |
|
|
3028
3116
|
{: class="table table-striped"}
|
|
@@ -4428,6 +4516,70 @@ Name | Type | Description | Notes
|
|
|
4428
4516
|
|
|
4429
4517
|
|
|
4430
4518
|
|
|
4519
|
+
<a name="post_outbound_contactlist_clear"></a>
|
|
4520
|
+
|
|
4521
|
+
## - post_outbound_contactlist_clear(contact_list_id)
|
|
4522
|
+
|
|
4523
|
+
|
|
4524
|
+
|
|
4525
|
+
Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
|
|
4526
|
+
|
|
4527
|
+
|
|
4528
|
+
|
|
4529
|
+
Wraps POST /api/v2/outbound/contactlists/{contactListId}/clear
|
|
4530
|
+
|
|
4531
|
+
Requires ANY permissions:
|
|
4532
|
+
|
|
4533
|
+
* outbound:contact:delete
|
|
4534
|
+
|
|
4535
|
+
|
|
4536
|
+
### Example
|
|
4537
|
+
~~~ruby
|
|
4538
|
+
# load the gem
|
|
4539
|
+
require 'purecloudplatformclientv2'
|
|
4540
|
+
# setup authorization
|
|
4541
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
4542
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
4543
|
+
environment = "mypurecloud.com"
|
|
4544
|
+
|
|
4545
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
4546
|
+
|
|
4547
|
+
PureCloud.configure do |config|
|
|
4548
|
+
config.access_token = @authToken
|
|
4549
|
+
end
|
|
4550
|
+
|
|
4551
|
+
api_instance = PureCloud::OutboundApi.new
|
|
4552
|
+
|
|
4553
|
+
contact_list_id = "contact_list_id_example" # String | Contact List ID
|
|
4554
|
+
|
|
4555
|
+
|
|
4556
|
+
begin
|
|
4557
|
+
#Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
|
|
4558
|
+
api_instance.post_outbound_contactlist_clear(contact_list_id)
|
|
4559
|
+
rescue PureCloud::ApiError => e
|
|
4560
|
+
puts "Exception when calling OutboundApi->post_outbound_contactlist_clear: #{e}"
|
|
4561
|
+
end
|
|
4562
|
+
~~~
|
|
4563
|
+
|
|
4564
|
+
### Parameters
|
|
4565
|
+
|
|
4566
|
+
Name | Type | Description | Notes
|
|
4567
|
+
------------- | ------------- | ------------- | -------------
|
|
4568
|
+
**contact_list_id** | **String**| Contact List ID | |
|
|
4569
|
+
{: class="table table-striped"}
|
|
4570
|
+
|
|
4571
|
+
|
|
4572
|
+
### Return type
|
|
4573
|
+
|
|
4574
|
+
nil (empty response body)
|
|
4575
|
+
|
|
4576
|
+
### HTTP request headers
|
|
4577
|
+
|
|
4578
|
+
- **Content-Type**: application/json
|
|
4579
|
+
- **Accept**: application/json
|
|
4580
|
+
|
|
4581
|
+
|
|
4582
|
+
|
|
4431
4583
|
<a name="post_outbound_contactlist_contacts"></a>
|
|
4432
4584
|
|
|
4433
4585
|
## -[**Array<DialerContact>**](DialerContact.html) post_outbound_contactlist_contacts(contact_list_id, body, opts)
|
data/docs/PingIdentity.md
CHANGED
|
@@ -11,8 +11,8 @@ title: PingIdentity
|
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **relying_party_identifier** | **String** | | [optional] |
|
|
13
13
|
| **certificate** | **String** | | [optional] |
|
|
14
|
-
| **issuer_uri** | **String** | | [optional] |
|
|
15
14
|
| **sso_target_uri** | **String** | | [optional] |
|
|
15
|
+
| **issuer_uri** | **String** | | [optional] |
|
|
16
16
|
| **disabled** | **BOOLEAN** | | [optional] |
|
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
18
18
|
{: class="table table-striped"}
|
data/docs/QualityApi.md
CHANGED
|
@@ -31,6 +31,7 @@ Method | Description
|
|
|
31
31
|
[**get_quality_forms_survey**](QualityApi.html#get_quality_forms_survey) | Get a survey form
|
|
32
32
|
[**get_quality_forms_survey_versions**](QualityApi.html#get_quality_forms_survey_versions) | Gets all the revisions for a specific survey.
|
|
33
33
|
[**get_quality_forms_surveys**](QualityApi.html#get_quality_forms_surveys) | Get the list of survey forms
|
|
34
|
+
[**get_quality_forms_surveys_bulk**](QualityApi.html#get_quality_forms_surveys_bulk) | Retrieve a list of survey forms by their ids
|
|
34
35
|
[**get_quality_keywordset**](QualityApi.html#get_quality_keywordset) | Get a keywordSet by id.
|
|
35
36
|
[**get_quality_keywordsets**](QualityApi.html#get_quality_keywordsets) | Get the list of keyword sets
|
|
36
37
|
[**get_quality_publishedform**](QualityApi.html#get_quality_publishedform) | Get the published evaluation forms.
|
|
@@ -1736,6 +1737,71 @@ Name | Type | Description | Notes
|
|
|
1736
1737
|
|
|
1737
1738
|
|
|
1738
1739
|
|
|
1740
|
+
<a name="get_quality_forms_surveys_bulk"></a>
|
|
1741
|
+
|
|
1742
|
+
## -[**SurveyFormEntityListing**](SurveyFormEntityListing.html) get_quality_forms_surveys_bulk(ids)
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
Retrieve a list of survey forms by their ids
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
Wraps GET /api/v2/quality/forms/surveys/bulk
|
|
1751
|
+
|
|
1752
|
+
Requires ANY permissions:
|
|
1753
|
+
|
|
1754
|
+
* quality:surveyForm:view
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
### Example
|
|
1758
|
+
~~~ruby
|
|
1759
|
+
# load the gem
|
|
1760
|
+
require 'purecloudplatformclientv2'
|
|
1761
|
+
# setup authorization
|
|
1762
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1763
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1764
|
+
environment = "mypurecloud.com"
|
|
1765
|
+
|
|
1766
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1767
|
+
|
|
1768
|
+
PureCloud.configure do |config|
|
|
1769
|
+
config.access_token = @authToken
|
|
1770
|
+
end
|
|
1771
|
+
|
|
1772
|
+
api_instance = PureCloud::QualityApi.new
|
|
1773
|
+
|
|
1774
|
+
ids = ["ids_example"] # Array<String> | A comma-delimited list of valid survey form ids
|
|
1775
|
+
|
|
1776
|
+
|
|
1777
|
+
begin
|
|
1778
|
+
#Retrieve a list of survey forms by their ids
|
|
1779
|
+
result = api_instance.get_quality_forms_surveys_bulk(ids)
|
|
1780
|
+
p result
|
|
1781
|
+
rescue PureCloud::ApiError => e
|
|
1782
|
+
puts "Exception when calling QualityApi->get_quality_forms_surveys_bulk: #{e}"
|
|
1783
|
+
end
|
|
1784
|
+
~~~
|
|
1785
|
+
|
|
1786
|
+
### Parameters
|
|
1787
|
+
|
|
1788
|
+
Name | Type | Description | Notes
|
|
1789
|
+
------------- | ------------- | ------------- | -------------
|
|
1790
|
+
**ids** | [**Array<String>**](String.html)| A comma-delimited list of valid survey form ids | |
|
|
1791
|
+
{: class="table table-striped"}
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
### Return type
|
|
1795
|
+
|
|
1796
|
+
[**SurveyFormEntityListing**](SurveyFormEntityListing.html)
|
|
1797
|
+
|
|
1798
|
+
### HTTP request headers
|
|
1799
|
+
|
|
1800
|
+
- **Content-Type**: application/json
|
|
1801
|
+
- **Accept**: application/json
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
|
|
1739
1805
|
<a name="get_quality_keywordset"></a>
|
|
1740
1806
|
|
|
1741
1807
|
## -[**KeywordSet**](KeywordSet.html) get_quality_keywordset(keyword_set_id)
|