@seamapi/http 1.33.0 → 1.34.0

package/src/lib/seam/connect/routes/access-methods.ts

@@ -0,0 +1,219 @@
+/*
+ * Automatically generated by generate-routes.ts.
+ * Do not edit this file or add other files to this directory.
+ */
+
+import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect'
+
+import {
+  getAuthHeadersForClientSessionToken,
+  warnOnInsecureuserIdentifierKey,
+} from 'lib/seam/connect/auth.js'
+import { type Client, createClient } from 'lib/seam/connect/client.js'
+import {
+  isSeamHttpOptionsWithApiKey,
+  isSeamHttpOptionsWithClient,
+  isSeamHttpOptionsWithClientSessionToken,
+  isSeamHttpOptionsWithConsoleSessionToken,
+  isSeamHttpOptionsWithPersonalAccessToken,
+  type SeamHttpFromPublishableKeyOptions,
+  SeamHttpInvalidOptionsError,
+  type SeamHttpOptions,
+  type SeamHttpOptionsWithApiKey,
+  type SeamHttpOptionsWithClient,
+  type SeamHttpOptionsWithClientSessionToken,
+  type SeamHttpOptionsWithConsoleSessionToken,
+  type SeamHttpOptionsWithPersonalAccessToken,
+  type SeamHttpRequestOptions,
+} from 'lib/seam/connect/options.js'
+import {
+  limitToSeamHttpRequestOptions,
+  parseOptions,
+} from 'lib/seam/connect/parse-options.js'
+import { SeamHttpRequest } from 'lib/seam/connect/seam-http-request.js'
+import { SeamPaginator } from 'lib/seam/connect/seam-paginator.js'
+import type { SetNonNullable } from 'lib/types.js'
+
+import { SeamHttpClientSessions } from './client-sessions.js'
+
+export class SeamHttpAccessMethods {
+  client: Client
+  readonly defaults: Required<SeamHttpRequestOptions>
+
+  constructor(apiKeyOrOptions: string | SeamHttpOptions = {}) {
+    const options = parseOptions(apiKeyOrOptions)
+    this.client = 'client' in options ? options.client : createClient(options)
+    this.defaults = limitToSeamHttpRequestOptions(options)
+  }
+
+  static fromClient(
+    client: SeamHttpOptionsWithClient['client'],
+    options: Omit<SeamHttpOptionsWithClient, 'client'> = {},
+  ): SeamHttpAccessMethods {
+    const constructorOptions = { ...options, client }
+    if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing client')
+    }
+    return new SeamHttpAccessMethods(constructorOptions)
+  }
+
+  static fromApiKey(
+    apiKey: SeamHttpOptionsWithApiKey['apiKey'],
+    options: Omit<SeamHttpOptionsWithApiKey, 'apiKey'> = {},
+  ): SeamHttpAccessMethods {
+    const constructorOptions = { ...options, apiKey }
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing apiKey')
+    }
+    return new SeamHttpAccessMethods(constructorOptions)
+  }
+
+  static fromClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+    options: Omit<
+      SeamHttpOptionsWithClientSessionToken,
+      'clientSessionToken'
+    > = {},
+  ): SeamHttpAccessMethods {
+    const constructorOptions = { ...options, clientSessionToken }
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing clientSessionToken')
+    }
+    return new SeamHttpAccessMethods(constructorOptions)
+  }
+
+  static async fromPublishableKey(
+    publishableKey: string,
+    userIdentifierKey: string,
+    options: SeamHttpFromPublishableKeyOptions = {},
+  ): Promise<SeamHttpAccessMethods> {
+    warnOnInsecureuserIdentifierKey(userIdentifierKey)
+    const clientOptions = parseOptions({ ...options, publishableKey })
+    if (isSeamHttpOptionsWithClient(clientOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'The client option cannot be used with SeamHttp.fromPublishableKey',
+      )
+    }
+    const client = createClient(clientOptions)
+    const clientSessions = SeamHttpClientSessions.fromClient(client)
+    const { token } = await clientSessions.getOrCreate({
+      user_identifier_key: userIdentifierKey,
+    })
+    return SeamHttpAccessMethods.fromClientSessionToken(token, options)
+  }
+
+  static fromConsoleSessionToken(
+    consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'],
+    workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithConsoleSessionToken,
+      'consoleSessionToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpAccessMethods {
+    const constructorOptions = { ...options, consoleSessionToken, workspaceId }
+    if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing consoleSessionToken or workspaceId',
+      )
+    }
+    return new SeamHttpAccessMethods(constructorOptions)
+  }
+
+  static fromPersonalAccessToken(
+    personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'],
+    workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithPersonalAccessToken,
+      'personalAccessToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpAccessMethods {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId }
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing personalAccessToken or workspaceId',
+      )
+    }
+    return new SeamHttpAccessMethods(constructorOptions)
+  }
+
+  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
+    request: SeamHttpRequest<TResponse, TResponseKey>,
+  ): SeamPaginator<TResponse, TResponseKey> {
+    return new SeamPaginator<TResponse, TResponseKey>(this, request)
+  }
+
+  async updateClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+  ): Promise<void> {
+    const { headers } = this.client.defaults
+    const authHeaders = getAuthHeadersForClientSessionToken({
+      clientSessionToken,
+    })
+    for (const key of Object.keys(authHeaders)) {
+      if (headers[key] == null) {
+        throw new Error(
+          'Cannot update a clientSessionToken on a client created without a clientSessionToken',
+        )
+      }
+    }
+    this.client.defaults.headers = { ...headers, ...authHeaders }
+    const clientSessions = SeamHttpClientSessions.fromClient(this.client)
+    await clientSessions.get()
+  }
+
+  delete(body?: AccessMethodsDeleteParams): SeamHttpRequest<void, undefined> {
+    return new SeamHttpRequest(this, {
+      pathname: '/access_methods/delete',
+      method: 'post',
+      body,
+      responseKey: undefined,
+    })
+  }
+
+  get(
+    body?: AccessMethodsGetParams,
+  ): SeamHttpRequest<AccessMethodsGetResponse, 'access_method'> {
+    return new SeamHttpRequest(this, {
+      pathname: '/access_methods/get',
+      method: 'post',
+      body,
+      responseKey: 'access_method',
+    })
+  }
+
+  list(
+    body?: AccessMethodsListParams,
+  ): SeamHttpRequest<AccessMethodsListResponse, 'access_methods'> {
+    return new SeamHttpRequest(this, {
+      pathname: '/access_methods/list',
+      method: 'post',
+      body,
+      responseKey: 'access_methods',
+    })
+  }
+}
+
+export type AccessMethodsDeleteParams =
+  RouteRequestBody<'/access_methods/delete'>
+
+export type AccessMethodsDeleteResponse = SetNonNullable<
+  Required<RouteResponse<'/access_methods/delete'>>
+>
+
+export type AccessMethodsDeleteOptions = never
+
+export type AccessMethodsGetParams = RouteRequestBody<'/access_methods/get'>
+
+export type AccessMethodsGetResponse = SetNonNullable<
+  Required<RouteResponse<'/access_methods/get'>>
+>
+
+export type AccessMethodsGetOptions = never
+
+export type AccessMethodsListParams = RouteRequestBody<'/access_methods/list'>
+
+export type AccessMethodsListResponse = SetNonNullable<
+  Required<RouteResponse<'/access_methods/list'>>
+>
+
+export type AccessMethodsListOptions = never

package/src/lib/seam/connect/routes/index.ts

@@ -1,6 +1,8 @@
 export * from './access-codes.js'
 export * from './access-codes-simulate.js'
 export * from './access-codes-unmanaged.js'
+export * from './access-grants.js'
+export * from './access-methods.js'
 export * from './acs.js'
 export * from './acs-access-groups.js'
 export * from './acs-credentials.js'
@@ -23,6 +25,7 @@ export * from './noise-sensors-noise-thresholds.js'
 export * from './noise-sensors-simulate.js'
 export * from './phones.js'
 export * from './phones-simulate.js'
+export * from './spaces.js'
 export * from './thermostats.js'
 export * from './thermostats-daily-programs.js'
 export * from './thermostats-schedules.js'

package/src/lib/seam/connect/routes/spaces.ts

@@ -0,0 +1,329 @@
+/*
+ * Automatically generated by generate-routes.ts.
+ * Do not edit this file or add other files to this directory.
+ */
+
+import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect'
+
+import {
+  getAuthHeadersForClientSessionToken,
+  warnOnInsecureuserIdentifierKey,
+} from 'lib/seam/connect/auth.js'
+import { type Client, createClient } from 'lib/seam/connect/client.js'
+import {
+  isSeamHttpOptionsWithApiKey,
+  isSeamHttpOptionsWithClient,
+  isSeamHttpOptionsWithClientSessionToken,
+  isSeamHttpOptionsWithConsoleSessionToken,
+  isSeamHttpOptionsWithPersonalAccessToken,
+  type SeamHttpFromPublishableKeyOptions,
+  SeamHttpInvalidOptionsError,
+  type SeamHttpOptions,
+  type SeamHttpOptionsWithApiKey,
+  type SeamHttpOptionsWithClient,
+  type SeamHttpOptionsWithClientSessionToken,
+  type SeamHttpOptionsWithConsoleSessionToken,
+  type SeamHttpOptionsWithPersonalAccessToken,
+  type SeamHttpRequestOptions,
+} from 'lib/seam/connect/options.js'
+import {
+  limitToSeamHttpRequestOptions,
+  parseOptions,
+} from 'lib/seam/connect/parse-options.js'
+import { SeamHttpRequest } from 'lib/seam/connect/seam-http-request.js'
+import { SeamPaginator } from 'lib/seam/connect/seam-paginator.js'
+import type { SetNonNullable } from 'lib/types.js'
+
+import { SeamHttpClientSessions } from './client-sessions.js'
+
+export class SeamHttpSpaces {
+  client: Client
+  readonly defaults: Required<SeamHttpRequestOptions>
+
+  constructor(apiKeyOrOptions: string | SeamHttpOptions = {}) {
+    const options = parseOptions(apiKeyOrOptions)
+    this.client = 'client' in options ? options.client : createClient(options)
+    this.defaults = limitToSeamHttpRequestOptions(options)
+  }
+
+  static fromClient(
+    client: SeamHttpOptionsWithClient['client'],
+    options: Omit<SeamHttpOptionsWithClient, 'client'> = {},
+  ): SeamHttpSpaces {
+    const constructorOptions = { ...options, client }
+    if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing client')
+    }
+    return new SeamHttpSpaces(constructorOptions)
+  }
+
+  static fromApiKey(
+    apiKey: SeamHttpOptionsWithApiKey['apiKey'],
+    options: Omit<SeamHttpOptionsWithApiKey, 'apiKey'> = {},
+  ): SeamHttpSpaces {
+    const constructorOptions = { ...options, apiKey }
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing apiKey')
+    }
+    return new SeamHttpSpaces(constructorOptions)
+  }
+
+  static fromClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+    options: Omit<
+      SeamHttpOptionsWithClientSessionToken,
+      'clientSessionToken'
+    > = {},
+  ): SeamHttpSpaces {
+    const constructorOptions = { ...options, clientSessionToken }
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing clientSessionToken')
+    }
+    return new SeamHttpSpaces(constructorOptions)
+  }
+
+  static async fromPublishableKey(
+    publishableKey: string,
+    userIdentifierKey: string,
+    options: SeamHttpFromPublishableKeyOptions = {},
+  ): Promise<SeamHttpSpaces> {
+    warnOnInsecureuserIdentifierKey(userIdentifierKey)
+    const clientOptions = parseOptions({ ...options, publishableKey })
+    if (isSeamHttpOptionsWithClient(clientOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'The client option cannot be used with SeamHttp.fromPublishableKey',
+      )
+    }
+    const client = createClient(clientOptions)
+    const clientSessions = SeamHttpClientSessions.fromClient(client)
+    const { token } = await clientSessions.getOrCreate({
+      user_identifier_key: userIdentifierKey,
+    })
+    return SeamHttpSpaces.fromClientSessionToken(token, options)
+  }
+
+  static fromConsoleSessionToken(
+    consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'],
+    workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithConsoleSessionToken,
+      'consoleSessionToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpSpaces {
+    const constructorOptions = { ...options, consoleSessionToken, workspaceId }
+    if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing consoleSessionToken or workspaceId',
+      )
+    }
+    return new SeamHttpSpaces(constructorOptions)
+  }
+
+  static fromPersonalAccessToken(
+    personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'],
+    workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithPersonalAccessToken,
+      'personalAccessToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpSpaces {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId }
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing personalAccessToken or workspaceId',
+      )
+    }
+    return new SeamHttpSpaces(constructorOptions)
+  }
+
+  createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
+    request: SeamHttpRequest<TResponse, TResponseKey>,
+  ): SeamPaginator<TResponse, TResponseKey> {
+    return new SeamPaginator<TResponse, TResponseKey>(this, request)
+  }
+
+  async updateClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+  ): Promise<void> {
+    const { headers } = this.client.defaults
+    const authHeaders = getAuthHeadersForClientSessionToken({
+      clientSessionToken,
+    })
+    for (const key of Object.keys(authHeaders)) {
+      if (headers[key] == null) {
+        throw new Error(
+          'Cannot update a clientSessionToken on a client created without a clientSessionToken',
+        )
+      }
+    }
+    this.client.defaults.headers = { ...headers, ...authHeaders }
+    const clientSessions = SeamHttpClientSessions.fromClient(this.client)
+    await clientSessions.get()
+  }
+
+  addAcsEntrances(
+    body?: SpacesAddAcsEntrancesBody,
+  ): SeamHttpRequest<void, undefined> {
+    return new SeamHttpRequest(this, {
+      pathname: '/spaces/add_acs_entrances',
+      method: 'post',
+      body,
+      responseKey: undefined,
+    })
+  }
+
+  addDevices(body?: SpacesAddDevicesBody): SeamHttpRequest<void, undefined> {
+    return new SeamHttpRequest(this, {
+      pathname: '/spaces/add_devices',
+      method: 'post',
+      body,
+      responseKey: undefined,
+    })
+  }
+
+  create(
+    body?: SpacesCreateBody,
+  ): SeamHttpRequest<SpacesCreateResponse, 'space'> {
+    return new SeamHttpRequest(this, {
+      pathname: '/spaces/create',
+      method: 'post',
+      body,
+      responseKey: 'space',
+    })
+  }
+
+  delete(body?: SpacesDeleteParams): SeamHttpRequest<void, undefined> {
+    return new SeamHttpRequest(this, {
+      pathname: '/spaces/delete',
+      method: 'post',
+      body,
+      responseKey: undefined,
+    })
+  }
+
+  get(body?: SpacesGetParams): SeamHttpRequest<SpacesGetResponse, 'space'> {
+    return new SeamHttpRequest(this, {
+      pathname: '/spaces/get',
+      method: 'post',
+      body,
+      responseKey: 'space',
+    })
+  }
+
+  list(body?: SpacesListParams): SeamHttpRequest<SpacesListResponse, 'spaces'> {
+    return new SeamHttpRequest(this, {
+      pathname: '/spaces/list',
+      method: 'post',
+      body,
+      responseKey: 'spaces',
+    })
+  }
+
+  removeAcsEntrances(
+    body?: SpacesRemoveAcsEntrancesParams,
+  ): SeamHttpRequest<void, undefined> {
+    return new SeamHttpRequest(this, {
+      pathname: '/spaces/remove_acs_entrances',
+      method: 'post',
+      body,
+      responseKey: undefined,
+    })
+  }
+
+  removeDevices(
+    body?: SpacesRemoveDevicesParams,
+  ): SeamHttpRequest<void, undefined> {
+    return new SeamHttpRequest(this, {
+      pathname: '/spaces/remove_devices',
+      method: 'post',
+      body,
+      responseKey: undefined,
+    })
+  }
+
+  update(
+    body?: SpacesUpdateBody,
+  ): SeamHttpRequest<SpacesUpdateResponse, 'space'> {
+    return new SeamHttpRequest(this, {
+      pathname: '/spaces/update',
+      method: 'post',
+      body,
+      responseKey: 'space',
+    })
+  }
+}
+
+export type SpacesAddAcsEntrancesBody =
+  RouteRequestBody<'/spaces/add_acs_entrances'>
+
+export type SpacesAddAcsEntrancesResponse = SetNonNullable<
+  Required<RouteResponse<'/spaces/add_acs_entrances'>>
+>
+
+export type SpacesAddAcsEntrancesOptions = never
+
+export type SpacesAddDevicesBody = RouteRequestBody<'/spaces/add_devices'>
+
+export type SpacesAddDevicesResponse = SetNonNullable<
+  Required<RouteResponse<'/spaces/add_devices'>>
+>
+
+export type SpacesAddDevicesOptions = never
+
+export type SpacesCreateBody = RouteRequestBody<'/spaces/create'>
+
+export type SpacesCreateResponse = SetNonNullable<
+  Required<RouteResponse<'/spaces/create'>>
+>
+
+export type SpacesCreateOptions = never
+
+export type SpacesDeleteParams = RouteRequestBody<'/spaces/delete'>
+
+export type SpacesDeleteResponse = SetNonNullable<
+  Required<RouteResponse<'/spaces/delete'>>
+>
+
+export type SpacesDeleteOptions = never
+
+export type SpacesGetParams = RouteRequestBody<'/spaces/get'>
+
+export type SpacesGetResponse = SetNonNullable<
+  Required<RouteResponse<'/spaces/get'>>
+>
+
+export type SpacesGetOptions = never
+
+export type SpacesListParams = RouteRequestBody<'/spaces/list'>
+
+export type SpacesListResponse = SetNonNullable<
+  Required<RouteResponse<'/spaces/list'>>
+>
+
+export type SpacesListOptions = never
+
+export type SpacesRemoveAcsEntrancesParams =
+  RouteRequestBody<'/spaces/remove_acs_entrances'>
+
+export type SpacesRemoveAcsEntrancesResponse = SetNonNullable<
+  Required<RouteResponse<'/spaces/remove_acs_entrances'>>
+>
+
+export type SpacesRemoveAcsEntrancesOptions = never
+
+export type SpacesRemoveDevicesParams =
+  RouteRequestBody<'/spaces/remove_devices'>
+
+export type SpacesRemoveDevicesResponse = SetNonNullable<
+  Required<RouteResponse<'/spaces/remove_devices'>>
+>
+
+export type SpacesRemoveDevicesOptions = never
+
+export type SpacesUpdateBody = RouteRequestBody<'/spaces/update'>
+
+export type SpacesUpdateResponse = SetNonNullable<
+  Required<RouteResponse<'/spaces/update'>>
+>
+
+export type SpacesUpdateOptions = never

package/src/lib/seam/connect/seam-http.ts

@@ -24,6 +24,8 @@ import {
 import { limitToSeamHttpRequestOptions, parseOptions } from './parse-options.js'
 import {
   SeamHttpAccessCodes,
+  SeamHttpAccessGrants,
+  SeamHttpAccessMethods,
   SeamHttpAcs,
   SeamHttpActionAttempts,
   SeamHttpClientSessions,
@@ -34,6 +36,7 @@ import {
   SeamHttpLocks,
   SeamHttpNoiseSensors,
   SeamHttpPhones,
+  SeamHttpSpaces,
   SeamHttpThermostats,
   SeamHttpUserIdentities,
   SeamHttpWebhooks,
@@ -173,6 +176,14 @@ export class SeamHttp {
     return SeamHttpAccessCodes.fromClient(this.client, this.defaults)
   }
 
+  get accessGrants(): SeamHttpAccessGrants {
+    return SeamHttpAccessGrants.fromClient(this.client, this.defaults)
+  }
+
+  get accessMethods(): SeamHttpAccessMethods {
+    return SeamHttpAccessMethods.fromClient(this.client, this.defaults)
+  }
+
   get acs(): SeamHttpAcs {
     return SeamHttpAcs.fromClient(this.client, this.defaults)
   }
@@ -213,6 +224,10 @@ export class SeamHttp {
     return SeamHttpPhones.fromClient(this.client, this.defaults)
   }
 
+  get spaces(): SeamHttpSpaces {
+    return SeamHttpSpaces.fromClient(this.client, this.defaults)
+  }
+
   get thermostats(): SeamHttpThermostats {
     return SeamHttpThermostats.fromClient(this.client, this.defaults)
   }

package/src/lib/version.ts

@@ -1,3 +1,3 @@
-const seamapiJavascriptHttpVersion = '1.33.0'
+const seamapiJavascriptHttpVersion = '1.34.0'
 
 export default seamapiJavascriptHttpVersion