Constructors
constructor
- new SeamHttpLocks(apiKeyOrOptions?): SeamHttpLocks
Properties
client
client: AxiosInstance
Readonly defaults
Methods
get
- get(body?): SeamHttpRequest<SetNonNullable<Required<{
device: {
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_removal?: boolean;
capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
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";
display_name: string;
errors: {
error_code: string;
message: string;
}[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: {
level: ...;
};
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status: "low" | "full" | "critical" | "good";
};
battery_level?: number;
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: {
endpoint_id: ...;
is_active: ...;
}[];
has_active_endpoint: boolean;
};
} & {
august_metadata?: {
has_keypad: boolean;
house_id?: string;
house_name: string;
keypad_battery_level?: string;
lock_id: string;
lock_name: string;
model?: string;
};
avigilon_alta_metadata?: {
entry_name: string;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: null | string;
};
dormakaba_oracode_metadata?: {
device_id?: number;
door_id: number;
door_is_wireless: boolean;
door_name: string;
iana_timezone?: string;
predefined_time_slots?: (...)[];
site_id: number;
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: string;
};
igloohome_metadata?: {
bridge_id?: string;
bridge_name?: string;
device_id: string;
device_name: string;
keypad_id?: string;
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: string;
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: {
time: ...;
value: ...;
};
humidity: {
time: ...;
value: ...;
};
pressure: {
time: ...;
value: ...;
};
sound: {
time: ...;
value: ...;
};
temperature: {
time: ...;
value: ...;
};
};
};
nest_metadata?: {
custom_name: string;
device_name: string;
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: "indoor" | "outdoor";
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: boolean;
keypad_battery_critical?: boolean;
keypad_paired?: boolean;
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: string;
};
schlage_metadata?: {
access_code_length: null | number;
device_id: string;
device_name: string;
model?: string;
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: "bridge" | "doorking";
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: string;
model?: string;
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: number;
serial_number: string;
};
ttlock_metadata?: {
lock_alias: string;
lock_id: number;
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: string;
locker_status_hardlock?: number;
product_model: string;
product_name: string;
product_type: string;
};
} & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
};
lock: {
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_removal?: boolean;
capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
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";
display_name: string;
errors: {
error_code: string;
message: string;
}[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: {
level: ...;
};
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status: "low" | "full" | "critical" | "good";
};
battery_level?: number;
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: {
endpoint_id: ...;
is_active: ...;
}[];
has_active_endpoint: boolean;
};
} & {
august_metadata?: {
has_keypad: boolean;
house_id?: string;
house_name: string;
keypad_battery_level?: string;
lock_id: string;
lock_name: string;
model?: string;
};
avigilon_alta_metadata?: {
entry_name: string;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: null | string;
};
dormakaba_oracode_metadata?: {
device_id?: number;
door_id: number;
door_is_wireless: boolean;
door_name: string;
iana_timezone?: string;
predefined_time_slots?: (...)[];
site_id: number;
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: string;
};
igloohome_metadata?: {
bridge_id?: string;
bridge_name?: string;
device_id: string;
device_name: string;
keypad_id?: string;
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: string;
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: {
time: ...;
value: ...;
};
humidity: {
time: ...;
value: ...;
};
pressure: {
time: ...;
value: ...;
};
sound: {
time: ...;
value: ...;
};
temperature: {
time: ...;
value: ...;
};
};
};
nest_metadata?: {
custom_name: string;
device_name: string;
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: "indoor" | "outdoor";
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: boolean;
keypad_battery_critical?: boolean;
keypad_paired?: boolean;
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: string;
};
schlage_metadata?: {
access_code_length: null | number;
device_id: string;
device_name: string;
model?: string;
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: "bridge" | "doorking";
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: string;
model?: string;
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: number;
serial_number: string;
};
ttlock_metadata?: {
lock_alias: string;
lock_id: number;
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: string;
locker_status_hardlock?: number;
product_model: string;
product_name: string;
product_type: string;
};
} & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
};
}>, "lock" | "device">, "device"> Parameters
Optional body: {
device_id?: string;
name?: string;
}Optional device_id?: string
Optional name?: string
Returns SeamHttpRequest<SetNonNullable<Required<{
device: {
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_removal?: boolean;
capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
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";
display_name: string;
errors: {
error_code: string;
message: string;
}[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: {
level: ...;
};
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status: "low" | "full" | "critical" | "good";
};
battery_level?: number;
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: {
endpoint_id: ...;
is_active: ...;
}[];
has_active_endpoint: boolean;
};
} & {
august_metadata?: {
has_keypad: boolean;
house_id?: string;
house_name: string;
keypad_battery_level?: string;
lock_id: string;
lock_name: string;
model?: string;
};
avigilon_alta_metadata?: {
entry_name: string;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: null | string;
};
dormakaba_oracode_metadata?: {
device_id?: number;
door_id: number;
door_is_wireless: boolean;
door_name: string;
iana_timezone?: string;
predefined_time_slots?: (...)[];
site_id: number;
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: string;
};
igloohome_metadata?: {
bridge_id?: string;
bridge_name?: string;
device_id: string;
device_name: string;
keypad_id?: string;
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: string;
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: {
time: ...;
value: ...;
};
humidity: {
time: ...;
value: ...;
};
pressure: {
time: ...;
value: ...;
};
sound: {
time: ...;
value: ...;
};
temperature: {
time: ...;
value: ...;
};
};
};
nest_metadata?: {
custom_name: string;
device_name: string;
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: "indoor" | "outdoor";
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: boolean;
keypad_battery_critical?: boolean;
keypad_paired?: boolean;
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: string;
};
schlage_metadata?: {
access_code_length: null | number;
device_id: string;
device_name: string;
model?: string;
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: "bridge" | "doorking";
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: string;
model?: string;
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: number;
serial_number: string;
};
ttlock_metadata?: {
lock_alias: string;
lock_id: number;
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: string;
locker_status_hardlock?: number;
product_model: string;
product_name: string;
product_type: string;
};
} & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
};
lock: {
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_removal?: boolean;
capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
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";
display_name: string;
errors: {
error_code: string;
message: string;
}[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: {
level: ...;
};
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status: "low" | "full" | "critical" | "good";
};
battery_level?: number;
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: {
endpoint_id: ...;
is_active: ...;
}[];
has_active_endpoint: boolean;
};
} & {
august_metadata?: {
has_keypad: boolean;
house_id?: string;
house_name: string;
keypad_battery_level?: string;
lock_id: string;
lock_name: string;
model?: string;
};
avigilon_alta_metadata?: {
entry_name: string;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: null | string;
};
dormakaba_oracode_metadata?: {
device_id?: number;
door_id: number;
door_is_wireless: boolean;
door_name: string;
iana_timezone?: string;
predefined_time_slots?: (...)[];
site_id: number;
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: string;
};
igloohome_metadata?: {
bridge_id?: string;
bridge_name?: string;
device_id: string;
device_name: string;
keypad_id?: string;
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: string;
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: {
time: ...;
value: ...;
};
humidity: {
time: ...;
value: ...;
};
pressure: {
time: ...;
value: ...;
};
sound: {
time: ...;
value: ...;
};
temperature: {
time: ...;
value: ...;
};
};
};
nest_metadata?: {
custom_name: string;
device_name: string;
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: "indoor" | "outdoor";
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: boolean;
keypad_battery_critical?: boolean;
keypad_paired?: boolean;
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: string;
};
schlage_metadata?: {
access_code_length: null | number;
device_id: string;
device_name: string;
model?: string;
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: "bridge" | "doorking";
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: string;
model?: string;
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: number;
serial_number: string;
};
ttlock_metadata?: {
lock_alias: string;
lock_id: number;
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: string;
locker_status_hardlock?: number;
product_model: string;
product_name: string;
product_type: string;
};
} & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
};
}>, "lock" | "device">, "device">
list
- list(body?): SeamHttpRequest<SetNonNullable<Required<{
devices: {
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_removal?: boolean;
capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
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";
display_name: string;
errors: {
error_code: string;
message: string;
}[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: (...) | (...);
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status: (...) | (...) | (...) | (...);
};
battery_level?: number;
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: (...)[];
has_active_endpoint: boolean;
};
} & {
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...) | (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...) | (...);
door_id: number;
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: number;
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...) | (...);
};
igloohome_metadata?: {
bridge_id?: (...) | (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
keypad_id?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...) | (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
custom_name: string;
device_name: string;
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...) | (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...) | (...) | (...);
keypad_battery_critical?: (...) | (...) | (...);
keypad_paired?: (...) | (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
schlage_metadata?: {
access_code_length: (...) | (...);
device_id: string;
device_name: string;
model?: (...) | (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...) | (...) | (...);
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...) | (...);
model?: (...) | (...);
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
lock_alias: string;
lock_id: number;
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
}[];
locks: {
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_removal?: boolean;
capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
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";
display_name: string;
errors: {
error_code: string;
message: string;
}[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: (...) | (...);
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status: (...) | (...) | (...) | (...);
};
battery_level?: number;
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: (...)[];
has_active_endpoint: boolean;
};
} & {
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...) | (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...) | (...);
door_id: number;
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: number;
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...) | (...);
};
igloohome_metadata?: {
bridge_id?: (...) | (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
keypad_id?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...) | (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
custom_name: string;
device_name: string;
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...) | (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...) | (...) | (...);
keypad_battery_critical?: (...) | (...) | (...);
keypad_paired?: (...) | (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
schlage_metadata?: {
access_code_length: (...) | (...);
device_id: string;
device_name: string;
model?: (...) | (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...) | (...) | (...);
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...) | (...);
model?: (...) | (...);
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
lock_alias: string;
lock_id: number;
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
}[];
}>, "devices" | "locks">, "devices"> Parameters
Optional body: {
connect_webview_id?: string;
connected_account_id?: string;
connected_account_ids?: string[];
created_before?: Date;
custom_metadata_has?: Record<string, string | boolean>;
device_ids?: string[];
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";
device_types?: ("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")[];
exclude_if?: ("can_remotely_unlock" | "can_remotely_lock" | "can_program_offline_access_codes" | "can_program_online_access_codes" | "can_simulate_removal")[];
include_if?: ("can_remotely_unlock" | "can_remotely_lock" | "can_program_offline_access_codes" | "can_program_online_access_codes" | "can_simulate_removal")[];
limit?: number;
manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n";
user_identifier_key?: string;
}Optional connect_webview_id?: string
Optional connected_account_id?: string
Optional connected_account_ids?: string[]
Optional created_before?: Date
Optional custom_metadata_has?: Record<string, string | boolean>
Optional device_ids?: string[]
Optional 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"
Optional device_types?: ("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")[]
Optional exclude_if?: ("can_remotely_unlock" | "can_remotely_lock" | "can_program_offline_access_codes" | "can_program_online_access_codes" | "can_simulate_removal")[]
Optional include_if?: ("can_remotely_unlock" | "can_remotely_lock" | "can_program_offline_access_codes" | "can_program_online_access_codes" | "can_simulate_removal")[]
Optional limit?: number
Optional manufacturer?: "linear" | "unknown" | "doorking" | "akuvox" | "august" | "avigilon_alta" | "brivo" | "butterflymx" | "schlage" | "smartthings" | "yale" | "genie" | "salto" | "lockly" | "ttlock" | "nuki" | "igloo" | "kwikset" | "minut" | "controlbyweb" | "nest" | "igloohome" | "ecobee" | "hubitat" | "four_suites" | "dormakaba_oracode" | "wyze" | "tedee" | "honeywell_resideo" | "keywe" | "philia" | "samsung" | "seam" | "two_n"
Optional user_identifier_key?: string
Returns SeamHttpRequest<SetNonNullable<Required<{
devices: {
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_removal?: boolean;
capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
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";
display_name: string;
errors: {
error_code: string;
message: string;
}[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: (...) | (...);
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status: (...) | (...) | (...) | (...);
};
battery_level?: number;
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: (...)[];
has_active_endpoint: boolean;
};
} & {
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...) | (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...) | (...);
door_id: number;
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: number;
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...) | (...);
};
igloohome_metadata?: {
bridge_id?: (...) | (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
keypad_id?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...) | (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
custom_name: string;
device_name: string;
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...) | (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...) | (...) | (...);
keypad_battery_critical?: (...) | (...) | (...);
keypad_paired?: (...) | (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
schlage_metadata?: {
access_code_length: (...) | (...);
device_id: string;
device_name: string;
model?: (...) | (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...) | (...) | (...);
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...) | (...);
model?: (...) | (...);
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
lock_alias: string;
lock_id: number;
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
}[];
locks: {
can_program_offline_access_codes?: boolean;
can_program_online_access_codes?: boolean;
can_remotely_lock?: boolean;
can_remotely_unlock?: boolean;
can_simulate_removal?: boolean;
capabilities_supported: ("access_code" | "lock" | "noise_detection" | "thermostat" | "battery" | "phone")[];
connected_account_id: string;
created_at: string;
custom_metadata: Record<string, string | boolean>;
device_id: string;
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";
display_name: string;
errors: {
error_code: string;
message: string;
}[];
is_managed: true;
location: null | {
location_name?: string;
timezone?: string;
};
nickname?: string;
properties: {
accessory_keypad?: {
battery?: (...) | (...);
is_connected: boolean;
};
appearance: {
name: string;
};
battery?: {
level: number;
status: (...) | (...) | (...) | (...);
};
battery_level?: number;
has_direct_power?: boolean;
image_alt_text?: string;
image_url?: string;
manufacturer?: string;
model: {
accessory_keypad_supported?: boolean;
can_connect_accessory_keypad?: boolean;
display_name: string;
has_built_in_keypad?: boolean;
manufacturer_display_name: string;
offline_access_codes_supported?: boolean;
online_access_codes_supported?: boolean;
};
name: string;
offline_access_codes_enabled?: boolean;
online: boolean;
online_access_codes_enabled?: boolean;
serial_number?: string;
supports_accessory_keypad?: boolean;
supports_offline_access_codes?: boolean;
} & {
assa_abloy_credential_service_metadata?: {
endpoints: (...)[];
has_active_endpoint: boolean;
};
} & {
august_metadata?: {
has_keypad: boolean;
house_id?: (...) | (...);
house_name: string;
keypad_battery_level?: (...) | (...);
lock_id: string;
lock_name: string;
model?: (...) | (...);
};
avigilon_alta_metadata?: {
entry_name: string;
org_name: string;
site_id: number;
site_name: string;
zone_id: number;
zone_name: string;
};
brivo_metadata?: {
device_name: string;
};
controlbyweb_metadata?: {
device_id: string;
device_name: string;
relay_name: (...) | (...);
};
dormakaba_oracode_metadata?: {
device_id?: (...) | (...);
door_id: number;
door_is_wireless: boolean;
door_name: string;
iana_timezone?: (...) | (...);
predefined_time_slots?: (...) | (...);
site_id: number;
site_name: string;
};
ecobee_metadata?: {
device_name: string;
ecobee_device_id: string;
};
four_suites_metadata?: {
device_id: number;
device_name: string;
reclose_delay_in_seconds: number;
};
genie_metadata?: {
device_name: string;
door_name: string;
};
honeywell_resideo_metadata?: {
device_name: string;
honeywell_resideo_device_id: string;
};
hubitat_metadata?: {
device_id: string;
device_label: string;
device_name: string;
};
igloo_metadata?: {
bridge_id: string;
device_id: string;
model?: (...) | (...);
};
igloohome_metadata?: {
bridge_id?: (...) | (...);
bridge_name?: (...) | (...);
device_id: string;
device_name: string;
keypad_id?: (...) | (...);
};
kwikset_metadata?: {
device_id: string;
device_name: string;
model_number: string;
};
lockly_metadata?: {
device_id: string;
device_name: string;
model?: (...) | (...);
};
minut_metadata?: {
device_id: string;
device_name: string;
latest_sensor_values: {
accelerometer_z: ...;
humidity: ...;
pressure: ...;
sound: ...;
temperature: ...;
};
};
nest_metadata?: {
custom_name: string;
device_name: string;
nest_device_id: string;
};
noiseaware_metadata?: {
device_id: string;
device_model: (...) | (...);
device_name: string;
noise_level_decibel: number;
noise_level_nrs: number;
};
nuki_metadata?: {
device_id: string;
device_name: string;
keypad_2_paired?: (...) | (...) | (...);
keypad_battery_critical?: (...) | (...) | (...);
keypad_paired?: (...) | (...) | (...);
};
salto_metadata?: {
battery_level: string;
customer_reference: string;
lock_id: string;
lock_type: string;
locked_state: string;
model?: (...) | (...);
};
schlage_metadata?: {
access_code_length: (...) | (...);
device_id: string;
device_name: string;
model?: (...) | (...);
};
seam_bridge_metadata?: {
device_num: number;
name: string;
unlock_method?: (...) | (...) | (...);
};
smartthings_metadata?: {
device_id: string;
device_name: string;
location_id?: (...) | (...);
model?: (...) | (...);
};
tedee_metadata?: {
bridge_id: number;
bridge_name: string;
device_id: number;
device_model: string;
device_name: string;
keypad_id?: (...) | (...);
serial_number: string;
};
ttlock_metadata?: {
lock_alias: string;
lock_id: number;
};
two_n_metadata?: {
device_id: number;
device_name: string;
};
wyze_metadata?: {
device_id: string;
device_info_model: string;
device_name: string;
keypad_uuid?: (...) | (...);
locker_status_hardlock?: (...) | (...);
product_model: string;
product_name: string;
product_type: string;
};
} & ({ _experimental_supported_code_from_access_codes_lengths?: number[] | undefined; code_constraints?: ({ constraint_type: "no_zeros" | "cannot_start_with_12" | "no_triple_consecutive_ints" | ... 5 more ... | "cannot_contain_089"; } | { ...; })[] | undefined; ... 6 more ...; door_open?: boolean | undefined; } & ({ ...;...);
warnings: {
message: string;
warning_code: string;
}[];
workspace_id: string;
}[];
}>, "devices" | "locks">, "devices">
lockDoor
- lockDoor(body?, options?): SeamHttpRequest<SetNonNullable<Required<{
action_attempt: {
action_attempt_id: string;
action_type: string;
error: null;
result?: any;
status: "success";
} | {
action_attempt_id: string;
action_type: string;
error: null;
result: null;
status: "pending";
} | {
action_attempt_id: string;
action_type: string;
error: {
message: string;
type: string;
};
result: null;
status: "error";
};
}>, "action_attempt">, "action_attempt"> Parameters
Optional body: {
device_id: string;
sync?: boolean;
}device_id: string
Optional sync?: boolean
- options: Pick<SeamHttpRequestOptions, "waitForActionAttempt"> = {}
Returns SeamHttpRequest<SetNonNullable<Required<{
action_attempt: {
action_attempt_id: string;
action_type: string;
error: null;
result?: any;
status: "success";
} | {
action_attempt_id: string;
action_type: string;
error: null;
result: null;
status: "pending";
} | {
action_attempt_id: string;
action_type: string;
error: {
message: string;
type: string;
};
result: null;
status: "error";
};
}>, "action_attempt">, "action_attempt">
unlockDoor
- unlockDoor(body?, options?): SeamHttpRequest<SetNonNullable<Required<{
action_attempt: {
action_attempt_id: string;
action_type: string;
error: null;
result?: any;
status: "success";
} | {
action_attempt_id: string;
action_type: string;
error: null;
result: null;
status: "pending";
} | {
action_attempt_id: string;
action_type: string;
error: {
message: string;
type: string;
};
result: null;
status: "error";
};
}>, "action_attempt">, "action_attempt"> Parameters
Optional body: {
device_id: string;
sync?: boolean;
}device_id: string
Optional sync?: boolean
- options: Pick<SeamHttpRequestOptions, "waitForActionAttempt"> = {}
Returns SeamHttpRequest<SetNonNullable<Required<{
action_attempt: {
action_attempt_id: string;
action_type: string;
error: null;
result?: any;
status: "success";
} | {
action_attempt_id: string;
action_type: string;
error: null;
result: null;
status: "pending";
} | {
action_attempt_id: string;
action_type: string;
error: {
message: string;
type: string;
};
result: null;
status: "error";
};
}>, "action_attempt">, "action_attempt">
updateClientSessionToken
- updateClientSessionToken(clientSessionToken): Promise<void>
Parameters
- clientSessionToken: string
Returns Promise<void>
Static fromApiKey
- fromApiKey(apiKey, options?): SeamHttpLocks
Static fromClient
- fromClient(client, options?): SeamHttpLocks
Static fromClientSessionToken
- fromClientSessionToken(clientSessionToken, options?): SeamHttpLocks
Static fromConsoleSessionToken
- fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpLocks
Static fromPersonalAccessToken
- fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpLocks
Static fromPublishableKey
- fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpLocks>
List all devices owned by this connected account