@dereekb/zoho 12.1.11 → 12.1.12

package/index.cjs.js

@@ -1974,6 +1974,14 @@ function zohoRecruitSearchRecordsCriteriaEntryToCriteriaString(entry) {
  * A code used in some cases to denote success.
  */
 const ZOHO_SUCCESS_CODE = 'SUCCESS';
+/**
+ * Lowercase status code
+ */
+const ZOHO_SUCCESS_STATUS = 'success';
+/**
+ * Set in the status field
+ */
+const ZOHO_ERROR_STATUS = 'error';
 function zohoServerErrorData(error) {
   const errorType = typeof error;
   let errorData;
@@ -2354,6 +2362,26 @@ function upsertRecord(context) {
 function updateRecord(context) {
   return updateRecordLikeFunction(context, '', 'PUT');
 }
+/**
+ * Deletes one or more records from the given module.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/delete-records.html
+ *
+ * @param context
+ * @returns ZohoRecruitDeleteRecordFunction
+ */
+function deleteRecord(context) {
+  return ({
+    ids,
+    module,
+    wf_trigger
+  }) => {
+    return context.fetchJson(`/v2/${module}?${fetch.makeUrlSearchParams({
+      ids,
+      wf_trigger
+    })}`, zohoRecruitApiFetchJsonInput('DELETE')).then(zohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs);
+  };
+}
 /**
  * Retrieves a specific record from the given module.
  *
@@ -2410,6 +2438,22 @@ function searchRecords(context) {
 function searchRecordsPageFactory(context) {
   return zohoFetchPageFactory(searchRecords(context));
 }
+/**
+ * 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
+ */
+function getRelatedRecordsFunctionFactory(context) {
+  return config => {
+    const {
+      targetModule
+    } = config;
+    return input => context.fetchJson(`/v2/${input.module}/${input.id}/${targetModule}?${zohoRecruitUrlSearchParamsMinusIdAndModule(input, input.filter).toString()}`, zohoRecruitApiFetchJsonInput('GET'));
+  };
+}
 function createNotes(context) {
   return input => context.fetchJson(`/v2/Notes`, zohoRecruitApiFetchJsonInput('POST', {
     data: input.data
@@ -2425,7 +2469,9 @@ function deleteNotes(context) {
   });
 }
 function getNotesForRecord(context) {
-  return input => context.fetchJson(`/v2/${input.module}/${input.id}/Notes?${zohoRecruitUrlSearchParamsMinusIdAndModule(input, input.filter).toString()}`, zohoRecruitApiFetchJsonInput('GET'));
+  return getRelatedRecordsFunctionFactory(context)({
+    targetModule: 'Notes'
+  });
 }
 function getNotesForRecordPageFactory(context) {
   return zohoFetchPageFactory(getNotesForRecord(context));
@@ -2506,12 +2552,32 @@ function zohoRecruitApiFetchJsonInput(method, body) {
   };
   return result;
 }
+function zohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs(response) {
+  const {
+    data
+  } = response;
+  const successItems = [];
+  const errorItems = [];
+  data.forEach(x => {
+    if (x.status === ZOHO_SUCCESS_STATUS) {
+      successItems.push(x);
+    } else {
+      errorItems.push(x);
+    }
+  });
+  const result = {
+    ...response,
+    successItems,
+    errorItems
+  };
+  return result;
+}
 function zohoRecruitMultiRecordResult(input, results) {
   const successItems = [];
   const errorItems = [];
   input.forEach((x, i) => {
     const result = results[i];
-    if (result.status === 'success') {
+    if (result.status === ZOHO_SUCCESS_STATUS) {
       successItems.push({
         input: x,
         result: result
@@ -2978,6 +3044,7 @@ exports.ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE = ZOHO_ACCOUNTS_INVALID_CLIENT_E
 exports.ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE = ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE;
 exports.ZOHO_ACCOUNTS_US_API_URL = ZOHO_ACCOUNTS_US_API_URL;
 exports.ZOHO_DUPLICATE_DATA_ERROR_CODE = ZOHO_DUPLICATE_DATA_ERROR_CODE;
+exports.ZOHO_ERROR_STATUS = ZOHO_ERROR_STATUS;
 exports.ZOHO_FAILURE_ERROR_CODE = ZOHO_FAILURE_ERROR_CODE;
 exports.ZOHO_INTERNAL_ERROR_CODE = ZOHO_INTERNAL_ERROR_CODE;
 exports.ZOHO_INVALID_AUTHORIZATION_ERROR_CODE = ZOHO_INVALID_AUTHORIZATION_ERROR_CODE;
@@ -2992,6 +3059,7 @@ exports.ZOHO_RECRUIT_CANDIDATES_MODULE = ZOHO_RECRUIT_CANDIDATES_MODULE;
 exports.ZOHO_RECRUIT_JOB_OPENINGS_MODULE = ZOHO_RECRUIT_JOB_OPENINGS_MODULE;
 exports.ZOHO_RECRUIT_SERVICE_NAME = ZOHO_RECRUIT_SERVICE_NAME;
 exports.ZOHO_SUCCESS_CODE = ZOHO_SUCCESS_CODE;
+exports.ZOHO_SUCCESS_STATUS = ZOHO_SUCCESS_STATUS;
 exports.ZOHO_TOO_MANY_REQUESTS_ERROR_CODE = ZOHO_TOO_MANY_REQUESTS_ERROR_CODE;
 exports.ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE = ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE;
 exports.ZohoAccountsAccessTokenError = ZohoAccountsAccessTokenError;
@@ -3015,6 +3083,7 @@ exports.associateCandidateRecordsWithJobOpenings = associateCandidateRecordsWith
 exports.createNotes = createNotes;
 exports.createNotesForRecord = createNotesForRecord;
 exports.deleteNotes = deleteNotes;
+exports.deleteRecord = deleteRecord;
 exports.emptyZohoPageResult = emptyZohoPageResult;
 exports.escapeZohoFieldValueForCriteriaString = escapeZohoFieldValueForCriteriaString;
 exports.executeRestApiFunction = executeRestApiFunction;
@@ -3022,6 +3091,7 @@ exports.getNotesForRecord = getNotesForRecord;
 exports.getNotesForRecordPageFactory = getNotesForRecordPageFactory;
 exports.getRecordById = getRecordById;
 exports.getRecords = getRecords;
+exports.getRelatedRecordsFunctionFactory = getRelatedRecordsFunctionFactory;
 exports.handleZohoAccountsErrorFetch = handleZohoAccountsErrorFetch;
 exports.handleZohoErrorFetchFactory = handleZohoErrorFetchFactory;
 exports.handleZohoRecruitErrorFetch = handleZohoRecruitErrorFetch;
@@ -3059,6 +3129,7 @@ exports.zohoFetchPageFactory = zohoFetchPageFactory;
 exports.zohoRateLimitHeaderDetails = zohoRateLimitHeaderDetails;
 exports.zohoRateLimitedFetchHandler = zohoRateLimitedFetchHandler;
 exports.zohoRecruitApiFetchJsonInput = zohoRecruitApiFetchJsonInput;
+exports.zohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs = zohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs;
 exports.zohoRecruitConfigApiUrl = zohoRecruitConfigApiUrl;
 exports.zohoRecruitFactory = zohoRecruitFactory;
 exports.zohoRecruitMultiRecordResult = zohoRecruitMultiRecordResult;

package/index.esm.js

@@ -1972,6 +1972,14 @@ function zohoRecruitSearchRecordsCriteriaEntryToCriteriaString(entry) {
  * A code used in some cases to denote success.
  */
 const ZOHO_SUCCESS_CODE = 'SUCCESS';
+/**
+ * Lowercase status code
+ */
+const ZOHO_SUCCESS_STATUS = 'success';
+/**
+ * Set in the status field
+ */
+const ZOHO_ERROR_STATUS = 'error';
 function zohoServerErrorData(error) {
   const errorType = typeof error;
   let errorData;
@@ -2352,6 +2360,26 @@ function upsertRecord(context) {
 function updateRecord(context) {
   return updateRecordLikeFunction(context, '', 'PUT');
 }
+/**
+ * Deletes one or more records from the given module.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/delete-records.html
+ *
+ * @param context
+ * @returns ZohoRecruitDeleteRecordFunction
+ */
+function deleteRecord(context) {
+  return ({
+    ids,
+    module,
+    wf_trigger
+  }) => {
+    return context.fetchJson(`/v2/${module}?${makeUrlSearchParams({
+      ids,
+      wf_trigger
+    })}`, zohoRecruitApiFetchJsonInput('DELETE')).then(zohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs);
+  };
+}
 /**
  * Retrieves a specific record from the given module.
  *
@@ -2408,6 +2436,22 @@ function searchRecords(context) {
 function searchRecordsPageFactory(context) {
   return zohoFetchPageFactory(searchRecords(context));
 }
+/**
+ * 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
+ */
+function getRelatedRecordsFunctionFactory(context) {
+  return config => {
+    const {
+      targetModule
+    } = config;
+    return input => context.fetchJson(`/v2/${input.module}/${input.id}/${targetModule}?${zohoRecruitUrlSearchParamsMinusIdAndModule(input, input.filter).toString()}`, zohoRecruitApiFetchJsonInput('GET'));
+  };
+}
 function createNotes(context) {
   return input => context.fetchJson(`/v2/Notes`, zohoRecruitApiFetchJsonInput('POST', {
     data: input.data
@@ -2423,7 +2467,9 @@ function deleteNotes(context) {
   });
 }
 function getNotesForRecord(context) {
-  return input => context.fetchJson(`/v2/${input.module}/${input.id}/Notes?${zohoRecruitUrlSearchParamsMinusIdAndModule(input, input.filter).toString()}`, zohoRecruitApiFetchJsonInput('GET'));
+  return getRelatedRecordsFunctionFactory(context)({
+    targetModule: 'Notes'
+  });
 }
 function getNotesForRecordPageFactory(context) {
   return zohoFetchPageFactory(getNotesForRecord(context));
@@ -2504,12 +2550,32 @@ function zohoRecruitApiFetchJsonInput(method, body) {
   };
   return result;
 }
+function zohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs(response) {
+  const {
+    data
+  } = response;
+  const successItems = [];
+  const errorItems = [];
+  data.forEach(x => {
+    if (x.status === ZOHO_SUCCESS_STATUS) {
+      successItems.push(x);
+    } else {
+      errorItems.push(x);
+    }
+  });
+  const result = {
+    ...response,
+    successItems,
+    errorItems
+  };
+  return result;
+}
 function zohoRecruitMultiRecordResult(input, results) {
   const successItems = [];
   const errorItems = [];
   input.forEach((x, i) => {
     const result = results[i];
-    if (result.status === 'success') {
+    if (result.status === ZOHO_SUCCESS_STATUS) {
       successItems.push({
         input: x,
         result: result
@@ -2968,4 +3034,4 @@ function zohoDateTimeString(date) {
   return isoDate.substring(0, isoDate.length - 5) + 'Z';
 }
 
-export { DEFAULT_ZOHO_API_RATE_LIMIT, DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD, DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION, MAX_ZOHO_RECRUIT_SEARCH_MODULE_RECORDS_CRITERIA, ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE, ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE, ZOHO_ACCOUNTS_US_API_URL, ZOHO_DUPLICATE_DATA_ERROR_CODE, ZOHO_FAILURE_ERROR_CODE, ZOHO_INTERNAL_ERROR_CODE, ZOHO_INVALID_AUTHORIZATION_ERROR_CODE, ZOHO_INVALID_DATA_ERROR_CODE, ZOHO_INVALID_QUERY_ERROR_CODE, ZOHO_MANDATORY_NOT_FOUND_ERROR_CODE, ZOHO_RATE_LIMIT_LIMIT_HEADER, ZOHO_RATE_LIMIT_REMAINING_HEADER, ZOHO_RATE_LIMIT_RESET_HEADER, ZOHO_RECRUIT_ALREADY_ASSOCIATED_ERROR_CODE, ZOHO_RECRUIT_CANDIDATES_MODULE, ZOHO_RECRUIT_JOB_OPENINGS_MODULE, ZOHO_RECRUIT_SERVICE_NAME, ZOHO_SUCCESS_CODE, ZOHO_TOO_MANY_REQUESTS_ERROR_CODE, ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE, ZohoAccountsAccessTokenError, ZohoAccountsAuthFailureError, ZohoInternalError, ZohoInvalidAuthorizationError, ZohoInvalidQueryError, ZohoRecruitExecuteRestApiFunctionError, ZohoRecruitRecordCrudDuplicateDataError, ZohoRecruitRecordCrudError, ZohoRecruitRecordCrudInvalidDataError, ZohoRecruitRecordCrudMandatoryFieldNotFoundError, ZohoRecruitRecordCrudNoMatchingRecordError, ZohoRecruitRecordNoContentError, ZohoServerError, ZohoServerFetchResponseError, ZohoTooManyRequestsError, accessToken, assertRecordDataArrayResultHasContent, associateCandidateRecordsWithJobOpenings, createNotes, createNotesForRecord, deleteNotes, emptyZohoPageResult, escapeZohoFieldValueForCriteriaString, executeRestApiFunction, getNotesForRecord, getNotesForRecordPageFactory, getRecordById, getRecords, handleZohoAccountsErrorFetch, handleZohoErrorFetchFactory, handleZohoRecruitErrorFetch, insertRecord, interceptZohoAccounts200StatusWithErrorResponse, interceptZohoErrorResponseFactory, interceptZohoRecruit200StatusWithErrorResponse, isZohoRecruitValidUrl, logZohoAccountsErrorToConsole, logZohoRecruitErrorToConsole, logZohoServerErrorFunction, parseZohoAccountsError, parseZohoAccountsServerErrorResponseData, parseZohoRecruitError, parseZohoRecruitServerErrorResponseData, parseZohoServerErrorResponseData, safeZohoDateTimeString, searchAssociatedRecords, searchCandidateAssociatedJobOpeningRecords, searchCandidateAssociatedJobOpeningRecordsPageFactory, searchJobOpeningAssociatedCandidateRecords, searchJobOpeningAssociatedCandidateRecordsPageFactory, searchRecords, searchRecordsPageFactory, tryFindZohoServerErrorData, updateRecord, upsertRecord, zohoAccessTokenStringFactory, zohoAccountsApiFetchJsonInput, zohoAccountsConfigApiUrl, zohoAccountsFactory, zohoAccountsZohoAccessTokenFactory, zohoDateTimeString, zohoFetchPageFactory, zohoRateLimitHeaderDetails, zohoRateLimitedFetchHandler, zohoRecruitApiFetchJsonInput, zohoRecruitConfigApiUrl, zohoRecruitFactory, zohoRecruitMultiRecordResult, zohoRecruitRecordCrudError, zohoRecruitSearchRecordsCriteriaEntriesForEmails, zohoRecruitSearchRecordsCriteriaEntryToCriteriaString, zohoRecruitSearchRecordsCriteriaString, zohoRecruitSearchRecordsCriteriaStringForTree, zohoRecruitUrlSearchParams, zohoRecruitUrlSearchParamsMinusIdAndModule, zohoRecruitUrlSearchParamsMinusModule, zohoServerErrorData };
+export { DEFAULT_ZOHO_API_RATE_LIMIT, DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD, DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION, MAX_ZOHO_RECRUIT_SEARCH_MODULE_RECORDS_CRITERIA, ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE, ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE, ZOHO_ACCOUNTS_US_API_URL, ZOHO_DUPLICATE_DATA_ERROR_CODE, ZOHO_ERROR_STATUS, ZOHO_FAILURE_ERROR_CODE, ZOHO_INTERNAL_ERROR_CODE, ZOHO_INVALID_AUTHORIZATION_ERROR_CODE, ZOHO_INVALID_DATA_ERROR_CODE, ZOHO_INVALID_QUERY_ERROR_CODE, ZOHO_MANDATORY_NOT_FOUND_ERROR_CODE, ZOHO_RATE_LIMIT_LIMIT_HEADER, ZOHO_RATE_LIMIT_REMAINING_HEADER, ZOHO_RATE_LIMIT_RESET_HEADER, ZOHO_RECRUIT_ALREADY_ASSOCIATED_ERROR_CODE, ZOHO_RECRUIT_CANDIDATES_MODULE, ZOHO_RECRUIT_JOB_OPENINGS_MODULE, ZOHO_RECRUIT_SERVICE_NAME, ZOHO_SUCCESS_CODE, ZOHO_SUCCESS_STATUS, ZOHO_TOO_MANY_REQUESTS_ERROR_CODE, ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE, ZohoAccountsAccessTokenError, ZohoAccountsAuthFailureError, ZohoInternalError, ZohoInvalidAuthorizationError, ZohoInvalidQueryError, ZohoRecruitExecuteRestApiFunctionError, ZohoRecruitRecordCrudDuplicateDataError, ZohoRecruitRecordCrudError, ZohoRecruitRecordCrudInvalidDataError, ZohoRecruitRecordCrudMandatoryFieldNotFoundError, ZohoRecruitRecordCrudNoMatchingRecordError, ZohoRecruitRecordNoContentError, ZohoServerError, ZohoServerFetchResponseError, ZohoTooManyRequestsError, accessToken, assertRecordDataArrayResultHasContent, associateCandidateRecordsWithJobOpenings, createNotes, createNotesForRecord, deleteNotes, deleteRecord, emptyZohoPageResult, escapeZohoFieldValueForCriteriaString, executeRestApiFunction, getNotesForRecord, getNotesForRecordPageFactory, getRecordById, getRecords, getRelatedRecordsFunctionFactory, handleZohoAccountsErrorFetch, handleZohoErrorFetchFactory, handleZohoRecruitErrorFetch, insertRecord, interceptZohoAccounts200StatusWithErrorResponse, interceptZohoErrorResponseFactory, interceptZohoRecruit200StatusWithErrorResponse, isZohoRecruitValidUrl, logZohoAccountsErrorToConsole, logZohoRecruitErrorToConsole, logZohoServerErrorFunction, parseZohoAccountsError, parseZohoAccountsServerErrorResponseData, parseZohoRecruitError, parseZohoRecruitServerErrorResponseData, parseZohoServerErrorResponseData, safeZohoDateTimeString, searchAssociatedRecords, searchCandidateAssociatedJobOpeningRecords, searchCandidateAssociatedJobOpeningRecordsPageFactory, searchJobOpeningAssociatedCandidateRecords, searchJobOpeningAssociatedCandidateRecordsPageFactory, searchRecords, searchRecordsPageFactory, tryFindZohoServerErrorData, updateRecord, upsertRecord, zohoAccessTokenStringFactory, zohoAccountsApiFetchJsonInput, zohoAccountsConfigApiUrl, zohoAccountsFactory, zohoAccountsZohoAccessTokenFactory, zohoDateTimeString, zohoFetchPageFactory, zohoRateLimitHeaderDetails, zohoRateLimitedFetchHandler, zohoRecruitApiFetchJsonInput, zohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs, zohoRecruitConfigApiUrl, zohoRecruitFactory, zohoRecruitMultiRecordResult, zohoRecruitRecordCrudError, zohoRecruitSearchRecordsCriteriaEntriesForEmails, zohoRecruitSearchRecordsCriteriaEntryToCriteriaString, zohoRecruitSearchRecordsCriteriaString, zohoRecruitSearchRecordsCriteriaStringForTree, zohoRecruitUrlSearchParams, zohoRecruitUrlSearchParamsMinusIdAndModule, zohoRecruitUrlSearchParamsMinusModule, zohoServerErrorData };

package/nestjs/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [12.1.12](https://github.com/dereekb/dbx-components/compare/v12.1.11...v12.1.12) (2025-06-19)
+
+
+
 ## [12.1.11](https://github.com/dereekb/dbx-components/compare/v12.1.10...v12.1.11) (2025-06-17)
 
 

package/nestjs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoho/nestjs",
-  "version": "12.1.11",
+  "version": "12.1.12",
   "type": "commonjs",
   "types": "./src/index.d.ts",
   "main": "./src/index.js"

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

@@ -11,6 +11,7 @@ export declare class ZohoRecruitApi {
     get insertRecord(): import("@dereekb/zoho").ZohoRecruitCreateRecordLikeFunction;
     get upsertRecord(): import("@dereekb/zoho").ZohoRecruitUpsertRecordLikeFunction;
     get updateRecord(): import("@dereekb/zoho").ZohoRecruitUpdateRecordLikeFunction;
+    get deleteRecord(): import("@dereekb/zoho").ZohoRecruitDeleteRecordFunction;
     get getRecordById(): import("@dereekb/zoho").ZohoRecruitGetRecordByIdFunction;
     get getRecords(): import("@dereekb/zoho").ZohoRecruitGetRecordsFunction;
     get searchRecords(): import("@dereekb/zoho").ZohoRecruitSearchRecordsFunction;

package/nestjs/src/lib/recruit/recruit.api.js

@@ -34,6 +34,9 @@ let ZohoRecruitApi = class ZohoRecruitApi {
     get updateRecord() {
         return (0, zoho_1.updateRecord)(this.recruitContext);
     }
+    get deleteRecord() {
+        return (0, zoho_1.deleteRecord)(this.recruitContext);
+    }
     get getRecordById() {
         return (0, zoho_1.getRecordById)(this.recruitContext);
     }

package/nestjs/src/lib/recruit/recruit.api.js.map

@@ -1 +1 @@
-{"version":3,"file":"recruit.api.js","sourceRoot":"","sources":["../../../../../../../packages/zoho/nestjs/src/lib/recruit/recruit.api.ts"],"names":[],"mappings":";;;;AAAA,2CAAoD;AACpD,wCAsBuB;AACvB,qDAA4D;AAC5D,2DAA2D;AAGpD,IAAM,cAAc,GAApB,MAAM,cAAc;IAYoB;IACT;IAZ3B,WAAW,CAAc;IAElC,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;IACzC,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,eAAe,CAAC;IACzD,CAAC;IAED,YAC6C,MAAgC,EACzC,eAAgC;QADvB,WAAM,GAAN,MAAM,CAA0B;QACzC,oBAAe,GAAf,eAAe,CAAiB;QAElE,IAAI,CAAC,WAAW,GAAG,IAAA,yBAAkB,EAAC;YACpC,GAAG,MAAM,CAAC,aAAa;YACvB,eAAe,EAAE,eAAe,CAAC,eAAe;SACjD,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACzB,CAAC;IAED,kBAAkB;IAClB,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAA,oBAAa,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAA,oBAAa,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,wBAAwB;QAC1B,OAAO,IAAA,+BAAwB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAA,kBAAW,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAA,kBAAW,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,oBAAoB;QACtB,OAAO,IAAA,2BAAoB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,IAAA,wBAAiB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAChD,CAAC;IAED,IAAI,4BAA4B;QAC9B,OAAO,IAAA,mCAA4B,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,sBAAsB;QACxB,OAAO,IAAA,6BAAsB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,wCAAwC;QAC1C,OAAO,IAAA,+CAAwC,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvE,CAAC;IAED,IAAI,0CAA0C;QAC5C,OAAO,IAAA,iDAA0C,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzE,CAAC;IAED,IAAI,qDAAqD;QACvD,OAAO,IAAA,4DAAqD,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACpF,CAAC;IAED,IAAI,0CAA0C;QAC5C,OAAO,IAAA,iDAA0C,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzE,CAAC;IAED,IAAI,qDAAqD;QACvD,OAAO,IAAA,4DAAqD,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACpF,CAAC;CACF,CAAA;AA7FY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAaR,mBAAA,IAAA,eAAM,EAAC,yCAAwB,CAAC,CAAA;IAChC,mBAAA,IAAA,eAAM,EAAC,8BAAe,CAAC,CAAA;6CAD2B,yCAAwB;QACxB,8BAAe;GAbzD,cAAc,CA6F1B"}
+{"version":3,"file":"recruit.api.js","sourceRoot":"","sources":["../../../../../../../packages/zoho/nestjs/src/lib/recruit/recruit.api.ts"],"names":[],"mappings":";;;;AAAA,2CAAoD;AACpD,wCAuBuB;AACvB,qDAA4D;AAC5D,2DAA2D;AAGpD,IAAM,cAAc,GAApB,MAAM,cAAc;IAYoB;IACT;IAZ3B,WAAW,CAAc;IAElC,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;IACzC,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,eAAe,CAAC;IACzD,CAAC;IAED,YAC6C,MAAgC,EACzC,eAAgC;QADvB,WAAM,GAAN,MAAM,CAA0B;QACzC,oBAAe,GAAf,eAAe,CAAiB;QAElE,IAAI,CAAC,WAAW,GAAG,IAAA,yBAAkB,EAAC;YACpC,GAAG,MAAM,CAAC,aAAa;YACvB,eAAe,EAAE,eAAe,CAAC,eAAe;SACjD,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACzB,CAAC;IAED,kBAAkB;IAClB,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAA,oBAAa,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAA,oBAAa,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,wBAAwB;QAC1B,OAAO,IAAA,+BAAwB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAA,kBAAW,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAA,kBAAW,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,oBAAoB;QACtB,OAAO,IAAA,2BAAoB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,iBAAiB;QACnB,OAAO,IAAA,wBAAiB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAChD,CAAC;IAED,IAAI,4BAA4B;QAC9B,OAAO,IAAA,mCAA4B,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3D,CAAC;IAED,IAAI,sBAAsB;QACxB,OAAO,IAAA,6BAAsB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,wCAAwC;QAC1C,OAAO,IAAA,+CAAwC,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACvE,CAAC;IAED,IAAI,0CAA0C;QAC5C,OAAO,IAAA,iDAA0C,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzE,CAAC;IAED,IAAI,qDAAqD;QACvD,OAAO,IAAA,4DAAqD,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACpF,CAAC;IAED,IAAI,0CAA0C;QAC5C,OAAO,IAAA,iDAA0C,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACzE,CAAC;IAED,IAAI,qDAAqD;QACvD,OAAO,IAAA,4DAAqD,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACpF,CAAC;CACF,CAAA;AAjGY,wCAAc;yBAAd,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAaR,mBAAA,IAAA,eAAM,EAAC,yCAAwB,CAAC,CAAA;IAChC,mBAAA,IAAA,eAAM,EAAC,8BAAe,CAAC,CAAA;6CAD2B,yCAAwB;QACxB,8BAAe;GAbzD,cAAc,CAiG1B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoho",
-  "version": "12.1.11",
+  "version": "12.1.12",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

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 { NewZohoRecruitNoteData, ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleNameRef, ZohoRecruitChangeObjectDetails, ZohoRecruitRecord, ZohoRecruitRecordId, ZohoRecruitRecordNote, ZohoRecruitTerritoryId, ZohoRecruitTrueFalseBoth, ZohoRecruitNoteId, ZohoRecruitRestFunctionApiName, ZohoRecruitUserId, ZohoRecruitModuleName } 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,6 +163,34 @@ 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 ZohoRecruitGetRelatedRecordsFunctionConfig {
+    readonly targetModule: ZohoRecruitModuleName;
+}
+export type ZohoRecruitGetRelatedRecordsFunctionFactory = <T extends 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 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 interface ZohoRecruitCreateNotesRequest {
     readonly data: ZohoRecruitCreateNotesRequestEntry[];
 }
@@ -154,13 +206,7 @@ export type ZohoRecruitDeleteNotesResult = ZohoRecruitMultiRecordResult<ZohoRecr
 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 {
-    /**
-     * @deprecated use variables on request instead of this filter.
-     */
-    readonly filter?: Maybe<ZohoRecruitGetNotesPageFilter>;
-}
+export type ZohoRecruitGetNotesForRecordRequest = ZohoRecruitGetRelatedRecordsRequest;
 export type ZohoRecruitGetNotesForRecordResponse = ZohoPageResult<ZohoRecruitRecordNote>;
 export type ZohoRecruitGetNotesForRecordFunction = (input: ZohoRecruitGetNotesForRecordRequest) => Promise<ZohoRecruitGetNotesForRecordResponse>;
 export declare function getNotesForRecord(context: ZohoRecruitContext): ZohoRecruitGetNotesForRecordFunction;
@@ -238,11 +284,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 +321,7 @@ export interface ZohoRecruitMultiRecordResultEntry<I, O> {
      */
     readonly result: O;
 }
+/**
+ * @deprecated use ZohoRecruitGetRelatedRecordsPageFilter instead.
+ */
+export type ZohoRecruitGetNotesPageFilter = ZohoRecruitGetRelatedRecordsPageFilter;

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
  *