Class SeamHttpEvents

constructor

• new SeamHttpEvents(apiKeyOrOptions?): SeamHttpEvents

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpEvents

client

Readonly defaults

get

• get(body?): Promise<{
      created_at: string;
      device_id?: string;
      event_id: string;
      event_type: string;
      occurred_at: string;
      workspace_id: string;
  }>

• Parameters

  • Optional body: {
        device_id?: string;
        event_id?: string;
        event_type?: string;
    }

    • Optional device_id?: string

    • Optional event_id?: string

    • Optional event_type?: string

  Returns Promise<{
      created_at: string;
      device_id?: string;
      event_id: string;
      event_type: string;
      occurred_at: string;
      workspace_id: string;
  }>

list

• list(body?): Promise<{
      created_at: string;
      device_id?: string;
      event_id: string;
      event_type: string;
      occurred_at: string;
      workspace_id: string;
  }[]>

• Parameters

  • Optional body: {
        access_code_id?: string;
        access_code_ids?: string[];
        between?: (string | Date)[];
        connected_account_id?: string;
        device_id?: string;
        device_ids?: string[];
        event_type?: "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled";
        event_types?: ("device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled")[];
        since?: string;
    }

    • Optional access_code_id?: string

    • Optional access_code_ids?: string[]

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

    • Optional connected_account_id?: string

    • Optional device_id?: string

    • Optional device_ids?: string[]

    • Optional event_type?: "device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled"

    • Optional event_types?: ("device.connected" | "device.unmanaged.connected" | "device.disconnected" | "device.unmanaged.disconnected" | "device.converted_to_unmanaged" | "device.unmanaged.converted_to_managed" | "device.removed" | "device.tampered" | "device.low_battery" | "device.battery_status_changed" | "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" | "access_code.created" | "access_code.changed" | "access_code.scheduled_on_device" | "access_code.set_on_device" | "access_code.deleted" | "access_code.removed_from_device" | "access_code.failed_to_set_on_device" | "access_code.delay_in_setting_on_device" | "access_code.failed_to_remove_from_device" | "access_code.delay_in_removing_from_device" | "access_code.deleted_external_to_seam" | "access_code.modified_external_to_seam" | "access_code.unmanaged.converted_to_managed" | "access_code.unmanaged.failed_to_convert_to_managed" | "access_code.unmanaged.created" | "access_code.unmanaged.removed" | "lock.locked" | "lock.unlocked" | "connected_account.connected" | "connected_account.successful_login" | "connected_account.created" | "connected_account.deleted" | "connected_account.disconnected" | "connected_account.completed_first_sync" | "noise_sensor.noise_threshold_triggered" | "access_code.backup_access_code_pulled")[]

    • Optional since?: string

  Returns Promise<{
      created_at: string;
      device_id?: string;
      event_id: string;
      event_type: string;
      occurred_at: string;
      workspace_id: string;
  }[]>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttpEvents

• Parameters

  • apiKey: string

  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpEvents

Static fromClient

• fromClient(client, options?): SeamHttpEvents

• Parameters

  • client: AxiosInstance

  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpEvents

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpEvents

• Parameters

  • clientSessionToken: string

  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpEvents

Static fromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpEvents

• Parameters

  • consoleSessionToken: string

  • workspaceId: string

  • options: Omit<SeamHttpOptionsWithConsoleSessionToken, "consoleSessionToken" | "workspaceId"> = {}

  Returns SeamHttpEvents

Static fromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpEvents

• Parameters

  • personalAccessToken: string

  • workspaceId: string

  • options: Omit<SeamHttpOptionsWithPersonalAccessToken, "workspaceId" | "personalAccessToken"> = {}

  Returns SeamHttpEvents

Static fromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpEvents>

• Parameters

  • publishableKey: string

  • userIdentifierKey: string

  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpEvents>