arthur-client 1.4.1251__py3-none-any.whl → 1.4.1252__py3-none-any.whl

arthur_client/api_bindings/__init__.py

@@ -287,6 +287,7 @@ from arthur_client.api_bindings.models.resource_list_alert_rule import ResourceL
 from arthur_client.api_bindings.models.resource_list_available_dataset import ResourceListAvailableDataset
 from arthur_client.api_bindings.models.resource_list_connector_spec import ResourceListConnectorSpec
 from arthur_client.api_bindings.models.resource_list_connector_type import ResourceListConnectorType
+from arthur_client.api_bindings.models.resource_list_custom_aggregation_spec_schema import ResourceListCustomAggregationSpecSchema
 from arthur_client.api_bindings.models.resource_list_data_plane import ResourceListDataPlane
 from arthur_client.api_bindings.models.resource_list_data_plane_association import ResourceListDataPlaneAssociation
 from arthur_client.api_bindings.models.resource_list_dataset import ResourceListDataset

arthur_client/api_bindings/api/custom_aggregations_v1_api.py

@@ -16,10 +16,13 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
 from typing import Any, Dict, List, Optional, Tuple, Union
 from typing_extensions import Annotated
 
-from pydantic import StrictStr
+from pydantic import Field, StrictBool, StrictInt, StrictStr
+from typing import Optional
+from typing_extensions import Annotated
 from arthur_client.api_bindings.models.custom_aggregation_spec_schema import CustomAggregationSpecSchema
 from arthur_client.api_bindings.models.post_custom_aggregation_spec_schema import PostCustomAggregationSpecSchema
 from arthur_client.api_bindings.models.put_custom_aggregation_spec_schema import PutCustomAggregationSpecSchema
+from arthur_client.api_bindings.models.resource_list_custom_aggregation_spec_schema import ResourceListCustomAggregationSpecSchema
 from arthur_client.api_bindings.models.validation_results import ValidationResults
 
 from arthur_client.api_bindings.api_client import ApiClient, RequestSerialized
@@ -314,6 +317,10 @@ class CustomAggregationsV1Api:
     def get_custom_aggregation(
         self,
         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)],
@@ -326,13 +333,21 @@ class CustomAggregationsV1Api:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> CustomAggregationSpecSchema:
+    ) -> ResourceListCustomAggregationSpecSchema:
         """Get Custom Aggregation By Id.
 
         Requires custom_aggregation_read permission.
 
         :param custom_aggregation_id: (required)
         :type custom_aggregation_id: str
+        :param version: The version of the custom aggregation to fetch.
+        :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
@@ -357,6 +372,10 @@ class CustomAggregationsV1Api:
 
         _param = self._get_custom_aggregation_serialize(
             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,
@@ -364,7 +383,7 @@ class CustomAggregationsV1Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CustomAggregationSpecSchema",
+            '200': "ResourceListCustomAggregationSpecSchema",
             '500': "InternalServerError",
             '404': "NotFoundError",
             '422': "HTTPValidationError",
@@ -384,6 +403,10 @@ class CustomAggregationsV1Api:
     def get_custom_aggregation_with_http_info(
         self,
         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)],
@@ -396,13 +419,21 @@ class CustomAggregationsV1Api:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[CustomAggregationSpecSchema]:
+    ) -> ApiResponse[ResourceListCustomAggregationSpecSchema]:
         """Get Custom Aggregation By Id.
 
         Requires custom_aggregation_read permission.
 
         :param custom_aggregation_id: (required)
         :type custom_aggregation_id: str
+        :param version: The version of the custom aggregation to fetch.
+        :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
@@ -427,6 +458,10 @@ class CustomAggregationsV1Api:
 
         _param = self._get_custom_aggregation_serialize(
             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,
@@ -434,7 +469,7 @@ class CustomAggregationsV1Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CustomAggregationSpecSchema",
+            '200': "ResourceListCustomAggregationSpecSchema",
             '500': "InternalServerError",
             '404': "NotFoundError",
             '422': "HTTPValidationError",
@@ -454,6 +489,10 @@ class CustomAggregationsV1Api:
     def get_custom_aggregation_without_preload_content(
         self,
         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)],
@@ -473,6 +512,14 @@ class CustomAggregationsV1Api:
 
         :param custom_aggregation_id: (required)
         :type custom_aggregation_id: str
+        :param version: The version of the custom aggregation to fetch.
+        :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
@@ -497,6 +544,10 @@ class CustomAggregationsV1Api:
 
         _param = self._get_custom_aggregation_serialize(
             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,
@@ -504,7 +555,7 @@ class CustomAggregationsV1Api:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CustomAggregationSpecSchema",
+            '200': "ResourceListCustomAggregationSpecSchema",
             '500': "InternalServerError",
             '404': "NotFoundError",
             '422': "HTTPValidationError",
@@ -519,6 +570,10 @@ class CustomAggregationsV1Api:
     def _get_custom_aggregation_serialize(
         self,
         custom_aggregation_id,
+        version,
+        latest,
+        page,
+        page_size,
         _request_auth,
         _content_type,
         _headers,
@@ -543,6 +598,22 @@ class CustomAggregationsV1Api:
         if custom_aggregation_id is not None:
             _path_params['custom_aggregation_id'] = custom_aggregation_id
         # process the query parameters
+        if version is not None:
+            
+            _query_params.append(('version', version))
+            
+        if latest is not None:
+            
+            _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
@@ -580,6 +651,310 @@ class CustomAggregationsV1Api:
 
 
 
+    @validate_call
+    def get_custom_aggregations_for_workspace(
+        self,
+        workspace_id: StrictStr,
+        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)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ResourceListCustomAggregationSpecSchema:
+        """Get Custom Aggregation.
+
+        Requires workspace_list_custom_aggregations permission.
+
+        :param workspace_id: (required)
+        :type workspace_id: str
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_custom_aggregations_for_workspace_serialize(
+            workspace_id=workspace_id,
+            page=page,
+            page_size=page_size,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ResourceListCustomAggregationSpecSchema",
+            '500': "InternalServerError",
+            '404': "NotFoundError",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def get_custom_aggregations_for_workspace_with_http_info(
+        self,
+        workspace_id: StrictStr,
+        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)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[ResourceListCustomAggregationSpecSchema]:
+        """Get Custom Aggregation.
+
+        Requires workspace_list_custom_aggregations permission.
+
+        :param workspace_id: (required)
+        :type workspace_id: str
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_custom_aggregations_for_workspace_serialize(
+            workspace_id=workspace_id,
+            page=page,
+            page_size=page_size,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ResourceListCustomAggregationSpecSchema",
+            '500': "InternalServerError",
+            '404': "NotFoundError",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def get_custom_aggregations_for_workspace_without_preload_content(
+        self,
+        workspace_id: StrictStr,
+        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)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get Custom Aggregation.
+
+        Requires workspace_list_custom_aggregations permission.
+
+        :param workspace_id: (required)
+        :type workspace_id: str
+        :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
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._get_custom_aggregations_for_workspace_serialize(
+            workspace_id=workspace_id,
+            page=page,
+            page_size=page_size,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ResourceListCustomAggregationSpecSchema",
+            '500': "InternalServerError",
+            '404': "NotFoundError",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_custom_aggregations_for_workspace_serialize(
+        self,
+        workspace_id,
+        page,
+        page_size,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if workspace_id is not None:
+            _path_params['workspace_id'] = workspace_id
+        # process the query parameters
+        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
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'OAuth2AuthorizationCode'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/api/v1/workspaces/{workspace_id}/custom_aggregations',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call
     def post_custom_aggregation(
         self,

arthur_client/api_bindings/docs/CustomAggregationSpecSchema.md

@@ -6,14 +6,14 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **str** | Name of the custom aggregation function. | 
-**description** | **str** | Description of the custom aggregation function and what it aggregates. | 
+**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 function. | 
+**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) | User who authored this custom aggregation. | 
+**authored_by** | [**User**](User.md) |  | 
 **created_at** | **datetime** | Time of aggregation creation. | 
 
 ## Example

arthur_client/api_bindings/docs/CustomAggregationsV1Api.md

@@ -6,6 +6,7 @@ Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**delete_custom_aggregation**](CustomAggregationsV1Api.md#delete_custom_aggregation) | **DELETE** /api/v1/custom_aggregations/{custom_aggregation_id} | Delete Custom Aggregation.
 [**get_custom_aggregation**](CustomAggregationsV1Api.md#get_custom_aggregation) | **GET** /api/v1/custom_aggregations/{custom_aggregation_id} | Get Custom Aggregation By Id.
+[**get_custom_aggregations_for_workspace**](CustomAggregationsV1Api.md#get_custom_aggregations_for_workspace) | **GET** /api/v1/workspaces/{workspace_id}/custom_aggregations | Get Custom Aggregation.
 [**post_custom_aggregation**](CustomAggregationsV1Api.md#post_custom_aggregation) | **POST** /api/v1/workspaces/{workspace_id}/custom_aggregations | Post Custom Aggregation.
 [**put_custom_aggregation**](CustomAggregationsV1Api.md#put_custom_aggregation) | **PUT** /api/v1/custom_aggregations/{custom_aggregation_id} | Update Custom Aggregation By Id.
 [**validate_custom_aggregation**](CustomAggregationsV1Api.md#validate_custom_aggregation) | **POST** /api/v1/workspaces/{workspace_id}/validate_custom_aggregation | Validate A Custom Aggregation Before Creation.
@@ -87,7 +88,7 @@ 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**
-> CustomAggregationSpecSchema get_custom_aggregation(custom_aggregation_id)
+> ResourceListCustomAggregationSpecSchema get_custom_aggregation(custom_aggregation_id, version=version, latest=latest, page=page, page_size=page_size)
 
 Get Custom Aggregation By Id.
 
@@ -99,7 +100,7 @@ Requires custom_aggregation_read permission.
 
 ```python
 import arthur_client.api_bindings
-from arthur_client.api_bindings.models.custom_aggregation_spec_schema import CustomAggregationSpecSchema
+from arthur_client.api_bindings.models.resource_list_custom_aggregation_spec_schema import ResourceListCustomAggregationSpecSchema
 from arthur_client.api_bindings.rest import ApiException
 from pprint import pprint
 
@@ -121,10 +122,14 @@ with arthur_client.api_bindings.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = arthur_client.api_bindings.CustomAggregationsV1Api(api_client)
     custom_aggregation_id = 'custom_aggregation_id_example' # str | 
+    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)
+        api_response = api_instance.get_custom_aggregation(custom_aggregation_id, version=version, latest=latest, page=page, page_size=page_size)
         print("The response of CustomAggregationsV1Api->get_custom_aggregation:\n")
         pprint(api_response)
     except Exception as e:
@@ -139,10 +144,96 @@ with arthur_client.api_bindings.ApiClient(configuration) as api_client:
 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
 
-[**CustomAggregationSpecSchema**](CustomAggregationSpecSchema.md)
+[**ResourceListCustomAggregationSpecSchema**](ResourceListCustomAggregationSpecSchema.md)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **get_custom_aggregations_for_workspace**
+> ResourceListCustomAggregationSpecSchema get_custom_aggregations_for_workspace(workspace_id, page=page, page_size=page_size)
+
+Get Custom Aggregation.
+
+Requires workspace_list_custom_aggregations permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```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.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.CustomAggregationsV1Api(api_client)
+    workspace_id = 'workspace_id_example' # str | 
+    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.
+        api_response = api_instance.get_custom_aggregations_for_workspace(workspace_id, page=page, page_size=page_size)
+        print("The response of CustomAggregationsV1Api->get_custom_aggregations_for_workspace:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling CustomAggregationsV1Api->get_custom_aggregations_for_workspace: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **workspace_id** | **str**|  | 
+ **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)
 
 ### Authorization
 

arthur_client/api_bindings/docs/PermissionName.md

@@ -93,6 +93,8 @@
 
 * `WORKSPACE_LIST_DATASETS` (value: `'workspace_list_datasets'`)
 
+* `WORKSPACE_LIST_CUSTOM_AGGREGATIONS` (value: `'workspace_list_custom_aggregations'`)
+
 * `PROJECT_READ` (value: `'project_read'`)
 
 * `PROJECT_UPDATE` (value: `'project_update'`)