import { APIResource } from "../core/resource.js";
import * as BusinessPartnersAPI from "./business-partners.js";
import { APIPromise } from "../core/api-promise.js";
import { PageCursorURL, PagePromise } from "../core/pagination.js";
import { RequestOptions } from "../internal/request-options.js";
/**
 * Candidates who have been submitted for background check screening
 */
export declare class BackgroundCheckCandidates extends APIResource {
    /**
     * A list of background check candidates.
     *
     * - Requires: `Background Check Platform API`
     * - Filterable fields: `external_id`, `email`, `created_at`, `updated_at`
     * - Sortable fields: `created_at`, `updated_at`
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * GET /background-check-candidates/?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",
     *       "owner_id": "string",
     *       "email": "string",
     *       "first_name": "string",
     *       "last_name": "string",
     *       "middle_name": "string",
     *       "external_id": "string"
     *     }
     *   ],
     *   "next_link": "string"
     * }
     * ```
     */
    list(query?: BackgroundCheckCandidateListParams | null | undefined, options?: RequestOptions): PagePromise<BackgroundCheckCandidateListResponsesPageCursorURL, BackgroundCheckCandidateListResponse>;
    /**
     * Create a new background check candidate
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * POST /background-check-candidates/ HTTP/1.1
     * Host: rest.ripplingapis.com
     * Content-Type: application/json
     * Accept: application/json
     * Rippling-Api-Version: 2024-08-01
     *
     * {
     *   "email": "email",
     *   "external_id": "external_id"
     * }
     *
     * HTTP/1.1 200 OK
     * Content-Type: application/json
     *
     * {
     *   "id": "string",
     *   "created_at": "string",
     *   "updated_at": "string",
     *   "owner_id": "string",
     *   "email": "string",
     *   "first_name": "string",
     *   "last_name": "string",
     *   "middle_name": "string",
     *   "external_id": "string"
     * }
     * ```
     */
    create(body: BackgroundCheckCandidateCreateParams, options?: RequestOptions): APIPromise<BackgroundCheckCandidateCreateResponse>;
    /**
     * Retrieve a specific background check candidate
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * GET /background-check-candidates/{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<BackgroundCheckCandidateRetrieveResponse>;
    /**
     * Update a specific background check candidate.
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * PATCH /background-check-candidates/{id}/ HTTP/1.1
     * Host: rest.ripplingapis.com
     * Content-Type: application/json
     * Accept: application/json
     * Rippling-Api-Version: 2024-08-01
     *
     * {
     *   "email": "email",
     *   "external_id": "external_id"
     * }
     *
     * HTTP/1.1 200 OK
     * Content-Type: application/json
     *
     * {
     *   "id": "string",
     *   "created_at": "string",
     *   "updated_at": "string",
     *   "owner_id": "string",
     *   "email": "string",
     *   "first_name": "string",
     *   "last_name": "string",
     *   "middle_name": "string",
     *   "external_id": "string"
     * }
     * ```
     */
    update(id: string, body: BackgroundCheckCandidateUpdateParams, options?: RequestOptions): APIPromise<BackgroundCheckCandidateUpdateResponse>;
    /**
     * Delete a background check candidate
     *
     * @example HTTP
     * Representative request and response shapes.
     * ```
     * DELETE /background-check-candidates/{id}/ HTTP/1.1
     * Host: rest.ripplingapis.com
     * Rippling-Api-Version: 2024-08-01
     *
     * HTTP/1.1 204 No Content
     * ```
     */
    delete(id: string, options?: RequestOptions): APIPromise<void>;
}
export type BackgroundCheckCandidateListResponsesPageCursorURL = PageCursorURL<BackgroundCheckCandidateListResponse>;
/**
 * Background Check Candidate DTO.
 *
 *     Represents a candidate who has been submitted for background check screening.
 *
 *     Required on Create (but nullable on read for legacy rows):
 *     - email: Required for new candidates, but may be null on read for legacy rows
 *     - external_id: Required for new candidates, but may be null on read for legacy rows
 *
 *     Optional Fields:
 *     - owner_id: May be null if no provider is associated
 *     - first_name: May be null if name is not available
 *     - last_name: May be null if name is not available
 *     - middle_name: May be null if not provided
 *
 *     Sensitive Fields:
 *     - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model
 *     - These do not require separate OAuth scopes beyond the resource-level scopes
 *       (background-check-candidates.read / .read-write) because they are not updating
 *       role or worker data, only storing candidate names for background check processing
 *
 *     Note: first_name, last_name, and middle_name are NOT filterable.
 *     Only external_id, email, created_at, and updated_at support filtering.
 */
export interface BackgroundCheckCandidateListResponse {
    /**
     * The email address of the candidate. Required on create, but may be null on read
     * for legacy rows.
     */
    email: string;
    /**
     * The provider's unique identifier for the candidate. Required on create, but may
     * be null on read for legacy rows. Can only be set once (during creation or when
     * null). Cannot be changed after being set.
     */
    external_id: string;
    /**
     * The unique identifier of the background check candidate.
     */
    id?: string;
    /**
     * The timestamp when the candidate was created.
     */
    created_at?: string;
    /**
     * The first name of the candidate.
     */
    first_name?: string;
    /**
     * The last name of the candidate.
     */
    last_name?: string;
    /**
     * The middle name of the candidate.
     */
    middle_name?: string;
    /**
     * The ID of the background check provider (OAuth spoke owner).
     */
    owner_id?: string;
    /**
     * The timestamp when the candidate was last updated.
     */
    updated_at?: string;
}
/**
 * Background Check Candidate DTO.
 *
 *     Represents a candidate who has been submitted for background check screening.
 *
 *     Required on Create (but nullable on read for legacy rows):
 *     - email: Required for new candidates, but may be null on read for legacy rows
 *     - external_id: Required for new candidates, but may be null on read for legacy rows
 *
 *     Optional Fields:
 *     - owner_id: May be null if no provider is associated
 *     - first_name: May be null if name is not available
 *     - last_name: May be null if name is not available
 *     - middle_name: May be null if not provided
 *
 *     Sensitive Fields:
 *     - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model
 *     - These do not require separate OAuth scopes beyond the resource-level scopes
 *       (background-check-candidates.read / .read-write) because they are not updating
 *       role or worker data, only storing candidate names for background check processing
 *
 *     Note: first_name, last_name, and middle_name are NOT filterable.
 *     Only external_id, email, created_at, and updated_at support filtering.
 */
export interface BackgroundCheckCandidateCreateResponse {
    /**
     * The email address of the candidate. Required on create, but may be null on read
     * for legacy rows.
     */
    email: string;
    /**
     * The provider's unique identifier for the candidate. Required on create, but may
     * be null on read for legacy rows. Can only be set once (during creation or when
     * null). Cannot be changed after being set.
     */
    external_id: string;
    /**
     * The unique identifier of the background check candidate.
     */
    id?: string;
    /**
     * The timestamp when the candidate was created.
     */
    created_at?: string;
    /**
     * The first name of the candidate.
     */
    first_name?: string;
    /**
     * The last name of the candidate.
     */
    last_name?: string;
    /**
     * The middle name of the candidate.
     */
    middle_name?: string;
    /**
     * The ID of the background check provider (OAuth spoke owner).
     */
    owner_id?: string;
    /**
     * The timestamp when the candidate was last updated.
     */
    updated_at?: string;
}
/**
 * Meta information for the response.
 */
export interface BackgroundCheckCandidateRetrieveResponse extends BusinessPartnersAPI.Meta {
    /**
     * The email address of the candidate. Required on create, but may be null on read
     * for legacy rows.
     */
    email: string;
    /**
     * The provider's unique identifier for the candidate. Required on create, but may
     * be null on read for legacy rows. Can only be set once (during creation or when
     * null). Cannot be changed after being set.
     */
    external_id: string;
    /**
     * The unique identifier of the background check candidate.
     */
    id?: string;
    /**
     * The timestamp when the candidate was created.
     */
    created_at?: string;
    /**
     * The first name of the candidate.
     */
    first_name?: string;
    /**
     * The last name of the candidate.
     */
    last_name?: string;
    /**
     * The middle name of the candidate.
     */
    middle_name?: string;
    /**
     * The ID of the background check provider (OAuth spoke owner).
     */
    owner_id?: string;
    /**
     * The timestamp when the candidate was last updated.
     */
    updated_at?: string;
}
/**
 * Background Check Candidate DTO.
 *
 *     Represents a candidate who has been submitted for background check screening.
 *
 *     Required on Create (but nullable on read for legacy rows):
 *     - email: Required for new candidates, but may be null on read for legacy rows
 *     - external_id: Required for new candidates, but may be null on read for legacy rows
 *
 *     Optional Fields:
 *     - owner_id: May be null if no provider is associated
 *     - first_name: May be null if name is not available
 *     - last_name: May be null if name is not available
 *     - middle_name: May be null if not provided
 *
 *     Sensitive Fields:
 *     - first_name, last_name, middle_name: Name fields are PII marked as sensitive in the model
 *     - These do not require separate OAuth scopes beyond the resource-level scopes
 *       (background-check-candidates.read / .read-write) because they are not updating
 *       role or worker data, only storing candidate names for background check processing
 *
 *     Note: first_name, last_name, and middle_name are NOT filterable.
 *     Only external_id, email, created_at, and updated_at support filtering.
 */
export interface BackgroundCheckCandidateUpdateResponse {
    /**
     * The email address of the candidate. Required on create, but may be null on read
     * for legacy rows.
     */
    email: string;
    /**
     * The provider's unique identifier for the candidate. Required on create, but may
     * be null on read for legacy rows. Can only be set once (during creation or when
     * null). Cannot be changed after being set.
     */
    external_id: string;
    /**
     * The unique identifier of the background check candidate.
     */
    id?: string;
    /**
     * The timestamp when the candidate was created.
     */
    created_at?: string;
    /**
     * The first name of the candidate.
     */
    first_name?: string;
    /**
     * The last name of the candidate.
     */
    last_name?: string;
    /**
     * The middle name of the candidate.
     */
    middle_name?: string;
    /**
     * The ID of the background check provider (OAuth spoke owner).
     */
    owner_id?: string;
    /**
     * The timestamp when the candidate was last updated.
     */
    updated_at?: string;
}
export interface BackgroundCheckCandidateListParams {
    cursor?: string;
    filter?: string;
    /**
     * The maximum number of results to return. Defaults to 50. Maximum is 100.
     */
    limit?: number;
    order_by?: string;
}
export interface BackgroundCheckCandidateCreateParams {
    /**
     * The email address of the candidate. Required on create, but may be null on read
     * for legacy rows.
     */
    email: string;
    /**
     * The provider's unique identifier for the candidate. Required on create, but may
     * be null on read for legacy rows. Can only be set once (during creation or when
     * null). Cannot be changed after being set.
     */
    external_id: string;
    /**
     * The first name of the candidate.
     */
    first_name?: string;
    /**
     * The last name of the candidate.
     */
    last_name?: string;
    /**
     * The middle name of the candidate.
     */
    middle_name?: string;
}
export interface BackgroundCheckCandidateUpdateParams {
    /**
     * The email address of the candidate. Required on create, but may be null on read
     * for legacy rows.
     */
    email: string;
    /**
     * The provider's unique identifier for the candidate. Required on create, but may
     * be null on read for legacy rows. Can only be set once (during creation or when
     * null). Cannot be changed after being set.
     */
    external_id: string;
    /**
     * The first name of the candidate.
     */
    first_name?: string;
    /**
     * The last name of the candidate.
     */
    last_name?: string;
    /**
     * The middle name of the candidate.
     */
    middle_name?: string;
}
export declare namespace BackgroundCheckCandidates {
    export { type BackgroundCheckCandidateListResponse as BackgroundCheckCandidateListResponse, type BackgroundCheckCandidateCreateResponse as BackgroundCheckCandidateCreateResponse, type BackgroundCheckCandidateRetrieveResponse as BackgroundCheckCandidateRetrieveResponse, type BackgroundCheckCandidateUpdateResponse as BackgroundCheckCandidateUpdateResponse, type BackgroundCheckCandidateListResponsesPageCursorURL as BackgroundCheckCandidateListResponsesPageCursorURL, type BackgroundCheckCandidateListParams as BackgroundCheckCandidateListParams, type BackgroundCheckCandidateCreateParams as BackgroundCheckCandidateCreateParams, type BackgroundCheckCandidateUpdateParams as BackgroundCheckCandidateUpdateParams, };
}
//# sourceMappingURL=background-check-candidates.d.ts.map