Migrating to 1Password SDK v0.3.0
Version v0.3.0 introduces 4 breaking changes. This guide details how to update your code.
Released: 4/23/2025
⚠️ Check Your Code
If you use any of these symbols, you need to read this guide:
client.vaults.list_allclient.vaults.listSDKIterator[VaultOverview]List[VaultOverview]client.items.list_allclient.items.listItemListFilterItemListFilterByStateInnerSDKIterator[ItemOverview]List[ItemOverview]ItemOverviewBreaking Changes
●Issue #1
The vault listing function name changed from `list_all` to `list`. Replace `await client.vaults.list_all(vault_id)` with `await client.vaults.list(vault_id)`.
●Issue #2
The return type of the vault listing function changed from `SDKIterator[VaultOverview]` to `List[VaultOverview]`. Replace async iteration with standard iteration over the result.
●Issue #3
The item listing function name changed from `ListAll` to `List`. Replace `await client.items.list_all(vault_id)` with `await client.items.list(vault_id, ItemListFilter(...))`.
●Issue #4
The return type of the item listing function changed from `SDKIterator[ItemOverview]` to `List[ItemOverview]`. Replace async iteration with standard iteration over the result.
Migration Steps
- 1If using vault listing, rename calls from `list_all` to `list`.
- 2If using vault listing, update iteration from `async for` to standard `for` loop over the returned list.
- 3If using item listing, rename calls from `ListAll` to `List` and update arguments to include filtering parameters if necessary.
- 4If using item listing, update iteration from `async for` to standard `for` loop over the returned list.
Release Summary
Version 0.3.0 introduces support for item states and filtering, alongside several breaking changes to vault and item listing functions, renaming them and changing their return types from iterators to lists.
Need More Details?
View the full release notes and all changes for 1Password SDK v0.3.0.
View Full Changelog