@seamapi/types 1.256.0 → 1.258.0

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.
@@ -433,6 +433,7 @@ declare const acs_credential: z.ZodObject<z.objectUtil.extendShape<{
433
433
  guest_acs_entrance_ids: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
434
434
  common_acs_entrance_ids: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
435
435
  is_valid: z.ZodOptional<z.ZodBoolean>;
436
+ auto_join: z.ZodOptional<z.ZodBoolean>;
436
437
  card_id: z.ZodOptional<z.ZodString>;
437
438
  credential_id: z.ZodOptional<z.ZodString>;
438
439
  }, "strip", z.ZodTypeAny, {
@@ -441,6 +442,7 @@ declare const acs_credential: z.ZodObject<z.objectUtil.extendShape<{
441
442
  guest_acs_entrance_ids?: string[] | undefined;
442
443
  common_acs_entrance_ids?: string[] | undefined;
443
444
  is_valid?: boolean | undefined;
445
+ auto_join?: boolean | undefined;
444
446
  card_id?: string | undefined;
445
447
  credential_id?: string | undefined;
446
448
  }, {
@@ -449,6 +451,7 @@ declare const acs_credential: z.ZodObject<z.objectUtil.extendShape<{
449
451
  guest_acs_entrance_ids?: string[] | undefined;
450
452
  common_acs_entrance_ids?: string[] | undefined;
451
453
  is_valid?: boolean | undefined;
454
+ auto_join?: boolean | undefined;
452
455
  card_id?: string | undefined;
453
456
  credential_id?: string | undefined;
454
457
  }>>;
@@ -479,6 +482,7 @@ declare const acs_credential: z.ZodObject<z.objectUtil.extendShape<{
479
482
  guest_acs_entrance_ids?: string[] | undefined;
480
483
  common_acs_entrance_ids?: string[] | undefined;
481
484
  is_valid?: boolean | undefined;
485
+ auto_join?: boolean | undefined;
482
486
  card_id?: string | undefined;
483
487
  credential_id?: string | undefined;
484
488
  } | undefined;
@@ -518,6 +522,7 @@ declare const acs_credential: z.ZodObject<z.objectUtil.extendShape<{
518
522
  guest_acs_entrance_ids?: string[] | undefined;
519
523
  common_acs_entrance_ids?: string[] | undefined;
520
524
  is_valid?: boolean | undefined;
525
+ auto_join?: boolean | undefined;
521
526
  card_id?: string | undefined;
522
527
  credential_id?: string | undefined;
523
528
  } | undefined;
@@ -580,6 +585,7 @@ declare const unmanaged_acs_credential: z.ZodObject<z.objectUtil.extendShape<{
580
585
  guest_acs_entrance_ids: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
581
586
  common_acs_entrance_ids: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
582
587
  is_valid: z.ZodOptional<z.ZodBoolean>;
588
+ auto_join: z.ZodOptional<z.ZodBoolean>;
583
589
  card_id: z.ZodOptional<z.ZodString>;
584
590
  credential_id: z.ZodOptional<z.ZodString>;
585
591
  }, "strip", z.ZodTypeAny, {
@@ -588,6 +594,7 @@ declare const unmanaged_acs_credential: z.ZodObject<z.objectUtil.extendShape<{
588
594
  guest_acs_entrance_ids?: string[] | undefined;
589
595
  common_acs_entrance_ids?: string[] | undefined;
590
596
  is_valid?: boolean | undefined;
597
+ auto_join?: boolean | undefined;
591
598
  card_id?: string | undefined;
592
599
  credential_id?: string | undefined;
593
600
  }, {
@@ -596,6 +603,7 @@ declare const unmanaged_acs_credential: z.ZodObject<z.objectUtil.extendShape<{
596
603
  guest_acs_entrance_ids?: string[] | undefined;
597
604
  common_acs_entrance_ids?: string[] | undefined;
598
605
  is_valid?: boolean | undefined;
606
+ auto_join?: boolean | undefined;
599
607
  card_id?: string | undefined;
600
608
  credential_id?: string | undefined;
601
609
  }>>;
@@ -626,6 +634,7 @@ declare const unmanaged_acs_credential: z.ZodObject<z.objectUtil.extendShape<{
626
634
  guest_acs_entrance_ids?: string[] | undefined;
627
635
  common_acs_entrance_ids?: string[] | undefined;
628
636
  is_valid?: boolean | undefined;
637
+ auto_join?: boolean | undefined;
629
638
  card_id?: string | undefined;
630
639
  credential_id?: string | undefined;
631
640
  } | undefined;
@@ -665,6 +674,7 @@ declare const unmanaged_acs_credential: z.ZodObject<z.objectUtil.extendShape<{
665
674
  guest_acs_entrance_ids?: string[] | undefined;
666
675
  common_acs_entrance_ids?: string[] | undefined;
667
676
  is_valid?: boolean | undefined;
677
+ auto_join?: boolean | undefined;
668
678
  card_id?: string | undefined;
669
679
  credential_id?: string | undefined;
670
680
  } | undefined;
@@ -10012,6 +10022,9 @@ declare const _default: {
10012
10022
  };
10013
10023
  visionline_metadata: {
10014
10024
  properties: {
10025
+ auto_join: {
10026
+ type: string;
10027
+ };
10015
10028
  card_function_type: {
10016
10029
  enum: string[];
10017
10030
  type: string;
@@ -16454,6 +16467,9 @@ declare const _default: {
16454
16467
  format: string;
16455
16468
  type: string;
16456
16469
  };
16470
+ auto_join: {
16471
+ type: string;
16472
+ };
16457
16473
  card_format: {
16458
16474
  enum: string[];
16459
16475
  type: string;
@@ -17124,6 +17140,9 @@ declare const _default: {
17124
17140
  };
17125
17141
  visionline_metadata: {
17126
17142
  properties: {
17143
+ auto_join: {
17144
+ type: string;
17145
+ };
17127
17146
  card_function_type: {
17128
17147
  enum: string[];
17129
17148
  type: string;
@@ -17383,6 +17402,9 @@ declare const _default: {
17383
17402
  };
17384
17403
  visionline_metadata: {
17385
17404
  properties: {
17405
+ auto_join: {
17406
+ type: string;
17407
+ };
17386
17408
  card_function_type: {
17387
17409
  enum: string[];
17388
17410
  type: string;
@@ -17709,6 +17731,128 @@ declare const _default: {
17709
17731
  'x-undocumented': string;
17710
17732
  };
17711
17733
  };
17734
+ '/acs/encoders/list': {
17735
+ post: {
17736
+ operationId: string;
17737
+ requestBody: {
17738
+ content: {
17739
+ 'application/json': {
17740
+ schema: {
17741
+ oneOf: ({
17742
+ properties: {
17743
+ acs_system_ids: {
17744
+ items: {
17745
+ format: string;
17746
+ type: string;
17747
+ };
17748
+ type: string;
17749
+ };
17750
+ device_ids: {
17751
+ items: {
17752
+ format: string;
17753
+ type: string;
17754
+ };
17755
+ type: string;
17756
+ };
17757
+ limit: {
17758
+ default: number;
17759
+ format: string;
17760
+ type: string;
17761
+ };
17762
+ };
17763
+ required: string[];
17764
+ type: string;
17765
+ } | {
17766
+ properties: {
17767
+ device_ids: {
17768
+ items: {
17769
+ format: string;
17770
+ type: string;
17771
+ };
17772
+ type: string;
17773
+ };
17774
+ limit: {
17775
+ default: number;
17776
+ format: string;
17777
+ type: string;
17778
+ };
17779
+ acs_system_ids?: never;
17780
+ };
17781
+ required: string[];
17782
+ type: string;
17783
+ } | {
17784
+ properties: {
17785
+ acs_system_ids: {
17786
+ items: {
17787
+ format: string;
17788
+ type: string;
17789
+ };
17790
+ type: string;
17791
+ };
17792
+ limit: {
17793
+ default: number;
17794
+ format: string;
17795
+ type: string;
17796
+ };
17797
+ device_ids?: never;
17798
+ };
17799
+ required: string[];
17800
+ type: string;
17801
+ })[];
17802
+ };
17803
+ };
17804
+ };
17805
+ };
17806
+ responses: {
17807
+ 200: {
17808
+ content: {
17809
+ 'application/json': {
17810
+ schema: {
17811
+ properties: {
17812
+ devices: {
17813
+ items: {
17814
+ $ref: string;
17815
+ };
17816
+ type: string;
17817
+ };
17818
+ ok: {
17819
+ type: string;
17820
+ };
17821
+ };
17822
+ required: string[];
17823
+ type: string;
17824
+ };
17825
+ };
17826
+ };
17827
+ description: string;
17828
+ };
17829
+ 400: {
17830
+ description: string;
17831
+ };
17832
+ 401: {
17833
+ description: string;
17834
+ };
17835
+ };
17836
+ security: ({
17837
+ pat_with_workspace: never[];
17838
+ console_session?: never;
17839
+ api_key?: never;
17840
+ } | {
17841
+ console_session: never[];
17842
+ pat_with_workspace?: never;
17843
+ api_key?: never;
17844
+ } | {
17845
+ api_key: never[];
17846
+ pat_with_workspace?: never;
17847
+ console_session?: never;
17848
+ })[];
17849
+ summary: string;
17850
+ tags: string[];
17851
+ 'x-fern-sdk-group-name': string[];
17852
+ 'x-fern-sdk-method-name': string;
17853
+ 'x-fern-sdk-return-value': string;
17854
+ };
17855
+ };
17712
17856
  '/acs/encoders/read_card': {
17713
17857
  post: {
17714
17858
  operationId: string;
@@ -30901,6 +31045,7 @@ interface Routes {
30901
31045
  guest_acs_entrance_ids?: string[] | undefined;
30902
31046
  common_acs_entrance_ids?: string[] | undefined;
30903
31047
  is_valid?: boolean | undefined;
31048
+ auto_join?: boolean | undefined;
30904
31049
  card_id?: string | undefined;
30905
31050
  credential_id?: string | undefined;
30906
31051
  } | undefined;
@@ -30928,6 +31073,7 @@ interface Routes {
30928
31073
  * @deprecated use override. */
30929
31074
  is_override_key?: boolean | undefined;
30930
31075
  override?: boolean | undefined;
31076
+ auto_join?: boolean | undefined;
30931
31077
  joiner_acs_credential_ids?: string[] | undefined;
30932
31078
  } | undefined;
30933
31079
  starts_at?: string | undefined;
@@ -30970,6 +31116,7 @@ interface Routes {
30970
31116
  guest_acs_entrance_ids?: string[] | undefined;
30971
31117
  common_acs_entrance_ids?: string[] | undefined;
30972
31118
  is_valid?: boolean | undefined;
31119
+ auto_join?: boolean | undefined;
30973
31120
  card_id?: string | undefined;
30974
31121
  credential_id?: string | undefined;
30975
31122
  } | undefined;
@@ -31033,6 +31180,7 @@ interface Routes {
31033
31180
  guest_acs_entrance_ids?: string[] | undefined;
31034
31181
  common_acs_entrance_ids?: string[] | undefined;
31035
31182
  is_valid?: boolean | undefined;
31183
+ auto_join?: boolean | undefined;
31036
31184
  card_id?: string | undefined;
31037
31185
  credential_id?: string | undefined;
31038
31186
  } | undefined;
@@ -31096,6 +31244,7 @@ interface Routes {
31096
31244
  guest_acs_entrance_ids?: string[] | undefined;
31097
31245
  common_acs_entrance_ids?: string[] | undefined;
31098
31246
  is_valid?: boolean | undefined;
31247
+ auto_join?: boolean | undefined;
31099
31248
  card_id?: string | undefined;
31100
31249
  credential_id?: string | undefined;
31101
31250
  } | undefined;
@@ -31195,6 +31344,7 @@ interface Routes {
31195
31344
  guest_acs_entrance_ids?: string[] | undefined;
31196
31345
  common_acs_entrance_ids?: string[] | undefined;
31197
31346
  is_valid?: boolean | undefined;
31347
+ auto_join?: boolean | undefined;
31198
31348
  card_id?: string | undefined;
31199
31349
  credential_id?: string | undefined;
31200
31350
  } | undefined;
@@ -31247,6 +31397,7 @@ interface Routes {
31247
31397
  guest_acs_entrance_ids?: string[] | undefined;
31248
31398
  common_acs_entrance_ids?: string[] | undefined;
31249
31399
  is_valid?: boolean | undefined;
31400
+ auto_join?: boolean | undefined;
31250
31401
  card_id?: string | undefined;
31251
31402
  credential_id?: string | undefined;
31252
31403
  } | undefined;
@@ -31306,6 +31457,7 @@ interface Routes {
31306
31457
  guest_acs_entrance_ids?: string[] | undefined;
31307
31458
  common_acs_entrance_ids?: string[] | undefined;
31308
31459
  is_valid?: boolean | undefined;
31460
+ auto_join?: boolean | undefined;
31309
31461
  card_id?: string | undefined;
31310
31462
  credential_id?: string | undefined;
31311
31463
  } | undefined;
@@ -31360,6 +31512,7 @@ interface Routes {
31360
31512
  guest_acs_entrance_ids?: string[] | undefined;
31361
31513
  common_acs_entrance_ids?: string[] | undefined;
31362
31514
  is_valid?: boolean | undefined;
31515
+ auto_join?: boolean | undefined;
31363
31516
  card_id?: string | undefined;
31364
31517
  credential_id?: string | undefined;
31365
31518
  } | undefined;
@@ -31825,6 +31978,461 @@ interface Routes {
31825
31978
  };
31826
31979
  };
31827
31980
  };
31981
+ '/acs/encoders/list': {
31982
+ route: '/acs/encoders/list';
31983
+ method: 'GET' | 'POST';
31984
+ queryParams: {};
31985
+ jsonBody: {};
31986
+ commonParams: {
31987
+ acs_system_ids: string[];
31988
+ device_ids: string[];
31989
+ limit?: number;
31990
+ } | {
31991
+ device_ids: string[];
31992
+ limit?: number;
31993
+ } | {
31994
+ acs_system_ids: string[];
31995
+ limit?: number;
31996
+ };
31997
+ formData: {};
31998
+ jsonResponse: {
31999
+ devices: Array<{
32000
+ /** Unique identifier for the device. */
32001
+ device_id: string;
32002
+ /** Type of the device. */
32003
+ 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') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | 'visionline_encoder';
32004
+ /** Optional nickname to describe the device, settable through Seam */
32005
+ nickname?: string | undefined;
32006
+ /** 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. */
32007
+ display_name: string;
32008
+ /** 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. */
32009
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
32010
+ /** Properties of the device. */
32011
+ properties: (({
32012
+ /** Indicates whether the device is online. */
32013
+ online: boolean;
32014
+ /** Name of the device.
32015
+ * @deprecated use device.display_name instead */
32016
+ name: string;
32017
+ /** Represents the accessory keypad state. */
32018
+ accessory_keypad?: {
32019
+ /** Indicates if the accessory_keypad is connected to the device. */
32020
+ is_connected: boolean;
32021
+ /** Indicates if the keypad battery properties. */
32022
+ battery?: {
32023
+ level: number;
32024
+ } | undefined;
32025
+ } | undefined;
32026
+ appearance: {
32027
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
32028
+ name: string;
32029
+ };
32030
+ model: {
32031
+ /** Indicates whether the device can connect a accessory keypad. */
32032
+ can_connect_accessory_keypad?: boolean | undefined;
32033
+ /** Display name of the device model. */
32034
+ display_name: string;
32035
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
32036
+ manufacturer_display_name: string;
32037
+ /** Indicates whether the device has a built in accessory keypad. */
32038
+ has_built_in_keypad?: boolean | undefined;
32039
+ /** Indicates whether the device supports offline access codes. */
32040
+ offline_access_codes_supported?: boolean | undefined;
32041
+ /** Indicates whether the device supports online access codes. */
32042
+ online_access_codes_supported?: boolean | undefined;
32043
+ /**
32044
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
32045
+ accessory_keypad_supported?: boolean | undefined;
32046
+ };
32047
+ /** Indicates whether the device has direct power. */
32048
+ has_direct_power?: boolean | undefined;
32049
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
32050
+ battery_level?: number | undefined;
32051
+ /** 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. */
32052
+ battery?: {
32053
+ level: number;
32054
+ status: 'critical' | 'low' | 'good' | 'full';
32055
+ } | undefined;
32056
+ /** Manufacturer of the device. */
32057
+ manufacturer?: string | undefined;
32058
+ /** Image URL for the device. */
32059
+ image_url?: string | undefined;
32060
+ /** Alt text for the device image. */
32061
+ image_alt_text?: string | undefined;
32062
+ /** Serial number of the device. */
32063
+ serial_number?: string | undefined;
32064
+ /** Indicates whether it is currently possible to use online access codes for the device. */
32065
+ online_access_codes_enabled?: boolean | undefined;
32066
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
32067
+ offline_access_codes_enabled?: boolean | undefined;
32068
+ /**
32069
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
32070
+ supports_accessory_keypad?: boolean | undefined;
32071
+ /**
32072
+ * @deprecated use offline_access_codes_enabled */
32073
+ supports_offline_access_codes?: boolean | undefined;
32074
+ /** Indicates current noise level in decibels, if the device supports noise detection. */
32075
+ noise_level_decibels?: number | undefined;
32076
+ /** Array of noise threshold IDs that are currently triggering. */
32077
+ currently_triggering_noise_threshold_ids?: string[] | undefined;
32078
+ } & {
32079
+ assa_abloy_credential_service_metadata?: ({
32080
+ has_active_endpoint: boolean;
32081
+ endpoints: Array<{
32082
+ endpoint_id: string;
32083
+ is_active: boolean;
32084
+ }>;
32085
+ } | undefined) | undefined;
32086
+ }) & {
32087
+ august_metadata?: {
32088
+ lock_id: string;
32089
+ lock_name: string;
32090
+ house_name: string;
32091
+ has_keypad: boolean;
32092
+ keypad_battery_level?: string | undefined;
32093
+ model?: string | undefined;
32094
+ house_id?: string | undefined;
32095
+ } | undefined;
32096
+ avigilon_alta_metadata?: {
32097
+ entry_name: string;
32098
+ org_name: string;
32099
+ zone_id: number;
32100
+ zone_name: string;
32101
+ site_id: number;
32102
+ site_name: string;
32103
+ entry_relays_total_count: number;
32104
+ } | undefined;
32105
+ schlage_metadata?: {
32106
+ device_id: string;
32107
+ device_name: string;
32108
+ access_code_length: number | null;
32109
+ model?: string | undefined;
32110
+ } | undefined;
32111
+ smartthings_metadata?: {
32112
+ device_id: string;
32113
+ device_name: string;
32114
+ model?: string | undefined;
32115
+ location_id?: string | undefined;
32116
+ } | undefined;
32117
+ lockly_metadata?: {
32118
+ device_id: string;
32119
+ device_name: string;
32120
+ model?: string | undefined;
32121
+ } | undefined;
32122
+ nuki_metadata?: {
32123
+ device_id: string;
32124
+ device_name: string;
32125
+ keypad_battery_critical?: boolean | undefined;
32126
+ keypad_paired?: boolean | undefined;
32127
+ keypad_2_paired?: boolean | undefined;
32128
+ } | undefined;
32129
+ kwikset_metadata?: {
32130
+ device_id: string;
32131
+ device_name: string;
32132
+ model_number: string;
32133
+ } | undefined;
32134
+ salto_metadata?: {
32135
+ lock_id: string;
32136
+ customer_reference: string;
32137
+ lock_type: string;
32138
+ battery_level: string;
32139
+ locked_state: string;
32140
+ model?: string | undefined;
32141
+ } | undefined;
32142
+ genie_metadata?: {
32143
+ device_name: string;
32144
+ door_name: string;
32145
+ } | undefined;
32146
+ brivo_metadata?: {
32147
+ device_name: string;
32148
+ } | undefined;
32149
+ igloo_metadata?: {
32150
+ device_id: string;
32151
+ bridge_id: string;
32152
+ model?: string | undefined;
32153
+ } | undefined;
32154
+ noiseaware_metadata?: {
32155
+ device_model: 'indoor' | 'outdoor';
32156
+ noise_level_nrs: number;
32157
+ noise_level_decibel: number;
32158
+ device_name: string;
32159
+ device_id: string;
32160
+ } | undefined;
32161
+ minut_metadata?: {
32162
+ device_id: string;
32163
+ device_name: string;
32164
+ latest_sensor_values: {
32165
+ temperature: {
32166
+ time: string;
32167
+ value: number;
32168
+ };
32169
+ sound: {
32170
+ time: string;
32171
+ value: number;
32172
+ };
32173
+ humidity: {
32174
+ time: string;
32175
+ value: number;
32176
+ };
32177
+ pressure: {
32178
+ time: string;
32179
+ value: number;
32180
+ };
32181
+ accelerometer_z: {
32182
+ time: string;
32183
+ value: number;
32184
+ };
32185
+ };
32186
+ } | undefined;
32187
+ four_suites_metadata?: {
32188
+ device_id: number;
32189
+ device_name: string;
32190
+ reclose_delay_in_seconds: number;
32191
+ } | undefined;
32192
+ two_n_metadata?: {
32193
+ device_id: number;
32194
+ device_name: string;
32195
+ } | undefined;
32196
+ controlbyweb_metadata?: {
32197
+ device_id: string;
32198
+ device_name: string;
32199
+ relay_name: string | null;
32200
+ } | undefined;
32201
+ ttlock_metadata?: {
32202
+ lock_id: number;
32203
+ lock_alias: string;
32204
+ feature_value: string;
32205
+ features: {
32206
+ passcode: boolean;
32207
+ passcode_management: boolean;
32208
+ unlock_via_gateway: boolean;
32209
+ lock_command: boolean;
32210
+ incomplete_keyboard_passcode: boolean;
32211
+ };
32212
+ has_gateway?: boolean | undefined;
32213
+ wireless_keypads?: Array<{
32214
+ wireless_keypad_id: number;
32215
+ wireless_keypad_name: string;
32216
+ }> | undefined;
32217
+ } | undefined;
32218
+ seam_bridge_metadata?: {
32219
+ unlock_method?: ('bridge' | 'doorking') | undefined;
32220
+ device_num: number;
32221
+ name: string;
32222
+ } | undefined;
32223
+ igloohome_metadata?: {
32224
+ device_id: string;
32225
+ device_name: string;
32226
+ bridge_id?: string | undefined;
32227
+ bridge_name?: string | undefined;
32228
+ keypad_id?: string | undefined;
32229
+ } | undefined;
32230
+ nest_metadata?: {
32231
+ nest_device_id: string;
32232
+ device_name: string;
32233
+ custom_name: string;
32234
+ } | undefined;
32235
+ ecobee_metadata?: {
32236
+ ecobee_device_id: string;
32237
+ device_name: string;
32238
+ } | undefined;
32239
+ honeywell_resideo_metadata?: {
32240
+ honeywell_resideo_device_id: string;
32241
+ device_name: string;
32242
+ } | undefined;
32243
+ hubitat_metadata?: {
32244
+ device_id: string;
32245
+ device_name: string;
32246
+ device_label: string;
32247
+ } | undefined;
32248
+ dormakaba_oracode_metadata?: {
32249
+ door_id?: number | undefined;
32250
+ door_name: string;
32251
+ device_id?: (number | string) | undefined;
32252
+ door_is_wireless: boolean;
32253
+ /** @DEPRECATED */
32254
+ site_id: number | null;
32255
+ site_name: string;
32256
+ iana_timezone?: string | undefined;
32257
+ predefined_time_slots?: Array<{
32258
+ name: string;
32259
+ prefix: number;
32260
+ check_in_time: string;
32261
+ check_out_time: string;
32262
+ is_24_hour: boolean;
32263
+ is_biweekly_mode: boolean;
32264
+ is_one_shot: boolean;
32265
+ is_master: boolean;
32266
+ ext_dormakaba_oracode_user_level_prefix: number;
32267
+ dormakaba_oracode_user_level_id: string;
32268
+ }> | undefined;
32269
+ } | undefined;
32270
+ wyze_metadata?: {
32271
+ device_id: string;
32272
+ device_name: string;
32273
+ product_name: string;
32274
+ product_type: string;
32275
+ product_model: string;
32276
+ device_info_model: string;
32277
+ keypad_uuid?: string | undefined;
32278
+ locker_status_hardlock?: number | undefined;
32279
+ } | undefined;
32280
+ tedee_metadata?: {
32281
+ device_id: number;
32282
+ serial_number: string;
32283
+ device_name: string;
32284
+ device_model: string;
32285
+ bridge_id: number;
32286
+ bridge_name: string;
32287
+ keypad_id?: number | undefined;
32288
+ } | undefined;
32289
+ visionline_metadata?: {
32290
+ encoder_id: string;
32291
+ } | undefined;
32292
+ }) & ({
32293
+ _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
32294
+ code_constraints?: (Array<{
32295
+ 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';
32296
+ } | {
32297
+ constraint_type: 'name_length' | 'name_must_be_unique';
32298
+ min_length?: number | undefined;
32299
+ max_length?: number | undefined;
32300
+ }> | undefined) | undefined;
32301
+ supported_code_lengths?: (number[] | undefined) | undefined;
32302
+ max_active_codes_supported?: (number | undefined) | undefined;
32303
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined;
32304
+ has_native_entry_events?: (boolean | undefined) | undefined;
32305
+ locked?: (boolean | undefined) | undefined;
32306
+ keypad_battery?: ({
32307
+ level: number;
32308
+ } | undefined) | undefined;
32309
+ door_open?: (boolean | undefined) | undefined;
32310
+ } & {
32311
+ temperature_fahrenheit?: number | undefined;
32312
+ temperature_celsius?: number | undefined;
32313
+ relative_humidity?: number | undefined;
32314
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
32315
+ available_fan_mode_settings?: Array<'auto' | 'on' | 'circulate'> | undefined;
32316
+ is_heating?: boolean | undefined;
32317
+ is_cooling?: boolean | undefined;
32318
+ is_fan_running?: boolean | undefined;
32319
+ /**
32320
+ * @deprecated use current_climate_setting.fan_mode_setting instead. */
32321
+ fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
32322
+ is_temporary_manual_override_active?: boolean | undefined;
32323
+ current_climate_setting?: {
32324
+ climate_preset_key?: string | undefined;
32325
+ can_edit?: boolean | undefined;
32326
+ can_delete?: boolean | undefined;
32327
+ name?: ((string | null) | undefined) | undefined;
32328
+ display_name?: string | undefined;
32329
+ fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
32330
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
32331
+ cooling_set_point_celsius?: (number | undefined) | undefined;
32332
+ heating_set_point_celsius?: (number | undefined) | undefined;
32333
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
32334
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
32335
+ manual_override_allowed?: boolean | undefined;
32336
+ } | undefined;
32337
+ /**
32338
+ * @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
32339
+ default_climate_setting?: {
32340
+ climate_preset_key?: string | undefined;
32341
+ can_edit?: boolean | undefined;
32342
+ can_delete?: boolean | undefined;
32343
+ name?: ((string | null) | undefined) | undefined;
32344
+ display_name?: string | undefined;
32345
+ fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
32346
+ hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
32347
+ cooling_set_point_celsius?: (number | undefined) | undefined;
32348
+ heating_set_point_celsius?: (number | undefined) | undefined;
32349
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
32350
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
32351
+ manual_override_allowed?: boolean | undefined;
32352
+ } | undefined;
32353
+ available_climate_presets?: Array<{
32354
+ climate_preset_key: string;
32355
+ can_edit: boolean;
32356
+ can_delete: boolean;
32357
+ name?: (string | null) | undefined;
32358
+ display_name: string;
32359
+ fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
32360
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
32361
+ cooling_set_point_celsius?: number | undefined;
32362
+ heating_set_point_celsius?: number | undefined;
32363
+ cooling_set_point_fahrenheit?: number | undefined;
32364
+ heating_set_point_fahrenheit?: number | undefined;
32365
+ manual_override_allowed: boolean;
32366
+ }> | undefined;
32367
+ fallback_climate_preset_key?: (string | null) | undefined;
32368
+ active_thermostat_schedule?: ({
32369
+ thermostat_schedule_id: string;
32370
+ device_id: string;
32371
+ name?: string | undefined;
32372
+ climate_preset_key: string;
32373
+ max_override_period_minutes?: number;
32374
+ starts_at: string;
32375
+ ends_at: string;
32376
+ created_at: string;
32377
+ /** Collection of errors associated with the thermostat schedule, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
32378
+ errors?: any;
32379
+ } | null) | undefined;
32380
+ min_cooling_set_point_celsius?: number | undefined;
32381
+ min_cooling_set_point_fahrenheit?: number | undefined;
32382
+ max_cooling_set_point_celsius?: number | undefined;
32383
+ max_cooling_set_point_fahrenheit?: number | undefined;
32384
+ min_heating_set_point_celsius?: number | undefined;
32385
+ min_heating_set_point_fahrenheit?: number | undefined;
32386
+ max_heating_set_point_celsius?: number | undefined;
32387
+ max_heating_set_point_fahrenheit?: number | undefined;
32388
+ min_heating_cooling_delta_celsius?: number | undefined;
32389
+ min_heating_cooling_delta_fahrenheit?: number | undefined;
32390
+ });
32391
+ /** Location information for the device. */
32392
+ location: {
32393
+ /** Name of the device location. */
32394
+ location_name?: string | undefined;
32395
+ /** Time zone of the device location. */
32396
+ timezone?: string | undefined;
32397
+ } | null;
32398
+ /** Unique identifier for the account associated with the device. */
32399
+ connected_account_id: string;
32400
+ /** Unique identifier for the Seam workspace associated with the device. */
32401
+ workspace_id: string;
32402
+ /** 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. */
32403
+ errors: Array<{
32404
+ message: string;
32405
+ is_device_error: true;
32406
+ error_code: string;
32407
+ } | {
32408
+ message: string;
32409
+ is_connected_account_error: true;
32410
+ error_code: string;
32411
+ }>;
32412
+ /** 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. */
32413
+ warnings: Array<{
32414
+ message: string;
32415
+ warning_code: string;
32416
+ }>;
32417
+ /** Date and time at which the device object was created. */
32418
+ created_at: string;
32419
+ /** Indicates whether Seam manages the device. */
32420
+ is_managed: true;
32421
+ custom_metadata: Record<string, string | boolean>;
32422
+ can_remotely_unlock?: boolean | undefined;
32423
+ can_remotely_lock?: boolean | undefined;
32424
+ can_program_offline_access_codes?: boolean | undefined;
32425
+ can_program_online_access_codes?: boolean | undefined;
32426
+ can_hvac_heat?: boolean | undefined;
32427
+ can_hvac_cool?: boolean | undefined;
32428
+ can_hvac_heat_cool?: boolean | undefined;
32429
+ can_turn_off_hvac?: boolean | undefined;
32430
+ can_simulate_removal?: boolean | undefined;
32431
+ can_simulate_connection?: boolean | undefined;
32432
+ can_simulate_disconnection?: boolean | undefined;
32433
+ }>;
32434
+ };
32435
+ };
31828
32436
  '/acs/encoders/read_card': {
31829
32437
  route: '/acs/encoders/read_card';
31830
32438
  method: 'POST';
@@ -32434,6 +33042,7 @@ interface Routes {
32434
33042
  guest_acs_entrance_ids?: string[] | undefined;
32435
33043
  common_acs_entrance_ids?: string[] | undefined;
32436
33044
  is_valid?: boolean | undefined;
33045
+ auto_join?: boolean | undefined;
32437
33046
  card_id?: string | undefined;
32438
33047
  credential_id?: string | undefined;
32439
33048
  } | undefined;