@nimble-way/nimble-js 0.19.0 → 1.0.0

package/src/resources/extract/templates/versions.ts

@@ -0,0 +1,284 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Versions extends APIResource {
+  /**
+   * List Extract Template Versions Public V2
+   *
+   * @example
+   * ```ts
+   * const versions =
+   *   await client.extract.templates.versions.list(
+   *     'extract_template_name',
+   *   );
+   * ```
+   */
+  list(
+    extractTemplateName: string,
+    query: VersionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<VersionListResponse> {
+    return this._client.get(path`/v2/extract/templates/${extractTemplateName}/versions`, {
+      query,
+      ...options,
+    });
+  }
+
+  /**
+   * Get Extract Template Version Public V2
+   *
+   * @example
+   * ```ts
+   * const version = await client.extract.templates.versions.get(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   *   { extract_template_name: 'extract_template_name' },
+   * );
+   * ```
+   */
+  get(versionID: string, params: VersionGetParams, options?: RequestOptions): APIPromise<VersionGetResponse> {
+    const { extract_template_name } = params;
+    return this._client.get(
+      path`/v2/extract/templates/${extract_template_name}/versions/${versionID}`,
+      options,
+    );
+  }
+}
+
+export interface VersionListResponse {
+  /**
+   * Items returned in this page.
+   */
+  items: Array<VersionListResponse.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 VersionListResponse {
+  export interface Item {
+    /**
+     * Unique extract template version identifier.
+     */
+    id: string;
+
+    /**
+     * When the version was created.
+     */
+    created_at: string;
+
+    /**
+     * JSON schema describing accepted input parameters.
+     */
+    input_schema: { [key: string]: unknown };
+
+    /**
+     * Metadata associated with this version.
+     */
+    metadata: Item.Metadata;
+
+    /**
+     * Extract template name this version belongs to.
+     */
+    name: string;
+
+    /**
+     * JSON schema describing extracted output.
+     */
+    output_schema: { [key: string]: unknown };
+
+    /**
+     * Monotonic version number for the extract template.
+     */
+    version_number: number;
+
+    /**
+     * Sample input and output pairs for the version.
+     */
+    samples?: Array<Item.Sample> | null;
+  }
+
+  export namespace Item {
+    /**
+     * Metadata associated with this version.
+     */
+    export interface Metadata {
+      /**
+       * Data source associated with the version.
+       */
+      data_source?: string | null;
+
+      /**
+       * Version description shown to users.
+       */
+      description?: string | null;
+
+      /**
+       * Human-friendly version display name.
+       */
+      display_name?: string | null;
+
+      /**
+       * Domain associated with the version.
+       */
+      domain?: string | null;
+
+      /**
+       * Entity type produced by the version.
+       */
+      entity_type?: string | null;
+
+      /**
+       * Tags associated with the version.
+       */
+      tags?: Array<string>;
+
+      /**
+       * Business vertical associated with the version.
+       */
+      vertical?: string | null;
+    }
+
+    export interface Sample {
+      /**
+       * Sample input parameters for the version.
+       */
+      input?: unknown;
+
+      /**
+       * Sample output produced by the version.
+       */
+      output?: unknown;
+    }
+  }
+}
+
+export interface VersionGetResponse {
+  /**
+   * Unique extract template version identifier.
+   */
+  id: string;
+
+  /**
+   * When the version was created.
+   */
+  created_at: string;
+
+  /**
+   * JSON schema describing accepted input parameters.
+   */
+  input_schema: { [key: string]: unknown };
+
+  /**
+   * Metadata associated with this version.
+   */
+  metadata: VersionGetResponse.Metadata;
+
+  /**
+   * Extract template name this version belongs to.
+   */
+  name: string;
+
+  /**
+   * JSON schema describing extracted output.
+   */
+  output_schema: { [key: string]: unknown };
+
+  /**
+   * Monotonic version number for the extract template.
+   */
+  version_number: number;
+
+  /**
+   * Sample input and output pairs for the version.
+   */
+  samples?: Array<VersionGetResponse.Sample> | null;
+}
+
+export namespace VersionGetResponse {
+  /**
+   * Metadata associated with this version.
+   */
+  export interface Metadata {
+    /**
+     * Data source associated with the version.
+     */
+    data_source?: string | null;
+
+    /**
+     * Version description shown to users.
+     */
+    description?: string | null;
+
+    /**
+     * Human-friendly version display name.
+     */
+    display_name?: string | null;
+
+    /**
+     * Domain associated with the version.
+     */
+    domain?: string | null;
+
+    /**
+     * Entity type produced by the version.
+     */
+    entity_type?: string | null;
+
+    /**
+     * Tags associated with the version.
+     */
+    tags?: Array<string>;
+
+    /**
+     * Business vertical associated with the version.
+     */
+    vertical?: string | null;
+  }
+
+  export interface Sample {
+    /**
+     * Sample input parameters for the version.
+     */
+    input?: unknown;
+
+    /**
+     * Sample output produced by the version.
+     */
+    output?: unknown;
+  }
+}
+
+export interface VersionListParams {
+  limit?: number;
+
+  offset?: number;
+}
+
+export interface VersionGetParams {
+  extract_template_name: string;
+}
+
+export declare namespace Versions {
+  export {
+    type VersionListResponse as VersionListResponse,
+    type VersionGetResponse as VersionGetResponse,
+    type VersionListParams as VersionListParams,
+    type VersionGetParams as VersionGetParams,
+  };
+}

package/src/resources/extract/templates.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './templates/index';

package/src/resources/extract.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './extract/index';

package/src/resources/fast-serp.ts

@@ -16,7 +16,7 @@ export class FastSerp extends APIResource {
    * ```
    */
   run(body: FastSerpRunParams, options?: RequestOptions): APIPromise<FastSerpRunResponse> {
-    return this._client.post('/v1/fast-serp', { body, ...options });
+    return this._client.post('/v2/fast-serp', { body, ...options });
   }
 }
 

package/src/resources/index.ts

@@ -2,20 +2,15 @@
 
 export * from './shared';
 export {
-  Agent,
+  Agents,
+  type AgentCreateResponse,
+  type AgentUpdateResponse,
   type AgentListResponse,
-  type AgentGenerateResponse,
   type AgentGetResponse,
-  type AgentGetGenerationResponse,
-  type AgentRunResponse,
-  type AgentRunAsyncResponse,
-  type AgentRunBatchResponse,
+  type AgentCreateParams,
+  type AgentUpdateParams,
   type AgentListParams,
-  type AgentGenerateParams,
-  type AgentRunParams,
-  type AgentRunAsyncParams,
-  type AgentRunBatchParams,
-} from './agent';
+} from './agents/agents';
 export { Batches, type BatchGetResponse, type BatchProgressResponse } from './batches';
 export {
   Crawl,
@@ -31,6 +26,15 @@ export {
   type DomainKnowledgeGetDriverResponse,
   type DomainKnowledgeGetDriverParams,
 } from './domain-knowledge';
+export {
+  Extract,
+  type ExtractAsyncResponse,
+  type ExtractBatchResponse,
+  type ExtractRunResponse,
+  type ExtractAsyncParams,
+  type ExtractBatchParams,
+  type ExtractRunParams,
+} from './extract/extract';
 export { FastSerp, type FastSerpRunResponse, type FastSerpRunParams } from './fast-serp';
 export {
   Jobs,
@@ -38,7 +42,6 @@ export {
   type JobUpdateResponse,
   type JobListResponse,
   type JobGetResponse,
-  type JobRunResponse,
   type JobCreateParams,
   type JobUpdateParams,
   type JobListParams,
@@ -59,18 +62,6 @@ export {
   type SerpRunAsyncParams,
   type SerpRunBatchParams,
 } from './serp';
-export {
-  TaskAgent,
-  type TaskAgentCreateResponse,
-  type TaskAgentUpdateResponse,
-  type TaskAgentListResponse,
-  type TaskAgentGetResponse,
-  type TaskAgentRunResponse,
-  type TaskAgentCreateParams,
-  type TaskAgentUpdateParams,
-  type TaskAgentListParams,
-  type TaskAgentRunParams,
-} from './task-agent/task-agent';
 export {
   Tasks,
   type TaskListResponse,
@@ -78,15 +69,4 @@ export {
   type TaskResultsResponse,
   type TaskListParams,
 } from './tasks';
-export {
-  type ExtractResponse,
-  type ExtractAsyncResponse,
-  type ExtractBatchResponse,
-  type MapResponse,
-  type SearchResponse,
-  type ExtractParams,
-  type ExtractAsyncParams,
-  type ExtractBatchParams,
-  type MapParams,
-  type SearchParams,
-} from './top-level';
+export { type MapResponse, type SearchResponse, type MapParams, type SearchParams } from './top-level';

package/src/resources/jobs/index.ts

@@ -6,13 +6,13 @@ export {
   type JobUpdateResponse,
   type JobListResponse,
   type JobGetResponse,
-  type JobRunResponse,
   type JobCreateParams,
   type JobUpdateParams,
   type JobListParams,
 } from './jobs';
 export {
   Runs,
+  type RunCreateResponse,
   type RunListResponse,
   type RunCancelResponse,
   type RunGetResponse,

package/src/resources/jobs/jobs.ts

@@ -2,7 +2,14 @@
 
 import { APIResource } from '../../core/resource';
 import * as RunsAPI from './runs/runs';
-import { RunCancelResponse, RunGetResponse, RunListParams, RunListResponse, Runs } from './runs/runs';
+import {
+  RunCancelResponse,
+  RunCreateResponse,
+  RunGetResponse,
+  RunListParams,
+  RunListResponse,
+  Runs,
+} from './runs/runs';
 import { APIPromise } from '../../core/api-promise';
 import { buildHeaders } from '../../internal/headers';
 import { RequestOptions } from '../../internal/request-options';
@@ -12,48 +19,41 @@ export class Jobs extends APIResource {
   runs: RunsAPI.Runs = new RunsAPI.Runs(this._client);
 
   /**
-   * Create Job
+   * Create Job Public V2
    */
   create(body: JobCreateParams, options?: RequestOptions): APIPromise<JobCreateResponse> {
-    return this._client.post('/v1/jobs', { body, ...options });
+    return this._client.post('/v2/jobs', { body, ...options });
   }
 
   /**
-   * Update Job
+   * Update Job Public V2
    */
   update(jobID: string, body: JobUpdateParams, options?: RequestOptions): APIPromise<JobUpdateResponse> {
-    return this._client.patch(path`/v1/jobs/${jobID}`, { body, ...options });
+    return this._client.patch(path`/v2/jobs/${jobID}`, { body, ...options });
   }
 
   /**
-   * List Jobs
+   * List Jobs Public V2
    */
   list(query: JobListParams | null | undefined = {}, options?: RequestOptions): APIPromise<JobListResponse> {
-    return this._client.get('/v1/jobs', { query, ...options });
+    return this._client.get('/v2/jobs', { query, ...options });
   }
 
   /**
-   * Delete Job
+   * Delete Job Public V2
    */
   delete(jobID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/v1/jobs/${jobID}`, {
+    return this._client.delete(path`/v2/jobs/${jobID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
   /**
-   * Get Job
+   * Get Job Public V2
    */
   get(jobID: string, options?: RequestOptions): APIPromise<JobGetResponse> {
-    return this._client.get(path`/v1/jobs/${jobID}`, options);
-  }
-
-  /**
-   * Trigger Run
-   */
-  run(jobID: string, options?: RequestOptions): APIPromise<JobRunResponse> {
-    return this._client.post(path`/v1/jobs/${jobID}/runs`, options);
+    return this._client.get(path`/v2/jobs/${jobID}`, options);
   }
 }
 
@@ -71,11 +71,6 @@ export interface JobCreateResponse {
    */
   name: string;
 
-  /**
-   * Name of the agent this job runs.
-   */
-  agent_name?: string | null;
-
   /**
    * When the job was created.
    */
@@ -96,6 +91,11 @@ export interface JobCreateResponse {
    */
   display_name?: string | null;
 
+  /**
+   * Name of the extract template this job runs.
+   */
+  extract_template_name?: string | null;
+
   /**
    * Configuration for the input data a job processes.
    */
@@ -195,11 +195,6 @@ export interface JobUpdateResponse {
    */
   name: string;
 
-  /**
-   * Name of the agent this job runs.
-   */
-  agent_name?: string | null;
-
   /**
    * When the job was created.
    */
@@ -220,6 +215,11 @@ export interface JobUpdateResponse {
    */
   display_name?: string | null;
 
+  /**
+   * Name of the extract template this job runs.
+   */
+  extract_template_name?: string | null;
+
   /**
    * Configuration for the input data a job processes.
    */
@@ -305,27 +305,24 @@ export namespace JobUpdateResponse {
   }
 }
 
-/**
- * A page of jobs.
- */
 export interface JobListResponse {
   /**
-   * Jobs on this page.
+   * Items returned in this page.
    */
   items: Array<JobListResponse.Item>;
 
   /**
-   * Current page number.
+   * Maximum number of items returned.
    */
-  page: number;
+  limit: number;
 
   /**
-   * Number of items per page.
+   * Number of items skipped before this page.
    */
-  per_page: number;
+  offset: number;
 
   /**
-   * Total number of jobs matching the query.
+   * Total number of items matching the query.
    */
   total: number;
 }
@@ -345,11 +342,6 @@ export namespace JobListResponse {
      */
     name: string;
 
-    /**
-     * Name of the agent this job runs.
-     */
-    agent_name?: string | null;
-
     /**
      * When the job was created.
      */
@@ -370,6 +362,11 @@ export namespace JobListResponse {
      */
     display_name?: string | null;
 
+    /**
+     * Name of the extract template this job runs.
+     */
+    extract_template_name?: string | null;
+
     /**
      * Configuration for the input data a job processes.
      */
@@ -478,11 +475,6 @@ export interface JobGetResponse {
    */
   name: string;
 
-  /**
-   * Name of the agent this job runs.
-   */
-  agent_name?: string | null;
-
   /**
    * When the job was created.
    */
@@ -503,6 +495,11 @@ export interface JobGetResponse {
    */
   display_name?: string | null;
 
+  /**
+   * Name of the extract template this job runs.
+   */
+  extract_template_name?: string | null;
+
   /**
    * Configuration for the input data a job processes.
    */
@@ -588,61 +585,11 @@ export namespace JobGetResponse {
   }
 }
 
-/**
- * A single execution of a job.
- */
-export interface JobRunResponse {
-  /**
-   * Unique run identifier (run\_<n>).
-   */
-  id: string;
-
-  /**
-   * When the run was created.
-   */
-  created_at: string;
-
-  /**
-   * Identifier of the job this run belongs to.
-   */
-  job_id: string;
-
-  /**
-   * Current run status.
-   */
-  status: 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING';
-
-  /**
-   * What triggered the run: 'schedule' or 'manual'.
-   */
-  triggered_by: 'schedule' | 'manual';
-
-  /**
-   * When the run finished.
-   */
-  finished_at?: string | null;
-
-  /**
-   * Number of input records processed.
-   */
-  input_count?: number | null;
-
-  /**
-   * Number of result records produced.
-   */
-  result_count?: number | null;
-
-  /**
-   * When the run started executing.
-   */
-  started_at?: string | null;
-}
-
 export interface JobCreateParams {
   /**
-   * Name of the agent to run.
+   * Name of the extract template to run.
    */
-  agent_name: string;
+  extract_template_name: string;
 
   /**
    * Job name.
@@ -821,19 +768,9 @@ export namespace JobUpdateParams {
 }
 
 export interface JobListParams {
-  /**
-   * Filter by agent name
-   */
-  agent_name?: string | null;
+  limit?: number;
 
-  page?: number;
-
-  per_page?: number;
-
-  /**
-   * Search by name or display name
-   */
-  q?: string | null;
+  offset?: number;
 }
 
 Jobs.Runs = Runs;
@@ -844,7 +781,6 @@ export declare namespace Jobs {
     type JobUpdateResponse as JobUpdateResponse,
     type JobListResponse as JobListResponse,
     type JobGetResponse as JobGetResponse,
-    type JobRunResponse as JobRunResponse,
     type JobCreateParams as JobCreateParams,
     type JobUpdateParams as JobUpdateParams,
     type JobListParams as JobListParams,
@@ -852,6 +788,7 @@ export declare namespace Jobs {
 
   export {
     Runs as Runs,
+    type RunCreateResponse as RunCreateResponse,
     type RunListResponse as RunListResponse,
     type RunCancelResponse as RunCancelResponse,
     type RunGetResponse as RunGetResponse,