@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.
@@ -4673,8 +4673,8 @@ export interface Routes {
4673
4673
  queryParams: {};
4674
4674
  jsonBody: {};
4675
4675
  commonParams: {
4676
- /** ID of the encoder to use for the encoding. */
4677
- device_id: string;
4676
+ /** ID of the acs_encoder to use for the encoding. */
4677
+ acs_encoder_id: string;
4678
4678
  /** ID of the acs_credential to encode on a physical card. */
4679
4679
  acs_credential_id: string;
4680
4680
  };
@@ -5409,10 +5409,10 @@ export interface Routes {
5409
5409
  jsonBody: {};
5410
5410
  commonParams: {
5411
5411
  acs_system_ids: string[];
5412
- device_ids: string[];
5412
+ acs_encoder_ids: string[];
5413
5413
  limit?: number;
5414
5414
  } | {
5415
- device_ids: string[];
5415
+ acs_encoder_ids: string[];
5416
5416
  limit?: number;
5417
5417
  } | {
5418
5418
  acs_system_ids: string[];
@@ -5420,512 +5420,28 @@ export interface Routes {
5420
5420
  };
5421
5421
  formData: {};
5422
5422
  jsonResponse: {
5423
- devices: Array<{
5424
- /** Unique identifier for the device. */
5425
- device_id: string;
5426
- /** Type of the device. */
5427
- device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | ('visionline_encoder' | 'assa_abloy_vostio_encoder');
5428
- /** Optional nickname to describe the device, settable through Seam */
5429
- nickname?: string | undefined;
5430
- /** 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. */
5431
- display_name: string;
5432
- /** 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. */
5433
- capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
5434
- /** Properties of the device. */
5435
- properties: (({
5436
- /** Indicates whether the device is online. */
5437
- online: boolean;
5438
- /** Name of the device.
5439
- * @deprecated use device.display_name instead */
5440
- name: string;
5441
- /** Represents the accessory keypad state. */
5442
- accessory_keypad?: {
5443
- /** Indicates if the accessory_keypad is connected to the device. */
5444
- is_connected: boolean;
5445
- /** Indicates if the keypad battery properties. */
5446
- battery?: {
5447
- level: number;
5448
- } | undefined;
5449
- } | undefined;
5450
- appearance: {
5451
- /** Name of the device as seen from the provider API and application, not settable through Seam. */
5452
- name: string;
5453
- };
5454
- model: {
5455
- /** Indicates whether the device can connect a accessory keypad. */
5456
- can_connect_accessory_keypad?: boolean | undefined;
5457
- /** Display name of the device model. */
5458
- display_name: string;
5459
- /** Display name that corresponds to the manufacturer-specific terminology for the device. */
5460
- manufacturer_display_name: string;
5461
- /** Indicates whether the device has a built in accessory keypad. */
5462
- has_built_in_keypad?: boolean | undefined;
5463
- /** Indicates whether the device supports offline access codes. */
5464
- offline_access_codes_supported?: boolean | undefined;
5465
- /** Indicates whether the device supports online access codes. */
5466
- online_access_codes_supported?: boolean | undefined;
5467
- /**
5468
- * @deprecated use device.properties.model.can_connect_accessory_keypad */
5469
- accessory_keypad_supported?: boolean | undefined;
5470
- };
5471
- /** Indicates whether the device has direct power. */
5472
- has_direct_power?: boolean | undefined;
5473
- /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
5474
- battery_level?: number | undefined;
5475
- /** 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. */
5476
- battery?: {
5477
- level: number;
5478
- status: 'critical' | 'low' | 'good' | 'full';
5479
- } | undefined;
5480
- /** Manufacturer of the device. */
5481
- manufacturer?: string | undefined;
5482
- /** Image URL for the device. */
5483
- image_url?: string | undefined;
5484
- /** Alt text for the device image. */
5485
- image_alt_text?: string | undefined;
5486
- /** Serial number of the device. */
5487
- serial_number?: string | undefined;
5488
- /** Indicates whether it is currently possible to use online access codes for the device. */
5489
- online_access_codes_enabled?: boolean | undefined;
5490
- /** Indicates whether it is currently possible to use offline access codes for the device. */
5491
- offline_access_codes_enabled?: boolean | undefined;
5492
- /**
5493
- * @deprecated use device.properties.model.can_connect_accessory_keypad */
5494
- supports_accessory_keypad?: boolean | undefined;
5495
- /**
5496
- * @deprecated use offline_access_codes_enabled */
5497
- supports_offline_access_codes?: boolean | undefined;
5498
- /** Indicates current noise level in decibels, if the device supports noise detection. */
5499
- noise_level_decibels?: number | undefined;
5500
- /** Array of noise threshold IDs that are currently triggering. */
5501
- currently_triggering_noise_threshold_ids?: string[] | undefined;
5502
- } & {
5503
- assa_abloy_credential_service_metadata?: ({
5504
- has_active_endpoint: boolean;
5505
- endpoints: Array<{
5506
- endpoint_id: string;
5507
- is_active: boolean;
5508
- }>;
5509
- } | undefined) | undefined;
5510
- }) & {
5511
- august_metadata?: {
5512
- lock_id: string;
5513
- lock_name: string;
5514
- house_name: string;
5515
- has_keypad: boolean;
5516
- keypad_battery_level?: string | undefined;
5517
- model?: string | undefined;
5518
- house_id?: string | undefined;
5519
- } | undefined;
5520
- avigilon_alta_metadata?: {
5521
- entry_name: string;
5522
- org_name: string;
5523
- zone_id: number;
5524
- zone_name: string;
5525
- site_id: number;
5526
- site_name: string;
5527
- entry_relays_total_count: number;
5528
- } | undefined;
5529
- schlage_metadata?: {
5530
- device_id: string;
5531
- device_name: string;
5532
- access_code_length: number | null;
5533
- model?: string | undefined;
5534
- } | undefined;
5535
- smartthings_metadata?: {
5536
- device_id: string;
5537
- device_name: string;
5538
- model?: string | undefined;
5539
- location_id?: string | undefined;
5540
- } | undefined;
5541
- lockly_metadata?: {
5542
- device_id: string;
5543
- device_name: string;
5544
- model?: string | undefined;
5545
- } | undefined;
5546
- nuki_metadata?: {
5547
- device_id: string;
5548
- device_name: string;
5549
- keypad_battery_critical?: boolean | undefined;
5550
- keypad_paired?: boolean | undefined;
5551
- keypad_2_paired?: boolean | undefined;
5552
- } | undefined;
5553
- kwikset_metadata?: {
5554
- device_id: string;
5555
- device_name: string;
5556
- model_number: string;
5557
- } | undefined;
5558
- /**
5559
- ---
5560
- deprecated: Use `salto_ks_metadata ` instead.
5561
- */
5562
- salto_metadata?: {
5563
- lock_id: string;
5564
- customer_reference: string;
5565
- lock_type: string;
5566
- battery_level: string;
5567
- locked_state: string;
5568
- model?: string | undefined;
5569
- } | undefined;
5570
- salto_ks_metadata?: {
5571
- lock_id: string;
5572
- customer_reference: string;
5573
- lock_type: string;
5574
- battery_level: string;
5575
- locked_state: string;
5576
- model?: string | undefined;
5577
- } | undefined;
5578
- genie_metadata?: {
5579
- device_name: string;
5580
- door_name: string;
5581
- } | undefined;
5582
- brivo_metadata?: {
5583
- device_name: string;
5584
- } | undefined;
5585
- igloo_metadata?: {
5586
- device_id: string;
5587
- bridge_id: string;
5588
- model?: string | undefined;
5589
- } | undefined;
5590
- noiseaware_metadata?: {
5591
- device_model: 'indoor' | 'outdoor';
5592
- noise_level_nrs: number;
5593
- noise_level_decibel: number;
5594
- device_name: string;
5595
- device_id: string;
5596
- } | undefined;
5597
- minut_metadata?: {
5598
- device_id: string;
5599
- device_name: string;
5600
- latest_sensor_values: {
5601
- temperature: {
5602
- time: string;
5603
- value: number;
5604
- };
5605
- sound: {
5606
- time: string;
5607
- value: number;
5608
- };
5609
- humidity: {
5610
- time: string;
5611
- value: number;
5612
- };
5613
- pressure: {
5614
- time: string;
5615
- value: number;
5616
- };
5617
- accelerometer_z: {
5618
- time: string;
5619
- value: number;
5620
- };
5621
- };
5622
- } | undefined;
5623
- four_suites_metadata?: {
5624
- device_id: number;
5625
- device_name: string;
5626
- reclose_delay_in_seconds: number;
5627
- } | undefined;
5628
- two_n_metadata?: {
5629
- device_id: number;
5630
- device_name: string;
5631
- } | undefined;
5632
- controlbyweb_metadata?: {
5633
- device_id: string;
5634
- device_name: string;
5635
- relay_name: string | null;
5636
- } | undefined;
5637
- ttlock_metadata?: {
5638
- lock_id: number;
5639
- lock_alias: string;
5640
- feature_value: string;
5641
- features: {
5642
- passcode: boolean;
5643
- passcode_management: boolean;
5644
- unlock_via_gateway: boolean;
5645
- lock_command: boolean;
5646
- incomplete_keyboard_passcode: boolean;
5647
- };
5648
- has_gateway?: boolean | undefined;
5649
- wireless_keypads?: Array<{
5650
- wireless_keypad_id: number;
5651
- wireless_keypad_name: string;
5652
- }> | undefined;
5653
- } | undefined;
5654
- seam_bridge_metadata?: {
5655
- unlock_method?: ('bridge' | 'doorking') | undefined;
5656
- device_num: number;
5657
- name: string;
5658
- } | undefined;
5659
- igloohome_metadata?: {
5660
- device_id: string;
5661
- device_name: string;
5662
- bridge_id?: string | undefined;
5663
- bridge_name?: string | undefined;
5664
- keypad_id?: string | undefined;
5665
- } | undefined;
5666
- nest_metadata?: {
5667
- nest_device_id: string;
5668
- device_name: string;
5669
- custom_name: string;
5670
- display_name?: string | undefined;
5671
- } | undefined;
5672
- ecobee_metadata?: {
5673
- ecobee_device_id: string;
5674
- device_name: string;
5675
- } | undefined;
5676
- honeywell_resideo_metadata?: {
5677
- honeywell_resideo_device_id: string;
5678
- device_name: string;
5679
- } | undefined;
5680
- hubitat_metadata?: {
5681
- device_id: string;
5682
- device_name: string;
5683
- device_label: string;
5684
- } | undefined;
5685
- dormakaba_oracode_metadata?: {
5686
- door_id?: number | undefined;
5687
- door_name: string;
5688
- device_id?: (number | string) | undefined;
5689
- door_is_wireless: boolean;
5690
- /** @DEPRECATED */
5691
- site_id: number | null;
5692
- site_name: string;
5693
- iana_timezone?: string | undefined;
5694
- predefined_time_slots?: Array<{
5695
- name: string;
5696
- prefix: number;
5697
- check_in_time: string;
5698
- check_out_time: string;
5699
- is_24_hour: boolean;
5700
- is_biweekly_mode: boolean;
5701
- is_one_shot: boolean;
5702
- is_master: boolean;
5703
- ext_dormakaba_oracode_user_level_prefix: number;
5704
- dormakaba_oracode_user_level_id: string;
5705
- }> | undefined;
5706
- } | undefined;
5707
- wyze_metadata?: {
5708
- device_id: string;
5709
- device_name: string;
5710
- product_name: string;
5711
- product_type: string;
5712
- product_model: string;
5713
- device_info_model: string;
5714
- keypad_uuid?: string | undefined;
5715
- locker_status_hardlock?: number | undefined;
5716
- } | undefined;
5717
- tedee_metadata?: {
5718
- device_id: number;
5719
- serial_number: string;
5720
- device_name: string;
5721
- device_model: string;
5722
- bridge_id: number;
5723
- bridge_name: string;
5724
- keypad_id?: number | undefined;
5725
- } | undefined;
5726
- visionline_metadata?: {
5727
- encoder_id: string;
5728
- } | undefined;
5729
- akiles_metadata?: {
5730
- gadget_name: string;
5731
- gadget_id: string;
5732
- product_name: string;
5733
- _member_group_id?: string | undefined;
5734
- } | undefined;
5735
- assa_abloy_vostio_metadata?: {
5736
- encoder_name: string;
5737
- } | undefined;
5738
- }) & ({
5739
- _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
5740
- code_constraints?: (Array<{
5741
- constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
5742
- } | {
5743
- constraint_type: 'name_length' | 'name_must_be_unique';
5744
- min_length?: number | undefined;
5745
- max_length?: number | undefined;
5746
- }> | undefined) | undefined;
5747
- supported_code_lengths?: (number[] | undefined) | undefined;
5748
- max_active_codes_supported?: (number | undefined) | undefined;
5749
- supports_backup_access_code_pool?: (boolean | undefined) | undefined;
5750
- has_native_entry_events?: (boolean | undefined) | undefined;
5751
- locked?: (boolean | undefined) | undefined;
5752
- keypad_battery?: ({
5753
- level: number;
5754
- } | undefined) | undefined;
5755
- door_open?: (boolean | undefined) | undefined;
5756
- } & {
5757
- temperature_fahrenheit?: number | undefined;
5758
- temperature_celsius?: number | undefined;
5759
- relative_humidity?: number | undefined;
5760
- available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
5761
- available_fan_mode_settings?: Array<'auto' | 'on' | 'circulate'> | undefined;
5762
- is_heating?: boolean | undefined;
5763
- is_cooling?: boolean | undefined;
5764
- is_fan_running?: boolean | undefined;
5765
- /**
5766
- * @deprecated use current_climate_setting.fan_mode_setting instead. */
5767
- fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
5768
- is_temporary_manual_override_active?: boolean | undefined;
5769
- current_climate_setting?: {
5770
- /** Unique key to identify the climate preset. */
5771
- climate_preset_key?: string | undefined;
5772
- /** Indicates whether this climate preset key can be edited. */
5773
- can_edit?: boolean | undefined;
5774
- /** Indicates whether this climate preset key can be deleted. */
5775
- can_delete?: boolean | undefined;
5776
- /** User-friendly name to identify the climate preset. */
5777
- name?: ((string | null) | undefined) | undefined;
5778
- /** Display name for the climate preset. */
5779
- display_name?: string | undefined;
5780
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
5781
- fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
5782
- /** 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`. */
5783
- hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5784
- /** 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). */
5785
- cooling_set_point_celsius?: (number | undefined) | undefined;
5786
- /** Temperature to which the thermostat should heat (in °C). */
5787
- heating_set_point_celsius?: (number | undefined) | undefined;
5788
- /** Temperature to which the thermostat should cool (in °F). */
5789
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5790
- /** Temperature to which the thermostat should heat (in °F). */
5791
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
5792
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
5793
- manual_override_allowed?: boolean | undefined;
5794
- } | undefined;
5795
- /**
5796
- * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
5797
- default_climate_setting?: {
5798
- /** Unique key to identify the climate preset. */
5799
- climate_preset_key?: string | undefined;
5800
- /** Indicates whether this climate preset key can be edited. */
5801
- can_edit?: boolean | undefined;
5802
- /** Indicates whether this climate preset key can be deleted. */
5803
- can_delete?: boolean | undefined;
5804
- /** User-friendly name to identify the climate preset. */
5805
- name?: ((string | null) | undefined) | undefined;
5806
- /** Display name for the climate preset. */
5807
- display_name?: string | undefined;
5808
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
5809
- fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
5810
- /** 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`. */
5811
- hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
5812
- /** 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). */
5813
- cooling_set_point_celsius?: (number | undefined) | undefined;
5814
- /** Temperature to which the thermostat should heat (in °C). */
5815
- heating_set_point_celsius?: (number | undefined) | undefined;
5816
- /** Temperature to which the thermostat should cool (in °F). */
5817
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
5818
- /** Temperature to which the thermostat should heat (in °F). */
5819
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
5820
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
5821
- manual_override_allowed?: boolean | undefined;
5822
- } | undefined;
5823
- available_climate_presets?: Array<{
5824
- /** Unique key to identify the climate preset. */
5825
- climate_preset_key: string;
5826
- /** Indicates whether this climate preset key can be edited. */
5827
- can_edit: boolean;
5828
- /** Indicates whether this climate preset key can be deleted. */
5829
- can_delete: boolean;
5830
- /** User-friendly name to identify the climate preset. */
5831
- name?: (string | null) | undefined;
5832
- /** Display name for the climate preset. */
5833
- display_name: string;
5834
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
5835
- fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
5836
- /** 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`. */
5837
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
5838
- /** 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). */
5839
- cooling_set_point_celsius?: number | undefined;
5840
- /** Temperature to which the thermostat should heat (in °C). */
5841
- heating_set_point_celsius?: number | undefined;
5842
- /** Temperature to which the thermostat should cool (in °F). */
5843
- cooling_set_point_fahrenheit?: number | undefined;
5844
- /** Temperature to which the thermostat should heat (in °F). */
5845
- heating_set_point_fahrenheit?: number | undefined;
5846
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
5847
- manual_override_allowed: boolean;
5848
- }> | undefined;
5849
- fallback_climate_preset_key?: (string | null) | undefined;
5850
- active_thermostat_schedule?: ({
5851
- /** ID of the climate schedule. */
5852
- thermostat_schedule_id: string;
5853
- /** ID of the desired thermostat device. */
5854
- device_id: string;
5855
- /** User-friendly name to identify the climate schedule. */
5856
- name?: string | undefined;
5857
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
5858
- climate_preset_key: string;
5859
- /** 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). */
5860
- max_override_period_minutes: number;
5861
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
5862
- starts_at: string;
5863
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
5864
- ends_at: string;
5865
- /** Date and time at which the climate schedule was created. */
5866
- created_at: string;
5867
- /** 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. */
5868
- errors?: any;
5869
- } | null) | undefined;
5870
- min_cooling_set_point_celsius?: number | undefined;
5871
- min_cooling_set_point_fahrenheit?: number | undefined;
5872
- max_cooling_set_point_celsius?: number | undefined;
5873
- max_cooling_set_point_fahrenheit?: number | undefined;
5874
- min_heating_set_point_celsius?: number | undefined;
5875
- min_heating_set_point_fahrenheit?: number | undefined;
5876
- max_heating_set_point_celsius?: number | undefined;
5877
- max_heating_set_point_fahrenheit?: number | undefined;
5878
- min_heating_cooling_delta_celsius?: number | undefined;
5879
- min_heating_cooling_delta_fahrenheit?: number | undefined;
5880
- temperature_threshold?: ({
5881
- lower_limit_celsius: number | null;
5882
- lower_limit_fahrenheit: number | null;
5883
- upper_limit_celsius: number | null;
5884
- upper_limit_fahrenheit: number | null;
5885
- } | undefined) | undefined;
5886
- });
5887
- /** Location information for the device. */
5888
- location: {
5889
- /** Name of the device location. */
5890
- location_name?: string | undefined;
5891
- /** Time zone of the device location. */
5892
- timezone?: string | undefined;
5893
- } | null;
5894
- /** Unique identifier for the account associated with the device. */
5895
- connected_account_id: string;
5896
- /** Unique identifier for the Seam workspace associated with the device. */
5423
+ acs_encoders: Array<{
5424
+ /** ID of the `acs_encoder`. */
5425
+ acs_encoder_id: string;
5426
+ /** ID of the access control system that contains the `acs_encoder`. */
5427
+ acs_system_id: string;
5428
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
5897
5429
  workspace_id: string;
5898
- /** 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. */
5430
+ /** Errors associated with the `acs_encoder`. */
5899
5431
  errors: Array<{
5432
+ /** Date and time at which Seam created the error. */
5433
+ created_at: string;
5434
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5900
5435
  message: string;
5901
- is_device_error: true;
5902
- error_code: string;
5903
- } | {
5904
- message: string;
5905
- is_connected_account_error: true;
5906
- error_code: string;
5907
- }>;
5908
- /** 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. */
5909
- warnings: Array<{
5910
- message: string;
5911
- warning_code: string;
5436
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5437
+ error_code: 'acs_encoder_removed';
5438
+ /** ID of the event that was created when the `acs_encoder` was removed. */
5439
+ _event_id: string;
5912
5440
  }>;
5913
- /** Date and time at which the device object was created. */
5441
+ /** Date and time at which the `acs_encoder` was created. */
5914
5442
  created_at: string;
5915
- /** Indicates whether Seam manages the device. */
5916
- is_managed: true;
5917
- custom_metadata: Record<string, string | boolean>;
5918
- can_remotely_unlock?: boolean | undefined;
5919
- can_remotely_lock?: boolean | undefined;
5920
- can_program_offline_access_codes?: boolean | undefined;
5921
- can_program_online_access_codes?: boolean | undefined;
5922
- can_hvac_heat?: boolean | undefined;
5923
- can_hvac_cool?: boolean | undefined;
5924
- can_hvac_heat_cool?: boolean | undefined;
5925
- can_turn_off_hvac?: boolean | undefined;
5926
- can_simulate_removal?: boolean | undefined;
5927
- can_simulate_connection?: boolean | undefined;
5928
- can_simulate_disconnection?: boolean | undefined;
5443
+ /** Display name for the `acs_encoder`. */
5444
+ display_name: string;
5929
5445
  }>;
5930
5446
  };
5931
5447
  };
@@ -5937,8 +5453,8 @@ export interface Routes {
5937
5453
  commonParams: {
5938
5454
  /** ID of the acs_system the encoder belongs to. */
5939
5455
  acs_system_id: string;
5940
- /** ID of the encoder to use for the scan. */
5941
- device_id: string;
5456
+ /** ID of the acs_encoder to use for the scan. */
5457
+ acs_encoder_id: string;
5942
5458
  };
5943
5459
  formData: {};
5944
5460
  jsonResponse: {
@@ -10231,24 +9747,25 @@ export interface Routes {
10231
9747
  manual_override_allowed: boolean;
10232
9748
  }> | undefined;
10233
9749
  fallback_climate_preset_key?: (string | null) | undefined;
9750
+ /** 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. */
10234
9751
  active_thermostat_schedule?: ({
10235
- /** ID of the climate schedule. */
9752
+ /** ID of the thermostat schedule. */
10236
9753
  thermostat_schedule_id: string;
10237
9754
  /** ID of the desired thermostat device. */
10238
9755
  device_id: string;
10239
- /** User-friendly name to identify the climate schedule. */
9756
+ /** User-friendly name to identify the thermostat schedule. */
10240
9757
  name?: string | undefined;
10241
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
9758
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
10242
9759
  climate_preset_key: string;
10243
- /** 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). */
9760
+ /** 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). */
10244
9761
  max_override_period_minutes: number;
10245
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
9762
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10246
9763
  starts_at: string;
10247
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
9764
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10248
9765
  ends_at: string;
10249
- /** Date and time at which the climate schedule was created. */
9766
+ /** Date and time at which the thermostat schedule was created. */
10250
9767
  created_at: string;
10251
- /** 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. */
9768
+ /** 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. */
10252
9769
  errors?: any;
10253
9770
  } | null) | undefined;
10254
9771
  min_cooling_set_point_celsius?: number | undefined;
@@ -10775,24 +10292,25 @@ export interface Routes {
10775
10292
  manual_override_allowed: boolean;
10776
10293
  }> | undefined;
10777
10294
  fallback_climate_preset_key?: (string | null) | undefined;
10295
+ /** 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. */
10778
10296
  active_thermostat_schedule?: ({
10779
- /** ID of the climate schedule. */
10297
+ /** ID of the thermostat schedule. */
10780
10298
  thermostat_schedule_id: string;
10781
10299
  /** ID of the desired thermostat device. */
10782
10300
  device_id: string;
10783
- /** User-friendly name to identify the climate schedule. */
10301
+ /** User-friendly name to identify the thermostat schedule. */
10784
10302
  name?: string | undefined;
10785
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
10303
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
10786
10304
  climate_preset_key: string;
10787
- /** 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). */
10305
+ /** 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). */
10788
10306
  max_override_period_minutes: number;
10789
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10307
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10790
10308
  starts_at: string;
10791
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10309
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
10792
10310
  ends_at: string;
10793
- /** Date and time at which the climate schedule was created. */
10311
+ /** Date and time at which the thermostat schedule was created. */
10794
10312
  created_at: string;
10795
- /** 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. */
10313
+ /** 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. */
10796
10314
  errors?: any;
10797
10315
  } | null) | undefined;
10798
10316
  min_cooling_set_point_celsius?: number | undefined;
@@ -11722,24 +11240,25 @@ export interface Routes {
11722
11240
  manual_override_allowed: boolean;
11723
11241
  }> | undefined;
11724
11242
  fallback_climate_preset_key?: (string | null) | undefined;
11243
+ /** 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. */
11725
11244
  active_thermostat_schedule?: ({
11726
- /** ID of the climate schedule. */
11245
+ /** ID of the thermostat schedule. */
11727
11246
  thermostat_schedule_id: string;
11728
11247
  /** ID of the desired thermostat device. */
11729
11248
  device_id: string;
11730
- /** User-friendly name to identify the climate schedule. */
11249
+ /** User-friendly name to identify the thermostat schedule. */
11731
11250
  name?: string | undefined;
11732
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
11251
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
11733
11252
  climate_preset_key: string;
11734
- /** 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). */
11253
+ /** 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). */
11735
11254
  max_override_period_minutes: number;
11736
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11255
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11737
11256
  starts_at: string;
11738
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11257
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11739
11258
  ends_at: string;
11740
- /** Date and time at which the climate schedule was created. */
11259
+ /** Date and time at which the thermostat schedule was created. */
11741
11260
  created_at: string;
11742
- /** 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. */
11261
+ /** 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. */
11743
11262
  errors?: any;
11744
11263
  } | null) | undefined;
11745
11264
  min_cooling_set_point_celsius?: number | undefined;
@@ -12229,24 +11748,25 @@ export interface Routes {
12229
11748
  manual_override_allowed: boolean;
12230
11749
  }> | undefined;
12231
11750
  fallback_climate_preset_key?: (string | null) | undefined;
11751
+ /** 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. */
12232
11752
  active_thermostat_schedule?: ({
12233
- /** ID of the climate schedule. */
11753
+ /** ID of the thermostat schedule. */
12234
11754
  thermostat_schedule_id: string;
12235
11755
  /** ID of the desired thermostat device. */
12236
11756
  device_id: string;
12237
- /** User-friendly name to identify the climate schedule. */
11757
+ /** User-friendly name to identify the thermostat schedule. */
12238
11758
  name?: string | undefined;
12239
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
11759
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
12240
11760
  climate_preset_key: string;
12241
- /** 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). */
11761
+ /** 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). */
12242
11762
  max_override_period_minutes: number;
12243
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11763
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12244
11764
  starts_at: string;
12245
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11765
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12246
11766
  ends_at: string;
12247
- /** Date and time at which the climate schedule was created. */
11767
+ /** Date and time at which the thermostat schedule was created. */
12248
11768
  created_at: string;
12249
- /** 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. */
11769
+ /** 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. */
12250
11770
  errors?: any;
12251
11771
  } | null) | undefined;
12252
11772
  min_cooling_set_point_celsius?: number | undefined;
@@ -12773,24 +12293,25 @@ export interface Routes {
12773
12293
  manual_override_allowed: boolean;
12774
12294
  }> | undefined;
12775
12295
  fallback_climate_preset_key?: (string | null) | undefined;
12296
+ /** 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. */
12776
12297
  active_thermostat_schedule?: ({
12777
- /** ID of the climate schedule. */
12298
+ /** ID of the thermostat schedule. */
12778
12299
  thermostat_schedule_id: string;
12779
12300
  /** ID of the desired thermostat device. */
12780
12301
  device_id: string;
12781
- /** User-friendly name to identify the climate schedule. */
12302
+ /** User-friendly name to identify the thermostat schedule. */
12782
12303
  name?: string | undefined;
12783
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
12304
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
12784
12305
  climate_preset_key: string;
12785
- /** 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). */
12306
+ /** 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). */
12786
12307
  max_override_period_minutes: number;
12787
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12308
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12788
12309
  starts_at: string;
12789
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12310
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12790
12311
  ends_at: string;
12791
- /** Date and time at which the climate schedule was created. */
12312
+ /** Date and time at which the thermostat schedule was created. */
12792
12313
  created_at: string;
12793
- /** 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. */
12314
+ /** 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. */
12794
12315
  errors?: any;
12795
12316
  } | null) | undefined;
12796
12317
  min_cooling_set_point_celsius?: number | undefined;
@@ -13280,24 +12801,25 @@ export interface Routes {
13280
12801
  manual_override_allowed: boolean;
13281
12802
  }> | undefined;
13282
12803
  fallback_climate_preset_key?: (string | null) | undefined;
12804
+ /** 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. */
13283
12805
  active_thermostat_schedule?: ({
13284
- /** ID of the climate schedule. */
12806
+ /** ID of the thermostat schedule. */
13285
12807
  thermostat_schedule_id: string;
13286
12808
  /** ID of the desired thermostat device. */
13287
12809
  device_id: string;
13288
- /** User-friendly name to identify the climate schedule. */
12810
+ /** User-friendly name to identify the thermostat schedule. */
13289
12811
  name?: string | undefined;
13290
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
12812
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
13291
12813
  climate_preset_key: string;
13292
- /** 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). */
12814
+ /** 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). */
13293
12815
  max_override_period_minutes: number;
13294
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12816
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
13295
12817
  starts_at: string;
13296
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12818
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
13297
12819
  ends_at: string;
13298
- /** Date and time at which the climate schedule was created. */
12820
+ /** Date and time at which the thermostat schedule was created. */
13299
12821
  created_at: string;
13300
- /** 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. */
12822
+ /** 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. */
13301
12823
  errors?: any;
13302
12824
  } | null) | undefined;
13303
12825
  min_cooling_set_point_celsius?: number | undefined;
@@ -15324,24 +14846,25 @@ export interface Routes {
15324
14846
  manual_override_allowed: boolean;
15325
14847
  }> | undefined;
15326
14848
  fallback_climate_preset_key?: (string | null) | undefined;
14849
+ /** 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. */
15327
14850
  active_thermostat_schedule?: ({
15328
- /** ID of the climate schedule. */
14851
+ /** ID of the thermostat schedule. */
15329
14852
  thermostat_schedule_id: string;
15330
14853
  /** ID of the desired thermostat device. */
15331
14854
  device_id: string;
15332
- /** User-friendly name to identify the climate schedule. */
14855
+ /** User-friendly name to identify the thermostat schedule. */
15333
14856
  name?: string | undefined;
15334
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
14857
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
15335
14858
  climate_preset_key: string;
15336
- /** 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). */
14859
+ /** 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). */
15337
14860
  max_override_period_minutes: number;
15338
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
14861
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15339
14862
  starts_at: string;
15340
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
14863
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15341
14864
  ends_at: string;
15342
- /** Date and time at which the climate schedule was created. */
14865
+ /** Date and time at which the thermostat schedule was created. */
15343
14866
  created_at: string;
15344
- /** 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. */
14867
+ /** 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. */
15345
14868
  errors?: any;
15346
14869
  } | null) | undefined;
15347
14870
  min_cooling_set_point_celsius?: number | undefined;
@@ -15831,24 +15354,25 @@ export interface Routes {
15831
15354
  manual_override_allowed: boolean;
15832
15355
  }> | undefined;
15833
15356
  fallback_climate_preset_key?: (string | null) | undefined;
15357
+ /** 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. */
15834
15358
  active_thermostat_schedule?: ({
15835
- /** ID of the climate schedule. */
15359
+ /** ID of the thermostat schedule. */
15836
15360
  thermostat_schedule_id: string;
15837
15361
  /** ID of the desired thermostat device. */
15838
15362
  device_id: string;
15839
- /** User-friendly name to identify the climate schedule. */
15363
+ /** User-friendly name to identify the thermostat schedule. */
15840
15364
  name?: string | undefined;
15841
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
15365
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
15842
15366
  climate_preset_key: string;
15843
- /** 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). */
15367
+ /** 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). */
15844
15368
  max_override_period_minutes: number;
15845
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15369
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15846
15370
  starts_at: string;
15847
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15371
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
15848
15372
  ends_at: string;
15849
- /** Date and time at which the climate schedule was created. */
15373
+ /** Date and time at which the thermostat schedule was created. */
15850
15374
  created_at: string;
15851
- /** 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. */
15375
+ /** 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. */
15852
15376
  errors?: any;
15853
15377
  } | null) | undefined;
15854
15378
  min_cooling_set_point_celsius?: number | undefined;
@@ -20316,24 +19840,25 @@ export interface Routes {
20316
19840
  manual_override_allowed: boolean;
20317
19841
  }> | undefined;
20318
19842
  fallback_climate_preset_key?: (string | null) | undefined;
19843
+ /** 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. */
20319
19844
  active_thermostat_schedule?: ({
20320
- /** ID of the climate schedule. */
19845
+ /** ID of the thermostat schedule. */
20321
19846
  thermostat_schedule_id: string;
20322
19847
  /** ID of the desired thermostat device. */
20323
19848
  device_id: string;
20324
- /** User-friendly name to identify the climate schedule. */
19849
+ /** User-friendly name to identify the thermostat schedule. */
20325
19850
  name?: string | undefined;
20326
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
19851
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
20327
19852
  climate_preset_key: string;
20328
- /** 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). */
19853
+ /** 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). */
20329
19854
  max_override_period_minutes: number;
20330
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19855
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
20331
19856
  starts_at: string;
20332
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
19857
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
20333
19858
  ends_at: string;
20334
- /** Date and time at which the climate schedule was created. */
19859
+ /** Date and time at which the thermostat schedule was created. */
20335
19860
  created_at: string;
20336
- /** 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. */
19861
+ /** 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. */
20337
19862
  errors?: any;
20338
19863
  } | null) | undefined;
20339
19864
  min_cooling_set_point_celsius?: number | undefined;
@@ -22342,24 +21867,25 @@ export interface Routes {
22342
21867
  manual_override_allowed: boolean;
22343
21868
  }> | undefined;
22344
21869
  fallback_climate_preset_key?: (string | null) | undefined;
21870
+ /** 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. */
22345
21871
  active_thermostat_schedule?: ({
22346
- /** ID of the climate schedule. */
21872
+ /** ID of the thermostat schedule. */
22347
21873
  thermostat_schedule_id: string;
22348
21874
  /** ID of the desired thermostat device. */
22349
21875
  device_id: string;
22350
- /** User-friendly name to identify the climate schedule. */
21876
+ /** User-friendly name to identify the thermostat schedule. */
22351
21877
  name?: string | undefined;
22352
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
21878
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
22353
21879
  climate_preset_key: string;
22354
- /** 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). */
21880
+ /** 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). */
22355
21881
  max_override_period_minutes: number;
22356
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
21882
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
22357
21883
  starts_at: string;
22358
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
21884
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
22359
21885
  ends_at: string;
22360
- /** Date and time at which the climate schedule was created. */
21886
+ /** Date and time at which the thermostat schedule was created. */
22361
21887
  created_at: string;
22362
- /** 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. */
21888
+ /** 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. */
22363
21889
  errors?: any;
22364
21890
  } | null) | undefined;
22365
21891
  min_cooling_set_point_celsius?: number | undefined;
@@ -22849,24 +22375,25 @@ export interface Routes {
22849
22375
  manual_override_allowed: boolean;
22850
22376
  }> | undefined;
22851
22377
  fallback_climate_preset_key?: (string | null) | undefined;
22378
+ /** 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. */
22852
22379
  active_thermostat_schedule?: ({
22853
- /** ID of the climate schedule. */
22380
+ /** ID of the thermostat schedule. */
22854
22381
  thermostat_schedule_id: string;
22855
22382
  /** ID of the desired thermostat device. */
22856
22383
  device_id: string;
22857
- /** User-friendly name to identify the climate schedule. */
22384
+ /** User-friendly name to identify the thermostat schedule. */
22858
22385
  name?: string | undefined;
22859
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
22386
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
22860
22387
  climate_preset_key: string;
22861
- /** 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). */
22388
+ /** 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). */
22862
22389
  max_override_period_minutes: number;
22863
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
22390
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
22864
22391
  starts_at: string;
22865
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
22392
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
22866
22393
  ends_at: string;
22867
- /** Date and time at which the climate schedule was created. */
22394
+ /** Date and time at which the thermostat schedule was created. */
22868
22395
  created_at: string;
22869
- /** 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. */
22396
+ /** 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. */
22870
22397
  errors?: any;
22871
22398
  } | null) | undefined;
22872
22399
  min_cooling_set_point_celsius?: number | undefined;
@@ -23673,38 +23200,39 @@ export interface Routes {
23673
23200
  jsonBody: {
23674
23201
  /** ID of the desired thermostat device. */
23675
23202
  device_id: string;
23676
- /** User-friendly name to identify the climate schedule. */
23203
+ /** User-friendly name to identify the thermostat schedule. */
23677
23204
  name?: string | undefined;
23678
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
23205
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
23679
23206
  climate_preset_key: string;
23680
- /** 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). */
23207
+ /** 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). */
23681
23208
  max_override_period_minutes?: number;
23682
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23209
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23683
23210
  starts_at: string;
23684
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23211
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23685
23212
  ends_at: string;
23686
23213
  };
23687
23214
  commonParams: {};
23688
23215
  formData: {};
23689
23216
  jsonResponse: {
23217
+ /** 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. */
23690
23218
  thermostat_schedule: {
23691
- /** ID of the climate schedule. */
23219
+ /** ID of the thermostat schedule. */
23692
23220
  thermostat_schedule_id: string;
23693
23221
  /** ID of the desired thermostat device. */
23694
23222
  device_id: string;
23695
- /** User-friendly name to identify the climate schedule. */
23223
+ /** User-friendly name to identify the thermostat schedule. */
23696
23224
  name?: string | undefined;
23697
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
23225
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
23698
23226
  climate_preset_key: string;
23699
- /** 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). */
23227
+ /** 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). */
23700
23228
  max_override_period_minutes: number;
23701
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23229
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23702
23230
  starts_at: string;
23703
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23231
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23704
23232
  ends_at: string;
23705
- /** Date and time at which the climate schedule was created. */
23233
+ /** Date and time at which the thermostat schedule was created. */
23706
23234
  created_at: string;
23707
- /** 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. */
23235
+ /** 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. */
23708
23236
  errors?: any;
23709
23237
  };
23710
23238
  };
@@ -23715,7 +23243,7 @@ export interface Routes {
23715
23243
  queryParams: {};
23716
23244
  jsonBody: {};
23717
23245
  commonParams: {
23718
- /** ID of the desired climate schedule. */
23246
+ /** ID of the desired thermostat schedule. */
23719
23247
  thermostat_schedule_id: string;
23720
23248
  };
23721
23249
  formData: {};
@@ -23727,29 +23255,30 @@ export interface Routes {
23727
23255
  queryParams: {};
23728
23256
  jsonBody: {};
23729
23257
  commonParams: {
23730
- /** ID of the desired climate schedule. */
23258
+ /** ID of the desired thermostat schedule. */
23731
23259
  thermostat_schedule_id: string;
23732
23260
  };
23733
23261
  formData: {};
23734
23262
  jsonResponse: {
23263
+ /** 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. */
23735
23264
  thermostat_schedule: {
23736
- /** ID of the climate schedule. */
23265
+ /** ID of the thermostat schedule. */
23737
23266
  thermostat_schedule_id: string;
23738
23267
  /** ID of the desired thermostat device. */
23739
23268
  device_id: string;
23740
- /** User-friendly name to identify the climate schedule. */
23269
+ /** User-friendly name to identify the thermostat schedule. */
23741
23270
  name?: string | undefined;
23742
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
23271
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
23743
23272
  climate_preset_key: string;
23744
- /** 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). */
23273
+ /** 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). */
23745
23274
  max_override_period_minutes: number;
23746
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23275
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23747
23276
  starts_at: string;
23748
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23277
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23749
23278
  ends_at: string;
23750
- /** Date and time at which the climate schedule was created. */
23279
+ /** Date and time at which the thermostat schedule was created. */
23751
23280
  created_at: string;
23752
- /** 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. */
23281
+ /** 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. */
23753
23282
  errors?: any;
23754
23283
  };
23755
23284
  };
@@ -23762,29 +23291,29 @@ export interface Routes {
23762
23291
  commonParams: {
23763
23292
  /** ID of the desired thermostat device. */
23764
23293
  device_id: string;
23765
- /** User identifier key by which to filter the list of returned climate schedules. */
23294
+ /** User identifier key by which to filter the list of returned thermostat schedules. */
23766
23295
  user_identifier_key?: string | undefined;
23767
23296
  };
23768
23297
  formData: {};
23769
23298
  jsonResponse: {
23770
23299
  thermostat_schedules: Array<{
23771
- /** ID of the climate schedule. */
23300
+ /** ID of the thermostat schedule. */
23772
23301
  thermostat_schedule_id: string;
23773
23302
  /** ID of the desired thermostat device. */
23774
23303
  device_id: string;
23775
- /** User-friendly name to identify the climate schedule. */
23304
+ /** User-friendly name to identify the thermostat schedule. */
23776
23305
  name?: string | undefined;
23777
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
23306
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
23778
23307
  climate_preset_key: string;
23779
- /** 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). */
23308
+ /** 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). */
23780
23309
  max_override_period_minutes: number;
23781
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23310
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23782
23311
  starts_at: string;
23783
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23312
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23784
23313
  ends_at: string;
23785
- /** Date and time at which the climate schedule was created. */
23314
+ /** Date and time at which the thermostat schedule was created. */
23786
23315
  created_at: string;
23787
- /** 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. */
23316
+ /** 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. */
23788
23317
  errors?: any;
23789
23318
  }>;
23790
23319
  };
@@ -23794,17 +23323,17 @@ export interface Routes {
23794
23323
  method: 'PATCH' | 'POST';
23795
23324
  queryParams: {};
23796
23325
  jsonBody: {
23797
- /** ID of the desired climate schedule. */
23326
+ /** ID of the desired thermostat schedule. */
23798
23327
  thermostat_schedule_id: string;
23799
- /** User-friendly name to identify the climate schedule. */
23328
+ /** User-friendly name to identify the thermostat schedule. */
23800
23329
  name?: string | undefined;
23801
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
23330
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
23802
23331
  climate_preset_key?: string | undefined;
23803
- /** 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). */
23332
+ /** 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). */
23804
23333
  max_override_period_minutes?: number | undefined;
23805
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23334
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23806
23335
  starts_at?: string | undefined;
23807
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23336
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
23808
23337
  ends_at?: string | undefined;
23809
23338
  };
23810
23339
  commonParams: {};
@@ -25230,24 +24759,25 @@ export interface Routes {
25230
24759
  manual_override_allowed: boolean;
25231
24760
  }> | undefined;
25232
24761
  fallback_climate_preset_key?: (string | null) | undefined;
24762
+ /** 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. */
25233
24763
  active_thermostat_schedule?: ({
25234
- /** ID of the climate schedule. */
24764
+ /** ID of the thermostat schedule. */
25235
24765
  thermostat_schedule_id: string;
25236
24766
  /** ID of the desired thermostat device. */
25237
24767
  device_id: string;
25238
- /** User-friendly name to identify the climate schedule. */
24768
+ /** User-friendly name to identify the thermostat schedule. */
25239
24769
  name?: string | undefined;
25240
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
24770
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
25241
24771
  climate_preset_key: string;
25242
- /** 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). */
24772
+ /** 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). */
25243
24773
  max_override_period_minutes: number;
25244
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
24774
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25245
24775
  starts_at: string;
25246
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
24776
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25247
24777
  ends_at: string;
25248
- /** Date and time at which the climate schedule was created. */
24778
+ /** Date and time at which the thermostat schedule was created. */
25249
24779
  created_at: string;
25250
- /** 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. */
24780
+ /** 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. */
25251
24781
  errors?: any;
25252
24782
  } | null) | undefined;
25253
24783
  min_cooling_set_point_celsius?: number | undefined;
@@ -25739,24 +25269,25 @@ export interface Routes {
25739
25269
  manual_override_allowed: boolean;
25740
25270
  }> | undefined;
25741
25271
  fallback_climate_preset_key?: (string | null) | undefined;
25272
+ /** 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. */
25742
25273
  active_thermostat_schedule?: ({
25743
- /** ID of the climate schedule. */
25274
+ /** ID of the thermostat schedule. */
25744
25275
  thermostat_schedule_id: string;
25745
25276
  /** ID of the desired thermostat device. */
25746
25277
  device_id: string;
25747
- /** User-friendly name to identify the climate schedule. */
25278
+ /** User-friendly name to identify the thermostat schedule. */
25748
25279
  name?: string | undefined;
25749
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
25280
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
25750
25281
  climate_preset_key: string;
25751
- /** 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). */
25282
+ /** 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). */
25752
25283
  max_override_period_minutes: number;
25753
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25284
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25754
25285
  starts_at: string;
25755
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25286
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
25756
25287
  ends_at: string;
25757
- /** Date and time at which the climate schedule was created. */
25288
+ /** Date and time at which the thermostat schedule was created. */
25758
25289
  created_at: string;
25759
- /** 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. */
25290
+ /** 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. */
25760
25291
  errors?: any;
25761
25292
  } | null) | undefined;
25762
25293
  min_cooling_set_point_celsius?: number | undefined;