@seamapi/types 1.292.1 → 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: {
@@ -20970,7 +20971,7 @@ declare const _default: {
20970
20971
  format: string;
20971
20972
  type: string;
20972
20973
  };
20973
- device_id: {
20974
+ acs_encoder_id: {
20974
20975
  description: string;
20975
20976
  format: string;
20976
20977
  type: string;
@@ -21040,14 +21041,14 @@ declare const _default: {
21040
21041
  schema: {
21041
21042
  oneOf: ({
21042
21043
  properties: {
21043
- acs_system_ids: {
21044
+ acs_encoder_ids: {
21044
21045
  items: {
21045
21046
  format: string;
21046
21047
  type: string;
21047
21048
  };
21048
21049
  type: string;
21049
21050
  };
21050
- device_ids: {
21051
+ acs_system_ids: {
21051
21052
  items: {
21052
21053
  format: string;
21053
21054
  type: string;
@@ -21064,7 +21065,7 @@ declare const _default: {
21064
21065
  type: string;
21065
21066
  } | {
21066
21067
  properties: {
21067
- device_ids: {
21068
+ acs_encoder_ids: {
21068
21069
  items: {
21069
21070
  format: string;
21070
21071
  type: string;
@@ -21094,7 +21095,7 @@ declare const _default: {
21094
21095
  format: string;
21095
21096
  type: string;
21096
21097
  };
21097
- device_ids?: never;
21098
+ acs_encoder_ids?: never;
21098
21099
  };
21099
21100
  required: string[];
21100
21101
  type: string;
@@ -21109,9 +21110,66 @@ declare const _default: {
21109
21110
  'application/json': {
21110
21111
  schema: {
21111
21112
  properties: {
21112
- devices: {
21113
+ acs_encoders: {
21113
21114
  items: {
21114
- $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;
21115
21173
  };
21116
21174
  type: string;
21117
21175
  };
@@ -21163,12 +21221,12 @@ declare const _default: {
21163
21221
  'application/json': {
21164
21222
  schema: {
21165
21223
  properties: {
21166
- acs_system_id: {
21224
+ acs_encoder_id: {
21167
21225
  description: string;
21168
21226
  format: string;
21169
21227
  type: string;
21170
21228
  };
21171
- device_id: {
21229
+ acs_system_id: {
21172
21230
  description: string;
21173
21231
  format: string;
21174
21232
  type: string;
@@ -36713,8 +36771,8 @@ interface Routes {
36713
36771
  queryParams: {};
36714
36772
  jsonBody: {};
36715
36773
  commonParams: {
36716
- /** ID of the encoder to use for the encoding. */
36717
- device_id: string;
36774
+ /** ID of the acs_encoder to use for the encoding. */
36775
+ acs_encoder_id: string;
36718
36776
  /** ID of the acs_credential to encode on a physical card. */
36719
36777
  acs_credential_id: string;
36720
36778
  };
@@ -37449,10 +37507,10 @@ interface Routes {
37449
37507
  jsonBody: {};
37450
37508
  commonParams: {
37451
37509
  acs_system_ids: string[];
37452
- device_ids: string[];
37510
+ acs_encoder_ids: string[];
37453
37511
  limit?: number;
37454
37512
  } | {
37455
- device_ids: string[];
37513
+ acs_encoder_ids: string[];
37456
37514
  limit?: number;
37457
37515
  } | {
37458
37516
  acs_system_ids: string[];
@@ -37460,513 +37518,28 @@ interface Routes {
37460
37518
  };
37461
37519
  formData: {};
37462
37520
  jsonResponse: {
37463
- devices: Array<{
37464
- /** Unique identifier for the device. */
37465
- device_id: string;
37466
- /** Type of the device. */
37467
- 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');
37468
- /** Optional nickname to describe the device, settable through Seam */
37469
- nickname?: string | undefined;
37470
- /** 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. */
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`. */
37527
+ workspace_id: string;
37528
+ /** Errors associated with the `acs_encoder`. */
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. */
37533
+ message: 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;
37538
+ }>;
37539
+ /** Date and time at which the `acs_encoder` was created. */
37540
+ created_at: string;
37541
+ /** Display name for the `acs_encoder`. */
37471
37542
  display_name: string;
37472
- /** 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. */
37473
- capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
37474
- /** Properties of the device. */
37475
- properties: (({
37476
- /** Indicates whether the device is online. */
37477
- online: boolean;
37478
- /** Name of the device.
37479
- * @deprecated use device.display_name instead */
37480
- name: string;
37481
- /** Represents the accessory keypad state. */
37482
- accessory_keypad?: {
37483
- /** Indicates if the accessory_keypad is connected to the device. */
37484
- is_connected: boolean;
37485
- /** Indicates if the keypad battery properties. */
37486
- battery?: {
37487
- level: number;
37488
- } | undefined;
37489
- } | undefined;
37490
- appearance: {
37491
- /** Name of the device as seen from the provider API and application, not settable through Seam. */
37492
- name: string;
37493
- };
37494
- model: {
37495
- /** Indicates whether the device can connect a accessory keypad. */
37496
- can_connect_accessory_keypad?: boolean | undefined;
37497
- /** Display name of the device model. */
37498
- display_name: string;
37499
- /** Display name that corresponds to the manufacturer-specific terminology for the device. */
37500
- manufacturer_display_name: string;
37501
- /** Indicates whether the device has a built in accessory keypad. */
37502
- has_built_in_keypad?: boolean | undefined;
37503
- /** Indicates whether the device supports offline access codes. */
37504
- offline_access_codes_supported?: boolean | undefined;
37505
- /** Indicates whether the device supports online access codes. */
37506
- online_access_codes_supported?: boolean | undefined;
37507
- /**
37508
- * @deprecated use device.properties.model.can_connect_accessory_keypad */
37509
- accessory_keypad_supported?: boolean | undefined;
37510
- };
37511
- /** Indicates whether the device has direct power. */
37512
- has_direct_power?: boolean | undefined;
37513
- /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
37514
- battery_level?: number | undefined;
37515
- /** 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. */
37516
- battery?: {
37517
- level: number;
37518
- status: 'critical' | 'low' | 'good' | 'full';
37519
- } | undefined;
37520
- /** Manufacturer of the device. */
37521
- manufacturer?: string | undefined;
37522
- /** Image URL for the device. */
37523
- image_url?: string | undefined;
37524
- /** Alt text for the device image. */
37525
- image_alt_text?: string | undefined;
37526
- /** Serial number of the device. */
37527
- serial_number?: string | undefined;
37528
- /** Indicates whether it is currently possible to use online access codes for the device. */
37529
- online_access_codes_enabled?: boolean | undefined;
37530
- /** Indicates whether it is currently possible to use offline access codes for the device. */
37531
- offline_access_codes_enabled?: boolean | undefined;
37532
- /**
37533
- * @deprecated use device.properties.model.can_connect_accessory_keypad */
37534
- supports_accessory_keypad?: boolean | undefined;
37535
- /**
37536
- * @deprecated use offline_access_codes_enabled */
37537
- supports_offline_access_codes?: boolean | undefined;
37538
- /** Indicates current noise level in decibels, if the device supports noise detection. */
37539
- noise_level_decibels?: number | undefined;
37540
- /** Array of noise threshold IDs that are currently triggering. */
37541
- currently_triggering_noise_threshold_ids?: string[] | undefined;
37542
- } & {
37543
- assa_abloy_credential_service_metadata?: ({
37544
- has_active_endpoint: boolean;
37545
- endpoints: Array<{
37546
- endpoint_id: string;
37547
- is_active: boolean;
37548
- }>;
37549
- } | undefined) | undefined;
37550
- }) & {
37551
- august_metadata?: {
37552
- lock_id: string;
37553
- lock_name: string;
37554
- house_name: string;
37555
- has_keypad: boolean;
37556
- keypad_battery_level?: string | undefined;
37557
- model?: string | undefined;
37558
- house_id?: string | undefined;
37559
- } | undefined;
37560
- avigilon_alta_metadata?: {
37561
- entry_name: string;
37562
- org_name: string;
37563
- zone_id: number;
37564
- zone_name: string;
37565
- site_id: number;
37566
- site_name: string;
37567
- entry_relays_total_count: number;
37568
- } | undefined;
37569
- schlage_metadata?: {
37570
- device_id: string;
37571
- device_name: string;
37572
- access_code_length: number | null;
37573
- model?: string | undefined;
37574
- } | undefined;
37575
- smartthings_metadata?: {
37576
- device_id: string;
37577
- device_name: string;
37578
- model?: string | undefined;
37579
- location_id?: string | undefined;
37580
- } | undefined;
37581
- lockly_metadata?: {
37582
- device_id: string;
37583
- device_name: string;
37584
- model?: string | undefined;
37585
- } | undefined;
37586
- nuki_metadata?: {
37587
- device_id: string;
37588
- device_name: string;
37589
- keypad_battery_critical?: boolean | undefined;
37590
- keypad_paired?: boolean | undefined;
37591
- keypad_2_paired?: boolean | undefined;
37592
- } | undefined;
37593
- kwikset_metadata?: {
37594
- device_id: string;
37595
- device_name: string;
37596
- model_number: string;
37597
- } | undefined;
37598
- /**
37599
- ---
37600
- deprecated: Use `salto_ks_metadata ` instead.
37601
- */
37602
- salto_metadata?: {
37603
- lock_id: string;
37604
- customer_reference: string;
37605
- lock_type: string;
37606
- battery_level: string;
37607
- locked_state: string;
37608
- model?: string | undefined;
37609
- } | undefined;
37610
- salto_ks_metadata?: {
37611
- lock_id: string;
37612
- customer_reference: string;
37613
- lock_type: string;
37614
- battery_level: string;
37615
- locked_state: string;
37616
- model?: string | undefined;
37617
- } | undefined;
37618
- genie_metadata?: {
37619
- device_name: string;
37620
- door_name: string;
37621
- } | undefined;
37622
- brivo_metadata?: {
37623
- device_name: string;
37624
- } | undefined;
37625
- igloo_metadata?: {
37626
- device_id: string;
37627
- bridge_id: string;
37628
- model?: string | undefined;
37629
- } | undefined;
37630
- noiseaware_metadata?: {
37631
- device_model: 'indoor' | 'outdoor';
37632
- noise_level_nrs: number;
37633
- noise_level_decibel: number;
37634
- device_name: string;
37635
- device_id: string;
37636
- } | undefined;
37637
- minut_metadata?: {
37638
- device_id: string;
37639
- device_name: string;
37640
- latest_sensor_values: {
37641
- temperature: {
37642
- time: string;
37643
- value: number;
37644
- };
37645
- sound: {
37646
- time: string;
37647
- value: number;
37648
- };
37649
- humidity: {
37650
- time: string;
37651
- value: number;
37652
- };
37653
- pressure: {
37654
- time: string;
37655
- value: number;
37656
- };
37657
- accelerometer_z: {
37658
- time: string;
37659
- value: number;
37660
- };
37661
- };
37662
- } | undefined;
37663
- four_suites_metadata?: {
37664
- device_id: number;
37665
- device_name: string;
37666
- reclose_delay_in_seconds: number;
37667
- } | undefined;
37668
- two_n_metadata?: {
37669
- device_id: number;
37670
- device_name: string;
37671
- } | undefined;
37672
- controlbyweb_metadata?: {
37673
- device_id: string;
37674
- device_name: string;
37675
- relay_name: string | null;
37676
- } | undefined;
37677
- ttlock_metadata?: {
37678
- lock_id: number;
37679
- lock_alias: string;
37680
- feature_value: string;
37681
- features: {
37682
- passcode: boolean;
37683
- passcode_management: boolean;
37684
- unlock_via_gateway: boolean;
37685
- lock_command: boolean;
37686
- incomplete_keyboard_passcode: boolean;
37687
- };
37688
- has_gateway?: boolean | undefined;
37689
- wireless_keypads?: Array<{
37690
- wireless_keypad_id: number;
37691
- wireless_keypad_name: string;
37692
- }> | undefined;
37693
- } | undefined;
37694
- seam_bridge_metadata?: {
37695
- unlock_method?: ('bridge' | 'doorking') | undefined;
37696
- device_num: number;
37697
- name: string;
37698
- } | undefined;
37699
- igloohome_metadata?: {
37700
- device_id: string;
37701
- device_name: string;
37702
- bridge_id?: string | undefined;
37703
- bridge_name?: string | undefined;
37704
- keypad_id?: string | undefined;
37705
- } | undefined;
37706
- nest_metadata?: {
37707
- nest_device_id: string;
37708
- device_name: string;
37709
- custom_name: string;
37710
- display_name?: string | undefined;
37711
- } | undefined;
37712
- ecobee_metadata?: {
37713
- ecobee_device_id: string;
37714
- device_name: string;
37715
- } | undefined;
37716
- honeywell_resideo_metadata?: {
37717
- honeywell_resideo_device_id: string;
37718
- device_name: string;
37719
- } | undefined;
37720
- hubitat_metadata?: {
37721
- device_id: string;
37722
- device_name: string;
37723
- device_label: string;
37724
- } | undefined;
37725
- dormakaba_oracode_metadata?: {
37726
- door_id?: number | undefined;
37727
- door_name: string;
37728
- device_id?: (number | string) | undefined;
37729
- door_is_wireless: boolean;
37730
- /** @DEPRECATED */
37731
- site_id: number | null;
37732
- site_name: string;
37733
- iana_timezone?: string | undefined;
37734
- predefined_time_slots?: Array<{
37735
- name: string;
37736
- prefix: number;
37737
- check_in_time: string;
37738
- check_out_time: string;
37739
- is_24_hour: boolean;
37740
- is_biweekly_mode: boolean;
37741
- is_one_shot: boolean;
37742
- is_master: boolean;
37743
- ext_dormakaba_oracode_user_level_prefix: number;
37744
- dormakaba_oracode_user_level_id: string;
37745
- }> | undefined;
37746
- } | undefined;
37747
- wyze_metadata?: {
37748
- device_id: string;
37749
- device_name: string;
37750
- product_name: string;
37751
- product_type: string;
37752
- product_model: string;
37753
- device_info_model: string;
37754
- keypad_uuid?: string | undefined;
37755
- locker_status_hardlock?: number | undefined;
37756
- } | undefined;
37757
- tedee_metadata?: {
37758
- device_id: number;
37759
- serial_number: string;
37760
- device_name: string;
37761
- device_model: string;
37762
- bridge_id: number;
37763
- bridge_name: string;
37764
- keypad_id?: number | undefined;
37765
- } | undefined;
37766
- visionline_metadata?: {
37767
- encoder_id: string;
37768
- } | undefined;
37769
- akiles_metadata?: {
37770
- gadget_name: string;
37771
- gadget_id: string;
37772
- product_name: string;
37773
- _member_group_id?: string | undefined;
37774
- } | undefined;
37775
- assa_abloy_vostio_metadata?: {
37776
- encoder_name: string;
37777
- } | undefined;
37778
- }) & ({
37779
- _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
37780
- code_constraints?: (Array<{
37781
- 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';
37782
- } | {
37783
- constraint_type: 'name_length' | 'name_must_be_unique';
37784
- min_length?: number | undefined;
37785
- max_length?: number | undefined;
37786
- }> | undefined) | undefined;
37787
- supported_code_lengths?: (number[] | undefined) | undefined;
37788
- max_active_codes_supported?: (number | undefined) | undefined;
37789
- supports_backup_access_code_pool?: (boolean | undefined) | undefined;
37790
- has_native_entry_events?: (boolean | undefined) | undefined;
37791
- locked?: (boolean | undefined) | undefined;
37792
- keypad_battery?: ({
37793
- level: number;
37794
- } | undefined) | undefined;
37795
- door_open?: (boolean | undefined) | undefined;
37796
- } & {
37797
- temperature_fahrenheit?: number | undefined;
37798
- temperature_celsius?: number | undefined;
37799
- relative_humidity?: number | undefined;
37800
- available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
37801
- available_fan_mode_settings?: Array<'auto' | 'on' | 'circulate'> | undefined;
37802
- is_heating?: boolean | undefined;
37803
- is_cooling?: boolean | undefined;
37804
- is_fan_running?: boolean | undefined;
37805
- /**
37806
- * @deprecated use current_climate_setting.fan_mode_setting instead. */
37807
- fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
37808
- is_temporary_manual_override_active?: boolean | undefined;
37809
- current_climate_setting?: {
37810
- /** Unique key to identify the climate preset. */
37811
- climate_preset_key?: string | undefined;
37812
- /** Indicates whether this climate preset key can be edited. */
37813
- can_edit?: boolean | undefined;
37814
- /** Indicates whether this climate preset key can be deleted. */
37815
- can_delete?: boolean | undefined;
37816
- /** User-friendly name to identify the climate preset. */
37817
- name?: ((string | null) | undefined) | undefined;
37818
- /** Display name for the climate preset. */
37819
- display_name?: string | undefined;
37820
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37821
- fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
37822
- /** 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`. */
37823
- hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
37824
- /** 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). */
37825
- cooling_set_point_celsius?: (number | undefined) | undefined;
37826
- /** Temperature to which the thermostat should heat (in °C). */
37827
- heating_set_point_celsius?: (number | undefined) | undefined;
37828
- /** Temperature to which the thermostat should cool (in °F). */
37829
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
37830
- /** Temperature to which the thermostat should heat (in °F). */
37831
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
37832
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37833
- manual_override_allowed?: boolean | undefined;
37834
- } | undefined;
37835
- /**
37836
- * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
37837
- default_climate_setting?: {
37838
- /** Unique key to identify the climate preset. */
37839
- climate_preset_key?: string | undefined;
37840
- /** Indicates whether this climate preset key can be edited. */
37841
- can_edit?: boolean | undefined;
37842
- /** Indicates whether this climate preset key can be deleted. */
37843
- can_delete?: boolean | undefined;
37844
- /** User-friendly name to identify the climate preset. */
37845
- name?: ((string | null) | undefined) | undefined;
37846
- /** Display name for the climate preset. */
37847
- display_name?: string | undefined;
37848
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37849
- fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
37850
- /** 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`. */
37851
- hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
37852
- /** 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). */
37853
- cooling_set_point_celsius?: (number | undefined) | undefined;
37854
- /** Temperature to which the thermostat should heat (in °C). */
37855
- heating_set_point_celsius?: (number | undefined) | undefined;
37856
- /** Temperature to which the thermostat should cool (in °F). */
37857
- cooling_set_point_fahrenheit?: (number | undefined) | undefined;
37858
- /** Temperature to which the thermostat should heat (in °F). */
37859
- heating_set_point_fahrenheit?: (number | undefined) | undefined;
37860
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37861
- manual_override_allowed?: boolean | undefined;
37862
- } | undefined;
37863
- available_climate_presets?: Array<{
37864
- /** Unique key to identify the climate preset. */
37865
- climate_preset_key: string;
37866
- /** Indicates whether this climate preset key can be edited. */
37867
- can_edit: boolean;
37868
- /** Indicates whether this climate preset key can be deleted. */
37869
- can_delete: boolean;
37870
- /** User-friendly name to identify the climate preset. */
37871
- name?: (string | null) | undefined;
37872
- /** Display name for the climate preset. */
37873
- display_name: string;
37874
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
37875
- fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
37876
- /** 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`. */
37877
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
37878
- /** 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). */
37879
- cooling_set_point_celsius?: number | undefined;
37880
- /** Temperature to which the thermostat should heat (in °C). */
37881
- heating_set_point_celsius?: number | undefined;
37882
- /** Temperature to which the thermostat should cool (in °F). */
37883
- cooling_set_point_fahrenheit?: number | undefined;
37884
- /** Temperature to which the thermostat should heat (in °F). */
37885
- heating_set_point_fahrenheit?: number | undefined;
37886
- /** Indicates whether a person at the thermostat can change the thermostat's settings. */
37887
- manual_override_allowed: boolean;
37888
- }> | undefined;
37889
- fallback_climate_preset_key?: (string | null) | undefined;
37890
- /** 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. */
37891
- active_thermostat_schedule?: ({
37892
- /** ID of the thermostat schedule. */
37893
- thermostat_schedule_id: string;
37894
- /** ID of the desired thermostat device. */
37895
- device_id: string;
37896
- /** User-friendly name to identify the thermostat schedule. */
37897
- name?: string | undefined;
37898
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
37899
- climate_preset_key: string;
37900
- /** 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). */
37901
- max_override_period_minutes: number;
37902
- /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
37903
- starts_at: string;
37904
- /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
37905
- ends_at: string;
37906
- /** Date and time at which the thermostat schedule was created. */
37907
- created_at: string;
37908
- /** 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. */
37909
- errors?: any;
37910
- } | null) | undefined;
37911
- min_cooling_set_point_celsius?: number | undefined;
37912
- min_cooling_set_point_fahrenheit?: number | undefined;
37913
- max_cooling_set_point_celsius?: number | undefined;
37914
- max_cooling_set_point_fahrenheit?: number | undefined;
37915
- min_heating_set_point_celsius?: number | undefined;
37916
- min_heating_set_point_fahrenheit?: number | undefined;
37917
- max_heating_set_point_celsius?: number | undefined;
37918
- max_heating_set_point_fahrenheit?: number | undefined;
37919
- min_heating_cooling_delta_celsius?: number | undefined;
37920
- min_heating_cooling_delta_fahrenheit?: number | undefined;
37921
- temperature_threshold?: ({
37922
- lower_limit_celsius: number | null;
37923
- lower_limit_fahrenheit: number | null;
37924
- upper_limit_celsius: number | null;
37925
- upper_limit_fahrenheit: number | null;
37926
- } | undefined) | undefined;
37927
- });
37928
- /** Location information for the device. */
37929
- location: {
37930
- /** Name of the device location. */
37931
- location_name?: string | undefined;
37932
- /** Time zone of the device location. */
37933
- timezone?: string | undefined;
37934
- } | null;
37935
- /** Unique identifier for the account associated with the device. */
37936
- connected_account_id: string;
37937
- /** Unique identifier for the Seam workspace associated with the device. */
37938
- workspace_id: string;
37939
- /** 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. */
37940
- errors: Array<{
37941
- message: string;
37942
- is_device_error: true;
37943
- error_code: string;
37944
- } | {
37945
- message: string;
37946
- is_connected_account_error: true;
37947
- error_code: string;
37948
- }>;
37949
- /** 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. */
37950
- warnings: Array<{
37951
- message: string;
37952
- warning_code: string;
37953
- }>;
37954
- /** Date and time at which the device object was created. */
37955
- created_at: string;
37956
- /** Indicates whether Seam manages the device. */
37957
- is_managed: true;
37958
- custom_metadata: Record<string, string | boolean>;
37959
- can_remotely_unlock?: boolean | undefined;
37960
- can_remotely_lock?: boolean | undefined;
37961
- can_program_offline_access_codes?: boolean | undefined;
37962
- can_program_online_access_codes?: boolean | undefined;
37963
- can_hvac_heat?: boolean | undefined;
37964
- can_hvac_cool?: boolean | undefined;
37965
- can_hvac_heat_cool?: boolean | undefined;
37966
- can_turn_off_hvac?: boolean | undefined;
37967
- can_simulate_removal?: boolean | undefined;
37968
- can_simulate_connection?: boolean | undefined;
37969
- can_simulate_disconnection?: boolean | undefined;
37970
37543
  }>;
37971
37544
  };
37972
37545
  };
@@ -37978,8 +37551,8 @@ interface Routes {
37978
37551
  commonParams: {
37979
37552
  /** ID of the acs_system the encoder belongs to. */
37980
37553
  acs_system_id: string;
37981
- /** ID of the encoder to use for the scan. */
37982
- device_id: string;
37554
+ /** ID of the acs_encoder to use for the scan. */
37555
+ acs_encoder_id: string;
37983
37556
  };
37984
37557
  formData: {};
37985
37558
  jsonResponse: {