@seamapi/types 1.176.0 → 1.177.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/dist/connect.cjs +1948 -160
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +4660 -498
  4. package/lib/seam/connect/model-types.d.ts +1 -1
  5. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +556 -0
  6. package/lib/seam/connect/models/action-attempts/action-attempt.js +20 -0
  7. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -0
  8. package/lib/seam/connect/models/action-attempts/common.d.ts +53 -0
  9. package/lib/seam/connect/models/action-attempts/common.js +24 -0
  10. package/lib/seam/connect/models/action-attempts/common.js.map +1 -0
  11. package/lib/seam/connect/models/action-attempts/index.d.ts +1 -0
  12. package/lib/seam/connect/models/action-attempts/index.js +2 -0
  13. package/lib/seam/connect/models/action-attempts/index.js.map +1 -0
  14. package/lib/seam/connect/models/action-attempts/lock-door.d.ts +72 -0
  15. package/lib/seam/connect/models/action-attempts/lock-door.js +25 -0
  16. package/lib/seam/connect/models/action-attempts/lock-door.js.map +1 -0
  17. package/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.d.ts +71 -0
  18. package/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.js +28 -0
  19. package/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.js.map +1 -0
  20. package/lib/seam/connect/models/action-attempts/set-cool.d.ts +71 -0
  21. package/lib/seam/connect/models/action-attempts/set-cool.js +25 -0
  22. package/lib/seam/connect/models/action-attempts/set-cool.js.map +1 -0
  23. package/lib/seam/connect/models/action-attempts/set-fan-mode.d.ts +71 -0
  24. package/lib/seam/connect/models/action-attempts/set-fan-mode.js +25 -0
  25. package/lib/seam/connect/models/action-attempts/set-fan-mode.js.map +1 -0
  26. package/lib/seam/connect/models/action-attempts/set-heat-cool.d.ts +71 -0
  27. package/lib/seam/connect/models/action-attempts/set-heat-cool.js +25 -0
  28. package/lib/seam/connect/models/action-attempts/set-heat-cool.js.map +1 -0
  29. package/lib/seam/connect/models/action-attempts/set-heat.d.ts +71 -0
  30. package/lib/seam/connect/models/action-attempts/set-heat.js +25 -0
  31. package/lib/seam/connect/models/action-attempts/set-heat.js.map +1 -0
  32. package/lib/seam/connect/models/action-attempts/set-thermostat-off.d.ts +71 -0
  33. package/lib/seam/connect/models/action-attempts/set-thermostat-off.js +25 -0
  34. package/lib/seam/connect/models/action-attempts/set-thermostat-off.js.map +1 -0
  35. package/lib/seam/connect/models/action-attempts/unlock-door.d.ts +72 -0
  36. package/lib/seam/connect/models/action-attempts/unlock-door.js +25 -0
  37. package/lib/seam/connect/models/action-attempts/unlock-door.js.map +1 -0
  38. package/lib/seam/connect/models/devices/managed-device.js +6 -2
  39. package/lib/seam/connect/models/devices/managed-device.js.map +1 -1
  40. package/lib/seam/connect/models/events/access-codes.d.ts +1 -1
  41. package/lib/seam/connect/models/events/access-codes.js +1 -1
  42. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  43. package/lib/seam/connect/models/events/acs/common.d.ts +1 -1
  44. package/lib/seam/connect/models/events/acs/common.js +1 -1
  45. package/lib/seam/connect/models/events/acs/common.js.map +1 -1
  46. package/lib/seam/connect/models/events/acs/credentials.d.ts +1 -1
  47. package/lib/seam/connect/models/events/acs/credentials.js +1 -1
  48. package/lib/seam/connect/models/events/acs/credentials.js.map +1 -1
  49. package/lib/seam/connect/models/events/acs/users.d.ts +1 -1
  50. package/lib/seam/connect/models/events/acs/users.js +1 -1
  51. package/lib/seam/connect/models/events/acs/users.js.map +1 -1
  52. package/lib/seam/connect/models/events/action-attempts.d.ts +10 -10
  53. package/lib/seam/connect/models/events/client-sessions.d.ts +1 -1
  54. package/lib/seam/connect/models/events/client-sessions.js +1 -1
  55. package/lib/seam/connect/models/events/client-sessions.js.map +1 -1
  56. package/lib/seam/connect/models/events/common.d.ts +1 -1
  57. package/lib/seam/connect/models/events/common.js +1 -1
  58. package/lib/seam/connect/models/events/common.js.map +1 -1
  59. package/lib/seam/connect/models/events/connected-accounts.d.ts +1 -1
  60. package/lib/seam/connect/models/events/connected-accounts.js +1 -1
  61. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  62. package/lib/seam/connect/models/events/devices.d.ts +1 -1
  63. package/lib/seam/connect/models/events/devices.js +1 -1
  64. package/lib/seam/connect/models/events/devices.js.map +1 -1
  65. package/lib/seam/connect/models/events/enrollment-automations.d.ts +1 -1
  66. package/lib/seam/connect/models/events/enrollment-automations.js +1 -1
  67. package/lib/seam/connect/models/events/enrollment-automations.js.map +1 -1
  68. package/lib/seam/connect/models/events/phones.d.ts +1 -1
  69. package/lib/seam/connect/models/events/phones.js +1 -1
  70. package/lib/seam/connect/models/events/phones.js.map +1 -1
  71. package/lib/seam/connect/models/events/seam-event.d.ts +1 -1
  72. package/lib/seam/connect/models/events/seam-event.js +1 -1
  73. package/lib/seam/connect/models/events/seam-event.js.map +1 -1
  74. package/lib/seam/connect/models/index.d.ts +1 -0
  75. package/lib/seam/connect/models/index.js +1 -0
  76. package/lib/seam/connect/models/index.js.map +1 -1
  77. package/lib/seam/connect/openapi.d.ts +1285 -54
  78. package/lib/seam/connect/openapi.js +1662 -28
  79. package/lib/seam/connect/openapi.js.map +1 -1
  80. package/lib/seam/connect/route-types.d.ts +2941 -565
  81. package/lib/seam/connect/schemas.d.ts +1 -1
  82. package/lib/seam/connect/schemas.js +1 -1
  83. package/lib/seam/connect/schemas.js.map +1 -1
  84. package/package.json +1 -1
  85. package/src/lib/seam/connect/model-types.ts +1 -0
  86. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +25 -0
  87. package/src/lib/seam/connect/models/action-attempts/common.ts +27 -0
  88. package/src/lib/seam/connect/models/action-attempts/index.ts +1 -0
  89. package/src/lib/seam/connect/models/action-attempts/lock-door.ts +35 -0
  90. package/src/lib/seam/connect/models/action-attempts/reset-sandbox-workspace.ts +39 -0
  91. package/src/lib/seam/connect/models/action-attempts/set-cool.ts +33 -0
  92. package/src/lib/seam/connect/models/action-attempts/set-fan-mode.ts +33 -0
  93. package/src/lib/seam/connect/models/action-attempts/set-heat-cool.ts +33 -0
  94. package/src/lib/seam/connect/models/action-attempts/set-heat.ts +33 -0
  95. package/src/lib/seam/connect/models/action-attempts/set-thermostat-off.ts +36 -0
  96. package/src/lib/seam/connect/models/action-attempts/unlock-door.ts +35 -0
  97. package/src/lib/seam/connect/models/devices/managed-device.ts +8 -2
  98. package/src/lib/seam/connect/models/events/access-codes.ts +1 -1
  99. package/src/lib/seam/connect/models/events/acs/common.ts +1 -1
  100. package/src/lib/seam/connect/models/events/acs/credentials.ts +1 -1
  101. package/src/lib/seam/connect/models/events/acs/users.ts +1 -1
  102. package/src/lib/seam/connect/models/events/client-sessions.ts +1 -1
  103. package/src/lib/seam/connect/models/events/common.ts +1 -1
  104. package/src/lib/seam/connect/models/events/connected-accounts.ts +1 -1
  105. package/src/lib/seam/connect/models/events/devices.ts +1 -1
  106. package/src/lib/seam/connect/models/events/enrollment-automations.ts +1 -1
  107. package/src/lib/seam/connect/models/events/phones.ts +1 -1
  108. package/src/lib/seam/connect/models/events/seam-event.ts +1 -1
  109. package/src/lib/seam/connect/models/index.ts +1 -0
  110. package/src/lib/seam/connect/openapi.ts +1686 -28
  111. package/src/lib/seam/connect/route-types.ts +3458 -914
  112. package/src/lib/seam/connect/schemas.ts +6 -1
@@ -2573,7 +2573,11 @@ export interface Routes {
2573
2573
  offline_access_codes_supported?: boolean | undefined
2574
2574
  /** Indicates whether the device supports online access codes. */
2575
2575
  online_access_codes_supported?: boolean | undefined
2576
- /** Indicates whether the device supports an accessory keypad. */
2576
+ /**
2577
+ ---
2578
+ deprecated: use device.properties.model.can_connect_accessory_keypad
2579
+ ---
2580
+ */
2577
2581
  accessory_keypad_supported?: boolean | undefined
2578
2582
  }
2579
2583
  /** Indicates whether the device has direct power. */
@@ -2601,7 +2605,7 @@ export interface Routes {
2601
2605
  offline_access_codes_enabled?: boolean | undefined
2602
2606
  /**
2603
2607
  ---
2604
- deprecated: use model.accessory_keypad_supported
2608
+ deprecated: use device.properties.model.can_connect_accessory_keypad
2605
2609
  ---
2606
2610
  */
2607
2611
  supports_accessory_keypad?: boolean | undefined
@@ -3462,7 +3466,11 @@ export interface Routes {
3462
3466
  offline_access_codes_supported?: boolean | undefined
3463
3467
  /** Indicates whether the device supports online access codes. */
3464
3468
  online_access_codes_supported?: boolean | undefined
3465
- /** Indicates whether the device supports an accessory keypad. */
3469
+ /**
3470
+ ---
3471
+ deprecated: use device.properties.model.can_connect_accessory_keypad
3472
+ ---
3473
+ */
3466
3474
  accessory_keypad_supported?: boolean | undefined
3467
3475
  }
3468
3476
  /** Indicates whether the device has direct power. */
@@ -3490,7 +3498,7 @@ export interface Routes {
3490
3498
  offline_access_codes_enabled?: boolean | undefined
3491
3499
  /**
3492
3500
  ---
3493
- deprecated: use model.accessory_keypad_supported
3501
+ deprecated: use device.properties.model.can_connect_accessory_keypad
3494
3502
  ---
3495
3503
  */
3496
3504
  supports_accessory_keypad?: boolean | undefined
@@ -4317,7 +4325,11 @@ export interface Routes {
4317
4325
  offline_access_codes_supported?: boolean | undefined
4318
4326
  /** Indicates whether the device supports online access codes. */
4319
4327
  online_access_codes_supported?: boolean | undefined
4320
- /** Indicates whether the device supports an accessory keypad. */
4328
+ /**
4329
+ ---
4330
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4331
+ ---
4332
+ */
4321
4333
  accessory_keypad_supported?: boolean | undefined
4322
4334
  }
4323
4335
  }
@@ -4602,7 +4614,11 @@ export interface Routes {
4602
4614
  offline_access_codes_supported?: boolean | undefined
4603
4615
  /** Indicates whether the device supports online access codes. */
4604
4616
  online_access_codes_supported?: boolean | undefined
4605
- /** Indicates whether the device supports an accessory keypad. */
4617
+ /**
4618
+ ---
4619
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4620
+ ---
4621
+ */
4606
4622
  accessory_keypad_supported?: boolean | undefined
4607
4623
  }
4608
4624
  }
@@ -4936,7 +4952,11 @@ export interface Routes {
4936
4952
  offline_access_codes_supported?: boolean | undefined
4937
4953
  /** Indicates whether the device supports online access codes. */
4938
4954
  online_access_codes_supported?: boolean | undefined
4939
- /** Indicates whether the device supports an accessory keypad. */
4955
+ /**
4956
+ ---
4957
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4958
+ ---
4959
+ */
4940
4960
  accessory_keypad_supported?: boolean | undefined
4941
4961
  }
4942
4962
  /** Indicates whether the device has direct power. */
@@ -4964,7 +4984,7 @@ export interface Routes {
4964
4984
  offline_access_codes_enabled?: boolean | undefined
4965
4985
  /**
4966
4986
  ---
4967
- deprecated: use model.accessory_keypad_supported
4987
+ deprecated: use device.properties.model.can_connect_accessory_keypad
4968
4988
  ---
4969
4989
  */
4970
4990
  supports_accessory_keypad?: boolean | undefined
@@ -5671,7 +5691,11 @@ export interface Routes {
5671
5691
  offline_access_codes_supported?: boolean | undefined
5672
5692
  /** Indicates whether the device supports online access codes. */
5673
5693
  online_access_codes_supported?: boolean | undefined
5674
- /** Indicates whether the device supports an accessory keypad. */
5694
+ /**
5695
+ ---
5696
+ deprecated: use device.properties.model.can_connect_accessory_keypad
5697
+ ---
5698
+ */
5675
5699
  accessory_keypad_supported?: boolean | undefined
5676
5700
  }
5677
5701
  /** Indicates whether the device has direct power. */
@@ -5699,7 +5723,7 @@ export interface Routes {
5699
5723
  offline_access_codes_enabled?: boolean | undefined
5700
5724
  /**
5701
5725
  ---
5702
- deprecated: use model.accessory_keypad_supported
5726
+ deprecated: use device.properties.model.can_connect_accessory_keypad
5703
5727
  ---
5704
5728
  */
5705
5729
  supports_accessory_keypad?: boolean | undefined
@@ -6560,7 +6584,11 @@ export interface Routes {
6560
6584
  offline_access_codes_supported?: boolean | undefined
6561
6585
  /** Indicates whether the device supports online access codes. */
6562
6586
  online_access_codes_supported?: boolean | undefined
6563
- /** Indicates whether the device supports an accessory keypad. */
6587
+ /**
6588
+ ---
6589
+ deprecated: use device.properties.model.can_connect_accessory_keypad
6590
+ ---
6591
+ */
6564
6592
  accessory_keypad_supported?: boolean | undefined
6565
6593
  }
6566
6594
  /** Indicates whether the device has direct power. */
@@ -6588,7 +6616,7 @@ export interface Routes {
6588
6616
  offline_access_codes_enabled?: boolean | undefined
6589
6617
  /**
6590
6618
  ---
6591
- deprecated: use model.accessory_keypad_supported
6619
+ deprecated: use device.properties.model.can_connect_accessory_keypad
6592
6620
  ---
6593
6621
  */
6594
6622
  supports_accessory_keypad?: boolean | undefined
@@ -7295,7 +7323,11 @@ export interface Routes {
7295
7323
  offline_access_codes_supported?: boolean | undefined
7296
7324
  /** Indicates whether the device supports online access codes. */
7297
7325
  online_access_codes_supported?: boolean | undefined
7298
- /** Indicates whether the device supports an accessory keypad. */
7326
+ /**
7327
+ ---
7328
+ deprecated: use device.properties.model.can_connect_accessory_keypad
7329
+ ---
7330
+ */
7299
7331
  accessory_keypad_supported?: boolean | undefined
7300
7332
  }
7301
7333
  /** Indicates whether the device has direct power. */
@@ -7323,7 +7355,7 @@ export interface Routes {
7323
7355
  offline_access_codes_enabled?: boolean | undefined
7324
7356
  /**
7325
7357
  ---
7326
- deprecated: use model.accessory_keypad_supported
7358
+ deprecated: use device.properties.model.can_connect_accessory_keypad
7327
7359
  ---
7328
7360
  */
7329
7361
  supports_accessory_keypad?: boolean | undefined
@@ -7951,187 +7983,336 @@ export interface Routes {
7951
7983
  jsonResponse: {
7952
7984
  action_attempt:
7953
7985
  | {
7954
- status: 'success'
7955
- action_type: string
7986
+ /**
7987
+ ---
7988
+ title: Action Attempt ID
7989
+ ---
7990
+ The ID of the action attempt.
7991
+ */
7956
7992
  action_attempt_id: string
7957
- result?: any
7993
+ status: 'pending'
7994
+ result: null
7958
7995
  error: null
7996
+ action_type: 'LOCK_DOOR'
7959
7997
  }
7960
7998
  | {
7961
- status: 'pending'
7962
- action_type: string
7999
+ /**
8000
+ ---
8001
+ title: Action Attempt ID
8002
+ ---
8003
+ The ID of the action attempt.
8004
+ */
7963
8005
  action_attempt_id: string
7964
- result: null
8006
+ status: 'success'
7965
8007
  error: null
8008
+ action_type: 'LOCK_DOOR'
8009
+ result: {}
7966
8010
  }
7967
8011
  | {
7968
- status: 'error'
7969
- action_type: string
8012
+ /**
8013
+ ---
8014
+ title: Action Attempt ID
8015
+ ---
8016
+ The ID of the action attempt.
8017
+ */
7970
8018
  action_attempt_id: string
8019
+ status: 'error'
7971
8020
  result: null
8021
+ action_type: 'LOCK_DOOR'
7972
8022
  error: {
7973
8023
  type: string
7974
8024
  message: string
7975
8025
  }
7976
8026
  }
7977
- }
7978
- }
7979
- '/locks/unlock_door': {
7980
- route: '/locks/unlock_door'
7981
- method: 'POST'
7982
- queryParams: {}
7983
- jsonBody: {
7984
- device_id: string
7985
- sync?: boolean
7986
- }
7987
- commonParams: {}
7988
- formData: {}
7989
- jsonResponse: {
7990
- action_attempt:
7991
8027
  | {
7992
- status: 'success'
7993
- action_type: string
8028
+ /**
8029
+ ---
8030
+ title: Action Attempt ID
8031
+ ---
8032
+ The ID of the action attempt.
8033
+ */
7994
8034
  action_attempt_id: string
7995
- result?: any
8035
+ status: 'pending'
8036
+ result: null
7996
8037
  error: null
8038
+ action_type: 'UNLOCK_DOOR'
7997
8039
  }
7998
8040
  | {
7999
- status: 'pending'
8000
- action_type: string
8041
+ /**
8042
+ ---
8043
+ title: Action Attempt ID
8044
+ ---
8045
+ The ID of the action attempt.
8046
+ */
8001
8047
  action_attempt_id: string
8002
- result: null
8048
+ status: 'success'
8003
8049
  error: null
8050
+ action_type: 'UNLOCK_DOOR'
8051
+ result: {}
8004
8052
  }
8005
8053
  | {
8006
- status: 'error'
8007
- action_type: string
8054
+ /**
8055
+ ---
8056
+ title: Action Attempt ID
8057
+ ---
8058
+ The ID of the action attempt.
8059
+ */
8008
8060
  action_attempt_id: string
8061
+ status: 'error'
8009
8062
  result: null
8063
+ action_type: 'UNLOCK_DOOR'
8010
8064
  error: {
8011
8065
  type: string
8012
8066
  message: string
8013
8067
  }
8014
8068
  }
8015
- }
8016
- }
8017
- '/networks/get': {
8018
- route: '/networks/get'
8019
- method: 'GET' | 'POST'
8020
- queryParams: {}
8021
- jsonBody: {}
8022
- commonParams: {
8023
- network_id: string
8024
- }
8025
- formData: {}
8026
- jsonResponse: {
8027
- network: {
8028
- network_id: string
8029
- workspace_id: string
8030
- display_name: string
8031
- created_at: string
8032
- }
8033
- }
8034
- }
8035
- '/networks/list': {
8036
- route: '/networks/list'
8037
- method: 'GET' | 'POST'
8038
- queryParams: {}
8039
- jsonBody: {}
8040
- commonParams: {}
8041
- formData: {}
8042
- jsonResponse: {
8043
- networks: Array<{
8044
- network_id: string
8045
- workspace_id: string
8046
- display_name: string
8047
- created_at: string
8048
- }>
8049
- }
8050
- }
8051
- '/noise_sensors/noise_thresholds/create': {
8052
- route: '/noise_sensors/noise_thresholds/create'
8053
- method: 'POST'
8054
- queryParams: {}
8055
- jsonBody: {
8056
- device_id: string
8057
- sync?: boolean
8058
- name?: string | undefined
8059
- starts_daily_at: string
8060
- ends_daily_at: string
8061
- noise_threshold_decibels?: number | undefined
8062
- noise_threshold_nrs?: number | undefined
8063
- }
8064
- commonParams: {}
8065
- formData: {}
8066
- jsonResponse: {
8067
- action_attempt:
8068
8069
  | {
8069
- status: 'success'
8070
- action_type: string
8070
+ /**
8071
+ ---
8072
+ title: Action Attempt ID
8073
+ ---
8074
+ The ID of the action attempt.
8075
+ */
8071
8076
  action_attempt_id: string
8072
- result?: any
8077
+ status: 'pending'
8078
+ result: null
8073
8079
  error: null
8080
+ action_type: 'RESET_SANDBOX_WORKSPACE'
8074
8081
  }
8075
8082
  | {
8076
- status: 'pending'
8077
- action_type: string
8083
+ /**
8084
+ ---
8085
+ title: Action Attempt ID
8086
+ ---
8087
+ The ID of the action attempt.
8088
+ */
8078
8089
  action_attempt_id: string
8079
- result: null
8090
+ status: 'success'
8080
8091
  error: null
8092
+ action_type: 'RESET_SANDBOX_WORKSPACE'
8093
+ result: {}
8081
8094
  }
8082
8095
  | {
8083
- status: 'error'
8084
- action_type: string
8096
+ /**
8097
+ ---
8098
+ title: Action Attempt ID
8099
+ ---
8100
+ The ID of the action attempt.
8101
+ */
8085
8102
  action_attempt_id: string
8103
+ status: 'error'
8086
8104
  result: null
8105
+ action_type: 'RESET_SANDBOX_WORKSPACE'
8087
8106
  error: {
8088
8107
  type: string
8089
8108
  message: string
8090
8109
  }
8091
8110
  }
8092
- noise_threshold: {
8093
- noise_threshold_id: string
8094
- device_id: string
8095
- name: string
8096
- noise_threshold_nrs?: number | undefined
8097
- starts_daily_at: string
8098
- ends_daily_at: string
8099
- noise_threshold_decibels: number
8100
- }
8101
- }
8102
- }
8103
- '/noise_sensors/noise_thresholds/delete': {
8104
- route: '/noise_sensors/noise_thresholds/delete'
8105
- method: 'DELETE' | 'POST'
8106
- queryParams: {}
8107
- jsonBody: {
8108
- noise_threshold_id: string
8109
- device_id: string
8110
- sync?: boolean
8111
- }
8112
- commonParams: {}
8113
- formData: {}
8114
- jsonResponse: {
8115
- action_attempt:
8116
8111
  | {
8117
- status: 'success'
8118
- action_type: string
8112
+ /**
8113
+ ---
8114
+ title: Action Attempt ID
8115
+ ---
8116
+ The ID of the action attempt.
8117
+ */
8119
8118
  action_attempt_id: string
8120
- result?: any
8119
+ status: 'pending'
8120
+ result: null
8121
8121
  error: null
8122
+ action_type: 'SET_COOL'
8122
8123
  }
8123
8124
  | {
8124
- status: 'pending'
8125
- action_type: string
8125
+ /**
8126
+ ---
8127
+ title: Action Attempt ID
8128
+ ---
8129
+ The ID of the action attempt.
8130
+ */
8131
+ action_attempt_id: string
8132
+ status: 'success'
8133
+ error: null
8134
+ action_type: 'SET_COOL'
8135
+ result: {}
8136
+ }
8137
+ | {
8138
+ /**
8139
+ ---
8140
+ title: Action Attempt ID
8141
+ ---
8142
+ The ID of the action attempt.
8143
+ */
8144
+ action_attempt_id: string
8145
+ status: 'error'
8146
+ result: null
8147
+ action_type: 'SET_COOL'
8148
+ error: {
8149
+ type: string
8150
+ message: string
8151
+ }
8152
+ }
8153
+ | {
8154
+ /**
8155
+ ---
8156
+ title: Action Attempt ID
8157
+ ---
8158
+ The ID of the action attempt.
8159
+ */
8126
8160
  action_attempt_id: string
8161
+ status: 'pending'
8127
8162
  result: null
8128
8163
  error: null
8164
+ action_type: 'SET_HEAT'
8165
+ }
8166
+ | {
8167
+ /**
8168
+ ---
8169
+ title: Action Attempt ID
8170
+ ---
8171
+ The ID of the action attempt.
8172
+ */
8173
+ action_attempt_id: string
8174
+ status: 'success'
8175
+ error: null
8176
+ action_type: 'SET_HEAT'
8177
+ result: {}
8129
8178
  }
8130
8179
  | {
8180
+ /**
8181
+ ---
8182
+ title: Action Attempt ID
8183
+ ---
8184
+ The ID of the action attempt.
8185
+ */
8186
+ action_attempt_id: string
8131
8187
  status: 'error'
8132
- action_type: string
8188
+ result: null
8189
+ action_type: 'SET_HEAT'
8190
+ error: {
8191
+ type: string
8192
+ message: string
8193
+ }
8194
+ }
8195
+ | {
8196
+ /**
8197
+ ---
8198
+ title: Action Attempt ID
8199
+ ---
8200
+ The ID of the action attempt.
8201
+ */
8202
+ action_attempt_id: string
8203
+ status: 'pending'
8204
+ result: null
8205
+ error: null
8206
+ action_type: 'SET_HEAT_COOL'
8207
+ }
8208
+ | {
8209
+ /**
8210
+ ---
8211
+ title: Action Attempt ID
8212
+ ---
8213
+ The ID of the action attempt.
8214
+ */
8215
+ action_attempt_id: string
8216
+ status: 'success'
8217
+ error: null
8218
+ action_type: 'SET_HEAT_COOL'
8219
+ result: {}
8220
+ }
8221
+ | {
8222
+ /**
8223
+ ---
8224
+ title: Action Attempt ID
8225
+ ---
8226
+ The ID of the action attempt.
8227
+ */
8133
8228
  action_attempt_id: string
8229
+ status: 'error'
8134
8230
  result: null
8231
+ action_type: 'SET_HEAT_COOL'
8232
+ error: {
8233
+ type: string
8234
+ message: string
8235
+ }
8236
+ }
8237
+ | {
8238
+ /**
8239
+ ---
8240
+ title: Action Attempt ID
8241
+ ---
8242
+ The ID of the action attempt.
8243
+ */
8244
+ action_attempt_id: string
8245
+ status: 'pending'
8246
+ result: null
8247
+ error: null
8248
+ action_type: 'SET_FAN_MODE'
8249
+ }
8250
+ | {
8251
+ /**
8252
+ ---
8253
+ title: Action Attempt ID
8254
+ ---
8255
+ The ID of the action attempt.
8256
+ */
8257
+ action_attempt_id: string
8258
+ status: 'success'
8259
+ error: null
8260
+ action_type: 'SET_FAN_MODE'
8261
+ result: {}
8262
+ }
8263
+ | {
8264
+ /**
8265
+ ---
8266
+ title: Action Attempt ID
8267
+ ---
8268
+ The ID of the action attempt.
8269
+ */
8270
+ action_attempt_id: string
8271
+ status: 'error'
8272
+ result: null
8273
+ action_type: 'SET_FAN_MODE'
8274
+ error: {
8275
+ type: string
8276
+ message: string
8277
+ }
8278
+ }
8279
+ | {
8280
+ /**
8281
+ ---
8282
+ title: Action Attempt ID
8283
+ ---
8284
+ The ID of the action attempt.
8285
+ */
8286
+ action_attempt_id: string
8287
+ status: 'pending'
8288
+ result: null
8289
+ error: null
8290
+ action_type: 'SET_THERMOSTAT_OFF'
8291
+ }
8292
+ | {
8293
+ /**
8294
+ ---
8295
+ title: Action Attempt ID
8296
+ ---
8297
+ The ID of the action attempt.
8298
+ */
8299
+ action_attempt_id: string
8300
+ status: 'success'
8301
+ error: null
8302
+ action_type: 'SET_THERMOSTAT_OFF'
8303
+ result: {}
8304
+ }
8305
+ | {
8306
+ /**
8307
+ ---
8308
+ title: Action Attempt ID
8309
+ ---
8310
+ The ID of the action attempt.
8311
+ */
8312
+ action_attempt_id: string
8313
+ status: 'error'
8314
+ result: null
8315
+ action_type: 'SET_THERMOSTAT_OFF'
8135
8316
  error: {
8136
8317
  type: string
8137
8318
  message: string
@@ -8139,439 +8320,449 @@ export interface Routes {
8139
8320
  }
8140
8321
  }
8141
8322
  }
8142
- '/noise_sensors/noise_thresholds/get': {
8143
- route: '/noise_sensors/noise_thresholds/get'
8144
- method: 'GET' | 'POST'
8145
- queryParams: {}
8146
- jsonBody: {}
8147
- commonParams: {
8148
- noise_threshold_id: string
8149
- }
8150
- formData: {}
8151
- jsonResponse: {
8152
- noise_threshold: {
8153
- noise_threshold_id: string
8154
- device_id: string
8155
- name: string
8156
- noise_threshold_nrs?: number | undefined
8157
- starts_daily_at: string
8158
- ends_daily_at: string
8159
- noise_threshold_decibels: number
8160
- }
8161
- }
8162
- }
8163
- '/noise_sensors/noise_thresholds/list': {
8164
- route: '/noise_sensors/noise_thresholds/list'
8165
- method: 'GET' | 'POST'
8166
- queryParams: {}
8167
- jsonBody: {}
8168
- commonParams: {
8169
- device_id: string
8170
- is_programmed?: boolean | undefined
8171
- }
8172
- formData: {}
8173
- jsonResponse: {
8174
- noise_thresholds: Array<{
8175
- noise_threshold_id: string
8176
- device_id: string
8177
- name: string
8178
- noise_threshold_nrs?: number | undefined
8179
- starts_daily_at: string
8180
- ends_daily_at: string
8181
- noise_threshold_decibels: number
8182
- }>
8183
- }
8184
- }
8185
- '/noise_sensors/noise_thresholds/update': {
8186
- route: '/noise_sensors/noise_thresholds/update'
8187
- method: 'PATCH' | 'POST' | 'PUT'
8323
+ '/locks/unlock_door': {
8324
+ route: '/locks/unlock_door'
8325
+ method: 'POST'
8188
8326
  queryParams: {}
8189
8327
  jsonBody: {
8190
- noise_threshold_id: string
8191
8328
  device_id: string
8192
8329
  sync?: boolean
8193
- name?: string | undefined
8194
- starts_daily_at?: string | undefined
8195
- ends_daily_at?: string | undefined
8196
- noise_threshold_decibels?: number | undefined
8197
- noise_threshold_nrs?: number | undefined
8198
8330
  }
8199
8331
  commonParams: {}
8200
8332
  formData: {}
8201
8333
  jsonResponse: {
8202
8334
  action_attempt:
8203
8335
  | {
8204
- status: 'success'
8205
- action_type: string
8336
+ /**
8337
+ ---
8338
+ title: Action Attempt ID
8339
+ ---
8340
+ The ID of the action attempt.
8341
+ */
8206
8342
  action_attempt_id: string
8207
- result?: any
8343
+ status: 'pending'
8344
+ result: null
8345
+ error: null
8346
+ action_type: 'LOCK_DOOR'
8347
+ }
8348
+ | {
8349
+ /**
8350
+ ---
8351
+ title: Action Attempt ID
8352
+ ---
8353
+ The ID of the action attempt.
8354
+ */
8355
+ action_attempt_id: string
8356
+ status: 'success'
8208
8357
  error: null
8358
+ action_type: 'LOCK_DOOR'
8359
+ result: {}
8360
+ }
8361
+ | {
8362
+ /**
8363
+ ---
8364
+ title: Action Attempt ID
8365
+ ---
8366
+ The ID of the action attempt.
8367
+ */
8368
+ action_attempt_id: string
8369
+ status: 'error'
8370
+ result: null
8371
+ action_type: 'LOCK_DOOR'
8372
+ error: {
8373
+ type: string
8374
+ message: string
8375
+ }
8209
8376
  }
8210
8377
  | {
8378
+ /**
8379
+ ---
8380
+ title: Action Attempt ID
8381
+ ---
8382
+ The ID of the action attempt.
8383
+ */
8384
+ action_attempt_id: string
8211
8385
  status: 'pending'
8212
- action_type: string
8386
+ result: null
8387
+ error: null
8388
+ action_type: 'UNLOCK_DOOR'
8389
+ }
8390
+ | {
8391
+ /**
8392
+ ---
8393
+ title: Action Attempt ID
8394
+ ---
8395
+ The ID of the action attempt.
8396
+ */
8397
+ action_attempt_id: string
8398
+ status: 'success'
8399
+ error: null
8400
+ action_type: 'UNLOCK_DOOR'
8401
+ result: {}
8402
+ }
8403
+ | {
8404
+ /**
8405
+ ---
8406
+ title: Action Attempt ID
8407
+ ---
8408
+ The ID of the action attempt.
8409
+ */
8410
+ action_attempt_id: string
8411
+ status: 'error'
8412
+ result: null
8413
+ action_type: 'UNLOCK_DOOR'
8414
+ error: {
8415
+ type: string
8416
+ message: string
8417
+ }
8418
+ }
8419
+ | {
8420
+ /**
8421
+ ---
8422
+ title: Action Attempt ID
8423
+ ---
8424
+ The ID of the action attempt.
8425
+ */
8213
8426
  action_attempt_id: string
8427
+ status: 'pending'
8214
8428
  result: null
8215
8429
  error: null
8430
+ action_type: 'RESET_SANDBOX_WORKSPACE'
8431
+ }
8432
+ | {
8433
+ /**
8434
+ ---
8435
+ title: Action Attempt ID
8436
+ ---
8437
+ The ID of the action attempt.
8438
+ */
8439
+ action_attempt_id: string
8440
+ status: 'success'
8441
+ error: null
8442
+ action_type: 'RESET_SANDBOX_WORKSPACE'
8443
+ result: {}
8216
8444
  }
8217
8445
  | {
8446
+ /**
8447
+ ---
8448
+ title: Action Attempt ID
8449
+ ---
8450
+ The ID of the action attempt.
8451
+ */
8452
+ action_attempt_id: string
8218
8453
  status: 'error'
8219
- action_type: string
8454
+ result: null
8455
+ action_type: 'RESET_SANDBOX_WORKSPACE'
8456
+ error: {
8457
+ type: string
8458
+ message: string
8459
+ }
8460
+ }
8461
+ | {
8462
+ /**
8463
+ ---
8464
+ title: Action Attempt ID
8465
+ ---
8466
+ The ID of the action attempt.
8467
+ */
8468
+ action_attempt_id: string
8469
+ status: 'pending'
8470
+ result: null
8471
+ error: null
8472
+ action_type: 'SET_COOL'
8473
+ }
8474
+ | {
8475
+ /**
8476
+ ---
8477
+ title: Action Attempt ID
8478
+ ---
8479
+ The ID of the action attempt.
8480
+ */
8481
+ action_attempt_id: string
8482
+ status: 'success'
8483
+ error: null
8484
+ action_type: 'SET_COOL'
8485
+ result: {}
8486
+ }
8487
+ | {
8488
+ /**
8489
+ ---
8490
+ title: Action Attempt ID
8491
+ ---
8492
+ The ID of the action attempt.
8493
+ */
8220
8494
  action_attempt_id: string
8495
+ status: 'error'
8221
8496
  result: null
8497
+ action_type: 'SET_COOL'
8222
8498
  error: {
8223
8499
  type: string
8224
8500
  message: string
8225
8501
  }
8226
8502
  }
8227
- }
8228
- }
8229
- '/noise_sensors/simulate/trigger_noise_threshold': {
8230
- route: '/noise_sensors/simulate/trigger_noise_threshold'
8231
- method: 'POST'
8232
- queryParams: {}
8233
- jsonBody: {
8234
- device_id: string
8235
- }
8236
- commonParams: {}
8237
- formData: {}
8238
- jsonResponse: {}
8239
- }
8240
- '/phones/deactivate': {
8241
- route: '/phones/deactivate'
8242
- method: 'DELETE' | 'POST'
8243
- queryParams: {}
8244
- jsonBody: {
8245
- device_id: string
8246
- }
8247
- commonParams: {}
8248
- formData: {}
8249
- jsonResponse: {}
8250
- }
8251
- '/phones/list': {
8252
- route: '/phones/list'
8503
+ | {
8504
+ /**
8505
+ ---
8506
+ title: Action Attempt ID
8507
+ ---
8508
+ The ID of the action attempt.
8509
+ */
8510
+ action_attempt_id: string
8511
+ status: 'pending'
8512
+ result: null
8513
+ error: null
8514
+ action_type: 'SET_HEAT'
8515
+ }
8516
+ | {
8517
+ /**
8518
+ ---
8519
+ title: Action Attempt ID
8520
+ ---
8521
+ The ID of the action attempt.
8522
+ */
8523
+ action_attempt_id: string
8524
+ status: 'success'
8525
+ error: null
8526
+ action_type: 'SET_HEAT'
8527
+ result: {}
8528
+ }
8529
+ | {
8530
+ /**
8531
+ ---
8532
+ title: Action Attempt ID
8533
+ ---
8534
+ The ID of the action attempt.
8535
+ */
8536
+ action_attempt_id: string
8537
+ status: 'error'
8538
+ result: null
8539
+ action_type: 'SET_HEAT'
8540
+ error: {
8541
+ type: string
8542
+ message: string
8543
+ }
8544
+ }
8545
+ | {
8546
+ /**
8547
+ ---
8548
+ title: Action Attempt ID
8549
+ ---
8550
+ The ID of the action attempt.
8551
+ */
8552
+ action_attempt_id: string
8553
+ status: 'pending'
8554
+ result: null
8555
+ error: null
8556
+ action_type: 'SET_HEAT_COOL'
8557
+ }
8558
+ | {
8559
+ /**
8560
+ ---
8561
+ title: Action Attempt ID
8562
+ ---
8563
+ The ID of the action attempt.
8564
+ */
8565
+ action_attempt_id: string
8566
+ status: 'success'
8567
+ error: null
8568
+ action_type: 'SET_HEAT_COOL'
8569
+ result: {}
8570
+ }
8571
+ | {
8572
+ /**
8573
+ ---
8574
+ title: Action Attempt ID
8575
+ ---
8576
+ The ID of the action attempt.
8577
+ */
8578
+ action_attempt_id: string
8579
+ status: 'error'
8580
+ result: null
8581
+ action_type: 'SET_HEAT_COOL'
8582
+ error: {
8583
+ type: string
8584
+ message: string
8585
+ }
8586
+ }
8587
+ | {
8588
+ /**
8589
+ ---
8590
+ title: Action Attempt ID
8591
+ ---
8592
+ The ID of the action attempt.
8593
+ */
8594
+ action_attempt_id: string
8595
+ status: 'pending'
8596
+ result: null
8597
+ error: null
8598
+ action_type: 'SET_FAN_MODE'
8599
+ }
8600
+ | {
8601
+ /**
8602
+ ---
8603
+ title: Action Attempt ID
8604
+ ---
8605
+ The ID of the action attempt.
8606
+ */
8607
+ action_attempt_id: string
8608
+ status: 'success'
8609
+ error: null
8610
+ action_type: 'SET_FAN_MODE'
8611
+ result: {}
8612
+ }
8613
+ | {
8614
+ /**
8615
+ ---
8616
+ title: Action Attempt ID
8617
+ ---
8618
+ The ID of the action attempt.
8619
+ */
8620
+ action_attempt_id: string
8621
+ status: 'error'
8622
+ result: null
8623
+ action_type: 'SET_FAN_MODE'
8624
+ error: {
8625
+ type: string
8626
+ message: string
8627
+ }
8628
+ }
8629
+ | {
8630
+ /**
8631
+ ---
8632
+ title: Action Attempt ID
8633
+ ---
8634
+ The ID of the action attempt.
8635
+ */
8636
+ action_attempt_id: string
8637
+ status: 'pending'
8638
+ result: null
8639
+ error: null
8640
+ action_type: 'SET_THERMOSTAT_OFF'
8641
+ }
8642
+ | {
8643
+ /**
8644
+ ---
8645
+ title: Action Attempt ID
8646
+ ---
8647
+ The ID of the action attempt.
8648
+ */
8649
+ action_attempt_id: string
8650
+ status: 'success'
8651
+ error: null
8652
+ action_type: 'SET_THERMOSTAT_OFF'
8653
+ result: {}
8654
+ }
8655
+ | {
8656
+ /**
8657
+ ---
8658
+ title: Action Attempt ID
8659
+ ---
8660
+ The ID of the action attempt.
8661
+ */
8662
+ action_attempt_id: string
8663
+ status: 'error'
8664
+ result: null
8665
+ action_type: 'SET_THERMOSTAT_OFF'
8666
+ error: {
8667
+ type: string
8668
+ message: string
8669
+ }
8670
+ }
8671
+ }
8672
+ }
8673
+ '/networks/get': {
8674
+ route: '/networks/get'
8253
8675
  method: 'GET' | 'POST'
8254
8676
  queryParams: {}
8255
8677
  jsonBody: {}
8256
8678
  commonParams: {
8257
- owner_user_identity_id?: string | undefined
8679
+ network_id: string
8258
8680
  }
8259
8681
  formData: {}
8260
8682
  jsonResponse: {
8261
- phones: Array<{
8262
- /** Unique identifier for the device. */
8263
- device_id: string
8264
- device_type: 'android_phone' | 'ios_phone'
8265
- /** Optional nickname to describe the device, settable through Seam */
8266
- nickname?: string | undefined
8267
- /** 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. */
8683
+ network: {
8684
+ network_id: string
8685
+ workspace_id: string
8268
8686
  display_name: string
8269
- /** 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. */
8270
- capabilities_supported: Array<
8271
- | 'access_code'
8272
- | 'lock'
8273
- | 'noise_detection'
8274
- | 'thermostat'
8275
- | 'battery'
8276
- | 'phone'
8277
- >
8278
- properties: {
8279
- assa_abloy_credential_service_metadata?:
8280
- | {
8281
- has_active_endpoint: boolean
8282
- endpoints: Array<{
8283
- endpoint_id: string
8284
- is_active: boolean
8285
- }>
8286
- }
8287
- | undefined
8288
- }
8289
- /** Location information for the device. */
8290
- location: {
8291
- /** Name of the device location. */
8292
- location_name?: string | undefined
8293
- /** Time zone of the device location. */
8294
- timezone?: string | undefined
8295
- } | null
8296
- /** Unique identifier for the Seam workspace associated with the device. */
8687
+ created_at: string
8688
+ }
8689
+ }
8690
+ }
8691
+ '/networks/list': {
8692
+ route: '/networks/list'
8693
+ method: 'GET' | 'POST'
8694
+ queryParams: {}
8695
+ jsonBody: {}
8696
+ commonParams: {}
8697
+ formData: {}
8698
+ jsonResponse: {
8699
+ networks: Array<{
8700
+ network_id: string
8297
8701
  workspace_id: string
8298
- /** 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. */
8299
- errors: Array<{
8300
- error_code: string
8301
- message: string
8302
- }>
8303
- /** 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. */
8304
- warnings: Array<{
8305
- warning_code: string
8306
- message: string
8307
- }>
8308
- /** Date and time at which the device object was created. */
8702
+ display_name: string
8309
8703
  created_at: string
8310
- /** Indicates whether Seam manages the device. */
8311
- is_managed: true
8312
- custom_metadata: Record<string, string | boolean>
8313
- can_remotely_unlock?: boolean | undefined
8314
- can_remotely_lock?: boolean | undefined
8315
- can_program_offline_access_codes?: boolean | undefined
8316
- can_program_online_access_codes?: boolean | undefined
8317
- can_simulate_removal?: boolean | undefined
8318
8704
  }>
8319
8705
  }
8320
8706
  }
8321
- '/phones/simulate/create_sandbox_phone': {
8322
- route: '/phones/simulate/create_sandbox_phone'
8323
- method: 'GET' | 'POST'
8707
+ '/noise_sensors/noise_thresholds/create': {
8708
+ route: '/noise_sensors/noise_thresholds/create'
8709
+ method: 'POST'
8324
8710
  queryParams: {}
8325
8711
  jsonBody: {
8326
- custom_sdk_installation_id?: string | undefined
8327
- user_identity_id: string
8328
- phone_metadata?: {
8329
- operating_system?: 'android' | 'ios'
8330
- os_version?: string
8331
- device_manufacturer?: string
8332
- device_model?: string
8333
- }
8334
- assa_abloy_metadata?: {
8335
- ble_capability?: boolean
8336
- hce_capability?: boolean
8337
- nfc_capability?: boolean
8338
- application_version?: string
8339
- seos_applet_version?: string
8340
- seos_tsm_endpoint_id?: number
8341
- }
8712
+ device_id: string
8713
+ sync?: boolean
8714
+ name?: string | undefined
8715
+ starts_daily_at: string
8716
+ ends_daily_at: string
8717
+ noise_threshold_decibels?: number | undefined
8718
+ noise_threshold_nrs?: number | undefined
8342
8719
  }
8343
8720
  commonParams: {}
8344
8721
  formData: {}
8345
8722
  jsonResponse: {
8346
- phone: {
8347
- /** Unique identifier for the device. */
8348
- device_id: string
8349
- device_type: 'android_phone' | 'ios_phone'
8350
- /** Optional nickname to describe the device, settable through Seam */
8351
- nickname?: string | undefined
8352
- /** 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. */
8353
- display_name: string
8354
- /** 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. */
8355
- capabilities_supported: Array<
8356
- | 'access_code'
8357
- | 'lock'
8358
- | 'noise_detection'
8359
- | 'thermostat'
8360
- | 'battery'
8361
- | 'phone'
8362
- >
8363
- properties: {
8364
- assa_abloy_credential_service_metadata?:
8365
- | {
8366
- has_active_endpoint: boolean
8367
- endpoints: Array<{
8368
- endpoint_id: string
8369
- is_active: boolean
8370
- }>
8371
- }
8372
- | undefined
8373
- }
8374
- /** Location information for the device. */
8375
- location: {
8376
- /** Name of the device location. */
8377
- location_name?: string | undefined
8378
- /** Time zone of the device location. */
8379
- timezone?: string | undefined
8380
- } | null
8381
- /** Unique identifier for the Seam workspace associated with the device. */
8382
- workspace_id: string
8383
- /** 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. */
8384
- errors: Array<{
8385
- error_code: string
8386
- message: string
8387
- }>
8388
- /** 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. */
8389
- warnings: Array<{
8390
- warning_code: string
8391
- message: string
8392
- }>
8393
- /** Date and time at which the device object was created. */
8394
- created_at: string
8395
- /** Indicates whether Seam manages the device. */
8396
- is_managed: true
8397
- custom_metadata: Record<string, string | boolean>
8398
- can_remotely_unlock?: boolean | undefined
8399
- can_remotely_lock?: boolean | undefined
8400
- can_program_offline_access_codes?: boolean | undefined
8401
- can_program_online_access_codes?: boolean | undefined
8402
- can_simulate_removal?: boolean | undefined
8403
- }
8404
- }
8405
- }
8406
- '/thermostats/climate_setting_schedules/create': {
8407
- route: '/thermostats/climate_setting_schedules/create'
8408
- method: 'POST'
8409
- queryParams: {}
8410
- jsonBody: {
8411
- schedule_type?: 'time_bound'
8412
- device_id: string
8413
- name?: string | undefined
8414
- schedule_starts_at: string
8415
- schedule_ends_at: string
8416
- automatic_heating_enabled?: boolean | undefined
8417
- automatic_cooling_enabled?: boolean | undefined
8418
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8419
- cooling_set_point_celsius?: (number | undefined) | undefined
8420
- heating_set_point_celsius?: (number | undefined) | undefined
8421
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
8422
- heating_set_point_fahrenheit?: (number | undefined) | undefined
8423
- manual_override_allowed?: boolean | undefined
8424
- }
8425
- commonParams: {}
8426
- formData: {}
8427
- jsonResponse: {
8428
- climate_setting_schedule: {
8429
- climate_setting_schedule_id: string
8430
- schedule_type: 'time_bound'
8431
- device_id: string
8432
- name?: string | undefined
8433
- schedule_starts_at: string
8434
- schedule_ends_at: string
8435
- created_at: string
8436
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8437
- errors?: any
8438
- automatic_heating_enabled?: boolean | undefined
8439
- automatic_cooling_enabled?: boolean | undefined
8440
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8441
- cooling_set_point_celsius?: (number | undefined) | undefined
8442
- heating_set_point_celsius?: (number | undefined) | undefined
8443
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
8444
- heating_set_point_fahrenheit?: (number | undefined) | undefined
8445
- manual_override_allowed?: boolean | undefined
8446
- }
8447
- }
8448
- }
8449
- '/thermostats/climate_setting_schedules/delete': {
8450
- route: '/thermostats/climate_setting_schedules/delete'
8451
- method: 'DELETE' | 'POST' | 'PUT'
8452
- queryParams: {}
8453
- jsonBody: {}
8454
- commonParams: {
8455
- climate_setting_schedule_id: string
8456
- }
8457
- formData: {}
8458
- jsonResponse: {}
8459
- }
8460
- '/thermostats/climate_setting_schedules/get': {
8461
- route: '/thermostats/climate_setting_schedules/get'
8462
- method: 'GET' | 'POST'
8463
- queryParams: {}
8464
- jsonBody: {}
8465
- commonParams: {
8466
- climate_setting_schedule_id?: string | undefined
8467
- device_id?: string | undefined
8468
- }
8469
- formData: {}
8470
- jsonResponse: {
8471
- climate_setting_schedule: {
8472
- climate_setting_schedule_id: string
8473
- schedule_type: 'time_bound'
8474
- device_id: string
8475
- name?: string | undefined
8476
- schedule_starts_at: string
8477
- schedule_ends_at: string
8478
- created_at: string
8479
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8480
- errors?: any
8481
- automatic_heating_enabled?: boolean | undefined
8482
- automatic_cooling_enabled?: boolean | undefined
8483
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8484
- cooling_set_point_celsius?: (number | undefined) | undefined
8485
- heating_set_point_celsius?: (number | undefined) | undefined
8486
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
8487
- heating_set_point_fahrenheit?: (number | undefined) | undefined
8488
- manual_override_allowed?: boolean | undefined
8489
- }
8490
- }
8491
- }
8492
- '/thermostats/climate_setting_schedules/list': {
8493
- route: '/thermostats/climate_setting_schedules/list'
8494
- method: 'GET' | 'POST'
8495
- queryParams: {}
8496
- jsonBody: {}
8497
- commonParams: {
8498
- device_id: string
8499
- user_identifier_key?: string | undefined
8500
- }
8501
- formData: {}
8502
- jsonResponse: {
8503
- climate_setting_schedules: Array<{
8504
- climate_setting_schedule_id: string
8505
- schedule_type: 'time_bound'
8506
- device_id: string
8507
- name?: string | undefined
8508
- schedule_starts_at: string
8509
- schedule_ends_at: string
8510
- created_at: string
8511
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8512
- errors?: any
8513
- automatic_heating_enabled?: boolean | undefined
8514
- automatic_cooling_enabled?: boolean | undefined
8515
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8516
- cooling_set_point_celsius?: (number | undefined) | undefined
8517
- heating_set_point_celsius?: (number | undefined) | undefined
8518
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
8519
- heating_set_point_fahrenheit?: (number | undefined) | undefined
8520
- manual_override_allowed?: boolean | undefined
8521
- }>
8522
- }
8523
- }
8524
- '/thermostats/climate_setting_schedules/update': {
8525
- route: '/thermostats/climate_setting_schedules/update'
8526
- method: 'PATCH' | 'POST' | 'PUT'
8527
- queryParams: {}
8528
- jsonBody: {
8529
- climate_setting_schedule_id: string
8530
- schedule_type?: 'time_bound'
8531
- name?: string | undefined
8532
- schedule_starts_at?: string | undefined
8533
- schedule_ends_at?: string | undefined
8534
- automatic_heating_enabled?: boolean | undefined
8535
- automatic_cooling_enabled?: boolean | undefined
8536
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8537
- cooling_set_point_celsius?: (number | undefined) | undefined
8538
- heating_set_point_celsius?: (number | undefined) | undefined
8539
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
8540
- heating_set_point_fahrenheit?: (number | undefined) | undefined
8541
- manual_override_allowed?: boolean | undefined
8542
- }
8543
- commonParams: {}
8544
- formData: {}
8545
- jsonResponse: {
8546
- climate_setting_schedule: {
8547
- climate_setting_schedule_id: string
8548
- schedule_type: 'time_bound'
8723
+ action_attempt:
8724
+ | {
8725
+ status: 'success'
8726
+ action_type: string
8727
+ action_attempt_id: string
8728
+ result?: any
8729
+ error: null
8730
+ }
8731
+ | {
8732
+ status: 'pending'
8733
+ action_type: string
8734
+ action_attempt_id: string
8735
+ result: null
8736
+ error: null
8737
+ }
8738
+ | {
8739
+ status: 'error'
8740
+ action_type: string
8741
+ action_attempt_id: string
8742
+ result: null
8743
+ error: {
8744
+ type: string
8745
+ message: string
8746
+ }
8747
+ }
8748
+ noise_threshold: {
8749
+ noise_threshold_id: string
8549
8750
  device_id: string
8550
- name?: string | undefined
8551
- schedule_starts_at: string
8552
- schedule_ends_at: string
8553
- created_at: string
8554
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8555
- errors?: any
8556
- automatic_heating_enabled?: boolean | undefined
8557
- automatic_cooling_enabled?: boolean | undefined
8558
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8559
- cooling_set_point_celsius?: (number | undefined) | undefined
8560
- heating_set_point_celsius?: (number | undefined) | undefined
8561
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
8562
- heating_set_point_fahrenheit?: (number | undefined) | undefined
8563
- manual_override_allowed?: boolean | undefined
8751
+ name: string
8752
+ noise_threshold_nrs?: number | undefined
8753
+ starts_daily_at: string
8754
+ ends_daily_at: string
8755
+ noise_threshold_decibels: number
8564
8756
  }
8565
8757
  }
8566
8758
  }
8567
- '/thermostats/cool': {
8568
- route: '/thermostats/cool'
8569
- method: 'POST'
8759
+ '/noise_sensors/noise_thresholds/delete': {
8760
+ route: '/noise_sensors/noise_thresholds/delete'
8761
+ method: 'DELETE' | 'POST'
8570
8762
  queryParams: {}
8571
8763
  jsonBody: {
8764
+ noise_threshold_id: string
8572
8765
  device_id: string
8573
- cooling_set_point_celsius?: number | undefined
8574
- cooling_set_point_fahrenheit?: number | undefined
8575
8766
  sync?: boolean
8576
8767
  }
8577
8768
  commonParams: {}
@@ -8604,57 +8795,129 @@ export interface Routes {
8604
8795
  }
8605
8796
  }
8606
8797
  }
8607
- '/thermostats/get': {
8608
- route: '/thermostats/get'
8798
+ '/noise_sensors/noise_thresholds/get': {
8799
+ route: '/noise_sensors/noise_thresholds/get'
8609
8800
  method: 'GET' | 'POST'
8610
8801
  queryParams: {}
8611
8802
  jsonBody: {}
8612
8803
  commonParams: {
8613
- device_id?: string | undefined
8614
- name?: string | undefined
8804
+ noise_threshold_id: string
8615
8805
  }
8616
8806
  formData: {}
8617
8807
  jsonResponse: {
8618
- thermostat: {
8619
- /** Unique identifier for the device. */
8808
+ noise_threshold: {
8809
+ noise_threshold_id: string
8620
8810
  device_id: string
8621
- /** Type of the device. */
8622
- device_type:
8623
- | (
8624
- | 'akuvox_lock'
8625
- | 'august_lock'
8626
- | 'brivo_access_point'
8627
- | 'butterflymx_panel'
8628
- | 'avigilon_alta_entry'
8629
- | 'doorking_lock'
8630
- | 'genie_door'
8631
- | 'igloo_lock'
8632
- | 'linear_lock'
8633
- | 'lockly_lock'
8634
- | 'kwikset_lock'
8635
- | 'nuki_lock'
8636
- | 'salto_lock'
8637
- | 'schlage_lock'
8638
- | 'seam_relay'
8639
- | 'smartthings_lock'
8640
- | 'wyze_lock'
8641
- | 'yale_lock'
8642
- | 'two_n_intercom'
8643
- | 'controlbyweb_device'
8644
- | 'ttlock_lock'
8645
- | 'igloohome_lock'
8646
- | 'hubitat_lock'
8647
- | 'four_suites_door'
8648
- | 'dormakaba_oracode_door'
8649
- | 'tedee_lock'
8650
- )
8651
- | ('noiseaware_activity_zone' | 'minut_sensor')
8652
- | (
8653
- | 'ecobee_thermostat'
8654
- | 'nest_thermostat'
8655
- | 'honeywell_resideo_thermostat'
8656
- )
8657
- | ('ios_phone' | 'android_phone')
8811
+ name: string
8812
+ noise_threshold_nrs?: number | undefined
8813
+ starts_daily_at: string
8814
+ ends_daily_at: string
8815
+ noise_threshold_decibels: number
8816
+ }
8817
+ }
8818
+ }
8819
+ '/noise_sensors/noise_thresholds/list': {
8820
+ route: '/noise_sensors/noise_thresholds/list'
8821
+ method: 'GET' | 'POST'
8822
+ queryParams: {}
8823
+ jsonBody: {}
8824
+ commonParams: {
8825
+ device_id: string
8826
+ is_programmed?: boolean | undefined
8827
+ }
8828
+ formData: {}
8829
+ jsonResponse: {
8830
+ noise_thresholds: Array<{
8831
+ noise_threshold_id: string
8832
+ device_id: string
8833
+ name: string
8834
+ noise_threshold_nrs?: number | undefined
8835
+ starts_daily_at: string
8836
+ ends_daily_at: string
8837
+ noise_threshold_decibels: number
8838
+ }>
8839
+ }
8840
+ }
8841
+ '/noise_sensors/noise_thresholds/update': {
8842
+ route: '/noise_sensors/noise_thresholds/update'
8843
+ method: 'PATCH' | 'POST' | 'PUT'
8844
+ queryParams: {}
8845
+ jsonBody: {
8846
+ noise_threshold_id: string
8847
+ device_id: string
8848
+ sync?: boolean
8849
+ name?: string | undefined
8850
+ starts_daily_at?: string | undefined
8851
+ ends_daily_at?: string | undefined
8852
+ noise_threshold_decibels?: number | undefined
8853
+ noise_threshold_nrs?: number | undefined
8854
+ }
8855
+ commonParams: {}
8856
+ formData: {}
8857
+ jsonResponse: {
8858
+ action_attempt:
8859
+ | {
8860
+ status: 'success'
8861
+ action_type: string
8862
+ action_attempt_id: string
8863
+ result?: any
8864
+ error: null
8865
+ }
8866
+ | {
8867
+ status: 'pending'
8868
+ action_type: string
8869
+ action_attempt_id: string
8870
+ result: null
8871
+ error: null
8872
+ }
8873
+ | {
8874
+ status: 'error'
8875
+ action_type: string
8876
+ action_attempt_id: string
8877
+ result: null
8878
+ error: {
8879
+ type: string
8880
+ message: string
8881
+ }
8882
+ }
8883
+ }
8884
+ }
8885
+ '/noise_sensors/simulate/trigger_noise_threshold': {
8886
+ route: '/noise_sensors/simulate/trigger_noise_threshold'
8887
+ method: 'POST'
8888
+ queryParams: {}
8889
+ jsonBody: {
8890
+ device_id: string
8891
+ }
8892
+ commonParams: {}
8893
+ formData: {}
8894
+ jsonResponse: {}
8895
+ }
8896
+ '/phones/deactivate': {
8897
+ route: '/phones/deactivate'
8898
+ method: 'DELETE' | 'POST'
8899
+ queryParams: {}
8900
+ jsonBody: {
8901
+ device_id: string
8902
+ }
8903
+ commonParams: {}
8904
+ formData: {}
8905
+ jsonResponse: {}
8906
+ }
8907
+ '/phones/list': {
8908
+ route: '/phones/list'
8909
+ method: 'GET' | 'POST'
8910
+ queryParams: {}
8911
+ jsonBody: {}
8912
+ commonParams: {
8913
+ owner_user_identity_id?: string | undefined
8914
+ }
8915
+ formData: {}
8916
+ jsonResponse: {
8917
+ phones: Array<{
8918
+ /** Unique identifier for the device. */
8919
+ device_id: string
8920
+ device_type: 'android_phone' | 'ios_phone'
8658
8921
  /** Optional nickname to describe the device, settable through Seam */
8659
8922
  nickname?: string | undefined
8660
8923
  /** 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. */
@@ -8668,298 +8931,1007 @@ export interface Routes {
8668
8931
  | 'battery'
8669
8932
  | 'phone'
8670
8933
  >
8671
- /** Properties of the device. */
8672
- properties: (({
8673
- /** Indicates whether the device is online. */
8674
- online: boolean
8675
- /**
8676
- ---
8677
- deprecated: use device.display_name instead
8678
- ---
8679
- Name of the device.
8680
- */
8681
- name: string
8682
- /** Represents the accessory keypad state. */
8683
- accessory_keypad?:
8684
- | {
8685
- /** Indicates if the accessory_keypad is connected to the device. */
8686
- is_connected: boolean
8687
- /** Indicates if the keypad battery properties. */
8688
- battery?:
8689
- | {
8690
- level: number
8691
- }
8692
- | undefined
8693
- }
8694
- | undefined
8695
- appearance: {
8696
- /** Name of the device as seen from the provider API and application, not settable through Seam. */
8697
- name: string
8698
- }
8699
- model: {
8700
- /** Indicates whether the device can connect a accessory keypad. */
8701
- can_connect_accessory_keypad?: boolean | undefined
8702
- /** Display name of the device model. */
8703
- display_name: string
8704
- /** Display name that corresponds to the manufacturer-specific terminology for the device. */
8705
- manufacturer_display_name: string
8706
- /** Indicates whether the device has a built in accessory keypad. */
8707
- has_built_in_keypad?: boolean | undefined
8708
- /** Indicates whether the device supports offline access codes. */
8709
- offline_access_codes_supported?: boolean | undefined
8710
- /** Indicates whether the device supports online access codes. */
8711
- online_access_codes_supported?: boolean | undefined
8712
- /** Indicates whether the device supports an accessory keypad. */
8713
- accessory_keypad_supported?: boolean | undefined
8714
- }
8715
- /** Indicates whether the device has direct power. */
8716
- has_direct_power?: boolean | undefined
8717
- /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
8718
- battery_level?: number | undefined
8719
- /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
8720
- battery?:
8721
- | {
8722
- level: number
8723
- status: 'critical' | 'low' | 'good' | 'full'
8724
- }
8725
- | undefined
8726
- /** Manufacturer of the device. */
8727
- manufacturer?: string | undefined
8728
- /** Image URL for the device. */
8729
- image_url?: string | undefined
8730
- /** Alt text for the device image. */
8731
- image_alt_text?: string | undefined
8732
- /** Serial number of the device. */
8733
- serial_number?: string | undefined
8734
- /** Indicates whether it is currently possible to use online access codes for the device. */
8735
- online_access_codes_enabled?: boolean | undefined
8736
- /** Indicates whether it is currently possible to use offline access codes for the device. */
8737
- offline_access_codes_enabled?: boolean | undefined
8738
- /**
8739
- ---
8740
- deprecated: use model.accessory_keypad_supported
8741
- ---
8742
- */
8743
- supports_accessory_keypad?: boolean | undefined
8744
- /**
8745
- ---
8746
- deprecated: use offline_access_codes_enabled
8747
- ---
8748
- */
8749
- supports_offline_access_codes?: boolean | undefined
8750
- /** Indicates current noise level in decibels, if the device supports noise detection. */
8751
- noise_level_decibels?: number | undefined
8752
- } & {
8934
+ properties: {
8753
8935
  assa_abloy_credential_service_metadata?:
8754
- | (
8755
- | {
8756
- has_active_endpoint: boolean
8757
- endpoints: Array<{
8758
- endpoint_id: string
8759
- is_active: boolean
8760
- }>
8761
- }
8762
- | undefined
8763
- )
8764
- | undefined
8765
- }) & {
8766
- august_metadata?:
8767
8936
  | {
8768
- lock_id: string
8769
- lock_name: string
8770
- house_name: string
8771
- has_keypad: boolean
8772
- keypad_battery_level?: string | undefined
8773
- model?: string | undefined
8774
- house_id?: string | undefined
8937
+ has_active_endpoint: boolean
8938
+ endpoints: Array<{
8939
+ endpoint_id: string
8940
+ is_active: boolean
8941
+ }>
8775
8942
  }
8776
8943
  | undefined
8777
- avigilon_alta_metadata?:
8778
- | {
8779
- entry_name: string
8780
- org_name: string
8781
- zone_id: number
8782
- zone_name: string
8783
- site_id: number
8784
- site_name: string
8785
- entry_relays_total_count: number
8786
- }
8787
- | undefined
8788
- schlage_metadata?:
8789
- | {
8790
- device_id: string
8791
- device_name: string
8792
- access_code_length: number | null
8793
- model?: string | undefined
8794
- }
8795
- | undefined
8796
- smartthings_metadata?:
8797
- | {
8798
- device_id: string
8799
- device_name: string
8800
- model?: string | undefined
8801
- location_id?: string | undefined
8802
- }
8803
- | undefined
8804
- lockly_metadata?:
8805
- | {
8806
- device_id: string
8807
- device_name: string
8808
- model?: string | undefined
8809
- }
8810
- | undefined
8811
- nuki_metadata?:
8812
- | {
8813
- device_id: string
8814
- device_name: string
8815
- keypad_battery_critical?: boolean | undefined
8816
- keypad_paired?: boolean | undefined
8817
- keypad_2_paired?: boolean | undefined
8818
- }
8819
- | undefined
8820
- kwikset_metadata?:
8821
- | {
8822
- device_id: string
8823
- device_name: string
8824
- model_number: string
8825
- }
8826
- | undefined
8827
- salto_metadata?:
8828
- | {
8829
- lock_id: string
8830
- customer_reference: string
8831
- lock_type: string
8832
- battery_level: string
8833
- locked_state: string
8834
- model?: string | undefined
8835
- }
8836
- | undefined
8837
- genie_metadata?:
8838
- | {
8839
- device_name: string
8840
- door_name: string
8841
- }
8842
- | undefined
8843
- brivo_metadata?:
8844
- | {
8845
- device_name: string
8846
- }
8847
- | undefined
8848
- igloo_metadata?:
8849
- | {
8850
- device_id: string
8851
- bridge_id: string
8852
- model?: string | undefined
8853
- }
8854
- | undefined
8855
- noiseaware_metadata?:
8856
- | {
8857
- device_model: 'indoor' | 'outdoor'
8858
- noise_level_nrs: number
8859
- noise_level_decibel: number
8860
- device_name: string
8861
- device_id: string
8862
- }
8863
- | undefined
8864
- minut_metadata?:
8865
- | {
8866
- device_id: string
8867
- device_name: string
8868
- latest_sensor_values: {
8869
- temperature: {
8870
- time: string
8871
- value: number
8872
- }
8873
- sound: {
8874
- time: string
8875
- value: number
8876
- }
8877
- humidity: {
8878
- time: string
8879
- value: number
8880
- }
8881
- pressure: {
8882
- time: string
8883
- value: number
8884
- }
8885
- accelerometer_z: {
8886
- time: string
8887
- value: number
8888
- }
8889
- }
8890
- }
8891
- | undefined
8892
- four_suites_metadata?:
8893
- | {
8894
- device_id: number
8895
- device_name: string
8896
- reclose_delay_in_seconds: number
8897
- }
8898
- | undefined
8899
- two_n_metadata?:
8900
- | {
8901
- device_id: number
8902
- device_name: string
8903
- }
8904
- | undefined
8905
- controlbyweb_metadata?:
8906
- | {
8907
- device_id: string
8908
- device_name: string
8909
- relay_name: string | null
8910
- }
8911
- | undefined
8912
- ttlock_metadata?:
8913
- | {
8914
- lock_id: number
8915
- lock_alias: string
8916
- feature_value: string
8917
- }
8918
- | undefined
8919
- seam_bridge_metadata?:
8920
- | {
8921
- unlock_method?: ('bridge' | 'doorking') | undefined
8922
- device_num: number
8923
- name: string
8924
- }
8925
- | undefined
8926
- igloohome_metadata?:
8927
- | {
8928
- device_id: string
8929
- device_name: string
8930
- bridge_id?: string | undefined
8931
- bridge_name?: string | undefined
8932
- keypad_id?: string | undefined
8933
- }
8934
- | undefined
8935
- nest_metadata?:
8936
- | {
8937
- nest_device_id: string
8938
- device_name: string
8939
- custom_name: string
8940
- }
8941
- | undefined
8942
- ecobee_metadata?:
8943
- | {
8944
- ecobee_device_id: string
8945
- device_name: string
8946
- }
8947
- | undefined
8948
- honeywell_resideo_metadata?:
8949
- | {
8950
- honeywell_resideo_device_id: string
8951
- device_name: string
8952
- }
8953
- | undefined
8954
- hubitat_metadata?:
8944
+ }
8945
+ /** Location information for the device. */
8946
+ location: {
8947
+ /** Name of the device location. */
8948
+ location_name?: string | undefined
8949
+ /** Time zone of the device location. */
8950
+ timezone?: string | undefined
8951
+ } | null
8952
+ /** Unique identifier for the Seam workspace associated with the device. */
8953
+ workspace_id: string
8954
+ /** 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. */
8955
+ errors: Array<{
8956
+ error_code: string
8957
+ message: string
8958
+ }>
8959
+ /** 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. */
8960
+ warnings: Array<{
8961
+ warning_code: string
8962
+ message: string
8963
+ }>
8964
+ /** Date and time at which the device object was created. */
8965
+ created_at: string
8966
+ /** Indicates whether Seam manages the device. */
8967
+ is_managed: true
8968
+ custom_metadata: Record<string, string | boolean>
8969
+ can_remotely_unlock?: boolean | undefined
8970
+ can_remotely_lock?: boolean | undefined
8971
+ can_program_offline_access_codes?: boolean | undefined
8972
+ can_program_online_access_codes?: boolean | undefined
8973
+ can_simulate_removal?: boolean | undefined
8974
+ }>
8975
+ }
8976
+ }
8977
+ '/phones/simulate/create_sandbox_phone': {
8978
+ route: '/phones/simulate/create_sandbox_phone'
8979
+ method: 'GET' | 'POST'
8980
+ queryParams: {}
8981
+ jsonBody: {
8982
+ custom_sdk_installation_id?: string | undefined
8983
+ user_identity_id: string
8984
+ phone_metadata?: {
8985
+ operating_system?: 'android' | 'ios'
8986
+ os_version?: string
8987
+ device_manufacturer?: string
8988
+ device_model?: string
8989
+ }
8990
+ assa_abloy_metadata?: {
8991
+ ble_capability?: boolean
8992
+ hce_capability?: boolean
8993
+ nfc_capability?: boolean
8994
+ application_version?: string
8995
+ seos_applet_version?: string
8996
+ seos_tsm_endpoint_id?: number
8997
+ }
8998
+ }
8999
+ commonParams: {}
9000
+ formData: {}
9001
+ jsonResponse: {
9002
+ phone: {
9003
+ /** Unique identifier for the device. */
9004
+ device_id: string
9005
+ device_type: 'android_phone' | 'ios_phone'
9006
+ /** Optional nickname to describe the device, settable through Seam */
9007
+ nickname?: string | undefined
9008
+ /** 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. */
9009
+ display_name: string
9010
+ /** 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. */
9011
+ capabilities_supported: Array<
9012
+ | 'access_code'
9013
+ | 'lock'
9014
+ | 'noise_detection'
9015
+ | 'thermostat'
9016
+ | 'battery'
9017
+ | 'phone'
9018
+ >
9019
+ properties: {
9020
+ assa_abloy_credential_service_metadata?:
8955
9021
  | {
8956
- device_id: string
8957
- device_name: string
8958
- device_label: string
9022
+ has_active_endpoint: boolean
9023
+ endpoints: Array<{
9024
+ endpoint_id: string
9025
+ is_active: boolean
9026
+ }>
8959
9027
  }
8960
9028
  | undefined
8961
- dormakaba_oracode_metadata?:
8962
- | {
9029
+ }
9030
+ /** Location information for the device. */
9031
+ location: {
9032
+ /** Name of the device location. */
9033
+ location_name?: string | undefined
9034
+ /** Time zone of the device location. */
9035
+ timezone?: string | undefined
9036
+ } | null
9037
+ /** Unique identifier for the Seam workspace associated with the device. */
9038
+ workspace_id: string
9039
+ /** 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. */
9040
+ errors: Array<{
9041
+ error_code: string
9042
+ message: string
9043
+ }>
9044
+ /** 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. */
9045
+ warnings: Array<{
9046
+ warning_code: string
9047
+ message: string
9048
+ }>
9049
+ /** Date and time at which the device object was created. */
9050
+ created_at: string
9051
+ /** Indicates whether Seam manages the device. */
9052
+ is_managed: true
9053
+ custom_metadata: Record<string, string | boolean>
9054
+ can_remotely_unlock?: boolean | undefined
9055
+ can_remotely_lock?: boolean | undefined
9056
+ can_program_offline_access_codes?: boolean | undefined
9057
+ can_program_online_access_codes?: boolean | undefined
9058
+ can_simulate_removal?: boolean | undefined
9059
+ }
9060
+ }
9061
+ }
9062
+ '/thermostats/climate_setting_schedules/create': {
9063
+ route: '/thermostats/climate_setting_schedules/create'
9064
+ method: 'POST'
9065
+ queryParams: {}
9066
+ jsonBody: {
9067
+ schedule_type?: 'time_bound'
9068
+ device_id: string
9069
+ name?: string | undefined
9070
+ schedule_starts_at: string
9071
+ schedule_ends_at: string
9072
+ automatic_heating_enabled?: boolean | undefined
9073
+ automatic_cooling_enabled?: boolean | undefined
9074
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
9075
+ cooling_set_point_celsius?: (number | undefined) | undefined
9076
+ heating_set_point_celsius?: (number | undefined) | undefined
9077
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
9078
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
9079
+ manual_override_allowed?: boolean | undefined
9080
+ }
9081
+ commonParams: {}
9082
+ formData: {}
9083
+ jsonResponse: {
9084
+ climate_setting_schedule: {
9085
+ climate_setting_schedule_id: string
9086
+ schedule_type: 'time_bound'
9087
+ device_id: string
9088
+ name?: string | undefined
9089
+ schedule_starts_at: string
9090
+ schedule_ends_at: string
9091
+ created_at: string
9092
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
9093
+ errors?: any
9094
+ automatic_heating_enabled?: boolean | undefined
9095
+ automatic_cooling_enabled?: boolean | undefined
9096
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
9097
+ cooling_set_point_celsius?: (number | undefined) | undefined
9098
+ heating_set_point_celsius?: (number | undefined) | undefined
9099
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
9100
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
9101
+ manual_override_allowed?: boolean | undefined
9102
+ }
9103
+ }
9104
+ }
9105
+ '/thermostats/climate_setting_schedules/delete': {
9106
+ route: '/thermostats/climate_setting_schedules/delete'
9107
+ method: 'DELETE' | 'POST' | 'PUT'
9108
+ queryParams: {}
9109
+ jsonBody: {}
9110
+ commonParams: {
9111
+ climate_setting_schedule_id: string
9112
+ }
9113
+ formData: {}
9114
+ jsonResponse: {}
9115
+ }
9116
+ '/thermostats/climate_setting_schedules/get': {
9117
+ route: '/thermostats/climate_setting_schedules/get'
9118
+ method: 'GET' | 'POST'
9119
+ queryParams: {}
9120
+ jsonBody: {}
9121
+ commonParams: {
9122
+ climate_setting_schedule_id?: string | undefined
9123
+ device_id?: string | undefined
9124
+ }
9125
+ formData: {}
9126
+ jsonResponse: {
9127
+ climate_setting_schedule: {
9128
+ climate_setting_schedule_id: string
9129
+ schedule_type: 'time_bound'
9130
+ device_id: string
9131
+ name?: string | undefined
9132
+ schedule_starts_at: string
9133
+ schedule_ends_at: string
9134
+ created_at: string
9135
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
9136
+ errors?: any
9137
+ automatic_heating_enabled?: boolean | undefined
9138
+ automatic_cooling_enabled?: boolean | undefined
9139
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
9140
+ cooling_set_point_celsius?: (number | undefined) | undefined
9141
+ heating_set_point_celsius?: (number | undefined) | undefined
9142
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
9143
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
9144
+ manual_override_allowed?: boolean | undefined
9145
+ }
9146
+ }
9147
+ }
9148
+ '/thermostats/climate_setting_schedules/list': {
9149
+ route: '/thermostats/climate_setting_schedules/list'
9150
+ method: 'GET' | 'POST'
9151
+ queryParams: {}
9152
+ jsonBody: {}
9153
+ commonParams: {
9154
+ device_id: string
9155
+ user_identifier_key?: string | undefined
9156
+ }
9157
+ formData: {}
9158
+ jsonResponse: {
9159
+ climate_setting_schedules: Array<{
9160
+ climate_setting_schedule_id: string
9161
+ schedule_type: 'time_bound'
9162
+ device_id: string
9163
+ name?: string | undefined
9164
+ schedule_starts_at: string
9165
+ schedule_ends_at: string
9166
+ created_at: string
9167
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
9168
+ errors?: any
9169
+ automatic_heating_enabled?: boolean | undefined
9170
+ automatic_cooling_enabled?: boolean | undefined
9171
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
9172
+ cooling_set_point_celsius?: (number | undefined) | undefined
9173
+ heating_set_point_celsius?: (number | undefined) | undefined
9174
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
9175
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
9176
+ manual_override_allowed?: boolean | undefined
9177
+ }>
9178
+ }
9179
+ }
9180
+ '/thermostats/climate_setting_schedules/update': {
9181
+ route: '/thermostats/climate_setting_schedules/update'
9182
+ method: 'PATCH' | 'POST' | 'PUT'
9183
+ queryParams: {}
9184
+ jsonBody: {
9185
+ climate_setting_schedule_id: string
9186
+ schedule_type?: 'time_bound'
9187
+ name?: string | undefined
9188
+ schedule_starts_at?: string | undefined
9189
+ schedule_ends_at?: string | undefined
9190
+ automatic_heating_enabled?: boolean | undefined
9191
+ automatic_cooling_enabled?: boolean | undefined
9192
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
9193
+ cooling_set_point_celsius?: (number | undefined) | undefined
9194
+ heating_set_point_celsius?: (number | undefined) | undefined
9195
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
9196
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
9197
+ manual_override_allowed?: boolean | undefined
9198
+ }
9199
+ commonParams: {}
9200
+ formData: {}
9201
+ jsonResponse: {
9202
+ climate_setting_schedule: {
9203
+ climate_setting_schedule_id: string
9204
+ schedule_type: 'time_bound'
9205
+ device_id: string
9206
+ name?: string | undefined
9207
+ schedule_starts_at: string
9208
+ schedule_ends_at: string
9209
+ created_at: string
9210
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
9211
+ errors?: any
9212
+ automatic_heating_enabled?: boolean | undefined
9213
+ automatic_cooling_enabled?: boolean | undefined
9214
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
9215
+ cooling_set_point_celsius?: (number | undefined) | undefined
9216
+ heating_set_point_celsius?: (number | undefined) | undefined
9217
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
9218
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
9219
+ manual_override_allowed?: boolean | undefined
9220
+ }
9221
+ }
9222
+ }
9223
+ '/thermostats/cool': {
9224
+ route: '/thermostats/cool'
9225
+ method: 'POST'
9226
+ queryParams: {}
9227
+ jsonBody: {
9228
+ device_id: string
9229
+ cooling_set_point_celsius?: number | undefined
9230
+ cooling_set_point_fahrenheit?: number | undefined
9231
+ sync?: boolean
9232
+ }
9233
+ commonParams: {}
9234
+ formData: {}
9235
+ jsonResponse: {
9236
+ action_attempt:
9237
+ | {
9238
+ /**
9239
+ ---
9240
+ title: Action Attempt ID
9241
+ ---
9242
+ The ID of the action attempt.
9243
+ */
9244
+ action_attempt_id: string
9245
+ status: 'pending'
9246
+ result: null
9247
+ error: null
9248
+ action_type: 'LOCK_DOOR'
9249
+ }
9250
+ | {
9251
+ /**
9252
+ ---
9253
+ title: Action Attempt ID
9254
+ ---
9255
+ The ID of the action attempt.
9256
+ */
9257
+ action_attempt_id: string
9258
+ status: 'success'
9259
+ error: null
9260
+ action_type: 'LOCK_DOOR'
9261
+ result: {}
9262
+ }
9263
+ | {
9264
+ /**
9265
+ ---
9266
+ title: Action Attempt ID
9267
+ ---
9268
+ The ID of the action attempt.
9269
+ */
9270
+ action_attempt_id: string
9271
+ status: 'error'
9272
+ result: null
9273
+ action_type: 'LOCK_DOOR'
9274
+ error: {
9275
+ type: string
9276
+ message: string
9277
+ }
9278
+ }
9279
+ | {
9280
+ /**
9281
+ ---
9282
+ title: Action Attempt ID
9283
+ ---
9284
+ The ID of the action attempt.
9285
+ */
9286
+ action_attempt_id: string
9287
+ status: 'pending'
9288
+ result: null
9289
+ error: null
9290
+ action_type: 'UNLOCK_DOOR'
9291
+ }
9292
+ | {
9293
+ /**
9294
+ ---
9295
+ title: Action Attempt ID
9296
+ ---
9297
+ The ID of the action attempt.
9298
+ */
9299
+ action_attempt_id: string
9300
+ status: 'success'
9301
+ error: null
9302
+ action_type: 'UNLOCK_DOOR'
9303
+ result: {}
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: 'error'
9314
+ result: null
9315
+ action_type: 'UNLOCK_DOOR'
9316
+ error: {
9317
+ type: string
9318
+ message: string
9319
+ }
9320
+ }
9321
+ | {
9322
+ /**
9323
+ ---
9324
+ title: Action Attempt ID
9325
+ ---
9326
+ The ID of the action attempt.
9327
+ */
9328
+ action_attempt_id: string
9329
+ status: 'pending'
9330
+ result: null
9331
+ error: null
9332
+ action_type: 'RESET_SANDBOX_WORKSPACE'
9333
+ }
9334
+ | {
9335
+ /**
9336
+ ---
9337
+ title: Action Attempt ID
9338
+ ---
9339
+ The ID of the action attempt.
9340
+ */
9341
+ action_attempt_id: string
9342
+ status: 'success'
9343
+ error: null
9344
+ action_type: 'RESET_SANDBOX_WORKSPACE'
9345
+ result: {}
9346
+ }
9347
+ | {
9348
+ /**
9349
+ ---
9350
+ title: Action Attempt ID
9351
+ ---
9352
+ The ID of the action attempt.
9353
+ */
9354
+ action_attempt_id: string
9355
+ status: 'error'
9356
+ result: null
9357
+ action_type: 'RESET_SANDBOX_WORKSPACE'
9358
+ error: {
9359
+ type: string
9360
+ message: string
9361
+ }
9362
+ }
9363
+ | {
9364
+ /**
9365
+ ---
9366
+ title: Action Attempt ID
9367
+ ---
9368
+ The ID of the action attempt.
9369
+ */
9370
+ action_attempt_id: string
9371
+ status: 'pending'
9372
+ result: null
9373
+ error: null
9374
+ action_type: 'SET_COOL'
9375
+ }
9376
+ | {
9377
+ /**
9378
+ ---
9379
+ title: Action Attempt ID
9380
+ ---
9381
+ The ID of the action attempt.
9382
+ */
9383
+ action_attempt_id: string
9384
+ status: 'success'
9385
+ error: null
9386
+ action_type: 'SET_COOL'
9387
+ result: {}
9388
+ }
9389
+ | {
9390
+ /**
9391
+ ---
9392
+ title: Action Attempt ID
9393
+ ---
9394
+ The ID of the action attempt.
9395
+ */
9396
+ action_attempt_id: string
9397
+ status: 'error'
9398
+ result: null
9399
+ action_type: 'SET_COOL'
9400
+ error: {
9401
+ type: string
9402
+ message: string
9403
+ }
9404
+ }
9405
+ | {
9406
+ /**
9407
+ ---
9408
+ title: Action Attempt ID
9409
+ ---
9410
+ The ID of the action attempt.
9411
+ */
9412
+ action_attempt_id: string
9413
+ status: 'pending'
9414
+ result: null
9415
+ error: null
9416
+ action_type: 'SET_HEAT'
9417
+ }
9418
+ | {
9419
+ /**
9420
+ ---
9421
+ title: Action Attempt ID
9422
+ ---
9423
+ The ID of the action attempt.
9424
+ */
9425
+ action_attempt_id: string
9426
+ status: 'success'
9427
+ error: null
9428
+ action_type: 'SET_HEAT'
9429
+ result: {}
9430
+ }
9431
+ | {
9432
+ /**
9433
+ ---
9434
+ title: Action Attempt ID
9435
+ ---
9436
+ The ID of the action attempt.
9437
+ */
9438
+ action_attempt_id: string
9439
+ status: 'error'
9440
+ result: null
9441
+ action_type: 'SET_HEAT'
9442
+ error: {
9443
+ type: string
9444
+ message: string
9445
+ }
9446
+ }
9447
+ | {
9448
+ /**
9449
+ ---
9450
+ title: Action Attempt ID
9451
+ ---
9452
+ The ID of the action attempt.
9453
+ */
9454
+ action_attempt_id: string
9455
+ status: 'pending'
9456
+ result: null
9457
+ error: null
9458
+ action_type: 'SET_HEAT_COOL'
9459
+ }
9460
+ | {
9461
+ /**
9462
+ ---
9463
+ title: Action Attempt ID
9464
+ ---
9465
+ The ID of the action attempt.
9466
+ */
9467
+ action_attempt_id: string
9468
+ status: 'success'
9469
+ error: null
9470
+ action_type: 'SET_HEAT_COOL'
9471
+ result: {}
9472
+ }
9473
+ | {
9474
+ /**
9475
+ ---
9476
+ title: Action Attempt ID
9477
+ ---
9478
+ The ID of the action attempt.
9479
+ */
9480
+ action_attempt_id: string
9481
+ status: 'error'
9482
+ result: null
9483
+ action_type: 'SET_HEAT_COOL'
9484
+ error: {
9485
+ type: string
9486
+ message: string
9487
+ }
9488
+ }
9489
+ | {
9490
+ /**
9491
+ ---
9492
+ title: Action Attempt ID
9493
+ ---
9494
+ The ID of the action attempt.
9495
+ */
9496
+ action_attempt_id: string
9497
+ status: 'pending'
9498
+ result: null
9499
+ error: null
9500
+ action_type: 'SET_FAN_MODE'
9501
+ }
9502
+ | {
9503
+ /**
9504
+ ---
9505
+ title: Action Attempt ID
9506
+ ---
9507
+ The ID of the action attempt.
9508
+ */
9509
+ action_attempt_id: string
9510
+ status: 'success'
9511
+ error: null
9512
+ action_type: 'SET_FAN_MODE'
9513
+ result: {}
9514
+ }
9515
+ | {
9516
+ /**
9517
+ ---
9518
+ title: Action Attempt ID
9519
+ ---
9520
+ The ID of the action attempt.
9521
+ */
9522
+ action_attempt_id: string
9523
+ status: 'error'
9524
+ result: null
9525
+ action_type: 'SET_FAN_MODE'
9526
+ error: {
9527
+ type: string
9528
+ message: string
9529
+ }
9530
+ }
9531
+ | {
9532
+ /**
9533
+ ---
9534
+ title: Action Attempt ID
9535
+ ---
9536
+ The ID of the action attempt.
9537
+ */
9538
+ action_attempt_id: string
9539
+ status: 'pending'
9540
+ result: null
9541
+ error: null
9542
+ action_type: 'SET_THERMOSTAT_OFF'
9543
+ }
9544
+ | {
9545
+ /**
9546
+ ---
9547
+ title: Action Attempt ID
9548
+ ---
9549
+ The ID of the action attempt.
9550
+ */
9551
+ action_attempt_id: string
9552
+ status: 'success'
9553
+ error: null
9554
+ action_type: 'SET_THERMOSTAT_OFF'
9555
+ result: {}
9556
+ }
9557
+ | {
9558
+ /**
9559
+ ---
9560
+ title: Action Attempt ID
9561
+ ---
9562
+ The ID of the action attempt.
9563
+ */
9564
+ action_attempt_id: string
9565
+ status: 'error'
9566
+ result: null
9567
+ action_type: 'SET_THERMOSTAT_OFF'
9568
+ error: {
9569
+ type: string
9570
+ message: string
9571
+ }
9572
+ }
9573
+ }
9574
+ }
9575
+ '/thermostats/get': {
9576
+ route: '/thermostats/get'
9577
+ method: 'GET' | 'POST'
9578
+ queryParams: {}
9579
+ jsonBody: {}
9580
+ commonParams: {
9581
+ device_id?: string | undefined
9582
+ name?: string | undefined
9583
+ }
9584
+ formData: {}
9585
+ jsonResponse: {
9586
+ thermostat: {
9587
+ /** Unique identifier for the device. */
9588
+ device_id: string
9589
+ /** Type of the device. */
9590
+ device_type:
9591
+ | (
9592
+ | 'akuvox_lock'
9593
+ | 'august_lock'
9594
+ | 'brivo_access_point'
9595
+ | 'butterflymx_panel'
9596
+ | 'avigilon_alta_entry'
9597
+ | 'doorking_lock'
9598
+ | 'genie_door'
9599
+ | 'igloo_lock'
9600
+ | 'linear_lock'
9601
+ | 'lockly_lock'
9602
+ | 'kwikset_lock'
9603
+ | 'nuki_lock'
9604
+ | 'salto_lock'
9605
+ | 'schlage_lock'
9606
+ | 'seam_relay'
9607
+ | 'smartthings_lock'
9608
+ | 'wyze_lock'
9609
+ | 'yale_lock'
9610
+ | 'two_n_intercom'
9611
+ | 'controlbyweb_device'
9612
+ | 'ttlock_lock'
9613
+ | 'igloohome_lock'
9614
+ | 'hubitat_lock'
9615
+ | 'four_suites_door'
9616
+ | 'dormakaba_oracode_door'
9617
+ | 'tedee_lock'
9618
+ )
9619
+ | ('noiseaware_activity_zone' | 'minut_sensor')
9620
+ | (
9621
+ | 'ecobee_thermostat'
9622
+ | 'nest_thermostat'
9623
+ | 'honeywell_resideo_thermostat'
9624
+ )
9625
+ | ('ios_phone' | 'android_phone')
9626
+ /** Optional nickname to describe the device, settable through Seam */
9627
+ nickname?: string | undefined
9628
+ /** 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. */
9629
+ display_name: string
9630
+ /** 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. */
9631
+ capabilities_supported: Array<
9632
+ | 'access_code'
9633
+ | 'lock'
9634
+ | 'noise_detection'
9635
+ | 'thermostat'
9636
+ | 'battery'
9637
+ | 'phone'
9638
+ >
9639
+ /** Properties of the device. */
9640
+ properties: (({
9641
+ /** Indicates whether the device is online. */
9642
+ online: boolean
9643
+ /**
9644
+ ---
9645
+ deprecated: use device.display_name instead
9646
+ ---
9647
+ Name of the device.
9648
+ */
9649
+ name: string
9650
+ /** Represents the accessory keypad state. */
9651
+ accessory_keypad?:
9652
+ | {
9653
+ /** Indicates if the accessory_keypad is connected to the device. */
9654
+ is_connected: boolean
9655
+ /** Indicates if the keypad battery properties. */
9656
+ battery?:
9657
+ | {
9658
+ level: number
9659
+ }
9660
+ | undefined
9661
+ }
9662
+ | undefined
9663
+ appearance: {
9664
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
9665
+ name: string
9666
+ }
9667
+ model: {
9668
+ /** Indicates whether the device can connect a accessory keypad. */
9669
+ can_connect_accessory_keypad?: boolean | undefined
9670
+ /** Display name of the device model. */
9671
+ display_name: string
9672
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
9673
+ manufacturer_display_name: string
9674
+ /** Indicates whether the device has a built in accessory keypad. */
9675
+ has_built_in_keypad?: boolean | undefined
9676
+ /** Indicates whether the device supports offline access codes. */
9677
+ offline_access_codes_supported?: boolean | undefined
9678
+ /** Indicates whether the device supports online access codes. */
9679
+ online_access_codes_supported?: boolean | undefined
9680
+ /**
9681
+ ---
9682
+ deprecated: use device.properties.model.can_connect_accessory_keypad
9683
+ ---
9684
+ */
9685
+ accessory_keypad_supported?: boolean | undefined
9686
+ }
9687
+ /** Indicates whether the device has direct power. */
9688
+ has_direct_power?: boolean | undefined
9689
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
9690
+ battery_level?: number | undefined
9691
+ /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
9692
+ battery?:
9693
+ | {
9694
+ level: number
9695
+ status: 'critical' | 'low' | 'good' | 'full'
9696
+ }
9697
+ | undefined
9698
+ /** Manufacturer of the device. */
9699
+ manufacturer?: string | undefined
9700
+ /** Image URL for the device. */
9701
+ image_url?: string | undefined
9702
+ /** Alt text for the device image. */
9703
+ image_alt_text?: string | undefined
9704
+ /** Serial number of the device. */
9705
+ serial_number?: string | undefined
9706
+ /** Indicates whether it is currently possible to use online access codes for the device. */
9707
+ online_access_codes_enabled?: boolean | undefined
9708
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
9709
+ offline_access_codes_enabled?: boolean | undefined
9710
+ /**
9711
+ ---
9712
+ deprecated: use device.properties.model.can_connect_accessory_keypad
9713
+ ---
9714
+ */
9715
+ supports_accessory_keypad?: boolean | undefined
9716
+ /**
9717
+ ---
9718
+ deprecated: use offline_access_codes_enabled
9719
+ ---
9720
+ */
9721
+ supports_offline_access_codes?: boolean | undefined
9722
+ /** Indicates current noise level in decibels, if the device supports noise detection. */
9723
+ noise_level_decibels?: number | undefined
9724
+ } & {
9725
+ assa_abloy_credential_service_metadata?:
9726
+ | (
9727
+ | {
9728
+ has_active_endpoint: boolean
9729
+ endpoints: Array<{
9730
+ endpoint_id: string
9731
+ is_active: boolean
9732
+ }>
9733
+ }
9734
+ | undefined
9735
+ )
9736
+ | undefined
9737
+ }) & {
9738
+ august_metadata?:
9739
+ | {
9740
+ lock_id: string
9741
+ lock_name: string
9742
+ house_name: string
9743
+ has_keypad: boolean
9744
+ keypad_battery_level?: string | undefined
9745
+ model?: string | undefined
9746
+ house_id?: string | undefined
9747
+ }
9748
+ | undefined
9749
+ avigilon_alta_metadata?:
9750
+ | {
9751
+ entry_name: string
9752
+ org_name: string
9753
+ zone_id: number
9754
+ zone_name: string
9755
+ site_id: number
9756
+ site_name: string
9757
+ entry_relays_total_count: number
9758
+ }
9759
+ | undefined
9760
+ schlage_metadata?:
9761
+ | {
9762
+ device_id: string
9763
+ device_name: string
9764
+ access_code_length: number | null
9765
+ model?: string | undefined
9766
+ }
9767
+ | undefined
9768
+ smartthings_metadata?:
9769
+ | {
9770
+ device_id: string
9771
+ device_name: string
9772
+ model?: string | undefined
9773
+ location_id?: string | undefined
9774
+ }
9775
+ | undefined
9776
+ lockly_metadata?:
9777
+ | {
9778
+ device_id: string
9779
+ device_name: string
9780
+ model?: string | undefined
9781
+ }
9782
+ | undefined
9783
+ nuki_metadata?:
9784
+ | {
9785
+ device_id: string
9786
+ device_name: string
9787
+ keypad_battery_critical?: boolean | undefined
9788
+ keypad_paired?: boolean | undefined
9789
+ keypad_2_paired?: boolean | undefined
9790
+ }
9791
+ | undefined
9792
+ kwikset_metadata?:
9793
+ | {
9794
+ device_id: string
9795
+ device_name: string
9796
+ model_number: string
9797
+ }
9798
+ | undefined
9799
+ salto_metadata?:
9800
+ | {
9801
+ lock_id: string
9802
+ customer_reference: string
9803
+ lock_type: string
9804
+ battery_level: string
9805
+ locked_state: string
9806
+ model?: string | undefined
9807
+ }
9808
+ | undefined
9809
+ genie_metadata?:
9810
+ | {
9811
+ device_name: string
9812
+ door_name: string
9813
+ }
9814
+ | undefined
9815
+ brivo_metadata?:
9816
+ | {
9817
+ device_name: string
9818
+ }
9819
+ | undefined
9820
+ igloo_metadata?:
9821
+ | {
9822
+ device_id: string
9823
+ bridge_id: string
9824
+ model?: string | undefined
9825
+ }
9826
+ | undefined
9827
+ noiseaware_metadata?:
9828
+ | {
9829
+ device_model: 'indoor' | 'outdoor'
9830
+ noise_level_nrs: number
9831
+ noise_level_decibel: number
9832
+ device_name: string
9833
+ device_id: string
9834
+ }
9835
+ | undefined
9836
+ minut_metadata?:
9837
+ | {
9838
+ device_id: string
9839
+ device_name: string
9840
+ latest_sensor_values: {
9841
+ temperature: {
9842
+ time: string
9843
+ value: number
9844
+ }
9845
+ sound: {
9846
+ time: string
9847
+ value: number
9848
+ }
9849
+ humidity: {
9850
+ time: string
9851
+ value: number
9852
+ }
9853
+ pressure: {
9854
+ time: string
9855
+ value: number
9856
+ }
9857
+ accelerometer_z: {
9858
+ time: string
9859
+ value: number
9860
+ }
9861
+ }
9862
+ }
9863
+ | undefined
9864
+ four_suites_metadata?:
9865
+ | {
9866
+ device_id: number
9867
+ device_name: string
9868
+ reclose_delay_in_seconds: number
9869
+ }
9870
+ | undefined
9871
+ two_n_metadata?:
9872
+ | {
9873
+ device_id: number
9874
+ device_name: string
9875
+ }
9876
+ | undefined
9877
+ controlbyweb_metadata?:
9878
+ | {
9879
+ device_id: string
9880
+ device_name: string
9881
+ relay_name: string | null
9882
+ }
9883
+ | undefined
9884
+ ttlock_metadata?:
9885
+ | {
9886
+ lock_id: number
9887
+ lock_alias: string
9888
+ feature_value: string
9889
+ }
9890
+ | undefined
9891
+ seam_bridge_metadata?:
9892
+ | {
9893
+ unlock_method?: ('bridge' | 'doorking') | undefined
9894
+ device_num: number
9895
+ name: string
9896
+ }
9897
+ | undefined
9898
+ igloohome_metadata?:
9899
+ | {
9900
+ device_id: string
9901
+ device_name: string
9902
+ bridge_id?: string | undefined
9903
+ bridge_name?: string | undefined
9904
+ keypad_id?: string | undefined
9905
+ }
9906
+ | undefined
9907
+ nest_metadata?:
9908
+ | {
9909
+ nest_device_id: string
9910
+ device_name: string
9911
+ custom_name: string
9912
+ }
9913
+ | undefined
9914
+ ecobee_metadata?:
9915
+ | {
9916
+ ecobee_device_id: string
9917
+ device_name: string
9918
+ }
9919
+ | undefined
9920
+ honeywell_resideo_metadata?:
9921
+ | {
9922
+ honeywell_resideo_device_id: string
9923
+ device_name: string
9924
+ }
9925
+ | undefined
9926
+ hubitat_metadata?:
9927
+ | {
9928
+ device_id: string
9929
+ device_name: string
9930
+ device_label: string
9931
+ }
9932
+ | undefined
9933
+ dormakaba_oracode_metadata?:
9934
+ | {
8963
9935
  door_id: number
8964
9936
  door_name: string
8965
9937
  device_id?: number | undefined
@@ -9352,14 +10324,368 @@ export interface Routes {
9352
10324
  }
9353
10325
  }
9354
10326
  }
9355
- '/thermostats/heat': {
9356
- route: '/thermostats/heat'
10327
+ '/thermostats/heat': {
10328
+ route: '/thermostats/heat'
10329
+ method: 'POST'
10330
+ queryParams: {}
10331
+ jsonBody: {
10332
+ device_id: string
10333
+ heating_set_point_celsius?: number | undefined
10334
+ heating_set_point_fahrenheit?: number | undefined
10335
+ sync?: boolean
10336
+ }
10337
+ commonParams: {}
10338
+ formData: {}
10339
+ jsonResponse: {
10340
+ action_attempt:
10341
+ | {
10342
+ /**
10343
+ ---
10344
+ title: Action Attempt ID
10345
+ ---
10346
+ The ID of the action attempt.
10347
+ */
10348
+ action_attempt_id: string
10349
+ status: 'pending'
10350
+ result: null
10351
+ error: null
10352
+ action_type: 'LOCK_DOOR'
10353
+ }
10354
+ | {
10355
+ /**
10356
+ ---
10357
+ title: Action Attempt ID
10358
+ ---
10359
+ The ID of the action attempt.
10360
+ */
10361
+ action_attempt_id: string
10362
+ status: 'success'
10363
+ error: null
10364
+ action_type: 'LOCK_DOOR'
10365
+ result: {}
10366
+ }
10367
+ | {
10368
+ /**
10369
+ ---
10370
+ title: Action Attempt ID
10371
+ ---
10372
+ The ID of the action attempt.
10373
+ */
10374
+ action_attempt_id: string
10375
+ status: 'error'
10376
+ result: null
10377
+ action_type: 'LOCK_DOOR'
10378
+ error: {
10379
+ type: string
10380
+ message: string
10381
+ }
10382
+ }
10383
+ | {
10384
+ /**
10385
+ ---
10386
+ title: Action Attempt ID
10387
+ ---
10388
+ The ID of the action attempt.
10389
+ */
10390
+ action_attempt_id: string
10391
+ status: 'pending'
10392
+ result: null
10393
+ error: null
10394
+ action_type: 'UNLOCK_DOOR'
10395
+ }
10396
+ | {
10397
+ /**
10398
+ ---
10399
+ title: Action Attempt ID
10400
+ ---
10401
+ The ID of the action attempt.
10402
+ */
10403
+ action_attempt_id: string
10404
+ status: 'success'
10405
+ error: null
10406
+ action_type: 'UNLOCK_DOOR'
10407
+ result: {}
10408
+ }
10409
+ | {
10410
+ /**
10411
+ ---
10412
+ title: Action Attempt ID
10413
+ ---
10414
+ The ID of the action attempt.
10415
+ */
10416
+ action_attempt_id: string
10417
+ status: 'error'
10418
+ result: null
10419
+ action_type: 'UNLOCK_DOOR'
10420
+ error: {
10421
+ type: string
10422
+ message: string
10423
+ }
10424
+ }
10425
+ | {
10426
+ /**
10427
+ ---
10428
+ title: Action Attempt ID
10429
+ ---
10430
+ The ID of the action attempt.
10431
+ */
10432
+ action_attempt_id: string
10433
+ status: 'pending'
10434
+ result: null
10435
+ error: null
10436
+ action_type: 'RESET_SANDBOX_WORKSPACE'
10437
+ }
10438
+ | {
10439
+ /**
10440
+ ---
10441
+ title: Action Attempt ID
10442
+ ---
10443
+ The ID of the action attempt.
10444
+ */
10445
+ action_attempt_id: string
10446
+ status: 'success'
10447
+ error: null
10448
+ action_type: 'RESET_SANDBOX_WORKSPACE'
10449
+ result: {}
10450
+ }
10451
+ | {
10452
+ /**
10453
+ ---
10454
+ title: Action Attempt ID
10455
+ ---
10456
+ The ID of the action attempt.
10457
+ */
10458
+ action_attempt_id: string
10459
+ status: 'error'
10460
+ result: null
10461
+ action_type: 'RESET_SANDBOX_WORKSPACE'
10462
+ error: {
10463
+ type: string
10464
+ message: string
10465
+ }
10466
+ }
10467
+ | {
10468
+ /**
10469
+ ---
10470
+ title: Action Attempt ID
10471
+ ---
10472
+ The ID of the action attempt.
10473
+ */
10474
+ action_attempt_id: string
10475
+ status: 'pending'
10476
+ result: null
10477
+ error: null
10478
+ action_type: 'SET_COOL'
10479
+ }
10480
+ | {
10481
+ /**
10482
+ ---
10483
+ title: Action Attempt ID
10484
+ ---
10485
+ The ID of the action attempt.
10486
+ */
10487
+ action_attempt_id: string
10488
+ status: 'success'
10489
+ error: null
10490
+ action_type: 'SET_COOL'
10491
+ result: {}
10492
+ }
10493
+ | {
10494
+ /**
10495
+ ---
10496
+ title: Action Attempt ID
10497
+ ---
10498
+ The ID of the action attempt.
10499
+ */
10500
+ action_attempt_id: string
10501
+ status: 'error'
10502
+ result: null
10503
+ action_type: 'SET_COOL'
10504
+ error: {
10505
+ type: string
10506
+ message: string
10507
+ }
10508
+ }
10509
+ | {
10510
+ /**
10511
+ ---
10512
+ title: Action Attempt ID
10513
+ ---
10514
+ The ID of the action attempt.
10515
+ */
10516
+ action_attempt_id: string
10517
+ status: 'pending'
10518
+ result: null
10519
+ error: null
10520
+ action_type: 'SET_HEAT'
10521
+ }
10522
+ | {
10523
+ /**
10524
+ ---
10525
+ title: Action Attempt ID
10526
+ ---
10527
+ The ID of the action attempt.
10528
+ */
10529
+ action_attempt_id: string
10530
+ status: 'success'
10531
+ error: null
10532
+ action_type: 'SET_HEAT'
10533
+ result: {}
10534
+ }
10535
+ | {
10536
+ /**
10537
+ ---
10538
+ title: Action Attempt ID
10539
+ ---
10540
+ The ID of the action attempt.
10541
+ */
10542
+ action_attempt_id: string
10543
+ status: 'error'
10544
+ result: null
10545
+ action_type: 'SET_HEAT'
10546
+ error: {
10547
+ type: string
10548
+ message: string
10549
+ }
10550
+ }
10551
+ | {
10552
+ /**
10553
+ ---
10554
+ title: Action Attempt ID
10555
+ ---
10556
+ The ID of the action attempt.
10557
+ */
10558
+ action_attempt_id: string
10559
+ status: 'pending'
10560
+ result: null
10561
+ error: null
10562
+ action_type: 'SET_HEAT_COOL'
10563
+ }
10564
+ | {
10565
+ /**
10566
+ ---
10567
+ title: Action Attempt ID
10568
+ ---
10569
+ The ID of the action attempt.
10570
+ */
10571
+ action_attempt_id: string
10572
+ status: 'success'
10573
+ error: null
10574
+ action_type: 'SET_HEAT_COOL'
10575
+ result: {}
10576
+ }
10577
+ | {
10578
+ /**
10579
+ ---
10580
+ title: Action Attempt ID
10581
+ ---
10582
+ The ID of the action attempt.
10583
+ */
10584
+ action_attempt_id: string
10585
+ status: 'error'
10586
+ result: null
10587
+ action_type: 'SET_HEAT_COOL'
10588
+ error: {
10589
+ type: string
10590
+ message: string
10591
+ }
10592
+ }
10593
+ | {
10594
+ /**
10595
+ ---
10596
+ title: Action Attempt ID
10597
+ ---
10598
+ The ID of the action attempt.
10599
+ */
10600
+ action_attempt_id: string
10601
+ status: 'pending'
10602
+ result: null
10603
+ error: null
10604
+ action_type: 'SET_FAN_MODE'
10605
+ }
10606
+ | {
10607
+ /**
10608
+ ---
10609
+ title: Action Attempt ID
10610
+ ---
10611
+ The ID of the action attempt.
10612
+ */
10613
+ action_attempt_id: string
10614
+ status: 'success'
10615
+ error: null
10616
+ action_type: 'SET_FAN_MODE'
10617
+ result: {}
10618
+ }
10619
+ | {
10620
+ /**
10621
+ ---
10622
+ title: Action Attempt ID
10623
+ ---
10624
+ The ID of the action attempt.
10625
+ */
10626
+ action_attempt_id: string
10627
+ status: 'error'
10628
+ result: null
10629
+ action_type: 'SET_FAN_MODE'
10630
+ error: {
10631
+ type: string
10632
+ message: string
10633
+ }
10634
+ }
10635
+ | {
10636
+ /**
10637
+ ---
10638
+ title: Action Attempt ID
10639
+ ---
10640
+ The ID of the action attempt.
10641
+ */
10642
+ action_attempt_id: string
10643
+ status: 'pending'
10644
+ result: null
10645
+ error: null
10646
+ action_type: 'SET_THERMOSTAT_OFF'
10647
+ }
10648
+ | {
10649
+ /**
10650
+ ---
10651
+ title: Action Attempt ID
10652
+ ---
10653
+ The ID of the action attempt.
10654
+ */
10655
+ action_attempt_id: string
10656
+ status: 'success'
10657
+ error: null
10658
+ action_type: 'SET_THERMOSTAT_OFF'
10659
+ result: {}
10660
+ }
10661
+ | {
10662
+ /**
10663
+ ---
10664
+ title: Action Attempt ID
10665
+ ---
10666
+ The ID of the action attempt.
10667
+ */
10668
+ action_attempt_id: string
10669
+ status: 'error'
10670
+ result: null
10671
+ action_type: 'SET_THERMOSTAT_OFF'
10672
+ error: {
10673
+ type: string
10674
+ message: string
10675
+ }
10676
+ }
10677
+ }
10678
+ }
10679
+ '/thermostats/heat_cool': {
10680
+ route: '/thermostats/heat_cool'
9357
10681
  method: 'POST'
9358
10682
  queryParams: {}
9359
10683
  jsonBody: {
9360
10684
  device_id: string
9361
10685
  heating_set_point_celsius?: number | undefined
9362
10686
  heating_set_point_fahrenheit?: number | undefined
10687
+ cooling_set_point_celsius?: number | undefined
10688
+ cooling_set_point_fahrenheit?: number | undefined
9363
10689
  sync?: boolean
9364
10690
  }
9365
10691
  commonParams: {}
@@ -9367,66 +10693,336 @@ export interface Routes {
9367
10693
  jsonResponse: {
9368
10694
  action_attempt:
9369
10695
  | {
9370
- status: 'success'
9371
- action_type: string
10696
+ /**
10697
+ ---
10698
+ title: Action Attempt ID
10699
+ ---
10700
+ The ID of the action attempt.
10701
+ */
9372
10702
  action_attempt_id: string
9373
- result?: any
10703
+ status: 'pending'
10704
+ result: null
9374
10705
  error: null
10706
+ action_type: 'LOCK_DOOR'
9375
10707
  }
9376
10708
  | {
9377
- status: 'pending'
9378
- action_type: string
10709
+ /**
10710
+ ---
10711
+ title: Action Attempt ID
10712
+ ---
10713
+ The ID of the action attempt.
10714
+ */
10715
+ action_attempt_id: string
10716
+ status: 'success'
10717
+ error: null
10718
+ action_type: 'LOCK_DOOR'
10719
+ result: {}
10720
+ }
10721
+ | {
10722
+ /**
10723
+ ---
10724
+ title: Action Attempt ID
10725
+ ---
10726
+ The ID of the action attempt.
10727
+ */
10728
+ action_attempt_id: string
10729
+ status: 'error'
10730
+ result: null
10731
+ action_type: 'LOCK_DOOR'
10732
+ error: {
10733
+ type: string
10734
+ message: string
10735
+ }
10736
+ }
10737
+ | {
10738
+ /**
10739
+ ---
10740
+ title: Action Attempt ID
10741
+ ---
10742
+ The ID of the action attempt.
10743
+ */
9379
10744
  action_attempt_id: string
10745
+ status: 'pending'
9380
10746
  result: null
9381
10747
  error: null
10748
+ action_type: 'UNLOCK_DOOR'
10749
+ }
10750
+ | {
10751
+ /**
10752
+ ---
10753
+ title: Action Attempt ID
10754
+ ---
10755
+ The ID of the action attempt.
10756
+ */
10757
+ action_attempt_id: string
10758
+ status: 'success'
10759
+ error: null
10760
+ action_type: 'UNLOCK_DOOR'
10761
+ result: {}
9382
10762
  }
9383
10763
  | {
10764
+ /**
10765
+ ---
10766
+ title: Action Attempt ID
10767
+ ---
10768
+ The ID of the action attempt.
10769
+ */
10770
+ action_attempt_id: string
9384
10771
  status: 'error'
9385
- action_type: string
10772
+ result: null
10773
+ action_type: 'UNLOCK_DOOR'
10774
+ error: {
10775
+ type: string
10776
+ message: string
10777
+ }
10778
+ }
10779
+ | {
10780
+ /**
10781
+ ---
10782
+ title: Action Attempt ID
10783
+ ---
10784
+ The ID of the action attempt.
10785
+ */
10786
+ action_attempt_id: string
10787
+ status: 'pending'
10788
+ result: null
10789
+ error: null
10790
+ action_type: 'RESET_SANDBOX_WORKSPACE'
10791
+ }
10792
+ | {
10793
+ /**
10794
+ ---
10795
+ title: Action Attempt ID
10796
+ ---
10797
+ The ID of the action attempt.
10798
+ */
10799
+ action_attempt_id: string
10800
+ status: 'success'
10801
+ error: null
10802
+ action_type: 'RESET_SANDBOX_WORKSPACE'
10803
+ result: {}
10804
+ }
10805
+ | {
10806
+ /**
10807
+ ---
10808
+ title: Action Attempt ID
10809
+ ---
10810
+ The ID of the action attempt.
10811
+ */
9386
10812
  action_attempt_id: string
10813
+ status: 'error'
9387
10814
  result: null
10815
+ action_type: 'RESET_SANDBOX_WORKSPACE'
9388
10816
  error: {
9389
10817
  type: string
9390
10818
  message: string
9391
10819
  }
9392
10820
  }
9393
- }
9394
- }
9395
- '/thermostats/heat_cool': {
9396
- route: '/thermostats/heat_cool'
9397
- method: 'POST'
9398
- queryParams: {}
9399
- jsonBody: {
9400
- device_id: string
9401
- heating_set_point_celsius?: number | undefined
9402
- heating_set_point_fahrenheit?: number | undefined
9403
- cooling_set_point_celsius?: number | undefined
9404
- cooling_set_point_fahrenheit?: number | undefined
9405
- sync?: boolean
9406
- }
9407
- commonParams: {}
9408
- formData: {}
9409
- jsonResponse: {
9410
- action_attempt:
9411
10821
  | {
10822
+ /**
10823
+ ---
10824
+ title: Action Attempt ID
10825
+ ---
10826
+ The ID of the action attempt.
10827
+ */
10828
+ action_attempt_id: string
10829
+ status: 'pending'
10830
+ result: null
10831
+ error: null
10832
+ action_type: 'SET_COOL'
10833
+ }
10834
+ | {
10835
+ /**
10836
+ ---
10837
+ title: Action Attempt ID
10838
+ ---
10839
+ The ID of the action attempt.
10840
+ */
10841
+ action_attempt_id: string
9412
10842
  status: 'success'
9413
- action_type: string
10843
+ error: null
10844
+ action_type: 'SET_COOL'
10845
+ result: {}
10846
+ }
10847
+ | {
10848
+ /**
10849
+ ---
10850
+ title: Action Attempt ID
10851
+ ---
10852
+ The ID of the action attempt.
10853
+ */
9414
10854
  action_attempt_id: string
9415
- result?: any
10855
+ status: 'error'
10856
+ result: null
10857
+ action_type: 'SET_COOL'
10858
+ error: {
10859
+ type: string
10860
+ message: string
10861
+ }
10862
+ }
10863
+ | {
10864
+ /**
10865
+ ---
10866
+ title: Action Attempt ID
10867
+ ---
10868
+ The ID of the action attempt.
10869
+ */
10870
+ action_attempt_id: string
10871
+ status: 'pending'
10872
+ result: null
10873
+ error: null
10874
+ action_type: 'SET_HEAT'
10875
+ }
10876
+ | {
10877
+ /**
10878
+ ---
10879
+ title: Action Attempt ID
10880
+ ---
10881
+ The ID of the action attempt.
10882
+ */
10883
+ action_attempt_id: string
10884
+ status: 'success'
9416
10885
  error: null
10886
+ action_type: 'SET_HEAT'
10887
+ result: {}
10888
+ }
10889
+ | {
10890
+ /**
10891
+ ---
10892
+ title: Action Attempt ID
10893
+ ---
10894
+ The ID of the action attempt.
10895
+ */
10896
+ action_attempt_id: string
10897
+ status: 'error'
10898
+ result: null
10899
+ action_type: 'SET_HEAT'
10900
+ error: {
10901
+ type: string
10902
+ message: string
10903
+ }
9417
10904
  }
9418
10905
  | {
10906
+ /**
10907
+ ---
10908
+ title: Action Attempt ID
10909
+ ---
10910
+ The ID of the action attempt.
10911
+ */
10912
+ action_attempt_id: string
9419
10913
  status: 'pending'
9420
- action_type: string
10914
+ result: null
10915
+ error: null
10916
+ action_type: 'SET_HEAT_COOL'
10917
+ }
10918
+ | {
10919
+ /**
10920
+ ---
10921
+ title: Action Attempt ID
10922
+ ---
10923
+ The ID of the action attempt.
10924
+ */
10925
+ action_attempt_id: string
10926
+ status: 'success'
10927
+ error: null
10928
+ action_type: 'SET_HEAT_COOL'
10929
+ result: {}
10930
+ }
10931
+ | {
10932
+ /**
10933
+ ---
10934
+ title: Action Attempt ID
10935
+ ---
10936
+ The ID of the action attempt.
10937
+ */
10938
+ action_attempt_id: string
10939
+ status: 'error'
10940
+ result: null
10941
+ action_type: 'SET_HEAT_COOL'
10942
+ error: {
10943
+ type: string
10944
+ message: string
10945
+ }
10946
+ }
10947
+ | {
10948
+ /**
10949
+ ---
10950
+ title: Action Attempt ID
10951
+ ---
10952
+ The ID of the action attempt.
10953
+ */
9421
10954
  action_attempt_id: string
10955
+ status: 'pending'
9422
10956
  result: null
9423
10957
  error: null
10958
+ action_type: 'SET_FAN_MODE'
10959
+ }
10960
+ | {
10961
+ /**
10962
+ ---
10963
+ title: Action Attempt ID
10964
+ ---
10965
+ The ID of the action attempt.
10966
+ */
10967
+ action_attempt_id: string
10968
+ status: 'success'
10969
+ error: null
10970
+ action_type: 'SET_FAN_MODE'
10971
+ result: {}
9424
10972
  }
9425
10973
  | {
10974
+ /**
10975
+ ---
10976
+ title: Action Attempt ID
10977
+ ---
10978
+ The ID of the action attempt.
10979
+ */
10980
+ action_attempt_id: string
9426
10981
  status: 'error'
9427
- action_type: string
10982
+ result: null
10983
+ action_type: 'SET_FAN_MODE'
10984
+ error: {
10985
+ type: string
10986
+ message: string
10987
+ }
10988
+ }
10989
+ | {
10990
+ /**
10991
+ ---
10992
+ title: Action Attempt ID
10993
+ ---
10994
+ The ID of the action attempt.
10995
+ */
10996
+ action_attempt_id: string
10997
+ status: 'pending'
10998
+ result: null
10999
+ error: null
11000
+ action_type: 'SET_THERMOSTAT_OFF'
11001
+ }
11002
+ | {
11003
+ /**
11004
+ ---
11005
+ title: Action Attempt ID
11006
+ ---
11007
+ The ID of the action attempt.
11008
+ */
11009
+ action_attempt_id: string
11010
+ status: 'success'
11011
+ error: null
11012
+ action_type: 'SET_THERMOSTAT_OFF'
11013
+ result: {}
11014
+ }
11015
+ | {
11016
+ /**
11017
+ ---
11018
+ title: Action Attempt ID
11019
+ ---
11020
+ The ID of the action attempt.
11021
+ */
9428
11022
  action_attempt_id: string
11023
+ status: 'error'
9429
11024
  result: null
11025
+ action_type: 'SET_THERMOSTAT_OFF'
9430
11026
  error: {
9431
11027
  type: string
9432
11028
  message: string
@@ -9680,7 +11276,11 @@ export interface Routes {
9680
11276
  offline_access_codes_supported?: boolean | undefined
9681
11277
  /** Indicates whether the device supports online access codes. */
9682
11278
  online_access_codes_supported?: boolean | undefined
9683
- /** Indicates whether the device supports an accessory keypad. */
11279
+ /**
11280
+ ---
11281
+ deprecated: use device.properties.model.can_connect_accessory_keypad
11282
+ ---
11283
+ */
9684
11284
  accessory_keypad_supported?: boolean | undefined
9685
11285
  }
9686
11286
  /** Indicates whether the device has direct power. */
@@ -9708,7 +11308,7 @@ export interface Routes {
9708
11308
  offline_access_codes_enabled?: boolean | undefined
9709
11309
  /**
9710
11310
  ---
9711
- deprecated: use model.accessory_keypad_supported
11311
+ deprecated: use device.properties.model.can_connect_accessory_keypad
9712
11312
  ---
9713
11313
  */
9714
11314
  supports_accessory_keypad?: boolean | undefined
@@ -10323,12 +11923,364 @@ export interface Routes {
10323
11923
  }>
10324
11924
  }
10325
11925
  }
10326
- '/thermostats/off': {
10327
- route: '/thermostats/off'
11926
+ '/thermostats/off': {
11927
+ route: '/thermostats/off'
11928
+ method: 'POST'
11929
+ queryParams: {}
11930
+ jsonBody: {
11931
+ device_id: string
11932
+ sync?: boolean
11933
+ }
11934
+ commonParams: {}
11935
+ formData: {}
11936
+ jsonResponse: {
11937
+ action_attempt:
11938
+ | {
11939
+ /**
11940
+ ---
11941
+ title: Action Attempt ID
11942
+ ---
11943
+ The ID of the action attempt.
11944
+ */
11945
+ action_attempt_id: string
11946
+ status: 'pending'
11947
+ result: null
11948
+ error: null
11949
+ action_type: 'LOCK_DOOR'
11950
+ }
11951
+ | {
11952
+ /**
11953
+ ---
11954
+ title: Action Attempt ID
11955
+ ---
11956
+ The ID of the action attempt.
11957
+ */
11958
+ action_attempt_id: string
11959
+ status: 'success'
11960
+ error: null
11961
+ action_type: 'LOCK_DOOR'
11962
+ result: {}
11963
+ }
11964
+ | {
11965
+ /**
11966
+ ---
11967
+ title: Action Attempt ID
11968
+ ---
11969
+ The ID of the action attempt.
11970
+ */
11971
+ action_attempt_id: string
11972
+ status: 'error'
11973
+ result: null
11974
+ action_type: 'LOCK_DOOR'
11975
+ error: {
11976
+ type: string
11977
+ message: string
11978
+ }
11979
+ }
11980
+ | {
11981
+ /**
11982
+ ---
11983
+ title: Action Attempt ID
11984
+ ---
11985
+ The ID of the action attempt.
11986
+ */
11987
+ action_attempt_id: string
11988
+ status: 'pending'
11989
+ result: null
11990
+ error: null
11991
+ action_type: 'UNLOCK_DOOR'
11992
+ }
11993
+ | {
11994
+ /**
11995
+ ---
11996
+ title: Action Attempt ID
11997
+ ---
11998
+ The ID of the action attempt.
11999
+ */
12000
+ action_attempt_id: string
12001
+ status: 'success'
12002
+ error: null
12003
+ action_type: 'UNLOCK_DOOR'
12004
+ result: {}
12005
+ }
12006
+ | {
12007
+ /**
12008
+ ---
12009
+ title: Action Attempt ID
12010
+ ---
12011
+ The ID of the action attempt.
12012
+ */
12013
+ action_attempt_id: string
12014
+ status: 'error'
12015
+ result: null
12016
+ action_type: 'UNLOCK_DOOR'
12017
+ error: {
12018
+ type: string
12019
+ message: string
12020
+ }
12021
+ }
12022
+ | {
12023
+ /**
12024
+ ---
12025
+ title: Action Attempt ID
12026
+ ---
12027
+ The ID of the action attempt.
12028
+ */
12029
+ action_attempt_id: string
12030
+ status: 'pending'
12031
+ result: null
12032
+ error: null
12033
+ action_type: 'RESET_SANDBOX_WORKSPACE'
12034
+ }
12035
+ | {
12036
+ /**
12037
+ ---
12038
+ title: Action Attempt ID
12039
+ ---
12040
+ The ID of the action attempt.
12041
+ */
12042
+ action_attempt_id: string
12043
+ status: 'success'
12044
+ error: null
12045
+ action_type: 'RESET_SANDBOX_WORKSPACE'
12046
+ result: {}
12047
+ }
12048
+ | {
12049
+ /**
12050
+ ---
12051
+ title: Action Attempt ID
12052
+ ---
12053
+ The ID of the action attempt.
12054
+ */
12055
+ action_attempt_id: string
12056
+ status: 'error'
12057
+ result: null
12058
+ action_type: 'RESET_SANDBOX_WORKSPACE'
12059
+ error: {
12060
+ type: string
12061
+ message: string
12062
+ }
12063
+ }
12064
+ | {
12065
+ /**
12066
+ ---
12067
+ title: Action Attempt ID
12068
+ ---
12069
+ The ID of the action attempt.
12070
+ */
12071
+ action_attempt_id: string
12072
+ status: 'pending'
12073
+ result: null
12074
+ error: null
12075
+ action_type: 'SET_COOL'
12076
+ }
12077
+ | {
12078
+ /**
12079
+ ---
12080
+ title: Action Attempt ID
12081
+ ---
12082
+ The ID of the action attempt.
12083
+ */
12084
+ action_attempt_id: string
12085
+ status: 'success'
12086
+ error: null
12087
+ action_type: 'SET_COOL'
12088
+ result: {}
12089
+ }
12090
+ | {
12091
+ /**
12092
+ ---
12093
+ title: Action Attempt ID
12094
+ ---
12095
+ The ID of the action attempt.
12096
+ */
12097
+ action_attempt_id: string
12098
+ status: 'error'
12099
+ result: null
12100
+ action_type: 'SET_COOL'
12101
+ error: {
12102
+ type: string
12103
+ message: string
12104
+ }
12105
+ }
12106
+ | {
12107
+ /**
12108
+ ---
12109
+ title: Action Attempt ID
12110
+ ---
12111
+ The ID of the action attempt.
12112
+ */
12113
+ action_attempt_id: string
12114
+ status: 'pending'
12115
+ result: null
12116
+ error: null
12117
+ action_type: 'SET_HEAT'
12118
+ }
12119
+ | {
12120
+ /**
12121
+ ---
12122
+ title: Action Attempt ID
12123
+ ---
12124
+ The ID of the action attempt.
12125
+ */
12126
+ action_attempt_id: string
12127
+ status: 'success'
12128
+ error: null
12129
+ action_type: 'SET_HEAT'
12130
+ result: {}
12131
+ }
12132
+ | {
12133
+ /**
12134
+ ---
12135
+ title: Action Attempt ID
12136
+ ---
12137
+ The ID of the action attempt.
12138
+ */
12139
+ action_attempt_id: string
12140
+ status: 'error'
12141
+ result: null
12142
+ action_type: 'SET_HEAT'
12143
+ error: {
12144
+ type: string
12145
+ message: string
12146
+ }
12147
+ }
12148
+ | {
12149
+ /**
12150
+ ---
12151
+ title: Action Attempt ID
12152
+ ---
12153
+ The ID of the action attempt.
12154
+ */
12155
+ action_attempt_id: string
12156
+ status: 'pending'
12157
+ result: null
12158
+ error: null
12159
+ action_type: 'SET_HEAT_COOL'
12160
+ }
12161
+ | {
12162
+ /**
12163
+ ---
12164
+ title: Action Attempt ID
12165
+ ---
12166
+ The ID of the action attempt.
12167
+ */
12168
+ action_attempt_id: string
12169
+ status: 'success'
12170
+ error: null
12171
+ action_type: 'SET_HEAT_COOL'
12172
+ result: {}
12173
+ }
12174
+ | {
12175
+ /**
12176
+ ---
12177
+ title: Action Attempt ID
12178
+ ---
12179
+ The ID of the action attempt.
12180
+ */
12181
+ action_attempt_id: string
12182
+ status: 'error'
12183
+ result: null
12184
+ action_type: 'SET_HEAT_COOL'
12185
+ error: {
12186
+ type: string
12187
+ message: string
12188
+ }
12189
+ }
12190
+ | {
12191
+ /**
12192
+ ---
12193
+ title: Action Attempt ID
12194
+ ---
12195
+ The ID of the action attempt.
12196
+ */
12197
+ action_attempt_id: string
12198
+ status: 'pending'
12199
+ result: null
12200
+ error: null
12201
+ action_type: 'SET_FAN_MODE'
12202
+ }
12203
+ | {
12204
+ /**
12205
+ ---
12206
+ title: Action Attempt ID
12207
+ ---
12208
+ The ID of the action attempt.
12209
+ */
12210
+ action_attempt_id: string
12211
+ status: 'success'
12212
+ error: null
12213
+ action_type: 'SET_FAN_MODE'
12214
+ result: {}
12215
+ }
12216
+ | {
12217
+ /**
12218
+ ---
12219
+ title: Action Attempt ID
12220
+ ---
12221
+ The ID of the action attempt.
12222
+ */
12223
+ action_attempt_id: string
12224
+ status: 'error'
12225
+ result: null
12226
+ action_type: 'SET_FAN_MODE'
12227
+ error: {
12228
+ type: string
12229
+ message: string
12230
+ }
12231
+ }
12232
+ | {
12233
+ /**
12234
+ ---
12235
+ title: Action Attempt ID
12236
+ ---
12237
+ The ID of the action attempt.
12238
+ */
12239
+ action_attempt_id: string
12240
+ status: 'pending'
12241
+ result: null
12242
+ error: null
12243
+ action_type: 'SET_THERMOSTAT_OFF'
12244
+ }
12245
+ | {
12246
+ /**
12247
+ ---
12248
+ title: Action Attempt ID
12249
+ ---
12250
+ The ID of the action attempt.
12251
+ */
12252
+ action_attempt_id: string
12253
+ status: 'success'
12254
+ error: null
12255
+ action_type: 'SET_THERMOSTAT_OFF'
12256
+ result: {}
12257
+ }
12258
+ | {
12259
+ /**
12260
+ ---
12261
+ title: Action Attempt ID
12262
+ ---
12263
+ The ID of the action attempt.
12264
+ */
12265
+ action_attempt_id: string
12266
+ status: 'error'
12267
+ result: null
12268
+ action_type: 'SET_THERMOSTAT_OFF'
12269
+ error: {
12270
+ type: string
12271
+ message: string
12272
+ }
12273
+ }
12274
+ }
12275
+ }
12276
+ '/thermostats/set_fan_mode': {
12277
+ route: '/thermostats/set_fan_mode'
10328
12278
  method: 'POST'
10329
12279
  queryParams: {}
10330
12280
  jsonBody: {
10331
12281
  device_id: string
12282
+ fan_mode?: ('auto' | 'on') | undefined
12283
+ fan_mode_setting?: ('auto' | 'on') | undefined
10332
12284
  sync?: boolean
10333
12285
  }
10334
12286
  commonParams: {}
@@ -10336,64 +12288,336 @@ export interface Routes {
10336
12288
  jsonResponse: {
10337
12289
  action_attempt:
10338
12290
  | {
12291
+ /**
12292
+ ---
12293
+ title: Action Attempt ID
12294
+ ---
12295
+ The ID of the action attempt.
12296
+ */
12297
+ action_attempt_id: string
12298
+ status: 'pending'
12299
+ result: null
12300
+ error: null
12301
+ action_type: 'LOCK_DOOR'
12302
+ }
12303
+ | {
12304
+ /**
12305
+ ---
12306
+ title: Action Attempt ID
12307
+ ---
12308
+ The ID of the action attempt.
12309
+ */
12310
+ action_attempt_id: string
10339
12311
  status: 'success'
10340
- action_type: string
12312
+ error: null
12313
+ action_type: 'LOCK_DOOR'
12314
+ result: {}
12315
+ }
12316
+ | {
12317
+ /**
12318
+ ---
12319
+ title: Action Attempt ID
12320
+ ---
12321
+ The ID of the action attempt.
12322
+ */
10341
12323
  action_attempt_id: string
10342
- result?: any
12324
+ status: 'error'
12325
+ result: null
12326
+ action_type: 'LOCK_DOOR'
12327
+ error: {
12328
+ type: string
12329
+ message: string
12330
+ }
12331
+ }
12332
+ | {
12333
+ /**
12334
+ ---
12335
+ title: Action Attempt ID
12336
+ ---
12337
+ The ID of the action attempt.
12338
+ */
12339
+ action_attempt_id: string
12340
+ status: 'pending'
12341
+ result: null
12342
+ error: null
12343
+ action_type: 'UNLOCK_DOOR'
12344
+ }
12345
+ | {
12346
+ /**
12347
+ ---
12348
+ title: Action Attempt ID
12349
+ ---
12350
+ The ID of the action attempt.
12351
+ */
12352
+ action_attempt_id: string
12353
+ status: 'success'
10343
12354
  error: null
12355
+ action_type: 'UNLOCK_DOOR'
12356
+ result: {}
12357
+ }
12358
+ | {
12359
+ /**
12360
+ ---
12361
+ title: Action Attempt ID
12362
+ ---
12363
+ The ID of the action attempt.
12364
+ */
12365
+ action_attempt_id: string
12366
+ status: 'error'
12367
+ result: null
12368
+ action_type: 'UNLOCK_DOOR'
12369
+ error: {
12370
+ type: string
12371
+ message: string
12372
+ }
10344
12373
  }
10345
12374
  | {
12375
+ /**
12376
+ ---
12377
+ title: Action Attempt ID
12378
+ ---
12379
+ The ID of the action attempt.
12380
+ */
12381
+ action_attempt_id: string
10346
12382
  status: 'pending'
10347
- action_type: string
12383
+ result: null
12384
+ error: null
12385
+ action_type: 'RESET_SANDBOX_WORKSPACE'
12386
+ }
12387
+ | {
12388
+ /**
12389
+ ---
12390
+ title: Action Attempt ID
12391
+ ---
12392
+ The ID of the action attempt.
12393
+ */
12394
+ action_attempt_id: string
12395
+ status: 'success'
12396
+ error: null
12397
+ action_type: 'RESET_SANDBOX_WORKSPACE'
12398
+ result: {}
12399
+ }
12400
+ | {
12401
+ /**
12402
+ ---
12403
+ title: Action Attempt ID
12404
+ ---
12405
+ The ID of the action attempt.
12406
+ */
12407
+ action_attempt_id: string
12408
+ status: 'error'
12409
+ result: null
12410
+ action_type: 'RESET_SANDBOX_WORKSPACE'
12411
+ error: {
12412
+ type: string
12413
+ message: string
12414
+ }
12415
+ }
12416
+ | {
12417
+ /**
12418
+ ---
12419
+ title: Action Attempt ID
12420
+ ---
12421
+ The ID of the action attempt.
12422
+ */
12423
+ action_attempt_id: string
12424
+ status: 'pending'
12425
+ result: null
12426
+ error: null
12427
+ action_type: 'SET_COOL'
12428
+ }
12429
+ | {
12430
+ /**
12431
+ ---
12432
+ title: Action Attempt ID
12433
+ ---
12434
+ The ID of the action attempt.
12435
+ */
12436
+ action_attempt_id: string
12437
+ status: 'success'
12438
+ error: null
12439
+ action_type: 'SET_COOL'
12440
+ result: {}
12441
+ }
12442
+ | {
12443
+ /**
12444
+ ---
12445
+ title: Action Attempt ID
12446
+ ---
12447
+ The ID of the action attempt.
12448
+ */
12449
+ action_attempt_id: string
12450
+ status: 'error'
12451
+ result: null
12452
+ action_type: 'SET_COOL'
12453
+ error: {
12454
+ type: string
12455
+ message: string
12456
+ }
12457
+ }
12458
+ | {
12459
+ /**
12460
+ ---
12461
+ title: Action Attempt ID
12462
+ ---
12463
+ The ID of the action attempt.
12464
+ */
10348
12465
  action_attempt_id: string
12466
+ status: 'pending'
10349
12467
  result: null
10350
12468
  error: null
12469
+ action_type: 'SET_HEAT'
12470
+ }
12471
+ | {
12472
+ /**
12473
+ ---
12474
+ title: Action Attempt ID
12475
+ ---
12476
+ The ID of the action attempt.
12477
+ */
12478
+ action_attempt_id: string
12479
+ status: 'success'
12480
+ error: null
12481
+ action_type: 'SET_HEAT'
12482
+ result: {}
10351
12483
  }
10352
12484
  | {
12485
+ /**
12486
+ ---
12487
+ title: Action Attempt ID
12488
+ ---
12489
+ The ID of the action attempt.
12490
+ */
12491
+ action_attempt_id: string
10353
12492
  status: 'error'
10354
- action_type: string
12493
+ result: null
12494
+ action_type: 'SET_HEAT'
12495
+ error: {
12496
+ type: string
12497
+ message: string
12498
+ }
12499
+ }
12500
+ | {
12501
+ /**
12502
+ ---
12503
+ title: Action Attempt ID
12504
+ ---
12505
+ The ID of the action attempt.
12506
+ */
12507
+ action_attempt_id: string
12508
+ status: 'pending'
12509
+ result: null
12510
+ error: null
12511
+ action_type: 'SET_HEAT_COOL'
12512
+ }
12513
+ | {
12514
+ /**
12515
+ ---
12516
+ title: Action Attempt ID
12517
+ ---
12518
+ The ID of the action attempt.
12519
+ */
12520
+ action_attempt_id: string
12521
+ status: 'success'
12522
+ error: null
12523
+ action_type: 'SET_HEAT_COOL'
12524
+ result: {}
12525
+ }
12526
+ | {
12527
+ /**
12528
+ ---
12529
+ title: Action Attempt ID
12530
+ ---
12531
+ The ID of the action attempt.
12532
+ */
10355
12533
  action_attempt_id: string
12534
+ status: 'error'
10356
12535
  result: null
12536
+ action_type: 'SET_HEAT_COOL'
10357
12537
  error: {
10358
12538
  type: string
10359
12539
  message: string
10360
12540
  }
10361
12541
  }
10362
- }
10363
- }
10364
- '/thermostats/set_fan_mode': {
10365
- route: '/thermostats/set_fan_mode'
10366
- method: 'POST'
10367
- queryParams: {}
10368
- jsonBody: {
10369
- device_id: string
10370
- fan_mode?: ('auto' | 'on') | undefined
10371
- fan_mode_setting?: ('auto' | 'on') | undefined
10372
- sync?: boolean
10373
- }
10374
- commonParams: {}
10375
- formData: {}
10376
- jsonResponse: {
10377
- action_attempt:
10378
12542
  | {
12543
+ /**
12544
+ ---
12545
+ title: Action Attempt ID
12546
+ ---
12547
+ The ID of the action attempt.
12548
+ */
12549
+ action_attempt_id: string
12550
+ status: 'pending'
12551
+ result: null
12552
+ error: null
12553
+ action_type: 'SET_FAN_MODE'
12554
+ }
12555
+ | {
12556
+ /**
12557
+ ---
12558
+ title: Action Attempt ID
12559
+ ---
12560
+ The ID of the action attempt.
12561
+ */
12562
+ action_attempt_id: string
10379
12563
  status: 'success'
10380
- action_type: string
12564
+ error: null
12565
+ action_type: 'SET_FAN_MODE'
12566
+ result: {}
12567
+ }
12568
+ | {
12569
+ /**
12570
+ ---
12571
+ title: Action Attempt ID
12572
+ ---
12573
+ The ID of the action attempt.
12574
+ */
12575
+ action_attempt_id: string
12576
+ status: 'error'
12577
+ result: null
12578
+ action_type: 'SET_FAN_MODE'
12579
+ error: {
12580
+ type: string
12581
+ message: string
12582
+ }
12583
+ }
12584
+ | {
12585
+ /**
12586
+ ---
12587
+ title: Action Attempt ID
12588
+ ---
12589
+ The ID of the action attempt.
12590
+ */
12591
+ action_attempt_id: string
12592
+ status: 'pending'
12593
+ result: null
12594
+ error: null
12595
+ action_type: 'SET_THERMOSTAT_OFF'
12596
+ }
12597
+ | {
12598
+ /**
12599
+ ---
12600
+ title: Action Attempt ID
12601
+ ---
12602
+ The ID of the action attempt.
12603
+ */
10381
12604
  action_attempt_id: string
10382
- result?: any
12605
+ status: 'success'
10383
12606
  error: null
12607
+ action_type: 'SET_THERMOSTAT_OFF'
12608
+ result: {}
10384
12609
  }
10385
12610
  | {
10386
- status: 'pending'
10387
- action_type: string
12611
+ /**
12612
+ ---
12613
+ title: Action Attempt ID
12614
+ ---
12615
+ The ID of the action attempt.
12616
+ */
10388
12617
  action_attempt_id: string
10389
- result: null
10390
- error: null
10391
- }
10392
- | {
10393
12618
  status: 'error'
10394
- action_type: string
10395
- action_attempt_id: string
10396
12619
  result: null
12620
+ action_type: 'SET_THERMOSTAT_OFF'
10397
12621
  error: {
10398
12622
  type: string
10399
12623
  message: string
@@ -10707,7 +12931,11 @@ export interface Routes {
10707
12931
  offline_access_codes_supported?: boolean | undefined
10708
12932
  /** Indicates whether the device supports online access codes. */
10709
12933
  online_access_codes_supported?: boolean | undefined
10710
- /** Indicates whether the device supports an accessory keypad. */
12934
+ /**
12935
+ ---
12936
+ deprecated: use device.properties.model.can_connect_accessory_keypad
12937
+ ---
12938
+ */
10711
12939
  accessory_keypad_supported?: boolean | undefined
10712
12940
  }
10713
12941
  /** Indicates whether the device has direct power. */
@@ -10735,7 +12963,7 @@ export interface Routes {
10735
12963
  offline_access_codes_enabled?: boolean | undefined
10736
12964
  /**
10737
12965
  ---
10738
- deprecated: use model.accessory_keypad_supported
12966
+ deprecated: use device.properties.model.can_connect_accessory_keypad
10739
12967
  ---
10740
12968
  */
10741
12969
  supports_accessory_keypad?: boolean | undefined
@@ -11447,7 +13675,11 @@ export interface Routes {
11447
13675
  offline_access_codes_supported?: boolean | undefined
11448
13676
  /** Indicates whether the device supports online access codes. */
11449
13677
  online_access_codes_supported?: boolean | undefined
11450
- /** Indicates whether the device supports an accessory keypad. */
13678
+ /**
13679
+ ---
13680
+ deprecated: use device.properties.model.can_connect_accessory_keypad
13681
+ ---
13682
+ */
11451
13683
  accessory_keypad_supported?: boolean | undefined
11452
13684
  }
11453
13685
  /** Indicates whether the device has direct power. */
@@ -11475,7 +13707,7 @@ export interface Routes {
11475
13707
  offline_access_codes_enabled?: boolean | undefined
11476
13708
  /**
11477
13709
  ---
11478
- deprecated: use model.accessory_keypad_supported
13710
+ deprecated: use device.properties.model.can_connect_accessory_keypad
11479
13711
  ---
11480
13712
  */
11481
13713
  supports_accessory_keypad?: boolean | undefined
@@ -12391,24 +14623,336 @@ export interface Routes {
12391
14623
  jsonResponse: {
12392
14624
  action_attempt:
12393
14625
  | {
14626
+ /**
14627
+ ---
14628
+ title: Action Attempt ID
14629
+ ---
14630
+ The ID of the action attempt.
14631
+ */
14632
+ action_attempt_id: string
14633
+ status: 'pending'
14634
+ result: null
14635
+ error: null
14636
+ action_type: 'LOCK_DOOR'
14637
+ }
14638
+ | {
14639
+ /**
14640
+ ---
14641
+ title: Action Attempt ID
14642
+ ---
14643
+ The ID of the action attempt.
14644
+ */
14645
+ action_attempt_id: string
12394
14646
  status: 'success'
12395
- action_type: string
14647
+ error: null
14648
+ action_type: 'LOCK_DOOR'
14649
+ result: {}
14650
+ }
14651
+ | {
14652
+ /**
14653
+ ---
14654
+ title: Action Attempt ID
14655
+ ---
14656
+ The ID of the action attempt.
14657
+ */
12396
14658
  action_attempt_id: string
12397
- result?: any
14659
+ status: 'error'
14660
+ result: null
14661
+ action_type: 'LOCK_DOOR'
14662
+ error: {
14663
+ type: string
14664
+ message: string
14665
+ }
14666
+ }
14667
+ | {
14668
+ /**
14669
+ ---
14670
+ title: Action Attempt ID
14671
+ ---
14672
+ The ID of the action attempt.
14673
+ */
14674
+ action_attempt_id: string
14675
+ status: 'pending'
14676
+ result: null
14677
+ error: null
14678
+ action_type: 'UNLOCK_DOOR'
14679
+ }
14680
+ | {
14681
+ /**
14682
+ ---
14683
+ title: Action Attempt ID
14684
+ ---
14685
+ The ID of the action attempt.
14686
+ */
14687
+ action_attempt_id: string
14688
+ status: 'success'
12398
14689
  error: null
14690
+ action_type: 'UNLOCK_DOOR'
14691
+ result: {}
12399
14692
  }
12400
14693
  | {
14694
+ /**
14695
+ ---
14696
+ title: Action Attempt ID
14697
+ ---
14698
+ The ID of the action attempt.
14699
+ */
14700
+ action_attempt_id: string
14701
+ status: 'error'
14702
+ result: null
14703
+ action_type: 'UNLOCK_DOOR'
14704
+ error: {
14705
+ type: string
14706
+ message: string
14707
+ }
14708
+ }
14709
+ | {
14710
+ /**
14711
+ ---
14712
+ title: Action Attempt ID
14713
+ ---
14714
+ The ID of the action attempt.
14715
+ */
14716
+ action_attempt_id: string
12401
14717
  status: 'pending'
12402
- action_type: string
14718
+ result: null
14719
+ error: null
14720
+ action_type: 'RESET_SANDBOX_WORKSPACE'
14721
+ }
14722
+ | {
14723
+ /**
14724
+ ---
14725
+ title: Action Attempt ID
14726
+ ---
14727
+ The ID of the action attempt.
14728
+ */
14729
+ action_attempt_id: string
14730
+ status: 'success'
14731
+ error: null
14732
+ action_type: 'RESET_SANDBOX_WORKSPACE'
14733
+ result: {}
14734
+ }
14735
+ | {
14736
+ /**
14737
+ ---
14738
+ title: Action Attempt ID
14739
+ ---
14740
+ The ID of the action attempt.
14741
+ */
14742
+ action_attempt_id: string
14743
+ status: 'error'
14744
+ result: null
14745
+ action_type: 'RESET_SANDBOX_WORKSPACE'
14746
+ error: {
14747
+ type: string
14748
+ message: string
14749
+ }
14750
+ }
14751
+ | {
14752
+ /**
14753
+ ---
14754
+ title: Action Attempt ID
14755
+ ---
14756
+ The ID of the action attempt.
14757
+ */
14758
+ action_attempt_id: string
14759
+ status: 'pending'
14760
+ result: null
14761
+ error: null
14762
+ action_type: 'SET_COOL'
14763
+ }
14764
+ | {
14765
+ /**
14766
+ ---
14767
+ title: Action Attempt ID
14768
+ ---
14769
+ The ID of the action attempt.
14770
+ */
14771
+ action_attempt_id: string
14772
+ status: 'success'
14773
+ error: null
14774
+ action_type: 'SET_COOL'
14775
+ result: {}
14776
+ }
14777
+ | {
14778
+ /**
14779
+ ---
14780
+ title: Action Attempt ID
14781
+ ---
14782
+ The ID of the action attempt.
14783
+ */
14784
+ action_attempt_id: string
14785
+ status: 'error'
14786
+ result: null
14787
+ action_type: 'SET_COOL'
14788
+ error: {
14789
+ type: string
14790
+ message: string
14791
+ }
14792
+ }
14793
+ | {
14794
+ /**
14795
+ ---
14796
+ title: Action Attempt ID
14797
+ ---
14798
+ The ID of the action attempt.
14799
+ */
12403
14800
  action_attempt_id: string
14801
+ status: 'pending'
12404
14802
  result: null
12405
14803
  error: null
14804
+ action_type: 'SET_HEAT'
14805
+ }
14806
+ | {
14807
+ /**
14808
+ ---
14809
+ title: Action Attempt ID
14810
+ ---
14811
+ The ID of the action attempt.
14812
+ */
14813
+ action_attempt_id: string
14814
+ status: 'success'
14815
+ error: null
14816
+ action_type: 'SET_HEAT'
14817
+ result: {}
12406
14818
  }
12407
14819
  | {
14820
+ /**
14821
+ ---
14822
+ title: Action Attempt ID
14823
+ ---
14824
+ The ID of the action attempt.
14825
+ */
14826
+ action_attempt_id: string
12408
14827
  status: 'error'
12409
- action_type: string
14828
+ result: null
14829
+ action_type: 'SET_HEAT'
14830
+ error: {
14831
+ type: string
14832
+ message: string
14833
+ }
14834
+ }
14835
+ | {
14836
+ /**
14837
+ ---
14838
+ title: Action Attempt ID
14839
+ ---
14840
+ The ID of the action attempt.
14841
+ */
14842
+ action_attempt_id: string
14843
+ status: 'pending'
14844
+ result: null
14845
+ error: null
14846
+ action_type: 'SET_HEAT_COOL'
14847
+ }
14848
+ | {
14849
+ /**
14850
+ ---
14851
+ title: Action Attempt ID
14852
+ ---
14853
+ The ID of the action attempt.
14854
+ */
14855
+ action_attempt_id: string
14856
+ status: 'success'
14857
+ error: null
14858
+ action_type: 'SET_HEAT_COOL'
14859
+ result: {}
14860
+ }
14861
+ | {
14862
+ /**
14863
+ ---
14864
+ title: Action Attempt ID
14865
+ ---
14866
+ The ID of the action attempt.
14867
+ */
14868
+ action_attempt_id: string
14869
+ status: 'error'
14870
+ result: null
14871
+ action_type: 'SET_HEAT_COOL'
14872
+ error: {
14873
+ type: string
14874
+ message: string
14875
+ }
14876
+ }
14877
+ | {
14878
+ /**
14879
+ ---
14880
+ title: Action Attempt ID
14881
+ ---
14882
+ The ID of the action attempt.
14883
+ */
14884
+ action_attempt_id: string
14885
+ status: 'pending'
14886
+ result: null
14887
+ error: null
14888
+ action_type: 'SET_FAN_MODE'
14889
+ }
14890
+ | {
14891
+ /**
14892
+ ---
14893
+ title: Action Attempt ID
14894
+ ---
14895
+ The ID of the action attempt.
14896
+ */
14897
+ action_attempt_id: string
14898
+ status: 'success'
14899
+ error: null
14900
+ action_type: 'SET_FAN_MODE'
14901
+ result: {}
14902
+ }
14903
+ | {
14904
+ /**
14905
+ ---
14906
+ title: Action Attempt ID
14907
+ ---
14908
+ The ID of the action attempt.
14909
+ */
14910
+ action_attempt_id: string
14911
+ status: 'error'
14912
+ result: null
14913
+ action_type: 'SET_FAN_MODE'
14914
+ error: {
14915
+ type: string
14916
+ message: string
14917
+ }
14918
+ }
14919
+ | {
14920
+ /**
14921
+ ---
14922
+ title: Action Attempt ID
14923
+ ---
14924
+ The ID of the action attempt.
14925
+ */
14926
+ action_attempt_id: string
14927
+ status: 'pending'
14928
+ result: null
14929
+ error: null
14930
+ action_type: 'SET_THERMOSTAT_OFF'
14931
+ }
14932
+ | {
14933
+ /**
14934
+ ---
14935
+ title: Action Attempt ID
14936
+ ---
14937
+ The ID of the action attempt.
14938
+ */
14939
+ action_attempt_id: string
14940
+ status: 'success'
14941
+ error: null
14942
+ action_type: 'SET_THERMOSTAT_OFF'
14943
+ result: {}
14944
+ }
14945
+ | {
14946
+ /**
14947
+ ---
14948
+ title: Action Attempt ID
14949
+ ---
14950
+ The ID of the action attempt.
14951
+ */
12410
14952
  action_attempt_id: string
14953
+ status: 'error'
12411
14954
  result: null
14955
+ action_type: 'SET_THERMOSTAT_OFF'
12412
14956
  error: {
12413
14957
  type: string
12414
14958
  message: string