@dereekb/zoho 13.4.0 → 13.4.2

package/nestjs/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@dereekb/zoho/nestjs",
-  "version": "13.4.0",
+  "version": "13.4.2",
   "peerDependencies": {
-    "@dereekb/nestjs": "13.4.0",
-    "@dereekb/util": "13.4.0",
-    "@dereekb/zoho": "13.4.0",
+    "@dereekb/nestjs": "13.4.2",
+    "@dereekb/util": "13.4.2",
+    "@dereekb/zoho": "13.4.2",
     "@nestjs/common": "^11.1.16",
     "@nestjs/config": "^4.0.3",
     "express": "^5.0.0"

package/nestjs/src/lib/accounts/accounts.service.d.ts

@@ -13,6 +13,11 @@ export declare abstract class ZohoAccountsAccessTokenCacheService {
     abstract loadZohoAccessTokenCache(service: ZohoServiceAccessTokenKey): ZohoAccessTokenCache;
 }
 export type LogMergeZohoAccountsAccessTokenCacheServiceErrorFunction = (failedUpdates: (readonly [ZohoAccessTokenCache, unknown])[]) => void;
+/**
+ * Default error logging function for merged Zoho access token cache services.
+ *
+ * @param failedUpdates - array of cache/error tuples that failed during update
+ */
 export declare function logMergeZohoAccountsAccessTokenCacheServiceErrorFunction(failedUpdates: (readonly [ZohoAccessTokenCache, unknown])[]): void;
 /**
  * Merges the input services in order to use some as a backup source.
@@ -22,12 +27,17 @@ export declare function logMergeZohoAccountsAccessTokenCacheServiceErrorFunction
  * When updating a cached token, it will update the token across all services.
  *
  * @param servicesToMerge Must include atleast one service. Empty arrays will throw an error.
+ * @param inputServicesToMerge - cache services to merge in priority order
+ * @param logError - optional error logging toggle or custom logging function
+ * @returns a merged ZohoAccountsAccessTokenCacheService that delegates across all inputs
  */
 export declare function mergeZohoAccountsAccessTokenCacheServices(inputServicesToMerge: ZohoAccountsAccessTokenCacheService[], logError?: Maybe<boolean | LogMergeZohoAccountsAccessTokenCacheServiceErrorFunction>): ZohoAccountsAccessTokenCacheService;
 /**
  * Creates a ZohoAccountsAccessTokenCacheService that uses in-memory storage.
  *
- * @returns
+ * @param existingCache - optional pre-populated token cache record to use as initial state
+ * @param logAccessToConsole - whether to log cache reads and writes to the console
+ * @returns a ZohoAccountsAccessTokenCacheService backed by in-memory storage
  */
 export declare function memoryZohoAccountsAccessTokenCacheService(existingCache?: ZohoAccountsAccessTokenCacheRecord, logAccessToConsole?: boolean): ZohoAccountsAccessTokenCacheService;
 export interface FileSystemZohoAccountsAccessTokenCacheService extends ZohoAccountsAccessTokenCacheService {
@@ -41,6 +51,8 @@ export declare const DEFAULT_FILE_ZOHO_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH
  *
  * Useful for testing.
  *
- * @returns
+ * @param filename - path to the JSON file used for token persistence
+ * @param useMemoryCache - whether to also cache tokens in memory for faster reads
+ * @returns a FileSystemZohoAccountsAccessTokenCacheService backed by file storage
  */
 export declare function fileZohoAccountsAccessTokenCacheService(filename?: string, useMemoryCache?: boolean): FileSystemZohoAccountsAccessTokenCacheService;

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

@@ -16,74 +16,189 @@ export declare class ZohoCrmApi {
     readonly zohoCrm: ZohoCrm;
     /**
      * The authenticated CRM context used by all operation accessors.
+     *
+     * @returns the CRM context from the underlying client
      */
     get crmContext(): ZohoCrmContext;
     /**
      * Rate limiter shared across all CRM requests to respect Zoho API quotas.
+     *
+     * @returns the shared rate limiter instance
      */
     get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
     /**
      * Initializes the CRM client by combining the service config with the
      * accounts context for OAuth token management.
+     *
+     * @param config - Zoho CRM service configuration
+     * @param zohoAccountsApi - accounts API used for OAuth token management
      */
     constructor(config: ZohoCrmServiceConfig, zohoAccountsApi: ZohoAccountsApi);
-    /** Configured pass-through for {@link zohoCrmInsertRecord}. */
+    /**
+     * Configured pass-through for {@link zohoCrmInsertRecord}.
+     *
+     * @returns bound insert record function
+     */
     get insertRecord(): import("@dereekb/zoho").ZohoCrmCreateRecordLikeFunction;
-    /** Configured pass-through for {@link zohoCrmUpsertRecord}. */
+    /**
+     * Configured pass-through for {@link zohoCrmUpsertRecord}.
+     *
+     * @returns bound upsert record function
+     */
     get upsertRecord(): import("@dereekb/zoho").ZohoCrmUpsertRecordLikeFunction;
-    /** Configured pass-through for {@link zohoCrmUpdateRecord}. */
+    /**
+     * Configured pass-through for {@link zohoCrmUpdateRecord}.
+     *
+     * @returns bound update record function
+     */
     get updateRecord(): import("@dereekb/zoho").ZohoCrmUpdateRecordLikeFunction;
-    /** Configured pass-through for {@link zohoCrmDeleteRecord}. */
+    /**
+     * Configured pass-through for {@link zohoCrmDeleteRecord}.
+     *
+     * @returns bound delete record function
+     */
     get deleteRecord(): import("@dereekb/zoho").ZohoCrmDeleteRecordFunction;
-    /** Configured pass-through for {@link zohoCrmGetRecordById}. */
+    /**
+     * Configured pass-through for {@link zohoCrmGetRecordById}.
+     *
+     * @returns bound get record by ID function
+     */
     get getRecordById(): import("@dereekb/zoho").ZohoCrmGetRecordByIdFunction;
-    /** Configured pass-through for {@link zohoCrmGetRecords}. */
+    /**
+     * Configured pass-through for {@link zohoCrmGetRecords}.
+     *
+     * @returns bound get records function
+     */
     get getRecords(): import("@dereekb/zoho").ZohoCrmGetRecordsFunction;
-    /** Configured pass-through for {@link zohoCrmSearchRecords}. */
+    /**
+     * Configured pass-through for {@link zohoCrmSearchRecords}.
+     *
+     * @returns bound search records function
+     */
     get searchRecords(): import("@dereekb/zoho").ZohoCrmSearchRecordsFunction;
-    /** Configured pass-through for {@link zohoCrmSearchRecordsPageFactory}. */
+    /**
+     * Configured pass-through for {@link zohoCrmSearchRecordsPageFactory}.
+     *
+     * @returns bound search records page factory function
+     */
     get searchRecordsPageFactory(): import("@dereekb/zoho").ZohoCrmSearchRecordsPageFactory;
-    /** Configured pass-through for {@link zohoCrmGetRelatedRecordsFunctionFactory}. */
+    /**
+     * Configured pass-through for {@link zohoCrmGetRelatedRecordsFunctionFactory}.
+     *
+     * @returns bound get related records factory function
+     */
     get getRelatedRecordsFunctionFactory(): import("@dereekb/zoho").ZohoCrmGetRelatedRecordsFunctionFactory;
-    /** Configured pass-through for {@link zohoCrmGetEmailsForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoCrmGetEmailsForRecord}.
+     *
+     * @returns bound get emails for record function
+     */
     get getEmailsForRecord(): import("@dereekb/zoho").ZohoCrmGetEmailsForRecordFunction;
-    /** Configured pass-through for {@link zohoCrmGetEmailsForRecordPageFactory}. */
+    /**
+     * Configured pass-through for {@link zohoCrmGetEmailsForRecordPageFactory}.
+     *
+     * @returns bound get emails page factory function
+     */
     get getEmailsForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetEmailsForRecordPageFactory;
-    /** Configured pass-through for {@link zohoCrmGetAttachmentsForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoCrmGetAttachmentsForRecord}.
+     *
+     * @returns bound get attachments for record function
+     */
     get getAttachmentsForRecord(): import("@dereekb/zoho").ZohoCrmGetAttachmentsForRecordFunction;
-    /** Configured pass-through for {@link zohoCrmGetAttachmentsForRecordPageFactory}. */
+    /**
+     * Configured pass-through for {@link zohoCrmGetAttachmentsForRecordPageFactory}.
+     *
+     * @returns bound get attachments page factory function
+     */
     get getAttachmentsForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetAttachmentsForRecordPageFactory;
-    /** Configured pass-through for {@link zohoCrmUploadAttachmentForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoCrmUploadAttachmentForRecord}.
+     *
+     * @returns bound upload attachment function
+     */
     get uploadAttachmentForRecord(): import("@dereekb/zoho").ZohoCrmUploadAttachmentForRecordFunction;
-    /** Configured pass-through for {@link zohoCrmDownloadAttachmentForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoCrmDownloadAttachmentForRecord}.
+     *
+     * @returns bound download attachment function
+     */
     get downloadAttachmentForRecord(): import("@dereekb/zoho").ZohoCrmDownloadAttachmentForRecordFunction;
-    /** Configured pass-through for {@link zohoCrmDeleteAttachmentFromRecord}. */
+    /**
+     * Configured pass-through for {@link zohoCrmDeleteAttachmentFromRecord}.
+     *
+     * @returns bound delete attachment function
+     */
     get deleteAttachmentFromRecord(): import("@dereekb/zoho").ZohoCrmDeleteAttachmentFromRecordFunction;
-    /** Configured pass-through for {@link zohoCrmCreateNotes}. */
+    /**
+     * Configured pass-through for {@link zohoCrmCreateNotes}.
+     *
+     * @returns bound create notes function
+     */
     get createNotes(): (input: import("@dereekb/zoho").ZohoCrmCreateNotesRequest) => Promise<import("@dereekb/zoho").ZohoCrmMultiRecordResult<import("@dereekb/zoho").NewZohoCrmNoteData, import("@dereekb/zoho").ZohoCrmChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoCrmChangeObjectDetails>, import("@dereekb/zoho").ZohoCrmChangeObjectResponseErrorEntry>>;
-    /** Configured pass-through for {@link zohoCrmDeleteNotes}. */
+    /**
+     * Configured pass-through for {@link zohoCrmDeleteNotes}.
+     *
+     * @returns bound delete notes function
+     */
     get deleteNotes(): (input: import("@dereekb/zoho").ZohoCrmDeleteNotesRequest) => Promise<import("@dereekb/zoho").ZohoCrmMultiRecordResult<string, import("@dereekb/zoho").ZohoCrmChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoCrmChangeObjectDetails>, import("@dereekb/zoho").ZohoCrmChangeObjectResponseErrorEntry>>;
-    /** Configured pass-through for {@link zohoCrmCreateNotesForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoCrmCreateNotesForRecord}.
+     *
+     * @returns bound create notes for record function
+     */
     get createNotesForRecord(): import("@dereekb/zoho").ZohoCrmCreateNotesForRecordFunction;
-    /** Configured pass-through for {@link zohoCrmGetNotesForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoCrmGetNotesForRecord}.
+     *
+     * @returns bound get notes for record function
+     */
     get getNotesForRecord(): import("@dereekb/zoho").ZohoCrmGetNotesForRecordFunction;
-    /** Configured pass-through for {@link zohoCrmGetNotesForRecordPageFactory}. */
+    /**
+     * Configured pass-through for {@link zohoCrmGetNotesForRecordPageFactory}.
+     *
+     * @returns bound get notes page factory function
+     */
     get getNotesForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetNotesForRecordPageFactory;
-    /** Configured pass-through for {@link zohoCrmExecuteRestApiFunction}. */
+    /**
+     * Configured pass-through for {@link zohoCrmExecuteRestApiFunction}.
+     *
+     * @returns bound execute REST API function
+     */
     get executeRestApiFunction(): import("@dereekb/zoho").ZohoCrmExecuteRestApiFunctionFunction;
-    /** Configured pass-through for {@link zohoCrmCreateTagsForModule}. */
+    /**
+     * Configured pass-through for {@link zohoCrmCreateTagsForModule}.
+     *
+     * @returns bound create tags for module function
+     */
     get createTagsForModule(): (input: import("@dereekb/zoho").ZohoCrmCreateTagsRequest) => Promise<{
         errorItems: import("@dereekb/zoho").ZohoCrmMultiRecordResultEntry<import("@dereekb/zoho").ZohoCrmCreateTagData, import("@dereekb/zoho").ZohoCrmChangeObjectResponseErrorEntry>[];
         duplicateErrorItems: import("@dereekb/zoho").ZohoCrmMultiRecordResultEntry<import("@dereekb/zoho").ZohoCrmCreateTagData, import("@dereekb/zoho").ZohoCrmChangeObjectResponseErrorEntry>[];
         allErrorItems: import("@dereekb/zoho").ZohoCrmMultiRecordResultEntry<import("@dereekb/zoho").ZohoCrmCreateTagData, import("@dereekb/zoho").ZohoCrmChangeObjectResponseErrorEntry>[];
         successItems: import("@dereekb/zoho").ZohoCrmMultiRecordResultEntry<import("@dereekb/zoho").ZohoCrmCreateTagData, import("@dereekb/zoho").ZohoCrmChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoCrmChangeObjectDetails>>[];
     }>;
-    /** Configured pass-through for {@link zohoCrmDeleteTag}. */
+    /**
+     * Configured pass-through for {@link zohoCrmDeleteTag}.
+     *
+     * @returns bound delete tag function
+     */
     get deleteTag(): import("@dereekb/zoho").ZohoCrmDeleteTagFunction;
-    /** Configured pass-through for {@link zohoCrmGetTagsForModule}. */
+    /**
+     * Configured pass-through for {@link zohoCrmGetTagsForModule}.
+     *
+     * @returns bound get tags for module function
+     */
     get getTagsForModule(): import("@dereekb/zoho").ZohoCrmGetTagsFunction;
-    /** Configured pass-through for {@link zohoCrmAddTagsToRecords}. */
+    /**
+     * Configured pass-through for {@link zohoCrmAddTagsToRecords}.
+     *
+     * @returns bound add tags to records function
+     */
     get addTagsToRecords(): import("@dereekb/zoho").ZohoCrmAddTagsToRecordsFunction;
-    /** Configured pass-through for {@link zohoCrmRemoveTagsFromRecords}. */
+    /**
+     * Configured pass-through for {@link zohoCrmRemoveTagsFromRecords}.
+     *
+     * @returns bound remove tags from records function
+     */
     get removeTagsFromRecords(): import("@dereekb/zoho").ZohoCrmRemoveTagsFromRecordsFunction;
 }

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

@@ -20,6 +20,8 @@ export declare abstract class ZohoCrmServiceConfig {
     readonly factoryConfig?: ZohoCrmFactoryConfig;
     /**
      * Validates that the required Zoho CRM connection fields are present and well-formed.
+     *
+     * @param config - the CRM service config to validate
      */
     static assertValidConfig(config: ZohoCrmServiceConfig): void;
 }

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

@@ -16,82 +16,213 @@ export declare class ZohoRecruitApi {
     readonly zohoRecruit: ZohoRecruit;
     /**
      * The authenticated Recruit context used by all operation accessors.
+     *
+     * @returns the Recruit context from the underlying client
      */
     get recruitContext(): ZohoRecruitContext;
     /**
      * Rate limiter shared across all Recruit requests to respect Zoho API quotas.
+     *
+     * @returns the shared rate limiter instance
      */
     get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
     /**
      * Initializes the Recruit client by combining the service config with the
      * accounts context for OAuth token management.
+     *
+     * @param config - Zoho Recruit service configuration
+     * @param zohoAccountsApi - accounts API used for OAuth token management
      */
     constructor(config: ZohoRecruitServiceConfig, zohoAccountsApi: ZohoAccountsApi);
-    /** Configured pass-through for {@link zohoRecruitInsertRecord}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitInsertRecord}.
+     *
+     * @returns bound insert record function
+     */
     get insertRecord(): import("@dereekb/zoho").ZohoRecruitCreateRecordLikeFunction;
-    /** Configured pass-through for {@link zohoRecruitUpsertRecord}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitUpsertRecord}.
+     *
+     * @returns bound upsert record function
+     */
     get upsertRecord(): import("@dereekb/zoho").ZohoRecruitUpsertRecordLikeFunction;
-    /** Configured pass-through for {@link zohoRecruitUpdateRecord}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitUpdateRecord}.
+     *
+     * @returns bound update record function
+     */
     get updateRecord(): import("@dereekb/zoho").ZohoRecruitUpdateRecordLikeFunction;
-    /** Configured pass-through for {@link zohoRecruitDeleteRecord}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitDeleteRecord}.
+     *
+     * @returns bound delete record function
+     */
     get deleteRecord(): import("@dereekb/zoho").ZohoRecruitDeleteRecordFunction;
-    /** Configured pass-through for {@link zohoRecruitGetRecordById}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitGetRecordById}.
+     *
+     * @returns bound get record by ID function
+     */
     get getRecordById(): import("@dereekb/zoho").ZohoRecruitGetRecordByIdFunction;
-    /** Configured pass-through for {@link zohoRecruitGetRecords}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitGetRecords}.
+     *
+     * @returns bound get records function
+     */
     get getRecords(): import("@dereekb/zoho").ZohoRecruitGetRecordsFunction;
-    /** Configured pass-through for {@link zohoRecruitSearchRecords}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitSearchRecords}.
+     *
+     * @returns bound search records function
+     */
     get searchRecords(): import("@dereekb/zoho").ZohoRecruitSearchRecordsFunction;
-    /** Configured pass-through for {@link zohoRecruitSearchRecordsPageFactory}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitSearchRecordsPageFactory}.
+     *
+     * @returns bound search records page factory function
+     */
     get searchRecordsPageFactory(): import("@dereekb/zoho").ZohoRecruitSearchRecordsPageFactory;
-    /** Configured pass-through for {@link zohoRecruitGetRelatedRecordsFunctionFactory}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitGetRelatedRecordsFunctionFactory}.
+     *
+     * @returns bound get related records factory function
+     */
     get getRelatedRecordsFunctionFactory(): import("@dereekb/zoho").ZohoRecruitGetRelatedRecordsFunctionFactory;
-    /** Configured pass-through for {@link zohoRecruitGetEmailsForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitGetEmailsForRecord}.
+     *
+     * @returns bound get emails for record function
+     */
     get getEmailsForRecord(): import("@dereekb/zoho").ZohoRecruitGetEmailsForRecordFunction;
-    /** Configured pass-through for {@link zohoRecruitGetEmailsForRecordPageFactory}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitGetEmailsForRecordPageFactory}.
+     *
+     * @returns bound get emails page factory function
+     */
     get getEmailsForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetEmailsForRecordPageFactory;
-    /** Configured pass-through for {@link zohoRecruitGetAttachmentsForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitGetAttachmentsForRecord}.
+     *
+     * @returns bound get attachments for record function
+     */
     get getAttachmentsForRecord(): import("@dereekb/zoho").ZohoRecruitGetAttachmentsForRecordFunction;
-    /** Configured pass-through for {@link zohoRecruitGetAttachmentsForRecordPageFactory}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitGetAttachmentsForRecordPageFactory}.
+     *
+     * @returns bound get attachments page factory function
+     */
     get getAttachmentsForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetAttachmentsForRecordPageFactory;
-    /** Configured pass-through for {@link zohoRecruitUploadAttachmentForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitUploadAttachmentForRecord}.
+     *
+     * @returns bound upload attachment function
+     */
     get uploadAttachmentForRecord(): import("@dereekb/zoho").ZohoRecruitUploadAttachmentForRecordFunction;
-    /** Configured pass-through for {@link zohoRecruitDownloadAttachmentForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitDownloadAttachmentForRecord}.
+     *
+     * @returns bound download attachment function
+     */
     get downloadAttachmentForRecord(): import("@dereekb/zoho").ZohoRecruitDownloadAttachmentForRecordFunction;
-    /** Configured pass-through for {@link zohoRecruitDeleteAttachmentFromRecord}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitDeleteAttachmentFromRecord}.
+     *
+     * @returns bound delete attachment function
+     */
     get deleteAttachmentFromRecord(): import("@dereekb/zoho").ZohoRecruitDeleteAttachmentFromRecordFunction;
-    /** Configured pass-through for {@link zohoRecruitCreateNotes}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitCreateNotes}.
+     *
+     * @returns bound create notes function
+     */
     get createNotes(): (input: import("@dereekb/zoho").ZohoRecruitCreateNotesRequest) => Promise<import("@dereekb/zoho").ZohoRecruitMultiRecordResult<import("@dereekb/zoho").NewZohoRecruitNoteData, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoRecruitChangeObjectDetails>, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseErrorEntry>>;
-    /** Configured pass-through for {@link zohoRecruitDeleteNotes}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitDeleteNotes}.
+     *
+     * @returns bound delete notes function
+     */
     get deleteNotes(): (input: import("@dereekb/zoho").ZohoRecruitDeleteNotesRequest) => Promise<import("@dereekb/zoho").ZohoRecruitMultiRecordResult<string, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoRecruitChangeObjectDetails>, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseErrorEntry>>;
-    /** Configured pass-through for {@link zohoRecruitCreateNotesForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitCreateNotesForRecord}.
+     *
+     * @returns bound create notes for record function
+     */
     get createNotesForRecord(): import("@dereekb/zoho").ZohoRecruitCreateNotesForRecordFunction;
-    /** Configured pass-through for {@link zohoRecruitGetNotesForRecord}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitGetNotesForRecord}.
+     *
+     * @returns bound get notes for record function
+     */
     get getNotesForRecord(): import("@dereekb/zoho").ZohoRecruitGetNotesForRecordFunction;
-    /** Configured pass-through for {@link zohoRecruitGetNotesForRecordPageFactory}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitGetNotesForRecordPageFactory}.
+     *
+     * @returns bound get notes page factory function
+     */
     get getNotesForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetNotesForRecordPageFactory;
-    /** Configured pass-through for {@link zohoRecruitExecuteRestApiFunction}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitExecuteRestApiFunction}.
+     *
+     * @returns bound execute REST API function
+     */
     get executeRestApiFunction(): import("@dereekb/zoho").ZohoRecruitExecuteRestApiFunctionFunction;
-    /** Configured pass-through for {@link zohoRecruitAssociateCandidateRecordsWithJobOpenings}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitAssociateCandidateRecordsWithJobOpenings}.
+     *
+     * @returns bound associate candidates with job openings function
+     */
     get associateCandidateRecordsWithJobOpenings(): import("@dereekb/zoho").ZohoRecruitAssociateCandidateRecordsWithJobOpeningsFunction;
-    /** Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecords}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecords}.
+     *
+     * @returns bound search candidate associated job openings function
+     */
     get searchCandidateAssociatedJobOpeningRecords(): import("@dereekb/zoho").ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsFunction<import("@dereekb/zoho").ZohoRecruitRecord>;
-    /** Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory}.
+     *
+     * @returns bound search candidate job openings page factory function
+     */
     get searchCandidateAssociatedJobOpeningRecordsPageFactory(): import("@dereekb/util/fetch").FetchPageFactory<import("@dereekb/zoho").ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsInput, import("@dereekb/zoho").ZohoRecruitSearchAssociatedRecordsResponse<import("@dereekb/zoho").ZohoRecruitRecord>>;
-    /** Configured pass-through for {@link zohoRecruitSearchJobOpeningAssociatedCandidateRecords}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitSearchJobOpeningAssociatedCandidateRecords}.
+     *
+     * @returns bound search job opening associated candidates function
+     */
     get searchJobOpeningAssociatedCandidateRecords(): import("@dereekb/zoho").ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsFunction<import("@dereekb/zoho").ZohoRecruitRecord>;
-    /** Configured pass-through for {@link zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory}.
+     *
+     * @returns bound search job opening candidates page factory function
+     */
     get searchJobOpeningAssociatedCandidateRecordsPageFactory(): import("@dereekb/util/fetch").FetchPageFactory<import("@dereekb/zoho").ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsInput, import("@dereekb/zoho").ZohoRecruitSearchAssociatedRecordsResponse<import("@dereekb/zoho").ZohoRecruitRecord>>;
-    /** Configured pass-through for {@link zohoRecruitCreateTagsForModule}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitCreateTagsForModule}.
+     *
+     * @returns bound create tags for module function
+     */
     get createTagsForModule(): (input: import("@dereekb/zoho").ZohoRecruitCreateTagsRequest) => Promise<{
         errorItems: import("@dereekb/zoho").ZohoRecruitMultiRecordResultEntry<import("@dereekb/zoho").ZohoRecruitCreateTagData, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseErrorEntry>[];
         duplicateErrorItems: import("@dereekb/zoho").ZohoRecruitMultiRecordResultEntry<import("@dereekb/zoho").ZohoRecruitCreateTagData, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseErrorEntry>[];
         allErrorItems: import("@dereekb/zoho").ZohoRecruitMultiRecordResultEntry<import("@dereekb/zoho").ZohoRecruitCreateTagData, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseErrorEntry>[];
         successItems: import("@dereekb/zoho").ZohoRecruitMultiRecordResultEntry<import("@dereekb/zoho").ZohoRecruitCreateTagData, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoRecruitChangeObjectDetails>>[];
     }>;
-    /** Configured pass-through for {@link zohoRecruitGetTagsForModule}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitGetTagsForModule}.
+     *
+     * @returns bound get tags for module function
+     */
     get getTagsForModule(): import("@dereekb/zoho").ZohoRecruitGetTagsFunction;
-    /** Configured pass-through for {@link zohoRecruitAddTagsToRecords}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitAddTagsToRecords}.
+     *
+     * @returns bound add tags to records function
+     */
     get addTagsToRecords(): import("@dereekb/zoho").ZohoRecruitAddTagsToRecordsFunction;
-    /** Configured pass-through for {@link zohoRecruitRemoveTagsFromRecords}. */
+    /**
+     * Configured pass-through for {@link zohoRecruitRemoveTagsFromRecords}.
+     *
+     * @returns bound remove tags from records function
+     */
     get removeTagsFromRecords(): import("@dereekb/zoho").ZohoRecruitRemoveTagsFromRecordsFunction;
 }

package/nestjs/src/lib/recruit/recruit.config.d.ts

@@ -20,6 +20,8 @@ export declare abstract class ZohoRecruitServiceConfig {
     readonly factoryConfig?: ZohoRecruitFactoryConfig;
     /**
      * Validates that the required Zoho Recruit connection fields are present and well-formed.
+     *
+     * @param config - the Recruit service config to validate
      */
     static assertValidConfig(config: ZohoRecruitServiceConfig): void;
 }

package/nestjs/src/lib/sign/sign.api.d.ts

@@ -16,39 +16,94 @@ export declare class ZohoSignApi {
     readonly zohoSign: ZohoSign;
     /**
      * The authenticated Sign context used by all operation accessors.
+     *
+     * @returns the Sign context from the underlying client
      */
     get signContext(): ZohoSignContext;
     /**
      * Rate limiter shared across all Sign requests to respect Zoho API quotas.
+     *
+     * @returns the shared rate limiter instance
      */
     get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
     /**
      * Initializes the Sign client by combining the service config with the
      * accounts context for OAuth token management.
+     *
+     * @param config - Zoho Sign service configuration
+     * @param zohoAccountsApi - accounts API used for OAuth token management
      */
     constructor(config: ZohoSignServiceConfig, zohoAccountsApi: ZohoAccountsApi);
-    /** Configured pass-through for {@link zohoSignGetDocument}. */
+    /**
+     * Configured pass-through for {@link zohoSignGetDocument}.
+     *
+     * @returns bound get document function
+     */
     get getDocument(): import("@dereekb/zoho").ZohoSignGetDocumentFunction;
-    /** Configured pass-through for {@link zohoSignGetDocuments}. */
+    /**
+     * Configured pass-through for {@link zohoSignGetDocuments}.
+     *
+     * @returns bound get documents function
+     */
     get getDocuments(): import("@dereekb/zoho").ZohoSignGetDocumentsFunction;
-    /** Configured pass-through for {@link zohoSignGetDocumentsPageFactory}. */
+    /**
+     * Configured pass-through for {@link zohoSignGetDocumentsPageFactory}.
+     *
+     * @returns bound get documents page factory function
+     */
     get getDocumentsPageFactory(): import("@dereekb/util/fetch").FetchPageFactory<import("@dereekb/zoho").ZohoSignGetDocumentsInput, import("@dereekb/zoho").ZohoSignGetDocumentsResponse>;
-    /** Configured pass-through for {@link zohoSignGetDocumentFormData}. */
+    /**
+     * Configured pass-through for {@link zohoSignGetDocumentFormData}.
+     *
+     * @returns bound get document form data function
+     */
     get getDocumentFormData(): import("@dereekb/zoho").ZohoSignGetDocumentFormDataFunction;
-    /** Configured pass-through for {@link zohoSignRetrieveFieldTypes}. */
+    /**
+     * Configured pass-through for {@link zohoSignRetrieveFieldTypes}.
+     *
+     * @returns bound retrieve field types function
+     */
     get retrieveFieldTypes(): import("@dereekb/zoho").ZohoSignRetrieveFieldTypesFunction;
-    /** Configured pass-through for {@link zohoSignDownloadPdf}. */
+    /**
+     * Configured pass-through for {@link zohoSignDownloadPdf}.
+     *
+     * @returns bound download PDF function
+     */
     get downloadPdf(): import("@dereekb/zoho").ZohoSignDownloadPdfFunction;
-    /** Configured pass-through for {@link zohoSignDownloadCompletionCertificate}. */
+    /**
+     * Configured pass-through for {@link zohoSignDownloadCompletionCertificate}.
+     *
+     * @returns bound download completion certificate function
+     */
     get downloadCompletionCertificate(): import("@dereekb/zoho").ZohoSignDownloadCompletionCertificateFunction;
-    /** Configured pass-through for {@link zohoSignCreateDocument}. */
+    /**
+     * Configured pass-through for {@link zohoSignCreateDocument}.
+     *
+     * @returns bound create document function
+     */
     get createDocument(): import("@dereekb/zoho").ZohoSignCreateDocumentFunction;
-    /** Configured pass-through for {@link zohoSignUpdateDocument}. */
+    /**
+     * Configured pass-through for {@link zohoSignUpdateDocument}.
+     *
+     * @returns bound update document function
+     */
     get updateDocument(): import("@dereekb/zoho").ZohoSignUpdateDocumentFunction;
-    /** Configured pass-through for {@link zohoSignSendDocumentForSignature}. */
+    /**
+     * Configured pass-through for {@link zohoSignSendDocumentForSignature}.
+     *
+     * @returns bound send document for signature function
+     */
     get sendDocumentForSignature(): import("@dereekb/zoho").ZohoSignSendDocumentForSignatureFunction;
-    /** Configured pass-through for {@link zohoSignExtendDocument}. */
+    /**
+     * Configured pass-through for {@link zohoSignExtendDocument}.
+     *
+     * @returns bound extend document function
+     */
     get extendDocument(): import("@dereekb/zoho").ZohoSignExtendDocumentFunction;
-    /** Configured pass-through for {@link zohoSignDeleteDocument}. */
+    /**
+     * Configured pass-through for {@link zohoSignDeleteDocument}.
+     *
+     * @returns bound delete document function
+     */
     get deleteDocument(): import("@dereekb/zoho").ZohoSignDeleteDocumentFunction;
 }

package/nestjs/src/lib/sign/webhook/webhook.zoho.sign.d.ts

@@ -106,6 +106,9 @@ export type ZohoSignWebhookEvent<T extends ZohoSignWebhookOperationType = ZohoSi
 };
 /**
  * Creates a {@link ZohoSignWebhookEvent} from a raw payload.
+ *
+ * @param payload - the raw Zoho Sign webhook payload to convert
+ * @returns a webhook event with the operation type extracted for convenience
  */
 export declare function zohoSignWebhookEvent(payload: ZohoSignWebhookPayload): ZohoSignWebhookEvent;
 export type ZohoSignEventHandler = Handler<ZohoSignWebhookEvent, ZohoSignWebhookOperationType>;