@dereekb/zoho 12.1.11 → 12.1.13

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

@@ -1,7 +1,7 @@
 import { ZohoDataArrayResultRef, ZohoPageFilter, ZohoPageResult } from './../zoho.api.page';
 import { FetchJsonBody, FetchJsonInput, FetchPage, FetchPageFactory, FetchPageFactoryOptions, makeUrlSearchParams } from '@dereekb/util/fetch';
 import { ZohoRecruitConfigApiUrlInput, ZohoRecruitContext } from './recruit.config';
-import { NewZohoRecruitNoteData, ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleNameRef, ZohoRecruitChangeObjectDetails, ZohoRecruitRecord, ZohoRecruitRecordId, ZohoRecruitRecordNote, ZohoRecruitTerritoryId, ZohoRecruitTrueFalseBoth, ZohoRecruitNoteId, ZohoRecruitRestFunctionApiName, ZohoRecruitUserId } from './recruit';
+import { ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleNameRef, ZohoRecruitChangeObjectDetails, ZohoRecruitRecord, ZohoRecruitRecordId, ZohoRecruitTerritoryId, ZohoRecruitTrueFalseBoth, ZohoRecruitRestFunctionApiName, ZohoRecruitUserId, ZohoRecruitModuleName, ZohoRecruitRecordEmailMetadata } from './recruit';
 import { ZohoRecruitSearchRecordsCriteriaTreeElement } from './recruit.criteria';
 import { ArrayOrValue, EmailAddress, Maybe, PhoneNumber, SortingOrder, UniqueModelWithId } from '@dereekb/util';
 import { ZohoServerErrorDataWithDetails, ZohoServerErrorStatus, ZohoServerSuccessCode, ZohoServerSuccessStatus } from '../zoho.error.api';
@@ -73,6 +73,30 @@ export type ZohoRecruitUpdateRecordFunction = ZohoRecruitUpdateRecordLikeFunctio
  * @returns
  */
 export declare function updateRecord(context: ZohoRecruitContext): ZohoRecruitUpdateRecordFunction;
+export type ZohoRecruitDeleteRecordFunction = (input: ZohoRecruitDeleteRecordInput) => Promise<ZohoRecruitDeleteRecordResponse>;
+export interface ZohoRecruitDeleteRecordInput extends ZohoRecruitModuleNameRef {
+    /**
+     * Id or array of ids to delete.
+     */
+    readonly ids: ArrayOrValue<ZohoRecruitRecordId>;
+    readonly wf_trigger?: boolean;
+}
+export interface ZohoRecruitDeleteRecordResponseSuccessEntry extends ZohoRecruitChangeObjectLikeResponseSuccessEntryMeta {
+    readonly details: {
+        readonly id: ZohoRecruitRecordId;
+    };
+}
+export type ZohoRecruitDeleteRecordResponse = ZohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs<ZohoRecruitDeleteRecordResponseSuccessEntry>;
+export type ZohoRecruitDeleteRecordResult = ZohoRecruitChangeObjectResponseSuccessEntry[];
+/**
+ * Deletes one or more records from the given module.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/delete-records.html
+ *
+ * @param context
+ * @returns ZohoRecruitDeleteRecordFunction
+ */
+export declare function deleteRecord(context: ZohoRecruitContext): ZohoRecruitDeleteRecordFunction;
 export interface ZohoRecruitGetRecordByIdInput extends ZohoRecruitModuleNameRef {
     readonly id: ZohoRecruitRecordId;
 }
@@ -139,39 +163,46 @@ export type ZohoRecruitSearchRecordsFunction = <T = ZohoRecruitRecord>(input: Zo
 export declare function searchRecords(context: ZohoRecruitContext): ZohoRecruitSearchRecordsFunction;
 export type SearchRecordsPageFactory = <T = ZohoRecruitRecord>(input: ZohoRecruitSearchRecordsInput<T>, options?: Maybe<FetchPageFactoryOptions<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>>) => FetchPage<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>;
 export declare function searchRecordsPageFactory(context: ZohoRecruitContext): SearchRecordsPageFactory;
-export interface ZohoRecruitCreateNotesRequest {
-    readonly data: ZohoRecruitCreateNotesRequestEntry[];
-}
-export type ZohoRecruitCreateNotesResult = ZohoRecruitMultiRecordResult<ZohoRecruitCreateNotesRequestEntry, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
-export type ZohoRecruitCreateNotesRequestEntry = NewZohoRecruitNoteData;
-export type ZohoRecruitCreateNotesResponse = ZohoRecruitChangeObjectResponse;
-export type ZohoRecruitCreateNotesFunction = (input: ZohoRecruitCreateNotesRequest) => Promise<ZohoRecruitCreateNotesResult>;
-export declare function createNotes(context: ZohoRecruitContext): (input: ZohoRecruitCreateNotesRequest) => Promise<ZohoRecruitMultiRecordResult<NewZohoRecruitNoteData, ZohoRecruitChangeObjectResponseSuccessEntry<ZohoRecruitChangeObjectDetails>, ZohoRecruitChangeObjectResponseErrorEntry>>;
-export interface ZohoRecruitDeleteNotesRequest {
-    readonly ids: ArrayOrValue<ZohoRecruitNoteId>;
-}
-export type ZohoRecruitDeleteNotesResult = ZohoRecruitMultiRecordResult<ZohoRecruitNoteId, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
-export type ZohoRecruitDeleteNotesResponse = ZohoRecruitChangeObjectResponse;
-export type ZohoRecruitDeleteNotesFunction = (input: ZohoRecruitDeleteNotesRequest) => Promise<ZohoRecruitDeleteNotesResult>;
-export declare function deleteNotes(context: ZohoRecruitContext): (input: ZohoRecruitDeleteNotesRequest) => Promise<ZohoRecruitMultiRecordResult<string, ZohoRecruitChangeObjectResponseSuccessEntry<ZohoRecruitChangeObjectDetails>, ZohoRecruitChangeObjectResponseErrorEntry>>;
-export type ZohoRecruitGetNotesPageFilter = ZohoPageFilter;
-export interface ZohoRecruitGetNotesForRecordRequest extends ZohoRecruitGetRecordByIdInput, ZohoRecruitGetNotesPageFilter {
+export interface ZohoRecruitGetRelatedRecordsFunctionConfig {
+    readonly targetModule: ZohoRecruitModuleName;
     /**
-     * @deprecated use variables on request instead of this filter.
+     * If true, will return an empty page result instead of null when no results are found.
+     *
+     * Defaults to true.
      */
-    readonly filter?: Maybe<ZohoRecruitGetNotesPageFilter>;
+    readonly returnEmptyRecordsInsteadOfNull?: boolean;
 }
-export type ZohoRecruitGetNotesForRecordResponse = ZohoPageResult<ZohoRecruitRecordNote>;
-export type ZohoRecruitGetNotesForRecordFunction = (input: ZohoRecruitGetNotesForRecordRequest) => Promise<ZohoRecruitGetNotesForRecordResponse>;
-export declare function getNotesForRecord(context: ZohoRecruitContext): ZohoRecruitGetNotesForRecordFunction;
-export type GetNotesForRecordPageFactory = FetchPageFactory<ZohoRecruitGetNotesForRecordRequest, ZohoRecruitGetNotesForRecordResponse>;
-export declare function getNotesForRecordPageFactory(context: ZohoRecruitContext): GetNotesForRecordPageFactory;
-export interface ZohoRecruitCreateNotesForRecordRequest extends ZohoRecruitModuleNameRef {
-    readonly id: ZohoRecruitRecordId;
-    readonly notes: ArrayOrValue<Omit<NewZohoRecruitNoteData, 'se_module' | 'Parent_Id'>>;
+export type ZohoRecruitGetRelatedRecordsFunctionFactory = <T = ZohoRecruitRecord>(input: ZohoRecruitGetRelatedRecordsFunctionConfig) => ZohoRecruitGetRelatedRecordsFunction<T>;
+export type ZohoRecruitGetRelatedRecordsPageFilter = ZohoPageFilter;
+export interface ZohoRecruitGetRelatedRecordsRequest extends ZohoRecruitGetRecordByIdInput, ZohoRecruitGetRelatedRecordsPageFilter {
+    /**
+     * 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<ZohoRecruitRecordId>>;
+    /**
+     * @deprecated set variables on request object directly instead of using this filter.
+     */
+    readonly filter?: Maybe<ZohoRecruitGetRelatedRecordsPageFilter>;
 }
-export type ZohoRecruitCreateNotesForRecordFunction = (input: ZohoRecruitCreateNotesForRecordRequest) => Promise<ZohoRecruitCreateNotesResult>;
-export declare function createNotesForRecord(context: ZohoRecruitContext): ZohoRecruitCreateNotesForRecordFunction;
+export type ZohoRecruitGetRelatedRecordsResponse<T = ZohoRecruitRecord> = ZohoPageResult<T>;
+export type ZohoRecruitGetRelatedRecordsFunction<T = ZohoRecruitRecord> = (input: ZohoRecruitGetRelatedRecordsRequest) => Promise<ZohoRecruitGetRelatedRecordsResponse<T>>;
+/**
+ * Creates a ZohoRecruitGetRelatedRecordsFunctionFactory, which can be used to create ZohoRecruitGetRelatedRecordsFunction<T> that targets retrieving related records of a given type.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
+ *
+ * @param context the ZohoRecruitContext to use
+ * @returns a ZohoRecruitGetRelatedRecordsFunctionFactory
+ */
+export declare function getRelatedRecordsFunctionFactory(context: ZohoRecruitContext): ZohoRecruitGetRelatedRecordsFunctionFactory;
+export type ZohoRecruitGetEmailsForRecordRequest = ZohoRecruitGetRelatedRecordsRequest;
+export type ZohoRecruitGetEmailsForRecordResponse = ZohoPageResult<ZohoRecruitRecordEmailMetadata>;
+export type ZohoRecruitGetEmailsForRecordFunction = (input: ZohoRecruitGetEmailsForRecordRequest) => Promise<ZohoRecruitGetEmailsForRecordResponse>;
+export declare function getEmailsForRecord(context: ZohoRecruitContext): ZohoRecruitGetEmailsForRecordFunction;
+export type GetEmailsForRecordPageFactory = FetchPageFactory<ZohoRecruitGetEmailsForRecordRequest, ZohoRecruitGetEmailsForRecordResponse>;
+export declare function getEmailsForRecordPageFactory(context: ZohoRecruitContext): GetEmailsForRecordPageFactory;
 export type ZohoRecruitExecuteRestApiFunctionRequest = ZohoRecruitExecuteRestApiFunctionNormalRequest | ZohoRecruitExecuteRestApiFunctionApiSpecificRequest;
 export interface ZohoRecruitExecuteRestApiFunctionNormalRequest {
     readonly functionName: ZohoRecruitRestFunctionApiName;
@@ -238,11 +269,17 @@ export declare const zohoRecruitUrlSearchParams: typeof makeUrlSearchParams;
 export declare function zohoRecruitApiFetchJsonInput(method: string, body?: Maybe<FetchJsonBody>): FetchJsonInput;
 export type ZohoRecruitChangeObjectLikeResponse<T extends ZohoRecruitChangeObjectLikeResponseEntry = ZohoRecruitChangeObjectLikeResponseEntry> = ZohoDataArrayResultRef<T>;
 export type ZohoRecruitChangeObjectLikeResponseEntry<E extends ZohoRecruitChangeObjectLikeResponseSuccessEntryMeta = ZohoRecruitChangeObjectLikeResponseSuccessEntryMeta> = E | ZohoRecruitChangeObjectResponseErrorEntry;
+export type ZohoRecruitChangeObjectLikeResponseSuccessEntryType<T extends ZohoRecruitChangeObjectLikeResponseEntry> = T extends ZohoRecruitChangeObjectLikeResponseEntry<infer E> ? E : never;
 export interface ZohoRecruitChangeObjectLikeResponseSuccessEntryMeta {
     readonly code: ZohoServerSuccessCode;
     readonly status: ZohoServerSuccessStatus;
     readonly message: string;
 }
+export type ZohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs<T extends ZohoRecruitChangeObjectLikeResponseEntry> = ZohoRecruitChangeObjectLikeResponse<T> & {
+    readonly successItems: ZohoRecruitChangeObjectLikeResponseSuccessEntryType<T>[];
+    readonly errorItems: ZohoRecruitChangeObjectResponseErrorEntry[];
+};
+export declare function zohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs<T extends ZohoRecruitChangeObjectLikeResponseEntry>(response: ZohoRecruitChangeObjectLikeResponse<T>): ZohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs<T>;
 export type ZohoRecruitChangeObjectResponse<T extends ZohoRecruitChangeObjectResponseEntry = ZohoRecruitChangeObjectResponseEntry> = ZohoRecruitChangeObjectLikeResponse<T>;
 export type ZohoRecruitChangeObjectResponseEntry<E extends ZohoRecruitChangeObjectResponseSuccessEntry = ZohoRecruitChangeObjectResponseSuccessEntry> = ZohoRecruitChangeObjectLikeResponseEntry<E>;
 export interface ZohoRecruitChangeObjectResponseSuccessEntry<D extends ZohoRecruitChangeObjectDetails = ZohoRecruitChangeObjectDetails> extends ZohoRecruitChangeObjectLikeResponseSuccessEntryMeta {
@@ -269,3 +306,7 @@ export interface ZohoRecruitMultiRecordResultEntry<I, O> {
      */
     readonly result: O;
 }
+/**
+ * @deprecated use ZohoRecruitGetRelatedRecordsPageFilter instead.
+ */
+export type ZohoRecruitGetNotesPageFilter = ZohoRecruitGetRelatedRecordsPageFilter;

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

@@ -0,0 +1,34 @@
+import { ZohoPageResult } from '../zoho.api.page';
+import { FetchPageFactory } from '@dereekb/util/fetch';
+import { ZohoRecruitContext } from './recruit.config';
+import { ZohoRecruitModuleNameRef, ZohoRecruitRecordId } from './recruit';
+import { ArrayOrValue } from '@dereekb/util';
+import { ZohoRecruitMultiRecordResult, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry, ZohoRecruitChangeObjectResponse, ZohoRecruitGetRelatedRecordsRequest } from './recruit.api';
+import { NewZohoRecruitNoteData, ZohoRecruitNoteId, ZohoRecruitRecordNote } from './recruit.notes';
+export interface ZohoRecruitCreateNotesRequest {
+    readonly data: ZohoRecruitCreateNotesRequestEntry[];
+}
+export type ZohoRecruitCreateNotesResult = ZohoRecruitMultiRecordResult<ZohoRecruitCreateNotesRequestEntry, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
+export type ZohoRecruitCreateNotesRequestEntry = NewZohoRecruitNoteData;
+export type ZohoRecruitCreateNotesResponse = ZohoRecruitChangeObjectResponse;
+export type ZohoRecruitCreateNotesFunction = (input: ZohoRecruitCreateNotesRequest) => Promise<ZohoRecruitCreateNotesResult>;
+export declare function createNotes(context: ZohoRecruitContext): (input: ZohoRecruitCreateNotesRequest) => Promise<ZohoRecruitMultiRecordResult<NewZohoRecruitNoteData, ZohoRecruitChangeObjectResponseSuccessEntry<import("./recruit").ZohoRecruitChangeObjectDetails>, ZohoRecruitChangeObjectResponseErrorEntry>>;
+export interface ZohoRecruitDeleteNotesRequest {
+    readonly ids: ArrayOrValue<ZohoRecruitNoteId>;
+}
+export type ZohoRecruitDeleteNotesResult = ZohoRecruitMultiRecordResult<ZohoRecruitNoteId, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
+export type ZohoRecruitDeleteNotesResponse = ZohoRecruitChangeObjectResponse;
+export type ZohoRecruitDeleteNotesFunction = (input: ZohoRecruitDeleteNotesRequest) => Promise<ZohoRecruitDeleteNotesResult>;
+export declare function deleteNotes(context: ZohoRecruitContext): (input: ZohoRecruitDeleteNotesRequest) => Promise<ZohoRecruitMultiRecordResult<string, ZohoRecruitChangeObjectResponseSuccessEntry<import("./recruit").ZohoRecruitChangeObjectDetails>, ZohoRecruitChangeObjectResponseErrorEntry>>;
+export type ZohoRecruitGetNotesForRecordRequest = ZohoRecruitGetRelatedRecordsRequest;
+export type ZohoRecruitGetNotesForRecordResponse = ZohoPageResult<ZohoRecruitRecordNote>;
+export type ZohoRecruitGetNotesForRecordFunction = (input: ZohoRecruitGetNotesForRecordRequest) => Promise<ZohoRecruitGetNotesForRecordResponse>;
+export declare function getNotesForRecord(context: ZohoRecruitContext): ZohoRecruitGetNotesForRecordFunction;
+export type GetNotesForRecordPageFactory = FetchPageFactory<ZohoRecruitGetNotesForRecordRequest, ZohoRecruitGetNotesForRecordResponse>;
+export declare function getNotesForRecordPageFactory(context: ZohoRecruitContext): GetNotesForRecordPageFactory;
+export interface ZohoRecruitCreateNotesForRecordRequest extends ZohoRecruitModuleNameRef {
+    readonly id: ZohoRecruitRecordId;
+    readonly notes: ArrayOrValue<Omit<NewZohoRecruitNoteData, 'se_module' | 'Parent_Id'>>;
+}
+export type ZohoRecruitCreateNotesForRecordFunction = (input: ZohoRecruitCreateNotesForRecordRequest) => Promise<ZohoRecruitCreateNotesResult>;
+export declare function createNotesForRecord(context: ZohoRecruitContext): ZohoRecruitCreateNotesForRecordFunction;

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

@@ -0,0 +1,86 @@
+import { ZohoRecruitContext } from './recruit.config';
+import { ArrayOrValue, Maybe } from '@dereekb/util';
+import { ZohoRecruitModuleNameRef, ZohoRecruitRecordId } from './recruit';
+import { ZohoRecruitChangeObjectLikeResponse, ZohoRecruitChangeObjectLikeResponseSuccessEntryMeta, ZohoRecruitChangeObjectResponse, ZohoRecruitChangeObjectResponseErrorEntry, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitGetRecordsPageFilter, ZohoRecruitMultiRecordResult, ZohoRecruitMultiRecordResultEntry } from './recruit.api';
+import { ZohoRecruitTagData, ZohoRecruitTagName, ZohoRecruitTagWithObjectDetails } from './recruit.tags';
+import { FetchPage, FetchPageFactoryOptions } from '@dereekb/util/fetch';
+import { ZohoPageResult } from '../zoho.api.page';
+export type ZohoRecruitCreateTagData = Pick<ZohoRecruitTagData, 'name'> & Partial<Pick<ZohoRecruitTagData, 'color_code'>>;
+export interface ZohoRecruitCreateTagsRequest extends ZohoRecruitModuleNameRef {
+    readonly tags: ArrayOrValue<ZohoRecruitCreateTagData>;
+}
+export interface ZohoRecruitCreateTagsResponse {
+    readonly tags: ZohoRecruitChangeObjectResponse['data'];
+}
+export type ZohoRecruitCreateTagsResult = ZohoRecruitMultiRecordResult<ZohoRecruitCreateTagData, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry> & {
+    readonly duplicateErrorItems: ZohoRecruitMultiRecordResultEntry<ZohoRecruitCreateTagData, ZohoRecruitChangeObjectResponseErrorEntry>[];
+    readonly allErrorItems: ZohoRecruitMultiRecordResultEntry<ZohoRecruitCreateTagData, ZohoRecruitChangeObjectResponseErrorEntry>[];
+};
+export type ZohoRecruitCreateTagsFunction = (input: ZohoRecruitCreateTagsRequest) => Promise<ZohoRecruitCreateTagsResult>;
+export declare function createTagsForModule(context: ZohoRecruitContext): (input: ZohoRecruitCreateTagsRequest) => Promise<{
+    errorItems: ZohoRecruitMultiRecordResultEntry<ZohoRecruitCreateTagData, ZohoRecruitChangeObjectResponseErrorEntry>[];
+    duplicateErrorItems: ZohoRecruitMultiRecordResultEntry<ZohoRecruitCreateTagData, ZohoRecruitChangeObjectResponseErrorEntry>[];
+    allErrorItems: ZohoRecruitMultiRecordResultEntry<ZohoRecruitCreateTagData, ZohoRecruitChangeObjectResponseErrorEntry>[];
+    successItems: ZohoRecruitMultiRecordResultEntry<ZohoRecruitCreateTagData, ZohoRecruitChangeObjectResponseSuccessEntry<import("./recruit").ZohoRecruitChangeObjectDetails>>[];
+}>;
+export interface ZohoRecruitGetTagsRequest extends ZohoRecruitModuleNameRef, ZohoRecruitGetRecordsPageFilter {
+    readonly my_tags?: string;
+}
+export interface ZohoRecruitGetTagsResponse extends Omit<ZohoPageResult<ZohoRecruitTagWithObjectDetails>, 'data'> {
+    readonly tags: ZohoRecruitTagWithObjectDetails[];
+}
+export type ZohoRecruitGetTagsResult = ZohoPageResult<ZohoRecruitTagWithObjectDetails>;
+export type ZohoRecruitGetTagsFunction = (input: ZohoRecruitGetTagsRequest) => Promise<ZohoRecruitGetTagsResult>;
+/**
+ * Returns the list of tags within a module.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/get-tag-list.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function getTagsForModule(context: ZohoRecruitContext): ZohoRecruitGetTagsFunction;
+export type GetTagsForModulePageFactory = (input: ZohoRecruitGetTagsRequest, options?: Maybe<FetchPageFactoryOptions<ZohoRecruitGetTagsRequest, ZohoRecruitGetTagsResult>>) => FetchPage<ZohoRecruitGetTagsRequest, ZohoRecruitGetTagsResult>;
+export declare function getTagsForModulePageFactory(context: ZohoRecruitContext): GetTagsForModulePageFactory;
+export interface ZohoRecruitAddTagsToRecordsRequest extends ZohoRecruitModuleNameRef {
+    /**
+     * Tag names to add to the records.
+     */
+    readonly tag_names: ArrayOrValue<ZohoRecruitTagName>;
+    /**
+     * Ids corresponding to the records in the module to add the tags to.
+     */
+    readonly ids: ArrayOrValue<ZohoRecruitRecordId>;
+}
+export interface ZohoRecruitAddTagsToRecordsResultDetails {
+    /**
+     * Record id that was updated
+     */
+    readonly id: ZohoRecruitRecordId;
+    /**
+     * Tag names that were added to the record
+     */
+    readonly tags: ZohoRecruitTagName[];
+}
+export interface ZohoRecruitAddTagsToRecordsSuccessEntry extends ZohoRecruitChangeObjectLikeResponseSuccessEntryMeta {
+    readonly details: ZohoRecruitAddTagsToRecordsResultDetails;
+}
+export type ZohoRecruitAddTagsToRecordsResponse = ZohoRecruitChangeObjectLikeResponse<ZohoRecruitAddTagsToRecordsSuccessEntry>;
+/**
+ * Contains all the details of the error.
+ */
+export type ZohoRecruitAddTagsToRecordsErrorEntryDetails = ZohoRecruitAddTagsToRecordsResultDetails;
+export type ZohoRecruitAddTagsToRecordsErrorEntry = ZohoRecruitChangeObjectResponseErrorEntry & {
+    readonly details: ZohoRecruitAddTagsToRecordsErrorEntryDetails;
+};
+export type ZohoRecruitAddTagsToRecordsResult = ZohoRecruitMultiRecordResult<ZohoRecruitAddTagsToRecordsRequest, ZohoRecruitAddTagsToRecordsSuccessEntry, ZohoRecruitAddTagsToRecordsErrorEntry>;
+export type ZohoRecruitAddTagsToRecordsFunction = (input: ZohoRecruitAddTagsToRecordsRequest) => Promise<ZohoRecruitAddTagsToRecordsResult>;
+/**
+ * Associates one or more candidates with one or more job openings.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/associate-candidate.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function addTagsToRecords(context: ZohoRecruitContext): ZohoRecruitAddTagsToRecordsFunction;

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

@@ -1,4 +1,4 @@
-import { CommaSeparatedString, ISO8601DateString, UniqueModelWithId, WebsiteUrl } from '@dereekb/util';
+import { CommaSeparatedString, EmailAddress, ISO8601DateString, UniqueModelWithId, WebsiteUrl } from '@dereekb/util';
 /**
  * Zoho Recruit module name.
  *
@@ -13,6 +13,14 @@ export declare const ZOHO_RECRUIT_CANDIDATES_MODULE = "Candidates";
  * Job Openings module name
  */
 export declare const ZOHO_RECRUIT_JOB_OPENINGS_MODULE = "Job_Openings";
+/**
+ * Notes module name
+ */
+export declare const ZOHO_RECRUIT_NOTES_MODULE = "Notes";
+/**
+ * Emails module name
+ */
+export declare const ZOHO_RECRUIT_EMAILS_MODULE = "Emails";
 /**
  * Contains a reference to a module.
  */
@@ -134,54 +142,6 @@ export type ZohoRecruitRecord = UniqueModelWithId & ZohoRecruitRecordFieldsData;
  * Returns true if it is a valid ZohoRecruitValidUrl.
  */
 export declare const isZohoRecruitValidUrl: (input: WebsiteUrl) => input is ZohoRecruitValidUrl;
-/**
- * Update details returned by the server for an updated record.
- *
- * @deprecated use ZohoRecruitChangeObjectDetails instead.
- */
-export type ZohoRecruitRecordUpdateDetails = ZohoRecruitChangeObjectDetails;
-export type ZohoRecruitNoteId = string;
-export interface ZohoRecruitNoteAction {
-    $is_system_action: boolean;
-}
-export type ZohoRecruitNoteSourceName = 'NORMAL_USER';
-export type ZohoRecruitNoteSourceType = number;
-export interface ZohoRecruitNoteSource {
-    name: ZohoRecruitNoteSourceName;
-    type: ZohoRecruitNoteSourceType;
-}
-export type ZohoRecruitNoteOwnerData = ZohoRecruitReferenceData;
-export interface ZohoRecruitNoteData {
-    Note_Title: string;
-    Note_Content: string;
-    Parent_Id: ZohoRecruitParentReferenceData;
-    Created_Time: ISO8601DateString;
-    Modified_Time: ISO8601DateString;
-    $attachments: null;
-    $is_edit_allowed: boolean;
-    $editable: boolean;
-    $type_id: ZohoRecruitTypeId;
-    $is_delete_allowed: boolean;
-    $note_action: ZohoRecruitNoteAction;
-    $source: ZohoRecruitNoteSource;
-    $se_module: ZohoRecruitModuleName;
-    $is_shared_to_client: boolean;
-    Note_Owner: ZohoRecruitNoteOwnerData;
-    Created_By: ZohoRecruitCreatedByData;
-    Modified_By: ZohoRecruitModifiedByData;
-    $size: ZohoRecruitNoteFileSize | null;
-    $voice_note: boolean;
-    $status: ZohoRecruitNoteStatus;
-}
-export interface NewZohoRecruitNoteData extends Pick<ZohoRecruitNoteData, 'Note_Title' | 'Note_Content'> {
-    Parent_Id: Pick<ZohoRecruitParentReferenceData, 'id'> | ZohoRecruitId;
-    se_module: ZohoRecruitModuleName;
-}
-export type ZohoRecruitNoteStatus = string;
-export type ZohoRecruitNoteFileSize = number;
-export interface ZohoRecruitNote extends ZohoRecruitNoteData, UniqueModelWithId {
-}
-export type ZohoRecruitRecordNote = ZohoRecruitNote;
 /**
  * The posting title of a job opening.
  */
@@ -191,6 +151,41 @@ export type ZohoRecruitJobOpeningPostingTitle = string;
  */
 export type ZohoRecruitCandidateStatus = string;
 /**
- * @deprecated use NewZohoRecruitNewNoteData instead.
+ * Metadata for a record's email.
+ */
+export interface ZohoRecruitRecordEmailMetadata {
+    /**
+     * 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: ZohoRecruitRecordEmailMetadataStatus[];
+}
+export type ZohoRecruitRecordEmailMetadataStatusType = 'sent' | string;
+export interface ZohoRecruitRecordEmailMetadataStatus {
+    type: ZohoRecruitRecordEmailMetadataStatusType;
+}
+/**
+ * Update details returned by the server for an updated record.
+ *
+ * @deprecated use ZohoRecruitChangeObjectDetails instead.
  */
-export type NewZohoRecruitNewNoteData = NewZohoRecruitNoteData;
+export type ZohoRecruitRecordUpdateDetails = ZohoRecruitChangeObjectDetails;

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

@@ -0,0 +1,48 @@
+import { ISO8601DateString, UniqueModelWithId } from '@dereekb/util';
+import { ZohoRecruitReferenceData, ZohoRecruitParentReferenceData, ZohoRecruitTypeId, ZohoRecruitModuleName, ZohoRecruitCreatedByData, ZohoRecruitModifiedByData, ZohoRecruitId } from './recruit';
+export type ZohoRecruitNoteId = string;
+export interface ZohoRecruitNoteAction {
+    $is_system_action: boolean;
+}
+export type ZohoRecruitNoteSourceName = 'NORMAL_USER';
+export type ZohoRecruitNoteSourceType = number;
+export interface ZohoRecruitNoteSource {
+    name: ZohoRecruitNoteSourceName;
+    type: ZohoRecruitNoteSourceType;
+}
+export type ZohoRecruitNoteOwnerData = ZohoRecruitReferenceData;
+export interface ZohoRecruitNoteData {
+    Note_Title: string;
+    Note_Content: string;
+    Parent_Id: ZohoRecruitParentReferenceData;
+    Created_Time: ISO8601DateString;
+    Modified_Time: ISO8601DateString;
+    $attachments: null;
+    $is_edit_allowed: boolean;
+    $editable: boolean;
+    $type_id: ZohoRecruitTypeId;
+    $is_delete_allowed: boolean;
+    $note_action: ZohoRecruitNoteAction;
+    $source: ZohoRecruitNoteSource;
+    $se_module: ZohoRecruitModuleName;
+    $is_shared_to_client: boolean;
+    Note_Owner: ZohoRecruitNoteOwnerData;
+    Created_By: ZohoRecruitCreatedByData;
+    Modified_By: ZohoRecruitModifiedByData;
+    $size: ZohoRecruitNoteFileSize | null;
+    $voice_note: boolean;
+    $status: ZohoRecruitNoteStatus;
+}
+export interface NewZohoRecruitNoteData extends Pick<ZohoRecruitNoteData, 'Note_Title' | 'Note_Content'> {
+    Parent_Id: Pick<ZohoRecruitParentReferenceData, 'id'> | ZohoRecruitId;
+    se_module: ZohoRecruitModuleName;
+}
+export type ZohoRecruitNoteStatus = string;
+export type ZohoRecruitNoteFileSize = number;
+export interface ZohoRecruitNote extends ZohoRecruitNoteData, UniqueModelWithId {
+}
+export type ZohoRecruitRecordNote = ZohoRecruitNote;
+/**
+ * @deprecated use NewZohoRecruitNewNoteData instead.
+ */
+export type NewZohoRecruitNewNoteData = NewZohoRecruitNoteData;

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

@@ -0,0 +1,34 @@
+import { HexColorCode } from '@dereekb/util';
+import { ZohoRecruitChangeObjectDetails } from './recruit';
+export type ZohoRecruitTagId = string;
+/**
+ * Name of a tag.
+ *
+ * Max length of 25 characters.
+ */
+export type ZohoRecruitTagName = string;
+/**
+ * Maximum length of ZohoRecruitTagName
+ */
+export declare const ZOHO_RECRUIT_TAG_NAME_MAX_LENGTH = 25;
+/**
+ * Hex color code of a tag
+ */
+export type ZohoRecruitTagColorCode = HexColorCode;
+/**
+ * The color and name of a Tag in Zoho Recruit.
+ */
+export interface ZohoRecruitTagData {
+    color_code: ZohoRecruitTagColorCode;
+    name: ZohoRecruitTagName;
+}
+/**
+ * Includes the id of the Tag along with other tag data.
+ */
+export interface ZohoRecruitTag extends ZohoRecruitTagData {
+    id: ZohoRecruitTagId;
+}
+/**
+ * ZohoRecruitTag that also has ZohoRecruitChangeObjectDetails
+ */
+export type ZohoRecruitTagWithObjectDetails = ZohoRecruitTag & ZohoRecruitChangeObjectDetails;

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

@@ -9,10 +9,18 @@ export interface ZohoServerErrorResponseData {
  * A code used in some cases to denote success.
  */
 export declare const ZOHO_SUCCESS_CODE = "SUCCESS";
+/**
+ * Lowercase status code
+ */
+export declare const ZOHO_SUCCESS_STATUS = "success";
+/**
+ * Set in the status field
+ */
+export declare const ZOHO_ERROR_STATUS = "error";
 export type ZohoServerSuccessCode = typeof ZOHO_SUCCESS_CODE;
-export type ZohoServerSuccessStatus = 'success';
+export type ZohoServerSuccessStatus = typeof ZOHO_SUCCESS_STATUS;
 export type ZohoServerErrorCode = string;
-export type ZohoServerErrorStatus = 'error';
+export type ZohoServerErrorStatus = typeof ZOHO_ERROR_STATUS;
 /**
  * Zoho Server Error Data
  *