/* * 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 { AcsEncoder } from 'lib/seam/connect/resources/acs-encoder.js' import type { ActionAttempt } from 'lib/seam/connect/resources/action-attempt.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 { SeamHttpAcsEncodersSimulate } from './simulate/index.js' export class SeamHttpAcsEncoders { client: Client readonly defaults: Required 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 = {}, ): SeamHttpAcsEncoders { const constructorOptions = { ...options, client } if (!isSeamHttpOptionsWithClient(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing client') } return new SeamHttpAcsEncoders(constructorOptions) } static fromApiKey( apiKey: SeamHttpOptionsWithApiKey['apiKey'], options: Omit = {}, ): SeamHttpAcsEncoders { const constructorOptions = { ...options, apiKey } if (!isSeamHttpOptionsWithApiKey(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing apiKey') } return new SeamHttpAcsEncoders(constructorOptions) } static fromClientSessionToken( clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], options: Omit< SeamHttpOptionsWithClientSessionToken, 'clientSessionToken' > = {}, ): SeamHttpAcsEncoders { const constructorOptions = { ...options, clientSessionToken } if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing clientSessionToken') } return new SeamHttpAcsEncoders(constructorOptions) } static async fromPublishableKey( publishableKey: string, userIdentifierKey: string, options: SeamHttpFromPublishableKeyOptions = {}, ): Promise { warnOnInsecureuserIdentifierKey(userIdentifierKey) const clientOptions = parseOptions({ ...options, publishableKey }) if (isSeamHttpOptionsWithClient(clientOptions)) { throw new SeamHttpInvalidOptionsError( 'The client option cannot be used with SeamHttpAcsEncoders.fromPublishableKey', ) } const client = createClient(clientOptions) const clientSessions = SeamHttpClientSessions.fromClient(client) const { token } = await clientSessions.getOrCreate({ user_identifier_key: userIdentifierKey, }) return SeamHttpAcsEncoders.fromClientSessionToken(token, options) } static fromConsoleSessionToken( consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'], workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'], options: Omit< SeamHttpOptionsWithConsoleSessionToken, 'consoleSessionToken' | 'workspaceId' > = {}, ): SeamHttpAcsEncoders { const constructorOptions = { ...options, consoleSessionToken, workspaceId } if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError( 'Missing consoleSessionToken or workspaceId', ) } return new SeamHttpAcsEncoders(constructorOptions) } static fromPersonalAccessToken( personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options: Omit< SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId' > = {}, ): SeamHttpAcsEncoders { const constructorOptions = { ...options, personalAccessToken, workspaceId } if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError( 'Missing personalAccessToken or workspaceId', ) } return new SeamHttpAcsEncoders(constructorOptions) } createPaginator( request: SeamHttpRequest, ): SeamPaginator { return new SeamPaginator(this, request) } async updateClientSessionToken( clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], ): Promise { 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 simulate(): SeamHttpAcsEncodersSimulate { return SeamHttpAcsEncodersSimulate.fromClient(this.client, this.defaults) } /** * Encodes an existing [credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id` */ encodeCredential( parameters: AcsEncodersEncodeCredentialParameters, options: AcsEncodersEncodeCredentialOptions = {}, ): AcsEncodersEncodeCredentialRequest { return new SeamHttpRequest(this, { pathname: '/acs/encoders/encode_credential', method: 'POST', body: parameters, responseKey: 'action_attempt', options, }) } /** * Returns a specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ get( parameters: AcsEncodersGetParameters, options: AcsEncodersGetOptions = {}, ): AcsEncodersGetRequest { return new SeamHttpRequest(this, { pathname: '/acs/encoders/get', method: 'POST', body: parameters, responseKey: 'acs_encoder', options, }) } /** * Returns a list of all [encoders](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ list( parameters?: AcsEncodersListParameters, options: AcsEncodersListOptions = {}, ): AcsEncodersListRequest { return new SeamHttpRequest(this, { pathname: '/acs/encoders/list', method: 'GET', params: parameters, responseKey: 'acs_encoders', options, }) } /** * Scans an encoded [acs_credential](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners). */ scanCredential( parameters: AcsEncodersScanCredentialParameters, options: AcsEncodersScanCredentialOptions = {}, ): AcsEncodersScanCredentialRequest { return new SeamHttpRequest(this, { pathname: '/acs/encoders/scan_credential', method: 'POST', body: parameters, responseKey: 'action_attempt', options, }) } /** * Scans a physical card placed on the specified [encoder](https://docs.seam.co/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`. */ scanToAssignCredential( parameters: AcsEncodersScanToAssignCredentialParameters, options: AcsEncodersScanToAssignCredentialOptions = {}, ): AcsEncodersScanToAssignCredentialRequest { return new SeamHttpRequest(this, { pathname: '/acs/encoders/scan_to_assign_credential', method: 'POST', body: parameters, responseKey: 'action_attempt', options, }) } } export type AcsEncodersEncodeCredentialParameters = { /** * ID of the `access_method` to encode onto a card. */ access_method_id?: string | undefined /** * ID of the `acs_credential` to encode onto a card. */ acs_credential_id?: string | undefined /** * ID of the `acs_encoder` to use to encode the `acs_credential`. */ acs_encoder_id: string } /** * @deprecated Use AcsEncodersEncodeCredentialRequest instead. */ export type AcsEncodersEncodeCredentialResponse = { action_attempt: ActionAttempt } export type AcsEncodersEncodeCredentialRequest = SeamHttpRequest< AcsEncodersEncodeCredentialResponse, 'action_attempt' > export type AcsEncodersEncodeCredentialOptions = Pick< SeamHttpRequestOptions, 'waitForActionAttempt' > export type AcsEncodersGetParameters = { /** * ID of the encoder that you want to get. */ acs_encoder_id: string } /** * @deprecated Use AcsEncodersGetRequest instead. */ export type AcsEncodersGetResponse = { acs_encoder: AcsEncoder } export type AcsEncodersGetRequest = SeamHttpRequest< AcsEncodersGetResponse, 'acs_encoder' > export interface AcsEncodersGetOptions {} export type AcsEncodersListParameters = { /** * ID of the access system for which you want to retrieve all encoders. */ acs_system_id?: string | undefined /** * IDs of the access systems for which you want to retrieve all encoders. */ acs_system_ids?: Array | undefined /** * IDs of the encoders that you want to retrieve. */ acs_encoder_ids?: Array | undefined /** * Number of encoders to return. */ limit?: number | undefined /** * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */ page_cursor?: string | undefined } /** * @deprecated Use AcsEncodersListRequest instead. */ export type AcsEncodersListResponse = { acs_encoders: Array } export type AcsEncodersListRequest = SeamHttpRequest< AcsEncodersListResponse, 'acs_encoders' > export interface AcsEncodersListOptions {} export type AcsEncodersScanCredentialParameters = { /** * ID of the encoder to use for the scan. */ acs_encoder_id: string /** * Salto KS-specific metadata for the scan action. */ salto_ks_metadata?: | { /** * When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false. */ detect_new_tags?: boolean | undefined } | undefined } /** * @deprecated Use AcsEncodersScanCredentialRequest instead. */ export type AcsEncodersScanCredentialResponse = { action_attempt: ActionAttempt } export type AcsEncodersScanCredentialRequest = SeamHttpRequest< AcsEncodersScanCredentialResponse, 'action_attempt' > export type AcsEncodersScanCredentialOptions = Pick< SeamHttpRequestOptions, 'waitForActionAttempt' > export type AcsEncodersScanToAssignCredentialParameters = { /** * ID of the `acs_encoder` to use to scan the credential. */ acs_encoder_id: string /** * ID of the `acs_user` to assign the scanned credential to. */ acs_user_id?: string | undefined /** * Salto KS-specific metadata for the scan action. */ salto_ks_metadata?: | { /** * When true, activates tag registration mode on the encoder to detect new, unregistered tags. When false, only detects existing tags already registered in the system. Defaults to false. */ detect_new_tags?: boolean | undefined } | undefined /** * ID of the `user_identity` to assign the scanned credential to. If the ACS system contains an ACS user linked to this user identity, it is used. Otherwise, one is created. */ user_identity_id?: string | undefined } /** * @deprecated Use AcsEncodersScanToAssignCredentialRequest instead. */ export type AcsEncodersScanToAssignCredentialResponse = { action_attempt: ActionAttempt } export type AcsEncodersScanToAssignCredentialRequest = SeamHttpRequest< AcsEncodersScanToAssignCredentialResponse, 'action_attempt' > export type AcsEncodersScanToAssignCredentialOptions = Pick< SeamHttpRequestOptions, 'waitForActionAttempt' >