Class SeamHttpAccessGrants

constructor

• new SeamHttpAccessGrants(apiKeyOrOptions?): SeamHttpAccessGrants

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpAccessGrants

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(parameters?, options?): AccessGrantsCreateRequest

• Parameters

  • Optionalparameters: AccessGrantsCreateParameters
  • options: AccessGrantsCreateOptions = {}

  Returns AccessGrantsCreateRequest

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?): AccessGrantsDeleteRequest

• Parameters

  • Optionalparameters: {
        access_grant_id: string;
    }

    • access_grant_id: string

      ID of Access Grant to delete.
  • options: AccessGrantsDeleteOptions = {}

  Returns AccessGrantsDeleteRequest

get

• get(parameters?, options?): AccessGrantsGetRequest

• Parameters

  • Optionalparameters: AccessGrantsGetParameters
  • options: AccessGrantsGetOptions = {}

  Returns AccessGrantsGetRequest

getRelated

• getRelated(parameters?, options?): AccessGrantsGetRelatedRequest

• Parameters

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

    • access_grant_ids: string[]

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

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

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

  • options: AccessGrantsGetRelatedOptions = {}

  Returns AccessGrantsGetRelatedRequest

list

• list(parameters?, options?): AccessGrantsListRequest

• Parameters

  • Optionalparameters: {
        access_grant_key?: string;
        acs_entrance_id?: string;
        acs_system_id?: string;
        customer_key?: string;
        location_id?: string;
        space_id?: string;
        user_identity_id?: string;
    }

    • Optionalaccess_grant_key?: string

      Filter Access Grants by 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.

    • Optionallocation_id?: string

      Deprecated

      Use space_id.

    • 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

update

• update(parameters?, options?): AccessGrantsUpdateRequest

• Parameters

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

    • access_grant_id: string

      ID of the Access Grant to update.

    • Optionalends_at?: null | string

      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?: null | string

      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): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpAccessGrants

• Parameters

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

  Returns SeamHttpAccessGrants

StaticfromClient

• fromClient(client, options?): SeamHttpAccessGrants

• Parameters

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

  Returns SeamHttpAccessGrants

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpAccessGrants

• Parameters

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

  Returns SeamHttpAccessGrants

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpAccessGrants

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpAccessGrants

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpAccessGrants>