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

peak/press/apps.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Apps client module."""
+
 from __future__ import annotations
 
 import json
@@ -151,7 +152,8 @@ class App(BaseClient):
 
         All App Specs must have unique names within a tenant.
         An App Spec must now be made up of already existing block specs.
-        Spec details (specId and release) needs to be added in the spec body inside `config` key.
+        Spec details (Block spec ID and Release version) needs to be added to the `config` key.
+        `config` also contains a `autoRunOnDeploy` key which is a boolean value to specify if the resource should be executed on successful deployment of the app. By default, it is False.
 
         REFERENCE:
             🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/App%20Specs/post_v1_apps_specs_>`__
@@ -196,7 +198,8 @@ class App(BaseClient):
                             "id": "string(required)",
                             "release": {
                                 "version": "string(required)",
-                            }
+                            },
+                            "autoRunOnDeploy": "boolean (By default it is False)",
                         }
                     ]
                 }
@@ -319,6 +322,9 @@ class App(BaseClient):
     def create_spec_release(self, spec_id: str, body: Dict[str, Any]) -> Dict[str, str]:
         """Publish a new release to an existing App spec.
 
+        Spec details (Block spec ID and Release version) needs to be added to the `config` key.
+        `config` also contains a `autoRunOnDeploy` key which is a boolean value to specify if the resource should be executed on successful deployment of the app. By default, it is False.
+
         REFERENCE:
             🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/App%20Specs/post_v1_apps_specs__specId__releases>`__
 
@@ -338,7 +344,8 @@ class App(BaseClient):
                             "id": "string(required)",
                             "release": {
                                 "version": "string(required)",
-                            }
+                            },
+                            "autoRunOnDeploy": "boolean (By default it is False)",
                         }
                     ],
                     "release": {
@@ -702,6 +709,39 @@ class App(BaseClient):
             subdomain="press",
         )
 
+    def redeploy(self, deployment_id: str) -> Dict[str, Any]:
+        """Redeploy latest revision of an existing App deployment.
+
+        This function 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.
+
+        REFERENCE:
+            🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/App%20Deployments/post_v1_apps_deployments__deploymentId__redeploy>`__
+
+        Args:
+            deployment_id (str): The ID of the App deployment to redeploy.
+
+        Returns:
+            Dict[str, Any]: A dictionary containing details of the deployment.
+
+        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 App deployment or its revisions do not exist.
+            ConflictException: There is a conflict with the current state of the target resource.
+            UnprocessableEntityException: The server was unable to process the request.
+            InternalServerErrorException: the server encountered an unexpected condition that
+                prevented it from fulfilling the request.
+        """
+        method, endpoint = HttpMethods.POST, f"{self.DEPLOYMENTS_BASE_ENDPOINT}/{deployment_id}/redeploy"
+
+        return self.session.create_request(  # type: ignore[no-any-return]
+            endpoint,
+            method,
+            content_type=ContentType.APPLICATION_JSON,
+            subdomain="press",
+        )
+
     def delete_deployment(self, deployment_id: str) -> Dict[None, None]:
         """Deletes an App deployment.