@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.
@@ -16678,6 +16678,7 @@ declare const device: z.ZodObject<{
16678
16678
  }>, "many">>>;
16679
16679
  max_active_codes_supported: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
16680
16680
  supports_backup_access_code_pool: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
16681
+ backup_access_code_pool_enabled: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
16681
16682
  has_native_entry_events: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
16682
16683
  } & {
16683
16684
  locked: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
@@ -16731,6 +16732,7 @@ declare const device: z.ZodObject<{
16731
16732
  }[] | undefined;
16732
16733
  max_active_codes_supported?: number | undefined;
16733
16734
  supports_backup_access_code_pool?: boolean | undefined;
16735
+ backup_access_code_pool_enabled?: boolean | undefined;
16734
16736
  has_native_entry_events?: boolean | undefined;
16735
16737
  locked?: boolean | undefined;
16736
16738
  keypad_battery?: {
@@ -16779,6 +16781,7 @@ declare const device: z.ZodObject<{
16779
16781
  }[] | undefined;
16780
16782
  max_active_codes_supported?: number | undefined;
16781
16783
  supports_backup_access_code_pool?: boolean | undefined;
16784
+ backup_access_code_pool_enabled?: boolean | undefined;
16782
16785
  has_native_entry_events?: boolean | undefined;
16783
16786
  locked?: boolean | undefined;
16784
16787
  keypad_battery?: {
@@ -18818,6 +18821,7 @@ declare const device: z.ZodObject<{
18818
18821
  }[] | undefined;
18819
18822
  max_active_codes_supported?: number | undefined;
18820
18823
  supports_backup_access_code_pool?: boolean | undefined;
18824
+ backup_access_code_pool_enabled?: boolean | undefined;
18821
18825
  has_native_entry_events?: boolean | undefined;
18822
18826
  locked?: boolean | undefined;
18823
18827
  keypad_battery?: {
@@ -19608,6 +19612,7 @@ declare const device: z.ZodObject<{
19608
19612
  }[] | undefined;
19609
19613
  max_active_codes_supported?: number | undefined;
19610
19614
  supports_backup_access_code_pool?: boolean | undefined;
19615
+ backup_access_code_pool_enabled?: boolean | undefined;
19611
19616
  has_native_entry_events?: boolean | undefined;
19612
19617
  locked?: boolean | undefined;
19613
19618
  keypad_battery?: {
@@ -21777,6 +21782,7 @@ declare const unmanaged_device: z.ZodObject<Pick<{
21777
21782
  }>, "many">>>;
21778
21783
  max_active_codes_supported: z.ZodOptional<z.ZodOptional<z.ZodNumber>>;
21779
21784
  supports_backup_access_code_pool: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
21785
+ backup_access_code_pool_enabled: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
21780
21786
  has_native_entry_events: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
21781
21787
  } & {
21782
21788
  locked: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
@@ -21830,6 +21836,7 @@ declare const unmanaged_device: z.ZodObject<Pick<{
21830
21836
  }[] | undefined;
21831
21837
  max_active_codes_supported?: number | undefined;
21832
21838
  supports_backup_access_code_pool?: boolean | undefined;
21839
+ backup_access_code_pool_enabled?: boolean | undefined;
21833
21840
  has_native_entry_events?: boolean | undefined;
21834
21841
  locked?: boolean | undefined;
21835
21842
  keypad_battery?: {
@@ -21878,6 +21885,7 @@ declare const unmanaged_device: z.ZodObject<Pick<{
21878
21885
  }[] | undefined;
21879
21886
  max_active_codes_supported?: number | undefined;
21880
21887
  supports_backup_access_code_pool?: boolean | undefined;
21888
+ backup_access_code_pool_enabled?: boolean | undefined;
21881
21889
  has_native_entry_events?: boolean | undefined;
21882
21890
  locked?: boolean | undefined;
21883
21891
  keypad_battery?: {
@@ -42493,6 +42501,8 @@ type Routes = {
42493
42501
  max_active_codes_supported?: (number | undefined) | undefined;
42494
42502
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
42495
42503
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
42504
+ /** 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). */
42505
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
42496
42506
  /** Indicates whether the device supports native entry events. */
42497
42507
  has_native_entry_events?: (boolean | undefined) | undefined;
42498
42508
  /** Indicates whether the lock is locked. */
@@ -49206,6 +49216,8 @@ type Routes = {
49206
49216
  max_active_codes_supported?: (number | undefined) | undefined;
49207
49217
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
49208
49218
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
49219
+ /** 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). */
49220
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
49209
49221
  /** Indicates whether the device supports native entry events. */
49210
49222
  has_native_entry_events?: (boolean | undefined) | undefined;
49211
49223
  /** Indicates whether the lock is locked. */
@@ -71691,6 +71703,8 @@ type Routes = {
71691
71703
  max_active_codes_supported?: (number | undefined) | undefined;
71692
71704
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
71693
71705
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
71706
+ /** 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). */
71707
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
71694
71708
  /** Indicates whether the device supports native entry events. */
71695
71709
  has_native_entry_events?: (boolean | undefined) | undefined;
71696
71710
  /** Indicates whether the lock is locked. */
@@ -73198,6 +73212,8 @@ type Routes = {
73198
73212
  max_active_codes_supported?: (number | undefined) | undefined;
73199
73213
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
73200
73214
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
73215
+ /** 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). */
73216
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
73201
73217
  /** Indicates whether the device supports native entry events. */
73202
73218
  has_native_entry_events?: (boolean | undefined) | undefined;
73203
73219
  /** Indicates whether the lock is locked. */
@@ -75191,6 +75207,8 @@ type Routes = {
75191
75207
  custom_metadata?: {
75192
75208
  [x: string]: string | boolean | null;
75193
75209
  } | undefined;
75210
+ /** 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. */
75211
+ backup_access_code_pool_enabled?: boolean | undefined;
75194
75212
  };
75195
75213
  formData: {};
75196
75214
  jsonResponse: {};
@@ -83772,6 +83790,8 @@ type Routes = {
83772
83790
  max_active_codes_supported?: (number | undefined) | undefined;
83773
83791
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
83774
83792
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
83793
+ /** 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). */
83794
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
83775
83795
  /** Indicates whether the device supports native entry events. */
83776
83796
  has_native_entry_events?: (boolean | undefined) | undefined;
83777
83797
  /** Indicates whether the lock is locked. */
@@ -85229,6 +85249,8 @@ type Routes = {
85229
85249
  max_active_codes_supported?: (number | undefined) | undefined;
85230
85250
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
85231
85251
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
85252
+ /** 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). */
85253
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
85232
85254
  /** Indicates whether the device supports native entry events. */
85233
85255
  has_native_entry_events?: (boolean | undefined) | undefined;
85234
85256
  /** Indicates whether the lock is locked. */
@@ -86736,6 +86758,8 @@ type Routes = {
86736
86758
  max_active_codes_supported?: (number | undefined) | undefined;
86737
86759
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
86738
86760
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
86761
+ /** 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). */
86762
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
86739
86763
  /** Indicates whether the device supports native entry events. */
86740
86764
  has_native_entry_events?: (boolean | undefined) | undefined;
86741
86765
  /** Indicates whether the lock is locked. */
@@ -88192,6 +88216,8 @@ type Routes = {
88192
88216
  max_active_codes_supported?: (number | undefined) | undefined;
88193
88217
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
88194
88218
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
88219
+ /** 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). */
88220
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
88195
88221
  /** Indicates whether the device supports native entry events. */
88196
88222
  has_native_entry_events?: (boolean | undefined) | undefined;
88197
88223
  /** Indicates whether the lock is locked. */
@@ -96425,6 +96451,8 @@ type Routes = {
96425
96451
  max_active_codes_supported?: (number | undefined) | undefined;
96426
96452
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
96427
96453
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
96454
+ /** 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). */
96455
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
96428
96456
  /** Indicates whether the device supports native entry events. */
96429
96457
  has_native_entry_events?: (boolean | undefined) | undefined;
96430
96458
  /** Indicates whether the lock is locked. */
@@ -97881,6 +97909,8 @@ type Routes = {
97881
97909
  max_active_codes_supported?: (number | undefined) | undefined;
97882
97910
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
97883
97911
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
97912
+ /** 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). */
97913
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
97884
97914
  /** Indicates whether the device supports native entry events. */
97885
97915
  has_native_entry_events?: (boolean | undefined) | undefined;
97886
97916
  /** Indicates whether the lock is locked. */
@@ -104470,6 +104500,99 @@ type Routes = {
104470
104500
  };
104471
104501
  maxDuration: undefined;
104472
104502
  };
104503
+ '/seam/console/v1/lynx_migration/get_property_migration_status': {
104504
+ route: '/seam/console/v1/lynx_migration/get_property_migration_status';
104505
+ method: 'GET' | 'POST';
104506
+ queryParams: {};
104507
+ jsonBody: {};
104508
+ commonParams: {
104509
+ /** ID of the space (property) to get the migration status for. */
104510
+ space_id: string;
104511
+ };
104512
+ formData: {};
104513
+ jsonResponse: {
104514
+ lynx_migration_property_run: {
104515
+ lynx_migration_property_run_id: string;
104516
+ space_id: string;
104517
+ status: string;
104518
+ created_at: string;
104519
+ updated_at: string;
104520
+ child_status_counts: {
104521
+ [x: string]: number;
104522
+ };
104523
+ } | null;
104524
+ };
104525
+ maxDuration: undefined;
104526
+ };
104527
+ '/seam/console/v1/lynx_migration/get_reservation_migration_status': {
104528
+ route: '/seam/console/v1/lynx_migration/get_reservation_migration_status';
104529
+ method: 'GET' | 'POST';
104530
+ queryParams: {};
104531
+ jsonBody: {};
104532
+ commonParams: {
104533
+ /** ID of the access grant (reservation) to get the migration status for. */
104534
+ access_grant_id: string;
104535
+ };
104536
+ formData: {};
104537
+ jsonResponse: {
104538
+ lynx_migration_reservation_run: {
104539
+ lynx_migration_run_id: string;
104540
+ access_grant_id: string;
104541
+ status: string;
104542
+ created_at: string;
104543
+ updated_at: string;
104544
+ } | null;
104545
+ };
104546
+ maxDuration: undefined;
104547
+ };
104548
+ '/seam/console/v1/lynx_migration/list_property_reservations': {
104549
+ route: '/seam/console/v1/lynx_migration/list_property_reservations';
104550
+ method: 'GET' | 'POST';
104551
+ queryParams: {};
104552
+ jsonBody: {};
104553
+ commonParams: {
104554
+ /** ID of the space (property) to plan a Lynx migration for. */
104555
+ space_id: string;
104556
+ };
104557
+ formData: {};
104558
+ jsonResponse: {
104559
+ lynx_migration_property_plan: {
104560
+ space_id: string;
104561
+ total: number;
104562
+ eligible_count: number;
104563
+ eligible: {
104564
+ access_grant_id: string;
104565
+ guest_name: string | null;
104566
+ }[];
104567
+ skipped: {
104568
+ access_grant_id: string;
104569
+ guest_name: string | null;
104570
+ reason: string | null;
104571
+ }[];
104572
+ };
104573
+ };
104574
+ maxDuration: undefined;
104575
+ };
104576
+ '/seam/console/v1/lynx_migration/migrate_property': {
104577
+ route: '/seam/console/v1/lynx_migration/migrate_property';
104578
+ method: 'POST';
104579
+ queryParams: {};
104580
+ jsonBody: {};
104581
+ commonParams: {
104582
+ /** ID of the space (property) to migrate. */
104583
+ space_id: string;
104584
+ };
104585
+ formData: {};
104586
+ jsonResponse: {
104587
+ lynx_migration_property_run: {
104588
+ lynx_migration_property_run_id: string;
104589
+ space_id: string;
104590
+ status: string;
104591
+ already_running: boolean;
104592
+ };
104593
+ };
104594
+ maxDuration: undefined;
104595
+ };
104473
104596
  '/seam/console/v1/sites/create': {
104474
104597
  route: '/seam/console/v1/sites/create';
104475
104598
  method: 'POST';
@@ -113406,6 +113529,8 @@ type Routes = {
113406
113529
  max_active_codes_supported?: (number | undefined) | undefined;
113407
113530
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
113408
113531
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
113532
+ /** 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). */
113533
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
113409
113534
  /** Indicates whether the device supports native entry events. */
113410
113535
  has_native_entry_events?: (boolean | undefined) | undefined;
113411
113536
  /** Indicates whether the lock is locked. */
@@ -120870,6 +120995,8 @@ type Routes = {
120870
120995
  max_active_codes_supported?: (number | undefined) | undefined;
120871
120996
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
120872
120997
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
120998
+ /** 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). */
120999
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
120873
121000
  /** Indicates whether the device supports native entry events. */
120874
121001
  has_native_entry_events?: (boolean | undefined) | undefined;
120875
121002
  /** Indicates whether the lock is locked. */
@@ -125753,6 +125880,8 @@ type Routes = {
125753
125880
  max_active_codes_supported?: (number | undefined) | undefined;
125754
125881
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
125755
125882
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
125883
+ /** 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). */
125884
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
125756
125885
  /** Indicates whether the device supports native entry events. */
125757
125886
  has_native_entry_events?: (boolean | undefined) | undefined;
125758
125887
  /** Indicates whether the lock is locked. */
@@ -127209,6 +127338,8 @@ type Routes = {
127209
127338
  max_active_codes_supported?: (number | undefined) | undefined;
127210
127339
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
127211
127340
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
127341
+ /** 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). */
127342
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
127212
127343
  /** Indicates whether the device supports native entry events. */
127213
127344
  has_native_entry_events?: (boolean | undefined) | undefined;
127214
127345
  /** Indicates whether the lock is locked. */
@@ -136381,6 +136512,8 @@ type Routes = {
136381
136512
  max_active_codes_supported?: (number | undefined) | undefined;
136382
136513
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
136383
136514
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
136515
+ /** 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). */
136516
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
136384
136517
  /** Indicates whether the device supports native entry events. */
136385
136518
  has_native_entry_events?: (boolean | undefined) | undefined;
136386
136519
  /** Indicates whether the lock is locked. */
@@ -137839,6 +137972,8 @@ type Routes = {
137839
137972
  max_active_codes_supported?: (number | undefined) | undefined;
137840
137973
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
137841
137974
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
137975
+ /** 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). */
137976
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
137842
137977
  /** Indicates whether the device supports native entry events. */
137843
137978
  has_native_entry_events?: (boolean | undefined) | undefined;
137844
137979
  /** Indicates whether the lock is locked. */
@@ -140552,6 +140687,8 @@ type Routes = {
140552
140687
  max_active_codes_supported?: (number | undefined) | undefined;
140553
140688
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
140554
140689
  supports_backup_access_code_pool?: (boolean | undefined) | undefined;
140690
+ /** 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). */
140691
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined;
140555
140692
  /** Indicates whether the device supports native entry events. */
140556
140693
  has_native_entry_events?: (boolean | undefined) | undefined;
140557
140694
  /** Indicates whether the lock is locked. */