purecloudplatformclientv2 56.0.0 → 57.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ADFS.md +1 -1
- data/docs/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AnalyticsApi.md +66 -0
- data/docs/ArrayNode.md +7 -7
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AuthzDivisionEntityListing.md +1 -1
- data/docs/CalibrationEntityListing.md +1 -1
- 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/ChatMediaParticipant.md +1 -0
- 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/ConversationChat.md +1 -0
- data/docs/ConversationEmailEventTopicEmailMediaParticipant.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicEmail.md +1 -0
- data/docs/ConversationsApi.md +134 -0
- data/docs/CreateWebChatConversationRequest.md +18 -0
- data/docs/CreateWebChatConversationResponse.md +16 -0
- data/docs/CreateWebChatMessageRequest.md +14 -0
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/CustomerInteractionCenter.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/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/Evaluation.md +3 -0
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluationQuestion.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/FlowVersionEntityListing.md +1 -1
- data/docs/FlowsApi.md +66 -0
- data/docs/GDPRJourneyCustomer.md +14 -0
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubject.md +2 -0
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GSuite.md +1 -1
- data/docs/GeneralDataProtectionRegulationApi.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GuestMemberInfo.md +15 -0
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityNow.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/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/JsonNode.md +33 -0
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LineIntegrationEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/Manager.md +25 -0
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/Meta.md +17 -0
- data/docs/MeteredAssignmentByAgent.md +18 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/ObservationValue.md +1 -0
- data/docs/Okta.md +1 -1
- data/docs/OneLogin.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PatchOperation.md +13 -0
- data/docs/PatchRequest.md +17 -0
- data/docs/Path.md +14 -0
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/Photo.md +14 -0
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PingIdentity.md +1 -1
- data/docs/PolicyActions.md +1 -0
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/PureEngage.md +1 -1
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md +1 -0
- data/docs/QueueConversationEventTopicEmail.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicEmail.md +1 -0
- data/docs/QueueConversationVideoEventTopicEmail.md +1 -0
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +2 -1
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +1499 -0
- data/docs/Salesforce.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScimEmail.md +15 -0
- data/docs/ScimListResponse.md +17 -0
- data/docs/ScimMetadata.md +16 -0
- data/docs/ScimPhoneNumber.md +15 -0
- data/docs/ScimResource.md +15 -0
- data/docs/ScimServiceProviderConfig.md +14 -0
- data/docs/ScimV2CreateUser.md +24 -0
- data/docs/ScimV2EnterpriseUser.md +15 -0
- data/docs/ScimV2Group.md +17 -0
- data/docs/ScimV2GroupReference.md +17 -0
- data/docs/ScimV2MemberReference.md +17 -0
- data/docs/ScimV2PatchOperation.md +15 -0
- data/docs/ScimV2PatchRequest.md +14 -0
- data/docs/ScimV2User.md +25 -0
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/SecurityProfileEntityListing.md +1 -1
- data/docs/ShareEntityListing.md +1 -1
- data/docs/SiteEntityListing.md +1 -1
- data/docs/SkillEntityListing.md +1 -1
- data/docs/SmsPhoneNumber.md +1 -1
- data/docs/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/SocialHandle.md +14 -0
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TelephonyProvidersEdgeApi.md +2 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeInterval.md +2 -0
- data/docs/TimeZone.md +1 -1
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UserActionCategoryEntityListing.md +1 -1
- data/docs/UserEntityListing.md +1 -1
- data/docs/UserLanguageEntityListing.md +1 -1
- data/docs/UserProfileEntityListing.md +1 -1
- data/docs/UserQueueEntityListing.md +1 -1
- data/docs/UserRecordingEntityListing.md +1 -1
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatApi.md +773 -24
- data/docs/WebChatConversation.md +16 -0
- data/docs/WebChatGuestMediaRequest.md +19 -0
- data/docs/WebChatGuestMediaRequestEntityList.md +13 -0
- data/docs/WebChatMemberInfo.md +21 -0
- data/docs/WebChatMemberInfoEntityList.md +22 -0
- data/docs/WebChatMessage.md +20 -0
- data/docs/WebChatMessageEntityList.md +17 -0
- data/docs/WebChatRoutingTarget.md +17 -0
- data/docs/WebChatTyping.md +16 -0
- data/docs/WidgetClientConfig.md +1 -0
- data/docs/WidgetClientConfigV1Http.md +14 -0
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +39 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +148 -0
- data/lib/purecloudplatformclientv2/api/flows_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/general_data_protection_regulation_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scim_api.rb +1671 -0
- data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/web_chat_api.rb +901 -30
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/array_node.rb +79 -79
- 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_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/chat_media_participant.rb +30 -4
- 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_chat.rb +27 -1
- data/lib/purecloudplatformclientv2/models/conversation_email_event_topic_email_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/create_web_chat_conversation_request.rb +352 -0
- data/lib/purecloudplatformclientv2/models/create_web_chat_conversation_response.rb +280 -0
- data/lib/purecloudplatformclientv2/models/create_web_chat_message_request.rb +247 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.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_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dnc_list_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.rb +81 -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/evaluation_question.rb +13 -13
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- 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_division_view_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_journey_customer.rb +238 -0
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject.rb +51 -1
- 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/guest_member_info.rb +261 -0
- data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/integration_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/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/json_node.rb +715 -0
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +12 -12
- 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 +521 -0
- data/lib/purecloudplatformclientv2/models/message.rb +2 -2
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +2 -2
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/meta.rb +303 -0
- data/lib/purecloudplatformclientv2/models/metered_assignment_by_agent.rb +328 -0
- 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/observation_value.rb +27 -1
- data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
- data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/patch_operation.rb +201 -0
- data/lib/purecloudplatformclientv2/models/patch_request.rb +310 -0
- data/lib/purecloudplatformclientv2/models/path.rb +226 -0
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/photo.rb +243 -0
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_actions.rb +28 -1
- 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/pure_engage.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_conversation_email_event_topic_email_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_email.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/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/replacement_term.rb +2 -2
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/scim_email.rb +269 -0
- data/lib/purecloudplatformclientv2/models/scim_list_response.rb +311 -0
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +295 -0
- data/lib/purecloudplatformclientv2/models/scim_phone_number.rb +269 -0
- data/lib/purecloudplatformclientv2/models/scim_resource.rb +254 -0
- data/lib/purecloudplatformclientv2/models/scim_service_provider_config.rb +228 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +508 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_enterprise_user.rb +255 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_group.rb +310 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +320 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +320 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_operation.rb +274 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_patch_request.rb +237 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +523 -0
- 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/site_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +5 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/social_handle.rb +240 -0
- 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_interval.rb +51 -1
- data/lib/purecloudplatformclientv2/models/time_zone.rb +13 -13
- 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/trustor_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_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_conversation.rb +279 -0
- data/lib/purecloudplatformclientv2/models/web_chat_guest_media_request.rb +384 -0
- data/lib/purecloudplatformclientv2/models/web_chat_guest_media_request_entity_list.rb +203 -0
- data/lib/purecloudplatformclientv2/models/web_chat_member_info.rb +445 -0
- data/lib/purecloudplatformclientv2/models/web_chat_member_info_entity_list.rb +428 -0
- data/lib/purecloudplatformclientv2/models/web_chat_message.rb +422 -0
- data/lib/purecloudplatformclientv2/models/web_chat_message_entity_list.rb +303 -0
- data/lib/purecloudplatformclientv2/models/web_chat_routing_target.rb +332 -0
- data/lib/purecloudplatformclientv2/models/web_chat_typing.rb +300 -0
- data/lib/purecloudplatformclientv2/models/widget_client_config.rb +26 -1
- data/lib/purecloudplatformclientv2/models/widget_client_config_v1_http.rb +240 -0
- data/lib/purecloudplatformclientv2/models/widget_deployment.rb +2 -2
- 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 +80 -2
@@ -88,5 +88,70 @@ module PureCloud
|
|
88
88
|
end
|
89
89
|
return data, status_code, headers
|
90
90
|
end
|
91
|
+
|
92
|
+
# Query for flow observations
|
93
|
+
#
|
94
|
+
# @param body query
|
95
|
+
# @param [Hash] opts the optional parameters
|
96
|
+
# @return [QualifierMappingObservationQueryResponse]
|
97
|
+
def post_analytics_flows_observations_query(body, opts = {})
|
98
|
+
data, _status_code, _headers = post_analytics_flows_observations_query_with_http_info(body, opts)
|
99
|
+
return data
|
100
|
+
end
|
101
|
+
|
102
|
+
# Query for flow observations
|
103
|
+
#
|
104
|
+
# @param body query
|
105
|
+
# @param [Hash] opts the optional parameters
|
106
|
+
# @return [Array<(QualifierMappingObservationQueryResponse, Fixnum, Hash)>] QualifierMappingObservationQueryResponse data, response status code and response headers
|
107
|
+
def post_analytics_flows_observations_query_with_http_info(body, opts = {})
|
108
|
+
if @api_client.config.debugging
|
109
|
+
@api_client.config.logger.debug "Calling API: FlowsApi.post_analytics_flows_observations_query ..."
|
110
|
+
end
|
111
|
+
|
112
|
+
|
113
|
+
# verify the required parameter 'body' is set
|
114
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling FlowsApi.post_analytics_flows_observations_query" if body.nil?
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
# resource path
|
121
|
+
local_var_path = "/api/v2/analytics/flows/observations/query".sub('{format}','json')
|
122
|
+
|
123
|
+
# query parameters
|
124
|
+
query_params = {}
|
125
|
+
|
126
|
+
# header parameters
|
127
|
+
header_params = {}
|
128
|
+
|
129
|
+
# HTTP header 'Accept' (if needed)
|
130
|
+
local_header_accept = ['application/json']
|
131
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
132
|
+
|
133
|
+
# HTTP header 'Content-Type'
|
134
|
+
local_header_content_type = ['application/json']
|
135
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
136
|
+
|
137
|
+
# form parameters
|
138
|
+
form_params = {}
|
139
|
+
|
140
|
+
# http body (model)
|
141
|
+
post_body = @api_client.object_to_http_body(body)
|
142
|
+
|
143
|
+
auth_names = ['PureCloud OAuth']
|
144
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
145
|
+
:header_params => header_params,
|
146
|
+
:query_params => query_params,
|
147
|
+
:form_params => form_params,
|
148
|
+
:body => post_body,
|
149
|
+
:auth_names => auth_names,
|
150
|
+
:return_type => 'QualifierMappingObservationQueryResponse')
|
151
|
+
if @api_client.config.debugging
|
152
|
+
@api_client.config.logger.debug "API called: FlowsApi#post_analytics_flows_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
153
|
+
end
|
154
|
+
return data, status_code, headers
|
155
|
+
end
|
91
156
|
end
|
92
157
|
end
|
@@ -189,8 +189,8 @@ module PureCloud
|
|
189
189
|
fail ArgumentError, "Missing the required parameter 'search_type' when calling GeneralDataProtectionRegulationApi.get_gdpr_subjects" if search_type.nil?
|
190
190
|
|
191
191
|
# verify enum value
|
192
|
-
unless ['NAME', 'ADDRESS', 'PHONE', 'EMAIL'].include?(search_type)
|
193
|
-
fail ArgumentError, "invalid value for 'search_type', must be one of NAME, ADDRESS, PHONE, EMAIL"
|
192
|
+
unless ['NAME', 'ADDRESS', 'PHONE', 'EMAIL', 'TWITTER'].include?(search_type)
|
193
|
+
fail ArgumentError, "invalid value for 'search_type', must be one of NAME, ADDRESS, PHONE, EMAIL, TWITTER"
|
194
194
|
end
|
195
195
|
|
196
196
|
|
@@ -0,0 +1,1671 @@
|
|
1
|
+
=begin
|
2
|
+
PureCloud Platform API
|
3
|
+
|
4
|
+
With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: DeveloperEvangelists@genesys.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
License: UNLICENSED
|
11
|
+
https://help.mypurecloud.com/articles/terms-and-conditions/
|
12
|
+
|
13
|
+
Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
|
14
|
+
|
15
|
+
=end
|
16
|
+
|
17
|
+
require "uri"
|
18
|
+
|
19
|
+
module PureCloud
|
20
|
+
class SCIMApi
|
21
|
+
attr_accessor :api_client
|
22
|
+
|
23
|
+
def initialize(api_client = ApiClient.default)
|
24
|
+
@api_client = api_client
|
25
|
+
end
|
26
|
+
|
27
|
+
# Soft delete user with specified ID
|
28
|
+
#
|
29
|
+
# @param user_id
|
30
|
+
# @param [Hash] opts the optional parameters
|
31
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
32
|
+
# @return [Empty]
|
33
|
+
def delete_scim_user(user_id, opts = {})
|
34
|
+
data, _status_code, _headers = delete_scim_user_with_http_info(user_id, opts)
|
35
|
+
return data
|
36
|
+
end
|
37
|
+
|
38
|
+
# Soft delete user with specified ID
|
39
|
+
#
|
40
|
+
# @param user_id
|
41
|
+
# @param [Hash] opts the optional parameters
|
42
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
43
|
+
# @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
|
44
|
+
def delete_scim_user_with_http_info(user_id, opts = {})
|
45
|
+
if @api_client.config.debugging
|
46
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.delete_scim_user ..."
|
47
|
+
end
|
48
|
+
|
49
|
+
|
50
|
+
# verify the required parameter 'user_id' is set
|
51
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.delete_scim_user" if user_id.nil?
|
52
|
+
|
53
|
+
|
54
|
+
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
|
59
|
+
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
# resource path
|
64
|
+
local_var_path = "/api/v2/scim/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
65
|
+
|
66
|
+
# query parameters
|
67
|
+
query_params = {}
|
68
|
+
|
69
|
+
# header parameters
|
70
|
+
header_params = {}
|
71
|
+
|
72
|
+
# HTTP header 'Accept' (if needed)
|
73
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
74
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
75
|
+
|
76
|
+
# HTTP header 'Content-Type'
|
77
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
78
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
79
|
+
header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
|
80
|
+
|
81
|
+
# form parameters
|
82
|
+
form_params = {}
|
83
|
+
|
84
|
+
# http body (model)
|
85
|
+
post_body = nil
|
86
|
+
|
87
|
+
auth_names = ['PureCloud OAuth']
|
88
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
89
|
+
:header_params => header_params,
|
90
|
+
:query_params => query_params,
|
91
|
+
:form_params => form_params,
|
92
|
+
:body => post_body,
|
93
|
+
:auth_names => auth_names,
|
94
|
+
:return_type => 'Empty')
|
95
|
+
if @api_client.config.debugging
|
96
|
+
@api_client.config.logger.debug "API called: SCIMApi#delete_scim_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
97
|
+
end
|
98
|
+
return data, status_code, headers
|
99
|
+
end
|
100
|
+
|
101
|
+
# Soft delete user with specified ID
|
102
|
+
#
|
103
|
+
# @param user_id
|
104
|
+
# @param [Hash] opts the optional parameters
|
105
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
106
|
+
# @return [Empty]
|
107
|
+
def delete_scim_v2_user(user_id, opts = {})
|
108
|
+
data, _status_code, _headers = delete_scim_v2_user_with_http_info(user_id, opts)
|
109
|
+
return data
|
110
|
+
end
|
111
|
+
|
112
|
+
# Soft delete user with specified ID
|
113
|
+
#
|
114
|
+
# @param user_id
|
115
|
+
# @param [Hash] opts the optional parameters
|
116
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
117
|
+
# @return [Array<(Empty, Fixnum, Hash)>] Empty data, response status code and response headers
|
118
|
+
def delete_scim_v2_user_with_http_info(user_id, opts = {})
|
119
|
+
if @api_client.config.debugging
|
120
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.delete_scim_v2_user ..."
|
121
|
+
end
|
122
|
+
|
123
|
+
|
124
|
+
# verify the required parameter 'user_id' is set
|
125
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.delete_scim_v2_user" if user_id.nil?
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
# resource path
|
138
|
+
local_var_path = "/api/v2/scim/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
139
|
+
|
140
|
+
# query parameters
|
141
|
+
query_params = {}
|
142
|
+
|
143
|
+
# header parameters
|
144
|
+
header_params = {}
|
145
|
+
|
146
|
+
# HTTP header 'Accept' (if needed)
|
147
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
148
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
149
|
+
|
150
|
+
# HTTP header 'Content-Type'
|
151
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
152
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
153
|
+
header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
|
154
|
+
|
155
|
+
# form parameters
|
156
|
+
form_params = {}
|
157
|
+
|
158
|
+
# http body (model)
|
159
|
+
post_body = nil
|
160
|
+
|
161
|
+
auth_names = ['PureCloud OAuth']
|
162
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
163
|
+
:header_params => header_params,
|
164
|
+
:query_params => query_params,
|
165
|
+
:form_params => form_params,
|
166
|
+
:body => post_body,
|
167
|
+
:auth_names => auth_names,
|
168
|
+
:return_type => 'Empty')
|
169
|
+
if @api_client.config.debugging
|
170
|
+
@api_client.config.logger.debug "API called: SCIMApi#delete_scim_v2_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
171
|
+
end
|
172
|
+
return data, status_code, headers
|
173
|
+
end
|
174
|
+
|
175
|
+
# Return Group with specified ID
|
176
|
+
#
|
177
|
+
# @param group_id
|
178
|
+
# @param [Hash] opts the optional parameters
|
179
|
+
# @option opts [String] :if_none_match If-None-Match for ETag version checking
|
180
|
+
# @return [ScimV2Group]
|
181
|
+
def get_scim_group(group_id, opts = {})
|
182
|
+
data, _status_code, _headers = get_scim_group_with_http_info(group_id, opts)
|
183
|
+
return data
|
184
|
+
end
|
185
|
+
|
186
|
+
# Return Group with specified ID
|
187
|
+
#
|
188
|
+
# @param group_id
|
189
|
+
# @param [Hash] opts the optional parameters
|
190
|
+
# @option opts [String] :if_none_match If-None-Match for ETag version checking
|
191
|
+
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
192
|
+
def get_scim_group_with_http_info(group_id, opts = {})
|
193
|
+
if @api_client.config.debugging
|
194
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_group ..."
|
195
|
+
end
|
196
|
+
|
197
|
+
|
198
|
+
# verify the required parameter 'group_id' is set
|
199
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.get_scim_group" if group_id.nil?
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
# resource path
|
212
|
+
local_var_path = "/api/v2/scim/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
|
213
|
+
|
214
|
+
# query parameters
|
215
|
+
query_params = {}
|
216
|
+
|
217
|
+
# header parameters
|
218
|
+
header_params = {}
|
219
|
+
|
220
|
+
# HTTP header 'Accept' (if needed)
|
221
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
222
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
223
|
+
|
224
|
+
# HTTP header 'Content-Type'
|
225
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
226
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
227
|
+
header_params[:'If-None-Match'] = opts[:'if_none_match'] if opts[:'if_none_match']
|
228
|
+
|
229
|
+
# form parameters
|
230
|
+
form_params = {}
|
231
|
+
|
232
|
+
# http body (model)
|
233
|
+
post_body = nil
|
234
|
+
|
235
|
+
auth_names = ['PureCloud OAuth']
|
236
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
237
|
+
:header_params => header_params,
|
238
|
+
:query_params => query_params,
|
239
|
+
:form_params => form_params,
|
240
|
+
:body => post_body,
|
241
|
+
:auth_names => auth_names,
|
242
|
+
:return_type => 'ScimV2Group')
|
243
|
+
if @api_client.config.debugging
|
244
|
+
@api_client.config.logger.debug "API called: SCIMApi#get_scim_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
245
|
+
end
|
246
|
+
return data, status_code, headers
|
247
|
+
end
|
248
|
+
|
249
|
+
# Query Groups
|
250
|
+
#
|
251
|
+
# @param [Hash] opts the optional parameters
|
252
|
+
# @option opts [Integer] :start_index Starting item of request. 1-based (default to 1)
|
253
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count. (default to 25)
|
254
|
+
# @option opts [String] :filter filter parameter e.g. displayName eq groupName
|
255
|
+
# @return [ScimListResponse]
|
256
|
+
def get_scim_groups(opts = {})
|
257
|
+
data, _status_code, _headers = get_scim_groups_with_http_info(opts)
|
258
|
+
return data
|
259
|
+
end
|
260
|
+
|
261
|
+
# Query Groups
|
262
|
+
#
|
263
|
+
# @param [Hash] opts the optional parameters
|
264
|
+
# @option opts [Integer] :start_index Starting item of request. 1-based
|
265
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count.
|
266
|
+
# @option opts [String] :filter filter parameter e.g. displayName eq groupName
|
267
|
+
# @return [Array<(ScimListResponse, Fixnum, Hash)>] ScimListResponse data, response status code and response headers
|
268
|
+
def get_scim_groups_with_http_info(opts = {})
|
269
|
+
if @api_client.config.debugging
|
270
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_groups ..."
|
271
|
+
end
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
# resource path
|
292
|
+
local_var_path = "/api/v2/scim/groups".sub('{format}','json')
|
293
|
+
|
294
|
+
# query parameters
|
295
|
+
query_params = {}
|
296
|
+
query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
|
297
|
+
query_params[:'count'] = opts[:'count'] if opts[:'count']
|
298
|
+
query_params[:'filter'] = opts[:'filter'] if opts[:'filter']
|
299
|
+
|
300
|
+
# header parameters
|
301
|
+
header_params = {}
|
302
|
+
|
303
|
+
# HTTP header 'Accept' (if needed)
|
304
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
305
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
306
|
+
|
307
|
+
# HTTP header 'Content-Type'
|
308
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
309
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
310
|
+
|
311
|
+
# form parameters
|
312
|
+
form_params = {}
|
313
|
+
|
314
|
+
# http body (model)
|
315
|
+
post_body = nil
|
316
|
+
|
317
|
+
auth_names = ['PureCloud OAuth']
|
318
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
319
|
+
:header_params => header_params,
|
320
|
+
:query_params => query_params,
|
321
|
+
:form_params => form_params,
|
322
|
+
:body => post_body,
|
323
|
+
:auth_names => auth_names,
|
324
|
+
:return_type => 'ScimListResponse')
|
325
|
+
if @api_client.config.debugging
|
326
|
+
@api_client.config.logger.debug "API called: SCIMApi#get_scim_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
327
|
+
end
|
328
|
+
return data, status_code, headers
|
329
|
+
end
|
330
|
+
|
331
|
+
# Return user with specified ID (default version)
|
332
|
+
#
|
333
|
+
# @param user_id
|
334
|
+
# @param [Hash] opts the optional parameters
|
335
|
+
# @option opts [String] :if_none_match If-None-Match for ETag version checking
|
336
|
+
# @return [ScimV2User]
|
337
|
+
def get_scim_user(user_id, opts = {})
|
338
|
+
data, _status_code, _headers = get_scim_user_with_http_info(user_id, opts)
|
339
|
+
return data
|
340
|
+
end
|
341
|
+
|
342
|
+
# Return user with specified ID (default version)
|
343
|
+
#
|
344
|
+
# @param user_id
|
345
|
+
# @param [Hash] opts the optional parameters
|
346
|
+
# @option opts [String] :if_none_match If-None-Match for ETag version checking
|
347
|
+
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
348
|
+
def get_scim_user_with_http_info(user_id, opts = {})
|
349
|
+
if @api_client.config.debugging
|
350
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_user ..."
|
351
|
+
end
|
352
|
+
|
353
|
+
|
354
|
+
# verify the required parameter 'user_id' is set
|
355
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.get_scim_user" if user_id.nil?
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
# resource path
|
368
|
+
local_var_path = "/api/v2/scim/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
369
|
+
|
370
|
+
# query parameters
|
371
|
+
query_params = {}
|
372
|
+
|
373
|
+
# header parameters
|
374
|
+
header_params = {}
|
375
|
+
|
376
|
+
# HTTP header 'Accept' (if needed)
|
377
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
378
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
379
|
+
|
380
|
+
# HTTP header 'Content-Type'
|
381
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
382
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
383
|
+
header_params[:'If-None-Match'] = opts[:'if_none_match'] if opts[:'if_none_match']
|
384
|
+
|
385
|
+
# form parameters
|
386
|
+
form_params = {}
|
387
|
+
|
388
|
+
# http body (model)
|
389
|
+
post_body = nil
|
390
|
+
|
391
|
+
auth_names = ['PureCloud OAuth']
|
392
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
393
|
+
:header_params => header_params,
|
394
|
+
:query_params => query_params,
|
395
|
+
:form_params => form_params,
|
396
|
+
:body => post_body,
|
397
|
+
:auth_names => auth_names,
|
398
|
+
:return_type => 'ScimV2User')
|
399
|
+
if @api_client.config.debugging
|
400
|
+
@api_client.config.logger.debug "API called: SCIMApi#get_scim_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
401
|
+
end
|
402
|
+
return data, status_code, headers
|
403
|
+
end
|
404
|
+
|
405
|
+
# Query Users
|
406
|
+
#
|
407
|
+
# @param filter filter parameter e.g. userName eq search@sample.org
|
408
|
+
# @param [Hash] opts the optional parameters
|
409
|
+
# @option opts [Integer] :start_index Starting item of request. 1-based (default to 1)
|
410
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count. (default to 25)
|
411
|
+
# @return [ScimListResponse]
|
412
|
+
def get_scim_users(filter, opts = {})
|
413
|
+
data, _status_code, _headers = get_scim_users_with_http_info(filter, opts)
|
414
|
+
return data
|
415
|
+
end
|
416
|
+
|
417
|
+
# Query Users
|
418
|
+
#
|
419
|
+
# @param filter filter parameter e.g. userName eq search@sample.org
|
420
|
+
# @param [Hash] opts the optional parameters
|
421
|
+
# @option opts [Integer] :start_index Starting item of request. 1-based
|
422
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count.
|
423
|
+
# @return [Array<(ScimListResponse, Fixnum, Hash)>] ScimListResponse data, response status code and response headers
|
424
|
+
def get_scim_users_with_http_info(filter, opts = {})
|
425
|
+
if @api_client.config.debugging
|
426
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_users ..."
|
427
|
+
end
|
428
|
+
|
429
|
+
|
430
|
+
# verify the required parameter 'filter' is set
|
431
|
+
fail ArgumentError, "Missing the required parameter 'filter' when calling SCIMApi.get_scim_users" if filter.nil?
|
432
|
+
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
|
443
|
+
|
444
|
+
|
445
|
+
|
446
|
+
|
447
|
+
|
448
|
+
|
449
|
+
# resource path
|
450
|
+
local_var_path = "/api/v2/scim/users".sub('{format}','json')
|
451
|
+
|
452
|
+
# query parameters
|
453
|
+
query_params = {}
|
454
|
+
query_params[:'filter'] = filter
|
455
|
+
query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
|
456
|
+
query_params[:'count'] = opts[:'count'] if opts[:'count']
|
457
|
+
|
458
|
+
# header parameters
|
459
|
+
header_params = {}
|
460
|
+
|
461
|
+
# HTTP header 'Accept' (if needed)
|
462
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
463
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
464
|
+
|
465
|
+
# HTTP header 'Content-Type'
|
466
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
467
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
468
|
+
|
469
|
+
# form parameters
|
470
|
+
form_params = {}
|
471
|
+
|
472
|
+
# http body (model)
|
473
|
+
post_body = nil
|
474
|
+
|
475
|
+
auth_names = ['PureCloud OAuth']
|
476
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
477
|
+
:header_params => header_params,
|
478
|
+
:query_params => query_params,
|
479
|
+
:form_params => form_params,
|
480
|
+
:body => post_body,
|
481
|
+
:auth_names => auth_names,
|
482
|
+
:return_type => 'ScimListResponse')
|
483
|
+
if @api_client.config.debugging
|
484
|
+
@api_client.config.logger.debug "API called: SCIMApi#get_scim_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
485
|
+
end
|
486
|
+
return data, status_code, headers
|
487
|
+
end
|
488
|
+
|
489
|
+
# Return Group with specified ID
|
490
|
+
#
|
491
|
+
# @param group_id
|
492
|
+
# @param [Hash] opts the optional parameters
|
493
|
+
# @option opts [String] :if_none_match If-None-Match for ETag version checking
|
494
|
+
# @return [ScimV2Group]
|
495
|
+
def get_scim_v2_group(group_id, opts = {})
|
496
|
+
data, _status_code, _headers = get_scim_v2_group_with_http_info(group_id, opts)
|
497
|
+
return data
|
498
|
+
end
|
499
|
+
|
500
|
+
# Return Group with specified ID
|
501
|
+
#
|
502
|
+
# @param group_id
|
503
|
+
# @param [Hash] opts the optional parameters
|
504
|
+
# @option opts [String] :if_none_match If-None-Match for ETag version checking
|
505
|
+
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
506
|
+
def get_scim_v2_group_with_http_info(group_id, opts = {})
|
507
|
+
if @api_client.config.debugging
|
508
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_group ..."
|
509
|
+
end
|
510
|
+
|
511
|
+
|
512
|
+
# verify the required parameter 'group_id' is set
|
513
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.get_scim_v2_group" if group_id.nil?
|
514
|
+
|
515
|
+
|
516
|
+
|
517
|
+
|
518
|
+
|
519
|
+
|
520
|
+
|
521
|
+
|
522
|
+
|
523
|
+
|
524
|
+
|
525
|
+
# resource path
|
526
|
+
local_var_path = "/api/v2/scim/v2/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
|
527
|
+
|
528
|
+
# query parameters
|
529
|
+
query_params = {}
|
530
|
+
|
531
|
+
# header parameters
|
532
|
+
header_params = {}
|
533
|
+
|
534
|
+
# HTTP header 'Accept' (if needed)
|
535
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
536
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
537
|
+
|
538
|
+
# HTTP header 'Content-Type'
|
539
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
540
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
541
|
+
header_params[:'If-None-Match'] = opts[:'if_none_match'] if opts[:'if_none_match']
|
542
|
+
|
543
|
+
# form parameters
|
544
|
+
form_params = {}
|
545
|
+
|
546
|
+
# http body (model)
|
547
|
+
post_body = nil
|
548
|
+
|
549
|
+
auth_names = ['PureCloud OAuth']
|
550
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
551
|
+
:header_params => header_params,
|
552
|
+
:query_params => query_params,
|
553
|
+
:form_params => form_params,
|
554
|
+
:body => post_body,
|
555
|
+
:auth_names => auth_names,
|
556
|
+
:return_type => 'ScimV2Group')
|
557
|
+
if @api_client.config.debugging
|
558
|
+
@api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
559
|
+
end
|
560
|
+
return data, status_code, headers
|
561
|
+
end
|
562
|
+
|
563
|
+
# Query Groups
|
564
|
+
#
|
565
|
+
# @param filter filter parameter e.g. displayName eq groupName
|
566
|
+
# @param [Hash] opts the optional parameters
|
567
|
+
# @option opts [Integer] :start_index Starting item of request. 1-based (default to 1)
|
568
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count. (default to 25)
|
569
|
+
# @return [ScimListResponse]
|
570
|
+
def get_scim_v2_groups(filter, opts = {})
|
571
|
+
data, _status_code, _headers = get_scim_v2_groups_with_http_info(filter, opts)
|
572
|
+
return data
|
573
|
+
end
|
574
|
+
|
575
|
+
# Query Groups
|
576
|
+
#
|
577
|
+
# @param filter filter parameter e.g. displayName eq groupName
|
578
|
+
# @param [Hash] opts the optional parameters
|
579
|
+
# @option opts [Integer] :start_index Starting item of request. 1-based
|
580
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count.
|
581
|
+
# @return [Array<(ScimListResponse, Fixnum, Hash)>] ScimListResponse data, response status code and response headers
|
582
|
+
def get_scim_v2_groups_with_http_info(filter, opts = {})
|
583
|
+
if @api_client.config.debugging
|
584
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_groups ..."
|
585
|
+
end
|
586
|
+
|
587
|
+
|
588
|
+
# verify the required parameter 'filter' is set
|
589
|
+
fail ArgumentError, "Missing the required parameter 'filter' when calling SCIMApi.get_scim_v2_groups" if filter.nil?
|
590
|
+
|
591
|
+
|
592
|
+
|
593
|
+
|
594
|
+
|
595
|
+
|
596
|
+
|
597
|
+
|
598
|
+
|
599
|
+
|
600
|
+
|
601
|
+
|
602
|
+
|
603
|
+
|
604
|
+
|
605
|
+
|
606
|
+
|
607
|
+
# resource path
|
608
|
+
local_var_path = "/api/v2/scim/v2/groups".sub('{format}','json')
|
609
|
+
|
610
|
+
# query parameters
|
611
|
+
query_params = {}
|
612
|
+
query_params[:'filter'] = filter
|
613
|
+
query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
|
614
|
+
query_params[:'count'] = opts[:'count'] if opts[:'count']
|
615
|
+
|
616
|
+
# header parameters
|
617
|
+
header_params = {}
|
618
|
+
|
619
|
+
# HTTP header 'Accept' (if needed)
|
620
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
621
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
622
|
+
|
623
|
+
# HTTP header 'Content-Type'
|
624
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
625
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
626
|
+
|
627
|
+
# form parameters
|
628
|
+
form_params = {}
|
629
|
+
|
630
|
+
# http body (model)
|
631
|
+
post_body = nil
|
632
|
+
|
633
|
+
auth_names = ['PureCloud OAuth']
|
634
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
635
|
+
:header_params => header_params,
|
636
|
+
:query_params => query_params,
|
637
|
+
:form_params => form_params,
|
638
|
+
:body => post_body,
|
639
|
+
:auth_names => auth_names,
|
640
|
+
:return_type => 'ScimListResponse')
|
641
|
+
if @api_client.config.debugging
|
642
|
+
@api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
643
|
+
end
|
644
|
+
return data, status_code, headers
|
645
|
+
end
|
646
|
+
|
647
|
+
# Get SCIM Configuration
|
648
|
+
#
|
649
|
+
# @param [Hash] opts the optional parameters
|
650
|
+
# @option opts [String] :if_none_match If-None-Match for ETag version checking
|
651
|
+
# @return [ScimServiceProviderConfig]
|
652
|
+
def get_scim_v2_serviceproviderconfig(opts = {})
|
653
|
+
data, _status_code, _headers = get_scim_v2_serviceproviderconfig_with_http_info(opts)
|
654
|
+
return data
|
655
|
+
end
|
656
|
+
|
657
|
+
# Get SCIM Configuration
|
658
|
+
#
|
659
|
+
# @param [Hash] opts the optional parameters
|
660
|
+
# @option opts [String] :if_none_match If-None-Match for ETag version checking
|
661
|
+
# @return [Array<(ScimServiceProviderConfig, Fixnum, Hash)>] ScimServiceProviderConfig data, response status code and response headers
|
662
|
+
def get_scim_v2_serviceproviderconfig_with_http_info(opts = {})
|
663
|
+
if @api_client.config.debugging
|
664
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_serviceproviderconfig ..."
|
665
|
+
end
|
666
|
+
|
667
|
+
|
668
|
+
|
669
|
+
|
670
|
+
|
671
|
+
|
672
|
+
|
673
|
+
# resource path
|
674
|
+
local_var_path = "/api/v2/scim/v2/serviceproviderconfig".sub('{format}','json')
|
675
|
+
|
676
|
+
# query parameters
|
677
|
+
query_params = {}
|
678
|
+
|
679
|
+
# header parameters
|
680
|
+
header_params = {}
|
681
|
+
|
682
|
+
# HTTP header 'Accept' (if needed)
|
683
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
684
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
685
|
+
|
686
|
+
# HTTP header 'Content-Type'
|
687
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
688
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
689
|
+
header_params[:'If-None-Match'] = opts[:'if_none_match'] if opts[:'if_none_match']
|
690
|
+
|
691
|
+
# form parameters
|
692
|
+
form_params = {}
|
693
|
+
|
694
|
+
# http body (model)
|
695
|
+
post_body = nil
|
696
|
+
|
697
|
+
auth_names = []
|
698
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
699
|
+
:header_params => header_params,
|
700
|
+
:query_params => query_params,
|
701
|
+
:form_params => form_params,
|
702
|
+
:body => post_body,
|
703
|
+
:auth_names => auth_names,
|
704
|
+
:return_type => 'ScimServiceProviderConfig')
|
705
|
+
if @api_client.config.debugging
|
706
|
+
@api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_serviceproviderconfig\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
707
|
+
end
|
708
|
+
return data, status_code, headers
|
709
|
+
end
|
710
|
+
|
711
|
+
# Return User with specified ID
|
712
|
+
#
|
713
|
+
# @param user_id
|
714
|
+
# @param [Hash] opts the optional parameters
|
715
|
+
# @option opts [String] :if_none_match If-None-Match for ETag version checking
|
716
|
+
# @return [ScimV2User]
|
717
|
+
def get_scim_v2_user(user_id, opts = {})
|
718
|
+
data, _status_code, _headers = get_scim_v2_user_with_http_info(user_id, opts)
|
719
|
+
return data
|
720
|
+
end
|
721
|
+
|
722
|
+
# Return User with specified ID
|
723
|
+
#
|
724
|
+
# @param user_id
|
725
|
+
# @param [Hash] opts the optional parameters
|
726
|
+
# @option opts [String] :if_none_match If-None-Match for ETag version checking
|
727
|
+
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
728
|
+
def get_scim_v2_user_with_http_info(user_id, opts = {})
|
729
|
+
if @api_client.config.debugging
|
730
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_user ..."
|
731
|
+
end
|
732
|
+
|
733
|
+
|
734
|
+
# verify the required parameter 'user_id' is set
|
735
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.get_scim_v2_user" if user_id.nil?
|
736
|
+
|
737
|
+
|
738
|
+
|
739
|
+
|
740
|
+
|
741
|
+
|
742
|
+
|
743
|
+
|
744
|
+
|
745
|
+
|
746
|
+
|
747
|
+
# resource path
|
748
|
+
local_var_path = "/api/v2/scim/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
749
|
+
|
750
|
+
# query parameters
|
751
|
+
query_params = {}
|
752
|
+
|
753
|
+
# header parameters
|
754
|
+
header_params = {}
|
755
|
+
|
756
|
+
# HTTP header 'Accept' (if needed)
|
757
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
758
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
759
|
+
|
760
|
+
# HTTP header 'Content-Type'
|
761
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
762
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
763
|
+
header_params[:'If-None-Match'] = opts[:'if_none_match'] if opts[:'if_none_match']
|
764
|
+
|
765
|
+
# form parameters
|
766
|
+
form_params = {}
|
767
|
+
|
768
|
+
# http body (model)
|
769
|
+
post_body = nil
|
770
|
+
|
771
|
+
auth_names = ['PureCloud OAuth']
|
772
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
773
|
+
:header_params => header_params,
|
774
|
+
:query_params => query_params,
|
775
|
+
:form_params => form_params,
|
776
|
+
:body => post_body,
|
777
|
+
:auth_names => auth_names,
|
778
|
+
:return_type => 'ScimV2User')
|
779
|
+
if @api_client.config.debugging
|
780
|
+
@api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
781
|
+
end
|
782
|
+
return data, status_code, headers
|
783
|
+
end
|
784
|
+
|
785
|
+
# Query Users
|
786
|
+
#
|
787
|
+
# @param filter filter parameter e.g. userName eq search@sample.org
|
788
|
+
# @param [Hash] opts the optional parameters
|
789
|
+
# @option opts [Integer] :start_index Starting item of request. 1-based (default to 1)
|
790
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count. (default to 25)
|
791
|
+
# @return [ScimListResponse]
|
792
|
+
def get_scim_v2_users(filter, opts = {})
|
793
|
+
data, _status_code, _headers = get_scim_v2_users_with_http_info(filter, opts)
|
794
|
+
return data
|
795
|
+
end
|
796
|
+
|
797
|
+
# Query Users
|
798
|
+
#
|
799
|
+
# @param filter filter parameter e.g. userName eq search@sample.org
|
800
|
+
# @param [Hash] opts the optional parameters
|
801
|
+
# @option opts [Integer] :start_index Starting item of request. 1-based
|
802
|
+
# @option opts [Integer] :count The requested number of items per page. A value of 0 will return no results other than the totalResults count.
|
803
|
+
# @return [Array<(ScimListResponse, Fixnum, Hash)>] ScimListResponse data, response status code and response headers
|
804
|
+
def get_scim_v2_users_with_http_info(filter, opts = {})
|
805
|
+
if @api_client.config.debugging
|
806
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_users ..."
|
807
|
+
end
|
808
|
+
|
809
|
+
|
810
|
+
# verify the required parameter 'filter' is set
|
811
|
+
fail ArgumentError, "Missing the required parameter 'filter' when calling SCIMApi.get_scim_v2_users" if filter.nil?
|
812
|
+
|
813
|
+
|
814
|
+
|
815
|
+
|
816
|
+
|
817
|
+
|
818
|
+
|
819
|
+
|
820
|
+
|
821
|
+
|
822
|
+
|
823
|
+
|
824
|
+
|
825
|
+
|
826
|
+
|
827
|
+
|
828
|
+
|
829
|
+
# resource path
|
830
|
+
local_var_path = "/api/v2/scim/v2/users".sub('{format}','json')
|
831
|
+
|
832
|
+
# query parameters
|
833
|
+
query_params = {}
|
834
|
+
query_params[:'filter'] = filter
|
835
|
+
query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
|
836
|
+
query_params[:'count'] = opts[:'count'] if opts[:'count']
|
837
|
+
|
838
|
+
# header parameters
|
839
|
+
header_params = {}
|
840
|
+
|
841
|
+
# HTTP header 'Accept' (if needed)
|
842
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
843
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
844
|
+
|
845
|
+
# HTTP header 'Content-Type'
|
846
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
847
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
848
|
+
|
849
|
+
# form parameters
|
850
|
+
form_params = {}
|
851
|
+
|
852
|
+
# http body (model)
|
853
|
+
post_body = nil
|
854
|
+
|
855
|
+
auth_names = ['PureCloud OAuth']
|
856
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
857
|
+
:header_params => header_params,
|
858
|
+
:query_params => query_params,
|
859
|
+
:form_params => form_params,
|
860
|
+
:body => post_body,
|
861
|
+
:auth_names => auth_names,
|
862
|
+
:return_type => 'ScimListResponse')
|
863
|
+
if @api_client.config.debugging
|
864
|
+
@api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
865
|
+
end
|
866
|
+
return data, status_code, headers
|
867
|
+
end
|
868
|
+
|
869
|
+
# Update Group with specified ID
|
870
|
+
#
|
871
|
+
# @param group_id
|
872
|
+
# @param body Group
|
873
|
+
# @param [Hash] opts the optional parameters
|
874
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
875
|
+
# @return [ScimV2Group]
|
876
|
+
def patch_scim_group(group_id, body, opts = {})
|
877
|
+
data, _status_code, _headers = patch_scim_group_with_http_info(group_id, body, opts)
|
878
|
+
return data
|
879
|
+
end
|
880
|
+
|
881
|
+
# Update Group with specified ID
|
882
|
+
#
|
883
|
+
# @param group_id
|
884
|
+
# @param body Group
|
885
|
+
# @param [Hash] opts the optional parameters
|
886
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
887
|
+
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
888
|
+
def patch_scim_group_with_http_info(group_id, body, opts = {})
|
889
|
+
if @api_client.config.debugging
|
890
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.patch_scim_group ..."
|
891
|
+
end
|
892
|
+
|
893
|
+
|
894
|
+
# verify the required parameter 'group_id' is set
|
895
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.patch_scim_group" if group_id.nil?
|
896
|
+
|
897
|
+
|
898
|
+
|
899
|
+
|
900
|
+
|
901
|
+
|
902
|
+
# verify the required parameter 'body' is set
|
903
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.patch_scim_group" if body.nil?
|
904
|
+
|
905
|
+
|
906
|
+
|
907
|
+
|
908
|
+
|
909
|
+
|
910
|
+
|
911
|
+
|
912
|
+
|
913
|
+
|
914
|
+
|
915
|
+
# resource path
|
916
|
+
local_var_path = "/api/v2/scim/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
|
917
|
+
|
918
|
+
# query parameters
|
919
|
+
query_params = {}
|
920
|
+
|
921
|
+
# header parameters
|
922
|
+
header_params = {}
|
923
|
+
|
924
|
+
# HTTP header 'Accept' (if needed)
|
925
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
926
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
927
|
+
|
928
|
+
# HTTP header 'Content-Type'
|
929
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
930
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
931
|
+
header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
|
932
|
+
|
933
|
+
# form parameters
|
934
|
+
form_params = {}
|
935
|
+
|
936
|
+
# http body (model)
|
937
|
+
post_body = @api_client.object_to_http_body(body)
|
938
|
+
|
939
|
+
auth_names = ['PureCloud OAuth']
|
940
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
941
|
+
:header_params => header_params,
|
942
|
+
:query_params => query_params,
|
943
|
+
:form_params => form_params,
|
944
|
+
:body => post_body,
|
945
|
+
:auth_names => auth_names,
|
946
|
+
:return_type => 'ScimV2Group')
|
947
|
+
if @api_client.config.debugging
|
948
|
+
@api_client.config.logger.debug "API called: SCIMApi#patch_scim_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
949
|
+
end
|
950
|
+
return data, status_code, headers
|
951
|
+
end
|
952
|
+
|
953
|
+
# Patch user with specified ID
|
954
|
+
#
|
955
|
+
# @param user_id
|
956
|
+
# @param body SCIM Patch Request
|
957
|
+
# @param [Hash] opts the optional parameters
|
958
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
959
|
+
# @return [ScimV2User]
|
960
|
+
def patch_scim_user(user_id, body, opts = {})
|
961
|
+
data, _status_code, _headers = patch_scim_user_with_http_info(user_id, body, opts)
|
962
|
+
return data
|
963
|
+
end
|
964
|
+
|
965
|
+
# Patch user with specified ID
|
966
|
+
#
|
967
|
+
# @param user_id
|
968
|
+
# @param body SCIM Patch Request
|
969
|
+
# @param [Hash] opts the optional parameters
|
970
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
971
|
+
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
972
|
+
def patch_scim_user_with_http_info(user_id, body, opts = {})
|
973
|
+
if @api_client.config.debugging
|
974
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.patch_scim_user ..."
|
975
|
+
end
|
976
|
+
|
977
|
+
|
978
|
+
# verify the required parameter 'user_id' is set
|
979
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.patch_scim_user" if user_id.nil?
|
980
|
+
|
981
|
+
|
982
|
+
|
983
|
+
|
984
|
+
|
985
|
+
|
986
|
+
# verify the required parameter 'body' is set
|
987
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.patch_scim_user" if body.nil?
|
988
|
+
|
989
|
+
|
990
|
+
|
991
|
+
|
992
|
+
|
993
|
+
|
994
|
+
|
995
|
+
|
996
|
+
|
997
|
+
|
998
|
+
|
999
|
+
# resource path
|
1000
|
+
local_var_path = "/api/v2/scim/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1001
|
+
|
1002
|
+
# query parameters
|
1003
|
+
query_params = {}
|
1004
|
+
|
1005
|
+
# header parameters
|
1006
|
+
header_params = {}
|
1007
|
+
|
1008
|
+
# HTTP header 'Accept' (if needed)
|
1009
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
1010
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1011
|
+
|
1012
|
+
# HTTP header 'Content-Type'
|
1013
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
1014
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1015
|
+
header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
|
1016
|
+
|
1017
|
+
# form parameters
|
1018
|
+
form_params = {}
|
1019
|
+
|
1020
|
+
# http body (model)
|
1021
|
+
post_body = @api_client.object_to_http_body(body)
|
1022
|
+
|
1023
|
+
auth_names = ['PureCloud OAuth']
|
1024
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
1025
|
+
:header_params => header_params,
|
1026
|
+
:query_params => query_params,
|
1027
|
+
:form_params => form_params,
|
1028
|
+
:body => post_body,
|
1029
|
+
:auth_names => auth_names,
|
1030
|
+
:return_type => 'ScimV2User')
|
1031
|
+
if @api_client.config.debugging
|
1032
|
+
@api_client.config.logger.debug "API called: SCIMApi#patch_scim_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1033
|
+
end
|
1034
|
+
return data, status_code, headers
|
1035
|
+
end
|
1036
|
+
|
1037
|
+
# Update Group with specified ID
|
1038
|
+
#
|
1039
|
+
# @param group_id
|
1040
|
+
# @param body Group
|
1041
|
+
# @param [Hash] opts the optional parameters
|
1042
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1043
|
+
# @return [ScimV2Group]
|
1044
|
+
def patch_scim_v2_group(group_id, body, opts = {})
|
1045
|
+
data, _status_code, _headers = patch_scim_v2_group_with_http_info(group_id, body, opts)
|
1046
|
+
return data
|
1047
|
+
end
|
1048
|
+
|
1049
|
+
# Update Group with specified ID
|
1050
|
+
#
|
1051
|
+
# @param group_id
|
1052
|
+
# @param body Group
|
1053
|
+
# @param [Hash] opts the optional parameters
|
1054
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1055
|
+
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
1056
|
+
def patch_scim_v2_group_with_http_info(group_id, body, opts = {})
|
1057
|
+
if @api_client.config.debugging
|
1058
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.patch_scim_v2_group ..."
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
|
1062
|
+
# verify the required parameter 'group_id' is set
|
1063
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.patch_scim_v2_group" if group_id.nil?
|
1064
|
+
|
1065
|
+
|
1066
|
+
|
1067
|
+
|
1068
|
+
|
1069
|
+
|
1070
|
+
# verify the required parameter 'body' is set
|
1071
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.patch_scim_v2_group" if body.nil?
|
1072
|
+
|
1073
|
+
|
1074
|
+
|
1075
|
+
|
1076
|
+
|
1077
|
+
|
1078
|
+
|
1079
|
+
|
1080
|
+
|
1081
|
+
|
1082
|
+
|
1083
|
+
# resource path
|
1084
|
+
local_var_path = "/api/v2/scim/v2/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
|
1085
|
+
|
1086
|
+
# query parameters
|
1087
|
+
query_params = {}
|
1088
|
+
|
1089
|
+
# header parameters
|
1090
|
+
header_params = {}
|
1091
|
+
|
1092
|
+
# HTTP header 'Accept' (if needed)
|
1093
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
1094
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1095
|
+
|
1096
|
+
# HTTP header 'Content-Type'
|
1097
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
1098
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1099
|
+
header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
|
1100
|
+
|
1101
|
+
# form parameters
|
1102
|
+
form_params = {}
|
1103
|
+
|
1104
|
+
# http body (model)
|
1105
|
+
post_body = @api_client.object_to_http_body(body)
|
1106
|
+
|
1107
|
+
auth_names = ['PureCloud OAuth']
|
1108
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
1109
|
+
:header_params => header_params,
|
1110
|
+
:query_params => query_params,
|
1111
|
+
:form_params => form_params,
|
1112
|
+
:body => post_body,
|
1113
|
+
:auth_names => auth_names,
|
1114
|
+
:return_type => 'ScimV2Group')
|
1115
|
+
if @api_client.config.debugging
|
1116
|
+
@api_client.config.logger.debug "API called: SCIMApi#patch_scim_v2_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1117
|
+
end
|
1118
|
+
return data, status_code, headers
|
1119
|
+
end
|
1120
|
+
|
1121
|
+
# Update user with specified ID
|
1122
|
+
#
|
1123
|
+
# @param user_id User Id
|
1124
|
+
# @param body SCIM Patch Request
|
1125
|
+
# @param [Hash] opts the optional parameters
|
1126
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1127
|
+
# @return [ScimV2User]
|
1128
|
+
def patch_scim_v2_user(user_id, body, opts = {})
|
1129
|
+
data, _status_code, _headers = patch_scim_v2_user_with_http_info(user_id, body, opts)
|
1130
|
+
return data
|
1131
|
+
end
|
1132
|
+
|
1133
|
+
# Update user with specified ID
|
1134
|
+
#
|
1135
|
+
# @param user_id User Id
|
1136
|
+
# @param body SCIM Patch Request
|
1137
|
+
# @param [Hash] opts the optional parameters
|
1138
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1139
|
+
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
1140
|
+
def patch_scim_v2_user_with_http_info(user_id, body, opts = {})
|
1141
|
+
if @api_client.config.debugging
|
1142
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.patch_scim_v2_user ..."
|
1143
|
+
end
|
1144
|
+
|
1145
|
+
|
1146
|
+
# verify the required parameter 'user_id' is set
|
1147
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.patch_scim_v2_user" if user_id.nil?
|
1148
|
+
|
1149
|
+
|
1150
|
+
|
1151
|
+
|
1152
|
+
|
1153
|
+
|
1154
|
+
# verify the required parameter 'body' is set
|
1155
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.patch_scim_v2_user" if body.nil?
|
1156
|
+
|
1157
|
+
|
1158
|
+
|
1159
|
+
|
1160
|
+
|
1161
|
+
|
1162
|
+
|
1163
|
+
|
1164
|
+
|
1165
|
+
|
1166
|
+
|
1167
|
+
# resource path
|
1168
|
+
local_var_path = "/api/v2/scim/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1169
|
+
|
1170
|
+
# query parameters
|
1171
|
+
query_params = {}
|
1172
|
+
|
1173
|
+
# header parameters
|
1174
|
+
header_params = {}
|
1175
|
+
|
1176
|
+
# HTTP header 'Accept' (if needed)
|
1177
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
1178
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1179
|
+
|
1180
|
+
# HTTP header 'Content-Type'
|
1181
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
1182
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1183
|
+
header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
|
1184
|
+
|
1185
|
+
# form parameters
|
1186
|
+
form_params = {}
|
1187
|
+
|
1188
|
+
# http body (model)
|
1189
|
+
post_body = @api_client.object_to_http_body(body)
|
1190
|
+
|
1191
|
+
auth_names = ['PureCloud OAuth']
|
1192
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
1193
|
+
:header_params => header_params,
|
1194
|
+
:query_params => query_params,
|
1195
|
+
:form_params => form_params,
|
1196
|
+
:body => post_body,
|
1197
|
+
:auth_names => auth_names,
|
1198
|
+
:return_type => 'ScimV2User')
|
1199
|
+
if @api_client.config.debugging
|
1200
|
+
@api_client.config.logger.debug "API called: SCIMApi#patch_scim_v2_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1201
|
+
end
|
1202
|
+
return data, status_code, headers
|
1203
|
+
end
|
1204
|
+
|
1205
|
+
# Create user
|
1206
|
+
#
|
1207
|
+
# @param body SCIM Create User
|
1208
|
+
# @param [Hash] opts the optional parameters
|
1209
|
+
# @return [ScimV2User]
|
1210
|
+
def post_scim_users(body, opts = {})
|
1211
|
+
data, _status_code, _headers = post_scim_users_with_http_info(body, opts)
|
1212
|
+
return data
|
1213
|
+
end
|
1214
|
+
|
1215
|
+
# Create user
|
1216
|
+
#
|
1217
|
+
# @param body SCIM Create User
|
1218
|
+
# @param [Hash] opts the optional parameters
|
1219
|
+
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
1220
|
+
def post_scim_users_with_http_info(body, opts = {})
|
1221
|
+
if @api_client.config.debugging
|
1222
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.post_scim_users ..."
|
1223
|
+
end
|
1224
|
+
|
1225
|
+
|
1226
|
+
# verify the required parameter 'body' is set
|
1227
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.post_scim_users" if body.nil?
|
1228
|
+
|
1229
|
+
|
1230
|
+
|
1231
|
+
|
1232
|
+
|
1233
|
+
# resource path
|
1234
|
+
local_var_path = "/api/v2/scim/users".sub('{format}','json')
|
1235
|
+
|
1236
|
+
# query parameters
|
1237
|
+
query_params = {}
|
1238
|
+
|
1239
|
+
# header parameters
|
1240
|
+
header_params = {}
|
1241
|
+
|
1242
|
+
# HTTP header 'Accept' (if needed)
|
1243
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
1244
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1245
|
+
|
1246
|
+
# HTTP header 'Content-Type'
|
1247
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
1248
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1249
|
+
|
1250
|
+
# form parameters
|
1251
|
+
form_params = {}
|
1252
|
+
|
1253
|
+
# http body (model)
|
1254
|
+
post_body = @api_client.object_to_http_body(body)
|
1255
|
+
|
1256
|
+
auth_names = ['PureCloud OAuth']
|
1257
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1258
|
+
:header_params => header_params,
|
1259
|
+
:query_params => query_params,
|
1260
|
+
:form_params => form_params,
|
1261
|
+
:body => post_body,
|
1262
|
+
:auth_names => auth_names,
|
1263
|
+
:return_type => 'ScimV2User')
|
1264
|
+
if @api_client.config.debugging
|
1265
|
+
@api_client.config.logger.debug "API called: SCIMApi#post_scim_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1266
|
+
end
|
1267
|
+
return data, status_code, headers
|
1268
|
+
end
|
1269
|
+
|
1270
|
+
# Create user
|
1271
|
+
#
|
1272
|
+
# @param body SCIM Create User
|
1273
|
+
# @param [Hash] opts the optional parameters
|
1274
|
+
# @return [ScimV2User]
|
1275
|
+
def post_scim_v2_users(body, opts = {})
|
1276
|
+
data, _status_code, _headers = post_scim_v2_users_with_http_info(body, opts)
|
1277
|
+
return data
|
1278
|
+
end
|
1279
|
+
|
1280
|
+
# Create user
|
1281
|
+
#
|
1282
|
+
# @param body SCIM Create User
|
1283
|
+
# @param [Hash] opts the optional parameters
|
1284
|
+
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
1285
|
+
def post_scim_v2_users_with_http_info(body, opts = {})
|
1286
|
+
if @api_client.config.debugging
|
1287
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.post_scim_v2_users ..."
|
1288
|
+
end
|
1289
|
+
|
1290
|
+
|
1291
|
+
# verify the required parameter 'body' is set
|
1292
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.post_scim_v2_users" if body.nil?
|
1293
|
+
|
1294
|
+
|
1295
|
+
|
1296
|
+
|
1297
|
+
|
1298
|
+
# resource path
|
1299
|
+
local_var_path = "/api/v2/scim/v2/users".sub('{format}','json')
|
1300
|
+
|
1301
|
+
# query parameters
|
1302
|
+
query_params = {}
|
1303
|
+
|
1304
|
+
# header parameters
|
1305
|
+
header_params = {}
|
1306
|
+
|
1307
|
+
# HTTP header 'Accept' (if needed)
|
1308
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
1309
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1310
|
+
|
1311
|
+
# HTTP header 'Content-Type'
|
1312
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
1313
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1314
|
+
|
1315
|
+
# form parameters
|
1316
|
+
form_params = {}
|
1317
|
+
|
1318
|
+
# http body (model)
|
1319
|
+
post_body = @api_client.object_to_http_body(body)
|
1320
|
+
|
1321
|
+
auth_names = ['PureCloud OAuth']
|
1322
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1323
|
+
:header_params => header_params,
|
1324
|
+
:query_params => query_params,
|
1325
|
+
:form_params => form_params,
|
1326
|
+
:body => post_body,
|
1327
|
+
:auth_names => auth_names,
|
1328
|
+
:return_type => 'ScimV2User')
|
1329
|
+
if @api_client.config.debugging
|
1330
|
+
@api_client.config.logger.debug "API called: SCIMApi#post_scim_v2_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1331
|
+
end
|
1332
|
+
return data, status_code, headers
|
1333
|
+
end
|
1334
|
+
|
1335
|
+
# Update Group with specified ID
|
1336
|
+
#
|
1337
|
+
# @param group_id
|
1338
|
+
# @param body Group
|
1339
|
+
# @param [Hash] opts the optional parameters
|
1340
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1341
|
+
# @return [ScimV2Group]
|
1342
|
+
def put_scim_group(group_id, body, opts = {})
|
1343
|
+
data, _status_code, _headers = put_scim_group_with_http_info(group_id, body, opts)
|
1344
|
+
return data
|
1345
|
+
end
|
1346
|
+
|
1347
|
+
# Update Group with specified ID
|
1348
|
+
#
|
1349
|
+
# @param group_id
|
1350
|
+
# @param body Group
|
1351
|
+
# @param [Hash] opts the optional parameters
|
1352
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1353
|
+
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
1354
|
+
def put_scim_group_with_http_info(group_id, body, opts = {})
|
1355
|
+
if @api_client.config.debugging
|
1356
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.put_scim_group ..."
|
1357
|
+
end
|
1358
|
+
|
1359
|
+
|
1360
|
+
# verify the required parameter 'group_id' is set
|
1361
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.put_scim_group" if group_id.nil?
|
1362
|
+
|
1363
|
+
|
1364
|
+
|
1365
|
+
|
1366
|
+
|
1367
|
+
|
1368
|
+
# verify the required parameter 'body' is set
|
1369
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.put_scim_group" if body.nil?
|
1370
|
+
|
1371
|
+
|
1372
|
+
|
1373
|
+
|
1374
|
+
|
1375
|
+
|
1376
|
+
|
1377
|
+
|
1378
|
+
|
1379
|
+
|
1380
|
+
|
1381
|
+
# resource path
|
1382
|
+
local_var_path = "/api/v2/scim/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
|
1383
|
+
|
1384
|
+
# query parameters
|
1385
|
+
query_params = {}
|
1386
|
+
|
1387
|
+
# header parameters
|
1388
|
+
header_params = {}
|
1389
|
+
|
1390
|
+
# HTTP header 'Accept' (if needed)
|
1391
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
1392
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1393
|
+
|
1394
|
+
# HTTP header 'Content-Type'
|
1395
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
1396
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1397
|
+
header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
|
1398
|
+
|
1399
|
+
# form parameters
|
1400
|
+
form_params = {}
|
1401
|
+
|
1402
|
+
# http body (model)
|
1403
|
+
post_body = @api_client.object_to_http_body(body)
|
1404
|
+
|
1405
|
+
auth_names = ['PureCloud OAuth']
|
1406
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1407
|
+
:header_params => header_params,
|
1408
|
+
:query_params => query_params,
|
1409
|
+
:form_params => form_params,
|
1410
|
+
:body => post_body,
|
1411
|
+
:auth_names => auth_names,
|
1412
|
+
:return_type => 'ScimV2Group')
|
1413
|
+
if @api_client.config.debugging
|
1414
|
+
@api_client.config.logger.debug "API called: SCIMApi#put_scim_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1415
|
+
end
|
1416
|
+
return data, status_code, headers
|
1417
|
+
end
|
1418
|
+
|
1419
|
+
# Update user with specified ID
|
1420
|
+
#
|
1421
|
+
# @param user_id
|
1422
|
+
# @param body User
|
1423
|
+
# @param [Hash] opts the optional parameters
|
1424
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1425
|
+
# @return [ScimV2User]
|
1426
|
+
def put_scim_user(user_id, body, opts = {})
|
1427
|
+
data, _status_code, _headers = put_scim_user_with_http_info(user_id, body, opts)
|
1428
|
+
return data
|
1429
|
+
end
|
1430
|
+
|
1431
|
+
# Update user with specified ID
|
1432
|
+
#
|
1433
|
+
# @param user_id
|
1434
|
+
# @param body User
|
1435
|
+
# @param [Hash] opts the optional parameters
|
1436
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1437
|
+
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
1438
|
+
def put_scim_user_with_http_info(user_id, body, opts = {})
|
1439
|
+
if @api_client.config.debugging
|
1440
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.put_scim_user ..."
|
1441
|
+
end
|
1442
|
+
|
1443
|
+
|
1444
|
+
# verify the required parameter 'user_id' is set
|
1445
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.put_scim_user" if user_id.nil?
|
1446
|
+
|
1447
|
+
|
1448
|
+
|
1449
|
+
|
1450
|
+
|
1451
|
+
|
1452
|
+
# verify the required parameter 'body' is set
|
1453
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.put_scim_user" if body.nil?
|
1454
|
+
|
1455
|
+
|
1456
|
+
|
1457
|
+
|
1458
|
+
|
1459
|
+
|
1460
|
+
|
1461
|
+
|
1462
|
+
|
1463
|
+
|
1464
|
+
|
1465
|
+
# resource path
|
1466
|
+
local_var_path = "/api/v2/scim/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1467
|
+
|
1468
|
+
# query parameters
|
1469
|
+
query_params = {}
|
1470
|
+
|
1471
|
+
# header parameters
|
1472
|
+
header_params = {}
|
1473
|
+
|
1474
|
+
# HTTP header 'Accept' (if needed)
|
1475
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
1476
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1477
|
+
|
1478
|
+
# HTTP header 'Content-Type'
|
1479
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
1480
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1481
|
+
header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
|
1482
|
+
|
1483
|
+
# form parameters
|
1484
|
+
form_params = {}
|
1485
|
+
|
1486
|
+
# http body (model)
|
1487
|
+
post_body = @api_client.object_to_http_body(body)
|
1488
|
+
|
1489
|
+
auth_names = ['PureCloud OAuth']
|
1490
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1491
|
+
:header_params => header_params,
|
1492
|
+
:query_params => query_params,
|
1493
|
+
:form_params => form_params,
|
1494
|
+
:body => post_body,
|
1495
|
+
:auth_names => auth_names,
|
1496
|
+
:return_type => 'ScimV2User')
|
1497
|
+
if @api_client.config.debugging
|
1498
|
+
@api_client.config.logger.debug "API called: SCIMApi#put_scim_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1499
|
+
end
|
1500
|
+
return data, status_code, headers
|
1501
|
+
end
|
1502
|
+
|
1503
|
+
# Update Group with specified ID
|
1504
|
+
#
|
1505
|
+
# @param group_id
|
1506
|
+
# @param body Group
|
1507
|
+
# @param [Hash] opts the optional parameters
|
1508
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1509
|
+
# @return [ScimV2Group]
|
1510
|
+
def put_scim_v2_group(group_id, body, opts = {})
|
1511
|
+
data, _status_code, _headers = put_scim_v2_group_with_http_info(group_id, body, opts)
|
1512
|
+
return data
|
1513
|
+
end
|
1514
|
+
|
1515
|
+
# Update Group with specified ID
|
1516
|
+
#
|
1517
|
+
# @param group_id
|
1518
|
+
# @param body Group
|
1519
|
+
# @param [Hash] opts the optional parameters
|
1520
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1521
|
+
# @return [Array<(ScimV2Group, Fixnum, Hash)>] ScimV2Group data, response status code and response headers
|
1522
|
+
def put_scim_v2_group_with_http_info(group_id, body, opts = {})
|
1523
|
+
if @api_client.config.debugging
|
1524
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.put_scim_v2_group ..."
|
1525
|
+
end
|
1526
|
+
|
1527
|
+
|
1528
|
+
# verify the required parameter 'group_id' is set
|
1529
|
+
fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.put_scim_v2_group" if group_id.nil?
|
1530
|
+
|
1531
|
+
|
1532
|
+
|
1533
|
+
|
1534
|
+
|
1535
|
+
|
1536
|
+
# verify the required parameter 'body' is set
|
1537
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.put_scim_v2_group" if body.nil?
|
1538
|
+
|
1539
|
+
|
1540
|
+
|
1541
|
+
|
1542
|
+
|
1543
|
+
|
1544
|
+
|
1545
|
+
|
1546
|
+
|
1547
|
+
|
1548
|
+
|
1549
|
+
# resource path
|
1550
|
+
local_var_path = "/api/v2/scim/v2/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
|
1551
|
+
|
1552
|
+
# query parameters
|
1553
|
+
query_params = {}
|
1554
|
+
|
1555
|
+
# header parameters
|
1556
|
+
header_params = {}
|
1557
|
+
|
1558
|
+
# HTTP header 'Accept' (if needed)
|
1559
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
1560
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1561
|
+
|
1562
|
+
# HTTP header 'Content-Type'
|
1563
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
1564
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1565
|
+
header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
|
1566
|
+
|
1567
|
+
# form parameters
|
1568
|
+
form_params = {}
|
1569
|
+
|
1570
|
+
# http body (model)
|
1571
|
+
post_body = @api_client.object_to_http_body(body)
|
1572
|
+
|
1573
|
+
auth_names = ['PureCloud OAuth']
|
1574
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1575
|
+
:header_params => header_params,
|
1576
|
+
:query_params => query_params,
|
1577
|
+
:form_params => form_params,
|
1578
|
+
:body => post_body,
|
1579
|
+
:auth_names => auth_names,
|
1580
|
+
:return_type => 'ScimV2Group')
|
1581
|
+
if @api_client.config.debugging
|
1582
|
+
@api_client.config.logger.debug "API called: SCIMApi#put_scim_v2_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1583
|
+
end
|
1584
|
+
return data, status_code, headers
|
1585
|
+
end
|
1586
|
+
|
1587
|
+
# Update user with specified ID
|
1588
|
+
#
|
1589
|
+
# @param user_id User Id
|
1590
|
+
# @param body User
|
1591
|
+
# @param [Hash] opts the optional parameters
|
1592
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1593
|
+
# @return [ScimV2User]
|
1594
|
+
def put_scim_v2_user(user_id, body, opts = {})
|
1595
|
+
data, _status_code, _headers = put_scim_v2_user_with_http_info(user_id, body, opts)
|
1596
|
+
return data
|
1597
|
+
end
|
1598
|
+
|
1599
|
+
# Update user with specified ID
|
1600
|
+
#
|
1601
|
+
# @param user_id User Id
|
1602
|
+
# @param body User
|
1603
|
+
# @param [Hash] opts the optional parameters
|
1604
|
+
# @option opts [String] :if_match If-Match for ETag version checking
|
1605
|
+
# @return [Array<(ScimV2User, Fixnum, Hash)>] ScimV2User data, response status code and response headers
|
1606
|
+
def put_scim_v2_user_with_http_info(user_id, body, opts = {})
|
1607
|
+
if @api_client.config.debugging
|
1608
|
+
@api_client.config.logger.debug "Calling API: SCIMApi.put_scim_v2_user ..."
|
1609
|
+
end
|
1610
|
+
|
1611
|
+
|
1612
|
+
# verify the required parameter 'user_id' is set
|
1613
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.put_scim_v2_user" if user_id.nil?
|
1614
|
+
|
1615
|
+
|
1616
|
+
|
1617
|
+
|
1618
|
+
|
1619
|
+
|
1620
|
+
# verify the required parameter 'body' is set
|
1621
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.put_scim_v2_user" if body.nil?
|
1622
|
+
|
1623
|
+
|
1624
|
+
|
1625
|
+
|
1626
|
+
|
1627
|
+
|
1628
|
+
|
1629
|
+
|
1630
|
+
|
1631
|
+
|
1632
|
+
|
1633
|
+
# resource path
|
1634
|
+
local_var_path = "/api/v2/scim/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
|
1635
|
+
|
1636
|
+
# query parameters
|
1637
|
+
query_params = {}
|
1638
|
+
|
1639
|
+
# header parameters
|
1640
|
+
header_params = {}
|
1641
|
+
|
1642
|
+
# HTTP header 'Accept' (if needed)
|
1643
|
+
local_header_accept = ['application/json', 'application/scim+json']
|
1644
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1645
|
+
|
1646
|
+
# HTTP header 'Content-Type'
|
1647
|
+
local_header_content_type = ['application/json', 'application/scim+json']
|
1648
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1649
|
+
header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']
|
1650
|
+
|
1651
|
+
# form parameters
|
1652
|
+
form_params = {}
|
1653
|
+
|
1654
|
+
# http body (model)
|
1655
|
+
post_body = @api_client.object_to_http_body(body)
|
1656
|
+
|
1657
|
+
auth_names = ['PureCloud OAuth']
|
1658
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1659
|
+
:header_params => header_params,
|
1660
|
+
:query_params => query_params,
|
1661
|
+
:form_params => form_params,
|
1662
|
+
:body => post_body,
|
1663
|
+
:auth_names => auth_names,
|
1664
|
+
:return_type => 'ScimV2User')
|
1665
|
+
if @api_client.config.debugging
|
1666
|
+
@api_client.config.logger.debug "API called: SCIMApi#put_scim_v2_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1667
|
+
end
|
1668
|
+
return data, status_code, headers
|
1669
|
+
end
|
1670
|
+
end
|
1671
|
+
end
|