// File generated from our OpenAPI spec by sdkgen. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import * as FilesAPI from '../stores/files';
import * as ContentAPI from './content';
import { APIPromise } from '../../core/api-promise';
import { RequestOptions } from '../../internal/request-options';
import { path } from '../../internal/utils/path';

export class Jobs extends APIResource {
  /**
   * Start an extraction job for the provided file and schema.
   *
   * Args: params: The parameters for creating an extraction job.
   *
   * Returns: The created extraction job.
   */
  create(body: JobCreateParams, options?: RequestOptions): APIPromise<ExtractionJob> {
    return this._client.post('/v1/extractions/jobs', { body, ...options });
  }

  /**
   * Get detailed information about a specific extraction job.
   *
   * Args: job_id: The ID of the extraction job.
   *
   * Returns: Detailed information about the extraction job.
   */
  retrieve(jobID: string, options?: RequestOptions): APIPromise<ExtractionJob> {
    return this._client.get(path`/v1/extractions/jobs/${jobID}`, options);
  }
}

/**
 * A job for extracting structured data from documents.
 */
export interface ExtractionJob {
  /**
   * Unique identifier for the extraction job
   */
  id: string;

  /**
   * ID of the organization that owns this job
   */
  organization_id: string;

  /**
   * ID of the file being extracted
   */
  file_id: string;

  /**
   * When the job was created
   */
  created_at: string;

  /**
   * When the job was last updated
   */
  updated_at: string;

  /**
   * When the job started processing
   */
  started_at: string | null;

  /**
   * When the job finished processing
   */
  finished_at: string | null;

  /**
   * Current status of the job
   */
  status: FilesAPI.StoreFileStatus;

  /**
   * The result of an extraction job.
   */
  result: ContentAPI.ExtractionResult | null;

  /**
   * Error information if failed
   */
  error: { [key: string]: unknown } | null;

  /**
   * The JSON schema used for extraction
   */
  json_schema: { [key: string]: unknown };
}

export interface JobCreateParams {
  /**
   * The ID of the file to extract from
   */
  file_id: string;

  /**
   * The JSON schema to use for extraction
   */
  json_schema: { [key: string]: unknown };
}

export declare namespace Jobs {
  export { type ExtractionJob as ExtractionJob, type JobCreateParams as JobCreateParams };
}