@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.
@@ -14444,6 +14444,10 @@ export type Routes = {
14444
14444
  supports_backup_access_code_pool?:
14445
14445
  | (boolean | undefined)
14446
14446
  | undefined
14447
+ /** 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). */
14448
+ backup_access_code_pool_enabled?:
14449
+ | (boolean | undefined)
14450
+ | undefined
14447
14451
  /** Indicates whether the device supports native entry events. */
14448
14452
  has_native_entry_events?: (boolean | undefined) | undefined
14449
14453
  /** Indicates whether the lock is locked. */
@@ -22348,6 +22352,10 @@ export type Routes = {
22348
22352
  supports_backup_access_code_pool?:
22349
22353
  | (boolean | undefined)
22350
22354
  | undefined
22355
+ /** 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). */
22356
+ backup_access_code_pool_enabled?:
22357
+ | (boolean | undefined)
22358
+ | undefined
22351
22359
  /** Indicates whether the device supports native entry events. */
22352
22360
  has_native_entry_events?: (boolean | undefined) | undefined
22353
22361
  /** Indicates whether the lock is locked. */
@@ -48615,6 +48623,8 @@ export type Routes = {
48615
48623
  max_active_codes_supported?: (number | undefined) | undefined
48616
48624
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
48617
48625
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
48626
+ /** 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). */
48627
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
48618
48628
  /** Indicates whether the device supports native entry events. */
48619
48629
  has_native_entry_events?: (boolean | undefined) | undefined
48620
48630
  /** Indicates whether the lock is locked. */
@@ -50665,6 +50675,8 @@ export type Routes = {
50665
50675
  max_active_codes_supported?: (number | undefined) | undefined
50666
50676
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
50667
50677
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
50678
+ /** 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). */
50679
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
50668
50680
  /** Indicates whether the device supports native entry events. */
50669
50681
  has_native_entry_events?: (boolean | undefined) | undefined
50670
50682
  /** Indicates whether the lock is locked. */
@@ -54610,6 +54622,8 @@ export type Routes = {
54610
54622
  [x: string]: string | boolean | null
54611
54623
  }
54612
54624
  | undefined
54625
+ /** 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. */
54626
+ backup_access_code_pool_enabled?: boolean | undefined
54613
54627
  }
54614
54628
  formData: {}
54615
54629
  jsonResponse: {}
@@ -64642,6 +64656,8 @@ export type Routes = {
64642
64656
  max_active_codes_supported?: (number | undefined) | undefined
64643
64657
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
64644
64658
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
64659
+ /** 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). */
64660
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
64645
64661
  /** Indicates whether the device supports native entry events. */
64646
64662
  has_native_entry_events?: (boolean | undefined) | undefined
64647
64663
  /** Indicates whether the lock is locked. */
@@ -66448,6 +66464,8 @@ export type Routes = {
66448
66464
  max_active_codes_supported?: (number | undefined) | undefined
66449
66465
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
66450
66466
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
66467
+ /** 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). */
66468
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
66451
66469
  /** Indicates whether the device supports native entry events. */
66452
66470
  has_native_entry_events?: (boolean | undefined) | undefined
66453
66471
  /** Indicates whether the lock is locked. */
@@ -68451,6 +68469,8 @@ export type Routes = {
68451
68469
  max_active_codes_supported?: (number | undefined) | undefined
68452
68470
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
68453
68471
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
68472
+ /** 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). */
68473
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
68454
68474
  /** Indicates whether the device supports native entry events. */
68455
68475
  has_native_entry_events?: (boolean | undefined) | undefined
68456
68476
  /** Indicates whether the lock is locked. */
@@ -70256,6 +70276,8 @@ export type Routes = {
70256
70276
  max_active_codes_supported?: (number | undefined) | undefined
70257
70277
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
70258
70278
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
70279
+ /** 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). */
70280
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
70259
70281
  /** Indicates whether the device supports native entry events. */
70260
70282
  has_native_entry_events?: (boolean | undefined) | undefined
70261
70283
  /** Indicates whether the lock is locked. */
@@ -79970,6 +79992,8 @@ export type Routes = {
79970
79992
  max_active_codes_supported?: (number | undefined) | undefined
79971
79993
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
79972
79994
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
79995
+ /** 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). */
79996
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
79973
79997
  /** Indicates whether the device supports native entry events. */
79974
79998
  has_native_entry_events?: (boolean | undefined) | undefined
79975
79999
  /** Indicates whether the lock is locked. */
@@ -81775,6 +81799,8 @@ export type Routes = {
81775
81799
  max_active_codes_supported?: (number | undefined) | undefined
81776
81800
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
81777
81801
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
81802
+ /** 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). */
81803
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
81778
81804
  /** Indicates whether the device supports native entry events. */
81779
81805
  has_native_entry_events?: (boolean | undefined) | undefined
81780
81806
  /** Indicates whether the lock is locked. */
@@ -89372,6 +89398,99 @@ export type Routes = {
89372
89398
  }
89373
89399
  maxDuration: undefined
89374
89400
  }
89401
+ '/seam/console/v1/lynx_migration/get_property_migration_status': {
89402
+ route: '/seam/console/v1/lynx_migration/get_property_migration_status'
89403
+ method: 'GET' | 'POST'
89404
+ queryParams: {}
89405
+ jsonBody: {}
89406
+ commonParams: {
89407
+ /** ID of the space (property) to get the migration status for. */
89408
+ space_id: string
89409
+ }
89410
+ formData: {}
89411
+ jsonResponse: {
89412
+ lynx_migration_property_run: {
89413
+ lynx_migration_property_run_id: string
89414
+ space_id: string
89415
+ status: string
89416
+ created_at: string
89417
+ updated_at: string
89418
+ child_status_counts: {
89419
+ [x: string]: number
89420
+ }
89421
+ } | null
89422
+ }
89423
+ maxDuration: undefined
89424
+ }
89425
+ '/seam/console/v1/lynx_migration/get_reservation_migration_status': {
89426
+ route: '/seam/console/v1/lynx_migration/get_reservation_migration_status'
89427
+ method: 'GET' | 'POST'
89428
+ queryParams: {}
89429
+ jsonBody: {}
89430
+ commonParams: {
89431
+ /** ID of the access grant (reservation) to get the migration status for. */
89432
+ access_grant_id: string
89433
+ }
89434
+ formData: {}
89435
+ jsonResponse: {
89436
+ lynx_migration_reservation_run: {
89437
+ lynx_migration_run_id: string
89438
+ access_grant_id: string
89439
+ status: string
89440
+ created_at: string
89441
+ updated_at: string
89442
+ } | null
89443
+ }
89444
+ maxDuration: undefined
89445
+ }
89446
+ '/seam/console/v1/lynx_migration/list_property_reservations': {
89447
+ route: '/seam/console/v1/lynx_migration/list_property_reservations'
89448
+ method: 'GET' | 'POST'
89449
+ queryParams: {}
89450
+ jsonBody: {}
89451
+ commonParams: {
89452
+ /** ID of the space (property) to plan a Lynx migration for. */
89453
+ space_id: string
89454
+ }
89455
+ formData: {}
89456
+ jsonResponse: {
89457
+ lynx_migration_property_plan: {
89458
+ space_id: string
89459
+ total: number
89460
+ eligible_count: number
89461
+ eligible: {
89462
+ access_grant_id: string
89463
+ guest_name: string | null
89464
+ }[]
89465
+ skipped: {
89466
+ access_grant_id: string
89467
+ guest_name: string | null
89468
+ reason: string | null
89469
+ }[]
89470
+ }
89471
+ }
89472
+ maxDuration: undefined
89473
+ }
89474
+ '/seam/console/v1/lynx_migration/migrate_property': {
89475
+ route: '/seam/console/v1/lynx_migration/migrate_property'
89476
+ method: 'POST'
89477
+ queryParams: {}
89478
+ jsonBody: {}
89479
+ commonParams: {
89480
+ /** ID of the space (property) to migrate. */
89481
+ space_id: string
89482
+ }
89483
+ formData: {}
89484
+ jsonResponse: {
89485
+ lynx_migration_property_run: {
89486
+ lynx_migration_property_run_id: string
89487
+ space_id: string
89488
+ status: string
89489
+ already_running: boolean
89490
+ }
89491
+ }
89492
+ maxDuration: undefined
89493
+ }
89375
89494
  '/seam/console/v1/sites/create': {
89376
89495
  route: '/seam/console/v1/sites/create'
89377
89496
  method: 'POST'
@@ -99921,6 +100040,10 @@ export type Routes = {
99921
100040
  supports_backup_access_code_pool?:
99922
100041
  | (boolean | undefined)
99923
100042
  | undefined
100043
+ /** 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). */
100044
+ backup_access_code_pool_enabled?:
100045
+ | (boolean | undefined)
100046
+ | undefined
99924
100047
  /** Indicates whether the device supports native entry events. */
99925
100048
  has_native_entry_events?: (boolean | undefined) | undefined
99926
100049
  /** Indicates whether the lock is locked. */
@@ -108716,6 +108839,8 @@ export type Routes = {
108716
108839
  max_active_codes_supported?: (number | undefined) | undefined
108717
108840
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
108718
108841
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
108842
+ /** 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). */
108843
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
108719
108844
  /** Indicates whether the device supports native entry events. */
108720
108845
  has_native_entry_events?: (boolean | undefined) | undefined
108721
108846
  /** Indicates whether the lock is locked. */
@@ -114565,6 +114690,8 @@ export type Routes = {
114565
114690
  max_active_codes_supported?: (number | undefined) | undefined
114566
114691
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
114567
114692
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
114693
+ /** 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). */
114694
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
114568
114695
  /** Indicates whether the device supports native entry events. */
114569
114696
  has_native_entry_events?: (boolean | undefined) | undefined
114570
114697
  /** Indicates whether the lock is locked. */
@@ -116370,6 +116497,8 @@ export type Routes = {
116370
116497
  max_active_codes_supported?: (number | undefined) | undefined
116371
116498
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
116372
116499
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
116500
+ /** 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). */
116501
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
116373
116502
  /** Indicates whether the device supports native entry events. */
116374
116503
  has_native_entry_events?: (boolean | undefined) | undefined
116375
116504
  /** Indicates whether the lock is locked. */
@@ -127019,6 +127148,8 @@ export type Routes = {
127019
127148
  max_active_codes_supported?: (number | undefined) | undefined
127020
127149
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
127021
127150
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
127151
+ /** 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). */
127152
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
127022
127153
  /** Indicates whether the device supports native entry events. */
127023
127154
  has_native_entry_events?: (boolean | undefined) | undefined
127024
127155
  /** Indicates whether the lock is locked. */
@@ -128826,6 +128957,8 @@ export type Routes = {
128826
128957
  max_active_codes_supported?: (number | undefined) | undefined
128827
128958
  /** Indicates whether the device supports a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes). */
128828
128959
  supports_backup_access_code_pool?: (boolean | undefined) | undefined
128960
+ /** 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). */
128961
+ backup_access_code_pool_enabled?: (boolean | undefined) | undefined
128829
128962
  /** Indicates whether the device supports native entry events. */
128830
128963
  has_native_entry_events?: (boolean | undefined) | undefined
128831
128964
  /** Indicates whether the lock is locked. */
@@ -132065,6 +132198,10 @@ export type Routes = {
132065
132198
  supports_backup_access_code_pool?:
132066
132199
  | (boolean | undefined)
132067
132200
  | undefined
132201
+ /** 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). */
132202
+ backup_access_code_pool_enabled?:
132203
+ | (boolean | undefined)
132204
+ | undefined
132068
132205
  /** Indicates whether the device supports native entry events. */
132069
132206
  has_native_entry_events?: (boolean | undefined) | undefined
132070
132207
  /** Indicates whether the lock is locked. */