purecloudplatformclientv2 75.1.0 → 79.0.0

data/docs/AuditApi.md

@@ -116,7 +116,8 @@ transaction_id = "transaction_id_example" # String | Transaction ID
 
 opts = { 
   cursor: "cursor_example", # String | Indicates where to resume query results (not required for first page)
-  page_size: 25 # Integer | Page size
+  page_size: 25, # Integer | Page size
+  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
 }
 
 begin
@@ -135,6 +136,7 @@ Name | Type | Description  | Notes
  **transaction_id** | **String**| Transaction ID |  |
  **cursor** | **String**| Indicates where to resume query results (not required for first page) | [optional]  |
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: user |
 {: class="table table-striped"}
 
 

data/docs/AuditLogMessage.md

@@ -8,7 +8,7 @@ title: AuditLogMessage
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | Id of the audit message. | [optional] |
-| **user** | [**AddressableEntityRef**](AddressableEntityRef.html) | User associated with this audit message. | [optional] |
+| **user** | [**DomainEntityRef**](DomainEntityRef.html) | User associated with this audit message. | [optional] |
 | **client** | [**AddressableEntityRef**](AddressableEntityRef.html) | Client associated with this audit message. | [optional] |
 | **remote_ip** | **Array<String>** | List of IP addresses of systems that originated or handled the request. | [optional] |
 | **service_name** | **String** | Name of the service that logged this audit message. | [optional] |

data/docs/AuthorizationApi.md

@@ -16,8 +16,10 @@ Method | Description
 [**get_authorization_divisions**](AuthorizationApi.html#get_authorization_divisions) | Retrieve a list of all divisions defined for the organization
 [**get_authorization_divisions_home**](AuthorizationApi.html#get_authorization_divisions_home) | Retrieve the home division for the organization.
 [**get_authorization_divisions_limit**](AuthorizationApi.html#get_authorization_divisions_limit) | Returns the maximum allowed number of divisions.
-[**get_authorization_divisionspermitted_me**](AuthorizationApi.html#get_authorization_divisionspermitted_me) | Returns whether or not current user can perform the specified action(s).
-[**get_authorization_divisionspermitted_subject_id**](AuthorizationApi.html#get_authorization_divisionspermitted_subject_id) | Returns whether or not specified user can perform the specified action(s).
+[**get_authorization_divisionspermitted_me**](AuthorizationApi.html#get_authorization_divisionspermitted_me) | Returns which divisions the current user has the given permission in.
+[**get_authorization_divisionspermitted_paged_me**](AuthorizationApi.html#get_authorization_divisionspermitted_paged_me) | Returns which divisions the current user has the given permission in.
+[**get_authorization_divisionspermitted_paged_subject_id**](AuthorizationApi.html#get_authorization_divisionspermitted_paged_subject_id) | Returns which divisions the specified user has the given permission in.
+[**get_authorization_divisionspermitted_subject_id**](AuthorizationApi.html#get_authorization_divisionspermitted_subject_id) | Returns which divisions the specified user has the given permission in.
 [**get_authorization_permissions**](AuthorizationApi.html#get_authorization_permissions) | Get all permissions.
 [**get_authorization_products**](AuthorizationApi.html#get_authorization_products) | Get the list of enabled products
 [**get_authorization_role**](AuthorizationApi.html#get_authorization_role) | Get a single organization role.
@@ -582,11 +584,11 @@ This endpoint does not need any parameter.
 
 ## [**Array<AuthzDivision>**](AuthzDivision.html) get_authorization_divisionspermitted_me(permission, opts)
 
+<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
 
+Returns which divisions the current user has the given permission in.
 
-Returns whether or not current user can perform the specified action(s).
-
-
+This route is deprecated, use authorization/divisionspermitted/paged/me instead.
 
 Wraps GET /api/v2/authorization/divisionspermitted/me 
 
@@ -618,7 +620,7 @@ opts = {
 }
 
 begin
-  #Returns whether or not current user can perform the specified action(s).
+  #Returns which divisions the current user has the given permission in.
   result = api_instance.get_authorization_divisionspermitted_me(permission, opts)
   p result
 rescue PureCloud::ApiError => e
@@ -646,15 +648,158 @@ Name | Type | Description  | Notes
 
 
 
+<a name="get_authorization_divisionspermitted_paged_me"></a>
+
+## [**DivsPermittedEntityListing**](DivsPermittedEntityListing.html) get_authorization_divisionspermitted_paged_me(permission, opts)
+
+
+
+Returns which divisions the current user has the given permission in.
+
+
+
+Wraps GET /api/v2/authorization/divisionspermitted/paged/me 
+
+Requires NO permissions: 
+
+
+
+### 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::AuthorizationApi.new
+
+permission = "permission_example" # String | The permission string, including the object to access, e.g. routing:queue:view
+
+opts = { 
+  page_number: 1, # Integer | Page number
+  page_size: 25 # Integer | Page size
+}
+
+begin
+  #Returns which divisions the current user has the given permission in.
+  result = api_instance.get_authorization_divisionspermitted_paged_me(permission, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling AuthorizationApi->get_authorization_divisionspermitted_paged_me: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **permission** | **String**| The permission string, including the object to access, e.g. routing:queue:view |  |
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**DivsPermittedEntityListing**](DivsPermittedEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_authorization_divisionspermitted_paged_subject_id"></a>
+
+## [**DivsPermittedEntityListing**](DivsPermittedEntityListing.html) get_authorization_divisionspermitted_paged_subject_id(subject_id, permission, opts)
+
+
+
+Returns which divisions the specified user has the given permission in.
+
+
+
+Wraps GET /api/v2/authorization/divisionspermitted/paged/{subjectId} 
+
+Requires NO permissions: 
+
+
+
+### 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::AuthorizationApi.new
+
+subject_id = "subject_id_example" # String | Subject ID (user or group)
+
+permission = "permission_example" # String | The permission string, including the object to access, e.g. routing:queue:view
+
+opts = { 
+  page_number: 1, # Integer | Page number
+  page_size: 25 # Integer | Page size
+}
+
+begin
+  #Returns which divisions the specified user has the given permission in.
+  result = api_instance.get_authorization_divisionspermitted_paged_subject_id(subject_id, permission, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling AuthorizationApi->get_authorization_divisionspermitted_paged_subject_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subject_id** | **String**| Subject ID (user or group) |  |
+ **permission** | **String**| The permission string, including the object to access, e.g. routing:queue:view |  |
+ **page_number** | **Integer**| Page number | [optional] [default to 1] |
+ **page_size** | **Integer**| Page size | [optional] [default to 25] |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**DivsPermittedEntityListing**](DivsPermittedEntityListing.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_authorization_divisionspermitted_subject_id"></a>
 
 ## [**Array&lt;AuthzDivision&gt;**](AuthzDivision.html) get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
 
 <span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
 
-Returns whether or not specified user can perform the specified action(s).
-
+Returns which divisions the specified user has the given permission in.
 
+This route is deprecated, use authorization/divisionspermitted/paged/{subjectId} instead.
 
 Wraps GET /api/v2/authorization/divisionspermitted/{subjectId} 
 
@@ -688,7 +833,7 @@ opts = {
 }
 
 begin
-  #Returns whether or not specified user can perform the specified action(s).
+  #Returns which divisions the specified user has the given permission in.
   result = api_instance.get_authorization_divisionspermitted_subject_id(subject_id, permission, opts)
   p result
 rescue PureCloud::ApiError => e

data/docs/AvailableTopic.md

@@ -9,8 +9,10 @@ title: AvailableTopic
 |------------ | ------------- | ------------- | -------------|
 | **description** | **String** |  | [optional] |
 | **id** | **String** |  | [optional] |
-| **requires_permissions** | **Array<String>** |  | [optional] |
+| **requires_permissions** | **Array<String>** | Permissions required to subscribe to the topic | [optional] |
 | **schema** | **Hash<String, Object>** |  | [optional] |
+| **requires_current_user** | **BOOLEAN** | True if the topic user ID is required to match the subscribing user ID | [optional] |
+| **requires_current_user_or_permission** | **BOOLEAN** | True if permissions are only required when the topic user ID does not match the subscribing user ID | [optional] |
 {: class="table table-striped"}
 
 

data/docs/BuAgentScheduleActivity.md

@@ -0,0 +1,18 @@
+---
+title: BuAgentScheduleActivity
+---
+## PureCloud::BuAgentScheduleActivity
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **start_date** | **DateTime** | The start date/time of this activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **length_minutes** | **Integer** | The length of this activity in minutes | [optional] |
+| **description** | **String** | The description of this activity | [optional] |
+| **activity_code_id** | **String** | The ID of the activity code associated with this activity | [optional] |
+| **paid** | **BOOLEAN** | Whether this activity is paid | [optional] |
+| **time_off_request_id** | **String** | The ID of the time off request associated with this activity, if applicable | [optional] |
+{: class="table table-striped"}
+
+

data/docs/BuAgentSchedulePublishedScheduleReference.md

@@ -0,0 +1,16 @@
+---
+title: BuAgentSchedulePublishedScheduleReference
+---
+## PureCloud::BuAgentSchedulePublishedScheduleReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [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] |
+| **week_count** | **Integer** | The number of weeks encompassed by the schedule | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/BuAgentScheduleSearchResponse.md

@@ -0,0 +1,15 @@
+---
+title: BuAgentScheduleSearchResponse
+---
+## PureCloud::BuAgentScheduleSearchResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **user** | [**UserReference**](UserReference.html) | The user to whom this agent schedule applies | [optional] |
+| **shifts** | [**Array<BuAgentScheduleShift>**](BuAgentScheduleShift.html) | The shift definitions for this agent schedule | [optional] |
+| **full_day_time_off_markers** | [**Array<BuFullDayTimeOffMarker>**](BuFullDayTimeOffMarker.html) | Full day time off markers which apply to this agent schedule | [optional] |
+{: class="table table-striped"}
+
+

data/docs/BuAgentScheduleShift.md

@@ -0,0 +1,18 @@
+---
+title: BuAgentScheduleShift
+---
+## PureCloud::BuAgentScheduleShift
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **start_date** | **DateTime** | The start date of this shift. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **length_minutes** | **Integer** | The length of this shift in minutes | [optional] |
+| **activities** | [**Array<BuAgentScheduleActivity>**](BuAgentScheduleActivity.html) | The activities associated with this shift | [optional] |
+| **manually_edited** | **BOOLEAN** | Whether this shift was manually edited. This is only set by clients and is used for rescheduling | [optional] |
+| **schedule** | [**BuScheduleReference**](BuScheduleReference.html) | The schedule to which this shift belongs | [optional] |
+{: class="table table-striped"}
+
+

data/docs/BuAgentSchedulesSearchResponse.md

@@ -0,0 +1,15 @@
+---
+title: BuAgentSchedulesSearchResponse
+---
+## PureCloud::BuAgentSchedulesSearchResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **agent_schedules** | [**Array<BuAgentScheduleSearchResponse>**](BuAgentScheduleSearchResponse.html) | The requested agent schedules | [optional] |
+| **business_unit_time_zone** | **String** | The time zone configured for the business unit to which this schedule applies | [optional] |
+| **published_schedules** | [**Array<BuAgentSchedulePublishedScheduleReference>**](BuAgentSchedulePublishedScheduleReference.html) | References to all published week schedules overlapping the start/end date query parameters | [optional] |
+{: class="table table-striped"}
+
+

data/docs/BuAsyncAgentSchedulesSearchResponse.md

@@ -0,0 +1,17 @@
+---
+title: BuAsyncAgentSchedulesSearchResponse
+---
+## PureCloud::BuAsyncAgentSchedulesSearchResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **status** | **String** | The status of the operation | [optional] |
+| **operation_id** | **String** | The ID for the operation | [optional] |
+| **result** | [**BuAgentSchedulesSearchResponse**](BuAgentSchedulesSearchResponse.html) | The result of the operation.  Null unless status == Complete | [optional] |
+| **progress** | **Integer** | Percent progress for the operation | [optional] |
+| **download_url** | **String** | The URL from which to download the result if it is too large to pass directly | [optional] |
+{: class="table table-striped"}
+
+

data/docs/BuFullDayTimeOffMarker.md

@@ -0,0 +1,18 @@
+---
+title: BuFullDayTimeOffMarker
+---
+## PureCloud::BuFullDayTimeOffMarker
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **business_unit_date** | **Date** | The date of the time off marker, interpreted in the business unit's time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | [optional] |
+| **length_minutes** | **Integer** | The length of the time off marker in minutes | [optional] |
+| **description** | **String** | The description of the time off marker | [optional] |
+| **activity_code_id** | **String** | The ID of the activity code associated with the time off marker | [optional] |
+| **paid** | **BOOLEAN** | Whether the time off marker is paid | [optional] |
+| **time_off_request_id** | **String** | The ID of the time off request | [optional] |
+{: class="table table-striped"}
+
+

data/docs/BuScheduleReference.md

@@ -0,0 +1,15 @@
+---
+title: BuScheduleReference
+---
+## PureCloud::BuScheduleReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [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/docs/Call.md

@@ -17,7 +17,7 @@ title: Call
 | **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] |
 | **recording_id** | **String** | A globally unique identifier for the recording associated with this call. | [optional] |
 | **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's call, divided into activity segments. | [optional] |
-| **error_info** | [**ErrorBody**](ErrorBody.html) |  | [optional] |
+| **error_info** | [**ErrorInfo**](ErrorInfo.html) |  | [optional] |
 | **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
 | **start_hold_time** | **DateTime** | The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **document_id** | **String** | If call is an outbound fax of a document from content management, then this is the id in content management. | [optional] |

data/docs/CallBasic.md

@@ -17,7 +17,7 @@ title: CallBasic
 | **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] |
 | **recording_id** | **String** | A globally unique identifier for the recording associated with this call. | [optional] |
 | **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's call, divided into activity segments. | [optional] |
-| **error_info** | [**ErrorBody**](ErrorBody.html) |  | [optional] |
+| **error_info** | [**ErrorInfo**](ErrorInfo.html) |  | [optional] |
 | **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
 | **start_hold_time** | **DateTime** | The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **document_id** | **String** | If call is an outbound fax of a document from content management, then this is the id in content management. | [optional] |

data/docs/CallMediaParticipant.md

@@ -24,7 +24,7 @@ title: CallMediaParticipant
 | **user** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud user for this participant. | [optional] |
 | **queue** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud queue for this participant. | [optional] |
 | **attributes** | **Hash<String, String>** | A list of ad-hoc attributes for the participant. | [optional] |
-| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
+| **error_info** | [**ErrorInfo**](ErrorInfo.html) | If the conversation ends in error, contains additional error details. | [optional] |
 | **script** | [**DomainEntityRef**](DomainEntityRef.html) | The Engage script that should be used by this participant. | [optional] |
 | **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
 | **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |

data/docs/CallbackMediaParticipant.md

@@ -24,7 +24,7 @@ title: CallbackMediaParticipant
 | **user** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud user for this participant. | [optional] |
 | **queue** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud queue for this participant. | [optional] |
 | **attributes** | **Hash<String, String>** | A list of ad-hoc attributes for the participant. | [optional] |
-| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
+| **error_info** | [**ErrorInfo**](ErrorInfo.html) | If the conversation ends in error, contains additional error details. | [optional] |
 | **script** | [**DomainEntityRef**](DomainEntityRef.html) | The Engage script that should be used by this participant. | [optional] |
 | **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
 | **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |

data/docs/CampaignProgress.md

@@ -9,7 +9,8 @@ title: CampaignProgress
 |------------ | ------------- | ------------- | -------------|
 | **campaign** | [**DomainEntityRef**](DomainEntityRef.html) | Identifier of the campaign | |
 | **contact_list** | [**DomainEntityRef**](DomainEntityRef.html) | Identifier of the contact list | |
-| **number_of_contacts_called** | **Integer** | Number of contacts processed during the campaign | [optional] |
+| **number_of_contacts_called** | **Integer** | Number of contacts called during the campaign | [optional] |
+| **number_of_contacts_messaged** | **Integer** | Number of contacts messaged during the campaign | [optional] |
 | **total_number_of_contacts** | **Integer** | Total number of contacts in the campaign | [optional] |
 | **percentage** | **Integer** | Percentage of contacts processed during the campaign | [optional] |
 {: class="table table-striped"}

data/docs/ChatMediaParticipant.md

@@ -24,7 +24,7 @@ title: ChatMediaParticipant
 | **user** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud user for this participant. | [optional] |
 | **queue** | [**DomainEntityRef**](DomainEntityRef.html) | The PureCloud queue for this participant. | [optional] |
 | **attributes** | **Hash<String, String>** | A list of ad-hoc attributes for the participant. | [optional] |
-| **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
+| **error_info** | [**ErrorInfo**](ErrorInfo.html) | If the conversation ends in error, contains additional error details. | [optional] |
 | **script** | [**DomainEntityRef**](DomainEntityRef.html) | The Engage script that should be used by this participant. | [optional] |
 | **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
 | **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |