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

peak/_metadata.py

@@ -956,6 +956,9 @@ command_metadata: Dict[str, Any] = {
     "blocks>deployments>patch-parameters": {
         "request_body_yaml_path": "sample_yaml/press/blocks/deployments/patch_block_parameters.yaml",
     },
+    "deployments>patch-parameters": {
+        "request_body_yaml_path": "sample_yaml/press/patch_parameters.yaml",
+    },
     "metrics>publish": {
         "request_body_yaml_path": "sample_yaml/metrics/publish.yaml",
     },

peak/_version.py

@@ -18,4 +18,4 @@
 # # You should have received a copy of the APACHE LICENSE, VERSION 2.0
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
-__version__: str = "1.12.0"
+__version__: str = "1.13.0"

peak/cli/press/apps/deployments.py

@@ -66,10 +66,13 @@ def create(
             imageUrl (string | required: false): URL of the image to be associated with the app deployment.
             tags (list(map) | required: false):
                 - name (string): Name of the tag.
+        appParameters (map | required: false):
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         parameters (map | required: false):
-            <blockName> (map): Dictionary of parameters for the block. Here the key is the name of the block.
-                <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                    <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            <blockName> (map): Dictionary of parameters specific to each block, where each key represents the block name.
+                build (map | required: false): Dictionary of parameters for the block's 'build' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+                run (map | required: false): Dictionary of parameters for the block's 'run' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         revision (map | required: false):
             notes (string | required: false): Notes for the deployment revision.
         spec (map):
@@ -348,10 +351,13 @@ def create_revision(
     🧩 ***Input file schema (yaml):***<br/>
     ```yaml
       body (map):
+        appParameters (map | required: false):
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         parameters (map | required: false):
-            <blockName> (map): Dictionary of blocks within the app, for which to provide parameters. Must be a valid block name.
-                <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                    <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            <blockName> (map): Dictionary of parameters specific to each block, where each key represents the block name.
+                build (map | required: false): Dictionary of parameters for the block's 'build' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+                run (map | required: false): Dictionary of parameters for the block's 'run' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         release (map):
             version (string): A valid semantic release version of the app spec.
         revision (map | required: false):

peak/cli/press/apps/specs.py

@@ -76,6 +76,16 @@ def create(
               release (map):
                 version (string): A valid semantic release version of the block spec.
               autoRunOnDeploy (bool | required: false): Whether to execute the resource after the app is deployed. By default it is False.
+      parameters (map | required: false):
+        <parameterType> (list(map)): List containing the parameter objects. Here the key is the type of the parameter. Accepted values are "build" or "run".
+            name (string): Name of the parameter.
+            type (string): Type of the parameter. Should be one of "boolean", "string", "string_array", "number", "number_array", "object" and "object_array".
+            required (boolean): Whether the parameter is required.
+            description (string | required: false): Description of the parameter.
+            defaultValue (string | required: false): Default value of the parameter.
+            title (string | required: false): Title of the parameter.
+            options (list(str) | required: false): List of options for the parameter. If provided, it must have at least one object with "title" and "value" field.
+            hideValue(boolean | required: false): Can be optionally provided to parameters of type "string", to mask the parameter's value when it has been set at deployment time.
     ```
 
     \b
@@ -332,6 +342,16 @@ def create_release(
               release (map):
                 version (string): A valid semantic release version of the block spec.
               autoRunOnDeploy (bool | required: false): Whether to execute the resource after the app is deployed. By default it is False.
+      parameters (map | required: false):
+        <parameterType> (list(map)): List containing the parameter objects. Here the key is the type of the parameter. Accepted values are "build" or "run".
+            name (string): Name of the parameter.
+            type (string): Type of the parameter. Should be one of "boolean", "string", "string_array", "number", "number_array", "object" and "object_array".
+            required (boolean): Whether the parameter is required.
+            description (string | required: false): Description of the parameter.
+            defaultValue (string | required: false): Default value of the parameter.
+            title (string | required: false): Title of the parameter.
+            options (list(str) | required: false): List of options for the parameter. If provided, it must have at least one object with "title" and "value" field.
+            hideValue(boolean | required: false): Can be optionally provided to parameters of type "string", to mask the parameter's value when it has been set at deployment time.
     ```
 
     \b

peak/cli/press/blocks/deployments.py

@@ -75,8 +75,8 @@ def create(
             tags (list(map) | required: false):
                 - name (string): Name of the tag.
         parameters (map | required: false):
-            <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         revision (map | required: false):
             notes (string | required: false): Notes for the deployment revision.
         spec (map):
@@ -362,8 +362,8 @@ def create_revision(
     ```yaml
       body (map):
         parameters (map | required: false):
-            <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         release (map):
             version (string): A valid semantic release version of the block spec.
         revision (map | required: false):
@@ -550,8 +550,7 @@ def patch_parameters(
     \b
     🧩 ***Input file schema (yaml):***<br/>
     ```yaml
-    body (map):
-        <key> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+    body (map): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
     ```
 
     \b

peak/cli/press/deployments.py

@@ -23,9 +23,9 @@
 from typing import List, Optional
 
 import typer
-from peak.cli import args
-from peak.cli.args import OUTPUT_TYPES, PAGING
-from peak.constants import OutputTypes
+from peak.cli import args, helpers
+from peak.cli.args import DRY_RUN, GENERATE_YAML, OUTPUT_TYPES, PAGING
+from peak.constants import OutputTypes, OutputTypesNoTable
 from peak.output import Writer
 from peak.press.deployments import Deployment
 from rich.console import Console
@@ -36,6 +36,8 @@ app = typer.Typer(
 )
 console = Console()
 
+_DEPLOYMENT_ID = typer.Argument(..., help="ID of the Block deployment to be used in this operation")
+
 
 @app.command("list", short_help="List App and Block deployments.")
 def list_deployments(
@@ -123,3 +125,47 @@ def execute_resources(
     with writer.pager():
         response = deployment_client.execute_resources(deployment_id)
         writer.write(response)
+
+
+@app.command(short_help="Update the parameters for a deployment at run time.")
+def patch_parameters(
+    ctx: typer.Context,
+    deployment_id: str = _DEPLOYMENT_ID,
+    file: str = args.TEMPLATE_PATH,
+    params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
+    params: Optional[List[str]] = args.TEMPLATE_PARAMS,
+    dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
+    generate: Optional[bool] = GENERATE_YAML,  # noqa: ARG001
+) -> None:
+    """***Update*** the parameters for a deployment at run time.
+
+    \b
+    🧩 ***Input file schema (yaml):***<br/>
+    ```yaml
+    body (map): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+    ```
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak deployments patch-parameters <deployment-id> /path/to/body.yaml -v /path/to/params.yaml
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {...}
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/Deployment%20Parameters/patch_v1_deployments__deploymentId__parameters_run)
+    """
+    body = helpers.template_handler(file, params_file, params)
+    deployments_client: Deployment = ctx.obj["client"]
+    body = helpers.remove_unknown_args(body, deployments_client.patch_parameters)
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = deployments_client.patch_parameters(deployment_id, **body)
+        writer.write(response)

peak/metrics/metrics.py

@@ -550,4 +550,4 @@ def get_client(session: Optional[Session] = None) -> Metric:
     return Metric(session)
 
 
-__all__ = ["get_client"]
+__all__: List[str] = ["get_client"]

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/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/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