purecloudplatformclientv2 62.0.0 → 66.0.0

data/docs/TelephonyProvidersEdgeApi.md

@@ -74,7 +74,7 @@ Method | Description
 [**get_telephony_providers_edges_physicalinterfaces**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_physicalinterfaces) | Get physical interfaces for edges.
 [**get_telephony_providers_edges_site**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_site) | Get a Site by ID.
 [**get_telephony_providers_edges_site_numberplan**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_site_numberplan) | Get a Number Plan by ID.
-[**get_telephony_providers_edges_site_numberplans**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_site_numberplans) | Get the list of Number Plans for this Site.
+[**get_telephony_providers_edges_site_numberplans**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_site_numberplans) | Get the list of Number Plans for this Site. Only fetches the first 200 records.
 [**get_telephony_providers_edges_site_numberplans_classifications**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_site_numberplans_classifications) | Get a list of Classifications for this Site
 [**get_telephony_providers_edges_site_outboundroute**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_site_outboundroute) | Get an outbound route
 [**get_telephony_providers_edges_site_outboundroutes**](TelephonyProvidersEdgeApi.html#get_telephony_providers_edges_site_outboundroutes) | Get outbound routes
@@ -125,7 +125,7 @@ Method | Description
 [**put_telephony_providers_edges_phone**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_phone) | Update a Phone by ID
 [**put_telephony_providers_edges_phonebasesetting**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_phonebasesetting) | Update a Phone Base Settings by ID
 [**put_telephony_providers_edges_site**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_site) | Update a Site by ID.
-[**put_telephony_providers_edges_site_numberplans**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_site_numberplans) | Update the list of Number Plans.
+[**put_telephony_providers_edges_site_numberplans**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_site_numberplans) | Update the list of Number Plans. A user can update maximum 200 number plans at a time.
 [**put_telephony_providers_edges_site_outboundroute**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_site_outboundroute) | Update outbound route
 [**put_telephony_providers_edges_trunkbasesetting**](TelephonyProvidersEdgeApi.html#put_telephony_providers_edges_trunkbasesetting) | Update a Trunk Base Settings object by ID
 {: class="table table-striped"}
@@ -4616,7 +4616,7 @@ Name | Type | Description  | Notes
 
 
 
-Get the list of Number Plans for this Site.
+Get the list of Number Plans for this Site. Only fetches the first 200 records.
 
 
 
@@ -4648,7 +4648,7 @@ site_id = "site_id_example" # String | Site ID
 
 
 begin
-  #Get the list of Number Plans for this Site.
+  #Get the list of Number Plans for this Site. Only fetches the first 200 records.
   result = api_instance.get_telephony_providers_edges_site_numberplans(site_id)
   p result
 rescue PureCloud::ApiError => e
@@ -8076,7 +8076,7 @@ Name | Type | Description  | Notes
 
 
 
-Update the list of Number Plans.
+Update the list of Number Plans. A user can update maximum 200 number plans at a time.
 
 
 
@@ -8110,7 +8110,7 @@ body = [PureCloud::NumberPlan.new] # Array | List of number plans
 
 
 begin
-  #Update the list of Number Plans.
+  #Update the list of Number Plans. A user can update maximum 200 number plans at a time.
   result = api_instance.put_telephony_providers_edges_site_numberplans(site_id, body)
   p result
 rescue PureCloud::ApiError => e

data/docs/TokensApi.md

@@ -25,8 +25,9 @@ Delete all auth tokens for the specified user.
 
 Wraps DELETE /api/v2/tokens/{userId} 
 
-Requires NO permissions: 
+Requires ANY permissions: 
 
+* oauth:token:delete
 
 
 ### Example

data/docs/TrusteeBillingOverview.md

@@ -21,6 +21,7 @@ title: TrusteeBillingOverview
 | **contract_amendment_date** | **DateTime** | Date-time the contract was last amended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **contract_effective_date** | **DateTime** | Date-time the contract became effective. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **contract_end_date** | **DateTime** | Date-time the contract ends. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **minimum_monthly_amount** | **String** | Minimum amount that will be charged for the month | [optional] |
 | **in_ramp_period** | **BOOLEAN** |  | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}

data/docs/UserAggregateDataContainer.md

@@ -0,0 +1,14 @@
+---
+title: UserAggregateDataContainer
+---
+## PureCloud::UserAggregateDataContainer
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **group** | **Hash<String, String>** | A mapping from dimension to value | [optional] |
+| **data** | [**Array<StatisticalResponse>**](StatisticalResponse.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserAggregateQueryClause.md

@@ -0,0 +1,14 @@
+---
+title: UserAggregateQueryClause
+---
+## PureCloud::UserAggregateQueryClause
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Boolean operation to apply to the provided predicates | |
+| **predicates** | [**Array<UserAggregateQueryPredicate>**](UserAggregateQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | |
+{: class="table table-striped"}
+
+

data/docs/UserAggregateQueryFilter.md

@@ -0,0 +1,15 @@
+---
+title: UserAggregateQueryFilter
+---
+## PureCloud::UserAggregateQueryFilter
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
+| **clauses** | [**Array<UserAggregateQueryClause>**](UserAggregateQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
+| **predicates** | [**Array<UserAggregateQueryPredicate>**](UserAggregateQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserAggregateQueryPredicate.md

@@ -0,0 +1,17 @@
+---
+title: UserAggregateQueryPredicate
+---
+## PureCloud::UserAggregateQueryPredicate
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Optional type, can usually be inferred | [optional] |
+| **dimension** | **String** | Left hand side for dimension predicates | [optional] |
+| **operator** | **String** | Optional operator, default is matches | [optional] |
+| **value** | **String** | Right hand side for dimension predicates | [optional] |
+| **range** | [**NumericRange**](NumericRange.html) | Right hand side for dimension predicates | [optional] |
+{: class="table table-striped"}
+
+

data/docs/{PresenceQueryResponse.md → UserAggregateQueryResponse.md}

@@ -1,14 +1,14 @@
 ---
-title: PresenceQueryResponse
+title: UserAggregateQueryResponse
 ---
-## PureCloud::PresenceQueryResponse
+## PureCloud::UserAggregateQueryResponse
 
 ## Properties
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **system_to_organization_mappings** | **Hash<String, Array<String>>** | A mapping from system presence to a list of organization presence ids | [optional] |
-| **results** | [**Array<AggregateDataContainer>**](AggregateDataContainer.html) |  | [optional] |
+| **results** | [**Array<UserAggregateDataContainer>**](UserAggregateDataContainer.html) |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/UserAggregationQuery.md

@@ -0,0 +1,20 @@
+---
+title: UserAggregationQuery
+---
+## PureCloud::UserAggregationQuery
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
+| **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
+| **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | [optional] |
+| **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
+| **filter** | [**UserAggregateQueryFilter**](UserAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
+| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
+| **flatten_multivalued_dimensions** | **BOOLEAN** | Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c') | [optional] |
+| **views** | [**Array<UserAggregationView>**](UserAggregationView.html) | Custom derived metric views | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserAggregationView.md

@@ -0,0 +1,16 @@
+---
+title: UserAggregationView
+---
+## PureCloud::UserAggregationView
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **target** | **String** | Target metric name | |
+| **name** | **String** | A unique name for this view. Must be distinct from other views and built-in metric names. | |
+| **function** | **String** | Type of view you wish to create | |
+| **range** | [**AggregationRange**](AggregationRange.html) | Range of numbers for slicing up data | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserAuthorization.md

@@ -8,7 +8,7 @@ title: UserAuthorization
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **roles** | [**Array<DomainRole>**](DomainRole.html) |  | [optional] |
-| **unused_roles** | [**Array<DomainRole>**](DomainRole.html) |  | [optional] |
+| **unused_roles** | [**Array<DomainRole>**](DomainRole.html) | A collection of the roles the user is not using | [optional] |
 | **permissions** | **Array<String>** | A collection of the permissions granted by all assigned roles | [optional] |
 | **permission_policies** | [**Array<ResourcePermissionPolicy>**](ResourcePermissionPolicy.html) | The policies configured for assigned permissions. | [optional] |
 {: class="table table-striped"}

data/docs/UserDetailQueryClause.md

@@ -0,0 +1,14 @@
+---
+title: UserDetailQueryClause
+---
+## PureCloud::UserDetailQueryClause
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Boolean operation to apply to the provided predicates | |
+| **predicates** | [**Array<UserDetailQueryPredicate>**](UserDetailQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | |
+{: class="table table-striped"}
+
+

data/docs/UserDetailQueryFilter.md

@@ -0,0 +1,15 @@
+---
+title: UserDetailQueryFilter
+---
+## PureCloud::UserDetailQueryFilter
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
+| **clauses** | [**Array<UserDetailQueryClause>**](UserDetailQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
+| **predicates** | [**Array<UserDetailQueryPredicate>**](UserDetailQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserDetailQueryPredicate.md

@@ -0,0 +1,17 @@
+---
+title: UserDetailQueryPredicate
+---
+## PureCloud::UserDetailQueryPredicate
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Optional type, can usually be inferred | [optional] |
+| **dimension** | **String** | Left hand side for dimension predicates | [optional] |
+| **operator** | **String** | Optional operator, default is matches | [optional] |
+| **value** | **String** | Right hand side for dimension predicates | [optional] |
+| **range** | [**NumericRange**](NumericRange.html) | Right hand side for dimension predicates | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserDetailsQuery.md

@@ -8,13 +8,13 @@ title: UserDetailsQuery
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **interval** | **String** | Specifies the date and time range of data being queried. Conversations MUST have started within this time range to potentially be included within the result set. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
-| **user_filters** | [**Array<AnalyticsQueryFilter>**](AnalyticsQueryFilter.html) | Filters that target the users to retrieve data for | [optional] |
-| **presence_filters** | [**Array<AnalyticsQueryFilter>**](AnalyticsQueryFilter.html) | Filters that target system and organization presence-level data | [optional] |
-| **routing_status_filters** | [**Array<AnalyticsQueryFilter>**](AnalyticsQueryFilter.html) | Filters that target agent routing status-level data | [optional] |
+| **user_filters** | [**Array<UserDetailQueryFilter>**](UserDetailQueryFilter.html) | Filters that target the users to retrieve data for | [optional] |
+| **routing_status_filters** | [**Array<RoutingStatusDetailQueryFilter>**](RoutingStatusDetailQueryFilter.html) | Filters that target agent routing status-level data | [optional] |
+| **order** | **String** | Sort the result set in ascending/descending order. Default is ascending | [optional] |
 | **presence_aggregations** | [**Array<AnalyticsQueryAggregation>**](AnalyticsQueryAggregation.html) | Include faceted search and aggregate roll-ups of presence data in your search results. This does not function as a filter, but rather, summary data about the presence results matching your filters | [optional] |
 | **routing_status_aggregations** | [**Array<AnalyticsQueryAggregation>**](AnalyticsQueryAggregation.html) | Include faceted search and aggregate roll-ups of agent routing status data in your search results. This does not function as a filter, but rather, summary data about the agent routing status results matching your filters | [optional] |
 | **paging** | [**PagingSpec**](PagingSpec.html) | Page size and number to control iterating through large result sets. Default page size is 25 | [optional] |
-| **order** | **String** | Sort the result set in ascending/descending order. Default is ascending | [optional] |
+| **presence_detail_filters** | [**Array<PresenceDetailQueryFilter>**](PresenceDetailQueryFilter.html) |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/UserObservationDataContainer.md

@@ -0,0 +1,14 @@
+---
+title: UserObservationDataContainer
+---
+## PureCloud::UserObservationDataContainer
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **group** | **Hash<String, String>** | A mapping from dimension to value | [optional] |
+| **data** | [**Array<ObservationMetricData>**](ObservationMetricData.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserObservationQuery.md

@@ -0,0 +1,15 @@
+---
+title: UserObservationQuery
+---
+## PureCloud::UserObservationQuery
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **filter** | [**UserObservationQueryFilter**](UserObservationQueryFilter.html) | Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters | |
+| **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |
+| **detail_metrics** | **Array<String>** | Metrics for which to include additional detailed observations | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserObservationQueryClause.md

@@ -0,0 +1,14 @@
+---
+title: UserObservationQueryClause
+---
+## PureCloud::UserObservationQueryClause
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Boolean operation to apply to the provided predicates | |
+| **predicates** | [**Array<UserObservationQueryPredicate>**](UserObservationQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | |
+{: class="table table-striped"}
+
+

data/docs/UserObservationQueryFilter.md

@@ -0,0 +1,15 @@
+---
+title: UserObservationQueryFilter
+---
+## PureCloud::UserObservationQueryFilter
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Boolean operation to apply to the provided predicates and clauses | |
+| **clauses** | [**Array<UserObservationQueryClause>**](UserObservationQueryClause.html) | Boolean 'and/or' logic with up to two-levels of nesting | [optional] |
+| **predicates** | [**Array<UserObservationQueryPredicate>**](UserObservationQueryPredicate.html) | Like a three-word sentence: (attribute-name) (operator) (target-value). | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserObservationQueryPredicate.md

@@ -0,0 +1,17 @@
+---
+title: UserObservationQueryPredicate
+---
+## PureCloud::UserObservationQueryPredicate
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Optional type, can usually be inferred | [optional] |
+| **dimension** | **String** | Left hand side for dimension predicates | [optional] |
+| **operator** | **String** | Optional operator, default is matches | [optional] |
+| **value** | **String** | Right hand side for dimension predicates | [optional] |
+| **range** | [**NumericRange**](NumericRange.html) | Right hand side for dimension predicates | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserObservationQueryResponse.md

@@ -0,0 +1,13 @@
+---
+title: UserObservationQueryResponse
+---
+## PureCloud::UserObservationQueryResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **results** | [**Array<UserObservationDataContainer>**](UserObservationDataContainer.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UsersApi.md

@@ -3207,7 +3207,7 @@ Name | Type | Description  | Notes
 
 <a name="post_analytics_users_aggregates_query"></a>
 
-## [**PresenceQueryResponse**](PresenceQueryResponse.html) post_analytics_users_aggregates_query(body)
+## [**UserAggregateQueryResponse**](UserAggregateQueryResponse.html) post_analytics_users_aggregates_query(body)
 
 
 
@@ -3239,7 +3239,7 @@ end
 
 api_instance = PureCloud::UsersApi.new
 
-body = PureCloud::AggregationQuery.new # AggregationQuery | query
+body = PureCloud::UserAggregationQuery.new # UserAggregationQuery | query
 
 
 begin
@@ -3255,13 +3255,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**AggregationQuery**](AggregationQuery.html)| query |  |
+ **body** | [**UserAggregationQuery**](UserAggregationQuery.html)| query |  |
 {: class="table table-striped"}
 
 
 ### Return type
 
-[**PresenceQueryResponse**](PresenceQueryResponse.html)
+[**UserAggregateQueryResponse**](UserAggregateQueryResponse.html)
 
 ### HTTP request headers
 
@@ -3337,7 +3337,7 @@ Name | Type | Description  | Notes
 
 <a name="post_analytics_users_observations_query"></a>
 
-## [**ObservationQueryResponse**](ObservationQueryResponse.html) post_analytics_users_observations_query(body)
+## [**UserObservationQueryResponse**](UserObservationQueryResponse.html) post_analytics_users_observations_query(body)
 
 
 
@@ -3369,7 +3369,7 @@ end
 
 api_instance = PureCloud::UsersApi.new
 
-body = PureCloud::ObservationQuery.new # ObservationQuery | query
+body = PureCloud::UserObservationQuery.new # UserObservationQuery | query
 
 
 begin
@@ -3385,13 +3385,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **body** | [**ObservationQuery**](ObservationQuery.html)| query |  |
+ **body** | [**UserObservationQuery**](UserObservationQuery.html)| query |  |
 {: class="table table-striped"}
 
 
 ### Return type
 
-[**ObservationQueryResponse**](ObservationQueryResponse.html)
+[**UserObservationQueryResponse**](UserObservationQueryResponse.html)
 
 ### HTTP request headers
 
@@ -3441,7 +3441,7 @@ division_id = "division_id_example" # String | the id of the division to which t
 role_id = "role_id_example" # String | the id of the role to grant
 
 opts = { 
-  subject_type: "PC_USER" # String | what the type of the subject is, PC_GROUP or PC_USER
+  subject_type: "PC_USER" # String | what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints)
 }
 
 begin
@@ -3459,7 +3459,7 @@ Name | Type | Description  | Notes
  **subject_id** | **String**| Subject ID (user or group) |  |
  **division_id** | **String**| the id of the division to which to make the grant |  |
  **role_id** | **String**| the id of the role to grant |  |
- **subject_type** | **String**| what the type of the subject is, PC_GROUP or PC_USER | [optional] [default to PC_USER] |
+ **subject_type** | **String**| what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) | [optional] [default to PC_USER] |
 {: class="table table-striped"}