@seamapi/types 1.175.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 (116) hide show
  1. package/dist/connect.cjs +1973 -161
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +4627 -403
  4. package/lib/seam/connect/model-types.d.ts +1 -1
  5. package/lib/seam/connect/models/acs/system.d.ts +36 -0
  6. package/lib/seam/connect/models/acs/system.js +8 -0
  7. package/lib/seam/connect/models/acs/system.js.map +1 -1
  8. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +556 -0
  9. package/lib/seam/connect/models/action-attempts/action-attempt.js +20 -0
  10. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -0
  11. package/lib/seam/connect/models/action-attempts/common.d.ts +53 -0
  12. package/lib/seam/connect/models/action-attempts/common.js +24 -0
  13. package/lib/seam/connect/models/action-attempts/common.js.map +1 -0
  14. package/lib/seam/connect/models/action-attempts/index.d.ts +1 -0
  15. package/lib/seam/connect/models/action-attempts/index.js +2 -0
  16. package/lib/seam/connect/models/action-attempts/index.js.map +1 -0
  17. package/lib/seam/connect/models/action-attempts/lock-door.d.ts +72 -0
  18. package/lib/seam/connect/models/action-attempts/lock-door.js +25 -0
  19. package/lib/seam/connect/models/action-attempts/lock-door.js.map +1 -0
  20. package/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.d.ts +71 -0
  21. package/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.js +28 -0
  22. package/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.js.map +1 -0
  23. package/lib/seam/connect/models/action-attempts/set-cool.d.ts +71 -0
  24. package/lib/seam/connect/models/action-attempts/set-cool.js +25 -0
  25. package/lib/seam/connect/models/action-attempts/set-cool.js.map +1 -0
  26. package/lib/seam/connect/models/action-attempts/set-fan-mode.d.ts +71 -0
  27. package/lib/seam/connect/models/action-attempts/set-fan-mode.js +25 -0
  28. package/lib/seam/connect/models/action-attempts/set-fan-mode.js.map +1 -0
  29. package/lib/seam/connect/models/action-attempts/set-heat-cool.d.ts +71 -0
  30. package/lib/seam/connect/models/action-attempts/set-heat-cool.js +25 -0
  31. package/lib/seam/connect/models/action-attempts/set-heat-cool.js.map +1 -0
  32. package/lib/seam/connect/models/action-attempts/set-heat.d.ts +71 -0
  33. package/lib/seam/connect/models/action-attempts/set-heat.js +25 -0
  34. package/lib/seam/connect/models/action-attempts/set-heat.js.map +1 -0
  35. package/lib/seam/connect/models/action-attempts/set-thermostat-off.d.ts +71 -0
  36. package/lib/seam/connect/models/action-attempts/set-thermostat-off.js +25 -0
  37. package/lib/seam/connect/models/action-attempts/set-thermostat-off.js.map +1 -0
  38. package/lib/seam/connect/models/action-attempts/unlock-door.d.ts +72 -0
  39. package/lib/seam/connect/models/action-attempts/unlock-door.js +25 -0
  40. package/lib/seam/connect/models/action-attempts/unlock-door.js.map +1 -0
  41. package/lib/seam/connect/models/devices/managed-device.js +6 -2
  42. package/lib/seam/connect/models/devices/managed-device.js.map +1 -1
  43. package/lib/seam/connect/models/events/access-codes.d.ts +1 -1
  44. package/lib/seam/connect/models/events/access-codes.js +1 -1
  45. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  46. package/lib/seam/connect/models/events/acs/common.d.ts +1 -1
  47. package/lib/seam/connect/models/events/acs/common.js +1 -1
  48. package/lib/seam/connect/models/events/acs/common.js.map +1 -1
  49. package/lib/seam/connect/models/events/acs/credentials.d.ts +1 -1
  50. package/lib/seam/connect/models/events/acs/credentials.js +1 -1
  51. package/lib/seam/connect/models/events/acs/credentials.js.map +1 -1
  52. package/lib/seam/connect/models/events/acs/users.d.ts +1 -1
  53. package/lib/seam/connect/models/events/acs/users.js +1 -1
  54. package/lib/seam/connect/models/events/acs/users.js.map +1 -1
  55. package/lib/seam/connect/models/events/action-attempts.d.ts +10 -10
  56. package/lib/seam/connect/models/events/client-sessions.d.ts +1 -1
  57. package/lib/seam/connect/models/events/client-sessions.js +1 -1
  58. package/lib/seam/connect/models/events/client-sessions.js.map +1 -1
  59. package/lib/seam/connect/models/events/common.d.ts +1 -1
  60. package/lib/seam/connect/models/events/common.js +1 -1
  61. package/lib/seam/connect/models/events/common.js.map +1 -1
  62. package/lib/seam/connect/models/events/connected-accounts.d.ts +1 -1
  63. package/lib/seam/connect/models/events/connected-accounts.js +1 -1
  64. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  65. package/lib/seam/connect/models/events/devices.d.ts +1 -1
  66. package/lib/seam/connect/models/events/devices.js +1 -1
  67. package/lib/seam/connect/models/events/devices.js.map +1 -1
  68. package/lib/seam/connect/models/events/enrollment-automations.d.ts +1 -1
  69. package/lib/seam/connect/models/events/enrollment-automations.js +1 -1
  70. package/lib/seam/connect/models/events/enrollment-automations.js.map +1 -1
  71. package/lib/seam/connect/models/events/phones.d.ts +1 -1
  72. package/lib/seam/connect/models/events/phones.js +1 -1
  73. package/lib/seam/connect/models/events/phones.js.map +1 -1
  74. package/lib/seam/connect/models/events/seam-event.d.ts +1 -1
  75. package/lib/seam/connect/models/events/seam-event.js +1 -1
  76. package/lib/seam/connect/models/events/seam-event.js.map +1 -1
  77. package/lib/seam/connect/models/index.d.ts +1 -0
  78. package/lib/seam/connect/models/index.js +1 -0
  79. package/lib/seam/connect/models/index.js.map +1 -1
  80. package/lib/seam/connect/openapi.d.ts +1366 -105
  81. package/lib/seam/connect/openapi.js +1686 -28
  82. package/lib/seam/connect/openapi.js.map +1 -1
  83. package/lib/seam/connect/route-types.d.ts +2764 -356
  84. package/lib/seam/connect/schemas.d.ts +1 -1
  85. package/lib/seam/connect/schemas.js +1 -1
  86. package/lib/seam/connect/schemas.js.map +1 -1
  87. package/package.json +1 -1
  88. package/src/lib/seam/connect/model-types.ts +1 -0
  89. package/src/lib/seam/connect/models/acs/system.ts +12 -0
  90. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +25 -0
  91. package/src/lib/seam/connect/models/action-attempts/common.ts +27 -0
  92. package/src/lib/seam/connect/models/action-attempts/index.ts +1 -0
  93. package/src/lib/seam/connect/models/action-attempts/lock-door.ts +35 -0
  94. package/src/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.ts +39 -0
  95. package/src/lib/seam/connect/models/action-attempts/set-cool.ts +33 -0
  96. package/src/lib/seam/connect/models/action-attempts/set-fan-mode.ts +33 -0
  97. package/src/lib/seam/connect/models/action-attempts/set-heat-cool.ts +33 -0
  98. package/src/lib/seam/connect/models/action-attempts/set-heat.ts +33 -0
  99. package/src/lib/seam/connect/models/action-attempts/set-thermostat-off.ts +36 -0
  100. package/src/lib/seam/connect/models/action-attempts/unlock-door.ts +35 -0
  101. package/src/lib/seam/connect/models/devices/managed-device.ts +8 -2
  102. package/src/lib/seam/connect/models/events/access-codes.ts +1 -1
  103. package/src/lib/seam/connect/models/events/acs/common.ts +1 -1
  104. package/src/lib/seam/connect/models/events/acs/credentials.ts +1 -1
  105. package/src/lib/seam/connect/models/events/acs/users.ts +1 -1
  106. package/src/lib/seam/connect/models/events/client-sessions.ts +1 -1
  107. package/src/lib/seam/connect/models/events/common.ts +1 -1
  108. package/src/lib/seam/connect/models/events/connected-accounts.ts +1 -1
  109. package/src/lib/seam/connect/models/events/devices.ts +1 -1
  110. package/src/lib/seam/connect/models/events/enrollment-automations.ts +1 -1
  111. package/src/lib/seam/connect/models/events/phones.ts +1 -1
  112. package/src/lib/seam/connect/models/events/seam-event.ts +1 -1
  113. package/src/lib/seam/connect/models/index.ts +1 -0
  114. package/src/lib/seam/connect/openapi.ts +1710 -28
  115. package/src/lib/seam/connect/route-types.ts +3452 -876
  116. package/src/lib/seam/connect/schemas.ts +6 -1
@@ -1300,6 +1300,14 @@ export interface Routes {
1300
1300
  connected_account_ids: string[];
1301
1301
  image_url: string;
1302
1302
  image_alt_text: string;
1303
+ errors: Array<{
1304
+ error_code: string;
1305
+ message: string;
1306
+ }>;
1307
+ warnings: Array<{
1308
+ warning_code: string;
1309
+ message: string;
1310
+ }>;
1303
1311
  can_automate_enrollment?: boolean | undefined;
1304
1312
  can_create_acs_access_groups?: boolean | undefined;
1305
1313
  can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
@@ -1339,6 +1347,14 @@ export interface Routes {
1339
1347
  connected_account_ids: string[];
1340
1348
  image_url: string;
1341
1349
  image_alt_text: string;
1350
+ errors: Array<{
1351
+ error_code: string;
1352
+ message: string;
1353
+ }>;
1354
+ warnings: Array<{
1355
+ warning_code: string;
1356
+ message: string;
1357
+ }>;
1342
1358
  can_automate_enrollment?: boolean | undefined;
1343
1359
  can_create_acs_access_groups?: boolean | undefined;
1344
1360
  can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
@@ -1378,6 +1394,14 @@ export interface Routes {
1378
1394
  connected_account_ids: string[];
1379
1395
  image_url: string;
1380
1396
  image_alt_text: string;
1397
+ errors: Array<{
1398
+ error_code: string;
1399
+ message: string;
1400
+ }>;
1401
+ warnings: Array<{
1402
+ warning_code: string;
1403
+ message: string;
1404
+ }>;
1381
1405
  can_automate_enrollment?: boolean | undefined;
1382
1406
  can_create_acs_access_groups?: boolean | undefined;
1383
1407
  can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
@@ -2198,7 +2222,11 @@ export interface Routes {
2198
2222
  offline_access_codes_supported?: boolean | undefined;
2199
2223
  /** Indicates whether the device supports online access codes. */
2200
2224
  online_access_codes_supported?: boolean | undefined;
2201
- /** Indicates whether the device supports an accessory keypad. */
2225
+ /**
2226
+ ---
2227
+ deprecated: use device.properties.model.can_connect_accessory_keypad
2228
+ ---
2229
+ */
2202
2230
  accessory_keypad_supported?: boolean | undefined;
2203
2231
  };
2204
2232
  /** Indicates whether the device has direct power. */
@@ -2224,7 +2252,7 @@ export interface Routes {
2224
2252
  offline_access_codes_enabled?: boolean | undefined;
2225
2253
  /**
2226
2254
  ---
2227
- deprecated: use model.accessory_keypad_supported
2255
+ deprecated: use device.properties.model.can_connect_accessory_keypad
2228
2256
  ---
2229
2257
  */
2230
2258
  supports_accessory_keypad?: boolean | undefined;
@@ -2738,7 +2766,11 @@ export interface Routes {
2738
2766
  offline_access_codes_supported?: boolean | undefined;
2739
2767
  /** Indicates whether the device supports online access codes. */
2740
2768
  online_access_codes_supported?: boolean | undefined;
2741
- /** Indicates whether the device supports an accessory keypad. */
2769
+ /**
2770
+ ---
2771
+ deprecated: use device.properties.model.can_connect_accessory_keypad
2772
+ ---
2773
+ */
2742
2774
  accessory_keypad_supported?: boolean | undefined;
2743
2775
  };
2744
2776
  /** Indicates whether the device has direct power. */
@@ -2764,7 +2796,7 @@ export interface Routes {
2764
2796
  offline_access_codes_enabled?: boolean | undefined;
2765
2797
  /**
2766
2798
  ---
2767
- deprecated: use model.accessory_keypad_supported
2799
+ deprecated: use device.properties.model.can_connect_accessory_keypad
2768
2800
  ---
2769
2801
  */
2770
2802
  supports_accessory_keypad?: boolean | undefined;
@@ -3320,7 +3352,11 @@ export interface Routes {
3320
3352
  offline_access_codes_supported?: boolean | undefined;
3321
3353
  /** Indicates whether the device supports online access codes. */
3322
3354
  online_access_codes_supported?: boolean | undefined;
3323
- /** Indicates whether the device supports an accessory keypad. */
3355
+ /**
3356
+ ---
3357
+ deprecated: use device.properties.model.can_connect_accessory_keypad
3358
+ ---
3359
+ */
3324
3360
  accessory_keypad_supported?: boolean | undefined;
3325
3361
  };
3326
3362
  };
@@ -3428,7 +3464,11 @@ export interface Routes {
3428
3464
  offline_access_codes_supported?: boolean | undefined;
3429
3465
  /** Indicates whether the device supports online access codes. */
3430
3466
  online_access_codes_supported?: boolean | undefined;
3431
- /** Indicates whether the device supports an accessory keypad. */
3467
+ /**
3468
+ ---
3469
+ deprecated: use device.properties.model.can_connect_accessory_keypad
3470
+ ---
3471
+ */
3432
3472
  accessory_keypad_supported?: boolean | undefined;
3433
3473
  };
3434
3474
  };
@@ -3592,7 +3632,11 @@ export interface Routes {
3592
3632
  offline_access_codes_supported?: boolean | undefined;
3593
3633
  /** Indicates whether the device supports online access codes. */
3594
3634
  online_access_codes_supported?: boolean | undefined;
3595
- /** Indicates whether the device supports an accessory keypad. */
3635
+ /**
3636
+ ---
3637
+ deprecated: use device.properties.model.can_connect_accessory_keypad
3638
+ ---
3639
+ */
3596
3640
  accessory_keypad_supported?: boolean | undefined;
3597
3641
  };
3598
3642
  /** Indicates whether the device has direct power. */
@@ -3618,7 +3662,7 @@ export interface Routes {
3618
3662
  offline_access_codes_enabled?: boolean | undefined;
3619
3663
  /**
3620
3664
  ---
3621
- deprecated: use model.accessory_keypad_supported
3665
+ deprecated: use device.properties.model.can_connect_accessory_keypad
3622
3666
  ---
3623
3667
  */
3624
3668
  supports_accessory_keypad?: boolean | undefined;
@@ -4107,7 +4151,11 @@ export interface Routes {
4107
4151
  offline_access_codes_supported?: boolean | undefined;
4108
4152
  /** Indicates whether the device supports online access codes. */
4109
4153
  online_access_codes_supported?: boolean | undefined;
4110
- /** Indicates whether the device supports an accessory keypad. */
4154
+ /**
4155
+ ---
4156
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4157
+ ---
4158
+ */
4111
4159
  accessory_keypad_supported?: boolean | undefined;
4112
4160
  };
4113
4161
  /** Indicates whether the device has direct power. */
@@ -4133,7 +4181,7 @@ export interface Routes {
4133
4181
  offline_access_codes_enabled?: boolean | undefined;
4134
4182
  /**
4135
4183
  ---
4136
- deprecated: use model.accessory_keypad_supported
4184
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4137
4185
  ---
4138
4186
  */
4139
4187
  supports_accessory_keypad?: boolean | undefined;
@@ -4647,7 +4695,11 @@ export interface Routes {
4647
4695
  offline_access_codes_supported?: boolean | undefined;
4648
4696
  /** Indicates whether the device supports online access codes. */
4649
4697
  online_access_codes_supported?: boolean | undefined;
4650
- /** Indicates whether the device supports an accessory keypad. */
4698
+ /**
4699
+ ---
4700
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4701
+ ---
4702
+ */
4651
4703
  accessory_keypad_supported?: boolean | undefined;
4652
4704
  };
4653
4705
  /** Indicates whether the device has direct power. */
@@ -4673,7 +4725,7 @@ export interface Routes {
4673
4725
  offline_access_codes_enabled?: boolean | undefined;
4674
4726
  /**
4675
4727
  ---
4676
- deprecated: use model.accessory_keypad_supported
4728
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4677
4729
  ---
4678
4730
  */
4679
4731
  supports_accessory_keypad?: boolean | undefined;
@@ -5162,7 +5214,11 @@ export interface Routes {
5162
5214
  offline_access_codes_supported?: boolean | undefined;
5163
5215
  /** Indicates whether the device supports online access codes. */
5164
5216
  online_access_codes_supported?: boolean | undefined;
5165
- /** Indicates whether the device supports an accessory keypad. */
5217
+ /**
5218
+ ---
5219
+ deprecated: use device.properties.model.can_connect_accessory_keypad
5220
+ ---
5221
+ */
5166
5222
  accessory_keypad_supported?: boolean | undefined;
5167
5223
  };
5168
5224
  /** Indicates whether the device has direct power. */
@@ -5188,7 +5244,7 @@ export interface Routes {
5188
5244
  offline_access_codes_enabled?: boolean | undefined;
5189
5245
  /**
5190
5246
  ---
5191
- deprecated: use model.accessory_keypad_supported
5247
+ deprecated: use device.properties.model.can_connect_accessory_keypad
5192
5248
  ---
5193
5249
  */
5194
5250
  supports_accessory_keypad?: boolean | undefined;
@@ -5643,260 +5699,313 @@ export interface Routes {
5643
5699
  formData: {};
5644
5700
  jsonResponse: {
5645
5701
  action_attempt: {
5646
- status: 'success';
5647
- action_type: string;
5702
+ /**
5703
+ ---
5704
+ title: Action Attempt ID
5705
+ ---
5706
+ The ID of the action attempt.
5707
+ */
5648
5708
  action_attempt_id: string;
5649
- result?: any;
5709
+ status: 'pending';
5710
+ result: null;
5650
5711
  error: null;
5712
+ action_type: 'LOCK_DOOR';
5651
5713
  } | {
5652
- status: 'pending';
5653
- action_type: string;
5714
+ /**
5715
+ ---
5716
+ title: Action Attempt ID
5717
+ ---
5718
+ The ID of the action attempt.
5719
+ */
5654
5720
  action_attempt_id: string;
5655
- result: null;
5721
+ status: 'success';
5656
5722
  error: null;
5723
+ action_type: 'LOCK_DOOR';
5724
+ result: {};
5657
5725
  } | {
5658
- status: 'error';
5659
- action_type: string;
5726
+ /**
5727
+ ---
5728
+ title: Action Attempt ID
5729
+ ---
5730
+ The ID of the action attempt.
5731
+ */
5660
5732
  action_attempt_id: string;
5733
+ status: 'error';
5661
5734
  result: null;
5735
+ action_type: 'LOCK_DOOR';
5662
5736
  error: {
5663
5737
  type: string;
5664
5738
  message: string;
5665
5739
  };
5666
- };
5667
- };
5668
- };
5669
- '/locks/unlock_door': {
5670
- route: '/locks/unlock_door';
5671
- method: 'POST';
5672
- queryParams: {};
5673
- jsonBody: {
5674
- device_id: string;
5675
- sync?: boolean;
5676
- };
5677
- commonParams: {};
5678
- formData: {};
5679
- jsonResponse: {
5680
- action_attempt: {
5681
- status: 'success';
5682
- action_type: string;
5740
+ } | {
5741
+ /**
5742
+ ---
5743
+ title: Action Attempt ID
5744
+ ---
5745
+ The ID of the action attempt.
5746
+ */
5683
5747
  action_attempt_id: string;
5684
- result?: any;
5748
+ status: 'pending';
5749
+ result: null;
5685
5750
  error: null;
5751
+ action_type: 'UNLOCK_DOOR';
5686
5752
  } | {
5687
- status: 'pending';
5688
- action_type: string;
5753
+ /**
5754
+ ---
5755
+ title: Action Attempt ID
5756
+ ---
5757
+ The ID of the action attempt.
5758
+ */
5689
5759
  action_attempt_id: string;
5690
- result: null;
5760
+ status: 'success';
5691
5761
  error: null;
5762
+ action_type: 'UNLOCK_DOOR';
5763
+ result: {};
5692
5764
  } | {
5693
- status: 'error';
5694
- action_type: string;
5765
+ /**
5766
+ ---
5767
+ title: Action Attempt ID
5768
+ ---
5769
+ The ID of the action attempt.
5770
+ */
5695
5771
  action_attempt_id: string;
5772
+ status: 'error';
5696
5773
  result: null;
5774
+ action_type: 'UNLOCK_DOOR';
5697
5775
  error: {
5698
5776
  type: string;
5699
5777
  message: string;
5700
5778
  };
5701
- };
5702
- };
5703
- };
5704
- '/networks/get': {
5705
- route: '/networks/get';
5706
- method: 'GET' | 'POST';
5707
- queryParams: {};
5708
- jsonBody: {};
5709
- commonParams: {
5710
- network_id: string;
5711
- };
5712
- formData: {};
5713
- jsonResponse: {
5714
- network: {
5715
- network_id: string;
5716
- workspace_id: string;
5717
- display_name: string;
5718
- created_at: string;
5719
- };
5720
- };
5721
- };
5722
- '/networks/list': {
5723
- route: '/networks/list';
5724
- method: 'GET' | 'POST';
5725
- queryParams: {};
5726
- jsonBody: {};
5727
- commonParams: {};
5728
- formData: {};
5729
- jsonResponse: {
5730
- networks: Array<{
5731
- network_id: string;
5732
- workspace_id: string;
5733
- display_name: string;
5734
- created_at: string;
5735
- }>;
5736
- };
5737
- };
5738
- '/noise_sensors/noise_thresholds/create': {
5739
- route: '/noise_sensors/noise_thresholds/create';
5740
- method: 'POST';
5741
- queryParams: {};
5742
- jsonBody: {
5743
- device_id: string;
5744
- sync?: boolean;
5745
- name?: string | undefined;
5746
- starts_daily_at: string;
5747
- ends_daily_at: string;
5748
- noise_threshold_decibels?: number | undefined;
5749
- noise_threshold_nrs?: number | undefined;
5750
- };
5751
- commonParams: {};
5752
- formData: {};
5753
- jsonResponse: {
5754
- action_attempt: {
5755
- status: 'success';
5756
- action_type: string;
5779
+ } | {
5780
+ /**
5781
+ ---
5782
+ title: Action Attempt ID
5783
+ ---
5784
+ The ID of the action attempt.
5785
+ */
5757
5786
  action_attempt_id: string;
5758
- result?: any;
5787
+ status: 'pending';
5788
+ result: null;
5759
5789
  error: null;
5790
+ action_type: 'RESET_SANDBOX_WORKSPACE';
5760
5791
  } | {
5761
- status: 'pending';
5762
- action_type: string;
5792
+ /**
5793
+ ---
5794
+ title: Action Attempt ID
5795
+ ---
5796
+ The ID of the action attempt.
5797
+ */
5763
5798
  action_attempt_id: string;
5764
- result: null;
5799
+ status: 'success';
5765
5800
  error: null;
5801
+ action_type: 'RESET_SANDBOX_WORKSPACE';
5802
+ result: {};
5766
5803
  } | {
5767
- status: 'error';
5768
- action_type: string;
5804
+ /**
5805
+ ---
5806
+ title: Action Attempt ID
5807
+ ---
5808
+ The ID of the action attempt.
5809
+ */
5769
5810
  action_attempt_id: string;
5811
+ status: 'error';
5770
5812
  result: null;
5813
+ action_type: 'RESET_SANDBOX_WORKSPACE';
5771
5814
  error: {
5772
5815
  type: string;
5773
5816
  message: string;
5774
5817
  };
5775
- };
5776
- noise_threshold: {
5777
- noise_threshold_id: string;
5778
- device_id: string;
5779
- name: string;
5780
- noise_threshold_nrs?: number | undefined;
5781
- starts_daily_at: string;
5782
- ends_daily_at: string;
5783
- noise_threshold_decibels: number;
5784
- };
5785
- };
5786
- };
5787
- '/noise_sensors/noise_thresholds/delete': {
5788
- route: '/noise_sensors/noise_thresholds/delete';
5789
- method: 'DELETE' | 'POST';
5790
- queryParams: {};
5791
- jsonBody: {
5792
- noise_threshold_id: string;
5793
- device_id: string;
5794
- sync?: boolean;
5795
- };
5796
- commonParams: {};
5797
- formData: {};
5798
- jsonResponse: {
5799
- action_attempt: {
5800
- status: 'success';
5801
- action_type: string;
5818
+ } | {
5819
+ /**
5820
+ ---
5821
+ title: Action Attempt ID
5822
+ ---
5823
+ The ID of the action attempt.
5824
+ */
5802
5825
  action_attempt_id: string;
5803
- result?: any;
5826
+ status: 'pending';
5827
+ result: null;
5804
5828
  error: null;
5829
+ action_type: 'SET_COOL';
5805
5830
  } | {
5806
- status: 'pending';
5807
- action_type: string;
5831
+ /**
5832
+ ---
5833
+ title: Action Attempt ID
5834
+ ---
5835
+ The ID of the action attempt.
5836
+ */
5808
5837
  action_attempt_id: string;
5809
- result: null;
5838
+ status: 'success';
5810
5839
  error: null;
5840
+ action_type: 'SET_COOL';
5841
+ result: {};
5811
5842
  } | {
5843
+ /**
5844
+ ---
5845
+ title: Action Attempt ID
5846
+ ---
5847
+ The ID of the action attempt.
5848
+ */
5849
+ action_attempt_id: string;
5812
5850
  status: 'error';
5813
- action_type: string;
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';
5866
+ result: null;
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: {};
5881
+ } | {
5882
+ /**
5883
+ ---
5884
+ title: Action Attempt ID
5885
+ ---
5886
+ The ID of the action attempt.
5887
+ */
5814
5888
  action_attempt_id: string;
5889
+ status: 'error';
5815
5890
  result: null;
5891
+ action_type: 'SET_HEAT';
5816
5892
  error: {
5817
5893
  type: string;
5818
5894
  message: string;
5819
5895
  };
5820
- };
5821
- };
5822
- };
5823
- '/noise_sensors/noise_thresholds/get': {
5824
- route: '/noise_sensors/noise_thresholds/get';
5825
- method: 'GET' | 'POST';
5826
- queryParams: {};
5827
- jsonBody: {};
5828
- commonParams: {
5829
- noise_threshold_id: string;
5830
- };
5831
- formData: {};
5832
- jsonResponse: {
5833
- noise_threshold: {
5834
- noise_threshold_id: string;
5835
- device_id: string;
5836
- name: string;
5837
- noise_threshold_nrs?: number | undefined;
5838
- starts_daily_at: string;
5839
- ends_daily_at: string;
5840
- noise_threshold_decibels: number;
5841
- };
5842
- };
5843
- };
5844
- '/noise_sensors/noise_thresholds/list': {
5845
- route: '/noise_sensors/noise_thresholds/list';
5846
- method: 'GET' | 'POST';
5847
- queryParams: {};
5848
- jsonBody: {};
5849
- commonParams: {
5850
- device_id: string;
5851
- is_programmed?: boolean | undefined;
5852
- };
5853
- formData: {};
5854
- jsonResponse: {
5855
- noise_thresholds: Array<{
5856
- noise_threshold_id: string;
5857
- device_id: string;
5858
- name: string;
5859
- noise_threshold_nrs?: number | undefined;
5860
- starts_daily_at: string;
5861
- ends_daily_at: string;
5862
- noise_threshold_decibels: number;
5863
- }>;
5864
- };
5865
- };
5866
- '/noise_sensors/noise_thresholds/update': {
5867
- route: '/noise_sensors/noise_thresholds/update';
5868
- method: 'PATCH' | 'POST' | 'PUT';
5869
- queryParams: {};
5870
- jsonBody: {
5871
- noise_threshold_id: string;
5872
- device_id: string;
5873
- sync?: boolean;
5874
- name?: string | undefined;
5875
- starts_daily_at?: string | undefined;
5876
- ends_daily_at?: string | undefined;
5877
- noise_threshold_decibels?: number | undefined;
5878
- noise_threshold_nrs?: number | undefined;
5879
- };
5880
- commonParams: {};
5881
- formData: {};
5882
- jsonResponse: {
5883
- action_attempt: {
5884
- status: 'success';
5885
- action_type: string;
5896
+ } | {
5897
+ /**
5898
+ ---
5899
+ title: Action Attempt ID
5900
+ ---
5901
+ The ID of the action attempt.
5902
+ */
5886
5903
  action_attempt_id: string;
5887
- result?: any;
5904
+ status: 'pending';
5905
+ result: null;
5888
5906
  error: null;
5907
+ action_type: 'SET_HEAT_COOL';
5889
5908
  } | {
5890
- status: 'pending';
5891
- action_type: string;
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
+ */
5927
+ action_attempt_id: string;
5928
+ status: 'error';
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
+ */
5892
5942
  action_attempt_id: string;
5943
+ status: 'pending';
5893
5944
  result: null;
5894
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: {};
5895
5959
  } | {
5960
+ /**
5961
+ ---
5962
+ title: Action Attempt ID
5963
+ ---
5964
+ The ID of the action attempt.
5965
+ */
5966
+ action_attempt_id: string;
5896
5967
  status: 'error';
5897
- action_type: string;
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
+ */
5898
6005
  action_attempt_id: string;
6006
+ status: 'error';
5899
6007
  result: null;
6008
+ action_type: 'SET_THERMOSTAT_OFF';
5900
6009
  error: {
5901
6010
  type: string;
5902
6011
  message: string;
@@ -5904,83 +6013,612 @@ export interface Routes {
5904
6013
  };
5905
6014
  };
5906
6015
  };
5907
- '/noise_sensors/simulate/trigger_noise_threshold': {
5908
- route: '/noise_sensors/simulate/trigger_noise_threshold';
6016
+ '/locks/unlock_door': {
6017
+ route: '/locks/unlock_door';
5909
6018
  method: 'POST';
5910
6019
  queryParams: {};
5911
6020
  jsonBody: {
5912
6021
  device_id: string;
6022
+ sync?: boolean;
5913
6023
  };
5914
6024
  commonParams: {};
5915
6025
  formData: {};
5916
- jsonResponse: {};
5917
- };
5918
- '/phones/deactivate': {
5919
- route: '/phones/deactivate';
5920
- method: 'DELETE' | 'POST';
5921
- queryParams: {};
5922
- jsonBody: {
5923
- device_id: string;
5924
- };
5925
- commonParams: {};
5926
- formData: {};
5927
- jsonResponse: {};
5928
- };
5929
- '/phones/list': {
5930
- route: '/phones/list';
5931
- method: 'GET' | 'POST';
5932
- queryParams: {};
5933
- jsonBody: {};
5934
- commonParams: {
5935
- owner_user_identity_id?: string | undefined;
5936
- };
5937
- formData: {};
5938
6026
  jsonResponse: {
5939
- phones: Array<{
5940
- /** Unique identifier for the device. */
5941
- device_id: string;
5942
- device_type: 'android_phone' | 'ios_phone';
5943
- /** Optional nickname to describe the device, settable through Seam */
5944
- nickname?: string | undefined;
5945
- /** 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. */
5946
- display_name: string;
5947
- /** 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. */
5948
- capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
5949
- properties: {
5950
- assa_abloy_credential_service_metadata?: {
5951
- has_active_endpoint: boolean;
5952
- endpoints: Array<{
5953
- endpoint_id: string;
5954
- is_active: boolean;
5955
- }>;
5956
- } | undefined;
5957
- };
5958
- /** Location information for the device. */
5959
- location: {
5960
- /** Name of the device location. */
5961
- location_name?: string | undefined;
5962
- /** Time zone of the device location. */
5963
- timezone?: string | undefined;
5964
- } | null;
5965
- /** Unique identifier for the Seam workspace associated with the device. */
5966
- workspace_id: string;
5967
- /** 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. */
5968
- errors: Array<{
5969
- error_code: string;
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;
6047
+ status: 'success';
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
+ */
6058
+ action_attempt_id: string;
6059
+ status: 'error';
6060
+ result: null;
6061
+ action_type: 'LOCK_DOOR';
6062
+ error: {
6063
+ type: string;
5970
6064
  message: string;
5971
- }>;
5972
- /** 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. */
5973
- warnings: Array<{
5974
- warning_code: 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';
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;
5975
6103
  message: string;
5976
- }>;
5977
- /** Date and time at which the device object was created. */
5978
- created_at: string;
5979
- /** Indicates whether Seam manages the device. */
5980
- is_managed: true;
5981
- custom_metadata: Record<string, string | boolean>;
5982
- can_remotely_unlock?: boolean | undefined;
5983
- can_remotely_lock?: boolean | undefined;
6104
+ };
6105
+ } | {
6106
+ /**
6107
+ ---
6108
+ title: Action Attempt ID
6109
+ ---
6110
+ The ID of the action attempt.
6111
+ */
6112
+ action_attempt_id: string;
6113
+ status: 'pending';
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
+ */
6151
+ action_attempt_id: string;
6152
+ status: 'pending';
6153
+ result: null;
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: {};
6168
+ } | {
6169
+ /**
6170
+ ---
6171
+ title: Action Attempt ID
6172
+ ---
6173
+ The ID of the action attempt.
6174
+ */
6175
+ action_attempt_id: string;
6176
+ status: 'error';
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
+ */
6214
+ action_attempt_id: string;
6215
+ status: 'error';
6216
+ result: null;
6217
+ action_type: 'SET_HEAT';
6218
+ error: {
6219
+ type: string;
6220
+ message: string;
6221
+ };
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
+ };
6340
+ };
6341
+ };
6342
+ '/networks/get': {
6343
+ route: '/networks/get';
6344
+ method: 'GET' | 'POST';
6345
+ queryParams: {};
6346
+ jsonBody: {};
6347
+ commonParams: {
6348
+ network_id: string;
6349
+ };
6350
+ formData: {};
6351
+ jsonResponse: {
6352
+ network: {
6353
+ network_id: string;
6354
+ workspace_id: string;
6355
+ display_name: string;
6356
+ created_at: string;
6357
+ };
6358
+ };
6359
+ };
6360
+ '/networks/list': {
6361
+ route: '/networks/list';
6362
+ method: 'GET' | 'POST';
6363
+ queryParams: {};
6364
+ jsonBody: {};
6365
+ commonParams: {};
6366
+ formData: {};
6367
+ jsonResponse: {
6368
+ networks: Array<{
6369
+ network_id: string;
6370
+ workspace_id: string;
6371
+ display_name: string;
6372
+ created_at: string;
6373
+ }>;
6374
+ };
6375
+ };
6376
+ '/noise_sensors/noise_thresholds/create': {
6377
+ route: '/noise_sensors/noise_thresholds/create';
6378
+ method: 'POST';
6379
+ queryParams: {};
6380
+ jsonBody: {
6381
+ device_id: string;
6382
+ sync?: boolean;
6383
+ name?: string | undefined;
6384
+ starts_daily_at: string;
6385
+ ends_daily_at: string;
6386
+ noise_threshold_decibels?: number | undefined;
6387
+ noise_threshold_nrs?: number | undefined;
6388
+ };
6389
+ commonParams: {};
6390
+ formData: {};
6391
+ jsonResponse: {
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;
6422
+ };
6423
+ };
6424
+ };
6425
+ '/noise_sensors/noise_thresholds/delete': {
6426
+ route: '/noise_sensors/noise_thresholds/delete';
6427
+ method: 'DELETE' | 'POST';
6428
+ queryParams: {};
6429
+ jsonBody: {
6430
+ noise_threshold_id: string;
6431
+ device_id: string;
6432
+ sync?: boolean;
6433
+ };
6434
+ commonParams: {};
6435
+ formData: {};
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
+ };
6460
+ };
6461
+ '/noise_sensors/noise_thresholds/get': {
6462
+ route: '/noise_sensors/noise_thresholds/get';
6463
+ method: 'GET' | 'POST';
6464
+ queryParams: {};
6465
+ jsonBody: {};
6466
+ commonParams: {
6467
+ noise_threshold_id: string;
6468
+ };
6469
+ formData: {};
6470
+ jsonResponse: {
6471
+ noise_threshold: {
6472
+ noise_threshold_id: string;
6473
+ device_id: string;
6474
+ name: string;
6475
+ noise_threshold_nrs?: number | undefined;
6476
+ starts_daily_at: string;
6477
+ ends_daily_at: string;
6478
+ noise_threshold_decibels: number;
6479
+ };
6480
+ };
6481
+ };
6482
+ '/noise_sensors/noise_thresholds/list': {
6483
+ route: '/noise_sensors/noise_thresholds/list';
6484
+ method: 'GET' | 'POST';
6485
+ queryParams: {};
6486
+ jsonBody: {};
6487
+ commonParams: {
6488
+ device_id: string;
6489
+ is_programmed?: boolean | undefined;
6490
+ };
6491
+ formData: {};
6492
+ jsonResponse: {
6493
+ noise_thresholds: Array<{
6494
+ noise_threshold_id: string;
6495
+ device_id: string;
6496
+ name: string;
6497
+ noise_threshold_nrs?: number | undefined;
6498
+ starts_daily_at: string;
6499
+ ends_daily_at: string;
6500
+ noise_threshold_decibels: number;
6501
+ }>;
6502
+ };
6503
+ };
6504
+ '/noise_sensors/noise_thresholds/update': {
6505
+ route: '/noise_sensors/noise_thresholds/update';
6506
+ method: 'PATCH' | 'POST' | 'PUT';
6507
+ queryParams: {};
6508
+ jsonBody: {
6509
+ noise_threshold_id: string;
6510
+ device_id: string;
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;
6517
+ };
6518
+ commonParams: {};
6519
+ formData: {};
6520
+ jsonResponse: {
6521
+ action_attempt: {
6522
+ status: 'success';
6523
+ action_type: string;
6524
+ action_attempt_id: string;
6525
+ result?: any;
6526
+ error: null;
6527
+ } | {
6528
+ status: 'pending';
6529
+ action_type: string;
6530
+ action_attempt_id: string;
6531
+ result: null;
6532
+ error: null;
6533
+ } | {
6534
+ status: 'error';
6535
+ action_type: string;
6536
+ action_attempt_id: string;
6537
+ result: null;
6538
+ error: {
6539
+ type: string;
6540
+ message: string;
6541
+ };
6542
+ };
6543
+ };
6544
+ };
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';
6569
+ method: 'GET' | 'POST';
6570
+ queryParams: {};
6571
+ jsonBody: {};
6572
+ commonParams: {
6573
+ owner_user_identity_id?: string | undefined;
6574
+ };
6575
+ formData: {};
6576
+ jsonResponse: {
6577
+ phones: Array<{
6578
+ /** Unique identifier for the device. */
6579
+ device_id: string;
6580
+ device_type: 'android_phone' | 'ios_phone';
6581
+ /** Optional nickname to describe the device, settable through Seam */
6582
+ nickname?: string | undefined;
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. */
6584
+ display_name: string;
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. */
6586
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
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
+ }>;
6594
+ } | 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;
5984
6622
  can_program_offline_access_codes?: boolean | undefined;
5985
6623
  can_program_online_access_codes?: boolean | undefined;
5986
6624
  can_simulate_removal?: boolean | undefined;
@@ -6238,22 +6876,313 @@ export interface Routes {
6238
6876
  formData: {};
6239
6877
  jsonResponse: {
6240
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;
6241
6898
  status: 'success';
6242
- action_type: string;
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
+ */
6243
7080
  action_attempt_id: string;
6244
- result?: any;
7081
+ status: 'pending';
7082
+ result: null;
6245
7083
  error: null;
7084
+ action_type: 'SET_HEAT_COOL';
6246
7085
  } | {
6247
- status: 'pending';
6248
- action_type: string;
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
+ */
6249
7119
  action_attempt_id: string;
7120
+ status: 'pending';
6250
7121
  result: null;
6251
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: {};
6252
7136
  } | {
7137
+ /**
7138
+ ---
7139
+ title: Action Attempt ID
7140
+ ---
7141
+ The ID of the action attempt.
7142
+ */
7143
+ action_attempt_id: string;
6253
7144
  status: 'error';
6254
- action_type: string;
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
+ */
6255
7182
  action_attempt_id: string;
7183
+ status: 'error';
6256
7184
  result: null;
7185
+ action_type: 'SET_THERMOSTAT_OFF';
6257
7186
  error: {
6258
7187
  type: string;
6259
7188
  message: string;
@@ -6320,7 +7249,11 @@ export interface Routes {
6320
7249
  offline_access_codes_supported?: boolean | undefined;
6321
7250
  /** Indicates whether the device supports online access codes. */
6322
7251
  online_access_codes_supported?: boolean | undefined;
6323
- /** Indicates whether the device supports an accessory keypad. */
7252
+ /**
7253
+ ---
7254
+ deprecated: use device.properties.model.can_connect_accessory_keypad
7255
+ ---
7256
+ */
6324
7257
  accessory_keypad_supported?: boolean | undefined;
6325
7258
  };
6326
7259
  /** Indicates whether the device has direct power. */
@@ -6346,7 +7279,7 @@ export interface Routes {
6346
7279
  offline_access_codes_enabled?: boolean | undefined;
6347
7280
  /**
6348
7281
  ---
6349
- deprecated: use model.accessory_keypad_supported
7282
+ deprecated: use device.properties.model.can_connect_accessory_keypad
6350
7283
  ---
6351
7284
  */
6352
7285
  supports_accessory_keypad?: boolean | undefined;
@@ -6770,94 +7703,676 @@ export interface Routes {
6770
7703
  errors: Array<{
6771
7704
  error_code: string;
6772
7705
  message: string;
6773
- }>;
6774
- /** 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. */
6775
- warnings: Array<{
6776
- 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;
6777
7970
  message: string;
6778
- }>;
6779
- /** Date and time at which the device object was created. */
6780
- created_at: string;
6781
- /** Indicates whether Seam manages the device. */
6782
- is_managed: true;
6783
- custom_metadata: Record<string, string | boolean>;
6784
- can_remotely_unlock?: boolean | undefined;
6785
- can_remotely_lock?: boolean | undefined;
6786
- can_program_offline_access_codes?: boolean | undefined;
6787
- can_program_online_access_codes?: boolean | undefined;
6788
- 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
+ };
6789
8050
  };
6790
8051
  };
6791
8052
  };
6792
- '/thermostats/heat': {
6793
- route: '/thermostats/heat';
8053
+ '/thermostats/heat_cool': {
8054
+ route: '/thermostats/heat_cool';
6794
8055
  method: 'POST';
6795
8056
  queryParams: {};
6796
8057
  jsonBody: {
6797
8058
  device_id: string;
6798
8059
  heating_set_point_celsius?: number | undefined;
6799
8060
  heating_set_point_fahrenheit?: number | undefined;
8061
+ cooling_set_point_celsius?: number | undefined;
8062
+ cooling_set_point_fahrenheit?: number | undefined;
6800
8063
  sync?: boolean;
6801
8064
  };
6802
8065
  commonParams: {};
6803
8066
  formData: {};
6804
8067
  jsonResponse: {
6805
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;
6806
8088
  status: 'success';
6807
- 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
+ */
8099
+ action_attempt_id: string;
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';
8245
+ error: null;
8246
+ action_type: 'SET_HEAT';
8247
+ result: {};
8248
+ } | {
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
+ */
6808
8270
  action_attempt_id: string;
6809
- result?: any;
8271
+ status: 'pending';
8272
+ result: null;
6810
8273
  error: null;
8274
+ action_type: 'SET_HEAT_COOL';
6811
8275
  } | {
6812
- status: 'pending';
6813
- action_type: string;
8276
+ /**
8277
+ ---
8278
+ title: Action Attempt ID
8279
+ ---
8280
+ The ID of the action attempt.
8281
+ */
6814
8282
  action_attempt_id: string;
6815
- result: null;
8283
+ status: 'success';
6816
8284
  error: null;
8285
+ action_type: 'SET_HEAT_COOL';
8286
+ result: {};
6817
8287
  } | {
6818
- status: 'error';
6819
- action_type: string;
8288
+ /**
8289
+ ---
8290
+ title: Action Attempt ID
8291
+ ---
8292
+ The ID of the action attempt.
8293
+ */
6820
8294
  action_attempt_id: string;
8295
+ status: 'error';
6821
8296
  result: null;
8297
+ action_type: 'SET_HEAT_COOL';
6822
8298
  error: {
6823
8299
  type: string;
6824
8300
  message: string;
6825
8301
  };
6826
- };
6827
- };
6828
- };
6829
- '/thermostats/heat_cool': {
6830
- route: '/thermostats/heat_cool';
6831
- method: 'POST';
6832
- queryParams: {};
6833
- jsonBody: {
6834
- device_id: string;
6835
- heating_set_point_celsius?: number | undefined;
6836
- heating_set_point_fahrenheit?: number | undefined;
6837
- cooling_set_point_celsius?: number | undefined;
6838
- cooling_set_point_fahrenheit?: number | undefined;
6839
- sync?: boolean;
6840
- };
6841
- commonParams: {};
6842
- formData: {};
6843
- jsonResponse: {
6844
- action_attempt: {
6845
- status: 'success';
6846
- action_type: string;
8302
+ } | {
8303
+ /**
8304
+ ---
8305
+ title: Action Attempt ID
8306
+ ---
8307
+ The ID of the action attempt.
8308
+ */
6847
8309
  action_attempt_id: string;
6848
- result?: any;
8310
+ status: 'pending';
8311
+ result: null;
6849
8312
  error: null;
8313
+ action_type: 'SET_FAN_MODE';
6850
8314
  } | {
6851
- status: 'pending';
6852
- action_type: string;
8315
+ /**
8316
+ ---
8317
+ title: Action Attempt ID
8318
+ ---
8319
+ The ID of the action attempt.
8320
+ */
6853
8321
  action_attempt_id: string;
6854
- result: null;
8322
+ status: 'success';
6855
8323
  error: null;
8324
+ action_type: 'SET_FAN_MODE';
8325
+ result: {};
6856
8326
  } | {
8327
+ /**
8328
+ ---
8329
+ title: Action Attempt ID
8330
+ ---
8331
+ The ID of the action attempt.
8332
+ */
8333
+ action_attempt_id: string;
6857
8334
  status: 'error';
6858
- 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
+ */
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
+ */
6859
8372
  action_attempt_id: string;
8373
+ status: 'error';
6860
8374
  result: null;
8375
+ action_type: 'SET_THERMOSTAT_OFF';
6861
8376
  error: {
6862
8377
  type: string;
6863
8378
  message: string;
@@ -6936,7 +8451,11 @@ export interface Routes {
6936
8451
  offline_access_codes_supported?: boolean | undefined;
6937
8452
  /** Indicates whether the device supports online access codes. */
6938
8453
  online_access_codes_supported?: boolean | undefined;
6939
- /** Indicates whether the device supports an accessory keypad. */
8454
+ /**
8455
+ ---
8456
+ deprecated: use device.properties.model.can_connect_accessory_keypad
8457
+ ---
8458
+ */
6940
8459
  accessory_keypad_supported?: boolean | undefined;
6941
8460
  };
6942
8461
  /** Indicates whether the device has direct power. */
@@ -6962,7 +8481,7 @@ export interface Routes {
6962
8481
  offline_access_codes_enabled?: boolean | undefined;
6963
8482
  /**
6964
8483
  ---
6965
- deprecated: use model.accessory_keypad_supported
8484
+ deprecated: use device.properties.model.can_connect_accessory_keypad
6966
8485
  ---
6967
8486
  */
6968
8487
  supports_accessory_keypad?: boolean | undefined;
@@ -7417,22 +8936,313 @@ export interface Routes {
7417
8936
  formData: {};
7418
8937
  jsonResponse: {
7419
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;
7420
8958
  status: 'success';
7421
- 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
+ */
9152
+ action_attempt_id: string;
9153
+ status: 'success';
9154
+ error: null;
9155
+ action_type: 'SET_HEAT_COOL';
9156
+ result: {};
9157
+ } | {
9158
+ /**
9159
+ ---
9160
+ title: Action Attempt ID
9161
+ ---
9162
+ The ID of the action attempt.
9163
+ */
7422
9164
  action_attempt_id: string;
7423
- result?: any;
7424
- error: null;
9165
+ status: 'error';
9166
+ result: null;
9167
+ action_type: 'SET_HEAT_COOL';
9168
+ error: {
9169
+ type: string;
9170
+ message: string;
9171
+ };
7425
9172
  } | {
7426
- status: 'pending';
7427
- action_type: string;
9173
+ /**
9174
+ ---
9175
+ title: Action Attempt ID
9176
+ ---
9177
+ The ID of the action attempt.
9178
+ */
7428
9179
  action_attempt_id: string;
9180
+ status: 'pending';
7429
9181
  result: null;
7430
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: {};
7431
9196
  } | {
9197
+ /**
9198
+ ---
9199
+ title: Action Attempt ID
9200
+ ---
9201
+ The ID of the action attempt.
9202
+ */
9203
+ action_attempt_id: string;
7432
9204
  status: 'error';
7433
- 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
+ */
7434
9242
  action_attempt_id: string;
9243
+ status: 'error';
7435
9244
  result: null;
9245
+ action_type: 'SET_THERMOSTAT_OFF';
7436
9246
  error: {
7437
9247
  type: string;
7438
9248
  message: string;
@@ -7454,22 +9264,313 @@ export interface Routes {
7454
9264
  formData: {};
7455
9265
  jsonResponse: {
7456
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;
7457
9286
  status: 'success';
7458
- 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
+ */
9519
+ action_attempt_id: string;
9520
+ status: 'success';
9521
+ error: null;
9522
+ action_type: 'SET_FAN_MODE';
9523
+ result: {};
9524
+ } | {
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
+ */
7459
9546
  action_attempt_id: string;
7460
- result?: any;
9547
+ status: 'pending';
9548
+ result: null;
7461
9549
  error: null;
9550
+ action_type: 'SET_THERMOSTAT_OFF';
7462
9551
  } | {
7463
- status: 'pending';
7464
- action_type: string;
9552
+ /**
9553
+ ---
9554
+ title: Action Attempt ID
9555
+ ---
9556
+ The ID of the action attempt.
9557
+ */
7465
9558
  action_attempt_id: string;
7466
- result: null;
9559
+ status: 'success';
7467
9560
  error: null;
9561
+ action_type: 'SET_THERMOSTAT_OFF';
9562
+ result: {};
7468
9563
  } | {
7469
- status: 'error';
7470
- action_type: string;
9564
+ /**
9565
+ ---
9566
+ title: Action Attempt ID
9567
+ ---
9568
+ The ID of the action attempt.
9569
+ */
7471
9570
  action_attempt_id: string;
9571
+ status: 'error';
7472
9572
  result: null;
9573
+ action_type: 'SET_THERMOSTAT_OFF';
7473
9574
  error: {
7474
9575
  type: string;
7475
9576
  message: string;
@@ -7735,7 +9836,11 @@ export interface Routes {
7735
9836
  offline_access_codes_supported?: boolean | undefined;
7736
9837
  /** Indicates whether the device supports online access codes. */
7737
9838
  online_access_codes_supported?: boolean | undefined;
7738
- /** Indicates whether the device supports an accessory keypad. */
9839
+ /**
9840
+ ---
9841
+ deprecated: use device.properties.model.can_connect_accessory_keypad
9842
+ ---
9843
+ */
7739
9844
  accessory_keypad_supported?: boolean | undefined;
7740
9845
  };
7741
9846
  /** Indicates whether the device has direct power. */
@@ -7761,7 +9866,7 @@ export interface Routes {
7761
9866
  offline_access_codes_enabled?: boolean | undefined;
7762
9867
  /**
7763
9868
  ---
7764
- deprecated: use model.accessory_keypad_supported
9869
+ deprecated: use device.properties.model.can_connect_accessory_keypad
7765
9870
  ---
7766
9871
  */
7767
9872
  supports_accessory_keypad?: boolean | undefined;
@@ -8255,7 +10360,11 @@ export interface Routes {
8255
10360
  offline_access_codes_supported?: boolean | undefined;
8256
10361
  /** Indicates whether the device supports online access codes. */
8257
10362
  online_access_codes_supported?: boolean | undefined;
8258
- /** Indicates whether the device supports an accessory keypad. */
10363
+ /**
10364
+ ---
10365
+ deprecated: use device.properties.model.can_connect_accessory_keypad
10366
+ ---
10367
+ */
8259
10368
  accessory_keypad_supported?: boolean | undefined;
8260
10369
  };
8261
10370
  /** Indicates whether the device has direct power. */
@@ -8281,7 +10390,7 @@ export interface Routes {
8281
10390
  offline_access_codes_enabled?: boolean | undefined;
8282
10391
  /**
8283
10392
  ---
8284
- deprecated: use model.accessory_keypad_supported
10393
+ deprecated: use device.properties.model.can_connect_accessory_keypad
8285
10394
  ---
8286
10395
  */
8287
10396
  supports_accessory_keypad?: boolean | undefined;
@@ -8756,6 +10865,14 @@ export interface Routes {
8756
10865
  connected_account_ids: string[];
8757
10866
  image_url: string;
8758
10867
  image_alt_text: string;
10868
+ errors: Array<{
10869
+ error_code: string;
10870
+ message: string;
10871
+ }>;
10872
+ warnings: Array<{
10873
+ warning_code: string;
10874
+ message: string;
10875
+ }>;
8759
10876
  can_automate_enrollment?: boolean | undefined;
8760
10877
  can_create_acs_access_groups?: boolean | undefined;
8761
10878
  can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
@@ -8982,22 +11099,313 @@ export interface Routes {
8982
11099
  formData: {};
8983
11100
  jsonResponse: {
8984
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;
8985
11121
  status: 'success';
8986
- 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
+ */
8987
11132
  action_attempt_id: string;
8988
- 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';
8989
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
+ };
8990
11218
  } | {
11219
+ /**
11220
+ ---
11221
+ title: Action Attempt ID
11222
+ ---
11223
+ The ID of the action attempt.
11224
+ */
11225
+ action_attempt_id: string;
8991
11226
  status: 'pending';
8992
- 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
+ */
8993
11264
  action_attempt_id: string;
11265
+ status: 'pending';
8994
11266
  result: null;
8995
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: {};
8996
11281
  } | {
11282
+ /**
11283
+ ---
11284
+ title: Action Attempt ID
11285
+ ---
11286
+ The ID of the action attempt.
11287
+ */
11288
+ action_attempt_id: string;
8997
11289
  status: 'error';
8998
- 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
+ */
8999
11405
  action_attempt_id: string;
11406
+ status: 'error';
9000
11407
  result: null;
11408
+ action_type: 'SET_THERMOSTAT_OFF';
9001
11409
  error: {
9002
11410
  type: string;
9003
11411
  message: string;