Class SeamHttp

constructor

• new SeamHttp(apiKeyOrOptions?): SeamHttp

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttp

client

Readonly defaults

accessCodes

• get accessCodes(): SeamHttpAccessCodes

• Returns SeamHttpAccessCodes

acs

• get acs(): SeamHttpAcs

• Returns SeamHttpAcs

actionAttempts

• get actionAttempts(): SeamHttpActionAttempts

• Returns SeamHttpActionAttempts

clientSessions

• get clientSessions(): SeamHttpClientSessions

• Returns SeamHttpClientSessions

connectWebviews

• get connectWebviews(): SeamHttpConnectWebviews

• Returns SeamHttpConnectWebviews

connectedAccounts

• get connectedAccounts(): SeamHttpConnectedAccounts

• Returns SeamHttpConnectedAccounts

devices

• get devices(): SeamHttpDevices

• Returns SeamHttpDevices

events

• get events(): SeamHttpEvents

• Returns SeamHttpEvents

locks

• get locks(): SeamHttpLocks

• Returns SeamHttpLocks

networks

• get networks(): SeamHttpNetworks

• Returns SeamHttpNetworks

noiseSensors

• get noiseSensors(): SeamHttpNoiseSensors

• Returns SeamHttpNoiseSensors

phones

• get phones(): SeamHttpPhones

• Returns SeamHttpPhones

thermostats

• get thermostats(): SeamHttpThermostats

• Returns SeamHttpThermostats

userIdentities

• get userIdentities(): SeamHttpUserIdentities

• Returns SeamHttpUserIdentities

webhooks

• get webhooks(): SeamHttpWebhooks

• Returns SeamHttpWebhooks

workspaces

• get workspaces(): Omit<SeamHttpWorkspaces, "create">

• Returns Omit<SeamHttpWorkspaces, "create">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

Static fromApiKey

• fromApiKey(apiKey, options?): SeamHttp

• Parameters

  • apiKey: string

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

  Returns SeamHttp

Static fromClient

• fromClient(client, options?): SeamHttp

• Parameters

  • client: AxiosInstance

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

  Returns SeamHttp

Static fromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttp

• Parameters

  • clientSessionToken: string

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

  Returns SeamHttp

Static fromConsoleSessionToken

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

• Parameters

  • consoleSessionToken: string

  • workspaceId: string

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

  Returns SeamHttp

Static fromPersonalAccessToken

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

• Parameters

  • personalAccessToken: string

  • workspaceId: string

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

  Returns SeamHttp

Static fromPublishableKey

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

• Parameters

  • publishableKey: string

  • userIdentifierKey: string

  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttp>