@seamapi/types 1.42.0 → 1.43.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.
@@ -1466,6 +1466,9 @@ export interface Routes {
1466
1466
  model: {
1467
1467
  display_name: string
1468
1468
  manufacturer_display_name: string
1469
+ offline_access_codes_supported?: boolean | undefined
1470
+ access_codes_supported?: boolean | undefined
1471
+ accessory_keypad_supported?: boolean | undefined
1469
1472
  }
1470
1473
  has_direct_power?: boolean | undefined
1471
1474
  battery_level?: number | undefined
@@ -1479,7 +1482,13 @@ export interface Routes {
1479
1482
  image_url?: string | undefined
1480
1483
  image_alt_text?: string | undefined
1481
1484
  serial_number?: string | undefined
1485
+ /** Currently possible to use online access codes */
1486
+ online_access_codes_enabled?: boolean | undefined
1487
+ /** Currently possible to use offline access codes */
1488
+ offline_access_codes_enabled?: boolean | undefined
1489
+ /** Deprecated: use model.offline_access_codes_enabled. */
1482
1490
  supports_accessory_keypad?: boolean | undefined
1491
+ /** Deprecated: use model.accessory_keypad_supported. */
1483
1492
  supports_offline_access_codes?: boolean | undefined
1484
1493
  } & {
1485
1494
  august_metadata?:
@@ -2164,6 +2173,9 @@ export interface Routes {
2164
2173
  model: {
2165
2174
  display_name: string
2166
2175
  manufacturer_display_name: string
2176
+ offline_access_codes_supported?: boolean | undefined
2177
+ access_codes_supported?: boolean | undefined
2178
+ accessory_keypad_supported?: boolean | undefined
2167
2179
  }
2168
2180
  has_direct_power?: boolean | undefined
2169
2181
  battery_level?: number | undefined
@@ -2177,7 +2189,13 @@ export interface Routes {
2177
2189
  image_url?: string | undefined
2178
2190
  image_alt_text?: string | undefined
2179
2191
  serial_number?: string | undefined
2192
+ /** Currently possible to use online access codes */
2193
+ online_access_codes_enabled?: boolean | undefined
2194
+ /** Currently possible to use offline access codes */
2195
+ offline_access_codes_enabled?: boolean | undefined
2196
+ /** Deprecated: use model.offline_access_codes_enabled. */
2180
2197
  supports_accessory_keypad?: boolean | undefined
2198
+ /** Deprecated: use model.accessory_keypad_supported. */
2181
2199
  supports_offline_access_codes?: boolean | undefined
2182
2200
  } & {
2183
2201
  august_metadata?:
@@ -3058,6 +3076,8 @@ export interface Routes {
3058
3076
  | 'device.salto.privacy_mode_deactivated'
3059
3077
  | 'device.connection_became_flaky'
3060
3078
  | 'device.connection_stabilized'
3079
+ | 'device.error.subscription_required'
3080
+ | 'device.error.subscription_required.resolved'
3061
3081
  | 'access_code.created'
3062
3082
  | 'access_code.changed'
3063
3083
  | 'access_code.scheduled_on_device'
@@ -3104,6 +3124,8 @@ export interface Routes {
3104
3124
  | 'device.salto.privacy_mode_deactivated'
3105
3125
  | 'device.connection_became_flaky'
3106
3126
  | 'device.connection_stabilized'
3127
+ | 'device.error.subscription_required'
3128
+ | 'device.error.subscription_required.resolved'
3107
3129
  | 'access_code.created'
3108
3130
  | 'access_code.changed'
3109
3131
  | 'access_code.scheduled_on_device'
@@ -3234,8 +3256,1160 @@ export interface Routes {
3234
3256
  }
3235
3257
  formData: {}
3236
3258
  jsonResponse: {
3237
- lock?: any
3238
- device?: any
3259
+ lock: {
3260
+ device_id: string
3261
+ device_type:
3262
+ | (
3263
+ | 'akuvox_lock'
3264
+ | 'august_lock'
3265
+ | 'brivo_access_point'
3266
+ | 'butterflymx_panel'
3267
+ | 'avigilon_alta_entry'
3268
+ | 'doorking_lock'
3269
+ | 'genie_door'
3270
+ | 'igloo_lock'
3271
+ | 'linear_lock'
3272
+ | 'lockly_lock'
3273
+ | 'kwikset_lock'
3274
+ | 'nuki_lock'
3275
+ | 'salto_lock'
3276
+ | 'schlage_lock'
3277
+ | 'seam_relay'
3278
+ | 'smartthings_lock'
3279
+ | 'wyze_lock'
3280
+ | 'yale_lock'
3281
+ | 'two_n_intercom'
3282
+ | 'controlbyweb_device'
3283
+ | 'ttlock_lock'
3284
+ | 'igloohome_lock'
3285
+ | 'hubitat_lock'
3286
+ | 'four_suites_door'
3287
+ | 'dormakaba_oracode_door'
3288
+ )
3289
+ | ('noiseaware_activity_zone' | 'minut_sensor')
3290
+ | ('ecobee_thermostat' | 'nest_thermostat')
3291
+ capabilities_supported: Array<
3292
+ 'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
3293
+ >
3294
+ properties: ({
3295
+ online: boolean
3296
+ name: string
3297
+ model: {
3298
+ display_name: string
3299
+ manufacturer_display_name: string
3300
+ }
3301
+ has_direct_power?: boolean | undefined
3302
+ battery_level?: number | undefined
3303
+ battery?:
3304
+ | {
3305
+ level: number
3306
+ status: 'critical' | 'low' | 'good' | 'full'
3307
+ }
3308
+ | undefined
3309
+ manufacturer?: string | undefined
3310
+ image_url?: string | undefined
3311
+ image_alt_text?: string | undefined
3312
+ serial_number?: string | undefined
3313
+ supports_accessory_keypad?: boolean | undefined
3314
+ supports_offline_access_codes?: boolean | undefined
3315
+ } & {
3316
+ august_metadata?:
3317
+ | {
3318
+ lock_id: string
3319
+ lock_name: string
3320
+ house_name: string
3321
+ has_keypad: boolean
3322
+ keypad_battery_level?: string | undefined
3323
+ model?: string | undefined
3324
+ house_id?: string | undefined
3325
+ }
3326
+ | undefined
3327
+ avigilon_alta_metadata?:
3328
+ | {
3329
+ entry_name: string
3330
+ org_name: string
3331
+ zone_id: number
3332
+ zone_name: string
3333
+ site_id: number
3334
+ site_name: string
3335
+ }
3336
+ | undefined
3337
+ schlage_metadata?:
3338
+ | {
3339
+ device_id: string
3340
+ device_name: string
3341
+ access_code_length: number
3342
+ model?: string | undefined
3343
+ }
3344
+ | undefined
3345
+ smartthings_metadata?:
3346
+ | {
3347
+ device_id: string
3348
+ device_name: string
3349
+ model?: string | undefined
3350
+ location_id?: string | undefined
3351
+ }
3352
+ | undefined
3353
+ lockly_metadata?:
3354
+ | {
3355
+ device_id: string
3356
+ device_name: string
3357
+ model?: string | undefined
3358
+ }
3359
+ | undefined
3360
+ nuki_metadata?:
3361
+ | {
3362
+ device_id: string
3363
+ device_name: string
3364
+ keypad_battery_critical?: boolean | undefined
3365
+ }
3366
+ | undefined
3367
+ kwikset_metadata?:
3368
+ | {
3369
+ device_id: string
3370
+ device_name: string
3371
+ model_number: string
3372
+ }
3373
+ | undefined
3374
+ salto_metadata?:
3375
+ | {
3376
+ lock_id: string
3377
+ customer_reference: string
3378
+ lock_type: string
3379
+ battery_level: string
3380
+ locked_state: string
3381
+ model?: string | undefined
3382
+ }
3383
+ | undefined
3384
+ genie_metadata?:
3385
+ | {
3386
+ device_name: string
3387
+ door_name: string
3388
+ }
3389
+ | undefined
3390
+ brivo_metadata?:
3391
+ | {
3392
+ device_name: string
3393
+ }
3394
+ | undefined
3395
+ igloo_metadata?:
3396
+ | {
3397
+ device_id: string
3398
+ bridge_id: string
3399
+ model?: string | undefined
3400
+ }
3401
+ | undefined
3402
+ noiseaware_metadata?:
3403
+ | {
3404
+ device_model: 'indoor' | 'outdoor'
3405
+ noise_level_nrs: number
3406
+ noise_level_decibel: number
3407
+ device_name: string
3408
+ device_id: string
3409
+ }
3410
+ | undefined
3411
+ minut_metadata?:
3412
+ | {
3413
+ device_id: string
3414
+ device_name: string
3415
+ latest_sensor_values: {
3416
+ temperature: {
3417
+ time: string
3418
+ value: number
3419
+ }
3420
+ sound: {
3421
+ time: string
3422
+ value: number
3423
+ }
3424
+ humidity: {
3425
+ time: string
3426
+ value: number
3427
+ }
3428
+ pressure: {
3429
+ time: string
3430
+ value: number
3431
+ }
3432
+ accelerometer_z: {
3433
+ time: string
3434
+ value: number
3435
+ }
3436
+ }
3437
+ }
3438
+ | undefined
3439
+ four_suites_metadata?:
3440
+ | {
3441
+ device_id: number
3442
+ device_name: string
3443
+ reclose_delay_in_seconds: number
3444
+ }
3445
+ | undefined
3446
+ two_n_metadata?:
3447
+ | {
3448
+ device_id: number
3449
+ device_name: string
3450
+ }
3451
+ | undefined
3452
+ controlbyweb_metadata?:
3453
+ | {
3454
+ device_id: string
3455
+ device_name: string
3456
+ relay_name: string | null
3457
+ }
3458
+ | undefined
3459
+ ttlock_metadata?:
3460
+ | {
3461
+ lock_id: number
3462
+ lock_alias: string
3463
+ }
3464
+ | undefined
3465
+ seam_bridge_metadata?:
3466
+ | {
3467
+ unlock_method?: ('bridge' | 'doorking') | undefined
3468
+ device_num: number
3469
+ name: string
3470
+ }
3471
+ | undefined
3472
+ igloohome_metadata?:
3473
+ | {
3474
+ device_id: string
3475
+ device_name: string
3476
+ bridge_id?: string | undefined
3477
+ bridge_name?: string | undefined
3478
+ }
3479
+ | undefined
3480
+ nest_metadata?:
3481
+ | {
3482
+ nest_device_id: string
3483
+ device_name: string
3484
+ custom_name: string
3485
+ }
3486
+ | undefined
3487
+ ecobee_metadata?:
3488
+ | {
3489
+ ecobee_device_id: string
3490
+ device_name: string
3491
+ }
3492
+ | undefined
3493
+ hubitat_metadata?:
3494
+ | {
3495
+ device_id: string
3496
+ device_name: string
3497
+ device_label: string
3498
+ }
3499
+ | undefined
3500
+ dormakaba_oracode_metadata?:
3501
+ | {
3502
+ door_id: number
3503
+ door_name: string
3504
+ device_id?: number | undefined
3505
+ site_id: number
3506
+ site_name: string
3507
+ }
3508
+ | undefined
3509
+ wyze_metadata?:
3510
+ | {
3511
+ device_id: string
3512
+ device_name: string
3513
+ product_name: string
3514
+ product_type: string
3515
+ product_model: string
3516
+ device_info_model: string
3517
+ }
3518
+ | undefined
3519
+ }) &
3520
+ ({
3521
+ code_constraints?:
3522
+ | (
3523
+ | Array<
3524
+ | {
3525
+ constraint_type:
3526
+ | 'no_zeros'
3527
+ | 'cannot_start_with_12'
3528
+ | 'no_triple_consecutive_ints'
3529
+ | 'cannot_specify_pin_code'
3530
+ | 'pin_code_matches_existing_set'
3531
+ | 'start_date_in_future'
3532
+ }
3533
+ | {
3534
+ constraint_type: 'name_length'
3535
+ min_length?: number | undefined
3536
+ max_length?: number | undefined
3537
+ }
3538
+ >
3539
+ | undefined
3540
+ )
3541
+ | undefined
3542
+ supported_code_lengths?: (number[] | undefined) | undefined
3543
+ max_active_codes_supported?: (number | undefined) | undefined
3544
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
3545
+ has_native_entry_events?: (boolean | undefined) | undefined
3546
+ locked?: (boolean | undefined) | undefined
3547
+ keypad_battery?:
3548
+ | (
3549
+ | {
3550
+ level: number
3551
+ }
3552
+ | undefined
3553
+ )
3554
+ | undefined
3555
+ door_open?: (boolean | undefined) | undefined
3556
+ } & (
3557
+ | {
3558
+ temperature_fahrenheit?: number | undefined
3559
+ temperature_celsius?: number | undefined
3560
+ relative_humidity?: number | undefined
3561
+ can_enable_automatic_heating?: boolean | undefined
3562
+ can_enable_automatic_cooling?: boolean | undefined
3563
+ available_hvac_mode_settings?:
3564
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
3565
+ | undefined
3566
+ is_heating_available?: true | undefined
3567
+ is_cooling_available?: true | undefined
3568
+ is_heating?: boolean | undefined
3569
+ is_cooling?: boolean | undefined
3570
+ is_fan_running?: boolean | undefined
3571
+ fan_mode_setting?: ('auto' | 'on') | undefined
3572
+ is_temporary_manual_override_active?: boolean | undefined
3573
+ current_climate_setting?:
3574
+ | {
3575
+ automatic_heating_enabled: boolean
3576
+ automatic_cooling_enabled: boolean
3577
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
3578
+ cooling_set_point_celsius?: number | undefined
3579
+ heating_set_point_celsius?: number | undefined
3580
+ cooling_set_point_fahrenheit?: number | undefined
3581
+ heating_set_point_fahrenheit?: number | undefined
3582
+ manual_override_allowed: boolean
3583
+ }
3584
+ | undefined
3585
+ default_climate_setting?:
3586
+ | (
3587
+ | {
3588
+ automatic_heating_enabled: boolean
3589
+ automatic_cooling_enabled: boolean
3590
+ hvac_mode_setting:
3591
+ | 'off'
3592
+ | 'heat'
3593
+ | 'cool'
3594
+ | 'heat_cool'
3595
+ cooling_set_point_celsius?: number | undefined
3596
+ heating_set_point_celsius?: number | undefined
3597
+ cooling_set_point_fahrenheit?: number | undefined
3598
+ heating_set_point_fahrenheit?: number | undefined
3599
+ manual_override_allowed: boolean
3600
+ }
3601
+ | undefined
3602
+ )
3603
+ | undefined
3604
+ is_climate_setting_schedule_active?: boolean | undefined
3605
+ active_climate_setting_schedule?:
3606
+ | (
3607
+ | {
3608
+ climate_setting_schedule_id: string
3609
+ schedule_type: 'time_bound'
3610
+ device_id: string
3611
+ name?: string | undefined
3612
+ schedule_starts_at: string
3613
+ schedule_ends_at: string
3614
+ created_at: string
3615
+ automatic_heating_enabled?: boolean | undefined
3616
+ automatic_cooling_enabled?: boolean | undefined
3617
+ hvac_mode_setting?:
3618
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
3619
+ | undefined
3620
+ cooling_set_point_celsius?:
3621
+ | (number | undefined)
3622
+ | undefined
3623
+ heating_set_point_celsius?:
3624
+ | (number | undefined)
3625
+ | undefined
3626
+ cooling_set_point_fahrenheit?:
3627
+ | (number | undefined)
3628
+ | undefined
3629
+ heating_set_point_fahrenheit?:
3630
+ | (number | undefined)
3631
+ | undefined
3632
+ manual_override_allowed?: boolean | undefined
3633
+ }
3634
+ | undefined
3635
+ )
3636
+ | undefined
3637
+ min_cooling_set_point_celsius?: number | undefined
3638
+ min_cooling_set_point_fahrenheit?: number | undefined
3639
+ max_cooling_set_point_celsius?: number | undefined
3640
+ max_cooling_set_point_fahrenheit?: number | undefined
3641
+ min_heating_set_point_celsius?: number | undefined
3642
+ min_heating_set_point_fahrenheit?: number | undefined
3643
+ max_heating_set_point_celsius?: number | undefined
3644
+ max_heating_set_point_fahrenheit?: number | undefined
3645
+ min_heating_cooling_delta_celsius?: number | undefined
3646
+ min_heating_cooling_delta_fahrenheit?: number | undefined
3647
+ }
3648
+ | {
3649
+ temperature_fahrenheit?: number | undefined
3650
+ temperature_celsius?: number | undefined
3651
+ relative_humidity?: number | undefined
3652
+ can_enable_automatic_heating?: boolean | undefined
3653
+ can_enable_automatic_cooling?: boolean | undefined
3654
+ available_hvac_mode_settings?:
3655
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
3656
+ | undefined
3657
+ is_heating_available?: true | undefined
3658
+ is_cooling_available?: false | undefined
3659
+ is_heating?: boolean | undefined
3660
+ is_cooling?: boolean | undefined
3661
+ is_fan_running?: boolean | undefined
3662
+ fan_mode_setting?: ('auto' | 'on') | undefined
3663
+ is_temporary_manual_override_active?: boolean | undefined
3664
+ current_climate_setting?:
3665
+ | {
3666
+ automatic_heating_enabled: boolean
3667
+ automatic_cooling_enabled: boolean
3668
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
3669
+ cooling_set_point_celsius?: number | undefined
3670
+ heating_set_point_celsius?: number | undefined
3671
+ cooling_set_point_fahrenheit?: number | undefined
3672
+ heating_set_point_fahrenheit?: number | undefined
3673
+ manual_override_allowed: boolean
3674
+ }
3675
+ | undefined
3676
+ default_climate_setting?:
3677
+ | (
3678
+ | {
3679
+ automatic_heating_enabled: boolean
3680
+ automatic_cooling_enabled: boolean
3681
+ hvac_mode_setting:
3682
+ | 'off'
3683
+ | 'heat'
3684
+ | 'cool'
3685
+ | 'heat_cool'
3686
+ cooling_set_point_celsius?: number | undefined
3687
+ heating_set_point_celsius?: number | undefined
3688
+ cooling_set_point_fahrenheit?: number | undefined
3689
+ heating_set_point_fahrenheit?: number | undefined
3690
+ manual_override_allowed: boolean
3691
+ }
3692
+ | undefined
3693
+ )
3694
+ | undefined
3695
+ is_climate_setting_schedule_active?: boolean | undefined
3696
+ active_climate_setting_schedule?:
3697
+ | (
3698
+ | {
3699
+ climate_setting_schedule_id: string
3700
+ schedule_type: 'time_bound'
3701
+ device_id: string
3702
+ name?: string | undefined
3703
+ schedule_starts_at: string
3704
+ schedule_ends_at: string
3705
+ created_at: string
3706
+ automatic_heating_enabled?: boolean | undefined
3707
+ automatic_cooling_enabled?: boolean | undefined
3708
+ hvac_mode_setting?:
3709
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
3710
+ | undefined
3711
+ cooling_set_point_celsius?:
3712
+ | (number | undefined)
3713
+ | undefined
3714
+ heating_set_point_celsius?:
3715
+ | (number | undefined)
3716
+ | undefined
3717
+ cooling_set_point_fahrenheit?:
3718
+ | (number | undefined)
3719
+ | undefined
3720
+ heating_set_point_fahrenheit?:
3721
+ | (number | undefined)
3722
+ | undefined
3723
+ manual_override_allowed?: boolean | undefined
3724
+ }
3725
+ | undefined
3726
+ )
3727
+ | undefined
3728
+ min_heating_set_point_celsius?: number | undefined
3729
+ min_heating_set_point_fahrenheit?: number | undefined
3730
+ max_heating_set_point_celsius?: number | undefined
3731
+ max_heating_set_point_fahrenheit?: number | undefined
3732
+ }
3733
+ | {
3734
+ temperature_fahrenheit?: number | undefined
3735
+ temperature_celsius?: number | undefined
3736
+ relative_humidity?: number | undefined
3737
+ can_enable_automatic_heating?: boolean | undefined
3738
+ can_enable_automatic_cooling?: boolean | undefined
3739
+ available_hvac_mode_settings?:
3740
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
3741
+ | undefined
3742
+ is_heating_available?: false | undefined
3743
+ is_cooling_available?: true | undefined
3744
+ is_heating?: boolean | undefined
3745
+ is_cooling?: boolean | undefined
3746
+ is_fan_running?: boolean | undefined
3747
+ fan_mode_setting?: ('auto' | 'on') | undefined
3748
+ is_temporary_manual_override_active?: boolean | undefined
3749
+ current_climate_setting?:
3750
+ | {
3751
+ automatic_heating_enabled: boolean
3752
+ automatic_cooling_enabled: boolean
3753
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
3754
+ cooling_set_point_celsius?: number | undefined
3755
+ heating_set_point_celsius?: number | undefined
3756
+ cooling_set_point_fahrenheit?: number | undefined
3757
+ heating_set_point_fahrenheit?: number | undefined
3758
+ manual_override_allowed: boolean
3759
+ }
3760
+ | undefined
3761
+ default_climate_setting?:
3762
+ | (
3763
+ | {
3764
+ automatic_heating_enabled: boolean
3765
+ automatic_cooling_enabled: boolean
3766
+ hvac_mode_setting:
3767
+ | 'off'
3768
+ | 'heat'
3769
+ | 'cool'
3770
+ | 'heat_cool'
3771
+ cooling_set_point_celsius?: number | undefined
3772
+ heating_set_point_celsius?: number | undefined
3773
+ cooling_set_point_fahrenheit?: number | undefined
3774
+ heating_set_point_fahrenheit?: number | undefined
3775
+ manual_override_allowed: boolean
3776
+ }
3777
+ | undefined
3778
+ )
3779
+ | undefined
3780
+ is_climate_setting_schedule_active?: boolean | undefined
3781
+ active_climate_setting_schedule?:
3782
+ | (
3783
+ | {
3784
+ climate_setting_schedule_id: string
3785
+ schedule_type: 'time_bound'
3786
+ device_id: string
3787
+ name?: string | undefined
3788
+ schedule_starts_at: string
3789
+ schedule_ends_at: string
3790
+ created_at: string
3791
+ automatic_heating_enabled?: boolean | undefined
3792
+ automatic_cooling_enabled?: boolean | undefined
3793
+ hvac_mode_setting?:
3794
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
3795
+ | undefined
3796
+ cooling_set_point_celsius?:
3797
+ | (number | undefined)
3798
+ | undefined
3799
+ heating_set_point_celsius?:
3800
+ | (number | undefined)
3801
+ | undefined
3802
+ cooling_set_point_fahrenheit?:
3803
+ | (number | undefined)
3804
+ | undefined
3805
+ heating_set_point_fahrenheit?:
3806
+ | (number | undefined)
3807
+ | undefined
3808
+ manual_override_allowed?: boolean | undefined
3809
+ }
3810
+ | undefined
3811
+ )
3812
+ | undefined
3813
+ min_cooling_set_point_celsius?: number | undefined
3814
+ min_cooling_set_point_fahrenheit?: number | undefined
3815
+ max_cooling_set_point_celsius?: number | undefined
3816
+ max_cooling_set_point_fahrenheit?: number | undefined
3817
+ }
3818
+ ))
3819
+ location: {
3820
+ location_name?: string | undefined
3821
+ timezone?: string | undefined
3822
+ } | null
3823
+ connected_account_id: string
3824
+ workspace_id: string
3825
+ errors: Array<{
3826
+ error_code: string
3827
+ message: string
3828
+ }>
3829
+ warnings: Array<{
3830
+ warning_code: string
3831
+ message: string
3832
+ }>
3833
+ created_at: string
3834
+ is_managed: true
3835
+ }
3836
+ device: {
3837
+ device_id: string
3838
+ device_type:
3839
+ | (
3840
+ | 'akuvox_lock'
3841
+ | 'august_lock'
3842
+ | 'brivo_access_point'
3843
+ | 'butterflymx_panel'
3844
+ | 'avigilon_alta_entry'
3845
+ | 'doorking_lock'
3846
+ | 'genie_door'
3847
+ | 'igloo_lock'
3848
+ | 'linear_lock'
3849
+ | 'lockly_lock'
3850
+ | 'kwikset_lock'
3851
+ | 'nuki_lock'
3852
+ | 'salto_lock'
3853
+ | 'schlage_lock'
3854
+ | 'seam_relay'
3855
+ | 'smartthings_lock'
3856
+ | 'wyze_lock'
3857
+ | 'yale_lock'
3858
+ | 'two_n_intercom'
3859
+ | 'controlbyweb_device'
3860
+ | 'ttlock_lock'
3861
+ | 'igloohome_lock'
3862
+ | 'hubitat_lock'
3863
+ | 'four_suites_door'
3864
+ | 'dormakaba_oracode_door'
3865
+ )
3866
+ | ('noiseaware_activity_zone' | 'minut_sensor')
3867
+ | ('ecobee_thermostat' | 'nest_thermostat')
3868
+ capabilities_supported: Array<
3869
+ 'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
3870
+ >
3871
+ properties: ({
3872
+ online: boolean
3873
+ name: string
3874
+ model: {
3875
+ display_name: string
3876
+ manufacturer_display_name: string
3877
+ }
3878
+ has_direct_power?: boolean | undefined
3879
+ battery_level?: number | undefined
3880
+ battery?:
3881
+ | {
3882
+ level: number
3883
+ status: 'critical' | 'low' | 'good' | 'full'
3884
+ }
3885
+ | undefined
3886
+ manufacturer?: string | undefined
3887
+ image_url?: string | undefined
3888
+ image_alt_text?: string | undefined
3889
+ serial_number?: string | undefined
3890
+ supports_accessory_keypad?: boolean | undefined
3891
+ supports_offline_access_codes?: boolean | undefined
3892
+ } & {
3893
+ august_metadata?:
3894
+ | {
3895
+ lock_id: string
3896
+ lock_name: string
3897
+ house_name: string
3898
+ has_keypad: boolean
3899
+ keypad_battery_level?: string | undefined
3900
+ model?: string | undefined
3901
+ house_id?: string | undefined
3902
+ }
3903
+ | undefined
3904
+ avigilon_alta_metadata?:
3905
+ | {
3906
+ entry_name: string
3907
+ org_name: string
3908
+ zone_id: number
3909
+ zone_name: string
3910
+ site_id: number
3911
+ site_name: string
3912
+ }
3913
+ | undefined
3914
+ schlage_metadata?:
3915
+ | {
3916
+ device_id: string
3917
+ device_name: string
3918
+ access_code_length: number
3919
+ model?: string | undefined
3920
+ }
3921
+ | undefined
3922
+ smartthings_metadata?:
3923
+ | {
3924
+ device_id: string
3925
+ device_name: string
3926
+ model?: string | undefined
3927
+ location_id?: string | undefined
3928
+ }
3929
+ | undefined
3930
+ lockly_metadata?:
3931
+ | {
3932
+ device_id: string
3933
+ device_name: string
3934
+ model?: string | undefined
3935
+ }
3936
+ | undefined
3937
+ nuki_metadata?:
3938
+ | {
3939
+ device_id: string
3940
+ device_name: string
3941
+ keypad_battery_critical?: boolean | undefined
3942
+ }
3943
+ | undefined
3944
+ kwikset_metadata?:
3945
+ | {
3946
+ device_id: string
3947
+ device_name: string
3948
+ model_number: string
3949
+ }
3950
+ | undefined
3951
+ salto_metadata?:
3952
+ | {
3953
+ lock_id: string
3954
+ customer_reference: string
3955
+ lock_type: string
3956
+ battery_level: string
3957
+ locked_state: string
3958
+ model?: string | undefined
3959
+ }
3960
+ | undefined
3961
+ genie_metadata?:
3962
+ | {
3963
+ device_name: string
3964
+ door_name: string
3965
+ }
3966
+ | undefined
3967
+ brivo_metadata?:
3968
+ | {
3969
+ device_name: string
3970
+ }
3971
+ | undefined
3972
+ igloo_metadata?:
3973
+ | {
3974
+ device_id: string
3975
+ bridge_id: string
3976
+ model?: string | undefined
3977
+ }
3978
+ | undefined
3979
+ noiseaware_metadata?:
3980
+ | {
3981
+ device_model: 'indoor' | 'outdoor'
3982
+ noise_level_nrs: number
3983
+ noise_level_decibel: number
3984
+ device_name: string
3985
+ device_id: string
3986
+ }
3987
+ | undefined
3988
+ minut_metadata?:
3989
+ | {
3990
+ device_id: string
3991
+ device_name: string
3992
+ latest_sensor_values: {
3993
+ temperature: {
3994
+ time: string
3995
+ value: number
3996
+ }
3997
+ sound: {
3998
+ time: string
3999
+ value: number
4000
+ }
4001
+ humidity: {
4002
+ time: string
4003
+ value: number
4004
+ }
4005
+ pressure: {
4006
+ time: string
4007
+ value: number
4008
+ }
4009
+ accelerometer_z: {
4010
+ time: string
4011
+ value: number
4012
+ }
4013
+ }
4014
+ }
4015
+ | undefined
4016
+ four_suites_metadata?:
4017
+ | {
4018
+ device_id: number
4019
+ device_name: string
4020
+ reclose_delay_in_seconds: number
4021
+ }
4022
+ | undefined
4023
+ two_n_metadata?:
4024
+ | {
4025
+ device_id: number
4026
+ device_name: string
4027
+ }
4028
+ | undefined
4029
+ controlbyweb_metadata?:
4030
+ | {
4031
+ device_id: string
4032
+ device_name: string
4033
+ relay_name: string | null
4034
+ }
4035
+ | undefined
4036
+ ttlock_metadata?:
4037
+ | {
4038
+ lock_id: number
4039
+ lock_alias: string
4040
+ }
4041
+ | undefined
4042
+ seam_bridge_metadata?:
4043
+ | {
4044
+ unlock_method?: ('bridge' | 'doorking') | undefined
4045
+ device_num: number
4046
+ name: string
4047
+ }
4048
+ | undefined
4049
+ igloohome_metadata?:
4050
+ | {
4051
+ device_id: string
4052
+ device_name: string
4053
+ bridge_id?: string | undefined
4054
+ bridge_name?: string | undefined
4055
+ }
4056
+ | undefined
4057
+ nest_metadata?:
4058
+ | {
4059
+ nest_device_id: string
4060
+ device_name: string
4061
+ custom_name: string
4062
+ }
4063
+ | undefined
4064
+ ecobee_metadata?:
4065
+ | {
4066
+ ecobee_device_id: string
4067
+ device_name: string
4068
+ }
4069
+ | undefined
4070
+ hubitat_metadata?:
4071
+ | {
4072
+ device_id: string
4073
+ device_name: string
4074
+ device_label: string
4075
+ }
4076
+ | undefined
4077
+ dormakaba_oracode_metadata?:
4078
+ | {
4079
+ door_id: number
4080
+ door_name: string
4081
+ device_id?: number | undefined
4082
+ site_id: number
4083
+ site_name: string
4084
+ }
4085
+ | undefined
4086
+ wyze_metadata?:
4087
+ | {
4088
+ device_id: string
4089
+ device_name: string
4090
+ product_name: string
4091
+ product_type: string
4092
+ product_model: string
4093
+ device_info_model: string
4094
+ }
4095
+ | undefined
4096
+ }) &
4097
+ ({
4098
+ code_constraints?:
4099
+ | (
4100
+ | Array<
4101
+ | {
4102
+ constraint_type:
4103
+ | 'no_zeros'
4104
+ | 'cannot_start_with_12'
4105
+ | 'no_triple_consecutive_ints'
4106
+ | 'cannot_specify_pin_code'
4107
+ | 'pin_code_matches_existing_set'
4108
+ | 'start_date_in_future'
4109
+ }
4110
+ | {
4111
+ constraint_type: 'name_length'
4112
+ min_length?: number | undefined
4113
+ max_length?: number | undefined
4114
+ }
4115
+ >
4116
+ | undefined
4117
+ )
4118
+ | undefined
4119
+ supported_code_lengths?: (number[] | undefined) | undefined
4120
+ max_active_codes_supported?: (number | undefined) | undefined
4121
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
4122
+ has_native_entry_events?: (boolean | undefined) | undefined
4123
+ locked?: (boolean | undefined) | undefined
4124
+ keypad_battery?:
4125
+ | (
4126
+ | {
4127
+ level: number
4128
+ }
4129
+ | undefined
4130
+ )
4131
+ | undefined
4132
+ door_open?: (boolean | undefined) | undefined
4133
+ } & (
4134
+ | {
4135
+ temperature_fahrenheit?: number | undefined
4136
+ temperature_celsius?: number | undefined
4137
+ relative_humidity?: number | undefined
4138
+ can_enable_automatic_heating?: boolean | undefined
4139
+ can_enable_automatic_cooling?: boolean | undefined
4140
+ available_hvac_mode_settings?:
4141
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
4142
+ | undefined
4143
+ is_heating_available?: true | undefined
4144
+ is_cooling_available?: true | undefined
4145
+ is_heating?: boolean | undefined
4146
+ is_cooling?: boolean | undefined
4147
+ is_fan_running?: boolean | undefined
4148
+ fan_mode_setting?: ('auto' | 'on') | undefined
4149
+ is_temporary_manual_override_active?: boolean | undefined
4150
+ current_climate_setting?:
4151
+ | {
4152
+ automatic_heating_enabled: boolean
4153
+ automatic_cooling_enabled: boolean
4154
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
4155
+ cooling_set_point_celsius?: number | undefined
4156
+ heating_set_point_celsius?: number | undefined
4157
+ cooling_set_point_fahrenheit?: number | undefined
4158
+ heating_set_point_fahrenheit?: number | undefined
4159
+ manual_override_allowed: boolean
4160
+ }
4161
+ | undefined
4162
+ default_climate_setting?:
4163
+ | (
4164
+ | {
4165
+ automatic_heating_enabled: boolean
4166
+ automatic_cooling_enabled: boolean
4167
+ hvac_mode_setting:
4168
+ | 'off'
4169
+ | 'heat'
4170
+ | 'cool'
4171
+ | 'heat_cool'
4172
+ cooling_set_point_celsius?: number | undefined
4173
+ heating_set_point_celsius?: number | undefined
4174
+ cooling_set_point_fahrenheit?: number | undefined
4175
+ heating_set_point_fahrenheit?: number | undefined
4176
+ manual_override_allowed: boolean
4177
+ }
4178
+ | undefined
4179
+ )
4180
+ | undefined
4181
+ is_climate_setting_schedule_active?: boolean | undefined
4182
+ active_climate_setting_schedule?:
4183
+ | (
4184
+ | {
4185
+ climate_setting_schedule_id: string
4186
+ schedule_type: 'time_bound'
4187
+ device_id: string
4188
+ name?: string | undefined
4189
+ schedule_starts_at: string
4190
+ schedule_ends_at: string
4191
+ created_at: string
4192
+ automatic_heating_enabled?: boolean | undefined
4193
+ automatic_cooling_enabled?: boolean | undefined
4194
+ hvac_mode_setting?:
4195
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
4196
+ | undefined
4197
+ cooling_set_point_celsius?:
4198
+ | (number | undefined)
4199
+ | undefined
4200
+ heating_set_point_celsius?:
4201
+ | (number | undefined)
4202
+ | undefined
4203
+ cooling_set_point_fahrenheit?:
4204
+ | (number | undefined)
4205
+ | undefined
4206
+ heating_set_point_fahrenheit?:
4207
+ | (number | undefined)
4208
+ | undefined
4209
+ manual_override_allowed?: boolean | undefined
4210
+ }
4211
+ | undefined
4212
+ )
4213
+ | undefined
4214
+ min_cooling_set_point_celsius?: number | undefined
4215
+ min_cooling_set_point_fahrenheit?: number | undefined
4216
+ max_cooling_set_point_celsius?: number | undefined
4217
+ max_cooling_set_point_fahrenheit?: number | undefined
4218
+ min_heating_set_point_celsius?: number | undefined
4219
+ min_heating_set_point_fahrenheit?: number | undefined
4220
+ max_heating_set_point_celsius?: number | undefined
4221
+ max_heating_set_point_fahrenheit?: number | undefined
4222
+ min_heating_cooling_delta_celsius?: number | undefined
4223
+ min_heating_cooling_delta_fahrenheit?: number | undefined
4224
+ }
4225
+ | {
4226
+ temperature_fahrenheit?: number | undefined
4227
+ temperature_celsius?: number | undefined
4228
+ relative_humidity?: number | undefined
4229
+ can_enable_automatic_heating?: boolean | undefined
4230
+ can_enable_automatic_cooling?: boolean | undefined
4231
+ available_hvac_mode_settings?:
4232
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
4233
+ | undefined
4234
+ is_heating_available?: true | undefined
4235
+ is_cooling_available?: false | undefined
4236
+ is_heating?: boolean | undefined
4237
+ is_cooling?: boolean | undefined
4238
+ is_fan_running?: boolean | undefined
4239
+ fan_mode_setting?: ('auto' | 'on') | undefined
4240
+ is_temporary_manual_override_active?: boolean | undefined
4241
+ current_climate_setting?:
4242
+ | {
4243
+ automatic_heating_enabled: boolean
4244
+ automatic_cooling_enabled: boolean
4245
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
4246
+ cooling_set_point_celsius?: number | undefined
4247
+ heating_set_point_celsius?: number | undefined
4248
+ cooling_set_point_fahrenheit?: number | undefined
4249
+ heating_set_point_fahrenheit?: number | undefined
4250
+ manual_override_allowed: boolean
4251
+ }
4252
+ | undefined
4253
+ default_climate_setting?:
4254
+ | (
4255
+ | {
4256
+ automatic_heating_enabled: boolean
4257
+ automatic_cooling_enabled: boolean
4258
+ hvac_mode_setting:
4259
+ | 'off'
4260
+ | 'heat'
4261
+ | 'cool'
4262
+ | 'heat_cool'
4263
+ cooling_set_point_celsius?: number | undefined
4264
+ heating_set_point_celsius?: number | undefined
4265
+ cooling_set_point_fahrenheit?: number | undefined
4266
+ heating_set_point_fahrenheit?: number | undefined
4267
+ manual_override_allowed: boolean
4268
+ }
4269
+ | undefined
4270
+ )
4271
+ | undefined
4272
+ is_climate_setting_schedule_active?: boolean | undefined
4273
+ active_climate_setting_schedule?:
4274
+ | (
4275
+ | {
4276
+ climate_setting_schedule_id: string
4277
+ schedule_type: 'time_bound'
4278
+ device_id: string
4279
+ name?: string | undefined
4280
+ schedule_starts_at: string
4281
+ schedule_ends_at: string
4282
+ created_at: string
4283
+ automatic_heating_enabled?: boolean | undefined
4284
+ automatic_cooling_enabled?: boolean | undefined
4285
+ hvac_mode_setting?:
4286
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
4287
+ | undefined
4288
+ cooling_set_point_celsius?:
4289
+ | (number | undefined)
4290
+ | undefined
4291
+ heating_set_point_celsius?:
4292
+ | (number | undefined)
4293
+ | undefined
4294
+ cooling_set_point_fahrenheit?:
4295
+ | (number | undefined)
4296
+ | undefined
4297
+ heating_set_point_fahrenheit?:
4298
+ | (number | undefined)
4299
+ | undefined
4300
+ manual_override_allowed?: boolean | undefined
4301
+ }
4302
+ | undefined
4303
+ )
4304
+ | undefined
4305
+ min_heating_set_point_celsius?: number | undefined
4306
+ min_heating_set_point_fahrenheit?: number | undefined
4307
+ max_heating_set_point_celsius?: number | undefined
4308
+ max_heating_set_point_fahrenheit?: number | undefined
4309
+ }
4310
+ | {
4311
+ temperature_fahrenheit?: number | undefined
4312
+ temperature_celsius?: number | undefined
4313
+ relative_humidity?: number | undefined
4314
+ can_enable_automatic_heating?: boolean | undefined
4315
+ can_enable_automatic_cooling?: boolean | undefined
4316
+ available_hvac_mode_settings?:
4317
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
4318
+ | undefined
4319
+ is_heating_available?: false | undefined
4320
+ is_cooling_available?: true | undefined
4321
+ is_heating?: boolean | undefined
4322
+ is_cooling?: boolean | undefined
4323
+ is_fan_running?: boolean | undefined
4324
+ fan_mode_setting?: ('auto' | 'on') | undefined
4325
+ is_temporary_manual_override_active?: boolean | undefined
4326
+ current_climate_setting?:
4327
+ | {
4328
+ automatic_heating_enabled: boolean
4329
+ automatic_cooling_enabled: boolean
4330
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
4331
+ cooling_set_point_celsius?: number | undefined
4332
+ heating_set_point_celsius?: number | undefined
4333
+ cooling_set_point_fahrenheit?: number | undefined
4334
+ heating_set_point_fahrenheit?: number | undefined
4335
+ manual_override_allowed: boolean
4336
+ }
4337
+ | undefined
4338
+ default_climate_setting?:
4339
+ | (
4340
+ | {
4341
+ automatic_heating_enabled: boolean
4342
+ automatic_cooling_enabled: boolean
4343
+ hvac_mode_setting:
4344
+ | 'off'
4345
+ | 'heat'
4346
+ | 'cool'
4347
+ | 'heat_cool'
4348
+ cooling_set_point_celsius?: number | undefined
4349
+ heating_set_point_celsius?: number | undefined
4350
+ cooling_set_point_fahrenheit?: number | undefined
4351
+ heating_set_point_fahrenheit?: number | undefined
4352
+ manual_override_allowed: boolean
4353
+ }
4354
+ | undefined
4355
+ )
4356
+ | undefined
4357
+ is_climate_setting_schedule_active?: boolean | undefined
4358
+ active_climate_setting_schedule?:
4359
+ | (
4360
+ | {
4361
+ climate_setting_schedule_id: string
4362
+ schedule_type: 'time_bound'
4363
+ device_id: string
4364
+ name?: string | undefined
4365
+ schedule_starts_at: string
4366
+ schedule_ends_at: string
4367
+ created_at: string
4368
+ automatic_heating_enabled?: boolean | undefined
4369
+ automatic_cooling_enabled?: boolean | undefined
4370
+ hvac_mode_setting?:
4371
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
4372
+ | undefined
4373
+ cooling_set_point_celsius?:
4374
+ | (number | undefined)
4375
+ | undefined
4376
+ heating_set_point_celsius?:
4377
+ | (number | undefined)
4378
+ | undefined
4379
+ cooling_set_point_fahrenheit?:
4380
+ | (number | undefined)
4381
+ | undefined
4382
+ heating_set_point_fahrenheit?:
4383
+ | (number | undefined)
4384
+ | undefined
4385
+ manual_override_allowed?: boolean | undefined
4386
+ }
4387
+ | undefined
4388
+ )
4389
+ | undefined
4390
+ min_cooling_set_point_celsius?: number | undefined
4391
+ min_cooling_set_point_fahrenheit?: number | undefined
4392
+ max_cooling_set_point_celsius?: number | undefined
4393
+ max_cooling_set_point_fahrenheit?: number | undefined
4394
+ }
4395
+ ))
4396
+ location: {
4397
+ location_name?: string | undefined
4398
+ timezone?: string | undefined
4399
+ } | null
4400
+ connected_account_id: string
4401
+ workspace_id: string
4402
+ errors: Array<{
4403
+ error_code: string
4404
+ message: string
4405
+ }>
4406
+ warnings: Array<{
4407
+ warning_code: string
4408
+ message: string
4409
+ }>
4410
+ created_at: string
4411
+ is_managed: true
4412
+ }
3239
4413
  }
3240
4414
  }
3241
4415
  '/locks/list': {
@@ -3357,8 +4531,1160 @@ export interface Routes {
3357
4531
  }
3358
4532
  formData: {}
3359
4533
  jsonResponse: {
3360
- locks?: any
3361
- devices?: any
4534
+ locks: Array<{
4535
+ device_id: string
4536
+ device_type:
4537
+ | (
4538
+ | 'akuvox_lock'
4539
+ | 'august_lock'
4540
+ | 'brivo_access_point'
4541
+ | 'butterflymx_panel'
4542
+ | 'avigilon_alta_entry'
4543
+ | 'doorking_lock'
4544
+ | 'genie_door'
4545
+ | 'igloo_lock'
4546
+ | 'linear_lock'
4547
+ | 'lockly_lock'
4548
+ | 'kwikset_lock'
4549
+ | 'nuki_lock'
4550
+ | 'salto_lock'
4551
+ | 'schlage_lock'
4552
+ | 'seam_relay'
4553
+ | 'smartthings_lock'
4554
+ | 'wyze_lock'
4555
+ | 'yale_lock'
4556
+ | 'two_n_intercom'
4557
+ | 'controlbyweb_device'
4558
+ | 'ttlock_lock'
4559
+ | 'igloohome_lock'
4560
+ | 'hubitat_lock'
4561
+ | 'four_suites_door'
4562
+ | 'dormakaba_oracode_door'
4563
+ )
4564
+ | ('noiseaware_activity_zone' | 'minut_sensor')
4565
+ | ('ecobee_thermostat' | 'nest_thermostat')
4566
+ capabilities_supported: Array<
4567
+ 'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
4568
+ >
4569
+ properties: ({
4570
+ online: boolean
4571
+ name: string
4572
+ model: {
4573
+ display_name: string
4574
+ manufacturer_display_name: string
4575
+ }
4576
+ has_direct_power?: boolean | undefined
4577
+ battery_level?: number | undefined
4578
+ battery?:
4579
+ | {
4580
+ level: number
4581
+ status: 'critical' | 'low' | 'good' | 'full'
4582
+ }
4583
+ | undefined
4584
+ manufacturer?: string | undefined
4585
+ image_url?: string | undefined
4586
+ image_alt_text?: string | undefined
4587
+ serial_number?: string | undefined
4588
+ supports_accessory_keypad?: boolean | undefined
4589
+ supports_offline_access_codes?: boolean | undefined
4590
+ } & {
4591
+ august_metadata?:
4592
+ | {
4593
+ lock_id: string
4594
+ lock_name: string
4595
+ house_name: string
4596
+ has_keypad: boolean
4597
+ keypad_battery_level?: string | undefined
4598
+ model?: string | undefined
4599
+ house_id?: string | undefined
4600
+ }
4601
+ | undefined
4602
+ avigilon_alta_metadata?:
4603
+ | {
4604
+ entry_name: string
4605
+ org_name: string
4606
+ zone_id: number
4607
+ zone_name: string
4608
+ site_id: number
4609
+ site_name: string
4610
+ }
4611
+ | undefined
4612
+ schlage_metadata?:
4613
+ | {
4614
+ device_id: string
4615
+ device_name: string
4616
+ access_code_length: number
4617
+ model?: string | undefined
4618
+ }
4619
+ | undefined
4620
+ smartthings_metadata?:
4621
+ | {
4622
+ device_id: string
4623
+ device_name: string
4624
+ model?: string | undefined
4625
+ location_id?: string | undefined
4626
+ }
4627
+ | undefined
4628
+ lockly_metadata?:
4629
+ | {
4630
+ device_id: string
4631
+ device_name: string
4632
+ model?: string | undefined
4633
+ }
4634
+ | undefined
4635
+ nuki_metadata?:
4636
+ | {
4637
+ device_id: string
4638
+ device_name: string
4639
+ keypad_battery_critical?: boolean | undefined
4640
+ }
4641
+ | undefined
4642
+ kwikset_metadata?:
4643
+ | {
4644
+ device_id: string
4645
+ device_name: string
4646
+ model_number: string
4647
+ }
4648
+ | undefined
4649
+ salto_metadata?:
4650
+ | {
4651
+ lock_id: string
4652
+ customer_reference: string
4653
+ lock_type: string
4654
+ battery_level: string
4655
+ locked_state: string
4656
+ model?: string | undefined
4657
+ }
4658
+ | undefined
4659
+ genie_metadata?:
4660
+ | {
4661
+ device_name: string
4662
+ door_name: string
4663
+ }
4664
+ | undefined
4665
+ brivo_metadata?:
4666
+ | {
4667
+ device_name: string
4668
+ }
4669
+ | undefined
4670
+ igloo_metadata?:
4671
+ | {
4672
+ device_id: string
4673
+ bridge_id: string
4674
+ model?: string | undefined
4675
+ }
4676
+ | undefined
4677
+ noiseaware_metadata?:
4678
+ | {
4679
+ device_model: 'indoor' | 'outdoor'
4680
+ noise_level_nrs: number
4681
+ noise_level_decibel: number
4682
+ device_name: string
4683
+ device_id: string
4684
+ }
4685
+ | undefined
4686
+ minut_metadata?:
4687
+ | {
4688
+ device_id: string
4689
+ device_name: string
4690
+ latest_sensor_values: {
4691
+ temperature: {
4692
+ time: string
4693
+ value: number
4694
+ }
4695
+ sound: {
4696
+ time: string
4697
+ value: number
4698
+ }
4699
+ humidity: {
4700
+ time: string
4701
+ value: number
4702
+ }
4703
+ pressure: {
4704
+ time: string
4705
+ value: number
4706
+ }
4707
+ accelerometer_z: {
4708
+ time: string
4709
+ value: number
4710
+ }
4711
+ }
4712
+ }
4713
+ | undefined
4714
+ four_suites_metadata?:
4715
+ | {
4716
+ device_id: number
4717
+ device_name: string
4718
+ reclose_delay_in_seconds: number
4719
+ }
4720
+ | undefined
4721
+ two_n_metadata?:
4722
+ | {
4723
+ device_id: number
4724
+ device_name: string
4725
+ }
4726
+ | undefined
4727
+ controlbyweb_metadata?:
4728
+ | {
4729
+ device_id: string
4730
+ device_name: string
4731
+ relay_name: string | null
4732
+ }
4733
+ | undefined
4734
+ ttlock_metadata?:
4735
+ | {
4736
+ lock_id: number
4737
+ lock_alias: string
4738
+ }
4739
+ | undefined
4740
+ seam_bridge_metadata?:
4741
+ | {
4742
+ unlock_method?: ('bridge' | 'doorking') | undefined
4743
+ device_num: number
4744
+ name: string
4745
+ }
4746
+ | undefined
4747
+ igloohome_metadata?:
4748
+ | {
4749
+ device_id: string
4750
+ device_name: string
4751
+ bridge_id?: string | undefined
4752
+ bridge_name?: string | undefined
4753
+ }
4754
+ | undefined
4755
+ nest_metadata?:
4756
+ | {
4757
+ nest_device_id: string
4758
+ device_name: string
4759
+ custom_name: string
4760
+ }
4761
+ | undefined
4762
+ ecobee_metadata?:
4763
+ | {
4764
+ ecobee_device_id: string
4765
+ device_name: string
4766
+ }
4767
+ | undefined
4768
+ hubitat_metadata?:
4769
+ | {
4770
+ device_id: string
4771
+ device_name: string
4772
+ device_label: string
4773
+ }
4774
+ | undefined
4775
+ dormakaba_oracode_metadata?:
4776
+ | {
4777
+ door_id: number
4778
+ door_name: string
4779
+ device_id?: number | undefined
4780
+ site_id: number
4781
+ site_name: string
4782
+ }
4783
+ | undefined
4784
+ wyze_metadata?:
4785
+ | {
4786
+ device_id: string
4787
+ device_name: string
4788
+ product_name: string
4789
+ product_type: string
4790
+ product_model: string
4791
+ device_info_model: string
4792
+ }
4793
+ | undefined
4794
+ }) &
4795
+ ({
4796
+ code_constraints?:
4797
+ | (
4798
+ | Array<
4799
+ | {
4800
+ constraint_type:
4801
+ | 'no_zeros'
4802
+ | 'cannot_start_with_12'
4803
+ | 'no_triple_consecutive_ints'
4804
+ | 'cannot_specify_pin_code'
4805
+ | 'pin_code_matches_existing_set'
4806
+ | 'start_date_in_future'
4807
+ }
4808
+ | {
4809
+ constraint_type: 'name_length'
4810
+ min_length?: number | undefined
4811
+ max_length?: number | undefined
4812
+ }
4813
+ >
4814
+ | undefined
4815
+ )
4816
+ | undefined
4817
+ supported_code_lengths?: (number[] | undefined) | undefined
4818
+ max_active_codes_supported?: (number | undefined) | undefined
4819
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
4820
+ has_native_entry_events?: (boolean | undefined) | undefined
4821
+ locked?: (boolean | undefined) | undefined
4822
+ keypad_battery?:
4823
+ | (
4824
+ | {
4825
+ level: number
4826
+ }
4827
+ | undefined
4828
+ )
4829
+ | undefined
4830
+ door_open?: (boolean | undefined) | undefined
4831
+ } & (
4832
+ | {
4833
+ temperature_fahrenheit?: number | undefined
4834
+ temperature_celsius?: number | undefined
4835
+ relative_humidity?: number | undefined
4836
+ can_enable_automatic_heating?: boolean | undefined
4837
+ can_enable_automatic_cooling?: boolean | undefined
4838
+ available_hvac_mode_settings?:
4839
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
4840
+ | undefined
4841
+ is_heating_available?: true | undefined
4842
+ is_cooling_available?: true | undefined
4843
+ is_heating?: boolean | undefined
4844
+ is_cooling?: boolean | undefined
4845
+ is_fan_running?: boolean | undefined
4846
+ fan_mode_setting?: ('auto' | 'on') | undefined
4847
+ is_temporary_manual_override_active?: boolean | undefined
4848
+ current_climate_setting?:
4849
+ | {
4850
+ automatic_heating_enabled: boolean
4851
+ automatic_cooling_enabled: boolean
4852
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
4853
+ cooling_set_point_celsius?: number | undefined
4854
+ heating_set_point_celsius?: number | undefined
4855
+ cooling_set_point_fahrenheit?: number | undefined
4856
+ heating_set_point_fahrenheit?: number | undefined
4857
+ manual_override_allowed: boolean
4858
+ }
4859
+ | undefined
4860
+ default_climate_setting?:
4861
+ | (
4862
+ | {
4863
+ automatic_heating_enabled: boolean
4864
+ automatic_cooling_enabled: boolean
4865
+ hvac_mode_setting:
4866
+ | 'off'
4867
+ | 'heat'
4868
+ | 'cool'
4869
+ | 'heat_cool'
4870
+ cooling_set_point_celsius?: number | undefined
4871
+ heating_set_point_celsius?: number | undefined
4872
+ cooling_set_point_fahrenheit?: number | undefined
4873
+ heating_set_point_fahrenheit?: number | undefined
4874
+ manual_override_allowed: boolean
4875
+ }
4876
+ | undefined
4877
+ )
4878
+ | undefined
4879
+ is_climate_setting_schedule_active?: boolean | undefined
4880
+ active_climate_setting_schedule?:
4881
+ | (
4882
+ | {
4883
+ climate_setting_schedule_id: string
4884
+ schedule_type: 'time_bound'
4885
+ device_id: string
4886
+ name?: string | undefined
4887
+ schedule_starts_at: string
4888
+ schedule_ends_at: string
4889
+ created_at: string
4890
+ automatic_heating_enabled?: boolean | undefined
4891
+ automatic_cooling_enabled?: boolean | undefined
4892
+ hvac_mode_setting?:
4893
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
4894
+ | undefined
4895
+ cooling_set_point_celsius?:
4896
+ | (number | undefined)
4897
+ | undefined
4898
+ heating_set_point_celsius?:
4899
+ | (number | undefined)
4900
+ | undefined
4901
+ cooling_set_point_fahrenheit?:
4902
+ | (number | undefined)
4903
+ | undefined
4904
+ heating_set_point_fahrenheit?:
4905
+ | (number | undefined)
4906
+ | undefined
4907
+ manual_override_allowed?: boolean | undefined
4908
+ }
4909
+ | undefined
4910
+ )
4911
+ | undefined
4912
+ min_cooling_set_point_celsius?: number | undefined
4913
+ min_cooling_set_point_fahrenheit?: number | undefined
4914
+ max_cooling_set_point_celsius?: number | undefined
4915
+ max_cooling_set_point_fahrenheit?: number | undefined
4916
+ min_heating_set_point_celsius?: number | undefined
4917
+ min_heating_set_point_fahrenheit?: number | undefined
4918
+ max_heating_set_point_celsius?: number | undefined
4919
+ max_heating_set_point_fahrenheit?: number | undefined
4920
+ min_heating_cooling_delta_celsius?: number | undefined
4921
+ min_heating_cooling_delta_fahrenheit?: number | undefined
4922
+ }
4923
+ | {
4924
+ temperature_fahrenheit?: number | undefined
4925
+ temperature_celsius?: number | undefined
4926
+ relative_humidity?: number | undefined
4927
+ can_enable_automatic_heating?: boolean | undefined
4928
+ can_enable_automatic_cooling?: boolean | undefined
4929
+ available_hvac_mode_settings?:
4930
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
4931
+ | undefined
4932
+ is_heating_available?: true | undefined
4933
+ is_cooling_available?: false | undefined
4934
+ is_heating?: boolean | undefined
4935
+ is_cooling?: boolean | undefined
4936
+ is_fan_running?: boolean | undefined
4937
+ fan_mode_setting?: ('auto' | 'on') | undefined
4938
+ is_temporary_manual_override_active?: boolean | undefined
4939
+ current_climate_setting?:
4940
+ | {
4941
+ automatic_heating_enabled: boolean
4942
+ automatic_cooling_enabled: boolean
4943
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
4944
+ cooling_set_point_celsius?: number | undefined
4945
+ heating_set_point_celsius?: number | undefined
4946
+ cooling_set_point_fahrenheit?: number | undefined
4947
+ heating_set_point_fahrenheit?: number | undefined
4948
+ manual_override_allowed: boolean
4949
+ }
4950
+ | undefined
4951
+ default_climate_setting?:
4952
+ | (
4953
+ | {
4954
+ automatic_heating_enabled: boolean
4955
+ automatic_cooling_enabled: boolean
4956
+ hvac_mode_setting:
4957
+ | 'off'
4958
+ | 'heat'
4959
+ | 'cool'
4960
+ | 'heat_cool'
4961
+ cooling_set_point_celsius?: number | undefined
4962
+ heating_set_point_celsius?: number | undefined
4963
+ cooling_set_point_fahrenheit?: number | undefined
4964
+ heating_set_point_fahrenheit?: number | undefined
4965
+ manual_override_allowed: boolean
4966
+ }
4967
+ | undefined
4968
+ )
4969
+ | undefined
4970
+ is_climate_setting_schedule_active?: boolean | undefined
4971
+ active_climate_setting_schedule?:
4972
+ | (
4973
+ | {
4974
+ climate_setting_schedule_id: string
4975
+ schedule_type: 'time_bound'
4976
+ device_id: string
4977
+ name?: string | undefined
4978
+ schedule_starts_at: string
4979
+ schedule_ends_at: string
4980
+ created_at: string
4981
+ automatic_heating_enabled?: boolean | undefined
4982
+ automatic_cooling_enabled?: boolean | undefined
4983
+ hvac_mode_setting?:
4984
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
4985
+ | undefined
4986
+ cooling_set_point_celsius?:
4987
+ | (number | undefined)
4988
+ | undefined
4989
+ heating_set_point_celsius?:
4990
+ | (number | undefined)
4991
+ | undefined
4992
+ cooling_set_point_fahrenheit?:
4993
+ | (number | undefined)
4994
+ | undefined
4995
+ heating_set_point_fahrenheit?:
4996
+ | (number | undefined)
4997
+ | undefined
4998
+ manual_override_allowed?: boolean | undefined
4999
+ }
5000
+ | undefined
5001
+ )
5002
+ | undefined
5003
+ min_heating_set_point_celsius?: number | undefined
5004
+ min_heating_set_point_fahrenheit?: number | undefined
5005
+ max_heating_set_point_celsius?: number | undefined
5006
+ max_heating_set_point_fahrenheit?: number | undefined
5007
+ }
5008
+ | {
5009
+ temperature_fahrenheit?: number | undefined
5010
+ temperature_celsius?: number | undefined
5011
+ relative_humidity?: number | undefined
5012
+ can_enable_automatic_heating?: boolean | undefined
5013
+ can_enable_automatic_cooling?: boolean | undefined
5014
+ available_hvac_mode_settings?:
5015
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
5016
+ | undefined
5017
+ is_heating_available?: false | undefined
5018
+ is_cooling_available?: true | undefined
5019
+ is_heating?: boolean | undefined
5020
+ is_cooling?: boolean | undefined
5021
+ is_fan_running?: boolean | undefined
5022
+ fan_mode_setting?: ('auto' | 'on') | undefined
5023
+ is_temporary_manual_override_active?: boolean | undefined
5024
+ current_climate_setting?:
5025
+ | {
5026
+ automatic_heating_enabled: boolean
5027
+ automatic_cooling_enabled: boolean
5028
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
5029
+ cooling_set_point_celsius?: number | undefined
5030
+ heating_set_point_celsius?: number | undefined
5031
+ cooling_set_point_fahrenheit?: number | undefined
5032
+ heating_set_point_fahrenheit?: number | undefined
5033
+ manual_override_allowed: boolean
5034
+ }
5035
+ | undefined
5036
+ default_climate_setting?:
5037
+ | (
5038
+ | {
5039
+ automatic_heating_enabled: boolean
5040
+ automatic_cooling_enabled: boolean
5041
+ hvac_mode_setting:
5042
+ | 'off'
5043
+ | 'heat'
5044
+ | 'cool'
5045
+ | 'heat_cool'
5046
+ cooling_set_point_celsius?: number | undefined
5047
+ heating_set_point_celsius?: number | undefined
5048
+ cooling_set_point_fahrenheit?: number | undefined
5049
+ heating_set_point_fahrenheit?: number | undefined
5050
+ manual_override_allowed: boolean
5051
+ }
5052
+ | undefined
5053
+ )
5054
+ | undefined
5055
+ is_climate_setting_schedule_active?: boolean | undefined
5056
+ active_climate_setting_schedule?:
5057
+ | (
5058
+ | {
5059
+ climate_setting_schedule_id: string
5060
+ schedule_type: 'time_bound'
5061
+ device_id: string
5062
+ name?: string | undefined
5063
+ schedule_starts_at: string
5064
+ schedule_ends_at: string
5065
+ created_at: string
5066
+ automatic_heating_enabled?: boolean | undefined
5067
+ automatic_cooling_enabled?: boolean | undefined
5068
+ hvac_mode_setting?:
5069
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
5070
+ | undefined
5071
+ cooling_set_point_celsius?:
5072
+ | (number | undefined)
5073
+ | undefined
5074
+ heating_set_point_celsius?:
5075
+ | (number | undefined)
5076
+ | undefined
5077
+ cooling_set_point_fahrenheit?:
5078
+ | (number | undefined)
5079
+ | undefined
5080
+ heating_set_point_fahrenheit?:
5081
+ | (number | undefined)
5082
+ | undefined
5083
+ manual_override_allowed?: boolean | undefined
5084
+ }
5085
+ | undefined
5086
+ )
5087
+ | undefined
5088
+ min_cooling_set_point_celsius?: number | undefined
5089
+ min_cooling_set_point_fahrenheit?: number | undefined
5090
+ max_cooling_set_point_celsius?: number | undefined
5091
+ max_cooling_set_point_fahrenheit?: number | undefined
5092
+ }
5093
+ ))
5094
+ location: {
5095
+ location_name?: string | undefined
5096
+ timezone?: string | undefined
5097
+ } | null
5098
+ connected_account_id: string
5099
+ workspace_id: string
5100
+ errors: Array<{
5101
+ error_code: string
5102
+ message: string
5103
+ }>
5104
+ warnings: Array<{
5105
+ warning_code: string
5106
+ message: string
5107
+ }>
5108
+ created_at: string
5109
+ is_managed: true
5110
+ }>
5111
+ devices: Array<{
5112
+ device_id: string
5113
+ device_type:
5114
+ | (
5115
+ | 'akuvox_lock'
5116
+ | 'august_lock'
5117
+ | 'brivo_access_point'
5118
+ | 'butterflymx_panel'
5119
+ | 'avigilon_alta_entry'
5120
+ | 'doorking_lock'
5121
+ | 'genie_door'
5122
+ | 'igloo_lock'
5123
+ | 'linear_lock'
5124
+ | 'lockly_lock'
5125
+ | 'kwikset_lock'
5126
+ | 'nuki_lock'
5127
+ | 'salto_lock'
5128
+ | 'schlage_lock'
5129
+ | 'seam_relay'
5130
+ | 'smartthings_lock'
5131
+ | 'wyze_lock'
5132
+ | 'yale_lock'
5133
+ | 'two_n_intercom'
5134
+ | 'controlbyweb_device'
5135
+ | 'ttlock_lock'
5136
+ | 'igloohome_lock'
5137
+ | 'hubitat_lock'
5138
+ | 'four_suites_door'
5139
+ | 'dormakaba_oracode_door'
5140
+ )
5141
+ | ('noiseaware_activity_zone' | 'minut_sensor')
5142
+ | ('ecobee_thermostat' | 'nest_thermostat')
5143
+ capabilities_supported: Array<
5144
+ 'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'
5145
+ >
5146
+ properties: ({
5147
+ online: boolean
5148
+ name: string
5149
+ model: {
5150
+ display_name: string
5151
+ manufacturer_display_name: string
5152
+ }
5153
+ has_direct_power?: boolean | undefined
5154
+ battery_level?: number | undefined
5155
+ battery?:
5156
+ | {
5157
+ level: number
5158
+ status: 'critical' | 'low' | 'good' | 'full'
5159
+ }
5160
+ | undefined
5161
+ manufacturer?: string | undefined
5162
+ image_url?: string | undefined
5163
+ image_alt_text?: string | undefined
5164
+ serial_number?: string | undefined
5165
+ supports_accessory_keypad?: boolean | undefined
5166
+ supports_offline_access_codes?: boolean | undefined
5167
+ } & {
5168
+ august_metadata?:
5169
+ | {
5170
+ lock_id: string
5171
+ lock_name: string
5172
+ house_name: string
5173
+ has_keypad: boolean
5174
+ keypad_battery_level?: string | undefined
5175
+ model?: string | undefined
5176
+ house_id?: string | undefined
5177
+ }
5178
+ | undefined
5179
+ avigilon_alta_metadata?:
5180
+ | {
5181
+ entry_name: string
5182
+ org_name: string
5183
+ zone_id: number
5184
+ zone_name: string
5185
+ site_id: number
5186
+ site_name: string
5187
+ }
5188
+ | undefined
5189
+ schlage_metadata?:
5190
+ | {
5191
+ device_id: string
5192
+ device_name: string
5193
+ access_code_length: number
5194
+ model?: string | undefined
5195
+ }
5196
+ | undefined
5197
+ smartthings_metadata?:
5198
+ | {
5199
+ device_id: string
5200
+ device_name: string
5201
+ model?: string | undefined
5202
+ location_id?: string | undefined
5203
+ }
5204
+ | undefined
5205
+ lockly_metadata?:
5206
+ | {
5207
+ device_id: string
5208
+ device_name: string
5209
+ model?: string | undefined
5210
+ }
5211
+ | undefined
5212
+ nuki_metadata?:
5213
+ | {
5214
+ device_id: string
5215
+ device_name: string
5216
+ keypad_battery_critical?: boolean | undefined
5217
+ }
5218
+ | undefined
5219
+ kwikset_metadata?:
5220
+ | {
5221
+ device_id: string
5222
+ device_name: string
5223
+ model_number: string
5224
+ }
5225
+ | undefined
5226
+ salto_metadata?:
5227
+ | {
5228
+ lock_id: string
5229
+ customer_reference: string
5230
+ lock_type: string
5231
+ battery_level: string
5232
+ locked_state: string
5233
+ model?: string | undefined
5234
+ }
5235
+ | undefined
5236
+ genie_metadata?:
5237
+ | {
5238
+ device_name: string
5239
+ door_name: string
5240
+ }
5241
+ | undefined
5242
+ brivo_metadata?:
5243
+ | {
5244
+ device_name: string
5245
+ }
5246
+ | undefined
5247
+ igloo_metadata?:
5248
+ | {
5249
+ device_id: string
5250
+ bridge_id: string
5251
+ model?: string | undefined
5252
+ }
5253
+ | undefined
5254
+ noiseaware_metadata?:
5255
+ | {
5256
+ device_model: 'indoor' | 'outdoor'
5257
+ noise_level_nrs: number
5258
+ noise_level_decibel: number
5259
+ device_name: string
5260
+ device_id: string
5261
+ }
5262
+ | undefined
5263
+ minut_metadata?:
5264
+ | {
5265
+ device_id: string
5266
+ device_name: string
5267
+ latest_sensor_values: {
5268
+ temperature: {
5269
+ time: string
5270
+ value: number
5271
+ }
5272
+ sound: {
5273
+ time: string
5274
+ value: number
5275
+ }
5276
+ humidity: {
5277
+ time: string
5278
+ value: number
5279
+ }
5280
+ pressure: {
5281
+ time: string
5282
+ value: number
5283
+ }
5284
+ accelerometer_z: {
5285
+ time: string
5286
+ value: number
5287
+ }
5288
+ }
5289
+ }
5290
+ | undefined
5291
+ four_suites_metadata?:
5292
+ | {
5293
+ device_id: number
5294
+ device_name: string
5295
+ reclose_delay_in_seconds: number
5296
+ }
5297
+ | undefined
5298
+ two_n_metadata?:
5299
+ | {
5300
+ device_id: number
5301
+ device_name: string
5302
+ }
5303
+ | undefined
5304
+ controlbyweb_metadata?:
5305
+ | {
5306
+ device_id: string
5307
+ device_name: string
5308
+ relay_name: string | null
5309
+ }
5310
+ | undefined
5311
+ ttlock_metadata?:
5312
+ | {
5313
+ lock_id: number
5314
+ lock_alias: string
5315
+ }
5316
+ | undefined
5317
+ seam_bridge_metadata?:
5318
+ | {
5319
+ unlock_method?: ('bridge' | 'doorking') | undefined
5320
+ device_num: number
5321
+ name: string
5322
+ }
5323
+ | undefined
5324
+ igloohome_metadata?:
5325
+ | {
5326
+ device_id: string
5327
+ device_name: string
5328
+ bridge_id?: string | undefined
5329
+ bridge_name?: string | undefined
5330
+ }
5331
+ | undefined
5332
+ nest_metadata?:
5333
+ | {
5334
+ nest_device_id: string
5335
+ device_name: string
5336
+ custom_name: string
5337
+ }
5338
+ | undefined
5339
+ ecobee_metadata?:
5340
+ | {
5341
+ ecobee_device_id: string
5342
+ device_name: string
5343
+ }
5344
+ | undefined
5345
+ hubitat_metadata?:
5346
+ | {
5347
+ device_id: string
5348
+ device_name: string
5349
+ device_label: string
5350
+ }
5351
+ | undefined
5352
+ dormakaba_oracode_metadata?:
5353
+ | {
5354
+ door_id: number
5355
+ door_name: string
5356
+ device_id?: number | undefined
5357
+ site_id: number
5358
+ site_name: string
5359
+ }
5360
+ | undefined
5361
+ wyze_metadata?:
5362
+ | {
5363
+ device_id: string
5364
+ device_name: string
5365
+ product_name: string
5366
+ product_type: string
5367
+ product_model: string
5368
+ device_info_model: string
5369
+ }
5370
+ | undefined
5371
+ }) &
5372
+ ({
5373
+ code_constraints?:
5374
+ | (
5375
+ | Array<
5376
+ | {
5377
+ constraint_type:
5378
+ | 'no_zeros'
5379
+ | 'cannot_start_with_12'
5380
+ | 'no_triple_consecutive_ints'
5381
+ | 'cannot_specify_pin_code'
5382
+ | 'pin_code_matches_existing_set'
5383
+ | 'start_date_in_future'
5384
+ }
5385
+ | {
5386
+ constraint_type: 'name_length'
5387
+ min_length?: number | undefined
5388
+ max_length?: number | undefined
5389
+ }
5390
+ >
5391
+ | undefined
5392
+ )
5393
+ | undefined
5394
+ supported_code_lengths?: (number[] | undefined) | undefined
5395
+ max_active_codes_supported?: (number | undefined) | undefined
5396
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
5397
+ has_native_entry_events?: (boolean | undefined) | undefined
5398
+ locked?: (boolean | undefined) | undefined
5399
+ keypad_battery?:
5400
+ | (
5401
+ | {
5402
+ level: number
5403
+ }
5404
+ | undefined
5405
+ )
5406
+ | undefined
5407
+ door_open?: (boolean | undefined) | undefined
5408
+ } & (
5409
+ | {
5410
+ temperature_fahrenheit?: number | undefined
5411
+ temperature_celsius?: number | undefined
5412
+ relative_humidity?: number | undefined
5413
+ can_enable_automatic_heating?: boolean | undefined
5414
+ can_enable_automatic_cooling?: boolean | undefined
5415
+ available_hvac_mode_settings?:
5416
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
5417
+ | undefined
5418
+ is_heating_available?: true | undefined
5419
+ is_cooling_available?: true | undefined
5420
+ is_heating?: boolean | undefined
5421
+ is_cooling?: boolean | undefined
5422
+ is_fan_running?: boolean | undefined
5423
+ fan_mode_setting?: ('auto' | 'on') | undefined
5424
+ is_temporary_manual_override_active?: boolean | undefined
5425
+ current_climate_setting?:
5426
+ | {
5427
+ automatic_heating_enabled: boolean
5428
+ automatic_cooling_enabled: boolean
5429
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
5430
+ cooling_set_point_celsius?: number | undefined
5431
+ heating_set_point_celsius?: number | undefined
5432
+ cooling_set_point_fahrenheit?: number | undefined
5433
+ heating_set_point_fahrenheit?: number | undefined
5434
+ manual_override_allowed: boolean
5435
+ }
5436
+ | undefined
5437
+ default_climate_setting?:
5438
+ | (
5439
+ | {
5440
+ automatic_heating_enabled: boolean
5441
+ automatic_cooling_enabled: boolean
5442
+ hvac_mode_setting:
5443
+ | 'off'
5444
+ | 'heat'
5445
+ | 'cool'
5446
+ | 'heat_cool'
5447
+ cooling_set_point_celsius?: number | undefined
5448
+ heating_set_point_celsius?: number | undefined
5449
+ cooling_set_point_fahrenheit?: number | undefined
5450
+ heating_set_point_fahrenheit?: number | undefined
5451
+ manual_override_allowed: boolean
5452
+ }
5453
+ | undefined
5454
+ )
5455
+ | undefined
5456
+ is_climate_setting_schedule_active?: boolean | undefined
5457
+ active_climate_setting_schedule?:
5458
+ | (
5459
+ | {
5460
+ climate_setting_schedule_id: string
5461
+ schedule_type: 'time_bound'
5462
+ device_id: string
5463
+ name?: string | undefined
5464
+ schedule_starts_at: string
5465
+ schedule_ends_at: string
5466
+ created_at: string
5467
+ automatic_heating_enabled?: boolean | undefined
5468
+ automatic_cooling_enabled?: boolean | undefined
5469
+ hvac_mode_setting?:
5470
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
5471
+ | undefined
5472
+ cooling_set_point_celsius?:
5473
+ | (number | undefined)
5474
+ | undefined
5475
+ heating_set_point_celsius?:
5476
+ | (number | undefined)
5477
+ | undefined
5478
+ cooling_set_point_fahrenheit?:
5479
+ | (number | undefined)
5480
+ | undefined
5481
+ heating_set_point_fahrenheit?:
5482
+ | (number | undefined)
5483
+ | undefined
5484
+ manual_override_allowed?: boolean | undefined
5485
+ }
5486
+ | undefined
5487
+ )
5488
+ | undefined
5489
+ min_cooling_set_point_celsius?: number | undefined
5490
+ min_cooling_set_point_fahrenheit?: number | undefined
5491
+ max_cooling_set_point_celsius?: number | undefined
5492
+ max_cooling_set_point_fahrenheit?: number | undefined
5493
+ min_heating_set_point_celsius?: number | undefined
5494
+ min_heating_set_point_fahrenheit?: number | undefined
5495
+ max_heating_set_point_celsius?: number | undefined
5496
+ max_heating_set_point_fahrenheit?: number | undefined
5497
+ min_heating_cooling_delta_celsius?: number | undefined
5498
+ min_heating_cooling_delta_fahrenheit?: number | undefined
5499
+ }
5500
+ | {
5501
+ temperature_fahrenheit?: number | undefined
5502
+ temperature_celsius?: number | undefined
5503
+ relative_humidity?: number | undefined
5504
+ can_enable_automatic_heating?: boolean | undefined
5505
+ can_enable_automatic_cooling?: boolean | undefined
5506
+ available_hvac_mode_settings?:
5507
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
5508
+ | undefined
5509
+ is_heating_available?: true | undefined
5510
+ is_cooling_available?: false | undefined
5511
+ is_heating?: boolean | undefined
5512
+ is_cooling?: boolean | undefined
5513
+ is_fan_running?: boolean | undefined
5514
+ fan_mode_setting?: ('auto' | 'on') | undefined
5515
+ is_temporary_manual_override_active?: boolean | undefined
5516
+ current_climate_setting?:
5517
+ | {
5518
+ automatic_heating_enabled: boolean
5519
+ automatic_cooling_enabled: boolean
5520
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
5521
+ cooling_set_point_celsius?: number | undefined
5522
+ heating_set_point_celsius?: number | undefined
5523
+ cooling_set_point_fahrenheit?: number | undefined
5524
+ heating_set_point_fahrenheit?: number | undefined
5525
+ manual_override_allowed: boolean
5526
+ }
5527
+ | undefined
5528
+ default_climate_setting?:
5529
+ | (
5530
+ | {
5531
+ automatic_heating_enabled: boolean
5532
+ automatic_cooling_enabled: boolean
5533
+ hvac_mode_setting:
5534
+ | 'off'
5535
+ | 'heat'
5536
+ | 'cool'
5537
+ | 'heat_cool'
5538
+ cooling_set_point_celsius?: number | undefined
5539
+ heating_set_point_celsius?: number | undefined
5540
+ cooling_set_point_fahrenheit?: number | undefined
5541
+ heating_set_point_fahrenheit?: number | undefined
5542
+ manual_override_allowed: boolean
5543
+ }
5544
+ | undefined
5545
+ )
5546
+ | undefined
5547
+ is_climate_setting_schedule_active?: boolean | undefined
5548
+ active_climate_setting_schedule?:
5549
+ | (
5550
+ | {
5551
+ climate_setting_schedule_id: string
5552
+ schedule_type: 'time_bound'
5553
+ device_id: string
5554
+ name?: string | undefined
5555
+ schedule_starts_at: string
5556
+ schedule_ends_at: string
5557
+ created_at: string
5558
+ automatic_heating_enabled?: boolean | undefined
5559
+ automatic_cooling_enabled?: boolean | undefined
5560
+ hvac_mode_setting?:
5561
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
5562
+ | undefined
5563
+ cooling_set_point_celsius?:
5564
+ | (number | undefined)
5565
+ | undefined
5566
+ heating_set_point_celsius?:
5567
+ | (number | undefined)
5568
+ | undefined
5569
+ cooling_set_point_fahrenheit?:
5570
+ | (number | undefined)
5571
+ | undefined
5572
+ heating_set_point_fahrenheit?:
5573
+ | (number | undefined)
5574
+ | undefined
5575
+ manual_override_allowed?: boolean | undefined
5576
+ }
5577
+ | undefined
5578
+ )
5579
+ | undefined
5580
+ min_heating_set_point_celsius?: number | undefined
5581
+ min_heating_set_point_fahrenheit?: number | undefined
5582
+ max_heating_set_point_celsius?: number | undefined
5583
+ max_heating_set_point_fahrenheit?: number | undefined
5584
+ }
5585
+ | {
5586
+ temperature_fahrenheit?: number | undefined
5587
+ temperature_celsius?: number | undefined
5588
+ relative_humidity?: number | undefined
5589
+ can_enable_automatic_heating?: boolean | undefined
5590
+ can_enable_automatic_cooling?: boolean | undefined
5591
+ available_hvac_mode_settings?:
5592
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
5593
+ | undefined
5594
+ is_heating_available?: false | undefined
5595
+ is_cooling_available?: true | undefined
5596
+ is_heating?: boolean | undefined
5597
+ is_cooling?: boolean | undefined
5598
+ is_fan_running?: boolean | undefined
5599
+ fan_mode_setting?: ('auto' | 'on') | undefined
5600
+ is_temporary_manual_override_active?: boolean | undefined
5601
+ current_climate_setting?:
5602
+ | {
5603
+ automatic_heating_enabled: boolean
5604
+ automatic_cooling_enabled: boolean
5605
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
5606
+ cooling_set_point_celsius?: number | undefined
5607
+ heating_set_point_celsius?: number | undefined
5608
+ cooling_set_point_fahrenheit?: number | undefined
5609
+ heating_set_point_fahrenheit?: number | undefined
5610
+ manual_override_allowed: boolean
5611
+ }
5612
+ | undefined
5613
+ default_climate_setting?:
5614
+ | (
5615
+ | {
5616
+ automatic_heating_enabled: boolean
5617
+ automatic_cooling_enabled: boolean
5618
+ hvac_mode_setting:
5619
+ | 'off'
5620
+ | 'heat'
5621
+ | 'cool'
5622
+ | 'heat_cool'
5623
+ cooling_set_point_celsius?: number | undefined
5624
+ heating_set_point_celsius?: number | undefined
5625
+ cooling_set_point_fahrenheit?: number | undefined
5626
+ heating_set_point_fahrenheit?: number | undefined
5627
+ manual_override_allowed: boolean
5628
+ }
5629
+ | undefined
5630
+ )
5631
+ | undefined
5632
+ is_climate_setting_schedule_active?: boolean | undefined
5633
+ active_climate_setting_schedule?:
5634
+ | (
5635
+ | {
5636
+ climate_setting_schedule_id: string
5637
+ schedule_type: 'time_bound'
5638
+ device_id: string
5639
+ name?: string | undefined
5640
+ schedule_starts_at: string
5641
+ schedule_ends_at: string
5642
+ created_at: string
5643
+ automatic_heating_enabled?: boolean | undefined
5644
+ automatic_cooling_enabled?: boolean | undefined
5645
+ hvac_mode_setting?:
5646
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
5647
+ | undefined
5648
+ cooling_set_point_celsius?:
5649
+ | (number | undefined)
5650
+ | undefined
5651
+ heating_set_point_celsius?:
5652
+ | (number | undefined)
5653
+ | undefined
5654
+ cooling_set_point_fahrenheit?:
5655
+ | (number | undefined)
5656
+ | undefined
5657
+ heating_set_point_fahrenheit?:
5658
+ | (number | undefined)
5659
+ | undefined
5660
+ manual_override_allowed?: boolean | undefined
5661
+ }
5662
+ | undefined
5663
+ )
5664
+ | undefined
5665
+ min_cooling_set_point_celsius?: number | undefined
5666
+ min_cooling_set_point_fahrenheit?: number | undefined
5667
+ max_cooling_set_point_celsius?: number | undefined
5668
+ max_cooling_set_point_fahrenheit?: number | undefined
5669
+ }
5670
+ ))
5671
+ location: {
5672
+ location_name?: string | undefined
5673
+ timezone?: string | undefined
5674
+ } | null
5675
+ connected_account_id: string
5676
+ workspace_id: string
5677
+ errors: Array<{
5678
+ error_code: string
5679
+ message: string
5680
+ }>
5681
+ warnings: Array<{
5682
+ warning_code: string
5683
+ message: string
5684
+ }>
5685
+ created_at: string
5686
+ is_managed: true
5687
+ }>
3362
5688
  }
3363
5689
  }
3364
5690
  '/locks/lock_door': {
@@ -3835,6 +6161,9 @@ export interface Routes {
3835
6161
  model: {
3836
6162
  display_name: string
3837
6163
  manufacturer_display_name: string
6164
+ offline_access_codes_supported?: boolean | undefined
6165
+ access_codes_supported?: boolean | undefined
6166
+ accessory_keypad_supported?: boolean | undefined
3838
6167
  }
3839
6168
  has_direct_power?: boolean | undefined
3840
6169
  battery_level?: number | undefined
@@ -3848,7 +6177,13 @@ export interface Routes {
3848
6177
  image_url?: string | undefined
3849
6178
  image_alt_text?: string | undefined
3850
6179
  serial_number?: string | undefined
6180
+ /** Currently possible to use online access codes */
6181
+ online_access_codes_enabled?: boolean | undefined
6182
+ /** Currently possible to use offline access codes */
6183
+ offline_access_codes_enabled?: boolean | undefined
6184
+ /** Deprecated: use model.offline_access_codes_enabled. */
3851
6185
  supports_accessory_keypad?: boolean | undefined
6186
+ /** Deprecated: use model.accessory_keypad_supported. */
3852
6187
  supports_offline_access_codes?: boolean | undefined
3853
6188
  } & {
3854
6189
  august_metadata?:
@@ -4563,6 +6898,9 @@ export interface Routes {
4563
6898
  model: {
4564
6899
  display_name: string
4565
6900
  manufacturer_display_name: string
6901
+ offline_access_codes_supported?: boolean | undefined
6902
+ access_codes_supported?: boolean | undefined
6903
+ accessory_keypad_supported?: boolean | undefined
4566
6904
  }
4567
6905
  has_direct_power?: boolean | undefined
4568
6906
  battery_level?: number | undefined
@@ -4576,7 +6914,13 @@ export interface Routes {
4576
6914
  image_url?: string | undefined
4577
6915
  image_alt_text?: string | undefined
4578
6916
  serial_number?: string | undefined
6917
+ /** Currently possible to use online access codes */
6918
+ online_access_codes_enabled?: boolean | undefined
6919
+ /** Currently possible to use offline access codes */
6920
+ offline_access_codes_enabled?: boolean | undefined
6921
+ /** Deprecated: use model.offline_access_codes_enabled. */
4579
6922
  supports_accessory_keypad?: boolean | undefined
6923
+ /** Deprecated: use model.accessory_keypad_supported. */
4580
6924
  supports_offline_access_codes?: boolean | undefined
4581
6925
  } & {
4582
6926
  august_metadata?:
@@ -5266,6 +7610,9 @@ export interface Routes {
5266
7610
  model: {
5267
7611
  display_name: string
5268
7612
  manufacturer_display_name: string
7613
+ offline_access_codes_supported?: boolean | undefined
7614
+ access_codes_supported?: boolean | undefined
7615
+ accessory_keypad_supported?: boolean | undefined
5269
7616
  }
5270
7617
  has_direct_power?: boolean | undefined
5271
7618
  battery_level?: number | undefined
@@ -5279,7 +7626,13 @@ export interface Routes {
5279
7626
  image_url?: string | undefined
5280
7627
  image_alt_text?: string | undefined
5281
7628
  serial_number?: string | undefined
7629
+ /** Currently possible to use online access codes */
7630
+ online_access_codes_enabled?: boolean | undefined
7631
+ /** Currently possible to use offline access codes */
7632
+ offline_access_codes_enabled?: boolean | undefined
7633
+ /** Deprecated: use model.offline_access_codes_enabled. */
5282
7634
  supports_accessory_keypad?: boolean | undefined
7635
+ /** Deprecated: use model.accessory_keypad_supported. */
5283
7636
  supports_offline_access_codes?: boolean | undefined
5284
7637
  } & {
5285
7638
  august_metadata?: