/** * This file was auto-generated by Fern from our API Definition. */ import * as environments from "../../../../environments.js"; import * as core from "../../../../core/index.js"; import * as FernAI from "../../../index.js"; export declare namespace Website { interface Options { environment?: core.Supplier; /** Specify a custom URL to connect the client to. */ baseUrl?: core.Supplier; token?: core.Supplier; /** Additional headers to include in requests. */ headers?: Record | undefined>; } interface RequestOptions { /** The maximum time to wait for a response in seconds. */ timeoutInSeconds?: number; /** The number of times to retry the request. Defaults to 2. */ maxRetries?: number; /** A hook to abort the request. */ abortSignal?: AbortSignal; /** Additional query string parameters to include in the request. */ queryParams?: Record; /** Additional headers to include in the request. */ headers?: Record | undefined>; } } export declare class Website { protected readonly _options: Website.Options; constructor(_options?: Website.Options); /** * Start crawling and indexing a website. * Returns a job_id to track the crawling progress. * * @param {string} domain * @param {FernAI.IndexWebsiteRequest} request * @param {Website.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.website.indexWebsite("domain", { * base_url: "base_url" * }) */ indexWebsite(domain: string, request: FernAI.IndexWebsiteRequest, requestOptions?: Website.RequestOptions): core.HttpResponsePromise; private __indexWebsite; /** * Get the status of a website crawling job. * * @param {string} domain * @param {FernAI.GetWebsiteStatusRequest} request * @param {Website.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.website.getWebsiteStatus("domain", { * job_id: "job_id" * }) */ getWebsiteStatus(domain: string, request: FernAI.GetWebsiteStatusRequest, requestOptions?: Website.RequestOptions): core.HttpResponsePromise; private __getWebsiteStatus; /** * Get a single indexed website page by ID. * * @param {string} domain * @param {string} websiteId * @param {Website.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.website.getWebsiteById("domain", "website_id") */ getWebsiteById(domain: string, websiteId: string, requestOptions?: Website.RequestOptions): core.HttpResponsePromise; private __getWebsiteById; /** * List all indexed website pages for a domain with pagination. * * @param {string} domain * @param {FernAI.GetWebsitesRequest} request * @param {Website.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.website.getWebsites("domain", { * page: 1, * limit: 1 * }) */ getWebsites(domain: string, request?: FernAI.GetWebsitesRequest, requestOptions?: Website.RequestOptions): core.HttpResponsePromise; private __getWebsites; /** * Re-crawl a website by starting a new crawl job. The job will delete old pages before indexing. * Uses the configuration from the original index request. * * @param {string} domain * @param {FernAI.ReindexWebsiteRequest} request * @param {Website.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.website.reindexWebsite("domain", { * base_url: "base_url" * }) */ reindexWebsite(domain: string, request: FernAI.ReindexWebsiteRequest, requestOptions?: Website.RequestOptions): core.HttpResponsePromise; private __reindexWebsite; /** * Delete all pages from a specific website by base URL. * * @param {string} domain * @param {FernAI.DeleteWebsiteRequest} request * @param {Website.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.website.deleteWebsite("domain", { * base_url: "base_url" * }) */ deleteWebsite(domain: string, request: FernAI.DeleteWebsiteRequest, requestOptions?: Website.RequestOptions): core.HttpResponsePromise; private __deleteWebsite; /** * Delete all indexed website pages for a domain. * * @param {string} domain * @param {Website.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.website.deleteAllWebsites("domain") */ deleteAllWebsites(domain: string, requestOptions?: Website.RequestOptions): core.HttpResponsePromise; private __deleteAllWebsites; protected _getAuthorizationHeader(): Promise; }