@seamapi/types 1.176.0 → 1.177.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.
Files changed (112) hide show
  1. package/dist/connect.cjs +1948 -160
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +4660 -498
  4. package/lib/seam/connect/model-types.d.ts +1 -1
  5. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +556 -0
  6. package/lib/seam/connect/models/action-attempts/action-attempt.js +20 -0
  7. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -0
  8. package/lib/seam/connect/models/action-attempts/common.d.ts +53 -0
  9. package/lib/seam/connect/models/action-attempts/common.js +24 -0
  10. package/lib/seam/connect/models/action-attempts/common.js.map +1 -0
  11. package/lib/seam/connect/models/action-attempts/index.d.ts +1 -0
  12. package/lib/seam/connect/models/action-attempts/index.js +2 -0
  13. package/lib/seam/connect/models/action-attempts/index.js.map +1 -0
  14. package/lib/seam/connect/models/action-attempts/lock-door.d.ts +72 -0
  15. package/lib/seam/connect/models/action-attempts/lock-door.js +25 -0
  16. package/lib/seam/connect/models/action-attempts/lock-door.js.map +1 -0
  17. package/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.d.ts +71 -0
  18. package/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.js +28 -0
  19. package/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.js.map +1 -0
  20. package/lib/seam/connect/models/action-attempts/set-cool.d.ts +71 -0
  21. package/lib/seam/connect/models/action-attempts/set-cool.js +25 -0
  22. package/lib/seam/connect/models/action-attempts/set-cool.js.map +1 -0
  23. package/lib/seam/connect/models/action-attempts/set-fan-mode.d.ts +71 -0
  24. package/lib/seam/connect/models/action-attempts/set-fan-mode.js +25 -0
  25. package/lib/seam/connect/models/action-attempts/set-fan-mode.js.map +1 -0
  26. package/lib/seam/connect/models/action-attempts/set-heat-cool.d.ts +71 -0
  27. package/lib/seam/connect/models/action-attempts/set-heat-cool.js +25 -0
  28. package/lib/seam/connect/models/action-attempts/set-heat-cool.js.map +1 -0
  29. package/lib/seam/connect/models/action-attempts/set-heat.d.ts +71 -0
  30. package/lib/seam/connect/models/action-attempts/set-heat.js +25 -0
  31. package/lib/seam/connect/models/action-attempts/set-heat.js.map +1 -0
  32. package/lib/seam/connect/models/action-attempts/set-thermostat-off.d.ts +71 -0
  33. package/lib/seam/connect/models/action-attempts/set-thermostat-off.js +25 -0
  34. package/lib/seam/connect/models/action-attempts/set-thermostat-off.js.map +1 -0
  35. package/lib/seam/connect/models/action-attempts/unlock-door.d.ts +72 -0
  36. package/lib/seam/connect/models/action-attempts/unlock-door.js +25 -0
  37. package/lib/seam/connect/models/action-attempts/unlock-door.js.map +1 -0
  38. package/lib/seam/connect/models/devices/managed-device.js +6 -2
  39. package/lib/seam/connect/models/devices/managed-device.js.map +1 -1
  40. package/lib/seam/connect/models/events/access-codes.d.ts +1 -1
  41. package/lib/seam/connect/models/events/access-codes.js +1 -1
  42. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  43. package/lib/seam/connect/models/events/acs/common.d.ts +1 -1
  44. package/lib/seam/connect/models/events/acs/common.js +1 -1
  45. package/lib/seam/connect/models/events/acs/common.js.map +1 -1
  46. package/lib/seam/connect/models/events/acs/credentials.d.ts +1 -1
  47. package/lib/seam/connect/models/events/acs/credentials.js +1 -1
  48. package/lib/seam/connect/models/events/acs/credentials.js.map +1 -1
  49. package/lib/seam/connect/models/events/acs/users.d.ts +1 -1
  50. package/lib/seam/connect/models/events/acs/users.js +1 -1
  51. package/lib/seam/connect/models/events/acs/users.js.map +1 -1
  52. package/lib/seam/connect/models/events/action-attempts.d.ts +10 -10
  53. package/lib/seam/connect/models/events/client-sessions.d.ts +1 -1
  54. package/lib/seam/connect/models/events/client-sessions.js +1 -1
  55. package/lib/seam/connect/models/events/client-sessions.js.map +1 -1
  56. package/lib/seam/connect/models/events/common.d.ts +1 -1
  57. package/lib/seam/connect/models/events/common.js +1 -1
  58. package/lib/seam/connect/models/events/common.js.map +1 -1
  59. package/lib/seam/connect/models/events/connected-accounts.d.ts +1 -1
  60. package/lib/seam/connect/models/events/connected-accounts.js +1 -1
  61. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  62. package/lib/seam/connect/models/events/devices.d.ts +1 -1
  63. package/lib/seam/connect/models/events/devices.js +1 -1
  64. package/lib/seam/connect/models/events/devices.js.map +1 -1
  65. package/lib/seam/connect/models/events/enrollment-automations.d.ts +1 -1
  66. package/lib/seam/connect/models/events/enrollment-automations.js +1 -1
  67. package/lib/seam/connect/models/events/enrollment-automations.js.map +1 -1
  68. package/lib/seam/connect/models/events/phones.d.ts +1 -1
  69. package/lib/seam/connect/models/events/phones.js +1 -1
  70. package/lib/seam/connect/models/events/phones.js.map +1 -1
  71. package/lib/seam/connect/models/events/seam-event.d.ts +1 -1
  72. package/lib/seam/connect/models/events/seam-event.js +1 -1
  73. package/lib/seam/connect/models/events/seam-event.js.map +1 -1
  74. package/lib/seam/connect/models/index.d.ts +1 -0
  75. package/lib/seam/connect/models/index.js +1 -0
  76. package/lib/seam/connect/models/index.js.map +1 -1
  77. package/lib/seam/connect/openapi.d.ts +1285 -54
  78. package/lib/seam/connect/openapi.js +1662 -28
  79. package/lib/seam/connect/openapi.js.map +1 -1
  80. package/lib/seam/connect/route-types.d.ts +2941 -565
  81. package/lib/seam/connect/schemas.d.ts +1 -1
  82. package/lib/seam/connect/schemas.js +1 -1
  83. package/lib/seam/connect/schemas.js.map +1 -1
  84. package/package.json +1 -1
  85. package/src/lib/seam/connect/model-types.ts +1 -0
  86. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +25 -0
  87. package/src/lib/seam/connect/models/action-attempts/common.ts +27 -0
  88. package/src/lib/seam/connect/models/action-attempts/index.ts +1 -0
  89. package/src/lib/seam/connect/models/action-attempts/lock-door.ts +35 -0
  90. package/src/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.ts +39 -0
  91. package/src/lib/seam/connect/models/action-attempts/set-cool.ts +33 -0
  92. package/src/lib/seam/connect/models/action-attempts/set-fan-mode.ts +33 -0
  93. package/src/lib/seam/connect/models/action-attempts/set-heat-cool.ts +33 -0
  94. package/src/lib/seam/connect/models/action-attempts/set-heat.ts +33 -0
  95. package/src/lib/seam/connect/models/action-attempts/set-thermostat-off.ts +36 -0
  96. package/src/lib/seam/connect/models/action-attempts/unlock-door.ts +35 -0
  97. package/src/lib/seam/connect/models/devices/managed-device.ts +8 -2
  98. package/src/lib/seam/connect/models/events/access-codes.ts +1 -1
  99. package/src/lib/seam/connect/models/events/acs/common.ts +1 -1
  100. package/src/lib/seam/connect/models/events/acs/credentials.ts +1 -1
  101. package/src/lib/seam/connect/models/events/acs/users.ts +1 -1
  102. package/src/lib/seam/connect/models/events/client-sessions.ts +1 -1
  103. package/src/lib/seam/connect/models/events/common.ts +1 -1
  104. package/src/lib/seam/connect/models/events/connected-accounts.ts +1 -1
  105. package/src/lib/seam/connect/models/events/devices.ts +1 -1
  106. package/src/lib/seam/connect/models/events/enrollment-automations.ts +1 -1
  107. package/src/lib/seam/connect/models/events/phones.ts +1 -1
  108. package/src/lib/seam/connect/models/events/seam-event.ts +1 -1
  109. package/src/lib/seam/connect/models/index.ts +1 -0
  110. package/src/lib/seam/connect/openapi.ts +1686 -28
  111. package/src/lib/seam/connect/route-types.ts +3458 -914
  112. package/src/lib/seam/connect/schemas.ts +6 -1
@@ -2222,7 +2222,11 @@ export interface Routes {
2222
2222
  offline_access_codes_supported?: boolean | undefined;
2223
2223
  /** Indicates whether the device supports online access codes. */
2224
2224
  online_access_codes_supported?: boolean | undefined;
2225
- /** Indicates whether the device supports an accessory keypad. */
2225
+ /**
2226
+ ---
2227
+ deprecated: use device.properties.model.can_connect_accessory_keypad
2228
+ ---
2229
+ */
2226
2230
  accessory_keypad_supported?: boolean | undefined;
2227
2231
  };
2228
2232
  /** Indicates whether the device has direct power. */
@@ -2248,7 +2252,7 @@ export interface Routes {
2248
2252
  offline_access_codes_enabled?: boolean | undefined;
2249
2253
  /**
2250
2254
  ---
2251
- deprecated: use model.accessory_keypad_supported
2255
+ deprecated: use device.properties.model.can_connect_accessory_keypad
2252
2256
  ---
2253
2257
  */
2254
2258
  supports_accessory_keypad?: boolean | undefined;
@@ -2762,7 +2766,11 @@ export interface Routes {
2762
2766
  offline_access_codes_supported?: boolean | undefined;
2763
2767
  /** Indicates whether the device supports online access codes. */
2764
2768
  online_access_codes_supported?: boolean | undefined;
2765
- /** Indicates whether the device supports an accessory keypad. */
2769
+ /**
2770
+ ---
2771
+ deprecated: use device.properties.model.can_connect_accessory_keypad
2772
+ ---
2773
+ */
2766
2774
  accessory_keypad_supported?: boolean | undefined;
2767
2775
  };
2768
2776
  /** Indicates whether the device has direct power. */
@@ -2788,7 +2796,7 @@ export interface Routes {
2788
2796
  offline_access_codes_enabled?: boolean | undefined;
2789
2797
  /**
2790
2798
  ---
2791
- deprecated: use model.accessory_keypad_supported
2799
+ deprecated: use device.properties.model.can_connect_accessory_keypad
2792
2800
  ---
2793
2801
  */
2794
2802
  supports_accessory_keypad?: boolean | undefined;
@@ -3344,7 +3352,11 @@ export interface Routes {
3344
3352
  offline_access_codes_supported?: boolean | undefined;
3345
3353
  /** Indicates whether the device supports online access codes. */
3346
3354
  online_access_codes_supported?: boolean | undefined;
3347
- /** Indicates whether the device supports an accessory keypad. */
3355
+ /**
3356
+ ---
3357
+ deprecated: use device.properties.model.can_connect_accessory_keypad
3358
+ ---
3359
+ */
3348
3360
  accessory_keypad_supported?: boolean | undefined;
3349
3361
  };
3350
3362
  };
@@ -3452,7 +3464,11 @@ export interface Routes {
3452
3464
  offline_access_codes_supported?: boolean | undefined;
3453
3465
  /** Indicates whether the device supports online access codes. */
3454
3466
  online_access_codes_supported?: boolean | undefined;
3455
- /** Indicates whether the device supports an accessory keypad. */
3467
+ /**
3468
+ ---
3469
+ deprecated: use device.properties.model.can_connect_accessory_keypad
3470
+ ---
3471
+ */
3456
3472
  accessory_keypad_supported?: boolean | undefined;
3457
3473
  };
3458
3474
  };
@@ -3616,7 +3632,11 @@ export interface Routes {
3616
3632
  offline_access_codes_supported?: boolean | undefined;
3617
3633
  /** Indicates whether the device supports online access codes. */
3618
3634
  online_access_codes_supported?: boolean | undefined;
3619
- /** Indicates whether the device supports an accessory keypad. */
3635
+ /**
3636
+ ---
3637
+ deprecated: use device.properties.model.can_connect_accessory_keypad
3638
+ ---
3639
+ */
3620
3640
  accessory_keypad_supported?: boolean | undefined;
3621
3641
  };
3622
3642
  /** Indicates whether the device has direct power. */
@@ -3642,7 +3662,7 @@ export interface Routes {
3642
3662
  offline_access_codes_enabled?: boolean | undefined;
3643
3663
  /**
3644
3664
  ---
3645
- deprecated: use model.accessory_keypad_supported
3665
+ deprecated: use device.properties.model.can_connect_accessory_keypad
3646
3666
  ---
3647
3667
  */
3648
3668
  supports_accessory_keypad?: boolean | undefined;
@@ -4131,7 +4151,11 @@ export interface Routes {
4131
4151
  offline_access_codes_supported?: boolean | undefined;
4132
4152
  /** Indicates whether the device supports online access codes. */
4133
4153
  online_access_codes_supported?: boolean | undefined;
4134
- /** Indicates whether the device supports an accessory keypad. */
4154
+ /**
4155
+ ---
4156
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4157
+ ---
4158
+ */
4135
4159
  accessory_keypad_supported?: boolean | undefined;
4136
4160
  };
4137
4161
  /** Indicates whether the device has direct power. */
@@ -4157,7 +4181,7 @@ export interface Routes {
4157
4181
  offline_access_codes_enabled?: boolean | undefined;
4158
4182
  /**
4159
4183
  ---
4160
- deprecated: use model.accessory_keypad_supported
4184
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4161
4185
  ---
4162
4186
  */
4163
4187
  supports_accessory_keypad?: boolean | undefined;
@@ -4671,7 +4695,11 @@ export interface Routes {
4671
4695
  offline_access_codes_supported?: boolean | undefined;
4672
4696
  /** Indicates whether the device supports online access codes. */
4673
4697
  online_access_codes_supported?: boolean | undefined;
4674
- /** Indicates whether the device supports an accessory keypad. */
4698
+ /**
4699
+ ---
4700
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4701
+ ---
4702
+ */
4675
4703
  accessory_keypad_supported?: boolean | undefined;
4676
4704
  };
4677
4705
  /** Indicates whether the device has direct power. */
@@ -4697,7 +4725,7 @@ export interface Routes {
4697
4725
  offline_access_codes_enabled?: boolean | undefined;
4698
4726
  /**
4699
4727
  ---
4700
- deprecated: use model.accessory_keypad_supported
4728
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4701
4729
  ---
4702
4730
  */
4703
4731
  supports_accessory_keypad?: boolean | undefined;
@@ -5186,7 +5214,11 @@ export interface Routes {
5186
5214
  offline_access_codes_supported?: boolean | undefined;
5187
5215
  /** Indicates whether the device supports online access codes. */
5188
5216
  online_access_codes_supported?: boolean | undefined;
5189
- /** Indicates whether the device supports an accessory keypad. */
5217
+ /**
5218
+ ---
5219
+ deprecated: use device.properties.model.can_connect_accessory_keypad
5220
+ ---
5221
+ */
5190
5222
  accessory_keypad_supported?: boolean | undefined;
5191
5223
  };
5192
5224
  /** Indicates whether the device has direct power. */
@@ -5212,7 +5244,7 @@ export interface Routes {
5212
5244
  offline_access_codes_enabled?: boolean | undefined;
5213
5245
  /**
5214
5246
  ---
5215
- deprecated: use model.accessory_keypad_supported
5247
+ deprecated: use device.properties.model.can_connect_accessory_keypad
5216
5248
  ---
5217
5249
  */
5218
5250
  supports_accessory_keypad?: boolean | undefined;
@@ -5667,176 +5699,313 @@ export interface Routes {
5667
5699
  formData: {};
5668
5700
  jsonResponse: {
5669
5701
  action_attempt: {
5670
- status: 'success';
5671
- action_type: string;
5702
+ /**
5703
+ ---
5704
+ title: Action Attempt ID
5705
+ ---
5706
+ The ID of the action attempt.
5707
+ */
5672
5708
  action_attempt_id: string;
5673
- result?: any;
5709
+ status: 'pending';
5710
+ result: null;
5674
5711
  error: null;
5712
+ action_type: 'LOCK_DOOR';
5675
5713
  } | {
5676
- status: 'pending';
5677
- action_type: string;
5714
+ /**
5715
+ ---
5716
+ title: Action Attempt ID
5717
+ ---
5718
+ The ID of the action attempt.
5719
+ */
5678
5720
  action_attempt_id: string;
5679
- result: null;
5721
+ status: 'success';
5680
5722
  error: null;
5723
+ action_type: 'LOCK_DOOR';
5724
+ result: {};
5681
5725
  } | {
5682
- status: 'error';
5683
- action_type: string;
5726
+ /**
5727
+ ---
5728
+ title: Action Attempt ID
5729
+ ---
5730
+ The ID of the action attempt.
5731
+ */
5684
5732
  action_attempt_id: string;
5733
+ status: 'error';
5685
5734
  result: null;
5735
+ action_type: 'LOCK_DOOR';
5686
5736
  error: {
5687
5737
  type: string;
5688
5738
  message: string;
5689
5739
  };
5690
- };
5691
- };
5692
- };
5693
- '/locks/unlock_door': {
5694
- route: '/locks/unlock_door';
5695
- method: 'POST';
5696
- queryParams: {};
5697
- jsonBody: {
5698
- device_id: string;
5699
- sync?: boolean;
5700
- };
5701
- commonParams: {};
5702
- formData: {};
5703
- jsonResponse: {
5704
- action_attempt: {
5705
- status: 'success';
5706
- action_type: string;
5740
+ } | {
5741
+ /**
5742
+ ---
5743
+ title: Action Attempt ID
5744
+ ---
5745
+ The ID of the action attempt.
5746
+ */
5707
5747
  action_attempt_id: string;
5708
- result?: any;
5748
+ status: 'pending';
5749
+ result: null;
5709
5750
  error: null;
5751
+ action_type: 'UNLOCK_DOOR';
5710
5752
  } | {
5711
- status: 'pending';
5712
- action_type: string;
5753
+ /**
5754
+ ---
5755
+ title: Action Attempt ID
5756
+ ---
5757
+ The ID of the action attempt.
5758
+ */
5713
5759
  action_attempt_id: string;
5714
- result: null;
5760
+ status: 'success';
5715
5761
  error: null;
5762
+ action_type: 'UNLOCK_DOOR';
5763
+ result: {};
5716
5764
  } | {
5717
- status: 'error';
5718
- action_type: string;
5765
+ /**
5766
+ ---
5767
+ title: Action Attempt ID
5768
+ ---
5769
+ The ID of the action attempt.
5770
+ */
5719
5771
  action_attempt_id: string;
5772
+ status: 'error';
5720
5773
  result: null;
5774
+ action_type: 'UNLOCK_DOOR';
5721
5775
  error: {
5722
5776
  type: string;
5723
5777
  message: string;
5724
5778
  };
5725
- };
5726
- };
5727
- };
5728
- '/networks/get': {
5729
- route: '/networks/get';
5730
- method: 'GET' | 'POST';
5731
- queryParams: {};
5732
- jsonBody: {};
5733
- commonParams: {
5734
- network_id: string;
5735
- };
5736
- formData: {};
5737
- jsonResponse: {
5738
- network: {
5739
- network_id: string;
5740
- workspace_id: string;
5741
- display_name: string;
5742
- created_at: string;
5743
- };
5744
- };
5745
- };
5746
- '/networks/list': {
5747
- route: '/networks/list';
5748
- method: 'GET' | 'POST';
5749
- queryParams: {};
5750
- jsonBody: {};
5751
- commonParams: {};
5752
- formData: {};
5753
- jsonResponse: {
5754
- networks: Array<{
5755
- network_id: string;
5756
- workspace_id: string;
5757
- display_name: string;
5758
- created_at: string;
5759
- }>;
5760
- };
5761
- };
5762
- '/noise_sensors/noise_thresholds/create': {
5763
- route: '/noise_sensors/noise_thresholds/create';
5764
- method: 'POST';
5765
- queryParams: {};
5766
- jsonBody: {
5767
- device_id: string;
5768
- sync?: boolean;
5769
- name?: string | undefined;
5770
- starts_daily_at: string;
5771
- ends_daily_at: string;
5772
- noise_threshold_decibels?: number | undefined;
5773
- noise_threshold_nrs?: number | undefined;
5774
- };
5775
- commonParams: {};
5776
- formData: {};
5777
- jsonResponse: {
5778
- action_attempt: {
5779
- status: 'success';
5780
- action_type: string;
5779
+ } | {
5780
+ /**
5781
+ ---
5782
+ title: Action Attempt ID
5783
+ ---
5784
+ The ID of the action attempt.
5785
+ */
5781
5786
  action_attempt_id: string;
5782
- result?: any;
5787
+ status: 'pending';
5788
+ result: null;
5783
5789
  error: null;
5790
+ action_type: 'RESET_SANDBOX_WORKSPACE';
5784
5791
  } | {
5785
- status: 'pending';
5786
- action_type: string;
5792
+ /**
5793
+ ---
5794
+ title: Action Attempt ID
5795
+ ---
5796
+ The ID of the action attempt.
5797
+ */
5787
5798
  action_attempt_id: string;
5788
- result: null;
5799
+ status: 'success';
5789
5800
  error: null;
5801
+ action_type: 'RESET_SANDBOX_WORKSPACE';
5802
+ result: {};
5790
5803
  } | {
5791
- status: 'error';
5792
- action_type: string;
5804
+ /**
5805
+ ---
5806
+ title: Action Attempt ID
5807
+ ---
5808
+ The ID of the action attempt.
5809
+ */
5793
5810
  action_attempt_id: string;
5811
+ status: 'error';
5794
5812
  result: null;
5813
+ action_type: 'RESET_SANDBOX_WORKSPACE';
5795
5814
  error: {
5796
5815
  type: string;
5797
5816
  message: string;
5798
5817
  };
5799
- };
5800
- noise_threshold: {
5801
- noise_threshold_id: string;
5802
- device_id: string;
5803
- name: string;
5804
- noise_threshold_nrs?: number | undefined;
5805
- starts_daily_at: string;
5806
- ends_daily_at: string;
5807
- noise_threshold_decibels: number;
5808
- };
5809
- };
5810
- };
5811
- '/noise_sensors/noise_thresholds/delete': {
5812
- route: '/noise_sensors/noise_thresholds/delete';
5813
- method: 'DELETE' | 'POST';
5814
- queryParams: {};
5815
- jsonBody: {
5816
- noise_threshold_id: string;
5817
- device_id: string;
5818
- sync?: boolean;
5819
- };
5820
- commonParams: {};
5821
- formData: {};
5822
- jsonResponse: {
5823
- action_attempt: {
5824
- status: 'success';
5825
- action_type: string;
5818
+ } | {
5819
+ /**
5820
+ ---
5821
+ title: Action Attempt ID
5822
+ ---
5823
+ The ID of the action attempt.
5824
+ */
5826
5825
  action_attempt_id: string;
5827
- result?: any;
5826
+ status: 'pending';
5827
+ result: null;
5828
5828
  error: null;
5829
+ action_type: 'SET_COOL';
5829
5830
  } | {
5830
- status: 'pending';
5831
- action_type: string;
5831
+ /**
5832
+ ---
5833
+ title: Action Attempt ID
5834
+ ---
5835
+ The ID of the action attempt.
5836
+ */
5837
+ action_attempt_id: string;
5838
+ status: 'success';
5839
+ error: null;
5840
+ action_type: 'SET_COOL';
5841
+ result: {};
5842
+ } | {
5843
+ /**
5844
+ ---
5845
+ title: Action Attempt ID
5846
+ ---
5847
+ The ID of the action attempt.
5848
+ */
5832
5849
  action_attempt_id: string;
5850
+ status: 'error';
5851
+ result: null;
5852
+ action_type: 'SET_COOL';
5853
+ error: {
5854
+ type: string;
5855
+ message: string;
5856
+ };
5857
+ } | {
5858
+ /**
5859
+ ---
5860
+ title: Action Attempt ID
5861
+ ---
5862
+ The ID of the action attempt.
5863
+ */
5864
+ action_attempt_id: string;
5865
+ status: 'pending';
5833
5866
  result: null;
5834
5867
  error: null;
5868
+ action_type: 'SET_HEAT';
5869
+ } | {
5870
+ /**
5871
+ ---
5872
+ title: Action Attempt ID
5873
+ ---
5874
+ The ID of the action attempt.
5875
+ */
5876
+ action_attempt_id: string;
5877
+ status: 'success';
5878
+ error: null;
5879
+ action_type: 'SET_HEAT';
5880
+ result: {};
5835
5881
  } | {
5882
+ /**
5883
+ ---
5884
+ title: Action Attempt ID
5885
+ ---
5886
+ The ID of the action attempt.
5887
+ */
5888
+ action_attempt_id: string;
5836
5889
  status: 'error';
5837
- action_type: string;
5890
+ result: null;
5891
+ action_type: 'SET_HEAT';
5892
+ error: {
5893
+ type: string;
5894
+ message: string;
5895
+ };
5896
+ } | {
5897
+ /**
5898
+ ---
5899
+ title: Action Attempt ID
5900
+ ---
5901
+ The ID of the action attempt.
5902
+ */
5903
+ action_attempt_id: string;
5904
+ status: 'pending';
5905
+ result: null;
5906
+ error: null;
5907
+ action_type: 'SET_HEAT_COOL';
5908
+ } | {
5909
+ /**
5910
+ ---
5911
+ title: Action Attempt ID
5912
+ ---
5913
+ The ID of the action attempt.
5914
+ */
5915
+ action_attempt_id: string;
5916
+ status: 'success';
5917
+ error: null;
5918
+ action_type: 'SET_HEAT_COOL';
5919
+ result: {};
5920
+ } | {
5921
+ /**
5922
+ ---
5923
+ title: Action Attempt ID
5924
+ ---
5925
+ The ID of the action attempt.
5926
+ */
5838
5927
  action_attempt_id: string;
5928
+ status: 'error';
5839
5929
  result: null;
5930
+ action_type: 'SET_HEAT_COOL';
5931
+ error: {
5932
+ type: string;
5933
+ message: string;
5934
+ };
5935
+ } | {
5936
+ /**
5937
+ ---
5938
+ title: Action Attempt ID
5939
+ ---
5940
+ The ID of the action attempt.
5941
+ */
5942
+ action_attempt_id: string;
5943
+ status: 'pending';
5944
+ result: null;
5945
+ error: null;
5946
+ action_type: 'SET_FAN_MODE';
5947
+ } | {
5948
+ /**
5949
+ ---
5950
+ title: Action Attempt ID
5951
+ ---
5952
+ The ID of the action attempt.
5953
+ */
5954
+ action_attempt_id: string;
5955
+ status: 'success';
5956
+ error: null;
5957
+ action_type: 'SET_FAN_MODE';
5958
+ result: {};
5959
+ } | {
5960
+ /**
5961
+ ---
5962
+ title: Action Attempt ID
5963
+ ---
5964
+ The ID of the action attempt.
5965
+ */
5966
+ action_attempt_id: string;
5967
+ status: 'error';
5968
+ result: null;
5969
+ action_type: 'SET_FAN_MODE';
5970
+ error: {
5971
+ type: string;
5972
+ message: string;
5973
+ };
5974
+ } | {
5975
+ /**
5976
+ ---
5977
+ title: Action Attempt ID
5978
+ ---
5979
+ The ID of the action attempt.
5980
+ */
5981
+ action_attempt_id: string;
5982
+ status: 'pending';
5983
+ result: null;
5984
+ error: null;
5985
+ action_type: 'SET_THERMOSTAT_OFF';
5986
+ } | {
5987
+ /**
5988
+ ---
5989
+ title: Action Attempt ID
5990
+ ---
5991
+ The ID of the action attempt.
5992
+ */
5993
+ action_attempt_id: string;
5994
+ status: 'success';
5995
+ error: null;
5996
+ action_type: 'SET_THERMOSTAT_OFF';
5997
+ result: {};
5998
+ } | {
5999
+ /**
6000
+ ---
6001
+ title: Action Attempt ID
6002
+ ---
6003
+ The ID of the action attempt.
6004
+ */
6005
+ action_attempt_id: string;
6006
+ status: 'error';
6007
+ result: null;
6008
+ action_type: 'SET_THERMOSTAT_OFF';
5840
6009
  error: {
5841
6010
  type: string;
5842
6011
  message: string;
@@ -5844,419 +6013,507 @@ export interface Routes {
5844
6013
  };
5845
6014
  };
5846
6015
  };
5847
- '/noise_sensors/noise_thresholds/get': {
5848
- route: '/noise_sensors/noise_thresholds/get';
5849
- method: 'GET' | 'POST';
5850
- queryParams: {};
5851
- jsonBody: {};
5852
- commonParams: {
5853
- noise_threshold_id: string;
5854
- };
5855
- formData: {};
5856
- jsonResponse: {
5857
- noise_threshold: {
5858
- noise_threshold_id: string;
5859
- device_id: string;
5860
- name: string;
5861
- noise_threshold_nrs?: number | undefined;
5862
- starts_daily_at: string;
5863
- ends_daily_at: string;
5864
- noise_threshold_decibels: number;
5865
- };
5866
- };
5867
- };
5868
- '/noise_sensors/noise_thresholds/list': {
5869
- route: '/noise_sensors/noise_thresholds/list';
5870
- method: 'GET' | 'POST';
5871
- queryParams: {};
5872
- jsonBody: {};
5873
- commonParams: {
5874
- device_id: string;
5875
- is_programmed?: boolean | undefined;
5876
- };
5877
- formData: {};
5878
- jsonResponse: {
5879
- noise_thresholds: Array<{
5880
- noise_threshold_id: string;
5881
- device_id: string;
5882
- name: string;
5883
- noise_threshold_nrs?: number | undefined;
5884
- starts_daily_at: string;
5885
- ends_daily_at: string;
5886
- noise_threshold_decibels: number;
5887
- }>;
5888
- };
5889
- };
5890
- '/noise_sensors/noise_thresholds/update': {
5891
- route: '/noise_sensors/noise_thresholds/update';
5892
- method: 'PATCH' | 'POST' | 'PUT';
6016
+ '/locks/unlock_door': {
6017
+ route: '/locks/unlock_door';
6018
+ method: 'POST';
5893
6019
  queryParams: {};
5894
6020
  jsonBody: {
5895
- noise_threshold_id: string;
5896
6021
  device_id: string;
5897
6022
  sync?: boolean;
5898
- name?: string | undefined;
5899
- starts_daily_at?: string | undefined;
5900
- ends_daily_at?: string | undefined;
5901
- noise_threshold_decibels?: number | undefined;
5902
- noise_threshold_nrs?: number | undefined;
5903
6023
  };
5904
6024
  commonParams: {};
5905
6025
  formData: {};
5906
6026
  jsonResponse: {
5907
6027
  action_attempt: {
6028
+ /**
6029
+ ---
6030
+ title: Action Attempt ID
6031
+ ---
6032
+ The ID of the action attempt.
6033
+ */
6034
+ action_attempt_id: string;
6035
+ status: 'pending';
6036
+ result: null;
6037
+ error: null;
6038
+ action_type: 'LOCK_DOOR';
6039
+ } | {
6040
+ /**
6041
+ ---
6042
+ title: Action Attempt ID
6043
+ ---
6044
+ The ID of the action attempt.
6045
+ */
6046
+ action_attempt_id: string;
5908
6047
  status: 'success';
5909
- action_type: string;
6048
+ error: null;
6049
+ action_type: 'LOCK_DOOR';
6050
+ result: {};
6051
+ } | {
6052
+ /**
6053
+ ---
6054
+ title: Action Attempt ID
6055
+ ---
6056
+ The ID of the action attempt.
6057
+ */
5910
6058
  action_attempt_id: string;
5911
- result?: any;
6059
+ status: 'error';
6060
+ result: null;
6061
+ action_type: 'LOCK_DOOR';
6062
+ error: {
6063
+ type: string;
6064
+ message: string;
6065
+ };
6066
+ } | {
6067
+ /**
6068
+ ---
6069
+ title: Action Attempt ID
6070
+ ---
6071
+ The ID of the action attempt.
6072
+ */
6073
+ action_attempt_id: string;
6074
+ status: 'pending';
6075
+ result: null;
6076
+ error: null;
6077
+ action_type: 'UNLOCK_DOOR';
6078
+ } | {
6079
+ /**
6080
+ ---
6081
+ title: Action Attempt ID
6082
+ ---
6083
+ The ID of the action attempt.
6084
+ */
6085
+ action_attempt_id: string;
6086
+ status: 'success';
5912
6087
  error: null;
6088
+ action_type: 'UNLOCK_DOOR';
6089
+ result: {};
6090
+ } | {
6091
+ /**
6092
+ ---
6093
+ title: Action Attempt ID
6094
+ ---
6095
+ The ID of the action attempt.
6096
+ */
6097
+ action_attempt_id: string;
6098
+ status: 'error';
6099
+ result: null;
6100
+ action_type: 'UNLOCK_DOOR';
6101
+ error: {
6102
+ type: string;
6103
+ message: string;
6104
+ };
5913
6105
  } | {
6106
+ /**
6107
+ ---
6108
+ title: Action Attempt ID
6109
+ ---
6110
+ The ID of the action attempt.
6111
+ */
6112
+ action_attempt_id: string;
5914
6113
  status: 'pending';
5915
- action_type: string;
6114
+ result: null;
6115
+ error: null;
6116
+ action_type: 'RESET_SANDBOX_WORKSPACE';
6117
+ } | {
6118
+ /**
6119
+ ---
6120
+ title: Action Attempt ID
6121
+ ---
6122
+ The ID of the action attempt.
6123
+ */
6124
+ action_attempt_id: string;
6125
+ status: 'success';
6126
+ error: null;
6127
+ action_type: 'RESET_SANDBOX_WORKSPACE';
6128
+ result: {};
6129
+ } | {
6130
+ /**
6131
+ ---
6132
+ title: Action Attempt ID
6133
+ ---
6134
+ The ID of the action attempt.
6135
+ */
6136
+ action_attempt_id: string;
6137
+ status: 'error';
6138
+ result: null;
6139
+ action_type: 'RESET_SANDBOX_WORKSPACE';
6140
+ error: {
6141
+ type: string;
6142
+ message: string;
6143
+ };
6144
+ } | {
6145
+ /**
6146
+ ---
6147
+ title: Action Attempt ID
6148
+ ---
6149
+ The ID of the action attempt.
6150
+ */
5916
6151
  action_attempt_id: string;
6152
+ status: 'pending';
5917
6153
  result: null;
5918
6154
  error: null;
6155
+ action_type: 'SET_COOL';
6156
+ } | {
6157
+ /**
6158
+ ---
6159
+ title: Action Attempt ID
6160
+ ---
6161
+ The ID of the action attempt.
6162
+ */
6163
+ action_attempt_id: string;
6164
+ status: 'success';
6165
+ error: null;
6166
+ action_type: 'SET_COOL';
6167
+ result: {};
5919
6168
  } | {
6169
+ /**
6170
+ ---
6171
+ title: Action Attempt ID
6172
+ ---
6173
+ The ID of the action attempt.
6174
+ */
6175
+ action_attempt_id: string;
5920
6176
  status: 'error';
5921
- action_type: string;
6177
+ result: null;
6178
+ action_type: 'SET_COOL';
6179
+ error: {
6180
+ type: string;
6181
+ message: string;
6182
+ };
6183
+ } | {
6184
+ /**
6185
+ ---
6186
+ title: Action Attempt ID
6187
+ ---
6188
+ The ID of the action attempt.
6189
+ */
6190
+ action_attempt_id: string;
6191
+ status: 'pending';
6192
+ result: null;
6193
+ error: null;
6194
+ action_type: 'SET_HEAT';
6195
+ } | {
6196
+ /**
6197
+ ---
6198
+ title: Action Attempt ID
6199
+ ---
6200
+ The ID of the action attempt.
6201
+ */
6202
+ action_attempt_id: string;
6203
+ status: 'success';
6204
+ error: null;
6205
+ action_type: 'SET_HEAT';
6206
+ result: {};
6207
+ } | {
6208
+ /**
6209
+ ---
6210
+ title: Action Attempt ID
6211
+ ---
6212
+ The ID of the action attempt.
6213
+ */
5922
6214
  action_attempt_id: string;
6215
+ status: 'error';
5923
6216
  result: null;
6217
+ action_type: 'SET_HEAT';
5924
6218
  error: {
5925
6219
  type: string;
5926
6220
  message: string;
5927
6221
  };
5928
- };
5929
- };
5930
- };
5931
- '/noise_sensors/simulate/trigger_noise_threshold': {
5932
- route: '/noise_sensors/simulate/trigger_noise_threshold';
5933
- method: 'POST';
5934
- queryParams: {};
5935
- jsonBody: {
5936
- device_id: string;
5937
- };
5938
- commonParams: {};
5939
- formData: {};
5940
- jsonResponse: {};
5941
- };
5942
- '/phones/deactivate': {
5943
- route: '/phones/deactivate';
5944
- method: 'DELETE' | 'POST';
5945
- queryParams: {};
5946
- jsonBody: {
5947
- device_id: string;
6222
+ } | {
6223
+ /**
6224
+ ---
6225
+ title: Action Attempt ID
6226
+ ---
6227
+ The ID of the action attempt.
6228
+ */
6229
+ action_attempt_id: string;
6230
+ status: 'pending';
6231
+ result: null;
6232
+ error: null;
6233
+ action_type: 'SET_HEAT_COOL';
6234
+ } | {
6235
+ /**
6236
+ ---
6237
+ title: Action Attempt ID
6238
+ ---
6239
+ The ID of the action attempt.
6240
+ */
6241
+ action_attempt_id: string;
6242
+ status: 'success';
6243
+ error: null;
6244
+ action_type: 'SET_HEAT_COOL';
6245
+ result: {};
6246
+ } | {
6247
+ /**
6248
+ ---
6249
+ title: Action Attempt ID
6250
+ ---
6251
+ The ID of the action attempt.
6252
+ */
6253
+ action_attempt_id: string;
6254
+ status: 'error';
6255
+ result: null;
6256
+ action_type: 'SET_HEAT_COOL';
6257
+ error: {
6258
+ type: string;
6259
+ message: string;
6260
+ };
6261
+ } | {
6262
+ /**
6263
+ ---
6264
+ title: Action Attempt ID
6265
+ ---
6266
+ The ID of the action attempt.
6267
+ */
6268
+ action_attempt_id: string;
6269
+ status: 'pending';
6270
+ result: null;
6271
+ error: null;
6272
+ action_type: 'SET_FAN_MODE';
6273
+ } | {
6274
+ /**
6275
+ ---
6276
+ title: Action Attempt ID
6277
+ ---
6278
+ The ID of the action attempt.
6279
+ */
6280
+ action_attempt_id: string;
6281
+ status: 'success';
6282
+ error: null;
6283
+ action_type: 'SET_FAN_MODE';
6284
+ result: {};
6285
+ } | {
6286
+ /**
6287
+ ---
6288
+ title: Action Attempt ID
6289
+ ---
6290
+ The ID of the action attempt.
6291
+ */
6292
+ action_attempt_id: string;
6293
+ status: 'error';
6294
+ result: null;
6295
+ action_type: 'SET_FAN_MODE';
6296
+ error: {
6297
+ type: string;
6298
+ message: string;
6299
+ };
6300
+ } | {
6301
+ /**
6302
+ ---
6303
+ title: Action Attempt ID
6304
+ ---
6305
+ The ID of the action attempt.
6306
+ */
6307
+ action_attempt_id: string;
6308
+ status: 'pending';
6309
+ result: null;
6310
+ error: null;
6311
+ action_type: 'SET_THERMOSTAT_OFF';
6312
+ } | {
6313
+ /**
6314
+ ---
6315
+ title: Action Attempt ID
6316
+ ---
6317
+ The ID of the action attempt.
6318
+ */
6319
+ action_attempt_id: string;
6320
+ status: 'success';
6321
+ error: null;
6322
+ action_type: 'SET_THERMOSTAT_OFF';
6323
+ result: {};
6324
+ } | {
6325
+ /**
6326
+ ---
6327
+ title: Action Attempt ID
6328
+ ---
6329
+ The ID of the action attempt.
6330
+ */
6331
+ action_attempt_id: string;
6332
+ status: 'error';
6333
+ result: null;
6334
+ action_type: 'SET_THERMOSTAT_OFF';
6335
+ error: {
6336
+ type: string;
6337
+ message: string;
6338
+ };
6339
+ };
5948
6340
  };
5949
- commonParams: {};
5950
- formData: {};
5951
- jsonResponse: {};
5952
6341
  };
5953
- '/phones/list': {
5954
- route: '/phones/list';
6342
+ '/networks/get': {
6343
+ route: '/networks/get';
5955
6344
  method: 'GET' | 'POST';
5956
6345
  queryParams: {};
5957
6346
  jsonBody: {};
5958
6347
  commonParams: {
5959
- owner_user_identity_id?: string | undefined;
6348
+ network_id: string;
5960
6349
  };
5961
6350
  formData: {};
5962
6351
  jsonResponse: {
5963
- phones: Array<{
5964
- /** Unique identifier for the device. */
5965
- device_id: string;
5966
- device_type: 'android_phone' | 'ios_phone';
5967
- /** Optional nickname to describe the device, settable through Seam */
5968
- nickname?: string | undefined;
5969
- /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
5970
- display_name: string;
5971
- /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
5972
- capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
5973
- properties: {
5974
- assa_abloy_credential_service_metadata?: {
5975
- has_active_endpoint: boolean;
5976
- endpoints: Array<{
5977
- endpoint_id: string;
5978
- is_active: boolean;
5979
- }>;
5980
- } | undefined;
5981
- };
5982
- /** Location information for the device. */
5983
- location: {
5984
- /** Name of the device location. */
5985
- location_name?: string | undefined;
5986
- /** Time zone of the device location. */
5987
- timezone?: string | undefined;
5988
- } | null;
5989
- /** Unique identifier for the Seam workspace associated with the device. */
6352
+ network: {
6353
+ network_id: string;
5990
6354
  workspace_id: string;
5991
- /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
5992
- errors: Array<{
5993
- error_code: string;
5994
- message: string;
5995
- }>;
5996
- /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
5997
- warnings: Array<{
5998
- warning_code: string;
5999
- message: string;
6000
- }>;
6001
- /** Date and time at which the device object was created. */
6355
+ display_name: string;
6002
6356
  created_at: string;
6003
- /** Indicates whether Seam manages the device. */
6004
- is_managed: true;
6005
- custom_metadata: Record<string, string | boolean>;
6006
- can_remotely_unlock?: boolean | undefined;
6007
- can_remotely_lock?: boolean | undefined;
6008
- can_program_offline_access_codes?: boolean | undefined;
6009
- can_program_online_access_codes?: boolean | undefined;
6010
- can_simulate_removal?: boolean | undefined;
6011
- }>;
6357
+ };
6012
6358
  };
6013
6359
  };
6014
- '/phones/simulate/create_sandbox_phone': {
6015
- route: '/phones/simulate/create_sandbox_phone';
6360
+ '/networks/list': {
6361
+ route: '/networks/list';
6016
6362
  method: 'GET' | 'POST';
6017
6363
  queryParams: {};
6018
- jsonBody: {
6019
- custom_sdk_installation_id?: string | undefined;
6020
- user_identity_id: string;
6021
- phone_metadata?: {
6022
- operating_system?: 'android' | 'ios';
6023
- os_version?: string;
6024
- device_manufacturer?: string;
6025
- device_model?: string;
6026
- };
6027
- assa_abloy_metadata?: {
6028
- ble_capability?: boolean;
6029
- hce_capability?: boolean;
6030
- nfc_capability?: boolean;
6031
- application_version?: string;
6032
- seos_applet_version?: string;
6033
- seos_tsm_endpoint_id?: number;
6034
- };
6035
- };
6364
+ jsonBody: {};
6036
6365
  commonParams: {};
6037
6366
  formData: {};
6038
6367
  jsonResponse: {
6039
- phone: {
6040
- /** Unique identifier for the device. */
6041
- device_id: string;
6042
- device_type: 'android_phone' | 'ios_phone';
6043
- /** Optional nickname to describe the device, settable through Seam */
6044
- nickname?: string | undefined;
6045
- /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
6046
- display_name: string;
6047
- /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
6048
- capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
6049
- properties: {
6050
- assa_abloy_credential_service_metadata?: {
6051
- has_active_endpoint: boolean;
6052
- endpoints: Array<{
6053
- endpoint_id: string;
6054
- is_active: boolean;
6055
- }>;
6056
- } | undefined;
6057
- };
6058
- /** Location information for the device. */
6059
- location: {
6060
- /** Name of the device location. */
6061
- location_name?: string | undefined;
6062
- /** Time zone of the device location. */
6063
- timezone?: string | undefined;
6064
- } | null;
6065
- /** Unique identifier for the Seam workspace associated with the device. */
6368
+ networks: Array<{
6369
+ network_id: string;
6066
6370
  workspace_id: string;
6067
- /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
6068
- errors: Array<{
6069
- error_code: string;
6070
- message: string;
6071
- }>;
6072
- /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
6073
- warnings: Array<{
6074
- warning_code: string;
6075
- message: string;
6076
- }>;
6077
- /** Date and time at which the device object was created. */
6371
+ display_name: string;
6078
6372
  created_at: string;
6079
- /** Indicates whether Seam manages the device. */
6080
- is_managed: true;
6081
- custom_metadata: Record<string, string | boolean>;
6082
- can_remotely_unlock?: boolean | undefined;
6083
- can_remotely_lock?: boolean | undefined;
6084
- can_program_offline_access_codes?: boolean | undefined;
6085
- can_program_online_access_codes?: boolean | undefined;
6086
- can_simulate_removal?: boolean | undefined;
6087
- };
6373
+ }>;
6088
6374
  };
6089
6375
  };
6090
- '/thermostats/climate_setting_schedules/create': {
6091
- route: '/thermostats/climate_setting_schedules/create';
6376
+ '/noise_sensors/noise_thresholds/create': {
6377
+ route: '/noise_sensors/noise_thresholds/create';
6092
6378
  method: 'POST';
6093
6379
  queryParams: {};
6094
6380
  jsonBody: {
6095
- schedule_type?: 'time_bound';
6096
6381
  device_id: string;
6382
+ sync?: boolean;
6097
6383
  name?: string | undefined;
6098
- schedule_starts_at: string;
6099
- schedule_ends_at: string;
6100
- automatic_heating_enabled?: boolean | undefined;
6101
- automatic_cooling_enabled?: boolean | undefined;
6102
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6103
- cooling_set_point_celsius?: (number | undefined) | undefined;
6104
- heating_set_point_celsius?: (number | undefined) | undefined;
6105
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6106
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6107
- manual_override_allowed?: boolean | undefined;
6384
+ starts_daily_at: string;
6385
+ ends_daily_at: string;
6386
+ noise_threshold_decibels?: number | undefined;
6387
+ noise_threshold_nrs?: number | undefined;
6108
6388
  };
6109
6389
  commonParams: {};
6110
6390
  formData: {};
6111
6391
  jsonResponse: {
6112
- climate_setting_schedule: {
6113
- climate_setting_schedule_id: string;
6114
- schedule_type: 'time_bound';
6115
- device_id: string;
6116
- name?: string | undefined;
6117
- schedule_starts_at: string;
6118
- schedule_ends_at: string;
6119
- created_at: string;
6120
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6121
- errors?: any;
6122
- automatic_heating_enabled?: boolean | undefined;
6123
- automatic_cooling_enabled?: boolean | undefined;
6124
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6125
- cooling_set_point_celsius?: (number | undefined) | undefined;
6126
- heating_set_point_celsius?: (number | undefined) | undefined;
6127
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6128
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6129
- manual_override_allowed?: boolean | undefined;
6392
+ action_attempt: {
6393
+ status: 'success';
6394
+ action_type: string;
6395
+ action_attempt_id: string;
6396
+ result?: any;
6397
+ error: null;
6398
+ } | {
6399
+ status: 'pending';
6400
+ action_type: string;
6401
+ action_attempt_id: string;
6402
+ result: null;
6403
+ error: null;
6404
+ } | {
6405
+ status: 'error';
6406
+ action_type: string;
6407
+ action_attempt_id: string;
6408
+ result: null;
6409
+ error: {
6410
+ type: string;
6411
+ message: string;
6412
+ };
6413
+ };
6414
+ noise_threshold: {
6415
+ noise_threshold_id: string;
6416
+ device_id: string;
6417
+ name: string;
6418
+ noise_threshold_nrs?: number | undefined;
6419
+ starts_daily_at: string;
6420
+ ends_daily_at: string;
6421
+ noise_threshold_decibels: number;
6130
6422
  };
6131
6423
  };
6132
6424
  };
6133
- '/thermostats/climate_setting_schedules/delete': {
6134
- route: '/thermostats/climate_setting_schedules/delete';
6135
- method: 'DELETE' | 'POST' | 'PUT';
6425
+ '/noise_sensors/noise_thresholds/delete': {
6426
+ route: '/noise_sensors/noise_thresholds/delete';
6427
+ method: 'DELETE' | 'POST';
6136
6428
  queryParams: {};
6137
- jsonBody: {};
6138
- commonParams: {
6139
- climate_setting_schedule_id: string;
6429
+ jsonBody: {
6430
+ noise_threshold_id: string;
6431
+ device_id: string;
6432
+ sync?: boolean;
6140
6433
  };
6434
+ commonParams: {};
6141
6435
  formData: {};
6142
- jsonResponse: {};
6436
+ jsonResponse: {
6437
+ action_attempt: {
6438
+ status: 'success';
6439
+ action_type: string;
6440
+ action_attempt_id: string;
6441
+ result?: any;
6442
+ error: null;
6443
+ } | {
6444
+ status: 'pending';
6445
+ action_type: string;
6446
+ action_attempt_id: string;
6447
+ result: null;
6448
+ error: null;
6449
+ } | {
6450
+ status: 'error';
6451
+ action_type: string;
6452
+ action_attempt_id: string;
6453
+ result: null;
6454
+ error: {
6455
+ type: string;
6456
+ message: string;
6457
+ };
6458
+ };
6459
+ };
6143
6460
  };
6144
- '/thermostats/climate_setting_schedules/get': {
6145
- route: '/thermostats/climate_setting_schedules/get';
6461
+ '/noise_sensors/noise_thresholds/get': {
6462
+ route: '/noise_sensors/noise_thresholds/get';
6146
6463
  method: 'GET' | 'POST';
6147
6464
  queryParams: {};
6148
6465
  jsonBody: {};
6149
6466
  commonParams: {
6150
- climate_setting_schedule_id?: string | undefined;
6151
- device_id?: string | undefined;
6467
+ noise_threshold_id: string;
6152
6468
  };
6153
6469
  formData: {};
6154
6470
  jsonResponse: {
6155
- climate_setting_schedule: {
6156
- climate_setting_schedule_id: string;
6157
- schedule_type: 'time_bound';
6471
+ noise_threshold: {
6472
+ noise_threshold_id: string;
6158
6473
  device_id: string;
6159
- name?: string | undefined;
6160
- schedule_starts_at: string;
6161
- schedule_ends_at: string;
6162
- created_at: string;
6163
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6164
- errors?: any;
6165
- automatic_heating_enabled?: boolean | undefined;
6166
- automatic_cooling_enabled?: boolean | undefined;
6167
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6168
- cooling_set_point_celsius?: (number | undefined) | undefined;
6169
- heating_set_point_celsius?: (number | undefined) | undefined;
6170
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6171
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6172
- manual_override_allowed?: boolean | undefined;
6474
+ name: string;
6475
+ noise_threshold_nrs?: number | undefined;
6476
+ starts_daily_at: string;
6477
+ ends_daily_at: string;
6478
+ noise_threshold_decibels: number;
6173
6479
  };
6174
6480
  };
6175
6481
  };
6176
- '/thermostats/climate_setting_schedules/list': {
6177
- route: '/thermostats/climate_setting_schedules/list';
6482
+ '/noise_sensors/noise_thresholds/list': {
6483
+ route: '/noise_sensors/noise_thresholds/list';
6178
6484
  method: 'GET' | 'POST';
6179
6485
  queryParams: {};
6180
6486
  jsonBody: {};
6181
6487
  commonParams: {
6182
6488
  device_id: string;
6183
- user_identifier_key?: string | undefined;
6489
+ is_programmed?: boolean | undefined;
6184
6490
  };
6185
6491
  formData: {};
6186
6492
  jsonResponse: {
6187
- climate_setting_schedules: Array<{
6188
- climate_setting_schedule_id: string;
6189
- schedule_type: 'time_bound';
6493
+ noise_thresholds: Array<{
6494
+ noise_threshold_id: string;
6190
6495
  device_id: string;
6191
- name?: string | undefined;
6192
- schedule_starts_at: string;
6193
- schedule_ends_at: string;
6194
- created_at: string;
6195
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6196
- errors?: any;
6197
- automatic_heating_enabled?: boolean | undefined;
6198
- automatic_cooling_enabled?: boolean | undefined;
6199
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6200
- cooling_set_point_celsius?: (number | undefined) | undefined;
6201
- heating_set_point_celsius?: (number | undefined) | undefined;
6202
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6203
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6204
- manual_override_allowed?: boolean | undefined;
6496
+ name: string;
6497
+ noise_threshold_nrs?: number | undefined;
6498
+ starts_daily_at: string;
6499
+ ends_daily_at: string;
6500
+ noise_threshold_decibels: number;
6205
6501
  }>;
6206
6502
  };
6207
6503
  };
6208
- '/thermostats/climate_setting_schedules/update': {
6209
- route: '/thermostats/climate_setting_schedules/update';
6504
+ '/noise_sensors/noise_thresholds/update': {
6505
+ route: '/noise_sensors/noise_thresholds/update';
6210
6506
  method: 'PATCH' | 'POST' | 'PUT';
6211
6507
  queryParams: {};
6212
6508
  jsonBody: {
6213
- climate_setting_schedule_id: string;
6214
- schedule_type?: 'time_bound';
6215
- name?: string | undefined;
6216
- schedule_starts_at?: string | undefined;
6217
- schedule_ends_at?: string | undefined;
6218
- automatic_heating_enabled?: boolean | undefined;
6219
- automatic_cooling_enabled?: boolean | undefined;
6220
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6221
- cooling_set_point_celsius?: (number | undefined) | undefined;
6222
- heating_set_point_celsius?: (number | undefined) | undefined;
6223
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6224
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6225
- manual_override_allowed?: boolean | undefined;
6226
- };
6227
- commonParams: {};
6228
- formData: {};
6229
- jsonResponse: {
6230
- climate_setting_schedule: {
6231
- climate_setting_schedule_id: string;
6232
- schedule_type: 'time_bound';
6233
- device_id: string;
6234
- name?: string | undefined;
6235
- schedule_starts_at: string;
6236
- schedule_ends_at: string;
6237
- created_at: string;
6238
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6239
- errors?: any;
6240
- automatic_heating_enabled?: boolean | undefined;
6241
- automatic_cooling_enabled?: boolean | undefined;
6242
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6243
- cooling_set_point_celsius?: (number | undefined) | undefined;
6244
- heating_set_point_celsius?: (number | undefined) | undefined;
6245
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6246
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
6247
- manual_override_allowed?: boolean | undefined;
6248
- };
6249
- };
6250
- };
6251
- '/thermostats/cool': {
6252
- route: '/thermostats/cool';
6253
- method: 'POST';
6254
- queryParams: {};
6255
- jsonBody: {
6509
+ noise_threshold_id: string;
6256
6510
  device_id: string;
6257
- cooling_set_point_celsius?: number | undefined;
6258
- cooling_set_point_fahrenheit?: number | undefined;
6259
6511
  sync?: boolean;
6512
+ name?: string | undefined;
6513
+ starts_daily_at?: string | undefined;
6514
+ ends_daily_at?: string | undefined;
6515
+ noise_threshold_decibels?: number | undefined;
6516
+ noise_threshold_nrs?: number | undefined;
6260
6517
  };
6261
6518
  commonParams: {};
6262
6519
  formData: {};
@@ -6285,55 +6542,703 @@ export interface Routes {
6285
6542
  };
6286
6543
  };
6287
6544
  };
6288
- '/thermostats/get': {
6289
- route: '/thermostats/get';
6545
+ '/noise_sensors/simulate/trigger_noise_threshold': {
6546
+ route: '/noise_sensors/simulate/trigger_noise_threshold';
6547
+ method: 'POST';
6548
+ queryParams: {};
6549
+ jsonBody: {
6550
+ device_id: string;
6551
+ };
6552
+ commonParams: {};
6553
+ formData: {};
6554
+ jsonResponse: {};
6555
+ };
6556
+ '/phones/deactivate': {
6557
+ route: '/phones/deactivate';
6558
+ method: 'DELETE' | 'POST';
6559
+ queryParams: {};
6560
+ jsonBody: {
6561
+ device_id: string;
6562
+ };
6563
+ commonParams: {};
6564
+ formData: {};
6565
+ jsonResponse: {};
6566
+ };
6567
+ '/phones/list': {
6568
+ route: '/phones/list';
6290
6569
  method: 'GET' | 'POST';
6291
6570
  queryParams: {};
6292
6571
  jsonBody: {};
6293
6572
  commonParams: {
6294
- device_id?: string | undefined;
6295
- name?: string | undefined;
6573
+ owner_user_identity_id?: string | undefined;
6296
6574
  };
6297
6575
  formData: {};
6298
6576
  jsonResponse: {
6299
- thermostat: {
6577
+ phones: Array<{
6300
6578
  /** Unique identifier for the device. */
6301
6579
  device_id: string;
6302
- /** Type of the device. */
6303
- 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' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone');
6580
+ device_type: 'android_phone' | 'ios_phone';
6304
6581
  /** Optional nickname to describe the device, settable through Seam */
6305
6582
  nickname?: string | undefined;
6306
6583
  /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
6307
6584
  display_name: string;
6308
6585
  /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
6309
6586
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
6310
- /** Properties of the device. */
6311
- properties: (({
6312
- /** Indicates whether the device is online. */
6313
- online: boolean;
6314
- /**
6315
- ---
6316
- deprecated: use device.display_name instead
6317
- ---
6318
- Name of the device.
6319
- */
6320
- name: string;
6321
- /** Represents the accessory keypad state. */
6322
- accessory_keypad?: {
6323
- /** Indicates if the accessory_keypad is connected to the device. */
6324
- is_connected: boolean;
6325
- /** Indicates if the keypad battery properties. */
6326
- battery?: {
6327
- level: number;
6328
- } | undefined;
6587
+ properties: {
6588
+ assa_abloy_credential_service_metadata?: {
6589
+ has_active_endpoint: boolean;
6590
+ endpoints: Array<{
6591
+ endpoint_id: string;
6592
+ is_active: boolean;
6593
+ }>;
6329
6594
  } | undefined;
6330
- appearance: {
6331
- /** Name of the device as seen from the provider API and application, not settable through Seam. */
6332
- name: string;
6333
- };
6334
- model: {
6335
- /** Indicates whether the device can connect a accessory keypad. */
6336
- can_connect_accessory_keypad?: boolean | undefined;
6595
+ };
6596
+ /** Location information for the device. */
6597
+ location: {
6598
+ /** Name of the device location. */
6599
+ location_name?: string | undefined;
6600
+ /** Time zone of the device location. */
6601
+ timezone?: string | undefined;
6602
+ } | null;
6603
+ /** Unique identifier for the Seam workspace associated with the device. */
6604
+ workspace_id: string;
6605
+ /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
6606
+ errors: Array<{
6607
+ error_code: string;
6608
+ message: string;
6609
+ }>;
6610
+ /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
6611
+ warnings: Array<{
6612
+ warning_code: string;
6613
+ message: string;
6614
+ }>;
6615
+ /** Date and time at which the device object was created. */
6616
+ created_at: string;
6617
+ /** Indicates whether Seam manages the device. */
6618
+ is_managed: true;
6619
+ custom_metadata: Record<string, string | boolean>;
6620
+ can_remotely_unlock?: boolean | undefined;
6621
+ can_remotely_lock?: boolean | undefined;
6622
+ can_program_offline_access_codes?: boolean | undefined;
6623
+ can_program_online_access_codes?: boolean | undefined;
6624
+ can_simulate_removal?: boolean | undefined;
6625
+ }>;
6626
+ };
6627
+ };
6628
+ '/phones/simulate/create_sandbox_phone': {
6629
+ route: '/phones/simulate/create_sandbox_phone';
6630
+ method: 'GET' | 'POST';
6631
+ queryParams: {};
6632
+ jsonBody: {
6633
+ custom_sdk_installation_id?: string | undefined;
6634
+ user_identity_id: string;
6635
+ phone_metadata?: {
6636
+ operating_system?: 'android' | 'ios';
6637
+ os_version?: string;
6638
+ device_manufacturer?: string;
6639
+ device_model?: string;
6640
+ };
6641
+ assa_abloy_metadata?: {
6642
+ ble_capability?: boolean;
6643
+ hce_capability?: boolean;
6644
+ nfc_capability?: boolean;
6645
+ application_version?: string;
6646
+ seos_applet_version?: string;
6647
+ seos_tsm_endpoint_id?: number;
6648
+ };
6649
+ };
6650
+ commonParams: {};
6651
+ formData: {};
6652
+ jsonResponse: {
6653
+ phone: {
6654
+ /** Unique identifier for the device. */
6655
+ device_id: string;
6656
+ device_type: 'android_phone' | 'ios_phone';
6657
+ /** Optional nickname to describe the device, settable through Seam */
6658
+ nickname?: string | undefined;
6659
+ /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
6660
+ display_name: string;
6661
+ /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
6662
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
6663
+ properties: {
6664
+ assa_abloy_credential_service_metadata?: {
6665
+ has_active_endpoint: boolean;
6666
+ endpoints: Array<{
6667
+ endpoint_id: string;
6668
+ is_active: boolean;
6669
+ }>;
6670
+ } | undefined;
6671
+ };
6672
+ /** Location information for the device. */
6673
+ location: {
6674
+ /** Name of the device location. */
6675
+ location_name?: string | undefined;
6676
+ /** Time zone of the device location. */
6677
+ timezone?: string | undefined;
6678
+ } | null;
6679
+ /** Unique identifier for the Seam workspace associated with the device. */
6680
+ workspace_id: string;
6681
+ /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
6682
+ errors: Array<{
6683
+ error_code: string;
6684
+ message: string;
6685
+ }>;
6686
+ /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
6687
+ warnings: Array<{
6688
+ warning_code: string;
6689
+ message: string;
6690
+ }>;
6691
+ /** Date and time at which the device object was created. */
6692
+ created_at: string;
6693
+ /** Indicates whether Seam manages the device. */
6694
+ is_managed: true;
6695
+ custom_metadata: Record<string, string | boolean>;
6696
+ can_remotely_unlock?: boolean | undefined;
6697
+ can_remotely_lock?: boolean | undefined;
6698
+ can_program_offline_access_codes?: boolean | undefined;
6699
+ can_program_online_access_codes?: boolean | undefined;
6700
+ can_simulate_removal?: boolean | undefined;
6701
+ };
6702
+ };
6703
+ };
6704
+ '/thermostats/climate_setting_schedules/create': {
6705
+ route: '/thermostats/climate_setting_schedules/create';
6706
+ method: 'POST';
6707
+ queryParams: {};
6708
+ jsonBody: {
6709
+ schedule_type?: 'time_bound';
6710
+ device_id: string;
6711
+ name?: string | undefined;
6712
+ schedule_starts_at: string;
6713
+ schedule_ends_at: string;
6714
+ automatic_heating_enabled?: boolean | undefined;
6715
+ automatic_cooling_enabled?: boolean | undefined;
6716
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6717
+ cooling_set_point_celsius?: (number | undefined) | undefined;
6718
+ heating_set_point_celsius?: (number | undefined) | undefined;
6719
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6720
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
6721
+ manual_override_allowed?: boolean | undefined;
6722
+ };
6723
+ commonParams: {};
6724
+ formData: {};
6725
+ jsonResponse: {
6726
+ climate_setting_schedule: {
6727
+ climate_setting_schedule_id: string;
6728
+ schedule_type: 'time_bound';
6729
+ device_id: string;
6730
+ name?: string | undefined;
6731
+ schedule_starts_at: string;
6732
+ schedule_ends_at: string;
6733
+ created_at: string;
6734
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6735
+ errors?: any;
6736
+ automatic_heating_enabled?: boolean | undefined;
6737
+ automatic_cooling_enabled?: boolean | undefined;
6738
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6739
+ cooling_set_point_celsius?: (number | undefined) | undefined;
6740
+ heating_set_point_celsius?: (number | undefined) | undefined;
6741
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6742
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
6743
+ manual_override_allowed?: boolean | undefined;
6744
+ };
6745
+ };
6746
+ };
6747
+ '/thermostats/climate_setting_schedules/delete': {
6748
+ route: '/thermostats/climate_setting_schedules/delete';
6749
+ method: 'DELETE' | 'POST' | 'PUT';
6750
+ queryParams: {};
6751
+ jsonBody: {};
6752
+ commonParams: {
6753
+ climate_setting_schedule_id: string;
6754
+ };
6755
+ formData: {};
6756
+ jsonResponse: {};
6757
+ };
6758
+ '/thermostats/climate_setting_schedules/get': {
6759
+ route: '/thermostats/climate_setting_schedules/get';
6760
+ method: 'GET' | 'POST';
6761
+ queryParams: {};
6762
+ jsonBody: {};
6763
+ commonParams: {
6764
+ climate_setting_schedule_id?: string | undefined;
6765
+ device_id?: string | undefined;
6766
+ };
6767
+ formData: {};
6768
+ jsonResponse: {
6769
+ climate_setting_schedule: {
6770
+ climate_setting_schedule_id: string;
6771
+ schedule_type: 'time_bound';
6772
+ device_id: string;
6773
+ name?: string | undefined;
6774
+ schedule_starts_at: string;
6775
+ schedule_ends_at: string;
6776
+ created_at: string;
6777
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6778
+ errors?: any;
6779
+ automatic_heating_enabled?: boolean | undefined;
6780
+ automatic_cooling_enabled?: boolean | undefined;
6781
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6782
+ cooling_set_point_celsius?: (number | undefined) | undefined;
6783
+ heating_set_point_celsius?: (number | undefined) | undefined;
6784
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6785
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
6786
+ manual_override_allowed?: boolean | undefined;
6787
+ };
6788
+ };
6789
+ };
6790
+ '/thermostats/climate_setting_schedules/list': {
6791
+ route: '/thermostats/climate_setting_schedules/list';
6792
+ method: 'GET' | 'POST';
6793
+ queryParams: {};
6794
+ jsonBody: {};
6795
+ commonParams: {
6796
+ device_id: string;
6797
+ user_identifier_key?: string | undefined;
6798
+ };
6799
+ formData: {};
6800
+ jsonResponse: {
6801
+ climate_setting_schedules: Array<{
6802
+ climate_setting_schedule_id: string;
6803
+ schedule_type: 'time_bound';
6804
+ device_id: string;
6805
+ name?: string | undefined;
6806
+ schedule_starts_at: string;
6807
+ schedule_ends_at: string;
6808
+ created_at: string;
6809
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6810
+ errors?: any;
6811
+ automatic_heating_enabled?: boolean | undefined;
6812
+ automatic_cooling_enabled?: boolean | undefined;
6813
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6814
+ cooling_set_point_celsius?: (number | undefined) | undefined;
6815
+ heating_set_point_celsius?: (number | undefined) | undefined;
6816
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6817
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
6818
+ manual_override_allowed?: boolean | undefined;
6819
+ }>;
6820
+ };
6821
+ };
6822
+ '/thermostats/climate_setting_schedules/update': {
6823
+ route: '/thermostats/climate_setting_schedules/update';
6824
+ method: 'PATCH' | 'POST' | 'PUT';
6825
+ queryParams: {};
6826
+ jsonBody: {
6827
+ climate_setting_schedule_id: string;
6828
+ schedule_type?: 'time_bound';
6829
+ name?: string | undefined;
6830
+ schedule_starts_at?: string | undefined;
6831
+ schedule_ends_at?: string | undefined;
6832
+ automatic_heating_enabled?: boolean | undefined;
6833
+ automatic_cooling_enabled?: boolean | undefined;
6834
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6835
+ cooling_set_point_celsius?: (number | undefined) | undefined;
6836
+ heating_set_point_celsius?: (number | undefined) | undefined;
6837
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6838
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
6839
+ manual_override_allowed?: boolean | undefined;
6840
+ };
6841
+ commonParams: {};
6842
+ formData: {};
6843
+ jsonResponse: {
6844
+ climate_setting_schedule: {
6845
+ climate_setting_schedule_id: string;
6846
+ schedule_type: 'time_bound';
6847
+ device_id: string;
6848
+ name?: string | undefined;
6849
+ schedule_starts_at: string;
6850
+ schedule_ends_at: string;
6851
+ created_at: string;
6852
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6853
+ errors?: any;
6854
+ automatic_heating_enabled?: boolean | undefined;
6855
+ automatic_cooling_enabled?: boolean | undefined;
6856
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
6857
+ cooling_set_point_celsius?: (number | undefined) | undefined;
6858
+ heating_set_point_celsius?: (number | undefined) | undefined;
6859
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
6860
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
6861
+ manual_override_allowed?: boolean | undefined;
6862
+ };
6863
+ };
6864
+ };
6865
+ '/thermostats/cool': {
6866
+ route: '/thermostats/cool';
6867
+ method: 'POST';
6868
+ queryParams: {};
6869
+ jsonBody: {
6870
+ device_id: string;
6871
+ cooling_set_point_celsius?: number | undefined;
6872
+ cooling_set_point_fahrenheit?: number | undefined;
6873
+ sync?: boolean;
6874
+ };
6875
+ commonParams: {};
6876
+ formData: {};
6877
+ jsonResponse: {
6878
+ action_attempt: {
6879
+ /**
6880
+ ---
6881
+ title: Action Attempt ID
6882
+ ---
6883
+ The ID of the action attempt.
6884
+ */
6885
+ action_attempt_id: string;
6886
+ status: 'pending';
6887
+ result: null;
6888
+ error: null;
6889
+ action_type: 'LOCK_DOOR';
6890
+ } | {
6891
+ /**
6892
+ ---
6893
+ title: Action Attempt ID
6894
+ ---
6895
+ The ID of the action attempt.
6896
+ */
6897
+ action_attempt_id: string;
6898
+ status: 'success';
6899
+ error: null;
6900
+ action_type: 'LOCK_DOOR';
6901
+ result: {};
6902
+ } | {
6903
+ /**
6904
+ ---
6905
+ title: Action Attempt ID
6906
+ ---
6907
+ The ID of the action attempt.
6908
+ */
6909
+ action_attempt_id: string;
6910
+ status: 'error';
6911
+ result: null;
6912
+ action_type: 'LOCK_DOOR';
6913
+ error: {
6914
+ type: string;
6915
+ message: string;
6916
+ };
6917
+ } | {
6918
+ /**
6919
+ ---
6920
+ title: Action Attempt ID
6921
+ ---
6922
+ The ID of the action attempt.
6923
+ */
6924
+ action_attempt_id: string;
6925
+ status: 'pending';
6926
+ result: null;
6927
+ error: null;
6928
+ action_type: 'UNLOCK_DOOR';
6929
+ } | {
6930
+ /**
6931
+ ---
6932
+ title: Action Attempt ID
6933
+ ---
6934
+ The ID of the action attempt.
6935
+ */
6936
+ action_attempt_id: string;
6937
+ status: 'success';
6938
+ error: null;
6939
+ action_type: 'UNLOCK_DOOR';
6940
+ result: {};
6941
+ } | {
6942
+ /**
6943
+ ---
6944
+ title: Action Attempt ID
6945
+ ---
6946
+ The ID of the action attempt.
6947
+ */
6948
+ action_attempt_id: string;
6949
+ status: 'error';
6950
+ result: null;
6951
+ action_type: 'UNLOCK_DOOR';
6952
+ error: {
6953
+ type: string;
6954
+ message: string;
6955
+ };
6956
+ } | {
6957
+ /**
6958
+ ---
6959
+ title: Action Attempt ID
6960
+ ---
6961
+ The ID of the action attempt.
6962
+ */
6963
+ action_attempt_id: string;
6964
+ status: 'pending';
6965
+ result: null;
6966
+ error: null;
6967
+ action_type: 'RESET_SANDBOX_WORKSPACE';
6968
+ } | {
6969
+ /**
6970
+ ---
6971
+ title: Action Attempt ID
6972
+ ---
6973
+ The ID of the action attempt.
6974
+ */
6975
+ action_attempt_id: string;
6976
+ status: 'success';
6977
+ error: null;
6978
+ action_type: 'RESET_SANDBOX_WORKSPACE';
6979
+ result: {};
6980
+ } | {
6981
+ /**
6982
+ ---
6983
+ title: Action Attempt ID
6984
+ ---
6985
+ The ID of the action attempt.
6986
+ */
6987
+ action_attempt_id: string;
6988
+ status: 'error';
6989
+ result: null;
6990
+ action_type: 'RESET_SANDBOX_WORKSPACE';
6991
+ error: {
6992
+ type: string;
6993
+ message: string;
6994
+ };
6995
+ } | {
6996
+ /**
6997
+ ---
6998
+ title: Action Attempt ID
6999
+ ---
7000
+ The ID of the action attempt.
7001
+ */
7002
+ action_attempt_id: string;
7003
+ status: 'pending';
7004
+ result: null;
7005
+ error: null;
7006
+ action_type: 'SET_COOL';
7007
+ } | {
7008
+ /**
7009
+ ---
7010
+ title: Action Attempt ID
7011
+ ---
7012
+ The ID of the action attempt.
7013
+ */
7014
+ action_attempt_id: string;
7015
+ status: 'success';
7016
+ error: null;
7017
+ action_type: 'SET_COOL';
7018
+ result: {};
7019
+ } | {
7020
+ /**
7021
+ ---
7022
+ title: Action Attempt ID
7023
+ ---
7024
+ The ID of the action attempt.
7025
+ */
7026
+ action_attempt_id: string;
7027
+ status: 'error';
7028
+ result: null;
7029
+ action_type: 'SET_COOL';
7030
+ error: {
7031
+ type: string;
7032
+ message: string;
7033
+ };
7034
+ } | {
7035
+ /**
7036
+ ---
7037
+ title: Action Attempt ID
7038
+ ---
7039
+ The ID of the action attempt.
7040
+ */
7041
+ action_attempt_id: string;
7042
+ status: 'pending';
7043
+ result: null;
7044
+ error: null;
7045
+ action_type: 'SET_HEAT';
7046
+ } | {
7047
+ /**
7048
+ ---
7049
+ title: Action Attempt ID
7050
+ ---
7051
+ The ID of the action attempt.
7052
+ */
7053
+ action_attempt_id: string;
7054
+ status: 'success';
7055
+ error: null;
7056
+ action_type: 'SET_HEAT';
7057
+ result: {};
7058
+ } | {
7059
+ /**
7060
+ ---
7061
+ title: Action Attempt ID
7062
+ ---
7063
+ The ID of the action attempt.
7064
+ */
7065
+ action_attempt_id: string;
7066
+ status: 'error';
7067
+ result: null;
7068
+ action_type: 'SET_HEAT';
7069
+ error: {
7070
+ type: string;
7071
+ message: string;
7072
+ };
7073
+ } | {
7074
+ /**
7075
+ ---
7076
+ title: Action Attempt ID
7077
+ ---
7078
+ The ID of the action attempt.
7079
+ */
7080
+ action_attempt_id: string;
7081
+ status: 'pending';
7082
+ result: null;
7083
+ error: null;
7084
+ action_type: 'SET_HEAT_COOL';
7085
+ } | {
7086
+ /**
7087
+ ---
7088
+ title: Action Attempt ID
7089
+ ---
7090
+ The ID of the action attempt.
7091
+ */
7092
+ action_attempt_id: string;
7093
+ status: 'success';
7094
+ error: null;
7095
+ action_type: 'SET_HEAT_COOL';
7096
+ result: {};
7097
+ } | {
7098
+ /**
7099
+ ---
7100
+ title: Action Attempt ID
7101
+ ---
7102
+ The ID of the action attempt.
7103
+ */
7104
+ action_attempt_id: string;
7105
+ status: 'error';
7106
+ result: null;
7107
+ action_type: 'SET_HEAT_COOL';
7108
+ error: {
7109
+ type: string;
7110
+ message: string;
7111
+ };
7112
+ } | {
7113
+ /**
7114
+ ---
7115
+ title: Action Attempt ID
7116
+ ---
7117
+ The ID of the action attempt.
7118
+ */
7119
+ action_attempt_id: string;
7120
+ status: 'pending';
7121
+ result: null;
7122
+ error: null;
7123
+ action_type: 'SET_FAN_MODE';
7124
+ } | {
7125
+ /**
7126
+ ---
7127
+ title: Action Attempt ID
7128
+ ---
7129
+ The ID of the action attempt.
7130
+ */
7131
+ action_attempt_id: string;
7132
+ status: 'success';
7133
+ error: null;
7134
+ action_type: 'SET_FAN_MODE';
7135
+ result: {};
7136
+ } | {
7137
+ /**
7138
+ ---
7139
+ title: Action Attempt ID
7140
+ ---
7141
+ The ID of the action attempt.
7142
+ */
7143
+ action_attempt_id: string;
7144
+ status: 'error';
7145
+ result: null;
7146
+ action_type: 'SET_FAN_MODE';
7147
+ error: {
7148
+ type: string;
7149
+ message: string;
7150
+ };
7151
+ } | {
7152
+ /**
7153
+ ---
7154
+ title: Action Attempt ID
7155
+ ---
7156
+ The ID of the action attempt.
7157
+ */
7158
+ action_attempt_id: string;
7159
+ status: 'pending';
7160
+ result: null;
7161
+ error: null;
7162
+ action_type: 'SET_THERMOSTAT_OFF';
7163
+ } | {
7164
+ /**
7165
+ ---
7166
+ title: Action Attempt ID
7167
+ ---
7168
+ The ID of the action attempt.
7169
+ */
7170
+ action_attempt_id: string;
7171
+ status: 'success';
7172
+ error: null;
7173
+ action_type: 'SET_THERMOSTAT_OFF';
7174
+ result: {};
7175
+ } | {
7176
+ /**
7177
+ ---
7178
+ title: Action Attempt ID
7179
+ ---
7180
+ The ID of the action attempt.
7181
+ */
7182
+ action_attempt_id: string;
7183
+ status: 'error';
7184
+ result: null;
7185
+ action_type: 'SET_THERMOSTAT_OFF';
7186
+ error: {
7187
+ type: string;
7188
+ message: string;
7189
+ };
7190
+ };
7191
+ };
7192
+ };
7193
+ '/thermostats/get': {
7194
+ route: '/thermostats/get';
7195
+ method: 'GET' | 'POST';
7196
+ queryParams: {};
7197
+ jsonBody: {};
7198
+ commonParams: {
7199
+ device_id?: string | undefined;
7200
+ name?: string | undefined;
7201
+ };
7202
+ formData: {};
7203
+ jsonResponse: {
7204
+ thermostat: {
7205
+ /** Unique identifier for the device. */
7206
+ device_id: string;
7207
+ /** Type of the device. */
7208
+ 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' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone');
7209
+ /** Optional nickname to describe the device, settable through Seam */
7210
+ nickname?: string | undefined;
7211
+ /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
7212
+ display_name: string;
7213
+ /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
7214
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
7215
+ /** Properties of the device. */
7216
+ properties: (({
7217
+ /** Indicates whether the device is online. */
7218
+ online: boolean;
7219
+ /**
7220
+ ---
7221
+ deprecated: use device.display_name instead
7222
+ ---
7223
+ Name of the device.
7224
+ */
7225
+ name: string;
7226
+ /** Represents the accessory keypad state. */
7227
+ accessory_keypad?: {
7228
+ /** Indicates if the accessory_keypad is connected to the device. */
7229
+ is_connected: boolean;
7230
+ /** Indicates if the keypad battery properties. */
7231
+ battery?: {
7232
+ level: number;
7233
+ } | undefined;
7234
+ } | undefined;
7235
+ appearance: {
7236
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
7237
+ name: string;
7238
+ };
7239
+ model: {
7240
+ /** Indicates whether the device can connect a accessory keypad. */
7241
+ can_connect_accessory_keypad?: boolean | undefined;
6337
7242
  /** Display name of the device model. */
6338
7243
  display_name: string;
6339
7244
  /** Display name that corresponds to the manufacturer-specific terminology for the device. */
@@ -6344,7 +7249,11 @@ export interface Routes {
6344
7249
  offline_access_codes_supported?: boolean | undefined;
6345
7250
  /** Indicates whether the device supports online access codes. */
6346
7251
  online_access_codes_supported?: boolean | undefined;
6347
- /** Indicates whether the device supports an accessory keypad. */
7252
+ /**
7253
+ ---
7254
+ deprecated: use device.properties.model.can_connect_accessory_keypad
7255
+ ---
7256
+ */
6348
7257
  accessory_keypad_supported?: boolean | undefined;
6349
7258
  };
6350
7259
  /** Indicates whether the device has direct power. */
@@ -6370,7 +7279,7 @@ export interface Routes {
6370
7279
  offline_access_codes_enabled?: boolean | undefined;
6371
7280
  /**
6372
7281
  ---
6373
- deprecated: use model.accessory_keypad_supported
7282
+ deprecated: use device.properties.model.can_connect_accessory_keypad
6374
7283
  ---
6375
7284
  */
6376
7285
  supports_accessory_keypad?: boolean | undefined;
@@ -6794,94 +7703,676 @@ export interface Routes {
6794
7703
  errors: Array<{
6795
7704
  error_code: string;
6796
7705
  message: string;
6797
- }>;
6798
- /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
6799
- warnings: Array<{
6800
- warning_code: string;
7706
+ }>;
7707
+ /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
7708
+ warnings: Array<{
7709
+ warning_code: string;
7710
+ message: string;
7711
+ }>;
7712
+ /** Date and time at which the device object was created. */
7713
+ created_at: string;
7714
+ /** Indicates whether Seam manages the device. */
7715
+ is_managed: true;
7716
+ custom_metadata: Record<string, string | boolean>;
7717
+ can_remotely_unlock?: boolean | undefined;
7718
+ can_remotely_lock?: boolean | undefined;
7719
+ can_program_offline_access_codes?: boolean | undefined;
7720
+ can_program_online_access_codes?: boolean | undefined;
7721
+ can_simulate_removal?: boolean | undefined;
7722
+ };
7723
+ };
7724
+ };
7725
+ '/thermostats/heat': {
7726
+ route: '/thermostats/heat';
7727
+ method: 'POST';
7728
+ queryParams: {};
7729
+ jsonBody: {
7730
+ device_id: string;
7731
+ heating_set_point_celsius?: number | undefined;
7732
+ heating_set_point_fahrenheit?: number | undefined;
7733
+ sync?: boolean;
7734
+ };
7735
+ commonParams: {};
7736
+ formData: {};
7737
+ jsonResponse: {
7738
+ action_attempt: {
7739
+ /**
7740
+ ---
7741
+ title: Action Attempt ID
7742
+ ---
7743
+ The ID of the action attempt.
7744
+ */
7745
+ action_attempt_id: string;
7746
+ status: 'pending';
7747
+ result: null;
7748
+ error: null;
7749
+ action_type: 'LOCK_DOOR';
7750
+ } | {
7751
+ /**
7752
+ ---
7753
+ title: Action Attempt ID
7754
+ ---
7755
+ The ID of the action attempt.
7756
+ */
7757
+ action_attempt_id: string;
7758
+ status: 'success';
7759
+ error: null;
7760
+ action_type: 'LOCK_DOOR';
7761
+ result: {};
7762
+ } | {
7763
+ /**
7764
+ ---
7765
+ title: Action Attempt ID
7766
+ ---
7767
+ The ID of the action attempt.
7768
+ */
7769
+ action_attempt_id: string;
7770
+ status: 'error';
7771
+ result: null;
7772
+ action_type: 'LOCK_DOOR';
7773
+ error: {
7774
+ type: string;
7775
+ message: string;
7776
+ };
7777
+ } | {
7778
+ /**
7779
+ ---
7780
+ title: Action Attempt ID
7781
+ ---
7782
+ The ID of the action attempt.
7783
+ */
7784
+ action_attempt_id: string;
7785
+ status: 'pending';
7786
+ result: null;
7787
+ error: null;
7788
+ action_type: 'UNLOCK_DOOR';
7789
+ } | {
7790
+ /**
7791
+ ---
7792
+ title: Action Attempt ID
7793
+ ---
7794
+ The ID of the action attempt.
7795
+ */
7796
+ action_attempt_id: string;
7797
+ status: 'success';
7798
+ error: null;
7799
+ action_type: 'UNLOCK_DOOR';
7800
+ result: {};
7801
+ } | {
7802
+ /**
7803
+ ---
7804
+ title: Action Attempt ID
7805
+ ---
7806
+ The ID of the action attempt.
7807
+ */
7808
+ action_attempt_id: string;
7809
+ status: 'error';
7810
+ result: null;
7811
+ action_type: 'UNLOCK_DOOR';
7812
+ error: {
7813
+ type: string;
7814
+ message: string;
7815
+ };
7816
+ } | {
7817
+ /**
7818
+ ---
7819
+ title: Action Attempt ID
7820
+ ---
7821
+ The ID of the action attempt.
7822
+ */
7823
+ action_attempt_id: string;
7824
+ status: 'pending';
7825
+ result: null;
7826
+ error: null;
7827
+ action_type: 'RESET_SANDBOX_WORKSPACE';
7828
+ } | {
7829
+ /**
7830
+ ---
7831
+ title: Action Attempt ID
7832
+ ---
7833
+ The ID of the action attempt.
7834
+ */
7835
+ action_attempt_id: string;
7836
+ status: 'success';
7837
+ error: null;
7838
+ action_type: 'RESET_SANDBOX_WORKSPACE';
7839
+ result: {};
7840
+ } | {
7841
+ /**
7842
+ ---
7843
+ title: Action Attempt ID
7844
+ ---
7845
+ The ID of the action attempt.
7846
+ */
7847
+ action_attempt_id: string;
7848
+ status: 'error';
7849
+ result: null;
7850
+ action_type: 'RESET_SANDBOX_WORKSPACE';
7851
+ error: {
7852
+ type: string;
7853
+ message: string;
7854
+ };
7855
+ } | {
7856
+ /**
7857
+ ---
7858
+ title: Action Attempt ID
7859
+ ---
7860
+ The ID of the action attempt.
7861
+ */
7862
+ action_attempt_id: string;
7863
+ status: 'pending';
7864
+ result: null;
7865
+ error: null;
7866
+ action_type: 'SET_COOL';
7867
+ } | {
7868
+ /**
7869
+ ---
7870
+ title: Action Attempt ID
7871
+ ---
7872
+ The ID of the action attempt.
7873
+ */
7874
+ action_attempt_id: string;
7875
+ status: 'success';
7876
+ error: null;
7877
+ action_type: 'SET_COOL';
7878
+ result: {};
7879
+ } | {
7880
+ /**
7881
+ ---
7882
+ title: Action Attempt ID
7883
+ ---
7884
+ The ID of the action attempt.
7885
+ */
7886
+ action_attempt_id: string;
7887
+ status: 'error';
7888
+ result: null;
7889
+ action_type: 'SET_COOL';
7890
+ error: {
7891
+ type: string;
7892
+ message: string;
7893
+ };
7894
+ } | {
7895
+ /**
7896
+ ---
7897
+ title: Action Attempt ID
7898
+ ---
7899
+ The ID of the action attempt.
7900
+ */
7901
+ action_attempt_id: string;
7902
+ status: 'pending';
7903
+ result: null;
7904
+ error: null;
7905
+ action_type: 'SET_HEAT';
7906
+ } | {
7907
+ /**
7908
+ ---
7909
+ title: Action Attempt ID
7910
+ ---
7911
+ The ID of the action attempt.
7912
+ */
7913
+ action_attempt_id: string;
7914
+ status: 'success';
7915
+ error: null;
7916
+ action_type: 'SET_HEAT';
7917
+ result: {};
7918
+ } | {
7919
+ /**
7920
+ ---
7921
+ title: Action Attempt ID
7922
+ ---
7923
+ The ID of the action attempt.
7924
+ */
7925
+ action_attempt_id: string;
7926
+ status: 'error';
7927
+ result: null;
7928
+ action_type: 'SET_HEAT';
7929
+ error: {
7930
+ type: string;
7931
+ message: string;
7932
+ };
7933
+ } | {
7934
+ /**
7935
+ ---
7936
+ title: Action Attempt ID
7937
+ ---
7938
+ The ID of the action attempt.
7939
+ */
7940
+ action_attempt_id: string;
7941
+ status: 'pending';
7942
+ result: null;
7943
+ error: null;
7944
+ action_type: 'SET_HEAT_COOL';
7945
+ } | {
7946
+ /**
7947
+ ---
7948
+ title: Action Attempt ID
7949
+ ---
7950
+ The ID of the action attempt.
7951
+ */
7952
+ action_attempt_id: string;
7953
+ status: 'success';
7954
+ error: null;
7955
+ action_type: 'SET_HEAT_COOL';
7956
+ result: {};
7957
+ } | {
7958
+ /**
7959
+ ---
7960
+ title: Action Attempt ID
7961
+ ---
7962
+ The ID of the action attempt.
7963
+ */
7964
+ action_attempt_id: string;
7965
+ status: 'error';
7966
+ result: null;
7967
+ action_type: 'SET_HEAT_COOL';
7968
+ error: {
7969
+ type: string;
6801
7970
  message: string;
6802
- }>;
6803
- /** Date and time at which the device object was created. */
6804
- created_at: string;
6805
- /** Indicates whether Seam manages the device. */
6806
- is_managed: true;
6807
- custom_metadata: Record<string, string | boolean>;
6808
- can_remotely_unlock?: boolean | undefined;
6809
- can_remotely_lock?: boolean | undefined;
6810
- can_program_offline_access_codes?: boolean | undefined;
6811
- can_program_online_access_codes?: boolean | undefined;
6812
- can_simulate_removal?: boolean | undefined;
7971
+ };
7972
+ } | {
7973
+ /**
7974
+ ---
7975
+ title: Action Attempt ID
7976
+ ---
7977
+ The ID of the action attempt.
7978
+ */
7979
+ action_attempt_id: string;
7980
+ status: 'pending';
7981
+ result: null;
7982
+ error: null;
7983
+ action_type: 'SET_FAN_MODE';
7984
+ } | {
7985
+ /**
7986
+ ---
7987
+ title: Action Attempt ID
7988
+ ---
7989
+ The ID of the action attempt.
7990
+ */
7991
+ action_attempt_id: string;
7992
+ status: 'success';
7993
+ error: null;
7994
+ action_type: 'SET_FAN_MODE';
7995
+ result: {};
7996
+ } | {
7997
+ /**
7998
+ ---
7999
+ title: Action Attempt ID
8000
+ ---
8001
+ The ID of the action attempt.
8002
+ */
8003
+ action_attempt_id: string;
8004
+ status: 'error';
8005
+ result: null;
8006
+ action_type: 'SET_FAN_MODE';
8007
+ error: {
8008
+ type: string;
8009
+ message: string;
8010
+ };
8011
+ } | {
8012
+ /**
8013
+ ---
8014
+ title: Action Attempt ID
8015
+ ---
8016
+ The ID of the action attempt.
8017
+ */
8018
+ action_attempt_id: string;
8019
+ status: 'pending';
8020
+ result: null;
8021
+ error: null;
8022
+ action_type: 'SET_THERMOSTAT_OFF';
8023
+ } | {
8024
+ /**
8025
+ ---
8026
+ title: Action Attempt ID
8027
+ ---
8028
+ The ID of the action attempt.
8029
+ */
8030
+ action_attempt_id: string;
8031
+ status: 'success';
8032
+ error: null;
8033
+ action_type: 'SET_THERMOSTAT_OFF';
8034
+ result: {};
8035
+ } | {
8036
+ /**
8037
+ ---
8038
+ title: Action Attempt ID
8039
+ ---
8040
+ The ID of the action attempt.
8041
+ */
8042
+ action_attempt_id: string;
8043
+ status: 'error';
8044
+ result: null;
8045
+ action_type: 'SET_THERMOSTAT_OFF';
8046
+ error: {
8047
+ type: string;
8048
+ message: string;
8049
+ };
6813
8050
  };
6814
8051
  };
6815
8052
  };
6816
- '/thermostats/heat': {
6817
- route: '/thermostats/heat';
8053
+ '/thermostats/heat_cool': {
8054
+ route: '/thermostats/heat_cool';
6818
8055
  method: 'POST';
6819
8056
  queryParams: {};
6820
8057
  jsonBody: {
6821
8058
  device_id: string;
6822
8059
  heating_set_point_celsius?: number | undefined;
6823
8060
  heating_set_point_fahrenheit?: number | undefined;
8061
+ cooling_set_point_celsius?: number | undefined;
8062
+ cooling_set_point_fahrenheit?: number | undefined;
6824
8063
  sync?: boolean;
6825
8064
  };
6826
8065
  commonParams: {};
6827
8066
  formData: {};
6828
8067
  jsonResponse: {
6829
8068
  action_attempt: {
8069
+ /**
8070
+ ---
8071
+ title: Action Attempt ID
8072
+ ---
8073
+ The ID of the action attempt.
8074
+ */
8075
+ action_attempt_id: string;
8076
+ status: 'pending';
8077
+ result: null;
8078
+ error: null;
8079
+ action_type: 'LOCK_DOOR';
8080
+ } | {
8081
+ /**
8082
+ ---
8083
+ title: Action Attempt ID
8084
+ ---
8085
+ The ID of the action attempt.
8086
+ */
8087
+ action_attempt_id: string;
6830
8088
  status: 'success';
6831
- action_type: string;
8089
+ error: null;
8090
+ action_type: 'LOCK_DOOR';
8091
+ result: {};
8092
+ } | {
8093
+ /**
8094
+ ---
8095
+ title: Action Attempt ID
8096
+ ---
8097
+ The ID of the action attempt.
8098
+ */
6832
8099
  action_attempt_id: string;
6833
- result?: any;
8100
+ status: 'error';
8101
+ result: null;
8102
+ action_type: 'LOCK_DOOR';
8103
+ error: {
8104
+ type: string;
8105
+ message: string;
8106
+ };
8107
+ } | {
8108
+ /**
8109
+ ---
8110
+ title: Action Attempt ID
8111
+ ---
8112
+ The ID of the action attempt.
8113
+ */
8114
+ action_attempt_id: string;
8115
+ status: 'pending';
8116
+ result: null;
8117
+ error: null;
8118
+ action_type: 'UNLOCK_DOOR';
8119
+ } | {
8120
+ /**
8121
+ ---
8122
+ title: Action Attempt ID
8123
+ ---
8124
+ The ID of the action attempt.
8125
+ */
8126
+ action_attempt_id: string;
8127
+ status: 'success';
8128
+ error: null;
8129
+ action_type: 'UNLOCK_DOOR';
8130
+ result: {};
8131
+ } | {
8132
+ /**
8133
+ ---
8134
+ title: Action Attempt ID
8135
+ ---
8136
+ The ID of the action attempt.
8137
+ */
8138
+ action_attempt_id: string;
8139
+ status: 'error';
8140
+ result: null;
8141
+ action_type: 'UNLOCK_DOOR';
8142
+ error: {
8143
+ type: string;
8144
+ message: string;
8145
+ };
8146
+ } | {
8147
+ /**
8148
+ ---
8149
+ title: Action Attempt ID
8150
+ ---
8151
+ The ID of the action attempt.
8152
+ */
8153
+ action_attempt_id: string;
8154
+ status: 'pending';
8155
+ result: null;
8156
+ error: null;
8157
+ action_type: 'RESET_SANDBOX_WORKSPACE';
8158
+ } | {
8159
+ /**
8160
+ ---
8161
+ title: Action Attempt ID
8162
+ ---
8163
+ The ID of the action attempt.
8164
+ */
8165
+ action_attempt_id: string;
8166
+ status: 'success';
8167
+ error: null;
8168
+ action_type: 'RESET_SANDBOX_WORKSPACE';
8169
+ result: {};
8170
+ } | {
8171
+ /**
8172
+ ---
8173
+ title: Action Attempt ID
8174
+ ---
8175
+ The ID of the action attempt.
8176
+ */
8177
+ action_attempt_id: string;
8178
+ status: 'error';
8179
+ result: null;
8180
+ action_type: 'RESET_SANDBOX_WORKSPACE';
8181
+ error: {
8182
+ type: string;
8183
+ message: string;
8184
+ };
8185
+ } | {
8186
+ /**
8187
+ ---
8188
+ title: Action Attempt ID
8189
+ ---
8190
+ The ID of the action attempt.
8191
+ */
8192
+ action_attempt_id: string;
8193
+ status: 'pending';
8194
+ result: null;
8195
+ error: null;
8196
+ action_type: 'SET_COOL';
8197
+ } | {
8198
+ /**
8199
+ ---
8200
+ title: Action Attempt ID
8201
+ ---
8202
+ The ID of the action attempt.
8203
+ */
8204
+ action_attempt_id: string;
8205
+ status: 'success';
8206
+ error: null;
8207
+ action_type: 'SET_COOL';
8208
+ result: {};
8209
+ } | {
8210
+ /**
8211
+ ---
8212
+ title: Action Attempt ID
8213
+ ---
8214
+ The ID of the action attempt.
8215
+ */
8216
+ action_attempt_id: string;
8217
+ status: 'error';
8218
+ result: null;
8219
+ action_type: 'SET_COOL';
8220
+ error: {
8221
+ type: string;
8222
+ message: string;
8223
+ };
8224
+ } | {
8225
+ /**
8226
+ ---
8227
+ title: Action Attempt ID
8228
+ ---
8229
+ The ID of the action attempt.
8230
+ */
8231
+ action_attempt_id: string;
8232
+ status: 'pending';
8233
+ result: null;
8234
+ error: null;
8235
+ action_type: 'SET_HEAT';
8236
+ } | {
8237
+ /**
8238
+ ---
8239
+ title: Action Attempt ID
8240
+ ---
8241
+ The ID of the action attempt.
8242
+ */
8243
+ action_attempt_id: string;
8244
+ status: 'success';
6834
8245
  error: null;
8246
+ action_type: 'SET_HEAT';
8247
+ result: {};
6835
8248
  } | {
6836
- status: 'pending';
6837
- action_type: string;
8249
+ /**
8250
+ ---
8251
+ title: Action Attempt ID
8252
+ ---
8253
+ The ID of the action attempt.
8254
+ */
8255
+ action_attempt_id: string;
8256
+ status: 'error';
8257
+ result: null;
8258
+ action_type: 'SET_HEAT';
8259
+ error: {
8260
+ type: string;
8261
+ message: string;
8262
+ };
8263
+ } | {
8264
+ /**
8265
+ ---
8266
+ title: Action Attempt ID
8267
+ ---
8268
+ The ID of the action attempt.
8269
+ */
6838
8270
  action_attempt_id: string;
8271
+ status: 'pending';
6839
8272
  result: null;
6840
8273
  error: null;
8274
+ action_type: 'SET_HEAT_COOL';
6841
8275
  } | {
6842
- status: 'error';
6843
- action_type: string;
8276
+ /**
8277
+ ---
8278
+ title: Action Attempt ID
8279
+ ---
8280
+ The ID of the action attempt.
8281
+ */
8282
+ action_attempt_id: string;
8283
+ status: 'success';
8284
+ error: null;
8285
+ action_type: 'SET_HEAT_COOL';
8286
+ result: {};
8287
+ } | {
8288
+ /**
8289
+ ---
8290
+ title: Action Attempt ID
8291
+ ---
8292
+ The ID of the action attempt.
8293
+ */
6844
8294
  action_attempt_id: string;
8295
+ status: 'error';
6845
8296
  result: null;
8297
+ action_type: 'SET_HEAT_COOL';
6846
8298
  error: {
6847
8299
  type: string;
6848
8300
  message: string;
6849
8301
  };
6850
- };
6851
- };
6852
- };
6853
- '/thermostats/heat_cool': {
6854
- route: '/thermostats/heat_cool';
6855
- method: 'POST';
6856
- queryParams: {};
6857
- jsonBody: {
6858
- device_id: string;
6859
- heating_set_point_celsius?: number | undefined;
6860
- heating_set_point_fahrenheit?: number | undefined;
6861
- cooling_set_point_celsius?: number | undefined;
6862
- cooling_set_point_fahrenheit?: number | undefined;
6863
- sync?: boolean;
6864
- };
6865
- commonParams: {};
6866
- formData: {};
6867
- jsonResponse: {
6868
- action_attempt: {
6869
- status: 'success';
6870
- action_type: string;
8302
+ } | {
8303
+ /**
8304
+ ---
8305
+ title: Action Attempt ID
8306
+ ---
8307
+ The ID of the action attempt.
8308
+ */
6871
8309
  action_attempt_id: string;
6872
- result?: any;
8310
+ status: 'pending';
8311
+ result: null;
6873
8312
  error: null;
8313
+ action_type: 'SET_FAN_MODE';
6874
8314
  } | {
6875
- status: 'pending';
6876
- action_type: string;
8315
+ /**
8316
+ ---
8317
+ title: Action Attempt ID
8318
+ ---
8319
+ The ID of the action attempt.
8320
+ */
6877
8321
  action_attempt_id: string;
6878
- result: null;
8322
+ status: 'success';
6879
8323
  error: null;
8324
+ action_type: 'SET_FAN_MODE';
8325
+ result: {};
6880
8326
  } | {
8327
+ /**
8328
+ ---
8329
+ title: Action Attempt ID
8330
+ ---
8331
+ The ID of the action attempt.
8332
+ */
8333
+ action_attempt_id: string;
6881
8334
  status: 'error';
6882
- action_type: string;
8335
+ result: null;
8336
+ action_type: 'SET_FAN_MODE';
8337
+ error: {
8338
+ type: string;
8339
+ message: string;
8340
+ };
8341
+ } | {
8342
+ /**
8343
+ ---
8344
+ title: Action Attempt ID
8345
+ ---
8346
+ The ID of the action attempt.
8347
+ */
8348
+ action_attempt_id: string;
8349
+ status: 'pending';
8350
+ result: null;
8351
+ error: null;
8352
+ action_type: 'SET_THERMOSTAT_OFF';
8353
+ } | {
8354
+ /**
8355
+ ---
8356
+ title: Action Attempt ID
8357
+ ---
8358
+ The ID of the action attempt.
8359
+ */
6883
8360
  action_attempt_id: string;
8361
+ status: 'success';
8362
+ error: null;
8363
+ action_type: 'SET_THERMOSTAT_OFF';
8364
+ result: {};
8365
+ } | {
8366
+ /**
8367
+ ---
8368
+ title: Action Attempt ID
8369
+ ---
8370
+ The ID of the action attempt.
8371
+ */
8372
+ action_attempt_id: string;
8373
+ status: 'error';
6884
8374
  result: null;
8375
+ action_type: 'SET_THERMOSTAT_OFF';
6885
8376
  error: {
6886
8377
  type: string;
6887
8378
  message: string;
@@ -6960,7 +8451,11 @@ export interface Routes {
6960
8451
  offline_access_codes_supported?: boolean | undefined;
6961
8452
  /** Indicates whether the device supports online access codes. */
6962
8453
  online_access_codes_supported?: boolean | undefined;
6963
- /** Indicates whether the device supports an accessory keypad. */
8454
+ /**
8455
+ ---
8456
+ deprecated: use device.properties.model.can_connect_accessory_keypad
8457
+ ---
8458
+ */
6964
8459
  accessory_keypad_supported?: boolean | undefined;
6965
8460
  };
6966
8461
  /** Indicates whether the device has direct power. */
@@ -6986,7 +8481,7 @@ export interface Routes {
6986
8481
  offline_access_codes_enabled?: boolean | undefined;
6987
8482
  /**
6988
8483
  ---
6989
- deprecated: use model.accessory_keypad_supported
8484
+ deprecated: use device.properties.model.can_connect_accessory_keypad
6990
8485
  ---
6991
8486
  */
6992
8487
  supports_accessory_keypad?: boolean | undefined;
@@ -7441,22 +8936,313 @@ export interface Routes {
7441
8936
  formData: {};
7442
8937
  jsonResponse: {
7443
8938
  action_attempt: {
8939
+ /**
8940
+ ---
8941
+ title: Action Attempt ID
8942
+ ---
8943
+ The ID of the action attempt.
8944
+ */
8945
+ action_attempt_id: string;
8946
+ status: 'pending';
8947
+ result: null;
8948
+ error: null;
8949
+ action_type: 'LOCK_DOOR';
8950
+ } | {
8951
+ /**
8952
+ ---
8953
+ title: Action Attempt ID
8954
+ ---
8955
+ The ID of the action attempt.
8956
+ */
8957
+ action_attempt_id: string;
7444
8958
  status: 'success';
7445
- action_type: string;
8959
+ error: null;
8960
+ action_type: 'LOCK_DOOR';
8961
+ result: {};
8962
+ } | {
8963
+ /**
8964
+ ---
8965
+ title: Action Attempt ID
8966
+ ---
8967
+ The ID of the action attempt.
8968
+ */
8969
+ action_attempt_id: string;
8970
+ status: 'error';
8971
+ result: null;
8972
+ action_type: 'LOCK_DOOR';
8973
+ error: {
8974
+ type: string;
8975
+ message: string;
8976
+ };
8977
+ } | {
8978
+ /**
8979
+ ---
8980
+ title: Action Attempt ID
8981
+ ---
8982
+ The ID of the action attempt.
8983
+ */
8984
+ action_attempt_id: string;
8985
+ status: 'pending';
8986
+ result: null;
8987
+ error: null;
8988
+ action_type: 'UNLOCK_DOOR';
8989
+ } | {
8990
+ /**
8991
+ ---
8992
+ title: Action Attempt ID
8993
+ ---
8994
+ The ID of the action attempt.
8995
+ */
8996
+ action_attempt_id: string;
8997
+ status: 'success';
8998
+ error: null;
8999
+ action_type: 'UNLOCK_DOOR';
9000
+ result: {};
9001
+ } | {
9002
+ /**
9003
+ ---
9004
+ title: Action Attempt ID
9005
+ ---
9006
+ The ID of the action attempt.
9007
+ */
9008
+ action_attempt_id: string;
9009
+ status: 'error';
9010
+ result: null;
9011
+ action_type: 'UNLOCK_DOOR';
9012
+ error: {
9013
+ type: string;
9014
+ message: string;
9015
+ };
9016
+ } | {
9017
+ /**
9018
+ ---
9019
+ title: Action Attempt ID
9020
+ ---
9021
+ The ID of the action attempt.
9022
+ */
9023
+ action_attempt_id: string;
9024
+ status: 'pending';
9025
+ result: null;
9026
+ error: null;
9027
+ action_type: 'RESET_SANDBOX_WORKSPACE';
9028
+ } | {
9029
+ /**
9030
+ ---
9031
+ title: Action Attempt ID
9032
+ ---
9033
+ The ID of the action attempt.
9034
+ */
9035
+ action_attempt_id: string;
9036
+ status: 'success';
9037
+ error: null;
9038
+ action_type: 'RESET_SANDBOX_WORKSPACE';
9039
+ result: {};
9040
+ } | {
9041
+ /**
9042
+ ---
9043
+ title: Action Attempt ID
9044
+ ---
9045
+ The ID of the action attempt.
9046
+ */
9047
+ action_attempt_id: string;
9048
+ status: 'error';
9049
+ result: null;
9050
+ action_type: 'RESET_SANDBOX_WORKSPACE';
9051
+ error: {
9052
+ type: string;
9053
+ message: string;
9054
+ };
9055
+ } | {
9056
+ /**
9057
+ ---
9058
+ title: Action Attempt ID
9059
+ ---
9060
+ The ID of the action attempt.
9061
+ */
9062
+ action_attempt_id: string;
9063
+ status: 'pending';
9064
+ result: null;
9065
+ error: null;
9066
+ action_type: 'SET_COOL';
9067
+ } | {
9068
+ /**
9069
+ ---
9070
+ title: Action Attempt ID
9071
+ ---
9072
+ The ID of the action attempt.
9073
+ */
9074
+ action_attempt_id: string;
9075
+ status: 'success';
9076
+ error: null;
9077
+ action_type: 'SET_COOL';
9078
+ result: {};
9079
+ } | {
9080
+ /**
9081
+ ---
9082
+ title: Action Attempt ID
9083
+ ---
9084
+ The ID of the action attempt.
9085
+ */
9086
+ action_attempt_id: string;
9087
+ status: 'error';
9088
+ result: null;
9089
+ action_type: 'SET_COOL';
9090
+ error: {
9091
+ type: string;
9092
+ message: string;
9093
+ };
9094
+ } | {
9095
+ /**
9096
+ ---
9097
+ title: Action Attempt ID
9098
+ ---
9099
+ The ID of the action attempt.
9100
+ */
9101
+ action_attempt_id: string;
9102
+ status: 'pending';
9103
+ result: null;
9104
+ error: null;
9105
+ action_type: 'SET_HEAT';
9106
+ } | {
9107
+ /**
9108
+ ---
9109
+ title: Action Attempt ID
9110
+ ---
9111
+ The ID of the action attempt.
9112
+ */
9113
+ action_attempt_id: string;
9114
+ status: 'success';
9115
+ error: null;
9116
+ action_type: 'SET_HEAT';
9117
+ result: {};
9118
+ } | {
9119
+ /**
9120
+ ---
9121
+ title: Action Attempt ID
9122
+ ---
9123
+ The ID of the action attempt.
9124
+ */
9125
+ action_attempt_id: string;
9126
+ status: 'error';
9127
+ result: null;
9128
+ action_type: 'SET_HEAT';
9129
+ error: {
9130
+ type: string;
9131
+ message: string;
9132
+ };
9133
+ } | {
9134
+ /**
9135
+ ---
9136
+ title: Action Attempt ID
9137
+ ---
9138
+ The ID of the action attempt.
9139
+ */
9140
+ action_attempt_id: string;
9141
+ status: 'pending';
9142
+ result: null;
9143
+ error: null;
9144
+ action_type: 'SET_HEAT_COOL';
9145
+ } | {
9146
+ /**
9147
+ ---
9148
+ title: Action Attempt ID
9149
+ ---
9150
+ The ID of the action attempt.
9151
+ */
7446
9152
  action_attempt_id: string;
7447
- result?: any;
9153
+ status: 'success';
7448
9154
  error: null;
9155
+ action_type: 'SET_HEAT_COOL';
9156
+ result: {};
7449
9157
  } | {
7450
- status: 'pending';
7451
- action_type: string;
9158
+ /**
9159
+ ---
9160
+ title: Action Attempt ID
9161
+ ---
9162
+ The ID of the action attempt.
9163
+ */
9164
+ action_attempt_id: string;
9165
+ status: 'error';
9166
+ result: null;
9167
+ action_type: 'SET_HEAT_COOL';
9168
+ error: {
9169
+ type: string;
9170
+ message: string;
9171
+ };
9172
+ } | {
9173
+ /**
9174
+ ---
9175
+ title: Action Attempt ID
9176
+ ---
9177
+ The ID of the action attempt.
9178
+ */
7452
9179
  action_attempt_id: string;
9180
+ status: 'pending';
7453
9181
  result: null;
7454
9182
  error: null;
9183
+ action_type: 'SET_FAN_MODE';
9184
+ } | {
9185
+ /**
9186
+ ---
9187
+ title: Action Attempt ID
9188
+ ---
9189
+ The ID of the action attempt.
9190
+ */
9191
+ action_attempt_id: string;
9192
+ status: 'success';
9193
+ error: null;
9194
+ action_type: 'SET_FAN_MODE';
9195
+ result: {};
7455
9196
  } | {
9197
+ /**
9198
+ ---
9199
+ title: Action Attempt ID
9200
+ ---
9201
+ The ID of the action attempt.
9202
+ */
9203
+ action_attempt_id: string;
7456
9204
  status: 'error';
7457
- action_type: string;
9205
+ result: null;
9206
+ action_type: 'SET_FAN_MODE';
9207
+ error: {
9208
+ type: string;
9209
+ message: string;
9210
+ };
9211
+ } | {
9212
+ /**
9213
+ ---
9214
+ title: Action Attempt ID
9215
+ ---
9216
+ The ID of the action attempt.
9217
+ */
9218
+ action_attempt_id: string;
9219
+ status: 'pending';
9220
+ result: null;
9221
+ error: null;
9222
+ action_type: 'SET_THERMOSTAT_OFF';
9223
+ } | {
9224
+ /**
9225
+ ---
9226
+ title: Action Attempt ID
9227
+ ---
9228
+ The ID of the action attempt.
9229
+ */
9230
+ action_attempt_id: string;
9231
+ status: 'success';
9232
+ error: null;
9233
+ action_type: 'SET_THERMOSTAT_OFF';
9234
+ result: {};
9235
+ } | {
9236
+ /**
9237
+ ---
9238
+ title: Action Attempt ID
9239
+ ---
9240
+ The ID of the action attempt.
9241
+ */
7458
9242
  action_attempt_id: string;
9243
+ status: 'error';
7459
9244
  result: null;
9245
+ action_type: 'SET_THERMOSTAT_OFF';
7460
9246
  error: {
7461
9247
  type: string;
7462
9248
  message: string;
@@ -7478,22 +9264,313 @@ export interface Routes {
7478
9264
  formData: {};
7479
9265
  jsonResponse: {
7480
9266
  action_attempt: {
9267
+ /**
9268
+ ---
9269
+ title: Action Attempt ID
9270
+ ---
9271
+ The ID of the action attempt.
9272
+ */
9273
+ action_attempt_id: string;
9274
+ status: 'pending';
9275
+ result: null;
9276
+ error: null;
9277
+ action_type: 'LOCK_DOOR';
9278
+ } | {
9279
+ /**
9280
+ ---
9281
+ title: Action Attempt ID
9282
+ ---
9283
+ The ID of the action attempt.
9284
+ */
9285
+ action_attempt_id: string;
7481
9286
  status: 'success';
7482
- action_type: string;
9287
+ error: null;
9288
+ action_type: 'LOCK_DOOR';
9289
+ result: {};
9290
+ } | {
9291
+ /**
9292
+ ---
9293
+ title: Action Attempt ID
9294
+ ---
9295
+ The ID of the action attempt.
9296
+ */
9297
+ action_attempt_id: string;
9298
+ status: 'error';
9299
+ result: null;
9300
+ action_type: 'LOCK_DOOR';
9301
+ error: {
9302
+ type: string;
9303
+ message: string;
9304
+ };
9305
+ } | {
9306
+ /**
9307
+ ---
9308
+ title: Action Attempt ID
9309
+ ---
9310
+ The ID of the action attempt.
9311
+ */
9312
+ action_attempt_id: string;
9313
+ status: 'pending';
9314
+ result: null;
9315
+ error: null;
9316
+ action_type: 'UNLOCK_DOOR';
9317
+ } | {
9318
+ /**
9319
+ ---
9320
+ title: Action Attempt ID
9321
+ ---
9322
+ The ID of the action attempt.
9323
+ */
9324
+ action_attempt_id: string;
9325
+ status: 'success';
9326
+ error: null;
9327
+ action_type: 'UNLOCK_DOOR';
9328
+ result: {};
9329
+ } | {
9330
+ /**
9331
+ ---
9332
+ title: Action Attempt ID
9333
+ ---
9334
+ The ID of the action attempt.
9335
+ */
9336
+ action_attempt_id: string;
9337
+ status: 'error';
9338
+ result: null;
9339
+ action_type: 'UNLOCK_DOOR';
9340
+ error: {
9341
+ type: string;
9342
+ message: string;
9343
+ };
9344
+ } | {
9345
+ /**
9346
+ ---
9347
+ title: Action Attempt ID
9348
+ ---
9349
+ The ID of the action attempt.
9350
+ */
9351
+ action_attempt_id: string;
9352
+ status: 'pending';
9353
+ result: null;
9354
+ error: null;
9355
+ action_type: 'RESET_SANDBOX_WORKSPACE';
9356
+ } | {
9357
+ /**
9358
+ ---
9359
+ title: Action Attempt ID
9360
+ ---
9361
+ The ID of the action attempt.
9362
+ */
9363
+ action_attempt_id: string;
9364
+ status: 'success';
9365
+ error: null;
9366
+ action_type: 'RESET_SANDBOX_WORKSPACE';
9367
+ result: {};
9368
+ } | {
9369
+ /**
9370
+ ---
9371
+ title: Action Attempt ID
9372
+ ---
9373
+ The ID of the action attempt.
9374
+ */
9375
+ action_attempt_id: string;
9376
+ status: 'error';
9377
+ result: null;
9378
+ action_type: 'RESET_SANDBOX_WORKSPACE';
9379
+ error: {
9380
+ type: string;
9381
+ message: string;
9382
+ };
9383
+ } | {
9384
+ /**
9385
+ ---
9386
+ title: Action Attempt ID
9387
+ ---
9388
+ The ID of the action attempt.
9389
+ */
9390
+ action_attempt_id: string;
9391
+ status: 'pending';
9392
+ result: null;
9393
+ error: null;
9394
+ action_type: 'SET_COOL';
9395
+ } | {
9396
+ /**
9397
+ ---
9398
+ title: Action Attempt ID
9399
+ ---
9400
+ The ID of the action attempt.
9401
+ */
9402
+ action_attempt_id: string;
9403
+ status: 'success';
9404
+ error: null;
9405
+ action_type: 'SET_COOL';
9406
+ result: {};
9407
+ } | {
9408
+ /**
9409
+ ---
9410
+ title: Action Attempt ID
9411
+ ---
9412
+ The ID of the action attempt.
9413
+ */
9414
+ action_attempt_id: string;
9415
+ status: 'error';
9416
+ result: null;
9417
+ action_type: 'SET_COOL';
9418
+ error: {
9419
+ type: string;
9420
+ message: string;
9421
+ };
9422
+ } | {
9423
+ /**
9424
+ ---
9425
+ title: Action Attempt ID
9426
+ ---
9427
+ The ID of the action attempt.
9428
+ */
9429
+ action_attempt_id: string;
9430
+ status: 'pending';
9431
+ result: null;
9432
+ error: null;
9433
+ action_type: 'SET_HEAT';
9434
+ } | {
9435
+ /**
9436
+ ---
9437
+ title: Action Attempt ID
9438
+ ---
9439
+ The ID of the action attempt.
9440
+ */
9441
+ action_attempt_id: string;
9442
+ status: 'success';
9443
+ error: null;
9444
+ action_type: 'SET_HEAT';
9445
+ result: {};
9446
+ } | {
9447
+ /**
9448
+ ---
9449
+ title: Action Attempt ID
9450
+ ---
9451
+ The ID of the action attempt.
9452
+ */
9453
+ action_attempt_id: string;
9454
+ status: 'error';
9455
+ result: null;
9456
+ action_type: 'SET_HEAT';
9457
+ error: {
9458
+ type: string;
9459
+ message: string;
9460
+ };
9461
+ } | {
9462
+ /**
9463
+ ---
9464
+ title: Action Attempt ID
9465
+ ---
9466
+ The ID of the action attempt.
9467
+ */
9468
+ action_attempt_id: string;
9469
+ status: 'pending';
9470
+ result: null;
9471
+ error: null;
9472
+ action_type: 'SET_HEAT_COOL';
9473
+ } | {
9474
+ /**
9475
+ ---
9476
+ title: Action Attempt ID
9477
+ ---
9478
+ The ID of the action attempt.
9479
+ */
9480
+ action_attempt_id: string;
9481
+ status: 'success';
9482
+ error: null;
9483
+ action_type: 'SET_HEAT_COOL';
9484
+ result: {};
9485
+ } | {
9486
+ /**
9487
+ ---
9488
+ title: Action Attempt ID
9489
+ ---
9490
+ The ID of the action attempt.
9491
+ */
9492
+ action_attempt_id: string;
9493
+ status: 'error';
9494
+ result: null;
9495
+ action_type: 'SET_HEAT_COOL';
9496
+ error: {
9497
+ type: string;
9498
+ message: string;
9499
+ };
9500
+ } | {
9501
+ /**
9502
+ ---
9503
+ title: Action Attempt ID
9504
+ ---
9505
+ The ID of the action attempt.
9506
+ */
9507
+ action_attempt_id: string;
9508
+ status: 'pending';
9509
+ result: null;
9510
+ error: null;
9511
+ action_type: 'SET_FAN_MODE';
9512
+ } | {
9513
+ /**
9514
+ ---
9515
+ title: Action Attempt ID
9516
+ ---
9517
+ The ID of the action attempt.
9518
+ */
7483
9519
  action_attempt_id: string;
7484
- result?: any;
9520
+ status: 'success';
7485
9521
  error: null;
9522
+ action_type: 'SET_FAN_MODE';
9523
+ result: {};
7486
9524
  } | {
7487
- status: 'pending';
7488
- action_type: string;
9525
+ /**
9526
+ ---
9527
+ title: Action Attempt ID
9528
+ ---
9529
+ The ID of the action attempt.
9530
+ */
9531
+ action_attempt_id: string;
9532
+ status: 'error';
9533
+ result: null;
9534
+ action_type: 'SET_FAN_MODE';
9535
+ error: {
9536
+ type: string;
9537
+ message: string;
9538
+ };
9539
+ } | {
9540
+ /**
9541
+ ---
9542
+ title: Action Attempt ID
9543
+ ---
9544
+ The ID of the action attempt.
9545
+ */
7489
9546
  action_attempt_id: string;
9547
+ status: 'pending';
7490
9548
  result: null;
7491
9549
  error: null;
9550
+ action_type: 'SET_THERMOSTAT_OFF';
7492
9551
  } | {
7493
- status: 'error';
7494
- action_type: string;
9552
+ /**
9553
+ ---
9554
+ title: Action Attempt ID
9555
+ ---
9556
+ The ID of the action attempt.
9557
+ */
9558
+ action_attempt_id: string;
9559
+ status: 'success';
9560
+ error: null;
9561
+ action_type: 'SET_THERMOSTAT_OFF';
9562
+ result: {};
9563
+ } | {
9564
+ /**
9565
+ ---
9566
+ title: Action Attempt ID
9567
+ ---
9568
+ The ID of the action attempt.
9569
+ */
7495
9570
  action_attempt_id: string;
9571
+ status: 'error';
7496
9572
  result: null;
9573
+ action_type: 'SET_THERMOSTAT_OFF';
7497
9574
  error: {
7498
9575
  type: string;
7499
9576
  message: string;
@@ -7759,7 +9836,11 @@ export interface Routes {
7759
9836
  offline_access_codes_supported?: boolean | undefined;
7760
9837
  /** Indicates whether the device supports online access codes. */
7761
9838
  online_access_codes_supported?: boolean | undefined;
7762
- /** Indicates whether the device supports an accessory keypad. */
9839
+ /**
9840
+ ---
9841
+ deprecated: use device.properties.model.can_connect_accessory_keypad
9842
+ ---
9843
+ */
7763
9844
  accessory_keypad_supported?: boolean | undefined;
7764
9845
  };
7765
9846
  /** Indicates whether the device has direct power. */
@@ -7785,7 +9866,7 @@ export interface Routes {
7785
9866
  offline_access_codes_enabled?: boolean | undefined;
7786
9867
  /**
7787
9868
  ---
7788
- deprecated: use model.accessory_keypad_supported
9869
+ deprecated: use device.properties.model.can_connect_accessory_keypad
7789
9870
  ---
7790
9871
  */
7791
9872
  supports_accessory_keypad?: boolean | undefined;
@@ -8279,7 +10360,11 @@ export interface Routes {
8279
10360
  offline_access_codes_supported?: boolean | undefined;
8280
10361
  /** Indicates whether the device supports online access codes. */
8281
10362
  online_access_codes_supported?: boolean | undefined;
8282
- /** Indicates whether the device supports an accessory keypad. */
10363
+ /**
10364
+ ---
10365
+ deprecated: use device.properties.model.can_connect_accessory_keypad
10366
+ ---
10367
+ */
8283
10368
  accessory_keypad_supported?: boolean | undefined;
8284
10369
  };
8285
10370
  /** Indicates whether the device has direct power. */
@@ -8305,7 +10390,7 @@ export interface Routes {
8305
10390
  offline_access_codes_enabled?: boolean | undefined;
8306
10391
  /**
8307
10392
  ---
8308
- deprecated: use model.accessory_keypad_supported
10393
+ deprecated: use device.properties.model.can_connect_accessory_keypad
8309
10394
  ---
8310
10395
  */
8311
10396
  supports_accessory_keypad?: boolean | undefined;
@@ -9014,22 +11099,313 @@ export interface Routes {
9014
11099
  formData: {};
9015
11100
  jsonResponse: {
9016
11101
  action_attempt: {
11102
+ /**
11103
+ ---
11104
+ title: Action Attempt ID
11105
+ ---
11106
+ The ID of the action attempt.
11107
+ */
11108
+ action_attempt_id: string;
11109
+ status: 'pending';
11110
+ result: null;
11111
+ error: null;
11112
+ action_type: 'LOCK_DOOR';
11113
+ } | {
11114
+ /**
11115
+ ---
11116
+ title: Action Attempt ID
11117
+ ---
11118
+ The ID of the action attempt.
11119
+ */
11120
+ action_attempt_id: string;
9017
11121
  status: 'success';
9018
- action_type: string;
11122
+ error: null;
11123
+ action_type: 'LOCK_DOOR';
11124
+ result: {};
11125
+ } | {
11126
+ /**
11127
+ ---
11128
+ title: Action Attempt ID
11129
+ ---
11130
+ The ID of the action attempt.
11131
+ */
9019
11132
  action_attempt_id: string;
9020
- result?: any;
11133
+ status: 'error';
11134
+ result: null;
11135
+ action_type: 'LOCK_DOOR';
11136
+ error: {
11137
+ type: string;
11138
+ message: string;
11139
+ };
11140
+ } | {
11141
+ /**
11142
+ ---
11143
+ title: Action Attempt ID
11144
+ ---
11145
+ The ID of the action attempt.
11146
+ */
11147
+ action_attempt_id: string;
11148
+ status: 'pending';
11149
+ result: null;
11150
+ error: null;
11151
+ action_type: 'UNLOCK_DOOR';
11152
+ } | {
11153
+ /**
11154
+ ---
11155
+ title: Action Attempt ID
11156
+ ---
11157
+ The ID of the action attempt.
11158
+ */
11159
+ action_attempt_id: string;
11160
+ status: 'success';
11161
+ error: null;
11162
+ action_type: 'UNLOCK_DOOR';
11163
+ result: {};
11164
+ } | {
11165
+ /**
11166
+ ---
11167
+ title: Action Attempt ID
11168
+ ---
11169
+ The ID of the action attempt.
11170
+ */
11171
+ action_attempt_id: string;
11172
+ status: 'error';
11173
+ result: null;
11174
+ action_type: 'UNLOCK_DOOR';
11175
+ error: {
11176
+ type: string;
11177
+ message: string;
11178
+ };
11179
+ } | {
11180
+ /**
11181
+ ---
11182
+ title: Action Attempt ID
11183
+ ---
11184
+ The ID of the action attempt.
11185
+ */
11186
+ action_attempt_id: string;
11187
+ status: 'pending';
11188
+ result: null;
11189
+ error: null;
11190
+ action_type: 'RESET_SANDBOX_WORKSPACE';
11191
+ } | {
11192
+ /**
11193
+ ---
11194
+ title: Action Attempt ID
11195
+ ---
11196
+ The ID of the action attempt.
11197
+ */
11198
+ action_attempt_id: string;
11199
+ status: 'success';
9021
11200
  error: null;
11201
+ action_type: 'RESET_SANDBOX_WORKSPACE';
11202
+ result: {};
11203
+ } | {
11204
+ /**
11205
+ ---
11206
+ title: Action Attempt ID
11207
+ ---
11208
+ The ID of the action attempt.
11209
+ */
11210
+ action_attempt_id: string;
11211
+ status: 'error';
11212
+ result: null;
11213
+ action_type: 'RESET_SANDBOX_WORKSPACE';
11214
+ error: {
11215
+ type: string;
11216
+ message: string;
11217
+ };
9022
11218
  } | {
11219
+ /**
11220
+ ---
11221
+ title: Action Attempt ID
11222
+ ---
11223
+ The ID of the action attempt.
11224
+ */
11225
+ action_attempt_id: string;
9023
11226
  status: 'pending';
9024
- action_type: string;
11227
+ result: null;
11228
+ error: null;
11229
+ action_type: 'SET_COOL';
11230
+ } | {
11231
+ /**
11232
+ ---
11233
+ title: Action Attempt ID
11234
+ ---
11235
+ The ID of the action attempt.
11236
+ */
11237
+ action_attempt_id: string;
11238
+ status: 'success';
11239
+ error: null;
11240
+ action_type: 'SET_COOL';
11241
+ result: {};
11242
+ } | {
11243
+ /**
11244
+ ---
11245
+ title: Action Attempt ID
11246
+ ---
11247
+ The ID of the action attempt.
11248
+ */
11249
+ action_attempt_id: string;
11250
+ status: 'error';
11251
+ result: null;
11252
+ action_type: 'SET_COOL';
11253
+ error: {
11254
+ type: string;
11255
+ message: string;
11256
+ };
11257
+ } | {
11258
+ /**
11259
+ ---
11260
+ title: Action Attempt ID
11261
+ ---
11262
+ The ID of the action attempt.
11263
+ */
9025
11264
  action_attempt_id: string;
11265
+ status: 'pending';
9026
11266
  result: null;
9027
11267
  error: null;
11268
+ action_type: 'SET_HEAT';
11269
+ } | {
11270
+ /**
11271
+ ---
11272
+ title: Action Attempt ID
11273
+ ---
11274
+ The ID of the action attempt.
11275
+ */
11276
+ action_attempt_id: string;
11277
+ status: 'success';
11278
+ error: null;
11279
+ action_type: 'SET_HEAT';
11280
+ result: {};
9028
11281
  } | {
11282
+ /**
11283
+ ---
11284
+ title: Action Attempt ID
11285
+ ---
11286
+ The ID of the action attempt.
11287
+ */
11288
+ action_attempt_id: string;
9029
11289
  status: 'error';
9030
- action_type: string;
11290
+ result: null;
11291
+ action_type: 'SET_HEAT';
11292
+ error: {
11293
+ type: string;
11294
+ message: string;
11295
+ };
11296
+ } | {
11297
+ /**
11298
+ ---
11299
+ title: Action Attempt ID
11300
+ ---
11301
+ The ID of the action attempt.
11302
+ */
11303
+ action_attempt_id: string;
11304
+ status: 'pending';
11305
+ result: null;
11306
+ error: null;
11307
+ action_type: 'SET_HEAT_COOL';
11308
+ } | {
11309
+ /**
11310
+ ---
11311
+ title: Action Attempt ID
11312
+ ---
11313
+ The ID of the action attempt.
11314
+ */
11315
+ action_attempt_id: string;
11316
+ status: 'success';
11317
+ error: null;
11318
+ action_type: 'SET_HEAT_COOL';
11319
+ result: {};
11320
+ } | {
11321
+ /**
11322
+ ---
11323
+ title: Action Attempt ID
11324
+ ---
11325
+ The ID of the action attempt.
11326
+ */
11327
+ action_attempt_id: string;
11328
+ status: 'error';
11329
+ result: null;
11330
+ action_type: 'SET_HEAT_COOL';
11331
+ error: {
11332
+ type: string;
11333
+ message: string;
11334
+ };
11335
+ } | {
11336
+ /**
11337
+ ---
11338
+ title: Action Attempt ID
11339
+ ---
11340
+ The ID of the action attempt.
11341
+ */
11342
+ action_attempt_id: string;
11343
+ status: 'pending';
11344
+ result: null;
11345
+ error: null;
11346
+ action_type: 'SET_FAN_MODE';
11347
+ } | {
11348
+ /**
11349
+ ---
11350
+ title: Action Attempt ID
11351
+ ---
11352
+ The ID of the action attempt.
11353
+ */
11354
+ action_attempt_id: string;
11355
+ status: 'success';
11356
+ error: null;
11357
+ action_type: 'SET_FAN_MODE';
11358
+ result: {};
11359
+ } | {
11360
+ /**
11361
+ ---
11362
+ title: Action Attempt ID
11363
+ ---
11364
+ The ID of the action attempt.
11365
+ */
11366
+ action_attempt_id: string;
11367
+ status: 'error';
11368
+ result: null;
11369
+ action_type: 'SET_FAN_MODE';
11370
+ error: {
11371
+ type: string;
11372
+ message: string;
11373
+ };
11374
+ } | {
11375
+ /**
11376
+ ---
11377
+ title: Action Attempt ID
11378
+ ---
11379
+ The ID of the action attempt.
11380
+ */
11381
+ action_attempt_id: string;
11382
+ status: 'pending';
11383
+ result: null;
11384
+ error: null;
11385
+ action_type: 'SET_THERMOSTAT_OFF';
11386
+ } | {
11387
+ /**
11388
+ ---
11389
+ title: Action Attempt ID
11390
+ ---
11391
+ The ID of the action attempt.
11392
+ */
11393
+ action_attempt_id: string;
11394
+ status: 'success';
11395
+ error: null;
11396
+ action_type: 'SET_THERMOSTAT_OFF';
11397
+ result: {};
11398
+ } | {
11399
+ /**
11400
+ ---
11401
+ title: Action Attempt ID
11402
+ ---
11403
+ The ID of the action attempt.
11404
+ */
9031
11405
  action_attempt_id: string;
11406
+ status: 'error';
9032
11407
  result: null;
11408
+ action_type: 'SET_THERMOSTAT_OFF';
9033
11409
  error: {
9034
11410
  type: string;
9035
11411
  message: string;