purecloudplatformclientv2 34.0.0 → 35.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/ActionEntityListing.md +1 -1
- data/docs/AgentActivityEntityListing.md +1 -1
- data/docs/AlertingApi.md +66 -0
- data/docs/AnalyticsApi.md +144 -0
- data/docs/ArchitectApi.md +492 -2
- data/docs/AssignedWrapupCode.md +17 -0
- data/docs/AttemptLimitsEntityListing.md +1 -1
- data/docs/AttributeEntityListing.md +1 -1
- data/docs/AttributesApi.md +36 -0
- data/docs/AuthorizationApi.md +102 -0
- data/docs/BillingApi.md +6 -0
- data/docs/CalibrationEntityListing.md +1 -1
- data/docs/CallConversationEntityListing.md +1 -1
- data/docs/CallHistoryConversationEntityListing.md +1 -1
- data/docs/CallableTimeSetEntityListing.md +1 -1
- data/docs/CallbackConversationEntityListing.md +1 -1
- data/docs/CampaignDivisionView.md +16 -0
- data/docs/CampaignDivisionViewListing.md +22 -0
- 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/ContactListEntityListing.md +1 -1
- data/docs/ContactListFilterEntityListing.md +1 -1
- data/docs/ContactListing.md +1 -1
- data/docs/ContentManagementApi.md +228 -0
- data/docs/ConversationEntityListing.md +1 -1
- data/docs/ConversationsApi.md +590 -14
- data/docs/CredentialInfoListing.md +1 -1
- data/docs/CredentialTypeListing.md +1 -1
- data/docs/DIDEntityListing.md +1 -1
- data/docs/DIDPoolEntityListing.md +1 -1
- data/docs/DataTableRowEntityListing.md +1 -1
- data/docs/DataTablesDomainEntityListing.md +1 -1
- data/docs/DependencyObjectEntityListing.md +1 -1
- data/docs/DependencyTypeEntityListing.md +1 -1
- data/docs/DialerEventEntityListing.md +1 -1
- data/docs/DirectoryUserDevicesListing.md +1 -1
- data/docs/DncListEntityListing.md +1 -1
- data/docs/DocumentAuditEntityListing.md +1 -1
- data/docs/DocumentEntityListing.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +1 -1
- data/docs/DomainEntityListing.md +1 -1
- data/docs/DomainEntityListingEvaluationForm.md +1 -1
- data/docs/DomainEntityListingQueryResult.md +1 -1
- data/docs/DomainEntityListingSurveyForm.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/EdgeEntityListing.md +1 -1
- data/docs/EdgeGroupEntityListing.md +1 -1
- data/docs/EdgeLineEntityListing.md +1 -1
- data/docs/EmailConversationEntityListing.md +1 -1
- data/docs/EmailMessageListing.md +1 -1
- data/docs/EmergencyGroupListing.md +1 -1
- data/docs/EncryptionKeyEntityListing.md +1 -1
- data/docs/EndpointEntityListing.md +1 -1
- data/docs/EvaluationEntityListing.md +1 -1
- data/docs/EvaluationFormEntityListing.md +1 -1
- data/docs/EvaluatorActivityEntityListing.md +1 -1
- data/docs/ExtensionEntityListing.md +1 -1
- data/docs/ExtensionPoolEntityListing.md +1 -1
- data/docs/ExternalContactsApi.md +238 -69
- data/docs/ExternalOrganizationListing.md +1 -1
- data/docs/FaxApi.md +36 -0
- data/docs/FaxDocumentEntityListing.md +1 -1
- data/docs/Flow.md +1 -1
- data/docs/FlowDivisionViewEntityListing.md +1 -1
- data/docs/FlowEntityListing.md +1 -1
- data/docs/FlowVersionEntityListing.md +1 -1
- data/docs/GDPRRequestEntityListing.md +1 -1
- data/docs/GDPRSubjectEntityListing.md +1 -1
- data/docs/GeneralDataProtectionRegulationApi.md +24 -0
- data/docs/GeolocationApi.md +24 -0
- data/docs/GreetingListing.md +1 -1
- data/docs/GreetingsApi.md +96 -0
- data/docs/GroupEntityListing.md +1 -1
- data/docs/GroupProfileEntityListing.md +1 -1
- data/docs/GroupsApi.md +84 -0
- data/docs/IVREntityListing.md +1 -1
- data/docs/IdentityProviderApi.md +168 -0
- 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 +246 -0
- data/docs/InteractionStatsAlertContainer.md +1 -1
- data/docs/InteractionStatsRuleContainer.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/KeywordSetEntityListing.md +1 -1
- data/docs/LanguageEntityListing.md +1 -1
- data/docs/LanguagesApi.md +60 -0
- data/docs/LibraryEntityListing.md +1 -1
- data/docs/LicenseApi.md +48 -0
- data/docs/LineBaseEntityListing.md +1 -1
- data/docs/LineEntityListing.md +1 -1
- data/docs/LocationEntityListing.md +1 -1
- data/docs/LocationsApi.md +24 -0
- data/docs/LogicalInterfaceEntityListing.md +1 -1
- data/docs/ManagementUnitListing.md +1 -1
- data/docs/MessageConversationEntityListing.md +1 -1
- data/docs/MobileDevicesApi.md +30 -0
- data/docs/NoteListing.md +1 -1
- data/docs/NotificationsApi.md +42 -0
- data/docs/OAuthApi.md +36 -0
- data/docs/OAuthClientEntityListing.md +1 -1
- data/docs/OAuthProviderEntityListing.md +1 -1
- data/docs/OrganizationApi.md +24 -0
- data/docs/OrganizationAuthorizationApi.md +138 -0
- data/docs/OrganizationPresenceEntityListing.md +1 -1
- data/docs/OrganizationRoleEntityListing.md +1 -1
- data/docs/OrphanRecordingListing.md +1 -1
- data/docs/OutboundApi.md +611 -0
- 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/PresenceApi.md +48 -0
- data/docs/PromptAssetEntityListing.md +1 -1
- data/docs/PromptEntityListing.md +1 -1
- data/docs/QualityApi.md +300 -0
- data/docs/QualityAuditPage.md +1 -1
- data/docs/QueueEntityListing.md +1 -1
- data/docs/QueueMemberEntityListing.md +1 -1
- data/docs/RecipientListing.md +1 -1
- data/docs/RecordingApi.md +222 -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/ResponseManagementApi.md +66 -0
- data/docs/ResponseSetEntityListing.md +1 -1
- data/docs/RoutingApi.md +351 -1
- data/docs/RuleSetEntityListing.md +1 -1
- data/docs/ScheduleEntityListing.md +1 -1
- data/docs/ScheduleGroupEntityListing.md +1 -1
- data/docs/SchemaCategoryEntityListing.md +1 -1
- data/docs/SchemaReferenceEntityListing.md +1 -1
- data/docs/ScreenRecordingSessionListing.md +1 -1
- data/docs/ScriptEntityListing.md +1 -1
- data/docs/ScriptsApi.md +66 -0
- data/docs/SearchApi.md +84 -0
- 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/StationsApi.md +30 -0
- data/docs/SuggestApi.md +24 -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/TelephonyProvidersEdgeApi.md +762 -0
- data/docs/TextMessageListing.md +1 -1
- data/docs/TimeZone.md +2 -2
- data/docs/TimeZoneEntityListing.md +1 -1
- data/docs/TokensApi.md +12 -0
- data/docs/TrunkBaseEntityListing.md +1 -1
- data/docs/TrunkEntityListing.md +1 -1
- data/docs/TrunkMetabaseEntityListing.md +1 -1
- data/docs/TrustEntityListing.md +1 -1
- data/docs/TrustUserEntityListing.md +1 -1
- data/docs/TrustorEntityListing.md +1 -1
- data/docs/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/UserRecordingsApi.md +36 -0
- data/docs/UserSkillEntityListing.md +1 -1
- data/docs/UsersApi.md +321 -3
- data/docs/UtilitiesApi.md +18 -0
- data/docs/VoicemailApi.md +144 -0
- data/docs/VoicemailMessageEntityListing.md +1 -1
- data/docs/WebChatApi.md +48 -0
- data/docs/WebChatConfig.md +13 -0
- data/docs/WebChatDeployment.md +2 -1
- data/docs/WorkforceManagementApi.md +74 -2
- data/docs/WorkspaceEntityListing.md +1 -1
- data/docs/WorkspaceMemberEntityListing.md +1 -1
- data/docs/WrapupCodeEntityListing.md +1 -1
- data/lib/purecloudplatformclientv2.rb +4 -1
- data/lib/purecloudplatformclientv2/api/architect_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +21 -21
- data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +90 -68
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +117 -0
- data/lib/purecloudplatformclientv2/api/routing_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/users_api.rb +18 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +1 -1
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb +308 -0
- data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/calibration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/call_history_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callable_time_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/callback_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/{authz_division.rb → campaign_division_view.rb} +9 -68
- data/lib/purecloudplatformclientv2/models/campaign_division_view_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/campaign_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_rule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/campaign_sequence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/certificate_authority_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/chat_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/client_app_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/command_status_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consumed_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/consuming_resources_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_list_filter_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/contact_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_info_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/credential_type_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_object_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dependency_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dialer_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/did_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/directory_user_devices_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/dnc_list_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_audit_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_evaluation_form.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_query_result.rb +14 -14
- data/lib/purecloudplatformclientv2/models/domain_entity_listing_survey_form.rb +14 -14
- 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 +14 -14
- data/lib/purecloudplatformclientv2/models/edge_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/edge_line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/email_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/emergency_group_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/encryption_key_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/endpoint_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluation_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/evaluator_activity_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/extension_pool_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/external_organization_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/fax_document_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow.rb +13 -12
- data/lib/purecloudplatformclientv2/models/flow_division_view_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/flow_version_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_request_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/gdpr_subject_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/greeting_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/group_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_domain_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/inbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_event_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/integration_type_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule_container.rb +14 -14
- data/lib/purecloudplatformclientv2/models/ivr_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/json_node.rb +65 -65
- data/lib/purecloudplatformclientv2/models/keyword_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/library_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/line_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/location_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/logical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/note_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_client_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/o_auth_provider_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_presence_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/organization_role_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/orphan_recording_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/outbound_route_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/permission_collection_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/phone_meta_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/physical_interface_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/policy_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/quality_audit_page.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/queue_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/relationship_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_meta_data_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_run_entry_entity_domain_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/report_schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/reporting_export_job_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_list.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/response_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/rule_set_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schedule_group_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/schema_reference_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/screen_recording_session_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/script_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/security_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/share_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/site_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/station_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/survey_form_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_asset_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/system_prompt_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/tag_value_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
- data/lib/purecloudplatformclientv2/models/time_zone_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_base_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trunk_metabase_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trust_user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/trustor_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_action_category_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_language_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_profile_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_queue_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_recording_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/user_skill_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/voicemail_message_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/web_chat_config.rb +202 -0
- data/lib/purecloudplatformclientv2/models/web_chat_deployment.rb +27 -2
- data/lib/purecloudplatformclientv2/models/workspace_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/workspace_member_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/models/wrapup_code_entity_listing.rb +14 -14
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +10 -4
- data/docs/AuthzDivision.md +0 -18
data/docs/TextMessageListing.md
CHANGED
@@ -13,9 +13,9 @@ title: TextMessageListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/TimeZone.md
CHANGED
@@ -7,10 +7,10 @@ title: TimeZone
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **display_name** | **String** | | [optional] |
|
11
|
-
| **id** | **String** | | [optional] |
|
12
10
|
| **dstsavings** | **Integer** | | [optional] |
|
13
11
|
| **raw_offset** | **Integer** | | [optional] |
|
12
|
+
| **id** | **String** | | [optional] |
|
13
|
+
| **display_name** | **String** | | [optional] |
|
14
14
|
{: class="table table-striped"}
|
15
15
|
|
16
16
|
|
@@ -13,9 +13,9 @@ title: TimeZoneEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/TokensApi.md
CHANGED
@@ -16,12 +16,18 @@ Method | Description
|
|
16
16
|
|
17
17
|
## - delete_tokens_me
|
18
18
|
|
19
|
+
|
20
|
+
|
19
21
|
Delete auth token used to make the request.
|
20
22
|
|
21
23
|
|
22
24
|
|
23
25
|
Wraps DELETE /api/v2/tokens/me
|
24
26
|
|
27
|
+
Requires NO permissions:
|
28
|
+
|
29
|
+
|
30
|
+
|
25
31
|
|
26
32
|
### Example
|
27
33
|
~~~ruby
|
@@ -68,12 +74,18 @@ nil (empty response body)
|
|
68
74
|
|
69
75
|
## -[**TokenInfo**](TokenInfo.html) get_tokens_me
|
70
76
|
|
77
|
+
|
78
|
+
|
71
79
|
Fetch information about the current token
|
72
80
|
|
73
81
|
|
74
82
|
|
75
83
|
Wraps GET /api/v2/tokens/me
|
76
84
|
|
85
|
+
Requires NO permissions:
|
86
|
+
|
87
|
+
|
88
|
+
|
77
89
|
|
78
90
|
### Example
|
79
91
|
~~~ruby
|
@@ -13,9 +13,9 @@ title: TrunkBaseEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/TrunkEntityListing.md
CHANGED
@@ -13,9 +13,9 @@ title: TrunkEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: TrunkMetabaseEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/TrustEntityListing.md
CHANGED
@@ -13,9 +13,9 @@ title: TrustEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: TrustUserEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: TrustorEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: UserActionCategoryEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/UserEntityListing.md
CHANGED
@@ -13,9 +13,9 @@ title: UserEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: UserLanguageEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: UserProfileEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: UserQueueEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
@@ -13,9 +13,9 @@ title: UserRecordingEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/UserRecordingsApi.md
CHANGED
@@ -20,12 +20,18 @@ Method | Description
|
|
20
20
|
|
21
21
|
## - delete_userrecording(recording_id)
|
22
22
|
|
23
|
+
|
24
|
+
|
23
25
|
Delete a user recording.
|
24
26
|
|
25
27
|
|
26
28
|
|
27
29
|
Wraps DELETE /api/v2/userrecordings/{recordingId}
|
28
30
|
|
31
|
+
Requires NO permissions:
|
32
|
+
|
33
|
+
|
34
|
+
|
29
35
|
|
30
36
|
### Example
|
31
37
|
~~~ruby
|
@@ -78,12 +84,18 @@ nil (empty response body)
|
|
78
84
|
|
79
85
|
## -[**UserRecording**](UserRecording.html) get_userrecording(recording_id, opts)
|
80
86
|
|
87
|
+
|
88
|
+
|
81
89
|
Get a user recording.
|
82
90
|
|
83
91
|
|
84
92
|
|
85
93
|
Wraps GET /api/v2/userrecordings/{recordingId}
|
86
94
|
|
95
|
+
Requires NO permissions:
|
96
|
+
|
97
|
+
|
98
|
+
|
87
99
|
|
88
100
|
### Example
|
89
101
|
~~~ruby
|
@@ -141,12 +153,18 @@ Name | Type | Description | Notes
|
|
141
153
|
|
142
154
|
## -[**DownloadResponse**](DownloadResponse.html) get_userrecording_media(recording_id, opts)
|
143
155
|
|
156
|
+
|
157
|
+
|
144
158
|
Download a user recording.
|
145
159
|
|
146
160
|
|
147
161
|
|
148
162
|
Wraps GET /api/v2/userrecordings/{recordingId}/media
|
149
163
|
|
164
|
+
Requires NO permissions:
|
165
|
+
|
166
|
+
|
167
|
+
|
150
168
|
|
151
169
|
### Example
|
152
170
|
~~~ruby
|
@@ -204,12 +222,18 @@ Name | Type | Description | Notes
|
|
204
222
|
|
205
223
|
## -[**UserRecordingEntityListing**](UserRecordingEntityListing.html) get_userrecordings(opts)
|
206
224
|
|
225
|
+
|
226
|
+
|
207
227
|
Get a list of user recordings.
|
208
228
|
|
209
229
|
|
210
230
|
|
211
231
|
Wraps GET /api/v2/userrecordings
|
212
232
|
|
233
|
+
Requires NO permissions:
|
234
|
+
|
235
|
+
|
236
|
+
|
213
237
|
|
214
238
|
### Example
|
215
239
|
~~~ruby
|
@@ -268,12 +292,18 @@ Name | Type | Description | Notes
|
|
268
292
|
|
269
293
|
## -[**FaxSummary**](FaxSummary.html) get_userrecordings_summary
|
270
294
|
|
295
|
+
|
296
|
+
|
271
297
|
Get user recording summary
|
272
298
|
|
273
299
|
|
274
300
|
|
275
301
|
Wraps GET /api/v2/userrecordings/summary
|
276
302
|
|
303
|
+
Requires NO permissions:
|
304
|
+
|
305
|
+
|
306
|
+
|
277
307
|
|
278
308
|
### Example
|
279
309
|
~~~ruby
|
@@ -321,12 +351,18 @@ This endpoint does not need any parameter.
|
|
321
351
|
|
322
352
|
## -[**UserRecording**](UserRecording.html) put_userrecording(recording_id, body, opts)
|
323
353
|
|
354
|
+
|
355
|
+
|
324
356
|
Update a user recording.
|
325
357
|
|
326
358
|
|
327
359
|
|
328
360
|
Wraps PUT /api/v2/userrecordings/{recordingId}
|
329
361
|
|
362
|
+
Requires NO permissions:
|
363
|
+
|
364
|
+
|
365
|
+
|
330
366
|
|
331
367
|
### Example
|
332
368
|
~~~ruby
|
@@ -13,9 +13,9 @@ title: UserSkillEntityListing
|
|
13
13
|
| **total** | **Integer** | | [optional] |
|
14
14
|
| **self_uri** | **String** | | [optional] |
|
15
15
|
| **first_uri** | **String** | | [optional] |
|
16
|
-
| **last_uri** | **String** | | [optional] |
|
17
16
|
| **previous_uri** | **String** | | [optional] |
|
18
17
|
| **next_uri** | **String** | | [optional] |
|
18
|
+
| **last_uri** | **String** | | [optional] |
|
19
19
|
| **page_count** | **Integer** | | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
data/docs/UsersApi.md
CHANGED
@@ -66,12 +66,18 @@ Method | Description
|
|
66
66
|
|
67
67
|
## -[**Empty**](Empty.html) delete_user(user_id)
|
68
68
|
|
69
|
+
|
70
|
+
|
69
71
|
Delete user
|
70
72
|
|
71
73
|
|
72
74
|
|
73
75
|
Wraps DELETE /api/v2/users/{userId}
|
74
76
|
|
77
|
+
Requires NO permissions:
|
78
|
+
|
79
|
+
|
80
|
+
|
75
81
|
|
76
82
|
### Example
|
77
83
|
~~~ruby
|
@@ -125,12 +131,18 @@ Name | Type | Description | Notes
|
|
125
131
|
|
126
132
|
## - delete_user_roles(user_id)
|
127
133
|
|
134
|
+
|
135
|
+
|
128
136
|
Removes all the roles from the user.
|
129
137
|
|
130
138
|
|
131
139
|
|
132
140
|
Wraps DELETE /api/v2/users/{userId}/roles
|
133
141
|
|
142
|
+
Requires ANY permissions:
|
143
|
+
|
144
|
+
* admin* role_manager* authorization:grant:delete
|
145
|
+
|
134
146
|
|
135
147
|
### Example
|
136
148
|
~~~ruby
|
@@ -183,12 +195,18 @@ nil (empty response body)
|
|
183
195
|
|
184
196
|
## - delete_user_routinglanguage(user_id, language_id)
|
185
197
|
|
198
|
+
|
199
|
+
|
186
200
|
Remove routing language from user
|
187
201
|
|
188
202
|
|
189
203
|
|
190
204
|
Wraps DELETE /api/v2/users/{userId}/routinglanguages/{languageId}
|
191
205
|
|
206
|
+
Requires ANY permissions:
|
207
|
+
|
208
|
+
* routing:skill:assign* admin
|
209
|
+
|
192
210
|
|
193
211
|
### Example
|
194
212
|
~~~ruby
|
@@ -244,12 +262,18 @@ nil (empty response body)
|
|
244
262
|
|
245
263
|
## - delete_user_routingskill(user_id, skill_id)
|
246
264
|
|
265
|
+
|
266
|
+
|
247
267
|
Remove routing skill from user
|
248
268
|
|
249
269
|
|
250
270
|
|
251
271
|
Wraps DELETE /api/v2/users/{userId}/routingskills/{skillId}
|
252
272
|
|
273
|
+
Requires ANY permissions:
|
274
|
+
|
275
|
+
* routing:skill:assign* admin
|
276
|
+
|
253
277
|
|
254
278
|
### Example
|
255
279
|
~~~ruby
|
@@ -305,12 +329,18 @@ nil (empty response body)
|
|
305
329
|
|
306
330
|
## - delete_user_station_associatedstation(user_id)
|
307
331
|
|
332
|
+
|
333
|
+
|
308
334
|
Clear associated station
|
309
335
|
|
310
336
|
|
311
337
|
|
312
338
|
Wraps DELETE /api/v2/users/{userId}/station/associatedstation
|
313
339
|
|
340
|
+
Requires NO permissions:
|
341
|
+
|
342
|
+
|
343
|
+
|
314
344
|
|
315
345
|
### Example
|
316
346
|
~~~ruby
|
@@ -363,12 +393,18 @@ nil (empty response body)
|
|
363
393
|
|
364
394
|
## - delete_user_station_defaultstation(user_id)
|
365
395
|
|
396
|
+
|
397
|
+
|
366
398
|
Clear default station
|
367
399
|
|
368
400
|
|
369
401
|
|
370
402
|
Wraps DELETE /api/v2/users/{userId}/station/defaultstation
|
371
403
|
|
404
|
+
Requires ANY permissions:
|
405
|
+
|
406
|
+
* telephony:plugin:all* telephony:phone:assign
|
407
|
+
|
372
408
|
|
373
409
|
### Example
|
374
410
|
~~~ruby
|
@@ -421,12 +457,18 @@ nil (empty response body)
|
|
421
457
|
|
422
458
|
## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
|
423
459
|
|
460
|
+
|
461
|
+
|
424
462
|
Fetch field config for an entity type
|
425
463
|
|
426
464
|
|
427
465
|
|
428
466
|
Wraps GET /api/v2/fieldconfig
|
429
467
|
|
468
|
+
Requires NO permissions:
|
469
|
+
|
470
|
+
|
471
|
+
|
430
472
|
|
431
473
|
### Example
|
432
474
|
~~~ruby
|
@@ -480,12 +522,18 @@ Name | Type | Description | Notes
|
|
480
522
|
|
481
523
|
## -[**UserProfileEntityListing**](UserProfileEntityListing.html) get_profiles_users(opts)
|
482
524
|
|
525
|
+
|
526
|
+
|
483
527
|
Get a user profile listing
|
484
528
|
|
485
529
|
|
486
530
|
|
487
531
|
Wraps GET /api/v2/profiles/users
|
488
532
|
|
533
|
+
Requires NO permissions:
|
534
|
+
|
535
|
+
|
536
|
+
|
489
537
|
|
490
538
|
### Example
|
491
539
|
~~~ruby
|
@@ -552,12 +600,18 @@ Name | Type | Description | Notes
|
|
552
600
|
|
553
601
|
## -[**User**](User.html) get_user(user_id, opts)
|
554
602
|
|
603
|
+
|
604
|
+
|
555
605
|
Get user.
|
556
606
|
|
557
607
|
|
558
608
|
|
559
609
|
Wraps GET /api/v2/users/{userId}
|
560
610
|
|
611
|
+
Requires NO permissions:
|
612
|
+
|
613
|
+
|
614
|
+
|
561
615
|
|
562
616
|
### Example
|
563
617
|
~~~ruby
|
@@ -617,12 +671,18 @@ Name | Type | Description | Notes
|
|
617
671
|
|
618
672
|
## -[**Adjacents**](Adjacents.html) get_user_adjacents(user_id, opts)
|
619
673
|
|
674
|
+
|
675
|
+
|
620
676
|
Get adjacents
|
621
677
|
|
622
678
|
|
623
679
|
|
624
680
|
Wraps GET /api/v2/users/{userId}/adjacents
|
625
681
|
|
682
|
+
Requires NO permissions:
|
683
|
+
|
684
|
+
|
685
|
+
|
626
686
|
|
627
687
|
### Example
|
628
688
|
~~~ruby
|
@@ -680,12 +740,18 @@ Name | Type | Description | Notes
|
|
680
740
|
|
681
741
|
## -[**CallForwarding**](CallForwarding.html) get_user_callforwarding(user_id)
|
682
742
|
|
743
|
+
|
744
|
+
|
683
745
|
Get a user's CallForwarding
|
684
746
|
|
685
747
|
|
686
748
|
|
687
749
|
Wraps GET /api/v2/users/{userId}/callforwarding
|
688
750
|
|
751
|
+
Requires NO permissions:
|
752
|
+
|
753
|
+
|
754
|
+
|
689
755
|
|
690
756
|
### Example
|
691
757
|
~~~ruby
|
@@ -739,12 +805,18 @@ Name | Type | Description | Notes
|
|
739
805
|
|
740
806
|
## -[**Array<User>**](User.html) get_user_directreports(user_id, opts)
|
741
807
|
|
808
|
+
|
809
|
+
|
742
810
|
Get direct reports
|
743
811
|
|
744
812
|
|
745
813
|
|
746
814
|
Wraps GET /api/v2/users/{userId}/directreports
|
747
815
|
|
816
|
+
Requires NO permissions:
|
817
|
+
|
818
|
+
|
819
|
+
|
748
820
|
|
749
821
|
### Example
|
750
822
|
~~~ruby
|
@@ -802,12 +874,18 @@ Name | Type | Description | Notes
|
|
802
874
|
|
803
875
|
## -[**UserEntityListing**](UserEntityListing.html) get_user_favorites(user_id, opts)
|
804
876
|
|
877
|
+
|
878
|
+
|
805
879
|
Get favorites
|
806
880
|
|
807
881
|
|
808
882
|
|
809
883
|
Wraps GET /api/v2/users/{userId}/favorites
|
810
884
|
|
885
|
+
Requires NO permissions:
|
886
|
+
|
887
|
+
|
888
|
+
|
811
889
|
|
812
890
|
### Example
|
813
891
|
~~~ruby
|
@@ -871,12 +949,18 @@ Name | Type | Description | Notes
|
|
871
949
|
|
872
950
|
## -[**Geolocation**](Geolocation.html) get_user_geolocation(user_id, client_id)
|
873
951
|
|
952
|
+
|
953
|
+
|
874
954
|
Get a user's Geolocation
|
875
955
|
|
876
956
|
|
877
957
|
|
878
958
|
Wraps GET /api/v2/users/{userId}/geolocations/{clientId}
|
879
959
|
|
960
|
+
Requires NO permissions:
|
961
|
+
|
962
|
+
|
963
|
+
|
880
964
|
|
881
965
|
### Example
|
882
966
|
~~~ruby
|
@@ -933,12 +1017,18 @@ Name | Type | Description | Notes
|
|
933
1017
|
|
934
1018
|
## -[**OutOfOffice**](OutOfOffice.html) get_user_outofoffice(user_id)
|
935
1019
|
|
1020
|
+
|
1021
|
+
|
936
1022
|
Get a OutOfOffice
|
937
1023
|
|
938
1024
|
|
939
1025
|
|
940
1026
|
Wraps GET /api/v2/users/{userId}/outofoffice
|
941
1027
|
|
1028
|
+
Requires NO permissions:
|
1029
|
+
|
1030
|
+
|
1031
|
+
|
942
1032
|
|
943
1033
|
### Example
|
944
1034
|
~~~ruby
|
@@ -992,12 +1082,18 @@ Name | Type | Description | Notes
|
|
992
1082
|
|
993
1083
|
## -[**UserProfile**](UserProfile.html) get_user_profile(user_id, opts)
|
994
1084
|
|
1085
|
+
|
1086
|
+
|
995
1087
|
Get user profile
|
996
1088
|
|
997
1089
|
|
998
1090
|
|
999
1091
|
Wraps GET /api/v2/users/{userId}/profile
|
1000
1092
|
|
1093
|
+
Requires NO permissions:
|
1094
|
+
|
1095
|
+
|
1096
|
+
|
1001
1097
|
|
1002
1098
|
### Example
|
1003
1099
|
~~~ruby
|
@@ -1055,12 +1151,18 @@ Name | Type | Description | Notes
|
|
1055
1151
|
|
1056
1152
|
## -Array<String>** get_user_profileskills(user_id)
|
1057
1153
|
|
1154
|
+
|
1155
|
+
|
1058
1156
|
List profile skills for a user
|
1059
1157
|
|
1060
1158
|
|
1061
1159
|
|
1062
1160
|
Wraps GET /api/v2/users/{userId}/profileskills
|
1063
1161
|
|
1162
|
+
Requires ANY permissions:
|
1163
|
+
|
1164
|
+
* directory:userProfile:view
|
1165
|
+
|
1064
1166
|
|
1065
1167
|
### Example
|
1066
1168
|
~~~ruby
|
@@ -1114,12 +1216,18 @@ Name | Type | Description | Notes
|
|
1114
1216
|
|
1115
1217
|
## -[**UserQueueEntityListing**](UserQueueEntityListing.html) get_user_queues(user_id, opts)
|
1116
1218
|
|
1219
|
+
|
1220
|
+
|
1117
1221
|
Get queues for user
|
1118
1222
|
|
1119
1223
|
|
1120
1224
|
|
1121
1225
|
Wraps GET /api/v2/users/{userId}/queues
|
1122
1226
|
|
1227
|
+
Requires ANY permissions:
|
1228
|
+
|
1229
|
+
* routing:queue:view
|
1230
|
+
|
1123
1231
|
|
1124
1232
|
### Example
|
1125
1233
|
~~~ruby
|
@@ -1143,7 +1251,8 @@ user_id = "user_id_example" # String | User ID
|
|
1143
1251
|
opts = {
|
1144
1252
|
page_size: 25, # Integer | Page size
|
1145
1253
|
page_number: 1, # Integer | Page number
|
1146
|
-
joined: true # BOOLEAN | Is joined to the queue
|
1254
|
+
joined: true, # BOOLEAN | Is joined to the queue
|
1255
|
+
division_id: ["division_id_example"] # Array<String> | Division ID(s)
|
1147
1256
|
}
|
1148
1257
|
|
1149
1258
|
begin
|
@@ -1163,6 +1272,7 @@ Name | Type | Description | Notes
|
|
1163
1272
|
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1164
1273
|
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1165
1274
|
**joined** | **BOOLEAN**| Is joined to the queue | [optional] [default to true] |
|
1275
|
+
**division_id** | [**Array<String>**](String.html)| Division ID(s) | [optional] |
|
1166
1276
|
{: class="table table-striped"}
|
1167
1277
|
|
1168
1278
|
|
@@ -1181,12 +1291,18 @@ Name | Type | Description | Notes
|
|
1181
1291
|
|
1182
1292
|
## -[**UserAuthorization**](UserAuthorization.html) get_user_roles(user_id)
|
1183
1293
|
|
1294
|
+
|
1295
|
+
|
1184
1296
|
Returns a listing of roles and permissions for a user.
|
1185
1297
|
|
1186
1298
|
|
1187
1299
|
|
1188
1300
|
Wraps GET /api/v2/users/{userId}/roles
|
1189
1301
|
|
1302
|
+
Requires ANY permissions:
|
1303
|
+
|
1304
|
+
* authorization:grant:view
|
1305
|
+
|
1190
1306
|
|
1191
1307
|
### Example
|
1192
1308
|
~~~ruby
|
@@ -1240,12 +1356,18 @@ Name | Type | Description | Notes
|
|
1240
1356
|
|
1241
1357
|
## -[**UserLanguageEntityListing**](UserLanguageEntityListing.html) get_user_routinglanguages(user_id, opts)
|
1242
1358
|
|
1359
|
+
|
1360
|
+
|
1243
1361
|
List routing language for user
|
1244
1362
|
|
1245
1363
|
|
1246
1364
|
|
1247
1365
|
Wraps GET /api/v2/users/{userId}/routinglanguages
|
1248
1366
|
|
1367
|
+
Requires NO permissions:
|
1368
|
+
|
1369
|
+
|
1370
|
+
|
1249
1371
|
|
1250
1372
|
### Example
|
1251
1373
|
~~~ruby
|
@@ -1307,12 +1429,18 @@ Name | Type | Description | Notes
|
|
1307
1429
|
|
1308
1430
|
## -[**UserSkillEntityListing**](UserSkillEntityListing.html) get_user_routingskills(user_id, opts)
|
1309
1431
|
|
1432
|
+
|
1433
|
+
|
1310
1434
|
List routing skills for user
|
1311
1435
|
|
1312
1436
|
|
1313
1437
|
|
1314
1438
|
Wraps GET /api/v2/users/{userId}/routingskills
|
1315
1439
|
|
1440
|
+
Requires NO permissions:
|
1441
|
+
|
1442
|
+
|
1443
|
+
|
1316
1444
|
|
1317
1445
|
### Example
|
1318
1446
|
~~~ruby
|
@@ -1374,12 +1502,18 @@ Name | Type | Description | Notes
|
|
1374
1502
|
|
1375
1503
|
## -[**RoutingStatus**](RoutingStatus.html) get_user_routingstatus(user_id)
|
1376
1504
|
|
1505
|
+
|
1506
|
+
|
1377
1507
|
Fetch the routing status of a user
|
1378
1508
|
|
1379
1509
|
|
1380
1510
|
|
1381
1511
|
Wraps GET /api/v2/users/{userId}/routingstatus
|
1382
1512
|
|
1513
|
+
Requires NO permissions:
|
1514
|
+
|
1515
|
+
|
1516
|
+
|
1383
1517
|
|
1384
1518
|
### Example
|
1385
1519
|
~~~ruby
|
@@ -1433,12 +1567,18 @@ Name | Type | Description | Notes
|
|
1433
1567
|
|
1434
1568
|
## -[**UserStations**](UserStations.html) get_user_station(user_id)
|
1435
1569
|
|
1570
|
+
|
1571
|
+
|
1436
1572
|
Get station information for user
|
1437
1573
|
|
1438
1574
|
|
1439
1575
|
|
1440
1576
|
Wraps GET /api/v2/users/{userId}/station
|
1441
1577
|
|
1578
|
+
Requires NO permissions:
|
1579
|
+
|
1580
|
+
|
1581
|
+
|
1442
1582
|
|
1443
1583
|
### Example
|
1444
1584
|
~~~ruby
|
@@ -1492,12 +1632,18 @@ Name | Type | Description | Notes
|
|
1492
1632
|
|
1493
1633
|
## -[**Array<User>**](User.html) get_user_superiors(user_id, opts)
|
1494
1634
|
|
1635
|
+
|
1636
|
+
|
1495
1637
|
Get superiors
|
1496
1638
|
|
1497
1639
|
|
1498
1640
|
|
1499
1641
|
Wraps GET /api/v2/users/{userId}/superiors
|
1500
1642
|
|
1643
|
+
Requires NO permissions:
|
1644
|
+
|
1645
|
+
|
1646
|
+
|
1501
1647
|
|
1502
1648
|
### Example
|
1503
1649
|
~~~ruby
|
@@ -1555,12 +1701,18 @@ Name | Type | Description | Notes
|
|
1555
1701
|
|
1556
1702
|
## -[**TrustorEntityListing**](TrustorEntityListing.html) get_user_trustors(user_id, opts)
|
1557
1703
|
|
1704
|
+
|
1705
|
+
|
1558
1706
|
List the organizations that have authorized/trusted the user.
|
1559
1707
|
|
1560
1708
|
|
1561
1709
|
|
1562
1710
|
Wraps GET /api/v2/users/{userId}/trustors
|
1563
1711
|
|
1712
|
+
Requires ANY permissions:
|
1713
|
+
|
1714
|
+
* authorization:orgTrustor:view
|
1715
|
+
|
1564
1716
|
|
1565
1717
|
### Example
|
1566
1718
|
~~~ruby
|
@@ -1620,12 +1772,18 @@ Name | Type | Description | Notes
|
|
1620
1772
|
|
1621
1773
|
## -[**UserEntityListing**](UserEntityListing.html) get_users(opts)
|
1622
1774
|
|
1775
|
+
|
1776
|
+
|
1623
1777
|
Get the list of available users.
|
1624
1778
|
|
1625
1779
|
|
1626
1780
|
|
1627
1781
|
Wraps GET /api/v2/users
|
1628
1782
|
|
1783
|
+
Requires NO permissions:
|
1784
|
+
|
1785
|
+
|
1786
|
+
|
1629
1787
|
|
1630
1788
|
### Example
|
1631
1789
|
~~~ruby
|
@@ -1690,12 +1848,18 @@ Name | Type | Description | Notes
|
|
1690
1848
|
|
1691
1849
|
## -[**UserMe**](UserMe.html) get_users_me(opts)
|
1692
1850
|
|
1851
|
+
|
1852
|
+
|
1693
1853
|
Get current user details.
|
1694
1854
|
|
1695
1855
|
This request is not valid when using the Client Credentials OAuth grant.
|
1696
1856
|
|
1697
1857
|
Wraps GET /api/v2/users/me
|
1698
1858
|
|
1859
|
+
Requires NO permissions:
|
1860
|
+
|
1861
|
+
|
1862
|
+
|
1699
1863
|
|
1700
1864
|
### Example
|
1701
1865
|
~~~ruby
|
@@ -1750,12 +1914,18 @@ Name | Type | Description | Notes
|
|
1750
1914
|
|
1751
1915
|
## -[**UsersSearchResponse**](UsersSearchResponse.html) get_users_search(q64, opts)
|
1752
1916
|
|
1917
|
+
|
1918
|
+
|
1753
1919
|
Search users using the q64 value returned from a previous search
|
1754
1920
|
|
1755
1921
|
|
1756
1922
|
|
1757
1923
|
Wraps GET /api/v2/users/search
|
1758
1924
|
|
1925
|
+
Requires NO permissions:
|
1926
|
+
|
1927
|
+
|
1928
|
+
|
1759
1929
|
|
1760
1930
|
### Example
|
1761
1931
|
~~~ruby
|
@@ -1813,12 +1983,18 @@ Name | Type | Description | Notes
|
|
1813
1983
|
|
1814
1984
|
## -[**User**](User.html) patch_user(user_id, body)
|
1815
1985
|
|
1986
|
+
|
1987
|
+
|
1816
1988
|
Update user
|
1817
1989
|
|
1818
1990
|
|
1819
1991
|
|
1820
1992
|
Wraps PATCH /api/v2/users/{userId}
|
1821
1993
|
|
1994
|
+
Requires NO permissions:
|
1995
|
+
|
1996
|
+
|
1997
|
+
|
1822
1998
|
|
1823
1999
|
### Example
|
1824
2000
|
~~~ruby
|
@@ -1875,12 +2051,18 @@ Name | Type | Description | Notes
|
|
1875
2051
|
|
1876
2052
|
## -[**CallForwarding**](CallForwarding.html) patch_user_callforwarding(user_id, body)
|
1877
2053
|
|
2054
|
+
|
2055
|
+
|
1878
2056
|
Patch a user's CallForwarding
|
1879
2057
|
|
1880
2058
|
|
1881
2059
|
|
1882
2060
|
Wraps PATCH /api/v2/users/{userId}/callforwarding
|
1883
2061
|
|
2062
|
+
Requires NO permissions:
|
2063
|
+
|
2064
|
+
|
2065
|
+
|
1884
2066
|
|
1885
2067
|
### Example
|
1886
2068
|
~~~ruby
|
@@ -1937,12 +2119,18 @@ Name | Type | Description | Notes
|
|
1937
2119
|
|
1938
2120
|
## -[**Geolocation**](Geolocation.html) patch_user_geolocation(user_id, client_id, body)
|
1939
2121
|
|
2122
|
+
|
2123
|
+
|
1940
2124
|
Patch a user's Geolocation
|
1941
2125
|
|
1942
2126
|
The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.
|
1943
2127
|
|
1944
2128
|
Wraps PATCH /api/v2/users/{userId}/geolocations/{clientId}
|
1945
2129
|
|
2130
|
+
Requires NO permissions:
|
2131
|
+
|
2132
|
+
|
2133
|
+
|
1946
2134
|
|
1947
2135
|
### Example
|
1948
2136
|
~~~ruby
|
@@ -2002,12 +2190,18 @@ Name | Type | Description | Notes
|
|
2002
2190
|
|
2003
2191
|
## -[**UserQueue**](UserQueue.html) patch_user_queue(queue_id, user_id, body)
|
2004
2192
|
|
2193
|
+
|
2194
|
+
|
2005
2195
|
Join or unjoin a queue for a user
|
2006
2196
|
|
2007
2197
|
|
2008
2198
|
|
2009
2199
|
Wraps PATCH /api/v2/users/{userId}/queues/{queueId}
|
2010
2200
|
|
2201
|
+
Requires ANY permissions:
|
2202
|
+
|
2203
|
+
* routing:queue:join
|
2204
|
+
|
2011
2205
|
|
2012
2206
|
### Example
|
2013
2207
|
~~~ruby
|
@@ -2065,7 +2259,9 @@ Name | Type | Description | Notes
|
|
2065
2259
|
|
2066
2260
|
<a name="patch_user_queues"></a>
|
2067
2261
|
|
2068
|
-
## -[**UserQueueEntityListing**](UserQueueEntityListing.html) patch_user_queues(user_id, body)
|
2262
|
+
## -[**UserQueueEntityListing**](UserQueueEntityListing.html) patch_user_queues(user_id, body, opts)
|
2263
|
+
|
2264
|
+
|
2069
2265
|
|
2070
2266
|
Join or unjoin a set of queues for a user
|
2071
2267
|
|
@@ -2073,6 +2269,10 @@ Join or unjoin a set of queues for a user
|
|
2073
2269
|
|
2074
2270
|
Wraps PATCH /api/v2/users/{userId}/queues
|
2075
2271
|
|
2272
|
+
Requires ANY permissions:
|
2273
|
+
|
2274
|
+
* routing:queue:join
|
2275
|
+
|
2076
2276
|
|
2077
2277
|
### Example
|
2078
2278
|
~~~ruby
|
@@ -2095,10 +2295,13 @@ user_id = "user_id_example" # String | User ID
|
|
2095
2295
|
|
2096
2296
|
body = [PureCloud::UserQueue.new] # Array<UserQueue> | User Queues
|
2097
2297
|
|
2298
|
+
opts = {
|
2299
|
+
division_id: ["division_id_example"] # Array<String> | Division ID(s)
|
2300
|
+
}
|
2098
2301
|
|
2099
2302
|
begin
|
2100
2303
|
#Join or unjoin a set of queues for a user
|
2101
|
-
result = api_instance.patch_user_queues(user_id, body)
|
2304
|
+
result = api_instance.patch_user_queues(user_id, body, opts)
|
2102
2305
|
p result
|
2103
2306
|
rescue PureCloud::ApiError => e
|
2104
2307
|
puts "Exception when calling UsersApi->patch_user_queues: #{e}"
|
@@ -2111,6 +2314,7 @@ Name | Type | Description | Notes
|
|
2111
2314
|
------------- | ------------- | ------------- | -------------
|
2112
2315
|
**user_id** | **String**| User ID | |
|
2113
2316
|
**body** | [**Array<UserQueue>**](UserQueue.html)| User Queues | |
|
2317
|
+
**division_id** | [**Array<String>**](String.html)| Division ID(s) | [optional] |
|
2114
2318
|
{: class="table table-striped"}
|
2115
2319
|
|
2116
2320
|
|
@@ -2129,12 +2333,18 @@ Name | Type | Description | Notes
|
|
2129
2333
|
|
2130
2334
|
## -[**UserRoutingLanguage**](UserRoutingLanguage.html) patch_user_routinglanguage(user_id, language_id, body)
|
2131
2335
|
|
2336
|
+
|
2337
|
+
|
2132
2338
|
Update routing language proficiency or state.
|
2133
2339
|
|
2134
2340
|
|
2135
2341
|
|
2136
2342
|
Wraps PATCH /api/v2/users/{userId}/routinglanguages/{languageId}
|
2137
2343
|
|
2344
|
+
Requires ANY permissions:
|
2345
|
+
|
2346
|
+
* routing:skill:assign* admin
|
2347
|
+
|
2138
2348
|
|
2139
2349
|
### Example
|
2140
2350
|
~~~ruby
|
@@ -2194,12 +2404,18 @@ Name | Type | Description | Notes
|
|
2194
2404
|
|
2195
2405
|
## -[**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
|
2196
2406
|
|
2407
|
+
|
2408
|
+
|
2197
2409
|
Query for user aggregates
|
2198
2410
|
|
2199
2411
|
|
2200
2412
|
|
2201
2413
|
Wraps POST /api/v2/analytics/users/aggregates/query
|
2202
2414
|
|
2415
|
+
Requires ANY permissions:
|
2416
|
+
|
2417
|
+
* analytics:userAggregate:view
|
2418
|
+
|
2203
2419
|
|
2204
2420
|
### Example
|
2205
2421
|
~~~ruby
|
@@ -2253,12 +2469,18 @@ Name | Type | Description | Notes
|
|
2253
2469
|
|
2254
2470
|
## -[**AnalyticsUserDetailsQueryResponse**](AnalyticsUserDetailsQueryResponse.html) post_analytics_users_details_query(body)
|
2255
2471
|
|
2472
|
+
|
2473
|
+
|
2256
2474
|
Query for user details
|
2257
2475
|
|
2258
2476
|
|
2259
2477
|
|
2260
2478
|
Wraps POST /api/v2/analytics/users/details/query
|
2261
2479
|
|
2480
|
+
Requires ANY permissions:
|
2481
|
+
|
2482
|
+
* analytics:userObservation:view
|
2483
|
+
|
2262
2484
|
|
2263
2485
|
### Example
|
2264
2486
|
~~~ruby
|
@@ -2312,12 +2534,18 @@ Name | Type | Description | Notes
|
|
2312
2534
|
|
2313
2535
|
## -[**ObservationQueryResponse**](ObservationQueryResponse.html) post_analytics_users_observations_query(body)
|
2314
2536
|
|
2537
|
+
|
2538
|
+
|
2315
2539
|
Query for user observations
|
2316
2540
|
|
2317
2541
|
|
2318
2542
|
|
2319
2543
|
Wraps POST /api/v2/analytics/users/observations/query
|
2320
2544
|
|
2545
|
+
Requires ANY permissions:
|
2546
|
+
|
2547
|
+
* analytics:userObservation:view
|
2548
|
+
|
2321
2549
|
|
2322
2550
|
### Example
|
2323
2551
|
~~~ruby
|
@@ -2371,12 +2599,18 @@ Name | Type | Description | Notes
|
|
2371
2599
|
|
2372
2600
|
## - post_user_invite(user_id, opts)
|
2373
2601
|
|
2602
|
+
|
2603
|
+
|
2374
2604
|
Send an activation email to the user
|
2375
2605
|
|
2376
2606
|
|
2377
2607
|
|
2378
2608
|
Wraps POST /api/v2/users/{userId}/invite
|
2379
2609
|
|
2610
|
+
Requires ANY permissions:
|
2611
|
+
|
2612
|
+
* directory:user:add* user_manager* user_administration
|
2613
|
+
|
2380
2614
|
|
2381
2615
|
### Example
|
2382
2616
|
~~~ruby
|
@@ -2433,12 +2667,18 @@ nil (empty response body)
|
|
2433
2667
|
|
2434
2668
|
## - post_user_password(user_id, body)
|
2435
2669
|
|
2670
|
+
|
2671
|
+
|
2436
2672
|
Change a users password
|
2437
2673
|
|
2438
2674
|
|
2439
2675
|
|
2440
2676
|
Wraps POST /api/v2/users/{userId}/password
|
2441
2677
|
|
2678
|
+
Requires ANY permissions:
|
2679
|
+
|
2680
|
+
* user_administration* directory:userPassword:edit
|
2681
|
+
|
2442
2682
|
|
2443
2683
|
### Example
|
2444
2684
|
~~~ruby
|
@@ -2494,12 +2734,18 @@ nil (empty response body)
|
|
2494
2734
|
|
2495
2735
|
## -[**UserRoutingLanguage**](UserRoutingLanguage.html) post_user_routinglanguages(user_id, body)
|
2496
2736
|
|
2737
|
+
|
2738
|
+
|
2497
2739
|
Add routing language to user
|
2498
2740
|
|
2499
2741
|
|
2500
2742
|
|
2501
2743
|
Wraps POST /api/v2/users/{userId}/routinglanguages
|
2502
2744
|
|
2745
|
+
Requires ANY permissions:
|
2746
|
+
|
2747
|
+
* routing:skill:assign* admin
|
2748
|
+
|
2503
2749
|
|
2504
2750
|
### Example
|
2505
2751
|
~~~ruby
|
@@ -2556,12 +2802,18 @@ Name | Type | Description | Notes
|
|
2556
2802
|
|
2557
2803
|
## -[**UserRoutingSkill**](UserRoutingSkill.html) post_user_routingskills(user_id, body)
|
2558
2804
|
|
2805
|
+
|
2806
|
+
|
2559
2807
|
Add routing skill to user
|
2560
2808
|
|
2561
2809
|
|
2562
2810
|
|
2563
2811
|
Wraps POST /api/v2/users/{userId}/routingskills
|
2564
2812
|
|
2813
|
+
Requires ANY permissions:
|
2814
|
+
|
2815
|
+
* routing:skill:assign* admin
|
2816
|
+
|
2565
2817
|
|
2566
2818
|
### Example
|
2567
2819
|
~~~ruby
|
@@ -2618,12 +2870,18 @@ Name | Type | Description | Notes
|
|
2618
2870
|
|
2619
2871
|
## -[**User**](User.html) post_users(body)
|
2620
2872
|
|
2873
|
+
|
2874
|
+
|
2621
2875
|
Create user
|
2622
2876
|
|
2623
2877
|
|
2624
2878
|
|
2625
2879
|
Wraps POST /api/v2/users
|
2626
2880
|
|
2881
|
+
Requires ANY permissions:
|
2882
|
+
|
2883
|
+
* directory:user:add
|
2884
|
+
|
2627
2885
|
|
2628
2886
|
### Example
|
2629
2887
|
~~~ruby
|
@@ -2677,12 +2935,18 @@ Name | Type | Description | Notes
|
|
2677
2935
|
|
2678
2936
|
## - post_users_me_password(body)
|
2679
2937
|
|
2938
|
+
|
2939
|
+
|
2680
2940
|
Change your password
|
2681
2941
|
|
2682
2942
|
|
2683
2943
|
|
2684
2944
|
Wraps POST /api/v2/users/me/password
|
2685
2945
|
|
2946
|
+
Requires NO permissions:
|
2947
|
+
|
2948
|
+
|
2949
|
+
|
2686
2950
|
|
2687
2951
|
### Example
|
2688
2952
|
~~~ruby
|
@@ -2735,12 +2999,18 @@ nil (empty response body)
|
|
2735
2999
|
|
2736
3000
|
## -[**UsersSearchResponse**](UsersSearchResponse.html) post_users_search(body)
|
2737
3001
|
|
3002
|
+
|
3003
|
+
|
2738
3004
|
Search users
|
2739
3005
|
|
2740
3006
|
|
2741
3007
|
|
2742
3008
|
Wraps POST /api/v2/users/search
|
2743
3009
|
|
3010
|
+
Requires NO permissions:
|
3011
|
+
|
3012
|
+
|
3013
|
+
|
2744
3014
|
|
2745
3015
|
### Example
|
2746
3016
|
~~~ruby
|
@@ -2794,12 +3064,18 @@ Name | Type | Description | Notes
|
|
2794
3064
|
|
2795
3065
|
## -[**CallForwarding**](CallForwarding.html) put_user_callforwarding(user_id, body)
|
2796
3066
|
|
3067
|
+
|
3068
|
+
|
2797
3069
|
Update a user's CallForwarding
|
2798
3070
|
|
2799
3071
|
|
2800
3072
|
|
2801
3073
|
Wraps PUT /api/v2/users/{userId}/callforwarding
|
2802
3074
|
|
3075
|
+
Requires NO permissions:
|
3076
|
+
|
3077
|
+
|
3078
|
+
|
2803
3079
|
|
2804
3080
|
### Example
|
2805
3081
|
~~~ruby
|
@@ -2856,12 +3132,18 @@ Name | Type | Description | Notes
|
|
2856
3132
|
|
2857
3133
|
## -[**OutOfOffice**](OutOfOffice.html) put_user_outofoffice(user_id, body)
|
2858
3134
|
|
3135
|
+
|
3136
|
+
|
2859
3137
|
Update an OutOfOffice
|
2860
3138
|
|
2861
3139
|
|
2862
3140
|
|
2863
3141
|
Wraps PUT /api/v2/users/{userId}/outofoffice
|
2864
3142
|
|
3143
|
+
Requires NO permissions:
|
3144
|
+
|
3145
|
+
|
3146
|
+
|
2865
3147
|
|
2866
3148
|
### Example
|
2867
3149
|
~~~ruby
|
@@ -2918,12 +3200,18 @@ Name | Type | Description | Notes
|
|
2918
3200
|
|
2919
3201
|
## -Array<String>** put_user_profileskills(user_id, opts)
|
2920
3202
|
|
3203
|
+
|
3204
|
+
|
2921
3205
|
Update profile skills for a user
|
2922
3206
|
|
2923
3207
|
|
2924
3208
|
|
2925
3209
|
Wraps PUT /api/v2/users/{userId}/profileskills
|
2926
3210
|
|
3211
|
+
Requires ANY permissions:
|
3212
|
+
|
3213
|
+
* directory:userProfile:edit* admin* user_manager* user_administration
|
3214
|
+
|
2927
3215
|
|
2928
3216
|
### Example
|
2929
3217
|
~~~ruby
|
@@ -2981,12 +3269,18 @@ Name | Type | Description | Notes
|
|
2981
3269
|
|
2982
3270
|
## -[**UserAuthorization**](UserAuthorization.html) put_user_roles(user_id, body)
|
2983
3271
|
|
3272
|
+
|
3273
|
+
|
2984
3274
|
Sets the user's roles
|
2985
3275
|
|
2986
3276
|
|
2987
3277
|
|
2988
3278
|
Wraps PUT /api/v2/users/{userId}/roles
|
2989
3279
|
|
3280
|
+
Requires ANY permissions:
|
3281
|
+
|
3282
|
+
* admin* role_manager* authorization:grant:add
|
3283
|
+
|
2990
3284
|
|
2991
3285
|
### Example
|
2992
3286
|
~~~ruby
|
@@ -3043,12 +3337,18 @@ Name | Type | Description | Notes
|
|
3043
3337
|
|
3044
3338
|
## -[**UserRoutingSkill**](UserRoutingSkill.html) put_user_routingskill(user_id, skill_id, body)
|
3045
3339
|
|
3340
|
+
|
3341
|
+
|
3046
3342
|
Update routing skill proficiency or state.
|
3047
3343
|
|
3048
3344
|
|
3049
3345
|
|
3050
3346
|
Wraps PUT /api/v2/users/{userId}/routingskills/{skillId}
|
3051
3347
|
|
3348
|
+
Requires ANY permissions:
|
3349
|
+
|
3350
|
+
* routing:skill:assign* admin
|
3351
|
+
|
3052
3352
|
|
3053
3353
|
### Example
|
3054
3354
|
~~~ruby
|
@@ -3108,12 +3408,18 @@ Name | Type | Description | Notes
|
|
3108
3408
|
|
3109
3409
|
## -[**RoutingStatus**](RoutingStatus.html) put_user_routingstatus(user_id, body)
|
3110
3410
|
|
3411
|
+
|
3412
|
+
|
3111
3413
|
Update the routing status of a user
|
3112
3414
|
|
3113
3415
|
|
3114
3416
|
|
3115
3417
|
Wraps PUT /api/v2/users/{userId}/routingstatus
|
3116
3418
|
|
3419
|
+
Requires NO permissions:
|
3420
|
+
|
3421
|
+
|
3422
|
+
|
3117
3423
|
|
3118
3424
|
### Example
|
3119
3425
|
~~~ruby
|
@@ -3170,12 +3476,18 @@ Name | Type | Description | Notes
|
|
3170
3476
|
|
3171
3477
|
## - put_user_station_associatedstation_station_id(user_id, station_id)
|
3172
3478
|
|
3479
|
+
|
3480
|
+
|
3173
3481
|
Set associated station
|
3174
3482
|
|
3175
3483
|
|
3176
3484
|
|
3177
3485
|
Wraps PUT /api/v2/users/{userId}/station/associatedstation/{stationId}
|
3178
3486
|
|
3487
|
+
Requires NO permissions:
|
3488
|
+
|
3489
|
+
|
3490
|
+
|
3179
3491
|
|
3180
3492
|
### Example
|
3181
3493
|
~~~ruby
|
@@ -3231,12 +3543,18 @@ nil (empty response body)
|
|
3231
3543
|
|
3232
3544
|
## - put_user_station_defaultstation_station_id(user_id, station_id)
|
3233
3545
|
|
3546
|
+
|
3547
|
+
|
3234
3548
|
Set default station
|
3235
3549
|
|
3236
3550
|
|
3237
3551
|
|
3238
3552
|
Wraps PUT /api/v2/users/{userId}/station/defaultstation/{stationId}
|
3239
3553
|
|
3554
|
+
Requires ANY permissions:
|
3555
|
+
|
3556
|
+
* telephony:plugin:all* telephony:phone:assign
|
3557
|
+
|
3240
3558
|
|
3241
3559
|
### Example
|
3242
3560
|
~~~ruby
|