Add Environment read functionality (#210)

Enable users to programatically read secrets from 1Password Environments.

Author: edif2008

example/desktop_app.py

@@ -133,6 +133,15 @@ async def main():
     print(group)
     # [developer-docs.sdk.python.get-group]-end
 
+    environment_id = os.environ.get("OP_ENVIRONMENT_ID")
+    if environment_id is not None:
+        # [developer-docs.sdk.python.get-environment-variables]-start
+        # Read variables from a 1Password Environment
+        environment = await client.environments.get_variables(environment_id)
+        for variable in environment.variables:
+            print(f"{variable.name}: {variable.value} (masked: {variable.masked})")
+        # [developer-docs.sdk.python.get-environment-variables]-end
+
 
 if __name__ == "__main__":
     asyncio.run(main())

example/example.py

@@ -201,6 +201,15 @@ async def main():
     await client.items.delete(created_item.vault_id, updated_item.id)
     # [developer-docs.sdk.python.delete-item]-end
 
+    environment_id = os.environ.get("OP_ENVIRONMENT_ID")
+    if environment_id is not None:
+        # [developer-docs.sdk.python.get-environment-variables]-start
+        # Read variables from a 1Password Environment
+        environment = await client.environments.get_variables(environment_id)
+        for variable in environment.variables:
+            print(f"{variable.name}: {variable.value} (masked: {variable.masked})")
+        # [developer-docs.sdk.python.get-environment-variables]-end
+
 
 async def archive_item(client: Client, vault_id: str, item_id: str):
     # [developer-docs.sdk.python.archive-item]-start

src/onepassword/__init__.py

@@ -7,6 +7,7 @@
 from .secrets import Secrets
 from .items import Items
 from .vaults import Vaults
+from .environments import Environments
 from .groups import Groups
 
 
@@ -19,6 +20,7 @@
     "Secrets",
     "Items",
     "Vaults",
+    "Environments",
     "Groups",
     "DesktopAuth",
     "DEFAULT_INTEGRATION_NAME",

src/onepassword/client.py

@@ -8,13 +8,15 @@
 from .secrets import Secrets
 from .items import Items
 from .vaults import Vaults
+from .environments import Environments
 from .groups import Groups
 
 
 class Client:
     secrets: Secrets
     items: Items
     vaults: Vaults
+    environments: Environments
     groups: Groups
 
     @classmethod
@@ -41,6 +43,7 @@ async def authenticate(
         authenticated_client.secrets = Secrets(inner_client)
         authenticated_client.items = Items(inner_client)
         authenticated_client.vaults = Vaults(inner_client)
+        authenticated_client.environments = Environments(inner_client)
         authenticated_client.groups = Groups(inner_client)
         authenticated_client._finalizer = weakref.finalize(
             cls, core.release_client, client_id

src/onepassword/environments.py

@@ -0,0 +1,33 @@
+# Code generated by op-codegen - DO NO EDIT MANUALLY
+
+from .core import InnerClient
+from pydantic import TypeAdapter
+from .types import GetVariablesResponse
+
+
+class Environments:
+    """
+    The Environments API holds all the operations the SDK client can perform on 1Password Environments.
+    """
+
+    def __init__(self, inner_client: InnerClient):
+        self.inner_client = inner_client
+
+    async def get_variables(self, environment_id: str) -> GetVariablesResponse:
+        """
+        Get environment variables belonging to an Environment.
+        """
+        response = await self.inner_client.invoke(
+            {
+                "invocation": {
+                    "clientId": self.inner_client.client_id,
+                    "parameters": {
+                        "name": "EnvironmentsGetVariables",
+                        "parameters": {"environment_id": environment_id},
+                    },
+                }
+            }
+        )
+
+        response = TypeAdapter(GetVariablesResponse).validate_json(response)
+        return response