purecloudplatformclientv2 91.0.0 → 96.0.0

data/docs/ArrayNode.md

@@ -12,11 +12,8 @@ title: ArrayNode
 | **number** | **BOOLEAN** |  | [optional] |
 | **boolean** | **BOOLEAN** |  | [optional] |
 | **object** | **BOOLEAN** |  | [optional] |
-| **value_node** | **BOOLEAN** |  | [optional] |
-| **container_node** | **BOOLEAN** |  | [optional] |
-| **missing_node** | **BOOLEAN** |  | [optional] |
-| **pojo** | **BOOLEAN** |  | [optional] |
 | **floating_point_number** | **BOOLEAN** |  | [optional] |
+| **pojo** | **BOOLEAN** |  | [optional] |
 | **integral_number** | **BOOLEAN** |  | [optional] |
 | **short** | **BOOLEAN** |  | [optional] |
 | **int** | **BOOLEAN** |  | [optional] |
@@ -26,6 +23,9 @@ title: ArrayNode
 | **big_integer** | **BOOLEAN** |  | [optional] |
 | **textual** | **BOOLEAN** |  | [optional] |
 | **binary** | **BOOLEAN** |  | [optional] |
+| **value_node** | **BOOLEAN** |  | [optional] |
+| **container_node** | **BOOLEAN** |  | [optional] |
+| **missing_node** | **BOOLEAN** |  | [optional] |
 | **array** | **BOOLEAN** |  | [optional] |
 | **null** | **BOOLEAN** |  | [optional] |
 {: class="table table-striped"}

data/docs/AuditApi.md

@@ -8,12 +8,73 @@ All URIs are relative to *https://api.mypurecloud.com*
 
 Method | Description
 ------------- | ------------- | -------------
+[**get_audits_query_realtime_servicemapping**](AuditApi.html#get_audits_query_realtime_servicemapping) | Get service mapping information used in audits.
 [**get_audits_query_servicemapping**](AuditApi.html#get_audits_query_servicemapping) | Get service mapping information used in audits.
 [**get_audits_query_transaction_id**](AuditApi.html#get_audits_query_transaction_id) | Get status of audit query execution
 [**get_audits_query_transaction_id_results**](AuditApi.html#get_audits_query_transaction_id_results) | Get results of audit query
 [**post_audits_query**](AuditApi.html#post_audits_query) | Create audit query execution
+[**post_audits_query_realtime**](AuditApi.html#post_audits_query_realtime) | This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
 {: class="table table-striped"}
 
+<a name="get_audits_query_realtime_servicemapping"></a>
+
+## [**AuditQueryServiceMapping**](AuditQueryServiceMapping.html) get_audits_query_realtime_servicemapping
+
+
+
+Get service mapping information used in audits.
+
+
+
+Wraps GET /api/v2/audits/query/realtime/servicemapping 
+
+Requires ALL permissions: 
+
+* audits:audit: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::AuditApi.new
+
+begin
+  #Get service mapping information used in audits.
+  result = api_instance.get_audits_query_realtime_servicemapping
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling AuditApi->get_audits_query_realtime_servicemapping: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AuditQueryServiceMapping**](AuditQueryServiceMapping.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_audits_query_servicemapping"></a>
 
 ## [**AuditQueryServiceMapping**](AuditQueryServiceMapping.html) get_audits_query_servicemapping
@@ -276,3 +337,72 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_audits_query_realtime"></a>
+
+## [**AuditRealtimeQueryResultsResponse**](AuditRealtimeQueryResultsResponse.html) post_audits_query_realtime(body, opts)
+
+
+
+This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
+
+
+
+Wraps POST /api/v2/audits/query/realtime 
+
+Requires ALL permissions: 
+
+* audits:audit: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::AuditApi.new
+
+body = PureCloud::AuditRealtimeQueryRequest.new # AuditRealtimeQueryRequest | query
+
+opts = { 
+  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
+}
+
+begin
+  #This endpoint will only retrieve 7 days worth of audits for certain services. Please use /query to get a full list and older audits.
+  result = api_instance.post_audits_query_realtime(body, opts)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling AuditApi->post_audits_query_realtime: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AuditRealtimeQueryRequest**](AuditRealtimeQueryRequest.html)| query |  |
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: user |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**AuditRealtimeQueryResultsResponse**](AuditRealtimeQueryResultsResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AuditRealtimeQueryRequest.md

@@ -0,0 +1,18 @@
+---
+title: AuditRealtimeQueryRequest
+---
+## PureCloud::AuditRealtimeQueryRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** | Date and time range of data to query. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
+| **service_name** | **String** | Name of the service to query audits for. | |
+| **filters** | [**Array<AuditQueryFilter>**](AuditQueryFilter.html) | Additional filters for the query. | [optional] |
+| **sort** | [**Array<AuditQuerySort>**](AuditQuerySort.html) | Sort parameter for the query. | [optional] |
+| **page_number** | **Integer** | Page number | [optional] |
+| **page_size** | **Integer** | Page size | [optional] |
+{: class="table table-striped"}
+
+

data/docs/AuditRealtimeQueryResultsResponse.md

@@ -0,0 +1,17 @@
+---
+title: AuditRealtimeQueryResultsResponse
+---
+## PureCloud::AuditRealtimeQueryResultsResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<AuditLogMessage>**](AuditLogMessage.html) |  | [optional] |
+| **page_size** | **Integer** |  | [optional] |
+| **page_number** | **Integer** |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+| **page_count** | **Integer** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/AvailableTopic.md

@@ -13,6 +13,7 @@ title: AvailableTopic
 | **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] |
+| **transports** | **Array<String>** | Transports that support events for the topic | [optional] |
 {: class="table table-striped"}
 
 

data/docs/Biography.md

@@ -11,6 +11,7 @@ title: Biography
 | **interests** | **Array<String>** |  | [optional] |
 | **hobbies** | **Array<String>** |  | [optional] |
 | **spouse** | **String** |  | [optional] |
+| **education** | [**Array<Education>**](Education.html) | User education details | [optional] |
 {: class="table table-striped"}
 
 

data/docs/BuAgentSchedulesQueryResponse.md

@@ -8,6 +8,7 @@ title: BuAgentSchedulesQueryResponse
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **agent_schedules** | [**Array<BuAgentScheduleQueryResponse>**](BuAgentScheduleQueryResponse.html) | The requested agent schedules | [optional] |
+| **business_unit_time_zone** | **String** | The time zone configured for the business unit to which these schedules apply | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ButtonComponent.md

@@ -0,0 +1,16 @@
+---
+title: ButtonComponent
+---
+## PureCloud::ButtonComponent
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | An ID assigned to this component | [optional] |
+| **text** | **String** | Text to show inside the button | [optional] |
+| **title** | **String** | Tooltip text to show when hovering over the button | [optional] |
+| **actions** | [**ContentActions**](ContentActions.html) | User actions available on the content. All actions are optional and all actions are executed simultaneously. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/Call.md

@@ -33,6 +33,7 @@ title: Call
 | **_self** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
 | **other** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
 | **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
+| **after_call_work** | [**AfterCallWork**](AfterCallWork.html) | After-call work for the communication. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/CallBasic.md

@@ -33,6 +33,7 @@ title: CallBasic
 | **_self** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
 | **other** | [**Address**](Address.html) | Address and name data for a call endpoint. | [optional] |
 | **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
+| **after_call_work** | [**AfterCallWork**](AfterCallWork.html) | After-call work for the communication. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/Callback.md

@@ -30,6 +30,7 @@ title: Callback
 | **provider** | **String** | The source provider for the callback. | [optional] |
 | **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
 | **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
+| **after_call_work** | [**AfterCallWork**](AfterCallWork.html) | After-call work for the communication. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/CallbackBasic.md

@@ -30,6 +30,7 @@ title: CallbackBasic
 | **provider** | **String** | The source provider for the callback. | [optional] |
 | **peer_id** | **String** | The id of the peer communication corresponding to a matching leg for this communication. | [optional] |
 | **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
+| **after_call_work** | [**AfterCallWork**](AfterCallWork.html) | After-call work for the communication. | [optional] |
 {: class="table table-striped"}
 
 

data/docs/CoachingApi.md

@@ -24,11 +24,12 @@ Method | Description
 [**patch_coaching_notification**](CoachingApi.html#patch_coaching_notification) | Update an existing notification.
 [**post_coaching_appointment_annotations**](CoachingApi.html#post_coaching_appointment_annotations) | Create a new annotation.
 [**post_coaching_appointments**](CoachingApi.html#post_coaching_appointments) | Create a new appointment
+[**post_coaching_appointments_aggregates_query**](CoachingApi.html#post_coaching_appointments_aggregates_query) | Retrieve aggregated appointment data
 {: class="table table-striped"}
 
 <a name="delete_coaching_appointment"></a>
 
-##  delete_coaching_appointment(appointment_id)
+## [**CoachingAppointmentReference**](CoachingAppointmentReference.html) delete_coaching_appointment(appointment_id)
 
 
 
@@ -40,7 +41,7 @@ Wraps DELETE /api/v2/coaching/appointments/{appointmentId}
 
 Requires ANY permissions: 
 
-* COACHING:APPOINTMENT:DELETE
+* coaching:appointment:delete
 
 
 ### Example
@@ -65,7 +66,8 @@ appointment_id = "appointment_id_example" # String | The ID of the coaching appo
 
 begin
   #Delete an existing appointment
-  api_instance.delete_coaching_appointment(appointment_id)
+  result = api_instance.delete_coaching_appointment(appointment_id)
+  p result
 rescue PureCloud::ApiError => e
   puts "Exception when calling CoachingApi->delete_coaching_appointment: #{e}"
 end
@@ -81,7 +83,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-nil (empty response body)
+[**CoachingAppointmentReference**](CoachingAppointmentReference.html)
 
 ### HTTP request headers
 
@@ -104,8 +106,8 @@ Wraps DELETE /api/v2/coaching/appointments/{appointmentId}/annotations/{annotati
 
 Requires ANY permissions: 
 
-* COACHING:ANNOTATION:DELETE
-* COACHING:PRIVATEANNOTATION:DELETE
+* coaching:annotation:delete
+* coaching:privateAnnotation:delete
 
 
 ### Example
@@ -172,7 +174,7 @@ Wraps GET /api/v2/coaching/appointments/{appointmentId}
 
 Requires ANY permissions: 
 
-* COACHING:APPOINTMENT:VIEW
+* coaching:appointment:view
 
 
 ### Example
@@ -237,8 +239,8 @@ Wraps GET /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationI
 
 Requires ANY permissions: 
 
-* COACHING:ANNOTATION:VIEW
-* COACHING:PRIVATEANNOTATION:VIEW
+* coaching:annotation:view
+* coaching:privateAnnotation:view
 
 
 ### Example
@@ -306,8 +308,8 @@ Wraps GET /api/v2/coaching/appointments/{appointmentId}/annotations
 
 Requires ANY permissions: 
 
-* COACHING:ANNOTATION:VIEW
-* COACHING:PRIVATEANNOTATION:VIEW
+* coaching:annotation:view
+* coaching:privateAnnotation:view
 
 
 ### Example
@@ -378,7 +380,7 @@ Wraps GET /api/v2/coaching/appointments/{appointmentId}/statuses
 
 Requires ANY permissions: 
 
-* COACHING:APPOINTMENTSTATUS:VIEW
+* coaching:appointmentStatus:view
 
 
 ### Example
@@ -449,7 +451,7 @@ Wraps GET /api/v2/coaching/appointments
 
 Requires ANY permissions: 
 
-* COACHING:APPOINTMENT:VIEW
+* coaching:appointment:view
 
 
 ### Example
@@ -472,12 +474,15 @@ api_instance = PureCloud::CoachingApi.new
 user_ids = ["user_ids_example"] # Array<String> | The user IDs for which to retrieve appointments
 
 opts = { 
-  interval: "interval_example", # String | Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
+  interval: "interval_example", # String | Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
   page_number: 1, # Integer | Page number
   page_size: 25, # Integer | Page size
   statuses: ["statuses_example"], # Array<String> | Appointment Statuses to filter by
   facilitator_ids: ["facilitator_ids_example"], # Array<String> | The facilitator IDs for which to retrieve appointments
-  sort_order: "sort_order_example" # String | Sort (by due date) either Asc or Desc
+  sort_order: "sort_order_example", # String | Sort (by due date) either Asc or Desc
+  relationships: ["relationships_example"], # Array<String> | Relationships to filter by
+  completion_interval: "completion_interval_example", # String | Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
+  overdue: "overdue_example" # String | Overdue status to filter by
 }
 
 begin
@@ -494,12 +499,15 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **user_ids** | [**Array&lt;String&gt;**](String.html)| The user IDs for which to retrieve appointments |  |
- **interval** | **String**| Interval string; format is ISO-8601. Separate start and end times with forward slash &#39;/&#39; | [optional]  |
+ **interval** | **String**| Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional]  |
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
  **statuses** | [**Array&lt;String&gt;**](String.html)| Appointment Statuses to filter by | [optional] <br />**Values**: Scheduled, InProgress, Completed, InvalidSchedule |
  **facilitator_ids** | [**Array&lt;String&gt;**](String.html)| The facilitator IDs for which to retrieve appointments | [optional]  |
  **sort_order** | **String**| Sort (by due date) either Asc or Desc | [optional] <br />**Values**: Desc, Asc |
+ **relationships** | [**Array&lt;String&gt;**](String.html)| Relationships to filter by | [optional] <br />**Values**: Creator, Facilitator, Attendee |
+ **completion_interval** | **String**| Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional]  |
+ **overdue** | **String**| Overdue status to filter by | [optional] <br />**Values**: Any, True, False |
 {: class="table table-striped"}
 
 
@@ -548,12 +556,15 @@ end
 api_instance = PureCloud::CoachingApi.new
 
 opts = { 
-  interval: "interval_example", # String | Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
+  interval: "interval_example", # String | Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
   page_number: 1, # Integer | Page number
   page_size: 25, # Integer | Page size
   statuses: ["statuses_example"], # Array<String> | Appointment Statuses to filter by
   facilitator_ids: ["facilitator_ids_example"], # Array<String> | The facilitator IDs for which to retrieve appointments
-  sort_order: "sort_order_example" # String | Sort (by due date) either Asc or Desc
+  sort_order: "sort_order_example", # String | Sort (by due date) either Asc or Desc
+  relationships: ["relationships_example"], # Array<String> | Relationships to filter by
+  completion_interval: "completion_interval_example", # String | Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
+  overdue: "overdue_example" # String | Overdue status to filter by
 }
 
 begin
@@ -569,12 +580,15 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **interval** | **String**| Interval string; format is ISO-8601. Separate start and end times with forward slash &#39;/&#39; | [optional]  |
+ **interval** | **String**| Interval to filter data by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional]  |
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
  **statuses** | [**Array&lt;String&gt;**](String.html)| Appointment Statuses to filter by | [optional] <br />**Values**: Scheduled, InProgress, Completed |
  **facilitator_ids** | [**Array&lt;String&gt;**](String.html)| The facilitator IDs for which to retrieve appointments | [optional]  |
  **sort_order** | **String**| Sort (by due date) either Asc or Desc | [optional] <br />**Values**: Desc, Asc |
+ **relationships** | [**Array&lt;String&gt;**](String.html)| Relationships to filter by | [optional] <br />**Values**: Creator, Facilitator, Attendee |
+ **completion_interval** | **String**| Appointment completion start and end to filter by. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional]  |
+ **overdue** | **String**| Overdue status to filter by | [optional] <br />**Values**: Any, True, False |
 {: class="table table-striped"}
 
 
@@ -591,7 +605,7 @@ Name | Type | Description  | Notes
 
 <a name="get_coaching_notification"></a>
 
-## [**CoachingNotification**](CoachingNotification.html) get_coaching_notification(notification_id)
+## [**CoachingNotification**](CoachingNotification.html) get_coaching_notification(notification_id, opts)
 
 
 
@@ -603,7 +617,7 @@ Wraps GET /api/v2/coaching/notifications/{notificationId}
 
 Requires ANY permissions: 
 
-* COACHING:NOTIFICATION:VIEW
+* coaching:notification:view
 
 
 ### Example
@@ -625,10 +639,13 @@ api_instance = PureCloud::CoachingApi.new
 
 notification_id = "notification_id_example" # String | The ID of the notification.
 
+opts = { 
+  expand: ["expand_example"] # Array<String> | Indicates a field in the response which should be expanded.
+}
 
 begin
   #Get an existing notification
-  result = api_instance.get_coaching_notification(notification_id)
+  result = api_instance.get_coaching_notification(notification_id, opts)
   p result
 rescue PureCloud::ApiError => e
   puts "Exception when calling CoachingApi->get_coaching_notification: #{e}"
@@ -640,6 +657,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **notification_id** | **String**| The ID of the notification. |  |
+ **expand** | [**Array&lt;String&gt;**](String.html)| Indicates a field in the response which should be expanded. | [optional] <br />**Values**: appointment |
 {: class="table table-striped"}
 
 
@@ -689,7 +707,8 @@ api_instance = PureCloud::CoachingApi.new
 
 opts = { 
   page_number: 1, # Integer | Page number
-  page_size: 25 # Integer | Page size
+  page_size: 25, # Integer | Page size
+  expand: ["expand_example"] # Array<String> | Indicates a field in the response which should be expanded.
 }
 
 begin
@@ -707,6 +726,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
+ **expand** | [**Array&lt;String&gt;**](String.html)| Indicates a field in the response which should be expanded. | [optional] <br />**Values**: appointment |
 {: class="table table-striped"}
 
 
@@ -735,7 +755,7 @@ Wraps PATCH /api/v2/coaching/appointments/{appointmentId}
 
 Requires ANY permissions: 
 
-* COACHING:APPOINTMENT:EDIT
+* coaching:appointment:edit
 
 
 ### Example
@@ -803,8 +823,8 @@ Wraps PATCH /api/v2/coaching/appointments/{appointmentId}/annotations/{annotatio
 
 Requires ANY permissions: 
 
-* COACHING:ANNOTATION:EDIT
-* COACHING:PRIVATEANNOTATION:EDIT
+* coaching:annotation:edit
+* coaching:privateAnnotation:edit
 
 
 ### Example
@@ -875,7 +895,7 @@ Wraps PATCH /api/v2/coaching/appointments/{appointmentId}/status
 
 Requires ANY permissions: 
 
-* COACHING:APPOINTMENTSTATUS:EDIT
+* coaching:appointmentStatus:edit
 
 
 ### Example
@@ -1010,8 +1030,8 @@ Wraps POST /api/v2/coaching/appointments/{appointmentId}/annotations
 
 Requires ANY permissions: 
 
-* COACHING:ANNOTATION:ADD
-* COACHING:PRIVATEANNOTATION:ADD
+* coaching:annotation:add
+* coaching:privateAnnotation:add
 
 
 ### Example
@@ -1079,7 +1099,7 @@ Wraps POST /api/v2/coaching/appointments
 
 Requires ANY permissions: 
 
-* COACHING:APPOINTMENT:ADD
+* coaching:appointment:add
 
 
 ### Example
@@ -1130,3 +1150,68 @@ Name | Type | Description  | Notes
 
 
 
+<a name="post_coaching_appointments_aggregates_query"></a>
+
+## [**CoachingAppointmentAggregateResponse**](CoachingAppointmentAggregateResponse.html) post_coaching_appointments_aggregates_query(body)
+
+
+
+Retrieve aggregated appointment data
+
+
+
+Wraps POST /api/v2/coaching/appointments/aggregates/query 
+
+Requires ANY permissions: 
+
+* coaching:appointment: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::CoachingApi.new
+
+body = PureCloud::CoachingAppointmentAggregateRequest.new # CoachingAppointmentAggregateRequest | Aggregate Request
+
+
+begin
+  #Retrieve aggregated appointment data
+  result = api_instance.post_coaching_appointments_aggregates_query(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling CoachingApi->post_coaching_appointments_aggregates_query: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CoachingAppointmentAggregateRequest**](CoachingAppointmentAggregateRequest.html)| Aggregate Request |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**CoachingAppointmentAggregateResponse**](CoachingAppointmentAggregateResponse.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+