@seamapi/types 1.396.0 → 1.396.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8465,6 +8465,7 @@ export default {
8465
8465
  },
8466
8466
  thermostat_daily_programs: {
8467
8467
  items: {
8468
+ description: 'Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.',
8468
8469
  properties: {
8469
8470
  created_at: {
8470
8471
  description: 'Date and time at which the thermostat daily program was created.',
@@ -8472,7 +8473,7 @@ export default {
8472
8473
  type: 'string',
8473
8474
  },
8474
8475
  device_id: {
8475
- description: 'ID of the desired thermostat device.',
8476
+ description: 'ID of the thermostat device on which the thermostat daily program is configured.',
8476
8477
  format: 'uuid',
8477
8478
  type: 'string',
8478
8479
  },
@@ -8484,13 +8485,14 @@ export default {
8484
8485
  periods: {
8485
8486
  description: 'Array of thermostat daily program periods.',
8486
8487
  items: {
8488
+ description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
8487
8489
  properties: {
8488
8490
  climate_preset_key: {
8489
- description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time.',
8491
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
8490
8492
  type: 'string',
8491
8493
  },
8492
8494
  starts_at_time: {
8493
- description: 'Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
8495
+ description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
8494
8496
  pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
8495
8497
  type: 'string',
8496
8498
  },
@@ -8523,6 +8525,7 @@ export default {
8523
8525
  'created_at',
8524
8526
  ],
8525
8527
  type: 'object',
8528
+ 'x-route-path': '/thermostats/thermostat_daily_programs',
8526
8529
  },
8527
8530
  type: 'array',
8528
8531
  },
@@ -28023,11 +28026,11 @@ export default {
28023
28026
  schema: {
28024
28027
  properties: {
28025
28028
  climate_preset_key: {
28026
- description: 'Climate preset key of the desired climate preset.',
28029
+ description: 'Climate preset key of the climate preset that you want to activate.',
28027
28030
  type: 'string',
28028
28031
  },
28029
28032
  device_id: {
28030
- description: 'ID of the desired thermostat device.',
28033
+ description: 'ID of the thermostat device for which you want to activate a climate preset.',
28031
28034
  format: 'uuid',
28032
28035
  type: 'string',
28033
28036
  },
@@ -28094,7 +28097,7 @@ export default {
28094
28097
  type: 'number',
28095
28098
  },
28096
28099
  device_id: {
28097
- description: 'ID of the desired thermostat device.',
28100
+ description: 'ID of the thermostat device that you want to set to cool mode.',
28098
28101
  format: 'uuid',
28099
28102
  type: 'string',
28100
28103
  },
@@ -28171,7 +28174,7 @@ export default {
28171
28174
  type: 'number',
28172
28175
  },
28173
28176
  device_id: {
28174
- description: 'ID of the desired thermostat device.',
28177
+ description: 'ID of the thermostat device for which you want create a climate preset.',
28175
28178
  format: 'uuid',
28176
28179
  type: 'string',
28177
28180
  },
@@ -28247,7 +28250,7 @@ export default {
28247
28250
  },
28248
28251
  '/thermostats/daily_programs/create': {
28249
28252
  post: {
28250
- description: 'Creates a thermostat daily program.',
28253
+ description: 'Creates a thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.',
28251
28254
  operationId: 'thermostatsDailyProgramsCreatePost',
28252
28255
  requestBody: {
28253
28256
  content: {
@@ -28255,7 +28258,7 @@ export default {
28255
28258
  schema: {
28256
28259
  properties: {
28257
28260
  device_id: {
28258
- description: 'ID of the desired thermostat device.',
28261
+ description: 'ID of the thermostat device for which you want to create a daily program.',
28259
28262
  format: 'uuid',
28260
28263
  type: 'string',
28261
28264
  },
@@ -28266,13 +28269,14 @@ export default {
28266
28269
  periods: {
28267
28270
  description: 'Array of thermostat daily program periods.',
28268
28271
  items: {
28272
+ description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
28269
28273
  properties: {
28270
28274
  climate_preset_key: {
28271
- description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time.',
28275
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
28272
28276
  type: 'string',
28273
28277
  },
28274
28278
  starts_at_time: {
28275
- description: 'Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
28279
+ description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
28276
28280
  pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
28277
28281
  type: 'string',
28278
28282
  },
@@ -28297,6 +28301,7 @@ export default {
28297
28301
  properties: {
28298
28302
  ok: { type: 'boolean' },
28299
28303
  thermostat_daily_program: {
28304
+ description: 'Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.',
28300
28305
  properties: {
28301
28306
  created_at: {
28302
28307
  description: 'Date and time at which the thermostat daily program was created.',
@@ -28304,7 +28309,7 @@ export default {
28304
28309
  type: 'string',
28305
28310
  },
28306
28311
  device_id: {
28307
- description: 'ID of the desired thermostat device.',
28312
+ description: 'ID of the thermostat device on which the thermostat daily program is configured.',
28308
28313
  format: 'uuid',
28309
28314
  type: 'string',
28310
28315
  },
@@ -28316,13 +28321,14 @@ export default {
28316
28321
  periods: {
28317
28322
  description: 'Array of thermostat daily program periods.',
28318
28323
  items: {
28324
+ description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
28319
28325
  properties: {
28320
28326
  climate_preset_key: {
28321
- description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time.',
28327
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
28322
28328
  type: 'string',
28323
28329
  },
28324
28330
  starts_at_time: {
28325
- description: 'Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
28331
+ description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
28326
28332
  pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
28327
28333
  type: 'string',
28328
28334
  },
@@ -28352,6 +28358,7 @@ export default {
28352
28358
  'created_at',
28353
28359
  ],
28354
28360
  type: 'object',
28361
+ 'x-route-path': '/thermostats/thermostat_daily_programs',
28355
28362
  },
28356
28363
  },
28357
28364
  required: ['thermostat_daily_program', 'ok'],
@@ -28377,7 +28384,6 @@ export default {
28377
28384
  'x-fern-sdk-return-value': 'thermostat_daily_program',
28378
28385
  'x-response-key': 'thermostat_daily_program',
28379
28386
  'x-title': 'Create a Thermostat Daily Program',
28380
- 'x-undocumented': 'Unreleased.',
28381
28387
  },
28382
28388
  },
28383
28389
  '/thermostats/daily_programs/delete': {
@@ -28390,7 +28396,7 @@ export default {
28390
28396
  schema: {
28391
28397
  properties: {
28392
28398
  thermostat_daily_program_id: {
28393
- description: 'ID of the desired thermostat schedule.',
28399
+ description: 'ID of the thermostat daily program that you want to delete.',
28394
28400
  format: 'uuid',
28395
28401
  type: 'string',
28396
28402
  },
@@ -28429,12 +28435,11 @@ export default {
28429
28435
  'x-fern-sdk-method-name': 'delete',
28430
28436
  'x-response-key': null,
28431
28437
  'x-title': 'Delete a Thermostat Daily Program',
28432
- 'x-undocumented': 'Unreleased.',
28433
28438
  },
28434
28439
  },
28435
28440
  '/thermostats/daily_programs/update': {
28436
28441
  patch: {
28437
- description: 'Updates a specified thermostat daily program.',
28442
+ description: 'Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.',
28438
28443
  operationId: 'thermostatsDailyProgramsUpdatePatch',
28439
28444
  requestBody: {
28440
28445
  content: {
@@ -28442,19 +28447,20 @@ export default {
28442
28447
  schema: {
28443
28448
  properties: {
28444
28449
  name: {
28445
- description: 'User-friendly name to identify the thermostat daily program.',
28450
+ description: 'User-friendly name to identify the thermostat daily program that you want to update.',
28446
28451
  type: 'string',
28447
28452
  },
28448
28453
  periods: {
28449
- description: 'Array of thermostat daily program periods.',
28454
+ description: 'Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.',
28450
28455
  items: {
28456
+ description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
28451
28457
  properties: {
28452
28458
  climate_preset_key: {
28453
- description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time.',
28459
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
28454
28460
  type: 'string',
28455
28461
  },
28456
28462
  starts_at_time: {
28457
- description: 'Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
28463
+ description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
28458
28464
  pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
28459
28465
  type: 'string',
28460
28466
  },
@@ -28465,7 +28471,7 @@ export default {
28465
28471
  type: 'array',
28466
28472
  },
28467
28473
  thermostat_daily_program_id: {
28468
- description: 'ID of the desired thermostat daily program.',
28474
+ description: 'ID of the thermostat daily program that you want to update.',
28469
28475
  format: 'uuid',
28470
28476
  type: 'string',
28471
28477
  },
@@ -28509,10 +28515,9 @@ export default {
28509
28515
  'x-fern-ignore': true,
28510
28516
  'x-response-key': 'action_attempt',
28511
28517
  'x-title': 'Update a Thermostat Daily Program',
28512
- 'x-undocumented': 'Unreleased.',
28513
28518
  },
28514
28519
  post: {
28515
- description: 'Updates a specified thermostat daily program.',
28520
+ description: 'Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.',
28516
28521
  operationId: 'thermostatsDailyProgramsUpdatePost',
28517
28522
  requestBody: {
28518
28523
  content: {
@@ -28520,19 +28525,20 @@ export default {
28520
28525
  schema: {
28521
28526
  properties: {
28522
28527
  name: {
28523
- description: 'User-friendly name to identify the thermostat daily program.',
28528
+ description: 'User-friendly name to identify the thermostat daily program that you want to update.',
28524
28529
  type: 'string',
28525
28530
  },
28526
28531
  periods: {
28527
- description: 'Array of thermostat daily program periods.',
28532
+ description: 'Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.',
28528
28533
  items: {
28534
+ description: 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
28529
28535
  properties: {
28530
28536
  climate_preset_key: {
28531
- description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time.',
28537
+ description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
28532
28538
  type: 'string',
28533
28539
  },
28534
28540
  starts_at_time: {
28535
- description: 'Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
28541
+ description: 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
28536
28542
  pattern: '^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$',
28537
28543
  type: 'string',
28538
28544
  },
@@ -28543,7 +28549,7 @@ export default {
28543
28549
  type: 'array',
28544
28550
  },
28545
28551
  thermostat_daily_program_id: {
28546
- description: 'ID of the desired thermostat daily program.',
28552
+ description: 'ID of the thermostat daily program that you want to update.',
28547
28553
  format: 'uuid',
28548
28554
  type: 'string',
28549
28555
  },
@@ -28589,7 +28595,6 @@ export default {
28589
28595
  'x-fern-sdk-return-value': 'action_attempt',
28590
28596
  'x-response-key': 'action_attempt',
28591
28597
  'x-title': 'Update a Thermostat Daily Program',
28592
- 'x-undocumented': 'Unreleased.',
28593
28598
  },
28594
28599
  },
28595
28600
  '/thermostats/delete_climate_preset': {
@@ -28602,11 +28607,11 @@ export default {
28602
28607
  schema: {
28603
28608
  properties: {
28604
28609
  climate_preset_key: {
28605
- description: 'Climate preset key of the desired climate preset.',
28610
+ description: 'Climate preset key of the climate preset that you want to delete.',
28606
28611
  type: 'string',
28607
28612
  },
28608
28613
  device_id: {
28609
- description: 'ID of the desired thermostat device.',
28614
+ description: 'ID of the thermostat device for which you want to delete a climate preset.',
28610
28615
  format: 'uuid',
28611
28616
  type: 'string',
28612
28617
  },
@@ -28657,12 +28662,12 @@ export default {
28657
28662
  schema: {
28658
28663
  properties: {
28659
28664
  device_id: {
28660
- description: 'ID of the desired thermostat device.',
28665
+ description: 'ID of the thermostat device that you want to retrieve.',
28661
28666
  format: 'uuid',
28662
28667
  type: 'string',
28663
28668
  },
28664
28669
  name: {
28665
- description: 'User-friendly name of the desired thermostat device.',
28670
+ description: 'User-friendly name of the thermostat device that you want to retrieve.',
28666
28671
  type: 'string',
28667
28672
  },
28668
28673
  },
@@ -28717,7 +28722,7 @@ export default {
28717
28722
  schema: {
28718
28723
  properties: {
28719
28724
  device_id: {
28720
- description: 'ID of the desired thermostat device.',
28725
+ description: 'ID of the thermostat device that you want to set to heat mode.',
28721
28726
  format: 'uuid',
28722
28727
  type: 'string',
28723
28728
  },
@@ -28800,7 +28805,7 @@ export default {
28800
28805
  type: 'number',
28801
28806
  },
28802
28807
  device_id: {
28803
- description: 'ID of the desired thermostat device.',
28808
+ description: 'ID of the thermostat device that you want to set to heat-cool mode.',
28804
28809
  format: 'uuid',
28805
28810
  type: 'string',
28806
28811
  },
@@ -28909,7 +28914,7 @@ export default {
28909
28914
  type: 'array',
28910
28915
  },
28911
28916
  device_type: {
28912
- description: 'Device type by which to filter devices.',
28917
+ description: 'Device type by which to filter thermostat devices.',
28913
28918
  enum: [
28914
28919
  'ecobee_thermostat',
28915
28920
  'nest_thermostat',
@@ -28920,7 +28925,7 @@ export default {
28920
28925
  type: 'string',
28921
28926
  },
28922
28927
  device_types: {
28923
- description: 'Array of device types by which to filter devices.',
28928
+ description: 'Array of device types by which to filter thermostat devices.',
28924
28929
  items: {
28925
28930
  enum: [
28926
28931
  'ecobee_thermostat',
@@ -28980,7 +28985,7 @@ export default {
28980
28985
  type: 'number',
28981
28986
  },
28982
28987
  manufacturer: {
28983
- description: 'Manufacturer by which to filter devices.',
28988
+ description: 'Manufacturer by which to filter thermostat devices.',
28984
28989
  enum: [
28985
28990
  'ecobee',
28986
28991
  'honeywell_resideo',
@@ -29062,7 +29067,7 @@ export default {
29062
29067
  schema: {
29063
29068
  properties: {
29064
29069
  device_id: {
29065
- description: 'ID of the desired thermostat device.',
29070
+ description: 'ID of the thermostat device that you want to set to off mode.',
29066
29071
  format: 'uuid',
29067
29072
  type: 'string',
29068
29073
  },
@@ -29538,11 +29543,11 @@ export default {
29538
29543
  schema: {
29539
29544
  properties: {
29540
29545
  climate_preset_key: {
29541
- description: 'Climate preset key of the desired climate preset.',
29546
+ description: 'Climate preset key of the climate preset that you want to set as the fallback climate preset.',
29542
29547
  type: 'string',
29543
29548
  },
29544
29549
  device_id: {
29545
- description: 'ID of the desired thermostat device.',
29550
+ description: 'ID of the thermostat device for which you want to set the fallback climate preset.',
29546
29551
  format: 'uuid',
29547
29552
  type: 'string',
29548
29553
  },
@@ -29591,7 +29596,11 @@ export default {
29591
29596
  'application/json': {
29592
29597
  schema: {
29593
29598
  properties: {
29594
- device_id: { format: 'uuid', type: 'string' },
29599
+ device_id: {
29600
+ description: 'ID of the thermostat device for which you want to set the fan mode.',
29601
+ format: 'uuid',
29602
+ type: 'string',
29603
+ },
29595
29604
  fan_mode: {
29596
29605
  deprecated: true,
29597
29606
  enum: ['auto', 'on', 'circulate'],
@@ -29665,7 +29674,7 @@ export default {
29665
29674
  {
29666
29675
  properties: {
29667
29676
  device_id: {
29668
- description: 'ID of the desired thermostat device.',
29677
+ description: 'ID of the thermostat device for which you want to set the HVAC mode.',
29669
29678
  format: 'uuid',
29670
29679
  type: 'string',
29671
29680
  },
@@ -29687,7 +29696,7 @@ export default {
29687
29696
  type: 'number',
29688
29697
  },
29689
29698
  device_id: {
29690
- description: 'ID of the desired thermostat device.',
29699
+ description: 'ID of the thermostat device for which you want to set the HVAC mode.',
29691
29700
  format: 'uuid',
29692
29701
  type: 'string',
29693
29702
  },
@@ -29699,7 +29708,7 @@ export default {
29699
29708
  {
29700
29709
  properties: {
29701
29710
  device_id: {
29702
- description: 'ID of the desired thermostat device.',
29711
+ description: 'ID of the thermostat device for which you want to set the HVAC mode.',
29703
29712
  format: 'uuid',
29704
29713
  type: 'string',
29705
29714
  },
@@ -29731,7 +29740,7 @@ export default {
29731
29740
  type: 'number',
29732
29741
  },
29733
29742
  device_id: {
29734
- description: 'ID of the desired thermostat device.',
29743
+ description: 'ID of the thermostat device for which you want to set the HVAC mode.',
29735
29744
  format: 'uuid',
29736
29745
  type: 'string',
29737
29746
  },
@@ -29805,7 +29814,7 @@ export default {
29805
29814
  schema: {
29806
29815
  properties: {
29807
29816
  device_id: {
29808
- description: 'ID of the desired thermostat device.',
29817
+ description: 'ID of the thermostat device for which you want to set a temperature threshold.',
29809
29818
  format: 'uuid',
29810
29819
  type: 'string',
29811
29820
  },
@@ -29880,7 +29889,7 @@ export default {
29880
29889
  schema: {
29881
29890
  properties: {
29882
29891
  device_id: {
29883
- description: 'ID of the desired thermostat device.',
29892
+ description: 'ID of the thermostat device for which you want to set a temperature threshold.',
29884
29893
  format: 'uuid',
29885
29894
  type: 'string',
29886
29895
  },
@@ -30180,7 +30189,7 @@ export default {
30180
30189
  type: 'number',
30181
30190
  },
30182
30191
  device_id: {
30183
- description: 'ID of the desired thermostat device.',
30192
+ description: 'ID of the thermostat device for which you want to update a climate preset.',
30184
30193
  format: 'uuid',
30185
30194
  type: 'string',
30186
30195
  },
@@ -30278,7 +30287,7 @@ export default {
30278
30287
  type: 'number',
30279
30288
  },
30280
30289
  device_id: {
30281
- description: 'ID of the desired thermostat device.',
30290
+ description: 'ID of the thermostat device for which you want to update a climate preset.',
30282
30291
  format: 'uuid',
30283
30292
  type: 'string',
30284
30293
  },
@@ -30357,7 +30366,7 @@ export default {
30357
30366
  },
30358
30367
  '/thermostats/update_weekly_program': {
30359
30368
  post: {
30360
- description: 'Activates a thermostat weekly program.',
30369
+ description: 'Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.',
30361
30370
  operationId: 'thermostatsUpdateWeeklyProgramPost',
30362
30371
  requestBody: {
30363
30372
  content: {
@@ -30365,7 +30374,7 @@ export default {
30365
30374
  schema: {
30366
30375
  properties: {
30367
30376
  device_id: {
30368
- description: 'ID of the thermostat device that the weekly program is for.',
30377
+ description: 'ID of the thermostat device for which you want to update the weekly program.',
30369
30378
  format: 'uuid',
30370
30379
  type: 'string',
30371
30380
  },
@@ -30452,8 +30461,7 @@ export default {
30452
30461
  'x-fern-sdk-method-name': 'update_weekly_program',
30453
30462
  'x-fern-sdk-return-value': 'action_attempt',
30454
30463
  'x-response-key': 'action_attempt',
30455
- 'x-title': 'Activate a Thermostat Weekly Program',
30456
- 'x-undocumented': 'Unreleased.',
30464
+ 'x-title': 'Update the Thermostat Weekly Program',
30457
30465
  },
30458
30466
  },
30459
30467
  '/unstable_access_grants/create': {