@seamapi/types 1.291.0 → 1.292.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
@@ -144,33 +144,51 @@ zod.z.array(fan_mode_setting);
144
144
 
145
145
  // src/lib/seam/connect/models/thermostats/climate-preset.ts
146
146
  var climate_preset = zod.z.object({
147
- climate_preset_key: zod.z.string(),
148
- can_edit: zod.z.boolean(),
149
- can_delete: zod.z.boolean(),
150
- name: zod.z.string().nullable().default(null).optional(),
151
- display_name: zod.z.string(),
152
- fan_mode_setting: fan_mode_setting.optional(),
153
- hvac_mode_setting: hvac_mode_setting.optional(),
154
- cooling_set_point_celsius: zod.z.number().optional(),
155
- heating_set_point_celsius: zod.z.number().optional(),
156
- cooling_set_point_fahrenheit: zod.z.number().optional(),
157
- heating_set_point_fahrenheit: zod.z.number().optional(),
158
- manual_override_allowed: zod.z.boolean()
147
+ climate_preset_key: zod.z.string().describe("Unique key to identify the climate preset."),
148
+ can_edit: zod.z.boolean().describe("Indicates whether this climate preset key can be edited."),
149
+ can_delete: zod.z.boolean().describe("Indicates whether this climate preset key can be deleted."),
150
+ name: zod.z.string().nullable().default(null).optional().describe("User-friendly name to identify the climate preset."),
151
+ display_name: zod.z.string().describe("Display name for the climate preset."),
152
+ fan_mode_setting: fan_mode_setting.optional().describe(
153
+ "Desired fan mode setting, such as `on`, `auto`, or `circulate`."
154
+ ),
155
+ hvac_mode_setting: hvac_mode_setting.optional().describe(
156
+ "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`."
157
+ ),
158
+ cooling_set_point_celsius: zod.z.number().optional().describe(
159
+ "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points)."
160
+ ),
161
+ heating_set_point_celsius: zod.z.number().optional().describe("Temperature to which the thermostat should heat (in \xB0C)."),
162
+ cooling_set_point_fahrenheit: zod.z.number().optional().describe("Temperature to which the thermostat should cool (in \xB0F)."),
163
+ heating_set_point_fahrenheit: zod.z.number().optional().describe("Temperature to which the thermostat should heat (in \xB0F)."),
164
+ manual_override_allowed: zod.z.boolean().describe(
165
+ "Indicates whether a person at the thermostat can change the thermostat's settings."
166
+ )
159
167
  });
160
168
  var climate_setting = climate_preset.partial();
161
169
  var thermostat_schedule = zod.z.object({
162
- thermostat_schedule_id: zod.z.string().uuid(),
163
- device_id: zod.z.string().uuid(),
164
- name: zod.z.string().optional(),
165
- climate_preset_key: zod.z.string(),
166
- max_override_period_minutes: zod.z.number().int().nonnegative(),
167
- starts_at: zod.z.string().datetime(),
168
- ends_at: zod.z.string().datetime(),
169
- created_at: zod.z.string().datetime(),
170
+ thermostat_schedule_id: zod.z.string().uuid().describe("ID of the thermostat schedule."),
171
+ device_id: zod.z.string().uuid().describe("ID of the desired thermostat device."),
172
+ name: zod.z.string().optional().describe("User-friendly name to identify the thermostat schedule."),
173
+ climate_preset_key: zod.z.string().describe(
174
+ "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule."
175
+ ),
176
+ max_override_period_minutes: zod.z.number().int().nonnegative().describe(
177
+ "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-thermostat-schedules#specifying-manual-override-permissions)."
178
+ ),
179
+ starts_at: zod.z.string().datetime().describe(
180
+ "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
181
+ ),
182
+ ends_at: zod.z.string().datetime().describe(
183
+ "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
184
+ ),
185
+ created_at: zod.z.string().datetime().describe("Date and time at which the thermostat schedule was created."),
170
186
  errors: zod.z.any().describe(
171
- '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.'
187
+ "Array of errors associated with the thermostat 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."
172
188
  )
173
- });
189
+ }).describe(
190
+ "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time."
191
+ );
174
192
 
175
193
  // src/lib/seam/connect/models/devices/capability-properties/thermostat.ts
176
194
  var thermostat_capability_properties = zod.z.object({
@@ -7157,22 +7175,47 @@ var openapi_default = {
7157
7175
  properties: {
7158
7176
  active_thermostat_schedule: {
7159
7177
  default: null,
7178
+ description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
7160
7179
  nullable: true,
7161
7180
  properties: {
7162
- climate_preset_key: { type: "string" },
7163
- created_at: { format: "date-time", type: "string" },
7164
- device_id: { format: "uuid", type: "string" },
7165
- ends_at: { format: "date-time", type: "string" },
7181
+ climate_preset_key: {
7182
+ description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
7183
+ type: "string"
7184
+ },
7185
+ created_at: {
7186
+ description: "Date and time at which the thermostat schedule was created.",
7187
+ format: "date-time",
7188
+ type: "string"
7189
+ },
7190
+ device_id: {
7191
+ description: "ID of the desired thermostat device.",
7192
+ format: "uuid",
7193
+ type: "string"
7194
+ },
7195
+ ends_at: {
7196
+ description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
7197
+ format: "date-time",
7198
+ type: "string"
7199
+ },
7166
7200
  errors: {
7167
- description: '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.'
7201
+ description: "Array of errors associated with the thermostat 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."
7168
7202
  },
7169
7203
  max_override_period_minutes: {
7204
+ description: "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-thermostat-schedules#specifying-manual-override-permissions).",
7170
7205
  minimum: 0,
7171
7206
  type: "integer"
7172
7207
  },
7173
- name: { type: "string" },
7174
- starts_at: { format: "date-time", type: "string" },
7208
+ name: {
7209
+ description: "User-friendly name to identify the thermostat schedule.",
7210
+ type: "string"
7211
+ },
7212
+ starts_at: {
7213
+ description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
7214
+ format: "date-time",
7215
+ type: "string"
7216
+ },
7175
7217
  thermostat_schedule_id: {
7218
+ description: "ID of the thermostat schedule.",
7176
7219
  format: "uuid",
7177
7220
  type: "string"
7178
7221
  }
@@ -7191,37 +7234,59 @@ var openapi_default = {
7191
7234
  available_climate_presets: {
7192
7235
  items: {
7193
7236
  properties: {
7194
- can_delete: { type: "boolean" },
7195
- can_edit: { type: "boolean" },
7196
- climate_preset_key: { type: "string" },
7237
+ can_delete: {
7238
+ description: "Indicates whether this climate preset key can be deleted.",
7239
+ type: "boolean"
7240
+ },
7241
+ can_edit: {
7242
+ description: "Indicates whether this climate preset key can be edited.",
7243
+ type: "boolean"
7244
+ },
7245
+ climate_preset_key: {
7246
+ description: "Unique key to identify the climate preset.",
7247
+ type: "string"
7248
+ },
7197
7249
  cooling_set_point_celsius: {
7250
+ description: "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
7198
7251
  format: "float",
7199
7252
  type: "number"
7200
7253
  },
7201
7254
  cooling_set_point_fahrenheit: {
7255
+ description: "Temperature to which the thermostat should cool (in \xB0F).",
7202
7256
  format: "float",
7203
7257
  type: "number"
7204
7258
  },
7205
- display_name: { type: "string" },
7259
+ display_name: {
7260
+ description: "Display name for the climate preset.",
7261
+ type: "string"
7262
+ },
7206
7263
  fan_mode_setting: {
7264
+ description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
7207
7265
  enum: ["auto", "on", "circulate"],
7208
7266
  type: "string"
7209
7267
  },
7210
7268
  heating_set_point_celsius: {
7269
+ description: "Temperature to which the thermostat should heat (in \xB0C).",
7211
7270
  format: "float",
7212
7271
  type: "number"
7213
7272
  },
7214
7273
  heating_set_point_fahrenheit: {
7274
+ description: "Temperature to which the thermostat should heat (in \xB0F).",
7215
7275
  format: "float",
7216
7276
  type: "number"
7217
7277
  },
7218
7278
  hvac_mode_setting: {
7279
+ description: "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`.",
7219
7280
  enum: ["off", "heat", "cool", "heat_cool"],
7220
7281
  type: "string"
7221
7282
  },
7222
- manual_override_allowed: { type: "boolean" },
7283
+ manual_override_allowed: {
7284
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
7285
+ type: "boolean"
7286
+ },
7223
7287
  name: {
7224
7288
  default: null,
7289
+ description: "User-friendly name to identify the climate preset.",
7225
7290
  nullable: true,
7226
7291
  type: "string"
7227
7292
  }
@@ -7253,37 +7318,59 @@ var openapi_default = {
7253
7318
  },
7254
7319
  current_climate_setting: {
7255
7320
  properties: {
7256
- can_delete: { type: "boolean" },
7257
- can_edit: { type: "boolean" },
7258
- climate_preset_key: { type: "string" },
7321
+ can_delete: {
7322
+ description: "Indicates whether this climate preset key can be deleted.",
7323
+ type: "boolean"
7324
+ },
7325
+ can_edit: {
7326
+ description: "Indicates whether this climate preset key can be edited.",
7327
+ type: "boolean"
7328
+ },
7329
+ climate_preset_key: {
7330
+ description: "Unique key to identify the climate preset.",
7331
+ type: "string"
7332
+ },
7259
7333
  cooling_set_point_celsius: {
7334
+ description: "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
7260
7335
  format: "float",
7261
7336
  type: "number"
7262
7337
  },
7263
7338
  cooling_set_point_fahrenheit: {
7339
+ description: "Temperature to which the thermostat should cool (in \xB0F).",
7264
7340
  format: "float",
7265
7341
  type: "number"
7266
7342
  },
7267
- display_name: { type: "string" },
7343
+ display_name: {
7344
+ description: "Display name for the climate preset.",
7345
+ type: "string"
7346
+ },
7268
7347
  fan_mode_setting: {
7348
+ description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
7269
7349
  enum: ["auto", "on", "circulate"],
7270
7350
  type: "string"
7271
7351
  },
7272
7352
  heating_set_point_celsius: {
7353
+ description: "Temperature to which the thermostat should heat (in \xB0C).",
7273
7354
  format: "float",
7274
7355
  type: "number"
7275
7356
  },
7276
7357
  heating_set_point_fahrenheit: {
7358
+ description: "Temperature to which the thermostat should heat (in \xB0F).",
7277
7359
  format: "float",
7278
7360
  type: "number"
7279
7361
  },
7280
7362
  hvac_mode_setting: {
7363
+ description: "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`.",
7281
7364
  enum: ["off", "heat", "cool", "heat_cool"],
7282
7365
  type: "string"
7283
7366
  },
7284
- manual_override_allowed: { type: "boolean" },
7367
+ manual_override_allowed: {
7368
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
7369
+ type: "boolean"
7370
+ },
7285
7371
  name: {
7286
7372
  default: null,
7373
+ description: "User-friendly name to identify the climate preset.",
7287
7374
  nullable: true,
7288
7375
  type: "string"
7289
7376
  }
@@ -7293,37 +7380,59 @@ var openapi_default = {
7293
7380
  default_climate_setting: {
7294
7381
  deprecated: true,
7295
7382
  properties: {
7296
- can_delete: { type: "boolean" },
7297
- can_edit: { type: "boolean" },
7298
- climate_preset_key: { type: "string" },
7383
+ can_delete: {
7384
+ description: "Indicates whether this climate preset key can be deleted.",
7385
+ type: "boolean"
7386
+ },
7387
+ can_edit: {
7388
+ description: "Indicates whether this climate preset key can be edited.",
7389
+ type: "boolean"
7390
+ },
7391
+ climate_preset_key: {
7392
+ description: "Unique key to identify the climate preset.",
7393
+ type: "string"
7394
+ },
7299
7395
  cooling_set_point_celsius: {
7396
+ description: "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
7300
7397
  format: "float",
7301
7398
  type: "number"
7302
7399
  },
7303
7400
  cooling_set_point_fahrenheit: {
7401
+ description: "Temperature to which the thermostat should cool (in \xB0F).",
7304
7402
  format: "float",
7305
7403
  type: "number"
7306
7404
  },
7307
- display_name: { type: "string" },
7405
+ display_name: {
7406
+ description: "Display name for the climate preset.",
7407
+ type: "string"
7408
+ },
7308
7409
  fan_mode_setting: {
7410
+ description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
7309
7411
  enum: ["auto", "on", "circulate"],
7310
7412
  type: "string"
7311
7413
  },
7312
7414
  heating_set_point_celsius: {
7415
+ description: "Temperature to which the thermostat should heat (in \xB0C).",
7313
7416
  format: "float",
7314
7417
  type: "number"
7315
7418
  },
7316
7419
  heating_set_point_fahrenheit: {
7420
+ description: "Temperature to which the thermostat should heat (in \xB0F).",
7317
7421
  format: "float",
7318
7422
  type: "number"
7319
7423
  },
7320
7424
  hvac_mode_setting: {
7425
+ description: "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`.",
7321
7426
  enum: ["off", "heat", "cool", "heat_cool"],
7322
7427
  type: "string"
7323
7428
  },
7324
- manual_override_allowed: { type: "boolean" },
7429
+ manual_override_allowed: {
7430
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
7431
+ type: "boolean"
7432
+ },
7325
7433
  name: {
7326
7434
  default: null,
7435
+ description: "User-friendly name to identify the climate preset.",
7327
7436
  nullable: true,
7328
7437
  type: "string"
7329
7438
  }
@@ -7816,18 +7925,49 @@ var openapi_default = {
7816
7925
  type: "object"
7817
7926
  },
7818
7927
  thermostat_schedule: {
7928
+ description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
7819
7929
  properties: {
7820
- climate_preset_key: { type: "string" },
7821
- created_at: { format: "date-time", type: "string" },
7822
- device_id: { format: "uuid", type: "string" },
7823
- ends_at: { format: "date-time", type: "string" },
7930
+ climate_preset_key: {
7931
+ description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
7932
+ type: "string"
7933
+ },
7934
+ created_at: {
7935
+ description: "Date and time at which the thermostat schedule was created.",
7936
+ format: "date-time",
7937
+ type: "string"
7938
+ },
7939
+ device_id: {
7940
+ description: "ID of the desired thermostat device.",
7941
+ format: "uuid",
7942
+ type: "string"
7943
+ },
7944
+ ends_at: {
7945
+ description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
7946
+ format: "date-time",
7947
+ type: "string"
7948
+ },
7824
7949
  errors: {
7825
- description: '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.'
7950
+ description: "Array of errors associated with the thermostat 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."
7826
7951
  },
7827
- max_override_period_minutes: { minimum: 0, type: "integer" },
7828
- name: { type: "string" },
7829
- starts_at: { format: "date-time", type: "string" },
7830
- thermostat_schedule_id: { format: "uuid", type: "string" }
7952
+ max_override_period_minutes: {
7953
+ description: "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-thermostat-schedules#specifying-manual-override-permissions).",
7954
+ minimum: 0,
7955
+ type: "integer"
7956
+ },
7957
+ name: {
7958
+ description: "User-friendly name to identify the thermostat schedule.",
7959
+ type: "string"
7960
+ },
7961
+ starts_at: {
7962
+ description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
7963
+ format: "date-time",
7964
+ type: "string"
7965
+ },
7966
+ thermostat_schedule_id: {
7967
+ description: "ID of the thermostat schedule.",
7968
+ format: "uuid",
7969
+ type: "string"
7970
+ }
7831
7971
  },
7832
7972
  required: [
7833
7973
  "thermostat_schedule_id",
@@ -14966,34 +15106,47 @@ var openapi_default = {
14966
15106
  },
14967
15107
  "/devices/list": {
14968
15108
  post: {
15109
+ description: "Returns a list of all [devices](https://docs.seam.co/latest/core-concepts/devices).",
14969
15110
  operationId: "devicesListPost",
14970
15111
  requestBody: {
14971
15112
  content: {
14972
15113
  "application/json": {
14973
15114
  schema: {
14974
15115
  properties: {
14975
- connect_webview_id: { format: "uuid", type: "string" },
15116
+ connect_webview_id: {
15117
+ description: "ID of the Connect Webview by which to filter devices.",
15118
+ format: "uuid",
15119
+ type: "string"
15120
+ },
14976
15121
  connected_account_id: {
14977
- description: "List all devices owned by this connected account",
15122
+ description: "ID of the connected account by which to filter.",
14978
15123
  format: "uuid",
14979
15124
  type: "string"
14980
15125
  },
14981
15126
  connected_account_ids: {
15127
+ description: "Array of IDs of the connected accounts by which to filter devices.",
14982
15128
  items: { format: "uuid", type: "string" },
14983
15129
  type: "array"
14984
15130
  },
14985
- created_before: { format: "date-time", type: "string" },
15131
+ created_before: {
15132
+ description: "Date threshold for devices to return. If specified, returns only devices created before the specified date.",
15133
+ format: "date-time",
15134
+ type: "string"
15135
+ },
14986
15136
  custom_metadata_has: {
14987
15137
  additionalProperties: {
14988
15138
  oneOf: [{ type: "string" }, { type: "boolean" }]
14989
15139
  },
15140
+ description: "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.",
14990
15141
  type: "object"
14991
15142
  },
14992
15143
  device_ids: {
15144
+ description: "Array of device IDs by which to filter devices.",
14993
15145
  items: { format: "uuid", type: "string" },
14994
15146
  type: "array"
14995
15147
  },
14996
15148
  device_type: {
15149
+ description: "Device type by which to filter devices.",
14997
15150
  oneOf: [
14998
15151
  {
14999
15152
  enum: [
@@ -15050,6 +15203,7 @@ var openapi_default = {
15050
15203
  ]
15051
15204
  },
15052
15205
  device_types: {
15206
+ description: "Array of device types by which to filter devices.",
15053
15207
  items: {
15054
15208
  oneOf: [
15055
15209
  {
@@ -15128,7 +15282,8 @@ var openapi_default = {
15128
15282
  ],
15129
15283
  type: "string"
15130
15284
  },
15131
- type: "array"
15285
+ type: "array",
15286
+ "x-undocumented": "Only used internally."
15132
15287
  },
15133
15288
  include_if: {
15134
15289
  items: {
@@ -15147,10 +15302,17 @@ var openapi_default = {
15147
15302
  ],
15148
15303
  type: "string"
15149
15304
  },
15150
- type: "array"
15305
+ type: "array",
15306
+ "x-undocumented": "Only used internally."
15307
+ },
15308
+ limit: {
15309
+ default: 500,
15310
+ description: "Numerical limit on the number of devices to return.",
15311
+ format: "float",
15312
+ type: "number"
15151
15313
  },
15152
- limit: { default: 500, format: "float", type: "number" },
15153
15314
  manufacturer: {
15315
+ description: "Manufacturer by which to filter devices.",
15154
15316
  enum: [
15155
15317
  "akuvox",
15156
15318
  "august",
@@ -15190,7 +15352,10 @@ var openapi_default = {
15190
15352
  ],
15191
15353
  type: "string"
15192
15354
  },
15193
- user_identifier_key: { type: "string" }
15355
+ user_identifier_key: {
15356
+ description: "Your own internal user ID for the user by which to filter devices.",
15357
+ type: "string"
15358
+ }
15194
15359
  },
15195
15360
  type: "object"
15196
15361
  }
@@ -15230,7 +15395,8 @@ var openapi_default = {
15230
15395
  "x-fern-sdk-group-name": ["devices"],
15231
15396
  "x-fern-sdk-method-name": "list",
15232
15397
  "x-fern-sdk-return-value": "devices",
15233
- "x-response-key": "devices"
15398
+ "x-response-key": "devices",
15399
+ "x-title": "List Devices"
15234
15400
  }
15235
15401
  },
15236
15402
  "/devices/list_device_providers": {
@@ -15476,28 +15642,40 @@ var openapi_default = {
15476
15642
  "application/json": {
15477
15643
  schema: {
15478
15644
  properties: {
15479
- connect_webview_id: { format: "uuid", type: "string" },
15645
+ connect_webview_id: {
15646
+ description: "ID of the Connect Webview by which to filter devices.",
15647
+ format: "uuid",
15648
+ type: "string"
15649
+ },
15480
15650
  connected_account_id: {
15481
- description: "List all devices owned by this connected account",
15651
+ description: "ID of the connected account by which to filter.",
15482
15652
  format: "uuid",
15483
15653
  type: "string"
15484
15654
  },
15485
15655
  connected_account_ids: {
15656
+ description: "Array of IDs of the connected accounts by which to filter devices.",
15486
15657
  items: { format: "uuid", type: "string" },
15487
15658
  type: "array"
15488
15659
  },
15489
- created_before: { format: "date-time", type: "string" },
15660
+ created_before: {
15661
+ description: "Date threshold for devices to return. If specified, returns only devices created before the specified date.",
15662
+ format: "date-time",
15663
+ type: "string"
15664
+ },
15490
15665
  custom_metadata_has: {
15491
15666
  additionalProperties: {
15492
15667
  oneOf: [{ type: "string" }, { type: "boolean" }]
15493
15668
  },
15669
+ description: "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.",
15494
15670
  type: "object"
15495
15671
  },
15496
15672
  device_ids: {
15673
+ description: "Array of device IDs by which to filter devices.",
15497
15674
  items: { format: "uuid", type: "string" },
15498
15675
  type: "array"
15499
15676
  },
15500
15677
  device_type: {
15678
+ description: "Device type by which to filter devices.",
15501
15679
  oneOf: [
15502
15680
  {
15503
15681
  enum: [
@@ -15554,6 +15732,7 @@ var openapi_default = {
15554
15732
  ]
15555
15733
  },
15556
15734
  device_types: {
15735
+ description: "Array of device types by which to filter devices.",
15557
15736
  items: {
15558
15737
  oneOf: [
15559
15738
  {
@@ -15632,7 +15811,8 @@ var openapi_default = {
15632
15811
  ],
15633
15812
  type: "string"
15634
15813
  },
15635
- type: "array"
15814
+ type: "array",
15815
+ "x-undocumented": "Only used internally."
15636
15816
  },
15637
15817
  include_if: {
15638
15818
  items: {
@@ -15651,10 +15831,17 @@ var openapi_default = {
15651
15831
  ],
15652
15832
  type: "string"
15653
15833
  },
15654
- type: "array"
15834
+ type: "array",
15835
+ "x-undocumented": "Only used internally."
15836
+ },
15837
+ limit: {
15838
+ default: 500,
15839
+ description: "Numerical limit on the number of devices to return.",
15840
+ format: "float",
15841
+ type: "number"
15655
15842
  },
15656
- limit: { default: 500, format: "float", type: "number" },
15657
15843
  manufacturer: {
15844
+ description: "Manufacturer by which to filter devices.",
15658
15845
  enum: [
15659
15846
  "akuvox",
15660
15847
  "august",
@@ -15694,7 +15881,10 @@ var openapi_default = {
15694
15881
  ],
15695
15882
  type: "string"
15696
15883
  },
15697
- user_identifier_key: { type: "string" }
15884
+ user_identifier_key: {
15885
+ description: "Your own internal user ID for the user by which to filter devices.",
15886
+ type: "string"
15887
+ }
15698
15888
  },
15699
15889
  type: "object"
15700
15890
  }
@@ -16284,28 +16474,40 @@ var openapi_default = {
16284
16474
  "application/json": {
16285
16475
  schema: {
16286
16476
  properties: {
16287
- connect_webview_id: { format: "uuid", type: "string" },
16477
+ connect_webview_id: {
16478
+ description: "ID of the Connect Webview by which to filter devices.",
16479
+ format: "uuid",
16480
+ type: "string"
16481
+ },
16288
16482
  connected_account_id: {
16289
- description: "List all devices owned by this connected account",
16483
+ description: "ID of the connected account by which to filter.",
16290
16484
  format: "uuid",
16291
16485
  type: "string"
16292
16486
  },
16293
16487
  connected_account_ids: {
16488
+ description: "Array of IDs of the connected accounts by which to filter devices.",
16294
16489
  items: { format: "uuid", type: "string" },
16295
16490
  type: "array"
16296
16491
  },
16297
- created_before: { format: "date-time", type: "string" },
16492
+ created_before: {
16493
+ description: "Date threshold for devices to return. If specified, returns only devices created before the specified date.",
16494
+ format: "date-time",
16495
+ type: "string"
16496
+ },
16298
16497
  custom_metadata_has: {
16299
16498
  additionalProperties: {
16300
16499
  oneOf: [{ type: "string" }, { type: "boolean" }]
16301
16500
  },
16501
+ description: "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.",
16302
16502
  type: "object"
16303
16503
  },
16304
16504
  device_ids: {
16505
+ description: "Array of device IDs by which to filter devices.",
16305
16506
  items: { format: "uuid", type: "string" },
16306
16507
  type: "array"
16307
16508
  },
16308
16509
  device_type: {
16510
+ description: "Device type by which to filter devices.",
16309
16511
  oneOf: [
16310
16512
  {
16311
16513
  enum: [
@@ -16362,6 +16564,7 @@ var openapi_default = {
16362
16564
  ]
16363
16565
  },
16364
16566
  device_types: {
16567
+ description: "Array of device types by which to filter devices.",
16365
16568
  items: {
16366
16569
  oneOf: [
16367
16570
  {
@@ -16440,7 +16643,8 @@ var openapi_default = {
16440
16643
  ],
16441
16644
  type: "string"
16442
16645
  },
16443
- type: "array"
16646
+ type: "array",
16647
+ "x-undocumented": "Only used internally."
16444
16648
  },
16445
16649
  include_if: {
16446
16650
  items: {
@@ -16459,10 +16663,17 @@ var openapi_default = {
16459
16663
  ],
16460
16664
  type: "string"
16461
16665
  },
16462
- type: "array"
16666
+ type: "array",
16667
+ "x-undocumented": "Only used internally."
16668
+ },
16669
+ limit: {
16670
+ default: 500,
16671
+ description: "Numerical limit on the number of devices to return.",
16672
+ format: "float",
16673
+ type: "number"
16463
16674
  },
16464
- limit: { default: 500, format: "float", type: "number" },
16465
16675
  manufacturer: {
16676
+ description: "Manufacturer by which to filter devices.",
16466
16677
  enum: [
16467
16678
  "akuvox",
16468
16679
  "august",
@@ -16502,7 +16713,10 @@ var openapi_default = {
16502
16713
  ],
16503
16714
  type: "string"
16504
16715
  },
16505
- user_identifier_key: { type: "string" }
16716
+ user_identifier_key: {
16717
+ description: "Your own internal user ID for the user by which to filter devices.",
16718
+ type: "string"
16719
+ }
16506
16720
  },
16507
16721
  type: "object"
16508
16722
  }
@@ -16750,28 +16964,40 @@ var openapi_default = {
16750
16964
  "application/json": {
16751
16965
  schema: {
16752
16966
  properties: {
16753
- connect_webview_id: { format: "uuid", type: "string" },
16967
+ connect_webview_id: {
16968
+ description: "ID of the Connect Webview by which to filter devices.",
16969
+ format: "uuid",
16970
+ type: "string"
16971
+ },
16754
16972
  connected_account_id: {
16755
- description: "List all devices owned by this connected account",
16973
+ description: "ID of the connected account by which to filter.",
16756
16974
  format: "uuid",
16757
16975
  type: "string"
16758
16976
  },
16759
16977
  connected_account_ids: {
16978
+ description: "Array of IDs of the connected accounts by which to filter devices.",
16760
16979
  items: { format: "uuid", type: "string" },
16761
16980
  type: "array"
16762
16981
  },
16763
- created_before: { format: "date-time", type: "string" },
16982
+ created_before: {
16983
+ description: "Date threshold for devices to return. If specified, returns only devices created before the specified date.",
16984
+ format: "date-time",
16985
+ type: "string"
16986
+ },
16764
16987
  custom_metadata_has: {
16765
16988
  additionalProperties: {
16766
16989
  oneOf: [{ type: "string" }, { type: "boolean" }]
16767
16990
  },
16991
+ description: "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.",
16768
16992
  type: "object"
16769
16993
  },
16770
16994
  device_ids: {
16995
+ description: "Array of device IDs by which to filter devices.",
16771
16996
  items: { format: "uuid", type: "string" },
16772
16997
  type: "array"
16773
16998
  },
16774
16999
  device_type: {
17000
+ description: "Device type by which to filter devices.",
16775
17001
  oneOf: [
16776
17002
  {
16777
17003
  enum: [
@@ -16828,6 +17054,7 @@ var openapi_default = {
16828
17054
  ]
16829
17055
  },
16830
17056
  device_types: {
17057
+ description: "Array of device types by which to filter devices.",
16831
17058
  items: {
16832
17059
  oneOf: [
16833
17060
  {
@@ -16906,7 +17133,8 @@ var openapi_default = {
16906
17133
  ],
16907
17134
  type: "string"
16908
17135
  },
16909
- type: "array"
17136
+ type: "array",
17137
+ "x-undocumented": "Only used internally."
16910
17138
  },
16911
17139
  include_if: {
16912
17140
  items: {
@@ -16925,10 +17153,17 @@ var openapi_default = {
16925
17153
  ],
16926
17154
  type: "string"
16927
17155
  },
16928
- type: "array"
17156
+ type: "array",
17157
+ "x-undocumented": "Only used internally."
17158
+ },
17159
+ limit: {
17160
+ default: 500,
17161
+ description: "Numerical limit on the number of devices to return.",
17162
+ format: "float",
17163
+ type: "number"
16929
17164
  },
16930
- limit: { default: 500, format: "float", type: "number" },
16931
17165
  manufacturer: {
17166
+ description: "Manufacturer by which to filter devices.",
16932
17167
  enum: [
16933
17168
  "akuvox",
16934
17169
  "august",
@@ -16968,7 +17203,10 @@ var openapi_default = {
16968
17203
  ],
16969
17204
  type: "string"
16970
17205
  },
16971
- user_identifier_key: { type: "string" }
17206
+ user_identifier_key: {
17207
+ description: "Your own internal user ID for the user by which to filter devices.",
17208
+ type: "string"
17209
+ }
16972
17210
  },
16973
17211
  type: "object"
16974
17212
  }
@@ -17613,14 +17851,22 @@ var openapi_default = {
17613
17851
  },
17614
17852
  "/thermostats/activate_climate_preset": {
17615
17853
  post: {
17854
+ description: "Activates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
17616
17855
  operationId: "thermostatsActivateClimatePresetPost",
17617
17856
  requestBody: {
17618
17857
  content: {
17619
17858
  "application/json": {
17620
17859
  schema: {
17621
17860
  properties: {
17622
- climate_preset_key: { type: "string" },
17623
- device_id: { format: "uuid", type: "string" }
17861
+ climate_preset_key: {
17862
+ description: "Climate preset key of the desired climate preset.",
17863
+ type: "string"
17864
+ },
17865
+ device_id: {
17866
+ description: "ID of the desired thermostat device.",
17867
+ format: "uuid",
17868
+ type: "string"
17869
+ }
17624
17870
  },
17625
17871
  required: ["device_id", "climate_preset_key"],
17626
17872
  type: "object"
@@ -17659,12 +17905,13 @@ var openapi_default = {
17659
17905
  "x-fern-sdk-group-name": ["thermostats"],
17660
17906
  "x-fern-sdk-method-name": "activate_climate_preset",
17661
17907
  "x-fern-sdk-return-value": "action_attempt",
17662
- "x-response-key": "action_attempt"
17908
+ "x-response-key": "action_attempt",
17909
+ "x-title": "Activate a Climate Preset"
17663
17910
  }
17664
17911
  },
17665
17912
  "/thermostats/cool": {
17666
17913
  post: {
17667
- description: "Sets a thermostat to cooling mode. You must include a cooling set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).",
17914
+ description: "Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [cool mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).",
17668
17915
  operationId: "thermostatsCoolPost",
17669
17916
  requestBody: {
17670
17917
  content: {
@@ -17672,21 +17919,25 @@ var openapi_default = {
17672
17919
  schema: {
17673
17920
  properties: {
17674
17921
  cooling_set_point_celsius: {
17675
- description: "Temperature to which the HVAC system connected to the thermostat should cool (in \xB0C). You must set one of the `cooling_set_point` parameters.",
17922
+ description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `cooling_set_point` parameters.",
17676
17923
  format: "float",
17677
17924
  type: "number"
17678
17925
  },
17679
17926
  cooling_set_point_fahrenheit: {
17680
- description: "Temperature to which the HVAC system connected to the thermostat should cool (in \xB0F). You must set one of the `cooling_set_point` parameters.",
17927
+ description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `cooling_set_point` parameters.",
17681
17928
  format: "float",
17682
17929
  type: "number"
17683
17930
  },
17684
17931
  device_id: {
17685
- description: "ID of the thermostat device.",
17932
+ description: "ID of the desired thermostat device.",
17686
17933
  format: "uuid",
17687
17934
  type: "string"
17688
17935
  },
17689
- sync: { default: false, type: "boolean" }
17936
+ sync: {
17937
+ default: false,
17938
+ type: "boolean",
17939
+ "x-undocumented": "Only used internally."
17940
+ }
17690
17941
  },
17691
17942
  required: ["device_id"],
17692
17943
  type: "object"
@@ -17732,40 +17983,62 @@ var openapi_default = {
17732
17983
  },
17733
17984
  "/thermostats/create_climate_preset": {
17734
17985
  post: {
17986
+ description: "Creates a [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
17735
17987
  operationId: "thermostatsCreateClimatePresetPost",
17736
17988
  requestBody: {
17737
17989
  content: {
17738
17990
  "application/json": {
17739
17991
  schema: {
17740
17992
  properties: {
17741
- climate_preset_key: { type: "string" },
17993
+ climate_preset_key: {
17994
+ description: "Unique key to identify the climate preset.",
17995
+ type: "string"
17996
+ },
17742
17997
  cooling_set_point_celsius: {
17998
+ description: "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
17743
17999
  format: "float",
17744
18000
  type: "number"
17745
18001
  },
17746
18002
  cooling_set_point_fahrenheit: {
18003
+ description: "Temperature to which the thermostat should cool (in \xB0F).",
17747
18004
  format: "float",
17748
18005
  type: "number"
17749
18006
  },
17750
- device_id: { format: "uuid", type: "string" },
18007
+ device_id: {
18008
+ description: "ID of the desired thermostat device.",
18009
+ format: "uuid",
18010
+ type: "string"
18011
+ },
17751
18012
  fan_mode_setting: {
18013
+ description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
17752
18014
  enum: ["auto", "on", "circulate"],
17753
18015
  type: "string"
17754
18016
  },
17755
18017
  heating_set_point_celsius: {
18018
+ description: "Temperature to which the thermostat should heat (in \xB0C).",
17756
18019
  format: "float",
17757
18020
  type: "number"
17758
18021
  },
17759
18022
  heating_set_point_fahrenheit: {
18023
+ description: "Temperature to which the thermostat should heat (in \xB0F).",
17760
18024
  format: "float",
17761
18025
  type: "number"
17762
18026
  },
17763
18027
  hvac_mode_setting: {
18028
+ description: "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`.",
17764
18029
  enum: ["off", "heat", "cool", "heat_cool"],
17765
18030
  type: "string"
17766
18031
  },
17767
- manual_override_allowed: { type: "boolean" },
17768
- name: { default: null, nullable: true, type: "string" }
18032
+ manual_override_allowed: {
18033
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
18034
+ type: "boolean"
18035
+ },
18036
+ name: {
18037
+ default: null,
18038
+ description: "User-friendly name to identify the climate preset.",
18039
+ nullable: true,
18040
+ type: "string"
18041
+ }
17769
18042
  },
17770
18043
  required: [
17771
18044
  "device_id",
@@ -17802,19 +18075,28 @@ var openapi_default = {
17802
18075
  tags: ["/thermostats"],
17803
18076
  "x-fern-sdk-group-name": ["thermostats"],
17804
18077
  "x-fern-sdk-method-name": "create_climate_preset",
17805
- "x-response-key": null
18078
+ "x-response-key": null,
18079
+ "x-title": "Create a Climate Preset"
17806
18080
  }
17807
18081
  },
17808
18082
  "/thermostats/delete_climate_preset": {
17809
18083
  post: {
18084
+ description: "Deletes a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
17810
18085
  operationId: "thermostatsDeleteClimatePresetPost",
17811
18086
  requestBody: {
17812
18087
  content: {
17813
18088
  "application/json": {
17814
18089
  schema: {
17815
18090
  properties: {
17816
- climate_preset_key: { type: "string" },
17817
- device_id: { format: "uuid", type: "string" }
18091
+ climate_preset_key: {
18092
+ description: "Climate preset key of the desired climate preset.",
18093
+ type: "string"
18094
+ },
18095
+ device_id: {
18096
+ description: "ID of the desired thermostat device.",
18097
+ format: "uuid",
18098
+ type: "string"
18099
+ }
17818
18100
  },
17819
18101
  required: ["device_id", "climate_preset_key"],
17820
18102
  type: "object"
@@ -17847,12 +18129,13 @@ var openapi_default = {
17847
18129
  tags: ["/thermostats"],
17848
18130
  "x-fern-sdk-group-name": ["thermostats"],
17849
18131
  "x-fern-sdk-method-name": "delete_climate_preset",
17850
- "x-response-key": null
18132
+ "x-response-key": null,
18133
+ "x-title": "Delete a Climate Preset"
17851
18134
  }
17852
18135
  },
17853
18136
  "/thermostats/get": {
17854
18137
  post: {
17855
- description: "Returns a specific thermostat.",
18138
+ description: "Returns a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
17856
18139
  operationId: "thermostatsGetPost",
17857
18140
  requestBody: {
17858
18141
  content: {
@@ -17860,12 +18143,12 @@ var openapi_default = {
17860
18143
  schema: {
17861
18144
  properties: {
17862
18145
  device_id: {
17863
- description: "ID of the thermostat device.",
18146
+ description: "ID of the desired thermostat device.",
17864
18147
  format: "uuid",
17865
18148
  type: "string"
17866
18149
  },
17867
18150
  name: {
17868
- description: "Name of the thermostat.",
18151
+ description: "User-friendly name of the desired thermostat device.",
17869
18152
  type: "string"
17870
18153
  }
17871
18154
  },
@@ -17906,12 +18189,13 @@ var openapi_default = {
17906
18189
  "x-fern-sdk-method-name": "get",
17907
18190
  "x-fern-sdk-return-value": "thermostat",
17908
18191
  "x-response-key": "thermostat",
17909
- "x-title": "Get a Thermostat"
18192
+ "x-title": "Get a Thermostat",
18193
+ "x-undocumented": "Will be removed."
17910
18194
  }
17911
18195
  },
17912
18196
  "/thermostats/heat": {
17913
18197
  post: {
17914
- description: "Sets a thermostat to heating mode. You must include a heating set point in Celsius or Fahrenheit. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).",
18198
+ description: "Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).",
17915
18199
  operationId: "thermostatsHeatPost",
17916
18200
  requestBody: {
17917
18201
  content: {
@@ -17919,21 +18203,25 @@ var openapi_default = {
17919
18203
  schema: {
17920
18204
  properties: {
17921
18205
  device_id: {
17922
- description: "ID of the thermostat device.",
18206
+ description: "ID of the desired thermostat device.",
17923
18207
  format: "uuid",
17924
18208
  type: "string"
17925
18209
  },
17926
18210
  heating_set_point_celsius: {
17927
- description: "Temperature to which the HVAC system connected to the thermostat should heat (in \xB0C). You must set one of the `heating_set_point` parameters.",
18211
+ description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `heating_set_point` parameters.",
17928
18212
  format: "float",
17929
18213
  type: "number"
17930
18214
  },
17931
18215
  heating_set_point_fahrenheit: {
17932
- description: "Temperature to which the HVAC system connected to the thermostat should heat (in \xB0F). You must set one of the `heating_set_point` parameters.",
18216
+ description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `heating_set_point` parameters.",
17933
18217
  format: "float",
17934
18218
  type: "number"
17935
18219
  },
17936
- sync: { default: false, type: "boolean" }
18220
+ sync: {
18221
+ default: false,
18222
+ type: "boolean",
18223
+ "x-undocumented": "Only used internally."
18224
+ }
17937
18225
  },
17938
18226
  required: ["device_id"],
17939
18227
  type: "object"
@@ -17979,7 +18267,7 @@ var openapi_default = {
17979
18267
  },
17980
18268
  "/thermostats/heat_cool": {
17981
18269
  post: {
17982
- description: 'Set a thermostat to heat-cool mode, also known as "auto" mode. To do so, you must include both cooling and heating set points in the payload, either in Celsius or Fahrenheit. For information about verifying the heating and cooling availability of the thermostat and validating the correct set points, see [HVAC Mode Constraints](https://docs.seam.co/latest/capability-guides/thermostats/hvac-mode#hvac-mode-constraints) and [Set Point Constraints](https://docs.seam.co/latest/capability-guides/thermostats/set-points#set-point-constraints).',
18270
+ description: 'Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to [heat-cool ("auto") mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
17983
18271
  operationId: "thermostatsHeatCoolPost",
17984
18272
  requestBody: {
17985
18273
  content: {
@@ -17987,31 +18275,35 @@ var openapi_default = {
17987
18275
  schema: {
17988
18276
  properties: {
17989
18277
  cooling_set_point_celsius: {
17990
- description: "Temperature to which the HVAC system connected to the thermostat should cool (in \xB0C). You must set one of the `cooling_set_point` parameters.",
18278
+ description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `cooling_set_point` parameters.",
17991
18279
  format: "float",
17992
18280
  type: "number"
17993
18281
  },
17994
18282
  cooling_set_point_fahrenheit: {
17995
- description: "Temperature the thermostat should cool to (in \xB0F). You must set one of the cooling_set_point parameters.",
18283
+ description: "Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `cooling_set_point` parameters.",
17996
18284
  format: "float",
17997
18285
  type: "number"
17998
18286
  },
17999
18287
  device_id: {
18000
- description: "ID of the thermostat device.",
18288
+ description: "ID of the desired thermostat device.",
18001
18289
  format: "uuid",
18002
18290
  type: "string"
18003
18291
  },
18004
18292
  heating_set_point_celsius: {
18005
- description: "Temperature to which the HVAC system connected to the thermostat should heat (in \xB0C). You must set one of the `heating_set_point` parameters.",
18293
+ description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0C. You must set one of the `heating_set_point` parameters.",
18006
18294
  format: "float",
18007
18295
  type: "number"
18008
18296
  },
18009
18297
  heating_set_point_fahrenheit: {
18010
- description: "Temperature the thermostat should heat to (in \xB0F). You must set one of the heating_set_point parameters.",
18298
+ description: "Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in \xB0F. You must set one of the `heating_set_point` parameters.",
18011
18299
  format: "float",
18012
18300
  type: "number"
18013
18301
  },
18014
- sync: { default: false, type: "boolean" }
18302
+ sync: {
18303
+ default: false,
18304
+ type: "boolean",
18305
+ "x-undocumented": "Only used internally."
18306
+ }
18015
18307
  },
18016
18308
  required: ["device_id"],
18017
18309
  type: "object"
@@ -18057,35 +18349,47 @@ var openapi_default = {
18057
18349
  },
18058
18350
  "/thermostats/list": {
18059
18351
  post: {
18060
- description: "Returns a list of thermostats connected to your workspace. If no thermostats are connected, the list will be empty.",
18352
+ description: "Returns a list of all [thermostats](https://docs.seam.co/latest/capability-guides/thermostats).",
18061
18353
  operationId: "thermostatsListPost",
18062
18354
  requestBody: {
18063
18355
  content: {
18064
18356
  "application/json": {
18065
18357
  schema: {
18066
18358
  properties: {
18067
- connect_webview_id: { format: "uuid", type: "string" },
18359
+ connect_webview_id: {
18360
+ description: "ID of the Connect Webview by which to filter devices.",
18361
+ format: "uuid",
18362
+ type: "string"
18363
+ },
18068
18364
  connected_account_id: {
18069
- description: "List all devices owned by this connected account",
18365
+ description: "ID of the connected account by which to filter.",
18070
18366
  format: "uuid",
18071
18367
  type: "string"
18072
18368
  },
18073
18369
  connected_account_ids: {
18370
+ description: "Array of IDs of the connected accounts by which to filter devices.",
18074
18371
  items: { format: "uuid", type: "string" },
18075
18372
  type: "array"
18076
18373
  },
18077
- created_before: { format: "date-time", type: "string" },
18374
+ created_before: {
18375
+ description: "Date threshold for devices to return. If specified, returns only devices created before the specified date.",
18376
+ format: "date-time",
18377
+ type: "string"
18378
+ },
18078
18379
  custom_metadata_has: {
18079
18380
  additionalProperties: {
18080
18381
  oneOf: [{ type: "string" }, { type: "boolean" }]
18081
18382
  },
18383
+ description: "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.",
18082
18384
  type: "object"
18083
18385
  },
18084
18386
  device_ids: {
18387
+ description: "Array of device IDs by which to filter devices.",
18085
18388
  items: { format: "uuid", type: "string" },
18086
18389
  type: "array"
18087
18390
  },
18088
18391
  device_type: {
18392
+ description: "Device type by which to filter devices.",
18089
18393
  oneOf: [
18090
18394
  {
18091
18395
  enum: [
@@ -18142,6 +18446,7 @@ var openapi_default = {
18142
18446
  ]
18143
18447
  },
18144
18448
  device_types: {
18449
+ description: "Array of device types by which to filter devices.",
18145
18450
  items: {
18146
18451
  oneOf: [
18147
18452
  {
@@ -18220,7 +18525,8 @@ var openapi_default = {
18220
18525
  ],
18221
18526
  type: "string"
18222
18527
  },
18223
- type: "array"
18528
+ type: "array",
18529
+ "x-undocumented": "Only used internally."
18224
18530
  },
18225
18531
  include_if: {
18226
18532
  items: {
@@ -18239,10 +18545,17 @@ var openapi_default = {
18239
18545
  ],
18240
18546
  type: "string"
18241
18547
  },
18242
- type: "array"
18548
+ type: "array",
18549
+ "x-undocumented": "Only used internally."
18550
+ },
18551
+ limit: {
18552
+ default: 500,
18553
+ description: "Numerical limit on the number of devices to return.",
18554
+ format: "float",
18555
+ type: "number"
18243
18556
  },
18244
- limit: { default: 500, format: "float", type: "number" },
18245
18557
  manufacturer: {
18558
+ description: "Manufacturer by which to filter devices.",
18246
18559
  enum: [
18247
18560
  "akuvox",
18248
18561
  "august",
@@ -18282,7 +18595,10 @@ var openapi_default = {
18282
18595
  ],
18283
18596
  type: "string"
18284
18597
  },
18285
- user_identifier_key: { type: "string" }
18598
+ user_identifier_key: {
18599
+ description: "Your own internal user ID for the user by which to filter devices.",
18600
+ type: "string"
18601
+ }
18286
18602
  },
18287
18603
  type: "object"
18288
18604
  }
@@ -18332,7 +18648,7 @@ var openapi_default = {
18332
18648
  },
18333
18649
  "/thermostats/off": {
18334
18650
  post: {
18335
- description: 'Sets a thermostat to "off" mode. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
18651
+ description: 'Sets a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) to ["off" mode](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings).',
18336
18652
  operationId: "thermostatsOffPost",
18337
18653
  requestBody: {
18338
18654
  content: {
@@ -18340,11 +18656,15 @@ var openapi_default = {
18340
18656
  schema: {
18341
18657
  properties: {
18342
18658
  device_id: {
18343
- description: "ID of the thermostat device.",
18659
+ description: "ID of the desired thermostat device.",
18344
18660
  format: "uuid",
18345
18661
  type: "string"
18346
18662
  },
18347
- sync: { default: false, type: "boolean" }
18663
+ sync: {
18664
+ default: false,
18665
+ type: "boolean",
18666
+ "x-undocumented": "Only used internally."
18667
+ }
18348
18668
  },
18349
18669
  required: ["device_id"],
18350
18670
  type: "object"
@@ -18390,22 +18710,39 @@ var openapi_default = {
18390
18710
  },
18391
18711
  "/thermostats/schedules/create": {
18392
18712
  post: {
18713
+ description: "Creates a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
18393
18714
  operationId: "thermostatsSchedulesCreatePost",
18394
18715
  requestBody: {
18395
18716
  content: {
18396
18717
  "application/json": {
18397
18718
  schema: {
18398
18719
  properties: {
18399
- climate_preset_key: { type: "string" },
18400
- device_id: { type: "string" },
18401
- ends_at: { type: "string" },
18720
+ climate_preset_key: {
18721
+ description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
18722
+ type: "string"
18723
+ },
18724
+ device_id: {
18725
+ description: "ID of the desired thermostat device.",
18726
+ type: "string"
18727
+ },
18728
+ ends_at: {
18729
+ description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
18730
+ type: "string"
18731
+ },
18402
18732
  max_override_period_minutes: {
18403
18733
  default: 0,
18734
+ description: "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-thermostat-schedules#specifying-manual-override-permissions).",
18404
18735
  minimum: 0,
18405
18736
  type: "integer"
18406
18737
  },
18407
- name: { type: "string" },
18408
- starts_at: { type: "string" }
18738
+ name: {
18739
+ description: "User-friendly name to identify the thermostat schedule.",
18740
+ type: "string"
18741
+ },
18742
+ starts_at: {
18743
+ description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
18744
+ type: "string"
18745
+ }
18409
18746
  },
18410
18747
  required: [
18411
18748
  "device_id",
@@ -18450,18 +18787,24 @@ var openapi_default = {
18450
18787
  "x-fern-sdk-group-name": ["thermostats", "schedules"],
18451
18788
  "x-fern-sdk-method-name": "create",
18452
18789
  "x-fern-sdk-return-value": "thermostat_schedule",
18453
- "x-response-key": "thermostat_schedule"
18790
+ "x-response-key": "thermostat_schedule",
18791
+ "x-title": "Create a Thermostat Schedule"
18454
18792
  }
18455
18793
  },
18456
18794
  "/thermostats/schedules/delete": {
18457
18795
  post: {
18796
+ description: "Deletes a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
18458
18797
  operationId: "thermostatsSchedulesDeletePost",
18459
18798
  requestBody: {
18460
18799
  content: {
18461
18800
  "application/json": {
18462
18801
  schema: {
18463
18802
  properties: {
18464
- thermostat_schedule_id: { format: "uuid", type: "string" }
18803
+ thermostat_schedule_id: {
18804
+ description: "ID of the desired thermostat schedule.",
18805
+ format: "uuid",
18806
+ type: "string"
18807
+ }
18465
18808
  },
18466
18809
  required: ["thermostat_schedule_id"],
18467
18810
  type: "object"
@@ -18495,18 +18838,24 @@ var openapi_default = {
18495
18838
  tags: ["/thermostats"],
18496
18839
  "x-fern-sdk-group-name": ["thermostats", "schedules"],
18497
18840
  "x-fern-sdk-method-name": "delete",
18498
- "x-response-key": null
18841
+ "x-response-key": null,
18842
+ "x-title": "Delete a Thermostat Schedule"
18499
18843
  }
18500
18844
  },
18501
18845
  "/thermostats/schedules/get": {
18502
18846
  post: {
18847
+ description: "Returns a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
18503
18848
  operationId: "thermostatsSchedulesGetPost",
18504
18849
  requestBody: {
18505
18850
  content: {
18506
18851
  "application/json": {
18507
18852
  schema: {
18508
18853
  properties: {
18509
- thermostat_schedule_id: { format: "uuid", type: "string" }
18854
+ thermostat_schedule_id: {
18855
+ description: "ID of the desired thermostat schedule.",
18856
+ format: "uuid",
18857
+ type: "string"
18858
+ }
18510
18859
  },
18511
18860
  required: ["thermostat_schedule_id"],
18512
18861
  type: "object"
@@ -18546,19 +18895,28 @@ var openapi_default = {
18546
18895
  "x-fern-sdk-group-name": ["thermostats", "schedules"],
18547
18896
  "x-fern-sdk-method-name": "get",
18548
18897
  "x-fern-sdk-return-value": "thermostat_schedule",
18549
- "x-response-key": "thermostat_schedule"
18898
+ "x-response-key": "thermostat_schedule",
18899
+ "x-title": "Get a Thermostat Schedule"
18550
18900
  }
18551
18901
  },
18552
18902
  "/thermostats/schedules/list": {
18553
18903
  post: {
18904
+ description: "Returns a list of all [thermostat schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
18554
18905
  operationId: "thermostatsSchedulesListPost",
18555
18906
  requestBody: {
18556
18907
  content: {
18557
18908
  "application/json": {
18558
18909
  schema: {
18559
18910
  properties: {
18560
- device_id: { format: "uuid", type: "string" },
18561
- user_identifier_key: { type: "string" }
18911
+ device_id: {
18912
+ description: "ID of the desired thermostat device.",
18913
+ format: "uuid",
18914
+ type: "string"
18915
+ },
18916
+ user_identifier_key: {
18917
+ description: "User identifier key by which to filter the list of returned thermostat schedules.",
18918
+ type: "string"
18919
+ }
18562
18920
  },
18563
18921
  required: ["device_id"],
18564
18922
  type: "object"
@@ -18601,23 +18959,45 @@ var openapi_default = {
18601
18959
  "x-fern-sdk-group-name": ["thermostats", "schedules"],
18602
18960
  "x-fern-sdk-method-name": "list",
18603
18961
  "x-fern-sdk-return-value": "thermostat_schedules",
18604
- "x-response-key": "thermostat_schedules"
18962
+ "x-response-key": "thermostat_schedules",
18963
+ "x-title": "List Thermostat Schedules"
18605
18964
  }
18606
18965
  },
18607
18966
  "/thermostats/schedules/update": {
18608
18967
  patch: {
18968
+ description: "Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
18609
18969
  operationId: "thermostatsSchedulesUpdatePatch",
18610
18970
  requestBody: {
18611
18971
  content: {
18612
18972
  "application/json": {
18613
18973
  schema: {
18614
18974
  properties: {
18615
- climate_preset_key: { type: "string" },
18616
- ends_at: { type: "string" },
18617
- max_override_period_minutes: { minimum: 0, type: "integer" },
18618
- name: { type: "string" },
18619
- starts_at: { type: "string" },
18620
- thermostat_schedule_id: { format: "uuid", type: "string" }
18975
+ climate_preset_key: {
18976
+ description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
18977
+ type: "string"
18978
+ },
18979
+ ends_at: {
18980
+ description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
18981
+ type: "string"
18982
+ },
18983
+ max_override_period_minutes: {
18984
+ description: "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-thermostat-schedules#specifying-manual-override-permissions).",
18985
+ minimum: 0,
18986
+ type: "integer"
18987
+ },
18988
+ name: {
18989
+ description: "User-friendly name to identify the thermostat schedule.",
18990
+ type: "string"
18991
+ },
18992
+ starts_at: {
18993
+ description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
18994
+ type: "string"
18995
+ },
18996
+ thermostat_schedule_id: {
18997
+ description: "ID of the desired thermostat schedule.",
18998
+ format: "uuid",
18999
+ type: "string"
19000
+ }
18621
19001
  },
18622
19002
  required: ["thermostat_schedule_id"],
18623
19003
  type: "object"
@@ -18650,21 +19030,43 @@ var openapi_default = {
18650
19030
  summary: "/thermostats/schedules/update",
18651
19031
  tags: ["/thermostats"],
18652
19032
  "x-fern-ignore": true,
18653
- "x-response-key": null
19033
+ "x-response-key": null,
19034
+ "x-title": "Update a Thermostat Schedule"
18654
19035
  },
18655
19036
  post: {
19037
+ description: "Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
18656
19038
  operationId: "thermostatsSchedulesUpdatePost",
18657
19039
  requestBody: {
18658
19040
  content: {
18659
19041
  "application/json": {
18660
19042
  schema: {
18661
19043
  properties: {
18662
- climate_preset_key: { type: "string" },
18663
- ends_at: { type: "string" },
18664
- max_override_period_minutes: { minimum: 0, type: "integer" },
18665
- name: { type: "string" },
18666
- starts_at: { type: "string" },
18667
- thermostat_schedule_id: { format: "uuid", type: "string" }
19044
+ climate_preset_key: {
19045
+ description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
19046
+ type: "string"
19047
+ },
19048
+ ends_at: {
19049
+ description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
19050
+ type: "string"
19051
+ },
19052
+ max_override_period_minutes: {
19053
+ description: "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-thermostat-schedules#specifying-manual-override-permissions).",
19054
+ minimum: 0,
19055
+ type: "integer"
19056
+ },
19057
+ name: {
19058
+ description: "User-friendly name to identify the thermostat schedule.",
19059
+ type: "string"
19060
+ },
19061
+ starts_at: {
19062
+ description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
19063
+ type: "string"
19064
+ },
19065
+ thermostat_schedule_id: {
19066
+ description: "ID of the desired thermostat schedule.",
19067
+ format: "uuid",
19068
+ type: "string"
19069
+ }
18668
19070
  },
18669
19071
  required: ["thermostat_schedule_id"],
18670
19072
  type: "object"
@@ -18698,19 +19100,28 @@ var openapi_default = {
18698
19100
  tags: ["/thermostats"],
18699
19101
  "x-fern-sdk-group-name": ["thermostats", "schedules"],
18700
19102
  "x-fern-sdk-method-name": "update",
18701
- "x-response-key": null
19103
+ "x-response-key": null,
19104
+ "x-title": "Update a Thermostat Schedule"
18702
19105
  }
18703
19106
  },
18704
19107
  "/thermostats/set_fallback_climate_preset": {
18705
19108
  post: {
19109
+ description: 'Sets a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
18706
19110
  operationId: "thermostatsSetFallbackClimatePresetPost",
18707
19111
  requestBody: {
18708
19112
  content: {
18709
19113
  "application/json": {
18710
19114
  schema: {
18711
19115
  properties: {
18712
- climate_preset_key: { type: "string" },
18713
- device_id: { format: "uuid", type: "string" }
19116
+ climate_preset_key: {
19117
+ description: "Climate preset key of the desired climate preset.",
19118
+ type: "string"
19119
+ },
19120
+ device_id: {
19121
+ description: "ID of the desired thermostat device.",
19122
+ format: "uuid",
19123
+ type: "string"
19124
+ }
18714
19125
  },
18715
19126
  required: ["device_id", "climate_preset_key"],
18716
19127
  type: "object"
@@ -18743,23 +19154,20 @@ var openapi_default = {
18743
19154
  tags: ["/thermostats"],
18744
19155
  "x-fern-sdk-group-name": ["thermostats"],
18745
19156
  "x-fern-sdk-method-name": "set_fallback_climate_preset",
18746
- "x-response-key": null
19157
+ "x-response-key": null,
19158
+ "x-title": "Set the Fallback Climate Preset"
18747
19159
  }
18748
19160
  },
18749
19161
  "/thermostats/set_fan_mode": {
18750
19162
  post: {
18751
- description: "Sets the fan mode setting for a thermostat. See also [Setting the Current HVAC and Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings) and [Fan Mode Settings](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings).",
19163
+ description: "Sets the [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
18752
19164
  operationId: "thermostatsSetFanModePost",
18753
19165
  requestBody: {
18754
19166
  content: {
18755
19167
  "application/json": {
18756
19168
  schema: {
18757
19169
  properties: {
18758
- device_id: {
18759
- description: "ID of the thermostat device.",
18760
- format: "uuid",
18761
- type: "string"
18762
- },
19170
+ device_id: { format: "uuid", type: "string" },
18763
19171
  fan_mode: {
18764
19172
  deprecated: true,
18765
19173
  enum: ["auto", "on", "circulate"],
@@ -18767,11 +19175,15 @@ var openapi_default = {
18767
19175
  "x-deprecated": "Use `fan_mode_setting` instead."
18768
19176
  },
18769
19177
  fan_mode_setting: {
18770
- description: "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).",
19178
+ description: "Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat.",
18771
19179
  enum: ["auto", "on", "circulate"],
18772
19180
  type: "string"
18773
19181
  },
18774
- sync: { default: false, type: "boolean" }
19182
+ sync: {
19183
+ default: false,
19184
+ type: "boolean",
19185
+ "x-undocumented": "Only used internally."
19186
+ }
18775
19187
  },
18776
19188
  required: ["device_id"],
18777
19189
  type: "object"
@@ -18812,38 +19224,47 @@ var openapi_default = {
18812
19224
  "x-fern-sdk-method-name": "set_fan_mode",
18813
19225
  "x-fern-sdk-return-value": "action_attempt",
18814
19226
  "x-response-key": "action_attempt",
18815
- "x-title": "Set Fan Mode Setting"
19227
+ "x-title": "Set the Fan Mode Setting"
18816
19228
  }
18817
19229
  },
18818
19230
  "/thermostats/set_temperature_threshold": {
18819
19231
  patch: {
19232
+ description: "Sets a [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.",
18820
19233
  operationId: "thermostatsSetTemperatureThresholdPatch",
18821
19234
  requestBody: {
18822
19235
  content: {
18823
19236
  "application/json": {
18824
19237
  schema: {
18825
19238
  properties: {
18826
- device_id: { format: "uuid", type: "string" },
19239
+ device_id: {
19240
+ description: "ID of the desired thermostat device.",
19241
+ format: "uuid",
19242
+ type: "string"
19243
+ },
18827
19244
  lower_limit_celsius: {
18828
19245
  default: null,
19246
+ description: "Lower temperature limit in in \xB0C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.",
18829
19247
  format: "float",
18830
19248
  nullable: true,
18831
19249
  type: "number"
18832
19250
  },
18833
19251
  lower_limit_fahrenheit: {
18834
19252
  default: null,
19253
+ description: "Lower temperature limit in in \xB0F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.",
18835
19254
  format: "float",
18836
19255
  nullable: true,
18837
19256
  type: "number"
18838
19257
  },
18839
19258
  upper_limit_celsius: {
18840
19259
  default: null,
19260
+ description: "Upper temperature limit in in \xB0C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.",
18841
19261
  format: "float",
18842
19262
  nullable: true,
18843
19263
  type: "number"
18844
19264
  },
18845
19265
  upper_limit_fahrenheit: {
18846
19266
  default: null,
19267
+ description: "Upper temperature limit in in \xB0C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.",
18847
19268
  format: "float",
18848
19269
  nullable: true,
18849
19270
  type: "number"
@@ -18879,36 +19300,46 @@ var openapi_default = {
18879
19300
  summary: "/thermostats/set_temperature_threshold",
18880
19301
  tags: ["/thermostats"],
18881
19302
  "x-fern-ignore": true,
18882
- "x-response-key": null
19303
+ "x-response-key": null,
19304
+ "x-title": "Set a Temperature Threshold"
18883
19305
  },
18884
19306
  post: {
19307
+ description: "Sets a [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.",
18885
19308
  operationId: "thermostatsSetTemperatureThresholdPost",
18886
19309
  requestBody: {
18887
19310
  content: {
18888
19311
  "application/json": {
18889
19312
  schema: {
18890
19313
  properties: {
18891
- device_id: { format: "uuid", type: "string" },
19314
+ device_id: {
19315
+ description: "ID of the desired thermostat device.",
19316
+ format: "uuid",
19317
+ type: "string"
19318
+ },
18892
19319
  lower_limit_celsius: {
18893
19320
  default: null,
19321
+ description: "Lower temperature limit in in \xB0C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.",
18894
19322
  format: "float",
18895
19323
  nullable: true,
18896
19324
  type: "number"
18897
19325
  },
18898
19326
  lower_limit_fahrenheit: {
18899
19327
  default: null,
19328
+ description: "Lower temperature limit in in \xB0F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both.",
18900
19329
  format: "float",
18901
19330
  nullable: true,
18902
19331
  type: "number"
18903
19332
  },
18904
19333
  upper_limit_celsius: {
18905
19334
  default: null,
19335
+ description: "Upper temperature limit in in \xB0C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.",
18906
19336
  format: "float",
18907
19337
  nullable: true,
18908
19338
  type: "number"
18909
19339
  },
18910
19340
  upper_limit_fahrenheit: {
18911
19341
  default: null,
19342
+ description: "Upper temperature limit in in \xB0C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both.",
18912
19343
  format: "float",
18913
19344
  nullable: true,
18914
19345
  type: "number"
@@ -18945,45 +19376,68 @@ var openapi_default = {
18945
19376
  tags: ["/thermostats"],
18946
19377
  "x-fern-sdk-group-name": ["thermostats"],
18947
19378
  "x-fern-sdk-method-name": "set_temperature_threshold",
18948
- "x-response-key": null
19379
+ "x-response-key": null,
19380
+ "x-title": "Set a Temperature Threshold"
18949
19381
  }
18950
19382
  },
18951
19383
  "/thermostats/update_climate_preset": {
18952
19384
  patch: {
19385
+ description: "Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
18953
19386
  operationId: "thermostatsUpdateClimatePresetPatch",
18954
19387
  requestBody: {
18955
19388
  content: {
18956
19389
  "application/json": {
18957
19390
  schema: {
18958
19391
  properties: {
18959
- climate_preset_key: { type: "string" },
19392
+ climate_preset_key: {
19393
+ description: "Unique key to identify the climate preset.",
19394
+ type: "string"
19395
+ },
18960
19396
  cooling_set_point_celsius: {
19397
+ description: "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
18961
19398
  format: "float",
18962
19399
  type: "number"
18963
19400
  },
18964
19401
  cooling_set_point_fahrenheit: {
19402
+ description: "Temperature to which the thermostat should cool (in \xB0F).",
18965
19403
  format: "float",
18966
19404
  type: "number"
18967
19405
  },
18968
- device_id: { format: "uuid", type: "string" },
19406
+ device_id: {
19407
+ description: "ID of the desired thermostat device.",
19408
+ format: "uuid",
19409
+ type: "string"
19410
+ },
18969
19411
  fan_mode_setting: {
19412
+ description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
18970
19413
  enum: ["auto", "on", "circulate"],
18971
19414
  type: "string"
18972
19415
  },
18973
19416
  heating_set_point_celsius: {
19417
+ description: "Temperature to which the thermostat should heat (in \xB0C).",
18974
19418
  format: "float",
18975
19419
  type: "number"
18976
19420
  },
18977
19421
  heating_set_point_fahrenheit: {
19422
+ description: "Temperature to which the thermostat should heat (in \xB0F).",
18978
19423
  format: "float",
18979
19424
  type: "number"
18980
19425
  },
18981
19426
  hvac_mode_setting: {
19427
+ description: "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`.",
18982
19428
  enum: ["off", "heat", "cool", "heat_cool"],
18983
19429
  type: "string"
18984
19430
  },
18985
- manual_override_allowed: { type: "boolean" },
18986
- name: { default: null, nullable: true, type: "string" }
19431
+ manual_override_allowed: {
19432
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
19433
+ type: "boolean"
19434
+ },
19435
+ name: {
19436
+ default: null,
19437
+ description: "User-friendly name to identify the climate preset.",
19438
+ nullable: true,
19439
+ type: "string"
19440
+ }
18987
19441
  },
18988
19442
  required: [
18989
19443
  "device_id",
@@ -19019,43 +19473,66 @@ var openapi_default = {
19019
19473
  summary: "/thermostats/update_climate_preset",
19020
19474
  tags: ["/thermostats"],
19021
19475
  "x-fern-ignore": true,
19022
- "x-response-key": null
19476
+ "x-response-key": null,
19477
+ "x-title": "Update a Climate Preset"
19023
19478
  },
19024
19479
  post: {
19480
+ description: "Updates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
19025
19481
  operationId: "thermostatsUpdateClimatePresetPost",
19026
19482
  requestBody: {
19027
19483
  content: {
19028
19484
  "application/json": {
19029
19485
  schema: {
19030
19486
  properties: {
19031
- climate_preset_key: { type: "string" },
19487
+ climate_preset_key: {
19488
+ description: "Unique key to identify the climate preset.",
19489
+ type: "string"
19490
+ },
19032
19491
  cooling_set_point_celsius: {
19492
+ description: "Temperature to which the thermostat should cool (in \xB0C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points).",
19033
19493
  format: "float",
19034
19494
  type: "number"
19035
19495
  },
19036
19496
  cooling_set_point_fahrenheit: {
19497
+ description: "Temperature to which the thermostat should cool (in \xB0F).",
19037
19498
  format: "float",
19038
19499
  type: "number"
19039
19500
  },
19040
- device_id: { format: "uuid", type: "string" },
19501
+ device_id: {
19502
+ description: "ID of the desired thermostat device.",
19503
+ format: "uuid",
19504
+ type: "string"
19505
+ },
19041
19506
  fan_mode_setting: {
19507
+ description: "Desired fan mode setting, such as `on`, `auto`, or `circulate`.",
19042
19508
  enum: ["auto", "on", "circulate"],
19043
19509
  type: "string"
19044
19510
  },
19045
19511
  heating_set_point_celsius: {
19512
+ description: "Temperature to which the thermostat should heat (in \xB0C).",
19046
19513
  format: "float",
19047
19514
  type: "number"
19048
19515
  },
19049
19516
  heating_set_point_fahrenheit: {
19517
+ description: "Temperature to which the thermostat should heat (in \xB0F).",
19050
19518
  format: "float",
19051
19519
  type: "number"
19052
19520
  },
19053
19521
  hvac_mode_setting: {
19522
+ description: "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`.",
19054
19523
  enum: ["off", "heat", "cool", "heat_cool"],
19055
19524
  type: "string"
19056
19525
  },
19057
- manual_override_allowed: { type: "boolean" },
19058
- name: { default: null, nullable: true, type: "string" }
19526
+ manual_override_allowed: {
19527
+ description: "Indicates whether a person at the thermostat can change the thermostat's settings.",
19528
+ type: "boolean"
19529
+ },
19530
+ name: {
19531
+ default: null,
19532
+ description: "User-friendly name to identify the climate preset.",
19533
+ nullable: true,
19534
+ type: "string"
19535
+ }
19059
19536
  },
19060
19537
  required: [
19061
19538
  "device_id",
@@ -19092,7 +19569,8 @@ var openapi_default = {
19092
19569
  tags: ["/thermostats"],
19093
19570
  "x-fern-sdk-group-name": ["thermostats"],
19094
19571
  "x-fern-sdk-method-name": "update_climate_preset",
19095
- "x-response-key": null
19572
+ "x-response-key": null,
19573
+ "x-title": "Update a Climate Preset"
19096
19574
  }
19097
19575
  },
19098
19576
  "/user_identities/add_acs_user": {