@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.
@@ -5398,8 +5398,8 @@ export interface Routes {
5398
5398
  queryParams: {}
5399
5399
  jsonBody: {}
5400
5400
  commonParams: {
5401
- /** ID of the encoder to use for the encoding. */
5402
- device_id: string
5401
+ /** ID of the acs_encoder to use for the encoding. */
5402
+ acs_encoder_id: string
5403
5403
  /** ID of the acs_credential to encode on a physical card. */
5404
5404
  acs_credential_id: string
5405
5405
  }
@@ -6261,11 +6261,11 @@ export interface Routes {
6261
6261
  commonParams:
6262
6262
  | {
6263
6263
  acs_system_ids: string[]
6264
- device_ids: string[]
6264
+ acs_encoder_ids: string[]
6265
6265
  limit?: number
6266
6266
  }
6267
6267
  | {
6268
- device_ids: string[]
6268
+ acs_encoder_ids: string[]
6269
6269
  limit?: number
6270
6270
  }
6271
6271
  | {
@@ -6274,695 +6274,28 @@ export interface Routes {
6274
6274
  }
6275
6275
  formData: {}
6276
6276
  jsonResponse: {
6277
- devices: Array<{
6278
- /** Unique identifier for the device. */
6279
- device_id: string
6280
- /** Type of the device. */
6281
- device_type:
6282
- | (
6283
- | 'akuvox_lock'
6284
- | 'august_lock'
6285
- | 'brivo_access_point'
6286
- | 'butterflymx_panel'
6287
- | 'avigilon_alta_entry'
6288
- | 'doorking_lock'
6289
- | 'genie_door'
6290
- | 'igloo_lock'
6291
- | 'linear_lock'
6292
- | 'lockly_lock'
6293
- | 'kwikset_lock'
6294
- | 'nuki_lock'
6295
- | 'salto_lock'
6296
- | 'schlage_lock'
6297
- | 'seam_relay'
6298
- | 'smartthings_lock'
6299
- | 'wyze_lock'
6300
- | 'yale_lock'
6301
- | 'two_n_intercom'
6302
- | 'controlbyweb_device'
6303
- | 'ttlock_lock'
6304
- | 'igloohome_lock'
6305
- | 'hubitat_lock'
6306
- | 'four_suites_door'
6307
- | 'dormakaba_oracode_door'
6308
- | 'tedee_lock'
6309
- | 'akiles_lock'
6310
- )
6311
- | ('noiseaware_activity_zone' | 'minut_sensor')
6312
- | (
6313
- | 'ecobee_thermostat'
6314
- | 'nest_thermostat'
6315
- | 'honeywell_resideo_thermostat'
6316
- )
6317
- | ('ios_phone' | 'android_phone')
6318
- | ('visionline_encoder' | 'assa_abloy_vostio_encoder')
6319
- /** Optional nickname to describe the device, settable through Seam */
6320
- nickname?: string | undefined
6321
- /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
6277
+ acs_encoders: Array<{
6278
+ /** ID of the `acs_encoder`. */
6279
+ acs_encoder_id: string
6280
+ /** ID of the access control system that contains the `acs_encoder`. */
6281
+ acs_system_id: string
6282
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
6283
+ workspace_id: string
6284
+ /** Errors associated with the `acs_encoder`. */
6285
+ errors: Array<{
6286
+ /** Date and time at which Seam created the error. */
6287
+ created_at: string
6288
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
6289
+ message: string
6290
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6291
+ error_code: 'acs_encoder_removed'
6292
+ /** ID of the event that was created when the `acs_encoder` was removed. */
6293
+ _event_id: string
6294
+ }>
6295
+ /** Date and time at which the `acs_encoder` was created. */
6296
+ created_at: string
6297
+ /** Display name for the `acs_encoder`. */
6322
6298
  display_name: string
6323
- /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
6324
- capabilities_supported: Array<
6325
- | 'access_code'
6326
- | 'lock'
6327
- | 'noise_detection'
6328
- | 'thermostat'
6329
- | 'battery'
6330
- | 'phone'
6331
- >
6332
- /** Properties of the device. */
6333
- properties: (({
6334
- /** Indicates whether the device is online. */
6335
- online: boolean
6336
- /** Name of the device.
6337
- * @deprecated use device.display_name instead */
6338
- name: string
6339
- /** Represents the accessory keypad state. */
6340
- accessory_keypad?:
6341
- | {
6342
- /** Indicates if the accessory_keypad is connected to the device. */
6343
- is_connected: boolean
6344
- /** Indicates if the keypad battery properties. */
6345
- battery?:
6346
- | {
6347
- level: number
6348
- }
6349
- | undefined
6350
- }
6351
- | undefined
6352
- appearance: {
6353
- /** Name of the device as seen from the provider API and application, not settable through Seam. */
6354
- name: string
6355
- }
6356
- model: {
6357
- /** Indicates whether the device can connect a accessory keypad. */
6358
- can_connect_accessory_keypad?: boolean | undefined
6359
- /** Display name of the device model. */
6360
- display_name: string
6361
- /** Display name that corresponds to the manufacturer-specific terminology for the device. */
6362
- manufacturer_display_name: string
6363
- /** Indicates whether the device has a built in accessory keypad. */
6364
- has_built_in_keypad?: boolean | undefined
6365
- /** Indicates whether the device supports offline access codes. */
6366
- offline_access_codes_supported?: boolean | undefined
6367
- /** Indicates whether the device supports online access codes. */
6368
- online_access_codes_supported?: boolean | undefined
6369
- /**
6370
- * @deprecated use device.properties.model.can_connect_accessory_keypad */
6371
- accessory_keypad_supported?: boolean | undefined
6372
- }
6373
- /** Indicates whether the device has direct power. */
6374
- has_direct_power?: boolean | undefined
6375
- /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
6376
- battery_level?: number | undefined
6377
- /** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
6378
- battery?:
6379
- | {
6380
- level: number
6381
- status: 'critical' | 'low' | 'good' | 'full'
6382
- }
6383
- | undefined
6384
- /** Manufacturer of the device. */
6385
- manufacturer?: string | undefined
6386
- /** Image URL for the device. */
6387
- image_url?: string | undefined
6388
- /** Alt text for the device image. */
6389
- image_alt_text?: string | undefined
6390
- /** Serial number of the device. */
6391
- serial_number?: string | undefined
6392
- /** Indicates whether it is currently possible to use online access codes for the device. */
6393
- online_access_codes_enabled?: boolean | undefined
6394
- /** Indicates whether it is currently possible to use offline access codes for the device. */
6395
- offline_access_codes_enabled?: boolean | undefined
6396
- /**
6397
- * @deprecated use device.properties.model.can_connect_accessory_keypad */
6398
- supports_accessory_keypad?: boolean | undefined
6399
- /**
6400
- * @deprecated use offline_access_codes_enabled */
6401
- supports_offline_access_codes?: boolean | undefined
6402
- /** Indicates current noise level in decibels, if the device supports noise detection. */
6403
- noise_level_decibels?: number | undefined
6404
- /** Array of noise threshold IDs that are currently triggering. */
6405
- currently_triggering_noise_threshold_ids?: string[] | undefined
6406
- } & {
6407
- assa_abloy_credential_service_metadata?:
6408
- | (
6409
- | {
6410
- has_active_endpoint: boolean
6411
- endpoints: Array<{
6412
- endpoint_id: string
6413
- is_active: boolean
6414
- }>
6415
- }
6416
- | undefined
6417
- )
6418
- | undefined
6419
- }) & {
6420
- august_metadata?:
6421
- | {
6422
- lock_id: string
6423
- lock_name: string
6424
- house_name: string
6425
- has_keypad: boolean
6426
- keypad_battery_level?: string | undefined
6427
- model?: string | undefined
6428
- house_id?: string | undefined
6429
- }
6430
- | undefined
6431
- avigilon_alta_metadata?:
6432
- | {
6433
- entry_name: string
6434
- org_name: string
6435
- zone_id: number
6436
- zone_name: string
6437
- site_id: number
6438
- site_name: string
6439
- entry_relays_total_count: number
6440
- }
6441
- | undefined
6442
- schlage_metadata?:
6443
- | {
6444
- device_id: string
6445
- device_name: string
6446
- access_code_length: number | null
6447
- model?: string | undefined
6448
- }
6449
- | undefined
6450
- smartthings_metadata?:
6451
- | {
6452
- device_id: string
6453
- device_name: string
6454
- model?: string | undefined
6455
- location_id?: string | undefined
6456
- }
6457
- | undefined
6458
- lockly_metadata?:
6459
- | {
6460
- device_id: string
6461
- device_name: string
6462
- model?: string | undefined
6463
- }
6464
- | undefined
6465
- nuki_metadata?:
6466
- | {
6467
- device_id: string
6468
- device_name: string
6469
- keypad_battery_critical?: boolean | undefined
6470
- keypad_paired?: boolean | undefined
6471
- keypad_2_paired?: boolean | undefined
6472
- }
6473
- | undefined
6474
- kwikset_metadata?:
6475
- | {
6476
- device_id: string
6477
- device_name: string
6478
- model_number: string
6479
- }
6480
- | undefined
6481
- /**
6482
- ---
6483
- deprecated: Use `salto_ks_metadata ` instead.
6484
- */
6485
- salto_metadata?:
6486
- | {
6487
- lock_id: string
6488
- customer_reference: string
6489
- lock_type: string
6490
- battery_level: string
6491
- locked_state: string
6492
- model?: string | undefined
6493
- }
6494
- | undefined
6495
- salto_ks_metadata?:
6496
- | {
6497
- lock_id: string
6498
- customer_reference: string
6499
- lock_type: string
6500
- battery_level: string
6501
- locked_state: string
6502
- model?: string | undefined
6503
- }
6504
- | undefined
6505
- genie_metadata?:
6506
- | {
6507
- device_name: string
6508
- door_name: string
6509
- }
6510
- | undefined
6511
- brivo_metadata?:
6512
- | {
6513
- device_name: string
6514
- }
6515
- | undefined
6516
- igloo_metadata?:
6517
- | {
6518
- device_id: string
6519
- bridge_id: string
6520
- model?: string | undefined
6521
- }
6522
- | undefined
6523
- noiseaware_metadata?:
6524
- | {
6525
- device_model: 'indoor' | 'outdoor'
6526
- noise_level_nrs: number
6527
- noise_level_decibel: number
6528
- device_name: string
6529
- device_id: string
6530
- }
6531
- | undefined
6532
- minut_metadata?:
6533
- | {
6534
- device_id: string
6535
- device_name: string
6536
- latest_sensor_values: {
6537
- temperature: {
6538
- time: string
6539
- value: number
6540
- }
6541
- sound: {
6542
- time: string
6543
- value: number
6544
- }
6545
- humidity: {
6546
- time: string
6547
- value: number
6548
- }
6549
- pressure: {
6550
- time: string
6551
- value: number
6552
- }
6553
- accelerometer_z: {
6554
- time: string
6555
- value: number
6556
- }
6557
- }
6558
- }
6559
- | undefined
6560
- four_suites_metadata?:
6561
- | {
6562
- device_id: number
6563
- device_name: string
6564
- reclose_delay_in_seconds: number
6565
- }
6566
- | undefined
6567
- two_n_metadata?:
6568
- | {
6569
- device_id: number
6570
- device_name: string
6571
- }
6572
- | undefined
6573
- controlbyweb_metadata?:
6574
- | {
6575
- device_id: string
6576
- device_name: string
6577
- relay_name: string | null
6578
- }
6579
- | undefined
6580
- ttlock_metadata?:
6581
- | {
6582
- lock_id: number
6583
- lock_alias: string
6584
- feature_value: string
6585
- features: {
6586
- passcode: boolean
6587
- passcode_management: boolean
6588
- unlock_via_gateway: boolean
6589
- lock_command: boolean
6590
- incomplete_keyboard_passcode: boolean
6591
- }
6592
- has_gateway?: boolean | undefined
6593
- wireless_keypads?:
6594
- | Array<{
6595
- wireless_keypad_id: number
6596
- wireless_keypad_name: string
6597
- }>
6598
- | undefined
6599
- }
6600
- | undefined
6601
- seam_bridge_metadata?:
6602
- | {
6603
- unlock_method?: ('bridge' | 'doorking') | undefined
6604
- device_num: number
6605
- name: string
6606
- }
6607
- | undefined
6608
- igloohome_metadata?:
6609
- | {
6610
- device_id: string
6611
- device_name: string
6612
- bridge_id?: string | undefined
6613
- bridge_name?: string | undefined
6614
- keypad_id?: string | undefined
6615
- }
6616
- | undefined
6617
- nest_metadata?:
6618
- | {
6619
- nest_device_id: string
6620
- device_name: string
6621
- custom_name: string
6622
- display_name?: string | undefined
6623
- }
6624
- | undefined
6625
- ecobee_metadata?:
6626
- | {
6627
- ecobee_device_id: string
6628
- device_name: string
6629
- }
6630
- | undefined
6631
- honeywell_resideo_metadata?:
6632
- | {
6633
- honeywell_resideo_device_id: string
6634
- device_name: string
6635
- }
6636
- | undefined
6637
- hubitat_metadata?:
6638
- | {
6639
- device_id: string
6640
- device_name: string
6641
- device_label: string
6642
- }
6643
- | undefined
6644
- dormakaba_oracode_metadata?:
6645
- | {
6646
- door_id?: number | undefined
6647
- door_name: string
6648
- device_id?: (number | string) | undefined
6649
- door_is_wireless: boolean
6650
- /** @DEPRECATED */
6651
- site_id: number | null
6652
- site_name: string
6653
- iana_timezone?: string | undefined
6654
- predefined_time_slots?:
6655
- | Array<{
6656
- name: string
6657
- prefix: number
6658
- check_in_time: string
6659
- check_out_time: string
6660
- is_24_hour: boolean
6661
- is_biweekly_mode: boolean
6662
- is_one_shot: boolean
6663
- is_master: boolean
6664
- ext_dormakaba_oracode_user_level_prefix: number
6665
- dormakaba_oracode_user_level_id: string
6666
- }>
6667
- | undefined
6668
- }
6669
- | undefined
6670
- wyze_metadata?:
6671
- | {
6672
- device_id: string
6673
- device_name: string
6674
- product_name: string
6675
- product_type: string
6676
- product_model: string
6677
- device_info_model: string
6678
- keypad_uuid?: string | undefined
6679
- locker_status_hardlock?: number | undefined
6680
- }
6681
- | undefined
6682
- tedee_metadata?:
6683
- | {
6684
- device_id: number
6685
- serial_number: string
6686
- device_name: string
6687
- device_model: string
6688
- bridge_id: number
6689
- bridge_name: string
6690
- keypad_id?: number | undefined
6691
- }
6692
- | undefined
6693
- visionline_metadata?:
6694
- | {
6695
- encoder_id: string
6696
- }
6697
- | undefined
6698
- akiles_metadata?:
6699
- | {
6700
- gadget_name: string
6701
- gadget_id: string
6702
- product_name: string
6703
- _member_group_id?: string | undefined
6704
- }
6705
- | undefined
6706
- assa_abloy_vostio_metadata?:
6707
- | {
6708
- encoder_name: string
6709
- }
6710
- | undefined
6711
- }) &
6712
- ({
6713
- _experimental_supported_code_from_access_codes_lengths?:
6714
- | (number[] | undefined)
6715
- | undefined
6716
- code_constraints?:
6717
- | (
6718
- | Array<
6719
- | {
6720
- constraint_type:
6721
- | 'no_zeros'
6722
- | 'cannot_start_with_12'
6723
- | 'no_triple_consecutive_ints'
6724
- | 'cannot_specify_pin_code'
6725
- | 'pin_code_matches_existing_set'
6726
- | 'start_date_in_future'
6727
- | 'no_ascending_or_descending_sequence'
6728
- | 'at_least_three_unique_digits'
6729
- | 'cannot_contain_089'
6730
- | 'cannot_contain_0789'
6731
- }
6732
- | {
6733
- constraint_type: 'name_length' | 'name_must_be_unique'
6734
- min_length?: number | undefined
6735
- max_length?: number | undefined
6736
- }
6737
- >
6738
- | undefined
6739
- )
6740
- | undefined
6741
- supported_code_lengths?: (number[] | undefined) | undefined
6742
- max_active_codes_supported?: (number | undefined) | undefined
6743
- supports_backup_access_code_pool?: (boolean | undefined) | undefined
6744
- has_native_entry_events?: (boolean | undefined) | undefined
6745
- locked?: (boolean | undefined) | undefined
6746
- keypad_battery?:
6747
- | (
6748
- | {
6749
- level: number
6750
- }
6751
- | undefined
6752
- )
6753
- | undefined
6754
- door_open?: (boolean | undefined) | undefined
6755
- } & {
6756
- temperature_fahrenheit?: number | undefined
6757
- temperature_celsius?: number | undefined
6758
- relative_humidity?: number | undefined
6759
- available_hvac_mode_settings?:
6760
- | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
6761
- | undefined
6762
- available_fan_mode_settings?:
6763
- | Array<'auto' | 'on' | 'circulate'>
6764
- | undefined
6765
- is_heating?: boolean | undefined
6766
- is_cooling?: boolean | undefined
6767
- is_fan_running?: boolean | undefined
6768
- /**
6769
- * @deprecated use current_climate_setting.fan_mode_setting instead. */
6770
- fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
6771
- is_temporary_manual_override_active?: boolean | undefined
6772
- current_climate_setting?:
6773
- | {
6774
- /** Unique key to identify the climate preset. */
6775
- climate_preset_key?: string | undefined
6776
- /** Indicates whether this climate preset key can be edited. */
6777
- can_edit?: boolean | undefined
6778
- /** Indicates whether this climate preset key can be deleted. */
6779
- can_delete?: boolean | undefined
6780
- /** User-friendly name to identify the climate preset. */
6781
- name?: ((string | null) | undefined) | undefined
6782
- /** Display name for the climate preset. */
6783
- display_name?: string | undefined
6784
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
6785
- fan_mode_setting?:
6786
- | (('auto' | 'on' | 'circulate') | undefined)
6787
- | undefined
6788
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
6789
- hvac_mode_setting?:
6790
- | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
6791
- | undefined
6792
- /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
6793
- cooling_set_point_celsius?: (number | undefined) | undefined
6794
- /** Temperature to which the thermostat should heat (in °C). */
6795
- heating_set_point_celsius?: (number | undefined) | undefined
6796
- /** Temperature to which the thermostat should cool (in °F). */
6797
- cooling_set_point_fahrenheit?:
6798
- | (number | undefined)
6799
- | undefined
6800
- /** Temperature to which the thermostat should heat (in °F). */
6801
- heating_set_point_fahrenheit?:
6802
- | (number | undefined)
6803
- | undefined
6804
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
6805
- manual_override_allowed?: boolean | undefined
6806
- }
6807
- | undefined
6808
- /**
6809
- * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
6810
- default_climate_setting?:
6811
- | {
6812
- /** Unique key to identify the climate preset. */
6813
- climate_preset_key?: string | undefined
6814
- /** Indicates whether this climate preset key can be edited. */
6815
- can_edit?: boolean | undefined
6816
- /** Indicates whether this climate preset key can be deleted. */
6817
- can_delete?: boolean | undefined
6818
- /** User-friendly name to identify the climate preset. */
6819
- name?: ((string | null) | undefined) | undefined
6820
- /** Display name for the climate preset. */
6821
- display_name?: string | undefined
6822
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
6823
- fan_mode_setting?:
6824
- | (('auto' | 'on' | 'circulate') | undefined)
6825
- | undefined
6826
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
6827
- hvac_mode_setting?:
6828
- | (('off' | 'heat' | 'cool' | 'heat_cool') | undefined)
6829
- | undefined
6830
- /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
6831
- cooling_set_point_celsius?: (number | undefined) | undefined
6832
- /** Temperature to which the thermostat should heat (in °C). */
6833
- heating_set_point_celsius?: (number | undefined) | undefined
6834
- /** Temperature to which the thermostat should cool (in °F). */
6835
- cooling_set_point_fahrenheit?:
6836
- | (number | undefined)
6837
- | undefined
6838
- /** Temperature to which the thermostat should heat (in °F). */
6839
- heating_set_point_fahrenheit?:
6840
- | (number | undefined)
6841
- | undefined
6842
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
6843
- manual_override_allowed?: boolean | undefined
6844
- }
6845
- | undefined
6846
- available_climate_presets?:
6847
- | Array<{
6848
- /** Unique key to identify the climate preset. */
6849
- climate_preset_key: string
6850
- /** Indicates whether this climate preset key can be edited. */
6851
- can_edit: boolean
6852
- /** Indicates whether this climate preset key can be deleted. */
6853
- can_delete: boolean
6854
- /** User-friendly name to identify the climate preset. */
6855
- name?: (string | null) | undefined
6856
- /** Display name for the climate preset. */
6857
- display_name: string
6858
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
6859
- fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
6860
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
6861
- hvac_mode_setting?:
6862
- | ('off' | 'heat' | 'cool' | 'heat_cool')
6863
- | undefined
6864
- /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
6865
- cooling_set_point_celsius?: number | undefined
6866
- /** Temperature to which the thermostat should heat (in °C). */
6867
- heating_set_point_celsius?: number | undefined
6868
- /** Temperature to which the thermostat should cool (in °F). */
6869
- cooling_set_point_fahrenheit?: number | undefined
6870
- /** Temperature to which the thermostat should heat (in °F). */
6871
- heating_set_point_fahrenheit?: number | undefined
6872
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
6873
- manual_override_allowed: boolean
6874
- }>
6875
- | undefined
6876
- fallback_climate_preset_key?: (string | null) | undefined
6877
- active_thermostat_schedule?:
6878
- | ({
6879
- /** ID of the climate schedule. */
6880
- thermostat_schedule_id: string
6881
- /** ID of the desired thermostat device. */
6882
- device_id: string
6883
- /** User-friendly name to identify the climate schedule. */
6884
- name?: string | undefined
6885
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
6886
- climate_preset_key: string
6887
- /** 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-climate-schedules#specifying-manual-override-permissions). */
6888
- max_override_period_minutes: number
6889
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
6890
- starts_at: string
6891
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
6892
- ends_at: string
6893
- /** Date and time at which the climate schedule was created. */
6894
- created_at: string
6895
- /** Array of errors associated with the climate 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. */
6896
- errors?: any
6897
- } | null)
6898
- | undefined
6899
- min_cooling_set_point_celsius?: number | undefined
6900
- min_cooling_set_point_fahrenheit?: number | undefined
6901
- max_cooling_set_point_celsius?: number | undefined
6902
- max_cooling_set_point_fahrenheit?: number | undefined
6903
- min_heating_set_point_celsius?: number | undefined
6904
- min_heating_set_point_fahrenheit?: number | undefined
6905
- max_heating_set_point_celsius?: number | undefined
6906
- max_heating_set_point_fahrenheit?: number | undefined
6907
- min_heating_cooling_delta_celsius?: number | undefined
6908
- min_heating_cooling_delta_fahrenheit?: number | undefined
6909
- temperature_threshold?:
6910
- | (
6911
- | {
6912
- lower_limit_celsius: number | null
6913
- lower_limit_fahrenheit: number | null
6914
- upper_limit_celsius: number | null
6915
- upper_limit_fahrenheit: number | null
6916
- }
6917
- | undefined
6918
- )
6919
- | undefined
6920
- })
6921
- /** Location information for the device. */
6922
- location: {
6923
- /** Name of the device location. */
6924
- location_name?: string | undefined
6925
- /** Time zone of the device location. */
6926
- timezone?: string | undefined
6927
- } | null
6928
- /** Unique identifier for the account associated with the device. */
6929
- connected_account_id: string
6930
- /** Unique identifier for the Seam workspace associated with the device. */
6931
- workspace_id: string
6932
- /** Array of errors associated with the device. 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. */
6933
- errors: Array<
6934
- | {
6935
- message: string
6936
- is_device_error: true
6937
- error_code: string
6938
- }
6939
- | {
6940
- message: string
6941
- is_connected_account_error: true
6942
- error_code: string
6943
- }
6944
- >
6945
- /** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
6946
- warnings: Array<{
6947
- message: string
6948
- warning_code: string
6949
- }>
6950
- /** Date and time at which the device object was created. */
6951
- created_at: string
6952
- /** Indicates whether Seam manages the device. */
6953
- is_managed: true
6954
- custom_metadata: Record<string, string | boolean>
6955
- can_remotely_unlock?: boolean | undefined
6956
- can_remotely_lock?: boolean | undefined
6957
- can_program_offline_access_codes?: boolean | undefined
6958
- can_program_online_access_codes?: boolean | undefined
6959
- can_hvac_heat?: boolean | undefined
6960
- can_hvac_cool?: boolean | undefined
6961
- can_hvac_heat_cool?: boolean | undefined
6962
- can_turn_off_hvac?: boolean | undefined
6963
- can_simulate_removal?: boolean | undefined
6964
- can_simulate_connection?: boolean | undefined
6965
- can_simulate_disconnection?: boolean | undefined
6966
6299
  }>
6967
6300
  }
6968
6301
  }
@@ -6974,8 +6307,8 @@ export interface Routes {
6974
6307
  commonParams: {
6975
6308
  /** ID of the acs_system the encoder belongs to. */
6976
6309
  acs_system_id: string
6977
- /** ID of the encoder to use for the scan. */
6978
- device_id: string
6310
+ /** ID of the acs_encoder to use for the scan. */
6311
+ acs_encoder_id: string
6979
6312
  }
6980
6313
  formData: {}
6981
6314
  jsonResponse: {
@@ -12176,25 +11509,26 @@ export interface Routes {
12176
11509
  }>
12177
11510
  | undefined
12178
11511
  fallback_climate_preset_key?: (string | null) | undefined
11512
+ /** 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. */
12179
11513
  active_thermostat_schedule?:
12180
11514
  | ({
12181
- /** ID of the climate schedule. */
11515
+ /** ID of the thermostat schedule. */
12182
11516
  thermostat_schedule_id: string
12183
11517
  /** ID of the desired thermostat device. */
12184
11518
  device_id: string
12185
- /** User-friendly name to identify the climate schedule. */
11519
+ /** User-friendly name to identify the thermostat schedule. */
12186
11520
  name?: string | undefined
12187
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
11521
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
12188
11522
  climate_preset_key: string
12189
- /** 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-climate-schedules#specifying-manual-override-permissions). */
11523
+ /** 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). */
12190
11524
  max_override_period_minutes: number
12191
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11525
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12192
11526
  starts_at: string
12193
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11527
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12194
11528
  ends_at: string
12195
- /** Date and time at which the climate schedule was created. */
11529
+ /** Date and time at which the thermostat schedule was created. */
12196
11530
  created_at: string
12197
- /** Array of errors associated with the climate 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. */
11531
+ /** 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. */
12198
11532
  errors?: any
12199
11533
  } | null)
12200
11534
  | undefined
@@ -13049,25 +12383,26 @@ export interface Routes {
13049
12383
  }>
13050
12384
  | undefined
13051
12385
  fallback_climate_preset_key?: (string | null) | undefined
12386
+ /** 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. */
13052
12387
  active_thermostat_schedule?:
13053
12388
  | ({
13054
- /** ID of the climate schedule. */
12389
+ /** ID of the thermostat schedule. */
13055
12390
  thermostat_schedule_id: string
13056
12391
  /** ID of the desired thermostat device. */
13057
12392
  device_id: string
13058
- /** User-friendly name to identify the climate schedule. */
12393
+ /** User-friendly name to identify the thermostat schedule. */
13059
12394
  name?: string | undefined
13060
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
12395
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
13061
12396
  climate_preset_key: string
13062
- /** 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-climate-schedules#specifying-manual-override-permissions). */
12397
+ /** 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). */
13063
12398
  max_override_period_minutes: number
13064
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12399
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
13065
12400
  starts_at: string
13066
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12401
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
13067
12402
  ends_at: string
13068
- /** Date and time at which the climate schedule was created. */
12403
+ /** Date and time at which the thermostat schedule was created. */
13069
12404
  created_at: string
13070
- /** Array of errors associated with the climate 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. */
12405
+ /** 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. */
13071
12406
  errors?: any
13072
12407
  } | null)
13073
12408
  | undefined
@@ -14637,25 +13972,26 @@ export interface Routes {
14637
13972
  }>
14638
13973
  | undefined
14639
13974
  fallback_climate_preset_key?: (string | null) | undefined
13975
+ /** 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. */
14640
13976
  active_thermostat_schedule?:
14641
13977
  | ({
14642
- /** ID of the climate schedule. */
13978
+ /** ID of the thermostat schedule. */
14643
13979
  thermostat_schedule_id: string
14644
13980
  /** ID of the desired thermostat device. */
14645
13981
  device_id: string
14646
- /** User-friendly name to identify the climate schedule. */
13982
+ /** User-friendly name to identify the thermostat schedule. */
14647
13983
  name?: string | undefined
14648
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
13984
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
14649
13985
  climate_preset_key: string
14650
- /** 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-climate-schedules#specifying-manual-override-permissions). */
13986
+ /** 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). */
14651
13987
  max_override_period_minutes: number
14652
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
13988
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
14653
13989
  starts_at: string
14654
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
13990
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
14655
13991
  ends_at: string
14656
- /** Date and time at which the climate schedule was created. */
13992
+ /** Date and time at which the thermostat schedule was created. */
14657
13993
  created_at: string
14658
- /** Array of errors associated with the climate 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. */
13994
+ /** 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. */
14659
13995
  errors?: any
14660
13996
  } | null)
14661
13997
  | undefined
@@ -15327,25 +14663,26 @@ export interface Routes {
15327
14663
  }>
15328
14664
  | undefined
15329
14665
  fallback_climate_preset_key?: (string | null) | undefined
14666
+ /** 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. */
15330
14667
  active_thermostat_schedule?:
15331
14668
  | ({
15332
- /** ID of the climate schedule. */
14669
+ /** ID of the thermostat schedule. */
15333
14670
  thermostat_schedule_id: string
15334
14671
  /** ID of the desired thermostat device. */
15335
14672
  device_id: string
15336
- /** User-friendly name to identify the climate schedule. */
14673
+ /** User-friendly name to identify the thermostat schedule. */
15337
14674
  name?: string | undefined
15338
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
14675
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
15339
14676
  climate_preset_key: string
15340
- /** 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-climate-schedules#specifying-manual-override-permissions). */
14677
+ /** 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). */
15341
14678
  max_override_period_minutes: number
15342
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
14679
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15343
14680
  starts_at: string
15344
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
14681
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15345
14682
  ends_at: string
15346
- /** Date and time at which the climate schedule was created. */
14683
+ /** Date and time at which the thermostat schedule was created. */
15347
14684
  created_at: string
15348
- /** Array of errors associated with the climate 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. */
14685
+ /** 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. */
15349
14686
  errors?: any
15350
14687
  } | null)
15351
14688
  | undefined
@@ -16200,25 +15537,26 @@ export interface Routes {
16200
15537
  }>
16201
15538
  | undefined
16202
15539
  fallback_climate_preset_key?: (string | null) | undefined
15540
+ /** 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. */
16203
15541
  active_thermostat_schedule?:
16204
15542
  | ({
16205
- /** ID of the climate schedule. */
15543
+ /** ID of the thermostat schedule. */
16206
15544
  thermostat_schedule_id: string
16207
15545
  /** ID of the desired thermostat device. */
16208
15546
  device_id: string
16209
- /** User-friendly name to identify the climate schedule. */
15547
+ /** User-friendly name to identify the thermostat schedule. */
16210
15548
  name?: string | undefined
16211
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
15549
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
16212
15550
  climate_preset_key: string
16213
- /** 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-climate-schedules#specifying-manual-override-permissions). */
15551
+ /** 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). */
16214
15552
  max_override_period_minutes: number
16215
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15553
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
16216
15554
  starts_at: string
16217
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15555
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
16218
15556
  ends_at: string
16219
- /** Date and time at which the climate schedule was created. */
15557
+ /** Date and time at which the thermostat schedule was created. */
16220
15558
  created_at: string
16221
- /** Array of errors associated with the climate 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. */
15559
+ /** 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. */
16222
15560
  errors?: any
16223
15561
  } | null)
16224
15562
  | undefined
@@ -16890,25 +16228,26 @@ export interface Routes {
16890
16228
  }>
16891
16229
  | undefined
16892
16230
  fallback_climate_preset_key?: (string | null) | undefined
16231
+ /** 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. */
16893
16232
  active_thermostat_schedule?:
16894
16233
  | ({
16895
- /** ID of the climate schedule. */
16234
+ /** ID of the thermostat schedule. */
16896
16235
  thermostat_schedule_id: string
16897
16236
  /** ID of the desired thermostat device. */
16898
16237
  device_id: string
16899
- /** User-friendly name to identify the climate schedule. */
16238
+ /** User-friendly name to identify the thermostat schedule. */
16900
16239
  name?: string | undefined
16901
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
16240
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
16902
16241
  climate_preset_key: string
16903
- /** 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-climate-schedules#specifying-manual-override-permissions). */
16242
+ /** 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). */
16904
16243
  max_override_period_minutes: number
16905
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
16244
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
16906
16245
  starts_at: string
16907
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
16246
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
16908
16247
  ends_at: string
16909
- /** Date and time at which the climate schedule was created. */
16248
+ /** Date and time at which the thermostat schedule was created. */
16910
16249
  created_at: string
16911
- /** Array of errors associated with the climate 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. */
16250
+ /** 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. */
16912
16251
  errors?: any
16913
16252
  } | null)
16914
16253
  | undefined
@@ -19515,25 +18854,26 @@ export interface Routes {
19515
18854
  }>
19516
18855
  | undefined
19517
18856
  fallback_climate_preset_key?: (string | null) | undefined
18857
+ /** 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. */
19518
18858
  active_thermostat_schedule?:
19519
18859
  | ({
19520
- /** ID of the climate schedule. */
18860
+ /** ID of the thermostat schedule. */
19521
18861
  thermostat_schedule_id: string
19522
18862
  /** ID of the desired thermostat device. */
19523
18863
  device_id: string
19524
- /** User-friendly name to identify the climate schedule. */
18864
+ /** User-friendly name to identify the thermostat schedule. */
19525
18865
  name?: string | undefined
19526
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
18866
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
19527
18867
  climate_preset_key: string
19528
- /** 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-climate-schedules#specifying-manual-override-permissions). */
18868
+ /** 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). */
19529
18869
  max_override_period_minutes: number
19530
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
18870
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19531
18871
  starts_at: string
19532
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
18872
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19533
18873
  ends_at: string
19534
- /** Date and time at which the climate schedule was created. */
18874
+ /** Date and time at which the thermostat schedule was created. */
19535
18875
  created_at: string
19536
- /** Array of errors associated with the climate 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. */
18876
+ /** 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. */
19537
18877
  errors?: any
19538
18878
  } | null)
19539
18879
  | undefined
@@ -20205,25 +19545,26 @@ export interface Routes {
20205
19545
  }>
20206
19546
  | undefined
20207
19547
  fallback_climate_preset_key?: (string | null) | undefined
19548
+ /** 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. */
20208
19549
  active_thermostat_schedule?:
20209
19550
  | ({
20210
- /** ID of the climate schedule. */
19551
+ /** ID of the thermostat schedule. */
20211
19552
  thermostat_schedule_id: string
20212
19553
  /** ID of the desired thermostat device. */
20213
19554
  device_id: string
20214
- /** User-friendly name to identify the climate schedule. */
19555
+ /** User-friendly name to identify the thermostat schedule. */
20215
19556
  name?: string | undefined
20216
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
19557
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
20217
19558
  climate_preset_key: string
20218
- /** 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-climate-schedules#specifying-manual-override-permissions). */
19559
+ /** 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). */
20219
19560
  max_override_period_minutes: number
20220
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19561
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
20221
19562
  starts_at: string
20222
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19563
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
20223
19564
  ends_at: string
20224
- /** Date and time at which the climate schedule was created. */
19565
+ /** Date and time at which the thermostat schedule was created. */
20225
19566
  created_at: string
20226
- /** Array of errors associated with the climate 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. */
19567
+ /** 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. */
20227
19568
  errors?: any
20228
19569
  } | null)
20229
19570
  | undefined
@@ -25527,25 +24868,26 @@ export interface Routes {
25527
24868
  }>
25528
24869
  | undefined
25529
24870
  fallback_climate_preset_key?: (string | null) | undefined
24871
+ /** 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. */
25530
24872
  active_thermostat_schedule?:
25531
24873
  | ({
25532
- /** ID of the climate schedule. */
24874
+ /** ID of the thermostat schedule. */
25533
24875
  thermostat_schedule_id: string
25534
24876
  /** ID of the desired thermostat device. */
25535
24877
  device_id: string
25536
- /** User-friendly name to identify the climate schedule. */
24878
+ /** User-friendly name to identify the thermostat schedule. */
25537
24879
  name?: string | undefined
25538
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
24880
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
25539
24881
  climate_preset_key: string
25540
- /** 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-climate-schedules#specifying-manual-override-permissions). */
24882
+ /** 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). */
25541
24883
  max_override_period_minutes: number
25542
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
24884
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25543
24885
  starts_at: string
25544
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
24886
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25545
24887
  ends_at: string
25546
- /** Date and time at which the climate schedule was created. */
24888
+ /** Date and time at which the thermostat schedule was created. */
25547
24889
  created_at: string
25548
- /** Array of errors associated with the climate 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. */
24890
+ /** 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. */
25549
24891
  errors?: any
25550
24892
  } | null)
25551
24893
  | undefined
@@ -28134,25 +27476,26 @@ export interface Routes {
28134
27476
  }>
28135
27477
  | undefined
28136
27478
  fallback_climate_preset_key?: (string | null) | undefined
27479
+ /** 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. */
28137
27480
  active_thermostat_schedule?:
28138
27481
  | ({
28139
- /** ID of the climate schedule. */
27482
+ /** ID of the thermostat schedule. */
28140
27483
  thermostat_schedule_id: string
28141
27484
  /** ID of the desired thermostat device. */
28142
27485
  device_id: string
28143
- /** User-friendly name to identify the climate schedule. */
27486
+ /** User-friendly name to identify the thermostat schedule. */
28144
27487
  name?: string | undefined
28145
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
27488
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
28146
27489
  climate_preset_key: string
28147
- /** 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-climate-schedules#specifying-manual-override-permissions). */
27490
+ /** 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). */
28148
27491
  max_override_period_minutes: number
28149
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
27492
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
28150
27493
  starts_at: string
28151
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
27494
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
28152
27495
  ends_at: string
28153
- /** Date and time at which the climate schedule was created. */
27496
+ /** Date and time at which the thermostat schedule was created. */
28154
27497
  created_at: string
28155
- /** Array of errors associated with the climate 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. */
27498
+ /** 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. */
28156
27499
  errors?: any
28157
27500
  } | null)
28158
27501
  | undefined
@@ -28824,25 +28167,26 @@ export interface Routes {
28824
28167
  }>
28825
28168
  | undefined
28826
28169
  fallback_climate_preset_key?: (string | null) | undefined
28170
+ /** 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. */
28827
28171
  active_thermostat_schedule?:
28828
28172
  | ({
28829
- /** ID of the climate schedule. */
28173
+ /** ID of the thermostat schedule. */
28830
28174
  thermostat_schedule_id: string
28831
28175
  /** ID of the desired thermostat device. */
28832
28176
  device_id: string
28833
- /** User-friendly name to identify the climate schedule. */
28177
+ /** User-friendly name to identify the thermostat schedule. */
28834
28178
  name?: string | undefined
28835
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
28179
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
28836
28180
  climate_preset_key: string
28837
- /** 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-climate-schedules#specifying-manual-override-permissions). */
28181
+ /** 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). */
28838
28182
  max_override_period_minutes: number
28839
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
28183
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
28840
28184
  starts_at: string
28841
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
28185
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
28842
28186
  ends_at: string
28843
- /** Date and time at which the climate schedule was created. */
28187
+ /** Date and time at which the thermostat schedule was created. */
28844
28188
  created_at: string
28845
- /** Array of errors associated with the climate 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. */
28189
+ /** 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. */
28846
28190
  errors?: any
28847
28191
  } | null)
28848
28192
  | undefined
@@ -29784,38 +29128,39 @@ export interface Routes {
29784
29128
  jsonBody: {
29785
29129
  /** ID of the desired thermostat device. */
29786
29130
  device_id: string
29787
- /** User-friendly name to identify the climate schedule. */
29131
+ /** User-friendly name to identify the thermostat schedule. */
29788
29132
  name?: string | undefined
29789
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
29133
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
29790
29134
  climate_preset_key: string
29791
- /** 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-climate-schedules#specifying-manual-override-permissions). */
29135
+ /** 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). */
29792
29136
  max_override_period_minutes?: number
29793
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29137
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29794
29138
  starts_at: string
29795
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29139
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29796
29140
  ends_at: string
29797
29141
  }
29798
29142
  commonParams: {}
29799
29143
  formData: {}
29800
29144
  jsonResponse: {
29145
+ /** 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. */
29801
29146
  thermostat_schedule: {
29802
- /** ID of the climate schedule. */
29147
+ /** ID of the thermostat schedule. */
29803
29148
  thermostat_schedule_id: string
29804
29149
  /** ID of the desired thermostat device. */
29805
29150
  device_id: string
29806
- /** User-friendly name to identify the climate schedule. */
29151
+ /** User-friendly name to identify the thermostat schedule. */
29807
29152
  name?: string | undefined
29808
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
29153
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
29809
29154
  climate_preset_key: string
29810
- /** 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-climate-schedules#specifying-manual-override-permissions). */
29155
+ /** 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). */
29811
29156
  max_override_period_minutes: number
29812
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29157
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29813
29158
  starts_at: string
29814
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29159
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29815
29160
  ends_at: string
29816
- /** Date and time at which the climate schedule was created. */
29161
+ /** Date and time at which the thermostat schedule was created. */
29817
29162
  created_at: string
29818
- /** Array of errors associated with the climate 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. */
29163
+ /** 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. */
29819
29164
  errors?: any
29820
29165
  }
29821
29166
  }
@@ -29826,7 +29171,7 @@ export interface Routes {
29826
29171
  queryParams: {}
29827
29172
  jsonBody: {}
29828
29173
  commonParams: {
29829
- /** ID of the desired climate schedule. */
29174
+ /** ID of the desired thermostat schedule. */
29830
29175
  thermostat_schedule_id: string
29831
29176
  }
29832
29177
  formData: {}
@@ -29838,29 +29183,30 @@ export interface Routes {
29838
29183
  queryParams: {}
29839
29184
  jsonBody: {}
29840
29185
  commonParams: {
29841
- /** ID of the desired climate schedule. */
29186
+ /** ID of the desired thermostat schedule. */
29842
29187
  thermostat_schedule_id: string
29843
29188
  }
29844
29189
  formData: {}
29845
29190
  jsonResponse: {
29191
+ /** 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. */
29846
29192
  thermostat_schedule: {
29847
- /** ID of the climate schedule. */
29193
+ /** ID of the thermostat schedule. */
29848
29194
  thermostat_schedule_id: string
29849
29195
  /** ID of the desired thermostat device. */
29850
29196
  device_id: string
29851
- /** User-friendly name to identify the climate schedule. */
29197
+ /** User-friendly name to identify the thermostat schedule. */
29852
29198
  name?: string | undefined
29853
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
29199
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
29854
29200
  climate_preset_key: string
29855
- /** 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-climate-schedules#specifying-manual-override-permissions). */
29201
+ /** 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). */
29856
29202
  max_override_period_minutes: number
29857
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29203
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29858
29204
  starts_at: string
29859
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29205
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29860
29206
  ends_at: string
29861
- /** Date and time at which the climate schedule was created. */
29207
+ /** Date and time at which the thermostat schedule was created. */
29862
29208
  created_at: string
29863
- /** Array of errors associated with the climate 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. */
29209
+ /** 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. */
29864
29210
  errors?: any
29865
29211
  }
29866
29212
  }
@@ -29873,29 +29219,29 @@ export interface Routes {
29873
29219
  commonParams: {
29874
29220
  /** ID of the desired thermostat device. */
29875
29221
  device_id: string
29876
- /** User identifier key by which to filter the list of returned climate schedules. */
29222
+ /** User identifier key by which to filter the list of returned thermostat schedules. */
29877
29223
  user_identifier_key?: string | undefined
29878
29224
  }
29879
29225
  formData: {}
29880
29226
  jsonResponse: {
29881
29227
  thermostat_schedules: Array<{
29882
- /** ID of the climate schedule. */
29228
+ /** ID of the thermostat schedule. */
29883
29229
  thermostat_schedule_id: string
29884
29230
  /** ID of the desired thermostat device. */
29885
29231
  device_id: string
29886
- /** User-friendly name to identify the climate schedule. */
29232
+ /** User-friendly name to identify the thermostat schedule. */
29887
29233
  name?: string | undefined
29888
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
29234
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
29889
29235
  climate_preset_key: string
29890
- /** 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-climate-schedules#specifying-manual-override-permissions). */
29236
+ /** 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). */
29891
29237
  max_override_period_minutes: number
29892
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29238
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29893
29239
  starts_at: string
29894
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29240
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29895
29241
  ends_at: string
29896
- /** Date and time at which the climate schedule was created. */
29242
+ /** Date and time at which the thermostat schedule was created. */
29897
29243
  created_at: string
29898
- /** Array of errors associated with the climate 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. */
29244
+ /** 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. */
29899
29245
  errors?: any
29900
29246
  }>
29901
29247
  }
@@ -29905,17 +29251,17 @@ export interface Routes {
29905
29251
  method: 'PATCH' | 'POST'
29906
29252
  queryParams: {}
29907
29253
  jsonBody: {
29908
- /** ID of the desired climate schedule. */
29254
+ /** ID of the desired thermostat schedule. */
29909
29255
  thermostat_schedule_id: string
29910
- /** User-friendly name to identify the climate schedule. */
29256
+ /** User-friendly name to identify the thermostat schedule. */
29911
29257
  name?: string | undefined
29912
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
29258
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
29913
29259
  climate_preset_key?: string | undefined
29914
- /** 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-climate-schedules#specifying-manual-override-permissions). */
29260
+ /** 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). */
29915
29261
  max_override_period_minutes?: number | undefined
29916
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29262
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29917
29263
  starts_at?: string | undefined
29918
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29264
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
29919
29265
  ends_at?: string | undefined
29920
29266
  }
29921
29267
  commonParams: {}
@@ -31642,25 +30988,26 @@ export interface Routes {
31642
30988
  }>
31643
30989
  | undefined
31644
30990
  fallback_climate_preset_key?: (string | null) | undefined
30991
+ /** 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. */
31645
30992
  active_thermostat_schedule?:
31646
30993
  | ({
31647
- /** ID of the climate schedule. */
30994
+ /** ID of the thermostat schedule. */
31648
30995
  thermostat_schedule_id: string
31649
30996
  /** ID of the desired thermostat device. */
31650
30997
  device_id: string
31651
- /** User-friendly name to identify the climate schedule. */
30998
+ /** User-friendly name to identify the thermostat schedule. */
31652
30999
  name?: string | undefined
31653
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
31000
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
31654
31001
  climate_preset_key: string
31655
- /** 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-climate-schedules#specifying-manual-override-permissions). */
31002
+ /** 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). */
31656
31003
  max_override_period_minutes: number
31657
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
31004
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
31658
31005
  starts_at: string
31659
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
31006
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
31660
31007
  ends_at: string
31661
- /** Date and time at which the climate schedule was created. */
31008
+ /** Date and time at which the thermostat schedule was created. */
31662
31009
  created_at: string
31663
- /** Array of errors associated with the climate 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. */
31010
+ /** 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. */
31664
31011
  errors?: any
31665
31012
  } | null)
31666
31013
  | undefined
@@ -32334,25 +31681,26 @@ export interface Routes {
32334
31681
  }>
32335
31682
  | undefined
32336
31683
  fallback_climate_preset_key?: (string | null) | undefined
31684
+ /** 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. */
32337
31685
  active_thermostat_schedule?:
32338
31686
  | ({
32339
- /** ID of the climate schedule. */
31687
+ /** ID of the thermostat schedule. */
32340
31688
  thermostat_schedule_id: string
32341
31689
  /** ID of the desired thermostat device. */
32342
31690
  device_id: string
32343
- /** User-friendly name to identify the climate schedule. */
31691
+ /** User-friendly name to identify the thermostat schedule. */
32344
31692
  name?: string | undefined
32345
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
31693
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
32346
31694
  climate_preset_key: string
32347
- /** 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-climate-schedules#specifying-manual-override-permissions). */
31695
+ /** 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). */
32348
31696
  max_override_period_minutes: number
32349
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
31697
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
32350
31698
  starts_at: string
32351
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
31699
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
32352
31700
  ends_at: string
32353
- /** Date and time at which the climate schedule was created. */
31701
+ /** Date and time at which the thermostat schedule was created. */
32354
31702
  created_at: string
32355
- /** Array of errors associated with the climate 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. */
31703
+ /** 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. */
32356
31704
  errors?: any
32357
31705
  } | null)
32358
31706
  | undefined