@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.
@@ -11818,6 +11818,7 @@ type Workspace = z.infer<typeof workspace>;
11818
11818
  declare const schemas_access_code: typeof access_code;
11819
11819
  declare const schemas_acs_access_group: typeof acs_access_group;
11820
11820
  declare const schemas_acs_credential: typeof acs_credential;
11821
+ declare const schemas_acs_encoder: typeof acs_encoder;
11821
11822
  declare const schemas_acs_entrance: typeof acs_entrance;
11822
11823
  declare const schemas_acs_system: typeof acs_system;
11823
11824
  declare const schemas_acs_user: typeof acs_user;
@@ -11843,7 +11844,7 @@ declare const schemas_user_identity: typeof user_identity;
11843
11844
  declare const schemas_webhook: typeof webhook;
11844
11845
  declare const schemas_workspace: typeof workspace;
11845
11846
  declare namespace schemas {
11846
- export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_device as device, schemas_device_provider as device_provider, schemas_noise_threshold as noise_threshold, schemas_seam_event as seam_event, schemas_thermostat_schedule as thermostat_schedule, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
11847
+ export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_device as device, schemas_device_provider as device_provider, schemas_noise_threshold as noise_threshold, schemas_seam_event as seam_event, schemas_thermostat_schedule as thermostat_schedule, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
11847
11848
  }
11848
11849
 
11849
11850
  declare const _default: {
@@ -15107,6 +15108,7 @@ declare const _default: {
15107
15108
  properties: {
15108
15109
  active_thermostat_schedule: {
15109
15110
  default: null;
15111
+ description: string;
15110
15112
  nullable: boolean;
15111
15113
  properties: {
15112
15114
  climate_preset_key: {
@@ -15930,6 +15932,7 @@ declare const _default: {
15930
15932
  type: string;
15931
15933
  };
15932
15934
  thermostat_schedule: {
15935
+ description: string;
15933
15936
  properties: {
15934
15937
  climate_preset_key: {
15935
15938
  description: string;
@@ -20968,7 +20971,7 @@ declare const _default: {
20968
20971
  format: string;
20969
20972
  type: string;
20970
20973
  };
20971
- device_id: {
20974
+ acs_encoder_id: {
20972
20975
  description: string;
20973
20976
  format: string;
20974
20977
  type: string;
@@ -21038,14 +21041,14 @@ declare const _default: {
21038
21041
  schema: {
21039
21042
  oneOf: ({
21040
21043
  properties: {
21041
- acs_system_ids: {
21044
+ acs_encoder_ids: {
21042
21045
  items: {
21043
21046
  format: string;
21044
21047
  type: string;
21045
21048
  };
21046
21049
  type: string;
21047
21050
  };
21048
- device_ids: {
21051
+ acs_system_ids: {
21049
21052
  items: {
21050
21053
  format: string;
21051
21054
  type: string;
@@ -21062,7 +21065,7 @@ declare const _default: {
21062
21065
  type: string;
21063
21066
  } | {
21064
21067
  properties: {
21065
- device_ids: {
21068
+ acs_encoder_ids: {
21066
21069
  items: {
21067
21070
  format: string;
21068
21071
  type: string;
@@ -21092,7 +21095,7 @@ declare const _default: {
21092
21095
  format: string;
21093
21096
  type: string;
21094
21097
  };
21095
- device_ids?: never;
21098
+ acs_encoder_ids?: never;
21096
21099
  };
21097
21100
  required: string[];
21098
21101
  type: string;
@@ -21107,9 +21110,66 @@ declare const _default: {
21107
21110
  'application/json': {
21108
21111
  schema: {
21109
21112
  properties: {
21110
- devices: {
21113
+ acs_encoders: {
21111
21114
  items: {
21112
- $ref: string;
21115
+ properties: {
21116
+ acs_encoder_id: {
21117
+ description: string;
21118
+ format: string;
21119
+ type: string;
21120
+ };
21121
+ acs_system_id: {
21122
+ description: string;
21123
+ format: string;
21124
+ type: string;
21125
+ };
21126
+ created_at: {
21127
+ description: string;
21128
+ format: string;
21129
+ type: string;
21130
+ };
21131
+ display_name: {
21132
+ description: string;
21133
+ type: string;
21134
+ };
21135
+ errors: {
21136
+ description: string;
21137
+ items: {
21138
+ description: string;
21139
+ properties: {
21140
+ _event_id: {
21141
+ description: string;
21142
+ format: string;
21143
+ type: string;
21144
+ };
21145
+ created_at: {
21146
+ description: string;
21147
+ format: string;
21148
+ type: string;
21149
+ };
21150
+ error_code: {
21151
+ description: string;
21152
+ enum: string[];
21153
+ type: string;
21154
+ };
21155
+ message: {
21156
+ description: string;
21157
+ type: string;
21158
+ };
21159
+ };
21160
+ required: string[];
21161
+ type: string;
21162
+ };
21163
+ type: string;
21164
+ };
21165
+ workspace_id: {
21166
+ description: string;
21167
+ format: string;
21168
+ type: string;
21169
+ };
21170
+ };
21171
+ required: string[];
21172
+ type: string;
21113
21173
  };
21114
21174
  type: string;
21115
21175
  };
@@ -21161,12 +21221,12 @@ declare const _default: {
21161
21221
  'application/json': {
21162
21222
  schema: {
21163
21223
  properties: {
21164
- acs_system_id: {
21224
+ acs_encoder_id: {
21165
21225
  description: string;
21166
21226
  format: string;
21167
21227
  type: string;
21168
21228
  };
21169
- device_id: {
21229
+ acs_system_id: {
21170
21230
  description: string;
21171
21231
  format: string;
21172
21232
  type: string;
@@ -36711,8 +36771,8 @@ interface Routes {
36711
36771
  queryParams: {};
36712
36772
  jsonBody: {};
36713
36773
  commonParams: {
36714
- /** ID of the encoder to use for the encoding. */
36715
- device_id: string;
36774
+ /** ID of the acs_encoder to use for the encoding. */
36775
+ acs_encoder_id: string;
36716
36776
  /** ID of the acs_credential to encode on a physical card. */
36717
36777
  acs_credential_id: string;
36718
36778
  };
@@ -37447,10 +37507,10 @@ interface Routes {
37447
37507
  jsonBody: {};
37448
37508
  commonParams: {
37449
37509
  acs_system_ids: string[];
37450
- device_ids: string[];
37510
+ acs_encoder_ids: string[];
37451
37511
  limit?: number;
37452
37512
  } | {
37453
- device_ids: string[];
37513
+ acs_encoder_ids: string[];
37454
37514
  limit?: number;
37455
37515
  } | {
37456
37516
  acs_system_ids: string[];
@@ -37458,512 +37518,28 @@ interface Routes {
37458
37518
  };
37459
37519
  formData: {};
37460
37520
  jsonResponse: {
37461
- devices: Array<{
37462
- /** Unique identifier for the device. */
37463
- device_id: string;
37464
- /** Type of the device. */
37465
- 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');
37466
- /** Optional nickname to describe the device, settable through Seam */
37467
- nickname?: string | undefined;
37468
- /** 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. */
37469
- display_name: string;
37470
- /** 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. */
37471
- capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
37472
- /** Properties of the device. */
37473
- properties: (({
37474
- /** Indicates whether the device is online. */
37475
- online: boolean;
37476
- /** Name of the device.
37477
- * @deprecated use device.display_name instead */
37478
- name: string;
37479
- /** Represents the accessory keypad state. */
37480
- accessory_keypad?: {
37481
- /** Indicates if the accessory_keypad is connected to the device. */
37482
- is_connected: boolean;
37483
- /** Indicates if the keypad battery properties. */
37484
- battery?: {
37485
- level: number;
37486
- } | undefined;
37487
- } | undefined;
37488
- appearance: {
37489
- /** Name of the device as seen from the provider API and application, not settable through Seam. */
37490
- name: string;
37491
- };
37492
- model: {
37493
- /** Indicates whether the device can connect a accessory keypad. */
37494
- can_connect_accessory_keypad?: boolean | undefined;
37495
- /** Display name of the device model. */
37496
- display_name: string;
37497
- /** Display name that corresponds to the manufacturer-specific terminology for the device. */
37498
- manufacturer_display_name: string;
37499
- /** Indicates whether the device has a built in accessory keypad. */
37500
- has_built_in_keypad?: boolean | undefined;
37501
- /** Indicates whether the device supports offline access codes. */
37502
- offline_access_codes_supported?: boolean | undefined;
37503
- /** Indicates whether the device supports online access codes. */
37504
- online_access_codes_supported?: boolean | undefined;
37505
- /**
37506
- * @deprecated use device.properties.model.can_connect_accessory_keypad */
37507
- accessory_keypad_supported?: boolean | undefined;
37508
- };
37509
- /** Indicates whether the device has direct power. */
37510
- has_direct_power?: boolean | undefined;
37511
- /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
37512
- battery_level?: number | undefined;
37513
- /** 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. */
37514
- battery?: {
37515
- level: number;
37516
- status: 'critical' | 'low' | 'good' | 'full';
37517
- } | undefined;
37518
- /** Manufacturer of the device. */
37519
- manufacturer?: string | undefined;
37520
- /** Image URL for the device. */
37521
- image_url?: string | undefined;
37522
- /** Alt text for the device image. */
37523
- image_alt_text?: string | undefined;
37524
- /** Serial number of the device. */
37525
- serial_number?: string | undefined;
37526
- /** Indicates whether it is currently possible to use online access codes for the device. */
37527
- online_access_codes_enabled?: boolean | undefined;
37528
- /** Indicates whether it is currently possible to use offline access codes for the device. */
37529
- offline_access_codes_enabled?: boolean | undefined;
37530
- /**
37531
- * @deprecated use device.properties.model.can_connect_accessory_keypad */
37532
- supports_accessory_keypad?: boolean | undefined;
37533
- /**
37534
- * @deprecated use offline_access_codes_enabled */
37535
- supports_offline_access_codes?: boolean | undefined;
37536
- /** Indicates current noise level in decibels, if the device supports noise detection. */
37537
- noise_level_decibels?: number | undefined;
37538
- /** Array of noise threshold IDs that are currently triggering. */
37539
- currently_triggering_noise_threshold_ids?: string[] | undefined;
37540
- } & {
37541
- assa_abloy_credential_service_metadata?: ({
37542
- has_active_endpoint: boolean;
37543
- endpoints: Array<{
37544
- endpoint_id: string;
37545
- is_active: boolean;
37546
- }>;
37547
- } | undefined) | undefined;
37548
- }) & {
37549
- august_metadata?: {
37550
- lock_id: string;
37551
- lock_name: string;
37552
- house_name: string;
37553
- has_keypad: boolean;
37554
- keypad_battery_level?: string | undefined;
37555
- model?: string | undefined;
37556
- house_id?: string | undefined;
37557
- } | undefined;
37558
- avigilon_alta_metadata?: {
37559
- entry_name: string;
37560
- org_name: string;
37561
- zone_id: number;
37562
- zone_name: string;
37563
- site_id: number;
37564
- site_name: string;
37565
- entry_relays_total_count: number;
37566
- } | undefined;
37567
- schlage_metadata?: {
37568
- device_id: string;
37569
- device_name: string;
37570
- access_code_length: number | null;
37571
- model?: string | undefined;
37572
- } | undefined;
37573
- smartthings_metadata?: {
37574
- device_id: string;
37575
- device_name: string;
37576
- model?: string | undefined;
37577
- location_id?: string | undefined;
37578
- } | undefined;
37579
- lockly_metadata?: {
37580
- device_id: string;
37581
- device_name: string;
37582
- model?: string | undefined;
37583
- } | undefined;
37584
- nuki_metadata?: {
37585
- device_id: string;
37586
- device_name: string;
37587
- keypad_battery_critical?: boolean | undefined;
37588
- keypad_paired?: boolean | undefined;
37589
- keypad_2_paired?: boolean | undefined;
37590
- } | undefined;
37591
- kwikset_metadata?: {
37592
- device_id: string;
37593
- device_name: string;
37594
- model_number: string;
37595
- } | undefined;
37596
- /**
37597
- ---
37598
- deprecated: Use `salto_ks_metadata ` instead.
37599
- */
37600
- salto_metadata?: {
37601
- lock_id: string;
37602
- customer_reference: string;
37603
- lock_type: string;
37604
- battery_level: string;
37605
- locked_state: string;
37606
- model?: string | undefined;
37607
- } | undefined;
37608
- salto_ks_metadata?: {
37609
- lock_id: string;
37610
- customer_reference: string;
37611
- lock_type: string;
37612
- battery_level: string;
37613
- locked_state: string;
37614
- model?: string | undefined;
37615
- } | undefined;
37616
- genie_metadata?: {
37617
- device_name: string;
37618
- door_name: string;
37619
- } | undefined;
37620
- brivo_metadata?: {
37621
- device_name: string;
37622
- } | undefined;
37623
- igloo_metadata?: {
37624
- device_id: string;
37625
- bridge_id: string;
37626
- model?: string | undefined;
37627
- } | undefined;
37628
- noiseaware_metadata?: {
37629
- device_model: 'indoor' | 'outdoor';
37630
- noise_level_nrs: number;
37631
- noise_level_decibel: number;
37632
- device_name: string;
37633
- device_id: string;
37634
- } | undefined;
37635
- minut_metadata?: {
37636
- device_id: string;
37637
- device_name: string;
37638
- latest_sensor_values: {
37639
- temperature: {
37640
- time: string;
37641
- value: number;
37642
- };
37643
- sound: {
37644
- time: string;
37645
- value: number;
37646
- };
37647
- humidity: {
37648
- time: string;
37649
- value: number;
37650
- };
37651
- pressure: {
37652
- time: string;
37653
- value: number;
37654
- };
37655
- accelerometer_z: {
37656
- time: string;
37657
- value: number;
37658
- };
37659
- };
37660
- } | undefined;
37661
- four_suites_metadata?: {
37662
- device_id: number;
37663
- device_name: string;
37664
- reclose_delay_in_seconds: number;
37665
- } | undefined;
37666
- two_n_metadata?: {
37667
- device_id: number;
37668
- device_name: string;
37669
- } | undefined;
37670
- controlbyweb_metadata?: {
37671
- device_id: string;
37672
- device_name: string;
37673
- relay_name: string | null;
37674
- } | undefined;
37675
- ttlock_metadata?: {
37676
- lock_id: number;
37677
- lock_alias: string;
37678
- feature_value: string;
37679
- features: {
37680
- passcode: boolean;
37681
- passcode_management: boolean;
37682
- unlock_via_gateway: boolean;
37683
- lock_command: boolean;
37684
- incomplete_keyboard_passcode: boolean;
37685
- };
37686
- has_gateway?: boolean | undefined;
37687
- wireless_keypads?: Array<{
37688
- wireless_keypad_id: number;
37689
- wireless_keypad_name: string;
37690
- }> | undefined;
37691
- } | undefined;
37692
- seam_bridge_metadata?: {
37693
- unlock_method?: ('bridge' | 'doorking') | undefined;
37694
- device_num: number;
37695
- name: string;
37696
- } | undefined;
37697
- igloohome_metadata?: {
37698
- device_id: string;
37699
- device_name: string;
37700
- bridge_id?: string | undefined;
37701
- bridge_name?: string | undefined;
37702
- keypad_id?: string | undefined;
37703
- } | undefined;
37704
- nest_metadata?: {
37705
- nest_device_id: string;
37706
- device_name: string;
37707
- custom_name: string;
37708
- display_name?: string | undefined;
37709
- } | undefined;
37710
- ecobee_metadata?: {
37711
- ecobee_device_id: string;
37712
- device_name: string;
37713
- } | undefined;
37714
- honeywell_resideo_metadata?: {
37715
- honeywell_resideo_device_id: string;
37716
- device_name: string;
37717
- } | undefined;
37718
- hubitat_metadata?: {
37719
- device_id: string;
37720
- device_name: string;
37721
- device_label: string;
37722
- } | undefined;
37723
- dormakaba_oracode_metadata?: {
37724
- door_id?: number | undefined;
37725
- door_name: string;
37726
- device_id?: (number | string) | undefined;
37727
- door_is_wireless: boolean;
37728
- /** @DEPRECATED */
37729
- site_id: number | null;
37730
- site_name: string;
37731
- iana_timezone?: string | undefined;
37732
- predefined_time_slots?: Array<{
37733
- name: string;
37734
- prefix: number;
37735
- check_in_time: string;
37736
- check_out_time: string;
37737
- is_24_hour: boolean;
37738
- is_biweekly_mode: boolean;
37739
- is_one_shot: boolean;
37740
- is_master: boolean;
37741
- ext_dormakaba_oracode_user_level_prefix: number;
37742
- dormakaba_oracode_user_level_id: string;
37743
- }> | undefined;
37744
- } | undefined;
37745
- wyze_metadata?: {
37746
- device_id: string;
37747
- device_name: string;
37748
- product_name: string;
37749
- product_type: string;
37750
- product_model: string;
37751
- device_info_model: string;
37752
- keypad_uuid?: string | undefined;
37753
- locker_status_hardlock?: number | undefined;
37754
- } | undefined;
37755
- tedee_metadata?: {
37756
- device_id: number;
37757
- serial_number: string;
37758
- device_name: string;
37759
- device_model: string;
37760
- bridge_id: number;
37761
- bridge_name: string;
37762
- keypad_id?: number | undefined;
37763
- } | undefined;
37764
- visionline_metadata?: {
37765
- encoder_id: string;
37766
- } | undefined;
37767
- akiles_metadata?: {
37768
- gadget_name: string;
37769
- gadget_id: string;
37770
- product_name: string;
37771
- _member_group_id?: string | undefined;
37772
- } | undefined;
37773
- assa_abloy_vostio_metadata?: {
37774
- encoder_name: string;
37775
- } | undefined;
37776
- }) & ({
37777
- _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
37778
- code_constraints?: (Array<{
37779
- 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';
37780
- } | {
37781
- constraint_type: 'name_length' | 'name_must_be_unique';
37782
- min_length?: number | undefined;
37783
- max_length?: number | undefined;
37784
- }> | undefined) | undefined;
37785
- supported_code_lengths?: (number[] | undefined) | undefined;
37786
- max_active_codes_supported?: (number | undefined) | undefined;
37787
- supports_backup_access_code_pool?: (boolean | undefined) | undefined;
37788
- has_native_entry_events?: (boolean | undefined) | undefined;
37789
- locked?: (boolean | undefined) | undefined;
37790
- keypad_battery?: ({
37791
- level: number;
37792
- } | undefined) | undefined;
37793
- door_open?: (boolean | undefined) | undefined;
37794
- } & {
37795
- temperature_fahrenheit?: number | undefined;
37796
- temperature_celsius?: number | undefined;
37797
- relative_humidity?: number | undefined;
37798
- available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
37799
- available_fan_mode_settings?: Array<'auto' | 'on' | 'circulate'> | undefined;
37800
- is_heating?: boolean | undefined;
37801
- is_cooling?: boolean | undefined;
37802
- is_fan_running?: boolean | undefined;
37803
- /**
37804
- * @deprecated use current_climate_setting.fan_mode_setting instead. */
37805
- fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
37806
- is_temporary_manual_override_active?: boolean | undefined;
37807
- current_climate_setting?: {
37808
- /** Unique key to identify the climate preset. */
37809
- climate_preset_key?: string | undefined;
37810
- /** Indicates whether this climate preset key can be edited. */
37811
- can_edit?: boolean | undefined;
37812
- /** Indicates whether this climate preset key can be deleted. */
37813
- can_delete?: boolean | undefined;
37814
- /** User-friendly name to identify the climate preset. */
37815
- name?: ((string | null) | undefined) | undefined;
37816
- /** Display name for the climate preset. */
37817
- display_name?: string | undefined;
37818
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37819
- fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
37820
- /** 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`. */
37821
- hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
37822
- /** 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). */
37823
- cooling_set_point_celsius?: (number | undefined) | undefined;
37824
- /** Temperature to which the thermostat should heat (in °C). */
37825
- heating_set_point_celsius?: (number | undefined) | undefined;
37826
- /** Temperature to which the thermostat should cool (in °F). */
37827
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
37828
- /** Temperature to which the thermostat should heat (in °F). */
37829
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
37830
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37831
- manual_override_allowed?: boolean | undefined;
37832
- } | undefined;
37833
- /**
37834
- * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
37835
- default_climate_setting?: {
37836
- /** Unique key to identify the climate preset. */
37837
- climate_preset_key?: string | undefined;
37838
- /** Indicates whether this climate preset key can be edited. */
37839
- can_edit?: boolean | undefined;
37840
- /** Indicates whether this climate preset key can be deleted. */
37841
- can_delete?: boolean | undefined;
37842
- /** User-friendly name to identify the climate preset. */
37843
- name?: ((string | null) | undefined) | undefined;
37844
- /** Display name for the climate preset. */
37845
- display_name?: string | undefined;
37846
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37847
- fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
37848
- /** 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`. */
37849
- hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
37850
- /** 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). */
37851
- cooling_set_point_celsius?: (number | undefined) | undefined;
37852
- /** Temperature to which the thermostat should heat (in °C). */
37853
- heating_set_point_celsius?: (number | undefined) | undefined;
37854
- /** Temperature to which the thermostat should cool (in °F). */
37855
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
37856
- /** Temperature to which the thermostat should heat (in °F). */
37857
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
37858
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37859
- manual_override_allowed?: boolean | undefined;
37860
- } | undefined;
37861
- available_climate_presets?: Array<{
37862
- /** Unique key to identify the climate preset. */
37863
- climate_preset_key: string;
37864
- /** Indicates whether this climate preset key can be edited. */
37865
- can_edit: boolean;
37866
- /** Indicates whether this climate preset key can be deleted. */
37867
- can_delete: boolean;
37868
- /** User-friendly name to identify the climate preset. */
37869
- name?: (string | null) | undefined;
37870
- /** Display name for the climate preset. */
37871
- display_name: string;
37872
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37873
- fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
37874
- /** 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`. */
37875
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
37876
- /** 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). */
37877
- cooling_set_point_celsius?: number | undefined;
37878
- /** Temperature to which the thermostat should heat (in °C). */
37879
- heating_set_point_celsius?: number | undefined;
37880
- /** Temperature to which the thermostat should cool (in °F). */
37881
- cooling_set_point_fahrenheit?: number | undefined;
37882
- /** Temperature to which the thermostat should heat (in °F). */
37883
- heating_set_point_fahrenheit?: number | undefined;
37884
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37885
- manual_override_allowed: boolean;
37886
- }> | undefined;
37887
- fallback_climate_preset_key?: (string | null) | undefined;
37888
- active_thermostat_schedule?: ({
37889
- /** ID of the climate schedule. */
37890
- thermostat_schedule_id: string;
37891
- /** ID of the desired thermostat device. */
37892
- device_id: string;
37893
- /** User-friendly name to identify the climate schedule. */
37894
- name?: string | undefined;
37895
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
37896
- climate_preset_key: string;
37897
- /** 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). */
37898
- max_override_period_minutes: number;
37899
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
37900
- starts_at: string;
37901
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
37902
- ends_at: string;
37903
- /** Date and time at which the climate schedule was created. */
37904
- created_at: string;
37905
- /** 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. */
37906
- errors?: any;
37907
- } | null) | undefined;
37908
- min_cooling_set_point_celsius?: number | undefined;
37909
- min_cooling_set_point_fahrenheit?: number | undefined;
37910
- max_cooling_set_point_celsius?: number | undefined;
37911
- max_cooling_set_point_fahrenheit?: number | undefined;
37912
- min_heating_set_point_celsius?: number | undefined;
37913
- min_heating_set_point_fahrenheit?: number | undefined;
37914
- max_heating_set_point_celsius?: number | undefined;
37915
- max_heating_set_point_fahrenheit?: number | undefined;
37916
- min_heating_cooling_delta_celsius?: number | undefined;
37917
- min_heating_cooling_delta_fahrenheit?: number | undefined;
37918
- temperature_threshold?: ({
37919
- lower_limit_celsius: number | null;
37920
- lower_limit_fahrenheit: number | null;
37921
- upper_limit_celsius: number | null;
37922
- upper_limit_fahrenheit: number | null;
37923
- } | undefined) | undefined;
37924
- });
37925
- /** Location information for the device. */
37926
- location: {
37927
- /** Name of the device location. */
37928
- location_name?: string | undefined;
37929
- /** Time zone of the device location. */
37930
- timezone?: string | undefined;
37931
- } | null;
37932
- /** Unique identifier for the account associated with the device. */
37933
- connected_account_id: string;
37934
- /** Unique identifier for the Seam workspace associated with the device. */
37521
+ acs_encoders: Array<{
37522
+ /** ID of the `acs_encoder`. */
37523
+ acs_encoder_id: string;
37524
+ /** ID of the access control system that contains the `acs_encoder`. */
37525
+ acs_system_id: string;
37526
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
37935
37527
  workspace_id: string;
37936
- /** 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. */
37528
+ /** Errors associated with the `acs_encoder`. */
37937
37529
  errors: Array<{
37530
+ /** Date and time at which Seam created the error. */
37531
+ created_at: string;
37532
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
37938
37533
  message: string;
37939
- is_device_error: true;
37940
- error_code: string;
37941
- } | {
37942
- message: string;
37943
- is_connected_account_error: true;
37944
- error_code: string;
37945
- }>;
37946
- /** 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. */
37947
- warnings: Array<{
37948
- message: string;
37949
- warning_code: string;
37534
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
37535
+ error_code: 'acs_encoder_removed';
37536
+ /** ID of the event that was created when the `acs_encoder` was removed. */
37537
+ _event_id: string;
37950
37538
  }>;
37951
- /** Date and time at which the device object was created. */
37539
+ /** Date and time at which the `acs_encoder` was created. */
37952
37540
  created_at: string;
37953
- /** Indicates whether Seam manages the device. */
37954
- is_managed: true;
37955
- custom_metadata: Record<string, string | boolean>;
37956
- can_remotely_unlock?: boolean | undefined;
37957
- can_remotely_lock?: boolean | undefined;
37958
- can_program_offline_access_codes?: boolean | undefined;
37959
- can_program_online_access_codes?: boolean | undefined;
37960
- can_hvac_heat?: boolean | undefined;
37961
- can_hvac_cool?: boolean | undefined;
37962
- can_hvac_heat_cool?: boolean | undefined;
37963
- can_turn_off_hvac?: boolean | undefined;
37964
- can_simulate_removal?: boolean | undefined;
37965
- can_simulate_connection?: boolean | undefined;
37966
- can_simulate_disconnection?: boolean | undefined;
37541
+ /** Display name for the `acs_encoder`. */
37542
+ display_name: string;
37967
37543
  }>;
37968
37544
  };
37969
37545
  };
@@ -37975,8 +37551,8 @@ interface Routes {
37975
37551
  commonParams: {
37976
37552
  /** ID of the acs_system the encoder belongs to. */
37977
37553
  acs_system_id: string;
37978
- /** ID of the encoder to use for the scan. */
37979
- device_id: string;
37554
+ /** ID of the acs_encoder to use for the scan. */
37555
+ acs_encoder_id: string;
37980
37556
  };
37981
37557
  formData: {};
37982
37558
  jsonResponse: {
@@ -42269,24 +41845,25 @@ interface Routes {
42269
41845
  manual_override_allowed: boolean;
42270
41846
  }> | undefined;
42271
41847
  fallback_climate_preset_key?: (string | null) | undefined;
41848
+ /** 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. */
42272
41849
  active_thermostat_schedule?: ({
42273
- /** ID of the climate schedule. */
41850
+ /** ID of the thermostat schedule. */
42274
41851
  thermostat_schedule_id: string;
42275
41852
  /** ID of the desired thermostat device. */
42276
41853
  device_id: string;
42277
- /** User-friendly name to identify the climate schedule. */
41854
+ /** User-friendly name to identify the thermostat schedule. */
42278
41855
  name?: string | undefined;
42279
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
41856
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
42280
41857
  climate_preset_key: string;
42281
- /** 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). */
41858
+ /** 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). */
42282
41859
  max_override_period_minutes: number;
42283
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41860
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
42284
41861
  starts_at: string;
42285
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41862
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
42286
41863
  ends_at: string;
42287
- /** Date and time at which the climate schedule was created. */
41864
+ /** Date and time at which the thermostat schedule was created. */
42288
41865
  created_at: string;
42289
- /** 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. */
41866
+ /** 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. */
42290
41867
  errors?: any;
42291
41868
  } | null) | undefined;
42292
41869
  min_cooling_set_point_celsius?: number | undefined;
@@ -42813,24 +42390,25 @@ interface Routes {
42813
42390
  manual_override_allowed: boolean;
42814
42391
  }> | undefined;
42815
42392
  fallback_climate_preset_key?: (string | null) | undefined;
42393
+ /** 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. */
42816
42394
  active_thermostat_schedule?: ({
42817
- /** ID of the climate schedule. */
42395
+ /** ID of the thermostat schedule. */
42818
42396
  thermostat_schedule_id: string;
42819
42397
  /** ID of the desired thermostat device. */
42820
42398
  device_id: string;
42821
- /** User-friendly name to identify the climate schedule. */
42399
+ /** User-friendly name to identify the thermostat schedule. */
42822
42400
  name?: string | undefined;
42823
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
42401
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
42824
42402
  climate_preset_key: string;
42825
- /** 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). */
42403
+ /** 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). */
42826
42404
  max_override_period_minutes: number;
42827
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
42405
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
42828
42406
  starts_at: string;
42829
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
42407
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
42830
42408
  ends_at: string;
42831
- /** Date and time at which the climate schedule was created. */
42409
+ /** Date and time at which the thermostat schedule was created. */
42832
42410
  created_at: string;
42833
- /** 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. */
42411
+ /** 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. */
42834
42412
  errors?: any;
42835
42413
  } | null) | undefined;
42836
42414
  min_cooling_set_point_celsius?: number | undefined;
@@ -43760,24 +43338,25 @@ interface Routes {
43760
43338
  manual_override_allowed: boolean;
43761
43339
  }> | undefined;
43762
43340
  fallback_climate_preset_key?: (string | null) | undefined;
43341
+ /** 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. */
43763
43342
  active_thermostat_schedule?: ({
43764
- /** ID of the climate schedule. */
43343
+ /** ID of the thermostat schedule. */
43765
43344
  thermostat_schedule_id: string;
43766
43345
  /** ID of the desired thermostat device. */
43767
43346
  device_id: string;
43768
- /** User-friendly name to identify the climate schedule. */
43347
+ /** User-friendly name to identify the thermostat schedule. */
43769
43348
  name?: string | undefined;
43770
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
43349
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
43771
43350
  climate_preset_key: string;
43772
- /** 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). */
43351
+ /** 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). */
43773
43352
  max_override_period_minutes: number;
43774
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43353
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43775
43354
  starts_at: string;
43776
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43355
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43777
43356
  ends_at: string;
43778
- /** Date and time at which the climate schedule was created. */
43357
+ /** Date and time at which the thermostat schedule was created. */
43779
43358
  created_at: string;
43780
- /** 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. */
43359
+ /** 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. */
43781
43360
  errors?: any;
43782
43361
  } | null) | undefined;
43783
43362
  min_cooling_set_point_celsius?: number | undefined;
@@ -44267,24 +43846,25 @@ interface Routes {
44267
43846
  manual_override_allowed: boolean;
44268
43847
  }> | undefined;
44269
43848
  fallback_climate_preset_key?: (string | null) | undefined;
43849
+ /** 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. */
44270
43850
  active_thermostat_schedule?: ({
44271
- /** ID of the climate schedule. */
43851
+ /** ID of the thermostat schedule. */
44272
43852
  thermostat_schedule_id: string;
44273
43853
  /** ID of the desired thermostat device. */
44274
43854
  device_id: string;
44275
- /** User-friendly name to identify the climate schedule. */
43855
+ /** User-friendly name to identify the thermostat schedule. */
44276
43856
  name?: string | undefined;
44277
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
43857
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
44278
43858
  climate_preset_key: string;
44279
- /** 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). */
43859
+ /** 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). */
44280
43860
  max_override_period_minutes: number;
44281
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43861
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44282
43862
  starts_at: string;
44283
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
43863
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44284
43864
  ends_at: string;
44285
- /** Date and time at which the climate schedule was created. */
43865
+ /** Date and time at which the thermostat schedule was created. */
44286
43866
  created_at: string;
44287
- /** 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. */
43867
+ /** 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. */
44288
43868
  errors?: any;
44289
43869
  } | null) | undefined;
44290
43870
  min_cooling_set_point_celsius?: number | undefined;
@@ -44811,24 +44391,25 @@ interface Routes {
44811
44391
  manual_override_allowed: boolean;
44812
44392
  }> | undefined;
44813
44393
  fallback_climate_preset_key?: (string | null) | undefined;
44394
+ /** 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. */
44814
44395
  active_thermostat_schedule?: ({
44815
- /** ID of the climate schedule. */
44396
+ /** ID of the thermostat schedule. */
44816
44397
  thermostat_schedule_id: string;
44817
44398
  /** ID of the desired thermostat device. */
44818
44399
  device_id: string;
44819
- /** User-friendly name to identify the climate schedule. */
44400
+ /** User-friendly name to identify the thermostat schedule. */
44820
44401
  name?: string | undefined;
44821
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
44402
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
44822
44403
  climate_preset_key: string;
44823
- /** 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). */
44404
+ /** 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). */
44824
44405
  max_override_period_minutes: number;
44825
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44406
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44826
44407
  starts_at: string;
44827
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44408
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44828
44409
  ends_at: string;
44829
- /** Date and time at which the climate schedule was created. */
44410
+ /** Date and time at which the thermostat schedule was created. */
44830
44411
  created_at: string;
44831
- /** 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. */
44412
+ /** 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. */
44832
44413
  errors?: any;
44833
44414
  } | null) | undefined;
44834
44415
  min_cooling_set_point_celsius?: number | undefined;
@@ -45318,24 +44899,25 @@ interface Routes {
45318
44899
  manual_override_allowed: boolean;
45319
44900
  }> | undefined;
45320
44901
  fallback_climate_preset_key?: (string | null) | undefined;
44902
+ /** 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. */
45321
44903
  active_thermostat_schedule?: ({
45322
- /** ID of the climate schedule. */
44904
+ /** ID of the thermostat schedule. */
45323
44905
  thermostat_schedule_id: string;
45324
44906
  /** ID of the desired thermostat device. */
45325
44907
  device_id: string;
45326
- /** User-friendly name to identify the climate schedule. */
44908
+ /** User-friendly name to identify the thermostat schedule. */
45327
44909
  name?: string | undefined;
45328
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
44910
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
45329
44911
  climate_preset_key: string;
45330
- /** 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). */
44912
+ /** 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). */
45331
44913
  max_override_period_minutes: number;
45332
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44914
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
45333
44915
  starts_at: string;
45334
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
44916
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
45335
44917
  ends_at: string;
45336
- /** Date and time at which the climate schedule was created. */
44918
+ /** Date and time at which the thermostat schedule was created. */
45337
44919
  created_at: string;
45338
- /** 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. */
44920
+ /** 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. */
45339
44921
  errors?: any;
45340
44922
  } | null) | undefined;
45341
44923
  min_cooling_set_point_celsius?: number | undefined;
@@ -47362,24 +46944,25 @@ interface Routes {
47362
46944
  manual_override_allowed: boolean;
47363
46945
  }> | undefined;
47364
46946
  fallback_climate_preset_key?: (string | null) | undefined;
46947
+ /** 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. */
47365
46948
  active_thermostat_schedule?: ({
47366
- /** ID of the climate schedule. */
46949
+ /** ID of the thermostat schedule. */
47367
46950
  thermostat_schedule_id: string;
47368
46951
  /** ID of the desired thermostat device. */
47369
46952
  device_id: string;
47370
- /** User-friendly name to identify the climate schedule. */
46953
+ /** User-friendly name to identify the thermostat schedule. */
47371
46954
  name?: string | undefined;
47372
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
46955
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
47373
46956
  climate_preset_key: string;
47374
- /** 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). */
46957
+ /** 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). */
47375
46958
  max_override_period_minutes: number;
47376
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
46959
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
47377
46960
  starts_at: string;
47378
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
46961
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
47379
46962
  ends_at: string;
47380
- /** Date and time at which the climate schedule was created. */
46963
+ /** Date and time at which the thermostat schedule was created. */
47381
46964
  created_at: string;
47382
- /** 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. */
46965
+ /** 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. */
47383
46966
  errors?: any;
47384
46967
  } | null) | undefined;
47385
46968
  min_cooling_set_point_celsius?: number | undefined;
@@ -47869,24 +47452,25 @@ interface Routes {
47869
47452
  manual_override_allowed: boolean;
47870
47453
  }> | undefined;
47871
47454
  fallback_climate_preset_key?: (string | null) | undefined;
47455
+ /** 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. */
47872
47456
  active_thermostat_schedule?: ({
47873
- /** ID of the climate schedule. */
47457
+ /** ID of the thermostat schedule. */
47874
47458
  thermostat_schedule_id: string;
47875
47459
  /** ID of the desired thermostat device. */
47876
47460
  device_id: string;
47877
- /** User-friendly name to identify the climate schedule. */
47461
+ /** User-friendly name to identify the thermostat schedule. */
47878
47462
  name?: string | undefined;
47879
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
47463
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
47880
47464
  climate_preset_key: string;
47881
- /** 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). */
47465
+ /** 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). */
47882
47466
  max_override_period_minutes: number;
47883
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
47467
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
47884
47468
  starts_at: string;
47885
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
47469
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
47886
47470
  ends_at: string;
47887
- /** Date and time at which the climate schedule was created. */
47471
+ /** Date and time at which the thermostat schedule was created. */
47888
47472
  created_at: string;
47889
- /** 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. */
47473
+ /** 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. */
47890
47474
  errors?: any;
47891
47475
  } | null) | undefined;
47892
47476
  min_cooling_set_point_celsius?: number | undefined;
@@ -52354,24 +51938,25 @@ interface Routes {
52354
51938
  manual_override_allowed: boolean;
52355
51939
  }> | undefined;
52356
51940
  fallback_climate_preset_key?: (string | null) | undefined;
51941
+ /** 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. */
52357
51942
  active_thermostat_schedule?: ({
52358
- /** ID of the climate schedule. */
51943
+ /** ID of the thermostat schedule. */
52359
51944
  thermostat_schedule_id: string;
52360
51945
  /** ID of the desired thermostat device. */
52361
51946
  device_id: string;
52362
- /** User-friendly name to identify the climate schedule. */
51947
+ /** User-friendly name to identify the thermostat schedule. */
52363
51948
  name?: string | undefined;
52364
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
51949
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
52365
51950
  climate_preset_key: string;
52366
- /** 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). */
51951
+ /** 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). */
52367
51952
  max_override_period_minutes: number;
52368
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
51953
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
52369
51954
  starts_at: string;
52370
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
51955
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
52371
51956
  ends_at: string;
52372
- /** Date and time at which the climate schedule was created. */
51957
+ /** Date and time at which the thermostat schedule was created. */
52373
51958
  created_at: string;
52374
- /** 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. */
51959
+ /** 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. */
52375
51960
  errors?: any;
52376
51961
  } | null) | undefined;
52377
51962
  min_cooling_set_point_celsius?: number | undefined;
@@ -54380,24 +53965,25 @@ interface Routes {
54380
53965
  manual_override_allowed: boolean;
54381
53966
  }> | undefined;
54382
53967
  fallback_climate_preset_key?: (string | null) | undefined;
53968
+ /** 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. */
54383
53969
  active_thermostat_schedule?: ({
54384
- /** ID of the climate schedule. */
53970
+ /** ID of the thermostat schedule. */
54385
53971
  thermostat_schedule_id: string;
54386
53972
  /** ID of the desired thermostat device. */
54387
53973
  device_id: string;
54388
- /** User-friendly name to identify the climate schedule. */
53974
+ /** User-friendly name to identify the thermostat schedule. */
54389
53975
  name?: string | undefined;
54390
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
53976
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
54391
53977
  climate_preset_key: string;
54392
- /** 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). */
53978
+ /** 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). */
54393
53979
  max_override_period_minutes: number;
54394
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
53980
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54395
53981
  starts_at: string;
54396
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
53982
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54397
53983
  ends_at: string;
54398
- /** Date and time at which the climate schedule was created. */
53984
+ /** Date and time at which the thermostat schedule was created. */
54399
53985
  created_at: string;
54400
- /** 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. */
53986
+ /** 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. */
54401
53987
  errors?: any;
54402
53988
  } | null) | undefined;
54403
53989
  min_cooling_set_point_celsius?: number | undefined;
@@ -54887,24 +54473,25 @@ interface Routes {
54887
54473
  manual_override_allowed: boolean;
54888
54474
  }> | undefined;
54889
54475
  fallback_climate_preset_key?: (string | null) | undefined;
54476
+ /** 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. */
54890
54477
  active_thermostat_schedule?: ({
54891
- /** ID of the climate schedule. */
54478
+ /** ID of the thermostat schedule. */
54892
54479
  thermostat_schedule_id: string;
54893
54480
  /** ID of the desired thermostat device. */
54894
54481
  device_id: string;
54895
- /** User-friendly name to identify the climate schedule. */
54482
+ /** User-friendly name to identify the thermostat schedule. */
54896
54483
  name?: string | undefined;
54897
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
54484
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
54898
54485
  climate_preset_key: string;
54899
- /** 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). */
54486
+ /** 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). */
54900
54487
  max_override_period_minutes: number;
54901
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54488
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54902
54489
  starts_at: string;
54903
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54490
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
54904
54491
  ends_at: string;
54905
- /** Date and time at which the climate schedule was created. */
54492
+ /** Date and time at which the thermostat schedule was created. */
54906
54493
  created_at: string;
54907
- /** 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. */
54494
+ /** 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. */
54908
54495
  errors?: any;
54909
54496
  } | null) | undefined;
54910
54497
  min_cooling_set_point_celsius?: number | undefined;
@@ -55711,38 +55298,39 @@ interface Routes {
55711
55298
  jsonBody: {
55712
55299
  /** ID of the desired thermostat device. */
55713
55300
  device_id: string;
55714
- /** User-friendly name to identify the climate schedule. */
55301
+ /** User-friendly name to identify the thermostat schedule. */
55715
55302
  name?: string | undefined;
55716
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
55303
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
55717
55304
  climate_preset_key: string;
55718
- /** 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). */
55305
+ /** 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). */
55719
55306
  max_override_period_minutes?: number;
55720
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55307
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55721
55308
  starts_at: string;
55722
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55309
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55723
55310
  ends_at: string;
55724
55311
  };
55725
55312
  commonParams: {};
55726
55313
  formData: {};
55727
55314
  jsonResponse: {
55315
+ /** 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. */
55728
55316
  thermostat_schedule: {
55729
- /** ID of the climate schedule. */
55317
+ /** ID of the thermostat schedule. */
55730
55318
  thermostat_schedule_id: string;
55731
55319
  /** ID of the desired thermostat device. */
55732
55320
  device_id: string;
55733
- /** User-friendly name to identify the climate schedule. */
55321
+ /** User-friendly name to identify the thermostat schedule. */
55734
55322
  name?: string | undefined;
55735
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
55323
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
55736
55324
  climate_preset_key: string;
55737
- /** 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). */
55325
+ /** 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). */
55738
55326
  max_override_period_minutes: number;
55739
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55327
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55740
55328
  starts_at: string;
55741
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55329
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55742
55330
  ends_at: string;
55743
- /** Date and time at which the climate schedule was created. */
55331
+ /** Date and time at which the thermostat schedule was created. */
55744
55332
  created_at: string;
55745
- /** 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. */
55333
+ /** 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. */
55746
55334
  errors?: any;
55747
55335
  };
55748
55336
  };
@@ -55753,7 +55341,7 @@ interface Routes {
55753
55341
  queryParams: {};
55754
55342
  jsonBody: {};
55755
55343
  commonParams: {
55756
- /** ID of the desired climate schedule. */
55344
+ /** ID of the desired thermostat schedule. */
55757
55345
  thermostat_schedule_id: string;
55758
55346
  };
55759
55347
  formData: {};
@@ -55765,29 +55353,30 @@ interface Routes {
55765
55353
  queryParams: {};
55766
55354
  jsonBody: {};
55767
55355
  commonParams: {
55768
- /** ID of the desired climate schedule. */
55356
+ /** ID of the desired thermostat schedule. */
55769
55357
  thermostat_schedule_id: string;
55770
55358
  };
55771
55359
  formData: {};
55772
55360
  jsonResponse: {
55361
+ /** 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. */
55773
55362
  thermostat_schedule: {
55774
- /** ID of the climate schedule. */
55363
+ /** ID of the thermostat schedule. */
55775
55364
  thermostat_schedule_id: string;
55776
55365
  /** ID of the desired thermostat device. */
55777
55366
  device_id: string;
55778
- /** User-friendly name to identify the climate schedule. */
55367
+ /** User-friendly name to identify the thermostat schedule. */
55779
55368
  name?: string | undefined;
55780
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
55369
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
55781
55370
  climate_preset_key: string;
55782
- /** 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). */
55371
+ /** 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). */
55783
55372
  max_override_period_minutes: number;
55784
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55373
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55785
55374
  starts_at: string;
55786
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55375
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55787
55376
  ends_at: string;
55788
- /** Date and time at which the climate schedule was created. */
55377
+ /** Date and time at which the thermostat schedule was created. */
55789
55378
  created_at: string;
55790
- /** 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. */
55379
+ /** 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. */
55791
55380
  errors?: any;
55792
55381
  };
55793
55382
  };
@@ -55800,29 +55389,29 @@ interface Routes {
55800
55389
  commonParams: {
55801
55390
  /** ID of the desired thermostat device. */
55802
55391
  device_id: string;
55803
- /** User identifier key by which to filter the list of returned climate schedules. */
55392
+ /** User identifier key by which to filter the list of returned thermostat schedules. */
55804
55393
  user_identifier_key?: string | undefined;
55805
55394
  };
55806
55395
  formData: {};
55807
55396
  jsonResponse: {
55808
55397
  thermostat_schedules: Array<{
55809
- /** ID of the climate schedule. */
55398
+ /** ID of the thermostat schedule. */
55810
55399
  thermostat_schedule_id: string;
55811
55400
  /** ID of the desired thermostat device. */
55812
55401
  device_id: string;
55813
- /** User-friendly name to identify the climate schedule. */
55402
+ /** User-friendly name to identify the thermostat schedule. */
55814
55403
  name?: string | undefined;
55815
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
55404
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
55816
55405
  climate_preset_key: string;
55817
- /** 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). */
55406
+ /** 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). */
55818
55407
  max_override_period_minutes: number;
55819
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55408
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55820
55409
  starts_at: string;
55821
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55410
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55822
55411
  ends_at: string;
55823
- /** Date and time at which the climate schedule was created. */
55412
+ /** Date and time at which the thermostat schedule was created. */
55824
55413
  created_at: string;
55825
- /** 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. */
55414
+ /** 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. */
55826
55415
  errors?: any;
55827
55416
  }>;
55828
55417
  };
@@ -55832,17 +55421,17 @@ interface Routes {
55832
55421
  method: 'PATCH' | 'POST';
55833
55422
  queryParams: {};
55834
55423
  jsonBody: {
55835
- /** ID of the desired climate schedule. */
55424
+ /** ID of the desired thermostat schedule. */
55836
55425
  thermostat_schedule_id: string;
55837
- /** User-friendly name to identify the climate schedule. */
55426
+ /** User-friendly name to identify the thermostat schedule. */
55838
55427
  name?: string | undefined;
55839
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
55428
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
55840
55429
  climate_preset_key?: string | undefined;
55841
- /** 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). */
55430
+ /** 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). */
55842
55431
  max_override_period_minutes?: number | undefined;
55843
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55432
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55844
55433
  starts_at?: string | undefined;
55845
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55434
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
55846
55435
  ends_at?: string | undefined;
55847
55436
  };
55848
55437
  commonParams: {};
@@ -57268,24 +56857,25 @@ interface Routes {
57268
56857
  manual_override_allowed: boolean;
57269
56858
  }> | undefined;
57270
56859
  fallback_climate_preset_key?: (string | null) | undefined;
56860
+ /** 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. */
57271
56861
  active_thermostat_schedule?: ({
57272
- /** ID of the climate schedule. */
56862
+ /** ID of the thermostat schedule. */
57273
56863
  thermostat_schedule_id: string;
57274
56864
  /** ID of the desired thermostat device. */
57275
56865
  device_id: string;
57276
- /** User-friendly name to identify the climate schedule. */
56866
+ /** User-friendly name to identify the thermostat schedule. */
57277
56867
  name?: string | undefined;
57278
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
56868
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
57279
56869
  climate_preset_key: string;
57280
- /** 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). */
56870
+ /** 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). */
57281
56871
  max_override_period_minutes: number;
57282
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
56872
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
57283
56873
  starts_at: string;
57284
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
56874
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
57285
56875
  ends_at: string;
57286
- /** Date and time at which the climate schedule was created. */
56876
+ /** Date and time at which the thermostat schedule was created. */
57287
56877
  created_at: string;
57288
- /** 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. */
56878
+ /** 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. */
57289
56879
  errors?: any;
57290
56880
  } | null) | undefined;
57291
56881
  min_cooling_set_point_celsius?: number | undefined;
@@ -57777,24 +57367,25 @@ interface Routes {
57777
57367
  manual_override_allowed: boolean;
57778
57368
  }> | undefined;
57779
57369
  fallback_climate_preset_key?: (string | null) | undefined;
57370
+ /** 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. */
57780
57371
  active_thermostat_schedule?: ({
57781
- /** ID of the climate schedule. */
57372
+ /** ID of the thermostat schedule. */
57782
57373
  thermostat_schedule_id: string;
57783
57374
  /** ID of the desired thermostat device. */
57784
57375
  device_id: string;
57785
- /** User-friendly name to identify the climate schedule. */
57376
+ /** User-friendly name to identify the thermostat schedule. */
57786
57377
  name?: string | undefined;
57787
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the climate schedule. */
57378
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
57788
57379
  climate_preset_key: string;
57789
- /** 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). */
57380
+ /** 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). */
57790
57381
  max_override_period_minutes: number;
57791
- /** Date and time at which the climate schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
57382
+ /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
57792
57383
  starts_at: string;
57793
- /** Date and time at which the climate schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
57384
+ /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
57794
57385
  ends_at: string;
57795
- /** Date and time at which the climate schedule was created. */
57386
+ /** Date and time at which the thermostat schedule was created. */
57796
57387
  created_at: string;
57797
- /** 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. */
57388
+ /** 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. */
57798
57389
  errors?: any;
57799
57390
  } | null) | undefined;
57800
57391
  min_cooling_set_point_celsius?: number | undefined;