Class SeamHttp

HTTP client for the Seam API.

Create a client with the constructor or one of the static factory methods, e.g., fromApiKey. Each Seam API route is available under its corresponding property, e.g., use seam.devices.list() to call the /devices/list endpoint.

Constructors

constructor

new SeamHttp(apiKeyOrOptions?: string | SeamHttpOptions): SeamHttp
Parameters
- apiKeyOrOptions: string | SeamHttpOptions = {}
Returns SeamHttp
- Defined in src/lib/routes/seam-http.ts:74

Properties

client

client: AxiosInstance

The client used to make HTTP requests to the Seam API.

`Readonly`defaults

defaults: Required<SeamHttpRequestOptions>

Default request options used for requests made by this client.

Accessors

accessCodes

get accessCodes(): SeamHttpAccessCodes
Client for the Seam API /access_codes routes.

Returns SeamHttpAccessCodes
- Defined in src/lib/routes/seam-http.ts:229

accessGrants

get accessGrants(): SeamHttpAccessGrants
Client for the Seam API /access_grants routes.

Returns SeamHttpAccessGrants
- Defined in src/lib/routes/seam-http.ts:236

accessMethods

get accessMethods(): SeamHttpAccessMethods
Client for the Seam API /access_methods routes.

Returns SeamHttpAccessMethods
- Defined in src/lib/routes/seam-http.ts:243

acs

get acs(): SeamHttpAcs
Client for the Seam API /acs routes.

Returns SeamHttpAcs
- Defined in src/lib/routes/seam-http.ts:250

actionAttempts

get actionAttempts(): SeamHttpActionAttempts
Client for the Seam API /action_attempts routes.

Returns SeamHttpActionAttempts
- Defined in src/lib/routes/seam-http.ts:257

clientSessions

get clientSessions(): SeamHttpClientSessions
Client for the Seam API /client_sessions routes.

Returns SeamHttpClientSessions
- Defined in src/lib/routes/seam-http.ts:264

connectedAccounts

get connectedAccounts(): SeamHttpConnectedAccounts
Client for the Seam API /connected_accounts routes.

Returns SeamHttpConnectedAccounts
- Defined in src/lib/routes/seam-http.ts:278

connectWebviews

get connectWebviews(): SeamHttpConnectWebviews
Client for the Seam API /connect_webviews routes.

Returns SeamHttpConnectWebviews
- Defined in src/lib/routes/seam-http.ts:271

customers

get customers(): SeamHttpCustomers
Client for the Seam API /customers routes.

Returns SeamHttpCustomers
- Defined in src/lib/routes/seam-http.ts:285

devices

get devices(): SeamHttpDevices
Client for the Seam API /devices routes.

Returns SeamHttpDevices
- Defined in src/lib/routes/seam-http.ts:292

events

get events(): SeamHttpEvents
Client for the Seam API /events routes.

Returns SeamHttpEvents
- Defined in src/lib/routes/seam-http.ts:299

instantKeys

get instantKeys(): SeamHttpInstantKeys
Client for the Seam API /instant_keys routes.

Returns SeamHttpInstantKeys
- Defined in src/lib/routes/seam-http.ts:306

locks

get locks(): SeamHttpLocks
Client for the Seam API /locks routes.

Returns SeamHttpLocks
- Defined in src/lib/routes/seam-http.ts:313

noiseSensors

get noiseSensors(): SeamHttpNoiseSensors
Client for the Seam API /noise_sensors routes.

Returns SeamHttpNoiseSensors
- Defined in src/lib/routes/seam-http.ts:320

phones

get phones(): SeamHttpPhones
Client for the Seam API /phones routes.

Returns SeamHttpPhones
- Defined in src/lib/routes/seam-http.ts:327

spaces

get spaces(): SeamHttpSpaces
Client for the Seam API /spaces routes.

Returns SeamHttpSpaces
- Defined in src/lib/routes/seam-http.ts:334

thermostats

get thermostats(): SeamHttpThermostats
Client for the Seam API /thermostats routes.

Returns SeamHttpThermostats
- Defined in src/lib/routes/seam-http.ts:341

userIdentities

get userIdentities(): SeamHttpUserIdentities
Client for the Seam API /user_identities routes.

Returns SeamHttpUserIdentities
- Defined in src/lib/routes/seam-http.ts:348

webhooks

get webhooks(): SeamHttpWebhooks
Client for the Seam API /webhooks routes.

Returns SeamHttpWebhooks
- Defined in src/lib/routes/seam-http.ts:355

workspaces

get workspaces(): SeamHttpWorkspaces
Client for the Seam API /workspaces routes.

Returns SeamHttpWorkspaces
- Defined in src/lib/routes/seam-http.ts:362

Methods

createPaginator

createPaginator<
    const TResponse,
    const TResponseKey extends string | number | symbol,
>(
    request: SeamHttpRequest<TResponse, TResponseKey>,
): SeamPaginator<TResponse, TResponseKey>
Creates a new SeamPaginator to iterate over the paginated results of the request.
Type Parameters
- const TResponse
- const TResponseKey extends string | number | symbol
Parameters
- request: SeamHttpRequest<TResponse, TResponseKey>
Returns SeamPaginator<TResponse, TResponseKey>
- Defined in src/lib/routes/seam-http.ts:196

updateClientSessionToken

updateClientSessionToken(clientSessionToken: string): Promise<void>
Updates the client session token used by this client for authentication.
Parameters
- clientSessionToken: string
Returns Promise<void>

Throws
If this client was not created with a client session token.
- Defined in src/lib/routes/seam-http.ts:207

`Static`fromApiKey

fromApiKey(
apiKey: string,
options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
): SeamHttp
Creates a new SeamHttp authenticated with an API key.
Parameters
- apiKey: string
- options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}
Returns SeamHttp
- Defined in src/lib/routes/seam-http.ts:97

`Static`fromClient

fromClient(
client: AxiosInstance,
options?: Omit<SeamHttpOptionsWithClient, "client">,
): SeamHttp
Creates a new SeamHttp from an existing HTTP client.
Parameters
- client: AxiosInstance
- options: Omit<SeamHttpOptionsWithClient, "client"> = {}
Returns SeamHttp
- Defined in src/lib/routes/seam-http.ts:83

`Static`fromClientSessionToken

fromClientSessionToken(
clientSessionToken: string,
options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
): SeamHttp
Creates a new SeamHttp authenticated with a client session token.
Parameters
- clientSessionToken: string
- options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}
Returns SeamHttp
- Defined in src/lib/routes/seam-http.ts:111

`Static`fromConsoleSessionToken

fromConsoleSessionToken(
    consoleSessionToken: string,
    workspaceId: string,
    options?: Omit<
        SeamHttpOptionsWithConsoleSessionToken,
        "consoleSessionToken"
        | "workspaceId",
    >,
): SeamHttp
Creates a new SeamHttp authenticated with a console session token and scoped to a workspace.
Parameters
- consoleSessionToken: string
- workspaceId: string
- options: Omit<
      SeamHttpOptionsWithConsoleSessionToken,
      "consoleSessionToken"
      | "workspaceId",
  > = {}
Returns SeamHttp
- Defined in src/lib/routes/seam-http.ts:154

`Static`fromPersonalAccessToken

fromPersonalAccessToken(
    personalAccessToken: string,
    workspaceId: string,
    options?: Omit<
        SeamHttpOptionsWithPersonalAccessToken,
        "personalAccessToken"
        | "workspaceId",
    >,
): SeamHttp
Creates a new SeamHttp authenticated with a personal access token and scoped to a workspace.
Parameters
- personalAccessToken: string
- workspaceId: string
- options: Omit<
      SeamHttpOptionsWithPersonalAccessToken,
      "personalAccessToken"
      | "workspaceId",
  > = {}
Returns SeamHttp
- Defined in src/lib/routes/seam-http.ts:175

`Static`fromPublishableKey

fromPublishableKey(
    publishableKey: string,
    userIdentifierKey: string,
    options?: SeamHttpFromPublishableKeyOptions,
): Promise<SeamHttp>
Creates a new SeamHttp authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.
Parameters
- publishableKey: string
- userIdentifierKey: string
- options: SeamHttpFromPublishableKeyOptions = {}
Returns Promise<SeamHttp>
- Defined in src/lib/routes/seam-http.ts:130

Class SeamHttp

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SeamHttp

Properties

client

Readonlydefaults

Accessors

accessCodes

Returns SeamHttpAccessCodes

accessGrants

Returns SeamHttpAccessGrants

accessMethods

Returns SeamHttpAccessMethods

acs

Returns SeamHttpAcs

actionAttempts

Returns SeamHttpActionAttempts

clientSessions

Returns SeamHttpClientSessions

connectedAccounts

Returns SeamHttpConnectedAccounts

connectWebviews

Returns SeamHttpConnectWebviews

customers

Returns SeamHttpCustomers

devices

Returns SeamHttpDevices

events

Returns SeamHttpEvents

instantKeys

Returns SeamHttpInstantKeys

locks

Returns SeamHttpLocks

noiseSensors

Returns SeamHttpNoiseSensors

phones

Returns SeamHttpPhones

spaces

Returns SeamHttpSpaces

thermostats

Returns SeamHttpThermostats

userIdentities

Returns SeamHttpUserIdentities

webhooks

Returns SeamHttpWebhooks

workspaces

Returns SeamHttpWorkspaces

Methods

createPaginator

Type Parameters

Parameters

Returns SeamPaginator<TResponse, TResponseKey>

updateClientSessionToken

Parameters

Returns Promise<void>

Throws

StaticfromApiKey

Parameters

Returns SeamHttp

StaticfromClient

Parameters

Returns SeamHttp

StaticfromClientSessionToken

Parameters

Returns SeamHttp

StaticfromConsoleSessionToken

Parameters

Returns SeamHttp

StaticfromPersonalAccessToken

Parameters

Returns SeamHttp

StaticfromPublishableKey

Parameters

`Readonly`defaults

`Static`fromApiKey

`Static`fromClient

`Static`fromClientSessionToken

`Static`fromConsoleSessionToken

`Static`fromPersonalAccessToken

`Static`fromPublishableKey