purecloudplatformclientv2 57.0.0 → 58.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/ADFS.md +1 -1
- data/docs/ActionEntityListing.md +1 -1
- data/docs/Agent.md +2 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsConversationSegment.md +1 -0
- data/docs/AnalyticsScoredAgent.md +14 -0
- data/docs/AnalyticsSession.md +1 -0
- data/docs/ArchitectApi.md +4 -2
- data/docs/ArrayNode.md +9 -9
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +1 -11
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/{AddressableEntityUser.md → BusinessUnitReference.md} +2 -2
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +1 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackMediaParticipant.md +1 -0
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ChatMediaParticipant.md +1 -0
- data/docs/ChatMessage.md +2 -0
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseMediaParticipant.md +1 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationRoutingData.md +17 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/CustomerInteractionCenter.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataSchema.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/DncListDivisionViewListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMediaParticipant.md +1 -0
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluationQuestion.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDiagnosticInfo.md +13 -0
- 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/GSuite.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +0 -6
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityNow.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +9 -9
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +1 -78
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationDefinition.md +1 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationUpdateDefinition.md +1 -0
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnit.md +1 -0
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Manager.md +1 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessageMediaParticipant.md +1 -0
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/ObjectsApi.md +1 -1
- data/docs/ObservationValue.md +1 -0
- data/docs/Okta.md +1 -1
- data/docs/OneLogin.md +1 -1
- data/docs/OrganizationApi.md +3 -3
- data/docs/OrganizationAuthorizationApi.md +1 -9
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/Participant.md +1 -0
- data/docs/ParticipantBasic.md +1 -0
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneCapabilities.md +1 -0
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PingIdentity.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PresenceApi.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/PureEngage.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/Recording.md +2 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +0 -9
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/Salesforce.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/ScimV2CreateUser.md +1 -0
- data/docs/ScimV2User.md +1 -0
- data/docs/ScoredAgent.md +14 -0
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/ScriptsApi.md +2 -5
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/Skill.md +14 -0
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/Survey.md +1 -0
- data/docs/SurveyErrorDetails.md +14 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemMessageSystemMessage.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeOffRequestNotification.md +18 -0
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/Trunk.md +9 -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/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserExternalIdentifier.md +15 -0
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +345 -25
- data/docs/VoicemailApi.md +0 -4
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmAbandonRate.md +2 -2
- data/docs/WfmAverageSpeedOfAnswer.md +1 -1
- data/docs/WfmServiceLevel.md +3 -3
- data/docs/WfmUserNotification.md +1 -0
- data/docs/WorkforceManagementApi.md +22 -3
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +9 -2
- data/lib/purecloudplatformclientv2/api/architect_api.rb +13 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/license_api.rb +0 -55
- data/lib/purecloudplatformclientv2/api/objects_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scripts_api.rb +4 -14
- data/lib/purecloudplatformclientv2/api/users_api.rb +383 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +29 -2
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent.rb +32 -8
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/analytics_conversation_segment.rb +28 -1
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_scored_agent.rb +228 -0
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +30 -4
- data/lib/purecloudplatformclientv2/models/array_node.rb +70 -70
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{addressable_entity_user.rb → business_unit_reference.rb} +1 -1
- 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/call_media_participant.rb +27 -1
- 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/callback_media_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +14 -14
- 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/chat_media_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/chat_message.rb +53 -1
- 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/cobrowse_media_participant.rb +27 -1
- 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_division_view_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/conversation_routing_data.rb +310 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_schema.rb +1 -1
- 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_division_view_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/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_media_participant.rb +27 -1
- 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/evaluation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_question.rb +13 -13
- 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/facebook_integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_diagnostic_info.rb +202 -0
- 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/g_suite.rb +12 -12
- 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/identity_now.rb +12 -12
- 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 +70 -70
- 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/line_integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_definition.rb +26 -1
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_update_definition.rb +29 -4
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/management_unit.rb +27 -1
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/manager.rb +27 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/messaging_sticker_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/observation_value.rb +31 -4
- data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
- data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
- 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/participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +27 -1
- 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_capabilities.rb +31 -4
- 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/ping_identity.rb +12 -12
- 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/pure_engage.rb +12 -12
- 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/recording.rb +53 -1
- 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/reporting_export_job_response.rb +2 -2
- 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/salesforce.rb +12 -12
- 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/scim_v2_create_user.rb +27 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +27 -1
- data/lib/purecloudplatformclientv2/models/scored_agent.rb +228 -0
- 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/{license_organization.rb → skill.rb} +2 -56
- 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/subject_division_grants_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/survey.rb +27 -1
- data/lib/purecloudplatformclientv2/models/survey_error_details.rb +228 -0
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_message_system_message.rb +4 -6
- data/lib/purecloudplatformclientv2/models/system_prompt_asset.rb +2 -2
- 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_off_request_notification.rb +350 -0
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk.rb +269 -1
- 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/twitter_integration_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_external_identifier.rb +265 -0
- 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_member_info_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wfm_abandon_rate.rb +3 -3
- data/lib/purecloudplatformclientv2/models/wfm_average_speed_of_answer.rb +2 -2
- data/lib/purecloudplatformclientv2/models/wfm_service_level.rb +4 -4
- data/lib/purecloudplatformclientv2/models/wfm_user_notification.rb +29 -3
- 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 +20 -6
- data/docs/LicenseOrganization.md +0 -16
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cf9a7b29df2a74c5bdebd53ff0882f604619259a
|
|
4
|
+
data.tar.gz: 9510a9201c7e6ce9f1863d16b5c8733da06b37e1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 41412bc20869c6d366358f99075f411537b7b6a89cfd0056014bdff3aa9783c2487c9cdaa48864ddddadef23c94c25bbdee16ce052a7c8f84db1107530214a59
|
|
7
|
+
data.tar.gz: f8d479bb2fffc2df717f5e1a1469b325c2605b0de9389c9e2bcb60c55103745ae88a960c029c97ba5200b35105d1865a0c226be13b2b7e1b86a20479dc516a62
|
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
|
```{"language":"ruby"}
|
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 58.0.0'
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
### Install from Git
|
data/docs/ADFS.md
CHANGED
|
@@ -11,8 +11,8 @@ title: ADFS
|
|
|
11
11
|
| **name** | **String** | | [optional] |
|
|
12
12
|
| **relying_party_identifier** | **String** | | [optional] |
|
|
13
13
|
| **certificate** | **String** | | [optional] |
|
|
14
|
-
| **sso_target_uri** | **String** | | [optional] |
|
|
15
14
|
| **issuer_uri** | **String** | | [optional] |
|
|
15
|
+
| **sso_target_uri** | **String** | | [optional] |
|
|
16
16
|
| **disabled** | **BOOLEAN** | | [optional] |
|
|
17
17
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
18
18
|
{: class="table table-striped"}
|
data/docs/ActionEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: ActionEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/Agent.md
CHANGED
|
@@ -7,7 +7,8 @@ title: Agent
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **
|
|
10
|
+
| **id** | **String** | | [optional] |
|
|
11
|
+
| **self_uri** | **String** | | [optional] |
|
|
11
12
|
{: class="table table-striped"}
|
|
12
13
|
|
|
13
14
|
|
|
@@ -13,9 +13,9 @@ title: AgentActivityEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -19,6 +19,7 @@ title: AnalyticsConversationSegment
|
|
|
19
19
|
| **requested_routing_user_ids** | **Array<String>** | | [optional] |
|
|
20
20
|
| **requested_routing_skill_ids** | **Array<String>** | | [optional] |
|
|
21
21
|
| **requested_language_id** | **String** | A unique identifier for the language requested for an interaction. | [optional] |
|
|
22
|
+
| **scored_agents** | [**Array<AnalyticsScoredAgent>**](AnalyticsScoredAgent.html) | | [optional] |
|
|
22
23
|
| **properties** | [**Array<AnalyticsProperty>**](AnalyticsProperty.html) | | [optional] |
|
|
23
24
|
| **source_conversation_id** | **String** | | [optional] |
|
|
24
25
|
| **destination_conversation_id** | **String** | | [optional] |
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AnalyticsScoredAgent
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::AnalyticsScoredAgent
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **scored_agent_id** | **String** | Unique identifier of an agent that was scored for this conversation | [optional] |
|
|
11
|
+
| **agent_score** | **Integer** | Assigned agent score for this conversation (0 - 100, higher being better) | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/AnalyticsSession.md
CHANGED
|
@@ -56,6 +56,7 @@ title: AnalyticsSession
|
|
|
56
56
|
| **journey_action_map_id** | **String** | Journey action map ID | [optional] |
|
|
57
57
|
| **journey_action_map_version** | **String** | Journey action map version | [optional] |
|
|
58
58
|
| **protocol_call_id** | **String** | The original voice protocol call ID, e.g. a SIP call ID | [optional] |
|
|
59
|
+
| **provider** | **String** | The source provider for the communication | [optional] |
|
|
59
60
|
{: class="table table-striped"}
|
|
60
61
|
|
|
61
62
|
|
data/docs/ArchitectApi.md
CHANGED
|
@@ -1206,7 +1206,8 @@ object_type = "object_type_example" # String | Consumed object type
|
|
|
1206
1206
|
opts = {
|
|
1207
1207
|
resource_type: ["resource_type_example"], # Array<String> | Types of consuming resources to show. Only versioned types are allowed here.
|
|
1208
1208
|
page_number: 1, # Integer | Page number
|
|
1209
|
-
page_size: 25 # Integer | Page size
|
|
1209
|
+
page_size: 25, # Integer | Page size
|
|
1210
|
+
flow_filter: "flow_filter_example" # String | Show only checkedIn or published flows
|
|
1210
1211
|
}
|
|
1211
1212
|
|
|
1212
1213
|
begin
|
|
@@ -1227,6 +1228,7 @@ Name | Type | Description | Notes
|
|
|
1227
1228
|
**resource_type** | [**Array<String>**](String.html)| Types of consuming resources to show. Only versioned types are allowed here. | [optional] <br />**Values**: ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BRIDGEACTION, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WORKFLOW |
|
|
1228
1229
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
1229
1230
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
1231
|
+
**flow_filter** | **String**| Show only checkedIn or published flows | [optional] <br />**Values**: checkedIn, published |
|
|
1230
1232
|
{: class="table table-striped"}
|
|
1231
1233
|
|
|
1232
1234
|
|
|
@@ -4330,7 +4332,7 @@ Wraps POST /api/v2/architect/systemprompts/{promptId}/history
|
|
|
4330
4332
|
|
|
4331
4333
|
Requires ANY permissions:
|
|
4332
4334
|
|
|
4333
|
-
* architect:systemPrompt:
|
|
4335
|
+
* architect:systemPrompt:view
|
|
4334
4336
|
|
|
4335
4337
|
|
|
4336
4338
|
### Example
|
data/docs/ArrayNode.md
CHANGED
|
@@ -12,20 +12,20 @@ title: ArrayNode
|
|
|
12
12
|
| **number** | **BOOLEAN** | | [optional] |
|
|
13
13
|
| **object** | **BOOLEAN** | | [optional] |
|
|
14
14
|
| **boolean** | **BOOLEAN** | | [optional] |
|
|
15
|
-
| **value_node** | **BOOLEAN** | | [optional] |
|
|
16
|
-
| **binary** | **BOOLEAN** | | [optional] |
|
|
17
|
-
| **pojo** | **BOOLEAN** | | [optional] |
|
|
18
|
-
| **container_node** | **BOOLEAN** | | [optional] |
|
|
19
|
-
| **missing_node** | **BOOLEAN** | | [optional] |
|
|
20
15
|
| **floating_point_number** | **BOOLEAN** | | [optional] |
|
|
16
|
+
| **integral_number** | **BOOLEAN** | | [optional] |
|
|
17
|
+
| **short** | **BOOLEAN** | | [optional] |
|
|
18
|
+
| **int** | **BOOLEAN** | | [optional] |
|
|
19
|
+
| **long** | **BOOLEAN** | | [optional] |
|
|
21
20
|
| **double** | **BOOLEAN** | | [optional] |
|
|
22
21
|
| **big_decimal** | **BOOLEAN** | | [optional] |
|
|
23
22
|
| **big_integer** | **BOOLEAN** | | [optional] |
|
|
24
23
|
| **textual** | **BOOLEAN** | | [optional] |
|
|
25
|
-
| **
|
|
26
|
-
| **
|
|
27
|
-
| **
|
|
28
|
-
| **
|
|
24
|
+
| **binary** | **BOOLEAN** | | [optional] |
|
|
25
|
+
| **value_node** | **BOOLEAN** | | [optional] |
|
|
26
|
+
| **container_node** | **BOOLEAN** | | [optional] |
|
|
27
|
+
| **missing_node** | **BOOLEAN** | | [optional] |
|
|
28
|
+
| **pojo** | **BOOLEAN** | | [optional] |
|
|
29
29
|
| **array** | **BOOLEAN** | | [optional] |
|
|
30
30
|
| **null** | **BOOLEAN** | | [optional] |
|
|
31
31
|
{: class="table table-striped"}
|
|
@@ -13,9 +13,9 @@ title: AttemptLimitsEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/AuthorizationApi.md
CHANGED
|
@@ -123,8 +123,6 @@ Wraps DELETE /api/v2/authorization/roles/{roleId}
|
|
|
123
123
|
|
|
124
124
|
Requires ANY permissions:
|
|
125
125
|
|
|
126
|
-
* admin
|
|
127
|
-
* role_manager
|
|
128
126
|
* authorization:role:delete
|
|
129
127
|
|
|
130
128
|
|
|
@@ -259,8 +257,6 @@ Wraps DELETE /api/v2/users/{userId}/roles
|
|
|
259
257
|
|
|
260
258
|
Requires ANY permissions:
|
|
261
259
|
|
|
262
|
-
* admin
|
|
263
|
-
* role_manager
|
|
264
260
|
* authorization:grant:delete
|
|
265
261
|
|
|
266
262
|
|
|
@@ -1476,8 +1472,6 @@ Wraps PATCH /api/v2/authorization/roles/{roleId}
|
|
|
1476
1472
|
|
|
1477
1473
|
Requires ANY permissions:
|
|
1478
1474
|
|
|
1479
|
-
* admin
|
|
1480
|
-
* role_manager
|
|
1481
1475
|
* authorization:role:edit
|
|
1482
1476
|
|
|
1483
1477
|
|
|
@@ -1585,7 +1579,7 @@ end
|
|
|
1585
1579
|
Name | Type | Description | Notes
|
|
1586
1580
|
------------- | ------------- | ------------- | -------------
|
|
1587
1581
|
**division_id** | **String**| Division ID | |
|
|
1588
|
-
**object_type** | **String**| The type of the objects. Must be one of the valid object types | <br />**Values**: QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, USER |
|
|
1582
|
+
**object_type** | **String**| The type of the objects. Must be one of the valid object types | <br />**Values**: QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, BUSINESSUNIT, FLOW, USER |
|
|
1589
1583
|
**body** | **Array<String>**| Object Id List | |
|
|
1590
1584
|
{: class="table table-striped"}
|
|
1591
1585
|
|
|
@@ -2096,8 +2090,6 @@ Wraps PUT /api/v2/authorization/roles/{roleId}
|
|
|
2096
2090
|
|
|
2097
2091
|
Requires ANY permissions:
|
|
2098
2092
|
|
|
2099
|
-
* admin
|
|
2100
|
-
* role_manager
|
|
2101
2093
|
* authorization:role:edit
|
|
2102
2094
|
|
|
2103
2095
|
|
|
@@ -2367,8 +2359,6 @@ Wraps PUT /api/v2/users/{userId}/roles
|
|
|
2367
2359
|
|
|
2368
2360
|
Requires ANY permissions:
|
|
2369
2361
|
|
|
2370
|
-
* admin
|
|
2371
|
-
* role_manager
|
|
2372
2362
|
* authorization:grant:add
|
|
2373
2363
|
|
|
2374
2364
|
|
|
@@ -13,9 +13,9 @@ title: AuthzDivisionEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: CalibrationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: CallConversationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: CallHistoryConversationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -36,6 +36,7 @@ title: CallMediaParticipant
|
|
|
36
36
|
| **peer** | **String** | The peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
37
37
|
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
38
38
|
| **journey_context** | [**JourneyContext**](JourneyContext.html) | Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. | [optional] |
|
|
39
|
+
| **conversation_routing_data** | [**ConversationRoutingData**](ConversationRoutingData.html) | Information on how a communication should be routed to an agent. | [optional] |
|
|
39
40
|
| **muted** | **BOOLEAN** | Value is true when the call is muted. | [optional] |
|
|
40
41
|
| **confined** | **BOOLEAN** | Value is true when the call is confined. | [optional] |
|
|
41
42
|
| **recording** | **BOOLEAN** | Value is true when the call is being recorded. | [optional] |
|
|
@@ -13,9 +13,9 @@ title: CallableTimeSetEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: CallbackConversationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -36,6 +36,7 @@ title: CallbackMediaParticipant
|
|
|
36
36
|
| **peer** | **String** | The peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
37
37
|
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
38
38
|
| **journey_context** | [**JourneyContext**](JourneyContext.html) | Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. | [optional] |
|
|
39
|
+
| **conversation_routing_data** | [**ConversationRoutingData**](ConversationRoutingData.html) | Information on how a communication should be routed to an agent. | [optional] |
|
|
39
40
|
| **outbound_preview** | [**DialerPreview**](DialerPreview.html) | The outbound preview associated with this callback. | [optional] |
|
|
40
41
|
| **voicemail** | [**Voicemail**](Voicemail.html) | The voicemail associated with this callback. | [optional] |
|
|
41
42
|
| **callback_numbers** | **Array<String>** | The list of phone number to use for this callback. | [optional] |
|
|
@@ -13,9 +13,9 @@ title: CampaignDivisionViewListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: CampaignEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: CampaignRuleEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: CampaignSequenceEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: CertificateAuthorityEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: ChatConversationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -36,6 +36,7 @@ title: ChatMediaParticipant
|
|
|
36
36
|
| **peer** | **String** | The peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
37
37
|
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
38
38
|
| **journey_context** | [**JourneyContext**](JourneyContext.html) | Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. | [optional] |
|
|
39
|
+
| **conversation_routing_data** | [**ConversationRoutingData**](ConversationRoutingData.html) | Information on how a communication should be routed to an agent. | [optional] |
|
|
39
40
|
| **room_id** | **String** | The ID of the chat room. | [optional] |
|
|
40
41
|
| **avatar_image_url** | **String** | If available, the URI to the avatar image of this communication. | [optional] |
|
|
41
42
|
{: class="table table-striped"}
|
data/docs/ChatMessage.md
CHANGED
|
@@ -16,6 +16,8 @@ title: ChatMessage
|
|
|
16
16
|
| **message** | **String** | The message id | [optional] |
|
|
17
17
|
| **type** | **String** | | [optional] |
|
|
18
18
|
| **body_type** | **String** | Type of the message body (v2 chats only) | [optional] |
|
|
19
|
+
| **sender_communication_id** | **String** | Communication of sender (v2 chats only) | [optional] |
|
|
20
|
+
| **participant_purpose** | **String** | Participant purpose of sender (v2 chats only) | [optional] |
|
|
19
21
|
| **user** | [**ChatMessageUser**](ChatMessageUser.html) | The user information for the sender (if available) | [optional] |
|
|
20
22
|
{: class="table table-striped"}
|
|
21
23
|
|
|
@@ -13,9 +13,9 @@ title: ClientAppEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: CobrowseConversationEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **next_uri** | **String** | | [optional] |
|
|
16
17
|
| **previous_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -36,6 +36,7 @@ title: CobrowseMediaParticipant
|
|
|
36
36
|
| **peer** | **String** | The peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
37
37
|
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
38
38
|
| **journey_context** | [**JourneyContext**](JourneyContext.html) | Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. | [optional] |
|
|
39
|
+
| **conversation_routing_data** | [**ConversationRoutingData**](ConversationRoutingData.html) | Information on how a communication should be routed to an agent. | [optional] |
|
|
39
40
|
| **cobrowse_session_id** | **String** | The co-browse session ID. | [optional] |
|
|
40
41
|
| **cobrowse_role** | **String** | This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer). | [optional] |
|
|
41
42
|
| **controlling** | **Array<String>** | ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages). | [optional] |
|