@seamapi/http 0.22.0 → 0.24.0

package/src/lib/seam/connect/routes/devices-simulate.ts

@@ -0,0 +1,172 @@
+/*
+ * 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 type { SetNonNullable } from 'type-fest'
+
+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 { SeamHttpClientSessions } from './client-sessions.js'
+
+export class SeamHttpDevicesSimulate {
+  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'> = {},
+  ): SeamHttpDevicesSimulate {
+    const constructorOptions = { ...options, client }
+    if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing client')
+    }
+    return new SeamHttpDevicesSimulate(constructorOptions)
+  }
+
+  static fromApiKey(
+    apiKey: SeamHttpOptionsWithApiKey['apiKey'],
+    options: Omit<SeamHttpOptionsWithApiKey, 'apiKey'> = {},
+  ): SeamHttpDevicesSimulate {
+    const constructorOptions = { ...options, apiKey }
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing apiKey')
+    }
+    return new SeamHttpDevicesSimulate(constructorOptions)
+  }
+
+  static fromClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+    options: Omit<
+      SeamHttpOptionsWithClientSessionToken,
+      'clientSessionToken'
+    > = {},
+  ): SeamHttpDevicesSimulate {
+    const constructorOptions = { ...options, clientSessionToken }
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing clientSessionToken')
+    }
+    return new SeamHttpDevicesSimulate(constructorOptions)
+  }
+
+  static async fromPublishableKey(
+    publishableKey: string,
+    userIdentifierKey: string,
+    options: SeamHttpFromPublishableKeyOptions = {},
+  ): Promise<SeamHttpDevicesSimulate> {
+    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 SeamHttpDevicesSimulate.fromClientSessionToken(token, options)
+  }
+
+  static fromConsoleSessionToken(
+    consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'],
+    workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithConsoleSessionToken,
+      'consoleSessionToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpDevicesSimulate {
+    const constructorOptions = { ...options, consoleSessionToken, workspaceId }
+    if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing consoleSessionToken or workspaceId',
+      )
+    }
+    return new SeamHttpDevicesSimulate(constructorOptions)
+  }
+
+  static fromPersonalAccessToken(
+    personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'],
+    workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithPersonalAccessToken,
+      'personalAccessToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpDevicesSimulate {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId }
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing personalAccessToken or workspaceId',
+      )
+    }
+    return new SeamHttpDevicesSimulate(constructorOptions)
+  }
+
+  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()
+  }
+
+  async remove(body?: DevicesSimulateRemoveBody): Promise<void> {
+    await this.client.request<DevicesSimulateRemoveResponse>({
+      url: '/devices/simulate/remove',
+      method: 'post',
+      data: body,
+    })
+  }
+}
+
+export type DevicesSimulateRemoveBody =
+  RouteRequestBody<'/devices/simulate/remove'>
+
+export type DevicesSimulateRemoveResponse = SetNonNullable<
+  Required<RouteResponse<'/devices/simulate/remove'>>
+>
+
+export type DevicesSimulateRemoveOptions = never

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

@@ -33,6 +33,7 @@ import {
 } from 'lib/seam/connect/parse-options.js'
 
 import { SeamHttpClientSessions } from './client-sessions.js'
+import { SeamHttpDevicesSimulate } from './devices-simulate.js'
 import { SeamHttpDevicesUnmanaged } from './devices-unmanaged.js'
 
 export class SeamHttpDevices {
@@ -158,6 +159,10 @@ export class SeamHttpDevices {
     return SeamHttpDevicesUnmanaged.fromClient(this.client, this.defaults)
   }
 
+  get simulate(): SeamHttpDevicesSimulate {
+    return SeamHttpDevicesSimulate.fromClient(this.client, this.defaults)
+  }
+
   async delete(body?: DevicesDeleteBody): Promise<void> {
     await this.client.request<DevicesDeleteResponse>({
       url: '/devices/delete',

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

@@ -13,6 +13,7 @@ export * from './client-sessions.js'
 export * from './connect-webviews.js'
 export * from './connected-accounts.js'
 export * from './devices.js'
+export * from './devices-simulate.js'
 export * from './devices-unmanaged.js'
 export * from './events.js'
 export * from './locks.js'

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

@@ -31,7 +31,9 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/seam/connect/parse-options.js'
+import { resolveActionAttempt } from 'lib/seam/connect/resolve-action-attempt.js'
 
+import { SeamHttpActionAttempts } from './action-attempts.js'
 import { SeamHttpClientSessions } from './client-sessions.js'
 import { SeamHttpThermostatsClimateSettingSchedules } from './thermostats-climate-setting-schedules.js'
 
@@ -161,12 +163,28 @@ export class SeamHttpThermostats {
     )
   }
 
-  async cool(body?: ThermostatsCoolBody): Promise<void> {
-    await this.client.request<ThermostatsCoolResponse>({
+  async cool(
+    body?: ThermostatsCoolBody,
+    options: Pick<SeamHttpRequestOptions, 'waitForActionAttempt'> = {},
+  ): Promise<ThermostatsCoolResponse['action_attempt']> {
+    const { data } = await this.client.request<ThermostatsCoolResponse>({
       url: '/thermostats/cool',
       method: 'post',
       data: body,
     })
+    const waitForActionAttempt =
+      options.waitForActionAttempt ?? this.defaults.waitForActionAttempt
+    if (waitForActionAttempt !== false) {
+      return await resolveActionAttempt(
+        data.action_attempt,
+        SeamHttpActionAttempts.fromClient(this.client, {
+          ...this.defaults,
+          waitForActionAttempt: false,
+        }),
+        typeof waitForActionAttempt === 'boolean' ? {} : waitForActionAttempt,
+      )
+    }
+    return data.action_attempt
   }
 
   async get(
@@ -181,20 +199,52 @@ export class SeamHttpThermostats {
     return data.thermostat
   }
 
-  async heat(body?: ThermostatsHeatBody): Promise<void> {
-    await this.client.request<ThermostatsHeatResponse>({
+  async heat(
+    body?: ThermostatsHeatBody,
+    options: Pick<SeamHttpRequestOptions, 'waitForActionAttempt'> = {},
+  ): Promise<ThermostatsHeatResponse['action_attempt']> {
+    const { data } = await this.client.request<ThermostatsHeatResponse>({
       url: '/thermostats/heat',
       method: 'post',
       data: body,
     })
+    const waitForActionAttempt =
+      options.waitForActionAttempt ?? this.defaults.waitForActionAttempt
+    if (waitForActionAttempt !== false) {
+      return await resolveActionAttempt(
+        data.action_attempt,
+        SeamHttpActionAttempts.fromClient(this.client, {
+          ...this.defaults,
+          waitForActionAttempt: false,
+        }),
+        typeof waitForActionAttempt === 'boolean' ? {} : waitForActionAttempt,
+      )
+    }
+    return data.action_attempt
   }
 
-  async heatCool(body?: ThermostatsHeatCoolBody): Promise<void> {
-    await this.client.request<ThermostatsHeatCoolResponse>({
+  async heatCool(
+    body?: ThermostatsHeatCoolBody,
+    options: Pick<SeamHttpRequestOptions, 'waitForActionAttempt'> = {},
+  ): Promise<ThermostatsHeatCoolResponse['action_attempt']> {
+    const { data } = await this.client.request<ThermostatsHeatCoolResponse>({
       url: '/thermostats/heat_cool',
       method: 'post',
       data: body,
     })
+    const waitForActionAttempt =
+      options.waitForActionAttempt ?? this.defaults.waitForActionAttempt
+    if (waitForActionAttempt !== false) {
+      return await resolveActionAttempt(
+        data.action_attempt,
+        SeamHttpActionAttempts.fromClient(this.client, {
+          ...this.defaults,
+          waitForActionAttempt: false,
+        }),
+        typeof waitForActionAttempt === 'boolean' ? {} : waitForActionAttempt,
+      )
+    }
+    return data.action_attempt
   }
 
   async list(
@@ -209,20 +259,52 @@ export class SeamHttpThermostats {
     return data.thermostats
   }
 
-  async off(body?: ThermostatsOffBody): Promise<void> {
-    await this.client.request<ThermostatsOffResponse>({
+  async off(
+    body?: ThermostatsOffBody,
+    options: Pick<SeamHttpRequestOptions, 'waitForActionAttempt'> = {},
+  ): Promise<ThermostatsOffResponse['action_attempt']> {
+    const { data } = await this.client.request<ThermostatsOffResponse>({
       url: '/thermostats/off',
       method: 'post',
       data: body,
     })
+    const waitForActionAttempt =
+      options.waitForActionAttempt ?? this.defaults.waitForActionAttempt
+    if (waitForActionAttempt !== false) {
+      return await resolveActionAttempt(
+        data.action_attempt,
+        SeamHttpActionAttempts.fromClient(this.client, {
+          ...this.defaults,
+          waitForActionAttempt: false,
+        }),
+        typeof waitForActionAttempt === 'boolean' ? {} : waitForActionAttempt,
+      )
+    }
+    return data.action_attempt
   }
 
-  async setFanMode(body?: ThermostatsSetFanModeBody): Promise<void> {
-    await this.client.request<ThermostatsSetFanModeResponse>({
+  async setFanMode(
+    body?: ThermostatsSetFanModeBody,
+    options: Pick<SeamHttpRequestOptions, 'waitForActionAttempt'> = {},
+  ): Promise<ThermostatsSetFanModeResponse['action_attempt']> {
+    const { data } = await this.client.request<ThermostatsSetFanModeResponse>({
       url: '/thermostats/set_fan_mode',
       method: 'post',
       data: body,
     })
+    const waitForActionAttempt =
+      options.waitForActionAttempt ?? this.defaults.waitForActionAttempt
+    if (waitForActionAttempt !== false) {
+      return await resolveActionAttempt(
+        data.action_attempt,
+        SeamHttpActionAttempts.fromClient(this.client, {
+          ...this.defaults,
+          waitForActionAttempt: false,
+        }),
+        typeof waitForActionAttempt === 'boolean' ? {} : waitForActionAttempt,
+      )
+    }
+    return data.action_attempt
   }
 
   async update(body?: ThermostatsUpdateBody): Promise<void> {
@@ -240,7 +322,10 @@ export type ThermostatsCoolResponse = SetNonNullable<
   Required<RouteResponse<'/thermostats/cool'>>
 >
 
-export type ThermostatsCoolOptions = never
+export type ThermostatsCoolOptions = Pick<
+  SeamHttpRequestOptions,
+  'waitForActionAttempt'
+>
 
 export type ThermostatsGetParams = RouteRequestBody<'/thermostats/get'>
 
@@ -256,7 +341,10 @@ export type ThermostatsHeatResponse = SetNonNullable<
   Required<RouteResponse<'/thermostats/heat'>>
 >
 
-export type ThermostatsHeatOptions = never
+export type ThermostatsHeatOptions = Pick<
+  SeamHttpRequestOptions,
+  'waitForActionAttempt'
+>
 
 export type ThermostatsHeatCoolBody = RouteRequestBody<'/thermostats/heat_cool'>
 
@@ -264,7 +352,10 @@ export type ThermostatsHeatCoolResponse = SetNonNullable<
   Required<RouteResponse<'/thermostats/heat_cool'>>
 >
 
-export type ThermostatsHeatCoolOptions = never
+export type ThermostatsHeatCoolOptions = Pick<
+  SeamHttpRequestOptions,
+  'waitForActionAttempt'
+>
 
 export type ThermostatsListParams = RouteRequestBody<'/thermostats/list'>
 
@@ -280,7 +371,10 @@ export type ThermostatsOffResponse = SetNonNullable<
   Required<RouteResponse<'/thermostats/off'>>
 >
 
-export type ThermostatsOffOptions = never
+export type ThermostatsOffOptions = Pick<
+  SeamHttpRequestOptions,
+  'waitForActionAttempt'
+>
 
 export type ThermostatsSetFanModeBody =
   RouteRequestBody<'/thermostats/set_fan_mode'>
@@ -289,7 +383,10 @@ export type ThermostatsSetFanModeResponse = SetNonNullable<
   Required<RouteResponse<'/thermostats/set_fan_mode'>>
 >
 
-export type ThermostatsSetFanModeOptions = never
+export type ThermostatsSetFanModeOptions = Pick<
+  SeamHttpRequestOptions,
+  'waitForActionAttempt'
+>
 
 export type ThermostatsUpdateBody = RouteRequestBody<'/thermostats/update'>
 

package/src/lib/version.ts

@@ -1,3 +1,3 @@
-const seamapiJavascriptHttpVersion = '0.22.0'
+const seamapiJavascriptHttpVersion = '0.24.0'
 
 export default seamapiJavascriptHttpVersion