ci: Generate docs

Author: seambot

docs/api/_blueprint.json

@@ -34,6 +34,8 @@ These items are intentionally undocumented.
 - `/networks`: No undocumented message provided
 - `/seam/bridge/v1/bridge_client_sessions`: No undocumented message provided
 - `/seam/bridge/v1/bridge_connected_systems`: No undocumented message provided
+- `/seam/customer/v1/automation_runs`: No undocumented message provided
+- `/seam/customer/v1/automations`: No undocumented message provided
 - `/seam/customer/v1/portals`: No undocumented message provided
 - `/seam/customer/v1/settings`: No undocumented message provided
 - `/seam/instant_key/v1/client_sessions`: No undocumented message provided
@@ -100,6 +102,10 @@ These items are intentionally undocumented.
 - `/seam/bridge/v1/bridge_client_sessions/regenerate_pairing_code`: Seam Bridge Client only.
 - `/seam/bridge/v1/bridge_client_sessions/report_status`: Seam Bridge Client only.
 - `/seam/bridge/v1/bridge_connected_systems/list`: Seam Bridge Client only.
+- `/seam/customer/v1/automation_runs/list`: Internal endpoint for customer portals.
+- `/seam/customer/v1/automations/delete`: Internal endpoint for customer portals.
+- `/seam/customer/v1/automations/get`: Internal endpoint for customer portals.
+- `/seam/customer/v1/automations/update`: Internal endpoint for customer portals.
 - `/seam/customer/v1/portals/get`: Internal endpoint for customer portals.
 - `/seam/customer/v1/settings/update`: Internal endpoint for customer portals.
 - `/seam/instant_key/v1/client_sessions/exchange_short_code`: Seam Instant Key only.
@@ -240,6 +246,7 @@ Items that are intentionally undocumented are not included in this section.
 - `device.can_simulate_disconnection`
 - `device.can_simulate_removal`
 - `device.can_turn_off_hvac`
+- `device.can_unlock_with_code`
 - `device_provider.can_hvac_cool`
 - `device_provider.can_hvac_heat`
 - `device_provider.can_hvac_heat_cool`
@@ -251,6 +258,7 @@ Items that are intentionally undocumented are not included in this section.
 - `device_provider.can_simulate_disconnection`
 - `device_provider.can_simulate_removal`
 - `device_provider.can_turn_off_hvac`
+- `device_provider.can_unlock_with_code`
 - `device_provider.device_provider_name`
 - `device_provider.display_name`
 - `device_provider.image_url`
@@ -276,6 +284,7 @@ Items that are intentionally undocumented are not included in this section.
 - `unmanaged_device.can_simulate_disconnection`
 - `unmanaged_device.can_simulate_removal`
 - `unmanaged_device.can_turn_off_hvac`
+- `unmanaged_device.can_unlock_with_code`
 - `unmanaged_device.is_managed`
 - `user_identity.display_name`
 - `user_identity.full_name`
@@ -409,7 +418,6 @@ These items have been marked as draft.
 ### Routes
 
 - `/access_grants`: No draft message provided
-- `/access_methods`: No draft message provided
 - `/spaces`: No draft message provided
 
 ### Endpoints
@@ -461,6 +469,12 @@ These items are deprecated.
 
 ### Endpoint parameters
 
+- `/access_codes/create`
+    - `use_offline_access_code`: Use `is_offline_access_code` instead.
+- `/access_codes/create_multiple`
+    - `use_offline_access_code`: Use `is_offline_access_code` instead.
+- `/access_codes/update`
+    - `use_offline_access_code`: Use `is_offline_access_code` instead.
 - `/access_grants/create`
     - `location_ids`: Use `space_ids`.
 - `/access_grants/list`
@@ -530,11 +544,13 @@ These items are deprecated.
 - `/bridges/list`: `bridges`
 - `/networks/get`: `network`
 - `/networks/list`: `networks`
+- `/seam/customer/v1/automation_runs/list`: `automation_runs`
 - `/seam/customer/v1/portals/get`: `customer_portal`
 - `/seam/partner/v1/building_blocks/spaces/auto_map`: `spaces`
 
 ### Endpoints without code samples
 
+- `/access_methods/encode`
 - `/customers/create_portal`
 - `/customers/push_data`
 - `/locks/get`

docs/api/_report.md

@@ -48,7 +48,6 @@
     * [Update a Credential](api/acs/credentials/update.md)
   * [Encoders](api/acs/encoders/README.md)
     * [Encode a Credential](api/acs/encoders/encode_credential.md)
-    * [Encode an Access Method](api/acs/encoders/encode_access_method.md)
     * [Get an Encoder](api/acs/encoders/get.md)
     * [List Encoders](api/acs/encoders/list.md)
     * [Scan a Credential](api/acs/encoders/scan_credential.md)
@@ -74,6 +73,7 @@
   * [Update an Access Grant](api/access_grants/update.md)
 * [Access Methods](api/access_methods/README.md)
   * [Delete an Access Method](api/access_methods/delete.md)
+  * [Encode an Access Method](api/access_methods/encode.md)
   * [Get an Access Method](api/access_methods/get.md)
   * [List Access Methods](api/access_methods/list.md)
 * [Connected Accounts](api/connected_accounts/README.md)

docs/api/_summary.md

@@ -110,6 +110,15 @@ Date and time at which the access grant ends.
 
 
 
+---
+
+**`instant_key_url`** *String*
+
+Instant Key URL. Only returned if the access grant has a single mobile_key access_method.
+
+
+
+
 ---
 
 **`location_ids`** *List* *of UUIDs*

docs/api/access_grants/README.md

@@ -103,9 +103,9 @@ URL of the Instant Key for mobile key access methods.
 
 ---
 
-**`is_card_encoding_required`** *Boolean*
+**`is_encoding_required`** *Boolean*
 
-Indicates whether card encoding is required for plastic card access methods.
+Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method.
 
 
 
@@ -332,6 +332,11 @@ An access method was reissued due to an access grant update.
 Delete an access method.
 
 
+[**`/access_methods/encode`**](./encode.md)
+
+Encodes an existing [credential](../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+
 [**`/access_methods/get`**](./get.md)
 
 Get an access method.

docs/api/access_methods/README.md

@@ -0,0 +1,87 @@
+# Encode an Access Method
+{% hint style="info" %}
+**Early Access Preview.** The access methods API is currently in Alpha. We're actively developing it and seeking early feedback at [[email protected]](mailto:[email protected]). Expect breaking changes as we refine the design.
+{% endhint %}
+
+- [Request Parameters](#request-parameters)
+- [Response](#response)
+
+Encodes an existing [credential](../../capability-guides/access-systems/managing-credentials.md) onto a plastic card placed on the specified [encoder](../../capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md).
+
+
+<details>
+
+<summary>Authentication Methods</summary>
+
+- API key
+- Personal access token
+  <br>Must also include the `seam-workspace` header in the request.
+
+To learn more, see [Authentication](https://docs.seam.co/latest/api/authentication).
+</details>
+
+## Request Parameters
+
+**`access_method_id`** *String* (Required)
+
+ID of the `access_method` to encode onto a card.
+
+---
+
+**`acs_encoder_id`** *String* (Required)
+
+ID of the `acs_encoder` to use to encode the `acs_credential`.
+
+---
+
+
+## Response
+
+[action\_attempt](./)
+
+
+{% tabs %}
+{% tab title="JSON" %}
+
+
+
+```json
+{
+  "action_attempt_id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
+  "action_type": "ENCODE_CREDENTIAL",
+  "error": null,
+  "result": {
+    "access_method": "card",
+    "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
+    "acs_system_id": "b1d03165-2759-474b-a342-e02223f27b39",
+    "acs_user_id": "0fc82df4-391b-4d00-a234-86378f1c3952",
+    "card_number": "164d29dc4a09b65f",
+    "created_at": "2025-06-16T16:54:17.946514Z",
+    "display_name": "Guest Lock 1, Vingcard Lock 2",
+    "ends_at": "2025-07-12T16:54:17.946512Z",
+    "errors": [],
+    "external_type": "visionline_card",
+    "external_type_display_name": "Visionline Card",
+    "is_issued": true,
+    "is_latest_desired_state_synced_with_provider": true,
+    "is_managed": true,
+    "is_multi_phone_sync_credential": false,
+    "issued_at": "2025-06-16T16:54:17.946512Z",
+    "latest_desired_state_synced_with_provider_at": "2025-06-18T16:54:17.946514Z",
+    "starts_at": "2025-07-10T16:54:17.946512Z",
+    "visionline_metadata": {
+      "card_function_type": "guest",
+      "card_id": "5",
+      "common_acs_entrance_ids": ["5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f"],
+      "credential_id": "15",
+      "guest_acs_entrance_ids": ["a1b2c3d4-e5f6-4a3b-2c1d-0e9f8a7b6c5d"],
+      "is_valid": true
+    },
+    "warnings": [],
+    "workspace_id": "005f1e54-5360-40db-8c31-4ef6baaad1fd"
+  },
+  "status": "success"
+}
+```
+{% endtab %}
+{% endtabs %}

docs/api/access_methods/encode.md

@@ -26,6 +26,7 @@ An access system card credential resource.
   "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
   "acs_system_id": "b1d03165-2759-474b-a342-e02223f27b39",
   "acs_user_id": "0fc82df4-391b-4d00-a234-86378f1c3952",
+  "connected_account_id": "daba7bd0-edb6-4bb9-a70b-f9ae08a0e301",
   "card_number": "164d29dc4a09b65f",
   "created_at": "2025-06-16T16:54:17.946514Z",
   "display_name": "Guest Lock 1, Vingcard Lock 2",
@@ -63,6 +64,7 @@ An access system mobile key credential resource.
   "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
   "acs_system_id": "b1d03165-2759-474b-a342-e02223f27b39",
   "acs_user_id": "0fc82df4-391b-4d00-a234-86378f1c3952",
+  "connected_account_id": "1b9a3e0d-443f-4063-b619-4ca7e2a97751",
   "created_at": "2025-06-16T16:54:17.946514Z",
   "display_name": "Front Door",
   "errors": [],
@@ -84,6 +86,7 @@ An access system PIN code credential resource.
   "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
   "acs_system_id": "b1d03165-2759-474b-a342-e02223f27b39",
   "acs_user_id": "0fc82df4-391b-4d00-a234-86378f1c3952",
+  "connected_account_id": "1b9a3e0d-443f-4063-b619-4ca7e2a97751",
   "code": "123456",
   "created_at": "2025-06-16T16:54:17.946514Z",
   "display_name": "FRONT_DOOR",
@@ -210,6 +213,15 @@ Access (PIN) code for the [credential](../../../capability-guides/access-systems
 
 
 
+---
+
+**`connected_account_id`** *UUID*
+
+ID of the [connected account](../../../capability-guides/access-systems/managing-credentials.md#connected-accounts) to which the [credential](../../../capability-guides/access-systems/managing-credentials.md) belongs.
+
+
+
+
 ---
 
 **`created_at`** *Datetime*

docs/api/acs/credentials/README.md

@@ -534,6 +534,7 @@ Enum values:
   "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
   "acs_system_id": "b1d03165-2759-474b-a342-e02223f27b39",
   "acs_user_id": "0fc82df4-391b-4d00-a234-86378f1c3952",
+  "connected_account_id": "daba7bd0-edb6-4bb9-a70b-f9ae08a0e301",
   "card_number": "164d29dc4a09b65f",
   "created_at": "2025-06-16T16:54:17.946514Z",
   "display_name": "Guest Lock 1, Vingcard Lock 2",

docs/api/acs/credentials/create.md

@@ -277,6 +277,7 @@ ID of the credential that you want to get.
   "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
   "acs_system_id": "b1d03165-2759-474b-a342-e02223f27b39",
   "acs_user_id": "0fc82df4-391b-4d00-a234-86378f1c3952",
+  "connected_account_id": "daba7bd0-edb6-4bb9-a70b-f9ae08a0e301",
   "card_number": "164d29dc4a09b65f",
   "created_at": "2025-06-16T16:54:17.946514Z",
   "display_name": "Guest Lock 1, Vingcard Lock 2",

docs/api/acs/credentials/get.md

@@ -311,6 +311,7 @@ Array of [acs\_credentials](./)
   "acs_credential_id": "73a0a199-024f-454d-a916-9bbda8502c12",
   "acs_system_id": "b1d03165-2759-474b-a342-e02223f27b39",
   "acs_user_id": "0fc82df4-391b-4d00-a234-86378f1c3952",
+  "connected_account_id": "daba7bd0-edb6-4bb9-a70b-f9ae08a0e301",
   "card_number": "164d29dc4a09b65f",
   "created_at": "2025-06-16T16:54:17.946514Z",
   "display_name": "Guest Lock 1, Vingcard Lock 2",