purecloudplatformclientv2 66.0.0 → 71.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 +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsSession.md +1 -0
- data/docs/ArchitectApi.md +21 -17
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +140 -0
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/BuSearchAgentSchedulesRequest.md +15 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +2 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackMediaParticipant.md +2 -0
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ChatMediaParticipant.md +2 -0
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseMediaParticipant.md +2 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactCenterSettings.md +13 -0
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationAggregationQuery.md +1 -0
- data/docs/ConversationCallEventTopicCallConversation.md +1 -0
- data/docs/ConversationCallEventTopicCallMediaParticipant.md +2 -0
- data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +2 -0
- data/docs/ConversationChatEventTopicChatMediaParticipant.md +2 -0
- data/docs/ConversationCobrowseEventTopicCobrowseMediaParticipant.md +2 -0
- data/docs/ConversationDeletionProtectionQuery.md +13 -0
- data/docs/ConversationEmailEventTopicEmailMediaParticipant.md +2 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicParticipant.md +2 -0
- data/docs/ConversationMessageEventTopicMessageMediaParticipant.md +2 -0
- data/docs/ConversationScreenShareEventTopicScreenShareMediaParticipant.md +2 -0
- data/docs/ConversationSocialExpressionEventTopicSocialMediaParticipant.md +2 -0
- data/docs/ConversationVideoEventTopicVideoMediaParticipant.md +2 -0
- data/docs/ConversationsApi.md +198 -0
- data/docs/CreateManagementUnitApiRequest.md +1 -1
- data/docs/{CreateManagementUnitSettings.md → CreateManagementUnitSettingsRequest.md} +3 -3
- data/docs/CreateWorkPlan.md +1 -0
- data/docs/CreateWorkPlanShift.md +1 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DialerResponsesetConfigChangeResponseSet.md +1 -0
- data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListDivisionViewListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/DomainLogicalInterface.md +4 -0
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMediaParticipant.md +2 -0
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowAggregationQuery.md +1 -0
- data/docs/FlowDivisionView.md +2 -0
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowOutcomeListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationType.md +1 -0
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationAddressVerificationDetails.md +16 -0
- data/docs/LocationCreateDefinition.md +20 -0
- data/docs/LocationDefinition.md +12 -9
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationUpdateDefinition.md +20 -0
- data/docs/LocationsApi.md +6 -6
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnit.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/{UserExternalIdentifier.md → ManagementUnitReference.md} +3 -4
- data/docs/{ManagementUnitSettings.md → ManagementUnitSettingsRequest.md} +3 -3
- data/docs/ManagementUnitSettingsResponse.md +18 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessageEvaluation.md +16 -0
- data/docs/MessageMediaParticipant.md +2 -0
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationsApi.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/Participant.md +2 -0
- data/docs/ParticipantBasic.md +2 -0
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PlanningPeriodSettings.md +14 -0
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +51 -23
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueConversationCallEventTopicCallConversation.md +1 -0
- data/docs/QueueConversationCallEventTopicCallMediaParticipant.md +2 -0
- data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +2 -0
- data/docs/QueueConversationChatEventTopicChatMediaParticipant.md +2 -0
- data/docs/QueueConversationCobrowseEventTopicCobrowseMediaParticipant.md +2 -0
- data/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md +2 -0
- data/docs/QueueConversationEventTopicParticipant.md +2 -0
- data/docs/QueueConversationMessageEventTopicMessageMediaParticipant.md +2 -0
- data/docs/QueueConversationScreenShareEventTopicScreenShareMediaParticipant.md +2 -0
- data/docs/QueueConversationSocialExpressionEventTopicParticipant.md +2 -0
- data/docs/QueueConversationVideoEventTopicParticipant.md +2 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/QueueUserEventTopicQueueMember.md +4 -4
- data/docs/QueueUserEventTopicUserReference.md +13 -0
- data/docs/RecipientListing.md +1 -1
- data/docs/Recording.md +1 -0
- data/docs/RecordingApi.md +164 -14
- data/docs/RecordingJobEntityListing.md +1 -1
- data/docs/RecordingJobsQuery.md +1 -1
- data/docs/RecordingMetadata.md +1 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ReportingExportJobRequest.md +2 -0
- data/docs/ReportingExportJobResponse.md +2 -0
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoleDivisionGrants.md +13 -0
- data/docs/RoleDivisionPair.md +14 -0
- data/docs/RoutingApi.md +250 -2
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +302 -26
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/{SchedulingSettings.md → SchedulingSettingsRequest.md} +2 -2
- data/docs/SchedulingSettingsResponse.md +15 -0
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimConfigResourceType.md +1 -1
- data/docs/ScimConfigResourceTypeSchemaExtension.md +1 -1
- data/docs/ScimError.md +4 -4
- data/docs/ScimServiceProviderConfig.md +7 -7
- data/docs/ScimServiceProviderConfigAuthenticationScheme.md +1 -1
- data/docs/ScimV2CreateUser.md +1 -1
- data/docs/ScimV2Group.md +3 -2
- data/docs/ScimV2User.md +2 -2
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SearchApi.md +3 -3
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/SelectedColumns.md +14 -0
- data/docs/SendAgentlessOutboundMessageRequest.md +16 -0
- data/docs/SendAgentlessOutboundMessageResponse.md +21 -0
- data/docs/ShareEntityListing.md +1 -1
- data/docs/ShiftTradeSettings.md +1 -0
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsAddressEntityListing.md +1 -1
- data/docs/SmsPhoneNumber.md +1 -0
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/StationsApi.md +1 -2
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SubscriptionOverviewUsage.md +2 -0
- data/docs/SuggestApi.md +2 -2
- data/docs/SurveyAggregationQuery.md +1 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeOffRequestLookup.md +13 -0
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TranscriptionSettings.md +14 -0
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TtsEngineEntityListing.md +1 -1
- data/docs/TtsVoiceEntityListing.md +1 -1
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UpdateManagementUnitRequest.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserAggregationQuery.md +1 -0
- data/docs/UserDetailsQuery.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +101 -306
- data/docs/ValueWrapperPlanningPeriodSettings.md +13 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmForecastModificationIntervalOffsetValue.md +1 -1
- data/docs/WhatsAppIntegrationEntityListing.md +1 -1
- data/docs/WhatsAppIntegrationRequest.md +17 -0
- data/docs/WorkPlan.md +1 -0
- data/docs/WorkPlanListItemResponse.md +1 -0
- data/docs/WorkPlanReference.md +3 -1
- data/docs/WorkPlanShift.md +1 -0
- data/docs/WorkforceManagementApi.md +80 -9
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +23 -5
- data/lib/purecloudplatformclientv2/api/architect_api.rb +24 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +195 -0
- data/lib/purecloudplatformclientv2/api/notifications_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/quality_api.rb +4 -4
- data/lib/purecloudplatformclientv2/api/recording_api.rb +138 -2
- data/lib/purecloudplatformclientv2/api/routing_api.rb +239 -9
- data/lib/purecloudplatformclientv2/api/scim_api.rb +364 -20
- data/lib/purecloudplatformclientv2/api/users_api.rb +127 -353
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +81 -8
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +30 -4
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/bu_search_agent_schedules_request.rb +266 -0
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_center_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_conversation.rb +29 -4
- data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_chat_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_cobrowse_event_topic_cobrowse_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_deletion_protection_query.rb +209 -0
- data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_email_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_message_event_topic_message_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_screen_share_event_topic_screen_share_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_social_expression_event_topic_social_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_video_event_topic_video_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/{create_management_unit_settings.rb → create_management_unit_settings_request.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/create_work_plan.rb +27 -1
- data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +27 -1
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_responseset_config_change_response_set.rb +26 -1
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_logical_interface.rb +105 -1
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/event_log.rb +2 -2
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +55 -3
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type.rb +29 -1
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_address_verification_details.rb +294 -0
- data/lib/purecloudplatformclientv2/models/location_create_definition.rb +405 -0
- data/lib/purecloudplatformclientv2/models/location_definition.rb +110 -34
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{location_create_update_definition.rb → location_update_definition.rb} +48 -63
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit.rb +1 -1
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{user_external_identifier.rb → management_unit_reference.rb} +10 -46
- data/lib/purecloudplatformclientv2/models/{management_unit_settings.rb → management_unit_settings_request.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/management_unit_settings_response.rb +337 -0
- data/lib/purecloudplatformclientv2/models/manager.rb +1 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_evaluation.rb +277 -0
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +53 -1
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/participant.rb +56 -4
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +56 -4
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/photo.rb +1 -1
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/planning_period_settings.rb +238 -0
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_call_conversation.rb +29 -4
- data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_call_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_chat_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_cobrowse_event_topic_cobrowse_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_email_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_message_event_topic_message_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_screen_share_event_topic_screen_share_media_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_participant.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_user_event_topic_queue_member.rb +31 -31
- data/lib/purecloudplatformclientv2/models/queue_user_event_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording.rb +27 -1
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/recording_metadata.rb +27 -1
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +58 -4
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +55 -1
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/role_division_grants.rb +209 -0
- data/lib/purecloudplatformclientv2/models/role_division_pair.rb +238 -0
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{scheduling_settings.rb → scheduling_settings_request.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/scheduling_settings_response.rb +255 -0
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_email.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_error.rb +5 -5
- data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +8 -8
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +2 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +34 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +3 -2
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/selected_columns.rb +228 -0
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_request.rb +314 -0
- data/lib/purecloudplatformclientv2/models/send_agentless_outbound_message_response.rb +424 -0
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/shift_trade_settings.rb +27 -1
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +29 -1
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subscription_overview_usage.rb +56 -4
- data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +357 -1
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/transcription_settings.rb +252 -0
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustee_billing_overview.rb +2 -2
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/update_management_unit_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/user_details_query.rb +32 -31
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/value_wrapper_planning_period_settings.rb +203 -0
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_forecast_modification_interval_offset_value.rb +1 -1
- data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_topic_wfm_move_agent_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/whats_app_integration_request.rb +321 -0
- data/lib/purecloudplatformclientv2/models/work_plan.rb +27 -1
- data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/work_plan_reference.rb +57 -9
- data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +27 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +48 -12
- data/docs/LocationCreateUpdateDefinition.md +0 -21
|
@@ -14,8 +14,8 @@ title: CampaignDivisionViewListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CampaignEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CampaignRuleEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CampaignSequenceEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CertificateAuthorityEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: ChatConversationEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -37,6 +37,8 @@ title: ChatMediaParticipant
|
|
|
37
37
|
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
38
38
|
| **journey_context** | [**JourneyContext**](JourneyContext.html) | Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. | [optional] |
|
|
39
39
|
| **conversation_routing_data** | [**ConversationRoutingData**](ConversationRoutingData.html) | Information on how a communication should be routed to an agent. | [optional] |
|
|
40
|
+
| **start_acw_time** | **DateTime** | The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
41
|
+
| **end_acw_time** | **DateTime** | The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
40
42
|
| **room_id** | **String** | The ID of the chat room. | [optional] |
|
|
41
43
|
| **avatar_image_url** | **String** | If available, the URI to the avatar image of this communication. | [optional] |
|
|
42
44
|
{: class="table table-striped"}
|
|
@@ -14,8 +14,8 @@ title: ClientAppEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CobrowseConversationEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -37,6 +37,8 @@ title: CobrowseMediaParticipant
|
|
|
37
37
|
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
38
38
|
| **journey_context** | [**JourneyContext**](JourneyContext.html) | Journey System data/context that is applicable to this communication. When used for historical purposes, the context should be immutable. When null, there is no applicable Journey System context. | [optional] |
|
|
39
39
|
| **conversation_routing_data** | [**ConversationRoutingData**](ConversationRoutingData.html) | Information on how a communication should be routed to an agent. | [optional] |
|
|
40
|
+
| **start_acw_time** | **DateTime** | The timestamp when this participant started after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
41
|
+
| **end_acw_time** | **DateTime** | The timestamp when this participant ended after-call work. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
40
42
|
| **cobrowse_session_id** | **String** | The co-browse session ID. | [optional] |
|
|
41
43
|
| **cobrowse_role** | **String** | This value identifies the role of the co-browse client within the co-browse session (a client is a sharer or a viewer). | [optional] |
|
|
42
44
|
| **controlling** | **Array<String>** | ID of co-browse participants for which this client has been granted control (list is empty if this client cannot control any shared pages). | [optional] |
|
|
@@ -14,8 +14,8 @@ title: CommandStatusEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: ConsumedResourcesEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: ConsumingResourcesEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ContactCenterSettings
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ContactCenterSettings
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **remove_skills_from_blind_transfer** | **BOOLEAN** | Strip skills from transfer | [optional] |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -14,8 +14,8 @@ title: ContactListDivisionViewListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: ContactListEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: ContactListFilterEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/ContactListing.md
CHANGED
|
@@ -14,8 +14,8 @@ title: ContactListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -15,6 +15,7 @@ title: ConversationAggregationQuery
|
|
|
15
15
|
| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
|
|
16
16
|
| **flatten_multivalued_dimensions** | **BOOLEAN** | Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') | [optional] |
|
|
17
17
|
| **views** | [**Array<ConversationAggregationView>**](ConversationAggregationView.html) | Custom derived metric views | [optional] |
|
|
18
|
+
| **alternate_time_dimension** | **String** | Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event. | [optional] |
|
|
18
19
|
{: class="table table-striped"}
|
|
19
20
|
|
|
20
21
|
|
|
@@ -12,6 +12,7 @@ title: ConversationCallEventTopicCallConversation
|
|
|
12
12
|
| **participants** | [**Array<ConversationCallEventTopicCallMediaParticipant>**](ConversationCallEventTopicCallMediaParticipant.html) | | [optional] |
|
|
13
13
|
| **other_media_uris** | **Array<String>** | | [optional] |
|
|
14
14
|
| **recording_state** | **String** | | [optional] |
|
|
15
|
+
| **max_participants** | **Integer** | | [optional] |
|
|
15
16
|
{: class="table table-striped"}
|
|
16
17
|
|
|
17
18
|
|
|
@@ -38,6 +38,8 @@ title: ConversationCallEventTopicCallMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**ConversationCallEventTopicJourneyContext**](ConversationCallEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **muted** | **BOOLEAN** | | [optional] |
|
|
42
44
|
| **confined** | **BOOLEAN** | | [optional] |
|
|
43
45
|
| **recording** | **BOOLEAN** | | [optional] |
|
|
@@ -38,6 +38,8 @@ title: ConversationCallbackEventTopicCallbackMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**ConversationCallbackEventTopicJourneyContext**](ConversationCallbackEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **outbound_preview** | [**ConversationCallbackEventTopicDialerPreview**](ConversationCallbackEventTopicDialerPreview.html) | | [optional] |
|
|
42
44
|
| **voicemail** | [**ConversationCallbackEventTopicVoicemail**](ConversationCallbackEventTopicVoicemail.html) | | [optional] |
|
|
43
45
|
| **callback_numbers** | **Array<String>** | | [optional] |
|
|
@@ -38,6 +38,8 @@ title: ConversationChatEventTopicChatMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**ConversationChatEventTopicJourneyContext**](ConversationChatEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **room_id** | **String** | | [optional] |
|
|
42
44
|
| **avatar_image_url** | **String** | | [optional] |
|
|
43
45
|
{: class="table table-striped"}
|
|
@@ -38,6 +38,8 @@ title: ConversationCobrowseEventTopicCobrowseMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**ConversationCobrowseEventTopicJourneyContext**](ConversationCobrowseEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **cobrowse_session_id** | **String** | | [optional] |
|
|
42
44
|
| **cobrowse_role** | **String** | | [optional] |
|
|
43
45
|
| **viewer_url** | **String** | | [optional] |
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationDeletionProtectionQuery
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationDeletionProtectionQuery
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **conversation_ids** | **Array<String>** | list of ConversationIds | |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -38,6 +38,8 @@ title: ConversationEmailEventTopicEmailMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**ConversationEmailEventTopicJourneyContext**](ConversationEmailEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **subject** | **String** | | [optional] |
|
|
42
44
|
| **messages_sent** | **Integer** | | [optional] |
|
|
43
45
|
| **auto_generated** | **BOOLEAN** | | [optional] |
|
|
@@ -14,8 +14,8 @@ title: ConversationEntityListing
|
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
16
|
| **next_uri** | **String** | | [optional] |
|
|
17
|
-
| **previous_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -24,6 +24,8 @@ title: ConversationEventTopicParticipant
|
|
|
24
24
|
| **wrapup_prompt** | **String** | | [optional] |
|
|
25
25
|
| **wrapup_timeout_ms** | **Integer** | | [optional] |
|
|
26
26
|
| **wrapup** | [**ConversationEventTopicWrapup**](ConversationEventTopicWrapup.html) | | [optional] |
|
|
27
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
28
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
27
29
|
| **conversation_routing_data** | [**ConversationEventTopicConversationRoutingData**](ConversationEventTopicConversationRoutingData.html) | | [optional] |
|
|
28
30
|
| **alerting_timeout_ms** | **Integer** | | [optional] |
|
|
29
31
|
| **monitored_participant_id** | **String** | | [optional] |
|
|
@@ -38,6 +38,8 @@ title: ConversationMessageEventTopicMessageMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**ConversationMessageEventTopicJourneyContext**](ConversationMessageEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **messages** | [**Array<ConversationMessageEventTopicMessageDetails>**](ConversationMessageEventTopicMessageDetails.html) | | [optional] |
|
|
42
44
|
| **type** | **String** | | [optional] |
|
|
43
45
|
| **recipient_country** | **String** | | [optional] |
|
|
@@ -38,6 +38,8 @@ title: ConversationScreenShareEventTopicScreenShareMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**ConversationScreenShareEventTopicJourneyContext**](ConversationScreenShareEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **context** | **String** | | [optional] |
|
|
42
44
|
| **peer_count** | **Integer** | | [optional] |
|
|
43
45
|
| **sharing** | **BOOLEAN** | | [optional] |
|
|
@@ -38,6 +38,8 @@ title: ConversationSocialExpressionEventTopicSocialMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**ConversationSocialExpressionEventTopicJourneyContext**](ConversationSocialExpressionEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **social_media_id** | **String** | | [optional] |
|
|
42
44
|
| **social_media_hub** | **String** | | [optional] |
|
|
43
45
|
| **social_user_name** | **String** | | [optional] |
|
|
@@ -38,6 +38,8 @@ title: ConversationVideoEventTopicVideoMediaParticipant
|
|
|
38
38
|
| **screen_recording_state** | **String** | | [optional] |
|
|
39
39
|
| **flagged_reason** | **String** | | [optional] |
|
|
40
40
|
| **journey_context** | [**ConversationVideoEventTopicJourneyContext**](ConversationVideoEventTopicJourneyContext.html) | | [optional] |
|
|
41
|
+
| **start_acw_time** | **DateTime** | | [optional] |
|
|
42
|
+
| **end_acw_time** | **DateTime** | | [optional] |
|
|
41
43
|
| **audio_muted** | **BOOLEAN** | | [optional] |
|
|
42
44
|
| **video_muted** | **BOOLEAN** | | [optional] |
|
|
43
45
|
| **sharing_screen** | **BOOLEAN** | | [optional] |
|
data/docs/ConversationsApi.md
CHANGED
|
@@ -16,6 +16,7 @@ Method | Description
|
|
|
16
16
|
[**delete_conversations_messaging_integrations_facebook_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_facebook_integration_id) | Delete a Facebook messaging integration
|
|
17
17
|
[**delete_conversations_messaging_integrations_line_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_line_integration_id) | Delete a LINE messenger integration
|
|
18
18
|
[**delete_conversations_messaging_integrations_twitter_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_twitter_integration_id) | Delete a Twitter messaging integration
|
|
19
|
+
[**delete_conversations_messaging_integrations_whatsapp_integration_id**](ConversationsApi.html#delete_conversations_messaging_integrations_whatsapp_integration_id) | Delete a WhatsApp messaging integration
|
|
19
20
|
[**get_analytics_conversation_details**](ConversationsApi.html#get_analytics_conversation_details) | Get a conversation by id
|
|
20
21
|
[**get_analytics_conversations_details**](ConversationsApi.html#get_analytics_conversations_details) | Gets multiple conversations by id
|
|
21
22
|
[**get_analytics_conversations_details_job**](ConversationsApi.html#get_analytics_conversations_details_job) | Get status for async query for conversation details
|
|
@@ -129,9 +130,11 @@ Method | Description
|
|
|
129
130
|
[**post_conversations_message_messages_bulk**](ConversationsApi.html#post_conversations_message_messages_bulk) | Get messages in batch
|
|
130
131
|
[**post_conversations_message_participant_replace**](ConversationsApi.html#post_conversations_message_participant_replace) | Replace this participant with the specified user and/or address
|
|
131
132
|
[**post_conversations_messages**](ConversationsApi.html#post_conversations_messages) | Create an outbound messaging conversation.
|
|
133
|
+
[**post_conversations_messages_agentless**](ConversationsApi.html#post_conversations_messages_agentless) | Send an agentless outbound message
|
|
132
134
|
[**post_conversations_messaging_integrations_facebook**](ConversationsApi.html#post_conversations_messaging_integrations_facebook) | Create a Facebook Integration
|
|
133
135
|
[**post_conversations_messaging_integrations_line**](ConversationsApi.html#post_conversations_messaging_integrations_line) | Create a LINE messenger Integration
|
|
134
136
|
[**post_conversations_messaging_integrations_twitter**](ConversationsApi.html#post_conversations_messaging_integrations_twitter) | Create a Twitter Integration
|
|
137
|
+
[**post_conversations_messaging_integrations_whatsapp**](ConversationsApi.html#post_conversations_messaging_integrations_whatsapp) | Create a WhatsApp Integration
|
|
135
138
|
[**put_conversation_participant_flaggedreason**](ConversationsApi.html#put_conversation_participant_flaggedreason) | Set flagged reason on conversation participant to indicate bad conversation quality.
|
|
136
139
|
[**put_conversations_call_participant_communication_uuidata**](ConversationsApi.html#put_conversations_call_participant_communication_uuidata) | Set uuiData to be sent on future commands.
|
|
137
140
|
[**put_conversations_email_messages_draft**](ConversationsApi.html#put_conversations_email_messages_draft) | Update conversation draft reply
|
|
@@ -661,6 +664,71 @@ nil (empty response body)
|
|
|
661
664
|
|
|
662
665
|
|
|
663
666
|
|
|
667
|
+
<a name="delete_conversations_messaging_integrations_whatsapp_integration_id"></a>
|
|
668
|
+
|
|
669
|
+
## [**WhatsAppIntegration**](WhatsAppIntegration.html) delete_conversations_messaging_integrations_whatsapp_integration_id(integration_id)
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
Delete a WhatsApp messaging integration
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
Wraps DELETE /api/v2/conversations/messaging/integrations/whatsapp/{integrationId}
|
|
678
|
+
|
|
679
|
+
Requires ANY permissions:
|
|
680
|
+
|
|
681
|
+
* messaging:integration:delete
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
### Example
|
|
685
|
+
```{"language":"ruby"}
|
|
686
|
+
# load the gem
|
|
687
|
+
require 'purecloudplatformclientv2'
|
|
688
|
+
# setup authorization
|
|
689
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
690
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
691
|
+
environment = "mypurecloud.com"
|
|
692
|
+
|
|
693
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
694
|
+
|
|
695
|
+
PureCloud.configure do |config|
|
|
696
|
+
config.access_token = @authToken
|
|
697
|
+
end
|
|
698
|
+
|
|
699
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
700
|
+
|
|
701
|
+
integration_id = "integration_id_example" # String | Integration ID
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
begin
|
|
705
|
+
#Delete a WhatsApp messaging integration
|
|
706
|
+
result = api_instance.delete_conversations_messaging_integrations_whatsapp_integration_id(integration_id)
|
|
707
|
+
p result
|
|
708
|
+
rescue PureCloud::ApiError => e
|
|
709
|
+
puts "Exception when calling ConversationsApi->delete_conversations_messaging_integrations_whatsapp_integration_id: #{e}"
|
|
710
|
+
end
|
|
711
|
+
```
|
|
712
|
+
|
|
713
|
+
### Parameters
|
|
714
|
+
|
|
715
|
+
Name | Type | Description | Notes
|
|
716
|
+
------------- | ------------- | ------------- | -------------
|
|
717
|
+
**integration_id** | **String**| Integration ID | |
|
|
718
|
+
{: class="table table-striped"}
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
### Return type
|
|
722
|
+
|
|
723
|
+
[**WhatsAppIntegration**](WhatsAppIntegration.html)
|
|
724
|
+
|
|
725
|
+
### HTTP request headers
|
|
726
|
+
|
|
727
|
+
- **Content-Type**: application/json
|
|
728
|
+
- **Accept**: application/json
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
664
732
|
<a name="get_analytics_conversation_details"></a>
|
|
665
733
|
|
|
666
734
|
## [**AnalyticsConversation**](AnalyticsConversation.html) get_analytics_conversation_details(conversation_id)
|
|
@@ -8283,6 +8351,71 @@ Name | Type | Description | Notes
|
|
|
8283
8351
|
|
|
8284
8352
|
|
|
8285
8353
|
|
|
8354
|
+
<a name="post_conversations_messages_agentless"></a>
|
|
8355
|
+
|
|
8356
|
+
## [**SendAgentlessOutboundMessageResponse**](SendAgentlessOutboundMessageResponse.html) post_conversations_messages_agentless(body)
|
|
8357
|
+
|
|
8358
|
+
|
|
8359
|
+
|
|
8360
|
+
Send an agentless outbound message
|
|
8361
|
+
|
|
8362
|
+
Send an agentlesss (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.
|
|
8363
|
+
|
|
8364
|
+
Wraps POST /api/v2/conversations/messages/agentless
|
|
8365
|
+
|
|
8366
|
+
Requires ANY permissions:
|
|
8367
|
+
|
|
8368
|
+
* conversation:message:create
|
|
8369
|
+
|
|
8370
|
+
|
|
8371
|
+
### Example
|
|
8372
|
+
```{"language":"ruby"}
|
|
8373
|
+
# load the gem
|
|
8374
|
+
require 'purecloudplatformclientv2'
|
|
8375
|
+
# setup authorization
|
|
8376
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
8377
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
8378
|
+
environment = "mypurecloud.com"
|
|
8379
|
+
|
|
8380
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
8381
|
+
|
|
8382
|
+
PureCloud.configure do |config|
|
|
8383
|
+
config.access_token = @authToken
|
|
8384
|
+
end
|
|
8385
|
+
|
|
8386
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
8387
|
+
|
|
8388
|
+
body = PureCloud::SendAgentlessOutboundMessageRequest.new # SendAgentlessOutboundMessageRequest | Create agentless outbound messaging request
|
|
8389
|
+
|
|
8390
|
+
|
|
8391
|
+
begin
|
|
8392
|
+
#Send an agentless outbound message
|
|
8393
|
+
result = api_instance.post_conversations_messages_agentless(body)
|
|
8394
|
+
p result
|
|
8395
|
+
rescue PureCloud::ApiError => e
|
|
8396
|
+
puts "Exception when calling ConversationsApi->post_conversations_messages_agentless: #{e}"
|
|
8397
|
+
end
|
|
8398
|
+
```
|
|
8399
|
+
|
|
8400
|
+
### Parameters
|
|
8401
|
+
|
|
8402
|
+
Name | Type | Description | Notes
|
|
8403
|
+
------------- | ------------- | ------------- | -------------
|
|
8404
|
+
**body** | [**SendAgentlessOutboundMessageRequest**](SendAgentlessOutboundMessageRequest.html)| Create agentless outbound messaging request | |
|
|
8405
|
+
{: class="table table-striped"}
|
|
8406
|
+
|
|
8407
|
+
|
|
8408
|
+
### Return type
|
|
8409
|
+
|
|
8410
|
+
[**SendAgentlessOutboundMessageResponse**](SendAgentlessOutboundMessageResponse.html)
|
|
8411
|
+
|
|
8412
|
+
### HTTP request headers
|
|
8413
|
+
|
|
8414
|
+
- **Content-Type**: application/json
|
|
8415
|
+
- **Accept**: application/json
|
|
8416
|
+
|
|
8417
|
+
|
|
8418
|
+
|
|
8286
8419
|
<a name="post_conversations_messaging_integrations_facebook"></a>
|
|
8287
8420
|
|
|
8288
8421
|
## [**FacebookIntegration**](FacebookIntegration.html) post_conversations_messaging_integrations_facebook(body)
|
|
@@ -8478,6 +8611,71 @@ Name | Type | Description | Notes
|
|
|
8478
8611
|
|
|
8479
8612
|
|
|
8480
8613
|
|
|
8614
|
+
<a name="post_conversations_messaging_integrations_whatsapp"></a>
|
|
8615
|
+
|
|
8616
|
+
## [**WhatsAppIntegration**](WhatsAppIntegration.html) post_conversations_messaging_integrations_whatsapp(body)
|
|
8617
|
+
|
|
8618
|
+
|
|
8619
|
+
|
|
8620
|
+
Create a WhatsApp Integration
|
|
8621
|
+
|
|
8622
|
+
|
|
8623
|
+
|
|
8624
|
+
Wraps POST /api/v2/conversations/messaging/integrations/whatsapp
|
|
8625
|
+
|
|
8626
|
+
Requires ANY permissions:
|
|
8627
|
+
|
|
8628
|
+
* messaging:whatsappIntegration:add
|
|
8629
|
+
|
|
8630
|
+
|
|
8631
|
+
### Example
|
|
8632
|
+
```{"language":"ruby"}
|
|
8633
|
+
# load the gem
|
|
8634
|
+
require 'purecloudplatformclientv2'
|
|
8635
|
+
# setup authorization
|
|
8636
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
8637
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
8638
|
+
environment = "mypurecloud.com"
|
|
8639
|
+
|
|
8640
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
8641
|
+
|
|
8642
|
+
PureCloud.configure do |config|
|
|
8643
|
+
config.access_token = @authToken
|
|
8644
|
+
end
|
|
8645
|
+
|
|
8646
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
8647
|
+
|
|
8648
|
+
body = PureCloud::WhatsAppIntegrationRequest.new # WhatsAppIntegrationRequest | WhatsAppIntegrationRequest
|
|
8649
|
+
|
|
8650
|
+
|
|
8651
|
+
begin
|
|
8652
|
+
#Create a WhatsApp Integration
|
|
8653
|
+
result = api_instance.post_conversations_messaging_integrations_whatsapp(body)
|
|
8654
|
+
p result
|
|
8655
|
+
rescue PureCloud::ApiError => e
|
|
8656
|
+
puts "Exception when calling ConversationsApi->post_conversations_messaging_integrations_whatsapp: #{e}"
|
|
8657
|
+
end
|
|
8658
|
+
```
|
|
8659
|
+
|
|
8660
|
+
### Parameters
|
|
8661
|
+
|
|
8662
|
+
Name | Type | Description | Notes
|
|
8663
|
+
------------- | ------------- | ------------- | -------------
|
|
8664
|
+
**body** | [**WhatsAppIntegrationRequest**](WhatsAppIntegrationRequest.html)| WhatsAppIntegrationRequest | |
|
|
8665
|
+
{: class="table table-striped"}
|
|
8666
|
+
|
|
8667
|
+
|
|
8668
|
+
### Return type
|
|
8669
|
+
|
|
8670
|
+
[**WhatsAppIntegration**](WhatsAppIntegration.html)
|
|
8671
|
+
|
|
8672
|
+
### HTTP request headers
|
|
8673
|
+
|
|
8674
|
+
- **Content-Type**: application/json
|
|
8675
|
+
- **Accept**: application/json
|
|
8676
|
+
|
|
8677
|
+
|
|
8678
|
+
|
|
8481
8679
|
<a name="put_conversation_participant_flaggedreason"></a>
|
|
8482
8680
|
|
|
8483
8681
|
## put_conversation_participant_flaggedreason(conversation_id, participant_id)
|