@seamapi/types 1.491.0 → 1.493.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.
@@ -13434,6 +13434,7 @@ export type Routes = {
13434
13434
  | 'brivo_group'
13435
13435
  | 'salto_space_group'
13436
13436
  | 'dormakaba_community_access_group'
13437
+ | 'dormakaba_ambiance_access_group'
13437
13438
  /**
13438
13439
  * @deprecated Use `external_type_display_name`.*/
13439
13440
  access_group_type_display_name: string
@@ -13446,6 +13447,7 @@ export type Routes = {
13446
13447
  | 'brivo_group'
13447
13448
  | 'salto_space_group'
13448
13449
  | 'dormakaba_community_access_group'
13450
+ | 'dormakaba_ambiance_access_group'
13449
13451
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
13450
13452
  external_type_display_name: string
13451
13453
  /** Date and time at which the access group was created. */
@@ -17256,6 +17258,7 @@ export type Routes = {
17256
17258
  | 'brivo_group'
17257
17259
  | 'salto_space_group'
17258
17260
  | 'dormakaba_community_access_group'
17261
+ | 'dormakaba_ambiance_access_group'
17259
17262
  /**
17260
17263
  * @deprecated Use `external_type_display_name`.*/
17261
17264
  access_group_type_display_name: string
@@ -17268,6 +17271,7 @@ export type Routes = {
17268
17271
  | 'brivo_group'
17269
17272
  | 'salto_space_group'
17270
17273
  | 'dormakaba_community_access_group'
17274
+ | 'dormakaba_ambiance_access_group'
17271
17275
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
17272
17276
  external_type_display_name: string
17273
17277
  /** Date and time at which the access group was created. */
@@ -19368,6 +19372,7 @@ export type Routes = {
19368
19372
  | 'brivo_group'
19369
19373
  | 'salto_space_group'
19370
19374
  | 'dormakaba_community_access_group'
19375
+ | 'dormakaba_ambiance_access_group'
19371
19376
  /**
19372
19377
  * @deprecated Use `external_type_display_name`.*/
19373
19378
  access_group_type_display_name: string
@@ -19380,6 +19385,7 @@ export type Routes = {
19380
19385
  | 'brivo_group'
19381
19386
  | 'salto_space_group'
19382
19387
  | 'dormakaba_community_access_group'
19388
+ | 'dormakaba_ambiance_access_group'
19383
19389
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
19384
19390
  external_type_display_name: string
19385
19391
  /** Date and time at which the access group was created. */
@@ -22194,6 +22200,1112 @@ export type Routes = {
22194
22200
  | undefined
22195
22201
  }[]
22196
22202
  | undefined
22203
+ access_codes?:
22204
+ | {
22205
+ /** Unique identifier for a group of access codes that share the same code. */
22206
+ common_code_key: string | null
22207
+ /** Indicates whether the code is set on the device according to a preconfigured schedule. */
22208
+ is_scheduled_on_device?: boolean | undefined
22209
+ /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
22210
+ type: 'time_bound' | 'ongoing'
22211
+ /** Indicates whether the access code is waiting for a code assignment. */
22212
+ is_waiting_for_code_assignment?: boolean | undefined
22213
+ /** Unique identifier for the access code. */
22214
+ access_code_id: string
22215
+ /** Unique identifier for the device associated with the access code. */
22216
+ device_id: string
22217
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
22218
+ name: string | null
22219
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
22220
+ code: string | null
22221
+ /** Date and time at which the access code was created. */
22222
+ created_at: string
22223
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
22224
+ errors: (
22225
+ | {
22226
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22227
+ message: string
22228
+ /** Indicates that this is an access code error. */
22229
+ is_access_code_error: true
22230
+ /** Date and time at which Seam created the error. */
22231
+ created_at?: string | undefined
22232
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22233
+ error_code: 'smartthings_failed_to_set_access_code'
22234
+ }
22235
+ | {
22236
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22237
+ message: string
22238
+ /** Indicates that this is an access code error. */
22239
+ is_access_code_error: true
22240
+ /** Date and time at which Seam created the error. */
22241
+ created_at?: string | undefined
22242
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22243
+ error_code: 'smartthings_failed_to_set_after_multiple_retries'
22244
+ }
22245
+ | {
22246
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22247
+ message: string
22248
+ /** Indicates that this is an access code error. */
22249
+ is_access_code_error: true
22250
+ /** Date and time at which Seam created the error. */
22251
+ created_at?: string | undefined
22252
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22253
+ error_code: 'smartthings_no_free_slots_available'
22254
+ }
22255
+ | {
22256
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22257
+ message: string
22258
+ /** Indicates that this is an access code error. */
22259
+ is_access_code_error: true
22260
+ /** Date and time at which Seam created the error. */
22261
+ created_at?: string | undefined
22262
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22263
+ error_code: 'failed_to_set_on_device'
22264
+ }
22265
+ | {
22266
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22267
+ message: string
22268
+ /** Indicates that this is an access code error. */
22269
+ is_access_code_error: true
22270
+ /** Date and time at which Seam created the error. */
22271
+ created_at?: string | undefined
22272
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22273
+ error_code: 'failed_to_remove_from_device'
22274
+ }
22275
+ | {
22276
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22277
+ message: string
22278
+ /** Indicates that this is an access code error. */
22279
+ is_access_code_error: true
22280
+ /** Date and time at which Seam created the error. */
22281
+ created_at?: string | undefined
22282
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22283
+ error_code: 'duplicate_code_on_device'
22284
+ }
22285
+ | {
22286
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22287
+ message: string
22288
+ /** Indicates that this is an access code error. */
22289
+ is_access_code_error: true
22290
+ /** Date and time at which Seam created the error. */
22291
+ created_at?: string | undefined
22292
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22293
+ error_code: 'duplicate_code_attempt_prevented'
22294
+ }
22295
+ | {
22296
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22297
+ message: string
22298
+ /** Indicates that this is an access code error. */
22299
+ is_access_code_error: true
22300
+ /** Date and time at which Seam created the error. */
22301
+ created_at?: string | undefined
22302
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22303
+ error_code: 'no_space_for_access_code_on_device'
22304
+ }
22305
+ | {
22306
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22307
+ message: string
22308
+ /** Indicates that this is an access code error. */
22309
+ is_access_code_error: true
22310
+ /** Date and time at which Seam created the error. */
22311
+ created_at?: string | undefined
22312
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22313
+ error_code: 'igloohome_bridge_too_many_pending_jobs'
22314
+ }
22315
+ | {
22316
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22317
+ message: string
22318
+ /** Indicates that this is an access code error. */
22319
+ is_access_code_error: true
22320
+ /** Date and time at which Seam created the error. */
22321
+ created_at?: string | undefined
22322
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22323
+ error_code: 'igloohome_bridge_offline'
22324
+ }
22325
+ | {
22326
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22327
+ message: string
22328
+ /** Indicates that this is an access code error. */
22329
+ is_access_code_error: true
22330
+ /** Date and time at which Seam created the error. */
22331
+ created_at?: string | undefined
22332
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22333
+ error_code: 'igloohome_offline_access_code_no_variance_available'
22334
+ }
22335
+ | {
22336
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22337
+ message: string
22338
+ /** Indicates that this is an access code error. */
22339
+ is_access_code_error: true
22340
+ /** Date and time at which Seam created the error. */
22341
+ created_at?: string | undefined
22342
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22343
+ error_code: 'kwikset_unable_to_confirm_code'
22344
+ }
22345
+ | {
22346
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22347
+ message: string
22348
+ /** Indicates that this is an access code error. */
22349
+ is_access_code_error: true
22350
+ /** Date and time at which Seam created the error. */
22351
+ created_at?: string | undefined
22352
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22353
+ error_code: 'kwikset_unable_to_confirm_deletion'
22354
+ }
22355
+ | {
22356
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22357
+ message: string
22358
+ /** Indicates that this is an access code error. */
22359
+ is_access_code_error: true
22360
+ /** Date and time at which Seam created the error. */
22361
+ created_at?: string | undefined
22362
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22363
+ error_code: 'code_modified_external_to_seam'
22364
+ }
22365
+ | {
22366
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22367
+ message: string
22368
+ /** Indicates that this is an access code error. */
22369
+ is_access_code_error: true
22370
+ /** Date and time at which Seam created the error. */
22371
+ created_at?: string | undefined
22372
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22373
+ error_code: 'august_lock_invalid_code_length'
22374
+ }
22375
+ | {
22376
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22377
+ message: string
22378
+ /** Indicates that this is an access code error. */
22379
+ is_access_code_error: true
22380
+ /** Date and time at which Seam created the error. */
22381
+ created_at?: string | undefined
22382
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22383
+ error_code: 'august_device_programming_delay'
22384
+ }
22385
+ | {
22386
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22387
+ message: string
22388
+ /** Indicates that this is an access code error. */
22389
+ is_access_code_error: true
22390
+ /** Date and time at which Seam created the error. */
22391
+ created_at?: string | undefined
22392
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22393
+ error_code: 'august_device_slots_full'
22394
+ }
22395
+ | {
22396
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22397
+ message: string
22398
+ /** Indicates that this is an access code error. */
22399
+ is_access_code_error: true
22400
+ /** Date and time at which Seam created the error. */
22401
+ created_at?: string | undefined
22402
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22403
+ error_code: 'august_lock_missing_keypad'
22404
+ }
22405
+ | {
22406
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22407
+ message: string
22408
+ /** Indicates that this is an access code error. */
22409
+ is_access_code_error: true
22410
+ /** Date and time at which Seam created the error. */
22411
+ created_at?: string | undefined
22412
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22413
+ error_code: 'august_lock_temporarily_offline'
22414
+ }
22415
+ | {
22416
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22417
+ message: string
22418
+ /** Indicates that this is an access code error. */
22419
+ is_access_code_error: true
22420
+ /** Date and time at which Seam created the error. */
22421
+ created_at?: string | undefined
22422
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22423
+ error_code: 'salto_ks_user_not_subscribed'
22424
+ }
22425
+ | {
22426
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22427
+ message: string
22428
+ /** Indicates that this is an access code error. */
22429
+ is_access_code_error: true
22430
+ /** Date and time at which Seam created the error. */
22431
+ created_at?: string | undefined
22432
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22433
+ error_code: 'hubitat_device_programming_delay'
22434
+ }
22435
+ | {
22436
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22437
+ message: string
22438
+ /** Indicates that this is an access code error. */
22439
+ is_access_code_error: true
22440
+ /** Date and time at which Seam created the error. */
22441
+ created_at?: string | undefined
22442
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22443
+ error_code: 'hubitat_no_free_positions_available'
22444
+ }
22445
+ | {
22446
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22447
+ message: string
22448
+ /** Indicates that this is an access code error. */
22449
+ is_access_code_error: true
22450
+ /** Date and time at which Seam created the error. */
22451
+ created_at?: string | undefined
22452
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22453
+ error_code: 'wyze_duplicate_code_name'
22454
+ }
22455
+ | {
22456
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22457
+ message: string
22458
+ /** Indicates that this is an access code error. */
22459
+ is_access_code_error: true
22460
+ /** Date and time at which Seam created the error. */
22461
+ created_at?: string | undefined
22462
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22463
+ error_code: 'wyze_potential_duplicate_code'
22464
+ }
22465
+ | {
22466
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22467
+ message: string
22468
+ /** Indicates that this is an access code error. */
22469
+ is_access_code_error: true
22470
+ /** Date and time at which Seam created the error. */
22471
+ created_at?: string | undefined
22472
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22473
+ error_code: 'dormakaba_oracode_no_valid_user_level'
22474
+ }
22475
+ | {
22476
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22477
+ message: string
22478
+ /** Indicates that the error is not a device error. */
22479
+ is_device_error: false
22480
+ /** Date and time at which Seam created the error. */
22481
+ created_at: string
22482
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22483
+ error_code: 'account_disconnected'
22484
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
22485
+ is_connected_account_error: true
22486
+ }
22487
+ | {
22488
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22489
+ message: string
22490
+ /** Indicates that the error is not a device error. */
22491
+ is_device_error: false
22492
+ /** Date and time at which Seam created the error. */
22493
+ created_at: string
22494
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22495
+ error_code: 'salto_ks_subscription_limit_exceeded'
22496
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
22497
+ is_connected_account_error: true
22498
+ }
22499
+ | {
22500
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22501
+ message: string
22502
+ /** Indicates that the error is a device error. */
22503
+ is_device_error: true
22504
+ /** Date and time at which Seam created the error. */
22505
+ created_at: string
22506
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22507
+ error_code: 'device_offline'
22508
+ }
22509
+ | {
22510
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22511
+ message: string
22512
+ /** Indicates that the error is a device error. */
22513
+ is_device_error: true
22514
+ /** Date and time at which Seam created the error. */
22515
+ created_at: string
22516
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22517
+ error_code: 'device_removed'
22518
+ }
22519
+ | {
22520
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22521
+ message: string
22522
+ /** Indicates that the error is a device error. */
22523
+ is_device_error: true
22524
+ /** Date and time at which Seam created the error. */
22525
+ created_at: string
22526
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22527
+ error_code: 'hub_disconnected'
22528
+ }
22529
+ | {
22530
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22531
+ message: string
22532
+ /** Indicates that the error is a device error. */
22533
+ is_device_error: true
22534
+ /** Date and time at which Seam created the error. */
22535
+ created_at: string
22536
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22537
+ error_code: 'device_disconnected'
22538
+ }
22539
+ | {
22540
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22541
+ message: string
22542
+ /** Indicates that the error is a device error. */
22543
+ is_device_error: true
22544
+ /** Date and time at which Seam created the error. */
22545
+ created_at: string
22546
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22547
+ error_code: 'empty_backup_access_code_pool'
22548
+ }
22549
+ | {
22550
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22551
+ message: string
22552
+ /** Indicates that the error is a device error. */
22553
+ is_device_error: true
22554
+ /** Date and time at which Seam created the error. */
22555
+ created_at: string
22556
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22557
+ error_code: 'august_lock_not_authorized'
22558
+ }
22559
+ | {
22560
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22561
+ message: string
22562
+ /** Indicates that the error is a device error. */
22563
+ is_device_error: true
22564
+ /** Date and time at which Seam created the error. */
22565
+ created_at: string
22566
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22567
+ error_code: 'august_lock_missing_bridge'
22568
+ }
22569
+ | {
22570
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22571
+ message: string
22572
+ /** Indicates that the error is a device error. */
22573
+ is_device_error: true
22574
+ /** Date and time at which Seam created the error. */
22575
+ created_at: string
22576
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22577
+ error_code: 'ttlock_lock_not_paired_to_gateway'
22578
+ }
22579
+ | {
22580
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22581
+ message: string
22582
+ /** Indicates that the error is a device error. */
22583
+ is_device_error: true
22584
+ /** Date and time at which Seam created the error. */
22585
+ created_at: string
22586
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22587
+ error_code: 'missing_device_credentials'
22588
+ }
22589
+ | {
22590
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22591
+ message: string
22592
+ /** Indicates that the error is a device error. */
22593
+ is_device_error: true
22594
+ /** Date and time at which Seam created the error. */
22595
+ created_at: string
22596
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22597
+ error_code: 'auxiliary_heat_running'
22598
+ }
22599
+ | {
22600
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22601
+ message: string
22602
+ /** Indicates that the error is a device error. */
22603
+ is_device_error: true
22604
+ /** Date and time at which Seam created the error. */
22605
+ created_at: string
22606
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22607
+ error_code: 'subscription_required'
22608
+ }
22609
+ | {
22610
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22611
+ message: string
22612
+ /** Indicates that the error is a device error. */
22613
+ is_device_error: true
22614
+ /** Date and time at which Seam created the error. */
22615
+ created_at: string
22616
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22617
+ error_code: 'lockly_missing_wifi_bridge'
22618
+ }
22619
+ | {
22620
+ /** Date and time at which Seam created the error. */
22621
+ created_at: string
22622
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22623
+ message: string
22624
+ /** Indicates whether the error is related specifically to the connected account. */
22625
+ is_connected_account_error?: boolean | undefined
22626
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
22627
+ is_bridge_error?: boolean | undefined
22628
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22629
+ error_code: 'invalid_credentials'
22630
+ }
22631
+ | {
22632
+ /** Date and time at which Seam created the error. */
22633
+ created_at: string
22634
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22635
+ message: string
22636
+ /** Indicates whether the error is related specifically to the connected account. */
22637
+ is_connected_account_error?: boolean | undefined
22638
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
22639
+ is_bridge_error?: boolean | undefined
22640
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22641
+ error_code: 'bridge_disconnected'
22642
+ }
22643
+ )[]
22644
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
22645
+ warnings: (
22646
+ | {
22647
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22648
+ message: string
22649
+ /** Date and time at which Seam created the warning. */
22650
+ created_at?: string | undefined
22651
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22652
+ warning_code: 'smartthings_failed_to_set_access_code'
22653
+ }
22654
+ | {
22655
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22656
+ message: string
22657
+ /** Date and time at which Seam created the warning. */
22658
+ created_at?: string | undefined
22659
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22660
+ warning_code: 'schlage_detected_duplicate'
22661
+ }
22662
+ | {
22663
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22664
+ message: string
22665
+ /** Date and time at which Seam created the warning. */
22666
+ created_at?: string | undefined
22667
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22668
+ warning_code: 'schlage_creation_outage'
22669
+ }
22670
+ | {
22671
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22672
+ message: string
22673
+ /** Date and time at which Seam created the warning. */
22674
+ created_at?: string | undefined
22675
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22676
+ warning_code: 'code_modified_external_to_seam'
22677
+ }
22678
+ | {
22679
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22680
+ message: string
22681
+ /** Date and time at which Seam created the warning. */
22682
+ created_at?: string | undefined
22683
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22684
+ warning_code: 'delay_in_setting_on_device'
22685
+ }
22686
+ | {
22687
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22688
+ message: string
22689
+ /** Date and time at which Seam created the warning. */
22690
+ created_at?: string | undefined
22691
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22692
+ warning_code: 'delay_in_removing_from_device'
22693
+ }
22694
+ | {
22695
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22696
+ message: string
22697
+ /** Date and time at which Seam created the warning. */
22698
+ created_at?: string | undefined
22699
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22700
+ warning_code: 'third_party_integration_detected'
22701
+ }
22702
+ | {
22703
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22704
+ message: string
22705
+ /** Date and time at which Seam created the warning. */
22706
+ created_at?: string | undefined
22707
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22708
+ warning_code: 'august_device_programming_delay'
22709
+ }
22710
+ | {
22711
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22712
+ message: string
22713
+ /** Date and time at which Seam created the warning. */
22714
+ created_at?: string | undefined
22715
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22716
+ warning_code: 'august_lock_temporarily_offline'
22717
+ }
22718
+ | {
22719
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22720
+ message: string
22721
+ /** Date and time at which Seam created the warning. */
22722
+ created_at?: string | undefined
22723
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22724
+ warning_code: 'igloo_algopin_must_be_used_within_24_hours'
22725
+ }
22726
+ | {
22727
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22728
+ message: string
22729
+ /** Date and time at which Seam created the warning. */
22730
+ created_at?: string | undefined
22731
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22732
+ warning_code: 'management_transferred'
22733
+ }
22734
+ | {
22735
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
22736
+ message: string
22737
+ /** Date and time at which Seam created the warning. */
22738
+ created_at?: string | undefined
22739
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
22740
+ warning_code: 'kwikset_unable_to_confirm_code'
22741
+ }
22742
+ )[]
22743
+ /** Indicates whether Seam manages the access code. */
22744
+ is_managed: true
22745
+ /** Date and time at which the time-bound access code becomes active. */
22746
+ starts_at?: (string | null) | undefined
22747
+ /** Date and time after which the time-bound access code becomes inactive. */
22748
+ ends_at?: (string | null) | undefined
22749
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
22750
+ status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
22751
+ /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
22752
+ is_backup_access_code_available: boolean
22753
+ /** Indicates whether the access code is a backup code. */
22754
+ is_backup?: boolean | undefined
22755
+ /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
22756
+ pulled_backup_access_code_id?: (string | null) | undefined
22757
+ /** Indicates whether changes to the access code from external sources are permitted. */
22758
+ is_external_modification_allowed: boolean
22759
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
22760
+ is_one_time_use: boolean
22761
+ /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
22762
+ is_offline_access_code: boolean
22763
+ }[]
22764
+ | undefined
22765
+ unmanaged_access_codes?:
22766
+ | {
22767
+ /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
22768
+ type: 'time_bound' | 'ongoing'
22769
+ /** Unique identifier for the access code. */
22770
+ access_code_id: string
22771
+ /** Unique identifier for the device associated with the access code. */
22772
+ device_id: string
22773
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
22774
+ name: string | null
22775
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
22776
+ code: string | null
22777
+ /** Date and time at which the access code was created. */
22778
+ created_at: string
22779
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
22780
+ errors: (
22781
+ | {
22782
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22783
+ message: string
22784
+ /** Indicates that this is an access code error. */
22785
+ is_access_code_error: true
22786
+ /** Date and time at which Seam created the error. */
22787
+ created_at?: string | undefined
22788
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22789
+ error_code: 'smartthings_failed_to_set_access_code'
22790
+ }
22791
+ | {
22792
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22793
+ message: string
22794
+ /** Indicates that this is an access code error. */
22795
+ is_access_code_error: true
22796
+ /** Date and time at which Seam created the error. */
22797
+ created_at?: string | undefined
22798
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22799
+ error_code: 'smartthings_failed_to_set_after_multiple_retries'
22800
+ }
22801
+ | {
22802
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22803
+ message: string
22804
+ /** Indicates that this is an access code error. */
22805
+ is_access_code_error: true
22806
+ /** Date and time at which Seam created the error. */
22807
+ created_at?: string | undefined
22808
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22809
+ error_code: 'smartthings_no_free_slots_available'
22810
+ }
22811
+ | {
22812
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22813
+ message: string
22814
+ /** Indicates that this is an access code error. */
22815
+ is_access_code_error: true
22816
+ /** Date and time at which Seam created the error. */
22817
+ created_at?: string | undefined
22818
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22819
+ error_code: 'failed_to_set_on_device'
22820
+ }
22821
+ | {
22822
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22823
+ message: string
22824
+ /** Indicates that this is an access code error. */
22825
+ is_access_code_error: true
22826
+ /** Date and time at which Seam created the error. */
22827
+ created_at?: string | undefined
22828
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22829
+ error_code: 'failed_to_remove_from_device'
22830
+ }
22831
+ | {
22832
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22833
+ message: string
22834
+ /** Indicates that this is an access code error. */
22835
+ is_access_code_error: true
22836
+ /** Date and time at which Seam created the error. */
22837
+ created_at?: string | undefined
22838
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22839
+ error_code: 'duplicate_code_on_device'
22840
+ }
22841
+ | {
22842
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22843
+ message: string
22844
+ /** Indicates that this is an access code error. */
22845
+ is_access_code_error: true
22846
+ /** Date and time at which Seam created the error. */
22847
+ created_at?: string | undefined
22848
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22849
+ error_code: 'duplicate_code_attempt_prevented'
22850
+ }
22851
+ | {
22852
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22853
+ message: string
22854
+ /** Indicates that this is an access code error. */
22855
+ is_access_code_error: true
22856
+ /** Date and time at which Seam created the error. */
22857
+ created_at?: string | undefined
22858
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22859
+ error_code: 'no_space_for_access_code_on_device'
22860
+ }
22861
+ | {
22862
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22863
+ message: string
22864
+ /** Indicates that this is an access code error. */
22865
+ is_access_code_error: true
22866
+ /** Date and time at which Seam created the error. */
22867
+ created_at?: string | undefined
22868
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22869
+ error_code: 'igloohome_bridge_too_many_pending_jobs'
22870
+ }
22871
+ | {
22872
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22873
+ message: string
22874
+ /** Indicates that this is an access code error. */
22875
+ is_access_code_error: true
22876
+ /** Date and time at which Seam created the error. */
22877
+ created_at?: string | undefined
22878
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22879
+ error_code: 'igloohome_bridge_offline'
22880
+ }
22881
+ | {
22882
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22883
+ message: string
22884
+ /** Indicates that this is an access code error. */
22885
+ is_access_code_error: true
22886
+ /** Date and time at which Seam created the error. */
22887
+ created_at?: string | undefined
22888
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22889
+ error_code: 'igloohome_offline_access_code_no_variance_available'
22890
+ }
22891
+ | {
22892
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22893
+ message: string
22894
+ /** Indicates that this is an access code error. */
22895
+ is_access_code_error: true
22896
+ /** Date and time at which Seam created the error. */
22897
+ created_at?: string | undefined
22898
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22899
+ error_code: 'kwikset_unable_to_confirm_code'
22900
+ }
22901
+ | {
22902
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22903
+ message: string
22904
+ /** Indicates that this is an access code error. */
22905
+ is_access_code_error: true
22906
+ /** Date and time at which Seam created the error. */
22907
+ created_at?: string | undefined
22908
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22909
+ error_code: 'kwikset_unable_to_confirm_deletion'
22910
+ }
22911
+ | {
22912
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22913
+ message: string
22914
+ /** Indicates that this is an access code error. */
22915
+ is_access_code_error: true
22916
+ /** Date and time at which Seam created the error. */
22917
+ created_at?: string | undefined
22918
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22919
+ error_code: 'code_modified_external_to_seam'
22920
+ }
22921
+ | {
22922
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22923
+ message: string
22924
+ /** Indicates that this is an access code error. */
22925
+ is_access_code_error: true
22926
+ /** Date and time at which Seam created the error. */
22927
+ created_at?: string | undefined
22928
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22929
+ error_code: 'august_lock_invalid_code_length'
22930
+ }
22931
+ | {
22932
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22933
+ message: string
22934
+ /** Indicates that this is an access code error. */
22935
+ is_access_code_error: true
22936
+ /** Date and time at which Seam created the error. */
22937
+ created_at?: string | undefined
22938
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22939
+ error_code: 'august_device_programming_delay'
22940
+ }
22941
+ | {
22942
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22943
+ message: string
22944
+ /** Indicates that this is an access code error. */
22945
+ is_access_code_error: true
22946
+ /** Date and time at which Seam created the error. */
22947
+ created_at?: string | undefined
22948
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22949
+ error_code: 'august_device_slots_full'
22950
+ }
22951
+ | {
22952
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22953
+ message: string
22954
+ /** Indicates that this is an access code error. */
22955
+ is_access_code_error: true
22956
+ /** Date and time at which Seam created the error. */
22957
+ created_at?: string | undefined
22958
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22959
+ error_code: 'august_lock_missing_keypad'
22960
+ }
22961
+ | {
22962
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22963
+ message: string
22964
+ /** Indicates that this is an access code error. */
22965
+ is_access_code_error: true
22966
+ /** Date and time at which Seam created the error. */
22967
+ created_at?: string | undefined
22968
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22969
+ error_code: 'august_lock_temporarily_offline'
22970
+ }
22971
+ | {
22972
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22973
+ message: string
22974
+ /** Indicates that this is an access code error. */
22975
+ is_access_code_error: true
22976
+ /** Date and time at which Seam created the error. */
22977
+ created_at?: string | undefined
22978
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22979
+ error_code: 'salto_ks_user_not_subscribed'
22980
+ }
22981
+ | {
22982
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22983
+ message: string
22984
+ /** Indicates that this is an access code error. */
22985
+ is_access_code_error: true
22986
+ /** Date and time at which Seam created the error. */
22987
+ created_at?: string | undefined
22988
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22989
+ error_code: 'hubitat_device_programming_delay'
22990
+ }
22991
+ | {
22992
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22993
+ message: string
22994
+ /** Indicates that this is an access code error. */
22995
+ is_access_code_error: true
22996
+ /** Date and time at which Seam created the error. */
22997
+ created_at?: string | undefined
22998
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
22999
+ error_code: 'hubitat_no_free_positions_available'
23000
+ }
23001
+ | {
23002
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23003
+ message: string
23004
+ /** Indicates that this is an access code error. */
23005
+ is_access_code_error: true
23006
+ /** Date and time at which Seam created the error. */
23007
+ created_at?: string | undefined
23008
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23009
+ error_code: 'wyze_duplicate_code_name'
23010
+ }
23011
+ | {
23012
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23013
+ message: string
23014
+ /** Indicates that this is an access code error. */
23015
+ is_access_code_error: true
23016
+ /** Date and time at which Seam created the error. */
23017
+ created_at?: string | undefined
23018
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23019
+ error_code: 'wyze_potential_duplicate_code'
23020
+ }
23021
+ | {
23022
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23023
+ message: string
23024
+ /** Indicates that this is an access code error. */
23025
+ is_access_code_error: true
23026
+ /** Date and time at which Seam created the error. */
23027
+ created_at?: string | undefined
23028
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23029
+ error_code: 'dormakaba_oracode_no_valid_user_level'
23030
+ }
23031
+ | {
23032
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23033
+ message: string
23034
+ /** Indicates that the error is not a device error. */
23035
+ is_device_error: false
23036
+ /** Date and time at which Seam created the error. */
23037
+ created_at: string
23038
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23039
+ error_code: 'account_disconnected'
23040
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
23041
+ is_connected_account_error: true
23042
+ }
23043
+ | {
23044
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23045
+ message: string
23046
+ /** Indicates that the error is not a device error. */
23047
+ is_device_error: false
23048
+ /** Date and time at which Seam created the error. */
23049
+ created_at: string
23050
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23051
+ error_code: 'salto_ks_subscription_limit_exceeded'
23052
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
23053
+ is_connected_account_error: true
23054
+ }
23055
+ | {
23056
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23057
+ message: string
23058
+ /** Indicates that the error is a device error. */
23059
+ is_device_error: true
23060
+ /** Date and time at which Seam created the error. */
23061
+ created_at: string
23062
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23063
+ error_code: 'device_offline'
23064
+ }
23065
+ | {
23066
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23067
+ message: string
23068
+ /** Indicates that the error is a device error. */
23069
+ is_device_error: true
23070
+ /** Date and time at which Seam created the error. */
23071
+ created_at: string
23072
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23073
+ error_code: 'device_removed'
23074
+ }
23075
+ | {
23076
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23077
+ message: string
23078
+ /** Indicates that the error is a device error. */
23079
+ is_device_error: true
23080
+ /** Date and time at which Seam created the error. */
23081
+ created_at: string
23082
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23083
+ error_code: 'hub_disconnected'
23084
+ }
23085
+ | {
23086
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23087
+ message: string
23088
+ /** Indicates that the error is a device error. */
23089
+ is_device_error: true
23090
+ /** Date and time at which Seam created the error. */
23091
+ created_at: string
23092
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23093
+ error_code: 'device_disconnected'
23094
+ }
23095
+ | {
23096
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23097
+ message: string
23098
+ /** Indicates that the error is a device error. */
23099
+ is_device_error: true
23100
+ /** Date and time at which Seam created the error. */
23101
+ created_at: string
23102
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23103
+ error_code: 'empty_backup_access_code_pool'
23104
+ }
23105
+ | {
23106
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23107
+ message: string
23108
+ /** Indicates that the error is a device error. */
23109
+ is_device_error: true
23110
+ /** Date and time at which Seam created the error. */
23111
+ created_at: string
23112
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23113
+ error_code: 'august_lock_not_authorized'
23114
+ }
23115
+ | {
23116
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23117
+ message: string
23118
+ /** Indicates that the error is a device error. */
23119
+ is_device_error: true
23120
+ /** Date and time at which Seam created the error. */
23121
+ created_at: string
23122
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23123
+ error_code: 'august_lock_missing_bridge'
23124
+ }
23125
+ | {
23126
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23127
+ message: string
23128
+ /** Indicates that the error is a device error. */
23129
+ is_device_error: true
23130
+ /** Date and time at which Seam created the error. */
23131
+ created_at: string
23132
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23133
+ error_code: 'ttlock_lock_not_paired_to_gateway'
23134
+ }
23135
+ | {
23136
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23137
+ message: string
23138
+ /** Indicates that the error is a device error. */
23139
+ is_device_error: true
23140
+ /** Date and time at which Seam created the error. */
23141
+ created_at: string
23142
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23143
+ error_code: 'missing_device_credentials'
23144
+ }
23145
+ | {
23146
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23147
+ message: string
23148
+ /** Indicates that the error is a device error. */
23149
+ is_device_error: true
23150
+ /** Date and time at which Seam created the error. */
23151
+ created_at: string
23152
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23153
+ error_code: 'auxiliary_heat_running'
23154
+ }
23155
+ | {
23156
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23157
+ message: string
23158
+ /** Indicates that the error is a device error. */
23159
+ is_device_error: true
23160
+ /** Date and time at which Seam created the error. */
23161
+ created_at: string
23162
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23163
+ error_code: 'subscription_required'
23164
+ }
23165
+ | {
23166
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23167
+ message: string
23168
+ /** Indicates that the error is a device error. */
23169
+ is_device_error: true
23170
+ /** Date and time at which Seam created the error. */
23171
+ created_at: string
23172
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23173
+ error_code: 'lockly_missing_wifi_bridge'
23174
+ }
23175
+ | {
23176
+ /** Date and time at which Seam created the error. */
23177
+ created_at: string
23178
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23179
+ message: string
23180
+ /** Indicates whether the error is related specifically to the connected account. */
23181
+ is_connected_account_error?: boolean | undefined
23182
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
23183
+ is_bridge_error?: boolean | undefined
23184
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23185
+ error_code: 'invalid_credentials'
23186
+ }
23187
+ | {
23188
+ /** Date and time at which Seam created the error. */
23189
+ created_at: string
23190
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
23191
+ message: string
23192
+ /** Indicates whether the error is related specifically to the connected account. */
23193
+ is_connected_account_error?: boolean | undefined
23194
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
23195
+ is_bridge_error?: boolean | undefined
23196
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23197
+ error_code: 'bridge_disconnected'
23198
+ }
23199
+ )[]
23200
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
23201
+ warnings: (
23202
+ | {
23203
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23204
+ message: string
23205
+ /** Date and time at which Seam created the warning. */
23206
+ created_at?: string | undefined
23207
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23208
+ warning_code: 'smartthings_failed_to_set_access_code'
23209
+ }
23210
+ | {
23211
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23212
+ message: string
23213
+ /** Date and time at which Seam created the warning. */
23214
+ created_at?: string | undefined
23215
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23216
+ warning_code: 'schlage_detected_duplicate'
23217
+ }
23218
+ | {
23219
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23220
+ message: string
23221
+ /** Date and time at which Seam created the warning. */
23222
+ created_at?: string | undefined
23223
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23224
+ warning_code: 'schlage_creation_outage'
23225
+ }
23226
+ | {
23227
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23228
+ message: string
23229
+ /** Date and time at which Seam created the warning. */
23230
+ created_at?: string | undefined
23231
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23232
+ warning_code: 'code_modified_external_to_seam'
23233
+ }
23234
+ | {
23235
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23236
+ message: string
23237
+ /** Date and time at which Seam created the warning. */
23238
+ created_at?: string | undefined
23239
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23240
+ warning_code: 'delay_in_setting_on_device'
23241
+ }
23242
+ | {
23243
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23244
+ message: string
23245
+ /** Date and time at which Seam created the warning. */
23246
+ created_at?: string | undefined
23247
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23248
+ warning_code: 'delay_in_removing_from_device'
23249
+ }
23250
+ | {
23251
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23252
+ message: string
23253
+ /** Date and time at which Seam created the warning. */
23254
+ created_at?: string | undefined
23255
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23256
+ warning_code: 'third_party_integration_detected'
23257
+ }
23258
+ | {
23259
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23260
+ message: string
23261
+ /** Date and time at which Seam created the warning. */
23262
+ created_at?: string | undefined
23263
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23264
+ warning_code: 'august_device_programming_delay'
23265
+ }
23266
+ | {
23267
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23268
+ message: string
23269
+ /** Date and time at which Seam created the warning. */
23270
+ created_at?: string | undefined
23271
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
23272
+ warning_code: 'august_lock_temporarily_offline'
23273
+ }
23274
+ | {
23275
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23276
+ message: string
23277
+ /** Date and time at which Seam created the warning. */
23278
+ created_at?: string | undefined
23279
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23280
+ warning_code: 'igloo_algopin_must_be_used_within_24_hours'
23281
+ }
23282
+ | {
23283
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23284
+ message: string
23285
+ /** Date and time at which Seam created the warning. */
23286
+ created_at?: string | undefined
23287
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23288
+ warning_code: 'management_transferred'
23289
+ }
23290
+ | {
23291
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
23292
+ message: string
23293
+ /** Date and time at which Seam created the warning. */
23294
+ created_at?: string | undefined
23295
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
23296
+ warning_code: 'kwikset_unable_to_confirm_code'
23297
+ }
23298
+ )[]
23299
+ /** Indicates that Seam does not manage the access code. */
23300
+ is_managed: false
23301
+ /** Date and time at which the time-bound access code becomes active. */
23302
+ starts_at?: (string | null) | undefined
23303
+ /** Date and time after which the time-bound access code becomes inactive. */
23304
+ ends_at?: (string | null) | undefined
23305
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
23306
+ status: 'set'
23307
+ }[]
23308
+ | undefined
22197
23309
  }
22198
23310
  }
22199
23311
  }
@@ -22292,6 +23404,7 @@ export type Routes = {
22292
23404
  | 'brivo_group'
22293
23405
  | 'salto_space_group'
22294
23406
  | 'dormakaba_community_access_group'
23407
+ | 'dormakaba_ambiance_access_group'
22295
23408
  /**
22296
23409
  * @deprecated Use `external_type_display_name`.*/
22297
23410
  access_group_type_display_name: string
@@ -22304,6 +23417,7 @@ export type Routes = {
22304
23417
  | 'brivo_group'
22305
23418
  | 'salto_space_group'
22306
23419
  | 'dormakaba_community_access_group'
23420
+ | 'dormakaba_ambiance_access_group'
22307
23421
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
22308
23422
  external_type_display_name: string
22309
23423
  /** Date and time at which the access group was created. */
@@ -22356,6 +23470,7 @@ export type Routes = {
22356
23470
  | 'brivo_group'
22357
23471
  | 'salto_space_group'
22358
23472
  | 'dormakaba_community_access_group'
23473
+ | 'dormakaba_ambiance_access_group'
22359
23474
  /**
22360
23475
  * @deprecated Use `external_type_display_name`.*/
22361
23476
  access_group_type_display_name: string
@@ -22368,6 +23483,7 @@ export type Routes = {
22368
23483
  | 'brivo_group'
22369
23484
  | 'salto_space_group'
22370
23485
  | 'dormakaba_community_access_group'
23486
+ | 'dormakaba_ambiance_access_group'
22371
23487
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
22372
23488
  external_type_display_name: string
22373
23489
  /** Date and time at which the access group was created. */
@@ -22833,6 +23949,7 @@ export type Routes = {
22833
23949
  | 'brivo_group'
22834
23950
  | 'salto_space_group'
22835
23951
  | 'dormakaba_community_access_group'
23952
+ | 'dormakaba_ambiance_access_group'
22836
23953
  /**
22837
23954
  * @deprecated Use `external_type_display_name`.*/
22838
23955
  access_group_type_display_name: string
@@ -22845,6 +23962,7 @@ export type Routes = {
22845
23962
  | 'brivo_group'
22846
23963
  | 'salto_space_group'
22847
23964
  | 'dormakaba_community_access_group'
23965
+ | 'dormakaba_ambiance_access_group'
22848
23966
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
22849
23967
  external_type_display_name: string
22850
23968
  /** Date and time at which the access group was created. */
@@ -22895,6 +24013,7 @@ export type Routes = {
22895
24013
  | 'brivo_group'
22896
24014
  | 'salto_space_group'
22897
24015
  | 'dormakaba_community_access_group'
24016
+ | 'dormakaba_ambiance_access_group'
22898
24017
  /**
22899
24018
  * @deprecated Use `external_type_display_name`.*/
22900
24019
  access_group_type_display_name: string
@@ -22907,6 +24026,7 @@ export type Routes = {
22907
24026
  | 'brivo_group'
22908
24027
  | 'salto_space_group'
22909
24028
  | 'dormakaba_community_access_group'
24029
+ | 'dormakaba_ambiance_access_group'
22910
24030
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
22911
24031
  external_type_display_name: string
22912
24032
  /** Date and time at which the access group was created. */
@@ -94818,6 +95938,7 @@ export type Routes = {
94818
95938
  | 'brivo_group'
94819
95939
  | 'salto_space_group'
94820
95940
  | 'dormakaba_community_access_group'
95941
+ | 'dormakaba_ambiance_access_group'
94821
95942
  /**
94822
95943
  * @deprecated Use `external_type_display_name`.*/
94823
95944
  access_group_type_display_name: string
@@ -94830,6 +95951,7 @@ export type Routes = {
94830
95951
  | 'brivo_group'
94831
95952
  | 'salto_space_group'
94832
95953
  | 'dormakaba_community_access_group'
95954
+ | 'dormakaba_ambiance_access_group'
94833
95955
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
94834
95956
  external_type_display_name: string
94835
95957
  /** Date and time at which the access group was created. */
@@ -96930,6 +98052,7 @@ export type Routes = {
96930
98052
  | 'brivo_group'
96931
98053
  | 'salto_space_group'
96932
98054
  | 'dormakaba_community_access_group'
98055
+ | 'dormakaba_ambiance_access_group'
96933
98056
  /**
96934
98057
  * @deprecated Use `external_type_display_name`.*/
96935
98058
  access_group_type_display_name: string
@@ -96942,6 +98065,7 @@ export type Routes = {
96942
98065
  | 'brivo_group'
96943
98066
  | 'salto_space_group'
96944
98067
  | 'dormakaba_community_access_group'
98068
+ | 'dormakaba_ambiance_access_group'
96945
98069
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
96946
98070
  external_type_display_name: string
96947
98071
  /** Date and time at which the access group was created. */
@@ -99725,35 +100849,1141 @@ export type Routes = {
99725
100849
  }
99726
100850
  )[]
99727
100851
  | undefined
99728
- instant_keys?:
100852
+ instant_keys?:
100853
+ | {
100854
+ /** ID of the Instant Key. */
100855
+ instant_key_id: string
100856
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key. */
100857
+ workspace_id: string
100858
+ /** Date and time at which the Instant Key was created. */
100859
+ created_at: string
100860
+ /** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */
100861
+ instant_key_url: string
100862
+ /** ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */
100863
+ client_session_id: string
100864
+ /** ID of the user identity associated with the Instant Key. */
100865
+ user_identity_id: string
100866
+ /** Date and time at which the Instant Key expires. */
100867
+ expires_at: string
100868
+ /** ID of the customization profile associated with the Instant Key. */
100869
+ customization_profile_id?: string | undefined
100870
+ /** Customization profile associated with the Instant Key. */
100871
+ customization_profile?:
100872
+ | {
100873
+ /** Primary color of the customization profile. */
100874
+ primary_color?: string | undefined
100875
+ /** Secondary color of the customization profile. */
100876
+ secondary_color?: string | undefined
100877
+ /** URL of the logo associated with the customization profile. */
100878
+ logo_url?: string | undefined
100879
+ }
100880
+ | undefined
100881
+ }[]
100882
+ | undefined
100883
+ access_codes?:
100884
+ | {
100885
+ /** Unique identifier for a group of access codes that share the same code. */
100886
+ common_code_key: string | null
100887
+ /** Indicates whether the code is set on the device according to a preconfigured schedule. */
100888
+ is_scheduled_on_device?: boolean | undefined
100889
+ /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
100890
+ type: 'time_bound' | 'ongoing'
100891
+ /** Indicates whether the access code is waiting for a code assignment. */
100892
+ is_waiting_for_code_assignment?: boolean | undefined
100893
+ /** Unique identifier for the access code. */
100894
+ access_code_id: string
100895
+ /** Unique identifier for the device associated with the access code. */
100896
+ device_id: string
100897
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
100898
+ name: string | null
100899
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
100900
+ code: string | null
100901
+ /** Date and time at which the access code was created. */
100902
+ created_at: string
100903
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
100904
+ errors: (
100905
+ | {
100906
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
100907
+ message: string
100908
+ /** Indicates that this is an access code error. */
100909
+ is_access_code_error: true
100910
+ /** Date and time at which Seam created the error. */
100911
+ created_at?: string | undefined
100912
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
100913
+ error_code: 'smartthings_failed_to_set_access_code'
100914
+ }
100915
+ | {
100916
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
100917
+ message: string
100918
+ /** Indicates that this is an access code error. */
100919
+ is_access_code_error: true
100920
+ /** Date and time at which Seam created the error. */
100921
+ created_at?: string | undefined
100922
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
100923
+ error_code: 'smartthings_failed_to_set_after_multiple_retries'
100924
+ }
100925
+ | {
100926
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
100927
+ message: string
100928
+ /** Indicates that this is an access code error. */
100929
+ is_access_code_error: true
100930
+ /** Date and time at which Seam created the error. */
100931
+ created_at?: string | undefined
100932
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
100933
+ error_code: 'smartthings_no_free_slots_available'
100934
+ }
100935
+ | {
100936
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
100937
+ message: string
100938
+ /** Indicates that this is an access code error. */
100939
+ is_access_code_error: true
100940
+ /** Date and time at which Seam created the error. */
100941
+ created_at?: string | undefined
100942
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
100943
+ error_code: 'failed_to_set_on_device'
100944
+ }
100945
+ | {
100946
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
100947
+ message: string
100948
+ /** Indicates that this is an access code error. */
100949
+ is_access_code_error: true
100950
+ /** Date and time at which Seam created the error. */
100951
+ created_at?: string | undefined
100952
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
100953
+ error_code: 'failed_to_remove_from_device'
100954
+ }
100955
+ | {
100956
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
100957
+ message: string
100958
+ /** Indicates that this is an access code error. */
100959
+ is_access_code_error: true
100960
+ /** Date and time at which Seam created the error. */
100961
+ created_at?: string | undefined
100962
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
100963
+ error_code: 'duplicate_code_on_device'
100964
+ }
100965
+ | {
100966
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
100967
+ message: string
100968
+ /** Indicates that this is an access code error. */
100969
+ is_access_code_error: true
100970
+ /** Date and time at which Seam created the error. */
100971
+ created_at?: string | undefined
100972
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
100973
+ error_code: 'duplicate_code_attempt_prevented'
100974
+ }
100975
+ | {
100976
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
100977
+ message: string
100978
+ /** Indicates that this is an access code error. */
100979
+ is_access_code_error: true
100980
+ /** Date and time at which Seam created the error. */
100981
+ created_at?: string | undefined
100982
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
100983
+ error_code: 'no_space_for_access_code_on_device'
100984
+ }
100985
+ | {
100986
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
100987
+ message: string
100988
+ /** Indicates that this is an access code error. */
100989
+ is_access_code_error: true
100990
+ /** Date and time at which Seam created the error. */
100991
+ created_at?: string | undefined
100992
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
100993
+ error_code: 'igloohome_bridge_too_many_pending_jobs'
100994
+ }
100995
+ | {
100996
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
100997
+ message: string
100998
+ /** Indicates that this is an access code error. */
100999
+ is_access_code_error: true
101000
+ /** Date and time at which Seam created the error. */
101001
+ created_at?: string | undefined
101002
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101003
+ error_code: 'igloohome_bridge_offline'
101004
+ }
101005
+ | {
101006
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101007
+ message: string
101008
+ /** Indicates that this is an access code error. */
101009
+ is_access_code_error: true
101010
+ /** Date and time at which Seam created the error. */
101011
+ created_at?: string | undefined
101012
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101013
+ error_code: 'igloohome_offline_access_code_no_variance_available'
101014
+ }
101015
+ | {
101016
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101017
+ message: string
101018
+ /** Indicates that this is an access code error. */
101019
+ is_access_code_error: true
101020
+ /** Date and time at which Seam created the error. */
101021
+ created_at?: string | undefined
101022
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101023
+ error_code: 'kwikset_unable_to_confirm_code'
101024
+ }
101025
+ | {
101026
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101027
+ message: string
101028
+ /** Indicates that this is an access code error. */
101029
+ is_access_code_error: true
101030
+ /** Date and time at which Seam created the error. */
101031
+ created_at?: string | undefined
101032
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101033
+ error_code: 'kwikset_unable_to_confirm_deletion'
101034
+ }
101035
+ | {
101036
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101037
+ message: string
101038
+ /** Indicates that this is an access code error. */
101039
+ is_access_code_error: true
101040
+ /** Date and time at which Seam created the error. */
101041
+ created_at?: string | undefined
101042
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101043
+ error_code: 'code_modified_external_to_seam'
101044
+ }
101045
+ | {
101046
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101047
+ message: string
101048
+ /** Indicates that this is an access code error. */
101049
+ is_access_code_error: true
101050
+ /** Date and time at which Seam created the error. */
101051
+ created_at?: string | undefined
101052
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101053
+ error_code: 'august_lock_invalid_code_length'
101054
+ }
101055
+ | {
101056
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101057
+ message: string
101058
+ /** Indicates that this is an access code error. */
101059
+ is_access_code_error: true
101060
+ /** Date and time at which Seam created the error. */
101061
+ created_at?: string | undefined
101062
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101063
+ error_code: 'august_device_programming_delay'
101064
+ }
101065
+ | {
101066
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101067
+ message: string
101068
+ /** Indicates that this is an access code error. */
101069
+ is_access_code_error: true
101070
+ /** Date and time at which Seam created the error. */
101071
+ created_at?: string | undefined
101072
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101073
+ error_code: 'august_device_slots_full'
101074
+ }
101075
+ | {
101076
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101077
+ message: string
101078
+ /** Indicates that this is an access code error. */
101079
+ is_access_code_error: true
101080
+ /** Date and time at which Seam created the error. */
101081
+ created_at?: string | undefined
101082
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101083
+ error_code: 'august_lock_missing_keypad'
101084
+ }
101085
+ | {
101086
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101087
+ message: string
101088
+ /** Indicates that this is an access code error. */
101089
+ is_access_code_error: true
101090
+ /** Date and time at which Seam created the error. */
101091
+ created_at?: string | undefined
101092
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101093
+ error_code: 'august_lock_temporarily_offline'
101094
+ }
101095
+ | {
101096
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101097
+ message: string
101098
+ /** Indicates that this is an access code error. */
101099
+ is_access_code_error: true
101100
+ /** Date and time at which Seam created the error. */
101101
+ created_at?: string | undefined
101102
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101103
+ error_code: 'salto_ks_user_not_subscribed'
101104
+ }
101105
+ | {
101106
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101107
+ message: string
101108
+ /** Indicates that this is an access code error. */
101109
+ is_access_code_error: true
101110
+ /** Date and time at which Seam created the error. */
101111
+ created_at?: string | undefined
101112
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101113
+ error_code: 'hubitat_device_programming_delay'
101114
+ }
101115
+ | {
101116
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101117
+ message: string
101118
+ /** Indicates that this is an access code error. */
101119
+ is_access_code_error: true
101120
+ /** Date and time at which Seam created the error. */
101121
+ created_at?: string | undefined
101122
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101123
+ error_code: 'hubitat_no_free_positions_available'
101124
+ }
101125
+ | {
101126
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101127
+ message: string
101128
+ /** Indicates that this is an access code error. */
101129
+ is_access_code_error: true
101130
+ /** Date and time at which Seam created the error. */
101131
+ created_at?: string | undefined
101132
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101133
+ error_code: 'wyze_duplicate_code_name'
101134
+ }
101135
+ | {
101136
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101137
+ message: string
101138
+ /** Indicates that this is an access code error. */
101139
+ is_access_code_error: true
101140
+ /** Date and time at which Seam created the error. */
101141
+ created_at?: string | undefined
101142
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101143
+ error_code: 'wyze_potential_duplicate_code'
101144
+ }
101145
+ | {
101146
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101147
+ message: string
101148
+ /** Indicates that this is an access code error. */
101149
+ is_access_code_error: true
101150
+ /** Date and time at which Seam created the error. */
101151
+ created_at?: string | undefined
101152
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101153
+ error_code: 'dormakaba_oracode_no_valid_user_level'
101154
+ }
101155
+ | {
101156
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101157
+ message: string
101158
+ /** Indicates that the error is not a device error. */
101159
+ is_device_error: false
101160
+ /** Date and time at which Seam created the error. */
101161
+ created_at: string
101162
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101163
+ error_code: 'account_disconnected'
101164
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
101165
+ is_connected_account_error: true
101166
+ }
101167
+ | {
101168
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101169
+ message: string
101170
+ /** Indicates that the error is not a device error. */
101171
+ is_device_error: false
101172
+ /** Date and time at which Seam created the error. */
101173
+ created_at: string
101174
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101175
+ error_code: 'salto_ks_subscription_limit_exceeded'
101176
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
101177
+ is_connected_account_error: true
101178
+ }
101179
+ | {
101180
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101181
+ message: string
101182
+ /** Indicates that the error is a device error. */
101183
+ is_device_error: true
101184
+ /** Date and time at which Seam created the error. */
101185
+ created_at: string
101186
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101187
+ error_code: 'device_offline'
101188
+ }
101189
+ | {
101190
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101191
+ message: string
101192
+ /** Indicates that the error is a device error. */
101193
+ is_device_error: true
101194
+ /** Date and time at which Seam created the error. */
101195
+ created_at: string
101196
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101197
+ error_code: 'device_removed'
101198
+ }
101199
+ | {
101200
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101201
+ message: string
101202
+ /** Indicates that the error is a device error. */
101203
+ is_device_error: true
101204
+ /** Date and time at which Seam created the error. */
101205
+ created_at: string
101206
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101207
+ error_code: 'hub_disconnected'
101208
+ }
101209
+ | {
101210
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101211
+ message: string
101212
+ /** Indicates that the error is a device error. */
101213
+ is_device_error: true
101214
+ /** Date and time at which Seam created the error. */
101215
+ created_at: string
101216
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101217
+ error_code: 'device_disconnected'
101218
+ }
101219
+ | {
101220
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101221
+ message: string
101222
+ /** Indicates that the error is a device error. */
101223
+ is_device_error: true
101224
+ /** Date and time at which Seam created the error. */
101225
+ created_at: string
101226
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101227
+ error_code: 'empty_backup_access_code_pool'
101228
+ }
101229
+ | {
101230
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101231
+ message: string
101232
+ /** Indicates that the error is a device error. */
101233
+ is_device_error: true
101234
+ /** Date and time at which Seam created the error. */
101235
+ created_at: string
101236
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101237
+ error_code: 'august_lock_not_authorized'
101238
+ }
101239
+ | {
101240
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101241
+ message: string
101242
+ /** Indicates that the error is a device error. */
101243
+ is_device_error: true
101244
+ /** Date and time at which Seam created the error. */
101245
+ created_at: string
101246
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101247
+ error_code: 'august_lock_missing_bridge'
101248
+ }
101249
+ | {
101250
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101251
+ message: string
101252
+ /** Indicates that the error is a device error. */
101253
+ is_device_error: true
101254
+ /** Date and time at which Seam created the error. */
101255
+ created_at: string
101256
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101257
+ error_code: 'ttlock_lock_not_paired_to_gateway'
101258
+ }
101259
+ | {
101260
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101261
+ message: string
101262
+ /** Indicates that the error is a device error. */
101263
+ is_device_error: true
101264
+ /** Date and time at which Seam created the error. */
101265
+ created_at: string
101266
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101267
+ error_code: 'missing_device_credentials'
101268
+ }
101269
+ | {
101270
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101271
+ message: string
101272
+ /** Indicates that the error is a device error. */
101273
+ is_device_error: true
101274
+ /** Date and time at which Seam created the error. */
101275
+ created_at: string
101276
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101277
+ error_code: 'auxiliary_heat_running'
101278
+ }
101279
+ | {
101280
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101281
+ message: string
101282
+ /** Indicates that the error is a device error. */
101283
+ is_device_error: true
101284
+ /** Date and time at which Seam created the error. */
101285
+ created_at: string
101286
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101287
+ error_code: 'subscription_required'
101288
+ }
101289
+ | {
101290
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101291
+ message: string
101292
+ /** Indicates that the error is a device error. */
101293
+ is_device_error: true
101294
+ /** Date and time at which Seam created the error. */
101295
+ created_at: string
101296
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101297
+ error_code: 'lockly_missing_wifi_bridge'
101298
+ }
101299
+ | {
101300
+ /** Date and time at which Seam created the error. */
101301
+ created_at: string
101302
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101303
+ message: string
101304
+ /** Indicates whether the error is related specifically to the connected account. */
101305
+ is_connected_account_error?: boolean | undefined
101306
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
101307
+ is_bridge_error?: boolean | undefined
101308
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101309
+ error_code: 'invalid_credentials'
101310
+ }
101311
+ | {
101312
+ /** Date and time at which Seam created the error. */
101313
+ created_at: string
101314
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101315
+ message: string
101316
+ /** Indicates whether the error is related specifically to the connected account. */
101317
+ is_connected_account_error?: boolean | undefined
101318
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
101319
+ is_bridge_error?: boolean | undefined
101320
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101321
+ error_code: 'bridge_disconnected'
101322
+ }
101323
+ )[]
101324
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
101325
+ warnings: (
101326
+ | {
101327
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101328
+ message: string
101329
+ /** Date and time at which Seam created the warning. */
101330
+ created_at?: string | undefined
101331
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101332
+ warning_code: 'smartthings_failed_to_set_access_code'
101333
+ }
101334
+ | {
101335
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101336
+ message: string
101337
+ /** Date and time at which Seam created the warning. */
101338
+ created_at?: string | undefined
101339
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101340
+ warning_code: 'schlage_detected_duplicate'
101341
+ }
101342
+ | {
101343
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101344
+ message: string
101345
+ /** Date and time at which Seam created the warning. */
101346
+ created_at?: string | undefined
101347
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101348
+ warning_code: 'schlage_creation_outage'
101349
+ }
101350
+ | {
101351
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101352
+ message: string
101353
+ /** Date and time at which Seam created the warning. */
101354
+ created_at?: string | undefined
101355
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101356
+ warning_code: 'code_modified_external_to_seam'
101357
+ }
101358
+ | {
101359
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101360
+ message: string
101361
+ /** Date and time at which Seam created the warning. */
101362
+ created_at?: string | undefined
101363
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101364
+ warning_code: 'delay_in_setting_on_device'
101365
+ }
101366
+ | {
101367
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101368
+ message: string
101369
+ /** Date and time at which Seam created the warning. */
101370
+ created_at?: string | undefined
101371
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101372
+ warning_code: 'delay_in_removing_from_device'
101373
+ }
101374
+ | {
101375
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101376
+ message: string
101377
+ /** Date and time at which Seam created the warning. */
101378
+ created_at?: string | undefined
101379
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101380
+ warning_code: 'third_party_integration_detected'
101381
+ }
101382
+ | {
101383
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101384
+ message: string
101385
+ /** Date and time at which Seam created the warning. */
101386
+ created_at?: string | undefined
101387
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101388
+ warning_code: 'august_device_programming_delay'
101389
+ }
101390
+ | {
101391
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101392
+ message: string
101393
+ /** Date and time at which Seam created the warning. */
101394
+ created_at?: string | undefined
101395
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101396
+ warning_code: 'august_lock_temporarily_offline'
101397
+ }
101398
+ | {
101399
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101400
+ message: string
101401
+ /** Date and time at which Seam created the warning. */
101402
+ created_at?: string | undefined
101403
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101404
+ warning_code: 'igloo_algopin_must_be_used_within_24_hours'
101405
+ }
101406
+ | {
101407
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101408
+ message: string
101409
+ /** Date and time at which Seam created the warning. */
101410
+ created_at?: string | undefined
101411
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101412
+ warning_code: 'management_transferred'
101413
+ }
101414
+ | {
101415
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101416
+ message: string
101417
+ /** Date and time at which Seam created the warning. */
101418
+ created_at?: string | undefined
101419
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101420
+ warning_code: 'kwikset_unable_to_confirm_code'
101421
+ }
101422
+ )[]
101423
+ /** Indicates whether Seam manages the access code. */
101424
+ is_managed: true
101425
+ /** Date and time at which the time-bound access code becomes active. */
101426
+ starts_at?: (string | null) | undefined
101427
+ /** Date and time after which the time-bound access code becomes inactive. */
101428
+ ends_at?: (string | null) | undefined
101429
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
101430
+ status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown'
101431
+ /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
101432
+ is_backup_access_code_available: boolean
101433
+ /** Indicates whether the access code is a backup code. */
101434
+ is_backup?: boolean | undefined
101435
+ /** Identifier of the pulled backup access code. Used to associate the pulled backup access code with the original access code. */
101436
+ pulled_backup_access_code_id?: (string | null) | undefined
101437
+ /** Indicates whether changes to the access code from external sources are permitted. */
101438
+ is_external_modification_allowed: boolean
101439
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
101440
+ is_one_time_use: boolean
101441
+ /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
101442
+ is_offline_access_code: boolean
101443
+ }[]
101444
+ | undefined
101445
+ unmanaged_access_codes?:
99729
101446
  | {
99730
- /** ID of the Instant Key. */
99731
- instant_key_id: string
99732
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the Instant Key. */
99733
- workspace_id: string
99734
- /** Date and time at which the Instant Key was created. */
101447
+ /** Type of the access code. `ongoing` access codes are active continuously until deactivated manually. `time_bound` access codes have a specific duration. */
101448
+ type: 'time_bound' | 'ongoing'
101449
+ /** Unique identifier for the access code. */
101450
+ access_code_id: string
101451
+ /** Unique identifier for the device associated with the access code. */
101452
+ device_id: string
101453
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
101454
+ name: string | null
101455
+ /** Code used for access. Typically, a numeric or alphanumeric string. */
101456
+ code: string | null
101457
+ /** Date and time at which the access code was created. */
99735
101458
  created_at: string
99736
- /** Shareable URL for the Instant Key. Use the URL to deliver the Instant Key to your user through a link in a text message or email or by embedding it in your web app. */
99737
- instant_key_url: string
99738
- /** ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) associated with the Instant Key. */
99739
- client_session_id: string
99740
- /** ID of the user identity associated with the Instant Key. */
99741
- user_identity_id: string
99742
- /** Date and time at which the Instant Key expires. */
99743
- expires_at: string
99744
- /** ID of the customization profile associated with the Instant Key. */
99745
- customization_profile_id?: string | undefined
99746
- /** Customization profile associated with the Instant Key. */
99747
- customization_profile?:
101459
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
101460
+ errors: (
99748
101461
  | {
99749
- /** Primary color of the customization profile. */
99750
- primary_color?: string | undefined
99751
- /** Secondary color of the customization profile. */
99752
- secondary_color?: string | undefined
99753
- /** URL of the logo associated with the customization profile. */
99754
- logo_url?: string | undefined
101462
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101463
+ message: string
101464
+ /** Indicates that this is an access code error. */
101465
+ is_access_code_error: true
101466
+ /** Date and time at which Seam created the error. */
101467
+ created_at?: string | undefined
101468
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101469
+ error_code: 'smartthings_failed_to_set_access_code'
99755
101470
  }
99756
- | undefined
101471
+ | {
101472
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101473
+ message: string
101474
+ /** Indicates that this is an access code error. */
101475
+ is_access_code_error: true
101476
+ /** Date and time at which Seam created the error. */
101477
+ created_at?: string | undefined
101478
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101479
+ error_code: 'smartthings_failed_to_set_after_multiple_retries'
101480
+ }
101481
+ | {
101482
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101483
+ message: string
101484
+ /** Indicates that this is an access code error. */
101485
+ is_access_code_error: true
101486
+ /** Date and time at which Seam created the error. */
101487
+ created_at?: string | undefined
101488
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101489
+ error_code: 'smartthings_no_free_slots_available'
101490
+ }
101491
+ | {
101492
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101493
+ message: string
101494
+ /** Indicates that this is an access code error. */
101495
+ is_access_code_error: true
101496
+ /** Date and time at which Seam created the error. */
101497
+ created_at?: string | undefined
101498
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101499
+ error_code: 'failed_to_set_on_device'
101500
+ }
101501
+ | {
101502
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101503
+ message: string
101504
+ /** Indicates that this is an access code error. */
101505
+ is_access_code_error: true
101506
+ /** Date and time at which Seam created the error. */
101507
+ created_at?: string | undefined
101508
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101509
+ error_code: 'failed_to_remove_from_device'
101510
+ }
101511
+ | {
101512
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101513
+ message: string
101514
+ /** Indicates that this is an access code error. */
101515
+ is_access_code_error: true
101516
+ /** Date and time at which Seam created the error. */
101517
+ created_at?: string | undefined
101518
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101519
+ error_code: 'duplicate_code_on_device'
101520
+ }
101521
+ | {
101522
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101523
+ message: string
101524
+ /** Indicates that this is an access code error. */
101525
+ is_access_code_error: true
101526
+ /** Date and time at which Seam created the error. */
101527
+ created_at?: string | undefined
101528
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101529
+ error_code: 'duplicate_code_attempt_prevented'
101530
+ }
101531
+ | {
101532
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101533
+ message: string
101534
+ /** Indicates that this is an access code error. */
101535
+ is_access_code_error: true
101536
+ /** Date and time at which Seam created the error. */
101537
+ created_at?: string | undefined
101538
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101539
+ error_code: 'no_space_for_access_code_on_device'
101540
+ }
101541
+ | {
101542
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101543
+ message: string
101544
+ /** Indicates that this is an access code error. */
101545
+ is_access_code_error: true
101546
+ /** Date and time at which Seam created the error. */
101547
+ created_at?: string | undefined
101548
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101549
+ error_code: 'igloohome_bridge_too_many_pending_jobs'
101550
+ }
101551
+ | {
101552
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101553
+ message: string
101554
+ /** Indicates that this is an access code error. */
101555
+ is_access_code_error: true
101556
+ /** Date and time at which Seam created the error. */
101557
+ created_at?: string | undefined
101558
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101559
+ error_code: 'igloohome_bridge_offline'
101560
+ }
101561
+ | {
101562
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101563
+ message: string
101564
+ /** Indicates that this is an access code error. */
101565
+ is_access_code_error: true
101566
+ /** Date and time at which Seam created the error. */
101567
+ created_at?: string | undefined
101568
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101569
+ error_code: 'igloohome_offline_access_code_no_variance_available'
101570
+ }
101571
+ | {
101572
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101573
+ message: string
101574
+ /** Indicates that this is an access code error. */
101575
+ is_access_code_error: true
101576
+ /** Date and time at which Seam created the error. */
101577
+ created_at?: string | undefined
101578
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101579
+ error_code: 'kwikset_unable_to_confirm_code'
101580
+ }
101581
+ | {
101582
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101583
+ message: string
101584
+ /** Indicates that this is an access code error. */
101585
+ is_access_code_error: true
101586
+ /** Date and time at which Seam created the error. */
101587
+ created_at?: string | undefined
101588
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101589
+ error_code: 'kwikset_unable_to_confirm_deletion'
101590
+ }
101591
+ | {
101592
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101593
+ message: string
101594
+ /** Indicates that this is an access code error. */
101595
+ is_access_code_error: true
101596
+ /** Date and time at which Seam created the error. */
101597
+ created_at?: string | undefined
101598
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101599
+ error_code: 'code_modified_external_to_seam'
101600
+ }
101601
+ | {
101602
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101603
+ message: string
101604
+ /** Indicates that this is an access code error. */
101605
+ is_access_code_error: true
101606
+ /** Date and time at which Seam created the error. */
101607
+ created_at?: string | undefined
101608
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101609
+ error_code: 'august_lock_invalid_code_length'
101610
+ }
101611
+ | {
101612
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101613
+ message: string
101614
+ /** Indicates that this is an access code error. */
101615
+ is_access_code_error: true
101616
+ /** Date and time at which Seam created the error. */
101617
+ created_at?: string | undefined
101618
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101619
+ error_code: 'august_device_programming_delay'
101620
+ }
101621
+ | {
101622
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101623
+ message: string
101624
+ /** Indicates that this is an access code error. */
101625
+ is_access_code_error: true
101626
+ /** Date and time at which Seam created the error. */
101627
+ created_at?: string | undefined
101628
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101629
+ error_code: 'august_device_slots_full'
101630
+ }
101631
+ | {
101632
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101633
+ message: string
101634
+ /** Indicates that this is an access code error. */
101635
+ is_access_code_error: true
101636
+ /** Date and time at which Seam created the error. */
101637
+ created_at?: string | undefined
101638
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101639
+ error_code: 'august_lock_missing_keypad'
101640
+ }
101641
+ | {
101642
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101643
+ message: string
101644
+ /** Indicates that this is an access code error. */
101645
+ is_access_code_error: true
101646
+ /** Date and time at which Seam created the error. */
101647
+ created_at?: string | undefined
101648
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101649
+ error_code: 'august_lock_temporarily_offline'
101650
+ }
101651
+ | {
101652
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101653
+ message: string
101654
+ /** Indicates that this is an access code error. */
101655
+ is_access_code_error: true
101656
+ /** Date and time at which Seam created the error. */
101657
+ created_at?: string | undefined
101658
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101659
+ error_code: 'salto_ks_user_not_subscribed'
101660
+ }
101661
+ | {
101662
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101663
+ message: string
101664
+ /** Indicates that this is an access code error. */
101665
+ is_access_code_error: true
101666
+ /** Date and time at which Seam created the error. */
101667
+ created_at?: string | undefined
101668
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101669
+ error_code: 'hubitat_device_programming_delay'
101670
+ }
101671
+ | {
101672
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101673
+ message: string
101674
+ /** Indicates that this is an access code error. */
101675
+ is_access_code_error: true
101676
+ /** Date and time at which Seam created the error. */
101677
+ created_at?: string | undefined
101678
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101679
+ error_code: 'hubitat_no_free_positions_available'
101680
+ }
101681
+ | {
101682
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101683
+ message: string
101684
+ /** Indicates that this is an access code error. */
101685
+ is_access_code_error: true
101686
+ /** Date and time at which Seam created the error. */
101687
+ created_at?: string | undefined
101688
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101689
+ error_code: 'wyze_duplicate_code_name'
101690
+ }
101691
+ | {
101692
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101693
+ message: string
101694
+ /** Indicates that this is an access code error. */
101695
+ is_access_code_error: true
101696
+ /** Date and time at which Seam created the error. */
101697
+ created_at?: string | undefined
101698
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101699
+ error_code: 'wyze_potential_duplicate_code'
101700
+ }
101701
+ | {
101702
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101703
+ message: string
101704
+ /** Indicates that this is an access code error. */
101705
+ is_access_code_error: true
101706
+ /** Date and time at which Seam created the error. */
101707
+ created_at?: string | undefined
101708
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101709
+ error_code: 'dormakaba_oracode_no_valid_user_level'
101710
+ }
101711
+ | {
101712
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101713
+ message: string
101714
+ /** Indicates that the error is not a device error. */
101715
+ is_device_error: false
101716
+ /** Date and time at which Seam created the error. */
101717
+ created_at: string
101718
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101719
+ error_code: 'account_disconnected'
101720
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
101721
+ is_connected_account_error: true
101722
+ }
101723
+ | {
101724
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101725
+ message: string
101726
+ /** Indicates that the error is not a device error. */
101727
+ is_device_error: false
101728
+ /** Date and time at which Seam created the error. */
101729
+ created_at: string
101730
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101731
+ error_code: 'salto_ks_subscription_limit_exceeded'
101732
+ /** Indicates that the error is a [connected account](https://docs.seam.co/latest/api/connected_accounts) error. */
101733
+ is_connected_account_error: true
101734
+ }
101735
+ | {
101736
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101737
+ message: string
101738
+ /** Indicates that the error is a device error. */
101739
+ is_device_error: true
101740
+ /** Date and time at which Seam created the error. */
101741
+ created_at: string
101742
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101743
+ error_code: 'device_offline'
101744
+ }
101745
+ | {
101746
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101747
+ message: string
101748
+ /** Indicates that the error is a device error. */
101749
+ is_device_error: true
101750
+ /** Date and time at which Seam created the error. */
101751
+ created_at: string
101752
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101753
+ error_code: 'device_removed'
101754
+ }
101755
+ | {
101756
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101757
+ message: string
101758
+ /** Indicates that the error is a device error. */
101759
+ is_device_error: true
101760
+ /** Date and time at which Seam created the error. */
101761
+ created_at: string
101762
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101763
+ error_code: 'hub_disconnected'
101764
+ }
101765
+ | {
101766
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101767
+ message: string
101768
+ /** Indicates that the error is a device error. */
101769
+ is_device_error: true
101770
+ /** Date and time at which Seam created the error. */
101771
+ created_at: string
101772
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101773
+ error_code: 'device_disconnected'
101774
+ }
101775
+ | {
101776
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101777
+ message: string
101778
+ /** Indicates that the error is a device error. */
101779
+ is_device_error: true
101780
+ /** Date and time at which Seam created the error. */
101781
+ created_at: string
101782
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101783
+ error_code: 'empty_backup_access_code_pool'
101784
+ }
101785
+ | {
101786
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101787
+ message: string
101788
+ /** Indicates that the error is a device error. */
101789
+ is_device_error: true
101790
+ /** Date and time at which Seam created the error. */
101791
+ created_at: string
101792
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101793
+ error_code: 'august_lock_not_authorized'
101794
+ }
101795
+ | {
101796
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101797
+ message: string
101798
+ /** Indicates that the error is a device error. */
101799
+ is_device_error: true
101800
+ /** Date and time at which Seam created the error. */
101801
+ created_at: string
101802
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101803
+ error_code: 'august_lock_missing_bridge'
101804
+ }
101805
+ | {
101806
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101807
+ message: string
101808
+ /** Indicates that the error is a device error. */
101809
+ is_device_error: true
101810
+ /** Date and time at which Seam created the error. */
101811
+ created_at: string
101812
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101813
+ error_code: 'ttlock_lock_not_paired_to_gateway'
101814
+ }
101815
+ | {
101816
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101817
+ message: string
101818
+ /** Indicates that the error is a device error. */
101819
+ is_device_error: true
101820
+ /** Date and time at which Seam created the error. */
101821
+ created_at: string
101822
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101823
+ error_code: 'missing_device_credentials'
101824
+ }
101825
+ | {
101826
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101827
+ message: string
101828
+ /** Indicates that the error is a device error. */
101829
+ is_device_error: true
101830
+ /** Date and time at which Seam created the error. */
101831
+ created_at: string
101832
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101833
+ error_code: 'auxiliary_heat_running'
101834
+ }
101835
+ | {
101836
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101837
+ message: string
101838
+ /** Indicates that the error is a device error. */
101839
+ is_device_error: true
101840
+ /** Date and time at which Seam created the error. */
101841
+ created_at: string
101842
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101843
+ error_code: 'subscription_required'
101844
+ }
101845
+ | {
101846
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101847
+ message: string
101848
+ /** Indicates that the error is a device error. */
101849
+ is_device_error: true
101850
+ /** Date and time at which Seam created the error. */
101851
+ created_at: string
101852
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101853
+ error_code: 'lockly_missing_wifi_bridge'
101854
+ }
101855
+ | {
101856
+ /** Date and time at which Seam created the error. */
101857
+ created_at: string
101858
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101859
+ message: string
101860
+ /** Indicates whether the error is related specifically to the connected account. */
101861
+ is_connected_account_error?: boolean | undefined
101862
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
101863
+ is_bridge_error?: boolean | undefined
101864
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101865
+ error_code: 'invalid_credentials'
101866
+ }
101867
+ | {
101868
+ /** Date and time at which Seam created the error. */
101869
+ created_at: string
101870
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
101871
+ message: string
101872
+ /** Indicates whether the error is related specifically to the connected account. */
101873
+ is_connected_account_error?: boolean | undefined
101874
+ /** Indicates whether the error is related to [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge). */
101875
+ is_bridge_error?: boolean | undefined
101876
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101877
+ error_code: 'bridge_disconnected'
101878
+ }
101879
+ )[]
101880
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
101881
+ warnings: (
101882
+ | {
101883
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101884
+ message: string
101885
+ /** Date and time at which Seam created the warning. */
101886
+ created_at?: string | undefined
101887
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101888
+ warning_code: 'smartthings_failed_to_set_access_code'
101889
+ }
101890
+ | {
101891
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101892
+ message: string
101893
+ /** Date and time at which Seam created the warning. */
101894
+ created_at?: string | undefined
101895
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101896
+ warning_code: 'schlage_detected_duplicate'
101897
+ }
101898
+ | {
101899
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101900
+ message: string
101901
+ /** Date and time at which Seam created the warning. */
101902
+ created_at?: string | undefined
101903
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101904
+ warning_code: 'schlage_creation_outage'
101905
+ }
101906
+ | {
101907
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101908
+ message: string
101909
+ /** Date and time at which Seam created the warning. */
101910
+ created_at?: string | undefined
101911
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101912
+ warning_code: 'code_modified_external_to_seam'
101913
+ }
101914
+ | {
101915
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101916
+ message: string
101917
+ /** Date and time at which Seam created the warning. */
101918
+ created_at?: string | undefined
101919
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101920
+ warning_code: 'delay_in_setting_on_device'
101921
+ }
101922
+ | {
101923
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101924
+ message: string
101925
+ /** Date and time at which Seam created the warning. */
101926
+ created_at?: string | undefined
101927
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101928
+ warning_code: 'delay_in_removing_from_device'
101929
+ }
101930
+ | {
101931
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101932
+ message: string
101933
+ /** Date and time at which Seam created the warning. */
101934
+ created_at?: string | undefined
101935
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101936
+ warning_code: 'third_party_integration_detected'
101937
+ }
101938
+ | {
101939
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101940
+ message: string
101941
+ /** Date and time at which Seam created the warning. */
101942
+ created_at?: string | undefined
101943
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101944
+ warning_code: 'august_device_programming_delay'
101945
+ }
101946
+ | {
101947
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101948
+ message: string
101949
+ /** Date and time at which Seam created the warning. */
101950
+ created_at?: string | undefined
101951
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
101952
+ warning_code: 'august_lock_temporarily_offline'
101953
+ }
101954
+ | {
101955
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101956
+ message: string
101957
+ /** Date and time at which Seam created the warning. */
101958
+ created_at?: string | undefined
101959
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101960
+ warning_code: 'igloo_algopin_must_be_used_within_24_hours'
101961
+ }
101962
+ | {
101963
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101964
+ message: string
101965
+ /** Date and time at which Seam created the warning. */
101966
+ created_at?: string | undefined
101967
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101968
+ warning_code: 'management_transferred'
101969
+ }
101970
+ | {
101971
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
101972
+ message: string
101973
+ /** Date and time at which Seam created the warning. */
101974
+ created_at?: string | undefined
101975
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
101976
+ warning_code: 'kwikset_unable_to_confirm_code'
101977
+ }
101978
+ )[]
101979
+ /** Indicates that Seam does not manage the access code. */
101980
+ is_managed: false
101981
+ /** Date and time at which the time-bound access code becomes active. */
101982
+ starts_at?: (string | null) | undefined
101983
+ /** Date and time after which the time-bound access code becomes inactive. */
101984
+ ends_at?: (string | null) | undefined
101985
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
101986
+ status: 'set'
99757
101987
  }[]
99758
101988
  | undefined
99759
101989
  }