@dereekb/zoho 13.11.13 → 13.11.15

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

@@ -36,8 +36,8 @@ export type ZohoRecruitCreateTagsFunction = (input: ZohoRecruitCreateTagsRequest
  * (which are often non-fatal) from other errors, making it easy to handle the common
  * case where a tag already exists.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that creates tags in the specified module
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that creates tags in the specified module.
  *
  * @example
  * ```typescript
@@ -79,8 +79,10 @@ export type ZohoRecruitGetTagsFunction = (input: ZohoRecruitGetTagsRequest) => P
  * Returns the list of tags within a module. Normalizes the non-standard API response
  * that returns data under a `tags` key instead of the standard `data` key.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that retrieves tags for a module
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that retrieves tags for a module.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-tag-list.html
  *
  * @example
  * ```typescript
@@ -90,8 +92,6 @@ export type ZohoRecruitGetTagsFunction = (input: ZohoRecruitGetTagsRequest) => P
  *   module: ZOHO_RECRUIT_CANDIDATES_MODULE
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/get-tag-list.html
  */
 export declare function zohoRecruitGetTagsForModule(context: ZohoRecruitContext): ZohoRecruitGetTagsFunction;
 /**
@@ -104,8 +104,9 @@ export type ZohoRecruitGetTagsForModulePageFactory = (input: ZohoRecruitGetTagsR
  * Returns a page factory for iterating over tags in a module across multiple pages.
  * Wraps {@link zohoRecruitGetTagsForModule} with automatic pagination handling.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Page factory for iterating over module tags
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Page factory for iterating over module tags.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoRecruitGetTagsForModulePageFactory(context: ZohoRecruitContext): ZohoRecruitGetTagsForModulePageFactory;
@@ -163,9 +164,11 @@ export type ZohoRecruitAddTagsToRecordsFunction = (input: ZohoRecruitAddTagsToRe
  * Adds one or more tags to one or more records. Returns a paired success/error result
  * for each record. Maximum of {@link ZOHO_RECRUIT_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED} (100) record IDs per call.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that adds tags to records
- * @throws {Error} If more than 100 record IDs are provided
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that adds tags to records.
+ * @throws {Error} If more than 100 record IDs are provided.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/add-tags.html
  *
  * @example
  * ```typescript
@@ -177,8 +180,6 @@ export type ZohoRecruitAddTagsToRecordsFunction = (input: ZohoRecruitAddTagsToRe
  *   ids: [candidateId1, candidateId2]
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/add-tags.html
  */
 export declare function zohoRecruitAddTagsToRecords(context: ZohoRecruitContext): ZohoRecruitAddTagsToRecordsFunction;
 /**
@@ -209,9 +210,11 @@ export type ZohoRecruitRemoveTagsFromRecordsFunction = (input: ZohoRecruitRemove
  * Removes one or more tags from one or more records. Returns a paired success/error result
  * for each record. Maximum of {@link ZOHO_RECRUIT_REMOVE_TAGS_FROM_RECORDS_MAX_IDS_ALLOWED} (100) record IDs per call.
  *
- * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
- * @returns Function that removes tags from records
- * @throws {Error} If more than 100 record IDs are provided
+ * @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
+ * @returns Function that removes tags from records.
+ * @throws {Error} If more than 100 record IDs are provided.
+ *
+ * @see https://www.zoho.com/recruit/developer-guide/apiv2/remove-tags.html
  *
  * @example
  * ```typescript
@@ -223,8 +226,6 @@ export type ZohoRecruitRemoveTagsFromRecordsFunction = (input: ZohoRecruitRemove
  *   ids: candidateId
  * });
  * ```
- *
- * @see https://www.zoho.com/recruit/developer-guide/apiv2/remove-tags.html
  */
 export declare function zohoRecruitRemoveTagsFromRecords(context: ZohoRecruitContext): ZohoRecruitRemoveTagsFromRecordsFunction;
 /**

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

@@ -22,8 +22,8 @@ export type ZohoRecruitConfigApiUrlInput = ZohoRecruitApiUrlKey | ZohoRecruitApi
 /**
  * Resolves an environment key or passthrough URL to the full Zoho Recruit API URL.
  *
- * @param input - An environment key ('sandbox' or 'production') or a full API URL
- * @returns The resolved Zoho Recruit API URL
+ * @param input - An environment key ('sandbox' or 'production') or a full API URL.
+ * @returns The resolved Zoho Recruit API URL.
  */
 export declare function zohoRecruitConfigApiUrl(input: ZohoRecruitConfigApiUrlInput): ZohoApiUrl;
 /**

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

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

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

@@ -50,16 +50,16 @@ export declare class ZohoRecruitRecordCrudNoMatchingRecordError extends ZohoRecr
 /**
  * Creates a typed CRUD error subclass based on the error code returned by the Zoho Recruit API, enabling callers to catch specific failure modes.
  *
- * @param error - Structured error data from the Zoho Recruit API response
- * @returns A specific CRUD error subclass matching the error code
+ * @param error - Structured error data from the Zoho Recruit API response.
+ * @returns A specific CRUD error subclass matching the error code.
  */
 export declare function zohoRecruitRecordCrudError(error: ZohoServerErrorDataWithDetails): ZohoRecruitRecordCrudError;
 /**
  * Returns an assertion function that throws {@link ZohoRecruitRecordNoContentError} when the data array result is empty or null, indicating the requested record does not exist.
  *
- * @param moduleName - Optional module name for the error context
- * @param recordId - Optional record ID for the error context
- * @returns Assertion function that validates the data array is non-empty
+ * @param moduleName - Optional module name for the error context.
+ * @param recordId - Optional record ID for the error context.
+ * @returns Assertion function that validates the data array is non-empty.
  */
 export declare function assertZohoRecruitRecordDataArrayResultHasContent<T>(moduleName?: ZohoRecruitModuleName, recordId?: ZohoRecruitRecordId): <R extends ZohoDataArrayResultRef<T>>(x: R) => R;
 /**
@@ -69,16 +69,16 @@ export declare const logZohoRecruitErrorToConsole: import("..").LogZohoServerErr
 /**
  * Parses the JSON body of a failed Zoho Recruit fetch response into a structured error, returning undefined if the body cannot be parsed.
  *
- * @param responseError - The fetch response error to parse
- * @returns Parsed Zoho server error, or undefined if parsing fails
+ * @param responseError - The fetch response error to parse.
+ * @returns Parsed Zoho server error, or undefined if parsing fails.
  */
 export declare function parseZohoRecruitError(responseError: FetchResponseError): Promise<ParsedZohoServerError>;
 /**
  * Converts raw Zoho Recruit error response data into a parsed error, delegating to Recruit-specific handlers for known error codes and falling back to the shared Zoho parser.
  *
- * @param errorResponseData - Raw error response data from the Zoho Recruit API
- * @param responseError - The underlying fetch response error
- * @returns Parsed Zoho server error, or undefined if the data contains no recognizable error
+ * @param errorResponseData - Raw error response data from the Zoho Recruit API.
+ * @param responseError - The underlying fetch response error.
+ * @returns Parsed Zoho server error, or undefined if the data contains no recognizable error.
  */
 export declare function parseZohoRecruitServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData, responseError: FetchResponseError): ParsedZohoServerError;
 /**

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

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

package/src/lib/recruit/recruit.notes.d.ts

@@ -1,4 +1,4 @@
-import { type ISO8601DateString, type UniqueModelWithId } from '@dereekb/util';
+import { type ISO8601DateString, type UniqueModelWithId, type Maybe } from '@dereekb/util';
 import { type ZohoRecruitReferenceData, type ZohoRecruitParentReferenceData, type ZohoRecruitTypeId, type ZohoRecruitModuleName, type ZohoRecruitCreatedByData, type ZohoRecruitModifiedByData, type ZohoRecruitId } from './recruit';
 /**
  * Unique identifier for a note in Zoho Recruit.
@@ -41,7 +41,7 @@ export interface ZohoRecruitNoteData {
     Note_Owner: ZohoRecruitNoteOwnerData;
     Created_By: ZohoRecruitCreatedByData;
     Modified_By: ZohoRecruitModifiedByData;
-    $size: ZohoRecruitNoteFileSize | null;
+    $size: Maybe<ZohoRecruitNoteFileSize>;
     $voice_note: boolean;
     $status: ZohoRecruitNoteStatus;
 }

package/src/lib/shared/criteria.d.ts

@@ -24,8 +24,8 @@ export declare const MAX_ZOHO_SEARCH_MODULE_RECORDS_CRITERIA = 10;
  * {@link ZohoSearchRecordsCriteriaTree} with nested AND/OR groups. Returns
  * `undefined` when the input is nullish or empty.
  *
- * @param input - Criteria tree element, entry array, or raw criteria string
- * @returns Compiled criteria string, or `undefined` if input is empty
+ * @param input - Criteria tree element, entry array, or raw criteria string.
+ * @returns Compiled criteria string, or `undefined` if input is empty.
  *
  * @example
  * ```typescript
@@ -51,8 +51,8 @@ export declare function zohoSearchRecordsCriteriaString<T = any>(input: Maybe<Zo
  * recursively resolving nested AND/OR groups. When both `and` and `or` are
  * present at the same level, the OR group is merged into the AND group.
  *
- * @param tree - Criteria tree containing `and` and/or `or` branches
- * @returns Compiled criteria string, or `undefined` if the tree is empty
+ * @param tree - Criteria tree containing `and` and/or `or` branches.
+ * @returns Compiled criteria string, or `undefined` if the tree is empty.
  */
 export declare function zohoSearchRecordsCriteriaStringForTree<T = any>(tree: ZohoSearchRecordsCriteriaTree<T>): Maybe<ZohoSearchRecordsCriteriaString>;
 /**
@@ -123,7 +123,7 @@ export declare const escapeZohoFieldValueForCriteriaString: import("@dereekb/uti
  *
  * Automatically escapes parentheses and commas in the value via {@link escapeZohoFieldValueForCriteriaString}.
  *
- * @param entry - The criteria entry to convert
+ * @param entry - The criteria entry to convert.
  * @returns Criteria string in the format `(field:filter:escapedValue)`
  *
  * @example

package/src/lib/shared/criteria.util.d.ts

@@ -5,9 +5,9 @@ import { type ZohoSearchRecordsCriteriaEntryArray } from './criteria';
  *
  * When used within an OR criteria tree, this enables searching for records matching any of the provided emails.
  *
- * @param emails - Single email or array of emails to create criteria entries for
+ * @param emails - Single email or array of emails to create criteria entries for.
  * @param field - Record field name to match against. Defaults to `'Email'`.
- * @returns Array of criteria entries, one per email, each using the `equals` filter
+ * @returns Array of criteria entries, one per email, each using the `equals` filter.
  *
  * @example
  * ```typescript

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

@@ -48,16 +48,16 @@ export type ZohoSignGetDocumentFunction = (input: ZohoSignGetDocumentInput) => P
  * Fetches the full details of a single Zoho Sign request (envelope) by its ID,
  * including actions, documents, and field data.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Function that retrieves a document by request ID
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Function that retrieves a document by request ID.
+ *
+ * @see https://www.zoho.com/sign/api/document-managment/get-details-of-a-particular-document.html
  *
  * @example
  * ```typescript
  * const getDocument = zohoSignGetDocument(context);
  * const response = await getDocument({ requestId: '12345' });
  * ```
- *
- * @see https://www.zoho.com/sign/api/document-managment/get-details-of-a-particular-document.html
  */
 export declare function zohoSignGetDocument(context: ZohoSignContext): ZohoSignGetDocumentFunction;
 export interface ZohoSignGetDocumentsInput extends ZohoSignPageFilter {
@@ -72,16 +72,16 @@ export type ZohoSignGetDocumentsFunction = (input: ZohoSignGetDocumentsInput) =>
  * Pagination parameters (`start_index`, `row_count`) are serialized as a
  * JSON `data` query parameter per the Zoho Sign API convention.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Function that retrieves a paginated list of documents
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Function that retrieves a paginated list of documents.
+ *
+ * @see https://www.zoho.com/sign/api/document-managment/get-document-list.html
  *
  * @example
  * ```typescript
  * const getDocuments = zohoSignGetDocuments(context);
  * const response = await getDocuments({ start_index: 1, row_count: 10 });
  * ```
- *
- * @see https://www.zoho.com/sign/api/document-managment/get-document-list.html
  */
 export declare function zohoSignGetDocuments(context: ZohoSignContext): ZohoSignGetDocumentsFunction;
 /**
@@ -91,8 +91,8 @@ export declare function zohoSignGetDocuments(context: ZohoSignContext): ZohoSign
  * `start_index`/`row_count` pagination, making it easy to iterate
  * through all documents across multiple pages.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Page factory for iterating through documents
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Page factory for iterating through documents.
  *
  * @example
  * ```typescript
@@ -102,6 +102,7 @@ export declare function zohoSignGetDocuments(context: ZohoSignContext): ZohoSign
  * const firstPage = await fetchPage.fetchNext();
  * const secondPage = await firstPage.fetchNext();
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoSignGetDocumentsPageFactory(context: ZohoSignContext): import("@dereekb/util/fetch").FetchPageFactory<ZohoSignGetDocumentsInput, ZohoSignGetDocumentsResponse>;
@@ -116,16 +117,16 @@ export type ZohoSignGetDocumentFormDataFunction = (input: ZohoSignGetDocumentFor
  * returns data after all recipients have signed. The response includes
  * field labels and values grouped by recipient action.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Function that retrieves form data for a completed document
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Function that retrieves form data for a completed document.
+ *
+ * @see https://www.zoho.com/sign/api/document-managment/get-document-form-data.html
  *
  * @example
  * ```typescript
  * const getFormData = zohoSignGetDocumentFormData(context);
  * const response = await getFormData({ requestId: '12345' });
  * ```
- *
- * @see https://www.zoho.com/sign/api/document-managment/get-document-form-data.html
  */
 export declare function zohoSignGetDocumentFormData(context: ZohoSignContext): ZohoSignGetDocumentFormDataFunction;
 export type ZohoSignRetrieveFieldTypesFunction = () => Promise<ZohoSignRetrieveFieldTypesResponse>;
@@ -136,16 +137,16 @@ export type ZohoSignRetrieveFieldTypesFunction = () => Promise<ZohoSignRetrieveF
  * that can be placed on documents. Useful for dynamically building document
  * templates or validating field configurations.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Function that retrieves all available field types
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Function that retrieves all available field types.
+ *
+ * @see https://www.zoho.com/sign/api/document-managment/retrieve-field-type.html
  *
  * @example
  * ```typescript
  * const retrieveFieldTypes = zohoSignRetrieveFieldTypes(context);
  * const response = await retrieveFieldTypes();
  * ```
- *
- * @see https://www.zoho.com/sign/api/document-managment/retrieve-field-type.html
  */
 export declare function zohoSignRetrieveFieldTypes(context: ZohoSignContext): ZohoSignRetrieveFieldTypesFunction;
 export interface ZohoSignDownloadPdfInput {
@@ -173,8 +174,10 @@ export type ZohoSignDownloadPdfFunction = (input: ZohoSignDownloadPdfInput) => P
  * completion certificate, merge all documents, or provide a password for
  * protected files.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Function that downloads signed PDFs by request ID
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Function that downloads signed PDFs by request ID.
+ *
+ * @see https://www.zoho.com/sign/api/document-managment/download-pdf.html
  *
  * @example
  * ```typescript
@@ -189,8 +192,6 @@ export type ZohoSignDownloadPdfFunction = (input: ZohoSignDownloadPdfInput) => P
  *
  * const blob = await response.blob();
  * ```
- *
- * @see https://www.zoho.com/sign/api/document-managment/download-pdf.html
  */
 export declare function zohoSignDownloadPdf(context: ZohoSignContext): ZohoSignDownloadPdfFunction;
 export interface ZohoSignDownloadCompletionCertificateInput {
@@ -204,8 +205,10 @@ export type ZohoSignDownloadCompletionCertificateFunction = (input: ZohoSignDown
  * certificate contains an audit trail of the signing process including
  * timestamps and recipient details. Returns a raw {@link Response}.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Function that downloads the completion certificate by request ID
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Function that downloads the completion certificate by request ID.
+ *
+ * @see https://www.zoho.com/sign/api/document-managment/download-completion-certificate.html
  *
  * @example
  * ```typescript
@@ -213,8 +216,6 @@ export type ZohoSignDownloadCompletionCertificateFunction = (input: ZohoSignDown
  * const response = await downloadCert({ requestId: '12345' });
  * const blob = await response.blob();
  * ```
- *
- * @see https://www.zoho.com/sign/api/document-managment/download-completion-certificate.html
  */
 export declare function zohoSignDownloadCompletionCertificate(context: ZohoSignContext): ZohoSignDownloadCompletionCertificateFunction;
 export interface ZohoSignCreateDocumentInput {
@@ -236,8 +237,10 @@ export type ZohoSignCreateDocumentFunction = (input: ZohoSignCreateDocumentInput
  * The created document starts in draft status and must be submitted
  * separately via {@link zohoSignSendDocumentForSignature}.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Function that creates a new document draft
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Function that creates a new document draft.
+ *
+ * @see https://www.zoho.com/sign/api/document-managment/create-document.html
  *
  * @example
  * ```typescript
@@ -260,8 +263,6 @@ export type ZohoSignCreateDocumentFunction = (input: ZohoSignCreateDocumentInput
  *
  * const draftId = response.requests.request_id;
  * ```
- *
- * @see https://www.zoho.com/sign/api/document-managment/create-document.html
  */
 export declare function zohoSignCreateDocument(context: ZohoSignContext): ZohoSignCreateDocumentFunction;
 export interface ZohoSignUpdateDocumentInput {
@@ -277,8 +278,10 @@ export type ZohoSignUpdateDocumentFunction = (input: ZohoSignUpdateDocumentInput
  * expiration settings. Cannot be used on documents that have already been
  * submitted for signature.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Function that updates a draft document by request ID
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Function that updates a draft document by request ID.
+ *
+ * @see https://www.zoho.com/sign/api/document-managment/update-document.html
  *
  * @example
  * ```typescript
@@ -289,8 +292,6 @@ export type ZohoSignUpdateDocumentFunction = (input: ZohoSignUpdateDocumentInput
  *   data: { notes: 'Updated notes for this document' }
  * });
  * ```
- *
- * @see https://www.zoho.com/sign/api/document-managment/update-document.html
  */
 export declare function zohoSignUpdateDocument(context: ZohoSignContext): ZohoSignUpdateDocumentFunction;
 export interface ZohoSignSendDocumentForSignatureInput {
@@ -306,8 +307,10 @@ export type ZohoSignSendDocumentForSignatureFunction = (input: ZohoSignSendDocum
  * submission. Once submitted, the document transitions from draft to
  * "inprogress" status and recipients receive signing notifications.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Function that sends a document for signature by request ID
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Function that sends a document for signature by request ID.
+ *
+ * @see https://www.zoho.com/sign/api/document-managment/send-document-for-signature.html
  *
  * @example
  * ```typescript
@@ -322,8 +325,6 @@ export type ZohoSignSendDocumentForSignatureFunction = (input: ZohoSignSendDocum
  *   data: { expiration_days: 30 }
  * });
  * ```
- *
- * @see https://www.zoho.com/sign/api/document-managment/send-document-for-signature.html
  */
 export declare function zohoSignSendDocumentForSignature(context: ZohoSignContext): ZohoSignSendDocumentForSignatureFunction;
 export interface ZohoSignExtendDocumentInput {
@@ -343,16 +344,16 @@ export type ZohoSignExtendDocumentFunction = (input: ZohoSignExtendDocumentInput
  * provided as a human-readable string (e.g. "30 November 2024"). Useful for
  * giving recipients additional time to complete signing.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Function that extends a document's expiration by request ID
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Function that extends a document's expiration by request ID.
+ *
+ * @see https://www.zoho.com/sign/api/document-managment/extend-document.html
  *
  * @example
  * ```typescript
  * const extendDocument = zohoSignExtendDocument(context);
  * await extendDocument({ requestId: '12345', expire_by: '30 November 2024' });
  * ```
- *
- * @see https://www.zoho.com/sign/api/document-managment/extend-document.html
  */
 export declare function zohoSignExtendDocument(context: ZohoSignContext): ZohoSignExtendDocumentFunction;
 export interface ZohoSignDeleteDocumentInput {
@@ -375,8 +376,10 @@ export type ZohoSignDeleteDocumentFunction = (input: ZohoSignDeleteDocumentInput
  * from recipients before deletion. An optional `reason` can be provided
  * to explain the recall. Sends the parameters as URL-encoded form data.
  *
- * @param context - Authenticated Zoho Sign context providing fetch and rate limiting
- * @returns Function that deletes a document by request ID
+ * @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
+ * @returns Function that deletes a document by request ID.
+ *
+ * @see https://www.zoho.com/sign/api/document-managment/delete-document.html
  *
  * @example
  * ```typescript
@@ -392,7 +395,5 @@ export type ZohoSignDeleteDocumentFunction = (input: ZohoSignDeleteDocumentInput
  *   reason: 'Contract terms changed'
  * });
  * ```
- *
- * @see https://www.zoho.com/sign/api/document-managment/delete-document.html
  */
 export declare function zohoSignDeleteDocument(context: ZohoSignContext): ZohoSignDeleteDocumentFunction;

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

@@ -1,4 +1,4 @@
-import { type Maybe } from '@dereekb/util';
+import { type SuggestedString, type Maybe } from '@dereekb/util';
 import { type FetchPageFactoryConfigDefaults } from '@dereekb/util/fetch';
 /**
  * Pagination parameters for Zoho Sign list endpoints.
@@ -27,7 +27,7 @@ export interface ZohoSignPageFilter {
 /**
  * Known sortable column names for Zoho Sign list endpoints, with a `string` fallback for custom columns.
  */
-export type ZohoSignSortColumn = 'request_name' | 'folder_name' | 'owner_full_name' | 'recipient_email' | 'form_name' | 'created_time' | (string & {});
+export type ZohoSignSortColumn = SuggestedString<'request_name' | 'folder_name' | 'owner_full_name' | 'recipient_email' | 'form_name' | 'created_time'>;
 /**
  * Sort direction for Zoho Sign list queries.
  */
@@ -90,9 +90,9 @@ export type ZohoSignFetchPageFetchFunction<I extends ZohoSignPageFilter, R exten
  * The factory reads `page_context.has_more_rows` from each response to determine if additional
  * pages exist, and automatically advances `start_index` by `row_count` for subsequent requests.
  *
- * @param fetch - The Zoho Sign fetch function to paginate over
- * @param defaults - Optional default configuration for the page factory
- * @returns A page factory that produces iterable page fetchers
+ * @param fetch - The Zoho Sign fetch function to paginate over.
+ * @param defaults - Optional default configuration for the page factory.
+ * @returns A page factory that produces iterable page fetchers.
  *
  * @example
  * ```typescript
@@ -105,6 +105,7 @@ export type ZohoSignFetchPageFetchFunction<I extends ZohoSignPageFilter, R exten
  *   const secondPage = await firstPage.fetchNext();
  * }
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoSignFetchPageFactory<I extends ZohoSignPageFilter, R extends ZohoSignPageResult<any>>(fetch: ZohoSignFetchPageFetchFunction<I, R>, defaults?: Maybe<FetchPageFactoryConfigDefaults>): import("@dereekb/util/fetch").FetchPageFactory<I, R>;

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

@@ -10,8 +10,8 @@ export type ZohoSignConfigApiUrlInput = ZohoSignApiUrlKey | ZohoSignApiUrl;
 /**
  * Resolves an environment key or passthrough URL to the full Zoho Sign API URL.
  *
- * @param input - An environment key ('sandbox' or 'production') or a full API URL
- * @returns The resolved Zoho Sign API URL
+ * @param input - An environment key ('sandbox' or 'production') or a full API URL.
+ * @returns The resolved Zoho Sign API URL.
  */
 export declare function zohoSignConfigApiUrl(input: ZohoSignConfigApiUrlInput): ZohoApiUrl;
 export type ZohoSignConfig = ZohoConfig;

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

@@ -1,4 +1,4 @@
-import { type EmailAddress, type FileSize, type HexColorCode, type PageNumber, type Pixels, type UnixDateTimeMillisecondsNumber } from '@dereekb/util';
+import { type EmailAddress, type FileSize, type HexColorCode, type SuggestedString, type PageNumber, type Pixels, type UnixDateTimeMillisecondsNumber } from '@dereekb/util';
 /**
  * An identifier in Zoho Sign.
  */
@@ -40,7 +40,7 @@ export type ZohoSignFieldTypeId = string;
 /**
  * Status of a Zoho Sign request.
  */
-export type ZohoSignRequestStatus = 'inprogress' | 'completed' | 'recalled' | 'declined' | 'expired' | (string & {});
+export type ZohoSignRequestStatus = SuggestedString<'inprogress' | 'completed' | 'recalled' | 'declined' | 'expired'>;
 /**
  * Recipient action type in Zoho Sign.
  */
@@ -52,7 +52,7 @@ export type ZohoSignVerificationType = 'EMAIL' | 'SMS' | 'OFFLINE';
 /**
  * Field type name for document fields.
  */
-export type ZohoSignFieldTypeName = 'Checkbox' | 'Radiogroup' | 'Signature' | 'Initial' | 'Textfield' | 'Email' | 'Date' | 'Name' | 'Company' | 'Jobtitle' | 'CustomDate' | 'Dropdown' | 'Attachment' | 'Checkout' | (string & {});
+export type ZohoSignFieldTypeName = SuggestedString<'Checkbox' | 'Radiogroup' | 'Signature' | 'Initial' | 'Textfield' | 'Email' | 'Date' | 'Name' | 'Company' | 'Jobtitle' | 'CustomDate' | 'Dropdown' | 'Attachment' | 'Checkout'>;
 /**
  * Name format for name fields.
  */
@@ -60,7 +60,7 @@ export type ZohoSignNameFormat = 'FIRST_NAME' | 'LAST_NAME' | 'FULL_NAME';
 /**
  * Field category classification.
  */
-export type ZohoSignFieldCategory = 'textfield' | 'image' | 'datefield' | (string & {});
+export type ZohoSignFieldCategory = SuggestedString<'textfield' | 'image' | 'datefield'>;
 /**
  * Definition of a field type available in Zoho Sign.
  */

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

@@ -4,16 +4,16 @@ export declare const logZohoSignErrorToConsole: import("..").LogZohoServerErrorF
 /**
  * Parses the JSON body of a failed Zoho Sign fetch response into a structured error, returning undefined if the body cannot be parsed.
  *
- * @param responseError - The fetch response error to parse
- * @returns Parsed Zoho server error, or undefined if parsing fails
+ * @param responseError - The fetch response error to parse.
+ * @returns Parsed Zoho server error, or undefined if parsing fails.
  */
 export declare function parseZohoSignError(responseError: FetchResponseError): Promise<ParsedZohoServerError>;
 /**
  * Converts raw Zoho Sign error response data into a parsed error, delegating to Sign-specific handlers for known error codes and falling back to the shared Zoho parser.
  *
- * @param errorResponseData - Raw error response data from the Zoho Sign API
- * @param responseError - The underlying fetch response error
- * @returns Parsed Zoho server error, or undefined if the data contains no recognizable error
+ * @param errorResponseData - Raw error response data from the Zoho Sign API.
+ * @param responseError - The underlying fetch response error.
+ * @returns Parsed Zoho server error, or undefined if the data contains no recognizable error.
  */
 export declare function parseZohoSignServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData | ZohoServerErrorResponseDataArrayRef, responseError: FetchResponseError): ParsedZohoServerError;
 export declare const interceptZohoSign200StatusWithErrorResponse: import("@dereekb/util/fetch").FetchJsonInterceptJsonResponseFunction;

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

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

package/src/lib/zoho.api.page.d.ts

@@ -35,7 +35,7 @@ export interface ZohoPageResult<T, I extends ZohoPageResultInfo = ZohoPageResult
  * Creates an empty {@link ZohoPageResult} with no data and `more_records: false`.
  * Useful as a fallback when the API returns `null` instead of an empty result.
  *
- * @returns An empty page result with default pagination info
+ * @returns An empty page result with default pagination info.
  */
 export declare function emptyZohoPageResult<T = unknown>(): ZohoPageResult<T>;
 /**
@@ -76,9 +76,9 @@ export type ZohoFetchPageFetchFunction<I extends ZohoPageFilter, R extends ZohoP
  * The factory reads `info.more_records` from each response to determine if additional
  * pages exist, and automatically increments the `page` parameter for subsequent requests.
  *
- * @param fetch - The Zoho fetch function to paginate over
- * @param defaults - Optional default configuration for the page factory
- * @returns A page factory that produces iterable page fetchers
+ * @param fetch - The Zoho fetch function to paginate over.
+ * @param defaults - Optional default configuration for the page factory.
+ * @returns A page factory that produces iterable page fetchers.
  *
  * @example
  * ```typescript
@@ -91,6 +91,7 @@ export type ZohoFetchPageFetchFunction<I extends ZohoPageFilter, R extends ZohoP
  *   const secondPage = await firstPage.fetchNext();
  * }
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function zohoFetchPageFactory<I extends ZohoPageFilter, R extends ZohoPageResult<any>>(fetch: ZohoFetchPageFetchFunction<I, R>, defaults?: Maybe<FetchPageFactoryConfigDefaults>): import("@dereekb/util/fetch").FetchPageFactory<I, R>;