purecloudplatformclientv2 85.0.0 → 89.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/ApiUsageQuery.md +16 -0
- data/docs/ApiUsageQueryResult.md +14 -0
- data/docs/ApiUsageRow.md +25 -0
- data/docs/ArchitectApi.md +132 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuditApi.md +60 -0
- data/docs/AuditQueryEntity.md +14 -0
- data/docs/AuditQueryExecutionStatusResponse.md +1 -0
- data/docs/AuditQueryRequest.md +1 -0
- data/docs/AuditQueryService.md +14 -0
- data/docs/AuditQueryServiceMapping.md +13 -0
- data/docs/AuditQuerySort.md +14 -0
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/Call.md +1 -0
- data/docs/CallBasic.md +1 -0
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/Callback.md +1 -0
- data/docs/CallbackBasic.md +1 -0
- data/docs/CallbackConversationEntityListing.md +1 -1
- 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/ClientAppEntityListing.md +1 -1
- data/docs/CoachingAnnotation.md +21 -0
- data/docs/CoachingAnnotationCreateRequest.md +14 -0
- data/docs/CoachingAnnotationList.md +22 -0
- data/docs/CoachingApi.md +1132 -0
- data/docs/CoachingAppointmentReference.md +14 -0
- data/docs/CoachingAppointmentResponse.md +27 -0
- data/docs/CoachingAppointmentResponseList.md +22 -0
- data/docs/CoachingAppointmentStatusDto.md +16 -0
- data/docs/CoachingAppointmentStatusDtoList.md +17 -0
- data/docs/CoachingNotification.md +23 -0
- data/docs/CoachingNotificationList.md +22 -0
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/Cobrowsesession.md +1 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/{PartialUploadResponse.md → ContextEntity.md} +3 -3
- data/docs/ContextIntent.md +13 -0
- data/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
- data/docs/ConversationChat.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicCall.md +1 -0
- data/docs/ConversationEventTopicCallback.md +2 -0
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationEventTopicCobrowse.md +1 -0
- data/docs/ConversationEventTopicEmail.md +1 -0
- data/docs/ConversationEventTopicMessage.md +1 -0
- data/docs/ConversationEventTopicScreenshare.md +1 -0
- data/docs/ConversationEventTopicSocialExpression.md +1 -0
- data/docs/ConversationEventTopicVideo.md +1 -0
- data/docs/ConversationReference.md +14 -0
- data/docs/Coretype.md +23 -0
- data/docs/CoretypeListing.md +15 -0
- data/docs/CreateCoachingAppointmentRequest.md +20 -0
- data/docs/CreateQueueRequest.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/DataExtensionsApi.md +198 -0
- data/docs/DataSchemaListing.md +15 -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/DetectedDialogAct.md +14 -0
- data/docs/DetectedIntent.md +15 -0
- data/docs/DetectedNamedEntity.md +16 -0
- data/docs/DetectedNamedEntityValue.md +14 -0
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DialogflowAgent.md +3 -2
- data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DivsPermittedEntityListing.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/DocumentReference.md +14 -0
- 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/Edge.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/Email.md +1 -0
- data/docs/EmailConversationEntityListing.md +1 -1
- 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/ExternalContact.md +2 -0
- data/docs/ExternalContactsApi.md +1001 -144
- data/docs/ExternalOrganization.md +2 -0
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDivisionView.md +2 -0
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowExecutionLaunchRequest.md +16 -0
- data/docs/FlowExecutionLaunchResponse.md +16 -0
- data/docs/FlowOutcomeListing.md +1 -1
- data/docs/FlowRuntimeExecution.md +23 -0
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GenericSAML.md +22 -0
- 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/IdentityProviderApi.md +187 -0
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntentDefinition.md +15 -0
- data/docs/IntentFeedback.md +16 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/IpAddressAuthentication.md +13 -0
- data/docs/ItemValidationLimits.md +14 -0
- data/docs/Items.md +14 -0
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/KnowledgeSearchResponse.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguageUnderstandingApi.md +1160 -0
- 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/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MaxLength.md +14 -0
- data/docs/Message.md +1 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/MinLength.md +14 -0
- data/docs/NamedEntityAnnotation.md +13 -0
- data/docs/NamedEntityTypeBinding.md +14 -0
- data/docs/NamedEntityTypeDefinition.md +15 -0
- data/docs/NamedEntityTypeItem.md +14 -0
- data/docs/NamedEntityTypeMechanism.md +15 -0
- data/docs/NluConfusionMatrixColumn.md +14 -0
- data/docs/NluConfusionMatrixRow.md +14 -0
- data/docs/NluDetectionContext.md +14 -0
- data/docs/NluDetectionInput.md +13 -0
- data/docs/NluDetectionOutput.md +14 -0
- data/docs/NluDetectionRequest.md +14 -0
- data/docs/NluDetectionResponse.md +15 -0
- data/docs/NluDomain.md +19 -0
- data/docs/NluDomainListing.md +22 -0
- data/docs/NluDomainVersion.md +25 -0
- data/docs/NluDomainVersionListing.md +22 -0
- data/docs/NluDomainVersionQualityReport.md +15 -0
- data/docs/NluDomainVersionTrainingResponse.md +14 -0
- data/docs/NluFeedbackListing.md +22 -0
- data/docs/NluFeedbackRequest.md +15 -0
- data/docs/NluFeedbackResponse.md +18 -0
- data/docs/NluQualityReportSummary.md +13 -0
- data/docs/NluQualityReportSummaryMetric.md +14 -0
- data/docs/NluUtterance.md +13 -0
- data/docs/NluUtteranceSegment.md +14 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthApi.md +208 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationApi.md +126 -0
- 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/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/PolicyEntityListing.md +1 -1
- data/docs/Prompt.md +2 -2
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/Queue.md +1 -0
- data/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +1 -0
- data/docs/QueueConversationEventTopicCall.md +1 -0
- data/docs/QueueConversationEventTopicCallback.md +2 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationEventTopicEmail.md +1 -0
- data/docs/QueueConversationEventTopicMessage.md +1 -0
- data/docs/QueueConversationEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationEventTopicVideo.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCallback.md +2 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicMessage.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
- data/docs/QueueConversationVideoEventTopicCall.md +1 -0
- data/docs/QueueConversationVideoEventTopicCallback.md +2 -0
- data/docs/QueueConversationVideoEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
- data/docs/QueueConversationVideoEventTopicMessage.md +1 -0
- data/docs/QueueConversationVideoEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationVideoEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationVideoEventTopicVideo.md +1 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/QueueRequest.md +1 -0
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +12 -0
- data/docs/RecordingJobEntityListing.md +1 -1
- 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 -0
- data/docs/ReportingExportJobResponse.md +2 -0
- data/docs/ReportingExportMetadataJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +65 -0
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +24 -36
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/Schema.md +17 -0
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaQuantityLimits.md +26 -0
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimV2EnterpriseUser.md +1 -0
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/Screenshare.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/SmsAddressEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/SocialExpression.md +1 -0
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.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/{TimeOffRequestLookup.md → TimeOffRequest.md} +2 -2
- data/docs/TimeOffRequestListing.md +13 -0
- data/docs/TimeZoneEntityListing.md +1 -1
- 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/UpdateCoachingAppointmentRequest.md +18 -0
- data/docs/UploadUrlRequest.md +16 -0
- data/docs/UploadUrlResponse.md +14 -0
- data/docs/UploadsApi.md +78 -0
- data/docs/UsageApi.md +144 -0
- data/docs/UsageExecutionResult.md +14 -0
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserAppEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueue.md +1 -0
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/ValidationLimits.md +18 -0
- data/docs/Video.md +1 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WemLearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md +14 -0
- data/docs/WemLearningAssignmentRuleRunTopicLearningModuleReference.md +14 -0
- data/docs/WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated.md +13 -0
- data/docs/WemLearningAssignmentTopicLearningAssignmentNotification.md +22 -0
- data/docs/WemLearningAssignmentTopicLearningModuleReference.md +14 -0
- data/docs/WemLearningAssignmentTopicUserReference.md +13 -0
- data/docs/WhatsAppIntegrationEntityListing.md +1 -1
- data/docs/WorkforceManagementApi.md +297 -448
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +85 -57
- data/lib/purecloudplatformclientv2/api/architect_api.rb +130 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +55 -0
- data/lib/purecloudplatformclientv2/api/coaching_api.rb +1296 -0
- data/lib/purecloudplatformclientv2/api/data_extensions_api.rb +207 -0
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +868 -4
- data/lib/purecloudplatformclientv2/api/identity_provider_api.rb +175 -0
- data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +1304 -0
- data/lib/purecloudplatformclientv2/api/o_auth_api.rb +224 -0
- data/lib/purecloudplatformclientv2/api/organization_api.rb +120 -0
- data/lib/purecloudplatformclientv2/api/recording_api.rb +78 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +64 -0
- data/lib/purecloudplatformclientv2/api/scim_api.rb +16 -16
- data/lib/purecloudplatformclientv2/api/uploads_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/usage_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +314 -571
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{intraday_query_data_command.rb → api_usage_query.rb} +45 -67
- data/lib/purecloudplatformclientv2/models/api_usage_query_result.rb +244 -0
- data/lib/purecloudplatformclientv2/models/{reschedule_request.rb → api_usage_row.rb} +182 -86
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{unscheduled_agent_warning.rb → audit_query_entity.rb} +32 -30
- data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +32 -4
- data/lib/purecloudplatformclientv2/models/audit_query_request.rb +32 -4
- data/lib/purecloudplatformclientv2/models/{wfm_intraday_queue_listing.rb → audit_query_service.rb} +32 -31
- data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_response.rb → audit_query_service_mapping.rb} +10 -9
- data/lib/purecloudplatformclientv2/models/audit_query_sort.rb +266 -0
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/bulk_update_shift_trade_state_result_item.rb +2 -2
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/call.rb +30 -4
- data/lib/purecloudplatformclientv2/models/call_basic.rb +30 -4
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/callback.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback_basic.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{short_term_forecast.rb → coaching_annotation.rb} +73 -105
- data/lib/purecloudplatformclientv2/models/coaching_annotation_create_request.rb +252 -0
- data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response.rb +587 -0
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{generate_short_term_forecast_response.rb → coaching_appointment_status_dto.rb} +49 -44
- data/lib/purecloudplatformclientv2/models/{wfm_forecast_modification_attributes.rb → coaching_appointment_status_dto_list.rb} +52 -37
- data/lib/purecloudplatformclientv2/models/coaching_notification.rb +504 -0
- data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{list_wrapper_wfm_forecast_modification.rb → context_entity.rb} +14 -10
- data/lib/purecloudplatformclientv2/models/{list_wrapper_forecast_source_day_pointer.rb → context_intent.rb} +14 -10
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_callback_event_topic_callback_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +32 -6
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +51 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/coretype.rb +465 -0
- data/lib/purecloudplatformclientv2/models/coretype_listing.rb +253 -0
- data/lib/purecloudplatformclientv2/models/{intraday_historical_queue_data.rb → create_coaching_appointment_request.rb} +100 -58
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/data_schema_listing.rb +253 -0
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{forecast_result_response.rb → detected_dialog_act.rb} +16 -16
- data/lib/purecloudplatformclientv2/models/{intraday_queue.rb → detected_intent.rb} +23 -23
- data/lib/purecloudplatformclientv2/models/{create_queue_media_association_request.rb → detected_named_entity.rb} +49 -26
- data/lib/purecloudplatformclientv2/models/detected_named_entity_value.rb +228 -0
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +31 -3
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{user_schedules_partial_upload_request.rb → document_reference.rb} +34 -16
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +16 -16
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +16 -16
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +16 -16
- data/lib/purecloudplatformclientv2/models/edge.rb +1 -0
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/email.rb +30 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/external_contact.rb +55 -1
- data/lib/purecloudplatformclientv2/models/external_organization.rb +55 -1
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +53 -1
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{queue_media_association.rb → flow_execution_launch_request.rb} +37 -32
- data/lib/purecloudplatformclientv2/models/{create_service_goal_group_request.rb → flow_execution_launch_response.rb} +43 -24
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{rescheduling_options_response.rb → flow_runtime_execution.rb} +120 -96
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/generic_saml.rb +428 -0
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{service_goal_group_goals.rb → intent_definition.rb} +34 -26
- data/lib/purecloudplatformclientv2/models/intent_feedback.rb +296 -0
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +16 -16
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +16 -16
- data/lib/purecloudplatformclientv2/models/ip_address_authentication.rb +203 -0
- data/lib/purecloudplatformclientv2/models/item_validation_limits.rb +238 -0
- data/lib/purecloudplatformclientv2/models/{time_off_request_entity_list.rb → items.rb} +33 -10
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/knowledge_search_response.rb +18 -18
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/max_length.rb +238 -0
- data/lib/purecloudplatformclientv2/models/message.rb +30 -4
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{forecast_generation_route_group_result.rb → min_length.rb} +26 -18
- data/lib/purecloudplatformclientv2/models/{scheduling_run_list_response.rb → named_entity_annotation.rb} +14 -10
- data/lib/purecloudplatformclientv2/models/{copy_short_term_forecast_request.rb → named_entity_type_binding.rb} +18 -19
- data/lib/purecloudplatformclientv2/models/{generate_week_schedule_request.rb → named_entity_type_definition.rb} +38 -13
- data/lib/purecloudplatformclientv2/models/{wfm_abandon_rate.rb → named_entity_type_item.rb} +19 -18
- data/lib/purecloudplatformclientv2/models/{short_term_forecast_response.rb → named_entity_type_mechanism.rb} +48 -36
- data/lib/purecloudplatformclientv2/models/{copy_week_schedule_request.rb → nlu_confusion_matrix_column.rb} +18 -18
- data/lib/purecloudplatformclientv2/models/{wfm_average_speed_of_answer.rb → nlu_confusion_matrix_row.rb} +24 -18
- data/lib/purecloudplatformclientv2/models/nlu_detection_context.rb +228 -0
- data/lib/purecloudplatformclientv2/models/nlu_detection_input.rb +207 -0
- data/lib/purecloudplatformclientv2/models/nlu_detection_output.rb +232 -0
- data/lib/purecloudplatformclientv2/models/nlu_detection_request.rb +233 -0
- data/lib/purecloudplatformclientv2/models/{route_group_list.rb → nlu_detection_response.rb} +39 -22
- data/lib/purecloudplatformclientv2/models/{short_term_forecast_list_item_response.rb → nlu_domain.rb} +66 -60
- data/lib/purecloudplatformclientv2/models/nlu_domain_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{update_week_schedule_request.rb → nlu_domain_version.rb} +187 -79
- data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{intraday_metric.rb → nlu_domain_version_quality_report.rb} +57 -28
- data/lib/purecloudplatformclientv2/models/nlu_domain_version_training_response.rb +227 -0
- data/lib/purecloudplatformclientv2/models/nlu_feedback_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/{wfm_service_level.rb → nlu_feedback_request.rb} +36 -25
- data/lib/purecloudplatformclientv2/models/{service_goal_group.rb → nlu_feedback_response.rb} +32 -37
- data/lib/purecloudplatformclientv2/models/{generate_short_term_forecast_request.rb → nlu_quality_report_summary.rb} +12 -10
- data/lib/purecloudplatformclientv2/models/nlu_quality_report_summary_metric.rb +238 -0
- data/lib/purecloudplatformclientv2/models/nlu_utterance.rb +209 -0
- data/lib/purecloudplatformclientv2/models/nlu_utterance_segment.rb +233 -0
- data/lib/purecloudplatformclientv2/models/note_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/prompt.rb +2 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +16 -16
- data/lib/purecloudplatformclientv2/models/queue.rb +29 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_callback_event_topic_callback_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_callback.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +51 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_cobrowse.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_message.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_screenshare.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_social_expression.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_video.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/queue_request.rb +29 -1
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +32 -4
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +57 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +16 -16
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{import_short_term_forecast_request.rb → schema.rb} +50 -35
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/schema_quantity_limits.rb +539 -0
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +30 -4
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/shift_trade_match_violation.rb +2 -2
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{time_off_request_lookup.rb → time_off_request.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/{time_off_request_lookup_list.rb → time_off_request_listing.rb} +2 -2
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{import_week_schedule_request.rb → update_coaching_appointment_request.rb} +60 -39
- data/lib/purecloudplatformclientv2/models/{route_group_attributes.rb → upload_url_request.rb} +43 -57
- data/lib/purecloudplatformclientv2/models/upload_url_response.rb +230 -0
- data/lib/purecloudplatformclientv2/models/usage_execution_result.rb +228 -0
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_app_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_queue.rb +29 -1
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/validation_limits.rb +326 -0
- data/lib/purecloudplatformclientv2/models/video.rb +30 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +16 -16
- data/lib/purecloudplatformclientv2/models/{service_goal_group_list.rb → wem_learning_assignment_rule_run_topic_learning_assignment_rule_run_notification.rb} +9 -11
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_learning_module_reference.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_rule_run_topic_wem_learning_assignments_created.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wem_learning_assignment_topic_learning_assignment_notification.rb +440 -0
- data/lib/purecloudplatformclientv2/models/{intraday_performance_prediction_agent_data.rb → wem_learning_assignment_topic_learning_module_reference.rb} +33 -9
- data/lib/purecloudplatformclientv2/models/{partial_upload_response.rb → wem_learning_assignment_topic_user_reference.rb} +1 -2
- data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +16 -16
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +172 -116
- data/docs/AsyncWeekScheduleResponse.md +0 -16
- data/docs/CopyShortTermForecastRequest.md +0 -14
- data/docs/CopyWeekScheduleRequest.md +0 -14
- data/docs/CreateQueueMediaAssociationRequest.md +0 -15
- data/docs/CreateServiceGoalGroupRequest.md +0 -15
- data/docs/ForecastGenerationResult.md +0 -13
- data/docs/ForecastGenerationRouteGroupResult.md +0 -14
- data/docs/ForecastResultResponse.md +0 -14
- data/docs/ForecastTimeSeriesResult.md +0 -14
- data/docs/GenerateShortTermForecastRequest.md +0 -13
- data/docs/GenerateShortTermForecastResponse.md +0 -16
- data/docs/GenerateWeekScheduleRequest.md +0 -14
- data/docs/GenerateWeekScheduleResponse.md +0 -15
- data/docs/ImportShortTermForecastRequest.md +0 -16
- data/docs/ImportWeekScheduleRequest.md +0 -17
- data/docs/IntradayDataGroup.md +0 -19
- data/docs/IntradayForecastData.md +0 -15
- data/docs/IntradayHistoricalAgentData.md +0 -14
- data/docs/IntradayHistoricalQueueData.md +0 -20
- data/docs/IntradayMetric.md +0 -14
- data/docs/IntradayPerformancePredictionAgentData.md +0 -13
- data/docs/IntradayPerformancePredictionQueueData.md +0 -15
- data/docs/IntradayQueryDataCommand.md +0 -17
- data/docs/IntradayQueue.md +0 -15
- data/docs/IntradayResponse.md +0 -20
- data/docs/IntradayScheduleData.md +0 -14
- data/docs/ListWrapperForecastSourceDayPointer.md +0 -13
- data/docs/ListWrapperWfmForecastModification.md +0 -13
- data/docs/QueueMediaAssociation.md +0 -16
- data/docs/RescheduleRequest.md +0 -20
- data/docs/RescheduleResult.md +0 -13
- data/docs/ReschedulingOptionsResponse.md +0 -22
- data/docs/RouteGroup.md +0 -18
- data/docs/RouteGroupAttributes.md +0 -16
- data/docs/RouteGroupList.md +0 -14
- data/docs/SchedulingRunListResponse.md +0 -13
- data/docs/SchedulingRunResponse.md +0 -28
- data/docs/ServiceGoalGroup.md +0 -18
- data/docs/ServiceGoalGroupGoals.md +0 -15
- data/docs/ServiceGoalGroupList.md +0 -14
- data/docs/ShortTermForecast.md +0 -22
- data/docs/ShortTermForecastListItemResponse.md +0 -18
- data/docs/ShortTermForecastListResponse.md +0 -13
- data/docs/ShortTermForecastResponse.md +0 -15
- data/docs/TimeOffRequestEntityList.md +0 -13
- data/docs/TimeOffRequestLookupList.md +0 -13
- data/docs/UnscheduledAgentWarning.md +0 -14
- data/docs/UpdateWeekScheduleRequest.md +0 -21
- data/docs/UserSchedulesPartialUploadRequest.md +0 -13
- data/docs/WfmAbandonRate.md +0 -14
- data/docs/WfmAverageSpeedOfAnswer.md +0 -14
- data/docs/WfmForecastModification.md +0 -20
- data/docs/WfmForecastModificationAttributes.md +0 -16
- data/docs/WfmIntradayQueueListing.md +0 -14
- data/docs/WfmServiceLevel.md +0 -15
- data/lib/purecloudplatformclientv2/models/async_week_schedule_response.rb +0 -295
- data/lib/purecloudplatformclientv2/models/forecast_generation_result.rb +0 -204
- data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +0 -256
- data/lib/purecloudplatformclientv2/models/generate_week_schedule_response.rb +0 -269
- data/lib/purecloudplatformclientv2/models/intraday_data_group.rb +0 -384
- data/lib/purecloudplatformclientv2/models/intraday_forecast_data.rb +0 -254
- data/lib/purecloudplatformclientv2/models/intraday_historical_agent_data.rb +0 -228
- data/lib/purecloudplatformclientv2/models/intraday_performance_prediction_queue_data.rb +0 -254
- data/lib/purecloudplatformclientv2/models/intraday_response.rb +0 -404
- data/lib/purecloudplatformclientv2/models/intraday_schedule_data.rb +0 -228
- data/lib/purecloudplatformclientv2/models/reschedule_result.rb +0 -202
- data/lib/purecloudplatformclientv2/models/route_group.rb +0 -363
- data/lib/purecloudplatformclientv2/models/scheduling_run_response.rb +0 -609
- data/lib/purecloudplatformclientv2/models/wfm_forecast_modification.rb +0 -435
|
@@ -22,6 +22,7 @@ title: QueueConversationVideoEventTopicSocialExpression
|
|
|
22
22
|
| **start_hold_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **connected_time** | **DateTime** | | [optional] |
|
|
24
24
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
25
|
+
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
25
26
|
| **additional_properties** | **Object** | | [optional] |
|
|
26
27
|
{: class="table table-striped"}
|
|
27
28
|
|
|
@@ -21,6 +21,7 @@ title: QueueConversationVideoEventTopicVideo
|
|
|
21
21
|
| **connected_time** | **DateTime** | | [optional] |
|
|
22
22
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
23
23
|
| **msids** | **Array<String>** | | [optional] |
|
|
24
|
+
| **wrapup** | [**QueueConversationVideoEventTopicWrapup**](QueueConversationVideoEventTopicWrapup.html) | | [optional] |
|
|
24
25
|
| **additional_properties** | **Object** | | [optional] |
|
|
25
26
|
{: class="table table-striped"}
|
|
26
27
|
|
data/docs/QueueEntityListing.md
CHANGED
|
@@ -12,10 +12,10 @@ title: QueueEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: QueueMemberEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **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/QueueRequest.md
CHANGED
|
@@ -17,6 +17,7 @@ title: QueueRequest
|
|
|
17
17
|
| **created_by** | **String** | The ID of the user that created the queue. | [optional] |
|
|
18
18
|
| **member_count** | **Integer** | The number of users in the queue. | [optional] |
|
|
19
19
|
| **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM | [optional] |
|
|
20
|
+
| **routing_rules** | [**Array<RoutingRule>**](RoutingRule.html) | The routing rules for the queue, used for routing to known or preferred agents. | [optional] |
|
|
20
21
|
| **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
|
|
21
22
|
| **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | [optional] |
|
|
22
23
|
| **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | [optional] |
|
data/docs/RecipientListing.md
CHANGED
|
@@ -12,10 +12,10 @@ title: RecipientListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **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/RecordingApi.md
CHANGED
|
@@ -421,6 +421,9 @@ recording_id = "recording_id_example" # String | Recording ID
|
|
|
421
421
|
|
|
422
422
|
opts = {
|
|
423
423
|
format_id: "WEBM", # String | The desired media format.
|
|
424
|
+
email_format_id: "EML", # String | The desired media format when downloading an email recording.
|
|
425
|
+
chat_format_id: "ZIP", # String | The desired media format when downloading a chat recording.
|
|
426
|
+
message_format_id: "ZIP", # String | The desired media format when downloading a message recording.
|
|
424
427
|
download: false, # BOOLEAN | requesting a download format of the recording
|
|
425
428
|
file_name: "file_name_example", # String | the name of the downloaded fileName
|
|
426
429
|
locale: "locale_example" # String | The locale for the requested file when downloading, as an ISO 639-1 code
|
|
@@ -442,6 +445,9 @@ Name | Type | Description | Notes
|
|
|
442
445
|
**conversation_id** | **String**| Conversation ID | |
|
|
443
446
|
**recording_id** | **String**| Recording ID | |
|
|
444
447
|
**format_id** | **String**| The desired media format. | [optional] [default to WEBM]<br />**Values**: WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE |
|
|
448
|
+
**email_format_id** | **String**| The desired media format when downloading an email recording. | [optional] [default to EML]<br />**Values**: EML, NONE |
|
|
449
|
+
**chat_format_id** | **String**| The desired media format when downloading a chat recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
|
|
450
|
+
**message_format_id** | **String**| The desired media format when downloading a message recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
|
|
445
451
|
**download** | **BOOLEAN**| requesting a download format of the recording | [optional] [default to false] |
|
|
446
452
|
**file_name** | **String**| the name of the downloaded fileName | [optional] |
|
|
447
453
|
**locale** | **String**| The locale for the requested file when downloading, as an ISO 639-1 code | [optional] |
|
|
@@ -904,6 +910,9 @@ orphan_id = "orphan_id_example" # String | Orphan ID
|
|
|
904
910
|
|
|
905
911
|
opts = {
|
|
906
912
|
format_id: "WEBM", # String | The desired media format.
|
|
913
|
+
email_format_id: "EML", # String | The desired media format when downloading an email recording.
|
|
914
|
+
chat_format_id: "ZIP", # String | The desired media format when downloading a chat recording.
|
|
915
|
+
message_format_id: "ZIP", # String | The desired media format when downloading a message recording.
|
|
907
916
|
download: false, # BOOLEAN | requesting a download format of the recording
|
|
908
917
|
file_name: "file_name_example", # String | the name of the downloaded fileName
|
|
909
918
|
locale: "locale_example" # String | The locale for the requested file when downloading, as an ISO 639-1 code
|
|
@@ -924,6 +933,9 @@ Name | Type | Description | Notes
|
|
|
924
933
|
------------- | ------------- | ------------- | -------------
|
|
925
934
|
**orphan_id** | **String**| Orphan ID | |
|
|
926
935
|
**format_id** | **String**| The desired media format. | [optional] [default to WEBM]<br />**Values**: WAV, WEBM, WAV_ULAW, OGG_VORBIS, OGG_OPUS, MP3, NONE |
|
|
936
|
+
**email_format_id** | **String**| The desired media format when downloading an email recording. | [optional] [default to EML]<br />**Values**: EML, NONE |
|
|
937
|
+
**chat_format_id** | **String**| The desired media format when downloading a chat recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
|
|
938
|
+
**message_format_id** | **String**| The desired media format when downloading a message recording. | [optional] [default to ZIP]<br />**Values**: ZIP, NONE |
|
|
927
939
|
**download** | **BOOLEAN**| requesting a download format of the recording | [optional] [default to false] |
|
|
928
940
|
**file_name** | **String**| the name of the downloaded fileName | [optional] |
|
|
929
941
|
**locale** | **String**| The locale for the requested file when downloading, as an ISO 639-1 code | [optional] |
|
|
@@ -12,10 +12,10 @@ title: RecordingJobEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **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/RelationshipListing.md
CHANGED
|
@@ -12,10 +12,10 @@ title: RelationshipListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ReportMetaDataEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ReportRunEntryEntityDomainListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ReportScheduleEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ReportingExportJobListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -20,6 +20,7 @@ title: ReportingExportJobRequest
|
|
|
20
20
|
| **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
|
|
21
21
|
| **selected_columns** | [**Array<SelectedColumns>**](SelectedColumns.html) | The list of ordered selected columns from the export view by the user | [optional] |
|
|
22
22
|
| **has_custom_participant_attributes** | **BOOLEAN** | Indicates if custom participant attributes will be exported | [optional] |
|
|
23
|
+
| **recipient_emails** | **Array<String>** | The list of email recipients for the exports | [optional] |
|
|
23
24
|
{: class="table table-striped"}
|
|
24
25
|
|
|
25
26
|
|
|
@@ -27,6 +27,8 @@ title: ReportingExportJobResponse
|
|
|
27
27
|
| **has_split_filters** | **BOOLEAN** | Indicates if filters will be split in aggregate detail exports | [optional] |
|
|
28
28
|
| **selected_columns** | [**Array<SelectedColumns>**](SelectedColumns.html) | The list of ordered selected columns from the export view by the user | [optional] |
|
|
29
29
|
| **has_custom_participant_attributes** | **BOOLEAN** | Indicates if custom participant attributes will be exported | [optional] |
|
|
30
|
+
| **recipient_emails** | **Array<String>** | The list of email recipients for the exports | [optional] |
|
|
31
|
+
| **email_statuses** | **Hash<String, String>** | The status of individual email addresses as a map | [optional] |
|
|
30
32
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
31
33
|
{: class="table table-striped"}
|
|
32
34
|
|
|
@@ -12,10 +12,10 @@ title: ReportingExportMetadataJobListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **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/ResponseEntityList.md
CHANGED
|
@@ -12,10 +12,10 @@ title: ResponseEntityList
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ResponseEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **last_uri** | **String** | | [optional] |
|
|
18
|
-
| **previous_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
21
21
|
|
|
@@ -12,10 +12,10 @@ title: ResponseSetEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **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/RoutingApi.md
CHANGED
|
@@ -15,6 +15,7 @@ Method | Description
|
|
|
15
15
|
[**delete_routing_queue_wrapupcode**](RoutingApi.html#delete_routing_queue_wrapupcode) | Delete a wrap-up code from a queue
|
|
16
16
|
[**delete_routing_settings**](RoutingApi.html#delete_routing_settings) | Delete an organization's routing settings
|
|
17
17
|
[**delete_routing_skill**](RoutingApi.html#delete_routing_skill) | Delete Routing Skill
|
|
18
|
+
[**delete_routing_sms_address**](RoutingApi.html#delete_routing_sms_address) | Delete an Address by Id for SMS
|
|
18
19
|
[**delete_routing_sms_phonenumber**](RoutingApi.html#delete_routing_sms_phonenumber) | Delete a phone number provisioned for SMS.
|
|
19
20
|
[**delete_routing_user_utilization**](RoutingApi.html#delete_routing_user_utilization) | Delete the user's max utilization settings and revert to the organization-wide default.
|
|
20
21
|
[**delete_routing_utilization**](RoutingApi.html#delete_routing_utilization) | Delete the organization-wide max utilization settings and revert to the system default.
|
|
@@ -546,6 +547,70 @@ nil (empty response body)
|
|
|
546
547
|
|
|
547
548
|
|
|
548
549
|
|
|
550
|
+
<a name="delete_routing_sms_address"></a>
|
|
551
|
+
|
|
552
|
+
## delete_routing_sms_address(address_id)
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
Delete an Address by Id for SMS
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
Wraps DELETE /api/v2/routing/sms/addresses/{addressId}
|
|
561
|
+
|
|
562
|
+
Requires ALL permissions:
|
|
563
|
+
|
|
564
|
+
* sms:phoneNumber:delete
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
### Example
|
|
568
|
+
```{"language":"ruby"}
|
|
569
|
+
# load the gem
|
|
570
|
+
require 'purecloudplatformclientv2'
|
|
571
|
+
# setup authorization
|
|
572
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
573
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
574
|
+
environment = "mypurecloud.com"
|
|
575
|
+
|
|
576
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
577
|
+
|
|
578
|
+
PureCloud.configure do |config|
|
|
579
|
+
config.access_token = @authToken
|
|
580
|
+
end
|
|
581
|
+
|
|
582
|
+
api_instance = PureCloud::RoutingApi.new
|
|
583
|
+
|
|
584
|
+
address_id = "address_id_example" # String | Address ID
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
begin
|
|
588
|
+
#Delete an Address by Id for SMS
|
|
589
|
+
api_instance.delete_routing_sms_address(address_id)
|
|
590
|
+
rescue PureCloud::ApiError => e
|
|
591
|
+
puts "Exception when calling RoutingApi->delete_routing_sms_address: #{e}"
|
|
592
|
+
end
|
|
593
|
+
```
|
|
594
|
+
|
|
595
|
+
### Parameters
|
|
596
|
+
|
|
597
|
+
Name | Type | Description | Notes
|
|
598
|
+
------------- | ------------- | ------------- | -------------
|
|
599
|
+
**address_id** | **String**| Address ID | |
|
|
600
|
+
{: class="table table-striped"}
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
### Return type
|
|
604
|
+
|
|
605
|
+
nil (empty response body)
|
|
606
|
+
|
|
607
|
+
### HTTP request headers
|
|
608
|
+
|
|
609
|
+
- **Content-Type**: application/json
|
|
610
|
+
- **Accept**: application/json
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
549
614
|
<a name="delete_routing_sms_phonenumber"></a>
|
|
550
615
|
|
|
551
616
|
## delete_routing_sms_phonenumber(address_id)
|
|
@@ -12,10 +12,10 @@ title: RuleSetEntityListing
|
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **previous_uri** | **String** | | [optional] |
|
|
15
16
|
| **self_uri** | **String** | | [optional] |
|
|
16
17
|
| **next_uri** | **String** | | [optional] |
|
|
17
18
|
| **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/SCIMApi.md
CHANGED
|
@@ -427,7 +427,7 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
427
427
|
|
|
428
428
|
opts = {
|
|
429
429
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
430
|
-
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
430
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
|
|
431
431
|
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
432
432
|
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
|
|
433
433
|
filter: "displayName eq groupName" # String | Filters results.
|
|
@@ -447,7 +447,7 @@ end
|
|
|
447
447
|
Name | Type | Description | Notes
|
|
448
448
|
------------- | ------------- | ------------- | -------------
|
|
449
449
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
450
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
450
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members). | [optional] [default to 25] |
|
|
451
451
|
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
452
452
|
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
453
453
|
**filter** | **String**| Filters results. | [optional] |
|
|
@@ -793,11 +793,8 @@ Get a user
|
|
|
793
793
|
|
|
794
794
|
Wraps GET /api/v2/scim/users/{userId}
|
|
795
795
|
|
|
796
|
-
Requires
|
|
796
|
+
Requires NO permissions:
|
|
797
797
|
|
|
798
|
-
* authorization:grant:view
|
|
799
|
-
* authorization:grant:add
|
|
800
|
-
* authorization:grant:delete
|
|
801
798
|
|
|
802
799
|
|
|
803
800
|
### Example
|
|
@@ -820,7 +817,7 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
820
817
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
|
|
821
818
|
|
|
822
819
|
opts = {
|
|
823
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes
|
|
820
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
824
821
|
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
|
|
825
822
|
if_none_match: "if_none_match_example" # String | TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
826
823
|
}
|
|
@@ -839,8 +836,8 @@ end
|
|
|
839
836
|
Name | Type | Description | Notes
|
|
840
837
|
------------- | ------------- | ------------- | -------------
|
|
841
838
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
842
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes
|
|
843
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups,
|
|
839
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
840
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
844
841
|
**if_none_match** | **String**| TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. | [optional] |
|
|
845
842
|
{: class="table table-striped"}
|
|
846
843
|
|
|
@@ -868,11 +865,8 @@ To return all active users, do not use a filter parameter. To return inactive us
|
|
|
868
865
|
|
|
869
866
|
Wraps GET /api/v2/scim/users
|
|
870
867
|
|
|
871
|
-
Requires
|
|
868
|
+
Requires NO permissions:
|
|
872
869
|
|
|
873
|
-
* authorization:grant:view
|
|
874
|
-
* authorization:grant:add
|
|
875
|
-
* authorization:grant:delete
|
|
876
870
|
|
|
877
871
|
|
|
878
872
|
### Example
|
|
@@ -894,8 +888,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
894
888
|
|
|
895
889
|
opts = {
|
|
896
890
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
897
|
-
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
898
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes
|
|
891
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
|
|
892
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
899
893
|
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
|
|
900
894
|
filter: "filter_example" # String | Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\".
|
|
901
895
|
}
|
|
@@ -914,9 +908,9 @@ end
|
|
|
914
908
|
Name | Type | Description | Notes
|
|
915
909
|
------------- | ------------- | ------------- | -------------
|
|
916
910
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
917
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
918
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes
|
|
919
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups,
|
|
911
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members). | [optional] [default to 25] |
|
|
912
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
913
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
920
914
|
**filter** | **String**| Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\". | [optional] |
|
|
921
915
|
{: class="table table-striped"}
|
|
922
916
|
|
|
@@ -1043,7 +1037,7 @@ filter = "displayName eq groupName" # String | Filters results.
|
|
|
1043
1037
|
|
|
1044
1038
|
opts = {
|
|
1045
1039
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
1046
|
-
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
1040
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
|
|
1047
1041
|
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
1048
1042
|
excluded_attributes: ["excluded_attributes_example"] # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
|
|
1049
1043
|
}
|
|
@@ -1063,7 +1057,7 @@ Name | Type | Description | Notes
|
|
|
1063
1057
|
------------- | ------------- | ------------- | -------------
|
|
1064
1058
|
**filter** | **String**| Filters results. | |
|
|
1065
1059
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
1066
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
1060
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members). | [optional] [default to 25] |
|
|
1067
1061
|
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the 'id', 'active', and 'meta attributes . Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
1068
1062
|
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output. | [optional] <br />**Values**: id, displayName, members, externalId, urn:ietf:params:scim:schemas:core:2.0:Group:id, urn:ietf:params:scim:schemas:core:2.0:Group:displayName, urn:ietf:params:scim:schemas:core:2.0:Group:members, urn:ietf:params:scim:schemas:core:2.0:Group:externalId |
|
|
1069
1063
|
{: class="table table-striped"}
|
|
@@ -1408,11 +1402,8 @@ Get a user
|
|
|
1408
1402
|
|
|
1409
1403
|
Wraps GET /api/v2/scim/v2/users/{userId}
|
|
1410
1404
|
|
|
1411
|
-
Requires
|
|
1405
|
+
Requires NO permissions:
|
|
1412
1406
|
|
|
1413
|
-
* authorization:grant:view
|
|
1414
|
-
* authorization:grant:add
|
|
1415
|
-
* authorization:grant:delete
|
|
1416
1407
|
|
|
1417
1408
|
|
|
1418
1409
|
### Example
|
|
@@ -1435,7 +1426,7 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
1435
1426
|
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
1436
1427
|
|
|
1437
1428
|
opts = {
|
|
1438
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes
|
|
1429
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
1439
1430
|
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
|
|
1440
1431
|
if_none_match: "if_none_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
1441
1432
|
}
|
|
@@ -1454,8 +1445,8 @@ end
|
|
|
1454
1445
|
Name | Type | Description | Notes
|
|
1455
1446
|
------------- | ------------- | ------------- | -------------
|
|
1456
1447
|
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
1457
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes
|
|
1458
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups,
|
|
1448
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
1449
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
1459
1450
|
**if_none_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. | [optional] |
|
|
1460
1451
|
{: class="table table-striped"}
|
|
1461
1452
|
|
|
@@ -1483,11 +1474,8 @@ To return all active users, do not use a filter parameter. To return inactive us
|
|
|
1483
1474
|
|
|
1484
1475
|
Wraps GET /api/v2/scim/v2/users
|
|
1485
1476
|
|
|
1486
|
-
Requires
|
|
1477
|
+
Requires NO permissions:
|
|
1487
1478
|
|
|
1488
|
-
* authorization:grant:view
|
|
1489
|
-
* authorization:grant:add
|
|
1490
|
-
* authorization:grant:delete
|
|
1491
1479
|
|
|
1492
1480
|
|
|
1493
1481
|
### Example
|
|
@@ -1509,8 +1497,8 @@ api_instance = PureCloud::SCIMApi.new
|
|
|
1509
1497
|
|
|
1510
1498
|
opts = {
|
|
1511
1499
|
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
1512
|
-
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
1513
|
-
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes
|
|
1500
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members).
|
|
1501
|
+
attributes: ["attributes_example"], # Array<String> | Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
1514
1502
|
excluded_attributes: ["excluded_attributes_example"], # Array<String> | Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
|
|
1515
1503
|
filter: "filter_example" # String | Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\".
|
|
1516
1504
|
}
|
|
@@ -1529,9 +1517,9 @@ end
|
|
|
1529
1517
|
Name | Type | Description | Notes
|
|
1530
1518
|
------------- | ------------- | ------------- | -------------
|
|
1531
1519
|
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
1532
|
-
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". | [optional] [default to 25] |
|
|
1533
|
-
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes
|
|
1534
|
-
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups,
|
|
1520
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns \"totalResults\". Note that page size over 25 will likely cause a 429 error by exceeding the internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. for Users externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, and for Groups externalId, members). | [optional] [default to 25] |
|
|
1521
|
+
**attributes** | [**Array<String>**](String.html)| Indicates which attributes to include. Returns these attributes and the 'id', 'userName', 'active', and 'meta' attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
1522
|
+
**excluded_attributes** | [**Array<String>**](String.html)| Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output. | [optional] <br />**Values**: id, userName, displayName, title, active, externalId, phoneNumbers, emails, groups, roles, urn:ietf:params:scim:schemas:core:2.0:User:id, urn:ietf:params:scim:schemas:core:2.0:User:userName, urn:ietf:params:scim:schemas:core:2.0:User:displayName, urn:ietf:params:scim:schemas:core:2.0:User:title, urn:ietf:params:scim:schemas:core:2.0:User:active, urn:ietf:params:scim:schemas:core:2.0:User:externalId, urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers, urn:ietf:params:scim:schemas:core:2.0:User:emails, urn:ietf:params:scim:schemas:core:2.0:User:groups, urn:ietf:params:scim:schemas:core:2.0:User:roles, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages |
|
|
1535
1523
|
**filter** | **String**| Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\". | [optional] |
|
|
1536
1524
|
{: class="table table-striped"}
|
|
1537
1525
|
|