feat: Preserve credential field order

Stainless-Generated-From: 0df566e7c79bb73166acc226effc1c9f331264be

Author: kernel-internal[bot]

src/kernel/resources/vaults/items.py

@@ -757,7 +757,9 @@ def upsert(
         Args:
           spec: Credential fields are for login and other non-payment credentials. Do not store,
               collect, or fill credit card data in credential items. Use wallet and card item
-              types for credit cards and payment checkout instead.
+              types for credit cards and payment checkout instead. Field order is preserved in
+              the user-facing collection form, so list fields in the same top-to-bottom order
+              as the website.
 
           extra_headers: Send extra headers
 
@@ -1528,7 +1530,9 @@ async def upsert(
         Args:
           spec: Credential fields are for login and other non-payment credentials. Do not store,
               collect, or fill credit card data in credential items. Use wallet and card item
-              types for credit cards and payment checkout instead.
+              types for credit cards and payment checkout instead. Field order is preserved in
+              the user-facing collection form, so list fields in the same top-to-bottom order
+              as the website.
 
           extra_headers: Send extra headers
 

src/kernel/types/vaults/credential_vault_field_definition.py

@@ -7,6 +7,9 @@
 
 
 class CredentialVaultFieldDefinition(BaseModel):
+    name: str
+    """Stable field name used to key values, updates, and browser fills."""
+
     required: bool
     """Whether a nonempty value is required for readiness and form submission."""
 

src/kernel/types/vaults/credential_vault_field_input_param.py

@@ -10,6 +10,9 @@
 
 
 class CredentialVaultFieldInputParam(TypedDict, total=False):
+    name: Required[str]
+    """Unique stable field name used to key values, updates, and browser fills."""
+
     type: Required[CredentialVaultFieldType]
     """
     Text, email, and password have form inputs; totp does not and is omitted from

src/kernel/types/vaults/credential_vault_item_request_param.py

@@ -30,7 +30,9 @@ class CredentialVaultItemRequestParam(TypedDict, total=False):
     """Credential fields are for login and other non-payment credentials.
 
     Do not store, collect, or fill credit card data in credential items. Use wallet
-    and card item types for credit cards and payment checkout instead.
+    and card item types for credit cards and payment checkout instead. Field order
+    is preserved in the user-facing collection form, so list fields in the same
+    top-to-bottom order as the website.
     """
 
     type: Required[Literal["credential"]]

src/kernel/types/vaults/credential_vault_item_spec.py

@@ -1,6 +1,6 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-from typing import Dict, Optional
+from typing import List, Optional
 
 from ..._models import BaseModel
 from .credential_vault_field_definition import CredentialVaultFieldDefinition
@@ -9,7 +9,10 @@
 
 
 class CredentialVaultItemSpec(BaseModel):
-    fields: Dict[str, CredentialVaultFieldDefinition]
+    fields: List[CredentialVaultFieldDefinition]
+    """
+    Ordered field definitions rendered in this order by credential collection forms.
+    """
 
     description: Optional[str] = None
     """

src/kernel/types/vaults/credential_vault_item_spec_input_param.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import Dict
+from typing import Iterable
 from typing_extensions import Required, TypedDict
 
 from .credential_vault_field_input_param import CredentialVaultFieldInputParam
@@ -13,10 +13,15 @@
 class CredentialVaultItemSpecInputParam(TypedDict, total=False):
     """Credential fields are for login and other non-payment credentials.
 
-    Do not store, collect, or fill credit card data in credential items. Use wallet and card item types for credit cards and payment checkout instead.
+    Do not store, collect, or fill credit card data in credential items. Use wallet and card item types for credit cards and payment checkout instead. Field order is preserved in the user-facing collection form, so list fields in the same top-to-bottom order as the website.
     """
 
-    fields: Required[Dict[str, CredentialVaultFieldInputParam]]
+    fields: Required[Iterable[CredentialVaultFieldInputParam]]
+    """Ordered field definitions.
+
+    Use the website's top-to-bottom field order; the collection form renders this
+    order unchanged.
+    """
 
     description: str
     """

src/kernel/types/vaults/item_upsert_params.py

@@ -194,7 +194,9 @@ class CredentialVaultItemRequest(TypedDict, total=False):
     """Credential fields are for login and other non-payment credentials.
 
     Do not store, collect, or fill credit card data in credential items. Use wallet
-    and card item types for credit cards and payment checkout instead.
+    and card item types for credit cards and payment checkout instead. Field order
+    is preserved in the user-facing collection form, so list fields in the same
+    top-to-bottom order as the website.
     """
 
     type: Required[Literal["credential"]]

tests/api_resources/vaults/test_items.py

@@ -1144,7 +1144,14 @@ def test_method_upsert_overload_3(self, client: Kernel) -> None:
         item = client.vaults.items.upsert(
             key="x",
             id_or_name="id_or_name",
-            spec={"fields": {"foo": {"type": "text"}}},
+            spec={
+                "fields": [
+                    {
+                        "name": "name",
+                        "type": "text",
+                    }
+                ]
+            },
             type="credential",
         )
         assert_matches_type(VaultItem, item, path=["response"])
@@ -1156,14 +1163,15 @@ def test_method_upsert_with_all_params_overload_3(self, client: Kernel) -> None:
             key="x",
             id_or_name="id_or_name",
             spec={
-                "fields": {
-                    "foo": {
+                "fields": [
+                    {
+                        "name": "name",
                         "type": "text",
                         "required": True,
                         "sensitive": True,
                         "value": "x",
                     }
-                },
+                ],
                 "description": "description",
             },
             type="credential",
@@ -1176,7 +1184,14 @@ def test_raw_response_upsert_overload_3(self, client: Kernel) -> None:
         response = client.vaults.items.with_raw_response.upsert(
             key="x",
             id_or_name="id_or_name",
-            spec={"fields": {"foo": {"type": "text"}}},
+            spec={
+                "fields": [
+                    {
+                        "name": "name",
+                        "type": "text",
+                    }
+                ]
+            },
             type="credential",
         )
 
@@ -1191,7 +1206,14 @@ def test_streaming_response_upsert_overload_3(self, client: Kernel) -> None:
         with client.vaults.items.with_streaming_response.upsert(
             key="x",
             id_or_name="id_or_name",
-            spec={"fields": {"foo": {"type": "text"}}},
+            spec={
+                "fields": [
+                    {
+                        "name": "name",
+                        "type": "text",
+                    }
+                ]
+            },
             type="credential",
         ) as response:
             assert not response.is_closed
@@ -1209,15 +1231,29 @@ def test_path_params_upsert_overload_3(self, client: Kernel) -> None:
             client.vaults.items.with_raw_response.upsert(
                 key="x",
                 id_or_name="",
-                spec={"fields": {"foo": {"type": "text"}}},
+                spec={
+                    "fields": [
+                        {
+                            "name": "name",
+                            "type": "text",
+                        }
+                    ]
+                },
                 type="credential",
             )
 
         with pytest.raises(ValueError, match=r"Expected a non-empty value for `key` but received ''"):
             client.vaults.items.with_raw_response.upsert(
                 key="",
                 id_or_name="id_or_name",
-                spec={"fields": {"foo": {"type": "text"}}},
+                spec={
+                    "fields": [
+                        {
+                            "name": "name",
+                            "type": "text",
+                        }
+                    ]
+                },
                 type="credential",
             )
 
@@ -2349,7 +2385,14 @@ async def test_method_upsert_overload_3(self, async_client: AsyncKernel) -> None
         item = await async_client.vaults.items.upsert(
             key="x",
             id_or_name="id_or_name",
-            spec={"fields": {"foo": {"type": "text"}}},
+            spec={
+                "fields": [
+                    {
+                        "name": "name",
+                        "type": "text",
+                    }
+                ]
+            },
             type="credential",
         )
         assert_matches_type(VaultItem, item, path=["response"])
@@ -2361,14 +2404,15 @@ async def test_method_upsert_with_all_params_overload_3(self, async_client: Asyn
             key="x",
             id_or_name="id_or_name",
             spec={
-                "fields": {
-                    "foo": {
+                "fields": [
+                    {
+                        "name": "name",
                         "type": "text",
                         "required": True,
                         "sensitive": True,
                         "value": "x",
                     }
-                },
+                ],
                 "description": "description",
             },
             type="credential",
@@ -2381,7 +2425,14 @@ async def test_raw_response_upsert_overload_3(self, async_client: AsyncKernel) -
         response = await async_client.vaults.items.with_raw_response.upsert(
             key="x",
             id_or_name="id_or_name",
-            spec={"fields": {"foo": {"type": "text"}}},
+            spec={
+                "fields": [
+                    {
+                        "name": "name",
+                        "type": "text",
+                    }
+                ]
+            },
             type="credential",
         )
 
@@ -2396,7 +2447,14 @@ async def test_streaming_response_upsert_overload_3(self, async_client: AsyncKer
         async with async_client.vaults.items.with_streaming_response.upsert(
             key="x",
             id_or_name="id_or_name",
-            spec={"fields": {"foo": {"type": "text"}}},
+            spec={
+                "fields": [
+                    {
+                        "name": "name",
+                        "type": "text",
+                    }
+                ]
+            },
             type="credential",
         ) as response:
             assert not response.is_closed
@@ -2414,14 +2472,28 @@ async def test_path_params_upsert_overload_3(self, async_client: AsyncKernel) ->
             await async_client.vaults.items.with_raw_response.upsert(
                 key="x",
                 id_or_name="",
-                spec={"fields": {"foo": {"type": "text"}}},
+                spec={
+                    "fields": [
+                        {
+                            "name": "name",
+                            "type": "text",
+                        }
+                    ]
+                },
                 type="credential",
             )
 
         with pytest.raises(ValueError, match=r"Expected a non-empty value for `key` but received ''"):
             await async_client.vaults.items.with_raw_response.upsert(
                 key="",
                 id_or_name="id_or_name",
-                spec={"fields": {"foo": {"type": "text"}}},
+                spec={
+                    "fields": [
+                        {
+                            "name": "name",
+                            "type": "text",
+                        }
+                    ]
+                },
                 type="credential",
             )