peak-sdk 1.16.1__py3-none-any.whl → 1.18.0__py3-none-any.whl

peak/metrics/metrics.py

@@ -56,6 +56,8 @@ class Metric(BaseClient):
         The metrics can be published either by passing artifact and namespace,
         or by passing collection_id and namespace. If both artifact and collection_id
         are provided, artifact takes priority. If the namespace is not provided, the 'default' namespace is used.
+        You can optionally include `namespaceMetadata` and `namespaceDescription` in the body
+        to provide additional context about the namespace.
 
         REFERENCE:
             🔗 `API Documentation <https://service.peak.ai/semantic-layer/api-docs/index.htm#/Metrics/post_api_v1_metrics>`__
@@ -74,6 +76,8 @@ class Metric(BaseClient):
 
                 {
                   "namespace": "string",
+                  "namespaceMetadata": { "key": "value" },
+                  "namespaceDescription": "Optional description"
                 }
 
         Raises:
@@ -84,10 +88,12 @@ class Metric(BaseClient):
             UnprocessableEntityException: The server was unable to process the request.
             InternalServerErrorException: The server failed to process the request.
         """
+        if body and "namespaceMetadata" in body:
+            body["namespaceMetadata"] = json.dumps(body["namespaceMetadata"])
+
         if artifact:
             method, endpoint = HttpMethods.POST, f"{self.BASE_ENDPOINT}/metrics"
             path = self.__get_artifact_details(artifact)
-
             return self.session.create_request(  # type: ignore[no-any-return]
                 endpoint,
                 method,
@@ -111,7 +117,7 @@ class Metric(BaseClient):
 
     def query(
         self,
-        measures: List[str],
+        measures: Optional[List[str]] = None,
         namespace: Optional[str] = None,
         generate_sql: Optional[bool] = False,  # noqa: FBT002
         dimensions: Optional[List[str]] = None,
@@ -128,7 +134,7 @@ class Metric(BaseClient):
             🔗 `API Documentation <https://service.peak.ai/semantic-layer/api-docs/index.htm#/Query/get_api_v1_metrics_query>`__
 
         Args:
-            measures (List[str]): An array of measures to include in the query. Measures represent quantitative metrics such as sums or counts.
+            measures (List[str] | None): An array of measures to include in the query. Measures represent quantitative metrics such as sums or counts.
             namespace (str | None): The namespace associated with the metrics. If not provided, the default namespace is used.
             generate_sql (bool | None): Indicates whether to return the SQL query instead of data. If `true`, the response will include the SQL query used to retrieve the metrics. Default is `false`.
             dimensions (List[str] | None): An array of dimensions to include in the query. Dimensions represent qualitative categories such as time, location, or product names.
@@ -183,7 +189,9 @@ class Metric(BaseClient):
         self,
         page_size: Optional[int] = None,
         page_number: Optional[int] = None,
+        publication_id: Optional[str] = None,
         namespace: Optional[str] = None,
+        search_term: Optional[str] = None,
         type: Optional[str] = None,  # noqa: A002
         *,
         return_iterator: Literal[False],
@@ -194,7 +202,9 @@ class Metric(BaseClient):
         self,
         page_size: Optional[int] = None,
         page_number: Optional[int] = None,
+        publication_id: Optional[str] = None,
         namespace: Optional[str] = None,
+        search_term: Optional[str] = None,
         type: Optional[str] = None,  # noqa: A002
         *,
         return_iterator: Literal[True] = True,
@@ -204,7 +214,9 @@ class Metric(BaseClient):
         self,
         page_size: Optional[int] = None,
         page_number: Optional[int] = None,
+        publication_id: Optional[str] = None,
         namespace: Optional[str] = None,
+        search_term: Optional[str] = None,
         type: Optional[str] = None,  # noqa: A002
         *,
         return_iterator: bool = True,
@@ -217,7 +229,9 @@ class Metric(BaseClient):
         Args:
             page_size (int | None): The number of images per page.
             page_number (int | None): The page number to retrieve. Only used when `return_iterator` is False.
+            publication_id (str | None): The publication ID to retrieve metrics from. If not provided, all metrics are retrieved.
             namespace (str | None): The namespace associated with the metrics. If not provided, the default namespace is used.
+            search_term (str | None): The search term to filter the metrics by. If not provided, all metrics are retrieved.
             type (str | None): The type of metrics to retrieve. If not provided, all metrics are retrieved. Available types are `cube`, `view`, `dimension`, `measure`, `segment` and `all`.
             return_iterator (bool): Whether to return an iterator object or list of metrics for a specified page number, defaults to True.
 
@@ -236,7 +250,9 @@ class Metric(BaseClient):
         method, endpoint = HttpMethods.GET, f"{self.BASE_ENDPOINT}/metrics"
         params = {
             "pageSize": page_size,
+            "publicationId": publication_id,
             "namespace": namespace,
+            "searchTerm": search_term,
             "type": type,
         }
 
@@ -537,6 +553,50 @@ class Metric(BaseClient):
             params={**params, "pageNumber": page_number},
         )
 
+    def update_namespace(
+        self,
+        namespace: str,
+        description: Optional[str] = None,
+        metadata: Optional[Dict[str, Any]] = None,
+    ) -> Dict[str, Any]:
+        """Update a namespace with a new description and metadata.
+
+        REFERENCE:
+            🔗 `API Documentation <https://service.peak.ai/semantic-layer/api-docs/index.htm#/Namespaces/patch_api_v1_namespaces__namespace_>`__
+
+        Args:
+            namespace (str): The name of the namespace to update.
+            description (str | None): The new description for the namespace.
+            metadata (Dict[str, Any] | None): The new metadata for the namespace.
+
+        Returns:
+            Dict[str, Any]: A dictionary containing details about the updated namespace.
+
+        Raises:
+            InvalidParameterException: The given request parameters are invalid.
+            UnauthorizedException: The credentials are invalid.
+            ForbiddenException: The user does not have permission to perform the operation.
+            NotFoundException: The given namespace does not exist.
+            UnprocessableEntityException: The server was unable to process the request.
+            InternalServerErrorException: The server failed to process the request.
+        """
+        if not namespace:
+            raise InvalidParameterException(message="Namespace must be provided.")
+
+        method, endpoint = HttpMethods.PATCH, f"{self.BASE_ENDPOINT}/namespaces/{namespace}"
+        body = {}
+        if description is not None:
+            body["description"] = description
+        if metadata is not None:
+            body["metadata"] = json.dumps(metadata)
+
+        return self.session.create_request(  # type: ignore[no-any-return]
+            endpoint,
+            method,
+            content_type=ContentType.APPLICATION_JSON,
+            body=body,
+        )
+
 
 def get_client(session: Optional[Session] = None) -> Metric:
     """Returns a Metrics client, If no session is provided, a default session is used.

peak/resources/__init__.py

@@ -24,11 +24,12 @@ from __future__ import annotations
 
 from typing import List
 
-from peak.resources import alerts, artifacts, images, services, tenants, users, webapps, workflows
+from peak.resources import alerts, artifacts, cache, images, services, tenants, users, webapps, workflows
 
 __all__: List[str] = [
     "alerts",
     "artifacts",
+    "cache",
     "images",
     "services",
     "tenants",