@nimble-way/nimble-js 0.17.0 → 0.19.0

package/src/resources/top-level.ts

@@ -408,7 +408,7 @@ export namespace ExtractAsyncResponse {
     /**
      * Current state of the task.
      */
-    state: 'pending' | 'success' | 'error';
+    state: 'pending' | 'queued' | 'in_progress' | 'success' | 'error';
 
     /**
      * URL for checking the task status.
@@ -420,27 +420,27 @@ export namespace ExtractAsyncResponse {
      */
     account_name?: string;
 
-    api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'media' | 'agent' | 'extract' | 'fast-serp';
+    api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'media' | 'agent' | 'extract' | 'fast-serp' | 'labs';
 
     /**
      * Batch ID if this task is part of a batch.
      */
-    batch_id?: string;
+    batch_id?: string | null;
 
     /**
      * URL for downloading the task results.
      */
-    download_url?: string;
+    download_url?: string | null;
 
     /**
      * Error message if the task failed.
      */
-    error?: string;
+    error?: string | null;
 
     /**
      * Classification of the error type.
      */
-    error_type?: string;
+    error_type?: string | null;
 
     /**
      * Timestamp when the task was last modified.
@@ -450,7 +450,12 @@ export namespace ExtractAsyncResponse {
     /**
      * Storage location of the output data.
      */
-    output_url?: string;
+    output_url?: string | null;
+
+    /**
+     * Queue name the task was submitted to.
+     */
+    queue?: string;
 
     /**
      * HTTP status code from the task execution.
@@ -501,7 +506,7 @@ export namespace ExtractBatchResponse {
     /**
      * Current state of the task.
      */
-    state: 'pending' | 'success' | 'error';
+    state: 'pending' | 'queued' | 'in_progress' | 'success' | 'error';
 
     /**
      * URL for checking the task status.
@@ -513,27 +518,27 @@ export namespace ExtractBatchResponse {
      */
     account_name?: string;
 
-    api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'media' | 'agent' | 'extract' | 'fast-serp';
+    api_type?: 'web' | 'serp' | 'ecommerce' | 'social' | 'media' | 'agent' | 'extract' | 'fast-serp' | 'labs';
 
     /**
      * Batch ID if this task is part of a batch.
      */
-    batch_id?: string;
+    batch_id?: string | null;
 
     /**
      * URL for downloading the task results.
      */
-    download_url?: string;
+    download_url?: string | null;
 
     /**
      * Error message if the task failed.
      */
-    error?: string;
+    error?: string | null;
 
     /**
      * Classification of the error type.
      */
-    error_type?: string;
+    error_type?: string | null;
 
     /**
      * Timestamp when the task was last modified.
@@ -543,7 +548,12 @@ export namespace ExtractBatchResponse {
     /**
      * Storage location of the output data.
      */
-    output_url?: string;
+    output_url?: string | null;
+
+    /**
+     * Queue name the task was submitted to.
+     */
+    queue?: string;
 
     /**
      * HTTP status code from the task execution.
@@ -607,6 +617,12 @@ export interface SearchResponse {
    * Citations mapping citation markers to result indices
    */
   answer_citations?: Array<SearchResponse.AnswerCitation> | null;
+
+  /**
+   * Cleaned SERP entities (e.g. KnowledgeGraph, TopStory, RelatedSearch). Only
+   * present for focus='serp'.
+   */
+  serp_data?: { [key: string]: unknown } | null;
 }
 
 export namespace SearchResponse {
@@ -683,6 +699,14 @@ export interface ExtractParams {
    */
   url: string;
 
+  /**
+   * Custom flow for the optimization engine: maps candidate names to the number of
+   * attempts to spend on each candidate before advancing (0 skips it). Key order
+   * defines the flow order. Providing it opts the request into 'auto' driver
+   * selection.
+   */
+  auto_driver_configuration?: { [key: string]: number };
+
   /**
    * Request body for POST, PUT, PATCH methods
    */
@@ -991,7 +1015,17 @@ export interface ExtractParams {
   /**
    * Browser driver to use
    */
-  driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6';
+  driver?:
+    | 'auto'
+    | 'vx6'
+    | 'vx8'
+    | 'vx8-pro'
+    | 'vx10'
+    | 'vx10-pro'
+    | 'vx12'
+    | 'vx12-pro'
+    | 'media-vx6'
+    | 'fast-vx6';
 
   /**
    * Expected HTTP status codes for successful requests
@@ -1759,6 +1793,8 @@ export namespace ExtractParams {
 
     prefetch_userbrowser?: boolean;
 
+    renew_on_blocked?: boolean;
+
     retry?: boolean;
 
     timeout?: number;
@@ -1771,6 +1807,14 @@ export interface ExtractAsyncParams {
    */
   url: string;
 
+  /**
+   * Custom flow for the optimization engine: maps candidate names to the number of
+   * attempts to spend on each candidate before advancing (0 skips it). Key order
+   * defines the flow order. Providing it opts the request into 'auto' driver
+   * selection.
+   */
+  auto_driver_configuration?: { [key: string]: number };
+
   /**
    * Request body for POST, PUT, PATCH methods
    */
@@ -2084,7 +2128,17 @@ export interface ExtractAsyncParams {
   /**
    * Browser driver to use
    */
-  driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6';
+  driver?:
+    | 'auto'
+    | 'vx6'
+    | 'vx8'
+    | 'vx8-pro'
+    | 'vx10'
+    | 'vx10-pro'
+    | 'vx12'
+    | 'vx12-pro'
+    | 'media-vx6'
+    | 'fast-vx6';
 
   /**
    * Expected HTTP status codes for successful requests
@@ -2872,6 +2926,8 @@ export namespace ExtractAsyncParams {
 
     prefetch_userbrowser?: boolean;
 
+    renew_on_blocked?: boolean;
+
     retry?: boolean;
 
     timeout?: number;
@@ -2894,6 +2950,14 @@ export interface ExtractBatchParams {
 
 export namespace ExtractBatchParams {
   export interface Input {
+    /**
+     * Custom flow for the optimization engine: maps candidate names to the number of
+     * attempts to spend on each candidate before advancing (0 skips it). Key order
+     * defines the flow order. Providing it opts the request into 'auto' driver
+     * selection.
+     */
+    auto_driver_configuration?: { [key: string]: number };
+
     /**
      * Request body for POST, PUT, PATCH methods
      */
@@ -3205,9 +3269,20 @@ export namespace ExtractBatchParams {
     device?: 'desktop' | 'mobile' | 'tablet';
 
     /**
-     * Browser driver to use
+     * Browser driver to use. Use 'auto' to let the engine select the candidate config
+     * per domain.
      */
-    driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6';
+    driver?:
+      | 'auto'
+      | 'vx6'
+      | 'vx8'
+      | 'vx8-pro'
+      | 'vx10'
+      | 'vx10-pro'
+      | 'vx12'
+      | 'vx12-pro'
+      | 'media-vx6'
+      | 'fast-vx6';
 
     /**
      * Expected HTTP status codes for successful requests
@@ -4001,6 +4076,8 @@ export namespace ExtractBatchParams {
 
       prefetch_userbrowser?: boolean;
 
+      renew_on_blocked?: boolean;
+
       retry?: boolean;
 
       timeout?: number;
@@ -4012,6 +4089,14 @@ export namespace ExtractBatchParams {
    * and async/storage settings.
    */
   export interface SharedInputs {
+    /**
+     * Custom flow for the optimization engine: maps candidate names to the number of
+     * attempts to spend on each candidate before advancing (0 skips it). Key order
+     * defines the flow order. Providing it opts the request into 'auto' driver
+     * selection.
+     */
+    auto_driver_configuration?: { [key: string]: number };
+
     /**
      * Request body for POST, PUT, PATCH methods
      */
@@ -4323,9 +4408,20 @@ export namespace ExtractBatchParams {
     device?: 'desktop' | 'mobile' | 'tablet';
 
     /**
-     * Browser driver to use
+     * Browser driver to use. Use 'auto' to let the engine select the candidate config
+     * per domain.
      */
-    driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro' | 'media-vx6';
+    driver?:
+      | 'auto'
+      | 'vx6'
+      | 'vx8'
+      | 'vx8-pro'
+      | 'vx10'
+      | 'vx10-pro'
+      | 'vx12'
+      | 'vx12-pro'
+      | 'media-vx6'
+      | 'fast-vx6';
 
     /**
      * Expected HTTP status codes for successful requests
@@ -5119,6 +5215,8 @@ export namespace ExtractBatchParams {
 
       prefetch_userbrowser?: boolean;
 
+      renew_on_blocked?: boolean;
+
       retry?: boolean;
 
       timeout?: number;

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.17.0'; // x-release-please-version
+export const VERSION = '0.19.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.17.0";
+export declare const VERSION = "0.19.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.17.0";
+export declare const VERSION = "0.19.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.17.0'; // x-release-please-version
+exports.VERSION = '0.19.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.17.0'; // x-release-please-version
+export const VERSION = '0.19.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map