purecloudplatformclientv2 36.1.0 → 37.0.0

data/docs/IntradayDataUpdateNotificationStartDate.md

@@ -8,9 +8,9 @@ title: IntradayDataUpdateNotificationStartDate
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **i_millis** | **Integer** |  | [optional] |
-| **before_now** | **BOOLEAN** |  | [optional] |
 | **after_now** | **BOOLEAN** |  | [optional] |
 | **equal_now** | **BOOLEAN** |  | [optional] |
+| **before_now** | **BOOLEAN** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/JsonNode.md

@@ -14,12 +14,12 @@ title: JsonNode
 | **boolean** | **BOOLEAN** |  | [optional] |
 | **number** | **BOOLEAN** |  | [optional] |
 | **float** | **BOOLEAN** |  | [optional] |
-| **floating_point_number** | **BOOLEAN** |  | [optional] |
 | **value_node** | **BOOLEAN** |  | [optional] |
 | **container_node** | **BOOLEAN** |  | [optional] |
 | **missing_node** | **BOOLEAN** |  | [optional] |
 | **pojo** | **BOOLEAN** |  | [optional] |
 | **integral_number** | **BOOLEAN** |  | [optional] |
+| **floating_point_number** | **BOOLEAN** |  | [optional] |
 | **short** | **BOOLEAN** |  | [optional] |
 | **int** | **BOOLEAN** |  | [optional] |
 | **long** | **BOOLEAN** |  | [optional] |

data/docs/LanguageReference.md

@@ -0,0 +1,14 @@
+---
+title: LanguageReference
+---
+## PureCloud::LanguageReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/LineId.md

@@ -0,0 +1,14 @@
+---
+title: LineId
+---
+## PureCloud::LineId
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **ids** | [**Array<LineUserId>**](LineUserId.html) | The set of Line userIds that this person has. Each userId is specific to the Line channel that the user interacts with. | [optional] |
+| **display_name** | **String** | The displayName of this person's account in Line | [optional] |
+{: class="table table-striped"}
+
+

data/docs/LineUserId.md

@@ -0,0 +1,13 @@
+---
+title: LineUserId
+---
+## PureCloud::LineUserId
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **user_id** | **String** | The unique channel-specific userId for the user | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ListWrapperForecastSourceDayPointer.md

@@ -0,0 +1,13 @@
+---
+title: ListWrapperForecastSourceDayPointer
+---
+## PureCloud::ListWrapperForecastSourceDayPointer
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **values** | [**Array<ForecastSourceDayPointer>**](ForecastSourceDayPointer.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ListWrapperShiftStartVariance.md

@@ -0,0 +1,13 @@
+---
+title: ListWrapperShiftStartVariance
+---
+## PureCloud::ListWrapperShiftStartVariance
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **values** | [**Array<ShiftStartVariance>**](ShiftStartVariance.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ListWrapperWfmForecastModification.md

@@ -0,0 +1,13 @@
+---
+title: ListWrapperWfmForecastModification
+---
+## PureCloud::ListWrapperWfmForecastModification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **values** | [**Array<WfmForecastModification>**](WfmForecastModification.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/MessageConversationNotificationMessageDetails.md

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

data/docs/MessageConversationNotificationMessageMedia.md

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

data/docs/MessageConversationNotificationMessageSticker.md

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

data/docs/MessageConversationNotificationMessages.md

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

data/docs/MessageMediaPolicyConditions.md

@@ -11,6 +11,7 @@ title: MessageMediaPolicyConditions
 | **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] |
 {: class="table table-striped"}
 

data/docs/OrgUser.md

@@ -9,6 +9,7 @@ title: OrgUser
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
+| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
 | **chat** | [**Chat**](Chat.html) |  | [optional] |
 | **department** | **String** |  | [optional] |
 | **email** | **String** |  | [optional] |

data/docs/OutboundApi.md

@@ -38,6 +38,7 @@ Method | Description
 [**get_outbound_campaignrule**](OutboundApi.html#get_outbound_campaignrule) | Get Campaign Rule
 [**get_outbound_campaignrules**](OutboundApi.html#get_outbound_campaignrules) | Query Campaign Rule list
 [**get_outbound_campaigns**](OutboundApi.html#get_outbound_campaigns) | Query a list of dialer campaigns.
+[**get_outbound_campaigns_divisionview**](OutboundApi.html#get_outbound_campaigns_divisionview) | Get a basic Campaign information object
 [**get_outbound_campaigns_divisionviews**](OutboundApi.html#get_outbound_campaigns_divisionviews) | Query a list of basic Campaign information objects
 [**get_outbound_contactlist**](OutboundApi.html#get_outbound_contactlist) | Get a dialer contact list.
 [**get_outbound_contactlist_contact**](OutboundApi.html#get_outbound_contactlist_contact) | Get a contact.
@@ -2065,6 +2066,7 @@ opts = {
   distribution_queue_id: "distribution_queue_id_example", # String | Distribution queue ID
   edge_group_id: "edge_group_id_example", # String | Edge group ID
   call_analysis_response_set_id: "call_analysis_response_set_id_example", # String | Call analysis response set ID
+  division_id: ["division_id_example"], # Array<String> | Division ID(s)
   sort_by: "sort_by_example", # String | Sort by
   sort_order: "a" # String | Sort order
 }
@@ -2092,6 +2094,7 @@ Name | Type | Description  | Notes
  **distribution_queue_id** | **String**| Distribution queue ID | [optional]  |
  **edge_group_id** | **String**| Edge group ID | [optional]  |
  **call_analysis_response_set_id** | **String**| Call analysis response set ID | [optional]  |
+ **division_id** | [**Array&lt;String&gt;**](String.html)| Division ID(s) | [optional]  |
  **sort_by** | **String**| Sort by | [optional]  |
  **sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending |
 {: class="table table-striped"}
@@ -2108,6 +2111,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_outbound_campaigns_divisionview"></a>
+
+## -[**CampaignDivisionView**](CampaignDivisionView.html) get_outbound_campaigns_divisionview(campaign_id)
+
+
+
+Get a basic Campaign information object
+
+This returns a simplified version of a Campaign, consisting of name and division.
+
+Wraps GET /api/v2/outbound/campaigns/divisionviews/{campaignId} 
+
+Requires ANY permissions: 
+
+* outbound:campaign:search
+
+
+### Example
+~~~ruby
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::OutboundApi.new
+
+campaign_id = "campaign_id_example" # String | Campaign ID
+
+
+begin
+  #Get a basic Campaign information object
+  result = api_instance.get_outbound_campaigns_divisionview(campaign_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling OutboundApi->get_outbound_campaigns_divisionview: #{e}"
+end
+~~~
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **campaign_id** | **String**| Campaign ID |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**CampaignDivisionView**](CampaignDivisionView.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_outbound_campaigns_divisionviews"></a>
 
 ## -[**CampaignDivisionViewListing**](CampaignDivisionViewListing.html) get_outbound_campaigns_divisionviews(opts)
@@ -2147,6 +2215,7 @@ opts = {
   page_number: 1, # Integer | Page number
   filter_type: "Prefix", # String | Filter type
   name: "name_example", # String | Name
+  id: ["id_example"], # Array<String> | id
   sort_by: "sort_by_example", # String | Sort by
   sort_order: "a" # String | Sort order
 }
@@ -2168,6 +2237,7 @@ Name | Type | Description  | Notes
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
  **filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith |
  **name** | **String**| Name | [optional]  |
+ **id** | [**Array&lt;String&gt;**](String.html)| id | [optional]  |
  **sort_by** | **String**| Sort by | [optional]  |
  **sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending |
 {: class="table table-striped"}

data/docs/PartialUploadResponse.md

@@ -0,0 +1,13 @@
+---
+title: PartialUploadResponse
+---
+## PureCloud::PartialUploadResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The reference id for a partial import request | [optional] |
+{: class="table table-striped"}
+
+

data/docs/PatchUser.md

@@ -8,7 +8,6 @@ title: PatchUser
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
-| **name** | **String** |  | [optional] |
 | **acd_auto_answer** | **BOOLEAN** | The value that denotes if acdAutoAnswer is set on the user | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}

data/docs/PublishedSurveyFormReference.md

@@ -0,0 +1,16 @@
+---
+title: PublishedSurveyFormReference
+---
+## PureCloud::PublishedSurveyFormReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **context_id** | **String** | The context id of this form. | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/QueryDivision.md

@@ -0,0 +1,12 @@
+---
+title: QueryDivision
+---
+## PureCloud::QueryDivision
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+{: class="table table-striped"}
+
+

data/docs/QueueMediaAssociation.md

@@ -0,0 +1,16 @@
+---
+title: QueueMediaAssociation
+---
+## PureCloud::QueueMediaAssociation
+
+## 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] |
+| **id** | **String** | The reference ID for this QueueMediaAssociation | [optional] |
+| **delete** | **BOOLEAN** | If marked true on a PATCH, this QueueMediaAssociation will be permanently deleted | [optional] |
+{: class="table table-striped"}
+
+

data/docs/QueueReference.md

@@ -0,0 +1,14 @@
+---
+title: QueueReference
+---
+## PureCloud::QueueReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/RecordingMessagingMessage.md

@@ -12,6 +12,7 @@ title: RecordingMessagingMessage
 | **from_external_contact** | [**ExternalContact**](ExternalContact.html) |  | [optional] |
 | **to** | **String** |  | [optional] |
 | **timestamp** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **id** | **String** |  | [optional] |
 | **message_text** | **String** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/RouteGroup.md

@@ -0,0 +1,18 @@
+---
+title: RouteGroup
+---
+## PureCloud::RouteGroup
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **attributes** | [**RouteGroupAttributes**](RouteGroupAttributes.html) | The attributes that describe this route group | |
+| **offered_per_interval** | **Array<Float>** | Interactions offered per 15 minute interval | |
+| **average_talk_time_seconds_per_interval** | **Array<Float>** | Average talk time in seconds per 15 minute interval | |
+| **average_after_call_work_seconds_per_interval** | **Array<Float>** | Average after call work in seconds per 15 minute interval | |
+| **completed_per_interval** | **Array<Float>** | Interactions completed per 15 minute interval | [optional] |
+| **abandoned_per_interval** | **Array<Float>** | Interactions abandoned per 15 minute interval | [optional] |
+{: class="table table-striped"}
+
+

data/docs/RouteGroupAttributes.md

@@ -0,0 +1,16 @@
+---
+title: RouteGroupAttributes
+---
+## PureCloud::RouteGroupAttributes
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **queue** | [**QueueReference**](QueueReference.html) | The queue to which the associated route group applies | |
+| **media_type** | **String** | The media type to which the associated route group applies | |
+| **language** | [**LanguageReference**](LanguageReference.html) | The language to which the associated route group applies | [optional] |
+| **skills** | [**Array<RoutingSkillReference>**](RoutingSkillReference.html) | The skill set to which the associated route group applies | [optional] |
+{: class="table table-striped"}
+
+

data/docs/RouteGroupList.md

@@ -0,0 +1,14 @@
+---
+title: RouteGroupList
+---
+## PureCloud::RouteGroupList
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **start_date** | **DateTime** | The reference start date for the route group arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **route_groups** | [**Array<RouteGroup>**](RouteGroup.html) | The route group data for this forecast | |
+{: class="table table-striped"}
+
+

data/docs/RoutingApi.md

@@ -33,7 +33,7 @@ Method | Description
 [**get_routing_queue_users**](RoutingApi.html#get_routing_queue_users) | Get the members of this queue
 [**get_routing_queue_wrapupcodes**](RoutingApi.html#get_routing_queue_wrapupcodes) | Get the wrap-up codes for a queue
 [**get_routing_queues**](RoutingApi.html#get_routing_queues) | Get list of queues.
-[**get_routing_queues_search**](RoutingApi.html#get_routing_queues_search) | Search for queues by name
+[**get_routing_queues_divisionviews**](RoutingApi.html#get_routing_queues_divisionviews) | Get a page of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
 [**get_routing_skill**](RoutingApi.html#get_routing_skill) | Get Routing Skill
 [**get_routing_skills**](RoutingApi.html#get_routing_skills) | Get the list of routing skills.
 [**get_routing_sms_availablephonenumbers**](RoutingApi.html#get_routing_sms_availablephonenumbers) | Get a list of available phone numbers for SMS provisioning.
@@ -1749,17 +1749,17 @@ Name | Type | Description  | Notes
 
 
 
-<a name="get_routing_queues_search"></a>
+<a name="get_routing_queues_divisionviews"></a>
 
-## -[**QueueEntityListing**](QueueEntityListing.html) get_routing_queues_search(opts)
+## -[**QueueEntityListing**](QueueEntityListing.html) get_routing_queues_divisionviews(opts)
 
 
 
-Search for queues by name
+Get a page of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
 
 
 
-Wraps GET /api/v2/routing/queues/search 
+Wraps GET /api/v2/routing/queues/divisionviews 
 
 Requires ANY permissions: 
 
@@ -1794,11 +1794,11 @@ opts = {
 }
 
 begin
-  #Search for queues by name
-  result = api_instance.get_routing_queues_search(opts)
+  #Get a page of simplified queue objects, filterable by name, queue ID(s), or division ID(s).
+  result = api_instance.get_routing_queues_divisionviews(opts)
   p result
 rescue PureCloud::ApiError => e
-  puts "Exception when calling RoutingApi->get_routing_queues_search: #{e}"
+  puts "Exception when calling RoutingApi->get_routing_queues_divisionviews: #{e}"
 end
 ~~~