@dereekb/zoho 13.11.13 → 13.11.15

package/src/lib/desk/desk.ticket.d.ts

@@ -1,4 +1,4 @@
-import { type Maybe } from '@dereekb/util';
+import { type SuggestedString, type Maybe } from '@dereekb/util';
 import { type ZohoDateTimeString } from '../zoho.type';
 import { type ZohoDeskTicketId, type ZohoDeskContactId, type ZohoDeskProductId, type ZohoDeskDepartmentId, type ZohoDeskAgentId, type ZohoDeskTeamId, type ZohoDeskAccountId, type ZohoDeskContractId } from './desk';
 /**
@@ -10,13 +10,13 @@ export type ZohoDeskTicketStatusType = 'Open' | 'Closed' | 'On Hold';
  *
  * Known values include Low, Medium, High, and Urgent. Custom priorities may also be defined.
  */
-export type ZohoDeskTicketPriority = 'Low' | 'Medium' | 'High' | 'Urgent' | (string & {});
+export type ZohoDeskTicketPriority = SuggestedString<'Low' | 'Medium' | 'High' | 'Urgent'>;
 /**
  * Communication channel through which a Zoho Desk ticket was created.
  *
  * Known values include Phone, Email, Social, Web, Chat, and Forums. Custom channels may also be present.
  */
-export type ZohoDeskTicketChannel = 'Phone' | 'Email' | 'Social' | 'Web' | 'Chat' | 'Forums' | (string & {});
+export type ZohoDeskTicketChannel = SuggestedString<'Phone' | 'Email' | 'Social' | 'Web' | 'Chat' | 'Forums'>;
 /**
  * Fields by which Zoho Desk ticket lists can be sorted.
  */
@@ -213,7 +213,7 @@ export interface ZohoDeskTicketTimer {
 /**
  * Communication channel for a thread.
  */
-export type ZohoDeskThreadChannel = 'EMAIL' | 'PHONE' | 'WEB' | 'CUSTOMERPORTAL' | 'FORUMS' | 'FACEBOOK' | 'TWITTER' | 'TWITTER_DM' | 'ONLINE_CHAT' | 'OFFLINE_CHAT' | 'FEEDBACK' | 'FEEDBACK_WIDGET' | (string & {});
+export type ZohoDeskThreadChannel = SuggestedString<'EMAIL' | 'PHONE' | 'WEB' | 'CUSTOMERPORTAL' | 'FORUMS' | 'FACEBOOK' | 'TWITTER' | 'TWITTER_DM' | 'ONLINE_CHAT' | 'OFFLINE_CHAT' | 'FEEDBACK' | 'FEEDBACK_WIDGET'>;
 /**
  * Direction of a thread message relative to the support team.
  */

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

@@ -59,10 +59,10 @@ export type ZohoRecruitAssociateCandidateRecordsWithJobOpeningsFunction = (input
  *
  * The result separates "already associated" errors from other errors, allowing callers to treat duplicate associations as non-fatal.
  *
- * @param context - Zoho Recruit API context providing fetch and authentication
+ * @param context - Zoho Recruit API context providing fetch and authentication.
  * @returns Factory function that associates candidates with job openings
  *
- * https://www.zoho.com/recruit/developer-guide/apiv2/associate-candidate.html
+ * https://www.zoho.com/recruit/developer-guide/apiv2/associate-candidate.html.
  */
 export declare function zohoRecruitAssociateCandidateRecordsWithJobOpenings(context: ZohoRecruitContext): ZohoRecruitAssociateCandidateRecordsWithJobOpeningsFunction;
 /**
@@ -84,8 +84,8 @@ export type ZohoRecruitSearchAssociatedRecordsFunction<R extends ZohoRecruitSear
 /**
  * Searches for records associated with a given candidate or job opening. Returns an empty page result when no records are found.
  *
- * @param context - Zoho Recruit API context providing fetch and authentication
- * @returns Factory function that searches for associated records
+ * @param context - Zoho Recruit API context providing fetch and authentication.
+ * @returns Factory function that searches for associated records.
  */
 export declare function zohoRecruitSearchAssociatedRecords<R extends ZohoRecruitSearchAssociatedRecordsResponse>(context: ZohoRecruitContext): ZohoRecruitSearchAssociatedRecordsFunction<R>;
 /**
@@ -96,15 +96,16 @@ export type ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsFunction<T exte
 /**
  * Searches for job openings associated with a specific candidate.
  *
- * @param context - Zoho Recruit API context providing fetch and authentication
- * @returns Factory function that searches for job openings associated with a candidate
+ * @param context - Zoho Recruit API context providing fetch and authentication.
+ * @returns Factory function that searches for job openings associated with a 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.
  *
- * @param context - Zoho Recruit API context providing fetch and authentication
- * @returns Page factory for iterating through associated job openings
+ * @param context - Zoho Recruit API context providing fetch and authentication.
+ * @returns Page factory for iterating through associated job openings.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory<T extends ZohoRecruitRecord>(context: ZohoRecruitContext): import("@dereekb/util/fetch").FetchPageFactory<ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsInput, ZohoRecruitSearchAssociatedRecordsResponse<T>>;
@@ -116,16 +117,17 @@ export type ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsFunction<T exte
 /**
  * Searches for candidates associated with a specific job opening.
  *
- * @param context - Zoho Recruit API context providing fetch and authentication
- * @param jobOpeningModuleName - Module name for job openings, defaults to the standard module
- * @returns Factory function that searches for candidates associated with a job opening
+ * @param context - Zoho Recruit API context providing fetch and authentication.
+ * @param jobOpeningModuleName - Module name for job openings, defaults to the standard module.
+ * @returns Factory function that searches for candidates associated with a 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.
  *
- * @param context - Zoho Recruit API context providing fetch and authentication
- * @returns Page factory for iterating through associated candidates
+ * @param context - Zoho Recruit API context providing fetch and authentication.
+ * @returns Page factory for iterating through associated candidates.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory<T extends ZohoRecruitRecord>(context: ZohoRecruitContext): import("@dereekb/util/fetch").FetchPageFactory<ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsInput, ZohoRecruitSearchAssociatedRecordsResponse<T>>;

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

@@ -102,8 +102,10 @@ export type ZohoRecruitInsertRecordFunction = ZohoRecruitCreateRecordLikeFunctio
  *
  * Maximum of {@link ZOHO_RECRUIT_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that inserts records into the specified module
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that inserts records into the specified module.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html
  *
  * @example
  * ```typescript
@@ -124,8 +126,6 @@ export type ZohoRecruitInsertRecordFunction = ZohoRecruitCreateRecordLikeFunctio
  *   ]
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html
  */
 export declare function zohoRecruitInsertRecord(context: ZohoRecruitContext): ZohoRecruitInsertRecordFunction;
 /**
@@ -142,8 +142,10 @@ export type ZohoRecruitUpsertRecordFunction = ZohoRecruitUpsertRecordLikeFunctio
  *
  * Maximum of {@link ZOHO_RECRUIT_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that upserts records in the specified module
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that upserts records in the specified module.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html
  *
  * @example
  * ```typescript
@@ -170,8 +172,6 @@ export type ZohoRecruitUpsertRecordFunction = ZohoRecruitUpsertRecordLikeFunctio
  *   ]
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html
  */
 export declare function zohoRecruitUpsertRecord(context: ZohoRecruitContext): ZohoRecruitUpsertRecordFunction;
 export type ZohoRecruitUpdateRecordFunction = ZohoRecruitUpdateRecordLikeFunction;
@@ -184,8 +184,10 @@ export type ZohoRecruitUpdateRecordFunction = ZohoRecruitUpdateRecordLikeFunctio
  *
  * Maximum of {@link ZOHO_RECRUIT_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that updates records in the specified module
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that updates records in the specified module.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/update-records.html
  *
  * @example
  * ```typescript
@@ -206,8 +208,6 @@ export type ZohoRecruitUpdateRecordFunction = ZohoRecruitUpdateRecordLikeFunctio
  *   ]
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/update-records.html
  */
 export declare function zohoRecruitUpdateRecord(context: ZohoRecruitContext): ZohoRecruitUpdateRecordFunction;
 /**
@@ -250,8 +250,10 @@ export type ZohoRecruitDeleteRecordResult = ZohoRecruitChangeObjectResponseSucce
  * an optional `wf_trigger` flag to execute workflow rules on deletion. Returns
  * a response with separated success and error entries.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that deletes records from the specified module
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that deletes records from the specified module.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-records.html
  *
  * @example
  * ```typescript
@@ -262,8 +264,6 @@ export type ZohoRecruitDeleteRecordResult = ZohoRecruitChangeObjectResponseSucce
  *   ids: candidateId
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-records.html
  */
 export declare function zohoRecruitDeleteRecord(context: ZohoRecruitContext): ZohoRecruitDeleteRecordFunction;
 /**
@@ -292,8 +292,10 @@ export type ZohoRecruitGetRecordByIdFunction = <T = ZohoRecruitRecord>(input: Zo
  * unwrapped from the standard data array, returning the record directly.
  * Throws if the record is not found.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that retrieves a record by module name and ID
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that retrieves a record by module name and ID.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
  *
  * @example
  * ```typescript
@@ -304,8 +306,6 @@ export type ZohoRecruitGetRecordByIdFunction = <T = ZohoRecruitRecord>(input: Zo
  *   id: candidateId
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
  */
 export declare function zohoRecruitGetRecordById(context: ZohoRecruitContext): ZohoRecruitGetRecordByIdFunction;
 /**
@@ -342,8 +342,10 @@ export type ZohoRecruitGetRecordsFunction = <T = ZohoRecruitRecord>(input: ZohoR
  * selection, sorting, custom view filtering, territory filtering, and
  * conversion/approval status filters via {@link ZohoRecruitGetRecordsInput}.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that retrieves paginated records from a module
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that retrieves paginated records from a module.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
  *
  * @example
  * ```typescript
@@ -354,8 +356,6 @@ export type ZohoRecruitGetRecordsFunction = <T = ZohoRecruitRecord>(input: ZohoR
  *   per_page: 10
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
  */
 export declare function zohoRecruitGetRecords(context: ZohoRecruitContext): ZohoRecruitGetRecordsFunction;
 /**
@@ -389,9 +389,11 @@ export type ZohoRecruitSearchRecordsFunction = <T = ZohoRecruitRecord>(input: Zo
  * At least one search parameter must be provided. Returns a paginated result,
  * defaulting to an empty data array when no matches are found.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that searches records in the specified module
- * @throws {Error} If none of `criteria`, `email`, `phone`, or `word` are provided
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that searches records in the specified module.
+ * @throws {Error} If none of `criteria`, `email`, `phone`, or `word` are provided.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/search-records.html
  *
  * @example
  * ```typescript
@@ -410,8 +412,6 @@ export type ZohoRecruitSearchRecordsFunction = <T = ZohoRecruitRecord>(input: Zo
  *   word: 'engineer'
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/search-records.html
  */
 export declare function zohoRecruitSearchRecords(context: ZohoRecruitContext): ZohoRecruitSearchRecordsFunction;
 /**
@@ -424,8 +424,8 @@ export type ZohoRecruitSearchRecordsPageFactory = <T = ZohoRecruitRecord>(input:
  * Returns a page factory that automatically handles Zoho Recruit's pagination,
  * making it easy to iterate through all search results across multiple pages.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Page factory for iterating over search results
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Page factory for iterating over search results.
  *
  * @example
  * ```typescript
@@ -440,6 +440,7 @@ export type ZohoRecruitSearchRecordsPageFactory = <T = ZohoRecruitRecord>(input:
  * const firstPage = await fetchPage.fetchNext();
  * const secondPage = await firstPage.fetchNext();
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoRecruitSearchRecordsPageFactory(context: ZohoRecruitContext): ZohoRecruitSearchRecordsPageFactory;
@@ -495,8 +496,10 @@ export type ZohoRecruitGetRelatedRecordsFunction<T = ZohoRecruitRecord> = (input
  * target module and empty-result behavior. By default, returns an empty page
  * result instead of null when no records are found.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Factory that creates typed related-records retrieval functions
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Factory that creates typed related-records retrieval functions.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
  *
  * @example
  * ```typescript
@@ -513,7 +516,6 @@ export type ZohoRecruitGetRelatedRecordsFunction<T = ZohoRecruitRecord> = (input
  * });
  * ```
  *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoRecruitGetRelatedRecordsFunctionFactory(context: ZohoRecruitContext): ZohoRecruitGetRelatedRecordsFunctionFactory;
@@ -537,8 +539,10 @@ export type ZohoRecruitGetEmailsForRecordFunction = (input: ZohoRecruitGetEmails
  * {@link ZohoRecruitRecordEmailMetadata} entries. When no emails exist for the
  * record, the result contains an empty data array rather than null.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that retrieves emails for a record
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that retrieves emails for a record.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
  *
  * @example
  * ```typescript
@@ -549,8 +553,6 @@ export type ZohoRecruitGetEmailsForRecordFunction = (input: ZohoRecruitGetEmails
  *   module: ZOHO_RECRUIT_CANDIDATES_MODULE
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
  */
 export declare function zohoRecruitGetEmailsForRecord(context: ZohoRecruitContext): ZohoRecruitGetEmailsForRecordFunction;
 /**
@@ -564,8 +566,10 @@ export type ZohoRecruitGetEmailsForRecordPageFactory = FetchPageFactory<ZohoRecr
  * multiple pages. Wraps {@link zohoRecruitGetEmailsForRecord} with automatic
  * pagination handling via {@link zohoFetchPageFactory}.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Page factory for iterating over record emails
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Page factory for iterating over record emails.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
  *
  * @example
  * ```typescript
@@ -584,7 +588,6 @@ export type ZohoRecruitGetEmailsForRecordPageFactory = FetchPageFactory<ZohoRecr
  * }
  * ```
  *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoRecruitGetEmailsForRecordPageFactory(context: ZohoRecruitContext): ZohoRecruitGetEmailsForRecordPageFactory;
@@ -612,8 +615,10 @@ export type ZohoRecruitGetAttachmentsForRecordFunction = (input: ZohoRecruitGetA
  * Each attachment entry includes a `$type` field that distinguishes between
  * directly uploaded attachments (`'Attachment'`) and linked attachments.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that retrieves attachments for a record
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that retrieves attachments for a record.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
  *
  * @example
  * ```typescript
@@ -627,8 +632,6 @@ export type ZohoRecruitGetAttachmentsForRecordFunction = (input: ZohoRecruitGetA
  * // Filter to only directly uploaded attachments (downloadable):
  * const downloadable = result.data.filter((x) => x.$type === 'Attachment');
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
  */
 export declare function zohoRecruitGetAttachmentsForRecord(context: ZohoRecruitContext): ZohoRecruitGetAttachmentsForRecordFunction;
 /**
@@ -642,8 +645,10 @@ export type ZohoRecruitGetAttachmentsForRecordPageFactory = FetchPageFactory<Zoh
  * across multiple pages. Wraps {@link zohoRecruitGetAttachmentsForRecord} with
  * automatic pagination handling via {@link zohoFetchPageFactory}.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Page factory for iterating over record attachments
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Page factory for iterating over record attachments.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
  *
  * @example
  * ```typescript
@@ -662,7 +667,6 @@ export type ZohoRecruitGetAttachmentsForRecordPageFactory = FetchPageFactory<Zoh
  * }
  * ```
  *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoRecruitGetAttachmentsForRecordPageFactory(context: ZohoRecruitContext): ZohoRecruitGetAttachmentsForRecordPageFactory;
@@ -719,10 +723,12 @@ export type ZohoRecruitUploadAttachmentForRecordFunction = (input: ZohoRecruitUp
  * will fetch the file. An attachment category must be specified by ID or name.
  * Maximum file size is {@link ZOHO_RECRUIT_ATTACHMENT_MAX_SIZE} (20MB).
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that uploads an attachment to a record
- * @throws {Error} If neither `file` nor `attachmentUrl` is provided
- * @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that uploads an attachment to a record.
+ * @throws {Error} If neither `file` nor `attachmentUrl` is provided.
+ * @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/upload-attachment.html
  *
  * @example
  * ```typescript
@@ -744,8 +750,6 @@ export type ZohoRecruitUploadAttachmentForRecordFunction = (input: ZohoRecruitUp
  *   attachmentCategoryName: 'Others'
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/upload-attachment.html
  */
 export declare function zohoRecruitUploadAttachmentForRecord(context: ZohoRecruitContext): ZohoRecruitUploadAttachmentForRecordFunction;
 /**
@@ -769,8 +773,10 @@ export type ZohoRecruitDownloadAttachmentForRecordFunction = (input: ZohoRecruit
  * {@link FetchFileResponse} containing the file data and metadata extracted
  * from the response headers.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that downloads an attachment by record and attachment ID
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that downloads an attachment by record and attachment ID.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/download-attachments.html
  *
  * @example
  * ```typescript
@@ -782,8 +788,6 @@ export type ZohoRecruitDownloadAttachmentForRecordFunction = (input: ZohoRecruit
  *   attachment_id: attachmentId
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/download-attachments.html
  */
 export declare function zohoRecruitDownloadAttachmentForRecord(context: ZohoRecruitContext): ZohoRecruitDownloadAttachmentForRecordFunction;
 /**
@@ -806,8 +810,10 @@ export type ZohoRecruitDeleteAttachmentFromRecordFunction = (input: ZohoRecruitD
  * Deletes a specific attachment from a record by its attachment ID.
  * Returns the raw {@link Response}.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that deletes an attachment by record and attachment ID
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that deletes an attachment by record and attachment ID.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-attachments.html
  *
  * @example
  * ```typescript
@@ -819,8 +825,6 @@ export type ZohoRecruitDeleteAttachmentFromRecordFunction = (input: ZohoRecruitD
  *   attachment_id: attachmentId
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-attachments.html
  */
 export declare function zohoRecruitDeleteAttachmentFromRecord(context: ZohoRecruitContext): ZohoRecruitDeleteAttachmentFromRecordFunction;
 /**
@@ -909,9 +913,9 @@ export type ZohoRecruitExecuteRestApiFunctionFunction = (input: ZohoRecruitExecu
  * - There is no documentation for ZohoRecruit specifically, but it seems to behave the same way
  * - You will need the following scopes: ZohoRecruit.functions.execute.READ,ZohoRecruit.functions.execute.CREATE
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that executes serverless functions via the REST API
- * @throws {ZohoRecruitExecuteRestApiFunctionError} If the function execution fails
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that executes serverless functions via the REST API.
+ * @throws {ZohoRecruitExecuteRestApiFunctionError} If the function execution fails.
  *
  * @example
  * ```typescript
@@ -933,33 +937,30 @@ export type ZohoRecruitExecuteRestApiFunctionFunction = (input: ZohoRecruitExecu
  *   apiUrl: 'production'
  * });
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoRecruitExecuteRestApiFunction(context: ZohoRecruitContext): ZohoRecruitExecuteRestApiFunctionFunction;
 /**
  * Builds URL search params from input objects, omitting the `module` key since it is used in the URL path rather than query string.
  *
- * @param input - One or more objects whose key-value pairs become query parameters
- * @returns URLSearchParams with the `module` key excluded
+ * @param input - One or more objects whose key-value pairs become query parameters.
+ * @returns URLSearchParams with the `module` key excluded.
  */
 export declare function zohoRecruitUrlSearchParamsMinusModule(...input: Maybe<object | Record<string, string | number>>[]): URLSearchParams;
 /**
  * Builds URL search params from input objects, omitting both `id` and `module` keys since they are used in the URL path.
  *
- * @param input - One or more objects whose key-value pairs become query parameters
- * @returns URLSearchParams with `id` and `module` keys excluded
+ * @param input - One or more objects whose key-value pairs become query parameters.
+ * @returns URLSearchParams with `id` and `module` keys excluded.
  */
 export declare function zohoRecruitUrlSearchParamsMinusIdAndModule(...input: Maybe<object | Record<string, string | number>>[]): URLSearchParams;
-/**
- * @deprecated use makeUrlSearchParams instead.
- */
-export declare const zohoRecruitUrlSearchParams: typeof makeUrlSearchParams;
 /**
  * Constructs a standard {@link FetchJsonInput} for Zoho Recruit API calls with the given HTTP method and optional body.
  *
- * @param method - HTTP method for the request
- * @param body - Optional JSON body to include in the request
- * @returns Configured fetch JSON input
+ * @param method - HTTP method for the request.
+ * @param body - Optional JSON body to include in the request.
+ * @returns Configured fetch JSON input.
  */
 export declare function zohoRecruitApiFetchJsonInput(method: string, body?: Maybe<FetchJsonBody>): FetchJsonInput;
 /**
@@ -999,8 +1000,8 @@ export type ZohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs<T extends Zo
  * Used internally by {@link zohoRecruitDeleteRecord} and similar functions to provide
  * convenient access to separated success/error results.
  *
- * @param response - Raw change operation response containing mixed success/error entries
- * @returns The response augmented with pre-separated `successItems` and `errorItems` arrays
+ * @param response - Raw change operation response containing mixed success/error entries.
+ * @returns The response augmented with pre-separated `successItems` and `errorItems` arrays.
  *
  * @example
  * ```typescript
@@ -1055,9 +1056,9 @@ export interface ZohoRecruitMultiRecordResultItem {
  * Used internally by {@link updateRecordLikeFunction} to pair input data with API outcomes
  * for insert, update, and upsert operations.
  *
- * @param input - Array of input records that were submitted to the API
+ * @param input - Array of input records that were submitted to the API.
  * @param results - Array of per-record results returned by the API, positionally aligned with `input`
- * @returns Object with `successItems` and `errorItems`, each containing paired `{ input, result }` entries
+ * @returns Object with `successItems` and `errorItems`, each containing paired `{ input, result }` entries.
  */
 export declare function zohoRecruitMultiRecordResult<I, OS extends ZohoRecruitMultiRecordResultItem, OE extends ZohoRecruitMultiRecordResultItem>(input: I[], results: (OS | OE)[]): ZohoRecruitMultiRecordResult<I, OS, OE>;
 export interface ZohoRecruitMultiRecordResultEntry<I, O> {
@@ -1070,6 +1071,10 @@ export interface ZohoRecruitMultiRecordResultEntry<I, O> {
      */
     readonly result: O;
 }
+/**
+ * @deprecated use makeUrlSearchParams instead.
+ */
+export declare const zohoRecruitUrlSearchParams: typeof makeUrlSearchParams;
 /**
  * @deprecated use ZohoRecruitGetRelatedRecordsPageFilter instead.
  */

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

@@ -36,8 +36,8 @@ export type ZohoRecruitCreateNotesFunction = (input: ZohoRecruitCreateNotesReque
  * Prefer {@link zohoRecruitCreateNotesForRecord} when creating notes linked to a specific
  * record, as it handles the module/parent linking automatically.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that creates notes in the Notes module
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that creates notes in the Notes module.
  *
  * @example
  * ```typescript
@@ -78,8 +78,8 @@ export type ZohoRecruitDeleteNotesFunction = (input: ZohoRecruitDeleteNotesReque
  * Deletes one or more notes by their IDs from the Notes module. Returns a paired
  * success/error result for each note ID.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that deletes notes by ID
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that deletes notes by ID.
  *
  * @example
  * ```typescript
@@ -107,8 +107,8 @@ export type ZohoRecruitGetNotesForRecordFunction = (input: ZohoRecruitGetNotesFo
  * Retrieves notes related to a specific record by targeting the Notes module
  * via the related records API. Returns an empty page result when no notes exist.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that retrieves notes for a record
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that retrieves notes for a record.
  *
  * @example
  * ```typescript
@@ -132,8 +132,9 @@ export type ZohoRecruitGetNotesForRecordPageFactory = FetchPageFactory<ZohoRecru
  * multiple pages. Wraps {@link zohoRecruitGetNotesForRecord} with automatic
  * pagination handling via {@link zohoFetchPageFactory}.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Page factory for iterating over record notes
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Page factory for iterating over record notes.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoRecruitGetNotesForRecordPageFactory(context: ZohoRecruitContext): ZohoRecruitGetNotesForRecordPageFactory;
@@ -155,8 +156,8 @@ export type ZohoRecruitCreateNotesForRecordFunction = (input: ZohoRecruitCreateN
  * `se_module` and `Parent_Id` on each note entry from the request's `module` and `id`,
  * then delegates to {@link zohoRecruitCreateNotes}.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that creates notes linked to a specific record
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that creates notes linked to a specific record.
  *
  * @example
  * ```typescript