Class SeamHttpConnectWebviews

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpConnectWebviews

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(
      parameters?: ConnectWebviewsCreateParameters,
      options?: ConnectWebviewsCreateOptions,
  ): ConnectWebviewsCreateRequest

  Parameters

  • Optionalparameters: ConnectWebviewsCreateParameters
  • options: ConnectWebviewsCreateOptions = {}

  Returns ConnectWebviewsCreateRequest

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: ConnectWebviewsDeleteParameters,
      options?: ConnectWebviewsDeleteOptions,
  ): ConnectWebviewsDeleteRequest

  Parameters

  • parameters: ConnectWebviewsDeleteParameters
  • options: ConnectWebviewsDeleteOptions = {}

  Returns ConnectWebviewsDeleteRequest

get

• get(
      parameters: ConnectWebviewsGetParameters,
      options?: ConnectWebviewsGetOptions,
  ): ConnectWebviewsGetRequest

  Parameters

  • parameters: ConnectWebviewsGetParameters
  • options: ConnectWebviewsGetOptions = {}

  Returns ConnectWebviewsGetRequest

list

• list(
      parameters?: ConnectWebviewsListParameters,
      options?: ConnectWebviewsListOptions,
  ): ConnectWebviewsListRequest

  Parameters

  • Optionalparameters: ConnectWebviewsListParameters
  • options: ConnectWebviewsListOptions = {}

  Returns ConnectWebviewsListRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromClient

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

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpConnectWebviews>