purecloudplatformclientv2 30.1.0 → 31.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/ADFS.md +1 -1
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AppFoundryApi.md +229 -0
- data/docs/AppFoundryListing.md +36 -0
- data/docs/AppFoundryListingCategory.md +14 -0
- data/docs/AppFoundryListingRegistryInfo.md +14 -0
- data/docs/ArchitectApi.md +14 -14
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +0 -120
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallConversationNotificationCallMediaParticipant.md +1 -0
- data/docs/CallConversationNotificationParticipants.md +1 -0
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallMediaParticipant.md +1 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CallbackConversationNotificationCallbackMediaParticipant.md +1 -0
- data/docs/CallbackConversationNotificationParticipants.md +1 -0
- data/docs/CallbackMediaParticipant.md +1 -0
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/CertificateDetails.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ChatConversationNotificationChatMediaParticipant.md +1 -0
- data/docs/ChatConversationNotificationParticipants.md +1 -0
- data/docs/ChatMediaParticipant.md +1 -0
- data/docs/ClientApp.md +21 -0
- data/docs/ClientAppConfigurationInfo.md +14 -0
- data/docs/ClientAppEntityListing.md +22 -0
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CobrowseConversationNotificationCobrowseMediaParticipant.md +1 -0
- data/docs/CobrowseConversationNotificationParticipants.md +1 -0
- data/docs/CobrowseMediaParticipant.md +1 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationNotificationParticipant.md +1 -0
- data/docs/ConversationNotificationParticipants.md +1 -0
- data/docs/ConversationNotificationVideo.md +1 -0
- data/docs/ConversationNotificationVideos.md +1 -0
- data/docs/CreateCallRequest.md +2 -0
- data/docs/CreateIntegrationRequest.md +16 -0
- data/docs/Credential.md +17 -0
- data/docs/CredentialInfo.md +18 -0
- data/docs/CredentialInfoListing.md +22 -0
- data/docs/CredentialSpecification.md +15 -0
- data/docs/CredentialType.md +17 -0
- data/docs/CredentialTypeListing.md +22 -0
- data/docs/CustomerInteractionCenter.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataExportNotificationNotification.md +22 -0
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EffectiveConfiguration.md +17 -0
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailConversationNotificationEmailMediaParticipant.md +1 -0
- data/docs/EmailConversationNotificationParticipants.md +1 -0
- data/docs/EmailMediaParticipant.md +1 -0
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/EventEntity.md +14 -0
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GSuite.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityNow.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/Integration.md +21 -0
- data/docs/IntegrationConfiguration.md +20 -0
- data/docs/IntegrationConfigurationInfo.md +13 -0
- data/docs/IntegrationEntityListing.md +22 -0
- data/docs/IntegrationEvent.md +23 -0
- data/docs/IntegrationEventEntityListing.md +22 -0
- data/docs/IntegrationStatusInfo.md +16 -0
- data/docs/IntegrationType.md +26 -0
- data/docs/IntegrationTypeEntityListing.md +22 -0
- data/docs/IntegrationsApi.md +1457 -175
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/IntradayDataUpdateNotification.md +2 -2
- data/docs/IntradayDataUpdateNotificationDateTime.md +16 -0
- data/docs/IntradayDataUpdateNotificationStartDate.md +16 -0
- data/docs/JsonNode.md +3 -3
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LocalizedField.md +12 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MarketingInfo.md +14 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessageConversationNotificationMessageMediaParticipant.md +1 -0
- data/docs/MessageConversationNotificationParticipants.md +1 -0
- data/docs/MessageInfo.md +16 -0
- data/docs/MessageMediaParticipant.md +1 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/Okta.md +1 -1
- data/docs/OneLogin.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/PagedListingEntity.md +17 -0
- data/docs/Participant.md +1 -0
- data/docs/ParticipantBasic.md +1 -0
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PingIdentity.md +1 -1
- data/docs/Platform.md +14 -0
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PricingOption.md +14 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RegionTimeZone.md +16 -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 +1 -1
- data/docs/ReportingExportJobResponse.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/Salesforce.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScreenShareConversationNotificationParticipants.md +1 -0
- data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md +1 -0
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmartCase.md +14 -0
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/SocialConversationNotificationParticipants.md +1 -0
- data/docs/SocialConversationNotificationSocialMediaParticipant.md +1 -0
- data/docs/StationEntityListing.md +1 -1
- 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/{WfmMoveAgentsCompleteNotificationUser.md → TimeOffRequestUpdateNotificationUserReference.md} +2 -2
- data/docs/TimeZone.md +4 -4
- data/docs/TimeZoneEntityListing.md +2 -2
- 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/UserActionCategory.md +15 -0
- data/docs/UserActionCategoryEntityListing.md +22 -0
- 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/UserScheduleAdherence.md +2 -1
- data/docs/UserScheduleAdherenceUpdateNotification.md +2 -1
- data/docs/UserScheduleAdherenceUpdateNotificationDateTime.md +16 -0
- data/docs/{TimeOffRequestUpdateNotificationUser.md → UserScheduleAdherenceUpdateNotificationUserReference.md} +2 -2
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/VendorConnectionRequest.md +15 -0
- data/docs/VideoConversationNotificationParticipants.md +2 -0
- data/docs/VideoConversationNotificationVideoMediaParticipant.md +2 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WfmMoveAgentsCompleteNotificationResults.md +1 -1
- data/docs/{UserScheduleAdherenceUpdateNotificationUser.md → WfmMoveAgentsCompleteNotificationUserReference.md} +2 -2
- data/docs/WfmMoveAgentsCompleteNotificationWfmMoveAgentData.md +1 -1
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +43 -6
- data/lib/purecloudplatformclientv2/api/app_foundry_api.rb +360 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +0 -145
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +1926 -321
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/app_foundry_listing.rb +815 -0
- data/lib/purecloudplatformclientv2/models/app_foundry_listing_category.rb +231 -0
- data/lib/purecloudplatformclientv2/models/app_foundry_listing_registry_info.rb +231 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +12 -12
- 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_conversation_notification_call_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +41 -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_conversation_notification_callback_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +41 -1
- 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/certificate_details.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_chat_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +41 -1
- data/lib/purecloudplatformclientv2/models/client_app.rb +432 -0
- data/lib/purecloudplatformclientv2/models/client_app_configuration_info.rb +229 -0
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +41 -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_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_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_notification_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_video.rb +28 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_videos.rb +28 -1
- data/lib/purecloudplatformclientv2/models/create_call_request.rb +53 -1
- data/lib/purecloudplatformclientv2/models/create_integration_request.rb +291 -0
- data/lib/purecloudplatformclientv2/models/credential.rb +311 -0
- data/lib/purecloudplatformclientv2/models/credential_info.rb +331 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/credential_specification.rb +257 -0
- data/lib/purecloudplatformclientv2/models/credential_type.rb +309 -0
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_export_notification_notification.rb +482 -0
- 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/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_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_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_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +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/effective_configuration.rb +338 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +41 -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/endpoint_entity_listing.rb +12 -12
- 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_entity.rb +228 -0
- 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/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/g_suite.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/identity_now.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.rb +432 -0
- data/lib/purecloudplatformclientv2/models/integration_configuration.rb +417 -0
- data/lib/purecloudplatformclientv2/models/integration_configuration_info.rb +203 -0
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/integration_event.rb +481 -0
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{data_column.rb → integration_status_info.rb} +79 -36
- data/lib/purecloudplatformclientv2/models/integration_type.rb +551 -0
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +428 -0
- 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/intraday_data_update_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_date_time.rb +276 -0
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_group.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_data_groupings.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_intraday_metric.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_metrics.rb +2 -2
- data/lib/purecloudplatformclientv2/models/intraday_data_update_notification_start_date.rb +276 -0
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/json_node.rb +66 -66
- 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/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/localized_field.rb +177 -0
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/marketing_info.rb +229 -0
- data/lib/purecloudplatformclientv2/models/message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_message_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/message_info.rb +278 -0
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +43 -3
- 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/okta.rb +12 -12
- data/lib/purecloudplatformclientv2/models/one_login.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/paged_listing_entity.rb +303 -0
- data/lib/purecloudplatformclientv2/models/participant.rb +44 -4
- data/lib/purecloudplatformclientv2/models/participant_basic.rb +44 -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/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
- data/lib/purecloudplatformclientv2/models/platform.rb +236 -0
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/pricing_option.rb +234 -0
- 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_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{authz_typed_object.rb → region_time_zone.rb} +58 -32
- 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_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +35 -37
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +32 -34
- 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/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/salesforce.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/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_screen_share_media_participant.rb +40 -1
- 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/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/smart_case.rb +229 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_social_media_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- 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/{user_schedule_adherence_update_notification_user.rb → time_off_request_update_notification_user_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -26
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +13 -13
- 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/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_action_category.rb +253 -0
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +428 -0
- 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_schedule_adherence.rb +28 -2
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification.rb +43 -4
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence_update_notification_date_time.rb +276 -0
- data/lib/purecloudplatformclientv2/models/{wfm_move_agents_complete_notification_user.rb → user_schedule_adherence_update_notification_user_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/vendor_connection_request.rb +269 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_participants.rb +70 -4
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_video_media_participant.rb +70 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_calculations_complete_notice_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification_results.rb +1 -1
- data/lib/purecloudplatformclientv2/models/{time_off_request_update_notification_user.rb → wfm_move_agents_complete_notification_user_reference.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/wfm_move_agents_complete_notification_wfm_move_agent_data.rb +1 -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 +88 -14
- data/docs/AuthzTypedObject.md +0 -14
- data/docs/DataColumn.md +0 -14
- data/docs/ObjectsApi.md +0 -132
- data/lib/purecloudplatformclientv2/api/objects_api.rb +0 -172
data/docs/AuthorizationApi.md
CHANGED
|
@@ -10,7 +10,6 @@ Method | Description
|
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
11
|
[**delete_authorization_role**](AuthorizationApi.html#delete_authorization_role) | Delete an organization role.
|
|
12
12
|
[**delete_user_roles**](AuthorizationApi.html#delete_user_roles) | Removes all the roles from the user.
|
|
13
|
-
[**get_authorization_divisions_limit**](AuthorizationApi.html#get_authorization_divisions_limit) | Returns the maximum allowed number of divisions.
|
|
14
13
|
[**get_authorization_permissions**](AuthorizationApi.html#get_authorization_permissions) | Get all permissions.
|
|
15
14
|
[**get_authorization_products**](AuthorizationApi.html#get_authorization_products) | Get the list of enabled products
|
|
16
15
|
[**get_authorization_role**](AuthorizationApi.html#get_authorization_role) | Get a single organization role.
|
|
@@ -18,7 +17,6 @@ Method | Description
|
|
|
18
17
|
[**get_authorization_roles**](AuthorizationApi.html#get_authorization_roles) | Retrieve a list of all roles defined for the organization
|
|
19
18
|
[**get_user_roles**](AuthorizationApi.html#get_user_roles) | Returns a listing of roles and permissions for a user.
|
|
20
19
|
[**patch_authorization_role**](AuthorizationApi.html#patch_authorization_role) | Patch Organization Role for needsUpdate Field
|
|
21
|
-
[**post_authorization_division_object**](AuthorizationApi.html#post_authorization_division_object) | Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
|
|
22
20
|
[**post_authorization_role_comparedefault_right_role_id**](AuthorizationApi.html#post_authorization_role_comparedefault_right_role_id) | Get an unsaved org role to default role comparison
|
|
23
21
|
[**post_authorization_roles**](AuthorizationApi.html#post_authorization_roles) | Create an organization role.
|
|
24
22
|
[**post_authorization_roles_default**](AuthorizationApi.html#post_authorization_roles_default) | Restores all default roles
|
|
@@ -145,59 +143,6 @@ nil (empty response body)
|
|
|
145
143
|
|
|
146
144
|
|
|
147
145
|
|
|
148
|
-
<a name="get_authorization_divisions_limit"></a>
|
|
149
|
-
|
|
150
|
-
## -Integer** get_authorization_divisions_limit
|
|
151
|
-
|
|
152
|
-
Returns the maximum allowed number of divisions.
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
Wraps GET /api/v2/authorization/divisions/limit
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
### Example
|
|
160
|
-
~~~ruby
|
|
161
|
-
# load the gem
|
|
162
|
-
require 'purecloudplatformclientv2'
|
|
163
|
-
# setup authorization
|
|
164
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
165
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
166
|
-
environment = "mypurecloud.com"
|
|
167
|
-
|
|
168
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
169
|
-
|
|
170
|
-
PureCloud.configure do |config|
|
|
171
|
-
config.access_token = @authToken
|
|
172
|
-
end
|
|
173
|
-
|
|
174
|
-
api_instance = PureCloud::AuthorizationApi.new
|
|
175
|
-
|
|
176
|
-
begin
|
|
177
|
-
#Returns the maximum allowed number of divisions.
|
|
178
|
-
result = api_instance.get_authorization_divisions_limit
|
|
179
|
-
p result
|
|
180
|
-
rescue PureCloud::ApiError => e
|
|
181
|
-
puts "Exception when calling AuthorizationApi->get_authorization_divisions_limit: #{e}"
|
|
182
|
-
end
|
|
183
|
-
~~~
|
|
184
|
-
|
|
185
|
-
### Parameters
|
|
186
|
-
This endpoint does not need any parameter.
|
|
187
|
-
{: class="table table-striped"}
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
### Return type
|
|
191
|
-
|
|
192
|
-
**Integer**
|
|
193
|
-
|
|
194
|
-
### HTTP request headers
|
|
195
|
-
|
|
196
|
-
- **Content-Type**: application/json
|
|
197
|
-
- **Accept**: application/json
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
146
|
<a name="get_authorization_permissions"></a>
|
|
202
147
|
|
|
203
148
|
## -[**PermissionCollectionEntityListing**](PermissionCollectionEntityListing.html) get_authorization_permissions(opts)
|
|
@@ -635,71 +580,6 @@ Name | Type | Description | Notes
|
|
|
635
580
|
|
|
636
581
|
|
|
637
582
|
|
|
638
|
-
<a name="post_authorization_division_object"></a>
|
|
639
|
-
|
|
640
|
-
## -[**Array<AuthzTypedObject>**](AuthzTypedObject.html) post_authorization_division_object(division_id, object_type, body)
|
|
641
|
-
|
|
642
|
-
Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
Wraps POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType}
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
### Example
|
|
650
|
-
~~~ruby
|
|
651
|
-
# load the gem
|
|
652
|
-
require 'purecloudplatformclientv2'
|
|
653
|
-
# setup authorization
|
|
654
|
-
@secret = ENV['PURECLOUD_SECRET']
|
|
655
|
-
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
656
|
-
environment = "mypurecloud.com"
|
|
657
|
-
|
|
658
|
-
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
659
|
-
|
|
660
|
-
PureCloud.configure do |config|
|
|
661
|
-
config.access_token = @authToken
|
|
662
|
-
end
|
|
663
|
-
|
|
664
|
-
api_instance = PureCloud::AuthorizationApi.new
|
|
665
|
-
|
|
666
|
-
division_id = "division_id_example" # String | Division ID
|
|
667
|
-
|
|
668
|
-
object_type = "object_type_example" # String | The type of the objects. Must be one of the valid object types
|
|
669
|
-
|
|
670
|
-
body = [PureCloud::Array<String>.new] # Array<String> | Object Id List
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
begin
|
|
674
|
-
#Set the division of a list of objects. The objects must all be of the same type: CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, QUEUE, USER
|
|
675
|
-
result = api_instance.post_authorization_division_object(division_id, object_type, body)
|
|
676
|
-
p result
|
|
677
|
-
rescue PureCloud::ApiError => e
|
|
678
|
-
puts "Exception when calling AuthorizationApi->post_authorization_division_object: #{e}"
|
|
679
|
-
end
|
|
680
|
-
~~~
|
|
681
|
-
|
|
682
|
-
### Parameters
|
|
683
|
-
|
|
684
|
-
Name | Type | Description | Notes
|
|
685
|
-
------------- | ------------- | ------------- | -------------
|
|
686
|
-
**division_id** | **String**| Division ID | |
|
|
687
|
-
**object_type** | **String**| The type of the objects. Must be one of the valid object types | <br />**Values**: QUEUE, CAMPAIGN, CONTACTLIST, DNCLIST, MANAGEMENTUNIT, FLOW, USER |
|
|
688
|
-
**body** | **Array<String>**| Object Id List | |
|
|
689
|
-
{: class="table table-striped"}
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
### Return type
|
|
693
|
-
|
|
694
|
-
[**Array<AuthzTypedObject>**](AuthzTypedObject.html)
|
|
695
|
-
|
|
696
|
-
### HTTP request headers
|
|
697
|
-
|
|
698
|
-
- **Content-Type**: application/json
|
|
699
|
-
- **Accept**: application/json
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
583
|
<a name="post_authorization_role_comparedefault_right_role_id"></a>
|
|
704
584
|
|
|
705
585
|
## -[**DomainOrgRoleDifference**](DomainOrgRoleDifference.html) post_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, body)
|
|
@@ -14,8 +14,8 @@ title: CalibrationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CallConversationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -34,6 +34,7 @@ title: CallConversationNotificationCallMediaParticipant
|
|
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
35
35
|
| **peer** | **String** | | [optional] |
|
|
36
36
|
| **screen_recording_state** | **String** | | [optional] |
|
|
37
|
+
| **flagged_reason** | **String** | | [optional] |
|
|
37
38
|
| **muted** | **BOOLEAN** | | [optional] |
|
|
38
39
|
| **confined** | **BOOLEAN** | | [optional] |
|
|
39
40
|
| **recording** | **BOOLEAN** | | [optional] |
|
|
@@ -34,6 +34,7 @@ title: CallConversationNotificationParticipants
|
|
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
35
35
|
| **peer** | **String** | | [optional] |
|
|
36
36
|
| **screen_recording_state** | **String** | | [optional] |
|
|
37
|
+
| **flagged_reason** | **String** | | [optional] |
|
|
37
38
|
| **muted** | **BOOLEAN** | | [optional] |
|
|
38
39
|
| **confined** | **BOOLEAN** | | [optional] |
|
|
39
40
|
| **recording** | **BOOLEAN** | | [optional] |
|
|
@@ -14,8 +14,8 @@ title: CallHistoryConversationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -33,6 +33,7 @@ title: CallMediaParticipant
|
|
|
33
33
|
| **external_organization** | [**UriReference**](UriReference.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
|
34
34
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Wrapup for this participant, if it has been applied. | [optional] |
|
|
35
35
|
| **peer** | **String** | The peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
36
|
+
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
36
37
|
| **muted** | **BOOLEAN** | Value is true when the call is muted. | [optional] |
|
|
37
38
|
| **confined** | **BOOLEAN** | Value is true when the call is confined. | [optional] |
|
|
38
39
|
| **recording** | **BOOLEAN** | Value is true when the call is being recorded. | [optional] |
|
|
@@ -14,8 +14,8 @@ title: CallableTimeSetEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -14,8 +14,8 @@ title: CallbackConversationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -34,6 +34,7 @@ title: CallbackConversationNotificationCallbackMediaParticipant
|
|
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
35
35
|
| **peer** | **String** | | [optional] |
|
|
36
36
|
| **screen_recording_state** | **String** | | [optional] |
|
|
37
|
+
| **flagged_reason** | **String** | | [optional] |
|
|
37
38
|
| **outbound_preview** | [**ConversationNotificationDialerPreview**](ConversationNotificationDialerPreview.html) | | [optional] |
|
|
38
39
|
| **voicemail** | [**ConversationNotificationVoicemail**](ConversationNotificationVoicemail.html) | | [optional] |
|
|
39
40
|
| **callback_numbers** | **Array<String>** | | [optional] |
|
|
@@ -34,6 +34,7 @@ title: CallbackConversationNotificationParticipants
|
|
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
35
35
|
| **peer** | **String** | | [optional] |
|
|
36
36
|
| **screen_recording_state** | **String** | | [optional] |
|
|
37
|
+
| **flagged_reason** | **String** | | [optional] |
|
|
37
38
|
| **outbound_preview** | [**ConversationNotificationDialerPreview**](ConversationNotificationDialerPreview.html) | | [optional] |
|
|
38
39
|
| **voicemail** | [**ConversationNotificationVoicemail**](ConversationNotificationVoicemail.html) | | [optional] |
|
|
39
40
|
| **callback_numbers** | **Array<String>** | | [optional] |
|
|
@@ -33,6 +33,7 @@ title: CallbackMediaParticipant
|
|
|
33
33
|
| **external_organization** | [**UriReference**](UriReference.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
|
34
34
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Wrapup for this participant, if it has been applied. | [optional] |
|
|
35
35
|
| **peer** | **String** | The peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
36
|
+
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
36
37
|
| **outbound_preview** | [**DialerPreview**](DialerPreview.html) | The outbound preview associated with this callback. | [optional] |
|
|
37
38
|
| **voicemail** | [**Voicemail**](Voicemail.html) | The voicemail associated with this callback. | [optional] |
|
|
38
39
|
| **callback_numbers** | **Array<String>** | The list of phone number to use for this callback. | [optional] |
|
|
@@ -14,8 +14,8 @@ title: CampaignEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
data/docs/CertificateDetails.md
CHANGED
|
@@ -12,8 +12,8 @@ title: CertificateDetails
|
|
|
12
12
|
| **expiration_date** | **DateTime** | The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
13
13
|
| **issue_date** | **DateTime** | The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
14
14
|
| **expired** | **BOOLEAN** | True if the certificate is expired, false otherwise. | [optional] |
|
|
15
|
-
| **signature_valid** | **BOOLEAN** | | [optional] |
|
|
16
15
|
| **valid** | **BOOLEAN** | | [optional] |
|
|
16
|
+
| **signature_valid** | **BOOLEAN** | | [optional] |
|
|
17
17
|
{: class="table table-striped"}
|
|
18
18
|
|
|
19
19
|
|
|
@@ -14,8 +14,8 @@ title: ChatConversationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -34,6 +34,7 @@ title: ChatConversationNotificationChatMediaParticipant
|
|
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
35
35
|
| **peer** | **String** | | [optional] |
|
|
36
36
|
| **screen_recording_state** | **String** | | [optional] |
|
|
37
|
+
| **flagged_reason** | **String** | | [optional] |
|
|
37
38
|
| **room_id** | **String** | | [optional] |
|
|
38
39
|
{: class="table table-striped"}
|
|
39
40
|
|
|
@@ -34,6 +34,7 @@ title: ChatConversationNotificationParticipants
|
|
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
35
35
|
| **peer** | **String** | | [optional] |
|
|
36
36
|
| **screen_recording_state** | **String** | | [optional] |
|
|
37
|
+
| **flagged_reason** | **String** | | [optional] |
|
|
37
38
|
| **room_id** | **String** | | [optional] |
|
|
38
39
|
{: class="table table-striped"}
|
|
39
40
|
|
|
@@ -33,6 +33,7 @@ title: ChatMediaParticipant
|
|
|
33
33
|
| **external_organization** | [**UriReference**](UriReference.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
|
34
34
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Wrapup for this participant, if it has been applied. | [optional] |
|
|
35
35
|
| **peer** | **String** | The peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
36
|
+
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
36
37
|
| **room_id** | **String** | The ID of the chat room. | [optional] |
|
|
37
38
|
{: class="table table-striped"}
|
|
38
39
|
|
data/docs/ClientApp.md
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ClientApp
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ClientApp
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | The name of the integration, used to distinguish this integration from others of the same type. | [optional] |
|
|
12
|
+
| **integration_type** | [**IntegrationType**](IntegrationType.html) | Type of the integration | [optional] |
|
|
13
|
+
| **notes** | **String** | Notes about the integration. | [optional] |
|
|
14
|
+
| **intended_state** | **String** | Configured state of the integration. | |
|
|
15
|
+
| **config** | [**ClientAppConfigurationInfo**](ClientAppConfigurationInfo.html) | Configuration information for the integration. | [optional] |
|
|
16
|
+
| **reported_state** | [**IntegrationStatusInfo**](IntegrationStatusInfo.html) | Last reported status of the integration. | [optional] |
|
|
17
|
+
| **attributes** | **Hash<String, String>** | Read-only attributes for the integration. | [optional] |
|
|
18
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
19
|
+
{: class="table table-striped"}
|
|
20
|
+
|
|
21
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ClientAppConfigurationInfo
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ClientAppConfigurationInfo
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **current** | [**IntegrationConfiguration**](IntegrationConfiguration.html) | The current, active configuration for the integration. | [optional] |
|
|
11
|
+
| **effective** | [**EffectiveConfiguration**](EffectiveConfiguration.html) | The effective configuration for the app, containing the integration specific configuration along with overrides specified in the integration type. | [optional] |
|
|
12
|
+
{: class="table table-striped"}
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ClientAppEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ClientAppEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<ClientApp>**](ClientApp.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **self_uri** | **String** | | [optional] |
|
|
15
|
+
| **first_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -14,8 +14,8 @@ title: CobrowseConversationEntityListing
|
|
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -34,6 +34,7 @@ title: CobrowseConversationNotificationCobrowseMediaParticipant
|
|
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
35
35
|
| **peer** | **String** | | [optional] |
|
|
36
36
|
| **screen_recording_state** | **String** | | [optional] |
|
|
37
|
+
| **flagged_reason** | **String** | | [optional] |
|
|
37
38
|
| **cobrowse_session_id** | **String** | | [optional] |
|
|
38
39
|
| **cobrowse_role** | **String** | | [optional] |
|
|
39
40
|
| **viewer_url** | **String** | | [optional] |
|
|
@@ -34,6 +34,7 @@ title: CobrowseConversationNotificationParticipants
|
|
|
34
34
|
| **wrapup** | [**ConversationNotificationWrapup**](ConversationNotificationWrapup.html) | | [optional] |
|
|
35
35
|
| **peer** | **String** | | [optional] |
|
|
36
36
|
| **screen_recording_state** | **String** | | [optional] |
|
|
37
|
+
| **flagged_reason** | **String** | | [optional] |
|
|
37
38
|
| **cobrowse_session_id** | **String** | | [optional] |
|
|
38
39
|
| **cobrowse_role** | **String** | | [optional] |
|
|
39
40
|
| **viewer_url** | **String** | | [optional] |
|
|
@@ -33,6 +33,7 @@ title: CobrowseMediaParticipant
|
|
|
33
33
|
| **external_organization** | [**UriReference**](UriReference.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
|
|
34
34
|
| **wrapup** | [**Wrapup**](Wrapup.html) | Wrapup for this participant, if it has been applied. | [optional] |
|
|
35
35
|
| **peer** | **String** | The peer communication corresponding to a matching leg for this communication. | [optional] |
|
|
36
|
+
| **flagged_reason** | **String** | The reason specifying why participant flagged the conversation. | [optional] |
|
|
36
37
|
| **cobrowse_session_id** | **String** | The co-browse session ID. | [optional] |
|
|
37
38
|
| **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] |
|
|
38
39
|
| **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
|
| **self_uri** | **String** | | [optional] |
|
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
|
16
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
-
| **next_uri** | **String** | | [optional] |
|
|
18
17
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
+
| **next_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|