import { type Client } from '../../../../../seam/connect/client.js'; import { type SeamHttpFromPublishableKeyOptions, type SeamHttpOptions, type SeamHttpOptionsWithApiKey, type SeamHttpOptionsWithClient, type SeamHttpOptionsWithClientSessionToken, type SeamHttpOptionsWithConsoleSessionToken, type SeamHttpOptionsWithPersonalAccessToken, type SeamHttpRequestOptions } from '../../../../../seam/connect/options.js'; import type { AcsEncoder } from '../../../../../seam/connect/resources/acs-encoder.js'; import type { ActionAttempt } from '../../../../../seam/connect/resources/action-attempt.js'; import { SeamHttpRequest } from '../../../../../seam/connect/seam-http-request.js'; import { SeamPaginator } from '../../../../../seam/connect/seam-paginator.js'; import { SeamHttpAcsEncodersSimulate } from './simulate/index.js'; export declare class SeamHttpAcsEncoders { client: Client; readonly defaults: Required; readonly ltsVersion = "1.0.0"; static ltsVersion: string; constructor(apiKeyOrOptions?: string | SeamHttpOptions); static fromClient(client: SeamHttpOptionsWithClient['client'], options?: Omit): SeamHttpAcsEncoders; static fromApiKey(apiKey: SeamHttpOptionsWithApiKey['apiKey'], options?: Omit): SeamHttpAcsEncoders; static fromClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken'], options?: Omit): SeamHttpAcsEncoders; static fromPublishableKey(publishableKey: string, userIdentifierKey: string, options?: SeamHttpFromPublishableKeyOptions): Promise; static fromConsoleSessionToken(consoleSessionToken: SeamHttpOptionsWithConsoleSessionToken['consoleSessionToken'], workspaceId: SeamHttpOptionsWithConsoleSessionToken['workspaceId'], options?: Omit): SeamHttpAcsEncoders; static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit): SeamHttpAcsEncoders; createPaginator(request: SeamHttpRequest): SeamPaginator; updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise; get simulate(): SeamHttpAcsEncodersSimulate; /** * 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; /** * 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; /** * 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; /** * 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; /** * 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; } 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; export type AcsEncodersEncodeCredentialOptions = Pick; 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; 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; 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; export type AcsEncodersScanCredentialOptions = Pick; 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; export type AcsEncodersScanToAssignCredentialOptions = Pick;