@nimble-way/nimble-js 0.20.0 → 1.0.0

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

@@ -7,18 +7,14 @@ import { path } from '../../../internal/utils/path';
 
 export class Artifacts extends APIResource {
   /**
-   * List Run Artifacts
-   *
-   * @deprecated
+   * List Run Artifacts Public V2
    */
   list(runID: string, options?: RequestOptions): APIPromise<ArtifactListResponse> {
-    return this._client.get(path`/v1/jobs/runs/${runID}/artifacts`, options);
+    return this._client.get(path`/v2/jobs/runs/${runID}/artifacts`, options);
   }
 
   /**
-   * Get Run Artifact Download URL
-   *
-   * @deprecated
+   * Get Run Artifact Download Url Public V2
    */
   downloadURL(
     artifactID: number,
@@ -26,13 +22,11 @@ export class Artifacts extends APIResource {
     options?: RequestOptions,
   ): APIPromise<ArtifactDownloadURLResponse> {
     const { run_id } = params;
-    return this._client.get(path`/v1/jobs/runs/${run_id}/artifacts/${artifactID}/download-url`, options);
+    return this._client.get(path`/v2/jobs/runs/${run_id}/artifacts/${artifactID}/download-url`, options);
   }
 
   /**
-   * Get Run Artifact
-   *
-   * @deprecated
+   * Get Run Artifact Public V2
    */
   get(
     artifactID: number,
@@ -40,13 +34,11 @@ export class Artifacts extends APIResource {
     options?: RequestOptions,
   ): APIPromise<ArtifactGetResponse> {
     const { run_id } = params;
-    return this._client.get(path`/v1/jobs/runs/${run_id}/artifacts/${artifactID}`, options);
+    return this._client.get(path`/v2/jobs/runs/${run_id}/artifacts/${artifactID}`, options);
   }
 
   /**
-   * Preview Run Artifact
-   *
-   * @deprecated
+   * Preview Run Artifact Public V2
    */
   preview(
     artifactID: number,
@@ -54,7 +46,7 @@ export class Artifacts extends APIResource {
     options?: RequestOptions,
   ): APIPromise<ArtifactPreviewResponse> {
     const { run_id } = params;
-    return this._client.get(path`/v1/jobs/runs/${run_id}/artifacts/${artifactID}/preview`, options);
+    return this._client.get(path`/v2/jobs/runs/${run_id}/artifacts/${artifactID}/preview`, options);
   }
 }
 

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

@@ -12,6 +12,7 @@ export {
 } from './artifacts';
 export {
   Runs,
+  type RunCreateResponse,
   type RunListResponse,
   type RunCancelResponse,
   type RunGetResponse,

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

@@ -20,60 +20,108 @@ export class Runs extends APIResource {
   artifacts: ArtifactsAPI.Artifacts = new ArtifactsAPI.Artifacts(this._client);
 
   /**
-   * List Runs for Job
-   *
-   * @deprecated
+   * Trigger Job Run Public V2
+   */
+  create(jobID: string, options?: RequestOptions): APIPromise<RunCreateResponse> {
+    return this._client.post(path`/v2/jobs/${jobID}/runs`, options);
+  }
+
+  /**
+   * List Job Runs Public V2
    */
   list(
     jobID: string,
     query: RunListParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<RunListResponse> {
-    return this._client.get(path`/v1/jobs/${jobID}/runs`, { query, ...options });
+    return this._client.get(path`/v2/jobs/${jobID}/runs`, { query, ...options });
   }
 
   /**
-   * Cancel Run
-   *
-   * @deprecated
+   * Cancel Run Public V2
    */
   cancel(runID: string, options?: RequestOptions): APIPromise<RunCancelResponse> {
-    return this._client.post(path`/v1/jobs/runs/${runID}/cancel`, options);
+    return this._client.post(path`/v2/jobs/runs/${runID}/cancel`, options);
   }
 
   /**
-   * Get Run
-   *
-   * @deprecated
+   * Get Run Public V2
    */
   get(runID: string, options?: RequestOptions): APIPromise<RunGetResponse> {
-    return this._client.get(path`/v1/jobs/runs/${runID}`, options);
+    return this._client.get(path`/v2/jobs/runs/${runID}`, options);
   }
 }
 
 /**
- * A page of job runs.
+ * A single execution of a job.
  */
+export interface RunCreateResponse {
+  /**
+   * 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 RunListResponse {
   /**
-   * Runs on this page.
+   * Items returned in this page.
    */
   items: Array<RunListResponse.Item>;
 
   /**
-   * Total number of runs matching the query.
+   * Maximum number of items returned.
    */
-  total: number;
+  limit: number;
 
   /**
-   * Current page number.
+   * Number of items skipped before this page.
    */
-  page?: number;
+  offset: number;
 
   /**
-   * Number of items per page.
+   * Total number of items matching the query.
    */
-  per_page?: number;
+  total: number;
 }
 
 export namespace RunListResponse {
@@ -214,14 +262,14 @@ export namespace RunGetResponse {
     name: string;
 
     /**
-     * Name of the agent this job runs.
+     * Human-friendly job name shown in the UI.
      */
-    agent_name?: string | null;
+    display_name?: string | null;
 
     /**
-     * Human-friendly job name shown in the UI.
+     * Name of the extract template this job runs.
      */
-    display_name?: string | null;
+    extract_template_name?: string | null;
 
     /**
      * Cron-based schedule controlling when a job runs automatically.
@@ -289,20 +337,16 @@ export namespace RunGetResponse {
 }
 
 export interface RunListParams {
-  page?: number;
+  limit?: number;
 
-  per_page?: number;
-
-  /**
-   * Filter by status
-   */
-  status?: string | null;
+  offset?: number;
 }
 
 Runs.Artifacts = Artifacts;
 
 export declare namespace Runs {
   export {
+    type RunCreateResponse as RunCreateResponse,
     type RunListResponse as RunListResponse,
     type RunCancelResponse as RunCancelResponse,
     type RunGetResponse as RunGetResponse,

package/src/resources/media.ts

@@ -16,7 +16,7 @@ export class Media extends APIResource {
    * ```
    */
   run(body: MediaRunParams, options?: RequestOptions): APIPromise<MediaRunResponse> {
-    return this._client.post('/v1/media', { body, ...options });
+    return this._client.post('/v2/media', { body, ...options });
   }
 
   /**
@@ -30,7 +30,7 @@ export class Media extends APIResource {
    * ```
    */
   runAsync(body: MediaRunAsyncParams, options?: RequestOptions): APIPromise<MediaRunAsyncResponse> {
-    return this._client.post('/v1/media/async', { body, ...options });
+    return this._client.post('/v2/media/async', { body, ...options });
   }
 }
 

package/src/resources/serp.ts

@@ -16,7 +16,7 @@ export class Serp extends APIResource {
    * ```
    */
   run(body: SerpRunParams, options?: RequestOptions): APIPromise<SerpRunResponse> {
-    return this._client.post('/v1/serp', { body, ...options });
+    return this._client.post('/v2/serp', { body, ...options });
   }
 
   /**
@@ -30,7 +30,7 @@ export class Serp extends APIResource {
    * ```
    */
   runAsync(body: SerpRunAsyncParams, options?: RequestOptions): APIPromise<SerpRunAsyncResponse> {
-    return this._client.post('/v1/serp/async', { body, ...options });
+    return this._client.post('/v2/serp/async', { body, ...options });
   }
 
   /**
@@ -44,7 +44,7 @@ export class Serp extends APIResource {
    * ```
    */
   runBatch(body: SerpRunBatchParams, options?: RequestOptions): APIPromise<SerpRunBatchResponse> {
-    return this._client.post('/v1/serp/batch', { body, ...options });
+    return this._client.post('/v2/serp/batch', { body, ...options });
   }
 }
 

package/src/resources/tasks.ts

@@ -13,21 +13,21 @@ export class Tasks extends APIResource {
     query: TaskListParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<TaskListResponse> {
-    return this._client.get('/v1/tasks', { query, ...options });
+    return this._client.get('/v2/tasks', { query, ...options });
   }
 
   /**
    * Retrieve the details of a specific task by its ID.
    */
   get(taskID: string, options?: RequestOptions): APIPromise<TaskGetResponse> {
-    return this._client.get(path`/v1/tasks/${taskID}`, options);
+    return this._client.get(path`/v2/tasks/${taskID}`, options);
   }
 
   /**
    * Retrieve the results of a completed task.
    */
   results(taskID: string, options?: RequestOptions): APIPromise<TaskResultsResponse> {
-    return this._client.get(path`/v1/tasks/${taskID}/results`, options);
+    return this._client.get(path`/v2/tasks/${taskID}/results`, options);
   }
 }