purecloudplatformclientv2 42.0.0 → 43.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ADFS.md +1 -1
- data/docs/ActionEntityListing.md +2 -2
- data/docs/AgentActivityEntityListing.md +2 -2
- data/docs/AnalyticsApi.md +66 -0
- data/docs/AnalyticsSurvey.md +1 -0
- data/docs/AttemptLimitsEntityListing.md +2 -2
- data/docs/AttributeEntityListing.md +2 -2
- data/docs/AuthorizationApi.md +1278 -185
- data/docs/AuthzDivision.md +18 -0
- data/docs/AuthzDivisionEntityListing.md +22 -0
- data/docs/AuthzGrant.md +16 -0
- data/docs/AuthzGrantPolicy.md +16 -0
- data/docs/AuthzGrantRole.md +18 -0
- data/docs/AuthzSubject.md +17 -0
- data/docs/CalibrationEntityListing.md +2 -2
- data/docs/CallConversationEntityListing.md +2 -2
- data/docs/CallHistoryConversationEntityListing.md +2 -2
- data/docs/CallableTimeSetEntityListing.md +2 -2
- data/docs/CallbackConversationEntityListing.md +2 -2
- data/docs/CampaignDivisionViewListing.md +2 -2
- data/docs/CampaignEntityListing.md +2 -2
- data/docs/CampaignRuleEntityListing.md +2 -2
- data/docs/CampaignSequenceEntityListing.md +2 -2
- data/docs/CertificateAuthorityEntityListing.md +2 -2
- data/docs/CertificateDetails.md +1 -1
- data/docs/ChatBadgeNotificationBadgeEntity.md +1 -3
- data/docs/ChatBadgeNotificationEntity.md +1 -3
- data/docs/ChatConversationEntityListing.md +2 -2
- data/docs/ClientAppEntityListing.md +2 -2
- data/docs/CobrowseConversationEntityListing.md +2 -2
- data/docs/CommandStatusEntityListing.md +2 -2
- data/docs/ConsumedResourcesEntityListing.md +2 -2
- data/docs/ConsumingResourcesEntityListing.md +2 -2
- data/docs/ContactListEntityListing.md +2 -2
- data/docs/ContactListFilterEntityListing.md +2 -2
- data/docs/ContactListing.md +2 -2
- data/docs/ConversationEntityListing.md +2 -2
- data/docs/ConversationQuery.md +1 -0
- data/docs/CreateCallbackCommand.md +1 -0
- data/docs/CreateCallbackOnConversationCommand.md +1 -0
- data/docs/CreateQueueRequest.md +1 -1
- data/docs/CredentialInfoListing.md +2 -2
- data/docs/CredentialTypeListing.md +2 -2
- data/docs/CustomerInteractionCenter.md +1 -1
- data/docs/DIDEntityListing.md +2 -2
- data/docs/DIDPoolEntityListing.md +2 -2
- data/docs/DataTableRowEntityListing.md +2 -2
- data/docs/DataTablesDomainEntityListing.md +2 -2
- data/docs/DependencyObjectEntityListing.md +2 -2
- data/docs/DependencyTypeEntityListing.md +2 -2
- data/docs/DialerEventEntityListing.md +2 -2
- data/docs/DirectoryUserDevicesListing.md +2 -2
- data/docs/DncListEntityListing.md +2 -2
- data/docs/Document.md +1 -1
- data/docs/DocumentAuditEntityListing.md +2 -2
- data/docs/DocumentEntityListing.md +2 -2
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +2 -2
- data/docs/DomainEntityListing.md +2 -2
- data/docs/DomainEntityListingEvaluationForm.md +2 -2
- data/docs/DomainEntityListingQueryResult.md +2 -2
- data/docs/DomainEntityListingSurveyForm.md +2 -2
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +2 -2
- data/docs/EdgeGroupEntityListing.md +2 -2
- data/docs/EdgeLineEntityListing.md +2 -2
- data/docs/EmailConversationEntityListing.md +2 -2
- data/docs/EmailMessageListing.md +2 -2
- data/docs/EmergencyGroupListing.md +2 -2
- data/docs/EncryptionKeyEntityListing.md +2 -2
- data/docs/EndpointEntityListing.md +2 -2
- data/docs/EvaluationEntityListing.md +2 -2
- data/docs/EvaluationFormEntityListing.md +2 -2
- data/docs/EvaluatorActivityEntityListing.md +2 -2
- data/docs/ExtensionEntityListing.md +2 -2
- data/docs/ExtensionPoolEntityListing.md +2 -2
- data/docs/ExternalOrganizationListing.md +2 -2
- data/docs/FacebookIntegration.md +24 -0
- data/docs/FacebookIntegrationEntityListing.md +22 -0
- data/docs/FacebookIntegrationRequest.md +20 -0
- data/docs/FaxDocument.md +1 -1
- data/docs/FaxDocumentEntityListing.md +2 -2
- data/docs/FlowDivisionViewEntityListing.md +2 -2
- data/docs/FlowEntityListing.md +2 -2
- data/docs/FlowVersionEntityListing.md +2 -2
- data/docs/FlowsApi.md +78 -0
- data/docs/GDPRRequestEntityListing.md +2 -2
- data/docs/GDPRSubjectEntityListing.md +2 -2
- data/docs/GKNDocumentationResult.md +16 -0
- data/docs/GKNDocumentationSearchCriteria.md +20 -0
- data/docs/GKNDocumentationSearchRequest.md +18 -0
- data/docs/GKNDocumentationSearchResponse.md +21 -0
- data/docs/GSuite.md +1 -1
- data/docs/GreetingListing.md +2 -2
- data/docs/GroupEntityListing.md +2 -2
- data/docs/GroupProfileEntityListing.md +2 -2
- data/docs/GroupsApi.md +1 -1
- data/docs/IVREntityListing.md +2 -2
- data/docs/IdentityNow.md +1 -1
- data/docs/InboundDomainEntityListing.md +2 -2
- data/docs/InboundRouteEntityListing.md +2 -2
- data/docs/IntegrationEntityListing.md +2 -2
- data/docs/IntegrationEventEntityListing.md +2 -2
- data/docs/IntegrationTypeEntityListing.md +2 -2
- data/docs/InteractionStatsAlertContainer.md +2 -2
- data/docs/InteractionStatsRuleContainer.md +2 -2
- data/docs/JsonNode.md +6 -6
- data/docs/KeywordSetEntityListing.md +2 -2
- data/docs/LanguageEntityListing.md +2 -2
- data/docs/LibraryEntityListing.md +2 -2
- data/docs/LineBaseEntityListing.md +2 -2
- data/docs/LineEntityListing.md +2 -2
- data/docs/LineIntegration.md +24 -0
- data/docs/LineIntegrationEntityListing.md +22 -0
- data/docs/LineIntegrationRequest.md +19 -0
- data/docs/LocationEntityListing.md +2 -2
- data/docs/LogicalInterfaceEntityListing.md +2 -2
- data/docs/ManagementUnitListing.md +2 -2
- data/docs/MessageConversationEntityListing.md +2 -2
- data/docs/MessagingApi.md +1015 -0
- data/docs/MessagingSticker.md +22 -0
- data/docs/MessagingStickerEntityListing.md +22 -0
- data/docs/NoteListing.md +2 -2
- data/docs/OAuthClientEntityListing.md +2 -2
- data/docs/OAuthProviderEntityListing.md +2 -2
- data/docs/ObjectsApi.md +554 -0
- data/docs/Okta.md +1 -1
- data/docs/OneLogin.md +1 -1
- data/docs/OrgUser.md +3 -1
- data/docs/OrganizationPresenceEntityListing.md +2 -2
- data/docs/OrganizationRoleEntityListing.md +2 -2
- data/docs/OrphanRecordingListing.md +2 -2
- data/docs/OutboundApi.md +2 -2
- data/docs/OutboundRouteBaseEntityListing.md +2 -2
- data/docs/OutboundRouteEntityListing.md +2 -2
- data/docs/PermissionCollectionEntityListing.md +2 -2
- data/docs/PhoneBaseEntityListing.md +2 -2
- data/docs/PhoneEntityListing.md +2 -2
- data/docs/PhoneMetaBaseEntityListing.md +2 -2
- data/docs/PhysicalInterfaceEntityListing.md +2 -2
- data/docs/PingIdentity.md +1 -1
- data/docs/PolicyEntityListing.md +2 -2
- data/docs/PresenceApi.md +66 -0
- data/docs/PromptAsset.md +1 -0
- data/docs/PromptAssetCreate.md +1 -0
- data/docs/PromptAssetEntityListing.md +2 -2
- data/docs/PromptEntityListing.md +2 -2
- data/docs/QualityAuditPage.md +2 -2
- data/docs/QueueEntityListing.md +2 -2
- data/docs/QueueMemberEntityListing.md +2 -2
- data/docs/QueueRequest.md +1 -1
- data/docs/RecipientListing.md +2 -2
- data/docs/RelationshipListing.md +2 -2
- data/docs/ReportMetaDataEntityListing.md +2 -2
- data/docs/ReportRunEntryEntityDomainListing.md +2 -2
- data/docs/ReportScheduleEntityListing.md +2 -2
- data/docs/ReportingExportJobListing.md +2 -2
- data/docs/ResponseConfig.md +1 -0
- data/docs/ResponseEntityList.md +2 -2
- data/docs/ResponseEntityListing.md +2 -2
- data/docs/ResponseSetEntityListing.md +2 -2
- data/docs/RoutingApi.md +144 -4
- data/docs/RuleSetEntityListing.md +2 -2
- data/docs/Salesforce.md +1 -1
- data/docs/ScheduleEntityListing.md +2 -2
- data/docs/ScheduleGroupEntityListing.md +2 -2
- data/docs/SchemaCategoryEntityListing.md +2 -2
- data/docs/SchemaReferenceEntityListing.md +2 -2
- data/docs/ScreenRecordingSessionListing.md +2 -2
- data/docs/ScriptEntityListing.md +2 -2
- data/docs/SearchApi.md +132 -2
- data/docs/SecurityProfileEntityListing.md +2 -2
- data/docs/ShareEntityListing.md +2 -2
- data/docs/SiteEntityListing.md +2 -2
- data/docs/SkillEntityListing.md +2 -2
- data/docs/SmsPhoneNumberEntityListing.md +2 -2
- data/docs/StationEntityListing.md +2 -2
- data/docs/SubjectDivisionGrantsEntityListing.md +2 -2
- data/docs/SubjectDivisions.md +14 -0
- data/docs/SuggestApi.md +2 -2
- data/docs/SurveyFormEntityListing.md +2 -2
- data/docs/SystemPromptAsset.md +1 -0
- data/docs/SystemPromptAssetEntityListing.md +2 -2
- data/docs/SystemPromptEntityListing.md +2 -2
- data/docs/TagValueEntityListing.md +2 -2
- data/docs/TextMessageListing.md +2 -2
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +2 -2
- data/docs/TrunkBaseEntityListing.md +2 -2
- data/docs/TrunkEntityListing.md +2 -2
- data/docs/TrunkMetabaseEntityListing.md +2 -2
- data/docs/TrustEntityListing.md +2 -2
- data/docs/TrustUser.md +3 -1
- data/docs/TrustUserEntityListing.md +2 -2
- data/docs/TrustorEntityListing.md +2 -2
- data/docs/TwitterIntegration.md +28 -0
- data/docs/TwitterIntegrationEntityListing.md +22 -0
- data/docs/TwitterIntegrationRequest.md +21 -0
- data/docs/UpdateUser.md +1 -1
- data/docs/UpdateWeekScheduleRequest.md +1 -0
- data/docs/User.md +3 -1
- data/docs/UserActionCategoryEntityListing.md +2 -2
- data/docs/UserEntityListing.md +2 -2
- data/docs/UserLanguageEntityListing.md +2 -2
- data/docs/UserMe.md +3 -1
- data/docs/UserProfileEntityListing.md +2 -2
- data/docs/UserQueueEntityListing.md +2 -2
- data/docs/UserRecordingEntityListing.md +2 -2
- data/docs/UserSkillEntityListing.md +2 -2
- data/docs/UsersApi.md +560 -8
- data/docs/VoicemailMessageEntityListing.md +2 -2
- data/docs/WorkforceManagementApi.md +67 -0
- data/docs/WorkspaceEntityListing.md +2 -2
- data/docs/WorkspaceMemberEntityListing.md +2 -2
- data/docs/WrapupCodeEntityListing.md +2 -2
- data/docs/WritableDialerContact.md +17 -0
- data/lib/purecloudplatformclientv2.rb +26 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +1477 -250
- data/lib/purecloudplatformclientv2/api/flows_api.rb +92 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +1050 -0
- data/lib/purecloudplatformclientv2/api/objects_api.rb +640 -0
- data/lib/purecloudplatformclientv2/api/presence_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +157 -3
- data/lib/purecloudplatformclientv2/api/search_api.rb +131 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +607 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +64 -0
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/adfs.rb +12 -12
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/analytics_session.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_survey.rb +30 -4
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/authz_division.rb +338 -0
- data/lib/purecloudplatformclientv2/models/authz_division_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/authz_grant.rb +277 -0
- data/lib/purecloudplatformclientv2/models/authz_grant_policy.rb +278 -0
- data/lib/purecloudplatformclientv2/models/authz_grant_role.rb +330 -0
- data/lib/purecloudplatformclientv2/models/authz_subject.rb +305 -0
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
- data/lib/purecloudplatformclientv2/models/chat_badge_notification_badge_entity.rb +7 -71
- data/lib/purecloudplatformclientv2/models/chat_badge_notification_entity.rb +7 -71
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/conversation_query.rb +29 -1
- data/lib/purecloudplatformclientv2/models/create_callback_command.rb +27 -1
- data/lib/purecloudplatformclientv2/models/create_callback_on_conversation_command.rb +27 -1
- data/lib/purecloudplatformclientv2/models/create_queue_request.rb +6 -0
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/customer_interaction_center.rb +12 -12
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +23 -23
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/edge_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/facebook_integration.rb +508 -0
- data/lib/purecloudplatformclientv2/models/facebook_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +394 -0
- data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +2 -2
- data/lib/purecloudplatformclientv2/models/g_suite.rb +12 -12
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/gkn_documentation_result.rb +285 -0
- data/lib/purecloudplatformclientv2/models/gkn_documentation_search_criteria.rb +423 -0
- data/lib/purecloudplatformclientv2/models/gkn_documentation_search_request.rb +349 -0
- data/lib/purecloudplatformclientv2/models/gkn_documentation_search_response.rb +444 -0
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/identity_now.rb +12 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +23 -23
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +23 -23
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/json_node.rb +89 -89
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/line_integration.rb +513 -0
- data/lib/purecloudplatformclientv2/models/line_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/line_integration_request.rb +363 -0
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/messaging_sticker.rb +477 -0
- data/lib/purecloudplatformclientv2/models/messaging_sticker_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/note_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/okta.rb +12 -12
- data/lib/purecloudplatformclientv2/models/one_login.rb +12 -12
- data/lib/purecloudplatformclientv2/models/org_user.rb +58 -2
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/ping_identity.rb +12 -12
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/prompt_asset.rb +26 -1
- data/lib/purecloudplatformclientv2/models/prompt_asset_create.rb +26 -1
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +23 -23
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/queue_request.rb +6 -0
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/response_config.rb +29 -1
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +23 -23
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/salesforce.rb +12 -12
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/subject_divisions.rb +242 -0
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/system_prompt_asset.rb +26 -1
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trust_user.rb +58 -2
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/twitter_integration.rb +636 -0
- data/lib/purecloudplatformclientv2/models/twitter_integration_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/twitter_integration_request.rb +454 -0
- data/lib/purecloudplatformclientv2/models/update_user.rb +1 -1
- data/lib/purecloudplatformclientv2/models/update_week_schedule_request.rb +44 -4
- data/lib/purecloudplatformclientv2/models/user.rb +58 -2
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_me.rb +58 -2
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/web_chat_config.rb +15 -1
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +23 -23
- data/lib/purecloudplatformclientv2/models/writable_dialer_contact.rb +320 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +54 -2
data/docs/UserEntityListing.md
CHANGED
@@ -12,10 +12,10 @@ title: UserEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: UserLanguageEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/UserMe.md
CHANGED
@@ -28,9 +28,11 @@ title: UserMe
|
|
28
28
|
| **geolocation** | [**Geolocation**](Geolocation.html) | Current geolocation position | [optional] |
|
29
29
|
| **station** | [**UserStations**](UserStations.html) | Effective, default, and last station information | [optional] |
|
30
30
|
| **authorization** | [**UserAuthorization**](UserAuthorization.html) | Roles and permissions assigned to the user | [optional] |
|
31
|
-
| **profile_skills** | **Array<String>** |
|
31
|
+
| **profile_skills** | **Array<String>** | Profile skills possessed by the user | [optional] |
|
32
32
|
| **locations** | [**Array<Location>**](Location.html) | The user placement at each site location. | [optional] |
|
33
33
|
| **groups** | [**Array<Group>**](Group.html) | The groups the user is a member of | [optional] |
|
34
|
+
| **skills** | [**Array<UserRoutingSkill>**](UserRoutingSkill.html) | Routing (ACD) skills possessed by the user | [optional] |
|
35
|
+
| **languages** | [**Array<UserRoutingLanguage>**](UserRoutingLanguage.html) | Routing (ACD) languages possessed by the user | [optional] |
|
34
36
|
| **acd_auto_answer** | **BOOLEAN** | acd auto answer | [optional] |
|
35
37
|
| **date** | [**ServerDate**](ServerDate.html) | The PureCloud system date time. | [optional] |
|
36
38
|
| **geolocation_settings** | [**GeolocationSettings**](GeolocationSettings.html) | Geolocation settings for user's organization. | [optional] |
|
@@ -12,10 +12,10 @@ title: UserProfileEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: UserQueueEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: UserRecordingEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -12,10 +12,10 @@ title: UserSkillEntityListing
|
|
12
12
|
| **page_number** | **Integer** | | [optional] |
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
|
-
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
15
|
| **previous_uri** | **String** | | [optional] |
|
18
16
|
| **next_uri** | **String** | | [optional] |
|
17
|
+
| **last_uri** | **String** | | [optional] |
|
18
|
+
| **first_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/UsersApi.md
CHANGED
@@ -8,12 +8,17 @@ All URIs are relative to *https://api.mypurecloud.com*
|
|
8
8
|
|
9
9
|
Method | Description
|
10
10
|
------------- | ------------- | -------------
|
11
|
+
[**delete_authorization_subject_division_role**](UsersApi.html#delete_authorization_subject_division_role) | Delete a grant of a role in a division
|
11
12
|
[**delete_user**](UsersApi.html#delete_user) | Delete user
|
12
13
|
[**delete_user_roles**](UsersApi.html#delete_user_roles) | Removes all the roles from the user.
|
13
14
|
[**delete_user_routinglanguage**](UsersApi.html#delete_user_routinglanguage) | Remove routing language from user
|
14
15
|
[**delete_user_routingskill**](UsersApi.html#delete_user_routingskill) | Remove routing skill from user
|
15
16
|
[**delete_user_station_associatedstation**](UsersApi.html#delete_user_station_associatedstation) | Clear associated station
|
16
17
|
[**delete_user_station_defaultstation**](UsersApi.html#delete_user_station_defaultstation) | Clear default station
|
18
|
+
[**get_authorization_divisionspermitted_me**](UsersApi.html#get_authorization_divisionspermitted_me) | Returns whether or not current user can perform the specified action(s).
|
19
|
+
[**get_authorization_divisionspermitted_subject_id**](UsersApi.html#get_authorization_divisionspermitted_subject_id) | Returns whether or not specified user can perform the specified action(s).
|
20
|
+
[**get_authorization_subject**](UsersApi.html#get_authorization_subject) | Returns a listing of roles and permissions for a user.
|
21
|
+
[**get_authorization_subjects_me**](UsersApi.html#get_authorization_subjects_me) | Returns a listing of roles and permissions for the currently authenticated user.
|
17
22
|
[**get_fieldconfig**](UsersApi.html#get_fieldconfig) | Fetch field config for an entity type
|
18
23
|
[**get_profiles_users**](UsersApi.html#get_profiles_users) | Get a user profile listing
|
19
24
|
[**get_user**](UsersApi.html#get_user) | Get user.
|
@@ -42,10 +47,13 @@ Method | Description
|
|
42
47
|
[**patch_user_queue**](UsersApi.html#patch_user_queue) | Join or unjoin a queue for a user
|
43
48
|
[**patch_user_queues**](UsersApi.html#patch_user_queues) | Join or unjoin a set of queues for a user
|
44
49
|
[**patch_user_routinglanguage**](UsersApi.html#patch_user_routinglanguage) | Update routing language proficiency or state.
|
50
|
+
[**patch_user_routinglanguages_bulk**](UsersApi.html#patch_user_routinglanguages_bulk) | Add bulk routing language to user. Max limit 50 languages
|
51
|
+
[**patch_user_routingskills_bulk**](UsersApi.html#patch_user_routingskills_bulk) | Add bulk routing skills to user
|
45
52
|
[**patch_users_bulk**](UsersApi.html#patch_users_bulk) | Update bulk acd autoanswer on users
|
46
53
|
[**post_analytics_users_aggregates_query**](UsersApi.html#post_analytics_users_aggregates_query) | Query for user aggregates
|
47
54
|
[**post_analytics_users_details_query**](UsersApi.html#post_analytics_users_details_query) | Query for user details
|
48
55
|
[**post_analytics_users_observations_query**](UsersApi.html#post_analytics_users_observations_query) | Query for user observations
|
56
|
+
[**post_authorization_subject_division_role**](UsersApi.html#post_authorization_subject_division_role) | Make a grant of a role in a division
|
49
57
|
[**post_user_invite**](UsersApi.html#post_user_invite) | Send an activation email to the user
|
50
58
|
[**post_user_password**](UsersApi.html#post_user_password) | Change a users password
|
51
59
|
[**post_user_routinglanguages**](UsersApi.html#post_user_routinglanguages) | Add routing language to user
|
@@ -63,6 +71,76 @@ Method | Description
|
|
63
71
|
[**put_user_station_defaultstation_station_id**](UsersApi.html#put_user_station_defaultstation_station_id) | Set default station
|
64
72
|
{: class="table table-striped"}
|
65
73
|
|
74
|
+
<a name="delete_authorization_subject_division_role"></a>
|
75
|
+
|
76
|
+
## - delete_authorization_subject_division_role(subject_id, division_id, role_id)
|
77
|
+
|
78
|
+
|
79
|
+
|
80
|
+
Delete a grant of a role in a division
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
Wraps DELETE /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}
|
85
|
+
|
86
|
+
Requires ANY permissions:
|
87
|
+
|
88
|
+
* authorization:grant:delete
|
89
|
+
|
90
|
+
|
91
|
+
### Example
|
92
|
+
~~~ruby
|
93
|
+
# load the gem
|
94
|
+
require 'purecloudplatformclientv2'
|
95
|
+
# setup authorization
|
96
|
+
@secret = ENV['PURECLOUD_SECRET']
|
97
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
98
|
+
environment = "mypurecloud.com"
|
99
|
+
|
100
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
101
|
+
|
102
|
+
PureCloud.configure do |config|
|
103
|
+
config.access_token = @authToken
|
104
|
+
end
|
105
|
+
|
106
|
+
api_instance = PureCloud::UsersApi.new
|
107
|
+
|
108
|
+
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
109
|
+
|
110
|
+
division_id = "division_id_example" # String | the id of the division of the grant
|
111
|
+
|
112
|
+
role_id = "role_id_example" # String | the id of the role of the grant
|
113
|
+
|
114
|
+
|
115
|
+
begin
|
116
|
+
#Delete a grant of a role in a division
|
117
|
+
api_instance.delete_authorization_subject_division_role(subject_id, division_id, role_id)
|
118
|
+
rescue PureCloud::ApiError => e
|
119
|
+
puts "Exception when calling UsersApi->delete_authorization_subject_division_role: #{e}"
|
120
|
+
end
|
121
|
+
~~~
|
122
|
+
|
123
|
+
### Parameters
|
124
|
+
|
125
|
+
Name | Type | Description | Notes
|
126
|
+
------------- | ------------- | ------------- | -------------
|
127
|
+
**subject_id** | **String**| Subject ID (user or group) | |
|
128
|
+
**division_id** | **String**| the id of the division of the grant | |
|
129
|
+
**role_id** | **String**| the id of the role of the grant | |
|
130
|
+
{: class="table table-striped"}
|
131
|
+
|
132
|
+
|
133
|
+
### Return type
|
134
|
+
|
135
|
+
nil (empty response body)
|
136
|
+
|
137
|
+
### HTTP request headers
|
138
|
+
|
139
|
+
- **Content-Type**: application/json
|
140
|
+
- **Accept**: application/json
|
141
|
+
|
142
|
+
|
143
|
+
|
66
144
|
<a name="delete_user"></a>
|
67
145
|
|
68
146
|
## -[**Empty**](Empty.html) delete_user(user_id)
|
@@ -460,6 +538,268 @@ nil (empty response body)
|
|
460
538
|
|
461
539
|
|
462
540
|
|
541
|
+
<a name="get_authorization_divisionspermitted_me"></a>
|
542
|
+
|
543
|
+
## -[**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
|
544
|
+
|
545
|
+
|
546
|
+
|
547
|
+
Returns whether or not current user can perform the specified action(s).
|
548
|
+
|
549
|
+
|
550
|
+
|
551
|
+
Wraps GET /api/v2/authorization/divisionspermitted/me
|
552
|
+
|
553
|
+
Requires NO permissions:
|
554
|
+
|
555
|
+
|
556
|
+
|
557
|
+
### Example
|
558
|
+
~~~ruby
|
559
|
+
# load the gem
|
560
|
+
require 'purecloudplatformclientv2'
|
561
|
+
# setup authorization
|
562
|
+
@secret = ENV['PURECLOUD_SECRET']
|
563
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
564
|
+
environment = "mypurecloud.com"
|
565
|
+
|
566
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
567
|
+
|
568
|
+
PureCloud.configure do |config|
|
569
|
+
config.access_token = @authToken
|
570
|
+
end
|
571
|
+
|
572
|
+
api_instance = PureCloud::UsersApi.new
|
573
|
+
|
574
|
+
permission = "permission_example" # String | The permission string, including the object to access, e.g. routing:queue:view
|
575
|
+
|
576
|
+
opts = {
|
577
|
+
name: "name_example" # String | Search term to filter by division name
|
578
|
+
}
|
579
|
+
|
580
|
+
begin
|
581
|
+
#Returns whether or not current user can perform the specified action(s).
|
582
|
+
result = api_instance.get_authorization_divisionspermitted_me(permission, opts)
|
583
|
+
p result
|
584
|
+
rescue PureCloud::ApiError => e
|
585
|
+
puts "Exception when calling UsersApi->get_authorization_divisionspermitted_me: #{e}"
|
586
|
+
end
|
587
|
+
~~~
|
588
|
+
|
589
|
+
### Parameters
|
590
|
+
|
591
|
+
Name | Type | Description | Notes
|
592
|
+
------------- | ------------- | ------------- | -------------
|
593
|
+
**permission** | **String**| The permission string, including the object to access, e.g. routing:queue:view | |
|
594
|
+
**name** | **String**| Search term to filter by division name | [optional] |
|
595
|
+
{: class="table table-striped"}
|
596
|
+
|
597
|
+
|
598
|
+
### Return type
|
599
|
+
|
600
|
+
[**Array<AuthzDivision>**](AuthzDivision.html)
|
601
|
+
|
602
|
+
### HTTP request headers
|
603
|
+
|
604
|
+
- **Content-Type**: application/json
|
605
|
+
- **Accept**: application/json
|
606
|
+
|
607
|
+
|
608
|
+
|
609
|
+
<a name="get_authorization_divisionspermitted_subject_id"></a>
|
610
|
+
|
611
|
+
## -[**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
|
612
|
+
|
613
|
+
|
614
|
+
|
615
|
+
Returns whether or not specified user can perform the specified action(s).
|
616
|
+
|
617
|
+
|
618
|
+
|
619
|
+
Wraps GET /api/v2/authorization/divisionspermitted/{subjectId}
|
620
|
+
|
621
|
+
Requires NO permissions:
|
622
|
+
|
623
|
+
|
624
|
+
|
625
|
+
### Example
|
626
|
+
~~~ruby
|
627
|
+
# load the gem
|
628
|
+
require 'purecloudplatformclientv2'
|
629
|
+
# setup authorization
|
630
|
+
@secret = ENV['PURECLOUD_SECRET']
|
631
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
632
|
+
environment = "mypurecloud.com"
|
633
|
+
|
634
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
635
|
+
|
636
|
+
PureCloud.configure do |config|
|
637
|
+
config.access_token = @authToken
|
638
|
+
end
|
639
|
+
|
640
|
+
api_instance = PureCloud::UsersApi.new
|
641
|
+
|
642
|
+
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
643
|
+
|
644
|
+
permission = "permission_example" # String | The permission string, including the object to access, e.g. routing:queue:view
|
645
|
+
|
646
|
+
opts = {
|
647
|
+
name: "name_example" # String | Search term to filter by division name
|
648
|
+
}
|
649
|
+
|
650
|
+
begin
|
651
|
+
#Returns whether or not specified user can perform the specified action(s).
|
652
|
+
result = api_instance.get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
|
653
|
+
p result
|
654
|
+
rescue PureCloud::ApiError => e
|
655
|
+
puts "Exception when calling UsersApi->get_authorization_divisionspermitted_subject_id: #{e}"
|
656
|
+
end
|
657
|
+
~~~
|
658
|
+
|
659
|
+
### Parameters
|
660
|
+
|
661
|
+
Name | Type | Description | Notes
|
662
|
+
------------- | ------------- | ------------- | -------------
|
663
|
+
**subject_id** | **String**| Subject ID (user or group) | |
|
664
|
+
**permission** | **String**| The permission string, including the object to access, e.g. routing:queue:view | |
|
665
|
+
**name** | **String**| Search term to filter by division name | [optional] |
|
666
|
+
{: class="table table-striped"}
|
667
|
+
|
668
|
+
|
669
|
+
### Return type
|
670
|
+
|
671
|
+
[**Array<AuthzDivision>**](AuthzDivision.html)
|
672
|
+
|
673
|
+
### HTTP request headers
|
674
|
+
|
675
|
+
- **Content-Type**: application/json
|
676
|
+
- **Accept**: application/json
|
677
|
+
|
678
|
+
|
679
|
+
|
680
|
+
<a name="get_authorization_subject"></a>
|
681
|
+
|
682
|
+
## -[**AuthzSubject**](AuthzSubject.html) get_authorization_subject(subject_id)
|
683
|
+
|
684
|
+
|
685
|
+
|
686
|
+
Returns a listing of roles and permissions for a user.
|
687
|
+
|
688
|
+
|
689
|
+
|
690
|
+
Wraps GET /api/v2/authorization/subjects/{subjectId}
|
691
|
+
|
692
|
+
Requires ANY permissions:
|
693
|
+
|
694
|
+
* authorization:grant:view
|
695
|
+
|
696
|
+
|
697
|
+
### Example
|
698
|
+
~~~ruby
|
699
|
+
# load the gem
|
700
|
+
require 'purecloudplatformclientv2'
|
701
|
+
# setup authorization
|
702
|
+
@secret = ENV['PURECLOUD_SECRET']
|
703
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
704
|
+
environment = "mypurecloud.com"
|
705
|
+
|
706
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
707
|
+
|
708
|
+
PureCloud.configure do |config|
|
709
|
+
config.access_token = @authToken
|
710
|
+
end
|
711
|
+
|
712
|
+
api_instance = PureCloud::UsersApi.new
|
713
|
+
|
714
|
+
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
715
|
+
|
716
|
+
|
717
|
+
begin
|
718
|
+
#Returns a listing of roles and permissions for a user.
|
719
|
+
result = api_instance.get_authorization_subject(subject_id)
|
720
|
+
p result
|
721
|
+
rescue PureCloud::ApiError => e
|
722
|
+
puts "Exception when calling UsersApi->get_authorization_subject: #{e}"
|
723
|
+
end
|
724
|
+
~~~
|
725
|
+
|
726
|
+
### Parameters
|
727
|
+
|
728
|
+
Name | Type | Description | Notes
|
729
|
+
------------- | ------------- | ------------- | -------------
|
730
|
+
**subject_id** | **String**| Subject ID (user or group) | |
|
731
|
+
{: class="table table-striped"}
|
732
|
+
|
733
|
+
|
734
|
+
### Return type
|
735
|
+
|
736
|
+
[**AuthzSubject**](AuthzSubject.html)
|
737
|
+
|
738
|
+
### HTTP request headers
|
739
|
+
|
740
|
+
- **Content-Type**: application/json
|
741
|
+
- **Accept**: application/json
|
742
|
+
|
743
|
+
|
744
|
+
|
745
|
+
<a name="get_authorization_subjects_me"></a>
|
746
|
+
|
747
|
+
## -[**AuthzSubject**](AuthzSubject.html) get_authorization_subjects_me
|
748
|
+
|
749
|
+
|
750
|
+
|
751
|
+
Returns a listing of roles and permissions for the currently authenticated user.
|
752
|
+
|
753
|
+
|
754
|
+
|
755
|
+
Wraps GET /api/v2/authorization/subjects/me
|
756
|
+
|
757
|
+
Requires NO permissions:
|
758
|
+
|
759
|
+
|
760
|
+
|
761
|
+
### Example
|
762
|
+
~~~ruby
|
763
|
+
# load the gem
|
764
|
+
require 'purecloudplatformclientv2'
|
765
|
+
# setup authorization
|
766
|
+
@secret = ENV['PURECLOUD_SECRET']
|
767
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
768
|
+
environment = "mypurecloud.com"
|
769
|
+
|
770
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
771
|
+
|
772
|
+
PureCloud.configure do |config|
|
773
|
+
config.access_token = @authToken
|
774
|
+
end
|
775
|
+
|
776
|
+
api_instance = PureCloud::UsersApi.new
|
777
|
+
|
778
|
+
begin
|
779
|
+
#Returns a listing of roles and permissions for the currently authenticated user.
|
780
|
+
result = api_instance.get_authorization_subjects_me
|
781
|
+
p result
|
782
|
+
rescue PureCloud::ApiError => e
|
783
|
+
puts "Exception when calling UsersApi->get_authorization_subjects_me: #{e}"
|
784
|
+
end
|
785
|
+
~~~
|
786
|
+
|
787
|
+
### Parameters
|
788
|
+
This endpoint does not need any parameter.
|
789
|
+
{: class="table table-striped"}
|
790
|
+
|
791
|
+
|
792
|
+
### Return type
|
793
|
+
|
794
|
+
[**AuthzSubject**](AuthzSubject.html)
|
795
|
+
|
796
|
+
### HTTP request headers
|
797
|
+
|
798
|
+
- **Content-Type**: application/json
|
799
|
+
- **Accept**: application/json
|
800
|
+
|
801
|
+
|
802
|
+
|
463
803
|
<a name="get_fieldconfig"></a>
|
464
804
|
|
465
805
|
## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
|
@@ -655,7 +995,7 @@ end
|
|
655
995
|
Name | Type | Description | Notes
|
656
996
|
------------- | ------------- | ------------- | -------------
|
657
997
|
**user_id** | **String**| User ID | |
|
658
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups |
|
998
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
|
659
999
|
**state** | **String**| Search for a user with this state | [optional] [default to active]<br />**Values**: active, deleted |
|
660
1000
|
{: class="table table-striped"}
|
661
1001
|
|
@@ -724,7 +1064,7 @@ end
|
|
724
1064
|
Name | Type | Description | Notes
|
725
1065
|
------------- | ------------- | ------------- | -------------
|
726
1066
|
**user_id** | **String**| User ID | |
|
727
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups |
|
1067
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
|
728
1068
|
{: class="table table-striped"}
|
729
1069
|
|
730
1070
|
|
@@ -856,7 +1196,7 @@ end
|
|
856
1196
|
Name | Type | Description | Notes
|
857
1197
|
------------- | ------------- | ------------- | -------------
|
858
1198
|
**user_id** | **String**| User ID | |
|
859
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups |
|
1199
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
|
860
1200
|
{: class="table table-striped"}
|
861
1201
|
|
862
1202
|
|
@@ -930,7 +1270,7 @@ Name | Type | Description | Notes
|
|
930
1270
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
931
1271
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
932
1272
|
**sort_order** | **String**| Sort order | [optional] [default to ASC] |
|
933
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups |
|
1273
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
|
934
1274
|
{: class="table table-striped"}
|
935
1275
|
|
936
1276
|
|
@@ -1129,7 +1469,7 @@ end
|
|
1129
1469
|
Name | Type | Description | Notes
|
1130
1470
|
------------- | ------------- | ------------- | -------------
|
1131
1471
|
**user_id** | **String**| userId | |
|
1132
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups |
|
1472
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
|
1133
1473
|
{: class="table table-striped"}
|
1134
1474
|
|
1135
1475
|
|
@@ -1674,7 +2014,7 @@ end
|
|
1674
2014
|
Name | Type | Description | Notes
|
1675
2015
|
------------- | ------------- | ------------- | -------------
|
1676
2016
|
**user_id** | **String**| User ID | |
|
1677
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups |
|
2017
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
|
1678
2018
|
{: class="table table-striped"}
|
1679
2019
|
|
1680
2020
|
|
@@ -1819,7 +2159,7 @@ Name | Type | Description | Notes
|
|
1819
2159
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1820
2160
|
**id** | [**Array<String>**](String.html)| id | [optional] |
|
1821
2161
|
**sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
|
1822
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups |
|
2162
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages |
|
1823
2163
|
**state** | **String**| Only list users of this state | [optional] [default to active]<br />**Values**: active, inactive, deleted |
|
1824
2164
|
{: class="table table-striped"}
|
1825
2165
|
|
@@ -1885,7 +2225,7 @@ end
|
|
1885
2225
|
|
1886
2226
|
Name | Type | Description | Notes
|
1887
2227
|
------------- | ------------- | ------------- | -------------
|
1888
|
-
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, date, geolocationsettings, organization, presencedefinitions, locationdefinitions, orgauthorization, orgproducts, favorites, superiors, directreports, adjacents, routingskills, routinglanguages, fieldconfigs, token, trustors |
|
2228
|
+
**expand** | [**Array<String>**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, date, geolocationsettings, organization, presencedefinitions, locationdefinitions, orgauthorization, orgproducts, favorites, superiors, directreports, adjacents, routingskills, routinglanguages, fieldconfigs, token, trustors |
|
1889
2229
|
{: class="table table-striped"}
|
1890
2230
|
|
1891
2231
|
|
@@ -2390,6 +2730,144 @@ Name | Type | Description | Notes
|
|
2390
2730
|
|
2391
2731
|
|
2392
2732
|
|
2733
|
+
<a name="patch_user_routinglanguages_bulk"></a>
|
2734
|
+
|
2735
|
+
## -[**UserLanguageEntityListing**](UserLanguageEntityListing.html) patch_user_routinglanguages_bulk(user_id, body)
|
2736
|
+
|
2737
|
+
|
2738
|
+
|
2739
|
+
Add bulk routing language to user. Max limit 50 languages
|
2740
|
+
|
2741
|
+
|
2742
|
+
|
2743
|
+
Wraps PATCH /api/v2/users/{userId}/routinglanguages/bulk
|
2744
|
+
|
2745
|
+
Requires ANY permissions:
|
2746
|
+
|
2747
|
+
* routing:skill:assign
|
2748
|
+
* admin
|
2749
|
+
|
2750
|
+
|
2751
|
+
### Example
|
2752
|
+
~~~ruby
|
2753
|
+
# load the gem
|
2754
|
+
require 'purecloudplatformclientv2'
|
2755
|
+
# setup authorization
|
2756
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2757
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2758
|
+
environment = "mypurecloud.com"
|
2759
|
+
|
2760
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2761
|
+
|
2762
|
+
PureCloud.configure do |config|
|
2763
|
+
config.access_token = @authToken
|
2764
|
+
end
|
2765
|
+
|
2766
|
+
api_instance = PureCloud::UsersApi.new
|
2767
|
+
|
2768
|
+
user_id = "user_id_example" # String | User ID
|
2769
|
+
|
2770
|
+
body = [PureCloud::UserRoutingLanguagePost.new] # Array<UserRoutingLanguagePost> | Language
|
2771
|
+
|
2772
|
+
|
2773
|
+
begin
|
2774
|
+
#Add bulk routing language to user. Max limit 50 languages
|
2775
|
+
result = api_instance.patch_user_routinglanguages_bulk(user_id, body)
|
2776
|
+
p result
|
2777
|
+
rescue PureCloud::ApiError => e
|
2778
|
+
puts "Exception when calling UsersApi->patch_user_routinglanguages_bulk: #{e}"
|
2779
|
+
end
|
2780
|
+
~~~
|
2781
|
+
|
2782
|
+
### Parameters
|
2783
|
+
|
2784
|
+
Name | Type | Description | Notes
|
2785
|
+
------------- | ------------- | ------------- | -------------
|
2786
|
+
**user_id** | **String**| User ID | |
|
2787
|
+
**body** | [**Array<UserRoutingLanguagePost>**](UserRoutingLanguagePost.html)| Language | |
|
2788
|
+
{: class="table table-striped"}
|
2789
|
+
|
2790
|
+
|
2791
|
+
### Return type
|
2792
|
+
|
2793
|
+
[**UserLanguageEntityListing**](UserLanguageEntityListing.html)
|
2794
|
+
|
2795
|
+
### HTTP request headers
|
2796
|
+
|
2797
|
+
- **Content-Type**: application/json
|
2798
|
+
- **Accept**: application/json
|
2799
|
+
|
2800
|
+
|
2801
|
+
|
2802
|
+
<a name="patch_user_routingskills_bulk"></a>
|
2803
|
+
|
2804
|
+
## -[**UserSkillEntityListing**](UserSkillEntityListing.html) patch_user_routingskills_bulk(user_id, body)
|
2805
|
+
|
2806
|
+
|
2807
|
+
|
2808
|
+
Add bulk routing skills to user
|
2809
|
+
|
2810
|
+
|
2811
|
+
|
2812
|
+
Wraps PATCH /api/v2/users/{userId}/routingskills/bulk
|
2813
|
+
|
2814
|
+
Requires ANY permissions:
|
2815
|
+
|
2816
|
+
* routing:skill:assign
|
2817
|
+
* admin
|
2818
|
+
|
2819
|
+
|
2820
|
+
### Example
|
2821
|
+
~~~ruby
|
2822
|
+
# load the gem
|
2823
|
+
require 'purecloudplatformclientv2'
|
2824
|
+
# setup authorization
|
2825
|
+
@secret = ENV['PURECLOUD_SECRET']
|
2826
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
2827
|
+
environment = "mypurecloud.com"
|
2828
|
+
|
2829
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
2830
|
+
|
2831
|
+
PureCloud.configure do |config|
|
2832
|
+
config.access_token = @authToken
|
2833
|
+
end
|
2834
|
+
|
2835
|
+
api_instance = PureCloud::UsersApi.new
|
2836
|
+
|
2837
|
+
user_id = "user_id_example" # String | User ID
|
2838
|
+
|
2839
|
+
body = [PureCloud::UserRoutingSkillPost.new] # Array<UserRoutingSkillPost> | Skill
|
2840
|
+
|
2841
|
+
|
2842
|
+
begin
|
2843
|
+
#Add bulk routing skills to user
|
2844
|
+
result = api_instance.patch_user_routingskills_bulk(user_id, body)
|
2845
|
+
p result
|
2846
|
+
rescue PureCloud::ApiError => e
|
2847
|
+
puts "Exception when calling UsersApi->patch_user_routingskills_bulk: #{e}"
|
2848
|
+
end
|
2849
|
+
~~~
|
2850
|
+
|
2851
|
+
### Parameters
|
2852
|
+
|
2853
|
+
Name | Type | Description | Notes
|
2854
|
+
------------- | ------------- | ------------- | -------------
|
2855
|
+
**user_id** | **String**| User ID | |
|
2856
|
+
**body** | [**Array<UserRoutingSkillPost>**](UserRoutingSkillPost.html)| Skill | |
|
2857
|
+
{: class="table table-striped"}
|
2858
|
+
|
2859
|
+
|
2860
|
+
### Return type
|
2861
|
+
|
2862
|
+
[**UserSkillEntityListing**](UserSkillEntityListing.html)
|
2863
|
+
|
2864
|
+
### HTTP request headers
|
2865
|
+
|
2866
|
+
- **Content-Type**: application/json
|
2867
|
+
- **Accept**: application/json
|
2868
|
+
|
2869
|
+
|
2870
|
+
|
2393
2871
|
<a name="patch_users_bulk"></a>
|
2394
2872
|
|
2395
2873
|
## -[**UserEntityListing**](UserEntityListing.html) patch_users_bulk(body)
|
@@ -2653,6 +3131,80 @@ Name | Type | Description | Notes
|
|
2653
3131
|
|
2654
3132
|
|
2655
3133
|
|
3134
|
+
<a name="post_authorization_subject_division_role"></a>
|
3135
|
+
|
3136
|
+
## - post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
|
3137
|
+
|
3138
|
+
|
3139
|
+
|
3140
|
+
Make a grant of a role in a division
|
3141
|
+
|
3142
|
+
|
3143
|
+
|
3144
|
+
Wraps POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}
|
3145
|
+
|
3146
|
+
Requires ANY permissions:
|
3147
|
+
|
3148
|
+
* authorization:grant:add
|
3149
|
+
|
3150
|
+
|
3151
|
+
### Example
|
3152
|
+
~~~ruby
|
3153
|
+
# load the gem
|
3154
|
+
require 'purecloudplatformclientv2'
|
3155
|
+
# setup authorization
|
3156
|
+
@secret = ENV['PURECLOUD_SECRET']
|
3157
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
3158
|
+
environment = "mypurecloud.com"
|
3159
|
+
|
3160
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
3161
|
+
|
3162
|
+
PureCloud.configure do |config|
|
3163
|
+
config.access_token = @authToken
|
3164
|
+
end
|
3165
|
+
|
3166
|
+
api_instance = PureCloud::UsersApi.new
|
3167
|
+
|
3168
|
+
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
3169
|
+
|
3170
|
+
division_id = "division_id_example" # String | the id of the division to which to make the grant
|
3171
|
+
|
3172
|
+
role_id = "role_id_example" # String | the id of the role to grant
|
3173
|
+
|
3174
|
+
opts = {
|
3175
|
+
subject_type: "PC_USER" # String | what the type of the subject is, PC_GROUP or PC_USER
|
3176
|
+
}
|
3177
|
+
|
3178
|
+
begin
|
3179
|
+
#Make a grant of a role in a division
|
3180
|
+
api_instance.post_authorization_subject_division_role(subject_id, division_id, role_id, opts)
|
3181
|
+
rescue PureCloud::ApiError => e
|
3182
|
+
puts "Exception when calling UsersApi->post_authorization_subject_division_role: #{e}"
|
3183
|
+
end
|
3184
|
+
~~~
|
3185
|
+
|
3186
|
+
### Parameters
|
3187
|
+
|
3188
|
+
Name | Type | Description | Notes
|
3189
|
+
------------- | ------------- | ------------- | -------------
|
3190
|
+
**subject_id** | **String**| Subject ID (user or group) | |
|
3191
|
+
**division_id** | **String**| the id of the division to which to make the grant | |
|
3192
|
+
**role_id** | **String**| the id of the role to grant | |
|
3193
|
+
**subject_type** | **String**| what the type of the subject is, PC_GROUP or PC_USER | [optional] [default to PC_USER] |
|
3194
|
+
{: class="table table-striped"}
|
3195
|
+
|
3196
|
+
|
3197
|
+
### Return type
|
3198
|
+
|
3199
|
+
nil (empty response body)
|
3200
|
+
|
3201
|
+
### HTTP request headers
|
3202
|
+
|
3203
|
+
- **Content-Type**: application/json
|
3204
|
+
- **Accept**: application/json
|
3205
|
+
|
3206
|
+
|
3207
|
+
|
2656
3208
|
<a name="post_user_invite"></a>
|
2657
3209
|
|
2658
3210
|
## - post_user_invite(user_id, opts)
|