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
|
@@ -13,8 +13,8 @@ title: FlowDivisionViewEntityListing
|
|
|
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/FlowEntityListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: FlowEntityListing
|
|
|
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/FlowOutcome.md
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: FlowOutcome
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::FlowOutcome
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The flow outcome identifier | [optional] |
|
|
11
|
+
| **name** | **String** | The flow outcome name. | |
|
|
12
|
+
| **description** | **String** | | [optional] |
|
|
13
|
+
| **current_operation** | [**Operation**](Operation.html) | | [optional] |
|
|
14
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: FlowOutcomeListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::FlowOutcomeListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<FlowOutcome>**](FlowOutcome.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: FlowVersionEntityListing
|
|
|
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: GDPRRequestEntityListing
|
|
|
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: GDPRSubjectEntityListing
|
|
|
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/GreetingListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: GreetingListing
|
|
|
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/GroupEntityListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: GroupEntityListing
|
|
|
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: GroupProfileEntityListing
|
|
|
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/IVREntityListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: IVREntityListing
|
|
|
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: InboundDomainEntityListing
|
|
|
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: InboundRouteEntityListing
|
|
|
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: IntegrationEntityListing
|
|
|
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: IntegrationEventEntityListing
|
|
|
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: IntegrationTypeEntityListing
|
|
|
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/IntegrationsApi.md
CHANGED
|
@@ -31,6 +31,16 @@ Method | Description
|
|
|
31
31
|
[**get_integrations_credentials_types**](IntegrationsApi.html#get_integrations_credentials_types) | List all credential types
|
|
32
32
|
[**get_integrations_eventlog**](IntegrationsApi.html#get_integrations_eventlog) | List all events
|
|
33
33
|
[**get_integrations_eventlog_event_id**](IntegrationsApi.html#get_integrations_eventlog_event_id) | Get a single event
|
|
34
|
+
[**get_integrations_speech_dialogflow_agent**](IntegrationsApi.html#get_integrations_speech_dialogflow_agent) | Get details about a Dialogflow agent
|
|
35
|
+
[**get_integrations_speech_dialogflow_agents**](IntegrationsApi.html#get_integrations_speech_dialogflow_agents) | Get a list of Dialogflow agents in the customers' Google accounts
|
|
36
|
+
[**get_integrations_speech_lex_bot_alias**](IntegrationsApi.html#get_integrations_speech_lex_bot_alias) | Get details about a Lex bot alias
|
|
37
|
+
[**get_integrations_speech_lex_bot_bot_id_aliases**](IntegrationsApi.html#get_integrations_speech_lex_bot_bot_id_aliases) | Get a list of aliases for a bot in the customer's AWS accounts
|
|
38
|
+
[**get_integrations_speech_lex_bots**](IntegrationsApi.html#get_integrations_speech_lex_bots) | Get a list of Lex bots in the customers' AWS accounts
|
|
39
|
+
[**get_integrations_speech_tts_engine**](IntegrationsApi.html#get_integrations_speech_tts_engine) | Get details about a TTS engine
|
|
40
|
+
[**get_integrations_speech_tts_engine_voice**](IntegrationsApi.html#get_integrations_speech_tts_engine_voice) | Get details about a specific voice for a TTS engine
|
|
41
|
+
[**get_integrations_speech_tts_engine_voices**](IntegrationsApi.html#get_integrations_speech_tts_engine_voices) | Get a list of voices for a TTS engine
|
|
42
|
+
[**get_integrations_speech_tts_engines**](IntegrationsApi.html#get_integrations_speech_tts_engines) | Get a list of TTS engines enabled for org
|
|
43
|
+
[**get_integrations_speech_tts_settings**](IntegrationsApi.html#get_integrations_speech_tts_settings) | Get TTS settings for an org
|
|
34
44
|
[**get_integrations_type**](IntegrationsApi.html#get_integrations_type) | Get integration type.
|
|
35
45
|
[**get_integrations_type_configschema**](IntegrationsApi.html#get_integrations_type_configschema) | Get properties config schema for an integration type.
|
|
36
46
|
[**get_integrations_types**](IntegrationsApi.html#get_integrations_types) | List integration types
|
|
@@ -49,6 +59,7 @@ Method | Description
|
|
|
49
59
|
[**post_integrations_workforcemanagement_vendorconnection**](IntegrationsApi.html#post_integrations_workforcemanagement_vendorconnection) | Add a vendor connection
|
|
50
60
|
[**put_integration_config_current**](IntegrationsApi.html#put_integration_config_current) | Update integration configuration.
|
|
51
61
|
[**put_integrations_credential**](IntegrationsApi.html#put_integrations_credential) | Update a set of credentials
|
|
62
|
+
[**put_integrations_speech_tts_settings**](IntegrationsApi.html#put_integrations_speech_tts_settings) | Update TTS settings for an org
|
|
52
63
|
{: class="table table-striped"}
|
|
53
64
|
|
|
54
65
|
<a name="delete_integration"></a>
|
|
@@ -1662,6 +1673,692 @@ Name | Type | Description | Notes
|
|
|
1662
1673
|
|
|
1663
1674
|
|
|
1664
1675
|
|
|
1676
|
+
<a name="get_integrations_speech_dialogflow_agent"></a>
|
|
1677
|
+
|
|
1678
|
+
## [**DialogflowAgent**](DialogflowAgent.html) get_integrations_speech_dialogflow_agent(agent_id)
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
|
|
1682
|
+
Get details about a Dialogflow agent
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
Wraps GET /api/v2/integrations/speech/dialogflow/agents/{agentId}
|
|
1687
|
+
|
|
1688
|
+
Requires ANY permissions:
|
|
1689
|
+
|
|
1690
|
+
* integrations:integration:view
|
|
1691
|
+
|
|
1692
|
+
|
|
1693
|
+
### Example
|
|
1694
|
+
```{"language":"ruby"}
|
|
1695
|
+
# load the gem
|
|
1696
|
+
require 'purecloudplatformclientv2'
|
|
1697
|
+
# setup authorization
|
|
1698
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1699
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1700
|
+
environment = "mypurecloud.com"
|
|
1701
|
+
|
|
1702
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1703
|
+
|
|
1704
|
+
PureCloud.configure do |config|
|
|
1705
|
+
config.access_token = @authToken
|
|
1706
|
+
end
|
|
1707
|
+
|
|
1708
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
1709
|
+
|
|
1710
|
+
agent_id = "agent_id_example" # String | The agent ID
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
begin
|
|
1714
|
+
#Get details about a Dialogflow agent
|
|
1715
|
+
result = api_instance.get_integrations_speech_dialogflow_agent(agent_id)
|
|
1716
|
+
p result
|
|
1717
|
+
rescue PureCloud::ApiError => e
|
|
1718
|
+
puts "Exception when calling IntegrationsApi->get_integrations_speech_dialogflow_agent: #{e}"
|
|
1719
|
+
end
|
|
1720
|
+
```
|
|
1721
|
+
|
|
1722
|
+
### Parameters
|
|
1723
|
+
|
|
1724
|
+
Name | Type | Description | Notes
|
|
1725
|
+
------------- | ------------- | ------------- | -------------
|
|
1726
|
+
**agent_id** | **String**| The agent ID | |
|
|
1727
|
+
{: class="table table-striped"}
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
### Return type
|
|
1731
|
+
|
|
1732
|
+
[**DialogflowAgent**](DialogflowAgent.html)
|
|
1733
|
+
|
|
1734
|
+
### HTTP request headers
|
|
1735
|
+
|
|
1736
|
+
- **Content-Type**: application/json
|
|
1737
|
+
- **Accept**: application/json
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
<a name="get_integrations_speech_dialogflow_agents"></a>
|
|
1742
|
+
|
|
1743
|
+
## [**DialogflowAgentSummaryEntityListing**](DialogflowAgentSummaryEntityListing.html) get_integrations_speech_dialogflow_agents(opts)
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
Get a list of Dialogflow agents in the customers' Google accounts
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
Wraps GET /api/v2/integrations/speech/dialogflow/agents
|
|
1752
|
+
|
|
1753
|
+
Requires ANY permissions:
|
|
1754
|
+
|
|
1755
|
+
* integrations:integration:view
|
|
1756
|
+
|
|
1757
|
+
|
|
1758
|
+
### Example
|
|
1759
|
+
```{"language":"ruby"}
|
|
1760
|
+
# load the gem
|
|
1761
|
+
require 'purecloudplatformclientv2'
|
|
1762
|
+
# setup authorization
|
|
1763
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1764
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1765
|
+
environment = "mypurecloud.com"
|
|
1766
|
+
|
|
1767
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1768
|
+
|
|
1769
|
+
PureCloud.configure do |config|
|
|
1770
|
+
config.access_token = @authToken
|
|
1771
|
+
end
|
|
1772
|
+
|
|
1773
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
1774
|
+
|
|
1775
|
+
opts = {
|
|
1776
|
+
page_number: 1, # Integer | Page number
|
|
1777
|
+
page_size: 25, # Integer | Page size
|
|
1778
|
+
name: "name_example" # String | Filter on agent name
|
|
1779
|
+
}
|
|
1780
|
+
|
|
1781
|
+
begin
|
|
1782
|
+
#Get a list of Dialogflow agents in the customers' Google accounts
|
|
1783
|
+
result = api_instance.get_integrations_speech_dialogflow_agents(opts)
|
|
1784
|
+
p result
|
|
1785
|
+
rescue PureCloud::ApiError => e
|
|
1786
|
+
puts "Exception when calling IntegrationsApi->get_integrations_speech_dialogflow_agents: #{e}"
|
|
1787
|
+
end
|
|
1788
|
+
```
|
|
1789
|
+
|
|
1790
|
+
### Parameters
|
|
1791
|
+
|
|
1792
|
+
Name | Type | Description | Notes
|
|
1793
|
+
------------- | ------------- | ------------- | -------------
|
|
1794
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1795
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
1796
|
+
**name** | **String**| Filter on agent name | [optional] |
|
|
1797
|
+
{: class="table table-striped"}
|
|
1798
|
+
|
|
1799
|
+
|
|
1800
|
+
### Return type
|
|
1801
|
+
|
|
1802
|
+
[**DialogflowAgentSummaryEntityListing**](DialogflowAgentSummaryEntityListing.html)
|
|
1803
|
+
|
|
1804
|
+
### HTTP request headers
|
|
1805
|
+
|
|
1806
|
+
- **Content-Type**: application/json
|
|
1807
|
+
- **Accept**: application/json
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
|
|
1811
|
+
<a name="get_integrations_speech_lex_bot_alias"></a>
|
|
1812
|
+
|
|
1813
|
+
## [**LexBotAlias**](LexBotAlias.html) get_integrations_speech_lex_bot_alias(alias_id)
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
|
|
1817
|
+
Get details about a Lex bot alias
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
Wraps GET /api/v2/integrations/speech/lex/bot/alias/{aliasId}
|
|
1822
|
+
|
|
1823
|
+
Requires ANY permissions:
|
|
1824
|
+
|
|
1825
|
+
* integrations:integration:view
|
|
1826
|
+
|
|
1827
|
+
|
|
1828
|
+
### Example
|
|
1829
|
+
```{"language":"ruby"}
|
|
1830
|
+
# load the gem
|
|
1831
|
+
require 'purecloudplatformclientv2'
|
|
1832
|
+
# setup authorization
|
|
1833
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1834
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1835
|
+
environment = "mypurecloud.com"
|
|
1836
|
+
|
|
1837
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1838
|
+
|
|
1839
|
+
PureCloud.configure do |config|
|
|
1840
|
+
config.access_token = @authToken
|
|
1841
|
+
end
|
|
1842
|
+
|
|
1843
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
1844
|
+
|
|
1845
|
+
alias_id = "alias_id_example" # String | The alias ID
|
|
1846
|
+
|
|
1847
|
+
|
|
1848
|
+
begin
|
|
1849
|
+
#Get details about a Lex bot alias
|
|
1850
|
+
result = api_instance.get_integrations_speech_lex_bot_alias(alias_id)
|
|
1851
|
+
p result
|
|
1852
|
+
rescue PureCloud::ApiError => e
|
|
1853
|
+
puts "Exception when calling IntegrationsApi->get_integrations_speech_lex_bot_alias: #{e}"
|
|
1854
|
+
end
|
|
1855
|
+
```
|
|
1856
|
+
|
|
1857
|
+
### Parameters
|
|
1858
|
+
|
|
1859
|
+
Name | Type | Description | Notes
|
|
1860
|
+
------------- | ------------- | ------------- | -------------
|
|
1861
|
+
**alias_id** | **String**| The alias ID | |
|
|
1862
|
+
{: class="table table-striped"}
|
|
1863
|
+
|
|
1864
|
+
|
|
1865
|
+
### Return type
|
|
1866
|
+
|
|
1867
|
+
[**LexBotAlias**](LexBotAlias.html)
|
|
1868
|
+
|
|
1869
|
+
### HTTP request headers
|
|
1870
|
+
|
|
1871
|
+
- **Content-Type**: application/json
|
|
1872
|
+
- **Accept**: application/json
|
|
1873
|
+
|
|
1874
|
+
|
|
1875
|
+
|
|
1876
|
+
<a name="get_integrations_speech_lex_bot_bot_id_aliases"></a>
|
|
1877
|
+
|
|
1878
|
+
## [**LexBotAliasEntityListing**](LexBotAliasEntityListing.html) get_integrations_speech_lex_bot_bot_id_aliases(bot_id, opts)
|
|
1879
|
+
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
Get a list of aliases for a bot in the customer's AWS accounts
|
|
1883
|
+
|
|
1884
|
+
|
|
1885
|
+
|
|
1886
|
+
Wraps GET /api/v2/integrations/speech/lex/bot/{botId}/aliases
|
|
1887
|
+
|
|
1888
|
+
Requires ANY permissions:
|
|
1889
|
+
|
|
1890
|
+
* integrations:integration:view
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
### Example
|
|
1894
|
+
```{"language":"ruby"}
|
|
1895
|
+
# load the gem
|
|
1896
|
+
require 'purecloudplatformclientv2'
|
|
1897
|
+
# setup authorization
|
|
1898
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1899
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1900
|
+
environment = "mypurecloud.com"
|
|
1901
|
+
|
|
1902
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1903
|
+
|
|
1904
|
+
PureCloud.configure do |config|
|
|
1905
|
+
config.access_token = @authToken
|
|
1906
|
+
end
|
|
1907
|
+
|
|
1908
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
1909
|
+
|
|
1910
|
+
bot_id = "bot_id_example" # String | The bot ID
|
|
1911
|
+
|
|
1912
|
+
opts = {
|
|
1913
|
+
page_number: 1, # Integer | Page number
|
|
1914
|
+
page_size: 25, # Integer | Page size
|
|
1915
|
+
status: "status_example", # String | Filter on alias status
|
|
1916
|
+
name: "name_example" # String | Filter on alias name
|
|
1917
|
+
}
|
|
1918
|
+
|
|
1919
|
+
begin
|
|
1920
|
+
#Get a list of aliases for a bot in the customer's AWS accounts
|
|
1921
|
+
result = api_instance.get_integrations_speech_lex_bot_bot_id_aliases(bot_id, opts)
|
|
1922
|
+
p result
|
|
1923
|
+
rescue PureCloud::ApiError => e
|
|
1924
|
+
puts "Exception when calling IntegrationsApi->get_integrations_speech_lex_bot_bot_id_aliases: #{e}"
|
|
1925
|
+
end
|
|
1926
|
+
```
|
|
1927
|
+
|
|
1928
|
+
### Parameters
|
|
1929
|
+
|
|
1930
|
+
Name | Type | Description | Notes
|
|
1931
|
+
------------- | ------------- | ------------- | -------------
|
|
1932
|
+
**bot_id** | **String**| The bot ID | |
|
|
1933
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1934
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
1935
|
+
**status** | **String**| Filter on alias status | [optional] <br />**Values**: READY, FAILED, BUILDING, NOT_BUILT |
|
|
1936
|
+
**name** | **String**| Filter on alias name | [optional] |
|
|
1937
|
+
{: class="table table-striped"}
|
|
1938
|
+
|
|
1939
|
+
|
|
1940
|
+
### Return type
|
|
1941
|
+
|
|
1942
|
+
[**LexBotAliasEntityListing**](LexBotAliasEntityListing.html)
|
|
1943
|
+
|
|
1944
|
+
### HTTP request headers
|
|
1945
|
+
|
|
1946
|
+
- **Content-Type**: application/json
|
|
1947
|
+
- **Accept**: application/json
|
|
1948
|
+
|
|
1949
|
+
|
|
1950
|
+
|
|
1951
|
+
<a name="get_integrations_speech_lex_bots"></a>
|
|
1952
|
+
|
|
1953
|
+
## [**LexBotEntityListing**](LexBotEntityListing.html) get_integrations_speech_lex_bots(opts)
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
Get a list of Lex bots in the customers' AWS accounts
|
|
1958
|
+
|
|
1959
|
+
|
|
1960
|
+
|
|
1961
|
+
Wraps GET /api/v2/integrations/speech/lex/bots
|
|
1962
|
+
|
|
1963
|
+
Requires ANY permissions:
|
|
1964
|
+
|
|
1965
|
+
* integrations:integration:view
|
|
1966
|
+
|
|
1967
|
+
|
|
1968
|
+
### Example
|
|
1969
|
+
```{"language":"ruby"}
|
|
1970
|
+
# load the gem
|
|
1971
|
+
require 'purecloudplatformclientv2'
|
|
1972
|
+
# setup authorization
|
|
1973
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1974
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1975
|
+
environment = "mypurecloud.com"
|
|
1976
|
+
|
|
1977
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1978
|
+
|
|
1979
|
+
PureCloud.configure do |config|
|
|
1980
|
+
config.access_token = @authToken
|
|
1981
|
+
end
|
|
1982
|
+
|
|
1983
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
1984
|
+
|
|
1985
|
+
opts = {
|
|
1986
|
+
page_number: 1, # Integer | Page number
|
|
1987
|
+
page_size: 25, # Integer | Page size
|
|
1988
|
+
name: "name_example" # String | Filter on bot name
|
|
1989
|
+
}
|
|
1990
|
+
|
|
1991
|
+
begin
|
|
1992
|
+
#Get a list of Lex bots in the customers' AWS accounts
|
|
1993
|
+
result = api_instance.get_integrations_speech_lex_bots(opts)
|
|
1994
|
+
p result
|
|
1995
|
+
rescue PureCloud::ApiError => e
|
|
1996
|
+
puts "Exception when calling IntegrationsApi->get_integrations_speech_lex_bots: #{e}"
|
|
1997
|
+
end
|
|
1998
|
+
```
|
|
1999
|
+
|
|
2000
|
+
### Parameters
|
|
2001
|
+
|
|
2002
|
+
Name | Type | Description | Notes
|
|
2003
|
+
------------- | ------------- | ------------- | -------------
|
|
2004
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2005
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
2006
|
+
**name** | **String**| Filter on bot name | [optional] |
|
|
2007
|
+
{: class="table table-striped"}
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
### Return type
|
|
2011
|
+
|
|
2012
|
+
[**LexBotEntityListing**](LexBotEntityListing.html)
|
|
2013
|
+
|
|
2014
|
+
### HTTP request headers
|
|
2015
|
+
|
|
2016
|
+
- **Content-Type**: application/json
|
|
2017
|
+
- **Accept**: application/json
|
|
2018
|
+
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
<a name="get_integrations_speech_tts_engine"></a>
|
|
2022
|
+
|
|
2023
|
+
## [**TtsEngineEntity**](TtsEngineEntity.html) get_integrations_speech_tts_engine(engine_id, opts)
|
|
2024
|
+
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
Get details about a TTS engine
|
|
2028
|
+
|
|
2029
|
+
|
|
2030
|
+
|
|
2031
|
+
Wraps GET /api/v2/integrations/speech/tts/engines/{engineId}
|
|
2032
|
+
|
|
2033
|
+
Requires ANY permissions:
|
|
2034
|
+
|
|
2035
|
+
* integrations:integration:view
|
|
2036
|
+
|
|
2037
|
+
|
|
2038
|
+
### Example
|
|
2039
|
+
```{"language":"ruby"}
|
|
2040
|
+
# load the gem
|
|
2041
|
+
require 'purecloudplatformclientv2'
|
|
2042
|
+
# setup authorization
|
|
2043
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2044
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2045
|
+
environment = "mypurecloud.com"
|
|
2046
|
+
|
|
2047
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2048
|
+
|
|
2049
|
+
PureCloud.configure do |config|
|
|
2050
|
+
config.access_token = @authToken
|
|
2051
|
+
end
|
|
2052
|
+
|
|
2053
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
2054
|
+
|
|
2055
|
+
engine_id = "engine_id_example" # String | The engine ID
|
|
2056
|
+
|
|
2057
|
+
opts = {
|
|
2058
|
+
include_voices: false # BOOLEAN | Include voices for the engine
|
|
2059
|
+
}
|
|
2060
|
+
|
|
2061
|
+
begin
|
|
2062
|
+
#Get details about a TTS engine
|
|
2063
|
+
result = api_instance.get_integrations_speech_tts_engine(engine_id, opts)
|
|
2064
|
+
p result
|
|
2065
|
+
rescue PureCloud::ApiError => e
|
|
2066
|
+
puts "Exception when calling IntegrationsApi->get_integrations_speech_tts_engine: #{e}"
|
|
2067
|
+
end
|
|
2068
|
+
```
|
|
2069
|
+
|
|
2070
|
+
### Parameters
|
|
2071
|
+
|
|
2072
|
+
Name | Type | Description | Notes
|
|
2073
|
+
------------- | ------------- | ------------- | -------------
|
|
2074
|
+
**engine_id** | **String**| The engine ID | |
|
|
2075
|
+
**include_voices** | **BOOLEAN**| Include voices for the engine | [optional] [default to false] |
|
|
2076
|
+
{: class="table table-striped"}
|
|
2077
|
+
|
|
2078
|
+
|
|
2079
|
+
### Return type
|
|
2080
|
+
|
|
2081
|
+
[**TtsEngineEntity**](TtsEngineEntity.html)
|
|
2082
|
+
|
|
2083
|
+
### HTTP request headers
|
|
2084
|
+
|
|
2085
|
+
- **Content-Type**: application/json
|
|
2086
|
+
- **Accept**: application/json
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
|
|
2090
|
+
<a name="get_integrations_speech_tts_engine_voice"></a>
|
|
2091
|
+
|
|
2092
|
+
## [**TtsVoiceEntity**](TtsVoiceEntity.html) get_integrations_speech_tts_engine_voice(engine_id, voice_id)
|
|
2093
|
+
|
|
2094
|
+
|
|
2095
|
+
|
|
2096
|
+
Get details about a specific voice for a TTS engine
|
|
2097
|
+
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
Wraps GET /api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId}
|
|
2101
|
+
|
|
2102
|
+
Requires ANY permissions:
|
|
2103
|
+
|
|
2104
|
+
* integrations:integration:view
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
### Example
|
|
2108
|
+
```{"language":"ruby"}
|
|
2109
|
+
# load the gem
|
|
2110
|
+
require 'purecloudplatformclientv2'
|
|
2111
|
+
# setup authorization
|
|
2112
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2113
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2114
|
+
environment = "mypurecloud.com"
|
|
2115
|
+
|
|
2116
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2117
|
+
|
|
2118
|
+
PureCloud.configure do |config|
|
|
2119
|
+
config.access_token = @authToken
|
|
2120
|
+
end
|
|
2121
|
+
|
|
2122
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
2123
|
+
|
|
2124
|
+
engine_id = "engine_id_example" # String | The engine ID
|
|
2125
|
+
|
|
2126
|
+
voice_id = "voice_id_example" # String | The voice ID
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
begin
|
|
2130
|
+
#Get details about a specific voice for a TTS engine
|
|
2131
|
+
result = api_instance.get_integrations_speech_tts_engine_voice(engine_id, voice_id)
|
|
2132
|
+
p result
|
|
2133
|
+
rescue PureCloud::ApiError => e
|
|
2134
|
+
puts "Exception when calling IntegrationsApi->get_integrations_speech_tts_engine_voice: #{e}"
|
|
2135
|
+
end
|
|
2136
|
+
```
|
|
2137
|
+
|
|
2138
|
+
### Parameters
|
|
2139
|
+
|
|
2140
|
+
Name | Type | Description | Notes
|
|
2141
|
+
------------- | ------------- | ------------- | -------------
|
|
2142
|
+
**engine_id** | **String**| The engine ID | |
|
|
2143
|
+
**voice_id** | **String**| The voice ID | |
|
|
2144
|
+
{: class="table table-striped"}
|
|
2145
|
+
|
|
2146
|
+
|
|
2147
|
+
### Return type
|
|
2148
|
+
|
|
2149
|
+
[**TtsVoiceEntity**](TtsVoiceEntity.html)
|
|
2150
|
+
|
|
2151
|
+
### HTTP request headers
|
|
2152
|
+
|
|
2153
|
+
- **Content-Type**: application/json
|
|
2154
|
+
- **Accept**: application/json
|
|
2155
|
+
|
|
2156
|
+
|
|
2157
|
+
|
|
2158
|
+
<a name="get_integrations_speech_tts_engine_voices"></a>
|
|
2159
|
+
|
|
2160
|
+
## [**TtsVoiceEntityListing**](TtsVoiceEntityListing.html) get_integrations_speech_tts_engine_voices(engine_id, opts)
|
|
2161
|
+
|
|
2162
|
+
|
|
2163
|
+
|
|
2164
|
+
Get a list of voices for a TTS engine
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
Wraps GET /api/v2/integrations/speech/tts/engines/{engineId}/voices
|
|
2169
|
+
|
|
2170
|
+
Requires ANY permissions:
|
|
2171
|
+
|
|
2172
|
+
* integrations:integration:view
|
|
2173
|
+
|
|
2174
|
+
|
|
2175
|
+
### Example
|
|
2176
|
+
```{"language":"ruby"}
|
|
2177
|
+
# load the gem
|
|
2178
|
+
require 'purecloudplatformclientv2'
|
|
2179
|
+
# setup authorization
|
|
2180
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2181
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2182
|
+
environment = "mypurecloud.com"
|
|
2183
|
+
|
|
2184
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2185
|
+
|
|
2186
|
+
PureCloud.configure do |config|
|
|
2187
|
+
config.access_token = @authToken
|
|
2188
|
+
end
|
|
2189
|
+
|
|
2190
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
2191
|
+
|
|
2192
|
+
engine_id = "engine_id_example" # String | The engine ID
|
|
2193
|
+
|
|
2194
|
+
opts = {
|
|
2195
|
+
page_number: 1, # Integer | Page number
|
|
2196
|
+
page_size: 25 # Integer | Page size
|
|
2197
|
+
}
|
|
2198
|
+
|
|
2199
|
+
begin
|
|
2200
|
+
#Get a list of voices for a TTS engine
|
|
2201
|
+
result = api_instance.get_integrations_speech_tts_engine_voices(engine_id, opts)
|
|
2202
|
+
p result
|
|
2203
|
+
rescue PureCloud::ApiError => e
|
|
2204
|
+
puts "Exception when calling IntegrationsApi->get_integrations_speech_tts_engine_voices: #{e}"
|
|
2205
|
+
end
|
|
2206
|
+
```
|
|
2207
|
+
|
|
2208
|
+
### Parameters
|
|
2209
|
+
|
|
2210
|
+
Name | Type | Description | Notes
|
|
2211
|
+
------------- | ------------- | ------------- | -------------
|
|
2212
|
+
**engine_id** | **String**| The engine ID | |
|
|
2213
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2214
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
2215
|
+
{: class="table table-striped"}
|
|
2216
|
+
|
|
2217
|
+
|
|
2218
|
+
### Return type
|
|
2219
|
+
|
|
2220
|
+
[**TtsVoiceEntityListing**](TtsVoiceEntityListing.html)
|
|
2221
|
+
|
|
2222
|
+
### HTTP request headers
|
|
2223
|
+
|
|
2224
|
+
- **Content-Type**: application/json
|
|
2225
|
+
- **Accept**: application/json
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
|
|
2229
|
+
<a name="get_integrations_speech_tts_engines"></a>
|
|
2230
|
+
|
|
2231
|
+
## [**TtsEngineEntityListing**](TtsEngineEntityListing.html) get_integrations_speech_tts_engines(opts)
|
|
2232
|
+
|
|
2233
|
+
|
|
2234
|
+
|
|
2235
|
+
Get a list of TTS engines enabled for org
|
|
2236
|
+
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
Wraps GET /api/v2/integrations/speech/tts/engines
|
|
2240
|
+
|
|
2241
|
+
Requires ANY permissions:
|
|
2242
|
+
|
|
2243
|
+
* integrations:integration:view
|
|
2244
|
+
|
|
2245
|
+
|
|
2246
|
+
### Example
|
|
2247
|
+
```{"language":"ruby"}
|
|
2248
|
+
# load the gem
|
|
2249
|
+
require 'purecloudplatformclientv2'
|
|
2250
|
+
# setup authorization
|
|
2251
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2252
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2253
|
+
environment = "mypurecloud.com"
|
|
2254
|
+
|
|
2255
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2256
|
+
|
|
2257
|
+
PureCloud.configure do |config|
|
|
2258
|
+
config.access_token = @authToken
|
|
2259
|
+
end
|
|
2260
|
+
|
|
2261
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
2262
|
+
|
|
2263
|
+
opts = {
|
|
2264
|
+
page_number: 1, # Integer | Page number
|
|
2265
|
+
page_size: 25, # Integer | Page size
|
|
2266
|
+
include_voices: false, # BOOLEAN | Include voices for the engine
|
|
2267
|
+
name: "name_example", # String | Filter on engine name
|
|
2268
|
+
language: "language_example" # String | Filter on supported language. If includeVoices=true then the voices are also filtered.
|
|
2269
|
+
}
|
|
2270
|
+
|
|
2271
|
+
begin
|
|
2272
|
+
#Get a list of TTS engines enabled for org
|
|
2273
|
+
result = api_instance.get_integrations_speech_tts_engines(opts)
|
|
2274
|
+
p result
|
|
2275
|
+
rescue PureCloud::ApiError => e
|
|
2276
|
+
puts "Exception when calling IntegrationsApi->get_integrations_speech_tts_engines: #{e}"
|
|
2277
|
+
end
|
|
2278
|
+
```
|
|
2279
|
+
|
|
2280
|
+
### Parameters
|
|
2281
|
+
|
|
2282
|
+
Name | Type | Description | Notes
|
|
2283
|
+
------------- | ------------- | ------------- | -------------
|
|
2284
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
2285
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
2286
|
+
**include_voices** | **BOOLEAN**| Include voices for the engine | [optional] [default to false] |
|
|
2287
|
+
**name** | **String**| Filter on engine name | [optional] |
|
|
2288
|
+
**language** | **String**| Filter on supported language. If includeVoices=true then the voices are also filtered. | [optional] |
|
|
2289
|
+
{: class="table table-striped"}
|
|
2290
|
+
|
|
2291
|
+
|
|
2292
|
+
### Return type
|
|
2293
|
+
|
|
2294
|
+
[**TtsEngineEntityListing**](TtsEngineEntityListing.html)
|
|
2295
|
+
|
|
2296
|
+
### HTTP request headers
|
|
2297
|
+
|
|
2298
|
+
- **Content-Type**: application/json
|
|
2299
|
+
- **Accept**: application/json
|
|
2300
|
+
|
|
2301
|
+
|
|
2302
|
+
|
|
2303
|
+
<a name="get_integrations_speech_tts_settings"></a>
|
|
2304
|
+
|
|
2305
|
+
## [**TtsSettings**](TtsSettings.html) get_integrations_speech_tts_settings
|
|
2306
|
+
|
|
2307
|
+
|
|
2308
|
+
|
|
2309
|
+
Get TTS settings for an org
|
|
2310
|
+
|
|
2311
|
+
|
|
2312
|
+
|
|
2313
|
+
Wraps GET /api/v2/integrations/speech/tts/settings
|
|
2314
|
+
|
|
2315
|
+
Requires ANY permissions:
|
|
2316
|
+
|
|
2317
|
+
* integrations:integration:view
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
### Example
|
|
2321
|
+
```{"language":"ruby"}
|
|
2322
|
+
# load the gem
|
|
2323
|
+
require 'purecloudplatformclientv2'
|
|
2324
|
+
# setup authorization
|
|
2325
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2326
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2327
|
+
environment = "mypurecloud.com"
|
|
2328
|
+
|
|
2329
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2330
|
+
|
|
2331
|
+
PureCloud.configure do |config|
|
|
2332
|
+
config.access_token = @authToken
|
|
2333
|
+
end
|
|
2334
|
+
|
|
2335
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
2336
|
+
|
|
2337
|
+
begin
|
|
2338
|
+
#Get TTS settings for an org
|
|
2339
|
+
result = api_instance.get_integrations_speech_tts_settings
|
|
2340
|
+
p result
|
|
2341
|
+
rescue PureCloud::ApiError => e
|
|
2342
|
+
puts "Exception when calling IntegrationsApi->get_integrations_speech_tts_settings: #{e}"
|
|
2343
|
+
end
|
|
2344
|
+
```
|
|
2345
|
+
|
|
2346
|
+
### Parameters
|
|
2347
|
+
This endpoint does not need any parameter.
|
|
2348
|
+
{: class="table table-striped"}
|
|
2349
|
+
|
|
2350
|
+
|
|
2351
|
+
### Return type
|
|
2352
|
+
|
|
2353
|
+
[**TtsSettings**](TtsSettings.html)
|
|
2354
|
+
|
|
2355
|
+
### HTTP request headers
|
|
2356
|
+
|
|
2357
|
+
- **Content-Type**: application/json
|
|
2358
|
+
- **Accept**: application/json
|
|
2359
|
+
|
|
2360
|
+
|
|
2361
|
+
|
|
1665
2362
|
<a name="get_integrations_type"></a>
|
|
1666
2363
|
|
|
1667
2364
|
## [**IntegrationType**](IntegrationType.html) get_integrations_type(type_id)
|
|
@@ -2884,3 +3581,68 @@ Name | Type | Description | Notes
|
|
|
2884
3581
|
|
|
2885
3582
|
|
|
2886
3583
|
|
|
3584
|
+
<a name="put_integrations_speech_tts_settings"></a>
|
|
3585
|
+
|
|
3586
|
+
## [**TtsSettings**](TtsSettings.html) put_integrations_speech_tts_settings(body)
|
|
3587
|
+
|
|
3588
|
+
|
|
3589
|
+
|
|
3590
|
+
Update TTS settings for an org
|
|
3591
|
+
|
|
3592
|
+
|
|
3593
|
+
|
|
3594
|
+
Wraps PUT /api/v2/integrations/speech/tts/settings
|
|
3595
|
+
|
|
3596
|
+
Requires ANY permissions:
|
|
3597
|
+
|
|
3598
|
+
* integrations:integration:edit
|
|
3599
|
+
|
|
3600
|
+
|
|
3601
|
+
### Example
|
|
3602
|
+
```{"language":"ruby"}
|
|
3603
|
+
# load the gem
|
|
3604
|
+
require 'purecloudplatformclientv2'
|
|
3605
|
+
# setup authorization
|
|
3606
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3607
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3608
|
+
environment = "mypurecloud.com"
|
|
3609
|
+
|
|
3610
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3611
|
+
|
|
3612
|
+
PureCloud.configure do |config|
|
|
3613
|
+
config.access_token = @authToken
|
|
3614
|
+
end
|
|
3615
|
+
|
|
3616
|
+
api_instance = PureCloud::IntegrationsApi.new
|
|
3617
|
+
|
|
3618
|
+
body = PureCloud::TtsSettings.new # TtsSettings | Updated TtsSettings
|
|
3619
|
+
|
|
3620
|
+
|
|
3621
|
+
begin
|
|
3622
|
+
#Update TTS settings for an org
|
|
3623
|
+
result = api_instance.put_integrations_speech_tts_settings(body)
|
|
3624
|
+
p result
|
|
3625
|
+
rescue PureCloud::ApiError => e
|
|
3626
|
+
puts "Exception when calling IntegrationsApi->put_integrations_speech_tts_settings: #{e}"
|
|
3627
|
+
end
|
|
3628
|
+
```
|
|
3629
|
+
|
|
3630
|
+
### Parameters
|
|
3631
|
+
|
|
3632
|
+
Name | Type | Description | Notes
|
|
3633
|
+
------------- | ------------- | ------------- | -------------
|
|
3634
|
+
**body** | [**TtsSettings**](TtsSettings.html)| Updated TtsSettings | |
|
|
3635
|
+
{: class="table table-striped"}
|
|
3636
|
+
|
|
3637
|
+
|
|
3638
|
+
### Return type
|
|
3639
|
+
|
|
3640
|
+
[**TtsSettings**](TtsSettings.html)
|
|
3641
|
+
|
|
3642
|
+
### HTTP request headers
|
|
3643
|
+
|
|
3644
|
+
- **Content-Type**: application/json
|
|
3645
|
+
- **Accept**: application/json
|
|
3646
|
+
|
|
3647
|
+
|
|
3648
|
+
|