purecloudplatformclientv2 36.1.0 → 37.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4324d4d420da278d411be6d1be5725bb8e848b8
-  data.tar.gz: d9e7e561751329187659da739020e78fcfbaa300
+  metadata.gz: 95c943e013ef3a19a62f8be6f2eacadc43bbb14f
+  data.tar.gz: 6d232c3a49b1854e1799268e335145190e86300c
 SHA512:
-  metadata.gz: c637c3df2a9e0ab537480e3383cb8188d094defe1fc693cab0be5039fb164f4b01da093b1d629291c4e528347994071114475b097990a88f00073b23fade23f7
-  data.tar.gz: b297deab4a105bd0a9a7719b5ea9861d089d692b7c8e2b1ac41a30076d50cf5f3384d6286dc3a6c6d09d28621c536da7c71b7ee5c7ae748868b278a3e23fba45
+  metadata.gz: 11e0824d7f466956707c95dd9eccd4d32358a5aa5b26cead7ba3bddcd1521ee50a14ac962500d5b882687a909139a3ff3f460e5b221bb8d48a71afaf6b7afcaf
+  data.tar.gz: 5070e45769a0d3202677393d3d51757f271c7c8d239128f75b07808684ddb34e64b55c3d1a07f42e9eff7e15ae20a87ca85da441a75a558e91a3fcdbfed517b7

data/README.md

@@ -1,7 +1,7 @@
 ---
 title: PureCloud Ruby Gem
 ---
-![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=36.1.0)
+![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=37.0.0)
 
 Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
 
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
 ### from rubygems.org
 
 ~~~ ruby
-gem install 'purecloudplatformclientv2', '~> 36.1.0'
+gem install 'purecloudplatformclientv2', '~> 37.0.0'
 ~~~
 
 ### Install from Git

data/docs/AgentTimeOffRequestPatch.md

@@ -0,0 +1,15 @@
+---
+title: AgentTimeOffRequestPatch
+---
+## PureCloud::AgentTimeOffRequestPatch
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **marked_as_read** | **BOOLEAN** | Whether this request has been read by the agent | [optional] |
+| **status** | **String** | The status of this time off request. Can only be canceled if the requested date has not already passed | [optional] |
+| **notes** | **String** | Notes about the time off request. Can only be edited while the request is still pending | [optional] |
+{: class="table table-striped"}
+
+

data/docs/AnalyticsApi.md

@@ -176,7 +176,7 @@ Wraps GET /api/v2/analytics/reporting/exports
 
 Requires ANY permissions: 
 
-* analytics:conversationAggregate:view
+* analytics:dataExport:view
 
 
 ### Example
@@ -1148,7 +1148,7 @@ Wraps POST /api/v2/analytics/reporting/exports
 
 Requires ANY permissions: 
 
-* analytics:conversationAggregate:view
+* analytics:dataExport:add
 
 
 ### Example

data/docs/AsgInfoResponse.md

@@ -7,9 +7,9 @@ title: AsgInfoResponse
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **id** | **String** | The full id of the asg <orgId>-<siteId>-ASG-<asgVersion> | [optional] |
 | **site** | [**Site**](Site.html) | The site that the asg belongs to. | [optional] |
-| **ami** | **String** | The ami ami of the asg. | [optional] |
+| **ami** | **String** | The version of the asg, ex '003' | [optional] |
 | **edge_version** | **String** | The software ami of the edges in the asg. | [optional] |
 | **instance_info** | [**Array<InstanceInfo>**](InstanceInfo.html) | List of instances and their information that live in the ASG. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |

data/docs/AsyncWeekScheduleResponse.md

@@ -0,0 +1,16 @@
+---
+title: AsyncWeekScheduleResponse
+---
+## PureCloud::AsyncWeekScheduleResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **status** | **String** | The status of the request | [optional] |
+| **result** | [**WeekSchedule**](WeekSchedule.html) | Week schedule result. The value will be null if the data is sent through notification or if response is large. | [optional] |
+| **operation_id** | **String** | The operation id to watch for on the notification topic if status == Processing | [optional] |
+| **download_url** | **String** | The url to fetch the result for large responses. The value will be null if result contains the data | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CallMediaPolicyConditions.md

@@ -11,6 +11,7 @@ title: CallMediaPolicyConditions
 | **date_ranges** | **Array<String>** |  | [optional] |
 | **for_queues** | [**Array<Queue>**](Queue.html) |  | [optional] |
 | **wrapup_codes** | [**Array<WrapupCode>**](WrapupCode.html) |  | [optional] |
+| **languages** | [**Array<Language>**](Language.html) |  | [optional] |
 | **time_allowed** | [**TimeAllowed**](TimeAllowed.html) |  | [optional] |
 | **directions** | **Array<String>** |  | [optional] |
 | **duration** | [**DurationCondition**](DurationCondition.html) |  | [optional] |

data/docs/CampaignNotification.md

@@ -38,6 +38,7 @@ title: CampaignNotification
 | **call_analysis_language** | **String** |  | [optional] |
 | **priority** | **Integer** |  | [optional] |
 | **contact_list_filters** | [**Array<CampaignNotificationUriReference>**](CampaignNotificationUriReference.html) |  | [optional] |
+| **division** | [**CampaignNotificationUriReference**](CampaignNotificationUriReference.html) |  | [optional] |
 | **additional_properties** | **Object** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/ChatMediaPolicyConditions.md

@@ -11,6 +11,7 @@ title: ChatMediaPolicyConditions
 | **date_ranges** | **Array<String>** |  | [optional] |
 | **for_queues** | [**Array<Queue>**](Queue.html) |  | [optional] |
 | **wrapup_codes** | [**Array<WrapupCode>**](WrapupCode.html) |  | [optional] |
+| **languages** | [**Array<Language>**](Language.html) |  | [optional] |
 | **time_allowed** | [**TimeAllowed**](TimeAllowed.html) |  | [optional] |
 | **duration** | [**DurationCondition**](DurationCondition.html) |  | [optional] |
 {: class="table table-striped"}

data/docs/ConversationNotificationMedia.md

@@ -9,6 +9,9 @@ title: ConversationNotificationMedia
 |------------ | ------------- | ------------- | -------------|
 | **url** | **String** |  | [optional] |
 | **media_type** | **String** |  | [optional] |
+| **content_length_bytes** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ConversationNotificationMessageDetails.md

@@ -12,6 +12,7 @@ title: ConversationNotificationMessageDetails
 | **message_status** | **String** |  | [optional] |
 | **message_segment_count** | **Integer** |  | [optional] |
 | **media** | [**Array<ConversationNotificationMedia>**](ConversationNotificationMedia.html) |  | [optional] |
+| **stickers** | [**Array<ConversationNotificationStickers>**](ConversationNotificationStickers.html) |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ConversationNotificationMessageMedia.md

@@ -9,6 +9,9 @@ title: ConversationNotificationMessageMedia
 |------------ | ------------- | ------------- | -------------|
 | **url** | **String** |  | [optional] |
 | **media_type** | **String** |  | [optional] |
+| **content_length_bytes** | **Integer** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ConversationNotificationMessageSticker.md

@@ -0,0 +1,14 @@
+---
+title: ConversationNotificationMessageSticker
+---
+## PureCloud::ConversationNotificationMessageSticker
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **url** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ConversationNotificationMessages.md

@@ -12,6 +12,7 @@ title: ConversationNotificationMessages
 | **message_status** | **String** |  | [optional] |
 | **message_segment_count** | **Integer** |  | [optional] |
 | **media** | [**Array<ConversationNotificationMedia>**](ConversationNotificationMedia.html) |  | [optional] |
+| **stickers** | [**Array<ConversationNotificationStickers>**](ConversationNotificationStickers.html) |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ConversationNotificationStickers.md

@@ -0,0 +1,14 @@
+---
+title: ConversationNotificationStickers
+---
+## PureCloud::ConversationNotificationStickers
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **url** | **String** |  | [optional] |
+| **id** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CopyShortTermForecastRequest.md

@@ -0,0 +1,14 @@
+---
+title: CopyShortTermForecastRequest
+---
+## PureCloud::CopyShortTermForecastRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **week_date** | **String** | The first day of the short term forecast in yyyy-MM-dd format.  Must be the management unit's start day of week | |
+| **description** | **String** | Description for the new forecast | |
+{: class="table table-striped"}
+
+

data/docs/CopyWeekScheduleRequest.md

@@ -0,0 +1,14 @@
+---
+title: CopyWeekScheduleRequest
+---
+## PureCloud::CopyWeekScheduleRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **description** | **String** | Description of the copied week schedule | |
+| **week_date** | **String** | Week in yyyy-MM-dd format to which the schedule is copied | |
+{: class="table table-striped"}
+
+

data/docs/CopyWorkPlan.md

@@ -0,0 +1,13 @@
+---
+title: CopyWorkPlan
+---
+## PureCloud::CopyWorkPlan
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | Name of the copied work plan | |
+{: class="table table-striped"}
+
+

data/docs/CreateAdminTimeOffRequest.md

@@ -0,0 +1,19 @@
+---
+title: CreateAdminTimeOffRequest
+---
+## PureCloud::CreateAdminTimeOffRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **status** | **String** | The status of this time off request | |
+| **users** | [**Array<UserReference>**](UserReference.html) | A set of IDs for users to associate with this time off request | |
+| **activity_code_id** | **String** | The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category | |
+| **notes** | **String** | Notes about the time off request | [optional] |
+| **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. | [optional] |
+| **partial_day_start_date_times** | **Array<DateTime>** | A set of start date-times in ISO-8601 format for partial day requests. | [optional] |
+| **daily_duration_minutes** | **Integer** | The daily duration of this time off request in minutes | |
+{: class="table table-striped"}
+
+

data/docs/CreateAgentTimeOffRequest.md

@@ -0,0 +1,17 @@
+---
+title: CreateAgentTimeOffRequest
+---
+## PureCloud::CreateAgentTimeOffRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **activity_code_id** | **String** | The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category | |
+| **notes** | **String** | Notes about the time off request | [optional] |
+| **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. | [optional] |
+| **partial_day_start_date_times** | **Array<DateTime>** | A set of start date-times in ISO-8601 format for partial day requests. | [optional] |
+| **daily_duration_minutes** | **Integer** | The daily duration of this time off request in minutes | |
+{: class="table table-striped"}
+
+

data/docs/CreateAsgRequest.md

@@ -11,7 +11,7 @@ title: CreateAsgRequest
 | **edge_group_id** | **String** | Edge group that the user wants the asg edges to be assigned to. | [optional] |
 | **external_trunk_base_id** | **String** | Trunk base that the user wants the asg edges to be assigned to | [optional] |
 | **asg_logical_iam_instance_profile** | **String** | Overrides the default logical IAM Instance Profile | [optional] |
-| **asg_ami** | **BOOLEAN** | Overrides the default EDGE AMI used with the ASG | [optional] |
+| **asg_ami** | **String** | Overrides the default EDGE AMI used with the ASG | [optional] |
 | **asg_type** | **String** | Overrides the type of ASG being created.  By default we always create a 'standard' asg. | [optional] |
 | **asg_instance_count** | **Integer** | Overrides the default number of Edge instances to start in the ASG | [optional] |
 | **asg_network_space** | **String** | Overrides the network space the ASG will start in.  The default will always be mediaservices | [optional] |

data/docs/CreateManagementUnitApiRequest.md

@@ -0,0 +1,17 @@
+---
+title: CreateManagementUnitApiRequest
+---
+## PureCloud::CreateManagementUnitApiRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the management unit | |
+| **time_zone** | **String** | The default time zone to use for this management unit | |
+| **start_day_of_week** | **String** | The configured first day of the week for scheduling and forecasting purposes | |
+| **settings** | [**CreateManagementUnitSettings**](CreateManagementUnitSettings.html) | The configuration for the management unit.  If omitted, reasonable defaults will be assigned | [optional] |
+| **division_id** | **String** | The division to which this management unit belongs.  Defaults to home division ID | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CreateManagementUnitSettings.md

@@ -0,0 +1,16 @@
+---
+title: CreateManagementUnitSettings
+---
+## PureCloud::CreateManagementUnitSettings
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **adherence** | [**AdherenceSettings**](AdherenceSettings.html) | Adherence settings for this management unit | [optional] |
+| **short_term_forecasting** | [**ShortTermForecastingSettings**](ShortTermForecastingSettings.html) | Short term forecasting settings for this management unit | [optional] |
+| **time_off** | [**TimeOffRequestSettings**](TimeOffRequestSettings.html) | Time off request settings for this management unit | [optional] |
+| **scheduling** | [**SchedulingSettings**](SchedulingSettings.html) | Scheduling settings for this management unit | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CreateQueueMediaAssociationRequest.md

@@ -0,0 +1,14 @@
+---
+title: CreateQueueMediaAssociationRequest
+---
+## PureCloud::CreateQueueMediaAssociationRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **queue** | [**QueueReference**](QueueReference.html) | The queue to associate with the service goal group | [optional] |
+| **media_types** | **Array<String>** | The media types of the given queue to associate with the service goal group | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CreateServiceGoalGroupRequest.md

@@ -0,0 +1,15 @@
+---
+title: CreateServiceGoalGroupRequest
+---
+## PureCloud::CreateServiceGoalGroupRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | name | |
+| **goals** | [**ServiceGoalGroupGoals**](ServiceGoalGroupGoals.html) | Goals defined for this service goal group | [optional] |
+| **queue_media_associations** | [**Array<CreateQueueMediaAssociationRequest>**](CreateQueueMediaAssociationRequest.html) | List of queues and media types from that queue to associate with this service goal group | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CreateWorkPlan.md

@@ -0,0 +1,26 @@
+---
+title: CreateWorkPlan
+---
+## PureCloud::CreateWorkPlan
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | Name of this work plan | |
+| **enabled** | **BOOLEAN** | Whether the work plan is enabled for scheduling | [optional] |
+| **constrain_weekly_paid_time** | **BOOLEAN** | Whether the weekly paid time constraint is enabled for this work plan | [optional] |
+| **flexible_weekly_paid_time** | **BOOLEAN** | Whether the weekly paid time constraint is flexible for this work plan | [optional] |
+| **weekly_exact_paid_minutes** | **Integer** | Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false | [optional] |
+| **weekly_minimum_paid_minutes** | **Integer** | Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | [optional] |
+| **weekly_maximum_paid_minutes** | **Integer** | Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | [optional] |
+| **constrain_minimum_time_between_shifts** | **BOOLEAN** | Whether the minimum time between shifts constraint is enabled for this work plan | [optional] |
+| **minimum_time_between_shifts_minutes** | **Integer** | Minimum time between shifts in minutes defined in this work plan. Used if constrainMinimumTimeBetweenShifts == true | [optional] |
+| **maximum_days** | **Integer** | Maximum number days in a week allowed to be scheduled for this work plan | [optional] |
+| **optional_days** | [**SetWrapperDayOfWeek**](SetWrapperDayOfWeek.html) | Optional days to schedule for this work plan | [optional] |
+| **shift_start_variances** | [**ListWrapperShiftStartVariance**](ListWrapperShiftStartVariance.html) | Variance in minutes among start times of shifts in this work plan | [optional] |
+| **shifts** | [**Array<CreateWorkPlanShift>**](CreateWorkPlanShift.html) | Shifts in this work plan | [optional] |
+| **agents** | [**Array<UserReference>**](UserReference.html) | Agents in this work plan | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CreateWorkPlanActivity.md

@@ -0,0 +1,23 @@
+---
+title: CreateWorkPlanActivity
+---
+## PureCloud::CreateWorkPlanActivity
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **activity_code_id** | **String** | ID of the activity code associated with this activity | [optional] |
+| **description** | **String** | Description of the activity | [optional] |
+| **length_minutes** | **Integer** | Length of the activity in minutes | [optional] |
+| **start_time_is_relative_to_shift_start** | **BOOLEAN** | Whether the start time of the activity is relative to the start time of the shift it belongs to | [optional] |
+| **flexible_start_time** | **BOOLEAN** | Whether the start time of the activity is flexible | [optional] |
+| **earliest_start_time_minutes** | **Integer** | Earliest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true | [optional] |
+| **latest_start_time_minutes** | **Integer** | Latest activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == true | [optional] |
+| **exact_start_time_minutes** | **Integer** | Exact activity start in offset minutes relative to shift start time if startTimeIsRelativeToShiftStart == true else its based on midnight. Used if flexibleStartTime == false | [optional] |
+| **start_time_increment_minutes** | **Integer** | Increment in offset minutes that would contribute to different possible start times for the activity | [optional] |
+| **counts_as_paid_time** | **BOOLEAN** | Whether the activity is paid | [optional] |
+| **counts_as_contiguous_work_time** | **BOOLEAN** | Whether the activity duration is counted towards contiguous work time | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CreateWorkPlanShift.md

@@ -0,0 +1,29 @@
+---
+title: CreateWorkPlanShift
+---
+## PureCloud::CreateWorkPlanShift
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | Name of the shift | |
+| **days** | [**SetWrapperDayOfWeek**](SetWrapperDayOfWeek.html) | Days of the week applicable for this shift | [optional] |
+| **flexible_start_time** | **BOOLEAN** | Whether the start time of the shift is flexible | [optional] |
+| **exact_start_time_minutes_from_midnight** | **Integer** | Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false | [optional] |
+| **earliest_start_time_minutes_from_midnight** | **Integer** | Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true | [optional] |
+| **latest_start_time_minutes_from_midnight** | **Integer** | Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true | [optional] |
+| **constrain_stop_time** | **BOOLEAN** | Whether the latest stop time constraint for the shift is enabled | [optional] |
+| **latest_stop_time_minutes_from_midnight** | **Integer** | Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true | [optional] |
+| **start_increment_minutes** | **Integer** | Increment in offset minutes that would contribute to different possible start times for the shift. Used if flexibleStartTime == true | [optional] |
+| **flexible_paid_time** | **BOOLEAN** | Whether the paid time setting for the shift is flexible | [optional] |
+| **exact_paid_time_minutes** | **Integer** | Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false | [optional] |
+| **minimum_paid_time_minutes** | **Integer** | Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true | [optional] |
+| **maximum_paid_time_minutes** | **Integer** | Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true | [optional] |
+| **constrain_contiguous_work_time** | **BOOLEAN** | Whether the contiguous time constraint for the shift is enabled | [optional] |
+| **minimum_contiguous_work_time_minutes** | **Integer** | Minimum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true | [optional] |
+| **maximum_contiguous_work_time_minutes** | **Integer** | Maximum contiguous time in minutes configured for the shift. Used if constrainContiguousWorkTime == true | [optional] |
+| **activities** | [**Array<CreateWorkPlanActivity>**](CreateWorkPlanActivity.html) | Activities configured for this shift | [optional] |
+{: class="table table-striped"}
+
+

data/docs/CurrentUserScheduleRequestBody.md

@@ -0,0 +1,14 @@
+---
+title: CurrentUserScheduleRequestBody
+---
+## PureCloud::CurrentUserScheduleRequestBody
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **start_date** | **DateTime** | Beginning of the range of schedules to fetch, in ISO-8601 format | |
+| **end_date** | **DateTime** | End of the range of schedules to fetch, in ISO-8601 format | |
+{: class="table table-striped"}
+
+