@seamapi/types 1.344.0 → 1.344.1

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.
package/dist/connect.cjs CHANGED
@@ -27949,6 +27949,7 @@ var openapi_default = {
27949
27949
  },
27950
27950
  "/thermostats/simulate/hvac_mode_adjusted": {
27951
27951
  post: {
27952
+ description: "Simulates having adjusted the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/latest/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).",
27952
27953
  operationId: "thermostatsSimulateHvacModeAdjustedPost",
27953
27954
  requestBody: {
27954
27955
  content: {
@@ -27958,8 +27959,16 @@ var openapi_default = {
27958
27959
  oneOf: [
27959
27960
  {
27960
27961
  properties: {
27961
- device_id: { format: "uuid", type: "string" },
27962
- hvac_mode: { enum: ["off"], type: "string" }
27962
+ device_id: {
27963
+ description: "ID of the desired thermostat device.",
27964
+ format: "uuid",
27965
+ type: "string"
27966
+ },
27967
+ hvac_mode: {
27968
+ description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.",
27969
+ enum: ["off"],
27970
+ type: "string"
27971
+ }
27963
27972
  },
27964
27973
  required: ["hvac_mode", "device_id"],
27965
27974
  type: "object"
@@ -27967,31 +27976,51 @@ var openapi_default = {
27967
27976
  {
27968
27977
  properties: {
27969
27978
  cooling_set_point_celsius: {
27979
+ description: "Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.",
27970
27980
  format: "float",
27971
27981
  type: "number"
27972
27982
  },
27973
27983
  cooling_set_point_fahrenheit: {
27984
+ description: "Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.",
27974
27985
  format: "float",
27975
27986
  type: "number"
27976
27987
  },
27977
- device_id: { format: "uuid", type: "string" },
27978
- hvac_mode: { enum: ["cool"], type: "string" }
27988
+ device_id: {
27989
+ description: "ID of the desired thermostat device.",
27990
+ format: "uuid",
27991
+ type: "string"
27992
+ },
27993
+ hvac_mode: {
27994
+ description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.",
27995
+ enum: ["cool"],
27996
+ type: "string"
27997
+ }
27979
27998
  },
27980
27999
  required: ["hvac_mode", "device_id"],
27981
28000
  type: "object"
27982
28001
  },
27983
28002
  {
27984
28003
  properties: {
27985
- device_id: { format: "uuid", type: "string" },
28004
+ device_id: {
28005
+ description: "ID of the desired thermostat device.",
28006
+ format: "uuid",
28007
+ type: "string"
28008
+ },
27986
28009
  heating_set_point_celsius: {
28010
+ description: "Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.",
27987
28011
  format: "float",
27988
28012
  type: "number"
27989
28013
  },
27990
28014
  heating_set_point_fahrenheit: {
28015
+ description: "Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.",
27991
28016
  format: "float",
27992
28017
  type: "number"
27993
28018
  },
27994
- hvac_mode: { enum: ["heat"], type: "string" }
28019
+ hvac_mode: {
28020
+ description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.",
28021
+ enum: ["heat"],
28022
+ type: "string"
28023
+ }
27995
28024
  },
27996
28025
  required: ["hvac_mode", "device_id"],
27997
28026
  type: "object"
@@ -27999,23 +28028,35 @@ var openapi_default = {
27999
28028
  {
28000
28029
  properties: {
28001
28030
  cooling_set_point_celsius: {
28031
+ description: "Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.",
28002
28032
  format: "float",
28003
28033
  type: "number"
28004
28034
  },
28005
28035
  cooling_set_point_fahrenheit: {
28036
+ description: "Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.",
28006
28037
  format: "float",
28007
28038
  type: "number"
28008
28039
  },
28009
- device_id: { format: "uuid", type: "string" },
28040
+ device_id: {
28041
+ description: "ID of the desired thermostat device.",
28042
+ format: "uuid",
28043
+ type: "string"
28044
+ },
28010
28045
  heating_set_point_celsius: {
28046
+ description: "Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.",
28011
28047
  format: "float",
28012
28048
  type: "number"
28013
28049
  },
28014
28050
  heating_set_point_fahrenheit: {
28051
+ description: "Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.",
28015
28052
  format: "float",
28016
28053
  type: "number"
28017
28054
  },
28018
- hvac_mode: { enum: ["heat_cool"], type: "string" }
28055
+ hvac_mode: {
28056
+ description: "Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.",
28057
+ enum: ["heat_cool"],
28058
+ type: "string"
28059
+ }
28019
28060
  },
28020
28061
  required: ["hvac_mode", "device_id"],
28021
28062
  type: "object"
@@ -28050,20 +28091,34 @@ var openapi_default = {
28050
28091
  tags: ["/thermostats"],
28051
28092
  "x-fern-sdk-group-name": ["thermostats", "simulate"],
28052
28093
  "x-fern-sdk-method-name": "hvac_mode_adjusted",
28053
- "x-response-key": null
28094
+ "x-response-key": null,
28095
+ "x-title": "HVAC Mode Adjusted"
28054
28096
  }
28055
28097
  },
28056
28098
  "/thermostats/simulate/temperature_reached": {
28057
28099
  post: {
28100
+ description: "Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/latest/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).",
28058
28101
  operationId: "thermostatsSimulateTemperatureReachedPost",
28059
28102
  requestBody: {
28060
28103
  content: {
28061
28104
  "application/json": {
28062
28105
  schema: {
28063
28106
  properties: {
28064
- device_id: { format: "uuid", type: "string" },
28065
- temperature_celsius: { format: "float", type: "number" },
28066
- temperature_fahrenheit: { format: "float", type: "number" }
28107
+ device_id: {
28108
+ description: "ID of the desired thermostat device.",
28109
+ format: "uuid",
28110
+ type: "string"
28111
+ },
28112
+ temperature_celsius: {
28113
+ description: "Desired simulated temperature in \xB0C. You must set `temperature_celsius` or `temperature_fahrenheit`.",
28114
+ format: "float",
28115
+ type: "number"
28116
+ },
28117
+ temperature_fahrenheit: {
28118
+ description: "Desired simulated temperature in \xB0F. You must set `temperature_fahrenheit` or `temperature_celsius`.",
28119
+ format: "float",
28120
+ type: "number"
28121
+ }
28067
28122
  },
28068
28123
  required: ["device_id"],
28069
28124
  type: "object"
@@ -28096,7 +28151,8 @@ var openapi_default = {
28096
28151
  tags: ["/thermostats"],
28097
28152
  "x-fern-sdk-group-name": ["thermostats", "simulate"],
28098
28153
  "x-fern-sdk-method-name": "temperature_reached",
28099
- "x-response-key": null
28154
+ "x-response-key": null,
28155
+ "x-title": "Temperature Reached"
28100
28156
  }
28101
28157
  },
28102
28158
  "/thermostats/update_climate_preset": {