purecloudplatformclientv2 61.0.0 → 62.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +2 -2
- data/docs/AgentActivityEntityListing.md +2 -2
- data/docs/AnalyticsApi.md +267 -0
- data/docs/AnalyticsConversationAsyncQueryResponse.md +14 -0
- data/docs/AnalyticsEvaluation.md +1 -1
- data/docs/ArrayNode.md +7 -7
- data/docs/AsyncQueryResponse.md +13 -0
- data/docs/AsyncQueryStatus.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +2 -2
- data/docs/Attribute.md +2 -2
- data/docs/AuthorizationApi.md +6 -2
- data/docs/AuthzDivisionEntityListing.md +2 -2
- data/docs/BillingApi.md +4 -4
- data/docs/BillingUsageReport.md +1 -0
- data/docs/CalibrationEntityListing.md +2 -2
- data/docs/CallConversationEntityListing.md +2 -2
- data/docs/CallHistoryConversationEntityListing.md +2 -2
- data/docs/CallMediaParticipant.md +6 -6
- data/docs/CallableContactsDiagnostic.md +4 -4
- data/docs/CallableTimeSetEntityListing.md +2 -2
- data/docs/CallbackConversationEntityListing.md +2 -2
- data/docs/CallbackMediaParticipant.md +5 -5
- data/docs/Campaign.md +11 -11
- data/docs/CampaignDivisionViewListing.md +2 -2
- data/docs/CampaignEntityListing.md +2 -2
- data/docs/CampaignInteraction.md +6 -6
- data/docs/CampaignInteractions.md +1 -1
- data/docs/CampaignProgress.md +2 -2
- data/docs/CampaignRuleActionEntities.md +2 -2
- data/docs/CampaignRuleEntities.md +2 -2
- data/docs/CampaignRuleEntityListing.md +2 -2
- data/docs/CampaignSchedule.md +1 -1
- data/docs/CampaignSequence.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +2 -2
- data/docs/CertificateAuthorityEntityListing.md +2 -2
- data/docs/ChatConversationEntityListing.md +2 -2
- data/docs/ChatMediaParticipant.md +5 -5
- data/docs/ClientAppEntityListing.md +2 -2
- data/docs/CobrowseConversationEntityListing.md +2 -2
- data/docs/CobrowseMediaParticipant.md +5 -5
- data/docs/CommandStatusEntityListing.md +2 -2
- data/docs/ConsumedResourcesEntityListing.md +2 -2
- data/docs/ConsumingResourcesEntityListing.md +2 -2
- data/docs/ContactList.md +2 -2
- data/docs/ContactListDivisionViewListing.md +2 -2
- data/docs/ContactListEntityListing.md +2 -2
- data/docs/ContactListFilter.md +1 -1
- data/docs/ContactListFilterEntityListing.md +2 -2
- data/docs/ContactListing.md +2 -2
- data/docs/ConversationDivisionMembership.md +2 -2
- data/docs/ConversationEntityListing.md +2 -2
- data/docs/ConversationsApi.md +471 -0
- data/docs/CreateCallbackResponse.md +1 -1
- data/docs/CreateQueueRequest.md +2 -2
- data/docs/CreateShareResponse.md +4 -4
- data/docs/CreateUser.md +1 -0
- data/docs/CredentialInfoListing.md +2 -2
- data/docs/CredentialTypeListing.md +2 -2
- data/docs/DID.md +2 -2
- data/docs/DIDEntityListing.md +2 -2
- data/docs/DIDPoolEntityListing.md +2 -2
- data/docs/DataSchema.md +1 -1
- data/docs/DataTableRowEntityListing.md +2 -2
- data/docs/DataTablesDomainEntityListing.md +2 -2
- data/docs/DependencyObjectEntityListing.md +2 -2
- data/docs/DependencyTypeEntityListing.md +2 -2
- data/docs/DialerEventEntityListing.md +2 -2
- data/docs/DialogflowAgentSummaryEntityListing.md +2 -2
- data/docs/DirectoryUserDevicesListing.md +2 -2
- data/docs/DncList.md +1 -1
- data/docs/DncListCreate.md +1 -1
- data/docs/DncListDivisionViewListing.md +2 -2
- data/docs/DncListEntityListing.md +2 -2
- data/docs/Document.md +4 -4
- data/docs/DocumentAudit.md +2 -2
- data/docs/DocumentAuditEntityListing.md +2 -2
- data/docs/DocumentEntityListing.md +2 -2
- data/docs/DocumentUpload.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
- data/docs/DomainEntityListing.md +2 -2
- data/docs/DomainEntityListingEvaluationForm.md +2 -2
- data/docs/DomainEntityListingQueryResult.md +2 -2
- data/docs/DomainEntityListingSurveyForm.md +2 -2
- data/docs/{UriReference.md → DomainEntityRef.md} +2 -2
- data/docs/DomainOrganizationRole.md +1 -0
- data/docs/DomainOrganizationRoleCreate.md +1 -0
- data/docs/DomainOrganizationRoleUpdate.md +1 -0
- data/docs/EdgeEntityListing.md +2 -2
- data/docs/EdgeGroupEntityListing.md +2 -2
- data/docs/EdgeInterface.md +1 -1
- data/docs/EdgeLine.md +1 -1
- data/docs/EdgeLineEntityListing.md +2 -2
- data/docs/EdgeMetrics.md +1 -1
- data/docs/EdgeTrunkBase.md +1 -1
- data/docs/EmailConversationEntityListing.md +2 -2
- data/docs/EmailMediaParticipant.md +5 -5
- data/docs/EmailMessageListing.md +2 -2
- data/docs/EmergencyCallFlow.md +2 -2
- data/docs/EmergencyGroupListing.md +2 -2
- data/docs/EncryptionKeyEntityListing.md +2 -2
- data/docs/Endpoint.md +2 -2
- data/docs/EvaluationEntityListing.md +2 -2
- data/docs/EvaluationFormEntityListing.md +2 -2
- data/docs/EvaluatorActivityEntityListing.md +2 -2
- data/docs/EventLog.md +2 -2
- data/docs/Extension.md +2 -2
- data/docs/ExtensionEntityListing.md +2 -2
- data/docs/ExtensionPoolEntityListing.md +2 -2
- data/docs/ExternalOrganizationListing.md +2 -2
- data/docs/FacebookIntegration.md +3 -3
- data/docs/FacebookIntegrationEntityListing.md +2 -2
- data/docs/FaxDocument.md +2 -2
- data/docs/FaxDocumentEntityListing.md +2 -2
- data/docs/FlowDivisionViewEntityListing.md +2 -2
- data/docs/FlowEntityListing.md +2 -2
- data/docs/FlowOutcomeListing.md +2 -2
- data/docs/FlowVersionEntityListing.md +2 -2
- data/docs/GDPRRequest.md +1 -1
- data/docs/GDPRRequestEntityListing.md +2 -2
- data/docs/GDPRSubjectEntityListing.md +2 -2
- data/docs/GreetingListing.md +2 -2
- data/docs/GroupEntityListing.md +2 -2
- data/docs/GroupProfileEntityListing.md +2 -2
- data/docs/GroupsApi.md +1 -1
- data/docs/IVR.md +4 -4
- data/docs/IVREntityListing.md +2 -2
- data/docs/InboundDomainEntityListing.md +2 -2
- data/docs/InboundRoute.md +5 -5
- data/docs/InboundRouteEntityListing.md +2 -2
- data/docs/IntegrationEntityListing.md +2 -2
- data/docs/IntegrationEventEntityListing.md +2 -2
- data/docs/IntegrationExport.md +2 -2
- data/docs/IntegrationTypeEntityListing.md +2 -2
- data/docs/InteractionStatsAlertContainer.md +2 -2
- data/docs/InteractionStatsRuleContainer.md +2 -2
- data/docs/JsonNode.md +7 -7
- data/docs/KeywordSetEntityListing.md +2 -2
- data/docs/LanguageEntityListing.md +2 -2
- data/docs/LexBotAliasEntityListing.md +2 -2
- data/docs/LexBotEntityListing.md +2 -2
- data/docs/LibraryEntityListing.md +2 -2
- data/docs/Line.md +6 -6
- data/docs/LineBase.md +1 -1
- data/docs/LineBaseEntityListing.md +2 -2
- data/docs/LineEntityListing.md +2 -2
- data/docs/LineIntegration.md +3 -3
- data/docs/LineIntegrationEntityListing.md +2 -2
- data/docs/LocationEntityListing.md +2 -2
- data/docs/LockInfo.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +2 -2
- data/docs/ManagementUnitListing.md +2 -2
- data/docs/Manager.md +1 -1
- data/docs/MessageConversationEntityListing.md +2 -2
- data/docs/MessageMediaParticipant.md +5 -5
- data/docs/MessagingIntegration.md +3 -3
- data/docs/MessagingIntegrationEntityListing.md +2 -2
- data/docs/MessagingStickerEntityListing.md +2 -2
- data/docs/NoteListing.md +2 -2
- data/docs/OAuthClient.md +2 -2
- data/docs/OAuthClientEntityListing.md +2 -2
- data/docs/OAuthClientListing.md +2 -2
- data/docs/OAuthProviderEntityListing.md +2 -2
- data/docs/OrgOAuthClient.md +2 -2
- data/docs/OrganizationPresenceEntityListing.md +2 -2
- data/docs/OrganizationRoleEntityListing.md +2 -2
- data/docs/OrphanRecordingListing.md +2 -2
- data/docs/OutboundApi.md +4 -4
- data/docs/OutboundRoute.md +1 -1
- data/docs/OutboundRouteBase.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +2 -2
- data/docs/OutboundRouteEntityListing.md +2 -2
- data/docs/PermissionCollectionEntityListing.md +2 -2
- data/docs/Phone.md +5 -5
- data/docs/PhoneBase.md +1 -1
- data/docs/PhoneBaseEntityListing.md +2 -2
- data/docs/PhoneEntityListing.md +2 -2
- data/docs/PhoneMetaBaseEntityListing.md +2 -2
- data/docs/PhoneStatus.md +1 -1
- data/docs/Photo.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +2 -2
- data/docs/PolicyEntityListing.md +2 -2
- data/docs/PromptAssetEntityListing.md +2 -2
- data/docs/PromptEntityListing.md +2 -2
- data/docs/QualityAuditPage.md +2 -2
- data/docs/Queue.md +2 -2
- data/docs/QueueEmailAddress.md +1 -1
- data/docs/QueueEntityListing.md +2 -2
- data/docs/QueueMemberEntityListing.md +2 -2
- data/docs/QueueMessagingAddresses.md +1 -1
- data/docs/QueueRequest.md +2 -2
- data/docs/QueueUtilizationDiagnostic.md +1 -1
- data/docs/RecipientListing.md +2 -2
- data/docs/RecordingJobEntityListing.md +2 -2
- data/docs/RecordingJobsQuery.md +2 -1
- data/docs/RelationshipListing.md +2 -2
- data/docs/ReplaceResponse.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +2 -2
- data/docs/ReportRunEntryEntityDomainListing.md +2 -2
- data/docs/ReportScheduleEntityListing.md +2 -2
- data/docs/ReportingExportJobListing.md +2 -2
- data/docs/Response.md +1 -1
- data/docs/ResponseEntityList.md +2 -2
- data/docs/ResponseEntityListing.md +2 -2
- data/docs/ResponseSetEntityListing.md +2 -2
- data/docs/RoutingApi.md +3 -1
- data/docs/RuleSet.md +2 -2
- data/docs/RuleSetDiagnostic.md +1 -1
- data/docs/RuleSetEntityListing.md +2 -2
- data/docs/ScheduleEntityListing.md +2 -2
- data/docs/ScheduleGroup.md +3 -3
- data/docs/ScheduleGroupEntityListing.md +2 -2
- data/docs/SchemaCategoryEntityListing.md +2 -2
- data/docs/SchemaReferenceEntityListing.md +2 -2
- data/docs/ScimGroupListResponse.md +4 -4
- data/docs/ScimPhoneNumber.md +1 -1
- data/docs/ScimUserListResponse.md +4 -4
- data/docs/ScimV2CreateUser.md +2 -3
- data/docs/ScimV2Group.md +2 -2
- data/docs/ScimV2GroupReference.md +2 -3
- data/docs/ScimV2MemberReference.md +2 -3
- data/docs/ScimV2User.md +4 -4
- data/docs/ScreenRecordingSessionListing.md +2 -2
- data/docs/ScriptEntityListing.md +2 -2
- data/docs/SearchApi.md +2 -2
- data/docs/SecureSession.md +1 -1
- data/docs/SecurityProfileEntityListing.md +2 -2
- data/docs/SequenceSchedule.md +1 -1
- data/docs/Share.md +4 -4
- data/docs/ShareEntityListing.md +2 -2
- data/docs/Site.md +2 -2
- data/docs/SiteEntityListing.md +2 -2
- data/docs/SkillEntityListing.md +2 -2
- data/docs/SmsAddressEntityListing.md +2 -2
- data/docs/SmsPhoneNumberEntityListing.md +2 -2
- data/docs/SpeechTextAnalyticsApi.md +80 -0
- data/docs/Station.md +2 -2
- data/docs/StationEntityListing.md +2 -2
- data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
- data/docs/SuggestApi.md +2 -2
- data/docs/Survey.md +1 -1
- data/docs/SurveyAssignment.md +1 -1
- data/docs/SurveyFormEntityListing.md +2 -2
- data/docs/SystemPromptAssetEntityListing.md +2 -2
- data/docs/SystemPromptEntityListing.md +2 -2
- data/docs/TagValueEntityListing.md +2 -2
- data/docs/TextMessageListing.md +2 -2
- data/docs/TimeZoneEntityListing.md +2 -2
- data/docs/TimeZoneMappingPreview.md +1 -1
- data/docs/TranscriptProperty.md +15 -0
- data/docs/Trunk.md +5 -5
- data/docs/TrunkBase.md +1 -1
- data/docs/TrunkBaseEntityListing.md +2 -2
- data/docs/TrunkEntityListing.md +2 -2
- data/docs/TrunkMetabaseEntityListing.md +2 -2
- data/docs/TrunkMetrics.md +2 -2
- data/docs/TrustEntityListing.md +2 -2
- data/docs/TrustUserEntityListing.md +2 -2
- data/docs/TrustorEntityListing.md +2 -2
- data/docs/TtsEngineEntityListing.md +2 -2
- data/docs/TtsVoiceEntityListing.md +2 -2
- data/docs/TwitterIntegration.md +3 -3
- data/docs/TwitterIntegrationEntityListing.md +2 -2
- data/docs/UserActionCategoryEntityListing.md +2 -2
- data/docs/UserAuthorization.md +1 -0
- data/docs/UserEntityListing.md +2 -2
- data/docs/UserLanguageEntityListing.md +2 -2
- data/docs/UserProfileEntityListing.md +2 -2
- data/docs/UserQueue.md +2 -2
- data/docs/UserQueueEntityListing.md +2 -2
- data/docs/UserRecording.md +2 -2
- data/docs/UserRecordingEntityListing.md +2 -2
- data/docs/UserSkillEntityListing.md +2 -2
- data/docs/UsersApi.md +9 -9
- data/docs/VoicemailMessageEntityListing.md +2 -2
- data/docs/WebChatDeployment.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +2 -2
- data/docs/WhatsAppIntegration.md +25 -0
- data/docs/WhatsAppIntegrationEntityListing.md +22 -0
- data/docs/WhatsAppIntegrationUpdateRequest.md +18 -0
- data/docs/WidgetDeployment.md +1 -1
- data/docs/Workspace.md +1 -1
- data/docs/WorkspaceEntityListing.md +2 -2
- data/docs/WorkspaceMember.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +2 -2
- data/docs/WrapupCodeEntityListing.md +2 -2
- data/lib/purecloudplatformclientv2.rb +9 -1
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +268 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/billing_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +481 -0
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +102 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +229 -0
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +13 -13
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/array_node.rb +75 -75
- data/lib/purecloudplatformclientv2/models/async_query_response.rb +202 -0
- data/lib/purecloudplatformclientv2/models/async_query_status.rb +320 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/attribute.rb +2 -2
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/billing_usage_report.rb +41 -1
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +6 -6
- data/lib/purecloudplatformclientv2/models/callable_contacts_diagnostic.rb +4 -4
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/campaign.rb +11 -11
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_interaction.rb +6 -6
- data/lib/purecloudplatformclientv2/models/campaign_interactions.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_progress.rb +2 -2
- data/lib/purecloudplatformclientv2/models/campaign_rule_action_entities.rb +2 -2
- data/lib/purecloudplatformclientv2/models/campaign_rule_entities.rb +2 -2
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/campaign_schedule.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_sequence.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list.rb +2 -2
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_list_filter.rb +1 -1
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/conversation_division_membership.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/create_callback_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/create_share_response.rb +4 -4
- data/lib/purecloudplatformclientv2/models/create_user.rb +44 -4
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/data_schema.rb +1 -1
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/did.rb +2 -2
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dnc_list.rb +1 -1
- data/lib/purecloudplatformclientv2/models/dnc_list_create.rb +1 -1
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document.rb +4 -4
- data/lib/purecloudplatformclientv2/models/document_audit.rb +2 -2
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/document_upload.rb +1 -1
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +13 -13
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +13 -13
- data/lib/purecloudplatformclientv2/models/{uri_reference.rb → domain_entity_ref.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +28 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +28 -1
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +28 -1
- data/lib/purecloudplatformclientv2/models/edge.rb +2 -2
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_interface.rb +1 -1
- data/lib/purecloudplatformclientv2/models/edge_line.rb +1 -1
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/edge_metrics.rb +1 -1
- data/lib/purecloudplatformclientv2/models/edge_trunk_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/emergency_call_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/endpoint.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/event_log.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/facebook_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/fax_document.rb +2 -2
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/gdpr_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/inbound_route.rb +5 -5
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/integration_export.rb +7 -2
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +13 -13
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +13 -13
- data/lib/purecloudplatformclientv2/models/ivr.rb +4 -4
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/json_node.rb +75 -75
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line.rb +6 -6
- data/lib/purecloudplatformclientv2/models/line_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/line_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/lock_info.rb +1 -1
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/manager.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +5 -5
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/note_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/o_auth_client.rb +2 -2
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +2 -2
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +2 -2
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/outbound_route.rb +1 -1
- data/lib/purecloudplatformclientv2/models/outbound_route_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone.rb +5 -5
- data/lib/purecloudplatformclientv2/models/phone_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/phone_status.rb +1 -1
- data/lib/purecloudplatformclientv2/models/photo.rb +1 -1
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_email_address.rb +1 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/queue_messaging_addresses.rb +1 -1
- data/lib/purecloudplatformclientv2/models/queue_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/queue_utilization_diagnostic.rb +1 -1
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +27 -6
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/replace_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/rule_set.rb +2 -2
- data/lib/purecloudplatformclientv2/models/rule_set_diagnostic.rb +1 -1
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schedule_group.rb +3 -3
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -29
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +3 -29
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +3 -29
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +17 -17
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/secure_session.rb +1 -1
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/sequence_schedule.rb +1 -1
- data/lib/purecloudplatformclientv2/models/share.rb +4 -4
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/site.rb +2 -2
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/station.rb +2 -2
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/survey.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_assignment.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/time_zone_mapping_preview.rb +1 -1
- data/lib/purecloudplatformclientv2/models/transcript_property.rb +254 -0
- data/lib/purecloudplatformclientv2/models/trunk.rb +5 -5
- data/lib/purecloudplatformclientv2/models/trunk_base.rb +1 -1
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trunk_metrics.rb +2 -2
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/twitter_integration.rb +3 -3
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_authorization.rb +28 -1
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_queue.rb +2 -2
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_recording.rb +2 -2
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +1 -1
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +13 -13
- data/lib/purecloudplatformclientv2/models/whats_app_integration.rb +562 -0
- data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/whats_app_integration_update_request.rb +365 -0
- data/lib/purecloudplatformclientv2/models/widget_deployment.rb +1 -1
- data/lib/purecloudplatformclientv2/models/workspace.rb +1 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/workspace_member.rb +2 -2
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +13 -13
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +20 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 73c6a35f3b3d9705c60ef4327e88f82c6bcf1036
|
|
4
|
+
data.tar.gz: e25688a230fae29575eddeed5846bb6b48a50059
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 22683edba29df4bcca451ddf72bff4be2391386f3a051c580968983cb55410fd00e691ea563c1bc4963eb8fbf6f575454d16d1c2979856cdc6477f6adc3028d9
|
|
7
|
+
data.tar.gz: e8d3d0cb7378c3677d316c903c4ef2f90959d46abc6df5488764219d6169d5d4094620b675029aaf799a19ead6428c9993cae7f38110e9cf7374d1d779de472c
|
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', '~> 62.0.0'
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
### Install from Git
|
data/docs/ActionEntityListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: ActionEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -13,9 +13,9 @@ title: AgentActivityEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/AnalyticsApi.md
CHANGED
|
@@ -8,9 +8,12 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
8
8
|
|
|
9
9
|
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
+
[**delete_analytics_conversations_details_job**](AnalyticsApi.html#delete_analytics_conversations_details_job) | Delete/cancel an async request
|
|
11
12
|
[**delete_analytics_reporting_schedule**](AnalyticsApi.html#delete_analytics_reporting_schedule) | Delete a scheduled report job.
|
|
12
13
|
[**get_analytics_conversation_details**](AnalyticsApi.html#get_analytics_conversation_details) | Get a conversation by id
|
|
13
14
|
[**get_analytics_conversations_details**](AnalyticsApi.html#get_analytics_conversations_details) | Gets multiple conversations by id
|
|
15
|
+
[**get_analytics_conversations_details_job**](AnalyticsApi.html#get_analytics_conversations_details_job) | Get status for async query for conversation details
|
|
16
|
+
[**get_analytics_conversations_details_job_results**](AnalyticsApi.html#get_analytics_conversations_details_job_results) | Fetch a page of results for an async query
|
|
14
17
|
[**get_analytics_reporting_exports**](AnalyticsApi.html#get_analytics_reporting_exports) | Get all view export requests for a user
|
|
15
18
|
[**get_analytics_reporting_metadata**](AnalyticsApi.html#get_analytics_reporting_metadata) | Get list of reporting metadata.
|
|
16
19
|
[**get_analytics_reporting_report_id_metadata**](AnalyticsApi.html#get_analytics_reporting_report_id_metadata) | Get a reporting metadata.
|
|
@@ -23,6 +26,7 @@ Method | Description
|
|
|
23
26
|
[**get_analytics_reporting_timeperiods**](AnalyticsApi.html#get_analytics_reporting_timeperiods) | Get a list of report time periods.
|
|
24
27
|
[**post_analytics_conversation_details_properties**](AnalyticsApi.html#post_analytics_conversation_details_properties) | Index conversation properties
|
|
25
28
|
[**post_analytics_conversations_aggregates_query**](AnalyticsApi.html#post_analytics_conversations_aggregates_query) | Query for conversation aggregates
|
|
29
|
+
[**post_analytics_conversations_details_jobs**](AnalyticsApi.html#post_analytics_conversations_details_jobs) | Query for conversation details asynchronously
|
|
26
30
|
[**post_analytics_conversations_details_query**](AnalyticsApi.html#post_analytics_conversations_details_query) | Query for conversation details
|
|
27
31
|
[**post_analytics_evaluations_aggregates_query**](AnalyticsApi.html#post_analytics_evaluations_aggregates_query) | Query for evaluation aggregates
|
|
28
32
|
[**post_analytics_flows_aggregates_query**](AnalyticsApi.html#post_analytics_flows_aggregates_query) | Query for flow aggregates
|
|
@@ -38,6 +42,70 @@ Method | Description
|
|
|
38
42
|
[**put_analytics_reporting_schedule**](AnalyticsApi.html#put_analytics_reporting_schedule) | Update a scheduled report job.
|
|
39
43
|
{: class="table table-striped"}
|
|
40
44
|
|
|
45
|
+
<a name="delete_analytics_conversations_details_job"></a>
|
|
46
|
+
|
|
47
|
+
## delete_analytics_conversations_details_job(job_id)
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
Delete/cancel an async request
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
Wraps DELETE /api/v2/analytics/conversations/details/jobs/{jobId}
|
|
56
|
+
|
|
57
|
+
Requires ANY permissions:
|
|
58
|
+
|
|
59
|
+
* analytics:conversationDetail:view
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
### Example
|
|
63
|
+
```{"language":"ruby"}
|
|
64
|
+
# load the gem
|
|
65
|
+
require 'purecloudplatformclientv2'
|
|
66
|
+
# setup authorization
|
|
67
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
68
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
69
|
+
environment = "mypurecloud.com"
|
|
70
|
+
|
|
71
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
72
|
+
|
|
73
|
+
PureCloud.configure do |config|
|
|
74
|
+
config.access_token = @authToken
|
|
75
|
+
end
|
|
76
|
+
|
|
77
|
+
api_instance = PureCloud::AnalyticsApi.new
|
|
78
|
+
|
|
79
|
+
job_id = "job_id_example" # String | jobId
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
begin
|
|
83
|
+
#Delete/cancel an async request
|
|
84
|
+
api_instance.delete_analytics_conversations_details_job(job_id)
|
|
85
|
+
rescue PureCloud::ApiError => e
|
|
86
|
+
puts "Exception when calling AnalyticsApi->delete_analytics_conversations_details_job: #{e}"
|
|
87
|
+
end
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Parameters
|
|
91
|
+
|
|
92
|
+
Name | Type | Description | Notes
|
|
93
|
+
------------- | ------------- | ------------- | -------------
|
|
94
|
+
**job_id** | **String**| jobId | |
|
|
95
|
+
{: class="table table-striped"}
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
### Return type
|
|
99
|
+
|
|
100
|
+
nil (empty response body)
|
|
101
|
+
|
|
102
|
+
### HTTP request headers
|
|
103
|
+
|
|
104
|
+
- **Content-Type**: application/json
|
|
105
|
+
- **Accept**: application/json
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
41
109
|
<a name="delete_analytics_reporting_schedule"></a>
|
|
42
110
|
|
|
43
111
|
## delete_analytics_reporting_schedule(schedule_id)
|
|
@@ -232,6 +300,140 @@ Name | Type | Description | Notes
|
|
|
232
300
|
|
|
233
301
|
|
|
234
302
|
|
|
303
|
+
<a name="get_analytics_conversations_details_job"></a>
|
|
304
|
+
|
|
305
|
+
## [**AsyncQueryStatus**](AsyncQueryStatus.html) get_analytics_conversations_details_job(job_id)
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
Get status for async query for conversation details
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
Wraps GET /api/v2/analytics/conversations/details/jobs/{jobId}
|
|
314
|
+
|
|
315
|
+
Requires ANY permissions:
|
|
316
|
+
|
|
317
|
+
* analytics:conversationDetail:view
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
### Example
|
|
321
|
+
```{"language":"ruby"}
|
|
322
|
+
# load the gem
|
|
323
|
+
require 'purecloudplatformclientv2'
|
|
324
|
+
# setup authorization
|
|
325
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
326
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
327
|
+
environment = "mypurecloud.com"
|
|
328
|
+
|
|
329
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
330
|
+
|
|
331
|
+
PureCloud.configure do |config|
|
|
332
|
+
config.access_token = @authToken
|
|
333
|
+
end
|
|
334
|
+
|
|
335
|
+
api_instance = PureCloud::AnalyticsApi.new
|
|
336
|
+
|
|
337
|
+
job_id = "job_id_example" # String | jobId
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
begin
|
|
341
|
+
#Get status for async query for conversation details
|
|
342
|
+
result = api_instance.get_analytics_conversations_details_job(job_id)
|
|
343
|
+
p result
|
|
344
|
+
rescue PureCloud::ApiError => e
|
|
345
|
+
puts "Exception when calling AnalyticsApi->get_analytics_conversations_details_job: #{e}"
|
|
346
|
+
end
|
|
347
|
+
```
|
|
348
|
+
|
|
349
|
+
### Parameters
|
|
350
|
+
|
|
351
|
+
Name | Type | Description | Notes
|
|
352
|
+
------------- | ------------- | ------------- | -------------
|
|
353
|
+
**job_id** | **String**| jobId | |
|
|
354
|
+
{: class="table table-striped"}
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
### Return type
|
|
358
|
+
|
|
359
|
+
[**AsyncQueryStatus**](AsyncQueryStatus.html)
|
|
360
|
+
|
|
361
|
+
### HTTP request headers
|
|
362
|
+
|
|
363
|
+
- **Content-Type**: application/json
|
|
364
|
+
- **Accept**: application/json
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<a name="get_analytics_conversations_details_job_results"></a>
|
|
369
|
+
|
|
370
|
+
## [**AnalyticsConversationAsyncQueryResponse**](AnalyticsConversationAsyncQueryResponse.html) get_analytics_conversations_details_job_results(job_id, opts)
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
Fetch a page of results for an async query
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
Wraps GET /api/v2/analytics/conversations/details/jobs/{jobId}/results
|
|
379
|
+
|
|
380
|
+
Requires ANY permissions:
|
|
381
|
+
|
|
382
|
+
* analytics:conversationDetail:view
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
### Example
|
|
386
|
+
```{"language":"ruby"}
|
|
387
|
+
# load the gem
|
|
388
|
+
require 'purecloudplatformclientv2'
|
|
389
|
+
# setup authorization
|
|
390
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
391
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
392
|
+
environment = "mypurecloud.com"
|
|
393
|
+
|
|
394
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
395
|
+
|
|
396
|
+
PureCloud.configure do |config|
|
|
397
|
+
config.access_token = @authToken
|
|
398
|
+
end
|
|
399
|
+
|
|
400
|
+
api_instance = PureCloud::AnalyticsApi.new
|
|
401
|
+
|
|
402
|
+
job_id = "job_id_example" # String | jobId
|
|
403
|
+
|
|
404
|
+
opts = {
|
|
405
|
+
cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page)
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
begin
|
|
409
|
+
#Fetch a page of results for an async query
|
|
410
|
+
result = api_instance.get_analytics_conversations_details_job_results(job_id, opts)
|
|
411
|
+
p result
|
|
412
|
+
rescue PureCloud::ApiError => e
|
|
413
|
+
puts "Exception when calling AnalyticsApi->get_analytics_conversations_details_job_results: #{e}"
|
|
414
|
+
end
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
### Parameters
|
|
418
|
+
|
|
419
|
+
Name | Type | Description | Notes
|
|
420
|
+
------------- | ------------- | ------------- | -------------
|
|
421
|
+
**job_id** | **String**| jobId | |
|
|
422
|
+
**cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional] |
|
|
423
|
+
{: class="table table-striped"}
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
### Return type
|
|
427
|
+
|
|
428
|
+
[**AnalyticsConversationAsyncQueryResponse**](AnalyticsConversationAsyncQueryResponse.html)
|
|
429
|
+
|
|
430
|
+
### HTTP request headers
|
|
431
|
+
|
|
432
|
+
- **Content-Type**: application/json
|
|
433
|
+
- **Accept**: application/json
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
235
437
|
<a name="get_analytics_reporting_exports"></a>
|
|
236
438
|
|
|
237
439
|
## [**ReportingExportJobListing**](ReportingExportJobListing.html) get_analytics_reporting_exports
|
|
@@ -1009,6 +1211,71 @@ Name | Type | Description | Notes
|
|
|
1009
1211
|
|
|
1010
1212
|
|
|
1011
1213
|
|
|
1214
|
+
<a name="post_analytics_conversations_details_jobs"></a>
|
|
1215
|
+
|
|
1216
|
+
## [**AsyncQueryResponse**](AsyncQueryResponse.html) post_analytics_conversations_details_jobs(body)
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
Query for conversation details asynchronously
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
Wraps POST /api/v2/analytics/conversations/details/jobs
|
|
1225
|
+
|
|
1226
|
+
Requires ANY permissions:
|
|
1227
|
+
|
|
1228
|
+
* analytics:conversationDetail:view
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
### Example
|
|
1232
|
+
```{"language":"ruby"}
|
|
1233
|
+
# load the gem
|
|
1234
|
+
require 'purecloudplatformclientv2'
|
|
1235
|
+
# setup authorization
|
|
1236
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
1237
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
1238
|
+
environment = "mypurecloud.com"
|
|
1239
|
+
|
|
1240
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
1241
|
+
|
|
1242
|
+
PureCloud.configure do |config|
|
|
1243
|
+
config.access_token = @authToken
|
|
1244
|
+
end
|
|
1245
|
+
|
|
1246
|
+
api_instance = PureCloud::AnalyticsApi.new
|
|
1247
|
+
|
|
1248
|
+
body = PureCloud::AsyncConversationQuery.new # AsyncConversationQuery | query
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
begin
|
|
1252
|
+
#Query for conversation details asynchronously
|
|
1253
|
+
result = api_instance.post_analytics_conversations_details_jobs(body)
|
|
1254
|
+
p result
|
|
1255
|
+
rescue PureCloud::ApiError => e
|
|
1256
|
+
puts "Exception when calling AnalyticsApi->post_analytics_conversations_details_jobs: #{e}"
|
|
1257
|
+
end
|
|
1258
|
+
```
|
|
1259
|
+
|
|
1260
|
+
### Parameters
|
|
1261
|
+
|
|
1262
|
+
Name | Type | Description | Notes
|
|
1263
|
+
------------- | ------------- | ------------- | -------------
|
|
1264
|
+
**body** | [**AsyncConversationQuery**](AsyncConversationQuery.html)| query | |
|
|
1265
|
+
{: class="table table-striped"}
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
### Return type
|
|
1269
|
+
|
|
1270
|
+
[**AsyncQueryResponse**](AsyncQueryResponse.html)
|
|
1271
|
+
|
|
1272
|
+
### HTTP request headers
|
|
1273
|
+
|
|
1274
|
+
- **Content-Type**: application/json
|
|
1275
|
+
- **Accept**: application/json
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
|
|
1012
1279
|
<a name="post_analytics_conversations_details_query"></a>
|
|
1013
1280
|
|
|
1014
1281
|
## [**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_analytics_conversations_details_query(body)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AnalyticsConversationAsyncQueryResponse
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::AnalyticsConversationAsyncQueryResponse
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **conversations** | [**Array<AnalyticsConversation>**](AnalyticsConversation.html) | | [optional] |
|
|
11
|
+
| **cursor** | **String** | Optional cursor to indicate where to resume the results | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
data/docs/AnalyticsEvaluation.md
CHANGED
|
@@ -16,8 +16,8 @@ title: AnalyticsEvaluation
|
|
|
16
16
|
| **context_id** | **String** | A unique identifier for an evaluation form, regardless of version | [optional] |
|
|
17
17
|
| **form_name** | **String** | Name of the evaluation form | [optional] |
|
|
18
18
|
| **calibration_id** | **String** | The calibration id used for the purpose of training evaluators | [optional] |
|
|
19
|
-
| **o_total_critical_score** | **Integer** | | [optional] |
|
|
20
19
|
| **o_total_score** | **Integer** | | [optional] |
|
|
20
|
+
| **o_total_critical_score** | **Integer** | | [optional] |
|
|
21
21
|
{: class="table table-striped"}
|
|
22
22
|
|
|
23
23
|
|
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
|
-
| **
|
|
15
|
+
| **missing_node** | **BOOLEAN** | | [optional] |
|
|
16
|
+
| **value_node** | **BOOLEAN** | | [optional] |
|
|
17
|
+
| **binary** | **BOOLEAN** | | [optional] |
|
|
18
|
+
| **pojo** | **BOOLEAN** | | [optional] |
|
|
19
|
+
| **container_node** | **BOOLEAN** | | [optional] |
|
|
20
|
+
| **int** | **BOOLEAN** | | [optional] |
|
|
16
21
|
| **integral_number** | **BOOLEAN** | | [optional] |
|
|
17
22
|
| **short** | **BOOLEAN** | | [optional] |
|
|
18
|
-
| **int** | **BOOLEAN** | | [optional] |
|
|
19
23
|
| **long** | **BOOLEAN** | | [optional] |
|
|
24
|
+
| **floating_point_number** | **BOOLEAN** | | [optional] |
|
|
20
25
|
| **double** | **BOOLEAN** | | [optional] |
|
|
21
26
|
| **big_decimal** | **BOOLEAN** | | [optional] |
|
|
22
27
|
| **big_integer** | **BOOLEAN** | | [optional] |
|
|
23
28
|
| **textual** | **BOOLEAN** | | [optional] |
|
|
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"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AsyncQueryResponse
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::AsyncQueryResponse
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **job_id** | **String** | Unique identifier for the async query execution. Can be used to check the status of the query and retrieve results. | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AsyncQueryStatus
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::AsyncQueryStatus
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **state** | **String** | The current state of the asynchronous query | [optional] |
|
|
11
|
+
| **error_message** | **String** | The error associated with the current query, if the state is FAILED | [optional] |
|
|
12
|
+
| **expiration_date** | **DateTime** | The time at which results for this query will expire. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
13
|
+
| **submission_date** | **DateTime** | The time at which the query was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
|
+
| **completion_date** | **DateTime** | The time at which the query completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
{: class="table table-striped"}
|
|
16
|
+
|
|
17
|
+
|
|
@@ -13,9 +13,9 @@ title: AttemptLimitsEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
+
| **previous_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|