Constructors
constructor
- new SeamHttpEvents(apiKeyOrOptions?): SeamHttpEvents
Properties
client
client: AxiosInstance
Readonlydefaults
Methods
get
- get(body?): SeamHttpRequest<SetNonNullable<Required<{
event?: {
acs_credential_id?: string;
acs_system_id?: string;
acs_user_id?: string;
action_attempt_id?: string;
client_session_id?: string;
climate_preset_key?: string;
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
created_at: string;
device_id?: string;
enrollment_automation_id?: string;
event_description: string;
event_id: string;
event_type: string;
fan_mode_setting?: string;
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
hvac_mode_setting?: string;
is_fallback_climate_preset?: boolean;
method?: string;
occurred_at: string;
thermostat_schedule_id?: null | string;
workspace_id: string;
};
message?: string;
}>, "message" | "event">, "event"> Parameters
Optionalbody: {
device_id?: string;
event_id?: string;
event_type?: string;
}Optionaldevice_id?: string
Optionalevent_id?: string
Optionalevent_type?: string
Returns SeamHttpRequest<SetNonNullable<Required<{
event?: {
acs_credential_id?: string;
acs_system_id?: string;
acs_user_id?: string;
action_attempt_id?: string;
client_session_id?: string;
climate_preset_key?: string;
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
created_at: string;
device_id?: string;
enrollment_automation_id?: string;
event_description: string;
event_id: string;
event_type: string;
fan_mode_setting?: string;
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
hvac_mode_setting?: string;
is_fallback_climate_preset?: boolean;
method?: string;
occurred_at: string;
thermostat_schedule_id?: null | string;
workspace_id: string;
};
message?: string;
}>, "message" | "event">, "event">
list
- list(body?): SeamHttpRequest<SetNonNullable<Required<{
events: {
acs_credential_id?: string;
acs_system_id?: string;
acs_user_id?: string;
action_attempt_id?: string;
client_session_id?: string;
climate_preset_key?: string;
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
created_at: string;
device_id?: string;
enrollment_automation_id?: string;
event_description: string;
event_id: string;
event_type: string;
fan_mode_setting?: string;
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
hvac_mode_setting?: string;
is_fallback_climate_preset?: boolean;
method?: string;
occurred_at: string;
thermostat_schedule_id?: null | string;
workspace_id: string;
}[];
}>, "events">, "events"> Parameters
Optionalbody: {
access_code_id?: string;
access_code_ids?: string[];
acs_system_id?: string;
acs_system_ids?: string[];
between?: (string | Date)[];
connect_webview_id?: string;
connected_account_id?: string;
device_id?: string;
device_ids?: string[];
event_type?:
| "access_code.created"
| "access_code.changed"
| "access_code.scheduled_on_device"
| "access_code.set_on_device"
| "access_code.removed_from_device"
| "access_code.delay_in_setting_on_device"
| "access_code.failed_to_set_on_device"
| "access_code.deleted"
| "access_code.delay_in_removing_from_device"
| "access_code.failed_to_remove_from_device"
| "access_code.modified_external_to_seam"
| "access_code.deleted_external_to_seam"
| "access_code.backup_access_code_pulled"
| "access_code.unmanaged.converted_to_managed"
| "access_code.unmanaged.failed_to_convert_to_managed"
| "access_code.unmanaged.created"
| "access_code.unmanaged.removed"
| "acs_system.connected"
| "acs_system.added"
| "acs_credential.deleted"
| "acs_credential.issued"
| "acs_user.deleted"
| "acs_encoder.added"
| "acs_encoder.removed"
| "action_attempt.lock_door.succeeded"
| "action_attempt.lock_door.failed"
| "action_attempt.unlock_door.succeeded"
| "action_attempt.unlock_door.failed"
| "client_session.deleted"
| "connected_account.connected"
| "connected_account.created"
| "connected_account.successful_login"
| "connected_account.disconnected"
| "connected_account.completed_first_sync"
| "connected_account.deleted"
| "connected_account.completed_first_sync_after_reconnection"
| "device.connected"
| "device.added"
| "device.converted_to_unmanaged"
| "device.unmanaged.converted_to_managed"
| "device.unmanaged.connected"
| "device.disconnected"
| "device.unmanaged.disconnected"
| "device.tampered"
| "device.low_battery"
| "device.battery_status_changed"
| "device.removed"
| "device.deleted"
| "device.third_party_integration_detected"
| "device.third_party_integration_no_longer_detected"
| "device.salto.privacy_mode_activated"
| "device.salto.privacy_mode_deactivated"
| "device.connection_became_flaky"
| "device.connection_stabilized"
| "device.error.subscription_required"
| "device.error.subscription_required.resolved"
| "device.accessory_keypad_connected"
| "device.accessory_keypad_disconnected"
| "noise_sensor.noise_threshold_triggered"
| "lock.locked"
| "lock.unlocked"
| "lock.access_denied"
| "thermostat.climate_preset_activated"
| "thermostat.manually_adjusted"
| "thermostat.temperature_threshold_exceeded"
| "thermostat.temperature_threshold_no_longer_exceeded"
| "enrollment_automation.deleted"
| "phone.deactivated"
| "connect_webview.login_succeeded"
| "connect_webview.login_failed";
event_types?: (
| "access_code.created"
| "access_code.changed"
| "access_code.scheduled_on_device"
| "access_code.set_on_device"
| "access_code.removed_from_device"
| "access_code.delay_in_setting_on_device"
| "access_code.failed_to_set_on_device"
| "access_code.deleted"
| "access_code.delay_in_removing_from_device"
| "access_code.failed_to_remove_from_device"
| "access_code.modified_external_to_seam"
| "access_code.deleted_external_to_seam"
| "access_code.backup_access_code_pulled"
| "access_code.unmanaged.converted_to_managed"
| "access_code.unmanaged.failed_to_convert_to_managed"
| "access_code.unmanaged.created"
| "access_code.unmanaged.removed"
| "acs_system.connected"
| "acs_system.added"
| "acs_credential.deleted"
| "acs_credential.issued"
| "acs_user.deleted"
| "acs_encoder.added"
| "acs_encoder.removed"
| "action_attempt.lock_door.succeeded"
| "action_attempt.lock_door.failed"
| "action_attempt.unlock_door.succeeded"
| "action_attempt.unlock_door.failed"
| "client_session.deleted"
| "connected_account.connected"
| "connected_account.created"
| "connected_account.successful_login"
| "connected_account.disconnected"
| "connected_account.completed_first_sync"
| "connected_account.deleted"
| "connected_account.completed_first_sync_after_reconnection"
| "device.connected"
| "device.added"
| "device.converted_to_unmanaged"
| "device.unmanaged.converted_to_managed"
| "device.unmanaged.connected"
| "device.disconnected"
| "device.unmanaged.disconnected"
| "device.tampered"
| "device.low_battery"
| "device.battery_status_changed"
| "device.removed"
| "device.deleted"
| "device.third_party_integration_detected"
| "device.third_party_integration_no_longer_detected"
| "device.salto.privacy_mode_activated"
| "device.salto.privacy_mode_deactivated"
| "device.connection_became_flaky"
| "device.connection_stabilized"
| "device.error.subscription_required"
| "device.error.subscription_required.resolved"
| "device.accessory_keypad_connected"
| "device.accessory_keypad_disconnected"
| "noise_sensor.noise_threshold_triggered"
| "lock.locked"
| "lock.unlocked"
| "lock.access_denied"
| "thermostat.climate_preset_activated"
| "thermostat.manually_adjusted"
| "thermostat.temperature_threshold_exceeded"
| "thermostat.temperature_threshold_no_longer_exceeded"
| "enrollment_automation.deleted"
| "phone.deactivated"
| "connect_webview.login_succeeded"
| "connect_webview.login_failed")[];
limit?: number;
since?: string;
unstable_offset?: number;
}Optionalaccess_code_id?: string
Optionalaccess_code_ids?: string[]
Optionalacs_system_id?: string
Optionalacs_system_ids?: string[]
Optionalbetween?: (string | Date)[]
Optionalconnect_webview_id?: string
Optionalconnected_account_id?: string
Optionaldevice_id?: string
Optionaldevice_ids?: string[]
Optionalevent_type?:
| "access_code.created"
| "access_code.changed"
| "access_code.scheduled_on_device"
| "access_code.set_on_device"
| "access_code.removed_from_device"
| "access_code.delay_in_setting_on_device"
| "access_code.failed_to_set_on_device"
| "access_code.deleted"
| "access_code.delay_in_removing_from_device"
| "access_code.failed_to_remove_from_device"
| "access_code.modified_external_to_seam"
| "access_code.deleted_external_to_seam"
| "access_code.backup_access_code_pulled"
| "access_code.unmanaged.converted_to_managed"
| "access_code.unmanaged.failed_to_convert_to_managed"
| "access_code.unmanaged.created"
| "access_code.unmanaged.removed"
| "acs_system.connected"
| "acs_system.added"
| "acs_credential.deleted"
| "acs_credential.issued"
| "acs_user.deleted"
| "acs_encoder.added"
| "acs_encoder.removed"
| "action_attempt.lock_door.succeeded"
| "action_attempt.lock_door.failed"
| "action_attempt.unlock_door.succeeded"
| "action_attempt.unlock_door.failed"
| "client_session.deleted"
| "connected_account.connected"
| "connected_account.created"
| "connected_account.successful_login"
| "connected_account.disconnected"
| "connected_account.completed_first_sync"
| "connected_account.deleted"
| "connected_account.completed_first_sync_after_reconnection"
| "device.connected"
| "device.added"
| "device.converted_to_unmanaged"
| "device.unmanaged.converted_to_managed"
| "device.unmanaged.connected"
| "device.disconnected"
| "device.unmanaged.disconnected"
| "device.tampered"
| "device.low_battery"
| "device.battery_status_changed"
| "device.removed"
| "device.deleted"
| "device.third_party_integration_detected"
| "device.third_party_integration_no_longer_detected"
| "device.salto.privacy_mode_activated"
| "device.salto.privacy_mode_deactivated"
| "device.connection_became_flaky"
| "device.connection_stabilized"
| "device.error.subscription_required"
| "device.error.subscription_required.resolved"
| "device.accessory_keypad_connected"
| "device.accessory_keypad_disconnected"
| "noise_sensor.noise_threshold_triggered"
| "lock.locked"
| "lock.unlocked"
| "lock.access_denied"
| "thermostat.climate_preset_activated"
| "thermostat.manually_adjusted"
| "thermostat.temperature_threshold_exceeded"
| "thermostat.temperature_threshold_no_longer_exceeded"
| "enrollment_automation.deleted"
| "phone.deactivated"
| "connect_webview.login_succeeded"
| "connect_webview.login_failed"
Optionalevent_types?: (
| "access_code.created"
| "access_code.changed"
| "access_code.scheduled_on_device"
| "access_code.set_on_device"
| "access_code.removed_from_device"
| "access_code.delay_in_setting_on_device"
| "access_code.failed_to_set_on_device"
| "access_code.deleted"
| "access_code.delay_in_removing_from_device"
| "access_code.failed_to_remove_from_device"
| "access_code.modified_external_to_seam"
| "access_code.deleted_external_to_seam"
| "access_code.backup_access_code_pulled"
| "access_code.unmanaged.converted_to_managed"
| "access_code.unmanaged.failed_to_convert_to_managed"
| "access_code.unmanaged.created"
| "access_code.unmanaged.removed"
| "acs_system.connected"
| "acs_system.added"
| "acs_credential.deleted"
| "acs_credential.issued"
| "acs_user.deleted"
| "acs_encoder.added"
| "acs_encoder.removed"
| "action_attempt.lock_door.succeeded"
| "action_attempt.lock_door.failed"
| "action_attempt.unlock_door.succeeded"
| "action_attempt.unlock_door.failed"
| "client_session.deleted"
| "connected_account.connected"
| "connected_account.created"
| "connected_account.successful_login"
| "connected_account.disconnected"
| "connected_account.completed_first_sync"
| "connected_account.deleted"
| "connected_account.completed_first_sync_after_reconnection"
| "device.connected"
| "device.added"
| "device.converted_to_unmanaged"
| "device.unmanaged.converted_to_managed"
| "device.unmanaged.connected"
| "device.disconnected"
| "device.unmanaged.disconnected"
| "device.tampered"
| "device.low_battery"
| "device.battery_status_changed"
| "device.removed"
| "device.deleted"
| "device.third_party_integration_detected"
| "device.third_party_integration_no_longer_detected"
| "device.salto.privacy_mode_activated"
| "device.salto.privacy_mode_deactivated"
| "device.connection_became_flaky"
| "device.connection_stabilized"
| "device.error.subscription_required"
| "device.error.subscription_required.resolved"
| "device.accessory_keypad_connected"
| "device.accessory_keypad_disconnected"
| "noise_sensor.noise_threshold_triggered"
| "lock.locked"
| "lock.unlocked"
| "lock.access_denied"
| "thermostat.climate_preset_activated"
| "thermostat.manually_adjusted"
| "thermostat.temperature_threshold_exceeded"
| "thermostat.temperature_threshold_no_longer_exceeded"
| "enrollment_automation.deleted"
| "phone.deactivated"
| "connect_webview.login_succeeded"
| "connect_webview.login_failed")[]
Optionallimit?: number
Optionalsince?: string
Optionalunstable_offset?: number
Returns SeamHttpRequest<SetNonNullable<Required<{
events: {
acs_credential_id?: string;
acs_system_id?: string;
acs_user_id?: string;
action_attempt_id?: string;
client_session_id?: string;
climate_preset_key?: string;
cooling_set_point_celsius?: number;
cooling_set_point_fahrenheit?: number;
created_at: string;
device_id?: string;
enrollment_automation_id?: string;
event_description: string;
event_id: string;
event_type: string;
fan_mode_setting?: string;
heating_set_point_celsius?: number;
heating_set_point_fahrenheit?: number;
hvac_mode_setting?: string;
is_fallback_climate_preset?: boolean;
method?: string;
occurred_at: string;
thermostat_schedule_id?: null | string;
workspace_id: string;
}[];
}>, "events">, "events">
updateClientSessionToken
- updateClientSessionToken(clientSessionToken): Promise<void>
Parameters
- clientSessionToken: string
Returns Promise<void>
StaticfromApiKey
- fromApiKey(apiKey, options?): SeamHttpEvents
StaticfromClient
- fromClient(client, options?): SeamHttpEvents
StaticfromClientSessionToken
- fromClientSessionToken(clientSessionToken, options?): SeamHttpEvents
StaticfromConsoleSessionToken
- fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpEvents
StaticfromPersonalAccessToken
- fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpEvents
StaticfromPublishableKey
- fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpEvents>