Skip to content

Commit cf0c70a

Browse files
committed
update release notes
1 parent 78a183e commit cf0c70a

File tree

1 file changed

+50
-13
lines changed

1 file changed

+50
-13
lines changed

src/release/RELEASE-NOTES

Lines changed: 50 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,57 @@
1-
# 1Password Python SDK v0.2.1
1+
# 1Password Python SDK v0.3.0
22

33
## NEW
44

5-
- **`CreatedAt` and `UpdatedAt` item metadata:** Items and item overviews now expose attributes with their creation and last edit times.
6-
- **Resolving secrets in bulk**: With the `client.secrets.resolveAll` function, the SDK is now able to resolve multiple secrets at once, improving the performance of the operation.
5+
- **Support for item states**: You can now fetch an item's state using the SDK.`ItemOverview` exposes one of two states: `Active` or `Archived`.
6+
- `Active`: An item located inside a vault. (Default)
7+
- `Archived`: An item that has been moved to the Archive. 1Password doesn't include archived items in search results or suggest them when you fill in apps and browsers. You can keep archived items as long as you'd like.
8+
- **Filtering the return of item listing by state**: You can now filter the listed items by item state.
79

8-
## IMPROVED
10+
## FIXED
911

10-
- **Support for new field types:** Items with `Address` and `Date` fields can now be created, retrieved, and edited using the 1Password SDK.
11-
- **Item sharing for attachments and documents**: Items with files attached now can also be shared using the `client.items.shares` functions.
12-
- **Adding custom fields in sections automatically**: The SDK now automatically adds custom fields without a section to an empty section within the item, creating it if necessary.
13-
- **`Tags` in item overviews**: The return type of `items.listAll` now also contains the item tags.
14-
- **Broader item editing capabilities**: You are now able to use the `items.put` function on more items, including those with fields that are not directly editable through the SDK (such as legacy fields, passkeys etc.)
12+
- **Deleting Archived Items:** The SDK now supports deleting items from the archive.
1513

16-
## FIXED
14+
### ⚠️ BREAKING CHANGES ⚠️
15+
16+
This release contains a breaking change for the Python SDK.
17+
18+
`items.list_all()` has changed to `items.list()` and the return type has also changed from SDKIterator[ItemOverview] to List[ItemOverview]. To migrate to the latest SDK version:
19+
20+
Wherever you were using:
21+
```python
22+
overviews = await client.items.list_all(vault_id)
23+
24+
async for overview in overviews:
25+
print(overview.ID)
26+
```
27+
28+
You must now use:
29+
30+
```python
31+
overviews = await client.items.list(vault_id, ItemListFilter(
32+
content=ItemListFilterByStateInner(
33+
active=active,
34+
archived=archived
35+
)
36+
))
37+
38+
for overview in overviews:
39+
print(overview.ID)
40+
```
41+
`vaults.list_all()` has changed to `vaults.list()` nd the return type has also changed from SDKIterator[VaultOverview] to List[VaultOverview]. To migrate to the latest SDK version:
42+
43+
Wherever you were using:
44+
```python
45+
vaults = await client.vaults.list_all()
46+
async for vault in vaults:
47+
print(vault.title)
48+
```
49+
50+
You must now use:
51+
```python
52+
vaults = await client.vaults.list()
53+
for vault in vaults:
54+
print(vault.title)
55+
```
1756

18-
- **Improvements to resolving secret references:**
19-
- Archived items are no longer used for secret references.
20-
- When multiple sections match a section query in resolving secret references, the SDK look through the fields in all sections, instead of erroring.
57+
This does not affect any code that's already deployed, and will not take effect in your codebase until updating to v0.3.0+ of the 1Password Python SDK.

0 commit comments

Comments
 (0)