●Change8

v0.3.0

Breaking Changes
📦 1password-sdk
⚠ 4 breaking✨ 2 features🐛 1 fixes🔧 11 symbols

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.

⚠️ Breaking Changes

  • 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)`.
  • The return type of the vault listing function changed from `SDKIterator[VaultOverview]` to `List[VaultOverview]`. Replace async iteration with standard iteration over the result.
  • 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(...))`.
  • 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

  1. If using vault listing, rename calls from `list_all` to `list`.
  2. If using vault listing, update iteration from `async for` to standard `for` loop over the returned list.
  3. If using item listing, rename calls from `ListAll` to `List` and update arguments to include filtering parameters if necessary.
  4. If using item listing, update iteration from `async for` to standard `for` loop over the returned list.

✨ New Features

  • Support for fetching an item's state via `ItemOverview`, which exposes `Active` or `Archived` states.
  • Ability to filter item list results by item state.

🐛 Bug Fixes

  • The SDK now supports deleting items from the archive.

🔧 Affected Symbols

client.vaults.list_allclient.vaults.listSDKIterator[VaultOverview]List[VaultOverview]client.items.list_allclient.items.listItemListFilterItemListFilterByStateInnerSDKIterator[ItemOverview]List[ItemOverview]ItemOverview