@seamapi/types 1.290.0 → 1.292.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 (32) hide show
  1. package/dist/connect.cjs +688 -193
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1099 -82
  4. package/lib/seam/connect/models/acs/acs-encoder.d.ts +52 -7
  5. package/lib/seam/connect/models/acs/acs-encoder.js +28 -4
  6. package/lib/seam/connect/models/acs/acs-encoder.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-system.js +15 -9
  8. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  9. package/lib/seam/connect/models/events/acs/encoders.d.ts +126 -0
  10. package/lib/seam/connect/models/events/acs/encoders.js +20 -0
  11. package/lib/seam/connect/models/events/acs/encoders.js.map +1 -0
  12. package/lib/seam/connect/models/events/acs/index.d.ts +60 -0
  13. package/lib/seam/connect/models/events/acs/index.js +2 -0
  14. package/lib/seam/connect/models/events/acs/index.js.map +1 -1
  15. package/lib/seam/connect/models/events/seam-event.d.ts +60 -0
  16. package/lib/seam/connect/models/thermostats/climate-preset.js +41 -12
  17. package/lib/seam/connect/models/thermostats/climate-preset.js.map +1 -1
  18. package/lib/seam/connect/models/thermostats/thermostat-schedule.js +30 -9
  19. package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
  20. package/lib/seam/connect/openapi.d.ts +218 -23
  21. package/lib/seam/connect/openapi.js +598 -133
  22. package/lib/seam/connect/openapi.js.map +1 -1
  23. package/lib/seam/connect/route-types.d.ts +803 -52
  24. package/package.json +1 -1
  25. package/src/lib/seam/connect/models/acs/acs-encoder.ts +40 -6
  26. package/src/lib/seam/connect/models/acs/acs-system.ts +29 -21
  27. package/src/lib/seam/connect/models/events/acs/encoders.ts +28 -0
  28. package/src/lib/seam/connect/models/events/acs/index.ts +2 -0
  29. package/src/lib/seam/connect/models/thermostats/climate-preset.ts +49 -12
  30. package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +38 -9
  31. package/src/lib/seam/connect/openapi.ts +754 -133
  32. package/src/lib/seam/connect/route-types.ts +805 -50
@@ -6771,25 +6771,37 @@ export interface Routes {
6771
6771
  is_temporary_manual_override_active?: boolean | undefined
6772
6772
  current_climate_setting?:
6773
6773
  | {
6774
+ /** Unique key to identify the climate preset. */
6774
6775
  climate_preset_key?: string | undefined
6776
+ /** Indicates whether this climate preset key can be edited. */
6775
6777
  can_edit?: boolean | undefined
6778
+ /** Indicates whether this climate preset key can be deleted. */
6776
6779
  can_delete?: boolean | undefined
6780
+ /** User-friendly name to identify the climate preset. */
6777
6781
  name?: ((string | null) | undefined) | undefined
6782
+ /** Display name for the climate preset. */
6778
6783
  display_name?: string | undefined
6784
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
6779
6785
  fan_mode_setting?:
6780
6786
  | (('auto' | 'on' | 'circulate') | undefined)
6781
6787
  | undefined
6788
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
6782
6789
  hvac_mode_setting?:
6783
6790
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
6784
6791
  | undefined
6792
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
6785
6793
  cooling_set_point_celsius?: (number | undefined) | undefined
6794
+ /** Temperature to which the thermostat should heat (in °C). */
6786
6795
  heating_set_point_celsius?: (number | undefined) | undefined
6796
+ /** Temperature to which the thermostat should cool (in °F). */
6787
6797
  cooling_set_point_fahrenheit?:
6788
6798
  | (number | undefined)
6789
6799
  | undefined
6800
+ /** Temperature to which the thermostat should heat (in °F). */
6790
6801
  heating_set_point_fahrenheit?:
6791
6802
  | (number | undefined)
6792
6803
  | undefined
6804
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
6793
6805
  manual_override_allowed?: boolean | undefined
6794
6806
  }
6795
6807
  | undefined
@@ -6797,58 +6809,90 @@ export interface Routes {
6797
6809
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6798
6810
  default_climate_setting?:
6799
6811
  | {
6812
+ /** Unique key to identify the climate preset. */
6800
6813
  climate_preset_key?: string | undefined
6814
+ /** Indicates whether this climate preset key can be edited. */
6801
6815
  can_edit?: boolean | undefined
6816
+ /** Indicates whether this climate preset key can be deleted. */
6802
6817
  can_delete?: boolean | undefined
6818
+ /** User-friendly name to identify the climate preset. */
6803
6819
  name?: ((string | null) | undefined) | undefined
6820
+ /** Display name for the climate preset. */
6804
6821
  display_name?: string | undefined
6822
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
6805
6823
  fan_mode_setting?:
6806
6824
  | (('auto' | 'on' | 'circulate') | undefined)
6807
6825
  | undefined
6826
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
6808
6827
  hvac_mode_setting?:
6809
6828
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
6810
6829
  | undefined
6830
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
6811
6831
  cooling_set_point_celsius?: (number | undefined) | undefined
6832
+ /** Temperature to which the thermostat should heat (in °C). */
6812
6833
  heating_set_point_celsius?: (number | undefined) | undefined
6834
+ /** Temperature to which the thermostat should cool (in °F). */
6813
6835
  cooling_set_point_fahrenheit?:
6814
6836
  | (number | undefined)
6815
6837
  | undefined
6838
+ /** Temperature to which the thermostat should heat (in °F). */
6816
6839
  heating_set_point_fahrenheit?:
6817
6840
  | (number | undefined)
6818
6841
  | undefined
6842
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
6819
6843
  manual_override_allowed?: boolean | undefined
6820
6844
  }
6821
6845
  | undefined
6822
6846
  available_climate_presets?:
6823
6847
  | Array<{
6848
+ /** Unique key to identify the climate preset. */
6824
6849
  climate_preset_key: string
6850
+ /** Indicates whether this climate preset key can be edited. */
6825
6851
  can_edit: boolean
6852
+ /** Indicates whether this climate preset key can be deleted. */
6826
6853
  can_delete: boolean
6854
+ /** User-friendly name to identify the climate preset. */
6827
6855
  name?: (string | null) | undefined
6856
+ /** Display name for the climate preset. */
6828
6857
  display_name: string
6858
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
6829
6859
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
6860
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
6830
6861
  hvac_mode_setting?:
6831
6862
  | ('off' | 'heat' | 'cool' | 'heat_cool')
6832
6863
  | undefined
6864
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
6833
6865
  cooling_set_point_celsius?: number | undefined
6866
+ /** Temperature to which the thermostat should heat (in °C). */
6834
6867
  heating_set_point_celsius?: number | undefined
6868
+ /** Temperature to which the thermostat should cool (in °F). */
6835
6869
  cooling_set_point_fahrenheit?: number | undefined
6870
+ /** Temperature to which the thermostat should heat (in °F). */
6836
6871
  heating_set_point_fahrenheit?: number | undefined
6872
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
6837
6873
  manual_override_allowed: boolean
6838
6874
  }>
6839
6875
  | undefined
6840
6876
  fallback_climate_preset_key?: (string | null) | undefined
6841
6877
  active_thermostat_schedule?:
6842
6878
  | ({
6879
+ /** ID of the climate schedule. */
6843
6880
  thermostat_schedule_id: string
6881
+ /** ID of the desired thermostat device. */
6844
6882
  device_id: string
6883
+ /** User-friendly name to identify the climate schedule. */
6845
6884
  name?: string | undefined
6885
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
6846
6886
  climate_preset_key: string
6887
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
6847
6888
  max_override_period_minutes: number
6889
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
6848
6890
  starts_at: string
6891
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
6849
6892
  ends_at: string
6893
+ /** Date and time at which the climate schedule was created. */
6850
6894
  created_at: string
6851
- /** Collection of errors associated with the thermostat schedule, 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. */
6895
+ /** Array of errors associated with the climate schedule. 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. */
6852
6896
  errors?: any
6853
6897
  } | null)
6854
6898
  | undefined
@@ -8148,7 +8192,7 @@ export interface Routes {
8148
8192
  created_at: string
8149
8193
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8150
8194
  message: string
8151
- /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
8195
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8152
8196
  error_code: 'salto_ks_subscription_limit_exceeded'
8153
8197
  }
8154
8198
  | {
@@ -8156,7 +8200,7 @@ export interface Routes {
8156
8200
  created_at: string
8157
8201
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8158
8202
  message: string
8159
- /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
8203
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8160
8204
  error_code: 'acs_system_disconnected'
8161
8205
  }
8162
8206
  | {
@@ -8164,7 +8208,7 @@ export interface Routes {
8164
8208
  created_at: string
8165
8209
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8166
8210
  message: string
8167
- /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
8211
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8168
8212
  error_code: 'account_disconnected'
8169
8213
  }
8170
8214
  >
@@ -8295,7 +8339,7 @@ export interface Routes {
8295
8339
  created_at: string
8296
8340
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8297
8341
  message: string
8298
- /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
8342
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8299
8343
  error_code: 'salto_ks_subscription_limit_exceeded'
8300
8344
  }
8301
8345
  | {
@@ -8303,7 +8347,7 @@ export interface Routes {
8303
8347
  created_at: string
8304
8348
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8305
8349
  message: string
8306
- /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
8350
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8307
8351
  error_code: 'acs_system_disconnected'
8308
8352
  }
8309
8353
  | {
@@ -8311,7 +8355,7 @@ export interface Routes {
8311
8355
  created_at: string
8312
8356
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8313
8357
  message: string
8314
- /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
8358
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8315
8359
  error_code: 'account_disconnected'
8316
8360
  }
8317
8361
  >
@@ -8442,7 +8486,7 @@ export interface Routes {
8442
8486
  created_at: string
8443
8487
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8444
8488
  message: string
8445
- /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
8489
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8446
8490
  error_code: 'salto_ks_subscription_limit_exceeded'
8447
8491
  }
8448
8492
  | {
@@ -8450,7 +8494,7 @@ export interface Routes {
8450
8494
  created_at: string
8451
8495
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8452
8496
  message: string
8453
- /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
8497
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8454
8498
  error_code: 'acs_system_disconnected'
8455
8499
  }
8456
8500
  | {
@@ -8458,7 +8502,7 @@ export interface Routes {
8458
8502
  created_at: string
8459
8503
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
8460
8504
  message: string
8461
- /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
8505
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
8462
8506
  error_code: 'account_disconnected'
8463
8507
  }
8464
8508
  >
@@ -12029,25 +12073,37 @@ export interface Routes {
12029
12073
  is_temporary_manual_override_active?: boolean | undefined
12030
12074
  current_climate_setting?:
12031
12075
  | {
12076
+ /** Unique key to identify the climate preset. */
12032
12077
  climate_preset_key?: string | undefined
12078
+ /** Indicates whether this climate preset key can be edited. */
12033
12079
  can_edit?: boolean | undefined
12080
+ /** Indicates whether this climate preset key can be deleted. */
12034
12081
  can_delete?: boolean | undefined
12082
+ /** User-friendly name to identify the climate preset. */
12035
12083
  name?: ((string | null) | undefined) | undefined
12084
+ /** Display name for the climate preset. */
12036
12085
  display_name?: string | undefined
12086
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12037
12087
  fan_mode_setting?:
12038
12088
  | (('auto' | 'on' | 'circulate') | undefined)
12039
12089
  | undefined
12090
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
12040
12091
  hvac_mode_setting?:
12041
12092
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
12042
12093
  | undefined
12094
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
12043
12095
  cooling_set_point_celsius?: (number | undefined) | undefined
12096
+ /** Temperature to which the thermostat should heat (in °C). */
12044
12097
  heating_set_point_celsius?: (number | undefined) | undefined
12098
+ /** Temperature to which the thermostat should cool (in °F). */
12045
12099
  cooling_set_point_fahrenheit?:
12046
12100
  | (number | undefined)
12047
12101
  | undefined
12102
+ /** Temperature to which the thermostat should heat (in °F). */
12048
12103
  heating_set_point_fahrenheit?:
12049
12104
  | (number | undefined)
12050
12105
  | undefined
12106
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12051
12107
  manual_override_allowed?: boolean | undefined
12052
12108
  }
12053
12109
  | undefined
@@ -12055,58 +12111,90 @@ export interface Routes {
12055
12111
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
12056
12112
  default_climate_setting?:
12057
12113
  | {
12114
+ /** Unique key to identify the climate preset. */
12058
12115
  climate_preset_key?: string | undefined
12116
+ /** Indicates whether this climate preset key can be edited. */
12059
12117
  can_edit?: boolean | undefined
12118
+ /** Indicates whether this climate preset key can be deleted. */
12060
12119
  can_delete?: boolean | undefined
12120
+ /** User-friendly name to identify the climate preset. */
12061
12121
  name?: ((string | null) | undefined) | undefined
12122
+ /** Display name for the climate preset. */
12062
12123
  display_name?: string | undefined
12124
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12063
12125
  fan_mode_setting?:
12064
12126
  | (('auto' | 'on' | 'circulate') | undefined)
12065
12127
  | undefined
12128
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
12066
12129
  hvac_mode_setting?:
12067
12130
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
12068
12131
  | undefined
12132
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
12069
12133
  cooling_set_point_celsius?: (number | undefined) | undefined
12134
+ /** Temperature to which the thermostat should heat (in °C). */
12070
12135
  heating_set_point_celsius?: (number | undefined) | undefined
12136
+ /** Temperature to which the thermostat should cool (in °F). */
12071
12137
  cooling_set_point_fahrenheit?:
12072
12138
  | (number | undefined)
12073
12139
  | undefined
12140
+ /** Temperature to which the thermostat should heat (in °F). */
12074
12141
  heating_set_point_fahrenheit?:
12075
12142
  | (number | undefined)
12076
12143
  | undefined
12144
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12077
12145
  manual_override_allowed?: boolean | undefined
12078
12146
  }
12079
12147
  | undefined
12080
12148
  available_climate_presets?:
12081
12149
  | Array<{
12150
+ /** Unique key to identify the climate preset. */
12082
12151
  climate_preset_key: string
12152
+ /** Indicates whether this climate preset key can be edited. */
12083
12153
  can_edit: boolean
12154
+ /** Indicates whether this climate preset key can be deleted. */
12084
12155
  can_delete: boolean
12156
+ /** User-friendly name to identify the climate preset. */
12085
12157
  name?: (string | null) | undefined
12158
+ /** Display name for the climate preset. */
12086
12159
  display_name: string
12160
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12087
12161
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
12162
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
12088
12163
  hvac_mode_setting?:
12089
12164
  | ('off' | 'heat' | 'cool' | 'heat_cool')
12090
12165
  | undefined
12166
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
12091
12167
  cooling_set_point_celsius?: number | undefined
12168
+ /** Temperature to which the thermostat should heat (in °C). */
12092
12169
  heating_set_point_celsius?: number | undefined
12170
+ /** Temperature to which the thermostat should cool (in °F). */
12093
12171
  cooling_set_point_fahrenheit?: number | undefined
12172
+ /** Temperature to which the thermostat should heat (in °F). */
12094
12173
  heating_set_point_fahrenheit?: number | undefined
12174
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12095
12175
  manual_override_allowed: boolean
12096
12176
  }>
12097
12177
  | undefined
12098
12178
  fallback_climate_preset_key?: (string | null) | undefined
12099
12179
  active_thermostat_schedule?:
12100
12180
  | ({
12181
+ /** ID of the climate schedule. */
12101
12182
  thermostat_schedule_id: string
12183
+ /** ID of the desired thermostat device. */
12102
12184
  device_id: string
12185
+ /** User-friendly name to identify the climate schedule. */
12103
12186
  name?: string | undefined
12187
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
12104
12188
  climate_preset_key: string
12189
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
12105
12190
  max_override_period_minutes: number
12191
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12106
12192
  starts_at: string
12193
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12107
12194
  ends_at: string
12195
+ /** Date and time at which the climate schedule was created. */
12108
12196
  created_at: string
12109
- /** Collection of errors associated with the thermostat schedule, 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. */
12197
+ /** Array of errors associated with the climate schedule. 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. */
12110
12198
  errors?: any
12111
12199
  } | null)
12112
12200
  | undefined
@@ -12186,10 +12274,13 @@ export interface Routes {
12186
12274
  queryParams: {}
12187
12275
  jsonBody: {}
12188
12276
  commonParams: {
12189
- /** List all devices owned by this connected account */
12277
+ /** ID of the connected account by which to filter. */
12190
12278
  connected_account_id?: string | undefined
12279
+ /** Array of IDs of the connected accounts by which to filter devices. */
12191
12280
  connected_account_ids?: string[] | undefined
12281
+ /** ID of the Connect Webview by which to filter devices. */
12192
12282
  connect_webview_id?: string | undefined
12283
+ /** Device type by which to filter devices. */
12193
12284
  device_type?:
12194
12285
  | (
12195
12286
  | (
@@ -12231,6 +12322,7 @@ export interface Routes {
12231
12322
  | ('visionline_encoder' | 'assa_abloy_vostio_encoder')
12232
12323
  )
12233
12324
  | undefined
12325
+ /** Array of device types by which to filter devices. */
12234
12326
  device_types?:
12235
12327
  | Array<
12236
12328
  | (
@@ -12272,6 +12364,7 @@ export interface Routes {
12272
12364
  | ('visionline_encoder' | 'assa_abloy_vostio_encoder')
12273
12365
  >
12274
12366
  | undefined
12367
+ /** Manufacturer by which to filter devices. */
12275
12368
  manufacturer?:
12276
12369
  | (
12277
12370
  | 'akuvox'
@@ -12311,11 +12404,17 @@ export interface Routes {
12311
12404
  | 'akiles'
12312
12405
  )
12313
12406
  | undefined
12407
+ /** Array of device IDs by which to filter devices. */
12314
12408
  device_ids?: string[] | undefined
12409
+ /** Numerical limit on the number of devices to return. */
12315
12410
  limit?: number
12411
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
12316
12412
  created_before?: Date | undefined
12413
+ /** Your own internal user ID for the user by which to filter devices. */
12317
12414
  user_identifier_key?: string | undefined
12415
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
12318
12416
  custom_metadata_has?: Record<string, string | boolean> | undefined
12417
+ /** */
12319
12418
  include_if?:
12320
12419
  | Array<
12321
12420
  | 'can_remotely_unlock'
@@ -12331,6 +12430,7 @@ export interface Routes {
12331
12430
  | 'can_simulate_disconnection'
12332
12431
  >
12333
12432
  | undefined
12433
+ /** */
12334
12434
  exclude_if?:
12335
12435
  | Array<
12336
12436
  | 'can_remotely_unlock'
@@ -12846,25 +12946,37 @@ export interface Routes {
12846
12946
  is_temporary_manual_override_active?: boolean | undefined
12847
12947
  current_climate_setting?:
12848
12948
  | {
12949
+ /** Unique key to identify the climate preset. */
12849
12950
  climate_preset_key?: string | undefined
12951
+ /** Indicates whether this climate preset key can be edited. */
12850
12952
  can_edit?: boolean | undefined
12953
+ /** Indicates whether this climate preset key can be deleted. */
12851
12954
  can_delete?: boolean | undefined
12955
+ /** User-friendly name to identify the climate preset. */
12852
12956
  name?: ((string | null) | undefined) | undefined
12957
+ /** Display name for the climate preset. */
12853
12958
  display_name?: string | undefined
12959
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12854
12960
  fan_mode_setting?:
12855
12961
  | (('auto' | 'on' | 'circulate') | undefined)
12856
12962
  | undefined
12963
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
12857
12964
  hvac_mode_setting?:
12858
12965
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
12859
12966
  | undefined
12967
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
12860
12968
  cooling_set_point_celsius?: (number | undefined) | undefined
12969
+ /** Temperature to which the thermostat should heat (in °C). */
12861
12970
  heating_set_point_celsius?: (number | undefined) | undefined
12971
+ /** Temperature to which the thermostat should cool (in °F). */
12862
12972
  cooling_set_point_fahrenheit?:
12863
12973
  | (number | undefined)
12864
12974
  | undefined
12975
+ /** Temperature to which the thermostat should heat (in °F). */
12865
12976
  heating_set_point_fahrenheit?:
12866
12977
  | (number | undefined)
12867
12978
  | undefined
12979
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12868
12980
  manual_override_allowed?: boolean | undefined
12869
12981
  }
12870
12982
  | undefined
@@ -12872,58 +12984,90 @@ export interface Routes {
12872
12984
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
12873
12985
  default_climate_setting?:
12874
12986
  | {
12987
+ /** Unique key to identify the climate preset. */
12875
12988
  climate_preset_key?: string | undefined
12989
+ /** Indicates whether this climate preset key can be edited. */
12876
12990
  can_edit?: boolean | undefined
12991
+ /** Indicates whether this climate preset key can be deleted. */
12877
12992
  can_delete?: boolean | undefined
12993
+ /** User-friendly name to identify the climate preset. */
12878
12994
  name?: ((string | null) | undefined) | undefined
12995
+ /** Display name for the climate preset. */
12879
12996
  display_name?: string | undefined
12997
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12880
12998
  fan_mode_setting?:
12881
12999
  | (('auto' | 'on' | 'circulate') | undefined)
12882
13000
  | undefined
13001
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
12883
13002
  hvac_mode_setting?:
12884
13003
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
12885
13004
  | undefined
13005
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
12886
13006
  cooling_set_point_celsius?: (number | undefined) | undefined
13007
+ /** Temperature to which the thermostat should heat (in °C). */
12887
13008
  heating_set_point_celsius?: (number | undefined) | undefined
13009
+ /** Temperature to which the thermostat should cool (in °F). */
12888
13010
  cooling_set_point_fahrenheit?:
12889
13011
  | (number | undefined)
12890
13012
  | undefined
13013
+ /** Temperature to which the thermostat should heat (in °F). */
12891
13014
  heating_set_point_fahrenheit?:
12892
13015
  | (number | undefined)
12893
13016
  | undefined
13017
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12894
13018
  manual_override_allowed?: boolean | undefined
12895
13019
  }
12896
13020
  | undefined
12897
13021
  available_climate_presets?:
12898
13022
  | Array<{
13023
+ /** Unique key to identify the climate preset. */
12899
13024
  climate_preset_key: string
13025
+ /** Indicates whether this climate preset key can be edited. */
12900
13026
  can_edit: boolean
13027
+ /** Indicates whether this climate preset key can be deleted. */
12901
13028
  can_delete: boolean
13029
+ /** User-friendly name to identify the climate preset. */
12902
13030
  name?: (string | null) | undefined
13031
+ /** Display name for the climate preset. */
12903
13032
  display_name: string
13033
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
12904
13034
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
13035
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
12905
13036
  hvac_mode_setting?:
12906
13037
  | ('off' | 'heat' | 'cool' | 'heat_cool')
12907
13038
  | undefined
13039
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
12908
13040
  cooling_set_point_celsius?: number | undefined
13041
+ /** Temperature to which the thermostat should heat (in °C). */
12909
13042
  heating_set_point_celsius?: number | undefined
13043
+ /** Temperature to which the thermostat should cool (in °F). */
12910
13044
  cooling_set_point_fahrenheit?: number | undefined
13045
+ /** Temperature to which the thermostat should heat (in °F). */
12911
13046
  heating_set_point_fahrenheit?: number | undefined
13047
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
12912
13048
  manual_override_allowed: boolean
12913
13049
  }>
12914
13050
  | undefined
12915
13051
  fallback_climate_preset_key?: (string | null) | undefined
12916
13052
  active_thermostat_schedule?:
12917
13053
  | ({
13054
+ /** ID of the climate schedule. */
12918
13055
  thermostat_schedule_id: string
13056
+ /** ID of the desired thermostat device. */
12919
13057
  device_id: string
13058
+ /** User-friendly name to identify the climate schedule. */
12920
13059
  name?: string | undefined
13060
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
12921
13061
  climate_preset_key: string
13062
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
12922
13063
  max_override_period_minutes: number
13064
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12923
13065
  starts_at: string
13066
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12924
13067
  ends_at: string
13068
+ /** Date and time at which the climate schedule was created. */
12925
13069
  created_at: string
12926
- /** Collection of errors associated with the thermostat schedule, 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. */
13070
+ /** Array of errors associated with the climate schedule. 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. */
12927
13071
  errors?: any
12928
13072
  } | null)
12929
13073
  | undefined
@@ -13285,10 +13429,13 @@ export interface Routes {
13285
13429
  queryParams: {}
13286
13430
  jsonBody: {}
13287
13431
  commonParams: {
13288
- /** List all devices owned by this connected account */
13432
+ /** ID of the connected account by which to filter. */
13289
13433
  connected_account_id?: string | undefined
13434
+ /** Array of IDs of the connected accounts by which to filter devices. */
13290
13435
  connected_account_ids?: string[] | undefined
13436
+ /** ID of the Connect Webview by which to filter devices. */
13291
13437
  connect_webview_id?: string | undefined
13438
+ /** Device type by which to filter devices. */
13292
13439
  device_type?:
13293
13440
  | (
13294
13441
  | (
@@ -13330,6 +13477,7 @@ export interface Routes {
13330
13477
  | ('visionline_encoder' | 'assa_abloy_vostio_encoder')
13331
13478
  )
13332
13479
  | undefined
13480
+ /** Array of device types by which to filter devices. */
13333
13481
  device_types?:
13334
13482
  | Array<
13335
13483
  | (
@@ -13371,6 +13519,7 @@ export interface Routes {
13371
13519
  | ('visionline_encoder' | 'assa_abloy_vostio_encoder')
13372
13520
  >
13373
13521
  | undefined
13522
+ /** Manufacturer by which to filter devices. */
13374
13523
  manufacturer?:
13375
13524
  | (
13376
13525
  | 'akuvox'
@@ -13410,11 +13559,17 @@ export interface Routes {
13410
13559
  | 'akiles'
13411
13560
  )
13412
13561
  | undefined
13562
+ /** Array of device IDs by which to filter devices. */
13413
13563
  device_ids?: string[] | undefined
13564
+ /** Numerical limit on the number of devices to return. */
13414
13565
  limit?: number
13566
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
13415
13567
  created_before?: Date | undefined
13568
+ /** Your own internal user ID for the user by which to filter devices. */
13416
13569
  user_identifier_key?: string | undefined
13570
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
13417
13571
  custom_metadata_has?: Record<string, string | boolean> | undefined
13572
+ /** */
13418
13573
  include_if?:
13419
13574
  | Array<
13420
13575
  | 'can_remotely_unlock'
@@ -13430,6 +13585,7 @@ export interface Routes {
13430
13585
  | 'can_simulate_disconnection'
13431
13586
  >
13432
13587
  | undefined
13588
+ /** */
13433
13589
  exclude_if?:
13434
13590
  | Array<
13435
13591
  | 'can_remotely_unlock'
@@ -13749,6 +13905,8 @@ export interface Routes {
13749
13905
  | 'acs_user.deleted'
13750
13906
  | 'acs_credential.deleted'
13751
13907
  | 'acs_credential.issued'
13908
+ | 'acs_encoder.added'
13909
+ | 'acs_encoder.removed'
13752
13910
  | 'enrollment_automation.deleted'
13753
13911
  | 'client_session.deleted'
13754
13912
  | 'action_attempt.lock_door.succeeded'
@@ -13821,6 +13979,8 @@ export interface Routes {
13821
13979
  | 'acs_user.deleted'
13822
13980
  | 'acs_credential.deleted'
13823
13981
  | 'acs_credential.issued'
13982
+ | 'acs_encoder.added'
13983
+ | 'acs_encoder.removed'
13824
13984
  | 'enrollment_automation.deleted'
13825
13985
  | 'client_session.deleted'
13826
13986
  | 'action_attempt.lock_door.succeeded'
@@ -14374,25 +14534,37 @@ export interface Routes {
14374
14534
  is_temporary_manual_override_active?: boolean | undefined
14375
14535
  current_climate_setting?:
14376
14536
  | {
14537
+ /** Unique key to identify the climate preset. */
14377
14538
  climate_preset_key?: string | undefined
14539
+ /** Indicates whether this climate preset key can be edited. */
14378
14540
  can_edit?: boolean | undefined
14541
+ /** Indicates whether this climate preset key can be deleted. */
14379
14542
  can_delete?: boolean | undefined
14543
+ /** User-friendly name to identify the climate preset. */
14380
14544
  name?: ((string | null) | undefined) | undefined
14545
+ /** Display name for the climate preset. */
14381
14546
  display_name?: string | undefined
14547
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
14382
14548
  fan_mode_setting?:
14383
14549
  | (('auto' | 'on' | 'circulate') | undefined)
14384
14550
  | undefined
14551
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
14385
14552
  hvac_mode_setting?:
14386
14553
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
14387
14554
  | undefined
14555
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
14388
14556
  cooling_set_point_celsius?: (number | undefined) | undefined
14557
+ /** Temperature to which the thermostat should heat (in °C). */
14389
14558
  heating_set_point_celsius?: (number | undefined) | undefined
14559
+ /** Temperature to which the thermostat should cool (in °F). */
14390
14560
  cooling_set_point_fahrenheit?:
14391
14561
  | (number | undefined)
14392
14562
  | undefined
14563
+ /** Temperature to which the thermostat should heat (in °F). */
14393
14564
  heating_set_point_fahrenheit?:
14394
14565
  | (number | undefined)
14395
14566
  | undefined
14567
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
14396
14568
  manual_override_allowed?: boolean | undefined
14397
14569
  }
14398
14570
  | undefined
@@ -14400,58 +14572,90 @@ export interface Routes {
14400
14572
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
14401
14573
  default_climate_setting?:
14402
14574
  | {
14575
+ /** Unique key to identify the climate preset. */
14403
14576
  climate_preset_key?: string | undefined
14577
+ /** Indicates whether this climate preset key can be edited. */
14404
14578
  can_edit?: boolean | undefined
14579
+ /** Indicates whether this climate preset key can be deleted. */
14405
14580
  can_delete?: boolean | undefined
14581
+ /** User-friendly name to identify the climate preset. */
14406
14582
  name?: ((string | null) | undefined) | undefined
14583
+ /** Display name for the climate preset. */
14407
14584
  display_name?: string | undefined
14585
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
14408
14586
  fan_mode_setting?:
14409
14587
  | (('auto' | 'on' | 'circulate') | undefined)
14410
14588
  | undefined
14589
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
14411
14590
  hvac_mode_setting?:
14412
14591
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
14413
14592
  | undefined
14593
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
14414
14594
  cooling_set_point_celsius?: (number | undefined) | undefined
14595
+ /** Temperature to which the thermostat should heat (in °C). */
14415
14596
  heating_set_point_celsius?: (number | undefined) | undefined
14597
+ /** Temperature to which the thermostat should cool (in °F). */
14416
14598
  cooling_set_point_fahrenheit?:
14417
14599
  | (number | undefined)
14418
14600
  | undefined
14601
+ /** Temperature to which the thermostat should heat (in °F). */
14419
14602
  heating_set_point_fahrenheit?:
14420
14603
  | (number | undefined)
14421
14604
  | undefined
14605
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
14422
14606
  manual_override_allowed?: boolean | undefined
14423
14607
  }
14424
14608
  | undefined
14425
14609
  available_climate_presets?:
14426
14610
  | Array<{
14611
+ /** Unique key to identify the climate preset. */
14427
14612
  climate_preset_key: string
14613
+ /** Indicates whether this climate preset key can be edited. */
14428
14614
  can_edit: boolean
14615
+ /** Indicates whether this climate preset key can be deleted. */
14429
14616
  can_delete: boolean
14617
+ /** User-friendly name to identify the climate preset. */
14430
14618
  name?: (string | null) | undefined
14619
+ /** Display name for the climate preset. */
14431
14620
  display_name: string
14621
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
14432
14622
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
14623
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
14433
14624
  hvac_mode_setting?:
14434
14625
  | ('off' | 'heat' | 'cool' | 'heat_cool')
14435
14626
  | undefined
14627
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
14436
14628
  cooling_set_point_celsius?: number | undefined
14629
+ /** Temperature to which the thermostat should heat (in °C). */
14437
14630
  heating_set_point_celsius?: number | undefined
14631
+ /** Temperature to which the thermostat should cool (in °F). */
14438
14632
  cooling_set_point_fahrenheit?: number | undefined
14633
+ /** Temperature to which the thermostat should heat (in °F). */
14439
14634
  heating_set_point_fahrenheit?: number | undefined
14635
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
14440
14636
  manual_override_allowed: boolean
14441
14637
  }>
14442
14638
  | undefined
14443
14639
  fallback_climate_preset_key?: (string | null) | undefined
14444
14640
  active_thermostat_schedule?:
14445
14641
  | ({
14642
+ /** ID of the climate schedule. */
14446
14643
  thermostat_schedule_id: string
14644
+ /** ID of the desired thermostat device. */
14447
14645
  device_id: string
14646
+ /** User-friendly name to identify the climate schedule. */
14448
14647
  name?: string | undefined
14648
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
14449
14649
  climate_preset_key: string
14650
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
14450
14651
  max_override_period_minutes: number
14652
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
14451
14653
  starts_at: string
14654
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
14452
14655
  ends_at: string
14656
+ /** Date and time at which the climate schedule was created. */
14453
14657
  created_at: string
14454
- /** Collection of errors associated with the thermostat schedule, 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. */
14658
+ /** Array of errors associated with the climate schedule. 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. */
14455
14659
  errors?: any
14456
14660
  } | null)
14457
14661
  | undefined
@@ -15020,25 +15224,37 @@ export interface Routes {
15020
15224
  is_temporary_manual_override_active?: boolean | undefined
15021
15225
  current_climate_setting?:
15022
15226
  | {
15227
+ /** Unique key to identify the climate preset. */
15023
15228
  climate_preset_key?: string | undefined
15229
+ /** Indicates whether this climate preset key can be edited. */
15024
15230
  can_edit?: boolean | undefined
15231
+ /** Indicates whether this climate preset key can be deleted. */
15025
15232
  can_delete?: boolean | undefined
15233
+ /** User-friendly name to identify the climate preset. */
15026
15234
  name?: ((string | null) | undefined) | undefined
15235
+ /** Display name for the climate preset. */
15027
15236
  display_name?: string | undefined
15237
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
15028
15238
  fan_mode_setting?:
15029
15239
  | (('auto' | 'on' | 'circulate') | undefined)
15030
15240
  | undefined
15241
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
15031
15242
  hvac_mode_setting?:
15032
15243
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
15033
15244
  | undefined
15245
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
15034
15246
  cooling_set_point_celsius?: (number | undefined) | undefined
15247
+ /** Temperature to which the thermostat should heat (in °C). */
15035
15248
  heating_set_point_celsius?: (number | undefined) | undefined
15249
+ /** Temperature to which the thermostat should cool (in °F). */
15036
15250
  cooling_set_point_fahrenheit?:
15037
15251
  | (number | undefined)
15038
15252
  | undefined
15253
+ /** Temperature to which the thermostat should heat (in °F). */
15039
15254
  heating_set_point_fahrenheit?:
15040
15255
  | (number | undefined)
15041
15256
  | undefined
15257
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
15042
15258
  manual_override_allowed?: boolean | undefined
15043
15259
  }
15044
15260
  | undefined
@@ -15046,58 +15262,90 @@ export interface Routes {
15046
15262
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
15047
15263
  default_climate_setting?:
15048
15264
  | {
15265
+ /** Unique key to identify the climate preset. */
15049
15266
  climate_preset_key?: string | undefined
15267
+ /** Indicates whether this climate preset key can be edited. */
15050
15268
  can_edit?: boolean | undefined
15269
+ /** Indicates whether this climate preset key can be deleted. */
15051
15270
  can_delete?: boolean | undefined
15271
+ /** User-friendly name to identify the climate preset. */
15052
15272
  name?: ((string | null) | undefined) | undefined
15273
+ /** Display name for the climate preset. */
15053
15274
  display_name?: string | undefined
15275
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
15054
15276
  fan_mode_setting?:
15055
15277
  | (('auto' | 'on' | 'circulate') | undefined)
15056
15278
  | undefined
15279
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
15057
15280
  hvac_mode_setting?:
15058
15281
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
15059
15282
  | undefined
15283
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
15060
15284
  cooling_set_point_celsius?: (number | undefined) | undefined
15285
+ /** Temperature to which the thermostat should heat (in °C). */
15061
15286
  heating_set_point_celsius?: (number | undefined) | undefined
15287
+ /** Temperature to which the thermostat should cool (in °F). */
15062
15288
  cooling_set_point_fahrenheit?:
15063
15289
  | (number | undefined)
15064
15290
  | undefined
15291
+ /** Temperature to which the thermostat should heat (in °F). */
15065
15292
  heating_set_point_fahrenheit?:
15066
15293
  | (number | undefined)
15067
15294
  | undefined
15295
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
15068
15296
  manual_override_allowed?: boolean | undefined
15069
15297
  }
15070
15298
  | undefined
15071
15299
  available_climate_presets?:
15072
15300
  | Array<{
15301
+ /** Unique key to identify the climate preset. */
15073
15302
  climate_preset_key: string
15303
+ /** Indicates whether this climate preset key can be edited. */
15074
15304
  can_edit: boolean
15305
+ /** Indicates whether this climate preset key can be deleted. */
15075
15306
  can_delete: boolean
15307
+ /** User-friendly name to identify the climate preset. */
15076
15308
  name?: (string | null) | undefined
15309
+ /** Display name for the climate preset. */
15077
15310
  display_name: string
15311
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
15078
15312
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
15313
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
15079
15314
  hvac_mode_setting?:
15080
15315
  | ('off' | 'heat' | 'cool' | 'heat_cool')
15081
15316
  | undefined
15317
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
15082
15318
  cooling_set_point_celsius?: number | undefined
15319
+ /** Temperature to which the thermostat should heat (in °C). */
15083
15320
  heating_set_point_celsius?: number | undefined
15321
+ /** Temperature to which the thermostat should cool (in °F). */
15084
15322
  cooling_set_point_fahrenheit?: number | undefined
15323
+ /** Temperature to which the thermostat should heat (in °F). */
15085
15324
  heating_set_point_fahrenheit?: number | undefined
15325
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
15086
15326
  manual_override_allowed: boolean
15087
15327
  }>
15088
15328
  | undefined
15089
15329
  fallback_climate_preset_key?: (string | null) | undefined
15090
15330
  active_thermostat_schedule?:
15091
15331
  | ({
15332
+ /** ID of the climate schedule. */
15092
15333
  thermostat_schedule_id: string
15334
+ /** ID of the desired thermostat device. */
15093
15335
  device_id: string
15336
+ /** User-friendly name to identify the climate schedule. */
15094
15337
  name?: string | undefined
15338
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
15095
15339
  climate_preset_key: string
15340
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
15096
15341
  max_override_period_minutes: number
15342
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15097
15343
  starts_at: string
15344
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15098
15345
  ends_at: string
15346
+ /** Date and time at which the climate schedule was created. */
15099
15347
  created_at: string
15100
- /** Collection of errors associated with the thermostat schedule, 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. */
15348
+ /** Array of errors associated with the climate schedule. 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. */
15101
15349
  errors?: any
15102
15350
  } | null)
15103
15351
  | undefined
@@ -15177,10 +15425,13 @@ export interface Routes {
15177
15425
  queryParams: {}
15178
15426
  jsonBody: {}
15179
15427
  commonParams: {
15180
- /** List all devices owned by this connected account */
15428
+ /** ID of the connected account by which to filter. */
15181
15429
  connected_account_id?: string | undefined
15430
+ /** Array of IDs of the connected accounts by which to filter devices. */
15182
15431
  connected_account_ids?: string[] | undefined
15432
+ /** ID of the Connect Webview by which to filter devices. */
15183
15433
  connect_webview_id?: string | undefined
15434
+ /** Device type by which to filter devices. */
15184
15435
  device_type?:
15185
15436
  | (
15186
15437
  | (
@@ -15222,6 +15473,7 @@ export interface Routes {
15222
15473
  | ('visionline_encoder' | 'assa_abloy_vostio_encoder')
15223
15474
  )
15224
15475
  | undefined
15476
+ /** Array of device types by which to filter devices. */
15225
15477
  device_types?:
15226
15478
  | Array<
15227
15479
  | (
@@ -15263,6 +15515,7 @@ export interface Routes {
15263
15515
  | ('visionline_encoder' | 'assa_abloy_vostio_encoder')
15264
15516
  >
15265
15517
  | undefined
15518
+ /** Manufacturer by which to filter devices. */
15266
15519
  manufacturer?:
15267
15520
  | (
15268
15521
  | 'akuvox'
@@ -15302,11 +15555,17 @@ export interface Routes {
15302
15555
  | 'akiles'
15303
15556
  )
15304
15557
  | undefined
15558
+ /** Array of device IDs by which to filter devices. */
15305
15559
  device_ids?: string[] | undefined
15560
+ /** Numerical limit on the number of devices to return. */
15306
15561
  limit?: number
15562
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
15307
15563
  created_before?: Date | undefined
15564
+ /** Your own internal user ID for the user by which to filter devices. */
15308
15565
  user_identifier_key?: string | undefined
15566
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
15309
15567
  custom_metadata_has?: Record<string, string | boolean> | undefined
15568
+ /** */
15310
15569
  include_if?:
15311
15570
  | Array<
15312
15571
  | 'can_remotely_unlock'
@@ -15322,6 +15581,7 @@ export interface Routes {
15322
15581
  | 'can_simulate_disconnection'
15323
15582
  >
15324
15583
  | undefined
15584
+ /** */
15325
15585
  exclude_if?:
15326
15586
  | Array<
15327
15587
  | 'can_remotely_unlock'
@@ -15837,25 +16097,37 @@ export interface Routes {
15837
16097
  is_temporary_manual_override_active?: boolean | undefined
15838
16098
  current_climate_setting?:
15839
16099
  | {
16100
+ /** Unique key to identify the climate preset. */
15840
16101
  climate_preset_key?: string | undefined
16102
+ /** Indicates whether this climate preset key can be edited. */
15841
16103
  can_edit?: boolean | undefined
16104
+ /** Indicates whether this climate preset key can be deleted. */
15842
16105
  can_delete?: boolean | undefined
16106
+ /** User-friendly name to identify the climate preset. */
15843
16107
  name?: ((string | null) | undefined) | undefined
16108
+ /** Display name for the climate preset. */
15844
16109
  display_name?: string | undefined
16110
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
15845
16111
  fan_mode_setting?:
15846
16112
  | (('auto' | 'on' | 'circulate') | undefined)
15847
16113
  | undefined
16114
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
15848
16115
  hvac_mode_setting?:
15849
16116
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
15850
16117
  | undefined
16118
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
15851
16119
  cooling_set_point_celsius?: (number | undefined) | undefined
16120
+ /** Temperature to which the thermostat should heat (in °C). */
15852
16121
  heating_set_point_celsius?: (number | undefined) | undefined
16122
+ /** Temperature to which the thermostat should cool (in °F). */
15853
16123
  cooling_set_point_fahrenheit?:
15854
16124
  | (number | undefined)
15855
16125
  | undefined
16126
+ /** Temperature to which the thermostat should heat (in °F). */
15856
16127
  heating_set_point_fahrenheit?:
15857
16128
  | (number | undefined)
15858
16129
  | undefined
16130
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
15859
16131
  manual_override_allowed?: boolean | undefined
15860
16132
  }
15861
16133
  | undefined
@@ -15863,58 +16135,90 @@ export interface Routes {
15863
16135
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
15864
16136
  default_climate_setting?:
15865
16137
  | {
16138
+ /** Unique key to identify the climate preset. */
15866
16139
  climate_preset_key?: string | undefined
16140
+ /** Indicates whether this climate preset key can be edited. */
15867
16141
  can_edit?: boolean | undefined
16142
+ /** Indicates whether this climate preset key can be deleted. */
15868
16143
  can_delete?: boolean | undefined
16144
+ /** User-friendly name to identify the climate preset. */
15869
16145
  name?: ((string | null) | undefined) | undefined
16146
+ /** Display name for the climate preset. */
15870
16147
  display_name?: string | undefined
16148
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
15871
16149
  fan_mode_setting?:
15872
16150
  | (('auto' | 'on' | 'circulate') | undefined)
15873
16151
  | undefined
16152
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
15874
16153
  hvac_mode_setting?:
15875
16154
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
15876
16155
  | undefined
16156
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
15877
16157
  cooling_set_point_celsius?: (number | undefined) | undefined
16158
+ /** Temperature to which the thermostat should heat (in °C). */
15878
16159
  heating_set_point_celsius?: (number | undefined) | undefined
16160
+ /** Temperature to which the thermostat should cool (in °F). */
15879
16161
  cooling_set_point_fahrenheit?:
15880
16162
  | (number | undefined)
15881
16163
  | undefined
16164
+ /** Temperature to which the thermostat should heat (in °F). */
15882
16165
  heating_set_point_fahrenheit?:
15883
16166
  | (number | undefined)
15884
16167
  | undefined
16168
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
15885
16169
  manual_override_allowed?: boolean | undefined
15886
16170
  }
15887
16171
  | undefined
15888
16172
  available_climate_presets?:
15889
16173
  | Array<{
16174
+ /** Unique key to identify the climate preset. */
15890
16175
  climate_preset_key: string
16176
+ /** Indicates whether this climate preset key can be edited. */
15891
16177
  can_edit: boolean
16178
+ /** Indicates whether this climate preset key can be deleted. */
15892
16179
  can_delete: boolean
16180
+ /** User-friendly name to identify the climate preset. */
15893
16181
  name?: (string | null) | undefined
16182
+ /** Display name for the climate preset. */
15894
16183
  display_name: string
16184
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
15895
16185
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
16186
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
15896
16187
  hvac_mode_setting?:
15897
16188
  | ('off' | 'heat' | 'cool' | 'heat_cool')
15898
16189
  | undefined
16190
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
15899
16191
  cooling_set_point_celsius?: number | undefined
16192
+ /** Temperature to which the thermostat should heat (in °C). */
15900
16193
  heating_set_point_celsius?: number | undefined
16194
+ /** Temperature to which the thermostat should cool (in °F). */
15901
16195
  cooling_set_point_fahrenheit?: number | undefined
16196
+ /** Temperature to which the thermostat should heat (in °F). */
15902
16197
  heating_set_point_fahrenheit?: number | undefined
16198
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
15903
16199
  manual_override_allowed: boolean
15904
16200
  }>
15905
16201
  | undefined
15906
16202
  fallback_climate_preset_key?: (string | null) | undefined
15907
16203
  active_thermostat_schedule?:
15908
16204
  | ({
16205
+ /** ID of the climate schedule. */
15909
16206
  thermostat_schedule_id: string
16207
+ /** ID of the desired thermostat device. */
15910
16208
  device_id: string
16209
+ /** User-friendly name to identify the climate schedule. */
15911
16210
  name?: string | undefined
16211
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
15912
16212
  climate_preset_key: string
16213
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
15913
16214
  max_override_period_minutes: number
16215
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15914
16216
  starts_at: string
16217
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15915
16218
  ends_at: string
16219
+ /** Date and time at which the climate schedule was created. */
15916
16220
  created_at: string
15917
- /** Collection of errors associated with the thermostat schedule, 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. */
16221
+ /** Array of errors associated with the climate schedule. 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. */
15918
16222
  errors?: any
15919
16223
  } | null)
15920
16224
  | undefined
@@ -16483,25 +16787,37 @@ export interface Routes {
16483
16787
  is_temporary_manual_override_active?: boolean | undefined
16484
16788
  current_climate_setting?:
16485
16789
  | {
16790
+ /** Unique key to identify the climate preset. */
16486
16791
  climate_preset_key?: string | undefined
16792
+ /** Indicates whether this climate preset key can be edited. */
16487
16793
  can_edit?: boolean | undefined
16794
+ /** Indicates whether this climate preset key can be deleted. */
16488
16795
  can_delete?: boolean | undefined
16796
+ /** User-friendly name to identify the climate preset. */
16489
16797
  name?: ((string | null) | undefined) | undefined
16798
+ /** Display name for the climate preset. */
16490
16799
  display_name?: string | undefined
16800
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
16491
16801
  fan_mode_setting?:
16492
16802
  | (('auto' | 'on' | 'circulate') | undefined)
16493
16803
  | undefined
16804
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
16494
16805
  hvac_mode_setting?:
16495
16806
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
16496
16807
  | undefined
16808
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
16497
16809
  cooling_set_point_celsius?: (number | undefined) | undefined
16810
+ /** Temperature to which the thermostat should heat (in °C). */
16498
16811
  heating_set_point_celsius?: (number | undefined) | undefined
16812
+ /** Temperature to which the thermostat should cool (in °F). */
16499
16813
  cooling_set_point_fahrenheit?:
16500
16814
  | (number | undefined)
16501
16815
  | undefined
16816
+ /** Temperature to which the thermostat should heat (in °F). */
16502
16817
  heating_set_point_fahrenheit?:
16503
16818
  | (number | undefined)
16504
16819
  | undefined
16820
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
16505
16821
  manual_override_allowed?: boolean | undefined
16506
16822
  }
16507
16823
  | undefined
@@ -16509,58 +16825,90 @@ export interface Routes {
16509
16825
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
16510
16826
  default_climate_setting?:
16511
16827
  | {
16828
+ /** Unique key to identify the climate preset. */
16512
16829
  climate_preset_key?: string | undefined
16830
+ /** Indicates whether this climate preset key can be edited. */
16513
16831
  can_edit?: boolean | undefined
16832
+ /** Indicates whether this climate preset key can be deleted. */
16514
16833
  can_delete?: boolean | undefined
16834
+ /** User-friendly name to identify the climate preset. */
16515
16835
  name?: ((string | null) | undefined) | undefined
16836
+ /** Display name for the climate preset. */
16516
16837
  display_name?: string | undefined
16838
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
16517
16839
  fan_mode_setting?:
16518
16840
  | (('auto' | 'on' | 'circulate') | undefined)
16519
16841
  | undefined
16842
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
16520
16843
  hvac_mode_setting?:
16521
16844
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
16522
16845
  | undefined
16846
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
16523
16847
  cooling_set_point_celsius?: (number | undefined) | undefined
16848
+ /** Temperature to which the thermostat should heat (in °C). */
16524
16849
  heating_set_point_celsius?: (number | undefined) | undefined
16850
+ /** Temperature to which the thermostat should cool (in °F). */
16525
16851
  cooling_set_point_fahrenheit?:
16526
16852
  | (number | undefined)
16527
16853
  | undefined
16854
+ /** Temperature to which the thermostat should heat (in °F). */
16528
16855
  heating_set_point_fahrenheit?:
16529
16856
  | (number | undefined)
16530
16857
  | undefined
16858
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
16531
16859
  manual_override_allowed?: boolean | undefined
16532
16860
  }
16533
16861
  | undefined
16534
16862
  available_climate_presets?:
16535
16863
  | Array<{
16864
+ /** Unique key to identify the climate preset. */
16536
16865
  climate_preset_key: string
16866
+ /** Indicates whether this climate preset key can be edited. */
16537
16867
  can_edit: boolean
16868
+ /** Indicates whether this climate preset key can be deleted. */
16538
16869
  can_delete: boolean
16870
+ /** User-friendly name to identify the climate preset. */
16539
16871
  name?: (string | null) | undefined
16872
+ /** Display name for the climate preset. */
16540
16873
  display_name: string
16874
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
16541
16875
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
16876
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
16542
16877
  hvac_mode_setting?:
16543
16878
  | ('off' | 'heat' | 'cool' | 'heat_cool')
16544
16879
  | undefined
16880
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
16545
16881
  cooling_set_point_celsius?: number | undefined
16882
+ /** Temperature to which the thermostat should heat (in °C). */
16546
16883
  heating_set_point_celsius?: number | undefined
16884
+ /** Temperature to which the thermostat should cool (in °F). */
16547
16885
  cooling_set_point_fahrenheit?: number | undefined
16886
+ /** Temperature to which the thermostat should heat (in °F). */
16548
16887
  heating_set_point_fahrenheit?: number | undefined
16888
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
16549
16889
  manual_override_allowed: boolean
16550
16890
  }>
16551
16891
  | undefined
16552
16892
  fallback_climate_preset_key?: (string | null) | undefined
16553
16893
  active_thermostat_schedule?:
16554
16894
  | ({
16895
+ /** ID of the climate schedule. */
16555
16896
  thermostat_schedule_id: string
16897
+ /** ID of the desired thermostat device. */
16556
16898
  device_id: string
16899
+ /** User-friendly name to identify the climate schedule. */
16557
16900
  name?: string | undefined
16901
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
16558
16902
  climate_preset_key: string
16903
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
16559
16904
  max_override_period_minutes: number
16905
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
16560
16906
  starts_at: string
16907
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
16561
16908
  ends_at: string
16909
+ /** Date and time at which the climate schedule was created. */
16562
16910
  created_at: string
16563
- /** Collection of errors associated with the thermostat schedule, 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. */
16911
+ /** Array of errors associated with the climate schedule. 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. */
16564
16912
  errors?: any
16565
16913
  } | null)
16566
16914
  | undefined
@@ -18392,10 +18740,13 @@ export interface Routes {
18392
18740
  queryParams: {}
18393
18741
  jsonBody: {}
18394
18742
  commonParams: {
18395
- /** List all devices owned by this connected account */
18743
+ /** ID of the connected account by which to filter. */
18396
18744
  connected_account_id?: string | undefined
18745
+ /** Array of IDs of the connected accounts by which to filter devices. */
18397
18746
  connected_account_ids?: string[] | undefined
18747
+ /** ID of the Connect Webview by which to filter devices. */
18398
18748
  connect_webview_id?: string | undefined
18749
+ /** Device type by which to filter devices. */
18399
18750
  device_type?:
18400
18751
  | (
18401
18752
  | (
@@ -18437,6 +18788,7 @@ export interface Routes {
18437
18788
  | ('visionline_encoder' | 'assa_abloy_vostio_encoder')
18438
18789
  )
18439
18790
  | undefined
18791
+ /** Array of device types by which to filter devices. */
18440
18792
  device_types?:
18441
18793
  | Array<
18442
18794
  | (
@@ -18478,6 +18830,7 @@ export interface Routes {
18478
18830
  | ('visionline_encoder' | 'assa_abloy_vostio_encoder')
18479
18831
  >
18480
18832
  | undefined
18833
+ /** Manufacturer by which to filter devices. */
18481
18834
  manufacturer?:
18482
18835
  | (
18483
18836
  | 'akuvox'
@@ -18517,11 +18870,17 @@ export interface Routes {
18517
18870
  | 'akiles'
18518
18871
  )
18519
18872
  | undefined
18873
+ /** Array of device IDs by which to filter devices. */
18520
18874
  device_ids?: string[] | undefined
18875
+ /** Numerical limit on the number of devices to return. */
18521
18876
  limit?: number
18877
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
18522
18878
  created_before?: Date | undefined
18879
+ /** Your own internal user ID for the user by which to filter devices. */
18523
18880
  user_identifier_key?: string | undefined
18881
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
18524
18882
  custom_metadata_has?: Record<string, string | boolean> | undefined
18883
+ /** */
18525
18884
  include_if?:
18526
18885
  | Array<
18527
18886
  | 'can_remotely_unlock'
@@ -18537,6 +18896,7 @@ export interface Routes {
18537
18896
  | 'can_simulate_disconnection'
18538
18897
  >
18539
18898
  | undefined
18899
+ /** */
18540
18900
  exclude_if?:
18541
18901
  | Array<
18542
18902
  | 'can_remotely_unlock'
@@ -19052,25 +19412,37 @@ export interface Routes {
19052
19412
  is_temporary_manual_override_active?: boolean | undefined
19053
19413
  current_climate_setting?:
19054
19414
  | {
19415
+ /** Unique key to identify the climate preset. */
19055
19416
  climate_preset_key?: string | undefined
19417
+ /** Indicates whether this climate preset key can be edited. */
19056
19418
  can_edit?: boolean | undefined
19419
+ /** Indicates whether this climate preset key can be deleted. */
19057
19420
  can_delete?: boolean | undefined
19421
+ /** User-friendly name to identify the climate preset. */
19058
19422
  name?: ((string | null) | undefined) | undefined
19423
+ /** Display name for the climate preset. */
19059
19424
  display_name?: string | undefined
19425
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
19060
19426
  fan_mode_setting?:
19061
19427
  | (('auto' | 'on' | 'circulate') | undefined)
19062
19428
  | undefined
19429
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
19063
19430
  hvac_mode_setting?:
19064
19431
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
19065
19432
  | undefined
19433
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
19066
19434
  cooling_set_point_celsius?: (number | undefined) | undefined
19435
+ /** Temperature to which the thermostat should heat (in °C). */
19067
19436
  heating_set_point_celsius?: (number | undefined) | undefined
19437
+ /** Temperature to which the thermostat should cool (in °F). */
19068
19438
  cooling_set_point_fahrenheit?:
19069
19439
  | (number | undefined)
19070
19440
  | undefined
19441
+ /** Temperature to which the thermostat should heat (in °F). */
19071
19442
  heating_set_point_fahrenheit?:
19072
19443
  | (number | undefined)
19073
19444
  | undefined
19445
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
19074
19446
  manual_override_allowed?: boolean | undefined
19075
19447
  }
19076
19448
  | undefined
@@ -19078,58 +19450,90 @@ export interface Routes {
19078
19450
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
19079
19451
  default_climate_setting?:
19080
19452
  | {
19453
+ /** Unique key to identify the climate preset. */
19081
19454
  climate_preset_key?: string | undefined
19455
+ /** Indicates whether this climate preset key can be edited. */
19082
19456
  can_edit?: boolean | undefined
19457
+ /** Indicates whether this climate preset key can be deleted. */
19083
19458
  can_delete?: boolean | undefined
19459
+ /** User-friendly name to identify the climate preset. */
19084
19460
  name?: ((string | null) | undefined) | undefined
19461
+ /** Display name for the climate preset. */
19085
19462
  display_name?: string | undefined
19463
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
19086
19464
  fan_mode_setting?:
19087
19465
  | (('auto' | 'on' | 'circulate') | undefined)
19088
19466
  | undefined
19467
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
19089
19468
  hvac_mode_setting?:
19090
19469
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
19091
19470
  | undefined
19471
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
19092
19472
  cooling_set_point_celsius?: (number | undefined) | undefined
19473
+ /** Temperature to which the thermostat should heat (in °C). */
19093
19474
  heating_set_point_celsius?: (number | undefined) | undefined
19475
+ /** Temperature to which the thermostat should cool (in °F). */
19094
19476
  cooling_set_point_fahrenheit?:
19095
19477
  | (number | undefined)
19096
19478
  | undefined
19479
+ /** Temperature to which the thermostat should heat (in °F). */
19097
19480
  heating_set_point_fahrenheit?:
19098
19481
  | (number | undefined)
19099
19482
  | undefined
19483
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
19100
19484
  manual_override_allowed?: boolean | undefined
19101
19485
  }
19102
19486
  | undefined
19103
19487
  available_climate_presets?:
19104
19488
  | Array<{
19489
+ /** Unique key to identify the climate preset. */
19105
19490
  climate_preset_key: string
19491
+ /** Indicates whether this climate preset key can be edited. */
19106
19492
  can_edit: boolean
19493
+ /** Indicates whether this climate preset key can be deleted. */
19107
19494
  can_delete: boolean
19495
+ /** User-friendly name to identify the climate preset. */
19108
19496
  name?: (string | null) | undefined
19497
+ /** Display name for the climate preset. */
19109
19498
  display_name: string
19499
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
19110
19500
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
19501
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
19111
19502
  hvac_mode_setting?:
19112
19503
  | ('off' | 'heat' | 'cool' | 'heat_cool')
19113
19504
  | undefined
19505
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
19114
19506
  cooling_set_point_celsius?: number | undefined
19507
+ /** Temperature to which the thermostat should heat (in °C). */
19115
19508
  heating_set_point_celsius?: number | undefined
19509
+ /** Temperature to which the thermostat should cool (in °F). */
19116
19510
  cooling_set_point_fahrenheit?: number | undefined
19511
+ /** Temperature to which the thermostat should heat (in °F). */
19117
19512
  heating_set_point_fahrenheit?: number | undefined
19513
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
19118
19514
  manual_override_allowed: boolean
19119
19515
  }>
19120
19516
  | undefined
19121
19517
  fallback_climate_preset_key?: (string | null) | undefined
19122
19518
  active_thermostat_schedule?:
19123
19519
  | ({
19520
+ /** ID of the climate schedule. */
19124
19521
  thermostat_schedule_id: string
19522
+ /** ID of the desired thermostat device. */
19125
19523
  device_id: string
19524
+ /** User-friendly name to identify the climate schedule. */
19126
19525
  name?: string | undefined
19526
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
19127
19527
  climate_preset_key: string
19528
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
19128
19529
  max_override_period_minutes: number
19530
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19129
19531
  starts_at: string
19532
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19130
19533
  ends_at: string
19534
+ /** Date and time at which the climate schedule was created. */
19131
19535
  created_at: string
19132
- /** Collection of errors associated with the thermostat schedule, 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. */
19536
+ /** Array of errors associated with the climate schedule. 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. */
19133
19537
  errors?: any
19134
19538
  } | null)
19135
19539
  | undefined
@@ -19698,25 +20102,37 @@ export interface Routes {
19698
20102
  is_temporary_manual_override_active?: boolean | undefined
19699
20103
  current_climate_setting?:
19700
20104
  | {
20105
+ /** Unique key to identify the climate preset. */
19701
20106
  climate_preset_key?: string | undefined
20107
+ /** Indicates whether this climate preset key can be edited. */
19702
20108
  can_edit?: boolean | undefined
20109
+ /** Indicates whether this climate preset key can be deleted. */
19703
20110
  can_delete?: boolean | undefined
20111
+ /** User-friendly name to identify the climate preset. */
19704
20112
  name?: ((string | null) | undefined) | undefined
20113
+ /** Display name for the climate preset. */
19705
20114
  display_name?: string | undefined
20115
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
19706
20116
  fan_mode_setting?:
19707
20117
  | (('auto' | 'on' | 'circulate') | undefined)
19708
20118
  | undefined
20119
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
19709
20120
  hvac_mode_setting?:
19710
20121
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
19711
20122
  | undefined
20123
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
19712
20124
  cooling_set_point_celsius?: (number | undefined) | undefined
20125
+ /** Temperature to which the thermostat should heat (in °C). */
19713
20126
  heating_set_point_celsius?: (number | undefined) | undefined
20127
+ /** Temperature to which the thermostat should cool (in °F). */
19714
20128
  cooling_set_point_fahrenheit?:
19715
20129
  | (number | undefined)
19716
20130
  | undefined
20131
+ /** Temperature to which the thermostat should heat (in °F). */
19717
20132
  heating_set_point_fahrenheit?:
19718
20133
  | (number | undefined)
19719
20134
  | undefined
20135
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
19720
20136
  manual_override_allowed?: boolean | undefined
19721
20137
  }
19722
20138
  | undefined
@@ -19724,58 +20140,90 @@ export interface Routes {
19724
20140
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
19725
20141
  default_climate_setting?:
19726
20142
  | {
20143
+ /** Unique key to identify the climate preset. */
19727
20144
  climate_preset_key?: string | undefined
20145
+ /** Indicates whether this climate preset key can be edited. */
19728
20146
  can_edit?: boolean | undefined
20147
+ /** Indicates whether this climate preset key can be deleted. */
19729
20148
  can_delete?: boolean | undefined
20149
+ /** User-friendly name to identify the climate preset. */
19730
20150
  name?: ((string | null) | undefined) | undefined
20151
+ /** Display name for the climate preset. */
19731
20152
  display_name?: string | undefined
20153
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
19732
20154
  fan_mode_setting?:
19733
20155
  | (('auto' | 'on' | 'circulate') | undefined)
19734
20156
  | undefined
20157
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
19735
20158
  hvac_mode_setting?:
19736
20159
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
19737
20160
  | undefined
20161
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
19738
20162
  cooling_set_point_celsius?: (number | undefined) | undefined
20163
+ /** Temperature to which the thermostat should heat (in °C). */
19739
20164
  heating_set_point_celsius?: (number | undefined) | undefined
20165
+ /** Temperature to which the thermostat should cool (in °F). */
19740
20166
  cooling_set_point_fahrenheit?:
19741
20167
  | (number | undefined)
19742
20168
  | undefined
20169
+ /** Temperature to which the thermostat should heat (in °F). */
19743
20170
  heating_set_point_fahrenheit?:
19744
20171
  | (number | undefined)
19745
20172
  | undefined
20173
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
19746
20174
  manual_override_allowed?: boolean | undefined
19747
20175
  }
19748
20176
  | undefined
19749
20177
  available_climate_presets?:
19750
20178
  | Array<{
20179
+ /** Unique key to identify the climate preset. */
19751
20180
  climate_preset_key: string
20181
+ /** Indicates whether this climate preset key can be edited. */
19752
20182
  can_edit: boolean
20183
+ /** Indicates whether this climate preset key can be deleted. */
19753
20184
  can_delete: boolean
20185
+ /** User-friendly name to identify the climate preset. */
19754
20186
  name?: (string | null) | undefined
20187
+ /** Display name for the climate preset. */
19755
20188
  display_name: string
20189
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
19756
20190
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
20191
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
19757
20192
  hvac_mode_setting?:
19758
20193
  | ('off' | 'heat' | 'cool' | 'heat_cool')
19759
20194
  | undefined
20195
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
19760
20196
  cooling_set_point_celsius?: number | undefined
20197
+ /** Temperature to which the thermostat should heat (in °C). */
19761
20198
  heating_set_point_celsius?: number | undefined
20199
+ /** Temperature to which the thermostat should cool (in °F). */
19762
20200
  cooling_set_point_fahrenheit?: number | undefined
20201
+ /** Temperature to which the thermostat should heat (in °F). */
19763
20202
  heating_set_point_fahrenheit?: number | undefined
20203
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
19764
20204
  manual_override_allowed: boolean
19765
20205
  }>
19766
20206
  | undefined
19767
20207
  fallback_climate_preset_key?: (string | null) | undefined
19768
20208
  active_thermostat_schedule?:
19769
20209
  | ({
20210
+ /** ID of the climate schedule. */
19770
20211
  thermostat_schedule_id: string
20212
+ /** ID of the desired thermostat device. */
19771
20213
  device_id: string
20214
+ /** User-friendly name to identify the climate schedule. */
19772
20215
  name?: string | undefined
20216
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
19773
20217
  climate_preset_key: string
20218
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
19774
20219
  max_override_period_minutes: number
20220
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19775
20221
  starts_at: string
20222
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19776
20223
  ends_at: string
20224
+ /** Date and time at which the climate schedule was created. */
19777
20225
  created_at: string
19778
- /** Collection of errors associated with the thermostat schedule, 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. */
20226
+ /** Array of errors associated with the climate schedule. 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. */
19779
20227
  errors?: any
19780
20228
  } | null)
19781
20229
  | undefined
@@ -22701,7 +23149,9 @@ export interface Routes {
22701
23149
  method: 'POST'
22702
23150
  queryParams: {}
22703
23151
  jsonBody: {
23152
+ /** ID of the desired thermostat device. */
22704
23153
  device_id: string
23154
+ /** Climate preset key of the desired climate preset. */
22705
23155
  climate_preset_key: string
22706
23156
  }
22707
23157
  commonParams: {}
@@ -23560,12 +24010,13 @@ export interface Routes {
23560
24010
  method: 'POST'
23561
24011
  queryParams: {}
23562
24012
  jsonBody: {
23563
- /** ID of the thermostat device. */
24013
+ /** ID of the desired thermostat device. */
23564
24014
  device_id: string
23565
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
24015
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
23566
24016
  cooling_set_point_celsius?: number | undefined
23567
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °F). You must set one of the `cooling_set_point` parameters. */
24017
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
23568
24018
  cooling_set_point_fahrenheit?: number | undefined
24019
+ /** */
23569
24020
  sync?: boolean
23570
24021
  }
23571
24022
  commonParams: {}
@@ -24424,15 +24875,25 @@ export interface Routes {
24424
24875
  method: 'POST'
24425
24876
  queryParams: {}
24426
24877
  jsonBody: {
24878
+ /** ID of the desired thermostat device. */
24427
24879
  device_id: string
24880
+ /** Unique key to identify the climate preset. */
24428
24881
  climate_preset_key: string
24882
+ /** User-friendly name to identify the climate preset. */
24429
24883
  name?: (string | null) | undefined
24884
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
24430
24885
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
24886
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
24431
24887
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
24888
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
24432
24889
  cooling_set_point_celsius?: number | undefined
24890
+ /** Temperature to which the thermostat should heat (in °C). */
24433
24891
  heating_set_point_celsius?: number | undefined
24892
+ /** Temperature to which the thermostat should cool (in °F). */
24434
24893
  cooling_set_point_fahrenheit?: number | undefined
24894
+ /** Temperature to which the thermostat should heat (in °F). */
24435
24895
  heating_set_point_fahrenheit?: number | undefined
24896
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
24436
24897
  manual_override_allowed: boolean
24437
24898
  }
24438
24899
  commonParams: {}
@@ -24444,7 +24905,9 @@ export interface Routes {
24444
24905
  method: 'POST' | 'DELETE'
24445
24906
  queryParams: {}
24446
24907
  jsonBody: {
24908
+ /** ID of the desired thermostat device. */
24447
24909
  device_id: string
24910
+ /** Climate preset key of the desired climate preset. */
24448
24911
  climate_preset_key: string
24449
24912
  }
24450
24913
  commonParams: {}
@@ -24457,9 +24920,9 @@ export interface Routes {
24457
24920
  queryParams: {}
24458
24921
  jsonBody: {}
24459
24922
  commonParams: {
24460
- /** ID of the thermostat device. */
24923
+ /** ID of the desired thermostat device. */
24461
24924
  device_id?: string | undefined
24462
- /** Name of the thermostat. */
24925
+ /** User-friendly name of the desired thermostat device. */
24463
24926
  name?: string | undefined
24464
24927
  }
24465
24928
  formData: {}
@@ -24961,25 +25424,37 @@ export interface Routes {
24961
25424
  is_temporary_manual_override_active?: boolean | undefined
24962
25425
  current_climate_setting?:
24963
25426
  | {
25427
+ /** Unique key to identify the climate preset. */
24964
25428
  climate_preset_key?: string | undefined
25429
+ /** Indicates whether this climate preset key can be edited. */
24965
25430
  can_edit?: boolean | undefined
25431
+ /** Indicates whether this climate preset key can be deleted. */
24966
25432
  can_delete?: boolean | undefined
25433
+ /** User-friendly name to identify the climate preset. */
24967
25434
  name?: ((string | null) | undefined) | undefined
25435
+ /** Display name for the climate preset. */
24968
25436
  display_name?: string | undefined
25437
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
24969
25438
  fan_mode_setting?:
24970
25439
  | (('auto' | 'on' | 'circulate') | undefined)
24971
25440
  | undefined
25441
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
24972
25442
  hvac_mode_setting?:
24973
25443
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
24974
25444
  | undefined
25445
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
24975
25446
  cooling_set_point_celsius?: (number | undefined) | undefined
25447
+ /** Temperature to which the thermostat should heat (in °C). */
24976
25448
  heating_set_point_celsius?: (number | undefined) | undefined
25449
+ /** Temperature to which the thermostat should cool (in °F). */
24977
25450
  cooling_set_point_fahrenheit?:
24978
25451
  | (number | undefined)
24979
25452
  | undefined
25453
+ /** Temperature to which the thermostat should heat (in °F). */
24980
25454
  heating_set_point_fahrenheit?:
24981
25455
  | (number | undefined)
24982
25456
  | undefined
25457
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
24983
25458
  manual_override_allowed?: boolean | undefined
24984
25459
  }
24985
25460
  | undefined
@@ -24987,58 +25462,90 @@ export interface Routes {
24987
25462
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
24988
25463
  default_climate_setting?:
24989
25464
  | {
25465
+ /** Unique key to identify the climate preset. */
24990
25466
  climate_preset_key?: string | undefined
25467
+ /** Indicates whether this climate preset key can be edited. */
24991
25468
  can_edit?: boolean | undefined
25469
+ /** Indicates whether this climate preset key can be deleted. */
24992
25470
  can_delete?: boolean | undefined
25471
+ /** User-friendly name to identify the climate preset. */
24993
25472
  name?: ((string | null) | undefined) | undefined
25473
+ /** Display name for the climate preset. */
24994
25474
  display_name?: string | undefined
25475
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
24995
25476
  fan_mode_setting?:
24996
25477
  | (('auto' | 'on' | 'circulate') | undefined)
24997
25478
  | undefined
25479
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
24998
25480
  hvac_mode_setting?:
24999
25481
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
25000
25482
  | undefined
25483
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
25001
25484
  cooling_set_point_celsius?: (number | undefined) | undefined
25485
+ /** Temperature to which the thermostat should heat (in °C). */
25002
25486
  heating_set_point_celsius?: (number | undefined) | undefined
25487
+ /** Temperature to which the thermostat should cool (in °F). */
25003
25488
  cooling_set_point_fahrenheit?:
25004
25489
  | (number | undefined)
25005
25490
  | undefined
25491
+ /** Temperature to which the thermostat should heat (in °F). */
25006
25492
  heating_set_point_fahrenheit?:
25007
25493
  | (number | undefined)
25008
25494
  | undefined
25495
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
25009
25496
  manual_override_allowed?: boolean | undefined
25010
25497
  }
25011
25498
  | undefined
25012
25499
  available_climate_presets?:
25013
25500
  | Array<{
25501
+ /** Unique key to identify the climate preset. */
25014
25502
  climate_preset_key: string
25503
+ /** Indicates whether this climate preset key can be edited. */
25015
25504
  can_edit: boolean
25505
+ /** Indicates whether this climate preset key can be deleted. */
25016
25506
  can_delete: boolean
25507
+ /** User-friendly name to identify the climate preset. */
25017
25508
  name?: (string | null) | undefined
25509
+ /** Display name for the climate preset. */
25018
25510
  display_name: string
25511
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
25019
25512
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
25513
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
25020
25514
  hvac_mode_setting?:
25021
25515
  | ('off' | 'heat' | 'cool' | 'heat_cool')
25022
25516
  | undefined
25517
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
25023
25518
  cooling_set_point_celsius?: number | undefined
25519
+ /** Temperature to which the thermostat should heat (in °C). */
25024
25520
  heating_set_point_celsius?: number | undefined
25521
+ /** Temperature to which the thermostat should cool (in °F). */
25025
25522
  cooling_set_point_fahrenheit?: number | undefined
25523
+ /** Temperature to which the thermostat should heat (in °F). */
25026
25524
  heating_set_point_fahrenheit?: number | undefined
25525
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
25027
25526
  manual_override_allowed: boolean
25028
25527
  }>
25029
25528
  | undefined
25030
25529
  fallback_climate_preset_key?: (string | null) | undefined
25031
25530
  active_thermostat_schedule?:
25032
25531
  | ({
25532
+ /** ID of the climate schedule. */
25033
25533
  thermostat_schedule_id: string
25534
+ /** ID of the desired thermostat device. */
25034
25535
  device_id: string
25536
+ /** User-friendly name to identify the climate schedule. */
25035
25537
  name?: string | undefined
25538
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
25036
25539
  climate_preset_key: string
25540
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
25037
25541
  max_override_period_minutes: number
25542
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25038
25543
  starts_at: string
25544
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25039
25545
  ends_at: string
25546
+ /** Date and time at which the climate schedule was created. */
25040
25547
  created_at: string
25041
- /** Collection of errors associated with the thermostat schedule, 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. */
25548
+ /** Array of errors associated with the climate schedule. 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. */
25042
25549
  errors?: any
25043
25550
  } | null)
25044
25551
  | undefined
@@ -25117,12 +25624,13 @@ export interface Routes {
25117
25624
  method: 'POST'
25118
25625
  queryParams: {}
25119
25626
  jsonBody: {
25120
- /** ID of the thermostat device. */
25627
+ /** ID of the desired thermostat device. */
25121
25628
  device_id: string
25122
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
25629
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
25123
25630
  heating_set_point_celsius?: number | undefined
25124
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °F). You must set one of the `heating_set_point` parameters. */
25631
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
25125
25632
  heating_set_point_fahrenheit?: number | undefined
25633
+ /** */
25126
25634
  sync?: boolean
25127
25635
  }
25128
25636
  commonParams: {}
@@ -25981,16 +26489,17 @@ export interface Routes {
25981
26489
  method: 'POST'
25982
26490
  queryParams: {}
25983
26491
  jsonBody: {
25984
- /** ID of the thermostat device. */
26492
+ /** ID of the desired thermostat device. */
25985
26493
  device_id: string
25986
- /** Temperature to which the HVAC system connected to the thermostat should heat (in °C). You must set one of the `heating_set_point` parameters. */
26494
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
25987
26495
  heating_set_point_celsius?: number | undefined
25988
- /** Temperature the thermostat should heat to (in °F). You must set one of the heating_set_point parameters. */
26496
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
25989
26497
  heating_set_point_fahrenheit?: number | undefined
25990
- /** Temperature to which the HVAC system connected to the thermostat should cool (in °C). You must set one of the `cooling_set_point` parameters. */
26498
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
25991
26499
  cooling_set_point_celsius?: number | undefined
25992
- /** Temperature the thermostat should cool to (in °F). You must set one of the cooling_set_point parameters. */
26500
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
25993
26501
  cooling_set_point_fahrenheit?: number | undefined
26502
+ /** */
25994
26503
  sync?: boolean
25995
26504
  }
25996
26505
  commonParams: {}
@@ -26850,10 +27359,13 @@ export interface Routes {
26850
27359
  queryParams: {}
26851
27360
  jsonBody: {}
26852
27361
  commonParams: {
26853
- /** List all devices owned by this connected account */
27362
+ /** ID of the connected account by which to filter. */
26854
27363
  connected_account_id?: string | undefined
27364
+ /** Array of IDs of the connected accounts by which to filter devices. */
26855
27365
  connected_account_ids?: string[] | undefined
27366
+ /** ID of the Connect Webview by which to filter devices. */
26856
27367
  connect_webview_id?: string | undefined
27368
+ /** Device type by which to filter devices. */
26857
27369
  device_type?:
26858
27370
  | (
26859
27371
  | (
@@ -26895,6 +27407,7 @@ export interface Routes {
26895
27407
  | ('visionline_encoder' | 'assa_abloy_vostio_encoder')
26896
27408
  )
26897
27409
  | undefined
27410
+ /** Array of device types by which to filter devices. */
26898
27411
  device_types?:
26899
27412
  | Array<
26900
27413
  | (
@@ -26936,6 +27449,7 @@ export interface Routes {
26936
27449
  | ('visionline_encoder' | 'assa_abloy_vostio_encoder')
26937
27450
  >
26938
27451
  | undefined
27452
+ /** Manufacturer by which to filter devices. */
26939
27453
  manufacturer?:
26940
27454
  | (
26941
27455
  | 'akuvox'
@@ -26975,11 +27489,17 @@ export interface Routes {
26975
27489
  | 'akiles'
26976
27490
  )
26977
27491
  | undefined
27492
+ /** Array of device IDs by which to filter devices. */
26978
27493
  device_ids?: string[] | undefined
27494
+ /** Numerical limit on the number of devices to return. */
26979
27495
  limit?: number
27496
+ /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
26980
27497
  created_before?: Date | undefined
27498
+ /** Your own internal user ID for the user by which to filter devices. */
26981
27499
  user_identifier_key?: string | undefined
27500
+ /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
26982
27501
  custom_metadata_has?: Record<string, string | boolean> | undefined
27502
+ /** */
26983
27503
  include_if?:
26984
27504
  | Array<
26985
27505
  | 'can_remotely_unlock'
@@ -26995,6 +27515,7 @@ export interface Routes {
26995
27515
  | 'can_simulate_disconnection'
26996
27516
  >
26997
27517
  | undefined
27518
+ /** */
26998
27519
  exclude_if?:
26999
27520
  | Array<
27000
27521
  | 'can_remotely_unlock'
@@ -27510,25 +28031,37 @@ export interface Routes {
27510
28031
  is_temporary_manual_override_active?: boolean | undefined
27511
28032
  current_climate_setting?:
27512
28033
  | {
28034
+ /** Unique key to identify the climate preset. */
27513
28035
  climate_preset_key?: string | undefined
28036
+ /** Indicates whether this climate preset key can be edited. */
27514
28037
  can_edit?: boolean | undefined
28038
+ /** Indicates whether this climate preset key can be deleted. */
27515
28039
  can_delete?: boolean | undefined
28040
+ /** User-friendly name to identify the climate preset. */
27516
28041
  name?: ((string | null) | undefined) | undefined
28042
+ /** Display name for the climate preset. */
27517
28043
  display_name?: string | undefined
28044
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
27518
28045
  fan_mode_setting?:
27519
28046
  | (('auto' | 'on' | 'circulate') | undefined)
27520
28047
  | undefined
28048
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
27521
28049
  hvac_mode_setting?:
27522
28050
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
27523
28051
  | undefined
28052
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
27524
28053
  cooling_set_point_celsius?: (number | undefined) | undefined
28054
+ /** Temperature to which the thermostat should heat (in °C). */
27525
28055
  heating_set_point_celsius?: (number | undefined) | undefined
28056
+ /** Temperature to which the thermostat should cool (in °F). */
27526
28057
  cooling_set_point_fahrenheit?:
27527
28058
  | (number | undefined)
27528
28059
  | undefined
28060
+ /** Temperature to which the thermostat should heat (in °F). */
27529
28061
  heating_set_point_fahrenheit?:
27530
28062
  | (number | undefined)
27531
28063
  | undefined
28064
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
27532
28065
  manual_override_allowed?: boolean | undefined
27533
28066
  }
27534
28067
  | undefined
@@ -27536,58 +28069,90 @@ export interface Routes {
27536
28069
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
27537
28070
  default_climate_setting?:
27538
28071
  | {
28072
+ /** Unique key to identify the climate preset. */
27539
28073
  climate_preset_key?: string | undefined
28074
+ /** Indicates whether this climate preset key can be edited. */
27540
28075
  can_edit?: boolean | undefined
28076
+ /** Indicates whether this climate preset key can be deleted. */
27541
28077
  can_delete?: boolean | undefined
28078
+ /** User-friendly name to identify the climate preset. */
27542
28079
  name?: ((string | null) | undefined) | undefined
28080
+ /** Display name for the climate preset. */
27543
28081
  display_name?: string | undefined
28082
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
27544
28083
  fan_mode_setting?:
27545
28084
  | (('auto' | 'on' | 'circulate') | undefined)
27546
28085
  | undefined
28086
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
27547
28087
  hvac_mode_setting?:
27548
28088
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
27549
28089
  | undefined
28090
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
27550
28091
  cooling_set_point_celsius?: (number | undefined) | undefined
28092
+ /** Temperature to which the thermostat should heat (in °C). */
27551
28093
  heating_set_point_celsius?: (number | undefined) | undefined
28094
+ /** Temperature to which the thermostat should cool (in °F). */
27552
28095
  cooling_set_point_fahrenheit?:
27553
28096
  | (number | undefined)
27554
28097
  | undefined
28098
+ /** Temperature to which the thermostat should heat (in °F). */
27555
28099
  heating_set_point_fahrenheit?:
27556
28100
  | (number | undefined)
27557
28101
  | undefined
28102
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
27558
28103
  manual_override_allowed?: boolean | undefined
27559
28104
  }
27560
28105
  | undefined
27561
28106
  available_climate_presets?:
27562
28107
  | Array<{
28108
+ /** Unique key to identify the climate preset. */
27563
28109
  climate_preset_key: string
28110
+ /** Indicates whether this climate preset key can be edited. */
27564
28111
  can_edit: boolean
28112
+ /** Indicates whether this climate preset key can be deleted. */
27565
28113
  can_delete: boolean
28114
+ /** User-friendly name to identify the climate preset. */
27566
28115
  name?: (string | null) | undefined
28116
+ /** Display name for the climate preset. */
27567
28117
  display_name: string
28118
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
27568
28119
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
28120
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
27569
28121
  hvac_mode_setting?:
27570
28122
  | ('off' | 'heat' | 'cool' | 'heat_cool')
27571
28123
  | undefined
28124
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
27572
28125
  cooling_set_point_celsius?: number | undefined
28126
+ /** Temperature to which the thermostat should heat (in °C). */
27573
28127
  heating_set_point_celsius?: number | undefined
28128
+ /** Temperature to which the thermostat should cool (in °F). */
27574
28129
  cooling_set_point_fahrenheit?: number | undefined
28130
+ /** Temperature to which the thermostat should heat (in °F). */
27575
28131
  heating_set_point_fahrenheit?: number | undefined
28132
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
27576
28133
  manual_override_allowed: boolean
27577
28134
  }>
27578
28135
  | undefined
27579
28136
  fallback_climate_preset_key?: (string | null) | undefined
27580
28137
  active_thermostat_schedule?:
27581
28138
  | ({
28139
+ /** ID of the climate schedule. */
27582
28140
  thermostat_schedule_id: string
28141
+ /** ID of the desired thermostat device. */
27583
28142
  device_id: string
28143
+ /** User-friendly name to identify the climate schedule. */
27584
28144
  name?: string | undefined
28145
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
27585
28146
  climate_preset_key: string
28147
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
27586
28148
  max_override_period_minutes: number
28149
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
27587
28150
  starts_at: string
28151
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
27588
28152
  ends_at: string
28153
+ /** Date and time at which the climate schedule was created. */
27589
28154
  created_at: string
27590
- /** Collection of errors associated with the thermostat schedule, 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. */
28155
+ /** Array of errors associated with the climate schedule. 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. */
27591
28156
  errors?: any
27592
28157
  } | null)
27593
28158
  | undefined
@@ -28156,25 +28721,37 @@ export interface Routes {
28156
28721
  is_temporary_manual_override_active?: boolean | undefined
28157
28722
  current_climate_setting?:
28158
28723
  | {
28724
+ /** Unique key to identify the climate preset. */
28159
28725
  climate_preset_key?: string | undefined
28726
+ /** Indicates whether this climate preset key can be edited. */
28160
28727
  can_edit?: boolean | undefined
28728
+ /** Indicates whether this climate preset key can be deleted. */
28161
28729
  can_delete?: boolean | undefined
28730
+ /** User-friendly name to identify the climate preset. */
28162
28731
  name?: ((string | null) | undefined) | undefined
28732
+ /** Display name for the climate preset. */
28163
28733
  display_name?: string | undefined
28734
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
28164
28735
  fan_mode_setting?:
28165
28736
  | (('auto' | 'on' | 'circulate') | undefined)
28166
28737
  | undefined
28738
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
28167
28739
  hvac_mode_setting?:
28168
28740
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
28169
28741
  | undefined
28742
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
28170
28743
  cooling_set_point_celsius?: (number | undefined) | undefined
28744
+ /** Temperature to which the thermostat should heat (in °C). */
28171
28745
  heating_set_point_celsius?: (number | undefined) | undefined
28746
+ /** Temperature to which the thermostat should cool (in °F). */
28172
28747
  cooling_set_point_fahrenheit?:
28173
28748
  | (number | undefined)
28174
28749
  | undefined
28750
+ /** Temperature to which the thermostat should heat (in °F). */
28175
28751
  heating_set_point_fahrenheit?:
28176
28752
  | (number | undefined)
28177
28753
  | undefined
28754
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
28178
28755
  manual_override_allowed?: boolean | undefined
28179
28756
  }
28180
28757
  | undefined
@@ -28182,58 +28759,90 @@ export interface Routes {
28182
28759
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
28183
28760
  default_climate_setting?:
28184
28761
  | {
28762
+ /** Unique key to identify the climate preset. */
28185
28763
  climate_preset_key?: string | undefined
28764
+ /** Indicates whether this climate preset key can be edited. */
28186
28765
  can_edit?: boolean | undefined
28766
+ /** Indicates whether this climate preset key can be deleted. */
28187
28767
  can_delete?: boolean | undefined
28768
+ /** User-friendly name to identify the climate preset. */
28188
28769
  name?: ((string | null) | undefined) | undefined
28770
+ /** Display name for the climate preset. */
28189
28771
  display_name?: string | undefined
28772
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
28190
28773
  fan_mode_setting?:
28191
28774
  | (('auto' | 'on' | 'circulate') | undefined)
28192
28775
  | undefined
28776
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
28193
28777
  hvac_mode_setting?:
28194
28778
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
28195
28779
  | undefined
28780
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
28196
28781
  cooling_set_point_celsius?: (number | undefined) | undefined
28782
+ /** Temperature to which the thermostat should heat (in °C). */
28197
28783
  heating_set_point_celsius?: (number | undefined) | undefined
28784
+ /** Temperature to which the thermostat should cool (in °F). */
28198
28785
  cooling_set_point_fahrenheit?:
28199
28786
  | (number | undefined)
28200
28787
  | undefined
28788
+ /** Temperature to which the thermostat should heat (in °F). */
28201
28789
  heating_set_point_fahrenheit?:
28202
28790
  | (number | undefined)
28203
28791
  | undefined
28792
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
28204
28793
  manual_override_allowed?: boolean | undefined
28205
28794
  }
28206
28795
  | undefined
28207
28796
  available_climate_presets?:
28208
28797
  | Array<{
28798
+ /** Unique key to identify the climate preset. */
28209
28799
  climate_preset_key: string
28800
+ /** Indicates whether this climate preset key can be edited. */
28210
28801
  can_edit: boolean
28802
+ /** Indicates whether this climate preset key can be deleted. */
28211
28803
  can_delete: boolean
28804
+ /** User-friendly name to identify the climate preset. */
28212
28805
  name?: (string | null) | undefined
28806
+ /** Display name for the climate preset. */
28213
28807
  display_name: string
28808
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
28214
28809
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
28810
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
28215
28811
  hvac_mode_setting?:
28216
28812
  | ('off' | 'heat' | 'cool' | 'heat_cool')
28217
28813
  | undefined
28814
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
28218
28815
  cooling_set_point_celsius?: number | undefined
28816
+ /** Temperature to which the thermostat should heat (in °C). */
28219
28817
  heating_set_point_celsius?: number | undefined
28818
+ /** Temperature to which the thermostat should cool (in °F). */
28220
28819
  cooling_set_point_fahrenheit?: number | undefined
28820
+ /** Temperature to which the thermostat should heat (in °F). */
28221
28821
  heating_set_point_fahrenheit?: number | undefined
28822
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
28222
28823
  manual_override_allowed: boolean
28223
28824
  }>
28224
28825
  | undefined
28225
28826
  fallback_climate_preset_key?: (string | null) | undefined
28226
28827
  active_thermostat_schedule?:
28227
28828
  | ({
28829
+ /** ID of the climate schedule. */
28228
28830
  thermostat_schedule_id: string
28831
+ /** ID of the desired thermostat device. */
28229
28832
  device_id: string
28833
+ /** User-friendly name to identify the climate schedule. */
28230
28834
  name?: string | undefined
28835
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
28231
28836
  climate_preset_key: string
28837
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
28232
28838
  max_override_period_minutes: number
28839
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
28233
28840
  starts_at: string
28841
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
28234
28842
  ends_at: string
28843
+ /** Date and time at which the climate schedule was created. */
28235
28844
  created_at: string
28236
- /** Collection of errors associated with the thermostat schedule, 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. */
28845
+ /** Array of errors associated with the climate schedule. 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. */
28237
28846
  errors?: any
28238
28847
  } | null)
28239
28848
  | undefined
@@ -28312,8 +28921,9 @@ export interface Routes {
28312
28921
  method: 'POST'
28313
28922
  queryParams: {}
28314
28923
  jsonBody: {
28315
- /** ID of the thermostat device. */
28924
+ /** ID of the desired thermostat device. */
28316
28925
  device_id: string
28926
+ /** */
28317
28927
  sync?: boolean
28318
28928
  }
28319
28929
  commonParams: {}
@@ -29172,26 +29782,40 @@ export interface Routes {
29172
29782
  method: 'POST'
29173
29783
  queryParams: {}
29174
29784
  jsonBody: {
29785
+ /** ID of the desired thermostat device. */
29175
29786
  device_id: string
29787
+ /** User-friendly name to identify the climate schedule. */
29176
29788
  name?: string | undefined
29789
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
29177
29790
  climate_preset_key: string
29791
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
29178
29792
  max_override_period_minutes?: number
29793
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29179
29794
  starts_at: string
29795
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29180
29796
  ends_at: string
29181
29797
  }
29182
29798
  commonParams: {}
29183
29799
  formData: {}
29184
29800
  jsonResponse: {
29185
29801
  thermostat_schedule: {
29802
+ /** ID of the climate schedule. */
29186
29803
  thermostat_schedule_id: string
29804
+ /** ID of the desired thermostat device. */
29187
29805
  device_id: string
29806
+ /** User-friendly name to identify the climate schedule. */
29188
29807
  name?: string | undefined
29808
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
29189
29809
  climate_preset_key: string
29810
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
29190
29811
  max_override_period_minutes: number
29812
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29191
29813
  starts_at: string
29814
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29192
29815
  ends_at: string
29816
+ /** Date and time at which the climate schedule was created. */
29193
29817
  created_at: string
29194
- /** Collection of errors associated with the thermostat schedule, 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. */
29818
+ /** Array of errors associated with the climate schedule. 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. */
29195
29819
  errors?: any
29196
29820
  }
29197
29821
  }
@@ -29202,6 +29826,7 @@ export interface Routes {
29202
29826
  queryParams: {}
29203
29827
  jsonBody: {}
29204
29828
  commonParams: {
29829
+ /** ID of the desired climate schedule. */
29205
29830
  thermostat_schedule_id: string
29206
29831
  }
29207
29832
  formData: {}
@@ -29213,20 +29838,29 @@ export interface Routes {
29213
29838
  queryParams: {}
29214
29839
  jsonBody: {}
29215
29840
  commonParams: {
29841
+ /** ID of the desired climate schedule. */
29216
29842
  thermostat_schedule_id: string
29217
29843
  }
29218
29844
  formData: {}
29219
29845
  jsonResponse: {
29220
29846
  thermostat_schedule: {
29847
+ /** ID of the climate schedule. */
29221
29848
  thermostat_schedule_id: string
29849
+ /** ID of the desired thermostat device. */
29222
29850
  device_id: string
29851
+ /** User-friendly name to identify the climate schedule. */
29223
29852
  name?: string | undefined
29853
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
29224
29854
  climate_preset_key: string
29855
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
29225
29856
  max_override_period_minutes: number
29857
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29226
29858
  starts_at: string
29859
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29227
29860
  ends_at: string
29861
+ /** Date and time at which the climate schedule was created. */
29228
29862
  created_at: string
29229
- /** Collection of errors associated with the thermostat schedule, 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. */
29863
+ /** Array of errors associated with the climate schedule. 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. */
29230
29864
  errors?: any
29231
29865
  }
29232
29866
  }
@@ -29237,21 +29871,31 @@ export interface Routes {
29237
29871
  queryParams: {}
29238
29872
  jsonBody: {}
29239
29873
  commonParams: {
29874
+ /** ID of the desired thermostat device. */
29240
29875
  device_id: string
29876
+ /** User identifier key by which to filter the list of returned climate schedules. */
29241
29877
  user_identifier_key?: string | undefined
29242
29878
  }
29243
29879
  formData: {}
29244
29880
  jsonResponse: {
29245
29881
  thermostat_schedules: Array<{
29882
+ /** ID of the climate schedule. */
29246
29883
  thermostat_schedule_id: string
29884
+ /** ID of the desired thermostat device. */
29247
29885
  device_id: string
29886
+ /** User-friendly name to identify the climate schedule. */
29248
29887
  name?: string | undefined
29888
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
29249
29889
  climate_preset_key: string
29890
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
29250
29891
  max_override_period_minutes: number
29892
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29251
29893
  starts_at: string
29894
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29252
29895
  ends_at: string
29896
+ /** Date and time at which the climate schedule was created. */
29253
29897
  created_at: string
29254
- /** Collection of errors associated with the thermostat schedule, 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. */
29898
+ /** Array of errors associated with the climate schedule. 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. */
29255
29899
  errors?: any
29256
29900
  }>
29257
29901
  }
@@ -29261,11 +29905,17 @@ export interface Routes {
29261
29905
  method: 'PATCH' | 'POST'
29262
29906
  queryParams: {}
29263
29907
  jsonBody: {
29908
+ /** ID of the desired climate schedule. */
29264
29909
  thermostat_schedule_id: string
29910
+ /** User-friendly name to identify the climate schedule. */
29265
29911
  name?: string | undefined
29912
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
29266
29913
  climate_preset_key?: string | undefined
29914
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
29267
29915
  max_override_period_minutes?: number | undefined
29916
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29268
29917
  starts_at?: string | undefined
29918
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29269
29919
  ends_at?: string | undefined
29270
29920
  }
29271
29921
  commonParams: {}
@@ -29277,7 +29927,9 @@ export interface Routes {
29277
29927
  method: 'POST'
29278
29928
  queryParams: {}
29279
29929
  jsonBody: {
29930
+ /** ID of the desired thermostat device. */
29280
29931
  device_id: string
29932
+ /** Climate preset key of the desired climate preset. */
29281
29933
  climate_preset_key: string
29282
29934
  }
29283
29935
  commonParams: {}
@@ -29289,13 +29941,13 @@ export interface Routes {
29289
29941
  method: 'POST'
29290
29942
  queryParams: {}
29291
29943
  jsonBody: {
29292
- /** ID of the thermostat device. */
29293
29944
  device_id: string
29294
29945
  /**
29295
29946
  * @deprecated Use `fan_mode_setting` instead. */
29296
29947
  fan_mode?: ('auto' | 'on' | 'circulate') | undefined
29297
- /** Fan mode setting of the thermostat. See also [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings). */
29948
+ /** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. */
29298
29949
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
29950
+ /** */
29299
29951
  sync?: boolean
29300
29952
  }
29301
29953
  commonParams: {}
@@ -30154,10 +30806,15 @@ export interface Routes {
30154
30806
  method: 'POST' | 'PATCH'
30155
30807
  queryParams: {}
30156
30808
  jsonBody: {
30809
+ /** ID of the desired thermostat device. */
30157
30810
  device_id: string
30811
+ /** Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. */
30158
30812
  lower_limit_celsius?: (number | undefined) | null
30813
+ /** Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. */
30159
30814
  lower_limit_fahrenheit?: (number | undefined) | null
30815
+ /** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. */
30160
30816
  upper_limit_celsius?: (number | undefined) | null
30817
+ /** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. */
30161
30818
  upper_limit_fahrenheit?: (number | undefined) | null
30162
30819
  }
30163
30820
  commonParams: {}
@@ -30169,15 +30826,25 @@ export interface Routes {
30169
30826
  method: 'POST' | 'PATCH'
30170
30827
  queryParams: {}
30171
30828
  jsonBody: {
30829
+ /** ID of the desired thermostat device. */
30172
30830
  device_id: string
30831
+ /** Unique key to identify the climate preset. */
30173
30832
  climate_preset_key: string
30833
+ /** User-friendly name to identify the climate preset. */
30174
30834
  name?: (string | null) | undefined
30835
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
30175
30836
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
30837
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
30176
30838
  hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
30839
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
30177
30840
  cooling_set_point_celsius?: number | undefined
30841
+ /** Temperature to which the thermostat should heat (in °C). */
30178
30842
  heating_set_point_celsius?: number | undefined
30843
+ /** Temperature to which the thermostat should cool (in °F). */
30179
30844
  cooling_set_point_fahrenheit?: number | undefined
30845
+ /** Temperature to which the thermostat should heat (in °F). */
30180
30846
  heating_set_point_fahrenheit?: number | undefined
30847
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
30181
30848
  manual_override_allowed: boolean
30182
30849
  }
30183
30850
  commonParams: {}
@@ -30872,25 +31539,37 @@ export interface Routes {
30872
31539
  is_temporary_manual_override_active?: boolean | undefined
30873
31540
  current_climate_setting?:
30874
31541
  | {
31542
+ /** Unique key to identify the climate preset. */
30875
31543
  climate_preset_key?: string | undefined
31544
+ /** Indicates whether this climate preset key can be edited. */
30876
31545
  can_edit?: boolean | undefined
31546
+ /** Indicates whether this climate preset key can be deleted. */
30877
31547
  can_delete?: boolean | undefined
31548
+ /** User-friendly name to identify the climate preset. */
30878
31549
  name?: ((string | null) | undefined) | undefined
31550
+ /** Display name for the climate preset. */
30879
31551
  display_name?: string | undefined
31552
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
30880
31553
  fan_mode_setting?:
30881
31554
  | (('auto' | 'on' | 'circulate') | undefined)
30882
31555
  | undefined
31556
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
30883
31557
  hvac_mode_setting?:
30884
31558
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
30885
31559
  | undefined
31560
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
30886
31561
  cooling_set_point_celsius?: (number | undefined) | undefined
31562
+ /** Temperature to which the thermostat should heat (in °C). */
30887
31563
  heating_set_point_celsius?: (number | undefined) | undefined
31564
+ /** Temperature to which the thermostat should cool (in °F). */
30888
31565
  cooling_set_point_fahrenheit?:
30889
31566
  | (number | undefined)
30890
31567
  | undefined
31568
+ /** Temperature to which the thermostat should heat (in °F). */
30891
31569
  heating_set_point_fahrenheit?:
30892
31570
  | (number | undefined)
30893
31571
  | undefined
31572
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
30894
31573
  manual_override_allowed?: boolean | undefined
30895
31574
  }
30896
31575
  | undefined
@@ -30898,58 +31577,90 @@ export interface Routes {
30898
31577
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
30899
31578
  default_climate_setting?:
30900
31579
  | {
31580
+ /** Unique key to identify the climate preset. */
30901
31581
  climate_preset_key?: string | undefined
31582
+ /** Indicates whether this climate preset key can be edited. */
30902
31583
  can_edit?: boolean | undefined
31584
+ /** Indicates whether this climate preset key can be deleted. */
30903
31585
  can_delete?: boolean | undefined
31586
+ /** User-friendly name to identify the climate preset. */
30904
31587
  name?: ((string | null) | undefined) | undefined
31588
+ /** Display name for the climate preset. */
30905
31589
  display_name?: string | undefined
31590
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
30906
31591
  fan_mode_setting?:
30907
31592
  | (('auto' | 'on' | 'circulate') | undefined)
30908
31593
  | undefined
31594
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
30909
31595
  hvac_mode_setting?:
30910
31596
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
30911
31597
  | undefined
31598
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
30912
31599
  cooling_set_point_celsius?: (number | undefined) | undefined
31600
+ /** Temperature to which the thermostat should heat (in °C). */
30913
31601
  heating_set_point_celsius?: (number | undefined) | undefined
31602
+ /** Temperature to which the thermostat should cool (in °F). */
30914
31603
  cooling_set_point_fahrenheit?:
30915
31604
  | (number | undefined)
30916
31605
  | undefined
31606
+ /** Temperature to which the thermostat should heat (in °F). */
30917
31607
  heating_set_point_fahrenheit?:
30918
31608
  | (number | undefined)
30919
31609
  | undefined
31610
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
30920
31611
  manual_override_allowed?: boolean | undefined
30921
31612
  }
30922
31613
  | undefined
30923
31614
  available_climate_presets?:
30924
31615
  | Array<{
31616
+ /** Unique key to identify the climate preset. */
30925
31617
  climate_preset_key: string
31618
+ /** Indicates whether this climate preset key can be edited. */
30926
31619
  can_edit: boolean
31620
+ /** Indicates whether this climate preset key can be deleted. */
30927
31621
  can_delete: boolean
31622
+ /** User-friendly name to identify the climate preset. */
30928
31623
  name?: (string | null) | undefined
31624
+ /** Display name for the climate preset. */
30929
31625
  display_name: string
31626
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
30930
31627
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
31628
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
30931
31629
  hvac_mode_setting?:
30932
31630
  | ('off' | 'heat' | 'cool' | 'heat_cool')
30933
31631
  | undefined
31632
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
30934
31633
  cooling_set_point_celsius?: number | undefined
31634
+ /** Temperature to which the thermostat should heat (in °C). */
30935
31635
  heating_set_point_celsius?: number | undefined
31636
+ /** Temperature to which the thermostat should cool (in °F). */
30936
31637
  cooling_set_point_fahrenheit?: number | undefined
31638
+ /** Temperature to which the thermostat should heat (in °F). */
30937
31639
  heating_set_point_fahrenheit?: number | undefined
31640
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
30938
31641
  manual_override_allowed: boolean
30939
31642
  }>
30940
31643
  | undefined
30941
31644
  fallback_climate_preset_key?: (string | null) | undefined
30942
31645
  active_thermostat_schedule?:
30943
31646
  | ({
31647
+ /** ID of the climate schedule. */
30944
31648
  thermostat_schedule_id: string
31649
+ /** ID of the desired thermostat device. */
30945
31650
  device_id: string
31651
+ /** User-friendly name to identify the climate schedule. */
30946
31652
  name?: string | undefined
31653
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
30947
31654
  climate_preset_key: string
31655
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
30948
31656
  max_override_period_minutes: number
31657
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
30949
31658
  starts_at: string
31659
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
30950
31660
  ends_at: string
31661
+ /** Date and time at which the climate schedule was created. */
30951
31662
  created_at: string
30952
- /** Collection of errors associated with the thermostat schedule, 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. */
31663
+ /** Array of errors associated with the climate schedule. 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. */
30953
31664
  errors?: any
30954
31665
  } | null)
30955
31666
  | undefined
@@ -31520,25 +32231,37 @@ export interface Routes {
31520
32231
  is_temporary_manual_override_active?: boolean | undefined
31521
32232
  current_climate_setting?:
31522
32233
  | {
32234
+ /** Unique key to identify the climate preset. */
31523
32235
  climate_preset_key?: string | undefined
32236
+ /** Indicates whether this climate preset key can be edited. */
31524
32237
  can_edit?: boolean | undefined
32238
+ /** Indicates whether this climate preset key can be deleted. */
31525
32239
  can_delete?: boolean | undefined
32240
+ /** User-friendly name to identify the climate preset. */
31526
32241
  name?: ((string | null) | undefined) | undefined
32242
+ /** Display name for the climate preset. */
31527
32243
  display_name?: string | undefined
32244
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
31528
32245
  fan_mode_setting?:
31529
32246
  | (('auto' | 'on' | 'circulate') | undefined)
31530
32247
  | undefined
32248
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
31531
32249
  hvac_mode_setting?:
31532
32250
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
31533
32251
  | undefined
32252
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
31534
32253
  cooling_set_point_celsius?: (number | undefined) | undefined
32254
+ /** Temperature to which the thermostat should heat (in °C). */
31535
32255
  heating_set_point_celsius?: (number | undefined) | undefined
32256
+ /** Temperature to which the thermostat should cool (in °F). */
31536
32257
  cooling_set_point_fahrenheit?:
31537
32258
  | (number | undefined)
31538
32259
  | undefined
32260
+ /** Temperature to which the thermostat should heat (in °F). */
31539
32261
  heating_set_point_fahrenheit?:
31540
32262
  | (number | undefined)
31541
32263
  | undefined
32264
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
31542
32265
  manual_override_allowed?: boolean | undefined
31543
32266
  }
31544
32267
  | undefined
@@ -31546,58 +32269,90 @@ export interface Routes {
31546
32269
  * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
31547
32270
  default_climate_setting?:
31548
32271
  | {
32272
+ /** Unique key to identify the climate preset. */
31549
32273
  climate_preset_key?: string | undefined
32274
+ /** Indicates whether this climate preset key can be edited. */
31550
32275
  can_edit?: boolean | undefined
32276
+ /** Indicates whether this climate preset key can be deleted. */
31551
32277
  can_delete?: boolean | undefined
32278
+ /** User-friendly name to identify the climate preset. */
31552
32279
  name?: ((string | null) | undefined) | undefined
32280
+ /** Display name for the climate preset. */
31553
32281
  display_name?: string | undefined
32282
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
31554
32283
  fan_mode_setting?:
31555
32284
  | (('auto' | 'on' | 'circulate') | undefined)
31556
32285
  | undefined
32286
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
31557
32287
  hvac_mode_setting?:
31558
32288
  | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
31559
32289
  | undefined
32290
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
31560
32291
  cooling_set_point_celsius?: (number | undefined) | undefined
32292
+ /** Temperature to which the thermostat should heat (in °C). */
31561
32293
  heating_set_point_celsius?: (number | undefined) | undefined
32294
+ /** Temperature to which the thermostat should cool (in °F). */
31562
32295
  cooling_set_point_fahrenheit?:
31563
32296
  | (number | undefined)
31564
32297
  | undefined
32298
+ /** Temperature to which the thermostat should heat (in °F). */
31565
32299
  heating_set_point_fahrenheit?:
31566
32300
  | (number | undefined)
31567
32301
  | undefined
32302
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
31568
32303
  manual_override_allowed?: boolean | undefined
31569
32304
  }
31570
32305
  | undefined
31571
32306
  available_climate_presets?:
31572
32307
  | Array<{
32308
+ /** Unique key to identify the climate preset. */
31573
32309
  climate_preset_key: string
32310
+ /** Indicates whether this climate preset key can be edited. */
31574
32311
  can_edit: boolean
32312
+ /** Indicates whether this climate preset key can be deleted. */
31575
32313
  can_delete: boolean
32314
+ /** User-friendly name to identify the climate preset. */
31576
32315
  name?: (string | null) | undefined
32316
+ /** Display name for the climate preset. */
31577
32317
  display_name: string
32318
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
31578
32319
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
32320
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
31579
32321
  hvac_mode_setting?:
31580
32322
  | ('off' | 'heat' | 'cool' | 'heat_cool')
31581
32323
  | undefined
32324
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
31582
32325
  cooling_set_point_celsius?: number | undefined
32326
+ /** Temperature to which the thermostat should heat (in °C). */
31583
32327
  heating_set_point_celsius?: number | undefined
32328
+ /** Temperature to which the thermostat should cool (in °F). */
31584
32329
  cooling_set_point_fahrenheit?: number | undefined
32330
+ /** Temperature to which the thermostat should heat (in °F). */
31585
32331
  heating_set_point_fahrenheit?: number | undefined
32332
+ /** Indicates whether a person at the thermostat can change the thermostat's settings. */
31586
32333
  manual_override_allowed: boolean
31587
32334
  }>
31588
32335
  | undefined
31589
32336
  fallback_climate_preset_key?: (string | null) | undefined
31590
32337
  active_thermostat_schedule?:
31591
32338
  | ({
32339
+ /** ID of the climate schedule. */
31592
32340
  thermostat_schedule_id: string
32341
+ /** ID of the desired thermostat device. */
31593
32342
  device_id: string
32343
+ /** User-friendly name to identify the climate schedule. */
31594
32344
  name?: string | undefined
32345
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
31595
32346
  climate_preset_key: string
32347
+ /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-schedules#specifying-manual-override-permissions). */
31596
32348
  max_override_period_minutes: number
32349
+ /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
31597
32350
  starts_at: string
32351
+ /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
31598
32352
  ends_at: string
32353
+ /** Date and time at which the climate schedule was created. */
31599
32354
  created_at: string
31600
- /** Collection of errors associated with the thermostat schedule, 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. */
32355
+ /** Array of errors associated with the climate schedule. 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. */
31601
32356
  errors?: any
31602
32357
  } | null)
31603
32358
  | undefined
@@ -31777,7 +32532,7 @@ export interface Routes {
31777
32532
  created_at: string
31778
32533
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
31779
32534
  message: string
31780
- /** Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit. */
32535
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
31781
32536
  error_code: 'salto_ks_subscription_limit_exceeded'
31782
32537
  }
31783
32538
  | {
@@ -31785,7 +32540,7 @@ export interface Routes {
31785
32540
  created_at: string
31786
32541
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
31787
32542
  message: string
31788
- /** Indicates that the access system has been disconnected. Please refer to [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue. */
32543
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
31789
32544
  error_code: 'acs_system_disconnected'
31790
32545
  }
31791
32546
  | {
@@ -31793,7 +32548,7 @@ export interface Routes {
31793
32548
  created_at: string
31794
32549
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
31795
32550
  message: string
31796
- /** Indicates that the login credentials are invalid. Please reconnect the account using the Connect Webview to restore access. */
32551
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
31797
32552
  error_code: 'account_disconnected'
31798
32553
  }
31799
32554
  >