Class SeamHttpUnstablePartnerBuildingBlocks

constructor

• new SeamHttpUnstablePartnerBuildingBlocks(apiKeyOrOptions?): SeamHttpUnstablePartnerBuildingBlocks

• Parameters

  • apiKeyOrOptions: string | SeamHttpOptions = {}

  Returns SeamHttpUnstablePartnerBuildingBlocks

client

Readonlydefaults

ReadonlyltsVersion

StaticltsVersion

connectAccounts

• connectAccounts(body?): SeamHttpRequest<SetNonNullable<Required<{
      magic_link: {
          building_block_type:
              | "connect_accounts"
              | "manage_devices"
              | "organize_spaces"
              | "console";
          created_at: string;
          customer_key: string;
          expires_at: string;
          url: string;
          workspace_id: string;
      };
  }>, "magic_link">, "magic_link">

• Parameters

  • Optionalbody: {
        customer_key: string;
    }

    • customer_key: string

      Customer key for which you want to connect accounts.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      magic_link: {
          building_block_type:
              | "connect_accounts"
              | "manage_devices"
              | "organize_spaces"
              | "console";
          created_at: string;
          customer_key: string;
          expires_at: string;
          url: string;
          workspace_id: string;
      };
  }>, "magic_link">, "magic_link">

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>

generateMagicLink

• generateMagicLink(params?): SeamHttpRequest<SetNonNullable<Required<{
      magic_link: {
          building_block_type:
              | "connect_accounts"
              | "manage_devices"
              | "organize_spaces"
              | "console";
          created_at: string;
          customer_key: string;
          expires_at: string;
          url: string;
          workspace_id: string;
      };
  }>, "magic_link">, "magic_link">

• Parameters

  • Optionalparams: {
        building_block_type:
            | "connect_accounts"
            | "manage_devices"
            | "organize_spaces"
            | "console";
        customer_key: string;
        spaces?: {
            custom_metadata?: Record<string, string>;
            description?: string;
            name: string;
            space_key: string;
        }[];
    }

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

      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?: {
          custom_metadata?: Record<string, string>;
          description?: string;
          name: string;
          space_key: string;
      }[]

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

  Returns SeamHttpRequest<SetNonNullable<Required<{
      magic_link: {
          building_block_type:
              | "connect_accounts"
              | "manage_devices"
              | "organize_spaces"
              | "console";
          created_at: string;
          customer_key: string;
          expires_at: string;
          url: string;
          workspace_id: string;
      };
  }>, "magic_link">, "magic_link">

manageDevices

• manageDevices(body?): SeamHttpRequest<SetNonNullable<Required<{
      magic_link: {
          building_block_type:
              | "connect_accounts"
              | "manage_devices"
              | "organize_spaces"
              | "console";
          created_at: string;
          customer_key: string;
          expires_at: string;
          url: string;
          workspace_id: string;
      };
  }>, "magic_link">, "magic_link">

• Parameters

  • Optionalbody: {
        customer_key: string;
    }

    • customer_key: string

      Customer key for which you want to manage devices.

  Returns SeamHttpRequest<SetNonNullable<Required<{
      magic_link: {
          building_block_type:
              | "connect_accounts"
              | "manage_devices"
              | "organize_spaces"
              | "console";
          created_at: string;
          customer_key: string;
          expires_at: string;
          url: string;
          workspace_id: string;
      };
  }>, "magic_link">, "magic_link">

organizeSpaces

• organizeSpaces(body?): SeamHttpRequest<SetNonNullable<Required<{
      magic_link: {
          building_block_type:
              | "connect_accounts"
              | "manage_devices"
              | "organize_spaces"
              | "console";
          created_at: string;
          customer_key: string;
          expires_at: string;
          url: string;
          workspace_id: string;
      };
  }>, "magic_link">, "magic_link">

• Parameters

  • Optionalbody: {
        customer_key: string;
        spaces?: {
            custom_metadata?: Record<string, string>;
            description?: string;
            name: string;
            space_key: string;
        }[];
    }

    • customer_key: string

      Customer key for which you want to organize spaces.

    • Optionalspaces?: {
          custom_metadata?: Record<string, string>;
          description?: string;
          name: string;
          space_key: string;
      }[]

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

  Returns SeamHttpRequest<SetNonNullable<Required<{
      magic_link: {
          building_block_type:
              | "connect_accounts"
              | "manage_devices"
              | "organize_spaces"
              | "console";
          created_at: string;
          customer_key: string;
          expires_at: string;
          url: string;
          workspace_id: string;
      };
  }>, "magic_link">, "magic_link">

updateClientSessionToken

• updateClientSessionToken(clientSessionToken): Promise<void>

• Parameters

  • clientSessionToken: string

  Returns Promise<void>

StaticfromApiKey

• fromApiKey(apiKey, options?): SeamHttpUnstablePartnerBuildingBlocks

• Parameters

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

  Returns SeamHttpUnstablePartnerBuildingBlocks

StaticfromClient

• fromClient(client, options?): SeamHttpUnstablePartnerBuildingBlocks

• Parameters

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

  Returns SeamHttpUnstablePartnerBuildingBlocks

StaticfromClientSessionToken

• fromClientSessionToken(clientSessionToken, options?): SeamHttpUnstablePartnerBuildingBlocks

• Parameters

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

  Returns SeamHttpUnstablePartnerBuildingBlocks

StaticfromConsoleSessionToken

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

• Parameters

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

  Returns SeamHttpUnstablePartnerBuildingBlocks

StaticfromPersonalAccessToken

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

• Parameters

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

  Returns SeamHttpUnstablePartnerBuildingBlocks

StaticfromPublishableKey

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

• Parameters

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

  Returns Promise<SeamHttpUnstablePartnerBuildingBlocks>