arthur-client 1.4.1283__tar.gz → 1.4.1285__tar.gz

{arthur_client-1.4.1283 → arthur_client-1.4.1285}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: arthur-client
-Version: 1.4.1283
+Version: 1.4.1285
 Summary: Arthur Python API Client Library
 License: MIT
 Keywords: api arthur client ArthurAI sdk ml model monitoring

{arthur_client-1.4.1283 → arthur_client-1.4.1285}/arthur_client/api_bindings/__init__.py

@@ -105,7 +105,8 @@ from arthur_client.api_bindings.models.create_model_task_job_spec import CreateM
 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.custom_aggregation_version_spec_schema import CustomAggregationVersionSpecSchema
+from arthur_client.api_bindings.models.custom_aggregation_version_spec_schema_aggregate_args_inner import CustomAggregationVersionSpecSchemaAggregateArgsInner
 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

{arthur_client-1.4.1283 → arthur_client-1.4.1285}/arthur_client/api_bindings/api/custom_aggregations_v1_api.py

@@ -319,8 +319,6 @@ class CustomAggregationsV1Api:
         custom_aggregation_id: StrictStr,
         version: Annotated[Optional[StrictInt], Field(description="The version of the custom aggregation to fetch.")] = None,
         latest: Annotated[Optional[StrictBool], Field(description="Whether to fetch the latest version of the custom aggregation.")] = None,
-        page: Annotated[Optional[StrictInt], Field(description="The page number to fetch.")] = None,
-        page_size: Annotated[Optional[StrictInt], Field(description="The number of items per page.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -333,10 +331,10 @@ class CustomAggregationsV1Api:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ResourceListCustomAggregationSpecSchema:
+    ) -> CustomAggregationSpecSchema:
         """Get Custom Aggregation By Id.
 
-        Requires custom_aggregation_read permission.
+        Requires custom_aggregation_read permission. Includes version filters to specify the versions included on the returned aggregation.
 
         :param custom_aggregation_id: (required)
         :type custom_aggregation_id: str
@@ -344,10 +342,6 @@ class CustomAggregationsV1Api:
         :type version: int
         :param latest: Whether to fetch the latest version of the custom aggregation.
         :type latest: bool
-        :param page: The page number to fetch.
-        :type page: int
-        :param page_size: The number of items per page.
-        :type page_size: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -374,8 +368,6 @@ class CustomAggregationsV1Api:
             custom_aggregation_id=custom_aggregation_id,
             version=version,
             latest=latest,
-            page=page,
-            page_size=page_size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -383,7 +375,7 @@ class CustomAggregationsV1Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ResourceListCustomAggregationSpecSchema",
+            '200': "CustomAggregationSpecSchema",
             '500': "InternalServerError",
             '404': "NotFoundError",
             '422': "HTTPValidationError",
@@ -405,8 +397,6 @@ class CustomAggregationsV1Api:
         custom_aggregation_id: StrictStr,
         version: Annotated[Optional[StrictInt], Field(description="The version of the custom aggregation to fetch.")] = None,
         latest: Annotated[Optional[StrictBool], Field(description="Whether to fetch the latest version of the custom aggregation.")] = None,
-        page: Annotated[Optional[StrictInt], Field(description="The page number to fetch.")] = None,
-        page_size: Annotated[Optional[StrictInt], Field(description="The number of items per page.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -419,10 +409,10 @@ class CustomAggregationsV1Api:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[ResourceListCustomAggregationSpecSchema]:
+    ) -> ApiResponse[CustomAggregationSpecSchema]:
         """Get Custom Aggregation By Id.
 
-        Requires custom_aggregation_read permission.
+        Requires custom_aggregation_read permission. Includes version filters to specify the versions included on the returned aggregation.
 
         :param custom_aggregation_id: (required)
         :type custom_aggregation_id: str
@@ -430,10 +420,6 @@ class CustomAggregationsV1Api:
         :type version: int
         :param latest: Whether to fetch the latest version of the custom aggregation.
         :type latest: bool
-        :param page: The page number to fetch.
-        :type page: int
-        :param page_size: The number of items per page.
-        :type page_size: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -460,8 +446,6 @@ class CustomAggregationsV1Api:
             custom_aggregation_id=custom_aggregation_id,
             version=version,
             latest=latest,
-            page=page,
-            page_size=page_size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -469,7 +453,7 @@ class CustomAggregationsV1Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ResourceListCustomAggregationSpecSchema",
+            '200': "CustomAggregationSpecSchema",
             '500': "InternalServerError",
             '404': "NotFoundError",
             '422': "HTTPValidationError",
@@ -491,8 +475,6 @@ class CustomAggregationsV1Api:
         custom_aggregation_id: StrictStr,
         version: Annotated[Optional[StrictInt], Field(description="The version of the custom aggregation to fetch.")] = None,
         latest: Annotated[Optional[StrictBool], Field(description="Whether to fetch the latest version of the custom aggregation.")] = None,
-        page: Annotated[Optional[StrictInt], Field(description="The page number to fetch.")] = None,
-        page_size: Annotated[Optional[StrictInt], Field(description="The number of items per page.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -508,7 +490,7 @@ class CustomAggregationsV1Api:
     ) -> RESTResponseType:
         """Get Custom Aggregation By Id.
 
-        Requires custom_aggregation_read permission.
+        Requires custom_aggregation_read permission. Includes version filters to specify the versions included on the returned aggregation.
 
         :param custom_aggregation_id: (required)
         :type custom_aggregation_id: str
@@ -516,10 +498,6 @@ class CustomAggregationsV1Api:
         :type version: int
         :param latest: Whether to fetch the latest version of the custom aggregation.
         :type latest: bool
-        :param page: The page number to fetch.
-        :type page: int
-        :param page_size: The number of items per page.
-        :type page_size: int
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -546,8 +524,6 @@ class CustomAggregationsV1Api:
             custom_aggregation_id=custom_aggregation_id,
             version=version,
             latest=latest,
-            page=page,
-            page_size=page_size,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -555,7 +531,7 @@ class CustomAggregationsV1Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "ResourceListCustomAggregationSpecSchema",
+            '200': "CustomAggregationSpecSchema",
             '500': "InternalServerError",
             '404': "NotFoundError",
             '422': "HTTPValidationError",
@@ -572,8 +548,6 @@ class CustomAggregationsV1Api:
         custom_aggregation_id,
         version,
         latest,
-        page,
-        page_size,
         _request_auth,
         _content_type,
         _headers,
@@ -606,14 +580,6 @@ class CustomAggregationsV1Api:
             
             _query_params.append(('latest', latest))
             
-        if page is not None:
-            
-            _query_params.append(('page', page))
-            
-        if page_size is not None:
-            
-            _query_params.append(('page_size', page_size))
-            
         # process the header parameters
         # process the form parameters
         # process the body parameter

{arthur_client-1.4.1283 → arthur_client-1.4.1285}/arthur_client/api_bindings/docs/CustomAggregationSpecSchema.md

@@ -5,16 +5,12 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**id** | **str** | Unique identifier of the custom aggregation with version. | 
 **name** | **str** | Name of the custom aggregation function. | 
 **description** | **str** |  | [optional] 
-**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 with version. | 
 **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) |  | 
-**created_at** | **datetime** | Time of aggregation creation. | 
+**versions** | [**List[CustomAggregationVersionSpecSchema]**](CustomAggregationVersionSpecSchema.md) | List of versions of the custom aggregation configuration. | 
+**latest_version** | **int** | Max/latest version of the custom aggregation that exists. This version may or may not be included in the list of versions depending on applied filters. | 
 
 ## Example
 

arthur_client-1.4.1285/arthur_client/api_bindings/docs/CustomAggregationVersionSpecSchema.md

@@ -0,0 +1,35 @@
+# CustomAggregationVersionSpecSchema
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**custom_aggregation_id** | **str** | ID of parent custom aggregation. | 
+**version** | **int** | Version number of the custom aggregation function. | 
+**authored_by** | [**User**](User.md) |  | 
+**created_at** | **datetime** | Time of aggregation creation. | 
+**reported_aggregations** | [**List[ReportedCustomAggregation]**](ReportedCustomAggregation.md) | Metadata for every aggregation the custom aggregation reports. | 
+**aggregate_args** | [**List[CustomAggregationVersionSpecSchemaAggregateArgsInner]**](CustomAggregationVersionSpecSchemaAggregateArgsInner.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.custom_aggregation_version_spec_schema import CustomAggregationVersionSpecSchema
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of CustomAggregationVersionSpecSchema from a JSON string
+custom_aggregation_version_spec_schema_instance = CustomAggregationVersionSpecSchema.from_json(json)
+# print the JSON string representation of the object
+print(CustomAggregationVersionSpecSchema.to_json())
+
+# convert the object into a dict
+custom_aggregation_version_spec_schema_dict = custom_aggregation_version_spec_schema_instance.to_dict()
+# create an instance of CustomAggregationVersionSpecSchema from a dict
+custom_aggregation_version_spec_schema_from_dict = CustomAggregationVersionSpecSchema.from_dict(custom_aggregation_version_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-1.4.1283/arthur_client/api_bindings/docs/CustomAggregationSpecSchemaAggregateArgsInner.md → arthur_client-1.4.1285/arthur_client/api_bindings/docs/CustomAggregationVersionSpecSchemaAggregateArgsInner.md

@@ -1,4 +1,4 @@
-# CustomAggregationSpecSchemaAggregateArgsInner
+# CustomAggregationVersionSpecSchemaAggregateArgsInner
 
 
 ## Properties
@@ -19,19 +19,19 @@ Name | Type | Description | Notes
 ## Example
 
 ```python
-from arthur_client.api_bindings.models.custom_aggregation_spec_schema_aggregate_args_inner import CustomAggregationSpecSchemaAggregateArgsInner
+from arthur_client.api_bindings.models.custom_aggregation_version_spec_schema_aggregate_args_inner import CustomAggregationVersionSpecSchemaAggregateArgsInner
 
 # 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)
+# create an instance of CustomAggregationVersionSpecSchemaAggregateArgsInner from a JSON string
+custom_aggregation_version_spec_schema_aggregate_args_inner_instance = CustomAggregationVersionSpecSchemaAggregateArgsInner.from_json(json)
 # print the JSON string representation of the object
-print(CustomAggregationSpecSchemaAggregateArgsInner.to_json())
+print(CustomAggregationVersionSpecSchemaAggregateArgsInner.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)
+custom_aggregation_version_spec_schema_aggregate_args_inner_dict = custom_aggregation_version_spec_schema_aggregate_args_inner_instance.to_dict()
+# create an instance of CustomAggregationVersionSpecSchemaAggregateArgsInner from a dict
+custom_aggregation_version_spec_schema_aggregate_args_inner_from_dict = CustomAggregationVersionSpecSchemaAggregateArgsInner.from_dict(custom_aggregation_version_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-1.4.1283 → arthur_client-1.4.1285}/arthur_client/api_bindings/docs/CustomAggregationsV1Api.md

@@ -88,11 +88,11 @@ void (empty response body)
 [[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**
-> ResourceListCustomAggregationSpecSchema get_custom_aggregation(custom_aggregation_id, version=version, latest=latest, page=page, page_size=page_size)
+> CustomAggregationSpecSchema get_custom_aggregation(custom_aggregation_id, version=version, latest=latest)
 
 Get Custom Aggregation By Id.
 
-Requires custom_aggregation_read permission.
+Requires custom_aggregation_read permission. Includes version filters to specify the versions included on the returned aggregation.
 
 ### Example
 
@@ -100,7 +100,7 @@ Requires custom_aggregation_read permission.
 
 ```python
 import arthur_client.api_bindings
-from arthur_client.api_bindings.models.resource_list_custom_aggregation_spec_schema import ResourceListCustomAggregationSpecSchema
+from arthur_client.api_bindings.models.custom_aggregation_spec_schema import CustomAggregationSpecSchema
 from arthur_client.api_bindings.rest import ApiException
 from pprint import pprint
 
@@ -124,12 +124,10 @@ with arthur_client.api_bindings.ApiClient(configuration) as api_client:
     custom_aggregation_id = 'custom_aggregation_id_example' # str | 
     version = 56 # int | The version of the custom aggregation to fetch. (optional)
     latest = False # bool | Whether to fetch the latest version of the custom aggregation. (optional) (default to False)
-    page = 1 # int | The page number to fetch. (optional) (default to 1)
-    page_size = 10 # int | The number of items per page. (optional) (default to 10)
 
     try:
         # Get Custom Aggregation By Id.
-        api_response = api_instance.get_custom_aggregation(custom_aggregation_id, version=version, latest=latest, page=page, page_size=page_size)
+        api_response = api_instance.get_custom_aggregation(custom_aggregation_id, version=version, latest=latest)
         print("The response of CustomAggregationsV1Api->get_custom_aggregation:\n")
         pprint(api_response)
     except Exception as e:
@@ -146,12 +144,10 @@ Name | Type | Description  | Notes
  **custom_aggregation_id** | **str**|  | 
  **version** | **int**| The version of the custom aggregation to fetch. | [optional] 
  **latest** | **bool**| Whether to fetch the latest version of the custom aggregation. | [optional] [default to False]
- **page** | **int**| The page number to fetch. | [optional] [default to 1]
- **page_size** | **int**| The number of items per page. | [optional] [default to 10]
 
 ### Return type
 
-[**ResourceListCustomAggregationSpecSchema**](ResourceListCustomAggregationSpecSchema.md)
+[**CustomAggregationSpecSchema**](CustomAggregationSpecSchema.md)
 
 ### Authorization
 

{arthur_client-1.4.1283 → arthur_client-1.4.1285}/arthur_client/api_bindings/docs/PostCustomAggregationSpecSchema.md

@@ -5,11 +5,11 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **str** | Name of the custom aggregation function. | 
-**description** | **str** |  | [optional] 
 **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. | 
+**aggregate_args** | [**List[CustomAggregationVersionSpecSchemaAggregateArgsInner]**](CustomAggregationVersionSpecSchemaAggregateArgsInner.md) | List of parameters to the custom aggregation's query function. | 
 **sql** | **str** | DuckDBSQL query for the custom aggregation. | 
+**name** | **str** | Name of the custom aggregation function. | 
+**description** | **str** |  | [optional] 
 
 ## Example
 

{arthur_client-1.4.1283 → arthur_client-1.4.1285}/arthur_client/api_bindings/docs/PutCustomAggregationSpecSchema.md

@@ -5,10 +5,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | **str** | Name of the custom aggregation function. | 
-**description** | **str** |  | [optional] 
 **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. | 
+**aggregate_args** | [**List[CustomAggregationVersionSpecSchemaAggregateArgsInner]**](CustomAggregationVersionSpecSchemaAggregateArgsInner.md) | List of parameters to the custom aggregation's query function. | 
 **sql** | **str** | DuckDBSQL query for the custom aggregation. | 
 
 ## Example

{arthur_client-1.4.1283 → arthur_client-1.4.1285}/arthur_client/api_bindings/models/__init__.py

@@ -62,7 +62,8 @@ from arthur_client.api_bindings.models.create_model_task_job_spec import CreateM
 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.custom_aggregation_version_spec_schema import CustomAggregationVersionSpecSchema
+from arthur_client.api_bindings.models.custom_aggregation_version_spec_schema_aggregate_args_inner import CustomAggregationVersionSpecSchemaAggregateArgsInner
 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

arthur_client-1.4.1285/arthur_client/api_bindings/models/custom_aggregation_spec_schema.py

@@ -0,0 +1,110 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.custom_aggregation_version_spec_schema import CustomAggregationVersionSpecSchema
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CustomAggregationSpecSchema(BaseModel):
+    """
+    CustomAggregationSpecSchema
+    """ # noqa: E501
+    id: StrictStr = Field(description="Unique identifier of the custom aggregation with version.")
+    name: StrictStr = Field(description="Name of the custom aggregation function.")
+    description: Optional[StrictStr] = None
+    workspace_id: StrictStr = Field(description="Unique identifier of the custom aggregation's parent workspace.")
+    versions: List[CustomAggregationVersionSpecSchema] = Field(description="List of versions of the custom aggregation configuration.")
+    latest_version: StrictInt = Field(description="Max/latest version of the custom aggregation that exists. This version may or may not be included in the list of versions depending on applied filters.")
+    __properties: ClassVar[List[str]] = ["id", "name", "description", "workspace_id", "versions", "latest_version"]
+
+    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 CustomAggregationSpecSchema 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 versions (list)
+        _items = []
+        if self.versions:
+            for _item_versions in self.versions:
+                if _item_versions:
+                    _items.append(_item_versions.to_dict())
+            _dict['versions'] = _items
+        # 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:
+            _dict['description'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CustomAggregationSpecSchema from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "workspace_id": obj.get("workspace_id"),
+            "versions": [CustomAggregationVersionSpecSchema.from_dict(_item) for _item in obj["versions"]] if obj.get("versions") is not None else None,
+            "latest_version": obj.get("latest_version")
+        })
+        return _obj
+
+

arthur_client-1.4.1283/arthur_client/api_bindings/models/custom_aggregation_spec_schema.py → arthur_client-1.4.1285/arthur_client/api_bindings/models/custom_aggregation_version_spec_schema.py

@@ -21,27 +21,24 @@ from datetime import datetime
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing_extensions import Annotated
-from arthur_client.api_bindings.models.custom_aggregation_spec_schema_aggregate_args_inner import CustomAggregationSpecSchemaAggregateArgsInner
+from arthur_client.api_bindings.models.custom_aggregation_version_spec_schema_aggregate_args_inner import CustomAggregationVersionSpecSchemaAggregateArgsInner
 from arthur_client.api_bindings.models.reported_custom_aggregation import ReportedCustomAggregation
 from arthur_client.api_bindings.models.user import User
 from typing import Optional, Set
 from typing_extensions import Self
 
-class CustomAggregationSpecSchema(BaseModel):
+class CustomAggregationVersionSpecSchema(BaseModel):
     """
-    CustomAggregationSpecSchema
+    CustomAggregationVersionSpecSchema
     """ # noqa: E501
-    name: StrictStr = Field(description="Name of the custom aggregation function.")
-    description: Optional[StrictStr] = None
-    reported_aggregations: Annotated[List[ReportedCustomAggregation], Field(min_length=1)] = Field(description="Metadata for every aggregation the custom aggregation reports.")
-    aggregate_args: List[CustomAggregationSpecSchemaAggregateArgsInner] = Field(description="List of parameters to the custom aggregation's query function.")
-    sql: StrictStr = Field(description="DuckDBSQL query for the custom aggregation.")
-    id: StrictStr = Field(description="Unique identifier of the custom aggregation with version.")
-    workspace_id: StrictStr = Field(description="Unique identifier of the custom aggregation's parent workspace.")
+    custom_aggregation_id: StrictStr = Field(description="ID of parent custom aggregation.")
     version: StrictInt = Field(description="Version number of the custom aggregation function.")
     authored_by: Optional[User]
     created_at: datetime = Field(description="Time of aggregation creation.")
-    __properties: ClassVar[List[str]] = ["name", "description", "reported_aggregations", "aggregate_args", "sql", "id", "workspace_id", "version", "authored_by", "created_at"]
+    reported_aggregations: Annotated[List[ReportedCustomAggregation], Field(min_length=1)] = Field(description="Metadata for every aggregation the custom aggregation reports.")
+    aggregate_args: List[CustomAggregationVersionSpecSchemaAggregateArgsInner] = Field(description="List of parameters to the custom aggregation's query function.")
+    sql: StrictStr = Field(description="DuckDBSQL query for the custom aggregation.")
+    __properties: ClassVar[List[str]] = ["custom_aggregation_id", "version", "authored_by", "created_at", "reported_aggregations", "aggregate_args", "sql"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -61,7 +58,7 @@ class CustomAggregationSpecSchema(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of CustomAggregationSpecSchema from a JSON string"""
+        """Create an instance of CustomAggregationVersionSpecSchema from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -82,6 +79,9 @@ class CustomAggregationSpecSchema(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # override the default output from pydantic by calling `to_dict()` of authored_by
+        if self.authored_by:
+            _dict['authored_by'] = self.authored_by.to_dict()
         # override the default output from pydantic by calling `to_dict()` of each item in reported_aggregations (list)
         _items = []
         if self.reported_aggregations:
@@ -96,14 +96,6 @@ class CustomAggregationSpecSchema(BaseModel):
                 if _item_aggregate_args:
                     _items.append(_item_aggregate_args.to_dict())
             _dict['aggregate_args'] = _items
-        # override the default output from pydantic by calling `to_dict()` of authored_by
-        if self.authored_by:
-            _dict['authored_by'] = self.authored_by.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:
-            _dict['description'] = None
-
         # set to None if authored_by (nullable) is None
         # and model_fields_set contains the field
         if self.authored_by is None and "authored_by" in self.model_fields_set:
@@ -113,7 +105,7 @@ class CustomAggregationSpecSchema(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of CustomAggregationSpecSchema from a dict"""
+        """Create an instance of CustomAggregationVersionSpecSchema from a dict"""
         if obj is None:
             return None
 
@@ -121,16 +113,13 @@ class CustomAggregationSpecSchema(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "name": obj.get("name"),
-            "description": obj.get("description"),
-            "reported_aggregations": [ReportedCustomAggregation.from_dict(_item) for _item in obj["reported_aggregations"]] if obj.get("reported_aggregations") is not None else None,
-            "aggregate_args": [CustomAggregationSpecSchemaAggregateArgsInner.from_dict(_item) for _item in obj["aggregate_args"]] if obj.get("aggregate_args") is not None else None,
-            "sql": obj.get("sql"),
-            "id": obj.get("id"),
-            "workspace_id": obj.get("workspace_id"),
+            "custom_aggregation_id": obj.get("custom_aggregation_id"),
             "version": obj.get("version"),
             "authored_by": User.from_dict(obj["authored_by"]) if obj.get("authored_by") is not None else None,
-            "created_at": obj.get("created_at")
+            "created_at": obj.get("created_at"),
+            "reported_aggregations": [ReportedCustomAggregation.from_dict(_item) for _item in obj["reported_aggregations"]] if obj.get("reported_aggregations") is not None else None,
+            "aggregate_args": [CustomAggregationVersionSpecSchemaAggregateArgsInner.from_dict(_item) for _item in obj["aggregate_args"]] if obj.get("aggregate_args") is not None else None,
+            "sql": obj.get("sql")
         })
         return _obj
 

arthur_client-1.4.1283/arthur_client/api_bindings/models/custom_aggregation_spec_schema_aggregate_args_inner.py → arthur_client-1.4.1285/arthur_client/api_bindings/models/custom_aggregation_version_spec_schema_aggregate_args_inner.py

@@ -26,11 +26,11 @@ from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
 from typing_extensions import Literal, Self
 from pydantic import Field
 
-CUSTOMAGGREGATIONSPECSCHEMAAGGREGATEARGSINNER_ANY_OF_SCHEMAS = ["BaseColumnParameterSchema", "BaseDatasetParameterSchema", "BaseLiteralParameterSchema"]
+CUSTOMAGGREGATIONVERSIONSPECSCHEMAAGGREGATEARGSINNER_ANY_OF_SCHEMAS = ["BaseColumnParameterSchema", "BaseDatasetParameterSchema", "BaseLiteralParameterSchema"]
 
-class CustomAggregationSpecSchemaAggregateArgsInner(BaseModel):
+class CustomAggregationVersionSpecSchemaAggregateArgsInner(BaseModel):
     """
-    CustomAggregationSpecSchemaAggregateArgsInner
+    CustomAggregationVersionSpecSchemaAggregateArgsInner
     """
 
     # data type: BaseDatasetParameterSchema
@@ -62,7 +62,7 @@ class CustomAggregationSpecSchemaAggregateArgsInner(BaseModel):
 
     @field_validator('actual_instance')
     def actual_instance_must_validate_anyof(cls, v):
-        instance = CustomAggregationSpecSchemaAggregateArgsInner.model_construct()
+        instance = CustomAggregationVersionSpecSchemaAggregateArgsInner.model_construct()
         error_messages = []
         # validate data type: BaseDatasetParameterSchema
         if not isinstance(v, BaseDatasetParameterSchema):
@@ -84,7 +84,7 @@ class CustomAggregationSpecSchemaAggregateArgsInner(BaseModel):
 
         if error_messages:
             # no match
-            raise ValueError("No match found when setting the actual_instance in CustomAggregationSpecSchemaAggregateArgsInner with anyOf schemas: BaseColumnParameterSchema, BaseDatasetParameterSchema, BaseLiteralParameterSchema. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when setting the actual_instance in CustomAggregationVersionSpecSchemaAggregateArgsInner with anyOf schemas: BaseColumnParameterSchema, BaseDatasetParameterSchema, BaseLiteralParameterSchema. Details: " + ", ".join(error_messages))
         else:
             return v
 
@@ -118,7 +118,7 @@ class CustomAggregationSpecSchemaAggregateArgsInner(BaseModel):
 
         if error_messages:
             # no match
-            raise ValueError("No match found when deserializing the JSON string into CustomAggregationSpecSchemaAggregateArgsInner with anyOf schemas: BaseColumnParameterSchema, BaseDatasetParameterSchema, BaseLiteralParameterSchema. Details: " + ", ".join(error_messages))
+            raise ValueError("No match found when deserializing the JSON string into CustomAggregationVersionSpecSchemaAggregateArgsInner with anyOf schemas: BaseColumnParameterSchema, BaseDatasetParameterSchema, BaseLiteralParameterSchema. Details: " + ", ".join(error_messages))
         else:
             return instance