purecloud 0.59.1 → 0.60.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +3 -3
- data/config-ruby.json +1 -1
- data/doc_out/AgentActivityEntityListing.html.md +2 -2
- data/doc_out/AggregationQuery.html.md +1 -1
- data/doc_out/AlertingApi.html.md +1106 -92
- data/doc_out/Annotation.html.md +14 -4
- data/doc_out/AttemptLimitsEntityListing.html.md +2 -2
- data/doc_out/AttributeEntityListing.html.md +2 -2
- data/doc_out/CalibrationEntityListing.html.md +2 -2
- data/doc_out/CallConversationEntityListing.html.md +2 -2
- data/doc_out/CallableTimeSetEntityListing.html.md +2 -2
- data/doc_out/CallbackConversationEntityListing.html.md +2 -2
- data/doc_out/CampaignEntityListing.html.md +2 -2
- data/doc_out/CampaignSequenceEntityListing.html.md +2 -2
- data/doc_out/CertificateAuthorityEntityListing.html.md +2 -2
- data/doc_out/ChannelEntityListing.html.md +2 -2
- data/doc_out/ChatConversationEntityListing.html.md +2 -2
- data/doc_out/CobrowseConversationEntityListing.html.md +2 -2
- data/doc_out/CommandStatusEntityListing.html.md +2 -2
- data/doc_out/ContactListEntityListing.html.md +2 -2
- data/doc_out/ContactSort.html.md +1 -1
- data/doc_out/ConversationEntityListing.html.md +2 -2
- data/doc_out/DIDEntityListing.html.md +2 -2
- data/doc_out/DIDPoolEntityListing.html.md +2 -2
- data/doc_out/DncListEntityListing.html.md +2 -2
- data/doc_out/DocumentAuditEntityListing.html.md +2 -2
- data/doc_out/DocumentEntityListing.html.md +2 -2
- data/doc_out/DomainEdgeSoftwareVersionDtoEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListing.html.md +2 -2
- data/doc_out/DomainEntityListingEvaluationForm.html.md +2 -2
- data/doc_out/DomainEntityListingQueryResult.html.md +2 -2
- data/doc_out/Edge.html.md +1 -1
- data/doc_out/EdgeEntityListing.html.md +2 -2
- data/doc_out/EdgeGroupEntityListing.html.md +2 -2
- data/doc_out/EdgeLineEntityListing.html.md +2 -2
- data/doc_out/EmailConversationEntityListing.html.md +2 -2
- data/doc_out/EmailMessageListing.html.md +2 -2
- data/doc_out/EncryptionKeyEntityListing.html.md +2 -2
- data/doc_out/EndpointEntityListing.html.md +2 -2
- data/doc_out/EvaluationEntityListing.html.md +2 -2
- data/doc_out/EvaluationFormEntityListing.html.md +2 -2
- data/doc_out/EvaluatorActivityEntityListing.html.md +2 -2
- data/doc_out/ExtensionEntityListing.html.md +2 -2
- data/doc_out/ExtensionPoolEntityListing.html.md +2 -2
- data/doc_out/FaxDocumentEntityListing.html.md +2 -2
- data/doc_out/GroupEntityListing.html.md +2 -2
- data/doc_out/HeartBeatAlert.html.md +1 -1
- data/doc_out/HeartBeatAlertContainer.html.md +2 -2
- data/doc_out/HeartBeatRule.html.md +1 -1
- data/doc_out/HeartBeatRuleContainer.html.md +2 -2
- data/doc_out/InboundDomainEntityListing.html.md +2 -2
- data/doc_out/InboundRouteEntityListing.html.md +2 -2
- data/doc_out/InteractionStatsAlert.html.md +1 -1
- data/doc_out/InteractionStatsAlertContainer.html.md +2 -2
- data/doc_out/InteractionStatsRule.html.md +1 -1
- data/doc_out/InteractionStatsRuleContainer.html.md +2 -2
- data/doc_out/KeywordSetEntityListing.html.md +2 -2
- data/doc_out/LanguageEntityListing.html.md +2 -2
- data/doc_out/LibraryEntityListing.html.md +2 -2
- data/doc_out/LineBaseEntityListing.html.md +2 -2
- data/doc_out/LineEntityListing.html.md +2 -2
- data/doc_out/LocalEncryptionConfigurationListing.html.md +2 -2
- data/doc_out/LogicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/OAuthClient.html.md +2 -2
- data/doc_out/OAuthClientEntityListing.html.md +3 -3
- data/doc_out/OAuthClientListing.html.md +20 -0
- data/doc_out/OAuthProviderEntityListing.html.md +2 -2
- data/doc_out/OrganizationPresenceEntityListing.html.md +2 -2
- data/doc_out/OrganizationRoleEntityListing.html.md +2 -2
- data/doc_out/OrphanRecording.html.md +1 -0
- data/doc_out/OrphanRecordingListing.html.md +2 -2
- data/doc_out/OrphanUpdateRequest.html.md +15 -0
- data/doc_out/OutboundRouteEntityListing.html.md +2 -2
- data/doc_out/PermissionCollectionEntityListing.html.md +2 -2
- data/doc_out/PhoneBaseEntityListing.html.md +2 -2
- data/doc_out/PhoneEntityListing.html.md +2 -2
- data/doc_out/PhoneMetaBaseEntityListing.html.md +2 -2
- data/doc_out/PhysicalInterfaceEntityListing.html.md +2 -2
- data/doc_out/PolicyEntityListing.html.md +2 -2
- data/doc_out/QualityApi.html.md +5 -1
- data/doc_out/QualityAuditPage.html.md +2 -2
- data/doc_out/QueueEntityListing.html.md +2 -2
- data/doc_out/QueueMemberEntityListing.html.md +2 -2
- data/doc_out/RecordingApi.html.md +132 -4
- data/doc_out/ReportMetaDataEntityListing.html.md +2 -2
- data/doc_out/ReportRunEntryEntityDomainListing.html.md +2 -2
- data/doc_out/ReportScheduleEntityListing.html.md +2 -2
- data/doc_out/ResponseEntityList.html.md +2 -2
- data/doc_out/ResponseEntityListing.html.md +2 -2
- data/doc_out/ResponseSetEntityListing.html.md +2 -2
- data/doc_out/RoutingStatusAlert.html.md +23 -0
- data/doc_out/RoutingStatusAlertContainer.html.md +22 -0
- data/doc_out/RoutingStatusRule.html.md +22 -0
- data/doc_out/RoutingStatusRuleContainer.html.md +22 -0
- data/doc_out/RuleSetEntityListing.html.md +2 -2
- data/doc_out/SchemaCategoryEntityListing.html.md +2 -2
- data/doc_out/SchemaReferenceEntityListing.html.md +2 -2
- data/doc_out/ScreenRecordingSessionListing.html.md +2 -2
- data/doc_out/ScriptEntityListing.html.md +2 -2
- data/doc_out/SecurityProfileEntityListing.html.md +2 -2
- data/doc_out/ShareEntityListing.html.md +2 -2
- data/doc_out/SiteEntityListing.html.md +2 -2
- data/doc_out/SkillEntityListing.html.md +2 -2
- data/doc_out/StationEntityListing.html.md +2 -2
- data/doc_out/StreetAddress.html.md +2 -2
- data/doc_out/TagValueEntityListing.html.md +2 -2
- data/doc_out/TelephonyProvidersEdgeApi.html.md +21 -17
- data/doc_out/TimeZoneEntityListing.html.md +2 -2
- data/doc_out/TrunkBaseEntityListing.html.md +2 -2
- data/doc_out/TrunkEntityListing.html.md +2 -2
- data/doc_out/TrunkMetabaseEntityListing.html.md +2 -2
- data/doc_out/UserEntityListing.html.md +2 -2
- data/doc_out/UserPresenceAlert.html.md +25 -0
- data/doc_out/UserPresenceAlertContainer.html.md +22 -0
- data/doc_out/UserPresenceRule.html.md +23 -0
- data/doc_out/{UsersEntityListing.html.md → UserPresenceRuleContainer.html.md} +5 -5
- data/doc_out/UserQueueEntityListing.html.md +2 -2
- data/doc_out/UserRecordingEntityListing.html.md +2 -2
- data/doc_out/UserSkillEntityListing.html.md +2 -2
- data/doc_out/UsersApi.html.md +2 -2
- data/doc_out/WorkspaceEntityListing.html.md +2 -2
- data/doc_out/WorkspaceMemberEntityListing.html.md +2 -2
- data/doc_out/WrapupCodeEntityListing.html.md +2 -2
- data/doc_out/index.html.md +3 -3
- data/lib/purecloud.rb +10 -1
- data/lib/purecloud/api/alerting_api.rb +1070 -49
- data/lib/purecloud/api/quality_api.rb +6 -0
- data/lib/purecloud/api/recording_api.rb +140 -2
- data/lib/purecloud/api/telephony_providers_edge_api.rb +13 -10
- data/lib/purecloud/api/users_api.rb +3 -3
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/aggregation_query.rb +1 -1
- data/lib/purecloud/models/annotation.rb +115 -1
- data/lib/purecloud/models/attempt_limits_entity_listing.rb +17 -17
- data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
- data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
- data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
- data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
- data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
- data/lib/purecloud/models/channel_entity_listing.rb +17 -17
- data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/cobrowse_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/contact_sort.rb +1 -0
- data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_entity_listing.rb +17 -17
- data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
- data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
- data/lib/purecloud/models/document_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_edge_software_version_dto_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
- data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
- data/lib/purecloud/models/edge.rb +2 -1
- data/lib/purecloud/models/edge_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
- data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
- data/lib/purecloud/models/email_message_listing.rb +17 -17
- data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
- data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
- data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_entity_listing.rb +17 -17
- data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
- data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
- data/lib/purecloud/models/group_entity_listing.rb +17 -17
- data/lib/purecloud/models/group_search_criteria.rb +1 -1
- data/lib/purecloud/models/heart_beat_alert.rb +1 -1
- data/lib/purecloud/models/heart_beat_alert_container.rb +17 -17
- data/lib/purecloud/models/heart_beat_rule.rb +1 -1
- data/lib/purecloud/models/heart_beat_rule_container.rb +17 -17
- data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
- data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/interaction_stats_alert.rb +1 -1
- data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
- data/lib/purecloud/models/interaction_stats_rule.rb +1 -1
- data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
- data/lib/purecloud/models/keyword_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/language_entity_listing.rb +17 -17
- data/lib/purecloud/models/library_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/line_entity_listing.rb +17 -17
- data/lib/purecloud/models/local_encryption_configuration_listing.rb +17 -17
- data/lib/purecloud/models/location_search_criteria.rb +1 -1
- data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/o_auth_client_entity_listing.rb +18 -18
- data/lib/purecloud/models/o_auth_client_listing.rb +246 -0
- data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
- data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
- data/lib/purecloud/models/orphan_recording.rb +21 -1
- data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
- data/lib/purecloud/models/orphan_update_request.rb +188 -0
- data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
- data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_entity_listing.rb +17 -17
- data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
- data/lib/purecloud/models/policy_entity_listing.rb +17 -17
- data/lib/purecloud/models/quality_audit_page.rb +17 -17
- data/lib/purecloud/models/queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/queue_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
- data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
- data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_entity_list.rb +17 -17
- data/lib/purecloud/models/response_entity_listing.rb +17 -17
- data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/routing_status_alert.rb +289 -0
- data/lib/purecloud/models/routing_status_alert_container.rb +257 -0
- data/lib/purecloud/models/routing_status_rule.rb +282 -0
- data/lib/purecloud/models/routing_status_rule_container.rb +257 -0
- data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
- data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
- data/lib/purecloud/models/screen_recording_session_listing.rb +17 -17
- data/lib/purecloud/models/script_entity_listing.rb +17 -17
- data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
- data/lib/purecloud/models/share_entity_listing.rb +17 -17
- data/lib/purecloud/models/site_entity_listing.rb +17 -17
- data/lib/purecloud/models/skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/station_entity_listing.rb +17 -17
- data/lib/purecloud/models/street_address.rb +2 -0
- data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
- data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_base_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_entity_listing.rb +17 -17
- data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_presence_alert.rb +310 -0
- data/lib/purecloud/models/user_presence_alert_container.rb +257 -0
- data/lib/purecloud/models/user_presence_rule.rb +293 -0
- data/lib/purecloud/models/{users_entity_listing.rb → user_presence_rule_container.rb} +19 -19
- data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
- data/lib/purecloud/models/user_schedule_adherence.rb +3 -3
- data/lib/purecloud/models/user_search_criteria.rb +1 -1
- data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
- data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
- data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
- data/lib/purecloud/version.rb +1 -1
- data/newVersion.md +1 -1
- data/swagger.json +1 -1
- data/version.json +1 -1
- metadata +22 -4
@@ -11,11 +11,11 @@ title: OAuthProviderEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: OrganizationPresenceEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: OrganizationRoleEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -17,6 +17,7 @@ title: OrphanRecording
|
|
17
17
|
| **file_state** | **String** | | [optional] |
|
18
18
|
| **provider_endpoint** | [**Endpoint**](Endpoint.html) | | [optional] |
|
19
19
|
| **recording** | [**Recording**](Recording.html) | | [optional] |
|
20
|
+
| **orphan_status** | **String** | The status of the orphaned recording's conversation. | [optional] |
|
20
21
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
21
22
|
{: class="table table-striped"}
|
22
23
|
|
@@ -11,11 +11,11 @@ title: OrphanRecordingListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -0,0 +1,15 @@
|
|
1
|
+
---
|
2
|
+
title: OrphanUpdateRequest
|
3
|
+
---
|
4
|
+
## PureCloud::OrphanUpdateRequest
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **archive_date** | **DateTime** | The orphan recording's archive date. Must be greater than 1 day from now if set. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
11
|
+
| **delete_date** | **DateTime** | The orphan recording's delete date. Must be greater than archiveDate if set, otherwise one day from now. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
12
|
+
| **conversation_id** | **String** | A conversation Id that this orphan's recording is to be attached to. If not present, the conversationId will be deduced from the recording media. | [optional] |
|
13
|
+
{: class="table table-striped"}
|
14
|
+
|
15
|
+
|
@@ -11,11 +11,11 @@ title: OutboundRouteEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: PermissionCollectionEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: PhoneBaseEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: PhoneEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: PhoneMetaBaseEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: PhysicalInterfaceEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: PolicyEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/doc_out/QualityApi.html.md
CHANGED
@@ -1066,7 +1066,9 @@ opts = {
|
|
1066
1066
|
expand: nil, # Array<Object> | variable name requested by expand list
|
1067
1067
|
next_page: "next_page_example", # String | next page token
|
1068
1068
|
previous_page: "previous_page_example", # String | Previous page token
|
1069
|
-
name: "name_example" # String | the keyword set name - used for filtering results in searches.
|
1069
|
+
name: "name_example", # String | the keyword set name - used for filtering results in searches.
|
1070
|
+
queue_id: "queue_id_example", # String | the queue id - used for filtering results in searches.
|
1071
|
+
agent_id: "agent_id_example" # String | the agent id - used for filtering results in searches.
|
1070
1072
|
}
|
1071
1073
|
|
1072
1074
|
begin
|
@@ -1089,6 +1091,8 @@ Name | Type | Description | Notes
|
|
1089
1091
|
**next_page** | **String**| next page token | [optional]
|
1090
1092
|
**previous_page** | **String**| Previous page token | [optional]
|
1091
1093
|
**name** | **String**| the keyword set name - used for filtering results in searches. | [optional]
|
1094
|
+
**queue_id** | **String**| the queue id - used for filtering results in searches. | [optional]
|
1095
|
+
**agent_id** | **String**| the agent id - used for filtering results in searches. | [optional]
|
1092
1096
|
{: class="table table-striped"}
|
1093
1097
|
|
1094
1098
|
|
@@ -11,11 +11,11 @@ title: QualityAuditPage
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: QueueEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,11 +11,11 @@ title: QueueMemberEntityListing
|
|
11
11
|
| **page_size** | **Integer** | | [optional] |
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
|
-
| **self_uri** | **String** | | [optional] |
|
15
14
|
| **first_uri** | **String** | | [optional] |
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -11,7 +11,7 @@ Method | HTTP request | Description
|
|
11
11
|
|[**delete_conversation_id_recordings_recording_id_annotations_annotation_id**](RecordingApi.html#delete_conversation_id_recordings_recording_id_annotations_annotation_id) | **DELETE** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} | Delete annotation|
|
12
12
|
|[**delete_mediaretentionpolicies**](RecordingApi.html#delete_mediaretentionpolicies) | **DELETE** /api/v2/recording/mediaretentionpolicies | Delete media retention policies|
|
13
13
|
|[**delete_mediaretentionpolicies_policy_id**](RecordingApi.html#delete_mediaretentionpolicies_policy_id) | **DELETE** /api/v2/recording/mediaretentionpolicies/{policyId} | Delete a media retention policy|
|
14
|
-
|[**delete_orphan_id**](RecordingApi.html#delete_orphan_id) | **DELETE** /api/v2/orphanrecordings/{orphanId} |
|
14
|
+
|[**delete_orphan_id**](RecordingApi.html#delete_orphan_id) | **DELETE** /api/v2/orphanrecordings/{orphanId} | Deletes a single orphan recording|
|
15
15
|
|[**get_conversation_id_recordings**](RecordingApi.html#get_conversation_id_recordings) | **GET** /api/v2/conversations/{conversationId}/recordings | Get all of a Conversation's Recordings.|
|
16
16
|
|[**get_conversation_id_recordings_recording_id**](RecordingApi.html#get_conversation_id_recordings_recording_id) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId} | Gets a specific recording.|
|
17
17
|
|[**get_conversation_id_recordings_recording_id_annotations**](RecordingApi.html#get_conversation_id_recordings_recording_id_annotations) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations | Get annotations for recording|
|
@@ -21,6 +21,7 @@ Method | HTTP request | Description
|
|
21
21
|
|[**get_mediaretentionpolicies**](RecordingApi.html#get_mediaretentionpolicies) | **GET** /api/v2/recording/mediaretentionpolicies | Gets media retention policy list with query options to filter on name and enabled.|
|
22
22
|
|[**get_mediaretentionpolicies_policy_id**](RecordingApi.html#get_mediaretentionpolicies_policy_id) | **GET** /api/v2/recording/mediaretentionpolicies/{policyId} | Get a media retention policy|
|
23
23
|
|[**get_orphan_id**](RecordingApi.html#get_orphan_id) | **GET** /api/v2/orphanrecordings/{orphanId} | Gets a single orphan recording|
|
24
|
+
|[**get_orphan_id_media**](RecordingApi.html#get_orphan_id_media) | **GET** /api/v2/orphanrecordings/{orphanId}/media | Gets the media of a single orphan recording|
|
24
25
|
|[**get_orphanrecordings**](RecordingApi.html#get_orphanrecordings) | **GET** /api/v2/orphanrecordings | Gets all orphan recordings|
|
25
26
|
|[**get_recordingkeys**](RecordingApi.html#get_recordingkeys) | **GET** /api/v2/recording/recordingkeys | Get encryption key list|
|
26
27
|
|[**get_recordingkeys_rotationschedule**](RecordingApi.html#get_recordingkeys_rotationschedule) | **GET** /api/v2/recording/recordingkeys/rotationschedule | Get key rotation schedule|
|
@@ -37,6 +38,7 @@ Method | HTTP request | Description
|
|
37
38
|
|[**put_conversation_id_recordings_recording_id_annotations_annotation_id**](RecordingApi.html#put_conversation_id_recordings_recording_id_annotations_annotation_id) | **PUT** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} | Update annotation|
|
38
39
|
|[**put_localkeys_settings_settings_id**](RecordingApi.html#put_localkeys_settings_settings_id) | **PUT** /api/v2/recording/localkeys/settings/{settingsId} | Update the local encryption settings|
|
39
40
|
|[**put_mediaretentionpolicies_policy_id**](RecordingApi.html#put_mediaretentionpolicies_policy_id) | **PUT** /api/v2/recording/mediaretentionpolicies/{policyId} | Update a media retention policy|
|
41
|
+
|[**put_orphan_id**](RecordingApi.html#put_orphan_id) | **PUT** /api/v2/orphanrecordings/{orphanId} | Updates an orphan recording to a regular recording with retention values|
|
40
42
|
|[**put_recordingkeys_rotationschedule**](RecordingApi.html#put_recordingkeys_rotationschedule) | **PUT** /api/v2/recording/recordingkeys/rotationschedule | Update key rotation schedule|
|
41
43
|
|[**put_settings**](RecordingApi.html#put_settings) | **PUT** /api/v2/recording/settings | Update the Recording Settings for the Organization|
|
42
44
|
{: class="table table-striped"}
|
@@ -218,7 +220,7 @@ Name | Type | Description | Notes
|
|
218
220
|
|
219
221
|
## -[**OrphanRecording**](OrphanRecording.html) delete_orphan_id(orphan_id)
|
220
222
|
|
221
|
-
|
223
|
+
Deletes a single orphan recording
|
222
224
|
|
223
225
|
|
224
226
|
|
@@ -243,7 +245,7 @@ orphan_id = "orphan_id_example" # String | Orphan ID
|
|
243
245
|
|
244
246
|
|
245
247
|
begin
|
246
|
-
#
|
248
|
+
#Deletes a single orphan recording
|
247
249
|
result = api_instance.delete_orphan_id(orphan_id)
|
248
250
|
p result
|
249
251
|
rescue PureCloud::ApiError => e
|
@@ -813,6 +815,70 @@ Name | Type | Description | Notes
|
|
813
815
|
|
814
816
|
|
815
817
|
|
818
|
+
<a name="get_orphan_id_media"></a>
|
819
|
+
|
820
|
+
## -[**Recording**](Recording.html) get_orphan_id_media(orphan_id, opts)
|
821
|
+
|
822
|
+
Gets the media of a single orphan recording
|
823
|
+
|
824
|
+
A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.
|
825
|
+
|
826
|
+
### Example
|
827
|
+
~~~ruby
|
828
|
+
# load the gem
|
829
|
+
require 'purecloud'
|
830
|
+
# setup authorization
|
831
|
+
@secret = ENV['PURECLOUD_SECRET']
|
832
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
833
|
+
environment = "mypurecloud.com"
|
834
|
+
|
835
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
836
|
+
|
837
|
+
PureCloud.configure do |config|
|
838
|
+
config.access_token = @authToken
|
839
|
+
end
|
840
|
+
|
841
|
+
api_instance = PureCloud::RecordingApi.new
|
842
|
+
|
843
|
+
orphan_id = "orphan_id_example" # String | Orphan ID
|
844
|
+
|
845
|
+
opts = {
|
846
|
+
format_id: "WEBM", # String | The desired media format.
|
847
|
+
download: false, # BOOLEAN | requesting a download format of the recording
|
848
|
+
file_name: "file_name_example" # String | the name of the downloaded fileName
|
849
|
+
}
|
850
|
+
|
851
|
+
begin
|
852
|
+
#Gets the media of a single orphan recording
|
853
|
+
result = api_instance.get_orphan_id_media(orphan_id, opts)
|
854
|
+
p result
|
855
|
+
rescue PureCloud::ApiError => e
|
856
|
+
puts "Exception when calling RecordingApi->get_orphan_id_media: #{e}"
|
857
|
+
end
|
858
|
+
~~~
|
859
|
+
|
860
|
+
### Parameters
|
861
|
+
|
862
|
+
Name | Type | Description | Notes
|
863
|
+
------------- | ------------- | ------------- | -------------
|
864
|
+
**orphan_id** | **String**| Orphan ID |
|
865
|
+
**format_id** | **String**| The desired media format. | [optional] [default to WEBM]
|
866
|
+
**download** | **BOOLEAN**| requesting a download format of the recording | [optional] [default to false]
|
867
|
+
**file_name** | **String**| the name of the downloaded fileName | [optional]
|
868
|
+
{: class="table table-striped"}
|
869
|
+
|
870
|
+
|
871
|
+
### Return type
|
872
|
+
|
873
|
+
[**Recording**](Recording.html)
|
874
|
+
|
875
|
+
### HTTP request headers
|
876
|
+
|
877
|
+
- **Content-Type**: application/json
|
878
|
+
- **Accept**: application/json
|
879
|
+
|
880
|
+
|
881
|
+
|
816
882
|
<a name="get_orphanrecordings"></a>
|
817
883
|
|
818
884
|
## -[**OrphanRecordingListing**](OrphanRecordingListing.html) get_orphanrecordings(opts)
|
@@ -844,7 +910,8 @@ opts = {
|
|
844
910
|
sort_by: "sort_by_example", # String | variable name requested to sort by
|
845
911
|
expand: nil, # Array<Object> | variable name requested by expand list
|
846
912
|
next_page: "next_page_example", # String | next page token
|
847
|
-
previous_page: "previous_page_example" # String | Previous page token
|
913
|
+
previous_page: "previous_page_example", # String | Previous page token
|
914
|
+
has_conversation: false # BOOLEAN | Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.
|
848
915
|
}
|
849
916
|
|
850
917
|
begin
|
@@ -866,6 +933,7 @@ Name | Type | Description | Notes
|
|
866
933
|
**expand** | [**Array<Object>**](Object.html)| variable name requested by expand list | [optional]
|
867
934
|
**next_page** | **String**| next page token | [optional]
|
868
935
|
**previous_page** | **String**| Previous page token | [optional]
|
936
|
+
**has_conversation** | **BOOLEAN**| Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. | [optional] [default to false]
|
869
937
|
{: class="table table-striped"}
|
870
938
|
|
871
939
|
|
@@ -1748,6 +1816,66 @@ Name | Type | Description | Notes
|
|
1748
1816
|
|
1749
1817
|
|
1750
1818
|
|
1819
|
+
<a name="put_orphan_id"></a>
|
1820
|
+
|
1821
|
+
## -[**Recording**](Recording.html) put_orphan_id(orphan_id, opts)
|
1822
|
+
|
1823
|
+
Updates an orphan recording to a regular recording with retention values
|
1824
|
+
|
1825
|
+
If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.
|
1826
|
+
|
1827
|
+
### Example
|
1828
|
+
~~~ruby
|
1829
|
+
# load the gem
|
1830
|
+
require 'purecloud'
|
1831
|
+
# setup authorization
|
1832
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1833
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1834
|
+
environment = "mypurecloud.com"
|
1835
|
+
|
1836
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1837
|
+
|
1838
|
+
PureCloud.configure do |config|
|
1839
|
+
config.access_token = @authToken
|
1840
|
+
end
|
1841
|
+
|
1842
|
+
api_instance = PureCloud::RecordingApi.new
|
1843
|
+
|
1844
|
+
orphan_id = "orphan_id_example" # String | Orphan ID
|
1845
|
+
|
1846
|
+
opts = {
|
1847
|
+
body: PureCloud::OrphanUpdateRequest.new # OrphanUpdateRequest |
|
1848
|
+
}
|
1849
|
+
|
1850
|
+
begin
|
1851
|
+
#Updates an orphan recording to a regular recording with retention values
|
1852
|
+
result = api_instance.put_orphan_id(orphan_id, opts)
|
1853
|
+
p result
|
1854
|
+
rescue PureCloud::ApiError => e
|
1855
|
+
puts "Exception when calling RecordingApi->put_orphan_id: #{e}"
|
1856
|
+
end
|
1857
|
+
~~~
|
1858
|
+
|
1859
|
+
### Parameters
|
1860
|
+
|
1861
|
+
Name | Type | Description | Notes
|
1862
|
+
------------- | ------------- | ------------- | -------------
|
1863
|
+
**orphan_id** | **String**| Orphan ID |
|
1864
|
+
**body** | [**OrphanUpdateRequest**](OrphanUpdateRequest.html)| | [optional]
|
1865
|
+
{: class="table table-striped"}
|
1866
|
+
|
1867
|
+
|
1868
|
+
### Return type
|
1869
|
+
|
1870
|
+
[**Recording**](Recording.html)
|
1871
|
+
|
1872
|
+
### HTTP request headers
|
1873
|
+
|
1874
|
+
- **Content-Type**: application/json
|
1875
|
+
- **Accept**: application/json
|
1876
|
+
|
1877
|
+
|
1878
|
+
|
1751
1879
|
<a name="put_recordingkeys_rotationschedule"></a>
|
1752
1880
|
|
1753
1881
|
## -[**KeyRotationSchedule**](KeyRotationSchedule.html) put_recordingkeys_rotationschedule(body)
|