purecloudplatformclientv2 34.0.0 → 35.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/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AlertingApi.md +66 -0
- data/docs/AnalyticsApi.md +144 -0
- data/docs/ArchitectApi.md +492 -2
- data/docs/AssignedWrapupCode.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AttributesApi.md +36 -0
- data/docs/AuthorizationApi.md +102 -0
- data/docs/BillingApi.md +6 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionView.md +16 -0
- data/docs/CampaignDivisionViewListing.md +22 -0
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ContentManagementApi.md +228 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +590 -14
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalContactsApi.md +238 -69
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxApi.md +36 -0
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/Flow.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GeneralDataProtectionRegulationApi.md +24 -0
- data/docs/GeolocationApi.md +24 -0
- data/docs/GreetingListing.md +1 -1
- data/docs/GreetingsApi.md +96 -0
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +84 -0
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityProviderApi.md +168 -0
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntegrationsApi.md +246 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguagesApi.md +60 -0
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +48 -0
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationsApi.md +24 -0
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MobileDevicesApi.md +30 -0
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationsApi.md +42 -0
- data/docs/OAuthApi.md +36 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationApi.md +24 -0
- data/docs/OrganizationAuthorizationApi.md +138 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +611 -0
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceApi.md +48 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +300 -0
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +222 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseManagementApi.md +66 -0
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +351 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/ScriptsApi.md +66 -0
- data/docs/SearchApi.md +84 -0
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/StationsApi.md +30 -0
- data/docs/SuggestApi.md +24 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +762 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TokensApi.md +12 -0
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserRecordingsApi.md +36 -0
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +321 -3
- data/docs/UtilitiesApi.md +18 -0
- data/docs/VoicemailApi.md +144 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatApi.md +48 -0
- data/docs/WebChatConfig.md +13 -0
- data/docs/WebChatDeployment.md +2 -1
- data/docs/WorkforceManagementApi.md +74 -2
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +4 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +21 -21
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +90 -68
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +117 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +1 -1
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb +308 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{authz_division.rb → campaign_division_view.rb} +9 -68
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow.rb +13 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/json_node.rb +65 -65
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/web_chat_config.rb +202 -0
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +27 -2
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +10 -4
- data/docs/AuthzDivision.md +0 -18
data/docs/QualityAuditPage.md
CHANGED
|
@@ -13,9 +13,9 @@ title: QualityAuditPage
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/QueueEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: QueueEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: QueueMemberEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/RecipientListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: RecipientListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/RecordingApi.md
CHANGED
|
@@ -51,12 +51,18 @@ Method | Description
|
|
|
51
51
|
|
|
52
52
|
## - delete_conversation_recording_annotation(conversation_id, recording_id, annotation_id)
|
|
53
53
|
|
|
54
|
+
|
|
55
|
+
|
|
54
56
|
Delete annotation
|
|
55
57
|
|
|
56
58
|
|
|
57
59
|
|
|
58
60
|
Wraps DELETE /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}
|
|
59
61
|
|
|
62
|
+
Requires NO permissions:
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
60
66
|
|
|
61
67
|
### Example
|
|
62
68
|
~~~ruby
|
|
@@ -115,12 +121,18 @@ nil (empty response body)
|
|
|
115
121
|
|
|
116
122
|
## -[**OrphanRecording**](OrphanRecording.html) delete_orphanrecording(orphan_id)
|
|
117
123
|
|
|
124
|
+
|
|
125
|
+
|
|
118
126
|
Deletes a single orphan recording
|
|
119
127
|
|
|
120
128
|
|
|
121
129
|
|
|
122
130
|
Wraps DELETE /api/v2/orphanrecordings/{orphanId}
|
|
123
131
|
|
|
132
|
+
Requires ANY permissions:
|
|
133
|
+
|
|
134
|
+
* recording:orphan:delete
|
|
135
|
+
|
|
124
136
|
|
|
125
137
|
### Example
|
|
126
138
|
~~~ruby
|
|
@@ -174,12 +186,18 @@ Name | Type | Description | Notes
|
|
|
174
186
|
|
|
175
187
|
## - delete_recording_mediaretentionpolicies(ids)
|
|
176
188
|
|
|
189
|
+
|
|
190
|
+
|
|
177
191
|
Delete media retention policies
|
|
178
192
|
|
|
179
193
|
Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.
|
|
180
194
|
|
|
181
195
|
Wraps DELETE /api/v2/recording/mediaretentionpolicies
|
|
182
196
|
|
|
197
|
+
Requires ANY permissions:
|
|
198
|
+
|
|
199
|
+
* recording:retentionPolicy:delete
|
|
200
|
+
|
|
183
201
|
|
|
184
202
|
### Example
|
|
185
203
|
~~~ruby
|
|
@@ -232,12 +250,18 @@ nil (empty response body)
|
|
|
232
250
|
|
|
233
251
|
## - delete_recording_mediaretentionpolicy(policy_id)
|
|
234
252
|
|
|
253
|
+
|
|
254
|
+
|
|
235
255
|
Delete a media retention policy
|
|
236
256
|
|
|
237
257
|
|
|
238
258
|
|
|
239
259
|
Wraps DELETE /api/v2/recording/mediaretentionpolicies/{policyId}
|
|
240
260
|
|
|
261
|
+
Requires ANY permissions:
|
|
262
|
+
|
|
263
|
+
* recording:retentionPolicy:delete
|
|
264
|
+
|
|
241
265
|
|
|
242
266
|
### Example
|
|
243
267
|
~~~ruby
|
|
@@ -290,12 +314,18 @@ nil (empty response body)
|
|
|
290
314
|
|
|
291
315
|
## -[**Recording**](Recording.html) get_conversation_recording(conversation_id, recording_id, opts)
|
|
292
316
|
|
|
317
|
+
|
|
318
|
+
|
|
293
319
|
Gets a specific recording.
|
|
294
320
|
|
|
295
321
|
|
|
296
322
|
|
|
297
323
|
Wraps GET /api/v2/conversations/{conversationId}/recordings/{recordingId}
|
|
298
324
|
|
|
325
|
+
Requires NO permissions:
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
299
329
|
|
|
300
330
|
### Example
|
|
301
331
|
~~~ruby
|
|
@@ -360,12 +390,18 @@ Name | Type | Description | Notes
|
|
|
360
390
|
|
|
361
391
|
## -[**Annotation**](Annotation.html) get_conversation_recording_annotation(conversation_id, recording_id, annotation_id)
|
|
362
392
|
|
|
393
|
+
|
|
394
|
+
|
|
363
395
|
Get annotation
|
|
364
396
|
|
|
365
397
|
|
|
366
398
|
|
|
367
399
|
Wraps GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}
|
|
368
400
|
|
|
401
|
+
Requires NO permissions:
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
369
405
|
|
|
370
406
|
### Example
|
|
371
407
|
~~~ruby
|
|
@@ -425,12 +461,18 @@ Name | Type | Description | Notes
|
|
|
425
461
|
|
|
426
462
|
## -[**Array<Annotation>**](Annotation.html) get_conversation_recording_annotations(conversation_id, recording_id)
|
|
427
463
|
|
|
464
|
+
|
|
465
|
+
|
|
428
466
|
Get annotations for recording
|
|
429
467
|
|
|
430
468
|
|
|
431
469
|
|
|
432
470
|
Wraps GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations
|
|
433
471
|
|
|
472
|
+
Requires NO permissions:
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
434
476
|
|
|
435
477
|
### Example
|
|
436
478
|
~~~ruby
|
|
@@ -487,12 +529,18 @@ Name | Type | Description | Notes
|
|
|
487
529
|
|
|
488
530
|
## -[**Array<Recording>**](Recording.html) get_conversation_recordingmetadata(conversation_id)
|
|
489
531
|
|
|
532
|
+
|
|
533
|
+
|
|
490
534
|
Get recording metadata for a conversation. Does not return playable media.
|
|
491
535
|
|
|
492
536
|
|
|
493
537
|
|
|
494
538
|
Wraps GET /api/v2/conversations/{conversationId}/recordingmetadata
|
|
495
539
|
|
|
540
|
+
Requires NO permissions:
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
496
544
|
|
|
497
545
|
### Example
|
|
498
546
|
~~~ruby
|
|
@@ -546,12 +594,18 @@ Name | Type | Description | Notes
|
|
|
546
594
|
|
|
547
595
|
## -[**Recording**](Recording.html) get_conversation_recordingmetadata_recording_id(conversation_id, recording_id)
|
|
548
596
|
|
|
597
|
+
|
|
598
|
+
|
|
549
599
|
Get metadata for a specific recording. Does not return playable media.
|
|
550
600
|
|
|
551
601
|
|
|
552
602
|
|
|
553
603
|
Wraps GET /api/v2/conversations/{conversationId}/recordingmetadata/{recordingId}
|
|
554
604
|
|
|
605
|
+
Requires NO permissions:
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
|
|
555
609
|
|
|
556
610
|
### Example
|
|
557
611
|
~~~ruby
|
|
@@ -608,12 +662,18 @@ Name | Type | Description | Notes
|
|
|
608
662
|
|
|
609
663
|
## -[**Array<Recording>**](Recording.html) get_conversation_recordings(conversation_id, opts)
|
|
610
664
|
|
|
665
|
+
|
|
666
|
+
|
|
611
667
|
Get all of a Conversation's Recordings.
|
|
612
668
|
|
|
613
669
|
|
|
614
670
|
|
|
615
671
|
Wraps GET /api/v2/conversations/{conversationId}/recordings
|
|
616
672
|
|
|
673
|
+
Requires NO permissions:
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
617
677
|
|
|
618
678
|
### Example
|
|
619
679
|
~~~ruby
|
|
@@ -673,12 +733,18 @@ Name | Type | Description | Notes
|
|
|
673
733
|
|
|
674
734
|
## -[**OrphanRecording**](OrphanRecording.html) get_orphanrecording(orphan_id)
|
|
675
735
|
|
|
736
|
+
|
|
737
|
+
|
|
676
738
|
Gets a single orphan recording
|
|
677
739
|
|
|
678
740
|
|
|
679
741
|
|
|
680
742
|
Wraps GET /api/v2/orphanrecordings/{orphanId}
|
|
681
743
|
|
|
744
|
+
Requires ANY permissions:
|
|
745
|
+
|
|
746
|
+
* recording:orphan:view
|
|
747
|
+
|
|
682
748
|
|
|
683
749
|
### Example
|
|
684
750
|
~~~ruby
|
|
@@ -732,12 +798,18 @@ Name | Type | Description | Notes
|
|
|
732
798
|
|
|
733
799
|
## -[**Recording**](Recording.html) get_orphanrecording_media(orphan_id, opts)
|
|
734
800
|
|
|
801
|
+
|
|
802
|
+
|
|
735
803
|
Gets the media of a single orphan recording
|
|
736
804
|
|
|
737
805
|
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.
|
|
738
806
|
|
|
739
807
|
Wraps GET /api/v2/orphanrecordings/{orphanId}/media
|
|
740
808
|
|
|
809
|
+
Requires NO permissions:
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
|
|
741
813
|
|
|
742
814
|
### Example
|
|
743
815
|
~~~ruby
|
|
@@ -799,12 +871,18 @@ Name | Type | Description | Notes
|
|
|
799
871
|
|
|
800
872
|
## -[**OrphanRecordingListing**](OrphanRecordingListing.html) get_orphanrecordings(opts)
|
|
801
873
|
|
|
874
|
+
|
|
875
|
+
|
|
802
876
|
Gets all orphan recordings
|
|
803
877
|
|
|
804
878
|
|
|
805
879
|
|
|
806
880
|
Wraps GET /api/v2/orphanrecordings
|
|
807
881
|
|
|
882
|
+
Requires ANY permissions:
|
|
883
|
+
|
|
884
|
+
* recording:orphan:view
|
|
885
|
+
|
|
808
886
|
|
|
809
887
|
### Example
|
|
810
888
|
~~~ruby
|
|
@@ -873,12 +951,18 @@ Name | Type | Description | Notes
|
|
|
873
951
|
|
|
874
952
|
## -[**BatchDownloadJobStatusResult**](BatchDownloadJobStatusResult.html) get_recording_batchrequest(job_id)
|
|
875
953
|
|
|
954
|
+
|
|
955
|
+
|
|
876
956
|
Get the status and results for a batch request job, only the user that submitted the job may retrieve results
|
|
877
957
|
|
|
878
958
|
|
|
879
959
|
|
|
880
960
|
Wraps GET /api/v2/recording/batchrequests/{jobId}
|
|
881
961
|
|
|
962
|
+
Requires NO permissions:
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
|
|
882
966
|
|
|
883
967
|
### Example
|
|
884
968
|
~~~ruby
|
|
@@ -932,12 +1016,18 @@ Name | Type | Description | Notes
|
|
|
932
1016
|
|
|
933
1017
|
## -[**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) get_recording_localkeys_setting(settings_id)
|
|
934
1018
|
|
|
1019
|
+
|
|
1020
|
+
|
|
935
1021
|
Get the local encryption settings
|
|
936
1022
|
|
|
937
1023
|
|
|
938
1024
|
|
|
939
1025
|
Wraps GET /api/v2/recording/localkeys/settings/{settingsId}
|
|
940
1026
|
|
|
1027
|
+
Requires ANY permissions:
|
|
1028
|
+
|
|
1029
|
+
* recording:encryptionKey:view
|
|
1030
|
+
|
|
941
1031
|
|
|
942
1032
|
### Example
|
|
943
1033
|
~~~ruby
|
|
@@ -991,12 +1081,18 @@ Name | Type | Description | Notes
|
|
|
991
1081
|
|
|
992
1082
|
## -[**LocalEncryptionConfigurationListing**](LocalEncryptionConfigurationListing.html) get_recording_localkeys_settings
|
|
993
1083
|
|
|
1084
|
+
|
|
1085
|
+
|
|
994
1086
|
gets a list local key settings data
|
|
995
1087
|
|
|
996
1088
|
|
|
997
1089
|
|
|
998
1090
|
Wraps GET /api/v2/recording/localkeys/settings
|
|
999
1091
|
|
|
1092
|
+
Requires ANY permissions:
|
|
1093
|
+
|
|
1094
|
+
* recording:encryptionKey:view
|
|
1095
|
+
|
|
1000
1096
|
|
|
1001
1097
|
### Example
|
|
1002
1098
|
~~~ruby
|
|
@@ -1044,12 +1140,18 @@ This endpoint does not need any parameter.
|
|
|
1044
1140
|
|
|
1045
1141
|
## -[**PolicyEntityListing**](PolicyEntityListing.html) get_recording_mediaretentionpolicies(opts)
|
|
1046
1142
|
|
|
1143
|
+
|
|
1144
|
+
|
|
1047
1145
|
Gets media retention policy list with query options to filter on name and enabled.
|
|
1048
1146
|
|
|
1049
1147
|
for a less verbose response, add summary=true to this endpoint
|
|
1050
1148
|
|
|
1051
1149
|
Wraps GET /api/v2/recording/mediaretentionpolicies
|
|
1052
1150
|
|
|
1151
|
+
Requires ANY permissions:
|
|
1152
|
+
|
|
1153
|
+
* recording:retentionPolicy:view
|
|
1154
|
+
|
|
1053
1155
|
|
|
1054
1156
|
### Example
|
|
1055
1157
|
~~~ruby
|
|
@@ -1122,12 +1224,18 @@ Name | Type | Description | Notes
|
|
|
1122
1224
|
|
|
1123
1225
|
## -[**Policy**](Policy.html) get_recording_mediaretentionpolicy(policy_id)
|
|
1124
1226
|
|
|
1227
|
+
|
|
1228
|
+
|
|
1125
1229
|
Get a media retention policy
|
|
1126
1230
|
|
|
1127
1231
|
|
|
1128
1232
|
|
|
1129
1233
|
Wraps GET /api/v2/recording/mediaretentionpolicies/{policyId}
|
|
1130
1234
|
|
|
1235
|
+
Requires ANY permissions:
|
|
1236
|
+
|
|
1237
|
+
* recording:retentionPolicy:view
|
|
1238
|
+
|
|
1131
1239
|
|
|
1132
1240
|
### Example
|
|
1133
1241
|
~~~ruby
|
|
@@ -1181,12 +1289,18 @@ Name | Type | Description | Notes
|
|
|
1181
1289
|
|
|
1182
1290
|
## -[**EncryptionKeyEntityListing**](EncryptionKeyEntityListing.html) get_recording_recordingkeys(opts)
|
|
1183
1291
|
|
|
1292
|
+
|
|
1293
|
+
|
|
1184
1294
|
Get encryption key list
|
|
1185
1295
|
|
|
1186
1296
|
|
|
1187
1297
|
|
|
1188
1298
|
Wraps GET /api/v2/recording/recordingkeys
|
|
1189
1299
|
|
|
1300
|
+
Requires ANY permissions:
|
|
1301
|
+
|
|
1302
|
+
* recording:encryptionKey:view
|
|
1303
|
+
|
|
1190
1304
|
|
|
1191
1305
|
### Example
|
|
1192
1306
|
~~~ruby
|
|
@@ -1243,12 +1357,18 @@ Name | Type | Description | Notes
|
|
|
1243
1357
|
|
|
1244
1358
|
## -[**KeyRotationSchedule**](KeyRotationSchedule.html) get_recording_recordingkeys_rotationschedule
|
|
1245
1359
|
|
|
1360
|
+
|
|
1361
|
+
|
|
1246
1362
|
Get key rotation schedule
|
|
1247
1363
|
|
|
1248
1364
|
|
|
1249
1365
|
|
|
1250
1366
|
Wraps GET /api/v2/recording/recordingkeys/rotationschedule
|
|
1251
1367
|
|
|
1368
|
+
Requires ANY permissions:
|
|
1369
|
+
|
|
1370
|
+
* recording:encryptionKey:view
|
|
1371
|
+
|
|
1252
1372
|
|
|
1253
1373
|
### Example
|
|
1254
1374
|
~~~ruby
|
|
@@ -1296,12 +1416,18 @@ This endpoint does not need any parameter.
|
|
|
1296
1416
|
|
|
1297
1417
|
## -[**RecordingSettings**](RecordingSettings.html) get_recording_settings(opts)
|
|
1298
1418
|
|
|
1419
|
+
|
|
1420
|
+
|
|
1299
1421
|
Get the Recording Settings for the Organization
|
|
1300
1422
|
|
|
1301
1423
|
|
|
1302
1424
|
|
|
1303
1425
|
Wraps GET /api/v2/recording/settings
|
|
1304
1426
|
|
|
1427
|
+
Requires NO permissions:
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
|
|
1305
1431
|
|
|
1306
1432
|
### Example
|
|
1307
1433
|
~~~ruby
|
|
@@ -1356,12 +1482,18 @@ Name | Type | Description | Notes
|
|
|
1356
1482
|
|
|
1357
1483
|
## -[**ScreenRecordingSessionListing**](ScreenRecordingSessionListing.html) get_recordings_screensessions(opts)
|
|
1358
1484
|
|
|
1485
|
+
|
|
1486
|
+
|
|
1359
1487
|
Retrieves a paged listing of screen recording sessions
|
|
1360
1488
|
|
|
1361
1489
|
|
|
1362
1490
|
|
|
1363
1491
|
Wraps GET /api/v2/recordings/screensessions
|
|
1364
1492
|
|
|
1493
|
+
Requires NO permissions:
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
|
|
1365
1497
|
|
|
1366
1498
|
### Example
|
|
1367
1499
|
~~~ruby
|
|
@@ -1418,12 +1550,18 @@ Name | Type | Description | Notes
|
|
|
1418
1550
|
|
|
1419
1551
|
## -[**Policy**](Policy.html) patch_recording_mediaretentionpolicy(policy_id, body)
|
|
1420
1552
|
|
|
1553
|
+
|
|
1554
|
+
|
|
1421
1555
|
Patch a media retention policy
|
|
1422
1556
|
|
|
1423
1557
|
|
|
1424
1558
|
|
|
1425
1559
|
Wraps PATCH /api/v2/recording/mediaretentionpolicies/{policyId}
|
|
1426
1560
|
|
|
1561
|
+
Requires ANY permissions:
|
|
1562
|
+
|
|
1563
|
+
* recording:retentionPolicy:edit
|
|
1564
|
+
|
|
1427
1565
|
|
|
1428
1566
|
### Example
|
|
1429
1567
|
~~~ruby
|
|
@@ -1480,12 +1618,18 @@ Name | Type | Description | Notes
|
|
|
1480
1618
|
|
|
1481
1619
|
## - patch_recordings_screensession(recording_session_id, opts)
|
|
1482
1620
|
|
|
1621
|
+
|
|
1622
|
+
|
|
1483
1623
|
Update a screen recording session
|
|
1484
1624
|
|
|
1485
1625
|
|
|
1486
1626
|
|
|
1487
1627
|
Wraps PATCH /api/v2/recordings/screensessions/{recordingSessionId}
|
|
1488
1628
|
|
|
1629
|
+
Requires NO permissions:
|
|
1630
|
+
|
|
1631
|
+
|
|
1632
|
+
|
|
1489
1633
|
|
|
1490
1634
|
### Example
|
|
1491
1635
|
~~~ruby
|
|
@@ -1542,12 +1686,18 @@ nil (empty response body)
|
|
|
1542
1686
|
|
|
1543
1687
|
## -[**Annotation**](Annotation.html) post_conversation_recording_annotations(conversation_id, recording_id, body)
|
|
1544
1688
|
|
|
1689
|
+
|
|
1690
|
+
|
|
1545
1691
|
Create annotation
|
|
1546
1692
|
|
|
1547
1693
|
|
|
1548
1694
|
|
|
1549
1695
|
Wraps POST /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations
|
|
1550
1696
|
|
|
1697
|
+
Requires NO permissions:
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
|
|
1551
1701
|
|
|
1552
1702
|
### Example
|
|
1553
1703
|
~~~ruby
|
|
@@ -1607,12 +1757,18 @@ Name | Type | Description | Notes
|
|
|
1607
1757
|
|
|
1608
1758
|
## -[**BatchDownloadJobSubmissionResult**](BatchDownloadJobSubmissionResult.html) post_recording_batchrequests(body)
|
|
1609
1759
|
|
|
1760
|
+
|
|
1761
|
+
|
|
1610
1762
|
Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.
|
|
1611
1763
|
|
|
1612
1764
|
|
|
1613
1765
|
|
|
1614
1766
|
Wraps POST /api/v2/recording/batchrequests
|
|
1615
1767
|
|
|
1768
|
+
Requires NO permissions:
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
|
|
1616
1772
|
|
|
1617
1773
|
### Example
|
|
1618
1774
|
~~~ruby
|
|
@@ -1666,12 +1822,18 @@ Name | Type | Description | Notes
|
|
|
1666
1822
|
|
|
1667
1823
|
## -[**EncryptionKey**](EncryptionKey.html) post_recording_localkeys(body)
|
|
1668
1824
|
|
|
1825
|
+
|
|
1826
|
+
|
|
1669
1827
|
create a local recording key
|
|
1670
1828
|
|
|
1671
1829
|
|
|
1672
1830
|
|
|
1673
1831
|
Wraps POST /api/v2/recording/localkeys
|
|
1674
1832
|
|
|
1833
|
+
Requires ANY permissions:
|
|
1834
|
+
|
|
1835
|
+
* recording:encryptionKey:edit
|
|
1836
|
+
|
|
1675
1837
|
|
|
1676
1838
|
### Example
|
|
1677
1839
|
~~~ruby
|
|
@@ -1725,12 +1887,18 @@ Name | Type | Description | Notes
|
|
|
1725
1887
|
|
|
1726
1888
|
## -[**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) post_recording_localkeys_settings(body)
|
|
1727
1889
|
|
|
1890
|
+
|
|
1891
|
+
|
|
1728
1892
|
create settings for local key creation
|
|
1729
1893
|
|
|
1730
1894
|
|
|
1731
1895
|
|
|
1732
1896
|
Wraps POST /api/v2/recording/localkeys/settings
|
|
1733
1897
|
|
|
1898
|
+
Requires ANY permissions:
|
|
1899
|
+
|
|
1900
|
+
* recording:encryptionKey:edit
|
|
1901
|
+
|
|
1734
1902
|
|
|
1735
1903
|
### Example
|
|
1736
1904
|
~~~ruby
|
|
@@ -1784,12 +1952,18 @@ Name | Type | Description | Notes
|
|
|
1784
1952
|
|
|
1785
1953
|
## -[**Policy**](Policy.html) post_recording_mediaretentionpolicies(body)
|
|
1786
1954
|
|
|
1955
|
+
|
|
1956
|
+
|
|
1787
1957
|
Create media retention policy
|
|
1788
1958
|
|
|
1789
1959
|
|
|
1790
1960
|
|
|
1791
1961
|
Wraps POST /api/v2/recording/mediaretentionpolicies
|
|
1792
1962
|
|
|
1963
|
+
Requires ANY permissions:
|
|
1964
|
+
|
|
1965
|
+
* recording:retentionPolicy:add
|
|
1966
|
+
|
|
1793
1967
|
|
|
1794
1968
|
### Example
|
|
1795
1969
|
~~~ruby
|
|
@@ -1843,12 +2017,18 @@ Name | Type | Description | Notes
|
|
|
1843
2017
|
|
|
1844
2018
|
## -[**EncryptionKey**](EncryptionKey.html) post_recording_recordingkeys
|
|
1845
2019
|
|
|
2020
|
+
|
|
2021
|
+
|
|
1846
2022
|
Create encryption key
|
|
1847
2023
|
|
|
1848
2024
|
|
|
1849
2025
|
|
|
1850
2026
|
Wraps POST /api/v2/recording/recordingkeys
|
|
1851
2027
|
|
|
2028
|
+
Requires ANY permissions:
|
|
2029
|
+
|
|
2030
|
+
* recording:encryptionKey:edit
|
|
2031
|
+
|
|
1852
2032
|
|
|
1853
2033
|
### Example
|
|
1854
2034
|
~~~ruby
|
|
@@ -1896,12 +2076,18 @@ This endpoint does not need any parameter.
|
|
|
1896
2076
|
|
|
1897
2077
|
## -[**Recording**](Recording.html) put_conversation_recording(conversation_id, recording_id, body)
|
|
1898
2078
|
|
|
2079
|
+
|
|
2080
|
+
|
|
1899
2081
|
Updates the retention records on a recording.
|
|
1900
2082
|
|
|
1901
2083
|
Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set.
|
|
1902
2084
|
|
|
1903
2085
|
Wraps PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}
|
|
1904
2086
|
|
|
2087
|
+
Requires NO permissions:
|
|
2088
|
+
|
|
2089
|
+
|
|
2090
|
+
|
|
1905
2091
|
|
|
1906
2092
|
### Example
|
|
1907
2093
|
~~~ruby
|
|
@@ -1961,12 +2147,18 @@ Name | Type | Description | Notes
|
|
|
1961
2147
|
|
|
1962
2148
|
## -[**Annotation**](Annotation.html) put_conversation_recording_annotation(conversation_id, recording_id, annotation_id, body)
|
|
1963
2149
|
|
|
2150
|
+
|
|
2151
|
+
|
|
1964
2152
|
Update annotation
|
|
1965
2153
|
|
|
1966
2154
|
|
|
1967
2155
|
|
|
1968
2156
|
Wraps PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}
|
|
1969
2157
|
|
|
2158
|
+
Requires NO permissions:
|
|
2159
|
+
|
|
2160
|
+
|
|
2161
|
+
|
|
1970
2162
|
|
|
1971
2163
|
### Example
|
|
1972
2164
|
~~~ruby
|
|
@@ -2029,12 +2221,18 @@ Name | Type | Description | Notes
|
|
|
2029
2221
|
|
|
2030
2222
|
## -[**Recording**](Recording.html) put_orphanrecording(orphan_id, opts)
|
|
2031
2223
|
|
|
2224
|
+
|
|
2225
|
+
|
|
2032
2226
|
Updates an orphan recording to a regular recording with retention values
|
|
2033
2227
|
|
|
2034
2228
|
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.
|
|
2035
2229
|
|
|
2036
2230
|
Wraps PUT /api/v2/orphanrecordings/{orphanId}
|
|
2037
2231
|
|
|
2232
|
+
Requires ANY permissions:
|
|
2233
|
+
|
|
2234
|
+
* recording:orphan:edit
|
|
2235
|
+
|
|
2038
2236
|
|
|
2039
2237
|
### Example
|
|
2040
2238
|
~~~ruby
|
|
@@ -2092,12 +2290,18 @@ Name | Type | Description | Notes
|
|
|
2092
2290
|
|
|
2093
2291
|
## -[**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) put_recording_localkeys_setting(settings_id, body)
|
|
2094
2292
|
|
|
2293
|
+
|
|
2294
|
+
|
|
2095
2295
|
Update the local encryption settings
|
|
2096
2296
|
|
|
2097
2297
|
|
|
2098
2298
|
|
|
2099
2299
|
Wraps PUT /api/v2/recording/localkeys/settings/{settingsId}
|
|
2100
2300
|
|
|
2301
|
+
Requires ANY permissions:
|
|
2302
|
+
|
|
2303
|
+
* recording:encryptionKey:edit
|
|
2304
|
+
|
|
2101
2305
|
|
|
2102
2306
|
### Example
|
|
2103
2307
|
~~~ruby
|
|
@@ -2154,12 +2358,18 @@ Name | Type | Description | Notes
|
|
|
2154
2358
|
|
|
2155
2359
|
## -[**Policy**](Policy.html) put_recording_mediaretentionpolicy(policy_id, body)
|
|
2156
2360
|
|
|
2361
|
+
|
|
2362
|
+
|
|
2157
2363
|
Update a media retention policy
|
|
2158
2364
|
|
|
2159
2365
|
|
|
2160
2366
|
|
|
2161
2367
|
Wraps PUT /api/v2/recording/mediaretentionpolicies/{policyId}
|
|
2162
2368
|
|
|
2369
|
+
Requires ANY permissions:
|
|
2370
|
+
|
|
2371
|
+
* recording:retentionPolicy:edit
|
|
2372
|
+
|
|
2163
2373
|
|
|
2164
2374
|
### Example
|
|
2165
2375
|
~~~ruby
|
|
@@ -2216,12 +2426,18 @@ Name | Type | Description | Notes
|
|
|
2216
2426
|
|
|
2217
2427
|
## -[**KeyRotationSchedule**](KeyRotationSchedule.html) put_recording_recordingkeys_rotationschedule(body)
|
|
2218
2428
|
|
|
2429
|
+
|
|
2430
|
+
|
|
2219
2431
|
Update key rotation schedule
|
|
2220
2432
|
|
|
2221
2433
|
|
|
2222
2434
|
|
|
2223
2435
|
Wraps PUT /api/v2/recording/recordingkeys/rotationschedule
|
|
2224
2436
|
|
|
2437
|
+
Requires ANY permissions:
|
|
2438
|
+
|
|
2439
|
+
* recording:encryptionKey:edit
|
|
2440
|
+
|
|
2225
2441
|
|
|
2226
2442
|
### Example
|
|
2227
2443
|
~~~ruby
|
|
@@ -2275,12 +2491,18 @@ Name | Type | Description | Notes
|
|
|
2275
2491
|
|
|
2276
2492
|
## -[**RecordingSettings**](RecordingSettings.html) put_recording_settings(body)
|
|
2277
2493
|
|
|
2494
|
+
|
|
2495
|
+
|
|
2278
2496
|
Update the Recording Settings for the Organization
|
|
2279
2497
|
|
|
2280
2498
|
|
|
2281
2499
|
|
|
2282
2500
|
Wraps PUT /api/v2/recording/settings
|
|
2283
2501
|
|
|
2502
|
+
Requires NO permissions:
|
|
2503
|
+
|
|
2504
|
+
|
|
2505
|
+
|
|
2284
2506
|
|
|
2285
2507
|
### Example
|
|
2286
2508
|
~~~ruby
|