Class SenseApiClient

constructor

• new SenseApiClient(
      session?: Session,
      options?: SenseApiClientOptions,
  ): SenseApiClient

  Creates a new SenseApiClient instance.

  Parameters

  • Optionalsession: Session

    Optional initial Session value.
  • Optionaloptions: SenseApiClientOptions

    Optional configuration SenseApiClientOptions.

  Returns SenseApiClient

Readonlyemitter

isAuthenticated

• get isAuthenticated(): boolean

  Returns whether the client currently has an active session.

  Returns boolean

  True if the client has an active session, false otherwise.

session

• get session(): undefined | Session

  Gets the current session.

  Returns undefined | Session

  The current session object, if any.
• set session(session: undefined | Session): void

  Sets the current session and emits a sessionChanged event if changed.

  Parameters

  • session: undefined | Session

    The new session value.

  Returns void

completeMfaLogin

• completeMfaLogin(
      mfaToken: string,
      oneTimePassword: string,
      clientDate: Date,
  ): Promise<void>

  Completes a multi-factor authentication (MFA) login flow with the Sense API.

  Parameters

  • mfaToken: string

    The MFA token received from the initial login attempt.
  • oneTimePassword: string

    The one-time password (OTP) code for MFA verification.
  • clientDate: Date

    The current date/time on the client device for time synchronization.

  Returns Promise<void>

  Throws

  SenseApiError If the MFA authentication fails.

getMonitorDevices

• getMonitorDevices(monitorId: number): Promise<Device[]>

  Retrieves all devices detected by a specific Sense monitor.

  Parameters

  • monitorId: number

    The ID of the Sense monitor to get devices for.

  Returns Promise<Device[]>

  A promise that resolves to an array of Device objects representing the detected devices.

  Throws

  SenseApiError If the API request fails.

  Throws

  UnauthenticatedError If there is no valid session.

getMonitorOverview

• getMonitorOverview(monitorId: number): Promise<MonitorOverview>

  Retrieves an overview of a specific Sense monitor.

  Parameters

  • monitorId: number

    The ID of the Sense monitor to get an overview for.

  Returns Promise<MonitorOverview>

  A promise that resolves to a MonitorOverview object containing the monitor's overview data.

  Throws

  SenseApiError If the API request fails.

  Throws

  UnauthenticatedError If there is no valid session.

getMonitorStatus

• getMonitorStatus(monitorId: number): Promise<MonitorStatus>

  Retrieves the status of a specific Sense monitor.

  Parameters

  • monitorId: number

    The ID of the Sense monitor to get the status for.

  Returns Promise<MonitorStatus>

  A promise that resolves to a MonitorStatus object containing the monitor's status data.

  Throws

  SenseApiError If the API request fails.

  Throws

  UnauthenticatedError If there is no valid session.

getMonitorTrends

• getMonitorTrends(
      monitorId: number,
      timezone: string,
      scale: TrendScale,
      startDate?: Date,
  ): Promise<Trends>

  Retrieves historical trend data for a Sense monitor.

  Parameters

  • monitorId: number

    The ID of the Sense monitor to get trends for.
  • timezone: string

    The timezone to use for date calculations, in IANA format (e.g. 'America/New_York'). This should correspond to the timezone of the monitor, as found in the Monitor object returned by getMonitorOverview.
  • scale: TrendScale

    The time scale for which to retrieve trends (e.g. DAY, WEEK, MONTH, YEAR, CYCLE).
  • OptionalstartDate: Date

    Optional start date to retrieve trends from. If not provided, trends will start from the current date.

  Returns Promise<Trends>

  A promise that resolves to a Trends object containing the trend data.

  Throws

  SenseApiError If the API request fails.

  Throws

  UnauthenticatedError If there is no valid session.

login

• login(emailAddress: string, password: string): Promise<undefined | string>

  Authenticates a user with the Sense API using email and password credentials.

  Parameters

  • emailAddress: string

    The email address of the user attempting to authenticate.
  • password: string

    The password of the user attempting to authenticate.

  Returns Promise<undefined | string>

  A promise that resolves to an MFA token if multi-factor authentication is required, or undefined if authentication is successful without MFA.

  Remarks

  This method will:

  • Clear any existing session
  • Attempt to authenticate with the provided credentials
  • Handle MFA requirements if needed
  • Create a new session if authentication is successful

  If this method returns a value, it indicates that multi-factor authentication is required. In this case, the returned MFA token should be used to complete the authentication process using the completeMfaLogin method.

  Throws

  SenseApiError If authentication fails for reasons other than MFA being required.

startRealtimeUpdates

• startRealtimeUpdates(monitorId: number): Promise<void>

  Starts real-time updates for a monitor.

  Parameters

  • monitorId: number

    The ID of the monitor to start real-time updates for.

  Returns Promise<void>

  Throws

  UnauthenticatedError If there is no valid session.

stopRealtimeUpdates

• stopRealtimeUpdates(): Promise<void>

  Stops real-time updates.

  Returns Promise<void>