Class SeamHttpUnstablePartnerBuildingBlocks

constructor

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

  Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpUnstablePartnerBuildingBlocks

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

connectAccounts

• connectAccounts(
      parameters?: { customer_key: string },
      options?: UnstablePartnerBuildingBlocksConnectAccountsOptions,
  ): UnstablePartnerBuildingBlocksConnectAccountsRequest

  Parameters

  • Optionalparameters: { customer_key: string }

    • customer_key: string

      Customer key for which you want to connect accounts.

  • options: UnstablePartnerBuildingBlocksConnectAccountsOptions = {}

  Returns UnstablePartnerBuildingBlocksConnectAccountsRequest

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>

generateMagicLink

• generateMagicLink(
      parameters?: {
          building_block_type:
              | "connect_accounts"
              | "organize_spaces"
              | "console"
              | "manage_devices";
          customer_key: string;
          spaces?: { name: string; parent_site_key?: string; space_key: string }[];
      },
      options?: UnstablePartnerBuildingBlocksGenerateMagicLinkOptions,
  ): UnstablePartnerBuildingBlocksGenerateMagicLinkRequest

  Parameters

  • Optionalparameters: {
        building_block_type:
            | "connect_accounts"
            | "organize_spaces"
            | "console"
            | "manage_devices";
        customer_key: string;
        spaces?: { name: string; parent_site_key?: string; space_key: string }[];
    }

    • building_block_type: "connect_accounts" | "organize_spaces" | "console" | "manage_devices"

      Type of building block for which you want to create a magic link.

    • customer_key: string

      Customer key for which you want to create a new building block magic link.

    • Optionalspaces?: { name: string; parent_site_key?: string; space_key: string }[]

      Optional list of spaces that you want to include in the new building block magic link.

  • options: UnstablePartnerBuildingBlocksGenerateMagicLinkOptions = {}

  Returns UnstablePartnerBuildingBlocksGenerateMagicLinkRequest

manageDevices

• manageDevices(
      parameters?: { customer_key: string },
      options?: UnstablePartnerBuildingBlocksManageDevicesOptions,
  ): UnstablePartnerBuildingBlocksManageDevicesRequest

  Parameters

  • Optionalparameters: { customer_key: string }

    • customer_key: string

      Customer key for which you want to manage devices.

  • options: UnstablePartnerBuildingBlocksManageDevicesOptions = {}

  Returns UnstablePartnerBuildingBlocksManageDevicesRequest

organizeSpaces

• organizeSpaces(
      parameters?: {
          customer_key: string;
          spaces?: { name: string; parent_site_key?: string; space_key: string }[];
      },
      options?: UnstablePartnerBuildingBlocksOrganizeSpacesOptions,
  ): UnstablePartnerBuildingBlocksOrganizeSpacesRequest

  Parameters

  • Optionalparameters: {
        customer_key: string;
        spaces?: { name: string; parent_site_key?: string; space_key: string }[];
    }

    • customer_key: string

      Customer key for which you want to organize spaces.

    • Optionalspaces?: { name: string; parent_site_key?: string; space_key: string }[]

      Optional list of spaces that you want to include in the new building block magic link.

  • options: UnstablePartnerBuildingBlocksOrganizeSpacesOptions = {}

  Returns UnstablePartnerBuildingBlocksOrganizeSpacesRequest

updateClientSessionToken

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

  Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

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

  Parameters

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

  Returns SeamHttpUnstablePartnerBuildingBlocks

StaticfromClient

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

  Parameters

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

  Returns SeamHttpUnstablePartnerBuildingBlocks

StaticfromClientSessionToken

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

  Parameters

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

  Returns SeamHttpUnstablePartnerBuildingBlocks

StaticfromConsoleSessionToken

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

  Parameters

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

  Returns SeamHttpUnstablePartnerBuildingBlocks

StaticfromPersonalAccessToken

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

  Parameters

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

  Returns SeamHttpUnstablePartnerBuildingBlocks

StaticfromPublishableKey

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

  Parameters

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

  Returns Promise<SeamHttpUnstablePartnerBuildingBlocks>