@dereekb/zoho 13.11.13 → 13.11.15

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

@@ -17,285 +17,285 @@ export declare class ZohoDeskApi {
     /**
      * The authenticated Desk context used by all operation accessors.
      *
-     * @returns the Desk context from the underlying client
+     * @returns The Desk context from the underlying client.
      */
     get deskContext(): ZohoDeskContext;
     /**
      * Rate limiter shared across all Desk requests to respect Zoho API quotas.
      *
-     * @returns the shared rate limiter instance
+     * @returns The shared rate limiter instance.
      */
     get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
     /**
      * Initializes the Desk client by combining the service config with the
      * accounts context for OAuth token management.
      *
-     * @param config - Zoho Desk service configuration
-     * @param zohoAccountsApi - accounts API used for OAuth token management
+     * @param config - Zoho Desk service configuration.
+     * @param zohoAccountsApi - Accounts API used for OAuth token management.
      */
     constructor(config: ZohoDeskServiceConfig, zohoAccountsApi: ZohoAccountsApi);
     /**
      * Configured pass-through for {@link zohoDeskGetTickets}.
      *
-     * @returns a function that lists Desk tickets matching the supplied filter/pagination input
+     * @returns Lists Desk tickets matching the supplied filter/pagination input.
      */
     get getTickets(): import("@dereekb/zoho").ZohoDeskGetTicketsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketById}.
      *
-     * @returns a function that fetches a single Desk ticket by its identifier
+     * @returns Fetches a single Desk ticket by its identifier.
      */
     get getTicketById(): import("@dereekb/zoho").ZohoDeskGetTicketByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskSearchTickets}.
      *
-     * @returns a function that runs a Desk ticket search with the provided criteria
+     * @returns Runs a Desk ticket search with the provided criteria.
      */
     get searchTickets(): import("@dereekb/zoho").ZohoDeskSearchTicketsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketsForContact}.
      *
-     * @returns a function that lists Desk tickets associated with the given contact id
+     * @returns Lists Desk tickets associated with the given contact id.
      */
     get getTicketsForContact(): import("@dereekb/zoho").ZohoDeskGetTicketsForContactFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketsForProduct}.
      *
-     * @returns a function that lists Desk tickets associated with the given product id
+     * @returns Lists Desk tickets associated with the given product id.
      */
     get getTicketsForProduct(): import("@dereekb/zoho").ZohoDeskGetTicketsForProductFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketMetrics}.
      *
-     * @returns a function that fetches aggregated metrics for the requested Desk tickets
+     * @returns Fetches aggregated metrics for the requested Desk tickets.
      */
     get getTicketMetrics(): import("@dereekb/zoho").ZohoDeskGetTicketMetricsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetAgentsTicketsCount}.
      *
-     * @returns a function that returns ticket counts grouped by agent for the requested filter
+     * @returns Returns ticket counts grouped by agent for the requested filter.
      */
     get getAgentsTicketsCount(): import("@dereekb/zoho").ZohoDeskGetAgentsTicketsCountFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketsPageFactory}.
      *
-     * @returns a paged result factory for iterating over Desk ticket list responses
+     * @returns A paged result factory for iterating over Desk ticket list responses.
      */
     get getTicketsPageFactory(): import("@dereekb/zoho").ZohoDeskGetTicketsPageFactory;
     /**
      * Configured pass-through for {@link zohoDeskSearchTicketsPageFactory}.
      *
-     * @returns a paged result factory for iterating over Desk ticket search responses
+     * @returns A paged result factory for iterating over Desk ticket search responses.
      */
     get searchTicketsPageFactory(): import("@dereekb/zoho").ZohoDeskSearchTicketsPageFactory;
     /**
      * Configured pass-through for {@link zohoDeskGetDepartments}.
      *
-     * @returns a function that lists Desk departments visible to the authenticated portal
+     * @returns Lists Desk departments visible to the authenticated portal.
      */
     get getDepartments(): import("@dereekb/zoho").ZohoDeskGetDepartmentsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetDepartmentById}.
      *
-     * @returns a function that fetches a single Desk department by its identifier
+     * @returns Fetches a single Desk department by its identifier.
      */
     get getDepartmentById(): import("@dereekb/zoho").ZohoDeskGetDepartmentByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetContacts}.
      *
-     * @returns a function that lists Desk contacts matching the supplied filter/pagination input
+     * @returns Lists Desk contacts matching the supplied filter/pagination input.
      */
     get getContacts(): import("@dereekb/zoho").ZohoDeskGetContactsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetContactById}.
      *
-     * @returns a function that fetches a single Desk contact by its identifier
+     * @returns Fetches a single Desk contact by its identifier.
      */
     get getContactById(): import("@dereekb/zoho").ZohoDeskGetContactByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetContactsByIds}.
      *
-     * @returns a function that fetches multiple Desk contacts in a single request by their identifiers
+     * @returns Fetches multiple Desk contacts in a single request by their identifiers.
      */
     get getContactsByIds(): import("@dereekb/zoho").ZohoDeskGetContactsByIdsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetContactsPageFactory}.
      *
-     * @returns a paged result factory for iterating over Desk contact list responses
+     * @returns A paged result factory for iterating over Desk contact list responses.
      */
     get getContactsPageFactory(): import("@dereekb/zoho").ZohoDeskGetContactsPageFactory;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketTags}.
      *
-     * @returns a function that lists the tags currently associated with a given Desk ticket
+     * @returns Lists the tags currently associated with a given Desk ticket.
      */
     get getTicketTags(): import("@dereekb/zoho").ZohoDeskGetTicketTagsFunction;
     /**
      * Configured pass-through for {@link zohoDeskAssociateTicketTags}.
      *
-     * @returns a function that associates one or more tags with a Desk ticket
+     * @returns Associates one or more tags with a Desk ticket.
      */
     get associateTicketTags(): import("@dereekb/zoho").ZohoDeskAssociateTicketTagsFunction;
     /**
      * Configured pass-through for {@link zohoDeskDissociateTicketTag}.
      *
-     * @returns a function that removes a single tag association from a Desk ticket
+     * @returns Removes a single tag association from a Desk ticket.
      */
     get dissociateTicketTag(): import("@dereekb/zoho").ZohoDeskDissociateTicketTagFunction;
     /**
      * Configured pass-through for {@link zohoDeskSearchTags}.
      *
-     * @returns a function that searches the Desk tag catalog by the supplied criteria
+     * @returns Searches the Desk tag catalog by the supplied criteria.
      */
     get searchTags(): import("@dereekb/zoho").ZohoDeskSearchTagsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetAllTags}.
      *
-     * @returns a function that lists every tag defined on the Desk portal
+     * @returns Lists every tag defined on the Desk portal.
      */
     get getAllTags(): import("@dereekb/zoho").ZohoDeskGetAllTagsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketFollowers}.
      *
-     * @returns a function that lists the agents following a given Desk ticket
+     * @returns Lists the agents following a given Desk ticket.
      */
     get getTicketFollowers(): import("@dereekb/zoho").ZohoDeskGetTicketFollowersFunction;
     /**
      * Configured pass-through for {@link zohoDeskAddTicketFollowers}.
      *
-     * @returns a function that adds one or more agents as followers of a Desk ticket
+     * @returns Adds one or more agents as followers of a Desk ticket.
      */
     get addTicketFollowers(): import("@dereekb/zoho").ZohoDeskAddTicketFollowersFunction;
     /**
      * Configured pass-through for {@link zohoDeskRemoveTicketFollowers}.
      *
-     * @returns a function that removes one or more agents from a Desk ticket's follower list
+     * @returns Removes one or more agents from a Desk ticket's follower list.
      */
     get removeTicketFollowers(): import("@dereekb/zoho").ZohoDeskRemoveTicketFollowersFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketAttachments}.
      *
-     * @returns a function that lists the file attachments on a given Desk ticket
+     * @returns Lists the file attachments on a given Desk ticket.
      */
     get getTicketAttachments(): import("@dereekb/zoho").ZohoDeskGetTicketAttachmentsFunction;
     /**
      * Configured pass-through for {@link zohoDeskDeleteTicketAttachment}.
      *
-     * @returns a function that deletes a single attachment from a Desk ticket by attachment id
+     * @returns Deletes a single attachment from a Desk ticket by attachment id.
      */
     get deleteTicketAttachment(): import("@dereekb/zoho").ZohoDeskDeleteTicketAttachmentFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketComments}.
      *
-     * @returns a function that lists the comments on a given Desk ticket
+     * @returns Lists the comments on a given Desk ticket.
      */
     get getTicketComments(): import("@dereekb/zoho").ZohoDeskGetTicketCommentsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketCommentById}.
      *
-     * @returns a function that fetches a single comment on a Desk ticket by comment id
+     * @returns Fetches a single comment on a Desk ticket by comment id.
      */
     get getTicketCommentById(): import("@dereekb/zoho").ZohoDeskGetTicketCommentByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskCreateTicketComment}.
      *
-     * @returns a function that creates a new comment on a Desk ticket from the supplied body
+     * @returns Creates a new comment on a Desk ticket from the supplied body.
      */
     get createTicketComment(): import("@dereekb/zoho").ZohoDeskCreateTicketCommentFunction;
     /**
      * Configured pass-through for {@link zohoDeskDeleteTicketComment}.
      *
-     * @returns a function that deletes a single comment from a Desk ticket by comment id
+     * @returns Deletes a single comment from a Desk ticket by comment id.
      */
     get deleteTicketComment(): import("@dereekb/zoho").ZohoDeskDeleteTicketCommentFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketTimer}.
      *
-     * @returns a function that fetches the current timer state for a Desk ticket
+     * @returns Fetches the current timer state for a Desk ticket.
      */
     get getTicketTimer(): import("@dereekb/zoho").ZohoDeskGetTicketTimerFunction;
     /**
      * Configured pass-through for {@link zohoDeskPerformTicketTimerAction}.
      *
-     * @returns a function that performs a timer action (start/pause/stop) on a Desk ticket
+     * @returns Performs a timer action (start/pause/stop) on a Desk ticket.
      */
     get performTicketTimerAction(): import("@dereekb/zoho").ZohoDeskPerformTicketTimerActionFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketTimeEntries}.
      *
-     * @returns a function that lists the time entries logged against a Desk ticket
+     * @returns Lists the time entries logged against a Desk ticket.
      */
     get getTicketTimeEntries(): import("@dereekb/zoho").ZohoDeskGetTicketTimeEntriesFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketTimeEntryById}.
      *
-     * @returns a function that fetches a single time entry on a Desk ticket by entry id
+     * @returns Fetches a single time entry on a Desk ticket by entry id.
      */
     get getTicketTimeEntryById(): import("@dereekb/zoho").ZohoDeskGetTicketTimeEntryByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketTimeEntrySummation}.
      *
-     * @returns a function that fetches the aggregated time-entry totals for a Desk ticket
+     * @returns Fetches the aggregated time-entry totals for a Desk ticket.
      */
     get getTicketTimeEntrySummation(): import("@dereekb/zoho").ZohoDeskGetTicketTimeEntrySummationFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketThreads}.
      *
-     * @returns a function that lists the conversation threads on a given Desk ticket
+     * @returns Lists the conversation threads on a given Desk ticket.
      */
     get getTicketThreads(): import("@dereekb/zoho").ZohoDeskGetTicketThreadsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketThreadById}.
      *
-     * @returns a function that fetches a single thread on a Desk ticket by thread id
+     * @returns Fetches a single thread on a Desk ticket by thread id.
      */
     get getTicketThreadById(): import("@dereekb/zoho").ZohoDeskGetTicketThreadByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketThreadsPageFactory}.
      *
-     * @returns a paged result factory for iterating over Desk ticket thread responses
+     * @returns A paged result factory for iterating over Desk ticket thread responses.
      */
     get getTicketThreadsPageFactory(): import("@dereekb/zoho").ZohoDeskGetTicketThreadsPageFactory;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketActivities}.
      *
-     * @returns a function that lists the activity log entries for a given Desk ticket
+     * @returns Lists the activity log entries for a given Desk ticket.
      */
     get getTicketActivities(): import("@dereekb/zoho").ZohoDeskGetTicketActivitiesFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetTicketActivitiesPageFactory}.
      *
-     * @returns a paged result factory for iterating over Desk ticket activity responses
+     * @returns A paged result factory for iterating over Desk ticket activity responses.
      */
     get getTicketActivitiesPageFactory(): import("@dereekb/zoho").ZohoDeskGetTicketActivitiesPageFactory;
     /**
      * Configured pass-through for {@link zohoDeskGetAgents}.
      *
-     * @returns a function that lists Desk agents matching the supplied filter/pagination input
+     * @returns Lists Desk agents matching the supplied filter/pagination input.
      */
     get getAgents(): import("@dereekb/zoho").ZohoDeskGetAgentsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetAgentById}.
      *
-     * @returns a function that fetches a single Desk agent by agent id
+     * @returns Fetches a single Desk agent by agent id.
      */
     get getAgentById(): import("@dereekb/zoho").ZohoDeskGetAgentByIdFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetAgentsByIds}.
      *
-     * @returns a function that fetches multiple Desk agents in a single request by their identifiers
+     * @returns Fetches multiple Desk agents in a single request by their identifiers.
      */
     get getAgentsByIds(): import("@dereekb/zoho").ZohoDeskGetAgentsByIdsFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetMyInfo}.
      *
-     * @returns a function that fetches the profile information for the currently authenticated agent
+     * @returns Fetches the profile information for the currently authenticated agent.
      */
     get getMyInfo(): import("@dereekb/zoho").ZohoDeskGetMyInfoFunction;
     /**
      * Configured pass-through for {@link zohoDeskGetAgentsPageFactory}.
      *
-     * @returns a paged result factory for iterating over Desk agent list responses
+     * @returns A paged result factory for iterating over Desk agent list responses.
      */
     get getAgentsPageFactory(): import("@dereekb/zoho").ZohoDeskGetAgentsPageFactory;
 }

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

@@ -21,7 +21,8 @@ export declare abstract class ZohoDeskServiceConfig {
     /**
      * Validates that the required Zoho Desk connection fields are present and well-formed.
      *
-     * @param config - the Desk service config to validate
+     * @param config - The Desk service config to validate.
+     * @throws {Error} When `config.zohoDesk.orgId` is missing or fails the shared Zoho config assertion.
      */
     static assertValidConfig(config: ZohoDeskServiceConfig): void;
 }

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

@@ -16,17 +16,17 @@ export declare const ZOHO_ORG_ID_CONFIG_KEY = "ORG_ID";
  * `ZOHO_DESK_API_URL` (service-specific) or `ZOHO_API_URL` (shared fallback).
  * The organization ID is read from `ZOHO_DESK_ORG_ID` or `ZOHO_ORG_ID`.
  *
- * @param configService - NestJS config service populated with Zoho environment variables
- * @returns Validated Zoho Desk service configuration
- * @throws {Error} If required config values (API URL or orgId) are missing
+ * @param configService - NestJS config service populated with Zoho environment variables.
+ * @returns Validated Zoho Desk service configuration.
+ * @throws {Error} If required config values (API URL or orgId) are missing.
  */
 export declare function zohoDeskServiceConfigFactory(configService: ConfigService): ZohoDeskServiceConfig;
 /**
  * Reads Zoho Accounts (OAuth) settings scoped to the Desk 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 Desk service access token
+ * @param configService - NestJS config service populated with Zoho OAuth environment variables.
+ * @returns Zoho Accounts service config scoped to the Desk service access token.
  */
 export declare function zohoDeskAccountServiceConfigFactory(configService: ConfigService): ZohoAccountsServiceConfig;
 /**
@@ -56,7 +56,7 @@ export interface ProvideAppZohoDeskMetadataConfig extends Pick<ModuleMetadata, '
  * exports {@link ZohoDeskApi} by default. Additional imports, exports, and providers
  * from the config are merged in.
  *
- * @param config - Module configuration with optional dependency module and extra metadata
+ * @param config - Module configuration with optional dependency module and extra metadata.
  * @returns Complete NestJS module metadata ready to pass to `@Module()`
  */
 export declare function appZohoDeskModuleMetadata(config: ProvideAppZohoDeskMetadataConfig): ModuleMetadata;

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

@@ -17,189 +17,189 @@ export declare class ZohoRecruitApi {
     /**
      * The authenticated Recruit context used by all operation accessors.
      *
-     * @returns the Recruit context from the underlying client
+     * @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
+     * @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
+     * @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}.
      *
-     * @returns bound insert record function
+     * @returns Bound insert record function.
      */
     get insertRecord(): import("@dereekb/zoho").ZohoRecruitCreateRecordLikeFunction;
     /**
      * Configured pass-through for {@link zohoRecruitUpsertRecord}.
      *
-     * @returns bound upsert record function
+     * @returns Bound upsert record function.
      */
     get upsertRecord(): import("@dereekb/zoho").ZohoRecruitUpsertRecordLikeFunction;
     /**
      * Configured pass-through for {@link zohoRecruitUpdateRecord}.
      *
-     * @returns bound update record function
+     * @returns Bound update record function.
      */
     get updateRecord(): import("@dereekb/zoho").ZohoRecruitUpdateRecordLikeFunction;
     /**
      * Configured pass-through for {@link zohoRecruitDeleteRecord}.
      *
-     * @returns bound delete record function
+     * @returns Bound delete record function.
      */
     get deleteRecord(): import("@dereekb/zoho").ZohoRecruitDeleteRecordFunction;
     /**
      * Configured pass-through for {@link zohoRecruitGetRecordById}.
      *
-     * @returns bound get record by ID function
+     * @returns Bound get record by ID function.
      */
     get getRecordById(): import("@dereekb/zoho").ZohoRecruitGetRecordByIdFunction;
     /**
      * Configured pass-through for {@link zohoRecruitGetRecords}.
      *
-     * @returns bound get records function
+     * @returns Bound get records function.
      */
     get getRecords(): import("@dereekb/zoho").ZohoRecruitGetRecordsFunction;
     /**
      * Configured pass-through for {@link zohoRecruitSearchRecords}.
      *
-     * @returns bound search records function
+     * @returns Bound search records function.
      */
     get searchRecords(): import("@dereekb/zoho").ZohoRecruitSearchRecordsFunction;
     /**
      * Configured pass-through for {@link zohoRecruitSearchRecordsPageFactory}.
      *
-     * @returns bound search records page factory function
+     * @returns Bound search records page factory function.
      */
     get searchRecordsPageFactory(): import("@dereekb/zoho").ZohoRecruitSearchRecordsPageFactory;
     /**
      * Configured pass-through for {@link zohoRecruitGetRelatedRecordsFunctionFactory}.
      *
-     * @returns bound get related records factory function
+     * @returns Bound get related records factory function.
      */
     get getRelatedRecordsFunctionFactory(): import("@dereekb/zoho").ZohoRecruitGetRelatedRecordsFunctionFactory;
     /**
      * Configured pass-through for {@link zohoRecruitGetEmailsForRecord}.
      *
-     * @returns bound get emails for record function
+     * @returns Bound get emails for record function.
      */
     get getEmailsForRecord(): import("@dereekb/zoho").ZohoRecruitGetEmailsForRecordFunction;
     /**
      * Configured pass-through for {@link zohoRecruitGetEmailsForRecordPageFactory}.
      *
-     * @returns bound get emails page factory function
+     * @returns Bound get emails page factory function.
      */
     get getEmailsForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetEmailsForRecordPageFactory;
     /**
      * Configured pass-through for {@link zohoRecruitGetAttachmentsForRecord}.
      *
-     * @returns bound get attachments for record function
+     * @returns Bound get attachments for record function.
      */
     get getAttachmentsForRecord(): import("@dereekb/zoho").ZohoRecruitGetAttachmentsForRecordFunction;
     /**
      * Configured pass-through for {@link zohoRecruitGetAttachmentsForRecordPageFactory}.
      *
-     * @returns bound get attachments page factory function
+     * @returns Bound get attachments page factory function.
      */
     get getAttachmentsForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetAttachmentsForRecordPageFactory;
     /**
      * Configured pass-through for {@link zohoRecruitUploadAttachmentForRecord}.
      *
-     * @returns bound upload attachment function
+     * @returns Bound upload attachment function.
      */
     get uploadAttachmentForRecord(): import("@dereekb/zoho").ZohoRecruitUploadAttachmentForRecordFunction;
     /**
      * Configured pass-through for {@link zohoRecruitDownloadAttachmentForRecord}.
      *
-     * @returns bound download attachment function
+     * @returns Bound download attachment function.
      */
     get downloadAttachmentForRecord(): import("@dereekb/zoho").ZohoRecruitDownloadAttachmentForRecordFunction;
     /**
      * Configured pass-through for {@link zohoRecruitDeleteAttachmentFromRecord}.
      *
-     * @returns bound delete attachment function
+     * @returns Bound delete attachment function.
      */
     get deleteAttachmentFromRecord(): import("@dereekb/zoho").ZohoRecruitDeleteAttachmentFromRecordFunction;
     /**
      * Configured pass-through for {@link zohoRecruitCreateNotes}.
      *
-     * @returns bound create notes function
+     * @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}.
      *
-     * @returns bound delete notes function
+     * @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}.
      *
-     * @returns bound create notes for record function
+     * @returns Bound create notes for record function.
      */
     get createNotesForRecord(): import("@dereekb/zoho").ZohoRecruitCreateNotesForRecordFunction;
     /**
      * Configured pass-through for {@link zohoRecruitGetNotesForRecord}.
      *
-     * @returns bound get notes for record function
+     * @returns Bound get notes for record function.
      */
     get getNotesForRecord(): import("@dereekb/zoho").ZohoRecruitGetNotesForRecordFunction;
     /**
      * Configured pass-through for {@link zohoRecruitGetNotesForRecordPageFactory}.
      *
-     * @returns bound get notes page factory function
+     * @returns Bound get notes page factory function.
      */
     get getNotesForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetNotesForRecordPageFactory;
     /**
      * Configured pass-through for {@link zohoRecruitExecuteRestApiFunction}.
      *
-     * @returns bound execute REST API function
+     * @returns Bound execute REST API function.
      */
     get executeRestApiFunction(): import("@dereekb/zoho").ZohoRecruitExecuteRestApiFunctionFunction;
     /**
      * Configured pass-through for {@link zohoRecruitAssociateCandidateRecordsWithJobOpenings}.
      *
-     * @returns bound associate candidates with job openings function
+     * @returns Bound associate candidates with job openings function.
      */
     get associateCandidateRecordsWithJobOpenings(): import("@dereekb/zoho").ZohoRecruitAssociateCandidateRecordsWithJobOpeningsFunction;
     /**
      * Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecords}.
      *
-     * @returns bound search candidate associated job openings function
+     * @returns Bound search candidate associated job openings function.
      */
     get searchCandidateAssociatedJobOpeningRecords(): import("@dereekb/zoho").ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsFunction<import("@dereekb/zoho").ZohoRecruitRecord>;
     /**
      * Configured pass-through for {@link zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory}.
      *
-     * @returns bound search candidate job openings page factory function
+     * @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}.
      *
-     * @returns bound search job opening associated candidates function
+     * @returns Bound search job opening associated candidates function.
      */
     get searchJobOpeningAssociatedCandidateRecords(): import("@dereekb/zoho").ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsFunction<import("@dereekb/zoho").ZohoRecruitRecord>;
     /**
      * Configured pass-through for {@link zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory}.
      *
-     * @returns bound search job opening candidates page factory function
+     * @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}.
      *
-     * @returns bound create tags for module function
+     * @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>[];
@@ -210,19 +210,19 @@ export declare class ZohoRecruitApi {
     /**
      * Configured pass-through for {@link zohoRecruitGetTagsForModule}.
      *
-     * @returns bound get tags for module function
+     * @returns Bound get tags for module function.
      */
     get getTagsForModule(): import("@dereekb/zoho").ZohoRecruitGetTagsFunction;
     /**
      * Configured pass-through for {@link zohoRecruitAddTagsToRecords}.
      *
-     * @returns bound add tags to records function
+     * @returns Bound add tags to records function.
      */
     get addTagsToRecords(): import("@dereekb/zoho").ZohoRecruitAddTagsToRecordsFunction;
     /**
      * Configured pass-through for {@link zohoRecruitRemoveTagsFromRecords}.
      *
-     * @returns bound remove tags from records function
+     * @returns Bound remove tags from records function.
      */
     get removeTagsFromRecords(): import("@dereekb/zoho").ZohoRecruitRemoveTagsFromRecordsFunction;
 }

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

@@ -21,7 +21,7 @@ export declare abstract class ZohoRecruitServiceConfig {
     /**
      * Validates that the required Zoho Recruit connection fields are present and well-formed.
      *
-     * @param config - the Recruit service config to validate
+     * @param config - The Recruit service config to validate.
      */
     static assertValidConfig(config: ZohoRecruitServiceConfig): void;
 }