@nimble-way/nimble-js 0.17.0 → 0.19.0

package/src/resources/jobs/runs/artifacts.ts

@@ -50,43 +50,110 @@ export class Artifacts extends APIResource {
   }
 }
 
+/**
+ * Artifacts produced by a run.
+ */
 export interface ArtifactListResponse {
+  /**
+   * Artifacts produced by the run.
+   */
   items: Array<ArtifactListResponse.Item>;
 }
 
 export namespace ArtifactListResponse {
+  /**
+   * A file produced by a run.
+   *
+   * Intentional subset of the bakery Artifact: `data_format` and `s3_path` are
+   * hidden from SDK consumers — internal storage details, not part of the public
+   * contract. Use the download-url endpoint to fetch the file. Bakery emits `id` as
+   * an int (crawlit native); the SDK contract is a string.
+   */
   export interface Item {
+    /**
+     * Artifact identifier.
+     */
     id: string;
 
+    /**
+     * When the artifact was created.
+     */
     created_at: string;
 
+    /**
+     * Human-readable artifact description.
+     */
     description: string;
 
+    /**
+     * Artifact type.
+     */
     type: string;
   }
 }
 
+/**
+ * A pre-signed URL for downloading an artifact.
+ */
 export interface ArtifactDownloadURLResponse {
+  /**
+   * When the download URL expires.
+   */
   expires_at: string;
 
+  /**
+   * Pre-signed URL to download the artifact.
+   */
   url: string;
 }
 
+/**
+ * A file produced by a run.
+ *
+ * Intentional subset of the bakery Artifact: `data_format` and `s3_path` are
+ * hidden from SDK consumers — internal storage details, not part of the public
+ * contract. Use the download-url endpoint to fetch the file. Bakery emits `id` as
+ * an int (crawlit native); the SDK contract is a string.
+ */
 export interface ArtifactGetResponse {
+  /**
+   * Artifact identifier.
+   */
   id: string;
 
+  /**
+   * When the artifact was created.
+   */
   created_at: string;
 
+  /**
+   * Human-readable artifact description.
+   */
   description: string;
 
+  /**
+   * Artifact type.
+   */
   type: string;
 }
 
+/**
+ * A tabular preview of an artifact's contents.
+ */
 export interface ArtifactPreviewResponse {
+  /**
+   * Column names in the preview.
+   */
   columns: Array<string>;
 
+  /**
+   * Total number of rows in the artifact.
+   */
   row_count: number;
 
+  /**
+   * Sample rows from the artifact.
+   */
   rows: Array<{ [key: string]: unknown }>;
 }
 

package/src/resources/jobs/runs/runs.ts

@@ -45,100 +45,239 @@ export class Runs extends APIResource {
   }
 }
 
+/**
+ * A page of job runs.
+ */
 export interface RunListResponse {
+  /**
+   * Runs on this page.
+   */
   items: Array<RunListResponse.Item>;
 
+  /**
+   * Current page number.
+   */
   page: number;
 
+  /**
+   * Number of items per page.
+   */
   per_page: number;
 
+  /**
+   * Total number of runs matching the query.
+   */
   total: number;
 }
 
 export namespace RunListResponse {
+  /**
+   * A single execution of a job.
+   */
   export interface Item {
+    /**
+     * 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;
   }
 }
 
+/**
+ * Result of cancelling a run.
+ */
 export interface RunCancelResponse {
+  /**
+   * Identifier of the cancelled run.
+   */
   id: string;
 
+  /**
+   * Run status after cancellation.
+   */
   status: 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING';
 }
 
+/**
+ * Full detail for a single run.
+ */
 export interface RunGetResponse {
+  /**
+   * Unique run identifier (run\_<n>).
+   */
   id: string;
 
+  /**
+   * When the run was created.
+   */
   created_at: string;
 
+  /**
+   * Context of the job this run belongs to.
+   */
   job: RunGetResponse.Job;
 
+  /**
+   * Current run status.
+   */
   status: 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING';
 
+  /**
+   * What triggered the run: 'schedule' or 'manual'.
+   */
   triggered_by: 'schedule' | 'manual';
 
+  /**
+   * Error details for a failed run.
+   */
   error?: RunGetResponse.Error | null;
 
+  /**
+   * When the run finished.
+   */
   finished_at?: string | null;
 
+  /**
+   * Sample of the run's input records.
+   */
   inputs_sample?: Array<unknown> | null;
 
+  /**
+   * When the run started executing.
+   */
   started_at?: string | null;
 
+  /**
+   * Aggregate metrics for a run.
+   */
   summary?: RunGetResponse.Summary | null;
 }
 
 export namespace RunGetResponse {
+  /**
+   * Context of the job this run belongs to.
+   */
   export interface Job {
+    /**
+     * Unique job identifier (job\_<n>).
+     */
     id: string;
 
+    /**
+     * Internal job name.
+     */
     name: string;
 
+    /**
+     * Name of the agent this job runs.
+     */
     agent_name?: string | null;
 
+    /**
+     * Human-friendly job name shown in the UI.
+     */
     display_name?: string | null;
 
+    /**
+     * Cron-based schedule controlling when a job runs automatically.
+     */
     schedule?: Job.Schedule | null;
   }
 
   export namespace Job {
+    /**
+     * Cron-based schedule controlling when a job runs automatically.
+     */
     export interface Schedule {
+      /**
+       * Cron expression defining when the job runs.
+       */
       cron: string;
 
+      /**
+       * Whether the schedule is currently active.
+       */
       enabled: boolean;
     }
   }
 
+  /**
+   * Error details for a failed run.
+   */
   export interface Error {
+    /**
+     * Sample of individual error records from the run.
+     */
     errors_sample?: Array<{ [key: string]: unknown }> | null;
 
+    /**
+     * Human-readable error message.
+     */
     message?: string | null;
 
+    /**
+     * Pipeline step where the error occurred.
+     */
     step?: string | null;
   }
 
+  /**
+   * Aggregate metrics for a run.
+   */
   export interface Summary {
+    /**
+     * Number of input records processed.
+     */
     input_count?: number | null;
 
+    /**
+     * Fraction of inputs that produced a result (result_count / input_count), from 0.0
+     * to 1.0.
+     */
     match_rate?: number | null;
 
+    /**
+     * Number of result records produced.
+     */
     result_count?: number | null;
   }
 }

package/src/resources/media.ts

@@ -440,7 +440,7 @@ export namespace MediaRunAsyncResponse {
     /**
      * Current state of the task.
      */
-    state: 'pending' | 'success' | 'error';
+    state: 'pending' | 'queued' | 'in_progress' | 'success' | 'error';
 
     /**
      * URL for checking the task status.
@@ -452,27 +452,27 @@ export namespace MediaRunAsyncResponse {
      */
     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.
@@ -482,7 +482,12 @@ export namespace MediaRunAsyncResponse {
     /**
      * 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.

package/src/resources/serp.ts

@@ -454,7 +454,7 @@ export namespace SerpRunAsyncResponse {
     /**
      * Current state of the task.
      */
-    state: 'pending' | 'success' | 'error';
+    state: 'pending' | 'queued' | 'in_progress' | 'success' | 'error';
 
     /**
      * URL for checking the task status.
@@ -466,27 +466,27 @@ export namespace SerpRunAsyncResponse {
      */
     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.
@@ -496,7 +496,12 @@ export namespace SerpRunAsyncResponse {
     /**
      * 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.
@@ -547,7 +552,7 @@ export namespace SerpRunBatchResponse {
     /**
      * Current state of the task.
      */
-    state: 'pending' | 'success' | 'error';
+    state: 'pending' | 'queued' | 'in_progress' | 'success' | 'error';
 
     /**
      * URL for checking the task status.
@@ -559,27 +564,27 @@ export namespace SerpRunBatchResponse {
      */
     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.
@@ -589,7 +594,12 @@ export namespace SerpRunBatchResponse {
     /**
      * 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.