@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
|
@@ -4616,16 +4616,18 @@ export default {
|
|
|
4616
4616
|
properties: {
|
|
4617
4617
|
active_thermostat_schedule: {
|
|
4618
4618
|
default: null,
|
|
4619
|
+
description:
|
|
4620
|
+
'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.',
|
|
4619
4621
|
nullable: true,
|
|
4620
4622
|
properties: {
|
|
4621
4623
|
climate_preset_key: {
|
|
4622
4624
|
description:
|
|
4623
|
-
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the
|
|
4625
|
+
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
|
|
4624
4626
|
type: 'string',
|
|
4625
4627
|
},
|
|
4626
4628
|
created_at: {
|
|
4627
4629
|
description:
|
|
4628
|
-
'Date and time at which the
|
|
4630
|
+
'Date and time at which the thermostat schedule was created.',
|
|
4629
4631
|
format: 'date-time',
|
|
4630
4632
|
type: 'string',
|
|
4631
4633
|
},
|
|
@@ -4636,33 +4638,33 @@ export default {
|
|
|
4636
4638
|
},
|
|
4637
4639
|
ends_at: {
|
|
4638
4640
|
description:
|
|
4639
|
-
'Date and time at which the
|
|
4641
|
+
'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
4640
4642
|
format: 'date-time',
|
|
4641
4643
|
type: 'string',
|
|
4642
4644
|
},
|
|
4643
4645
|
errors: {
|
|
4644
4646
|
description:
|
|
4645
|
-
'Array of errors associated with the
|
|
4647
|
+
'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.',
|
|
4646
4648
|
},
|
|
4647
4649
|
max_override_period_minutes: {
|
|
4648
4650
|
description:
|
|
4649
|
-
"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-
|
|
4651
|
+
"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).",
|
|
4650
4652
|
minimum: 0,
|
|
4651
4653
|
type: 'integer',
|
|
4652
4654
|
},
|
|
4653
4655
|
name: {
|
|
4654
4656
|
description:
|
|
4655
|
-
'User-friendly name to identify the
|
|
4657
|
+
'User-friendly name to identify the thermostat schedule.',
|
|
4656
4658
|
type: 'string',
|
|
4657
4659
|
},
|
|
4658
4660
|
starts_at: {
|
|
4659
4661
|
description:
|
|
4660
|
-
'Date and time at which the
|
|
4662
|
+
'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
4661
4663
|
format: 'date-time',
|
|
4662
4664
|
type: 'string',
|
|
4663
4665
|
},
|
|
4664
4666
|
thermostat_schedule_id: {
|
|
4665
|
-
description: 'ID of the
|
|
4667
|
+
description: 'ID of the thermostat schedule.',
|
|
4666
4668
|
format: 'uuid',
|
|
4667
4669
|
type: 'string',
|
|
4668
4670
|
},
|
|
@@ -5417,15 +5419,17 @@ export default {
|
|
|
5417
5419
|
type: 'object',
|
|
5418
5420
|
},
|
|
5419
5421
|
thermostat_schedule: {
|
|
5422
|
+
description:
|
|
5423
|
+
'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.',
|
|
5420
5424
|
properties: {
|
|
5421
5425
|
climate_preset_key: {
|
|
5422
5426
|
description:
|
|
5423
|
-
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the
|
|
5427
|
+
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
|
|
5424
5428
|
type: 'string',
|
|
5425
5429
|
},
|
|
5426
5430
|
created_at: {
|
|
5427
5431
|
description:
|
|
5428
|
-
'Date and time at which the
|
|
5432
|
+
'Date and time at which the thermostat schedule was created.',
|
|
5429
5433
|
format: 'date-time',
|
|
5430
5434
|
type: 'string',
|
|
5431
5435
|
},
|
|
@@ -5436,32 +5440,33 @@ export default {
|
|
|
5436
5440
|
},
|
|
5437
5441
|
ends_at: {
|
|
5438
5442
|
description:
|
|
5439
|
-
'Date and time at which the
|
|
5443
|
+
'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
5440
5444
|
format: 'date-time',
|
|
5441
5445
|
type: 'string',
|
|
5442
5446
|
},
|
|
5443
5447
|
errors: {
|
|
5444
5448
|
description:
|
|
5445
|
-
'Array of errors associated with the
|
|
5449
|
+
'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.',
|
|
5446
5450
|
},
|
|
5447
5451
|
max_override_period_minutes: {
|
|
5448
5452
|
description:
|
|
5449
|
-
"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-
|
|
5453
|
+
"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).",
|
|
5450
5454
|
minimum: 0,
|
|
5451
5455
|
type: 'integer',
|
|
5452
5456
|
},
|
|
5453
5457
|
name: {
|
|
5454
|
-
description:
|
|
5458
|
+
description:
|
|
5459
|
+
'User-friendly name to identify the thermostat schedule.',
|
|
5455
5460
|
type: 'string',
|
|
5456
5461
|
},
|
|
5457
5462
|
starts_at: {
|
|
5458
5463
|
description:
|
|
5459
|
-
'Date and time at which the
|
|
5464
|
+
'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
5460
5465
|
format: 'date-time',
|
|
5461
5466
|
type: 'string',
|
|
5462
5467
|
},
|
|
5463
5468
|
thermostat_schedule_id: {
|
|
5464
|
-
description: 'ID of the
|
|
5469
|
+
description: 'ID of the thermostat schedule.',
|
|
5465
5470
|
format: 'uuid',
|
|
5466
5471
|
type: 'string',
|
|
5467
5472
|
},
|
|
@@ -9402,13 +9407,14 @@ export default {
|
|
|
9402
9407
|
format: 'uuid',
|
|
9403
9408
|
type: 'string',
|
|
9404
9409
|
},
|
|
9405
|
-
|
|
9406
|
-
description:
|
|
9410
|
+
acs_encoder_id: {
|
|
9411
|
+
description:
|
|
9412
|
+
'ID of the acs_encoder to use for the encoding.',
|
|
9407
9413
|
format: 'uuid',
|
|
9408
9414
|
type: 'string',
|
|
9409
9415
|
},
|
|
9410
9416
|
},
|
|
9411
|
-
required: ['
|
|
9417
|
+
required: ['acs_encoder_id', 'acs_credential_id'],
|
|
9412
9418
|
type: 'object',
|
|
9413
9419
|
},
|
|
9414
9420
|
},
|
|
@@ -9459,28 +9465,28 @@ export default {
|
|
|
9459
9465
|
oneOf: [
|
|
9460
9466
|
{
|
|
9461
9467
|
properties: {
|
|
9462
|
-
|
|
9468
|
+
acs_encoder_ids: {
|
|
9463
9469
|
items: { format: 'uuid', type: 'string' },
|
|
9464
9470
|
type: 'array',
|
|
9465
9471
|
},
|
|
9466
|
-
|
|
9472
|
+
acs_system_ids: {
|
|
9467
9473
|
items: { format: 'uuid', type: 'string' },
|
|
9468
9474
|
type: 'array',
|
|
9469
9475
|
},
|
|
9470
9476
|
limit: { default: 500, format: 'float', type: 'number' },
|
|
9471
9477
|
},
|
|
9472
|
-
required: ['acs_system_ids', '
|
|
9478
|
+
required: ['acs_system_ids', 'acs_encoder_ids'],
|
|
9473
9479
|
type: 'object',
|
|
9474
9480
|
},
|
|
9475
9481
|
{
|
|
9476
9482
|
properties: {
|
|
9477
|
-
|
|
9483
|
+
acs_encoder_ids: {
|
|
9478
9484
|
items: { format: 'uuid', type: 'string' },
|
|
9479
9485
|
type: 'array',
|
|
9480
9486
|
},
|
|
9481
9487
|
limit: { default: 500, format: 'float', type: 'number' },
|
|
9482
9488
|
},
|
|
9483
|
-
required: ['
|
|
9489
|
+
required: ['acs_encoder_ids'],
|
|
9484
9490
|
type: 'object',
|
|
9485
9491
|
},
|
|
9486
9492
|
{
|
|
@@ -9505,13 +9511,93 @@ export default {
|
|
|
9505
9511
|
'application/json': {
|
|
9506
9512
|
schema: {
|
|
9507
9513
|
properties: {
|
|
9508
|
-
|
|
9509
|
-
items: {
|
|
9514
|
+
acs_encoders: {
|
|
9515
|
+
items: {
|
|
9516
|
+
properties: {
|
|
9517
|
+
acs_encoder_id: {
|
|
9518
|
+
description: 'ID of the `acs_encoder`.',
|
|
9519
|
+
format: 'uuid',
|
|
9520
|
+
type: 'string',
|
|
9521
|
+
},
|
|
9522
|
+
acs_system_id: {
|
|
9523
|
+
description:
|
|
9524
|
+
'ID of the access control system that contains the `acs_encoder`.',
|
|
9525
|
+
format: 'uuid',
|
|
9526
|
+
type: 'string',
|
|
9527
|
+
},
|
|
9528
|
+
created_at: {
|
|
9529
|
+
description:
|
|
9530
|
+
'Date and time at which the `acs_encoder` was created.',
|
|
9531
|
+
format: 'date-time',
|
|
9532
|
+
type: 'string',
|
|
9533
|
+
},
|
|
9534
|
+
display_name: {
|
|
9535
|
+
description: 'Display name for the `acs_encoder`.',
|
|
9536
|
+
type: 'string',
|
|
9537
|
+
},
|
|
9538
|
+
errors: {
|
|
9539
|
+
description:
|
|
9540
|
+
'Errors associated with the `acs_encoder`.',
|
|
9541
|
+
items: {
|
|
9542
|
+
description:
|
|
9543
|
+
'Error associated with the `acs_encoder`.',
|
|
9544
|
+
properties: {
|
|
9545
|
+
_event_id: {
|
|
9546
|
+
description:
|
|
9547
|
+
'ID of the event that was created when the `acs_encoder` was removed.',
|
|
9548
|
+
format: 'uuid',
|
|
9549
|
+
type: 'string',
|
|
9550
|
+
},
|
|
9551
|
+
created_at: {
|
|
9552
|
+
description:
|
|
9553
|
+
'Date and time at which Seam created the error.',
|
|
9554
|
+
format: 'date-time',
|
|
9555
|
+
type: 'string',
|
|
9556
|
+
},
|
|
9557
|
+
error_code: {
|
|
9558
|
+
description:
|
|
9559
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
9560
|
+
enum: ['acs_encoder_removed'],
|
|
9561
|
+
type: 'string',
|
|
9562
|
+
},
|
|
9563
|
+
message: {
|
|
9564
|
+
description:
|
|
9565
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
9566
|
+
type: 'string',
|
|
9567
|
+
},
|
|
9568
|
+
},
|
|
9569
|
+
required: [
|
|
9570
|
+
'created_at',
|
|
9571
|
+
'message',
|
|
9572
|
+
'error_code',
|
|
9573
|
+
'_event_id',
|
|
9574
|
+
],
|
|
9575
|
+
type: 'object',
|
|
9576
|
+
},
|
|
9577
|
+
type: 'array',
|
|
9578
|
+
},
|
|
9579
|
+
workspace_id: {
|
|
9580
|
+
description:
|
|
9581
|
+
'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`.',
|
|
9582
|
+
format: 'uuid',
|
|
9583
|
+
type: 'string',
|
|
9584
|
+
},
|
|
9585
|
+
},
|
|
9586
|
+
required: [
|
|
9587
|
+
'acs_encoder_id',
|
|
9588
|
+
'acs_system_id',
|
|
9589
|
+
'workspace_id',
|
|
9590
|
+
'errors',
|
|
9591
|
+
'created_at',
|
|
9592
|
+
'display_name',
|
|
9593
|
+
],
|
|
9594
|
+
type: 'object',
|
|
9595
|
+
},
|
|
9510
9596
|
type: 'array',
|
|
9511
9597
|
},
|
|
9512
9598
|
ok: { type: 'boolean' },
|
|
9513
9599
|
},
|
|
9514
|
-
required: ['
|
|
9600
|
+
required: ['acs_encoders', 'ok'],
|
|
9515
9601
|
type: 'object',
|
|
9516
9602
|
},
|
|
9517
9603
|
},
|
|
@@ -9530,8 +9616,8 @@ export default {
|
|
|
9530
9616
|
tags: ['/acs'],
|
|
9531
9617
|
'x-fern-sdk-group-name': ['acs', 'encoders'],
|
|
9532
9618
|
'x-fern-sdk-method-name': 'list',
|
|
9533
|
-
'x-fern-sdk-return-value': '
|
|
9534
|
-
'x-response-key': '
|
|
9619
|
+
'x-fern-sdk-return-value': 'acs_encoders',
|
|
9620
|
+
'x-response-key': 'acs_encoders',
|
|
9535
9621
|
'x-undocumented': 'Encoders are in alpha.',
|
|
9536
9622
|
},
|
|
9537
9623
|
},
|
|
@@ -9543,18 +9629,18 @@ export default {
|
|
|
9543
9629
|
'application/json': {
|
|
9544
9630
|
schema: {
|
|
9545
9631
|
properties: {
|
|
9546
|
-
|
|
9547
|
-
description: 'ID of the
|
|
9632
|
+
acs_encoder_id: {
|
|
9633
|
+
description: 'ID of the acs_encoder to use for the scan.',
|
|
9548
9634
|
format: 'uuid',
|
|
9549
9635
|
type: 'string',
|
|
9550
9636
|
},
|
|
9551
|
-
|
|
9552
|
-
description: 'ID of the
|
|
9637
|
+
acs_system_id: {
|
|
9638
|
+
description: 'ID of the acs_system the encoder belongs to.',
|
|
9553
9639
|
format: 'uuid',
|
|
9554
9640
|
type: 'string',
|
|
9555
9641
|
},
|
|
9556
9642
|
},
|
|
9557
|
-
required: ['acs_system_id', '
|
|
9643
|
+
required: ['acs_system_id', 'acs_encoder_id'],
|
|
9558
9644
|
type: 'object',
|
|
9559
9645
|
},
|
|
9560
9646
|
},
|
|
@@ -16516,7 +16602,7 @@ export default {
|
|
|
16516
16602
|
'/thermostats/schedules/create': {
|
|
16517
16603
|
post: {
|
|
16518
16604
|
description:
|
|
16519
|
-
'Creates a [
|
|
16605
|
+
'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).',
|
|
16520
16606
|
operationId: 'thermostatsSchedulesCreatePost',
|
|
16521
16607
|
requestBody: {
|
|
16522
16608
|
content: {
|
|
@@ -16525,7 +16611,7 @@ export default {
|
|
|
16525
16611
|
properties: {
|
|
16526
16612
|
climate_preset_key: {
|
|
16527
16613
|
description:
|
|
16528
|
-
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the
|
|
16614
|
+
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
|
|
16529
16615
|
type: 'string',
|
|
16530
16616
|
},
|
|
16531
16617
|
device_id: {
|
|
@@ -16534,24 +16620,24 @@ export default {
|
|
|
16534
16620
|
},
|
|
16535
16621
|
ends_at: {
|
|
16536
16622
|
description:
|
|
16537
|
-
'Date and time at which the
|
|
16623
|
+
'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16538
16624
|
type: 'string',
|
|
16539
16625
|
},
|
|
16540
16626
|
max_override_period_minutes: {
|
|
16541
16627
|
default: 0,
|
|
16542
16628
|
description:
|
|
16543
|
-
"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-
|
|
16629
|
+
"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).",
|
|
16544
16630
|
minimum: 0,
|
|
16545
16631
|
type: 'integer',
|
|
16546
16632
|
},
|
|
16547
16633
|
name: {
|
|
16548
16634
|
description:
|
|
16549
|
-
'User-friendly name to identify the
|
|
16635
|
+
'User-friendly name to identify the thermostat schedule.',
|
|
16550
16636
|
type: 'string',
|
|
16551
16637
|
},
|
|
16552
16638
|
starts_at: {
|
|
16553
16639
|
description:
|
|
16554
|
-
'Date and time at which the
|
|
16640
|
+
'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16555
16641
|
type: 'string',
|
|
16556
16642
|
},
|
|
16557
16643
|
},
|
|
@@ -16599,13 +16685,13 @@ export default {
|
|
|
16599
16685
|
'x-fern-sdk-method-name': 'create',
|
|
16600
16686
|
'x-fern-sdk-return-value': 'thermostat_schedule',
|
|
16601
16687
|
'x-response-key': 'thermostat_schedule',
|
|
16602
|
-
'x-title': 'Create a
|
|
16688
|
+
'x-title': 'Create a Thermostat Schedule',
|
|
16603
16689
|
},
|
|
16604
16690
|
},
|
|
16605
16691
|
'/thermostats/schedules/delete': {
|
|
16606
16692
|
post: {
|
|
16607
16693
|
description:
|
|
16608
|
-
'Deletes a [
|
|
16694
|
+
'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).',
|
|
16609
16695
|
operationId: 'thermostatsSchedulesDeletePost',
|
|
16610
16696
|
requestBody: {
|
|
16611
16697
|
content: {
|
|
@@ -16613,7 +16699,7 @@ export default {
|
|
|
16613
16699
|
schema: {
|
|
16614
16700
|
properties: {
|
|
16615
16701
|
thermostat_schedule_id: {
|
|
16616
|
-
description: 'ID of the desired
|
|
16702
|
+
description: 'ID of the desired thermostat schedule.',
|
|
16617
16703
|
format: 'uuid',
|
|
16618
16704
|
type: 'string',
|
|
16619
16705
|
},
|
|
@@ -16651,13 +16737,13 @@ export default {
|
|
|
16651
16737
|
'x-fern-sdk-group-name': ['thermostats', 'schedules'],
|
|
16652
16738
|
'x-fern-sdk-method-name': 'delete',
|
|
16653
16739
|
'x-response-key': null,
|
|
16654
|
-
'x-title': 'Delete a
|
|
16740
|
+
'x-title': 'Delete a Thermostat Schedule',
|
|
16655
16741
|
},
|
|
16656
16742
|
},
|
|
16657
16743
|
'/thermostats/schedules/get': {
|
|
16658
16744
|
post: {
|
|
16659
16745
|
description:
|
|
16660
|
-
'Returns a specified [
|
|
16746
|
+
'Returns a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
16661
16747
|
operationId: 'thermostatsSchedulesGetPost',
|
|
16662
16748
|
requestBody: {
|
|
16663
16749
|
content: {
|
|
@@ -16665,7 +16751,7 @@ export default {
|
|
|
16665
16751
|
schema: {
|
|
16666
16752
|
properties: {
|
|
16667
16753
|
thermostat_schedule_id: {
|
|
16668
|
-
description: 'ID of the desired
|
|
16754
|
+
description: 'ID of the desired thermostat schedule.',
|
|
16669
16755
|
format: 'uuid',
|
|
16670
16756
|
type: 'string',
|
|
16671
16757
|
},
|
|
@@ -16709,13 +16795,13 @@ export default {
|
|
|
16709
16795
|
'x-fern-sdk-method-name': 'get',
|
|
16710
16796
|
'x-fern-sdk-return-value': 'thermostat_schedule',
|
|
16711
16797
|
'x-response-key': 'thermostat_schedule',
|
|
16712
|
-
'x-title': 'Get a
|
|
16798
|
+
'x-title': 'Get a Thermostat Schedule',
|
|
16713
16799
|
},
|
|
16714
16800
|
},
|
|
16715
16801
|
'/thermostats/schedules/list': {
|
|
16716
16802
|
post: {
|
|
16717
16803
|
description:
|
|
16718
|
-
'Returns a list of all [
|
|
16804
|
+
'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).',
|
|
16719
16805
|
operationId: 'thermostatsSchedulesListPost',
|
|
16720
16806
|
requestBody: {
|
|
16721
16807
|
content: {
|
|
@@ -16729,7 +16815,7 @@ export default {
|
|
|
16729
16815
|
},
|
|
16730
16816
|
user_identifier_key: {
|
|
16731
16817
|
description:
|
|
16732
|
-
'User identifier key by which to filter the list of returned
|
|
16818
|
+
'User identifier key by which to filter the list of returned thermostat schedules.',
|
|
16733
16819
|
type: 'string',
|
|
16734
16820
|
},
|
|
16735
16821
|
},
|
|
@@ -16775,13 +16861,13 @@ export default {
|
|
|
16775
16861
|
'x-fern-sdk-method-name': 'list',
|
|
16776
16862
|
'x-fern-sdk-return-value': 'thermostat_schedules',
|
|
16777
16863
|
'x-response-key': 'thermostat_schedules',
|
|
16778
|
-
'x-title': 'List
|
|
16864
|
+
'x-title': 'List Thermostat Schedules',
|
|
16779
16865
|
},
|
|
16780
16866
|
},
|
|
16781
16867
|
'/thermostats/schedules/update': {
|
|
16782
16868
|
patch: {
|
|
16783
16869
|
description:
|
|
16784
|
-
'Updates a specified [
|
|
16870
|
+
'Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
16785
16871
|
operationId: 'thermostatsSchedulesUpdatePatch',
|
|
16786
16872
|
requestBody: {
|
|
16787
16873
|
content: {
|
|
@@ -16790,32 +16876,32 @@ export default {
|
|
|
16790
16876
|
properties: {
|
|
16791
16877
|
climate_preset_key: {
|
|
16792
16878
|
description:
|
|
16793
|
-
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the
|
|
16879
|
+
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
|
|
16794
16880
|
type: 'string',
|
|
16795
16881
|
},
|
|
16796
16882
|
ends_at: {
|
|
16797
16883
|
description:
|
|
16798
|
-
'Date and time at which the
|
|
16884
|
+
'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16799
16885
|
type: 'string',
|
|
16800
16886
|
},
|
|
16801
16887
|
max_override_period_minutes: {
|
|
16802
16888
|
description:
|
|
16803
|
-
"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-
|
|
16889
|
+
"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).",
|
|
16804
16890
|
minimum: 0,
|
|
16805
16891
|
type: 'integer',
|
|
16806
16892
|
},
|
|
16807
16893
|
name: {
|
|
16808
16894
|
description:
|
|
16809
|
-
'User-friendly name to identify the
|
|
16895
|
+
'User-friendly name to identify the thermostat schedule.',
|
|
16810
16896
|
type: 'string',
|
|
16811
16897
|
},
|
|
16812
16898
|
starts_at: {
|
|
16813
16899
|
description:
|
|
16814
|
-
'Date and time at which the
|
|
16900
|
+
'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16815
16901
|
type: 'string',
|
|
16816
16902
|
},
|
|
16817
16903
|
thermostat_schedule_id: {
|
|
16818
|
-
description: 'ID of the desired
|
|
16904
|
+
description: 'ID of the desired thermostat schedule.',
|
|
16819
16905
|
format: 'uuid',
|
|
16820
16906
|
type: 'string',
|
|
16821
16907
|
},
|
|
@@ -16852,11 +16938,11 @@ export default {
|
|
|
16852
16938
|
tags: ['/thermostats'],
|
|
16853
16939
|
'x-fern-ignore': true,
|
|
16854
16940
|
'x-response-key': null,
|
|
16855
|
-
'x-title': 'Update a
|
|
16941
|
+
'x-title': 'Update a Thermostat Schedule',
|
|
16856
16942
|
},
|
|
16857
16943
|
post: {
|
|
16858
16944
|
description:
|
|
16859
|
-
'Updates a specified [
|
|
16945
|
+
'Updates a specified [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
|
|
16860
16946
|
operationId: 'thermostatsSchedulesUpdatePost',
|
|
16861
16947
|
requestBody: {
|
|
16862
16948
|
content: {
|
|
@@ -16865,32 +16951,32 @@ export default {
|
|
|
16865
16951
|
properties: {
|
|
16866
16952
|
climate_preset_key: {
|
|
16867
16953
|
description:
|
|
16868
|
-
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the
|
|
16954
|
+
'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
|
|
16869
16955
|
type: 'string',
|
|
16870
16956
|
},
|
|
16871
16957
|
ends_at: {
|
|
16872
16958
|
description:
|
|
16873
|
-
'Date and time at which the
|
|
16959
|
+
'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16874
16960
|
type: 'string',
|
|
16875
16961
|
},
|
|
16876
16962
|
max_override_period_minutes: {
|
|
16877
16963
|
description:
|
|
16878
|
-
"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-
|
|
16964
|
+
"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).",
|
|
16879
16965
|
minimum: 0,
|
|
16880
16966
|
type: 'integer',
|
|
16881
16967
|
},
|
|
16882
16968
|
name: {
|
|
16883
16969
|
description:
|
|
16884
|
-
'User-friendly name to identify the
|
|
16970
|
+
'User-friendly name to identify the thermostat schedule.',
|
|
16885
16971
|
type: 'string',
|
|
16886
16972
|
},
|
|
16887
16973
|
starts_at: {
|
|
16888
16974
|
description:
|
|
16889
|
-
'Date and time at which the
|
|
16975
|
+
'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
16890
16976
|
type: 'string',
|
|
16891
16977
|
},
|
|
16892
16978
|
thermostat_schedule_id: {
|
|
16893
|
-
description: 'ID of the desired
|
|
16979
|
+
description: 'ID of the desired thermostat schedule.',
|
|
16894
16980
|
format: 'uuid',
|
|
16895
16981
|
type: 'string',
|
|
16896
16982
|
},
|
|
@@ -16928,7 +17014,7 @@ export default {
|
|
|
16928
17014
|
'x-fern-sdk-group-name': ['thermostats', 'schedules'],
|
|
16929
17015
|
'x-fern-sdk-method-name': 'update',
|
|
16930
17016
|
'x-response-key': null,
|
|
16931
|
-
'x-title': 'Update a
|
|
17017
|
+
'x-title': 'Update a Thermostat Schedule',
|
|
16932
17018
|
},
|
|
16933
17019
|
},
|
|
16934
17020
|
'/thermostats/set_fallback_climate_preset': {
|