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

arthur_client/api_bindings/docs/MetricsColumnParameterSchema.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']
+**optional** | **bool** | Boolean denoting if the parameter is optional. | [optional] [default to False]
 
 ## Example
 

arthur_client/api_bindings/docs/MetricsDatasetParameterSchema.md

@@ -6,11 +6,11 @@
 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 'dataset']
 **model_problem_type** | [**ModelProblemType**](ModelProblemType.md) |  | [optional] 
+**optional** | **bool** | Boolean denoting if the parameter is optional. | [optional] [default to False]
 
 ## Example
 

arthur_client/api_bindings/docs/MetricsLiteralParameterSchema.md

@@ -6,11 +6,11 @@
 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 'literal']
 **parameter_dtype** | [**DType**](DType.md) | Data type of the parameter. | 
+**optional** | **bool** | Boolean denoting if the parameter is optional. | [optional] [default to False]
 
 ## Example
 

arthur_client/api_bindings/docs/ObjectType.md

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

arthur_client/api_bindings/docs/PermissionName.md

@@ -87,6 +87,10 @@
 
 * `WORKSPACE_TEST_WEBHOOK` (value: `'workspace_test_webhook'`)
 
+* `WORKSPACE_CREATE_CUSTOM_AGGREGATION` (value: `'workspace_create_custom_aggregation'`)
+
+* `WORKSPACE_VALIDATE_CUSTOM_AGGREGATION` (value: `'workspace_validate_custom_aggregation'`)
+
 * `PROJECT_READ` (value: `'project_read'`)
 
 * `PROJECT_UPDATE` (value: `'project_update'`)
@@ -267,6 +271,12 @@
 
 * `ROLE_READ` (value: `'role_read'`)
 
+* `CUSTOM_AGGREGATION_READ` (value: `'custom_aggregation_read'`)
+
+* `CUSTOM_AGGREGATION_PUT` (value: `'custom_aggregation_put'`)
+
+* `CUSTOM_AGGREGATION_DELETE` (value: `'custom_aggregation_delete'`)
+
 [[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/PostCustomAggregationSpecSchema.md

@@ -0,0 +1,33 @@
+# PostCustomAggregationSpecSchema
+
+
+## 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. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.post_custom_aggregation_spec_schema import PostCustomAggregationSpecSchema
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PostCustomAggregationSpecSchema from a JSON string
+post_custom_aggregation_spec_schema_instance = PostCustomAggregationSpecSchema.from_json(json)
+# print the JSON string representation of the object
+print(PostCustomAggregationSpecSchema.to_json())
+
+# convert the object into a dict
+post_custom_aggregation_spec_schema_dict = post_custom_aggregation_spec_schema_instance.to_dict()
+# create an instance of PostCustomAggregationSpecSchema from a dict
+post_custom_aggregation_spec_schema_from_dict = PostCustomAggregationSpecSchema.from_dict(post_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/PutCustomAggregationSpecSchema.md

@@ -0,0 +1,33 @@
+# PutCustomAggregationSpecSchema
+
+
+## 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. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.put_custom_aggregation_spec_schema import PutCustomAggregationSpecSchema
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PutCustomAggregationSpecSchema from a JSON string
+put_custom_aggregation_spec_schema_instance = PutCustomAggregationSpecSchema.from_json(json)
+# print the JSON string representation of the object
+print(PutCustomAggregationSpecSchema.to_json())
+
+# convert the object into a dict
+put_custom_aggregation_spec_schema_dict = put_custom_aggregation_spec_schema_instance.to_dict()
+# create an instance of PutCustomAggregationSpecSchema from a dict
+put_custom_aggregation_spec_schema_from_dict = PutCustomAggregationSpecSchema.from_dict(put_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/ReportedCustomAggregation.md

@@ -0,0 +1,34 @@
+# ReportedCustomAggregation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metric_name** | **str** | Name of the reported aggregation metric. | 
+**description** | **str** | Description of the reported aggregation metric and what it aggregates. | 
+**value_column** | **str** | Name of the column returned from the SQL query holding the metric value. | 
+**timestamp_column** | **str** | Name of the column returned from the SQL query holding the timestamp buckets. | 
+**metric_kind** | [**AggregationMetricType**](AggregationMetricType.md) | Return type of the reported aggregation metric value. | 
+**dimension_columns** | **List[str]** | Name of any dimension columns returned from the SQL query. Max length is 1. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.reported_custom_aggregation import ReportedCustomAggregation
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ReportedCustomAggregation from a JSON string
+reported_custom_aggregation_instance = ReportedCustomAggregation.from_json(json)
+# print the JSON string representation of the object
+print(ReportedCustomAggregation.to_json())
+
+# convert the object into a dict
+reported_custom_aggregation_dict = reported_custom_aggregation_instance.to_dict()
+# create an instance of ReportedCustomAggregation from a dict
+reported_custom_aggregation_from_dict = ReportedCustomAggregation.from_dict(reported_custom_aggregation_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/ResourceKind.md

@@ -35,6 +35,8 @@
 
 * `WEBHOOK` (value: `'webhook'`)
 
+* `CUSTOM_AGGREGATION` (value: `'custom_aggregation'`)
+
 [[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/RuleType.md

@@ -5,12 +5,8 @@
 
 * `KEYWORDRULE` (value: `'KeywordRule'`)
 
-* `MODELHALLUCINATIONRULE` (value: `'ModelHallucinationRule'`)
-
 * `MODELHALLUCINATIONRULEV2` (value: `'ModelHallucinationRuleV2'`)
 
-* `MODELHALLUCINATIONRULEV3` (value: `'ModelHallucinationRuleV3'`)
-
 * `MODELSENSITIVEDATARULE` (value: `'ModelSensitiveDataRule'`)
 
 * `PIIDATARULE` (value: `'PIIDataRule'`)

arthur_client/api_bindings/docs/ValidationOutcome.md

@@ -0,0 +1,13 @@
+# ValidationOutcome
+
+Generic class to indicate if a validation passed or failed.
+
+## Enum
+
+* `PASS` (value: `'pass'`)
+
+* `FAIL` (value: `'fail'`)
+
+[[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/ValidationResult.md

@@ -0,0 +1,31 @@
+# ValidationResult
+
+Generic class to indicate a single validation and its outcome.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**validation_description** | **str** | Description of validation requirement. | 
+**validation_outcome** | [**ValidationOutcome**](ValidationOutcome.md) | Outcome of the validation requirement. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.validation_result import ValidationResult
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ValidationResult from a JSON string
+validation_result_instance = ValidationResult.from_json(json)
+# print the JSON string representation of the object
+print(ValidationResult.to_json())
+
+# convert the object into a dict
+validation_result_dict = validation_result_instance.to_dict()
+# create an instance of ValidationResult from a dict
+validation_result_from_dict = ValidationResult.from_dict(validation_result_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/ValidationResults.md

@@ -0,0 +1,30 @@
+# ValidationResults
+
+This class is a generic class for any endpoints returning multiple validation errors.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**validation_results** | [**List[ValidationResult]**](ValidationResult.md) |  | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.validation_results import ValidationResults
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ValidationResults from a JSON string
+validation_results_instance = ValidationResults.from_json(json)
+# print the JSON string representation of the object
+print(ValidationResults.to_json())
+
+# convert the object into a dict
+validation_results_dict = validation_results_instance.to_dict()
+# create an instance of ValidationResults from a dict
+validation_results_from_dict = ValidationResults.from_dict(validation_results_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/models/__init__.py

@@ -31,6 +31,10 @@ from arthur_client.api_bindings.models.alert_webhook_called import AlertWebhookC
 from arthur_client.api_bindings.models.available_dataset import AvailableDataset
 from arthur_client.api_bindings.models.available_datasets_sort import AvailableDatasetsSort
 from arthur_client.api_bindings.models.bad_request_error import BadRequestError
+from arthur_client.api_bindings.models.base_column_parameter_schema import BaseColumnParameterSchema
+from arthur_client.api_bindings.models.base_column_parameter_schema_allowed_column_types_inner import BaseColumnParameterSchemaAllowedColumnTypesInner
+from arthur_client.api_bindings.models.base_dataset_parameter_schema import BaseDatasetParameterSchema
+from arthur_client.api_bindings.models.base_literal_parameter_schema import BaseLiteralParameterSchema
 from arthur_client.api_bindings.models.base_role import BaseRole
 from arthur_client.api_bindings.models.bound_member import BoundMember
 from arthur_client.api_bindings.models.bound_member_kind import BoundMemberKind
@@ -55,6 +59,8 @@ from arthur_client.api_bindings.models.create_model_link_task_job_spec import Cr
 from arthur_client.api_bindings.models.create_model_task_job_spec import CreateModelTaskJobSpec
 from arthur_client.api_bindings.models.created_alerts import CreatedAlerts
 from arthur_client.api_bindings.models.credentials import Credentials
+from arthur_client.api_bindings.models.custom_aggregation_spec_schema import CustomAggregationSpecSchema
+from arthur_client.api_bindings.models.custom_aggregation_spec_schema_aggregate_args_inner import CustomAggregationSpecSchemaAggregateArgsInner
 from arthur_client.api_bindings.models.d_type import DType
 from arthur_client.api_bindings.models.data_plane import DataPlane
 from arthur_client.api_bindings.models.data_plane_association import DataPlaneAssociation
@@ -127,7 +133,6 @@ from arthur_client.api_bindings.models.list_type import ListType
 from arthur_client.api_bindings.models.metrics_arg_spec import MetricsArgSpec
 from arthur_client.api_bindings.models.metrics_calculation_job_spec import MetricsCalculationJobSpec
 from arthur_client.api_bindings.models.metrics_column_list_parameter_schema import MetricsColumnListParameterSchema
-from arthur_client.api_bindings.models.metrics_column_list_parameter_schema_allowed_column_types_inner import MetricsColumnListParameterSchemaAllowedColumnTypesInner
 from arthur_client.api_bindings.models.metrics_column_parameter_schema import MetricsColumnParameterSchema
 from arthur_client.api_bindings.models.metrics_dataset_parameter_schema import MetricsDatasetParameterSchema
 from arthur_client.api_bindings.models.metrics_literal_parameter_schema import MetricsLiteralParameterSchema
@@ -179,6 +184,7 @@ from arthur_client.api_bindings.models.post_alert import PostAlert
 from arthur_client.api_bindings.models.post_alert_rule import PostAlertRule
 from arthur_client.api_bindings.models.post_alerts import PostAlerts
 from arthur_client.api_bindings.models.post_connector_spec import PostConnectorSpec
+from arthur_client.api_bindings.models.post_custom_aggregation_spec_schema import PostCustomAggregationSpecSchema
 from arthur_client.api_bindings.models.post_data_plane import PostDataPlane
 from arthur_client.api_bindings.models.post_data_plane_association import PostDataPlaneAssociation
 from arthur_client.api_bindings.models.post_data_retrieval_operation import PostDataRetrievalOperation
@@ -215,6 +221,7 @@ from arthur_client.api_bindings.models.project_bound_resource_metadata import Pr
 from arthur_client.api_bindings.models.project_sort import ProjectSort
 from arthur_client.api_bindings.models.put_available_dataset import PutAvailableDataset
 from arthur_client.api_bindings.models.put_available_datasets import PutAvailableDatasets
+from arthur_client.api_bindings.models.put_custom_aggregation_spec_schema import PutCustomAggregationSpecSchema
 from arthur_client.api_bindings.models.put_dataset_schema import PutDatasetSchema
 from arthur_client.api_bindings.models.put_job_state import PutJobState
 from arthur_client.api_bindings.models.put_model_metric_spec import PutModelMetricSpec
@@ -225,6 +232,7 @@ from arthur_client.api_bindings.models.put_task_state_cache_request import PutTa
 from arthur_client.api_bindings.models.regenerate_task_validation_key_job_spec import RegenerateTaskValidationKeyJobSpec
 from arthur_client.api_bindings.models.regex_config import RegexConfig
 from arthur_client.api_bindings.models.register_user import RegisterUser
+from arthur_client.api_bindings.models.reported_custom_aggregation import ReportedCustomAggregation
 from arthur_client.api_bindings.models.resource_kind import ResourceKind
 from arthur_client.api_bindings.models.resource_list_aggregation_spec_schema import ResourceListAggregationSpecSchema
 from arthur_client.api_bindings.models.resource_list_alert_rule import ResourceListAlertRule
@@ -284,6 +292,9 @@ from arthur_client.api_bindings.models.user_type import UserType
 from arthur_client.api_bindings.models.validate_alert_rule_query_req import ValidateAlertRuleQueryReq
 from arthur_client.api_bindings.models.validation_error import ValidationError
 from arthur_client.api_bindings.models.validation_error_loc_inner import ValidationErrorLocInner
+from arthur_client.api_bindings.models.validation_outcome import ValidationOutcome
+from arthur_client.api_bindings.models.validation_result import ValidationResult
+from arthur_client.api_bindings.models.validation_results import ValidationResults
 from arthur_client.api_bindings.models.webhook import Webhook
 from arthur_client.api_bindings.models.webhook_response import WebhookResponse
 from arthur_client.api_bindings.models.webhook_result import WebhookResult

arthur_client/api_bindings/models/base_column_parameter_schema.py

@@ -0,0 +1,125 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.base_column_parameter_schema_allowed_column_types_inner import BaseColumnParameterSchemaAllowedColumnTypesInner
+from arthur_client.api_bindings.models.scope_schema_tag import ScopeSchemaTag
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BaseColumnParameterSchema(BaseModel):
+    """
+    BaseColumnParameterSchema
+    """ # noqa: E501
+    parameter_key: StrictStr = Field(description="Name of the parameter.")
+    friendly_name: StrictStr = Field(description="User facing name of the parameter.")
+    description: StrictStr = Field(description="Description of the parameter.")
+    tag_hints: Optional[List[ScopeSchemaTag]] = Field(default=None, description="List of tags that are applicable to this parameter. Datasets with columns that have matching tags can be inferred this way.")
+    source_dataset_parameter_key: StrictStr = Field(description="Name of the parameter that provides the dataset to be used for this column.")
+    allowed_column_types: Optional[List[BaseColumnParameterSchemaAllowedColumnTypesInner]] = None
+    allow_any_column_type: Optional[StrictBool] = Field(default=False, description="Indicates if this metric parameter can accept any column type.")
+    parameter_type: Optional[StrictStr] = 'column'
+    __properties: ClassVar[List[str]] = ["parameter_key", "friendly_name", "description", "tag_hints", "source_dataset_parameter_key", "allowed_column_types", "allow_any_column_type", "parameter_type"]
+
+    @field_validator('parameter_type')
+    def parameter_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['column']):
+            raise ValueError("must be one of enum values ('column')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of BaseColumnParameterSchema from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in allowed_column_types (list)
+        _items = []
+        if self.allowed_column_types:
+            for _item_allowed_column_types in self.allowed_column_types:
+                if _item_allowed_column_types:
+                    _items.append(_item_allowed_column_types.to_dict())
+            _dict['allowed_column_types'] = _items
+        # set to None if allowed_column_types (nullable) is None
+        # and model_fields_set contains the field
+        if self.allowed_column_types is None and "allowed_column_types" in self.model_fields_set:
+            _dict['allowed_column_types'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BaseColumnParameterSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameter_key": obj.get("parameter_key"),
+            "friendly_name": obj.get("friendly_name"),
+            "description": obj.get("description"),
+            "tag_hints": obj.get("tag_hints"),
+            "source_dataset_parameter_key": obj.get("source_dataset_parameter_key"),
+            "allowed_column_types": [BaseColumnParameterSchemaAllowedColumnTypesInner.from_dict(_item) for _item in obj["allowed_column_types"]] if obj.get("allowed_column_types") is not None else None,
+            "allow_any_column_type": obj.get("allow_any_column_type") if obj.get("allow_any_column_type") is not None else False,
+            "parameter_type": obj.get("parameter_type") if obj.get("parameter_type") is not None else 'column'
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/{metrics_column_list_parameter_schema_allowed_column_types_inner.py → base_column_parameter_schema_allowed_column_types_inner.py}

@@ -24,11 +24,11 @@ from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
 from typing_extensions import Literal, Self
 from pydantic import Field
 
-METRICSCOLUMNLISTPARAMETERSCHEMAALLOWEDCOLUMNTYPESINNER_ANY_OF_SCHEMAS = ["ListType", "ObjectType", "ScalarType"]
+BASECOLUMNPARAMETERSCHEMAALLOWEDCOLUMNTYPESINNER_ANY_OF_SCHEMAS = ["ListType", "ObjectType", "ScalarType"]
 
-class MetricsColumnListParameterSchemaAllowedColumnTypesInner(BaseModel):
+class BaseColumnParameterSchemaAllowedColumnTypesInner(BaseModel):
     """
-    MetricsColumnListParameterSchemaAllowedColumnTypesInner
+    BaseColumnParameterSchemaAllowedColumnTypesInner
     """
 
     # data type: ScalarType
@@ -60,7 +60,7 @@ class MetricsColumnListParameterSchemaAllowedColumnTypesInner(BaseModel):
 
     @field_validator('actual_instance')
     def actual_instance_must_validate_anyof(cls, v):
-        instance = MetricsColumnListParameterSchemaAllowedColumnTypesInner.model_construct()
+        instance = BaseColumnParameterSchemaAllowedColumnTypesInner.model_construct()
         error_messages = []
         # validate data type: ScalarType
         if not isinstance(v, ScalarType):
@@ -82,7 +82,7 @@ class MetricsColumnListParameterSchemaAllowedColumnTypesInner(BaseModel):
 
         if error_messages:
             # no match
-            raise ValueError("No match found when setting the actual_instance in MetricsColumnListParameterSchemaAllowedColumnTypesInner with anyOf schemas: ListType, ObjectType, ScalarType. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting the actual_instance in BaseColumnParameterSchemaAllowedColumnTypesInner with anyOf schemas: ListType, ObjectType, ScalarType. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -116,7 +116,7 @@ class MetricsColumnListParameterSchemaAllowedColumnTypesInner(BaseModel):
 
         if error_messages:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into MetricsColumnListParameterSchemaAllowedColumnTypesInner with anyOf schemas: ListType, ObjectType, ScalarType. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into BaseColumnParameterSchemaAllowedColumnTypesInner with anyOf schemas: ListType, ObjectType, ScalarType. Details: " + ", ".join(error_messages))
         else:
             return instance
 
@@ -147,5 +147,5 @@ class MetricsColumnListParameterSchemaAllowedColumnTypesInner(BaseModel):
 from arthur_client.api_bindings.models.list_type import ListType
 from arthur_client.api_bindings.models.object_type import ObjectType
 # TODO: Rewrite to not use raise_errors
-MetricsColumnListParameterSchemaAllowedColumnTypesInner.model_rebuild(raise_errors=False)
+BaseColumnParameterSchemaAllowedColumnTypesInner.model_rebuild(raise_errors=False)
 

arthur_client/api_bindings/models/base_dataset_parameter_schema.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.model_problem_type import ModelProblemType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BaseDatasetParameterSchema(BaseModel):
+    """
+    BaseDatasetParameterSchema
+    """ # noqa: E501
+    parameter_key: StrictStr = Field(description="Name of the parameter.")
+    friendly_name: StrictStr = Field(description="User facing name of the parameter.")
+    description: StrictStr = Field(description="Description of the parameter.")
+    parameter_type: Optional[StrictStr] = 'dataset'
+    model_problem_type: Optional[ModelProblemType] = None
+    __properties: ClassVar[List[str]] = ["parameter_key", "friendly_name", "description", "parameter_type", "model_problem_type"]
+
+    @field_validator('parameter_type')
+    def parameter_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['dataset']):
+            raise ValueError("must be one of enum values ('dataset')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of BaseDatasetParameterSchema from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if model_problem_type (nullable) is None
+        # and model_fields_set contains the field
+        if self.model_problem_type is None and "model_problem_type" in self.model_fields_set:
+            _dict['model_problem_type'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BaseDatasetParameterSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "parameter_key": obj.get("parameter_key"),
+            "friendly_name": obj.get("friendly_name"),
+            "description": obj.get("description"),
+            "parameter_type": obj.get("parameter_type") if obj.get("parameter_type") is not None else 'dataset',
+            "model_problem_type": obj.get("model_problem_type")
+        })
+        return _obj
+
+