purecloudplatformclientv2 70.0.0 → 71.0.0

data/docs/SCIMApi.md

@@ -8,7 +8,9 @@ All URIs are relative to *https://api.mypurecloud.com*
 
 Method | Description
 ------------- | ------------- | -------------
+[**delete_scim_group**](SCIMApi.html#delete_scim_group) | Delete a group.
 [**delete_scim_user**](SCIMApi.html#delete_scim_user) | Delete a user
+[**delete_scim_v2_group**](SCIMApi.html#delete_scim_v2_group) | Delete a group.
 [**delete_scim_v2_user**](SCIMApi.html#delete_scim_v2_user) | Delete a user
 [**get_scim_group**](SCIMApi.html#get_scim_group) | Get a group
 [**get_scim_groups**](SCIMApi.html#get_scim_groups) | Get a list of groups
@@ -28,7 +30,9 @@ Method | Description
 [**patch_scim_user**](SCIMApi.html#patch_scim_user) | Modify a user
 [**patch_scim_v2_group**](SCIMApi.html#patch_scim_v2_group) | Modify a group
 [**patch_scim_v2_user**](SCIMApi.html#patch_scim_v2_user) | Modify a user
+[**post_scim_groups**](SCIMApi.html#post_scim_groups) | The information used to create a group.
 [**post_scim_users**](SCIMApi.html#post_scim_users) | Create a user
+[**post_scim_v2_groups**](SCIMApi.html#post_scim_v2_groups) | The information used to create a group.
 [**post_scim_v2_users**](SCIMApi.html#post_scim_v2_users) | Create a user
 [**put_scim_group**](SCIMApi.html#put_scim_group) | Replace a group
 [**put_scim_user**](SCIMApi.html#put_scim_user) | Replace a user
@@ -36,6 +40,74 @@ Method | Description
 [**put_scim_v2_user**](SCIMApi.html#put_scim_v2_user) | Replace a user
 {: class="table table-striped"}
 
+<a name="delete_scim_group"></a>
+
+##  delete_scim_group(group_id, opts)
+
+
+
+Delete a group.
+
+
+
+Wraps DELETE /api/v2/scim/groups/{groupId} 
+
+Requires ANY permissions: 
+
+* directory:group:edit
+
+
+### 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::SCIMApi.new
+
+group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
+
+opts = { 
+  if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
+}
+
+begin
+  #Delete a group.
+  api_instance.delete_scim_group(group_id, opts)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SCIMApi->delete_scim_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. |  |
+ **if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;. | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/scim+json
+ - **Accept**: application/json, application/scim+json
+
+
+
 <a name="delete_scim_user"></a>
 
 ## [**Empty**](Empty.html) delete_scim_user(user_id, opts)
@@ -105,6 +177,74 @@ Name | Type | Description  | Notes
 
 
 
+<a name="delete_scim_v2_group"></a>
+
+##  delete_scim_v2_group(group_id, opts)
+
+
+
+Delete a group.
+
+
+
+Wraps DELETE /api/v2/scim/v2/groups/{groupId} 
+
+Requires ANY permissions: 
+
+* directory:group:edit
+
+
+### 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::SCIMApi.new
+
+group_id = "group_id_example" # String | The ID of a group. Returned with GET /api/v2/scim/v2/groups.
+
+opts = { 
+  if_match: "if_match_example" # String | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\".
+}
+
+begin
+  #Delete a group.
+  api_instance.delete_scim_v2_group(group_id, opts)
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SCIMApi->delete_scim_v2_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **group_id** | **String**| The ID of a group. Returned with GET /api/v2/scim/v2/groups. |  |
+ **if_match** | **String**| The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \&quot;42\&quot;. If the ETag is different from the version on the server, returns 400 with a \&quot;scimType\&quot; of \&quot;invalidVers\&quot;. | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+nil (empty response body)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/scim+json
+ - **Accept**: application/json, application/scim+json
+
+
+
 <a name="delete_scim_v2_user"></a>
 
 ## [**Empty**](Empty.html) delete_scim_v2_user(user_id, opts)
@@ -1347,6 +1487,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_scim_groups"></a>
+
+## [**ScimV2Group**](ScimV2Group.html) post_scim_groups(body)
+
+
+
+The information used to create a group.
+
+PureCloud group will be created as \"Official\" group with visibility set \"Public\", and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
+
+Wraps POST /api/v2/scim/groups 
+
+Requires ANY permissions: 
+
+* directory:group:edit
+
+
+### 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::SCIMApi.new
+
+body = PureCloud::ScimV2Group.new # ScimV2Group | The information used to create a group.
+
+
+begin
+  #The information used to create a group.
+  result = api_instance.post_scim_groups(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SCIMApi->post_scim_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ScimV2Group**](ScimV2Group.html)| The information used to create a group. |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ScimV2Group**](ScimV2Group.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/scim+json
+ - **Accept**: application/json, application/scim+json
+
+
+
 <a name="post_scim_users"></a>
 
 ## [**ScimV2User**](ScimV2User.html) post_scim_users(body)
@@ -1412,6 +1617,71 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_scim_v2_groups"></a>
+
+## [**ScimV2Group**](ScimV2Group.html) post_scim_v2_groups(body)
+
+
+
+The information used to create a group.
+
+PureCloud group will be created as \"Official\" group with visibility set \"Public\", and rules visibility True. Will auto-create an external ID if one is not provided on create. External ID is used to determine if delete should be allowed.
+
+Wraps POST /api/v2/scim/v2/groups 
+
+Requires ANY permissions: 
+
+* directory:group:edit
+
+
+### 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::SCIMApi.new
+
+body = PureCloud::ScimV2Group.new # ScimV2Group | The information used to create a group.
+
+
+begin
+  #The information used to create a group.
+  result = api_instance.post_scim_v2_groups(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SCIMApi->post_scim_v2_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ScimV2Group**](ScimV2Group.html)| The information used to create a group. |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ScimV2Group**](ScimV2Group.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, application/scim+json
+ - **Accept**: application/json, application/scim+json
+
+
+
 <a name="post_scim_v2_users"></a>
 
 ## [**ScimV2User**](ScimV2User.html) post_scim_v2_users(body)

data/docs/ScimServiceProviderConfigAuthenticationScheme.md

@@ -12,7 +12,7 @@ title: ScimServiceProviderConfigAuthenticationScheme
 | **spec_uri** | **String** | The HTTP-addressable URL that points to the authentication scheme's specification. | [optional] |
 | **documentation_uri** | **String** | The HTTP-addressable URL that points to the authentication scheme's usage documentation. | [optional] |
 | **type** | **String** | The type of authentication scheme. | |
-| **primary** | **BOOLEAN** | Indicates the primary method of authentication. | [optional] |
+| **primary** | **BOOLEAN** | Indicates whether this authentication scheme is the primary method of authentication. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ScimV2Group.md

@@ -9,7 +9,8 @@ title: ScimV2Group
 |------------ | ------------- | ------------- | -------------|
 | **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] |
 | **schemas** | **Array<String>** | The list of supported schemas. | [optional] |
-| **display_name** | **String** | The display name of the group. | [optional] |
+| **display_name** | **String** | The display name of the group. | |
+| **external_id** | **String** | The external ID of the group. Set by the provisioning client. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readWrite\". | [optional] |
 | **members** | [**Array<ScimV2MemberReference>**](ScimV2MemberReference.html) | The list of members in the group. | [optional] |
 | **meta** | [**ScimMetadata**](ScimMetadata.html) | The metadata of the SCIM resource. | [optional] |
 {: class="table table-striped"}

data/docs/SendAgentlessOutboundMessageRequest.md

@@ -0,0 +1,16 @@
+---
+title: SendAgentlessOutboundMessageRequest
+---
+## PureCloud::SendAgentlessOutboundMessageRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **from_address** | **String** | The messaging address of the sender of the message. For an SMS messenger type, this must be a currently provisioned sms phone number. The phone number address must be in E.164 format. E.g. +13175555555 or +34234234234 | |
+| **to_address** | **String** | The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234 | |
+| **to_address_messenger_type** | **String** | The recipient messaging address messenger type. | |
+| **text_body** | **String** | The text of the message to send | |
+{: class="table table-striped"}
+
+

data/docs/SendAgentlessOutboundMessageResponse.md

@@ -0,0 +1,21 @@
+---
+title: SendAgentlessOutboundMessageResponse
+---
+## PureCloud::SendAgentlessOutboundMessageResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **conversation_id** | **String** | The identifier of the conversation. | [optional] |
+| **from_address** | **String** | The sender of the text message. | [optional] |
+| **to_address** | **String** | The recipient of the text message. | [optional] |
+| **messenger_type** | **String** | Type of text messenger. | [optional] |
+| **text_body** | **String** | The body of the text message. | [optional] |
+| **timestamp** | **DateTime** | The time when the message was sent. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+| **user** | [**AddressableEntityRef**](AddressableEntityRef.html) | Details of the user created the job | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ShiftTradeSettings.md

@@ -18,6 +18,7 @@ title: ShiftTradeSettings
 | **requires_matching_queues** | **BOOLEAN** | Whether to constrain shift trades to agents with matching queues | [optional] |
 | **requires_matching_languages** | **BOOLEAN** | Whether to constrain shift trades to agents with matching languages | [optional] |
 | **requires_matching_skills** | **BOOLEAN** | Whether to constrain shift trades to agents with matching skills | [optional] |
+| **requires_matching_planning_groups** | **BOOLEAN** | Whether to constrain shift trades to agents with matching planning groups | [optional] |
 | **activity_category_rules** | [**Array<ShiftTradeActivityRule>**](ShiftTradeActivityRule.html) | Rules that specify what to do with activity categories that are part of a shift defined in a trade | [optional] |
 {: class="table table-striped"}
 

data/docs/TranscriptionSettings.md

@@ -0,0 +1,14 @@
+---
+title: TranscriptionSettings
+---
+## PureCloud::TranscriptionSettings
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **transcription** | **String** | Setting to enable/disable transcription capability | |
+| **transcription_confidence_threshold** | **Integer** | Configure confidence threshold. The possible values are from 1 to 100. | |
+{: class="table table-striped"}
+
+

data/docs/WhatsAppIntegrationRequest.md

@@ -0,0 +1,17 @@
+---
+title: WhatsAppIntegrationRequest
+---
+## PureCloud::WhatsAppIntegrationRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** | The name of the WhatsApp Integration | |
+| **phone_number** | **String** | The phone number associated to the whatsApp integration | |
+| **waba_certificate** | **String** | The waba(WhatsApp Business Manager) certificate associated to the WhatsApp integration phone number | |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/WorkPlanReference.md

@@ -7,7 +7,9 @@ title: WorkPlanReference
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **id** | **String** | The ID of the work plan | |
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **management_unit** | [**ManagementUnitReference**](ManagementUnitReference.html) | The management unit to which this work plan belongs.  Nullable in some routes | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 
 

data/docs/WorkforceManagementApi.md

@@ -58,6 +58,7 @@ Method | Description
 [**patch_workforcemanagement_timeoffrequest**](WorkforceManagementApi.html#patch_workforcemanagement_timeoffrequest) | Update a time off request for the current user
 [**post_workforcemanagement_adherence_historical**](WorkforceManagementApi.html#post_workforcemanagement_adherence_historical) | Request a historical adherence report for users across management units
 [**post_workforcemanagement_managementunit_activitycodes**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_activitycodes) | Create a new activity code
+[**post_workforcemanagement_managementunit_agentschedules_search**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_agentschedules_search) | Query published schedules for given given time range for set of users
 [**post_workforcemanagement_managementunit_historicaladherencequery**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_historicaladherencequery) | Request a historical adherence report
 [**post_workforcemanagement_managementunit_intraday**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_intraday) | Get intraday data for the given date for the requested queueIds
 [**post_workforcemanagement_managementunit_move**](WorkforceManagementApi.html#post_workforcemanagement_managementunit_move) | Move the requested management unit to a new business unit
@@ -1186,7 +1187,7 @@ Wraps GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/schedul
 
 Requires ANY permissions: 
 
-* wfm:schedule:generate
+* wfm:schedule:edit
 
 
 ### Example
@@ -2972,7 +2973,7 @@ Wraps PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/sched
 
 Requires ANY permissions: 
 
-* wfm:schedule:generate
+* wfm:schedule:edit
 
 
 ### Example
@@ -3601,6 +3602,76 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_workforcemanagement_managementunit_agentschedules_search"></a>
+
+## [**UserScheduleContainer**](UserScheduleContainer.html) post_workforcemanagement_managementunit_agentschedules_search(mu_id, opts)
+
+
+
+Query published schedules for given given time range for set of users
+
+
+
+Wraps POST /api/v2/workforcemanagement/managementunits/{muId}/agentschedules/search 
+
+Requires ANY permissions: 
+
+* wfm:publishedSchedule:view
+* wfm:schedule:view
+
+
+### 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::WorkforceManagementApi.new
+
+mu_id = "mu_id_example" # String | The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
+
+opts = { 
+  body: PureCloud::BuSearchAgentSchedulesRequest.new # BuSearchAgentSchedulesRequest | body
+}
+
+begin
+  #Query published schedules for given given time range for set of users
+  result = api_instance.post_workforcemanagement_managementunit_agentschedules_search(mu_id, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_agentschedules_search: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **mu_id** | **String**| The management unit ID of the management unit, or &#39;mine&#39; for the management unit of the logged-in user. |  |
+ **body** | [**BuSearchAgentSchedulesRequest**](BuSearchAgentSchedulesRequest.html)| body | [optional]  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserScheduleContainer**](UserScheduleContainer.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="post_workforcemanagement_managementunit_historicaladherencequery"></a>
 
 ## [**WfmHistoricalAdherenceResponse**](WfmHistoricalAdherenceResponse.html) post_workforcemanagement_managementunit_historicaladherencequery(mu_id, opts)
@@ -4247,7 +4318,7 @@ Wraps POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/
 
 Requires ANY permissions: 
 
-* wfm:schedule:edit
+* wfm:schedule:generate
 
 
 ### Example