@nimble-way/nimble-js 0.13.0 → 0.16.0

package/src/resources/jobs/jobs.ts

@@ -0,0 +1,413 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as RunsAPI from './runs/runs';
+import { RunCancelResponse, RunGetResponse, RunListParams, RunListResponse, Runs } from './runs/runs';
+import { APIPromise } from '../../core/api-promise';
+import { buildHeaders } from '../../internal/headers';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Jobs extends APIResource {
+  runs: RunsAPI.Runs = new RunsAPI.Runs(this._client);
+
+  /**
+   * Create Job
+   */
+  create(body: JobCreateParams, options?: RequestOptions): APIPromise<JobCreateResponse> {
+    return this._client.post('/v1/jobs', { body, ...options });
+  }
+
+  /**
+   * Update Job
+   */
+  update(jobID: string, body: JobUpdateParams, options?: RequestOptions): APIPromise<JobUpdateResponse> {
+    return this._client.patch(path`/v1/jobs/${jobID}`, { body, ...options });
+  }
+
+  /**
+   * List Jobs
+   */
+  list(query: JobListParams | null | undefined = {}, options?: RequestOptions): APIPromise<JobListResponse> {
+    return this._client.get('/v1/jobs', { query, ...options });
+  }
+
+  /**
+   * Delete Job
+   */
+  delete(jobID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v1/jobs/${jobID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Get Job
+   */
+  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);
+  }
+}
+
+export interface JobCreateResponse {
+  id: string;
+
+  name: string;
+
+  agent_name?: string | null;
+
+  created_at?: string | null;
+
+  description?: string | null;
+
+  destination?: JobCreateResponse.Destination | null;
+
+  display_name?: string | null;
+
+  inputs?: JobCreateResponse.Inputs | null;
+
+  last_run_at?: string | null;
+
+  last_run_status?: 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING' | null;
+
+  schedule?: JobCreateResponse.Schedule | null;
+
+  updated_at?: string | null;
+}
+
+export namespace JobCreateResponse {
+  export interface Destination {
+    path: string;
+
+    type: 'file' | 's3';
+
+    format?: 'jsonl' | 'csv' | 'parquet';
+  }
+
+  export interface Inputs {
+    type: 's3' | 'inline' | 'file';
+
+    data?: Array<{ [key: string]: unknown }> | null;
+
+    file_path?: string | null;
+  }
+
+  export interface Schedule {
+    cron: string;
+
+    enabled: boolean;
+  }
+}
+
+export interface JobUpdateResponse {
+  id: string;
+
+  name: string;
+
+  agent_name?: string | null;
+
+  created_at?: string | null;
+
+  description?: string | null;
+
+  destination?: JobUpdateResponse.Destination | null;
+
+  display_name?: string | null;
+
+  inputs?: JobUpdateResponse.Inputs | null;
+
+  last_run_at?: string | null;
+
+  last_run_status?: 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING' | null;
+
+  schedule?: JobUpdateResponse.Schedule | null;
+
+  updated_at?: string | null;
+}
+
+export namespace JobUpdateResponse {
+  export interface Destination {
+    path: string;
+
+    type: 'file' | 's3';
+
+    format?: 'jsonl' | 'csv' | 'parquet';
+  }
+
+  export interface Inputs {
+    type: 's3' | 'inline' | 'file';
+
+    data?: Array<{ [key: string]: unknown }> | null;
+
+    file_path?: string | null;
+  }
+
+  export interface Schedule {
+    cron: string;
+
+    enabled: boolean;
+  }
+}
+
+export interface JobListResponse {
+  items: Array<JobListResponse.Item>;
+
+  page: number;
+
+  per_page: number;
+
+  total: number;
+}
+
+export namespace JobListResponse {
+  export interface Item {
+    id: string;
+
+    name: string;
+
+    agent_name?: string | null;
+
+    created_at?: string | null;
+
+    description?: string | null;
+
+    destination?: Item.Destination | null;
+
+    display_name?: string | null;
+
+    inputs?: Item.Inputs | null;
+
+    last_run_at?: string | null;
+
+    last_run_status?:
+      | 'PENDING'
+      | 'RUNNING'
+      | 'SUCCESS'
+      | 'FAILED'
+      | 'CANCELLED'
+      | 'TIMEOUT'
+      | 'WARNING'
+      | null;
+
+    schedule?: Item.Schedule | null;
+
+    updated_at?: string | null;
+  }
+
+  export namespace Item {
+    export interface Destination {
+      path: string;
+
+      type: 'file' | 's3';
+
+      format?: 'jsonl' | 'csv' | 'parquet';
+    }
+
+    export interface Inputs {
+      type: 's3' | 'inline' | 'file';
+
+      data?: Array<{ [key: string]: unknown }> | null;
+
+      file_path?: string | null;
+    }
+
+    export interface Schedule {
+      cron: string;
+
+      enabled: boolean;
+    }
+  }
+}
+
+export interface JobGetResponse {
+  id: string;
+
+  name: string;
+
+  agent_name?: string | null;
+
+  created_at?: string | null;
+
+  description?: string | null;
+
+  destination?: JobGetResponse.Destination | null;
+
+  display_name?: string | null;
+
+  inputs?: JobGetResponse.Inputs | null;
+
+  last_run_at?: string | null;
+
+  last_run_status?: 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING' | null;
+
+  schedule?: JobGetResponse.Schedule | null;
+
+  updated_at?: string | null;
+}
+
+export namespace JobGetResponse {
+  export interface Destination {
+    path: string;
+
+    type: 'file' | 's3';
+
+    format?: 'jsonl' | 'csv' | 'parquet';
+  }
+
+  export interface Inputs {
+    type: 's3' | 'inline' | 'file';
+
+    data?: Array<{ [key: string]: unknown }> | null;
+
+    file_path?: string | null;
+  }
+
+  export interface Schedule {
+    cron: string;
+
+    enabled: boolean;
+  }
+}
+
+export interface JobRunResponse {
+  id: string;
+
+  created_at: string;
+
+  job_id: string;
+
+  status: 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING';
+
+  triggered_by: 'schedule' | 'manual';
+
+  finished_at?: string | null;
+
+  input_count?: number | null;
+
+  result_count?: number | null;
+
+  started_at?: string | null;
+}
+
+export interface JobCreateParams {
+  agent_name: string;
+
+  name: string;
+
+  description?: string | null;
+
+  destination?: JobCreateParams.Destination | null;
+
+  display_name?: string | null;
+
+  inputs?: JobCreateParams.Inputs | null;
+
+  schedule?: JobCreateParams.Schedule | null;
+}
+
+export namespace JobCreateParams {
+  export interface Destination {
+    path: string;
+
+    type: 'file' | 's3';
+
+    format?: 'jsonl' | 'csv' | 'parquet';
+  }
+
+  export interface Inputs {
+    type: 's3' | 'inline' | 'file';
+
+    data?: Array<{ [key: string]: unknown }> | null;
+
+    file_path?: string | null;
+  }
+
+  export interface Schedule {
+    cron: string;
+
+    enabled: boolean;
+  }
+}
+
+export interface JobUpdateParams {
+  description?: string | null;
+
+  destination?: JobUpdateParams.Destination | null;
+
+  display_name?: string | null;
+
+  inputs?: JobUpdateParams.Inputs | null;
+
+  schedule?: JobUpdateParams.Schedule | null;
+}
+
+export namespace JobUpdateParams {
+  export interface Destination {
+    path: string;
+
+    type: 'file' | 's3';
+
+    format?: 'jsonl' | 'csv' | 'parquet';
+  }
+
+  export interface Inputs {
+    type: 's3' | 'inline' | 'file';
+
+    data?: Array<{ [key: string]: unknown }> | null;
+
+    file_path?: string | null;
+  }
+
+  export interface Schedule {
+    cron: string;
+
+    enabled: boolean;
+  }
+}
+
+export interface JobListParams {
+  /**
+   * Filter by agent name
+   */
+  agent_name?: string | null;
+
+  page?: number;
+
+  per_page?: number;
+
+  /**
+   * Search by name or display name
+   */
+  q?: string | null;
+}
+
+Jobs.Runs = Runs;
+
+export declare namespace Jobs {
+  export {
+    type JobCreateResponse as JobCreateResponse,
+    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,
+  };
+
+  export {
+    Runs as Runs,
+    type RunListResponse as RunListResponse,
+    type RunCancelResponse as RunCancelResponse,
+    type RunGetResponse as RunGetResponse,
+    type RunListParams as RunListParams,
+  };
+}

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

@@ -0,0 +1,115 @@
+// 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 Artifacts extends APIResource {
+  /**
+   * List Run Artifacts
+   */
+  list(runID: string, options?: RequestOptions): APIPromise<ArtifactListResponse> {
+    return this._client.get(path`/v1/jobs/runs/${runID}/artifacts`, options);
+  }
+
+  /**
+   * Get Run Artifact Download URL
+   */
+  downloadURL(
+    artifactID: string,
+    params: ArtifactDownloadURLParams,
+    options?: RequestOptions,
+  ): APIPromise<ArtifactDownloadURLResponse> {
+    const { run_id } = params;
+    return this._client.get(path`/v1/jobs/runs/${run_id}/artifacts/${artifactID}/download-url`, options);
+  }
+
+  /**
+   * Get Run Artifact
+   */
+  get(
+    artifactID: string,
+    params: ArtifactGetParams,
+    options?: RequestOptions,
+  ): APIPromise<ArtifactGetResponse> {
+    const { run_id } = params;
+    return this._client.get(path`/v1/jobs/runs/${run_id}/artifacts/${artifactID}`, options);
+  }
+
+  /**
+   * Preview Run Artifact
+   */
+  preview(
+    artifactID: string,
+    params: ArtifactPreviewParams,
+    options?: RequestOptions,
+  ): APIPromise<ArtifactPreviewResponse> {
+    const { run_id } = params;
+    return this._client.get(path`/v1/jobs/runs/${run_id}/artifacts/${artifactID}/preview`, options);
+  }
+}
+
+export interface ArtifactListResponse {
+  items: Array<ArtifactListResponse.Item>;
+}
+
+export namespace ArtifactListResponse {
+  export interface Item {
+    id: string;
+
+    created_at: string;
+
+    description: string;
+
+    type: string;
+  }
+}
+
+export interface ArtifactDownloadURLResponse {
+  expires_at: string;
+
+  url: string;
+}
+
+export interface ArtifactGetResponse {
+  id: string;
+
+  created_at: string;
+
+  description: string;
+
+  type: string;
+}
+
+export interface ArtifactPreviewResponse {
+  columns: Array<string>;
+
+  row_count: number;
+
+  rows: Array<{ [key: string]: unknown }>;
+}
+
+export interface ArtifactDownloadURLParams {
+  run_id: string;
+}
+
+export interface ArtifactGetParams {
+  run_id: string;
+}
+
+export interface ArtifactPreviewParams {
+  run_id: string;
+}
+
+export declare namespace Artifacts {
+  export {
+    type ArtifactListResponse as ArtifactListResponse,
+    type ArtifactDownloadURLResponse as ArtifactDownloadURLResponse,
+    type ArtifactGetResponse as ArtifactGetResponse,
+    type ArtifactPreviewResponse as ArtifactPreviewResponse,
+    type ArtifactDownloadURLParams as ArtifactDownloadURLParams,
+    type ArtifactGetParams as ArtifactGetParams,
+    type ArtifactPreviewParams as ArtifactPreviewParams,
+  };
+}

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

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Artifacts,
+  type ArtifactListResponse,
+  type ArtifactDownloadURLResponse,
+  type ArtifactGetResponse,
+  type ArtifactPreviewResponse,
+  type ArtifactDownloadURLParams,
+  type ArtifactGetParams,
+  type ArtifactPreviewParams,
+} from './artifacts';
+export {
+  Runs,
+  type RunListResponse,
+  type RunCancelResponse,
+  type RunGetResponse,
+  type RunListParams,
+} from './runs';

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

@@ -0,0 +1,177 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as ArtifactsAPI from './artifacts';
+import {
+  ArtifactDownloadURLParams,
+  ArtifactDownloadURLResponse,
+  ArtifactGetParams,
+  ArtifactGetResponse,
+  ArtifactListResponse,
+  ArtifactPreviewParams,
+  ArtifactPreviewResponse,
+  Artifacts,
+} from './artifacts';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+import { path } from '../../../internal/utils/path';
+
+export class Runs extends APIResource {
+  artifacts: ArtifactsAPI.Artifacts = new ArtifactsAPI.Artifacts(this._client);
+
+  /**
+   * List Runs for Job
+   */
+  list(
+    jobID: string,
+    query: RunListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<RunListResponse> {
+    return this._client.get(path`/v1/jobs/${jobID}/runs`, { query, ...options });
+  }
+
+  /**
+   * Cancel Run
+   */
+  cancel(runID: string, options?: RequestOptions): APIPromise<RunCancelResponse> {
+    return this._client.post(path`/v1/jobs/runs/${runID}/cancel`, options);
+  }
+
+  /**
+   * Get Run
+   */
+  get(runID: string, options?: RequestOptions): APIPromise<RunGetResponse> {
+    return this._client.get(path`/v1/jobs/runs/${runID}`, options);
+  }
+}
+
+export interface RunListResponse {
+  items: Array<RunListResponse.Item>;
+
+  page: number;
+
+  per_page: number;
+
+  total: number;
+}
+
+export namespace RunListResponse {
+  export interface Item {
+    id: string;
+
+    created_at: string;
+
+    job_id: string;
+
+    status: 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING';
+
+    triggered_by: 'schedule' | 'manual';
+
+    finished_at?: string | null;
+
+    input_count?: number | null;
+
+    result_count?: number | null;
+
+    started_at?: string | null;
+  }
+}
+
+export interface RunCancelResponse {
+  id: string;
+
+  status: 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING';
+}
+
+export interface RunGetResponse {
+  id: string;
+
+  created_at: string;
+
+  job: RunGetResponse.Job;
+
+  status: 'PENDING' | 'RUNNING' | 'SUCCESS' | 'FAILED' | 'CANCELLED' | 'TIMEOUT' | 'WARNING';
+
+  triggered_by: 'schedule' | 'manual';
+
+  error?: RunGetResponse.Error | null;
+
+  finished_at?: string | null;
+
+  inputs_sample?: Array<unknown> | null;
+
+  started_at?: string | null;
+
+  summary?: RunGetResponse.Summary | null;
+}
+
+export namespace RunGetResponse {
+  export interface Job {
+    id: string;
+
+    name: string;
+
+    agent_name?: string | null;
+
+    display_name?: string | null;
+
+    schedule?: Job.Schedule | null;
+  }
+
+  export namespace Job {
+    export interface Schedule {
+      cron: string;
+
+      enabled: boolean;
+    }
+  }
+
+  export interface Error {
+    errors_sample?: Array<{ [key: string]: unknown }> | null;
+
+    message?: string | null;
+
+    step?: string | null;
+  }
+
+  export interface Summary {
+    input_count?: number | null;
+
+    match_rate?: number | null;
+
+    result_count?: number | null;
+  }
+}
+
+export interface RunListParams {
+  page?: number;
+
+  per_page?: number;
+
+  /**
+   * Filter by status
+   */
+  status?: string | null;
+}
+
+Runs.Artifacts = Artifacts;
+
+export declare namespace Runs {
+  export {
+    type RunListResponse as RunListResponse,
+    type RunCancelResponse as RunCancelResponse,
+    type RunGetResponse as RunGetResponse,
+    type RunListParams as RunListParams,
+  };
+
+  export {
+    Artifacts as Artifacts,
+    type ArtifactListResponse as ArtifactListResponse,
+    type ArtifactDownloadURLResponse as ArtifactDownloadURLResponse,
+    type ArtifactGetResponse as ArtifactGetResponse,
+    type ArtifactPreviewResponse as ArtifactPreviewResponse,
+    type ArtifactDownloadURLParams as ArtifactDownloadURLParams,
+    type ArtifactGetParams as ArtifactGetParams,
+    type ArtifactPreviewParams as ArtifactPreviewParams,
+  };
+}

package/src/resources/jobs/runs.ts

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