peak-sdk 1.14.0__py3-none-any.whl → 1.15.1__py3-none-any.whl

peak/_metadata.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 Peak AI Limited. or its affiliates. All Rights Reserved.
 # #
 # # Licensed under the Apache License, Version 2.0 (the "License"). You
 # # may not use this file except in compliance with the License. A copy of
@@ -959,6 +959,9 @@ command_metadata: Dict[str, Any] = {
     "deployments>patch-parameters": {
         "request_body_yaml_path": "sample_yaml/press/patch_parameters.yaml",
     },
+    "deployments>patch-parameters-v2": {
+        "request_body_yaml_path": "sample_yaml/press/deployments/patch_app_parameters_v2.yaml",
+    },
     "metrics>publish": {
         "request_body_yaml_path": "sample_yaml/metrics/publish.yaml",
     },

peak/_version.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 Peak AI Limited. or its affiliates. All Rights Reserved.
 # #
 # # Licensed under the Apache License, Version 2.0 (the "License"). You
 # # may not use this file except in compliance with the License. A copy of
@@ -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.14.0"
+__version__: str = "1.15.1"

peak/cli/press/apps/specs.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 Peak AI Limited. or its affiliates. All Rights Reserved.
 # #
 # # Licensed under the Apache License, Version 2.0 (the "License"). You
 # # may not use this file except in compliance with the License. A copy of
@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Peak apps specs commands."""
+
 from typing import Dict, List, Optional
 
 import typer
@@ -86,6 +87,12 @@ def create(
             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.
+            conditions(list(map) | required: false): Conditions that determine when the parameter should be enabled. Conditions on two or more parameters should be used with conditionType "AND" or "OR".
+                - dependsOn (string): Name of the parameter that this parameter depends on.
+                  operator (string): Operator to be used for the condition. Should be one of "equals" or "not-equals".
+                  value (string): Value to be compared with the parameter.
+                - conditionType (string): Type of the condition. Should be one of "AND" or "OR".
+                  conditions (list(map)): Nested conditions that determine when the parameter should be enabled.
     ```
 
     \b
@@ -352,6 +359,12 @@ def create_release(
             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.
+            conditions(list(map) | required: false): Conditions that determine when the parameter should be enabled. Conditions on two or more parameters should be used with conditionType "AND" or "OR".
+                - dependsOn (string): Name of the parameter that this parameter depends on.
+                  operator (string): Operator to be used for the condition. Should be one of "equals" or "not-equals".
+                  value (string): Value to be compared with the parameter.
+                - conditionType (string): Type of the condition. Should be one of "AND" or "OR".
+                  conditions (list(map)): Nested conditions that determine when the parameter should be enabled.
     ```
 
     \b

peak/cli/press/blocks/specs.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 Peak AI Limited. or its affiliates. All Rights Reserved.
 # #
 # # Licensed under the Apache License, Version 2.0 (the "License"). You
 # # may not use this file except in compliance with the License. A copy of
@@ -344,6 +344,12 @@ def create(
             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.
+            conditions(list(map) | required: false): Conditions that determine when the parameter should be enabled. Conditions on two or more parameters should be used with conditionType "AND" or "OR".
+                - dependsOn (string): Name of the parameter that this parameter depends on.
+                  operator (string): Operator to be used for the condition. Should be one of "equals" or "not-equals".
+                  value (string): Value to be compared with the parameter.
+                - conditionType (string): Type of the condition. Should be one of "AND" or "OR".
+                  conditions (list(map)): Nested conditions that determine when the parameter should be enabled.
     artifact (map | required: false):
       path (str): Path to the artifact.
       ignore_files (list(str) | required: false) : Ignore files to use when creating artifact.
@@ -762,6 +768,12 @@ def create_release(
             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.
+            conditions(list(map) | required: false): Conditions that determine when the parameter should be enabled. Conditions on two or more parameters should be used with conditionType "AND" or "OR".
+                - dependsOn (string): Name of the parameter that this parameter depends on.
+                  operator (string): Operator to be used for the condition. Should be one of "equals" or "not-equals".
+                  value (string): Value to be compared with the parameter.
+                - conditionType (string): Type of the condition. Should be one of "AND" or "OR".
+                  conditions (list(map)): Nested conditions that determine when the parameter should be enabled.
     artifact (map | required: false):
         path (str): Path to the artifact.
         ignore_files (list(str) | required: false) : Ignore files to use when creating artifact.

peak/cli/press/deployments.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 Peak AI Limited. or its affiliates. All Rights Reserved.
 # #
 # # Licensed under the Apache License, Version 2.0 (the "License"). You
 # # may not use this file except in compliance with the License. A copy of
@@ -127,7 +127,7 @@ def execute_resources(
         writer.write(response)
 
 
-@app.command(short_help="Update the parameters for a deployment at run time.")
+@app.command(short_help="Update the runtime parameters for a deployment.")
 def patch_parameters(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
@@ -169,3 +169,59 @@ def patch_parameters(
     with writer.pager():
         response = deployments_client.patch_parameters(deployment_id, **body)
         writer.write(response)
+
+
+@app.command(short_help="Update the App runtime parameters and Block runtime parameters for a deployment.")
+def patch_parameters_v2(
+    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 runtime.
+
+    \b
+    🧩 ***Input file schema to update run parameters of an app deployment (yaml):***<br/>
+    ```yaml
+    body (map):
+        appParameters (map | required: false):
+            Dictionary of runtime app parameters. 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 specific to each block, where each key represents the block name.
+                Dictionary of runtime block parameters. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+    ```
+
+    🧩 ***Input file schema to update run parameters of a block deployment (yaml):***<br/>
+    ```yaml
+    body (map):
+        parameters (map | required: false):
+            Dictionary of runtime block parameters. 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-v2 <deployment-id> /path/to/body.yaml -v /path/to/params.yaml
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    { appParameters: {...}, parameters: {...} }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/Deployment%20Parameters/patch_v2_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_v2)
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = deployments_client.patch_parameters_v2(deployment_id, **body)
+        writer.write(response)

peak/press/apps.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 Peak AI Limited. or its affiliates. All Rights Reserved.
 # #
 # # Licensed under the Apache License, Version 2.0 (the "License"). You
 # # may not use this file except in compliance with the License. A copy of
@@ -236,6 +236,25 @@ class App(BaseClient):
                             "title": "string",
                             "options": "list(str)",
                             "hideValue": "boolean",
+                            "conditions": [
+                                // Basic condition
+                                {
+                                    "dependsOn": "string",
+                                    "operator": "string",
+                                    "value": "string|number|boolean"
+                                },
+                                // Composite condition
+                                {
+                                    "conditionType": "AND|OR",
+                                    "conditions": [
+                                        {
+                                            "dependsOn": "string",
+                                            "operator": "string",
+                                            "value": "string|number|boolean"
+                                        }
+                                    ]
+                                }
+                            ]
                         }
                     ]
                 }
@@ -426,6 +445,25 @@ class App(BaseClient):
                             "required": "boolean(required)",
                             "title": "string",
                             "type": "string(required)",
+                            "conditions": [
+                                // Basic condition
+                                {
+                                    "dependsOn": "string",
+                                    "operator": "string",
+                                    "value": "string|number|boolean"
+                                },
+                                // Composite condition
+                                {
+                                    "conditionType": "AND|OR",
+                                    "conditions": [
+                                        {
+                                            "dependsOn": "string",
+                                            "operator": "string",
+                                            "value": "string|number|boolean"
+                                        }
+                                    ]
+                                }
+                            ]
                         }
                     ]
                 }

peak/press/blocks.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 Peak AI Limited. or its affiliates. All Rights Reserved.
 # #
 # # Licensed under the Apache License, Version 2.0 (the "License"). You
 # # may not use this file except in compliance with the License. A copy of
@@ -574,6 +574,25 @@ class Block(BaseClient):
                             "required": "boolean(required)",
                             "title": "string",
                             "type": "string(required)",
+                            "conditions": [
+                                // Basic condition
+                                {
+                                    "dependsOn": "string",
+                                    "operator": "equals|not-equals",
+                                    "value": "string|number|boolean"
+                                },
+                                // Composite condition
+                                {
+                                    "conditionType": "AND|OR",
+                                    "conditions": [
+                                        {
+                                            "dependsOn": "string",
+                                            "operator": "equals|not-equals",
+                                            "value": "string|number|boolean"
+                                        }
+                                    ]
+                                }
+                            ]
                         }
                     ]
                 }
@@ -1123,6 +1142,25 @@ class Block(BaseClient):
                             "required": "boolean(required)",
                             "title": "string",
                             "type": "string(required)",
+                            "conditions": [
+                                // Basic condition
+                                {
+                                    "dependsOn": "string",
+                                    "operator": "equals|not-equals",
+                                    "value": "string|number|boolean"
+                                },
+                                // Composite condition
+                                {
+                                    "conditionType": "AND|OR",
+                                    "conditions": [
+                                        {
+                                            "dependsOn": "string",
+                                            "operator": "equals|not-equals",
+                                            "value": "string|number|boolean"
+                                        }
+                                    ]
+                                }
+                            ]
                         }
                     ]
                 }

peak/press/deployments.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 Peak AI Limited. or its affiliates. All Rights Reserved.
 # #
 # # Licensed under the Apache License, Version 2.0 (the "License"). You
 # # may not use this file except in compliance with the License. A copy of
@@ -188,6 +188,68 @@ class Deployment(BaseClient):
             subdomain="press",
         )
 
+    def patch_parameters_v2(
+        self,
+        deployment_id: str,
+        body: Dict[str, Any],
+    ) -> Dict[str, Any]:
+        """Get the runtime parameters for a deployment.
+
+        REFERENCE:
+            🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/Deployment%20Parameters/patch_v2_deployments__deploymentId__parameters_run>`__
+
+        Args:
+            deployment_id (str): The ID of the deployment.
+            body (Dict[str, Any]): body (Dict[str, str]): Dictionary of app and block parameters.
+
+        Returns:
+            Dict[str, Any]: Dictionary containing app and block parameters.
+
+        SCHEMA(Block Deployment Run Parameters):
+            The valid types for parameters are `boolean`, `string`, `string_array`, `number`, `number_array`, `object` and `object_array`.
+
+            .. code-block:: json
+
+                {
+                    "parameters": {
+                        "param_name": "param_value (string | number | boolean | dict | array)"
+                    }
+                }
+
+        SCHEMA(App Deployment Run Parameters):
+            The valid types for parameters are `boolean`, `string`, `string_array`, `number`, `number_array`, `object` and `object_array`.
+
+            .. code-block:: json
+
+                {
+                    "appParameters": {
+                        "param_name": "param_value (string | number | boolean | dict | array)"
+                    },
+                    "parameters": {
+                        "block_name": {
+                            "param_name": "param_value (string | number | boolean | dict | array)"
+                        }
+                    }
+                }
+
+        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"v2/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/specs/create_app_spec.yaml

@@ -87,6 +87,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 featured: true
 scope: shared
 tenants:

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

@@ -76,3 +76,34 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3

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

@@ -90,6 +90,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

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

@@ -81,6 +81,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

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

@@ -92,6 +92,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/press/blocks/specs/service/webapp/create_block_spec_release.yaml

@@ -83,6 +83,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/press/blocks/specs/workflow/create_block_spec.yaml

@@ -172,6 +172,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/press/blocks/specs/workflow/create_block_spec_release.yaml

@@ -161,6 +161,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/press/deployments/patch_app_parameters_v2.yaml

@@ -0,0 +1,15 @@
+# parameters.yaml
+
+body:
+  appParameters:
+    agg_type: "MAX"
+    num_iterations: 50
+    email_notifications: true
+    file_names:
+      - input.csv
+      - output.csv
+  parameters:
+    block1:
+      email_notifications: false
+    block2:
+      num_iterations: 10

peak/sample_yaml/press/deployments/patch_block_parameters_v2.yaml

@@ -0,0 +1,10 @@
+# parameters.yaml
+
+body:
+  parameters:
+    agg_type: "MAX"
+    num_iterations: 50
+    email_notifications: true
+    file_names:
+      - input.csv
+      - output.csv

peak/session.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 Peak AI Limited. or its affiliates. All Rights Reserved.
 # #
 # # Licensed under the Apache License, Version 2.0 (the "License"). You
 # # may not use this file except in compliance with the License. A copy of
@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Session module for Peak API."""
+
 from __future__ import annotations
 
 import os
@@ -243,7 +244,7 @@ class Session:
 
         logger.info("auth_token not given, searching for 'PEAK_AUTH_TOKEN' or 'API_KEY' in env variables")
         if not os.environ.get("API_KEY") and not os.environ.get("PEAK_AUTH_TOKEN"):
-            raise exceptions.MissingEnvironmentVariableException(env_var="PEAK_AUTH_TOKEN or API_KEY")
+            raise exceptions.MissingEnvironmentVariableException(env_var="PEAK_AUTH_TOKEN")
         if os.environ.get("PEAK_AUTH_TOKEN"):
             self.auth_token = os.environ["PEAK_AUTH_TOKEN"]
             return
@@ -254,12 +255,9 @@ class Session:
             self.stage = Stage(stage)
             return
 
-        logger.info("stage not given, searching for STAGE in env variables")
-        if not os.environ.get("STAGE"):
-            logger.info("STAGE environment variable is not set, defaulting to PROD")
-            self.stage = Stage.PROD
-            return
-        self.stage = Stage(os.environ["STAGE"])
+        logger.info("stage not given, searching for PEAK__STAGE or STAGE in env variables")
+        final_stage = os.environ.get("PEAK__STAGE", os.environ.get("STAGE", Stage.PROD))
+        self.stage = Stage(final_stage)
 
 
 __all__: List[str] = ["Session", "_get_default_session"]

peak/tools/logging/logger.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 Peak AI Limited. or its affiliates. All Rights Reserved.
 # #
 # # Licensed under the Apache License, Version 2.0 (the "License"). You
 # # may not use this file except in compliance with the License. A copy of
@@ -84,7 +84,7 @@ def peak_contexts_processor(
         "press_deployment_id": os.getenv("PRESS_DEPLOYMENT_ID"),
         "run_id": os.getenv("PEAK_RUN_ID"),
         "exec_id": os.getenv("PEAK_EXEC_ID"),
-        "stage": os.getenv("STAGE"),
+        "stage": os.getenv("PEAK__STAGE", os.getenv("STAGE")),
         "tenant_name": os.getenv("TENANT_NAME", os.getenv("TENANT")),
         "tenant_id": os.getenv("TENANT_ID"),
         "api_name": os.getenv("PEAK_API_NAME"),

{peak_sdk-1.14.0.dist-info → peak_sdk-1.15.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peak-sdk
-Version: 1.14.0
+Version: 1.15.1
 Summary: Python SDK for interacting with the Peak platform
 Home-page: https://docs.peak.ai/sdk/latest/
 License: Apache-2.0
@@ -106,7 +106,7 @@ Follow these steps to create a virtual environment using Python's built-in `venv
     This should return a response of the following format
 
     ```bash
-    peak-cli==1.14.0
+    peak-cli==1.15.1
     Python==3.12.3
     System==Darwin(23.6.0)
     ```
@@ -122,14 +122,14 @@ Follow these steps to create a virtual environment using Python's built-in `venv
     This should print the version of the SDK
 
     ```
-    1.14.0
+    1.15.1
     ```
 
 ### Using the SDK and CLI
 
--   To start using the SDK and CLI, you'll need either an API Key or a Personal Access Token (PAT).
--   If you don't have one yet, sign up for an account on the Peak platform to obtain your API key or Personal Access token (PAT).
--   To export it, run the following command in your terminal and replace <peak_auth_token> with your actual API key or PAT:
+-   To start using the SDK and CLI, you'll need a Personal Access Token (PAT).
+-   If you don't have one yet, sign up for an account on the Peak platform to obtain your Personal Access token (PAT).
+-   To export it, run the following command in your terminal and replace <peak_auth_token> with your actual PAT:
     ```
     export PEAK_AUTH_TOKEN=<peak_auth_token>
     ```

{peak_sdk-1.14.0.dist-info → peak_sdk-1.15.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
 peak/__init__.py,sha256=lxS3Xqyj9yvZdI3DVWbfn8i_Lw4t2Ujw9HbKe44-LY8,1284
-peak/_metadata.py,sha256=ongQ3I77xv-3nZSLemYk_UKYLiMAwfM60-K_vcqRMBI,30528
-peak/_version.py,sha256=q_w6UYjTZ96mhm0Vg6AXepEKgyu-XGfEAbNB40N3tlI,887
+peak/_metadata.py,sha256=8w0pXN03pDvh1toM-divY6HNVF8znTqGGG2T9Q4hEl4,30672
+peak/_version.py,sha256=QZinsq2WrQhSqLqmYU_Rte6hcEMNndD7qb28itNf9DA,887
 peak/auth.py,sha256=KcqCqovY6sFiMGNAGP9k3AtCAXrZ-tYd7QP-PFYorX0,904
 peak/base_client.py,sha256=3cS8hZApONkojwdgzt_tbwSxwpFcn3xGwzVcmxkgOJc,1808
 peak/callbacks.py,sha256=k_p2Av5_ZWD8bDzcSPhbYaAS2xHQpVI1cSkAecnmuqU,3775
@@ -13,11 +13,11 @@ peak/cli/metrics/metrics.py,sha256=ry8YIRhQccZhjqLO_nJOvBf7T-cUDYOSHlr92Jz63nM,2
 peak/cli/press/__init__.py,sha256=7zvL15sobpdrEuGoziADkJVnrHMiZKINYr4FDRFetY8,898
 peak/cli/press/apps/__init__.py,sha256=_bUtQG1zrO9Jv5zIFFKikR82-NsAfpow2KgSOa3oX_M,1459
 peak/cli/press/apps/deployments.py,sha256=t47FPfEOORXvb9_0F0cds0sxikMaNqOs-QEbsvebkl0,18737
-peak/cli/press/apps/specs.py,sha256=Nep1NHAWZ3M7MLMXAgXs77qkCtSBJxNo8KG_R0bW-MU,18236
+peak/cli/press/apps/specs.py,sha256=9veK_CGrOUTpNEMIn1j-xrkcW8giY4E9LuQLpBuH8DQ,19635
 peak/cli/press/blocks/__init__.py,sha256=0kQIpLD29rlec5xTB9RLNPdIHxf6vi6_3gukBkwaySI,1499
 peak/cli/press/blocks/deployments.py,sha256=galqAK58qDvv4bpyL1z3cQ2YhxEu2msadoVXB4epOq0,21953
-peak/cli/press/blocks/specs.py,sha256=m_w8EFUiyTi36YOc0GZyKL6jdT9uEYi8uZf29y0HNvQ,62494
-peak/cli/press/deployments.py,sha256=xr46ZWwmOE9IIRb9U9zNSIfDN6_jAbQce-wvjgfm-VI,5902
+peak/cli/press/blocks/specs.py,sha256=w-fuip1fgqa8NNPeSPl4MZMk-4SDJT6rhfBjxvPLlrM,63892
+peak/cli/press/deployments.py,sha256=wdaxRHva59SdBB--gid19kekxTBv8qfnpI4UEXsIX1Q,8523
 peak/cli/press/specs.py,sha256=7XFWmgOuNBM8N482InvtQiZoQOldHqcQghLyHCmLHHI,4737
 peak/cli/resources/__init__.py,sha256=ThMYJ-QNULjTWOmAGUzhKWuqDcHq73DxzgTV2r5-uLs,883
 peak/cli/resources/alerts/__init__.py,sha256=TyeLPOGiA4qvOKORV3Ejlx8n6lGfX1G2GcU-bpYsgPE,1197
@@ -42,9 +42,9 @@ peak/metrics/__init__.py,sha256=g5ufdcpozE7C6jJVbzo9XQNK3o9dNTy31wgIaRBmrHQ,1057
 peak/metrics/metrics.py,sha256=oeexaJsy6CWiC6lwBPo6kWp_LXldkam1yKeO54ZbuP8,24533
 peak/output.py,sha256=J--61iDMLpBzXXV4BJu1eceT4W1lhiuYsYtGS1hEpOo,6971
 peak/press/__init__.py,sha256=80Key6wov_xZld45-39ELT0gDC_t4cy-JvA9wfCy7-c,1112
-peak/press/apps.py,sha256=EzNjAi337isk4EEprCEjGkvRyvkaZwu15nTwduLz8a0,48811
-peak/press/blocks.py,sha256=iY_aSX_7eTLm-rb3i6OXwngT6lb9qrZLjWtS5zIPl9A,95666
-peak/press/deployments.py,sha256=lfWSkrJ6nEWiA8bO0d5u675mGJakRgNuQEbqXpLgbJc,8487
+peak/press/apps.py,sha256=Rh_EDQDuLyuM3FwFxz7riuq1i7lhU4uRclzp65KFPfE,50711
+peak/press/blocks.py,sha256=9XLt2iiQBFa3ON9BddVZ1vp-kRNjij2JOfn069SAO-g,97610
+peak/press/deployments.py,sha256=ZUcuUMygIEswGXleZAF8wkjzSXSl21jGERvIXJ__dcw,10969
 peak/press/specs.py,sha256=GH9-SACctAlcBZznXEmsIqneOwIJoE55mD4aHQymMrM,10915
 peak/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 peak/resources/__init__.py,sha256=CkLWMygz8mr_isA8uMGQn2uut-BilCydLwx5sYniPIA,1242
@@ -62,20 +62,22 @@ peak/sample_yaml/metrics/query.yaml,sha256=0RKgPjVvDxEHZcB9yj9sKan1vOiIw5_utRn68
 peak/sample_yaml/press/apps/deployments/create_app_deployment.yaml,sha256=rb8eICyd_tN5_gZAyuyZ7DqtThDWvAIqpSZmlwvBDUk,1254
 peak/sample_yaml/press/apps/deployments/create_app_deployment_revision.yaml,sha256=DwF9xn3lQIOMAlDsZl5V_6oiAN-0mfyADs4BsX56_KE,946
 peak/sample_yaml/press/apps/deployments/update_app_deployment_metadata.yaml,sha256=RBrAnxULPXYTrYY7T6l-L5_Q1E8LJ6RwVwOkw4zn5w0,302
-peak/sample_yaml/press/apps/specs/create_app_spec.yaml,sha256=pXzukt9A86DIg36a7SQDKExDNOLUxQPILBHxU3Ni1fk,2336
-peak/sample_yaml/press/apps/specs/create_app_spec_release.yaml,sha256=lBy3ybY4DTiE9tFq0XIJCyYinSmqP0bx9XCh9tGHDKM,2001
+peak/sample_yaml/press/apps/specs/create_app_spec.yaml,sha256=s7Wa8a3OEalt6oPc_dDcTXstF7x5PMZ8lBYuNMaFIX4,3263
+peak/sample_yaml/press/apps/specs/create_app_spec_release.yaml,sha256=8dI4n6LQfbi2LR_8IJOPe7NrMLdEoa2zHTbhemZGBCs,2928
 peak/sample_yaml/press/apps/specs/update_app_spec_metadata.yaml,sha256=jCZZevvQbeUlHtfhG0DZrNVMlzm-teT1dLs6DuqAloY,337
 peak/sample_yaml/press/blocks/deployments/create_block_deployment.yaml,sha256=LcJ2Eata1JdwQ8rhCM4kh2H0p5OsSpnGIMnVySP7DiY,729
 peak/sample_yaml/press/blocks/deployments/create_block_deployment_revision.yaml,sha256=ob17cSem5opvRaoeZzgwKtbTVItduNIHdnVD5l3nYuw,376
 peak/sample_yaml/press/blocks/deployments/patch_block_parameters.yaml,sha256=Zx8bHmrfnClykuUhBSe9OY9CBOwvfdtvxePLHED7LyA,156
 peak/sample_yaml/press/blocks/deployments/update_block_deployment_metadata.yaml,sha256=1Qvc-2kdxcC3wPpH8p4DQWFRNKqRMI_mQjeN4A0aUug,304
-peak/sample_yaml/press/blocks/specs/service/api/create_block_spec.yaml,sha256=WxwOG0w5sQHLzWPqvnlc3pJfc6XCw29sXgtgtxEa46g,2445
-peak/sample_yaml/press/blocks/specs/service/api/create_block_spec_release.yaml,sha256=kg0KjX9EBhB-0VD2SuBe7dMJPgOAhbc5kRsvd9xIpf8,2088
-peak/sample_yaml/press/blocks/specs/service/webapp/create_block_spec.yaml,sha256=srduheVqMfBjqvDfTFwU-5LDiHq-JcxCB0c-tfRLhho,2510
-peak/sample_yaml/press/blocks/specs/service/webapp/create_block_spec_release.yaml,sha256=vnCE4vXIeV_45QwXt1o_L4uxXVBk0NXwPzAG-B_s_fU,2138
+peak/sample_yaml/press/blocks/specs/service/api/create_block_spec.yaml,sha256=S5pNty-8hq2XZ4E17gYqs3GyXwZzQXX_U9wyUNg2tSI,3372
+peak/sample_yaml/press/blocks/specs/service/api/create_block_spec_release.yaml,sha256=n_fQCS095b6tch6dRtbDuVfdVvss-dk-lzXVOyAVXWc,3015
+peak/sample_yaml/press/blocks/specs/service/webapp/create_block_spec.yaml,sha256=9qs86TLWq6HhSfZn23STYgaj3VekXyNjO-E94hAR5Fg,3437
+peak/sample_yaml/press/blocks/specs/service/webapp/create_block_spec_release.yaml,sha256=lsjZ43P22XOraAgmISGmvX5J76uUbGhvRcfzV1lvIaY,3065
 peak/sample_yaml/press/blocks/specs/update_block_spec_metadata.yaml,sha256=WsfYGQ81gC4-RYG-U_N3_EPIhKjx4zOgg-tmAjmHkpk,378
-peak/sample_yaml/press/blocks/specs/workflow/create_block_spec.yaml,sha256=k4RePPB0wEiTwq91Lg2NY0MTTWr90zHPluxKsxAEpA4,4564
-peak/sample_yaml/press/blocks/specs/workflow/create_block_spec_release.yaml,sha256=70tGyUmrP-h_MweS7LzoYcltV8cNvBuDYxgexed7GxI,4208
+peak/sample_yaml/press/blocks/specs/workflow/create_block_spec.yaml,sha256=yfV5dsF0vXIlS2hocCsyBev79opjDyYRnAGoVbDmnB4,5491
+peak/sample_yaml/press/blocks/specs/workflow/create_block_spec_release.yaml,sha256=2M-hjRK1flbPItc4F7eHoCZwoDJoOCgVHtlEb6TSW4Y,5135
+peak/sample_yaml/press/deployments/patch_app_parameters_v2.yaml,sha256=kP3dM8bd80HxmlLxJ8X0YKbcAkMLXNLGhk4Zjs0NcMw,264
+peak/sample_yaml/press/deployments/patch_block_parameters_v2.yaml,sha256=pCkdChBMrcbAeuqVnOw4cAnqjptDNzWn--fcNOJMhIA,165
 peak/sample_yaml/press/patch_parameters.yaml,sha256=8eD8X2XNVQ9_TNDFXd-XPiZ5CK2upqpv1QCEiWvDGBs,139
 peak/sample_yaml/resources/artifacts/create_artifact.yaml,sha256=8sFU7VV2vv292THRsGNzTItWbhP7F4YMACM4jkVisRU,194
 peak/sample_yaml/resources/artifacts/create_artifact_version.yaml,sha256=Mru6TdS0z34--r4nhx0-ZBUgR6Ylj0Gp_JRy3-Kb7pk,131
@@ -110,18 +112,18 @@ peak/sample_yaml/resources/workflows/workflow_input_parameters.yaml,sha256=kM52m
 peak/sample_yaml/resources/workflows/workflow_input_parameters_inherit.yaml,sha256=6sA-CsVB0xS31G_2YE9W4vtZvupA9zDO97UCJKJlJiQ,1426
 peak/sample_yaml/resources/workflows/workflow_output_parameters.yaml,sha256=S9twG4lSB2HAt4ZL6zy5beKD-XY1Jik4asyHy4DG5Cs,913
 peak/sample_yaml/resources/workflows/workflow_skippable_steps.yaml,sha256=Ei1wGqJC-LqDPpQfqh_CmMmJ_DI5kQfuGTK4koQsiVk,1418
-peak/session.py,sha256=4Wi6uBmJSv6vAV0d6SweZCV59jpMr3Zkc-84aUTrn7U,10360
+peak/session.py,sha256=mEK8nV_zyLp720ANTxvMyYI6BnM3ijrnQ4_4SZomP9A,10266
 peak/telemetry.py,sha256=LSrqSir-2WKPDwhjs_hG-oSjSIVnojptN124hPPR5i0,7263
 peak/template.py,sha256=VezqlvPxJKW_e4lh3GqsUX1mjUJsW9WRGLC1oMK2UwE,10839
 peak/tools/__init__.py,sha256=qK30qBi0MNvob6UkyzcfhI0s8nfSwGC4167A_2URBnY,1048
 peak/tools/logging/__init__.py,sha256=tIKis2HbtFzXY9gEsjcFipHxoGbieDtV2cYKP7Z9Ibw,1513
 peak/tools/logging/log_handler.py,sha256=wxU7klDyhCSdiotPnTXCvLhpRes_bnbQ3H1xVn42qjk,1406
 peak/tools/logging/log_level.py,sha256=Xtv4zZnYk4QBix_MfCRGim4yJbv7w2tTbNKe_s4QmaI,2665
-peak/tools/logging/logger.py,sha256=Jow5D3hqek-n0kHWNeL2nKbC9NfpfkWFT_FmPp-skTw,15653
+peak/tools/logging/logger.py,sha256=5wvQwgwWrHllOmEl_O6q5Obv1-Eb2cW1deXtR8h_IqQ,15679
 peak/tools/logging/utils.py,sha256=qmjdBbCc1Y6JDbSgNXfdnLnpkx7fb9kPw9u8uO3AAII,3330
 peak/validators.py,sha256=_nVAXF_AB443voKNjyQsCTQBAVVAqn7xCbCbBguohIs,2715
-peak_sdk-1.14.0.dist-info/LICENSE,sha256=W0jszenKx7YdFA7BDnyg8xDKXzCP8AperJb_PHh9paQ,11340
-peak_sdk-1.14.0.dist-info/METADATA,sha256=7zHFOJ0bEqwu2_NEDS3jJ2ig9kJjDSw2Kv_IUHEdqv0,7978
-peak_sdk-1.14.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-peak_sdk-1.14.0.dist-info/entry_points.txt,sha256=zHCEjuOTjkfmqivgEZQsPGm4zFA4W3Q_vKCjPr7W6lE,47
-peak_sdk-1.14.0.dist-info/RECORD,,
+peak_sdk-1.15.1.dist-info/LICENSE,sha256=W0jszenKx7YdFA7BDnyg8xDKXzCP8AperJb_PHh9paQ,11340
+peak_sdk-1.15.1.dist-info/METADATA,sha256=LEOJSOq_UBrq2Fm8k5OVudLkH_15MGgVtRoyaOSa5nw,7935
+peak_sdk-1.15.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+peak_sdk-1.15.1.dist-info/entry_points.txt,sha256=zHCEjuOTjkfmqivgEZQsPGm4zFA4W3Q_vKCjPr7W6lE,47
+peak_sdk-1.15.1.dist-info/RECORD,,