@seamapi/http 1.50.0 → 1.51.0

package/src/lib/seam/connect/routes/instant-keys/instant-keys.ts

@@ -0,0 +1,200 @@
+/*
+ * Automatically generated by codegen/smith.ts.
+ * Do not edit this file or add other files to this directory.
+ */
+
+import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect'
+
+import { seamApiLtsVersion } from 'lib/lts-version.js'
+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 'lib/seam/connect/routes/client-sessions/index.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'
+
+export class SeamHttpInstantKeys {
+  client: Client
+  readonly defaults: Required<SeamHttpRequestOptions>
+  readonly ltsVersion = seamApiLtsVersion
+  static ltsVersion = seamApiLtsVersion
+
+  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'> = {},
+  ): SeamHttpInstantKeys {
+    const constructorOptions = { ...options, client }
+    if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing client')
+    }
+    return new SeamHttpInstantKeys(constructorOptions)
+  }
+
+  static fromApiKey(
+    apiKey: SeamHttpOptionsWithApiKey['apiKey'],
+    options: Omit<SeamHttpOptionsWithApiKey, 'apiKey'> = {},
+  ): SeamHttpInstantKeys {
+    const constructorOptions = { ...options, apiKey }
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing apiKey')
+    }
+    return new SeamHttpInstantKeys(constructorOptions)
+  }
+
+  static fromClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+    options: Omit<
+      SeamHttpOptionsWithClientSessionToken,
+      'clientSessionToken'
+    > = {},
+  ): SeamHttpInstantKeys {
+    const constructorOptions = { ...options, clientSessionToken }
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing clientSessionToken')
+    }
+    return new SeamHttpInstantKeys(constructorOptions)
+  }
+
+  static async fromPublishableKey(
+    publishableKey: string,
+    userIdentifierKey: string,
+    options: SeamHttpFromPublishableKeyOptions = {},
+  ): Promise<SeamHttpInstantKeys> {
+    warnOnInsecureuserIdentifierKey(userIdentifierKey)
+    const clientOptions = parseOptions({ ...options, publishableKey })
+    if (isSeamHttpOptionsWithClient(clientOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'The client option cannot be used with SeamHttpInstantKeys.fromPublishableKey',
+      )
+    }
+    const client = createClient(clientOptions)
+    const clientSessions = SeamHttpClientSessions.fromClient(client)
+    const { token } = await clientSessions.getOrCreate({
+      user_identifier_key: userIdentifierKey,
+    })
+    return SeamHttpInstantKeys.fromClientSessionToken(token, options)
+  }
+
+  static fromConsoleSessionToken(
+    consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'],
+    workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithConsoleSessionToken,
+      'consoleSessionToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpInstantKeys {
+    const constructorOptions = { ...options, consoleSessionToken, workspaceId }
+    if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing consoleSessionToken or workspaceId',
+      )
+    }
+    return new SeamHttpInstantKeys(constructorOptions)
+  }
+
+  static fromPersonalAccessToken(
+    personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'],
+    workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithPersonalAccessToken,
+      'personalAccessToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpInstantKeys {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId }
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing personalAccessToken or workspaceId',
+      )
+    }
+    return new SeamHttpInstantKeys(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()
+  }
+
+  list(
+    parameters?: InstantKeysListParameters,
+    options: InstantKeysListOptions = {},
+  ): InstantKeysListRequest {
+    return new SeamHttpRequest(this, {
+      pathname: '/instant_keys/list',
+      method: 'POST',
+      body: parameters,
+      responseKey: 'instant_keys',
+      options,
+    })
+  }
+}
+
+export type InstantKeysListParameters = RouteRequestBody<'/instant_keys/list'>
+
+/**
+ * @deprecated Use InstantKeysListParameters instead.
+ */
+export type InstantKeysListParams = InstantKeysListParameters
+
+/**
+ * @deprecated Use InstantKeysListRequest instead.
+ */
+export type InstantKeysListResponse = SetNonNullable<
+  Required<RouteResponse<'/instant_keys/list'>>
+>
+
+export type InstantKeysListRequest = SeamHttpRequest<
+  InstantKeysListResponse,
+  'instant_keys'
+>
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface InstantKeysListOptions {}

package/src/lib/seam/connect/routes/seam/console/v1/v1.ts

@@ -168,45 +168,45 @@ export class SeamHttpSeamConsoleV1 {
     await clientSessions.get()
   }
 
-  getResourceType(
-    parameters?: SeamConsoleV1GetResourceTypeParameters,
-    options: SeamConsoleV1GetResourceTypeOptions = {},
-  ): SeamConsoleV1GetResourceTypeRequest {
+  getResourceLocator(
+    parameters?: SeamConsoleV1GetResourceLocatorParameters,
+    options: SeamConsoleV1GetResourceLocatorOptions = {},
+  ): SeamConsoleV1GetResourceLocatorRequest {
     if (!this.defaults.isUndocumentedApiEnabled) {
       throw new Error(
         'Cannot use undocumented API without isUndocumentedApiEnabled',
       )
     }
     return new SeamHttpRequest(this, {
-      pathname: '/seam/console/v1/get_resource_type',
+      pathname: '/seam/console/v1/get_resource_locator',
       method: 'GET',
       params: parameters,
-      responseKey: 'resource_type',
+      responseKey: 'resource_locator',
       options,
     })
   }
 }
 
-export type SeamConsoleV1GetResourceTypeParameters =
-  RouteRequestParams<'/seam/console/v1/get_resource_type'>
+export type SeamConsoleV1GetResourceLocatorParameters =
+  RouteRequestParams<'/seam/console/v1/get_resource_locator'>
 
 /**
- * @deprecated Use SeamConsoleV1GetResourceTypeParameters instead.
+ * @deprecated Use SeamConsoleV1GetResourceLocatorParameters instead.
  */
-export type SeamConsoleV1GetResourceTypeParams =
-  SeamConsoleV1GetResourceTypeParameters
+export type SeamConsoleV1GetResourceLocatorParams =
+  SeamConsoleV1GetResourceLocatorParameters
 
 /**
- * @deprecated Use SeamConsoleV1GetResourceTypeRequest instead.
+ * @deprecated Use SeamConsoleV1GetResourceLocatorRequest instead.
  */
-export type SeamConsoleV1GetResourceTypeResponse = SetNonNullable<
-  Required<RouteResponse<'/seam/console/v1/get_resource_type'>>
+export type SeamConsoleV1GetResourceLocatorResponse = SetNonNullable<
+  Required<RouteResponse<'/seam/console/v1/get_resource_locator'>>
 >
 
-export type SeamConsoleV1GetResourceTypeRequest = SeamHttpRequest<
-  SeamConsoleV1GetResourceTypeResponse,
-  'resource_type'
+export type SeamConsoleV1GetResourceLocatorRequest = SeamHttpRequest<
+  SeamConsoleV1GetResourceLocatorResponse,
+  'resource_locator'
 >
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface SeamConsoleV1GetResourceTypeOptions {}
+export interface SeamConsoleV1GetResourceLocatorOptions {}

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

@@ -452,6 +452,12 @@ import {
   type EventsListRequest,
   SeamHttpEvents,
 } from './events/index.js'
+import {
+  type InstantKeysListOptions,
+  type InstantKeysListParameters,
+  type InstantKeysListRequest,
+  SeamHttpInstantKeys,
+} from './instant-keys/index.js'
 import {
   type LocksGetOptions,
   type LocksGetParameters,
@@ -525,9 +531,9 @@ import {
   SeamHttpPhonesSimulate,
 } from './phones/simulate/index.js'
 import {
-  type SeamConsoleV1GetResourceTypeOptions,
-  type SeamConsoleV1GetResourceTypeParameters,
-  type SeamConsoleV1GetResourceTypeRequest,
+  type SeamConsoleV1GetResourceLocatorOptions,
+  type SeamConsoleV1GetResourceLocatorParameters,
+  type SeamConsoleV1GetResourceLocatorRequest,
   SeamHttpSeamConsoleV1,
 } from './seam/console/v1/index.js'
 import {
@@ -2534,6 +2540,19 @@ export class SeamHttpEndpoints {
     }
   }
 
+  get ['/instant_keys/list'](): (
+    parameters?: InstantKeysListParameters,
+    options?: InstantKeysListOptions,
+  ) => InstantKeysListRequest {
+    const { client, defaults } = this
+    return function instantKeysList(
+      ...args: Parameters<SeamHttpInstantKeys['list']>
+    ): ReturnType<SeamHttpInstantKeys['list']> {
+      const seam = SeamHttpInstantKeys.fromClient(client, defaults)
+      return seam.list(...args)
+    }
+  }
+
   get ['/locks/get'](): (
     parameters?: LocksGetParameters,
     options?: LocksGetOptions,
@@ -2770,21 +2789,21 @@ export class SeamHttpEndpoints {
     }
   }
 
-  get ['/seam/console/v1/get_resource_type'](): (
-    parameters?: SeamConsoleV1GetResourceTypeParameters,
-    options?: SeamConsoleV1GetResourceTypeOptions,
-  ) => SeamConsoleV1GetResourceTypeRequest {
+  get ['/seam/console/v1/get_resource_locator'](): (
+    parameters?: SeamConsoleV1GetResourceLocatorParameters,
+    options?: SeamConsoleV1GetResourceLocatorOptions,
+  ) => SeamConsoleV1GetResourceLocatorRequest {
     const { client, defaults } = this
     if (!this.defaults.isUndocumentedApiEnabled) {
       throw new Error(
         'Cannot use undocumented API without isUndocumentedApiEnabled',
       )
     }
-    return function seamConsoleV1GetResourceType(
-      ...args: Parameters<SeamHttpSeamConsoleV1['getResourceType']>
-    ): ReturnType<SeamHttpSeamConsoleV1['getResourceType']> {
+    return function seamConsoleV1GetResourceLocator(
+      ...args: Parameters<SeamHttpSeamConsoleV1['getResourceLocator']>
+    ): ReturnType<SeamHttpSeamConsoleV1['getResourceLocator']> {
       const seam = SeamHttpSeamConsoleV1.fromClient(client, defaults)
-      return seam.getResourceType(...args)
+      return seam.getResourceLocator(...args)
     }
   }
 
@@ -4205,6 +4224,7 @@ export type SeamHttpEndpointQueryPaths =
   | '/devices/unmanaged/list'
   | '/events/get'
   | '/events/list'
+  | '/instant_keys/list'
   | '/locks/get'
   | '/locks/list'
   | '/noise_sensors/list'
@@ -4212,7 +4232,7 @@ export type SeamHttpEndpointQueryPaths =
   | '/noise_sensors/noise_thresholds/list'
   | '/phones/get'
   | '/phones/list'
-  | '/seam/console/v1/get_resource_type'
+  | '/seam/console/v1/get_resource_locator'
   | '/seam/customer/v1/automation_runs/list'
   | '/seam/customer/v1/automations/get'
   | '/seam/customer/v1/portals/get'

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

@@ -44,6 +44,7 @@ import { SeamHttpConnectedAccounts } from './connected-accounts/index.js'
 import { SeamHttpCustomers } from './customers/index.js'
 import { SeamHttpDevices } from './devices/index.js'
 import { SeamHttpEvents } from './events/index.js'
+import { SeamHttpInstantKeys } from './instant-keys/index.js'
 import { SeamHttpLocks } from './locks/index.js'
 import { SeamHttpNoiseSensors } from './noise-sensors/index.js'
 import { SeamHttpPhones } from './phones/index.js'
@@ -232,6 +233,10 @@ export class SeamHttp {
     return SeamHttpEvents.fromClient(this.client, this.defaults)
   }
 
+  get instantKeys(): SeamHttpInstantKeys {
+    return SeamHttpInstantKeys.fromClient(this.client, this.defaults)
+  }
+
   get locks(): SeamHttpLocks {
     return SeamHttpLocks.fromClient(this.client, this.defaults)
   }

package/src/lib/version.ts

@@ -1,3 +1,3 @@
-const seamapiJavascriptHttpVersion = '1.50.0'
+const seamapiJavascriptHttpVersion = '1.51.0'
 
 export default seamapiJavascriptHttpVersion