@dereekb/zoho 12.1.11 → 12.1.13

package/index.cjs.js

@@ -1741,40 +1741,6 @@ $$2({ target: 'Iterator', proto: true, real: true }, {
   }
 });
 
-var call$2 = functionCall;
-var aCallable$1 = aCallable$7;
-var anObject$2 = anObject$e;
-var getIteratorDirect$2 = getIteratorDirect$5;
-var createIteratorProxy$1 = iteratorCreateProxy;
-var callWithSafeIterationClosing = callWithSafeIterationClosing$2;
-
-var IteratorProxy$1 = createIteratorProxy$1(function () {
-  var iterator = this.iterator;
-  var result = anObject$2(call$2(this.next, iterator));
-  var done = this.done = !!result.done;
-  if (!done) return callWithSafeIterationClosing(iterator, this.mapper, [result.value, this.counter++], true);
-});
-
-// `Iterator.prototype.map` method
-// https://github.com/tc39/proposal-iterator-helpers
-var iteratorMap = function map(mapper) {
-  anObject$2(this);
-  aCallable$1(mapper);
-  return new IteratorProxy$1(getIteratorDirect$2(this), {
-    mapper: mapper
-  });
-};
-
-var $$1 = _export;
-var map = iteratorMap;
-var IS_PURE$1 = isPure;
-
-// `Iterator.prototype.map` method
-// https://github.com/tc39/proposal-iterator-helpers
-$$1({ target: 'Iterator', proto: true, real: true, forced: IS_PURE$1 }, {
-  map: map
-});
-
 /**
  * Returns an empty ZohoPageResult that is typed to R and has no more records/results.
  */
@@ -1828,40 +1794,61 @@ function zohoRecruitConfigApiUrl(input) {
   }
 }
 
-var call$1 = functionCall;
-var anObject$1 = anObject$e;
-var getIteratorDirect$1 = getIteratorDirect$5;
+/**
+ * Candidates module name
+ */
+const ZOHO_RECRUIT_CANDIDATES_MODULE = 'Candidates';
+/**
+ * Job Openings module name
+ */
+const ZOHO_RECRUIT_JOB_OPENINGS_MODULE = 'Job_Openings';
+/**
+ * Notes module name
+ */
+const ZOHO_RECRUIT_NOTES_MODULE = 'Notes';
+/**
+ * Emails module name
+ */
+const ZOHO_RECRUIT_EMAILS_MODULE = 'Emails';
+/**
+ * Returns true if it is a valid ZohoRecruitValidUrl.
+ */
+const isZohoRecruitValidUrl = util.isStandardInternetAccessibleWebsiteUrl;
+
+var call$2 = functionCall;
+var anObject$2 = anObject$e;
+var getIteratorDirect$2 = getIteratorDirect$5;
 var getIteratorMethod = getIteratorMethod$3;
 
 var getIteratorFlattenable$1 = function (obj, stringHandling) {
-  if (!stringHandling || typeof obj !== 'string') anObject$1(obj);
+  if (!stringHandling || typeof obj !== 'string') anObject$2(obj);
   var method = getIteratorMethod(obj);
-  return getIteratorDirect$1(anObject$1(method !== undefined ? call$1(method, obj) : obj));
+  return getIteratorDirect$2(anObject$2(method !== undefined ? call$2(method, obj) : obj));
 };
 
-var $ = _export;
-var call = functionCall;
-var aCallable = aCallable$7;
-var anObject = anObject$e;
-var getIteratorDirect = getIteratorDirect$5;
+var $$1 = _export;
+var call$1 = functionCall;
+var aCallable$1 = aCallable$7;
+var anObject$1 = anObject$e;
+var getIteratorDirect$1 = getIteratorDirect$5;
 var getIteratorFlattenable = getIteratorFlattenable$1;
-var createIteratorProxy = iteratorCreateProxy;
+var createIteratorProxy$1 = iteratorCreateProxy;
 var iteratorClose = iteratorClose$4;
-var IS_PURE = isPure;
+var IS_PURE$1 = isPure;
 
-var IteratorProxy = createIteratorProxy(function () {
+var IteratorProxy$1 = createIteratorProxy$1(function () {
   var iterator = this.iterator;
   var mapper = this.mapper;
   var result, inner;
 
   while (true) {
     if (inner = this.inner) try {
-      result = anObject(call(inner.next, inner.iterator));
+      result = anObject$1(call$1(inner.next, inner.iterator));
       if (!result.done) return result.value;
       this.inner = null;
     } catch (error) { iteratorClose(iterator, 'throw', error); }
 
-    result = anObject(call(this.next, iterator));
+    result = anObject$1(call$1(this.next, iterator));
 
     if (this.done = !!result.done) return;
 
@@ -1873,17 +1860,51 @@ var IteratorProxy = createIteratorProxy(function () {
 
 // `Iterator.prototype.flatMap` method
 // https://github.com/tc39/proposal-iterator-helpers
-$({ target: 'Iterator', proto: true, real: true, forced: IS_PURE }, {
+$$1({ target: 'Iterator', proto: true, real: true, forced: IS_PURE$1 }, {
   flatMap: function flatMap(mapper) {
-    anObject(this);
-    aCallable(mapper);
-    return new IteratorProxy(getIteratorDirect(this), {
+    anObject$1(this);
+    aCallable$1(mapper);
+    return new IteratorProxy$1(getIteratorDirect$1(this), {
       mapper: mapper,
       inner: null
     });
   }
 });
 
+var call = functionCall;
+var aCallable = aCallable$7;
+var anObject = anObject$e;
+var getIteratorDirect = getIteratorDirect$5;
+var createIteratorProxy = iteratorCreateProxy;
+var callWithSafeIterationClosing = callWithSafeIterationClosing$2;
+
+var IteratorProxy = createIteratorProxy(function () {
+  var iterator = this.iterator;
+  var result = anObject(call(this.next, iterator));
+  var done = this.done = !!result.done;
+  if (!done) return callWithSafeIterationClosing(iterator, this.mapper, [result.value, this.counter++], true);
+});
+
+// `Iterator.prototype.map` method
+// https://github.com/tc39/proposal-iterator-helpers
+var iteratorMap = function map(mapper) {
+  anObject(this);
+  aCallable(mapper);
+  return new IteratorProxy(getIteratorDirect(this), {
+    mapper: mapper
+  });
+};
+
+var $ = _export;
+var map = iteratorMap;
+var IS_PURE = isPure;
+
+// `Iterator.prototype.map` method
+// https://github.com/tc39/proposal-iterator-helpers
+$({ target: 'Iterator', proto: true, real: true, forced: IS_PURE }, {
+  map: map
+});
+
 /**
  * Can search up to 10 criteria at a time.
  *
@@ -1974,6 +1995,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 +2383,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,43 +2459,30 @@ function searchRecords(context) {
 function searchRecordsPageFactory(context) {
   return zohoFetchPageFactory(searchRecords(context));
 }
-function createNotes(context) {
-  return input => context.fetchJson(`/v2/Notes`, zohoRecruitApiFetchJsonInput('POST', {
-    data: input.data
-  })).then(x => {
-    return zohoRecruitMultiRecordResult(util.asArray(input.data), x.data);
-  });
+/**
+ * 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,
+      returnEmptyRecordsInsteadOfNull = true
+    } = config;
+    return input => context.fetchJson(`/v2/${input.module}/${input.id}/${targetModule}?${zohoRecruitUrlSearchParamsMinusIdAndModule(input, input.filter).toString()}`, zohoRecruitApiFetchJsonInput('GET')).then(x => x ?? (returnEmptyRecordsInsteadOfNull !== false ? emptyZohoPageResult() : x));
+  };
 }
-function deleteNotes(context) {
-  return input => context.fetchJson(`/v2/Notes?${fetch.makeUrlSearchParams({
-    ids: input.ids
-  })}`, zohoRecruitApiFetchJsonInput('DELETE')).then(x => {
-    return zohoRecruitMultiRecordResult(util.asArray(input.ids), x.data);
+function getEmailsForRecord(context) {
+  return getRelatedRecordsFunctionFactory(context)({
+    targetModule: ZOHO_RECRUIT_EMAILS_MODULE
   });
 }
-function getNotesForRecord(context) {
-  return input => context.fetchJson(`/v2/${input.module}/${input.id}/Notes?${zohoRecruitUrlSearchParamsMinusIdAndModule(input, input.filter).toString()}`, zohoRecruitApiFetchJsonInput('GET'));
-}
-function getNotesForRecordPageFactory(context) {
-  return zohoFetchPageFactory(getNotesForRecord(context));
-}
-function createNotesForRecord(context) {
-  const createNotesInstance = createNotes(context);
-  return input => {
-    const {
-      module: se_module,
-      id: Parent_Id,
-      notes
-    } = input;
-    const createNotesRequest = {
-      data: util.asArray(notes).map(x => ({
-        ...x,
-        se_module,
-        Parent_Id
-      }))
-    };
-    return createNotesInstance(createNotesRequest);
-  };
+function getEmailsForRecordPageFactory(context) {
+  return zohoFetchPageFactory(getEmailsForRecord(context));
 }
 class ZohoRecruitExecuteRestApiFunctionError extends makeError.BaseError {
   constructor(error) {
@@ -2506,12 +2542,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
@@ -2530,19 +2586,6 @@ function zohoRecruitMultiRecordResult(input, results) {
   return result;
 }
 
-/**
- * Candidates module name
- */
-const ZOHO_RECRUIT_CANDIDATES_MODULE = 'Candidates';
-/**
- * Job Openings module name
- */
-const ZOHO_RECRUIT_JOB_OPENINGS_MODULE = 'Job_Openings';
-/**
- * Returns true if it is a valid ZohoRecruitValidUrl.
- */
-const isZohoRecruitValidUrl = util.isStandardInternetAccessibleWebsiteUrl;
-
 /**
  * Associates one or more candidates with one or more job openings.
  *
@@ -2604,6 +2647,109 @@ function searchJobOpeningAssociatedCandidateRecordsPageFactory(context) {
   return zohoFetchPageFactory(searchJobOpeningAssociatedCandidateRecords(context));
 }
 
+function createNotes(context) {
+  return input => context.fetchJson(`/v2/${ZOHO_RECRUIT_NOTES_MODULE}`, zohoRecruitApiFetchJsonInput('POST', {
+    data: input.data
+  })).then(x => {
+    return zohoRecruitMultiRecordResult(util.asArray(input.data), x.data);
+  });
+}
+function deleteNotes(context) {
+  return input => context.fetchJson(`/v2/${ZOHO_RECRUIT_NOTES_MODULE}?${fetch.makeUrlSearchParams({
+    ids: input.ids
+  })}`, zohoRecruitApiFetchJsonInput('DELETE')).then(x => {
+    return zohoRecruitMultiRecordResult(util.asArray(input.ids), x.data);
+  });
+}
+function getNotesForRecord(context) {
+  return getRelatedRecordsFunctionFactory(context)({
+    targetModule: ZOHO_RECRUIT_NOTES_MODULE
+  });
+}
+function getNotesForRecordPageFactory(context) {
+  return zohoFetchPageFactory(getNotesForRecord(context));
+}
+function createNotesForRecord(context) {
+  const createNotesInstance = createNotes(context);
+  return input => {
+    const {
+      module: se_module,
+      id: Parent_Id,
+      notes
+    } = input;
+    const createNotesRequest = {
+      data: util.asArray(notes).map(x => ({
+        ...x,
+        se_module,
+        Parent_Id
+      }))
+    };
+    return createNotesInstance(createNotesRequest);
+  };
+}
+
+function createTagsForModule(context) {
+  return input => context.fetchJson(`/v2/settings/tags?${fetch.makeUrlSearchParams({
+    module: input.module
+  })}`, zohoRecruitApiFetchJsonInput('POST', {
+    tags: util.asArray(input.tags)
+  })).then(x => {
+    const result = zohoRecruitMultiRecordResult(util.asArray(input.tags), x.tags);
+    const {
+      included: duplicateErrorItems,
+      excluded: otherErrorItems
+    } = util.separateValues(result.errorItems, x => {
+      return x.result.code === ZOHO_DUPLICATE_DATA_ERROR_CODE;
+    });
+    return {
+      ...result,
+      errorItems: otherErrorItems,
+      duplicateErrorItems,
+      allErrorItems: result.errorItems
+    };
+  });
+}
+/**
+ * Returns the list of tags within a module.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/get-tag-list.html
+ *
+ * @param context
+ * @returns
+ */
+function getTagsForModule(context) {
+  return input => context.fetchJson(`/v2/settings/tags?${fetch.makeUrlSearchParams({
+    module: input.module,
+    my_tags: input.my_tags
+  })}`, zohoRecruitApiFetchJsonInput('GET')).then(x => {
+    // NOTE: This doesn't follow the api documentation, and instead is a normal page result except it has "tags" instead of "data".
+    return {
+      ...x,
+      data: x.tags
+    };
+  });
+}
+function getTagsForModulePageFactory(context) {
+  return zohoFetchPageFactory(getTagsForModule(context));
+}
+/**
+ * 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
+ */
+function addTagsToRecords(context) {
+  return input => context.fetchJson(`/v2/${ZOHO_RECRUIT_CANDIDATES_MODULE}/actions/add_tags?${fetch.makeUrlSearchParams({
+    tag_names: input.tag_names,
+    ids: input.ids
+  })}`, zohoRecruitApiFetchJsonInput('POST')).then(x => {
+    const resultInputMap = x.data.map(() => input); // assign "input" to each value for now
+    return zohoRecruitMultiRecordResult(resultInputMap, x.data);
+  });
+}
+
 /**
  * Creates a ZohoRecruitSearchRecordsCriteriaEntryArray from an array of emails.
  *
@@ -2802,6 +2948,11 @@ function zohoRecruitFactory(factoryConfig) {
   };
 }
 
+/**
+ * Maximum length of ZohoRecruitTagName
+ */
+const ZOHO_RECRUIT_TAG_NAME_MAX_LENGTH = 25;
+
 /**
  * Trades a refresh token for a new AccessToken
  * @param context
@@ -2978,6 +3129,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;
@@ -2989,9 +3141,13 @@ exports.ZOHO_RATE_LIMIT_REMAINING_HEADER = ZOHO_RATE_LIMIT_REMAINING_HEADER;
 exports.ZOHO_RATE_LIMIT_RESET_HEADER = ZOHO_RATE_LIMIT_RESET_HEADER;
 exports.ZOHO_RECRUIT_ALREADY_ASSOCIATED_ERROR_CODE = ZOHO_RECRUIT_ALREADY_ASSOCIATED_ERROR_CODE;
 exports.ZOHO_RECRUIT_CANDIDATES_MODULE = ZOHO_RECRUIT_CANDIDATES_MODULE;
+exports.ZOHO_RECRUIT_EMAILS_MODULE = ZOHO_RECRUIT_EMAILS_MODULE;
 exports.ZOHO_RECRUIT_JOB_OPENINGS_MODULE = ZOHO_RECRUIT_JOB_OPENINGS_MODULE;
+exports.ZOHO_RECRUIT_NOTES_MODULE = ZOHO_RECRUIT_NOTES_MODULE;
 exports.ZOHO_RECRUIT_SERVICE_NAME = ZOHO_RECRUIT_SERVICE_NAME;
+exports.ZOHO_RECRUIT_TAG_NAME_MAX_LENGTH = ZOHO_RECRUIT_TAG_NAME_MAX_LENGTH;
 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;
@@ -3010,18 +3166,26 @@ exports.ZohoServerError = ZohoServerError;
 exports.ZohoServerFetchResponseError = ZohoServerFetchResponseError;
 exports.ZohoTooManyRequestsError = ZohoTooManyRequestsError;
 exports.accessToken = accessToken;
+exports.addTagsToRecords = addTagsToRecords;
 exports.assertRecordDataArrayResultHasContent = assertRecordDataArrayResultHasContent;
 exports.associateCandidateRecordsWithJobOpenings = associateCandidateRecordsWithJobOpenings;
 exports.createNotes = createNotes;
 exports.createNotesForRecord = createNotesForRecord;
+exports.createTagsForModule = createTagsForModule;
 exports.deleteNotes = deleteNotes;
+exports.deleteRecord = deleteRecord;
 exports.emptyZohoPageResult = emptyZohoPageResult;
 exports.escapeZohoFieldValueForCriteriaString = escapeZohoFieldValueForCriteriaString;
 exports.executeRestApiFunction = executeRestApiFunction;
+exports.getEmailsForRecord = getEmailsForRecord;
+exports.getEmailsForRecordPageFactory = getEmailsForRecordPageFactory;
 exports.getNotesForRecord = getNotesForRecord;
 exports.getNotesForRecordPageFactory = getNotesForRecordPageFactory;
 exports.getRecordById = getRecordById;
 exports.getRecords = getRecords;
+exports.getRelatedRecordsFunctionFactory = getRelatedRecordsFunctionFactory;
+exports.getTagsForModule = getTagsForModule;
+exports.getTagsForModulePageFactory = getTagsForModulePageFactory;
 exports.handleZohoAccountsErrorFetch = handleZohoAccountsErrorFetch;
 exports.handleZohoErrorFetchFactory = handleZohoErrorFetchFactory;
 exports.handleZohoRecruitErrorFetch = handleZohoRecruitErrorFetch;
@@ -3059,6 +3223,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;