purecloudplatformclientv2 75.1.0 → 79.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/ActivityCode.md +1 -1
- data/docs/AnalyticsApi.md +66 -2
- data/docs/AnalyticsConversationAsyncQueryResponse.md +1 -1
- data/docs/AnalyticsConversationQueryResponse.md +1 -1
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/AnalyticsParticipantWithoutAttributes.md +1 -0
- data/docs/ArchitectApi.md +345 -0
- data/docs/AuditApi.md +3 -1
- data/docs/AuditLogMessage.md +1 -1
- data/docs/AuthorizationApi.md +154 -9
- data/docs/AvailableTopic.md +3 -1
- data/docs/BuAgentScheduleActivity.md +18 -0
- data/docs/BuAgentSchedulePublishedScheduleReference.md +16 -0
- data/docs/BuAgentScheduleSearchResponse.md +15 -0
- data/docs/BuAgentScheduleShift.md +18 -0
- data/docs/BuAgentSchedulesSearchResponse.md +15 -0
- data/docs/BuAsyncAgentSchedulesSearchResponse.md +17 -0
- data/docs/BuFullDayTimeOffMarker.md +18 -0
- data/docs/BuScheduleReference.md +15 -0
- data/docs/Call.md +1 -1
- data/docs/CallBasic.md +1 -1
- data/docs/CallMediaParticipant.md +1 -1
- data/docs/CallbackMediaParticipant.md +1 -1
- data/docs/CampaignProgress.md +2 -1
- data/docs/ChatMediaParticipant.md +1 -1
- data/docs/CobrowseMediaParticipant.md +1 -1
- data/docs/ConversationsApi.md +71 -1
- data/docs/CopyAttachmentsRequest.md +14 -0
- data/docs/CreateManagementUnitApiRequest.md +3 -2
- data/docs/CreateManagementUnitSettingsRequest.md +1 -1
- data/docs/CreateWorkPlanShift.md +1 -1
- data/docs/DataTableExportJob.md +22 -0
- data/docs/DataTableImportJob.md +25 -0
- data/docs/DivsPermittedEntityListing.md +23 -0
- data/docs/EmailMediaParticipant.md +1 -1
- data/docs/EntityListing.md +17 -0
- data/docs/ErrorBody.md +2 -2
- data/docs/ErrorInfo.md +14 -0
- data/docs/Evaluation.md +1 -0
- data/docs/EvaluationQuestionGroupScore.md +4 -0
- data/docs/EvaluationScoringSet.md +1 -0
- data/docs/FacebookIntegrationRequest.md +2 -2
- data/docs/GDPRJourneyCustomer.md +2 -2
- data/docs/InboundDomain.md +2 -0
- data/docs/Library.md +4 -3
- data/docs/LicenseApi.md +66 -0
- data/docs/MailFromResult.md +15 -0
- data/docs/ManagementUnit.md +2 -2
- data/docs/ManagementUnitSettingsRequest.md +1 -1
- data/docs/MessageMediaParticipant.md +1 -1
- data/docs/MessagingApi.md +0 -936
- data/docs/MessagingTemplate.md +15 -0
- data/docs/Organization.md +1 -0
- data/docs/QualityApi.md +5 -6
- data/docs/Record.md +15 -0
- data/docs/ReportingExportMetadataJobListing.md +22 -0
- data/docs/ReportingExportMetadataJobResponse.md +22 -0
- data/docs/Response.md +2 -0
- data/docs/RoutingApi.md +385 -0
- data/docs/RoutingSettings.md +13 -0
- data/docs/SCIMApi.md +397 -23
- data/docs/ScimUserExtensions.md +14 -0
- data/docs/ScimUserRole.md +13 -0
- data/docs/ScimUserRoutingLanguage.md +14 -0
- data/docs/ScimUserRoutingSkill.md +14 -0
- data/docs/ScimV2CreateUser.md +2 -1
- data/docs/ScimV2SchemaAttribute.md +24 -0
- data/docs/ScimV2SchemaDefinition.md +17 -0
- data/docs/ScimV2SchemaListResponse.md +17 -0
- data/docs/ScimV2User.md +2 -1
- data/docs/ShortTermForecast.md +2 -2
- data/docs/ShortTermForecastListItemResponse.md +2 -2
- data/docs/ShortTermForecastReference.md +2 -2
- data/docs/TimeOffRequestLookup.md +3 -3
- data/docs/TimeOffRequestResponse.md +3 -3
- data/docs/UserScheduleAdherence.md +1 -1
- data/docs/UsersApi.md +358 -10
- data/docs/ViewFilter.md +4 -10
- data/docs/WeekSchedule.md +1 -1
- data/docs/WeekScheduleListItemResponse.md +1 -1
- data/docs/WeekScheduleReference.md +1 -1
- data/docs/WorkPlanShift.md +1 -1
- data/docs/WorkforceManagementApi.md +40 -41
- data/lib/purecloudplatformclientv2.rb +27 -0
- data/lib/purecloudplatformclientv2/api/analytics_api.rb +73 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +373 -0
- data/lib/purecloudplatformclientv2/api/audit_api.rb +9 -0
- data/lib/purecloudplatformclientv2/api/authorization_api.rb +185 -7
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +84 -0
- data/lib/purecloudplatformclientv2/api/license_api.rb +63 -0
- data/lib/purecloudplatformclientv2/api/messaging_api.rb +0 -949
- data/lib/purecloudplatformclientv2/api/quality_api.rb +8 -6
- data/lib/purecloudplatformclientv2/api/routing_api.rb +378 -0
- data/lib/purecloudplatformclientv2/api/scim_api.rb +366 -26
- data/lib/purecloudplatformclientv2/api/users_api.rb +398 -7
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -3
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/activity_code.rb +30 -30
- data/lib/purecloudplatformclientv2/models/analytics_conversation_async_query_response.rb +15 -15
- data/lib/purecloudplatformclientv2/models/analytics_conversation_query_response.rb +15 -15
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +27 -1
- data/lib/purecloudplatformclientv2/models/analytics_participant_without_attributes.rb +27 -1
- data/lib/purecloudplatformclientv2/models/audit_log_message.rb +5 -5
- data/lib/purecloudplatformclientv2/models/available_topic.rb +57 -4
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_activity.rb +332 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_published_schedule_reference.rb +280 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_search_response.rb +258 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedule_shift.rb +334 -0
- data/lib/purecloudplatformclientv2/models/bu_agent_schedules_search_response.rb +258 -0
- data/lib/purecloudplatformclientv2/models/bu_async_agent_schedules_search_response.rb +320 -0
- data/lib/purecloudplatformclientv2/models/bu_full_day_time_off_marker.rb +332 -0
- data/lib/purecloudplatformclientv2/models/bu_schedule_reference.rb +254 -0
- data/lib/purecloudplatformclientv2/models/call.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_basic.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/callback_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/campaign_progress.rb +28 -2
- data/lib/purecloudplatformclientv2/models/chat_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/copy_attachments_request.rb +240 -0
- data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb +37 -16
- data/lib/purecloudplatformclientv2/models/create_management_unit_settings_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb +1 -1
- data/lib/purecloudplatformclientv2/models/data_table_export_job.rb +455 -0
- data/lib/purecloudplatformclientv2/models/data_table_import_job.rb +547 -0
- data/lib/purecloudplatformclientv2/models/divs_permitted_entity_listing.rb +453 -0
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/entity_listing.rb +303 -0
- data/lib/purecloudplatformclientv2/models/error_body.rb +20 -20
- data/lib/purecloudplatformclientv2/models/error_info.rb +226 -0
- data/lib/purecloudplatformclientv2/models/evaluation.rb +27 -1
- data/lib/purecloudplatformclientv2/models/evaluation_question_group_score.rb +101 -1
- data/lib/purecloudplatformclientv2/models/evaluation_scoring_set.rb +26 -1
- data/lib/purecloudplatformclientv2/models/facebook_integration_request.rb +2 -7
- data/lib/purecloudplatformclientv2/models/flow_aggregate_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/gdpr_journey_customer.rb +2 -12
- data/lib/purecloudplatformclientv2/models/inbound_domain.rb +53 -1
- data/lib/purecloudplatformclientv2/models/library.rb +44 -2
- data/lib/purecloudplatformclientv2/models/mail_from_result.rb +275 -0
- data/lib/purecloudplatformclientv2/models/management_unit.rb +2 -2
- data/lib/purecloudplatformclientv2/models/management_unit_settings_request.rb +1 -1
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1 -1
- data/lib/purecloudplatformclientv2/models/messaging_template.rb +270 -0
- data/lib/purecloudplatformclientv2/models/organization.rb +41 -1
- data/lib/purecloudplatformclientv2/models/record.rb +269 -0
- data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb +2 -2
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/reporting_export_metadata_job_response.rb +459 -0
- data/lib/purecloudplatformclientv2/models/response.rb +67 -1
- data/lib/purecloudplatformclientv2/models/routing_settings.rb +202 -0
- data/lib/purecloudplatformclientv2/models/scim_metadata.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_user_extensions.rb +233 -0
- data/lib/purecloudplatformclientv2/models/scim_user_role.rb +203 -0
- data/lib/purecloudplatformclientv2/models/scim_user_routing_language.rb +234 -0
- data/lib/purecloudplatformclientv2/models/scim_user_routing_skill.rb +234 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_create_user.rb +30 -5
- data/lib/purecloudplatformclientv2/models/scim_v2_group_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_member_reference.rb +2 -2
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_attribute.rb +551 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_definition.rb +309 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_schema_list_response.rb +311 -0
- data/lib/purecloudplatformclientv2/models/scim_v2_user.rb +27 -2
- data/lib/purecloudplatformclientv2/models/segment_detail_query_predicate.rb +2 -2
- data/lib/purecloudplatformclientv2/models/short_term_forecast.rb +30 -35
- data/lib/purecloudplatformclientv2/models/short_term_forecast_list_item_response.rb +30 -35
- data/lib/purecloudplatformclientv2/models/short_term_forecast_reference.rb +22 -27
- data/lib/purecloudplatformclientv2/models/time_off_request_lookup.rb +3 -3
- data/lib/purecloudplatformclientv2/models/time_off_request_response.rb +3 -3
- data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +1 -1
- data/lib/purecloudplatformclientv2/models/view_filter.rb +53 -255
- data/lib/purecloudplatformclientv2/models/week_schedule.rb +21 -21
- data/lib/purecloudplatformclientv2/models/week_schedule_list_item_response.rb +21 -21
- data/lib/purecloudplatformclientv2/models/week_schedule_reference.rb +14 -14
- data/lib/purecloudplatformclientv2/models/work_plan_shift.rb +1 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +56 -2
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: ScimUserExtensions
|
3
|
+
---
|
4
|
+
## PureCloud::ScimUserExtensions
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **routing_skills** | [**Array<ScimUserRoutingSkill>**](ScimUserRoutingSkill.html) | Routing Skills assigned to user. No more than 50 skills may be assigned to a user. | [optional] |
|
11
|
+
| **routing_languages** | [**Array<ScimUserRoutingLanguage>**](ScimUserRoutingLanguage.html) | Routing Languages assigned to user. No more than 50 languages may be assigned to a user. | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
---
|
2
|
+
title: ScimUserRole
|
3
|
+
---
|
4
|
+
## PureCloud::ScimUserRole
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **value** | **String** | Purecloud user role name | [optional] |
|
11
|
+
{: class="table table-striped"}
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: ScimUserRoutingLanguage
|
3
|
+
---
|
4
|
+
## PureCloud::ScimUserRoutingLanguage
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **name** | **String** | Case-sensitive name identifying a language configured in routing languages. | |
|
11
|
+
| **proficiency** | **Float** | Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular language. It is used when a queue is set to \"Best available language\" mode to allow acd interactions to target agents with higher proficiency ratings. | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
---
|
2
|
+
title: ScimUserRoutingSkill
|
3
|
+
---
|
4
|
+
## PureCloud::ScimUserRoutingSkill
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **name** | **String** | Case-sensitive name identifying a skill configured in routing skills. | |
|
11
|
+
| **proficiency** | **Float** | Proficiency is a rating from 0.0 to 5.0 on how competent an agent is for a particular skill. It is used when a queue is set to \"Best available skills\" mode to allow acd interactions to target agents with higher proficiency ratings. | [optional] |
|
12
|
+
{: class="table table-striped"}
|
13
|
+
|
14
|
+
|
data/docs/ScimV2CreateUser.md
CHANGED
@@ -18,8 +18,9 @@ title: ScimV2CreateUser
|
|
18
18
|
| **photos** | [**Array<Photo>**](Photo.html) | The list of the user's photos. | [optional] |
|
19
19
|
| **external_id** | **String** | The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\". | [optional] |
|
20
20
|
| **groups** | [**Array<ScimV2GroupReference>**](ScimV2GroupReference.html) | The list of groups that the user is a member of. | [optional] |
|
21
|
-
| **roles** | **Array<
|
21
|
+
| **roles** | [**Array<ScimUserRole>**](ScimUserRole.html) | The list of roles assigned to the user. | [optional] |
|
22
22
|
| **urnietfparamsscimschemasextensionenterprise2_0_user** | [**ScimV2EnterpriseUser**](ScimV2EnterpriseUser.html) | The URI of the schema for the enterprise user. | [optional] |
|
23
|
+
| **urnietfparamsscimschemasextensiongenesyspurecloud2_0_user** | [**ScimUserExtensions**](ScimUserExtensions.html) | | [optional] |
|
23
24
|
{: class="table table-striped"}
|
24
25
|
|
25
26
|
|
@@ -0,0 +1,24 @@
|
|
1
|
+
---
|
2
|
+
title: ScimV2SchemaAttribute
|
3
|
+
---
|
4
|
+
## PureCloud::ScimV2SchemaAttribute
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **name** | **String** | The attribute's name | [optional] |
|
11
|
+
| **type** | **String** | The attribute's data type. Valid values are \"string\", \"boolean\", \"decimal\", \"integer\", \"dateTime\", \"reference\", and \"complex\". | [optional] |
|
12
|
+
| **sub_attributes** | [**Array<ScimV2SchemaAttribute>**](ScimV2SchemaAttribute.html) | When an attribute is of type \"complex\", \"subAttributes\" defines a set of sub-attributes. \"subAttributes\" has the same schema sub-attributes as \"attributes\" | [optional] |
|
13
|
+
| **multi_valued** | **BOOLEAN** | A Boolean value indicating the attribute's plurality. | [optional] |
|
14
|
+
| **description** | **String** | The attribute's human-readable description. | [optional] |
|
15
|
+
| **required** | **BOOLEAN** | A Boolean value that specifies whether or not the attribute is required. | [optional] |
|
16
|
+
| **canonical_values** | **Array<String>** | A collection of suggested canonical values that MAY be used (e.g., \"work\" and \"home\"). In some cases, service providers MAY choose to ignore unsupported values. OPTIONAL. | [optional] |
|
17
|
+
| **case_exact** | **BOOLEAN** | A Boolean value that specifies whether or not a string attribute is case sensitive. The server SHALL use case sensitivity when evaluating filters. For attributes that are case exact, the server SHALL preserve case for any value submitted. If the attribute is case insensitive, the server MAY alter case for a submitted value. Case sensitivity also impacts how attribute values MAY be compared against filter values (see Section 3.4.2.2 of [RFC7644]) | [optional] |
|
18
|
+
| **mutability** | **String** | A single keyword indicating the circumstances under which the value of the attribute can be (re)defined. Value are readOnly, readWrite, immutable, writeOnly | [optional] |
|
19
|
+
| **returned** | **String** | A single keyword that indicates when an attribute and associated values are returned in response to a GET request, or in response to a PUT, POST, or PATCH request. Valid keywords are as follows: always, never, default, request | [optional] |
|
20
|
+
| **uniqueness** | **String** | A single keyword value that specifies how the service provider enforces uniqueness of attribute values. A server MAY reject an invalid value based on uniqueness by returning HTTP response code 400 (Bad Request). A client MAY enforce uniqueness on the client side to a greater degree than the service provider enforces. For example, a client could make a value unique while the server has uniqueness of \"none\". Valid keywords are as follows: none, server, global | [optional] |
|
21
|
+
| **reference_types** | **Array<String>** | A multi-valued array of JSON strings that indicate the SCIM resource types that may be referenced. Values include User, Group, external and uri. | [optional] |
|
22
|
+
{: class="table table-striped"}
|
23
|
+
|
24
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: ScimV2SchemaDefinition
|
3
|
+
---
|
4
|
+
## PureCloud::ScimV2SchemaDefinition
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **id** | **String** | The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"Mutability\" is set to \"readOnly\". \"Returned\" is set to \"always\". | [optional] |
|
11
|
+
| **name** | **String** | Schema name. | [optional] |
|
12
|
+
| **description** | **String** | Schema description. | [optional] |
|
13
|
+
| **attributes** | [**Array<ScimV2SchemaAttribute>**](ScimV2SchemaAttribute.html) | A complex type that defines service provider attributes and their qualities. | [optional] |
|
14
|
+
| **meta** | [**ScimMetadata**](ScimMetadata.html) | The metadata of the SCIM resource. | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
---
|
2
|
+
title: ScimV2SchemaListResponse
|
3
|
+
---
|
4
|
+
## PureCloud::ScimV2SchemaListResponse
|
5
|
+
|
6
|
+
## Properties
|
7
|
+
|
8
|
+
|Name | Type | Description | Notes|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
10
|
+
| **total_results** | **Integer** | The total number of results. | [optional] |
|
11
|
+
| **start_index** | **Integer** | The 1-based index of the first result returned by this request. Add this to \"itemsPerPage\" when requesting the next page of results. | [optional] |
|
12
|
+
| **items_per_page** | **Integer** | The number of resources returned per page. | [optional] |
|
13
|
+
| **resources** | [**Array<ScimV2SchemaDefinition>**](ScimV2SchemaDefinition.html) | Resources | [optional] |
|
14
|
+
| **schemas** | **Array<String>** | The list of supported schemas. | [optional] |
|
15
|
+
{: class="table table-striped"}
|
16
|
+
|
17
|
+
|
data/docs/ScimV2User.md
CHANGED
@@ -19,8 +19,9 @@ title: ScimV2User
|
|
19
19
|
| **photos** | [**Array<Photo>**](Photo.html) | The list of the user's photos. | [optional] |
|
20
20
|
| **external_id** | **String** | The external ID of the user. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\". | [optional] |
|
21
21
|
| **groups** | [**Array<ScimV2GroupReference>**](ScimV2GroupReference.html) | The list of groups that the user is a member of. | [optional] |
|
22
|
-
| **roles** | **Array<
|
22
|
+
| **roles** | [**Array<ScimUserRole>**](ScimUserRole.html) | The list of roles assigned to the user. | [optional] |
|
23
23
|
| **urnietfparamsscimschemasextensionenterprise2_0_user** | [**ScimV2EnterpriseUser**](ScimV2EnterpriseUser.html) | The URI of the schema for the enterprise user. | [optional] |
|
24
|
+
| **urnietfparamsscimschemasextensiongenesyspurecloud2_0_user** | [**ScimUserExtensions**](ScimUserExtensions.html) | | [optional] |
|
24
25
|
| **meta** | [**ScimMetadata**](ScimMetadata.html) | The metadata of the SCIM resource. | [optional] |
|
25
26
|
{: class="table table-striped"}
|
26
27
|
|
data/docs/ShortTermForecast.md
CHANGED
@@ -7,7 +7,8 @@ title: ShortTermForecast
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **id** | **String** | The
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
11
12
|
| **week_date** | **String** | The weekDate of the short term forecast in yyyy-MM-dd format | |
|
12
13
|
| **description** | **String** | The description of the short term forecast | [optional] |
|
13
14
|
| **creation_method** | **String** | The method used to create this forecast | [optional] |
|
@@ -16,7 +17,6 @@ title: ShortTermForecast
|
|
16
17
|
| **reference_start_date** | **DateTime** | ISO-8601 date that serves as the reference date for interval-based modifications | [optional] |
|
17
18
|
| **modifications** | [**ListWrapperWfmForecastModification**](ListWrapperWfmForecastModification.html) | The modifications that have been applied to this forecast | [optional] |
|
18
19
|
| **generation_results** | [**ForecastGenerationResult**](ForecastGenerationResult.html) | Forecast generation results, if applicable | [optional] |
|
19
|
-
| **self_uri** | **String** | The URI for this object | [optional] |
|
20
20
|
{: class="table table-striped"}
|
21
21
|
|
22
22
|
|
@@ -7,12 +7,12 @@ title: ShortTermForecastListItemResponse
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **id** | **String** | The
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
11
12
|
| **week_date** | **String** | The weekDate of the short term forecast in yyyy-MM-dd format | |
|
12
13
|
| **description** | **String** | The description of the short term forecast | [optional] |
|
13
14
|
| **creation_method** | **String** | The method used to create this forecast | [optional] |
|
14
15
|
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Metadata for this forecast | |
|
15
|
-
| **self_uri** | **String** | The URI for this object | [optional] |
|
16
16
|
{: class="table table-striped"}
|
17
17
|
|
18
18
|
|
@@ -7,10 +7,10 @@ title: ShortTermForecastReference
|
|
7
7
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
|
-
| **id** | **String** | The
|
10
|
+
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
+
| **self_uri** | **String** | The URI for this object | [optional] |
|
11
12
|
| **week_date** | **String** | The weekDate of the short term forecast in yyyy-MM-dd format | |
|
12
13
|
| **description** | **String** | The description of the short term forecast | [optional] |
|
13
|
-
| **self_uri** | **String** | The URI for this object | [optional] |
|
14
14
|
{: class="table table-striped"}
|
15
15
|
|
16
16
|
|
@@ -8,7 +8,7 @@ title: TimeOffRequestLookup
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The id of the time off request | |
|
11
|
-
| **user** | [**
|
11
|
+
| **user** | [**UserReference**](UserReference.html) | The user that the time off request belongs to | |
|
12
12
|
| **is_full_day_request** | **BOOLEAN** | Whether this is a full day request (false means partial day) | [optional] |
|
13
13
|
| **marked_as_read** | **BOOLEAN** | Whether this request has been marked as read by the agent | [optional] |
|
14
14
|
| **activity_code_id** | **String** | The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category | [optional] |
|
@@ -17,9 +17,9 @@ title: TimeOffRequestLookup
|
|
17
17
|
| **full_day_management_unit_dates** | **Array<String>** | A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true | [optional] |
|
18
18
|
| **daily_duration_minutes** | **Integer** | The daily duration of this time off request in minutes | [optional] |
|
19
19
|
| **notes** | **String** | Notes about the time off request | [optional] |
|
20
|
-
| **submitted_by** | [**
|
20
|
+
| **submitted_by** | [**UserReference**](UserReference.html) | The user who submitted this time off request | [optional] |
|
21
21
|
| **submitted_date** | **DateTime** | The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
22
|
-
| **reviewed_by** | [**
|
22
|
+
| **reviewed_by** | [**UserReference**](UserReference.html) | The user who reviewed this time off request | [optional] |
|
23
23
|
| **reviewed_date** | **DateTime** | The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
24
24
|
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | The version metadata of the time off request | [optional] |
|
25
25
|
| **self_uri** | **String** | The URI for this object | [optional] |
|
@@ -8,7 +8,7 @@ title: TimeOffRequestResponse
|
|
8
8
|
|Name | Type | Description | Notes|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
|
-
| **user** | [**
|
11
|
+
| **user** | [**UserReference**](UserReference.html) | The user associated with this time off request | [optional] |
|
12
12
|
| **is_full_day_request** | **BOOLEAN** | Whether this is a full day request (false means partial day) | [optional] |
|
13
13
|
| **marked_as_read** | **BOOLEAN** | Whether this request has been marked as read by the agent | [optional] |
|
14
14
|
| **activity_code_id** | **String** | The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category | [optional] |
|
@@ -17,9 +17,9 @@ title: TimeOffRequestResponse
|
|
17
17
|
| **full_day_management_unit_dates** | **Array<String>** | A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. Will be not empty if isFullDayRequest == true | [optional] |
|
18
18
|
| **daily_duration_minutes** | **Integer** | The daily duration of this time off request in minutes | [optional] |
|
19
19
|
| **notes** | **String** | Notes about the time off request | [optional] |
|
20
|
-
| **submitted_by** | [**
|
20
|
+
| **submitted_by** | [**UserReference**](UserReference.html) | The user who submitted this time off request | [optional] |
|
21
21
|
| **submitted_date** | **DateTime** | The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
22
|
-
| **reviewed_by** | [**
|
22
|
+
| **reviewed_by** | [**UserReference**](UserReference.html) | The user who reviewed this time off request | [optional] |
|
23
23
|
| **reviewed_date** | **DateTime** | The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
24
24
|
| **modified_by** | [**UserReference**](UserReference.html) | The user who last modified this TimeOffRequestResponse | [optional] |
|
25
25
|
| **modified_date** | **DateTime** | The timestamp when this request was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
|
@@ -9,7 +9,7 @@ title: UserScheduleAdherence
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
10
10
|
| **id** | **String** | The globally unique identifier for the object. | [optional] |
|
11
11
|
| **name** | **String** | | [optional] |
|
12
|
-
| **user** | [**
|
12
|
+
| **user** | [**UserReference**](UserReference.html) | The user for whom this status applies | [optional] |
|
13
13
|
| **management_unit** | [**ManagementUnit**](ManagementUnit.html) | The management unit to which this user belongs | [optional] |
|
14
14
|
| **scheduled_activity_category** | **String** | Activity for which the user is scheduled | [optional] |
|
15
15
|
| **system_presence** | **String** | Actual underlying system presence value | [optional] |
|
data/docs/UsersApi.md
CHANGED
@@ -10,6 +10,7 @@ Method | Description
|
|
10
10
|
------------- | ------------- | -------------
|
11
11
|
[**delete_analytics_users_details_job**](UsersApi.html#delete_analytics_users_details_job) | Delete/cancel an async request
|
12
12
|
[**delete_authorization_subject_division_role**](UsersApi.html#delete_authorization_subject_division_role) | Delete a grant of a role in a division
|
13
|
+
[**delete_routing_user_utilization**](UsersApi.html#delete_routing_user_utilization) | Delete the user's max utilization settings and revert to the organization-wide default.
|
13
14
|
[**delete_user**](UsersApi.html#delete_user) | Delete user
|
14
15
|
[**delete_user_roles**](UsersApi.html#delete_user_roles) | Removes all the roles from the user.
|
15
16
|
[**delete_user_routinglanguage**](UsersApi.html#delete_user_routinglanguage) | Remove routing language from user
|
@@ -18,12 +19,15 @@ Method | Description
|
|
18
19
|
[**delete_user_station_defaultstation**](UsersApi.html#delete_user_station_defaultstation) | Clear default station
|
19
20
|
[**get_analytics_users_details_job**](UsersApi.html#get_analytics_users_details_job) | Get status for async query for user details
|
20
21
|
[**get_analytics_users_details_job_results**](UsersApi.html#get_analytics_users_details_job_results) | Fetch a page of results for an async query
|
21
|
-
[**get_authorization_divisionspermitted_me**](UsersApi.html#get_authorization_divisionspermitted_me) | Returns
|
22
|
-
[**
|
22
|
+
[**get_authorization_divisionspermitted_me**](UsersApi.html#get_authorization_divisionspermitted_me) | Returns which divisions the current user has the given permission in.
|
23
|
+
[**get_authorization_divisionspermitted_paged_me**](UsersApi.html#get_authorization_divisionspermitted_paged_me) | Returns which divisions the current user has the given permission in.
|
24
|
+
[**get_authorization_divisionspermitted_paged_subject_id**](UsersApi.html#get_authorization_divisionspermitted_paged_subject_id) | Returns which divisions the specified user has the given permission in.
|
25
|
+
[**get_authorization_divisionspermitted_subject_id**](UsersApi.html#get_authorization_divisionspermitted_subject_id) | Returns which divisions the specified user has the given permission in.
|
23
26
|
[**get_authorization_subject**](UsersApi.html#get_authorization_subject) | Returns a listing of roles and permissions for a user.
|
24
27
|
[**get_authorization_subjects_me**](UsersApi.html#get_authorization_subjects_me) | Returns a listing of roles and permissions for the currently authenticated user.
|
25
28
|
[**get_fieldconfig**](UsersApi.html#get_fieldconfig) | Fetch field config for an entity type
|
26
29
|
[**get_profiles_users**](UsersApi.html#get_profiles_users) | Get a user profile listing
|
30
|
+
[**get_routing_user_utilization**](UsersApi.html#get_routing_user_utilization) | Get the user's max utilization settings. If not configured, the organization-wide default is returned.
|
27
31
|
[**get_user**](UsersApi.html#get_user) | Get user.
|
28
32
|
[**get_user_adjacents**](UsersApi.html#get_user_adjacents) | Get adjacents
|
29
33
|
[**get_user_callforwarding**](UsersApi.html#get_user_callforwarding) | Get a user's CallForwarding
|
@@ -67,6 +71,7 @@ Method | Description
|
|
67
71
|
[**post_users**](UsersApi.html#post_users) | Create user
|
68
72
|
[**post_users_me_password**](UsersApi.html#post_users_me_password) | Change your password
|
69
73
|
[**post_users_search**](UsersApi.html#post_users_search) | Search users
|
74
|
+
[**put_routing_user_utilization**](UsersApi.html#put_routing_user_utilization) | Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
70
75
|
[**put_user_callforwarding**](UsersApi.html#put_user_callforwarding) | Update a user's CallForwarding
|
71
76
|
[**put_user_outofoffice**](UsersApi.html#put_user_outofoffice) | Update an OutOfOffice
|
72
77
|
[**put_user_profileskills**](UsersApi.html#put_user_profileskills) | Update profile skills for a user
|
@@ -212,6 +217,70 @@ nil (empty response body)
|
|
212
217
|
|
213
218
|
|
214
219
|
|
220
|
+
<a name="delete_routing_user_utilization"></a>
|
221
|
+
|
222
|
+
## delete_routing_user_utilization(user_id)
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
Delete the user's max utilization settings and revert to the organization-wide default.
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
Wraps DELETE /api/v2/routing/users/{userId}/utilization
|
231
|
+
|
232
|
+
Requires ANY permissions:
|
233
|
+
|
234
|
+
* routing:utilization:manage
|
235
|
+
|
236
|
+
|
237
|
+
### Example
|
238
|
+
```{"language":"ruby"}
|
239
|
+
# load the gem
|
240
|
+
require 'purecloudplatformclientv2'
|
241
|
+
# setup authorization
|
242
|
+
@secret = ENV['PURECLOUD_SECRET']
|
243
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
244
|
+
environment = "mypurecloud.com"
|
245
|
+
|
246
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
247
|
+
|
248
|
+
PureCloud.configure do |config|
|
249
|
+
config.access_token = @authToken
|
250
|
+
end
|
251
|
+
|
252
|
+
api_instance = PureCloud::UsersApi.new
|
253
|
+
|
254
|
+
user_id = "user_id_example" # String | User ID
|
255
|
+
|
256
|
+
|
257
|
+
begin
|
258
|
+
#Delete the user's max utilization settings and revert to the organization-wide default.
|
259
|
+
api_instance.delete_routing_user_utilization(user_id)
|
260
|
+
rescue PureCloud::ApiError => e
|
261
|
+
puts "Exception when calling UsersApi->delete_routing_user_utilization: #{e}"
|
262
|
+
end
|
263
|
+
```
|
264
|
+
|
265
|
+
### Parameters
|
266
|
+
|
267
|
+
Name | Type | Description | Notes
|
268
|
+
------------- | ------------- | ------------- | -------------
|
269
|
+
**user_id** | **String**| User ID | |
|
270
|
+
{: class="table table-striped"}
|
271
|
+
|
272
|
+
|
273
|
+
### Return type
|
274
|
+
|
275
|
+
nil (empty response body)
|
276
|
+
|
277
|
+
### HTTP request headers
|
278
|
+
|
279
|
+
- **Content-Type**: application/json
|
280
|
+
- **Accept**: application/json
|
281
|
+
|
282
|
+
|
283
|
+
|
215
284
|
<a name="delete_user"></a>
|
216
285
|
|
217
286
|
## [**Empty**](Empty.html) delete_user(user_id)
|
@@ -706,7 +775,8 @@ api_instance = PureCloud::UsersApi.new
|
|
706
775
|
job_id = "job_id_example" # String | jobId
|
707
776
|
|
708
777
|
opts = {
|
709
|
-
cursor: "cursor_example" # String | Indicates where to resume query results (not required for first page)
|
778
|
+
cursor: "cursor_example", # String | Indicates where to resume query results (not required for first page)
|
779
|
+
page_size: 56 # Integer | The desired maximum number of results
|
710
780
|
}
|
711
781
|
|
712
782
|
begin
|
@@ -724,6 +794,7 @@ Name | Type | Description | Notes
|
|
724
794
|
------------- | ------------- | ------------- | -------------
|
725
795
|
**job_id** | **String**| jobId | |
|
726
796
|
**cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional] |
|
797
|
+
**page_size** | **Integer**| The desired maximum number of results | [optional] |
|
727
798
|
{: class="table table-striped"}
|
728
799
|
|
729
800
|
|
@@ -742,11 +813,11 @@ Name | Type | Description | Notes
|
|
742
813
|
|
743
814
|
## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
|
744
815
|
|
816
|
+
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
745
817
|
|
818
|
+
Returns which divisions the current user has the given permission in.
|
746
819
|
|
747
|
-
|
748
|
-
|
749
|
-
|
820
|
+
This route is deprecated, use authorization/divisionspermitted/paged/me instead.
|
750
821
|
|
751
822
|
Wraps GET /api/v2/authorization/divisionspermitted/me
|
752
823
|
|
@@ -778,7 +849,7 @@ opts = {
|
|
778
849
|
}
|
779
850
|
|
780
851
|
begin
|
781
|
-
#Returns
|
852
|
+
#Returns which divisions the current user has the given permission in.
|
782
853
|
result = api_instance.get_authorization_divisionspermitted_me(permission, opts)
|
783
854
|
p result
|
784
855
|
rescue PureCloud::ApiError => e
|
@@ -806,15 +877,158 @@ Name | Type | Description | Notes
|
|
806
877
|
|
807
878
|
|
808
879
|
|
880
|
+
<a name="get_authorization_divisionspermitted_paged_me"></a>
|
881
|
+
|
882
|
+
## [**DivsPermittedEntityListing**](DivsPermittedEntityListing.html) get_authorization_divisionspermitted_paged_me(permission, opts)
|
883
|
+
|
884
|
+
|
885
|
+
|
886
|
+
Returns which divisions the current user has the given permission in.
|
887
|
+
|
888
|
+
|
889
|
+
|
890
|
+
Wraps GET /api/v2/authorization/divisionspermitted/paged/me
|
891
|
+
|
892
|
+
Requires NO permissions:
|
893
|
+
|
894
|
+
|
895
|
+
|
896
|
+
### Example
|
897
|
+
```{"language":"ruby"}
|
898
|
+
# load the gem
|
899
|
+
require 'purecloudplatformclientv2'
|
900
|
+
# setup authorization
|
901
|
+
@secret = ENV['PURECLOUD_SECRET']
|
902
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
903
|
+
environment = "mypurecloud.com"
|
904
|
+
|
905
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
906
|
+
|
907
|
+
PureCloud.configure do |config|
|
908
|
+
config.access_token = @authToken
|
909
|
+
end
|
910
|
+
|
911
|
+
api_instance = PureCloud::UsersApi.new
|
912
|
+
|
913
|
+
permission = "permission_example" # String | The permission string, including the object to access, e.g. routing:queue:view
|
914
|
+
|
915
|
+
opts = {
|
916
|
+
page_number: 1, # Integer | Page number
|
917
|
+
page_size: 25 # Integer | Page size
|
918
|
+
}
|
919
|
+
|
920
|
+
begin
|
921
|
+
#Returns which divisions the current user has the given permission in.
|
922
|
+
result = api_instance.get_authorization_divisionspermitted_paged_me(permission, opts)
|
923
|
+
p result
|
924
|
+
rescue PureCloud::ApiError => e
|
925
|
+
puts "Exception when calling UsersApi->get_authorization_divisionspermitted_paged_me: #{e}"
|
926
|
+
end
|
927
|
+
```
|
928
|
+
|
929
|
+
### Parameters
|
930
|
+
|
931
|
+
Name | Type | Description | Notes
|
932
|
+
------------- | ------------- | ------------- | -------------
|
933
|
+
**permission** | **String**| The permission string, including the object to access, e.g. routing:queue:view | |
|
934
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
935
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
936
|
+
{: class="table table-striped"}
|
937
|
+
|
938
|
+
|
939
|
+
### Return type
|
940
|
+
|
941
|
+
[**DivsPermittedEntityListing**](DivsPermittedEntityListing.html)
|
942
|
+
|
943
|
+
### HTTP request headers
|
944
|
+
|
945
|
+
- **Content-Type**: application/json
|
946
|
+
- **Accept**: application/json
|
947
|
+
|
948
|
+
|
949
|
+
|
950
|
+
<a name="get_authorization_divisionspermitted_paged_subject_id"></a>
|
951
|
+
|
952
|
+
## [**DivsPermittedEntityListing**](DivsPermittedEntityListing.html) get_authorization_divisionspermitted_paged_subject_id(subject_id, permission, opts)
|
953
|
+
|
954
|
+
|
955
|
+
|
956
|
+
Returns which divisions the specified user has the given permission in.
|
957
|
+
|
958
|
+
|
959
|
+
|
960
|
+
Wraps GET /api/v2/authorization/divisionspermitted/paged/{subjectId}
|
961
|
+
|
962
|
+
Requires NO permissions:
|
963
|
+
|
964
|
+
|
965
|
+
|
966
|
+
### Example
|
967
|
+
```{"language":"ruby"}
|
968
|
+
# load the gem
|
969
|
+
require 'purecloudplatformclientv2'
|
970
|
+
# setup authorization
|
971
|
+
@secret = ENV['PURECLOUD_SECRET']
|
972
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
973
|
+
environment = "mypurecloud.com"
|
974
|
+
|
975
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
976
|
+
|
977
|
+
PureCloud.configure do |config|
|
978
|
+
config.access_token = @authToken
|
979
|
+
end
|
980
|
+
|
981
|
+
api_instance = PureCloud::UsersApi.new
|
982
|
+
|
983
|
+
subject_id = "subject_id_example" # String | Subject ID (user or group)
|
984
|
+
|
985
|
+
permission = "permission_example" # String | The permission string, including the object to access, e.g. routing:queue:view
|
986
|
+
|
987
|
+
opts = {
|
988
|
+
page_number: 1, # Integer | Page number
|
989
|
+
page_size: 25 # Integer | Page size
|
990
|
+
}
|
991
|
+
|
992
|
+
begin
|
993
|
+
#Returns which divisions the specified user has the given permission in.
|
994
|
+
result = api_instance.get_authorization_divisionspermitted_paged_subject_id(subject_id, permission, opts)
|
995
|
+
p result
|
996
|
+
rescue PureCloud::ApiError => e
|
997
|
+
puts "Exception when calling UsersApi->get_authorization_divisionspermitted_paged_subject_id: #{e}"
|
998
|
+
end
|
999
|
+
```
|
1000
|
+
|
1001
|
+
### Parameters
|
1002
|
+
|
1003
|
+
Name | Type | Description | Notes
|
1004
|
+
------------- | ------------- | ------------- | -------------
|
1005
|
+
**subject_id** | **String**| Subject ID (user or group) | |
|
1006
|
+
**permission** | **String**| The permission string, including the object to access, e.g. routing:queue:view | |
|
1007
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
1008
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
1009
|
+
{: class="table table-striped"}
|
1010
|
+
|
1011
|
+
|
1012
|
+
### Return type
|
1013
|
+
|
1014
|
+
[**DivsPermittedEntityListing**](DivsPermittedEntityListing.html)
|
1015
|
+
|
1016
|
+
### HTTP request headers
|
1017
|
+
|
1018
|
+
- **Content-Type**: application/json
|
1019
|
+
- **Accept**: application/json
|
1020
|
+
|
1021
|
+
|
1022
|
+
|
809
1023
|
<a name="get_authorization_divisionspermitted_subject_id"></a>
|
810
1024
|
|
811
1025
|
## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
|
812
1026
|
|
813
1027
|
<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
|
814
1028
|
|
815
|
-
Returns
|
816
|
-
|
1029
|
+
Returns which divisions the specified user has the given permission in.
|
817
1030
|
|
1031
|
+
This route is deprecated, use authorization/divisionspermitted/paged/{subjectId} instead.
|
818
1032
|
|
819
1033
|
Wraps GET /api/v2/authorization/divisionspermitted/{subjectId}
|
820
1034
|
|
@@ -848,7 +1062,7 @@ opts = {
|
|
848
1062
|
}
|
849
1063
|
|
850
1064
|
begin
|
851
|
-
#Returns
|
1065
|
+
#Returns which divisions the specified user has the given permission in.
|
852
1066
|
result = api_instance.get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
|
853
1067
|
p result
|
854
1068
|
rescue PureCloud::ApiError => e
|
@@ -1139,6 +1353,72 @@ Name | Type | Description | Notes
|
|
1139
1353
|
|
1140
1354
|
|
1141
1355
|
|
1356
|
+
<a name="get_routing_user_utilization"></a>
|
1357
|
+
|
1358
|
+
## [**Utilization**](Utilization.html) get_routing_user_utilization(user_id)
|
1359
|
+
|
1360
|
+
|
1361
|
+
|
1362
|
+
Get the user's max utilization settings. If not configured, the organization-wide default is returned.
|
1363
|
+
|
1364
|
+
|
1365
|
+
|
1366
|
+
Wraps GET /api/v2/routing/users/{userId}/utilization
|
1367
|
+
|
1368
|
+
Requires ANY permissions:
|
1369
|
+
|
1370
|
+
* routing:utilization:manage
|
1371
|
+
* routing:utilization:view
|
1372
|
+
|
1373
|
+
|
1374
|
+
### Example
|
1375
|
+
```{"language":"ruby"}
|
1376
|
+
# load the gem
|
1377
|
+
require 'purecloudplatformclientv2'
|
1378
|
+
# setup authorization
|
1379
|
+
@secret = ENV['PURECLOUD_SECRET']
|
1380
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
1381
|
+
environment = "mypurecloud.com"
|
1382
|
+
|
1383
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
1384
|
+
|
1385
|
+
PureCloud.configure do |config|
|
1386
|
+
config.access_token = @authToken
|
1387
|
+
end
|
1388
|
+
|
1389
|
+
api_instance = PureCloud::UsersApi.new
|
1390
|
+
|
1391
|
+
user_id = "user_id_example" # String | User ID
|
1392
|
+
|
1393
|
+
|
1394
|
+
begin
|
1395
|
+
#Get the user's max utilization settings. If not configured, the organization-wide default is returned.
|
1396
|
+
result = api_instance.get_routing_user_utilization(user_id)
|
1397
|
+
p result
|
1398
|
+
rescue PureCloud::ApiError => e
|
1399
|
+
puts "Exception when calling UsersApi->get_routing_user_utilization: #{e}"
|
1400
|
+
end
|
1401
|
+
```
|
1402
|
+
|
1403
|
+
### Parameters
|
1404
|
+
|
1405
|
+
Name | Type | Description | Notes
|
1406
|
+
------------- | ------------- | ------------- | -------------
|
1407
|
+
**user_id** | **String**| User ID | |
|
1408
|
+
{: class="table table-striped"}
|
1409
|
+
|
1410
|
+
|
1411
|
+
### Return type
|
1412
|
+
|
1413
|
+
[**Utilization**](Utilization.html)
|
1414
|
+
|
1415
|
+
### HTTP request headers
|
1416
|
+
|
1417
|
+
- **Content-Type**: application/json
|
1418
|
+
- **Accept**: application/json
|
1419
|
+
|
1420
|
+
|
1421
|
+
|
1142
1422
|
<a name="get_user"></a>
|
1143
1423
|
|
1144
1424
|
## [**User**](User.html) get_user(user_id, opts)
|
@@ -4068,6 +4348,74 @@ Name | Type | Description | Notes
|
|
4068
4348
|
|
4069
4349
|
|
4070
4350
|
|
4351
|
+
<a name="put_routing_user_utilization"></a>
|
4352
|
+
|
4353
|
+
## [**Utilization**](Utilization.html) put_routing_user_utilization(user_id, body)
|
4354
|
+
|
4355
|
+
|
4356
|
+
|
4357
|
+
Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
4358
|
+
|
4359
|
+
|
4360
|
+
|
4361
|
+
Wraps PUT /api/v2/routing/users/{userId}/utilization
|
4362
|
+
|
4363
|
+
Requires ANY permissions:
|
4364
|
+
|
4365
|
+
* routing:utilization:manage
|
4366
|
+
|
4367
|
+
|
4368
|
+
### Example
|
4369
|
+
```{"language":"ruby"}
|
4370
|
+
# load the gem
|
4371
|
+
require 'purecloudplatformclientv2'
|
4372
|
+
# setup authorization
|
4373
|
+
@secret = ENV['PURECLOUD_SECRET']
|
4374
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
4375
|
+
environment = "mypurecloud.com"
|
4376
|
+
|
4377
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
4378
|
+
|
4379
|
+
PureCloud.configure do |config|
|
4380
|
+
config.access_token = @authToken
|
4381
|
+
end
|
4382
|
+
|
4383
|
+
api_instance = PureCloud::UsersApi.new
|
4384
|
+
|
4385
|
+
user_id = "user_id_example" # String | User ID
|
4386
|
+
|
4387
|
+
body = PureCloud::Utilization.new # Utilization | utilization
|
4388
|
+
|
4389
|
+
|
4390
|
+
begin
|
4391
|
+
#Update the user's max utilization settings. Include only those media types requiring custom configuration.
|
4392
|
+
result = api_instance.put_routing_user_utilization(user_id, body)
|
4393
|
+
p result
|
4394
|
+
rescue PureCloud::ApiError => e
|
4395
|
+
puts "Exception when calling UsersApi->put_routing_user_utilization: #{e}"
|
4396
|
+
end
|
4397
|
+
```
|
4398
|
+
|
4399
|
+
### Parameters
|
4400
|
+
|
4401
|
+
Name | Type | Description | Notes
|
4402
|
+
------------- | ------------- | ------------- | -------------
|
4403
|
+
**user_id** | **String**| User ID | |
|
4404
|
+
**body** | [**Utilization**](Utilization.html)| utilization | |
|
4405
|
+
{: class="table table-striped"}
|
4406
|
+
|
4407
|
+
|
4408
|
+
### Return type
|
4409
|
+
|
4410
|
+
[**Utilization**](Utilization.html)
|
4411
|
+
|
4412
|
+
### HTTP request headers
|
4413
|
+
|
4414
|
+
- **Content-Type**: application/json
|
4415
|
+
- **Accept**: application/json
|
4416
|
+
|
4417
|
+
|
4418
|
+
|
4071
4419
|
<a name="put_user_callforwarding"></a>
|
4072
4420
|
|
4073
4421
|
## [**CallForwarding**](CallForwarding.html) put_user_callforwarding(user_id, body)
|