Class SeamHttpInstantKeys

constructor

• new SeamHttpInstantKeys(apiKeyOrOptions?): SeamHttpInstantKeys

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpInstantKeys

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

• Parameters

  • Optionalparameters: {
        instant_key_id: string;
    }

    • instant_key_id: string

      ID of the Instant Key that you want to delete.
  • options: InstantKeysDeleteOptions = {}

  Returns InstantKeysDeleteRequest

get

• get(parameters?, options?): InstantKeysGetRequest

• Parameters

  • Optionalparameters: {
        instant_key_id?: string;
        instant_key_url?: string;
    }

    • Optionalinstant_key_id?: string

      ID of the instant key to get.

    • Optionalinstant_key_url?: string

      URL of the instant key to get.
  • options: InstantKeysGetOptions = {}

  Returns InstantKeysGetRequest

list

• list(parameters?, options?): InstantKeysListRequest

• Parameters

  • Optionalparameters: {
        user_identity_id?: string;
    }

    • Optionaluser_identity_id?: string

      ID of the user identity by which you want to filter the list of Instant Keys.
  • options: InstantKeysListOptions = {}

  Returns InstantKeysListRequest

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpInstantKeys

• Parameters

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

  Returns SeamHttpInstantKeys

StaticfromClient

• fromClient(client, options?): SeamHttpInstantKeys

• Parameters

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

  Returns SeamHttpInstantKeys

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpInstantKeys

• Parameters

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

  Returns SeamHttpInstantKeys

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpInstantKeys

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpInstantKeys

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpInstantKeys>