Class SeamHttpConnectWebviews

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpConnectWebviews

client

Readonlydefaults

create

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

  Creates a new Connect Webview.

  To enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a connect_webview. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.

  You should make a new connect_webview for each unique login request. Each connect_webview tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.

  See also: Connect Webview Process.

  Parameters

  • Optionalparameters: ConnectWebviewsCreateParameters
  • options: ConnectWebviewsCreateOptions = {}

  Returns ConnectWebviewsCreateRequest

createPaginator

• createPaginator<
      const TResponse,
      const TResponseKey extends string | number | symbol,
  >(
      request: SeamHttpRequest<TResponse, TResponseKey>,
  ): SeamPaginator<TResponse, TResponseKey>

  Creates a new SeamPaginator to iterate over the paginated results of the request.

  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

  Deletes a Connect Webview.

  You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.

  Parameters

  • parameters: ConnectWebviewsDeleteParameters
  • options: ConnectWebviewsDeleteOptions = {}

  Returns ConnectWebviewsDeleteRequest

get

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

  Returns a specified Connect Webview.

  Unless you're using a custom_redirect_url, you should poll a newly-created connect_webview to find out if the user has signed in or to get details about what devices they've connected.

  Parameters

  • parameters: ConnectWebviewsGetParameters
  • options: ConnectWebviewsGetOptions = {}

  Returns ConnectWebviewsGetRequest

list

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

  Returns a list of all Connect Webviews.

  Parameters

  • Optionalparameters: ConnectWebviewsListParameters
  • options: ConnectWebviewsListOptions = {}

  Returns ConnectWebviewsListRequest

updateClientSessionToken

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

  Updates the client session token used by this client for authentication.

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

  Throws

  If this client was not created with a client session token.

StaticfromApiKey

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

  Creates a new SeamHttpConnectWebviews authenticated with an API key.

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromClient

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

  Creates a new SeamHttpConnectWebviews from an existing HTTP client.

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromClientSessionToken

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

  Creates a new SeamHttpConnectWebviews authenticated with a client session token.

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromConsoleSessionToken

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

  Creates a new SeamHttpConnectWebviews authenticated with a console session token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromPersonalAccessToken

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

  Creates a new SeamHttpConnectWebviews authenticated with a personal access token and scoped to a workspace.

  Parameters

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

  Returns SeamHttpConnectWebviews

StaticfromPublishableKey

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

  Creates a new SeamHttpConnectWebviews authenticated with a client session token for the user identified by the user identifier key. The client session is created with the publishable key if it does not exist.

  Parameters

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

  Returns Promise<SeamHttpConnectWebviews>