access-grants.ts

/*
 * Automatically generated by codegen/smith.ts.
 * Do not edit this file or add other files to this directory.
 */

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 type {
  RouteRequestBody,
  RouteRequestParams,
  RouteResponse,
} from 'lib/seam/connect/route-types.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 { SeamHttpAccessGrantsUnmanaged } from './unmanaged/index.js'

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

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

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

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

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

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

  create(
    parameters?: AccessGrantsCreateParameters,
    options: AccessGrantsCreateOptions = {},
  ): AccessGrantsCreateRequest {
    return new SeamHttpRequest(this, {
      pathname: '/access_grants/create',
      method: 'POST',
      body: parameters,
      responseKey: 'access_grant',
      options,
    })
  }

  delete(
    parameters?: AccessGrantsDeleteParameters,
    options: AccessGrantsDeleteOptions = {},
  ): AccessGrantsDeleteRequest {
    return new SeamHttpRequest(this, {
      pathname: '/access_grants/delete',
      method: 'POST',
      body: parameters,
      responseKey: undefined,
      options,
    })
  }

  get(
    parameters?: AccessGrantsGetParameters,
    options: AccessGrantsGetOptions = {},
  ): AccessGrantsGetRequest {
    return new SeamHttpRequest(this, {
      pathname: '/access_grants/get',
      method: 'GET',
      params: parameters,
      responseKey: 'access_grant',
      options,
    })
  }

  getRelated(
    parameters?: AccessGrantsGetRelatedParameters,
    options: AccessGrantsGetRelatedOptions = {},
  ): AccessGrantsGetRelatedRequest {
    return new SeamHttpRequest(this, {
      pathname: '/access_grants/get_related',
      method: 'POST',
      body: parameters,
      responseKey: 'batch',
      options,
    })
  }

  list(
    parameters?: AccessGrantsListParameters,
    options: AccessGrantsListOptions = {},
  ): AccessGrantsListRequest {
    return new SeamHttpRequest(this, {
      pathname: '/access_grants/list',
      method: 'POST',
      body: parameters,
      responseKey: 'access_grants',
      options,
    })
  }

  requestAccessMethods(
    parameters?: AccessGrantsRequestAccessMethodsParameters,
    options: AccessGrantsRequestAccessMethodsOptions = {},
  ): AccessGrantsRequestAccessMethodsRequest {
    return new SeamHttpRequest(this, {
      pathname: '/access_grants/request_access_methods',
      method: 'POST',
      body: parameters,
      responseKey: 'access_grant',
      options,
    })
  }

  update(
    parameters?: AccessGrantsUpdateParameters,
    options: AccessGrantsUpdateOptions = {},
  ): AccessGrantsUpdateRequest {
    return new SeamHttpRequest(this, {
      pathname: '/access_grants/update',
      method: 'PATCH',
      body: parameters,
      responseKey: undefined,
      options,
    })
  }
}

export type AccessGrantsCreateParameters =
  RouteRequestBody<'/access_grants/create'>

/**
 * @deprecated Use AccessGrantsCreateParameters instead.
 */
export type AccessGrantsCreateBody = AccessGrantsCreateParameters

/**
 * @deprecated Use AccessGrantsCreateRequest instead.
 */
export type AccessGrantsCreateResponse = SetNonNullable<
  Required<RouteResponse<'/access_grants/create'>>
>

export type AccessGrantsCreateRequest = SeamHttpRequest<
  AccessGrantsCreateResponse,
  'access_grant'
>

export interface AccessGrantsCreateOptions {}

export type AccessGrantsDeleteParameters =
  RouteRequestBody<'/access_grants/delete'>

/**
 * @deprecated Use AccessGrantsDeleteParameters instead.
 */
export type AccessGrantsDeleteParams = AccessGrantsDeleteParameters

/**
 * @deprecated Use AccessGrantsDeleteRequest instead.
 */
export type AccessGrantsDeleteResponse = SetNonNullable<
  Required<RouteResponse<'/access_grants/delete'>>
>

export type AccessGrantsDeleteRequest = SeamHttpRequest<void, undefined>

export interface AccessGrantsDeleteOptions {}

export type AccessGrantsGetParameters = RouteRequestParams<'/access_grants/get'>

/**
 * @deprecated Use AccessGrantsGetParameters instead.
 */
export type AccessGrantsGetParams = AccessGrantsGetParameters

/**
 * @deprecated Use AccessGrantsGetRequest instead.
 */
export type AccessGrantsGetResponse = SetNonNullable<
  Required<RouteResponse<'/access_grants/get'>>
>

export type AccessGrantsGetRequest = SeamHttpRequest<
  AccessGrantsGetResponse,
  'access_grant'
>

export interface AccessGrantsGetOptions {}

export type AccessGrantsGetRelatedParameters =
  RouteRequestBody<'/access_grants/get_related'>

/**
 * @deprecated Use AccessGrantsGetRelatedParameters instead.
 */
export type AccessGrantsGetRelatedParams = AccessGrantsGetRelatedParameters

/**
 * @deprecated Use AccessGrantsGetRelatedRequest instead.
 */
export type AccessGrantsGetRelatedResponse = SetNonNullable<
  Required<RouteResponse<'/access_grants/get_related'>>
>

export type AccessGrantsGetRelatedRequest = SeamHttpRequest<
  AccessGrantsGetRelatedResponse,
  'batch'
>

export interface AccessGrantsGetRelatedOptions {}

export type AccessGrantsListParameters = RouteRequestBody<'/access_grants/list'>

/**
 * @deprecated Use AccessGrantsListParameters instead.
 */
export type AccessGrantsListParams = AccessGrantsListParameters

/**
 * @deprecated Use AccessGrantsListRequest instead.
 */
export type AccessGrantsListResponse = SetNonNullable<
  Required<RouteResponse<'/access_grants/list'>>
>

export type AccessGrantsListRequest = SeamHttpRequest<
  AccessGrantsListResponse,
  'access_grants'
>

export interface AccessGrantsListOptions {}

export type AccessGrantsRequestAccessMethodsParameters =
  RouteRequestBody<'/access_grants/request_access_methods'>

/**
 * @deprecated Use AccessGrantsRequestAccessMethodsParameters instead.
 */
export type AccessGrantsRequestAccessMethodsBody =
  AccessGrantsRequestAccessMethodsParameters

/**
 * @deprecated Use AccessGrantsRequestAccessMethodsRequest instead.
 */
export type AccessGrantsRequestAccessMethodsResponse = SetNonNullable<
  Required<RouteResponse<'/access_grants/request_access_methods'>>
>

export type AccessGrantsRequestAccessMethodsRequest = SeamHttpRequest<
  AccessGrantsRequestAccessMethodsResponse,
  'access_grant'
>

export interface AccessGrantsRequestAccessMethodsOptions {}

export type AccessGrantsUpdateParameters =
  RouteRequestBody<'/access_grants/update'>

/**
 * @deprecated Use AccessGrantsUpdateParameters instead.
 */
export type AccessGrantsUpdateBody = AccessGrantsUpdateParameters

/**
 * @deprecated Use AccessGrantsUpdateRequest instead.
 */
export type AccessGrantsUpdateResponse = SetNonNullable<
  Required<RouteResponse<'/access_grants/update'>>
>

export type AccessGrantsUpdateRequest = SeamHttpRequest<void, undefined>

export interface AccessGrantsUpdateOptions {}