@dereekb/zoho 10.2.0

package/nestjs/src/lib/zoho.config.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertValidZohoConfig = exports.readZohoConfigFromConfigService = exports.zohoConfigServiceReaderFunction = exports.ZOHO_API_URL_CONFIG_KEY = void 0;
+exports.ZOHO_API_URL_CONFIG_KEY = 'API_URL';
+function zohoConfigServiceReaderFunction(inputOrKey, inputConfigService) {
+    let configService;
+    let serviceAccessTokenKey;
+    if (typeof inputOrKey === 'string') {
+        serviceAccessTokenKey = inputOrKey;
+        configService = inputConfigService;
+    }
+    else {
+        configService = inputOrKey.configService;
+        serviceAccessTokenKey = inputOrKey.serviceAccessTokenKey;
+    }
+    const baseServicePrefix = 'ZOHO_';
+    const servicePrefix = serviceAccessTokenKey.toUpperCase(); // "RECRUIT"
+    const servicePrefixString = `${baseServicePrefix}${servicePrefix}_`; // "ZOHO_RECRUIT_"
+    return (key) => {
+        const baseConfigKey = `${baseServicePrefix}${key}`; // "ZOHO_ACCOUNTS_URL"
+        const serviceSpecificConfigKey = `${servicePrefixString}${key}`; // "ZOHO_RECRUIT_ACCOUNTS_URL"
+        return configService.get(serviceSpecificConfigKey) ?? configService.get(baseConfigKey);
+    };
+}
+exports.zohoConfigServiceReaderFunction = zohoConfigServiceReaderFunction;
+/**
+ * Reads the ZohoConfig config from the ConfigService.
+ *
+ * @param configService
+ * @param prefix
+ */
+function readZohoConfigFromConfigService(configService, servicePrefix, assertValid = true) {
+    const servicePrefixString = servicePrefix ? `${servicePrefix}_` : '';
+    const apiUrlConfigKey = `${servicePrefixString}${exports.ZOHO_API_URL_CONFIG_KEY}`;
+    const config = {
+        apiUrl: configService.get(apiUrlConfigKey) ?? configService.get(exports.ZOHO_API_URL_CONFIG_KEY)
+    };
+    if (assertValid) {
+        if (!config.apiUrl) {
+            throw new Error(`No Zoho API url or type specified for key "${apiUrlConfigKey}".`);
+        }
+    }
+    return config;
+}
+exports.readZohoConfigFromConfigService = readZohoConfigFromConfigService;
+function assertValidZohoConfig(config) {
+    if (!config.apiUrl) {
+        throw new Error(`No Zoho API url or type specified.`);
+    }
+}
+exports.assertValidZohoConfig = assertValidZohoConfig;
+//# sourceMappingURL=zoho.config.js.map

package/nestjs/src/lib/zoho.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"zoho.config.js","sourceRoot":"","sources":["../../../../../../packages/zoho/nestjs/src/lib/zoho.config.ts"],"names":[],"mappings":";;;AAGa,QAAA,uBAAuB,GAAG,SAAS,CAAC;AAoBjD,SAAgB,+BAA+B,CAAC,UAAqE,EAAE,kBAAkC;IACvJ,IAAI,aAA4B,CAAC;IACjC,IAAI,qBAAgD,CAAC;IAErD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;QAClC,qBAAqB,GAAG,UAAU,CAAC;QACnC,aAAa,GAAG,kBAAmB,CAAC;KACrC;SAAM;QACL,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QACzC,qBAAqB,GAAG,UAAU,CAAC,qBAAqB,CAAC;KAC1D;IAED,MAAM,iBAAiB,GAAG,OAAO,CAAC;IAClC,MAAM,aAAa,GAAG,qBAAqB,CAAC,WAAW,EAAE,CAAC,CAAC,YAAY;IACvE,MAAM,mBAAmB,GAAG,GAAG,iBAAiB,GAAG,aAAa,GAAG,CAAC,CAAC,kBAAkB;IAEvF,OAAO,CAAC,GAAW,EAAU,EAAE;QAC7B,MAAM,aAAa,GAAG,GAAG,iBAAiB,GAAG,GAAG,EAAE,CAAC,CAAC,sBAAsB;QAC1E,MAAM,wBAAwB,GAAG,GAAG,mBAAmB,GAAG,GAAG,EAAE,CAAC,CAAC,8BAA8B;QAC/F,OAAO,aAAa,CAAC,GAAG,CAAS,wBAAwB,CAAC,IAAK,aAAa,CAAC,GAAG,CAAS,aAAa,CAAY,CAAC;IACrH,CAAC,CAAC;AACJ,CAAC;AArBD,0EAqBC;AAED;;;;;GAKG;AACH,SAAgB,+BAA+B,CAAC,aAA4B,EAAE,aAAsB,EAAE,WAAW,GAAG,IAAI;IACtH,MAAM,mBAAmB,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,aAAa,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACrE,MAAM,eAAe,GAAG,GAAG,mBAAmB,GAAG,+BAAuB,EAAE,CAAC;IAE3E,MAAM,MAAM,GAAG;QACb,MAAM,EAAE,aAAa,CAAC,GAAG,CAAS,eAAe,CAAC,IAAK,aAAa,CAAC,GAAG,CAAS,+BAAuB,CAAY;KACrH,CAAC;IAEF,IAAI,WAAW,EAAE;QACf,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,8CAA8C,eAAe,IAAI,CAAC,CAAC;SACpF;KACF;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAfD,0EAeC;AAED,SAAgB,qBAAqB,CAAC,MAAkB;IACtD,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;QAClB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;KACvD;AACH,CAAC;AAJD,sDAIC"}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@dereekb/zoho",
+  "version": "10.2.0",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "node": {
+        "require": "./index.cjs.js",
+        "import": "./index.mjs"
+      },
+      "browser": {
+        "require": "./index.cjs.js",
+        "import": "./index.esm.js"
+      },
+      "default": "./index.cjs.js"
+    },
+    "./nestjs": {
+      "types": "./nestjs/src/index.d.ts",
+      "main": "./nestjs/src/index.js",
+      "require": "./nestjs/src/index.js",
+      "default": "./nestjs/src/index.js"
+    }
+  },
+  "peerDependencies": {
+    "@dereekb/util": "*",
+    "make-error": "^1.3.0"
+  },
+  "module": "./index.esm.js",
+  "main": "./index.cjs.js"
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib';

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

@@ -0,0 +1,27 @@
+import { FetchJsonBody, FetchJsonInput } from '@dereekb/util/fetch';
+import { ZohoAccountsContext } from './accounts.config';
+import { ZohoAuthClientIdAndSecretPair, ZohoRefreshToken } from '../zoho.config';
+import { ZohoAccessTokenApiDomain, ZohoAccessTokenScopesString, ZohoAccessTokenString } from './accounts';
+import { Maybe, Seconds } from '@dereekb/util';
+import { ZohoAccountsAccessTokenErrorCode } from './accounts.error.api';
+export interface ZohoAccountsAccessTokenInput {
+    readonly client?: Maybe<ZohoAuthClientIdAndSecretPair>;
+    readonly refreshToken?: Maybe<ZohoRefreshToken>;
+}
+export interface ZohoAccountsAccessTokenResponse {
+    access_token: ZohoAccessTokenString;
+    scope: ZohoAccessTokenScopesString;
+    api_domain: ZohoAccessTokenApiDomain;
+    token_type: 'Bearer';
+    expires_in: Seconds;
+}
+export interface ZohoAccountsAccessTokenErrorResponse {
+    error: ZohoAccountsAccessTokenErrorCode;
+}
+/**
+ * Trades a refresh token for a new AccessToken
+ * @param context
+ * @returns
+ */
+export declare function accessToken(context: ZohoAccountsContext): (input?: ZohoAccountsAccessTokenInput) => Promise<ZohoAccountsAccessTokenResponse>;
+export declare function zohoAccountsApiFetchJsonInput(method: string, body?: FetchJsonBody): FetchJsonInput;

package/src/lib/accounts/accounts.config.d.ts

@@ -0,0 +1,45 @@
+import { FactoryWithRequiredInput, Maybe } from '@dereekb/util';
+import { ConfiguredFetch, FetchJsonFunction } from '@dereekb/util/fetch';
+import { ZohoApiUrl, ZohoRefreshToken, ZohoConfig, ZohoAuthClientIdAndSecretPair } from '../zoho.config';
+import { ZohoAccessTokenCache, ZohoAccessTokenFactory } from './accounts';
+/**
+ * The Zoho Accounts API URL for the US datacenter.
+ */
+export declare const ZOHO_ACCOUNTS_US_API_URL = "https://accounts.zoho.com";
+/**
+ * Url for the Zoho Accounts API.
+ *
+ * You can find a list here of Account URLs here:
+ *
+ * https://help.zoho.com/portal/en/kb/creator/developer-guide/others/url-patterns/articles/know-your-creator-account-s-base-url
+ */
+export type ZohoAccountsApiUrl = ZohoApiUrl;
+export type ZohoAccountsApiUrlKey = 'us';
+export type ZohoAccountsConfigApiUrlInput = ZohoAccountsApiUrlKey | ZohoAccountsApiUrl;
+export declare function zohoAccountsConfigApiUrl(input: ZohoAccountsConfigApiUrlInput): ZohoApiUrl;
+/**
+ * Configuration for ZohoAccounts.
+ */
+export interface ZohoAccountsConfig extends ZohoConfig, ZohoAuthClientIdAndSecretPair {
+    /**
+     * Refresh token used for generaing new ZohoAccessToken values.
+     */
+    readonly refreshToken: ZohoRefreshToken;
+    /**
+     * Optional ZohoAccessTokenCache for caching access tokens.
+     */
+    readonly accessTokenCache?: Maybe<ZohoAccessTokenCache>;
+}
+export interface ZohoAccountsFetchFactoryInput {
+    readonly apiUrl: ZohoApiUrl;
+}
+export type ZohoAccountsFetchFactory = FactoryWithRequiredInput<ConfiguredFetch, ZohoAccountsFetchFactoryInput>;
+export interface ZohoAccountsContext {
+    readonly fetch: ConfiguredFetch;
+    readonly fetchJson: FetchJsonFunction;
+    readonly loadAccessToken: ZohoAccessTokenFactory;
+    readonly config: ZohoAccountsConfig;
+}
+export interface ZohoAccountsContextRef {
+    readonly accountsContext: ZohoAccountsContext;
+}

package/src/lib/accounts/accounts.d.ts

@@ -0,0 +1,75 @@
+import { Maybe } from '@dereekb/util';
+import { ZohoApiServiceName } from '../zoho.config';
+/**
+ * Arbitrary key used to identify a specific service's access token. Typically coincides with the ZohoApiServiceName.
+ *
+ * I.E. recruit
+ */
+export type ZohoServiceAccessTokenKey = ZohoApiServiceName | string;
+/**
+ * Access token authorization string generated from a refresh token.
+ */
+export type ZohoAccessTokenString = string;
+/**
+ * Scopes string for a ZohoAccessToken
+ *
+ * Example: "ZohoRecruit.modules.ALL"
+ */
+export type ZohoAccessTokenScopesString = string;
+/**
+ * Api domain string for a ZohoAccessToken
+ *
+ * Example: "https://www.zohoapis.com"
+ */
+export type ZohoAccessTokenApiDomain = string;
+/**
+ * Zoho account access token.
+ */
+export interface ZohoAccessToken {
+    readonly accessToken: ZohoAccessTokenString;
+    readonly scope: ZohoAccessTokenScopesString;
+    readonly apiDomain: ZohoAccessTokenApiDomain;
+    /**
+     * Length of time the token is valid for.
+     */
+    readonly expiresIn: number;
+    /**
+     * Date the token expires at.
+     */
+    readonly expiresAt: Date;
+}
+/**
+ * Used for retrieving and storing ZohoAccessToken values.
+ */
+export interface ZohoAccessTokenCache {
+    /**
+     * Loads the token from the cache, if available.
+     *
+     * The token may be expired.
+     */
+    loadCachedToken(): Promise<Maybe<ZohoAccessToken>>;
+    /**
+     * Updates the cache with the given access token.
+     */
+    updateCachedToken(accessToken: ZohoAccessToken): Promise<void>;
+}
+/**
+ * Source for retriving a ZohoAccessToken.
+ *
+ * Throws an ZohoAccountsAuthRetrievalError error if the token could not be retrieved.
+ */
+export type ZohoAccessTokenFactory = () => Promise<ZohoAccessToken>;
+/**
+ * A ZohoAccessTokenFactory that always generates a new ZohoAccessToken.
+ */
+export type ZohoAccessTokenRefresher = ZohoAccessTokenFactory;
+/**
+ * Source for retriving a ZohoAccessToken string.
+ *
+ * Throws an ZohoAccountsAuthRetrievalError error if the token could not be retrieved.
+ */
+export type ZohoAccessTokenStringFactory = () => Promise<ZohoAccessTokenString>;
+/**
+ * Generates a new ZohoAccessTokenStringFactory.
+ */
+export declare function zohoAccessTokenStringFactory(zohoAccessTokenFactory: ZohoAccessTokenFactory): ZohoAccessTokenStringFactory;

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

@@ -0,0 +1,28 @@
+import { FetchRequestFactoryError, FetchResponseError } from '@dereekb/util/fetch';
+import { ZohoServerErrorResponseData, ParsedZohoServerError } from '../zoho.error.api';
+/**
+ * Error in the following cases:
+ * - the refresh token string is invalid
+ */
+export declare const ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE = "invalid_code";
+export declare const ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE = "invalid_client";
+export type ZohoAccountsAccessTokenErrorCode = typeof ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE | typeof ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE;
+/**
+ * Thrown if the call to the Zoho API creating an access token using a refresh token fails.
+ */
+export declare class ZohoAccountsAccessTokenError extends FetchRequestFactoryError {
+    readonly errorCode: ZohoAccountsAccessTokenErrorCode;
+    constructor(errorCode: ZohoAccountsAccessTokenErrorCode);
+}
+/**
+ * Thrown if a valid ZohoAccessToken cannot be retrieved successfully.
+ */
+export declare class ZohoAccountsAuthFailureError extends FetchRequestFactoryError {
+    readonly reason?: string | undefined;
+    constructor(reason?: string | undefined);
+}
+export declare const logZohoAccountsErrorToConsole: import("../zoho.error.api").LogZohoServerErrorFunction;
+export declare function parseZohoAccountsError(responseError: FetchResponseError): Promise<ParsedZohoServerError>;
+export declare function parseZohoAccountsServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData, responseError: FetchResponseError): ParsedZohoServerError;
+export declare const interceptZohoAccountsErrorResponse: import("@dereekb/util/fetch").FetchJsonInterceptJsonResponseFunction;
+export declare const handleZohoAccountsErrorFetch: import("../zoho.error.api").HandleZohoErrorFetchFactory;

package/src/lib/accounts/accounts.factory.d.ts

@@ -0,0 +1,34 @@
+import { ZohoAccountsConfig, ZohoAccountsContextRef, ZohoAccountsFetchFactory } from './accounts.config';
+import { LogZohoServerErrorFunction } from '../zoho.error.api';
+import { ZohoAccessTokenCache, ZohoAccessTokenFactory, ZohoAccessTokenRefresher } from './accounts';
+import { Maybe, Milliseconds } from '@dereekb/util';
+export type ZohoAccounts = ZohoAccountsContextRef;
+export interface ZohoAccountsFactoryConfig {
+    /**
+     * Creates a new fetch instance to use when making calls.
+     */
+    fetchFactory?: ZohoAccountsFetchFactory;
+    /**
+     * Custom log error function.
+     */
+    logZohoServerErrorFunction?: LogZohoServerErrorFunction;
+}
+export type ZohoAccountsFactory = (config: ZohoAccountsConfig) => ZohoAccounts;
+export declare function zohoAccountsFactory(factoryConfig: ZohoAccountsFactoryConfig): ZohoAccountsFactory;
+export interface ZohoAccountsZohoAccessTokenFactoryConfig {
+    /**
+     * Number of milliseconds before the expiration time a token should be discarded.
+     *
+     * Defaults to 1 minute.
+     */
+    readonly tokenExpirationBuffer?: Milliseconds;
+    readonly tokenRefresher: ZohoAccessTokenRefresher;
+    readonly accessTokenCache?: Maybe<ZohoAccessTokenCache>;
+}
+/**
+ * Creates a ZohoAccountsZohoAccessTokenFactoryConfig
+ *
+ * @param config
+ * @returns
+ */
+export declare function zohoAccountsZohoAccessTokenFactory(config: ZohoAccountsZohoAccessTokenFactoryConfig): ZohoAccessTokenFactory;

package/src/lib/accounts/index.d.ts

@@ -0,0 +1,5 @@
+export * from './accounts';
+export * from './accounts.api';
+export * from './accounts.config';
+export * from './accounts.error.api';
+export * from './accounts.factory';

package/src/lib/index.d.ts

@@ -0,0 +1,6 @@
+export * from './recruit';
+export * from './accounts';
+export * from './zoho.error.api';
+export * from './zoho.api.page';
+export * from './zoho.config';
+export * from './zoho.type';

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

@@ -0,0 +1,5 @@
+export * from './recruit.api';
+export * from './recruit.config';
+export * from './recruit.error.api';
+export * from './recruit.factory';
+export * from './recruit';

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

@@ -0,0 +1,144 @@
+import { ZohoDataArrayResultRef, 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 { 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 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;
+}
+export interface ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> extends ZohoRecruitModuleNameRef {
+    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 ZohoRecruitUpdateMultiRecordFunction<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = (input: ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitUpdateRecordResult<RECORD_INPUT_TYPE>>;
+export type ZohoRecruitInsertRecordFunction = ZohoRecruitUpdateRecordLikeFunction<NewZohoRecruitRecordData>;
+/**
+ * Inserts one or more records into Recruit.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function insertRecord(context: ZohoRecruitContext): ZohoRecruitInsertRecordFunction;
+export type ZohoRecruitUpsertRecordFunction = ZohoRecruitUpdateRecordLikeFunction<NewZohoRecruitRecordData | ZohoRecruitRecordFieldsData>;
+/**
+ * Updates or inserts one or more records in Recruit.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function upsertRecord(context: ZohoRecruitContext): ZohoRecruitUpsertRecordFunction;
+export type ZohoRecruitUpdateRecordFunction = ZohoRecruitUpdateRecordLikeFunction<UpdateZohoRecruitRecordData>;
+/**
+ * Updates one or more records in Recruit.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/update-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function updateRecord(context: ZohoRecruitContext): ZohoRecruitUpdateRecordFunction;
+export interface ZohoRecruitGetRecordByIdInput extends ZohoRecruitModuleNameRef {
+    readonly id: ZohoRecruitRecordId;
+}
+export type ZohoRecruitGetRecordByIdResponse = ZohoDataArrayResultRef<ZohoRecruitRecord>;
+export type ZohoRecruitGetRecordByIdResult<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> = T;
+export type ZohoRecruitGetRecordByIdFunction = <T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord>(input: ZohoRecruitGetRecordByIdInput) => Promise<ZohoRecruitGetRecordByIdResult<T>>;
+/**
+ * Retrieves a specific record from the given module.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function getRecordById(context: ZohoRecruitContext): ZohoRecruitGetRecordByIdFunction;
+export interface ZohoRecruitGetRecordsPageFilter {
+    readonly converted?: ZohoRecruitTrueFalseBoth;
+    readonly approved?: ZohoRecruitTrueFalseBoth;
+    readonly page?: number;
+    readonly per_page?: number;
+}
+export interface ZohoRecruitGetRecordsInput extends ZohoRecruitModuleNameRef, ZohoRecruitGetRecordsPageFilter {
+    readonly fields?: ZohoRecruitCommaSeparateFieldNames;
+    readonly sort_order?: SortingOrder;
+    readonly sort_by?: ZohoRecruitFieldName;
+    readonly cvid?: ZohoRecruitCustomViewId;
+    readonly territory_id?: ZohoRecruitTerritoryId;
+    readonly include_child?: boolean;
+    readonly $state?: ZohoRecruitDraftOrSaveState;
+}
+export type ZohoRecruitGetRecordsResponse<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> = ZohoPageResult<T>;
+export type ZohoRecruitGetRecordsFunction = <T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord>(input: ZohoRecruitGetRecordsInput) => Promise<ZohoRecruitGetRecordsResponse<T>>;
+/**
+ * Retrieves records from the given module. Used for paginating across all records.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function getRecords(context: ZohoRecruitContext): ZohoRecruitGetRecordsFunction;
+/**
+ * Configuration for searching records.
+ *
+ * Only criteria, email, phone, or word will be used at a single time.
+ */
+export interface ZohoRecruitSearchRecordsInput<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> extends ZohoRecruitModuleNameRef, ZohoRecruitGetRecordsPageFilter {
+    readonly criteria?: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>>;
+    readonly email?: Maybe<EmailAddress>;
+    readonly phone?: Maybe<PhoneNumber>;
+    readonly word?: Maybe<string>;
+}
+export type ZohoRecruitSearchRecordsResponse<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> = ZohoRecruitGetRecordsResponse<T>;
+export type ZohoRecruitSearchRecordsFunction = <T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord>(input: ZohoRecruitSearchRecordsInput<T>) => Promise<ZohoRecruitSearchRecordsResponse<T>>;
+/**
+ * Searches records from the given module.
+ *
+ * https://www.zoho.com/recruit/developer-guide/apiv2/search-records.html
+ *
+ * @param context
+ * @returns
+ */
+export declare function searchRecords(context: ZohoRecruitContext): ZohoRecruitSearchRecordsFunction;
+export declare function zohoRecruitUrlSearchParamsMinusModule(input: object | Record<string, string | number>): URLSearchParams;
+export declare function zohoRecruitApiFetchJsonInput(method: string, body?: FetchJsonBody): FetchJsonInput;
+export interface ZohoRecruitMultiRecordResult<I, OS, OE> {
+    readonly successItems: ZohoRecruitMultiRecordResultEntry<I, OS>[];
+    readonly errorItems: ZohoRecruitMultiRecordResultEntry<I, OE>[];
+}
+export interface ZohoRecrutMultiRecordResultItem {
+    readonly status: ZohoServerSuccessStatus | ZohoServerErrorStatus;
+}
+export declare function zohoRecruitMultiRecordResult<I, OS extends ZohoRecrutMultiRecordResultItem, OE extends ZohoRecrutMultiRecordResultItem>(input: I[], results: (OS | OE)[]): ZohoRecruitMultiRecordResult<I, OS, OE>;
+export interface ZohoRecruitMultiRecordResultEntry<I, O> {
+    /**
+     * Input record/data.
+     */
+    readonly input: I;
+    /**
+     * The result of the insert.
+     */
+    readonly result: O;
+}

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

@@ -0,0 +1,23 @@
+import { FactoryWithRequiredInput } from '@dereekb/util';
+import { ConfiguredFetch, FetchJsonFunction } from '@dereekb/util/fetch';
+import { ZohoApiUrl, ZohoRefreshToken, ZohoApiUrlKey, ZohoConfig, ZohoApiServiceName } from '../zoho.config';
+import { ZohoServiceAccessTokenKey } from '../accounts';
+export declare const ZOHO_RECRUIT_SERVICE_NAME: ZohoApiServiceName | ZohoServiceAccessTokenKey;
+export type ZohoRecruitApiUrl = ZohoApiUrl;
+export type ZohoRecruitApiKey = ZohoRefreshToken;
+export type ZohoRecruitApiUrlKey = ZohoApiUrlKey;
+export type ZohoRecruitConfigApiUrlInput = ZohoRecruitApiUrlKey | ZohoRecruitApiUrl;
+export declare function zohoRecruitConfigApiUrl(input: ZohoRecruitConfigApiUrlInput): ZohoApiUrl;
+export type ZohoRecruitConfig = ZohoConfig;
+export interface ZohoRecruitFetchFactoryInput {
+    readonly apiUrl: ZohoRecruitApiUrl;
+}
+export type ZohoRecruitFetchFactory = FactoryWithRequiredInput<ConfiguredFetch, ZohoRecruitFetchFactoryInput>;
+export interface ZohoRecruitContext {
+    readonly fetch: ConfiguredFetch;
+    readonly fetchJson: FetchJsonFunction;
+    readonly config: ZohoRecruitConfig;
+}
+export interface ZohoRecruitContextRef {
+    readonly recruitContext: ZohoRecruitContext;
+}

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

@@ -0,0 +1,108 @@
+import { CommaSeparatedString, ISO8601DateString, Maybe, UniqueModelWithId } from '@dereekb/util';
+/**
+ * Zoho Recruit module name.
+ *
+ * Example "Candidates"
+ */
+export type ZohoRecruitModuleName = string;
+/**
+ * Zoho Recruit record id
+ *
+ * Example "576214000000569001"
+ */
+export type ZohoRecruitRecordId = string;
+/**
+ * Zoho Recruit custom view id
+ */
+export type ZohoRecruitCustomViewId = string;
+/**
+ * Zoho Recruit territory id
+ */
+export type ZohoRecruitTerritoryId = string;
+/**
+ * The name of a field on a record.
+ */
+export type ZohoRecruitFieldName = string;
+export type ZohoRecruitDraftOrSaveState = 'draft' | 'save';
+/**
+ * Comma separated list of field names
+ */
+export type ZohoRecruitCommaSeparateFieldNames = CommaSeparatedString;
+export type ZohoRecruitTrueFalseBoth = 'true' | 'false' | 'both';
+export interface ZohoRecruitCreatedByData {
+    name: string;
+    id: string;
+}
+export type ZohoRecruitRecordFieldsData = Record<ZohoRecruitFieldName, any>;
+export interface ZohoRecordDraftStateData {
+    /**
+     * Used to update a draft record or to convert a draft to a normal record.
+     *
+     * When creating, passing "draft" will create the record as a draft.
+     */
+    $state?: ZohoRecruitDraftOrSaveState;
+}
+export type NewZohoRecruitRecordData = ZohoRecruitRecordFieldsData & ZohoRecordDraftStateData;
+/**
+ * A ZohoRecruit record containing the corresponding record's id.
+ */
+export type UpdateZohoRecruitRecordData = UniqueModelWithId & ZohoRecruitRecordFieldsData & ZohoRecordDraftStateData;
+/**
+ * A ZohoRecruit record containing record details.
+ */
+export type ZohoRecruitRecord = UniqueModelWithId & ZohoRecruitRecordFieldsData;
+/**
+ * Update details returned by the server for an updated object.
+ */
+export interface ZohoRecruitRecordUpdateDetails {
+    id: ZohoRecruitRecordId;
+    Modified_Time: ISO8601DateString;
+    Modified_By: ZohoRecruitCreatedByData;
+    Created_Time: ISO8601DateString;
+    Created_By: ZohoRecruitCreatedByData;
+}
+/**
+ * Encoded criteria string.
+ */
+export type ZohoRecruitSearchRecordsCriteriaString = string;
+/**
+ * Creates a ZohoRecruitSearchRecordsCriteriaString from a ZohoRecruitSearchRecordsCriteriaTree.
+ *
+ * If the input tree is empty, returns undefined.
+ */
+export declare function zohoRecruitSearchRecordsCriteriaString<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData>(input: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
+export declare function zohoRecruitSearchRecordsCriteriaStringForTree<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData>(tree: ZohoRecruitSearchRecordsCriteriaTree<T>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
+/**
+ * Tree items
+ *
+ * If both AND and OR values are provided at the root tree, then the will be merged together with AND.
+ */
+export interface ZohoRecruitSearchRecordsCriteriaTree<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData> {
+    /**
+     * Items to AND with eachother
+     */
+    readonly and?: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>[]>;
+    /**
+     * Items to OR with eachother
+     */
+    readonly or?: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>[]>;
+}
+export type ZohoRecruitSearchRecordsCriteriaTreeElement<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData> = ZohoRecruitSearchRecordsCriteriaEntryArray<T> | ZohoRecruitSearchRecordsCriteriaTree | ZohoRecruitSearchRecordsCriteriaString;
+export type ZohoRecruitSearchRecordsCriteriaFilterType = 'starts_with' | 'equals' | 'contains';
+export type ZohoRecruitSearchRecordsCriteriaEntryArray<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData> = ZohoRecruitSearchRecordsCriteriaEntry<T>[];
+export interface ZohoRecruitSearchRecordsCriteriaEntry<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData> {
+    readonly field: keyof T extends string ? keyof T : never;
+    readonly filter: ZohoRecruitSearchRecordsCriteriaFilterType;
+    readonly value: string;
+}
+/**
+ * Escape used for ZohoRecruitSearchRecordsCriteriaString
+ */
+export declare const escapeZohoFieldValueForCriteriaString: import("@dereekb/util").EscapeStringCharactersFunction;
+/**
+ * Converts the input entry to a ZohoRecruitSearchRecordsCriteriaString. Properly escapes any parenthesis or commas.
+ *
+ * @param entry
+ * @returns
+ */
+export declare function zohoRecruitSearchRecordsCriteriaEntryToCriteriaString<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData>(entry: ZohoRecruitSearchRecordsCriteriaEntry<T>): ZohoRecruitSearchRecordsCriteriaString;

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

@@ -0,0 +1,29 @@
+import { FetchResponseError } from '@dereekb/util/fetch';
+import { BaseError } from 'make-error';
+import { ZohoServerErrorDataWithDetails, ZohoServerErrorResponseData, ZohoServerError, ParsedZohoServerError } from '../zoho.error.api';
+import { ZohoRecruitModuleName, ZohoRecruitRecordId } from './recruit';
+import { ZohoDataArrayResultRef } from '../zoho.api.page';
+export declare class ZohoRecruitRecordNoContentError extends BaseError {
+    readonly moduleName?: string | undefined;
+    readonly recordId?: string | undefined;
+    constructor(moduleName?: string | undefined, recordId?: string | undefined);
+}
+export declare class ZohoRecruitRecordCrudError extends ZohoServerError<ZohoServerErrorDataWithDetails> {
+}
+export declare class ZohoRecruitRecordCrudMandatoryFieldNotFoundError extends ZohoRecruitRecordCrudError {
+}
+export declare class ZohoRecruitRecordCrudDuplicateDataError extends ZohoRecruitRecordCrudError {
+}
+export type ZohoRecruitRecordCrudInvalidDataErrorDetails = Record<string, string>;
+export declare class ZohoRecruitRecordCrudInvalidDataError extends ZohoRecruitRecordCrudError {
+    get invalidFieldDetails(): ZohoRecruitRecordCrudInvalidDataErrorDetails;
+}
+export declare class ZohoRecruitRecordCrudNoMatchingRecordError extends ZohoRecruitRecordCrudInvalidDataError {
+}
+export declare function zohoRecruitRecordCrudError(error: ZohoServerErrorDataWithDetails): ZohoRecruitRecordCrudError;
+export declare function assertRecordDataArrayResultHasContent<T>(moduleName?: ZohoRecruitModuleName, recordId?: ZohoRecruitRecordId): <R extends ZohoDataArrayResultRef<T>>(x: R) => R;
+export declare const logZohoRecruitErrorToConsole: import("../zoho.error.api").LogZohoServerErrorFunction;
+export declare function parseZohoRecruitError(responseError: FetchResponseError): Promise<ParsedZohoServerError>;
+export declare function parseZohoRecruitServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData, responseError: FetchResponseError): ParsedZohoServerError;
+export declare const interceptZohoRecruitErrorResponse: import("@dereekb/util/fetch").FetchJsonInterceptJsonResponseFunction;
+export declare const handleZohoRecruitErrorFetch: import("../zoho.error.api").HandleZohoErrorFetchFactory;

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

@@ -0,0 +1,16 @@
+import { ZohoRecruitConfig, ZohoRecruitContextRef, ZohoRecruitFetchFactory } from './recruit.config';
+import { LogZohoServerErrorFunction } from '../zoho.error.api';
+import { ZohoAccountsContextRef } from '../accounts/accounts.config';
+export type ZohoRecruit = ZohoRecruitContextRef;
+export interface ZohoRecruitFactoryConfig extends ZohoAccountsContextRef {
+    /**
+     * Creates a new fetch instance to use when making calls.
+     */
+    fetchFactory?: ZohoRecruitFetchFactory;
+    /**
+     * Custom log error function.
+     */
+    logZohoServerErrorFunction?: LogZohoServerErrorFunction;
+}
+export type ZohoRecruitFactory = (config: ZohoRecruitConfig) => ZohoRecruit;
+export declare function zohoRecruitFactory(factoryConfig: ZohoRecruitFactoryConfig): ZohoRecruitFactory;