@nimble-way/nimble-js 0.10.0 → 0.12.0

package/src/resources/agent.ts

@@ -7,7 +7,7 @@ import { path } from '../internal/utils/path';
 
 export class Agent extends APIResource {
   /**
-   * List Templates
+   * List Agent Templates
    */
   list(
     query: AgentListParams | null | undefined = {},
@@ -17,12 +17,37 @@ export class Agent extends APIResource {
   }
 
   /**
-   * Get Template
+   * Create Agent Generation
+   */
+  generate(body: AgentGenerateParams, options?: RequestOptions): APIPromise<AgentGenerateResponse> {
+    return this._client.post('/v1/agents/generations', { body, ...options });
+  }
+
+  /**
+   * Get Agent Template
    */
   get(templateName: string, options?: RequestOptions): APIPromise<AgentGetResponse> {
     return this._client.get(path`/v1/agents/${templateName}`, options);
   }
 
+  /**
+   * Get Agent Generation
+   */
+  getGeneration(generationID: string, options?: RequestOptions): APIPromise<AgentGetGenerationResponse> {
+    return this._client.get(path`/v1/agents/generations/${generationID}`, options);
+  }
+
+  /**
+   * Publish Agent Version
+   */
+  publish(
+    agentName: string,
+    body: AgentPublishParams,
+    options?: RequestOptions,
+  ): APIPromise<AgentPublishResponse> {
+    return this._client.post(path`/v1/agents/${agentName}/publish`, { body, ...options });
+  }
+
   /**
    * Execute WSA Realtime Endpoint
    */
@@ -36,6 +61,13 @@ export class Agent extends APIResource {
   runAsync(body: AgentRunAsyncParams, options?: RequestOptions): APIPromise<AgentRunAsyncResponse> {
     return this._client.post('/v1/agents/async', { body, ...options });
   }
+
+  /**
+   * Execute WSA Batch Endpoint
+   */
+  runBatch(body: AgentRunBatchParams, options?: RequestOptions): APIPromise<AgentRunBatchResponse> {
+    return this._client.post('/v1/agents/batch', { body, ...options });
+  }
 }
 
 export type AgentListResponse = Array<AgentListResponse.AgentListResponseItem>;
@@ -60,6 +92,30 @@ export namespace AgentListResponse {
   }
 }
 
+export interface AgentGenerateResponse {
+  id: string;
+
+  status: string;
+
+  agent_name?: string | null;
+
+  completed_at?: string | null;
+
+  created_at?: string | null;
+
+  error?: string | null;
+
+  generated_version?: unknown | null;
+
+  generated_version_id?: string | null;
+
+  source_version_id?: string | null;
+
+  started_at?: string | null;
+
+  summary?: string | null;
+}
+
 export interface AgentGetResponse {
   display_name: string;
 
@@ -110,6 +166,36 @@ export namespace AgentGetResponse {
   }
 }
 
+export interface AgentGetGenerationResponse {
+  id: string;
+
+  status: string;
+
+  agent_name?: string | null;
+
+  completed_at?: string | null;
+
+  created_at?: string | null;
+
+  error?: string | null;
+
+  generated_version?: unknown | null;
+
+  generated_version_id?: string | null;
+
+  source_version_id?: string | null;
+
+  started_at?: string | null;
+
+  summary?: string | null;
+}
+
+export interface AgentPublishResponse {
+  agent_name: string;
+
+  published_version_id: string;
+}
+
 export interface AgentRunResponse {
   data: AgentRunResponse.Data;
 
@@ -191,6 +277,11 @@ export namespace AgentRunResponse {
      */
     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.
      */
@@ -472,6 +563,99 @@ export interface AgentRunAsyncResponse {
   task: { [key: string]: unknown };
 }
 
+/**
+ * Response when a batch of extract tasks is created successfully.
+ */
+export interface AgentRunBatchResponse {
+  /**
+   * Unique identifier for the batch.
+   */
+  batch_id: string;
+
+  /**
+   * Number of tasks in the batch.
+   */
+  batch_size: number;
+
+  /**
+   * List of created tasks.
+   */
+  tasks: Array<AgentRunBatchResponse.Task>;
+}
+
+export namespace AgentRunBatchResponse {
+  export 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;
+  }
+}
+
 export interface AgentListParams {
   /**
    * Number of results per page
@@ -499,11 +683,46 @@ export interface AgentListParams {
   search?: string | null;
 }
 
+export type AgentGenerateParams =
+  | AgentGenerateParams.CreateAgentGenerationRequest
+  | AgentGenerateParams.CreateAgentRefinementRequest;
+
+export declare namespace AgentGenerateParams {
+  export interface CreateAgentGenerationRequest {
+    agent_name: string;
+
+    prompt: string;
+
+    url: string;
+
+    input_schema?: unknown;
+
+    metadata?: unknown | null;
+
+    output_schema?: unknown;
+  }
+
+  export interface CreateAgentRefinementRequest {
+    from_agent: string;
+
+    prompt: string;
+  }
+}
+
+export interface AgentPublishParams {
+  version_id: string;
+}
+
 export interface AgentRunParams {
   agent: string;
 
   params: { [key: string]: unknown };
 
+  /**
+   * Response formats to include. All disabled by default.
+   */
+  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+
   localization?: boolean;
 }
 
@@ -517,6 +736,11 @@ export interface AgentRunAsyncParams {
    */
   callback_url?: string;
 
+  /**
+   * Response formats to include. All disabled by default.
+   */
+  formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+
   localization?: boolean;
 
   /**
@@ -540,14 +764,53 @@ export interface AgentRunAsyncParams {
   storage_url?: string;
 }
 
+export interface AgentRunBatchParams {
+  inputs: Array<AgentRunBatchParams.Input>;
+
+  shared_inputs: AgentRunBatchParams.SharedInputs;
+}
+
+export namespace AgentRunBatchParams {
+  export interface Input {
+    /**
+     * Response formats to include. All disabled by default.
+     */
+    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+
+    localization?: boolean;
+
+    params?: { [key: string]: unknown };
+  }
+
+  export interface SharedInputs {
+    agent: string;
+
+    /**
+     * Response formats to include. All disabled by default.
+     */
+    formats?: Array<'html' | 'markdown' | 'screenshot' | 'headers'>;
+
+    localization?: boolean;
+
+    params?: { [key: string]: unknown };
+  }
+}
+
 export declare namespace Agent {
   export {
     type AgentListResponse as AgentListResponse,
+    type AgentGenerateResponse as AgentGenerateResponse,
     type AgentGetResponse as AgentGetResponse,
+    type AgentGetGenerationResponse as AgentGetGenerationResponse,
+    type AgentPublishResponse as AgentPublishResponse,
     type AgentRunResponse as AgentRunResponse,
     type AgentRunAsyncResponse as AgentRunAsyncResponse,
+    type AgentRunBatchResponse as AgentRunBatchResponse,
     type AgentListParams as AgentListParams,
+    type AgentGenerateParams as AgentGenerateParams,
+    type AgentPublishParams as AgentPublishParams,
     type AgentRunParams as AgentRunParams,
     type AgentRunAsyncParams as AgentRunAsyncParams,
+    type AgentRunBatchParams as AgentRunBatchParams,
   };
 }

package/src/resources/index.ts

@@ -4,12 +4,19 @@ export * from './shared';
 export {
   Agent,
   type AgentListResponse,
+  type AgentGenerateResponse,
   type AgentGetResponse,
+  type AgentGetGenerationResponse,
+  type AgentPublishResponse,
   type AgentRunResponse,
   type AgentRunAsyncResponse,
+  type AgentRunBatchResponse,
   type AgentListParams,
+  type AgentGenerateParams,
+  type AgentPublishParams,
   type AgentRunParams,
   type AgentRunAsyncParams,
+  type AgentRunBatchParams,
 } from './agent';
 export { Batches, type BatchGetResponse, type BatchProgressResponse } from './batches';
 export {

package/src/resources/top-level.ts

@@ -83,6 +83,11 @@ export namespace ExtractResponse {
      */
     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.
      */

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.10.0'; // x-release-please-version
+export const VERSION = '0.12.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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