@rippling/rippling-sdk 0.2.0-alpha.94 → 0.2.0-alpha.96

package/resources/background-check-candidates.d.mts

@@ -0,0 +1,337 @@
+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";
+/**
+ * Candidates who have been submitted for background check screening
+ */
+export declare class BackgroundCheckCandidates extends APIResource {
+    /**
+     * A list of background check candidates.
+     *
+     * - Requires: `API Tier 2`
+     * - Filterable fields: `external_id`, `email`, `created_at`, `updated_at`
+     * - Sortable fields: `created_at`, `updated_at`
+     */
+    list(query?: BackgroundCheckCandidateListParams | null | undefined, options?: RequestOptions): PagePromise<BackgroundCheckCandidateListResponsesPageCursorURL, BackgroundCheckCandidateListResponse>;
+    /**
+     * Create a new background check candidate
+     */
+    create(body: BackgroundCheckCandidateCreateParams, options?: RequestOptions): APIPromise<BackgroundCheckCandidateCreateResponse>;
+    /**
+     * Retrieve a specific background check candidate
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<BackgroundCheckCandidateRetrieveResponse>;
+    /**
+     * Update a specific background check candidate.
+     */
+    update(id: string, body: BackgroundCheckCandidateUpdateParams, options?: RequestOptions): APIPromise<BackgroundCheckCandidateUpdateResponse>;
+    /**
+     * Delete a background check candidate
+     */
+    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.mts.map

package/resources/background-check-candidates.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"background-check-candidates.d.mts","sourceRoot":"","sources":["../src/resources/background-check-candidates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAEhE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,WAAW;IACxD;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kDAAkD,EAAE,oCAAoC,CAAC;IAQxG;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sCAAsC,CAAC;IAIrD;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wCAAwC,CAAC;IAIpG;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sCAAsC,CAAC;IAIrD;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,MAAM,kDAAkD,GAC5D,aAAa,CAAC,oCAAoC,CAAC,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,sCAAsC;IACrD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,wCAAyC,SAAQ,mBAAmB,CAAC,IAAI;IACxF;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,sCAAsC;IACrD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,yBAAyB,CAAC;IACjD,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,kDAAkD,IAAI,kDAAkD,EAC7G,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oCAAoC,IAAI,oCAAoC,GAClF,CAAC;CACH"}

package/resources/background-check-candidates.d.ts

@@ -0,0 +1,337 @@
+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: `API Tier 2`
+     * - Filterable fields: `external_id`, `email`, `created_at`, `updated_at`
+     * - Sortable fields: `created_at`, `updated_at`
+     */
+    list(query?: BackgroundCheckCandidateListParams | null | undefined, options?: RequestOptions): PagePromise<BackgroundCheckCandidateListResponsesPageCursorURL, BackgroundCheckCandidateListResponse>;
+    /**
+     * Create a new background check candidate
+     */
+    create(body: BackgroundCheckCandidateCreateParams, options?: RequestOptions): APIPromise<BackgroundCheckCandidateCreateResponse>;
+    /**
+     * Retrieve a specific background check candidate
+     */
+    retrieve(id: string, options?: RequestOptions): APIPromise<BackgroundCheckCandidateRetrieveResponse>;
+    /**
+     * Update a specific background check candidate.
+     */
+    update(id: string, body: BackgroundCheckCandidateUpdateParams, options?: RequestOptions): APIPromise<BackgroundCheckCandidateUpdateResponse>;
+    /**
+     * Delete a background check candidate
+     */
+    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

package/resources/background-check-candidates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"background-check-candidates.d.ts","sourceRoot":"","sources":["../src/resources/background-check-candidates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAEhE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,yBAA0B,SAAQ,WAAW;IACxD;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,kCAAkC,GAAG,IAAI,GAAG,SAAc,EACjE,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kDAAkD,EAAE,oCAAoC,CAAC;IAQxG;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sCAAsC,CAAC;IAIrD;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wCAAwC,CAAC;IAIpG;;OAEG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,oCAAoC,EAC1C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sCAAsC,CAAC;IAIrD;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED,MAAM,MAAM,kDAAkD,GAC5D,aAAa,CAAC,oCAAoC,CAAC,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,sCAAsC;IACrD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,wCAAyC,SAAQ,mBAAmB,CAAC,IAAI;IACxF;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,sCAAsC;IACrD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oCAAoC;IACnD;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,yBAAyB,CAAC;IACjD,OAAO,EACL,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,wCAAwC,IAAI,wCAAwC,EACzF,KAAK,sCAAsC,IAAI,sCAAsC,EACrF,KAAK,kDAAkD,IAAI,kDAAkD,EAC7G,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,oCAAoC,IAAI,oCAAoC,EACjF,KAAK,oCAAoC,IAAI,oCAAoC,GAClF,CAAC;CACH"}