Class SeamHttpAccessGrants

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessGrants

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

unmanaged

• get unmanaged(): SeamHttpAccessGrantsUnmanaged

  Returns SeamHttpAccessGrantsUnmanaged

create

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

  Parameters

  • parameters: AccessGrantsCreateParameters
  • options: AccessGrantsCreateOptions = {}

  Returns AccessGrantsCreateRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): 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: { access_grant_id: string },
      options?: AccessGrantsDeleteOptions,
  ): AccessGrantsDeleteRequest

  Parameters

  • parameters: { access_grant_id: string }

    • access_grant_id: string

      ID of Access Grant to delete.

  • options: AccessGrantsDeleteOptions = {}

  Returns AccessGrantsDeleteRequest

get

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

  Parameters

  • Optionalparameters: AccessGrantsGetParameters
  • options: AccessGrantsGetOptions = {}

  Returns AccessGrantsGetRequest

getRelated

• getRelated(
      parameters?: {
          access_grant_ids?: string[];
          access_grant_keys?: string[];
          exclude?: (
              | "access_methods"
              | "acs_access_groups"
              | "acs_entrances"
              | "acs_systems"
              | "connected_accounts"
              | "devices"
              | "spaces"
              | "user_identities"
          )[];
          include?: (
              | "access_methods"
              | "acs_access_groups"
              | "acs_entrances"
              | "acs_systems"
              | "connected_accounts"
              | "devices"
              | "spaces"
              | "user_identities"
          )[];
      },
      options?: AccessGrantsGetRelatedOptions,
  ): AccessGrantsGetRelatedRequest

  Parameters

  • Optionalparameters: {
        access_grant_ids?: string[];
        access_grant_keys?: string[];
        exclude?: (
            | "access_methods"
            | "acs_access_groups"
            | "acs_entrances"
            | "acs_systems"
            | "connected_accounts"
            | "devices"
            | "spaces"
            | "user_identities"
        )[];
        include?: (
            | "access_methods"
            | "acs_access_groups"
            | "acs_entrances"
            | "acs_systems"
            | "connected_accounts"
            | "devices"
            | "spaces"
            | "user_identities"
        )[];
    }

    • Optionalaccess_grant_ids?: string[]

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

    • Optionalaccess_grant_keys?: string[]

      Keys of the access grants that you want to get along with their related resources.

    • Optionalexclude?: (
          | "access_methods"
          | "acs_access_groups"
          | "acs_entrances"
          | "acs_systems"
          | "connected_accounts"
          | "devices"
          | "spaces"
          | "user_identities"
      )[]

    • Optionalinclude?: (
          | "access_methods"
          | "acs_access_groups"
          | "acs_entrances"
          | "acs_systems"
          | "connected_accounts"
          | "devices"
          | "spaces"
          | "user_identities"
      )[]

  • options: AccessGrantsGetRelatedOptions = {}

  Returns AccessGrantsGetRelatedRequest

list

• list(
      parameters?: {
          access_code_id?: string;
          access_grant_ids?: string[];
          access_grant_key?: string | null;
          acs_entrance_id?: string;
          acs_system_id?: string;
          customer_key?: string;
          device_id?: string;
          limit?: number;
          location_id?: string;
          page_cursor?: string | null;
          reservation_key?: string;
          space_id?: string;
          user_identity_id?: string;
      },
      options?: AccessGrantsListOptions,
  ): AccessGrantsListRequest

  Parameters

  • Optionalparameters: {
        access_code_id?: string;
        access_grant_ids?: string[];
        access_grant_key?: string | null;
        acs_entrance_id?: string;
        acs_system_id?: string;
        customer_key?: string;
        device_id?: string;
        limit?: number;
        location_id?: string;
        page_cursor?: string | null;
        reservation_key?: string;
        space_id?: string;
        user_identity_id?: string;
    }

    • Optionalaccess_code_id?: string

      ID of the access code by which you want to filter the list of Access Grants.

    • Optionalaccess_grant_ids?: string[]

      IDs of the access grants to retrieve.

    • Optionalaccess_grant_key?: string | null

      Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key.

    • Optionalacs_entrance_id?: string

      ID of the entrance by which you want to filter the list of Access Grants.

    • Optionalacs_system_id?: string

      ID of the access system by which you want to filter the list of Access Grants.

    • Optionalcustomer_key?: string

      Customer key for which you want to list access grants.

    • Optionaldevice_id?: string

      ID of the device by which you want to filter the list of Access Grants.

    • Optionallimit?: number

      Numerical limit on the number of access grants to return.

    • Optionallocation_id?: string

      Deprecated

      Use space_id.

    • Optionalpage_cursor?: string | null

      Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

    • Optionalreservation_key?: string

      Filter Access Grants by reservation_key.

    • Optionalspace_id?: string

      ID of the space by which you want to filter the list of Access Grants.

    • Optionaluser_identity_id?: string

      ID of user identity by which you want to filter the list of Access Grants.

  • options: AccessGrantsListOptions = {}

  Returns AccessGrantsListRequest

requestAccessMethods

• requestAccessMethods(
      parameters: {
          access_grant_id: string;
          requested_access_methods: {
              code?: string;
              instant_key_max_use_count?: number;
              mode: "code" | "card" | "mobile_key" | "cloud_key";
          }[];
      },
      options?: AccessGrantsRequestAccessMethodsOptions,
  ): AccessGrantsRequestAccessMethodsRequest

  Parameters

  • parameters: {
        access_grant_id: string;
        requested_access_methods: {
            code?: string;
            instant_key_max_use_count?: number;
            mode: "code" | "card" | "mobile_key" | "cloud_key";
        }[];
    }

    • access_grant_id: string

      ID of the Access Grant to add access methods to.

    • requested_access_methods: {
          code?: string;
          instant_key_max_use_count?: number;
          mode: "code" | "card" | "mobile_key" | "cloud_key";
      }[]

      Array of requested access methods to add to the access grant.

  • options: AccessGrantsRequestAccessMethodsOptions = {}

  Returns AccessGrantsRequestAccessMethodsRequest

update

• update(
      parameters?: {
          access_grant_id?: string;
          access_grant_key?: string;
          ends_at?: string | null;
          name?: string | null;
          starts_at?: string;
      },
      options?: AccessGrantsUpdateOptions,
  ): AccessGrantsUpdateRequest

  Parameters

  • Optionalparameters: {
        access_grant_id?: string;
        access_grant_key?: string;
        ends_at?: string | null;
        name?: string | null;
        starts_at?: string;
    }

    • Optionalaccess_grant_id?: string

      ID of the Access Grant to update. Provide either access_grant_id or access_grant_key.

    • Optionalaccess_grant_key?: string

      Key of the Access Grant to update. Provide either access_grant_id or access_grant_key.

    • Optionalends_at?: string | null

      Date and time at which the validity of the grant ends, in ISO 8601 format. Must be a time in the future and after starts_at.

    • Optionalname?: string | null

      Display name for the access grant.

    • Optionalstarts_at?: string

      Date and time at which the validity of the grant starts, in ISO 8601 format.

  • options: AccessGrantsUpdateOptions = {}

  Returns AccessGrantsUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpAccessGrants

StaticfromClient

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

  Parameters

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

  Returns SeamHttpAccessGrants

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpAccessGrants

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpAccessGrants

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpAccessGrants

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpAccessGrants>