@seamapi/types 1.11.1 → 1.13.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.
@@ -2936,6 +2936,9 @@ declare const _default: {
2936
2936
  format: string;
2937
2937
  type: string;
2938
2938
  };
2939
+ allow_external_modification: {
2940
+ type: string;
2941
+ };
2939
2942
  force: {
2940
2943
  type: string;
2941
2944
  };
@@ -3005,6 +3008,9 @@ declare const _default: {
3005
3008
  format: string;
3006
3009
  type: string;
3007
3010
  };
3011
+ allow_external_modification: {
3012
+ type: string;
3013
+ };
3008
3014
  force: {
3009
3015
  type: string;
3010
3016
  };
@@ -3399,6 +3405,9 @@ declare const _default: {
3399
3405
  format: string;
3400
3406
  type: string;
3401
3407
  };
3408
+ allow_external_modification: {
3409
+ type: string;
3410
+ };
3402
3411
  force: {
3403
3412
  type: string;
3404
3413
  };
@@ -3467,6 +3476,9 @@ declare const _default: {
3467
3476
  format: string;
3468
3477
  type: string;
3469
3478
  };
3479
+ allow_external_modification: {
3480
+ type: string;
3481
+ };
3470
3482
  force: {
3471
3483
  type: string;
3472
3484
  };
@@ -10314,6 +10326,3604 @@ declare const _default: {
10314
10326
  }[];
10315
10327
  };
10316
10328
 
10329
+ interface Routes {
10330
+ '/access_codes/create': {
10331
+ route: '/access_codes/create';
10332
+ method: 'POST';
10333
+ queryParams: {};
10334
+ jsonBody: {
10335
+ device_id: string;
10336
+ name?: string | undefined;
10337
+ starts_at?: string | undefined;
10338
+ ends_at?: string | undefined;
10339
+ code?: string | undefined;
10340
+ sync?: boolean;
10341
+ attempt_for_offline_device?: boolean;
10342
+ common_code_key?: string | undefined;
10343
+ prefer_native_scheduling?: boolean | undefined;
10344
+ use_backup_access_code_pool?: boolean | undefined;
10345
+ allow_external_modification?: boolean | undefined;
10346
+ };
10347
+ commonParams: {};
10348
+ formData: {};
10349
+ jsonResponse: {
10350
+ action_attempt: {
10351
+ status: 'success';
10352
+ action_type: string;
10353
+ action_attempt_id: string;
10354
+ result?: any;
10355
+ error: null;
10356
+ } | {
10357
+ status: 'pending';
10358
+ action_type: string;
10359
+ action_attempt_id: string;
10360
+ result: null;
10361
+ error: null;
10362
+ } | {
10363
+ status: 'error';
10364
+ action_type: string;
10365
+ action_attempt_id: string;
10366
+ result: null;
10367
+ error: {
10368
+ type: string;
10369
+ message: string;
10370
+ };
10371
+ };
10372
+ access_code: {
10373
+ common_code_key: string | null;
10374
+ is_scheduled_on_device?: boolean | undefined;
10375
+ type: 'time_bound' | 'ongoing';
10376
+ is_waiting_for_code_assignment?: boolean | undefined;
10377
+ access_code_id: string;
10378
+ device_id: string;
10379
+ name: string | null;
10380
+ code: string | null;
10381
+ created_at: string;
10382
+ errors?: any;
10383
+ warnings?: any;
10384
+ is_managed: true;
10385
+ starts_at?: string | undefined;
10386
+ ends_at?: string | undefined;
10387
+ status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
10388
+ is_backup_access_code_available: boolean;
10389
+ is_backup?: boolean | undefined;
10390
+ pulled_backup_access_code_id?: (string | null) | undefined;
10391
+ };
10392
+ };
10393
+ };
10394
+ '/access_codes/create_multiple': {
10395
+ route: '/access_codes/create_multiple';
10396
+ method: 'POST' | 'PUT';
10397
+ queryParams: {};
10398
+ jsonBody: {
10399
+ device_ids: string[];
10400
+ behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
10401
+ name?: string | undefined;
10402
+ starts_at?: string | undefined;
10403
+ ends_at?: string | undefined;
10404
+ code?: string | undefined;
10405
+ attempt_for_offline_device?: boolean;
10406
+ prefer_native_scheduling?: boolean | undefined;
10407
+ use_backup_access_code_pool?: boolean | undefined;
10408
+ allow_external_modification?: boolean | undefined;
10409
+ };
10410
+ commonParams: {};
10411
+ formData: {};
10412
+ jsonResponse: {
10413
+ access_codes: Array<{
10414
+ common_code_key: string | null;
10415
+ is_scheduled_on_device?: boolean | undefined;
10416
+ type: 'time_bound' | 'ongoing';
10417
+ is_waiting_for_code_assignment?: boolean | undefined;
10418
+ access_code_id: string;
10419
+ device_id: string;
10420
+ name: string | null;
10421
+ code: string | null;
10422
+ created_at: string;
10423
+ errors?: any;
10424
+ warnings?: any;
10425
+ is_managed: true;
10426
+ starts_at?: string | undefined;
10427
+ ends_at?: string | undefined;
10428
+ status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
10429
+ is_backup_access_code_available: boolean;
10430
+ is_backup?: boolean | undefined;
10431
+ pulled_backup_access_code_id?: (string | null) | undefined;
10432
+ }>;
10433
+ };
10434
+ };
10435
+ '/access_codes/delete': {
10436
+ route: '/access_codes/delete';
10437
+ method: 'DELETE' | 'POST';
10438
+ queryParams: {};
10439
+ jsonBody: {};
10440
+ commonParams: {
10441
+ device_id?: string | undefined;
10442
+ access_code_id: string;
10443
+ sync?: boolean;
10444
+ };
10445
+ formData: {};
10446
+ jsonResponse: {
10447
+ action_attempt: {
10448
+ status: 'success';
10449
+ action_type: string;
10450
+ action_attempt_id: string;
10451
+ result?: any;
10452
+ error: null;
10453
+ } | {
10454
+ status: 'pending';
10455
+ action_type: string;
10456
+ action_attempt_id: string;
10457
+ result: null;
10458
+ error: null;
10459
+ } | {
10460
+ status: 'error';
10461
+ action_type: string;
10462
+ action_attempt_id: string;
10463
+ result: null;
10464
+ error: {
10465
+ type: string;
10466
+ message: string;
10467
+ };
10468
+ };
10469
+ };
10470
+ };
10471
+ '/access_codes/generate_code': {
10472
+ route: '/access_codes/generate_code';
10473
+ method: 'GET';
10474
+ queryParams: {};
10475
+ jsonBody: {};
10476
+ commonParams: {
10477
+ device_id: string;
10478
+ };
10479
+ formData: {};
10480
+ jsonResponse: {
10481
+ generated_code: {
10482
+ device_id: string;
10483
+ code: string;
10484
+ };
10485
+ };
10486
+ };
10487
+ '/access_codes/get': {
10488
+ route: '/access_codes/get';
10489
+ method: 'GET' | 'POST';
10490
+ queryParams: {};
10491
+ jsonBody: {};
10492
+ commonParams: {
10493
+ device_id?: string | undefined;
10494
+ access_code_id?: string | undefined;
10495
+ code?: string | undefined;
10496
+ };
10497
+ formData: {};
10498
+ jsonResponse: {
10499
+ access_code: {
10500
+ common_code_key: string | null;
10501
+ is_scheduled_on_device?: boolean | undefined;
10502
+ type: 'time_bound' | 'ongoing';
10503
+ is_waiting_for_code_assignment?: boolean | undefined;
10504
+ access_code_id: string;
10505
+ device_id: string;
10506
+ name: string | null;
10507
+ code: string | null;
10508
+ created_at: string;
10509
+ errors?: any;
10510
+ warnings?: any;
10511
+ is_managed: true;
10512
+ starts_at?: string | undefined;
10513
+ ends_at?: string | undefined;
10514
+ status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
10515
+ is_backup_access_code_available: boolean;
10516
+ is_backup?: boolean | undefined;
10517
+ pulled_backup_access_code_id?: (string | null) | undefined;
10518
+ };
10519
+ };
10520
+ };
10521
+ '/access_codes/list': {
10522
+ route: '/access_codes/list';
10523
+ method: 'GET' | 'POST';
10524
+ queryParams: {};
10525
+ jsonBody: {};
10526
+ commonParams: {
10527
+ device_id?: string | undefined;
10528
+ access_code_ids?: string[] | undefined;
10529
+ };
10530
+ formData: {};
10531
+ jsonResponse: {
10532
+ access_codes: Array<{
10533
+ common_code_key: string | null;
10534
+ is_scheduled_on_device?: boolean | undefined;
10535
+ type: 'time_bound' | 'ongoing';
10536
+ is_waiting_for_code_assignment?: boolean | undefined;
10537
+ access_code_id: string;
10538
+ device_id: string;
10539
+ name: string | null;
10540
+ code: string | null;
10541
+ created_at: string;
10542
+ errors?: any;
10543
+ warnings?: any;
10544
+ is_managed: true;
10545
+ starts_at?: string | undefined;
10546
+ ends_at?: string | undefined;
10547
+ status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
10548
+ is_backup_access_code_available: boolean;
10549
+ is_backup?: boolean | undefined;
10550
+ pulled_backup_access_code_id?: (string | null) | undefined;
10551
+ }>;
10552
+ };
10553
+ };
10554
+ '/access_codes/pull_backup_access_code': {
10555
+ route: '/access_codes/pull_backup_access_code';
10556
+ method: 'POST';
10557
+ queryParams: {};
10558
+ jsonBody: {
10559
+ access_code_id: string;
10560
+ };
10561
+ commonParams: {};
10562
+ formData: {};
10563
+ jsonResponse: {
10564
+ backup_access_code: {
10565
+ common_code_key: string | null;
10566
+ is_scheduled_on_device?: boolean | undefined;
10567
+ type: 'time_bound' | 'ongoing';
10568
+ is_waiting_for_code_assignment?: boolean | undefined;
10569
+ access_code_id: string;
10570
+ device_id: string;
10571
+ name: string | null;
10572
+ code: string | null;
10573
+ created_at: string;
10574
+ errors?: any;
10575
+ warnings?: any;
10576
+ is_managed: true;
10577
+ starts_at?: string | undefined;
10578
+ ends_at?: string | undefined;
10579
+ status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
10580
+ is_backup_access_code_available: boolean;
10581
+ is_backup?: boolean | undefined;
10582
+ pulled_backup_access_code_id?: (string | null) | undefined;
10583
+ };
10584
+ };
10585
+ };
10586
+ '/access_codes/simulate/create_unmanaged_access_code': {
10587
+ route: '/access_codes/simulate/create_unmanaged_access_code';
10588
+ method: 'POST';
10589
+ queryParams: {};
10590
+ jsonBody: {
10591
+ device_id: string;
10592
+ name: string;
10593
+ code: string;
10594
+ };
10595
+ commonParams: {};
10596
+ formData: {};
10597
+ jsonResponse: {
10598
+ access_code: {
10599
+ access_code_id: string;
10600
+ code: string | null;
10601
+ status: 'set';
10602
+ created_at: string | Date;
10603
+ is_managed: false;
10604
+ type: 'ongoing';
10605
+ starts_at: null;
10606
+ ends_at: null;
10607
+ } | {
10608
+ access_code_id: string;
10609
+ code: string | null;
10610
+ status: 'set';
10611
+ created_at: string | Date;
10612
+ is_managed: false;
10613
+ type: 'time_bound';
10614
+ starts_at: string | null;
10615
+ ends_at: string | null;
10616
+ };
10617
+ };
10618
+ };
10619
+ '/access_codes/unmanaged/convert_to_managed': {
10620
+ route: '/access_codes/unmanaged/convert_to_managed';
10621
+ method: 'POST' | 'PATCH';
10622
+ queryParams: {};
10623
+ jsonBody: {};
10624
+ commonParams: {
10625
+ access_code_id: string;
10626
+ allow_external_modification?: boolean | undefined;
10627
+ force?: boolean | undefined;
10628
+ sync?: boolean;
10629
+ };
10630
+ formData: {};
10631
+ jsonResponse: {};
10632
+ };
10633
+ '/access_codes/unmanaged/delete': {
10634
+ route: '/access_codes/unmanaged/delete';
10635
+ method: 'DELETE' | 'POST';
10636
+ queryParams: {};
10637
+ jsonBody: {};
10638
+ commonParams: {
10639
+ access_code_id: string;
10640
+ sync?: boolean;
10641
+ };
10642
+ formData: {};
10643
+ jsonResponse: {
10644
+ action_attempt: {
10645
+ status: 'success';
10646
+ action_type: string;
10647
+ action_attempt_id: string;
10648
+ result?: any;
10649
+ error: null;
10650
+ } | {
10651
+ status: 'pending';
10652
+ action_type: string;
10653
+ action_attempt_id: string;
10654
+ result: null;
10655
+ error: null;
10656
+ } | {
10657
+ status: 'error';
10658
+ action_type: string;
10659
+ action_attempt_id: string;
10660
+ result: null;
10661
+ error: {
10662
+ type: string;
10663
+ message: string;
10664
+ };
10665
+ };
10666
+ };
10667
+ };
10668
+ '/access_codes/unmanaged/get': {
10669
+ route: '/access_codes/unmanaged/get';
10670
+ method: 'GET' | 'POST';
10671
+ queryParams: {};
10672
+ jsonBody: {};
10673
+ commonParams: {
10674
+ device_id?: string | undefined;
10675
+ access_code_id?: string | undefined;
10676
+ code?: string | undefined;
10677
+ };
10678
+ formData: {};
10679
+ jsonResponse: {
10680
+ access_code: {
10681
+ type: 'time_bound' | 'ongoing';
10682
+ access_code_id: string;
10683
+ device_id: string;
10684
+ name: string | null;
10685
+ code: string | null;
10686
+ created_at: string;
10687
+ errors?: any;
10688
+ warnings?: any;
10689
+ is_managed: false;
10690
+ starts_at: string | null;
10691
+ ends_at: string | null;
10692
+ status: 'set';
10693
+ };
10694
+ };
10695
+ };
10696
+ '/access_codes/unmanaged/list': {
10697
+ route: '/access_codes/unmanaged/list';
10698
+ method: 'GET' | 'POST';
10699
+ queryParams: {};
10700
+ jsonBody: {};
10701
+ commonParams: {
10702
+ device_id: string;
10703
+ };
10704
+ formData: {};
10705
+ jsonResponse: {
10706
+ access_codes: Array<{
10707
+ type: 'time_bound' | 'ongoing';
10708
+ access_code_id: string;
10709
+ device_id: string;
10710
+ name: string | null;
10711
+ code: string | null;
10712
+ created_at: string;
10713
+ errors?: any;
10714
+ warnings?: any;
10715
+ is_managed: false;
10716
+ starts_at: string | null;
10717
+ ends_at: string | null;
10718
+ status: 'set';
10719
+ }>;
10720
+ };
10721
+ };
10722
+ '/access_codes/unmanaged/update': {
10723
+ route: '/access_codes/unmanaged/update';
10724
+ method: 'POST' | 'PATCH';
10725
+ queryParams: {};
10726
+ jsonBody: {};
10727
+ commonParams: {
10728
+ access_code_id: string;
10729
+ is_managed: boolean;
10730
+ allow_external_modification?: boolean | undefined;
10731
+ force?: boolean | undefined;
10732
+ };
10733
+ formData: {};
10734
+ jsonResponse: {};
10735
+ };
10736
+ '/access_codes/update': {
10737
+ route: '/access_codes/update';
10738
+ method: 'POST' | 'PUT';
10739
+ queryParams: {};
10740
+ jsonBody: {
10741
+ name?: string | undefined;
10742
+ starts_at?: string | undefined;
10743
+ ends_at?: string | undefined;
10744
+ code?: string | undefined;
10745
+ sync?: boolean;
10746
+ attempt_for_offline_device?: boolean;
10747
+ prefer_native_scheduling?: boolean | undefined;
10748
+ use_backup_access_code_pool?: boolean | undefined;
10749
+ allow_external_modification?: boolean | undefined;
10750
+ access_code_id: string;
10751
+ device_id?: string | undefined;
10752
+ type?: ('ongoing' | 'time_bound') | undefined;
10753
+ };
10754
+ commonParams: {};
10755
+ formData: {};
10756
+ jsonResponse: {
10757
+ action_attempt: {
10758
+ status: 'success';
10759
+ action_type: string;
10760
+ action_attempt_id: string;
10761
+ result?: any;
10762
+ error: null;
10763
+ } | {
10764
+ status: 'pending';
10765
+ action_type: string;
10766
+ action_attempt_id: string;
10767
+ result: null;
10768
+ error: null;
10769
+ } | {
10770
+ status: 'error';
10771
+ action_type: string;
10772
+ action_attempt_id: string;
10773
+ result: null;
10774
+ error: {
10775
+ type: string;
10776
+ message: string;
10777
+ };
10778
+ };
10779
+ };
10780
+ };
10781
+ '/acs/access_groups/add_user': {
10782
+ route: '/acs/access_groups/add_user';
10783
+ method: 'PATCH' | 'POST';
10784
+ queryParams: {};
10785
+ jsonBody: {};
10786
+ commonParams: {
10787
+ acs_access_group_id: string;
10788
+ acs_user_id: string;
10789
+ };
10790
+ formData: {};
10791
+ jsonResponse: {};
10792
+ };
10793
+ '/acs/access_groups/create': {
10794
+ route: '/acs/access_groups/create';
10795
+ method: 'POST';
10796
+ queryParams: {};
10797
+ jsonBody: {};
10798
+ commonParams: {
10799
+ acs_system_id: string;
10800
+ name?: string | undefined;
10801
+ };
10802
+ formData: {};
10803
+ jsonResponse: {
10804
+ acs_access_group: {
10805
+ acs_access_group_id: string;
10806
+ acs_system_id: string;
10807
+ workspace_id: string;
10808
+ name: string;
10809
+ access_group_type: 'pti_unit';
10810
+ access_group_type_display_name: string;
10811
+ created_at: string;
10812
+ };
10813
+ };
10814
+ };
10815
+ '/acs/access_groups/delete': {
10816
+ route: '/acs/access_groups/delete';
10817
+ method: 'DELETE' | 'POST';
10818
+ queryParams: {};
10819
+ jsonBody: {};
10820
+ commonParams: {
10821
+ acs_access_group_id: string;
10822
+ };
10823
+ formData: {};
10824
+ jsonResponse: {};
10825
+ };
10826
+ '/acs/access_groups/get': {
10827
+ route: '/acs/access_groups/get';
10828
+ method: 'GET' | 'POST';
10829
+ queryParams: {};
10830
+ jsonBody: {};
10831
+ commonParams: {
10832
+ acs_access_group_id: string;
10833
+ };
10834
+ formData: {};
10835
+ jsonResponse: {
10836
+ acs_access_group: {
10837
+ acs_access_group_id: string;
10838
+ acs_system_id: string;
10839
+ workspace_id: string;
10840
+ name: string;
10841
+ access_group_type: 'pti_unit';
10842
+ access_group_type_display_name: string;
10843
+ created_at: string;
10844
+ };
10845
+ };
10846
+ };
10847
+ '/acs/access_groups/list': {
10848
+ route: '/acs/access_groups/list';
10849
+ method: 'GET' | 'POST';
10850
+ queryParams: {};
10851
+ jsonBody: {};
10852
+ commonParams: {
10853
+ acs_system_id?: string | undefined;
10854
+ acs_user_id?: string | undefined;
10855
+ };
10856
+ formData: {};
10857
+ jsonResponse: {
10858
+ acs_access_groups: Array<{
10859
+ acs_access_group_id: string;
10860
+ acs_system_id: string;
10861
+ workspace_id: string;
10862
+ name: string;
10863
+ access_group_type: 'pti_unit';
10864
+ access_group_type_display_name: string;
10865
+ created_at: string;
10866
+ }>;
10867
+ };
10868
+ };
10869
+ '/acs/access_groups/list_users': {
10870
+ route: '/acs/access_groups/list_users';
10871
+ method: 'GET' | 'POST';
10872
+ queryParams: {};
10873
+ jsonBody: {};
10874
+ commonParams: {
10875
+ acs_access_group_id: string;
10876
+ };
10877
+ formData: {};
10878
+ jsonResponse: {
10879
+ acs_users: Array<{
10880
+ acs_user_id: string;
10881
+ acs_system_id: string;
10882
+ workspace_id: string;
10883
+ created_at: string;
10884
+ display_name: string;
10885
+ full_name?: string | undefined;
10886
+ email?: string | undefined;
10887
+ phone_number?: string | undefined;
10888
+ }>;
10889
+ };
10890
+ };
10891
+ '/acs/access_groups/remove_user': {
10892
+ route: '/acs/access_groups/remove_user';
10893
+ method: 'DELETE' | 'POST';
10894
+ queryParams: {};
10895
+ jsonBody: {};
10896
+ commonParams: {
10897
+ acs_access_group_id: string;
10898
+ acs_user_id: string;
10899
+ };
10900
+ formData: {};
10901
+ jsonResponse: {};
10902
+ };
10903
+ '/acs/access_groups/update': {
10904
+ route: '/acs/access_groups/update';
10905
+ method: 'POST' | 'PATCH';
10906
+ queryParams: {};
10907
+ jsonBody: {};
10908
+ commonParams: {
10909
+ acs_access_group_id: string;
10910
+ name?: (string | null) | undefined;
10911
+ };
10912
+ formData: {};
10913
+ jsonResponse: {};
10914
+ };
10915
+ '/acs/systems/get': {
10916
+ route: '/acs/systems/get';
10917
+ method: 'GET' | 'POST';
10918
+ queryParams: {};
10919
+ jsonBody: {};
10920
+ commonParams: {
10921
+ acs_system_id: string;
10922
+ };
10923
+ formData: {};
10924
+ jsonResponse: {
10925
+ acs_system: {
10926
+ acs_system_id: string;
10927
+ system_type: 'pti_site' | 'alta_org';
10928
+ system_type_display_name: string;
10929
+ name: string;
10930
+ created_at: string;
10931
+ };
10932
+ };
10933
+ };
10934
+ '/acs/systems/list': {
10935
+ route: '/acs/systems/list';
10936
+ method: 'GET' | 'POST';
10937
+ queryParams: {};
10938
+ jsonBody: {};
10939
+ commonParams: {};
10940
+ formData: {};
10941
+ jsonResponse: {
10942
+ acs_systems: Array<{
10943
+ acs_system_id: string;
10944
+ system_type: 'pti_site' | 'alta_org';
10945
+ system_type_display_name: string;
10946
+ name: string;
10947
+ created_at: string;
10948
+ }>;
10949
+ };
10950
+ };
10951
+ '/acs/users/add_to_access_group': {
10952
+ route: '/acs/users/add_to_access_group';
10953
+ method: 'POST' | 'PATCH';
10954
+ queryParams: {};
10955
+ jsonBody: {};
10956
+ commonParams: {
10957
+ acs_user_id: string;
10958
+ acs_access_group_id: string;
10959
+ };
10960
+ formData: {};
10961
+ jsonResponse: {};
10962
+ };
10963
+ '/acs/users/create': {
10964
+ route: '/acs/users/create';
10965
+ method: 'POST';
10966
+ queryParams: {};
10967
+ jsonBody: {};
10968
+ commonParams: {
10969
+ acs_system_id: string;
10970
+ acs_access_group_ids?: string[];
10971
+ full_name?: string | undefined;
10972
+ email?: string | undefined;
10973
+ phone_number?: string | undefined;
10974
+ };
10975
+ formData: {};
10976
+ jsonResponse: {
10977
+ acs_user: {
10978
+ acs_user_id: string;
10979
+ acs_system_id: string;
10980
+ workspace_id: string;
10981
+ created_at: string;
10982
+ display_name: string;
10983
+ full_name?: string | undefined;
10984
+ email?: string | undefined;
10985
+ phone_number?: string | undefined;
10986
+ };
10987
+ };
10988
+ };
10989
+ '/acs/users/delete': {
10990
+ route: '/acs/users/delete';
10991
+ method: 'DELETE' | 'POST';
10992
+ queryParams: {};
10993
+ jsonBody: {};
10994
+ commonParams: {
10995
+ acs_user_id: string;
10996
+ };
10997
+ formData: {};
10998
+ jsonResponse: {};
10999
+ };
11000
+ '/acs/users/get': {
11001
+ route: '/acs/users/get';
11002
+ method: 'GET' | 'POST';
11003
+ queryParams: {};
11004
+ jsonBody: {};
11005
+ commonParams: {
11006
+ acs_user_id: string;
11007
+ };
11008
+ formData: {};
11009
+ jsonResponse: {
11010
+ acs_user: {
11011
+ acs_user_id: string;
11012
+ acs_system_id: string;
11013
+ workspace_id: string;
11014
+ created_at: string;
11015
+ display_name: string;
11016
+ full_name?: string | undefined;
11017
+ email?: string | undefined;
11018
+ phone_number?: string | undefined;
11019
+ };
11020
+ };
11021
+ };
11022
+ '/acs/users/list': {
11023
+ route: '/acs/users/list';
11024
+ method: 'GET' | 'POST';
11025
+ queryParams: {};
11026
+ jsonBody: {};
11027
+ commonParams: {
11028
+ acs_system_id: string;
11029
+ };
11030
+ formData: {};
11031
+ jsonResponse: {
11032
+ acs_users: Array<{
11033
+ acs_user_id: string;
11034
+ acs_system_id: string;
11035
+ workspace_id: string;
11036
+ created_at: string;
11037
+ display_name: string;
11038
+ full_name?: string | undefined;
11039
+ email?: string | undefined;
11040
+ phone_number?: string | undefined;
11041
+ }>;
11042
+ };
11043
+ };
11044
+ '/acs/users/remove_from_access_group': {
11045
+ route: '/acs/users/remove_from_access_group';
11046
+ method: 'DELETE' | 'POST';
11047
+ queryParams: {};
11048
+ jsonBody: {};
11049
+ commonParams: {
11050
+ acs_user_id: string;
11051
+ acs_access_group_id: string;
11052
+ };
11053
+ formData: {};
11054
+ jsonResponse: {};
11055
+ };
11056
+ '/acs/users/update': {
11057
+ route: '/acs/users/update';
11058
+ method: 'POST' | 'PATCH';
11059
+ queryParams: {};
11060
+ jsonBody: {};
11061
+ commonParams: {
11062
+ acs_user_id: string;
11063
+ full_name?: string | undefined;
11064
+ email?: string | undefined;
11065
+ phone_number?: string | undefined;
11066
+ };
11067
+ formData: {};
11068
+ jsonResponse: {};
11069
+ };
11070
+ '/action_attempts/get': {
11071
+ route: '/action_attempts/get';
11072
+ method: 'GET' | 'POST';
11073
+ queryParams: {};
11074
+ jsonBody: {};
11075
+ commonParams: {
11076
+ action_attempt_id: string;
11077
+ };
11078
+ formData: {};
11079
+ jsonResponse: {
11080
+ action_attempt: {
11081
+ status: 'success';
11082
+ action_type: string;
11083
+ action_attempt_id: string;
11084
+ result?: any;
11085
+ error: null;
11086
+ } | {
11087
+ status: 'pending';
11088
+ action_type: string;
11089
+ action_attempt_id: string;
11090
+ result: null;
11091
+ error: null;
11092
+ } | {
11093
+ status: 'error';
11094
+ action_type: string;
11095
+ action_attempt_id: string;
11096
+ result: null;
11097
+ error: {
11098
+ type: string;
11099
+ message: string;
11100
+ };
11101
+ };
11102
+ };
11103
+ };
11104
+ '/action_attempts/list': {
11105
+ route: '/action_attempts/list';
11106
+ method: 'GET' | 'POST';
11107
+ queryParams: {};
11108
+ jsonBody: {};
11109
+ commonParams: {
11110
+ action_attempt_ids: string[];
11111
+ };
11112
+ formData: {};
11113
+ jsonResponse: {
11114
+ action_attempts: Array<{
11115
+ status: 'success';
11116
+ action_type: string;
11117
+ action_attempt_id: string;
11118
+ result?: any;
11119
+ error: null;
11120
+ } | {
11121
+ status: 'pending';
11122
+ action_type: string;
11123
+ action_attempt_id: string;
11124
+ result: null;
11125
+ error: null;
11126
+ } | {
11127
+ status: 'error';
11128
+ action_type: string;
11129
+ action_attempt_id: string;
11130
+ result: null;
11131
+ error: {
11132
+ type: string;
11133
+ message: string;
11134
+ };
11135
+ }>;
11136
+ };
11137
+ };
11138
+ '/client_sessions/create': {
11139
+ route: '/client_sessions/create';
11140
+ method: 'POST' | 'PUT';
11141
+ queryParams: {};
11142
+ jsonBody: {
11143
+ user_identifier_key?: string | undefined;
11144
+ connect_webview_ids?: string[] | undefined;
11145
+ connected_account_ids?: string[] | undefined;
11146
+ };
11147
+ commonParams: {};
11148
+ formData: {};
11149
+ jsonResponse: {
11150
+ client_session: {
11151
+ client_session_id: string;
11152
+ user_identifier_key: string | null;
11153
+ created_at: string;
11154
+ token: string;
11155
+ workspace_id: string;
11156
+ };
11157
+ };
11158
+ };
11159
+ '/client_sessions/delete': {
11160
+ route: '/client_sessions/delete';
11161
+ method: 'POST' | 'DELETE';
11162
+ queryParams: {};
11163
+ jsonBody: {};
11164
+ commonParams: {
11165
+ client_session_id: string;
11166
+ };
11167
+ formData: {};
11168
+ jsonResponse: {};
11169
+ };
11170
+ '/client_sessions/get': {
11171
+ route: '/client_sessions/get';
11172
+ method: 'GET' | 'POST';
11173
+ queryParams: {};
11174
+ jsonBody: {};
11175
+ commonParams: {
11176
+ client_session_id?: string | undefined;
11177
+ user_identifier_key?: string | undefined;
11178
+ };
11179
+ formData: {};
11180
+ jsonResponse: {
11181
+ client_session: {
11182
+ client_session_id: string;
11183
+ user_identifier_key: string | null;
11184
+ created_at: string;
11185
+ token: string;
11186
+ device_count: number;
11187
+ connected_account_ids: string[];
11188
+ connect_webview_ids: string[];
11189
+ workspace_id: string;
11190
+ };
11191
+ };
11192
+ };
11193
+ '/client_sessions/grant_access': {
11194
+ route: '/client_sessions/grant_access';
11195
+ method: 'POST' | 'PATCH';
11196
+ queryParams: {};
11197
+ jsonBody: {};
11198
+ commonParams: {
11199
+ client_session_id?: string | undefined;
11200
+ user_identifier_key?: string | undefined;
11201
+ connected_account_ids?: string[] | undefined;
11202
+ connect_webview_ids?: string[] | undefined;
11203
+ };
11204
+ formData: {};
11205
+ jsonResponse: {
11206
+ client_session: {
11207
+ client_session_id: string;
11208
+ user_identifier_key: string | null;
11209
+ created_at: string;
11210
+ token: string;
11211
+ device_count: number;
11212
+ connected_account_ids: string[];
11213
+ connect_webview_ids: string[];
11214
+ workspace_id: string;
11215
+ };
11216
+ };
11217
+ };
11218
+ '/client_sessions/list': {
11219
+ route: '/client_sessions/list';
11220
+ method: 'POST' | 'GET';
11221
+ queryParams: {};
11222
+ jsonBody: {};
11223
+ commonParams: {
11224
+ client_session_id?: string | undefined;
11225
+ user_identifier_key?: string | undefined;
11226
+ connect_webview_id?: string | undefined;
11227
+ without_user_identifier_key?: boolean | undefined;
11228
+ };
11229
+ formData: {};
11230
+ jsonResponse: {
11231
+ client_sessions: Array<{
11232
+ client_session_id: string;
11233
+ user_identifier_key: string | null;
11234
+ created_at: string;
11235
+ device_count: number;
11236
+ connected_account_ids: string[];
11237
+ connect_webview_ids: string[];
11238
+ workspace_id: string;
11239
+ }>;
11240
+ };
11241
+ };
11242
+ '/connect_webviews/create': {
11243
+ route: '/connect_webviews/create';
11244
+ method: 'POST';
11245
+ queryParams: {};
11246
+ jsonBody: {
11247
+ device_selection_mode?: ('none' | 'single' | 'multiple') | undefined;
11248
+ custom_redirect_url?: string | undefined;
11249
+ custom_redirect_failure_url?: string | undefined;
11250
+ accepted_providers?: Array<'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'yale_access'> | undefined;
11251
+ provider_category?: ('stable' | 'consumer_smartlocks' | 'internal_beta') | undefined;
11252
+ custom_metadata?: Record<string, string | number | null | boolean> | undefined;
11253
+ automatically_manage_new_devices?: boolean | undefined;
11254
+ wait_for_device_creation?: boolean | undefined;
11255
+ };
11256
+ commonParams: {};
11257
+ formData: {};
11258
+ jsonResponse: {
11259
+ connect_webview: {
11260
+ connect_webview_id: string;
11261
+ connected_account_id?: string | undefined;
11262
+ url: string;
11263
+ workspace_id: string;
11264
+ device_selection_mode: 'none' | 'single' | 'multiple';
11265
+ accepted_providers: string[];
11266
+ accepted_devices: string[];
11267
+ any_provider_allowed: boolean;
11268
+ any_device_allowed: boolean;
11269
+ created_at: string;
11270
+ login_successful: boolean;
11271
+ status: 'pending' | 'failed' | 'authorized';
11272
+ };
11273
+ };
11274
+ };
11275
+ '/connect_webviews/delete': {
11276
+ route: '/connect_webviews/delete';
11277
+ method: 'DELETE' | 'POST';
11278
+ queryParams: {};
11279
+ jsonBody: {
11280
+ connect_webview_id: string;
11281
+ };
11282
+ commonParams: {};
11283
+ formData: {};
11284
+ jsonResponse: {};
11285
+ };
11286
+ '/connect_webviews/get': {
11287
+ route: '/connect_webviews/get';
11288
+ method: 'GET' | 'POST';
11289
+ queryParams: {};
11290
+ jsonBody: {};
11291
+ commonParams: {
11292
+ connect_webview_id: string;
11293
+ };
11294
+ formData: {};
11295
+ jsonResponse: {
11296
+ connect_webview: {
11297
+ connect_webview_id: string;
11298
+ connected_account_id?: string | undefined;
11299
+ url: string;
11300
+ workspace_id: string;
11301
+ device_selection_mode: 'none' | 'single' | 'multiple';
11302
+ accepted_providers: string[];
11303
+ accepted_devices: string[];
11304
+ any_provider_allowed: boolean;
11305
+ any_device_allowed: boolean;
11306
+ created_at: string;
11307
+ login_successful: boolean;
11308
+ status: 'pending' | 'failed' | 'authorized';
11309
+ };
11310
+ };
11311
+ };
11312
+ '/connect_webviews/list': {
11313
+ route: '/connect_webviews/list';
11314
+ method: 'GET' | 'POST';
11315
+ queryParams: {};
11316
+ jsonBody: {};
11317
+ commonParams: {};
11318
+ formData: {};
11319
+ jsonResponse: {
11320
+ connect_webviews: Array<{
11321
+ connect_webview_id: string;
11322
+ connected_account_id?: string | undefined;
11323
+ url: string;
11324
+ workspace_id: string;
11325
+ device_selection_mode: 'none' | 'single' | 'multiple';
11326
+ accepted_providers: string[];
11327
+ accepted_devices: string[];
11328
+ any_provider_allowed: boolean;
11329
+ any_device_allowed: boolean;
11330
+ created_at: string;
11331
+ login_successful: boolean;
11332
+ status: 'pending' | 'failed' | 'authorized';
11333
+ }>;
11334
+ };
11335
+ };
11336
+ '/connect_webviews/view': {
11337
+ route: '/connect_webviews/view';
11338
+ method: 'GET';
11339
+ queryParams: {
11340
+ connect_webview_id: string;
11341
+ auth_token: string;
11342
+ };
11343
+ jsonBody: {};
11344
+ commonParams: {};
11345
+ formData: {};
11346
+ jsonResponse: {};
11347
+ };
11348
+ '/connected_accounts/delete': {
11349
+ route: '/connected_accounts/delete';
11350
+ method: 'DELETE' | 'POST';
11351
+ queryParams: {};
11352
+ jsonBody: {
11353
+ connected_account_id: string;
11354
+ sync?: boolean;
11355
+ };
11356
+ commonParams: {};
11357
+ formData: {};
11358
+ jsonResponse: {};
11359
+ };
11360
+ '/connected_accounts/get': {
11361
+ route: '/connected_accounts/get';
11362
+ method: 'GET' | 'POST';
11363
+ queryParams: {};
11364
+ jsonBody: {};
11365
+ commonParams: {
11366
+ connected_account_id: string;
11367
+ } | {
11368
+ email: string;
11369
+ };
11370
+ formData: {};
11371
+ jsonResponse: {
11372
+ connected_account: {
11373
+ connected_account_id?: string | undefined;
11374
+ created_at?: string | undefined;
11375
+ user_identifier?: {
11376
+ username?: string | undefined;
11377
+ api_url?: string | undefined;
11378
+ email?: string | undefined;
11379
+ phone?: string | undefined;
11380
+ exclusive?: boolean | undefined;
11381
+ } | undefined;
11382
+ account_type?: string | undefined;
11383
+ account_type_display_name: string;
11384
+ errors?: any;
11385
+ warnings?: any;
11386
+ custom_metadata?: Record<string, string | number | boolean | null> | undefined;
11387
+ };
11388
+ };
11389
+ };
11390
+ '/connected_accounts/list': {
11391
+ route: '/connected_accounts/list';
11392
+ method: 'GET' | 'POST';
11393
+ queryParams: {};
11394
+ jsonBody: {};
11395
+ commonParams: {};
11396
+ formData: {};
11397
+ jsonResponse: {
11398
+ connected_accounts: Array<{
11399
+ connected_account_id?: string | undefined;
11400
+ created_at?: string | undefined;
11401
+ user_identifier?: {
11402
+ username?: string | undefined;
11403
+ api_url?: string | undefined;
11404
+ email?: string | undefined;
11405
+ phone?: string | undefined;
11406
+ exclusive?: boolean | undefined;
11407
+ } | undefined;
11408
+ account_type?: string | undefined;
11409
+ account_type_display_name: string;
11410
+ errors?: any;
11411
+ warnings?: any;
11412
+ custom_metadata?: Record<string, string | number | boolean | null> | undefined;
11413
+ }>;
11414
+ };
11415
+ };
11416
+ '/devices/delete': {
11417
+ route: '/devices/delete';
11418
+ method: 'DELETE' | 'POST';
11419
+ queryParams: {};
11420
+ jsonBody: {};
11421
+ commonParams: {
11422
+ device_id: string;
11423
+ };
11424
+ formData: {};
11425
+ jsonResponse: {};
11426
+ };
11427
+ '/devices/get': {
11428
+ route: '/devices/get';
11429
+ method: 'GET' | 'POST';
11430
+ queryParams: {};
11431
+ jsonBody: {};
11432
+ commonParams: {
11433
+ device_id?: string | undefined;
11434
+ name?: string | undefined;
11435
+ };
11436
+ formData: {};
11437
+ jsonResponse: {
11438
+ device: {
11439
+ device_id: string;
11440
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
11441
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
11442
+ properties: ({
11443
+ online: boolean;
11444
+ name: string;
11445
+ model: {
11446
+ display_name: string;
11447
+ manufacturer_display_name: string;
11448
+ };
11449
+ has_direct_power?: boolean | undefined;
11450
+ battery_level?: number | undefined;
11451
+ battery?: {
11452
+ level: number;
11453
+ status: 'critical' | 'low' | 'good' | 'full';
11454
+ } | undefined;
11455
+ manufacturer?: string | undefined;
11456
+ image_url?: string | undefined;
11457
+ image_alt_text?: string | undefined;
11458
+ serial_number?: string | undefined;
11459
+ } & {
11460
+ august_metadata?: {
11461
+ lock_id: string;
11462
+ lock_name: string;
11463
+ house_name: string;
11464
+ has_keypad: boolean;
11465
+ keypad_battery_level?: string | undefined;
11466
+ model?: string | undefined;
11467
+ house_id?: string | undefined;
11468
+ } | undefined;
11469
+ avigilon_alta_metadata?: {
11470
+ entry_name: string;
11471
+ org_name: string;
11472
+ zone_id: number;
11473
+ zone_name: string;
11474
+ site_id: number;
11475
+ site_name: string;
11476
+ } | undefined;
11477
+ schlage_metadata?: {
11478
+ device_id: string;
11479
+ device_name: string;
11480
+ access_code_length: number;
11481
+ model?: string | undefined;
11482
+ } | undefined;
11483
+ smartthings_metadata?: {
11484
+ device_id: string;
11485
+ device_name: string;
11486
+ model?: string | undefined;
11487
+ location_id?: string | undefined;
11488
+ } | undefined;
11489
+ lockly_metadata?: {
11490
+ device_id: string;
11491
+ device_name: string;
11492
+ model?: string | undefined;
11493
+ } | undefined;
11494
+ nuki_metadata?: {
11495
+ device_id: string;
11496
+ device_name: string;
11497
+ keypad_battery_critical?: boolean | undefined;
11498
+ } | undefined;
11499
+ kwikset_metadata?: {
11500
+ device_id: string;
11501
+ device_name: string;
11502
+ model_number: string;
11503
+ } | undefined;
11504
+ salto_metadata?: {
11505
+ lock_id: string;
11506
+ customer_reference: string;
11507
+ lock_type: string;
11508
+ battery_level: string;
11509
+ locked_state: string;
11510
+ model?: string | undefined;
11511
+ } | undefined;
11512
+ genie_metadata?: {
11513
+ device_name: string;
11514
+ door_name: string;
11515
+ } | undefined;
11516
+ brivo_metadata?: {
11517
+ device_name: string;
11518
+ } | undefined;
11519
+ igloo_metadata?: {
11520
+ device_id: string;
11521
+ bridge_id: string;
11522
+ model?: string | undefined;
11523
+ } | undefined;
11524
+ noiseaware_metadata?: {
11525
+ device_model: 'indoor' | 'outdoor';
11526
+ noise_level_nrs: number;
11527
+ noise_level_decibel: number;
11528
+ device_name: string;
11529
+ device_id: string;
11530
+ } | undefined;
11531
+ minut_metadata?: {
11532
+ device_id: string;
11533
+ device_name: string;
11534
+ latest_sensor_values: {
11535
+ temperature: {
11536
+ time: string;
11537
+ value: number;
11538
+ };
11539
+ sound: {
11540
+ time: string;
11541
+ value: number;
11542
+ };
11543
+ humidity: {
11544
+ time: string;
11545
+ value: number;
11546
+ };
11547
+ pressure: {
11548
+ time: string;
11549
+ value: number;
11550
+ };
11551
+ accelerometer_z: {
11552
+ time: string;
11553
+ value: number;
11554
+ };
11555
+ };
11556
+ } | undefined;
11557
+ four_suites_metadata?: {
11558
+ device_id: number;
11559
+ device_name: string;
11560
+ reclose_delay_in_seconds: number;
11561
+ } | undefined;
11562
+ two_n_metadata?: {
11563
+ device_id: number;
11564
+ device_name: string;
11565
+ } | undefined;
11566
+ controlbyweb_metadata?: {
11567
+ device_id: string;
11568
+ device_name: string;
11569
+ relay_name: string | null;
11570
+ } | undefined;
11571
+ ttlock_metadata?: {
11572
+ lock_id: number;
11573
+ lock_alias: string;
11574
+ } | undefined;
11575
+ seam_bridge_metadata?: {
11576
+ unlock_method?: ('bridge' | 'doorking') | undefined;
11577
+ device_num: number;
11578
+ name: string;
11579
+ } | undefined;
11580
+ igloohome_metadata?: {
11581
+ device_id: string;
11582
+ bridge_id: string;
11583
+ device_name: string;
11584
+ bridge_name: string;
11585
+ } | undefined;
11586
+ nest_metadata?: {
11587
+ nest_device_id: string;
11588
+ device_name: string;
11589
+ custom_name: string;
11590
+ } | undefined;
11591
+ ecobee_metadata?: {
11592
+ ecobee_device_id: string;
11593
+ device_name: string;
11594
+ } | undefined;
11595
+ hubitat_metadata?: {
11596
+ device_id: string;
11597
+ device_name: string;
11598
+ device_label: string;
11599
+ } | undefined;
11600
+ dormakaba_oracode_metadata?: {
11601
+ door_id: number;
11602
+ door_name: string;
11603
+ device_id?: number | undefined;
11604
+ site_id: number;
11605
+ site_name: string;
11606
+ } | undefined;
11607
+ wyze_metadata?: {
11608
+ device_id: string;
11609
+ device_name: string;
11610
+ product_type: string;
11611
+ product_model: string;
11612
+ device_info_model: string;
11613
+ } | undefined;
11614
+ }) & ({
11615
+ code_constraints?: (Array<{
11616
+ constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future';
11617
+ } | {
11618
+ constraint_type: 'name_length';
11619
+ min_length?: number | undefined;
11620
+ max_length?: number | undefined;
11621
+ }> | undefined) | undefined;
11622
+ supported_code_lengths?: (number[] | undefined) | undefined;
11623
+ max_active_codes_supported?: (number | undefined) | undefined;
11624
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined;
11625
+ has_native_entry_events?: (boolean | undefined) | undefined;
11626
+ locked?: (boolean | undefined) | undefined;
11627
+ keypad_battery?: ({
11628
+ level: number;
11629
+ } | undefined) | undefined;
11630
+ door_open?: (boolean | undefined) | undefined;
11631
+ } & ({
11632
+ temperature_fahrenheit?: number | undefined;
11633
+ temperature_celsius?: number | undefined;
11634
+ relative_humidity?: number | undefined;
11635
+ can_enable_automatic_heating?: boolean | undefined;
11636
+ can_enable_automatic_cooling?: boolean | undefined;
11637
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
11638
+ is_heating_available?: true | undefined;
11639
+ is_cooling_available?: true | undefined;
11640
+ is_heating?: boolean | undefined;
11641
+ is_cooling?: boolean | undefined;
11642
+ is_fan_running?: boolean | undefined;
11643
+ fan_mode_setting?: ('auto' | 'on') | undefined;
11644
+ is_temporary_manual_override_active?: boolean | undefined;
11645
+ current_climate_setting?: {
11646
+ automatic_heating_enabled: boolean;
11647
+ automatic_cooling_enabled: boolean;
11648
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
11649
+ cooling_set_point_celsius?: number | undefined;
11650
+ heating_set_point_celsius?: number | undefined;
11651
+ cooling_set_point_fahrenheit?: number | undefined;
11652
+ heating_set_point_fahrenheit?: number | undefined;
11653
+ manual_override_allowed: boolean;
11654
+ } | undefined;
11655
+ default_climate_setting?: ({
11656
+ automatic_heating_enabled: boolean;
11657
+ automatic_cooling_enabled: boolean;
11658
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
11659
+ cooling_set_point_celsius?: number | undefined;
11660
+ heating_set_point_celsius?: number | undefined;
11661
+ cooling_set_point_fahrenheit?: number | undefined;
11662
+ heating_set_point_fahrenheit?: number | undefined;
11663
+ manual_override_allowed: boolean;
11664
+ } | undefined) | undefined;
11665
+ is_climate_setting_schedule_active?: boolean | undefined;
11666
+ active_climate_setting_schedule?: ({
11667
+ climate_setting_schedule_id: string;
11668
+ schedule_type: 'time_bound';
11669
+ device_id: string;
11670
+ name?: string | undefined;
11671
+ schedule_starts_at: string;
11672
+ schedule_ends_at: string;
11673
+ created_at: string;
11674
+ automatic_heating_enabled?: boolean | undefined;
11675
+ automatic_cooling_enabled?: boolean | undefined;
11676
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
11677
+ cooling_set_point_celsius?: (number | undefined) | undefined;
11678
+ heating_set_point_celsius?: (number | undefined) | undefined;
11679
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
11680
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
11681
+ manual_override_allowed?: boolean | undefined;
11682
+ } | undefined) | undefined;
11683
+ min_cooling_set_point_celsius?: number | undefined;
11684
+ min_cooling_set_point_fahrenheit?: number | undefined;
11685
+ max_cooling_set_point_celsius?: number | undefined;
11686
+ max_cooling_set_point_fahrenheit?: number | undefined;
11687
+ min_heating_set_point_celsius?: number | undefined;
11688
+ min_heating_set_point_fahrenheit?: number | undefined;
11689
+ max_heating_set_point_celsius?: number | undefined;
11690
+ max_heating_set_point_fahrenheit?: number | undefined;
11691
+ min_heating_cooling_delta_celsius?: number | undefined;
11692
+ min_heating_cooling_delta_fahrenheit?: number | undefined;
11693
+ } | {
11694
+ temperature_fahrenheit?: number | undefined;
11695
+ temperature_celsius?: number | undefined;
11696
+ relative_humidity?: number | undefined;
11697
+ can_enable_automatic_heating?: boolean | undefined;
11698
+ can_enable_automatic_cooling?: boolean | undefined;
11699
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
11700
+ is_heating_available?: true | undefined;
11701
+ is_cooling_available?: false | undefined;
11702
+ is_heating?: boolean | undefined;
11703
+ is_cooling?: boolean | undefined;
11704
+ is_fan_running?: boolean | undefined;
11705
+ fan_mode_setting?: ('auto' | 'on') | undefined;
11706
+ is_temporary_manual_override_active?: boolean | undefined;
11707
+ current_climate_setting?: {
11708
+ automatic_heating_enabled: boolean;
11709
+ automatic_cooling_enabled: boolean;
11710
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
11711
+ cooling_set_point_celsius?: number | undefined;
11712
+ heating_set_point_celsius?: number | undefined;
11713
+ cooling_set_point_fahrenheit?: number | undefined;
11714
+ heating_set_point_fahrenheit?: number | undefined;
11715
+ manual_override_allowed: boolean;
11716
+ } | undefined;
11717
+ default_climate_setting?: ({
11718
+ automatic_heating_enabled: boolean;
11719
+ automatic_cooling_enabled: boolean;
11720
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
11721
+ cooling_set_point_celsius?: number | undefined;
11722
+ heating_set_point_celsius?: number | undefined;
11723
+ cooling_set_point_fahrenheit?: number | undefined;
11724
+ heating_set_point_fahrenheit?: number | undefined;
11725
+ manual_override_allowed: boolean;
11726
+ } | undefined) | undefined;
11727
+ is_climate_setting_schedule_active?: boolean | undefined;
11728
+ active_climate_setting_schedule?: ({
11729
+ climate_setting_schedule_id: string;
11730
+ schedule_type: 'time_bound';
11731
+ device_id: string;
11732
+ name?: string | undefined;
11733
+ schedule_starts_at: string;
11734
+ schedule_ends_at: string;
11735
+ created_at: string;
11736
+ automatic_heating_enabled?: boolean | undefined;
11737
+ automatic_cooling_enabled?: boolean | undefined;
11738
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
11739
+ cooling_set_point_celsius?: (number | undefined) | undefined;
11740
+ heating_set_point_celsius?: (number | undefined) | undefined;
11741
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
11742
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
11743
+ manual_override_allowed?: boolean | undefined;
11744
+ } | undefined) | undefined;
11745
+ min_heating_set_point_celsius?: number | undefined;
11746
+ min_heating_set_point_fahrenheit?: number | undefined;
11747
+ max_heating_set_point_celsius?: number | undefined;
11748
+ max_heating_set_point_fahrenheit?: number | undefined;
11749
+ } | {
11750
+ temperature_fahrenheit?: number | undefined;
11751
+ temperature_celsius?: number | undefined;
11752
+ relative_humidity?: number | undefined;
11753
+ can_enable_automatic_heating?: boolean | undefined;
11754
+ can_enable_automatic_cooling?: boolean | undefined;
11755
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
11756
+ is_heating_available?: false | undefined;
11757
+ is_cooling_available?: true | undefined;
11758
+ is_heating?: boolean | undefined;
11759
+ is_cooling?: boolean | undefined;
11760
+ is_fan_running?: boolean | undefined;
11761
+ fan_mode_setting?: ('auto' | 'on') | undefined;
11762
+ is_temporary_manual_override_active?: boolean | undefined;
11763
+ current_climate_setting?: {
11764
+ automatic_heating_enabled: boolean;
11765
+ automatic_cooling_enabled: boolean;
11766
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
11767
+ cooling_set_point_celsius?: number | undefined;
11768
+ heating_set_point_celsius?: number | undefined;
11769
+ cooling_set_point_fahrenheit?: number | undefined;
11770
+ heating_set_point_fahrenheit?: number | undefined;
11771
+ manual_override_allowed: boolean;
11772
+ } | undefined;
11773
+ default_climate_setting?: ({
11774
+ automatic_heating_enabled: boolean;
11775
+ automatic_cooling_enabled: boolean;
11776
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
11777
+ cooling_set_point_celsius?: number | undefined;
11778
+ heating_set_point_celsius?: number | undefined;
11779
+ cooling_set_point_fahrenheit?: number | undefined;
11780
+ heating_set_point_fahrenheit?: number | undefined;
11781
+ manual_override_allowed: boolean;
11782
+ } | undefined) | undefined;
11783
+ is_climate_setting_schedule_active?: boolean | undefined;
11784
+ active_climate_setting_schedule?: ({
11785
+ climate_setting_schedule_id: string;
11786
+ schedule_type: 'time_bound';
11787
+ device_id: string;
11788
+ name?: string | undefined;
11789
+ schedule_starts_at: string;
11790
+ schedule_ends_at: string;
11791
+ created_at: string;
11792
+ automatic_heating_enabled?: boolean | undefined;
11793
+ automatic_cooling_enabled?: boolean | undefined;
11794
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
11795
+ cooling_set_point_celsius?: (number | undefined) | undefined;
11796
+ heating_set_point_celsius?: (number | undefined) | undefined;
11797
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
11798
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
11799
+ manual_override_allowed?: boolean | undefined;
11800
+ } | undefined) | undefined;
11801
+ min_cooling_set_point_celsius?: number | undefined;
11802
+ min_cooling_set_point_fahrenheit?: number | undefined;
11803
+ max_cooling_set_point_celsius?: number | undefined;
11804
+ max_cooling_set_point_fahrenheit?: number | undefined;
11805
+ }));
11806
+ location: {
11807
+ location_name?: string | undefined;
11808
+ timezone?: string | undefined;
11809
+ } | null;
11810
+ connected_account_id: string;
11811
+ workspace_id: string;
11812
+ errors: Array<{
11813
+ error_code: string;
11814
+ message: string;
11815
+ }>;
11816
+ warnings: Array<{
11817
+ warning_code: string;
11818
+ message: string;
11819
+ }>;
11820
+ created_at: string;
11821
+ is_managed: true;
11822
+ };
11823
+ };
11824
+ };
11825
+ '/devices/list': {
11826
+ route: '/devices/list';
11827
+ method: 'GET' | 'POST';
11828
+ queryParams: {};
11829
+ jsonBody: {};
11830
+ commonParams: {
11831
+ connected_account_id?: string | undefined;
11832
+ connected_account_ids?: string[] | undefined;
11833
+ connect_webview_id?: string | undefined;
11834
+ device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')) | undefined;
11835
+ device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')> | undefined;
11836
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode') | undefined;
11837
+ device_ids?: string[] | undefined;
11838
+ limit?: number;
11839
+ created_before?: string | undefined;
11840
+ };
11841
+ formData: {};
11842
+ jsonResponse: {
11843
+ devices: Array<{
11844
+ device_id: string;
11845
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
11846
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
11847
+ properties: ({
11848
+ online: boolean;
11849
+ name: string;
11850
+ model: {
11851
+ display_name: string;
11852
+ manufacturer_display_name: string;
11853
+ };
11854
+ has_direct_power?: boolean | undefined;
11855
+ battery_level?: number | undefined;
11856
+ battery?: {
11857
+ level: number;
11858
+ status: 'critical' | 'low' | 'good' | 'full';
11859
+ } | undefined;
11860
+ manufacturer?: string | undefined;
11861
+ image_url?: string | undefined;
11862
+ image_alt_text?: string | undefined;
11863
+ serial_number?: string | undefined;
11864
+ } & {
11865
+ august_metadata?: {
11866
+ lock_id: string;
11867
+ lock_name: string;
11868
+ house_name: string;
11869
+ has_keypad: boolean;
11870
+ keypad_battery_level?: string | undefined;
11871
+ model?: string | undefined;
11872
+ house_id?: string | undefined;
11873
+ } | undefined;
11874
+ avigilon_alta_metadata?: {
11875
+ entry_name: string;
11876
+ org_name: string;
11877
+ zone_id: number;
11878
+ zone_name: string;
11879
+ site_id: number;
11880
+ site_name: string;
11881
+ } | undefined;
11882
+ schlage_metadata?: {
11883
+ device_id: string;
11884
+ device_name: string;
11885
+ access_code_length: number;
11886
+ model?: string | undefined;
11887
+ } | undefined;
11888
+ smartthings_metadata?: {
11889
+ device_id: string;
11890
+ device_name: string;
11891
+ model?: string | undefined;
11892
+ location_id?: string | undefined;
11893
+ } | undefined;
11894
+ lockly_metadata?: {
11895
+ device_id: string;
11896
+ device_name: string;
11897
+ model?: string | undefined;
11898
+ } | undefined;
11899
+ nuki_metadata?: {
11900
+ device_id: string;
11901
+ device_name: string;
11902
+ keypad_battery_critical?: boolean | undefined;
11903
+ } | undefined;
11904
+ kwikset_metadata?: {
11905
+ device_id: string;
11906
+ device_name: string;
11907
+ model_number: string;
11908
+ } | undefined;
11909
+ salto_metadata?: {
11910
+ lock_id: string;
11911
+ customer_reference: string;
11912
+ lock_type: string;
11913
+ battery_level: string;
11914
+ locked_state: string;
11915
+ model?: string | undefined;
11916
+ } | undefined;
11917
+ genie_metadata?: {
11918
+ device_name: string;
11919
+ door_name: string;
11920
+ } | undefined;
11921
+ brivo_metadata?: {
11922
+ device_name: string;
11923
+ } | undefined;
11924
+ igloo_metadata?: {
11925
+ device_id: string;
11926
+ bridge_id: string;
11927
+ model?: string | undefined;
11928
+ } | undefined;
11929
+ noiseaware_metadata?: {
11930
+ device_model: 'indoor' | 'outdoor';
11931
+ noise_level_nrs: number;
11932
+ noise_level_decibel: number;
11933
+ device_name: string;
11934
+ device_id: string;
11935
+ } | undefined;
11936
+ minut_metadata?: {
11937
+ device_id: string;
11938
+ device_name: string;
11939
+ latest_sensor_values: {
11940
+ temperature: {
11941
+ time: string;
11942
+ value: number;
11943
+ };
11944
+ sound: {
11945
+ time: string;
11946
+ value: number;
11947
+ };
11948
+ humidity: {
11949
+ time: string;
11950
+ value: number;
11951
+ };
11952
+ pressure: {
11953
+ time: string;
11954
+ value: number;
11955
+ };
11956
+ accelerometer_z: {
11957
+ time: string;
11958
+ value: number;
11959
+ };
11960
+ };
11961
+ } | undefined;
11962
+ four_suites_metadata?: {
11963
+ device_id: number;
11964
+ device_name: string;
11965
+ reclose_delay_in_seconds: number;
11966
+ } | undefined;
11967
+ two_n_metadata?: {
11968
+ device_id: number;
11969
+ device_name: string;
11970
+ } | undefined;
11971
+ controlbyweb_metadata?: {
11972
+ device_id: string;
11973
+ device_name: string;
11974
+ relay_name: string | null;
11975
+ } | undefined;
11976
+ ttlock_metadata?: {
11977
+ lock_id: number;
11978
+ lock_alias: string;
11979
+ } | undefined;
11980
+ seam_bridge_metadata?: {
11981
+ unlock_method?: ('bridge' | 'doorking') | undefined;
11982
+ device_num: number;
11983
+ name: string;
11984
+ } | undefined;
11985
+ igloohome_metadata?: {
11986
+ device_id: string;
11987
+ bridge_id: string;
11988
+ device_name: string;
11989
+ bridge_name: string;
11990
+ } | undefined;
11991
+ nest_metadata?: {
11992
+ nest_device_id: string;
11993
+ device_name: string;
11994
+ custom_name: string;
11995
+ } | undefined;
11996
+ ecobee_metadata?: {
11997
+ ecobee_device_id: string;
11998
+ device_name: string;
11999
+ } | undefined;
12000
+ hubitat_metadata?: {
12001
+ device_id: string;
12002
+ device_name: string;
12003
+ device_label: string;
12004
+ } | undefined;
12005
+ dormakaba_oracode_metadata?: {
12006
+ door_id: number;
12007
+ door_name: string;
12008
+ device_id?: number | undefined;
12009
+ site_id: number;
12010
+ site_name: string;
12011
+ } | undefined;
12012
+ wyze_metadata?: {
12013
+ device_id: string;
12014
+ device_name: string;
12015
+ product_type: string;
12016
+ product_model: string;
12017
+ device_info_model: string;
12018
+ } | undefined;
12019
+ }) & ({
12020
+ code_constraints?: (Array<{
12021
+ constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future';
12022
+ } | {
12023
+ constraint_type: 'name_length';
12024
+ min_length?: number | undefined;
12025
+ max_length?: number | undefined;
12026
+ }> | undefined) | undefined;
12027
+ supported_code_lengths?: (number[] | undefined) | undefined;
12028
+ max_active_codes_supported?: (number | undefined) | undefined;
12029
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined;
12030
+ has_native_entry_events?: (boolean | undefined) | undefined;
12031
+ locked?: (boolean | undefined) | undefined;
12032
+ keypad_battery?: ({
12033
+ level: number;
12034
+ } | undefined) | undefined;
12035
+ door_open?: (boolean | undefined) | undefined;
12036
+ } & ({
12037
+ temperature_fahrenheit?: number | undefined;
12038
+ temperature_celsius?: number | undefined;
12039
+ relative_humidity?: number | undefined;
12040
+ can_enable_automatic_heating?: boolean | undefined;
12041
+ can_enable_automatic_cooling?: boolean | undefined;
12042
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
12043
+ is_heating_available?: true | undefined;
12044
+ is_cooling_available?: true | undefined;
12045
+ is_heating?: boolean | undefined;
12046
+ is_cooling?: boolean | undefined;
12047
+ is_fan_running?: boolean | undefined;
12048
+ fan_mode_setting?: ('auto' | 'on') | undefined;
12049
+ is_temporary_manual_override_active?: boolean | undefined;
12050
+ current_climate_setting?: {
12051
+ automatic_heating_enabled: boolean;
12052
+ automatic_cooling_enabled: boolean;
12053
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12054
+ cooling_set_point_celsius?: number | undefined;
12055
+ heating_set_point_celsius?: number | undefined;
12056
+ cooling_set_point_fahrenheit?: number | undefined;
12057
+ heating_set_point_fahrenheit?: number | undefined;
12058
+ manual_override_allowed: boolean;
12059
+ } | undefined;
12060
+ default_climate_setting?: ({
12061
+ automatic_heating_enabled: boolean;
12062
+ automatic_cooling_enabled: boolean;
12063
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12064
+ cooling_set_point_celsius?: number | undefined;
12065
+ heating_set_point_celsius?: number | undefined;
12066
+ cooling_set_point_fahrenheit?: number | undefined;
12067
+ heating_set_point_fahrenheit?: number | undefined;
12068
+ manual_override_allowed: boolean;
12069
+ } | undefined) | undefined;
12070
+ is_climate_setting_schedule_active?: boolean | undefined;
12071
+ active_climate_setting_schedule?: ({
12072
+ climate_setting_schedule_id: string;
12073
+ schedule_type: 'time_bound';
12074
+ device_id: string;
12075
+ name?: string | undefined;
12076
+ schedule_starts_at: string;
12077
+ schedule_ends_at: string;
12078
+ created_at: string;
12079
+ automatic_heating_enabled?: boolean | undefined;
12080
+ automatic_cooling_enabled?: boolean | undefined;
12081
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12082
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12083
+ heating_set_point_celsius?: (number | undefined) | undefined;
12084
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12085
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12086
+ manual_override_allowed?: boolean | undefined;
12087
+ } | undefined) | undefined;
12088
+ min_cooling_set_point_celsius?: number | undefined;
12089
+ min_cooling_set_point_fahrenheit?: number | undefined;
12090
+ max_cooling_set_point_celsius?: number | undefined;
12091
+ max_cooling_set_point_fahrenheit?: number | undefined;
12092
+ min_heating_set_point_celsius?: number | undefined;
12093
+ min_heating_set_point_fahrenheit?: number | undefined;
12094
+ max_heating_set_point_celsius?: number | undefined;
12095
+ max_heating_set_point_fahrenheit?: number | undefined;
12096
+ min_heating_cooling_delta_celsius?: number | undefined;
12097
+ min_heating_cooling_delta_fahrenheit?: number | undefined;
12098
+ } | {
12099
+ temperature_fahrenheit?: number | undefined;
12100
+ temperature_celsius?: number | undefined;
12101
+ relative_humidity?: number | undefined;
12102
+ can_enable_automatic_heating?: boolean | undefined;
12103
+ can_enable_automatic_cooling?: boolean | undefined;
12104
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
12105
+ is_heating_available?: true | undefined;
12106
+ is_cooling_available?: false | undefined;
12107
+ is_heating?: boolean | undefined;
12108
+ is_cooling?: boolean | undefined;
12109
+ is_fan_running?: boolean | undefined;
12110
+ fan_mode_setting?: ('auto' | 'on') | undefined;
12111
+ is_temporary_manual_override_active?: boolean | undefined;
12112
+ current_climate_setting?: {
12113
+ automatic_heating_enabled: boolean;
12114
+ automatic_cooling_enabled: boolean;
12115
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12116
+ cooling_set_point_celsius?: number | undefined;
12117
+ heating_set_point_celsius?: number | undefined;
12118
+ cooling_set_point_fahrenheit?: number | undefined;
12119
+ heating_set_point_fahrenheit?: number | undefined;
12120
+ manual_override_allowed: boolean;
12121
+ } | undefined;
12122
+ default_climate_setting?: ({
12123
+ automatic_heating_enabled: boolean;
12124
+ automatic_cooling_enabled: boolean;
12125
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12126
+ cooling_set_point_celsius?: number | undefined;
12127
+ heating_set_point_celsius?: number | undefined;
12128
+ cooling_set_point_fahrenheit?: number | undefined;
12129
+ heating_set_point_fahrenheit?: number | undefined;
12130
+ manual_override_allowed: boolean;
12131
+ } | undefined) | undefined;
12132
+ is_climate_setting_schedule_active?: boolean | undefined;
12133
+ active_climate_setting_schedule?: ({
12134
+ climate_setting_schedule_id: string;
12135
+ schedule_type: 'time_bound';
12136
+ device_id: string;
12137
+ name?: string | undefined;
12138
+ schedule_starts_at: string;
12139
+ schedule_ends_at: string;
12140
+ created_at: string;
12141
+ automatic_heating_enabled?: boolean | undefined;
12142
+ automatic_cooling_enabled?: boolean | undefined;
12143
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12144
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12145
+ heating_set_point_celsius?: (number | undefined) | undefined;
12146
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12147
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12148
+ manual_override_allowed?: boolean | undefined;
12149
+ } | undefined) | undefined;
12150
+ min_heating_set_point_celsius?: number | undefined;
12151
+ min_heating_set_point_fahrenheit?: number | undefined;
12152
+ max_heating_set_point_celsius?: number | undefined;
12153
+ max_heating_set_point_fahrenheit?: number | undefined;
12154
+ } | {
12155
+ temperature_fahrenheit?: number | undefined;
12156
+ temperature_celsius?: number | undefined;
12157
+ relative_humidity?: number | undefined;
12158
+ can_enable_automatic_heating?: boolean | undefined;
12159
+ can_enable_automatic_cooling?: boolean | undefined;
12160
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
12161
+ is_heating_available?: false | undefined;
12162
+ is_cooling_available?: true | undefined;
12163
+ is_heating?: boolean | undefined;
12164
+ is_cooling?: boolean | undefined;
12165
+ is_fan_running?: boolean | undefined;
12166
+ fan_mode_setting?: ('auto' | 'on') | undefined;
12167
+ is_temporary_manual_override_active?: boolean | undefined;
12168
+ current_climate_setting?: {
12169
+ automatic_heating_enabled: boolean;
12170
+ automatic_cooling_enabled: boolean;
12171
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12172
+ cooling_set_point_celsius?: number | undefined;
12173
+ heating_set_point_celsius?: number | undefined;
12174
+ cooling_set_point_fahrenheit?: number | undefined;
12175
+ heating_set_point_fahrenheit?: number | undefined;
12176
+ manual_override_allowed: boolean;
12177
+ } | undefined;
12178
+ default_climate_setting?: ({
12179
+ automatic_heating_enabled: boolean;
12180
+ automatic_cooling_enabled: boolean;
12181
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
12182
+ cooling_set_point_celsius?: number | undefined;
12183
+ heating_set_point_celsius?: number | undefined;
12184
+ cooling_set_point_fahrenheit?: number | undefined;
12185
+ heating_set_point_fahrenheit?: number | undefined;
12186
+ manual_override_allowed: boolean;
12187
+ } | undefined) | undefined;
12188
+ is_climate_setting_schedule_active?: boolean | undefined;
12189
+ active_climate_setting_schedule?: ({
12190
+ climate_setting_schedule_id: string;
12191
+ schedule_type: 'time_bound';
12192
+ device_id: string;
12193
+ name?: string | undefined;
12194
+ schedule_starts_at: string;
12195
+ schedule_ends_at: string;
12196
+ created_at: string;
12197
+ automatic_heating_enabled?: boolean | undefined;
12198
+ automatic_cooling_enabled?: boolean | undefined;
12199
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12200
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12201
+ heating_set_point_celsius?: (number | undefined) | undefined;
12202
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12203
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12204
+ manual_override_allowed?: boolean | undefined;
12205
+ } | undefined) | undefined;
12206
+ min_cooling_set_point_celsius?: number | undefined;
12207
+ min_cooling_set_point_fahrenheit?: number | undefined;
12208
+ max_cooling_set_point_celsius?: number | undefined;
12209
+ max_cooling_set_point_fahrenheit?: number | undefined;
12210
+ }));
12211
+ location: {
12212
+ location_name?: string | undefined;
12213
+ timezone?: string | undefined;
12214
+ } | null;
12215
+ connected_account_id: string;
12216
+ workspace_id: string;
12217
+ errors: Array<{
12218
+ error_code: string;
12219
+ message: string;
12220
+ }>;
12221
+ warnings: Array<{
12222
+ warning_code: string;
12223
+ message: string;
12224
+ }>;
12225
+ created_at: string;
12226
+ is_managed: true;
12227
+ }>;
12228
+ };
12229
+ };
12230
+ '/devices/list_device_providers': {
12231
+ route: '/devices/list_device_providers';
12232
+ method: 'GET' | 'POST';
12233
+ queryParams: {};
12234
+ jsonBody: {};
12235
+ commonParams: {
12236
+ provider_category?: ('stable' | 'consumer_smartlocks') | undefined;
12237
+ };
12238
+ formData: {};
12239
+ jsonResponse: {
12240
+ device_providers: Array<{
12241
+ device_provider_name: string;
12242
+ display_name: string;
12243
+ image_url: string;
12244
+ provider_categories: Array<'stable' | 'consumer_smartlocks'>;
12245
+ }>;
12246
+ };
12247
+ };
12248
+ '/devices/unmanaged/get': {
12249
+ route: '/devices/unmanaged/get';
12250
+ method: 'GET' | 'POST';
12251
+ queryParams: {};
12252
+ jsonBody: {};
12253
+ commonParams: {
12254
+ device_id?: string | undefined;
12255
+ name?: string | undefined;
12256
+ };
12257
+ formData: {};
12258
+ jsonResponse: {
12259
+ device: {
12260
+ device_id: string;
12261
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
12262
+ connected_account_id: string;
12263
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
12264
+ workspace_id: string;
12265
+ errors: Array<{
12266
+ error_code: string;
12267
+ message: string;
12268
+ }>;
12269
+ warnings: Array<{
12270
+ warning_code: string;
12271
+ message: string;
12272
+ }>;
12273
+ created_at: string;
12274
+ is_managed: false;
12275
+ properties: {
12276
+ name: string;
12277
+ online: boolean;
12278
+ manufacturer?: string | undefined;
12279
+ image_url?: string | undefined;
12280
+ image_alt_text?: string | undefined;
12281
+ model: {
12282
+ display_name: string;
12283
+ manufacturer_display_name: string;
12284
+ };
12285
+ };
12286
+ };
12287
+ };
12288
+ };
12289
+ '/devices/unmanaged/list': {
12290
+ route: '/devices/unmanaged/list';
12291
+ method: 'GET' | 'POST';
12292
+ queryParams: {};
12293
+ jsonBody: {};
12294
+ commonParams: {
12295
+ connected_account_id?: string | undefined;
12296
+ connected_account_ids?: string[] | undefined;
12297
+ connect_webview_id?: string | undefined;
12298
+ device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')) | undefined;
12299
+ device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')> | undefined;
12300
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode') | undefined;
12301
+ device_ids?: string[] | undefined;
12302
+ limit?: number;
12303
+ created_before?: string | undefined;
12304
+ };
12305
+ formData: {};
12306
+ jsonResponse: {
12307
+ devices: Array<{
12308
+ device_id: string;
12309
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
12310
+ connected_account_id: string;
12311
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
12312
+ workspace_id: string;
12313
+ errors: Array<{
12314
+ error_code: string;
12315
+ message: string;
12316
+ }>;
12317
+ warnings: Array<{
12318
+ warning_code: string;
12319
+ message: string;
12320
+ }>;
12321
+ created_at: string;
12322
+ is_managed: false;
12323
+ properties: {
12324
+ name: string;
12325
+ online: boolean;
12326
+ manufacturer?: string | undefined;
12327
+ image_url?: string | undefined;
12328
+ image_alt_text?: string | undefined;
12329
+ model: {
12330
+ display_name: string;
12331
+ manufacturer_display_name: string;
12332
+ };
12333
+ };
12334
+ }>;
12335
+ };
12336
+ };
12337
+ '/devices/unmanaged/update': {
12338
+ route: '/devices/unmanaged/update';
12339
+ method: 'POST' | 'PATCH';
12340
+ queryParams: {};
12341
+ jsonBody: {};
12342
+ commonParams: {
12343
+ device_id: string;
12344
+ is_managed: true;
12345
+ };
12346
+ formData: {};
12347
+ jsonResponse: {};
12348
+ };
12349
+ '/devices/update': {
12350
+ route: '/devices/update';
12351
+ method: 'POST' | 'PATCH';
12352
+ queryParams: {};
12353
+ jsonBody: {};
12354
+ commonParams: {
12355
+ device_id: string;
12356
+ properties?: {
12357
+ name?: (string | null) | undefined;
12358
+ } | undefined;
12359
+ name?: (string | null) | undefined;
12360
+ location?: {} | undefined;
12361
+ is_managed?: boolean;
12362
+ };
12363
+ formData: {};
12364
+ jsonResponse: {};
12365
+ };
12366
+ '/events/get': {
12367
+ route: '/events/get';
12368
+ method: 'GET' | 'POST';
12369
+ queryParams: {};
12370
+ jsonBody: {};
12371
+ commonParams: {
12372
+ event_id?: string | undefined;
12373
+ event_type?: string | undefined;
12374
+ device_id?: string | undefined;
12375
+ };
12376
+ formData: {};
12377
+ jsonResponse: {
12378
+ event?: {
12379
+ event_id: string;
12380
+ device_id?: string | undefined;
12381
+ event_type: string;
12382
+ workspace_id: string;
12383
+ created_at: string;
12384
+ occurred_at: string;
12385
+ } | undefined;
12386
+ message?: string | undefined;
12387
+ };
12388
+ };
12389
+ '/events/list': {
12390
+ route: '/events/list';
12391
+ method: 'GET' | 'POST';
12392
+ queryParams: {};
12393
+ jsonBody: {};
12394
+ commonParams: {
12395
+ since?: string | undefined;
12396
+ between?: Array<string | Date> | undefined;
12397
+ device_id?: string | undefined;
12398
+ device_ids?: string[] | undefined;
12399
+ access_code_id?: string | undefined;
12400
+ access_code_ids?: string[] | undefined;
12401
+ event_type?: ('device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled') | undefined;
12402
+ event_types?: Array<'device.connected' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.removed' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'access_code.created' | 'access_code.changed' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.deleted' | 'access_code.removed_from_device' | 'access_code.failed_to_set_on_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_remove_from_device' | 'access_code.delay_in_removing_from_device' | 'access_code.modified_external_to_seam' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'lock.locked' | 'lock.unlocked' | 'connected_account.connected' | 'connected_account.successful_login' | 'connected_account.created' | 'connected_account.deleted' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'noise_sensor.noise_threshold_triggered' | 'access_code.backup_access_code_pulled'> | undefined;
12403
+ connected_account_id?: string | undefined;
12404
+ };
12405
+ formData: {};
12406
+ jsonResponse: {
12407
+ events?: Array<{
12408
+ event_id: string;
12409
+ device_id?: string | undefined;
12410
+ event_type: string;
12411
+ workspace_id: string;
12412
+ created_at: string;
12413
+ occurred_at: string;
12414
+ }> | undefined;
12415
+ message?: string | undefined;
12416
+ };
12417
+ };
12418
+ '/health': {
12419
+ route: '/health';
12420
+ method: 'GET';
12421
+ queryParams: {};
12422
+ jsonBody: {};
12423
+ commonParams: {};
12424
+ formData: {};
12425
+ jsonResponse: {
12426
+ ok: boolean;
12427
+ msg: 'I\u2019m one with the Force. The Force is with me.';
12428
+ last_service_evaluation_at?: string | undefined;
12429
+ service_health_statuses: Array<{
12430
+ service: string;
12431
+ status: 'healthy' | 'degraded' | 'down';
12432
+ description: string;
12433
+ }>;
12434
+ };
12435
+ };
12436
+ '/health/get_health': {
12437
+ route: '/health/get_health';
12438
+ method: 'GET';
12439
+ queryParams: {};
12440
+ jsonBody: {};
12441
+ commonParams: {};
12442
+ formData: {};
12443
+ jsonResponse: {
12444
+ ok: boolean;
12445
+ msg: 'I\u2019m one with the Force. The Force is with me.';
12446
+ last_service_evaluation_at?: string | undefined;
12447
+ service_health_statuses: Array<{
12448
+ service: string;
12449
+ status: 'healthy' | 'degraded' | 'down';
12450
+ description: string;
12451
+ }>;
12452
+ };
12453
+ };
12454
+ '/health/get_service_health': {
12455
+ route: '/health/get_service_health';
12456
+ method: 'GET' | 'POST';
12457
+ queryParams: {};
12458
+ jsonBody: {};
12459
+ commonParams: {
12460
+ service: string;
12461
+ };
12462
+ formData: {};
12463
+ jsonResponse: {
12464
+ ok: true;
12465
+ last_service_evaluation_at: string;
12466
+ service_health: {
12467
+ service: string;
12468
+ status: 'healthy' | 'degraded' | 'down';
12469
+ description: string;
12470
+ };
12471
+ };
12472
+ };
12473
+ '/health/service/[service_name]': {
12474
+ route: '/health/service/[service_name]';
12475
+ method: 'GET' | 'POST';
12476
+ queryParams: {};
12477
+ jsonBody: {};
12478
+ commonParams: {
12479
+ service_name: string;
12480
+ };
12481
+ formData: {};
12482
+ jsonResponse: {
12483
+ ok: true;
12484
+ last_service_evaluation_at: string;
12485
+ service_health: {
12486
+ service: string;
12487
+ status: 'healthy' | 'degraded' | 'down';
12488
+ description: string;
12489
+ };
12490
+ };
12491
+ };
12492
+ '/locks/get': {
12493
+ route: '/locks/get';
12494
+ method: 'GET' | 'POST';
12495
+ queryParams: {};
12496
+ jsonBody: {};
12497
+ commonParams: {
12498
+ device_id?: string | undefined;
12499
+ name?: string | undefined;
12500
+ };
12501
+ formData: {};
12502
+ jsonResponse: {
12503
+ lock?: any;
12504
+ device?: any;
12505
+ };
12506
+ };
12507
+ '/locks/list': {
12508
+ route: '/locks/list';
12509
+ method: 'GET' | 'POST';
12510
+ queryParams: {};
12511
+ jsonBody: {};
12512
+ commonParams: {
12513
+ connected_account_id?: string | undefined;
12514
+ connected_account_ids?: string[] | undefined;
12515
+ connect_webview_id?: string | undefined;
12516
+ device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')) | undefined;
12517
+ device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')> | undefined;
12518
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode') | undefined;
12519
+ device_ids?: string[] | undefined;
12520
+ limit?: number;
12521
+ created_before?: string | undefined;
12522
+ };
12523
+ formData: {};
12524
+ jsonResponse: {
12525
+ locks?: any;
12526
+ devices?: any;
12527
+ };
12528
+ };
12529
+ '/locks/lock_door': {
12530
+ route: '/locks/lock_door';
12531
+ method: 'POST';
12532
+ queryParams: {};
12533
+ jsonBody: {
12534
+ device_id: string;
12535
+ sync?: boolean;
12536
+ };
12537
+ commonParams: {};
12538
+ formData: {};
12539
+ jsonResponse: {
12540
+ action_attempt: {
12541
+ status: 'success';
12542
+ action_type: string;
12543
+ action_attempt_id: string;
12544
+ result?: any;
12545
+ error: null;
12546
+ } | {
12547
+ status: 'pending';
12548
+ action_type: string;
12549
+ action_attempt_id: string;
12550
+ result: null;
12551
+ error: null;
12552
+ } | {
12553
+ status: 'error';
12554
+ action_type: string;
12555
+ action_attempt_id: string;
12556
+ result: null;
12557
+ error: {
12558
+ type: string;
12559
+ message: string;
12560
+ };
12561
+ };
12562
+ };
12563
+ };
12564
+ '/locks/unlock_door': {
12565
+ route: '/locks/unlock_door';
12566
+ method: 'POST';
12567
+ queryParams: {};
12568
+ jsonBody: {
12569
+ device_id: string;
12570
+ sync?: boolean;
12571
+ };
12572
+ commonParams: {};
12573
+ formData: {};
12574
+ jsonResponse: {
12575
+ action_attempt: {
12576
+ status: 'success';
12577
+ action_type: string;
12578
+ action_attempt_id: string;
12579
+ result?: any;
12580
+ error: null;
12581
+ } | {
12582
+ status: 'pending';
12583
+ action_type: string;
12584
+ action_attempt_id: string;
12585
+ result: null;
12586
+ error: null;
12587
+ } | {
12588
+ status: 'error';
12589
+ action_type: string;
12590
+ action_attempt_id: string;
12591
+ result: null;
12592
+ error: {
12593
+ type: string;
12594
+ message: string;
12595
+ };
12596
+ };
12597
+ };
12598
+ };
12599
+ '/noise_sensors/noise_thresholds/create': {
12600
+ route: '/noise_sensors/noise_thresholds/create';
12601
+ method: 'POST';
12602
+ queryParams: {};
12603
+ jsonBody: {
12604
+ device_id: string;
12605
+ sync?: boolean;
12606
+ name?: string | undefined;
12607
+ starts_daily_at: string;
12608
+ ends_daily_at: string;
12609
+ noise_threshold_decibels?: number | undefined;
12610
+ noise_threshold_nrs?: number | undefined;
12611
+ };
12612
+ commonParams: {};
12613
+ formData: {};
12614
+ jsonResponse: {
12615
+ action_attempt: {
12616
+ status: 'success';
12617
+ action_type: string;
12618
+ action_attempt_id: string;
12619
+ result?: any;
12620
+ error: null;
12621
+ } | {
12622
+ status: 'pending';
12623
+ action_type: string;
12624
+ action_attempt_id: string;
12625
+ result: null;
12626
+ error: null;
12627
+ } | {
12628
+ status: 'error';
12629
+ action_type: string;
12630
+ action_attempt_id: string;
12631
+ result: null;
12632
+ error: {
12633
+ type: string;
12634
+ message: string;
12635
+ };
12636
+ };
12637
+ };
12638
+ };
12639
+ '/noise_sensors/noise_thresholds/delete': {
12640
+ route: '/noise_sensors/noise_thresholds/delete';
12641
+ method: 'DELETE' | 'POST';
12642
+ queryParams: {};
12643
+ jsonBody: {
12644
+ noise_threshold_id: string;
12645
+ device_id: string;
12646
+ sync?: boolean;
12647
+ };
12648
+ commonParams: {};
12649
+ formData: {};
12650
+ jsonResponse: {
12651
+ action_attempt: {
12652
+ status: 'success';
12653
+ action_type: string;
12654
+ action_attempt_id: string;
12655
+ result?: any;
12656
+ error: null;
12657
+ } | {
12658
+ status: 'pending';
12659
+ action_type: string;
12660
+ action_attempt_id: string;
12661
+ result: null;
12662
+ error: null;
12663
+ } | {
12664
+ status: 'error';
12665
+ action_type: string;
12666
+ action_attempt_id: string;
12667
+ result: null;
12668
+ error: {
12669
+ type: string;
12670
+ message: string;
12671
+ };
12672
+ };
12673
+ };
12674
+ };
12675
+ '/noise_sensors/noise_thresholds/get': {
12676
+ route: '/noise_sensors/noise_thresholds/get';
12677
+ method: 'GET' | 'POST';
12678
+ queryParams: {};
12679
+ jsonBody: {};
12680
+ commonParams: {
12681
+ noise_threshold_id: string;
12682
+ };
12683
+ formData: {};
12684
+ jsonResponse: {
12685
+ noise_threshold: {
12686
+ noise_threshold_id: string;
12687
+ device_id: string;
12688
+ name: string;
12689
+ noise_threshold_nrs?: number | undefined;
12690
+ starts_daily_at: string;
12691
+ ends_daily_at: string;
12692
+ noise_threshold_decibels: number;
12693
+ };
12694
+ };
12695
+ };
12696
+ '/noise_sensors/noise_thresholds/list': {
12697
+ route: '/noise_sensors/noise_thresholds/list';
12698
+ method: 'GET' | 'POST';
12699
+ queryParams: {};
12700
+ jsonBody: {};
12701
+ commonParams: {
12702
+ device_id: string;
12703
+ };
12704
+ formData: {};
12705
+ jsonResponse: {
12706
+ noise_thresholds: Array<{
12707
+ noise_threshold_id: string;
12708
+ device_id: string;
12709
+ name: string;
12710
+ noise_threshold_nrs?: number | undefined;
12711
+ starts_daily_at: string;
12712
+ ends_daily_at: string;
12713
+ noise_threshold_decibels: number;
12714
+ }>;
12715
+ };
12716
+ };
12717
+ '/noise_sensors/noise_thresholds/update': {
12718
+ route: '/noise_sensors/noise_thresholds/update';
12719
+ method: 'PUT' | 'POST';
12720
+ queryParams: {};
12721
+ jsonBody: {
12722
+ noise_threshold_id: string;
12723
+ device_id: string;
12724
+ sync?: boolean;
12725
+ name?: string | undefined;
12726
+ starts_daily_at?: string | undefined;
12727
+ ends_daily_at?: string | undefined;
12728
+ noise_threshold_decibels?: number | undefined;
12729
+ noise_threshold_nrs?: number | undefined;
12730
+ };
12731
+ commonParams: {};
12732
+ formData: {};
12733
+ jsonResponse: {
12734
+ action_attempt: {
12735
+ status: 'success';
12736
+ action_type: string;
12737
+ action_attempt_id: string;
12738
+ result?: any;
12739
+ error: null;
12740
+ } | {
12741
+ status: 'pending';
12742
+ action_type: string;
12743
+ action_attempt_id: string;
12744
+ result: null;
12745
+ error: null;
12746
+ } | {
12747
+ status: 'error';
12748
+ action_type: string;
12749
+ action_attempt_id: string;
12750
+ result: null;
12751
+ error: {
12752
+ type: string;
12753
+ message: string;
12754
+ };
12755
+ };
12756
+ };
12757
+ };
12758
+ '/noise_sensors/simulate/trigger_noise_threshold': {
12759
+ route: '/noise_sensors/simulate/trigger_noise_threshold';
12760
+ method: 'POST';
12761
+ queryParams: {};
12762
+ jsonBody: {
12763
+ device_id: string;
12764
+ };
12765
+ commonParams: {};
12766
+ formData: {};
12767
+ jsonResponse: {};
12768
+ };
12769
+ '/thermostats/climate_setting_schedules/create': {
12770
+ route: '/thermostats/climate_setting_schedules/create';
12771
+ method: 'POST';
12772
+ queryParams: {};
12773
+ jsonBody: {
12774
+ schedule_type?: 'time_bound';
12775
+ device_id: string;
12776
+ name?: string | undefined;
12777
+ schedule_starts_at: string;
12778
+ schedule_ends_at: string;
12779
+ automatic_heating_enabled?: boolean | undefined;
12780
+ automatic_cooling_enabled?: boolean | undefined;
12781
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12782
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12783
+ heating_set_point_celsius?: (number | undefined) | undefined;
12784
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12785
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12786
+ manual_override_allowed?: boolean | undefined;
12787
+ };
12788
+ commonParams: {};
12789
+ formData: {};
12790
+ jsonResponse: {
12791
+ climate_setting_schedule: {
12792
+ climate_setting_schedule_id: string;
12793
+ schedule_type: 'time_bound';
12794
+ device_id: string;
12795
+ name?: string | undefined;
12796
+ schedule_starts_at: string;
12797
+ schedule_ends_at: string;
12798
+ created_at: string;
12799
+ automatic_heating_enabled?: boolean | undefined;
12800
+ automatic_cooling_enabled?: boolean | undefined;
12801
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12802
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12803
+ heating_set_point_celsius?: (number | undefined) | undefined;
12804
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12805
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12806
+ manual_override_allowed?: boolean | undefined;
12807
+ };
12808
+ };
12809
+ };
12810
+ '/thermostats/climate_setting_schedules/delete': {
12811
+ route: '/thermostats/climate_setting_schedules/delete';
12812
+ method: 'PUT' | 'POST' | 'DELETE';
12813
+ queryParams: {};
12814
+ jsonBody: {};
12815
+ commonParams: {
12816
+ climate_setting_schedule_id: string;
12817
+ };
12818
+ formData: {};
12819
+ jsonResponse: {};
12820
+ };
12821
+ '/thermostats/climate_setting_schedules/get': {
12822
+ route: '/thermostats/climate_setting_schedules/get';
12823
+ method: 'GET' | 'POST';
12824
+ queryParams: {};
12825
+ jsonBody: {};
12826
+ commonParams: {
12827
+ climate_setting_schedule_id?: string | undefined;
12828
+ device_id?: string | undefined;
12829
+ };
12830
+ formData: {};
12831
+ jsonResponse: {
12832
+ climate_setting_schedule: {
12833
+ climate_setting_schedule_id: string;
12834
+ schedule_type: 'time_bound';
12835
+ device_id: string;
12836
+ name?: string | undefined;
12837
+ schedule_starts_at: string;
12838
+ schedule_ends_at: string;
12839
+ created_at: string;
12840
+ automatic_heating_enabled?: boolean | undefined;
12841
+ automatic_cooling_enabled?: boolean | undefined;
12842
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12843
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12844
+ heating_set_point_celsius?: (number | undefined) | undefined;
12845
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12846
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12847
+ manual_override_allowed?: boolean | undefined;
12848
+ };
12849
+ };
12850
+ };
12851
+ '/thermostats/climate_setting_schedules/list': {
12852
+ route: '/thermostats/climate_setting_schedules/list';
12853
+ method: 'GET' | 'POST';
12854
+ queryParams: {};
12855
+ jsonBody: {};
12856
+ commonParams: {
12857
+ device_id: string;
12858
+ };
12859
+ formData: {};
12860
+ jsonResponse: {
12861
+ climate_setting_schedules: Array<{
12862
+ climate_setting_schedule_id: string;
12863
+ schedule_type: 'time_bound';
12864
+ device_id: string;
12865
+ name?: string | undefined;
12866
+ schedule_starts_at: string;
12867
+ schedule_ends_at: string;
12868
+ created_at: string;
12869
+ automatic_heating_enabled?: boolean | undefined;
12870
+ automatic_cooling_enabled?: boolean | undefined;
12871
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12872
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12873
+ heating_set_point_celsius?: (number | undefined) | undefined;
12874
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12875
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12876
+ manual_override_allowed?: boolean | undefined;
12877
+ }>;
12878
+ };
12879
+ };
12880
+ '/thermostats/climate_setting_schedules/update': {
12881
+ route: '/thermostats/climate_setting_schedules/update';
12882
+ method: 'PUT' | 'POST';
12883
+ queryParams: {};
12884
+ jsonBody: {
12885
+ climate_setting_schedule_id: string;
12886
+ schedule_type?: 'time_bound';
12887
+ name?: string | undefined;
12888
+ schedule_starts_at?: string | undefined;
12889
+ schedule_ends_at?: string | undefined;
12890
+ automatic_heating_enabled?: boolean | undefined;
12891
+ automatic_cooling_enabled?: boolean | undefined;
12892
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12893
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12894
+ heating_set_point_celsius?: (number | undefined) | undefined;
12895
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12896
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12897
+ manual_override_allowed?: boolean | undefined;
12898
+ };
12899
+ commonParams: {};
12900
+ formData: {};
12901
+ jsonResponse: {
12902
+ climate_setting_schedule: {
12903
+ climate_setting_schedule_id: string;
12904
+ schedule_type: 'time_bound';
12905
+ device_id: string;
12906
+ name?: string | undefined;
12907
+ schedule_starts_at: string;
12908
+ schedule_ends_at: string;
12909
+ created_at: string;
12910
+ automatic_heating_enabled?: boolean | undefined;
12911
+ automatic_cooling_enabled?: boolean | undefined;
12912
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
12913
+ cooling_set_point_celsius?: (number | undefined) | undefined;
12914
+ heating_set_point_celsius?: (number | undefined) | undefined;
12915
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
12916
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
12917
+ manual_override_allowed?: boolean | undefined;
12918
+ };
12919
+ };
12920
+ };
12921
+ '/thermostats/cool': {
12922
+ route: '/thermostats/cool';
12923
+ method: 'POST';
12924
+ queryParams: {};
12925
+ jsonBody: {
12926
+ device_id: string;
12927
+ cooling_set_point_celsius?: number | undefined;
12928
+ cooling_set_point_fahrenheit?: number | undefined;
12929
+ sync?: boolean;
12930
+ };
12931
+ commonParams: {};
12932
+ formData: {};
12933
+ jsonResponse: {};
12934
+ };
12935
+ '/thermostats/get': {
12936
+ route: '/thermostats/get';
12937
+ method: 'GET' | 'POST';
12938
+ queryParams: {};
12939
+ jsonBody: {};
12940
+ commonParams: {
12941
+ device_id?: string | undefined;
12942
+ name?: string | undefined;
12943
+ };
12944
+ formData: {};
12945
+ jsonResponse: {
12946
+ thermostat: {
12947
+ device_id: string;
12948
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
12949
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
12950
+ properties: ({
12951
+ online: boolean;
12952
+ name: string;
12953
+ model: {
12954
+ display_name: string;
12955
+ manufacturer_display_name: string;
12956
+ };
12957
+ has_direct_power?: boolean | undefined;
12958
+ battery_level?: number | undefined;
12959
+ battery?: {
12960
+ level: number;
12961
+ status: 'critical' | 'low' | 'good' | 'full';
12962
+ } | undefined;
12963
+ manufacturer?: string | undefined;
12964
+ image_url?: string | undefined;
12965
+ image_alt_text?: string | undefined;
12966
+ serial_number?: string | undefined;
12967
+ } & {
12968
+ august_metadata?: {
12969
+ lock_id: string;
12970
+ lock_name: string;
12971
+ house_name: string;
12972
+ has_keypad: boolean;
12973
+ keypad_battery_level?: string | undefined;
12974
+ model?: string | undefined;
12975
+ house_id?: string | undefined;
12976
+ } | undefined;
12977
+ avigilon_alta_metadata?: {
12978
+ entry_name: string;
12979
+ org_name: string;
12980
+ zone_id: number;
12981
+ zone_name: string;
12982
+ site_id: number;
12983
+ site_name: string;
12984
+ } | undefined;
12985
+ schlage_metadata?: {
12986
+ device_id: string;
12987
+ device_name: string;
12988
+ access_code_length: number;
12989
+ model?: string | undefined;
12990
+ } | undefined;
12991
+ smartthings_metadata?: {
12992
+ device_id: string;
12993
+ device_name: string;
12994
+ model?: string | undefined;
12995
+ location_id?: string | undefined;
12996
+ } | undefined;
12997
+ lockly_metadata?: {
12998
+ device_id: string;
12999
+ device_name: string;
13000
+ model?: string | undefined;
13001
+ } | undefined;
13002
+ nuki_metadata?: {
13003
+ device_id: string;
13004
+ device_name: string;
13005
+ keypad_battery_critical?: boolean | undefined;
13006
+ } | undefined;
13007
+ kwikset_metadata?: {
13008
+ device_id: string;
13009
+ device_name: string;
13010
+ model_number: string;
13011
+ } | undefined;
13012
+ salto_metadata?: {
13013
+ lock_id: string;
13014
+ customer_reference: string;
13015
+ lock_type: string;
13016
+ battery_level: string;
13017
+ locked_state: string;
13018
+ model?: string | undefined;
13019
+ } | undefined;
13020
+ genie_metadata?: {
13021
+ device_name: string;
13022
+ door_name: string;
13023
+ } | undefined;
13024
+ brivo_metadata?: {
13025
+ device_name: string;
13026
+ } | undefined;
13027
+ igloo_metadata?: {
13028
+ device_id: string;
13029
+ bridge_id: string;
13030
+ model?: string | undefined;
13031
+ } | undefined;
13032
+ noiseaware_metadata?: {
13033
+ device_model: 'indoor' | 'outdoor';
13034
+ noise_level_nrs: number;
13035
+ noise_level_decibel: number;
13036
+ device_name: string;
13037
+ device_id: string;
13038
+ } | undefined;
13039
+ minut_metadata?: {
13040
+ device_id: string;
13041
+ device_name: string;
13042
+ latest_sensor_values: {
13043
+ temperature: {
13044
+ time: string;
13045
+ value: number;
13046
+ };
13047
+ sound: {
13048
+ time: string;
13049
+ value: number;
13050
+ };
13051
+ humidity: {
13052
+ time: string;
13053
+ value: number;
13054
+ };
13055
+ pressure: {
13056
+ time: string;
13057
+ value: number;
13058
+ };
13059
+ accelerometer_z: {
13060
+ time: string;
13061
+ value: number;
13062
+ };
13063
+ };
13064
+ } | undefined;
13065
+ four_suites_metadata?: {
13066
+ device_id: number;
13067
+ device_name: string;
13068
+ reclose_delay_in_seconds: number;
13069
+ } | undefined;
13070
+ two_n_metadata?: {
13071
+ device_id: number;
13072
+ device_name: string;
13073
+ } | undefined;
13074
+ controlbyweb_metadata?: {
13075
+ device_id: string;
13076
+ device_name: string;
13077
+ relay_name: string | null;
13078
+ } | undefined;
13079
+ ttlock_metadata?: {
13080
+ lock_id: number;
13081
+ lock_alias: string;
13082
+ } | undefined;
13083
+ seam_bridge_metadata?: {
13084
+ unlock_method?: ('bridge' | 'doorking') | undefined;
13085
+ device_num: number;
13086
+ name: string;
13087
+ } | undefined;
13088
+ igloohome_metadata?: {
13089
+ device_id: string;
13090
+ bridge_id: string;
13091
+ device_name: string;
13092
+ bridge_name: string;
13093
+ } | undefined;
13094
+ nest_metadata?: {
13095
+ nest_device_id: string;
13096
+ device_name: string;
13097
+ custom_name: string;
13098
+ } | undefined;
13099
+ ecobee_metadata?: {
13100
+ ecobee_device_id: string;
13101
+ device_name: string;
13102
+ } | undefined;
13103
+ hubitat_metadata?: {
13104
+ device_id: string;
13105
+ device_name: string;
13106
+ device_label: string;
13107
+ } | undefined;
13108
+ dormakaba_oracode_metadata?: {
13109
+ door_id: number;
13110
+ door_name: string;
13111
+ device_id?: number | undefined;
13112
+ site_id: number;
13113
+ site_name: string;
13114
+ } | undefined;
13115
+ wyze_metadata?: {
13116
+ device_id: string;
13117
+ device_name: string;
13118
+ product_type: string;
13119
+ product_model: string;
13120
+ device_info_model: string;
13121
+ } | undefined;
13122
+ }) & ({
13123
+ code_constraints?: (Array<{
13124
+ constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future';
13125
+ } | {
13126
+ constraint_type: 'name_length';
13127
+ min_length?: number | undefined;
13128
+ max_length?: number | undefined;
13129
+ }> | undefined) | undefined;
13130
+ supported_code_lengths?: (number[] | undefined) | undefined;
13131
+ max_active_codes_supported?: (number | undefined) | undefined;
13132
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined;
13133
+ has_native_entry_events?: (boolean | undefined) | undefined;
13134
+ locked?: (boolean | undefined) | undefined;
13135
+ keypad_battery?: ({
13136
+ level: number;
13137
+ } | undefined) | undefined;
13138
+ door_open?: (boolean | undefined) | undefined;
13139
+ } & ({
13140
+ temperature_fahrenheit?: number | undefined;
13141
+ temperature_celsius?: number | undefined;
13142
+ relative_humidity?: number | undefined;
13143
+ can_enable_automatic_heating?: boolean | undefined;
13144
+ can_enable_automatic_cooling?: boolean | undefined;
13145
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
13146
+ is_heating_available?: true | undefined;
13147
+ is_cooling_available?: true | undefined;
13148
+ is_heating?: boolean | undefined;
13149
+ is_cooling?: boolean | undefined;
13150
+ is_fan_running?: boolean | undefined;
13151
+ fan_mode_setting?: ('auto' | 'on') | undefined;
13152
+ is_temporary_manual_override_active?: boolean | undefined;
13153
+ current_climate_setting?: {
13154
+ automatic_heating_enabled: boolean;
13155
+ automatic_cooling_enabled: boolean;
13156
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13157
+ cooling_set_point_celsius?: number | undefined;
13158
+ heating_set_point_celsius?: number | undefined;
13159
+ cooling_set_point_fahrenheit?: number | undefined;
13160
+ heating_set_point_fahrenheit?: number | undefined;
13161
+ manual_override_allowed: boolean;
13162
+ } | undefined;
13163
+ default_climate_setting?: ({
13164
+ automatic_heating_enabled: boolean;
13165
+ automatic_cooling_enabled: boolean;
13166
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13167
+ cooling_set_point_celsius?: number | undefined;
13168
+ heating_set_point_celsius?: number | undefined;
13169
+ cooling_set_point_fahrenheit?: number | undefined;
13170
+ heating_set_point_fahrenheit?: number | undefined;
13171
+ manual_override_allowed: boolean;
13172
+ } | undefined) | undefined;
13173
+ is_climate_setting_schedule_active?: boolean | undefined;
13174
+ active_climate_setting_schedule?: ({
13175
+ climate_setting_schedule_id: string;
13176
+ schedule_type: 'time_bound';
13177
+ device_id: string;
13178
+ name?: string | undefined;
13179
+ schedule_starts_at: string;
13180
+ schedule_ends_at: string;
13181
+ created_at: string;
13182
+ automatic_heating_enabled?: boolean | undefined;
13183
+ automatic_cooling_enabled?: boolean | undefined;
13184
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13185
+ cooling_set_point_celsius?: (number | undefined) | undefined;
13186
+ heating_set_point_celsius?: (number | undefined) | undefined;
13187
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13188
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
13189
+ manual_override_allowed?: boolean | undefined;
13190
+ } | undefined) | undefined;
13191
+ min_cooling_set_point_celsius?: number | undefined;
13192
+ min_cooling_set_point_fahrenheit?: number | undefined;
13193
+ max_cooling_set_point_celsius?: number | undefined;
13194
+ max_cooling_set_point_fahrenheit?: number | undefined;
13195
+ min_heating_set_point_celsius?: number | undefined;
13196
+ min_heating_set_point_fahrenheit?: number | undefined;
13197
+ max_heating_set_point_celsius?: number | undefined;
13198
+ max_heating_set_point_fahrenheit?: number | undefined;
13199
+ min_heating_cooling_delta_celsius?: number | undefined;
13200
+ min_heating_cooling_delta_fahrenheit?: number | undefined;
13201
+ } | {
13202
+ temperature_fahrenheit?: number | undefined;
13203
+ temperature_celsius?: number | undefined;
13204
+ relative_humidity?: number | undefined;
13205
+ can_enable_automatic_heating?: boolean | undefined;
13206
+ can_enable_automatic_cooling?: boolean | undefined;
13207
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
13208
+ is_heating_available?: true | undefined;
13209
+ is_cooling_available?: false | undefined;
13210
+ is_heating?: boolean | undefined;
13211
+ is_cooling?: boolean | undefined;
13212
+ is_fan_running?: boolean | undefined;
13213
+ fan_mode_setting?: ('auto' | 'on') | undefined;
13214
+ is_temporary_manual_override_active?: boolean | undefined;
13215
+ current_climate_setting?: {
13216
+ automatic_heating_enabled: boolean;
13217
+ automatic_cooling_enabled: boolean;
13218
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13219
+ cooling_set_point_celsius?: number | undefined;
13220
+ heating_set_point_celsius?: number | undefined;
13221
+ cooling_set_point_fahrenheit?: number | undefined;
13222
+ heating_set_point_fahrenheit?: number | undefined;
13223
+ manual_override_allowed: boolean;
13224
+ } | undefined;
13225
+ default_climate_setting?: ({
13226
+ automatic_heating_enabled: boolean;
13227
+ automatic_cooling_enabled: boolean;
13228
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13229
+ cooling_set_point_celsius?: number | undefined;
13230
+ heating_set_point_celsius?: number | undefined;
13231
+ cooling_set_point_fahrenheit?: number | undefined;
13232
+ heating_set_point_fahrenheit?: number | undefined;
13233
+ manual_override_allowed: boolean;
13234
+ } | undefined) | undefined;
13235
+ is_climate_setting_schedule_active?: boolean | undefined;
13236
+ active_climate_setting_schedule?: ({
13237
+ climate_setting_schedule_id: string;
13238
+ schedule_type: 'time_bound';
13239
+ device_id: string;
13240
+ name?: string | undefined;
13241
+ schedule_starts_at: string;
13242
+ schedule_ends_at: string;
13243
+ created_at: string;
13244
+ automatic_heating_enabled?: boolean | undefined;
13245
+ automatic_cooling_enabled?: boolean | undefined;
13246
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13247
+ cooling_set_point_celsius?: (number | undefined) | undefined;
13248
+ heating_set_point_celsius?: (number | undefined) | undefined;
13249
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13250
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
13251
+ manual_override_allowed?: boolean | undefined;
13252
+ } | undefined) | undefined;
13253
+ min_heating_set_point_celsius?: number | undefined;
13254
+ min_heating_set_point_fahrenheit?: number | undefined;
13255
+ max_heating_set_point_celsius?: number | undefined;
13256
+ max_heating_set_point_fahrenheit?: number | undefined;
13257
+ } | {
13258
+ temperature_fahrenheit?: number | undefined;
13259
+ temperature_celsius?: number | undefined;
13260
+ relative_humidity?: number | undefined;
13261
+ can_enable_automatic_heating?: boolean | undefined;
13262
+ can_enable_automatic_cooling?: boolean | undefined;
13263
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
13264
+ is_heating_available?: false | undefined;
13265
+ is_cooling_available?: true | undefined;
13266
+ is_heating?: boolean | undefined;
13267
+ is_cooling?: boolean | undefined;
13268
+ is_fan_running?: boolean | undefined;
13269
+ fan_mode_setting?: ('auto' | 'on') | undefined;
13270
+ is_temporary_manual_override_active?: boolean | undefined;
13271
+ current_climate_setting?: {
13272
+ automatic_heating_enabled: boolean;
13273
+ automatic_cooling_enabled: boolean;
13274
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13275
+ cooling_set_point_celsius?: number | undefined;
13276
+ heating_set_point_celsius?: number | undefined;
13277
+ cooling_set_point_fahrenheit?: number | undefined;
13278
+ heating_set_point_fahrenheit?: number | undefined;
13279
+ manual_override_allowed: boolean;
13280
+ } | undefined;
13281
+ default_climate_setting?: ({
13282
+ automatic_heating_enabled: boolean;
13283
+ automatic_cooling_enabled: boolean;
13284
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13285
+ cooling_set_point_celsius?: number | undefined;
13286
+ heating_set_point_celsius?: number | undefined;
13287
+ cooling_set_point_fahrenheit?: number | undefined;
13288
+ heating_set_point_fahrenheit?: number | undefined;
13289
+ manual_override_allowed: boolean;
13290
+ } | undefined) | undefined;
13291
+ is_climate_setting_schedule_active?: boolean | undefined;
13292
+ active_climate_setting_schedule?: ({
13293
+ climate_setting_schedule_id: string;
13294
+ schedule_type: 'time_bound';
13295
+ device_id: string;
13296
+ name?: string | undefined;
13297
+ schedule_starts_at: string;
13298
+ schedule_ends_at: string;
13299
+ created_at: string;
13300
+ automatic_heating_enabled?: boolean | undefined;
13301
+ automatic_cooling_enabled?: boolean | undefined;
13302
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13303
+ cooling_set_point_celsius?: (number | undefined) | undefined;
13304
+ heating_set_point_celsius?: (number | undefined) | undefined;
13305
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13306
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
13307
+ manual_override_allowed?: boolean | undefined;
13308
+ } | undefined) | undefined;
13309
+ min_cooling_set_point_celsius?: number | undefined;
13310
+ min_cooling_set_point_fahrenheit?: number | undefined;
13311
+ max_cooling_set_point_celsius?: number | undefined;
13312
+ max_cooling_set_point_fahrenheit?: number | undefined;
13313
+ }));
13314
+ location: {
13315
+ location_name?: string | undefined;
13316
+ timezone?: string | undefined;
13317
+ } | null;
13318
+ connected_account_id: string;
13319
+ workspace_id: string;
13320
+ errors: Array<{
13321
+ error_code: string;
13322
+ message: string;
13323
+ }>;
13324
+ warnings: Array<{
13325
+ warning_code: string;
13326
+ message: string;
13327
+ }>;
13328
+ created_at: string;
13329
+ is_managed: true;
13330
+ };
13331
+ };
13332
+ };
13333
+ '/thermostats/heat': {
13334
+ route: '/thermostats/heat';
13335
+ method: 'POST';
13336
+ queryParams: {};
13337
+ jsonBody: {
13338
+ device_id: string;
13339
+ heating_set_point_celsius?: number | undefined;
13340
+ heating_set_point_fahrenheit?: number | undefined;
13341
+ sync?: boolean;
13342
+ };
13343
+ commonParams: {};
13344
+ formData: {};
13345
+ jsonResponse: {};
13346
+ };
13347
+ '/thermostats/heat_cool': {
13348
+ route: '/thermostats/heat_cool';
13349
+ method: 'POST';
13350
+ queryParams: {};
13351
+ jsonBody: {
13352
+ device_id: string;
13353
+ heating_set_point_celsius?: number | undefined;
13354
+ heating_set_point_fahrenheit?: number | undefined;
13355
+ cooling_set_point_celsius?: number | undefined;
13356
+ cooling_set_point_fahrenheit?: number | undefined;
13357
+ sync?: boolean;
13358
+ };
13359
+ commonParams: {};
13360
+ formData: {};
13361
+ jsonResponse: {};
13362
+ };
13363
+ '/thermostats/list': {
13364
+ route: '/thermostats/list';
13365
+ method: 'GET' | 'POST';
13366
+ queryParams: {};
13367
+ jsonBody: {};
13368
+ commonParams: {
13369
+ connected_account_id?: string | undefined;
13370
+ connected_account_ids?: string[] | undefined;
13371
+ connect_webview_id?: string | undefined;
13372
+ device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')) | undefined;
13373
+ device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat')> | undefined;
13374
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode') | undefined;
13375
+ device_ids?: string[] | undefined;
13376
+ limit?: number;
13377
+ created_before?: string | undefined;
13378
+ };
13379
+ formData: {};
13380
+ jsonResponse: {
13381
+ thermostats: Array<{
13382
+ device_id: string;
13383
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat');
13384
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery'>;
13385
+ properties: ({
13386
+ online: boolean;
13387
+ name: string;
13388
+ model: {
13389
+ display_name: string;
13390
+ manufacturer_display_name: string;
13391
+ };
13392
+ has_direct_power?: boolean | undefined;
13393
+ battery_level?: number | undefined;
13394
+ battery?: {
13395
+ level: number;
13396
+ status: 'critical' | 'low' | 'good' | 'full';
13397
+ } | undefined;
13398
+ manufacturer?: string | undefined;
13399
+ image_url?: string | undefined;
13400
+ image_alt_text?: string | undefined;
13401
+ serial_number?: string | undefined;
13402
+ } & {
13403
+ august_metadata?: {
13404
+ lock_id: string;
13405
+ lock_name: string;
13406
+ house_name: string;
13407
+ has_keypad: boolean;
13408
+ keypad_battery_level?: string | undefined;
13409
+ model?: string | undefined;
13410
+ house_id?: string | undefined;
13411
+ } | undefined;
13412
+ avigilon_alta_metadata?: {
13413
+ entry_name: string;
13414
+ org_name: string;
13415
+ zone_id: number;
13416
+ zone_name: string;
13417
+ site_id: number;
13418
+ site_name: string;
13419
+ } | undefined;
13420
+ schlage_metadata?: {
13421
+ device_id: string;
13422
+ device_name: string;
13423
+ access_code_length: number;
13424
+ model?: string | undefined;
13425
+ } | undefined;
13426
+ smartthings_metadata?: {
13427
+ device_id: string;
13428
+ device_name: string;
13429
+ model?: string | undefined;
13430
+ location_id?: string | undefined;
13431
+ } | undefined;
13432
+ lockly_metadata?: {
13433
+ device_id: string;
13434
+ device_name: string;
13435
+ model?: string | undefined;
13436
+ } | undefined;
13437
+ nuki_metadata?: {
13438
+ device_id: string;
13439
+ device_name: string;
13440
+ keypad_battery_critical?: boolean | undefined;
13441
+ } | undefined;
13442
+ kwikset_metadata?: {
13443
+ device_id: string;
13444
+ device_name: string;
13445
+ model_number: string;
13446
+ } | undefined;
13447
+ salto_metadata?: {
13448
+ lock_id: string;
13449
+ customer_reference: string;
13450
+ lock_type: string;
13451
+ battery_level: string;
13452
+ locked_state: string;
13453
+ model?: string | undefined;
13454
+ } | undefined;
13455
+ genie_metadata?: {
13456
+ device_name: string;
13457
+ door_name: string;
13458
+ } | undefined;
13459
+ brivo_metadata?: {
13460
+ device_name: string;
13461
+ } | undefined;
13462
+ igloo_metadata?: {
13463
+ device_id: string;
13464
+ bridge_id: string;
13465
+ model?: string | undefined;
13466
+ } | undefined;
13467
+ noiseaware_metadata?: {
13468
+ device_model: 'indoor' | 'outdoor';
13469
+ noise_level_nrs: number;
13470
+ noise_level_decibel: number;
13471
+ device_name: string;
13472
+ device_id: string;
13473
+ } | undefined;
13474
+ minut_metadata?: {
13475
+ device_id: string;
13476
+ device_name: string;
13477
+ latest_sensor_values: {
13478
+ temperature: {
13479
+ time: string;
13480
+ value: number;
13481
+ };
13482
+ sound: {
13483
+ time: string;
13484
+ value: number;
13485
+ };
13486
+ humidity: {
13487
+ time: string;
13488
+ value: number;
13489
+ };
13490
+ pressure: {
13491
+ time: string;
13492
+ value: number;
13493
+ };
13494
+ accelerometer_z: {
13495
+ time: string;
13496
+ value: number;
13497
+ };
13498
+ };
13499
+ } | undefined;
13500
+ four_suites_metadata?: {
13501
+ device_id: number;
13502
+ device_name: string;
13503
+ reclose_delay_in_seconds: number;
13504
+ } | undefined;
13505
+ two_n_metadata?: {
13506
+ device_id: number;
13507
+ device_name: string;
13508
+ } | undefined;
13509
+ controlbyweb_metadata?: {
13510
+ device_id: string;
13511
+ device_name: string;
13512
+ relay_name: string | null;
13513
+ } | undefined;
13514
+ ttlock_metadata?: {
13515
+ lock_id: number;
13516
+ lock_alias: string;
13517
+ } | undefined;
13518
+ seam_bridge_metadata?: {
13519
+ unlock_method?: ('bridge' | 'doorking') | undefined;
13520
+ device_num: number;
13521
+ name: string;
13522
+ } | undefined;
13523
+ igloohome_metadata?: {
13524
+ device_id: string;
13525
+ bridge_id: string;
13526
+ device_name: string;
13527
+ bridge_name: string;
13528
+ } | undefined;
13529
+ nest_metadata?: {
13530
+ nest_device_id: string;
13531
+ device_name: string;
13532
+ custom_name: string;
13533
+ } | undefined;
13534
+ ecobee_metadata?: {
13535
+ ecobee_device_id: string;
13536
+ device_name: string;
13537
+ } | undefined;
13538
+ hubitat_metadata?: {
13539
+ device_id: string;
13540
+ device_name: string;
13541
+ device_label: string;
13542
+ } | undefined;
13543
+ dormakaba_oracode_metadata?: {
13544
+ door_id: number;
13545
+ door_name: string;
13546
+ device_id?: number | undefined;
13547
+ site_id: number;
13548
+ site_name: string;
13549
+ } | undefined;
13550
+ wyze_metadata?: {
13551
+ device_id: string;
13552
+ device_name: string;
13553
+ product_type: string;
13554
+ product_model: string;
13555
+ device_info_model: string;
13556
+ } | undefined;
13557
+ }) & ({
13558
+ code_constraints?: (Array<{
13559
+ constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future';
13560
+ } | {
13561
+ constraint_type: 'name_length';
13562
+ min_length?: number | undefined;
13563
+ max_length?: number | undefined;
13564
+ }> | undefined) | undefined;
13565
+ supported_code_lengths?: (number[] | undefined) | undefined;
13566
+ max_active_codes_supported?: (number | undefined) | undefined;
13567
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined;
13568
+ has_native_entry_events?: (boolean | undefined) | undefined;
13569
+ locked?: (boolean | undefined) | undefined;
13570
+ keypad_battery?: ({
13571
+ level: number;
13572
+ } | undefined) | undefined;
13573
+ door_open?: (boolean | undefined) | undefined;
13574
+ } & ({
13575
+ temperature_fahrenheit?: number | undefined;
13576
+ temperature_celsius?: number | undefined;
13577
+ relative_humidity?: number | undefined;
13578
+ can_enable_automatic_heating?: boolean | undefined;
13579
+ can_enable_automatic_cooling?: boolean | undefined;
13580
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
13581
+ is_heating_available?: true | undefined;
13582
+ is_cooling_available?: true | undefined;
13583
+ is_heating?: boolean | undefined;
13584
+ is_cooling?: boolean | undefined;
13585
+ is_fan_running?: boolean | undefined;
13586
+ fan_mode_setting?: ('auto' | 'on') | undefined;
13587
+ is_temporary_manual_override_active?: boolean | undefined;
13588
+ current_climate_setting?: {
13589
+ automatic_heating_enabled: boolean;
13590
+ automatic_cooling_enabled: boolean;
13591
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13592
+ cooling_set_point_celsius?: number | undefined;
13593
+ heating_set_point_celsius?: number | undefined;
13594
+ cooling_set_point_fahrenheit?: number | undefined;
13595
+ heating_set_point_fahrenheit?: number | undefined;
13596
+ manual_override_allowed: boolean;
13597
+ } | undefined;
13598
+ default_climate_setting?: ({
13599
+ automatic_heating_enabled: boolean;
13600
+ automatic_cooling_enabled: boolean;
13601
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13602
+ cooling_set_point_celsius?: number | undefined;
13603
+ heating_set_point_celsius?: number | undefined;
13604
+ cooling_set_point_fahrenheit?: number | undefined;
13605
+ heating_set_point_fahrenheit?: number | undefined;
13606
+ manual_override_allowed: boolean;
13607
+ } | undefined) | undefined;
13608
+ is_climate_setting_schedule_active?: boolean | undefined;
13609
+ active_climate_setting_schedule?: ({
13610
+ climate_setting_schedule_id: string;
13611
+ schedule_type: 'time_bound';
13612
+ device_id: string;
13613
+ name?: string | undefined;
13614
+ schedule_starts_at: string;
13615
+ schedule_ends_at: string;
13616
+ created_at: string;
13617
+ automatic_heating_enabled?: boolean | undefined;
13618
+ automatic_cooling_enabled?: boolean | undefined;
13619
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13620
+ cooling_set_point_celsius?: (number | undefined) | undefined;
13621
+ heating_set_point_celsius?: (number | undefined) | undefined;
13622
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13623
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
13624
+ manual_override_allowed?: boolean | undefined;
13625
+ } | undefined) | undefined;
13626
+ min_cooling_set_point_celsius?: number | undefined;
13627
+ min_cooling_set_point_fahrenheit?: number | undefined;
13628
+ max_cooling_set_point_celsius?: number | undefined;
13629
+ max_cooling_set_point_fahrenheit?: number | undefined;
13630
+ min_heating_set_point_celsius?: number | undefined;
13631
+ min_heating_set_point_fahrenheit?: number | undefined;
13632
+ max_heating_set_point_celsius?: number | undefined;
13633
+ max_heating_set_point_fahrenheit?: number | undefined;
13634
+ min_heating_cooling_delta_celsius?: number | undefined;
13635
+ min_heating_cooling_delta_fahrenheit?: number | undefined;
13636
+ } | {
13637
+ temperature_fahrenheit?: number | undefined;
13638
+ temperature_celsius?: number | undefined;
13639
+ relative_humidity?: number | undefined;
13640
+ can_enable_automatic_heating?: boolean | undefined;
13641
+ can_enable_automatic_cooling?: boolean | undefined;
13642
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
13643
+ is_heating_available?: true | undefined;
13644
+ is_cooling_available?: false | undefined;
13645
+ is_heating?: boolean | undefined;
13646
+ is_cooling?: boolean | undefined;
13647
+ is_fan_running?: boolean | undefined;
13648
+ fan_mode_setting?: ('auto' | 'on') | undefined;
13649
+ is_temporary_manual_override_active?: boolean | undefined;
13650
+ current_climate_setting?: {
13651
+ automatic_heating_enabled: boolean;
13652
+ automatic_cooling_enabled: boolean;
13653
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13654
+ cooling_set_point_celsius?: number | undefined;
13655
+ heating_set_point_celsius?: number | undefined;
13656
+ cooling_set_point_fahrenheit?: number | undefined;
13657
+ heating_set_point_fahrenheit?: number | undefined;
13658
+ manual_override_allowed: boolean;
13659
+ } | undefined;
13660
+ default_climate_setting?: ({
13661
+ automatic_heating_enabled: boolean;
13662
+ automatic_cooling_enabled: boolean;
13663
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13664
+ cooling_set_point_celsius?: number | undefined;
13665
+ heating_set_point_celsius?: number | undefined;
13666
+ cooling_set_point_fahrenheit?: number | undefined;
13667
+ heating_set_point_fahrenheit?: number | undefined;
13668
+ manual_override_allowed: boolean;
13669
+ } | undefined) | undefined;
13670
+ is_climate_setting_schedule_active?: boolean | undefined;
13671
+ active_climate_setting_schedule?: ({
13672
+ climate_setting_schedule_id: string;
13673
+ schedule_type: 'time_bound';
13674
+ device_id: string;
13675
+ name?: string | undefined;
13676
+ schedule_starts_at: string;
13677
+ schedule_ends_at: string;
13678
+ created_at: string;
13679
+ automatic_heating_enabled?: boolean | undefined;
13680
+ automatic_cooling_enabled?: boolean | undefined;
13681
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13682
+ cooling_set_point_celsius?: (number | undefined) | undefined;
13683
+ heating_set_point_celsius?: (number | undefined) | undefined;
13684
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13685
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
13686
+ manual_override_allowed?: boolean | undefined;
13687
+ } | undefined) | undefined;
13688
+ min_heating_set_point_celsius?: number | undefined;
13689
+ min_heating_set_point_fahrenheit?: number | undefined;
13690
+ max_heating_set_point_celsius?: number | undefined;
13691
+ max_heating_set_point_fahrenheit?: number | undefined;
13692
+ } | {
13693
+ temperature_fahrenheit?: number | undefined;
13694
+ temperature_celsius?: number | undefined;
13695
+ relative_humidity?: number | undefined;
13696
+ can_enable_automatic_heating?: boolean | undefined;
13697
+ can_enable_automatic_cooling?: boolean | undefined;
13698
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
13699
+ is_heating_available?: false | undefined;
13700
+ is_cooling_available?: true | undefined;
13701
+ is_heating?: boolean | undefined;
13702
+ is_cooling?: boolean | undefined;
13703
+ is_fan_running?: boolean | undefined;
13704
+ fan_mode_setting?: ('auto' | 'on') | undefined;
13705
+ is_temporary_manual_override_active?: boolean | undefined;
13706
+ current_climate_setting?: {
13707
+ automatic_heating_enabled: boolean;
13708
+ automatic_cooling_enabled: boolean;
13709
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13710
+ cooling_set_point_celsius?: number | undefined;
13711
+ heating_set_point_celsius?: number | undefined;
13712
+ cooling_set_point_fahrenheit?: number | undefined;
13713
+ heating_set_point_fahrenheit?: number | undefined;
13714
+ manual_override_allowed: boolean;
13715
+ } | undefined;
13716
+ default_climate_setting?: ({
13717
+ automatic_heating_enabled: boolean;
13718
+ automatic_cooling_enabled: boolean;
13719
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
13720
+ cooling_set_point_celsius?: number | undefined;
13721
+ heating_set_point_celsius?: number | undefined;
13722
+ cooling_set_point_fahrenheit?: number | undefined;
13723
+ heating_set_point_fahrenheit?: number | undefined;
13724
+ manual_override_allowed: boolean;
13725
+ } | undefined) | undefined;
13726
+ is_climate_setting_schedule_active?: boolean | undefined;
13727
+ active_climate_setting_schedule?: ({
13728
+ climate_setting_schedule_id: string;
13729
+ schedule_type: 'time_bound';
13730
+ device_id: string;
13731
+ name?: string | undefined;
13732
+ schedule_starts_at: string;
13733
+ schedule_ends_at: string;
13734
+ created_at: string;
13735
+ automatic_heating_enabled?: boolean | undefined;
13736
+ automatic_cooling_enabled?: boolean | undefined;
13737
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13738
+ cooling_set_point_celsius?: (number | undefined) | undefined;
13739
+ heating_set_point_celsius?: (number | undefined) | undefined;
13740
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13741
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
13742
+ manual_override_allowed?: boolean | undefined;
13743
+ } | undefined) | undefined;
13744
+ min_cooling_set_point_celsius?: number | undefined;
13745
+ min_cooling_set_point_fahrenheit?: number | undefined;
13746
+ max_cooling_set_point_celsius?: number | undefined;
13747
+ max_cooling_set_point_fahrenheit?: number | undefined;
13748
+ }));
13749
+ location: {
13750
+ location_name?: string | undefined;
13751
+ timezone?: string | undefined;
13752
+ } | null;
13753
+ connected_account_id: string;
13754
+ workspace_id: string;
13755
+ errors: Array<{
13756
+ error_code: string;
13757
+ message: string;
13758
+ }>;
13759
+ warnings: Array<{
13760
+ warning_code: string;
13761
+ message: string;
13762
+ }>;
13763
+ created_at: string;
13764
+ is_managed: true;
13765
+ }>;
13766
+ };
13767
+ };
13768
+ '/thermostats/off': {
13769
+ route: '/thermostats/off';
13770
+ method: 'POST';
13771
+ queryParams: {};
13772
+ jsonBody: {
13773
+ device_id: string;
13774
+ sync?: boolean;
13775
+ };
13776
+ commonParams: {};
13777
+ formData: {};
13778
+ jsonResponse: {};
13779
+ };
13780
+ '/thermostats/set_fan_mode': {
13781
+ route: '/thermostats/set_fan_mode';
13782
+ method: 'POST';
13783
+ queryParams: {};
13784
+ jsonBody: {
13785
+ device_id: string;
13786
+ fan_mode?: ('auto' | 'on') | undefined;
13787
+ fan_mode_setting?: ('auto' | 'on') | undefined;
13788
+ sync?: boolean;
13789
+ };
13790
+ commonParams: {};
13791
+ formData: {};
13792
+ jsonResponse: {};
13793
+ };
13794
+ '/thermostats/update': {
13795
+ route: '/thermostats/update';
13796
+ method: 'POST';
13797
+ queryParams: {};
13798
+ jsonBody: {
13799
+ device_id: string;
13800
+ default_climate_setting: {
13801
+ automatic_heating_enabled?: boolean | undefined;
13802
+ automatic_cooling_enabled?: boolean | undefined;
13803
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
13804
+ cooling_set_point_celsius?: (number | undefined) | undefined;
13805
+ heating_set_point_celsius?: (number | undefined) | undefined;
13806
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
13807
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
13808
+ manual_override_allowed?: boolean | undefined;
13809
+ };
13810
+ };
13811
+ commonParams: {};
13812
+ formData: {};
13813
+ jsonResponse: {};
13814
+ };
13815
+ '/webhooks/create': {
13816
+ route: '/webhooks/create';
13817
+ method: 'POST';
13818
+ queryParams: {};
13819
+ jsonBody: {
13820
+ url: string;
13821
+ event_types?: string[];
13822
+ };
13823
+ commonParams: {};
13824
+ formData: {};
13825
+ jsonResponse: {
13826
+ webhook: {
13827
+ webhook_id: string;
13828
+ url: string;
13829
+ event_types?: string[] | undefined;
13830
+ secret?: string | undefined;
13831
+ };
13832
+ };
13833
+ };
13834
+ '/webhooks/delete': {
13835
+ route: '/webhooks/delete';
13836
+ method: 'DELETE' | 'POST';
13837
+ queryParams: {};
13838
+ jsonBody: {};
13839
+ commonParams: {
13840
+ webhook_id: string;
13841
+ };
13842
+ formData: {};
13843
+ jsonResponse: {};
13844
+ };
13845
+ '/webhooks/get': {
13846
+ route: '/webhooks/get';
13847
+ method: 'GET' | 'POST';
13848
+ queryParams: {};
13849
+ jsonBody: {};
13850
+ commonParams: {
13851
+ webhook_id: string;
13852
+ };
13853
+ formData: {};
13854
+ jsonResponse: {
13855
+ webhook: {
13856
+ webhook_id: string;
13857
+ url: string;
13858
+ event_types?: string[] | undefined;
13859
+ secret?: string | undefined;
13860
+ };
13861
+ };
13862
+ };
13863
+ '/webhooks/list': {
13864
+ route: '/webhooks/list';
13865
+ method: 'GET';
13866
+ queryParams: {};
13867
+ jsonBody: {};
13868
+ commonParams: {};
13869
+ formData: {};
13870
+ jsonResponse: {
13871
+ webhooks: Array<{
13872
+ webhook_id: string;
13873
+ url: string;
13874
+ event_types?: string[] | undefined;
13875
+ secret?: string | undefined;
13876
+ }>;
13877
+ };
13878
+ };
13879
+ '/workspaces/get': {
13880
+ route: '/workspaces/get';
13881
+ method: 'GET';
13882
+ queryParams: {};
13883
+ jsonBody: {};
13884
+ commonParams: {};
13885
+ formData: {};
13886
+ jsonResponse: {
13887
+ workspace?: {
13888
+ workspace_id: string;
13889
+ name: string;
13890
+ is_sandbox: boolean;
13891
+ connect_partner_name: string | null;
13892
+ } | undefined;
13893
+ };
13894
+ };
13895
+ '/workspaces/list': {
13896
+ route: '/workspaces/list';
13897
+ method: 'GET';
13898
+ queryParams: {};
13899
+ jsonBody: {};
13900
+ commonParams: {};
13901
+ formData: {};
13902
+ jsonResponse: {
13903
+ workspaces: Array<{
13904
+ workspace_id: string;
13905
+ name: string;
13906
+ is_sandbox: boolean;
13907
+ connect_partner_name: string | null;
13908
+ }>;
13909
+ };
13910
+ };
13911
+ '/workspaces/reset_sandbox': {
13912
+ route: '/workspaces/reset_sandbox';
13913
+ method: 'POST';
13914
+ queryParams: {};
13915
+ jsonBody: {};
13916
+ commonParams: {};
13917
+ formData: {};
13918
+ jsonResponse: {
13919
+ message: string;
13920
+ };
13921
+ };
13922
+ }
13923
+ type RouteResponse<Path extends keyof Routes> = Routes[Path]['jsonResponse'];
13924
+ type RouteRequestBody<Path extends keyof Routes> = Routes[Path]['jsonBody'] & Routes[Path]['commonParams'];
13925
+ type RouteRequestParams<Path extends keyof Routes> = Routes[Path]['queryParams'] & Routes[Path]['commonParams'];
13926
+
10317
13927
  declare const routes: {};
10318
13928
 
10319
- export { ConnectWebview, _default as openapi, routes, schemas };
13929
+ export { ConnectWebview, RouteRequestBody, RouteRequestParams, RouteResponse, Routes, _default as openapi, routes, schemas };