@dereekb/zoho 13.4.0 → 13.4.1

package/nestjs/index.cjs.js

@@ -50,27 +50,33 @@ function zohoConfigServiceReaderFunction(inputOrKey, inputConfigService) {
         return (_configService_get = configService.get(serviceSpecificConfigKey)) !== null && _configService_get !== void 0 ? _configService_get : configService.get(baseConfigKey);
     };
 }
-/**
- * Reads the ZohoConfig config from the ConfigService.
- *
- * @param configService
- * @param prefix
- */ function readZohoConfigFromConfigService(configService, servicePrefix) {
+function readZohoConfigFromConfigService(configOrService, servicePrefix) {
     var assertValid = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : true;
     var _configService_get;
+    var configService;
+    if ('configService' in configOrService) {
+        var _configOrService_assertValid;
+        configService = configOrService.configService;
+        servicePrefix = configOrService.servicePrefix;
+        assertValid = (_configOrService_assertValid = configOrService.assertValid) !== null && _configOrService_assertValid !== void 0 ? _configOrService_assertValid : true;
+    } else {
+        configService = configOrService;
+    }
     var servicePrefixString = servicePrefix ? "".concat(servicePrefix, "_") : '';
     var apiUrlConfigKey = "".concat(servicePrefixString).concat(ZOHO_API_URL_CONFIG_KEY);
     var config = {
         apiUrl: (_configService_get = configService.get(apiUrlConfigKey)) !== null && _configService_get !== void 0 ? _configService_get : configService.get(ZOHO_API_URL_CONFIG_KEY)
     };
-    if (assertValid) {
-        if (!config.apiUrl) {
-            throw new Error('No Zoho API url or type specified for key "'.concat(apiUrlConfigKey, '".'));
-        }
+    if (assertValid && !config.apiUrl) {
+        throw new Error('No Zoho API url or type specified for key "'.concat(apiUrlConfigKey, '".'));
     }
     return config;
 }
-function assertValidZohoConfig(config) {
+/**
+ * Asserts that the provided ZohoConfig has a valid API URL configured.
+ *
+ * @param config - the Zoho config to validate
+ */ function assertValidZohoConfig(config) {
     if (!config.apiUrl) {
         throw new Error("No Zoho API url or type specified.");
     }
@@ -121,6 +127,7 @@ function _define_property$c(obj, key, value) {
             value: function assertValidConfig(config) {
                 var zohoAccounts = config.zohoAccounts;
                 if (!zohoAccounts) {
+                    // eslint-disable-line @typescript-eslint/no-unnecessary-condition -- runtime guard for consumers passing invalid config
                     throw new Error('ZohoAccountsServiceConfig.zohoAccounts is required');
                 } else {
                     if (!zohoAccounts.serviceAccessTokenKey) {
@@ -406,7 +413,11 @@ function _ts_generator$3(thisArg, body) {
 exports.ZohoAccountsAccessTokenCacheService = __decorate([
     common.Injectable()
 ], exports.ZohoAccountsAccessTokenCacheService);
-function logMergeZohoAccountsAccessTokenCacheServiceErrorFunction(failedUpdates) {
+/**
+ * Default error logging function for merged Zoho access token cache services.
+ *
+ * @param failedUpdates - array of cache/error tuples that failed during update
+ */ function logMergeZohoAccountsAccessTokenCacheServiceErrorFunction(failedUpdates) {
     console.warn("mergeZohoAccountsAccessTokenCacheServices(): failed updating ".concat(failedUpdates.length, " caches."));
     failedUpdates.forEach(function(param, i) {
         var _param = _sliced_to_array(param, 2); _param[0]; var e = _param[1];
@@ -421,6 +432,9 @@ function logMergeZohoAccountsAccessTokenCacheServiceErrorFunction(failedUpdates)
  * 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
  */ function mergeZohoAccountsAccessTokenCacheServices(inputServicesToMerge, logError) {
     var services = _to_consumable_array$3(inputServicesToMerge);
     var logErrorFunction = typeof logError === 'function' ? logError : logError !== false ? logMergeZohoAccountsAccessTokenCacheServiceErrorFunction : undefined;
@@ -470,6 +484,7 @@ function logMergeZohoAccountsAccessTokenCacheServiceErrorFunction(failedUpdates)
                                 })).then(function(x) {
                                     // only find the failures if we're logging
                                     if (logErrorFunction != null) {
+                                        // eslint-disable-next-line @typescript-eslint/no-explicit-any -- PromiseSettledResult requires any for generic access
                                         var failedUpdates = util.filterMaybeArrayValues(x.map(function(y) {
                                             return y.value;
                                         }));
@@ -512,7 +527,9 @@ function logMergeZohoAccountsAccessTokenCacheServiceErrorFunction(failedUpdates)
 /**
  * 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
  */ function memoryZohoAccountsAccessTokenCacheService(existingCache, logAccessToConsole) {
     var tokens = existingCache !== null && existingCache !== void 0 ? existingCache : {};
     function loadZohoAccessTokenCache(service) {
@@ -580,7 +597,9 @@ var DEFAULT_FILE_ZOHO_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH = '.tmp/zoho-acce
  *
  * 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
  */ function fileZohoAccountsAccessTokenCacheService() {
     var filename = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : DEFAULT_FILE_ZOHO_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH, useMemoryCache = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : true;
     var loadedTokens = null;
@@ -687,7 +706,7 @@ var DEFAULT_FILE_ZOHO_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH = '.tmp/zoho-acce
         var accessTokenCache = {
             loadCachedToken: function loadCachedToken() {
                 return _async_to_generator$3(function() {
-                    var tokens, token;
+                    var tokens;
                     return _ts_generator$3(this, function(_state) {
                         switch(_state.label){
                             case 0:
@@ -697,11 +716,10 @@ var DEFAULT_FILE_ZOHO_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH = '.tmp/zoho-acce
                                 ];
                             case 1:
                                 tokens = _state.sent();
-                                token = tokens[service];
                                 // console.log('retrieving access token from file: ', { token, service });
                                 return [
                                     2,
-                                    token
+                                    tokens[service]
                                 ];
                         }
                     });
@@ -719,6 +737,7 @@ var DEFAULT_FILE_ZOHO_ACCOUNTS_ACCESS_TOKEN_CACHE_SERVICE_PATH = '.tmp/zoho-acce
                                 ];
                             case 1:
                                 tokens = _state.sent();
+                                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- defensive guard in case loadTokens() changes
                                 if (tokens) {
                                     tokens[service] = accessToken;
                                 }
@@ -852,13 +871,13 @@ function _object_spread$4(target) {
 exports.ZohoAccountsApi = /*#__PURE__*/ function() {
     function ZohoAccountsApi(config, cacheService) {
         _class_call_check$a(this, ZohoAccountsApi);
-        var _config_factoryConfig;
+        var _config_zohoAccounts_accessTokenCache, _config_factoryConfig;
         _define_property$a(this, "config", void 0);
         _define_property$a(this, "cacheService", void 0);
         _define_property$a(this, "zohoAccounts", void 0);
         this.config = config;
         this.cacheService = cacheService;
-        var accessTokenCache = config.zohoAccounts.accessTokenCache ? config.zohoAccounts.accessTokenCache : cacheService.loadZohoAccessTokenCache(config.zohoAccounts.serviceAccessTokenKey);
+        var accessTokenCache = (_config_zohoAccounts_accessTokenCache = config.zohoAccounts.accessTokenCache) !== null && _config_zohoAccounts_accessTokenCache !== void 0 ? _config_zohoAccounts_accessTokenCache : cacheService.loadZohoAccessTokenCache(config.zohoAccounts.serviceAccessTokenKey);
         this.zohoAccounts = zoho.zohoAccountsFactory((_config_factoryConfig = config.factoryConfig) !== null && _config_factoryConfig !== void 0 ? _config_factoryConfig : {})(_object_spread$4({
             accessTokenCache: accessTokenCache
         }, config.zohoAccounts));
@@ -937,6 +956,8 @@ function _define_property$9(obj, key, value) {
             key: "assertValidConfig",
             value: /**
      * Validates that the required Zoho CRM connection fields are present and well-formed.
+     *
+     * @param config - the CRM service config to validate
      */ function assertValidConfig(config) {
                 assertValidZohoConfig(config.zohoCrm);
             }
@@ -1035,6 +1056,8 @@ function _object_spread_props$3(target, source) {
             key: "crmContext",
             get: /**
      * The authenticated CRM context used by all operation accessors.
+     *
+     * @returns the CRM context from the underlying client
      */ function get() {
                 return this.zohoCrm.crmContext;
             }
@@ -1043,6 +1066,8 @@ function _object_spread_props$3(target, source) {
             key: "zohoRateLimiter",
             get: /**
      * Rate limiter shared across all CRM requests to respect Zoho API quotas.
+     *
+     * @returns the shared rate limiter instance
      */ function get() {
                 return this.zohoCrm.crmContext.zohoRateLimiter;
             }
@@ -1050,163 +1075,271 @@ function _object_spread_props$3(target, source) {
         {
             key: "insertRecord",
             get: // MARK: Accessors
-            /** Configured pass-through for {@link zohoCrmInsertRecord}. */ function get() {
+            /**
+     * Configured pass-through for {@link zohoCrmInsertRecord}.
+     *
+     * @returns bound insert record function
+     */ function get() {
                 return zoho.zohoCrmInsertRecord(this.crmContext);
             }
         },
         {
             key: "upsertRecord",
-            get: /** Configured pass-through for {@link zohoCrmUpsertRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmUpsertRecord}.
+     *
+     * @returns bound upsert record function
+     */ function get() {
                 return zoho.zohoCrmUpsertRecord(this.crmContext);
             }
         },
         {
             key: "updateRecord",
-            get: /** Configured pass-through for {@link zohoCrmUpdateRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmUpdateRecord}.
+     *
+     * @returns bound update record function
+     */ function get() {
                 return zoho.zohoCrmUpdateRecord(this.crmContext);
             }
         },
         {
             key: "deleteRecord",
-            get: /** Configured pass-through for {@link zohoCrmDeleteRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmDeleteRecord}.
+     *
+     * @returns bound delete record function
+     */ function get() {
                 return zoho.zohoCrmDeleteRecord(this.crmContext);
             }
         },
         {
             key: "getRecordById",
-            get: /** Configured pass-through for {@link zohoCrmGetRecordById}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmGetRecordById}.
+     *
+     * @returns bound get record by ID function
+     */ function get() {
                 return zoho.zohoCrmGetRecordById(this.crmContext);
             }
         },
         {
             key: "getRecords",
-            get: /** Configured pass-through for {@link zohoCrmGetRecords}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmGetRecords}.
+     *
+     * @returns bound get records function
+     */ function get() {
                 return zoho.zohoCrmGetRecords(this.crmContext);
             }
         },
         {
             key: "searchRecords",
-            get: /** Configured pass-through for {@link zohoCrmSearchRecords}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmSearchRecords}.
+     *
+     * @returns bound search records function
+     */ function get() {
                 return zoho.zohoCrmSearchRecords(this.crmContext);
             }
         },
         {
             key: "searchRecordsPageFactory",
-            get: /** Configured pass-through for {@link zohoCrmSearchRecordsPageFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmSearchRecordsPageFactory}.
+     *
+     * @returns bound search records page factory function
+     */ function get() {
                 return zoho.zohoCrmSearchRecordsPageFactory(this.crmContext);
             }
         },
         {
             key: "getRelatedRecordsFunctionFactory",
-            get: /** Configured pass-through for {@link zohoCrmGetRelatedRecordsFunctionFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmGetRelatedRecordsFunctionFactory}.
+     *
+     * @returns bound get related records factory function
+     */ function get() {
                 return zoho.zohoCrmGetRelatedRecordsFunctionFactory(this.crmContext);
             }
         },
         {
             key: "getEmailsForRecord",
-            get: /** Configured pass-through for {@link zohoCrmGetEmailsForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmGetEmailsForRecord}.
+     *
+     * @returns bound get emails for record function
+     */ function get() {
                 return zoho.zohoCrmGetEmailsForRecord(this.crmContext);
             }
         },
         {
             key: "getEmailsForRecordPageFactory",
-            get: /** Configured pass-through for {@link zohoCrmGetEmailsForRecordPageFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmGetEmailsForRecordPageFactory}.
+     *
+     * @returns bound get emails page factory function
+     */ function get() {
                 return zoho.zohoCrmGetEmailsForRecordPageFactory(this.crmContext);
             }
         },
         {
             key: "getAttachmentsForRecord",
-            get: /** Configured pass-through for {@link zohoCrmGetAttachmentsForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmGetAttachmentsForRecord}.
+     *
+     * @returns bound get attachments for record function
+     */ function get() {
                 return zoho.zohoCrmGetAttachmentsForRecord(this.crmContext);
             }
         },
         {
             key: "getAttachmentsForRecordPageFactory",
-            get: /** Configured pass-through for {@link zohoCrmGetAttachmentsForRecordPageFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmGetAttachmentsForRecordPageFactory}.
+     *
+     * @returns bound get attachments page factory function
+     */ function get() {
                 return zoho.zohoCrmGetAttachmentsForRecordPageFactory(this.crmContext);
             }
         },
         {
             key: "uploadAttachmentForRecord",
-            get: /** Configured pass-through for {@link zohoCrmUploadAttachmentForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmUploadAttachmentForRecord}.
+     *
+     * @returns bound upload attachment function
+     */ function get() {
                 return zoho.zohoCrmUploadAttachmentForRecord(this.crmContext);
             }
         },
         {
             key: "downloadAttachmentForRecord",
-            get: /** Configured pass-through for {@link zohoCrmDownloadAttachmentForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmDownloadAttachmentForRecord}.
+     *
+     * @returns bound download attachment function
+     */ function get() {
                 return zoho.zohoCrmDownloadAttachmentForRecord(this.crmContext);
             }
         },
         {
             key: "deleteAttachmentFromRecord",
-            get: /** Configured pass-through for {@link zohoCrmDeleteAttachmentFromRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmDeleteAttachmentFromRecord}.
+     *
+     * @returns bound delete attachment function
+     */ function get() {
                 return zoho.zohoCrmDeleteAttachmentFromRecord(this.crmContext);
             }
         },
         {
             key: "createNotes",
-            get: /** Configured pass-through for {@link zohoCrmCreateNotes}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmCreateNotes}.
+     *
+     * @returns bound create notes function
+     */ function get() {
                 return zoho.zohoCrmCreateNotes(this.crmContext);
             }
         },
         {
             key: "deleteNotes",
-            get: /** Configured pass-through for {@link zohoCrmDeleteNotes}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmDeleteNotes}.
+     *
+     * @returns bound delete notes function
+     */ function get() {
                 return zoho.zohoCrmDeleteNotes(this.crmContext);
             }
         },
         {
             key: "createNotesForRecord",
-            get: /** Configured pass-through for {@link zohoCrmCreateNotesForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmCreateNotesForRecord}.
+     *
+     * @returns bound create notes for record function
+     */ function get() {
                 return zoho.zohoCrmCreateNotesForRecord(this.crmContext);
             }
         },
         {
             key: "getNotesForRecord",
-            get: /** Configured pass-through for {@link zohoCrmGetNotesForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmGetNotesForRecord}.
+     *
+     * @returns bound get notes for record function
+     */ function get() {
                 return zoho.zohoCrmGetNotesForRecord(this.crmContext);
             }
         },
         {
             key: "getNotesForRecordPageFactory",
-            get: /** Configured pass-through for {@link zohoCrmGetNotesForRecordPageFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmGetNotesForRecordPageFactory}.
+     *
+     * @returns bound get notes page factory function
+     */ function get() {
                 return zoho.zohoCrmGetNotesForRecordPageFactory(this.crmContext);
             }
         },
         {
             key: "executeRestApiFunction",
-            get: /** Configured pass-through for {@link zohoCrmExecuteRestApiFunction}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmExecuteRestApiFunction}.
+     *
+     * @returns bound execute REST API function
+     */ function get() {
                 return zoho.zohoCrmExecuteRestApiFunction(this.crmContext);
             }
         },
         {
             key: "createTagsForModule",
-            get: /** Configured pass-through for {@link zohoCrmCreateTagsForModule}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmCreateTagsForModule}.
+     *
+     * @returns bound create tags for module function
+     */ function get() {
                 return zoho.zohoCrmCreateTagsForModule(this.crmContext);
             }
         },
         {
             key: "deleteTag",
-            get: /** Configured pass-through for {@link zohoCrmDeleteTag}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmDeleteTag}.
+     *
+     * @returns bound delete tag function
+     */ function get() {
                 return zoho.zohoCrmDeleteTag(this.crmContext);
             }
         },
         {
             key: "getTagsForModule",
-            get: /** Configured pass-through for {@link zohoCrmGetTagsForModule}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmGetTagsForModule}.
+     *
+     * @returns bound get tags for module function
+     */ function get() {
                 return zoho.zohoCrmGetTagsForModule(this.crmContext);
             }
         },
         {
             key: "addTagsToRecords",
-            get: /** Configured pass-through for {@link zohoCrmAddTagsToRecords}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmAddTagsToRecords}.
+     *
+     * @returns bound add tags to records function
+     */ function get() {
                 return zoho.zohoCrmAddTagsToRecords(this.crmContext);
             }
         },
         {
             key: "removeTagsFromRecords",
-            get: /** Configured pass-through for {@link zohoCrmRemoveTagsFromRecords}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoCrmRemoveTagsFromRecords}.
+     *
+     * @returns bound remove tags from records function
+     */ function get() {
                 return zoho.zohoCrmRemoveTagsFromRecords(this.crmContext);
             }
         }
@@ -1415,6 +1548,8 @@ function _define_property$7(obj, key, value) {
             key: "assertValidConfig",
             value: /**
      * Validates that the required Zoho Recruit connection fields are present and well-formed.
+     *
+     * @param config - the Recruit service config to validate
      */ function assertValidConfig(config) {
                 assertValidZohoConfig(config.zohoRecruit);
             }
@@ -1513,6 +1648,8 @@ function _object_spread_props$2(target, source) {
             key: "recruitContext",
             get: /**
      * The authenticated Recruit context used by all operation accessors.
+     *
+     * @returns the Recruit context from the underlying client
      */ function get() {
                 return this.zohoRecruit.recruitContext;
             }
@@ -1521,6 +1658,8 @@ function _object_spread_props$2(target, source) {
             key: "zohoRateLimiter",
             get: /**
      * Rate limiter shared across all Recruit requests to respect Zoho API quotas.
+     *
+     * @returns the shared rate limiter instance
      */ function get() {
                 return this.zohoRecruit.recruitContext.zohoRateLimiter;
             }
@@ -1528,187 +1667,311 @@ function _object_spread_props$2(target, source) {
         {
             key: "insertRecord",
             get: // MARK: Accessors
-            /** Configured pass-through for {@link zohoRecruitInsertRecord}. */ function get() {
+            /**
+     * Configured pass-through for {@link zohoRecruitInsertRecord}.
+     *
+     * @returns bound insert record function
+     */ function get() {
                 return zoho.zohoRecruitInsertRecord(this.recruitContext);
             }
         },
         {
             key: "upsertRecord",
-            get: /** Configured pass-through for {@link zohoRecruitUpsertRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitUpsertRecord}.
+     *
+     * @returns bound upsert record function
+     */ function get() {
                 return zoho.zohoRecruitUpsertRecord(this.recruitContext);
             }
         },
         {
             key: "updateRecord",
-            get: /** Configured pass-through for {@link zohoRecruitUpdateRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitUpdateRecord}.
+     *
+     * @returns bound update record function
+     */ function get() {
                 return zoho.zohoRecruitUpdateRecord(this.recruitContext);
             }
         },
         {
             key: "deleteRecord",
-            get: /** Configured pass-through for {@link zohoRecruitDeleteRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitDeleteRecord}.
+     *
+     * @returns bound delete record function
+     */ function get() {
                 return zoho.zohoRecruitDeleteRecord(this.recruitContext);
             }
         },
         {
             key: "getRecordById",
-            get: /** Configured pass-through for {@link zohoRecruitGetRecordById}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitGetRecordById}.
+     *
+     * @returns bound get record by ID function
+     */ function get() {
                 return zoho.zohoRecruitGetRecordById(this.recruitContext);
             }
         },
         {
             key: "getRecords",
-            get: /** Configured pass-through for {@link zohoRecruitGetRecords}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitGetRecords}.
+     *
+     * @returns bound get records function
+     */ function get() {
                 return zoho.zohoRecruitGetRecords(this.recruitContext);
             }
         },
         {
             key: "searchRecords",
-            get: /** Configured pass-through for {@link zohoRecruitSearchRecords}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitSearchRecords}.
+     *
+     * @returns bound search records function
+     */ function get() {
                 return zoho.zohoRecruitSearchRecords(this.recruitContext);
             }
         },
         {
             key: "searchRecordsPageFactory",
-            get: /** Configured pass-through for {@link zohoRecruitSearchRecordsPageFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitSearchRecordsPageFactory}.
+     *
+     * @returns bound search records page factory function
+     */ function get() {
                 return zoho.zohoRecruitSearchRecordsPageFactory(this.recruitContext);
             }
         },
         {
             key: "getRelatedRecordsFunctionFactory",
-            get: /** Configured pass-through for {@link zohoRecruitGetRelatedRecordsFunctionFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitGetRelatedRecordsFunctionFactory}.
+     *
+     * @returns bound get related records factory function
+     */ function get() {
                 return zoho.zohoRecruitGetRelatedRecordsFunctionFactory(this.recruitContext);
             }
         },
         {
             key: "getEmailsForRecord",
-            get: /** Configured pass-through for {@link zohoRecruitGetEmailsForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitGetEmailsForRecord}.
+     *
+     * @returns bound get emails for record function
+     */ function get() {
                 return zoho.zohoRecruitGetEmailsForRecord(this.recruitContext);
             }
         },
         {
             key: "getEmailsForRecordPageFactory",
-            get: /** Configured pass-through for {@link zohoRecruitGetEmailsForRecordPageFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitGetEmailsForRecordPageFactory}.
+     *
+     * @returns bound get emails page factory function
+     */ function get() {
                 return zoho.zohoRecruitGetEmailsForRecordPageFactory(this.recruitContext);
             }
         },
         {
             key: "getAttachmentsForRecord",
-            get: /** Configured pass-through for {@link zohoRecruitGetAttachmentsForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitGetAttachmentsForRecord}.
+     *
+     * @returns bound get attachments for record function
+     */ function get() {
                 return zoho.zohoRecruitGetAttachmentsForRecord(this.recruitContext);
             }
         },
         {
             key: "getAttachmentsForRecordPageFactory",
-            get: /** Configured pass-through for {@link zohoRecruitGetAttachmentsForRecordPageFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitGetAttachmentsForRecordPageFactory}.
+     *
+     * @returns bound get attachments page factory function
+     */ function get() {
                 return zoho.zohoRecruitGetAttachmentsForRecordPageFactory(this.recruitContext);
             }
         },
         {
             key: "uploadAttachmentForRecord",
-            get: /** Configured pass-through for {@link zohoRecruitUploadAttachmentForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitUploadAttachmentForRecord}.
+     *
+     * @returns bound upload attachment function
+     */ function get() {
                 return zoho.zohoRecruitUploadAttachmentForRecord(this.recruitContext);
             }
         },
         {
             key: "downloadAttachmentForRecord",
-            get: /** Configured pass-through for {@link zohoRecruitDownloadAttachmentForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitDownloadAttachmentForRecord}.
+     *
+     * @returns bound download attachment function
+     */ function get() {
                 return zoho.zohoRecruitDownloadAttachmentForRecord(this.recruitContext);
             }
         },
         {
             key: "deleteAttachmentFromRecord",
-            get: /** Configured pass-through for {@link zohoRecruitDeleteAttachmentFromRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitDeleteAttachmentFromRecord}.
+     *
+     * @returns bound delete attachment function
+     */ function get() {
                 return zoho.zohoRecruitDeleteAttachmentFromRecord(this.recruitContext);
             }
         },
         {
             key: "createNotes",
-            get: /** Configured pass-through for {@link zohoRecruitCreateNotes}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitCreateNotes}.
+     *
+     * @returns bound create notes function
+     */ function get() {
                 return zoho.zohoRecruitCreateNotes(this.recruitContext);
             }
         },
         {
             key: "deleteNotes",
-            get: /** Configured pass-through for {@link zohoRecruitDeleteNotes}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitDeleteNotes}.
+     *
+     * @returns bound delete notes function
+     */ function get() {
                 return zoho.zohoRecruitDeleteNotes(this.recruitContext);
             }
         },
         {
             key: "createNotesForRecord",
-            get: /** Configured pass-through for {@link zohoRecruitCreateNotesForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitCreateNotesForRecord}.
+     *
+     * @returns bound create notes for record function
+     */ function get() {
                 return zoho.zohoRecruitCreateNotesForRecord(this.recruitContext);
             }
         },
         {
             key: "getNotesForRecord",
-            get: /** Configured pass-through for {@link zohoRecruitGetNotesForRecord}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitGetNotesForRecord}.
+     *
+     * @returns bound get notes for record function
+     */ function get() {
                 return zoho.zohoRecruitGetNotesForRecord(this.recruitContext);
             }
         },
         {
             key: "getNotesForRecordPageFactory",
-            get: /** Configured pass-through for {@link zohoRecruitGetNotesForRecordPageFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitGetNotesForRecordPageFactory}.
+     *
+     * @returns bound get notes page factory function
+     */ function get() {
                 return zoho.zohoRecruitGetNotesForRecordPageFactory(this.recruitContext);
             }
         },
         {
             key: "executeRestApiFunction",
-            get: /** Configured pass-through for {@link zohoRecruitExecuteRestApiFunction}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitExecuteRestApiFunction}.
+     *
+     * @returns bound execute REST API function
+     */ function get() {
                 return zoho.zohoRecruitExecuteRestApiFunction(this.recruitContext);
             }
         },
         {
             key: "associateCandidateRecordsWithJobOpenings",
-            get: /** Configured pass-through for {@link zohoRecruitAssociateCandidateRecordsWithJobOpenings}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitAssociateCandidateRecordsWithJobOpenings}.
+     *
+     * @returns bound associate candidates with job openings function
+     */ function get() {
                 return zoho.zohoRecruitAssociateCandidateRecordsWithJobOpenings(this.recruitContext);
             }
         },
         {
             key: "searchCandidateAssociatedJobOpeningRecords",
-            get: /** Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecords}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecords}.
+     *
+     * @returns bound search candidate associated job openings function
+     */ function get() {
                 return zoho.zohoRecruitSearchCandidateAssociatedJobOpeningRecords(this.recruitContext);
             }
         },
         {
             key: "searchCandidateAssociatedJobOpeningRecordsPageFactory",
-            get: /** Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory}.
+     *
+     * @returns bound search candidate job openings page factory function
+     */ function get() {
                 return zoho.zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory(this.recruitContext);
             }
         },
         {
             key: "searchJobOpeningAssociatedCandidateRecords",
-            get: /** Configured pass-through for {@link zohoRecruitSearchJobOpeningAssociatedCandidateRecords}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitSearchJobOpeningAssociatedCandidateRecords}.
+     *
+     * @returns bound search job opening associated candidates function
+     */ function get() {
                 return zoho.zohoRecruitSearchJobOpeningAssociatedCandidateRecords(this.recruitContext);
             }
         },
         {
             key: "searchJobOpeningAssociatedCandidateRecordsPageFactory",
-            get: /** Configured pass-through for {@link zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory}.
+     *
+     * @returns bound search job opening candidates page factory function
+     */ function get() {
                 return zoho.zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory(this.recruitContext);
             }
         },
         {
             key: "createTagsForModule",
-            get: /** Configured pass-through for {@link zohoRecruitCreateTagsForModule}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitCreateTagsForModule}.
+     *
+     * @returns bound create tags for module function
+     */ function get() {
                 return zoho.zohoRecruitCreateTagsForModule(this.recruitContext);
             }
         },
         {
             key: "getTagsForModule",
-            get: /** Configured pass-through for {@link zohoRecruitGetTagsForModule}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitGetTagsForModule}.
+     *
+     * @returns bound get tags for module function
+     */ function get() {
                 return zoho.zohoRecruitGetTagsForModule(this.recruitContext);
             }
         },
         {
             key: "addTagsToRecords",
-            get: /** Configured pass-through for {@link zohoRecruitAddTagsToRecords}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitAddTagsToRecords}.
+     *
+     * @returns bound add tags to records function
+     */ function get() {
                 return zoho.zohoRecruitAddTagsToRecords(this.recruitContext);
             }
         },
         {
             key: "removeTagsFromRecords",
-            get: /** Configured pass-through for {@link zohoRecruitRemoveTagsFromRecords}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoRecruitRemoveTagsFromRecords}.
+     *
+     * @returns bound remove tags from records function
+     */ function get() {
                 return zoho.zohoRecruitRemoveTagsFromRecords(this.recruitContext);
             }
         }
@@ -2006,6 +2269,8 @@ function _object_spread_props$1(target, source) {
             key: "signContext",
             get: /**
      * The authenticated Sign context used by all operation accessors.
+     *
+     * @returns the Sign context from the underlying client
      */ function get() {
                 return this.zohoSign.signContext;
             }
@@ -2014,6 +2279,8 @@ function _object_spread_props$1(target, source) {
             key: "zohoRateLimiter",
             get: /**
      * Rate limiter shared across all Sign requests to respect Zoho API quotas.
+     *
+     * @returns the shared rate limiter instance
      */ function get() {
                 return this.zohoSign.signContext.zohoRateLimiter;
             }
@@ -2021,73 +2288,121 @@ function _object_spread_props$1(target, source) {
         {
             key: "getDocument",
             get: // MARK: Accessors
-            /** Configured pass-through for {@link zohoSignGetDocument}. */ function get() {
+            /**
+     * Configured pass-through for {@link zohoSignGetDocument}.
+     *
+     * @returns bound get document function
+     */ function get() {
                 return zoho.zohoSignGetDocument(this.signContext);
             }
         },
         {
             key: "getDocuments",
-            get: /** Configured pass-through for {@link zohoSignGetDocuments}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoSignGetDocuments}.
+     *
+     * @returns bound get documents function
+     */ function get() {
                 return zoho.zohoSignGetDocuments(this.signContext);
             }
         },
         {
             key: "getDocumentsPageFactory",
-            get: /** Configured pass-through for {@link zohoSignGetDocumentsPageFactory}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoSignGetDocumentsPageFactory}.
+     *
+     * @returns bound get documents page factory function
+     */ function get() {
                 return zoho.zohoSignGetDocumentsPageFactory(this.signContext);
             }
         },
         {
             key: "getDocumentFormData",
-            get: /** Configured pass-through for {@link zohoSignGetDocumentFormData}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoSignGetDocumentFormData}.
+     *
+     * @returns bound get document form data function
+     */ function get() {
                 return zoho.zohoSignGetDocumentFormData(this.signContext);
             }
         },
         {
             key: "retrieveFieldTypes",
-            get: /** Configured pass-through for {@link zohoSignRetrieveFieldTypes}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoSignRetrieveFieldTypes}.
+     *
+     * @returns bound retrieve field types function
+     */ function get() {
                 return zoho.zohoSignRetrieveFieldTypes(this.signContext);
             }
         },
         {
             key: "downloadPdf",
-            get: /** Configured pass-through for {@link zohoSignDownloadPdf}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoSignDownloadPdf}.
+     *
+     * @returns bound download PDF function
+     */ function get() {
                 return zoho.zohoSignDownloadPdf(this.signContext);
             }
         },
         {
             key: "downloadCompletionCertificate",
-            get: /** Configured pass-through for {@link zohoSignDownloadCompletionCertificate}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoSignDownloadCompletionCertificate}.
+     *
+     * @returns bound download completion certificate function
+     */ function get() {
                 return zoho.zohoSignDownloadCompletionCertificate(this.signContext);
             }
         },
         {
             key: "createDocument",
-            get: /** Configured pass-through for {@link zohoSignCreateDocument}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoSignCreateDocument}.
+     *
+     * @returns bound create document function
+     */ function get() {
                 return zoho.zohoSignCreateDocument(this.signContext);
             }
         },
         {
             key: "updateDocument",
-            get: /** Configured pass-through for {@link zohoSignUpdateDocument}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoSignUpdateDocument}.
+     *
+     * @returns bound update document function
+     */ function get() {
                 return zoho.zohoSignUpdateDocument(this.signContext);
             }
         },
         {
             key: "sendDocumentForSignature",
-            get: /** Configured pass-through for {@link zohoSignSendDocumentForSignature}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoSignSendDocumentForSignature}.
+     *
+     * @returns bound send document for signature function
+     */ function get() {
                 return zoho.zohoSignSendDocumentForSignature(this.signContext);
             }
         },
         {
             key: "extendDocument",
-            get: /** Configured pass-through for {@link zohoSignExtendDocument}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoSignExtendDocument}.
+     *
+     * @returns bound extend document function
+     */ function get() {
                 return zoho.zohoSignExtendDocument(this.signContext);
             }
         },
         {
             key: "deleteDocument",
-            get: /** Configured pass-through for {@link zohoSignDeleteDocument}. */ function get() {
+            get: /**
+     * Configured pass-through for {@link zohoSignDeleteDocument}.
+     *
+     * @returns bound delete document function
+     */ function get() {
                 return zoho.zohoSignDeleteDocument(this.signContext);
             }
         }
@@ -2295,6 +2610,9 @@ function _object_spread_props(target, source) {
 }
 /**
  * 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
  */ function zohoSignWebhookEvent(payload) {
     return _object_spread_props(_object_spread({}, payload), {
         operationType: payload.notifications.operation_type