purecloudplatformclientv2 59.0.0 → 60.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/ArchitectApi.md +16 -16
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/BaseProgramEntity.md +15 -0
- data/docs/BaseTopicEntitiy.md +15 -0
- data/docs/BatchDownloadJobStatusResult.md +0 -1
- data/docs/BatchDownloadJobSubmissionResult.md +0 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/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/ConversationEntityListing.md +1 -1
- data/docs/CreateTopicRequest.md +20 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
- 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/DomainLogicalInterface.md +3 -0
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/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/FlowOutcomeListing.md +1 -1
- 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/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- 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 +3 -3
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationsApi.md +65 -0
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Manager.md +1 -13
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- 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/Phrase.md +15 -0
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/Program.md +22 -0
- data/docs/PromptAsset.md +8 -8
- data/docs/PromptAssetCreate.md +7 -7
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingJob.md +0 -1
- data/docs/RecordingJobEntityListing.md +1 -1
- 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 +4 -0
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +58 -58
- 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/ScimGroupListResponse.md +17 -0
- data/docs/{ScimListResponse.md → ScimUserListResponse.md} +3 -3
- data/docs/ScimV2CreateUser.md +1 -1
- data/docs/ScimV2Group.md +2 -2
- data/docs/ScimV2GroupReference.md +1 -2
- data/docs/ScimV2MemberReference.md +1 -2
- data/docs/ScimV2User.md +2 -2
- 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/SpeechTextAnalyticsApi.md +210 -0
- data/docs/Station.md +1 -0
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- 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/Topic.md +25 -0
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TtsEngineEntityListing.md +1 -1
- data/docs/TtsVoiceEntityListing.md +1 -1
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UserTokensTopicTokenNotification.md +16 -0
- data/docs/UserTokensTopicUriReference.md +14 -0
- data/docs/UsersApi.md +5 -3
- data/docs/ViewFilter.md +2 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WorkforceManagementApi.md +1 -1
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +11 -6
- data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/locations_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/scim_api.rb +62 -62
- data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +222 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +0 -13
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
- 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/{scim_resource.rb → base_program_entity.rb} +16 -17
- data/lib/purecloudplatformclientv2/models/{patch_operation.rb → base_topic_entitiy.rb} +60 -8
- data/lib/purecloudplatformclientv2/models/batch_download_job_status_result.rb +1 -26
- data/lib/purecloudplatformclientv2/models/batch_download_job_submission_result.rb +1 -26
- 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_entity_listing.rb +12 -12
- 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.rb +2 -2
- 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_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/create_topic_request.rb +438 -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_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_summary_entity_listing.rb +12 -12
- 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/domain_logical_interface.rb +78 -1
- 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_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/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.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +2 -2
- 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_listing.rb +12 -12
- 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/lex_bot_alias_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
- 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 +29 -28
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/manager.rb +3 -321
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- 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/phrase.rb +297 -0
- 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/program.rb +447 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset.rb +8 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +7 -0
- 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_page.rb +12 -12
- 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 +1 -26
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
- 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/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/{scim_list_response.rb → scim_group_list_response.rb} +3 -3
- data/lib/purecloudplatformclientv2/models/{patch_request.rb → scim_user_list_response.rb} +41 -40
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +23 -23
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +17 -16
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -27
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +3 -28
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +20 -19
- 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.rb +27 -1
- 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/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/topic.rb +538 -0
- 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_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- 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/{meta.rb → user_tokens_topic_token_notification.rb} +26 -53
- data/lib/purecloudplatformclientv2/models/{path.rb → user_tokens_topic_uri_reference.rb} +14 -14
- data/lib/purecloudplatformclientv2/models/view_filter.rb +60 -4
- 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/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 +24 -14
- data/docs/Meta.md +0 -17
- data/docs/PatchOperation.md +0 -13
- data/docs/PatchRequest.md +0 -17
- data/docs/Path.md +0 -14
- data/docs/ScimResource.md +0 -15
@@ -13,8 +13,8 @@ title: ScheduleEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: ScheduleGroupEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: SchemaCategoryEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: SchemaReferenceEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: ScimGroupListResponse
|
3
|
+
---
|
4
|
+
## PureCloud::ScimGroupListResponse
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **total_results** | **Integer** | Total Results | [optional] |
|
11
|
+
| **start_index** | **Integer** | Start index | [optional] |
|
12
|
+
| **items_per_page** | **Integer** | Items per Page | [optional] |
|
13
|
+
| **resources** | [**Array<ScimV2Group>**](ScimV2Group.html) | Resources | [optional] |
|
14
|
+
| **schemas** | **Array<String>** | schemas supported | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
title:
|
2
|
+
title: ScimUserListResponse
|
3
3
|
---
|
4
|
-
## PureCloud::
|
4
|
+
## PureCloud::ScimUserListResponse
|
5
5
|
|
6
6
|
## Properties
|
7
7
|
|
@@ -10,7 +10,7 @@ title: ScimListResponse
|
|
10
10
|
| **total_results** | **Integer** | Total Results | [optional] |
|
11
11
|
| **start_index** | **Integer** | Start index | [optional] |
|
12
12
|
| **items_per_page** | **Integer** | Items per Page | [optional] |
|
13
|
-
| **resources** | [**Array<
|
13
|
+
| **resources** | [**Array<ScimV2User>**](ScimV2User.html) | Resources | [optional] |
|
14
14
|
| **schemas** | **Array<String>** | schemas supported | [optional] |
|
15
15
|
{: class="table table-striped"}
|
16
16
|
|
data/docs/ScimV2CreateUser.md
CHANGED
@@ -7,10 +7,10 @@ title: ScimV2CreateUser
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **display_name** | **String** | Display Name | |
|
11
10
|
| **schemas** | **Array<String>** | schemas supported | [optional] |
|
12
11
|
| **active** | **BOOLEAN** | Active flag | [optional] |
|
13
12
|
| **user_name** | **String** | User Name (Must be Unique) maps to PureCloud e-mail address | |
|
13
|
+
| **display_name** | **String** | Display Name | |
|
14
14
|
| **password** | **String** | Password (updateOnly) | [optional] |
|
15
15
|
| **title** | **String** | Title | [optional] |
|
16
16
|
| **phone_numbers** | [**Array<ScimPhoneNumber>**](ScimPhoneNumber.html) | Phone numbers | [optional] |
|
data/docs/ScimV2Group.md
CHANGED
@@ -8,10 +8,10 @@ title: ScimV2Group
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | SCIM Resource identifier | [optional] |
|
11
|
-
| **display_name** | **String** | Display Name | [optional] |
|
12
11
|
| **schemas** | **Array<String>** | schemas supported | [optional] |
|
12
|
+
| **display_name** | **String** | Display Name | [optional] |
|
13
13
|
| **members** | [**Array<ScimV2MemberReference>**](ScimV2MemberReference.html) | Scim Group Members | [optional] |
|
14
|
-
| **meta** | [**ScimMetadata**](ScimMetadata.html) |
|
14
|
+
| **meta** | [**ScimMetadata**](ScimMetadata.html) | Resource SCIM meta | [optional] |
|
15
15
|
{: class="table table-striped"}
|
16
16
|
|
17
17
|
|
@@ -7,8 +7,7 @@ title: ScimV2GroupReference
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **
|
11
|
-
| **meta** | [**ScimMetadata**](ScimMetadata.html) | | [optional] |
|
10
|
+
| **meta** | [**ScimMetadata**](ScimMetadata.html) | Resource SCIM meta | [optional] |
|
12
11
|
| **type** | **String** | SCIM Resource Type of member | [optional] |
|
13
12
|
| **value** | **String** | Value of ID of group member. May be User or Group id | [optional] |
|
14
13
|
| **ref** | **String** | Ref to entity | [optional] |
|
@@ -8,8 +8,7 @@ title: ScimV2MemberReference
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **type** | **String** | SCIM Resource Type of member | [optional] |
|
11
|
-
| **
|
12
|
-
| **meta** | [**ScimMetadata**](ScimMetadata.html) | | [optional] |
|
11
|
+
| **meta** | [**ScimMetadata**](ScimMetadata.html) | Resource SCIM meta | [optional] |
|
13
12
|
| **value** | **String** | Value of ID of group member. May be User or Group id | [optional] |
|
14
13
|
| **ref** | **String** | Ref to entity | [optional] |
|
15
14
|
{: class="table table-striped"}
|
data/docs/ScimV2User.md
CHANGED
@@ -8,10 +8,10 @@ title: ScimV2User
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | SCIM Resource identifier | [optional] |
|
11
|
-
| **display_name** | **String** | Display Name | [optional] |
|
12
11
|
| **schemas** | **Array<String>** | schemas supported | [optional] |
|
13
12
|
| **active** | **BOOLEAN** | Active flag | [optional] |
|
14
13
|
| **user_name** | **String** | User Name (Must be Unique) maps to PureCloud e-mail address | [optional] |
|
14
|
+
| **display_name** | **String** | Display Name | [optional] |
|
15
15
|
| **password** | **String** | Password (updateOnly) | [optional] |
|
16
16
|
| **title** | **String** | Title | [optional] |
|
17
17
|
| **phone_numbers** | [**Array<ScimPhoneNumber>**](ScimPhoneNumber.html) | Phone numbers | [optional] |
|
@@ -19,7 +19,7 @@ title: ScimV2User
|
|
19
19
|
| **photos** | [**Array<Photo>**](Photo.html) | Photos | [optional] |
|
20
20
|
| **external_id** | **String** | External ID | [optional] |
|
21
21
|
| **groups** | [**Array<ScimV2GroupReference>**](ScimV2GroupReference.html) | Group References | [optional] |
|
22
|
-
| **meta** | [**ScimMetadata**](ScimMetadata.html) |
|
22
|
+
| **meta** | [**ScimMetadata**](ScimMetadata.html) | Resource SCIM meta | [optional] |
|
23
23
|
| **urnietfparamsscimschemasextensionenterprise2_0_user** | [**ScimV2EnterpriseUser**](ScimV2EnterpriseUser.html) | | [optional] |
|
24
24
|
{: class="table table-striped"}
|
25
25
|
|
@@ -13,8 +13,8 @@ title: ScreenRecordingSessionListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/docs/ScriptEntityListing.md
CHANGED
@@ -13,8 +13,8 @@ title: ScriptEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: SecurityProfileEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/docs/ShareEntityListing.md
CHANGED
@@ -13,8 +13,8 @@ title: ShareEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/docs/SiteEntityListing.md
CHANGED
@@ -13,8 +13,8 @@ title: SiteEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
data/docs/SkillEntityListing.md
CHANGED
@@ -13,8 +13,8 @@ title: SkillEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_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: SmsPhoneNumberEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
@@ -0,0 +1,210 @@
|
|
1
|
+
---
|
2
|
+
title: SpeechTextAnalyticsApi
|
3
|
+
---
|
4
|
+
|
5
|
+
## PureCloud::SpeechTextAnalyticsApi
|
6
|
+
|
7
|
+
All URIs are relative to *https://api.mypurecloud.com*
|
8
|
+
|
9
|
+
Method | Description
|
10
|
+
------------- | ------------- | -------------
|
11
|
+
[**get_speechandtextanalytics_program**](SpeechTextAnalyticsApi.html#get_speechandtextanalytics_program) | Get a Speech & Text Analytics program by id
|
12
|
+
[**get_speechandtextanalytics_topic**](SpeechTextAnalyticsApi.html#get_speechandtextanalytics_topic) | Get a Speech & Text Analytics topic by id
|
13
|
+
[**post_speechandtextanalytics_topics**](SpeechTextAnalyticsApi.html#post_speechandtextanalytics_topics) | Create new Speech & Text Analytics topic
|
14
|
+
{: class="table table-striped"}
|
15
|
+
|
16
|
+
<a name="get_speechandtextanalytics_program"></a>
|
17
|
+
|
18
|
+
## [**Program**](Program.html) get_speechandtextanalytics_program(program_id)
|
19
|
+
|
20
|
+
|
21
|
+
|
22
|
+
Get a Speech & Text Analytics program by id
|
23
|
+
|
24
|
+
|
25
|
+
|
26
|
+
Wraps GET /api/v2/speechandtextanalytics/programs/{programId}
|
27
|
+
|
28
|
+
Requires ANY permissions:
|
29
|
+
|
30
|
+
* speechAndTextAnalytics:program:view
|
31
|
+
|
32
|
+
|
33
|
+
### Example
|
34
|
+
```{"language":"ruby"}
|
35
|
+
# load the gem
|
36
|
+
require 'purecloudplatformclientv2'
|
37
|
+
# setup authorization
|
38
|
+
@secret = ENV['PURECLOUD_SECRET']
|
39
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
40
|
+
environment = "mypurecloud.com"
|
41
|
+
|
42
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
43
|
+
|
44
|
+
PureCloud.configure do |config|
|
45
|
+
config.access_token = @authToken
|
46
|
+
end
|
47
|
+
|
48
|
+
api_instance = PureCloud::SpeechTextAnalyticsApi.new
|
49
|
+
|
50
|
+
program_id = "program_id_example" # String | The id of the topic to get
|
51
|
+
|
52
|
+
|
53
|
+
begin
|
54
|
+
#Get a Speech & Text Analytics program by id
|
55
|
+
result = api_instance.get_speechandtextanalytics_program(program_id)
|
56
|
+
p result
|
57
|
+
rescue PureCloud::ApiError => e
|
58
|
+
puts "Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_program: #{e}"
|
59
|
+
end
|
60
|
+
```
|
61
|
+
|
62
|
+
### Parameters
|
63
|
+
|
64
|
+
Name | Type | Description | Notes
|
65
|
+
------------- | ------------- | ------------- | -------------
|
66
|
+
**program_id** | **String**| The id of the topic to get | |
|
67
|
+
{: class="table table-striped"}
|
68
|
+
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**Program**](Program.html)
|
73
|
+
|
74
|
+
### HTTP request headers
|
75
|
+
|
76
|
+
- **Content-Type**: application/json
|
77
|
+
- **Accept**: application/json
|
78
|
+
|
79
|
+
|
80
|
+
|
81
|
+
<a name="get_speechandtextanalytics_topic"></a>
|
82
|
+
|
83
|
+
## [**Topic**](Topic.html) get_speechandtextanalytics_topic(topic_id)
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
Get a Speech & Text Analytics topic by id
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
Wraps GET /api/v2/speechandtextanalytics/topics/{topicId}
|
92
|
+
|
93
|
+
Requires ANY permissions:
|
94
|
+
|
95
|
+
* speechAndTextAnalytics:topic:view
|
96
|
+
|
97
|
+
|
98
|
+
### Example
|
99
|
+
```{"language":"ruby"}
|
100
|
+
# load the gem
|
101
|
+
require 'purecloudplatformclientv2'
|
102
|
+
# setup authorization
|
103
|
+
@secret = ENV['PURECLOUD_SECRET']
|
104
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
105
|
+
environment = "mypurecloud.com"
|
106
|
+
|
107
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
108
|
+
|
109
|
+
PureCloud.configure do |config|
|
110
|
+
config.access_token = @authToken
|
111
|
+
end
|
112
|
+
|
113
|
+
api_instance = PureCloud::SpeechTextAnalyticsApi.new
|
114
|
+
|
115
|
+
topic_id = "topic_id_example" # String | The id of the topic to get
|
116
|
+
|
117
|
+
|
118
|
+
begin
|
119
|
+
#Get a Speech & Text Analytics topic by id
|
120
|
+
result = api_instance.get_speechandtextanalytics_topic(topic_id)
|
121
|
+
p result
|
122
|
+
rescue PureCloud::ApiError => e
|
123
|
+
puts "Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topic: #{e}"
|
124
|
+
end
|
125
|
+
```
|
126
|
+
|
127
|
+
### Parameters
|
128
|
+
|
129
|
+
Name | Type | Description | Notes
|
130
|
+
------------- | ------------- | ------------- | -------------
|
131
|
+
**topic_id** | **String**| The id of the topic to get | |
|
132
|
+
{: class="table table-striped"}
|
133
|
+
|
134
|
+
|
135
|
+
### Return type
|
136
|
+
|
137
|
+
[**Topic**](Topic.html)
|
138
|
+
|
139
|
+
### HTTP request headers
|
140
|
+
|
141
|
+
- **Content-Type**: application/json
|
142
|
+
- **Accept**: application/json
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
<a name="post_speechandtextanalytics_topics"></a>
|
147
|
+
|
148
|
+
## [**Topic**](Topic.html) post_speechandtextanalytics_topics(body)
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
Create new Speech & Text Analytics topic
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
Wraps POST /api/v2/speechandtextanalytics/topics
|
157
|
+
|
158
|
+
Requires ANY permissions:
|
159
|
+
|
160
|
+
* speechAndTextAnalytics:topic:add
|
161
|
+
|
162
|
+
|
163
|
+
### Example
|
164
|
+
```{"language":"ruby"}
|
165
|
+
# load the gem
|
166
|
+
require 'purecloudplatformclientv2'
|
167
|
+
# setup authorization
|
168
|
+
@secret = ENV['PURECLOUD_SECRET']
|
169
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
170
|
+
environment = "mypurecloud.com"
|
171
|
+
|
172
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
173
|
+
|
174
|
+
PureCloud.configure do |config|
|
175
|
+
config.access_token = @authToken
|
176
|
+
end
|
177
|
+
|
178
|
+
api_instance = PureCloud::SpeechTextAnalyticsApi.new
|
179
|
+
|
180
|
+
body = PureCloud::CreateTopicRequest.new # CreateTopicRequest | The topic to create
|
181
|
+
|
182
|
+
|
183
|
+
begin
|
184
|
+
#Create new Speech & Text Analytics topic
|
185
|
+
result = api_instance.post_speechandtextanalytics_topics(body)
|
186
|
+
p result
|
187
|
+
rescue PureCloud::ApiError => e
|
188
|
+
puts "Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_topics: #{e}"
|
189
|
+
end
|
190
|
+
```
|
191
|
+
|
192
|
+
### Parameters
|
193
|
+
|
194
|
+
Name | Type | Description | Notes
|
195
|
+
------------- | ------------- | ------------- | -------------
|
196
|
+
**body** | [**CreateTopicRequest**](CreateTopicRequest.html)| The topic to create | |
|
197
|
+
{: class="table table-striped"}
|
198
|
+
|
199
|
+
|
200
|
+
### Return type
|
201
|
+
|
202
|
+
[**Topic**](Topic.html)
|
203
|
+
|
204
|
+
### HTTP request headers
|
205
|
+
|
206
|
+
- **Content-Type**: application/json
|
207
|
+
- **Accept**: application/json
|
208
|
+
|
209
|
+
|
210
|
+
|
data/docs/Station.md
CHANGED
@@ -19,6 +19,7 @@ title: Station
|
|
19
19
|
| **line_appearance_id** | **String** | | [optional] |
|
20
20
|
| **web_rtc_media_dscp** | **Integer** | The default or configured value of media dscp for the station. Empty if station type is not inin_webrtc_softphone. | [optional] |
|
21
21
|
| **web_rtc_persistent_enabled** | **BOOLEAN** | The default or configured value of persistent connection setting for the station. Empty if station type is not inin_webrtc_softphone. | [optional] |
|
22
|
+
| **web_rtc_force_turn** | **BOOLEAN** | Whether the station is configured to require TURN for routing WebRTC calls. Empty if station type is not inin_webrtc_softphone. | [optional] |
|
22
23
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
23
24
|
{: class="table table-striped"}
|
24
25
|
|
@@ -13,8 +13,8 @@ title: StationEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
16
|
-
| **previous_uri** | **String** | | [optional] |
|
17
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|