purecloudplatformclientv2 58.0.1 → 59.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActionEntityListing.md +1 -1
- data/docs/{Skill.md → AddressableEntityRef.md} +2 -2
- data/docs/Agent.md +1 -2
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/ArchitectApi.md +298 -14
- data/docs/AsyncConversationQuery.md +21 -0
- 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/CallHistoryConversation.md +1 -0
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallHistoryParticipant.md +1 -0
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionViewListing.md +1 -1
- data/docs/CampaignEntityListing.md +1 -1
- data/docs/CampaignRuleEntityListing.md +1 -1
- data/docs/CampaignSequenceEntityListing.md +1 -1
- data/docs/CertificateAuthorityEntityListing.md +1 -1
- data/docs/ChatConversationEntityListing.md +1 -1
- data/docs/ClientAppEntityListing.md +1 -1
- data/docs/CobrowseConversationEntityListing.md +1 -1
- data/docs/CommandStatusEntityListing.md +1 -1
- data/docs/ConsumedResourcesEntityListing.md +1 -1
- data/docs/ConsumingResourcesEntityListing.md +1 -1
- data/docs/ContactListDivisionViewListing.md +1 -1
- data/docs/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/Conversation.md +1 -0
- data/docs/ConversationBasic.md +1 -0
- data/docs/ConversationChatEventTopicChatMediaParticipant.md +1 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationEventTopicChat.md +1 -0
- data/docs/ConversationProperties.md +1 -0
- data/docs/ConversationRoutingData.md +3 -3
- data/docs/CreateManagementUnitApiRequest.md +1 -1
- data/docs/CreateUser.md +1 -1
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataSchema.md +4 -5
- 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/DialogflowAgent.md +18 -0
- data/docs/DialogflowAgentSummary.md +17 -0
- data/docs/DialogflowAgentSummaryEntityListing.md +22 -0
- data/docs/DialogflowIntent.md +14 -0
- data/docs/DialogflowParameter.md +14 -0
- data/docs/DialogflowProject.md +14 -0
- 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/EmailMediaParticipant.md +1 -0
- data/docs/EmailMessage.md +1 -0
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExecuteRecordingJobsQuery.md +13 -0
- 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/FlowOutcome.md +17 -0
- data/docs/FlowOutcomeListing.md +22 -0
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GreetingListing.md +1 -1
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/IVREntityListing.md +1 -1
- data/docs/InboundDomainEntityListing.md +1 -1
- data/docs/InboundRouteEntityListing.md +1 -1
- data/docs/IntegrationEntityListing.md +1 -1
- data/docs/IntegrationEventEntityListing.md +1 -1
- data/docs/IntegrationTypeEntityListing.md +1 -1
- data/docs/IntegrationsApi.md +762 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguageOverride.md +15 -0
- data/docs/LexBot.md +16 -0
- data/docs/LexBotAlias.md +21 -0
- data/docs/LexBotAliasEntityListing.md +22 -0
- data/docs/LexBotEntityListing.md +22 -0
- data/docs/LexIntent.md +16 -0
- data/docs/LexSlot.md +16 -0
- 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/LocationDefinition.md +2 -0
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationImage.md +14 -0
- data/docs/LocationsApi.md +6 -2
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnit.md +5 -6
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MessagingApi.md +1211 -134
- data/docs/MessagingIntegration.md +23 -0
- data/docs/MessagingIntegrationEntityListing.md +22 -0
- data/docs/MessagingStickerEntityListing.md +1 -1
- data/docs/MoveManagementUnitRequest.md +13 -0
- data/docs/MoveManagementUnitResponse.md +14 -0
- data/docs/NoteListing.md +1 -1
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundRouteBaseEntityListing.md +1 -1
- data/docs/OutboundRouteEntityListing.md +1 -1
- data/docs/PermissionCollectionEntityListing.md +1 -1
- data/docs/PhoneBaseEntityListing.md +1 -1
- data/docs/PhoneEntityListing.md +1 -1
- data/docs/PhoneMetaBaseEntityListing.md +1 -1
- data/docs/PhysicalInterfaceEntityListing.md +1 -1
- data/docs/PolicyEntityListing.md +1 -1
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityAudit.md +1 -0
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueConversationChatEventTopicChatMediaParticipant.md +1 -0
- data/docs/QueueConversationEventTopicChat.md +1 -0
- data/docs/QueueConversationSocialExpressionEventTopicChat.md +1 -0
- data/docs/QueueConversationVideoEventTopicChat.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 +335 -0
- data/docs/RecordingJob.md +23 -0
- data/docs/RecordingJobEntityListing.md +22 -0
- data/docs/RecordingJobsQuery.md +15 -0
- data/docs/RelationshipListing.md +1 -1
- data/docs/ReportMetaDataEntityListing.md +1 -1
- data/docs/ReportRunEntryEntityDomainListing.md +1 -1
- data/docs/ReportScheduleEntityListing.md +1 -1
- data/docs/ReportingExportJobListing.md +1 -1
- data/docs/ResponseEntityList.md +1 -1
- data/docs/ResponseEntityListing.md +1 -1
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +1 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/SCIMApi.md +145 -145
- 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/ScoredAgent.md +1 -1
- 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/SmsPhoneNumberEntityListing.md +1 -1
- data/docs/StationEntityListing.md +1 -1
- data/docs/SubjectDivisionGrantsEntityListing.md +1 -1
- data/docs/SubscriptionOverviewUsage.md +1 -0
- data/docs/SurveyFormEntityListing.md +1 -1
- data/docs/SystemPromptAssetEntityListing.md +1 -1
- data/docs/SystemPromptEntityListing.md +1 -1
- data/docs/TagValueEntityListing.md +1 -1
- data/docs/TextMessageListing.md +1 -1
- data/docs/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/TtsEngineEntity.md +20 -0
- data/docs/TtsEngineEntityListing.md +22 -0
- data/docs/TtsSettings.md +14 -0
- data/docs/TtsVoiceEntity.md +19 -0
- data/docs/TtsVoiceEntityListing.md +22 -0
- data/docs/TwitterIntegrationEntityListing.md +1 -1
- data/docs/UpdateManagementUnitRequest.md +15 -0
- 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/WebChatMemberInfoEntityList.md +1 -1
- data/docs/WfmMoveManagementUnitTopicBusinessUnit.md +13 -0
- data/docs/WfmMoveManagementUnitTopicMoveManagementUnitNotification.md +14 -0
- data/docs/WfmUserNotificationTopicTimeOffRequestNotification.md +18 -0
- data/docs/WfmUserNotificationTopicWfmUserNotification.md +1 -0
- data/docs/WorkforceManagementApi.md +158 -18
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +35 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +334 -6
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +851 -0
- data/lib/purecloudplatformclientv2/api/locations_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +1111 -6
- data/lib/purecloudplatformclientv2/api/recording_api.rb +342 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/scim_api.rb +124 -124
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +163 -21
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/{skill.rb → addressable_entity_ref.rb} +1 -1
- data/lib/purecloudplatformclientv2/models/agent.rb +8 -32
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/async_conversation_query.rb +448 -0
- 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.rb +27 -1
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/call_history_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_division_view_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation.rb +29 -1
- data/lib/purecloudplatformclientv2/models/conversation_basic.rb +29 -1
- data/lib/purecloudplatformclientv2/models/conversation_chat_event_topic_chat_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_properties.rb +27 -1
- data/lib/purecloudplatformclientv2/models/conversation_routing_data.rb +3 -3
- data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_user.rb +5 -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/data_schema.rb +5 -31
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/dialogflow_agent.rb +335 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary.rb +305 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_agent_summary_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_intent.rb +240 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_parameter.rb +238 -0
- data/lib/purecloudplatformclientv2/models/dialogflow_project.rb +226 -0
- 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_media_participant.rb +30 -4
- data/lib/purecloudplatformclientv2/models/email_message.rb +27 -1
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/execute_recording_jobs_query.rb +221 -0
- 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_outcome.rb +309 -0
- data/lib/purecloudplatformclientv2/models/flow_outcome_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/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/keyword_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/language_override.rb +269 -0
- data/lib/purecloudplatformclientv2/models/lex_bot.rb +279 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_alias.rb +444 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_alias_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/lex_bot_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/lex_intent.rb +297 -0
- data/lib/purecloudplatformclientv2/models/lex_slot.rb +290 -0
- 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_definition.rb +56 -1
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/location_image.rb +227 -0
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/management_unit.rb +21 -57
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/messaging_integration.rb +510 -0
- data/lib/purecloudplatformclientv2/models/messaging_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/move_management_unit_request.rb +207 -0
- data/lib/purecloudplatformclientv2/models/move_management_unit_response.rb +242 -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/organization_presence_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/quality_audit.rb +26 -1
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_conversation_chat_event_topic_chat_media_participant.rb +29 -4
- data/lib/purecloudplatformclientv2/models/queue_conversation_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_social_expression_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_conversation_video_event_topic_chat.rb +26 -1
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/recording_job.rb +480 -0
- data/lib/purecloudplatformclientv2/models/recording_job_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/recording_jobs_query.rb +283 -0
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/reporting_export_job_request.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_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/scored_agent.rb +1 -1
- 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_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/subscription_overview_usage.rb +30 -4
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/tts_engine_entity.rb +399 -0
- data/lib/purecloudplatformclientv2/models/tts_engine_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/tts_settings.rb +240 -0
- data/lib/purecloudplatformclientv2/models/tts_voice_entity.rb +372 -0
- data/lib/purecloudplatformclientv2/models/tts_voice_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +12 -12
- data/lib/purecloudplatformclientv2/models/update_management_unit_request.rb +254 -0
- 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_member_info_entity_list.rb +12 -12
- data/lib/purecloudplatformclientv2/models/wfm_move_management_unit_topic_business_unit.rb +201 -0
- data/lib/purecloudplatformclientv2/models/wfm_move_management_unit_topic_move_management_unit_notification.rb +240 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_time_off_request_notification.rb +344 -0
- data/lib/purecloudplatformclientv2/models/wfm_user_notification_topic_wfm_user_notification.rb +28 -3
- 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 +72 -4
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: RecordingJob
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::RecordingJob
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **state** | **String** | The current state of the job. | |
|
|
13
|
+
| **recording_jobs_query** | [**RecordingJobsQuery**](RecordingJobsQuery.html) | Original query of the job. | [optional] |
|
|
14
|
+
| **date_created** | **DateTime** | Date when the job was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
|
15
|
+
| **total_conversations** | **Integer** | Total number of conversations affected. | [optional] |
|
|
16
|
+
| **total_recordings** | **Integer** | Total number of recordings affected. | [optional] |
|
|
17
|
+
| **total_processed_recordings** | **Integer** | Total number of recordings have been processed. | [optional] |
|
|
18
|
+
| **percent_progress** | **Integer** | Progress in percentage based on the number of recordings | [optional] |
|
|
19
|
+
| **error_message** | **String** | Error occurred during the job execution | [optional] |
|
|
20
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
|
21
|
+
{: class="table table-striped"}
|
|
22
|
+
|
|
23
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: RecordingJobEntityListing
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::RecordingJobEntityListing
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **entities** | [**Array<RecordingJob>**](RecordingJob.html) | | [optional] |
|
|
11
|
+
| **page_size** | **Integer** | | [optional] |
|
|
12
|
+
| **page_number** | **Integer** | | [optional] |
|
|
13
|
+
| **total** | **Integer** | | [optional] |
|
|
14
|
+
| **first_uri** | **String** | | [optional] |
|
|
15
|
+
| **self_uri** | **String** | | [optional] |
|
|
16
|
+
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
|
19
|
+
| **page_count** | **Integer** | | [optional] |
|
|
20
|
+
{: class="table table-striped"}
|
|
21
|
+
|
|
22
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: RecordingJobsQuery
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::RecordingJobsQuery
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **action** | **String** | Operation to perform bulk task | |
|
|
11
|
+
| **action_date** | **DateTime** | The date when the action will be performed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
|
|
12
|
+
| **conversation_query** | [**AsyncConversationQuery**](AsyncConversationQuery.html) | Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query. | |
|
|
13
|
+
{: class="table table-striped"}
|
|
14
|
+
|
|
15
|
+
|
data/docs/RelationshipListing.md
CHANGED
|
@@ -13,8 +13,8 @@ title: RelationshipListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: ReportMetaDataEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: ReportRunEntryEntityDomainListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: ReportScheduleEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: ReportingExportJobListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/ResponseEntityList.md
CHANGED
|
@@ -13,8 +13,8 @@ title: ResponseEntityList
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: ResponseEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
|
@@ -13,8 +13,8 @@ title: ResponseSetEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/RoutingApi.md
CHANGED
|
@@ -2320,7 +2320,7 @@ end
|
|
|
2320
2320
|
Name | Type | Description | Notes
|
|
2321
2321
|
------------- | ------------- | ------------- | -------------
|
|
2322
2322
|
**phone_number** | **String**| Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used. | [optional] |
|
|
2323
|
-
**phone_number_type** | **String**| Filter on phone number type | [optional] <br />**Values**: local, mobile, tollfree |
|
|
2323
|
+
**phone_number_type** | **String**| Filter on phone number type | [optional] <br />**Values**: local, mobile, tollfree, shortcode |
|
|
2324
2324
|
**phone_number_status** | **String**| Filter on phone number status | [optional] <br />**Values**: active, invalid, porting |
|
|
2325
2325
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
2326
2326
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
@@ -13,8 +13,8 @@ title: RuleSetEntityListing
|
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
|
14
14
|
| **first_uri** | **String** | | [optional] |
|
|
15
15
|
| **self_uri** | **String** | | [optional] |
|
|
16
|
-
| **next_uri** | **String** | | [optional] |
|
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
|
17
|
+
| **next_uri** | **String** | | [optional] |
|
|
18
18
|
| **last_uri** | **String** | | [optional] |
|
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
|
20
20
|
{: class="table table-striped"}
|
data/docs/SCIMApi.md
CHANGED
|
@@ -8,27 +8,27 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
|
8
8
|
|
|
9
9
|
Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
|
11
|
-
[**delete_scim_user**](SCIMApi.html#delete_scim_user) |
|
|
12
|
-
[**delete_scim_v2_user**](SCIMApi.html#delete_scim_v2_user) |
|
|
13
|
-
[**get_scim_group**](SCIMApi.html#get_scim_group) |
|
|
14
|
-
[**get_scim_groups**](SCIMApi.html#get_scim_groups) |
|
|
15
|
-
[**get_scim_user**](SCIMApi.html#get_scim_user) |
|
|
16
|
-
[**get_scim_users**](SCIMApi.html#get_scim_users) |
|
|
17
|
-
[**get_scim_v2_group**](SCIMApi.html#get_scim_v2_group) |
|
|
18
|
-
[**get_scim_v2_groups**](SCIMApi.html#get_scim_v2_groups) |
|
|
19
|
-
[**get_scim_v2_serviceproviderconfig**](SCIMApi.html#get_scim_v2_serviceproviderconfig) | Get SCIM
|
|
20
|
-
[**get_scim_v2_user**](SCIMApi.html#get_scim_v2_user) |
|
|
21
|
-
[**get_scim_v2_users**](SCIMApi.html#get_scim_v2_users) |
|
|
22
|
-
[**patch_scim_group**](SCIMApi.html#patch_scim_group) |
|
|
23
|
-
[**patch_scim_user**](SCIMApi.html#patch_scim_user) |
|
|
24
|
-
[**patch_scim_v2_group**](SCIMApi.html#patch_scim_v2_group) |
|
|
25
|
-
[**patch_scim_v2_user**](SCIMApi.html#patch_scim_v2_user) |
|
|
26
|
-
[**post_scim_users**](SCIMApi.html#post_scim_users) | Create user
|
|
27
|
-
[**post_scim_v2_users**](SCIMApi.html#post_scim_v2_users) | Create user
|
|
28
|
-
[**put_scim_group**](SCIMApi.html#put_scim_group) |
|
|
29
|
-
[**put_scim_user**](SCIMApi.html#put_scim_user) |
|
|
30
|
-
[**put_scim_v2_group**](SCIMApi.html#put_scim_v2_group) |
|
|
31
|
-
[**put_scim_v2_user**](SCIMApi.html#put_scim_v2_user) |
|
|
11
|
+
[**delete_scim_user**](SCIMApi.html#delete_scim_user) | Delete a user
|
|
12
|
+
[**delete_scim_v2_user**](SCIMApi.html#delete_scim_v2_user) | Delete a user
|
|
13
|
+
[**get_scim_group**](SCIMApi.html#get_scim_group) | Get a group
|
|
14
|
+
[**get_scim_groups**](SCIMApi.html#get_scim_groups) | Get a list of groups
|
|
15
|
+
[**get_scim_user**](SCIMApi.html#get_scim_user) | Get a user
|
|
16
|
+
[**get_scim_users**](SCIMApi.html#get_scim_users) | Get a list of users
|
|
17
|
+
[**get_scim_v2_group**](SCIMApi.html#get_scim_v2_group) | Get a group
|
|
18
|
+
[**get_scim_v2_groups**](SCIMApi.html#get_scim_v2_groups) | Get a list of groups
|
|
19
|
+
[**get_scim_v2_serviceproviderconfig**](SCIMApi.html#get_scim_v2_serviceproviderconfig) | Get the SCIM configuration
|
|
20
|
+
[**get_scim_v2_user**](SCIMApi.html#get_scim_v2_user) | Get a user
|
|
21
|
+
[**get_scim_v2_users**](SCIMApi.html#get_scim_v2_users) | Get a list of users
|
|
22
|
+
[**patch_scim_group**](SCIMApi.html#patch_scim_group) | Modify a group
|
|
23
|
+
[**patch_scim_user**](SCIMApi.html#patch_scim_user) | Modify a user
|
|
24
|
+
[**patch_scim_v2_group**](SCIMApi.html#patch_scim_v2_group) | Modify a group
|
|
25
|
+
[**patch_scim_v2_user**](SCIMApi.html#patch_scim_v2_user) | Modify a user
|
|
26
|
+
[**post_scim_users**](SCIMApi.html#post_scim_users) | Create a user
|
|
27
|
+
[**post_scim_v2_users**](SCIMApi.html#post_scim_v2_users) | Create a user
|
|
28
|
+
[**put_scim_group**](SCIMApi.html#put_scim_group) | Replace a group
|
|
29
|
+
[**put_scim_user**](SCIMApi.html#put_scim_user) | Replace a user
|
|
30
|
+
[**put_scim_v2_group**](SCIMApi.html#put_scim_v2_group) | Replace a group
|
|
31
|
+
[**put_scim_v2_user**](SCIMApi.html#put_scim_v2_user) | Replace a user
|
|
32
32
|
{: class="table table-striped"}
|
|
33
33
|
|
|
34
34
|
<a name="delete_scim_user"></a>
|
|
@@ -37,7 +37,7 @@ Method | Description
|
|
|
37
37
|
|
|
38
38
|
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
Delete a user
|
|
41
41
|
|
|
42
42
|
|
|
43
43
|
|
|
@@ -65,14 +65,14 @@ end
|
|
|
65
65
|
|
|
66
66
|
api_instance = PureCloud::SCIMApi.new
|
|
67
67
|
|
|
68
|
-
user_id = "user_id_example" # String |
|
|
68
|
+
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
|
|
69
69
|
|
|
70
70
|
opts = {
|
|
71
|
-
if_match: "if_match_example" # String | If
|
|
71
|
+
if_match: "if_match_example" # String | The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
|
|
72
72
|
}
|
|
73
73
|
|
|
74
74
|
begin
|
|
75
|
-
#
|
|
75
|
+
#Delete a user
|
|
76
76
|
result = api_instance.delete_scim_user(user_id, opts)
|
|
77
77
|
p result
|
|
78
78
|
rescue PureCloud::ApiError => e
|
|
@@ -84,8 +84,8 @@ end
|
|
|
84
84
|
|
|
85
85
|
Name | Type | Description | Notes
|
|
86
86
|
------------- | ------------- | ------------- | -------------
|
|
87
|
-
**user_id** | **String**|
|
|
88
|
-
**if_match** | **String**| If
|
|
87
|
+
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
88
|
+
**if_match** | **String**| The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request. | [optional] |
|
|
89
89
|
{: class="table table-striped"}
|
|
90
90
|
|
|
91
91
|
|
|
@@ -106,7 +106,7 @@ Name | Type | Description | Notes
|
|
|
106
106
|
|
|
107
107
|
|
|
108
108
|
|
|
109
|
-
|
|
109
|
+
Delete a user
|
|
110
110
|
|
|
111
111
|
|
|
112
112
|
|
|
@@ -134,14 +134,14 @@ end
|
|
|
134
134
|
|
|
135
135
|
api_instance = PureCloud::SCIMApi.new
|
|
136
136
|
|
|
137
|
-
user_id = "user_id_example" # String |
|
|
137
|
+
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
138
138
|
|
|
139
139
|
opts = {
|
|
140
|
-
if_match: "if_match_example" # String | If
|
|
140
|
+
if_match: "if_match_example" # String | The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
|
|
141
141
|
}
|
|
142
142
|
|
|
143
143
|
begin
|
|
144
|
-
#
|
|
144
|
+
#Delete a user
|
|
145
145
|
result = api_instance.delete_scim_v2_user(user_id, opts)
|
|
146
146
|
p result
|
|
147
147
|
rescue PureCloud::ApiError => e
|
|
@@ -153,8 +153,8 @@ end
|
|
|
153
153
|
|
|
154
154
|
Name | Type | Description | Notes
|
|
155
155
|
------------- | ------------- | ------------- | -------------
|
|
156
|
-
**user_id** | **String**|
|
|
157
|
-
**if_match** | **String**| If
|
|
156
|
+
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
157
|
+
**if_match** | **String**| The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request. | [optional] |
|
|
158
158
|
{: class="table table-striped"}
|
|
159
159
|
|
|
160
160
|
|
|
@@ -175,7 +175,7 @@ Name | Type | Description | Notes
|
|
|
175
175
|
|
|
176
176
|
|
|
177
177
|
|
|
178
|
-
|
|
178
|
+
Get a group
|
|
179
179
|
|
|
180
180
|
|
|
181
181
|
|
|
@@ -203,14 +203,14 @@ end
|
|
|
203
203
|
|
|
204
204
|
api_instance = PureCloud::SCIMApi.new
|
|
205
205
|
|
|
206
|
-
group_id = "group_id_example" # String |
|
|
206
|
+
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
207
207
|
|
|
208
208
|
opts = {
|
|
209
|
-
if_none_match: "if_none_match_example" # String | If
|
|
209
|
+
if_none_match: "if_none_match_example" # String | The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
|
|
210
210
|
}
|
|
211
211
|
|
|
212
212
|
begin
|
|
213
|
-
#
|
|
213
|
+
#Get a group
|
|
214
214
|
result = api_instance.get_scim_group(group_id, opts)
|
|
215
215
|
p result
|
|
216
216
|
rescue PureCloud::ApiError => e
|
|
@@ -222,8 +222,8 @@ end
|
|
|
222
222
|
|
|
223
223
|
Name | Type | Description | Notes
|
|
224
224
|
------------- | ------------- | ------------- | -------------
|
|
225
|
-
**group_id** | **String**|
|
|
226
|
-
**if_none_match** | **String**| If
|
|
225
|
+
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups. | |
|
|
226
|
+
**if_none_match** | **String**| The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified. | [optional] |
|
|
227
227
|
{: class="table table-striped"}
|
|
228
228
|
|
|
229
229
|
|
|
@@ -244,7 +244,7 @@ Name | Type | Description | Notes
|
|
|
244
244
|
|
|
245
245
|
|
|
246
246
|
|
|
247
|
-
|
|
247
|
+
Get a list of groups
|
|
248
248
|
|
|
249
249
|
|
|
250
250
|
|
|
@@ -273,13 +273,13 @@ end
|
|
|
273
273
|
api_instance = PureCloud::SCIMApi.new
|
|
274
274
|
|
|
275
275
|
opts = {
|
|
276
|
-
start_index: 1, # Integer |
|
|
277
|
-
count: 25, # Integer | The requested number of items per page. A value of 0
|
|
278
|
-
filter: "displayName eq groupName" # String |
|
|
276
|
+
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
277
|
+
count: 25, # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
278
|
+
filter: "displayName eq groupName" # String | Filters results.
|
|
279
279
|
}
|
|
280
280
|
|
|
281
281
|
begin
|
|
282
|
-
#
|
|
282
|
+
#Get a list of groups
|
|
283
283
|
result = api_instance.get_scim_groups(opts)
|
|
284
284
|
p result
|
|
285
285
|
rescue PureCloud::ApiError => e
|
|
@@ -291,9 +291,9 @@ end
|
|
|
291
291
|
|
|
292
292
|
Name | Type | Description | Notes
|
|
293
293
|
------------- | ------------- | ------------- | -------------
|
|
294
|
-
**start_index** | **Integer**|
|
|
295
|
-
**count** | **Integer**| The requested number of items per page. A value of 0
|
|
296
|
-
**filter** | **String**|
|
|
294
|
+
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
295
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults. | [optional] [default to 25] |
|
|
296
|
+
**filter** | **String**| Filters results. | [optional] |
|
|
297
297
|
{: class="table table-striped"}
|
|
298
298
|
|
|
299
299
|
|
|
@@ -314,7 +314,7 @@ Name | Type | Description | Notes
|
|
|
314
314
|
|
|
315
315
|
|
|
316
316
|
|
|
317
|
-
|
|
317
|
+
Get a user
|
|
318
318
|
|
|
319
319
|
|
|
320
320
|
|
|
@@ -343,14 +343,14 @@ end
|
|
|
343
343
|
|
|
344
344
|
api_instance = PureCloud::SCIMApi.new
|
|
345
345
|
|
|
346
|
-
user_id = "user_id_example" # String |
|
|
346
|
+
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
|
|
347
347
|
|
|
348
348
|
opts = {
|
|
349
|
-
if_none_match: "if_none_match_example" # String | If
|
|
349
|
+
if_none_match: "if_none_match_example" # String | The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
|
|
350
350
|
}
|
|
351
351
|
|
|
352
352
|
begin
|
|
353
|
-
#
|
|
353
|
+
#Get a user
|
|
354
354
|
result = api_instance.get_scim_user(user_id, opts)
|
|
355
355
|
p result
|
|
356
356
|
rescue PureCloud::ApiError => e
|
|
@@ -362,8 +362,8 @@ end
|
|
|
362
362
|
|
|
363
363
|
Name | Type | Description | Notes
|
|
364
364
|
------------- | ------------- | ------------- | -------------
|
|
365
|
-
**user_id** | **String**|
|
|
366
|
-
**if_none_match** | **String**| If
|
|
365
|
+
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
366
|
+
**if_none_match** | **String**| The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified. | [optional] |
|
|
367
367
|
{: class="table table-striped"}
|
|
368
368
|
|
|
369
369
|
|
|
@@ -384,7 +384,7 @@ Name | Type | Description | Notes
|
|
|
384
384
|
|
|
385
385
|
|
|
386
386
|
|
|
387
|
-
|
|
387
|
+
Get a list of users
|
|
388
388
|
|
|
389
389
|
|
|
390
390
|
|
|
@@ -413,15 +413,15 @@ end
|
|
|
413
413
|
|
|
414
414
|
api_instance = PureCloud::SCIMApi.new
|
|
415
415
|
|
|
416
|
-
filter = "filter_example" # String |
|
|
416
|
+
filter = "filter_example" # String | Filters results.
|
|
417
417
|
|
|
418
418
|
opts = {
|
|
419
|
-
start_index: 1, # Integer |
|
|
420
|
-
count: 25 # Integer | The requested number of items per page. A value of 0
|
|
419
|
+
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
420
|
+
count: 25 # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
421
421
|
}
|
|
422
422
|
|
|
423
423
|
begin
|
|
424
|
-
#
|
|
424
|
+
#Get a list of users
|
|
425
425
|
result = api_instance.get_scim_users(filter, opts)
|
|
426
426
|
p result
|
|
427
427
|
rescue PureCloud::ApiError => e
|
|
@@ -433,9 +433,9 @@ end
|
|
|
433
433
|
|
|
434
434
|
Name | Type | Description | Notes
|
|
435
435
|
------------- | ------------- | ------------- | -------------
|
|
436
|
-
**filter** | **String**|
|
|
437
|
-
**start_index** | **Integer**|
|
|
438
|
-
**count** | **Integer**| The requested number of items per page. A value of 0
|
|
436
|
+
**filter** | **String**| Filters results. | |
|
|
437
|
+
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
438
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults. | [optional] [default to 25] |
|
|
439
439
|
{: class="table table-striped"}
|
|
440
440
|
|
|
441
441
|
|
|
@@ -456,7 +456,7 @@ Name | Type | Description | Notes
|
|
|
456
456
|
|
|
457
457
|
|
|
458
458
|
|
|
459
|
-
|
|
459
|
+
Get a group
|
|
460
460
|
|
|
461
461
|
|
|
462
462
|
|
|
@@ -484,14 +484,14 @@ end
|
|
|
484
484
|
|
|
485
485
|
api_instance = PureCloud::SCIMApi.new
|
|
486
486
|
|
|
487
|
-
group_id = "group_id_example" # String |
|
|
487
|
+
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
488
488
|
|
|
489
489
|
opts = {
|
|
490
|
-
if_none_match: "if_none_match_example" # String | If
|
|
490
|
+
if_none_match: "if_none_match_example" # String | The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
|
|
491
491
|
}
|
|
492
492
|
|
|
493
493
|
begin
|
|
494
|
-
#
|
|
494
|
+
#Get a group
|
|
495
495
|
result = api_instance.get_scim_v2_group(group_id, opts)
|
|
496
496
|
p result
|
|
497
497
|
rescue PureCloud::ApiError => e
|
|
@@ -503,8 +503,8 @@ end
|
|
|
503
503
|
|
|
504
504
|
Name | Type | Description | Notes
|
|
505
505
|
------------- | ------------- | ------------- | -------------
|
|
506
|
-
**group_id** | **String**|
|
|
507
|
-
**if_none_match** | **String**| If
|
|
506
|
+
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
507
|
+
**if_none_match** | **String**| The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified. | [optional] |
|
|
508
508
|
{: class="table table-striped"}
|
|
509
509
|
|
|
510
510
|
|
|
@@ -525,7 +525,7 @@ Name | Type | Description | Notes
|
|
|
525
525
|
|
|
526
526
|
|
|
527
527
|
|
|
528
|
-
|
|
528
|
+
Get a list of groups
|
|
529
529
|
|
|
530
530
|
|
|
531
531
|
|
|
@@ -553,15 +553,15 @@ end
|
|
|
553
553
|
|
|
554
554
|
api_instance = PureCloud::SCIMApi.new
|
|
555
555
|
|
|
556
|
-
filter = "displayName eq groupName" # String |
|
|
556
|
+
filter = "displayName eq groupName" # String | Filters results.
|
|
557
557
|
|
|
558
558
|
opts = {
|
|
559
|
-
start_index: 1, # Integer |
|
|
560
|
-
count: 25 # Integer | The requested number of items per page. A value of 0
|
|
559
|
+
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
560
|
+
count: 25 # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
561
561
|
}
|
|
562
562
|
|
|
563
563
|
begin
|
|
564
|
-
#
|
|
564
|
+
#Get a list of groups
|
|
565
565
|
result = api_instance.get_scim_v2_groups(filter, opts)
|
|
566
566
|
p result
|
|
567
567
|
rescue PureCloud::ApiError => e
|
|
@@ -573,9 +573,9 @@ end
|
|
|
573
573
|
|
|
574
574
|
Name | Type | Description | Notes
|
|
575
575
|
------------- | ------------- | ------------- | -------------
|
|
576
|
-
**filter** | **String**|
|
|
577
|
-
**start_index** | **Integer**|
|
|
578
|
-
**count** | **Integer**| The requested number of items per page. A value of 0
|
|
576
|
+
**filter** | **String**| Filters results. | |
|
|
577
|
+
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
578
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults. | [optional] [default to 25] |
|
|
579
579
|
{: class="table table-striped"}
|
|
580
580
|
|
|
581
581
|
|
|
@@ -596,7 +596,7 @@ Name | Type | Description | Notes
|
|
|
596
596
|
|
|
597
597
|
|
|
598
598
|
|
|
599
|
-
Get SCIM
|
|
599
|
+
Get the SCIM configuration
|
|
600
600
|
|
|
601
601
|
|
|
602
602
|
|
|
@@ -614,11 +614,11 @@ require 'purecloudplatformclientv2'
|
|
|
614
614
|
api_instance = PureCloud::SCIMApi.new
|
|
615
615
|
|
|
616
616
|
opts = {
|
|
617
|
-
if_none_match: "if_none_match_example" # String | If
|
|
617
|
+
if_none_match: "if_none_match_example" # String | The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
|
|
618
618
|
}
|
|
619
619
|
|
|
620
620
|
begin
|
|
621
|
-
#Get SCIM
|
|
621
|
+
#Get the SCIM configuration
|
|
622
622
|
result = api_instance.get_scim_v2_serviceproviderconfig(opts)
|
|
623
623
|
p result
|
|
624
624
|
rescue PureCloud::ApiError => e
|
|
@@ -630,7 +630,7 @@ end
|
|
|
630
630
|
|
|
631
631
|
Name | Type | Description | Notes
|
|
632
632
|
------------- | ------------- | ------------- | -------------
|
|
633
|
-
**if_none_match** | **String**| If
|
|
633
|
+
**if_none_match** | **String**| The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified. | [optional] |
|
|
634
634
|
{: class="table table-striped"}
|
|
635
635
|
|
|
636
636
|
|
|
@@ -651,7 +651,7 @@ Name | Type | Description | Notes
|
|
|
651
651
|
|
|
652
652
|
|
|
653
653
|
|
|
654
|
-
|
|
654
|
+
Get a user
|
|
655
655
|
|
|
656
656
|
|
|
657
657
|
|
|
@@ -680,14 +680,14 @@ end
|
|
|
680
680
|
|
|
681
681
|
api_instance = PureCloud::SCIMApi.new
|
|
682
682
|
|
|
683
|
-
user_id = "user_id_example" # String |
|
|
683
|
+
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
684
684
|
|
|
685
685
|
opts = {
|
|
686
|
-
if_none_match: "if_none_match_example" # String | If
|
|
686
|
+
if_none_match: "if_none_match_example" # String | The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified.
|
|
687
687
|
}
|
|
688
688
|
|
|
689
689
|
begin
|
|
690
|
-
#
|
|
690
|
+
#Get a user
|
|
691
691
|
result = api_instance.get_scim_v2_user(user_id, opts)
|
|
692
692
|
p result
|
|
693
693
|
rescue PureCloud::ApiError => e
|
|
@@ -699,8 +699,8 @@ end
|
|
|
699
699
|
|
|
700
700
|
Name | Type | Description | Notes
|
|
701
701
|
------------- | ------------- | ------------- | -------------
|
|
702
|
-
**user_id** | **String**|
|
|
703
|
-
**if_none_match** | **String**| If
|
|
702
|
+
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
703
|
+
**if_none_match** | **String**| The ETag of a resource. If no match is found, returns request. If match is found, returns 304 Not Modified. | [optional] |
|
|
704
704
|
{: class="table table-striped"}
|
|
705
705
|
|
|
706
706
|
|
|
@@ -721,7 +721,7 @@ Name | Type | Description | Notes
|
|
|
721
721
|
|
|
722
722
|
|
|
723
723
|
|
|
724
|
-
|
|
724
|
+
Get a list of users
|
|
725
725
|
|
|
726
726
|
|
|
727
727
|
|
|
@@ -750,15 +750,15 @@ end
|
|
|
750
750
|
|
|
751
751
|
api_instance = PureCloud::SCIMApi.new
|
|
752
752
|
|
|
753
|
-
filter = "filter_example" # String |
|
|
753
|
+
filter = "filter_example" # String | Filters results.
|
|
754
754
|
|
|
755
755
|
opts = {
|
|
756
|
-
start_index: 1, # Integer |
|
|
757
|
-
count: 25 # Integer | The requested number of items per page. A value of 0
|
|
756
|
+
start_index: 1, # Integer | The 1-based index of the first query result.
|
|
757
|
+
count: 25 # Integer | The requested number of items per page. A value of 0 returns totalResults.
|
|
758
758
|
}
|
|
759
759
|
|
|
760
760
|
begin
|
|
761
|
-
#
|
|
761
|
+
#Get a list of users
|
|
762
762
|
result = api_instance.get_scim_v2_users(filter, opts)
|
|
763
763
|
p result
|
|
764
764
|
rescue PureCloud::ApiError => e
|
|
@@ -770,9 +770,9 @@ end
|
|
|
770
770
|
|
|
771
771
|
Name | Type | Description | Notes
|
|
772
772
|
------------- | ------------- | ------------- | -------------
|
|
773
|
-
**filter** | **String**|
|
|
774
|
-
**start_index** | **Integer**|
|
|
775
|
-
**count** | **Integer**| The requested number of items per page. A value of 0
|
|
773
|
+
**filter** | **String**| Filters results. | |
|
|
774
|
+
**start_index** | **Integer**| The 1-based index of the first query result. | [optional] [default to 1] |
|
|
775
|
+
**count** | **Integer**| The requested number of items per page. A value of 0 returns totalResults. | [optional] [default to 25] |
|
|
776
776
|
{: class="table table-striped"}
|
|
777
777
|
|
|
778
778
|
|
|
@@ -793,7 +793,7 @@ Name | Type | Description | Notes
|
|
|
793
793
|
|
|
794
794
|
|
|
795
795
|
|
|
796
|
-
|
|
796
|
+
Modify a group
|
|
797
797
|
|
|
798
798
|
|
|
799
799
|
|
|
@@ -821,16 +821,16 @@ end
|
|
|
821
821
|
|
|
822
822
|
api_instance = PureCloud::SCIMApi.new
|
|
823
823
|
|
|
824
|
-
group_id = "group_id_example" # String |
|
|
824
|
+
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
825
825
|
|
|
826
826
|
body = PureCloud::PatchRequest.new # PatchRequest | Group
|
|
827
827
|
|
|
828
828
|
opts = {
|
|
829
|
-
if_match: "if_match_example" # String | If
|
|
829
|
+
if_match: "if_match_example" # String | The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
|
|
830
830
|
}
|
|
831
831
|
|
|
832
832
|
begin
|
|
833
|
-
#
|
|
833
|
+
#Modify a group
|
|
834
834
|
result = api_instance.patch_scim_group(group_id, body, opts)
|
|
835
835
|
p result
|
|
836
836
|
rescue PureCloud::ApiError => e
|
|
@@ -842,9 +842,9 @@ end
|
|
|
842
842
|
|
|
843
843
|
Name | Type | Description | Notes
|
|
844
844
|
------------- | ------------- | ------------- | -------------
|
|
845
|
-
**group_id** | **String**|
|
|
845
|
+
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups. | |
|
|
846
846
|
**body** | [**PatchRequest**](PatchRequest.html)| Group | |
|
|
847
|
-
**if_match** | **String**| If
|
|
847
|
+
**if_match** | **String**| The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request. | [optional] |
|
|
848
848
|
{: class="table table-striped"}
|
|
849
849
|
|
|
850
850
|
|
|
@@ -865,7 +865,7 @@ Name | Type | Description | Notes
|
|
|
865
865
|
|
|
866
866
|
|
|
867
867
|
|
|
868
|
-
|
|
868
|
+
Modify a user
|
|
869
869
|
|
|
870
870
|
|
|
871
871
|
|
|
@@ -894,16 +894,16 @@ end
|
|
|
894
894
|
|
|
895
895
|
api_instance = PureCloud::SCIMApi.new
|
|
896
896
|
|
|
897
|
-
user_id = "user_id_example" # String |
|
|
897
|
+
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
|
|
898
898
|
|
|
899
899
|
body = PureCloud::ScimV2PatchRequest.new # ScimV2PatchRequest | SCIM Patch Request
|
|
900
900
|
|
|
901
901
|
opts = {
|
|
902
|
-
if_match: "if_match_example" # String | If
|
|
902
|
+
if_match: "if_match_example" # String | The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
|
|
903
903
|
}
|
|
904
904
|
|
|
905
905
|
begin
|
|
906
|
-
#
|
|
906
|
+
#Modify a user
|
|
907
907
|
result = api_instance.patch_scim_user(user_id, body, opts)
|
|
908
908
|
p result
|
|
909
909
|
rescue PureCloud::ApiError => e
|
|
@@ -915,9 +915,9 @@ end
|
|
|
915
915
|
|
|
916
916
|
Name | Type | Description | Notes
|
|
917
917
|
------------- | ------------- | ------------- | -------------
|
|
918
|
-
**user_id** | **String**|
|
|
918
|
+
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
919
919
|
**body** | [**ScimV2PatchRequest**](ScimV2PatchRequest.html)| SCIM Patch Request | |
|
|
920
|
-
**if_match** | **String**| If
|
|
920
|
+
**if_match** | **String**| The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request. | [optional] |
|
|
921
921
|
{: class="table table-striped"}
|
|
922
922
|
|
|
923
923
|
|
|
@@ -938,7 +938,7 @@ Name | Type | Description | Notes
|
|
|
938
938
|
|
|
939
939
|
|
|
940
940
|
|
|
941
|
-
|
|
941
|
+
Modify a group
|
|
942
942
|
|
|
943
943
|
|
|
944
944
|
|
|
@@ -966,16 +966,16 @@ end
|
|
|
966
966
|
|
|
967
967
|
api_instance = PureCloud::SCIMApi.new
|
|
968
968
|
|
|
969
|
-
group_id = "group_id_example" # String |
|
|
969
|
+
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
970
970
|
|
|
971
971
|
body = PureCloud::PatchRequest.new # PatchRequest | Group
|
|
972
972
|
|
|
973
973
|
opts = {
|
|
974
|
-
if_match: "if_match_example" # String | If
|
|
974
|
+
if_match: "if_match_example" # String | The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
|
|
975
975
|
}
|
|
976
976
|
|
|
977
977
|
begin
|
|
978
|
-
#
|
|
978
|
+
#Modify a group
|
|
979
979
|
result = api_instance.patch_scim_v2_group(group_id, body, opts)
|
|
980
980
|
p result
|
|
981
981
|
rescue PureCloud::ApiError => e
|
|
@@ -987,9 +987,9 @@ end
|
|
|
987
987
|
|
|
988
988
|
Name | Type | Description | Notes
|
|
989
989
|
------------- | ------------- | ------------- | -------------
|
|
990
|
-
**group_id** | **String**|
|
|
990
|
+
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
991
991
|
**body** | [**PatchRequest**](PatchRequest.html)| Group | |
|
|
992
|
-
**if_match** | **String**| If
|
|
992
|
+
**if_match** | **String**| The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request. | [optional] |
|
|
993
993
|
{: class="table table-striped"}
|
|
994
994
|
|
|
995
995
|
|
|
@@ -1010,7 +1010,7 @@ Name | Type | Description | Notes
|
|
|
1010
1010
|
|
|
1011
1011
|
|
|
1012
1012
|
|
|
1013
|
-
|
|
1013
|
+
Modify a user
|
|
1014
1014
|
|
|
1015
1015
|
|
|
1016
1016
|
|
|
@@ -1039,16 +1039,16 @@ end
|
|
|
1039
1039
|
|
|
1040
1040
|
api_instance = PureCloud::SCIMApi.new
|
|
1041
1041
|
|
|
1042
|
-
user_id = "user_id_example" # String |
|
|
1042
|
+
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
1043
1043
|
|
|
1044
1044
|
body = PureCloud::ScimV2PatchRequest.new # ScimV2PatchRequest | SCIM Patch Request
|
|
1045
1045
|
|
|
1046
1046
|
opts = {
|
|
1047
|
-
if_match: "if_match_example" # String | If
|
|
1047
|
+
if_match: "if_match_example" # String | The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
|
|
1048
1048
|
}
|
|
1049
1049
|
|
|
1050
1050
|
begin
|
|
1051
|
-
#
|
|
1051
|
+
#Modify a user
|
|
1052
1052
|
result = api_instance.patch_scim_v2_user(user_id, body, opts)
|
|
1053
1053
|
p result
|
|
1054
1054
|
rescue PureCloud::ApiError => e
|
|
@@ -1060,9 +1060,9 @@ end
|
|
|
1060
1060
|
|
|
1061
1061
|
Name | Type | Description | Notes
|
|
1062
1062
|
------------- | ------------- | ------------- | -------------
|
|
1063
|
-
**user_id** | **String**|
|
|
1063
|
+
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
1064
1064
|
**body** | [**ScimV2PatchRequest**](ScimV2PatchRequest.html)| SCIM Patch Request | |
|
|
1065
|
-
**if_match** | **String**| If
|
|
1065
|
+
**if_match** | **String**| The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request. | [optional] |
|
|
1066
1066
|
{: class="table table-striped"}
|
|
1067
1067
|
|
|
1068
1068
|
|
|
@@ -1083,7 +1083,7 @@ Name | Type | Description | Notes
|
|
|
1083
1083
|
|
|
1084
1084
|
|
|
1085
1085
|
|
|
1086
|
-
Create user
|
|
1086
|
+
Create a user
|
|
1087
1087
|
|
|
1088
1088
|
|
|
1089
1089
|
|
|
@@ -1115,7 +1115,7 @@ body = PureCloud::ScimV2CreateUser.new # ScimV2CreateUser | SCIM Create User
|
|
|
1115
1115
|
|
|
1116
1116
|
|
|
1117
1117
|
begin
|
|
1118
|
-
#Create user
|
|
1118
|
+
#Create a user
|
|
1119
1119
|
result = api_instance.post_scim_users(body)
|
|
1120
1120
|
p result
|
|
1121
1121
|
rescue PureCloud::ApiError => e
|
|
@@ -1148,7 +1148,7 @@ Name | Type | Description | Notes
|
|
|
1148
1148
|
|
|
1149
1149
|
|
|
1150
1150
|
|
|
1151
|
-
Create user
|
|
1151
|
+
Create a user
|
|
1152
1152
|
|
|
1153
1153
|
|
|
1154
1154
|
|
|
@@ -1180,7 +1180,7 @@ body = PureCloud::ScimV2CreateUser.new # ScimV2CreateUser | SCIM Create User
|
|
|
1180
1180
|
|
|
1181
1181
|
|
|
1182
1182
|
begin
|
|
1183
|
-
#Create user
|
|
1183
|
+
#Create a user
|
|
1184
1184
|
result = api_instance.post_scim_v2_users(body)
|
|
1185
1185
|
p result
|
|
1186
1186
|
rescue PureCloud::ApiError => e
|
|
@@ -1213,7 +1213,7 @@ Name | Type | Description | Notes
|
|
|
1213
1213
|
|
|
1214
1214
|
|
|
1215
1215
|
|
|
1216
|
-
|
|
1216
|
+
Replace a group
|
|
1217
1217
|
|
|
1218
1218
|
|
|
1219
1219
|
|
|
@@ -1241,16 +1241,16 @@ end
|
|
|
1241
1241
|
|
|
1242
1242
|
api_instance = PureCloud::SCIMApi.new
|
|
1243
1243
|
|
|
1244
|
-
group_id = "group_id_example" # String |
|
|
1244
|
+
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
1245
1245
|
|
|
1246
1246
|
body = PureCloud::ScimV2Group.new # ScimV2Group | Group
|
|
1247
1247
|
|
|
1248
1248
|
opts = {
|
|
1249
|
-
if_match: "if_match_example" # String | If
|
|
1249
|
+
if_match: "if_match_example" # String | The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
|
|
1250
1250
|
}
|
|
1251
1251
|
|
|
1252
1252
|
begin
|
|
1253
|
-
#
|
|
1253
|
+
#Replace a group
|
|
1254
1254
|
result = api_instance.put_scim_group(group_id, body, opts)
|
|
1255
1255
|
p result
|
|
1256
1256
|
rescue PureCloud::ApiError => e
|
|
@@ -1262,9 +1262,9 @@ end
|
|
|
1262
1262
|
|
|
1263
1263
|
Name | Type | Description | Notes
|
|
1264
1264
|
------------- | ------------- | ------------- | -------------
|
|
1265
|
-
**group_id** | **String**|
|
|
1265
|
+
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/groups. | |
|
|
1266
1266
|
**body** | [**ScimV2Group**](ScimV2Group.html)| Group | |
|
|
1267
|
-
**if_match** | **String**| If
|
|
1267
|
+
**if_match** | **String**| The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request. | [optional] |
|
|
1268
1268
|
{: class="table table-striped"}
|
|
1269
1269
|
|
|
1270
1270
|
|
|
@@ -1285,7 +1285,7 @@ Name | Type | Description | Notes
|
|
|
1285
1285
|
|
|
1286
1286
|
|
|
1287
1287
|
|
|
1288
|
-
|
|
1288
|
+
Replace a user
|
|
1289
1289
|
|
|
1290
1290
|
|
|
1291
1291
|
|
|
@@ -1314,16 +1314,16 @@ end
|
|
|
1314
1314
|
|
|
1315
1315
|
api_instance = PureCloud::SCIMApi.new
|
|
1316
1316
|
|
|
1317
|
-
user_id = "user_id_example" # String |
|
|
1317
|
+
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/users.
|
|
1318
1318
|
|
|
1319
1319
|
body = PureCloud::ScimV2User.new # ScimV2User | User
|
|
1320
1320
|
|
|
1321
1321
|
opts = {
|
|
1322
|
-
if_match: "if_match_example" # String | If
|
|
1322
|
+
if_match: "if_match_example" # String | The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
|
|
1323
1323
|
}
|
|
1324
1324
|
|
|
1325
1325
|
begin
|
|
1326
|
-
#
|
|
1326
|
+
#Replace a user
|
|
1327
1327
|
result = api_instance.put_scim_user(user_id, body, opts)
|
|
1328
1328
|
p result
|
|
1329
1329
|
rescue PureCloud::ApiError => e
|
|
@@ -1335,9 +1335,9 @@ end
|
|
|
1335
1335
|
|
|
1336
1336
|
Name | Type | Description | Notes
|
|
1337
1337
|
------------- | ------------- | ------------- | -------------
|
|
1338
|
-
**user_id** | **String**|
|
|
1338
|
+
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/users. | |
|
|
1339
1339
|
**body** | [**ScimV2User**](ScimV2User.html)| User | |
|
|
1340
|
-
**if_match** | **String**| If
|
|
1340
|
+
**if_match** | **String**| The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request. | [optional] |
|
|
1341
1341
|
{: class="table table-striped"}
|
|
1342
1342
|
|
|
1343
1343
|
|
|
@@ -1358,7 +1358,7 @@ Name | Type | Description | Notes
|
|
|
1358
1358
|
|
|
1359
1359
|
|
|
1360
1360
|
|
|
1361
|
-
|
|
1361
|
+
Replace a group
|
|
1362
1362
|
|
|
1363
1363
|
|
|
1364
1364
|
|
|
@@ -1386,16 +1386,16 @@ end
|
|
|
1386
1386
|
|
|
1387
1387
|
api_instance = PureCloud::SCIMApi.new
|
|
1388
1388
|
|
|
1389
|
-
group_id = "group_id_example" # String |
|
|
1389
|
+
group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
1390
1390
|
|
|
1391
1391
|
body = PureCloud::ScimV2Group.new # ScimV2Group | Group
|
|
1392
1392
|
|
|
1393
1393
|
opts = {
|
|
1394
|
-
if_match: "if_match_example" # String | If
|
|
1394
|
+
if_match: "if_match_example" # String | The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
|
|
1395
1395
|
}
|
|
1396
1396
|
|
|
1397
1397
|
begin
|
|
1398
|
-
#
|
|
1398
|
+
#Replace a group
|
|
1399
1399
|
result = api_instance.put_scim_v2_group(group_id, body, opts)
|
|
1400
1400
|
p result
|
|
1401
1401
|
rescue PureCloud::ApiError => e
|
|
@@ -1407,9 +1407,9 @@ end
|
|
|
1407
1407
|
|
|
1408
1408
|
Name | Type | Description | Notes
|
|
1409
1409
|
------------- | ------------- | ------------- | -------------
|
|
1410
|
-
**group_id** | **String**|
|
|
1410
|
+
**group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. | |
|
|
1411
1411
|
**body** | [**ScimV2Group**](ScimV2Group.html)| Group | |
|
|
1412
|
-
**if_match** | **String**| If
|
|
1412
|
+
**if_match** | **String**| The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request. | [optional] |
|
|
1413
1413
|
{: class="table table-striped"}
|
|
1414
1414
|
|
|
1415
1415
|
|
|
@@ -1430,7 +1430,7 @@ Name | Type | Description | Notes
|
|
|
1430
1430
|
|
|
1431
1431
|
|
|
1432
1432
|
|
|
1433
|
-
|
|
1433
|
+
Replace a user
|
|
1434
1434
|
|
|
1435
1435
|
|
|
1436
1436
|
|
|
@@ -1459,16 +1459,16 @@ end
|
|
|
1459
1459
|
|
|
1460
1460
|
api_instance = PureCloud::SCIMApi.new
|
|
1461
1461
|
|
|
1462
|
-
user_id = "user_id_example" # String |
|
|
1462
|
+
user_id = "user_id_example" # String | The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
1463
1463
|
|
|
1464
1464
|
body = PureCloud::ScimV2User.new # ScimV2User | User
|
|
1465
1465
|
|
|
1466
1466
|
opts = {
|
|
1467
|
-
if_match: "if_match_example" # String | If
|
|
1467
|
+
if_match: "if_match_example" # String | The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request.
|
|
1468
1468
|
}
|
|
1469
1469
|
|
|
1470
1470
|
begin
|
|
1471
|
-
#
|
|
1471
|
+
#Replace a user
|
|
1472
1472
|
result = api_instance.put_scim_v2_user(user_id, body, opts)
|
|
1473
1473
|
p result
|
|
1474
1474
|
rescue PureCloud::ApiError => e
|
|
@@ -1480,9 +1480,9 @@ end
|
|
|
1480
1480
|
|
|
1481
1481
|
Name | Type | Description | Notes
|
|
1482
1482
|
------------- | ------------- | ------------- | -------------
|
|
1483
|
-
**user_id** | **String**|
|
|
1483
|
+
**user_id** | **String**| The ID of a user. Returned with GET /api/v2/scim/v2/users. | |
|
|
1484
1484
|
**body** | [**ScimV2User**](ScimV2User.html)| User | |
|
|
1485
|
-
**if_match** | **String**| If
|
|
1485
|
+
**if_match** | **String**| The ETag of a resource. If no match is found, returns 412 Precondition Failed. If match is found, performs request. | [optional] |
|
|
1486
1486
|
{: class="table table-striped"}
|
|
1487
1487
|
|
|
1488
1488
|
|