purecloudplatformclientv2 92.0.0 → 93.0.0

data/docs/ScimConfigResourceType.md

@@ -7,7 +7,7 @@ title: ScimConfigResourceType
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **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] |
+| **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] |
 | **name** | **String** | The name of the resource type. | [optional] |
 | **description** | **String** | The description of the resource type. | [optional] |

data/docs/ScimUserExtensions.md

@@ -7,8 +7,8 @@ title: ScimUserExtensions
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **routing_skills** | [**Array<ScimUserRoutingSkill>**](ScimUserRoutingSkill.html) | Routing Skills assigned to user. No more than 50 skills may be assigned to a user. | [optional] |
-| **routing_languages** | [**Array<ScimUserRoutingLanguage>**](ScimUserRoutingLanguage.html) | Routing Languages assigned to user. No more than 50 languages may be assigned to a user. | [optional] |
+| **routing_skills** | [**Array<ScimUserRoutingSkill>**](ScimUserRoutingSkill.html) | The list of routing skills assigned to a user. Maximum 50 skills. | [optional] |
+| **routing_languages** | [**Array<ScimUserRoutingLanguage>**](ScimUserRoutingLanguage.html) | The list of routing languages assigned to a user. Maximum 50 languages. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ScimUserRole.md

@@ -7,7 +7,7 @@ title: ScimUserRole
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **value** | **String** | Purecloud user role name | [optional] |
+| **value** | **String** | The role of the Genesys Cloud user. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ScimUserRoutingLanguage.md

@@ -7,8 +7,8 @@ title: ScimUserRoutingLanguage
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **name** | **String** | Case-sensitive name identifying a language configured in routing languages. | |
-| **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] |
+| **name** | **String** | The case-sensitive name of a routing language configured in Genesys Cloud. | |
+| **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] |
 {: class="table table-striped"}
 
 

data/docs/ScimUserRoutingSkill.md

@@ -7,8 +7,8 @@ title: ScimUserRoutingSkill
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **name** | **String** | Case-sensitive name identifying a skill configured in routing skills. | |
-| **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] |
+| **name** | **String** | The case-sensitive name of a routing skill configured in Genesys Cloud. | |
+| **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] |
 {: class="table table-striped"}
 
 

data/docs/ScimV2CreateUser.md

@@ -9,9 +9,9 @@ title: ScimV2CreateUser
 |------------ | ------------- | ------------- | -------------|
 | **schemas** | **Array<String>** | The list of supported schemas. | [optional] |
 | **active** | **BOOLEAN** | Indicates whether the user's administrative status is active. | [optional] |
-| **user_name** | **String** | The user's PureCloud email address. Must be unique. | |
+| **user_name** | **String** | The user's Genesys Cloud email address. Must be unique. | |
 | **display_name** | **String** | The display name of the user. | |
-| **password** | **String** | The new password for the PureCloud user. Does not return an existing password. | [optional] |
+| **password** | **String** | The new password for the Genesys Cloud user. Does not return an existing password. | [optional] |
 | **title** | **String** | The user's title. | [optional] |
 | **phone_numbers** | [**Array<ScimPhoneNumber>**](ScimPhoneNumber.html) | The list of the user's phone numbers. | [optional] |
 | **emails** | [**Array<ScimEmail>**](ScimEmail.html) | The list of the user's email addresses. | [optional] |
@@ -19,7 +19,7 @@ title: ScimV2CreateUser
 | **groups** | [**Array<ScimV2GroupReference>**](ScimV2GroupReference.html) | The list of groups that the user is a member of. | [optional] |
 | **roles** | [**Array<ScimUserRole>**](ScimUserRole.html) | The list of roles assigned to the user. | [optional] |
 | **urnietfparamsscimschemasextensionenterprise2_0_user** | [**ScimV2EnterpriseUser**](ScimV2EnterpriseUser.html) | The URI of the schema for the enterprise user. | [optional] |
-| **urnietfparamsscimschemasextensiongenesyspurecloud2_0_user** | [**ScimUserExtensions**](ScimUserExtensions.html) |  | [optional] |
+| **urnietfparamsscimschemasextensiongenesyspurecloud2_0_user** | [**ScimUserExtensions**](ScimUserExtensions.html) | The URI of the schema for the Genesys Cloud user. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ScimV2Group.md

@@ -7,7 +7,7 @@ title: ScimV2Group
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **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] |
+| **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. | |
 | **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] |

data/docs/ScimV2SchemaAttribute.md

@@ -8,17 +8,17 @@ title: ScimV2SchemaAttribute
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **name** | **String** | The attribute's name | [optional] |
-| **type** | **String** | The attribute's data type.  Valid values are \"string\", \"boolean\", \"decimal\", \"integer\", \"dateTime\", \"reference\", and \"complex\". | [optional] |
-| **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] |
-| **multi_valued** | **BOOLEAN** | A Boolean value indicating the attribute's plurality. | [optional] |
-| **description** | **String** | The attribute's human-readable description. | [optional] |
-| **required** | **BOOLEAN** | A Boolean value that specifies whether or not the attribute is required. | [optional] |
-| **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] |
-| **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] |
-| **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] |
-| **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] |
-| **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] |
-| **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] |
+| **type** | **String** | The data type of the attribute. | [optional] |
+| **sub_attributes** | [**Array<ScimV2SchemaAttribute>**](ScimV2SchemaAttribute.html) | The list of subattributes for an attribute of the type \"complex\". Uses the same schema as \"attributes\". | [optional] |
+| **multi_valued** | **BOOLEAN** | Indicates whether an attribute contains multiple values. | [optional] |
+| **description** | **String** | The description of the attribute. | [optional] |
+| **required** | **BOOLEAN** | Indicates whether an attribute is required. | [optional] |
+| **canonical_values** | **Array<String>** | The list of standard values that service providers may use. Service providers may ignore unsupported values. | [optional] |
+| **case_exact** | **BOOLEAN** | Indicates whether a string attribute is case-sensitive. If set to \"true\", the server preserves case sensitivity. If set to \"false\", the server may change the case. The server also uses case sensitivity when evaluating filters. See section 3.4.2.2 \"Filtering\" in RFC 7644 for details. | [optional] |
+| **mutability** | **String** | The circumstances under which an attribute can be defined or redefined. The default is \"readWrite\". | [optional] |
+| **returned** | **String** | The circumstances under which an attribute and its values are returned in response to a GET, PUT, POST, or PATCH request. | [optional] |
+| **uniqueness** | **String** | The method by which the service provider enforces the uniqueness of an attribute value. A server can reject a value by returning the HTTP response code 400 (Bad Request). A client can enforce uniqueness to a greater degree than the server provider enforces. For example, a client could make a value unique even though the server has \"uniqueness\" set to \"none\". | [optional] |
+| **reference_types** | **Array<String>** | The list of SCIM resource types that may be referenced. Only applies when \"type\" is set to \"reference\". | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ScimV2SchemaDefinition.md

@@ -7,10 +7,10 @@ title: ScimV2SchemaDefinition
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **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] |
-| **name** | **String** | Schema name. | [optional] |
-| **description** | **String** | Schema description. | [optional] |
-| **attributes** | [**Array<ScimV2SchemaAttribute>**](ScimV2SchemaAttribute.html) | A complex type that defines service provider attributes and their qualities. | [optional] |
+| **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] |
+| **name** | **String** | The name of the schema. | [optional] |
+| **description** | **String** | The description of the schema. | [optional] |
+| **attributes** | [**Array<ScimV2SchemaAttribute>**](ScimV2SchemaAttribute.html) | The list of service provider attributes. | [optional] |
 | **meta** | [**ScimMetadata**](ScimMetadata.html) | The metadata of the SCIM resource. | [optional] |
 {: class="table table-striped"}
 

data/docs/ScimV2SchemaListResponse.md

@@ -10,7 +10,7 @@ title: ScimV2SchemaListResponse
 | **total_results** | **Integer** | The total number of results. | [optional] |
 | **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] |
 | **items_per_page** | **Integer** | The number of resources returned per page. | [optional] |
-| **resources** | [**Array<ScimV2SchemaDefinition>**](ScimV2SchemaDefinition.html) | Resources | [optional] |
+| **resources** | [**Array<ScimV2SchemaDefinition>**](ScimV2SchemaDefinition.html) | The list of requested resources. | [optional] |
 | **schemas** | **Array<String>** | The list of supported schemas. | [optional] |
 {: class="table table-striped"}
 

data/docs/ScimV2User.md

@@ -7,12 +7,12 @@ title: ScimV2User
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **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] |
+| **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] |
 | **active** | **BOOLEAN** | Indicates whether the user's administrative status is active. | [optional] |
-| **user_name** | **String** | The user's PureCloud email address. Must be unique. | [optional] |
+| **user_name** | **String** | The user's Genesys Cloud email address. Must be unique. | [optional] |
 | **display_name** | **String** | The display name of the user. | [optional] |
-| **password** | **String** | The new password for the PureCloud user. Does not return an existing password. | [optional] |
+| **password** | **String** | The new password for the Genesys Cloud user. Does not return an existing password. | [optional] |
 | **title** | **String** | The user's title. | [optional] |
 | **phone_numbers** | [**Array<ScimPhoneNumber>**](ScimPhoneNumber.html) | The list of the user's phone numbers. | [optional] |
 | **emails** | [**Array<ScimEmail>**](ScimEmail.html) | The list of the user's email addresses. | [optional] |
@@ -20,7 +20,7 @@ title: ScimV2User
 | **groups** | [**Array<ScimV2GroupReference>**](ScimV2GroupReference.html) | The list of groups that the user is a member of. | [optional] |
 | **roles** | [**Array<ScimUserRole>**](ScimUserRole.html) | The list of roles assigned to the user. | [optional] |
 | **urnietfparamsscimschemasextensionenterprise2_0_user** | [**ScimV2EnterpriseUser**](ScimV2EnterpriseUser.html) | The URI of the schema for the enterprise user. | [optional] |
-| **urnietfparamsscimschemasextensiongenesyspurecloud2_0_user** | [**ScimUserExtensions**](ScimUserExtensions.html) |  | [optional] |
+| **urnietfparamsscimschemasextensiongenesyspurecloud2_0_user** | [**ScimUserExtensions**](ScimUserExtensions.html) | The URI of the schema for the Genesys Cloud user. | [optional] |
 | **meta** | [**ScimMetadata**](ScimMetadata.html) | The metadata of the SCIM resource. | [optional] |
 {: class="table table-striped"}
 

data/docs/SmsConfig.md

@@ -0,0 +1,15 @@
+---
+title: SmsConfig
+---
+## PureCloud::SmsConfig
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **message_column** | **String** | The Contact List column specifying the message to send to the contact. | |
+| **phone_column** | **String** | The Contact List column specifying the phone number to send a message to. | |
+| **sender_sms_phone_number** | [**SmsPhoneNumberRef**](SmsPhoneNumberRef.html) | A reference to the SMS Phone Number that will be used as the sender of a message. | |
+{: class="table table-striped"}
+
+

data/docs/SmsPhoneNumberRef.md

@@ -0,0 +1,14 @@
+---
+title: SmsPhoneNumberRef
+---
+## PureCloud::SmsPhoneNumberRef
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **phone_number** | **String** | A phone number provisioned for SMS communications in E.164 format. E.g. +13175555555 or +34234234234 | |
+| **self_uri** | **String** |  | [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/VoicemailUserPolicy.md

@@ -11,6 +11,7 @@ title: VoicemailUserPolicy
 | **alert_timeout_seconds** | **Integer** | The number of seconds to ring the user's phone before a call is transfered to voicemail | [optional] |
 | **pin** | **String** | The user's PIN to access their voicemail. This property is only used for updates and never provided otherwise to ensure security | [optional] |
 | **modified_date** | **DateTime** | The date the policy was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **send_email_notifications** | **BOOLEAN** | Whether email notifications are sent to the user when a new voicemail is received | [optional] |
 {: class="table table-striped"}
 
 

data/docs/WfmBusinessUnitReference.md

@@ -0,0 +1,14 @@
+---
+title: WfmBusinessUnitReference
+---
+## PureCloud::WfmBusinessUnitReference
+
+## 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/WfmHistoricalAdherenceResponse.md

@@ -9,6 +9,7 @@ title: WfmHistoricalAdherenceResponse
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The query ID to listen for | [optional] |
 | **download_url** | **String** | Deprecated. Use downloadUrls instead. | [optional] |
+| **download_result** | [**WfmHistoricalAdherenceResultWrapper**](WfmHistoricalAdherenceResultWrapper.html) | Result will always come via downloadUrls; however the schema is included for documentation | [optional] |
 | **download_urls** | **Array<String>** | The uri list to GET the results of the Historical Adherence query. For notification purposes only | [optional] |
 | **query_state** | **String** | The state of the adherence query | [optional] |
 {: class="table table-striped"}

data/docs/WfmHistoricalAdherenceResultWrapper.md

@@ -0,0 +1,15 @@
+---
+title: WfmHistoricalAdherenceResultWrapper
+---
+## PureCloud::WfmHistoricalAdherenceResultWrapper
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entity_id** | **String** | The operation ID of the historical adherence query | [optional] |
+| **data** | [**Array<HistoricalAdherenceQueryResult>**](HistoricalAdherenceQueryResult.html) | The list of historical adherence query results | [optional] |
+| **lookup_id_to_secondary_presence_id** | **Hash<String, String>** | Map of secondary presence lookup ID to corresponding secondary presence ID | [optional] |
+{: class="table table-striped"}
+
+

data/docs/WfmHistoricalDataUploadRequestStatusTopicDateTime.md

@@ -0,0 +1,16 @@
+---
+title: WfmHistoricalDataUploadRequestStatusTopicDateTime
+---
+## PureCloud::WfmHistoricalDataUploadRequestStatusTopicDateTime
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **i_millis** | **Integer** |  | [optional] |
+| **before_now** | **BOOLEAN** |  | [optional] |
+| **after_now** | **BOOLEAN** |  | [optional] |
+| **equal_now** | **BOOLEAN** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md

@@ -0,0 +1,20 @@
+---
+title: WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate
+---
+## PureCloud::WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **request_id** | **String** |  | [optional] |
+| **date_import_started** | [**WfmHistoricalDataUploadRequestStatusTopicDateTime**](WfmHistoricalDataUploadRequestStatusTopicDateTime.html) |  | [optional] |
+| **date_import_ended** | [**WfmHistoricalDataUploadRequestStatusTopicDateTime**](WfmHistoricalDataUploadRequestStatusTopicDateTime.html) |  | [optional] |
+| **date_created** | [**WfmHistoricalDataUploadRequestStatusTopicDateTime**](WfmHistoricalDataUploadRequestStatusTopicDateTime.html) |  | [optional] |
+| **date_modified** | [**WfmHistoricalDataUploadRequestStatusTopicDateTime**](WfmHistoricalDataUploadRequestStatusTopicDateTime.html) |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **error** | **String** |  | [optional] |
+| **active** | **BOOLEAN** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/WfmScheduleReference.md

@@ -0,0 +1,16 @@
+---
+title: WfmScheduleReference
+---
+## PureCloud::WfmScheduleReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **business_unit** | [**WfmBusinessUnitReference**](WfmBusinessUnitReference.html) | A reference to a Workforce Management Business Unit | [optional] |
+| **week_date** | **Date** | The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/lib/purecloudplatformclientv2.rb

@@ -338,6 +338,10 @@ require 'purecloudplatformclientv2/models/cobrowse_media_participant'
 require 'purecloudplatformclientv2/models/cobrowsesession'
 require 'purecloudplatformclientv2/models/command_status'
 require 'purecloudplatformclientv2/models/command_status_entity_listing'
+require 'purecloudplatformclientv2/models/common_campaign'
+require 'purecloudplatformclientv2/models/common_campaign_division_view'
+require 'purecloudplatformclientv2/models/common_campaign_division_view_entity_listing'
+require 'purecloudplatformclientv2/models/common_campaign_entity_listing'
 require 'purecloudplatformclientv2/models/condition'
 require 'purecloudplatformclientv2/models/connect_rate'
 require 'purecloudplatformclientv2/models/consult_transfer'
@@ -962,6 +966,10 @@ require 'purecloudplatformclientv2/models/guest_member_info'
 require 'purecloudplatformclientv2/models/headcount_forecast'
 require 'purecloudplatformclientv2/models/headcount_interval'
 require 'purecloudplatformclientv2/models/help_link'
+require 'purecloudplatformclientv2/models/historical_adherence_actuals'
+require 'purecloudplatformclientv2/models/historical_adherence_day_metrics'
+require 'purecloudplatformclientv2/models/historical_adherence_exception_info'
+require 'purecloudplatformclientv2/models/historical_adherence_query_result'
 require 'purecloudplatformclientv2/models/history_entry'
 require 'purecloudplatformclientv2/models/history_listing'
 require 'purecloudplatformclientv2/models/homer_record'
@@ -1120,6 +1128,10 @@ require 'purecloudplatformclientv2/models/message_media_policy'
 require 'purecloudplatformclientv2/models/message_media_policy_conditions'
 require 'purecloudplatformclientv2/models/message_sticker'
 require 'purecloudplatformclientv2/models/message_sticker_attachment'
+require 'purecloudplatformclientv2/models/messaging_campaign'
+require 'purecloudplatformclientv2/models/messaging_campaign_division_view'
+require 'purecloudplatformclientv2/models/messaging_campaign_division_view_entity_listing'
+require 'purecloudplatformclientv2/models/messaging_campaign_entity_listing'
 require 'purecloudplatformclientv2/models/messaging_integration'
 require 'purecloudplatformclientv2/models/messaging_integration_entity_listing'
 require 'purecloudplatformclientv2/models/messaging_sticker'
@@ -1683,9 +1695,11 @@ require 'purecloudplatformclientv2/models/sms_address'
 require 'purecloudplatformclientv2/models/sms_address_entity_listing'
 require 'purecloudplatformclientv2/models/sms_address_provision'
 require 'purecloudplatformclientv2/models/sms_available_phone_number'
+require 'purecloudplatformclientv2/models/sms_config'
 require 'purecloudplatformclientv2/models/sms_phone_number'
 require 'purecloudplatformclientv2/models/sms_phone_number_entity_listing'
 require 'purecloudplatformclientv2/models/sms_phone_number_provision'
+require 'purecloudplatformclientv2/models/sms_phone_number_ref'
 require 'purecloudplatformclientv2/models/social_expression'
 require 'purecloudplatformclientv2/models/social_handle'
 require 'purecloudplatformclientv2/models/sort_item'
@@ -2009,11 +2023,15 @@ require 'purecloudplatformclientv2/models/wfm_bulk_shift_trade_state_update_noti
 require 'purecloudplatformclientv2/models/wfm_bulk_shift_trade_state_update_notification_topic_local_date'
 require 'purecloudplatformclientv2/models/wfm_bulk_shift_trade_state_update_notification_topic_user_reference'
 require 'purecloudplatformclientv2/models/wfm_bulk_shift_trade_state_update_notification_topic_wfm_versioned_entity_metadata'
+require 'purecloudplatformclientv2/models/wfm_business_unit_reference'
 require 'purecloudplatformclientv2/models/wfm_forecast_modification_interval_offset_value'
 require 'purecloudplatformclientv2/models/wfm_historical_adherence_calculations_complete_topic_wfm_historical_adherence_calculations_comple'
 require 'purecloudplatformclientv2/models/wfm_historical_adherence_query'
 require 'purecloudplatformclientv2/models/wfm_historical_adherence_query_for_users'
 require 'purecloudplatformclientv2/models/wfm_historical_adherence_response'
+require 'purecloudplatformclientv2/models/wfm_historical_adherence_result_wrapper'
+require 'purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_date_time'
+require 'purecloudplatformclientv2/models/wfm_historical_data_upload_request_status_topic_historical_data_upload_request_update'
 require 'purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_data_group'
 require 'purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_data_update'
 require 'purecloudplatformclientv2/models/wfm_intraday_data_update_topic_intraday_forecast_data'
@@ -2030,6 +2048,7 @@ require 'purecloudplatformclientv2/models/wfm_move_agents_complete_topic_wfm_mov
 require 'purecloudplatformclientv2/models/wfm_move_agents_complete_topic_wfm_move_agents_complete'
 require 'purecloudplatformclientv2/models/wfm_move_management_unit_topic_business_unit'
 require 'purecloudplatformclientv2/models/wfm_move_management_unit_topic_move_management_unit_notification'
+require 'purecloudplatformclientv2/models/wfm_schedule_reference'
 require 'purecloudplatformclientv2/models/wfm_schedule_topic_wfm_schedule_notification'
 require 'purecloudplatformclientv2/models/wfm_time_off_request_update_topic_time_off_request_update'
 require 'purecloudplatformclientv2/models/wfm_time_off_request_update_topic_user_reference'

data/lib/purecloudplatformclientv2/api/architect_api.rb

@@ -1153,8 +1153,8 @@ module PureCloud
       fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumedresources" if object_type.nil?
       
       # verify enum value
-      unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(object_type)
-        fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW"
+      unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'NLUDOMAIN', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(object_type)
+        fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW"
       end
       
       
@@ -1267,8 +1267,8 @@ module PureCloud
       fail ArgumentError, "Missing the required parameter 'object_type' when calling ArchitectApi.get_architect_dependencytracking_consumingresources" if object_type.nil?
       
       # verify enum value
-      unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(object_type)
-        fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW"
+      unless ['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'NLUDOMAIN', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(object_type)
+        fail ArgumentError, "invalid value for 'object_type', must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW"
       end
       
       
@@ -1526,8 +1526,8 @@ module PureCloud
       
       
       
-      if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(opts[:'object_type'])
-        fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW'
+      if opts[:'object_type'] && !['ACDLANGUAGE', 'ACDSKILL', 'ACDWRAPUPCODE', 'BOTFLOW', 'BRIDGEACTION', 'COMMONMODULEFLOW', 'COMPOSERSCRIPT', 'CONTACTLIST', 'DATAACTION', 'DATATABLE', 'DIALOGENGINEBOT', 'DIALOGENGINEBOTVERSION', 'DIALOGFLOWAGENT', 'EMAILROUTE', 'EMERGENCYGROUP', 'FLOWACTION', 'FLOWDATATYPE', 'FLOWOUTCOME', 'GROUP', 'INBOUNDCALLFLOW', 'INBOUNDCHATFLOW', 'INBOUNDEMAILFLOW', 'INBOUNDSHORTMESSAGEFLOW', 'INQUEUECALLFLOW', 'IVRCONFIGURATION', 'LANGUAGE', 'LEXBOT', 'LEXBOTALIAS', 'NLUDOMAIN', 'OUTBOUNDCALLFLOW', 'QUEUE', 'RECORDINGPOLICY', 'RESPONSE', 'SCHEDULE', 'SCHEDULEGROUP', 'SECUREACTION', 'SECURECALLFLOW', 'SURVEYINVITEFLOW', 'SYSTEMPROMPT', 'TTSENGINE', 'TTSVOICE', 'USER', 'USERPROMPT', 'WIDGET', 'WORKFLOW'].include?(opts[:'object_type'])
+        fail ArgumentError, 'invalid value for "object_type", must be one of ACDLANGUAGE, ACDSKILL, ACDWRAPUPCODE, BOTFLOW, BRIDGEACTION, COMMONMODULEFLOW, COMPOSERSCRIPT, CONTACTLIST, DATAACTION, DATATABLE, DIALOGENGINEBOT, DIALOGENGINEBOTVERSION, DIALOGFLOWAGENT, EMAILROUTE, EMERGENCYGROUP, FLOWACTION, FLOWDATATYPE, FLOWOUTCOME, GROUP, INBOUNDCALLFLOW, INBOUNDCHATFLOW, INBOUNDEMAILFLOW, INBOUNDSHORTMESSAGEFLOW, INQUEUECALLFLOW, IVRCONFIGURATION, LANGUAGE, LEXBOT, LEXBOTALIAS, NLUDOMAIN, OUTBOUNDCALLFLOW, QUEUE, RECORDINGPOLICY, RESPONSE, SCHEDULE, SCHEDULEGROUP, SECUREACTION, SECURECALLFLOW, SURVEYINVITEFLOW, SYSTEMPROMPT, TTSENGINE, TTSVOICE, USER, USERPROMPT, WIDGET, WORKFLOW'
       end
       
       
@@ -2788,6 +2788,7 @@ module PureCloud
     # @option opts [String] :sort_by Sort by (default to name)
     # @option opts [String] :sort_order Sort order (default to ASC)
     # @option opts [String] :name Name of the Schedule Group to filter by.
+    # @option opts [String] :schedule_ids A comma-delimited list of Schedule IDs to filter by.
     # @return [ScheduleGroupEntityListing]
     def get_architect_schedulegroups(opts = {})
       data, _status_code, _headers = get_architect_schedulegroups_with_http_info(opts)
@@ -2802,6 +2803,7 @@ module PureCloud
     # @option opts [String] :sort_by Sort by
     # @option opts [String] :sort_order Sort order
     # @option opts [String] :name Name of the Schedule Group to filter by.
+    # @option opts [String] :schedule_ids A comma-delimited list of Schedule IDs to filter by.
     # @return [Array<(ScheduleGroupEntityListing, Fixnum, Hash)>] ScheduleGroupEntityListing data, response status code and response headers
     def get_architect_schedulegroups_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -2831,6 +2833,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -2848,6 +2856,7 @@ module PureCloud
       query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
       query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
       query_params[:'name'] = opts[:'name'] if opts[:'name']
+      query_params[:'scheduleIds'] = opts[:'schedule_ids'] if opts[:'schedule_ids']
 
       # header parameters
       header_params = {}