@seamapi/http 1.41.0 → 1.42.0

package/src/lib/seam/connect/routes/seam/customer/v1/automation-runs/automation-runs.ts

@@ -0,0 +1,215 @@
+/*
+ * 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 SeamHttpSeamCustomerV1AutomationRuns {
+  client: Client
+  readonly defaults: Required<SeamHttpRequestOptions>
+  readonly ltsVersion = seamApiLtsVersion
+  static ltsVersion = seamApiLtsVersion
+
+  constructor(apiKeyOrOptions: string | SeamHttpOptions = {}) {
+    const options = parseOptions(apiKeyOrOptions)
+    if (!options.isUndocumentedApiEnabled) {
+      throw new Error(
+        'Cannot use undocumented API without isUndocumentedApiEnabled',
+      )
+    }
+    this.client = 'client' in options ? options.client : createClient(options)
+    this.defaults = limitToSeamHttpRequestOptions(options)
+  }
+
+  static fromClient(
+    client: SeamHttpOptionsWithClient['client'],
+    options: Omit<SeamHttpOptionsWithClient, 'client'> = {},
+  ): SeamHttpSeamCustomerV1AutomationRuns {
+    const constructorOptions = { ...options, client }
+    if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing client')
+    }
+    return new SeamHttpSeamCustomerV1AutomationRuns(constructorOptions)
+  }
+
+  static fromApiKey(
+    apiKey: SeamHttpOptionsWithApiKey['apiKey'],
+    options: Omit<SeamHttpOptionsWithApiKey, 'apiKey'> = {},
+  ): SeamHttpSeamCustomerV1AutomationRuns {
+    const constructorOptions = { ...options, apiKey }
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing apiKey')
+    }
+    return new SeamHttpSeamCustomerV1AutomationRuns(constructorOptions)
+  }
+
+  static fromClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+    options: Omit<
+      SeamHttpOptionsWithClientSessionToken,
+      'clientSessionToken'
+    > = {},
+  ): SeamHttpSeamCustomerV1AutomationRuns {
+    const constructorOptions = { ...options, clientSessionToken }
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing clientSessionToken')
+    }
+    return new SeamHttpSeamCustomerV1AutomationRuns(constructorOptions)
+  }
+
+  static async fromPublishableKey(
+    publishableKey: string,
+    userIdentifierKey: string,
+    options: SeamHttpFromPublishableKeyOptions = {},
+  ): Promise<SeamHttpSeamCustomerV1AutomationRuns> {
+    warnOnInsecureuserIdentifierKey(userIdentifierKey)
+    const clientOptions = parseOptions({ ...options, publishableKey })
+    if (isSeamHttpOptionsWithClient(clientOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'The client option cannot be used with SeamHttpSeamCustomerV1AutomationRuns.fromPublishableKey',
+      )
+    }
+    const client = createClient(clientOptions)
+    const clientSessions = SeamHttpClientSessions.fromClient(client)
+    const { token } = await clientSessions.getOrCreate({
+      user_identifier_key: userIdentifierKey,
+    })
+    return SeamHttpSeamCustomerV1AutomationRuns.fromClientSessionToken(
+      token,
+      options,
+    )
+  }
+
+  static fromConsoleSessionToken(
+    consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'],
+    workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithConsoleSessionToken,
+      'consoleSessionToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpSeamCustomerV1AutomationRuns {
+    const constructorOptions = { ...options, consoleSessionToken, workspaceId }
+    if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing consoleSessionToken or workspaceId',
+      )
+    }
+    return new SeamHttpSeamCustomerV1AutomationRuns(constructorOptions)
+  }
+
+  static fromPersonalAccessToken(
+    personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'],
+    workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithPersonalAccessToken,
+      'personalAccessToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpSeamCustomerV1AutomationRuns {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId }
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing personalAccessToken or workspaceId',
+      )
+    }
+    return new SeamHttpSeamCustomerV1AutomationRuns(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?: SeamCustomerV1AutomationRunsListParameters,
+    options: SeamCustomerV1AutomationRunsListOptions = {},
+  ): SeamCustomerV1AutomationRunsListRequest {
+    if (!this.defaults.isUndocumentedApiEnabled) {
+      throw new Error(
+        'Cannot use undocumented API without isUndocumentedApiEnabled',
+      )
+    }
+    return new SeamHttpRequest(this, {
+      pathname: '/seam/customer/v1/automation_runs/list',
+      method: 'POST',
+      body: parameters,
+      responseKey: 'automation_runs',
+      options,
+    })
+  }
+}
+
+export type SeamCustomerV1AutomationRunsListParameters =
+  RouteRequestBody<'/seam/customer/v1/automation_runs/list'>
+
+/**
+ * @deprecated Use SeamCustomerV1AutomationRunsListParameters instead.
+ */
+export type SeamCustomerV1AutomationRunsListParams =
+  SeamCustomerV1AutomationRunsListParameters
+
+/**
+ * @deprecated Use SeamCustomerV1AutomationRunsListRequest instead.
+ */
+export type SeamCustomerV1AutomationRunsListResponse = SetNonNullable<
+  Required<RouteResponse<'/seam/customer/v1/automation_runs/list'>>
+>
+
+export type SeamCustomerV1AutomationRunsListRequest = SeamHttpRequest<
+  SeamCustomerV1AutomationRunsListResponse,
+  'automation_runs'
+>
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface SeamCustomerV1AutomationRunsListOptions {}

package/src/lib/seam/connect/routes/seam/customer/v1/automation-runs/index.ts

@@ -0,0 +1,6 @@
+/*
+ * Automatically generated by codegen/smith.ts.
+ * Do not edit this file or add other files to this directory.
+ */
+
+export * from './automation-runs.js'

package/src/lib/seam/connect/routes/seam/customer/v1/automations/automations.ts

@@ -0,0 +1,303 @@
+/*
+ * Automatically generated by codegen/smith.ts.
+ * Do not edit this file or add other files to this directory.
+ */
+
+import type {
+  RouteRequestBody,
+  RouteRequestParams,
+  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 SeamHttpSeamCustomerV1Automations {
+  client: Client
+  readonly defaults: Required<SeamHttpRequestOptions>
+  readonly ltsVersion = seamApiLtsVersion
+  static ltsVersion = seamApiLtsVersion
+
+  constructor(apiKeyOrOptions: string | SeamHttpOptions = {}) {
+    const options = parseOptions(apiKeyOrOptions)
+    if (!options.isUndocumentedApiEnabled) {
+      throw new Error(
+        'Cannot use undocumented API without isUndocumentedApiEnabled',
+      )
+    }
+    this.client = 'client' in options ? options.client : createClient(options)
+    this.defaults = limitToSeamHttpRequestOptions(options)
+  }
+
+  static fromClient(
+    client: SeamHttpOptionsWithClient['client'],
+    options: Omit<SeamHttpOptionsWithClient, 'client'> = {},
+  ): SeamHttpSeamCustomerV1Automations {
+    const constructorOptions = { ...options, client }
+    if (!isSeamHttpOptionsWithClient(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing client')
+    }
+    return new SeamHttpSeamCustomerV1Automations(constructorOptions)
+  }
+
+  static fromApiKey(
+    apiKey: SeamHttpOptionsWithApiKey['apiKey'],
+    options: Omit<SeamHttpOptionsWithApiKey, 'apiKey'> = {},
+  ): SeamHttpSeamCustomerV1Automations {
+    const constructorOptions = { ...options, apiKey }
+    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing apiKey')
+    }
+    return new SeamHttpSeamCustomerV1Automations(constructorOptions)
+  }
+
+  static fromClientSessionToken(
+    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
+    options: Omit<
+      SeamHttpOptionsWithClientSessionToken,
+      'clientSessionToken'
+    > = {},
+  ): SeamHttpSeamCustomerV1Automations {
+    const constructorOptions = { ...options, clientSessionToken }
+    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError('Missing clientSessionToken')
+    }
+    return new SeamHttpSeamCustomerV1Automations(constructorOptions)
+  }
+
+  static async fromPublishableKey(
+    publishableKey: string,
+    userIdentifierKey: string,
+    options: SeamHttpFromPublishableKeyOptions = {},
+  ): Promise<SeamHttpSeamCustomerV1Automations> {
+    warnOnInsecureuserIdentifierKey(userIdentifierKey)
+    const clientOptions = parseOptions({ ...options, publishableKey })
+    if (isSeamHttpOptionsWithClient(clientOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'The client option cannot be used with SeamHttpSeamCustomerV1Automations.fromPublishableKey',
+      )
+    }
+    const client = createClient(clientOptions)
+    const clientSessions = SeamHttpClientSessions.fromClient(client)
+    const { token } = await clientSessions.getOrCreate({
+      user_identifier_key: userIdentifierKey,
+    })
+    return SeamHttpSeamCustomerV1Automations.fromClientSessionToken(
+      token,
+      options,
+    )
+  }
+
+  static fromConsoleSessionToken(
+    consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'],
+    workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithConsoleSessionToken,
+      'consoleSessionToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpSeamCustomerV1Automations {
+    const constructorOptions = { ...options, consoleSessionToken, workspaceId }
+    if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing consoleSessionToken or workspaceId',
+      )
+    }
+    return new SeamHttpSeamCustomerV1Automations(constructorOptions)
+  }
+
+  static fromPersonalAccessToken(
+    personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'],
+    workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'],
+    options: Omit<
+      SeamHttpOptionsWithPersonalAccessToken,
+      'personalAccessToken' | 'workspaceId'
+    > = {},
+  ): SeamHttpSeamCustomerV1Automations {
+    const constructorOptions = { ...options, personalAccessToken, workspaceId }
+    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
+      throw new SeamHttpInvalidOptionsError(
+        'Missing personalAccessToken or workspaceId',
+      )
+    }
+    return new SeamHttpSeamCustomerV1Automations(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(
+    parameters?: SeamCustomerV1AutomationsDeleteParameters,
+    options: SeamCustomerV1AutomationsDeleteOptions = {},
+  ): SeamCustomerV1AutomationsDeleteRequest {
+    if (!this.defaults.isUndocumentedApiEnabled) {
+      throw new Error(
+        'Cannot use undocumented API without isUndocumentedApiEnabled',
+      )
+    }
+    return new SeamHttpRequest(this, {
+      pathname: '/seam/customer/v1/automations/delete',
+      method: 'POST',
+      body: parameters,
+      responseKey: undefined,
+      options,
+    })
+  }
+
+  get(
+    parameters?: SeamCustomerV1AutomationsGetParameters,
+    options: SeamCustomerV1AutomationsGetOptions = {},
+  ): SeamCustomerV1AutomationsGetRequest {
+    if (!this.defaults.isUndocumentedApiEnabled) {
+      throw new Error(
+        'Cannot use undocumented API without isUndocumentedApiEnabled',
+      )
+    }
+    return new SeamHttpRequest(this, {
+      pathname: '/seam/customer/v1/automations/get',
+      method: 'GET',
+      params: parameters,
+      responseKey: undefined,
+      options,
+    })
+  }
+
+  update(
+    parameters?: SeamCustomerV1AutomationsUpdateParameters,
+    options: SeamCustomerV1AutomationsUpdateOptions = {},
+  ): SeamCustomerV1AutomationsUpdateRequest {
+    if (!this.defaults.isUndocumentedApiEnabled) {
+      throw new Error(
+        'Cannot use undocumented API without isUndocumentedApiEnabled',
+      )
+    }
+    return new SeamHttpRequest(this, {
+      pathname: '/seam/customer/v1/automations/update',
+      method: 'PATCH',
+      body: parameters,
+      responseKey: undefined,
+      options,
+    })
+  }
+}
+
+export type SeamCustomerV1AutomationsDeleteParameters =
+  RouteRequestBody<'/seam/customer/v1/automations/delete'>
+
+/**
+ * @deprecated Use SeamCustomerV1AutomationsDeleteParameters instead.
+ */
+export type SeamCustomerV1AutomationsDeleteParams =
+  SeamCustomerV1AutomationsDeleteParameters
+
+/**
+ * @deprecated Use SeamCustomerV1AutomationsDeleteRequest instead.
+ */
+export type SeamCustomerV1AutomationsDeleteResponse = SetNonNullable<
+  Required<RouteResponse<'/seam/customer/v1/automations/delete'>>
+>
+
+export type SeamCustomerV1AutomationsDeleteRequest = SeamHttpRequest<
+  void,
+  undefined
+>
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface SeamCustomerV1AutomationsDeleteOptions {}
+
+export type SeamCustomerV1AutomationsGetParameters =
+  RouteRequestParams<'/seam/customer/v1/automations/get'>
+
+/**
+ * @deprecated Use SeamCustomerV1AutomationsGetParameters instead.
+ */
+export type SeamCustomerV1AutomationsGetParams =
+  SeamCustomerV1AutomationsGetParameters
+
+/**
+ * @deprecated Use SeamCustomerV1AutomationsGetRequest instead.
+ */
+export type SeamCustomerV1AutomationsGetResponse = SetNonNullable<
+  Required<RouteResponse<'/seam/customer/v1/automations/get'>>
+>
+
+export type SeamCustomerV1AutomationsGetRequest = SeamHttpRequest<
+  void,
+  undefined
+>
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface SeamCustomerV1AutomationsGetOptions {}
+
+export type SeamCustomerV1AutomationsUpdateParameters =
+  RouteRequestBody<'/seam/customer/v1/automations/update'>
+
+/**
+ * @deprecated Use SeamCustomerV1AutomationsUpdateParameters instead.
+ */
+export type SeamCustomerV1AutomationsUpdateBody =
+  SeamCustomerV1AutomationsUpdateParameters
+
+/**
+ * @deprecated Use SeamCustomerV1AutomationsUpdateRequest instead.
+ */
+export type SeamCustomerV1AutomationsUpdateResponse = SetNonNullable<
+  Required<RouteResponse<'/seam/customer/v1/automations/update'>>
+>
+
+export type SeamCustomerV1AutomationsUpdateRequest = SeamHttpRequest<
+  void,
+  undefined
+>
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface SeamCustomerV1AutomationsUpdateOptions {}

package/src/lib/seam/connect/routes/seam/customer/v1/automations/index.ts

@@ -0,0 +1,6 @@
+/*
+ * Automatically generated by codegen/smith.ts.
+ * Do not edit this file or add other files to this directory.
+ */
+
+export * from './automations.js'

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

@@ -3,6 +3,8 @@
  * Do not edit this file or add other files to this directory.
  */
 
+export * from './automation-runs/index.js'
+export * from './automations/index.js'
 export * from './portals/index.js'
 export * from './settings/index.js'
 export * from './v1.js'

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

@@ -33,6 +33,8 @@ import { SeamHttpClientSessions } from 'lib/seam/connect/routes/client-sessions/
 import type { SeamHttpRequest } from 'lib/seam/connect/seam-http-request.js'
 import { SeamPaginator } from 'lib/seam/connect/seam-paginator.js'
 
+import { SeamHttpSeamCustomerV1AutomationRuns } from './automation-runs/index.js'
+import { SeamHttpSeamCustomerV1Automations } from './automations/index.js'
 import { SeamHttpSeamCustomerV1Portals } from './portals/index.js'
 import { SeamHttpSeamCustomerV1Settings } from './settings/index.js'
 
@@ -168,6 +170,20 @@ export class SeamHttpSeamCustomerV1 {
     await clientSessions.get()
   }
 
+  get automationRuns(): SeamHttpSeamCustomerV1AutomationRuns {
+    return SeamHttpSeamCustomerV1AutomationRuns.fromClient(
+      this.client,
+      this.defaults,
+    )
+  }
+
+  get automations(): SeamHttpSeamCustomerV1Automations {
+    return SeamHttpSeamCustomerV1Automations.fromClient(
+      this.client,
+      this.defaults,
+    )
+  }
+
   get portals(): SeamHttpSeamCustomerV1Portals {
     return SeamHttpSeamCustomerV1Portals.fromClient(this.client, this.defaults)
   }