@nimble-way/nimble-js 0.16.0 → 0.17.0

package/resources/fast-serp.d.mts

@@ -0,0 +1,309 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class FastSerp extends APIResource {
+    /**
+     * Fast SERP
+     *
+     * @example
+     * ```ts
+     * const response = await client.fastSerp.run({
+     *   search_engine: 'google_search',
+     * });
+     * ```
+     */
+    run(body: FastSerpRunParams, options?: RequestOptions): APIPromise<FastSerpRunResponse>;
+}
+export interface FastSerpRunResponse {
+    data: FastSerpRunResponse.Data;
+    metadata: FastSerpRunResponse.Metadata;
+    /**
+     * The status of the task.
+     */
+    status: 'success' | 'skipped' | 'fatal' | 'error' | 'postponed' | 'ignored' | 'rejected' | 'blocked';
+    /**
+     * Unique identifier for the task.
+     */
+    task_id: string;
+    /**
+     * The final URL.
+     */
+    url: string;
+    debug?: FastSerpRunResponse.Debug;
+    /**
+     * Pagination information if applicable.
+     */
+    pagination?: FastSerpRunResponse.NextPageParams | Array<FastSerpRunResponse.UnionMember1>;
+    /**
+     * The HTTP status code of the task.
+     */
+    status_code?: number;
+    /**
+     * List of warnings generated during the task.
+     */
+    warnings?: Array<string>;
+}
+export declare namespace FastSerpRunResponse {
+    interface Data {
+        /**
+         * Browser actions execution results. Present only when browser_actions were
+         * specified in the request.
+         */
+        browser_actions?: Data.BrowserActions;
+        /**
+         * The cookies collected from browser actions during the task.
+         */
+        cookies?: Array<unknown>;
+        /**
+         * The evaluation results from browser actions during the task.
+         */
+        eval?: Array<unknown>;
+        /**
+         * The http requests from browser actions made during the task.
+         */
+        fetch?: Array<unknown>;
+        /**
+         * The headers received during the task.
+         */
+        headers?: {
+            [key: string]: string;
+        };
+        /**
+         * The HTML content of the page.
+         */
+        html?: string;
+        /**
+         * List of all unique URLs found on the page.
+         */
+        links?: Array<string>;
+        /**
+         * The Markdown version of the HTML content.
+         */
+        markdown?: string;
+        /**
+         * The network capture data collected during the task.
+         */
+        network_capture?: Array<Data.NetworkCapture>;
+        /**
+         * Individual HTML content of each pagination page, before merging.
+         */
+        pages_html?: Array<string>;
+        /**
+         * The parsing results extracted from the HTML & network content.
+         */
+        parsing?: Data.ParsingSuccessResult | Data.ParsingErrorResult | {
+            [key: string]: unknown;
+        };
+        /**
+         * The list of redirects that occurred during the task.
+         */
+        redirects?: Array<Data.Redirect>;
+        /**
+         * Screenshots taken during the task, from browser actions, or the screenshot
+         * format.
+         */
+        screenshots?: Array<unknown>;
+    }
+    namespace Data {
+        /**
+         * Browser actions execution results. Present only when browser_actions were
+         * specified in the request.
+         */
+        interface BrowserActions {
+            results: Array<BrowserActions.Result>;
+            success: boolean;
+            total_duration: number;
+        }
+        namespace BrowserActions {
+            interface Result {
+                duration: number;
+                name: 'goto' | 'wait' | 'wait_for_element' | 'wait_for_navigation' | 'click' | 'fill' | 'press' | 'scroll' | 'auto_scroll' | 'screenshot' | 'get_cookies' | 'eval' | 'fetch';
+                status: 'no-run' | 'in-progress' | 'done' | 'error' | 'skipped';
+                error?: string;
+                result?: unknown;
+            }
+        }
+        interface NetworkCapture {
+            filter: NetworkCapture.Filter;
+            results: Array<NetworkCapture.Result>;
+            errorMessage?: string;
+        }
+        namespace NetworkCapture {
+            interface Filter {
+                validation: boolean;
+                wait_for_requests_count: number;
+                method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
+                /**
+                 * Resource type for network capture filtering
+                 */
+                resource_type?: 'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other' | 'fedcm' | Array<'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other' | 'fedcm'>;
+                status_code?: number | Array<number>;
+                url?: Filter.URL;
+                wait_for_requests_count_timeout?: number;
+            }
+            namespace Filter {
+                interface URL {
+                    type: 'exact' | 'contains';
+                    value: string;
+                }
+            }
+            interface Result {
+                request: Result.Request;
+                response: Result.Response;
+            }
+            namespace Result {
+                interface Request {
+                    headers: {
+                        [key: string]: string;
+                    };
+                    method: string;
+                    /**
+                     * Resource type for network capture filtering
+                     */
+                    resource_type: 'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other' | 'fedcm';
+                    url: string;
+                    body?: string;
+                }
+                interface Response {
+                    body: string;
+                    headers: {
+                        [key: string]: string;
+                    };
+                    serialization: 'none' | 'base64';
+                    status: number;
+                    status_text: string;
+                }
+            }
+        }
+        interface ParsingSuccessResult {
+            entities: {
+                [key: string]: unknown;
+            };
+            status: 'success';
+        }
+        interface ParsingErrorResult {
+            error: string;
+            status: 'error';
+        }
+        interface Redirect {
+            status_code: number;
+            url: string;
+        }
+    }
+    interface Metadata {
+        /**
+         * The name of the agent used for the query.
+         */
+        agent?: string;
+        /**
+         * The driver used for the task.
+         */
+        driver?: string;
+        /**
+         * The localization identifier for the query.
+         */
+        localization_id?: string;
+        /**
+         * The duration in milliseconds of the query processing.
+         */
+        query_duration?: number;
+        /**
+         * The time when the query was received.
+         */
+        query_time?: string;
+        /**
+         * Additional response parameters.
+         */
+        response_parameters?: unknown;
+        /**
+         * A tag associated with the query.
+         */
+        tag?: string;
+    }
+    interface Debug {
+        /**
+         * Performance metrics collected during the task.
+         */
+        performance_metrics?: {
+            [key: string]: number;
+        };
+        /**
+         * Total bytes used by the proxy during the task.
+         */
+        proxy_total_bytes_usage?: number;
+        /**
+         * The transformed output after applying any transformations.
+         */
+        transformed_output?: unknown;
+        /**
+         * The userbrowser instance using during the task.
+         */
+        userbrowser?: unknown;
+    }
+    interface NextPageParams {
+        next_page_params: {
+            [key: string]: unknown;
+        };
+    }
+    interface UnionMember1 {
+        next_page_params: {
+            [key: string]: unknown;
+        };
+    }
+}
+export interface FastSerpRunParams {
+    /**
+     * The search engine to query.
+     */
+    search_engine: 'google_search' | 'google_sge' | 'google_aio' | 'google_maps_search' | 'google_maps_reviews' | 'google_maps_place' | 'google_news' | 'google_images' | 'bing_search' | 'yandex_search';
+    /**
+     * ISO Alpha-2 country code used to access the target search engine (e.g. US, DE,
+     * GB).
+     */
+    country?: string;
+    /**
+     * Device type used for the search request.
+     */
+    device?: 'desktop' | 'mobile';
+    /**
+     * Top-level domain for the search engine (e.g. "com", "co.uk", "de").
+     */
+    domain?: string;
+    /**
+     * Locale used for the search request.
+     */
+    locale?: string;
+    /**
+     * Geo-location for the search (canonical Google location name).
+     */
+    location?: string;
+    /**
+     * Number of results to return (1–100).
+     */
+    num_results?: number;
+    /**
+     * The result page number for pagination.
+     */
+    page?: number;
+    /**
+     * When true, the SERP response is parsed into structured JSON.
+     */
+    parse?: boolean;
+    /**
+     * The search keyword or phrase to query.
+     */
+    query?: string;
+    /**
+     * Whether to render the page in a browser before extracting.
+     */
+    render?: boolean;
+    /**
+     * When true, disables Google result filtering (filter=0) so omitted/duplicate and
+     * highly similar pages are also returned. Applies to Google search engines.
+     */
+    show_hidden_results?: boolean;
+}
+export declare namespace FastSerp {
+    export { type FastSerpRunResponse as FastSerpRunResponse, type FastSerpRunParams as FastSerpRunParams };
+}
+//# sourceMappingURL=fast-serp.d.mts.map

package/resources/fast-serp.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fast-serp.d.mts","sourceRoot":"","sources":["../src/resources/fast-serp.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGxF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAE/B,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;IAErG;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ,KAAK,CAAC,EAAE,mBAAmB,CAAC,KAAK,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,mBAAmB,CAAC,cAAc,GAAG,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAE1F;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB;;;WAGG;QACH,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC;QAEtC;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAEvB;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAE7C;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE3B;;WAEG;QACH,OAAO,CAAC,EAAE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,kBAAkB,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3F;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEjC;;;WAGG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;KAC9B;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,cAAc;YAC7B,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAEtC,OAAO,EAAE,OAAO,CAAC;YAEjB,cAAc,EAAE,MAAM,CAAC;SACxB;QAED,UAAiB,cAAc,CAAC;YAC9B,UAAiB,MAAM;gBACrB,QAAQ,EAAE,MAAM,CAAC;gBAEjB,IAAI,EACA,MAAM,GACN,MAAM,GACN,kBAAkB,GAClB,qBAAqB,GACrB,OAAO,GACP,MAAM,GACN,OAAO,GACP,QAAQ,GACR,aAAa,GACb,YAAY,GACZ,aAAa,GACb,MAAM,GACN,OAAO,CAAC;gBAEZ,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;gBAEhE,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf,MAAM,CAAC,EAAE,OAAO,CAAC;aAClB;SACF;QAED,UAAiB,cAAc;YAC7B,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;YAE9B,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAEtC,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;QAED,UAAiB,cAAc,CAAC;YAC9B,UAAiB,MAAM;gBACrB,UAAU,EAAE,OAAO,CAAC;gBAEpB,uBAAuB,EAAE,MAAM,CAAC;gBAEhC,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC;gBAEhG;;mBAEG;gBACH,aAAa,CAAC,EACV,UAAU,GACV,YAAY,GACZ,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ,GACR,WAAW,GACX,KAAK,GACL,OAAO,GACP,UAAU,GACV,aAAa,GACb,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,MAAM,GACN,oBAAoB,GACpB,WAAW,GACX,OAAO,GACP,OAAO,GACP,KAAK,CACD,UAAU,GACV,YAAY,GACZ,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ,GACR,WAAW,GACX,KAAK,GACL,OAAO,GACP,UAAU,GACV,aAAa,GACb,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,MAAM,GACN,oBAAoB,GACpB,WAAW,GACX,OAAO,GACP,OAAO,CACV,CAAC;gBAEN,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;gBAErC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC;gBAEjB,+BAA+B,CAAC,EAAE,MAAM,CAAC;aAC1C;YAED,UAAiB,MAAM,CAAC;gBACtB,UAAiB,GAAG;oBAClB,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;oBAE3B,KAAK,EAAE,MAAM,CAAC;iBACf;aACF;YAED,UAAiB,MAAM;gBACrB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;gBAExB,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;aAC3B;YAED,UAAiB,MAAM,CAAC;gBACtB,UAAiB,OAAO;oBACtB,OAAO,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;oBAEnC,MAAM,EAAE,MAAM,CAAC;oBAEf;;uBAEG;oBACH,aAAa,EACT,UAAU,GACV,YAAY,GACZ,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ,GACR,WAAW,GACX,KAAK,GACL,OAAO,GACP,UAAU,GACV,aAAa,GACb,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,MAAM,GACN,oBAAoB,GACpB,WAAW,GACX,OAAO,GACP,OAAO,CAAC;oBAEZ,GAAG,EAAE,MAAM,CAAC;oBAEZ,IAAI,CAAC,EAAE,MAAM,CAAC;iBACf;gBAED,UAAiB,QAAQ;oBACvB,IAAI,EAAE,MAAM,CAAC;oBAEb,OAAO,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;oBAEnC,aAAa,EAAE,MAAM,GAAG,QAAQ,CAAC;oBAEjC,MAAM,EAAE,MAAM,CAAC;oBAEf,WAAW,EAAE,MAAM,CAAC;iBACrB;aACF;SACF;QAED,UAAiB,oBAAoB;YACnC,QAAQ,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAErC,MAAM,EAAE,SAAS,CAAC;SACnB;QAED,UAAiB,kBAAkB;YACjC,KAAK,EAAE,MAAM,CAAC;YAEd,MAAM,EAAE,OAAO,CAAC;SACjB;QAED,UAAiB,QAAQ;YACvB,WAAW,EAAE,MAAM,CAAC;YAEpB,GAAG,EAAE,MAAM,CAAC;SACb;KACF;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,KAAK;QACpB;;WAEG;QACH,mBAAmB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEhD;;WAEG;QACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAE7B;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB;IAED,UAAiB,cAAc;QAC7B,gBAAgB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KAC9C;IAED,UAAiB,YAAY;QAC3B,gBAAgB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KAC9C;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,EACT,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,oBAAoB,GACpB,qBAAqB,GACrB,mBAAmB,GACnB,aAAa,GACb,eAAe,GACf,aAAa,GACb,eAAe,CAAC;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACzG"}

package/resources/fast-serp.d.ts

@@ -0,0 +1,309 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class FastSerp extends APIResource {
+    /**
+     * Fast SERP
+     *
+     * @example
+     * ```ts
+     * const response = await client.fastSerp.run({
+     *   search_engine: 'google_search',
+     * });
+     * ```
+     */
+    run(body: FastSerpRunParams, options?: RequestOptions): APIPromise<FastSerpRunResponse>;
+}
+export interface FastSerpRunResponse {
+    data: FastSerpRunResponse.Data;
+    metadata: FastSerpRunResponse.Metadata;
+    /**
+     * The status of the task.
+     */
+    status: 'success' | 'skipped' | 'fatal' | 'error' | 'postponed' | 'ignored' | 'rejected' | 'blocked';
+    /**
+     * Unique identifier for the task.
+     */
+    task_id: string;
+    /**
+     * The final URL.
+     */
+    url: string;
+    debug?: FastSerpRunResponse.Debug;
+    /**
+     * Pagination information if applicable.
+     */
+    pagination?: FastSerpRunResponse.NextPageParams | Array<FastSerpRunResponse.UnionMember1>;
+    /**
+     * The HTTP status code of the task.
+     */
+    status_code?: number;
+    /**
+     * List of warnings generated during the task.
+     */
+    warnings?: Array<string>;
+}
+export declare namespace FastSerpRunResponse {
+    interface Data {
+        /**
+         * Browser actions execution results. Present only when browser_actions were
+         * specified in the request.
+         */
+        browser_actions?: Data.BrowserActions;
+        /**
+         * The cookies collected from browser actions during the task.
+         */
+        cookies?: Array<unknown>;
+        /**
+         * The evaluation results from browser actions during the task.
+         */
+        eval?: Array<unknown>;
+        /**
+         * The http requests from browser actions made during the task.
+         */
+        fetch?: Array<unknown>;
+        /**
+         * The headers received during the task.
+         */
+        headers?: {
+            [key: string]: string;
+        };
+        /**
+         * The HTML content of the page.
+         */
+        html?: string;
+        /**
+         * List of all unique URLs found on the page.
+         */
+        links?: Array<string>;
+        /**
+         * The Markdown version of the HTML content.
+         */
+        markdown?: string;
+        /**
+         * The network capture data collected during the task.
+         */
+        network_capture?: Array<Data.NetworkCapture>;
+        /**
+         * Individual HTML content of each pagination page, before merging.
+         */
+        pages_html?: Array<string>;
+        /**
+         * The parsing results extracted from the HTML & network content.
+         */
+        parsing?: Data.ParsingSuccessResult | Data.ParsingErrorResult | {
+            [key: string]: unknown;
+        };
+        /**
+         * The list of redirects that occurred during the task.
+         */
+        redirects?: Array<Data.Redirect>;
+        /**
+         * Screenshots taken during the task, from browser actions, or the screenshot
+         * format.
+         */
+        screenshots?: Array<unknown>;
+    }
+    namespace Data {
+        /**
+         * Browser actions execution results. Present only when browser_actions were
+         * specified in the request.
+         */
+        interface BrowserActions {
+            results: Array<BrowserActions.Result>;
+            success: boolean;
+            total_duration: number;
+        }
+        namespace BrowserActions {
+            interface Result {
+                duration: number;
+                name: 'goto' | 'wait' | 'wait_for_element' | 'wait_for_navigation' | 'click' | 'fill' | 'press' | 'scroll' | 'auto_scroll' | 'screenshot' | 'get_cookies' | 'eval' | 'fetch';
+                status: 'no-run' | 'in-progress' | 'done' | 'error' | 'skipped';
+                error?: string;
+                result?: unknown;
+            }
+        }
+        interface NetworkCapture {
+            filter: NetworkCapture.Filter;
+            results: Array<NetworkCapture.Result>;
+            errorMessage?: string;
+        }
+        namespace NetworkCapture {
+            interface Filter {
+                validation: boolean;
+                wait_for_requests_count: number;
+                method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
+                /**
+                 * Resource type for network capture filtering
+                 */
+                resource_type?: 'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other' | 'fedcm' | Array<'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other' | 'fedcm'>;
+                status_code?: number | Array<number>;
+                url?: Filter.URL;
+                wait_for_requests_count_timeout?: number;
+            }
+            namespace Filter {
+                interface URL {
+                    type: 'exact' | 'contains';
+                    value: string;
+                }
+            }
+            interface Result {
+                request: Result.Request;
+                response: Result.Response;
+            }
+            namespace Result {
+                interface Request {
+                    headers: {
+                        [key: string]: string;
+                    };
+                    method: string;
+                    /**
+                     * Resource type for network capture filtering
+                     */
+                    resource_type: 'document' | 'stylesheet' | 'image' | 'media' | 'font' | 'script' | 'texttrack' | 'xhr' | 'fetch' | 'prefetch' | 'eventsource' | 'websocket' | 'manifest' | 'signedexchange' | 'ping' | 'cspviolationreport' | 'preflight' | 'other' | 'fedcm';
+                    url: string;
+                    body?: string;
+                }
+                interface Response {
+                    body: string;
+                    headers: {
+                        [key: string]: string;
+                    };
+                    serialization: 'none' | 'base64';
+                    status: number;
+                    status_text: string;
+                }
+            }
+        }
+        interface ParsingSuccessResult {
+            entities: {
+                [key: string]: unknown;
+            };
+            status: 'success';
+        }
+        interface ParsingErrorResult {
+            error: string;
+            status: 'error';
+        }
+        interface Redirect {
+            status_code: number;
+            url: string;
+        }
+    }
+    interface Metadata {
+        /**
+         * The name of the agent used for the query.
+         */
+        agent?: string;
+        /**
+         * The driver used for the task.
+         */
+        driver?: string;
+        /**
+         * The localization identifier for the query.
+         */
+        localization_id?: string;
+        /**
+         * The duration in milliseconds of the query processing.
+         */
+        query_duration?: number;
+        /**
+         * The time when the query was received.
+         */
+        query_time?: string;
+        /**
+         * Additional response parameters.
+         */
+        response_parameters?: unknown;
+        /**
+         * A tag associated with the query.
+         */
+        tag?: string;
+    }
+    interface Debug {
+        /**
+         * Performance metrics collected during the task.
+         */
+        performance_metrics?: {
+            [key: string]: number;
+        };
+        /**
+         * Total bytes used by the proxy during the task.
+         */
+        proxy_total_bytes_usage?: number;
+        /**
+         * The transformed output after applying any transformations.
+         */
+        transformed_output?: unknown;
+        /**
+         * The userbrowser instance using during the task.
+         */
+        userbrowser?: unknown;
+    }
+    interface NextPageParams {
+        next_page_params: {
+            [key: string]: unknown;
+        };
+    }
+    interface UnionMember1 {
+        next_page_params: {
+            [key: string]: unknown;
+        };
+    }
+}
+export interface FastSerpRunParams {
+    /**
+     * The search engine to query.
+     */
+    search_engine: 'google_search' | 'google_sge' | 'google_aio' | 'google_maps_search' | 'google_maps_reviews' | 'google_maps_place' | 'google_news' | 'google_images' | 'bing_search' | 'yandex_search';
+    /**
+     * ISO Alpha-2 country code used to access the target search engine (e.g. US, DE,
+     * GB).
+     */
+    country?: string;
+    /**
+     * Device type used for the search request.
+     */
+    device?: 'desktop' | 'mobile';
+    /**
+     * Top-level domain for the search engine (e.g. "com", "co.uk", "de").
+     */
+    domain?: string;
+    /**
+     * Locale used for the search request.
+     */
+    locale?: string;
+    /**
+     * Geo-location for the search (canonical Google location name).
+     */
+    location?: string;
+    /**
+     * Number of results to return (1–100).
+     */
+    num_results?: number;
+    /**
+     * The result page number for pagination.
+     */
+    page?: number;
+    /**
+     * When true, the SERP response is parsed into structured JSON.
+     */
+    parse?: boolean;
+    /**
+     * The search keyword or phrase to query.
+     */
+    query?: string;
+    /**
+     * Whether to render the page in a browser before extracting.
+     */
+    render?: boolean;
+    /**
+     * When true, disables Google result filtering (filter=0) so omitted/duplicate and
+     * highly similar pages are also returned. Applies to Google search engines.
+     */
+    show_hidden_results?: boolean;
+}
+export declare namespace FastSerp {
+    export { type FastSerpRunResponse as FastSerpRunResponse, type FastSerpRunParams as FastSerpRunParams };
+}
+//# sourceMappingURL=fast-serp.d.ts.map

package/resources/fast-serp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fast-serp.d.ts","sourceRoot":"","sources":["../src/resources/fast-serp.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGxF;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,mBAAmB,CAAC,IAAI,CAAC;IAE/B,QAAQ,EAAE,mBAAmB,CAAC,QAAQ,CAAC;IAEvC;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;IAErG;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ,KAAK,CAAC,EAAE,mBAAmB,CAAC,KAAK,CAAC;IAElC;;OAEG;IACH,UAAU,CAAC,EAAE,mBAAmB,CAAC,cAAc,GAAG,KAAK,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;IAE1F;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAC1B;AAED,yBAAiB,mBAAmB,CAAC;IACnC,UAAiB,IAAI;QACnB;;;WAGG;QACH,eAAe,CAAC,EAAE,IAAI,CAAC,cAAc,CAAC;QAEtC;;WAEG;QACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAEzB;;WAEG;QACH,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAEvB;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEpC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAEtB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAE7C;;WAEG;QACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAE3B;;WAEG;QACH,OAAO,CAAC,EAAE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,kBAAkB,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3F;;WAEG;QACH,SAAS,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEjC;;;WAGG;QACH,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;KAC9B;IAED,UAAiB,IAAI,CAAC;QACpB;;;WAGG;QACH,UAAiB,cAAc;YAC7B,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAEtC,OAAO,EAAE,OAAO,CAAC;YAEjB,cAAc,EAAE,MAAM,CAAC;SACxB;QAED,UAAiB,cAAc,CAAC;YAC9B,UAAiB,MAAM;gBACrB,QAAQ,EAAE,MAAM,CAAC;gBAEjB,IAAI,EACA,MAAM,GACN,MAAM,GACN,kBAAkB,GAClB,qBAAqB,GACrB,OAAO,GACP,MAAM,GACN,OAAO,GACP,QAAQ,GACR,aAAa,GACb,YAAY,GACZ,aAAa,GACb,MAAM,GACN,OAAO,CAAC;gBAEZ,MAAM,EAAE,QAAQ,GAAG,aAAa,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC;gBAEhE,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf,MAAM,CAAC,EAAE,OAAO,CAAC;aAClB;SACF;QAED,UAAiB,cAAc;YAC7B,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC;YAE9B,OAAO,EAAE,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;YAEtC,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;QAED,UAAiB,cAAc,CAAC;YAC9B,UAAiB,MAAM;gBACrB,UAAU,EAAE,OAAO,CAAC;gBAEpB,uBAAuB,EAAE,MAAM,CAAC;gBAEhC,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,OAAO,GAAG,OAAO,CAAC;gBAEhG;;mBAEG;gBACH,aAAa,CAAC,EACV,UAAU,GACV,YAAY,GACZ,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ,GACR,WAAW,GACX,KAAK,GACL,OAAO,GACP,UAAU,GACV,aAAa,GACb,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,MAAM,GACN,oBAAoB,GACpB,WAAW,GACX,OAAO,GACP,OAAO,GACP,KAAK,CACD,UAAU,GACV,YAAY,GACZ,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ,GACR,WAAW,GACX,KAAK,GACL,OAAO,GACP,UAAU,GACV,aAAa,GACb,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,MAAM,GACN,oBAAoB,GACpB,WAAW,GACX,OAAO,GACP,OAAO,CACV,CAAC;gBAEN,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;gBAErC,GAAG,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC;gBAEjB,+BAA+B,CAAC,EAAE,MAAM,CAAC;aAC1C;YAED,UAAiB,MAAM,CAAC;gBACtB,UAAiB,GAAG;oBAClB,IAAI,EAAE,OAAO,GAAG,UAAU,CAAC;oBAE3B,KAAK,EAAE,MAAM,CAAC;iBACf;aACF;YAED,UAAiB,MAAM;gBACrB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;gBAExB,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC;aAC3B;YAED,UAAiB,MAAM,CAAC;gBACtB,UAAiB,OAAO;oBACtB,OAAO,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;oBAEnC,MAAM,EAAE,MAAM,CAAC;oBAEf;;uBAEG;oBACH,aAAa,EACT,UAAU,GACV,YAAY,GACZ,OAAO,GACP,OAAO,GACP,MAAM,GACN,QAAQ,GACR,WAAW,GACX,KAAK,GACL,OAAO,GACP,UAAU,GACV,aAAa,GACb,WAAW,GACX,UAAU,GACV,gBAAgB,GAChB,MAAM,GACN,oBAAoB,GACpB,WAAW,GACX,OAAO,GACP,OAAO,CAAC;oBAEZ,GAAG,EAAE,MAAM,CAAC;oBAEZ,IAAI,CAAC,EAAE,MAAM,CAAC;iBACf;gBAED,UAAiB,QAAQ;oBACvB,IAAI,EAAE,MAAM,CAAC;oBAEb,OAAO,EAAE;wBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;qBAAE,CAAC;oBAEnC,aAAa,EAAE,MAAM,GAAG,QAAQ,CAAC;oBAEjC,MAAM,EAAE,MAAM,CAAC;oBAEf,WAAW,EAAE,MAAM,CAAC;iBACrB;aACF;SACF;QAED,UAAiB,oBAAoB;YACnC,QAAQ,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAErC,MAAM,EAAE,SAAS,CAAC;SACnB;QAED,UAAiB,kBAAkB;YACjC,KAAK,EAAE,MAAM,CAAC;YAEd,MAAM,EAAE,OAAO,CAAC;SACjB;QAED,UAAiB,QAAQ;YACvB,WAAW,EAAE,MAAM,CAAC;YAEpB,GAAG,EAAE,MAAM,CAAC;SACb;KACF;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAE9B;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED,UAAiB,KAAK;QACpB;;WAEG;QACH,mBAAmB,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAEhD;;WAEG;QACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;QAEjC;;WAEG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;QAE7B;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB;IAED,UAAiB,cAAc;QAC7B,gBAAgB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KAC9C;IAED,UAAiB,YAAY;QAC3B,gBAAgB,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KAC9C;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,aAAa,EACT,eAAe,GACf,YAAY,GACZ,YAAY,GACZ,oBAAoB,GACpB,qBAAqB,GACrB,mBAAmB,GACnB,aAAa,GACb,eAAe,GACf,aAAa,GACb,eAAe,CAAC;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAC;IAE9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CACzG"}

package/resources/fast-serp.js

@@ -0,0 +1,22 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FastSerp = void 0;
+const resource_1 = require("../core/resource.js");
+class FastSerp extends resource_1.APIResource {
+    /**
+     * Fast SERP
+     *
+     * @example
+     * ```ts
+     * const response = await client.fastSerp.run({
+     *   search_engine: 'google_search',
+     * });
+     * ```
+     */
+    run(body, options) {
+        return this._client.post('/v1/fast-serp', { body, ...options });
+    }
+}
+exports.FastSerp = FastSerp;
+//# sourceMappingURL=fast-serp.js.map

package/resources/fast-serp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fast-serp.js","sourceRoot":"","sources":["../src/resources/fast-serp.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAuB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClE,CAAC;CACF;AAdD,4BAcC"}

package/resources/fast-serp.mjs

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+export class FastSerp extends APIResource {
+    /**
+     * Fast SERP
+     *
+     * @example
+     * ```ts
+     * const response = await client.fastSerp.run({
+     *   search_engine: 'google_search',
+     * });
+     * ```
+     */
+    run(body, options) {
+        return this._client.post('/v1/fast-serp', { body, ...options });
+    }
+}
+//# sourceMappingURL=fast-serp.mjs.map