Go SDK Release v0.3.0 (#194)

* Update core to version e1f91a18

* update example code

* Release v0.3.0

* fix release notes

* fix release notes

* fix heading for breaking change

* add single ticks to function names and return types

* Apply suggestions from code review

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

* Update internal/release/RELEASE-NOTES

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

* remove extra newline and fix formatting

* delete iterator file

---------

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

Author: 3 people

example/main.go

@@ -6,7 +6,6 @@ import (
 	"crypto/rsa"
 	"crypto/x509"
 	"encoding/pem"
-	"errors"
 	"fmt"
 	"os"
 )
@@ -43,42 +42,48 @@ func main() {
 	resolveTOTPSecretReference(client, item.VaultID, item.ID, "TOTP_onetimepassword")
 	sharelink := generateItemSharing(client, item.VaultID, item.ID)
 	fmt.Println(sharelink)
+	archiveItem(client, item.VaultID, item.ID)
 	deleteItem(client, item.VaultID, item.ID)
 }
 
 func listVaultsAndItems(client *onepassword.Client, vaultID string) {
 	// [developer-docs.sdk.go.list-vaults]-start
-	vaults, err := client.Vaults().ListAll(context.Background())
+	vaults, err := client.Vaults().List(context.Background())
 	if err != nil {
 		panic(err)
 	}
-	for {
-		vault, err := vaults.Next()
-		if errors.Is(err, onepassword.ErrorIteratorDone) {
-			break
-		} else if err != nil {
-			panic(err)
-		}
-
+	for _, vault := range vaults {
 		fmt.Printf("%s %s\n", vault.ID, vault.Title)
 	}
 	// [developer-docs.sdk.go.list-vaults]-end
 
 	// [developer-docs.sdk.go.list-items]-start
-	items, err := client.Items().ListAll(context.Background(), vaultID)
+	overviews, err := client.Items().List(context.Background(), vaultID)
 	if err != nil {
 		panic(err)
 	}
-	for {
-		item, err := items.Next()
-		if errors.Is(err, onepassword.ErrorIteratorDone) {
-			break
-		} else if err != nil {
-			panic(err)
-		}
-		fmt.Printf("%s %s\n", item.ID, item.Title)
+	for _, overview := range overviews {
+		fmt.Printf("%s %s\n", overview.ID, overview.Title)
 	}
 	// [developer-docs.sdk.go.list-items]-end
+
+	// [developer-docs.sdk.go.use-item-filters]-start
+	archivedOverviews, err := client.Items().List(context.Background(), vaultID,
+		onepassword.NewItemListFilterTypeVariantByState(
+			&onepassword.ItemListFilterByStateInner{
+				Active:   false,
+				Archived: true,
+			},
+		),
+	)
+	if err != nil {
+		panic(err)
+	}
+	for _, overview := range archivedOverviews {
+		fmt.Printf("%s %s\n", overview.ID, overview.Title)
+	}
+	// [developer-docs.sdk.go.use-item-filters]-end
+
 }
 
 func getAndUpdateItem(client *onepassword.Client, existingVaultID, existingItemID string) {
@@ -140,9 +145,9 @@ func resolveBulkSecretReferences(client *onepassword.Client, vaultID, itemID, fi
 	// Retrieves multiple secrets from 1Password.
 	// Takes multiple secret references as input and returns the secret to which it points.
 	secret, _ := client.Secrets().ResolveAll(
-		context.Background(), 
+		context.Background(),
 		[]string{
-			fmt.Sprintf("op://%s/%s/%s", vaultID, itemID, fieldID), 
+			fmt.Sprintf("op://%s/%s/%s", vaultID, itemID, fieldID),
 			fmt.Sprintf("op://%s/%s/%s", vaultID, itemID, fieldID2),
 		},
 	)
@@ -290,11 +295,6 @@ func generatePasswords() {
 	// [developer-docs.sdk.go.generate-memorable-password]-end
 }
 
-// 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.
-//
-//lint:ignore U1000 NOTE: this is in a separate function to avoid creating a new item
 func archiveItem(client *onepassword.Client, vaultID string, itemID string) {
 	// [developer-docs.sdk.go.archive-item]-start
 	// Archive a item from your vault.
@@ -303,7 +303,6 @@ func archiveItem(client *onepassword.Client, vaultID string, itemID string) {
 	if err != nil {
 		panic(err)
 	}
-
 	// [developer-docs.sdk.go.archive-item]-end
 }
 

internal/release/RELEASE-NOTES

@@ -1,20 +1,90 @@
-# 1Password Go SDK v0.2.1
+# 1Password Go SDK v0.3.0
 
 ## NEW
 
-- **`CreatedAt` and `UpdatedAt` item metadata:** Items and item overviews now expose attributes with their creation and last edit times.
-- **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.
+- **Support for item states**: You can now fetch an item's state using the SDK. `ItemOverview` exposes one of two states: `Active` or `Archived`.
+    - `Active`: An item located inside a vault. (Default)
+    - `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.
+- **Filtering listed items by state**: You can now filter the results of the item list function by item state.
 
-## IMPROVED
+## FIXED
 
-- **Support for new field types:** Items with `Address` and `Date` fields can now be created, retrieved, and edited using the 1Password SDK.
-- **Item sharing for attachments and documents**: Items with files attached now can also be shared using the `client.Items().Shares()` functions.
-- **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.
-- **`Tags` in item overviews**: The return type of `Items().ListAll` now also contains the item tags.
-- **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.)
+- **Deleting Archived Items:** The SDK now supports deleting items from the archive.
 
-## FIXED
+## ⚠️ BREAKING CHANGES ⚠️
+This release contains breaking changes for two functions in the Go SDK.
+
+**Vault listing**
+
+* The function name has changed from `ListAll` to `List`. To use this in your code, replace:
+```go
+vaults, err := client.Vaults().ListAll(context.Background(), vaultID)
+// error handling
+```
+with:
+```go
+vaults, err := client.Vaults().List(context.Background(), vaultID)
+// error handling
+```
+
+* The return type of the vault listing function has changed from `*Iterator[VaultOverview]` to `[]VaultOverview`. To use this in your code, replace:
+
+```go
+for {
+	vault, err := vaults.Next()
+	if errors.Is(err, onepassword.ErrorIteratorDone) {
+		break
+	} else if err != nil {
+		// error handling
+	}
+	// using the vault overview
+}
+```
+with:
+```go
+for _, vault := range vaults {
+	// using the vault overview
+}
+```
+**Item listing**
+
+* The function name has changed from `ListAll` to `List`. To use this in your code, replace:
+```go
+overviews, err := client.Items().ListAll(context.Background())
+// error handling
+```
+with:
+```go
+overviews, err := client.Items().List(
+	context.Background(),
+	vaultID,
+	onepassword.NewItemListFilterTypeVariantByState(
+		&onepassword.ItemListFilterByStateInner{
+			Active:   true,
+			Archived: true,
+		},
+	),
+)
+// error handling
+```
+
+* The return type of the item listing function has changed from `*Iterator[ItemOverview]` to `[]ItemOverview`. To use this in your code, replace:
+```go
+for {
+	overview, err := overviews.Next()
+	if errors.Is(err, onepassword.ErrorIteratorDone) {
+		break
+	} else if err != nil {
+		// error handling
+	}
+	// using the item overview
+}
+```
+with:
+```go
+for _, overview := range overviews {
+	// using the item overview
+}
+```
 
-- **Improvements to resolving secret references:**
-    - Archived items are no longer used for secret references.
-    - When multiple sections match a section query in resolving secret references, the SDK look through the fields in all sections, instead of erroring.
+This does not affect any code that's already deployed, and will not take effect in your codebase until you choose to update to version 0.3.0 or later of the 1Password Go SDK.

internal/release/version

@@ -1 +1 @@
-0.2.1
+0.3.0

internal/release/version-build

@@ -1 +1 @@
-0020101
+0030001