@nimble-way/nimble-js 0.7.0 → 0.9.0

package/resources/batches.d.ts

@@ -0,0 +1,140 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Batches extends APIResource {
+    /**
+     * Retrieve a paginated list of batches for the authenticated account.
+     */
+    list(options?: RequestOptions): APIPromise<void>;
+    /**
+     * Retrieve the details of a batch including all its tasks and completion status.
+     */
+    get(batchID: string, options?: RequestOptions): APIPromise<BatchGetResponse>;
+    /**
+     * Retrieve lightweight progress information for a batch without fetching all task
+     * details.
+     */
+    progress(batchID: string, options?: RequestOptions): APIPromise<BatchProgressResponse>;
+}
+/**
+ * Response containing batch details with all tasks.
+ */
+export interface BatchGetResponse {
+    /**
+     * Unique identifier for the batch.
+     */
+    id: string;
+    /**
+     * Whether all tasks in the batch have finished.
+     */
+    completed: boolean;
+    /**
+     * Number of tasks that have completed so far.
+     */
+    completed_count: number;
+    /**
+     * ISO timestamp when the batch was created.
+     */
+    created_at: string;
+    /**
+     * Completion ratio between 0 and 1.
+     */
+    progress: number;
+    status: 'success';
+    /**
+     * List of tasks in the batch.
+     */
+    tasks: Array<BatchGetResponse.Task | null>;
+    /**
+     * ISO timestamp when the batch completed.
+     */
+    completed_at?: string;
+}
+export declare namespace BatchGetResponse {
+    interface Task {
+        /**
+         * Unique task identifier.
+         */
+        id: string;
+        _query: unknown;
+        /**
+         * Timestamp when the task was created.
+         */
+        created_at: string;
+        /**
+         * Original input data for the task.
+         */
+        input: unknown;
+        /**
+         * Current state of the task.
+         */
+        state: 'pending' | 'success' | 'error';
+        /**
+         * URL for checking the task status.
+         */
+        status_url: string;
+        /**
+         * Account name that owns the task.
+         */
+        account_name?: string;
+        api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'media' | 'agent' | 'extract';
+        /**
+         * Batch ID if this task is part of a batch.
+         */
+        batch_id?: string;
+        /**
+         * URL for downloading the task results.
+         */
+        download_url?: string;
+        /**
+         * Error message if the task failed.
+         */
+        error?: string;
+        /**
+         * Classification of the error type.
+         */
+        error_type?: string;
+        /**
+         * Timestamp when the task was last modified.
+         */
+        modified_at?: string;
+        /**
+         * Storage location of the output data.
+         */
+        output_url?: string;
+        /**
+         * HTTP status code from the task execution.
+         */
+        status_code?: number;
+    }
+}
+/**
+ * Lightweight batch progress without task details.
+ */
+export interface BatchProgressResponse {
+    /**
+     * Unique identifier for the batch.
+     */
+    id: string;
+    /**
+     * Whether all tasks in the batch have finished.
+     */
+    completed: boolean;
+    /**
+     * Number of tasks that have completed so far.
+     */
+    completed_count: number;
+    /**
+     * Completion ratio between 0 and 1.
+     */
+    progress: number;
+    status: 'success';
+    /**
+     * ISO timestamp when the batch completed.
+     */
+    completed_at?: string;
+}
+export declare namespace Batches {
+    export { type BatchGetResponse as BatchGetResponse, type BatchProgressResponse as BatchProgressResponse };
+}
+//# sourceMappingURL=batches.d.ts.map

package/resources/batches.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"batches.d.ts","sourceRoot":"","sources":["../src/resources/batches.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOhD;;OAEG;IACH,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;IAI5E;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGvF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,gBAAgB,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IAE3C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,yBAAiB,gBAAgB,CAAC;IAChC,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,MAAM,EAAE,OAAO,CAAC;QAEhB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,KAAK,EAAE,OAAO,CAAC;QAEf;;WAEG;QACH,KAAK,EAAE,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC;QAEvC;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB,QAAQ,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,WAAW,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,SAAS,CAAC;QAEnF;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,MAAM,EAAE,SAAS,CAAC;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,gBAAgB,IAAI,gBAAgB,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,CAAC;CAC3G"}

package/resources/batches.js

@@ -0,0 +1,33 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Batches = void 0;
+const resource_1 = require("../core/resource.js");
+const headers_1 = require("../internal/headers.js");
+const path_1 = require("../internal/utils/path.js");
+class Batches extends resource_1.APIResource {
+    /**
+     * Retrieve a paginated list of batches for the authenticated account.
+     */
+    list(options) {
+        return this._client.get('/v1/batches', {
+            ...options,
+            headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Retrieve the details of a batch including all its tasks and completion status.
+     */
+    get(batchID, options) {
+        return this._client.get((0, path_1.path) `/v1/batches/${batchID}`, options);
+    }
+    /**
+     * Retrieve lightweight progress information for a batch without fetching all task
+     * details.
+     */
+    progress(batchID, options) {
+        return this._client.get((0, path_1.path) `/v1/batches/${batchID}/progress`, options);
+    }
+}
+exports.Batches = Batches;
+//# sourceMappingURL=batches.js.map

package/resources/batches.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batches.js","sourceRoot":"","sources":["../src/resources/batches.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE;YACrC,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,OAAe,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,eAAe,OAAO,WAAW,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF;AAzBD,0BAyBC"}

package/resources/batches.mjs

@@ -0,0 +1,29 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { buildHeaders } from "../internal/headers.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Batches extends APIResource {
+    /**
+     * Retrieve a paginated list of batches for the authenticated account.
+     */
+    list(options) {
+        return this._client.get('/v1/batches', {
+            ...options,
+            headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+        });
+    }
+    /**
+     * Retrieve the details of a batch including all its tasks and completion status.
+     */
+    get(batchID, options) {
+        return this._client.get(path `/v1/batches/${batchID}`, options);
+    }
+    /**
+     * Retrieve lightweight progress information for a batch without fetching all task
+     * details.
+     */
+    progress(batchID, options) {
+        return this._client.get(path `/v1/batches/${batchID}/progress`, options);
+    }
+}
+//# sourceMappingURL=batches.mjs.map

package/resources/batches.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"batches.mjs","sourceRoot":"","sources":["../src/resources/batches.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE;YACrC,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,GAAG,CAAC,OAAe,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,OAAe,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,eAAe,OAAO,WAAW,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;CACF"}

package/resources/index.d.mts

@@ -1,6 +1,7 @@
 export * from "./shared.mjs";
 export { Agent, type AgentListResponse, type AgentGetResponse, type AgentRunResponse, type AgentRunAsyncResponse, type AgentListParams, type AgentRunParams, type AgentRunAsyncParams, } from "./agent.mjs";
+export { Batches, type BatchGetResponse, type BatchProgressResponse } from "./batches.mjs";
 export { Crawl, type CrawlListResponse, type CrawlRunResponse, type CrawlStatusResponse, type CrawlTerminateResponse, type CrawlListParams, type CrawlRunParams, } from "./crawl.mjs";
 export { Tasks, type TaskListResponse, type TaskGetResponse, type TaskResultsResponse, type TaskListParams, } from "./tasks.mjs";
-export { type ExtractResponse, type ExtractAsyncResponse, type MapResponse, type SearchResponse, type ExtractParams, type ExtractAsyncParams, type MapParams, type SearchParams, } from "./top-level.mjs";
+export { type ExtractResponse, type ExtractAsyncResponse, type ExtractBatchResponse, type MapResponse, type SearchResponse, type ExtractParams, type ExtractAsyncParams, type ExtractBatchParams, type MapParams, type SearchParams, } from "./top-level.mjs";
 //# sourceMappingURL=index.d.mts.map

package/resources/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,mBAAmB,GACzB;OACM,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,cAAc,GACpB;OACM,EACL,KAAK,EACL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,cAAc,GACpB;OACM,EACL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,SAAS,EACd,KAAK,YAAY,GAClB"}
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,mBAAmB,GACzB;OACM,EAAE,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,qBAAqB,EAAE;OAC9D,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,cAAc,GACpB;OACM,EACL,KAAK,EACL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,cAAc,GACpB;OACM,EACL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,SAAS,EACd,KAAK,YAAY,GAClB"}

package/resources/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./shared.js";
 export { Agent, type AgentListResponse, type AgentGetResponse, type AgentRunResponse, type AgentRunAsyncResponse, type AgentListParams, type AgentRunParams, type AgentRunAsyncParams, } from "./agent.js";
+export { Batches, type BatchGetResponse, type BatchProgressResponse } from "./batches.js";
 export { Crawl, type CrawlListResponse, type CrawlRunResponse, type CrawlStatusResponse, type CrawlTerminateResponse, type CrawlListParams, type CrawlRunParams, } from "./crawl.js";
 export { Tasks, type TaskListResponse, type TaskGetResponse, type TaskResultsResponse, type TaskListParams, } from "./tasks.js";
-export { type ExtractResponse, type ExtractAsyncResponse, type MapResponse, type SearchResponse, type ExtractParams, type ExtractAsyncParams, type MapParams, type SearchParams, } from "./top-level.js";
+export { type ExtractResponse, type ExtractAsyncResponse, type ExtractBatchResponse, type MapResponse, type SearchResponse, type ExtractParams, type ExtractAsyncParams, type ExtractBatchParams, type MapParams, type SearchParams, } from "./top-level.js";
 //# sourceMappingURL=index.d.ts.map

package/resources/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,mBAAmB,GACzB;OACM,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,cAAc,GACpB;OACM,EACL,KAAK,EACL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,cAAc,GACpB;OACM,EACL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,SAAS,EACd,KAAK,YAAY,GAClB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,mBAAmB,GACzB;OACM,EAAE,OAAO,EAAE,KAAK,gBAAgB,EAAE,KAAK,qBAAqB,EAAE;OAC9D,EACL,KAAK,EACL,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EACpB,KAAK,cAAc,GACpB;OACM,EACL,KAAK,EACL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,mBAAmB,EACxB,KAAK,cAAc,GACpB;OACM,EACL,KAAK,eAAe,EACpB,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EACzB,KAAK,WAAW,EAChB,KAAK,cAAc,EACnB,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,kBAAkB,EACvB,KAAK,SAAS,EACd,KAAK,YAAY,GAClB"}

package/resources/index.js

@@ -1,11 +1,13 @@
 "use strict";
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Tasks = exports.Crawl = exports.Agent = void 0;
+exports.Tasks = exports.Crawl = exports.Batches = exports.Agent = void 0;
 const tslib_1 = require("../internal/tslib.js");
 tslib_1.__exportStar(require("./shared.js"), exports);
 var agent_1 = require("./agent.js");
 Object.defineProperty(exports, "Agent", { enumerable: true, get: function () { return agent_1.Agent; } });
+var batches_1 = require("./batches.js");
+Object.defineProperty(exports, "Batches", { enumerable: true, get: function () { return batches_1.Batches; } });
 var crawl_1 = require("./crawl.js");
 Object.defineProperty(exports, "Crawl", { enumerable: true, get: function () { return crawl_1.Crawl; } });
 var tasks_1 = require("./tasks.js");

package/resources/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,oCASiB;AARf,8FAAA,KAAK,OAAA;AASP,oCAQiB;AAPf,8FAAA,KAAK,OAAA;AAQP,oCAMiB;AALf,8FAAA,KAAK,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,oCASiB;AARf,8FAAA,KAAK,OAAA;AASP,wCAAuF;AAA9E,kGAAA,OAAO,OAAA;AAChB,oCAQiB;AAPf,8FAAA,KAAK,OAAA;AAQP,oCAMiB;AALf,8FAAA,KAAK,OAAA"}

package/resources/index.mjs

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 export * from "./shared.mjs";
 export { Agent, } from "./agent.mjs";
+export { Batches } from "./batches.mjs";
 export { Crawl, } from "./crawl.mjs";
 export { Tasks, } from "./tasks.mjs";
 //# sourceMappingURL=index.mjs.map

package/resources/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,KAAK,GAQN;OACM,EACL,KAAK,GAON;OACM,EACL,KAAK,GAKN"}
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,KAAK,GAQN;OACM,EAAE,OAAO,EAAqD;OAC9D,EACL,KAAK,GAON;OACM,EACL,KAAK,GAKN"}

package/resources/top-level.d.mts

@@ -302,6 +302,81 @@ export declare namespace ExtractAsyncResponse {
         status_code?: number;
     }
 }
+/**
+ * Response when a batch of extract tasks is created successfully.
+ */
+export interface ExtractBatchResponse {
+    /**
+     * Unique identifier for the batch.
+     */
+    batch_id: string;
+    /**
+     * Number of tasks in the batch.
+     */
+    batch_size: number;
+    /**
+     * List of created tasks.
+     */
+    tasks: Array<ExtractBatchResponse.Task>;
+}
+export declare namespace ExtractBatchResponse {
+    interface Task {
+        /**
+         * Unique task identifier.
+         */
+        id: string;
+        _query: unknown;
+        /**
+         * Timestamp when the task was created.
+         */
+        created_at: string;
+        /**
+         * Original input data for the task.
+         */
+        input: unknown;
+        /**
+         * Current state of the task.
+         */
+        state: 'pending' | 'success' | 'error';
+        /**
+         * URL for checking the task status.
+         */
+        status_url: string;
+        /**
+         * Account name that owns the task.
+         */
+        account_name?: string;
+        api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'media' | 'agent' | 'extract';
+        /**
+         * Batch ID if this task is part of a batch.
+         */
+        batch_id?: string;
+        /**
+         * URL for downloading the task results.
+         */
+        download_url?: string;
+        /**
+         * Error message if the task failed.
+         */
+        error?: string;
+        /**
+         * Classification of the error type.
+         */
+        error_type?: string;
+        /**
+         * Timestamp when the task was last modified.
+         */
+        modified_at?: string;
+        /**
+         * Storage location of the output data.
+         */
+        output_url?: string;
+        /**
+         * HTTP status code from the task execution.
+         */
+        status_code?: number;
+    }
+}
 /**
  * Response schema for map requests.
  */
@@ -746,6 +821,207 @@ export declare namespace ExtractAsyncParams {
         timeout?: number;
     }
 }
+export interface ExtractBatchParams {
+    /**
+     * Array of extraction requests. Each object represents one extraction with its own
+     * parameters.
+     */
+    params: Array<ExtractBatchParams.Param>;
+    /**
+     * Shared parameters applied to the entire batch, such as storage and callback
+     * configuration.
+     */
+    shared_params?: ExtractBatchParams.SharedParams;
+}
+export declare namespace ExtractBatchParams {
+    interface Param {
+        /**
+         * Target URL to scrape
+         */
+        url: string;
+        /**
+         * Browser type to emulate
+         */
+        browser?: 'chrome' | 'firefox' | Param.UnionMember1;
+        /**
+         * Array of browser automation actions to execute sequentially
+         */
+        browser_actions?: Array<Shared.AutoScrollAction | Shared.ClickAction | Shared.EvalAction | Shared.FetchAction | Shared.FillAction | Shared.GetCookiesAction | Shared.GotoAction | Shared.PressAction | Shared.ScreenshotAction | Shared.ScrollAction | Shared.WaitAction | Shared.WaitForElementAction | Shared.WaitForNavigationAction>;
+        /**
+         * City for geolocation
+         */
+        city?: string;
+        /**
+         * Whether to automatically handle cookie consent headers
+         */
+        consent_header?: boolean;
+        /**
+         * Browser cookies as array of cookie objects
+         */
+        cookies?: Array<Param.UnionMember0> | string;
+        /**
+         * Country code for geolocation and proxy selection
+         */
+        country?: 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'XK' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'ALL';
+        /**
+         * Device type for browser emulation
+         */
+        device?: 'desktop' | 'mobile' | 'tablet';
+        /**
+         * Browser driver to use
+         */
+        driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro';
+        /**
+         * Expected HTTP status codes for successful requests
+         */
+        expected_status_codes?: Array<number>;
+        /**
+         * List of acceptable response formats in order of preference
+         */
+        formats?: Array<'html' | 'markdown' | 'screenshot'>;
+        /**
+         * Custom HTTP headers to include in the request
+         */
+        headers?: {
+            [key: string]: string | Array<string> | null;
+        };
+        /**
+         * Whether to use HTTP/2 protocol
+         */
+        http2?: boolean;
+        /**
+         * Whether to emulate XMLHttpRequest behavior
+         */
+        is_xhr?: boolean;
+        /**
+         * Locale for browser language and region settings
+         */
+        locale?: 'aa-DJ' | 'aa-ER' | 'aa-ET' | 'af' | 'af-NA' | 'af-ZA' | 'ak' | 'ak-GH' | 'am' | 'am-ET' | 'an-ES' | 'ar' | 'ar-AE' | 'ar-BH' | 'ar-DZ' | 'ar-EG' | 'ar-IN' | 'ar-IQ' | 'ar-JO' | 'ar-KW' | 'ar-LB' | 'ar-LY' | 'ar-MA' | 'ar-OM' | 'ar-QA' | 'ar-SA' | 'ar-SD' | 'ar-SY' | 'ar-TN' | 'ar-YE' | 'as' | 'as-IN' | 'asa' | 'asa-TZ' | 'ast-ES' | 'az' | 'az-AZ' | 'az-Cyrl' | 'az-Cyrl-AZ' | 'az-Latn' | 'az-Latn-AZ' | 'be' | 'be-BY' | 'bem' | 'bem-ZM' | 'ber-DZ' | 'ber-MA' | 'bez' | 'bez-TZ' | 'bg' | 'bg-BG' | 'bho-IN' | 'bm' | 'bm-ML' | 'bn' | 'bn-BD' | 'bn-IN' | 'bo' | 'bo-CN' | 'bo-IN' | 'br-FR' | 'brx-IN' | 'bs' | 'bs-BA' | 'byn-ER' | 'ca' | 'ca-AD' | 'ca-ES' | 'ca-FR' | 'ca-IT' | 'cgg' | 'cgg-UG' | 'chr' | 'chr-US' | 'crh-UA' | 'cs' | 'cs-CZ' | 'csb-PL' | 'cv-RU' | 'cy' | 'cy-GB' | 'da' | 'da-DK' | 'dav' | 'dav-KE' | 'de' | 'de-AT' | 'de-BE' | 'de-CH' | 'de-DE' | 'de-LI' | 'de-LU' | 'dv-MV' | 'dz-BT' | 'ebu' | 'ebu-KE' | 'ee' | 'ee-GH' | 'ee-TG' | 'el' | 'el-CY' | 'el-GR' | 'en' | 'en-AG' | 'en-AS' | 'en-AU' | 'en-BE' | 'en-BW' | 'en-BZ' | 'en-CA' | 'en-DK' | 'en-GB' | 'en-GU' | 'en-HK' | 'en-IE' | 'en-IN' | 'en-JM' | 'en-MH' | 'en-MP' | 'en-MT' | 'en-MU' | 'en-NA' | 'en-NG' | 'en-NZ' | 'en-PH' | 'en-PK' | 'en-SG' | 'en-TT' | 'en-UM' | 'en-US' | 'en-VI' | 'en-ZA' | 'en-ZM' | 'en-ZW' | 'eo' | 'es' | 'es-419' | 'es-AR' | 'es-BO' | 'es-CL' | 'es-CO' | 'es-CR' | 'es-CU' | 'es-DO' | 'es-EC' | 'es-ES' | 'es-GQ' | 'es-GT' | 'es-HN' | 'es-MX' | 'es-NI' | 'es-PA' | 'es-PE' | 'es-PR' | 'es-PY' | 'es-SV' | 'es-US' | 'es-UY' | 'es-VE' | 'et' | 'et-EE' | 'eu' | 'eu-ES' | 'fa' | 'fa-AF' | 'fa-IR' | 'ff' | 'ff-SN' | 'fi' | 'fi-FI' | 'fil' | 'fil-PH' | 'fo' | 'fo-FO' | 'fr' | 'fr-BE' | 'fr-BF' | 'fr-BI' | 'fr-BJ' | 'fr-BL' | 'fr-CA' | 'fr-CD' | 'fr-CF' | 'fr-CG' | 'fr-CH' | 'fr-CI' | 'fr-CM' | 'fr-DJ' | 'fr-FR' | 'fr-GA' | 'fr-GN' | 'fr-GP' | 'fr-GQ' | 'fr-KM' | 'fr-LU' | 'fr-MC' | 'fr-MF' | 'fr-MG' | 'fr-ML' | 'fr-MQ' | 'fr-NE' | 'fr-RE' | 'fr-RW' | 'fr-SN' | 'fr-TD' | 'fr-TG' | 'fur-IT' | 'fy-DE' | 'fy-NL' | 'ga' | 'ga-IE' | 'gd-GB' | 'gez-ER' | 'gez-ET' | 'gl' | 'gl-ES' | 'gsw' | 'gsw-CH' | 'gu' | 'gu-IN' | 'guz' | 'guz-KE' | 'gv' | 'gv-GB' | 'ha' | 'ha-Latn' | 'ha-Latn-GH' | 'ha-Latn-NE' | 'ha-Latn-NG' | 'ha-NG' | 'haw' | 'haw-US' | 'he' | 'he-IL' | 'hi' | 'hi-IN' | 'hne-IN' | 'hr' | 'hr-HR' | 'hsb-DE' | 'ht-HT' | 'hu' | 'hu-HU' | 'hy' | 'hy-AM' | 'id' | 'id-ID' | 'ig' | 'ig-NG' | 'ii' | 'ii-CN' | 'ik-CA' | 'is' | 'is-IS' | 'it' | 'it-CH' | 'it-IT' | 'iu-CA' | 'iw-IL' | 'ja' | 'ja-JP' | 'jmc' | 'jmc-TZ' | 'ka' | 'ka-GE' | 'kab' | 'kab-DZ' | 'kam' | 'kam-KE' | 'kde' | 'kde-TZ' | 'kea' | 'kea-CV' | 'khq' | 'khq-ML' | 'ki' | 'ki-KE' | 'kk' | 'kk-Cyrl' | 'kk-Cyrl-KZ' | 'kk-KZ' | 'kl' | 'kl-GL' | 'kln' | 'kln-KE' | 'km' | 'km-KH' | 'kn' | 'kn-IN' | 'ko' | 'ko-KR' | 'kok' | 'kok-IN' | 'ks-IN' | 'ku-TR' | 'kw' | 'kw-GB' | 'ky-KG' | 'lag' | 'lag-TZ' | 'lb-LU' | 'lg' | 'lg-UG' | 'li-BE' | 'li-NL' | 'lij-IT' | 'lo-LA' | 'lt' | 'lt-LT' | 'luo' | 'luo-KE' | 'luy' | 'luy-KE' | 'lv' | 'lv-LV' | 'mag-IN' | 'mai-IN' | 'mas' | 'mas-KE' | 'mas-TZ' | 'mer' | 'mer-KE' | 'mfe' | 'mfe-MU' | 'mg' | 'mg-MG' | 'mhr-RU' | 'mi-NZ' | 'mk' | 'mk-MK' | 'ml' | 'ml-IN' | 'mn-MN' | 'mr' | 'mr-IN' | 'ms' | 'ms-BN' | 'ms-MY' | 'mt' | 'mt-MT' | 'my' | 'my-MM' | 'nan-TW' | 'naq' | 'naq-NA' | 'nb' | 'nb-NO' | 'nd' | 'nd-ZW' | 'nds-DE' | 'nds-NL' | 'ne' | 'ne-IN' | 'ne-NP' | 'nl' | 'nl-AW' | 'nl-BE' | 'nl-NL' | 'nn' | 'nn-NO' | 'nr-ZA' | 'nso-ZA' | 'nyn' | 'nyn-UG' | 'oc-FR' | 'om' | 'om-ET' | 'om-KE' | 'or' | 'or-IN' | 'os-RU' | 'pa' | 'pa-Arab' | 'pa-Arab-PK' | 'pa-Guru' | 'pa-Guru-IN' | 'pa-IN' | 'pa-PK' | 'pap-AN' | 'pl' | 'pl-PL' | 'ps' | 'ps-AF' | 'pt' | 'pt-BR' | 'pt-GW' | 'pt-MZ' | 'pt-PT' | 'rm' | 'rm-CH' | 'ro' | 'ro-MD' | 'ro-RO' | 'rof' | 'rof-TZ' | 'ru' | 'ru-MD' | 'ru-RU' | 'ru-UA' | 'rw' | 'rw-RW' | 'rwk' | 'rwk-TZ' | 'sa-IN' | 'saq' | 'saq-KE' | 'sc-IT' | 'sd-IN' | 'se-NO' | 'seh' | 'seh-MZ' | 'ses' | 'ses-ML' | 'sg' | 'sg-CF' | 'shi' | 'shi-Latn' | 'shi-Latn-MA' | 'shi-Tfng' | 'shi-Tfng-MA' | 'shs-CA' | 'si' | 'si-LK' | 'sid-ET' | 'sk' | 'sk-SK' | 'sl' | 'sl-SI' | 'sn' | 'sn-ZW' | 'so' | 'so-DJ' | 'so-ET' | 'so-KE' | 'so-SO' | 'sq' | 'sq-AL' | 'sq-MK' | 'sr' | 'sr-Cyrl' | 'sr-Cyrl-BA' | 'sr-Cyrl-ME' | 'sr-Cyrl-RS' | 'sr-Latn' | 'sr-Latn-BA' | 'sr-Latn-ME' | 'sr-Latn-RS' | 'sr-ME' | 'sr-RS' | 'ss-ZA' | 'st-ZA' | 'sv' | 'sv-FI' | 'sv-SE' | 'sw' | 'sw-KE' | 'sw-TZ' | 'ta' | 'ta-IN' | 'ta-LK' | 'te' | 'te-IN' | 'teo' | 'teo-KE' | 'teo-UG' | 'tg-TJ' | 'th' | 'th-TH' | 'ti' | 'ti-ER' | 'ti-ET' | 'tig-ER' | 'tk-TM' | 'tl-PH' | 'tn-ZA' | 'to' | 'to-TO' | 'tr' | 'tr-CY' | 'tr-TR' | 'ts-ZA' | 'tt-RU' | 'tzm' | 'tzm-Latn' | 'tzm-Latn-MA' | 'ug-CN' | 'uk' | 'uk-UA' | 'unm-US' | 'ur' | 'ur-IN' | 'ur-PK' | 'uz' | 'uz-Arab' | 'uz-Arab-AF' | 'uz-Cyrl' | 'uz-Cyrl-UZ' | 'uz-Latn' | 'uz-Latn-UZ' | 'uz-UZ' | 've-ZA' | 'vi' | 'vi-VN' | 'vun' | 'vun-TZ' | 'wa-BE' | 'wae-CH' | 'wal-ET' | 'wo-SN' | 'xh-ZA' | 'xog' | 'xog-UG' | 'yi-US' | 'yo' | 'yo-NG' | 'yue-HK' | 'zh' | 'zh-CN' | 'zh-HK' | 'zh-Hans' | 'zh-Hans-CN' | 'zh-Hans-HK' | 'zh-Hans-MO' | 'zh-Hans-SG' | 'zh-Hant' | 'zh-Hant-HK' | 'zh-Hant-MO' | 'zh-Hant-TW' | 'zh-SG' | 'zh-TW' | 'zu' | 'zu-ZA' | 'auto';
+        /**
+         * HTTP method for the request
+         */
+        method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+        /**
+         * Filters for capturing network traffic
+         */
+        network_capture?: Array<Param.NetworkCapture>;
+        /**
+         * Operating system to emulate
+         */
+        os?: 'windows' | 'mac os' | 'linux' | 'android' | 'ios';
+        /**
+         * Whether to parse the response content
+         */
+        parse?: boolean;
+        /**
+         * Custom parser configuration as a key-value map
+         */
+        parser?: {
+            [key: string]: unknown;
+        } | string;
+        /**
+         * Referrer policy for the request
+         */
+        referrer_type?: 'random' | 'no-referer' | 'same-origin' | 'google' | 'bing' | 'facebook' | 'twitter' | 'instagram';
+        /**
+         * Whether to render JavaScript content using a browser
+         */
+        render?: boolean;
+        /**
+         * Request timeout in milliseconds
+         */
+        request_timeout?: number;
+        session?: Param.Session;
+        /**
+         * Skills or capabilities required for the request
+         */
+        skill?: string | Array<string>;
+        /**
+         * US state for geolocation (only valid when country is US)
+         */
+        state?: 'AL' | 'AK' | 'AS' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'UT' | 'VT' | 'VA' | 'VI' | 'WA' | 'WV' | 'WI' | 'WY';
+        /**
+         * User-defined tag for request identification
+         */
+        tag?: string;
+    }
+    namespace Param {
+        interface UnionMember1 {
+            name: 'chrome' | 'firefox';
+            /**
+             * Specific browser version to emulate
+             */
+            version?: string;
+        }
+        interface UnionMember0 {
+            creation?: string | null;
+            domain?: string | null;
+            expires?: string;
+            extensions?: Array<string> | null;
+            hostOnly?: boolean | null;
+            httpOnly?: boolean | null;
+            lastAccessed?: string | null;
+            maxAge?: 'Infinity' | '-Infinity' | number | null;
+            name?: string;
+            path?: string | null;
+            pathIsDefault?: boolean | null;
+            sameSite?: 'strict' | 'lax' | 'none';
+            secure?: boolean;
+            value?: string;
+            [k: string]: unknown;
+        }
+        interface NetworkCapture {
+            method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
+            /**
+             * Resource type for network capture filtering
+             */
+            resource_type?: string | Array<string>;
+            status_code?: number | Array<number>;
+            url?: NetworkCapture.URL;
+            validation?: boolean;
+            wait_for_requests_count?: number;
+            wait_for_requests_count_timeout?: number;
+        }
+        namespace NetworkCapture {
+            interface URL {
+                value: string;
+                type?: 'exact' | 'contains';
+            }
+        }
+        interface Session {
+            id?: string;
+            prefetch_userbrowser?: boolean;
+            retry?: boolean;
+            timeout?: number;
+        }
+    }
+    /**
+     * Shared parameters applied to the entire batch, such as storage and callback
+     * configuration.
+     */
+    interface SharedParams {
+        /**
+         * URL to call back when async operation completes
+         */
+        callback_url?: string;
+        /**
+         * Whether to compress stored data
+         */
+        storage_compress?: boolean;
+        /**
+         * Custom name for the stored object
+         */
+        storage_object_name?: string;
+        /**
+         * Type of storage to use for results
+         */
+        storage_type?: string;
+        /**
+         * URL for storage location
+         */
+        storage_url?: string;
+    }
+}
 export interface MapParams {
     /**
      * Url to map.
@@ -849,6 +1125,6 @@ export interface SearchParams {
     time_range?: 'hour' | 'day' | 'week' | 'month' | 'year' | null;
 }
 export declare namespace TopLevel {
-    export { type ExtractResponse as ExtractResponse, type ExtractAsyncResponse as ExtractAsyncResponse, type MapResponse as MapResponse, type SearchResponse as SearchResponse, type ExtractParams as ExtractParams, type ExtractAsyncParams as ExtractAsyncParams, type MapParams as MapParams, type SearchParams as SearchParams, };
+    export { type ExtractResponse as ExtractResponse, type ExtractAsyncResponse as ExtractAsyncResponse, type ExtractBatchResponse as ExtractBatchResponse, type MapResponse as MapResponse, type SearchResponse as SearchResponse, type ExtractParams as ExtractParams, type ExtractAsyncParams as ExtractAsyncParams, type ExtractBatchParams as ExtractBatchParams, type MapParams as MapParams, type SearchParams as SearchParams, };
 }
 //# sourceMappingURL=top-level.d.mts.map