@seamapi/types 1.257.0 → 1.258.1
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.
- package/dist/connect.cjs +87 -39
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +664 -156
- package/lib/seam/connect/openapi.d.ts +122 -54
- package/lib/seam/connect/openapi.js +86 -38
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +456 -16
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +86 -38
- package/src/lib/seam/connect/route-types.ts +630 -16
package/dist/connect.d.cts
CHANGED
|
@@ -10898,56 +10898,6 @@ declare const _default: {
|
|
|
10898
10898
|
required: string[];
|
|
10899
10899
|
type: string;
|
|
10900
10900
|
};
|
|
10901
|
-
climate_preset: {
|
|
10902
|
-
properties: {
|
|
10903
|
-
can_delete: {
|
|
10904
|
-
type: string;
|
|
10905
|
-
};
|
|
10906
|
-
can_edit: {
|
|
10907
|
-
type: string;
|
|
10908
|
-
};
|
|
10909
|
-
climate_preset_key: {
|
|
10910
|
-
type: string;
|
|
10911
|
-
};
|
|
10912
|
-
cooling_set_point_celsius: {
|
|
10913
|
-
format: string;
|
|
10914
|
-
type: string;
|
|
10915
|
-
};
|
|
10916
|
-
cooling_set_point_fahrenheit: {
|
|
10917
|
-
format: string;
|
|
10918
|
-
type: string;
|
|
10919
|
-
};
|
|
10920
|
-
display_name: {
|
|
10921
|
-
type: string;
|
|
10922
|
-
};
|
|
10923
|
-
fan_mode_setting: {
|
|
10924
|
-
enum: string[];
|
|
10925
|
-
type: string;
|
|
10926
|
-
};
|
|
10927
|
-
heating_set_point_celsius: {
|
|
10928
|
-
format: string;
|
|
10929
|
-
type: string;
|
|
10930
|
-
};
|
|
10931
|
-
heating_set_point_fahrenheit: {
|
|
10932
|
-
format: string;
|
|
10933
|
-
type: string;
|
|
10934
|
-
};
|
|
10935
|
-
hvac_mode_setting: {
|
|
10936
|
-
enum: string[];
|
|
10937
|
-
type: string;
|
|
10938
|
-
};
|
|
10939
|
-
manual_override_allowed: {
|
|
10940
|
-
type: string;
|
|
10941
|
-
};
|
|
10942
|
-
name: {
|
|
10943
|
-
default: null;
|
|
10944
|
-
nullable: boolean;
|
|
10945
|
-
type: string;
|
|
10946
|
-
};
|
|
10947
|
-
};
|
|
10948
|
-
required: string[];
|
|
10949
|
-
type: string;
|
|
10950
|
-
};
|
|
10951
10901
|
connect_webview: {
|
|
10952
10902
|
properties: {
|
|
10953
10903
|
accepted_devices: {
|
|
@@ -17731,6 +17681,128 @@ declare const _default: {
|
|
|
17731
17681
|
'x-undocumented': string;
|
|
17732
17682
|
};
|
|
17733
17683
|
};
|
|
17684
|
+
'/acs/encoders/list': {
|
|
17685
|
+
post: {
|
|
17686
|
+
operationId: string;
|
|
17687
|
+
requestBody: {
|
|
17688
|
+
content: {
|
|
17689
|
+
'application/json': {
|
|
17690
|
+
schema: {
|
|
17691
|
+
oneOf: ({
|
|
17692
|
+
properties: {
|
|
17693
|
+
acs_system_ids: {
|
|
17694
|
+
items: {
|
|
17695
|
+
format: string;
|
|
17696
|
+
type: string;
|
|
17697
|
+
};
|
|
17698
|
+
type: string;
|
|
17699
|
+
};
|
|
17700
|
+
device_ids: {
|
|
17701
|
+
items: {
|
|
17702
|
+
format: string;
|
|
17703
|
+
type: string;
|
|
17704
|
+
};
|
|
17705
|
+
type: string;
|
|
17706
|
+
};
|
|
17707
|
+
limit: {
|
|
17708
|
+
default: number;
|
|
17709
|
+
format: string;
|
|
17710
|
+
type: string;
|
|
17711
|
+
};
|
|
17712
|
+
};
|
|
17713
|
+
required: string[];
|
|
17714
|
+
type: string;
|
|
17715
|
+
} | {
|
|
17716
|
+
properties: {
|
|
17717
|
+
device_ids: {
|
|
17718
|
+
items: {
|
|
17719
|
+
format: string;
|
|
17720
|
+
type: string;
|
|
17721
|
+
};
|
|
17722
|
+
type: string;
|
|
17723
|
+
};
|
|
17724
|
+
limit: {
|
|
17725
|
+
default: number;
|
|
17726
|
+
format: string;
|
|
17727
|
+
type: string;
|
|
17728
|
+
};
|
|
17729
|
+
acs_system_ids?: never;
|
|
17730
|
+
};
|
|
17731
|
+
required: string[];
|
|
17732
|
+
type: string;
|
|
17733
|
+
} | {
|
|
17734
|
+
properties: {
|
|
17735
|
+
acs_system_ids: {
|
|
17736
|
+
items: {
|
|
17737
|
+
format: string;
|
|
17738
|
+
type: string;
|
|
17739
|
+
};
|
|
17740
|
+
type: string;
|
|
17741
|
+
};
|
|
17742
|
+
limit: {
|
|
17743
|
+
default: number;
|
|
17744
|
+
format: string;
|
|
17745
|
+
type: string;
|
|
17746
|
+
};
|
|
17747
|
+
device_ids?: never;
|
|
17748
|
+
};
|
|
17749
|
+
required: string[];
|
|
17750
|
+
type: string;
|
|
17751
|
+
})[];
|
|
17752
|
+
};
|
|
17753
|
+
};
|
|
17754
|
+
};
|
|
17755
|
+
};
|
|
17756
|
+
responses: {
|
|
17757
|
+
200: {
|
|
17758
|
+
content: {
|
|
17759
|
+
'application/json': {
|
|
17760
|
+
schema: {
|
|
17761
|
+
properties: {
|
|
17762
|
+
devices: {
|
|
17763
|
+
items: {
|
|
17764
|
+
$ref: string;
|
|
17765
|
+
};
|
|
17766
|
+
type: string;
|
|
17767
|
+
};
|
|
17768
|
+
ok: {
|
|
17769
|
+
type: string;
|
|
17770
|
+
};
|
|
17771
|
+
};
|
|
17772
|
+
required: string[];
|
|
17773
|
+
type: string;
|
|
17774
|
+
};
|
|
17775
|
+
};
|
|
17776
|
+
};
|
|
17777
|
+
description: string;
|
|
17778
|
+
};
|
|
17779
|
+
400: {
|
|
17780
|
+
description: string;
|
|
17781
|
+
};
|
|
17782
|
+
401: {
|
|
17783
|
+
description: string;
|
|
17784
|
+
};
|
|
17785
|
+
};
|
|
17786
|
+
security: ({
|
|
17787
|
+
pat_with_workspace: never[];
|
|
17788
|
+
console_session?: never;
|
|
17789
|
+
api_key?: never;
|
|
17790
|
+
} | {
|
|
17791
|
+
console_session: never[];
|
|
17792
|
+
pat_with_workspace?: never;
|
|
17793
|
+
api_key?: never;
|
|
17794
|
+
} | {
|
|
17795
|
+
api_key: never[];
|
|
17796
|
+
pat_with_workspace?: never;
|
|
17797
|
+
console_session?: never;
|
|
17798
|
+
})[];
|
|
17799
|
+
summary: string;
|
|
17800
|
+
tags: string[];
|
|
17801
|
+
'x-fern-sdk-group-name': string[];
|
|
17802
|
+
'x-fern-sdk-method-name': string;
|
|
17803
|
+
'x-fern-sdk-return-value': string;
|
|
17804
|
+
};
|
|
17805
|
+
};
|
|
17734
17806
|
'/acs/encoders/read_card': {
|
|
17735
17807
|
post: {
|
|
17736
17808
|
operationId: string;
|
|
@@ -24465,9 +24537,6 @@ declare const _default: {
|
|
|
24465
24537
|
'application/json': {
|
|
24466
24538
|
schema: {
|
|
24467
24539
|
properties: {
|
|
24468
|
-
climate_preset: {
|
|
24469
|
-
$ref: string;
|
|
24470
|
-
};
|
|
24471
24540
|
ok: {
|
|
24472
24541
|
type: string;
|
|
24473
24542
|
};
|
|
@@ -24503,7 +24572,6 @@ declare const _default: {
|
|
|
24503
24572
|
tags: string[];
|
|
24504
24573
|
'x-fern-sdk-group-name': string[];
|
|
24505
24574
|
'x-fern-sdk-method-name': string;
|
|
24506
|
-
'x-fern-sdk-return-value': string;
|
|
24507
24575
|
};
|
|
24508
24576
|
};
|
|
24509
24577
|
'/thermostats/delete_climate_preset': {
|
|
@@ -31856,99 +31924,554 @@ interface Routes {
|
|
|
31856
31924
|
};
|
|
31857
31925
|
};
|
|
31858
31926
|
};
|
|
31859
|
-
'/acs/encoders/
|
|
31860
|
-
route: '/acs/encoders/
|
|
31861
|
-
method: 'POST';
|
|
31927
|
+
'/acs/encoders/list': {
|
|
31928
|
+
route: '/acs/encoders/list';
|
|
31929
|
+
method: 'GET' | 'POST';
|
|
31862
31930
|
queryParams: {};
|
|
31863
31931
|
jsonBody: {};
|
|
31864
31932
|
commonParams: {
|
|
31865
|
-
|
|
31866
|
-
|
|
31933
|
+
acs_system_ids: string[];
|
|
31934
|
+
device_ids: string[];
|
|
31935
|
+
limit?: number;
|
|
31867
31936
|
} | {
|
|
31868
|
-
|
|
31937
|
+
device_ids: string[];
|
|
31938
|
+
limit?: number;
|
|
31939
|
+
} | {
|
|
31940
|
+
acs_system_ids: string[];
|
|
31941
|
+
limit?: number;
|
|
31869
31942
|
};
|
|
31870
31943
|
formData: {};
|
|
31871
31944
|
jsonResponse: {
|
|
31872
|
-
|
|
31873
|
-
/**
|
|
31874
|
-
|
|
31875
|
-
|
|
31876
|
-
|
|
31877
|
-
|
|
31878
|
-
|
|
31879
|
-
|
|
31880
|
-
|
|
31881
|
-
|
|
31882
|
-
|
|
31883
|
-
|
|
31884
|
-
|
|
31885
|
-
|
|
31886
|
-
|
|
31887
|
-
|
|
31888
|
-
|
|
31889
|
-
|
|
31890
|
-
|
|
31891
|
-
|
|
31892
|
-
|
|
31893
|
-
|
|
31894
|
-
|
|
31895
|
-
|
|
31896
|
-
|
|
31897
|
-
|
|
31898
|
-
|
|
31899
|
-
|
|
31900
|
-
|
|
31901
|
-
|
|
31902
|
-
|
|
31903
|
-
|
|
31904
|
-
|
|
31905
|
-
|
|
31906
|
-
|
|
31907
|
-
|
|
31908
|
-
|
|
31909
|
-
|
|
31910
|
-
|
|
31911
|
-
|
|
31912
|
-
|
|
31913
|
-
|
|
31914
|
-
|
|
31915
|
-
|
|
31916
|
-
|
|
31917
|
-
|
|
31918
|
-
|
|
31919
|
-
|
|
31920
|
-
|
|
31921
|
-
|
|
31922
|
-
|
|
31923
|
-
|
|
31924
|
-
|
|
31925
|
-
|
|
31926
|
-
|
|
31927
|
-
|
|
31928
|
-
|
|
31929
|
-
|
|
31930
|
-
|
|
31931
|
-
|
|
31932
|
-
|
|
31933
|
-
|
|
31934
|
-
|
|
31935
|
-
|
|
31936
|
-
|
|
31937
|
-
|
|
31938
|
-
|
|
31939
|
-
|
|
31940
|
-
|
|
31941
|
-
|
|
31942
|
-
|
|
31943
|
-
|
|
31944
|
-
|
|
31945
|
-
|
|
31946
|
-
|
|
31947
|
-
|
|
31948
|
-
|
|
31949
|
-
|
|
31950
|
-
|
|
31951
|
-
|
|
31945
|
+
devices: Array<{
|
|
31946
|
+
/** Unique identifier for the device. */
|
|
31947
|
+
device_id: string;
|
|
31948
|
+
/** Type of the device. */
|
|
31949
|
+
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';
|
|
31950
|
+
/** Optional nickname to describe the device, settable through Seam */
|
|
31951
|
+
nickname?: string | undefined;
|
|
31952
|
+
/** 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. */
|
|
31953
|
+
display_name: string;
|
|
31954
|
+
/** 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. */
|
|
31955
|
+
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
31956
|
+
/** Properties of the device. */
|
|
31957
|
+
properties: (({
|
|
31958
|
+
/** Indicates whether the device is online. */
|
|
31959
|
+
online: boolean;
|
|
31960
|
+
/** Name of the device.
|
|
31961
|
+
* @deprecated use device.display_name instead */
|
|
31962
|
+
name: string;
|
|
31963
|
+
/** Represents the accessory keypad state. */
|
|
31964
|
+
accessory_keypad?: {
|
|
31965
|
+
/** Indicates if the accessory_keypad is connected to the device. */
|
|
31966
|
+
is_connected: boolean;
|
|
31967
|
+
/** Indicates if the keypad battery properties. */
|
|
31968
|
+
battery?: {
|
|
31969
|
+
level: number;
|
|
31970
|
+
} | undefined;
|
|
31971
|
+
} | undefined;
|
|
31972
|
+
appearance: {
|
|
31973
|
+
/** Name of the device as seen from the provider API and application, not settable through Seam. */
|
|
31974
|
+
name: string;
|
|
31975
|
+
};
|
|
31976
|
+
model: {
|
|
31977
|
+
/** Indicates whether the device can connect a accessory keypad. */
|
|
31978
|
+
can_connect_accessory_keypad?: boolean | undefined;
|
|
31979
|
+
/** Display name of the device model. */
|
|
31980
|
+
display_name: string;
|
|
31981
|
+
/** Display name that corresponds to the manufacturer-specific terminology for the device. */
|
|
31982
|
+
manufacturer_display_name: string;
|
|
31983
|
+
/** Indicates whether the device has a built in accessory keypad. */
|
|
31984
|
+
has_built_in_keypad?: boolean | undefined;
|
|
31985
|
+
/** Indicates whether the device supports offline access codes. */
|
|
31986
|
+
offline_access_codes_supported?: boolean | undefined;
|
|
31987
|
+
/** Indicates whether the device supports online access codes. */
|
|
31988
|
+
online_access_codes_supported?: boolean | undefined;
|
|
31989
|
+
/**
|
|
31990
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
31991
|
+
accessory_keypad_supported?: boolean | undefined;
|
|
31992
|
+
};
|
|
31993
|
+
/** Indicates whether the device has direct power. */
|
|
31994
|
+
has_direct_power?: boolean | undefined;
|
|
31995
|
+
/** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
|
|
31996
|
+
battery_level?: number | undefined;
|
|
31997
|
+
/** 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. */
|
|
31998
|
+
battery?: {
|
|
31999
|
+
level: number;
|
|
32000
|
+
status: 'critical' | 'low' | 'good' | 'full';
|
|
32001
|
+
} | undefined;
|
|
32002
|
+
/** Manufacturer of the device. */
|
|
32003
|
+
manufacturer?: string | undefined;
|
|
32004
|
+
/** Image URL for the device. */
|
|
32005
|
+
image_url?: string | undefined;
|
|
32006
|
+
/** Alt text for the device image. */
|
|
32007
|
+
image_alt_text?: string | undefined;
|
|
32008
|
+
/** Serial number of the device. */
|
|
32009
|
+
serial_number?: string | undefined;
|
|
32010
|
+
/** Indicates whether it is currently possible to use online access codes for the device. */
|
|
32011
|
+
online_access_codes_enabled?: boolean | undefined;
|
|
32012
|
+
/** Indicates whether it is currently possible to use offline access codes for the device. */
|
|
32013
|
+
offline_access_codes_enabled?: boolean | undefined;
|
|
32014
|
+
/**
|
|
32015
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
32016
|
+
supports_accessory_keypad?: boolean | undefined;
|
|
32017
|
+
/**
|
|
32018
|
+
* @deprecated use offline_access_codes_enabled */
|
|
32019
|
+
supports_offline_access_codes?: boolean | undefined;
|
|
32020
|
+
/** Indicates current noise level in decibels, if the device supports noise detection. */
|
|
32021
|
+
noise_level_decibels?: number | undefined;
|
|
32022
|
+
/** Array of noise threshold IDs that are currently triggering. */
|
|
32023
|
+
currently_triggering_noise_threshold_ids?: string[] | undefined;
|
|
32024
|
+
} & {
|
|
32025
|
+
assa_abloy_credential_service_metadata?: ({
|
|
32026
|
+
has_active_endpoint: boolean;
|
|
32027
|
+
endpoints: Array<{
|
|
32028
|
+
endpoint_id: string;
|
|
32029
|
+
is_active: boolean;
|
|
32030
|
+
}>;
|
|
32031
|
+
} | undefined) | undefined;
|
|
32032
|
+
}) & {
|
|
32033
|
+
august_metadata?: {
|
|
32034
|
+
lock_id: string;
|
|
32035
|
+
lock_name: string;
|
|
32036
|
+
house_name: string;
|
|
32037
|
+
has_keypad: boolean;
|
|
32038
|
+
keypad_battery_level?: string | undefined;
|
|
32039
|
+
model?: string | undefined;
|
|
32040
|
+
house_id?: string | undefined;
|
|
32041
|
+
} | undefined;
|
|
32042
|
+
avigilon_alta_metadata?: {
|
|
32043
|
+
entry_name: string;
|
|
32044
|
+
org_name: string;
|
|
32045
|
+
zone_id: number;
|
|
32046
|
+
zone_name: string;
|
|
32047
|
+
site_id: number;
|
|
32048
|
+
site_name: string;
|
|
32049
|
+
entry_relays_total_count: number;
|
|
32050
|
+
} | undefined;
|
|
32051
|
+
schlage_metadata?: {
|
|
32052
|
+
device_id: string;
|
|
32053
|
+
device_name: string;
|
|
32054
|
+
access_code_length: number | null;
|
|
32055
|
+
model?: string | undefined;
|
|
32056
|
+
} | undefined;
|
|
32057
|
+
smartthings_metadata?: {
|
|
32058
|
+
device_id: string;
|
|
32059
|
+
device_name: string;
|
|
32060
|
+
model?: string | undefined;
|
|
32061
|
+
location_id?: string | undefined;
|
|
32062
|
+
} | undefined;
|
|
32063
|
+
lockly_metadata?: {
|
|
32064
|
+
device_id: string;
|
|
32065
|
+
device_name: string;
|
|
32066
|
+
model?: string | undefined;
|
|
32067
|
+
} | undefined;
|
|
32068
|
+
nuki_metadata?: {
|
|
32069
|
+
device_id: string;
|
|
32070
|
+
device_name: string;
|
|
32071
|
+
keypad_battery_critical?: boolean | undefined;
|
|
32072
|
+
keypad_paired?: boolean | undefined;
|
|
32073
|
+
keypad_2_paired?: boolean | undefined;
|
|
32074
|
+
} | undefined;
|
|
32075
|
+
kwikset_metadata?: {
|
|
32076
|
+
device_id: string;
|
|
32077
|
+
device_name: string;
|
|
32078
|
+
model_number: string;
|
|
32079
|
+
} | undefined;
|
|
32080
|
+
salto_metadata?: {
|
|
32081
|
+
lock_id: string;
|
|
32082
|
+
customer_reference: string;
|
|
32083
|
+
lock_type: string;
|
|
32084
|
+
battery_level: string;
|
|
32085
|
+
locked_state: string;
|
|
32086
|
+
model?: string | undefined;
|
|
32087
|
+
} | undefined;
|
|
32088
|
+
genie_metadata?: {
|
|
32089
|
+
device_name: string;
|
|
32090
|
+
door_name: string;
|
|
32091
|
+
} | undefined;
|
|
32092
|
+
brivo_metadata?: {
|
|
32093
|
+
device_name: string;
|
|
32094
|
+
} | undefined;
|
|
32095
|
+
igloo_metadata?: {
|
|
32096
|
+
device_id: string;
|
|
32097
|
+
bridge_id: string;
|
|
32098
|
+
model?: string | undefined;
|
|
32099
|
+
} | undefined;
|
|
32100
|
+
noiseaware_metadata?: {
|
|
32101
|
+
device_model: 'indoor' | 'outdoor';
|
|
32102
|
+
noise_level_nrs: number;
|
|
32103
|
+
noise_level_decibel: number;
|
|
32104
|
+
device_name: string;
|
|
32105
|
+
device_id: string;
|
|
32106
|
+
} | undefined;
|
|
32107
|
+
minut_metadata?: {
|
|
32108
|
+
device_id: string;
|
|
32109
|
+
device_name: string;
|
|
32110
|
+
latest_sensor_values: {
|
|
32111
|
+
temperature: {
|
|
32112
|
+
time: string;
|
|
32113
|
+
value: number;
|
|
32114
|
+
};
|
|
32115
|
+
sound: {
|
|
32116
|
+
time: string;
|
|
32117
|
+
value: number;
|
|
32118
|
+
};
|
|
32119
|
+
humidity: {
|
|
32120
|
+
time: string;
|
|
32121
|
+
value: number;
|
|
32122
|
+
};
|
|
32123
|
+
pressure: {
|
|
32124
|
+
time: string;
|
|
32125
|
+
value: number;
|
|
32126
|
+
};
|
|
32127
|
+
accelerometer_z: {
|
|
32128
|
+
time: string;
|
|
32129
|
+
value: number;
|
|
32130
|
+
};
|
|
32131
|
+
};
|
|
32132
|
+
} | undefined;
|
|
32133
|
+
four_suites_metadata?: {
|
|
32134
|
+
device_id: number;
|
|
32135
|
+
device_name: string;
|
|
32136
|
+
reclose_delay_in_seconds: number;
|
|
32137
|
+
} | undefined;
|
|
32138
|
+
two_n_metadata?: {
|
|
32139
|
+
device_id: number;
|
|
32140
|
+
device_name: string;
|
|
32141
|
+
} | undefined;
|
|
32142
|
+
controlbyweb_metadata?: {
|
|
32143
|
+
device_id: string;
|
|
32144
|
+
device_name: string;
|
|
32145
|
+
relay_name: string | null;
|
|
32146
|
+
} | undefined;
|
|
32147
|
+
ttlock_metadata?: {
|
|
32148
|
+
lock_id: number;
|
|
32149
|
+
lock_alias: string;
|
|
32150
|
+
feature_value: string;
|
|
32151
|
+
features: {
|
|
32152
|
+
passcode: boolean;
|
|
32153
|
+
passcode_management: boolean;
|
|
32154
|
+
unlock_via_gateway: boolean;
|
|
32155
|
+
lock_command: boolean;
|
|
32156
|
+
incomplete_keyboard_passcode: boolean;
|
|
32157
|
+
};
|
|
32158
|
+
has_gateway?: boolean | undefined;
|
|
32159
|
+
wireless_keypads?: Array<{
|
|
32160
|
+
wireless_keypad_id: number;
|
|
32161
|
+
wireless_keypad_name: string;
|
|
32162
|
+
}> | undefined;
|
|
32163
|
+
} | undefined;
|
|
32164
|
+
seam_bridge_metadata?: {
|
|
32165
|
+
unlock_method?: ('bridge' | 'doorking') | undefined;
|
|
32166
|
+
device_num: number;
|
|
32167
|
+
name: string;
|
|
32168
|
+
} | undefined;
|
|
32169
|
+
igloohome_metadata?: {
|
|
32170
|
+
device_id: string;
|
|
32171
|
+
device_name: string;
|
|
32172
|
+
bridge_id?: string | undefined;
|
|
32173
|
+
bridge_name?: string | undefined;
|
|
32174
|
+
keypad_id?: string | undefined;
|
|
32175
|
+
} | undefined;
|
|
32176
|
+
nest_metadata?: {
|
|
32177
|
+
nest_device_id: string;
|
|
32178
|
+
device_name: string;
|
|
32179
|
+
custom_name: string;
|
|
32180
|
+
} | undefined;
|
|
32181
|
+
ecobee_metadata?: {
|
|
32182
|
+
ecobee_device_id: string;
|
|
32183
|
+
device_name: string;
|
|
32184
|
+
} | undefined;
|
|
32185
|
+
honeywell_resideo_metadata?: {
|
|
32186
|
+
honeywell_resideo_device_id: string;
|
|
32187
|
+
device_name: string;
|
|
32188
|
+
} | undefined;
|
|
32189
|
+
hubitat_metadata?: {
|
|
32190
|
+
device_id: string;
|
|
32191
|
+
device_name: string;
|
|
32192
|
+
device_label: string;
|
|
32193
|
+
} | undefined;
|
|
32194
|
+
dormakaba_oracode_metadata?: {
|
|
32195
|
+
door_id?: number | undefined;
|
|
32196
|
+
door_name: string;
|
|
32197
|
+
device_id?: (number | string) | undefined;
|
|
32198
|
+
door_is_wireless: boolean;
|
|
32199
|
+
/** @DEPRECATED */
|
|
32200
|
+
site_id: number | null;
|
|
32201
|
+
site_name: string;
|
|
32202
|
+
iana_timezone?: string | undefined;
|
|
32203
|
+
predefined_time_slots?: Array<{
|
|
32204
|
+
name: string;
|
|
32205
|
+
prefix: number;
|
|
32206
|
+
check_in_time: string;
|
|
32207
|
+
check_out_time: string;
|
|
32208
|
+
is_24_hour: boolean;
|
|
32209
|
+
is_biweekly_mode: boolean;
|
|
32210
|
+
is_one_shot: boolean;
|
|
32211
|
+
is_master: boolean;
|
|
32212
|
+
ext_dormakaba_oracode_user_level_prefix: number;
|
|
32213
|
+
dormakaba_oracode_user_level_id: string;
|
|
32214
|
+
}> | undefined;
|
|
32215
|
+
} | undefined;
|
|
32216
|
+
wyze_metadata?: {
|
|
32217
|
+
device_id: string;
|
|
32218
|
+
device_name: string;
|
|
32219
|
+
product_name: string;
|
|
32220
|
+
product_type: string;
|
|
32221
|
+
product_model: string;
|
|
32222
|
+
device_info_model: string;
|
|
32223
|
+
keypad_uuid?: string | undefined;
|
|
32224
|
+
locker_status_hardlock?: number | undefined;
|
|
32225
|
+
} | undefined;
|
|
32226
|
+
tedee_metadata?: {
|
|
32227
|
+
device_id: number;
|
|
32228
|
+
serial_number: string;
|
|
32229
|
+
device_name: string;
|
|
32230
|
+
device_model: string;
|
|
32231
|
+
bridge_id: number;
|
|
32232
|
+
bridge_name: string;
|
|
32233
|
+
keypad_id?: number | undefined;
|
|
32234
|
+
} | undefined;
|
|
32235
|
+
visionline_metadata?: {
|
|
32236
|
+
encoder_id: string;
|
|
32237
|
+
} | undefined;
|
|
32238
|
+
}) & ({
|
|
32239
|
+
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
32240
|
+
code_constraints?: (Array<{
|
|
32241
|
+
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';
|
|
32242
|
+
} | {
|
|
32243
|
+
constraint_type: 'name_length' | 'name_must_be_unique';
|
|
32244
|
+
min_length?: number | undefined;
|
|
32245
|
+
max_length?: number | undefined;
|
|
32246
|
+
}> | undefined) | undefined;
|
|
32247
|
+
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
32248
|
+
max_active_codes_supported?: (number | undefined) | undefined;
|
|
32249
|
+
supports_backup_access_code_pool?: (boolean | undefined) | undefined;
|
|
32250
|
+
has_native_entry_events?: (boolean | undefined) | undefined;
|
|
32251
|
+
locked?: (boolean | undefined) | undefined;
|
|
32252
|
+
keypad_battery?: ({
|
|
32253
|
+
level: number;
|
|
32254
|
+
} | undefined) | undefined;
|
|
32255
|
+
door_open?: (boolean | undefined) | undefined;
|
|
32256
|
+
} & {
|
|
32257
|
+
temperature_fahrenheit?: number | undefined;
|
|
32258
|
+
temperature_celsius?: number | undefined;
|
|
32259
|
+
relative_humidity?: number | undefined;
|
|
32260
|
+
available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
|
|
32261
|
+
available_fan_mode_settings?: Array<'auto' | 'on' | 'circulate'> | undefined;
|
|
32262
|
+
is_heating?: boolean | undefined;
|
|
32263
|
+
is_cooling?: boolean | undefined;
|
|
32264
|
+
is_fan_running?: boolean | undefined;
|
|
32265
|
+
/**
|
|
32266
|
+
* @deprecated use current_climate_setting.fan_mode_setting instead. */
|
|
32267
|
+
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
32268
|
+
is_temporary_manual_override_active?: boolean | undefined;
|
|
32269
|
+
current_climate_setting?: {
|
|
32270
|
+
climate_preset_key?: string | undefined;
|
|
32271
|
+
can_edit?: boolean | undefined;
|
|
32272
|
+
can_delete?: boolean | undefined;
|
|
32273
|
+
name?: ((string | null) | undefined) | undefined;
|
|
32274
|
+
display_name?: string | undefined;
|
|
32275
|
+
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
32276
|
+
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
32277
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
32278
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
32279
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
32280
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
32281
|
+
manual_override_allowed?: boolean | undefined;
|
|
32282
|
+
} | undefined;
|
|
32283
|
+
/**
|
|
32284
|
+
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
32285
|
+
default_climate_setting?: {
|
|
32286
|
+
climate_preset_key?: string | undefined;
|
|
32287
|
+
can_edit?: boolean | undefined;
|
|
32288
|
+
can_delete?: boolean | undefined;
|
|
32289
|
+
name?: ((string | null) | undefined) | undefined;
|
|
32290
|
+
display_name?: string | undefined;
|
|
32291
|
+
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
32292
|
+
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
32293
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
32294
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
32295
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
32296
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
32297
|
+
manual_override_allowed?: boolean | undefined;
|
|
32298
|
+
} | undefined;
|
|
32299
|
+
available_climate_presets?: Array<{
|
|
32300
|
+
climate_preset_key: string;
|
|
32301
|
+
can_edit: boolean;
|
|
32302
|
+
can_delete: boolean;
|
|
32303
|
+
name?: (string | null) | undefined;
|
|
32304
|
+
display_name: string;
|
|
32305
|
+
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
32306
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
32307
|
+
cooling_set_point_celsius?: number | undefined;
|
|
32308
|
+
heating_set_point_celsius?: number | undefined;
|
|
32309
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
32310
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
32311
|
+
manual_override_allowed: boolean;
|
|
32312
|
+
}> | undefined;
|
|
32313
|
+
fallback_climate_preset_key?: (string | null) | undefined;
|
|
32314
|
+
active_thermostat_schedule?: ({
|
|
32315
|
+
thermostat_schedule_id: string;
|
|
32316
|
+
device_id: string;
|
|
32317
|
+
name?: string | undefined;
|
|
32318
|
+
climate_preset_key: string;
|
|
32319
|
+
max_override_period_minutes?: number;
|
|
32320
|
+
starts_at: string;
|
|
32321
|
+
ends_at: string;
|
|
32322
|
+
created_at: string;
|
|
32323
|
+
/** 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. */
|
|
32324
|
+
errors?: any;
|
|
32325
|
+
} | null) | undefined;
|
|
32326
|
+
min_cooling_set_point_celsius?: number | undefined;
|
|
32327
|
+
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
32328
|
+
max_cooling_set_point_celsius?: number | undefined;
|
|
32329
|
+
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
32330
|
+
min_heating_set_point_celsius?: number | undefined;
|
|
32331
|
+
min_heating_set_point_fahrenheit?: number | undefined;
|
|
32332
|
+
max_heating_set_point_celsius?: number | undefined;
|
|
32333
|
+
max_heating_set_point_fahrenheit?: number | undefined;
|
|
32334
|
+
min_heating_cooling_delta_celsius?: number | undefined;
|
|
32335
|
+
min_heating_cooling_delta_fahrenheit?: number | undefined;
|
|
32336
|
+
});
|
|
32337
|
+
/** Location information for the device. */
|
|
32338
|
+
location: {
|
|
32339
|
+
/** Name of the device location. */
|
|
32340
|
+
location_name?: string | undefined;
|
|
32341
|
+
/** Time zone of the device location. */
|
|
32342
|
+
timezone?: string | undefined;
|
|
32343
|
+
} | null;
|
|
32344
|
+
/** Unique identifier for the account associated with the device. */
|
|
32345
|
+
connected_account_id: string;
|
|
32346
|
+
/** Unique identifier for the Seam workspace associated with the device. */
|
|
32347
|
+
workspace_id: string;
|
|
32348
|
+
/** 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. */
|
|
32349
|
+
errors: Array<{
|
|
32350
|
+
message: string;
|
|
32351
|
+
is_device_error: true;
|
|
32352
|
+
error_code: string;
|
|
32353
|
+
} | {
|
|
32354
|
+
message: string;
|
|
32355
|
+
is_connected_account_error: true;
|
|
32356
|
+
error_code: string;
|
|
32357
|
+
}>;
|
|
32358
|
+
/** 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. */
|
|
32359
|
+
warnings: Array<{
|
|
32360
|
+
message: string;
|
|
32361
|
+
warning_code: string;
|
|
32362
|
+
}>;
|
|
32363
|
+
/** Date and time at which the device object was created. */
|
|
32364
|
+
created_at: string;
|
|
32365
|
+
/** Indicates whether Seam manages the device. */
|
|
32366
|
+
is_managed: true;
|
|
32367
|
+
custom_metadata: Record<string, string | boolean>;
|
|
32368
|
+
can_remotely_unlock?: boolean | undefined;
|
|
32369
|
+
can_remotely_lock?: boolean | undefined;
|
|
32370
|
+
can_program_offline_access_codes?: boolean | undefined;
|
|
32371
|
+
can_program_online_access_codes?: boolean | undefined;
|
|
32372
|
+
can_hvac_heat?: boolean | undefined;
|
|
32373
|
+
can_hvac_cool?: boolean | undefined;
|
|
32374
|
+
can_hvac_heat_cool?: boolean | undefined;
|
|
32375
|
+
can_turn_off_hvac?: boolean | undefined;
|
|
32376
|
+
can_simulate_removal?: boolean | undefined;
|
|
32377
|
+
can_simulate_connection?: boolean | undefined;
|
|
32378
|
+
can_simulate_disconnection?: boolean | undefined;
|
|
32379
|
+
}>;
|
|
32380
|
+
};
|
|
32381
|
+
};
|
|
32382
|
+
'/acs/encoders/read_card': {
|
|
32383
|
+
route: '/acs/encoders/read_card';
|
|
32384
|
+
method: 'POST';
|
|
32385
|
+
queryParams: {};
|
|
32386
|
+
jsonBody: {};
|
|
32387
|
+
commonParams: {
|
|
32388
|
+
acs_system_id: string;
|
|
32389
|
+
device_name: string;
|
|
32390
|
+
} | {
|
|
32391
|
+
device_id: string;
|
|
32392
|
+
};
|
|
32393
|
+
formData: {};
|
|
32394
|
+
jsonResponse: {
|
|
32395
|
+
action_attempt: {
|
|
32396
|
+
/** The ID of the action attempt. */
|
|
32397
|
+
action_attempt_id: string;
|
|
32398
|
+
status: 'pending';
|
|
32399
|
+
result: null;
|
|
32400
|
+
error: null;
|
|
32401
|
+
action_type: 'LOCK_DOOR';
|
|
32402
|
+
} | {
|
|
32403
|
+
/** The ID of the action attempt. */
|
|
32404
|
+
action_attempt_id: string;
|
|
32405
|
+
status: 'success';
|
|
32406
|
+
error: null;
|
|
32407
|
+
action_type: 'LOCK_DOOR';
|
|
32408
|
+
result: {};
|
|
32409
|
+
} | {
|
|
32410
|
+
/** The ID of the action attempt. */
|
|
32411
|
+
action_attempt_id: string;
|
|
32412
|
+
status: 'error';
|
|
32413
|
+
result: null;
|
|
32414
|
+
action_type: 'LOCK_DOOR';
|
|
32415
|
+
error: {
|
|
32416
|
+
type: string;
|
|
32417
|
+
message: string;
|
|
32418
|
+
};
|
|
32419
|
+
} | {
|
|
32420
|
+
/** The ID of the action attempt. */
|
|
32421
|
+
action_attempt_id: string;
|
|
32422
|
+
status: 'pending';
|
|
32423
|
+
result: null;
|
|
32424
|
+
error: null;
|
|
32425
|
+
action_type: 'UNLOCK_DOOR';
|
|
32426
|
+
} | {
|
|
32427
|
+
/** The ID of the action attempt. */
|
|
32428
|
+
action_attempt_id: string;
|
|
32429
|
+
status: 'success';
|
|
32430
|
+
error: null;
|
|
32431
|
+
action_type: 'UNLOCK_DOOR';
|
|
32432
|
+
result: {};
|
|
32433
|
+
} | {
|
|
32434
|
+
/** The ID of the action attempt. */
|
|
32435
|
+
action_attempt_id: string;
|
|
32436
|
+
status: 'error';
|
|
32437
|
+
result: null;
|
|
32438
|
+
action_type: 'UNLOCK_DOOR';
|
|
32439
|
+
error: {
|
|
32440
|
+
type: string;
|
|
32441
|
+
message: string;
|
|
32442
|
+
};
|
|
32443
|
+
} | {
|
|
32444
|
+
/** The ID of the action attempt. */
|
|
32445
|
+
action_attempt_id: string;
|
|
32446
|
+
status: 'pending';
|
|
32447
|
+
result: null;
|
|
32448
|
+
error: null;
|
|
32449
|
+
action_type: 'READ_CARD';
|
|
32450
|
+
} | {
|
|
32451
|
+
/** The ID of the action attempt. */
|
|
32452
|
+
action_attempt_id: string;
|
|
32453
|
+
status: 'success';
|
|
32454
|
+
error: null;
|
|
32455
|
+
action_type: 'READ_CARD';
|
|
32456
|
+
result: {
|
|
32457
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
32458
|
+
acs_credential_id: string | null;
|
|
32459
|
+
/** A number or sting that physically identifies this card. */
|
|
32460
|
+
card_number: string | null;
|
|
32461
|
+
};
|
|
32462
|
+
} | {
|
|
32463
|
+
/** The ID of the action attempt. */
|
|
32464
|
+
action_attempt_id: string;
|
|
32465
|
+
status: 'error';
|
|
32466
|
+
result: null;
|
|
32467
|
+
action_type: 'READ_CARD';
|
|
32468
|
+
error: {
|
|
32469
|
+
type: string;
|
|
32470
|
+
message: string;
|
|
32471
|
+
};
|
|
32472
|
+
} | {
|
|
32473
|
+
/** The ID of the action attempt. */
|
|
32474
|
+
action_attempt_id: string;
|
|
31952
32475
|
status: 'pending';
|
|
31953
32476
|
result: null;
|
|
31954
32477
|
error: null;
|
|
@@ -42278,22 +42801,7 @@ interface Routes {
|
|
|
42278
42801
|
};
|
|
42279
42802
|
commonParams: {};
|
|
42280
42803
|
formData: {};
|
|
42281
|
-
jsonResponse: {
|
|
42282
|
-
climate_preset: {
|
|
42283
|
-
climate_preset_key: string;
|
|
42284
|
-
can_edit: boolean;
|
|
42285
|
-
can_delete: boolean;
|
|
42286
|
-
name?: (string | null) | undefined;
|
|
42287
|
-
display_name: string;
|
|
42288
|
-
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
42289
|
-
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
42290
|
-
cooling_set_point_celsius?: number | undefined;
|
|
42291
|
-
heating_set_point_celsius?: number | undefined;
|
|
42292
|
-
cooling_set_point_fahrenheit?: number | undefined;
|
|
42293
|
-
heating_set_point_fahrenheit?: number | undefined;
|
|
42294
|
-
manual_override_allowed: boolean;
|
|
42295
|
-
};
|
|
42296
|
-
};
|
|
42804
|
+
jsonResponse: {};
|
|
42297
42805
|
};
|
|
42298
42806
|
'/thermostats/delete_climate_preset': {
|
|
42299
42807
|
route: '/thermostats/delete_climate_preset';
|