@seamapi/types 1.938.0 → 1.940.0

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.
@@ -12603,6 +12603,8 @@ export type Routes = {
12603
12603
  max_active_codes_supported?: (number | undefined) | undefined;
12604
12604
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
12605
12605
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
12606
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
12607
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
12606
12608
  /** Indicates whether the device supports native entry events. */
12607
12609
  has_native_entry_events?: (boolean | undefined) | undefined;
12608
12610
  /** Indicates whether the lock is locked. */
@@ -19316,6 +19318,8 @@ export type Routes = {
19316
19318
  max_active_codes_supported?: (number | undefined) | undefined;
19317
19319
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
19318
19320
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
19321
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
19322
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
19319
19323
  /** Indicates whether the device supports native entry events. */
19320
19324
  has_native_entry_events?: (boolean | undefined) | undefined;
19321
19325
  /** Indicates whether the lock is locked. */
@@ -41801,6 +41805,8 @@ export type Routes = {
41801
41805
  max_active_codes_supported?: (number | undefined) | undefined;
41802
41806
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
41803
41807
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
41808
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
41809
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
41804
41810
  /** Indicates whether the device supports native entry events. */
41805
41811
  has_native_entry_events?: (boolean | undefined) | undefined;
41806
41812
  /** Indicates whether the lock is locked. */
@@ -43308,6 +43314,8 @@ export type Routes = {
43308
43314
  max_active_codes_supported?: (number | undefined) | undefined;
43309
43315
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
43310
43316
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
43317
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
43318
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
43311
43319
  /** Indicates whether the device supports native entry events. */
43312
43320
  has_native_entry_events?: (boolean | undefined) | undefined;
43313
43321
  /** Indicates whether the lock is locked. */
@@ -45301,6 +45309,8 @@ export type Routes = {
45301
45309
  custom_metadata?: {
45302
45310
  [x: string]: string | boolean | null;
45303
45311
  } | undefined;
45312
+ /** Indicates whether the device's [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is enabled. Set to `false` to disable the pool: Seam stops refilling it and removes any backup codes that have not yet been pulled into active use. */
45313
+ backup_access_code_pool_enabled?: boolean | undefined;
45304
45314
  };
45305
45315
  formData: {};
45306
45316
  jsonResponse: {};
@@ -53882,6 +53892,8 @@ export type Routes = {
53882
53892
  max_active_codes_supported?: (number | undefined) | undefined;
53883
53893
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
53884
53894
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
53895
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
53896
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
53885
53897
  /** Indicates whether the device supports native entry events. */
53886
53898
  has_native_entry_events?: (boolean | undefined) | undefined;
53887
53899
  /** Indicates whether the lock is locked. */
@@ -55339,6 +55351,8 @@ export type Routes = {
55339
55351
  max_active_codes_supported?: (number | undefined) | undefined;
55340
55352
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
55341
55353
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
55354
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
55355
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
55342
55356
  /** Indicates whether the device supports native entry events. */
55343
55357
  has_native_entry_events?: (boolean | undefined) | undefined;
55344
55358
  /** Indicates whether the lock is locked. */
@@ -56846,6 +56860,8 @@ export type Routes = {
56846
56860
  max_active_codes_supported?: (number | undefined) | undefined;
56847
56861
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
56848
56862
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
56863
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
56864
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
56849
56865
  /** Indicates whether the device supports native entry events. */
56850
56866
  has_native_entry_events?: (boolean | undefined) | undefined;
56851
56867
  /** Indicates whether the lock is locked. */
@@ -58302,6 +58318,8 @@ export type Routes = {
58302
58318
  max_active_codes_supported?: (number | undefined) | undefined;
58303
58319
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
58304
58320
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
58321
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
58322
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
58305
58323
  /** Indicates whether the device supports native entry events. */
58306
58324
  has_native_entry_events?: (boolean | undefined) | undefined;
58307
58325
  /** Indicates whether the lock is locked. */
@@ -66535,6 +66553,8 @@ export type Routes = {
66535
66553
  max_active_codes_supported?: (number | undefined) | undefined;
66536
66554
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
66537
66555
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
66556
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
66557
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
66538
66558
  /** Indicates whether the device supports native entry events. */
66539
66559
  has_native_entry_events?: (boolean | undefined) | undefined;
66540
66560
  /** Indicates whether the lock is locked. */
@@ -67991,6 +68011,8 @@ export type Routes = {
67991
68011
  max_active_codes_supported?: (number | undefined) | undefined;
67992
68012
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
67993
68013
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
68014
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
68015
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
67994
68016
  /** Indicates whether the device supports native entry events. */
67995
68017
  has_native_entry_events?: (boolean | undefined) | undefined;
67996
68018
  /** Indicates whether the lock is locked. */
@@ -74580,6 +74602,99 @@ export type Routes = {
74580
74602
  };
74581
74603
  maxDuration: undefined;
74582
74604
  };
74605
+ '/seam/console/v1/lynx_migration/get_property_migration_status': {
74606
+ route: '/seam/console/v1/lynx_migration/get_property_migration_status';
74607
+ method: 'GET' | 'POST';
74608
+ queryParams: {};
74609
+ jsonBody: {};
74610
+ commonParams: {
74611
+ /** ID of the space (property) to get the migration status for. */
74612
+ space_id: string;
74613
+ };
74614
+ formData: {};
74615
+ jsonResponse: {
74616
+ lynx_migration_property_run: {
74617
+ lynx_migration_property_run_id: string;
74618
+ space_id: string;
74619
+ status: string;
74620
+ created_at: string;
74621
+ updated_at: string;
74622
+ child_status_counts: {
74623
+ [x: string]: number;
74624
+ };
74625
+ } | null;
74626
+ };
74627
+ maxDuration: undefined;
74628
+ };
74629
+ '/seam/console/v1/lynx_migration/get_reservation_migration_status': {
74630
+ route: '/seam/console/v1/lynx_migration/get_reservation_migration_status';
74631
+ method: 'GET' | 'POST';
74632
+ queryParams: {};
74633
+ jsonBody: {};
74634
+ commonParams: {
74635
+ /** ID of the access grant (reservation) to get the migration status for. */
74636
+ access_grant_id: string;
74637
+ };
74638
+ formData: {};
74639
+ jsonResponse: {
74640
+ lynx_migration_reservation_run: {
74641
+ lynx_migration_run_id: string;
74642
+ access_grant_id: string;
74643
+ status: string;
74644
+ created_at: string;
74645
+ updated_at: string;
74646
+ } | null;
74647
+ };
74648
+ maxDuration: undefined;
74649
+ };
74650
+ '/seam/console/v1/lynx_migration/list_property_reservations': {
74651
+ route: '/seam/console/v1/lynx_migration/list_property_reservations';
74652
+ method: 'GET' | 'POST';
74653
+ queryParams: {};
74654
+ jsonBody: {};
74655
+ commonParams: {
74656
+ /** ID of the space (property) to plan a Lynx migration for. */
74657
+ space_id: string;
74658
+ };
74659
+ formData: {};
74660
+ jsonResponse: {
74661
+ lynx_migration_property_plan: {
74662
+ space_id: string;
74663
+ total: number;
74664
+ eligible_count: number;
74665
+ eligible: {
74666
+ access_grant_id: string;
74667
+ guest_name: string | null;
74668
+ }[];
74669
+ skipped: {
74670
+ access_grant_id: string;
74671
+ guest_name: string | null;
74672
+ reason: string | null;
74673
+ }[];
74674
+ };
74675
+ };
74676
+ maxDuration: undefined;
74677
+ };
74678
+ '/seam/console/v1/lynx_migration/migrate_property': {
74679
+ route: '/seam/console/v1/lynx_migration/migrate_property';
74680
+ method: 'POST';
74681
+ queryParams: {};
74682
+ jsonBody: {};
74683
+ commonParams: {
74684
+ /** ID of the space (property) to migrate. */
74685
+ space_id: string;
74686
+ };
74687
+ formData: {};
74688
+ jsonResponse: {
74689
+ lynx_migration_property_run: {
74690
+ lynx_migration_property_run_id: string;
74691
+ space_id: string;
74692
+ status: string;
74693
+ already_running: boolean;
74694
+ };
74695
+ };
74696
+ maxDuration: undefined;
74697
+ };
74583
74698
  '/seam/console/v1/sites/create': {
74584
74699
  route: '/seam/console/v1/sites/create';
74585
74700
  method: 'POST';
@@ -83516,6 +83631,8 @@ export type Routes = {
83516
83631
  max_active_codes_supported?: (number | undefined) | undefined;
83517
83632
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
83518
83633
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
83634
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
83635
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
83519
83636
  /** Indicates whether the device supports native entry events. */
83520
83637
  has_native_entry_events?: (boolean | undefined) | undefined;
83521
83638
  /** Indicates whether the lock is locked. */
@@ -90980,6 +91097,8 @@ export type Routes = {
90980
91097
  max_active_codes_supported?: (number | undefined) | undefined;
90981
91098
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
90982
91099
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
91100
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
91101
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
90983
91102
  /** Indicates whether the device supports native entry events. */
90984
91103
  has_native_entry_events?: (boolean | undefined) | undefined;
90985
91104
  /** Indicates whether the lock is locked. */
@@ -95863,6 +95982,8 @@ export type Routes = {
95863
95982
  max_active_codes_supported?: (number | undefined) | undefined;
95864
95983
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
95865
95984
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
95985
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
95986
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
95866
95987
  /** Indicates whether the device supports native entry events. */
95867
95988
  has_native_entry_events?: (boolean | undefined) | undefined;
95868
95989
  /** Indicates whether the lock is locked. */
@@ -97319,6 +97440,8 @@ export type Routes = {
97319
97440
  max_active_codes_supported?: (number | undefined) | undefined;
97320
97441
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
97321
97442
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
97443
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
97444
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
97322
97445
  /** Indicates whether the device supports native entry events. */
97323
97446
  has_native_entry_events?: (boolean | undefined) | undefined;
97324
97447
  /** Indicates whether the lock is locked. */
@@ -106491,6 +106614,8 @@ export type Routes = {
106491
106614
  max_active_codes_supported?: (number | undefined) | undefined;
106492
106615
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
106493
106616
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
106617
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
106618
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
106494
106619
  /** Indicates whether the device supports native entry events. */
106495
106620
  has_native_entry_events?: (boolean | undefined) | undefined;
106496
106621
  /** Indicates whether the lock is locked. */
@@ -107949,6 +108074,8 @@ export type Routes = {
107949
108074
  max_active_codes_supported?: (number | undefined) | undefined;
107950
108075
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
107951
108076
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
108077
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
108078
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
107952
108079
  /** Indicates whether the device supports native entry events. */
107953
108080
  has_native_entry_events?: (boolean | undefined) | undefined;
107954
108081
  /** Indicates whether the lock is locked. */
@@ -110662,6 +110789,8 @@ export type Routes = {
110662
110789
  max_active_codes_supported?: (number | undefined) | undefined;
110663
110790
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
110664
110791
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
110792
+ /** Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to `false` using [/devices/update](https://docs.seam.co/api/devices/update). */
110793
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
110665
110794
  /** Indicates whether the device supports native entry events. */
110666
110795
  has_native_entry_events?: (boolean | undefined) | undefined;
110667
110796
  /** Indicates whether the lock is locked. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.938.0",
3
+ "version": "1.940.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -153,6 +153,11 @@ export const access_code_capability_properties = z.object({
153
153
  property_group_key: access_codes
154
154
  ---
155
155
  Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes).`),
156
+ backup_access_code_pool_enabled: z.boolean().optional().describe(`
157
+ ---
158
+ property_group_key: access_codes
159
+ ---
160
+ Indicates whether the [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) is currently enabled for the device. To disable it, set this to \`false\` using [/devices/update](https://docs.seam.co/api/devices/update).`),
156
161
  has_native_entry_events: z.boolean().optional().describe(`
157
162
  ---
158
163
  property_group_key: access_codes