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

import { APIResource } from '../core/resource';
import { PageCursorURL, PagePromise } from '../core/pagination';
import { RequestOptions } from '../internal/request-options';

/**
 * A request for a job to be filled by a candidate
 */
export class JobRequisitions extends APIResource {
  /**
   * A list of job requisitions.
   *
   * - Requires: `API Tier 2`
   * - Sortable fields: `id`, `created_at`, `updated_at`
   */
  list(
    query: JobRequisitionListParams | null | undefined = {},
    options?: RequestOptions,
  ): PagePromise<JobRequisitionsPageCursorURL, JobRequisition> {
    return this._client.getAPIList('/job-requisitions/', PageCursorURL<JobRequisition>, {
      query,
      ...options,
    });
  }
}

export type JobRequisitionsPageCursorURL = PageCursorURL<JobRequisition>;

export interface JobRequisition {
  /**
   * Identifier field
   */
  id: string;

  /**
   * Record creation date
   */
  created_at: string;

  /**
   * Job requisition name
   */
  name: string;

  /**
   * Job requisition status
   */
  status: 'OPEN' | 'CLOSED' | 'PUBLISHED' | 'DRAFT' | 'ARCHIVED';

  /**
   * Record update date
   */
  updated_at: string;
}

export interface JobRequisitionListParams {
  cursor?: string;

  order_by?: string;
}

export declare namespace JobRequisitions {
  export {
    type JobRequisition as JobRequisition,
    type JobRequisitionsPageCursorURL as JobRequisitionsPageCursorURL,
    type JobRequisitionListParams as JobRequisitionListParams,
  };
}