@nimble-way/nimble-js 0.18.0 → 0.20.0

package/src/resources/task-agent/templates.ts

@@ -7,7 +7,9 @@ import { path } from '../../internal/utils/path';
 
 export class Templates extends APIResource {
   /**
-   * List all available Web Search Agent templates.
+   * List Templates
+   *
+   * @deprecated
    */
   list(
     query: TemplateListParams | null | undefined = {},
@@ -17,141 +19,303 @@ export class Templates extends APIResource {
   }
 
   /**
-   * Fetch a single Web Search Agent template by name.
+   * Get Template
+   *
+   * @deprecated
    */
   get(templateName: string, options?: RequestOptions): APIPromise<TemplateGetResponse> {
     return this._client.get(path`/v1/task-agents/templates/${templateName}`, options);
   }
 }
 
-export type TemplateListResponse = Array<TemplateListResponse.TemplateListResponseItem>;
+export interface TemplateListResponse {
+  /**
+   * Items returned in this page.
+   */
+  items: Array<TemplateListResponse.Item>;
+
+  /**
+   * Maximum number of items returned.
+   */
+  limit: number;
+
+  /**
+   * Number of items skipped before this page.
+   */
+  offset: number;
+
+  /**
+   * Total number of items matching the query.
+   */
+  total: number;
+}
 
 export namespace TemplateListResponse {
-  export interface TemplateListResponseItem {
+  export interface Item {
+    /**
+     * Unique template identifier (wsat\_<uuid>).
+     */
     id: string;
 
+    /**
+     * When the template was created.
+     */
     created_at: string;
 
+    /**
+     * Template description shown to users.
+     */
     description: string;
 
+    /**
+     * Human-friendly template name shown to users.
+     */
     display_name: string;
 
+    /**
+     * Domain expertise or operating context for the template.
+     */
     domain_expertise: string;
 
-    effort: string;
+    /**
+     * Default effort level for runs created from this template.
+     */
+    effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
 
-    goals: Array<TemplateListResponseItem.Goal>;
+    /**
+     * Ordered goals for the template.
+     */
+    goals: Array<Item.Goal>;
 
+    /**
+     * Icon identifier used when presenting the template.
+     */
     icon: string;
 
+    /**
+     * JSON schema describing the structured output the agent should produce.
+     */
     output_schema: { [key: string]: unknown } | null;
 
-    sources: Array<TemplateListResponseItem.Source>;
+    /**
+     * Ordered source groups for the template.
+     */
+    sources: Array<Item.Source>;
 
-    suggested_questions: Array<TemplateListResponseItem.SuggestedQuestion>;
+    /**
+     * Suggested prompts for the template.
+     */
+    suggested_questions: Array<Item.SuggestedQuestion>;
 
+    /**
+     * Stable template name used to create agent instances.
+     */
     template_name: string;
 
+    /**
+     * When the template was last updated.
+     */
     updated_at: string;
 
+    /**
+     * Primary use case supported by the template.
+     */
     use_case: 'research' | 'enrichment' | 'dataset_building';
   }
 
-  export namespace TemplateListResponseItem {
+  export namespace Item {
     export interface Goal {
+      /**
+       * Unique goal identifier (wsag\_<uuid>).
+       */
       id: string;
 
+      /**
+       * Goal text.
+       */
       goal: string;
 
+      /**
+       * Zero-based goal position.
+       */
       order: number;
     }
 
     export interface Source {
+      /**
+       * Unique source group identifier (wsas\_<uuid>).
+       */
       id: string;
 
+      /**
+       * Domains included in this source group.
+       */
       domains: Array<string>;
 
+      /**
+       * Zero-based source group position.
+       */
       order: number;
 
+      /**
+       * Source group title.
+       */
       title: string;
     }
 
     export interface SuggestedQuestion {
+      /**
+       * Unique suggested question identifier (wsasq\_<uuid>).
+       */
       id: string;
 
+      /**
+       * Zero-based suggested question position.
+       */
       order: number;
 
+      /**
+       * Suggested prompt text.
+       */
       question: string;
     }
   }
 }
 
 export interface TemplateGetResponse {
+  /**
+   * Unique template identifier (wsat\_<uuid>).
+   */
   id: string;
 
+  /**
+   * When the template was created.
+   */
   created_at: string;
 
+  /**
+   * Template description shown to users.
+   */
   description: string;
 
+  /**
+   * Human-friendly template name shown to users.
+   */
   display_name: string;
 
+  /**
+   * Domain expertise or operating context for the template.
+   */
   domain_expertise: string;
 
-  effort: string;
+  /**
+   * Default effort level for runs created from this template.
+   */
+  effort: 'low' | 'medium' | 'high' | 'x-high' | 'max';
 
+  /**
+   * Ordered goals for the template.
+   */
   goals: Array<TemplateGetResponse.Goal>;
 
+  /**
+   * Icon identifier used when presenting the template.
+   */
   icon: string;
 
+  /**
+   * JSON schema describing the structured output the agent should produce.
+   */
   output_schema: { [key: string]: unknown } | null;
 
+  /**
+   * Ordered source groups for the template.
+   */
   sources: Array<TemplateGetResponse.Source>;
 
+  /**
+   * Suggested prompts for the template.
+   */
   suggested_questions: Array<TemplateGetResponse.SuggestedQuestion>;
 
+  /**
+   * Stable template name used to create agent instances.
+   */
   template_name: string;
 
+  /**
+   * When the template was last updated.
+   */
   updated_at: string;
 
+  /**
+   * Primary use case supported by the template.
+   */
   use_case: 'research' | 'enrichment' | 'dataset_building';
 }
 
 export namespace TemplateGetResponse {
   export interface Goal {
+    /**
+     * Unique goal identifier (wsag\_<uuid>).
+     */
     id: string;
 
+    /**
+     * Goal text.
+     */
     goal: string;
 
+    /**
+     * Zero-based goal position.
+     */
     order: number;
   }
 
   export interface Source {
+    /**
+     * Unique source group identifier (wsas\_<uuid>).
+     */
     id: string;
 
+    /**
+     * Domains included in this source group.
+     */
     domains: Array<string>;
 
+    /**
+     * Zero-based source group position.
+     */
     order: number;
 
+    /**
+     * Source group title.
+     */
     title: string;
   }
 
   export interface SuggestedQuestion {
+    /**
+     * Unique suggested question identifier (wsasq\_<uuid>).
+     */
     id: string;
 
+    /**
+     * Zero-based suggested question position.
+     */
     order: number;
 
+    /**
+     * Suggested prompt text.
+     */
     question: string;
   }
 }
 
 export interface TemplateListParams {
-  effort?: string | null;
-
   limit?: number;
 
   offset?: number;
-
-  use_case?: string | null;
 }
 
 export declare namespace Templates {

package/src/resources/tasks.ts

@@ -82,22 +82,22 @@ export namespace TaskListResponse {
     /**
      * 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.
@@ -107,7 +107,7 @@ export namespace TaskListResponse {
     /**
      * Storage location of the output data.
      */
-    output_url?: string;
+    output_url?: string | null;
 
     /**
      * Queue name the task was submitted to.
@@ -184,22 +184,22 @@ export namespace TaskGetResponse {
     /**
      * 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.
@@ -209,7 +209,7 @@ export namespace TaskGetResponse {
     /**
      * Storage location of the output data.
      */
-    output_url?: string;
+    output_url?: string | null;
 
     /**
      * Queue name the task was submitted to.

package/src/resources/top-level.ts

@@ -425,22 +425,22 @@ export namespace ExtractAsyncResponse {
     /**
      * 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,7 @@ export namespace ExtractAsyncResponse {
     /**
      * Storage location of the output data.
      */
-    output_url?: string;
+    output_url?: string | null;
 
     /**
      * Queue name the task was submitted to.
@@ -523,22 +523,22 @@ export namespace ExtractBatchResponse {
     /**
      * 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.
@@ -548,7 +548,7 @@ export namespace ExtractBatchResponse {
     /**
      * Storage location of the output data.
      */
-    output_url?: string;
+    output_url?: string | null;
 
     /**
      * Queue name the task was submitted to.
@@ -1793,6 +1793,8 @@ export namespace ExtractParams {
 
     prefetch_userbrowser?: boolean;
 
+    renew_on_blocked?: boolean;
+
     retry?: boolean;
 
     timeout?: number;
@@ -2924,6 +2926,8 @@ export namespace ExtractAsyncParams {
 
     prefetch_userbrowser?: boolean;
 
+    renew_on_blocked?: boolean;
+
     retry?: boolean;
 
     timeout?: number;
@@ -4072,6 +4076,8 @@ export namespace ExtractBatchParams {
 
       prefetch_userbrowser?: boolean;
 
+      renew_on_blocked?: boolean;
+
       retry?: boolean;
 
       timeout?: number;
@@ -5209,6 +5215,8 @@ export namespace ExtractBatchParams {
 
       prefetch_userbrowser?: boolean;
 
+      renew_on_blocked?: boolean;
+
       retry?: boolean;
 
       timeout?: number;
@@ -6049,11 +6057,6 @@ export interface SearchParams {
    */
   country?: string;
 
-  /**
-   * Internal-only. Gated to allowlisted accounts; ignored otherwise.
-   */
-  debug_params?: { [key: string]: unknown } | null;
-
   /**
    * Deprecated. Use search_depth instead. true maps to 'deep', false maps to 'lite'.
    */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.18.0'; // x-release-please-version
+export const VERSION = '0.20.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.18.0";
+export declare const VERSION = "0.20.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.18.0'; // x-release-please-version
+exports.VERSION = '0.20.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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