peak-sdk 1.8.0__tar.gz → 1.9.0__tar.gz

{peak_sdk-1.8.0 → peak_sdk-1.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peak-sdk
-Version: 1.8.0
+Version: 1.9.0
 Summary: Python SDK for interacting with the Peak platform
 Home-page: https://docs.peak.ai/sdk/latest/
 License: Apache-2.0

{peak_sdk-1.8.0 → peak_sdk-1.9.0}/peak/_version.py

@@ -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.8.0"
+__version__: str = "1.9.0"

{peak_sdk-1.8.0 → peak_sdk-1.9.0}/peak/cli/resources/tenants.py

@@ -23,7 +23,7 @@ from typing import Optional
 
 import typer
 from peak.cli.args import OUTPUT_TYPES, PAGING
-from peak.constants import OutputTypes
+from peak.constants import OutputTypes, OutputTypesNoTable
 from peak.output import Writer
 from peak.resources.tenants import Tenant
 
@@ -37,6 +37,11 @@ _ENTITY_TYPE = typer.Option(
     help="Entity type to be used in this operation (e.g. - `workflow`, `webapp`, `api-deployment`).",
 )
 
+_DATA_STORE_TYPE = typer.Option(
+    None,
+    help="Data store type. The only allowed values is data-warehouse.",
+)
+
 
 @app.command(
     "list-instance-options",
@@ -58,7 +63,7 @@ def list_instance_options(
 
     \b
     🆗 ***Response:***
-    ```
+    ```json
     {
       "data": [
         {
@@ -66,7 +71,7 @@ def list_instance_options(
           "gpu": null,
           "gpuMemory": null,
           "id": 20,
-          "instanceClass": "Genaeral Purpose",
+          "instanceClass": "General Purpose",
           "memory": 125,
           "name": "Pico (0.125CPU, 0.125GB RAM)",
           "provider": "k8s",
@@ -84,3 +89,48 @@ def list_instance_options(
     with writer.pager():
         response = tenants_client.list_instance_options(entity_type=entity_type)
         writer.write(response)
+
+
+@app.command(
+    short_help="Get credentails for a data store.",
+)
+def get_credentials(
+    ctx: typer.Context,
+    data_store_type: Optional[str] = _DATA_STORE_TYPE,
+    output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """***Get*** credentials for the given data store type.
+
+    \b
+    📝 ***Example Usage:***<br/>
+    ```bash
+    peak tenants get-credentials --data-store-type data-warehouse
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+      "application": "application",
+      "connectionString": "snowflake://host/database?authenticator=OAUTH&token=generated-access-token",
+      "integration": "integration_name",
+      "port": 443,
+      "role": "role_name",
+      "schema": "schema",
+      "warehouse": "warehouse",
+      "accessToken": "generated-access-token",
+      "authType": "oauth",
+      "database": "database",
+      "host": "host",
+      "dataWarehouseType": "snowflake"
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/connections/api-docs/index.htm#/connections/get_api_v1_connections_credentials)
+    """
+    tenants_client: Tenant = ctx.obj["client"]
+    writer = Writer()
+
+    with writer.pager():
+        response = tenants_client.get_credentials(data_store_type=data_store_type)
+        writer.write(response)

{peak_sdk-1.8.0 → peak_sdk-1.9.0}/peak/resources/tenants.py

@@ -31,7 +31,8 @@ from peak.session import Session
 class Tenant(BaseClient):
     """Tenant client class."""
 
-    BASE_ENDPOINT = "quota/api/v1"
+    QUOTA_BASE_ENDPOINT = "quota/api/v1"
+    CONNECTIONS_BASE_ENDPOINT = "connections/api/v1"
 
     def list_instance_options(
         self,
@@ -56,7 +57,7 @@ class Tenant(BaseClient):
             NotFoundException: The given image does not exist.
             InternalServerErrorException: The server failed to process the request.
         """
-        method, endpoint = HttpMethods.GET, f"{self.BASE_ENDPOINT}/settings/tenant-instance-options"
+        method, endpoint = HttpMethods.GET, f"{self.QUOTA_BASE_ENDPOINT}/settings/tenant-instance-options"
         params = {"entityType": entity_type}
 
         return self.session.create_request(  # type: ignore[no-any-return]
@@ -66,6 +67,40 @@ class Tenant(BaseClient):
             params=params,
         )
 
+    def get_credentials(
+        self,
+        data_store_type: Optional[str] = None,
+    ) -> Dict[str, Any]:
+        """Retrieve credentials for a given data store type.
+
+        REFERENCE:
+            🔗 `API Documentation <https://service.peak.ai/connections/api-docs/index.htm#/connections/get_api_v1_connections_credentials>`__
+
+        Args:
+            data_store_type (str): The type of the data store.
+                Allowed values are - data-warehouse.
+                Default - data-warehouse
+
+        Returns:
+            Dict[str, Any]: a dictionary containing the credentials for the data store.
+
+        Raises:
+            BadRequestException: The given request parameters are invalid.
+            UnauthorizedException: The credentials are invalid.
+            ForbiddenException: The user does not have permission to perform the operation.
+            NotFoundException: The given image does not exist.
+            InternalServerErrorException: The server failed to process the request.
+        """
+        method, endpoint = HttpMethods.GET, f"{self.CONNECTIONS_BASE_ENDPOINT}/connections/credentials"
+        params = {"type": data_store_type}
+
+        return self.session.create_request(  # type: ignore[no-any-return]
+            endpoint,
+            method,
+            content_type=ContentType.APPLICATION_JSON,
+            params=params,
+        )
+
 
 def get_client(session: Optional[Session] = None) -> Tenant:
     """Returns a Tenant client, If no session is provided, a default session is used.

{peak_sdk-1.8.0 → peak_sdk-1.9.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "peak-sdk"
-version = "1.8.0"
+version = "1.9.0"
 packages = [{ include = "peak" }]
 description = "Python SDK for interacting with the Peak platform"
 authors = ["Peak <support@peak.ai>"]