@dereekb/zoho 11.0.4 → 11.0.6

package/index.cjs.js

@@ -2482,6 +2482,14 @@ var addToUnscopables = addToUnscopables$2;
 // https://tc39.es/ecma262/#sec-array.prototype-@@unscopables
 addToUnscopables('flatMap');
 
+/**
+ * Candidates module name
+ */
+const ZOHO_RECRUIT_CANDIDATES_MODULE = 'Candidates';
+/**
+ * Returns true if it is a valid ZohoRecruitValidUrl.
+ */
+const isZohoRecruitValidUrl = util.isStandardInternetAccessibleWebsiteUrl;
 /**
  * Creates a ZohoRecruitSearchRecordsCriteriaString from a ZohoRecruitSearchRecordsCriteriaTree.
  *
@@ -3975,6 +3983,33 @@ function searchRecords(context) {
     data: []
   });
 }
+function createNotes(context) {
+  return input => context.fetchJson(`/v2/Notes`, zohoRecruitApiFetchJsonInput('POST', {
+    data: input.data
+  })).then(x => {
+    return zohoRecruitMultiRecordResult(util.asArray(input.data), x.data);
+  });
+}
+function getNotesForRecord(context) {
+  return input => context.fetchJson(`/v2/${input.module}/${input.id}/Notes?${zohoRecruitUrlSearchParamsMinusModule(input.filter).toString()}`, zohoRecruitApiFetchJsonInput('GET'));
+}
+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 => Object.assign({}, x, {
+        se_module,
+        Parent_Id
+      }))
+    };
+    return createNotesInstance(createNotesRequest);
+  };
+}
 // MARK: Util
 function zohoRecruitUrlSearchParamsMinusModule(input) {
   const searchParams = new URLSearchParams(input);
@@ -4433,6 +4468,7 @@ exports.ZOHO_INVALID_AUTHORIZATION_ERROR_CODE = ZOHO_INVALID_AUTHORIZATION_ERROR
 exports.ZOHO_INVALID_DATA_ERROR_CODE = ZOHO_INVALID_DATA_ERROR_CODE;
 exports.ZOHO_INVALID_QUERY_ERROR_CODE = ZOHO_INVALID_QUERY_ERROR_CODE;
 exports.ZOHO_MANDATORY_NOT_FOUND_ERROR_CODE = ZOHO_MANDATORY_NOT_FOUND_ERROR_CODE;
+exports.ZOHO_RECRUIT_CANDIDATES_MODULE = ZOHO_RECRUIT_CANDIDATES_MODULE;
 exports.ZOHO_RECRUIT_SERVICE_NAME = ZOHO_RECRUIT_SERVICE_NAME;
 exports.ZOHO_SUCCESS_CODE = ZOHO_SUCCESS_CODE;
 exports.ZohoAccountsAccessTokenError = ZohoAccountsAccessTokenError;
@@ -4450,7 +4486,10 @@ exports.ZohoServerError = ZohoServerError;
 exports.ZohoServerFetchResponseError = ZohoServerFetchResponseError;
 exports.accessToken = accessToken;
 exports.assertRecordDataArrayResultHasContent = assertRecordDataArrayResultHasContent;
+exports.createNotes = createNotes;
+exports.createNotesForRecord = createNotesForRecord;
 exports.escapeZohoFieldValueForCriteriaString = escapeZohoFieldValueForCriteriaString;
+exports.getNotesForRecord = getNotesForRecord;
 exports.getRecordById = getRecordById;
 exports.getRecords = getRecords;
 exports.handleZohoAccountsErrorFetch = handleZohoAccountsErrorFetch;
@@ -4460,6 +4499,7 @@ exports.insertRecord = insertRecord;
 exports.interceptZohoAccountsErrorResponse = interceptZohoAccountsErrorResponse;
 exports.interceptZohoErrorResponseFactory = interceptZohoErrorResponseFactory;
 exports.interceptZohoRecruitErrorResponse = interceptZohoRecruitErrorResponse;
+exports.isZohoRecruitValidUrl = isZohoRecruitValidUrl;
 exports.logZohoAccountsErrorToConsole = logZohoAccountsErrorToConsole;
 exports.logZohoRecruitErrorToConsole = logZohoRecruitErrorToConsole;
 exports.logZohoServerErrorFunction = logZohoServerErrorFunction;

package/index.esm.js

@@ -1,4 +1,4 @@
-import { escapeStringCharactersFunction, filterMaybeValues, asArray, MS_IN_MINUTE, MS_IN_SECOND } from '@dereekb/util';
+import { escapeStringCharactersFunction, isStandardInternetAccessibleWebsiteUrl, filterMaybeValues, asArray, MS_IN_MINUTE, MS_IN_SECOND } from '@dereekb/util';
 import { BaseError } from 'make-error';
 import { FetchResponseError, FetchRequestFactoryError, fetchJsonFunction, returnNullHandleFetchJsonParseErrorFunction, nodeFetchService } from '@dereekb/util/fetch';
 
@@ -2478,18 +2478,38 @@ var addToUnscopables = addToUnscopables$2;
 // https://tc39.es/ecma262/#sec-array.prototype-@@unscopables
 addToUnscopables('flatMap');
 
+// MARK: Data Types
 /**
  * Zoho Recruit module name.
  *
  * Example "Candidates"
  */
 
+/**
+ * Candidates module name
+ */
+const ZOHO_RECRUIT_CANDIDATES_MODULE = 'Candidates';
+
+/**
+ * Contains a reference to a module.
+ */
+
+/**
+ * An identifier in Zoho Recruit.
+ */
+
 /**
  * Zoho Recruit record id
  *
  * Example "576214000000569001"
  */
 
+/**
+ * Zoho Recruit type id
+ *
+ * Example "576214000000820595"
+ */
+
 /**
  * Zoho Recruit custom view id
  */
@@ -2506,6 +2526,20 @@ addToUnscopables('flatMap');
  * Comma separated list of field names
  */
 
+/**
+ * Zoho Recruit only allows URLs that can be resolved via the internet (I.E. uses a normal tdl)
+ *
+ * The following are considered invalid:
+ * - localhost:8080
+ * - ht://dereekb.com
+ */
+
+/**
+ * Update details returned by the server for a created/updated object.
+ */
+
+// MARK: Zoho Recruit Record
+
 /**
  * A ZohoRecruit record containing the corresponding record's id.
  */
@@ -2515,7 +2549,14 @@ addToUnscopables('flatMap');
  */
 
 /**
- * Update details returned by the server for an updated object.
+ * Returns true if it is a valid ZohoRecruitValidUrl.
+ */
+const isZohoRecruitValidUrl = isStandardInternetAccessibleWebsiteUrl;
+
+/**
+ * Update details returned by the server for an updated record.
+ *
+ * @deprecated use ZohoRecruitChangeObjectDetails instead.
  */
 
 /**
@@ -2609,6 +2650,10 @@ function zohoRecruitSearchRecordsCriteriaEntryToCriteriaString(entry) {
   return `(${entry.field}:${entry.filter}:${escapedValue})`;
 }
 
+// MARK: Notes
+
+// TODO
+
 var global$6 = global$k;
 var classof = classofRaw$2;
 
@@ -4008,6 +4053,36 @@ function searchRecords(context) {
   });
 }
 
+// MARK: Notes
+
+function createNotes(context) {
+  return input => context.fetchJson(`/v2/Notes`, zohoRecruitApiFetchJsonInput('POST', {
+    data: input.data
+  })).then(x => {
+    return zohoRecruitMultiRecordResult(asArray(input.data), x.data);
+  });
+}
+function getNotesForRecord(context) {
+  return input => context.fetchJson(`/v2/${input.module}/${input.id}/Notes?${zohoRecruitUrlSearchParamsMinusModule(input.filter).toString()}`, zohoRecruitApiFetchJsonInput('GET'));
+}
+function createNotesForRecord(context) {
+  const createNotesInstance = createNotes(context);
+  return input => {
+    const {
+      module: se_module,
+      id: Parent_Id,
+      notes
+    } = input;
+    const createNotesRequest = {
+      data: asArray(notes).map(x => Object.assign({}, x, {
+        se_module,
+        Parent_Id
+      }))
+    };
+    return createNotesInstance(createNotesRequest);
+  };
+}
+
 // MARK: Util
 function zohoRecruitUrlSearchParamsMinusModule(input) {
   const searchParams = new URLSearchParams(input);
@@ -4024,6 +4099,8 @@ function zohoRecruitApiFetchJsonInput(method, body) {
   return result;
 }
 
+// MARK: Results
+
 // MARK: Multi-Record Results
 
 function zohoRecruitMultiRecordResult(input, results) {
@@ -4050,6 +4127,19 @@ function zohoRecruitMultiRecordResult(input, results) {
   return result;
 }
 
+// MARK: COMPAT
+/**
+ * @deprecated use ZohoRecruitChangeObjectResponseEntry instead.
+ */
+
+/**
+ * @deprecated use ZohoRecruitChangeObjectResponseSuccessEntry instead.
+ */
+
+/**
+ * @deprecated use ZohoRecruitChangeObjectResponseErrorEntry instead.
+ */
+
 const ZOHO_RECRUIT_SERVICE_NAME = 'recruit';
 function zohoRecruitConfigApiUrl(input) {
   switch (input) {
@@ -4396,4 +4486,4 @@ function zohoAccountsZohoAccessTokenFactory(config) {
   };
 }
 
-export { 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_RECRUIT_SERVICE_NAME, ZOHO_SUCCESS_CODE, ZohoAccountsAccessTokenError, ZohoAccountsAuthFailureError, ZohoInternalError, ZohoInvalidAuthorizationError, ZohoInvalidQueryError, ZohoRecruitRecordCrudDuplicateDataError, ZohoRecruitRecordCrudError, ZohoRecruitRecordCrudInvalidDataError, ZohoRecruitRecordCrudMandatoryFieldNotFoundError, ZohoRecruitRecordCrudNoMatchingRecordError, ZohoRecruitRecordNoContentError, ZohoServerError, ZohoServerFetchResponseError, accessToken, assertRecordDataArrayResultHasContent, escapeZohoFieldValueForCriteriaString, getRecordById, getRecords, handleZohoAccountsErrorFetch, handleZohoErrorFetchFactory, handleZohoRecruitErrorFetch, insertRecord, interceptZohoAccountsErrorResponse, interceptZohoErrorResponseFactory, interceptZohoRecruitErrorResponse, logZohoAccountsErrorToConsole, logZohoRecruitErrorToConsole, logZohoServerErrorFunction, parseZohoAccountsError, parseZohoAccountsServerErrorResponseData, parseZohoRecruitError, parseZohoRecruitServerErrorResponseData, parseZohoServerErrorResponseData, searchRecords, tryFindZohoServerErrorData, updateRecord, upsertRecord, zohoAccessTokenStringFactory, zohoAccountsApiFetchJsonInput, zohoAccountsConfigApiUrl, zohoAccountsFactory, zohoAccountsZohoAccessTokenFactory, zohoRecruitApiFetchJsonInput, zohoRecruitConfigApiUrl, zohoRecruitFactory, zohoRecruitMultiRecordResult, zohoRecruitRecordCrudError, zohoRecruitSearchRecordsCriteriaEntryToCriteriaString, zohoRecruitSearchRecordsCriteriaString, zohoRecruitSearchRecordsCriteriaStringForTree, zohoRecruitUrlSearchParamsMinusModule, zohoServerErrorData };
+export { 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_RECRUIT_CANDIDATES_MODULE, ZOHO_RECRUIT_SERVICE_NAME, ZOHO_SUCCESS_CODE, ZohoAccountsAccessTokenError, ZohoAccountsAuthFailureError, ZohoInternalError, ZohoInvalidAuthorizationError, ZohoInvalidQueryError, ZohoRecruitRecordCrudDuplicateDataError, ZohoRecruitRecordCrudError, ZohoRecruitRecordCrudInvalidDataError, ZohoRecruitRecordCrudMandatoryFieldNotFoundError, ZohoRecruitRecordCrudNoMatchingRecordError, ZohoRecruitRecordNoContentError, ZohoServerError, ZohoServerFetchResponseError, accessToken, assertRecordDataArrayResultHasContent, createNotes, createNotesForRecord, escapeZohoFieldValueForCriteriaString, getNotesForRecord, getRecordById, getRecords, handleZohoAccountsErrorFetch, handleZohoErrorFetchFactory, handleZohoRecruitErrorFetch, insertRecord, interceptZohoAccountsErrorResponse, interceptZohoErrorResponseFactory, interceptZohoRecruitErrorResponse, isZohoRecruitValidUrl, logZohoAccountsErrorToConsole, logZohoRecruitErrorToConsole, logZohoServerErrorFunction, parseZohoAccountsError, parseZohoAccountsServerErrorResponseData, parseZohoRecruitError, parseZohoRecruitServerErrorResponseData, parseZohoServerErrorResponseData, searchRecords, tryFindZohoServerErrorData, updateRecord, upsertRecord, zohoAccessTokenStringFactory, zohoAccountsApiFetchJsonInput, zohoAccountsConfigApiUrl, zohoAccountsFactory, zohoAccountsZohoAccessTokenFactory, zohoRecruitApiFetchJsonInput, zohoRecruitConfigApiUrl, zohoRecruitFactory, zohoRecruitMultiRecordResult, zohoRecruitRecordCrudError, zohoRecruitSearchRecordsCriteriaEntryToCriteriaString, zohoRecruitSearchRecordsCriteriaString, zohoRecruitSearchRecordsCriteriaStringForTree, zohoRecruitUrlSearchParamsMinusModule, zohoServerErrorData };

package/nestjs/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [11.0.6](https://github.com/dereekb/dbx-components/compare/v11.0.5-dev...v11.0.6) (2024-11-20)
+
+
+
+## [11.0.5](https://github.com/dereekb/dbx-components/compare/v11.0.4-dev...v11.0.5) (2024-11-19)
+
+
+
 ## [11.0.4](https://github.com/dereekb/dbx-components/compare/v11.0.3-dev...v11.0.4) (2024-11-19)
 
 

package/nestjs/package.json

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

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

@@ -13,4 +13,7 @@ export declare class ZohoRecruitApi {
     get getRecordById(): import("@dereekb/zoho").ZohoRecruitGetRecordByIdFunction;
     get getRecords(): import("@dereekb/zoho").ZohoRecruitGetRecordsFunction;
     get searchRecords(): import("@dereekb/zoho").ZohoRecruitSearchRecordsFunction;
+    get createNotes(): (input: import("@dereekb/zoho").ZohoRecruitCreateNotesRequest) => Promise<import("@dereekb/zoho").ZohoRecruitMultiRecordResult<import("@dereekb/zoho").NewZohoRecruitNewNoteData, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoRecruitChangeObjectDetails>, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseErrorEntry>>;
+    get createNotesForRecord(): import("@dereekb/zoho").ZohoRecruitCreateNotesForRecordFunction;
+    get getNotesForRecord(): import("@dereekb/zoho").ZohoRecruitGetNotesForRecordFunction;
 }

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

@@ -40,6 +40,15 @@ let ZohoRecruitApi = exports.ZohoRecruitApi = class ZohoRecruitApi {
     get searchRecords() {
         return (0, zoho_1.searchRecords)(this.recruitContext);
     }
+    get createNotes() {
+        return (0, zoho_1.createNotes)(this.recruitContext);
+    }
+    get createNotesForRecord() {
+        return (0, zoho_1.createNotesForRecord)(this.recruitContext);
+    }
+    get getNotesForRecord() {
+        return (0, zoho_1.getNotesForRecord)(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,wCAAwK;AACxK,qDAA4D;AAC5D,2DAA2D;AAGpD,IAAM,cAAc,4BAApB,MAAM,cAAc;IAO8B;IAAoE;IANlH,WAAW,CAAc;IAElC,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;IACzC,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;CACF,CAAA;yBAtCY,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAQE,mBAAA,IAAA,eAAM,EAAC,yCAAwB,CAAC,CAAA;IAA6C,mBAAA,IAAA,eAAM,EAAC,8BAAe,CAAC,CAAA;6CAAlD,yCAAwB,EAAqD,8BAAe;GAPhJ,cAAc,CAsC1B"}
+{"version":3,"file":"recruit.api.js","sourceRoot":"","sources":["../../../../../../../packages/zoho/nestjs/src/lib/recruit/recruit.api.ts"],"names":[],"mappings":";;;;AAAA,2CAAoD;AACpD,wCAA8N;AAC9N,qDAA4D;AAC5D,2DAA2D;AAGpD,IAAM,cAAc,4BAApB,MAAM,cAAc;IAO8B;IAAoE;IANlH,WAAW,CAAc;IAElC,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC;IACzC,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,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;yBAlDY,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAQE,mBAAA,IAAA,eAAM,EAAC,yCAAwB,CAAC,CAAA;IAA6C,mBAAA,IAAA,eAAM,EAAC,8BAAe,CAAC,CAAA;6CAAlD,yCAAwB,EAAqD,8BAAe;GAPhJ,cAAc,CAkD1B"}

package/package.json

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

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

@@ -1,24 +1,11 @@
-import { ZohoDataArrayResultRef, ZohoPageResult } from './../zoho.api.page';
+import { ZohoDataArrayResultRef, ZohoPageFilter, ZohoPageResult } from './../zoho.api.page';
 import { FetchJsonBody, FetchJsonInput } from '@dereekb/util/fetch';
 import { ZohoRecruitContext } from './recruit.config';
-import { NewZohoRecruitRecordData, UpdateZohoRecruitRecordData, ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleName, ZohoRecruitRecord, ZohoRecruitRecordFieldsData, ZohoRecruitRecordId, ZohoRecruitRecordUpdateDetails, ZohoRecruitSearchRecordsCriteriaTreeElement, ZohoRecruitTerritoryId, ZohoRecruitTrueFalseBoth } from './recruit';
-import { EmailAddress, Maybe, PhoneNumber, SortingOrder } from '@dereekb/util';
+import { NewZohoRecruitNewNoteData, NewZohoRecruitRecordData, UpdateZohoRecruitRecordData, ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleNameRef, ZohoRecruitChangeObjectDetails, ZohoRecruitRecord, ZohoRecruitRecordFieldsData, ZohoRecruitRecordId, ZohoRecruitRecordNote, ZohoRecruitSearchRecordsCriteriaTreeElement, ZohoRecruitTerritoryId, ZohoRecruitTrueFalseBoth } from './recruit';
+import { ArrayOrValue, EmailAddress, Maybe, PhoneNumber, SortingOrder } from '@dereekb/util';
 import { ZohoServerErrorDataWithDetails, ZohoServerErrorStatus, ZohoServerSuccessCode, ZohoServerSuccessStatus } from '../zoho.error.api';
-export interface ZohoRecruitModuleNameRef {
-    readonly module: ZohoRecruitModuleName;
-}
-export type ZohoRecruitUpdateRecordResult<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = ZohoRecruitMultiRecordResult<RECORD_INPUT_TYPE, ZohoRecruitUpdateRecordResponseSuccessEntry, ZohoRecruitUpdateRecordResponseErrorEntry>;
-export type ZohoRecruitUpdateRecordResponse = ZohoDataArrayResultRef<ZohoRecruitUpdateRecordResponseEntry>;
-export type ZohoRecruitUpdateRecordResponseEntry = ZohoRecruitUpdateRecordResponseSuccessEntry | ZohoRecruitUpdateRecordResponseErrorEntry;
-export interface ZohoRecruitUpdateRecordResponseSuccessEntry {
-    readonly code: ZohoServerSuccessCode;
-    readonly details: ZohoRecruitRecordUpdateDetails;
-    readonly status: ZohoServerSuccessStatus;
-    readonly message: string;
-}
-export interface ZohoRecruitUpdateRecordResponseErrorEntry extends ZohoServerErrorDataWithDetails {
-    readonly status: ZohoServerErrorStatus;
-}
+export type ZohoRecruitUpdateRecordResult<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = ZohoRecruitMultiRecordResult<RECORD_INPUT_TYPE, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
+export type ZohoRecruitUpdateRecordResponse = ZohoRecruitChangeObjectResponse;
 export type ZohoRecruitUpdateRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = ZohoRecruitUpdateSingleRecordInput<RECORD_INPUT_TYPE> | ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE>;
 export interface ZohoRecruitUpdateSingleRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> extends ZohoRecruitModuleNameRef {
     readonly data: RECORD_INPUT_TYPE;
@@ -27,7 +14,7 @@ export interface ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE extends Zoh
     readonly data: RECORD_INPUT_TYPE[];
 }
 export type ZohoRecruitUpdateRecordLikeFunction<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = ZohoRecruitUpdateMultiRecordFunction<RECORD_INPUT_TYPE> & ZohoRecruitUpdateSingleRecordFunction<RECORD_INPUT_TYPE>;
-export type ZohoRecruitUpdateSingleRecordFunction<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = (input: ZohoRecruitUpdateSingleRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitRecordUpdateDetails>;
+export type ZohoRecruitUpdateSingleRecordFunction<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = (input: ZohoRecruitUpdateSingleRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitChangeObjectDetails>;
 export type ZohoRecruitUpdateMultiRecordFunction<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = (input: ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitUpdateRecordResult<RECORD_INPUT_TYPE>>;
 export type ZohoRecruitInsertRecordFunction = ZohoRecruitUpdateRecordLikeFunction<NewZohoRecruitRecordData>;
 /**
@@ -74,11 +61,9 @@ export type ZohoRecruitGetRecordByIdFunction = <T extends ZohoRecruitRecordField
  * @returns
  */
 export declare function getRecordById(context: ZohoRecruitContext): ZohoRecruitGetRecordByIdFunction;
-export interface ZohoRecruitGetRecordsPageFilter {
+export interface ZohoRecruitGetRecordsPageFilter extends ZohoPageFilter {
     readonly converted?: ZohoRecruitTrueFalseBoth;
     readonly approved?: ZohoRecruitTrueFalseBoth;
-    readonly page?: number;
-    readonly per_page?: number;
 }
 export interface ZohoRecruitGetRecordsInput extends ZohoRecruitModuleNameRef, ZohoRecruitGetRecordsPageFilter {
     readonly fields?: ZohoRecruitCommaSeparateFieldNames;
@@ -122,8 +107,40 @@ export type ZohoRecruitSearchRecordsFunction = <T extends ZohoRecruitRecordField
  * @returns
  */
 export declare function searchRecords(context: ZohoRecruitContext): ZohoRecruitSearchRecordsFunction;
-export declare function zohoRecruitUrlSearchParamsMinusModule(input: object | Record<string, string | number>): URLSearchParams;
+export type ZohoRecruitGetNotesPageFilter = ZohoPageFilter;
+export interface ZohoRecruitCreateNotesRequest {
+    readonly data: ZohoRecruitCreateNotesRequestEntry[];
+}
+export type ZohoRecruitCreateNotesResult = ZohoRecruitMultiRecordResult<ZohoRecruitCreateNotesRequestEntry, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
+export type ZohoRecruitCreateNotesRequestEntry = NewZohoRecruitNewNoteData;
+export type ZohoRecruitCreateNotesResponse = ZohoRecruitChangeObjectResponse;
+export type ZohoRecruitCreateNotesFunction = (input: ZohoRecruitCreateNotesRequest) => Promise<ZohoRecruitCreateNotesResult>;
+export declare function createNotes(context: ZohoRecruitContext): (input: ZohoRecruitCreateNotesRequest) => Promise<ZohoRecruitMultiRecordResult<NewZohoRecruitNewNoteData, ZohoRecruitChangeObjectResponseSuccessEntry<ZohoRecruitChangeObjectDetails>, ZohoRecruitChangeObjectResponseErrorEntry>>;
+export interface ZohoRecruitGetNotesForRecordRequest extends ZohoRecruitGetRecordByIdInput {
+    filter?: Maybe<ZohoRecruitGetNotesPageFilter>;
+}
+export type ZohoRecruitGetNotesForRecordResponse = ZohoPageResult<ZohoRecruitRecordNote>;
+export type ZohoRecruitGetNotesForRecordFunction = (input: ZohoRecruitGetNotesForRecordRequest) => Promise<ZohoRecruitGetNotesForRecordResponse>;
+export declare function getNotesForRecord(context: ZohoRecruitContext): ZohoRecruitGetNotesForRecordFunction;
+export interface ZohoRecruitCreateNotesForRecordRequest extends ZohoRecruitModuleNameRef {
+    readonly id: ZohoRecruitRecordId;
+    readonly notes: ArrayOrValue<Omit<NewZohoRecruitNewNoteData, 'se_module' | 'Parent_Id'>>;
+}
+export type ZohoRecruitCreateNotesForRecordFunction = (input: ZohoRecruitCreateNotesForRecordRequest) => Promise<ZohoRecruitCreateNotesResult>;
+export declare function createNotesForRecord(context: ZohoRecruitContext): ZohoRecruitCreateNotesForRecordFunction;
+export declare function zohoRecruitUrlSearchParamsMinusModule(input: Maybe<object | Record<string, string | number>>): URLSearchParams;
 export declare function zohoRecruitApiFetchJsonInput(method: string, body?: FetchJsonBody): FetchJsonInput;
+export type ZohoRecruitChangeObjectResponse<T extends ZohoRecruitChangeObjectResponseEntry = ZohoRecruitChangeObjectResponseEntry> = ZohoDataArrayResultRef<T>;
+export type ZohoRecruitChangeObjectResponseEntry<E extends ZohoRecruitChangeObjectResponseSuccessEntry = ZohoRecruitChangeObjectResponseSuccessEntry> = E | ZohoRecruitUpdateRecordResponseErrorEntry;
+export interface ZohoRecruitChangeObjectResponseSuccessEntry<D extends ZohoRecruitChangeObjectDetails = ZohoRecruitChangeObjectDetails> {
+    readonly code: ZohoServerSuccessCode;
+    readonly details: D;
+    readonly status: ZohoServerSuccessStatus;
+    readonly message: string;
+}
+export interface ZohoRecruitChangeObjectResponseErrorEntry extends ZohoServerErrorDataWithDetails {
+    readonly status: ZohoServerErrorStatus;
+}
 export interface ZohoRecruitMultiRecordResult<I, OS, OE> {
     readonly successItems: ZohoRecruitMultiRecordResultEntry<I, OS>[];
     readonly errorItems: ZohoRecruitMultiRecordResultEntry<I, OE>[];
@@ -142,3 +159,15 @@ export interface ZohoRecruitMultiRecordResultEntry<I, O> {
      */
     readonly result: O;
 }
+/**
+ * @deprecated use ZohoRecruitChangeObjectResponseEntry instead.
+ */
+export type ZohoRecruitUpdateRecordResponseEntry = ZohoRecruitChangeObjectResponseEntry;
+/**
+ * @deprecated use ZohoRecruitChangeObjectResponseSuccessEntry instead.
+ */
+export type ZohoRecruitUpdateRecordResponseSuccessEntry = ZohoRecruitChangeObjectResponseSuccessEntry;
+/**
+ * @deprecated use ZohoRecruitChangeObjectResponseErrorEntry instead.
+ */
+export type ZohoRecruitUpdateRecordResponseErrorEntry = ZohoRecruitChangeObjectResponseErrorEntry;

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

@@ -1,16 +1,36 @@
-import { CommaSeparatedString, ISO8601DateString, Maybe, UniqueModelWithId } from '@dereekb/util';
+import { CommaSeparatedString, ISO8601DateString, Maybe, UniqueModelWithId, WebsiteUrl } from '@dereekb/util';
 /**
  * Zoho Recruit module name.
  *
  * Example "Candidates"
  */
 export type ZohoRecruitModuleName = string;
+/**
+ * Candidates module name
+ */
+export declare const ZOHO_RECRUIT_CANDIDATES_MODULE = "Candidates";
+/**
+ * Contains a reference to a module.
+ */
+export interface ZohoRecruitModuleNameRef {
+    readonly module: ZohoRecruitModuleName;
+}
+/**
+ * An identifier in Zoho Recruit.
+ */
+export type ZohoRecruitId = string;
 /**
  * Zoho Recruit record id
  *
  * Example "576214000000569001"
  */
 export type ZohoRecruitRecordId = string;
+/**
+ * Zoho Recruit type id
+ *
+ * Example "576214000000820595"
+ */
+export type ZohoRecruitTypeId = string;
 /**
  * Zoho Recruit custom view id
  */
@@ -29,9 +49,34 @@ export type ZohoRecruitDraftOrSaveState = 'draft' | 'save';
  */
 export type ZohoRecruitCommaSeparateFieldNames = CommaSeparatedString;
 export type ZohoRecruitTrueFalseBoth = 'true' | 'false' | 'both';
-export interface ZohoRecruitCreatedByData {
+export interface ZohoRecruitReferenceData {
     name: string;
-    id: string;
+    id: ZohoRecruitId;
+}
+export interface ZohoRecruitReferenceDataWithModule extends ZohoRecruitReferenceData, ZohoRecruitModuleNameRef {
+}
+export type ZohoRecruitCreatedByData = ZohoRecruitReferenceData;
+export interface ZohoRecruitModifiedByData extends ZohoRecruitReferenceData {
+    zuid: ZohoRecruitId;
+}
+export type ZohoRecruitParentReferenceData = ZohoRecruitReferenceDataWithModule;
+/**
+ * Zoho Recruit only allows URLs that can be resolved via the internet (I.E. uses a normal tdl)
+ *
+ * The following are considered invalid:
+ * - localhost:8080
+ * - ht://dereekb.com
+ */
+export type ZohoRecruitValidUrl = WebsiteUrl;
+/**
+ * Update details returned by the server for a created/updated object.
+ */
+export interface ZohoRecruitChangeObjectDetails {
+    id: ZohoRecruitRecordId;
+    Modified_Time: ISO8601DateString;
+    Modified_By: ZohoRecruitCreatedByData;
+    Created_Time: ISO8601DateString;
+    Created_By: ZohoRecruitCreatedByData;
 }
 export type ZohoRecruitRecordFieldsData = Record<ZohoRecruitFieldName, any>;
 export interface ZohoRecordDraftStateData {
@@ -52,15 +97,15 @@ export type UpdateZohoRecruitRecordData = UniqueModelWithId & ZohoRecruitRecordF
  */
 export type ZohoRecruitRecord = UniqueModelWithId & ZohoRecruitRecordFieldsData;
 /**
- * Update details returned by the server for an updated object.
+ * Returns true if it is a valid ZohoRecruitValidUrl.
  */
-export interface ZohoRecruitRecordUpdateDetails {
-    id: ZohoRecruitRecordId;
-    Modified_Time: ISO8601DateString;
-    Modified_By: ZohoRecruitCreatedByData;
-    Created_Time: ISO8601DateString;
-    Created_By: ZohoRecruitCreatedByData;
-}
+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;
 /**
  * Encoded criteria string.
  */
@@ -106,3 +151,45 @@ export declare const escapeZohoFieldValueForCriteriaString: import("@dereekb/uti
  * @returns
  */
 export declare function zohoRecruitSearchRecordsCriteriaEntryToCriteriaString<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData>(entry: ZohoRecruitSearchRecordsCriteriaEntry<T>): ZohoRecruitSearchRecordsCriteriaString;
+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 NewZohoRecruitNewNoteData 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;

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

@@ -1,4 +1,11 @@
 import { PageNumber } from '@dereekb/util';
+/**
+ * Base page filter
+ */
+export interface ZohoPageFilter {
+    readonly page?: number;
+    readonly per_page?: number;
+}
 export interface ZohoDataArrayResultRef<T> {
     /**
      * Array of data returned.
@@ -8,11 +15,11 @@ export interface ZohoDataArrayResultRef<T> {
 /**
  * Page result that contains an array of data and page information.
  */
-export interface ZohoPageResult<T> extends ZohoDataArrayResultRef<T> {
+export interface ZohoPageResult<T, I extends ZohoPageResultInfo = ZohoPageResultInfo> extends ZohoDataArrayResultRef<T> {
     /**
      * Current page information
      */
-    readonly info: ZohoPageResultInfo;
+    readonly info: I;
 }
 /**
  * Page information within a ZohoPageResult