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
|
@@ -13,9 +13,9 @@ title: OutboundRouteBaseEntityListing
|
|
|
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: OutboundRouteEntityListing
|
|
|
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: PermissionCollectionEntityListing
|
|
|
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: PhoneBaseEntityListing
|
|
|
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/PhoneEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: PhoneEntityListing
|
|
|
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: PhoneMetaBaseEntityListing
|
|
|
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: PhysicalInterfaceEntityListing
|
|
|
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/PolicyEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: PolicyEntityListing
|
|
|
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/PresenceApi.md
CHANGED
|
@@ -22,12 +22,18 @@ Method | Description
|
|
|
22
22
|
|
|
23
23
|
## - delete_presencedefinition(presence_id)
|
|
24
24
|
|
|
25
|
+
|
|
26
|
+
|
|
25
27
|
Delete a Presence Definition
|
|
26
28
|
|
|
27
29
|
|
|
28
30
|
|
|
29
31
|
Wraps DELETE /api/v2/presencedefinitions/{presenceId}
|
|
30
32
|
|
|
33
|
+
Requires ANY permissions:
|
|
34
|
+
|
|
35
|
+
* presence:presenceDefinition:delete
|
|
36
|
+
|
|
31
37
|
|
|
32
38
|
### Example
|
|
33
39
|
~~~ruby
|
|
@@ -80,12 +86,18 @@ nil (empty response body)
|
|
|
80
86
|
|
|
81
87
|
## -[**OrganizationPresence**](OrganizationPresence.html) get_presencedefinition(presence_id, opts)
|
|
82
88
|
|
|
89
|
+
|
|
90
|
+
|
|
83
91
|
Get a Presence Definition
|
|
84
92
|
|
|
85
93
|
|
|
86
94
|
|
|
87
95
|
Wraps GET /api/v2/presencedefinitions/{presenceId}
|
|
88
96
|
|
|
97
|
+
Requires NO permissions:
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
89
101
|
|
|
90
102
|
### Example
|
|
91
103
|
~~~ruby
|
|
@@ -143,12 +155,18 @@ Name | Type | Description | Notes
|
|
|
143
155
|
|
|
144
156
|
## -[**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html) get_presencedefinitions(opts)
|
|
145
157
|
|
|
158
|
+
|
|
159
|
+
|
|
146
160
|
Get an Organization's list of Presence Definitions
|
|
147
161
|
|
|
148
162
|
|
|
149
163
|
|
|
150
164
|
Wraps GET /api/v2/presencedefinitions
|
|
151
165
|
|
|
166
|
+
Requires NO permissions:
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
152
170
|
|
|
153
171
|
### Example
|
|
154
172
|
~~~ruby
|
|
@@ -209,12 +227,18 @@ Name | Type | Description | Notes
|
|
|
209
227
|
|
|
210
228
|
## -[**Array<SystemPresence>**](SystemPresence.html) get_systempresences
|
|
211
229
|
|
|
230
|
+
|
|
231
|
+
|
|
212
232
|
Get the list of SystemPresences
|
|
213
233
|
|
|
214
234
|
|
|
215
235
|
|
|
216
236
|
Wraps GET /api/v2/systempresences
|
|
217
237
|
|
|
238
|
+
Requires NO permissions:
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
218
242
|
|
|
219
243
|
### Example
|
|
220
244
|
~~~ruby
|
|
@@ -262,12 +286,18 @@ This endpoint does not need any parameter.
|
|
|
262
286
|
|
|
263
287
|
## -[**UserPresence**](UserPresence.html) get_user_presence(user_id, source_id)
|
|
264
288
|
|
|
289
|
+
|
|
290
|
+
|
|
265
291
|
Get a user's Presence
|
|
266
292
|
|
|
267
293
|
|
|
268
294
|
|
|
269
295
|
Wraps GET /api/v2/users/{userId}/presences/{sourceId}
|
|
270
296
|
|
|
297
|
+
Requires NO permissions:
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
271
301
|
|
|
272
302
|
### Example
|
|
273
303
|
~~~ruby
|
|
@@ -324,12 +354,18 @@ Name | Type | Description | Notes
|
|
|
324
354
|
|
|
325
355
|
## -[**UserPresence**](UserPresence.html) patch_user_presence(user_id, source_id, body)
|
|
326
356
|
|
|
357
|
+
|
|
358
|
+
|
|
327
359
|
Patch a user's Presence
|
|
328
360
|
|
|
329
361
|
The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
330
362
|
|
|
331
363
|
Wraps PATCH /api/v2/users/{userId}/presences/{sourceId}
|
|
332
364
|
|
|
365
|
+
Requires NO permissions:
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
333
369
|
|
|
334
370
|
### Example
|
|
335
371
|
~~~ruby
|
|
@@ -389,12 +425,18 @@ Name | Type | Description | Notes
|
|
|
389
425
|
|
|
390
426
|
## -[**OrganizationPresence**](OrganizationPresence.html) post_presencedefinitions(body)
|
|
391
427
|
|
|
428
|
+
|
|
429
|
+
|
|
392
430
|
Create a Presence Definition
|
|
393
431
|
|
|
394
432
|
|
|
395
433
|
|
|
396
434
|
Wraps POST /api/v2/presencedefinitions
|
|
397
435
|
|
|
436
|
+
Requires ANY permissions:
|
|
437
|
+
|
|
438
|
+
* presence:presenceDefinition:add
|
|
439
|
+
|
|
398
440
|
|
|
399
441
|
### Example
|
|
400
442
|
~~~ruby
|
|
@@ -448,12 +490,18 @@ Name | Type | Description | Notes
|
|
|
448
490
|
|
|
449
491
|
## -[**OrganizationPresence**](OrganizationPresence.html) put_presencedefinition(presence_id, body)
|
|
450
492
|
|
|
493
|
+
|
|
494
|
+
|
|
451
495
|
Update a Presence Definition
|
|
452
496
|
|
|
453
497
|
|
|
454
498
|
|
|
455
499
|
Wraps PUT /api/v2/presencedefinitions/{presenceId}
|
|
456
500
|
|
|
501
|
+
Requires ANY permissions:
|
|
502
|
+
|
|
503
|
+
* presence:presenceDefinition:edit
|
|
504
|
+
|
|
457
505
|
|
|
458
506
|
### Example
|
|
459
507
|
~~~ruby
|
|
@@ -13,9 +13,9 @@ title: PromptAssetEntityListing
|
|
|
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/PromptEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: PromptEntityListing
|
|
|
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/QualityApi.md
CHANGED
|
@@ -64,12 +64,18 @@ Method | Description
|
|
|
64
64
|
|
|
65
65
|
## -[**Calibration**](Calibration.html) delete_quality_calibration(calibration_id, calibrator_id)
|
|
66
66
|
|
|
67
|
+
|
|
68
|
+
|
|
67
69
|
Delete a calibration by id.
|
|
68
70
|
|
|
69
71
|
|
|
70
72
|
|
|
71
73
|
Wraps DELETE /api/v2/quality/calibrations/{calibrationId}
|
|
72
74
|
|
|
75
|
+
Requires NO permissions:
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
73
79
|
|
|
74
80
|
### Example
|
|
75
81
|
~~~ruby
|
|
@@ -126,12 +132,18 @@ Name | Type | Description | Notes
|
|
|
126
132
|
|
|
127
133
|
## -[**Evaluation**](Evaluation.html) delete_quality_conversation_evaluation(conversation_id, evaluation_id, opts)
|
|
128
134
|
|
|
135
|
+
|
|
136
|
+
|
|
129
137
|
Delete an evaluation
|
|
130
138
|
|
|
131
139
|
|
|
132
140
|
|
|
133
141
|
Wraps DELETE /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
|
|
134
142
|
|
|
143
|
+
Requires NO permissions:
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
135
147
|
|
|
136
148
|
### Example
|
|
137
149
|
~~~ruby
|
|
@@ -192,12 +204,18 @@ Name | Type | Description | Notes
|
|
|
192
204
|
|
|
193
205
|
## - delete_quality_form(form_id)
|
|
194
206
|
|
|
207
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
208
|
+
|
|
195
209
|
Delete an evaluation form.
|
|
196
210
|
|
|
197
211
|
|
|
198
212
|
|
|
199
213
|
Wraps DELETE /api/v2/quality/forms/{formId}
|
|
200
214
|
|
|
215
|
+
Requires ANY permissions:
|
|
216
|
+
|
|
217
|
+
* quality:evaluationForm:delete
|
|
218
|
+
|
|
201
219
|
|
|
202
220
|
### Example
|
|
203
221
|
~~~ruby
|
|
@@ -250,12 +268,18 @@ nil (empty response body)
|
|
|
250
268
|
|
|
251
269
|
## - delete_quality_forms_evaluation(form_id)
|
|
252
270
|
|
|
271
|
+
|
|
272
|
+
|
|
253
273
|
Delete an evaluation form.
|
|
254
274
|
|
|
255
275
|
|
|
256
276
|
|
|
257
277
|
Wraps DELETE /api/v2/quality/forms/evaluations/{formId}
|
|
258
278
|
|
|
279
|
+
Requires ANY permissions:
|
|
280
|
+
|
|
281
|
+
* quality:evaluationForm:delete
|
|
282
|
+
|
|
259
283
|
|
|
260
284
|
### Example
|
|
261
285
|
~~~ruby
|
|
@@ -308,12 +332,18 @@ nil (empty response body)
|
|
|
308
332
|
|
|
309
333
|
## - delete_quality_forms_survey(form_id)
|
|
310
334
|
|
|
335
|
+
|
|
336
|
+
|
|
311
337
|
Delete a survey form.
|
|
312
338
|
|
|
313
339
|
|
|
314
340
|
|
|
315
341
|
Wraps DELETE /api/v2/quality/forms/surveys/{formId}
|
|
316
342
|
|
|
343
|
+
Requires ANY permissions:
|
|
344
|
+
|
|
345
|
+
* quality:surveyForm:delete
|
|
346
|
+
|
|
317
347
|
|
|
318
348
|
### Example
|
|
319
349
|
~~~ruby
|
|
@@ -366,12 +396,18 @@ nil (empty response body)
|
|
|
366
396
|
|
|
367
397
|
## - delete_quality_keywordset(keyword_set_id)
|
|
368
398
|
|
|
399
|
+
|
|
400
|
+
|
|
369
401
|
Delete a keywordSet by id.
|
|
370
402
|
|
|
371
403
|
|
|
372
404
|
|
|
373
405
|
Wraps DELETE /api/v2/quality/keywordsets/{keywordSetId}
|
|
374
406
|
|
|
407
|
+
Requires NO permissions:
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
375
411
|
|
|
376
412
|
### Example
|
|
377
413
|
~~~ruby
|
|
@@ -424,12 +460,18 @@ nil (empty response body)
|
|
|
424
460
|
|
|
425
461
|
## - delete_quality_keywordsets(ids)
|
|
426
462
|
|
|
463
|
+
|
|
464
|
+
|
|
427
465
|
Delete keyword sets
|
|
428
466
|
|
|
429
467
|
Bulk delete of keyword sets; this will only delete the keyword sets that match the ids specified in the query param.
|
|
430
468
|
|
|
431
469
|
Wraps DELETE /api/v2/quality/keywordsets
|
|
432
470
|
|
|
471
|
+
Requires NO permissions:
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
433
475
|
|
|
434
476
|
### Example
|
|
435
477
|
~~~ruby
|
|
@@ -482,12 +524,18 @@ nil (empty response body)
|
|
|
482
524
|
|
|
483
525
|
## -[**AgentActivityEntityListing**](AgentActivityEntityListing.html) get_quality_agents_activity(opts)
|
|
484
526
|
|
|
527
|
+
|
|
528
|
+
|
|
485
529
|
Gets a list of Agent Activities
|
|
486
530
|
|
|
487
531
|
Including the number of evaluations and average evaluation score
|
|
488
532
|
|
|
489
533
|
Wraps GET /api/v2/quality/agents/activity
|
|
490
534
|
|
|
535
|
+
Requires NO permissions:
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
491
539
|
|
|
492
540
|
### Example
|
|
493
541
|
~~~ruby
|
|
@@ -564,12 +612,18 @@ Name | Type | Description | Notes
|
|
|
564
612
|
|
|
565
613
|
## -[**Calibration**](Calibration.html) get_quality_calibration(calibration_id, opts)
|
|
566
614
|
|
|
615
|
+
|
|
616
|
+
|
|
567
617
|
Get a calibration by id. Requires either calibrator id or conversation id
|
|
568
618
|
|
|
569
619
|
|
|
570
620
|
|
|
571
621
|
Wraps GET /api/v2/quality/calibrations/{calibrationId}
|
|
572
622
|
|
|
623
|
+
Requires NO permissions:
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
573
627
|
|
|
574
628
|
### Example
|
|
575
629
|
~~~ruby
|
|
@@ -629,12 +683,18 @@ Name | Type | Description | Notes
|
|
|
629
683
|
|
|
630
684
|
## -[**CalibrationEntityListing**](CalibrationEntityListing.html) get_quality_calibrations(calibrator_id, opts)
|
|
631
685
|
|
|
686
|
+
|
|
687
|
+
|
|
632
688
|
Get the list of calibrations
|
|
633
689
|
|
|
634
690
|
|
|
635
691
|
|
|
636
692
|
Wraps GET /api/v2/quality/calibrations
|
|
637
693
|
|
|
694
|
+
Requires NO permissions:
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
638
698
|
|
|
639
699
|
### Example
|
|
640
700
|
~~~ruby
|
|
@@ -708,12 +768,18 @@ Name | Type | Description | Notes
|
|
|
708
768
|
|
|
709
769
|
## -[**QualityAuditPage**](QualityAuditPage.html) get_quality_conversation_audits(conversation_id, opts)
|
|
710
770
|
|
|
771
|
+
|
|
772
|
+
|
|
711
773
|
Get audits for conversation or recording
|
|
712
774
|
|
|
713
775
|
|
|
714
776
|
|
|
715
777
|
Wraps GET /api/v2/quality/conversations/{conversationId}/audits
|
|
716
778
|
|
|
779
|
+
Requires NO permissions:
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
717
783
|
|
|
718
784
|
### Example
|
|
719
785
|
~~~ruby
|
|
@@ -785,12 +851,18 @@ Name | Type | Description | Notes
|
|
|
785
851
|
|
|
786
852
|
## -[**Evaluation**](Evaluation.html) get_quality_conversation_evaluation(conversation_id, evaluation_id, opts)
|
|
787
853
|
|
|
854
|
+
|
|
855
|
+
|
|
788
856
|
Get an evaluation
|
|
789
857
|
|
|
790
858
|
|
|
791
859
|
|
|
792
860
|
Wraps GET /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
|
|
793
861
|
|
|
862
|
+
Requires NO permissions:
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
|
|
794
866
|
|
|
795
867
|
### Example
|
|
796
868
|
~~~ruby
|
|
@@ -851,12 +923,18 @@ Name | Type | Description | Notes
|
|
|
851
923
|
|
|
852
924
|
## -[**EvaluationEntityListing**](EvaluationEntityListing.html) get_quality_evaluations_query(opts)
|
|
853
925
|
|
|
926
|
+
|
|
927
|
+
|
|
854
928
|
Queries Evaluations and returns a paged list
|
|
855
929
|
|
|
856
930
|
Query params must include one of conversationId, evaluatorUserId, or agentUserId
|
|
857
931
|
|
|
858
932
|
Wraps GET /api/v2/quality/evaluations/query
|
|
859
933
|
|
|
934
|
+
Requires NO permissions:
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
|
|
860
938
|
|
|
861
939
|
### Example
|
|
862
940
|
~~~ruby
|
|
@@ -945,12 +1023,18 @@ Name | Type | Description | Notes
|
|
|
945
1023
|
|
|
946
1024
|
## -[**EvaluatorActivityEntityListing**](EvaluatorActivityEntityListing.html) get_quality_evaluators_activity(opts)
|
|
947
1025
|
|
|
1026
|
+
|
|
1027
|
+
|
|
948
1028
|
Get an evaluator activity
|
|
949
1029
|
|
|
950
1030
|
|
|
951
1031
|
|
|
952
1032
|
Wraps GET /api/v2/quality/evaluators/activity
|
|
953
1033
|
|
|
1034
|
+
Requires NO permissions:
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
|
|
954
1038
|
|
|
955
1039
|
### Example
|
|
956
1040
|
~~~ruby
|
|
@@ -1025,12 +1109,18 @@ Name | Type | Description | Notes
|
|
|
1025
1109
|
|
|
1026
1110
|
## -[**EvaluationForm**](EvaluationForm.html) get_quality_form(form_id)
|
|
1027
1111
|
|
|
1112
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
1113
|
+
|
|
1028
1114
|
Get an evaluation form
|
|
1029
1115
|
|
|
1030
1116
|
|
|
1031
1117
|
|
|
1032
1118
|
Wraps GET /api/v2/quality/forms/{formId}
|
|
1033
1119
|
|
|
1120
|
+
Requires ANY permissions:
|
|
1121
|
+
|
|
1122
|
+
* quality:evaluationForm:view
|
|
1123
|
+
|
|
1034
1124
|
|
|
1035
1125
|
### Example
|
|
1036
1126
|
~~~ruby
|
|
@@ -1084,12 +1174,18 @@ Name | Type | Description | Notes
|
|
|
1084
1174
|
|
|
1085
1175
|
## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_form_versions(form_id, opts)
|
|
1086
1176
|
|
|
1177
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
1178
|
+
|
|
1087
1179
|
Gets all the revisions for a specific evaluation.
|
|
1088
1180
|
|
|
1089
1181
|
|
|
1090
1182
|
|
|
1091
1183
|
Wraps GET /api/v2/quality/forms/{formId}/versions
|
|
1092
1184
|
|
|
1185
|
+
Requires ANY permissions:
|
|
1186
|
+
|
|
1187
|
+
* quality:evaluationForm:view
|
|
1188
|
+
|
|
1093
1189
|
|
|
1094
1190
|
### Example
|
|
1095
1191
|
~~~ruby
|
|
@@ -1149,12 +1245,18 @@ Name | Type | Description | Notes
|
|
|
1149
1245
|
|
|
1150
1246
|
## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_forms(opts)
|
|
1151
1247
|
|
|
1248
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
1249
|
+
|
|
1152
1250
|
Get the list of evaluation forms
|
|
1153
1251
|
|
|
1154
1252
|
|
|
1155
1253
|
|
|
1156
1254
|
Wraps GET /api/v2/quality/forms
|
|
1157
1255
|
|
|
1256
|
+
Requires ANY permissions:
|
|
1257
|
+
|
|
1258
|
+
* quality:evaluationForm:view
|
|
1259
|
+
|
|
1158
1260
|
|
|
1159
1261
|
### Example
|
|
1160
1262
|
~~~ruby
|
|
@@ -1221,12 +1323,18 @@ Name | Type | Description | Notes
|
|
|
1221
1323
|
|
|
1222
1324
|
## -[**EvaluationForm**](EvaluationForm.html) get_quality_forms_evaluation(form_id)
|
|
1223
1325
|
|
|
1326
|
+
|
|
1327
|
+
|
|
1224
1328
|
Get an evaluation form
|
|
1225
1329
|
|
|
1226
1330
|
|
|
1227
1331
|
|
|
1228
1332
|
Wraps GET /api/v2/quality/forms/evaluations/{formId}
|
|
1229
1333
|
|
|
1334
|
+
Requires ANY permissions:
|
|
1335
|
+
|
|
1336
|
+
* quality:evaluationForm:view
|
|
1337
|
+
|
|
1230
1338
|
|
|
1231
1339
|
### Example
|
|
1232
1340
|
~~~ruby
|
|
@@ -1280,12 +1388,18 @@ Name | Type | Description | Notes
|
|
|
1280
1388
|
|
|
1281
1389
|
## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_forms_evaluation_versions(form_id, opts)
|
|
1282
1390
|
|
|
1391
|
+
|
|
1392
|
+
|
|
1283
1393
|
Gets all the revisions for a specific evaluation.
|
|
1284
1394
|
|
|
1285
1395
|
|
|
1286
1396
|
|
|
1287
1397
|
Wraps GET /api/v2/quality/forms/evaluations/{formId}/versions
|
|
1288
1398
|
|
|
1399
|
+
Requires ANY permissions:
|
|
1400
|
+
|
|
1401
|
+
* quality:evaluationForm:view
|
|
1402
|
+
|
|
1289
1403
|
|
|
1290
1404
|
### Example
|
|
1291
1405
|
~~~ruby
|
|
@@ -1345,12 +1459,18 @@ Name | Type | Description | Notes
|
|
|
1345
1459
|
|
|
1346
1460
|
## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_forms_evaluations(opts)
|
|
1347
1461
|
|
|
1462
|
+
|
|
1463
|
+
|
|
1348
1464
|
Get the list of evaluation forms
|
|
1349
1465
|
|
|
1350
1466
|
|
|
1351
1467
|
|
|
1352
1468
|
Wraps GET /api/v2/quality/forms/evaluations
|
|
1353
1469
|
|
|
1470
|
+
Requires ANY permissions:
|
|
1471
|
+
|
|
1472
|
+
* quality:evaluationForm:view
|
|
1473
|
+
|
|
1354
1474
|
|
|
1355
1475
|
### Example
|
|
1356
1476
|
~~~ruby
|
|
@@ -1417,12 +1537,18 @@ Name | Type | Description | Notes
|
|
|
1417
1537
|
|
|
1418
1538
|
## -[**SurveyForm**](SurveyForm.html) get_quality_forms_survey(form_id)
|
|
1419
1539
|
|
|
1540
|
+
|
|
1541
|
+
|
|
1420
1542
|
Get a survey form
|
|
1421
1543
|
|
|
1422
1544
|
|
|
1423
1545
|
|
|
1424
1546
|
Wraps GET /api/v2/quality/forms/surveys/{formId}
|
|
1425
1547
|
|
|
1548
|
+
Requires ANY permissions:
|
|
1549
|
+
|
|
1550
|
+
* quality:surveyForm:view
|
|
1551
|
+
|
|
1426
1552
|
|
|
1427
1553
|
### Example
|
|
1428
1554
|
~~~ruby
|
|
@@ -1476,12 +1602,18 @@ Name | Type | Description | Notes
|
|
|
1476
1602
|
|
|
1477
1603
|
## -[**SurveyFormEntityListing**](SurveyFormEntityListing.html) get_quality_forms_survey_versions(form_id, opts)
|
|
1478
1604
|
|
|
1605
|
+
|
|
1606
|
+
|
|
1479
1607
|
Gets all the revisions for a specific survey.
|
|
1480
1608
|
|
|
1481
1609
|
|
|
1482
1610
|
|
|
1483
1611
|
Wraps GET /api/v2/quality/forms/surveys/{formId}/versions
|
|
1484
1612
|
|
|
1613
|
+
Requires ANY permissions:
|
|
1614
|
+
|
|
1615
|
+
* quality:surveyForm:view
|
|
1616
|
+
|
|
1485
1617
|
|
|
1486
1618
|
### Example
|
|
1487
1619
|
~~~ruby
|
|
@@ -1541,12 +1673,18 @@ Name | Type | Description | Notes
|
|
|
1541
1673
|
|
|
1542
1674
|
## -[**SurveyFormEntityListing**](SurveyFormEntityListing.html) get_quality_forms_surveys(opts)
|
|
1543
1675
|
|
|
1676
|
+
|
|
1677
|
+
|
|
1544
1678
|
Get the list of survey forms
|
|
1545
1679
|
|
|
1546
1680
|
|
|
1547
1681
|
|
|
1548
1682
|
Wraps GET /api/v2/quality/forms/surveys
|
|
1549
1683
|
|
|
1684
|
+
Requires ANY permissions:
|
|
1685
|
+
|
|
1686
|
+
* quality:surveyForm:view
|
|
1687
|
+
|
|
1550
1688
|
|
|
1551
1689
|
### Example
|
|
1552
1690
|
~~~ruby
|
|
@@ -1613,12 +1751,18 @@ Name | Type | Description | Notes
|
|
|
1613
1751
|
|
|
1614
1752
|
## -[**KeywordSet**](KeywordSet.html) get_quality_keywordset(keyword_set_id)
|
|
1615
1753
|
|
|
1754
|
+
|
|
1755
|
+
|
|
1616
1756
|
Get a keywordSet by id.
|
|
1617
1757
|
|
|
1618
1758
|
|
|
1619
1759
|
|
|
1620
1760
|
Wraps GET /api/v2/quality/keywordsets/{keywordSetId}
|
|
1621
1761
|
|
|
1762
|
+
Requires NO permissions:
|
|
1763
|
+
|
|
1764
|
+
|
|
1765
|
+
|
|
1622
1766
|
|
|
1623
1767
|
### Example
|
|
1624
1768
|
~~~ruby
|
|
@@ -1672,12 +1816,18 @@ Name | Type | Description | Notes
|
|
|
1672
1816
|
|
|
1673
1817
|
## -[**KeywordSetEntityListing**](KeywordSetEntityListing.html) get_quality_keywordsets(opts)
|
|
1674
1818
|
|
|
1819
|
+
|
|
1820
|
+
|
|
1675
1821
|
Get the list of keyword sets
|
|
1676
1822
|
|
|
1677
1823
|
|
|
1678
1824
|
|
|
1679
1825
|
Wraps GET /api/v2/quality/keywordsets
|
|
1680
1826
|
|
|
1827
|
+
Requires NO permissions:
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
|
|
1681
1831
|
|
|
1682
1832
|
### Example
|
|
1683
1833
|
~~~ruby
|
|
@@ -1750,12 +1900,18 @@ Name | Type | Description | Notes
|
|
|
1750
1900
|
|
|
1751
1901
|
## -[**EvaluationForm**](EvaluationForm.html) get_quality_publishedform(form_id)
|
|
1752
1902
|
|
|
1903
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
1904
|
+
|
|
1753
1905
|
Get the published evaluation forms.
|
|
1754
1906
|
|
|
1755
1907
|
|
|
1756
1908
|
|
|
1757
1909
|
Wraps GET /api/v2/quality/publishedforms/{formId}
|
|
1758
1910
|
|
|
1911
|
+
Requires ANY permissions:
|
|
1912
|
+
|
|
1913
|
+
* quality:evaluationForm:view
|
|
1914
|
+
|
|
1759
1915
|
|
|
1760
1916
|
### Example
|
|
1761
1917
|
~~~ruby
|
|
@@ -1809,12 +1965,18 @@ Name | Type | Description | Notes
|
|
|
1809
1965
|
|
|
1810
1966
|
## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_publishedforms(opts)
|
|
1811
1967
|
|
|
1968
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
1969
|
+
|
|
1812
1970
|
Get the published evaluation forms.
|
|
1813
1971
|
|
|
1814
1972
|
|
|
1815
1973
|
|
|
1816
1974
|
Wraps GET /api/v2/quality/publishedforms
|
|
1817
1975
|
|
|
1976
|
+
Requires ANY permissions:
|
|
1977
|
+
|
|
1978
|
+
* quality:evaluationForm:view
|
|
1979
|
+
|
|
1818
1980
|
|
|
1819
1981
|
### Example
|
|
1820
1982
|
~~~ruby
|
|
@@ -1873,12 +2035,18 @@ Name | Type | Description | Notes
|
|
|
1873
2035
|
|
|
1874
2036
|
## -[**EvaluationForm**](EvaluationForm.html) get_quality_publishedforms_evaluation(form_id)
|
|
1875
2037
|
|
|
2038
|
+
|
|
2039
|
+
|
|
1876
2040
|
Get the most recent published version of an evaluation form.
|
|
1877
2041
|
|
|
1878
2042
|
|
|
1879
2043
|
|
|
1880
2044
|
Wraps GET /api/v2/quality/publishedforms/evaluations/{formId}
|
|
1881
2045
|
|
|
2046
|
+
Requires ANY permissions:
|
|
2047
|
+
|
|
2048
|
+
* quality:evaluationForm:view
|
|
2049
|
+
|
|
1882
2050
|
|
|
1883
2051
|
### Example
|
|
1884
2052
|
~~~ruby
|
|
@@ -1932,12 +2100,18 @@ Name | Type | Description | Notes
|
|
|
1932
2100
|
|
|
1933
2101
|
## -[**EvaluationFormEntityListing**](EvaluationFormEntityListing.html) get_quality_publishedforms_evaluations(opts)
|
|
1934
2102
|
|
|
2103
|
+
|
|
2104
|
+
|
|
1935
2105
|
Get the published evaluation forms.
|
|
1936
2106
|
|
|
1937
2107
|
|
|
1938
2108
|
|
|
1939
2109
|
Wraps GET /api/v2/quality/publishedforms/evaluations
|
|
1940
2110
|
|
|
2111
|
+
Requires ANY permissions:
|
|
2112
|
+
|
|
2113
|
+
* quality:evaluationForm:view
|
|
2114
|
+
|
|
1941
2115
|
|
|
1942
2116
|
### Example
|
|
1943
2117
|
~~~ruby
|
|
@@ -1996,12 +2170,18 @@ Name | Type | Description | Notes
|
|
|
1996
2170
|
|
|
1997
2171
|
## -[**SurveyForm**](SurveyForm.html) get_quality_publishedforms_survey(form_id)
|
|
1998
2172
|
|
|
2173
|
+
|
|
2174
|
+
|
|
1999
2175
|
Get the most recent published version of a survey form.
|
|
2000
2176
|
|
|
2001
2177
|
|
|
2002
2178
|
|
|
2003
2179
|
Wraps GET /api/v2/quality/publishedforms/surveys/{formId}
|
|
2004
2180
|
|
|
2181
|
+
Requires ANY permissions:
|
|
2182
|
+
|
|
2183
|
+
* quality:surveyForm:view
|
|
2184
|
+
|
|
2005
2185
|
|
|
2006
2186
|
### Example
|
|
2007
2187
|
~~~ruby
|
|
@@ -2055,12 +2235,18 @@ Name | Type | Description | Notes
|
|
|
2055
2235
|
|
|
2056
2236
|
## -[**SurveyFormEntityListing**](SurveyFormEntityListing.html) get_quality_publishedforms_surveys(opts)
|
|
2057
2237
|
|
|
2238
|
+
|
|
2239
|
+
|
|
2058
2240
|
Get the published survey forms.
|
|
2059
2241
|
|
|
2060
2242
|
|
|
2061
2243
|
|
|
2062
2244
|
Wraps GET /api/v2/quality/publishedforms/surveys
|
|
2063
2245
|
|
|
2246
|
+
Requires ANY permissions:
|
|
2247
|
+
|
|
2248
|
+
* quality:surveyForm:view
|
|
2249
|
+
|
|
2064
2250
|
|
|
2065
2251
|
### Example
|
|
2066
2252
|
~~~ruby
|
|
@@ -2119,12 +2305,18 @@ Name | Type | Description | Notes
|
|
|
2119
2305
|
|
|
2120
2306
|
## -[**SurveyForm**](SurveyForm.html) patch_quality_forms_survey(form_id, body)
|
|
2121
2307
|
|
|
2308
|
+
|
|
2309
|
+
|
|
2122
2310
|
Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.
|
|
2123
2311
|
|
|
2124
2312
|
|
|
2125
2313
|
|
|
2126
2314
|
Wraps PATCH /api/v2/quality/forms/surveys/{formId}
|
|
2127
2315
|
|
|
2316
|
+
Requires ANY permissions:
|
|
2317
|
+
|
|
2318
|
+
* quality:surveyForm:edit
|
|
2319
|
+
|
|
2128
2320
|
|
|
2129
2321
|
### Example
|
|
2130
2322
|
~~~ruby
|
|
@@ -2181,12 +2373,18 @@ Name | Type | Description | Notes
|
|
|
2181
2373
|
|
|
2182
2374
|
## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_analytics_evaluations_aggregates_query(body)
|
|
2183
2375
|
|
|
2376
|
+
|
|
2377
|
+
|
|
2184
2378
|
Query for evaluation aggregates
|
|
2185
2379
|
|
|
2186
2380
|
|
|
2187
2381
|
|
|
2188
2382
|
Wraps POST /api/v2/analytics/evaluations/aggregates/query
|
|
2189
2383
|
|
|
2384
|
+
Requires ANY permissions:
|
|
2385
|
+
|
|
2386
|
+
* analytics:evaluationAggregate:view
|
|
2387
|
+
|
|
2190
2388
|
|
|
2191
2389
|
### Example
|
|
2192
2390
|
~~~ruby
|
|
@@ -2240,12 +2438,18 @@ Name | Type | Description | Notes
|
|
|
2240
2438
|
|
|
2241
2439
|
## -[**Calibration**](Calibration.html) post_quality_calibrations(body, opts)
|
|
2242
2440
|
|
|
2441
|
+
|
|
2442
|
+
|
|
2243
2443
|
Create a calibration
|
|
2244
2444
|
|
|
2245
2445
|
|
|
2246
2446
|
|
|
2247
2447
|
Wraps POST /api/v2/quality/calibrations
|
|
2248
2448
|
|
|
2449
|
+
Requires NO permissions:
|
|
2450
|
+
|
|
2451
|
+
|
|
2452
|
+
|
|
2249
2453
|
|
|
2250
2454
|
### Example
|
|
2251
2455
|
~~~ruby
|
|
@@ -2303,12 +2507,18 @@ Name | Type | Description | Notes
|
|
|
2303
2507
|
|
|
2304
2508
|
## -[**Evaluation**](Evaluation.html) post_quality_conversation_evaluations(conversation_id, body, opts)
|
|
2305
2509
|
|
|
2510
|
+
|
|
2511
|
+
|
|
2306
2512
|
Create an evaluation
|
|
2307
2513
|
|
|
2308
2514
|
|
|
2309
2515
|
|
|
2310
2516
|
Wraps POST /api/v2/quality/conversations/{conversationId}/evaluations
|
|
2311
2517
|
|
|
2518
|
+
Requires NO permissions:
|
|
2519
|
+
|
|
2520
|
+
|
|
2521
|
+
|
|
2312
2522
|
|
|
2313
2523
|
### Example
|
|
2314
2524
|
~~~ruby
|
|
@@ -2369,12 +2579,18 @@ Name | Type | Description | Notes
|
|
|
2369
2579
|
|
|
2370
2580
|
## -[**EvaluationScoringSet**](EvaluationScoringSet.html) post_quality_evaluations_scoring(body)
|
|
2371
2581
|
|
|
2582
|
+
|
|
2583
|
+
|
|
2372
2584
|
Score evaluation
|
|
2373
2585
|
|
|
2374
2586
|
|
|
2375
2587
|
|
|
2376
2588
|
Wraps POST /api/v2/quality/evaluations/scoring
|
|
2377
2589
|
|
|
2590
|
+
Requires NO permissions:
|
|
2591
|
+
|
|
2592
|
+
|
|
2593
|
+
|
|
2378
2594
|
|
|
2379
2595
|
### Example
|
|
2380
2596
|
~~~ruby
|
|
@@ -2428,12 +2644,18 @@ Name | Type | Description | Notes
|
|
|
2428
2644
|
|
|
2429
2645
|
## -[**EvaluationForm**](EvaluationForm.html) post_quality_forms(body)
|
|
2430
2646
|
|
|
2647
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
2648
|
+
|
|
2431
2649
|
Create an evaluation form.
|
|
2432
2650
|
|
|
2433
2651
|
|
|
2434
2652
|
|
|
2435
2653
|
Wraps POST /api/v2/quality/forms
|
|
2436
2654
|
|
|
2655
|
+
Requires ANY permissions:
|
|
2656
|
+
|
|
2657
|
+
* quality:evaluationForm:add
|
|
2658
|
+
|
|
2437
2659
|
|
|
2438
2660
|
### Example
|
|
2439
2661
|
~~~ruby
|
|
@@ -2487,12 +2709,18 @@ Name | Type | Description | Notes
|
|
|
2487
2709
|
|
|
2488
2710
|
## -[**EvaluationForm**](EvaluationForm.html) post_quality_forms_evaluations(body)
|
|
2489
2711
|
|
|
2712
|
+
|
|
2713
|
+
|
|
2490
2714
|
Create an evaluation form.
|
|
2491
2715
|
|
|
2492
2716
|
|
|
2493
2717
|
|
|
2494
2718
|
Wraps POST /api/v2/quality/forms/evaluations
|
|
2495
2719
|
|
|
2720
|
+
Requires ANY permissions:
|
|
2721
|
+
|
|
2722
|
+
* quality:evaluationForm:add
|
|
2723
|
+
|
|
2496
2724
|
|
|
2497
2725
|
### Example
|
|
2498
2726
|
~~~ruby
|
|
@@ -2546,12 +2774,18 @@ Name | Type | Description | Notes
|
|
|
2546
2774
|
|
|
2547
2775
|
## -[**SurveyForm**](SurveyForm.html) post_quality_forms_surveys(body)
|
|
2548
2776
|
|
|
2777
|
+
|
|
2778
|
+
|
|
2549
2779
|
Create a survey form.
|
|
2550
2780
|
|
|
2551
2781
|
|
|
2552
2782
|
|
|
2553
2783
|
Wraps POST /api/v2/quality/forms/surveys
|
|
2554
2784
|
|
|
2785
|
+
Requires ANY permissions:
|
|
2786
|
+
|
|
2787
|
+
* quality:surveyForm:add
|
|
2788
|
+
|
|
2555
2789
|
|
|
2556
2790
|
### Example
|
|
2557
2791
|
~~~ruby
|
|
@@ -2605,12 +2839,18 @@ Name | Type | Description | Notes
|
|
|
2605
2839
|
|
|
2606
2840
|
## -[**KeywordSet**](KeywordSet.html) post_quality_keywordsets(body, opts)
|
|
2607
2841
|
|
|
2842
|
+
|
|
2843
|
+
|
|
2608
2844
|
Create a Keyword Set
|
|
2609
2845
|
|
|
2610
2846
|
|
|
2611
2847
|
|
|
2612
2848
|
Wraps POST /api/v2/quality/keywordsets
|
|
2613
2849
|
|
|
2850
|
+
Requires NO permissions:
|
|
2851
|
+
|
|
2852
|
+
|
|
2853
|
+
|
|
2614
2854
|
|
|
2615
2855
|
### Example
|
|
2616
2856
|
~~~ruby
|
|
@@ -2668,12 +2908,18 @@ Name | Type | Description | Notes
|
|
|
2668
2908
|
|
|
2669
2909
|
## -[**EvaluationForm**](EvaluationForm.html) post_quality_publishedforms(body)
|
|
2670
2910
|
|
|
2911
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
2912
|
+
|
|
2671
2913
|
Publish an evaluation form.
|
|
2672
2914
|
|
|
2673
2915
|
|
|
2674
2916
|
|
|
2675
2917
|
Wraps POST /api/v2/quality/publishedforms
|
|
2676
2918
|
|
|
2919
|
+
Requires ANY permissions:
|
|
2920
|
+
|
|
2921
|
+
* quality:evaluationForm:add
|
|
2922
|
+
|
|
2677
2923
|
|
|
2678
2924
|
### Example
|
|
2679
2925
|
~~~ruby
|
|
@@ -2727,12 +2973,18 @@ Name | Type | Description | Notes
|
|
|
2727
2973
|
|
|
2728
2974
|
## -[**EvaluationForm**](EvaluationForm.html) post_quality_publishedforms_evaluations(body)
|
|
2729
2975
|
|
|
2976
|
+
|
|
2977
|
+
|
|
2730
2978
|
Publish an evaluation form.
|
|
2731
2979
|
|
|
2732
2980
|
|
|
2733
2981
|
|
|
2734
2982
|
Wraps POST /api/v2/quality/publishedforms/evaluations
|
|
2735
2983
|
|
|
2984
|
+
Requires ANY permissions:
|
|
2985
|
+
|
|
2986
|
+
* quality:evaluationForm:add
|
|
2987
|
+
|
|
2736
2988
|
|
|
2737
2989
|
### Example
|
|
2738
2990
|
~~~ruby
|
|
@@ -2786,12 +3038,18 @@ Name | Type | Description | Notes
|
|
|
2786
3038
|
|
|
2787
3039
|
## -[**SurveyForm**](SurveyForm.html) post_quality_publishedforms_surveys(body)
|
|
2788
3040
|
|
|
3041
|
+
|
|
3042
|
+
|
|
2789
3043
|
Publish a survey form.
|
|
2790
3044
|
|
|
2791
3045
|
|
|
2792
3046
|
|
|
2793
3047
|
Wraps POST /api/v2/quality/publishedforms/surveys
|
|
2794
3048
|
|
|
3049
|
+
Requires ANY permissions:
|
|
3050
|
+
|
|
3051
|
+
* quality:surveyForm:add
|
|
3052
|
+
|
|
2795
3053
|
|
|
2796
3054
|
### Example
|
|
2797
3055
|
~~~ruby
|
|
@@ -2845,12 +3103,18 @@ Name | Type | Description | Notes
|
|
|
2845
3103
|
|
|
2846
3104
|
## -[**KeywordSet**](KeywordSet.html) post_quality_spotability(opts)
|
|
2847
3105
|
|
|
3106
|
+
|
|
3107
|
+
|
|
2848
3108
|
Retrieve the spotability statistic
|
|
2849
3109
|
|
|
2850
3110
|
|
|
2851
3111
|
|
|
2852
3112
|
Wraps POST /api/v2/quality/spotability
|
|
2853
3113
|
|
|
3114
|
+
Requires NO permissions:
|
|
3115
|
+
|
|
3116
|
+
|
|
3117
|
+
|
|
2854
3118
|
|
|
2855
3119
|
### Example
|
|
2856
3120
|
~~~ruby
|
|
@@ -2905,12 +3169,18 @@ Name | Type | Description | Notes
|
|
|
2905
3169
|
|
|
2906
3170
|
## -[**Calibration**](Calibration.html) put_quality_calibration(calibration_id, body)
|
|
2907
3171
|
|
|
3172
|
+
|
|
3173
|
+
|
|
2908
3174
|
Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex
|
|
2909
3175
|
|
|
2910
3176
|
|
|
2911
3177
|
|
|
2912
3178
|
Wraps PUT /api/v2/quality/calibrations/{calibrationId}
|
|
2913
3179
|
|
|
3180
|
+
Requires NO permissions:
|
|
3181
|
+
|
|
3182
|
+
|
|
3183
|
+
|
|
2914
3184
|
|
|
2915
3185
|
### Example
|
|
2916
3186
|
~~~ruby
|
|
@@ -2967,12 +3237,18 @@ Name | Type | Description | Notes
|
|
|
2967
3237
|
|
|
2968
3238
|
## -[**Evaluation**](Evaluation.html) put_quality_conversation_evaluation(conversation_id, evaluation_id, body, opts)
|
|
2969
3239
|
|
|
3240
|
+
|
|
3241
|
+
|
|
2970
3242
|
Update an evaluation
|
|
2971
3243
|
|
|
2972
3244
|
|
|
2973
3245
|
|
|
2974
3246
|
Wraps PUT /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId}
|
|
2975
3247
|
|
|
3248
|
+
Requires NO permissions:
|
|
3249
|
+
|
|
3250
|
+
|
|
3251
|
+
|
|
2976
3252
|
|
|
2977
3253
|
### Example
|
|
2978
3254
|
~~~ruby
|
|
@@ -3036,12 +3312,18 @@ Name | Type | Description | Notes
|
|
|
3036
3312
|
|
|
3037
3313
|
## -[**EvaluationForm**](EvaluationForm.html) put_quality_form(form_id, body)
|
|
3038
3314
|
|
|
3315
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
|
3316
|
+
|
|
3039
3317
|
Update an evaluation form.
|
|
3040
3318
|
|
|
3041
3319
|
|
|
3042
3320
|
|
|
3043
3321
|
Wraps PUT /api/v2/quality/forms/{formId}
|
|
3044
3322
|
|
|
3323
|
+
Requires ANY permissions:
|
|
3324
|
+
|
|
3325
|
+
* quality:evaluationForm:edit
|
|
3326
|
+
|
|
3045
3327
|
|
|
3046
3328
|
### Example
|
|
3047
3329
|
~~~ruby
|
|
@@ -3098,12 +3380,18 @@ Name | Type | Description | Notes
|
|
|
3098
3380
|
|
|
3099
3381
|
## -[**EvaluationForm**](EvaluationForm.html) put_quality_forms_evaluation(form_id, body)
|
|
3100
3382
|
|
|
3383
|
+
|
|
3384
|
+
|
|
3101
3385
|
Update an evaluation form.
|
|
3102
3386
|
|
|
3103
3387
|
|
|
3104
3388
|
|
|
3105
3389
|
Wraps PUT /api/v2/quality/forms/evaluations/{formId}
|
|
3106
3390
|
|
|
3391
|
+
Requires ANY permissions:
|
|
3392
|
+
|
|
3393
|
+
* quality:evaluationForm:edit
|
|
3394
|
+
|
|
3107
3395
|
|
|
3108
3396
|
### Example
|
|
3109
3397
|
~~~ruby
|
|
@@ -3160,12 +3448,18 @@ Name | Type | Description | Notes
|
|
|
3160
3448
|
|
|
3161
3449
|
## -[**SurveyForm**](SurveyForm.html) put_quality_forms_survey(form_id, body)
|
|
3162
3450
|
|
|
3451
|
+
|
|
3452
|
+
|
|
3163
3453
|
Update a survey form.
|
|
3164
3454
|
|
|
3165
3455
|
|
|
3166
3456
|
|
|
3167
3457
|
Wraps PUT /api/v2/quality/forms/surveys/{formId}
|
|
3168
3458
|
|
|
3459
|
+
Requires ANY permissions:
|
|
3460
|
+
|
|
3461
|
+
* quality:surveyForm:edit
|
|
3462
|
+
|
|
3169
3463
|
|
|
3170
3464
|
### Example
|
|
3171
3465
|
~~~ruby
|
|
@@ -3222,12 +3516,18 @@ Name | Type | Description | Notes
|
|
|
3222
3516
|
|
|
3223
3517
|
## -[**KeywordSet**](KeywordSet.html) put_quality_keywordset(keyword_set_id, body)
|
|
3224
3518
|
|
|
3519
|
+
|
|
3520
|
+
|
|
3225
3521
|
Update a keywordSet to the specified keywordSet via PUT.
|
|
3226
3522
|
|
|
3227
3523
|
|
|
3228
3524
|
|
|
3229
3525
|
Wraps PUT /api/v2/quality/keywordsets/{keywordSetId}
|
|
3230
3526
|
|
|
3527
|
+
Requires NO permissions:
|
|
3528
|
+
|
|
3529
|
+
|
|
3530
|
+
|
|
3231
3531
|
|
|
3232
3532
|
### Example
|
|
3233
3533
|
~~~ruby
|