Class SeamHttpAcsEncoders

constructor

• new SeamHttpAcsEncoders(
      apiKeyOrOptions?: string | SeamHttpOptions,
  ): SeamHttpAcsEncoders

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsEncoders

client

Readonlydefaults

simulate

• get simulate(): SeamHttpAcsEncodersSimulate

  Client for the Seam API /acs/encoders/simulate routes.

  Returns SeamHttpAcsEncodersSimulate

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  Type Parameters

  • const TResponse
  • const TResponseKey extends string | number | symbol

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

encodeCredential

• encodeCredential(
      parameters: AcsEncodersEncodeCredentialParameters,
      options?: AcsEncodersEncodeCredentialOptions,
  ): AcsEncodersEncodeCredentialRequest

  Encodes an existing credential onto a plastic card placed on the specified encoder. Either provide an acs_credential_id or an access_method_id

  Parameters

  • parameters: AcsEncodersEncodeCredentialParameters
  • options: AcsEncodersEncodeCredentialOptions = {}

  Returns AcsEncodersEncodeCredentialRequest

get

• get(
      parameters: AcsEncodersGetParameters,
      options?: AcsEncodersGetOptions,
  ): AcsEncodersGetRequest

  Returns a specified encoder.

  Parameters

  • parameters: AcsEncodersGetParameters
  • options: AcsEncodersGetOptions = {}

  Returns AcsEncodersGetRequest

list

• list(
      parameters?: AcsEncodersListParameters,
      options?: AcsEncodersListOptions,
  ): AcsEncodersListRequest

  Returns a list of all encoders.

  Parameters

  • Optionalparameters: AcsEncodersListParameters
  • options: AcsEncodersListOptions = {}

  Returns AcsEncodersListRequest

scanCredential

• scanCredential(
      parameters: AcsEncodersScanCredentialParameters,
      options?: AcsEncodersScanCredentialOptions,
  ): AcsEncodersScanCredentialRequest

  Scans an encoded acs_credential from a plastic card placed on the specified encoder.

  Parameters

  • parameters: AcsEncodersScanCredentialParameters
  • options: AcsEncodersScanCredentialOptions = {}

  Returns AcsEncodersScanCredentialRequest

scanToAssignCredential

• scanToAssignCredential(
      parameters: AcsEncodersScanToAssignCredentialParameters,
      options?: AcsEncodersScanToAssignCredentialOptions,
  ): AcsEncodersScanToAssignCredentialRequest

  Scans a physical card placed on the specified encoder and assigns the scanned credential to an ACS user. Provide either an acs_user_id or a user_identity_id.

  Parameters

  • parameters: AcsEncodersScanToAssignCredentialParameters
  • options: AcsEncodersScanToAssignCredentialOptions = {}

  Returns AcsEncodersScanToAssignCredentialRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken: string): Promise<void>

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

• fromApiKey(
      apiKey: string,
      options?: Omit<SeamHttpOptionsWithApiKey, "apiKey">,
  ): SeamHttpAcsEncoders

  Creates a new SeamHttpAcsEncoders authenticated with an API key.

  Parameters

  • apiKey: string
  • options: Omit<SeamHttpOptionsWithApiKey, "apiKey"> = {}

  Returns SeamHttpAcsEncoders

StaticfromClient

• fromClient(
      client: AxiosInstance,
      options?: Omit<SeamHttpOptionsWithClient, "client">,
  ): SeamHttpAcsEncoders

  Creates a new SeamHttpAcsEncoders from an existing HTTP client.

  Parameters

  • client: AxiosInstance
  • options: Omit<SeamHttpOptionsWithClient, "client"> = {}

  Returns SeamHttpAcsEncoders

StaticfromClientSessionToken

• fromClientSessionToken(
      clientSessionToken: string,
      options?: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken">,
  ): SeamHttpAcsEncoders

  Creates a new SeamHttpAcsEncoders authenticated with a client session token.

  Parameters

  • clientSessionToken: string
  • options: Omit<SeamHttpOptionsWithClientSessionToken, "clientSessionToken"> = {}

  Returns SeamHttpAcsEncoders

StaticfromConsoleSessionToken

• fromConsoleSessionToken(
      consoleSessionToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithConsoleSessionToken,
          "consoleSessionToken"
          | "workspaceId",
      >,
  ): SeamHttpAcsEncoders

  Creates a new SeamHttpAcsEncoders authenticated with a console session token and scoped to a workspace.

  Parameters

  • consoleSessionToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithConsoleSessionToken,
        "consoleSessionToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpAcsEncoders

StaticfromPersonalAccessToken

• fromPersonalAccessToken(
      personalAccessToken: string,
      workspaceId: string,
      options?: Omit<
          SeamHttpOptionsWithPersonalAccessToken,
          "personalAccessToken"
          | "workspaceId",
      >,
  ): SeamHttpAcsEncoders

  Creates a new SeamHttpAcsEncoders authenticated with a personal access token and scoped to a workspace.

  Parameters

  • personalAccessToken: string
  • workspaceId: string
  • options: Omit<
        SeamHttpOptionsWithPersonalAccessToken,
        "personalAccessToken"
        | "workspaceId",
    > = {}

  Returns SeamHttpAcsEncoders

StaticfromPublishableKey

• fromPublishableKey(
      publishableKey: string,
      userIdentifierKey: string,
      options?: SeamHttpFromPublishableKeyOptions,
  ): Promise<SeamHttpAcsEncoders>

  Creates a new SeamHttpAcsEncoders authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

  • publishableKey: string
  • userIdentifierKey: string
  • options: SeamHttpFromPublishableKeyOptions = {}

  Returns Promise<SeamHttpAcsEncoders>