arthur-client 1.4.1233__py3-none-any.whl → 1.4.1234__py3-none-any.whl

arthur_client/api_bindings/docs/AggregationSpecSchemaInitArgsInner.md

@@ -6,15 +6,15 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **parameter_key** | **str** | Name of the parameter. | 
-**optional** | **bool** | Boolean denoting if the parameter is optional. | [optional] [default to False]
 **friendly_name** | **str** | User facing name of the parameter. | 
 **description** | **str** | Description of the parameter. | 
 **parameter_type** | **str** |  | [optional] [default to 'column_list']
 **model_problem_type** | [**ModelProblemType**](ModelProblemType.md) |  | [optional] 
+**optional** | **bool** | Boolean denoting if the parameter is optional. | [optional] [default to False]
 **parameter_dtype** | [**DType**](DType.md) | Data type of the parameter. | 
 **tag_hints** | [**List[ScopeSchemaTag]**](ScopeSchemaTag.md) | List of tags that are applicable to this parameter. Datasets with columns that have matching tags can be inferred this way. | [optional] [default to []]
 **source_dataset_parameter_key** | **str** | Name of the parameter that provides the dataset to be used for this column. | 
-**allowed_column_types** | [**List[MetricsColumnListParameterSchemaAllowedColumnTypesInner]**](MetricsColumnListParameterSchemaAllowedColumnTypesInner.md) |  | [optional] 
+**allowed_column_types** | [**List[BaseColumnParameterSchemaAllowedColumnTypesInner]**](BaseColumnParameterSchemaAllowedColumnTypesInner.md) |  | [optional] 
 **allow_any_column_type** | **bool** | Indicates if this metric parameter can accept any column type. | [optional] [default to False]
 
 ## Example

arthur_client/api_bindings/docs/BaseColumnParameterSchema.md

@@ -0,0 +1,36 @@
+# BaseColumnParameterSchema
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameter_key** | **str** | Name of the parameter. | 
+**friendly_name** | **str** | User facing name of the parameter. | 
+**description** | **str** | Description of the parameter. | 
+**tag_hints** | [**List[ScopeSchemaTag]**](ScopeSchemaTag.md) | List of tags that are applicable to this parameter. Datasets with columns that have matching tags can be inferred this way. | [optional] [default to []]
+**source_dataset_parameter_key** | **str** | Name of the parameter that provides the dataset to be used for this column. | 
+**allowed_column_types** | [**List[BaseColumnParameterSchemaAllowedColumnTypesInner]**](BaseColumnParameterSchemaAllowedColumnTypesInner.md) |  | [optional] 
+**allow_any_column_type** | **bool** | Indicates if this metric parameter can accept any column type. | [optional] [default to False]
+**parameter_type** | **str** |  | [optional] [default to 'column']
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.base_column_parameter_schema import BaseColumnParameterSchema
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BaseColumnParameterSchema from a JSON string
+base_column_parameter_schema_instance = BaseColumnParameterSchema.from_json(json)
+# print the JSON string representation of the object
+print(BaseColumnParameterSchema.to_json())
+
+# convert the object into a dict
+base_column_parameter_schema_dict = base_column_parameter_schema_instance.to_dict()
+# create an instance of BaseColumnParameterSchema from a dict
+base_column_parameter_schema_from_dict = BaseColumnParameterSchema.from_dict(base_column_parameter_schema_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/BaseColumnParameterSchemaAllowedColumnTypesInner.md

@@ -0,0 +1,31 @@
+# BaseColumnParameterSchemaAllowedColumnTypesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dtype** | [**DType**](DType.md) |  | 
+**object** | [**Dict[str, BaseColumnParameterSchemaAllowedColumnTypesInner]**](BaseColumnParameterSchemaAllowedColumnTypesInner.md) |  | 
+**items** | [**Items1**](Items1.md) |  | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.base_column_parameter_schema_allowed_column_types_inner import BaseColumnParameterSchemaAllowedColumnTypesInner
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BaseColumnParameterSchemaAllowedColumnTypesInner from a JSON string
+base_column_parameter_schema_allowed_column_types_inner_instance = BaseColumnParameterSchemaAllowedColumnTypesInner.from_json(json)
+# print the JSON string representation of the object
+print(BaseColumnParameterSchemaAllowedColumnTypesInner.to_json())
+
+# convert the object into a dict
+base_column_parameter_schema_allowed_column_types_inner_dict = base_column_parameter_schema_allowed_column_types_inner_instance.to_dict()
+# create an instance of BaseColumnParameterSchemaAllowedColumnTypesInner from a dict
+base_column_parameter_schema_allowed_column_types_inner_from_dict = BaseColumnParameterSchemaAllowedColumnTypesInner.from_dict(base_column_parameter_schema_allowed_column_types_inner_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/BaseDatasetParameterSchema.md

@@ -0,0 +1,33 @@
+# BaseDatasetParameterSchema
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameter_key** | **str** | Name of the parameter. | 
+**friendly_name** | **str** | User facing name of the parameter. | 
+**description** | **str** | Description of the parameter. | 
+**parameter_type** | **str** |  | [optional] [default to 'dataset']
+**model_problem_type** | [**ModelProblemType**](ModelProblemType.md) |  | [optional] 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.base_dataset_parameter_schema import BaseDatasetParameterSchema
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BaseDatasetParameterSchema from a JSON string
+base_dataset_parameter_schema_instance = BaseDatasetParameterSchema.from_json(json)
+# print the JSON string representation of the object
+print(BaseDatasetParameterSchema.to_json())
+
+# convert the object into a dict
+base_dataset_parameter_schema_dict = base_dataset_parameter_schema_instance.to_dict()
+# create an instance of BaseDatasetParameterSchema from a dict
+base_dataset_parameter_schema_from_dict = BaseDatasetParameterSchema.from_dict(base_dataset_parameter_schema_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/BaseLiteralParameterSchema.md

@@ -0,0 +1,33 @@
+# BaseLiteralParameterSchema
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameter_key** | **str** | Name of the parameter. | 
+**friendly_name** | **str** | User facing name of the parameter. | 
+**description** | **str** | Description of the parameter. | 
+**parameter_type** | **str** |  | [optional] [default to 'literal']
+**parameter_dtype** | [**DType**](DType.md) | Data type of the parameter. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.base_literal_parameter_schema import BaseLiteralParameterSchema
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of BaseLiteralParameterSchema from a JSON string
+base_literal_parameter_schema_instance = BaseLiteralParameterSchema.from_json(json)
+# print the JSON string representation of the object
+print(BaseLiteralParameterSchema.to_json())
+
+# convert the object into a dict
+base_literal_parameter_schema_dict = base_literal_parameter_schema_instance.to_dict()
+# create an instance of BaseLiteralParameterSchema from a dict
+base_literal_parameter_schema_from_dict = BaseLiteralParameterSchema.from_dict(base_literal_parameter_schema_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/CustomAggregationSpecSchema.md

@@ -0,0 +1,38 @@
+# CustomAggregationSpecSchema
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Name of the custom aggregation function. | 
+**description** | **str** | Description of the custom aggregation function and what it aggregates. | 
+**reported_aggregations** | [**List[ReportedCustomAggregation]**](ReportedCustomAggregation.md) | Metadata for every aggregation the custom aggregation reports. | 
+**aggregate_args** | [**List[CustomAggregationSpecSchemaAggregateArgsInner]**](CustomAggregationSpecSchemaAggregateArgsInner.md) | List of parameters to the custom aggregation's query function. | 
+**sql** | **str** | DuckDBSQL query for the custom aggregation. | 
+**id** | **str** | Unique identifier of the custom aggregation function. | 
+**workspace_id** | **str** | Unique identifier of the custom aggregation's parent workspace. | 
+**version** | **int** | Version number of the custom aggregation function. | 
+**authored_by** | [**User**](User.md) | User who authored this custom aggregation. | 
+**created_at** | **datetime** | Time of aggregation creation. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.custom_aggregation_spec_schema import CustomAggregationSpecSchema
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomAggregationSpecSchema from a JSON string
+custom_aggregation_spec_schema_instance = CustomAggregationSpecSchema.from_json(json)
+# print the JSON string representation of the object
+print(CustomAggregationSpecSchema.to_json())
+
+# convert the object into a dict
+custom_aggregation_spec_schema_dict = custom_aggregation_spec_schema_instance.to_dict()
+# create an instance of CustomAggregationSpecSchema from a dict
+custom_aggregation_spec_schema_from_dict = CustomAggregationSpecSchema.from_dict(custom_aggregation_spec_schema_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/CustomAggregationSpecSchemaAggregateArgsInner.md

@@ -0,0 +1,38 @@
+# CustomAggregationSpecSchemaAggregateArgsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parameter_key** | **str** | Name of the parameter. | 
+**friendly_name** | **str** | User facing name of the parameter. | 
+**description** | **str** | Description of the parameter. | 
+**parameter_type** | **str** |  | [optional] [default to 'column']
+**model_problem_type** | [**ModelProblemType**](ModelProblemType.md) |  | [optional] 
+**parameter_dtype** | [**DType**](DType.md) | Data type of the parameter. | 
+**tag_hints** | [**List[ScopeSchemaTag]**](ScopeSchemaTag.md) | List of tags that are applicable to this parameter. Datasets with columns that have matching tags can be inferred this way. | [optional] [default to []]
+**source_dataset_parameter_key** | **str** | Name of the parameter that provides the dataset to be used for this column. | 
+**allowed_column_types** | [**List[BaseColumnParameterSchemaAllowedColumnTypesInner]**](BaseColumnParameterSchemaAllowedColumnTypesInner.md) |  | [optional] 
+**allow_any_column_type** | **bool** | Indicates if this metric parameter can accept any column type. | [optional] [default to False]
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.custom_aggregation_spec_schema_aggregate_args_inner import CustomAggregationSpecSchemaAggregateArgsInner
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomAggregationSpecSchemaAggregateArgsInner from a JSON string
+custom_aggregation_spec_schema_aggregate_args_inner_instance = CustomAggregationSpecSchemaAggregateArgsInner.from_json(json)
+# print the JSON string representation of the object
+print(CustomAggregationSpecSchemaAggregateArgsInner.to_json())
+
+# convert the object into a dict
+custom_aggregation_spec_schema_aggregate_args_inner_dict = custom_aggregation_spec_schema_aggregate_args_inner_instance.to_dict()
+# create an instance of CustomAggregationSpecSchemaAggregateArgsInner from a dict
+custom_aggregation_spec_schema_aggregate_args_inner_from_dict = CustomAggregationSpecSchemaAggregateArgsInner.from_dict(custom_aggregation_spec_schema_aggregate_args_inner_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/CustomAggregationsV1Api.md

@@ -0,0 +1,410 @@
+# arthur_client.api_bindings.CustomAggregationsV1Api
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_custom_aggregation**](CustomAggregationsV1Api.md#delete_custom_aggregation) | **DELETE** /api/v1/custom_aggregations/{custom_aggregation_id} | Delete Custom Aggregation.
+[**get_custom_aggregation**](CustomAggregationsV1Api.md#get_custom_aggregation) | **GET** /api/v1/custom_aggregations/{custom_aggregation_id} | Get Custom Aggregation By Id.
+[**post_custom_aggregation**](CustomAggregationsV1Api.md#post_custom_aggregation) | **POST** /api/v1/workspaces/{workspace_id}/custom_aggregations | Post Custom Aggregation.
+[**put_custom_aggregation**](CustomAggregationsV1Api.md#put_custom_aggregation) | **PUT** /api/v1/custom_aggregations/{custom_aggregation_id} | Update Custom Aggregation By Id.
+[**validate_custom_aggregation**](CustomAggregationsV1Api.md#validate_custom_aggregation) | **POST** /api/v1/workspaces/{workspace_id}/validate_custom_aggregation | Validate A Custom Aggregation Before Creation.
+
+
+# **delete_custom_aggregation**
+> delete_custom_aggregation(custom_aggregation_id)
+
+Delete Custom Aggregation.
+
+Requires custom_aggregation_delete permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.CustomAggregationsV1Api(api_client)
+    custom_aggregation_id = 'custom_aggregation_id_example' # str | 
+
+    try:
+        # Delete Custom Aggregation.
+        api_instance.delete_custom_aggregation(custom_aggregation_id)
+    except Exception as e:
+        print("Exception when calling CustomAggregationsV1Api->delete_custom_aggregation: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **custom_aggregation_id** | **str**|  | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **get_custom_aggregation**
+> CustomAggregationSpecSchema get_custom_aggregation(custom_aggregation_id)
+
+Get Custom Aggregation By Id.
+
+Requires custom_aggregation_read permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.custom_aggregation_spec_schema import CustomAggregationSpecSchema
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.CustomAggregationsV1Api(api_client)
+    custom_aggregation_id = 'custom_aggregation_id_example' # str | 
+
+    try:
+        # Get Custom Aggregation By Id.
+        api_response = api_instance.get_custom_aggregation(custom_aggregation_id)
+        print("The response of CustomAggregationsV1Api->get_custom_aggregation:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling CustomAggregationsV1Api->get_custom_aggregation: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **custom_aggregation_id** | **str**|  | 
+
+### Return type
+
+[**CustomAggregationSpecSchema**](CustomAggregationSpecSchema.md)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **post_custom_aggregation**
+> CustomAggregationSpecSchema post_custom_aggregation(workspace_id, post_custom_aggregation_spec_schema)
+
+Post Custom Aggregation.
+
+Requires workspace_create_custom_aggregation permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.custom_aggregation_spec_schema import CustomAggregationSpecSchema
+from arthur_client.api_bindings.models.post_custom_aggregation_spec_schema import PostCustomAggregationSpecSchema
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.CustomAggregationsV1Api(api_client)
+    workspace_id = 'workspace_id_example' # str | 
+    post_custom_aggregation_spec_schema = arthur_client.api_bindings.PostCustomAggregationSpecSchema() # PostCustomAggregationSpecSchema | 
+
+    try:
+        # Post Custom Aggregation.
+        api_response = api_instance.post_custom_aggregation(workspace_id, post_custom_aggregation_spec_schema)
+        print("The response of CustomAggregationsV1Api->post_custom_aggregation:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling CustomAggregationsV1Api->post_custom_aggregation: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **workspace_id** | **str**|  | 
+ **post_custom_aggregation_spec_schema** | [**PostCustomAggregationSpecSchema**](PostCustomAggregationSpecSchema.md)|  | 
+
+### Return type
+
+[**CustomAggregationSpecSchema**](CustomAggregationSpecSchema.md)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**400** | Bad Request |  -  |
+**404** | Not Found |  -  |
+**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **put_custom_aggregation**
+> CustomAggregationSpecSchema put_custom_aggregation(custom_aggregation_id, put_custom_aggregation_spec_schema)
+
+Update Custom Aggregation By Id.
+
+Creates a new version of the custom aggregation. Requires custom_aggregation_put permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.custom_aggregation_spec_schema import CustomAggregationSpecSchema
+from arthur_client.api_bindings.models.put_custom_aggregation_spec_schema import PutCustomAggregationSpecSchema
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.CustomAggregationsV1Api(api_client)
+    custom_aggregation_id = 'custom_aggregation_id_example' # str | 
+    put_custom_aggregation_spec_schema = arthur_client.api_bindings.PutCustomAggregationSpecSchema() # PutCustomAggregationSpecSchema | 
+
+    try:
+        # Update Custom Aggregation By Id.
+        api_response = api_instance.put_custom_aggregation(custom_aggregation_id, put_custom_aggregation_spec_schema)
+        print("The response of CustomAggregationsV1Api->put_custom_aggregation:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling CustomAggregationsV1Api->put_custom_aggregation: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **custom_aggregation_id** | **str**|  | 
+ **put_custom_aggregation_spec_schema** | [**PutCustomAggregationSpecSchema**](PutCustomAggregationSpecSchema.md)|  | 
+
+### Return type
+
+[**CustomAggregationSpecSchema**](CustomAggregationSpecSchema.md)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **validate_custom_aggregation**
+> ValidationResults validate_custom_aggregation(workspace_id, post_custom_aggregation_spec_schema)
+
+Validate A Custom Aggregation Before Creation.
+
+Validates the custom aggregation and returns any expected errors for aggregation creation. Requires workspace_validate_custom_aggregation permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.post_custom_aggregation_spec_schema import PostCustomAggregationSpecSchema
+from arthur_client.api_bindings.models.validation_results import ValidationResults
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.CustomAggregationsV1Api(api_client)
+    workspace_id = 'workspace_id_example' # str | 
+    post_custom_aggregation_spec_schema = arthur_client.api_bindings.PostCustomAggregationSpecSchema() # PostCustomAggregationSpecSchema | 
+
+    try:
+        # Validate A Custom Aggregation Before Creation.
+        api_response = api_instance.validate_custom_aggregation(workspace_id, post_custom_aggregation_spec_schema)
+        print("The response of CustomAggregationsV1Api->validate_custom_aggregation:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling CustomAggregationsV1Api->validate_custom_aggregation: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **workspace_id** | **str**|  | 
+ **post_custom_aggregation_spec_schema** | [**PostCustomAggregationSpecSchema**](PostCustomAggregationSpecSchema.md)|  | 
+
+### Return type
+
+[**ValidationResults**](ValidationResults.md)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

arthur_client/api_bindings/docs/Items1.md

@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **dtype** | [**DType**](DType.md) |  | 
-**object** | [**Dict[str, MetricsColumnListParameterSchemaAllowedColumnTypesInner]**](MetricsColumnListParameterSchemaAllowedColumnTypesInner.md) |  | 
+**object** | [**Dict[str, BaseColumnParameterSchemaAllowedColumnTypesInner]**](BaseColumnParameterSchemaAllowedColumnTypesInner.md) |  | 
 **items** | [**Items1**](Items1.md) |  | 
 
 ## Example

arthur_client/api_bindings/docs/MetricsColumnListParameterSchema.md

@@ -6,14 +6,14 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **parameter_key** | **str** | Name of the parameter. | 
-**optional** | **bool** | Boolean denoting if the parameter is optional. | [optional] [default to False]
 **friendly_name** | **str** | User facing name of the parameter. | 
 **description** | **str** | Description of the parameter. | 
 **tag_hints** | [**List[ScopeSchemaTag]**](ScopeSchemaTag.md) | List of tags that are applicable to this parameter. Datasets with columns that have matching tags can be inferred this way. | [optional] [default to []]
 **source_dataset_parameter_key** | **str** | Name of the parameter that provides the dataset to be used for this column. | 
-**allowed_column_types** | [**List[MetricsColumnListParameterSchemaAllowedColumnTypesInner]**](MetricsColumnListParameterSchemaAllowedColumnTypesInner.md) |  | [optional] 
+**allowed_column_types** | [**List[BaseColumnParameterSchemaAllowedColumnTypesInner]**](BaseColumnParameterSchemaAllowedColumnTypesInner.md) |  | [optional] 
 **allow_any_column_type** | **bool** | Indicates if this metric parameter can accept any column type. | [optional] [default to False]
 **parameter_type** | **str** |  | [optional] [default to 'column_list']
+**optional** | **bool** | Boolean denoting if the parameter is optional. | [optional] [default to False]
 
 ## Example