@seamapi/types 1.395.3 → 1.396.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 +244 -254
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2057 -3172
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +0 -53
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +0 -23
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
- package/lib/seam/connect/models/devices/device-provider.js +2 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/thermostats/thermostat-program.js +16 -6
- package/lib/seam/connect/models/thermostats/thermostat-program.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +193 -206
- package/lib/seam/connect/openapi.js +219 -222
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1863 -2966
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +0 -35
- package/src/lib/seam/connect/models/devices/device-provider.ts +2 -0
- package/src/lib/seam/connect/models/thermostats/thermostat-program.ts +29 -15
- package/src/lib/seam/connect/openapi.ts +268 -231
- package/src/lib/seam/connect/route-types.ts +4677 -5965
package/dist/connect.cjs
CHANGED
|
@@ -156,15 +156,19 @@ var climate_preset = zod.z.object({
|
|
|
156
156
|
var climate_setting = climate_preset.partial();
|
|
157
157
|
var thermostat_daily_program_period = zod.z.object({
|
|
158
158
|
starts_at_time: zod.z.string().regex(/^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$/).describe(
|
|
159
|
-
"Time at which the thermostat daily program
|
|
159
|
+
"Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
|
|
160
160
|
),
|
|
161
161
|
climate_preset_key: zod.z.string().describe(
|
|
162
|
-
"Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time
|
|
162
|
+
"Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`."
|
|
163
163
|
)
|
|
164
|
-
})
|
|
164
|
+
}).describe(
|
|
165
|
+
"Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time."
|
|
166
|
+
);
|
|
165
167
|
var thermostat_daily_program = zod.z.object({
|
|
166
168
|
thermostat_daily_program_id: zod.z.string().uuid().describe("ID of the thermostat daily program."),
|
|
167
|
-
device_id: zod.z.string().uuid().describe(
|
|
169
|
+
device_id: zod.z.string().uuid().describe(
|
|
170
|
+
"ID of the thermostat device on which the thermostat daily program is configured."
|
|
171
|
+
),
|
|
168
172
|
name: zod.z.string().nullable().describe("User-friendly name to identify the thermostat daily program."),
|
|
169
173
|
periods: zod.z.array(thermostat_daily_program_period).describe("Array of thermostat daily program periods."),
|
|
170
174
|
workspace_id: zod.z.string().uuid().describe(
|
|
@@ -173,7 +177,12 @@ var thermostat_daily_program = zod.z.object({
|
|
|
173
177
|
created_at: zod.z.string().datetime().describe(
|
|
174
178
|
"Date and time at which the thermostat daily program was created."
|
|
175
179
|
)
|
|
176
|
-
})
|
|
180
|
+
}).describe(`
|
|
181
|
+
---
|
|
182
|
+
route_path: /thermostats/thermostat_daily_programs
|
|
183
|
+
---
|
|
184
|
+
Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.
|
|
185
|
+
`);
|
|
177
186
|
var thermostat_weekly_program = zod.z.object({
|
|
178
187
|
monday_program_id: zod.z.string().uuid().nullable().describe("ID of the thermostat daily program to run on Mondays."),
|
|
179
188
|
tuesday_program_id: zod.z.string().uuid().nullable().describe("ID of the thermostat daily program to run on Tuesdays."),
|
|
@@ -1319,7 +1328,8 @@ var DEVICE_PROVIDERS = {
|
|
|
1319
1328
|
ASSA_ABLOY_VOSTIO_CREDENTIAL_SERVICE: "assa_abloy_vostio_credential_service",
|
|
1320
1329
|
TADO: "tado",
|
|
1321
1330
|
SALTO_SPACE: "salto_space",
|
|
1322
|
-
SENSI: "sensi"
|
|
1331
|
+
SENSI: "sensi",
|
|
1332
|
+
KWIKSET2: "kwikset2"
|
|
1323
1333
|
};
|
|
1324
1334
|
var ALL_DEVICE_PROVIDERS = Object.values(DEVICE_PROVIDERS);
|
|
1325
1335
|
var PROVIDER_CATEGORY_MAP = {
|
|
@@ -1350,7 +1360,8 @@ var PROVIDER_CATEGORY_MAP = {
|
|
|
1350
1360
|
"visionline",
|
|
1351
1361
|
"assa_abloy_credential_service",
|
|
1352
1362
|
"latch",
|
|
1353
|
-
"akiles"
|
|
1363
|
+
"akiles",
|
|
1364
|
+
"sensi"
|
|
1354
1365
|
],
|
|
1355
1366
|
consumer_smartlocks: [
|
|
1356
1367
|
"akiles",
|
|
@@ -2684,24 +2695,6 @@ var acs_users_warnings = zod.z.discriminatedUnion("warning_code", [
|
|
|
2684
2695
|
]).describe(
|
|
2685
2696
|
"Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
|
|
2686
2697
|
);
|
|
2687
|
-
var common_acs_user_modification = zod.z.object({
|
|
2688
|
-
created_at: zod.z.string().datetime().describe("Date and time at which this modification was requested."),
|
|
2689
|
-
message: zod.z.string().describe("Detailed description of the modification.")
|
|
2690
|
-
});
|
|
2691
|
-
var acs_user_suspension_state_modification = common_acs_user_modification.extend({
|
|
2692
|
-
modification_code: zod.z.literal("suspension_state")
|
|
2693
|
-
}).describe(
|
|
2694
|
-
"Indicates that the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) `is_suspended` state was updated on Seam and will soon be applied to the ACS user on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
|
|
2695
|
-
);
|
|
2696
|
-
var acs_user_profile_modification = common_acs_user_modification.extend({
|
|
2697
|
-
modification_code: zod.z.literal("profile")
|
|
2698
|
-
}).describe(
|
|
2699
|
-
"Indicates that the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) profile details (name, email, phone) were updated on Seam and will soon be applied to the ACS user on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems)."
|
|
2700
|
-
);
|
|
2701
|
-
zod.z.object({
|
|
2702
|
-
suspension_state: acs_user_suspension_state_modification.optional().nullable(),
|
|
2703
|
-
profile: acs_user_profile_modification.optional().nullable()
|
|
2704
|
-
});
|
|
2705
2698
|
var user_fields = zod.z.object({
|
|
2706
2699
|
full_name: zod.z.string().trim().min(1).optional().describe(
|
|
2707
2700
|
"Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
|
|
@@ -13033,6 +13026,7 @@ var openapi_default = {
|
|
|
13033
13026
|
},
|
|
13034
13027
|
thermostat_daily_programs: {
|
|
13035
13028
|
items: {
|
|
13029
|
+
description: "Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.",
|
|
13036
13030
|
properties: {
|
|
13037
13031
|
created_at: {
|
|
13038
13032
|
description: "Date and time at which the thermostat daily program was created.",
|
|
@@ -13040,7 +13034,7 @@ var openapi_default = {
|
|
|
13040
13034
|
type: "string"
|
|
13041
13035
|
},
|
|
13042
13036
|
device_id: {
|
|
13043
|
-
description: "ID of the
|
|
13037
|
+
description: "ID of the thermostat device on which the thermostat daily program is configured.",
|
|
13044
13038
|
format: "uuid",
|
|
13045
13039
|
type: "string"
|
|
13046
13040
|
},
|
|
@@ -13052,13 +13046,14 @@ var openapi_default = {
|
|
|
13052
13046
|
periods: {
|
|
13053
13047
|
description: "Array of thermostat daily program periods.",
|
|
13054
13048
|
items: {
|
|
13049
|
+
description: "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.",
|
|
13055
13050
|
properties: {
|
|
13056
13051
|
climate_preset_key: {
|
|
13057
|
-
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time
|
|
13052
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.",
|
|
13058
13053
|
type: "string"
|
|
13059
13054
|
},
|
|
13060
13055
|
starts_at_time: {
|
|
13061
|
-
description: "Time at which the thermostat daily program
|
|
13056
|
+
description: "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
13062
13057
|
pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
|
|
13063
13058
|
type: "string"
|
|
13064
13059
|
}
|
|
@@ -13090,7 +13085,8 @@ var openapi_default = {
|
|
|
13090
13085
|
"workspace_id",
|
|
13091
13086
|
"created_at"
|
|
13092
13087
|
],
|
|
13093
|
-
type: "object"
|
|
13088
|
+
type: "object",
|
|
13089
|
+
"x-route-path": "/thermostats/thermostat_daily_programs"
|
|
13094
13090
|
},
|
|
13095
13091
|
type: "array"
|
|
13096
13092
|
},
|
|
@@ -13496,7 +13492,8 @@ var openapi_default = {
|
|
|
13496
13492
|
"assa_abloy_vostio_credential_service",
|
|
13497
13493
|
"tado",
|
|
13498
13494
|
"salto_space",
|
|
13499
|
-
"sensi"
|
|
13495
|
+
"sensi",
|
|
13496
|
+
"kwikset2"
|
|
13500
13497
|
],
|
|
13501
13498
|
type: "string"
|
|
13502
13499
|
},
|
|
@@ -23753,6 +23750,11 @@ var openapi_default = {
|
|
|
23753
23750
|
description: "ID of the user for which you want to retrieve all access groups.",
|
|
23754
23751
|
format: "uuid",
|
|
23755
23752
|
type: "string"
|
|
23753
|
+
},
|
|
23754
|
+
user_identity_id: {
|
|
23755
|
+
description: "ID of the user identity for which you want to retrieve all access groups.",
|
|
23756
|
+
format: "uuid",
|
|
23757
|
+
type: "string"
|
|
23756
23758
|
}
|
|
23757
23759
|
},
|
|
23758
23760
|
type: "object"
|
|
@@ -27971,6 +27973,7 @@ var openapi_default = {
|
|
|
27971
27973
|
"tado",
|
|
27972
27974
|
"salto_space",
|
|
27973
27975
|
"sensi",
|
|
27976
|
+
"kwikset2",
|
|
27974
27977
|
"yale_access",
|
|
27975
27978
|
"hid_cm",
|
|
27976
27979
|
"google_nest"
|
|
@@ -28331,6 +28334,10 @@ var openapi_default = {
|
|
|
28331
28334
|
description: "Returns accounts whose custom_metadata contains all of the provided key/value pairs.",
|
|
28332
28335
|
type: "object"
|
|
28333
28336
|
},
|
|
28337
|
+
customer_ids: {
|
|
28338
|
+
items: { format: "uuid", type: "string" },
|
|
28339
|
+
type: "array"
|
|
28340
|
+
},
|
|
28334
28341
|
limit: {
|
|
28335
28342
|
default: 11e3,
|
|
28336
28343
|
description: "Maximum number of records to return per page.",
|
|
@@ -28580,6 +28587,10 @@ var openapi_default = {
|
|
|
28580
28587
|
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.",
|
|
28581
28588
|
type: "object"
|
|
28582
28589
|
},
|
|
28590
|
+
customer_ids: {
|
|
28591
|
+
items: { format: "uuid", type: "string" },
|
|
28592
|
+
type: "array"
|
|
28593
|
+
},
|
|
28583
28594
|
device_ids: {
|
|
28584
28595
|
description: "Array of device IDs by which to filter devices.",
|
|
28585
28596
|
items: { format: "uuid", type: "string" },
|
|
@@ -28771,19 +28782,20 @@ var openapi_default = {
|
|
|
28771
28782
|
"unknown",
|
|
28772
28783
|
"wyze",
|
|
28773
28784
|
"yale",
|
|
28774
|
-
"minut",
|
|
28775
28785
|
"two_n",
|
|
28776
28786
|
"ttlock",
|
|
28777
|
-
"nest",
|
|
28778
28787
|
"igloohome",
|
|
28779
|
-
"ecobee",
|
|
28780
28788
|
"hubitat",
|
|
28781
28789
|
"controlbyweb",
|
|
28782
28790
|
"smartthings",
|
|
28783
28791
|
"dormakaba_oracode",
|
|
28784
28792
|
"tedee",
|
|
28785
|
-
"honeywell_resideo",
|
|
28786
28793
|
"akiles",
|
|
28794
|
+
"ecobee",
|
|
28795
|
+
"honeywell_resideo",
|
|
28796
|
+
"minut",
|
|
28797
|
+
"nest",
|
|
28798
|
+
"noiseaware",
|
|
28787
28799
|
"tado",
|
|
28788
28800
|
"sensi"
|
|
28789
28801
|
],
|
|
@@ -29118,6 +29130,10 @@ var openapi_default = {
|
|
|
29118
29130
|
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.",
|
|
29119
29131
|
type: "object"
|
|
29120
29132
|
},
|
|
29133
|
+
customer_ids: {
|
|
29134
|
+
items: { format: "uuid", type: "string" },
|
|
29135
|
+
type: "array"
|
|
29136
|
+
},
|
|
29121
29137
|
device_ids: {
|
|
29122
29138
|
description: "Array of device IDs by which to filter devices.",
|
|
29123
29139
|
items: { format: "uuid", type: "string" },
|
|
@@ -29309,19 +29325,20 @@ var openapi_default = {
|
|
|
29309
29325
|
"unknown",
|
|
29310
29326
|
"wyze",
|
|
29311
29327
|
"yale",
|
|
29312
|
-
"minut",
|
|
29313
29328
|
"two_n",
|
|
29314
29329
|
"ttlock",
|
|
29315
|
-
"nest",
|
|
29316
29330
|
"igloohome",
|
|
29317
|
-
"ecobee",
|
|
29318
29331
|
"hubitat",
|
|
29319
29332
|
"controlbyweb",
|
|
29320
29333
|
"smartthings",
|
|
29321
29334
|
"dormakaba_oracode",
|
|
29322
29335
|
"tedee",
|
|
29323
|
-
"honeywell_resideo",
|
|
29324
29336
|
"akiles",
|
|
29337
|
+
"ecobee",
|
|
29338
|
+
"honeywell_resideo",
|
|
29339
|
+
"minut",
|
|
29340
|
+
"nest",
|
|
29341
|
+
"noiseaware",
|
|
29325
29342
|
"tado",
|
|
29326
29343
|
"sensi"
|
|
29327
29344
|
],
|
|
@@ -29671,6 +29688,10 @@ var openapi_default = {
|
|
|
29671
29688
|
},
|
|
29672
29689
|
connect_webview_id: { format: "uuid", type: "string" },
|
|
29673
29690
|
connected_account_id: { format: "uuid", type: "string" },
|
|
29691
|
+
customer_ids: {
|
|
29692
|
+
items: { format: "uuid", type: "string" },
|
|
29693
|
+
type: "array"
|
|
29694
|
+
},
|
|
29674
29695
|
device_id: { format: "uuid", type: "string" },
|
|
29675
29696
|
device_ids: {
|
|
29676
29697
|
items: { format: "uuid", type: "string" },
|
|
@@ -30000,6 +30021,10 @@ var openapi_default = {
|
|
|
30000
30021
|
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.",
|
|
30001
30022
|
type: "object"
|
|
30002
30023
|
},
|
|
30024
|
+
customer_ids: {
|
|
30025
|
+
items: { format: "uuid", type: "string" },
|
|
30026
|
+
type: "array"
|
|
30027
|
+
},
|
|
30003
30028
|
device_ids: {
|
|
30004
30029
|
description: "Array of device IDs by which to filter devices.",
|
|
30005
30030
|
items: { format: "uuid", type: "string" },
|
|
@@ -30547,6 +30572,10 @@ var openapi_default = {
|
|
|
30547
30572
|
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.",
|
|
30548
30573
|
type: "object"
|
|
30549
30574
|
},
|
|
30575
|
+
customer_ids: {
|
|
30576
|
+
items: { format: "uuid", type: "string" },
|
|
30577
|
+
type: "array"
|
|
30578
|
+
},
|
|
30550
30579
|
device_ids: {
|
|
30551
30580
|
description: "Array of device IDs by which to filter devices.",
|
|
30552
30581
|
items: { format: "uuid", type: "string" },
|
|
@@ -30613,7 +30642,7 @@ var openapi_default = {
|
|
|
30613
30642
|
},
|
|
30614
30643
|
manufacturer: {
|
|
30615
30644
|
description: "Manufacturer by which to filter devices.",
|
|
30616
|
-
enum: ["
|
|
30645
|
+
enum: ["minut", "noiseaware"],
|
|
30617
30646
|
type: "string"
|
|
30618
30647
|
},
|
|
30619
30648
|
page_cursor: {
|
|
@@ -32558,11 +32587,11 @@ var openapi_default = {
|
|
|
32558
32587
|
schema: {
|
|
32559
32588
|
properties: {
|
|
32560
32589
|
climate_preset_key: {
|
|
32561
|
-
description: "Climate preset key of the
|
|
32590
|
+
description: "Climate preset key of the climate preset that you want to activate.",
|
|
32562
32591
|
type: "string"
|
|
32563
32592
|
},
|
|
32564
32593
|
device_id: {
|
|
32565
|
-
description: "ID of the
|
|
32594
|
+
description: "ID of the thermostat device for which you want to activate a climate preset.",
|
|
32566
32595
|
format: "uuid",
|
|
32567
32596
|
type: "string"
|
|
32568
32597
|
}
|
|
@@ -32609,166 +32638,6 @@ var openapi_default = {
|
|
|
32609
32638
|
"x-title": "Activate a Climate Preset"
|
|
32610
32639
|
}
|
|
32611
32640
|
},
|
|
32612
|
-
"/thermostats/activate_weekly_program": {
|
|
32613
|
-
post: {
|
|
32614
|
-
description: "Activates a thermostat weekly program.",
|
|
32615
|
-
operationId: "thermostatsActivateWeeklyProgramPost",
|
|
32616
|
-
requestBody: {
|
|
32617
|
-
content: {
|
|
32618
|
-
"application/json": {
|
|
32619
|
-
schema: {
|
|
32620
|
-
properties: {
|
|
32621
|
-
device_id: {
|
|
32622
|
-
description: "ID of the thermostat device that the weekly program is for.",
|
|
32623
|
-
format: "uuid",
|
|
32624
|
-
type: "string"
|
|
32625
|
-
},
|
|
32626
|
-
friday_program_id: {
|
|
32627
|
-
description: "ID of the thermostat daily program to run on Fridays.",
|
|
32628
|
-
format: "uuid",
|
|
32629
|
-
nullable: true,
|
|
32630
|
-
type: "string"
|
|
32631
|
-
},
|
|
32632
|
-
monday_program_id: {
|
|
32633
|
-
description: "ID of the thermostat daily program to run on Mondays.",
|
|
32634
|
-
format: "uuid",
|
|
32635
|
-
nullable: true,
|
|
32636
|
-
type: "string"
|
|
32637
|
-
},
|
|
32638
|
-
saturday_program_id: {
|
|
32639
|
-
description: "ID of the thermostat daily program to run on Saturdays.",
|
|
32640
|
-
format: "uuid",
|
|
32641
|
-
nullable: true,
|
|
32642
|
-
type: "string"
|
|
32643
|
-
},
|
|
32644
|
-
sunday_program_id: {
|
|
32645
|
-
description: "ID of the thermostat daily program to run on Sundays.",
|
|
32646
|
-
format: "uuid",
|
|
32647
|
-
nullable: true,
|
|
32648
|
-
type: "string"
|
|
32649
|
-
},
|
|
32650
|
-
thursday_program_id: {
|
|
32651
|
-
description: "ID of the thermostat daily program to run on Thursdays.",
|
|
32652
|
-
format: "uuid",
|
|
32653
|
-
nullable: true,
|
|
32654
|
-
type: "string"
|
|
32655
|
-
},
|
|
32656
|
-
tuesday_program_id: {
|
|
32657
|
-
description: "ID of the thermostat daily program to run on Tuesdays.",
|
|
32658
|
-
format: "uuid",
|
|
32659
|
-
nullable: true,
|
|
32660
|
-
type: "string"
|
|
32661
|
-
},
|
|
32662
|
-
wednesday_program_id: {
|
|
32663
|
-
description: "ID of the thermostat daily program to run on Wednesdays.",
|
|
32664
|
-
format: "uuid",
|
|
32665
|
-
nullable: true,
|
|
32666
|
-
type: "string"
|
|
32667
|
-
}
|
|
32668
|
-
},
|
|
32669
|
-
required: ["device_id"],
|
|
32670
|
-
type: "object"
|
|
32671
|
-
}
|
|
32672
|
-
}
|
|
32673
|
-
}
|
|
32674
|
-
},
|
|
32675
|
-
responses: {
|
|
32676
|
-
200: {
|
|
32677
|
-
content: {
|
|
32678
|
-
"application/json": {
|
|
32679
|
-
schema: {
|
|
32680
|
-
properties: {
|
|
32681
|
-
action_attempt: {
|
|
32682
|
-
$ref: "#/components/schemas/action_attempt"
|
|
32683
|
-
},
|
|
32684
|
-
ok: { type: "boolean" }
|
|
32685
|
-
},
|
|
32686
|
-
required: ["action_attempt", "ok"],
|
|
32687
|
-
type: "object"
|
|
32688
|
-
}
|
|
32689
|
-
}
|
|
32690
|
-
},
|
|
32691
|
-
description: "OK"
|
|
32692
|
-
},
|
|
32693
|
-
400: { description: "Bad Request" },
|
|
32694
|
-
401: { description: "Unauthorized" }
|
|
32695
|
-
},
|
|
32696
|
-
security: [
|
|
32697
|
-
{ client_session: [] },
|
|
32698
|
-
{ pat_with_workspace: [] },
|
|
32699
|
-
{ console_session_with_workspace: [] },
|
|
32700
|
-
{ api_key: [] }
|
|
32701
|
-
],
|
|
32702
|
-
summary: "/thermostats/activate_weekly_program",
|
|
32703
|
-
tags: ["/thermostats"],
|
|
32704
|
-
"x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS",
|
|
32705
|
-
"x-fern-sdk-group-name": ["thermostats"],
|
|
32706
|
-
"x-fern-sdk-method-name": "activate_weekly_program",
|
|
32707
|
-
"x-fern-sdk-return-value": "action_attempt",
|
|
32708
|
-
"x-response-key": "action_attempt",
|
|
32709
|
-
"x-title": "Activate a Thermostat Weekly Program",
|
|
32710
|
-
"x-undocumented": "Unreleased."
|
|
32711
|
-
}
|
|
32712
|
-
},
|
|
32713
|
-
"/thermostats/clear_weekly_program": {
|
|
32714
|
-
post: {
|
|
32715
|
-
description: "Clears a thermostat weekly program.",
|
|
32716
|
-
operationId: "thermostatsClearWeeklyProgramPost",
|
|
32717
|
-
requestBody: {
|
|
32718
|
-
content: {
|
|
32719
|
-
"application/json": {
|
|
32720
|
-
schema: {
|
|
32721
|
-
properties: {
|
|
32722
|
-
device_id: {
|
|
32723
|
-
description: "ID of the thermostat device to clear the weekly program for.",
|
|
32724
|
-
format: "uuid",
|
|
32725
|
-
type: "string"
|
|
32726
|
-
}
|
|
32727
|
-
},
|
|
32728
|
-
required: ["device_id"],
|
|
32729
|
-
type: "object"
|
|
32730
|
-
}
|
|
32731
|
-
}
|
|
32732
|
-
}
|
|
32733
|
-
},
|
|
32734
|
-
responses: {
|
|
32735
|
-
200: {
|
|
32736
|
-
content: {
|
|
32737
|
-
"application/json": {
|
|
32738
|
-
schema: {
|
|
32739
|
-
properties: {
|
|
32740
|
-
action_attempt: {
|
|
32741
|
-
$ref: "#/components/schemas/action_attempt"
|
|
32742
|
-
},
|
|
32743
|
-
ok: { type: "boolean" }
|
|
32744
|
-
},
|
|
32745
|
-
required: ["action_attempt", "ok"],
|
|
32746
|
-
type: "object"
|
|
32747
|
-
}
|
|
32748
|
-
}
|
|
32749
|
-
},
|
|
32750
|
-
description: "OK"
|
|
32751
|
-
},
|
|
32752
|
-
400: { description: "Bad Request" },
|
|
32753
|
-
401: { description: "Unauthorized" }
|
|
32754
|
-
},
|
|
32755
|
-
security: [
|
|
32756
|
-
{ client_session: [] },
|
|
32757
|
-
{ pat_with_workspace: [] },
|
|
32758
|
-
{ console_session_with_workspace: [] },
|
|
32759
|
-
{ api_key: [] }
|
|
32760
|
-
],
|
|
32761
|
-
summary: "/thermostats/clear_weekly_program",
|
|
32762
|
-
tags: ["/thermostats"],
|
|
32763
|
-
"x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS",
|
|
32764
|
-
"x-fern-sdk-group-name": ["thermostats"],
|
|
32765
|
-
"x-fern-sdk-method-name": "clear_weekly_program",
|
|
32766
|
-
"x-fern-sdk-return-value": "action_attempt",
|
|
32767
|
-
"x-response-key": "action_attempt",
|
|
32768
|
-
"x-title": "Clear a Thermostat Weekly Program",
|
|
32769
|
-
"x-undocumented": "Unreleased."
|
|
32770
|
-
}
|
|
32771
|
-
},
|
|
32772
32641
|
"/thermostats/cool": {
|
|
32773
32642
|
post: {
|
|
32774
32643
|
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).",
|
|
@@ -32789,7 +32658,7 @@ var openapi_default = {
|
|
|
32789
32658
|
type: "number"
|
|
32790
32659
|
},
|
|
32791
32660
|
device_id: {
|
|
32792
|
-
description: "ID of the
|
|
32661
|
+
description: "ID of the thermostat device that you want to set to cool mode.",
|
|
32793
32662
|
format: "uuid",
|
|
32794
32663
|
type: "string"
|
|
32795
32664
|
},
|
|
@@ -32866,7 +32735,7 @@ var openapi_default = {
|
|
|
32866
32735
|
type: "number"
|
|
32867
32736
|
},
|
|
32868
32737
|
device_id: {
|
|
32869
|
-
description: "ID of the
|
|
32738
|
+
description: "ID of the thermostat device for which you want create a climate preset.",
|
|
32870
32739
|
format: "uuid",
|
|
32871
32740
|
type: "string"
|
|
32872
32741
|
},
|
|
@@ -32942,7 +32811,7 @@ var openapi_default = {
|
|
|
32942
32811
|
},
|
|
32943
32812
|
"/thermostats/daily_programs/create": {
|
|
32944
32813
|
post: {
|
|
32945
|
-
description: "Creates a thermostat daily program.",
|
|
32814
|
+
description: "Creates a thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.",
|
|
32946
32815
|
operationId: "thermostatsDailyProgramsCreatePost",
|
|
32947
32816
|
requestBody: {
|
|
32948
32817
|
content: {
|
|
@@ -32950,7 +32819,7 @@ var openapi_default = {
|
|
|
32950
32819
|
schema: {
|
|
32951
32820
|
properties: {
|
|
32952
32821
|
device_id: {
|
|
32953
|
-
description: "ID of the
|
|
32822
|
+
description: "ID of the thermostat device for which you want to create a daily program.",
|
|
32954
32823
|
format: "uuid",
|
|
32955
32824
|
type: "string"
|
|
32956
32825
|
},
|
|
@@ -32961,13 +32830,14 @@ var openapi_default = {
|
|
|
32961
32830
|
periods: {
|
|
32962
32831
|
description: "Array of thermostat daily program periods.",
|
|
32963
32832
|
items: {
|
|
32833
|
+
description: "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.",
|
|
32964
32834
|
properties: {
|
|
32965
32835
|
climate_preset_key: {
|
|
32966
|
-
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time
|
|
32836
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.",
|
|
32967
32837
|
type: "string"
|
|
32968
32838
|
},
|
|
32969
32839
|
starts_at_time: {
|
|
32970
|
-
description: "Time at which the thermostat daily program
|
|
32840
|
+
description: "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
32971
32841
|
pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
|
|
32972
32842
|
type: "string"
|
|
32973
32843
|
}
|
|
@@ -32992,6 +32862,7 @@ var openapi_default = {
|
|
|
32992
32862
|
properties: {
|
|
32993
32863
|
ok: { type: "boolean" },
|
|
32994
32864
|
thermostat_daily_program: {
|
|
32865
|
+
description: "Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.",
|
|
32995
32866
|
properties: {
|
|
32996
32867
|
created_at: {
|
|
32997
32868
|
description: "Date and time at which the thermostat daily program was created.",
|
|
@@ -32999,7 +32870,7 @@ var openapi_default = {
|
|
|
32999
32870
|
type: "string"
|
|
33000
32871
|
},
|
|
33001
32872
|
device_id: {
|
|
33002
|
-
description: "ID of the
|
|
32873
|
+
description: "ID of the thermostat device on which the thermostat daily program is configured.",
|
|
33003
32874
|
format: "uuid",
|
|
33004
32875
|
type: "string"
|
|
33005
32876
|
},
|
|
@@ -33011,13 +32882,14 @@ var openapi_default = {
|
|
|
33011
32882
|
periods: {
|
|
33012
32883
|
description: "Array of thermostat daily program periods.",
|
|
33013
32884
|
items: {
|
|
32885
|
+
description: "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.",
|
|
33014
32886
|
properties: {
|
|
33015
32887
|
climate_preset_key: {
|
|
33016
|
-
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time
|
|
32888
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.",
|
|
33017
32889
|
type: "string"
|
|
33018
32890
|
},
|
|
33019
32891
|
starts_at_time: {
|
|
33020
|
-
description: "Time at which the thermostat daily program
|
|
32892
|
+
description: "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
33021
32893
|
pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
|
|
33022
32894
|
type: "string"
|
|
33023
32895
|
}
|
|
@@ -33046,7 +32918,8 @@ var openapi_default = {
|
|
|
33046
32918
|
"workspace_id",
|
|
33047
32919
|
"created_at"
|
|
33048
32920
|
],
|
|
33049
|
-
type: "object"
|
|
32921
|
+
type: "object",
|
|
32922
|
+
"x-route-path": "/thermostats/thermostat_daily_programs"
|
|
33050
32923
|
}
|
|
33051
32924
|
},
|
|
33052
32925
|
required: ["thermostat_daily_program", "ok"],
|
|
@@ -33071,8 +32944,7 @@ var openapi_default = {
|
|
|
33071
32944
|
"x-fern-sdk-method-name": "create",
|
|
33072
32945
|
"x-fern-sdk-return-value": "thermostat_daily_program",
|
|
33073
32946
|
"x-response-key": "thermostat_daily_program",
|
|
33074
|
-
"x-title": "Create a Thermostat Daily Program"
|
|
33075
|
-
"x-undocumented": "Unreleased."
|
|
32947
|
+
"x-title": "Create a Thermostat Daily Program"
|
|
33076
32948
|
}
|
|
33077
32949
|
},
|
|
33078
32950
|
"/thermostats/daily_programs/delete": {
|
|
@@ -33085,7 +32957,7 @@ var openapi_default = {
|
|
|
33085
32957
|
schema: {
|
|
33086
32958
|
properties: {
|
|
33087
32959
|
thermostat_daily_program_id: {
|
|
33088
|
-
description: "ID of the
|
|
32960
|
+
description: "ID of the thermostat daily program that you want to delete.",
|
|
33089
32961
|
format: "uuid",
|
|
33090
32962
|
type: "string"
|
|
33091
32963
|
}
|
|
@@ -33123,13 +32995,12 @@ var openapi_default = {
|
|
|
33123
32995
|
"x-fern-sdk-group-name": ["thermostats", "daily_programs"],
|
|
33124
32996
|
"x-fern-sdk-method-name": "delete",
|
|
33125
32997
|
"x-response-key": null,
|
|
33126
|
-
"x-title": "Delete a Thermostat Daily Program"
|
|
33127
|
-
"x-undocumented": "Unreleased."
|
|
32998
|
+
"x-title": "Delete a Thermostat Daily Program"
|
|
33128
32999
|
}
|
|
33129
33000
|
},
|
|
33130
33001
|
"/thermostats/daily_programs/update": {
|
|
33131
33002
|
patch: {
|
|
33132
|
-
description: "Updates a specified thermostat daily program.",
|
|
33003
|
+
description: "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.",
|
|
33133
33004
|
operationId: "thermostatsDailyProgramsUpdatePatch",
|
|
33134
33005
|
requestBody: {
|
|
33135
33006
|
content: {
|
|
@@ -33137,19 +33008,20 @@ var openapi_default = {
|
|
|
33137
33008
|
schema: {
|
|
33138
33009
|
properties: {
|
|
33139
33010
|
name: {
|
|
33140
|
-
description: "User-friendly name to identify the thermostat daily program.",
|
|
33011
|
+
description: "User-friendly name to identify the thermostat daily program that you want to update.",
|
|
33141
33012
|
type: "string"
|
|
33142
33013
|
},
|
|
33143
33014
|
periods: {
|
|
33144
|
-
description: "Array of thermostat daily program periods.",
|
|
33015
|
+
description: "Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.",
|
|
33145
33016
|
items: {
|
|
33017
|
+
description: "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.",
|
|
33146
33018
|
properties: {
|
|
33147
33019
|
climate_preset_key: {
|
|
33148
|
-
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time
|
|
33020
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.",
|
|
33149
33021
|
type: "string"
|
|
33150
33022
|
},
|
|
33151
33023
|
starts_at_time: {
|
|
33152
|
-
description: "Time at which the thermostat daily program
|
|
33024
|
+
description: "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
33153
33025
|
pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
|
|
33154
33026
|
type: "string"
|
|
33155
33027
|
}
|
|
@@ -33160,7 +33032,7 @@ var openapi_default = {
|
|
|
33160
33032
|
type: "array"
|
|
33161
33033
|
},
|
|
33162
33034
|
thermostat_daily_program_id: {
|
|
33163
|
-
description: "ID of the
|
|
33035
|
+
description: "ID of the thermostat daily program that you want to update.",
|
|
33164
33036
|
format: "uuid",
|
|
33165
33037
|
type: "string"
|
|
33166
33038
|
}
|
|
@@ -33203,11 +33075,10 @@ var openapi_default = {
|
|
|
33203
33075
|
"x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS",
|
|
33204
33076
|
"x-fern-ignore": true,
|
|
33205
33077
|
"x-response-key": "action_attempt",
|
|
33206
|
-
"x-title": "Update a Thermostat Daily Program"
|
|
33207
|
-
"x-undocumented": "Unreleased."
|
|
33078
|
+
"x-title": "Update a Thermostat Daily Program"
|
|
33208
33079
|
},
|
|
33209
33080
|
post: {
|
|
33210
|
-
description: "Updates a specified thermostat daily program.",
|
|
33081
|
+
description: "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.",
|
|
33211
33082
|
operationId: "thermostatsDailyProgramsUpdatePost",
|
|
33212
33083
|
requestBody: {
|
|
33213
33084
|
content: {
|
|
@@ -33215,19 +33086,20 @@ var openapi_default = {
|
|
|
33215
33086
|
schema: {
|
|
33216
33087
|
properties: {
|
|
33217
33088
|
name: {
|
|
33218
|
-
description: "User-friendly name to identify the thermostat daily program.",
|
|
33089
|
+
description: "User-friendly name to identify the thermostat daily program that you want to update.",
|
|
33219
33090
|
type: "string"
|
|
33220
33091
|
},
|
|
33221
33092
|
periods: {
|
|
33222
|
-
description: "Array of thermostat daily program periods.",
|
|
33093
|
+
description: "Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.",
|
|
33223
33094
|
items: {
|
|
33095
|
+
description: "Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.",
|
|
33224
33096
|
properties: {
|
|
33225
33097
|
climate_preset_key: {
|
|
33226
|
-
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time
|
|
33098
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.",
|
|
33227
33099
|
type: "string"
|
|
33228
33100
|
},
|
|
33229
33101
|
starts_at_time: {
|
|
33230
|
-
description: "Time at which the thermostat daily program
|
|
33102
|
+
description: "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
33231
33103
|
pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
|
|
33232
33104
|
type: "string"
|
|
33233
33105
|
}
|
|
@@ -33238,7 +33110,7 @@ var openapi_default = {
|
|
|
33238
33110
|
type: "array"
|
|
33239
33111
|
},
|
|
33240
33112
|
thermostat_daily_program_id: {
|
|
33241
|
-
description: "ID of the
|
|
33113
|
+
description: "ID of the thermostat daily program that you want to update.",
|
|
33242
33114
|
format: "uuid",
|
|
33243
33115
|
type: "string"
|
|
33244
33116
|
}
|
|
@@ -33283,8 +33155,7 @@ var openapi_default = {
|
|
|
33283
33155
|
"x-fern-sdk-method-name": "update",
|
|
33284
33156
|
"x-fern-sdk-return-value": "action_attempt",
|
|
33285
33157
|
"x-response-key": "action_attempt",
|
|
33286
|
-
"x-title": "Update a Thermostat Daily Program"
|
|
33287
|
-
"x-undocumented": "Unreleased."
|
|
33158
|
+
"x-title": "Update a Thermostat Daily Program"
|
|
33288
33159
|
}
|
|
33289
33160
|
},
|
|
33290
33161
|
"/thermostats/delete_climate_preset": {
|
|
@@ -33297,11 +33168,11 @@ var openapi_default = {
|
|
|
33297
33168
|
schema: {
|
|
33298
33169
|
properties: {
|
|
33299
33170
|
climate_preset_key: {
|
|
33300
|
-
description: "Climate preset key of the
|
|
33171
|
+
description: "Climate preset key of the climate preset that you want to delete.",
|
|
33301
33172
|
type: "string"
|
|
33302
33173
|
},
|
|
33303
33174
|
device_id: {
|
|
33304
|
-
description: "ID of the
|
|
33175
|
+
description: "ID of the thermostat device for which you want to delete a climate preset.",
|
|
33305
33176
|
format: "uuid",
|
|
33306
33177
|
type: "string"
|
|
33307
33178
|
}
|
|
@@ -33352,12 +33223,12 @@ var openapi_default = {
|
|
|
33352
33223
|
schema: {
|
|
33353
33224
|
properties: {
|
|
33354
33225
|
device_id: {
|
|
33355
|
-
description: "ID of the
|
|
33226
|
+
description: "ID of the thermostat device that you want to retrieve.",
|
|
33356
33227
|
format: "uuid",
|
|
33357
33228
|
type: "string"
|
|
33358
33229
|
},
|
|
33359
33230
|
name: {
|
|
33360
|
-
description: "User-friendly name of the
|
|
33231
|
+
description: "User-friendly name of the thermostat device that you want to retrieve.",
|
|
33361
33232
|
type: "string"
|
|
33362
33233
|
}
|
|
33363
33234
|
},
|
|
@@ -33412,7 +33283,7 @@ var openapi_default = {
|
|
|
33412
33283
|
schema: {
|
|
33413
33284
|
properties: {
|
|
33414
33285
|
device_id: {
|
|
33415
|
-
description: "ID of the
|
|
33286
|
+
description: "ID of the thermostat device that you want to set to heat mode.",
|
|
33416
33287
|
format: "uuid",
|
|
33417
33288
|
type: "string"
|
|
33418
33289
|
},
|
|
@@ -33495,7 +33366,7 @@ var openapi_default = {
|
|
|
33495
33366
|
type: "number"
|
|
33496
33367
|
},
|
|
33497
33368
|
device_id: {
|
|
33498
|
-
description: "ID of the
|
|
33369
|
+
description: "ID of the thermostat device that you want to set to heat-cool mode.",
|
|
33499
33370
|
format: "uuid",
|
|
33500
33371
|
type: "string"
|
|
33501
33372
|
},
|
|
@@ -33594,13 +33465,17 @@ var openapi_default = {
|
|
|
33594
33465
|
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.",
|
|
33595
33466
|
type: "object"
|
|
33596
33467
|
},
|
|
33468
|
+
customer_ids: {
|
|
33469
|
+
items: { format: "uuid", type: "string" },
|
|
33470
|
+
type: "array"
|
|
33471
|
+
},
|
|
33597
33472
|
device_ids: {
|
|
33598
33473
|
description: "Array of device IDs by which to filter devices.",
|
|
33599
33474
|
items: { format: "uuid", type: "string" },
|
|
33600
33475
|
type: "array"
|
|
33601
33476
|
},
|
|
33602
33477
|
device_type: {
|
|
33603
|
-
description: "Device type by which to filter devices.",
|
|
33478
|
+
description: "Device type by which to filter thermostat devices.",
|
|
33604
33479
|
enum: [
|
|
33605
33480
|
"ecobee_thermostat",
|
|
33606
33481
|
"nest_thermostat",
|
|
@@ -33611,7 +33486,7 @@ var openapi_default = {
|
|
|
33611
33486
|
type: "string"
|
|
33612
33487
|
},
|
|
33613
33488
|
device_types: {
|
|
33614
|
-
description: "Array of device types by which to filter devices.",
|
|
33489
|
+
description: "Array of device types by which to filter thermostat devices.",
|
|
33615
33490
|
items: {
|
|
33616
33491
|
enum: [
|
|
33617
33492
|
"ecobee_thermostat",
|
|
@@ -33671,8 +33546,14 @@ var openapi_default = {
|
|
|
33671
33546
|
type: "number"
|
|
33672
33547
|
},
|
|
33673
33548
|
manufacturer: {
|
|
33674
|
-
description: "Manufacturer by which to filter devices.",
|
|
33675
|
-
enum: [
|
|
33549
|
+
description: "Manufacturer by which to filter thermostat devices.",
|
|
33550
|
+
enum: [
|
|
33551
|
+
"ecobee",
|
|
33552
|
+
"honeywell_resideo",
|
|
33553
|
+
"nest",
|
|
33554
|
+
"tado",
|
|
33555
|
+
"sensi"
|
|
33556
|
+
],
|
|
33676
33557
|
type: "string"
|
|
33677
33558
|
},
|
|
33678
33559
|
page_cursor: {
|
|
@@ -33747,7 +33628,7 @@ var openapi_default = {
|
|
|
33747
33628
|
schema: {
|
|
33748
33629
|
properties: {
|
|
33749
33630
|
device_id: {
|
|
33750
|
-
description: "ID of the
|
|
33631
|
+
description: "ID of the thermostat device that you want to set to off mode.",
|
|
33751
33632
|
format: "uuid",
|
|
33752
33633
|
type: "string"
|
|
33753
33634
|
},
|
|
@@ -34223,11 +34104,11 @@ var openapi_default = {
|
|
|
34223
34104
|
schema: {
|
|
34224
34105
|
properties: {
|
|
34225
34106
|
climate_preset_key: {
|
|
34226
|
-
description: "Climate preset key of the
|
|
34107
|
+
description: "Climate preset key of the climate preset that you want to set as the fallback climate preset.",
|
|
34227
34108
|
type: "string"
|
|
34228
34109
|
},
|
|
34229
34110
|
device_id: {
|
|
34230
|
-
description: "ID of the
|
|
34111
|
+
description: "ID of the thermostat device for which you want to set the fallback climate preset.",
|
|
34231
34112
|
format: "uuid",
|
|
34232
34113
|
type: "string"
|
|
34233
34114
|
}
|
|
@@ -34276,7 +34157,11 @@ var openapi_default = {
|
|
|
34276
34157
|
"application/json": {
|
|
34277
34158
|
schema: {
|
|
34278
34159
|
properties: {
|
|
34279
|
-
device_id: {
|
|
34160
|
+
device_id: {
|
|
34161
|
+
description: "ID of the thermostat device for which you want to set the fan mode.",
|
|
34162
|
+
format: "uuid",
|
|
34163
|
+
type: "string"
|
|
34164
|
+
},
|
|
34280
34165
|
fan_mode: {
|
|
34281
34166
|
deprecated: true,
|
|
34282
34167
|
enum: ["auto", "on", "circulate"],
|
|
@@ -34350,7 +34235,7 @@ var openapi_default = {
|
|
|
34350
34235
|
{
|
|
34351
34236
|
properties: {
|
|
34352
34237
|
device_id: {
|
|
34353
|
-
description: "ID of the
|
|
34238
|
+
description: "ID of the thermostat device for which you want to set the HVAC mode.",
|
|
34354
34239
|
format: "uuid",
|
|
34355
34240
|
type: "string"
|
|
34356
34241
|
},
|
|
@@ -34372,7 +34257,7 @@ var openapi_default = {
|
|
|
34372
34257
|
type: "number"
|
|
34373
34258
|
},
|
|
34374
34259
|
device_id: {
|
|
34375
|
-
description: "ID of the
|
|
34260
|
+
description: "ID of the thermostat device for which you want to set the HVAC mode.",
|
|
34376
34261
|
format: "uuid",
|
|
34377
34262
|
type: "string"
|
|
34378
34263
|
},
|
|
@@ -34384,7 +34269,7 @@ var openapi_default = {
|
|
|
34384
34269
|
{
|
|
34385
34270
|
properties: {
|
|
34386
34271
|
device_id: {
|
|
34387
|
-
description: "ID of the
|
|
34272
|
+
description: "ID of the thermostat device for which you want to set the HVAC mode.",
|
|
34388
34273
|
format: "uuid",
|
|
34389
34274
|
type: "string"
|
|
34390
34275
|
},
|
|
@@ -34416,7 +34301,7 @@ var openapi_default = {
|
|
|
34416
34301
|
type: "number"
|
|
34417
34302
|
},
|
|
34418
34303
|
device_id: {
|
|
34419
|
-
description: "ID of the
|
|
34304
|
+
description: "ID of the thermostat device for which you want to set the HVAC mode.",
|
|
34420
34305
|
format: "uuid",
|
|
34421
34306
|
type: "string"
|
|
34422
34307
|
},
|
|
@@ -34490,7 +34375,7 @@ var openapi_default = {
|
|
|
34490
34375
|
schema: {
|
|
34491
34376
|
properties: {
|
|
34492
34377
|
device_id: {
|
|
34493
|
-
description: "ID of the
|
|
34378
|
+
description: "ID of the thermostat device for which you want to set a temperature threshold.",
|
|
34494
34379
|
format: "uuid",
|
|
34495
34380
|
type: "string"
|
|
34496
34381
|
},
|
|
@@ -34565,7 +34450,7 @@ var openapi_default = {
|
|
|
34565
34450
|
schema: {
|
|
34566
34451
|
properties: {
|
|
34567
34452
|
device_id: {
|
|
34568
|
-
description: "ID of the
|
|
34453
|
+
description: "ID of the thermostat device for which you want to set a temperature threshold.",
|
|
34569
34454
|
format: "uuid",
|
|
34570
34455
|
type: "string"
|
|
34571
34456
|
},
|
|
@@ -34865,7 +34750,7 @@ var openapi_default = {
|
|
|
34865
34750
|
type: "number"
|
|
34866
34751
|
},
|
|
34867
34752
|
device_id: {
|
|
34868
|
-
description: "ID of the
|
|
34753
|
+
description: "ID of the thermostat device for which you want to update a climate preset.",
|
|
34869
34754
|
format: "uuid",
|
|
34870
34755
|
type: "string"
|
|
34871
34756
|
},
|
|
@@ -34963,7 +34848,7 @@ var openapi_default = {
|
|
|
34963
34848
|
type: "number"
|
|
34964
34849
|
},
|
|
34965
34850
|
device_id: {
|
|
34966
|
-
description: "ID of the
|
|
34851
|
+
description: "ID of the thermostat device for which you want to update a climate preset.",
|
|
34967
34852
|
format: "uuid",
|
|
34968
34853
|
type: "string"
|
|
34969
34854
|
},
|
|
@@ -35040,6 +34925,106 @@ var openapi_default = {
|
|
|
35040
34925
|
"x-title": "Update a Climate Preset"
|
|
35041
34926
|
}
|
|
35042
34927
|
},
|
|
34928
|
+
"/thermostats/update_weekly_program": {
|
|
34929
|
+
post: {
|
|
34930
|
+
description: "Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.",
|
|
34931
|
+
operationId: "thermostatsUpdateWeeklyProgramPost",
|
|
34932
|
+
requestBody: {
|
|
34933
|
+
content: {
|
|
34934
|
+
"application/json": {
|
|
34935
|
+
schema: {
|
|
34936
|
+
properties: {
|
|
34937
|
+
device_id: {
|
|
34938
|
+
description: "ID of the thermostat device for which you want to update the weekly program.",
|
|
34939
|
+
format: "uuid",
|
|
34940
|
+
type: "string"
|
|
34941
|
+
},
|
|
34942
|
+
friday_program_id: {
|
|
34943
|
+
description: "ID of the thermostat daily program to run on Fridays.",
|
|
34944
|
+
format: "uuid",
|
|
34945
|
+
nullable: true,
|
|
34946
|
+
type: "string"
|
|
34947
|
+
},
|
|
34948
|
+
monday_program_id: {
|
|
34949
|
+
description: "ID of the thermostat daily program to run on Mondays.",
|
|
34950
|
+
format: "uuid",
|
|
34951
|
+
nullable: true,
|
|
34952
|
+
type: "string"
|
|
34953
|
+
},
|
|
34954
|
+
saturday_program_id: {
|
|
34955
|
+
description: "ID of the thermostat daily program to run on Saturdays.",
|
|
34956
|
+
format: "uuid",
|
|
34957
|
+
nullable: true,
|
|
34958
|
+
type: "string"
|
|
34959
|
+
},
|
|
34960
|
+
sunday_program_id: {
|
|
34961
|
+
description: "ID of the thermostat daily program to run on Sundays.",
|
|
34962
|
+
format: "uuid",
|
|
34963
|
+
nullable: true,
|
|
34964
|
+
type: "string"
|
|
34965
|
+
},
|
|
34966
|
+
thursday_program_id: {
|
|
34967
|
+
description: "ID of the thermostat daily program to run on Thursdays.",
|
|
34968
|
+
format: "uuid",
|
|
34969
|
+
nullable: true,
|
|
34970
|
+
type: "string"
|
|
34971
|
+
},
|
|
34972
|
+
tuesday_program_id: {
|
|
34973
|
+
description: "ID of the thermostat daily program to run on Tuesdays.",
|
|
34974
|
+
format: "uuid",
|
|
34975
|
+
nullable: true,
|
|
34976
|
+
type: "string"
|
|
34977
|
+
},
|
|
34978
|
+
wednesday_program_id: {
|
|
34979
|
+
description: "ID of the thermostat daily program to run on Wednesdays.",
|
|
34980
|
+
format: "uuid",
|
|
34981
|
+
nullable: true,
|
|
34982
|
+
type: "string"
|
|
34983
|
+
}
|
|
34984
|
+
},
|
|
34985
|
+
required: ["device_id"],
|
|
34986
|
+
type: "object"
|
|
34987
|
+
}
|
|
34988
|
+
}
|
|
34989
|
+
}
|
|
34990
|
+
},
|
|
34991
|
+
responses: {
|
|
34992
|
+
200: {
|
|
34993
|
+
content: {
|
|
34994
|
+
"application/json": {
|
|
34995
|
+
schema: {
|
|
34996
|
+
properties: {
|
|
34997
|
+
action_attempt: {
|
|
34998
|
+
$ref: "#/components/schemas/action_attempt"
|
|
34999
|
+
},
|
|
35000
|
+
ok: { type: "boolean" }
|
|
35001
|
+
},
|
|
35002
|
+
required: ["action_attempt", "ok"],
|
|
35003
|
+
type: "object"
|
|
35004
|
+
}
|
|
35005
|
+
}
|
|
35006
|
+
},
|
|
35007
|
+
description: "OK"
|
|
35008
|
+
},
|
|
35009
|
+
400: { description: "Bad Request" },
|
|
35010
|
+
401: { description: "Unauthorized" }
|
|
35011
|
+
},
|
|
35012
|
+
security: [
|
|
35013
|
+
{ client_session: [] },
|
|
35014
|
+
{ pat_with_workspace: [] },
|
|
35015
|
+
{ console_session_with_workspace: [] },
|
|
35016
|
+
{ api_key: [] }
|
|
35017
|
+
],
|
|
35018
|
+
summary: "/thermostats/update_weekly_program",
|
|
35019
|
+
tags: ["/thermostats"],
|
|
35020
|
+
"x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS",
|
|
35021
|
+
"x-fern-sdk-group-name": ["thermostats"],
|
|
35022
|
+
"x-fern-sdk-method-name": "update_weekly_program",
|
|
35023
|
+
"x-fern-sdk-return-value": "action_attempt",
|
|
35024
|
+
"x-response-key": "action_attempt",
|
|
35025
|
+
"x-title": "Update the Thermostat Weekly Program"
|
|
35026
|
+
}
|
|
35027
|
+
},
|
|
35043
35028
|
"/unstable_access_grants/create": {
|
|
35044
35029
|
post: {
|
|
35045
35030
|
description: "Creates a new access grant.",
|
|
@@ -36838,6 +36823,11 @@ var openapi_default = {
|
|
|
36838
36823
|
"application/json": {
|
|
36839
36824
|
schema: {
|
|
36840
36825
|
properties: {
|
|
36826
|
+
acs_system_ids: {
|
|
36827
|
+
description: "List of ACS system IDs to associate with the user identity through ACS users. If there's no user with the same email address or phone number in the specified ACS systems, a new ACS user is created. If there is an existing user with the same email or phone number in the specified ACS systems, the user is linked to the user identity.",
|
|
36828
|
+
items: { format: "uuid", type: "string" },
|
|
36829
|
+
type: "array"
|
|
36830
|
+
},
|
|
36841
36831
|
email_address: {
|
|
36842
36832
|
description: "Unique email address for the user identity.",
|
|
36843
36833
|
format: "email",
|