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

peak/cli/resources/alerts/emails.py

@@ -0,0 +1,360 @@
+#
+# # Copyright © 2024 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
+# # the License is located at:
+# #
+# # https://github.com/PeakBI/peak-sdk/blob/main/LICENSE
+# #
+# # or in the "license" file accompanying this file. This file is
+# # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# # ANY KIND, either express or implied. See the License for the specific
+# # language governing permissions and limitations under the License.
+# #
+# # This file is part of the peak-sdk.
+# # see (https://github.com/PeakBI/peak-sdk)
+# #
+# # 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>
+#
+
+"""Peak Alerts commands."""
+
+from typing import Any, Dict, List, Optional
+
+import typer
+from peak.cli import helpers
+from peak.cli.args import OUTPUT_TYPES, PAGING, TEMPLATE_PARAMS, TEMPLATE_PARAMS_FILE
+from peak.constants import OutputTypes, OutputTypesNoTable
+from peak.helpers import combine_dictionaries, map_user_options, parse_list_of_strings, variables_to_dict
+from peak.output import Writer
+from peak.resources.alerts import Alert
+from typing_extensions import Annotated
+
+app = typer.Typer(
+    help="Alerts management commands.",
+    short_help="Manage alerts.",
+)
+
+_EMAIL_ID = typer.Argument(..., help="The ID of the email.")
+_RECIPIENTS = typer.Option(None, help="The email addresses of the recipients.")
+_SUBJECT = typer.Option(None, help="The subject of the email.")
+_TEMPLATE_NAME = typer.Option(None, help="The name of the email template.")
+_TEMPLATE_PARAMETERS = typer.Option(
+    None,
+    help="The parameters for the email template. To be passed in stringified JSON format.",
+)
+_COUNT = typer.Option(None, help="The number of emails to retrieve.")
+_DATE_FROM = typer.Option(None, help="The date from which to retrieve emails (in ISO format).")
+_DATE_TO = typer.Option(None, help="The date till which to retrieve emails (in ISO format).")
+_PAGE_SIZE = typer.Option(None, help="The number of emails per page.")
+_PAGE_NUMBER = typer.Option(None, help="The page number to retrieve.")
+_CC = typer.Option(None, help="The email addresses of the recipients to be CC'd.")
+_BCC = typer.Option(None, help="The email addresses of the recipients to be BCC'd.")
+_LIST_TEMPLATE_NAME = typer.Option(None, help="Email Template Name to search for.")
+_LIST_TEMPLATE_SCOPE = typer.Option(None, help="List of type of template to filter the templates by.")
+_DESCRIBE_TEMPLATE_NAME = typer.Argument(None, help="The name of the email template.")
+
+
+@app.command("list", short_help="List all emails.", options_metavar="list_emails")
+def list_emails(
+    ctx: typer.Context,
+    page_size: Optional[int] = _PAGE_SIZE,
+    page_number: Optional[int] = _PAGE_NUMBER,
+    count: Optional[int] = _COUNT,
+    date_from: Optional[str] = _DATE_FROM,
+    date_to: Optional[str] = _DATE_TO,
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypes] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """Retrieve the history of emails sent.
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak alerts emails list --page-size 10 --page-number 1
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "emailCount": 1,
+        "emails": [
+            {
+                "createdAt": "2024-01-01T00:00:00.200Z",
+                "createdBy": "platform@peak.ai",
+                "id": 1,
+                "status": "Delivered",
+                "subject": "email_subject",
+                "templateName": "template_name",
+            }
+        ],
+        "pageCount": 1,
+        "pageNumber": 1,
+        "pageSize": 25
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/notifications/api-docs/index.htm#/Emails/get_api_v1_emails)
+    """
+    alert_client: Alert = ctx.obj["client"]
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = alert_client.list_emails(
+            page_size=page_size,
+            page_number=page_number,
+            count=count,
+            date_from=date_from,
+            date_to=date_to,
+            return_iterator=False,
+        )
+        writer.write(response)
+
+
+@app.command("send", short_help="Send an email.", options_metavar="send_email")
+def send_email(
+    ctx: typer.Context,
+    file: Annotated[
+        Optional[str],
+        typer.Argument(
+            ...,
+            help="Path to the file that defines the body for this operation, supports both `yaml` file or a `jinja` template.",
+        ),
+    ] = None,
+    params_file: str = TEMPLATE_PARAMS_FILE,
+    params: List[str] = TEMPLATE_PARAMS,
+    recipients: Optional[List[str]] = _RECIPIENTS,
+    cc: Optional[List[str]] = _CC,
+    bcc: Optional[List[str]] = _BCC,
+    subject: Optional[str] = _SUBJECT,
+    template_name: Optional[str] = _TEMPLATE_NAME,
+    template_parameters: Optional[str] = _TEMPLATE_PARAMETERS,
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """Send an email to the specified recipients using the specified template.
+
+    \b
+    🧩 ***Input file schema(yaml):***<br/>
+    ```yaml
+      body (map):
+        recipients (list(str) | required: true): List of email addresses of the recipients.
+        cc (list(str) | required: false): List of email addresses of the recipients to be CC'd.
+        bcc (list(str) | required: false): List of email addresses of the recipients to be BCC'd.
+        subject (str | required: true): The subject of the email.
+        templateName (str | required: true): The name of the email template.
+        templateParameters (map | required: false): The parameters for the email template.
+    ```
+
+     \b
+    📝 ***Example usage:***
+    ```bash
+    peak alerts emails send '/path/to/email.yaml' --params-file '/path/to/values.yaml'
+    ```
+
+    We can also provide the required parameters from the command line or combine the YAML template and command line arguments in which case the command line arguments will take precedence.
+
+    \b
+    📝 ***Example usage without yaml:***
+    ```bash
+    peak alerts emails send --recipients <recipient_email_1> --recipients <recipient_email_2> --subject <email_subject> --template-name <template_name> --template-parameters '{"key": "value"}'
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "id": 1
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/notifications/api-docs/index.htm#/Emails/post_api_v1_emails)
+    """
+    alert_client: Alert = ctx.obj["client"]
+    writer: Writer = ctx.obj["writer"]
+
+    user_options: Dict[str, Any] = variables_to_dict(
+        recipients,
+        cc,
+        bcc,
+        subject,
+        template_name,
+        template_parameters,
+    )
+
+    body: Dict[str, Any] = {}
+    if file:
+        body = helpers.template_handler(file=file, params_file=params_file, params=params)
+        body = helpers.remove_unknown_args(body, alert_client.send_email)
+
+    updated_body = combine_dictionaries(body.get("body") or {}, user_options)
+
+    if recipients:
+        updated_body["recipients"] = parse_list_of_strings(recipients)
+
+    if cc:
+        updated_body["cc"] = parse_list_of_strings(cc)
+
+    if bcc:
+        updated_body["bcc"] = parse_list_of_strings(bcc)
+
+    if template_parameters:
+        updated_body["templateParameters"] = map_user_options(
+            user_options=user_options,
+            mapping={},
+            dict_type_keys=["templateParameters"],
+        )
+
+    with writer.pager():
+        response: Dict[str, Any] = alert_client.send_email(body=updated_body)
+        writer.write(response)
+
+
+@app.command(short_help="Describe details of a specific email.", options_metavar="describe_email")
+def describe(
+    ctx: typer.Context,
+    email_id: int = _EMAIL_ID,
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """***Describe*** details of a specific email.
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak alerts emails describe <email-id>
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "createdAt": "2024-01-01T00:00:00.000Z",
+        "createdBy": "platform@peak.ai",
+        "deliveredAt": "2024-01-01T00:00:00.000Z",
+        "id": 1,
+        "recipients": {
+            "cc": [],
+            "to": ["someone@peak.ai"],
+            "bcc": []
+        },
+        "status": "Delivered",
+        "statusDetails": [
+            {
+                "email": "someone@peak.ai",
+                "status": "Delivered",
+                "description": "The email was successfully delivered."
+            }
+        ],
+        "subject": "Hello, world!",
+        "templateName": "template_name",
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/notifications/api-docs/index.htm#/Emails/get_api_v1_emails__id_)
+    """
+    alert_client: Alert = ctx.obj["client"]
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = alert_client.describe_email(email_id=email_id)
+        writer.write(response)
+
+
+@app.command(short_help="List all the templates.", options_metavar="list_templates")
+def list_templates(
+    ctx: typer.Context,
+    page_size: Optional[int] = _PAGE_SIZE,
+    page_number: Optional[int] = _PAGE_NUMBER,
+    scope: Optional[List[str]] = _LIST_TEMPLATE_SCOPE,
+    name: Optional[str] = _LIST_TEMPLATE_NAME,
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypes] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """Retrieve the email templates list.
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak alerts emails list-templates --page-size 10 --page-number 1
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "templateCount": 1,
+        "templates": [
+            {
+                "id": 1,
+                "createdAt": "2021-09-01T12:00:00Z",
+                "createdBy": "platform@peak.ai",
+                "name": "test_template",
+                "scope": "custom"
+            }
+        ],
+        "pageCount": 1,
+        "pageNumber": 1,
+        "pageSize": 25
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/notifications/api-docs/index.htm#/Templates/get_api_v1_emails_templates)
+    """
+    alert_client: Alert = ctx.obj["client"]
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = alert_client.list_templates(
+            page_size=page_size,
+            page_number=page_number,
+            scope=scope,
+            name=name,
+            return_iterator=False,
+        )
+        writer.write(response)
+
+
+@app.command(
+    short_help="Describe details of a specific template.",
+    options_metavar="describe_template",
+)
+def describe_template(
+    ctx: typer.Context,
+    template_name: str = _DESCRIBE_TEMPLATE_NAME,
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """***Describe*** details of a specific template.
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak alerts emails describe-template <template-name>
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "id": 1,
+        "createdAt": "2021-09-01T12:00:00Z",
+        "createdBy": "platform@peak.ai",
+        "name": "test_template",
+        "subject": "Important Account Update Information",
+        "body": "<h1>Hello</h1><p>Your account has been updated.</p>",
+        "scope": "custom"
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/notifications/api-docs/index.htm#/Templates/get_api_v1_emails_templates__name_)
+    """
+    alert_client: Alert = ctx.obj["client"]
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = alert_client.describe_template(template_name=template_name)
+        writer.write(response)

peak/cli/resources/images.py

@@ -41,7 +41,10 @@ _BUILD_ID = typer.Option(..., help="ID of the image build to be used in this ope
 
 _COUNT = typer.Option(None, help="Number of builds required.")
 
-_BUILD_STATUS = typer.Option(None, help="List of build status to filter image builds.")
+_BUILD_STATUS = typer.Option(
+    None,
+    help="List of build status to filter image builds. Valid values are `building`, `failed`, `success`, `stopped`, `stopping`.",
+)
 
 _VERSIONS = typer.Option(None, help="List of version ids to filter image builds.")
 
@@ -52,7 +55,10 @@ _IMAGE_LIST_STATUS = typer.Option(
     help="List of status of the latest version to filter the images by. Valid values are `not-ready`, `ready`, `in-use`, `deleting`, `delete-failed`.",
 )
 
-_IMAGE_LIST_SCOPE = typer.Option(None, help="List of type of image to filter the images by.")
+_IMAGE_LIST_SCOPE = typer.Option(
+    None,
+    help="List of type of image to filter the images by. Valid values are `custom` and `global`.",
+)
 
 _IMAGE_LIST_BUILD_STATUS = typer.Option(
     None,
@@ -79,7 +85,10 @@ _NAME = typer.Option(None, help="Name of the image.")
 
 _VERSION = typer.Option(None, help="A valid semantic image version.")
 
-_TYPE = typer.Option(None, help="Type of the image.")
+_TYPE = typer.Option(
+    None,
+    help="Type of the image. Allowed values are 'workflow', 'workspace-r', 'workspace-python, 'api', 'webapp'.",
+)
 
 _DESCRIPTION = typer.Option(None, help="Description of the image.")
 
@@ -89,7 +98,10 @@ _ARTIFACT_IGNORE_FILES = typer.Option(None, help="Ignore files to use when creat
 
 _BUILD_DETAILS = typer.Option(None, help="Build details of the image. To be passed in stringified json format.")
 
-_SOURCE = typer.Option(None, help="The source via which the image is to be created.")
+_SOURCE = typer.Option(
+    None,
+    help="The source via which the image is to be created. Allowed values are 'github', 'dockerfile' and 'upload'.",
+)
 
 _DOCKERFILE = typer.Option(None, help="The dockerfile to be used to create the image.")
 
@@ -167,7 +179,7 @@ def create(
       body (map):
         name (str): Name of the image.
         version (str | required: false): A valid semantic image version. If not provided, the version will be set to 0.0.1.
-        type (str): Type of the image.
+        type (str): Type of the image. Allowed values are 'workflow', 'workspace-r', 'workspace-python, 'api' and 'webapp'.
         description (str | required: false): Description of the image.
         buildDetails (map | required: false):
           source (str | required: false): The source via which the image is to be created. Allowed values are 'github', 'dockerfile' and 'upload'. It is 'upload' by default.
@@ -429,7 +441,7 @@ def create_or_update(
       body (map):
         name (str): Name of the image.
         version (str | required: false): A valid semantic image version. If not provided, the next patch version of the latest version will be used.
-        type (str): Type of the image.
+        type (str): Type of the image. Allowed values are 'workflow', 'workspace-r', 'workspace-python, 'api' and 'webapp'.
         description (str | required: false): Description of the image.
         buildDetails (map | required: false): If not provided and if the image version already exists, the build details of the existing version will be used.
           source (str | required: false): The source via which the image is to be created. Allowed values are 'github', 'dockerfile' and 'upload'. It is 'upload' by default if new version is being created otherwise the existing version's source will be used.
@@ -1086,4 +1098,4 @@ def get_build_logs(
                 writer.write(response)
                 break
 
-            next_token = response["nextToken"] if "nextToken" in response else None
+            next_token = response.get("nextToken", None)

peak/cli/resources/services.py

@@ -87,6 +87,11 @@ _ENTRYPOINT = typer.Option(None, help="Entrypoint for the service.")
 
 _HEALTH_CHECK_URL = typer.Option(None, help="Endpoint to monitor service's operational status.")
 
+_MIN_INSTANCES = typer.Option(
+    None,
+    help="Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.",
+)
+
 _HTTP_METHOD = typer.Option(None, help="HTTP method to be used to test the service.")
 
 _PATH = typer.Option(None, help="Path to be used to test the service.")
@@ -168,6 +173,7 @@ def create(
     secrets: Optional[List[str]] = _SECRETS,
     entrypoint: Optional[str] = _ENTRYPOINT,
     health_check_url: Optional[str] = _HEALTH_CHECK_URL,
+    min_instances: Optional[int] = _MIN_INSTANCES,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
     paging: Optional[bool] = PAGING,  # noqa: ARG001
     output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
@@ -194,6 +200,7 @@ def create(
         sessionStickiness (boolean | required: false): Enable session stickiness for the service. Default value is false. Enabling session stickiness will tie each user to a specific server for all their requests. Not required for API type services.
         entrypoint (string | required: false): Entrypoint for the service.
         healthCheckURL (string | required: false): Endpoint to monitor service's operational status.
+        minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.
     ```
 
     \b
@@ -252,6 +259,9 @@ def create(
     if health_check_url:
         updated_body["healthCheckURL"] = health_check_url
 
+    if min_instances:
+        updated_body["minInstances"] = min_instances
+
     with writer.pager():
         response = service_client.create_service(body=updated_body)
         writer.write(response)
@@ -274,6 +284,7 @@ def update(
     secrets: Optional[List[str]] = _SECRETS,
     entrypoint: Optional[str] = _ENTRYPOINT,
     health_check_url: Optional[str] = _HEALTH_CHECK_URL,
+    min_instances: Optional[int] = _MIN_INSTANCES,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
     paging: Optional[bool] = PAGING,  # noqa: ARG001
     output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
@@ -305,6 +316,7 @@ def update(
         sessionStickiness (boolean | required: false): Enable session stickiness for the service. Default value is false. Enabling session stickiness will tie each user to a specific server for all their requests. Not required for API type services.
         entrypoint (string | required: false): Entrypoint for the service.
         healthCheckURL (string | required: false): Endpoint to monitor service's operational status.
+        minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.
     ```
 
     \b
@@ -361,6 +373,9 @@ def update(
     if health_check_url:
         updated_body["healthCheckURL"] = health_check_url
 
+    if min_instances:
+        updated_body["minInstances"] = min_instances
+
     with writer.pager():
         response = service_client.update_service(service_id=service_id, body=updated_body)
         writer.write(response)
@@ -387,6 +402,7 @@ def create_or_update(
     secrets: Optional[List[str]] = _SECRETS,
     entrypoint: Optional[str] = _ENTRYPOINT,
     health_check_url: Optional[str] = _HEALTH_CHECK_URL,
+    min_instances: Optional[int] = _MIN_INSTANCES,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
     paging: Optional[bool] = PAGING,  # noqa: ARG001
     output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
@@ -418,6 +434,7 @@ def create_or_update(
         sessionStickiness (boolean | required: false): Enable session stickiness for the service. Default value is false. Enabling session stickiness will tie each user to a specific server for all their requests. Not required for API type services.
         entrypoint (string | required: false): Entrypoint for the service.
         healthCheckURL (string | required: false): Endpoint to monitor service's operational status.
+        minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.
     ```
 
     \b
@@ -478,6 +495,9 @@ def create_or_update(
     if health_check_url:
         updated_body["healthCheckURL"] = health_check_url
 
+    if min_instances:
+        updated_body["minInstances"] = min_instances
+
     response = service_client.create_or_update_service(body=updated_body)
     writer.write(response)
 
@@ -551,6 +571,9 @@ def describe(
         "createdBy": "someone@peak.ai",
         "updatedAt": "2020-01-01T18:00:00.000Z",
         "updatedBy": "someone@peak.ai",
+        "entrypoint": "/",
+        "healthCheckURL": "/health",
+        "minInstances": 1,
         "tags": [...]
     }
     ```

peak/cli/resources/tenants.py

@@ -32,7 +32,10 @@ app = typer.Typer(
     short_help="Create and manage Tenant Settings.",
 )
 
-_ENTITY_TYPE = typer.Option(..., help="Entity type to be used in this operation (e.g. - feed, workflow).")
+_ENTITY_TYPE = typer.Option(
+    ...,
+    help="Entity type to be used in this operation (e.g. - `workflow`, `webapp`, `api-deployment`).",
+)
 
 
 @app.command(