purecloudplatformclientv2 64.0.0 → 68.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsEvaluation.md +2 -0
- data/docs/ArchitectApi.md +18 -85
- data/docs/ArchitectDependencyTrackingBuildNotificationClient.md +14 -0
- data/docs/ArchitectDependencyTrackingBuildNotificationDependencyTrackingBuildNotification.md +1 -0
- data/docs/ArchitectFlowNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectFlowNotificationClient.md +14 -0
- data/docs/ArchitectFlowOutcomeNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectFlowOutcomeNotificationClient.md +14 -0
- data/docs/ArchitectPromptNotificationArchitectOperation.md +1 -0
- data/docs/ArchitectPromptNotificationClient.md +14 -0
- data/docs/AsyncConversationQuery.md +1 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthorizationApi.md +140 -0
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversation.md +1 -0
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- 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/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ConversationCallEventTopicCallConversation.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/CreateWorkPlan.md +11 -0
- data/docs/CreateWorkPlanActivity.md +2 -0
- data/docs/CreateWorkPlanShift.md +7 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DialogflowAgentSummaryEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListDivisionViewListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/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/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- 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 -0
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FacebookIntegrationEntityListing.md +1 -1
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowOutcomeListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/HomerRecord.md +63 -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/IntegrationType.md +1 -0
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/IpAddressRange.md +15 -0
- data/docs/IpAddressRangeListing.md +13 -0
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LexBotAliasEntityListing.md +1 -1
- data/docs/LexBotEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationAddressVerificationDetails.md +16 -0
- data/docs/LocationCreateUpdateDefinition.md +6 -6
- data/docs/LocationDefinition.md +12 -9
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationsApi.md +2 -2
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Manager.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingIntegrationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationsApi.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PlanningPeriodSettings.md +14 -0
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueConversationCallEventTopicCallConversation.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/RecordingJobEntityListing.md +1 -1
- data/docs/RecordingJobsQuery.md +1 -1
- data/docs/RecordingMetadata.md +1 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ReportingExportJobRequest.md +1 -0
- data/docs/ReportingExportJobResponse.md +1 -0
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoleDivisionGrants.md +13 -0
- data/docs/RoleDivisionPair.md +14 -0
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +88 -96
- data/docs/SIPSearchPublicRequest.md +22 -0
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchedulingSettings.md +1 -0
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimConfigResourceType.md +7 -7
- data/docs/ScimConfigResourceTypeSchemaExtension.md +2 -2
- data/docs/ScimConfigResourceTypesListResponse.md +2 -2
- data/docs/ScimGroupListResponse.md +2 -2
- data/docs/ScimMetadata.md +2 -2
- data/docs/ScimPhoneNumber.md +1 -1
- data/docs/ScimServiceProviderConfig.md +9 -9
- data/docs/ScimServiceProviderConfigAuthenticationScheme.md +6 -6
- data/docs/ScimServiceProviderConfigBulkFeature.md +3 -3
- data/docs/ScimServiceProviderConfigFilterFeature.md +2 -2
- data/docs/ScimServiceProviderConfigSimpleFeature.md +1 -1
- data/docs/ScimUserListResponse.md +2 -2
- data/docs/ScimV2CreateUser.md +9 -9
- data/docs/ScimV2Group.md +3 -3
- data/docs/ScimV2GroupReference.md +2 -2
- data/docs/ScimV2MemberReference.md +2 -2
- data/docs/ScimV2PatchOperation.md +2 -2
- data/docs/ScimV2PatchRequest.md +2 -2
- data/docs/ScimV2User.md +10 -10
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SearchApi.md +3 -3
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SignedUrlResponse.md +16 -0
- data/docs/SipDownloadResponse.md +14 -0
- data/docs/SipSearchResult.md +20 -0
- data/docs/Site.md +1 -0
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsAddressEntityListing.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SuggestApi.md +2 -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/TelephonyApi.md +223 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeOffRequestLookup.md +13 -0
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrusteeBillingOverview.md +1 -0
- 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/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserDetailsQuery.md +2 -2
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +140 -0
- data/docs/UtilitiesApi.md +59 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmForecastModificationIntervalOffsetValue.md +1 -1
- data/docs/WhatsAppIntegrationEntityListing.md +1 -1
- data/docs/WorkPlan.md +11 -0
- data/docs/WorkPlanActivity.md +2 -0
- data/docs/WorkPlanListItemResponse.md +11 -0
- data/docs/WorkPlanShift.md +7 -0
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +16 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +15 -81
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/notifications_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scim_api.rb +134 -84
- data/lib/purecloudplatformclientv2/api/telephony_api.rb +270 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +157 -0
- data/lib/purecloudplatformclientv2/api/utilities_api.rb +55 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/analytics_evaluation.rb +53 -1
- data/lib/purecloudplatformclientv2/models/analytics_flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_dependency_tracking_build_notification_dependency_tracking_build_notification.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_flow_outcome_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/architect_prompt_notification_architect_operation.rb +26 -1
- data/lib/purecloudplatformclientv2/models/architect_prompt_notification_client.rb +226 -0
- data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +30 -4
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_conversation.rb +27 -1
- 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_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/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_aggregation_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_call_event_topic_call_conversation.rb +29 -4
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/create_work_plan.rb +301 -1
- data/lib/purecloudplatformclientv2/models/create_work_plan_activity.rb +56 -4
- data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +211 -1
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_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/edge_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email_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_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_query.rb +44 -4
- data/lib/purecloudplatformclientv2/models/evaluation_aggregation_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view.rb +2 -2
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/homer_record.rb +1501 -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.rb +29 -1
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ip_address_range.rb +265 -0
- data/lib/purecloudplatformclientv2/models/ip_address_range_listing.rb +203 -0
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_address_verification_details.rb +294 -0
- data/lib/purecloudplatformclientv2/models/location_create_update_definition.rb +56 -51
- data/lib/purecloudplatformclientv2/models/location_definition.rb +110 -34
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/manager.rb +1 -1
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/note_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/planning_period_settings.rb +238 -0
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_conversation_call_event_topic_call_conversation.rb +29 -4
- data/lib/purecloudplatformclientv2/models/queue_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 +27 -1
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/recording_metadata.rb +27 -1
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_data_export_topic_data_export_notification.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +32 -6
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +29 -3
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/role_division_grants.rb +209 -0
- data/lib/purecloudplatformclientv2/models/role_division_pair.rb +238 -0
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scheduling_settings.rb +30 -4
- 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 +7 -7
- data/lib/purecloudplatformclientv2/models/scim_config_resource_type_schema_extension.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_config_resource_types_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_group_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +9 -9
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_authentication_scheme.rb +7 -7
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_bulk_feature.rb +4 -4
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_filter_feature.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config_simple_feature.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_user_list_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +9 -8
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +3 -3
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +2 -1
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +10 -9
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/signed_url_response.rb +279 -0
- data/lib/purecloudplatformclientv2/models/sip_download_response.rb +228 -0
- data/lib/purecloudplatformclientv2/models/{data_table_import_job.rb → sip_search_public_request.rb} +57 -133
- data/lib/purecloudplatformclientv2/models/sip_search_result.rb +386 -0
- data/lib/purecloudplatformclientv2/models/site.rb +26 -1
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_address_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +357 -1
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustee_billing_overview.rb +27 -1
- 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/user_action_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_details_query.rb +52 -51
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_forecast_modification_interval_offset_value.rb +1 -1
- data/lib/purecloudplatformclientv2/models/whats_app_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/work_plan.rb +301 -1
- data/lib/purecloudplatformclientv2/models/work_plan_activity.rb +53 -1
- data/lib/purecloudplatformclientv2/models/work_plan_list_item_response.rb +301 -1
- data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +211 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +34 -4
- data/docs/DataTableImportJob.md +0 -24
|
@@ -361,7 +361,7 @@ module PureCloud
|
|
|
361
361
|
end
|
|
362
362
|
|
|
363
363
|
# Create a new channel
|
|
364
|
-
# There is a limit of
|
|
364
|
+
# There is a limit of 10 channels per user/app combination. Creating an 11th channel will remove the channel with oldest last used date.
|
|
365
365
|
# @param [Hash] opts the optional parameters
|
|
366
366
|
# @return [Channel]
|
|
367
367
|
def post_notifications_channels(opts = {})
|
|
@@ -370,7 +370,7 @@ module PureCloud
|
|
|
370
370
|
end
|
|
371
371
|
|
|
372
372
|
# Create a new channel
|
|
373
|
-
# There is a limit of
|
|
373
|
+
# There is a limit of 10 channels per user/app combination. Creating an 11th channel will remove the channel with oldest last used date.
|
|
374
374
|
# @param [Hash] opts the optional parameters
|
|
375
375
|
# @return [Array<(Channel, Fixnum, Hash)>] Channel data, response status code and response headers
|
|
376
376
|
def post_notifications_channels_with_http_info(opts = {})
|
|
@@ -28,7 +28,7 @@ module PureCloud
|
|
|
28
28
|
#
|
|
29
29
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
|
|
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/users/{userId}. 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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
32
32
|
# @return [Empty]
|
|
33
33
|
def delete_scim_user(user_id, opts = {})
|
|
34
34
|
data, _status_code, _headers = delete_scim_user_with_http_info(user_id, opts)
|
|
@@ -39,7 +39,7 @@ module PureCloud
|
|
|
39
39
|
#
|
|
40
40
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
|
|
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/users/{userId}. 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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
43
43
|
# @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
|
|
44
44
|
def delete_scim_user_with_http_info(user_id, opts = {})
|
|
45
45
|
if @api_client.config.debugging
|
|
@@ -102,7 +102,7 @@ module PureCloud
|
|
|
102
102
|
#
|
|
103
103
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
104
104
|
# @param [Hash] opts the optional parameters
|
|
105
|
-
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
105
|
+
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
106
106
|
# @return [Empty]
|
|
107
107
|
def delete_scim_v2_user(user_id, opts = {})
|
|
108
108
|
data, _status_code, _headers = delete_scim_v2_user_with_http_info(user_id, opts)
|
|
@@ -113,7 +113,7 @@ module PureCloud
|
|
|
113
113
|
#
|
|
114
114
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
115
115
|
# @param [Hash] opts the optional parameters
|
|
116
|
-
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
116
|
+
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
117
117
|
# @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
|
|
118
118
|
def delete_scim_v2_user_with_http_info(user_id, opts = {})
|
|
119
119
|
if @api_client.config.debugging
|
|
@@ -250,7 +250,7 @@ module PureCloud
|
|
|
250
250
|
#
|
|
251
251
|
# @param [Hash] opts the optional parameters
|
|
252
252
|
# @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
|
|
253
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults
|
|
253
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". (default to 25)
|
|
254
254
|
# @option opts [String] :filter Filters results.
|
|
255
255
|
# @return [ScimGroupListResponse]
|
|
256
256
|
def get_scim_groups(opts = {})
|
|
@@ -262,7 +262,7 @@ module PureCloud
|
|
|
262
262
|
#
|
|
263
263
|
# @param [Hash] opts the optional parameters
|
|
264
264
|
# @option opts [Integer] :start_index The 1-based index of the first query result.
|
|
265
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults
|
|
265
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
266
266
|
# @option opts [String] :filter Filters results.
|
|
267
267
|
# @return [Array<(ScimGroupListResponse, Fixnum, Hash)>] ScimGroupListResponse data, response status code and response headers
|
|
268
268
|
def get_scim_groups_with_http_info(opts = {})
|
|
@@ -328,9 +328,9 @@ module PureCloud
|
|
|
328
328
|
return data, status_code, headers
|
|
329
329
|
end
|
|
330
330
|
|
|
331
|
-
# Get
|
|
331
|
+
# Get a resource type
|
|
332
332
|
#
|
|
333
|
-
# @param resource_type The
|
|
333
|
+
# @param resource_type The type of resource. Returned with GET /api/v2/scim/resourcetypes.
|
|
334
334
|
# @param [Hash] opts the optional parameters
|
|
335
335
|
# @return [ScimConfigResourceType]
|
|
336
336
|
def get_scim_resourcetype(resource_type, opts = {})
|
|
@@ -338,9 +338,9 @@ module PureCloud
|
|
|
338
338
|
return data
|
|
339
339
|
end
|
|
340
340
|
|
|
341
|
-
# Get
|
|
341
|
+
# Get a resource type
|
|
342
342
|
#
|
|
343
|
-
# @param resource_type The
|
|
343
|
+
# @param resource_type The type of resource. Returned with GET /api/v2/scim/resourcetypes.
|
|
344
344
|
# @param [Hash] opts the optional parameters
|
|
345
345
|
# @return [Array<(ScimConfigResourceType, Fixnum, Hash)>] ScimConfigResourceType data, response status code and response headers
|
|
346
346
|
def get_scim_resourcetype_with_http_info(resource_type, opts = {})
|
|
@@ -398,38 +398,29 @@ module PureCloud
|
|
|
398
398
|
return data, status_code, headers
|
|
399
399
|
end
|
|
400
400
|
|
|
401
|
-
# Get
|
|
401
|
+
# Get a list of resource types
|
|
402
402
|
#
|
|
403
403
|
# @param [Hash] opts the optional parameters
|
|
404
|
-
# @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
|
|
405
404
|
# @return [ScimConfigResourceTypesListResponse]
|
|
406
405
|
def get_scim_resourcetypes(opts = {})
|
|
407
406
|
data, _status_code, _headers = get_scim_resourcetypes_with_http_info(opts)
|
|
408
407
|
return data
|
|
409
408
|
end
|
|
410
409
|
|
|
411
|
-
# Get
|
|
410
|
+
# Get a list of resource types
|
|
412
411
|
#
|
|
413
412
|
# @param [Hash] opts the optional parameters
|
|
414
|
-
# @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
|
|
415
413
|
# @return [Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>] ScimConfigResourceTypesListResponse data, response status code and response headers
|
|
416
414
|
def get_scim_resourcetypes_with_http_info(opts = {})
|
|
417
415
|
if @api_client.config.debugging
|
|
418
416
|
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_resourcetypes ..."
|
|
419
417
|
end
|
|
420
418
|
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
419
|
# resource path
|
|
428
420
|
local_var_path = "/api/v2/scim/resourcetypes".sub('{format}','json')
|
|
429
421
|
|
|
430
422
|
# query parameters
|
|
431
423
|
query_params = {}
|
|
432
|
-
query_params[:'filter'] = opts[:'filter'] if opts[:'filter']
|
|
433
424
|
|
|
434
425
|
# header parameters
|
|
435
426
|
header_params = {}
|
|
@@ -462,20 +453,20 @@ module PureCloud
|
|
|
462
453
|
return data, status_code, headers
|
|
463
454
|
end
|
|
464
455
|
|
|
465
|
-
# Get
|
|
456
|
+
# Get a service provider's configuration
|
|
466
457
|
#
|
|
467
458
|
# @param [Hash] opts the optional parameters
|
|
468
|
-
# @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/
|
|
459
|
+
# @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/serviceproviderconfig. 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.
|
|
469
460
|
# @return [ScimServiceProviderConfig]
|
|
470
461
|
def get_scim_serviceproviderconfig(opts = {})
|
|
471
462
|
data, _status_code, _headers = get_scim_serviceproviderconfig_with_http_info(opts)
|
|
472
463
|
return data
|
|
473
464
|
end
|
|
474
465
|
|
|
475
|
-
# Get
|
|
466
|
+
# Get a service provider's configuration
|
|
476
467
|
#
|
|
477
468
|
# @param [Hash] opts the optional parameters
|
|
478
|
-
# @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/
|
|
469
|
+
# @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/serviceproviderconfig. 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.
|
|
479
470
|
# @return [Array<(ScimServiceProviderConfig, Fixnum, Hash)>] ScimServiceProviderConfig data, response status code and response headers
|
|
480
471
|
def get_scim_serviceproviderconfig_with_http_info(opts = {})
|
|
481
472
|
if @api_client.config.debugging
|
|
@@ -530,6 +521,8 @@ module PureCloud
|
|
|
530
521
|
#
|
|
531
522
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
|
|
532
523
|
# @param [Hash] opts the optional parameters
|
|
524
|
+
# @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
525
|
+
# @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
533
526
|
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
534
527
|
# @return [ScimV2User]
|
|
535
528
|
def get_scim_user(user_id, opts = {})
|
|
@@ -541,6 +534,8 @@ module PureCloud
|
|
|
541
534
|
#
|
|
542
535
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
|
|
543
536
|
# @param [Hash] opts the optional parameters
|
|
537
|
+
# @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
538
|
+
# @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
544
539
|
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
545
540
|
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
|
546
541
|
def get_scim_user_with_http_info(user_id, opts = {})
|
|
@@ -559,6 +554,18 @@ module PureCloud
|
|
|
559
554
|
|
|
560
555
|
|
|
561
556
|
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
562
569
|
|
|
563
570
|
|
|
564
571
|
|
|
@@ -567,6 +574,8 @@ module PureCloud
|
|
|
567
574
|
|
|
568
575
|
# query parameters
|
|
569
576
|
query_params = {}
|
|
577
|
+
query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
|
|
578
|
+
query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
|
|
570
579
|
|
|
571
580
|
# header parameters
|
|
572
581
|
header_params = {}
|
|
@@ -601,32 +610,46 @@ module PureCloud
|
|
|
601
610
|
end
|
|
602
611
|
|
|
603
612
|
# Get a list of users
|
|
604
|
-
#
|
|
605
|
-
# @param filter Filters results.
|
|
613
|
+
# To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
606
614
|
# @param [Hash] opts the optional parameters
|
|
607
615
|
# @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
|
|
608
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults
|
|
616
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". (default to 25)
|
|
617
|
+
# @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
618
|
+
# @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
619
|
+
# @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\".
|
|
609
620
|
# @return [ScimUserListResponse]
|
|
610
|
-
def get_scim_users(
|
|
611
|
-
data, _status_code, _headers = get_scim_users_with_http_info(
|
|
621
|
+
def get_scim_users(opts = {})
|
|
622
|
+
data, _status_code, _headers = get_scim_users_with_http_info(opts)
|
|
612
623
|
return data
|
|
613
624
|
end
|
|
614
625
|
|
|
615
626
|
# Get a list of users
|
|
616
|
-
#
|
|
617
|
-
# @param filter Filters results.
|
|
627
|
+
# To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
618
628
|
# @param [Hash] opts the optional parameters
|
|
619
629
|
# @option opts [Integer] :start_index The 1-based index of the first query result.
|
|
620
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults
|
|
630
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
631
|
+
# @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
632
|
+
# @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
633
|
+
# @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\".
|
|
621
634
|
# @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers
|
|
622
|
-
def get_scim_users_with_http_info(
|
|
635
|
+
def get_scim_users_with_http_info(opts = {})
|
|
623
636
|
if @api_client.config.debugging
|
|
624
637
|
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_users ..."
|
|
625
638
|
end
|
|
626
639
|
|
|
627
640
|
|
|
628
|
-
|
|
629
|
-
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
|
|
630
653
|
|
|
631
654
|
|
|
632
655
|
|
|
@@ -649,9 +672,11 @@ module PureCloud
|
|
|
649
672
|
|
|
650
673
|
# query parameters
|
|
651
674
|
query_params = {}
|
|
652
|
-
query_params[:'filter'] = filter
|
|
653
675
|
query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
|
|
654
676
|
query_params[:'count'] = opts[:'count'] if opts[:'count']
|
|
677
|
+
query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
|
|
678
|
+
query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
|
|
679
|
+
query_params[:'filter'] = opts[:'filter'] if opts[:'filter']
|
|
655
680
|
|
|
656
681
|
# header parameters
|
|
657
682
|
header_params = {}
|
|
@@ -763,7 +788,7 @@ module PureCloud
|
|
|
763
788
|
# @param filter Filters results.
|
|
764
789
|
# @param [Hash] opts the optional parameters
|
|
765
790
|
# @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
|
|
766
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults
|
|
791
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". (default to 25)
|
|
767
792
|
# @return [ScimGroupListResponse]
|
|
768
793
|
def get_scim_v2_groups(filter, opts = {})
|
|
769
794
|
data, _status_code, _headers = get_scim_v2_groups_with_http_info(filter, opts)
|
|
@@ -775,7 +800,7 @@ module PureCloud
|
|
|
775
800
|
# @param filter Filters results.
|
|
776
801
|
# @param [Hash] opts the optional parameters
|
|
777
802
|
# @option opts [Integer] :start_index The 1-based index of the first query result.
|
|
778
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults
|
|
803
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
779
804
|
# @return [Array<(ScimGroupListResponse, Fixnum, Hash)>] ScimGroupListResponse data, response status code and response headers
|
|
780
805
|
def get_scim_v2_groups_with_http_info(filter, opts = {})
|
|
781
806
|
if @api_client.config.debugging
|
|
@@ -842,9 +867,9 @@ module PureCloud
|
|
|
842
867
|
return data, status_code, headers
|
|
843
868
|
end
|
|
844
869
|
|
|
845
|
-
# Get
|
|
870
|
+
# Get a resource type
|
|
846
871
|
#
|
|
847
|
-
# @param resource_type The
|
|
872
|
+
# @param resource_type The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.
|
|
848
873
|
# @param [Hash] opts the optional parameters
|
|
849
874
|
# @return [ScimConfigResourceType]
|
|
850
875
|
def get_scim_v2_resourcetype(resource_type, opts = {})
|
|
@@ -852,9 +877,9 @@ module PureCloud
|
|
|
852
877
|
return data
|
|
853
878
|
end
|
|
854
879
|
|
|
855
|
-
# Get
|
|
880
|
+
# Get a resource type
|
|
856
881
|
#
|
|
857
|
-
# @param resource_type The
|
|
882
|
+
# @param resource_type The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.
|
|
858
883
|
# @param [Hash] opts the optional parameters
|
|
859
884
|
# @return [Array<(ScimConfigResourceType, Fixnum, Hash)>] ScimConfigResourceType data, response status code and response headers
|
|
860
885
|
def get_scim_v2_resourcetype_with_http_info(resource_type, opts = {})
|
|
@@ -912,38 +937,29 @@ module PureCloud
|
|
|
912
937
|
return data, status_code, headers
|
|
913
938
|
end
|
|
914
939
|
|
|
915
|
-
# Get
|
|
940
|
+
# Get a list of resource types
|
|
916
941
|
#
|
|
917
942
|
# @param [Hash] opts the optional parameters
|
|
918
|
-
# @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
|
|
919
943
|
# @return [ScimConfigResourceTypesListResponse]
|
|
920
944
|
def get_scim_v2_resourcetypes(opts = {})
|
|
921
945
|
data, _status_code, _headers = get_scim_v2_resourcetypes_with_http_info(opts)
|
|
922
946
|
return data
|
|
923
947
|
end
|
|
924
948
|
|
|
925
|
-
# Get
|
|
949
|
+
# Get a list of resource types
|
|
926
950
|
#
|
|
927
951
|
# @param [Hash] opts the optional parameters
|
|
928
|
-
# @option opts [String] :filter Filtered results are invalid and will result in a 403 (Unauthorized) return.
|
|
929
952
|
# @return [Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>] ScimConfigResourceTypesListResponse data, response status code and response headers
|
|
930
953
|
def get_scim_v2_resourcetypes_with_http_info(opts = {})
|
|
931
954
|
if @api_client.config.debugging
|
|
932
955
|
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_resourcetypes ..."
|
|
933
956
|
end
|
|
934
957
|
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
958
|
# resource path
|
|
942
959
|
local_var_path = "/api/v2/scim/v2/resourcetypes".sub('{format}','json')
|
|
943
960
|
|
|
944
961
|
# query parameters
|
|
945
962
|
query_params = {}
|
|
946
|
-
query_params[:'filter'] = opts[:'filter'] if opts[:'filter']
|
|
947
963
|
|
|
948
964
|
# header parameters
|
|
949
965
|
header_params = {}
|
|
@@ -976,7 +992,7 @@ module PureCloud
|
|
|
976
992
|
return data, status_code, headers
|
|
977
993
|
end
|
|
978
994
|
|
|
979
|
-
# Get
|
|
995
|
+
# Get a service provider's configuration
|
|
980
996
|
#
|
|
981
997
|
# @param [Hash] opts the optional parameters
|
|
982
998
|
# @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/v2/serviceproviderconfig. 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.
|
|
@@ -986,7 +1002,7 @@ module PureCloud
|
|
|
986
1002
|
return data
|
|
987
1003
|
end
|
|
988
1004
|
|
|
989
|
-
# Get
|
|
1005
|
+
# Get a service provider's configuration
|
|
990
1006
|
#
|
|
991
1007
|
# @param [Hash] opts the optional parameters
|
|
992
1008
|
# @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/v2/serviceproviderconfig. 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.
|
|
@@ -1044,6 +1060,8 @@ module PureCloud
|
|
|
1044
1060
|
#
|
|
1045
1061
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
1046
1062
|
# @param [Hash] opts the optional parameters
|
|
1063
|
+
# @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
1064
|
+
# @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
1047
1065
|
# @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/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
1048
1066
|
# @return [ScimV2User]
|
|
1049
1067
|
def get_scim_v2_user(user_id, opts = {})
|
|
@@ -1055,6 +1073,8 @@ module PureCloud
|
|
|
1055
1073
|
#
|
|
1056
1074
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
1057
1075
|
# @param [Hash] opts the optional parameters
|
|
1076
|
+
# @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
1077
|
+
# @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
1058
1078
|
# @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/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
1059
1079
|
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
|
1060
1080
|
def get_scim_v2_user_with_http_info(user_id, opts = {})
|
|
@@ -1073,6 +1093,18 @@ module PureCloud
|
|
|
1073
1093
|
|
|
1074
1094
|
|
|
1075
1095
|
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
|
|
1076
1108
|
|
|
1077
1109
|
|
|
1078
1110
|
|
|
@@ -1081,6 +1113,8 @@ module PureCloud
|
|
|
1081
1113
|
|
|
1082
1114
|
# query parameters
|
|
1083
1115
|
query_params = {}
|
|
1116
|
+
query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
|
|
1117
|
+
query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
|
|
1084
1118
|
|
|
1085
1119
|
# header parameters
|
|
1086
1120
|
header_params = {}
|
|
@@ -1115,32 +1149,46 @@ module PureCloud
|
|
|
1115
1149
|
end
|
|
1116
1150
|
|
|
1117
1151
|
# Get a list of users
|
|
1118
|
-
#
|
|
1119
|
-
# @param filter Filters results.
|
|
1152
|
+
# To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
1120
1153
|
# @param [Hash] opts the optional parameters
|
|
1121
1154
|
# @option opts [Integer] :start_index The 1-based index of the first query result. (default to 1)
|
|
1122
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults
|
|
1155
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\". (default to 25)
|
|
1156
|
+
# @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
1157
|
+
# @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
1158
|
+
# @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\".
|
|
1123
1159
|
# @return [ScimUserListResponse]
|
|
1124
|
-
def get_scim_v2_users(
|
|
1125
|
-
data, _status_code, _headers = get_scim_v2_users_with_http_info(
|
|
1160
|
+
def get_scim_v2_users(opts = {})
|
|
1161
|
+
data, _status_code, _headers = get_scim_v2_users_with_http_info(opts)
|
|
1126
1162
|
return data
|
|
1127
1163
|
end
|
|
1128
1164
|
|
|
1129
1165
|
# Get a list of users
|
|
1130
|
-
#
|
|
1131
|
-
# @param filter Filters results.
|
|
1166
|
+
# To return all active users, do not use a filter parameter. To return inactive users, set \"filter\" to \"active eq false\". By default, returns SCIM attributes externalId, enterprise-user:manager, and roles. To exclude these attributes, set \"attributes\" to \"id,active\" or \"excludeAttributes\" to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
1132
1167
|
# @param [Hash] opts the optional parameters
|
|
1133
1168
|
# @option opts [Integer] :start_index The 1-based index of the first query result.
|
|
1134
|
-
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns totalResults
|
|
1169
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
1170
|
+
# @option opts [Array<String>] :attributes Indicates which attributes to include. Returns these attributes and the default attributes (externalId, enterprise-user:manager, roles). Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
1171
|
+
# @option opts [Array<String>] :excluded_attributes Indicates which attributes to exclude. Returns the default attributes (externalId, enterprise-user:manager, roles) minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
1172
|
+
# @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\".
|
|
1135
1173
|
# @return [Array<(ScimUserListResponse, Fixnum, Hash)>] ScimUserListResponse data, response status code and response headers
|
|
1136
|
-
def get_scim_v2_users_with_http_info(
|
|
1174
|
+
def get_scim_v2_users_with_http_info(opts = {})
|
|
1137
1175
|
if @api_client.config.debugging
|
|
1138
1176
|
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_users ..."
|
|
1139
1177
|
end
|
|
1140
1178
|
|
|
1141
1179
|
|
|
1142
|
-
|
|
1143
|
-
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
|
|
1144
1192
|
|
|
1145
1193
|
|
|
1146
1194
|
|
|
@@ -1163,9 +1211,11 @@ module PureCloud
|
|
|
1163
1211
|
|
|
1164
1212
|
# query parameters
|
|
1165
1213
|
query_params = {}
|
|
1166
|
-
query_params[:'filter'] = filter
|
|
1167
1214
|
query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
|
|
1168
1215
|
query_params[:'count'] = opts[:'count'] if opts[:'count']
|
|
1216
|
+
query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
|
|
1217
|
+
query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
|
|
1218
|
+
query_params[:'filter'] = opts[:'filter'] if opts[:'filter']
|
|
1169
1219
|
|
|
1170
1220
|
# header parameters
|
|
1171
1221
|
header_params = {}
|
|
@@ -1203,7 +1253,7 @@ module PureCloud
|
|
|
1203
1253
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
1204
1254
|
# @param body The information used to modify a group.
|
|
1205
1255
|
# @param [Hash] opts the optional parameters
|
|
1206
|
-
# @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}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1256
|
+
# @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}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1207
1257
|
# @return [ScimV2Group]
|
|
1208
1258
|
def patch_scim_group(group_id, body, opts = {})
|
|
1209
1259
|
data, _status_code, _headers = patch_scim_group_with_http_info(group_id, body, opts)
|
|
@@ -1215,7 +1265,7 @@ module PureCloud
|
|
|
1215
1265
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
1216
1266
|
# @param body The information used to modify a group.
|
|
1217
1267
|
# @param [Hash] opts the optional parameters
|
|
1218
|
-
# @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}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1268
|
+
# @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}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1219
1269
|
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
|
1220
1270
|
def patch_scim_group_with_http_info(group_id, body, opts = {})
|
|
1221
1271
|
if @api_client.config.debugging
|
|
@@ -1287,7 +1337,7 @@ module PureCloud
|
|
|
1287
1337
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
|
|
1288
1338
|
# @param body The information used to modify a user.
|
|
1289
1339
|
# @param [Hash] opts the optional parameters
|
|
1290
|
-
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1340
|
+
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1291
1341
|
# @return [ScimV2User]
|
|
1292
1342
|
def patch_scim_user(user_id, body, opts = {})
|
|
1293
1343
|
data, _status_code, _headers = patch_scim_user_with_http_info(user_id, body, opts)
|
|
@@ -1299,7 +1349,7 @@ module PureCloud
|
|
|
1299
1349
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
|
|
1300
1350
|
# @param body The information used to modify a user.
|
|
1301
1351
|
# @param [Hash] opts the optional parameters
|
|
1302
|
-
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1352
|
+
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1303
1353
|
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
|
1304
1354
|
def patch_scim_user_with_http_info(user_id, body, opts = {})
|
|
1305
1355
|
if @api_client.config.debugging
|
|
@@ -1371,7 +1421,7 @@ module PureCloud
|
|
|
1371
1421
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
1372
1422
|
# @param body The information used to modify a group.
|
|
1373
1423
|
# @param [Hash] opts the optional parameters
|
|
1374
|
-
# @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\".
|
|
1424
|
+
# @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\".
|
|
1375
1425
|
# @return [ScimV2Group]
|
|
1376
1426
|
def patch_scim_v2_group(group_id, body, opts = {})
|
|
1377
1427
|
data, _status_code, _headers = patch_scim_v2_group_with_http_info(group_id, body, opts)
|
|
@@ -1383,7 +1433,7 @@ module PureCloud
|
|
|
1383
1433
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
1384
1434
|
# @param body The information used to modify a group.
|
|
1385
1435
|
# @param [Hash] opts the optional parameters
|
|
1386
|
-
# @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\".
|
|
1436
|
+
# @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\".
|
|
1387
1437
|
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
|
1388
1438
|
def patch_scim_v2_group_with_http_info(group_id, body, opts = {})
|
|
1389
1439
|
if @api_client.config.debugging
|
|
@@ -1455,7 +1505,7 @@ module PureCloud
|
|
|
1455
1505
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
1456
1506
|
# @param body The information used to modify a user.
|
|
1457
1507
|
# @param [Hash] opts the optional parameters
|
|
1458
|
-
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1508
|
+
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1459
1509
|
# @return [ScimV2User]
|
|
1460
1510
|
def patch_scim_v2_user(user_id, body, opts = {})
|
|
1461
1511
|
data, _status_code, _headers = patch_scim_v2_user_with_http_info(user_id, body, opts)
|
|
@@ -1467,7 +1517,7 @@ module PureCloud
|
|
|
1467
1517
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
1468
1518
|
# @param body The information used to modify a user.
|
|
1469
1519
|
# @param [Hash] opts the optional parameters
|
|
1470
|
-
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1520
|
+
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1471
1521
|
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
|
1472
1522
|
def patch_scim_v2_user_with_http_info(user_id, body, opts = {})
|
|
1473
1523
|
if @api_client.config.debugging
|
|
@@ -1669,7 +1719,7 @@ module PureCloud
|
|
|
1669
1719
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
1670
1720
|
# @param body The information used to replace a group.
|
|
1671
1721
|
# @param [Hash] opts the optional parameters
|
|
1672
|
-
# @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}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1722
|
+
# @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}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1673
1723
|
# @return [ScimV2Group]
|
|
1674
1724
|
def put_scim_group(group_id, body, opts = {})
|
|
1675
1725
|
data, _status_code, _headers = put_scim_group_with_http_info(group_id, body, opts)
|
|
@@ -1681,7 +1731,7 @@ module PureCloud
|
|
|
1681
1731
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
1682
1732
|
# @param body The information used to replace a group.
|
|
1683
1733
|
# @param [Hash] opts the optional parameters
|
|
1684
|
-
# @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}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1734
|
+
# @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}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1685
1735
|
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
|
1686
1736
|
def put_scim_group_with_http_info(group_id, body, opts = {})
|
|
1687
1737
|
if @api_client.config.debugging
|
|
@@ -1753,7 +1803,7 @@ module PureCloud
|
|
|
1753
1803
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
|
|
1754
1804
|
# @param body The information used to replace a user.
|
|
1755
1805
|
# @param [Hash] opts the optional parameters
|
|
1756
|
-
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1806
|
+
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1757
1807
|
# @return [ScimV2User]
|
|
1758
1808
|
def put_scim_user(user_id, body, opts = {})
|
|
1759
1809
|
data, _status_code, _headers = put_scim_user_with_http_info(user_id, body, opts)
|
|
@@ -1765,7 +1815,7 @@ module PureCloud
|
|
|
1765
1815
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/users.
|
|
1766
1816
|
# @param body The information used to replace a user.
|
|
1767
1817
|
# @param [Hash] opts the optional parameters
|
|
1768
|
-
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1818
|
+
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1769
1819
|
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
|
1770
1820
|
def put_scim_user_with_http_info(user_id, body, opts = {})
|
|
1771
1821
|
if @api_client.config.debugging
|
|
@@ -1837,7 +1887,7 @@ module PureCloud
|
|
|
1837
1887
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
1838
1888
|
# @param body The information used to replace a group.
|
|
1839
1889
|
# @param [Hash] opts the optional parameters
|
|
1840
|
-
# @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\".
|
|
1890
|
+
# @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\".
|
|
1841
1891
|
# @return [ScimV2Group]
|
|
1842
1892
|
def put_scim_v2_group(group_id, body, opts = {})
|
|
1843
1893
|
data, _status_code, _headers = put_scim_v2_group_with_http_info(group_id, body, opts)
|
|
@@ -1849,7 +1899,7 @@ module PureCloud
|
|
|
1849
1899
|
# @param group_id The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
1850
1900
|
# @param body The information used to replace a group.
|
|
1851
1901
|
# @param [Hash] opts the optional parameters
|
|
1852
|
-
# @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\".
|
|
1902
|
+
# @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\".
|
|
1853
1903
|
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
|
1854
1904
|
def put_scim_v2_group_with_http_info(group_id, body, opts = {})
|
|
1855
1905
|
if @api_client.config.debugging
|
|
@@ -1921,7 +1971,7 @@ module PureCloud
|
|
|
1921
1971
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
1922
1972
|
# @param body The information used to replace a user.
|
|
1923
1973
|
# @param [Hash] opts the optional parameters
|
|
1924
|
-
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1974
|
+
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1925
1975
|
# @return [ScimV2User]
|
|
1926
1976
|
def put_scim_v2_user(user_id, body, opts = {})
|
|
1927
1977
|
data, _status_code, _headers = put_scim_v2_user_with_http_info(user_id, body, opts)
|
|
@@ -1933,7 +1983,7 @@ module PureCloud
|
|
|
1933
1983
|
# @param user_id The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
1934
1984
|
# @param body The information used to replace a user.
|
|
1935
1985
|
# @param [Hash] opts the optional parameters
|
|
1936
|
-
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a scimType of \"invalidVers\".
|
|
1986
|
+
# @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/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
|
|
1937
1987
|
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
|
1938
1988
|
def put_scim_v2_user_with_http_info(user_id, body, opts = {})
|
|
1939
1989
|
if @api_client.config.debugging
|