purecloudplatformclientv2 34.0.0 → 35.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AlertingApi.md +66 -0
- data/docs/AnalyticsApi.md +144 -0
- data/docs/ArchitectApi.md +492 -2
- data/docs/AssignedWrapupCode.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AttributesApi.md +36 -0
- data/docs/AuthorizationApi.md +102 -0
- data/docs/BillingApi.md +6 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionView.md +16 -0
- data/docs/CampaignDivisionViewListing.md +22 -0
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ContentManagementApi.md +228 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +590 -14
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalContactsApi.md +238 -69
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxApi.md +36 -0
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/Flow.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GeneralDataProtectionRegulationApi.md +24 -0
- data/docs/GeolocationApi.md +24 -0
- data/docs/GreetingListing.md +1 -1
- data/docs/GreetingsApi.md +96 -0
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +84 -0
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityProviderApi.md +168 -0
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntegrationsApi.md +246 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguagesApi.md +60 -0
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +48 -0
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationsApi.md +24 -0
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MobileDevicesApi.md +30 -0
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationsApi.md +42 -0
- data/docs/OAuthApi.md +36 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationApi.md +24 -0
- data/docs/OrganizationAuthorizationApi.md +138 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +611 -0
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceApi.md +48 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +300 -0
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +222 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseManagementApi.md +66 -0
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +351 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/ScriptsApi.md +66 -0
- data/docs/SearchApi.md +84 -0
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/StationsApi.md +30 -0
- data/docs/SuggestApi.md +24 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +762 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TokensApi.md +12 -0
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserRecordingsApi.md +36 -0
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +321 -3
- data/docs/UtilitiesApi.md +18 -0
- data/docs/VoicemailApi.md +144 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatApi.md +48 -0
- data/docs/WebChatConfig.md +13 -0
- data/docs/WebChatDeployment.md +2 -1
- data/docs/WorkforceManagementApi.md +74 -2
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +4 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +21 -21
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +90 -68
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +117 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +1 -1
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb +308 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{authz_division.rb → campaign_division_view.rb} +9 -68
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow.rb +13 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/json_node.rb +65 -65
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/web_chat_config.rb +202 -0
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +27 -2
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +10 -4
- data/docs/AuthzDivision.md +0 -18
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 399def481abf5cafcb01f02ce9cbabd7e8d91068
|
|
4
|
+
data.tar.gz: 01c425fbe7ca3e7d96b3c06e2bd9345387779677
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 22ec0a82c797d1a52ad9aab8f69dddbd81b281c35ba8396ac0e2b2c0d8716b0093eaca010b64ae443a86a20e604bb99e1f4e6994f33a68a793cbc1a682370091
|
|
7
|
+
data.tar.gz: 78dad3de5ce80f988a3bf82eaea07bfccd6377d4f69ea187d4f1146147981aabe41fea15b26dca6813bcb7a6a5ec3557f48426a477f251351b65ba4528faa5ac
|
data/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: PureCloud Ruby Gem
|
|
3
3
|
---
|
|
4
|
-
|
|
5
5
|
|
|
6
6
|
Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
|
|
7
7
|
|
|
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
|
|
|
10
10
|
### from rubygems.org
|
|
11
11
|
|
|
12
12
|
~~~ ruby
|
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 35.0.0'
|
|
14
14
|
~~~
|
|
15
15
|
|
|
16
16
|
### Install from Git
|
data/docs/ActionEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: ActionEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: AgentActivityEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/AlertingApi.md
CHANGED
|
@@ -25,12 +25,18 @@ Method | Description
|
|
|
25
25
|
|
|
26
26
|
## - delete_alerting_interactionstats_alert(alert_id)
|
|
27
27
|
|
|
28
|
+
|
|
29
|
+
|
|
28
30
|
Delete an interaction stats alert
|
|
29
31
|
|
|
30
32
|
|
|
31
33
|
|
|
32
34
|
Wraps DELETE /api/v2/alerting/interactionstats/alerts/{alertId}
|
|
33
35
|
|
|
36
|
+
Requires ANY permissions:
|
|
37
|
+
|
|
38
|
+
* alerting:alert:delete
|
|
39
|
+
|
|
34
40
|
|
|
35
41
|
### Example
|
|
36
42
|
~~~ruby
|
|
@@ -83,12 +89,18 @@ nil (empty response body)
|
|
|
83
89
|
|
|
84
90
|
## - delete_alerting_interactionstats_rule(rule_id)
|
|
85
91
|
|
|
92
|
+
|
|
93
|
+
|
|
86
94
|
Delete an interaction stats rule.
|
|
87
95
|
|
|
88
96
|
|
|
89
97
|
|
|
90
98
|
Wraps DELETE /api/v2/alerting/interactionstats/rules/{ruleId}
|
|
91
99
|
|
|
100
|
+
Requires ANY permissions:
|
|
101
|
+
|
|
102
|
+
* alerting:rule:delete
|
|
103
|
+
|
|
92
104
|
|
|
93
105
|
### Example
|
|
94
106
|
~~~ruby
|
|
@@ -141,12 +153,18 @@ nil (empty response body)
|
|
|
141
153
|
|
|
142
154
|
## -[**ActiveAlertCount**](ActiveAlertCount.html) get_alerting_alerts_active
|
|
143
155
|
|
|
156
|
+
|
|
157
|
+
|
|
144
158
|
Gets active alert count for a user.
|
|
145
159
|
|
|
146
160
|
|
|
147
161
|
|
|
148
162
|
Wraps GET /api/v2/alerting/alerts/active
|
|
149
163
|
|
|
164
|
+
Requires NO permissions:
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
150
168
|
|
|
151
169
|
### Example
|
|
152
170
|
~~~ruby
|
|
@@ -194,12 +212,18 @@ This endpoint does not need any parameter.
|
|
|
194
212
|
|
|
195
213
|
## -[**InteractionStatsAlert**](InteractionStatsAlert.html) get_alerting_interactionstats_alert(alert_id, opts)
|
|
196
214
|
|
|
215
|
+
|
|
216
|
+
|
|
197
217
|
Get an interaction stats alert
|
|
198
218
|
|
|
199
219
|
|
|
200
220
|
|
|
201
221
|
Wraps GET /api/v2/alerting/interactionstats/alerts/{alertId}
|
|
202
222
|
|
|
223
|
+
Requires ANY permissions:
|
|
224
|
+
|
|
225
|
+
* alerting:alert:view
|
|
226
|
+
|
|
203
227
|
|
|
204
228
|
### Example
|
|
205
229
|
~~~ruby
|
|
@@ -257,12 +281,18 @@ Name | Type | Description | Notes
|
|
|
257
281
|
|
|
258
282
|
## -[**InteractionStatsAlertContainer**](InteractionStatsAlertContainer.html) get_alerting_interactionstats_alerts(opts)
|
|
259
283
|
|
|
284
|
+
|
|
285
|
+
|
|
260
286
|
Get interaction stats alert list.
|
|
261
287
|
|
|
262
288
|
|
|
263
289
|
|
|
264
290
|
Wraps GET /api/v2/alerting/interactionstats/alerts
|
|
265
291
|
|
|
292
|
+
Requires ANY permissions:
|
|
293
|
+
|
|
294
|
+
* alerting:alert:view
|
|
295
|
+
|
|
266
296
|
|
|
267
297
|
### Example
|
|
268
298
|
~~~ruby
|
|
@@ -317,12 +347,18 @@ Name | Type | Description | Notes
|
|
|
317
347
|
|
|
318
348
|
## -[**UnreadMetric**](UnreadMetric.html) get_alerting_interactionstats_alerts_unread
|
|
319
349
|
|
|
350
|
+
|
|
351
|
+
|
|
320
352
|
Gets user unread count of interaction stats alerts.
|
|
321
353
|
|
|
322
354
|
|
|
323
355
|
|
|
324
356
|
Wraps GET /api/v2/alerting/interactionstats/alerts/unread
|
|
325
357
|
|
|
358
|
+
Requires NO permissions:
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
326
362
|
|
|
327
363
|
### Example
|
|
328
364
|
~~~ruby
|
|
@@ -370,12 +406,18 @@ This endpoint does not need any parameter.
|
|
|
370
406
|
|
|
371
407
|
## -[**InteractionStatsRule**](InteractionStatsRule.html) get_alerting_interactionstats_rule(rule_id, opts)
|
|
372
408
|
|
|
409
|
+
|
|
410
|
+
|
|
373
411
|
Get an interaction stats rule.
|
|
374
412
|
|
|
375
413
|
|
|
376
414
|
|
|
377
415
|
Wraps GET /api/v2/alerting/interactionstats/rules/{ruleId}
|
|
378
416
|
|
|
417
|
+
Requires ANY permissions:
|
|
418
|
+
|
|
419
|
+
* alerting:rule:view
|
|
420
|
+
|
|
379
421
|
|
|
380
422
|
### Example
|
|
381
423
|
~~~ruby
|
|
@@ -433,12 +475,18 @@ Name | Type | Description | Notes
|
|
|
433
475
|
|
|
434
476
|
## -[**InteractionStatsRuleContainer**](InteractionStatsRuleContainer.html) get_alerting_interactionstats_rules(opts)
|
|
435
477
|
|
|
478
|
+
|
|
479
|
+
|
|
436
480
|
Get an interaction stats rule list.
|
|
437
481
|
|
|
438
482
|
|
|
439
483
|
|
|
440
484
|
Wraps GET /api/v2/alerting/interactionstats/rules
|
|
441
485
|
|
|
486
|
+
Requires ANY permissions:
|
|
487
|
+
|
|
488
|
+
* alerting:rule:view
|
|
489
|
+
|
|
442
490
|
|
|
443
491
|
### Example
|
|
444
492
|
~~~ruby
|
|
@@ -493,12 +541,18 @@ Name | Type | Description | Notes
|
|
|
493
541
|
|
|
494
542
|
## -[**InteractionStatsRule**](InteractionStatsRule.html) post_alerting_interactionstats_rules(body, opts)
|
|
495
543
|
|
|
544
|
+
|
|
545
|
+
|
|
496
546
|
Create an interaction stats rule.
|
|
497
547
|
|
|
498
548
|
|
|
499
549
|
|
|
500
550
|
Wraps POST /api/v2/alerting/interactionstats/rules
|
|
501
551
|
|
|
552
|
+
Requires ANY permissions:
|
|
553
|
+
|
|
554
|
+
* alerting:rule:add
|
|
555
|
+
|
|
502
556
|
|
|
503
557
|
### Example
|
|
504
558
|
~~~ruby
|
|
@@ -556,12 +610,18 @@ Name | Type | Description | Notes
|
|
|
556
610
|
|
|
557
611
|
## -[**UnreadStatus**](UnreadStatus.html) put_alerting_interactionstats_alert(alert_id, body, opts)
|
|
558
612
|
|
|
613
|
+
|
|
614
|
+
|
|
559
615
|
Update an interaction stats alert read status
|
|
560
616
|
|
|
561
617
|
|
|
562
618
|
|
|
563
619
|
Wraps PUT /api/v2/alerting/interactionstats/alerts/{alertId}
|
|
564
620
|
|
|
621
|
+
Requires ANY permissions:
|
|
622
|
+
|
|
623
|
+
* alerting:alert:edit
|
|
624
|
+
|
|
565
625
|
|
|
566
626
|
### Example
|
|
567
627
|
~~~ruby
|
|
@@ -622,12 +682,18 @@ Name | Type | Description | Notes
|
|
|
622
682
|
|
|
623
683
|
## -[**InteractionStatsRule**](InteractionStatsRule.html) put_alerting_interactionstats_rule(rule_id, body, opts)
|
|
624
684
|
|
|
685
|
+
|
|
686
|
+
|
|
625
687
|
Update an interaction stats rule
|
|
626
688
|
|
|
627
689
|
|
|
628
690
|
|
|
629
691
|
Wraps PUT /api/v2/alerting/interactionstats/rules/{ruleId}
|
|
630
692
|
|
|
693
|
+
Requires ANY permissions:
|
|
694
|
+
|
|
695
|
+
* alerting:rule:edit
|
|
696
|
+
|
|
631
697
|
|
|
632
698
|
### Example
|
|
633
699
|
~~~ruby
|
data/docs/AnalyticsApi.md
CHANGED
|
@@ -38,12 +38,18 @@ Method | Description
|
|
|
38
38
|
|
|
39
39
|
## - delete_analytics_reporting_schedule(schedule_id)
|
|
40
40
|
|
|
41
|
+
|
|
42
|
+
|
|
41
43
|
Delete a scheduled report job.
|
|
42
44
|
|
|
43
45
|
|
|
44
46
|
|
|
45
47
|
Wraps DELETE /api/v2/analytics/reporting/schedules/{scheduleId}
|
|
46
48
|
|
|
49
|
+
Requires NO permissions:
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
47
53
|
|
|
48
54
|
### Example
|
|
49
55
|
~~~ruby
|
|
@@ -96,12 +102,18 @@ nil (empty response body)
|
|
|
96
102
|
|
|
97
103
|
## -[**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversation_details(conversation_id)
|
|
98
104
|
|
|
105
|
+
|
|
106
|
+
|
|
99
107
|
Get a conversation by id
|
|
100
108
|
|
|
101
109
|
|
|
102
110
|
|
|
103
111
|
Wraps GET /api/v2/analytics/conversations/{conversationId}/details
|
|
104
112
|
|
|
113
|
+
Requires ANY permissions:
|
|
114
|
+
|
|
115
|
+
* analytics:conversationDetail:view
|
|
116
|
+
|
|
105
117
|
|
|
106
118
|
### Example
|
|
107
119
|
~~~ruby
|
|
@@ -155,12 +167,18 @@ Name | Type | Description | Notes
|
|
|
155
167
|
|
|
156
168
|
## -[**ReportingExportJobListing**](ReportingExportJobListing.html) get_analytics_reporting_exports
|
|
157
169
|
|
|
170
|
+
|
|
171
|
+
|
|
158
172
|
Get all view export requests for a user
|
|
159
173
|
|
|
160
174
|
|
|
161
175
|
|
|
162
176
|
Wraps GET /api/v2/analytics/reporting/exports
|
|
163
177
|
|
|
178
|
+
Requires ANY permissions:
|
|
179
|
+
|
|
180
|
+
* analytics:conversationAggregate:view
|
|
181
|
+
|
|
164
182
|
|
|
165
183
|
### Example
|
|
166
184
|
~~~ruby
|
|
@@ -208,12 +226,18 @@ This endpoint does not need any parameter.
|
|
|
208
226
|
|
|
209
227
|
## -[**ReportMetaDataEntityListing**](ReportMetaDataEntityListing.html) get_analytics_reporting_metadata(opts)
|
|
210
228
|
|
|
229
|
+
|
|
230
|
+
|
|
211
231
|
Get list of reporting metadata.
|
|
212
232
|
|
|
213
233
|
|
|
214
234
|
|
|
215
235
|
Wraps GET /api/v2/analytics/reporting/metadata
|
|
216
236
|
|
|
237
|
+
Requires NO permissions:
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
217
241
|
|
|
218
242
|
### Example
|
|
219
243
|
~~~ruby
|
|
@@ -272,12 +296,18 @@ Name | Type | Description | Notes
|
|
|
272
296
|
|
|
273
297
|
## -[**ReportMetaData**](ReportMetaData.html) get_analytics_reporting_report_id_metadata(report_id, opts)
|
|
274
298
|
|
|
299
|
+
|
|
300
|
+
|
|
275
301
|
Get a reporting metadata.
|
|
276
302
|
|
|
277
303
|
|
|
278
304
|
|
|
279
305
|
Wraps GET /api/v2/analytics/reporting/{reportId}/metadata
|
|
280
306
|
|
|
307
|
+
Requires NO permissions:
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
281
311
|
|
|
282
312
|
### Example
|
|
283
313
|
~~~ruby
|
|
@@ -335,12 +365,18 @@ Name | Type | Description | Notes
|
|
|
335
365
|
|
|
336
366
|
## -Array<String>** get_analytics_reporting_reportformats
|
|
337
367
|
|
|
368
|
+
|
|
369
|
+
|
|
338
370
|
Get a list of report formats
|
|
339
371
|
|
|
340
372
|
Get a list of report formats.
|
|
341
373
|
|
|
342
374
|
Wraps GET /api/v2/analytics/reporting/reportformats
|
|
343
375
|
|
|
376
|
+
Requires NO permissions:
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
344
380
|
|
|
345
381
|
### Example
|
|
346
382
|
~~~ruby
|
|
@@ -388,12 +424,18 @@ This endpoint does not need any parameter.
|
|
|
388
424
|
|
|
389
425
|
## -[**ReportSchedule**](ReportSchedule.html) get_analytics_reporting_schedule(schedule_id)
|
|
390
426
|
|
|
427
|
+
|
|
428
|
+
|
|
391
429
|
Get a scheduled report job.
|
|
392
430
|
|
|
393
431
|
|
|
394
432
|
|
|
395
433
|
Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}
|
|
396
434
|
|
|
435
|
+
Requires NO permissions:
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
397
439
|
|
|
398
440
|
### Example
|
|
399
441
|
~~~ruby
|
|
@@ -447,12 +489,18 @@ Name | Type | Description | Notes
|
|
|
447
489
|
|
|
448
490
|
## -[**ReportRunEntryEntityDomainListing**](ReportRunEntryEntityDomainListing.html) get_analytics_reporting_schedule_history(schedule_id, opts)
|
|
449
491
|
|
|
492
|
+
|
|
493
|
+
|
|
450
494
|
Get list of completed scheduled report jobs.
|
|
451
495
|
|
|
452
496
|
|
|
453
497
|
|
|
454
498
|
Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}/history
|
|
455
499
|
|
|
500
|
+
Requires NO permissions:
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
456
504
|
|
|
457
505
|
### Example
|
|
458
506
|
~~~ruby
|
|
@@ -512,12 +560,18 @@ Name | Type | Description | Notes
|
|
|
512
560
|
|
|
513
561
|
## -[**ReportRunEntry**](ReportRunEntry.html) get_analytics_reporting_schedule_history_latest(schedule_id)
|
|
514
562
|
|
|
563
|
+
|
|
564
|
+
|
|
515
565
|
Get most recently completed scheduled report job.
|
|
516
566
|
|
|
517
567
|
|
|
518
568
|
|
|
519
569
|
Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/latest
|
|
520
570
|
|
|
571
|
+
Requires NO permissions:
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
|
|
521
575
|
|
|
522
576
|
### Example
|
|
523
577
|
~~~ruby
|
|
@@ -571,12 +625,18 @@ Name | Type | Description | Notes
|
|
|
571
625
|
|
|
572
626
|
## -[**ReportRunEntry**](ReportRunEntry.html) get_analytics_reporting_schedule_history_run_id(run_id, schedule_id)
|
|
573
627
|
|
|
628
|
+
|
|
629
|
+
|
|
574
630
|
A completed scheduled report job
|
|
575
631
|
|
|
576
632
|
A completed scheduled report job.
|
|
577
633
|
|
|
578
634
|
Wraps GET /api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}
|
|
579
635
|
|
|
636
|
+
Requires NO permissions:
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
580
640
|
|
|
581
641
|
### Example
|
|
582
642
|
~~~ruby
|
|
@@ -633,12 +693,18 @@ Name | Type | Description | Notes
|
|
|
633
693
|
|
|
634
694
|
## -[**ReportScheduleEntityListing**](ReportScheduleEntityListing.html) get_analytics_reporting_schedules(opts)
|
|
635
695
|
|
|
696
|
+
|
|
697
|
+
|
|
636
698
|
Get a list of scheduled report jobs
|
|
637
699
|
|
|
638
700
|
Get a list of scheduled report jobs.
|
|
639
701
|
|
|
640
702
|
Wraps GET /api/v2/analytics/reporting/schedules
|
|
641
703
|
|
|
704
|
+
Requires NO permissions:
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
642
708
|
|
|
643
709
|
### Example
|
|
644
710
|
~~~ruby
|
|
@@ -695,12 +761,18 @@ Name | Type | Description | Notes
|
|
|
695
761
|
|
|
696
762
|
## -Array<String>** get_analytics_reporting_timeperiods
|
|
697
763
|
|
|
764
|
+
|
|
765
|
+
|
|
698
766
|
Get a list of report time periods.
|
|
699
767
|
|
|
700
768
|
|
|
701
769
|
|
|
702
770
|
Wraps GET /api/v2/analytics/reporting/timeperiods
|
|
703
771
|
|
|
772
|
+
Requires NO permissions:
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
704
776
|
|
|
705
777
|
### Example
|
|
706
778
|
~~~ruby
|
|
@@ -748,12 +820,18 @@ This endpoint does not need any parameter.
|
|
|
748
820
|
|
|
749
821
|
## -[**PropertyIndexRequest**](PropertyIndexRequest.html) post_analytics_conversation_details_properties(conversation_id, body)
|
|
750
822
|
|
|
823
|
+
|
|
824
|
+
|
|
751
825
|
Index conversation properties
|
|
752
826
|
|
|
753
827
|
|
|
754
828
|
|
|
755
829
|
Wraps POST /api/v2/analytics/conversations/{conversationId}/details/properties
|
|
756
830
|
|
|
831
|
+
Requires ANY permissions:
|
|
832
|
+
|
|
833
|
+
* analytics:conversationProperties:index
|
|
834
|
+
|
|
757
835
|
|
|
758
836
|
### Example
|
|
759
837
|
~~~ruby
|
|
@@ -810,12 +888,18 @@ Name | Type | Description | Notes
|
|
|
810
888
|
|
|
811
889
|
## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_conversations_aggregates_query(body)
|
|
812
890
|
|
|
891
|
+
|
|
892
|
+
|
|
813
893
|
Query for conversation aggregates
|
|
814
894
|
|
|
815
895
|
|
|
816
896
|
|
|
817
897
|
Wraps POST /api/v2/analytics/conversations/aggregates/query
|
|
818
898
|
|
|
899
|
+
Requires ANY permissions:
|
|
900
|
+
|
|
901
|
+
* analytics:conversationAggregate:view
|
|
902
|
+
|
|
819
903
|
|
|
820
904
|
### Example
|
|
821
905
|
~~~ruby
|
|
@@ -869,12 +953,18 @@ Name | Type | Description | Notes
|
|
|
869
953
|
|
|
870
954
|
## -[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_analytics_conversations_details_query(body)
|
|
871
955
|
|
|
956
|
+
|
|
957
|
+
|
|
872
958
|
Query for conversation details
|
|
873
959
|
|
|
874
960
|
|
|
875
961
|
|
|
876
962
|
Wraps POST /api/v2/analytics/conversations/details/query
|
|
877
963
|
|
|
964
|
+
Requires ANY permissions:
|
|
965
|
+
|
|
966
|
+
* analytics:conversationDetail:view
|
|
967
|
+
|
|
878
968
|
|
|
879
969
|
### Example
|
|
880
970
|
~~~ruby
|
|
@@ -928,12 +1018,18 @@ Name | Type | Description | Notes
|
|
|
928
1018
|
|
|
929
1019
|
## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_evaluations_aggregates_query(body)
|
|
930
1020
|
|
|
1021
|
+
|
|
1022
|
+
|
|
931
1023
|
Query for evaluation aggregates
|
|
932
1024
|
|
|
933
1025
|
|
|
934
1026
|
|
|
935
1027
|
Wraps POST /api/v2/analytics/evaluations/aggregates/query
|
|
936
1028
|
|
|
1029
|
+
Requires ANY permissions:
|
|
1030
|
+
|
|
1031
|
+
* analytics:evaluationAggregate:view
|
|
1032
|
+
|
|
937
1033
|
|
|
938
1034
|
### Example
|
|
939
1035
|
~~~ruby
|
|
@@ -987,12 +1083,18 @@ Name | Type | Description | Notes
|
|
|
987
1083
|
|
|
988
1084
|
## -[**QualifierMappingObservationQueryResponse**](QualifierMappingObservationQueryResponse.html) post_analytics_queues_observations_query(body)
|
|
989
1085
|
|
|
1086
|
+
|
|
1087
|
+
|
|
990
1088
|
Query for queue observations
|
|
991
1089
|
|
|
992
1090
|
|
|
993
1091
|
|
|
994
1092
|
Wraps POST /api/v2/analytics/queues/observations/query
|
|
995
1093
|
|
|
1094
|
+
Requires ANY permissions:
|
|
1095
|
+
|
|
1096
|
+
* analytics:queueObservation:view
|
|
1097
|
+
|
|
996
1098
|
|
|
997
1099
|
### Example
|
|
998
1100
|
~~~ruby
|
|
@@ -1046,12 +1148,18 @@ Name | Type | Description | Notes
|
|
|
1046
1148
|
|
|
1047
1149
|
## -[**ReportingExportJobResponse**](ReportingExportJobResponse.html) post_analytics_reporting_exports(body)
|
|
1048
1150
|
|
|
1151
|
+
|
|
1152
|
+
|
|
1049
1153
|
Generate a view export request
|
|
1050
1154
|
|
|
1051
1155
|
|
|
1052
1156
|
|
|
1053
1157
|
Wraps POST /api/v2/analytics/reporting/exports
|
|
1054
1158
|
|
|
1159
|
+
Requires ANY permissions:
|
|
1160
|
+
|
|
1161
|
+
* analytics:conversationAggregate:view
|
|
1162
|
+
|
|
1055
1163
|
|
|
1056
1164
|
### Example
|
|
1057
1165
|
~~~ruby
|
|
@@ -1105,12 +1213,18 @@ Name | Type | Description | Notes
|
|
|
1105
1213
|
|
|
1106
1214
|
## -[**RunNowResponse**](RunNowResponse.html) post_analytics_reporting_schedule_runreport(schedule_id)
|
|
1107
1215
|
|
|
1216
|
+
|
|
1217
|
+
|
|
1108
1218
|
Place a scheduled report immediately into the reporting queue
|
|
1109
1219
|
|
|
1110
1220
|
|
|
1111
1221
|
|
|
1112
1222
|
Wraps POST /api/v2/analytics/reporting/schedules/{scheduleId}/runreport
|
|
1113
1223
|
|
|
1224
|
+
Requires NO permissions:
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
|
|
1114
1228
|
|
|
1115
1229
|
### Example
|
|
1116
1230
|
~~~ruby
|
|
@@ -1164,12 +1278,18 @@ Name | Type | Description | Notes
|
|
|
1164
1278
|
|
|
1165
1279
|
## -[**ReportSchedule**](ReportSchedule.html) post_analytics_reporting_schedules(body)
|
|
1166
1280
|
|
|
1281
|
+
|
|
1282
|
+
|
|
1167
1283
|
Create a scheduled report job
|
|
1168
1284
|
|
|
1169
1285
|
Create a scheduled report job.
|
|
1170
1286
|
|
|
1171
1287
|
Wraps POST /api/v2/analytics/reporting/schedules
|
|
1172
1288
|
|
|
1289
|
+
Requires NO permissions:
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
|
|
1173
1293
|
|
|
1174
1294
|
### Example
|
|
1175
1295
|
~~~ruby
|
|
@@ -1223,12 +1343,18 @@ Name | Type | Description | Notes
|
|
|
1223
1343
|
|
|
1224
1344
|
## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
|
|
1225
1345
|
|
|
1346
|
+
|
|
1347
|
+
|
|
1226
1348
|
Query for user aggregates
|
|
1227
1349
|
|
|
1228
1350
|
|
|
1229
1351
|
|
|
1230
1352
|
Wraps POST /api/v2/analytics/users/aggregates/query
|
|
1231
1353
|
|
|
1354
|
+
Requires ANY permissions:
|
|
1355
|
+
|
|
1356
|
+
* analytics:userAggregate:view
|
|
1357
|
+
|
|
1232
1358
|
|
|
1233
1359
|
### Example
|
|
1234
1360
|
~~~ruby
|
|
@@ -1282,12 +1408,18 @@ Name | Type | Description | Notes
|
|
|
1282
1408
|
|
|
1283
1409
|
## -[**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_analytics_users_details_query(body)
|
|
1284
1410
|
|
|
1411
|
+
|
|
1412
|
+
|
|
1285
1413
|
Query for user details
|
|
1286
1414
|
|
|
1287
1415
|
|
|
1288
1416
|
|
|
1289
1417
|
Wraps POST /api/v2/analytics/users/details/query
|
|
1290
1418
|
|
|
1419
|
+
Requires ANY permissions:
|
|
1420
|
+
|
|
1421
|
+
* analytics:userObservation:view
|
|
1422
|
+
|
|
1291
1423
|
|
|
1292
1424
|
### Example
|
|
1293
1425
|
~~~ruby
|
|
@@ -1341,12 +1473,18 @@ Name | Type | Description | Notes
|
|
|
1341
1473
|
|
|
1342
1474
|
## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_analytics_users_observations_query(body)
|
|
1343
1475
|
|
|
1476
|
+
|
|
1477
|
+
|
|
1344
1478
|
Query for user observations
|
|
1345
1479
|
|
|
1346
1480
|
|
|
1347
1481
|
|
|
1348
1482
|
Wraps POST /api/v2/analytics/users/observations/query
|
|
1349
1483
|
|
|
1484
|
+
Requires ANY permissions:
|
|
1485
|
+
|
|
1486
|
+
* analytics:userObservation:view
|
|
1487
|
+
|
|
1350
1488
|
|
|
1351
1489
|
### Example
|
|
1352
1490
|
~~~ruby
|
|
@@ -1400,12 +1538,18 @@ Name | Type | Description | Notes
|
|
|
1400
1538
|
|
|
1401
1539
|
## -[**ReportSchedule**](ReportSchedule.html) put_analytics_reporting_schedule(schedule_id, body)
|
|
1402
1540
|
|
|
1541
|
+
|
|
1542
|
+
|
|
1403
1543
|
Update a scheduled report job.
|
|
1404
1544
|
|
|
1405
1545
|
|
|
1406
1546
|
|
|
1407
1547
|
Wraps PUT /api/v2/analytics/reporting/schedules/{scheduleId}
|
|
1408
1548
|
|
|
1549
|
+
Requires NO permissions:
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
|
|
1409
1553
|
|
|
1410
1554
|
### Example
|
|
1411
1555
|
~~~ruby
|