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
|
@@ -21,17 +21,17 @@ title: ChatMediaParticipant
|
|
|
21
21
|
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] |
|
|
22
22
|
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] |
|
|
23
23
|
| **wrapup_prompt** | **String** | The wrap-up prompt indicating the type of wrap-up to be performed. | [optional] |
|
|
24
|
-
| **user** | [**
|
|
25
|
-
| **queue** | [**
|
|
24
|
+
| **user** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud user for this participant. | [optional] |
|
|
25
|
+
| **queue** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud queue for this participant. | [optional] |
|
|
26
26
|
| **attributes** | **Hash<String, String>** | A list of ad-hoc attributes for the participant. | [optional] |
|
|
27
27
|
| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
|
|
28
|
-
| **script** | [**
|
|
28
|
+
| **script** | [**DomainEntityRef**](DomainEntityRef.html) | The Engage script that should be used by this participant. | [optional] |
|
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
|
|
30
30
|
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
|
|
31
31
|
| **alerting_timeout_ms** | **Integer** | Specifies how long the agent has to answer an interaction before being marked as not responding. | [optional] |
|
|
32
32
|
| **provider** | **String** | The source provider for the communication. | [optional] |
|
|
33
|
-
| **external_contact** | [**
|
|
34
|
-
| **external_organization** | [**
|
|
33
|
+
| **external_contact** | [**DomainEntityRef**](DomainEntityRef.html) | If this participant represents an external contact, then this will be the reference for the external contact. | [optional] |
|
|
34
|
+
| **external_organization** | [**DomainEntityRef**](DomainEntityRef.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
|
35
35
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Wrapup for this participant, if it has been applied. | [optional] |
|
|
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] |
|
|
@@ -13,9 +13,9 @@ title: ClientAppEntityListing
|
|
|
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: CobrowseConversationEntityListing
|
|
|
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
|
|
|
@@ -21,17 +21,17 @@ title: CobrowseMediaParticipant
|
|
|
21
21
|
| **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] |
|
|
22
22
|
| **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] |
|
|
23
23
|
| **wrapup_prompt** | **String** | The wrap-up prompt indicating the type of wrap-up to be performed. | [optional] |
|
|
24
|
-
| **user** | [**
|
|
25
|
-
| **queue** | [**
|
|
24
|
+
| **user** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud user for this participant. | [optional] |
|
|
25
|
+
| **queue** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud queue for this participant. | [optional] |
|
|
26
26
|
| **attributes** | **Hash<String, String>** | A list of ad-hoc attributes for the participant. | [optional] |
|
|
27
27
|
| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
|
|
28
|
-
| **script** | [**
|
|
28
|
+
| **script** | [**DomainEntityRef**](DomainEntityRef.html) | The Engage script that should be used by this participant. | [optional] |
|
|
29
29
|
| **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
|
|
30
30
|
| **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
|
|
31
31
|
| **alerting_timeout_ms** | **Integer** | Specifies how long the agent has to answer an interaction before being marked as not responding. | [optional] |
|
|
32
32
|
| **provider** | **String** | The source provider for the communication. | [optional] |
|
|
33
|
-
| **external_contact** | [**
|
|
34
|
-
| **external_organization** | [**
|
|
33
|
+
| **external_contact** | [**DomainEntityRef**](DomainEntityRef.html) | If this participant represents an external contact, then this will be the reference for the external contact. | [optional] |
|
|
34
|
+
| **external_organization** | [**DomainEntityRef**](DomainEntityRef.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
|
35
35
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Wrapup for this participant, if it has been applied. | [optional] |
|
|
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] |
|
|
@@ -13,9 +13,9 @@ title: CommandStatusEntityListing
|
|
|
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: ConsumedResourcesEntityListing
|
|
|
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: ConsumingResourcesEntityListing
|
|
|
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/ContactList.md
CHANGED
|
@@ -12,14 +12,14 @@ title: ContactList
|
|
|
12
12
|
| **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
14
|
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
|
15
|
-
| **division** | [**
|
|
15
|
+
| **division** | [**DomainEntityRef**](DomainEntityRef.html) | The division this entity belongs to. | [optional] |
|
|
16
16
|
| **column_names** | **Array<String>** | The names of the contact data columns. | |
|
|
17
17
|
| **phone_columns** | [**Array<ContactPhoneNumberColumn>**](ContactPhoneNumberColumn.html) | Indicates which columns are phone numbers. | |
|
|
18
18
|
| **import_status** | [**ImportStatus**](ImportStatus.html) | The status of the import process. | [optional] |
|
|
19
19
|
| **preview_mode_column_name** | **String** | A column to check if a contact should always be dialed in preview mode. | [optional] |
|
|
20
20
|
| **preview_mode_accepted_values** | **Array<String>** | The values in the previewModeColumnName column that indicate a contact should always be dialed in preview mode. | [optional] |
|
|
21
21
|
| **size** | **Integer** | The number of contacts in the ContactList. | [optional] |
|
|
22
|
-
| **attempt_limits** | [**
|
|
22
|
+
| **attempt_limits** | [**DomainEntityRef**](DomainEntityRef.html) | AttemptLimits for this ContactList. | [optional] |
|
|
23
23
|
| **automatic_time_zone_mapping** | **BOOLEAN** | Indicates if automatic time zone mapping is to be used for this ContactList. | [optional] |
|
|
24
24
|
| **zip_code_column_name** | **String** | The name of contact list column containing the zip code for use with automatic time zone mapping. Only allowed if 'automaticTimeZoneMapping' is set to true. | [optional] |
|
|
25
25
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
@@ -13,9 +13,9 @@ title: ContactListDivisionViewListing
|
|
|
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: ContactListEntityListing
|
|
|
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/ContactListFilter.md
CHANGED
|
@@ -12,7 +12,7 @@ title: ContactListFilter
|
|
|
12
12
|
| **date_created** | **DateTime** | Creation time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
13
13
|
| **date_modified** | **DateTime** | Last modified time of the entity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
14
|
| **version** | **Integer** | Required for updates, must match the version number of the most recent update | [optional] |
|
|
15
|
-
| **contact_list** | [**
|
|
15
|
+
| **contact_list** | [**DomainEntityRef**](DomainEntityRef.html) | The contact list the filter is based on. | |
|
|
16
16
|
| **clauses** | [**Array<ContactListFilterClause>**](ContactListFilterClause.html) | Groups of conditions to filter the contacts by. | [optional] |
|
|
17
17
|
| **filter_type** | **String** | How to join clauses together. | [optional] |
|
|
18
18
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
@@ -13,9 +13,9 @@ title: ContactListFilterEntityListing
|
|
|
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/ContactListing.md
CHANGED
|
@@ -13,9 +13,9 @@ title: ContactListing
|
|
|
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
|
|
|
@@ -7,8 +7,8 @@ title: ConversationDivisionMembership
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **division** | [**
|
|
11
|
-
| **entities** | [**Array<
|
|
10
|
+
| **division** | [**DomainEntityRef**](DomainEntityRef.html) | A division the conversation belongs to. | [optional] |
|
|
11
|
+
| **entities** | [**Array<DomainEntityRef>**](DomainEntityRef.html) | The entities on the conversation within the division. These are the users, queues, work flows, etc. that can be on conversations and and be assigned to different divisions. | [optional] |
|
|
12
12
|
{: class="table table-striped"}
|
|
13
13
|
|
|
14
14
|
|
|
@@ -13,9 +13,9 @@ title: ConversationEntityListing
|
|
|
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/ConversationsApi.md
CHANGED
|
@@ -8,6 +8,7 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
8
8
|
|
|
9
9
|
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
+
[**delete_analytics_conversations_details_job**](ConversationsApi.html#delete_analytics_conversations_details_job) | Delete/cancel an async request
|
|
11
12
|
[**delete_conversation_participant_code**](ConversationsApi.html#delete_conversation_participant_code) | Delete a code used to add a communication to this participant
|
|
12
13
|
[**delete_conversation_participant_flaggedreason**](ConversationsApi.html#delete_conversation_participant_flaggedreason) | Remove flagged reason from conversation participant.
|
|
13
14
|
[**delete_conversations_call_participant_consult**](ConversationsApi.html#delete_conversations_call_participant_consult) | Cancel the transfer
|
|
@@ -17,6 +18,8 @@ Method | Description
|
|
|
17
18
|
[**delete_conversations_messaging_integrations_twitter_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_twitter_integration_id) | Delete a Twitter messaging integration
|
|
18
19
|
[**get_analytics_conversation_details**](ConversationsApi.html#get_analytics_conversation_details) | Get a conversation by id
|
|
19
20
|
[**get_analytics_conversations_details**](ConversationsApi.html#get_analytics_conversations_details) | Gets multiple conversations by id
|
|
21
|
+
[**get_analytics_conversations_details_job**](ConversationsApi.html#get_analytics_conversations_details_job) | Get status for async query for conversation details
|
|
22
|
+
[**get_analytics_conversations_details_job_results**](ConversationsApi.html#get_analytics_conversations_details_job_results) | Fetch a page of results for an async query
|
|
20
23
|
[**get_conversation**](ConversationsApi.html#get_conversation) | Get conversation
|
|
21
24
|
[**get_conversation_participant_secureivrsession**](ConversationsApi.html#get_conversation_participant_secureivrsession) | Fetch info on a secure session
|
|
22
25
|
[**get_conversation_participant_secureivrsessions**](ConversationsApi.html#get_conversation_participant_secureivrsessions) | Get a list of secure sessions for this participant.
|
|
@@ -61,6 +64,8 @@ Method | Description
|
|
|
61
64
|
[**get_conversations_messaging_integrations_line_integration_id**](ConversationsApi.html#get_conversations_messaging_integrations_line_integration_id) | Get a LINE messenger integration
|
|
62
65
|
[**get_conversations_messaging_integrations_twitter**](ConversationsApi.html#get_conversations_messaging_integrations_twitter) | Get a list of Twitter Integrations
|
|
63
66
|
[**get_conversations_messaging_integrations_twitter_integration_id**](ConversationsApi.html#get_conversations_messaging_integrations_twitter_integration_id) | Get a Twitter messaging integration
|
|
67
|
+
[**get_conversations_messaging_integrations_whatsapp**](ConversationsApi.html#get_conversations_messaging_integrations_whatsapp) | Get a list of WhatsApp Integrations
|
|
68
|
+
[**get_conversations_messaging_integrations_whatsapp_integration_id**](ConversationsApi.html#get_conversations_messaging_integrations_whatsapp_integration_id) | Get a WhatsApp messaging integration
|
|
64
69
|
[**get_conversations_messaging_sticker**](ConversationsApi.html#get_conversations_messaging_sticker) | Get a list of Messaging Stickers
|
|
65
70
|
[**patch_conversation_participant**](ConversationsApi.html#patch_conversation_participant) | Update a participant.
|
|
66
71
|
[**patch_conversation_participant_attributes**](ConversationsApi.html#patch_conversation_participant_attributes) | Update the attributes on a conversation participant.
|
|
@@ -89,8 +94,10 @@ Method | Description
|
|
|
89
94
|
[**patch_conversations_message_participant**](ConversationsApi.html#patch_conversations_message_participant) | Update conversation participant
|
|
90
95
|
[**patch_conversations_message_participant_attributes**](ConversationsApi.html#patch_conversations_message_participant_attributes) | Update the attributes on a conversation participant.
|
|
91
96
|
[**patch_conversations_message_participant_communication**](ConversationsApi.html#patch_conversations_message_participant_communication) | Update conversation participant's communication by disconnecting it.
|
|
97
|
+
[**patch_conversations_messaging_integrations_whatsapp_integration_id**](ConversationsApi.html#patch_conversations_messaging_integrations_whatsapp_integration_id) | Activate a WhatsApp messaging integration.
|
|
92
98
|
[**post_analytics_conversation_details_properties**](ConversationsApi.html#post_analytics_conversation_details_properties) | Index conversation properties
|
|
93
99
|
[**post_analytics_conversations_aggregates_query**](ConversationsApi.html#post_analytics_conversations_aggregates_query) | Query for conversation aggregates
|
|
100
|
+
[**post_analytics_conversations_details_jobs**](ConversationsApi.html#post_analytics_conversations_details_jobs) | Query for conversation details asynchronously
|
|
94
101
|
[**post_analytics_conversations_details_query**](ConversationsApi.html#post_analytics_conversations_details_query) | Query for conversation details
|
|
95
102
|
[**post_conversation_disconnect**](ConversationsApi.html#post_conversation_disconnect) | Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resyncronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
|
|
96
103
|
[**post_conversation_participant_callbacks**](ConversationsApi.html#post_conversation_participant_callbacks) | Create a new callback for the specified participant on the conversation.
|
|
@@ -127,6 +134,70 @@ Method | Description
|
|
|
127
134
|
[**put_conversations_messaging_integrations_line_integration_id**](ConversationsApi.html#put_conversations_messaging_integrations_line_integration_id) | Update a LINE messenger integration
|
|
128
135
|
{: class="table table-striped"}
|
|
129
136
|
|
|
137
|
+
<a name="delete_analytics_conversations_details_job"></a>
|
|
138
|
+
|
|
139
|
+
## delete_analytics_conversations_details_job(job_id)
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
Delete/cancel an async request
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
Wraps DELETE /api/v2/analytics/conversations/details/jobs/{jobId}
|
|
148
|
+
|
|
149
|
+
Requires ANY permissions:
|
|
150
|
+
|
|
151
|
+
* analytics:conversationDetail:view
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
### Example
|
|
155
|
+
```{"language":"ruby"}
|
|
156
|
+
# load the gem
|
|
157
|
+
require 'purecloudplatformclientv2'
|
|
158
|
+
# setup authorization
|
|
159
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
160
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
161
|
+
environment = "mypurecloud.com"
|
|
162
|
+
|
|
163
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
164
|
+
|
|
165
|
+
PureCloud.configure do |config|
|
|
166
|
+
config.access_token = @authToken
|
|
167
|
+
end
|
|
168
|
+
|
|
169
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
170
|
+
|
|
171
|
+
job_id = "job_id_example" # String | jobId
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
begin
|
|
175
|
+
#Delete/cancel an async request
|
|
176
|
+
api_instance.delete_analytics_conversations_details_job(job_id)
|
|
177
|
+
rescue PureCloud::ApiError => e
|
|
178
|
+
puts "Exception when calling ConversationsApi->delete_analytics_conversations_details_job: #{e}"
|
|
179
|
+
end
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### Parameters
|
|
183
|
+
|
|
184
|
+
Name | Type | Description | Notes
|
|
185
|
+
------------- | ------------- | ------------- | -------------
|
|
186
|
+
**job_id** | **String**| jobId | |
|
|
187
|
+
{: class="table table-striped"}
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
### Return type
|
|
191
|
+
|
|
192
|
+
nil (empty response body)
|
|
193
|
+
|
|
194
|
+
### HTTP request headers
|
|
195
|
+
|
|
196
|
+
- **Content-Type**: application/json
|
|
197
|
+
- **Accept**: application/json
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
130
201
|
<a name="delete_conversation_participant_code"></a>
|
|
131
202
|
|
|
132
203
|
## delete_conversation_participant_code(conversation_id, participant_id, add_communication_code)
|
|
@@ -717,6 +788,140 @@ Name | Type | Description | Notes
|
|
|
717
788
|
|
|
718
789
|
|
|
719
790
|
|
|
791
|
+
<a name="get_analytics_conversations_details_job"></a>
|
|
792
|
+
|
|
793
|
+
## [**AsyncQueryStatus**](AsyncQueryStatus.html) get_analytics_conversations_details_job(job_id)
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
Get status for async query for conversation details
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
Wraps GET /api/v2/analytics/conversations/details/jobs/{jobId}
|
|
802
|
+
|
|
803
|
+
Requires ANY permissions:
|
|
804
|
+
|
|
805
|
+
* analytics:conversationDetail:view
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
### Example
|
|
809
|
+
```{"language":"ruby"}
|
|
810
|
+
# load the gem
|
|
811
|
+
require 'purecloudplatformclientv2'
|
|
812
|
+
# setup authorization
|
|
813
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
814
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
815
|
+
environment = "mypurecloud.com"
|
|
816
|
+
|
|
817
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
818
|
+
|
|
819
|
+
PureCloud.configure do |config|
|
|
820
|
+
config.access_token = @authToken
|
|
821
|
+
end
|
|
822
|
+
|
|
823
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
824
|
+
|
|
825
|
+
job_id = "job_id_example" # String | jobId
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
begin
|
|
829
|
+
#Get status for async query for conversation details
|
|
830
|
+
result = api_instance.get_analytics_conversations_details_job(job_id)
|
|
831
|
+
p result
|
|
832
|
+
rescue PureCloud::ApiError => e
|
|
833
|
+
puts "Exception when calling ConversationsApi->get_analytics_conversations_details_job: #{e}"
|
|
834
|
+
end
|
|
835
|
+
```
|
|
836
|
+
|
|
837
|
+
### Parameters
|
|
838
|
+
|
|
839
|
+
Name | Type | Description | Notes
|
|
840
|
+
------------- | ------------- | ------------- | -------------
|
|
841
|
+
**job_id** | **String**| jobId | |
|
|
842
|
+
{: class="table table-striped"}
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
### Return type
|
|
846
|
+
|
|
847
|
+
[**AsyncQueryStatus**](AsyncQueryStatus.html)
|
|
848
|
+
|
|
849
|
+
### HTTP request headers
|
|
850
|
+
|
|
851
|
+
- **Content-Type**: application/json
|
|
852
|
+
- **Accept**: application/json
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
<a name="get_analytics_conversations_details_job_results"></a>
|
|
857
|
+
|
|
858
|
+
## [**AnalyticsConversationAsyncQueryResponse**](AnalyticsConversationAsyncQueryResponse.html) get_analytics_conversations_details_job_results(job_id, opts)
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
Fetch a page of results for an async query
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
Wraps GET /api/v2/analytics/conversations/details/jobs/{jobId}/results
|
|
867
|
+
|
|
868
|
+
Requires ANY permissions:
|
|
869
|
+
|
|
870
|
+
* analytics:conversationDetail:view
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
### Example
|
|
874
|
+
```{"language":"ruby"}
|
|
875
|
+
# load the gem
|
|
876
|
+
require 'purecloudplatformclientv2'
|
|
877
|
+
# setup authorization
|
|
878
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
879
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
880
|
+
environment = "mypurecloud.com"
|
|
881
|
+
|
|
882
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
883
|
+
|
|
884
|
+
PureCloud.configure do |config|
|
|
885
|
+
config.access_token = @authToken
|
|
886
|
+
end
|
|
887
|
+
|
|
888
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
889
|
+
|
|
890
|
+
job_id = "job_id_example" # String | jobId
|
|
891
|
+
|
|
892
|
+
opts = {
|
|
893
|
+
cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page)
|
|
894
|
+
}
|
|
895
|
+
|
|
896
|
+
begin
|
|
897
|
+
#Fetch a page of results for an async query
|
|
898
|
+
result = api_instance.get_analytics_conversations_details_job_results(job_id, opts)
|
|
899
|
+
p result
|
|
900
|
+
rescue PureCloud::ApiError => e
|
|
901
|
+
puts "Exception when calling ConversationsApi->get_analytics_conversations_details_job_results: #{e}"
|
|
902
|
+
end
|
|
903
|
+
```
|
|
904
|
+
|
|
905
|
+
### Parameters
|
|
906
|
+
|
|
907
|
+
Name | Type | Description | Notes
|
|
908
|
+
------------- | ------------- | ------------- | -------------
|
|
909
|
+
**job_id** | **String**| jobId | |
|
|
910
|
+
**cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional] |
|
|
911
|
+
{: class="table table-striped"}
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
### Return type
|
|
915
|
+
|
|
916
|
+
[**AnalyticsConversationAsyncQueryResponse**](AnalyticsConversationAsyncQueryResponse.html)
|
|
917
|
+
|
|
918
|
+
### HTTP request headers
|
|
919
|
+
|
|
920
|
+
- **Content-Type**: application/json
|
|
921
|
+
- **Accept**: application/json
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
|
|
720
925
|
<a name="get_conversation"></a>
|
|
721
926
|
|
|
722
927
|
## [**Conversation**](Conversation.html) get_conversation(conversation_id)
|
|
@@ -3612,6 +3817,139 @@ Name | Type | Description | Notes
|
|
|
3612
3817
|
|
|
3613
3818
|
|
|
3614
3819
|
|
|
3820
|
+
<a name="get_conversations_messaging_integrations_whatsapp"></a>
|
|
3821
|
+
|
|
3822
|
+
## [**WhatsAppIntegrationEntityListing**](WhatsAppIntegrationEntityListing.html) get_conversations_messaging_integrations_whatsapp(opts)
|
|
3823
|
+
|
|
3824
|
+
|
|
3825
|
+
|
|
3826
|
+
Get a list of WhatsApp Integrations
|
|
3827
|
+
|
|
3828
|
+
|
|
3829
|
+
|
|
3830
|
+
Wraps GET /api/v2/conversations/messaging/integrations/whatsapp
|
|
3831
|
+
|
|
3832
|
+
Requires ANY permissions:
|
|
3833
|
+
|
|
3834
|
+
* messaging:integration:view
|
|
3835
|
+
|
|
3836
|
+
|
|
3837
|
+
### Example
|
|
3838
|
+
```{"language":"ruby"}
|
|
3839
|
+
# load the gem
|
|
3840
|
+
require 'purecloudplatformclientv2'
|
|
3841
|
+
# setup authorization
|
|
3842
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3843
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3844
|
+
environment = "mypurecloud.com"
|
|
3845
|
+
|
|
3846
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3847
|
+
|
|
3848
|
+
PureCloud.configure do |config|
|
|
3849
|
+
config.access_token = @authToken
|
|
3850
|
+
end
|
|
3851
|
+
|
|
3852
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3853
|
+
|
|
3854
|
+
opts = {
|
|
3855
|
+
page_size: 25, # Integer | Page size
|
|
3856
|
+
page_number: 1 # Integer | Page number
|
|
3857
|
+
}
|
|
3858
|
+
|
|
3859
|
+
begin
|
|
3860
|
+
#Get a list of WhatsApp Integrations
|
|
3861
|
+
result = api_instance.get_conversations_messaging_integrations_whatsapp(opts)
|
|
3862
|
+
p result
|
|
3863
|
+
rescue PureCloud::ApiError => e
|
|
3864
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_whatsapp: #{e}"
|
|
3865
|
+
end
|
|
3866
|
+
```
|
|
3867
|
+
|
|
3868
|
+
### Parameters
|
|
3869
|
+
|
|
3870
|
+
Name | Type | Description | Notes
|
|
3871
|
+
------------- | ------------- | ------------- | -------------
|
|
3872
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
3873
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
3874
|
+
{: class="table table-striped"}
|
|
3875
|
+
|
|
3876
|
+
|
|
3877
|
+
### Return type
|
|
3878
|
+
|
|
3879
|
+
[**WhatsAppIntegrationEntityListing**](WhatsAppIntegrationEntityListing.html)
|
|
3880
|
+
|
|
3881
|
+
### HTTP request headers
|
|
3882
|
+
|
|
3883
|
+
- **Content-Type**: application/json
|
|
3884
|
+
- **Accept**: application/json
|
|
3885
|
+
|
|
3886
|
+
|
|
3887
|
+
|
|
3888
|
+
<a name="get_conversations_messaging_integrations_whatsapp_integration_id"></a>
|
|
3889
|
+
|
|
3890
|
+
## [**WhatsAppIntegration**](WhatsAppIntegration.html) get_conversations_messaging_integrations_whatsapp_integration_id(integration_id)
|
|
3891
|
+
|
|
3892
|
+
|
|
3893
|
+
|
|
3894
|
+
Get a WhatsApp messaging integration
|
|
3895
|
+
|
|
3896
|
+
|
|
3897
|
+
|
|
3898
|
+
Wraps GET /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}
|
|
3899
|
+
|
|
3900
|
+
Requires ANY permissions:
|
|
3901
|
+
|
|
3902
|
+
* messaging:integration:view
|
|
3903
|
+
|
|
3904
|
+
|
|
3905
|
+
### Example
|
|
3906
|
+
```{"language":"ruby"}
|
|
3907
|
+
# load the gem
|
|
3908
|
+
require 'purecloudplatformclientv2'
|
|
3909
|
+
# setup authorization
|
|
3910
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
3911
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
3912
|
+
environment = "mypurecloud.com"
|
|
3913
|
+
|
|
3914
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
3915
|
+
|
|
3916
|
+
PureCloud.configure do |config|
|
|
3917
|
+
config.access_token = @authToken
|
|
3918
|
+
end
|
|
3919
|
+
|
|
3920
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
3921
|
+
|
|
3922
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
3923
|
+
|
|
3924
|
+
|
|
3925
|
+
begin
|
|
3926
|
+
#Get a WhatsApp messaging integration
|
|
3927
|
+
result = api_instance.get_conversations_messaging_integrations_whatsapp_integration_id(integration_id)
|
|
3928
|
+
p result
|
|
3929
|
+
rescue PureCloud::ApiError => e
|
|
3930
|
+
puts "Exception when calling ConversationsApi->get_conversations_messaging_integrations_whatsapp_integration_id: #{e}"
|
|
3931
|
+
end
|
|
3932
|
+
```
|
|
3933
|
+
|
|
3934
|
+
### Parameters
|
|
3935
|
+
|
|
3936
|
+
Name | Type | Description | Notes
|
|
3937
|
+
------------- | ------------- | ------------- | -------------
|
|
3938
|
+
**integration_id** | **String**| Integration ID | |
|
|
3939
|
+
{: class="table table-striped"}
|
|
3940
|
+
|
|
3941
|
+
|
|
3942
|
+
### Return type
|
|
3943
|
+
|
|
3944
|
+
[**WhatsAppIntegration**](WhatsAppIntegration.html)
|
|
3945
|
+
|
|
3946
|
+
### HTTP request headers
|
|
3947
|
+
|
|
3948
|
+
- **Content-Type**: application/json
|
|
3949
|
+
- **Accept**: application/json
|
|
3950
|
+
|
|
3951
|
+
|
|
3952
|
+
|
|
3615
3953
|
<a name="get_conversations_messaging_sticker"></a>
|
|
3616
3954
|
|
|
3617
3955
|
## [**MessagingStickerEntityListing**](MessagingStickerEntityListing.html) get_conversations_messaging_sticker(messenger_type, opts)
|
|
@@ -5569,6 +5907,74 @@ Name | Type | Description | Notes
|
|
|
5569
5907
|
|
|
5570
5908
|
|
|
5571
5909
|
|
|
5910
|
+
<a name="patch_conversations_messaging_integrations_whatsapp_integration_id"></a>
|
|
5911
|
+
|
|
5912
|
+
## [**WhatsAppIntegration**](WhatsAppIntegration.html) patch_conversations_messaging_integrations_whatsapp_integration_id(integration_id, body)
|
|
5913
|
+
|
|
5914
|
+
|
|
5915
|
+
|
|
5916
|
+
Activate a WhatsApp messaging integration.
|
|
5917
|
+
|
|
5918
|
+
The following steps are required in order to fully activate a Whatsapp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
|
|
5919
|
+
|
|
5920
|
+
Wraps PATCH /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}
|
|
5921
|
+
|
|
5922
|
+
Requires ANY permissions:
|
|
5923
|
+
|
|
5924
|
+
* messaging:integration:edit
|
|
5925
|
+
|
|
5926
|
+
|
|
5927
|
+
### Example
|
|
5928
|
+
```{"language":"ruby"}
|
|
5929
|
+
# load the gem
|
|
5930
|
+
require 'purecloudplatformclientv2'
|
|
5931
|
+
# setup authorization
|
|
5932
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
5933
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
5934
|
+
environment = "mypurecloud.com"
|
|
5935
|
+
|
|
5936
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
5937
|
+
|
|
5938
|
+
PureCloud.configure do |config|
|
|
5939
|
+
config.access_token = @authToken
|
|
5940
|
+
end
|
|
5941
|
+
|
|
5942
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
5943
|
+
|
|
5944
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
5945
|
+
|
|
5946
|
+
body = PureCloud::WhatsAppIntegrationUpdateRequest.new # WhatsAppIntegrationUpdateRequest | WhatsAppIntegrationUpdateRequest
|
|
5947
|
+
|
|
5948
|
+
|
|
5949
|
+
begin
|
|
5950
|
+
#Activate a WhatsApp messaging integration.
|
|
5951
|
+
result = api_instance.patch_conversations_messaging_integrations_whatsapp_integration_id(integration_id, body)
|
|
5952
|
+
p result
|
|
5953
|
+
rescue PureCloud::ApiError => e
|
|
5954
|
+
puts "Exception when calling ConversationsApi->patch_conversations_messaging_integrations_whatsapp_integration_id: #{e}"
|
|
5955
|
+
end
|
|
5956
|
+
```
|
|
5957
|
+
|
|
5958
|
+
### Parameters
|
|
5959
|
+
|
|
5960
|
+
Name | Type | Description | Notes
|
|
5961
|
+
------------- | ------------- | ------------- | -------------
|
|
5962
|
+
**integration_id** | **String**| Integration ID | |
|
|
5963
|
+
**body** | [**WhatsAppIntegrationUpdateRequest**](WhatsAppIntegrationUpdateRequest.html)| WhatsAppIntegrationUpdateRequest | |
|
|
5964
|
+
{: class="table table-striped"}
|
|
5965
|
+
|
|
5966
|
+
|
|
5967
|
+
### Return type
|
|
5968
|
+
|
|
5969
|
+
[**WhatsAppIntegration**](WhatsAppIntegration.html)
|
|
5970
|
+
|
|
5971
|
+
### HTTP request headers
|
|
5972
|
+
|
|
5973
|
+
- **Content-Type**: application/json
|
|
5974
|
+
- **Accept**: application/json
|
|
5975
|
+
|
|
5976
|
+
|
|
5977
|
+
|
|
5572
5978
|
<a name="post_analytics_conversation_details_properties"></a>
|
|
5573
5979
|
|
|
5574
5980
|
## [**PropertyIndexRequest**](PropertyIndexRequest.html) post_analytics_conversation_details_properties(conversation_id, body)
|
|
@@ -5702,6 +6108,71 @@ Name | Type | Description | Notes
|
|
|
5702
6108
|
|
|
5703
6109
|
|
|
5704
6110
|
|
|
6111
|
+
<a name="post_analytics_conversations_details_jobs"></a>
|
|
6112
|
+
|
|
6113
|
+
## [**AsyncQueryResponse**](AsyncQueryResponse.html) post_analytics_conversations_details_jobs(body)
|
|
6114
|
+
|
|
6115
|
+
|
|
6116
|
+
|
|
6117
|
+
Query for conversation details asynchronously
|
|
6118
|
+
|
|
6119
|
+
|
|
6120
|
+
|
|
6121
|
+
Wraps POST /api/v2/analytics/conversations/details/jobs
|
|
6122
|
+
|
|
6123
|
+
Requires ANY permissions:
|
|
6124
|
+
|
|
6125
|
+
* analytics:conversationDetail:view
|
|
6126
|
+
|
|
6127
|
+
|
|
6128
|
+
### Example
|
|
6129
|
+
```{"language":"ruby"}
|
|
6130
|
+
# load the gem
|
|
6131
|
+
require 'purecloudplatformclientv2'
|
|
6132
|
+
# setup authorization
|
|
6133
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
6134
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
6135
|
+
environment = "mypurecloud.com"
|
|
6136
|
+
|
|
6137
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
6138
|
+
|
|
6139
|
+
PureCloud.configure do |config|
|
|
6140
|
+
config.access_token = @authToken
|
|
6141
|
+
end
|
|
6142
|
+
|
|
6143
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
6144
|
+
|
|
6145
|
+
body = PureCloud::AsyncConversationQuery.new # AsyncConversationQuery | query
|
|
6146
|
+
|
|
6147
|
+
|
|
6148
|
+
begin
|
|
6149
|
+
#Query for conversation details asynchronously
|
|
6150
|
+
result = api_instance.post_analytics_conversations_details_jobs(body)
|
|
6151
|
+
p result
|
|
6152
|
+
rescue PureCloud::ApiError => e
|
|
6153
|
+
puts "Exception when calling ConversationsApi->post_analytics_conversations_details_jobs: #{e}"
|
|
6154
|
+
end
|
|
6155
|
+
```
|
|
6156
|
+
|
|
6157
|
+
### Parameters
|
|
6158
|
+
|
|
6159
|
+
Name | Type | Description | Notes
|
|
6160
|
+
------------- | ------------- | ------------- | -------------
|
|
6161
|
+
**body** | [**AsyncConversationQuery**](AsyncConversationQuery.html)| query | |
|
|
6162
|
+
{: class="table table-striped"}
|
|
6163
|
+
|
|
6164
|
+
|
|
6165
|
+
### Return type
|
|
6166
|
+
|
|
6167
|
+
[**AsyncQueryResponse**](AsyncQueryResponse.html)
|
|
6168
|
+
|
|
6169
|
+
### HTTP request headers
|
|
6170
|
+
|
|
6171
|
+
- **Content-Type**: application/json
|
|
6172
|
+
- **Accept**: application/json
|
|
6173
|
+
|
|
6174
|
+
|
|
6175
|
+
|
|
5705
6176
|
<a name="post_analytics_conversations_details_query"></a>
|
|
5706
6177
|
|
|
5707
6178
|
## [**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_analytics_conversations_details_query(body)
|