@seamapi/types 1.406.3 → 1.406.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/dist/connect.cjs +88 -37
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +45 -12
  4. package/lib/seam/connect/openapi.d.ts +24 -0
  5. package/lib/seam/connect/openapi.js +81 -30
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +21 -12
  8. package/package.json +1 -1
  9. package/src/lib/seam/connect/openapi.ts +92 -30
  10. package/src/lib/seam/connect/route-types.ts +21 -12
package/lib/seam/connect/route-types.d.ts CHANGED
@@ -21,11 +21,11 @@ export interface Routes {
21
21
  common_code_key?: string | undefined;
22
22
  /** 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`. */
23
23
  prefer_native_scheduling?: boolean | undefined;
24
- /** 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). */
24
+ /** 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). */
25
25
  use_backup_access_code_pool?: boolean | undefined;
26
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
26
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
27
27
  allow_external_modification?: boolean | undefined;
28
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
28
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
29
29
  is_external_modification_allowed?: boolean | undefined;
30
30
  /** 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. */
31
31
  preferred_code_length?: number | undefined;
@@ -1629,11 +1629,11 @@ export interface Routes {
1629
1629
  attempt_for_offline_device?: boolean;
1630
1630
  /** 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`. */
1631
1631
  prefer_native_scheduling?: boolean | undefined;
1632
- /** 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). */
1632
+ /** 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). */
1633
1633
  use_backup_access_code_pool?: boolean | undefined;
1634
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
1634
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
1635
1635
  allow_external_modification?: boolean | undefined;
1636
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
1636
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
1637
1637
  is_external_modification_allowed?: boolean | undefined;
1638
1638
  use_offline_access_code?: boolean | undefined;
1639
1639
  /** 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 {
7716
7716
  attempt_for_offline_device?: boolean;
7717
7717
  /** 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`. */
7718
7718
  prefer_native_scheduling?: boolean | undefined;
7719
- /** 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). */
7719
+ /** 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). */
7720
7720
  use_backup_access_code_pool?: boolean | undefined;
7721
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
7721
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
7722
7722
  allow_external_modification?: boolean | undefined;
7723
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
7723
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
7724
7724
  is_external_modification_allowed?: boolean | undefined;
7725
7725
  /** 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. */
7726
7726
  preferred_code_length?: number | undefined;
@@ -25460,7 +25460,9 @@ export interface Routes {
25460
25460
  queryParams: {};
25461
25461
  jsonBody: {};
25462
25462
  commonParams: {
25463
+ /** ID of the lock that you want to get. */
25463
25464
  device_id?: string | undefined;
25465
+ /** Name of the lock that you want to get. */
25464
25466
  name?: string | undefined;
25465
25467
  };
25466
25468
  formData: {};
@@ -27888,11 +27890,11 @@ export interface Routes {
27888
27890
  connected_account_ids?: string[] | undefined;
27889
27891
  /** ID of the Connect Webview for which you want to list devices. */
27890
27892
  connect_webview_id?: string | undefined;
27891
- /** Device type by which to filter devices. */
27893
+ /** Device type of the locks that you want to list. */
27892
27894
  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;
27893
- /** Array of device types by which to filter devices. */
27895
+ /** Device types of the locks that you want to list. */
27894
27896
  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;
27895
- /** Manufacturer by which to filter devices. */
27897
+ /** Manufacturer of the locks that you want to list. */
27896
27898
  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;
27897
27899
  /** Array of device IDs for which you want to list devices. */
27898
27900
  device_ids?: string[] | undefined;
@@ -30328,7 +30330,9 @@ export interface Routes {
30328
30330
  method: 'POST';
30329
30331
  queryParams: {};
30330
30332
  jsonBody: {
30333
+ /** ID of the lock that you want to lock. */
30331
30334
  device_id: string;
30335
+ /** */
30332
30336
  sync?: boolean;
30333
30337
  };
30334
30338
  commonParams: {};
@@ -31444,7 +31448,9 @@ export interface Routes {
31444
31448
  method: 'POST';
31445
31449
  queryParams: {};
31446
31450
  jsonBody: {
31451
+ /** ID of the device for which you want to simulate a keypad code entry. */
31447
31452
  device_id: string;
31453
+ /** Code that you want to simulate entering on a keypad. */
31448
31454
  code: string;
31449
31455
  };
31450
31456
  commonParams: {};
@@ -32560,6 +32566,7 @@ export interface Routes {
32560
32566
  method: 'POST';
32561
32567
  queryParams: {};
32562
32568
  jsonBody: {
32569
+ /** ID of the device for which you want to simulate a manual lock action using a keypad. */
32563
32570
  device_id: string;
32564
32571
  };
32565
32572
  commonParams: {};
@@ -33675,7 +33682,9 @@ export interface Routes {
33675
33682
  method: 'POST';
33676
33683
  queryParams: {};
33677
33684
  jsonBody: {
33685
+ /** ID of the lock that you want to unlock. */
33678
33686
  device_id: string;
33687
+ /** */
33679
33688
  sync?: boolean;
33680
33689
  };
33681
33690
  commonParams: {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.406.3",
3
+ "version": "1.406.5",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
package/src/lib/seam/connect/openapi.ts CHANGED
@@ -20593,7 +20593,7 @@ export default {
20593
20593
  properties: {
20594
20594
  allow_external_modification: {
20595
20595
  description:
20596
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20596
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20597
20597
  type: 'boolean',
20598
20598
  },
20599
20599
  attempt_for_offline_device: {
@@ -20625,7 +20625,7 @@ export default {
20625
20625
  },
20626
20626
  is_external_modification_allowed: {
20627
20627
  description:
20628
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20628
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20629
20629
  type: 'boolean',
20630
20630
  },
20631
20631
  is_offline_access_code: {
@@ -20673,7 +20673,7 @@ export default {
20673
20673
  },
20674
20674
  use_backup_access_code_pool: {
20675
20675
  description:
20676
- '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).',
20676
+ '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).',
20677
20677
  type: 'boolean',
20678
20678
  },
20679
20679
  use_offline_access_code: { type: 'boolean' },
@@ -20734,7 +20734,7 @@ export default {
20734
20734
  properties: {
20735
20735
  allow_external_modification: {
20736
20736
  description:
20737
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20737
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20738
20738
  type: 'boolean',
20739
20739
  },
20740
20740
  attempt_for_offline_device: {
@@ -20768,7 +20768,7 @@ export default {
20768
20768
  },
20769
20769
  is_external_modification_allowed: {
20770
20770
  description:
20771
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20771
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20772
20772
  type: 'boolean',
20773
20773
  },
20774
20774
  is_offline_access_code: {
@@ -20811,7 +20811,7 @@ export default {
20811
20811
  },
20812
20812
  use_backup_access_code_pool: {
20813
20813
  description:
20814
- '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).',
20814
+ '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).',
20815
20815
  type: 'boolean',
20816
20816
  },
20817
20817
  use_offline_access_code: { type: 'boolean' },
@@ -20869,7 +20869,7 @@ export default {
20869
20869
  properties: {
20870
20870
  allow_external_modification: {
20871
20871
  description:
20872
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20872
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20873
20873
  type: 'boolean',
20874
20874
  },
20875
20875
  attempt_for_offline_device: {
@@ -20903,7 +20903,7 @@ export default {
20903
20903
  },
20904
20904
  is_external_modification_allowed: {
20905
20905
  description:
20906
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
20906
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
20907
20907
  type: 'boolean',
20908
20908
  },
20909
20909
  is_offline_access_code: {
@@ -20946,7 +20946,7 @@ export default {
20946
20946
  },
20947
20947
  use_backup_access_code_pool: {
20948
20948
  description:
20949
- '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).',
20949
+ '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).',
20950
20950
  type: 'boolean',
20951
20951
  },
20952
20952
  use_offline_access_code: { type: 'boolean' },
@@ -21974,7 +21974,7 @@ export default {
21974
21974
  },
21975
21975
  allow_external_modification: {
21976
21976
  description:
21977
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
21977
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
21978
21978
  type: 'boolean',
21979
21979
  },
21980
21980
  attempt_for_offline_device: {
@@ -22001,7 +22001,7 @@ export default {
22001
22001
  },
22002
22002
  is_external_modification_allowed: {
22003
22003
  description:
22004
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
22004
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
22005
22005
  type: 'boolean',
22006
22006
  },
22007
22007
  is_managed: {
@@ -22060,7 +22060,7 @@ export default {
22060
22060
  },
22061
22061
  use_backup_access_code_pool: {
22062
22062
  description:
22063
- '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).',
22063
+ '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).',
22064
22064
  type: 'boolean',
22065
22065
  },
22066
22066
  use_offline_access_code: { type: 'boolean' },
@@ -22122,7 +22122,7 @@ export default {
22122
22122
  },
22123
22123
  allow_external_modification: {
22124
22124
  description:
22125
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
22125
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
22126
22126
  type: 'boolean',
22127
22127
  },
22128
22128
  attempt_for_offline_device: {
@@ -22149,7 +22149,7 @@ export default {
22149
22149
  },
22150
22150
  is_external_modification_allowed: {
22151
22151
  description:
22152
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
22152
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
22153
22153
  type: 'boolean',
22154
22154
  },
22155
22155
  is_managed: {
@@ -22208,7 +22208,7 @@ export default {
22208
22208
  },
22209
22209
  use_backup_access_code_pool: {
22210
22210
  description:
22211
- '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).',
22211
+ '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).',
22212
22212
  type: 'boolean',
22213
22213
  },
22214
22214
  use_offline_access_code: { type: 'boolean' },
@@ -22271,7 +22271,7 @@ export default {
22271
22271
  },
22272
22272
  allow_external_modification: {
22273
22273
  description:
22274
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
22274
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
22275
22275
  type: 'boolean',
22276
22276
  },
22277
22277
  attempt_for_offline_device: {
@@ -22298,7 +22298,7 @@ export default {
22298
22298
  },
22299
22299
  is_external_modification_allowed: {
22300
22300
  description:
22301
- 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
22301
+ 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.',
22302
22302
  type: 'boolean',
22303
22303
  },
22304
22304
  is_managed: {
@@ -22357,7 +22357,7 @@ export default {
22357
22357
  },
22358
22358
  use_backup_access_code_pool: {
22359
22359
  description:
22360
- '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).',
22360
+ '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).',
22361
22361
  type: 'boolean',
22362
22362
  },
22363
22363
  use_offline_access_code: { type: 'boolean' },
@@ -29979,14 +29979,23 @@ export default {
29979
29979
  },
29980
29980
  '/locks/get': {
29981
29981
  post: {
29982
+ description:
29983
+ 'Returns a specified [lock](https://docs.seam.co/latest/capability-guides/smart-locks). **Use `/devices/get` instead.**',
29982
29984
  operationId: 'locksGetPost',
29983
29985
  requestBody: {
29984
29986
  content: {
29985
29987
  'application/json': {
29986
29988
  schema: {
29987
29989
  properties: {
29988
- device_id: { format: 'uuid', type: 'string' },
29989
- name: { type: 'string' },
29990
+ device_id: {
29991
+ description: 'ID of the lock that you want to get.',
29992
+ format: 'uuid',
29993
+ type: 'string',
29994
+ },
29995
+ name: {
29996
+ description: 'Name of the lock that you want to get.',
29997
+ type: 'string',
29998
+ },
29990
29999
  },
29991
30000
  type: 'object',
29992
30001
  },
@@ -30026,10 +30035,13 @@ export default {
30026
30035
  'x-fern-sdk-method-name': 'get',
30027
30036
  'x-fern-sdk-return-value': 'device',
30028
30037
  'x-response-key': 'device',
30038
+ 'x-title': 'Get a Lock',
30029
30039
  },
30030
30040
  },
30031
30041
  '/locks/list': {
30032
30042
  post: {
30043
+ description:
30044
+ 'Returns a list of all [locks](https://docs.seam.co/latest/capability-guides/smart-locks).',
30033
30045
  operationId: 'locksListPost',
30034
30046
  requestBody: {
30035
30047
  content: {
@@ -30079,7 +30091,8 @@ export default {
30079
30091
  type: 'array',
30080
30092
  },
30081
30093
  device_type: {
30082
- description: 'Device type by which to filter devices.',
30094
+ description:
30095
+ 'Device type of the locks that you want to list.',
30083
30096
  enum: [
30084
30097
  'akuvox_lock',
30085
30098
  'august_lock',
@@ -30113,7 +30126,7 @@ export default {
30113
30126
  },
30114
30127
  device_types: {
30115
30128
  description:
30116
- 'Array of device types by which to filter devices.',
30129
+ 'Device types of the locks that you want to list.',
30117
30130
  items: {
30118
30131
  description: 'Device type for smartlocks.\n ',
30119
30132
  enum: [
@@ -30197,7 +30210,8 @@ export default {
30197
30210
  type: 'number',
30198
30211
  },
30199
30212
  manufacturer: {
30200
- description: 'Manufacturer by which to filter devices.',
30213
+ description:
30214
+ 'Manufacturer of the locks that you want to list.',
30201
30215
  enum: [
30202
30216
  'akuvox',
30203
30217
  'august',
@@ -30293,18 +30307,29 @@ export default {
30293
30307
  'x-fern-sdk-method-name': 'list',
30294
30308
  'x-fern-sdk-return-value': 'devices',
30295
30309
  'x-response-key': 'devices',
30310
+ 'x-title': 'List Locks',
30296
30311
  },
30297
30312
  },
30298
30313
  '/locks/lock_door': {
30299
30314
  post: {
30315
+ description:
30316
+ '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).',
30300
30317
  operationId: 'locksLockDoorPost',
30301
30318
  requestBody: {
30302
30319
  content: {
30303
30320
  'application/json': {
30304
30321
  schema: {
30305
30322
  properties: {
30306
- device_id: { format: 'uuid', type: 'string' },
30307
- sync: { default: false, type: 'boolean' },
30323
+ device_id: {
30324
+ description: 'ID of the lock that you want to lock.',
30325
+ format: 'uuid',
30326
+ type: 'string',
30327
+ },
30328
+ sync: {
30329
+ default: false,
30330
+ type: 'boolean',
30331
+ 'x-undocumented': 'Only used internally.',
30332
+ },
30308
30333
  },
30309
30334
  required: ['device_id'],
30310
30335
  type: 'object',
@@ -30346,18 +30371,30 @@ export default {
30346
30371
  'x-fern-sdk-method-name': 'lock_door',
30347
30372
  'x-fern-sdk-return-value': 'action_attempt',
30348
30373
  'x-response-key': 'action_attempt',
30374
+ 'x-title': 'Lock a Lock',
30349
30375
  },
30350
30376
  },
30351
30377
  '/locks/simulate/keypad_code_entry': {
30352
30378
  post: {
30379
+ description:
30380
+ '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).',
30353
30381
  operationId: 'locksSimulateKeypadCodeEntryPost',
30354
30382
  requestBody: {
30355
30383
  content: {
30356
30384
  'application/json': {
30357
30385
  schema: {
30358
30386
  properties: {
30359
- code: { type: 'string' },
30360
- device_id: { format: 'uuid', type: 'string' },
30387
+ code: {
30388
+ description:
30389
+ 'Code that you want to simulate entering on a keypad.',
30390
+ type: 'string',
30391
+ },
30392
+ device_id: {
30393
+ description:
30394
+ 'ID of the device for which you want to simulate a keypad code entry.',
30395
+ format: 'uuid',
30396
+ type: 'string',
30397
+ },
30361
30398
  },
30362
30399
  required: ['device_id', 'code'],
30363
30400
  type: 'object',
@@ -30403,12 +30440,21 @@ export default {
30403
30440
  },
30404
30441
  '/locks/simulate/manual_lock_via_keypad': {
30405
30442
  post: {
30443
+ description:
30444
+ '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).',
30406
30445
  operationId: 'locksSimulateManualLockViaKeypadPost',
30407
30446
  requestBody: {
30408
30447
  content: {
30409
30448
  'application/json': {
30410
30449
  schema: {
30411
- properties: { device_id: { format: 'uuid', type: 'string' } },
30450
+ properties: {
30451
+ device_id: {
30452
+ description:
30453
+ 'ID of the device for which you want to simulate a manual lock action using a keypad.',
30454
+ format: 'uuid',
30455
+ type: 'string',
30456
+ },
30457
+ },
30412
30458
  required: ['device_id'],
30413
30459
  type: 'object',
30414
30460
  },
@@ -30453,14 +30499,24 @@ export default {
30453
30499
  },
30454
30500
  '/locks/unlock_door': {
30455
30501
  post: {
30502
+ description:
30503
+ '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).',
30456
30504
  operationId: 'locksUnlockDoorPost',
30457
30505
  requestBody: {
30458
30506
  content: {
30459
30507
  'application/json': {
30460
30508
  schema: {
30461
30509
  properties: {
30462
- device_id: { format: 'uuid', type: 'string' },
30463
- sync: { default: false, type: 'boolean' },
30510
+ device_id: {
30511
+ description: 'ID of the lock that you want to unlock.',
30512
+ format: 'uuid',
30513
+ type: 'string',
30514
+ },
30515
+ sync: {
30516
+ default: false,
30517
+ type: 'boolean',
30518
+ 'x-undocumented': 'Only used internally.',
30519
+ },
30464
30520
  },
30465
30521
  required: ['device_id'],
30466
30522
  type: 'object',
@@ -30502,6 +30558,7 @@ export default {
30502
30558
  'x-fern-sdk-method-name': 'unlock_door',
30503
30559
  'x-fern-sdk-return-value': 'action_attempt',
30504
30560
  'x-response-key': 'action_attempt',
30561
+ 'x-title': 'Unlock a Lock',
30505
30562
  },
30506
30563
  },
30507
30564
  '/networks/get': {
@@ -30544,10 +30601,12 @@ export default {
30544
30601
  ],
30545
30602
  summary: '/networks/get',
30546
30603
  tags: ['/networks'],
30604
+ 'x-deprecated': 'Will be removed.',
30547
30605
  'x-fern-sdk-group-name': ['networks'],
30548
30606
  'x-fern-sdk-method-name': 'get',
30549
30607
  'x-fern-sdk-return-value': 'network',
30550
30608
  'x-response-key': 'network',
30609
+ 'x-undocumented': 'Deprecated.',
30551
30610
  },
30552
30611
  },
30553
30612
  '/networks/list': {
@@ -30587,10 +30646,12 @@ export default {
30587
30646
  ],
30588
30647
  summary: '/networks/list',
30589
30648
  tags: ['/networks'],
30649
+ 'x-deprecated': 'Will be removed.',
30590
30650
  'x-fern-sdk-group-name': ['networks'],
30591
30651
  'x-fern-sdk-method-name': 'list',
30592
30652
  'x-fern-sdk-return-value': 'networks',
30593
30653
  'x-response-key': 'networks',
30654
+ 'x-undocumented': 'Deprecated.',
30594
30655
  },
30595
30656
  },
30596
30657
  '/noise_sensors/list': {
@@ -37560,6 +37621,7 @@ export default {
37560
37621
  'x-fern-sdk-return-value': 'bridge_client_session',
37561
37622
  'x-response-key': 'bridge_client_session',
37562
37623
  'x-title': 'Generate a building block magic link',
37624
+ 'x-undocumented': 'Experimental partner building blocks.',
37563
37625
  },
37564
37626
  },
37565
37627
  '/unstable_partner/resources/push': {
package/src/lib/seam/connect/route-types.ts CHANGED
@@ -21,11 +21,11 @@ export interface Routes {
21
21
  common_code_key?: string | undefined
22
22
  /** 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`. */
23
23
  prefer_native_scheduling?: boolean | undefined
24
- /** 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). */
24
+ /** 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). */
25
25
  use_backup_access_code_pool?: boolean | undefined
26
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
26
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
27
27
  allow_external_modification?: boolean | undefined
28
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
28
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
29
29
  is_external_modification_allowed?: boolean | undefined
30
30
  /** 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. */
31
31
  preferred_code_length?: number | undefined
@@ -1872,11 +1872,11 @@ export interface Routes {
1872
1872
  attempt_for_offline_device?: boolean
1873
1873
  /** 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`. */
1874
1874
  prefer_native_scheduling?: boolean | undefined
1875
- /** 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). */
1875
+ /** 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). */
1876
1876
  use_backup_access_code_pool?: boolean | undefined
1877
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
1877
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
1878
1878
  allow_external_modification?: boolean | undefined
1879
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
1879
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
1880
1880
  is_external_modification_allowed?: boolean | undefined
1881
1881
  use_offline_access_code?: boolean | undefined
1882
1882
  /** 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 {
8769
8769
  attempt_for_offline_device?: boolean
8770
8770
  /** 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`. */
8771
8771
  prefer_native_scheduling?: boolean | undefined
8772
- /** 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). */
8772
+ /** 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). */
8773
8773
  use_backup_access_code_pool?: boolean | undefined
8774
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
8774
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
8775
8775
  allow_external_modification?: boolean | undefined
8776
- /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
8776
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
8777
8777
  is_external_modification_allowed?: boolean | undefined
8778
8778
  /** 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. */
8779
8779
  preferred_code_length?: number | undefined
@@ -29940,7 +29940,9 @@ export interface Routes {
29940
29940
  queryParams: {}
29941
29941
  jsonBody: {}
29942
29942
  commonParams: {
29943
+ /** ID of the lock that you want to get. */
29943
29944
  device_id?: string | undefined
29945
+ /** Name of the lock that you want to get. */
29944
29946
  name?: string | undefined
29945
29947
  }
29946
29948
  formData: {}
@@ -32838,7 +32840,7 @@ export interface Routes {
32838
32840
  connected_account_ids?: string[] | undefined
32839
32841
  /** ID of the Connect Webview for which you want to list devices. */
32840
32842
  connect_webview_id?: string | undefined
32841
- /** Device type by which to filter devices. */
32843
+ /** Device type of the locks that you want to list. */
32842
32844
  device_type?:
32843
32845
  | (
32844
32846
  | 'akuvox_lock'
@@ -32870,7 +32872,7 @@ export interface Routes {
32870
32872
  | 'akiles_lock'
32871
32873
  )
32872
32874
  | undefined
32873
- /** Array of device types by which to filter devices. */
32875
+ /** Device types of the locks that you want to list. */
32874
32876
  device_types?:
32875
32877
  | Array<
32876
32878
  | 'akuvox_lock'
@@ -32902,7 +32904,7 @@ export interface Routes {
32902
32904
  | 'akiles_lock'
32903
32905
  >
32904
32906
  | undefined
32905
- /** Manufacturer by which to filter devices. */
32907
+ /** Manufacturer of the locks that you want to list. */
32906
32908
  manufacturer?:
32907
32909
  | (
32908
32910
  | 'akuvox'
@@ -35867,7 +35869,9 @@ export interface Routes {
35867
35869
  method: 'POST'
35868
35870
  queryParams: {}
35869
35871
  jsonBody: {
35872
+ /** ID of the lock that you want to lock. */
35870
35873
  device_id: string
35874
+ /** */
35871
35875
  sync?: boolean
35872
35876
  }
35873
35877
  commonParams: {}
@@ -37172,7 +37176,9 @@ export interface Routes {
37172
37176
  method: 'POST'
37173
37177
  queryParams: {}
37174
37178
  jsonBody: {
37179
+ /** ID of the device for which you want to simulate a keypad code entry. */
37175
37180
  device_id: string
37181
+ /** Code that you want to simulate entering on a keypad. */
37176
37182
  code: string
37177
37183
  }
37178
37184
  commonParams: {}
@@ -38477,6 +38483,7 @@ export interface Routes {
38477
38483
  method: 'POST'
38478
38484
  queryParams: {}
38479
38485
  jsonBody: {
38486
+ /** ID of the device for which you want to simulate a manual lock action using a keypad. */
38480
38487
  device_id: string
38481
38488
  }
38482
38489
  commonParams: {}
@@ -39781,7 +39788,9 @@ export interface Routes {
39781
39788
  method: 'POST'
39782
39789
  queryParams: {}
39783
39790
  jsonBody: {
39791
+ /** ID of the lock that you want to unlock. */
39784
39792
  device_id: string
39793
+ /** */
39785
39794
  sync?: boolean
39786
39795
  }
39787
39796
  commonParams: {}