Class SeamHttpAccessMethods

constructor

• new SeamHttpAccessMethods(apiKeyOrOptions?): SeamHttpAccessMethods

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessMethods

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

createPaginator

• createPaginator<const TResponse, const TResponseKey>(request): SeamPaginator<TResponse, TResponseKey>

• Type Parameters

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

  Parameters

  • request: SeamHttpRequest<TResponse, TResponseKey>

  Returns SeamPaginator<TResponse, TResponseKey>

delete

• delete(parameters?, options?): AccessMethodsDeleteRequest

• Parameters

  • Optionalparameters: {
        access_method_id: string;
    }

    • access_method_id: string

      ID of access method to get.
  • options: AccessMethodsDeleteOptions = {}

  Returns AccessMethodsDeleteRequest

encode

• encode(parameters?, options?): AccessMethodsEncodeRequest

• Parameters

  • Optionalparameters: {
        access_method_id: string;
        acs_encoder_id: string;
    }

    • access_method_id: string

      ID of the access_method to encode onto a card.

    • acs_encoder_id: string

      ID of the acs_encoder to use to encode the access_method.
  • options: AccessMethodsEncodeOptions = {}

  Returns AccessMethodsEncodeRequest

get

• get(parameters?, options?): AccessMethodsGetRequest

• Parameters

  • Optionalparameters: {
        access_method_id: string;
    }

    • access_method_id: string

      ID of access method to get.
  • options: AccessMethodsGetOptions = {}

  Returns AccessMethodsGetRequest

getRelated

• getRelated(parameters?, options?): AccessMethodsGetRelatedRequest

• Parameters

  • Optionalparameters: {
        access_method_ids: string[];
        exclude?: ("acs_entrances" | "devices" | "spaces")[];
        include?: ("acs_entrances" | "devices" | "spaces")[];
    }

    • access_method_ids: string[]

      IDs of the access methods that you want to get along with their related resources.

    • Optionalexclude?: ("acs_entrances" | "devices" | "spaces")[]

    • Optionalinclude?: ("acs_entrances" | "devices" | "spaces")[]

  • options: AccessMethodsGetRelatedOptions = {}

  Returns AccessMethodsGetRelatedRequest

list

• list(parameters?, options?): AccessMethodsListRequest

• Parameters

  • Optionalparameters: {
        access_grant_id: string;
        acs_entrance_id?: string;
        device_id?: string;
        space_id?: string;
    }

    • access_grant_id: string

      ID of Access Grant to list access methods for.

    • Optionalacs_entrance_id?: string

      ID of the entrance for which you want to retrieve all access methods.

    • Optionaldevice_id?: string

      ID of the device for which you want to retrieve all access methods.

    • Optionalspace_id?: string

      ID of the space for which you want to retrieve all access methods.
  • options: AccessMethodsListOptions = {}

  Returns AccessMethodsListRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpAccessMethods

• Parameters

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

  Returns SeamHttpAccessMethods

StaticfromClient

• fromClient(client, options?): SeamHttpAccessMethods

• Parameters

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

  Returns SeamHttpAccessMethods

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAccessMethods

• Parameters

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

  Returns SeamHttpAccessMethods

StaticfromConsoleSessionToken

• fromConsoleSessionToken(consoleSessionToken, workspaceId, options?): SeamHttpAccessMethods

• Parameters

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

  Returns SeamHttpAccessMethods

StaticfromPersonalAccessToken

• fromPersonalAccessToken(personalAccessToken, workspaceId, options?): SeamHttpAccessMethods

• Parameters

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

  Returns SeamHttpAccessMethods

StaticfromPublishableKey

• fromPublishableKey(publishableKey, userIdentifierKey, options?): Promise<SeamHttpAccessMethods>

• Parameters

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

  Returns Promise<SeamHttpAccessMethods>