Class SeamHttpSeamConsoleV1Sites

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpSeamConsoleV1Sites

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

create

• create(
      parameters: { name: string; site_key?: string },
      options?: SeamConsoleV1SitesCreateOptions,
  ): SeamConsoleV1SitesCreateRequest

  Parameters

  • parameters: { name: string; site_key?: string }

    • name: string

      Name of the site that you want to create.

    • Optionalsite_key?: string

      Unique key for the site within the workspace.

  • options: SeamConsoleV1SitesCreateOptions = {}

  Returns SeamConsoleV1SitesCreateRequest

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: { site_id: string },
      options?: SeamConsoleV1SitesDeleteOptions,
  ): SeamConsoleV1SitesDeleteRequest

  Parameters

  • parameters: { site_id: string }

    • site_id: string

      ID of the site that you want to delete.

  • options: SeamConsoleV1SitesDeleteOptions = {}

  Returns SeamConsoleV1SitesDeleteRequest

list

• list(
      parameters?: { search?: string },
      options?: SeamConsoleV1SitesListOptions,
  ): SeamConsoleV1SitesListRequest

  Parameters

  • Optionalparameters: { search?: string }

    • Optionalsearch?: string

      String for which to search. Filters sites to those with a partial match on name or site_key.

  • options: SeamConsoleV1SitesListOptions = {}

  Returns SeamConsoleV1SitesListRequest

update

• update(
      parameters: { name?: string; site_id: string; site_key?: string },
      options?: SeamConsoleV1SitesUpdateOptions,
  ): SeamConsoleV1SitesUpdateRequest

  Parameters

  • parameters: { name?: string; site_id: string; site_key?: string }

    • Optionalname?: string

      New name for the site.

    • site_id: string

      ID of the site that you want to update.

    • Optionalsite_key?: string

      New unique key for the site within the workspace.

  • options: SeamConsoleV1SitesUpdateOptions = {}

  Returns SeamConsoleV1SitesUpdateRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpSeamConsoleV1Sites

StaticfromClient

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

  Parameters

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

  Returns SeamHttpSeamConsoleV1Sites

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpSeamConsoleV1Sites

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpSeamConsoleV1Sites

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpSeamConsoleV1Sites

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpSeamConsoleV1Sites>