@seamapi/types 1.406.4 → 1.406.5

package/lib/seam/connect/route-types.d.ts

@@ -21,11 +21,11 @@ export interface Routes {
             common_code_key?: string | undefined;
             /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
             prefer_native_scheduling?: boolean | undefined;
-            /** 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). */
             use_backup_access_code_pool?: boolean | undefined;
-            /** 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`. */
             allow_external_modification?: boolean | undefined;
-            /** 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`. */
             is_external_modification_allowed?: boolean | undefined;
             /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
             preferred_code_length?: number | undefined;
@@ -1629,11 +1629,11 @@ export interface Routes {
             attempt_for_offline_device?: boolean;
             /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
             prefer_native_scheduling?: boolean | undefined;
-            /** 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). */
             use_backup_access_code_pool?: boolean | undefined;
-            /** 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`. */
             allow_external_modification?: boolean | undefined;
-            /** 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`. */
             is_external_modification_allowed?: boolean | undefined;
             use_offline_access_code?: boolean | undefined;
             /** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
@@ -7716,11 +7716,11 @@ export interface Routes {
             attempt_for_offline_device?: boolean;
             /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
             prefer_native_scheduling?: boolean | undefined;
-            /** 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). */
             use_backup_access_code_pool?: boolean | undefined;
-            /** 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`. */
             allow_external_modification?: boolean | undefined;
-            /** 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`. */
             is_external_modification_allowed?: boolean | undefined;
             /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
             preferred_code_length?: number | undefined;
@@ -25460,7 +25460,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the lock that you want to get. */
             device_id?: string | undefined;
+            /** Name of the lock that you want to get. */
             name?: string | undefined;
         };
         formData: {};
@@ -27888,11 +27890,11 @@ export interface Routes {
             connected_account_ids?: string[] | undefined;
             /** ID of the Connect Webview for which you want to list devices. */
             connect_webview_id?: string | undefined;
-            /** Device type by which to filter devices. */
+            /** Device type of the locks that you want to list. */
             device_type?: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | undefined;
-            /** Array of device types by which to filter devices. */
+            /** Device types of the locks that you want to list. */
             device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock'> | undefined;
-            /** Manufacturer by which to filter devices. */
+            /** Manufacturer of the locks that you want to list. */
             manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'kwikset2' | 'smartthings') | undefined;
             /** Array of device IDs for which you want to list devices. */
             device_ids?: string[] | undefined;
@@ -30328,7 +30330,9 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the lock that you want to lock. */
             device_id: string;
+            /**  */
             sync?: boolean;
         };
         commonParams: {};
@@ -31444,7 +31448,9 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the device for which you want to simulate a keypad code entry. */
             device_id: string;
+            /** Code that you want to simulate entering on a keypad. */
             code: string;
         };
         commonParams: {};
@@ -32560,6 +32566,7 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the device for which you want to simulate a manual lock action using a keypad. */
             device_id: string;
         };
         commonParams: {};
@@ -33675,7 +33682,9 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the lock that you want to unlock. */
             device_id: string;
+            /**  */
             sync?: boolean;
         };
         commonParams: {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.406.4",
+  "version": "1.406.5",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/openapi.ts

@@ -20593,7 +20593,7 @@ export default {
                 properties: {
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   attempt_for_offline_device: {
@@ -20625,7 +20625,7 @@ export default {
                   },
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   is_offline_access_code: {
@@ -20673,7 +20673,7 @@ export default {
                   },
                   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).',
+                      '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).',
                     type: 'boolean',
                   },
                   use_offline_access_code: { type: 'boolean' },
@@ -20734,7 +20734,7 @@ export default {
                 properties: {
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   attempt_for_offline_device: {
@@ -20768,7 +20768,7 @@ export default {
                   },
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   is_offline_access_code: {
@@ -20811,7 +20811,7 @@ export default {
                   },
                   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).',
+                      '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).',
                     type: 'boolean',
                   },
                   use_offline_access_code: { type: 'boolean' },
@@ -20869,7 +20869,7 @@ export default {
                 properties: {
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   attempt_for_offline_device: {
@@ -20903,7 +20903,7 @@ export default {
                   },
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   is_offline_access_code: {
@@ -20946,7 +20946,7 @@ export default {
                   },
                   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).',
+                      '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).',
                     type: 'boolean',
                   },
                   use_offline_access_code: { type: 'boolean' },
@@ -21974,7 +21974,7 @@ export default {
                   },
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   attempt_for_offline_device: {
@@ -22001,7 +22001,7 @@ export default {
                   },
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   is_managed: {
@@ -22060,7 +22060,7 @@ export default {
                   },
                   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).',
+                      '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).',
                     type: 'boolean',
                   },
                   use_offline_access_code: { type: 'boolean' },
@@ -22122,7 +22122,7 @@ export default {
                   },
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   attempt_for_offline_device: {
@@ -22149,7 +22149,7 @@ export default {
                   },
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   is_managed: {
@@ -22208,7 +22208,7 @@ export default {
                   },
                   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).',
+                      '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).',
                     type: 'boolean',
                   },
                   use_offline_access_code: { type: 'boolean' },
@@ -22271,7 +22271,7 @@ export default {
                   },
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   attempt_for_offline_device: {
@@ -22298,7 +22298,7 @@ export default {
                   },
                   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`.',
+                      'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
                     type: 'boolean',
                   },
                   is_managed: {
@@ -22357,7 +22357,7 @@ export default {
                   },
                   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).',
+                      '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).',
                     type: 'boolean',
                   },
                   use_offline_access_code: { type: 'boolean' },
@@ -29979,14 +29979,23 @@ export default {
     },
     '/locks/get': {
       post: {
+        description:
+          'Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**',
         operationId: 'locksGetPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
-                  name: { type: 'string' },
+                  device_id: {
+                    description: 'ID of the lock that you want to get.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  name: {
+                    description: 'Name of the lock that you want to get.',
+                    type: 'string',
+                  },
                 },
                 type: 'object',
               },
@@ -30026,10 +30035,13 @@ export default {
         'x-fern-sdk-method-name': 'get',
         'x-fern-sdk-return-value': 'device',
         'x-response-key': 'device',
+        'x-title': 'Get a Lock',
       },
     },
     '/locks/list': {
       post: {
+        description:
+          'Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).',
         operationId: 'locksListPost',
         requestBody: {
           content: {
@@ -30079,7 +30091,8 @@ export default {
                     type: 'array',
                   },
                   device_type: {
-                    description: 'Device type by which to filter devices.',
+                    description:
+                      'Device type of the locks that you want to list.',
                     enum: [
                       'akuvox_lock',
                       'august_lock',
@@ -30113,7 +30126,7 @@ export default {
                   },
                   device_types: {
                     description:
-                      'Array of device types by which to filter devices.',
+                      'Device types of the locks that you want to list.',
                     items: {
                       description: 'Device type for smartlocks.\n          ',
                       enum: [
@@ -30197,7 +30210,8 @@ export default {
                     type: 'number',
                   },
                   manufacturer: {
-                    description: 'Manufacturer by which to filter devices.',
+                    description:
+                      'Manufacturer of the locks that you want to list.',
                     enum: [
                       'akuvox',
                       'august',
@@ -30293,18 +30307,29 @@ export default {
         'x-fern-sdk-method-name': 'list',
         'x-fern-sdk-return-value': 'devices',
         'x-response-key': 'devices',
+        'x-title': 'List Locks',
       },
     },
     '/locks/lock_door': {
       post: {
+        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).',
         operationId: 'locksLockDoorPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
-                  sync: { default: false, type: 'boolean' },
+                  device_id: {
+                    description: 'ID of the lock that you want to lock.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  sync: {
+                    default: false,
+                    type: 'boolean',
+                    'x-undocumented': 'Only used internally.',
+                  },
                 },
                 required: ['device_id'],
                 type: 'object',
@@ -30346,18 +30371,30 @@ export default {
         'x-fern-sdk-method-name': 'lock_door',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Lock a Lock',
       },
     },
     '/locks/simulate/keypad_code_entry': {
       post: {
+        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](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
         operationId: 'locksSimulateKeypadCodeEntryPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  code: { type: 'string' },
-                  device_id: { format: 'uuid', type: 'string' },
+                  code: {
+                    description:
+                      'Code that you want to simulate entering on a keypad.',
+                    type: 'string',
+                  },
+                  device_id: {
+                    description:
+                      'ID of the device for which you want to simulate a keypad code entry.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
                 },
                 required: ['device_id', 'code'],
                 type: 'object',
@@ -30403,12 +30440,21 @@ export default {
     },
     '/locks/simulate/manual_lock_via_keypad': {
       post: {
+        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](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
         operationId: 'locksSimulateManualLockViaKeypadPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
-                properties: { device_id: { format: 'uuid', type: 'string' } },
+                properties: {
+                  device_id: {
+                    description:
+                      'ID of the device for which you want to simulate a manual lock action using a keypad.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                },
                 required: ['device_id'],
                 type: 'object',
               },
@@ -30453,14 +30499,24 @@ export default {
     },
     '/locks/unlock_door': {
       post: {
+        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).',
         operationId: 'locksUnlockDoorPost',
         requestBody: {
           content: {
             'application/json': {
               schema: {
                 properties: {
-                  device_id: { format: 'uuid', type: 'string' },
-                  sync: { default: false, type: 'boolean' },
+                  device_id: {
+                    description: 'ID of the lock that you want to unlock.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  sync: {
+                    default: false,
+                    type: 'boolean',
+                    'x-undocumented': 'Only used internally.',
+                  },
                 },
                 required: ['device_id'],
                 type: 'object',
@@ -30502,6 +30558,7 @@ export default {
         'x-fern-sdk-method-name': 'unlock_door',
         'x-fern-sdk-return-value': 'action_attempt',
         'x-response-key': 'action_attempt',
+        'x-title': 'Unlock a Lock',
       },
     },
     '/networks/get': {
@@ -30544,10 +30601,12 @@ export default {
         ],
         summary: '/networks/get',
         tags: ['/networks'],
+        'x-deprecated': 'Will be removed.',
         'x-fern-sdk-group-name': ['networks'],
         'x-fern-sdk-method-name': 'get',
         'x-fern-sdk-return-value': 'network',
         'x-response-key': 'network',
+        'x-undocumented': 'Deprecated.',
       },
     },
     '/networks/list': {
@@ -30587,10 +30646,12 @@ export default {
         ],
         summary: '/networks/list',
         tags: ['/networks'],
+        'x-deprecated': 'Will be removed.',
         'x-fern-sdk-group-name': ['networks'],
         'x-fern-sdk-method-name': 'list',
         'x-fern-sdk-return-value': 'networks',
         'x-response-key': 'networks',
+        'x-undocumented': 'Deprecated.',
       },
     },
     '/noise_sensors/list': {

package/src/lib/seam/connect/route-types.ts

@@ -21,11 +21,11 @@ export interface Routes {
       common_code_key?: string | undefined
       /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
       prefer_native_scheduling?: boolean | undefined
-      /** 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). */
       use_backup_access_code_pool?: boolean | undefined
-      /** 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`. */
       allow_external_modification?: boolean | undefined
-      /** 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`. */
       is_external_modification_allowed?: boolean | undefined
       /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
       preferred_code_length?: number | undefined
@@ -1872,11 +1872,11 @@ export interface Routes {
       attempt_for_offline_device?: boolean
       /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
       prefer_native_scheduling?: boolean | undefined
-      /** 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). */
       use_backup_access_code_pool?: boolean | undefined
-      /** 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`. */
       allow_external_modification?: boolean | undefined
-      /** 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`. */
       is_external_modification_allowed?: boolean | undefined
       use_offline_access_code?: boolean | undefined
       /** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
@@ -8769,11 +8769,11 @@ export interface Routes {
       attempt_for_offline_device?: boolean
       /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
       prefer_native_scheduling?: boolean | undefined
-      /** 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). */
       use_backup_access_code_pool?: boolean | undefined
-      /** 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`. */
       allow_external_modification?: boolean | undefined
-      /** 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`. */
       is_external_modification_allowed?: boolean | undefined
       /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
       preferred_code_length?: number | undefined
@@ -29940,7 +29940,9 @@ export interface Routes {
     queryParams: {}
     jsonBody: {}
     commonParams: {
+      /** ID of the lock that you want to get. */
       device_id?: string | undefined
+      /** Name of the lock that you want to get. */
       name?: string | undefined
     }
     formData: {}
@@ -32838,7 +32840,7 @@ export interface Routes {
       connected_account_ids?: string[] | undefined
       /** ID of the Connect Webview for which you want to list devices. */
       connect_webview_id?: string | undefined
-      /** Device type by which to filter devices. */
+      /** Device type of the locks that you want to list. */
       device_type?:
         | (
             | 'akuvox_lock'
@@ -32870,7 +32872,7 @@ export interface Routes {
             | 'akiles_lock'
           )
         | undefined
-      /** Array of device types by which to filter devices. */
+      /** Device types of the locks that you want to list. */
       device_types?:
         | Array<
             | 'akuvox_lock'
@@ -32902,7 +32904,7 @@ export interface Routes {
             | 'akiles_lock'
           >
         | undefined
-      /** Manufacturer by which to filter devices. */
+      /** Manufacturer of the locks that you want to list. */
       manufacturer?:
         | (
             | 'akuvox'
@@ -35867,7 +35869,9 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the lock that you want to lock. */
       device_id: string
+      /**  */
       sync?: boolean
     }
     commonParams: {}
@@ -37172,7 +37176,9 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the device for which you want to simulate a keypad code entry. */
       device_id: string
+      /** Code that you want to simulate entering on a keypad. */
       code: string
     }
     commonParams: {}
@@ -38477,6 +38483,7 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the device for which you want to simulate a manual lock action using a keypad. */
       device_id: string
     }
     commonParams: {}
@@ -39781,7 +39788,9 @@ export interface Routes {
     method: 'POST'
     queryParams: {}
     jsonBody: {
+      /** ID of the lock that you want to unlock. */
       device_id: string
+      /**  */
       sync?: boolean
     }
     commonParams: {}