@dereekb/zoho 12.6.21 → 13.0.0

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

@@ -0,0 +1,43 @@
+import { ZohoCrm, ZohoCrmContext } from '@dereekb/zoho';
+import { ZohoCrmServiceConfig } from './crm.config';
+import { ZohoAccountsApi } from '../accounts/accounts.api';
+export declare class ZohoCrmApi {
+    readonly config: ZohoCrmServiceConfig;
+    readonly zohoAccountsApi: ZohoAccountsApi;
+    readonly zohoCrm: ZohoCrm;
+    get crmContext(): ZohoCrmContext;
+    get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
+    constructor(config: ZohoCrmServiceConfig, zohoAccountsApi: ZohoAccountsApi);
+    get insertRecord(): import("@dereekb/zoho").ZohoCrmCreateRecordLikeFunction;
+    get upsertRecord(): import("@dereekb/zoho").ZohoCrmUpsertRecordLikeFunction;
+    get updateRecord(): import("@dereekb/zoho").ZohoCrmUpdateRecordLikeFunction;
+    get deleteRecord(): import("@dereekb/zoho").ZohoCrmDeleteRecordFunction;
+    get getRecordById(): import("@dereekb/zoho").ZohoCrmGetRecordByIdFunction;
+    get getRecords(): import("@dereekb/zoho").ZohoCrmGetRecordsFunction;
+    get searchRecords(): import("@dereekb/zoho").ZohoCrmSearchRecordsFunction;
+    get searchRecordsPageFactory(): import("@dereekb/zoho").ZohoCrmSearchRecordsPageFactory;
+    get getRelatedRecordsFunctionFactory(): import("@dereekb/zoho").ZohoCrmGetRelatedRecordsFunctionFactory;
+    get getEmailsForRecord(): import("@dereekb/zoho").ZohoCrmGetEmailsForRecordFunction;
+    get getEmailsForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetEmailsForRecordPageFactory;
+    get getAttachmentsForRecord(): import("@dereekb/zoho").ZohoCrmGetAttachmentsForRecordFunction;
+    get getAttachmentsForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetAttachmentsForRecordPageFactory;
+    get uploadAttachmentForRecord(): import("@dereekb/zoho").ZohoCrmUploadAttachmentForRecordFunction;
+    get downloadAttachmentForRecord(): import("@dereekb/zoho").ZohoCrmDownloadAttachmentForRecordFunction;
+    get deleteAttachmentFromRecord(): import("@dereekb/zoho").ZohoCrmDeleteAttachmentFromRecordFunction;
+    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>>;
+    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>>;
+    get createNotesForRecord(): import("@dereekb/zoho").ZohoCrmCreateNotesForRecordFunction;
+    get getNotesForRecord(): import("@dereekb/zoho").ZohoCrmGetNotesForRecordFunction;
+    get getNotesForRecordPageFactory(): import("@dereekb/zoho").ZohoCrmGetNotesForRecordPageFactory;
+    get executeRestApiFunction(): import("@dereekb/zoho").ZohoCrmExecuteRestApiFunctionFunction;
+    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>>[];
+    }>;
+    get deleteTag(): import("@dereekb/zoho").ZohoCrmDeleteTagFunction;
+    get getTagsForModule(): import("@dereekb/zoho").ZohoCrmGetTagsFunction;
+    get addTagsToRecords(): import("@dereekb/zoho").ZohoCrmAddTagsToRecordsFunction;
+    get removeTagsFromRecords(): import("@dereekb/zoho").ZohoCrmRemoveTagsFromRecordsFunction;
+}

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

@@ -0,0 +1,10 @@
+import { type ZohoCrmConfig, type ZohoCrmFactoryConfig } from '@dereekb/zoho';
+export type ZohoCrmServiceApiConfig = ZohoCrmConfig & {};
+/**
+ * Configuration for ZohoCrmService
+ */
+export declare abstract class ZohoCrmServiceConfig {
+    readonly zohoCrm: ZohoCrmServiceApiConfig;
+    readonly factoryConfig?: ZohoCrmFactoryConfig;
+    static assertValidConfig(config: ZohoCrmServiceConfig): void;
+}

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

@@ -0,0 +1,24 @@
+import { type ModuleMetadata } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { ZohoCrmServiceConfig } from './crm.config';
+import { ZohoAccountsServiceConfig } from '../accounts/accounts.config';
+import { type Maybe } from '@dereekb/util';
+export declare function zohoCrmServiceConfigFactory(configService: ConfigService): ZohoCrmServiceConfig;
+export declare function zohoCrmAccountServiceConfigFactory(configService: ConfigService): ZohoAccountsServiceConfig;
+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.
+     */
+    readonly dependencyModule?: Maybe<Required<ModuleMetadata>['imports']['0']>;
+}
+/**
+ * Convenience function used to generate ModuleMetadata for an app's ZohoCrmModule.
+ *
+ * @param provide
+ * @param useFactory
+ * @returns
+ */
+export declare function appZohoCrmModuleMetadata(config: ProvideAppZohoCrmMetadataConfig): ModuleMetadata;

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

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

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

@@ -6,7 +6,7 @@ export declare class ZohoRecruitApi {
     readonly zohoAccountsApi: ZohoAccountsApi;
     readonly zohoRecruit: ZohoRecruit;
     get recruitContext(): ZohoRecruitContext;
-    get zohoRateLimiter(): import("dist/packages/util/src").ResetPeriodPromiseRateLimiter;
+    get zohoRateLimiter(): import("@dereekb/util").ResetPeriodPromiseRateLimiter;
     constructor(config: ZohoRecruitServiceConfig, zohoAccountsApi: ZohoAccountsApi);
     get insertRecord(): import("@dereekb/zoho").ZohoRecruitCreateRecordLikeFunction;
     get upsertRecord(): import("@dereekb/zoho").ZohoRecruitUpsertRecordLikeFunction;
@@ -15,12 +15,12 @@ export declare class ZohoRecruitApi {
     get getRecordById(): import("@dereekb/zoho").ZohoRecruitGetRecordByIdFunction;
     get getRecords(): import("@dereekb/zoho").ZohoRecruitGetRecordsFunction;
     get searchRecords(): import("@dereekb/zoho").ZohoRecruitSearchRecordsFunction;
-    get searchRecordsPageFactory(): import("@dereekb/zoho").SearchRecordsPageFactory;
+    get searchRecordsPageFactory(): import("@dereekb/zoho").ZohoRecruitSearchRecordsPageFactory;
     get getRelatedRecordsFunctionFactory(): import("@dereekb/zoho").ZohoRecruitGetRelatedRecordsFunctionFactory;
     get getEmailsForRecord(): import("@dereekb/zoho").ZohoRecruitGetEmailsForRecordFunction;
-    get getEmailsForRecordPageFactory(): import("@dereekb/zoho").GetEmailsForRecordPageFactory;
+    get getEmailsForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetEmailsForRecordPageFactory;
     get getAttachmentsForRecord(): import("@dereekb/zoho").ZohoRecruitGetAttachmentsForRecordFunction;
-    get getAttachmentsForRecordPageFactory(): import("@dereekb/zoho").GetAttachmentsForRecordPageFactory;
+    get getAttachmentsForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetAttachmentsForRecordPageFactory;
     get uploadAttachmentForRecord(): import("@dereekb/zoho").ZohoRecruitUploadAttachmentForRecordFunction;
     get downloadAttachmentForRecord(): import("@dereekb/zoho").ZohoRecruitDownloadAttachmentForRecordFunction;
     get deleteAttachmentFromRecord(): import("@dereekb/zoho").ZohoRecruitDeleteAttachmentFromRecordFunction;
@@ -28,13 +28,13 @@ export declare class ZohoRecruitApi {
     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>>;
     get createNotesForRecord(): import("@dereekb/zoho").ZohoRecruitCreateNotesForRecordFunction;
     get getNotesForRecord(): import("@dereekb/zoho").ZohoRecruitGetNotesForRecordFunction;
-    get getNotesForRecordPageFactory(): import("@dereekb/zoho").GetNotesForRecordPageFactory;
+    get getNotesForRecordPageFactory(): import("@dereekb/zoho").ZohoRecruitGetNotesForRecordPageFactory;
     get executeRestApiFunction(): import("@dereekb/zoho").ZohoRecruitExecuteRestApiFunctionFunction;
     get associateCandidateRecordsWithJobOpenings(): import("@dereekb/zoho").ZohoRecruitAssociateCandidateRecordsWithJobOpeningsFunction;
     get searchCandidateAssociatedJobOpeningRecords(): import("@dereekb/zoho").ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsFunction<import("@dereekb/zoho").ZohoRecruitRecord>;
-    get searchCandidateAssociatedJobOpeningRecordsPageFactory(): import("dist/packages/util/fetch/src").FetchPageFactory<import("@dereekb/zoho").ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsInput, import("@dereekb/zoho").ZohoRecruitSearchAssociatedRecordsResponse<import("@dereekb/zoho").ZohoRecruitRecord>>;
+    get searchCandidateAssociatedJobOpeningRecordsPageFactory(): import("@dereekb/util/fetch").FetchPageFactory<import("@dereekb/zoho").ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsInput, import("@dereekb/zoho").ZohoRecruitSearchAssociatedRecordsResponse<import("@dereekb/zoho").ZohoRecruitRecord>>;
     get searchJobOpeningAssociatedCandidateRecords(): import("@dereekb/zoho").ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsFunction<import("@dereekb/zoho").ZohoRecruitRecord>;
-    get searchJobOpeningAssociatedCandidateRecordsPageFactory(): import("dist/packages/util/fetch/src").FetchPageFactory<import("@dereekb/zoho").ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsInput, import("@dereekb/zoho").ZohoRecruitSearchAssociatedRecordsResponse<import("@dereekb/zoho").ZohoRecruitRecord>>;
+    get searchJobOpeningAssociatedCandidateRecordsPageFactory(): import("@dereekb/util/fetch").FetchPageFactory<import("@dereekb/zoho").ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsInput, import("@dereekb/zoho").ZohoRecruitSearchAssociatedRecordsResponse<import("@dereekb/zoho").ZohoRecruitRecord>>;
     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>[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoho",
-  "version": "12.6.21",
+  "version": "13.0.0",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",
@@ -15,16 +15,23 @@
     },
     "./nestjs": {
       "types": "./nestjs/src/index.d.ts",
-      "main": "./nestjs/src/index.js",
-      "require": "./nestjs/src/index.js",
-      "default": "./nestjs/src/index.js"
+      "module": "./nestjs/index.esm.js",
+      "main": "./nestjs/index.cjs.js",
+      "node": {
+        "require": "./nestjs/index.cjs.js"
+      },
+      "browser": {
+        "require": "./nestjs/index.cjs.js",
+        "import": "./nestjs/index.esm.js"
+      }
     }
   },
   "peerDependencies": {
-    "@dereekb/util": "*",
-    "make-error": "^1.3.0"
+    "@dereekb/util": "13.0.0",
+    "make-error": "^1.3.0",
+    "core-js": "^3.0.0"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
-  "types": "./index.esm.d.ts"
+  "types": "./index.d.ts"
 }

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

@@ -23,5 +23,5 @@ export interface ZohoAccountsAccessTokenErrorResponse {
  * @param context
  * @returns
  */
-export declare function accessToken(context: ZohoAccountsContext): (input?: ZohoAccountsAccessTokenInput) => Promise<ZohoAccountsAccessTokenResponse>;
+export declare function zohoAccountsAccessToken(context: ZohoAccountsContext): (input?: ZohoAccountsAccessTokenInput) => Promise<ZohoAccountsAccessTokenResponse>;
 export declare function zohoAccountsApiFetchJsonInput(method: string, body?: FetchJsonBody): FetchJsonInput;

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

@@ -21,8 +21,8 @@ export declare class ZohoAccountsAuthFailureError extends FetchRequestFactoryErr
     readonly reason?: string | undefined;
     constructor(reason?: string | undefined);
 }
-export declare const logZohoAccountsErrorToConsole: import("../zoho.error.api").LogZohoServerErrorFunction;
+export declare const logZohoAccountsErrorToConsole: import("..").LogZohoServerErrorFunction;
 export declare function parseZohoAccountsError(responseError: FetchResponseError): Promise<ParsedZohoServerError>;
 export declare function parseZohoAccountsServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData, responseError: FetchResponseError): ParsedZohoServerError;
 export declare const interceptZohoAccounts200StatusWithErrorResponse: import("@dereekb/util/fetch").FetchJsonInterceptJsonResponseFunction;
-export declare const handleZohoAccountsErrorFetch: import("../zoho.error.api").HandleZohoErrorFetchFactory;
+export declare const handleZohoAccountsErrorFetch: import("..").HandleZohoErrorFetchFactory;

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

@@ -0,0 +1,430 @@
+import { type ZohoDataArrayResultRef, type ZohoPageFilter, type ZohoPageResult } from './../zoho.api.page';
+import { type FetchFileResponse, type FetchJsonBody, type FetchJsonInput, type FetchPage, type FetchPageFactory, type FetchPageFactoryOptions, makeUrlSearchParams } from '@dereekb/util/fetch';
+import { type ZohoCrmConfigApiUrlInput, type ZohoCrmContext } from './crm.config';
+import { type ZohoCrmCommaSeparateFieldNames, type ZohoCrmCustomViewId, type ZohoCrmDraftOrSaveState, type ZohoCrmFieldName, type ZohoCrmModuleNameRef, type ZohoCrmChangeObjectDetails, type ZohoCrmRecord, type ZohoCrmRecordId, type ZohoCrmTerritoryId, type ZohoCrmTrueFalseBoth, type ZohoCrmRestFunctionApiName, type ZohoCrmUserId, type ZohoCrmModuleName, type ZohoCrmRecordEmailMetadata, type ZohoCrmRecordAttachmentMetadata, type ZohoCrmAttachmentRecordId, type ZohoCrmAttachmentCategoryId, type KnownZohoCrmAttachmentCategoryName } from './crm';
+import { type ZohoCrmSearchRecordsCriteriaTreeElement } from './crm.criteria';
+import { type ArrayOrValue, type EmailAddress, type Maybe, type PhoneNumber, type SortingOrder, type UniqueModelWithId, type WebsiteUrlWithPrefix } from '@dereekb/util';
+import { type ZohoServerErrorDataWithDetails, type ZohoServerErrorStatus, type ZohoServerSuccessCode, type ZohoServerSuccessStatus } from '../zoho.error.api';
+import { type ZohoDateTimeString } from '../zoho.type';
+import { BaseError } from 'make-error';
+/**
+ * The maximum number of records allowed for most CRUD functions.
+ *
+ * This is a limit enforced by the Zoho Crm API
+ */
+export declare const ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT = 100;
+export type ZohoCrmUpdateRecordResult<T> = ZohoCrmMultiRecordResult<T, ZohoCrmChangeObjectResponseSuccessEntry, ZohoCrmChangeObjectResponseErrorEntry>;
+export type ZohoCrmUpdateRecordResponse = ZohoCrmChangeObjectResponse;
+export type ZohoCrmCreateRecordData<T> = Omit<T, 'id'>;
+export interface ZohoCrmCreateSingleRecordInput<T> extends ZohoCrmModuleNameRef {
+    readonly data: ZohoCrmCreateRecordData<T>;
+}
+export interface ZohoCrmCreateMultiRecordInput<T> extends ZohoCrmModuleNameRef {
+    readonly data: ZohoCrmCreateRecordData<T>[];
+}
+export type ZohoCrmCreateRecordLikeFunction = ZohoCrmCreateMultiRecordFunction & ZohoCrmCreateSingleRecordFunction;
+export type ZohoCrmCreateSingleRecordFunction = <T>(input: ZohoCrmCreateSingleRecordInput<T>) => Promise<ZohoCrmChangeObjectDetails>;
+export type ZohoCrmCreateMultiRecordFunction = <T>(input: ZohoCrmCreateMultiRecordInput<T>) => Promise<ZohoCrmUpdateRecordResult<T>>;
+export type ZohoCrmUpdateRecordInput<T> = ZohoCrmUpdateSingleRecordInput<T> | ZohoCrmUpdateMultiRecordInput<T>;
+export type ZohoCrmUpdateRecordData<T> = UniqueModelWithId & Partial<T>;
+export interface ZohoCrmUpdateSingleRecordInput<T> extends ZohoCrmModuleNameRef {
+    readonly data: ZohoCrmUpdateRecordData<T>;
+}
+export interface ZohoCrmUpdateMultiRecordInput<T> extends ZohoCrmModuleNameRef {
+    readonly data: ZohoCrmUpdateRecordData<T>[];
+}
+export type ZohoCrmUpdateRecordLikeFunction = ZohoCrmUpdateMultiRecordFunction & ZohoCrmUpdateSingleRecordFunction;
+export type ZohoCrmUpdateMultiRecordFunction = <T>(input: ZohoCrmUpdateMultiRecordInput<T>) => Promise<ZohoCrmUpdateRecordResult<T>>;
+export type ZohoCrmUpdateSingleRecordFunction = <T>(input: ZohoCrmUpdateSingleRecordInput<T>) => Promise<ZohoCrmChangeObjectDetails>;
+export type ZohoCrmUpsertRecordData<T> = ZohoCrmCreateRecordData<T> | ZohoCrmUpdateRecordData<T>;
+export interface ZohoCrmUpsertSingleRecordInput<T> extends ZohoCrmModuleNameRef {
+    readonly data: ZohoCrmUpsertRecordData<T>;
+}
+export interface ZohoCrmUpsertMultiRecordInput<T> extends ZohoCrmModuleNameRef {
+    readonly data: ZohoCrmUpsertRecordData<T>[];
+}
+export type ZohoCrmUpsertRecordLikeFunction = ZohoCrmUpsertMultiRecordFunction & ZohoCrmUpsertSingleRecordFunction;
+export type ZohoCrmUpsertMultiRecordFunction = <T>(input: ZohoCrmUpsertMultiRecordInput<T>) => Promise<ZohoCrmUpdateRecordResult<T>>;
+export type ZohoCrmUpsertSingleRecordFunction = <T>(input: ZohoCrmUpsertSingleRecordInput<T>) => Promise<ZohoCrmChangeObjectDetails>;
+export type ZohoCrmInsertRecordFunction = ZohoCrmCreateRecordLikeFunction;
+/**
+ * Inserts one or more records into Crm.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/insert-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmInsertRecord(context: ZohoCrmContext): ZohoCrmInsertRecordFunction;
+/**
+ * Upsert function that can do either an insert or and update ased on the input.
+ */
+export type ZohoCrmUpsertRecordFunction = ZohoCrmUpsertRecordLikeFunction;
+/**
+ * Updates or inserts one or more records in Crm.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/upsert-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmUpsertRecord(context: ZohoCrmContext): ZohoCrmUpsertRecordFunction;
+export type ZohoCrmUpdateRecordFunction = ZohoCrmUpdateRecordLikeFunction;
+/**
+ * Updates one or more records in Crm.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/update-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmUpdateRecord(context: ZohoCrmContext): ZohoCrmUpdateRecordFunction;
+export type ZohoCrmDeleteRecordFunction = (input: ZohoCrmDeleteRecordInput) => Promise<ZohoCrmDeleteRecordResponse>;
+export interface ZohoCrmDeleteRecordInput extends ZohoCrmModuleNameRef {
+    /**
+     * Id or array of ids to delete.
+     */
+    readonly ids: ArrayOrValue<ZohoCrmRecordId>;
+    readonly wf_trigger?: boolean;
+}
+export interface ZohoCrmDeleteRecordResponseSuccessEntry extends ZohoCrmChangeObjectLikeResponseSuccessEntryMeta {
+    readonly details: {
+        readonly id: ZohoCrmRecordId;
+    };
+}
+export type ZohoCrmDeleteRecordResponse = ZohoCrmChangeObjectLikeResponseSuccessAndErrorPairs<ZohoCrmDeleteRecordResponseSuccessEntry>;
+export type ZohoCrmDeleteRecordResult = ZohoCrmChangeObjectResponseSuccessEntry[];
+/**
+ * Deletes one or more records from the given module.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/delete-records.html
+ *
+ * @param context
+ * @returns ZohoCrmDeleteRecordFunction
+ */
+export declare function zohoCrmDeleteRecord(context: ZohoCrmContext): ZohoCrmDeleteRecordFunction;
+export interface ZohoCrmGetRecordByIdInput extends ZohoCrmModuleNameRef {
+    readonly id: ZohoCrmRecordId;
+}
+export type ZohoCrmGetRecordByIdResponse<T = ZohoCrmRecord> = ZohoDataArrayResultRef<T>;
+export type ZohoCrmGetRecordByIdResult<T = ZohoCrmRecord> = T;
+export type ZohoCrmGetRecordByIdFunction = <T = ZohoCrmRecord>(input: ZohoCrmGetRecordByIdInput) => Promise<ZohoCrmGetRecordByIdResult<T>>;
+/**
+ * Retrieves a specific record from the given module.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmGetRecordById(context: ZohoCrmContext): ZohoCrmGetRecordByIdFunction;
+export interface ZohoCrmGetRecordsPageFilter extends ZohoPageFilter {
+    readonly converted?: ZohoCrmTrueFalseBoth;
+    readonly approved?: ZohoCrmTrueFalseBoth;
+}
+export interface ZohoCrmGetRecordsFieldsRef {
+    readonly fields: ArrayOrValue<ZohoCrmFieldName> | ZohoCrmCommaSeparateFieldNames;
+}
+export interface ZohoCrmGetRecordsInput extends ZohoCrmModuleNameRef, ZohoCrmGetRecordsPageFilter, ZohoCrmGetRecordsFieldsRef {
+    readonly sort_order?: SortingOrder;
+    readonly sort_by?: ZohoCrmFieldName;
+    readonly cvid?: ZohoCrmCustomViewId;
+    readonly territory_id?: ZohoCrmTerritoryId;
+    readonly include_child?: boolean;
+    readonly $state?: ZohoCrmDraftOrSaveState;
+}
+export type ZohoCrmGetRecordsResponse<T = ZohoCrmRecord> = ZohoPageResult<T>;
+export type ZohoCrmGetRecordsFunction = <T = ZohoCrmRecord>(input: ZohoCrmGetRecordsInput) => Promise<ZohoCrmGetRecordsResponse<T>>;
+/**
+ * Retrieves records from the given module. Used for paginating across all records.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmGetRecords(context: ZohoCrmContext): ZohoCrmGetRecordsFunction;
+/**
+ * Configuration for searching records.
+ *
+ * Only criteria, email, phone, or word will be used at a single time.
+ */
+export interface ZohoCrmSearchRecordsInput<T = ZohoCrmRecord> extends ZohoCrmModuleNameRef, ZohoCrmGetRecordsPageFilter {
+    readonly criteria?: Maybe<ZohoCrmSearchRecordsCriteriaTreeElement<T>>;
+    readonly cvid?: Maybe<ZohoCrmCustomViewId>;
+    readonly email?: Maybe<EmailAddress>;
+    readonly phone?: Maybe<PhoneNumber>;
+    readonly word?: Maybe<string>;
+}
+export type ZohoCrmSearchRecordsResponse<T = ZohoCrmRecord> = ZohoCrmGetRecordsResponse<T>;
+export type ZohoCrmSearchRecordsFunction = <T = ZohoCrmRecord>(input: ZohoCrmSearchRecordsInput<T>) => Promise<ZohoCrmSearchRecordsResponse<T>>;
+/**
+ * Searches records from the given module.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/search-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmSearchRecords(context: ZohoCrmContext): ZohoCrmSearchRecordsFunction;
+export type ZohoCrmSearchRecordsPageFactory = <T = ZohoCrmRecord>(input: ZohoCrmSearchRecordsInput<T>, options?: Maybe<FetchPageFactoryOptions<ZohoCrmSearchRecordsInput<T>, ZohoCrmSearchRecordsResponse<T>>>) => FetchPage<ZohoCrmSearchRecordsInput<T>, ZohoCrmSearchRecordsResponse<T>>;
+export declare function zohoCrmSearchRecordsPageFactory(context: ZohoCrmContext): ZohoCrmSearchRecordsPageFactory;
+export interface ZohoCrmGetRelatedRecordsFunctionConfig {
+    readonly targetModule: ZohoCrmModuleName;
+    /**
+     * If true, will return an empty page result instead of null when no results are found.
+     *
+     * Defaults to true.
+     */
+    readonly returnEmptyRecordsInsteadOfNull?: boolean;
+}
+export type ZohoCrmGetRelatedRecordsFunctionFactory = <T = ZohoCrmRecord>(input: ZohoCrmGetRelatedRecordsFunctionConfig) => ZohoCrmGetRelatedRecordsFunction<T>;
+export type ZohoCrmGetRelatedRecordsPageFilter = ZohoPageFilter;
+export interface ZohoCrmGetRelatedRecordsRequest extends ZohoCrmGetRecordByIdInput, ZohoCrmGetRelatedRecordsPageFilter {
+    /**
+     * Optional, Use to filter the related records of the primary/target record with said ids.
+     *
+     * For example, providing this value will return the Notes with these ids when searching on related Notes for the primary/target record.
+     */
+    readonly ids?: Maybe<ArrayOrValue<ZohoCrmRecordId>>;
+    /**
+     * @deprecated set variables on request object directly instead of using this filter.
+     */
+    readonly filter?: Maybe<ZohoCrmGetRelatedRecordsPageFilter>;
+}
+/**
+ * A variant of ZohoCrmGetRelatedRecordsRequest that includes a required fields property.
+ */
+export interface ZohoCrmGetRelatedRecordsRequestWithFields extends ZohoCrmGetRelatedRecordsRequest, ZohoCrmGetRecordsFieldsRef {
+}
+export type ZohoCrmGetRelatedRecordsResponse<T = ZohoCrmRecord> = ZohoPageResult<T>;
+export type ZohoCrmGetRelatedRecordsFunction<T = ZohoCrmRecord> = (input: ZohoCrmGetRelatedRecordsRequest) => Promise<ZohoCrmGetRelatedRecordsResponse<T>>;
+/**
+ * Creates a ZohoCrmGetRelatedRecordsFunctionFactory, which can be used to create ZohoCrmGetRelatedRecordsFunction<T> that targets retrieving related records of a given type.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
+ *
+ * @param context the ZohoCrmContext to use
+ * @returns a ZohoCrmGetRelatedRecordsFunctionFactory
+ */
+export declare function zohoCrmGetRelatedRecordsFunctionFactory(context: ZohoCrmContext): ZohoCrmGetRelatedRecordsFunctionFactory;
+/**
+ * Type filter to use when fetching emails for a record.
+ *
+ * https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
+ */
+export type ZohoCrmGetEmailsForRecordTypeFilter = 'sent_from_crm' | 'scheduled_in_crm' | 'drafts' | 'user_emails' | 'all_contacts_sent_crm_emails' | 'all_contacts_scheduled_crm_emails' | 'all_contacts_draft_crm_emails';
+export type ZohoCrmGetEmailsForRecordRequest = ZohoCrmGetRelatedRecordsRequest & {
+    /**
+     * The type of emails to fetch.
+     */
+    readonly type?: Maybe<ZohoCrmGetEmailsForRecordTypeFilter>;
+    /**
+     * The ID of the user whose emails you want to fetch.
+     *
+     * Note that you can use this parameter only with type=user_emails.
+     */
+    readonly owner_id?: Maybe<ZohoCrmRecordId>;
+};
+export type ZohoCrmGetEmailsForRecordResponse = ZohoPageResult<ZohoCrmRecordEmailMetadata>;
+export type ZohoCrmGetEmailsForRecordFunction = (input: ZohoCrmGetEmailsForRecordRequest) => Promise<ZohoCrmGetEmailsForRecordResponse>;
+export type ZohoCrmGetEmailsForRecordRawApiResponse = Omit<ZohoCrmGetEmailsForRecordResponse, 'data'> & {
+    Emails: ZohoCrmGetEmailsForRecordResponse['data'];
+};
+export declare function zohoCrmGetEmailsForRecord(context: ZohoCrmContext): ZohoCrmGetEmailsForRecordFunction;
+export type ZohoCrmGetEmailsForRecordPageFactory = FetchPageFactory<ZohoCrmGetEmailsForRecordRequest, ZohoCrmGetEmailsForRecordResponse>;
+export declare function zohoCrmGetEmailsForRecordPageFactory(context: ZohoCrmContext): ZohoCrmGetEmailsForRecordPageFactory;
+export type ZohoCrmGetAttachmentsForRecordRequest = ZohoCrmGetRelatedRecordsRequest & ZohoCrmGetRecordsFieldsRef;
+export type ZohoCrmGetAttachmentsForRecordResponse = ZohoPageResult<ZohoCrmRecordAttachmentMetadata>;
+export type ZohoCrmGetAttachmentsForRecordFunction = (input: ZohoCrmGetAttachmentsForRecordRequest) => Promise<ZohoCrmGetAttachmentsForRecordResponse>;
+export declare function zohoCrmGetAttachmentsForRecord(context: ZohoCrmContext): ZohoCrmGetAttachmentsForRecordFunction;
+export type ZohoCrmGetAttachmentsForRecordPageFactory = FetchPageFactory<ZohoCrmGetAttachmentsForRecordRequest, ZohoCrmGetAttachmentsForRecordResponse>;
+export declare function zohoCrmGetAttachmentsForRecordPageFactory(context: ZohoCrmContext): ZohoCrmGetAttachmentsForRecordPageFactory;
+/**
+ * Maximum attachment size allowed by Zoho Crm.
+ *
+ * 20MB
+ */
+export declare const ZOHO_CRM_ATTACHMENT_MAX_SIZE: number;
+export interface ZohoCrmUploadAttachmentForRecordRequest extends ZohoCrmGetRecordByIdInput {
+    /**
+     * Requires the use of a FormData object.
+     *
+     * Max of 20MB are allowed
+     *
+     * @deprecated Use attachmentUrl instead for now.
+     */
+    readonly formData?: FormData;
+    /**
+     * File url to pull the file from.
+     *
+     * Either this or formData must be provided.
+     */
+    readonly attachmentUrl?: WebsiteUrlWithPrefix;
+    /**
+     * The category id(s) of the attachment.
+     *
+     * Either this or attachments_category must be provided.
+     */
+    readonly attachmentCategoryId?: ArrayOrValue<ZohoCrmAttachmentCategoryId>;
+    /**
+     * The category name(s) of the attachment.
+     *
+     * Either this or attachments_category_id must be provided.
+     *
+     * Example: "Resume"
+     */
+    readonly attachmentCategoryName?: ArrayOrValue<KnownZohoCrmAttachmentCategoryName>;
+}
+export type ZohoCrmUploadAttachmentForRecordResponse = Response;
+export type ZohoCrmUploadAttachmentForRecordFunction = (input: ZohoCrmUploadAttachmentForRecordRequest) => Promise<ZohoCrmUploadAttachmentForRecordResponse>;
+/**
+ * Uploads an attachment to a record.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/upload-attachment.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmUploadAttachmentForRecord(context: ZohoCrmContext): ZohoCrmUploadAttachmentForRecordFunction;
+export interface ZohoCrmDownloadAttachmentForRecordRequest extends ZohoCrmGetRecordByIdInput {
+    readonly attachment_id: ZohoCrmAttachmentRecordId;
+}
+export type ZohoCrmDownloadAttachmentForRecordResponse = FetchFileResponse;
+export type ZohoCrmDownloadAttachmentForRecordFunction = (input: ZohoCrmDownloadAttachmentForRecordRequest) => Promise<ZohoCrmDownloadAttachmentForRecordResponse>;
+/**
+ * Downloads an attachment from a record.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/download-attachments.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmDownloadAttachmentForRecord(context: ZohoCrmContext): ZohoCrmDownloadAttachmentForRecordFunction;
+export interface ZohoCrmDeleteAttachmentFromRecordRequest extends ZohoCrmGetRecordByIdInput {
+    readonly attachment_id: ZohoCrmAttachmentRecordId;
+}
+export type ZohoCrmDeleteAttachmentFromRecordResponse = Response;
+export type ZohoCrmDeleteAttachmentFromRecordFunction = (input: ZohoCrmDeleteAttachmentFromRecordRequest) => Promise<ZohoCrmDeleteAttachmentFromRecordResponse>;
+/**
+ * Deletes an attachment from a record.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/delete-attachments.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmDeleteAttachmentFromRecord(context: ZohoCrmContext): ZohoCrmDeleteAttachmentFromRecordFunction;
+export type ZohoCrmExecuteRestApiFunctionRequest = ZohoCrmExecuteRestApiFunctionNormalRequest | ZohoCrmExecuteRestApiFunctionApiSpecificRequest;
+export interface ZohoCrmExecuteRestApiFunctionNormalRequest {
+    readonly functionName: ZohoCrmRestFunctionApiName;
+    readonly params?: Maybe<ZohoCrmExecuteRestApiFunctionParams>;
+}
+export interface ZohoCrmExecuteRestApiFunctionApiSpecificRequest extends ZohoCrmExecuteRestApiFunctionNormalRequest {
+    /**
+     * If provided the function will use the API key provided instead of the internal oauth
+     */
+    readonly apiKey: Maybe<ZohoCrmRestFunctionApiKey>;
+    /**
+     * If provided, the function will target the given API and not the default. Only used when apiKey is provided.
+     *
+     * Careful when using this, as it might indicate that the target is not environment specific/aware.
+     */
+    readonly apiUrl?: ZohoCrmConfigApiUrlInput;
+}
+export type ZohoCrmRestFunctionApiKey = string;
+export type ZohoCrmExecuteRestApiFunctionParams = Record<string, string | number | boolean | ZohoDateTimeString>;
+export type ZohoCrmExecuteRestApiFunctionResponse = ZohoCrmExecuteRestApiFunctionSuccessResponse | ZohoCrmExecuteRestApiFunctionErrorResponse;
+export interface ZohoCrmExecuteRestApiFunctionSuccessResponse {
+    readonly code: 'success';
+    readonly details: ZohoCrmExecuteRestApiFunctionSuccessDetails;
+    readonly message: string;
+}
+export interface ZohoCrmExecuteRestApiFunctionSuccessDetails {
+    readonly userMessage: string[];
+    readonly output_type: string;
+    readonly id: ZohoCrmUserId;
+}
+export interface ZohoCrmExecuteRestApiFunctionErrorResponse {
+    readonly code: string;
+    readonly details: unknown;
+    readonly message: string;
+}
+export declare class ZohoCrmExecuteRestApiFunctionError extends BaseError {
+    readonly error: ZohoCrmExecuteRestApiFunctionErrorResponse;
+    constructor(error: ZohoCrmExecuteRestApiFunctionErrorResponse);
+}
+/**
+ * Executes the Zoho Crm function based on the input.
+ *
+ * If the function fails execution a ZohoCrmExecuteRestApiFunctionError will be thrown. Other API errors may still be thrown.
+ */
+export type ZohoCrmExecuteRestApiFunctionFunction = (input: ZohoCrmExecuteRestApiFunctionRequest) => Promise<ZohoCrmExecuteRestApiFunctionSuccessDetails>;
+/**
+ * Creates a ZohoCrmExecuteRestApiFunctionFunction
+ *
+ * OAuth Details:
+ * - https://www.zoho.com/crm/developer/docs/functions/serverless-fn-oauth.html#OAuth2
+ * - There is no documentation for ZohoCrm specifically, but it seems to behave the same way
+ * - You will need the following scopes: ZohoCrm.functions.execute.READ,ZohoCrm.functions.execute.CREATE
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmExecuteRestApiFunction(context: ZohoCrmContext): ZohoCrmExecuteRestApiFunctionFunction;
+export declare function zohoCrmUrlSearchParamsMinusModule(...input: Maybe<object | Record<string, string | number>>[]): URLSearchParams;
+export declare function zohoCrmUrlSearchParamsMinusIdAndModule(...input: Maybe<object | Record<string, string | number>>[]): URLSearchParams;
+/**
+ * @deprecated use makeUrlSearchParams instead.
+ */
+export declare const zohoCrmUrlSearchParams: typeof makeUrlSearchParams;
+export declare function zohoCrmApiFetchJsonInput(method: string, body?: Maybe<FetchJsonBody>): FetchJsonInput;
+/**
+ * Catches ZohoServerFetchResponseDataArrayError and returns the error data array as the response data, as each data element will have the error details.
+ *
+ * Use to catch errors from functions that return ZohoCrmChangeObjectLikeResponse and pass the result to zohoCrmChangeObjectLikeResponseSuccessAndErrorPairs.
+ */
+export declare function zohoCrmCatchZohoCrmChangeObjectLikeResponseError<R extends ZohoCrmChangeObjectLikeResponse<any>>(e: unknown): R;
+export type ZohoCrmChangeObjectLikeResponse<T extends ZohoCrmChangeObjectLikeResponseEntry = ZohoCrmChangeObjectLikeResponseEntry> = ZohoDataArrayResultRef<T>;
+export type ZohoCrmChangeObjectLikeResponseEntry<E extends ZohoCrmChangeObjectLikeResponseSuccessEntryMeta = ZohoCrmChangeObjectLikeResponseSuccessEntryMeta> = E | ZohoCrmChangeObjectResponseErrorEntry;
+export type ZohoCrmChangeObjectLikeResponseSuccessEntryType<T extends ZohoCrmChangeObjectLikeResponseEntry> = T extends ZohoCrmChangeObjectLikeResponseEntry<infer E> ? E : never;
+export interface ZohoCrmChangeObjectLikeResponseSuccessEntryMeta {
+    readonly code: ZohoServerSuccessCode;
+    readonly status: ZohoServerSuccessStatus;
+    readonly message: string;
+}
+export type ZohoCrmChangeObjectLikeResponseSuccessAndErrorPairs<T extends ZohoCrmChangeObjectLikeResponseEntry> = ZohoCrmChangeObjectLikeResponse<T> & {
+    readonly successItems: ZohoCrmChangeObjectLikeResponseSuccessEntryType<T>[];
+    readonly errorItems: ZohoCrmChangeObjectResponseErrorEntry[];
+};
+export declare function zohoCrmChangeObjectLikeResponseSuccessAndErrorPairs<T extends ZohoCrmChangeObjectLikeResponseEntry>(response: ZohoCrmChangeObjectLikeResponse<T>): ZohoCrmChangeObjectLikeResponseSuccessAndErrorPairs<T>;
+export type ZohoCrmChangeObjectResponse<T extends ZohoCrmChangeObjectResponseEntry = ZohoCrmChangeObjectResponseEntry> = ZohoCrmChangeObjectLikeResponse<T>;
+export type ZohoCrmChangeObjectResponseEntry<E extends ZohoCrmChangeObjectResponseSuccessEntry = ZohoCrmChangeObjectResponseSuccessEntry> = ZohoCrmChangeObjectLikeResponseEntry<E>;
+export interface ZohoCrmChangeObjectResponseSuccessEntry<D extends ZohoCrmChangeObjectDetails = ZohoCrmChangeObjectDetails> extends ZohoCrmChangeObjectLikeResponseSuccessEntryMeta {
+    readonly details: D;
+}
+export interface ZohoCrmChangeObjectResponseErrorEntry extends ZohoServerErrorDataWithDetails {
+    readonly status: ZohoServerErrorStatus;
+}
+export interface ZohoCrmMultiRecordResult<I, OS, OE> {
+    readonly successItems: ZohoCrmMultiRecordResultEntry<I, OS>[];
+    readonly errorItems: ZohoCrmMultiRecordResultEntry<I, OE>[];
+}
+export interface ZohoCrmMultiRecordResultItem {
+    readonly status: ZohoServerSuccessStatus | ZohoServerErrorStatus;
+}
+export declare function zohoCrmMultiRecordResult<I, OS extends ZohoCrmMultiRecordResultItem, OE extends ZohoCrmMultiRecordResultItem>(input: I[], results: (OS | OE)[]): ZohoCrmMultiRecordResult<I, OS, OE>;
+export interface ZohoCrmMultiRecordResultEntry<I, O> {
+    /**
+     * Input record/data.
+     */
+    readonly input: I;
+    /**
+     * The result of the insert.
+     */
+    readonly result: O;
+}
+/**
+ * @deprecated use ZohoCrmGetRelatedRecordsPageFilter instead.
+ */
+export type ZohoCrmGetNotesPageFilter = ZohoCrmGetRelatedRecordsPageFilter;