peak-sdk 1.6.0__py3-none-any.whl → 1.8.0__py3-none-any.whl

peak/cli/press/apps/deployments.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Peak apps deployments commands."""
+
 from __future__ import annotations
 
 from typing import Dict, List, Optional
@@ -37,11 +38,12 @@ console = Console()
 _DEPLOYMENT_ID = typer.Argument(..., help="ID of the App deployment to be used in this operation.")
 
 
-@app.command(short_help="Create an App deployment.", options_metavar="create_app_deployment")
+@app.command(short_help="Create an App deployment.")
 def create(
     ctx: typer.Context,
     file: str = args.TEMPLATE_PATH,
     description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
+    revision_notes_file: Optional[str] = args.REVISION_NOTES_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -95,7 +97,13 @@ def create(
     app_client: App = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params, description_file)
+    markdown_files = {}
+    if description_file:
+        markdown_files["body:metadata:description"] = description_file
+    if revision_notes_file:
+        markdown_files["body:revision:notes"] = revision_notes_file
+
+    body = helpers.template_handler(file, params_file, params, markdown_files)
     body = helpers.remove_unknown_args(body, app_client.create_deployment)
 
     with writer.pager():
@@ -103,7 +111,7 @@ def create(
         writer.write(response)
 
 
-@app.command("list", short_help="List App deployments.", options_metavar="list_app_deployments")
+@app.command("list", short_help="List App deployments.")
 def list_app_deployments(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -136,7 +144,7 @@ def list_app_deployments(
 
     🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Deployments/get_v1_apps_deployments)
     """
-    app_client = ctx.obj["client"]
+    app_client: App = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
     with writer.pager():
@@ -151,7 +159,7 @@ def list_app_deployments(
         writer.write(response)
 
 
-@app.command(short_help="Describe an App deployment.", options_metavar="describe_app_deployment")
+@app.command(short_help="Describe an App deployment.")
 def describe(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
@@ -163,7 +171,7 @@ def describe(
     \b
     📝 ***Example usage:***<br/>
     ```bash
-    peak apps deployments describe "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+    peak apps deployments describe <deployment_id>
     ```
 
     \b
@@ -188,7 +196,7 @@ def describe(
         writer.write(response)
 
 
-@app.command(short_help="Delete an App deployment.", options_metavar="delete_app_deployment")
+@app.command(short_help="Delete an App deployment.")
 def delete(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
@@ -201,7 +209,7 @@ def delete(
     \b
     📝 ***Example usage:***<br/>
     ```bash
-    peak apps deployments delete "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+    peak apps deployments delete <deployment_id>
     ```
 
     \b
@@ -212,7 +220,7 @@ def delete(
 
     🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Deployments/delete_v1_apps_deployments__deploymentId_)
     """
-    app_client = ctx.obj["client"]
+    app_client: App = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
     with writer.pager():
@@ -220,7 +228,7 @@ def delete(
         writer.write(response)
 
 
-@app.command(short_help="Update the App deployment metadata.", options_metavar="update_app_deployment_metadata")
+@app.command(short_help="Update the App deployment metadata.")
 def update_metadata(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
@@ -252,7 +260,7 @@ def update_metadata(
     \b
     📝 ***Example usage:***
     ```bash
-    peak apps deployments update-metadata "632a4e7c-ab86-4ecb-8f34-99b5da531ceb" /path/to/body.yaml -v /path/to/params.yaml
+    peak apps deployments update-metadata <deployment_id> /path/to/body.yaml -v /path/to/params.yaml
     ```
 
     \b
@@ -269,10 +277,14 @@ def update_metadata(
 
     🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Deployments/patch_v1_apps_deployments__deploymentId_)
     """
-    app_client = ctx.obj["client"]
+    app_client: App = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params, description_file)
+    markdown_files = {}
+    if description_file:
+        markdown_files["body:description"] = description_file
+
+    body = helpers.template_handler(file, params_file, params, markdown_files)
     body = helpers.remove_unknown_args(body, app_client.update_deployment_metadata)
 
     with writer.pager():
@@ -280,11 +292,49 @@ def update_metadata(
         writer.write(response)
 
 
-@app.command(short_help="Create an App deployment revision.", options_metavar="create_app_deployment_revision")
+@app.command(short_help="Redploy an App deployment.")
+def redeploy(
+    ctx: typer.Context,
+    deployment_id: str = _DEPLOYMENT_ID,
+    dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """***Redeploy*** latest revision an App deployment.
+
+    This allows you to redeploy an App deployment that is in a `failed` or `warning` state, provided at least one of its block deployments is also in a `failed` or `warning` state.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak apps deployments redeploy <deployment_id>
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "deploymentId": "632a4e7c-ab86-4ecb-8f34-99b5da531ceb",
+        "revision": 2
+        "revisionId": "7092bd84-c35d-43c1-90ca-7510a1204dcc"
+    }
+    ```
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Deployments/post_v1_apps_deployments__deploymentId__redeploy)
+    """
+    app_client: App = ctx.obj["client"]
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = app_client.redeploy(deployment_id)
+        writer.write(response)
+
+
+@app.command(short_help="Create an App deployment revision.")
 def create_revision(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
     file: str = args.TEMPLATE_PATH,
+    revision_notes_file: Optional[str] = args.REVISION_NOTES_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -329,7 +379,11 @@ def create_revision(
     app_client: App = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params)
+    markdown_files = {}
+    if revision_notes_file:
+        markdown_files["body:revision:notes"] = revision_notes_file
+
+    body = helpers.template_handler(file, params_file, params, markdown_files)
     body = helpers.remove_unknown_args(body, app_client.create_deployment_revision)
 
     with writer.pager():
@@ -337,7 +391,7 @@ def create_revision(
         writer.write(response)
 
 
-@app.command(short_help="Describe an App deployment revision.", options_metavar="describe_app_deployment_revision")
+@app.command(short_help="Describe an App deployment revision.")
 def describe_revision(
     ctx: typer.Context,
     deployment_id: str = args.DEPLOYMENT_ID,
@@ -354,7 +408,7 @@ def describe_revision(
     \b
     📝 ***Example usage:***<br/>
     ```bash
-    peak apps deployments describe-revision --deployment-id "632a4e7c-ab86-4ecb-8f34-99b5da531ceb" --revision 2
+    peak apps deployments describe-revision --deployment-id <deployment_id> --revision <revision>
     ```
 
     \b
@@ -384,7 +438,7 @@ def describe_revision(
         writer.write(response)
 
 
-@app.command(short_help="List revisions of an App deployment.", options_metavar="list_app_deployment_revisions")
+@app.command(short_help="List revisions of an App deployment.")
 def list_revisions(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,

peak/cli/press/apps/specs.py

@@ -35,11 +35,12 @@ console = Console()
 _SPEC_ID = typer.Argument(..., help="ID of the App spec to be used in this operation.")
 
 
-@app.command(short_help="Create an App spec.", options_metavar="create_app_spec")
+@app.command(short_help="Create an App spec.")
 def create(
     ctx: typer.Context,
     file: str = args.TEMPLATE_PATH,
     description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
+    release_notes_file: Optional[str] = args.RELEASE_NOTES_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -74,6 +75,7 @@ def create(
             - id (string): ID of the block spec.
               release (map):
                 version (string): A valid semantic release version of the block spec.
+              autoRunOnDeploy (bool | required: false): Whether to execute the resource after the app is deployed. By default it is False.
     ```
 
     \b
@@ -95,7 +97,13 @@ def create(
     app_client: App = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params, description_file)
+    markdown_files = {}
+    if description_file:
+        markdown_files["body:metadata:description"] = description_file
+    if release_notes_file:
+        markdown_files["body:release:notes"] = release_notes_file
+
+    body = helpers.template_handler(file, params_file, params, markdown_files)
     body = helpers.remove_unknown_args(body, app_client.create_spec)
 
     with writer.pager():
@@ -103,7 +111,7 @@ def create(
         writer.write(response)
 
 
-@app.command("list", short_help="List App specs.", options_metavar="list_app_specs")
+@app.command("list", short_help="List App specs.")
 def list_app_specs(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -157,7 +165,7 @@ def list_app_specs(
         writer.write(response)
 
 
-@app.command(short_help="Describe an App spec.", options_metavar="describe_app_spec")
+@app.command(short_help="Describe an App spec.")
 def describe(
     ctx: typer.Context,
     spec_id: str = _SPEC_ID,
@@ -195,7 +203,7 @@ def describe(
         writer.write(response)
 
 
-@app.command(short_help="Update the App spec metadata.", options_metavar="update_app_spec_metadata")
+@app.command(short_help="Update the App spec metadata.")
 def update_metadata(
     ctx: typer.Context,
     spec_id: str = _SPEC_ID,
@@ -253,7 +261,11 @@ def update_metadata(
     app_client: App = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    data = helpers.template_handler(file, params_file, params, description_file)
+    markdown_files = {}
+    if description_file:
+        markdown_files["body:metadata:description"] = description_file
+
+    data = helpers.template_handler(file, params_file, params, markdown_files)
     data = helpers.remove_unknown_args(data, app_client.update_spec_metadata)
 
     with writer.pager():
@@ -261,7 +273,7 @@ def update_metadata(
         writer.write(response)
 
 
-@app.command(short_help="Delete an App spec.", options_metavar="delete_app_spec")
+@app.command(short_help="Delete an App spec.")
 def delete(
     ctx: typer.Context,
     spec_id: str = _SPEC_ID,
@@ -293,11 +305,12 @@ def delete(
         writer.write(response)
 
 
-@app.command(short_help="Create a new release of the App spec.", options_metavar="create_app_spec_release")
+@app.command(short_help="Create a new release of the App spec.")
 def create_release(
     ctx: typer.Context,
     spec_id: str = _SPEC_ID,
     file: str = args.TEMPLATE_PATH,
+    release_notes_file: Optional[str] = args.RELEASE_NOTES_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -318,6 +331,7 @@ def create_release(
             - id (string): ID of the block spec.
               release (map):
                 version (string): A valid semantic release version of the block spec.
+              autoRunOnDeploy (bool | required: false): Whether to execute the resource after the app is deployed. By default it is False.
     ```
 
     \b
@@ -342,7 +356,11 @@ def create_release(
     app_client: App = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params)
+    markdown_files = {}
+    if release_notes_file:
+        markdown_files["body:release:notes"] = release_notes_file
+
+    body = helpers.template_handler(file, params_file, params, markdown_files)
     body = helpers.remove_unknown_args(body, app_client.create_spec_release)
 
     with writer.pager():
@@ -350,7 +368,7 @@ def create_release(
         writer.write(response)
 
 
-@app.command(short_help="Describe an App spec release.", options_metavar="describe_app_spec_release")
+@app.command(short_help="Describe an App spec release.")
 def describe_release(
     ctx: typer.Context,
     spec_id: str = args.SPEC_ID,
@@ -395,7 +413,7 @@ def describe_release(
         writer.write(response)
 
 
-@app.command(short_help="List App specs releases.", options_metavar="list_app_spec_releases")
+@app.command(short_help="List App specs releases.")
 def list_releases(
     ctx: typer.Context,
     spec_id: str = args.SPEC_ID,

peak/cli/press/blocks/deployments.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Peak blocks deployments commands."""
+
 from __future__ import annotations
 
 from typing import Dict, List, Optional
@@ -45,11 +46,12 @@ _FALLBACK_DETAILS_FILE = typer.Option(
 )
 
 
-@app.command(short_help="Create a Block deployment.", options_metavar="create_block_deployment")
+@app.command(short_help="Create a Block deployment.")
 def create(
     ctx: typer.Context,
     file: str = args.TEMPLATE_PATH,
     description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
+    revision_notes_file: Optional[str] = args.REVISION_NOTES_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -102,7 +104,13 @@ def create(
     blocks_client: Block = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params, description_file)
+    markdown_files = {}
+    if description_file:
+        markdown_files["body:metadata:description"] = description_file
+    if revision_notes_file:
+        markdown_files["body:revision:notes"] = revision_notes_file
+
+    body = helpers.template_handler(file, params_file, params, markdown_files)
     body = helpers.remove_unknown_args(body, blocks_client.create_deployment)
 
     with writer.pager():
@@ -110,7 +118,7 @@ def create(
         writer.write(response)
 
 
-@app.command("list", short_help="List Block deployments.", options_metavar="list_block_deployments")
+@app.command("list", short_help="List Block deployments.")
 def list_block_deployments(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -160,7 +168,7 @@ def list_block_deployments(
         writer.write(response)
 
 
-@app.command(short_help="Describe the Block deployment.", options_metavar="descibe_block_deployment")
+@app.command(short_help="Describe the Block deployment.")
 def describe(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
@@ -176,7 +184,7 @@ def describe(
     \b
     📝 ***Example usage:***<br/>
     ```bash
-    peak blocks deployments describe "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+    peak blocks deployments describe <deployment_id>
     ```
 
     \b
@@ -202,7 +210,7 @@ def describe(
         writer.write(response)
 
 
-@app.command(short_help="Update the Block deployment metadata.", options_metavar="update_block_deployment_metadata")
+@app.command(short_help="Update the Block deployment metadata.")
 def update_metadata(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
@@ -234,7 +242,7 @@ def update_metadata(
     \b
     📝 ***Example usage:***
     ```bash
-    peak blocks deployments update-metadata "632a4e7c-ab86-4ecb-8f34-99b5da531ceb" /path/to/body.yaml -v /path/to/params.yaml
+    peak blocks deployments update-metadata <deployment_id> /path/to/body.yaml -v /path/to/params.yaml
     ```
 
     \b
@@ -254,7 +262,11 @@ def update_metadata(
     blocks_client: Block = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params, description_file)
+    markdown_files = {}
+    if description_file:
+        markdown_files["body:description"] = description_file
+
+    body = helpers.template_handler(file, params_file, params, markdown_files)
     body = helpers.remove_unknown_args(body, blocks_client.update_deployment_metadata)
 
     with writer.pager():
@@ -262,7 +274,43 @@ def update_metadata(
         writer.write(response)
 
 
-@app.command(short_help="Delete a Block deployment.", options_metavar="delete_block_deployment")
+@app.command(short_help="Redeploy a Block deployment.")
+def redeploy(
+    ctx: typer.Context,
+    deployment_id: str = _DEPLOYMENT_ID,
+    dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """***Redeploy*** latest revision of a Block deployment. This allows you to redeploy a Block deployment that is in `failed` or `warning` state.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak blocks deployments redeploy <deployment_id>
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "deploymentId": "632a4e7c-ab86-4ecb-8f34-99b5da531ceb",
+        "revision": 2
+        "revisionId": "7092bd84-c35d-43c1-90ca-7510a1204dcc"
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/Block%20Deployments/redeploy_v1_blocks_deployments__deploymentId_)
+    """
+    blocks_client: Block = ctx.obj["client"]
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = blocks_client.redeploy(deployment_id)
+        writer.write(response)
+
+
+@app.command(short_help="Delete a Block deployment.")
 def delete(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
@@ -275,7 +323,7 @@ def delete(
     \b
     📝 ***Example usage:***<br/>
     ```bash
-    peak blocks deployments delete "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+    peak blocks deployments delete <deployment_id>
     ```
 
     \b
@@ -294,11 +342,12 @@ def delete(
         writer.write(response)
 
 
-@app.command(short_help="Create a Block deployment revision.", options_metavar="create_block_deployment_revision")
+@app.command(short_help="Create a Block deployment revision.")
 def create_revision(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
     file: str = args.TEMPLATE_PATH,
+    revision_notes_file: Optional[str] = args.REVISION_NOTES_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -342,7 +391,11 @@ def create_revision(
     blocks_client: Block = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params)
+    markdown_files = {}
+    if revision_notes_file:
+        markdown_files["body:revision:notes"] = revision_notes_file
+
+    body = helpers.template_handler(file, params_file, params, markdown_files)
     body = helpers.remove_unknown_args(body, blocks_client.create_deployment_revision)
 
     with writer.pager():
@@ -350,7 +403,7 @@ def create_revision(
         writer.write(response)
 
 
-@app.command(short_help="Describe a Block deployment revision.", options_metavar="describe_block_deployment_revision")
+@app.command(short_help="Describe a Block deployment revision.")
 def describe_revision(
     ctx: typer.Context,
     deployment_id: str = args.DEPLOYMENT_ID,
@@ -367,7 +420,7 @@ def describe_revision(
     \b
     📝 ***Example usage:***<br/>
     ```bash
-    peak blocks deployments describe-revision --deployment-id "632a4e7c-ab86-4ecb-8f34-99b5da531ceb" --revision 2
+    peak blocks deployments describe-revision --deployment-id <deployment_id> --revision 2
     ```
 
     \b
@@ -397,7 +450,7 @@ def describe_revision(
         writer.write(response)
 
 
-@app.command(short_help="List revisions of a Block deployment.", options_metavar="list_block_deployment_revisions")
+@app.command(short_help="List revisions of a Block deployment.")
 def list_revisions(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
@@ -445,7 +498,7 @@ def list_revisions(
         writer.write(response)
 
 
-@app.command(short_help="Get the parameters for a deployment at run time.", options_metavar="get_block_parameters")
+@app.command(short_help="Get the parameters for a deployment at run time.")
 def get_parameters(
     ctx: typer.Context,
     deployment_id: Optional[str] = _DEPLOYMENT_ID_OPTION,
@@ -480,7 +533,7 @@ def get_parameters(
         writer.write(response)
 
 
-@app.command(short_help="Update the parameters for a deployment at run time.", options_metavar="patch_block_parameters")
+@app.command(short_help="Update the parameters for a deployment at run time.")
 def patch_parameters(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
@@ -525,7 +578,7 @@ def patch_parameters(
         writer.write(response)
 
 
-@app.command(short_help="Get the info for related blocks within an app.", options_metavar="get_related_block_details")
+@app.command(short_help="Get the info for related blocks within an app.")
 def get_related_block_details(
     ctx: typer.Context,
     deployment_id: Optional[str] = _DEPLOYMENT_ID_OPTION,