@dereekb/zoho 12.6.21 → 13.0.0

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

@@ -0,0 +1,40 @@
+import { type ZohoPageResult } from '../zoho.api.page';
+import { type FetchPageFactory } from '@dereekb/util/fetch';
+import { type ZohoCrmContext } from './crm.config';
+import { type ZohoCrmModuleNameRef, type ZohoCrmRecordId } from './crm';
+import { type ArrayOrValue } from '@dereekb/util';
+import { type ZohoCrmMultiRecordResult, type ZohoCrmChangeObjectResponseSuccessEntry, type ZohoCrmChangeObjectResponseErrorEntry, type ZohoCrmChangeObjectResponse, type ZohoCrmGetRelatedRecordsRequestWithFields } from './crm.api';
+import { type NewZohoCrmNoteData, type ZohoCrmNoteId, type ZohoCrmRecordNote } from './crm.notes';
+export interface ZohoCrmCreateNotesRequest {
+    readonly data: ZohoCrmCreateNotesRequestEntry[];
+}
+export type ZohoCrmCreateNotesResult = ZohoCrmMultiRecordResult<ZohoCrmCreateNotesRequestEntry, ZohoCrmChangeObjectResponseSuccessEntry, ZohoCrmChangeObjectResponseErrorEntry>;
+export type ZohoCrmCreateNotesRequestEntry = NewZohoCrmNoteData;
+export type ZohoCrmCreateNotesResponse = ZohoCrmChangeObjectResponse;
+export type ZohoCrmCreateNotesFunction = (input: ZohoCrmCreateNotesRequest) => Promise<ZohoCrmCreateNotesResult>;
+export declare function zohoCrmCreateNotes(context: ZohoCrmContext): (input: ZohoCrmCreateNotesRequest) => Promise<ZohoCrmMultiRecordResult<NewZohoCrmNoteData, ZohoCrmChangeObjectResponseSuccessEntry<import("./crm").ZohoCrmChangeObjectDetails>, ZohoCrmChangeObjectResponseErrorEntry>>;
+export interface ZohoCrmDeleteNotesRequest {
+    readonly ids: ArrayOrValue<ZohoCrmNoteId>;
+}
+export type ZohoCrmDeleteNotesResult = ZohoCrmMultiRecordResult<ZohoCrmNoteId, ZohoCrmChangeObjectResponseSuccessEntry, ZohoCrmChangeObjectResponseErrorEntry>;
+export type ZohoCrmDeleteNotesResponse = ZohoCrmChangeObjectResponse;
+export type ZohoCrmDeleteNotesFunction = (input: ZohoCrmDeleteNotesRequest) => Promise<ZohoCrmDeleteNotesResult>;
+export declare function zohoCrmDeleteNotes(context: ZohoCrmContext): (input: ZohoCrmDeleteNotesRequest) => Promise<ZohoCrmMultiRecordResult<string, ZohoCrmChangeObjectResponseSuccessEntry<import("./crm").ZohoCrmChangeObjectDetails>, ZohoCrmChangeObjectResponseErrorEntry>>;
+export type ZohoCrmGetNotesForRecordRequest = ZohoCrmGetRelatedRecordsRequestWithFields;
+export type ZohoCrmGetNotesForRecordResponse = ZohoPageResult<ZohoCrmRecordNote>;
+export type ZohoCrmGetNotesForRecordFunction = (input: ZohoCrmGetNotesForRecordRequest) => Promise<ZohoCrmGetNotesForRecordResponse>;
+export declare function zohoCrmGetNotesForRecord(context: ZohoCrmContext): ZohoCrmGetNotesForRecordFunction;
+export type ZohoCrmGetNotesForRecordPageFactory = FetchPageFactory<ZohoCrmGetNotesForRecordRequest, ZohoCrmGetNotesForRecordResponse>;
+export declare function zohoCrmGetNotesForRecordPageFactory(context: ZohoCrmContext): ZohoCrmGetNotesForRecordPageFactory;
+export interface ZohoCrmCreateNotesForRecordRequest extends ZohoCrmModuleNameRef {
+    readonly id: ZohoCrmRecordId;
+    readonly notes: ArrayOrValue<Omit<NewZohoCrmNoteData, 'se_module' | 'Parent_Id'>>;
+}
+export type ZohoCrmCreateNotesForRecordFunction = (input: ZohoCrmCreateNotesForRecordRequest) => Promise<ZohoCrmCreateNotesResult>;
+/**
+ * https://www.zoho.com/crm/developer/docs/api/v8/create-notes.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmCreateNotesForRecord(context: ZohoCrmContext): ZohoCrmCreateNotesForRecordFunction;

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

@@ -0,0 +1,160 @@
+import { type ZohoCrmContext } from './crm.config';
+import { type ArrayOrValue, type Maybe } from '@dereekb/util';
+import { type ZohoCrmModuleNameRef, type ZohoCrmRecordId } from './crm';
+import { type ZohoCrmChangeObjectLikeResponse, type ZohoCrmChangeObjectLikeResponseSuccessEntryMeta, type ZohoCrmChangeObjectResponse, type ZohoCrmChangeObjectResponseErrorEntry, type ZohoCrmChangeObjectResponseSuccessEntry, type ZohoCrmGetRecordsPageFilter, type ZohoCrmMultiRecordResult, type ZohoCrmMultiRecordResultEntry } from './crm.api';
+import { type ZohoCrmTagId, type ZohoCrmTagData, type ZohoCrmTagName, type ZohoCrmTagWithObjectDetails } from './crm.tags';
+import { type FetchPage, type FetchPageFactoryOptions } from '@dereekb/util/fetch';
+import { type ZohoPageResult } from '../zoho.api.page';
+export type ZohoCrmCreateTagData = Pick<ZohoCrmTagData, 'name'> & Partial<Pick<ZohoCrmTagData, 'color_code'>>;
+export interface ZohoCrmCreateTagsRequest extends ZohoCrmModuleNameRef {
+    readonly tags: ArrayOrValue<ZohoCrmCreateTagData>;
+}
+export interface ZohoCrmCreateTagsResponse {
+    readonly tags: ZohoCrmChangeObjectResponse['data'];
+}
+export type ZohoCrmCreateTagsResult = ZohoCrmMultiRecordResult<ZohoCrmCreateTagData, ZohoCrmChangeObjectResponseSuccessEntry, ZohoCrmChangeObjectResponseErrorEntry> & {
+    readonly duplicateErrorItems: ZohoCrmMultiRecordResultEntry<ZohoCrmCreateTagData, ZohoCrmChangeObjectResponseErrorEntry>[];
+    readonly allErrorItems: ZohoCrmMultiRecordResultEntry<ZohoCrmCreateTagData, ZohoCrmChangeObjectResponseErrorEntry>[];
+};
+export type ZohoCrmCreateTagsFunction = (input: ZohoCrmCreateTagsRequest) => Promise<ZohoCrmCreateTagsResult>;
+export declare function zohoCrmCreateTagsForModule(context: ZohoCrmContext): (input: ZohoCrmCreateTagsRequest) => Promise<{
+    errorItems: ZohoCrmMultiRecordResultEntry<ZohoCrmCreateTagData, ZohoCrmChangeObjectResponseErrorEntry>[];
+    duplicateErrorItems: ZohoCrmMultiRecordResultEntry<ZohoCrmCreateTagData, ZohoCrmChangeObjectResponseErrorEntry>[];
+    allErrorItems: ZohoCrmMultiRecordResultEntry<ZohoCrmCreateTagData, ZohoCrmChangeObjectResponseErrorEntry>[];
+    successItems: ZohoCrmMultiRecordResultEntry<ZohoCrmCreateTagData, ZohoCrmChangeObjectResponseSuccessEntry<import("./crm").ZohoCrmChangeObjectDetails>>[];
+}>;
+export interface ZohoCrmDeleteTagRequest {
+    readonly id: ZohoCrmTagId;
+}
+export interface ZohoCrmDeleteTagResponseSuccessEntry extends ZohoCrmChangeObjectLikeResponseSuccessEntryMeta {
+    readonly details: {
+        readonly id: ZohoCrmTagId;
+    };
+}
+export interface ZohoCrmDeleteTagResponse {
+    readonly tags: ZohoCrmDeleteTagResponseSuccessEntry;
+}
+export type ZohoCrmDeleteTagResult = ZohoCrmDeleteTagResponseSuccessEntry;
+export type ZohoCrmDeleteTagFunction = (input: ZohoCrmDeleteTagRequest) => Promise<ZohoCrmDeleteTagResult>;
+/**
+ * Deletes a single tag by ID.
+ *
+ * Note: A tag cannot be deleted if it is associated with any configuration (e.g. Workflow Rules).
+ *
+ * https://www.zoho.com/crm/developer/docs/api/v8/delete-tag.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmDeleteTag(context: ZohoCrmContext): ZohoCrmDeleteTagFunction;
+export interface ZohoCrmGetTagsRequest extends ZohoCrmModuleNameRef, ZohoCrmGetRecordsPageFilter {
+    readonly my_tags?: string;
+}
+export interface ZohoCrmGetTagsResponse extends Omit<ZohoPageResult<ZohoCrmTagWithObjectDetails>, 'data'> {
+    readonly tags: ZohoCrmTagWithObjectDetails[];
+}
+export type ZohoCrmGetTagsResult = ZohoPageResult<ZohoCrmTagWithObjectDetails>;
+export type ZohoCrmGetTagsFunction = (input: ZohoCrmGetTagsRequest) => Promise<ZohoCrmGetTagsResult>;
+/**
+ * Returns the list of tags within a module.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/get-tag-list.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmGetTagsForModule(context: ZohoCrmContext): ZohoCrmGetTagsFunction;
+export type ZohoCrmGetTagsForModulePageFactory = (input: ZohoCrmGetTagsRequest, options?: Maybe<FetchPageFactoryOptions<ZohoCrmGetTagsRequest, ZohoCrmGetTagsResult>>) => FetchPage<ZohoCrmGetTagsRequest, ZohoCrmGetTagsResult>;
+export declare function zohoCrmGetTagsForModulePageFactory(context: ZohoCrmContext): ZohoCrmGetTagsForModulePageFactory;
+/**
+ * Limit enforced by Zoho Crm
+ */
+export declare const ZOHO_CRM_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED = 100;
+export interface ZohoCrmAddTagsToRecordsRequest extends ZohoCrmModuleNameRef {
+    /**
+     * Tag names to add to the records.
+     */
+    readonly tag_names?: Maybe<ArrayOrValue<ZohoCrmTagName>>;
+    /**
+     * Specific tags to add to the records.
+     */
+    readonly tags?: Maybe<ArrayOrValue<ZohoCrmTagData & {
+        id?: Maybe<ZohoCrmTagId>;
+    }>>;
+    /**
+     * Specify if the existing tags are to be overwritten.
+     */
+    readonly over_write?: Maybe<boolean>;
+    /**
+     * Ids corresponding to the records in the module to add the tags to.
+     *
+     * Max of 100 ids.
+     */
+    readonly ids: ArrayOrValue<ZohoCrmRecordId>;
+}
+export interface ZohoCrmAddTagsToRecordsResultDetails {
+    /**
+     * Record id that was updated
+     */
+    readonly id: ZohoCrmRecordId;
+    /**
+     * Tag names that were added to the record
+     */
+    readonly tags: ZohoCrmTagName[];
+}
+export interface ZohoCrmAddTagsToRecordsSuccessEntry extends ZohoCrmChangeObjectLikeResponseSuccessEntryMeta {
+    readonly details: ZohoCrmAddTagsToRecordsResultDetails;
+}
+export type ZohoCrmAddTagsToRecordsResponse = ZohoCrmChangeObjectLikeResponse<ZohoCrmAddTagsToRecordsSuccessEntry>;
+/**
+ * Contains all the details of the error.
+ */
+export type ZohoCrmAddTagsToRecordsErrorEntryDetails = ZohoCrmAddTagsToRecordsResultDetails;
+export type ZohoCrmAddTagsToRecordsErrorEntry = ZohoCrmChangeObjectResponseErrorEntry & {
+    readonly details: ZohoCrmAddTagsToRecordsErrorEntryDetails;
+};
+export type ZohoCrmAddTagsToRecordsResult = ZohoCrmMultiRecordResult<ZohoCrmAddTagsToRecordsRequest, ZohoCrmAddTagsToRecordsSuccessEntry, ZohoCrmAddTagsToRecordsErrorEntry>;
+export type ZohoCrmAddTagsToRecordsFunction = (input: ZohoCrmAddTagsToRecordsRequest) => Promise<ZohoCrmAddTagsToRecordsResult>;
+/**
+ * Adds one or more tags to one or more records.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/add-tags.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmAddTagsToRecords(context: ZohoCrmContext): ZohoCrmAddTagsToRecordsFunction;
+export declare function zohoCrmAddTagsToRecordsRequestBody(input: ZohoCrmAddTagsToRecordsRequest): {
+    tags: (ZohoCrmTagData & {
+        id?: Maybe<ZohoCrmTagId>;
+    })[];
+    ids: string[];
+};
+/**
+ * Limit enforced by Zoho Crm
+ */
+export declare const ZOHO_CRM_REMOVE_TAGS_FROM_RECORDS_MAX_IDS_ALLOWED = 100;
+export type ZohoCrmRemoveTagsFromRecordsRequest = ZohoCrmAddTagsToRecordsRequest;
+export type ZohoCrmRemoveTagsFromRecordsResultDetails = ZohoCrmAddTagsToRecordsResultDetails;
+export interface ZohoCrmRemoveTagsFromRecordsSuccessEntry extends ZohoCrmChangeObjectLikeResponseSuccessEntryMeta {
+    readonly details: ZohoCrmRemoveTagsFromRecordsResultDetails;
+}
+export type ZohoCrmRemoveTagsFromRecordsResponse = ZohoCrmChangeObjectLikeResponse<ZohoCrmRemoveTagsFromRecordsSuccessEntry>;
+/**
+ * Contains all the details of the error.
+ */
+export type ZohoCrmRemoveTagsFromRecordsErrorEntryDetails = ZohoCrmRemoveTagsFromRecordsResultDetails;
+export type ZohoCrmRemoveTagsFromRecordsErrorEntry = ZohoCrmChangeObjectResponseErrorEntry & {
+    readonly details: ZohoCrmRemoveTagsFromRecordsErrorEntryDetails;
+};
+export type ZohoCrmRemoveTagsFromRecordsResult = ZohoCrmMultiRecordResult<ZohoCrmRemoveTagsFromRecordsRequest, ZohoCrmRemoveTagsFromRecordsSuccessEntry, ZohoCrmRemoveTagsFromRecordsErrorEntry>;
+export type ZohoCrmRemoveTagsFromRecordsFunction = (input: ZohoCrmRemoveTagsFromRecordsRequest) => Promise<ZohoCrmRemoveTagsFromRecordsResult>;
+/**
+ * Removes one or more tags from one or more records.
+ *
+ * https://www.zoho.com/crm/developer-guide/apiv2/remove-tags.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function zohoCrmRemoveTagsFromRecords(context: ZohoCrmContext): ZohoCrmRemoveTagsFromRecordsFunction;

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

@@ -0,0 +1,24 @@
+import { type FactoryWithRequiredInput } from '@dereekb/util';
+import { type ConfiguredFetch, type FetchJsonFunction } from '@dereekb/util/fetch';
+import { type ZohoApiUrl, type ZohoApiUrlKey, type ZohoConfig, type ZohoApiServiceName } from '../zoho.config';
+import { type ZohoAccessTokenStringFactory, type ZohoServiceAccessTokenKey } from '../accounts';
+import { type ZohoRateLimiterRef } from '../zoho.limit';
+export declare const ZOHO_CRM_SERVICE_NAME: ZohoApiServiceName | ZohoServiceAccessTokenKey;
+export type ZohoCrmApiUrl = ZohoApiUrl;
+export type ZohoCrmApiUrlKey = ZohoApiUrlKey;
+export type ZohoCrmConfigApiUrlInput = ZohoCrmApiUrlKey | ZohoCrmApiUrl;
+export declare function zohoCrmConfigApiUrl(input: ZohoCrmConfigApiUrlInput): ZohoApiUrl;
+export type ZohoCrmConfig = ZohoConfig;
+export interface ZohoCrmFetchFactoryInput {
+    readonly apiUrl: ZohoCrmApiUrl;
+}
+export type ZohoCrmFetchFactory = FactoryWithRequiredInput<ConfiguredFetch, ZohoCrmFetchFactoryInput>;
+export interface ZohoCrmContext extends ZohoRateLimiterRef {
+    readonly fetch: ConfiguredFetch;
+    readonly fetchJson: FetchJsonFunction;
+    readonly accessTokenStringFactory: ZohoAccessTokenStringFactory;
+    readonly config: ZohoCrmConfig;
+}
+export interface ZohoCrmContextRef {
+    readonly crmContext: ZohoCrmContext;
+}

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

@@ -0,0 +1,19 @@
+import { type ZohoSearchRecordsCriteriaString, type ZohoSearchRecordsCriteriaTree, type ZohoSearchRecordsCriteriaFilterType, type ZohoSearchRecordsCriteriaEntry, zohoSearchRecordsCriteriaString, zohoSearchRecordsCriteriaStringForTree, zohoSearchRecordsCriteriaEntryToCriteriaString } from '../shared/criteria';
+/**
+ * Can search up to 10 criteria at a time.
+ *
+ * https://www.zoho.com/crm/developer/docs/api/v8/search-records.html
+ *
+ * "You can search for a maximum of 10 criteria (with the same or different column) with equals and starts_with conditions."
+ */
+export declare const MAX_ZOHO_CRM_SEARCH_MODULE_RECORDS_CRITERIA = 10;
+export type ZohoCrmSearchRecordsCriteriaString = ZohoSearchRecordsCriteriaString;
+export declare const zohoCrmSearchRecordsCriteriaString: typeof zohoSearchRecordsCriteriaString;
+export declare const zohoCrmSearchRecordsCriteriaStringForTree: typeof zohoSearchRecordsCriteriaStringForTree;
+export type ZohoCrmSearchRecordsCriteriaTree<T = any> = ZohoSearchRecordsCriteriaTree<T>;
+export type ZohoCrmSearchRecordsCriteriaTreeElement<T = any> = ZohoCrmSearchRecordsCriteriaEntryArray<T> | ZohoCrmSearchRecordsCriteriaTree<T> | ZohoCrmSearchRecordsCriteriaString;
+export type ZohoCrmSearchRecordsCriteriaFilterType = ZohoSearchRecordsCriteriaFilterType;
+export type ZohoCrmSearchRecordsCriteriaEntryArray<T = any> = ZohoCrmSearchRecordsCriteriaEntry<T>[];
+export type ZohoCrmSearchRecordsCriteriaEntry<T = any> = ZohoSearchRecordsCriteriaEntry<T>;
+export declare const escapeZohoCrmFieldValueForCriteriaString: import("@dereekb/util").EscapeStringCharactersFunction;
+export declare const zohoCrmSearchRecordsCriteriaEntryToCriteriaString: typeof zohoSearchRecordsCriteriaEntryToCriteriaString;

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

@@ -0,0 +1,325 @@
+import { type CommaSeparatedString, type EmailAddress, type ISO8601DateString, type UniqueModelWithId, type WebsiteUrl } from '@dereekb/util';
+/**
+ * Zoho CRM module name.
+ *
+ * Example "Leads"
+ */
+export type ZohoCrmModuleName = string;
+/**
+ * Leads module name
+ */
+export declare const ZOHO_CRM_LEADS_MODULE = "Leads";
+/**
+ * Contacts module name
+ */
+export declare const ZOHO_CRM_CONTACTS_MODULE = "Contacts";
+/**
+ * Tasks module name
+ */
+export declare const ZOHO_CRM_TASKS_MODULE = "Tasks";
+/**
+ * Notes module name
+ */
+export declare const ZOHO_CRM_NOTES_MODULE = "Notes";
+/**
+ * Emails module name
+ */
+export declare const ZOHO_CRM_EMAILS_MODULE = "Emails";
+/**
+ * Attachments module name
+ */
+export declare const ZOHO_CRM_ATTACHMENTS_MODULE = "Attachments";
+/**
+ * Contains a reference to a module.
+ */
+export interface ZohoCrmModuleNameRef {
+    readonly module: ZohoCrmModuleName;
+}
+/**
+ * The API name of a function that is accessible via the Crm REST API
+ */
+export type ZohoCrmRestFunctionApiName = string;
+/**
+ * An identifier in Zoho Crm.
+ */
+export type ZohoCrmId = string;
+/**
+ * Identifier of a Lead record in Zoho CRM.
+ */
+export type ZohoCrmLeadId = string;
+/**
+ * Identifier of an Account record in Zoho CRM.
+ */
+export type ZohoCrmAccountId = string;
+/**
+ * Identifier of a Contact record in Zoho CRM.
+ */
+export type ZohoCrmContactId = string;
+/**
+ * Identifier of a Deal record in Zoho CRM.
+ */
+export type ZohoCrmDealId = string;
+/**
+ * Identifier of a Campaign record in Zoho CRM.
+ */
+export type ZohoCrmCampaignId = string;
+/**
+ * Identifier of a Task record in Zoho CRM.
+ */
+export type ZohoCrmTaskId = string;
+/**
+ * Identifier of a Case record in Zoho CRM.
+ */
+export type ZohoCrmCaseId = string;
+/**
+ * Zoho Crm record id
+ *
+ * Example "576214000000569001"
+ */
+export type ZohoCrmRecordId = string;
+/**
+ * Zoho Crm type id
+ *
+ * Example "576214000000820595"
+ */
+export type ZohoCrmTypeId = string;
+/**
+ * Zoho Crm user identifier.
+ *
+ * Users can be found in the Users and Controls section in settings.
+ */
+export type ZohoCrmUserId = string;
+/**
+ * Zoho Crm custom view id
+ */
+export type ZohoCrmCustomViewId = string;
+/**
+ * Zoho Crm territory id
+ */
+export type ZohoCrmTerritoryId = string;
+/**
+ * The name of a field on a record.
+ */
+export type ZohoCrmFieldName = string;
+/**
+ * Comma separated list of field names
+ */
+export type ZohoCrmCommaSeparateFieldNames = CommaSeparatedString;
+export type ZohoCrmDraftOrSaveState = 'draft' | 'save';
+export type ZohoCrmTrueFalseBoth = 'true' | 'false' | 'both';
+export interface ZohoCrmReferenceData {
+    name: string;
+    id: ZohoCrmId;
+}
+/**
+ * Reference pair of a Zoho Crm user name and id
+ */
+export interface ZohoCrmUserReferenceData {
+    name: string;
+    id: ZohoCrmUserId;
+}
+export interface ZohoCrmReferenceDataWithModule extends ZohoCrmReferenceData, ZohoCrmModuleNameRef {
+}
+export type ZohoCrmCreatedByData = ZohoCrmUserReferenceData;
+export type ZohoCrmRecordOwner = ZohoCrmUserReferenceData;
+export interface ZohoCrmModifiedByData extends ZohoCrmReferenceData {
+    zuid: ZohoCrmId;
+}
+export type ZohoCrmParentReferenceData = ZohoCrmReferenceDataWithModule;
+/**
+ * Zoho Crm only allows URLs that can be resolved via the internet (I.E. uses a normal tdl)
+ *
+ * The following are considered invalid:
+ * - localhost:8080
+ * - ht://dereekb.com
+ */
+export type ZohoCrmValidUrl = WebsiteUrl;
+/**
+ * Update details returned by the server for a created/updated object.
+ */
+export interface ZohoCrmChangeObjectDetails {
+    id: ZohoCrmRecordId;
+    Modified_Time: ISO8601DateString;
+    Modified_By: ZohoCrmCreatedByData;
+    Created_Time: ISO8601DateString;
+    Created_By: ZohoCrmCreatedByData;
+}
+/**
+ * Base Zoho Crm field data type.
+ */
+export interface ZohoCrmRecordFieldsData {
+}
+export interface ZohoCrmRecordDraftStateData {
+    /**
+     * Used to update a draft record or to convert a draft to a normal record.
+     *
+     * When creating, passing "draft" will create the record as a draft.
+     */
+    $state?: ZohoCrmDraftOrSaveState;
+}
+export type NewZohoCrmRecordData<T = ZohoCrmRecordFieldsData> = T & ZohoCrmRecordDraftStateData;
+/**
+ * A ZohoCrm record containing the corresponding record's id.
+ */
+export type UpdateZohoCrmRecordData = UniqueModelWithId & ZohoCrmRecordFieldsData & ZohoCrmRecordDraftStateData;
+/**
+ * A ZohoCrm record containing record details.
+ */
+export type ZohoCrmRecord = UniqueModelWithId & ZohoCrmRecordFieldsData;
+/**
+ * Returns true if it is a valid ZohoCrmValidUrl.
+ */
+export declare const isZohoCrmValidUrl: (input: WebsiteUrl) => input is ZohoCrmValidUrl;
+/**
+ * The status of a record.
+ */
+export type ZohoCrmRecordStatus = string;
+/**
+ * Metadata for a record's email.
+ */
+export interface ZohoCrmRecordEmailMetadata {
+    /**
+     * Whether or not an attachment is present.
+     */
+    attachment: boolean;
+    /**
+     * The subject of the email.
+     */
+    subject: string;
+    /**
+     * The email address the email was sent to.
+     */
+    to: EmailAddress;
+    /**
+     * The email address the email was sent from.
+     */
+    from: EmailAddress;
+    /**
+     * The date the email was sent.
+     */
+    sent_on: ISO8601DateString;
+    /**
+     * The status of the email.
+     */
+    status: ZohoCrmRecordEmailMetadataStatus[];
+}
+export type ZohoCrmRecordEmailMetadataStatusType = 'sent' | string;
+export interface ZohoCrmRecordEmailMetadataStatus {
+    type: ZohoCrmRecordEmailMetadataStatusType;
+}
+export declare const ZOHO_CRM_RECORD_ATTACHMENT_METADATA_ATTACH_TYPE_RESUME = "Resume";
+export interface ZohoCrmRecordAttachmentMetadataAttachType extends ZohoCrmReferenceData {
+    name: typeof ZOHO_CRM_RECORD_ATTACHMENT_METADATA_ATTACH_TYPE_RESUME | string;
+}
+/**
+ * Record id for an attachment.
+ */
+export type ZohoCrmAttachmentRecordId = ZohoCrmRecordId;
+/**
+ * The size of the attachment in bytes, stored as a string.
+ */
+export type ZohoCrmRecordAttachmentMetadataSize = string;
+/**
+ * Attachment category id
+ */
+export type ZohoCrmAttachmentCategoryId = string;
+/**
+ * Known attachment category names
+ */
+export type KnownZohoCrmAttachmentCategoryName = 'Resume' | 'Offer' | 'Contracts' | 'Criminal records' | 'Mandatory reporter' | 'Teaching certification' | 'Health records' | 'Others' | 'Cover Letter' | 'Formatted Resume';
+/**
+ * Attachment category name
+ *
+ * I.E. "Resume"
+ */
+export type ZohoCrmAttachmentCategoryName = KnownZohoCrmAttachmentCategoryName | string;
+/**
+ * The type of attachment.
+ *
+ * "Attachment" - Download the attachment to retrieve the value.
+ * "Link URL" - Use the Attachment_URL property to retrieve the value.
+ */
+export type ZohoCrmAttachmentType = 'Attachment' | 'Link URL';
+/**
+ * Metadata for a record's attachment.
+ */
+export interface ZohoCrmRecordAttachmentMetadata {
+    /**
+     * The type of attachment
+     */
+    $attach_type: ZohoCrmRecordAttachmentMetadataAttachType;
+    /**
+     * Last time the attachment was modified
+     */
+    Modified_Time: ISO8601DateString;
+    /**
+     * The category of the attachment
+     */
+    Category: ZohoCrmRecordAttachmentMetadataAttachType;
+    /**
+     * The name of the attachment
+     */
+    File_Name: string;
+    /**
+     * The size of the attachment in bytes, stored as a string.
+     */
+    Size: ZohoCrmRecordAttachmentMetadataSize;
+    /**
+     * The time the attachment was created
+     */
+    Created_Time: ISO8601DateString;
+    /**
+     * The parent record id for this attachment
+     */
+    Parent_Id: ZohoCrmRecordId;
+    /**
+     * Owner of the attachment
+     */
+    Attachment_Owner: ZohoCrmUserReferenceData;
+    /**
+     * Internal file identifier for the attachment
+     */
+    $file_id: string;
+    /**
+     * Type of attachment, and how to retrieve the value.
+     */
+    $type: ZohoCrmAttachmentType;
+    /**
+     * Direct URL to the attachment, when available
+     */
+    Attachment_URL: string | null;
+    /**
+     * User who last modified this attachment
+     */
+    Modified_By: ZohoCrmUserReferenceData;
+    /**
+     * Attachment record id
+     */
+    id: ZohoCrmAttachmentRecordId;
+    /**
+     * User who created this attachment
+     */
+    Created_By: ZohoCrmUserReferenceData;
+    /**
+     * Whether the attachment is editable
+     */
+    $editable: boolean;
+    /**
+     * Module this attachment belongs to (e.g., Leads)
+     */
+    $se_module: ZohoCrmModuleName;
+    /**
+     * Link URL when the attachment is a link
+     */
+    $link_url?: string | null;
+    /**
+     * Number of linked documents
+     */
+    $link_docs: number;
+}
+/**
+ * Update details returned by the server for an updated record.
+ *
+ * @deprecated use ZohoCrmChangeObjectDetails instead.
+ */
+export type ZohoCrmRecordUpdateDetails = ZohoCrmChangeObjectDetails;

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

@@ -0,0 +1,52 @@
+import { type FetchResponseError } from '@dereekb/util/fetch';
+import { BaseError } from 'make-error';
+import { type ZohoServerErrorDataWithDetails, type ZohoServerErrorResponseData, ZohoServerError, type ParsedZohoServerError, type ZohoServerErrorResponseDataArrayRef } from '../zoho.error.api';
+import { type ZohoCrmModuleName, type ZohoCrmRecordId } from './crm';
+import { type ZohoDataArrayResultRef } from '../zoho.api.page';
+/**
+ * Error code for when two records are already associated with each other.
+ *
+ * Example being a candidate and a job opening are already associated.
+ */
+export declare const ZOHO_CRM_ALREADY_ASSOCIATED_ERROR_CODE = "ALREADY_ASSOCIATED";
+/**
+ * Thrown when a record with the given id has no content. Typically also means it does not exist.
+ */
+export declare class ZohoCrmRecordNoContentError extends BaseError {
+    readonly moduleName?: ZohoCrmModuleName | undefined;
+    readonly recordId?: ZohoCrmRecordId | undefined;
+    constructor(moduleName?: ZohoCrmModuleName | undefined, recordId?: ZohoCrmRecordId | undefined);
+}
+export declare class ZohoCrmRecordCrudError extends ZohoServerError<ZohoServerErrorDataWithDetails> {
+}
+export declare class ZohoCrmRecordCrudMandatoryFieldNotFoundError extends ZohoCrmRecordCrudError {
+}
+export declare class ZohoCrmRecordCrudDuplicateDataError extends ZohoCrmRecordCrudError {
+}
+export type ZohoCrmRecordCrudInvalidDataErrorDetails = Record<string, string>;
+export interface ZohoCrmRecordCrudInvalidFieldDetails {
+    /**
+     * The api name for this field
+     *
+     * Example: 'id'
+     */
+    readonly api_name: string;
+    /**
+     * The json path for this field from the root data.
+     *
+     * Example: `$.data[0].id`
+     */
+    readonly json_path: string;
+}
+export declare class ZohoCrmRecordCrudInvalidDataError extends ZohoCrmRecordCrudError {
+    get invalidFieldDetails(): ZohoCrmRecordCrudInvalidFieldDetails;
+}
+export declare class ZohoCrmRecordCrudNoMatchingRecordError extends ZohoCrmRecordCrudInvalidDataError {
+}
+export declare function zohoCrmRecordCrudError(error: ZohoServerErrorDataWithDetails): ZohoCrmRecordCrudError;
+export declare function assertZohoCrmRecordDataArrayResultHasContent<T>(moduleName?: ZohoCrmModuleName, recordId?: ZohoCrmRecordId): <R extends ZohoDataArrayResultRef<T>>(x: R) => R;
+export declare const logZohoCrmErrorToConsole: import("..").LogZohoServerErrorFunction;
+export declare function parseZohoCrmError(responseError: FetchResponseError): Promise<ParsedZohoServerError>;
+export declare function parseZohoCrmServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData | ZohoServerErrorResponseDataArrayRef, responseError: FetchResponseError): ParsedZohoServerError;
+export declare const interceptZohoCrm200StatusWithErrorResponse: import("@dereekb/util/fetch").FetchJsonInterceptJsonResponseFunction;
+export declare const handleZohoCrmErrorFetch: import("..").HandleZohoErrorFetchFactory;

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

@@ -0,0 +1,22 @@
+import { type ZohoCrmConfig, type ZohoCrmContextRef, type ZohoCrmFetchFactory } from './crm.config';
+import { type LogZohoServerErrorFunction } from '../zoho.error.api';
+import { type ZohoAccountsContextRef } from '../accounts/accounts.config';
+import { type ZohoRateLimitedFetchHandlerConfig } from '../zoho.limit';
+import { type Maybe } from '@dereekb/util';
+export type ZohoCrm = ZohoCrmContextRef;
+export interface ZohoCrmFactoryConfig extends ZohoAccountsContextRef {
+    /**
+     * Custom ZohoRateLimitedFetchHandlerConfig
+     */
+    rateLimiterConfig?: Maybe<ZohoRateLimitedFetchHandlerConfig>;
+    /**
+     * Creates a new fetch instance to use when making calls.
+     */
+    fetchFactory?: ZohoCrmFetchFactory;
+    /**
+     * Custom log error function.
+     */
+    logZohoServerErrorFunction?: LogZohoServerErrorFunction;
+}
+export type ZohoCrmFactory = (config: ZohoCrmConfig) => ZohoCrm;
+export declare function zohoCrmFactory(factoryConfig: ZohoCrmFactoryConfig): ZohoCrmFactory;