peak-sdk 1.11.0__py3-none-any.whl → 1.13.0__py3-none-any.whl

peak/press/apps.py

@@ -147,6 +147,7 @@ class App(BaseClient):
         featured: Optional[bool] = None,
         scope: Optional[str] = None,
         tenants: Optional[List[str]] = None,
+        parameters: Optional[Dict[str, List[Dict[str, Any]]]] = None,
     ) -> Dict[str, str]:
         """Creates a new App spec.
 
@@ -166,6 +167,10 @@ class App(BaseClient):
                 and `shared` allows specifying what set of tenants can access and use this spec.
                 By default it is `private`.
             tenants (List[str] | None): Given a shared scope, specify what other tenants can discover and deploy this spec.
+            parameters (Optional[Dict[str, List[Dict[str, Any]]]]): A dictionary containing optional keys `build` and `run`. The structure of the dictionary is as follows:
+
+                - `build` (List[Dict[str, Any]], optional): A list of parameter objects, the values of which will be given and used at deployment time.
+                - `run` (List[Dict[str, Any]], optional): A list of parameter objects, the values of which will be given at deployment time and will be used at run time.
 
         Returns:
             Dict[str, str]: Id of the created app spec.
@@ -203,6 +208,37 @@ class App(BaseClient):
                         }
                     ]
                 }
+        SCHEMA(Parameters):
+            The valid types for parameters are `boolean`, `string`, `string_array`, `number`, `number_array`, `object` and `object_array`.
+
+            .. code-block:: json
+
+                {
+                    "build": [
+                        {
+                            "name": "string(required)",
+                            "type": "string(required)",
+                            "required": "boolean(required)",
+                            "description": "string",
+                            "defaultValue": "string(required)",
+                            "title": "string",
+                            "options": "list(str)",
+                            "hideValue": "boolean",
+                        }
+                    ],
+                    "run": [
+                        {
+                            "name": "string(required)",
+                            "type": "string(required)",
+                            "required": "boolean(required)",
+                            "description": "string",
+                            "defaultValue": "string(required)",
+                            "title": "string",
+                            "options": "list(str)",
+                            "hideValue": "boolean",
+                        }
+                    ]
+                }
 
         Raises:
             BadRequestException: The given parameters are invalid.
@@ -218,6 +254,7 @@ class App(BaseClient):
             "spec": json.dumps(body),
             "featured": json.dumps(featured),
             "scope": scope,
+            "parameters": json.dumps(parameters),
         }
 
         if tenants:
@@ -319,7 +356,12 @@ class App(BaseClient):
             subdomain="press",
         )
 
-    def create_spec_release(self, spec_id: str, body: Dict[str, Any]) -> Dict[str, str]:
+    def create_spec_release(
+        self,
+        spec_id: str,
+        body: Dict[str, Any],
+        parameters: Optional[Dict[str, List[Dict[str, Any]]]] = None,
+    ) -> Dict[str, str]:
         """Publish a new release to an existing App spec.
 
         Spec details (Block spec ID and Release version) needs to be added to the `config` key.
@@ -331,6 +373,10 @@ class App(BaseClient):
         Args:
             spec_id (str): Id of the spec in which new release will be created
             body (Dict[str, Any]): Dictionary containing updated release and config in the expected format.
+            parameters (Optional[Dict[str, List[Dict[str, Any]]]]): A dictionary containing optional keys `build` and `run`. The structure of the dictionary is as follows:
+
+                - `build` (List[Dict[str, Any]], optional): A list of parameter objects, the values of which will be given and used at deployment time.
+                - `run` (List[Dict[str, Any]], optional): A list of parameter objects, the values of which will be given at deployment time and will be used at run time.
 
         Returns:
             Dict[str, str]: Dictionary containing spec id and release version
@@ -354,6 +400,36 @@ class App(BaseClient):
                     }
                 }
 
+        SCHEMA(Parameters):
+            The valid types for parameters are `boolean`, `string`, `string_array`, `number`, `number_array`, `object` and `object_array`.
+
+            .. code-block:: json
+
+                {
+                    "build": [
+                        {
+                            "defaultValue": "string(required)",
+                            "description": "string",
+                            "hideValue": "boolean",
+                            "name": "string(required)",
+                            "required": "boolean(required)",
+                            "title": "string",
+                            "type": "string(required)",
+                        }
+                    ],
+                    "run": [
+                        {
+                            "defaultValue": "string(required)",
+                            "description": "string",
+                            "hideValue": "boolean",
+                            "name": "string(required)",
+                            "required": "boolean(required)",
+                            "title": "string",
+                            "type": "string(required)",
+                        }
+                    ]
+                }
+
         Raises:
             BadRequestException: The given parameters are invalid.
             UnauthorizedException: The credentials are invalid.
@@ -369,7 +445,10 @@ class App(BaseClient):
             endpoint,
             method,
             content_type=ContentType.APPLICATION_JSON,
-            body=body,
+            body={
+                **body,
+                "parameters": parameters,
+            },
             subdomain="press",
         )
 
@@ -517,7 +596,7 @@ class App(BaseClient):
             subdomain="press",
         )
 
-    def create_deployment(self, body: Dict[str, str]) -> Dict[str, str]:
+    def create_deployment(self, body: Dict[str, Any]) -> Dict[str, str]:
         """Creates a new deployment from App spec.
 
         Uses the latest spec release if release version is not provided.
@@ -548,6 +627,14 @@ class App(BaseClient):
                         ],
                         "title": "string"
                     },
+                    "appParameters": {
+                        "build": {
+                            "param_name": "param_value (string | number | boolean | array)"
+                        },
+                        "run": {
+                            "param_name": "param_value (string | number | boolean | array)"
+                        }
+                    },
                     "parameters": {
                         "spec_name": {
                             "build": {
@@ -772,7 +859,7 @@ class App(BaseClient):
             subdomain="press",
         )
 
-    def create_deployment_revision(self, deployment_id: str, body: Dict[str, str]) -> Dict[str, str]:
+    def create_deployment_revision(self, deployment_id: str, body: Dict[str, Any]) -> Dict[str, str]:
         """Creates a new Revision of a Deployment, from a selected App Spec Release.
 
         Publish a new revision of an App Deployment. The payload must specify the release version of the parent spec that you wish to use (if one is not provided, the latest available will be used),
@@ -798,6 +885,14 @@ class App(BaseClient):
                     "revision": {
                         "notes": "string",
                     },
+                    "appParameters": {
+                        "build": {
+                            "param_name": "param_value (string | number | boolean | array)"
+                        },
+                        "run": {
+                            "param_name": "param_value (string | number | boolean | array)"
+                        }
+                    },
                     "parameters": {
                         "block-name-1":{
                             "build": {
@@ -984,7 +1079,7 @@ class App(BaseClient):
                     "summary": "string",
                     "tags": [
                         {
-                        "name": "string",
+                            "name": "string",
                         }
                     ],
                     "title": "string",

peak/press/blocks.py

@@ -542,6 +542,7 @@ class Block(BaseClient):
                                     "secrets": []
                                 },
                                 "sessionStickiness": "boolean (only for web-app service)",
+                                "scaleToZero": "boolean (only for web-app service)",
                                 "entrypoint": "string",
                                 "healthCheckURL": "string",
                                 "minInstances": "number. Default is 1 and maximum is 2",
@@ -1090,6 +1091,7 @@ class Block(BaseClient):
                                     "secrets": []
                                 },
                                 "sessionStickiness": "boolean (only for web-app service)",
+                                "scaleToZero": "boolean (only for web-app service)",
                                 "entrypoint": "string",
                                 "healthCheckURL": "string",
                                 "minInstances": "number. Default is 1 and maximum is 2",

peak/press/deployments.py

@@ -153,6 +153,41 @@ class Deployment(BaseClient):
             subdomain="press",
         )
 
+    def patch_parameters(
+        self,
+        deployment_id: str,
+        body: Dict[str, Any],
+    ) -> Dict[str, Any]:
+        """Get the parameters for a deployment at run time.
+
+        REFERENCE:
+            🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/Deployment%20Parameters/patch_v1_deployments__deploymentId__parameters_run>`__
+
+        Args:
+            deployment_id (str): The ID of the deployment.
+            body (Dict[str, Any]): Dictionary containing the updated parameters.
+
+        Returns:
+            Dict[str, Any]: Dictionary containing the updated parameters.
+
+        Raises:
+            BadRequestException: The given parameters are invalid.
+            UnauthorizedException: The credentials are invalid.
+            ForbiddenException: The user does not have permission to perform the operation.
+            NotFoundException: The given deployment does not exist.
+            InternalServerErrorException: The server encountered an unexpected condition that
+                prevented it from fulfilling the request.
+        """
+        method, endpoint = HttpMethods.PATCH, f"v1/deployments/{deployment_id}/parameters/run"
+
+        return self.session.create_request(  # type: ignore[no-any-return]
+            endpoint,
+            method,
+            body=body,
+            content_type=ContentType.APPLICATION_JSON,
+            subdomain="press",
+        )
+
 
 def get_client(session: Optional[Session] = None) -> Deployment:
     """Returns a Deployment client.

peak/resources/__init__.py

@@ -26,4 +26,13 @@ from typing import List
 
 from peak.resources import alerts, artifacts, images, services, tenants, users, webapps, workflows
 
-__all__: List[str] = ["alerts", "artifacts", "images", "services", "tenants", "users", "webapps", "workflows"]
+__all__: List[str] = [
+    "alerts",
+    "artifacts",
+    "images",
+    "services",
+    "tenants",
+    "users",
+    "webapps",
+    "workflows",
+]

peak/resources/services.py

@@ -152,6 +152,7 @@ class Service(BaseClient):
                     },
                     "description": "string",
                     "sessionStickiness": "boolean. Not required for 'api' service type.",
+                    "scaleToZero": "boolean. Only for 'web-app' service type.",
                     "entrypoint": "string",
                     "healthCheckURL": "string",
                     "minInstances": "number. Default is 1 and maximum is 2",
@@ -180,7 +181,7 @@ class Service(BaseClient):
         """Updates the existing service.
 
         When updating the service, it will trigger a redeployment only under specific conditions.
-        Redeployment is triggered if you make changes to any of the following parameters: imageId, versionId, instanceTypeId, parameters, healthCheckURL, entrypoint or sessionStickiness.
+        Redeployment is triggered if you make changes to any of the following parameters: imageId, versionId, instanceTypeId, parameters, healthCheckURL, entrypoint, scaleToZero or sessionStickiness.
         However, only modifying the title or description will not trigger a redeployment.
 
         With the help of this operation, we can just update the required fields (except name and serviceType) and keep the rest of the fields as it is.
@@ -215,6 +216,7 @@ class Service(BaseClient):
                     },
                     "description": "string",
                     "sessionStickiness": "boolean. Not required for 'api' service type.",
+                    "scaleToZero": "boolean. Only for 'web-app' service type.",
                     "entrypoint": "string",
                     "healthCheckURL": "string",
                     "minInstances": "number. Default is 1 and maximum is 2",
@@ -240,7 +242,7 @@ class Service(BaseClient):
         """Create a new service or updates an existing service based on service name.
 
         When updating the service, it will trigger a redeployment only under specific conditions.
-        Redeployment is triggered if you make changes to any of the following parameters: imageId, versionId, instanceTypeId, parameters, healthCheckURL, entrypoint or sessionStickiness.
+        Redeployment is triggered if you make changes to any of the following parameters: imageId, versionId, instanceTypeId, parameters, healthCheckURL, entrypoint, scaleToZero or sessionStickiness.
         However, only modifying the title or description will not trigger a redeployment.
 
         REFERENCE:
@@ -274,6 +276,7 @@ class Service(BaseClient):
                     },
                     "description": "string",
                     "sessionStickiness": "boolean. Not required for 'api' service type.",
+                    "scaleToZero": "boolean. Only for 'web-app' service type.",
                     "entrypoint": "string",
                     "healthCheckURL": "string",
                     "minInstances": "number. Default is 1 and maximum is 2",

peak/sample_yaml/metrics/create_collection.yaml

@@ -0,0 +1,8 @@
+# create_collection.yaml
+
+body:
+  name: test
+  scope: public
+  description: "This collection is used for product metrics"
+artifact:
+  path: metrics

peak/sample_yaml/metrics/publish.yaml

@@ -0,0 +1,6 @@
+# publish.yaml
+
+body:
+  namespace: dev
+artifact:
+  path: metrics

peak/sample_yaml/metrics/query.yaml

@@ -0,0 +1,25 @@
+namespace: default
+generateSql: false
+measures:
+  - product.price
+dimensions:
+  - product.name
+filters:
+  - dimension: product.category
+    operator: equals
+    values:
+      - "electronics"
+timeDimensions:
+  - dimension: product.created_at
+    dateRange:
+      - "2020-01-26T00:00:00Z"
+      - "2020-02-06T00:00:00Z"
+    granularity: day
+segments:
+  - product.category
+  - product.price
+order:
+  product.created_at: desc
+  product.price: asc
+limit: 100
+ofset: 0

peak/sample_yaml/press/apps/deployments/create_app_deployment.yaml

@@ -10,6 +10,18 @@ body:
     imageUrl: https://my-block-pics.com/image-0.jpg
     tags:
       - name: CLI
+  appParameters:
+    build:
+      watcher_user: "abc@123.com"
+      use_cache: true
+      runtime_exceeded: 10
+    run:
+      agg_type: "SUM"
+      num_iterations: 50
+      email_notifications: true
+      file_names:
+        - input.csv
+        - output.csv
   parameters:
     block-1:
       build:

peak/sample_yaml/press/apps/deployments/create_app_deployment_revision.yaml

@@ -1,6 +1,18 @@
 # app_deployment_revision.yaml
 
 body:
+  appParameters:
+    build:
+      watcher_user: "abc@123.com"
+      use_cache: true
+      runtime_exceeded: 10
+    run:
+      agg_type: "SUM"
+      num_iterations: 50
+      email_notifications: true
+      file_names:
+        - input.csv
+        - output.csv
   parameters:
     block-1:
       build:

peak/sample_yaml/press/apps/specs/create_app_spec.yaml

@@ -24,6 +24,69 @@ body:
       release:
         version: 1.0.0
       autoRunOnDeploy: False
+parameters:
+  build:
+    - name: watcher_user
+      type: string
+      required: true
+      title: Watcher User Email
+      description: Set the watcher user email
+      defaultValue: user@peak.ai
+      hideValue: false
+    - name: use_cache
+      type: boolean
+      required: false
+      title: Image Caching
+      description: Enable image caching for the workflow
+      defaultValue: false
+    - name: runtime_exceeded
+      type: number
+      required: false
+      title: Runtime Exceeded
+      description: Select the runtime exceeded value to trigger a failed notification for the workflow (in minutes)
+      options:
+        - title: Low
+          value: 10
+        - title: Medium
+          value: 50
+        - title: High
+          value: 100
+      defaultValue: 10
+  run:
+    - name: agg_type
+      type: string
+      required: false
+      title: Agg Type
+      description: Select an aggregation function (e.g., AVG, SUM, COUNT)
+      defaultValue: AVG
+      hideValue: true
+    - name: email_notifications
+      type: boolean
+      required: false
+      title: Email Notifications
+      description: Enable email notifications
+      defaultValue: false
+    - name: num_iterations
+      type: number
+      required: false
+      title: Number of Iterations
+      description: Select the number of iterations
+      options:
+        - title: Low
+          value: 10
+        - title: Medium
+          value: 50
+        - title: High
+          value: 100
+      defaultValue: 10
+    - name: file_names
+      type: string_array
+      required: true
+      title: File Names
+      description: Specify input and output file names
+      defaultValue:
+        - input.csv
+        - output.csv
 featured: true
 scope: shared
 tenants:

peak/sample_yaml/press/apps/specs/create_app_spec_release.yaml

@@ -13,3 +13,66 @@ body:
       release:
         version: 2.0.0
       autoRunOnDeploy: False
+parameters:
+  build:
+    - name: watcher_user
+      type: string
+      required: true
+      title: Watcher User Email
+      description: Set the watcher user email
+      defaultValue: user@peak.ai
+      hideValue: false
+    - name: use_cache
+      type: boolean
+      required: false
+      title: Image Caching
+      description: Enable image caching for the workflow
+      defaultValue: false
+    - name: runtime_exceeded
+      type: number
+      required: false
+      title: Runtime Exceeded
+      description: Select the runtime exceeded value to trigger a failed notification for the workflow (in minutes)
+      options:
+        - title: Low
+          value: 10
+        - title: Medium
+          value: 50
+        - title: High
+          value: 100
+      defaultValue: 10
+  run:
+    - name: agg_type
+      type: string
+      required: false
+      title: Agg Type
+      description: Select an aggregation function (e.g., AVG, SUM, COUNT)
+      defaultValue: AVG
+      hideValue: true
+    - name: email_notifications
+      type: boolean
+      required: false
+      title: Email Notifications
+      description: Enable email notifications
+      defaultValue: false
+    - name: num_iterations
+      type: number
+      required: false
+      title: Number of Iterations
+      description: Select the number of iterations
+      options:
+        - title: Low
+          value: 10
+        - title: Medium
+          value: 50
+        - title: High
+          value: 100
+      defaultValue: 10
+    - name: file_names
+      type: string_array
+      required: true
+      title: File Names
+      description: Specify input and output file names
+      defaultValue:
+        - input.csv
+        - output.csv

peak/sample_yaml/press/blocks/specs/service/api/create_block_spec.yaml

@@ -35,16 +35,18 @@ body:
     minInstances: 1
 parameters:
   build:
-    - defaultValue: /health
-      description: Enter the health check URL
-      name: health_check_url
+    - name: health_check_url
+      type: string
       required: true
       title: Health Check URL
-      type: string
+      description: Enter the health check URL
+      defaultValue: /health
       hideValue: false
-    - defaultValue: 20
+    - name: instance_type_id
+      type: number
+      required: true
+      title: Instance Type ID
       description: Select an instance type
-      name: instance_type_id
       options:
         - title: Pico (0.125CPU, 0.125GB RAM)
           value: 20
@@ -52,26 +54,26 @@ parameters:
           value: 21
         - title: Micro (0.5CPU, 1GB RAM)
           value: 22
-      required: true
-      title: Instance Type ID
-      type: number
+      defaultValue: 20
   run:
-    - defaultValue: AVG
-      description: Select an aggregation function (e.g., AVG, SUM, COUNT)
-      name: agg_type
+    - name: agg_type
+      type: string
       required: false
       title: Agg Type
-      type: string
+      description: Select an aggregation function (e.g., AVG, SUM, COUNT)
+      defaultValue: AVG
       hideValue: true
-    - defaultValue: false
-      description: Enable email notifications
-      name: email_notifications
+    - name: email_notifications
+      type: boolean
       required: false
       title: Email Notifications
-      type: boolean
-    - defaultValue: 10
+      description: Enable email notifications
+      defaultValue: false
+    - name: num_iterations
+      type: number
+      required: false
+      title: Number of Iterations
       description: Select the number of iterations
-      name: num_iterations
       options:
         - title: Low
           value: 10
@@ -79,17 +81,15 @@ parameters:
           value: 50
         - title: High
           value: 100
-      required: false
-      title: Number of Iterations
-      type: number
-    - defaultValue:
-        - input.csv
-        - output.csv
-      description: Specify input and output file names
-      name: file_names
+      defaultValue: 10
+    - name: file_names
+      type: string_array
       required: true
       title: File Names
-      type: string_array
+      description: Specify input and output file names
+      defaultValue:
+        - input.csv
+        - output.csv
 artifact:
   path: "."
   ignore_files: