Skip to content

Commit fae14f2

Browse files
committed
update release notes
1 parent e322118 commit fae14f2

File tree

1 file changed

+47
-13
lines changed

1 file changed

+47
-13
lines changed

src/release/RELEASE-NOTES

Lines changed: 47 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,55 @@
1-
:wq
2-
# 1Password Python SDK v0.2.1
1+
# 1Password Python SDK v0.3.0
32

43
## NEW
54

6-
- **`CreatedAt` and `UpdatedAt` item metadata:** Items and item overviews now expose attributes with their creation and last edit times.
7-
- **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. `Item` and `ItemOverview` expose two states: `Active` and`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. The current exposed filter is `ByState`, which allows devs to filter `ItemOverviews` by their `State` .
89

910
## IMPROVED
1011

11-
- **Support for new field types:** Items with `Address` and `Date` fields can now be created, retrieved, and edited using the 1Password SDK.
12-
- **Item sharing for attachments and documents**: Items with files attached now can also be shared using the `client.items.shares` functions.
13-
- **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.
14-
- **`Tags` in item overviews**: The return type of `items.listAll` now also contains the item tags.
15-
- **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+
- **Improved Deleting Capabilities:** You can now delete `Archived` items in the SDKs.
1613

17-
## FIXED
14+
### ⚠️ BREAKING CHANGES ⚠️
1815

19-
- **Improvements to resolving secret references:**
20-
- Archived items are no longer used for secret references.
21-
- When multiple sections match a section query in resolving secret references, the SDK look through the fields in all sections, instead of erroring.
16+
This release contains a breaking change for the Go SDK.
17+
18+
`items.list_all()` has changed to `items.list()` and below is how to migrate.
19+
20+
Before:
21+
```python
22+
overviews = await client.items.list_all(vault_id)
23+
# To iterate through this you can do the following:
24+
async for overview in overviews:
25+
print(overview.ID)
26+
```
27+
28+
After:
29+
30+
```python
31+
overviews = await client.items.list(vault_id, ItemListFilter(
32+
content=ItemListFilterByStateInner(
33+
active=active,
34+
archived=archived
35+
)
36+
))
37+
# to iterate through it you can do the following:
38+
for overview in overviews:
39+
print(overview.ID)
40+
```
41+
`vaults.list_all()` has changed to `vaults.list()` and the migration guide is below:
42+
43+
Before:
44+
```python
45+
vaults = await client.vaults.list_all()
46+
async for vault in vaults:
47+
print(vault.title)
48+
```
49+
50+
After:
51+
```python
52+
vaults = await client.vaults.list()
53+
for vault in vaults:
54+
print(vault.title)
55+
```

0 commit comments

Comments
 (0)