Class SeamHttpEvents

Index

Constructors

Properties

Methods

createPaginator get list updateClientSessionToken fromApiKey fromClient fromClientSessionToken fromConsoleSessionToken fromPersonalAccessToken fromPublishableKey

Constructors

constructor

new SeamHttpEvents(apiKeyOrOptions?): SeamHttpEvents
Parameters
- apiKeyOrOptions: string | SeamHttpOptions = {}
Returns SeamHttpEvents
- Defined in src/lib/seam/connect/routes/events/events.ts:45

Properties

client

client: AxiosInstance

`Readonly`defaults

defaults: Required<SeamHttpRequestOptions>

`Readonly`ltsVersion

ltsVersion: "1.0.0" = seamApiLtsVersion

`Static`ltsVersion

ltsVersion: string = seamApiLtsVersion

Methods

createPaginator

createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>
Type Parameters
- const TResponse
- const TResponseKey extends string | number | symbol
Parameters
- request: SeamHttpRequest<TResponse, TResponseKey>
Returns SeamPaginator<TResponse, TResponseKey>
- Defined in src/lib/seam/connect/routes/events/events.ts:141

get

get(parameters?, options?): EventsGetRequest
Parameters
- Optionalparameters: {
      device_id?: string;
      event_id?: string;
      event_type?: string;
  }
  - Optionaldevice_id?: string
    Unique identifier for the device that triggered the event that you want to get.
  - Optionalevent_id?: string
    Unique identifier for the event that you want to get.
  - Optionalevent_type?: string
    Type of the event that you want to get.
- options: EventsGetOptions = {}
Returns EventsGetRequest
- Defined in src/lib/seam/connect/routes/events/events.ts:166

list

list(parameters?, options?): EventsListRequest
Parameters
- Optionalparameters: {
      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;
      customer_key?: string;
      device_id?: string;
      device_ids?: string[];
      event_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"
          | "access_grant.created"
          | "access_grant.deleted"
          | "access_grant.access_granted_to_all_doors"
          | "access_grant.access_granted_to_door"
          | "access_grant.access_to_door_lost"
          | "access_method.issued"
          | "access_method.revoked"
          | "access_method.card_encoding_required"
          | "access_method.deleted"
          | "access_method.reissued"
          | "acs_system.connected"
          | "acs_system.added"
          | "acs_system.disconnected"
          | "acs_credential.deleted"
          | "acs_credential.issued"
          | "acs_credential.reissued"
          | "acs_credential.invalidated"
          | "acs_user.created"
          | "acs_user.deleted"
          | "acs_encoder.added"
          | "acs_encoder.removed"
          | "acs_access_group.deleted"
          | "acs_entrance.added"
          | "acs_entrance.removed"
          | "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"
          | "action_attempt.lock_door.succeeded"
          | "action_attempt.lock_door.failed"
          | "action_attempt.unlock_door.succeeded"
          | "action_attempt.unlock_door.failed"
          | "connect_webview.login_succeeded"
          | "connect_webview.login_failed"
          | "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"
          | "thermostat.temperature_reached_set_point"
          | "thermostat.temperature_changed"
          | "device.name_changed"
          | "enrollment_automation.deleted"
          | "phone.deactivated";
      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"
          | "access_grant.created"
          | "access_grant.deleted"
          | "access_grant.access_granted_to_all_doors"
          | "access_grant.access_granted_to_door"
          | "access_grant.access_to_door_lost"
          | "access_method.issued"
          | "access_method.revoked"
          | "access_method.card_encoding_required"
          | "access_method.deleted"
          | "access_method.reissued"
          | "acs_system.connected"
          | "acs_system.added"
          | "acs_system.disconnected"
          | "acs_credential.deleted"
          | "acs_credential.issued"
          | "acs_credential.reissued"
          | "acs_credential.invalidated"
          | "acs_user.created"
          | "acs_user.deleted"
          | "acs_encoder.added"
          | "acs_encoder.removed"
          | "acs_access_group.deleted"
          | "acs_entrance.added"
          | "acs_entrance.removed"
          | "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"
          | "action_attempt.lock_door.succeeded"
          | "action_attempt.lock_door.failed"
          | "action_attempt.unlock_door.succeeded"
          | "action_attempt.unlock_door.failed"
          | "connect_webview.login_succeeded"
          | "connect_webview.login_failed"
          | "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"
          | "thermostat.temperature_reached_set_point"
          | "thermostat.temperature_changed"
          | "device.name_changed"
          | "enrollment_automation.deleted"
          | "phone.deactivated")[];
      limit?: number;
      since?: string;
      unstable_offset?: number;
  }
  - Optionalaccess_code_id?: string
    ID of the access code for which you want to list events.
  - Optionalaccess_code_ids?: string[]
    IDs of the access codes for which you want to list events.
  - Optionalacs_system_id?: string
    ID of the access system for which you want to list events.
  - Optionalacs_system_ids?: string[]
    IDs of the access systems for which you want to list events.
  - Optionalbetween?: (string | Date)[]
    Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include since or between.
  - Optionalconnect_webview_id?: string
    ID of the Connect Webview for which you want to list events.
  - Optionalconnected_account_id?: string
    ID of the connected account for which you want to list events.
  - Optionalcustomer_key?: string
    Customer key for which you want to list events.
  - Optionaldevice_id?: string
    ID of the device for which you want to list events.
  - Optionaldevice_ids?: string[]
    IDs of the devices for which you want to list events.
  - Optionalevent_ids?: string[]
    IDs of the events that you want to list.
  - 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"
        | "access_grant.created"
        | "access_grant.deleted"
        | "access_grant.access_granted_to_all_doors"
        | "access_grant.access_granted_to_door"
        | "access_grant.access_to_door_lost"
        | "access_method.issued"
        | "access_method.revoked"
        | "access_method.card_encoding_required"
        | "access_method.deleted"
        | "access_method.reissued"
        | "acs_system.connected"
        | "acs_system.added"
        | "acs_system.disconnected"
        | "acs_credential.deleted"
        | "acs_credential.issued"
        | "acs_credential.reissued"
        | "acs_credential.invalidated"
        | "acs_user.created"
        | "acs_user.deleted"
        | "acs_encoder.added"
        | "acs_encoder.removed"
        | "acs_access_group.deleted"
        | "acs_entrance.added"
        | "acs_entrance.removed"
        | "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"
        | "action_attempt.lock_door.succeeded"
        | "action_attempt.lock_door.failed"
        | "action_attempt.unlock_door.succeeded"
        | "action_attempt.unlock_door.failed"
        | "connect_webview.login_succeeded"
        | "connect_webview.login_failed"
        | "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"
        | "thermostat.temperature_reached_set_point"
        | "thermostat.temperature_changed"
        | "device.name_changed"
        | "enrollment_automation.deleted"
        | "phone.deactivated"
    Type of the events that you want to list.
  - 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"
        | "access_grant.created"
        | "access_grant.deleted"
        | "access_grant.access_granted_to_all_doors"
        | "access_grant.access_granted_to_door"
        | "access_grant.access_to_door_lost"
        | "access_method.issued"
        | "access_method.revoked"
        | "access_method.card_encoding_required"
        | "access_method.deleted"
        | "access_method.reissued"
        | "acs_system.connected"
        | "acs_system.added"
        | "acs_system.disconnected"
        | "acs_credential.deleted"
        | "acs_credential.issued"
        | "acs_credential.reissued"
        | "acs_credential.invalidated"
        | "acs_user.created"
        | "acs_user.deleted"
        | "acs_encoder.added"
        | "acs_encoder.removed"
        | "acs_access_group.deleted"
        | "acs_entrance.added"
        | "acs_entrance.removed"
        | "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"
        | "action_attempt.lock_door.succeeded"
        | "action_attempt.lock_door.failed"
        | "action_attempt.unlock_door.succeeded"
        | "action_attempt.unlock_door.failed"
        | "connect_webview.login_succeeded"
        | "connect_webview.login_failed"
        | "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"
        | "thermostat.temperature_reached_set_point"
        | "thermostat.temperature_changed"
        | "device.name_changed"
        | "enrollment_automation.deleted"
        | "phone.deactivated")[]
    Types of the events that you want to list.
  - Optionallimit?: number
    Numerical limit on the number of events to return.
  - Optionalsince?: string
    Timestamp to indicate the beginning generation time for the events that you want to list. You must include since or between.
  - Optionalunstable_offset?: number
    Offset for the events that you want to list.
- options: EventsListOptions = {}
Returns EventsListRequest
- Defined in src/lib/seam/connect/routes/events/events.ts:179

updateClientSessionToken

updateClientSessionToken(clientSessionToken): Promise<void>
Parameters
- clientSessionToken: string
Returns Promise<void>
- Defined in src/lib/seam/connect/routes/events/events.ts:147

`Static`fromApiKey

fromApiKey(apiKey, options?): SeamHttpEvents
Parameters
- apiKey: string
- options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}
Returns SeamHttpEvents
- Defined in src/lib/seam/connect/routes/events/events.ts:62

`Static`fromClient

fromClient(client, options?): SeamHttpEvents
Parameters
- client: AxiosInstance
- options: Omit<SeamHttpOptionsWithClient, "client"> = {}
Returns SeamHttpEvents
- Defined in src/lib/seam/connect/routes/events/events.ts:51

`Static`fromClientSessionToken

fromClientSessionToken(clientSessionToken, options?): SeamHttpEvents
Parameters
- clientSessionToken: string
- options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}
Returns SeamHttpEvents
- Defined in src/lib/seam/connect/routes/events/events.ts:73

`Static`fromConsoleSessionToken

fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpEvents
Parameters
- consoleSessionToken: string
- workspaceId: string
- options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}
Returns SeamHttpEvents
- Defined in src/lib/seam/connect/routes/events/events.ts:107

`Static`fromPersonalAccessToken

fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpEvents
Parameters
- personalAccessToken: string
- workspaceId: string
- options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}
Returns SeamHttpEvents
- Defined in src/lib/seam/connect/routes/events/events.ts:124

`Static`fromPublishableKey

fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpEvents>
Parameters
- publishableKey: string
- userIdentifierKey: string
- options: SeamHttpFromPublishableKeyOptions = {}
Returns Promise<SeamHttpEvents>
- Defined in src/lib/seam/connect/routes/events/events.ts:87

Class SeamHttpEvents

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SeamHttpEvents

Properties

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

Methods

createPaginator

Type Parameters

Parameters

Returns SeamPaginator<TResponse, TResponseKey>

get

Parameters

Optionaldevice_id?: string

Optionalevent_id?: string

Optionalevent_type?: string

Returns EventsGetRequest

list

Parameters

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

Optionalcustomer_key?: string

Optionaldevice_id?: string

Optionaldevice_ids?: string[]

Optionalevent_ids?: string[]

Optionallimit?: number

Optionalsince?: string

Optionalunstable_offset?: number

Returns EventsListRequest

updateClientSessionToken

Parameters

Returns Promise<void>

StaticfromApiKey

Parameters

Returns SeamHttpEvents

StaticfromClient

Parameters

Returns SeamHttpEvents

StaticfromClientSessionToken

Parameters

Returns SeamHttpEvents

StaticfromConsoleSessionToken

Parameters

Returns SeamHttpEvents

StaticfromPersonalAccessToken

Parameters

Returns SeamHttpEvents

StaticfromPublishableKey

Parameters

Returns Promise<SeamHttpEvents>

Settings

On This Page

`Readonly`defaults

`Readonly`ltsVersion

`Static`ltsVersion

`Optional`device_id?: string

`Optional`event_id?: string

`Optional`event_type?: string

`Optional`access_code_id?: string

`Optional`access_code_ids?: string[]

`Optional`acs_system_id?: string

`Optional`acs_system_ids?: string[]

`Optional`between?: (string | Date)[]

`Optional`connect_webview_id?: string

`Optional`connected_account_id?: string

`Optional`customer_key?: string

`Optional`device_id?: string

`Optional`device_ids?: string[]

`Optional`event_ids?: string[]

`Optional`limit?: number

`Optional`since?: string

`Optional`unstable_offset?: number

`Static`fromApiKey

`Static`fromClient

`Static`fromClientSessionToken

`Static`fromConsoleSessionToken

`Static`fromPersonalAccessToken

`Static`fromPublishableKey