Constructors

Properties

client: AxiosInstance
defaults: Required<SeamHttpRequestOptions>

Methods

  • 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?:
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.created";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.changed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                code: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.scheduled_on_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                code: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.set_on_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.removed_from_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.delay_in_setting_on_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.failed_to_set_on_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                code: null | string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.delay_in_removing_from_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.failed_to_remove_from_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.modified_external_to_seam";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.deleted_external_to_seam";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                backup_access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.backup_access_code_pulled";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.unmanaged.converted_to_managed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.unmanaged.failed_to_convert_to_managed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.unmanaged.created";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.unmanaged.removed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_system.connected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_system.added";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_system.disconnected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_credential_id: string;
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_credential.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_credential_id: string;
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_credential.issued";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_system_id: string;
                acs_user_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_user.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_encoder_id: string;
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_encoder.added";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_encoder_id: string;
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_encoder.removed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                client_session_id: string;
                created_at: string;
                event_id: string;
                event_type: "client_session.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connect_webview_id: string;
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.connected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connect_webview_id: string;
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.created";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connect_webview_id: string;
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.successful_login";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.disconnected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.completed_first_sync";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.completed_first_sync_after_reconnection";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                action_attempt_id: string;
                action_type: string;
                created_at: string;
                event_id: string;
                event_type: "action_attempt.lock_door.succeeded";
                occurred_at: string;
                status: string;
                workspace_id: string;
            }
            | {
                action_attempt_id: string;
                action_type: string;
                created_at: string;
                event_id: string;
                event_type: "action_attempt.lock_door.failed";
                occurred_at: string;
                status: string;
                workspace_id: string;
            }
            | {
                action_attempt_id: string;
                action_type: string;
                created_at: string;
                event_id: string;
                event_type: "action_attempt.unlock_door.succeeded";
                occurred_at: string;
                status: string;
                workspace_id: string;
            }
            | {
                action_attempt_id: string;
                action_type: string;
                created_at: string;
                event_id: string;
                event_type: "action_attempt.unlock_door.failed";
                occurred_at: string;
                status: string;
                workspace_id: string;
            }
            | {
                connect_webview_id: string;
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connect_webview.login_succeeded";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connect_webview_id: string;
                created_at: string;
                event_id: string;
                event_type: "connect_webview.login_failed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.connected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.added";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.converted_to_unmanaged";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.unmanaged.converted_to_managed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.unmanaged.connected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                error_code: "account_disconnected" | "hub_disconnected" | "device_disconnected";
                event_id: string;
                event_type: "device.disconnected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                error_code: "account_disconnected" | "hub_disconnected" | "device_disconnected";
                event_id: string;
                event_type: "device.unmanaged.disconnected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.tampered";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                battery_level: number;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.low_battery";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                battery_level: number;
                battery_status:
                    | "low"
                    | "full"
                    | "critical"
                    | "good";
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.battery_status_changed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.removed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.third_party_integration_detected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.third_party_integration_no_longer_detected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.salto.privacy_mode_activated";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.salto.privacy_mode_deactivated";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.connection_became_flaky";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.connection_stabilized";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.error.subscription_required";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.error.subscription_required.resolved";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.accessory_keypad_connected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.accessory_keypad_disconnected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "noise_sensor.noise_threshold_triggered";
                minut_metadata?: Record<string, unknown>;
                noise_level_decibels?: number;
                noise_level_nrs?: number;
                noise_threshold_id?: string;
                noise_threshold_name?: string;
                noiseaware_metadata?: Record<string, unknown>;
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id?: string;
                action_attempt_id?: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "lock.locked";
                method:
                    | "manual"
                    | "unknown"
                    | "keycode"
                    | "automatic"
                    | "seamapi";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id?: string;
                action_attempt_id?: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "lock.unlocked";
                method:
                    | "manual"
                    | "unknown"
                    | "keycode"
                    | "automatic"
                    | "seamapi";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id?: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "lock.access_denied";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                climate_preset_key: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "thermostat.climate_preset_activated";
                is_fallback_climate_preset: boolean;
                occurred_at: string;
                thermostat_schedule_id: null | string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "thermostat.manually_adjusted";
                fan_mode_setting?: "auto" | "on" | "circulate";
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?:
                    | "off"
                    | "heat"
                    | "cool"
                    | "heat_cool";
                method: "external" | "seam";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "thermostat.temperature_threshold_exceeded";
                lower_limit_celsius: null | number;
                lower_limit_fahrenheit: null | number;
                occurred_at: string;
                temperature_celsius: number;
                temperature_fahrenheit: number;
                upper_limit_celsius: null | number;
                upper_limit_fahrenheit: null | number;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "thermostat.temperature_threshold_no_longer_exceeded";
                lower_limit_celsius: null | number;
                lower_limit_fahrenheit: null | number;
                occurred_at: string;
                temperature_celsius: number;
                temperature_fahrenheit: number;
                upper_limit_celsius: null | number;
                upper_limit_fahrenheit: null | number;
                workspace_id: string;
            }
            | {
                created_at: string;
                enrollment_automation_id: string;
                event_id: string;
                event_type: "enrollment_automation.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "phone.deactivated";
                occurred_at: string;
                workspace_id: string;
            };
        message?: string;
    }>, "message" | "event">, "event">

  • 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_system.disconnected"
              | "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_system.disconnected"
              | "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_system.disconnected"
            | "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_system.disconnected"
            | "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: (
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.created";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.changed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                code: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.scheduled_on_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                code: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.set_on_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.removed_from_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.delay_in_setting_on_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.failed_to_set_on_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                code: null | string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.delay_in_removing_from_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.failed_to_remove_from_device";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.modified_external_to_seam";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.deleted_external_to_seam";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                backup_access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.backup_access_code_pulled";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.unmanaged.converted_to_managed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.unmanaged.failed_to_convert_to_managed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.unmanaged.created";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "access_code.unmanaged.removed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_system.connected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_system.added";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_system.disconnected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_credential_id: string;
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_credential.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_credential_id: string;
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_credential.issued";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_system_id: string;
                acs_user_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_user.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_encoder_id: string;
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_encoder.added";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                acs_encoder_id: string;
                acs_system_id: string;
                connected_account_id?: string;
                created_at: string;
                event_id: string;
                event_type: "acs_encoder.removed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                client_session_id: string;
                created_at: string;
                event_id: string;
                event_type: "client_session.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connect_webview_id: string;
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.connected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connect_webview_id: string;
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.created";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connect_webview_id: string;
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.successful_login";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.disconnected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.completed_first_sync";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connected_account.completed_first_sync_after_reconnection";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                action_attempt_id: string;
                action_type: string;
                created_at: string;
                event_id: string;
                event_type: "action_attempt.lock_door.succeeded";
                occurred_at: string;
                status: string;
                workspace_id: string;
            }
            | {
                action_attempt_id: string;
                action_type: string;
                created_at: string;
                event_id: string;
                event_type: "action_attempt.lock_door.failed";
                occurred_at: string;
                status: string;
                workspace_id: string;
            }
            | {
                action_attempt_id: string;
                action_type: string;
                created_at: string;
                event_id: string;
                event_type: "action_attempt.unlock_door.succeeded";
                occurred_at: string;
                status: string;
                workspace_id: string;
            }
            | {
                action_attempt_id: string;
                action_type: string;
                created_at: string;
                event_id: string;
                event_type: "action_attempt.unlock_door.failed";
                occurred_at: string;
                status: string;
                workspace_id: string;
            }
            | {
                connect_webview_id: string;
                connected_account_id: string;
                created_at: string;
                event_id: string;
                event_type: "connect_webview.login_succeeded";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connect_webview_id: string;
                created_at: string;
                event_id: string;
                event_type: "connect_webview.login_failed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.connected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.added";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.converted_to_unmanaged";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.unmanaged.converted_to_managed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.unmanaged.connected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                error_code: "account_disconnected" | "hub_disconnected" | "device_disconnected";
                event_id: string;
                event_type: "device.disconnected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                error_code: "account_disconnected" | "hub_disconnected" | "device_disconnected";
                event_id: string;
                event_type: "device.unmanaged.disconnected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.tampered";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                battery_level: number;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.low_battery";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                battery_level: number;
                battery_status:
                    | "low"
                    | "full"
                    | "critical"
                    | "good";
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.battery_status_changed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.removed";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.third_party_integration_detected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.third_party_integration_no_longer_detected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.salto.privacy_mode_activated";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.salto.privacy_mode_deactivated";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.connection_became_flaky";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.connection_stabilized";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.error.subscription_required";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.error.subscription_required.resolved";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.accessory_keypad_connected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "device.accessory_keypad_disconnected";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "noise_sensor.noise_threshold_triggered";
                minut_metadata?: Record<string, unknown>;
                noise_level_decibels?: number;
                noise_level_nrs?: number;
                noise_threshold_id?: string;
                noise_threshold_name?: string;
                noiseaware_metadata?: Record<string, unknown>;
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id?: string;
                action_attempt_id?: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "lock.locked";
                method:
                    | "manual"
                    | "unknown"
                    | "keycode"
                    | "automatic"
                    | "seamapi";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id?: string;
                action_attempt_id?: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "lock.unlocked";
                method:
                    | "manual"
                    | "unknown"
                    | "keycode"
                    | "automatic"
                    | "seamapi";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                access_code_id?: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "lock.access_denied";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                climate_preset_key: string;
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "thermostat.climate_preset_activated";
                is_fallback_climate_preset: boolean;
                occurred_at: string;
                thermostat_schedule_id: null | string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                cooling_set_point_celsius?: number;
                cooling_set_point_fahrenheit?: number;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "thermostat.manually_adjusted";
                fan_mode_setting?: "auto" | "on" | "circulate";
                heating_set_point_celsius?: number;
                heating_set_point_fahrenheit?: number;
                hvac_mode_setting?:
                    | "off"
                    | "heat"
                    | "cool"
                    | "heat_cool";
                method: "external" | "seam";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "thermostat.temperature_threshold_exceeded";
                lower_limit_celsius: null | number;
                lower_limit_fahrenheit: null | number;
                occurred_at: string;
                temperature_celsius: number;
                temperature_fahrenheit: number;
                upper_limit_celsius: null | number;
                upper_limit_fahrenheit: null | number;
                workspace_id: string;
            }
            | {
                connected_account_id: string;
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "thermostat.temperature_threshold_no_longer_exceeded";
                lower_limit_celsius: null | number;
                lower_limit_fahrenheit: null | number;
                occurred_at: string;
                temperature_celsius: number;
                temperature_fahrenheit: number;
                upper_limit_celsius: null | number;
                upper_limit_fahrenheit: null | number;
                workspace_id: string;
            }
            | {
                created_at: string;
                enrollment_automation_id: string;
                event_id: string;
                event_type: "enrollment_automation.deleted";
                occurred_at: string;
                workspace_id: string;
            }
            | {
                created_at: string;
                device_id: string;
                event_id: string;
                event_type: "phone.deactivated";
                occurred_at: string;
                workspace_id: string;
            })[];
    }>, "events">, "events">

  • Parameters

    • clientSessionToken: string

    Returns Promise<void>