@dereekb/zoho 11.0.15 → 11.0.16

package/index.cjs.js

@@ -1208,6 +1208,18 @@ function zohoFetchPageFactory(fetch$1, defaults) {
   }));
 }
 
+const ZOHO_RECRUIT_SERVICE_NAME = 'recruit';
+function zohoRecruitConfigApiUrl(input) {
+  switch (input) {
+    case 'sandbox':
+      return 'https://recruitsandbox.zoho.com/recruit';
+    case 'production':
+      return 'https://recruit.zoho.com/recruit';
+    default:
+      return input;
+  }
+}
+
 var classof$3 = classofRaw$2;
 
 // `IsArray` abstract operation
@@ -3248,6 +3260,42 @@ function createNotesForRecord(context) {
     return createNotesInstance(createNotesRequest);
   };
 }
+class ZohoRecruitExecuteRestApiFunctionError extends makeError.BaseError {
+  constructor(error) {
+    super(`An error occured during the execution of the function. Code: ${error.code}, Message: ${error.message}`);
+    this.error = void 0;
+    this.error = error;
+  }
+}
+/**
+ * Creates a ZohoRecruitExecuteRestApiFunctionFunction
+ *
+ * OAuth Details:
+ * - https://www.zoho.com/crm/developer/docs/functions/serverless-fn-oauth.html#OAuth2
+ * - There is no documentation for ZohoRecruit specifically, but it seems to behave the same way
+ * - You will need the following scopes: ZohoRecruit.functions.execute.READ,ZohoRecruit.functions.execute.CREATE
+ *
+ * @param context
+ * @returns
+ */
+function executeRestApiFunction(context) {
+  return input => {
+    const inputSearchParams = fetch.makeUrlSearchParams(input.params);
+    const inputSearchParamsString = inputSearchParams.toString();
+    const isSpecificRequest = Boolean(input.apiKey);
+    const urlParams = (isSpecificRequest ? `auth_type=apikey&zapikey=${input.apiKey}` : 'auth_type=oauth') + (inputSearchParamsString ? `&${inputSearchParamsString}` : '');
+    const relativeUrl = `/v2/functions/${input.functionName}/actions/execute?${urlParams}`;
+    const baseUrl = isSpecificRequest && input.apiUrl != null ? zohoRecruitConfigApiUrl(input.apiUrl) : '';
+    const url = `${baseUrl}${relativeUrl}`;
+    return context.fetchJson(url, zohoRecruitApiFetchJsonInput('POST')).then(x => {
+      if (x.code === 'success') {
+        return x.details;
+      } else {
+        throw new ZohoRecruitExecuteRestApiFunctionError(x);
+      }
+    });
+  };
+}
 // MARK: Util
 function zohoRecruitUrlSearchParamsMinusModule(...input) {
   return fetch.makeUrlSearchParams(input, {
@@ -3266,7 +3314,7 @@ const zohoRecruitUrlSearchParams = fetch.makeUrlSearchParams;
 function zohoRecruitApiFetchJsonInput(method, body) {
   const result = {
     method,
-    body
+    body: body != null ? body : undefined
   };
   return result;
 }
@@ -3294,18 +3342,6 @@ function zohoRecruitMultiRecordResult(input, results) {
   return result;
 }
 
-const ZOHO_RECRUIT_SERVICE_NAME = 'recruit';
-function zohoRecruitConfigApiUrl(input) {
-  switch (input) {
-    case 'sandbox':
-      return 'https://recruitsandbox.zoho.com/recruit';
-    case 'production':
-      return 'https://recruit.zoho.com/recruit/';
-    default:
-      return input;
-  }
-}
-
 /**
  * Error in the following cases:
  * - the refresh token string is invalid
@@ -3421,9 +3457,9 @@ function zohoRateLimitedFetchHandler(config) {
   function configForLimit(limit, resetAt) {
     return {
       limit: defaultLimit,
-      startLimitAt: Math.ceil(limit / 20),
-      cooldownRate: 1.1 * (limit / (defaultResetPeriod / util.MS_IN_SECOND)),
-      exponentRate: 1.1,
+      startLimitAt: Math.ceil(limit / 10),
+      cooldownRate: 1.2 * (limit / (defaultResetPeriod / util.MS_IN_SECOND)),
+      exponentRate: 1.08,
       maxWaitTime: util.MS_IN_SECOND * 10,
       resetPeriod: defaultResetPeriod,
       resetAt
@@ -3805,6 +3841,7 @@ exports.ZohoAccountsAuthFailureError = ZohoAccountsAuthFailureError;
 exports.ZohoInternalError = ZohoInternalError;
 exports.ZohoInvalidAuthorizationError = ZohoInvalidAuthorizationError;
 exports.ZohoInvalidQueryError = ZohoInvalidQueryError;
+exports.ZohoRecruitExecuteRestApiFunctionError = ZohoRecruitExecuteRestApiFunctionError;
 exports.ZohoRecruitRecordCrudDuplicateDataError = ZohoRecruitRecordCrudDuplicateDataError;
 exports.ZohoRecruitRecordCrudError = ZohoRecruitRecordCrudError;
 exports.ZohoRecruitRecordCrudInvalidDataError = ZohoRecruitRecordCrudInvalidDataError;
@@ -3820,6 +3857,7 @@ exports.createNotes = createNotes;
 exports.createNotesForRecord = createNotesForRecord;
 exports.deleteNotes = deleteNotes;
 exports.escapeZohoFieldValueForCriteriaString = escapeZohoFieldValueForCriteriaString;
+exports.executeRestApiFunction = executeRestApiFunction;
 exports.getNotesForRecord = getNotesForRecord;
 exports.getNotesForRecordPageFactory = getNotesForRecordPageFactory;
 exports.getRecordById = getRecordById;

package/index.esm.js

@@ -1222,6 +1222,18 @@ function zohoFetchPageFactory(fetch, defaults) {
   }));
 }
 
+const ZOHO_RECRUIT_SERVICE_NAME = 'recruit';
+function zohoRecruitConfigApiUrl(input) {
+  switch (input) {
+    case 'sandbox':
+      return 'https://recruitsandbox.zoho.com/recruit';
+    case 'production':
+      return 'https://recruit.zoho.com/recruit';
+    default:
+      return input;
+  }
+}
+
 var classof$3 = classofRaw$2;
 
 // `IsArray` abstract operation
@@ -1556,6 +1568,10 @@ const ZOHO_RECRUIT_CANDIDATES_MODULE = 'Candidates';
  * Contains a reference to a module.
  */
 
+/**
+ * The API name of a function that is accessible via the Recruit REST API
+ */
+
 /**
  * An identifier in Zoho Recruit.
  */
@@ -1572,6 +1588,12 @@ const ZOHO_RECRUIT_CANDIDATES_MODULE = 'Candidates';
  * Example "576214000000820595"
  */
 
+/**
+ * Zoho Recruit user identifier.
+ *
+ * Users can be found in the Users and Controls section in settings.
+ */
+
 /**
  * Zoho Recruit custom view id
  */
@@ -1588,6 +1610,10 @@ const ZOHO_RECRUIT_CANDIDATES_MODULE = 'Candidates';
  * Comma separated list of field names
  */
 
+/**
+ * Reference pair of a Zoho Recruit user name and id
+ */
+
 /**
  * Zoho Recruit only allows URLs that can be resolved via the internet (I.E. uses a normal tdl)
  *
@@ -3352,6 +3378,51 @@ function createNotesForRecord(context) {
   };
 }
 
+// MARK: Function
+
+class ZohoRecruitExecuteRestApiFunctionError extends BaseError {
+  constructor(error) {
+    super(`An error occured during the execution of the function. Code: ${error.code}, Message: ${error.message}`);
+    this.error = error;
+  }
+}
+
+/**
+ * Executes the Zoho Recruit function based on the input.
+ *
+ * If the function fails execution a ZohoRecruitExecuteRestApiFunctionError will be thrown. Other API errors may still be thrown.
+ */
+
+/**
+ * Creates a ZohoRecruitExecuteRestApiFunctionFunction
+ *
+ * OAuth Details:
+ * - https://www.zoho.com/crm/developer/docs/functions/serverless-fn-oauth.html#OAuth2
+ * - There is no documentation for ZohoRecruit specifically, but it seems to behave the same way
+ * - You will need the following scopes: ZohoRecruit.functions.execute.READ,ZohoRecruit.functions.execute.CREATE
+ *
+ * @param context
+ * @returns
+ */
+function executeRestApiFunction(context) {
+  return input => {
+    const inputSearchParams = makeUrlSearchParams(input.params);
+    const inputSearchParamsString = inputSearchParams.toString();
+    const isSpecificRequest = Boolean(input.apiKey);
+    const urlParams = (isSpecificRequest ? `auth_type=apikey&zapikey=${input.apiKey}` : 'auth_type=oauth') + (inputSearchParamsString ? `&${inputSearchParamsString}` : '');
+    const relativeUrl = `/v2/functions/${input.functionName}/actions/execute?${urlParams}`;
+    const baseUrl = isSpecificRequest && input.apiUrl != null ? zohoRecruitConfigApiUrl(input.apiUrl) : '';
+    const url = `${baseUrl}${relativeUrl}`;
+    return context.fetchJson(url, zohoRecruitApiFetchJsonInput('POST')).then(x => {
+      if (x.code === 'success') {
+        return x.details;
+      } else {
+        throw new ZohoRecruitExecuteRestApiFunctionError(x);
+      }
+    });
+  };
+}
+
 // MARK: Util
 function zohoRecruitUrlSearchParamsMinusModule(...input) {
   return makeUrlSearchParams(input, {
@@ -3371,7 +3442,7 @@ const zohoRecruitUrlSearchParams = makeUrlSearchParams;
 function zohoRecruitApiFetchJsonInput(method, body) {
   const result = {
     method,
-    body
+    body: body != null ? body : undefined
   };
   return result;
 }
@@ -3417,18 +3488,6 @@ function zohoRecruitMultiRecordResult(input, results) {
  * @deprecated use ZohoRecruitChangeObjectResponseErrorEntry instead.
  */
 
-const ZOHO_RECRUIT_SERVICE_NAME = 'recruit';
-function zohoRecruitConfigApiUrl(input) {
-  switch (input) {
-    case 'sandbox':
-      return 'https://recruitsandbox.zoho.com/recruit';
-    case 'production':
-      return 'https://recruit.zoho.com/recruit/';
-    default:
-      return input;
-  }
-}
-
 /**
  * Error in the following cases:
  * - the refresh token string is invalid
@@ -3559,10 +3618,10 @@ function zohoRateLimitedFetchHandler(config) {
   function configForLimit(limit, resetAt) {
     return {
       limit: defaultLimit,
-      startLimitAt: Math.ceil(limit / 20),
-      // can do 5% of the requests of the limit before rate limiting begins
-      cooldownRate: 1.1 * (limit / (defaultResetPeriod / MS_IN_SECOND)),
-      exponentRate: 1.1,
+      startLimitAt: Math.ceil(limit / 10),
+      // can do 10% of the requests of the limit before rate limiting begins
+      cooldownRate: 1.2 * (limit / (defaultResetPeriod / MS_IN_SECOND)),
+      exponentRate: 1.08,
       maxWaitTime: MS_IN_SECOND * 10,
       resetPeriod: defaultResetPeriod,
       resetAt
@@ -3865,4 +3924,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, ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE, ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE, ZOHO_ACCOUNTS_US_API_URL, ZOHO_DUPLICATE_DATA_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_CANDIDATES_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, ZohoRecruitRecordCrudDuplicateDataError, ZohoRecruitRecordCrudError, ZohoRecruitRecordCrudInvalidDataError, ZohoRecruitRecordCrudMandatoryFieldNotFoundError, ZohoRecruitRecordCrudNoMatchingRecordError, ZohoRecruitRecordNoContentError, ZohoServerError, ZohoServerFetchResponseError, ZohoTooManyRequestsError, accessToken, assertRecordDataArrayResultHasContent, createNotes, createNotesForRecord, deleteNotes, escapeZohoFieldValueForCriteriaString, getNotesForRecord, getNotesForRecordPageFactory, getRecordById, getRecords, handleZohoAccountsErrorFetch, handleZohoErrorFetchFactory, handleZohoRecruitErrorFetch, insertRecord, interceptZohoAccountsErrorResponse, interceptZohoErrorResponseFactory, interceptZohoRecruitErrorResponse, isZohoRecruitValidUrl, logZohoAccountsErrorToConsole, logZohoRecruitErrorToConsole, logZohoServerErrorFunction, parseZohoAccountsError, parseZohoAccountsServerErrorResponseData, parseZohoRecruitError, parseZohoRecruitServerErrorResponseData, parseZohoServerErrorResponseData, safeZohoDateTimeString, searchRecords, searchRecordsPageFactory, tryFindZohoServerErrorData, updateRecord, upsertRecord, zohoAccessTokenStringFactory, zohoAccountsApiFetchJsonInput, zohoAccountsConfigApiUrl, zohoAccountsFactory, zohoAccountsZohoAccessTokenFactory, zohoDateTimeString, zohoFetchPageFactory, zohoRateLimitHeaderDetails, zohoRateLimitedFetchHandler, zohoRecruitApiFetchJsonInput, zohoRecruitConfigApiUrl, zohoRecruitFactory, zohoRecruitMultiRecordResult, zohoRecruitRecordCrudError, 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, ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE, ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE, ZOHO_ACCOUNTS_US_API_URL, ZOHO_DUPLICATE_DATA_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_CANDIDATES_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, createNotes, createNotesForRecord, deleteNotes, escapeZohoFieldValueForCriteriaString, executeRestApiFunction, getNotesForRecord, getNotesForRecordPageFactory, getRecordById, getRecords, handleZohoAccountsErrorFetch, handleZohoErrorFetchFactory, handleZohoRecruitErrorFetch, insertRecord, interceptZohoAccountsErrorResponse, interceptZohoErrorResponseFactory, interceptZohoRecruitErrorResponse, isZohoRecruitValidUrl, logZohoAccountsErrorToConsole, logZohoRecruitErrorToConsole, logZohoServerErrorFunction, parseZohoAccountsError, parseZohoAccountsServerErrorResponseData, parseZohoRecruitError, parseZohoRecruitServerErrorResponseData, parseZohoServerErrorResponseData, safeZohoDateTimeString, searchRecords, searchRecordsPageFactory, tryFindZohoServerErrorData, updateRecord, upsertRecord, zohoAccessTokenStringFactory, zohoAccountsApiFetchJsonInput, zohoAccountsConfigApiUrl, zohoAccountsFactory, zohoAccountsZohoAccessTokenFactory, zohoDateTimeString, zohoFetchPageFactory, zohoRateLimitHeaderDetails, zohoRateLimitedFetchHandler, zohoRecruitApiFetchJsonInput, zohoRecruitConfigApiUrl, zohoRecruitFactory, zohoRecruitMultiRecordResult, zohoRecruitRecordCrudError, 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).
 
+## [11.0.16](https://github.com/dereekb/dbx-components/compare/v11.0.15-dev...v11.0.16) (2024-12-05)
+
+
+
 ## [11.0.15](https://github.com/dereekb/dbx-components/compare/v11.0.14-dev...v11.0.15) (2024-11-29)
 
 

package/nestjs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/zoho/nestjs",
-  "version": "11.0.15",
+  "version": "11.0.16",
   "type": "commonjs",
   "main": "./src/index.js"
 }

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

@@ -19,4 +19,5 @@ export declare class ZohoRecruitApi {
     get deleteNotes(): (input: import("@dereekb/zoho").ZohoRecruitDeleteNotesRequest) => Promise<import("@dereekb/zoho").ZohoRecruitMultiRecordResult<string, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoRecruitChangeObjectDetails>, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseErrorEntry>>;
     get createNotesForRecord(): import("@dereekb/zoho").ZohoRecruitCreateNotesForRecordFunction;
     get getNotesForRecord(): import("@dereekb/zoho").ZohoRecruitGetNotesForRecordFunction;
+    get executeRestApiFunction(): import("@dereekb/zoho").ZohoRecruitExecuteRestApiFunctionFunction;
 }

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

@@ -58,6 +58,9 @@ let ZohoRecruitApi = exports.ZohoRecruitApi = class ZohoRecruitApi {
     get getNotesForRecord() {
         return (0, zoho_1.getNotesForRecord)(this.recruitContext);
     }
+    get executeRestApiFunction() {
+        return (0, zoho_1.executeRestApiFunction)(this.recruitContext);
+    }
 };
 exports.ZohoRecruitApi = ZohoRecruitApi = tslib_1.__decorate([
     (0, common_1.Injectable)(),

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,wCAAqQ;AACrQ,qDAA4D;AAC5D,2DAA2D;AAGpD,IAAM,cAAc,4BAApB,MAAM,cAAc;IAW8B;IAAoE;IAVlH,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,YAAuD,MAAgC,EAAoC,eAAgC;QAApG,WAAM,GAAN,MAAM,CAA0B;QAAoC,oBAAe,GAAf,eAAe,CAAiB;QACzJ,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;CACF,CAAA;yBA9DY,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAYE,mBAAA,IAAA,eAAM,EAAC,yCAAwB,CAAC,CAAA;IAA6C,mBAAA,IAAA,eAAM,EAAC,8BAAe,CAAC,CAAA;6CAAlD,yCAAwB,EAAqD,8BAAe;GAXhJ,cAAc,CA8D1B"}
+{"version":3,"file":"recruit.api.js","sourceRoot":"","sources":["../../../../../../../packages/zoho/nestjs/src/lib/recruit/recruit.api.ts"],"names":[],"mappings":";;;;AAAA,2CAAoD;AACpD,wCAA6R;AAC7R,qDAA4D;AAC5D,2DAA2D;AAGpD,IAAM,cAAc,4BAApB,MAAM,cAAc;IAW8B;IAAoE;IAVlH,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,YAAuD,MAAgC,EAAoC,eAAgC;QAApG,WAAM,GAAN,MAAM,CAA0B;QAAoC,oBAAe,GAAf,eAAe,CAAiB;QACzJ,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,sBAAsB;QACxB,OAAO,IAAA,6BAAsB,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACrD,CAAC;CACF,CAAA;yBAlEY,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAYE,mBAAA,IAAA,eAAM,EAAC,yCAAwB,CAAC,CAAA;IAA6C,mBAAA,IAAA,eAAM,EAAC,8BAAe,CAAC,CAAA;6CAAlD,yCAAwB,EAAqD,8BAAe;GAXhJ,cAAc,CAkE1B"}

package/package.json

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

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

@@ -1,9 +1,11 @@
 import { ZohoDataArrayResultRef, ZohoPageFilter, ZohoPageResult } from './../zoho.api.page';
 import { FetchJsonBody, FetchJsonInput, FetchPage, FetchPageFactory, FetchPageFactoryOptions, makeUrlSearchParams } from '@dereekb/util/fetch';
-import { ZohoRecruitContext } from './recruit.config';
-import { NewZohoRecruitNoteData, ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleNameRef, ZohoRecruitChangeObjectDetails, ZohoRecruitRecord, ZohoRecruitRecordId, ZohoRecruitRecordNote, ZohoRecruitSearchRecordsCriteriaTreeElement, ZohoRecruitTerritoryId, ZohoRecruitTrueFalseBoth, ZohoRecruitNoteId } from './recruit';
+import { ZohoRecruitConfigApiUrlInput, ZohoRecruitContext } from './recruit.config';
+import { NewZohoRecruitNoteData, ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleNameRef, ZohoRecruitChangeObjectDetails, ZohoRecruitRecord, ZohoRecruitRecordId, ZohoRecruitRecordNote, ZohoRecruitSearchRecordsCriteriaTreeElement, ZohoRecruitTerritoryId, ZohoRecruitTrueFalseBoth, ZohoRecruitNoteId, ZohoRecruitRestFunctionApiName, ZohoRecruitUserId } from './recruit';
 import { ArrayOrValue, EmailAddress, Maybe, PhoneNumber, SortingOrder, UniqueModelWithId } from '@dereekb/util';
 import { ZohoServerErrorDataWithDetails, ZohoServerErrorStatus, ZohoServerSuccessCode, ZohoServerSuccessStatus } from '../zoho.error.api';
+import { ZohoDateTimeString } from '../zoho.type';
+import { BaseError } from 'make-error';
 export type ZohoRecruitUpdateRecordResult<T> = ZohoRecruitMultiRecordResult<T, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
 export type ZohoRecruitUpdateRecordResponse = ZohoRecruitChangeObjectResponse;
 export type ZohoRecruitCreateRecordData<T> = Omit<T, 'id'>;
@@ -166,13 +168,70 @@ export interface ZohoRecruitCreateNotesForRecordRequest extends ZohoRecruitModul
 }
 export type ZohoRecruitCreateNotesForRecordFunction = (input: ZohoRecruitCreateNotesForRecordRequest) => Promise<ZohoRecruitCreateNotesResult>;
 export declare function createNotesForRecord(context: ZohoRecruitContext): ZohoRecruitCreateNotesForRecordFunction;
+export type ZohoRecruitExecuteRestApiFunctionRequest = ZohoRecruitExecuteRestApiFunctionNormalRequest | ZohoRecruitExecuteRestApiFunctionApiSpecificRequest;
+export interface ZohoRecruitExecuteRestApiFunctionNormalRequest {
+    readonly functionName: ZohoRecruitRestFunctionApiName;
+    readonly params?: Maybe<ZohoRecruitExecuteRestApiFunctionParams>;
+}
+export interface ZohoRecruitExecuteRestApiFunctionApiSpecificRequest extends ZohoRecruitExecuteRestApiFunctionNormalRequest {
+    /**
+     * If provided the function will use the API key provided instead of the internal oauth
+     */
+    readonly apiKey: Maybe<ZohoRecruitRestFunctionApiKey>;
+    /**
+     * If provided, the function will target the given API and not the default. Only used when apiKey is provided.
+     *
+     * Careful when using this, as it might indicate that the target is not environment specific/aware.
+     */
+    readonly apiUrl?: ZohoRecruitConfigApiUrlInput;
+}
+export type ZohoRecruitRestFunctionApiKey = string;
+export type ZohoRecruitExecuteRestApiFunctionParams = Record<string, string | number | boolean | ZohoDateTimeString>;
+export type ZohoRecruitExecuteRestApiFunctionResponse = ZohoRecruitExecuteRestApiFunctionSuccessResponse | ZohoRecruitExecuteRestApiFunctionErrorResponse;
+export interface ZohoRecruitExecuteRestApiFunctionSuccessResponse {
+    readonly code: 'success';
+    readonly details: ZohoRecruitExecuteRestApiFunctionSuccessDetails;
+    readonly message: string;
+}
+export interface ZohoRecruitExecuteRestApiFunctionSuccessDetails {
+    readonly userMessage: string[];
+    readonly output_type: string;
+    readonly id: ZohoRecruitUserId;
+}
+export interface ZohoRecruitExecuteRestApiFunctionErrorResponse {
+    readonly code: string;
+    readonly details: unknown;
+    readonly message: string;
+}
+export declare class ZohoRecruitExecuteRestApiFunctionError extends BaseError {
+    readonly error: ZohoRecruitExecuteRestApiFunctionErrorResponse;
+    constructor(error: ZohoRecruitExecuteRestApiFunctionErrorResponse);
+}
+/**
+ * Executes the Zoho Recruit function based on the input.
+ *
+ * If the function fails execution a ZohoRecruitExecuteRestApiFunctionError will be thrown. Other API errors may still be thrown.
+ */
+export type ZohoRecruitExecuteRestApiFunctionFunction = (input: ZohoRecruitExecuteRestApiFunctionRequest) => Promise<ZohoRecruitExecuteRestApiFunctionSuccessDetails>;
+/**
+ * Creates a ZohoRecruitExecuteRestApiFunctionFunction
+ *
+ * OAuth Details:
+ * - https://www.zoho.com/crm/developer/docs/functions/serverless-fn-oauth.html#OAuth2
+ * - There is no documentation for ZohoRecruit specifically, but it seems to behave the same way
+ * - You will need the following scopes: ZohoRecruit.functions.execute.READ,ZohoRecruit.functions.execute.CREATE
+ *
+ * @param context
+ * @returns
+ */
+export declare function executeRestApiFunction(context: ZohoRecruitContext): ZohoRecruitExecuteRestApiFunctionFunction;
 export declare function zohoRecruitUrlSearchParamsMinusModule(...input: Maybe<object | Record<string, string | number>>[]): URLSearchParams;
 export declare function zohoRecruitUrlSearchParamsMinusIdAndModule(...input: Maybe<object | Record<string, string | number>>[]): URLSearchParams;
 /**
  * @deprecated use makeUrlSearchParams instead.
  */
 export declare const zohoRecruitUrlSearchParams: typeof makeUrlSearchParams;
-export declare function zohoRecruitApiFetchJsonInput(method: string, body?: FetchJsonBody): FetchJsonInput;
+export declare function zohoRecruitApiFetchJsonInput(method: string, body?: Maybe<FetchJsonBody>): FetchJsonInput;
 export type ZohoRecruitChangeObjectResponse<T extends ZohoRecruitChangeObjectResponseEntry = ZohoRecruitChangeObjectResponseEntry> = ZohoDataArrayResultRef<T>;
 export type ZohoRecruitChangeObjectResponseEntry<E extends ZohoRecruitChangeObjectResponseSuccessEntry = ZohoRecruitChangeObjectResponseSuccessEntry> = E | ZohoRecruitChangeObjectResponseErrorEntry;
 export interface ZohoRecruitChangeObjectResponseSuccessEntry<D extends ZohoRecruitChangeObjectDetails = ZohoRecruitChangeObjectDetails> {

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

@@ -15,6 +15,10 @@ export declare const ZOHO_RECRUIT_CANDIDATES_MODULE = "Candidates";
 export interface ZohoRecruitModuleNameRef {
     readonly module: ZohoRecruitModuleName;
 }
+/**
+ * The API name of a function that is accessible via the Recruit REST API
+ */
+export type ZohoRecruitRestFunctionApiName = string;
 /**
  * An identifier in Zoho Recruit.
  */
@@ -31,6 +35,12 @@ export type ZohoRecruitRecordId = string;
  * Example "576214000000820595"
  */
 export type ZohoRecruitTypeId = string;
+/**
+ * Zoho Recruit user identifier.
+ *
+ * Users can be found in the Users and Controls section in settings.
+ */
+export type ZohoRecruitUserId = string;
 /**
  * Zoho Recruit custom view id
  */
@@ -53,9 +63,17 @@ export interface ZohoRecruitReferenceData {
     name: string;
     id: ZohoRecruitId;
 }
+/**
+ * Reference pair of a Zoho Recruit user name and id
+ */
+export interface ZohoRecruitUserReferenceData {
+    name: string;
+    id: ZohoRecruitUserId;
+}
 export interface ZohoRecruitReferenceDataWithModule extends ZohoRecruitReferenceData, ZohoRecruitModuleNameRef {
 }
-export type ZohoRecruitCreatedByData = ZohoRecruitReferenceData;
+export type ZohoRecruitCreatedByData = ZohoRecruitUserReferenceData;
+export type ZohoRecruitCandidateOwner = ZohoRecruitUserReferenceData;
 export interface ZohoRecruitModifiedByData extends ZohoRecruitReferenceData {
     zuid: ZohoRecruitId;
 }