customers.ts

/*
 * 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'

import { SeamHttpSeamCustomerV1CustomersAutomations } from './automations/index.js'

export class SeamHttpSeamCustomerV1Customers {
  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'> = {},
  ): SeamHttpSeamCustomerV1Customers {
    const constructorOptions = { ...options, client }
    if (!isSeamHttpOptionsWithClient(constructorOptions)) {
      throw new SeamHttpInvalidOptionsError('Missing client')
    }
    return new SeamHttpSeamCustomerV1Customers(constructorOptions)
  }

  static fromApiKey(
    apiKey: SeamHttpOptionsWithApiKey['apiKey'],
    options: Omit<SeamHttpOptionsWithApiKey, 'apiKey'> = {},
  ): SeamHttpSeamCustomerV1Customers {
    const constructorOptions = { ...options, apiKey }
    if (!isSeamHttpOptionsWithApiKey(constructorOptions)) {
      throw new SeamHttpInvalidOptionsError('Missing apiKey')
    }
    return new SeamHttpSeamCustomerV1Customers(constructorOptions)
  }

  static fromClientSessionToken(
    clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'],
    options: Omit<
      SeamHttpOptionsWithClientSessionToken,
      'clientSessionToken'
    > = {},
  ): SeamHttpSeamCustomerV1Customers {
    const constructorOptions = { ...options, clientSessionToken }
    if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) {
      throw new SeamHttpInvalidOptionsError('Missing clientSessionToken')
    }
    return new SeamHttpSeamCustomerV1Customers(constructorOptions)
  }

  static async fromPublishableKey(
    publishableKey: string,
    userIdentifierKey: string,
    options: SeamHttpFromPublishableKeyOptions = {},
  ): Promise<SeamHttpSeamCustomerV1Customers> {
    warnOnInsecureuserIdentifierKey(userIdentifierKey)
    const clientOptions = parseOptions({ ...options, publishableKey })
    if (isSeamHttpOptionsWithClient(clientOptions)) {
      throw new SeamHttpInvalidOptionsError(
        'The client option cannot be used with SeamHttpSeamCustomerV1Customers.fromPublishableKey',
      )
    }
    const client = createClient(clientOptions)
    const clientSessions = SeamHttpClientSessions.fromClient(client)
    const { token } = await clientSessions.getOrCreate({
      user_identifier_key: userIdentifierKey,
    })
    return SeamHttpSeamCustomerV1Customers.fromClientSessionToken(
      token,
      options,
    )
  }

  static fromConsoleSessionToken(
    consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'],
    workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'],
    options: Omit<
      SeamHttpOptionsWithConsoleSessionToken,
      'consoleSessionToken' | 'workspaceId'
    > = {},
  ): SeamHttpSeamCustomerV1Customers {
    const constructorOptions = { ...options, consoleSessionToken, workspaceId }
    if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) {
      throw new SeamHttpInvalidOptionsError(
        'Missing consoleSessionToken or workspaceId',
      )
    }
    return new SeamHttpSeamCustomerV1Customers(constructorOptions)
  }

  static fromPersonalAccessToken(
    personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'],
    workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'],
    options: Omit<
      SeamHttpOptionsWithPersonalAccessToken,
      'personalAccessToken' | 'workspaceId'
    > = {},
  ): SeamHttpSeamCustomerV1Customers {
    const constructorOptions = { ...options, personalAccessToken, workspaceId }
    if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) {
      throw new SeamHttpInvalidOptionsError(
        'Missing personalAccessToken or workspaceId',
      )
    }
    return new SeamHttpSeamCustomerV1Customers(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()
  }

  get automations(): SeamHttpSeamCustomerV1CustomersAutomations {
    return SeamHttpSeamCustomerV1CustomersAutomations.fromClient(
      this.client,
      this.defaults,
    )
  }

  list(
    parameters?: SeamCustomerV1CustomersListParameters,
    options: SeamCustomerV1CustomersListOptions = {},
  ): SeamCustomerV1CustomersListRequest {
    if (!this.defaults.isUndocumentedApiEnabled) {
      throw new Error(
        'Cannot use undocumented API without isUndocumentedApiEnabled',
      )
    }
    return new SeamHttpRequest(this, {
      pathname: '/seam/customer/v1/customers/list',
      method: 'POST',
      body: parameters,
      responseKey: 'customers',
      options,
    })
  }

  me(
    parameters?: SeamCustomerV1CustomersMeParameters,
    options: SeamCustomerV1CustomersMeOptions = {},
  ): SeamCustomerV1CustomersMeRequest {
    if (!this.defaults.isUndocumentedApiEnabled) {
      throw new Error(
        'Cannot use undocumented API without isUndocumentedApiEnabled',
      )
    }
    return new SeamHttpRequest(this, {
      pathname: '/seam/customer/v1/customers/me',
      method: 'GET',
      params: parameters,
      responseKey: undefined,
      options,
    })
  }

  openPortal(
    parameters?: SeamCustomerV1CustomersOpenPortalParameters,
    options: SeamCustomerV1CustomersOpenPortalOptions = {},
  ): SeamCustomerV1CustomersOpenPortalRequest {
    if (!this.defaults.isUndocumentedApiEnabled) {
      throw new Error(
        'Cannot use undocumented API without isUndocumentedApiEnabled',
      )
    }
    return new SeamHttpRequest(this, {
      pathname: '/seam/customer/v1/customers/open_portal',
      method: 'POST',
      body: parameters,
      responseKey: 'magic_link',
      options,
    })
  }
}

export type SeamCustomerV1CustomersListParameters =
  RouteRequestBody<'/seam/customer/v1/customers/list'>

/**
 * @deprecated Use SeamCustomerV1CustomersListParameters instead.
 */
export type SeamCustomerV1CustomersListParams =
  SeamCustomerV1CustomersListParameters

/**
 * @deprecated Use SeamCustomerV1CustomersListRequest instead.
 */
export type SeamCustomerV1CustomersListResponse = SetNonNullable<
  Required<RouteResponse<'/seam/customer/v1/customers/list'>>
>

export type SeamCustomerV1CustomersListRequest = SeamHttpRequest<
  SeamCustomerV1CustomersListResponse,
  'customers'
>

export interface SeamCustomerV1CustomersListOptions {}

export type SeamCustomerV1CustomersMeParameters =
  RouteRequestParams<'/seam/customer/v1/customers/me'>

/**
 * @deprecated Use SeamCustomerV1CustomersMeParameters instead.
 */
export type SeamCustomerV1CustomersMeParams =
  SeamCustomerV1CustomersMeParameters

/**
 * @deprecated Use SeamCustomerV1CustomersMeRequest instead.
 */
export type SeamCustomerV1CustomersMeResponse = SetNonNullable<
  Required<RouteResponse<'/seam/customer/v1/customers/me'>>
>

export type SeamCustomerV1CustomersMeRequest = SeamHttpRequest<void, undefined>

export interface SeamCustomerV1CustomersMeOptions {}

export type SeamCustomerV1CustomersOpenPortalParameters =
  RouteRequestBody<'/seam/customer/v1/customers/open_portal'>

/**
 * @deprecated Use SeamCustomerV1CustomersOpenPortalParameters instead.
 */
export type SeamCustomerV1CustomersOpenPortalBody =
  SeamCustomerV1CustomersOpenPortalParameters

/**
 * @deprecated Use SeamCustomerV1CustomersOpenPortalRequest instead.
 */
export type SeamCustomerV1CustomersOpenPortalResponse = SetNonNullable<
  Required<RouteResponse<'/seam/customer/v1/customers/open_portal'>>
>

export type SeamCustomerV1CustomersOpenPortalRequest = SeamHttpRequest<
  SeamCustomerV1CustomersOpenPortalResponse,
  'magic_link'
>

export interface SeamCustomerV1CustomersOpenPortalOptions {}