Class SeamHttpAcsCredentials

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAcsCredentials

client

Readonlydefaults

assign

• assign(
      parameters: AcsCredentialsAssignParameters,
      options?: AcsCredentialsAssignOptions,
  ): AcsCredentialsAssignRequest

  Assigns a specified credential to a specified access system user.

  Parameters

  • parameters: AcsCredentialsAssignParameters
  • options: AcsCredentialsAssignOptions = {}

  Returns AcsCredentialsAssignRequest

create

• create(
      parameters: AcsCredentialsCreateParameters,
      options?: AcsCredentialsCreateOptions,
  ): AcsCredentialsCreateRequest

  Creates a new credential for a specified ACS user. For granting access, we recommend Access Grants instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.

  Parameters

  • parameters: AcsCredentialsCreateParameters
  • options: AcsCredentialsCreateOptions = {}

  Returns AcsCredentialsCreateRequest

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>

delete

• delete(
      parameters: AcsCredentialsDeleteParameters,
      options?: AcsCredentialsDeleteOptions,
  ): AcsCredentialsDeleteRequest

  Deletes a specified credential.

  Parameters

  • parameters: AcsCredentialsDeleteParameters
  • options: AcsCredentialsDeleteOptions = {}

  Returns AcsCredentialsDeleteRequest

get

• get(
      parameters: AcsCredentialsGetParameters,
      options?: AcsCredentialsGetOptions,
  ): AcsCredentialsGetRequest

  Returns a specified credential.

  Parameters

  • parameters: AcsCredentialsGetParameters
  • options: AcsCredentialsGetOptions = {}

  Returns AcsCredentialsGetRequest

list

• list(
      parameters?: AcsCredentialsListParameters,
      options?: AcsCredentialsListOptions,
  ): AcsCredentialsListRequest

  Returns a list of all credentials.

  Parameters

  • Optionalparameters: AcsCredentialsListParameters
  • options: AcsCredentialsListOptions = {}

  Returns AcsCredentialsListRequest

listAccessibleEntrances

• listAccessibleEntrances(
      parameters: AcsCredentialsListAccessibleEntrancesParameters,
      options?: AcsCredentialsListAccessibleEntrancesOptions,
  ): AcsCredentialsListAccessibleEntrancesRequest

  Returns a list of all entrances to which a credential grants access.

  Parameters

  • parameters: AcsCredentialsListAccessibleEntrancesParameters
  • options: AcsCredentialsListAccessibleEntrancesOptions = {}

  Returns AcsCredentialsListAccessibleEntrancesRequest

unassign

• unassign(
      parameters: AcsCredentialsUnassignParameters,
      options?: AcsCredentialsUnassignOptions,
  ): AcsCredentialsUnassignRequest

  Unassigns a specified credential from a specified access system user.

  Parameters

  • parameters: AcsCredentialsUnassignParameters
  • options: AcsCredentialsUnassignOptions = {}

  Returns AcsCredentialsUnassignRequest

update

• update(
      parameters: AcsCredentialsUpdateParameters,
      options?: AcsCredentialsUpdateOptions,
  ): AcsCredentialsUpdateRequest

  Updates the code and ends at date and time for a specified credential.

  Parameters

  • parameters: AcsCredentialsUpdateParameters
  • options: AcsCredentialsUpdateOptions = {}

  Returns AcsCredentialsUpdateRequest

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">,
  ): SeamHttpAcsCredentials

  Creates a new SeamHttpAcsCredentials authenticated with an API key.

  Parameters

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

  Returns SeamHttpAcsCredentials

StaticfromClient

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

  Creates a new SeamHttpAcsCredentials from an existing HTTP client.

  Parameters

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

  Returns SeamHttpAcsCredentials

StaticfromClientSessionToken

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

  Creates a new SeamHttpAcsCredentials authenticated with a client session token.

  Parameters

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

  Returns SeamHttpAcsCredentials

StaticfromConsoleSessionToken

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

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

  Parameters

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

  Returns SeamHttpAcsCredentials

StaticfromPersonalAccessToken

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

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

  Parameters

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

  Returns SeamHttpAcsCredentials

StaticfromPublishableKey

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

  Creates a new SeamHttpAcsCredentials 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<SeamHttpAcsCredentials>