Merge pull request #145 from 1Password/sdk-core/2025-01-09-571dd93f

Python SDK 0.1.6 RC

Author: hculea

README.md

@@ -87,24 +87,28 @@ Operations:
 - [x] [Create items](https://developer.1password.com/docs/sdks/manage-items#create-an-item)
 - [x] [Update items](https://developer.1password.com/docs/sdks/manage-items#update-an-item)
 - [x] [Delete items](https://developer.1password.com/docs/sdks/manage-items#delete-an-item)
+- [x] Archive items
 - [x] [List items](https://developer.1password.com/docs/sdks/list-vaults-items/)
-- [x] Add & update tags on items
+- [x] Share items
 - [x] Generate PIN, random and memorable passwords
 
 Field types:
 - [x] API Keys
 - [x] Passwords
 - [x] Concealed fields
 - [x] Text fields
-- [ ] Notes
-- [x] SSH private keys (partially supported: supported in resolving secret references, not yet supported in item create/get/update)
-- [ ] SSH public keys, fingerprint and key type
+- [x] Notes
+- [x] SSH private keys, public keys, fingerprint and key type (partially supported: supported in resolving secret references, not yet supported in item create/get/update)
 - [x] One-time passwords
 - [x] URLs
 - [x] Websites (used to suggest and autofill logins)
 - [x] Phone numbers
 - [x] Credit card types
 - [x] Credit card numbers
+- [x] Emails
+- [x] References to other items
+- [ ] Address
+- [ ] Date / MM/YY
 - [ ] Files attachments and Document items
 
 ### Vault management

example/example.py

@@ -165,11 +165,56 @@ async def main():
     print(random_password)
     # [developer-docs.sdk.python.generate-random-password]-end
 
+    await share_item(client, created_item.vault_id, updated_item.id)
+
     # [developer-docs.sdk.python.delete-item]-start
     # Delete a item from your vault.
     await client.items.delete(created_item.vault_id, updated_item.id)
     # [developer-docs.sdk.python.delete-item]-end
 
+## NOTE: this is in a separate function to avoid creating a new item
+## NOTE: just for the sake of archiving it. This is because the SDK
+## NOTE: only works with active items, so archiving and then deleting
+## NOTE: is not yet possible.
+async def archive_item(client: Client, vault_id: str, item_id: str):
+    # [developer-docs.sdk.python.archive-item]-start
+    # Archive a item from your vault.
+    await client.items.archive(vault_id, item_id)
+    # [developer-docs.sdk.python.archive-item]-end
+
+
+async def share_item(client: Client, vault_id: str, item_id: str):
+    # [developer-docs.sdk.python.item-share-get-item]-start
+    item = await client.items.get(vault_id, item_id)
+    print(item)
+    # [developer-docs.sdk.python.item-share-get-item]-end
+
+    # [developer-docs.sdk.python.item-share-get-account-policy]-start
+    policy = await client.items.shares.get_account_policy(item.vault_id, item.id)
+    print(policy)
+    # [developer-docs.sdk.python.item-share-get-account-policy]-end
+
+    # [developer-docs.sdk.python.item-share-validate-recipients]-start
+    valid_recipients = await client.items.shares.validate_recipients(
+        policy, ["agilebits.com"]
+    )
+
+    print(valid_recipients)
+    # [developer-docs.sdk.python.item-share-validate-recipients]-end
+
+    # [developer-docs.sdk.python.item-share-create-share]-start
+    share_link = await client.items.shares.create(
+        item,
+        policy,
+        ItemShareParams(
+            recipients = valid_recipients,
+            expireAfter= ItemShareDuration.ONEHOUR,
+            oneTimeOnly= False,
+        ),
+    )
+
+    print(share_link)
+    # [developer-docs.sdk.python.item-share-create-share]-end
 
 if __name__ == "__main__":
     asyncio.run(main())

src/onepassword/__init__.py

@@ -24,7 +24,11 @@
 for name, obj in inspect.getmembers(sys.modules["onepassword.types"]):
     # Add all classes and instances of typing.Literal defined in types.py.
     if (
-        inspect.isclass(obj)
-        and inspect.getmodule(obj) == sys.modules["onepassword.types"]
-    ) or type(eval(name)) == typing._LiteralGenericAlias:
+        (
+            inspect.isclass(obj)
+            and inspect.getmodule(obj) == sys.modules["onepassword.types"]
+        )
+        or isinstance(obj, int)
+        or type(obj) == typing._LiteralGenericAlias
+    ):
         __all__.append(name)

src/onepassword/build_number.py

@@ -1 +1 @@
-SDK_BUILD_NUMBER = "0010501"
+SDK_BUILD_NUMBER = "0010601"

src/onepassword/client.py

@@ -1,5 +1,6 @@
 # Code generated by op-codegen - DO NO EDIT MANUALLY
 
+from __future__ import annotations
 import weakref
 from .core import _init_client, _release_client
 from .defaults import new_default_config
@@ -14,7 +15,9 @@ class Client:
     vaults: Vaults
 
     @classmethod
-    async def authenticate(cls, auth, integration_name, integration_version):
+    async def authenticate(
+        cls, auth: str, integration_name: str, integration_version: str
+    ) -> Client:
         config = new_default_config(
             auth=auth or "",
             integration_name=integration_name,

src/onepassword/items.py

@@ -1,9 +1,10 @@
 # Code generated by op-codegen - DO NO EDIT MANUALLY
 
-from .core import _invoke, _invoke_sync
-from json import loads
+from .core import _invoke
 from .iterator import SDKIterator
-from .types import Item, ItemOverview
+from pydantic import TypeAdapter
+from .items_shares import ItemsShares
+from .types import Item, ItemCreateParams, ItemOverview
 
 
 class Items:
@@ -13,10 +14,11 @@ class Items:
 
     def __init__(self, client_id):
         self.client_id = client_id
+        self.shares = ItemsShares(client_id)
 
-    async def create(self, params):
+    async def create(self, params: ItemCreateParams) -> Item:
         """
-        Create a new item
+        Create a new item.
         """
         response = await _invoke(
             {
@@ -29,9 +31,11 @@ async def create(self, params):
                 }
             }
         )
-        return Item.model_validate_json(response)
 
-    async def get(self, vault_id, item_id):
+        response = TypeAdapter(Item).validate_json(response)
+        return response
+
+    async def get(self, vault_id: str, item_id: str) -> Item:
         """
         Get an item by vault and item ID
         """
@@ -46,9 +50,11 @@ async def get(self, vault_id, item_id):
                 }
             }
         )
-        return Item.model_validate_json(response)
 
-    async def put(self, item):
+        response = TypeAdapter(Item).validate_json(response)
+        return response
+
+    async def put(self, item: Item) -> Item:
         """
         Update an existing item.
         """
@@ -63,13 +69,15 @@ async def put(self, item):
                 }
             }
         )
-        return Item.model_validate_json(response)
 
-    async def delete(self, vault_id, item_id):
+        response = TypeAdapter(Item).validate_json(response)
+        return response
+
+    async def delete(self, vault_id: str, item_id: str):
         """
         Delete an item.
         """
-        await _invoke(
+        response = await _invoke(
             {
                 "invocation": {
                     "clientId": self.client_id,
@@ -81,7 +89,27 @@ async def delete(self, vault_id, item_id):
             }
         )
 
-    async def list_all(self, vault_id):
+        return None
+
+    async def archive(self, vault_id: str, item_id: str):
+        """
+        Archive an item.
+        """
+        response = await _invoke(
+            {
+                "invocation": {
+                    "clientId": self.client_id,
+                    "parameters": {
+                        "name": "ItemsArchive",
+                        "parameters": {"vault_id": vault_id, "item_id": item_id},
+                    },
+                }
+            }
+        )
+
+        return None
+
+    async def list_all(self, vault_id: str) -> SDKIterator[ItemOverview]:
         """
         List all items
         """
@@ -97,8 +125,5 @@ async def list_all(self, vault_id):
             }
         )
 
-        response_data = loads(response)
-
-        objects = [ItemOverview.model_validate(data) for data in response_data]
-
-        return SDKIterator(objects)
+        response = TypeAdapter(list[ItemOverview]).validate_json(response)
+        return SDKIterator(response)

src/onepassword/items_shares.py

@@ -0,0 +1,80 @@
+# Code generated by op-codegen - DO NO EDIT MANUALLY
+
+from .core import _invoke
+from pydantic import TypeAdapter
+from .types import Item, ItemShareAccountPolicy, ItemShareParams, ValidRecipient
+
+
+class ItemsShares:
+    def __init__(self, client_id):
+        self.client_id = client_id
+
+    async def get_account_policy(
+        self, vault_id: str, item_id: str
+    ) -> ItemShareAccountPolicy:
+        """
+        Get the item sharing policy of your account.
+        """
+        response = await _invoke(
+            {
+                "invocation": {
+                    "clientId": self.client_id,
+                    "parameters": {
+                        "name": "ItemsSharesGetAccountPolicy",
+                        "parameters": {"vault_id": vault_id, "item_id": item_id},
+                    },
+                }
+            }
+        )
+
+        response = TypeAdapter(ItemShareAccountPolicy).validate_json(response)
+        return response
+
+    async def validate_recipients(
+        self, policy: ItemShareAccountPolicy, recipients: list[str]
+    ) -> list[ValidRecipient]:
+        """
+        Validate the recipients of an item sharing link.
+        """
+        response = await _invoke(
+            {
+                "invocation": {
+                    "clientId": self.client_id,
+                    "parameters": {
+                        "name": "ItemsSharesValidateRecipients",
+                        "parameters": {
+                            "policy": policy.model_dump(by_alias=True),
+                            "recipients": recipients,
+                        },
+                    },
+                }
+            }
+        )
+
+        response = TypeAdapter(list[ValidRecipient]).validate_json(response)
+        return response
+
+    async def create(
+        self, item: Item, policy: ItemShareAccountPolicy, params: ItemShareParams
+    ) -> str:
+        """
+        Create a new item sharing link.
+        """
+        response = await _invoke(
+            {
+                "invocation": {
+                    "clientId": self.client_id,
+                    "parameters": {
+                        "name": "ItemsSharesCreate",
+                        "parameters": {
+                            "item": item.model_dump(by_alias=True),
+                            "policy": policy.model_dump(by_alias=True),
+                            "params": params.model_dump(by_alias=True),
+                        },
+                    },
+                }
+            }
+        )
+
+        response = TypeAdapter(str).validate_json(response)
+        return response