diff --git a/docs/api/_blueprint.json b/docs/api/_blueprint.json index 1218b2036..028600286 100644 --- a/docs/api/_blueprint.json +++ b/docs/api/_blueprint.json @@ -33,7 +33,7 @@ "parameters": [ { "name": "allow_external_modification", - "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -118,7 +118,7 @@ }, { "name": "is_external_modification_allowed", - "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -288,7 +288,7 @@ }, { "name": "use_backup_access_code_pool", - "description": "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).", + "description": "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -353,7 +353,7 @@ "parameters": [ { "name": "allow_external_modification", - "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -462,7 +462,7 @@ }, { "name": "is_external_modification_allowed", - "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -617,7 +617,7 @@ }, { "name": "use_backup_access_code_pool", - "description": "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).", + "description": "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -1145,7 +1145,7 @@ }, { "name": "allow_external_modification", - "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -1216,7 +1216,7 @@ }, { "name": "is_external_modification_allowed", - "description": "Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.", + "description": "Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -1436,7 +1436,7 @@ }, { "name": "use_backup_access_code_pool", - "description": "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).", + "description": "Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code).", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -11183,7 +11183,7 @@ "jsonType": "object" }, { - "name": "customer_id", + "name": "customer_ids", "description": "", "isRequired": false, "isDeprecated": false, @@ -11193,8 +11193,9 @@ "isDraft": false, "draftMessage": "", "hasDefault": false, - "format": "string", - "jsonType": "string" + "format": "list", + "jsonType": "array", + "itemFormat": "string" }, { "name": "limit", @@ -17615,10 +17616,10 @@ "namespace": null, "endpoints": [ { - "title": "", + "title": "Get a Lock", "name": "get", "path": "/locks/get", - "description": "", + "description": "Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**", "isDeprecated": false, "deprecationMessage": "Use `/devices/get` instead.", "isUndocumented": false, @@ -17641,7 +17642,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the lock that you want to get.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17655,7 +17656,7 @@ }, { "name": "name", - "description": "", + "description": "Name of the lock that you want to get.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -17679,10 +17680,10 @@ "codeSamples": [] }, { - "title": "", + "title": "List Locks", "name": "list", "path": "/locks/list", - "description": "", + "description": "Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -17806,7 +17807,7 @@ }, { "name": "device_type", - "description": "Device type by which to filter devices.", + "description": "Device type of the locks that you want to list.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -18092,7 +18093,7 @@ }, { "name": "device_types", - "description": "Array of device types by which to filter devices.", + "description": "Device types of the locks that you want to list.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -18648,7 +18649,7 @@ }, { "name": "manufacturer", - "description": "Manufacturer by which to filter devices.", + "description": "Manufacturer of the locks that you want to list.", "isRequired": false, "isDeprecated": false, "deprecationMessage": "", @@ -18996,10 +18997,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Lock a Lock", "name": "lock_door", "path": "/locks/lock_door", - "description": "", + "description": "Locks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -19022,7 +19023,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the lock that you want to lock.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -19040,8 +19041,8 @@ "isRequired": false, "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", "isDraft": false, "draftMessage": "", "hasDefault": true, @@ -19061,10 +19062,10 @@ "codeSamples": [] }, { - "title": "", + "title": "Unlock a Lock", "name": "unlock_door", "path": "/locks/unlock_door", - "description": "", + "description": "Unlocks a [lock](https://docs.seam.co/latest/capability-guides/smart-locks). See also [Locking and Unlocking Smart Locks](https://docs.seam.co/latest/capability-guides/smart-locks/lock-and-unlock).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": false, @@ -19087,7 +19088,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the lock that you want to unlock.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -19105,8 +19106,8 @@ "isRequired": false, "isDeprecated": false, "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "isUndocumented": true, + "undocumentedMessage": "Only used internally.", "isDraft": false, "draftMessage": "", "hasDefault": true, @@ -19140,7 +19141,7 @@ "title": "", "name": "keypad_code_entry", "path": "/locks/simulate/keypad_code_entry", - "description": "", + "description": "Simulates the entry of a code on a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](../core-concepts/workspaces/README.md#sandbox-workspaces).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": true, @@ -19163,7 +19164,7 @@ "parameters": [ { "name": "code", - "description": "", + "description": "Code that you want to simulate entering on a keypad.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -19177,7 +19178,7 @@ }, { "name": "device_id", - "description": "", + "description": "ID of the device for which you want to simulate a keypad code entry.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -19203,7 +19204,7 @@ "title": "", "name": "manual_lock_via_keypad", "path": "/locks/simulate/manual_lock_via_keypad", - "description": "", + "description": "Simulates a manual lock action using a keypad. You can only perform this action for [August](https://docs.seam.co/latest/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](../core-concepts/workspaces/README.md#sandbox-workspaces).", "isDeprecated": false, "deprecationMessage": "", "isUndocumented": true, @@ -19226,7 +19227,7 @@ "parameters": [ { "name": "device_id", - "description": "", + "description": "ID of the device for which you want to simulate a manual lock action using a keypad.", "isRequired": true, "isDeprecated": false, "deprecationMessage": "", @@ -19265,9 +19266,9 @@ "path": "/networks/get", "description": "", "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "deprecationMessage": "Will be removed.", + "isUndocumented": true, + "undocumentedMessage": "Deprecated.", "isDraft": false, "draftMessage": "", "response": { @@ -19314,9 +19315,9 @@ "path": "/networks/list", "description": "", "isDeprecated": false, - "deprecationMessage": "", - "isUndocumented": false, - "undocumentedMessage": "", + "deprecationMessage": "Will be removed.", + "isUndocumented": true, + "undocumentedMessage": "Deprecated.", "isDraft": false, "draftMessage": "", "response": { @@ -19344,7 +19345,7 @@ } ], "subroutes": [], - "isUndocumented": false, + "isUndocumented": true, "isDeprecated": false, "isDraft": false }, @@ -40419,6 +40420,19 @@ "format": "datetime", "jsonType": "string" }, + { + "name": "customer_id", + "description": "", + "isDeprecated": false, + "deprecationMessage": "", + "isUndocumented": false, + "undocumentedMessage": "", + "isDraft": false, + "draftMessage": "", + "propertyGroupKey": null, + "format": "id", + "jsonType": "string" + }, { "name": "device_count", "description": "", diff --git a/docs/api/_report.md b/docs/api/_report.md index 5c4c7329e..ea0f382fa 100644 --- a/docs/api/_report.md +++ b/docs/api/_report.md @@ -13,7 +13,6 @@ - `/devices/unmanaged` - `/events` - `/locks` -- `/networks` - `/noise_sensors` - `/noise_sensors/noise_thresholds` - `/noise_sensors/simulate` @@ -23,12 +22,6 @@ ### Endpoints -- `/locks/get` -- `/locks/list` -- `/locks/lock_door` -- `/locks/unlock_door` -- `/networks/get` -- `/networks/list` - `/noise_sensors/list` - `/noise_sensors/noise_thresholds/create` - `/noise_sensors/noise_thresholds/delete` @@ -60,6 +53,7 @@ These items are intentionally undocumented. - `/acs/users/unmanaged`: No undocumented message provided - `/bridges`: No undocumented message provided - `/locks/simulate`: No undocumented message provided +- `/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/instant_key/v1/client_sessions`: No undocumented message provided @@ -109,6 +103,8 @@ These items are intentionally undocumented. - `/devices/delete`: Deleting a device is no longer supported and will be removed. - `/locks/simulate/keypad_code_entry`: Unreleased. - `/locks/simulate/manual_lock_via_keypad`: Unreleased. +- `/networks/get`: Deprecated. +- `/networks/list`: Deprecated. - `/seam/bridge/v1/bridge_client_sessions/create`: Seam Bridge Client only. - `/seam/bridge/v1/bridge_client_sessions/get`: Seam Bridge Client only. - `/seam/bridge/v1/bridge_client_sessions/refresh_telemetry_token`: Seam Bridge Client only. @@ -169,6 +165,10 @@ These items are intentionally undocumented. - `exclude_if`: Only used internally. - `include_if`: Only used internally. - `unstable_location_id`: Experimental locations. +- `/locks/lock_door` + - `sync`: Only used internally. +- `/locks/unlock_door` + - `sync`: Only used internally. - `/noise_sensors/list` - `exclude_if`: Only used internally. - `include_if`: Only used internally. @@ -239,6 +239,7 @@ Items that are intentionally undocumented are not included in this section. - `client_session.connect_webview_ids` - `client_session.connected_account_ids` - `client_session.created_at` +- `client_session.customer_id` - `client_session.device_count` - `client_session.expires_at` - `client_session.token` @@ -330,12 +331,6 @@ Items that are intentionally undocumented are not included in this section. ### Endpoints -- `/locks/get` -- `/locks/list` -- `/locks/lock_door` -- `/locks/unlock_door` -- `/locks/simulate/keypad_code_entry` -- `/locks/simulate/manual_lock_via_keypad` - `/networks/get` - `/networks/list` - `/noise_sensors/list` @@ -392,7 +387,7 @@ Items that are intentionally undocumented are not included in this section. - `customer_id` - `device_selection_mode` - `/connect_webviews/list` - - `customer_id` + - `customer_ids` - `/connected_accounts/delete` - `sync` - `/connected_accounts/list` @@ -407,24 +402,14 @@ Items that are intentionally undocumented are not included in this section. - `customer_ids` - `exclude_if` - `include_if` -- `/locks/get` - - `device_id` - - `name` - `/locks/list` - `customer_ids` - `exclude_if` - `include_if` - `/locks/lock_door` - - `device_id` - `sync` - `/locks/unlock_door` - - `device_id` - `sync` -- `/locks/simulate/keypad_code_entry` - - `code` - - `device_id` -- `/locks/simulate/manual_lock_via_keypad` - - `device_id` - `/networks/get` - `network_id` - `/noise_sensors/list` diff --git a/docs/api/access_codes/create.md b/docs/api/access_codes/create.md index 9b985b20c..4d6a2b3b4 100644 --- a/docs/api/access_codes/create.md +++ b/docs/api/access_codes/create.md @@ -36,7 +36,7 @@ ID of the device for which you want to create the new access code. **`allow_external_modification`** *Boolean* -Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. +Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. --- @@ -64,7 +64,7 @@ Date and time at which the validity of the new access code ends, in [ISO 8601](h **`is_external_modification_allowed`** *Boolean* -Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. +Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. --- @@ -112,7 +112,7 @@ Date and time at which the validity of the new access code starts, in [ISO 8601] **`use_backup_access_code_pool`** *Boolean* -Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). +Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). --- diff --git a/docs/api/access_codes/create_multiple.md b/docs/api/access_codes/create_multiple.md index fe732e4a0..f0cf283fe 100644 --- a/docs/api/access_codes/create_multiple.md +++ b/docs/api/access_codes/create_multiple.md @@ -44,7 +44,7 @@ IDs of the devices for which you want to create the new access codes. **`allow_external_modification`** *Boolean* -Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. +Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. --- @@ -72,7 +72,7 @@ Date and time at which the validity of the new access code ends, in [ISO 8601](h **`is_external_modification_allowed`** *Boolean* -Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. +Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. --- @@ -120,7 +120,7 @@ Date and time at which the validity of the new access code starts, in [ISO 8601] **`use_backup_access_code_pool`** *Boolean* -Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). +Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). --- diff --git a/docs/api/access_codes/update.md b/docs/api/access_codes/update.md index 040b7e95b..5193fa5d7 100644 --- a/docs/api/access_codes/update.md +++ b/docs/api/access_codes/update.md @@ -38,7 +38,7 @@ ID of the access code that you want to update. **`allow_external_modification`** *Boolean* -Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. +Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. --- @@ -66,7 +66,7 @@ Date and time at which the validity of the new access code ends, in [ISO 8601](h **`is_external_modification_allowed`** *Boolean* -Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. +Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. --- @@ -126,7 +126,7 @@ Type to which you want to convert the access code. To convert a time-bound acces **`use_backup_access_code_pool`** *Boolean* -Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). +Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api/access_codes/pull_backup_access_code). --- diff --git a/package-lock.json b/package-lock.json index 15c0987de..96b931a9e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.43.5", "@seamapi/smith": "^0.4.4", - "@seamapi/types": "1.406.4", + "@seamapi/types": "1.406.6", "change-case": "^5.4.4", "command-exists": "^1.2.9", "execa": "^9.3.1", @@ -798,9 +798,9 @@ } }, "node_modules/@seamapi/types": { - "version": "1.406.4", - "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.406.4.tgz", - "integrity": "sha512-HSVpjWe/OeI+wUMJ+eGAg+GNx0unfRfTdWHuVXoWYFtm+V2Xv29M3h+6A20zRxrnmoGPe2fKb4v+/XAU/k373Q==", + "version": "1.406.6", + "resolved": "https://registry.npmjs.org/@seamapi/types/-/types-1.406.6.tgz", + "integrity": "sha512-MXkLNMAdFh+4SHlofbaB6zMr0o/r91z0Uy/hT2IOYFIL7471vU9NjQ11W/4mFwmX9uB4F0llTDqHJ4NxvwEzEw==", "license": "MIT", "engines": { "node": ">=18.12.0", diff --git a/package.json b/package.json index 56907b30c..707b21875 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,7 @@ "@prettier/plugin-ruby": "^4.0.4", "@seamapi/blueprint": "^0.43.5", "@seamapi/smith": "^0.4.4", - "@seamapi/types": "1.406.4", + "@seamapi/types": "1.406.6", "change-case": "^5.4.4", "command-exists": "^1.2.9", "execa": "^9.3.1",