purecloudplatformclientv2 58.0.1 → 59.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/{Skill.md → AddressableEntityRef.md} +2 -2
- data/docs/Agent.md +1 -2
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/ArchitectApi.md +298 -14
- data/docs/AsyncConversationQuery.md +21 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversation.md +1 -0
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallHistoryParticipant.md +1 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionViewListing.md +1 -1
- 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/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/Conversation.md +1 -0
- data/docs/ConversationBasic.md +1 -0
- data/docs/ConversationChatEventTopicChatMediaParticipant.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationProperties.md +1 -0
- data/docs/ConversationRoutingData.md +3 -3
- data/docs/CreateManagementUnitApiRequest.md +1 -1
- data/docs/CreateUser.md +1 -1
- 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/DataSchema.md +4 -5
- 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/DialogflowAgent.md +18 -0
- data/docs/DialogflowAgentSummary.md +17 -0
- data/docs/DialogflowAgentSummaryEntityListing.md +22 -0
- data/docs/DialogflowIntent.md +14 -0
- data/docs/DialogflowParameter.md +14 -0
- data/docs/DialogflowProject.md +14 -0
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListDivisionViewListing.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/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMediaParticipant.md +1 -0
- data/docs/EmailMessage.md +1 -0
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExecuteRecordingJobsQuery.md +13 -0
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowOutcome.md +17 -0
- data/docs/FlowOutcomeListing.md +22 -0
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- 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 +762 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguageOverride.md +15 -0
- data/docs/LexBot.md +16 -0
- data/docs/LexBotAlias.md +21 -0
- data/docs/LexBotAliasEntityListing.md +22 -0
- data/docs/LexBotEntityListing.md +22 -0
- data/docs/LexIntent.md +16 -0
- data/docs/LexSlot.md +16 -0
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationDefinition.md +2 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationImage.md +14 -0
- data/docs/LocationsApi.md +6 -2
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnit.md +5 -6
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingApi.md +1211 -134
- data/docs/MessagingIntegration.md +23 -0
- data/docs/MessagingIntegrationEntityListing.md +22 -0
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/MoveManagementUnitRequest.md +13 -0
- data/docs/MoveManagementUnitResponse.md +14 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- 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/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAudit.md +1 -0
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueConversationChatEventTopicChatMediaParticipant.md +1 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicChat.md +1 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +335 -0
- data/docs/RecordingJob.md +23 -0
- data/docs/RecordingJobEntityListing.md +22 -0
- data/docs/RecordingJobsQuery.md +15 -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/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +145 -145
- 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/ScoredAgent.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- 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/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SubscriptionOverviewUsage.md +1 -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/TextMessageListing.md +1 -1
- data/docs/TimeZoneEntityListing.md +1 -1
- 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/TtsEngineEntity.md +20 -0
- data/docs/TtsEngineEntityListing.md +22 -0
- data/docs/TtsSettings.md +14 -0
- data/docs/TtsVoiceEntity.md +19 -0
- data/docs/TtsVoiceEntityListing.md +22 -0
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UpdateManagementUnitRequest.md +15 -0
- 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/UserSkillEntityListing.md +1 -1
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmMoveManagementUnitTopicBusinessUnit.md +13 -0
- data/docs/WfmMoveManagementUnitTopicMoveManagementUnitNotification.md +14 -0
- data/docs/WfmUserNotificationTopicTimeOffRequestNotification.md +18 -0
- data/docs/WfmUserNotificationTopicWfmUserNotification.md +1 -0
- data/docs/WorkforceManagementApi.md +158 -18
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +35 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +334 -6
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +851 -0
- data/lib/purecloudplatformclientv2/api/locations_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +1111 -6
- data/lib/purecloudplatformclientv2/api/recording_api.rb +342 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scim_api.rb +124 -124
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +163 -21
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{skill.rb → addressable_entity_ref.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/agent.rb +8 -32
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +448 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation.rb +27 -1
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation.rb +29 -1
- data/lib/purecloudplatformclientv2/models/conversation_basic.rb +29 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_chat_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_properties.rb +27 -1
- data/lib/purecloudplatformclientv2/models/conversation_routing_data.rb +3 -3
- data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_user.rb +5 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_schema.rb +5 -31
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +335 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary.rb +305 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_intent.rb +240 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_parameter.rb +238 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_project.rb +226 -0
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/email_message.rb +27 -1
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/execute_recording_jobs_query.rb +221 -0
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_outcome.rb +309 -0
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_override.rb +269 -0
- data/lib/purecloudplatformclientv2/models/lex_bot.rb +279 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_alias.rb +444 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/lex_intent.rb +297 -0
- data/lib/purecloudplatformclientv2/models/lex_slot.rb +290 -0
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_definition.rb +56 -1
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_image.rb +227 -0
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit.rb +21 -57
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +510 -0
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/move_management_unit_request.rb +207 -0
- data/lib/purecloudplatformclientv2/models/move_management_unit_response.rb +242 -0
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit.rb +26 -1
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_chat_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_job.rb +480 -0
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +283 -0
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scored_agent.rb +1 -1
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subscription_overview_usage.rb +30 -4
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity.rb +399 -0
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/tts_settings.rb +240 -0
- data/lib/purecloudplatformclientv2/models/tts_voice_entity.rb +372 -0
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/update_management_unit_request.rb +254 -0
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_move_management_unit_topic_business_unit.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_move_management_unit_topic_move_management_unit_notification.rb +240 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_time_off_request_notification.rb +344 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_wfm_user_notification.rb +28 -3
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +72 -4
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MessagingIntegration
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MessagingIntegration
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | A unique Integration Id | |
|
|
11
|
+
| **name** | **String** | The name of the Integration | |
|
|
12
|
+
| **status** | **String** | The status of the Integration | [optional] |
|
|
13
|
+
| **messenger_type** | **String** | The type of Messaging Integration | |
|
|
14
|
+
| **recipient** | [**UriReference**](UriReference.html) | The recipient associated to the Integration. This recipient is used to associate a flow to an integration | [optional] |
|
|
15
|
+
| **date_created** | **DateTime** | Date this Integration was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
16
|
+
| **date_modified** | **DateTime** | Date this Integration was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
17
|
+
| **created_by** | [**UriReference**](UriReference.html) | User reference that created this Integration | [optional] |
|
|
18
|
+
| **modified_by** | [**UriReference**](UriReference.html) | User reference that last modified this Integration | [optional] |
|
|
19
|
+
| **version** | **Integer** | Version number required for updates. | |
|
|
20
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
21
|
+
{: class="table table-striped"}
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MessagingIntegrationEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MessagingIntegrationEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<MessagingIntegration>**](MessagingIntegration.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_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
|
+
|
|
@@ -13,8 +13,8 @@ title: MessagingStickerEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MoveManagementUnitRequest
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MoveManagementUnitRequest
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **business_unit_id** | **String** | The ID of the business unit to which to move the management unit | |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: MoveManagementUnitResponse
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::MoveManagementUnitResponse
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **business_unit** | [**BusinessUnitReference**](BusinessUnitReference.html) | The new business unit | [optional] |
|
|
11
|
+
| **status** | **String** | The status of the move. Will always be 'Processing' unless the Management Unit is already in the requested Business Unit in which case it will be 'Complete' | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/NoteListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: NoteListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: OAuthClientEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: OAuthProviderEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: OrganizationPresenceEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: OrganizationRoleEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: OrphanRecordingListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: OutboundRouteBaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: OutboundRouteEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: PermissionCollectionEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: PhoneBaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/PhoneEntityListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: PhoneEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: PhoneMetaBaseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: PhysicalInterfaceEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/PolicyEntityListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: PolicyEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: PromptAssetEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/PromptEntityListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: PromptEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/QualityAudit.md
CHANGED
|
@@ -10,6 +10,7 @@ title: QualityAudit
|
|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **user** | [**User**](User.html) | | [optional] |
|
|
13
|
+
| **job_id** | **String** | | [optional] |
|
|
13
14
|
| **level** | **String** | | [optional] |
|
|
14
15
|
| **entity** | [**AuditEntity**](AuditEntity.html) | | [optional] |
|
|
15
16
|
| **timestamp** | **String** | | [optional] |
|
data/docs/QualityAuditPage.md
CHANGED
|
@@ -13,8 +13,8 @@ title: QualityAuditPage
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -39,6 +39,7 @@ title: QueueConversationChatEventTopicChatMediaParticipant
|
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**QueueConversationChatEventTopicJourneyContext**](QueueConversationChatEventTopicJourneyContext.html) | | [optional] |
|
|
41
41
|
| **room_id** | **String** | | [optional] |
|
|
42
|
+
| **avatar_image_url** | **String** | | [optional] |
|
|
42
43
|
{: class="table table-striped"}
|
|
43
44
|
|
|
44
45
|
|
|
@@ -13,6 +13,7 @@ title: QueueConversationEventTopicChat
|
|
|
13
13
|
| **script_id** | **String** | | [optional] |
|
|
14
14
|
| **peer_id** | **String** | | [optional] |
|
|
15
15
|
| **room_id** | **String** | | [optional] |
|
|
16
|
+
| **avatar_image_url** | **String** | | [optional] |
|
|
16
17
|
| **held** | **BOOLEAN** | | [optional] |
|
|
17
18
|
| **disconnect_type** | **String** | | [optional] |
|
|
18
19
|
| **start_hold_time** | **DateTime** | | [optional] |
|
|
@@ -13,6 +13,7 @@ title: QueueConversationSocialExpressionEventTopicChat
|
|
|
13
13
|
| **script_id** | **String** | | [optional] |
|
|
14
14
|
| **peer_id** | **String** | | [optional] |
|
|
15
15
|
| **room_id** | **String** | | [optional] |
|
|
16
|
+
| **avatar_image_url** | **String** | | [optional] |
|
|
16
17
|
| **held** | **BOOLEAN** | | [optional] |
|
|
17
18
|
| **disconnect_type** | **String** | | [optional] |
|
|
18
19
|
| **start_hold_time** | **DateTime** | | [optional] |
|
|
@@ -13,6 +13,7 @@ title: QueueConversationVideoEventTopicChat
|
|
|
13
13
|
| **script_id** | **String** | | [optional] |
|
|
14
14
|
| **peer_id** | **String** | | [optional] |
|
|
15
15
|
| **room_id** | **String** | | [optional] |
|
|
16
|
+
| **avatar_image_url** | **String** | | [optional] |
|
|
16
17
|
| **held** | **BOOLEAN** | | [optional] |
|
|
17
18
|
| **disconnect_type** | **String** | | [optional] |
|
|
18
19
|
| **start_hold_time** | **DateTime** | | [optional] |
|
data/docs/QueueEntityListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: QueueEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: QueueMemberEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/RecipientListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: RecipientListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/RecordingApi.md
CHANGED
|
@@ -10,6 +10,7 @@ Method | Description
|
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
11
|
[**delete_conversation_recording_annotation**](RecordingApi.html#delete_conversation_recording_annotation) | Delete annotation
|
|
12
12
|
[**delete_orphanrecording**](RecordingApi.html#delete_orphanrecording) | Deletes a single orphan recording
|
|
13
|
+
[**delete_recording_job**](RecordingApi.html#delete_recording_job) | Delete the recording bulk job
|
|
13
14
|
[**delete_recording_mediaretentionpolicies**](RecordingApi.html#delete_recording_mediaretentionpolicies) | Delete media retention policies
|
|
14
15
|
[**delete_recording_mediaretentionpolicy**](RecordingApi.html#delete_recording_mediaretentionpolicy) | Delete a media retention policy
|
|
15
16
|
[**get_conversation_recording**](RecordingApi.html#get_conversation_recording) | Gets a specific recording.
|
|
@@ -22,6 +23,8 @@ Method | Description
|
|
|
22
23
|
[**get_orphanrecording_media**](RecordingApi.html#get_orphanrecording_media) | Gets the media of a single orphan recording
|
|
23
24
|
[**get_orphanrecordings**](RecordingApi.html#get_orphanrecordings) | Gets all orphan recordings
|
|
24
25
|
[**get_recording_batchrequest**](RecordingApi.html#get_recording_batchrequest) | Get the status and results for a batch request job, only the user that submitted the job may retrieve results
|
|
26
|
+
[**get_recording_job**](RecordingApi.html#get_recording_job) | Get the status of the job associated with the job id.
|
|
27
|
+
[**get_recording_jobs**](RecordingApi.html#get_recording_jobs) | Get the status of all jobs within the user's organization
|
|
25
28
|
[**get_recording_localkeys_setting**](RecordingApi.html#get_recording_localkeys_setting) | Get the local encryption settings
|
|
26
29
|
[**get_recording_localkeys_settings**](RecordingApi.html#get_recording_localkeys_settings) | gets a list local key settings data
|
|
27
30
|
[**get_recording_mediaretentionpolicies**](RecordingApi.html#get_recording_mediaretentionpolicies) | Gets media retention policy list with query options to filter on name and enabled.
|
|
@@ -34,6 +37,7 @@ Method | Description
|
|
|
34
37
|
[**patch_recordings_screensession**](RecordingApi.html#patch_recordings_screensession) | Update a screen recording session
|
|
35
38
|
[**post_conversation_recording_annotations**](RecordingApi.html#post_conversation_recording_annotations) | Create annotation
|
|
36
39
|
[**post_recording_batchrequests**](RecordingApi.html#post_recording_batchrequests) | Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration.
|
|
40
|
+
[**post_recording_jobs**](RecordingApi.html#post_recording_jobs) | Create a recording bulk job
|
|
37
41
|
[**post_recording_localkeys**](RecordingApi.html#post_recording_localkeys) | create a local recording key
|
|
38
42
|
[**post_recording_localkeys_settings**](RecordingApi.html#post_recording_localkeys_settings) | create settings for local key creation
|
|
39
43
|
[**post_recording_mediaretentionpolicies**](RecordingApi.html#post_recording_mediaretentionpolicies) | Create media retention policy
|
|
@@ -41,6 +45,7 @@ Method | Description
|
|
|
41
45
|
[**put_conversation_recording**](RecordingApi.html#put_conversation_recording) | Updates the retention records on a recording.
|
|
42
46
|
[**put_conversation_recording_annotation**](RecordingApi.html#put_conversation_recording_annotation) | Update annotation
|
|
43
47
|
[**put_orphanrecording**](RecordingApi.html#put_orphanrecording) | Updates an orphan recording to a regular recording with retention values
|
|
48
|
+
[**put_recording_job**](RecordingApi.html#put_recording_job) | Execute the recording bulk job
|
|
44
49
|
[**put_recording_localkeys_setting**](RecordingApi.html#put_recording_localkeys_setting) | Update the local encryption settings
|
|
45
50
|
[**put_recording_mediaretentionpolicy**](RecordingApi.html#put_recording_mediaretentionpolicy) | Update a media retention policy
|
|
46
51
|
[**put_recording_recordingkeys_rotationschedule**](RecordingApi.html#put_recording_recordingkeys_rotationschedule) | Update key rotation schedule
|
|
@@ -181,6 +186,70 @@ Name | Type | Description | Notes
|
|
|
181
186
|
|
|
182
187
|
|
|
183
188
|
|
|
189
|
+
<a name="delete_recording_job"></a>
|
|
190
|
+
|
|
191
|
+
## delete_recording_job(job_id)
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
Delete the recording bulk job
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
Wraps DELETE /api/v2/recording/jobs/{jobId}
|
|
200
|
+
|
|
201
|
+
Requires ANY permissions:
|
|
202
|
+
|
|
203
|
+
* recording:job:delete
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
### Example
|
|
207
|
+
```{"language":"ruby"}
|
|
208
|
+
# load the gem
|
|
209
|
+
require 'purecloudplatformclientv2'
|
|
210
|
+
# setup authorization
|
|
211
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
212
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
213
|
+
environment = "mypurecloud.com"
|
|
214
|
+
|
|
215
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
216
|
+
|
|
217
|
+
PureCloud.configure do |config|
|
|
218
|
+
config.access_token = @authToken
|
|
219
|
+
end
|
|
220
|
+
|
|
221
|
+
api_instance = PureCloud::RecordingApi.new
|
|
222
|
+
|
|
223
|
+
job_id = "job_id_example" # String | jobId
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
begin
|
|
227
|
+
#Delete the recording bulk job
|
|
228
|
+
api_instance.delete_recording_job(job_id)
|
|
229
|
+
rescue PureCloud::ApiError => e
|
|
230
|
+
puts "Exception when calling RecordingApi->delete_recording_job: #{e}"
|
|
231
|
+
end
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### Parameters
|
|
235
|
+
|
|
236
|
+
Name | Type | Description | Notes
|
|
237
|
+
------------- | ------------- | ------------- | -------------
|
|
238
|
+
**job_id** | **String**| jobId | |
|
|
239
|
+
{: class="table table-striped"}
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
### Return type
|
|
243
|
+
|
|
244
|
+
nil (empty response body)
|
|
245
|
+
|
|
246
|
+
### HTTP request headers
|
|
247
|
+
|
|
248
|
+
- **Content-Type**: application/json
|
|
249
|
+
- **Accept**: application/json
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
184
253
|
<a name="delete_recording_mediaretentionpolicies"></a>
|
|
185
254
|
|
|
186
255
|
## delete_recording_mediaretentionpolicies(ids)
|
|
@@ -1004,6 +1073,139 @@ Name | Type | Description | Notes
|
|
|
1004
1073
|
|
|
1005
1074
|
|
|
1006
1075
|
|
|
1076
|
+
<a name="get_recording_job"></a>
|
|
1077
|
+
|
|
1078
|
+
## [**RecordingJob**](RecordingJob.html) get_recording_job(job_id)
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
Get the status of the job associated with the job id.
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
Wraps GET /api/v2/recording/jobs/{jobId}
|
|
1087
|
+
|
|
1088
|
+
Requires ANY permissions:
|
|
1089
|
+
|
|
1090
|
+
* recording:job:view
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
### Example
|
|
1094
|
+
```{"language":"ruby"}
|
|
1095
|
+
# load the gem
|
|
1096
|
+
require 'purecloudplatformclientv2'
|
|
1097
|
+
# setup authorization
|
|
1098
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1099
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1100
|
+
environment = "mypurecloud.com"
|
|
1101
|
+
|
|
1102
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1103
|
+
|
|
1104
|
+
PureCloud.configure do |config|
|
|
1105
|
+
config.access_token = @authToken
|
|
1106
|
+
end
|
|
1107
|
+
|
|
1108
|
+
api_instance = PureCloud::RecordingApi.new
|
|
1109
|
+
|
|
1110
|
+
job_id = "job_id_example" # String | jobId
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
begin
|
|
1114
|
+
#Get the status of the job associated with the job id.
|
|
1115
|
+
result = api_instance.get_recording_job(job_id)
|
|
1116
|
+
p result
|
|
1117
|
+
rescue PureCloud::ApiError => e
|
|
1118
|
+
puts "Exception when calling RecordingApi->get_recording_job: #{e}"
|
|
1119
|
+
end
|
|
1120
|
+
```
|
|
1121
|
+
|
|
1122
|
+
### Parameters
|
|
1123
|
+
|
|
1124
|
+
Name | Type | Description | Notes
|
|
1125
|
+
------------- | ------------- | ------------- | -------------
|
|
1126
|
+
**job_id** | **String**| jobId | |
|
|
1127
|
+
{: class="table table-striped"}
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
### Return type
|
|
1131
|
+
|
|
1132
|
+
[**RecordingJob**](RecordingJob.html)
|
|
1133
|
+
|
|
1134
|
+
### HTTP request headers
|
|
1135
|
+
|
|
1136
|
+
- **Content-Type**: application/json
|
|
1137
|
+
- **Accept**: application/json
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
<a name="get_recording_jobs"></a>
|
|
1142
|
+
|
|
1143
|
+
## [**RecordingJobEntityListing**](RecordingJobEntityListing.html) get_recording_jobs(opts)
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
Get the status of all jobs within the user's organization
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
Wraps GET /api/v2/recording/jobs
|
|
1152
|
+
|
|
1153
|
+
Requires ANY permissions:
|
|
1154
|
+
|
|
1155
|
+
* recording:job:view
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
### Example
|
|
1159
|
+
```{"language":"ruby"}
|
|
1160
|
+
# load the gem
|
|
1161
|
+
require 'purecloudplatformclientv2'
|
|
1162
|
+
# setup authorization
|
|
1163
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1164
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1165
|
+
environment = "mypurecloud.com"
|
|
1166
|
+
|
|
1167
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1168
|
+
|
|
1169
|
+
PureCloud.configure do |config|
|
|
1170
|
+
config.access_token = @authToken
|
|
1171
|
+
end
|
|
1172
|
+
|
|
1173
|
+
api_instance = PureCloud::RecordingApi.new
|
|
1174
|
+
|
|
1175
|
+
opts = {
|
|
1176
|
+
page_size: 25, # Integer | Page size
|
|
1177
|
+
page_number: 1 # Integer | Page number
|
|
1178
|
+
}
|
|
1179
|
+
|
|
1180
|
+
begin
|
|
1181
|
+
#Get the status of all jobs within the user's organization
|
|
1182
|
+
result = api_instance.get_recording_jobs(opts)
|
|
1183
|
+
p result
|
|
1184
|
+
rescue PureCloud::ApiError => e
|
|
1185
|
+
puts "Exception when calling RecordingApi->get_recording_jobs: #{e}"
|
|
1186
|
+
end
|
|
1187
|
+
```
|
|
1188
|
+
|
|
1189
|
+
### Parameters
|
|
1190
|
+
|
|
1191
|
+
Name | Type | Description | Notes
|
|
1192
|
+
------------- | ------------- | ------------- | -------------
|
|
1193
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
1194
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1195
|
+
{: class="table table-striped"}
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
### Return type
|
|
1199
|
+
|
|
1200
|
+
[**RecordingJobEntityListing**](RecordingJobEntityListing.html)
|
|
1201
|
+
|
|
1202
|
+
### HTTP request headers
|
|
1203
|
+
|
|
1204
|
+
- **Content-Type**: application/json
|
|
1205
|
+
- **Accept**: application/json
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
|
|
1007
1209
|
<a name="get_recording_localkeys_setting"></a>
|
|
1008
1210
|
|
|
1009
1211
|
## [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) get_recording_localkeys_setting(settings_id)
|
|
@@ -1805,6 +2007,71 @@ Name | Type | Description | Notes
|
|
|
1805
2007
|
|
|
1806
2008
|
|
|
1807
2009
|
|
|
2010
|
+
<a name="post_recording_jobs"></a>
|
|
2011
|
+
|
|
2012
|
+
## [**RecordingJob**](RecordingJob.html) post_recording_jobs(body)
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
|
|
2016
|
+
Create a recording bulk job
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
|
|
2020
|
+
Wraps POST /api/v2/recording/jobs
|
|
2021
|
+
|
|
2022
|
+
Requires ANY permissions:
|
|
2023
|
+
|
|
2024
|
+
* recording:job:add
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
### Example
|
|
2028
|
+
```{"language":"ruby"}
|
|
2029
|
+
# load the gem
|
|
2030
|
+
require 'purecloudplatformclientv2'
|
|
2031
|
+
# setup authorization
|
|
2032
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2033
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2034
|
+
environment = "mypurecloud.com"
|
|
2035
|
+
|
|
2036
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2037
|
+
|
|
2038
|
+
PureCloud.configure do |config|
|
|
2039
|
+
config.access_token = @authToken
|
|
2040
|
+
end
|
|
2041
|
+
|
|
2042
|
+
api_instance = PureCloud::RecordingApi.new
|
|
2043
|
+
|
|
2044
|
+
body = PureCloud::RecordingJobsQuery.new # RecordingJobsQuery | query
|
|
2045
|
+
|
|
2046
|
+
|
|
2047
|
+
begin
|
|
2048
|
+
#Create a recording bulk job
|
|
2049
|
+
result = api_instance.post_recording_jobs(body)
|
|
2050
|
+
p result
|
|
2051
|
+
rescue PureCloud::ApiError => e
|
|
2052
|
+
puts "Exception when calling RecordingApi->post_recording_jobs: #{e}"
|
|
2053
|
+
end
|
|
2054
|
+
```
|
|
2055
|
+
|
|
2056
|
+
### Parameters
|
|
2057
|
+
|
|
2058
|
+
Name | Type | Description | Notes
|
|
2059
|
+
------------- | ------------- | ------------- | -------------
|
|
2060
|
+
**body** | [**RecordingJobsQuery**](RecordingJobsQuery.html)| query | |
|
|
2061
|
+
{: class="table table-striped"}
|
|
2062
|
+
|
|
2063
|
+
|
|
2064
|
+
### Return type
|
|
2065
|
+
|
|
2066
|
+
[**RecordingJob**](RecordingJob.html)
|
|
2067
|
+
|
|
2068
|
+
### HTTP request headers
|
|
2069
|
+
|
|
2070
|
+
- **Content-Type**: application/json
|
|
2071
|
+
- **Accept**: application/json
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
|
|
1808
2075
|
<a name="post_recording_localkeys"></a>
|
|
1809
2076
|
|
|
1810
2077
|
## [**EncryptionKey**](EncryptionKey.html) post_recording_localkeys(body)
|
|
@@ -2271,6 +2538,74 @@ Name | Type | Description | Notes
|
|
|
2271
2538
|
|
|
2272
2539
|
|
|
2273
2540
|
|
|
2541
|
+
<a name="put_recording_job"></a>
|
|
2542
|
+
|
|
2543
|
+
## [**RecordingJob**](RecordingJob.html) put_recording_job(job_id, body)
|
|
2544
|
+
|
|
2545
|
+
|
|
2546
|
+
|
|
2547
|
+
Execute the recording bulk job
|
|
2548
|
+
|
|
2549
|
+
|
|
2550
|
+
|
|
2551
|
+
Wraps PUT /api/v2/recording/jobs/{jobId}
|
|
2552
|
+
|
|
2553
|
+
Requires ANY permissions:
|
|
2554
|
+
|
|
2555
|
+
* recording:job:edit
|
|
2556
|
+
|
|
2557
|
+
|
|
2558
|
+
### Example
|
|
2559
|
+
```{"language":"ruby"}
|
|
2560
|
+
# load the gem
|
|
2561
|
+
require 'purecloudplatformclientv2'
|
|
2562
|
+
# setup authorization
|
|
2563
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2564
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2565
|
+
environment = "mypurecloud.com"
|
|
2566
|
+
|
|
2567
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2568
|
+
|
|
2569
|
+
PureCloud.configure do |config|
|
|
2570
|
+
config.access_token = @authToken
|
|
2571
|
+
end
|
|
2572
|
+
|
|
2573
|
+
api_instance = PureCloud::RecordingApi.new
|
|
2574
|
+
|
|
2575
|
+
job_id = "job_id_example" # String | jobId
|
|
2576
|
+
|
|
2577
|
+
body = PureCloud::ExecuteRecordingJobsQuery.new # ExecuteRecordingJobsQuery | query
|
|
2578
|
+
|
|
2579
|
+
|
|
2580
|
+
begin
|
|
2581
|
+
#Execute the recording bulk job
|
|
2582
|
+
result = api_instance.put_recording_job(job_id, body)
|
|
2583
|
+
p result
|
|
2584
|
+
rescue PureCloud::ApiError => e
|
|
2585
|
+
puts "Exception when calling RecordingApi->put_recording_job: #{e}"
|
|
2586
|
+
end
|
|
2587
|
+
```
|
|
2588
|
+
|
|
2589
|
+
### Parameters
|
|
2590
|
+
|
|
2591
|
+
Name | Type | Description | Notes
|
|
2592
|
+
------------- | ------------- | ------------- | -------------
|
|
2593
|
+
**job_id** | **String**| jobId | |
|
|
2594
|
+
**body** | [**ExecuteRecordingJobsQuery**](ExecuteRecordingJobsQuery.html)| query | |
|
|
2595
|
+
{: class="table table-striped"}
|
|
2596
|
+
|
|
2597
|
+
|
|
2598
|
+
### Return type
|
|
2599
|
+
|
|
2600
|
+
[**RecordingJob**](RecordingJob.html)
|
|
2601
|
+
|
|
2602
|
+
### HTTP request headers
|
|
2603
|
+
|
|
2604
|
+
- **Content-Type**: application/json
|
|
2605
|
+
- **Accept**: application/json
|
|
2606
|
+
|
|
2607
|
+
|
|
2608
|
+
|
|
2274
2609
|
<a name="put_recording_localkeys_setting"></a>
|
|
2275
2610
|
|
|
2276
2611
|
## [**LocalEncryptionConfiguration**](LocalEncryptionConfiguration.html) put_recording_localkeys_setting(settings_id, body)
|