peak-sdk 1.14.0__tar.gz → 1.15.0__tar.gz

{peak_sdk-1.14.0 → peak_sdk-1.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peak-sdk
-Version: 1.14.0
+Version: 1.15.0
 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.0
     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.0
     ```
 
 ### 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 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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.0"

{peak_sdk-1.14.0 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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_sdk-1.14.0 → peak_sdk-1.15.0}/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: