peak-sdk 1.5.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

peak/resources/workflows.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Workflow client module."""
+
 from __future__ import annotations
 
 from typing import Any, Dict, Iterator, List, Literal, Optional, overload
@@ -51,8 +52,7 @@ class Workflow(BaseClient):
         name: Optional[str] = None,
         *,
         return_iterator: Literal[False],
-    ) -> Dict[str, Any]:
-        ...
+    ) -> Dict[str, Any]: ...
 
     @overload
     def list_workflows(
@@ -65,8 +65,7 @@ class Workflow(BaseClient):
         name: Optional[str] = None,
         *,
         return_iterator: Literal[True] = True,
-    ) -> Iterator[Dict[str, Any]]:
-        ...
+    ) -> Iterator[Dict[str, Any]]: ...
 
     def list_workflows(
         self: Workflow,
@@ -166,10 +165,30 @@ class Workflow(BaseClient):
                                 "runtimeExceeded": "number"
                             },
                             "user": "string",
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
                             "webhook": {
                                 "name": "string(required)",
                                 "url": "string(required)",
-                                "payload": "string(required)",
+                                "payload": "string(required)"
+                            }
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
+                            "email": {
+                                "name": "string",
+                                "recipients": {
+                                    "to": ["string"]
+                                }
                             }
                         }
                     ],
@@ -295,10 +314,30 @@ class Workflow(BaseClient):
                                 "runtimeExceeded": "number"
                             },
                             "user": "string",
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
                             "webhook": {
                                 "name": "string(required)",
                                 "url": "string(required)",
-                                "payload": "string(required)",
+                                "payload": "string(required)"
+                            }
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
+                            "email": {
+                                "name": "string",
+                                "recipients": {
+                                    "to": ["string"]
+                                }
                             }
                         }
                     ],
@@ -382,7 +421,7 @@ class Workflow(BaseClient):
             ForbiddenException: The user does not have permission to perform the operation.
             InternalServerErrorException: The server failed to process the request.
         """
-        workflow_name = body["name"] if "name" in body else ""
+        workflow_name = body.get("name", "")
         response = (
             {}
             if not len(workflow_name)
@@ -463,10 +502,30 @@ class Workflow(BaseClient):
                                 "runtimeExceeded": "number"
                             },
                             "user": "string",
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
                             "webhook": {
                                 "name": "string(required)",
                                 "url": "string(required)",
-                                "payload": "string(required)",
+                                "payload": "string(required)"
+                            }
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
+                            "email": {
+                                "name": "string",
+                                "recipients": {
+                                    "to": ["string"]
+                                }
                             }
                         }
                     ],
@@ -624,10 +683,30 @@ class Workflow(BaseClient):
                                 "runtimeExceeded": "number"
                             },
                             "user": "string",
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
                             "webhook": {
                                 "name": "string(required)",
                                 "url": "string(required)",
-                                "payload": "string(required)",
+                                "payload": "string(required)"
+                            }
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
+                            "email": {
+                                "name": "string",
+                                "recipients": {
+                                    "to": ["string"]
+                                }
                             }
                         }
                     ],
@@ -961,12 +1040,13 @@ class Workflow(BaseClient):
         workflow_id: int,
         date_from: Optional[str] = None,
         date_to: Optional[str] = None,
+        status: Optional[List[str]] = None,
+        count: Optional[int] = None,
         page_size: Optional[int] = None,
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[False],
-    ) -> Dict[str, Any]:
-        ...
+    ) -> Dict[str, Any]: ...
 
     @overload
     def list_executions(
@@ -974,18 +1054,21 @@ class Workflow(BaseClient):
         workflow_id: int,
         date_from: Optional[str] = None,
         date_to: Optional[str] = None,
+        status: Optional[List[str]] = None,
+        count: Optional[int] = None,
         page_size: Optional[int] = None,
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[True] = True,
-    ) -> Iterator[Dict[str, Any]]:
-        ...
+    ) -> Iterator[Dict[str, Any]]: ...
 
     def list_executions(
         self: Workflow,
         workflow_id: int,
         date_from: Optional[str] = None,
         date_to: Optional[str] = None,
+        status: Optional[List[str]] = None,
+        count: Optional[int] = None,
         page_size: Optional[int] = None,
         page_number: Optional[int] = None,
         *,
@@ -1000,6 +1083,11 @@ class Workflow(BaseClient):
             workflow_id (int): ID of the workflow to fetch executions.
             date_from (str | None): The date after which the executions should be included (in ISO format). Defaults to None
             date_to (str | None): The date till which the executions should be included (in ISO format). Defaults to None
+            status (List[str] | None): The status of the executions to filter by.
+                Valid values are `Success`, `Running`, `Stopped`, `Stopping` and `Failed`.
+            count (int | None): Number of executions required in the provided time range or 90 days (Ordered by latest to earliest).
+                For example, if 5 is provided, it will return last 5 workflow executions.
+                By default, it will return all the executions.
             page_size (int | None): Number of executions per page.
             page_number (int | None): Page number to fetch. Only used when return_iterator is False.
             return_iterator (bool): Whether to return an iterator object or list of executions for a specified page number, defaults to True.
@@ -1021,6 +1109,8 @@ class Workflow(BaseClient):
         method, endpoint = HttpMethods.GET, f"{self.BASE_ENDPOINT}/workflows/executions/{workflow_id}"
 
         params: Dict[str, Any] = {
+            "count": count,
+            "statuses": status,
             "dateTo": date_to,
             "dateFrom": date_from,
             "pageSize": page_size,

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

@@ -19,9 +19,11 @@ body:
     - id: existing_block_spec_id_1
       release:
         version: 1.0.0
+      autoRunOnDeploy: True
     - id: existing_block_spec_id_2
       release:
         version: 1.0.0
+      autoRunOnDeploy: False
 featured: true
 scope: shared
 tenants:

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

@@ -8,6 +8,8 @@ body:
     - id: existing_block_spec_id_1
       release:
         version: 2.0.0
+      autoRunOnDeploy: True
     - id: existing_block_spec_id_2
       release:
         version: 2.0.0
+      autoRunOnDeploy: False

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

@@ -0,0 +1,102 @@
+body:
+  version: 1
+  kind: service
+  metadata:
+    name: api-service-block
+    title: API Service Block
+    summary: API Service Block
+    description: Creating a new service block spec of type api.
+    descriptionContentType: text/markdown
+    imageUrl: https://my-block-pics.com/image-0.jpg
+    tags:
+      - name: CLI
+  release:
+    version: 1.0.0
+    notes: This is the original release
+  config:
+    serviceType: api
+    image:
+      dockerfile: Dockerfile
+      context: "."
+      version: 0.0.1
+    parameters:
+      env:
+        param1: value1
+        param2: value2
+      secrets:
+        - secret1
+        - secret2
+    resources:
+      instanceTypeId: "@param:instance_type_id"
+    healthCheckURL: "@param:health_check_url"
+    entrypoint: |
+      python
+      app.py
+    minInstances: 1
+parameters:
+  build:
+    - defaultValue: /health
+      description: Enter the health check URL
+      name: health_check_url
+      required: true
+      title: Health Check URL
+      type: string
+      hideValue: false
+    - defaultValue: 20
+      description: Select an instance type
+      name: instance_type_id
+      options:
+        - title: Pico (0.125CPU, 0.125GB RAM)
+          value: 20
+        - title: Nano (0.25CPU, 0.5GB RAM)
+          value: 21
+        - title: Micro (0.5CPU, 1GB RAM)
+          value: 22
+      required: true
+      title: Instance Type ID
+      type: number
+  run:
+    - defaultValue: AVG
+      description: Select an aggregation function (e.g., AVG, SUM, COUNT)
+      name: agg_type
+      required: false
+      title: Agg Type
+      type: string
+      hideValue: true
+    - defaultValue: false
+      description: Enable email notifications
+      name: email_notifications
+      required: false
+      title: Email Notifications
+      type: boolean
+    - defaultValue: 10
+      description: Select the number of iterations
+      name: num_iterations
+      options:
+        - title: Low
+          value: 10
+        - title: Medium
+          value: 50
+        - title: High
+          value: 100
+      required: false
+      title: Number of Iterations
+      type: number
+    - defaultValue:
+        - input.csv
+        - output.csv
+      description: Specify input and output file names
+      name: file_names
+      required: true
+      title: File Names
+      type: string_array
+artifact:
+  path: "."
+  ignore_files:
+    - ".gitignore"
+    - ".dockerignore"
+featured: true
+scope: shared
+tenants:
+  - tenant1
+  - tenant2

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

@@ -0,0 +1,88 @@
+# block_spec_release.yaml
+
+body:
+  release:
+    version: 2.0.0
+    notes: This is a new release
+  config:
+    serviceType: api
+    image:
+      dockerfile: Dockerfile
+      context: "."
+      version: 0.0.1
+    parameters:
+      env:
+        param1: value1
+        param2: value2
+      secrets:
+        - secret1
+        - secret2
+    resources:
+      instanceTypeId: "@param:instance_type_id"
+    healthCheckURL: "@param:health_check_url"
+    entrypoint: |
+      python
+      app.py
+    minInstances: 1
+parameters:
+  build:
+    - defaultValue: /health
+      description: Enter the health check URL
+      name: health_check_url
+      required: true
+      title: Health Check URL
+      type: string
+      hideValue: false
+    - defaultValue: 20
+      description: Select an instance type
+      name: instance_type_id
+      options:
+        - title: Pico (0.125CPU, 0.125GB RAM)
+          value: 20
+        - title: Nano (0.25CPU, 0.5GB RAM)
+          value: 21
+        - title: Micro (0.5CPU, 1GB RAM)
+          value: 22
+      required: true
+      title: Instance Type ID
+      type: number
+  run:
+    - defaultValue: AVG
+      description: Select an aggregation function (e.g., AVG, SUM, COUNT)
+      name: agg_type
+      required: false
+      title: Agg Type
+      type: string
+      hideValue: true
+    - defaultValue: false
+      description: Enable email notifications
+      name: email_notifications
+      required: false
+      title: Email Notifications
+      type: boolean
+    - defaultValue: 10
+      description: Select the number of iterations
+      name: num_iterations
+      options:
+        - title: Low
+          value: 10
+        - title: Medium
+          value: 50
+        - title: High
+          value: 100
+      required: false
+      title: Number of Iterations
+      type: number
+    - defaultValue:
+        - input.csv
+        - output.csv
+      description: Specify input and output file names
+      name: file_names
+      required: true
+      title: File Names
+      type: string_array
+artifact:
+  path: "."
+  ignore_files:
+    - ".gitignore"
+    - ".dockerignore"

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

@@ -0,0 +1,103 @@
+body:
+  version: 1
+  kind: service
+  metadata:
+    name: webapp-service-block
+    title: Web App Service Block
+    summary: Web App Service Block
+    description: Creating a new service block spec of type web-app.
+    descriptionContentType: text/markdown
+    imageUrl: https://my-block-pics.com/image-0.jpg
+    tags:
+      - name: CLI
+  release:
+    version: 1.0.0
+    notes: This is the original release
+  config:
+    serviceType: web-app
+    image:
+      dockerfile: Dockerfile
+      context: "."
+      version: 0.0.1
+    parameters:
+      env:
+        param1: value1
+        param2: value2
+      secrets:
+        - secret1
+        - secret2
+    resources:
+      instanceTypeId: "@param:instance_type_id"
+    healthCheckURL: "@param:health_check_url"
+    sessionStickiness: false
+    entrypoint: |
+      python
+      app.py
+    minInstances: 1
+parameters:
+  build:
+    - defaultValue: /health
+      description: Enter the health check URL
+      name: health_check_url
+      required: true
+      title: Health Check URL
+      type: string
+      hideValue: false
+    - defaultValue: 43
+      description: Select an instance type
+      name: instance_type_id
+      options:
+        - title: Pico (0.25CPU, 0.5GB RAM)
+          value: 43
+        - title: Nano (0.25CPU, 1GB RAM)
+          value: 44
+        - title: Micro (0.5CPU, 1GB RAM)
+          value: 45
+      required: true
+      title: Instance Type ID
+      type: number
+  run:
+    - defaultValue: AVG
+      description: Select an aggregation function (e.g., AVG, SUM, COUNT)
+      name: agg_type
+      required: false
+      title: Agg Type
+      type: string
+      hideValue: true
+    - defaultValue: false
+      description: Enable email notifications
+      name: email_notifications
+      required: false
+      title: Email Notifications
+      type: boolean
+    - defaultValue: 10
+      description: Select the number of iterations
+      name: num_iterations
+      options:
+        - title: Low
+          value: 10
+        - title: Medium
+          value: 50
+        - title: High
+          value: 100
+      required: false
+      title: Number of Iterations
+      type: number
+    - defaultValue:
+        - input.csv
+        - output.csv
+      description: Specify input and output file names
+      name: file_names
+      required: true
+      title: File Names
+      type: string_array
+artifact:
+  path: "."
+  ignore_files:
+    - ".gitignore"
+    - ".dockerignore"
+featured: true
+scope: shared
+tenants:
+  - tenant1
+  - tenant2

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

@@ -0,0 +1,89 @@
+# block_spec_release.yaml
+
+body:
+  release:
+    version: 2.0.0
+    notes: This is a new release
+  config:
+    serviceType: web-app
+    image:
+      dockerfile: Dockerfile
+      context: "."
+      version: 0.0.1
+    parameters:
+      env:
+        param1: value1
+        param2: value2
+      secrets:
+        - secret1
+        - secret2
+    resources:
+      instanceTypeId: "@param:instance_type_id"
+    healthCheckURL: "@param:health_check_url"
+    sessionStickiness: false
+    entrypoint: |
+      python
+      app.py
+    minInstances: 1
+parameters:
+  build:
+    - defaultValue: /health
+      description: Enter the health check URL
+      name: health_check_url
+      required: true
+      title: Health Check URL
+      type: string
+      hideValue: false
+    - defaultValue: 43
+      description: Select an instance type
+      name: instance_type_id
+      options:
+        - title: Pico (0.25CPU, 0.5GB RAM)
+          value: 43
+        - title: Nano (0.25CPU, 1GB RAM)
+          value: 44
+        - title: Micro (0.5CPU, 1GB RAM)
+          value: 45
+      required: true
+      title: Instance Type ID
+      type: number
+  run:
+    - defaultValue: AVG
+      description: Select an aggregation function (e.g., AVG, SUM, COUNT)
+      name: agg_type
+      required: false
+      title: Agg Type
+      type: string
+      hideValue: true
+    - defaultValue: false
+      description: Enable email notifications
+      name: email_notifications
+      required: false
+      title: Email Notifications
+      type: boolean
+    - defaultValue: 10
+      description: Select the number of iterations
+      name: num_iterations
+      options:
+        - title: Low
+          value: 10
+        - title: Medium
+          value: 50
+        - title: High
+          value: 100
+      required: false
+      title: Number of Iterations
+      type: number
+    - defaultValue:
+        - input.csv
+        - output.csv
+      description: Specify input and output file names
+      name: file_names
+      required: true
+      title: File Names
+      type: string_array
+artifact:
+  path: "."
+  ignore_files:
+    - ".gitignore"
+    - ".dockerignore"

peak/sample_yaml/press/blocks/specs/{create_block_spec.yaml → workflow/create_block_spec.yaml}

@@ -38,7 +38,25 @@ body:
       - webhook:
           name: info
           url: https://abc.com/post
-          payload: '{ "pingback-url": "https:/workflow/123" }'
+          payload: |
+            {
+              "system": "external_system",
+              "action": "update",
+              "data": {
+                "field": "value",
+                "timestamp": "2024-05-20T12:00:00Z"
+              }
+            }
+        events:
+          success: false
+          fail: true
+          runtimeExceeded: "@param:runtime_exceeded"
+      - email:
+          name: "email-watcher-1"
+          recipients:
+            to:
+              - "user1@peak.ai"
+              - "user2@peak.ai"
         events:
           success: false
           fail: true
@@ -112,6 +130,7 @@ artifact:
     - ".gitignore"
     - ".dockerignore"
 featured: true
+autoRunOnDeploy: true
 scope: shared
 tenants:
   - tenant1

peak/sample_yaml/press/blocks/specs/{create_block_spec_release.yaml → workflow/create_block_spec_release.yaml}

@@ -27,7 +27,25 @@ body:
       - webhook:
           name: info
           url: https://abc.com/post
-          payload: '{ "pingback-url": "https:/workflow/123" }'
+          payload: |
+            {
+              "system": "external_system",
+              "action": "update",
+              "data": {
+                "field": "value",
+                "timestamp": "2024-05-20T12:00:00Z"
+              }
+            }
+        events:
+          success: false
+          fail: true
+          runtimeExceeded: "@param:runtime_exceeded"
+      - email:
+          name: "email-watcher-1"
+          recipients:
+            to:
+              - "user1@peak.ai"
+              - "user2@peak.ai"
         events:
           success: false
           fail: true
@@ -100,3 +118,4 @@ artifact:
   ignore_files:
     - ".gitignore"
     - ".dockerignore"
+autoRunOnDeploy: true