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