@seamapi/types 1.292.0 → 1.292.2
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 +189 -81
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +250 -659
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +16 -11
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +68 -9
- package/lib/seam/connect/openapi.js +139 -66
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +180 -649
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/lib/seam/connect/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +51 -44
- package/src/lib/seam/connect/openapi.ts +152 -66
- package/src/lib/seam/connect/route-types.ts +184 -836
- package/src/lib/seam/connect/schemas.ts +1 -0
package/dist/connect.cjs
CHANGED
|
@@ -14,6 +14,7 @@ __export(schemas_exports, {
|
|
|
14
14
|
access_code: () => access_code,
|
|
15
15
|
acs_access_group: () => acs_access_group,
|
|
16
16
|
acs_credential: () => acs_credential,
|
|
17
|
+
acs_encoder: () => acs_encoder,
|
|
17
18
|
acs_entrance: () => acs_entrance,
|
|
18
19
|
acs_system: () => acs_system,
|
|
19
20
|
acs_user: () => acs_user,
|
|
@@ -167,26 +168,28 @@ var climate_preset = zod.z.object({
|
|
|
167
168
|
});
|
|
168
169
|
var climate_setting = climate_preset.partial();
|
|
169
170
|
var thermostat_schedule = zod.z.object({
|
|
170
|
-
thermostat_schedule_id: zod.z.string().uuid().describe("ID of the
|
|
171
|
+
thermostat_schedule_id: zod.z.string().uuid().describe("ID of the thermostat schedule."),
|
|
171
172
|
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
|
|
173
|
+
name: zod.z.string().optional().describe("User-friendly name to identify the thermostat schedule."),
|
|
173
174
|
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
|
|
175
|
+
"Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule."
|
|
175
176
|
),
|
|
176
177
|
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-
|
|
178
|
+
"Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions)."
|
|
178
179
|
),
|
|
179
180
|
starts_at: zod.z.string().datetime().describe(
|
|
180
|
-
"Date and time at which the
|
|
181
|
+
"Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
|
|
181
182
|
),
|
|
182
183
|
ends_at: zod.z.string().datetime().describe(
|
|
183
|
-
"Date and time at which the
|
|
184
|
+
"Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
|
|
184
185
|
),
|
|
185
|
-
created_at: zod.z.string().datetime().describe("Date and time at which the
|
|
186
|
+
created_at: zod.z.string().datetime().describe("Date and time at which the thermostat schedule was created."),
|
|
186
187
|
errors: zod.z.any().describe(
|
|
187
|
-
"Array of errors associated with the
|
|
188
|
+
"Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it."
|
|
188
189
|
)
|
|
189
|
-
})
|
|
190
|
+
}).describe(
|
|
191
|
+
"Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time."
|
|
192
|
+
);
|
|
190
193
|
|
|
191
194
|
// src/lib/seam/connect/models/devices/capability-properties/thermostat.ts
|
|
192
195
|
var thermostat_capability_properties = zod.z.object({
|
|
@@ -1329,6 +1332,38 @@ var acs_credential_on_encoder = zod.z.object({
|
|
|
1329
1332
|
common_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional()
|
|
1330
1333
|
}).optional().describe("Visionline-specific metadata for the credential.")
|
|
1331
1334
|
});
|
|
1335
|
+
var common_acs_encoder_error = zod.z.object({
|
|
1336
|
+
created_at: zod.z.string().datetime().describe("Date and time at which Seam created the error."),
|
|
1337
|
+
message: zod.z.string().describe(
|
|
1338
|
+
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
1339
|
+
)
|
|
1340
|
+
});
|
|
1341
|
+
var error_code_description = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
1342
|
+
var acs_encoder_removed = common_acs_encoder_error.extend({
|
|
1343
|
+
error_code: zod.z.literal("acs_encoder_removed").describe(error_code_description),
|
|
1344
|
+
_event_id: zod.z.string().uuid().describe(
|
|
1345
|
+
"ID of the event that was created when the `acs_encoder` was removed."
|
|
1346
|
+
)
|
|
1347
|
+
});
|
|
1348
|
+
var acs_encoder_error = (
|
|
1349
|
+
// z.union([
|
|
1350
|
+
acs_encoder_removed.describe("Error associated with the `acs_encoder`.")
|
|
1351
|
+
);
|
|
1352
|
+
zod.z.object({
|
|
1353
|
+
acs_encoder_removed: acs_encoder_removed.optional().nullable()
|
|
1354
|
+
});
|
|
1355
|
+
var acs_encoder = zod.z.object({
|
|
1356
|
+
acs_encoder_id: zod.z.string().uuid().describe("ID of the `acs_encoder`."),
|
|
1357
|
+
acs_system_id: zod.z.string().uuid().describe(
|
|
1358
|
+
"ID of the access control system that contains the `acs_encoder`."
|
|
1359
|
+
),
|
|
1360
|
+
workspace_id: zod.z.string().uuid().describe(
|
|
1361
|
+
"ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`."
|
|
1362
|
+
),
|
|
1363
|
+
errors: zod.z.array(acs_encoder_error).describe("Errors associated with the `acs_encoder`."),
|
|
1364
|
+
created_at: zod.z.string().datetime().describe("Date and time at which the `acs_encoder` was created."),
|
|
1365
|
+
display_name: zod.z.string().describe("Display name for the `acs_encoder`.")
|
|
1366
|
+
});
|
|
1332
1367
|
var acs_entrance = zod.z.object({
|
|
1333
1368
|
acs_system_id: zod.z.string().uuid().describe("ID of the access control system that contains the entrance."),
|
|
1334
1369
|
acs_entrance_id: zod.z.string().uuid().describe("ID of the entrance."),
|
|
@@ -1385,29 +1420,29 @@ var common_acs_system_error = zod.z.object({
|
|
|
1385
1420
|
"Detailed description of the error. Provides insights into the issue and potentially how to rectify it."
|
|
1386
1421
|
)
|
|
1387
1422
|
});
|
|
1388
|
-
var
|
|
1423
|
+
var error_code_description2 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
|
|
1389
1424
|
var seam_bridge_disconnected = common_acs_system_error.extend({
|
|
1390
|
-
error_code: zod.z.literal("seam_bridge_disconnected").describe(
|
|
1425
|
+
error_code: zod.z.literal("seam_bridge_disconnected").describe(error_code_description2)
|
|
1391
1426
|
}).describe(`Indicates that the Seam API cannot communicate with the [Seam Bridge](https://docs.seam.co/latest/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline.
|
|
1392
1427
|
This error might also occur if the Seam Bridge is connected to the wrong [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
|
|
1393
1428
|
See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.seam_bridge_disconnected).`);
|
|
1394
1429
|
var visionline_instance_unreachable = common_acs_system_error.extend({
|
|
1395
|
-
error_code: zod.z.literal("visionline_instance_unreachable").describe(
|
|
1430
|
+
error_code: zod.z.literal("visionline_instance_unreachable").describe(error_code_description2)
|
|
1396
1431
|
}).describe(`Indicates that the Seam Bridge is functioning correctly and the Seam API can communicate with the Seam Bridge, but the Seam API cannot connect to the on-premises [Visionline access control system](https://docs.seam.co/latest/device-and-system-integration-guides/assa-abloy-visionline-access-control-system).
|
|
1397
1432
|
For example, the IP address of the on-premises access control system may be set incorrectly within the Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces).
|
|
1398
1433
|
See also [Troubleshooting Your Access Control System](https://docs.seam.co/latest/capability-guides/capability-guides/access-systems/troubleshooting-your-access-control-system#acs_system.errors.visionline_instance_unreachable).`);
|
|
1399
1434
|
var salto_ks_subscription_limit_exceeded = common_acs_system_error.extend({
|
|
1400
|
-
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(
|
|
1435
|
+
error_code: zod.z.literal("salto_ks_subscription_limit_exceeded").describe(error_code_description2)
|
|
1401
1436
|
}).describe(
|
|
1402
1437
|
"Indicates that the maximum number of users allowed for the site has been reached. This means that new access codes cannot be created. Contact Salto support to increase the user limit."
|
|
1403
1438
|
);
|
|
1404
1439
|
var acs_system_disconnected = common_acs_system_error.extend({
|
|
1405
|
-
error_code: zod.z.literal("acs_system_disconnected").describe(
|
|
1440
|
+
error_code: zod.z.literal("acs_system_disconnected").describe(error_code_description2)
|
|
1406
1441
|
}).describe(
|
|
1407
1442
|
"Indicates that the access system has been disconnected. See [this guide](https://docs.seam.co/latest/capability-guides/access-systems/troubleshooting-your-access-control-system guide) to resolve the issue."
|
|
1408
1443
|
);
|
|
1409
1444
|
var account_disconnected = common_acs_system_error.extend({
|
|
1410
|
-
error_code: zod.z.literal("account_disconnected").describe(
|
|
1445
|
+
error_code: zod.z.literal("account_disconnected").describe(error_code_description2)
|
|
1411
1446
|
}).describe(
|
|
1412
1447
|
"Indicates that the login credentials are invalid. Reconnect the account using the Connect Webview to restore access."
|
|
1413
1448
|
);
|
|
@@ -7173,14 +7208,15 @@ var openapi_default = {
|
|
|
7173
7208
|
properties: {
|
|
7174
7209
|
active_thermostat_schedule: {
|
|
7175
7210
|
default: null,
|
|
7211
|
+
description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
|
|
7176
7212
|
nullable: true,
|
|
7177
7213
|
properties: {
|
|
7178
7214
|
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
|
|
7215
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
|
|
7180
7216
|
type: "string"
|
|
7181
7217
|
},
|
|
7182
7218
|
created_at: {
|
|
7183
|
-
description: "Date and time at which the
|
|
7219
|
+
description: "Date and time at which the thermostat schedule was created.",
|
|
7184
7220
|
format: "date-time",
|
|
7185
7221
|
type: "string"
|
|
7186
7222
|
},
|
|
@@ -7190,29 +7226,29 @@ var openapi_default = {
|
|
|
7190
7226
|
type: "string"
|
|
7191
7227
|
},
|
|
7192
7228
|
ends_at: {
|
|
7193
|
-
description: "Date and time at which the
|
|
7229
|
+
description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
7194
7230
|
format: "date-time",
|
|
7195
7231
|
type: "string"
|
|
7196
7232
|
},
|
|
7197
7233
|
errors: {
|
|
7198
|
-
description: "Array of errors associated with the
|
|
7234
|
+
description: "Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it."
|
|
7199
7235
|
},
|
|
7200
7236
|
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-
|
|
7237
|
+
description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
7202
7238
|
minimum: 0,
|
|
7203
7239
|
type: "integer"
|
|
7204
7240
|
},
|
|
7205
7241
|
name: {
|
|
7206
|
-
description: "User-friendly name to identify the
|
|
7242
|
+
description: "User-friendly name to identify the thermostat schedule.",
|
|
7207
7243
|
type: "string"
|
|
7208
7244
|
},
|
|
7209
7245
|
starts_at: {
|
|
7210
|
-
description: "Date and time at which the
|
|
7246
|
+
description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
7211
7247
|
format: "date-time",
|
|
7212
7248
|
type: "string"
|
|
7213
7249
|
},
|
|
7214
7250
|
thermostat_schedule_id: {
|
|
7215
|
-
description: "ID of the
|
|
7251
|
+
description: "ID of the thermostat schedule.",
|
|
7216
7252
|
format: "uuid",
|
|
7217
7253
|
type: "string"
|
|
7218
7254
|
}
|
|
@@ -7922,13 +7958,14 @@ var openapi_default = {
|
|
|
7922
7958
|
type: "object"
|
|
7923
7959
|
},
|
|
7924
7960
|
thermostat_schedule: {
|
|
7961
|
+
description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
|
|
7925
7962
|
properties: {
|
|
7926
7963
|
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
|
|
7964
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
|
|
7928
7965
|
type: "string"
|
|
7929
7966
|
},
|
|
7930
7967
|
created_at: {
|
|
7931
|
-
description: "Date and time at which the
|
|
7968
|
+
description: "Date and time at which the thermostat schedule was created.",
|
|
7932
7969
|
format: "date-time",
|
|
7933
7970
|
type: "string"
|
|
7934
7971
|
},
|
|
@@ -7938,29 +7975,29 @@ var openapi_default = {
|
|
|
7938
7975
|
type: "string"
|
|
7939
7976
|
},
|
|
7940
7977
|
ends_at: {
|
|
7941
|
-
description: "Date and time at which the
|
|
7978
|
+
description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
7942
7979
|
format: "date-time",
|
|
7943
7980
|
type: "string"
|
|
7944
7981
|
},
|
|
7945
7982
|
errors: {
|
|
7946
|
-
description: "Array of errors associated with the
|
|
7983
|
+
description: "Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it."
|
|
7947
7984
|
},
|
|
7948
7985
|
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-
|
|
7986
|
+
description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
7950
7987
|
minimum: 0,
|
|
7951
7988
|
type: "integer"
|
|
7952
7989
|
},
|
|
7953
7990
|
name: {
|
|
7954
|
-
description: "User-friendly name to identify the
|
|
7991
|
+
description: "User-friendly name to identify the thermostat schedule.",
|
|
7955
7992
|
type: "string"
|
|
7956
7993
|
},
|
|
7957
7994
|
starts_at: {
|
|
7958
|
-
description: "Date and time at which the
|
|
7995
|
+
description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
7959
7996
|
format: "date-time",
|
|
7960
7997
|
type: "string"
|
|
7961
7998
|
},
|
|
7962
7999
|
thermostat_schedule_id: {
|
|
7963
|
-
description: "ID of the
|
|
8000
|
+
description: "ID of the thermostat schedule.",
|
|
7964
8001
|
format: "uuid",
|
|
7965
8002
|
type: "string"
|
|
7966
8003
|
}
|
|
@@ -11775,13 +11812,13 @@ var openapi_default = {
|
|
|
11775
11812
|
format: "uuid",
|
|
11776
11813
|
type: "string"
|
|
11777
11814
|
},
|
|
11778
|
-
|
|
11779
|
-
description: "ID of the
|
|
11815
|
+
acs_encoder_id: {
|
|
11816
|
+
description: "ID of the acs_encoder to use for the encoding.",
|
|
11780
11817
|
format: "uuid",
|
|
11781
11818
|
type: "string"
|
|
11782
11819
|
}
|
|
11783
11820
|
},
|
|
11784
|
-
required: ["
|
|
11821
|
+
required: ["acs_encoder_id", "acs_credential_id"],
|
|
11785
11822
|
type: "object"
|
|
11786
11823
|
}
|
|
11787
11824
|
}
|
|
@@ -11832,28 +11869,28 @@ var openapi_default = {
|
|
|
11832
11869
|
oneOf: [
|
|
11833
11870
|
{
|
|
11834
11871
|
properties: {
|
|
11835
|
-
|
|
11872
|
+
acs_encoder_ids: {
|
|
11836
11873
|
items: { format: "uuid", type: "string" },
|
|
11837
11874
|
type: "array"
|
|
11838
11875
|
},
|
|
11839
|
-
|
|
11876
|
+
acs_system_ids: {
|
|
11840
11877
|
items: { format: "uuid", type: "string" },
|
|
11841
11878
|
type: "array"
|
|
11842
11879
|
},
|
|
11843
11880
|
limit: { default: 500, format: "float", type: "number" }
|
|
11844
11881
|
},
|
|
11845
|
-
required: ["acs_system_ids", "
|
|
11882
|
+
required: ["acs_system_ids", "acs_encoder_ids"],
|
|
11846
11883
|
type: "object"
|
|
11847
11884
|
},
|
|
11848
11885
|
{
|
|
11849
11886
|
properties: {
|
|
11850
|
-
|
|
11887
|
+
acs_encoder_ids: {
|
|
11851
11888
|
items: { format: "uuid", type: "string" },
|
|
11852
11889
|
type: "array"
|
|
11853
11890
|
},
|
|
11854
11891
|
limit: { default: 500, format: "float", type: "number" }
|
|
11855
11892
|
},
|
|
11856
|
-
required: ["
|
|
11893
|
+
required: ["acs_encoder_ids"],
|
|
11857
11894
|
type: "object"
|
|
11858
11895
|
},
|
|
11859
11896
|
{
|
|
@@ -11878,13 +11915,84 @@ var openapi_default = {
|
|
|
11878
11915
|
"application/json": {
|
|
11879
11916
|
schema: {
|
|
11880
11917
|
properties: {
|
|
11881
|
-
|
|
11882
|
-
items: {
|
|
11918
|
+
acs_encoders: {
|
|
11919
|
+
items: {
|
|
11920
|
+
properties: {
|
|
11921
|
+
acs_encoder_id: {
|
|
11922
|
+
description: "ID of the `acs_encoder`.",
|
|
11923
|
+
format: "uuid",
|
|
11924
|
+
type: "string"
|
|
11925
|
+
},
|
|
11926
|
+
acs_system_id: {
|
|
11927
|
+
description: "ID of the access control system that contains the `acs_encoder`.",
|
|
11928
|
+
format: "uuid",
|
|
11929
|
+
type: "string"
|
|
11930
|
+
},
|
|
11931
|
+
created_at: {
|
|
11932
|
+
description: "Date and time at which the `acs_encoder` was created.",
|
|
11933
|
+
format: "date-time",
|
|
11934
|
+
type: "string"
|
|
11935
|
+
},
|
|
11936
|
+
display_name: {
|
|
11937
|
+
description: "Display name for the `acs_encoder`.",
|
|
11938
|
+
type: "string"
|
|
11939
|
+
},
|
|
11940
|
+
errors: {
|
|
11941
|
+
description: "Errors associated with the `acs_encoder`.",
|
|
11942
|
+
items: {
|
|
11943
|
+
description: "Error associated with the `acs_encoder`.",
|
|
11944
|
+
properties: {
|
|
11945
|
+
_event_id: {
|
|
11946
|
+
description: "ID of the event that was created when the `acs_encoder` was removed.",
|
|
11947
|
+
format: "uuid",
|
|
11948
|
+
type: "string"
|
|
11949
|
+
},
|
|
11950
|
+
created_at: {
|
|
11951
|
+
description: "Date and time at which Seam created the error.",
|
|
11952
|
+
format: "date-time",
|
|
11953
|
+
type: "string"
|
|
11954
|
+
},
|
|
11955
|
+
error_code: {
|
|
11956
|
+
description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
|
|
11957
|
+
enum: ["acs_encoder_removed"],
|
|
11958
|
+
type: "string"
|
|
11959
|
+
},
|
|
11960
|
+
message: {
|
|
11961
|
+
description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
|
|
11962
|
+
type: "string"
|
|
11963
|
+
}
|
|
11964
|
+
},
|
|
11965
|
+
required: [
|
|
11966
|
+
"created_at",
|
|
11967
|
+
"message",
|
|
11968
|
+
"error_code",
|
|
11969
|
+
"_event_id"
|
|
11970
|
+
],
|
|
11971
|
+
type: "object"
|
|
11972
|
+
},
|
|
11973
|
+
type: "array"
|
|
11974
|
+
},
|
|
11975
|
+
workspace_id: {
|
|
11976
|
+
description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.",
|
|
11977
|
+
format: "uuid",
|
|
11978
|
+
type: "string"
|
|
11979
|
+
}
|
|
11980
|
+
},
|
|
11981
|
+
required: [
|
|
11982
|
+
"acs_encoder_id",
|
|
11983
|
+
"acs_system_id",
|
|
11984
|
+
"workspace_id",
|
|
11985
|
+
"errors",
|
|
11986
|
+
"created_at",
|
|
11987
|
+
"display_name"
|
|
11988
|
+
],
|
|
11989
|
+
type: "object"
|
|
11990
|
+
},
|
|
11883
11991
|
type: "array"
|
|
11884
11992
|
},
|
|
11885
11993
|
ok: { type: "boolean" }
|
|
11886
11994
|
},
|
|
11887
|
-
required: ["
|
|
11995
|
+
required: ["acs_encoders", "ok"],
|
|
11888
11996
|
type: "object"
|
|
11889
11997
|
}
|
|
11890
11998
|
}
|
|
@@ -11903,8 +12011,8 @@ var openapi_default = {
|
|
|
11903
12011
|
tags: ["/acs"],
|
|
11904
12012
|
"x-fern-sdk-group-name": ["acs", "encoders"],
|
|
11905
12013
|
"x-fern-sdk-method-name": "list",
|
|
11906
|
-
"x-fern-sdk-return-value": "
|
|
11907
|
-
"x-response-key": "
|
|
12014
|
+
"x-fern-sdk-return-value": "acs_encoders",
|
|
12015
|
+
"x-response-key": "acs_encoders",
|
|
11908
12016
|
"x-undocumented": "Encoders are in alpha."
|
|
11909
12017
|
}
|
|
11910
12018
|
},
|
|
@@ -11916,18 +12024,18 @@ var openapi_default = {
|
|
|
11916
12024
|
"application/json": {
|
|
11917
12025
|
schema: {
|
|
11918
12026
|
properties: {
|
|
11919
|
-
|
|
11920
|
-
description: "ID of the
|
|
12027
|
+
acs_encoder_id: {
|
|
12028
|
+
description: "ID of the acs_encoder to use for the scan.",
|
|
11921
12029
|
format: "uuid",
|
|
11922
12030
|
type: "string"
|
|
11923
12031
|
},
|
|
11924
|
-
|
|
11925
|
-
description: "ID of the
|
|
12032
|
+
acs_system_id: {
|
|
12033
|
+
description: "ID of the acs_system the encoder belongs to.",
|
|
11926
12034
|
format: "uuid",
|
|
11927
12035
|
type: "string"
|
|
11928
12036
|
}
|
|
11929
12037
|
},
|
|
11930
|
-
required: ["acs_system_id", "
|
|
12038
|
+
required: ["acs_system_id", "acs_encoder_id"],
|
|
11931
12039
|
type: "object"
|
|
11932
12040
|
}
|
|
11933
12041
|
}
|
|
@@ -18706,7 +18814,7 @@ var openapi_default = {
|
|
|
18706
18814
|
},
|
|
18707
18815
|
"/thermostats/schedules/create": {
|
|
18708
18816
|
post: {
|
|
18709
|
-
description: "Creates a [
|
|
18817
|
+
description: "Creates a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
|
|
18710
18818
|
operationId: "thermostatsSchedulesCreatePost",
|
|
18711
18819
|
requestBody: {
|
|
18712
18820
|
content: {
|
|
@@ -18714,7 +18822,7 @@ var openapi_default = {
|
|
|
18714
18822
|
schema: {
|
|
18715
18823
|
properties: {
|
|
18716
18824
|
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
|
|
18825
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
|
|
18718
18826
|
type: "string"
|
|
18719
18827
|
},
|
|
18720
18828
|
device_id: {
|
|
@@ -18722,21 +18830,21 @@ var openapi_default = {
|
|
|
18722
18830
|
type: "string"
|
|
18723
18831
|
},
|
|
18724
18832
|
ends_at: {
|
|
18725
|
-
description: "Date and time at which the
|
|
18833
|
+
description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
18726
18834
|
type: "string"
|
|
18727
18835
|
},
|
|
18728
18836
|
max_override_period_minutes: {
|
|
18729
18837
|
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-
|
|
18838
|
+
description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
18731
18839
|
minimum: 0,
|
|
18732
18840
|
type: "integer"
|
|
18733
18841
|
},
|
|
18734
18842
|
name: {
|
|
18735
|
-
description: "User-friendly name to identify the
|
|
18843
|
+
description: "User-friendly name to identify the thermostat schedule.",
|
|
18736
18844
|
type: "string"
|
|
18737
18845
|
},
|
|
18738
18846
|
starts_at: {
|
|
18739
|
-
description: "Date and time at which the
|
|
18847
|
+
description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
18740
18848
|
type: "string"
|
|
18741
18849
|
}
|
|
18742
18850
|
},
|
|
@@ -18784,12 +18892,12 @@ var openapi_default = {
|
|
|
18784
18892
|
"x-fern-sdk-method-name": "create",
|
|
18785
18893
|
"x-fern-sdk-return-value": "thermostat_schedule",
|
|
18786
18894
|
"x-response-key": "thermostat_schedule",
|
|
18787
|
-
"x-title": "Create a
|
|
18895
|
+
"x-title": "Create a Thermostat Schedule"
|
|
18788
18896
|
}
|
|
18789
18897
|
},
|
|
18790
18898
|
"/thermostats/schedules/delete": {
|
|
18791
18899
|
post: {
|
|
18792
|
-
description: "Deletes a [
|
|
18900
|
+
description: "Deletes a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
|
|
18793
18901
|
operationId: "thermostatsSchedulesDeletePost",
|
|
18794
18902
|
requestBody: {
|
|
18795
18903
|
content: {
|
|
@@ -18797,7 +18905,7 @@ var openapi_default = {
|
|
|
18797
18905
|
schema: {
|
|
18798
18906
|
properties: {
|
|
18799
18907
|
thermostat_schedule_id: {
|
|
18800
|
-
description: "ID of the desired
|
|
18908
|
+
description: "ID of the desired thermostat schedule.",
|
|
18801
18909
|
format: "uuid",
|
|
18802
18910
|
type: "string"
|
|
18803
18911
|
}
|
|
@@ -18835,12 +18943,12 @@ var openapi_default = {
|
|
|
18835
18943
|
"x-fern-sdk-group-name": ["thermostats", "schedules"],
|
|
18836
18944
|
"x-fern-sdk-method-name": "delete",
|
|
18837
18945
|
"x-response-key": null,
|
|
18838
|
-
"x-title": "Delete a
|
|
18946
|
+
"x-title": "Delete a Thermostat Schedule"
|
|
18839
18947
|
}
|
|
18840
18948
|
},
|
|
18841
18949
|
"/thermostats/schedules/get": {
|
|
18842
18950
|
post: {
|
|
18843
|
-
description: "Returns a specified [
|
|
18951
|
+
description: "Returns a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
|
|
18844
18952
|
operationId: "thermostatsSchedulesGetPost",
|
|
18845
18953
|
requestBody: {
|
|
18846
18954
|
content: {
|
|
@@ -18848,7 +18956,7 @@ var openapi_default = {
|
|
|
18848
18956
|
schema: {
|
|
18849
18957
|
properties: {
|
|
18850
18958
|
thermostat_schedule_id: {
|
|
18851
|
-
description: "ID of the desired
|
|
18959
|
+
description: "ID of the desired thermostat schedule.",
|
|
18852
18960
|
format: "uuid",
|
|
18853
18961
|
type: "string"
|
|
18854
18962
|
}
|
|
@@ -18892,12 +19000,12 @@ var openapi_default = {
|
|
|
18892
19000
|
"x-fern-sdk-method-name": "get",
|
|
18893
19001
|
"x-fern-sdk-return-value": "thermostat_schedule",
|
|
18894
19002
|
"x-response-key": "thermostat_schedule",
|
|
18895
|
-
"x-title": "Get a
|
|
19003
|
+
"x-title": "Get a Thermostat Schedule"
|
|
18896
19004
|
}
|
|
18897
19005
|
},
|
|
18898
19006
|
"/thermostats/schedules/list": {
|
|
18899
19007
|
post: {
|
|
18900
|
-
description: "Returns a list of all [
|
|
19008
|
+
description: "Returns a list of all [thermostat schedules](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
|
|
18901
19009
|
operationId: "thermostatsSchedulesListPost",
|
|
18902
19010
|
requestBody: {
|
|
18903
19011
|
content: {
|
|
@@ -18910,7 +19018,7 @@ var openapi_default = {
|
|
|
18910
19018
|
type: "string"
|
|
18911
19019
|
},
|
|
18912
19020
|
user_identifier_key: {
|
|
18913
|
-
description: "User identifier key by which to filter the list of returned
|
|
19021
|
+
description: "User identifier key by which to filter the list of returned thermostat schedules.",
|
|
18914
19022
|
type: "string"
|
|
18915
19023
|
}
|
|
18916
19024
|
},
|
|
@@ -18956,12 +19064,12 @@ var openapi_default = {
|
|
|
18956
19064
|
"x-fern-sdk-method-name": "list",
|
|
18957
19065
|
"x-fern-sdk-return-value": "thermostat_schedules",
|
|
18958
19066
|
"x-response-key": "thermostat_schedules",
|
|
18959
|
-
"x-title": "List
|
|
19067
|
+
"x-title": "List Thermostat Schedules"
|
|
18960
19068
|
}
|
|
18961
19069
|
},
|
|
18962
19070
|
"/thermostats/schedules/update": {
|
|
18963
19071
|
patch: {
|
|
18964
|
-
description: "Updates a specified [
|
|
19072
|
+
description: "Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
|
|
18965
19073
|
operationId: "thermostatsSchedulesUpdatePatch",
|
|
18966
19074
|
requestBody: {
|
|
18967
19075
|
content: {
|
|
@@ -18969,28 +19077,28 @@ var openapi_default = {
|
|
|
18969
19077
|
schema: {
|
|
18970
19078
|
properties: {
|
|
18971
19079
|
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
|
|
19080
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
|
|
18973
19081
|
type: "string"
|
|
18974
19082
|
},
|
|
18975
19083
|
ends_at: {
|
|
18976
|
-
description: "Date and time at which the
|
|
19084
|
+
description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
18977
19085
|
type: "string"
|
|
18978
19086
|
},
|
|
18979
19087
|
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-
|
|
19088
|
+
description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
18981
19089
|
minimum: 0,
|
|
18982
19090
|
type: "integer"
|
|
18983
19091
|
},
|
|
18984
19092
|
name: {
|
|
18985
|
-
description: "User-friendly name to identify the
|
|
19093
|
+
description: "User-friendly name to identify the thermostat schedule.",
|
|
18986
19094
|
type: "string"
|
|
18987
19095
|
},
|
|
18988
19096
|
starts_at: {
|
|
18989
|
-
description: "Date and time at which the
|
|
19097
|
+
description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
18990
19098
|
type: "string"
|
|
18991
19099
|
},
|
|
18992
19100
|
thermostat_schedule_id: {
|
|
18993
|
-
description: "ID of the desired
|
|
19101
|
+
description: "ID of the desired thermostat schedule.",
|
|
18994
19102
|
format: "uuid",
|
|
18995
19103
|
type: "string"
|
|
18996
19104
|
}
|
|
@@ -19027,10 +19135,10 @@ var openapi_default = {
|
|
|
19027
19135
|
tags: ["/thermostats"],
|
|
19028
19136
|
"x-fern-ignore": true,
|
|
19029
19137
|
"x-response-key": null,
|
|
19030
|
-
"x-title": "Update a
|
|
19138
|
+
"x-title": "Update a Thermostat Schedule"
|
|
19031
19139
|
},
|
|
19032
19140
|
post: {
|
|
19033
|
-
description: "Updates a specified [
|
|
19141
|
+
description: "Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).",
|
|
19034
19142
|
operationId: "thermostatsSchedulesUpdatePost",
|
|
19035
19143
|
requestBody: {
|
|
19036
19144
|
content: {
|
|
@@ -19038,28 +19146,28 @@ var openapi_default = {
|
|
|
19038
19146
|
schema: {
|
|
19039
19147
|
properties: {
|
|
19040
19148
|
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
|
|
19149
|
+
description: "Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.",
|
|
19042
19150
|
type: "string"
|
|
19043
19151
|
},
|
|
19044
19152
|
ends_at: {
|
|
19045
|
-
description: "Date and time at which the
|
|
19153
|
+
description: "Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
19046
19154
|
type: "string"
|
|
19047
19155
|
},
|
|
19048
19156
|
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-
|
|
19157
|
+
description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
19050
19158
|
minimum: 0,
|
|
19051
19159
|
type: "integer"
|
|
19052
19160
|
},
|
|
19053
19161
|
name: {
|
|
19054
|
-
description: "User-friendly name to identify the
|
|
19162
|
+
description: "User-friendly name to identify the thermostat schedule.",
|
|
19055
19163
|
type: "string"
|
|
19056
19164
|
},
|
|
19057
19165
|
starts_at: {
|
|
19058
|
-
description: "Date and time at which the
|
|
19166
|
+
description: "Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
|
|
19059
19167
|
type: "string"
|
|
19060
19168
|
},
|
|
19061
19169
|
thermostat_schedule_id: {
|
|
19062
|
-
description: "ID of the desired
|
|
19170
|
+
description: "ID of the desired thermostat schedule.",
|
|
19063
19171
|
format: "uuid",
|
|
19064
19172
|
type: "string"
|
|
19065
19173
|
}
|
|
@@ -19097,7 +19205,7 @@ var openapi_default = {
|
|
|
19097
19205
|
"x-fern-sdk-group-name": ["thermostats", "schedules"],
|
|
19098
19206
|
"x-fern-sdk-method-name": "update",
|
|
19099
19207
|
"x-response-key": null,
|
|
19100
|
-
"x-title": "Update a
|
|
19208
|
+
"x-title": "Update a Thermostat Schedule"
|
|
19101
19209
|
}
|
|
19102
19210
|
},
|
|
19103
19211
|
"/thermostats/set_fallback_climate_preset": {
|