@dereekb/zoho 13.0.5 → 13.0.7

package/src/lib/recruit/recruit.api.candidates.d.ts

@@ -3,11 +3,20 @@ import { type ArrayOrValue } from '@dereekb/util';
 import { type ZohoRecruitJobOpeningId, type ZohoRecruitCandidateId, type ZohoRecruitCandidateStatus, type ZohoRecruitJobOpeningPostingTitle, type ZohoRecruitModuleNameRef, type ZohoRecruitRecord } from './recruit';
 import { type ZohoRecruitChangeObjectLikeResponse, type ZohoRecruitChangeObjectLikeResponseSuccessEntryMeta, type ZohoRecruitChangeObjectResponseErrorEntry, type ZohoRecruitGetRecordsPageFilter, type ZohoRecruitMultiRecordResult, type ZohoRecruitMultiRecordResultEntry, type ZohoRecruitSearchRecordsResponse } from './recruit.api';
 import { type ZohoServerErrorDataWithDetails } from '../zoho.error.api';
+/**
+ * Input for associating candidates with job openings. Accepts a single or multiple association entries.
+ */
 export type ZohoRecruitAssociateCandidateRecordsWithJobOpeningsInput = ArrayOrValue<ZohoRecruitAssociateCandidateRecordsWithJobOpeningsInputData>;
+/**
+ * Specifies which candidates to associate with which job openings.
+ */
 export interface ZohoRecruitAssociateCandidateRecordsWithJobOpeningsInputData {
     readonly jobids: ZohoRecruitJobOpeningId[];
     readonly ids: ZohoRecruitCandidateId[];
 }
+/**
+ * Details returned on a successful candidate-to-job-opening association.
+ */
 export interface ZohoRecruitAssociateCandidateRecordsWithJobOpeningsResultDetails {
     /**
      * Job Opening id that was updated
@@ -18,16 +27,25 @@ export interface ZohoRecruitAssociateCandidateRecordsWithJobOpeningsResultDetail
      */
     readonly ids: ZohoRecruitCandidateId[];
 }
+/**
+ * Successful entry from a candidate association operation.
+ */
 export interface ZohoRecruitAssociateCandidateRecordsWithJobOpeningsSuccessEntry extends ZohoRecruitChangeObjectLikeResponseSuccessEntryMeta {
     readonly details: ZohoRecruitAssociateCandidateRecordsWithJobOpeningsResultDetails;
 }
 export type ZohoRecruitAssociateCandidateRecordsWithJobOpeningsResponse = ZohoRecruitChangeObjectLikeResponse<ZohoRecruitAssociateCandidateRecordsWithJobOpeningsSuccessEntry>;
+/**
+ * Error details from a failed association, including the underlying Zoho error array.
+ */
 export interface ZohoRecruitAssociateCandidateRecordsWithJobOpeningsErrorEntryDetails extends ZohoRecruitAssociateCandidateRecordsWithJobOpeningsResultDetails {
     readonly error: ZohoServerErrorDataWithDetails[];
 }
 export type ZohoRecruitAssociateCandidateRecordsWithJobOpeningsErrorEntry = ZohoRecruitChangeObjectResponseErrorEntry & {
     readonly details: ZohoRecruitAssociateCandidateRecordsWithJobOpeningsErrorEntryDetails;
 };
+/**
+ * Result of a candidate association operation, with "already associated" errors separated out so callers can treat them as non-fatal.
+ */
 export type ZohoRecruitAssociateCandidateRecordsWithJobOpeningsResult = ZohoRecruitMultiRecordResult<ZohoRecruitAssociateCandidateRecordsWithJobOpeningsInput, ZohoRecruitAssociateCandidateRecordsWithJobOpeningsSuccessEntry, ZohoRecruitAssociateCandidateRecordsWithJobOpeningsErrorEntry> & {
     /**
      * List of items that are already associated with the job opening
@@ -39,12 +57,14 @@ export type ZohoRecruitAssociateCandidateRecordsWithJobOpeningsFunction = (input
 /**
  * Associates one or more candidates with one or more job openings.
  *
- * https://www.zoho.com/recruit/developer-guide/apiv2/associate-candidate.html
+ * The result separates "already associated" errors from other errors, allowing callers to treat duplicate associations as non-fatal.
  *
- * @param context
- * @returns
+ * https://www.zoho.com/recruit/developer-guide/apiv2/associate-candidate.html
  */
 export declare function zohoRecruitAssociateCandidateRecordsWithJobOpenings(context: ZohoRecruitContext): ZohoRecruitAssociateCandidateRecordsWithJobOpeningsFunction;
+/**
+ * Input for searching records associated with a candidate or job opening, with optional filters.
+ */
 export interface ZohoRecruitSearchAssociatedRecordsInput extends ZohoRecruitModuleNameRef, ZohoRecruitGetRecordsPageFilter {
     readonly id: ZohoRecruitCandidateId | ZohoRecruitJobOpeningId;
     /**
@@ -58,12 +78,33 @@ export interface ZohoRecruitSearchAssociatedRecordsInput extends ZohoRecruitModu
 }
 export type ZohoRecruitSearchAssociatedRecordsResponse<T = ZohoRecruitRecord> = ZohoRecruitSearchRecordsResponse<T>;
 export type ZohoRecruitSearchAssociatedRecordsFunction<R extends ZohoRecruitSearchAssociatedRecordsResponse> = (input: ZohoRecruitSearchAssociatedRecordsInput) => Promise<R>;
+/**
+ * Searches for records associated with a given candidate or job opening. Returns an empty page result when no records are found.
+ */
 export declare function zohoRecruitSearchAssociatedRecords<R extends ZohoRecruitSearchAssociatedRecordsResponse>(context: ZohoRecruitContext): ZohoRecruitSearchAssociatedRecordsFunction<R>;
+/**
+ * Input for searching job openings associated with a candidate, omitting module and candidate_statuses since they are predetermined.
+ */
 export type ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsInput = Omit<ZohoRecruitSearchAssociatedRecordsInput, 'module' | 'candidate_statuses'>;
 export type ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsFunction<T extends ZohoRecruitRecord> = (input: ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsInput) => Promise<ZohoRecruitSearchAssociatedRecordsResponse<T>>;
+/**
+ * Searches for job openings associated with a specific candidate.
+ */
 export declare function zohoRecruitSearchCandidateAssociatedJobOpeningRecords<T extends ZohoRecruitRecord>(context: ZohoRecruitContext): ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsFunction<T>;
+/**
+ * Creates a page factory for paginating over job openings associated with a candidate.
+ */
 export declare function zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory<T extends ZohoRecruitRecord>(context: ZohoRecruitContext): import("@dereekb/util/fetch").FetchPageFactory<ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsInput, ZohoRecruitSearchAssociatedRecordsResponse<T>>;
+/**
+ * Input for searching candidates associated with a job opening, omitting module and posting_title since they are predetermined.
+ */
 export type ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsInput = Omit<ZohoRecruitSearchAssociatedRecordsInput, 'module' | 'posting_title'>;
 export type ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsFunction<T extends ZohoRecruitRecord> = (input: ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsInput) => Promise<ZohoRecruitSearchAssociatedRecordsResponse<T>>;
+/**
+ * Searches for candidates associated with a specific job opening.
+ */
 export declare function zohoRecruitSearchJobOpeningAssociatedCandidateRecords<T extends ZohoRecruitRecord>(context: ZohoRecruitContext, jobOpeningModuleName?: string): ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsFunction<T>;
+/**
+ * Creates a page factory for paginating over candidates associated with a job opening.
+ */
 export declare function zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory<T extends ZohoRecruitRecord>(context: ZohoRecruitContext): import("@dereekb/util/fetch").FetchPageFactory<ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsInput, ZohoRecruitSearchAssociatedRecordsResponse<T>>;