import { APIResource } from "../core/resource.mjs"; import * as BusinessPartnersAPI from "./business-partners.mjs"; import { APIPromise } from "../core/api-promise.mjs"; import { PageCursorURL, PagePromise } from "../core/pagination.mjs"; import { RequestOptions } from "../internal/request-options.mjs"; /** * A request for a job to be filled by a candidate */ export declare class JobRequisitions extends APIResource { /** * List non-confidential active job requisitions available to the integration. Use * a requisition identifier to retrieve its details, pipeline, or location-specific * job posts. * * - Requires: `API Tier 1` * - Filterable fields: `requisition_id`, `created_at` * - Sortable fields: `id`, `created_at`, `updated_at` * * @example HTTP * Representative request and response shapes. * ``` * GET /job-requisitions/?filter=filter&order_by=order_by&limit=50&cursor=cursor HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "__meta": { * "redacted_fields": [ * { * "name": "date_of_birth", * "reason": "Insufficient entitlements" * } * ] * }, * "results": [ * { * "id": "string", * "created_at": "string", * "updated_at": "string", * "name": "string", * "status": "OPEN", * "requisition_id": "string" * } * ], * "next_link": "string" * } * ``` */ list(query?: JobRequisitionListParams | null | undefined, options?: RequestOptions): PagePromise; /** * Retrieve a non-confidential job requisition by identifier. Unlike the list * operation, retrieve can return a closed requisition. * * @example HTTP * Representative request and response shapes. * ``` * GET /job-requisitions/{id}/ HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "__meta": { * "redacted_fields": [ * {} * ] * } * } * ``` */ retrieve(id: string, options?: RequestOptions): APIPromise; /** * Returns the configured application stages in pipeline order. Requisitions * without a configured pipeline return an empty stages list. * * @example HTTP * Representative request and response shapes. * ``` * GET /job-requisitions/{id}/pipeline/ HTTP/1.1 * Host: rest.ripplingapis.com * Accept: application/json * Rippling-Api-Version: 2024-08-01 * * HTTP/1.1 200 OK * Content-Type: application/json * * { * "job_requisition_id": "string", * "stages": [ * { * "id": "string", * "name": "string" * } * ] * } * ``` */ pipeline(id: string, options?: RequestOptions): APIPromise; } export type JobRequisitionsPageCursorURL = PageCursorURL; 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; /** * Customer-defined job requisition identifier; null when the company has not set * one */ requisition_id?: string; } /** * Meta information for the response. */ export interface JobRequisitionRetrieveResponse extends BusinessPartnersAPI.Meta, JobRequisition { } export interface JobRequisitionPipelineResponse { /** * Job requisition identifier */ job_requisition_id: string; /** * Ordered application stages for the job requisition */ stages: Array; } export declare namespace JobRequisitionPipelineResponse { interface Stage { /** * Application stage identifier from the requisition's configured pipeline plan; * stable for other requisitions that use the same stage definition. */ id: string; /** * Application stage name */ name: string; } } export interface JobRequisitionListParams { cursor?: string; filter?: string; /** * The maximum number of results to return. Defaults to 50. Maximum is 100. */ limit?: number; order_by?: string; } export declare namespace JobRequisitions { export { type JobRequisition as JobRequisition, type JobRequisitionRetrieveResponse as JobRequisitionRetrieveResponse, type JobRequisitionPipelineResponse as JobRequisitionPipelineResponse, type JobRequisitionsPageCursorURL as JobRequisitionsPageCursorURL, type JobRequisitionListParams as JobRequisitionListParams, }; } //# sourceMappingURL=job-requisitions.d.mts.map