@dereekb/zoho 13.0.6 → 13.1.0

package/nestjs/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@dereekb/zoho/nestjs",
-  "version": "13.0.6",
+  "version": "13.1.0",
   "peerDependencies": {
-    "@dereekb/util": "13.0.6",
-    "@dereekb/zoho": "13.0.6",
+    "@dereekb/util": "13.1.0",
+    "@dereekb/zoho": "13.1.0",
     "@nestjs/common": "^11.0.0",
     "@nestjs/config": "^4.0.0"
   },

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

@@ -1,4 +1,4 @@
-import { ZohoAccounts, ZohoAccountsContext } from '@dereekb/zoho';
+import { type ZohoAccounts, type ZohoAccountsContext } from '@dereekb/zoho';
 import { ZohoAccountsServiceConfig } from './accounts.config';
 import { ZohoAccountsAccessTokenCacheService } from './accounts.service';
 export declare class ZohoAccountsApi {

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

@@ -1,5 +1,5 @@
-import { ZohoAccessToken, ZohoAccessTokenCache, ZohoServiceAccessTokenKey } from '@dereekb/zoho';
-import { Maybe } from '@dereekb/util';
+import { type ZohoAccessToken, type ZohoAccessTokenCache, type ZohoServiceAccessTokenKey } from '@dereekb/zoho';
+import { type Maybe } from '@dereekb/util';
 export type ZohoAccountsAccessTokenCacheRecord = Record<ZohoServiceAccessTokenKey, Maybe<ZohoAccessToken>>;
 /**
  * Service used for retrieving ZohoAccessTokenCache for Zoho services.

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

@@ -1,43 +1,89 @@
-import { ZohoCrm, ZohoCrmContext } from '@dereekb/zoho';
+import { type ZohoCrm, type ZohoCrmContext } from '@dereekb/zoho';
 import { ZohoCrmServiceConfig } from './crm.config';
 import { ZohoAccountsApi } from '../accounts/accounts.api';
+/**
+ * NestJS injectable service that wraps the Zoho CRM API.
+ *
+ * Provides convenient accessor getters for all CRM operations, each bound
+ * to the authenticated CRM context created during construction.
+ */
 export declare class ZohoCrmApi {
     readonly config: ZohoCrmServiceConfig;
     readonly zohoAccountsApi: ZohoAccountsApi;
+    /**
+     * Underlying Zoho CRM client instance, initialized from the injected config and accounts context.
+     */
     readonly zohoCrm: ZohoCrm;
+    /**
+     * The authenticated CRM context used by all operation accessors.
+     */
     get crmContext(): ZohoCrmContext;
+    /**
+     * Rate limiter shared across all CRM requests to respect Zoho API quotas.
+     */
     get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
+    /**
+     * Initializes the CRM client by combining the service config with the
+     * accounts context for OAuth token management.
+     */
     constructor(config: ZohoCrmServiceConfig, zohoAccountsApi: ZohoAccountsApi);
+    /** Configured pass-through for {@link zohoCrmInsertRecord}. */
     get insertRecord(): import("@dereekb/zoho").ZohoCrmCreateRecordLikeFunction;
+    /** Configured pass-through for {@link zohoCrmUpsertRecord}. */
     get upsertRecord(): import("@dereekb/zoho").ZohoCrmUpsertRecordLikeFunction;
+    /** Configured pass-through for {@link zohoCrmUpdateRecord}. */
     get updateRecord(): import("@dereekb/zoho").ZohoCrmUpdateRecordLikeFunction;
+    /** Configured pass-through for {@link zohoCrmDeleteRecord}. */
     get deleteRecord(): import("@dereekb/zoho").ZohoCrmDeleteRecordFunction;
+    /** Configured pass-through for {@link zohoCrmGetRecordById}. */
     get getRecordById(): import("@dereekb/zoho").ZohoCrmGetRecordByIdFunction;
+    /** Configured pass-through for {@link zohoCrmGetRecords}. */
     get getRecords(): import("@dereekb/zoho").ZohoCrmGetRecordsFunction;
+    /** Configured pass-through for {@link zohoCrmSearchRecords}. */
     get searchRecords(): import("@dereekb/zoho").ZohoCrmSearchRecordsFunction;
+    /** Configured pass-through for {@link zohoCrmSearchRecordsPageFactory}. */
     get searchRecordsPageFactory(): import("@dereekb/zoho").ZohoCrmSearchRecordsPageFactory;
+    /** Configured pass-through for {@link zohoCrmGetRelatedRecordsFunctionFactory}. */
     get getRelatedRecordsFunctionFactory(): import("@dereekb/zoho").ZohoCrmGetRelatedRecordsFunctionFactory;
+    /** Configured pass-through for {@link zohoCrmGetEmailsForRecord}. */
     get getEmailsForRecord(): import("@dereekb/zoho").ZohoCrmGetEmailsForRecordFunction;
+    /** Configured pass-through for {@link zohoCrmGetEmailsForRecordPageFactory}. */
     get getEmailsForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetEmailsForRecordPageFactory;
+    /** Configured pass-through for {@link zohoCrmGetAttachmentsForRecord}. */
     get getAttachmentsForRecord(): import("@dereekb/zoho").ZohoCrmGetAttachmentsForRecordFunction;
+    /** Configured pass-through for {@link zohoCrmGetAttachmentsForRecordPageFactory}. */
     get getAttachmentsForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetAttachmentsForRecordPageFactory;
+    /** Configured pass-through for {@link zohoCrmUploadAttachmentForRecord}. */
     get uploadAttachmentForRecord(): import("@dereekb/zoho").ZohoCrmUploadAttachmentForRecordFunction;
+    /** Configured pass-through for {@link zohoCrmDownloadAttachmentForRecord}. */
     get downloadAttachmentForRecord(): import("@dereekb/zoho").ZohoCrmDownloadAttachmentForRecordFunction;
+    /** Configured pass-through for {@link zohoCrmDeleteAttachmentFromRecord}. */
     get deleteAttachmentFromRecord(): import("@dereekb/zoho").ZohoCrmDeleteAttachmentFromRecordFunction;
+    /** Configured pass-through for {@link zohoCrmCreateNotes}. */
     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}. */
     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}. */
     get createNotesForRecord(): import("@dereekb/zoho").ZohoCrmCreateNotesForRecordFunction;
+    /** Configured pass-through for {@link zohoCrmGetNotesForRecord}. */
     get getNotesForRecord(): import("@dereekb/zoho").ZohoCrmGetNotesForRecordFunction;
+    /** Configured pass-through for {@link zohoCrmGetNotesForRecordPageFactory}. */
     get getNotesForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetNotesForRecordPageFactory;
+    /** Configured pass-through for {@link zohoCrmExecuteRestApiFunction}. */
     get executeRestApiFunction(): import("@dereekb/zoho").ZohoCrmExecuteRestApiFunctionFunction;
+    /** Configured pass-through for {@link zohoCrmCreateTagsForModule}. */
     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}. */
     get deleteTag(): import("@dereekb/zoho").ZohoCrmDeleteTagFunction;
+    /** Configured pass-through for {@link zohoCrmGetTagsForModule}. */
     get getTagsForModule(): import("@dereekb/zoho").ZohoCrmGetTagsFunction;
+    /** Configured pass-through for {@link zohoCrmAddTagsToRecords}. */
     get addTagsToRecords(): import("@dereekb/zoho").ZohoCrmAddTagsToRecordsFunction;
+    /** Configured pass-through for {@link zohoCrmRemoveTagsFromRecords}. */
     get removeTagsFromRecords(): import("@dereekb/zoho").ZohoCrmRemoveTagsFromRecordsFunction;
 }

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

@@ -1,10 +1,25 @@
 import { type ZohoCrmConfig, type ZohoCrmFactoryConfig } from '@dereekb/zoho';
+/**
+ * API configuration for connecting to the Zoho CRM service endpoint.
+ */
 export type ZohoCrmServiceApiConfig = ZohoCrmConfig & {};
 /**
- * Configuration for ZohoCrmService
+ * Abstract configuration class for the NestJS Zoho CRM service.
+ *
+ * Used as a DI token so that applications can provide their own config values
+ * while keeping the expected shape consistent.
  */
 export declare abstract class ZohoCrmServiceConfig {
+    /**
+     * Zoho CRM API connection settings (endpoint URL, etc.).
+     */
     readonly zohoCrm: ZohoCrmServiceApiConfig;
+    /**
+     * Optional factory-level overrides applied when creating the underlying CRM client.
+     */
     readonly factoryConfig?: ZohoCrmFactoryConfig;
+    /**
+     * Validates that the required Zoho CRM connection fields are present and well-formed.
+     */
     static assertValidConfig(config: ZohoCrmServiceConfig): void;
 }

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

@@ -3,22 +3,91 @@ import { ConfigService } from '@nestjs/config';
 import { ZohoCrmServiceConfig } from './crm.config';
 import { ZohoAccountsServiceConfig } from '../accounts/accounts.config';
 import { type Maybe } from '@dereekb/util';
+/**
+ * Reads Zoho CRM connection settings from the NestJS ConfigService
+ * and returns a validated service config.
+ *
+ * Resolves the API URL via environment variables following the naming convention
+ * `ZOHO_CRM_API_URL` (service-specific) or `ZOHO_API_URL` (shared fallback).
+ *
+ * @param configService - NestJS config service populated with Zoho environment variables
+ * @returns Validated Zoho CRM service configuration
+ * @throws {Error} If required config values (e.g. API URL) are missing
+ *
+ * @example
+ * ```typescript
+ * {
+ *   provide: ZohoCrmServiceConfig,
+ *   inject: [ConfigService],
+ *   useFactory: zohoCrmServiceConfigFactory
+ * }
+ * ```
+ */
 export declare function zohoCrmServiceConfigFactory(configService: ConfigService): ZohoCrmServiceConfig;
+/**
+ * Reads Zoho Accounts (OAuth) settings scoped to the CRM service from
+ * the NestJS ConfigService and returns an accounts service config.
+ *
+ * @param configService - NestJS config service populated with Zoho OAuth environment variables
+ * @returns Zoho Accounts service config scoped to the CRM service access token
+ *
+ * @example
+ * ```typescript
+ * {
+ *   provide: ZohoAccountsServiceConfig,
+ *   inject: [ConfigService],
+ *   useFactory: zohoCrmAccountServiceConfigFactory
+ * }
+ * ```
+ */
 export declare function zohoCrmAccountServiceConfigFactory(configService: ConfigService): ZohoAccountsServiceConfig;
+/**
+ * Configuration for generating the application-level Zoho CRM NestJS module metadata.
+ *
+ * Extends standard NestJS {@link ModuleMetadata} fields (`imports`, `exports`, `providers`)
+ * so additional providers or modules can be merged into the generated metadata.
+ */
 export interface ProvideAppZohoCrmMetadataConfig extends Pick<ModuleMetadata, 'imports' | 'exports' | 'providers'> {
     /**
-     * The ZohoCrmModule requires the following dependencies in order to initialze properly:
-     * - ZohoAccountsAccessTokenCacheService
-     *
-     * This module declaration makes it easier to import a module that exports those depenendencies.
+     * Module that exports the required dependencies for this module.
+     * When provided, this module is automatically included in the generated `imports` array.
      */
     readonly dependencyModule?: Maybe<Required<ModuleMetadata>['imports']['0']>;
 }
 /**
- * Convenience function used to generate ModuleMetadata for an app's ZohoCrmModule.
+ * Generates NestJS {@link ModuleMetadata} that wires up the full Zoho CRM stack
+ * (config, accounts, and API service) so consuming modules only need a single import.
+ *
+ * The generated module requires the following dependencies in order to initialize properly:
+ * - {@link ZohoAccountsAccessTokenCacheService}
+ *
+ * Use the `dependencyModule` config option to import a module that exports those dependencies.
+ *
+ * The returned metadata registers {@link ZohoCrmServiceConfig}, {@link ZohoCrmApi},
+ * {@link ZohoAccountsServiceConfig}, and {@link ZohoAccountsApi} as providers, and
+ * exports {@link ZohoCrmApi} by default. Additional imports, exports, and providers
+ * from the config are merged in.
+ *
+ * @param config - Module configuration with optional dependency module and extra metadata
+ * @returns Complete NestJS module metadata ready to pass to `@Module()`
+ *
+ * @example
+ * ```typescript
+ * const cacheService = fileZohoAccountsAccessTokenCacheService();
+ *
+ * @Module({
+ *   providers: [
+ *     {
+ *       provide: ZohoAccountsAccessTokenCacheService,
+ *       useValue: cacheService
+ *     }
+ *   ],
+ *   exports: [ZohoAccountsAccessTokenCacheService]
+ * })
+ * export class ZohoCrmDependencyModule {}
  *
- * @param provide
- * @param useFactory
- * @returns
+ * @Module(appZohoCrmModuleMetadata({ dependencyModule: ZohoCrmDependencyModule }))
+ * export class AppZohoCrmModule {}
+ * ```
  */
 export declare function appZohoCrmModuleMetadata(config: ProvideAppZohoCrmMetadataConfig): ModuleMetadata;

package/nestjs/src/lib/index.d.ts

@@ -1,3 +1,5 @@
 export * from './accounts';
+export * from './crm';
 export * from './recruit';
+export * from './sign';
 export * from './zoho.config';

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

@@ -1,47 +1,97 @@
-import { ZohoRecruit, ZohoRecruitContext } from '@dereekb/zoho';
+import { type ZohoRecruit, type ZohoRecruitContext } from '@dereekb/zoho';
 import { ZohoRecruitServiceConfig } from './recruit.config';
 import { ZohoAccountsApi } from '../accounts/accounts.api';
+/**
+ * NestJS injectable service that wraps the Zoho Recruit API.
+ *
+ * Provides convenient accessor getters for all Recruit operations, each bound
+ * to the authenticated Recruit context created during construction.
+ */
 export declare class ZohoRecruitApi {
     readonly config: ZohoRecruitServiceConfig;
     readonly zohoAccountsApi: ZohoAccountsApi;
+    /**
+     * Underlying Zoho Recruit client instance, initialized from the injected config and accounts context.
+     */
     readonly zohoRecruit: ZohoRecruit;
+    /**
+     * The authenticated Recruit context used by all operation accessors.
+     */
     get recruitContext(): ZohoRecruitContext;
+    /**
+     * Rate limiter shared across all Recruit requests to respect Zoho API quotas.
+     */
     get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
+    /**
+     * Initializes the Recruit client by combining the service config with the
+     * accounts context for OAuth token management.
+     */
     constructor(config: ZohoRecruitServiceConfig, zohoAccountsApi: ZohoAccountsApi);
+    /** Configured pass-through for {@link zohoRecruitInsertRecord}. */
     get insertRecord(): import("@dereekb/zoho").ZohoRecruitCreateRecordLikeFunction;
+    /** Configured pass-through for {@link zohoRecruitUpsertRecord}. */
     get upsertRecord(): import("@dereekb/zoho").ZohoRecruitUpsertRecordLikeFunction;
+    /** Configured pass-through for {@link zohoRecruitUpdateRecord}. */
     get updateRecord(): import("@dereekb/zoho").ZohoRecruitUpdateRecordLikeFunction;
+    /** Configured pass-through for {@link zohoRecruitDeleteRecord}. */
     get deleteRecord(): import("@dereekb/zoho").ZohoRecruitDeleteRecordFunction;
+    /** Configured pass-through for {@link zohoRecruitGetRecordById}. */
     get getRecordById(): import("@dereekb/zoho").ZohoRecruitGetRecordByIdFunction;
+    /** Configured pass-through for {@link zohoRecruitGetRecords}. */
     get getRecords(): import("@dereekb/zoho").ZohoRecruitGetRecordsFunction;
+    /** Configured pass-through for {@link zohoRecruitSearchRecords}. */
     get searchRecords(): import("@dereekb/zoho").ZohoRecruitSearchRecordsFunction;
+    /** Configured pass-through for {@link zohoRecruitSearchRecordsPageFactory}. */
     get searchRecordsPageFactory(): import("@dereekb/zoho").ZohoRecruitSearchRecordsPageFactory;
+    /** Configured pass-through for {@link zohoRecruitGetRelatedRecordsFunctionFactory}. */
     get getRelatedRecordsFunctionFactory(): import("@dereekb/zoho").ZohoRecruitGetRelatedRecordsFunctionFactory;
+    /** Configured pass-through for {@link zohoRecruitGetEmailsForRecord}. */
     get getEmailsForRecord(): import("@dereekb/zoho").ZohoRecruitGetEmailsForRecordFunction;
+    /** Configured pass-through for {@link zohoRecruitGetEmailsForRecordPageFactory}. */
     get getEmailsForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetEmailsForRecordPageFactory;
+    /** Configured pass-through for {@link zohoRecruitGetAttachmentsForRecord}. */
     get getAttachmentsForRecord(): import("@dereekb/zoho").ZohoRecruitGetAttachmentsForRecordFunction;
+    /** Configured pass-through for {@link zohoRecruitGetAttachmentsForRecordPageFactory}. */
     get getAttachmentsForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetAttachmentsForRecordPageFactory;
+    /** Configured pass-through for {@link zohoRecruitUploadAttachmentForRecord}. */
     get uploadAttachmentForRecord(): import("@dereekb/zoho").ZohoRecruitUploadAttachmentForRecordFunction;
+    /** Configured pass-through for {@link zohoRecruitDownloadAttachmentForRecord}. */
     get downloadAttachmentForRecord(): import("@dereekb/zoho").ZohoRecruitDownloadAttachmentForRecordFunction;
+    /** Configured pass-through for {@link zohoRecruitDeleteAttachmentFromRecord}. */
     get deleteAttachmentFromRecord(): import("@dereekb/zoho").ZohoRecruitDeleteAttachmentFromRecordFunction;
+    /** Configured pass-through for {@link zohoRecruitCreateNotes}. */
     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}. */
     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}. */
     get createNotesForRecord(): import("@dereekb/zoho").ZohoRecruitCreateNotesForRecordFunction;
+    /** Configured pass-through for {@link zohoRecruitGetNotesForRecord}. */
     get getNotesForRecord(): import("@dereekb/zoho").ZohoRecruitGetNotesForRecordFunction;
+    /** Configured pass-through for {@link zohoRecruitGetNotesForRecordPageFactory}. */
     get getNotesForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetNotesForRecordPageFactory;
+    /** Configured pass-through for {@link zohoRecruitExecuteRestApiFunction}. */
     get executeRestApiFunction(): import("@dereekb/zoho").ZohoRecruitExecuteRestApiFunctionFunction;
+    /** Configured pass-through for {@link zohoRecruitAssociateCandidateRecordsWithJobOpenings}. */
     get associateCandidateRecordsWithJobOpenings(): import("@dereekb/zoho").ZohoRecruitAssociateCandidateRecordsWithJobOpeningsFunction;
+    /** Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecords}. */
     get searchCandidateAssociatedJobOpeningRecords(): import("@dereekb/zoho").ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsFunction<import("@dereekb/zoho").ZohoRecruitRecord>;
+    /** Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory}. */
     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}. */
     get searchJobOpeningAssociatedCandidateRecords(): import("@dereekb/zoho").ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsFunction<import("@dereekb/zoho").ZohoRecruitRecord>;
+    /** Configured pass-through for {@link zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory}. */
     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}. */
     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}. */
     get getTagsForModule(): import("@dereekb/zoho").ZohoRecruitGetTagsFunction;
+    /** Configured pass-through for {@link zohoRecruitAddTagsToRecords}. */
     get addTagsToRecords(): import("@dereekb/zoho").ZohoRecruitAddTagsToRecordsFunction;
+    /** Configured pass-through for {@link zohoRecruitRemoveTagsFromRecords}. */
     get removeTagsFromRecords(): import("@dereekb/zoho").ZohoRecruitRemoveTagsFromRecordsFunction;
 }

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

@@ -1,10 +1,25 @@
 import { type ZohoRecruitConfig, type ZohoRecruitFactoryConfig } from '@dereekb/zoho';
+/**
+ * API configuration for connecting to the Zoho Recruit service endpoint.
+ */
 export type ZohoRecruitServiceApiConfig = ZohoRecruitConfig & {};
 /**
- * Configuration for ZohoRecruitService
+ * Abstract configuration class for the NestJS Zoho Recruit service.
+ *
+ * Used as a DI token so that applications can provide their own config values
+ * while keeping the expected shape consistent.
  */
 export declare abstract class ZohoRecruitServiceConfig {
+    /**
+     * Zoho Recruit API connection settings (endpoint URL, etc.).
+     */
     readonly zohoRecruit: ZohoRecruitServiceApiConfig;
+    /**
+     * Optional factory-level overrides applied when creating the underlying Recruit client.
+     */
     readonly factoryConfig?: ZohoRecruitFactoryConfig;
+    /**
+     * Validates that the required Zoho Recruit connection fields are present and well-formed.
+     */
     static assertValidConfig(config: ZohoRecruitServiceConfig): void;
 }

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

@@ -3,22 +3,91 @@ import { ConfigService } from '@nestjs/config';
 import { ZohoRecruitServiceConfig } from './recruit.config';
 import { ZohoAccountsServiceConfig } from '../accounts/accounts.config';
 import { type Maybe } from '@dereekb/util';
+/**
+ * Reads Zoho Recruit connection settings from the NestJS ConfigService
+ * and returns a validated service config.
+ *
+ * Resolves the API URL via environment variables following the naming convention
+ * `ZOHO_RECRUIT_API_URL` (service-specific) or `ZOHO_API_URL` (shared fallback).
+ *
+ * @param configService - NestJS config service populated with Zoho environment variables
+ * @returns Validated Zoho Recruit service configuration
+ * @throws {Error} If required config values (e.g. API URL) are missing
+ *
+ * @example
+ * ```typescript
+ * {
+ *   provide: ZohoRecruitServiceConfig,
+ *   inject: [ConfigService],
+ *   useFactory: zohoRecruitServiceConfigFactory
+ * }
+ * ```
+ */
 export declare function zohoRecruitServiceConfigFactory(configService: ConfigService): ZohoRecruitServiceConfig;
+/**
+ * Reads Zoho Accounts (OAuth) settings scoped to the Recruit service from
+ * the NestJS ConfigService and returns an accounts service config.
+ *
+ * @param configService - NestJS config service populated with Zoho OAuth environment variables
+ * @returns Zoho Accounts service config scoped to the Recruit service access token
+ *
+ * @example
+ * ```typescript
+ * {
+ *   provide: ZohoAccountsServiceConfig,
+ *   inject: [ConfigService],
+ *   useFactory: zohoRecruitAccountServiceConfigFactory
+ * }
+ * ```
+ */
 export declare function zohoRecruitAccountServiceConfigFactory(configService: ConfigService): ZohoAccountsServiceConfig;
+/**
+ * Configuration for generating the application-level Zoho Recruit NestJS module metadata.
+ *
+ * Extends standard NestJS {@link ModuleMetadata} fields (`imports`, `exports`, `providers`)
+ * so additional providers or modules can be merged into the generated metadata.
+ */
 export interface ProvideAppZohoRecruitMetadataConfig extends Pick<ModuleMetadata, 'imports' | 'exports' | 'providers'> {
     /**
-     * The ZohoRecruitModule requires the following dependencies in order to initialze properly:
-     * - ZohoAccountsAccessTokenCacheService
-     *
-     * This module declaration makes it easier to import a module that exports those depenendencies.
+     * Module that exports the required dependencies for this module.
+     * When provided, this module is automatically included in the generated `imports` array.
      */
     readonly dependencyModule?: Maybe<Required<ModuleMetadata>['imports']['0']>;
 }
 /**
- * Convenience function used to generate ModuleMetadata for an app's ZohoRecruitModule.
+ * Generates NestJS {@link ModuleMetadata} that wires up the full Zoho Recruit stack
+ * (config, accounts, and API service) so consuming modules only need a single import.
+ *
+ * The generated module requires the following dependencies in order to initialize properly:
+ * - {@link ZohoAccountsAccessTokenCacheService}
+ *
+ * Use the `dependencyModule` config option to import a module that exports those dependencies.
+ *
+ * The returned metadata registers {@link ZohoRecruitServiceConfig}, {@link ZohoRecruitApi},
+ * {@link ZohoAccountsServiceConfig}, and {@link ZohoAccountsApi} as providers, and
+ * exports {@link ZohoRecruitApi} by default. Additional imports, exports, and providers
+ * from the config are merged in.
+ *
+ * @param config - Module configuration with optional dependency module and extra metadata
+ * @returns Complete NestJS module metadata ready to pass to `@Module()`
+ *
+ * @example
+ * ```typescript
+ * const cacheService = fileZohoAccountsAccessTokenCacheService();
+ *
+ * @Module({
+ *   providers: [
+ *     {
+ *       provide: ZohoAccountsAccessTokenCacheService,
+ *       useValue: cacheService
+ *     }
+ *   ],
+ *   exports: [ZohoAccountsAccessTokenCacheService]
+ * })
+ * export class ZohoRecruitDependencyModule {}
  *
- * @param provide
- * @param useFactory
- * @returns
+ * @Module(appZohoRecruitModuleMetadata({ dependencyModule: ZohoRecruitDependencyModule }))
+ * export class AppZohoRecruitModule {}
+ * ```
  */
 export declare function appZohoRecruitModuleMetadata(config: ProvideAppZohoRecruitMetadataConfig): ModuleMetadata;

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

@@ -0,0 +1,3 @@
+export * from './sign.api';
+export * from './sign.config';
+export * from './sign.module';

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

@@ -0,0 +1,54 @@
+import { type ZohoSign, type ZohoSignContext } from '@dereekb/zoho';
+import { ZohoSignServiceConfig } from './sign.config';
+import { ZohoAccountsApi } from '../accounts/accounts.api';
+/**
+ * NestJS injectable service that wraps the Zoho Sign API.
+ *
+ * Provides convenient accessor getters for all Sign operations, each bound
+ * to the authenticated Sign context created during construction.
+ */
+export declare class ZohoSignApi {
+    readonly config: ZohoSignServiceConfig;
+    readonly zohoAccountsApi: ZohoAccountsApi;
+    /**
+     * Underlying Zoho Sign client instance, initialized from the injected config and accounts context.
+     */
+    readonly zohoSign: ZohoSign;
+    /**
+     * The authenticated Sign context used by all operation accessors.
+     */
+    get signContext(): ZohoSignContext;
+    /**
+     * Rate limiter shared across all Sign requests to respect Zoho API quotas.
+     */
+    get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
+    /**
+     * Initializes the Sign client by combining the service config with the
+     * accounts context for OAuth token management.
+     */
+    constructor(config: ZohoSignServiceConfig, zohoAccountsApi: ZohoAccountsApi);
+    /** Configured pass-through for {@link zohoSignGetDocument}. */
+    get getDocument(): import("@dereekb/zoho").ZohoSignGetDocumentFunction;
+    /** Configured pass-through for {@link zohoSignGetDocuments}. */
+    get getDocuments(): import("@dereekb/zoho").ZohoSignGetDocumentsFunction;
+    /** Configured pass-through for {@link zohoSignGetDocumentsPageFactory}. */
+    get getDocumentsPageFactory(): import("@dereekb/util/fetch").FetchPageFactory<import("@dereekb/zoho").ZohoSignGetDocumentsInput, import("@dereekb/zoho").ZohoSignGetDocumentsResponse>;
+    /** Configured pass-through for {@link zohoSignGetDocumentFormData}. */
+    get getDocumentFormData(): import("@dereekb/zoho").ZohoSignGetDocumentFormDataFunction;
+    /** Configured pass-through for {@link zohoSignRetrieveFieldTypes}. */
+    get retrieveFieldTypes(): import("@dereekb/zoho").ZohoSignRetrieveFieldTypesFunction;
+    /** Configured pass-through for {@link zohoSignDownloadPdf}. */
+    get downloadPdf(): import("@dereekb/zoho").ZohoSignDownloadPdfFunction;
+    /** Configured pass-through for {@link zohoSignDownloadCompletionCertificate}. */
+    get downloadCompletionCertificate(): import("@dereekb/zoho").ZohoSignDownloadCompletionCertificateFunction;
+    /** Configured pass-through for {@link zohoSignCreateDocument}. */
+    get createDocument(): import("@dereekb/zoho").ZohoSignCreateDocumentFunction;
+    /** Configured pass-through for {@link zohoSignUpdateDocument}. */
+    get updateDocument(): import("@dereekb/zoho").ZohoSignUpdateDocumentFunction;
+    /** Configured pass-through for {@link zohoSignSendDocumentForSignature}. */
+    get sendDocumentForSignature(): import("@dereekb/zoho").ZohoSignSendDocumentForSignatureFunction;
+    /** Configured pass-through for {@link zohoSignExtendDocument}. */
+    get extendDocument(): import("@dereekb/zoho").ZohoSignExtendDocumentFunction;
+    /** Configured pass-through for {@link zohoSignDeleteDocument}. */
+    get deleteDocument(): import("@dereekb/zoho").ZohoSignDeleteDocumentFunction;
+}

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

@@ -0,0 +1,10 @@
+import { type ZohoSignConfig, type ZohoSignFactoryConfig } from '@dereekb/zoho';
+export type ZohoSignServiceApiConfig = ZohoSignConfig & {};
+/**
+ * Configuration for ZohoSignService
+ */
+export declare abstract class ZohoSignServiceConfig {
+    readonly zohoSign: ZohoSignServiceApiConfig;
+    readonly factoryConfig?: ZohoSignFactoryConfig;
+    static assertValidConfig(config: ZohoSignServiceConfig): void;
+}