@dereekb/zoho 13.11.13 → 13.11.15

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

@@ -123,8 +123,10 @@ export type ZohoCrmInsertRecordFunction = ZohoCrmCreateRecordLikeFunction;
  *
  * Maximum of {@link ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that inserts records into the specified module
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that inserts records into the specified module.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/insert-records.html
  *
  * @example
  * ```typescript
@@ -145,8 +147,6 @@ export type ZohoCrmInsertRecordFunction = ZohoCrmCreateRecordLikeFunction;
  *   ]
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/insert-records.html
  */
 export declare function zohoCrmInsertRecord(context: ZohoCrmContext): ZohoCrmInsertRecordFunction;
 /**
@@ -163,8 +163,10 @@ export type ZohoCrmUpsertRecordFunction = ZohoCrmUpsertRecordLikeFunction;
  *
  * Maximum of {@link ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that upserts records in the specified module
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that upserts records in the specified module.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/upsert-records.html
  *
  * @example
  * ```typescript
@@ -191,8 +193,6 @@ export type ZohoCrmUpsertRecordFunction = ZohoCrmUpsertRecordLikeFunction;
  *   ]
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/upsert-records.html
  */
 export declare function zohoCrmUpsertRecord(context: ZohoCrmContext): ZohoCrmUpsertRecordFunction;
 /**
@@ -208,8 +208,10 @@ export type ZohoCrmUpdateRecordFunction = ZohoCrmUpdateRecordLikeFunction;
  *
  * Maximum of {@link ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that updates records in the specified module
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that updates records in the specified module.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/update-records.html
  *
  * @example
  * ```typescript
@@ -230,8 +232,6 @@ export type ZohoCrmUpdateRecordFunction = ZohoCrmUpdateRecordLikeFunction;
  *   ]
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/update-records.html
  */
 export declare function zohoCrmUpdateRecord(context: ZohoCrmContext): ZohoCrmUpdateRecordFunction;
 /**
@@ -274,8 +274,10 @@ export type ZohoCrmDeleteRecordResult = ZohoCrmChangeObjectResponseSuccessEntry[
  * an optional `wf_trigger` flag to execute workflow rules on deletion. Returns
  * a response with separated success and error entries.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that deletes records from the specified module
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that deletes records from the specified module.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/delete-records.html
  *
  * @example
  * ```typescript
@@ -286,8 +288,6 @@ export type ZohoCrmDeleteRecordResult = ZohoCrmChangeObjectResponseSuccessEntry[
  *   ids: contactId
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/delete-records.html
  */
 export declare function zohoCrmDeleteRecord(context: ZohoCrmContext): ZohoCrmDeleteRecordFunction;
 /**
@@ -315,8 +315,10 @@ export type ZohoCrmGetRecordByIdFunction = <T = ZohoCrmRecord>(input: ZohoCrmGet
  * unwrapped from the standard data array, returning the record directly.
  * Throws if the record is not found.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that retrieves a record by module name and ID
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that retrieves a record by module name and ID.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
  *
  * @example
  * ```typescript
@@ -327,8 +329,6 @@ export type ZohoCrmGetRecordByIdFunction = <T = ZohoCrmRecord>(input: ZohoCrmGet
  *   id: contactId
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
  */
 export declare function zohoCrmGetRecordById(context: ZohoCrmContext): ZohoCrmGetRecordByIdFunction;
 export interface ZohoCrmGetRecordsPageFilter extends ZohoPageFilter {
@@ -355,8 +355,10 @@ export type ZohoCrmGetRecordsFunction = <T = ZohoCrmRecord>(input: ZohoCrmGetRec
  * selection, sorting, custom view filtering, territory filtering, and
  * conversion/approval status filters via {@link ZohoCrmGetRecordsInput}.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that retrieves paginated records from a module
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that retrieves paginated records from a module.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
  *
  * @example
  * ```typescript
@@ -368,8 +370,6 @@ export type ZohoCrmGetRecordsFunction = <T = ZohoCrmRecord>(input: ZohoCrmGetRec
  *   per_page: 10
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
  */
 export declare function zohoCrmGetRecords(context: ZohoCrmContext): ZohoCrmGetRecordsFunction;
 /**
@@ -394,9 +394,11 @@ export type ZohoCrmSearchRecordsFunction = <T = ZohoCrmRecord>(input: ZohoCrmSea
  * 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 CRM context providing fetch and rate limiting
- * @returns Function that searches records in the specified module
- * @throws {Error} If none of `criteria`, `email`, `phone`, `cvid`, or `word` are provided
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that searches records in the specified module.
+ * @throws {Error} If none of `criteria`, `email`, `phone`, `cvid`, or `word` are provided.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/search-records.html
  *
  * @example
  * ```typescript
@@ -415,8 +417,6 @@ export type ZohoCrmSearchRecordsFunction = <T = ZohoCrmRecord>(input: ZohoCrmSea
  *   word: 'engineer'
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/search-records.html
  */
 export declare function zohoCrmSearchRecords(context: ZohoCrmContext): ZohoCrmSearchRecordsFunction;
 /**
@@ -429,8 +429,8 @@ export type ZohoCrmSearchRecordsPageFactory = <T = ZohoCrmRecord>(input: ZohoCrm
  * Returns a page factory that automatically handles Zoho CRM's pagination,
  * making it easy to iterate through all search results across multiple pages.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Page factory for iterating over search results
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Page factory for iterating over search results.
  *
  * @example
  * ```typescript
@@ -445,6 +445,7 @@ export type ZohoCrmSearchRecordsPageFactory = <T = ZohoCrmRecord>(input: ZohoCrm
  * const firstPage = await fetchPage.fetchNext();
  * const secondPage = await firstPage.fetchNext();
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoCrmSearchRecordsPageFactory(context: ZohoCrmContext): ZohoCrmSearchRecordsPageFactory;
@@ -487,8 +488,10 @@ export type ZohoCrmGetRelatedRecordsFunction<T = ZohoCrmRecord> = (input: ZohoCr
  * 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 CRM context providing fetch and rate limiting
- * @returns Factory that creates typed related-records retrieval functions
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Factory that creates typed related-records retrieval functions.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
  *
  * @example
  * ```typescript
@@ -505,7 +508,6 @@ export type ZohoCrmGetRelatedRecordsFunction<T = ZohoCrmRecord> = (input: ZohoCr
  * });
  * ```
  *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoCrmGetRelatedRecordsFunctionFactory(context: ZohoCrmContext): ZohoCrmGetRelatedRecordsFunctionFactory;
@@ -540,8 +542,10 @@ export type ZohoCrmGetEmailsForRecordRawApiResponse = Omit<ZohoCrmGetEmailsForRe
  * which returns email data under an `Emails` key instead of the standard `data` key.
  * Returns a paginated result of {@link ZohoCrmRecordEmailMetadata} entries.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that retrieves emails for a record
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that retrieves emails for a record.
+ *
+ * @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
  *
  * @example
  * ```typescript
@@ -552,8 +556,6 @@ export type ZohoCrmGetEmailsForRecordRawApiResponse = Omit<ZohoCrmGetEmailsForRe
  *   module: 'Contacts'
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
  */
 export declare function zohoCrmGetEmailsForRecord(context: ZohoCrmContext): ZohoCrmGetEmailsForRecordFunction;
 /**
@@ -567,8 +569,10 @@ export type ZohoCrmGetEmailsForRecordPageFactory = FetchPageFactory<ZohoCrmGetEm
  * multiple pages. Wraps {@link zohoCrmGetEmailsForRecord} with automatic
  * pagination handling via {@link zohoFetchPageFactory}.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Page factory for iterating over record emails
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Page factory for iterating over record emails.
+ *
+ * @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
  *
  * @example
  * ```typescript
@@ -587,7 +591,6 @@ export type ZohoCrmGetEmailsForRecordPageFactory = FetchPageFactory<ZohoCrmGetEm
  * }
  * ```
  *
- * @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoCrmGetEmailsForRecordPageFactory(context: ZohoCrmContext): ZohoCrmGetEmailsForRecordPageFactory;
@@ -612,8 +615,10 @@ export type ZohoCrmGetAttachmentsForRecordFunction = (input: ZohoCrmGetAttachmen
  * and category information. When no attachments exist for the record, the result
  * contains an empty data array rather than null.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that retrieves attachments for a record
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that retrieves attachments for a record.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
  *
  * @example
  * ```typescript
@@ -625,8 +630,6 @@ export type ZohoCrmGetAttachmentsForRecordFunction = (input: ZohoCrmGetAttachmen
  *   fields: 'File_Name,Size,Created_Time'
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
  */
 export declare function zohoCrmGetAttachmentsForRecord(context: ZohoCrmContext): ZohoCrmGetAttachmentsForRecordFunction;
 /**
@@ -640,8 +643,10 @@ export type ZohoCrmGetAttachmentsForRecordPageFactory = FetchPageFactory<ZohoCrm
  * across multiple pages. Wraps {@link zohoCrmGetAttachmentsForRecord} with
  * automatic pagination handling via {@link zohoFetchPageFactory}.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Page factory for iterating over record attachments
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Page factory for iterating over record attachments.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
  *
  * @example
  * ```typescript
@@ -661,7 +666,6 @@ export type ZohoCrmGetAttachmentsForRecordPageFactory = FetchPageFactory<ZohoCrm
  * }
  * ```
  *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoCrmGetAttachmentsForRecordPageFactory(context: ZohoCrmContext): ZohoCrmGetAttachmentsForRecordPageFactory;
@@ -700,9 +704,11 @@ export type ZohoCrmUploadAttachmentForRecordFunction = (input: ZohoCrmUploadAtta
  * multipart/form-data. An attachment category must be specified by ID or name.
  * Maximum file size is {@link ZOHO_CRM_ATTACHMENT_MAX_SIZE} (20MB).
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that uploads an attachment to a record
- * @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that uploads an attachment to a record.
+ * @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided.
+ *
+ * @see https://www.zoho.com/crm/developer/docs/api/v2.1/upload-attachment.html
  *
  * @example
  * ```typescript
@@ -715,8 +721,6 @@ export type ZohoCrmUploadAttachmentForRecordFunction = (input: ZohoCrmUploadAtta
  *   attachmentCategoryName: 'Resume'
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer/docs/api/v2.1/upload-attachment.html
  */
 export declare function zohoCrmUploadAttachmentForRecord(context: ZohoCrmContext): ZohoCrmUploadAttachmentForRecordFunction;
 export interface ZohoCrmDownloadAttachmentForRecordRequest extends ZohoCrmGetRecordByIdInput {
@@ -731,8 +735,10 @@ export type ZohoCrmDownloadAttachmentForRecordFunction = (input: ZohoCrmDownload
  * {@link FetchFileResponse} containing the file data and metadata extracted
  * from the response headers.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that downloads an attachment by record and attachment ID
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that downloads an attachment by record and attachment ID.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/download-attachments.html
  *
  * @example
  * ```typescript
@@ -744,8 +750,6 @@ export type ZohoCrmDownloadAttachmentForRecordFunction = (input: ZohoCrmDownload
  *   attachment_id: attachmentId
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/download-attachments.html
  */
 export declare function zohoCrmDownloadAttachmentForRecord(context: ZohoCrmContext): ZohoCrmDownloadAttachmentForRecordFunction;
 export interface ZohoCrmDeleteAttachmentFromRecordRequest extends ZohoCrmGetRecordByIdInput {
@@ -759,8 +763,10 @@ export type ZohoCrmDeleteAttachmentFromRecordFunction = (input: ZohoCrmDeleteAtt
  * Deletes a specific attachment from a record by its attachment ID.
  * Returns the raw {@link Response}.
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that deletes an attachment by record and attachment ID
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that deletes an attachment by record and attachment ID.
+ *
+ * @see https://www.zoho.com/crm/developer-guide/apiv2/delete-attachments.html
  *
  * @example
  * ```typescript
@@ -772,8 +778,6 @@ export type ZohoCrmDeleteAttachmentFromRecordFunction = (input: ZohoCrmDeleteAtt
  *   attachment_id: attachmentId
  * });
  * ```
- *
- * @see https://www.zoho.com/crm/developer-guide/apiv2/delete-attachments.html
  */
 export declare function zohoCrmDeleteAttachmentFromRecord(context: ZohoCrmContext): ZohoCrmDeleteAttachmentFromRecordFunction;
 export type ZohoCrmExecuteRestApiFunctionRequest = ZohoCrmExecuteRestApiFunctionNormalRequest | ZohoCrmExecuteRestApiFunctionApiSpecificRequest;
@@ -836,9 +840,9 @@ export type ZohoCrmExecuteRestApiFunctionFunction = (input: ZohoCrmExecuteRestAp
  * - There is no documentation for ZohoCrm specifically, but it seems to behave the same way
  * - You will need the following scopes: ZohoCrm.functions.execute.READ,ZohoCrm.functions.execute.CREATE
  *
- * @param context - Authenticated Zoho CRM context providing fetch and rate limiting
- * @returns Function that executes serverless functions via the REST API
- * @throws {ZohoCrmExecuteRestApiFunctionError} If the function execution fails
+ * @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
+ * @returns Function that executes serverless functions via the REST API.
+ * @throws {ZohoCrmExecuteRestApiFunctionError} If the function execution fails.
  *
  * @example
  * ```typescript
@@ -860,33 +864,30 @@ export type ZohoCrmExecuteRestApiFunctionFunction = (input: ZohoCrmExecuteRestAp
  *   apiUrl: 'production'
  * });
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoCrmExecuteRestApiFunction(context: ZohoCrmContext): ZohoCrmExecuteRestApiFunctionFunction;
 /**
  * Builds URL search params from the input objects, omitting the `module` key since it is used in the URL path rather than as a query parameter.
  *
- * @param input - One or more objects to convert into URL search parameters
- * @returns URL search params string with the `module` key excluded
+ * @param input - One or more objects to convert into URL search parameters.
+ * @returns URL search params string with the `module` key excluded.
  */
 export declare function zohoCrmUrlSearchParamsMinusModule(...input: Maybe<object | Record<string, string | number>>[]): URLSearchParams;
 /**
  * Builds URL search params from the input objects, omitting both `id` and `module` keys since they are used in the URL path.
  *
- * @param input - One or more objects to convert into URL search parameters
- * @returns URL search params string with `id` and `module` keys excluded
+ * @param input - One or more objects to convert into URL search parameters.
+ * @returns URL search params string with `id` and `module` keys excluded.
  */
 export declare function zohoCrmUrlSearchParamsMinusIdAndModule(...input: Maybe<object | Record<string, string | number>>[]): URLSearchParams;
-/**
- * @deprecated use makeUrlSearchParams instead.
- */
-export declare const zohoCrmUrlSearchParams: typeof makeUrlSearchParams;
 /**
  * Constructs the standard FetchJsonInput used by CRM API calls, pairing the HTTP method with an optional body.
  *
- * @param method - HTTP method to use for the request
- * @param body - Optional request body to include
- * @returns Configured fetch input for the Zoho CRM API call
+ * @param method - HTTP method to use for the request.
+ * @param body - Optional request body to include.
+ * @returns Configured fetch input for the Zoho CRM API call.
  */
 export declare function zohoCrmApiFetchJsonInput(method: string, body?: Maybe<FetchJsonBody>): FetchJsonInput;
 /**
@@ -894,8 +895,9 @@ export declare function zohoCrmApiFetchJsonInput(method: string, body?: Maybe<Fe
  *
  * Use to catch errors from functions that return ZohoCrmChangeObjectLikeResponse and pass the result to zohoCrmChangeObjectLikeResponseSuccessAndErrorPairs.
  *
- * @param e - The error to catch and potentially convert
- * @returns The error data array wrapped as a change object response
+ * @param e - The error to catch and potentially convert.
+ * @returns The error data array wrapped as a change object response.
+ * @throws Re-throws `e` when it is not a {@link ZohoServerFetchResponseDataArrayError}.
  */
 export declare function zohoCrmCatchZohoCrmChangeObjectLikeResponseError<R extends ZohoCrmChangeObjectLikeResponse<any>>(e: unknown): R;
 export type ZohoCrmChangeObjectLikeResponse<T extends ZohoCrmChangeObjectLikeResponseEntry = ZohoCrmChangeObjectLikeResponseEntry> = ZohoDataArrayResultRef<T>;
@@ -920,8 +922,8 @@ export type ZohoCrmChangeObjectLikeResponseSuccessAndErrorPairs<T extends ZohoCr
  * Used internally by {@link zohoCrmDeleteRecord} 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
@@ -964,9 +966,9 @@ export interface ZohoCrmMultiRecordResultItem {
  * 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 zohoCrmMultiRecordResult<I, OS extends ZohoCrmMultiRecordResultItem, OE extends ZohoCrmMultiRecordResultItem>(input: I[], results: (OS | OE)[]): ZohoCrmMultiRecordResult<I, OS, OE>;
 export interface ZohoCrmMultiRecordResultEntry<I, O> {
@@ -979,6 +981,10 @@ export interface ZohoCrmMultiRecordResultEntry<I, O> {
      */
     readonly result: O;
 }
+/**
+ * @deprecated use makeUrlSearchParams instead.
+ */
+export declare const zohoCrmUrlSearchParams: typeof makeUrlSearchParams;
 /**
  * @deprecated use ZohoCrmGetRelatedRecordsPageFilter instead.
  */

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

@@ -29,8 +29,8 @@ export type ZohoCrmCreateNotesFunction = (input: ZohoCrmCreateNotesRequest) => P
  *
  * For creating notes associated with a specific record, prefer {@link zohoCrmCreateNotesForRecord} which handles parent binding automatically.
  *
- * @param context - Authenticated Zoho CRM context for making API calls
- * @returns Function that creates notes in the CRM Notes module
+ * @param context - Authenticated Zoho CRM context for making API calls.
+ * @returns Function that creates notes in the CRM Notes module.
  */
 export declare function zohoCrmCreateNotes(context: ZohoCrmContext): (input: ZohoCrmCreateNotesRequest) => Promise<ZohoCrmMultiRecordResult<NewZohoCrmNoteData, ZohoCrmChangeObjectResponseSuccessEntry<import("./crm").ZohoCrmChangeObjectDetails>, ZohoCrmChangeObjectResponseErrorEntry>>;
 /**
@@ -51,8 +51,8 @@ export type ZohoCrmDeleteNotesFunction = (input: ZohoCrmDeleteNotesRequest) => P
 /**
  * Deletes one or more notes from the CRM Notes module by their IDs.
  *
- * @param context - Authenticated Zoho CRM context for making API calls
- * @returns Function that deletes notes by their IDs
+ * @param context - Authenticated Zoho CRM context for making API calls.
+ * @returns Function that deletes notes by their IDs.
  */
 export declare function zohoCrmDeleteNotes(context: ZohoCrmContext): (input: ZohoCrmDeleteNotesRequest) => Promise<ZohoCrmMultiRecordResult<string, ZohoCrmChangeObjectResponseSuccessEntry<import("./crm").ZohoCrmChangeObjectDetails>, ZohoCrmChangeObjectResponseErrorEntry>>;
 /**
@@ -67,16 +67,17 @@ export type ZohoCrmGetNotesForRecordFunction = (input: ZohoCrmGetNotesForRecordR
 /**
  * Retrieves paginated notes associated with a specific CRM record using the related records API.
  *
- * @param context - Authenticated Zoho CRM context for making API calls
- * @returns Function that retrieves notes for a specific record
+ * @param context - Authenticated Zoho CRM context for making API calls.
+ * @returns Function that retrieves notes for a specific record.
  */
 export declare function zohoCrmGetNotesForRecord(context: ZohoCrmContext): ZohoCrmGetNotesForRecordFunction;
 export type ZohoCrmGetNotesForRecordPageFactory = FetchPageFactory<ZohoCrmGetNotesForRecordRequest, ZohoCrmGetNotesForRecordResponse>;
 /**
  * Creates a page factory for iterating through all notes for a record across multiple pages.
  *
- * @param context - Authenticated Zoho CRM context for making API calls
- * @returns Page factory for paginating through notes for a record
+ * @param context - Authenticated Zoho CRM context for making API calls.
+ * @returns Page factory for paginating through notes for a record.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoCrmGetNotesForRecordPageFactory(context: ZohoCrmContext): ZohoCrmGetNotesForRecordPageFactory;
@@ -93,7 +94,7 @@ export type ZohoCrmCreateNotesForRecordFunction = (input: ZohoCrmCreateNotesForR
  *
  * https://www.zoho.com/crm/developer/docs/api/v8/create-notes.html
  *
- * @param context - Authenticated Zoho CRM context for making API calls
- * @returns Function that creates notes bound to a specific record
+ * @param context - Authenticated Zoho CRM context for making API calls.
+ * @returns Function that creates notes bound to a specific record.
  */
 export declare function zohoCrmCreateNotesForRecord(context: ZohoCrmContext): ZohoCrmCreateNotesForRecordFunction;

package/src/lib/crm/crm.api.tags.d.ts

@@ -32,8 +32,8 @@ export type ZohoCrmCreateTagsFunction = (input: ZohoCrmCreateTagsRequest) => Pro
 /**
  * Creates one or more tags for a CRM module. Duplicate tag errors are separated from other errors in the result to simplify idempotent workflows.
  *
- * @param context - Authenticated Zoho CRM context for making API calls
- * @returns Function that creates tags for a module
+ * @param context - Authenticated Zoho CRM context for making API calls.
+ * @returns Function that creates tags for a module.
  */
 export declare function zohoCrmCreateTagsForModule(context: ZohoCrmContext): (input: ZohoCrmCreateTagsRequest) => Promise<{
     errorItems: ZohoCrmMultiRecordResultEntry<ZohoCrmCreateTagData, ZohoCrmChangeObjectResponseErrorEntry>[];
@@ -70,8 +70,8 @@ export type ZohoCrmDeleteTagFunction = (input: ZohoCrmDeleteTagRequest) => Promi
  *
  * https://www.zoho.com/crm/developer/docs/api/v8/delete-tag.html
  *
- * @param context - Authenticated Zoho CRM context for making API calls
- * @returns Function that deletes a tag by ID
+ * @param context - Authenticated Zoho CRM context for making API calls.
+ * @returns Function that deletes a tag by ID.
  */
 export declare function zohoCrmDeleteTag(context: ZohoCrmContext): ZohoCrmDeleteTagFunction;
 /**
@@ -96,16 +96,17 @@ export type ZohoCrmGetTagsFunction = (input: ZohoCrmGetTagsRequest) => Promise<Z
  *
  * https://www.zoho.com/crm/developer-guide/apiv2/get-tag-list.html
  *
- * @param context - Authenticated Zoho CRM context for making API calls
- * @returns Function that retrieves tags for a module
+ * @param context - Authenticated Zoho CRM context for making API calls.
+ * @returns Function that retrieves tags for a module.
  */
 export declare function zohoCrmGetTagsForModule(context: ZohoCrmContext): ZohoCrmGetTagsFunction;
 export type ZohoCrmGetTagsForModulePageFactory = (input: ZohoCrmGetTagsRequest, options?: Maybe<FetchPageFactoryOptions<ZohoCrmGetTagsRequest, ZohoCrmGetTagsResult>>) => FetchPage<ZohoCrmGetTagsRequest, ZohoCrmGetTagsResult>;
 /**
  * Creates a page factory for iterating through all tags in a module across multiple pages.
  *
- * @param context - Authenticated Zoho CRM context for making API calls
- * @returns Page factory for paginating through tags in a module
+ * @param context - Authenticated Zoho CRM context for making API calls.
+ * @returns Page factory for paginating through tags in a module.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoCrmGetTagsForModulePageFactory(context: ZohoCrmContext): ZohoCrmGetTagsForModulePageFactory;
@@ -172,15 +173,16 @@ export type ZohoCrmAddTagsToRecordsFunction = (input: ZohoCrmAddTagsToRecordsReq
  *
  * https://www.zoho.com/crm/developer-guide/apiv2/add-tags.html
  *
- * @param context - Authenticated Zoho CRM context for making API calls
- * @returns Function that adds tags to records
+ * @param context - Authenticated Zoho CRM context for making API calls.
+ * @returns Function that adds tags to records.
  */
 export declare function zohoCrmAddTagsToRecords(context: ZohoCrmContext): ZohoCrmAddTagsToRecordsFunction;
 /**
  * Builds the request body for the add/remove tags endpoints, merging `tag_names` into `tags` and enforcing the max ID limit.
  *
- * @param input - The add/remove tags request containing tag names, tag objects, and record IDs
- * @returns The formatted request body with merged tags and record IDs
+ * @param input - The add/remove tags request containing tag names, tag objects, and record IDs.
+ * @returns The formatted request body with merged tags and record IDs.
+ * @throws {Error} When `input.ids` exceeds {@link ZOHO_CRM_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED}.
  */
 export declare function zohoCrmAddTagsToRecordsRequestBody(input: ZohoCrmAddTagsToRecordsRequest): {
     tags: (ZohoCrmTagData & {
@@ -227,7 +229,7 @@ export type ZohoCrmRemoveTagsFromRecordsFunction = (input: ZohoCrmRemoveTagsFrom
  *
  * https://www.zoho.com/crm/developer-guide/apiv2/remove-tags.html
  *
- * @param context - Authenticated Zoho CRM context for making API calls
- * @returns Function that removes tags from records
+ * @param context - Authenticated Zoho CRM context for making API calls.
+ * @returns Function that removes tags from records.
  */
 export declare function zohoCrmRemoveTagsFromRecords(context: ZohoCrmContext): ZohoCrmRemoveTagsFromRecordsFunction;

package/src/lib/crm/crm.config.d.ts

@@ -22,8 +22,8 @@ export type ZohoCrmConfigApiUrlInput = ZohoCrmApiUrlKey | ZohoCrmApiUrl;
 /**
  * Resolves a CRM API URL input to its full base URL. Well-known keys ('sandbox', 'production') map to their respective Zoho CRM endpoints; custom URLs pass through unchanged.
  *
- * @param input - A well-known environment key or a custom CRM API URL
- * @returns The resolved full Zoho CRM API base URL
+ * @param input - A well-known environment key or a custom CRM API URL.
+ * @returns The resolved full Zoho CRM API base URL.
  */
 export declare function zohoCrmConfigApiUrl(input: ZohoCrmConfigApiUrlInput): ZohoApiUrl;
 /**

package/src/lib/crm/crm.d.ts

@@ -1,4 +1,4 @@
-import { type CommaSeparatedString, type EmailAddress, type ISO8601DateString, type Maybe, type UniqueModelWithId, type WebsiteUrl } from '@dereekb/util';
+import { type CommaSeparatedString, type EmailAddress, type ISO8601DateString, type SuggestedString, type Maybe, type UniqueModelWithId, type WebsiteUrl } from '@dereekb/util';
 /**
  * Zoho CRM module name.
  *
@@ -203,7 +203,7 @@ export interface ZohoCrmRecordEmailMetadata {
      */
     status: ZohoCrmRecordEmailMetadataStatus[];
 }
-export type ZohoCrmRecordEmailMetadataStatusType = 'sent' | (string & {});
+export type ZohoCrmRecordEmailMetadataStatusType = SuggestedString<'sent'>;
 export interface ZohoCrmRecordEmailMetadataStatus {
     type: ZohoCrmRecordEmailMetadataStatusType;
 }

package/src/lib/crm/crm.error.api.d.ts

@@ -67,16 +67,16 @@ export declare class ZohoCrmRecordCrudNoMatchingRecordError extends ZohoCrmRecor
 /**
  * Maps a Zoho CRM server error to the appropriate typed {@link ZohoCrmRecordCrudError} subclass based on the error code and affected field.
  *
- * @param error - The server error data containing the error code and field details
- * @returns The appropriate typed CRM CRUD error instance
+ * @param error - The server error data containing the error code and field details.
+ * @returns The appropriate typed CRM CRUD error instance.
  */
 export declare function zohoCrmRecordCrudError(error: ZohoServerErrorDataWithDetails): ZohoCrmRecordCrudError;
 /**
  * Returns an assertion function that throws {@link ZohoCrmRecordNoContentError} when a data array result is empty or null, typically indicating a missing record.
  *
- * @param moduleName - Optional CRM module name for the error context
- * @param recordId - Optional record ID for the error context
- * @returns Assertion function that throws if the data array is empty
+ * @param moduleName - Optional CRM module name for the error context.
+ * @param recordId - Optional record ID for the error context.
+ * @returns Assertion function that throws if the data array is empty.
  */
 export declare function assertZohoCrmRecordDataArrayResultHasContent<T>(moduleName?: ZohoCrmModuleName, recordId?: ZohoCrmRecordId): <R extends ZohoDataArrayResultRef<T>>(x: R) => R;
 /**
@@ -86,16 +86,16 @@ export declare const logZohoCrmErrorToConsole: import("..").LogZohoServerErrorFu
 /**
  * Parses a fetch response error into a typed Zoho CRM server error by extracting and interpreting the JSON error body.
  *
- * @param responseError - The fetch response error to parse
- * @returns The parsed Zoho server error, or undefined if the response could not be parsed
+ * @param responseError - The fetch response error to parse.
+ * @returns The parsed Zoho server error, or undefined if the response could not be parsed.
  */
 export declare function parseZohoCrmError(responseError: FetchResponseError): Promise<ParsedZohoServerError>;
 /**
  * Parses a Zoho CRM error response body into a typed error. Delegates to CRM-specific error code handling before falling back to the generic Zoho error parser.
  *
- * @param errorResponseData - The raw error response data from the Zoho CRM API
- * @param responseError - The original fetch response error for context
- * @returns The parsed Zoho server error, or undefined if the error could not be classified
+ * @param errorResponseData - The raw error response data from the Zoho CRM API.
+ * @param responseError - The original fetch response error for context.
+ * @returns The parsed Zoho server error, or undefined if the error could not be classified.
  */
 export declare function parseZohoCrmServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData | ZohoServerErrorResponseDataArrayRef, responseError: FetchResponseError): ParsedZohoServerError;
 /**

package/src/lib/crm/crm.factory.d.ts

@@ -38,8 +38,8 @@ export type ZohoCrmFactory = (config: ZohoCrmConfig) => ZohoCrm;
  * Each client handles OAuth token refresh on {@link ZohoInvalidTokenError}, rate limiting,
  * and Zoho CRM's non-standard error responses (200 status with error body).
  *
- * @param factoryConfig - Configuration providing account credentials and optional overrides
- * @returns A factory function that creates authenticated Zoho CRM clients
+ * @param factoryConfig - Configuration providing account credentials and optional overrides.
+ * @returns A factory function that creates authenticated Zoho CRM clients.
  *
  * @example
  * ```typescript
@@ -54,6 +54,7 @@ export type ZohoCrmFactory = (config: ZohoCrmConfig) => ZohoCrm;
  * // Use the CRM context for API calls:
  * const { crmContext } = zohoCrm;
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoCrmFactory(factoryConfig: ZohoCrmFactoryConfig): ZohoCrmFactory;