purecloudplatformclientv2 91.0.0 → 96.0.0

data/docs/StatEventFlowOutcomeTopicMetric.md

@@ -0,0 +1,15 @@
+---
+title: StatEventFlowOutcomeTopicMetric
+---
+## PureCloud::StatEventFlowOutcomeTopicMetric
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **metric** | **String** |  | [optional] |
+| **qualifier** | **String** |  | [optional] |
+| **stats** | **Hash<String, Float>** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventFlowOutcomeTopicStatsNotification.md

@@ -0,0 +1,14 @@
+---
+title: StatEventFlowOutcomeTopicStatsNotification
+---
+## PureCloud::StatEventFlowOutcomeTopicStatsNotification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **group** | **Hash<String, String>** |  | [optional] |
+| **data** | [**Array<StatEventFlowOutcomeTopicDatum>**](StatEventFlowOutcomeTopicDatum.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventFlowTopicDatum.md

@@ -0,0 +1,14 @@
+---
+title: StatEventFlowTopicDatum
+---
+## PureCloud::StatEventFlowTopicDatum
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** |  | [optional] |
+| **metrics** | [**Array<StatEventFlowTopicMetric>**](StatEventFlowTopicMetric.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventFlowTopicMetric.md

@@ -0,0 +1,15 @@
+---
+title: StatEventFlowTopicMetric
+---
+## PureCloud::StatEventFlowTopicMetric
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **metric** | **String** |  | [optional] |
+| **qualifier** | **String** |  | [optional] |
+| **stats** | **Hash<String, Float>** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventFlowTopicStatsNotification.md

@@ -0,0 +1,14 @@
+---
+title: StatEventFlowTopicStatsNotification
+---
+## PureCloud::StatEventFlowTopicStatsNotification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **group** | **Hash<String, String>** |  | [optional] |
+| **data** | [**Array<StatEventFlowTopicDatum>**](StatEventFlowTopicDatum.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventWrapUpCodeTopicDatum.md

@@ -0,0 +1,14 @@
+---
+title: StatEventWrapUpCodeTopicDatum
+---
+## PureCloud::StatEventWrapUpCodeTopicDatum
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** |  | [optional] |
+| **metrics** | [**Array<StatEventWrapUpCodeTopicMetric>**](StatEventWrapUpCodeTopicMetric.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventWrapUpCodeTopicMetric.md

@@ -0,0 +1,15 @@
+---
+title: StatEventWrapUpCodeTopicMetric
+---
+## PureCloud::StatEventWrapUpCodeTopicMetric
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **metric** | **String** |  | [optional] |
+| **qualifier** | **String** |  | [optional] |
+| **stats** | **Hash<String, Float>** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventWrapUpCodeTopicStatsNotification.md

@@ -0,0 +1,14 @@
+---
+title: StatEventWrapUpCodeTopicStatsNotification
+---
+## PureCloud::StatEventWrapUpCodeTopicStatsNotification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **group** | **Hash<String, String>** |  | [optional] |
+| **data** | [**Array<StatEventWrapUpCodeTopicDatum>**](StatEventWrapUpCodeTopicDatum.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SurveyForm.md

@@ -14,8 +14,6 @@ title: SurveyForm
 | **disabled** | **BOOLEAN** | Is this form disabled | [optional] |
 | **context_id** | **String** | Unique Id for all versions of this form | |
 | **language** | **String** | Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW | |
-| **header_image_id** | **String** | Id of the header image appearing at the top of the form. | [optional] |
-| **header_image_url** | **String** | Temporary URL for accessing header image | [optional] |
 | **header** | **String** | Markdown text for the top of the form. | [optional] |
 | **footer** | **String** | Markdown text for the bottom of the form. | [optional] |
 | **question_groups** | [**Array<SurveyQuestionGroup>**](SurveyQuestionGroup.html) | A list of question groups | |

data/docs/TelephonyProvidersEdgeApi.md

@@ -2909,7 +2909,8 @@ api_instance = PureCloud::TelephonyProvidersEdgeApi.new
 opts = { 
   page_size: 25, # Integer | Page size
   page_number: 1, # Integer | Page number
-  sort_by: "number" # String | Sort by
+  sort_by: "number", # String | Sort by
+  id: ["id_example"] # Array<String> | Filter by a specific list of ID's
 }
 
 begin
@@ -2928,6 +2929,7 @@ Name | Type | Description  | Notes
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
  **sort_by** | **String**| Sort by | [optional] [default to number] |
+ **id** | [**Array&lt;String&gt;**](String.html)| Filter by a specific list of ID&#39;s | [optional]  |
 {: class="table table-striped"}
 
 
@@ -2983,7 +2985,8 @@ opts = {
   sort_order: "ASC", # String | Sort order
   phone_number: "phone_number_example", # String | Filter by phoneNumber
   owner_id: "owner_id_example", # String | Filter by the owner of a phone number
-  did_pool_id: "did_pool_id_example" # String | Filter by the DID Pool assignment
+  did_pool_id: "did_pool_id_example", # String | Filter by the DID Pool assignment
+  id: ["id_example"] # Array<String> | Filter by a specific list of ID's
 }
 
 begin
@@ -3006,6 +3009,7 @@ Name | Type | Description  | Notes
  **phone_number** | **String**| Filter by phoneNumber | [optional]  |
  **owner_id** | **String**| Filter by the owner of a phone number | [optional]  |
  **did_pool_id** | **String**| Filter by the DID Pool assignment | [optional]  |
+ **id** | [**Array&lt;String&gt;**](String.html)| Filter by a specific list of ID&#39;s | [optional]  |
 {: class="table table-striped"}
 
 

data/docs/TextbotsApi.md

@@ -0,0 +1,78 @@
+---
+title: TextbotsApi
+---
+
+## PureCloud::TextbotsApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+Method | Description
+------------- | ------------- | -------------
+[**post_textbots_bots_execute**](TextbotsApi.html#post_textbots_bots_execute) | Send an intent to a bot to start a dialog/interact with it via text
+{: class="table table-striped"}
+
+<a name="post_textbots_bots_execute"></a>
+
+## [**PostTextResponse**](PostTextResponse.html) post_textbots_bots_execute(post_text_request)
+
+
+
+Send an intent to a bot to start a dialog/interact with it via text
+
+This will either start a bot with the given id or relay a communication to an existing bot session.
+
+Wraps POST /api/v2/textbots/bots/execute 
+
+Requires ANY permissions: 
+
+* textbots:session:execute
+
+
+### Example
+```{"language":"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::TextbotsApi.new
+
+post_text_request = PureCloud::PostTextRequest.new # PostTextRequest | 
+
+
+begin
+  #Send an intent to a bot to start a dialog/interact with it via text
+  result = api_instance.post_textbots_bots_execute(post_text_request)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling TextbotsApi->post_textbots_bots_execute: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **post_text_request** | [**PostTextRequest**](PostTextRequest.html)|  |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**PostTextResponse**](PostTextResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/TranscriptUrl.md

@@ -0,0 +1,13 @@
+---
+title: TranscriptUrl
+---
+## PureCloud::TranscriptUrl
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **url** | **String** | The pre-signed S3 URL of the transcript | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UpdateCoachingAppointmentRequest.md

@@ -9,10 +9,11 @@ title: UpdateCoachingAppointmentRequest
 |------------ | ------------- | ------------- | -------------|
 | **name** | **String** | The name of coaching appointment. | [optional] |
 | **description** | **String** | The description of coaching appointment. | [optional] |
-| **date_start** | **DateTime** | The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **date_start** | **DateTime** | The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **length_in_minutes** | **Integer** | The duration of coaching appointment in minutes. | [optional] |
 | **conversation_ids** | **Array<String>** | IDs of conversations associated with this coaching appointment. | [optional] |
 | **document_ids** | **Array<String>** | IDs of documents associated with this coaching appointment. | [optional] |
+| **status** | **String** | The status of the coaching appointment. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/UserRoutingLanguage.md

@@ -9,9 +9,9 @@ title: UserRoutingLanguage
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
-| **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] |
-| **state** | **String** | Activate or deactivate this routing langauge. | [optional] |
-| **language_uri** | **String** | URI to the organization language used by this user langauge. | [optional] |
+| **proficiency** | **Float** | A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings. | [optional] |
+| **state** | **String** | Activate or deactivate this routing language. | [optional] |
+| **language_uri** | **String** | URI to the organization language used by this user language. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/UserRoutingLanguagePost.md

@@ -9,7 +9,7 @@ title: UserRoutingLanguagePost
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The id of the existing routing language to add to the user | |
 | **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. | |
-| **language_uri** | **String** | URI to the organization language used by this user langauge. | [optional] |
+| **language_uri** | **String** | URI to the organization language used by this user language. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/UserRoutingSkill.md

@@ -9,7 +9,7 @@ title: UserRoutingSkill
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
-| **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] |
+| **proficiency** | **Float** | A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When \"Best available skills\" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings. | [optional] |
 | **state** | **String** | Activate or deactivate this routing skill. | [optional] |
 | **skill_uri** | **String** | URI to the organization skill used by this user skill. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |

data/docs/UserScheduleAdherence.md

@@ -11,6 +11,7 @@ title: UserScheduleAdherence
 | **name** | **String** |  | [optional] |
 | **user** | [**UserReference**](UserReference.html) | The user for whom this status applies | [optional] |
 | **management_unit** | [**ManagementUnit**](ManagementUnit.html) | The management unit to which this user belongs | [optional] |
+| **team** | [**Team**](Team.html) | The team to which this user belongs | [optional] |
 | **scheduled_activity_category** | **String** | Activity for which the user is scheduled | [optional] |
 | **system_presence** | **String** | Actual underlying system presence value | [optional] |
 | **organization_secondary_presence_id** | **String** | Organization Secondary Presence Id. | [optional] |

data/docs/UserSearchRequest.md

@@ -14,6 +14,8 @@ title: UserSearchRequest
 | **sort** | [**Array<SearchSort>**](SearchSort.html) | Multi-value sort order, list of multiple sort values | [optional] |
 | **expand** | **Array<String>** | Provides more details about a specified resource | [optional] |
 | **query** | [**Array<UserSearchCriteria>**](UserSearchCriteria.html) |  | [optional] |
+| **integration_presence_source** | **String** | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10. | [optional] |
+| **enforce_permissions** | **BOOLEAN** | Enforce view permission on request | [optional] |
 {: class="table table-striped"}
 
 

data/docs/UsersApi.md

@@ -1180,7 +1180,8 @@ opts = {
   id: ["id_example"], # Array<String> | id
   jid: ["jid_example"], # Array<String> | jid
   sort_order: "ASC", # String | Ascending or descending sort order
-  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
+  expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
+  integration_presence_source: "integration_presence_source_example" # String | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\".
 }
 
 begin
@@ -1202,6 +1203,7 @@ Name | Type | Description  | Notes
  **jid** | [**Array&lt;String&gt;**](String.html)| jid | [optional]  |
  **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
  **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization |
+ **integration_presence_source** | **String**| Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \&quot;expand\&quot;. | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
 {: class="table table-striped"}
 
 
@@ -1319,6 +1321,7 @@ user_id = "user_id_example" # String | User ID
 
 opts = { 
   expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
+  integration_presence_source: "integration_presence_source_example", # String | Gets an integration presence for a user instead of their default.
   state: "active" # String | Search for a user with this state
 }
 
@@ -1337,6 +1340,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **user_id** | **String**| User ID |  |
  **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography |
+ **integration_presence_source** | **String**| Gets an integration presence for a user instead of their default. | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
  **state** | **String**| Search for a user with this state | [optional] [default to active]<br />**Values**: active, deleted |
 {: class="table table-striped"}
 
@@ -1793,7 +1797,8 @@ api_instance = PureCloud::UsersApi.new
 user_id = "user_id_example" # String | userId
 
 opts = { 
-  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
+  expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
+  integration_presence_source: "integration_presence_source_example" # String | Gets an integration presence for a user instead of their default.
 }
 
 begin
@@ -1811,6 +1816,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **user_id** | **String**| userId |  |
  **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team |
+ **integration_presence_source** | **String**| Gets an integration presence for a user instead of their default. | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
 {: class="table table-striped"}
 
 
@@ -2482,6 +2488,7 @@ opts = {
   jabber_id: ["jabber_id_example"], # Array<String> | A list of jabberIds to fetch by bulk (cannot be used with the \"id\" parameter)
   sort_order: "ASC", # String | Ascending or descending sort order
   expand: ["expand_example"], # Array<String> | Which fields, if any, to expand
+  integration_presence_source: "integration_presence_source_example", # String | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10.
   state: "active" # String | Only list users of this state
 }
 
@@ -2504,6 +2511,7 @@ Name | Type | Description  | Notes
  **jabber_id** | [**Array&lt;String&gt;**](String.html)| A list of jabberIds to fetch by bulk (cannot be used with the \&quot;id\&quot; parameter) | [optional]  |
  **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]<br />**Values**: ascending, descending |
  **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography |
+ **integration_presence_source** | **String**| Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \&quot;expand\&quot;. When using this parameter the maximum number of users that can be returned is 10. | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
  **state** | **String**| Only list users of this state | [optional] [default to active]<br />**Values**: active, inactive, deleted, any |
 {: class="table table-striped"}
 
@@ -2553,7 +2561,8 @@ end
 api_instance = PureCloud::UsersApi.new
 
 opts = { 
-  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand.
+  expand: ["expand_example"], # Array<String> | Which fields, if any, to expand.
+  integration_presence_source: "integration_presence_source_example" # String | Get your presence for a given integration. This parameter will only be used when presence is provided as an \"expand\".
 }
 
 begin
@@ -2570,6 +2579,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography, date, geolocationsettings, organization, presencedefinitions, locationdefinitions, orgauthorization, orgproducts, favorites, superiors, directreports, adjacents, routingskills, routinglanguages, fieldconfigs, token, trustors |
+ **integration_presence_source** | **String**| Get your presence for a given integration. This parameter will only be used when presence is provided as an \&quot;expand\&quot;. | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
 {: class="table table-striped"}
 
 
@@ -2620,7 +2630,8 @@ api_instance = PureCloud::UsersApi.new
 q64 = "q64_example" # String | q64
 
 opts = { 
-  expand: ["expand_example"] # Array<String> | expand
+  expand: ["expand_example"], # Array<String> | expand
+  integration_presence_source: "integration_presence_source_example" # String | integrationPresenceSource
 }
 
 begin
@@ -2638,6 +2649,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **q64** | **String**| q64 |  |
  **expand** | [**Array&lt;String&gt;**](String.html)| expand | [optional]  |
+ **integration_presence_source** | **String**| integrationPresenceSource | [optional] <br />**Values**: MicrosoftTeams, ZoomPhone |
 {: class="table table-striped"}
 
 
@@ -2869,7 +2881,7 @@ Join or unjoin a queue for a user
 
 Wraps PATCH /api/v2/users/{userId}/queues/{queueId} 
 
-Requires ANY permissions: 
+Requires ALL permissions: 
 
 * routing:queue:join
 
@@ -4159,8 +4171,9 @@ Search users
 
 Wraps POST /api/v2/users/search 
 
-Requires NO permissions: 
+Requires ANY permissions: 
 
+* directory:user:view
 
 
 ### Example