infisicalsdk 1.0.11__tar.gz → 1.0.12__tar.gz

infisicalsdk-1.0.12/LICENSE

@@ -0,0 +1,11 @@
+MIT License
+
+Copyright (c) 2025 Infisical
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+NOTE: This license pertains specifically to components of the codebase that do not possess an explicit license. Each distinct SDK incorporated within this software is governed by its individual licensing terms and conditions. The provisions outlined in this MIT license are applicable to those segments of the codebase not explicitly covered by their respective licenses.

{infisicalsdk-1.0.11 → infisicalsdk-1.0.12}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: infisicalsdk
-Version: 1.0.11
+Version: 1.0.12
 Summary: Official Infisical SDK for Python (Latest)
 Home-page: https://github.com/Infisical/python-sdk-official
 Author: Infisical
 Author-email: support@infisical.com
 Keywords: Infisical,Infisical API,Infisical SDK,SDK,Secrets Management
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: python-dateutil
 Requires-Dist: aenum
 Requires-Dist: requests~=2.32
@@ -18,6 +19,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: summary
 

infisicalsdk-1.0.12/README.md

@@ -0,0 +1,40 @@
+<h1 align="center">
+  <img width="300" src="/img/logoname-white.svg#gh-dark-mode-only" alt="infisical">
+</h1>
+<p align="center">
+  <p align="center"><b>Infisical Python SDK</b></p>
+<h4 align="center">
+|
+  <a href="https://infisical.com/docs/sdks/languages/python">Documentation</a> |
+  <a href="https://www.infisical.com">Website</a> |
+  <a href="https://infisical.com/slack">Slack</a> |
+</h4>
+
+<h4 align="center">
+  <a href="https://github.com/Infisical/python-sdk-official/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Infisical SDK's are released under the MIT license." />
+  </a>
+  <a href="https://infisical.com/slack">
+    <img src="https://img.shields.io/badge/chat-on%20Slack-blueviolet" alt="Slack community channel" />
+  </a>
+  <a href="https://twitter.com/infisical">
+    <img src="https://img.shields.io/twitter/follow/infisical?label=Follow" alt="Infisical Twitter" />
+  </a>
+</h4>
+
+## Introduction
+
+**[Infisical](https://infisical.com)** is the open source secret management platform that teams use to centralize their secrets like API keys, database credentials, and configurations.
+
+If you’re working with Python, the official Infisical Python SDK package is the easiest way to fetch and work with secrets for your application. You can read the documentation [here](https://infisical.com/docs/sdks/languages/python).
+
+## Documentation
+You can find the documentation for the Python SDK on our [SDK documentation page](https://infisical.com/docs/sdks/languages/python).
+
+## Security
+
+Please do not file GitHub issues or post on our public forum for security vulnerabilities, as they are public!
+
+Infisical takes security issues very seriously. If you have any concerns about Infisical or believe you have uncovered a vulnerability, please get in touch via the e-mail address security@infisical.com. In the message, try to provide a description of the issue and ideally a way of reproducing it. The security team will get back to you as soon as possible.
+
+Note that this security address should be used only for undisclosed vulnerabilities. Please report any security problems to us before disclosing it publicly.

{infisicalsdk-1.0.11 → infisicalsdk-1.0.12}/infisical_sdk/api_types.py

@@ -194,3 +194,102 @@ class KmsKeyEncryptDataResponse(BaseModel):
 class KmsKeyDecryptDataResponse(BaseModel):
     """Response model for decrypt data API"""
     plaintext: str
+
+@dataclass
+class CreateFolderResponseItem(BaseModel):
+    """Folder model with path for create response"""
+    id: str
+    name: str
+    createdAt: str
+    updatedAt: str
+    envId: str
+    path: str
+    version: Optional[int] = 1
+    parentId: Optional[str] = None
+    isReserved: Optional[bool] = False
+    description: Optional[str] = None
+    lastSecretModified: Optional[str] = None
+
+@dataclass
+class CreateFolderResponse(BaseModel):
+    """Response model for create folder API"""
+    folder: CreateFolderResponseItem
+
+    @classmethod
+    def from_dict(cls, data: Dict) -> 'CreateFolderResponse':
+        return cls(
+            folder=CreateFolderResponseItem.from_dict(data['folder']),
+        )
+
+
+@dataclass
+class ListFoldersResponseItem(BaseModel):
+    """Response model for list folders API"""
+    id: str
+    name: str
+    createdAt: str
+    updatedAt: str
+    envId: str
+    version: Optional[int] = 1
+    parentId: Optional[str] = None
+    isReserved: Optional[bool] = False
+    description: Optional[str] = None
+    lastSecretModified: Optional[str] = None 
+    relativePath: Optional[str] = None
+
+
+@dataclass
+class ListFoldersResponse(BaseModel):
+    """Complete response model for folders API"""
+    folders: List[ListFoldersResponseItem]
+
+    @classmethod
+    def from_dict(cls, data: Dict) -> 'ListFoldersResponse':
+        """Create model from dictionary with camelCase keys, handling nested objects"""
+        return cls(
+            folders=[ListFoldersResponseItem.from_dict(folder) for folder in data['folders']]
+        )
+
+
+@dataclass
+class Environment(BaseModel):
+    """Environment model"""
+    envId: str
+    envName: str
+    envSlug: str
+
+@dataclass
+class SingleFolderResponseItem(BaseModel):
+    """Response model for get folder API"""
+    id: str
+    name: str
+    createdAt: str
+    updatedAt: str
+    envId: str
+    path: str
+    projectId: str
+    environment: Environment
+    version: Optional[int] = 1
+    parentId: Optional[str] = None
+    isReserved: Optional[bool] = False
+    description: Optional[str] = None
+    lastSecretModified: Optional[str] = None
+    
+    @classmethod
+    def from_dict(cls, data: Dict) -> 'SingleFolderResponseItem':
+        """Create model from dictionary with nested Environment"""
+        folder_data = data.copy()
+        folder_data['environment'] = Environment.from_dict(data['environment'])
+        
+        return super().from_dict(folder_data)
+
+@dataclass
+class SingleFolderResponse(BaseModel):
+    """Response model for get/create folder API"""
+    folder: SingleFolderResponseItem
+
+    @classmethod
+    def from_dict(cls, data: Dict) -> 'SingleFolderResponse':
+        return cls(
+            folder=SingleFolderResponseItem.from_dict(data['folder']),
+        )

{infisicalsdk-1.0.11 → infisicalsdk-1.0.12}/infisical_sdk/client.py

@@ -3,6 +3,7 @@ from .infisical_requests import InfisicalRequests
 from infisical_sdk.resources import Auth
 from infisical_sdk.resources import V3RawSecrets
 from infisical_sdk.resources import KMS
+from infisical_sdk.resources import V2Folders
 
 from infisical_sdk.util import SecretsCache
 
@@ -24,6 +25,7 @@ class InfisicalSDKClient:
         self.auth = Auth(self.api, self.set_token)
         self.secrets = V3RawSecrets(self.api, self.cache)
         self.kms = KMS(self.api)
+        self.folders = V2Folders(self.api)
 
     def set_token(self, token: str):
         """

{infisicalsdk-1.0.11 → infisicalsdk-1.0.12}/infisical_sdk/resources/__init__.py

@@ -1,3 +1,4 @@
 from .secrets import V3RawSecrets
 from .kms import KMS
-from .auth import Auth
+from .auth import Auth
+from .folders import V2Folders

infisicalsdk-1.0.12/infisical_sdk/resources/folders.py

@@ -0,0 +1,75 @@
+from typing import Optional
+from datetime import datetime, timezone
+
+from infisical_sdk.infisical_requests import InfisicalRequests
+from infisical_sdk.api_types import ListFoldersResponse, SingleFolderResponse, SingleFolderResponseItem, CreateFolderResponse, CreateFolderResponseItem
+
+
+class V2Folders:
+    def __init__(self, requests: InfisicalRequests) -> None:
+        self.requests = requests
+
+    def create_folder(
+            self,
+            name: str,
+            environment_slug: str,
+            project_id: str,
+            path: str = "/",
+            description: Optional[str] = None) -> CreateFolderResponseItem:
+
+        request_body = {
+            "projectId": project_id,
+            "environment": environment_slug,
+            "name": name,
+            "path": path,
+            "description": description,
+        }
+
+        result = self.requests.post(
+            path="/api/v2/folders",
+            json=request_body,
+            model=CreateFolderResponse
+        )
+
+        return result.data.folder
+
+    def list_folders(
+            self,
+            project_id: str,
+            environment_slug: str,
+            path: str,
+            last_secret_modified: Optional[datetime] = None,
+            recursive: bool = False) -> ListFoldersResponse:
+
+        params = {
+            "projectId": project_id,
+            "environment": environment_slug,
+            "path": path,
+            "recursive": recursive,
+        }
+
+        if last_secret_modified is not None:
+            # Convert to UTC and format as RFC 3339 with 'Z' suffix
+            # The API expects UTC times in 'Z' format (e.g., 2023-11-07T05:31:56Z)
+            utc_datetime = last_secret_modified.astimezone(timezone.utc) if last_secret_modified.tzinfo else last_secret_modified.replace(tzinfo=timezone.utc)
+            params["lastSecretModified"] = utc_datetime.strftime('%Y-%m-%dT%H:%M:%SZ')
+
+        result = self.requests.get(
+            path="/api/v2/folders",
+            params=params,
+            model=ListFoldersResponse
+        )
+
+        return result.data
+
+    def get_folder_by_id(
+            self,
+            id: str) -> SingleFolderResponseItem:
+
+        result = self.requests.get(
+            path=f"/api/v2/folders/{id}",
+            model=SingleFolderResponse
+        )
+
+        return result.data.folder
+

{infisicalsdk-1.0.11 → infisicalsdk-1.0.12}/infisicalsdk.egg-info/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: infisicalsdk
-Version: 1.0.11
+Version: 1.0.12
 Summary: Official Infisical SDK for Python (Latest)
 Home-page: https://github.com/Infisical/python-sdk-official
 Author: Infisical
 Author-email: support@infisical.com
 Keywords: Infisical,Infisical API,Infisical SDK,SDK,Secrets Management
 Description-Content-Type: text/markdown
+License-File: LICENSE
 Requires-Dist: python-dateutil
 Requires-Dist: aenum
 Requires-Dist: requests~=2.32
@@ -18,6 +19,7 @@ Dynamic: description
 Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: keywords
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: summary
 

{infisicalsdk-1.0.11 → infisicalsdk-1.0.12}/infisicalsdk.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE
 README.md
 pyproject.toml
 setup.cfg
@@ -8,6 +9,7 @@ infisical_sdk/client.py
 infisical_sdk/infisical_requests.py
 infisical_sdk/resources/__init__.py
 infisical_sdk/resources/auth.py
+infisical_sdk/resources/folders.py
 infisical_sdk/resources/kms.py
 infisical_sdk/resources/secrets.py
 infisical_sdk/resources/auth_methods/__init__.py

{infisicalsdk-1.0.11 → infisicalsdk-1.0.12}/setup.py

@@ -15,7 +15,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "infisicalsdk"
-VERSION = "1.0.11"
+VERSION = "1.0.12"
 PYTHON_REQUIRES = ">=3.8"
 REQUIRES = [
     "python-dateutil",

infisicalsdk-1.0.11/README.md

@@ -1,399 +0,0 @@
-# Infisical Python SDK
-
-The Infisical SDK provides a convenient way to interact with the Infisical API. 
-
-### Migrating to version 1.0.3 or above
-
-We have recently rolled out our first stable version of the SDK, version `1.0.3` and above.
-
-The 1.0.3 version comes with a few key changes that may change how you're using the SDK.
-1. **Removal of `rest`**: The SDK no longer exposes the entire Infisical API. This was nessecary as we have moved away from using an OpenAPI generator approach. We aim to add support for more API resources in the near future. If you have any specific requests, please [open an issue](https://github.com/Infisical/python-sdk-official/issues).
-
-2. **New response types**: The 1.0.3 release uses return types that differ from the older versions. The new return types such as `BaseSecret`, are all exported from the Infisical SDK.
-
-3. **Property renaming**: Some properties on the responses have been slightly renamed. An example of this would be that the `secret_key` property on the `get_secret_by_name()` method, that has been renamed to `secretKey`.
-
-With this in mind, you're ready to upgrade your SDK version to `1.0.3` or above. 
-
-You can refer to our [legacy documentation](https://github.com/Infisical/python-sdk-official/tree/9b0403938ee5ae599d42c5f1fdf9158671a15606?tab=readme-ov-file#infisical-python-sdk) if need be.
-
-## Requirements
-
-Python 3.7+
-
-## Installation
-
-```bash
-pip install infisicalsdk
-```
-
-## Getting Started
-
-```python
-from infisical_sdk import InfisicalSDKClient
-
-# Initialize the client
-client = InfisicalSDKClient(host="https://app.infisical.com")
-
-# Authenticate (example using Universal Auth)
-client.auth.universal_auth.login(
-    client_id="<machine-identity-client-id>", 
-    client_secret="<machine-identity-client-secret>"
-)
-
-# Use the SDK to interact with Infisical
-secrets = client.secrets.list_secrets(project_id="<project-id>", environment_slug="dev", secret_path="/")
-```
-
-## InfisicalSDKClient Parameters
-
-The `InfisicalSDKClient` takes the following parameters, which are used as a global configuration for the lifetime of the SDK instance.
-
-- **host** (`str`, _Optional_): The host URL for your Infisical instance. Defaults to `https://app.infisical.com`.
-- **token** (`str`, _Optional_): Specify an authentication token to use for all requests. If provided, you will not need to call any of the `auth` methods. Defaults to `None`
-- **cache_ttl** (`int`, _Optional_): The SDK has built-in client-side caching for secrets, greatly improving response times. By default, secrets are cached for 1 minute (60 seconds). You can disable caching by setting `cache_ttl` to `None`, or adjust the duration in seconds as needed.
-
-```python
-client = InfisicalSDKClient(
-  host="https://app.infisical.com", # Defaults to https://app.infisical.com
-  token="<optional-auth-token>", # If not set, use the client.auth() methods.
-  cache_ttl = 300 # `None` to disable caching
-)
-```
-
-## Core Methods
-
-The SDK methods are organized into the following high-level categories:
-
-1. `auth`: Handles authentication methods.
-2. `secrets`: Manages CRUD operations for secrets.
-3. `kms`: Perform cryptographic operations with Infisical KMS.
-
-### `auth`
-
-The `Auth` component provides methods for authentication:
-
-#### Universal Auth
-
-```python
-response = client.auth.universal_auth.login(
-    client_id="<machine-identity-client-id>", 
-    client_secret="<machine-identity-client-secret>"
-)
-```
-
-#### AWS Auth
-
-```python
-response = client.auth.aws_auth.login(identity_id="<machine-identity-id>")
-```
-
-### `secrets`
-
-This sub-class handles operations related to secrets:
-
-#### List Secrets
-
-```python
-secrets = client.secrets.list_secrets(
-    project_id="<project-id>",
-    environment_slug="dev",
-    secret_path="/",
-    expand_secret_references=True, # Optional
-    view_secret_value=True, # Optional 
-    recursive=False, # Optional
-    include_imports=True, # Optional
-    tag_filters=[] # Optional
-)
-```
-
-**Parameters:**
-- `project_id` (str): The ID of your project.
-- `project_slug` (str): The slug of your project.
-- `environment_slug` (str): The environment in which to list secrets (e.g., "dev").
-- `secret_path` (str): The path to the secrets.
-- `expand_secret_references` (bool): Whether to expand secret references.
-- `view_secret_value` (bool): Whether or not to include the secret value in the response. If set to false, the `secretValue` will be masked with `<hidden-by-infisical>`. Defaults to true.
-- `recursive` (bool): Whether to list secrets recursively.
-- `include_imports` (bool): Whether to include imported secrets.
-- `tag_filters` (List[str]): Tags to filter secrets.
-
-**Note:** Exactly one of `project_id` or `project_slug` is required. If both are provided, `project_id` takes precedence.
-
-**Returns:**
-- `ListSecretsResponse`: The response containing the list of secrets.
-
-#### Create Secret
-
-```python
-new_secret = client.secrets.create_secret_by_name(
-    secret_name="NEW_SECRET",
-    project_id="<project-id>",
-    secret_path="/",
-    environment_slug="dev",
-    secret_value="secret_value",
-    secret_comment="Optional comment",
-    skip_multiline_encoding=False,
-    secret_reminder_repeat_days=30,  # Optional
-    secret_reminder_note="Remember to update this secret"  # Optional
-    secret_metadata=[{"key": "metadata_key", "value": "metadata_value"}], # Optional
-    tags_ids=["tag_id_1", "tag_id_2"] # Optional
-)
-```
-
-**Parameters:**
-- `secret_name` (str): The name of the secret.
-- `project_id` (str): The ID of your project.
-- `project_slug` (str): The slug of your project.
-- `secret_path` (str): The path to the secret.
-- `environment_slug` (str): The environment in which to create the secret.
-- `secret_value` (str): The value of the secret.
-- `secret_comment` (str, optional): A comment associated with the secret.
-- `skip_multiline_encoding` (bool, optional): Whether to skip encoding for multiline secrets.
-- `secret_reminder_repeat_days` (Union[float, int], optional): Number of days after which to repeat secret reminders.
-- `secret_reminder_note` (str, optional): A note for the secret reminder.
-- `secret_metadata` (List[Dict[str, Any]], optional): Metadata associated with the secret.
-- `tags_ids` (List[str], optional): IDs of tags to associate with the secret.
-
-**Note:** Exactly one of `project_id` or `project_slug` is required. If both are provided, `project_id` takes precedence.
-
-**Returns:**
-- `BaseSecret`: The response after creating the secret.
-
-#### Update Secret
-
-```python
-updated_secret = client.secrets.update_secret_by_name(
-    current_secret_name="EXISTING_SECRET",
-    project_id="<project-id>",
-    project_slug="<project-slug>",
-    secret_path="/",
-    environment_slug="dev",
-    secret_value="new_secret_value",
-    secret_comment="Updated comment",  # Optional
-    skip_multiline_encoding=False,
-    secret_reminder_repeat_days=30,  # Optional
-    secret_reminder_note="Updated reminder note",  # Optional
-    new_secret_name="NEW_NAME"  # Optional
-    secret_metadata=[{"key": "metadata_key", "value": "metadata_value"}], # Optional
-    tags_ids=["tag_id_1", "tag_id_2"] # Optional
-)
-```
-
-**Parameters:**
-- `current_secret_name` (str): The current name of the secret.
-- `project_id` (str): The ID of your project.
-- `project_slug` (str): The slug of your project.
-- `secret_path` (str): The path to the secret.
-- `environment_slug` (str): The environment in which to update the secret.
-- `secret_value` (str, optional): The new value of the secret.
-- `secret_comment` (str, optional): An updated comment associated with the secret.
-- `skip_multiline_encoding` (bool, optional): Whether to skip encoding for multiline secrets.
-- `secret_reminder_repeat_days` (Union[float, int], optional): Updated number of days after which to repeat secret reminders.
-- `secret_reminder_note` (str, optional): An updated note for the secret reminder.
-- `new_secret_name` (str, optional): A new name for the secret.
-- `secret_metadata` (List[Dict[str, Any]], optional): Metadata associated with the secret.
-- `tags_ids` (List[str], optional): IDs of tags to associate with the secret.
-
-**Note:** Exactly one of `project_id` or `project_slug` is required. If both are provided, `project_id` takes precedence.
-
-**Returns:**
-- `BaseSecret`: The response after updating the secret.
-
-#### Get Secret by Name
-
-```python
-secret = client.secrets.get_secret_by_name(
-    secret_name="EXISTING_SECRET",
-    project_id="<project-id>",
-    environment_slug="dev",
-    secret_path="/",
-    expand_secret_references=True, # Optional
-    view_secret_value=True, # Optional
-    include_imports=True, # Optional
-    version=None # Optional
-)
-```
-
-**Parameters:**
-- `secret_name` (str): The name of the secret.
-- `project_id` (str): The ID of your project.
-- `project_slug` (str): The slug of your project.
-- `environment_slug` (str): The environment in which to retrieve the secret.
-- `secret_path` (str): The path to the secret.
-- `expand_secret_references` (bool): Whether to expand secret references.
-- `view_secret_value` (bool): Whether or not to include the secret value in the response. If set to false, the `secretValue` will be masked with `<hidden-by-infisical>`. Defaults to true.
-- `include_imports` (bool): Whether to include imported secrets.
-- `version` (str, optional): The version of the secret to retrieve. Fetches the latest by default.
-
-**Note:** Exactly one of `project_id` or `project_slug` is required. If both are provided, `project_id` takes precedence.
-
-**Returns:**
-- `BaseSecret`: The response containing the secret.
-
-#### Delete Secret by Name
-
-```python
-deleted_secret = client.secrets.delete_secret_by_name(
-    secret_name="EXISTING_SECRET",
-    project_id="<project-id>",
-    environment_slug="dev",
-    secret_path="/"
-)
-```
-
-**Parameters:**
-- `secret_name` (str): The name of the secret to delete.
-- `project_id` (str): The ID of your project.
-- `project_slug` (str): The slug of your project.
-- `environment_slug` (str): The environment in which to delete the secret.
-- `secret_path` (str): The path to the secret.
-
-**Note:** Exactly one of `project_id` or `project_slug` is required. If both are provided, `project_id` takes precedence.
-
-**Returns:**
-- `BaseSecret`: The response after deleting the secret.
-
-### `kms`
-
-This sub-class handles KMS related operations:
-
-#### List KMS Keys
-
-```python
-kms_keys = client.kms.list_keys(
-    project_id="<project-id>",
-    offset=0, # Optional
-    limit=100, # Optional
-    order_by=KmsKeysOrderBy.NAME, # Optional
-    order_direction=OrderDirection.ASC, # Optional
-    search=None # Optional
-)
-```
-
-**Parameters:**
-- `project_id` (str): The ID of your project.
-- `offset` (int, optional): The offset to paginate from.
-- `limit` (int, optional): The page size for paginating.
-- `order_by` (KmsKeysOrderBy, optional): The key property to order the list response by.
-- `order_direction` (OrderDirection, optional): The direction to order the list response in.
-- `search` (str, optional): The text value to filter key names by.
-
-**Returns:**
-- `ListKmsKeysResponse`: The response containing the list of KMS keys.
-
-#### Get KMS Key by ID
-
-```python
-kms_key = client.kms.get_key_by_id(
-    key_id="<key-id>"
-)
-```
-
-**Parameters:**
-- `key_id` (str): The ID of the key to retrieve.
-
-**Returns:**
-- `KmsKey`: The specified key.
-
-#### Get KMS Key by Name
-
-```python
-kms_key = client.kms.get_key_by_name(
-    key_name="my-key",
-    project_id="<project-id>"
-)
-```
-
-**Parameters:**
-- `key_name` (str): The name of the key to retrieve.
-- `project_id` (str): The ID of your project.
-
-**Returns:**
-- `KmsKey`: The specified key.
-
-#### Create KMS Key
-
-```python
-kms_key = client.kms.create_key(
-    name="my-key",
-    project_id="<project-id>",
-    encryption_algorithm=SymmetricEncryption.AES_GCM_256,
-    description=None # Optional
-)
-```
-
-**Parameters:**
-- `name` (str): The name of the key (must be slug-friendly).
-- `project_id` (str): The ID of your project.
-- `encryption_algorithm` (SymmetricEncryption): The encryption alogrithm this key should use.
-- `description` (str, optional): A description of your key.
-
-**Returns:**
-- `KmsKey`: The newly created key.
-
-#### Update KMS Key
-
-```python
-updated_key = client.kms.update_key(
-    key_id="<key-id>",
-    name="my-updated-key", # Optional
-    description="Updated description", # Optional
-    is_disabled=True # Optional
-)
-```
-
-**Parameters:**
-- `key_id` (str): The ID of the key to be updated.
-- `name` (str, optional): The updated name of the key (must be slug-friendly).
-- `description` (str): The updated description of the key.
-- `is_disabled` (str): The flag to disable operations with this key.
-
-**Returns:**
-- `KmsKey`: The updated key.
-
-#### Delete KMS Key
-
-```python
-deleted_key = client.kms.delete_key(
-    key_id="<key-id>"
-)
-```
-
-**Parameters:**
-- `key_id` (str): The ID of the key to be deleted.
-
-**Returns:**
-- `KmsKey`: The deleted key.
-
-#### Encrypt Data with KMS Key
-
-```python
-encrypted_data = client.kms.encrypt_data(
-    key_id="<key-id>",
-    base64EncodedPlaintext="TXkgc2VjcmV0IG1lc3NhZ2U=" # must be base64 encoded
-)
-```
-
-**Parameters:**
-- `key_id` (str): The ID of the key to encrypt the data with.
-- `base64EncodedPlaintext` (str): The plaintext data to encrypt (must be base64 encoded).
-
-**Returns:**
-- `str`: The encrypted ciphertext.
-
-#### Decrypte Data with KMS Key
-
-```python
-decrypted_data = client.kms.decrypt_data(
-    key_id="<key-id>",
-    ciphertext="Aq96Ry7sMH3k/ogaIB5MiSfH+LblQRBu69lcJe0GfIvI48ZvbWY+9JulyoQYdjAx"
-)
-```
-
-**Parameters:**
-- `key_id` (str): The ID of the key to decrypt the data with.
-- `ciphertext` (str): The ciphertext returned from the encrypt operation.
-
-**Returns:**
-- `str`: The base64 encoded plaintext.