purecloudplatformclientv2 90.0.0 → 95.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/AfterCallWork.md +15 -0
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AmazonLexRequest.md +14 -0
- data/docs/AnalyticsApi.md +67 -1
- data/docs/AnalyticsSession.md +4 -0
- data/docs/ArchitectApi.md +51 -49
- data/docs/ArrayNode.md +5 -5
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuditApi.md +70 -0
- data/docs/AuditRealtimeQueryRequest.md +18 -0
- data/docs/AuditRealtimeQueryResultsResponse.md +17 -0
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/AvailableTopic.md +1 -0
- data/docs/Biography.md +1 -0
- data/docs/BuAgentScheduleActivity.md +2 -0
- data/docs/ButtonComponent.md +16 -0
- 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/CoachingAnnotationList.md +1 -1
- data/docs/CoachingApi.md +35 -28
- data/docs/CoachingAppointmentResponseList.md +1 -1
- data/docs/CoachingNotification.md +1 -1
- data/docs/CoachingNotificationList.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/Cobrowsesession.md +1 -0
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/CommonCampaign.md +17 -0
- data/docs/CommonCampaignDivisionView.md +17 -0
- data/docs/CommonCampaignDivisionViewEntityListing.md +22 -0
- data/docs/CommonCampaignEntityListing.md +22 -0
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/Contact.md +1 -0
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ContentActions.md +17 -0
- data/docs/ContentAttachment.md +19 -0
- data/docs/ContentGeneric.md +19 -0
- data/docs/ContentList.md +19 -0
- data/docs/ContentLocation.md +17 -0
- data/docs/ContentNotificationTemplate.md +17 -0
- data/docs/ContentQuickReply.md +16 -0
- data/docs/ConversationAggregationQuery.md +1 -1
- data/docs/ConversationAssociation.md +1 -1
- data/docs/ConversationChat.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicAfterCallWork.md +15 -0
- data/docs/ConversationEventTopicCall.md +1 -0
- data/docs/ConversationEventTopicCallback.md +1 -0
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationEventTopicCobrowse.md +1 -0
- data/docs/ConversationEventTopicEmail.md +1 -0
- data/docs/ConversationEventTopicMessage.md +2 -0
- data/docs/ConversationEventTopicScreenshare.md +1 -0
- data/docs/ConversationEventTopicSocialExpression.md +1 -0
- data/docs/ConversationEventTopicVideo.md +1 -0
- data/docs/ConversationsApi.md +73 -4
- data/docs/CreateCoachingAppointmentRequest.md +1 -1
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/CursorContactListing.md +16 -0
- data/docs/CursorNoteListing.md +16 -0
- data/docs/CursorOrganizationListing.md +16 -0
- data/docs/CursorRelationshipListing.md +16 -0
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/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/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroup.md +1 -0
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/Education.md +17 -0
- 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/EvaluationAggregationQuery.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/ExternalContactsApi.md +285 -9
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FacebookIntegrationUpdateRequest.md +14 -0
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowAggregationQuery.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowOutcomeListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GenericSAML.md +1 -1
- data/docs/GoogleDialogflowCustomSettings.md +13 -0
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/HistoricalAdherenceActuals.md +15 -0
- data/docs/HistoricalAdherenceDayMetrics.md +23 -0
- data/docs/HistoricalAdherenceExceptionInfo.md +21 -0
- data/docs/HistoricalAdherenceQueryResult.md +21 -0
- data/docs/IVREntityListing.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JourneyAggregateDataContainer.md +14 -0
- data/docs/JourneyAggregateQueryClause.md +14 -0
- data/docs/JourneyAggregateQueryFilter.md +15 -0
- data/docs/JourneyAggregateQueryPredicate.md +17 -0
- data/docs/JourneyAggregateQueryResponse.md +13 -0
- data/docs/JourneyAggregationQuery.md +21 -0
- data/docs/JourneyAggregationView.md +16 -0
- data/docs/JourneyApi.md +78 -0
- data/docs/JsonNode.md +5 -5
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/KnowledgeSearchRequest.md +3 -3
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguageUnderstandingApi.md +165 -31
- 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/ListItemComponent.md +19 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/Message.md +1 -0
- data/docs/MessageContent.md +19 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingCampaign.md +28 -0
- data/docs/MessagingCampaignDivisionView.md +16 -0
- data/docs/MessagingCampaignDivisionViewEntityListing.md +22 -0
- data/docs/MessagingCampaignEntityListing.md +22 -0
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/NluDomainListing.md +1 -1
- data/docs/NluDomainVersion.md +2 -1
- data/docs/NluDomainVersionListing.md +1 -1
- data/docs/NluFeedbackListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationTemplateBody.md +14 -0
- data/docs/NotificationTemplateFooter.md +13 -0
- data/docs/NotificationTemplateHeader.md +16 -0
- data/docs/NotificationTemplateParameter.md +14 -0
- data/docs/NotificationsApi.md +1 -1
- data/docs/OAuthClient.md +1 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthClientListing.md +1 -0
- data/docs/OAuthClientRequest.md +1 -0
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/ObservationValue.md +3 -1
- data/docs/OrgOAuthClient.md +1 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +881 -76
- 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/PhoneCapabilities.md +1 -0
- 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/PostTextMessage.md +15 -0
- data/docs/PostTextRequest.md +23 -0
- data/docs/PostTextResponse.md +20 -0
- data/docs/PresenceApi.md +206 -6
- data/docs/PresenceExpand.md +17 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueConversationEventTopicAfterCallWork.md +15 -0
- data/docs/QueueConversationEventTopicCall.md +1 -0
- data/docs/QueueConversationEventTopicCallback.md +1 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationEventTopicEmail.md +1 -0
- data/docs/QueueConversationEventTopicMessage.md +2 -0
- data/docs/QueueConversationEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationEventTopicVideo.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicAfterCallWork.md +15 -0
- data/docs/QueueConversationSocialExpressionEventTopicCall.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCallback.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicMessage.md +2 -0
- data/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicVideo.md +1 -0
- data/docs/QueueConversationVideoEventTopicAfterCallWork.md +15 -0
- data/docs/QueueConversationVideoEventTopicCall.md +1 -0
- data/docs/QueueConversationVideoEventTopicCallback.md +1 -0
- data/docs/QueueConversationVideoEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicCobrowse.md +1 -0
- data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
- data/docs/QueueConversationVideoEventTopicMessage.md +2 -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/RecipientListing.md +1 -1
- data/docs/Recording.md +1 -0
- data/docs/RecordingApi.md +2 -2
- 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/ReportingDataExportTopicDataExportNotification.md +1 -0
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ReportingExportJobRequest.md +2 -0
- data/docs/ReportingExportJobResponse.md +3 -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 +13 -13
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +92 -104
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimConfigResourceType.md +2 -2
- data/docs/ScimGenesysUserExternalId.md +14 -0
- data/docs/ScimMetadata.md +2 -2
- data/docs/ScimUserExtensions.md +3 -2
- data/docs/ScimUserRole.md +1 -1
- data/docs/ScimUserRoutingLanguage.md +2 -2
- data/docs/ScimUserRoutingSkill.md +2 -2
- data/docs/ScimV2CreateUser.md +3 -3
- data/docs/ScimV2Group.md +1 -1
- data/docs/ScimV2SchemaAttribute.md +11 -11
- data/docs/ScimV2SchemaDefinition.md +5 -5
- data/docs/ScimV2SchemaListResponse.md +1 -1
- data/docs/ScimV2User.md +4 -4
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/Screenshare.md +1 -0
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SearchApi.md +3 -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/SmsConfig.md +15 -0
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/SmsPhoneNumberRef.md +14 -0
- data/docs/SocialExpression.md +1 -0
- data/docs/SpeechTextAnalyticsApi.md +81 -0
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SurveyAggregationQuery.md +1 -1
- data/docs/SurveyForm.md +0 -2
- 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/TelephonyProvidersEdgeApi.md +6 -2
- data/docs/TextMessageListing.md +1 -1
- data/docs/TextbotsApi.md +78 -0
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TranscriptUrl.md +13 -0
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TtsEngineEntityListing.md +1 -1
- data/docs/TtsVoiceEntityListing.md +1 -1
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UpdateCoachingAppointmentRequest.md +2 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserAggregationQuery.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/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserRoutingLanguage.md +3 -3
- data/docs/UserRoutingLanguagePost.md +1 -1
- data/docs/UserRoutingSkill.md +1 -1
- data/docs/UserSearchRequest.md +1 -0
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +17 -5
- data/docs/Video.md +1 -0
- data/docs/ViewFilter.md +4 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/VoicemailMessagesTopicOwner.md +13 -0
- data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +14 -0
- data/docs/VoicemailMessagesTopicVoicemailMessage.md +2 -0
- data/docs/VoicemailUserPolicy.md +1 -0
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +23 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +24 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +15 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +17 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +14 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +13 -0
- data/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +15 -0
- data/docs/WfmBusinessUnitReference.md +14 -0
- data/docs/WfmHistoricalAdherenceResponse.md +1 -0
- data/docs/WfmHistoricalAdherenceResultWrapper.md +15 -0
- data/docs/WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.md +13 -0
- data/docs/WfmHistoricalDataUploadRequestStatusTopicDateTime.md +16 -0
- data/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md +20 -0
- data/docs/WfmScheduleReference.md +16 -0
- data/docs/WhatsAppIntegrationEntityListing.md +1 -1
- data/docs/WorkforceManagementApi.md +3 -3
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +74 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +67 -2
- data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -6
- data/lib/purecloudplatformclientv2/api/audit_api.rb +74 -0
- data/lib/purecloudplatformclientv2/api/coaching_api.rb +28 -9
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +79 -4
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +305 -13
- data/lib/purecloudplatformclientv2/api/journey_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/language_understanding_api.rb +191 -32
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +1215 -155
- data/lib/purecloudplatformclientv2/api/presence_api.rb +213 -8
- data/lib/purecloudplatformclientv2/api/recording_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api/scim_api.rb +74 -74
- data/lib/purecloudplatformclientv2/api/search_api.rb +13 -0
- data/lib/purecloudplatformclientv2/api/speech_text_analytics_api.rb +102 -0
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/textbots_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +78 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +6 -6
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/after_call_work.rb +267 -0
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/amazon_lex_request.rb +232 -0
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +124 -4
- data/lib/purecloudplatformclientv2/models/array_node.rb +51 -51
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +6 -6
- data/lib/purecloudplatformclientv2/models/audit_query_entity.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_execution_status_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_query_service.rb +2 -2
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_request.rb +360 -0
- data/lib/purecloudplatformclientv2/models/audit_realtime_query_results_response.rb +303 -0
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/available_topic.rb +32 -4
- data/lib/purecloudplatformclientv2/models/biography.rb +32 -4
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +70 -4
- data/lib/purecloudplatformclientv2/models/button_component.rb +281 -0
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- 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 +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/coaching_annotation_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/coaching_appointment_response_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/coaching_notification.rb +1 -1
- data/lib/purecloudplatformclientv2/models/coaching_notification_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowsesession.rb +30 -4
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/common_campaign.rb +320 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_division_view.rb +320 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_division_view_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/common_campaign_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact.rb +29 -4
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/content_actions.rb +309 -0
- data/lib/purecloudplatformclientv2/models/content_attachment.rb +378 -0
- data/lib/purecloudplatformclientv2/models/content_generic.rb +361 -0
- data/lib/purecloudplatformclientv2/models/content_list.rb +375 -0
- data/lib/purecloudplatformclientv2/models/content_location.rb +307 -0
- data/lib/purecloudplatformclientv2/models/content_notification_template.rb +312 -0
- data/lib/purecloudplatformclientv2/models/content_quick_reply.rb +300 -0
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_association.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat.rb +30 -4
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_after_call_work.rb +265 -0
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_callback.rb +26 -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 +51 -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/create_coaching_appointment_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cursor_contact_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/cursor_note_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/cursor_organization_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/cursor_relationship_listing.rb +278 -0
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group.rb +27 -1
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/education.rb +304 -0
- data/lib/purecloudplatformclientv2/models/email.rb +30 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_update_request.rb +228 -0
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/generic_saml.rb +12 -12
- data/lib/purecloudplatformclientv2/models/google_dialogflow_custom_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/historical_adherence_actuals.rb +268 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_day_metrics.rb +462 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_exception_info.rb +466 -0
- data/lib/purecloudplatformclientv2/models/historical_adherence_query_result.rb +430 -0
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/intent_feedback.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/journey_aggregate_data_container.rb +231 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_clause.rb +254 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_filter.rb +277 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_predicate.rb +348 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregate_query_response.rb +203 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregation_query.rb +435 -0
- data/lib/purecloudplatformclientv2/models/journey_aggregation_view.rb +323 -0
- data/lib/purecloudplatformclientv2/models/json_node.rb +51 -51
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/knowledge_search_request.rb +0 -15
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library.rb +2 -2
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/list_item_component.rb +373 -0
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message.rb +30 -4
- data/lib/purecloudplatformclientv2/models/message_content.rb +378 -0
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_campaign.rb +621 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view.rb +279 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_campaign_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/nlu_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/nlu_domain_version.rb +32 -1
- data/lib/purecloudplatformclientv2/models/nlu_domain_version_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/nlu_feedback_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/notification_template_body.rb +236 -0
- data/lib/purecloudplatformclientv2/models/notification_template_footer.rb +203 -0
- data/lib/purecloudplatformclientv2/models/notification_template_header.rb +302 -0
- data/lib/purecloudplatformclientv2/models/notification_template_parameter.rb +234 -0
- data/lib/purecloudplatformclientv2/models/o_auth_client.rb +41 -1
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +41 -1
- data/lib/purecloudplatformclientv2/models/o_auth_client_request.rb +44 -4
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/observation_value.rb +70 -2
- data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +41 -1
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_capabilities.rb +29 -4
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/post_text_message.rb +275 -0
- data/lib/purecloudplatformclientv2/models/post_text_request.rb +482 -0
- data/lib/purecloudplatformclientv2/models/post_text_response.rb +413 -0
- data/lib/purecloudplatformclientv2/models/presence_expand.rb +309 -0
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_after_call_work.rb +265 -0
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_callback.rb +26 -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 +51 -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_after_call_work.rb +265 -0
- 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 +26 -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 +51 -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_after_call_work.rb +265 -0
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_callback.rb +26 -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 +51 -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 +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording.rb +41 -1
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +31 -4
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +53 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +78 -1
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_generation_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_genesys_user_external_id.rb +229 -0
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +35 -7
- data/lib/purecloudplatformclientv2/models/scim_user_role.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +3 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +1 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +6 -6
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +4 -3
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/screenshare.rb +30 -4
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_config.rb +269 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number_ref.rb +232 -0
- data/lib/purecloudplatformclientv2/models/social_expression.rb +30 -4
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/survey_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/survey_form.rb +1 -53
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/transcript_url.rb +202 -0
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/update_coaching_appointment_request.rb +45 -5
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_routing_language.rb +4 -4
- data/lib/purecloudplatformclientv2/models/user_routing_language_post.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_routing_skill.rb +1 -1
- data/lib/purecloudplatformclientv2/models/user_search_request.rb +44 -4
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/video.rb +30 -4
- data/lib/purecloudplatformclientv2/models/view_filter.rb +114 -4
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_owner.rb +201 -0
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_copy_record.rb +226 -0
- data/lib/purecloudplatformclientv2/models/voicemail_messages_topic_voicemail_message.rb +56 -4
- data/lib/purecloudplatformclientv2/models/voicemail_user_policy.rb +30 -4
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wem_coaching_appointment_topic_coaching_appointment_notification.rb +4 -4
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_forecast_modification.rb +497 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast.rb +494 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_bu_short_term_forecast_notification.rb +265 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_forecast_source_day_pointer.rb +315 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_modification_interval_offset_value.rb +226 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_user_reference.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_bu_short_term_forecast_import_complete_topic_wfm_versioned_entity_metadata.rb +251 -0
- data/lib/purecloudplatformclientv2/models/wfm_business_unit_reference.rb +228 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_response.rb +27 -1
- data/lib/purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper.rb +258 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_purge_request_status_topic_historical_data_upload_purge_request_update.rb +215 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time.rb +276 -0
- data/lib/purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update.rb +390 -0
- data/lib/purecloudplatformclientv2/models/wfm_schedule_reference.rb +280 -0
- data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +151 -3
|
@@ -309,9 +309,9 @@ module PureCloud
|
|
|
309
309
|
end
|
|
310
310
|
|
|
311
311
|
# Get a user's Presence
|
|
312
|
-
#
|
|
312
|
+
# Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources.
|
|
313
313
|
# @param user_id user Id
|
|
314
|
-
# @param source_id
|
|
314
|
+
# @param source_id Presence source ID
|
|
315
315
|
# @param [Hash] opts the optional parameters
|
|
316
316
|
# @return [UserPresence]
|
|
317
317
|
def get_user_presence(user_id, source_id, opts = {})
|
|
@@ -320,9 +320,9 @@ module PureCloud
|
|
|
320
320
|
end
|
|
321
321
|
|
|
322
322
|
# Get a user's Presence
|
|
323
|
-
#
|
|
323
|
+
# Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources.
|
|
324
324
|
# @param user_id user Id
|
|
325
|
-
# @param source_id
|
|
325
|
+
# @param source_id Presence source ID
|
|
326
326
|
# @param [Hash] opts the optional parameters
|
|
327
327
|
# @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
|
|
328
328
|
def get_user_presence_with_http_info(user_id, source_id, opts = {})
|
|
@@ -383,10 +383,140 @@ module PureCloud
|
|
|
383
383
|
return data, status_code, headers
|
|
384
384
|
end
|
|
385
385
|
|
|
386
|
+
# Get a user's Microsoft Teams presence.
|
|
387
|
+
# Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
388
|
+
# @param user_id user Id
|
|
389
|
+
# @param [Hash] opts the optional parameters
|
|
390
|
+
# @return [PresenceExpand]
|
|
391
|
+
def get_user_presences_microsoftteams(user_id, opts = {})
|
|
392
|
+
data, _status_code, _headers = get_user_presences_microsoftteams_with_http_info(user_id, opts)
|
|
393
|
+
return data
|
|
394
|
+
end
|
|
395
|
+
|
|
396
|
+
# Get a user's Microsoft Teams presence.
|
|
397
|
+
# Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
398
|
+
# @param user_id user Id
|
|
399
|
+
# @param [Hash] opts the optional parameters
|
|
400
|
+
# @return [Array<(PresenceExpand, Fixnum, Hash)>] PresenceExpand data, response status code and response headers
|
|
401
|
+
def get_user_presences_microsoftteams_with_http_info(user_id, opts = {})
|
|
402
|
+
if @api_client.config.debugging
|
|
403
|
+
@api_client.config.logger.debug "Calling API: PresenceApi.get_user_presences_microsoftteams ..."
|
|
404
|
+
end
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
# verify the required parameter 'user_id' is set
|
|
408
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling PresenceApi.get_user_presences_microsoftteams" if user_id.nil?
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
# resource path
|
|
415
|
+
local_var_path = "/api/v2/users/{userId}/presences/microsoftteams".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
|
416
|
+
|
|
417
|
+
# query parameters
|
|
418
|
+
query_params = {}
|
|
419
|
+
|
|
420
|
+
# header parameters
|
|
421
|
+
header_params = {}
|
|
422
|
+
|
|
423
|
+
# HTTP header 'Accept' (if needed)
|
|
424
|
+
local_header_accept = ['application/json']
|
|
425
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
426
|
+
|
|
427
|
+
# HTTP header 'Content-Type'
|
|
428
|
+
local_header_content_type = ['application/json']
|
|
429
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
430
|
+
|
|
431
|
+
# form parameters
|
|
432
|
+
form_params = {}
|
|
433
|
+
|
|
434
|
+
# http body (model)
|
|
435
|
+
post_body = nil
|
|
436
|
+
|
|
437
|
+
auth_names = ['PureCloud OAuth']
|
|
438
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
439
|
+
:header_params => header_params,
|
|
440
|
+
:query_params => query_params,
|
|
441
|
+
:form_params => form_params,
|
|
442
|
+
:body => post_body,
|
|
443
|
+
:auth_names => auth_names,
|
|
444
|
+
:return_type => 'PresenceExpand')
|
|
445
|
+
if @api_client.config.debugging
|
|
446
|
+
@api_client.config.logger.debug "API called: PresenceApi#get_user_presences_microsoftteams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
447
|
+
end
|
|
448
|
+
return data, status_code, headers
|
|
449
|
+
end
|
|
450
|
+
|
|
451
|
+
# Get a user's Genesys Cloud presence.
|
|
452
|
+
# Get the default Genesys Cloud user presence source PURECLOUD
|
|
453
|
+
# @param user_id user Id
|
|
454
|
+
# @param [Hash] opts the optional parameters
|
|
455
|
+
# @return [UserPresence]
|
|
456
|
+
def get_user_presences_purecloud(user_id, opts = {})
|
|
457
|
+
data, _status_code, _headers = get_user_presences_purecloud_with_http_info(user_id, opts)
|
|
458
|
+
return data
|
|
459
|
+
end
|
|
460
|
+
|
|
461
|
+
# Get a user's Genesys Cloud presence.
|
|
462
|
+
# Get the default Genesys Cloud user presence source PURECLOUD
|
|
463
|
+
# @param user_id user Id
|
|
464
|
+
# @param [Hash] opts the optional parameters
|
|
465
|
+
# @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
|
|
466
|
+
def get_user_presences_purecloud_with_http_info(user_id, opts = {})
|
|
467
|
+
if @api_client.config.debugging
|
|
468
|
+
@api_client.config.logger.debug "Calling API: PresenceApi.get_user_presences_purecloud ..."
|
|
469
|
+
end
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
# verify the required parameter 'user_id' is set
|
|
473
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling PresenceApi.get_user_presences_purecloud" if user_id.nil?
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
# resource path
|
|
480
|
+
local_var_path = "/api/v2/users/{userId}/presences/purecloud".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
|
481
|
+
|
|
482
|
+
# query parameters
|
|
483
|
+
query_params = {}
|
|
484
|
+
|
|
485
|
+
# header parameters
|
|
486
|
+
header_params = {}
|
|
487
|
+
|
|
488
|
+
# HTTP header 'Accept' (if needed)
|
|
489
|
+
local_header_accept = ['application/json']
|
|
490
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
491
|
+
|
|
492
|
+
# HTTP header 'Content-Type'
|
|
493
|
+
local_header_content_type = ['application/json']
|
|
494
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
495
|
+
|
|
496
|
+
# form parameters
|
|
497
|
+
form_params = {}
|
|
498
|
+
|
|
499
|
+
# http body (model)
|
|
500
|
+
post_body = nil
|
|
501
|
+
|
|
502
|
+
auth_names = ['PureCloud OAuth']
|
|
503
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
504
|
+
:header_params => header_params,
|
|
505
|
+
:query_params => query_params,
|
|
506
|
+
:form_params => form_params,
|
|
507
|
+
:body => post_body,
|
|
508
|
+
:auth_names => auth_names,
|
|
509
|
+
:return_type => 'UserPresence')
|
|
510
|
+
if @api_client.config.debugging
|
|
511
|
+
@api_client.config.logger.debug "API called: PresenceApi#get_user_presences_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
512
|
+
end
|
|
513
|
+
return data, status_code, headers
|
|
514
|
+
end
|
|
515
|
+
|
|
386
516
|
# Patch a user's Presence
|
|
387
|
-
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
517
|
+
# Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
388
518
|
# @param user_id user Id
|
|
389
|
-
# @param source_id
|
|
519
|
+
# @param source_id Presence source ID
|
|
390
520
|
# @param body User presence
|
|
391
521
|
# @param [Hash] opts the optional parameters
|
|
392
522
|
# @return [UserPresence]
|
|
@@ -396,9 +526,9 @@ module PureCloud
|
|
|
396
526
|
end
|
|
397
527
|
|
|
398
528
|
# Patch a user's Presence
|
|
399
|
-
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
529
|
+
# Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
400
530
|
# @param user_id user Id
|
|
401
|
-
# @param source_id
|
|
531
|
+
# @param source_id Presence source ID
|
|
402
532
|
# @param body User presence
|
|
403
533
|
# @param [Hash] opts the optional parameters
|
|
404
534
|
# @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
|
|
@@ -468,6 +598,81 @@ module PureCloud
|
|
|
468
598
|
return data, status_code, headers
|
|
469
599
|
end
|
|
470
600
|
|
|
601
|
+
# Patch a Genesys Cloud user's presence
|
|
602
|
+
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
603
|
+
# @param user_id user Id
|
|
604
|
+
# @param body User presence
|
|
605
|
+
# @param [Hash] opts the optional parameters
|
|
606
|
+
# @return [UserPresence]
|
|
607
|
+
def patch_user_presences_purecloud(user_id, body, opts = {})
|
|
608
|
+
data, _status_code, _headers = patch_user_presences_purecloud_with_http_info(user_id, body, opts)
|
|
609
|
+
return data
|
|
610
|
+
end
|
|
611
|
+
|
|
612
|
+
# Patch a Genesys Cloud user's presence
|
|
613
|
+
# The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
614
|
+
# @param user_id user Id
|
|
615
|
+
# @param body User presence
|
|
616
|
+
# @param [Hash] opts the optional parameters
|
|
617
|
+
# @return [Array<(UserPresence, Fixnum, Hash)>] UserPresence data, response status code and response headers
|
|
618
|
+
def patch_user_presences_purecloud_with_http_info(user_id, body, opts = {})
|
|
619
|
+
if @api_client.config.debugging
|
|
620
|
+
@api_client.config.logger.debug "Calling API: PresenceApi.patch_user_presences_purecloud ..."
|
|
621
|
+
end
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
# verify the required parameter 'user_id' is set
|
|
625
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling PresenceApi.patch_user_presences_purecloud" if user_id.nil?
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
# verify the required parameter 'body' is set
|
|
633
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling PresenceApi.patch_user_presences_purecloud" if body.nil?
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
# resource path
|
|
640
|
+
local_var_path = "/api/v2/users/{userId}/presences/purecloud".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
|
641
|
+
|
|
642
|
+
# query parameters
|
|
643
|
+
query_params = {}
|
|
644
|
+
|
|
645
|
+
# header parameters
|
|
646
|
+
header_params = {}
|
|
647
|
+
|
|
648
|
+
# HTTP header 'Accept' (if needed)
|
|
649
|
+
local_header_accept = ['application/json']
|
|
650
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
|
651
|
+
|
|
652
|
+
# HTTP header 'Content-Type'
|
|
653
|
+
local_header_content_type = ['application/json']
|
|
654
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
|
655
|
+
|
|
656
|
+
# form parameters
|
|
657
|
+
form_params = {}
|
|
658
|
+
|
|
659
|
+
# http body (model)
|
|
660
|
+
post_body = @api_client.object_to_http_body(body)
|
|
661
|
+
|
|
662
|
+
auth_names = ['PureCloud OAuth']
|
|
663
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
|
664
|
+
:header_params => header_params,
|
|
665
|
+
:query_params => query_params,
|
|
666
|
+
:form_params => form_params,
|
|
667
|
+
:body => post_body,
|
|
668
|
+
:auth_names => auth_names,
|
|
669
|
+
:return_type => 'UserPresence')
|
|
670
|
+
if @api_client.config.debugging
|
|
671
|
+
@api_client.config.logger.debug "API called: PresenceApi#patch_user_presences_purecloud\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
672
|
+
end
|
|
673
|
+
return data, status_code, headers
|
|
674
|
+
end
|
|
675
|
+
|
|
471
676
|
# Create a Presence Definition
|
|
472
677
|
#
|
|
473
678
|
# @param body The Presence Definition to create
|
|
@@ -684,7 +684,7 @@ module PureCloud
|
|
|
684
684
|
#
|
|
685
685
|
# @param conversation_id Conversation ID
|
|
686
686
|
# @param [Hash] opts the optional parameters
|
|
687
|
-
# @return [Array<
|
|
687
|
+
# @return [Array<RecordingMetadata>]
|
|
688
688
|
def get_conversation_recordingmetadata(conversation_id, opts = {})
|
|
689
689
|
data, _status_code, _headers = get_conversation_recordingmetadata_with_http_info(conversation_id, opts)
|
|
690
690
|
return data
|
|
@@ -694,7 +694,7 @@ module PureCloud
|
|
|
694
694
|
#
|
|
695
695
|
# @param conversation_id Conversation ID
|
|
696
696
|
# @param [Hash] opts the optional parameters
|
|
697
|
-
# @return [Array<(Array<
|
|
697
|
+
# @return [Array<(Array<RecordingMetadata>, Fixnum, Hash)>] Array<RecordingMetadata> data, response status code and response headers
|
|
698
698
|
def get_conversation_recordingmetadata_with_http_info(conversation_id, opts = {})
|
|
699
699
|
if @api_client.config.debugging
|
|
700
700
|
@api_client.config.logger.debug "Calling API: RecordingApi.get_conversation_recordingmetadata ..."
|
|
@@ -738,7 +738,7 @@ module PureCloud
|
|
|
738
738
|
:form_params => form_params,
|
|
739
739
|
:body => post_body,
|
|
740
740
|
:auth_names => auth_names,
|
|
741
|
-
:return_type => 'Array<
|
|
741
|
+
:return_type => 'Array<RecordingMetadata>')
|
|
742
742
|
if @api_client.config.debugging
|
|
743
743
|
@api_client.config.logger.debug "API called: RecordingApi#get_conversation_recordingmetadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
744
744
|
end
|
|
@@ -24,22 +24,22 @@ module PureCloud
|
|
|
24
24
|
@api_client = api_client
|
|
25
25
|
end
|
|
26
26
|
|
|
27
|
-
# Delete a group
|
|
27
|
+
# Delete a group
|
|
28
28
|
#
|
|
29
|
-
# @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
29
|
+
# @param group_id The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
|
|
30
30
|
# @param [Hash] opts the optional parameters
|
|
31
|
-
# @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
31
|
+
# @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
32
32
|
# @return [nil]
|
|
33
33
|
def delete_scim_group(group_id, opts = {})
|
|
34
34
|
delete_scim_group_with_http_info(group_id, opts)
|
|
35
35
|
return nil
|
|
36
36
|
end
|
|
37
37
|
|
|
38
|
-
# Delete a group
|
|
38
|
+
# Delete a group
|
|
39
39
|
#
|
|
40
|
-
# @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
40
|
+
# @param group_id The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
|
|
41
41
|
# @param [Hash] opts the optional parameters
|
|
42
|
-
# @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
42
|
+
# @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
43
43
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
44
44
|
def delete_scim_group_with_http_info(group_id, opts = {})
|
|
45
45
|
if @api_client.config.debugging
|
|
@@ -171,22 +171,22 @@ module PureCloud
|
|
|
171
171
|
return data, status_code, headers
|
|
172
172
|
end
|
|
173
173
|
|
|
174
|
-
# Delete a group
|
|
174
|
+
# Delete a group
|
|
175
175
|
#
|
|
176
|
-
# @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
176
|
+
# @param group_id The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
|
|
177
177
|
# @param [Hash] opts the optional parameters
|
|
178
|
-
# @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
178
|
+
# @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
179
179
|
# @return [nil]
|
|
180
180
|
def delete_scim_v2_group(group_id, opts = {})
|
|
181
181
|
delete_scim_v2_group_with_http_info(group_id, opts)
|
|
182
182
|
return nil
|
|
183
183
|
end
|
|
184
184
|
|
|
185
|
-
# Delete a group
|
|
185
|
+
# Delete a group
|
|
186
186
|
#
|
|
187
|
-
# @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
187
|
+
# @param group_id The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
|
|
188
188
|
# @param [Hash] opts the optional parameters
|
|
189
|
-
# @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
189
|
+
# @option opts [String] :if_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId} or GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
190
190
|
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
191
191
|
def delete_scim_v2_group_with_http_info(group_id, opts = {})
|
|
192
192
|
if @api_client.config.debugging
|
|
@@ -323,7 +323,7 @@ module PureCloud
|
|
|
323
323
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
324
324
|
# @param [Hash] opts the optional parameters
|
|
325
325
|
# @option opts [Array<String>] :attributes 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.
|
|
326
|
-
# @option opts [Array<String>] :excluded_attributes 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'
|
|
326
|
+
# @option opts [Array<String>] :excluded_attributes 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.
|
|
327
327
|
# @option opts [String] :if_none_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. 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.
|
|
328
328
|
# @return [ScimV2Group]
|
|
329
329
|
def get_scim_group(group_id, opts = {})
|
|
@@ -336,7 +336,7 @@ module PureCloud
|
|
|
336
336
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
337
337
|
# @param [Hash] opts the optional parameters
|
|
338
338
|
# @option opts [Array<String>] :attributes 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.
|
|
339
|
-
# @option opts [Array<String>] :excluded_attributes 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'
|
|
339
|
+
# @option opts [Array<String>] :excluded_attributes 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.
|
|
340
340
|
# @option opts [String] :if_none_match The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. 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.
|
|
341
341
|
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
|
342
342
|
def get_scim_group_with_http_info(group_id, opts = {})
|
|
@@ -414,10 +414,10 @@ module PureCloud
|
|
|
414
414
|
#
|
|
415
415
|
# @param [Hash] opts the optional parameters
|
|
416
416
|
# @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
|
|
417
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". (default to 25)
|
|
417
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. 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) (default to 25)
|
|
418
418
|
# @option opts [Array<String>] :attributes 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.
|
|
419
|
-
# @option opts [Array<String>] :excluded_attributes 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'
|
|
420
|
-
# @option opts [String] :filter Filters results.
|
|
419
|
+
# @option opts [Array<String>] :excluded_attributes 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.
|
|
420
|
+
# @option opts [String] :filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
421
421
|
# @return [ScimGroupListResponse]
|
|
422
422
|
def get_scim_groups(opts = {})
|
|
423
423
|
data, _status_code, _headers = get_scim_groups_with_http_info(opts)
|
|
@@ -428,10 +428,10 @@ module PureCloud
|
|
|
428
428
|
#
|
|
429
429
|
# @param [Hash] opts the optional parameters
|
|
430
430
|
# @option opts [Integer] :start_index The 1-based index of the first query result.
|
|
431
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
431
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. 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)
|
|
432
432
|
# @option opts [Array<String>] :attributes 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.
|
|
433
|
-
# @option opts [Array<String>] :excluded_attributes 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'
|
|
434
|
-
# @option opts [String] :filter Filters results.
|
|
433
|
+
# @option opts [Array<String>] :excluded_attributes 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.
|
|
434
|
+
# @option opts [String] :filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
435
435
|
# @return [Array<(ScimGroupListResponse, Fixnum, Hash)>] ScimGroupListResponse data, response status code and response headers
|
|
436
436
|
def get_scim_groups_with_http_info(opts = {})
|
|
437
437
|
if @api_client.config.debugging
|
|
@@ -635,21 +635,21 @@ module PureCloud
|
|
|
635
635
|
return data, status_code, headers
|
|
636
636
|
end
|
|
637
637
|
|
|
638
|
-
# Get
|
|
638
|
+
# Get a SCIM schema
|
|
639
639
|
#
|
|
640
|
-
# @param schema_id The ID of a schema.
|
|
640
|
+
# @param schema_id The ID of a schema. Returned with GET /api/v2/scim/schemas.
|
|
641
641
|
# @param [Hash] opts the optional parameters
|
|
642
|
-
# @return [
|
|
642
|
+
# @return [ScimV2SchemaDefinition]
|
|
643
643
|
def get_scim_schema(schema_id, opts = {})
|
|
644
644
|
data, _status_code, _headers = get_scim_schema_with_http_info(schema_id, opts)
|
|
645
645
|
return data
|
|
646
646
|
end
|
|
647
647
|
|
|
648
|
-
# Get
|
|
648
|
+
# Get a SCIM schema
|
|
649
649
|
#
|
|
650
|
-
# @param schema_id The ID of a schema.
|
|
650
|
+
# @param schema_id The ID of a schema. Returned with GET /api/v2/scim/schemas.
|
|
651
651
|
# @param [Hash] opts the optional parameters
|
|
652
|
-
# @return [Array<(
|
|
652
|
+
# @return [Array<(ScimV2SchemaDefinition, Fixnum, Hash)>] ScimV2SchemaDefinition data, response status code and response headers
|
|
653
653
|
def get_scim_schema_with_http_info(schema_id, opts = {})
|
|
654
654
|
if @api_client.config.debugging
|
|
655
655
|
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_schema ..."
|
|
@@ -698,28 +698,28 @@ module PureCloud
|
|
|
698
698
|
:form_params => form_params,
|
|
699
699
|
:body => post_body,
|
|
700
700
|
:auth_names => auth_names,
|
|
701
|
-
:return_type => '
|
|
701
|
+
:return_type => 'ScimV2SchemaDefinition')
|
|
702
702
|
if @api_client.config.debugging
|
|
703
703
|
@api_client.config.logger.debug "API called: SCIMApi#get_scim_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
704
704
|
end
|
|
705
705
|
return data, status_code, headers
|
|
706
706
|
end
|
|
707
707
|
|
|
708
|
-
# Get
|
|
708
|
+
# Get a list of SCIM schemas
|
|
709
709
|
#
|
|
710
710
|
# @param [Hash] opts the optional parameters
|
|
711
|
-
# @option opts [String] :filter Filtered results are invalid and
|
|
712
|
-
# @return [
|
|
711
|
+
# @option opts [String] :filter Filtered results are invalid and return 403 Unauthorized.
|
|
712
|
+
# @return [ScimV2SchemaListResponse]
|
|
713
713
|
def get_scim_schemas(opts = {})
|
|
714
714
|
data, _status_code, _headers = get_scim_schemas_with_http_info(opts)
|
|
715
715
|
return data
|
|
716
716
|
end
|
|
717
717
|
|
|
718
|
-
# Get
|
|
718
|
+
# Get a list of SCIM schemas
|
|
719
719
|
#
|
|
720
720
|
# @param [Hash] opts the optional parameters
|
|
721
|
-
# @option opts [String] :filter Filtered results are invalid and
|
|
722
|
-
# @return [Array<(
|
|
721
|
+
# @option opts [String] :filter Filtered results are invalid and return 403 Unauthorized.
|
|
722
|
+
# @return [Array<(ScimV2SchemaListResponse, Fixnum, Hash)>] ScimV2SchemaListResponse data, response status code and response headers
|
|
723
723
|
def get_scim_schemas_with_http_info(opts = {})
|
|
724
724
|
if @api_client.config.debugging
|
|
725
725
|
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_schemas ..."
|
|
@@ -762,7 +762,7 @@ module PureCloud
|
|
|
762
762
|
:form_params => form_params,
|
|
763
763
|
:body => post_body,
|
|
764
764
|
:auth_names => auth_names,
|
|
765
|
-
:return_type => '
|
|
765
|
+
:return_type => 'ScimV2SchemaListResponse')
|
|
766
766
|
if @api_client.config.debugging
|
|
767
767
|
@api_client.config.logger.debug "API called: SCIMApi#get_scim_schemas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
768
768
|
end
|
|
@@ -926,13 +926,13 @@ module PureCloud
|
|
|
926
926
|
end
|
|
927
927
|
|
|
928
928
|
# Get a list of users
|
|
929
|
-
# To return all active users, do not use
|
|
929
|
+
# To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
930
930
|
# @param [Hash] opts the optional parameters
|
|
931
931
|
# @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
|
|
932
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". (default to 25)
|
|
932
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. 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) (default to 25)
|
|
933
933
|
# @option opts [Array<String>] :attributes 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.
|
|
934
934
|
# @option opts [Array<String>] :excluded_attributes 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.
|
|
935
|
-
# @option opts [String] :filter 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\".
|
|
935
|
+
# @option opts [String] :filter 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\", \"employeeNumber eq 9876543210\".
|
|
936
936
|
# @return [ScimUserListResponse]
|
|
937
937
|
def get_scim_users(opts = {})
|
|
938
938
|
data, _status_code, _headers = get_scim_users_with_http_info(opts)
|
|
@@ -940,13 +940,13 @@ module PureCloud
|
|
|
940
940
|
end
|
|
941
941
|
|
|
942
942
|
# Get a list of users
|
|
943
|
-
# To return all active users, do not use
|
|
943
|
+
# To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
944
944
|
# @param [Hash] opts the optional parameters
|
|
945
945
|
# @option opts [Integer] :start_index The 1-based index of the first query result.
|
|
946
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
946
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. 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)
|
|
947
947
|
# @option opts [Array<String>] :attributes 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.
|
|
948
948
|
# @option opts [Array<String>] :excluded_attributes 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.
|
|
949
|
-
# @option opts [String] :filter 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\".
|
|
949
|
+
# @option opts [String] :filter 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\", \"employeeNumber eq 9876543210\".
|
|
950
950
|
# @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers
|
|
951
951
|
def get_scim_users_with_http_info(opts = {})
|
|
952
952
|
if @api_client.config.debugging
|
|
@@ -1030,8 +1030,8 @@ module PureCloud
|
|
|
1030
1030
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
1031
1031
|
# @param [Hash] opts the optional parameters
|
|
1032
1032
|
# @option opts [Array<String>] :attributes 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.
|
|
1033
|
-
# @option opts [Array<String>] :excluded_attributes 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'
|
|
1034
|
-
# @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. 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.
|
|
1033
|
+
# @option opts [Array<String>] :excluded_attributes 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.
|
|
1034
|
+
# @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. 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.
|
|
1035
1035
|
# @return [ScimV2Group]
|
|
1036
1036
|
def get_scim_v2_group(group_id, opts = {})
|
|
1037
1037
|
data, _status_code, _headers = get_scim_v2_group_with_http_info(group_id, opts)
|
|
@@ -1043,8 +1043,8 @@ module PureCloud
|
|
|
1043
1043
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
1044
1044
|
# @param [Hash] opts the optional parameters
|
|
1045
1045
|
# @option opts [Array<String>] :attributes 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.
|
|
1046
|
-
# @option opts [Array<String>] :excluded_attributes 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'
|
|
1047
|
-
# @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. 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.
|
|
1046
|
+
# @option opts [Array<String>] :excluded_attributes 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.
|
|
1047
|
+
# @option opts [String] :if_none_match TThe ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. 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.
|
|
1048
1048
|
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
|
1049
1049
|
def get_scim_v2_group_with_http_info(group_id, opts = {})
|
|
1050
1050
|
if @api_client.config.debugging
|
|
@@ -1119,12 +1119,12 @@ module PureCloud
|
|
|
1119
1119
|
|
|
1120
1120
|
# Get a list of groups
|
|
1121
1121
|
#
|
|
1122
|
-
# @param filter Filters results.
|
|
1122
|
+
# @param filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
1123
1123
|
# @param [Hash] opts the optional parameters
|
|
1124
1124
|
# @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
|
|
1125
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". (default to 25)
|
|
1125
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. 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) (default to 25)
|
|
1126
1126
|
# @option opts [Array<String>] :attributes 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.
|
|
1127
|
-
# @option opts [Array<String>] :excluded_attributes 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'
|
|
1127
|
+
# @option opts [Array<String>] :excluded_attributes 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.
|
|
1128
1128
|
# @return [ScimGroupListResponse]
|
|
1129
1129
|
def get_scim_v2_groups(filter, opts = {})
|
|
1130
1130
|
data, _status_code, _headers = get_scim_v2_groups_with_http_info(filter, opts)
|
|
@@ -1133,12 +1133,12 @@ module PureCloud
|
|
|
1133
1133
|
|
|
1134
1134
|
# Get a list of groups
|
|
1135
1135
|
#
|
|
1136
|
-
# @param filter Filters results.
|
|
1136
|
+
# @param filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
1137
1137
|
# @param [Hash] opts the optional parameters
|
|
1138
1138
|
# @option opts [Integer] :start_index The 1-based index of the first query result.
|
|
1139
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
1139
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. 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)
|
|
1140
1140
|
# @option opts [Array<String>] :attributes 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.
|
|
1141
|
-
# @option opts [Array<String>] :excluded_attributes 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'
|
|
1141
|
+
# @option opts [Array<String>] :excluded_attributes 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.
|
|
1142
1142
|
# @return [Array<(ScimGroupListResponse, Fixnum, Hash)>] ScimGroupListResponse data, response status code and response headers
|
|
1143
1143
|
def get_scim_v2_groups_with_http_info(filter, opts = {})
|
|
1144
1144
|
if @api_client.config.debugging
|
|
@@ -1344,9 +1344,9 @@ module PureCloud
|
|
|
1344
1344
|
return data, status_code, headers
|
|
1345
1345
|
end
|
|
1346
1346
|
|
|
1347
|
-
# Get
|
|
1347
|
+
# Get a SCIM schema
|
|
1348
1348
|
#
|
|
1349
|
-
# @param schema_id The ID of a schema.
|
|
1349
|
+
# @param schema_id The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.
|
|
1350
1350
|
# @param [Hash] opts the optional parameters
|
|
1351
1351
|
# @return [ScimV2SchemaDefinition]
|
|
1352
1352
|
def get_scim_v2_schema(schema_id, opts = {})
|
|
@@ -1354,9 +1354,9 @@ module PureCloud
|
|
|
1354
1354
|
return data
|
|
1355
1355
|
end
|
|
1356
1356
|
|
|
1357
|
-
# Get
|
|
1357
|
+
# Get a SCIM schema
|
|
1358
1358
|
#
|
|
1359
|
-
# @param schema_id The ID of a schema.
|
|
1359
|
+
# @param schema_id The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.
|
|
1360
1360
|
# @param [Hash] opts the optional parameters
|
|
1361
1361
|
# @return [Array<(ScimV2SchemaDefinition, Fixnum, Hash)>] ScimV2SchemaDefinition data, response status code and response headers
|
|
1362
1362
|
def get_scim_v2_schema_with_http_info(schema_id, opts = {})
|
|
@@ -1414,20 +1414,20 @@ module PureCloud
|
|
|
1414
1414
|
return data, status_code, headers
|
|
1415
1415
|
end
|
|
1416
1416
|
|
|
1417
|
-
# Get
|
|
1417
|
+
# Get a list of SCIM schemas
|
|
1418
1418
|
#
|
|
1419
1419
|
# @param [Hash] opts the optional parameters
|
|
1420
|
-
# @option opts [String] :filter Filtered results are invalid and
|
|
1420
|
+
# @option opts [String] :filter Filtered results are invalid and return 403 Unauthorized.
|
|
1421
1421
|
# @return [ScimV2SchemaListResponse]
|
|
1422
1422
|
def get_scim_v2_schemas(opts = {})
|
|
1423
1423
|
data, _status_code, _headers = get_scim_v2_schemas_with_http_info(opts)
|
|
1424
1424
|
return data
|
|
1425
1425
|
end
|
|
1426
1426
|
|
|
1427
|
-
# Get
|
|
1427
|
+
# Get a list of SCIM schemas
|
|
1428
1428
|
#
|
|
1429
1429
|
# @param [Hash] opts the optional parameters
|
|
1430
|
-
# @option opts [String] :filter Filtered results are invalid and
|
|
1430
|
+
# @option opts [String] :filter Filtered results are invalid and return 403 Unauthorized.
|
|
1431
1431
|
# @return [Array<(ScimV2SchemaListResponse, Fixnum, Hash)>] ScimV2SchemaListResponse data, response status code and response headers
|
|
1432
1432
|
def get_scim_v2_schemas_with_http_info(opts = {})
|
|
1433
1433
|
if @api_client.config.debugging
|
|
@@ -1635,13 +1635,13 @@ module PureCloud
|
|
|
1635
1635
|
end
|
|
1636
1636
|
|
|
1637
1637
|
# Get a list of users
|
|
1638
|
-
# To return all active users, do not use
|
|
1638
|
+
# To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
1639
1639
|
# @param [Hash] opts the optional parameters
|
|
1640
1640
|
# @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
|
|
1641
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". (default to 25)
|
|
1641
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. 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) (default to 25)
|
|
1642
1642
|
# @option opts [Array<String>] :attributes 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.
|
|
1643
1643
|
# @option opts [Array<String>] :excluded_attributes 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.
|
|
1644
|
-
# @option opts [String] :filter 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\".
|
|
1644
|
+
# @option opts [String] :filter 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\", \"employeeNumber eq 9876543210\".
|
|
1645
1645
|
# @return [ScimUserListResponse]
|
|
1646
1646
|
def get_scim_v2_users(opts = {})
|
|
1647
1647
|
data, _status_code, _headers = get_scim_v2_users_with_http_info(opts)
|
|
@@ -1649,13 +1649,13 @@ module PureCloud
|
|
|
1649
1649
|
end
|
|
1650
1650
|
|
|
1651
1651
|
# Get a list of users
|
|
1652
|
-
# To return all active users, do not use
|
|
1652
|
+
# To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
1653
1653
|
# @param [Hash] opts the optional parameters
|
|
1654
1654
|
# @option opts [Integer] :start_index The 1-based index of the first query result.
|
|
1655
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
1655
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values -- (i.e. 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)
|
|
1656
1656
|
# @option opts [Array<String>] :attributes 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.
|
|
1657
1657
|
# @option opts [Array<String>] :excluded_attributes 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.
|
|
1658
|
-
# @option opts [String] :filter 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\".
|
|
1658
|
+
# @option opts [String] :filter 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\", \"employeeNumber eq 9876543210\".
|
|
1659
1659
|
# @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers
|
|
1660
1660
|
def get_scim_v2_users_with_http_info(opts = {})
|
|
1661
1661
|
if @api_client.config.debugging
|
|
@@ -2070,8 +2070,8 @@ module PureCloud
|
|
|
2070
2070
|
return data, status_code, headers
|
|
2071
2071
|
end
|
|
2072
2072
|
|
|
2073
|
-
#
|
|
2074
|
-
#
|
|
2073
|
+
# Creates a group
|
|
2074
|
+
# Creates a Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
|
|
2075
2075
|
# @param body The information used to create a group.
|
|
2076
2076
|
# @param [Hash] opts the optional parameters
|
|
2077
2077
|
# @return [ScimV2Group]
|
|
@@ -2080,8 +2080,8 @@ module PureCloud
|
|
|
2080
2080
|
return data
|
|
2081
2081
|
end
|
|
2082
2082
|
|
|
2083
|
-
#
|
|
2084
|
-
#
|
|
2083
|
+
# Creates a group
|
|
2084
|
+
# Creates a Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
|
|
2085
2085
|
# @param body The information used to create a group.
|
|
2086
2086
|
# @param [Hash] opts the optional parameters
|
|
2087
2087
|
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
|
@@ -2200,9 +2200,9 @@ module PureCloud
|
|
|
2200
2200
|
return data, status_code, headers
|
|
2201
2201
|
end
|
|
2202
2202
|
|
|
2203
|
-
#
|
|
2204
|
-
#
|
|
2205
|
-
# @param body
|
|
2203
|
+
# Create a group
|
|
2204
|
+
# Creates an \"official\" Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
|
|
2205
|
+
# @param body Creates a group.
|
|
2206
2206
|
# @param [Hash] opts the optional parameters
|
|
2207
2207
|
# @return [ScimV2Group]
|
|
2208
2208
|
def post_scim_v2_groups(body, opts = {})
|
|
@@ -2210,9 +2210,9 @@ module PureCloud
|
|
|
2210
2210
|
return data
|
|
2211
2211
|
end
|
|
2212
2212
|
|
|
2213
|
-
#
|
|
2214
|
-
#
|
|
2215
|
-
# @param body
|
|
2213
|
+
# Create a group
|
|
2214
|
+
# Creates an \"official\" Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
|
|
2215
|
+
# @param body Creates a group.
|
|
2216
2216
|
# @param [Hash] opts the optional parameters
|
|
2217
2217
|
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
|
2218
2218
|
def post_scim_v2_groups_with_http_info(body, opts = {})
|