arthur-client 1.4.1055__py3-none-any.whl → 1.4.1186__py3-none-any.whl

arthur_client/api_bindings/docs/MetricsColumnListParameterSchemaAllowedColumnTypesInner.md

@@ -0,0 +1,31 @@
+# MetricsColumnListParameterSchemaAllowedColumnTypesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dtype** | [**DType**](DType.md) |  | 
+**object** | [**Dict[str, MetricsColumnListParameterSchemaAllowedColumnTypesInner]**](MetricsColumnListParameterSchemaAllowedColumnTypesInner.md) |  | 
+**items** | [**Items1**](Items1.md) |  | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.metrics_column_list_parameter_schema_allowed_column_types_inner import MetricsColumnListParameterSchemaAllowedColumnTypesInner
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of MetricsColumnListParameterSchemaAllowedColumnTypesInner from a JSON string
+metrics_column_list_parameter_schema_allowed_column_types_inner_instance = MetricsColumnListParameterSchemaAllowedColumnTypesInner.from_json(json)
+# print the JSON string representation of the object
+print(MetricsColumnListParameterSchemaAllowedColumnTypesInner.to_json())
+
+# convert the object into a dict
+metrics_column_list_parameter_schema_allowed_column_types_inner_dict = metrics_column_list_parameter_schema_allowed_column_types_inner_instance.to_dict()
+# create an instance of MetricsColumnListParameterSchemaAllowedColumnTypesInner from a dict
+metrics_column_list_parameter_schema_allowed_column_types_inner_from_dict = MetricsColumnListParameterSchemaAllowedColumnTypesInner.from_dict(metrics_column_list_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/MetricsColumnParameterSchema.md

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 **parameter_type** | **str** |  | [optional] [default to 'column']
 **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[MetricsColumnParameterSchemaAllowedColumnTypesInner]**](MetricsColumnParameterSchemaAllowedColumnTypesInner.md) |  | [optional] 
+**allowed_column_types** | [**List[MetricsColumnListParameterSchemaAllowedColumnTypesInner]**](MetricsColumnListParameterSchemaAllowedColumnTypesInner.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/ObjectType.md

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

arthur_client/api_bindings/docs/PatchAlertRule.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **bound** | [**AlertBound**](AlertBound.md) |  | [optional] 
 **query** | **str** |  | [optional] 
 **metric_name** | **str** |  | [optional] 
+**interval** | [**AlertRuleInterval**](AlertRuleInterval.md) |  | [optional] 
 **notification_webhook_ids** | **List[str]** |  | [optional] 
 
 ## Example

arthur_client/api_bindings/docs/PostAlert.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **value** | **float** | The value of the metric that triggered the alert. | 
 **threshold** | **float** | The threshold that triggered the alert. | 
 **bound** | [**AlertBound**](AlertBound.md) | The bound of the alert. | 
+**interval** | [**AlertRuleInterval**](AlertRuleInterval.md) | The interval of the alert rule, commonly '1 day', '1 hour', etc. | 
 **dimensions** | **object** |  | 
 **alert_rule_id** | **str** | The alert rule id of the alert. | 
 **job_id** | **str** |  | [optional] 

arthur_client/api_bindings/docs/PostAlertRule.md

@@ -11,6 +11,7 @@ Name | Type | Description | Notes
 **bound** | [**AlertBound**](AlertBound.md) | The bound of the alert rule. | 
 **query** | **str** | The query of the alert rule. | 
 **metric_name** | **str** | The name of the metric returned by the alert rule query. | 
+**interval** | [**AlertRuleInterval**](AlertRuleInterval.md) | The interval of the alert rule, commonly '1 day', '1 hour', etc. | 
 **notification_webhook_ids** | **List[str]** | The notification webhook IDs where the alert rule will send alert notification. | [optional] [default to []]
 
 ## Example

arthur_client/api_bindings/docs/PostMetricsQuery.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **query** | **str** | Query for retrieving the metrics. | 
 **time_range** | [**PostMetricsQueryTimeRange**](PostMetricsQueryTimeRange.md) | Time range to filter the metrics by. | 
+**interval** | [**AlertRuleInterval**](AlertRuleInterval.md) |  | [optional] 
 **limit** | **int** | Limit the number of metrics returned. Defaults to 50. | [optional] [default to 50]
 **result_filter** | [**ResultFilter**](ResultFilter.md) |  | [optional] 
 

arthur_client/api_bindings/docs/ValidateAlertRuleQueryReq.md

@@ -0,0 +1,29 @@
+# ValidateAlertRuleQueryReq
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **str** | The query of the alert rule. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.validate_alert_rule_query_req import ValidateAlertRuleQueryReq
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ValidateAlertRuleQueryReq from a JSON string
+validate_alert_rule_query_req_instance = ValidateAlertRuleQueryReq.from_json(json)
+# print the JSON string representation of the object
+print(ValidateAlertRuleQueryReq.to_json())
+
+# convert the object into a dict
+validate_alert_rule_query_req_dict = validate_alert_rule_query_req_instance.to_dict()
+# create an instance of ValidateAlertRuleQueryReq from a dict
+validate_alert_rule_query_req_from_dict = ValidateAlertRuleQueryReq.from_dict(validate_alert_rule_query_req_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

@@ -22,7 +22,9 @@ from arthur_client.api_bindings.models.alert import Alert
 from arthur_client.api_bindings.models.alert_bound import AlertBound
 from arthur_client.api_bindings.models.alert_check_job_spec import AlertCheckJobSpec
 from arthur_client.api_bindings.models.alert_rule import AlertRule
+from arthur_client.api_bindings.models.alert_rule_interval import AlertRuleInterval
 from arthur_client.api_bindings.models.alert_rule_notification_webhook import AlertRuleNotificationWebhook
+from arthur_client.api_bindings.models.alert_rule_sql_validation_resp import AlertRuleSQLValidationResp
 from arthur_client.api_bindings.models.alert_rule_sort import AlertRuleSort
 from arthur_client.api_bindings.models.alert_sort import AlertSort
 from arthur_client.api_bindings.models.alert_webhook_called import AlertWebhookCalled
@@ -99,6 +101,7 @@ from arthur_client.api_bindings.models.infinite_pagination import InfinitePagina
 from arthur_client.api_bindings.models.infinite_resource_list_alert import InfiniteResourceListAlert
 from arthur_client.api_bindings.models.infinite_resource_list_job import InfiniteResourceListJob
 from arthur_client.api_bindings.models.internal_server_error import InternalServerError
+from arthur_client.api_bindings.models.interval_unit import IntervalUnit
 from arthur_client.api_bindings.models.invite_new_user import InviteNewUser
 from arthur_client.api_bindings.models.items import Items
 from arthur_client.api_bindings.models.items1 import Items1
@@ -124,8 +127,8 @@ 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_column_parameter_schema_allowed_column_types_inner import MetricsColumnParameterSchemaAllowedColumnTypesInner
 from arthur_client.api_bindings.models.metrics_dataset_parameter_schema import MetricsDatasetParameterSchema
 from arthur_client.api_bindings.models.metrics_literal_parameter_schema import MetricsLiteralParameterSchema
 from arthur_client.api_bindings.models.metrics_query_result import MetricsQueryResult
@@ -278,6 +281,7 @@ from arthur_client.api_bindings.models.user_credentials import UserCredentials
 from arthur_client.api_bindings.models.user_service_account_credentials import UserServiceAccountCredentials
 from arthur_client.api_bindings.models.user_sort import UserSort
 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.webhook import Webhook

arthur_client/api_bindings/models/alert.py

@@ -21,6 +21,7 @@ from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from arthur_client.api_bindings.models.alert_bound import AlertBound
+from arthur_client.api_bindings.models.alert_rule_interval import AlertRuleInterval
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -33,6 +34,7 @@ class Alert(BaseModel):
     value: Union[StrictFloat, StrictInt] = Field(description="The value of the metric that triggered the alert.")
     threshold: Union[StrictFloat, StrictInt] = Field(description="The threshold that triggered the alert.")
     bound: AlertBound = Field(description="The bound of the alert.")
+    interval: AlertRuleInterval = Field(description="The interval of the alert rule, commonly '1 day', '1 hour', etc.")
     dimensions: Optional[Dict[str, Any]]
     alert_rule_id: StrictStr = Field(description="The alert rule id of the alert.")
     job_id: Optional[StrictStr] = None
@@ -43,7 +45,7 @@ class Alert(BaseModel):
     alert_rule_name: StrictStr = Field(description="The name of the alert rule.")
     alert_rule_metric_name: StrictStr = Field(description="The name of the metric returned by the alert rule query.")
     is_duplicate_of: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["description", "timestamp", "value", "threshold", "bound", "dimensions", "alert_rule_id", "job_id", "created_at", "updated_at", "id", "model_id", "alert_rule_name", "alert_rule_metric_name", "is_duplicate_of"]
+    __properties: ClassVar[List[str]] = ["description", "timestamp", "value", "threshold", "bound", "interval", "dimensions", "alert_rule_id", "job_id", "created_at", "updated_at", "id", "model_id", "alert_rule_name", "alert_rule_metric_name", "is_duplicate_of"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -84,6 +86,9 @@ class Alert(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of interval
+        if self.interval:
+            _dict['interval'] = self.interval.to_dict()
         # set to None if description (nullable) is None
         # and model_fields_set contains the field
         if self.description is None and "description" in self.model_fields_set:
@@ -121,6 +126,7 @@ class Alert(BaseModel):
             "value": obj.get("value"),
             "threshold": obj.get("threshold"),
             "bound": obj.get("bound"),
+            "interval": AlertRuleInterval.from_dict(obj["interval"]) if obj.get("interval") is not None else None,
             "dimensions": obj.get("dimensions"),
             "alert_rule_id": obj.get("alert_rule_id"),
             "job_id": obj.get("job_id"),

arthur_client/api_bindings/models/alert_rule.py

@@ -21,6 +21,7 @@ from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional, Union
 from arthur_client.api_bindings.models.alert_bound import AlertBound
+from arthur_client.api_bindings.models.alert_rule_interval import AlertRuleInterval
 from arthur_client.api_bindings.models.alert_rule_notification_webhook import AlertRuleNotificationWebhook
 from arthur_client.api_bindings.models.user import User
 from typing import Optional, Set
@@ -40,9 +41,10 @@ class AlertRule(BaseModel):
     bound: AlertBound = Field(description="The bound of the alert rule.")
     query: StrictStr = Field(description="The query of the alert rule.")
     metric_name: StrictStr = Field(description="The name of the metric returned by the alert rule query.")
+    interval: AlertRuleInterval = Field(description="The interval of the alert rule, commonly '1 day', '1 hour', etc.")
     last_updated_by_user: Optional[User] = None
     notification_webhooks: List[AlertRuleNotificationWebhook] = Field(description="Notification webhooks configured for the alert rule.")
-    __properties: ClassVar[List[str]] = ["created_at", "updated_at", "id", "model_id", "name", "description", "threshold", "bound", "query", "metric_name", "last_updated_by_user", "notification_webhooks"]
+    __properties: ClassVar[List[str]] = ["created_at", "updated_at", "id", "model_id", "name", "description", "threshold", "bound", "query", "metric_name", "interval", "last_updated_by_user", "notification_webhooks"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -83,6 +85,9 @@ class AlertRule(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of interval
+        if self.interval:
+            _dict['interval'] = self.interval.to_dict()
         # override the default output from pydantic by calling `to_dict()` of last_updated_by_user
         if self.last_updated_by_user:
             _dict['last_updated_by_user'] = self.last_updated_by_user.to_dict()
@@ -125,6 +130,7 @@ class AlertRule(BaseModel):
             "bound": obj.get("bound"),
             "query": obj.get("query"),
             "metric_name": obj.get("metric_name"),
+            "interval": AlertRuleInterval.from_dict(obj["interval"]) if obj.get("interval") is not None else None,
             "last_updated_by_user": User.from_dict(obj["last_updated_by_user"]) if obj.get("last_updated_by_user") is not None else None,
             "notification_webhooks": [AlertRuleNotificationWebhook.from_dict(_item) for _item in obj["notification_webhooks"]] if obj.get("notification_webhooks") is not None else None
         })

arthur_client/api_bindings/models/alert_rule_interval.py

@@ -0,0 +1,90 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List
+from arthur_client.api_bindings.models.interval_unit import IntervalUnit
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AlertRuleInterval(BaseModel):
+    """
+    AlertRuleInterval
+    """ # noqa: E501
+    unit: IntervalUnit = Field(description="Unit of time interval. Example: 'minutes'.")
+    count: StrictInt = Field(description="Number of units in the interval. Example: '5'.")
+    __properties: ClassVar[List[str]] = ["unit", "count"]
+
+    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 AlertRuleInterval 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AlertRuleInterval from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "unit": obj.get("unit"),
+            "count": obj.get("count")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/alert_rule_sql_validation_resp.py

@@ -0,0 +1,93 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AlertRuleSQLValidationResp(BaseModel):
+    """
+    AlertRuleSQLValidationResp
+    """ # noqa: E501
+    has_metric_timestamp_col: StrictBool = Field(description="The name of the metric returned by the alert rule query.")
+    has_metric_value_col: StrictBool = Field(description="The name of the metric returned by the alert rule query.")
+    has_time_templates: StrictBool = Field(description="The name of the metric returned by the alert rule query.")
+    has_interval_templates: StrictBool = Field(description="The name of the metric returned by the alert rule query.")
+    __properties: ClassVar[List[str]] = ["has_metric_timestamp_col", "has_metric_value_col", "has_time_templates", "has_interval_templates"]
+
+    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 AlertRuleSQLValidationResp 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,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AlertRuleSQLValidationResp from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "has_metric_timestamp_col": obj.get("has_metric_timestamp_col"),
+            "has_metric_value_col": obj.get("has_metric_value_col"),
+            "has_time_templates": obj.get("has_time_templates"),
+            "has_interval_templates": obj.get("has_interval_templates")
+        })
+        return _obj
+
+

arthur_client/api_bindings/models/d_type.py

@@ -35,6 +35,7 @@ class DType(str, Enum):
     TIMESTAMP = 'timestamp'
     DATE = 'date'
     JSON = 'json'
+    IMAGE = 'image'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

arthur_client/api_bindings/models/dataset_locator_field_data_type.py

@@ -29,6 +29,7 @@ class DatasetLocatorFieldDataType(str, Enum):
     UUID = 'UUID'
     STRING = 'string'
     ENUM = 'enum'
+    REGEX_STRING = 'regex_string'
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

arthur_client/api_bindings/models/interval_unit.py

@@ -0,0 +1,39 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class IntervalUnit(str, Enum):
+    """
+    IntervalUnit
+    """
+
+    """
+    allowed enum values
+    """
+    SECONDS = 'seconds'
+    MINUTES = 'minutes'
+    HOURS = 'hours'
+    DAYS = 'days'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of IntervalUnit from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/models/metrics_column_list_parameter_schema.py

@@ -19,6 +19,8 @@ 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.metrics_column_list_parameter_schema_allowed_column_types_inner import MetricsColumnListParameterSchemaAllowedColumnTypesInner
+from arthur_client.api_bindings.models.scope_schema_tag import ScopeSchemaTag
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -31,7 +33,11 @@ class MetricsColumnListParameterSchema(BaseModel):
     friendly_name: StrictStr = Field(description="User facing name of the parameter.")
     description: StrictStr = Field(description="Description of the parameter.")
     parameter_type: Optional[StrictStr] = 'column_list'
-    __properties: ClassVar[List[str]] = ["parameter_key", "optional", "friendly_name", "description", "parameter_type"]
+    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[MetricsColumnListParameterSchemaAllowedColumnTypesInner]] = None
+    allow_any_column_type: Optional[StrictBool] = Field(default=False, description="Indicates if this metric parameter can accept any column type.")
+    __properties: ClassVar[List[str]] = ["parameter_key", "optional", "friendly_name", "description", "parameter_type", "tag_hints", "source_dataset_parameter_key", "allowed_column_types", "allow_any_column_type"]
 
     @field_validator('parameter_type')
     def parameter_type_validate_enum(cls, value):
@@ -82,6 +88,18 @@ class MetricsColumnListParameterSchema(BaseModel):
             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
@@ -98,7 +116,11 @@ class MetricsColumnListParameterSchema(BaseModel):
             "optional": obj.get("optional") if obj.get("optional") is not None else False,
             "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 'column_list'
+            "parameter_type": obj.get("parameter_type") if obj.get("parameter_type") is not None else 'column_list',
+            "tag_hints": obj.get("tag_hints"),
+            "source_dataset_parameter_key": obj.get("source_dataset_parameter_key"),
+            "allowed_column_types": [MetricsColumnListParameterSchemaAllowedColumnTypesInner.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
         })
         return _obj
 

arthur_client/api_bindings/models/{metrics_column_parameter_schema_allowed_column_types_inner.py → metrics_column_list_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
 
-METRICSCOLUMNPARAMETERSCHEMAALLOWEDCOLUMNTYPESINNER_ANY_OF_SCHEMAS = ["ListType", "ObjectType", "ScalarType"]
+METRICSCOLUMNLISTPARAMETERSCHEMAALLOWEDCOLUMNTYPESINNER_ANY_OF_SCHEMAS = ["ListType", "ObjectType", "ScalarType"]
 
-class MetricsColumnParameterSchemaAllowedColumnTypesInner(BaseModel):
+class MetricsColumnListParameterSchemaAllowedColumnTypesInner(BaseModel):
     """
-    MetricsColumnParameterSchemaAllowedColumnTypesInner
+    MetricsColumnListParameterSchemaAllowedColumnTypesInner
     """
 
     # data type: ScalarType
@@ -60,7 +60,7 @@ class MetricsColumnParameterSchemaAllowedColumnTypesInner(BaseModel):
 
     @field_validator('actual_instance')
     def actual_instance_must_validate_anyof(cls, v):
-        instance = MetricsColumnParameterSchemaAllowedColumnTypesInner.model_construct()
+        instance = MetricsColumnListParameterSchemaAllowedColumnTypesInner.model_construct()
         error_messages = []
         # validate data type: ScalarType
         if not isinstance(v, ScalarType):
@@ -82,7 +82,7 @@ class MetricsColumnParameterSchemaAllowedColumnTypesInner(BaseModel):
 
         if error_messages:
             # no match
-            raise ValueError("No match found when setting the actual_instance in MetricsColumnParameterSchemaAllowedColumnTypesInner with anyOf schemas: ListType, ObjectType, ScalarType. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting the actual_instance in MetricsColumnListParameterSchemaAllowedColumnTypesInner with anyOf schemas: ListType, ObjectType, ScalarType. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -116,7 +116,7 @@ class MetricsColumnParameterSchemaAllowedColumnTypesInner(BaseModel):
 
         if error_messages:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into MetricsColumnParameterSchemaAllowedColumnTypesInner with anyOf schemas: ListType, ObjectType, ScalarType. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into MetricsColumnListParameterSchemaAllowedColumnTypesInner with anyOf schemas: ListType, ObjectType, ScalarType. Details: " + ", ".join(error_messages))
         else:
             return instance
 
@@ -147,5 +147,5 @@ class MetricsColumnParameterSchemaAllowedColumnTypesInner(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
-MetricsColumnParameterSchemaAllowedColumnTypesInner.model_rebuild(raise_errors=False)
+MetricsColumnListParameterSchemaAllowedColumnTypesInner.model_rebuild(raise_errors=False)
 

arthur_client/api_bindings/models/metrics_column_parameter_schema.py

@@ -19,7 +19,7 @@ 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.metrics_column_parameter_schema_allowed_column_types_inner import MetricsColumnParameterSchemaAllowedColumnTypesInner
+from arthur_client.api_bindings.models.metrics_column_list_parameter_schema_allowed_column_types_inner import MetricsColumnListParameterSchemaAllowedColumnTypesInner
 from arthur_client.api_bindings.models.scope_schema_tag import ScopeSchemaTag
 from typing import Optional, Set
 from typing_extensions import Self
@@ -35,7 +35,7 @@ class MetricsColumnParameterSchema(BaseModel):
     parameter_type: Optional[StrictStr] = 'column'
     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[MetricsColumnParameterSchemaAllowedColumnTypesInner]] = None
+    allowed_column_types: Optional[List[MetricsColumnListParameterSchemaAllowedColumnTypesInner]] = None
     allow_any_column_type: Optional[StrictBool] = Field(default=False, description="Indicates if this metric parameter can accept any column type.")
     __properties: ClassVar[List[str]] = ["parameter_key", "optional", "friendly_name", "description", "parameter_type", "tag_hints", "source_dataset_parameter_key", "allowed_column_types", "allow_any_column_type"]
 
@@ -119,7 +119,7 @@ class MetricsColumnParameterSchema(BaseModel):
             "parameter_type": obj.get("parameter_type") if obj.get("parameter_type") is not None else 'column',
             "tag_hints": obj.get("tag_hints"),
             "source_dataset_parameter_key": obj.get("source_dataset_parameter_key"),
-            "allowed_column_types": [MetricsColumnParameterSchemaAllowedColumnTypesInner.from_dict(_item) for _item in obj["allowed_column_types"]] if obj.get("allowed_column_types") is not None else None,
+            "allowed_column_types": [MetricsColumnListParameterSchemaAllowedColumnTypesInner.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
         })
         return _obj

arthur_client/api_bindings/models/object_type.py

@@ -26,7 +26,7 @@ class ObjectType(BaseModel):
     """
     ObjectType
     """ # noqa: E501
-    object: Dict[str, MetricsColumnParameterSchemaAllowedColumnTypesInner]
+    object: Dict[str, MetricsColumnListParameterSchemaAllowedColumnTypesInner]
     __properties: ClassVar[List[str]] = ["object"]
 
     model_config = ConfigDict(
@@ -88,7 +88,7 @@ class ObjectType(BaseModel):
 
         _obj = cls.model_validate({
             "object": dict(
-                (_k, MetricsColumnParameterSchemaAllowedColumnTypesInner.from_dict(_v))
+                (_k, MetricsColumnListParameterSchemaAllowedColumnTypesInner.from_dict(_v))
                 for _k, _v in obj["object"].items()
             )
             if obj.get("object") is not None
@@ -96,7 +96,7 @@ class ObjectType(BaseModel):
         })
         return _obj
 
-from arthur_client.api_bindings.models.metrics_column_parameter_schema_allowed_column_types_inner import MetricsColumnParameterSchemaAllowedColumnTypesInner
+from arthur_client.api_bindings.models.metrics_column_list_parameter_schema_allowed_column_types_inner import MetricsColumnListParameterSchemaAllowedColumnTypesInner
 # TODO: Rewrite to not use raise_errors
 ObjectType.model_rebuild(raise_errors=False)