Python SDK Release v0.3.0 (#170)

* Update core to version e1f91a18

* update example

* update release notes

* Release v0.3.0

* update release notes

* update iterator to pythons

* fix go SDK word

* Apply suggestions from code review

update release notes with stylistic edits

Co-authored-by: Lucy Butcher <[email protected]>

* fix migration guide

* Update src/release/RELEASE-NOTES

Co-authored-by: Lucy Butcher <[email protected]>

* delete iterator file

---------

Co-authored-by: 1PasswordSDKBot <[email protected]>
Co-authored-by: Lucy Butcher <[email protected]>

Author: 3 people

example/example.py

@@ -25,17 +25,26 @@ async def main():
     # [developer-docs.sdk.python.client-initialization]-end
 
     # [developer-docs.sdk.python.list-vaults]-start
-    vaults = await client.vaults.list_all()
-    async for vault in vaults:
+    vaults = await client.vaults.list()
+    for vault in vaults:
         print(vault.title)
     # [developer-docs.sdk.python.list-vaults]-end
 
     # [developer-docs.sdk.python.list-items]-start
-    items = await client.items.list_all(vault.id)
-    async for item in items:
-        print(item.title)
+    overviews = await client.items.list(vault.id)
+    for overview in overviews:
+        print(overview.title)
     # [developer-docs.sdk.python.list-items]-end
-
+    # [developer-docs.sdk.python.use-item-filters]-start
+    archived_overviews = await client.items.list(
+        vault.id,
+        ItemListFilterByState(
+            content=ItemListFilterByStateInner(active=False, archived=True)
+        ),
+    )
+    for overview in archived_overviews:
+        print(overview.title)
+        # [developer-docs.sdk.python.use-item-filters]-end
     # [developer-docs.sdk.python.validate-secret-reference]-start
     # Validate secret reference to ensure no syntax errors
     try:
@@ -175,24 +184,22 @@ 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)
+    await share_item(client, updated_item.vault_id, updated_item.id)
 
     await create_ssh_key_item(client, vault_id)
 
     await create_and_replace_document_item(client, vault_id)
 
     await create_attach_and_delete_file_field_item(client, vault_id)
 
+    await archive_item(client, updated_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.

src/onepassword/build_number.py

@@ -1 +1 @@
-SDK_BUILD_NUMBER = "0020101"
+SDK_BUILD_NUMBER = "0030001"

src/onepassword/items.py

@@ -1,12 +1,11 @@
 # Code generated by op-codegen - DO NO EDIT MANUALLY
 
 from .core import _invoke, _invoke_sync
-from .iterator import SDKIterator
 from typing import Optional, List
 from pydantic import TypeAdapter
 from .items_shares import ItemsShares
 from .items_files import ItemsFiles
-from .types import Item, ItemCreateParams, ItemOverview
+from .types import Item, ItemCreateParams, ItemListFilter, ItemOverview
 
 
 class Items:
@@ -113,21 +112,24 @@ async def archive(self, vault_id: str, item_id: str) -> None:
 
         return None
 
-    async def list_all(self, vault_id: str) -> SDKIterator[ItemOverview]:
+    async def list(self, vault_id: str, *filters: ItemListFilter) -> List[ItemOverview]:
         """
-        List all items
+        List items based on filters.
         """
         response = await _invoke(
             {
                 "invocation": {
                     "clientId": self.client_id,
                     "parameters": {
-                        "name": "ItemsListAll",
-                        "parameters": {"vault_id": vault_id},
+                        "name": "ItemsList",
+                        "parameters": {
+                            "vault_id": vault_id,
+                            "filters": [o.model_dump(by_alias=True) for o in filters],
+                        },
                     },
                 }
             }
         )
 
         response = TypeAdapter(List[ItemOverview]).validate_json(response)
-        return SDKIterator(response)
+        return response

src/onepassword/items_files.py

@@ -1,7 +1,6 @@
 # Code generated by op-codegen - DO NO EDIT MANUALLY
 
 from .core import _invoke, _invoke_sync
-from .iterator import SDKIterator
 from typing import Optional, List
 from pydantic import TypeAdapter
 from .types import DocumentCreateParams, FileAttributes, FileCreateParams, Item

src/onepassword/items_shares.py

@@ -1,7 +1,6 @@
 # Code generated by op-codegen - DO NO EDIT MANUALLY
 
 from .core import _invoke, _invoke_sync
-from .iterator import SDKIterator
 from typing import Optional, List
 from pydantic import TypeAdapter
 from .types import Item, ItemShareAccountPolicy, ItemShareParams, ValidRecipient