Class SeamHttpAccessGrants

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessGrants

client

Readonlydefaults

unmanaged

• get unmanaged(): SeamHttpAccessGrantsUnmanaged

  Client for the Seam API /access_grants/unmanaged routes.

  Returns SeamHttpAccessGrantsUnmanaged

create

• create(
      parameters: AccessGrantsCreateParameters,
      options?: AccessGrantsCreateOptions,
  ): AccessGrantsCreateRequest

  Creates a new Access Grant. Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using device_ids) and access control systems (using acs_entrance_ids or space_ids), and can issue PIN codes, key cards, and mobile keys through a single request.

  Parameters

  • parameters: AccessGrantsCreateParameters
  • options: AccessGrantsCreateOptions = {}

  Returns AccessGrantsCreateRequest

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: AccessGrantsDeleteParameters,
      options?: AccessGrantsDeleteOptions,
  ): AccessGrantsDeleteRequest

  Delete an Access Grant.

  Parameters

  • parameters: AccessGrantsDeleteParameters
  • options: AccessGrantsDeleteOptions = {}

  Returns AccessGrantsDeleteRequest

get

• get(
      parameters?: AccessGrantsGetParameters,
      options?: AccessGrantsGetOptions,
  ): AccessGrantsGetRequest

  Get an Access Grant.

  Parameters

  • Optionalparameters: AccessGrantsGetParameters
  • options: AccessGrantsGetOptions = {}

  Returns AccessGrantsGetRequest

getRelated

• getRelated(
      parameters?: AccessGrantsGetRelatedParameters,
      options?: AccessGrantsGetRelatedOptions,
  ): AccessGrantsGetRelatedRequest

  Gets all related resources for one or more Access Grants.

  Parameters

  • Optionalparameters: AccessGrantsGetRelatedParameters
  • options: AccessGrantsGetRelatedOptions = {}

  Returns AccessGrantsGetRelatedRequest

list

• list(
      parameters?: AccessGrantsListParameters,
      options?: AccessGrantsListOptions,
  ): AccessGrantsListRequest

  Gets an Access Grant.

  Parameters

  • Optionalparameters: AccessGrantsListParameters
  • options: AccessGrantsListOptions = {}

  Returns AccessGrantsListRequest

requestAccessMethods

• requestAccessMethods(
      parameters: AccessGrantsRequestAccessMethodsParameters,
      options?: AccessGrantsRequestAccessMethodsOptions,
  ): AccessGrantsRequestAccessMethodsRequest

  Adds additional requested access methods to an existing Access Grant.

  Parameters

  • parameters: AccessGrantsRequestAccessMethodsParameters
  • options: AccessGrantsRequestAccessMethodsOptions = {}

  Returns AccessGrantsRequestAccessMethodsRequest

update

• update(
      parameters?: AccessGrantsUpdateParameters,
      options?: AccessGrantsUpdateOptions,
  ): AccessGrantsUpdateRequest

  Updates an existing Access Grant's time window.

  Parameters

  • Optionalparameters: AccessGrantsUpdateParameters
  • options: AccessGrantsUpdateOptions = {}

  Returns AccessGrantsUpdateRequest

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

  Creates a new SeamHttpAccessGrants authenticated with an API key.

  Parameters

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

  Returns SeamHttpAccessGrants

StaticfromClient

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

  Creates a new SeamHttpAccessGrants from an existing HTTP client.

  Parameters

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

  Returns SeamHttpAccessGrants

StaticfromClientSessionToken

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

  Creates a new SeamHttpAccessGrants authenticated with a client session token.

  Parameters

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

  Returns SeamHttpAccessGrants

StaticfromConsoleSessionToken

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

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

  Parameters

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

  Returns SeamHttpAccessGrants

StaticfromPersonalAccessToken

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

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

  Parameters

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

  Returns SeamHttpAccessGrants

StaticfromPublishableKey

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

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