Merge pull request #78 from 1Password/sdk-core/2024-07-26-384c9aa2

SDK core 384c9aa2

Author: hculea

example/example.py

@@ -2,6 +2,7 @@
 import os
 from onepassword import *
 
+
 async def main():
     # Gets your service account token from the OP_SERVICE_ACCOUNT_TOKEN environment variable.
     token = os.getenv("OP_SERVICE_ACCOUNT_TOKEN")
@@ -19,8 +20,7 @@ async def main():
     print(value)
 
     # Create an Item and add it to your vault.
-    to_create = Item(
-        id="",
+    to_create = ItemCreateParams(
         title="MyName",
         category="Login",
         vault_id="q73bqltug6xoegr3wkk2zkenoq",
@@ -31,29 +31,48 @@ async def main():
                 field_type="Text",
                 section_id=None,
                 value="mynameisjeff",
+                details=None,
             ),
             ItemField(
                 id="password",
                 title="password",
                 field_type="Concealed",
                 section_id=None,
                 value="jeff",
+                details=None,
+            ),
+            ItemField(
+                id="onetimepassword",
+                title="one-time-password",
+                field_type="Totp",
+                section_id="totpsection",
+                value="otpauth://totp/my-example-otp?secret=jncrjgbdjnrncbjsr&issuer=1Password",
+                details=None,
             ),
         ],
-        sections=[ItemSection(id="", title="")],
+        sections=[ItemSection(id="", title=""), ItemSection(id="totpsection", title="")],
     )
     created_item = await client.items.create(to_create)
 
     print(dict(created_item))
 
+    # Fetch a totp code from the item
+    for f in created_item.fields:
+        if f.field_type == "Totp":
+            if f.details.content.error_message is not None:
+                print(f.details.content.error_message)
+            else:
+                print(f.details.content.code)
+
+    
     # Retrieve an item from your vault.
     item = await client.items.get(created_item.vault_id, created_item.id)
 
     print(dict(item))
 
     # Update a field in your item
     item.fields[0].value = "new_value"
-    updated_item = await client.items.update(item)
+    updated_item = await client.items.put(item)
 
     print(dict(updated_item))
 

setup.py

@@ -31,7 +31,7 @@ def get_shared_library_data_to_include():
     platform_to_lib = {
         "Darwin": "libop_uniffi_core.dylib",
         "Linux": "libop_uniffi_core.so",
-        "Windows": "op_uniffi_core.dll"
+        "Windows": "op_uniffi_core.dll",
     }
     c_shared_library_file_name = platform_to_lib.get(platform.system(), "")
     c_shared_library_file_name = os.path.join(include_path, c_shared_library_file_name)

src/onepassword/__init__.py

@@ -1,11 +1,12 @@
 # AUTO-GENERATED
 from .client import Client
 from .defaults import DEFAULT_INTEGRATION_NAME, DEFAULT_INTEGRATION_VERSION
-from .types import * # noqa F403
+from .types import *  # noqa F403
 from .secrets import Secrets
 from .items import Items
 
-import sys 
+
+import sys
 import inspect
 import typing
 
@@ -19,5 +20,8 @@
 
 for name, obj in inspect.getmembers(sys.modules["onepassword.types"]):
     # Add all classes and instances of typing.Literal defined in types.py.
-    if (inspect.isclass(obj) and inspect.getmodule(obj) == sys.modules["onepassword.types"]) or type(eval(name)) == typing._LiteralGenericAlias:
+    if (
+        inspect.isclass(obj)
+        and inspect.getmodule(obj) == sys.modules["onepassword.types"]
+    ) or type(eval(name)) == typing._LiteralGenericAlias:
         __all__.append(name)

src/onepassword/client.py

@@ -7,23 +7,24 @@
 
 
 class Client:
-	secrets: Secrets
-	items: Items
-	
+    secrets: Secrets
+    items: Items
 
-	@classmethod
-	async def authenticate(cls, auth, integration_name, integration_version):
-		config = new_default_config(
-			auth=auth,
-			integration_name=integration_name,
-			integration_version=integration_version,
-		)
-		client_id = int(await _init_client(config))
+    @classmethod
+    async def authenticate(cls, auth, integration_name, integration_version):
+        config = new_default_config(
+            auth=auth,
+            integration_name=integration_name,
+            integration_version=integration_version,
+        )
+        client_id = int(await _init_client(config))
 
-		authenticated_client = cls()
+        authenticated_client = cls()
 
-		authenticated_client.secrets = Secrets(client_id)
-		authenticated_client.items = Items(client_id)
-		authenticated_client._finalizer = weakref.finalize(cls, _release_client, client_id)
+        authenticated_client.secrets = Secrets(client_id)
+        authenticated_client.items = Items(client_id)
+        authenticated_client._finalizer = weakref.finalize(
+            cls, _release_client, client_id
+        )
 
-		return authenticated_client
+        return authenticated_client

src/onepassword/core.py

@@ -9,7 +9,9 @@
 elif machine_arch in ["aarch64", "arm64"]:
     import onepassword.lib.aarch64.op_uniffi_core as core
 else:
-    raise ImportError(f"Your machine's architecture is not currently supported: {machine_arch}")
+    raise ImportError(
+        f"Your machine's architecture is not currently supported: {machine_arch}"
+    )
 
 
 # InitClient creates a client instance in the current core module and returns its unique ID.

src/onepassword/defaults.py

@@ -2,7 +2,7 @@
 from src.release.version import SDK_BUILD_NUMBER
 
 SDK_LANGUAGE = "Python"
-SDK_VERSION = SDK_BUILD_NUMBER 
+SDK_VERSION = SDK_BUILD_NUMBER
 DEFAULT_INTEGRATION_NAME = "Unknown"
 DEFAULT_INTEGRATION_VERSION = "Unknown"
 DEFAULT_REQUEST_LIBRARY = "net/http"

src/onepassword/items.py

@@ -1,32 +1,38 @@
+# AUTO-GENERATED
 from .core import _invoke
-import json
+from json import loads
 from .types import Item
 
 
 class Items:
-    """Contains all operations the SDK client can perform on 1Password items."""
+    """
+    The Items API holds all operations the SDK client can perform on 1Password items.
+    """
 
     def __init__(self, client_id):
         self.client_id = client_id
 
-    async def create(self, item):
-        """Create a new item"""
+    async def create(self, params):
+        """
+        Create a new item
+        """
         response = await _invoke(
             {
                 "clientId": self.client_id,
                 "invocation": {
                     "name": "Create",
                     "parameters": {
-                        "item": item.dict(),
+                        "params": params.dict(),
                     },
                 },
             }
         )
-        result = Item(**json.loads(response))
-        return result
+        return Item(**loads(response))
 
     async def get(self, vault_id, item_id):
-        """Get an item by vault and item ID"""
+        """
+        Get an item by vault and item ID
+        """
         response = await _invoke(
             {
                 "clientId": self.client_id,
@@ -39,27 +45,30 @@ async def get(self, vault_id, item_id):
                 },
             }
         )
-        result = Item(**json.loads(response))
-        return result
+        return Item(**loads(response))
 
-    async def update(self, item):
-        """Update an existing item. You can currently only edit text and concealed fields."""
+    async def put(self, item):
+        """
+        Update an existing item.
+        """
         response = await _invoke(
             {
                 "clientId": self.client_id,
                 "invocation": {
-                    "name": "Update",
+                    "name": "Put",
                     "parameters": {
                         "item": item.dict(),
                     },
                 },
             }
         )
-        result = Item(**json.loads(response))
-        return result
+        return Item(**loads(response))
 
     async def delete(self, vault_id, item_id):
-        """Delete an item. """
+        """
+        Delete an item.
+        """
+
         await _invoke(
             {
                 "clientId": self.client_id,