@seamapi/types 1.396.0 → 1.397.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 +102 -94
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +113 -106
- 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-type.d.ts +1 -0
- package/lib/seam/connect/models/devices/device-type.js +1 -0
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +3 -3
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +3 -3
- 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 +10 -5
- package/lib/seam/connect/openapi.js +72 -56
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +97 -95
- 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-type.ts +1 -0
- package/src/lib/seam/connect/models/thermostats/thermostat-program.ts +29 -15
- package/src/lib/seam/connect/openapi.ts +111 -56
- package/src/lib/seam/connect/route-types.ts +97 -74
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."),
|
|
@@ -911,7 +920,8 @@ var THERMOSTAT_DEVICE_TYPE = {
|
|
|
911
920
|
NEST_THERMOSTAT: "nest_thermostat",
|
|
912
921
|
HONEYWELL_RESIDEO_THERMOSTAT: "honeywell_resideo_thermostat",
|
|
913
922
|
TADO_THERMOSTAT: "tado_thermostat",
|
|
914
|
-
SENSI_THERMOSTAT: "sensi_thermostat"
|
|
923
|
+
SENSI_THERMOSTAT: "sensi_thermostat",
|
|
924
|
+
SMARTTHINGS_THERMOSTAT: "smartthings_thermostat"
|
|
915
925
|
};
|
|
916
926
|
var thermostat_device_type = zod.z.enum(
|
|
917
927
|
Object.values(THERMOSTAT_DEVICE_TYPE)
|
|
@@ -2686,24 +2696,6 @@ var acs_users_warnings = zod.z.discriminatedUnion("warning_code", [
|
|
|
2686
2696
|
]).describe(
|
|
2687
2697
|
"Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
|
|
2688
2698
|
);
|
|
2689
|
-
var common_acs_user_modification = zod.z.object({
|
|
2690
|
-
created_at: zod.z.string().datetime().describe("Date and time at which this modification was requested."),
|
|
2691
|
-
message: zod.z.string().describe("Detailed description of the modification.")
|
|
2692
|
-
});
|
|
2693
|
-
var acs_user_suspension_state_modification = common_acs_user_modification.extend({
|
|
2694
|
-
modification_code: zod.z.literal("suspension_state")
|
|
2695
|
-
}).describe(
|
|
2696
|
-
"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)."
|
|
2697
|
-
);
|
|
2698
|
-
var acs_user_profile_modification = common_acs_user_modification.extend({
|
|
2699
|
-
modification_code: zod.z.literal("profile")
|
|
2700
|
-
}).describe(
|
|
2701
|
-
"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)."
|
|
2702
|
-
);
|
|
2703
|
-
zod.z.object({
|
|
2704
|
-
suspension_state: acs_user_suspension_state_modification.optional().nullable(),
|
|
2705
|
-
profile: acs_user_profile_modification.optional().nullable()
|
|
2706
|
-
});
|
|
2707
2699
|
var user_fields = zod.z.object({
|
|
2708
2700
|
full_name: zod.z.string().trim().min(1).optional().describe(
|
|
2709
2701
|
"Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
|
|
@@ -11437,7 +11429,8 @@ var openapi_default = {
|
|
|
11437
11429
|
"nest_thermostat",
|
|
11438
11430
|
"honeywell_resideo_thermostat",
|
|
11439
11431
|
"tado_thermostat",
|
|
11440
|
-
"sensi_thermostat"
|
|
11432
|
+
"sensi_thermostat",
|
|
11433
|
+
"smartthings_thermostat"
|
|
11441
11434
|
],
|
|
11442
11435
|
type: "string"
|
|
11443
11436
|
},
|
|
@@ -13035,6 +13028,7 @@ var openapi_default = {
|
|
|
13035
13028
|
},
|
|
13036
13029
|
thermostat_daily_programs: {
|
|
13037
13030
|
items: {
|
|
13031
|
+
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.",
|
|
13038
13032
|
properties: {
|
|
13039
13033
|
created_at: {
|
|
13040
13034
|
description: "Date and time at which the thermostat daily program was created.",
|
|
@@ -13042,7 +13036,7 @@ var openapi_default = {
|
|
|
13042
13036
|
type: "string"
|
|
13043
13037
|
},
|
|
13044
13038
|
device_id: {
|
|
13045
|
-
description: "ID of the
|
|
13039
|
+
description: "ID of the thermostat device on which the thermostat daily program is configured.",
|
|
13046
13040
|
format: "uuid",
|
|
13047
13041
|
type: "string"
|
|
13048
13042
|
},
|
|
@@ -13054,13 +13048,14 @@ var openapi_default = {
|
|
|
13054
13048
|
periods: {
|
|
13055
13049
|
description: "Array of thermostat daily program periods.",
|
|
13056
13050
|
items: {
|
|
13051
|
+
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.",
|
|
13057
13052
|
properties: {
|
|
13058
13053
|
climate_preset_key: {
|
|
13059
|
-
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
|
|
13054
|
+
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`.",
|
|
13060
13055
|
type: "string"
|
|
13061
13056
|
},
|
|
13062
13057
|
starts_at_time: {
|
|
13063
|
-
description: "Time at which the thermostat daily program
|
|
13058
|
+
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.",
|
|
13064
13059
|
pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
|
|
13065
13060
|
type: "string"
|
|
13066
13061
|
}
|
|
@@ -13092,7 +13087,8 @@ var openapi_default = {
|
|
|
13092
13087
|
"workspace_id",
|
|
13093
13088
|
"created_at"
|
|
13094
13089
|
],
|
|
13095
|
-
type: "object"
|
|
13090
|
+
type: "object",
|
|
13091
|
+
"x-route-path": "/thermostats/thermostat_daily_programs"
|
|
13096
13092
|
},
|
|
13097
13093
|
type: "array"
|
|
13098
13094
|
},
|
|
@@ -20883,7 +20879,8 @@ var openapi_default = {
|
|
|
20883
20879
|
"nest_thermostat",
|
|
20884
20880
|
"honeywell_resideo_thermostat",
|
|
20885
20881
|
"tado_thermostat",
|
|
20886
|
-
"sensi_thermostat"
|
|
20882
|
+
"sensi_thermostat",
|
|
20883
|
+
"smartthings_thermostat"
|
|
20887
20884
|
],
|
|
20888
20885
|
type: "string"
|
|
20889
20886
|
},
|
|
@@ -28647,7 +28644,8 @@ var openapi_default = {
|
|
|
28647
28644
|
"nest_thermostat",
|
|
28648
28645
|
"honeywell_resideo_thermostat",
|
|
28649
28646
|
"tado_thermostat",
|
|
28650
|
-
"sensi_thermostat"
|
|
28647
|
+
"sensi_thermostat",
|
|
28648
|
+
"smartthings_thermostat"
|
|
28651
28649
|
],
|
|
28652
28650
|
type: "string"
|
|
28653
28651
|
},
|
|
@@ -28704,7 +28702,8 @@ var openapi_default = {
|
|
|
28704
28702
|
"nest_thermostat",
|
|
28705
28703
|
"honeywell_resideo_thermostat",
|
|
28706
28704
|
"tado_thermostat",
|
|
28707
|
-
"sensi_thermostat"
|
|
28705
|
+
"sensi_thermostat",
|
|
28706
|
+
"smartthings_thermostat"
|
|
28708
28707
|
],
|
|
28709
28708
|
type: "string"
|
|
28710
28709
|
},
|
|
@@ -29190,7 +29189,8 @@ var openapi_default = {
|
|
|
29190
29189
|
"nest_thermostat",
|
|
29191
29190
|
"honeywell_resideo_thermostat",
|
|
29192
29191
|
"tado_thermostat",
|
|
29193
|
-
"sensi_thermostat"
|
|
29192
|
+
"sensi_thermostat",
|
|
29193
|
+
"smartthings_thermostat"
|
|
29194
29194
|
],
|
|
29195
29195
|
type: "string"
|
|
29196
29196
|
},
|
|
@@ -29247,7 +29247,8 @@ var openapi_default = {
|
|
|
29247
29247
|
"nest_thermostat",
|
|
29248
29248
|
"honeywell_resideo_thermostat",
|
|
29249
29249
|
"tado_thermostat",
|
|
29250
|
-
"sensi_thermostat"
|
|
29250
|
+
"sensi_thermostat",
|
|
29251
|
+
"smartthings_thermostat"
|
|
29251
29252
|
],
|
|
29252
29253
|
type: "string"
|
|
29253
29254
|
},
|
|
@@ -32593,11 +32594,11 @@ var openapi_default = {
|
|
|
32593
32594
|
schema: {
|
|
32594
32595
|
properties: {
|
|
32595
32596
|
climate_preset_key: {
|
|
32596
|
-
description: "Climate preset key of the
|
|
32597
|
+
description: "Climate preset key of the climate preset that you want to activate.",
|
|
32597
32598
|
type: "string"
|
|
32598
32599
|
},
|
|
32599
32600
|
device_id: {
|
|
32600
|
-
description: "ID of the
|
|
32601
|
+
description: "ID of the thermostat device for which you want to activate a climate preset.",
|
|
32601
32602
|
format: "uuid",
|
|
32602
32603
|
type: "string"
|
|
32603
32604
|
}
|
|
@@ -32664,7 +32665,7 @@ var openapi_default = {
|
|
|
32664
32665
|
type: "number"
|
|
32665
32666
|
},
|
|
32666
32667
|
device_id: {
|
|
32667
|
-
description: "ID of the
|
|
32668
|
+
description: "ID of the thermostat device that you want to set to cool mode.",
|
|
32668
32669
|
format: "uuid",
|
|
32669
32670
|
type: "string"
|
|
32670
32671
|
},
|
|
@@ -32741,7 +32742,7 @@ var openapi_default = {
|
|
|
32741
32742
|
type: "number"
|
|
32742
32743
|
},
|
|
32743
32744
|
device_id: {
|
|
32744
|
-
description: "ID of the
|
|
32745
|
+
description: "ID of the thermostat device for which you want create a climate preset.",
|
|
32745
32746
|
format: "uuid",
|
|
32746
32747
|
type: "string"
|
|
32747
32748
|
},
|
|
@@ -32817,7 +32818,7 @@ var openapi_default = {
|
|
|
32817
32818
|
},
|
|
32818
32819
|
"/thermostats/daily_programs/create": {
|
|
32819
32820
|
post: {
|
|
32820
|
-
description: "Creates a thermostat daily program.",
|
|
32821
|
+
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.",
|
|
32821
32822
|
operationId: "thermostatsDailyProgramsCreatePost",
|
|
32822
32823
|
requestBody: {
|
|
32823
32824
|
content: {
|
|
@@ -32825,7 +32826,7 @@ var openapi_default = {
|
|
|
32825
32826
|
schema: {
|
|
32826
32827
|
properties: {
|
|
32827
32828
|
device_id: {
|
|
32828
|
-
description: "ID of the
|
|
32829
|
+
description: "ID of the thermostat device for which you want to create a daily program.",
|
|
32829
32830
|
format: "uuid",
|
|
32830
32831
|
type: "string"
|
|
32831
32832
|
},
|
|
@@ -32836,13 +32837,14 @@ var openapi_default = {
|
|
|
32836
32837
|
periods: {
|
|
32837
32838
|
description: "Array of thermostat daily program periods.",
|
|
32838
32839
|
items: {
|
|
32840
|
+
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.",
|
|
32839
32841
|
properties: {
|
|
32840
32842
|
climate_preset_key: {
|
|
32841
|
-
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
|
|
32843
|
+
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`.",
|
|
32842
32844
|
type: "string"
|
|
32843
32845
|
},
|
|
32844
32846
|
starts_at_time: {
|
|
32845
|
-
description: "Time at which the thermostat daily program
|
|
32847
|
+
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.",
|
|
32846
32848
|
pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
|
|
32847
32849
|
type: "string"
|
|
32848
32850
|
}
|
|
@@ -32867,6 +32869,7 @@ var openapi_default = {
|
|
|
32867
32869
|
properties: {
|
|
32868
32870
|
ok: { type: "boolean" },
|
|
32869
32871
|
thermostat_daily_program: {
|
|
32872
|
+
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.",
|
|
32870
32873
|
properties: {
|
|
32871
32874
|
created_at: {
|
|
32872
32875
|
description: "Date and time at which the thermostat daily program was created.",
|
|
@@ -32874,7 +32877,7 @@ var openapi_default = {
|
|
|
32874
32877
|
type: "string"
|
|
32875
32878
|
},
|
|
32876
32879
|
device_id: {
|
|
32877
|
-
description: "ID of the
|
|
32880
|
+
description: "ID of the thermostat device on which the thermostat daily program is configured.",
|
|
32878
32881
|
format: "uuid",
|
|
32879
32882
|
type: "string"
|
|
32880
32883
|
},
|
|
@@ -32886,13 +32889,14 @@ var openapi_default = {
|
|
|
32886
32889
|
periods: {
|
|
32887
32890
|
description: "Array of thermostat daily program periods.",
|
|
32888
32891
|
items: {
|
|
32892
|
+
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.",
|
|
32889
32893
|
properties: {
|
|
32890
32894
|
climate_preset_key: {
|
|
32891
|
-
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
|
|
32895
|
+
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`.",
|
|
32892
32896
|
type: "string"
|
|
32893
32897
|
},
|
|
32894
32898
|
starts_at_time: {
|
|
32895
|
-
description: "Time at which the thermostat daily program
|
|
32899
|
+
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.",
|
|
32896
32900
|
pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
|
|
32897
32901
|
type: "string"
|
|
32898
32902
|
}
|
|
@@ -32921,7 +32925,8 @@ var openapi_default = {
|
|
|
32921
32925
|
"workspace_id",
|
|
32922
32926
|
"created_at"
|
|
32923
32927
|
],
|
|
32924
|
-
type: "object"
|
|
32928
|
+
type: "object",
|
|
32929
|
+
"x-route-path": "/thermostats/thermostat_daily_programs"
|
|
32925
32930
|
}
|
|
32926
32931
|
},
|
|
32927
32932
|
required: ["thermostat_daily_program", "ok"],
|
|
@@ -32946,8 +32951,7 @@ var openapi_default = {
|
|
|
32946
32951
|
"x-fern-sdk-method-name": "create",
|
|
32947
32952
|
"x-fern-sdk-return-value": "thermostat_daily_program",
|
|
32948
32953
|
"x-response-key": "thermostat_daily_program",
|
|
32949
|
-
"x-title": "Create a Thermostat Daily Program"
|
|
32950
|
-
"x-undocumented": "Unreleased."
|
|
32954
|
+
"x-title": "Create a Thermostat Daily Program"
|
|
32951
32955
|
}
|
|
32952
32956
|
},
|
|
32953
32957
|
"/thermostats/daily_programs/delete": {
|
|
@@ -32960,7 +32964,7 @@ var openapi_default = {
|
|
|
32960
32964
|
schema: {
|
|
32961
32965
|
properties: {
|
|
32962
32966
|
thermostat_daily_program_id: {
|
|
32963
|
-
description: "ID of the
|
|
32967
|
+
description: "ID of the thermostat daily program that you want to delete.",
|
|
32964
32968
|
format: "uuid",
|
|
32965
32969
|
type: "string"
|
|
32966
32970
|
}
|
|
@@ -32998,13 +33002,12 @@ var openapi_default = {
|
|
|
32998
33002
|
"x-fern-sdk-group-name": ["thermostats", "daily_programs"],
|
|
32999
33003
|
"x-fern-sdk-method-name": "delete",
|
|
33000
33004
|
"x-response-key": null,
|
|
33001
|
-
"x-title": "Delete a Thermostat Daily Program"
|
|
33002
|
-
"x-undocumented": "Unreleased."
|
|
33005
|
+
"x-title": "Delete a Thermostat Daily Program"
|
|
33003
33006
|
}
|
|
33004
33007
|
},
|
|
33005
33008
|
"/thermostats/daily_programs/update": {
|
|
33006
33009
|
patch: {
|
|
33007
|
-
description: "Updates a specified thermostat daily program.",
|
|
33010
|
+
description: "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.",
|
|
33008
33011
|
operationId: "thermostatsDailyProgramsUpdatePatch",
|
|
33009
33012
|
requestBody: {
|
|
33010
33013
|
content: {
|
|
@@ -33012,19 +33015,20 @@ var openapi_default = {
|
|
|
33012
33015
|
schema: {
|
|
33013
33016
|
properties: {
|
|
33014
33017
|
name: {
|
|
33015
|
-
description: "User-friendly name to identify the thermostat daily program.",
|
|
33018
|
+
description: "User-friendly name to identify the thermostat daily program that you want to update.",
|
|
33016
33019
|
type: "string"
|
|
33017
33020
|
},
|
|
33018
33021
|
periods: {
|
|
33019
|
-
description: "Array of thermostat daily program periods.",
|
|
33022
|
+
description: "Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.",
|
|
33020
33023
|
items: {
|
|
33024
|
+
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.",
|
|
33021
33025
|
properties: {
|
|
33022
33026
|
climate_preset_key: {
|
|
33023
|
-
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
|
|
33027
|
+
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`.",
|
|
33024
33028
|
type: "string"
|
|
33025
33029
|
},
|
|
33026
33030
|
starts_at_time: {
|
|
33027
|
-
description: "Time at which the thermostat daily program
|
|
33031
|
+
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.",
|
|
33028
33032
|
pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
|
|
33029
33033
|
type: "string"
|
|
33030
33034
|
}
|
|
@@ -33035,7 +33039,7 @@ var openapi_default = {
|
|
|
33035
33039
|
type: "array"
|
|
33036
33040
|
},
|
|
33037
33041
|
thermostat_daily_program_id: {
|
|
33038
|
-
description: "ID of the
|
|
33042
|
+
description: "ID of the thermostat daily program that you want to update.",
|
|
33039
33043
|
format: "uuid",
|
|
33040
33044
|
type: "string"
|
|
33041
33045
|
}
|
|
@@ -33078,11 +33082,10 @@ var openapi_default = {
|
|
|
33078
33082
|
"x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS",
|
|
33079
33083
|
"x-fern-ignore": true,
|
|
33080
33084
|
"x-response-key": "action_attempt",
|
|
33081
|
-
"x-title": "Update a Thermostat Daily Program"
|
|
33082
|
-
"x-undocumented": "Unreleased."
|
|
33085
|
+
"x-title": "Update a Thermostat Daily Program"
|
|
33083
33086
|
},
|
|
33084
33087
|
post: {
|
|
33085
|
-
description: "Updates a specified thermostat daily program.",
|
|
33088
|
+
description: "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.",
|
|
33086
33089
|
operationId: "thermostatsDailyProgramsUpdatePost",
|
|
33087
33090
|
requestBody: {
|
|
33088
33091
|
content: {
|
|
@@ -33090,19 +33093,20 @@ var openapi_default = {
|
|
|
33090
33093
|
schema: {
|
|
33091
33094
|
properties: {
|
|
33092
33095
|
name: {
|
|
33093
|
-
description: "User-friendly name to identify the thermostat daily program.",
|
|
33096
|
+
description: "User-friendly name to identify the thermostat daily program that you want to update.",
|
|
33094
33097
|
type: "string"
|
|
33095
33098
|
},
|
|
33096
33099
|
periods: {
|
|
33097
|
-
description: "Array of thermostat daily program periods.",
|
|
33100
|
+
description: "Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.",
|
|
33098
33101
|
items: {
|
|
33102
|
+
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.",
|
|
33099
33103
|
properties: {
|
|
33100
33104
|
climate_preset_key: {
|
|
33101
|
-
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
|
|
33105
|
+
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`.",
|
|
33102
33106
|
type: "string"
|
|
33103
33107
|
},
|
|
33104
33108
|
starts_at_time: {
|
|
33105
|
-
description: "Time at which the thermostat daily program
|
|
33109
|
+
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.",
|
|
33106
33110
|
pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
|
|
33107
33111
|
type: "string"
|
|
33108
33112
|
}
|
|
@@ -33113,7 +33117,7 @@ var openapi_default = {
|
|
|
33113
33117
|
type: "array"
|
|
33114
33118
|
},
|
|
33115
33119
|
thermostat_daily_program_id: {
|
|
33116
|
-
description: "ID of the
|
|
33120
|
+
description: "ID of the thermostat daily program that you want to update.",
|
|
33117
33121
|
format: "uuid",
|
|
33118
33122
|
type: "string"
|
|
33119
33123
|
}
|
|
@@ -33158,8 +33162,7 @@ var openapi_default = {
|
|
|
33158
33162
|
"x-fern-sdk-method-name": "update",
|
|
33159
33163
|
"x-fern-sdk-return-value": "action_attempt",
|
|
33160
33164
|
"x-response-key": "action_attempt",
|
|
33161
|
-
"x-title": "Update a Thermostat Daily Program"
|
|
33162
|
-
"x-undocumented": "Unreleased."
|
|
33165
|
+
"x-title": "Update a Thermostat Daily Program"
|
|
33163
33166
|
}
|
|
33164
33167
|
},
|
|
33165
33168
|
"/thermostats/delete_climate_preset": {
|
|
@@ -33172,11 +33175,11 @@ var openapi_default = {
|
|
|
33172
33175
|
schema: {
|
|
33173
33176
|
properties: {
|
|
33174
33177
|
climate_preset_key: {
|
|
33175
|
-
description: "Climate preset key of the
|
|
33178
|
+
description: "Climate preset key of the climate preset that you want to delete.",
|
|
33176
33179
|
type: "string"
|
|
33177
33180
|
},
|
|
33178
33181
|
device_id: {
|
|
33179
|
-
description: "ID of the
|
|
33182
|
+
description: "ID of the thermostat device for which you want to delete a climate preset.",
|
|
33180
33183
|
format: "uuid",
|
|
33181
33184
|
type: "string"
|
|
33182
33185
|
}
|
|
@@ -33227,12 +33230,12 @@ var openapi_default = {
|
|
|
33227
33230
|
schema: {
|
|
33228
33231
|
properties: {
|
|
33229
33232
|
device_id: {
|
|
33230
|
-
description: "ID of the
|
|
33233
|
+
description: "ID of the thermostat device that you want to retrieve.",
|
|
33231
33234
|
format: "uuid",
|
|
33232
33235
|
type: "string"
|
|
33233
33236
|
},
|
|
33234
33237
|
name: {
|
|
33235
|
-
description: "User-friendly name of the
|
|
33238
|
+
description: "User-friendly name of the thermostat device that you want to retrieve.",
|
|
33236
33239
|
type: "string"
|
|
33237
33240
|
}
|
|
33238
33241
|
},
|
|
@@ -33287,7 +33290,7 @@ var openapi_default = {
|
|
|
33287
33290
|
schema: {
|
|
33288
33291
|
properties: {
|
|
33289
33292
|
device_id: {
|
|
33290
|
-
description: "ID of the
|
|
33293
|
+
description: "ID of the thermostat device that you want to set to heat mode.",
|
|
33291
33294
|
format: "uuid",
|
|
33292
33295
|
type: "string"
|
|
33293
33296
|
},
|
|
@@ -33370,7 +33373,7 @@ var openapi_default = {
|
|
|
33370
33373
|
type: "number"
|
|
33371
33374
|
},
|
|
33372
33375
|
device_id: {
|
|
33373
|
-
description: "ID of the
|
|
33376
|
+
description: "ID of the thermostat device that you want to set to heat-cool mode.",
|
|
33374
33377
|
format: "uuid",
|
|
33375
33378
|
type: "string"
|
|
33376
33379
|
},
|
|
@@ -33479,25 +33482,27 @@ var openapi_default = {
|
|
|
33479
33482
|
type: "array"
|
|
33480
33483
|
},
|
|
33481
33484
|
device_type: {
|
|
33482
|
-
description: "Device type by which to filter devices.",
|
|
33485
|
+
description: "Device type by which to filter thermostat devices.",
|
|
33483
33486
|
enum: [
|
|
33484
33487
|
"ecobee_thermostat",
|
|
33485
33488
|
"nest_thermostat",
|
|
33486
33489
|
"honeywell_resideo_thermostat",
|
|
33487
33490
|
"tado_thermostat",
|
|
33488
|
-
"sensi_thermostat"
|
|
33491
|
+
"sensi_thermostat",
|
|
33492
|
+
"smartthings_thermostat"
|
|
33489
33493
|
],
|
|
33490
33494
|
type: "string"
|
|
33491
33495
|
},
|
|
33492
33496
|
device_types: {
|
|
33493
|
-
description: "Array of device types by which to filter devices.",
|
|
33497
|
+
description: "Array of device types by which to filter thermostat devices.",
|
|
33494
33498
|
items: {
|
|
33495
33499
|
enum: [
|
|
33496
33500
|
"ecobee_thermostat",
|
|
33497
33501
|
"nest_thermostat",
|
|
33498
33502
|
"honeywell_resideo_thermostat",
|
|
33499
33503
|
"tado_thermostat",
|
|
33500
|
-
"sensi_thermostat"
|
|
33504
|
+
"sensi_thermostat",
|
|
33505
|
+
"smartthings_thermostat"
|
|
33501
33506
|
],
|
|
33502
33507
|
type: "string"
|
|
33503
33508
|
},
|
|
@@ -33550,7 +33555,7 @@ var openapi_default = {
|
|
|
33550
33555
|
type: "number"
|
|
33551
33556
|
},
|
|
33552
33557
|
manufacturer: {
|
|
33553
|
-
description: "Manufacturer by which to filter devices.",
|
|
33558
|
+
description: "Manufacturer by which to filter thermostat devices.",
|
|
33554
33559
|
enum: [
|
|
33555
33560
|
"ecobee",
|
|
33556
33561
|
"honeywell_resideo",
|
|
@@ -33632,7 +33637,7 @@ var openapi_default = {
|
|
|
33632
33637
|
schema: {
|
|
33633
33638
|
properties: {
|
|
33634
33639
|
device_id: {
|
|
33635
|
-
description: "ID of the
|
|
33640
|
+
description: "ID of the thermostat device that you want to set to off mode.",
|
|
33636
33641
|
format: "uuid",
|
|
33637
33642
|
type: "string"
|
|
33638
33643
|
},
|
|
@@ -34108,11 +34113,11 @@ var openapi_default = {
|
|
|
34108
34113
|
schema: {
|
|
34109
34114
|
properties: {
|
|
34110
34115
|
climate_preset_key: {
|
|
34111
|
-
description: "Climate preset key of the
|
|
34116
|
+
description: "Climate preset key of the climate preset that you want to set as the fallback climate preset.",
|
|
34112
34117
|
type: "string"
|
|
34113
34118
|
},
|
|
34114
34119
|
device_id: {
|
|
34115
|
-
description: "ID of the
|
|
34120
|
+
description: "ID of the thermostat device for which you want to set the fallback climate preset.",
|
|
34116
34121
|
format: "uuid",
|
|
34117
34122
|
type: "string"
|
|
34118
34123
|
}
|
|
@@ -34161,7 +34166,11 @@ var openapi_default = {
|
|
|
34161
34166
|
"application/json": {
|
|
34162
34167
|
schema: {
|
|
34163
34168
|
properties: {
|
|
34164
|
-
device_id: {
|
|
34169
|
+
device_id: {
|
|
34170
|
+
description: "ID of the thermostat device for which you want to set the fan mode.",
|
|
34171
|
+
format: "uuid",
|
|
34172
|
+
type: "string"
|
|
34173
|
+
},
|
|
34165
34174
|
fan_mode: {
|
|
34166
34175
|
deprecated: true,
|
|
34167
34176
|
enum: ["auto", "on", "circulate"],
|
|
@@ -34235,7 +34244,7 @@ var openapi_default = {
|
|
|
34235
34244
|
{
|
|
34236
34245
|
properties: {
|
|
34237
34246
|
device_id: {
|
|
34238
|
-
description: "ID of the
|
|
34247
|
+
description: "ID of the thermostat device for which you want to set the HVAC mode.",
|
|
34239
34248
|
format: "uuid",
|
|
34240
34249
|
type: "string"
|
|
34241
34250
|
},
|
|
@@ -34257,7 +34266,7 @@ var openapi_default = {
|
|
|
34257
34266
|
type: "number"
|
|
34258
34267
|
},
|
|
34259
34268
|
device_id: {
|
|
34260
|
-
description: "ID of the
|
|
34269
|
+
description: "ID of the thermostat device for which you want to set the HVAC mode.",
|
|
34261
34270
|
format: "uuid",
|
|
34262
34271
|
type: "string"
|
|
34263
34272
|
},
|
|
@@ -34269,7 +34278,7 @@ var openapi_default = {
|
|
|
34269
34278
|
{
|
|
34270
34279
|
properties: {
|
|
34271
34280
|
device_id: {
|
|
34272
|
-
description: "ID of the
|
|
34281
|
+
description: "ID of the thermostat device for which you want to set the HVAC mode.",
|
|
34273
34282
|
format: "uuid",
|
|
34274
34283
|
type: "string"
|
|
34275
34284
|
},
|
|
@@ -34301,7 +34310,7 @@ var openapi_default = {
|
|
|
34301
34310
|
type: "number"
|
|
34302
34311
|
},
|
|
34303
34312
|
device_id: {
|
|
34304
|
-
description: "ID of the
|
|
34313
|
+
description: "ID of the thermostat device for which you want to set the HVAC mode.",
|
|
34305
34314
|
format: "uuid",
|
|
34306
34315
|
type: "string"
|
|
34307
34316
|
},
|
|
@@ -34375,7 +34384,7 @@ var openapi_default = {
|
|
|
34375
34384
|
schema: {
|
|
34376
34385
|
properties: {
|
|
34377
34386
|
device_id: {
|
|
34378
|
-
description: "ID of the
|
|
34387
|
+
description: "ID of the thermostat device for which you want to set a temperature threshold.",
|
|
34379
34388
|
format: "uuid",
|
|
34380
34389
|
type: "string"
|
|
34381
34390
|
},
|
|
@@ -34450,7 +34459,7 @@ var openapi_default = {
|
|
|
34450
34459
|
schema: {
|
|
34451
34460
|
properties: {
|
|
34452
34461
|
device_id: {
|
|
34453
|
-
description: "ID of the
|
|
34462
|
+
description: "ID of the thermostat device for which you want to set a temperature threshold.",
|
|
34454
34463
|
format: "uuid",
|
|
34455
34464
|
type: "string"
|
|
34456
34465
|
},
|
|
@@ -34750,7 +34759,7 @@ var openapi_default = {
|
|
|
34750
34759
|
type: "number"
|
|
34751
34760
|
},
|
|
34752
34761
|
device_id: {
|
|
34753
|
-
description: "ID of the
|
|
34762
|
+
description: "ID of the thermostat device for which you want to update a climate preset.",
|
|
34754
34763
|
format: "uuid",
|
|
34755
34764
|
type: "string"
|
|
34756
34765
|
},
|
|
@@ -34848,7 +34857,7 @@ var openapi_default = {
|
|
|
34848
34857
|
type: "number"
|
|
34849
34858
|
},
|
|
34850
34859
|
device_id: {
|
|
34851
|
-
description: "ID of the
|
|
34860
|
+
description: "ID of the thermostat device for which you want to update a climate preset.",
|
|
34852
34861
|
format: "uuid",
|
|
34853
34862
|
type: "string"
|
|
34854
34863
|
},
|
|
@@ -34927,7 +34936,7 @@ var openapi_default = {
|
|
|
34927
34936
|
},
|
|
34928
34937
|
"/thermostats/update_weekly_program": {
|
|
34929
34938
|
post: {
|
|
34930
|
-
description: "
|
|
34939
|
+
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
34940
|
operationId: "thermostatsUpdateWeeklyProgramPost",
|
|
34932
34941
|
requestBody: {
|
|
34933
34942
|
content: {
|
|
@@ -34935,7 +34944,7 @@ var openapi_default = {
|
|
|
34935
34944
|
schema: {
|
|
34936
34945
|
properties: {
|
|
34937
34946
|
device_id: {
|
|
34938
|
-
description: "ID of the thermostat device
|
|
34947
|
+
description: "ID of the thermostat device for which you want to update the weekly program.",
|
|
34939
34948
|
format: "uuid",
|
|
34940
34949
|
type: "string"
|
|
34941
34950
|
},
|
|
@@ -35022,8 +35031,7 @@ var openapi_default = {
|
|
|
35022
35031
|
"x-fern-sdk-method-name": "update_weekly_program",
|
|
35023
35032
|
"x-fern-sdk-return-value": "action_attempt",
|
|
35024
35033
|
"x-response-key": "action_attempt",
|
|
35025
|
-
"x-title": "
|
|
35026
|
-
"x-undocumented": "Unreleased."
|
|
35034
|
+
"x-title": "Update the Thermostat Weekly Program"
|
|
35027
35035
|
}
|
|
35028
35036
|
},
|
|
35029
35037
|
"/unstable_access_grants/create": {
|