/* * 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 { AcsCredential } from 'lib/seam/connect/resources/acs-credential.js' import type { AcsEntrance } from 'lib/seam/connect/resources/acs-entrance.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' export class SeamHttpAcsEntrances { 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 = {}, ): SeamHttpAcsEntrances { const constructorOptions = { ...options, client } if (!isSeamHttpOptionsWithClient(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing client') } return new SeamHttpAcsEntrances(constructorOptions) } static fromApiKey( apiKey: SeamHttpOptionsWithApiKey['apiKey'], options: Omit = {}, ): SeamHttpAcsEntrances { const constructorOptions = { ...options, apiKey } if (!isSeamHttpOptionsWithApiKey(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing apiKey') } return new SeamHttpAcsEntrances(constructorOptions) } static fromClientSessionToken( clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], options: Omit< SeamHttpOptionsWithClientSessionToken, 'clientSessionToken' > = {}, ): SeamHttpAcsEntrances { const constructorOptions = { ...options, clientSessionToken } if (!isSeamHttpOptionsWithClientSessionToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError('Missing clientSessionToken') } return new SeamHttpAcsEntrances(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 SeamHttpAcsEntrances.fromPublishableKey', ) } const client = createClient(clientOptions) const clientSessions = SeamHttpClientSessions.fromClient(client) const { token } = await clientSessions.getOrCreate({ user_identifier_key: userIdentifierKey, }) return SeamHttpAcsEntrances.fromClientSessionToken(token, options) } static fromConsoleSessionToken( consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'], workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'], options: Omit< SeamHttpOptionsWithConsoleSessionToken, 'consoleSessionToken' | 'workspaceId' > = {}, ): SeamHttpAcsEntrances { const constructorOptions = { ...options, consoleSessionToken, workspaceId } if (!isSeamHttpOptionsWithConsoleSessionToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError( 'Missing consoleSessionToken or workspaceId', ) } return new SeamHttpAcsEntrances(constructorOptions) } static fromPersonalAccessToken( personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options: Omit< SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId' > = {}, ): SeamHttpAcsEntrances { const constructorOptions = { ...options, personalAccessToken, workspaceId } if (!isSeamHttpOptionsWithPersonalAccessToken(constructorOptions)) { throw new SeamHttpInvalidOptionsError( 'Missing personalAccessToken or workspaceId', ) } return new SeamHttpAcsEntrances(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() } /** * Returns a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */ get( parameters: AcsEntrancesGetParameters, options: AcsEntrancesGetOptions = {}, ): AcsEntrancesGetRequest { return new SeamHttpRequest(this, { pathname: '/acs/entrances/get', method: 'POST', body: parameters, responseKey: 'acs_entrance', options, }) } /** * Grants a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */ grantAccess( parameters: AcsEntrancesGrantAccessParameters, options: AcsEntrancesGrantAccessOptions = {}, ): AcsEntrancesGrantAccessRequest { return new SeamHttpRequest(this, { pathname: '/acs/entrances/grant_access', method: 'POST', body: parameters, responseKey: undefined, options, }) } /** * Returns a list of all [access system entrances](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */ list( parameters?: AcsEntrancesListParameters, options: AcsEntrancesListOptions = {}, ): AcsEntrancesListRequest { return new SeamHttpRequest(this, { pathname: '/acs/entrances/list', method: 'POST', body: parameters, responseKey: 'acs_entrances', options, }) } /** * Returns a list of all [credentials](https://docs.seam.co/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */ listCredentialsWithAccess( parameters: AcsEntrancesListCredentialsWithAccessParameters, options: AcsEntrancesListCredentialsWithAccessOptions = {}, ): AcsEntrancesListCredentialsWithAccessRequest { return new SeamHttpRequest(this, { pathname: '/acs/entrances/list_credentials_with_access', method: 'POST', body: parameters, responseKey: 'acs_credentials', options, }) } /** * Remotely unlocks a specified [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation. */ unlock( parameters: AcsEntrancesUnlockParameters, options: AcsEntrancesUnlockOptions = {}, ): AcsEntrancesUnlockRequest { return new SeamHttpRequest(this, { pathname: '/acs/entrances/unlock', method: 'POST', body: parameters, responseKey: 'action_attempt', options, }) } } export type AcsEntrancesGetParameters = { /** * ID of the entrance that you want to get. */ acs_entrance_id: string } /** * @deprecated Use AcsEntrancesGetRequest instead. */ export type AcsEntrancesGetResponse = { acs_entrance: AcsEntrance } export type AcsEntrancesGetRequest = SeamHttpRequest< AcsEntrancesGetResponse, 'acs_entrance' > export interface AcsEntrancesGetOptions {} export type AcsEntrancesGrantAccessParameters = { /** * ID of the entrance to which you want to grant an access system user access. */ acs_entrance_id: string /** * ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. */ acs_user_id?: string | undefined /** * ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */ user_identity_id?: string | undefined } /** * @deprecated Use AcsEntrancesGrantAccessRequest instead. */ export type AcsEntrancesGrantAccessResponse = void export type AcsEntrancesGrantAccessRequest = SeamHttpRequest export interface AcsEntrancesGrantAccessOptions {} export type AcsEntrancesListParameters = { /** * ID of the access method for which you want to retrieve all entrances to which it grants access. */ access_method_id?: string | undefined /** * ID of the credential for which you want to retrieve all entrances. */ acs_credential_id?: string | undefined /** * IDs of the entrances for which you want to retrieve all entrances. */ acs_entrance_ids?: Array | undefined /** * ID of the access system for which you want to retrieve all entrances. */ acs_system_id?: string | undefined /** * ID of the connected account for which you want to retrieve all entrances. */ connected_account_id?: string | undefined /** * Customer key for which you want to list entrances. */ customer_key?: string | undefined /** * Maximum number of records to return per page. */ limit?: number | undefined /** * @deprecated Use `space_id`. */ location_id?: string | undefined /** * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */ page_cursor?: string | undefined /** * String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`. */ search?: string | undefined /** * ID of the space for which you want to list entrances. */ space_id?: string | undefined } /** * @deprecated Use AcsEntrancesListRequest instead. */ export type AcsEntrancesListResponse = { acs_entrances: Array } export type AcsEntrancesListRequest = SeamHttpRequest< AcsEntrancesListResponse, 'acs_entrances' > export interface AcsEntrancesListOptions {} export type AcsEntrancesListCredentialsWithAccessParameters = { /** * ID of the entrance for which you want to list all credentials that grant access. */ acs_entrance_id: string /** * Conditions that credentials must meet to be included in the returned list. */ include_if?: Array<'visionline_metadata.is_valid'> | undefined } /** * @deprecated Use AcsEntrancesListCredentialsWithAccessRequest instead. */ export type AcsEntrancesListCredentialsWithAccessResponse = { acs_credentials: Array } export type AcsEntrancesListCredentialsWithAccessRequest = SeamHttpRequest< AcsEntrancesListCredentialsWithAccessResponse, 'acs_credentials' > export interface AcsEntrancesListCredentialsWithAccessOptions {} export type AcsEntrancesUnlockParameters = { /** * ID of the cloud_key credential to use for the unlock operation. */ acs_credential_id: string /** * ID of the entrance to unlock. */ acs_entrance_id: string } /** * @deprecated Use AcsEntrancesUnlockRequest instead. */ export type AcsEntrancesUnlockResponse = { action_attempt: ActionAttempt } export type AcsEntrancesUnlockRequest = SeamHttpRequest< AcsEntrancesUnlockResponse, 'action_attempt' > export type AcsEntrancesUnlockOptions = Pick< SeamHttpRequestOptions, 'waitForActionAttempt' >