@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
|
@@ -4413,14 +4413,15 @@ export default {
|
|
|
4413
4413
|
properties: {
|
|
4414
4414
|
active_thermostat_schedule: {
|
|
4415
4415
|
default: null,
|
|
4416
|
+
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.',
|
|
4416
4417
|
nullable: true,
|
|
4417
4418
|
properties: {
|
|
4418
4419
|
climate_preset_key: {
|
|
4419
|
-
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the
|
|
4420
|
+
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.',
|
|
4420
4421
|
type: 'string',
|
|
4421
4422
|
},
|
|
4422
4423
|
created_at: {
|
|
4423
|
-
description: 'Date and time at which the
|
|
4424
|
+
description: 'Date and time at which the thermostat schedule was created.',
|
|
4424
4425
|
format: 'date-time',
|
|
4425
4426
|
type: 'string',
|
|
4426
4427
|
},
|
|
@@ -4430,29 +4431,29 @@ export default {
|
|
|
4430
4431
|
type: 'string',
|
|
4431
4432
|
},
|
|
4432
4433
|
ends_at: {
|
|
4433
|
-
description: 'Date and time at which the
|
|
4434
|
+
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.',
|
|
4434
4435
|
format: 'date-time',
|
|
4435
4436
|
type: 'string',
|
|
4436
4437
|
},
|
|
4437
4438
|
errors: {
|
|
4438
|
-
description: 'Array of errors associated with the
|
|
4439
|
+
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.',
|
|
4439
4440
|
},
|
|
4440
4441
|
max_override_period_minutes: {
|
|
4441
|
-
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-
|
|
4442
|
+
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).",
|
|
4442
4443
|
minimum: 0,
|
|
4443
4444
|
type: 'integer',
|
|
4444
4445
|
},
|
|
4445
4446
|
name: {
|
|
4446
|
-
description: 'User-friendly name to identify the
|
|
4447
|
+
description: 'User-friendly name to identify the thermostat schedule.',
|
|
4447
4448
|
type: 'string',
|
|
4448
4449
|
},
|
|
4449
4450
|
starts_at: {
|
|
4450
|
-
description: 'Date and time at which the
|
|
4451
|
+
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.',
|
|
4451
4452
|
format: 'date-time',
|
|
4452
4453
|
type: 'string',
|
|
4453
4454
|
},
|
|
4454
4455
|
thermostat_schedule_id: {
|
|
4455
|
-
description: 'ID of the
|
|
4456
|
+
description: 'ID of the thermostat schedule.',
|
|
4456
4457
|
format: 'uuid',
|
|
4457
4458
|
type: 'string',
|
|
4458
4459
|
},
|
|
@@ -5162,13 +5163,14 @@ export default {
|
|
|
5162
5163
|
type: 'object',
|
|
5163
5164
|
},
|
|
5164
5165
|
thermostat_schedule: {
|
|
5166
|
+
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.',
|
|
5165
5167
|
properties: {
|
|
5166
5168
|
climate_preset_key: {
|
|
5167
|
-
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the
|
|
5169
|
+
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.',
|
|
5168
5170
|
type: 'string',
|
|
5169
5171
|
},
|
|
5170
5172
|
created_at: {
|
|
5171
|
-
description: 'Date and time at which the
|
|
5173
|
+
description: 'Date and time at which the thermostat schedule was created.',
|
|
5172
5174
|
format: 'date-time',
|
|
5173
5175
|
type: 'string',
|
|
5174
5176
|
},
|
|
@@ -5178,29 +5180,29 @@ export default {
|
|
|
5178
5180
|
type: 'string',
|
|
5179
5181
|
},
|
|
5180
5182
|
ends_at: {
|
|
5181
|
-
description: 'Date and time at which the
|
|
5183
|
+
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.',
|
|
5182
5184
|
format: 'date-time',
|
|
5183
5185
|
type: 'string',
|
|
5184
5186
|
},
|
|
5185
5187
|
errors: {
|
|
5186
|
-
description: 'Array of errors associated with the
|
|
5188
|
+
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.',
|
|
5187
5189
|
},
|
|
5188
5190
|
max_override_period_minutes: {
|
|
5189
|
-
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-
|
|
5191
|
+
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).",
|
|
5190
5192
|
minimum: 0,
|
|
5191
5193
|
type: 'integer',
|
|
5192
5194
|
},
|
|
5193
5195
|
name: {
|
|
5194
|
-
description: 'User-friendly name to identify the
|
|
5196
|
+
description: 'User-friendly name to identify the thermostat schedule.',
|
|
5195
5197
|
type: 'string',
|
|
5196
5198
|
},
|
|
5197
5199
|
starts_at: {
|
|
5198
|
-
description: 'Date and time at which the
|
|
5200
|
+
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.',
|
|
5199
5201
|
format: 'date-time',
|
|
5200
5202
|
type: 'string',
|
|
5201
5203
|
},
|
|
5202
5204
|
thermostat_schedule_id: {
|
|
5203
|
-
description: 'ID of the
|
|
5205
|
+
description: 'ID of the thermostat schedule.',
|
|
5204
5206
|
format: 'uuid',
|
|
5205
5207
|
type: 'string',
|
|
5206
5208
|
},
|
|
@@ -9015,13 +9017,13 @@ export default {
|
|
|
9015
9017
|
format: 'uuid',
|
|
9016
9018
|
type: 'string',
|
|
9017
9019
|
},
|
|
9018
|
-
|
|
9019
|
-
description: 'ID of the
|
|
9020
|
+
acs_encoder_id: {
|
|
9021
|
+
description: 'ID of the acs_encoder to use for the encoding.',
|
|
9020
9022
|
format: 'uuid',
|
|
9021
9023
|
type: 'string',
|
|
9022
9024
|
},
|
|
9023
9025
|
},
|
|
9024
|
-
required: ['
|
|
9026
|
+
required: ['acs_encoder_id', 'acs_credential_id'],
|
|
9025
9027
|
type: 'object',
|
|
9026
9028
|
},
|
|
9027
9029
|
},
|
|
@@ -9072,28 +9074,28 @@ export default {
|
|
|
9072
9074
|
oneOf: [
|
|
9073
9075
|
{
|
|
9074
9076
|
properties: {
|
|
9075
|
-
|
|
9077
|
+
acs_encoder_ids: {
|
|
9076
9078
|
items: { format: 'uuid', type: 'string' },
|
|
9077
9079
|
type: 'array',
|
|
9078
9080
|
},
|
|
9079
|
-
|
|
9081
|
+
acs_system_ids: {
|
|
9080
9082
|
items: { format: 'uuid', type: 'string' },
|
|
9081
9083
|
type: 'array',
|
|
9082
9084
|
},
|
|
9083
9085
|
limit: { default: 500, format: 'float', type: 'number' },
|
|
9084
9086
|
},
|
|
9085
|
-
required: ['acs_system_ids', '
|
|
9087
|
+
required: ['acs_system_ids', 'acs_encoder_ids'],
|
|
9086
9088
|
type: 'object',
|
|
9087
9089
|
},
|
|
9088
9090
|
{
|
|
9089
9091
|
properties: {
|
|
9090
|
-
|
|
9092
|
+
acs_encoder_ids: {
|
|
9091
9093
|
items: { format: 'uuid', type: 'string' },
|
|
9092
9094
|
type: 'array',
|
|
9093
9095
|
},
|
|
9094
9096
|
limit: { default: 500, format: 'float', type: 'number' },
|
|
9095
9097
|
},
|
|
9096
|
-
required: ['
|
|
9098
|
+
required: ['acs_encoder_ids'],
|
|
9097
9099
|
type: 'object',
|
|
9098
9100
|
},
|
|
9099
9101
|
{
|
|
@@ -9118,13 +9120,84 @@ export default {
|
|
|
9118
9120
|
'application/json': {
|
|
9119
9121
|
schema: {
|
|
9120
9122
|
properties: {
|
|
9121
|
-
|
|
9122
|
-
items: {
|
|
9123
|
+
acs_encoders: {
|
|
9124
|
+
items: {
|
|
9125
|
+
properties: {
|
|
9126
|
+
acs_encoder_id: {
|
|
9127
|
+
description: 'ID of the `acs_encoder`.',
|
|
9128
|
+
format: 'uuid',
|
|
9129
|
+
type: 'string',
|
|
9130
|
+
},
|
|
9131
|
+
acs_system_id: {
|
|
9132
|
+
description: 'ID of the access control system that contains the `acs_encoder`.',
|
|
9133
|
+
format: 'uuid',
|
|
9134
|
+
type: 'string',
|
|
9135
|
+
},
|
|
9136
|
+
created_at: {
|
|
9137
|
+
description: 'Date and time at which the `acs_encoder` was created.',
|
|
9138
|
+
format: 'date-time',
|
|
9139
|
+
type: 'string',
|
|
9140
|
+
},
|
|
9141
|
+
display_name: {
|
|
9142
|
+
description: 'Display name for the `acs_encoder`.',
|
|
9143
|
+
type: 'string',
|
|
9144
|
+
},
|
|
9145
|
+
errors: {
|
|
9146
|
+
description: 'Errors associated with the `acs_encoder`.',
|
|
9147
|
+
items: {
|
|
9148
|
+
description: 'Error associated with the `acs_encoder`.',
|
|
9149
|
+
properties: {
|
|
9150
|
+
_event_id: {
|
|
9151
|
+
description: 'ID of the event that was created when the `acs_encoder` was removed.',
|
|
9152
|
+
format: 'uuid',
|
|
9153
|
+
type: 'string',
|
|
9154
|
+
},
|
|
9155
|
+
created_at: {
|
|
9156
|
+
description: 'Date and time at which Seam created the error.',
|
|
9157
|
+
format: 'date-time',
|
|
9158
|
+
type: 'string',
|
|
9159
|
+
},
|
|
9160
|
+
error_code: {
|
|
9161
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
9162
|
+
enum: ['acs_encoder_removed'],
|
|
9163
|
+
type: 'string',
|
|
9164
|
+
},
|
|
9165
|
+
message: {
|
|
9166
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
9167
|
+
type: 'string',
|
|
9168
|
+
},
|
|
9169
|
+
},
|
|
9170
|
+
required: [
|
|
9171
|
+
'created_at',
|
|
9172
|
+
'message',
|
|
9173
|
+
'error_code',
|
|
9174
|
+
'_event_id',
|
|
9175
|
+
],
|
|
9176
|
+
type: 'object',
|
|
9177
|
+
},
|
|
9178
|
+
type: 'array',
|
|
9179
|
+
},
|
|
9180
|
+
workspace_id: {
|
|
9181
|
+
description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.',
|
|
9182
|
+
format: 'uuid',
|
|
9183
|
+
type: 'string',
|
|
9184
|
+
},
|
|
9185
|
+
},
|
|
9186
|
+
required: [
|
|
9187
|
+
'acs_encoder_id',
|
|
9188
|
+
'acs_system_id',
|
|
9189
|
+
'workspace_id',
|
|
9190
|
+
'errors',
|
|
9191
|
+
'created_at',
|
|
9192
|
+
'display_name',
|
|
9193
|
+
],
|
|
9194
|
+
type: 'object',
|
|
9195
|
+
},
|
|
9123
9196
|
type: 'array',
|
|
9124
9197
|
},
|
|
9125
9198
|
ok: { type: 'boolean' },
|
|
9126
9199
|
},
|
|
9127
|
-
required: ['
|
|
9200
|
+
required: ['acs_encoders', 'ok'],
|
|
9128
9201
|
type: 'object',
|
|
9129
9202
|
},
|
|
9130
9203
|
},
|
|
@@ -9143,8 +9216,8 @@ export default {
|
|
|
9143
9216
|
tags: ['/acs'],
|
|
9144
9217
|
'x-fern-sdk-group-name': ['acs', 'encoders'],
|
|
9145
9218
|
'x-fern-sdk-method-name': 'list',
|
|
9146
|
-
'x-fern-sdk-return-value': '
|
|
9147
|
-
'x-response-key': '
|
|
9219
|
+
'x-fern-sdk-return-value': 'acs_encoders',
|
|
9220
|
+
'x-response-key': 'acs_encoders',
|
|
9148
9221
|
'x-undocumented': 'Encoders are in alpha.',
|
|
9149
9222
|
},
|
|
9150
9223
|
},
|
|
@@ -9156,18 +9229,18 @@ export default {
|
|
|
9156
9229
|
'application/json': {
|
|
9157
9230
|
schema: {
|
|
9158
9231
|
properties: {
|
|
9159
|
-
|
|
9160
|
-
description: 'ID of the
|
|
9232
|
+
acs_encoder_id: {
|
|
9233
|
+
description: 'ID of the acs_encoder to use for the scan.',
|
|
9161
9234
|
format: 'uuid',
|
|
9162
9235
|
type: 'string',
|
|
9163
9236
|
},
|
|
9164
|
-
|
|
9165
|
-
description: 'ID of the
|
|
9237
|
+
acs_system_id: {
|
|
9238
|
+
description: 'ID of the acs_system the encoder belongs to.',
|
|
9166
9239
|
format: 'uuid',
|
|
9167
9240
|
type: 'string',
|
|
9168
9241
|
},
|
|
9169
9242
|
},
|
|
9170
|
-
required: ['acs_system_id', '
|
|
9243
|
+
required: ['acs_system_id', 'acs_encoder_id'],
|
|
9171
9244
|
type: 'object',
|
|
9172
9245
|
},
|
|
9173
9246
|
},
|
|
@@ -15946,7 +16019,7 @@ export default {
|
|
|
15946
16019
|
},
|
|
15947
16020
|
'/thermostats/schedules/create': {
|
|
15948
16021
|
post: {
|
|
15949
|
-
description: 'Creates a [
|
|
16022
|
+
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).',
|
|
15950
16023
|
operationId: 'thermostatsSchedulesCreatePost',
|
|
15951
16024
|
requestBody: {
|
|
15952
16025
|
content: {
|
|
@@ -15954,7 +16027,7 @@ export default {
|
|
|
15954
16027
|
schema: {
|
|
15955
16028
|
properties: {
|
|
15956
16029
|
climate_preset_key: {
|
|
15957
|
-
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the
|
|
16030
|
+
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.',
|
|
15958
16031
|
type: 'string',
|
|
15959
16032
|
},
|
|
15960
16033
|
device_id: {
|
|
@@ -15962,21 +16035,21 @@ export default {
|
|
|
15962
16035
|
type: 'string',
|
|
15963
16036
|
},
|
|
15964
16037
|
ends_at: {
|
|
15965
|
-
description: 'Date and time at which the
|
|
16038
|
+
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.',
|
|
15966
16039
|
type: 'string',
|
|
15967
16040
|
},
|
|
15968
16041
|
max_override_period_minutes: {
|
|
15969
16042
|
default: 0,
|
|
15970
|
-
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-
|
|
16043
|
+
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).",
|
|
15971
16044
|
minimum: 0,
|
|
15972
16045
|
type: 'integer',
|
|
15973
16046
|
},
|
|
15974
16047
|
name: {
|
|
15975
|
-
description: 'User-friendly name to identify the
|
|
16048
|
+
description: 'User-friendly name to identify the thermostat schedule.',
|
|
15976
16049
|
type: 'string',
|
|
15977
16050
|
},
|
|
15978
16051
|
starts_at: {
|
|
15979
|
-
description: 'Date and time at which the
|
|
16052
|
+
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.',
|
|
15980
16053
|
type: 'string',
|
|
15981
16054
|
},
|
|
15982
16055
|
},
|
|
@@ -16024,12 +16097,12 @@ export default {
|
|
|
16024
16097
|
'x-fern-sdk-method-name': 'create',
|
|
16025
16098
|
'x-fern-sdk-return-value': 'thermostat_schedule',
|
|
16026
16099
|
'x-response-key': 'thermostat_schedule',
|
|
16027
|
-
'x-title': 'Create a
|
|
16100
|
+
'x-title': 'Create a Thermostat Schedule',
|
|
16028
16101
|
},
|
|
16029
16102
|
},
|
|
16030
16103
|
'/thermostats/schedules/delete': {
|
|
16031
16104
|
post: {
|
|
16032
|
-
description: 'Deletes a [
|
|
16105
|
+
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).',
|
|
16033
16106
|
operationId: 'thermostatsSchedulesDeletePost',
|
|
16034
16107
|
requestBody: {
|
|
16035
16108
|
content: {
|
|
@@ -16037,7 +16110,7 @@ export default {
|
|
|
16037
16110
|
schema: {
|
|
16038
16111
|
properties: {
|
|
16039
16112
|
thermostat_schedule_id: {
|
|
16040
|
-
description: 'ID of the desired
|
|
16113
|
+
description: 'ID of the desired thermostat schedule.',
|
|
16041
16114
|
format: 'uuid',
|
|
16042
16115
|
type: 'string',
|
|
16043
16116
|
},
|
|
@@ -16075,12 +16148,12 @@ export default {
|
|
|
16075
16148
|
'x-fern-sdk-group-name': ['thermostats', 'schedules'],
|
|
16076
16149
|
'x-fern-sdk-method-name': 'delete',
|
|
16077
16150
|
'x-response-key': null,
|
|
16078
|
-
'x-title': 'Delete a
|
|
16151
|
+
'x-title': 'Delete a Thermostat Schedule',
|
|
16079
16152
|
},
|
|
16080
16153
|
},
|
|
16081
16154
|
'/thermostats/schedules/get': {
|
|
16082
16155
|
post: {
|
|
16083
|
-
description: 'Returns a specified [
|
|
16156
|
+
description: 'Returns a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
16084
16157
|
operationId: 'thermostatsSchedulesGetPost',
|
|
16085
16158
|
requestBody: {
|
|
16086
16159
|
content: {
|
|
@@ -16088,7 +16161,7 @@ export default {
|
|
|
16088
16161
|
schema: {
|
|
16089
16162
|
properties: {
|
|
16090
16163
|
thermostat_schedule_id: {
|
|
16091
|
-
description: 'ID of the desired
|
|
16164
|
+
description: 'ID of the desired thermostat schedule.',
|
|
16092
16165
|
format: 'uuid',
|
|
16093
16166
|
type: 'string',
|
|
16094
16167
|
},
|
|
@@ -16132,12 +16205,12 @@ export default {
|
|
|
16132
16205
|
'x-fern-sdk-method-name': 'get',
|
|
16133
16206
|
'x-fern-sdk-return-value': 'thermostat_schedule',
|
|
16134
16207
|
'x-response-key': 'thermostat_schedule',
|
|
16135
|
-
'x-title': 'Get a
|
|
16208
|
+
'x-title': 'Get a Thermostat Schedule',
|
|
16136
16209
|
},
|
|
16137
16210
|
},
|
|
16138
16211
|
'/thermostats/schedules/list': {
|
|
16139
16212
|
post: {
|
|
16140
|
-
description: 'Returns a list of all [
|
|
16213
|
+
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).',
|
|
16141
16214
|
operationId: 'thermostatsSchedulesListPost',
|
|
16142
16215
|
requestBody: {
|
|
16143
16216
|
content: {
|
|
@@ -16150,7 +16223,7 @@ export default {
|
|
|
16150
16223
|
type: 'string',
|
|
16151
16224
|
},
|
|
16152
16225
|
user_identifier_key: {
|
|
16153
|
-
description: 'User identifier key by which to filter the list of returned
|
|
16226
|
+
description: 'User identifier key by which to filter the list of returned thermostat schedules.',
|
|
16154
16227
|
type: 'string',
|
|
16155
16228
|
},
|
|
16156
16229
|
},
|
|
@@ -16196,12 +16269,12 @@ export default {
|
|
|
16196
16269
|
'x-fern-sdk-method-name': 'list',
|
|
16197
16270
|
'x-fern-sdk-return-value': 'thermostat_schedules',
|
|
16198
16271
|
'x-response-key': 'thermostat_schedules',
|
|
16199
|
-
'x-title': 'List
|
|
16272
|
+
'x-title': 'List Thermostat Schedules',
|
|
16200
16273
|
},
|
|
16201
16274
|
},
|
|
16202
16275
|
'/thermostats/schedules/update': {
|
|
16203
16276
|
patch: {
|
|
16204
|
-
description: 'Updates a specified [
|
|
16277
|
+
description: 'Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
16205
16278
|
operationId: 'thermostatsSchedulesUpdatePatch',
|
|
16206
16279
|
requestBody: {
|
|
16207
16280
|
content: {
|
|
@@ -16209,28 +16282,28 @@ export default {
|
|
|
16209
16282
|
schema: {
|
|
16210
16283
|
properties: {
|
|
16211
16284
|
climate_preset_key: {
|
|
16212
|
-
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the
|
|
16285
|
+
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.',
|
|
16213
16286
|
type: 'string',
|
|
16214
16287
|
},
|
|
16215
16288
|
ends_at: {
|
|
16216
|
-
description: 'Date and time at which the
|
|
16289
|
+
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.',
|
|
16217
16290
|
type: 'string',
|
|
16218
16291
|
},
|
|
16219
16292
|
max_override_period_minutes: {
|
|
16220
|
-
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-
|
|
16293
|
+
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).",
|
|
16221
16294
|
minimum: 0,
|
|
16222
16295
|
type: 'integer',
|
|
16223
16296
|
},
|
|
16224
16297
|
name: {
|
|
16225
|
-
description: 'User-friendly name to identify the
|
|
16298
|
+
description: 'User-friendly name to identify the thermostat schedule.',
|
|
16226
16299
|
type: 'string',
|
|
16227
16300
|
},
|
|
16228
16301
|
starts_at: {
|
|
16229
|
-
description: 'Date and time at which the
|
|
16302
|
+
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.',
|
|
16230
16303
|
type: 'string',
|
|
16231
16304
|
},
|
|
16232
16305
|
thermostat_schedule_id: {
|
|
16233
|
-
description: 'ID of the desired
|
|
16306
|
+
description: 'ID of the desired thermostat schedule.',
|
|
16234
16307
|
format: 'uuid',
|
|
16235
16308
|
type: 'string',
|
|
16236
16309
|
},
|
|
@@ -16267,10 +16340,10 @@ export default {
|
|
|
16267
16340
|
tags: ['/thermostats'],
|
|
16268
16341
|
'x-fern-ignore': true,
|
|
16269
16342
|
'x-response-key': null,
|
|
16270
|
-
'x-title': 'Update a
|
|
16343
|
+
'x-title': 'Update a Thermostat Schedule',
|
|
16271
16344
|
},
|
|
16272
16345
|
post: {
|
|
16273
|
-
description: 'Updates a specified [
|
|
16346
|
+
description: 'Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
16274
16347
|
operationId: 'thermostatsSchedulesUpdatePost',
|
|
16275
16348
|
requestBody: {
|
|
16276
16349
|
content: {
|
|
@@ -16278,28 +16351,28 @@ export default {
|
|
|
16278
16351
|
schema: {
|
|
16279
16352
|
properties: {
|
|
16280
16353
|
climate_preset_key: {
|
|
16281
|
-
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the
|
|
16354
|
+
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.',
|
|
16282
16355
|
type: 'string',
|
|
16283
16356
|
},
|
|
16284
16357
|
ends_at: {
|
|
16285
|
-
description: 'Date and time at which the
|
|
16358
|
+
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.',
|
|
16286
16359
|
type: 'string',
|
|
16287
16360
|
},
|
|
16288
16361
|
max_override_period_minutes: {
|
|
16289
|
-
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-
|
|
16362
|
+
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).",
|
|
16290
16363
|
minimum: 0,
|
|
16291
16364
|
type: 'integer',
|
|
16292
16365
|
},
|
|
16293
16366
|
name: {
|
|
16294
|
-
description: 'User-friendly name to identify the
|
|
16367
|
+
description: 'User-friendly name to identify the thermostat schedule.',
|
|
16295
16368
|
type: 'string',
|
|
16296
16369
|
},
|
|
16297
16370
|
starts_at: {
|
|
16298
|
-
description: 'Date and time at which the
|
|
16371
|
+
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.',
|
|
16299
16372
|
type: 'string',
|
|
16300
16373
|
},
|
|
16301
16374
|
thermostat_schedule_id: {
|
|
16302
|
-
description: 'ID of the desired
|
|
16375
|
+
description: 'ID of the desired thermostat schedule.',
|
|
16303
16376
|
format: 'uuid',
|
|
16304
16377
|
type: 'string',
|
|
16305
16378
|
},
|
|
@@ -16337,7 +16410,7 @@ export default {
|
|
|
16337
16410
|
'x-fern-sdk-group-name': ['thermostats', 'schedules'],
|
|
16338
16411
|
'x-fern-sdk-method-name': 'update',
|
|
16339
16412
|
'x-response-key': null,
|
|
16340
|
-
'x-title': 'Update a
|
|
16413
|
+
'x-title': 'Update a Thermostat Schedule',
|
|
16341
16414
|
},
|
|
16342
16415
|
},
|
|
16343
16416
|
'/thermostats/set_fallback_climate_preset': {
|