purecloudplatformclientv2 62.0.0 → 66.0.0

data/docs/CreateQueueMediaAssociationRequest.md

@@ -7,6 +7,7 @@ title: CreateQueueMediaAssociationRequest
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **queue** | [**QueueReference**](QueueReference.html) | The queue to associate with the service goal group | [optional] |
 | **media_types** | **Array<String>** | The media types of the given queue to associate with the service goal group | [optional] |
 {: class="table table-striped"}

data/docs/DataSchema.md

@@ -11,7 +11,7 @@ title: DataSchema
 | **name** | **String** |  | [optional] |
 | **version** | **Integer** | The schema's version, a positive integer. Required for updates. | |
 | **applies_to** | **Array<String>** | One of \"CONTACT\" or \"EXTERNAL_ORGANIZATION\".  Indicates the built-in entity type to which this schema applies. | [optional] |
-| **enabled** | **BOOLEAN** | The schema's current enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists | [optional] |
+| **enabled** | **BOOLEAN** | The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists. | [optional] |
 | **created_by** | [**DomainEntityRef**](DomainEntityRef.html) | The URI of the user that created this schema. | [optional] |
 | **date_created** | **DateTime** | The date and time this schema was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **json_schema** | [**JsonSchemaDocument**](JsonSchemaDocument.html) | A JSON schema defining the extension to the built-in entity type. | |

data/docs/DependencyStatus.md

@@ -9,7 +9,8 @@ title: DependencyStatus
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
-| **user** | [**User**](User.html) |  | [optional] |
+| **user** | [**User**](User.html) | User that initiated the build. | [optional] |
+| **client** | [**DomainEntityRef**](DomainEntityRef.html) | OAuth client that initiated the build. | [optional] |
 | **build_id** | **String** |  | [optional] |
 | **date_started** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **date_completed** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |

data/docs/DomainOrganizationRole.md

@@ -12,7 +12,7 @@ title: DomainOrganizationRole
 | **description** | **String** |  | [optional] |
 | **default_role_id** | **String** |  | [optional] |
 | **permissions** | **Array<String>** |  | [optional] |
-| **unused_permissions** | **Array<String>** |  | [optional] |
+| **unused_permissions** | **Array<String>** | A collection of the permissions the role is not using | [optional] |
 | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) |  | [optional] |
 | **user_count** | **Integer** |  | [optional] |
 | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |

data/docs/DomainOrganizationRoleCreate.md

@@ -12,7 +12,7 @@ title: DomainOrganizationRoleCreate
 | **description** | **String** |  | [optional] |
 | **default_role_id** | **String** |  | [optional] |
 | **permissions** | **Array<String>** |  | [optional] |
-| **unused_permissions** | **Array<String>** |  | [optional] |
+| **unused_permissions** | **Array<String>** | A collection of the permissions the role is not using | [optional] |
 | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) |  | [optional] |
 | **user_count** | **Integer** |  | [optional] |
 | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |

data/docs/DomainOrganizationRoleUpdate.md

@@ -12,7 +12,7 @@ title: DomainOrganizationRoleUpdate
 | **description** | **String** |  | [optional] |
 | **default_role_id** | **String** |  | [optional] |
 | **permissions** | **Array<String>** |  | [optional] |
-| **unused_permissions** | **Array<String>** |  | [optional] |
+| **unused_permissions** | **Array<String>** | A collection of the permissions the role is not using | [optional] |
 | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) |  | [optional] |
 | **user_count** | **Integer** |  | [optional] |
 | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |

data/docs/EvaluationAggregateDataContainer.md

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

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

data/docs/EvaluationAggregateQueryFilter.md

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

data/docs/EvaluationAggregateQueryPredicate.md

@@ -0,0 +1,17 @@
+---
+title: EvaluationAggregateQueryPredicate
+---
+## PureCloud::EvaluationAggregateQueryPredicate
+
+## 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/EvaluationAggregateQueryResponse.md

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

data/docs/EvaluationAggregationQuery.md

@@ -0,0 +1,21 @@
+---
+title: EvaluationAggregationQuery
+---
+## PureCloud::EvaluationAggregationQuery
+
+## 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** | [**EvaluationAggregateQueryFilter**](EvaluationAggregateQueryFilter.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<EvaluationAggregationView>**](EvaluationAggregationView.html) | Custom derived metric views | [optional] |
+| **alternate_time_dimension** | **String** | Dimension to use as the alternative timestamp for data in the aggregate.  Choosing \"eventTime\" uses the actual time of the data event. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/EvaluationAggregationView.md

@@ -0,0 +1,16 @@
+---
+title: EvaluationAggregationView
+---
+## PureCloud::EvaluationAggregationView
+
+## 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/EvaluationDetailQueryClause.md

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

data/docs/EvaluationDetailQueryFilter.md

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

data/docs/EvaluationDetailQueryPredicate.md

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

data/docs/Flow.md

@@ -12,7 +12,8 @@ title: Flow
 | **division** | [**WritableDivision**](WritableDivision.html) | The division to which this entity belongs. | [optional] |
 | **description** | **String** |  | [optional] |
 | **type** | **String** |  | [optional] |
-| **locked_user** | [**User**](User.html) |  | [optional] |
+| **locked_user** | [**User**](User.html) | User that has the flow locked. | [optional] |
+| **locked_client** | [**DomainEntityRef**](DomainEntityRef.html) | OAuth client that has the flow locked. | [optional] |
 | **active** | **BOOLEAN** |  | [optional] |
 | **system** | **BOOLEAN** |  | [optional] |
 | **deleted** | **BOOLEAN** |  | [optional] |

data/docs/{AggregateDataContainer.md → FlowAggregateDataContainer.md}

@@ -1,7 +1,7 @@
 ---
-title: AggregateDataContainer
+title: FlowAggregateDataContainer
 ---
-## PureCloud::AggregateDataContainer
+## PureCloud::FlowAggregateDataContainer
 
 ## Properties
 

data/docs/FlowAggregateQueryClause.md

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

data/docs/FlowAggregateQueryFilter.md

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

data/docs/FlowAggregateQueryPredicate.md

@@ -0,0 +1,17 @@
+---
+title: FlowAggregateQueryPredicate
+---
+## PureCloud::FlowAggregateQueryPredicate
+
+## 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/FlowAggregateQueryResponse.md

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

data/docs/{AggregationQuery.md → FlowAggregationQuery.md}

@@ -1,7 +1,7 @@
 ---
-title: AggregationQuery
+title: FlowAggregationQuery
 ---
-## PureCloud::AggregationQuery
+## PureCloud::FlowAggregationQuery
 
 ## Properties
 
@@ -11,10 +11,10 @@ title: AggregationQuery
 | **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** | [**AnalyticsQueryFilter**](AnalyticsQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
+| **filter** | [**FlowAggregateQueryFilter**](FlowAggregateQueryFilter.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<AnalyticsView>**](AnalyticsView.html) | Custom derived metric views | [optional] |
+| **views** | [**Array<FlowAggregationView>**](FlowAggregationView.html) | Custom derived metric views | [optional] |
 {: class="table table-striped"}
 
 

data/docs/{AnalyticsView.md → FlowAggregationView.md}

@@ -1,13 +1,13 @@
 ---
-title: AnalyticsView
+title: FlowAggregationView
 ---
-## PureCloud::AnalyticsView
+## PureCloud::FlowAggregationView
 
 ## Properties
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **target** | **String** | CallTarget metric name | |
+| **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] |

data/docs/{ObservationDataContainer.md → FlowObservationDataContainer.md}

@@ -1,7 +1,7 @@
 ---
-title: ObservationDataContainer
+title: FlowObservationDataContainer
 ---
-## PureCloud::ObservationDataContainer
+## PureCloud::FlowObservationDataContainer
 
 ## Properties
 

data/docs/{ObservationQuery.md → FlowObservationQuery.md}

@@ -1,13 +1,13 @@
 ---
-title: ObservationQuery
+title: FlowObservationQuery
 ---
-## PureCloud::ObservationQuery
+## PureCloud::FlowObservationQuery
 
 ## Properties
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **filter** | [**AnalyticsQueryFilter**](AnalyticsQueryFilter.html) | Filter to return a subset of observations. Expresses boolean logical predicates as well as dimensional filters | |
+| **filter** | [**FlowObservationQueryFilter**](FlowObservationQueryFilter.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/FlowObservationQueryClause.md

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

data/docs/FlowObservationQueryFilter.md

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

data/docs/FlowObservationQueryPredicate.md

@@ -0,0 +1,17 @@
+---
+title: FlowObservationQueryPredicate
+---
+## PureCloud::FlowObservationQueryPredicate
+
+## 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/FlowObservationQueryResponse.md

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