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