@dereekb/zoho 12.6.21 → 12.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.cjs.js +1786 -419
- package/index.esm.js +1678 -417
- package/nestjs/CHANGELOG.md +9 -0
- package/nestjs/package.json +1 -1
- package/nestjs/src/lib/accounts/accounts.api.js +3 -2
- package/nestjs/src/lib/accounts/accounts.api.js.map +1 -1
- package/nestjs/src/lib/accounts/accounts.config.d.ts +32 -0
- package/nestjs/src/lib/accounts/accounts.config.js +29 -4
- package/nestjs/src/lib/accounts/accounts.config.js.map +1 -1
- package/nestjs/src/lib/crm/crm.api.d.ts +42 -0
- package/nestjs/src/lib/crm/crm.api.js +115 -0
- package/nestjs/src/lib/crm/crm.api.js.map +1 -0
- package/nestjs/src/lib/crm/crm.config.d.ts +10 -0
- package/nestjs/src/lib/crm/crm.config.js +16 -0
- package/nestjs/src/lib/crm/crm.config.js.map +1 -0
- package/nestjs/src/lib/crm/crm.module.d.ts +24 -0
- package/nestjs/src/lib/crm/crm.module.js +61 -0
- package/nestjs/src/lib/crm/crm.module.js.map +1 -0
- package/nestjs/src/lib/crm/index.d.ts +3 -0
- package/nestjs/src/lib/crm/index.js +7 -0
- package/nestjs/src/lib/crm/index.js.map +1 -0
- package/nestjs/src/lib/recruit/recruit.api.d.ts +4 -4
- package/nestjs/src/lib/recruit/recruit.api.js +31 -31
- package/nestjs/src/lib/recruit/recruit.api.js.map +1 -1
- package/nestjs/src/lib/recruit/recruit.module.js +1 -1
- package/nestjs/src/lib/recruit/recruit.module.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/accounts/accounts.api.d.ts +1 -1
- package/src/lib/crm/crm.api.d.ts +430 -0
- package/src/lib/crm/crm.api.notes.d.ts +40 -0
- package/src/lib/crm/crm.api.tags.d.ts +136 -0
- package/src/lib/crm/crm.config.d.ts +24 -0
- package/src/lib/crm/crm.criteria.d.ts +19 -0
- package/src/lib/crm/crm.d.ts +325 -0
- package/src/lib/crm/crm.error.api.d.ts +52 -0
- package/src/lib/crm/crm.factory.d.ts +22 -0
- package/src/lib/crm/crm.notes.d.ts +48 -0
- package/src/lib/crm/crm.tags.d.ts +40 -0
- package/src/lib/crm/index.d.ts +10 -0
- package/src/lib/index.d.ts +1 -0
- package/src/lib/recruit/index.d.ts +0 -1
- package/src/lib/recruit/recruit.api.candidates.d.ts +30 -6
- package/src/lib/recruit/recruit.api.d.ts +102 -22
- package/src/lib/recruit/recruit.api.notes.d.ts +30 -6
- package/src/lib/recruit/recruit.api.tags.d.ts +30 -6
- package/src/lib/recruit/recruit.criteria.d.ts +8 -44
- package/src/lib/recruit/recruit.d.ts +7 -3
- package/src/lib/recruit/recruit.error.api.d.ts +5 -1
- package/src/lib/shared/criteria.d.ts +55 -0
- package/src/lib/shared/criteria.util.d.ts +10 -0
- package/src/lib/zoho.error.api.d.ts +62 -4
- package/src/lib/recruit/recruit.criteria.util.d.ts +0 -10
package/src/lib/index.d.ts
CHANGED
|
@@ -4,7 +4,6 @@ export * from './recruit.api.notes';
|
|
|
4
4
|
export * from './recruit.api.tags';
|
|
5
5
|
export * from './recruit.config';
|
|
6
6
|
export * from './recruit.criteria';
|
|
7
|
-
export * from './recruit.criteria.util';
|
|
8
7
|
export * from './recruit.error.api';
|
|
9
8
|
export * from './recruit.factory';
|
|
10
9
|
export * from './recruit';
|
|
@@ -44,7 +44,7 @@ export type ZohoRecruitAssociateCandidateRecordsWithJobOpeningsFunction = (input
|
|
|
44
44
|
* @param context
|
|
45
45
|
* @returns
|
|
46
46
|
*/
|
|
47
|
-
export declare function
|
|
47
|
+
export declare function zohoRecruitAssociateCandidateRecordsWithJobOpenings(context: ZohoRecruitContext): ZohoRecruitAssociateCandidateRecordsWithJobOpeningsFunction;
|
|
48
48
|
export interface ZohoRecruitSearchAssociatedRecordsInput extends ZohoRecruitModuleNameRef, ZohoRecruitGetRecordsPageFilter {
|
|
49
49
|
readonly id: ZohoRecruitCandidateId | ZohoRecruitJobOpeningId;
|
|
50
50
|
/**
|
|
@@ -58,12 +58,36 @@ export interface ZohoRecruitSearchAssociatedRecordsInput extends ZohoRecruitModu
|
|
|
58
58
|
}
|
|
59
59
|
export type ZohoRecruitSearchAssociatedRecordsResponse<T = ZohoRecruitRecord> = ZohoRecruitSearchRecordsResponse<T>;
|
|
60
60
|
export type ZohoRecruitSearchAssociatedRecordsFunction<R extends ZohoRecruitSearchAssociatedRecordsResponse> = (input: ZohoRecruitSearchAssociatedRecordsInput) => Promise<R>;
|
|
61
|
-
export declare function
|
|
61
|
+
export declare function zohoRecruitSearchAssociatedRecords<R extends ZohoRecruitSearchAssociatedRecordsResponse>(context: ZohoRecruitContext): ZohoRecruitSearchAssociatedRecordsFunction<R>;
|
|
62
62
|
export type ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsInput = Omit<ZohoRecruitSearchAssociatedRecordsInput, 'module' | 'candidate_statuses'>;
|
|
63
63
|
export type ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsFunction<T extends ZohoRecruitRecord> = (input: ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsInput) => Promise<ZohoRecruitSearchAssociatedRecordsResponse<T>>;
|
|
64
|
-
export declare function
|
|
65
|
-
export declare function
|
|
64
|
+
export declare function zohoRecruitSearchCandidateAssociatedJobOpeningRecords<T extends ZohoRecruitRecord>(context: ZohoRecruitContext): ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsFunction<T>;
|
|
65
|
+
export declare function zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory<T extends ZohoRecruitRecord>(context: ZohoRecruitContext): import("dist/packages/util/fetch/src").FetchPageFactory<ZohoRecruitSearchCandidateAssociatedJobOpeningRecordsInput, ZohoRecruitSearchAssociatedRecordsResponse<T>>;
|
|
66
66
|
export type ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsInput = Omit<ZohoRecruitSearchAssociatedRecordsInput, 'module' | 'posting_title'>;
|
|
67
67
|
export type ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsFunction<T extends ZohoRecruitRecord> = (input: ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsInput) => Promise<ZohoRecruitSearchAssociatedRecordsResponse<T>>;
|
|
68
|
-
export declare function
|
|
69
|
-
export declare function
|
|
68
|
+
export declare function zohoRecruitSearchJobOpeningAssociatedCandidateRecords<T extends ZohoRecruitRecord>(context: ZohoRecruitContext, jobOpeningModuleName?: string): ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsFunction<T>;
|
|
69
|
+
export declare function zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory<T extends ZohoRecruitRecord>(context: ZohoRecruitContext): import("dist/packages/util/fetch/src").FetchPageFactory<ZohoRecruitSearchJobOpeningAssociatedCandidateRecordsInput, ZohoRecruitSearchAssociatedRecordsResponse<T>>;
|
|
70
|
+
/**
|
|
71
|
+
* @deprecated Use zohoRecruitAssociateCandidateRecordsWithJobOpenings instead.
|
|
72
|
+
*/
|
|
73
|
+
export declare const associateCandidateRecordsWithJobOpenings: typeof zohoRecruitAssociateCandidateRecordsWithJobOpenings;
|
|
74
|
+
/**
|
|
75
|
+
* @deprecated Use zohoRecruitSearchAssociatedRecords instead.
|
|
76
|
+
*/
|
|
77
|
+
export declare const searchAssociatedRecords: typeof zohoRecruitSearchAssociatedRecords;
|
|
78
|
+
/**
|
|
79
|
+
* @deprecated Use zohoRecruitSearchCandidateAssociatedJobOpeningRecords instead.
|
|
80
|
+
*/
|
|
81
|
+
export declare const searchCandidateAssociatedJobOpeningRecords: typeof zohoRecruitSearchCandidateAssociatedJobOpeningRecords;
|
|
82
|
+
/**
|
|
83
|
+
* @deprecated Use zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory instead.
|
|
84
|
+
*/
|
|
85
|
+
export declare const searchCandidateAssociatedJobOpeningRecordsPageFactory: typeof zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory;
|
|
86
|
+
/**
|
|
87
|
+
* @deprecated Use zohoRecruitSearchJobOpeningAssociatedCandidateRecords instead.
|
|
88
|
+
*/
|
|
89
|
+
export declare const searchJobOpeningAssociatedCandidateRecords: typeof zohoRecruitSearchJobOpeningAssociatedCandidateRecords;
|
|
90
|
+
/**
|
|
91
|
+
* @deprecated Use zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory instead.
|
|
92
|
+
*/
|
|
93
|
+
export declare const searchJobOpeningAssociatedCandidateRecordsPageFactory: typeof zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory;
|
|
@@ -55,7 +55,7 @@ export type ZohoRecruitInsertRecordFunction = ZohoRecruitCreateRecordLikeFunctio
|
|
|
55
55
|
* @param context
|
|
56
56
|
* @returns
|
|
57
57
|
*/
|
|
58
|
-
export declare function
|
|
58
|
+
export declare function zohoRecruitInsertRecord(context: ZohoRecruitContext): ZohoRecruitInsertRecordFunction;
|
|
59
59
|
/**
|
|
60
60
|
* Upsert function that can do either an insert or and update ased on the input.
|
|
61
61
|
*/
|
|
@@ -68,7 +68,7 @@ export type ZohoRecruitUpsertRecordFunction = ZohoRecruitUpsertRecordLikeFunctio
|
|
|
68
68
|
* @param context
|
|
69
69
|
* @returns
|
|
70
70
|
*/
|
|
71
|
-
export declare function
|
|
71
|
+
export declare function zohoRecruitUpsertRecord(context: ZohoRecruitContext): ZohoRecruitUpsertRecordFunction;
|
|
72
72
|
export type ZohoRecruitUpdateRecordFunction = ZohoRecruitUpdateRecordLikeFunction;
|
|
73
73
|
/**
|
|
74
74
|
* Updates one or more records in Recruit.
|
|
@@ -78,7 +78,7 @@ export type ZohoRecruitUpdateRecordFunction = ZohoRecruitUpdateRecordLikeFunctio
|
|
|
78
78
|
* @param context
|
|
79
79
|
* @returns
|
|
80
80
|
*/
|
|
81
|
-
export declare function
|
|
81
|
+
export declare function zohoRecruitUpdateRecord(context: ZohoRecruitContext): ZohoRecruitUpdateRecordFunction;
|
|
82
82
|
export type ZohoRecruitDeleteRecordFunction = (input: ZohoRecruitDeleteRecordInput) => Promise<ZohoRecruitDeleteRecordResponse>;
|
|
83
83
|
export interface ZohoRecruitDeleteRecordInput extends ZohoRecruitModuleNameRef {
|
|
84
84
|
/**
|
|
@@ -102,7 +102,7 @@ export type ZohoRecruitDeleteRecordResult = ZohoRecruitChangeObjectResponseSucce
|
|
|
102
102
|
* @param context
|
|
103
103
|
* @returns ZohoRecruitDeleteRecordFunction
|
|
104
104
|
*/
|
|
105
|
-
export declare function
|
|
105
|
+
export declare function zohoRecruitDeleteRecord(context: ZohoRecruitContext): ZohoRecruitDeleteRecordFunction;
|
|
106
106
|
export interface ZohoRecruitGetRecordByIdInput extends ZohoRecruitModuleNameRef {
|
|
107
107
|
readonly id: ZohoRecruitRecordId;
|
|
108
108
|
}
|
|
@@ -117,7 +117,7 @@ export type ZohoRecruitGetRecordByIdFunction = <T = ZohoRecruitRecord>(input: Zo
|
|
|
117
117
|
* @param context
|
|
118
118
|
* @returns
|
|
119
119
|
*/
|
|
120
|
-
export declare function
|
|
120
|
+
export declare function zohoRecruitGetRecordById(context: ZohoRecruitContext): ZohoRecruitGetRecordByIdFunction;
|
|
121
121
|
export interface ZohoRecruitGetRecordsPageFilter extends ZohoPageFilter {
|
|
122
122
|
readonly converted?: ZohoRecruitTrueFalseBoth;
|
|
123
123
|
readonly approved?: ZohoRecruitTrueFalseBoth;
|
|
@@ -141,7 +141,7 @@ export type ZohoRecruitGetRecordsFunction = <T = ZohoRecruitRecord>(input: ZohoR
|
|
|
141
141
|
* @param context
|
|
142
142
|
* @returns
|
|
143
143
|
*/
|
|
144
|
-
export declare function
|
|
144
|
+
export declare function zohoRecruitGetRecords(context: ZohoRecruitContext): ZohoRecruitGetRecordsFunction;
|
|
145
145
|
/**
|
|
146
146
|
* Configuration for searching records.
|
|
147
147
|
*
|
|
@@ -166,9 +166,9 @@ export type ZohoRecruitSearchRecordsFunction = <T = ZohoRecruitRecord>(input: Zo
|
|
|
166
166
|
* @param context
|
|
167
167
|
* @returns
|
|
168
168
|
*/
|
|
169
|
-
export declare function
|
|
170
|
-
export type
|
|
171
|
-
export declare function
|
|
169
|
+
export declare function zohoRecruitSearchRecords(context: ZohoRecruitContext): ZohoRecruitSearchRecordsFunction;
|
|
170
|
+
export type ZohoRecruitSearchRecordsPageFactory = <T = ZohoRecruitRecord>(input: ZohoRecruitSearchRecordsInput<T>, options?: Maybe<FetchPageFactoryOptions<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>>) => FetchPage<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>;
|
|
171
|
+
export declare function zohoRecruitSearchRecordsPageFactory(context: ZohoRecruitContext): ZohoRecruitSearchRecordsPageFactory;
|
|
172
172
|
export interface ZohoRecruitGetRelatedRecordsFunctionConfig {
|
|
173
173
|
readonly targetModule: ZohoRecruitModuleName;
|
|
174
174
|
/**
|
|
@@ -202,19 +202,19 @@ export type ZohoRecruitGetRelatedRecordsFunction<T = ZohoRecruitRecord> = (input
|
|
|
202
202
|
* @param context the ZohoRecruitContext to use
|
|
203
203
|
* @returns a ZohoRecruitGetRelatedRecordsFunctionFactory
|
|
204
204
|
*/
|
|
205
|
-
export declare function
|
|
205
|
+
export declare function zohoRecruitGetRelatedRecordsFunctionFactory(context: ZohoRecruitContext): ZohoRecruitGetRelatedRecordsFunctionFactory;
|
|
206
206
|
export type ZohoRecruitGetEmailsForRecordRequest = ZohoRecruitGetRelatedRecordsRequest;
|
|
207
207
|
export type ZohoRecruitGetEmailsForRecordResponse = ZohoPageResult<ZohoRecruitRecordEmailMetadata>;
|
|
208
208
|
export type ZohoRecruitGetEmailsForRecordFunction = (input: ZohoRecruitGetEmailsForRecordRequest) => Promise<ZohoRecruitGetEmailsForRecordResponse>;
|
|
209
|
-
export declare function
|
|
210
|
-
export type
|
|
211
|
-
export declare function
|
|
209
|
+
export declare function zohoRecruitGetEmailsForRecord(context: ZohoRecruitContext): ZohoRecruitGetEmailsForRecordFunction;
|
|
210
|
+
export type ZohoRecruitGetEmailsForRecordPageFactory = FetchPageFactory<ZohoRecruitGetEmailsForRecordRequest, ZohoRecruitGetEmailsForRecordResponse>;
|
|
211
|
+
export declare function zohoRecruitGetEmailsForRecordPageFactory(context: ZohoRecruitContext): ZohoRecruitGetEmailsForRecordPageFactory;
|
|
212
212
|
export type ZohoRecruitGetAttachmentsForRecordRequest = ZohoRecruitGetRelatedRecordsRequest;
|
|
213
213
|
export type ZohoRecruitGetAttachmentsForRecordResponse = ZohoPageResult<ZohoRecruitRecordAttachmentMetadata>;
|
|
214
214
|
export type ZohoRecruitGetAttachmentsForRecordFunction = (input: ZohoRecruitGetAttachmentsForRecordRequest) => Promise<ZohoRecruitGetAttachmentsForRecordResponse>;
|
|
215
|
-
export declare function
|
|
216
|
-
export type
|
|
217
|
-
export declare function
|
|
215
|
+
export declare function zohoRecruitGetAttachmentsForRecord(context: ZohoRecruitContext): ZohoRecruitGetAttachmentsForRecordFunction;
|
|
216
|
+
export type ZohoRecruitGetAttachmentsForRecordPageFactory = FetchPageFactory<ZohoRecruitGetAttachmentsForRecordRequest, ZohoRecruitGetAttachmentsForRecordResponse>;
|
|
217
|
+
export declare function zohoRecruitGetAttachmentsForRecordPageFactory(context: ZohoRecruitContext): ZohoRecruitGetAttachmentsForRecordPageFactory;
|
|
218
218
|
/**
|
|
219
219
|
* Maximum attachment size allowed by Zoho Recruit.
|
|
220
220
|
*
|
|
@@ -261,7 +261,7 @@ export type ZohoRecruitUploadAttachmentForRecordFunction = (input: ZohoRecruitUp
|
|
|
261
261
|
* @param context
|
|
262
262
|
* @returns
|
|
263
263
|
*/
|
|
264
|
-
export declare function
|
|
264
|
+
export declare function zohoRecruitUploadAttachmentForRecord(context: ZohoRecruitContext): ZohoRecruitUploadAttachmentForRecordFunction;
|
|
265
265
|
export interface ZohoRecruitDownloadAttachmentForRecordRequest extends ZohoRecruitGetRecordByIdInput {
|
|
266
266
|
readonly attachment_id: ZohoRecruitAttachmentRecordId;
|
|
267
267
|
}
|
|
@@ -275,7 +275,7 @@ export type ZohoRecruitDownloadAttachmentForRecordFunction = (input: ZohoRecruit
|
|
|
275
275
|
* @param context
|
|
276
276
|
* @returns
|
|
277
277
|
*/
|
|
278
|
-
export declare function
|
|
278
|
+
export declare function zohoRecruitDownloadAttachmentForRecord(context: ZohoRecruitContext): ZohoRecruitDownloadAttachmentForRecordFunction;
|
|
279
279
|
export interface ZohoRecruitDeleteAttachmentFromRecordRequest extends ZohoRecruitGetRecordByIdInput {
|
|
280
280
|
readonly attachment_id: ZohoRecruitAttachmentRecordId;
|
|
281
281
|
}
|
|
@@ -289,7 +289,7 @@ export type ZohoRecruitDeleteAttachmentFromRecordFunction = (input: ZohoRecruitD
|
|
|
289
289
|
* @param context
|
|
290
290
|
* @returns
|
|
291
291
|
*/
|
|
292
|
-
export declare function
|
|
292
|
+
export declare function zohoRecruitDeleteAttachmentFromRecord(context: ZohoRecruitContext): ZohoRecruitDeleteAttachmentFromRecordFunction;
|
|
293
293
|
export type ZohoRecruitExecuteRestApiFunctionRequest = ZohoRecruitExecuteRestApiFunctionNormalRequest | ZohoRecruitExecuteRestApiFunctionApiSpecificRequest;
|
|
294
294
|
export interface ZohoRecruitExecuteRestApiFunctionNormalRequest {
|
|
295
295
|
readonly functionName: ZohoRecruitRestFunctionApiName;
|
|
@@ -346,7 +346,7 @@ export type ZohoRecruitExecuteRestApiFunctionFunction = (input: ZohoRecruitExecu
|
|
|
346
346
|
* @param context
|
|
347
347
|
* @returns
|
|
348
348
|
*/
|
|
349
|
-
export declare function
|
|
349
|
+
export declare function zohoRecruitExecuteRestApiFunction(context: ZohoRecruitContext): ZohoRecruitExecuteRestApiFunctionFunction;
|
|
350
350
|
export declare function zohoRecruitUrlSearchParamsMinusModule(...input: Maybe<object | Record<string, string | number>>[]): URLSearchParams;
|
|
351
351
|
export declare function zohoRecruitUrlSearchParamsMinusIdAndModule(...input: Maybe<object | Record<string, string | number>>[]): URLSearchParams;
|
|
352
352
|
/**
|
|
@@ -379,10 +379,10 @@ export interface ZohoRecruitMultiRecordResult<I, OS, OE> {
|
|
|
379
379
|
readonly successItems: ZohoRecruitMultiRecordResultEntry<I, OS>[];
|
|
380
380
|
readonly errorItems: ZohoRecruitMultiRecordResultEntry<I, OE>[];
|
|
381
381
|
}
|
|
382
|
-
export interface
|
|
382
|
+
export interface ZohoRecruitMultiRecordResultItem {
|
|
383
383
|
readonly status: ZohoServerSuccessStatus | ZohoServerErrorStatus;
|
|
384
384
|
}
|
|
385
|
-
export declare function zohoRecruitMultiRecordResult<I, OS extends
|
|
385
|
+
export declare function zohoRecruitMultiRecordResult<I, OS extends ZohoRecruitMultiRecordResultItem, OE extends ZohoRecruitMultiRecordResultItem>(input: I[], results: (OS | OE)[]): ZohoRecruitMultiRecordResult<I, OS, OE>;
|
|
386
386
|
export interface ZohoRecruitMultiRecordResultEntry<I, O> {
|
|
387
387
|
/**
|
|
388
388
|
* Input record/data.
|
|
@@ -397,3 +397,83 @@ export interface ZohoRecruitMultiRecordResultEntry<I, O> {
|
|
|
397
397
|
* @deprecated use ZohoRecruitGetRelatedRecordsPageFilter instead.
|
|
398
398
|
*/
|
|
399
399
|
export type ZohoRecruitGetNotesPageFilter = ZohoRecruitGetRelatedRecordsPageFilter;
|
|
400
|
+
/**
|
|
401
|
+
* @deprecated Use zohoRecruitInsertRecord instead.
|
|
402
|
+
*/
|
|
403
|
+
export declare const insertRecord: typeof zohoRecruitInsertRecord;
|
|
404
|
+
/**
|
|
405
|
+
* @deprecated Use zohoRecruitUpdateRecord instead.
|
|
406
|
+
*/
|
|
407
|
+
export declare const updateRecord: typeof zohoRecruitUpdateRecord;
|
|
408
|
+
/**
|
|
409
|
+
* @deprecated Use zohoRecruitUpsertRecord instead.
|
|
410
|
+
*/
|
|
411
|
+
export declare const upsertRecord: typeof zohoRecruitUpsertRecord;
|
|
412
|
+
/**
|
|
413
|
+
* @deprecated Use zohoRecruitDeleteRecord instead.
|
|
414
|
+
*/
|
|
415
|
+
export declare const deleteRecord: typeof zohoRecruitDeleteRecord;
|
|
416
|
+
/**
|
|
417
|
+
* @deprecated Use zohoRecruitGetRecordById instead.
|
|
418
|
+
*/
|
|
419
|
+
export declare const getRecordById: typeof zohoRecruitGetRecordById;
|
|
420
|
+
/**
|
|
421
|
+
* @deprecated Use zohoRecruitGetRecords instead.
|
|
422
|
+
*/
|
|
423
|
+
export declare const getRecords: typeof zohoRecruitGetRecords;
|
|
424
|
+
/**
|
|
425
|
+
* @deprecated Use zohoRecruitSearchRecords instead.
|
|
426
|
+
*/
|
|
427
|
+
export declare const searchRecords: typeof zohoRecruitSearchRecords;
|
|
428
|
+
/**
|
|
429
|
+
* @deprecated Use zohoRecruitSearchRecordsPageFactory instead.
|
|
430
|
+
*/
|
|
431
|
+
export declare const searchRecordsPageFactory: typeof zohoRecruitSearchRecordsPageFactory;
|
|
432
|
+
/**
|
|
433
|
+
* @deprecated Use zohoRecruitGetRelatedRecordsFunctionFactory instead.
|
|
434
|
+
*/
|
|
435
|
+
export declare const getRelatedRecordsFunctionFactory: typeof zohoRecruitGetRelatedRecordsFunctionFactory;
|
|
436
|
+
/**
|
|
437
|
+
* @deprecated Use zohoRecruitGetEmailsForRecord instead.
|
|
438
|
+
*/
|
|
439
|
+
export declare const getEmailsForRecord: typeof zohoRecruitGetEmailsForRecord;
|
|
440
|
+
/**
|
|
441
|
+
* @deprecated Use zohoRecruitGetEmailsForRecordPageFactory instead.
|
|
442
|
+
*/
|
|
443
|
+
export declare const getEmailsForRecordPageFactory: typeof zohoRecruitGetEmailsForRecordPageFactory;
|
|
444
|
+
/**
|
|
445
|
+
* @deprecated Use zohoRecruitGetAttachmentsForRecord instead.
|
|
446
|
+
*/
|
|
447
|
+
export declare const getAttachmentsForRecord: typeof zohoRecruitGetAttachmentsForRecord;
|
|
448
|
+
/**
|
|
449
|
+
* @deprecated Use zohoRecruitGetAttachmentsForRecordPageFactory instead.
|
|
450
|
+
*/
|
|
451
|
+
export declare const getAttachmentsForRecordPageFactory: typeof zohoRecruitGetAttachmentsForRecordPageFactory;
|
|
452
|
+
/**
|
|
453
|
+
* @deprecated Use zohoRecruitUploadAttachmentForRecord instead.
|
|
454
|
+
*/
|
|
455
|
+
export declare const uploadAttachmentForRecord: typeof zohoRecruitUploadAttachmentForRecord;
|
|
456
|
+
/**
|
|
457
|
+
* @deprecated Use zohoRecruitDownloadAttachmentForRecord instead.
|
|
458
|
+
*/
|
|
459
|
+
export declare const downloadAttachmentForRecord: typeof zohoRecruitDownloadAttachmentForRecord;
|
|
460
|
+
/**
|
|
461
|
+
* @deprecated Use zohoRecruitDeleteAttachmentFromRecord instead.
|
|
462
|
+
*/
|
|
463
|
+
export declare const deleteAttachmentFromRecord: typeof zohoRecruitDeleteAttachmentFromRecord;
|
|
464
|
+
/**
|
|
465
|
+
* @deprecated Use zohoRecruitExecuteRestApiFunction instead.
|
|
466
|
+
*/
|
|
467
|
+
export declare const executeRestApiFunction: typeof zohoRecruitExecuteRestApiFunction;
|
|
468
|
+
/**
|
|
469
|
+
* @deprecated Use ZohoRecruitSearchRecordsPageFactory instead.
|
|
470
|
+
*/
|
|
471
|
+
export type SearchRecordsPageFactory = ZohoRecruitSearchRecordsPageFactory;
|
|
472
|
+
/**
|
|
473
|
+
* @deprecated Use ZohoRecruitGetEmailsForRecordPageFactory instead.
|
|
474
|
+
*/
|
|
475
|
+
export type GetEmailsForRecordPageFactory = ZohoRecruitGetEmailsForRecordPageFactory;
|
|
476
|
+
/**
|
|
477
|
+
* @deprecated Use ZohoRecruitGetAttachmentsForRecordPageFactory instead.
|
|
478
|
+
*/
|
|
479
|
+
export type GetAttachmentsForRecordPageFactory = ZohoRecruitGetAttachmentsForRecordPageFactory;
|
|
@@ -12,23 +12,47 @@ export type ZohoRecruitCreateNotesResult = ZohoRecruitMultiRecordResult<ZohoRecr
|
|
|
12
12
|
export type ZohoRecruitCreateNotesRequestEntry = NewZohoRecruitNoteData;
|
|
13
13
|
export type ZohoRecruitCreateNotesResponse = ZohoRecruitChangeObjectResponse;
|
|
14
14
|
export type ZohoRecruitCreateNotesFunction = (input: ZohoRecruitCreateNotesRequest) => Promise<ZohoRecruitCreateNotesResult>;
|
|
15
|
-
export declare function
|
|
15
|
+
export declare function zohoRecruitCreateNotes(context: ZohoRecruitContext): (input: ZohoRecruitCreateNotesRequest) => Promise<ZohoRecruitMultiRecordResult<NewZohoRecruitNoteData, ZohoRecruitChangeObjectResponseSuccessEntry<import("./recruit").ZohoRecruitChangeObjectDetails>, ZohoRecruitChangeObjectResponseErrorEntry>>;
|
|
16
16
|
export interface ZohoRecruitDeleteNotesRequest {
|
|
17
17
|
readonly ids: ArrayOrValue<ZohoRecruitNoteId>;
|
|
18
18
|
}
|
|
19
19
|
export type ZohoRecruitDeleteNotesResult = ZohoRecruitMultiRecordResult<ZohoRecruitNoteId, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
|
|
20
20
|
export type ZohoRecruitDeleteNotesResponse = ZohoRecruitChangeObjectResponse;
|
|
21
21
|
export type ZohoRecruitDeleteNotesFunction = (input: ZohoRecruitDeleteNotesRequest) => Promise<ZohoRecruitDeleteNotesResult>;
|
|
22
|
-
export declare function
|
|
22
|
+
export declare function zohoRecruitDeleteNotes(context: ZohoRecruitContext): (input: ZohoRecruitDeleteNotesRequest) => Promise<ZohoRecruitMultiRecordResult<string, ZohoRecruitChangeObjectResponseSuccessEntry<import("./recruit").ZohoRecruitChangeObjectDetails>, ZohoRecruitChangeObjectResponseErrorEntry>>;
|
|
23
23
|
export type ZohoRecruitGetNotesForRecordRequest = ZohoRecruitGetRelatedRecordsRequest;
|
|
24
24
|
export type ZohoRecruitGetNotesForRecordResponse = ZohoPageResult<ZohoRecruitRecordNote>;
|
|
25
25
|
export type ZohoRecruitGetNotesForRecordFunction = (input: ZohoRecruitGetNotesForRecordRequest) => Promise<ZohoRecruitGetNotesForRecordResponse>;
|
|
26
|
-
export declare function
|
|
27
|
-
export type
|
|
28
|
-
export declare function
|
|
26
|
+
export declare function zohoRecruitGetNotesForRecord(context: ZohoRecruitContext): ZohoRecruitGetNotesForRecordFunction;
|
|
27
|
+
export type ZohoRecruitGetNotesForRecordPageFactory = FetchPageFactory<ZohoRecruitGetNotesForRecordRequest, ZohoRecruitGetNotesForRecordResponse>;
|
|
28
|
+
export declare function zohoRecruitGetNotesForRecordPageFactory(context: ZohoRecruitContext): ZohoRecruitGetNotesForRecordPageFactory;
|
|
29
29
|
export interface ZohoRecruitCreateNotesForRecordRequest extends ZohoRecruitModuleNameRef {
|
|
30
30
|
readonly id: ZohoRecruitRecordId;
|
|
31
31
|
readonly notes: ArrayOrValue<Omit<NewZohoRecruitNoteData, 'se_module' | 'Parent_Id'>>;
|
|
32
32
|
}
|
|
33
33
|
export type ZohoRecruitCreateNotesForRecordFunction = (input: ZohoRecruitCreateNotesForRecordRequest) => Promise<ZohoRecruitCreateNotesResult>;
|
|
34
|
-
export declare function
|
|
34
|
+
export declare function zohoRecruitCreateNotesForRecord(context: ZohoRecruitContext): ZohoRecruitCreateNotesForRecordFunction;
|
|
35
|
+
/**
|
|
36
|
+
* @deprecated Use zohoRecruitCreateNotes instead.
|
|
37
|
+
*/
|
|
38
|
+
export declare const createNotes: typeof zohoRecruitCreateNotes;
|
|
39
|
+
/**
|
|
40
|
+
* @deprecated Use zohoRecruitDeleteNotes instead.
|
|
41
|
+
*/
|
|
42
|
+
export declare const deleteNotes: typeof zohoRecruitDeleteNotes;
|
|
43
|
+
/**
|
|
44
|
+
* @deprecated Use zohoRecruitGetNotesForRecord instead.
|
|
45
|
+
*/
|
|
46
|
+
export declare const getNotesForRecord: typeof zohoRecruitGetNotesForRecord;
|
|
47
|
+
/**
|
|
48
|
+
* @deprecated Use zohoRecruitGetNotesForRecordPageFactory instead.
|
|
49
|
+
*/
|
|
50
|
+
export declare const getNotesForRecordPageFactory: typeof zohoRecruitGetNotesForRecordPageFactory;
|
|
51
|
+
/**
|
|
52
|
+
* @deprecated Use zohoRecruitCreateNotesForRecord instead.
|
|
53
|
+
*/
|
|
54
|
+
export declare const createNotesForRecord: typeof zohoRecruitCreateNotesForRecord;
|
|
55
|
+
/**
|
|
56
|
+
* @deprecated Use ZohoRecruitGetNotesForRecordPageFactory instead.
|
|
57
|
+
*/
|
|
58
|
+
export type GetNotesForRecordPageFactory = ZohoRecruitGetNotesForRecordPageFactory;
|
|
@@ -17,7 +17,7 @@ export type ZohoRecruitCreateTagsResult = ZohoRecruitMultiRecordResult<ZohoRecru
|
|
|
17
17
|
readonly allErrorItems: ZohoRecruitMultiRecordResultEntry<ZohoRecruitCreateTagData, ZohoRecruitChangeObjectResponseErrorEntry>[];
|
|
18
18
|
};
|
|
19
19
|
export type ZohoRecruitCreateTagsFunction = (input: ZohoRecruitCreateTagsRequest) => Promise<ZohoRecruitCreateTagsResult>;
|
|
20
|
-
export declare function
|
|
20
|
+
export declare function zohoRecruitCreateTagsForModule(context: ZohoRecruitContext): (input: ZohoRecruitCreateTagsRequest) => Promise<{
|
|
21
21
|
errorItems: ZohoRecruitMultiRecordResultEntry<ZohoRecruitCreateTagData, ZohoRecruitChangeObjectResponseErrorEntry>[];
|
|
22
22
|
duplicateErrorItems: ZohoRecruitMultiRecordResultEntry<ZohoRecruitCreateTagData, ZohoRecruitChangeObjectResponseErrorEntry>[];
|
|
23
23
|
allErrorItems: ZohoRecruitMultiRecordResultEntry<ZohoRecruitCreateTagData, ZohoRecruitChangeObjectResponseErrorEntry>[];
|
|
@@ -39,9 +39,9 @@ export type ZohoRecruitGetTagsFunction = (input: ZohoRecruitGetTagsRequest) => P
|
|
|
39
39
|
* @param context
|
|
40
40
|
* @returns
|
|
41
41
|
*/
|
|
42
|
-
export declare function
|
|
43
|
-
export type
|
|
44
|
-
export declare function
|
|
42
|
+
export declare function zohoRecruitGetTagsForModule(context: ZohoRecruitContext): ZohoRecruitGetTagsFunction;
|
|
43
|
+
export type ZohoRecruitGetTagsForModulePageFactory = (input: ZohoRecruitGetTagsRequest, options?: Maybe<FetchPageFactoryOptions<ZohoRecruitGetTagsRequest, ZohoRecruitGetTagsResult>>) => FetchPage<ZohoRecruitGetTagsRequest, ZohoRecruitGetTagsResult>;
|
|
44
|
+
export declare function zohoRecruitGetTagsForModulePageFactory(context: ZohoRecruitContext): ZohoRecruitGetTagsForModulePageFactory;
|
|
45
45
|
/**
|
|
46
46
|
* Limit enforced by Zoho Recruit
|
|
47
47
|
*/
|
|
@@ -89,7 +89,7 @@ export type ZohoRecruitAddTagsToRecordsFunction = (input: ZohoRecruitAddTagsToRe
|
|
|
89
89
|
* @param context
|
|
90
90
|
* @returns
|
|
91
91
|
*/
|
|
92
|
-
export declare function
|
|
92
|
+
export declare function zohoRecruitAddTagsToRecords(context: ZohoRecruitContext): ZohoRecruitAddTagsToRecordsFunction;
|
|
93
93
|
/**
|
|
94
94
|
* Limit enforced by Zoho Recruit
|
|
95
95
|
*/
|
|
@@ -117,4 +117,28 @@ export type ZohoRecruitRemoveTagsFromRecordsFunction = (input: ZohoRecruitRemove
|
|
|
117
117
|
* @param context
|
|
118
118
|
* @returns
|
|
119
119
|
*/
|
|
120
|
-
export declare function
|
|
120
|
+
export declare function zohoRecruitRemoveTagsFromRecords(context: ZohoRecruitContext): ZohoRecruitRemoveTagsFromRecordsFunction;
|
|
121
|
+
/**
|
|
122
|
+
* @deprecated Use zohoRecruitCreateTagsForModule instead.
|
|
123
|
+
*/
|
|
124
|
+
export declare const createTagsForModule: typeof zohoRecruitCreateTagsForModule;
|
|
125
|
+
/**
|
|
126
|
+
* @deprecated Use zohoRecruitGetTagsForModule instead.
|
|
127
|
+
*/
|
|
128
|
+
export declare const getTagsForModule: typeof zohoRecruitGetTagsForModule;
|
|
129
|
+
/**
|
|
130
|
+
* @deprecated Use zohoRecruitGetTagsForModulePageFactory instead.
|
|
131
|
+
*/
|
|
132
|
+
export declare const getTagsForModulePageFactory: typeof zohoRecruitGetTagsForModulePageFactory;
|
|
133
|
+
/**
|
|
134
|
+
* @deprecated Use zohoRecruitAddTagsToRecords instead.
|
|
135
|
+
*/
|
|
136
|
+
export declare const addTagsToRecords: typeof zohoRecruitAddTagsToRecords;
|
|
137
|
+
/**
|
|
138
|
+
* @deprecated Use zohoRecruitRemoveTagsFromRecords instead.
|
|
139
|
+
*/
|
|
140
|
+
export declare const removeTagsFromRecords: typeof zohoRecruitRemoveTagsFromRecords;
|
|
141
|
+
/**
|
|
142
|
+
* @deprecated Use ZohoRecruitGetTagsForModulePageFactory instead.
|
|
143
|
+
*/
|
|
144
|
+
export type GetTagsForModulePageFactory = ZohoRecruitGetTagsForModulePageFactory;
|
|
@@ -1,8 +1,4 @@
|
|
|
1
|
-
import { type
|
|
2
|
-
/**
|
|
3
|
-
* Encoded criteria string.
|
|
4
|
-
*/
|
|
5
|
-
export type ZohoRecruitSearchRecordsCriteriaString = string;
|
|
1
|
+
import { type ZohoSearchRecordsCriteriaString, type ZohoSearchRecordsCriteriaTree, type ZohoSearchRecordsCriteriaFilterType, type ZohoSearchRecordsCriteriaEntry, zohoSearchRecordsCriteriaString, zohoSearchRecordsCriteriaStringForTree, zohoSearchRecordsCriteriaEntryToCriteriaString } from '../shared/criteria';
|
|
6
2
|
/**
|
|
7
3
|
* Can search up to 10 criteria at a time.
|
|
8
4
|
*
|
|
@@ -11,44 +7,12 @@ export type ZohoRecruitSearchRecordsCriteriaString = string;
|
|
|
11
7
|
* "You can search for a maximum of 10 criteria (with the same or different column) with equals and starts_with conditions."
|
|
12
8
|
*/
|
|
13
9
|
export declare const MAX_ZOHO_RECRUIT_SEARCH_MODULE_RECORDS_CRITERIA = 10;
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
*/
|
|
19
|
-
export declare function zohoRecruitSearchRecordsCriteriaString<T = any>(input: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
|
|
20
|
-
export declare function zohoRecruitSearchRecordsCriteriaStringForTree<T = any>(tree: ZohoRecruitSearchRecordsCriteriaTree<T>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
|
|
21
|
-
/**
|
|
22
|
-
* Tree items
|
|
23
|
-
*
|
|
24
|
-
* If both AND and OR values are provided at the root tree, then the will be merged together with AND.
|
|
25
|
-
*/
|
|
26
|
-
export interface ZohoRecruitSearchRecordsCriteriaTree<T = any> {
|
|
27
|
-
/**
|
|
28
|
-
* Items to AND with eachother
|
|
29
|
-
*/
|
|
30
|
-
readonly and?: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>[]>;
|
|
31
|
-
/**
|
|
32
|
-
* Items to OR with eachother
|
|
33
|
-
*/
|
|
34
|
-
readonly or?: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>[]>;
|
|
35
|
-
}
|
|
10
|
+
export type ZohoRecruitSearchRecordsCriteriaString = ZohoSearchRecordsCriteriaString;
|
|
11
|
+
export declare const zohoRecruitSearchRecordsCriteriaString: typeof zohoSearchRecordsCriteriaString;
|
|
12
|
+
export declare const zohoRecruitSearchRecordsCriteriaStringForTree: typeof zohoSearchRecordsCriteriaStringForTree;
|
|
13
|
+
export type ZohoRecruitSearchRecordsCriteriaTree<T = any> = ZohoSearchRecordsCriteriaTree<T>;
|
|
36
14
|
export type ZohoRecruitSearchRecordsCriteriaTreeElement<T = any> = ZohoRecruitSearchRecordsCriteriaEntryArray<T> | ZohoRecruitSearchRecordsCriteriaTree<T> | ZohoRecruitSearchRecordsCriteriaString;
|
|
37
|
-
export type ZohoRecruitSearchRecordsCriteriaFilterType =
|
|
15
|
+
export type ZohoRecruitSearchRecordsCriteriaFilterType = ZohoSearchRecordsCriteriaFilterType;
|
|
38
16
|
export type ZohoRecruitSearchRecordsCriteriaEntryArray<T = any> = ZohoRecruitSearchRecordsCriteriaEntry<T>[];
|
|
39
|
-
export
|
|
40
|
-
|
|
41
|
-
readonly filter: ZohoRecruitSearchRecordsCriteriaFilterType;
|
|
42
|
-
readonly value: string;
|
|
43
|
-
}
|
|
44
|
-
/**
|
|
45
|
-
* Escape used for ZohoRecruitSearchRecordsCriteriaString
|
|
46
|
-
*/
|
|
47
|
-
export declare const escapeZohoFieldValueForCriteriaString: import("@dereekb/util").EscapeStringCharactersFunction;
|
|
48
|
-
/**
|
|
49
|
-
* Converts the input entry to a ZohoRecruitSearchRecordsCriteriaString. Properly escapes any parenthesis or commas.
|
|
50
|
-
*
|
|
51
|
-
* @param entry
|
|
52
|
-
* @returns
|
|
53
|
-
*/
|
|
54
|
-
export declare function zohoRecruitSearchRecordsCriteriaEntryToCriteriaString<T = any>(entry: ZohoRecruitSearchRecordsCriteriaEntry<T>): ZohoRecruitSearchRecordsCriteriaString;
|
|
17
|
+
export type ZohoRecruitSearchRecordsCriteriaEntry<T = any> = ZohoSearchRecordsCriteriaEntry<T>;
|
|
18
|
+
export declare const zohoRecruitSearchRecordsCriteriaEntryToCriteriaString: typeof zohoSearchRecordsCriteriaEntryToCriteriaString;
|
|
@@ -125,7 +125,7 @@ export interface ZohoRecruitChangeObjectDetails {
|
|
|
125
125
|
*/
|
|
126
126
|
export interface ZohoRecruitRecordFieldsData {
|
|
127
127
|
}
|
|
128
|
-
export interface
|
|
128
|
+
export interface ZohoRecruitRecordDraftStateData {
|
|
129
129
|
/**
|
|
130
130
|
* Used to update a draft record or to convert a draft to a normal record.
|
|
131
131
|
*
|
|
@@ -133,11 +133,11 @@ export interface ZohoRecordDraftStateData {
|
|
|
133
133
|
*/
|
|
134
134
|
$state?: ZohoRecruitDraftOrSaveState;
|
|
135
135
|
}
|
|
136
|
-
export type NewZohoRecruitRecordData<T = ZohoRecruitRecordFieldsData> = T &
|
|
136
|
+
export type NewZohoRecruitRecordData<T = ZohoRecruitRecordFieldsData> = T & ZohoRecruitRecordDraftStateData;
|
|
137
137
|
/**
|
|
138
138
|
* A ZohoRecruit record containing the corresponding record's id.
|
|
139
139
|
*/
|
|
140
|
-
export type UpdateZohoRecruitRecordData = UniqueModelWithId & ZohoRecruitRecordFieldsData &
|
|
140
|
+
export type UpdateZohoRecruitRecordData = UniqueModelWithId & ZohoRecruitRecordFieldsData & ZohoRecruitRecordDraftStateData;
|
|
141
141
|
/**
|
|
142
142
|
* A ZohoRecruit record containing record details.
|
|
143
143
|
*/
|
|
@@ -303,3 +303,7 @@ export interface ZohoRecruitRecordAttachmentMetadata {
|
|
|
303
303
|
* @deprecated use ZohoRecruitChangeObjectDetails instead.
|
|
304
304
|
*/
|
|
305
305
|
export type ZohoRecruitRecordUpdateDetails = ZohoRecruitChangeObjectDetails;
|
|
306
|
+
/**
|
|
307
|
+
* @deprecated Use ZohoRecruitRecordDraftStateData instead.
|
|
308
|
+
*/
|
|
309
|
+
export type ZohoRecordDraftStateData = ZohoRecruitRecordDraftStateData;
|
|
@@ -30,9 +30,13 @@ export declare class ZohoRecruitRecordCrudInvalidDataError extends ZohoRecruitRe
|
|
|
30
30
|
export declare class ZohoRecruitRecordCrudNoMatchingRecordError extends ZohoRecruitRecordCrudInvalidDataError {
|
|
31
31
|
}
|
|
32
32
|
export declare function zohoRecruitRecordCrudError(error: ZohoServerErrorDataWithDetails): ZohoRecruitRecordCrudError;
|
|
33
|
-
export declare function
|
|
33
|
+
export declare function assertZohoRecruitRecordDataArrayResultHasContent<T>(moduleName?: ZohoRecruitModuleName, recordId?: ZohoRecruitRecordId): <R extends ZohoDataArrayResultRef<T>>(x: R) => R;
|
|
34
34
|
export declare const logZohoRecruitErrorToConsole: import("../zoho.error.api").LogZohoServerErrorFunction;
|
|
35
35
|
export declare function parseZohoRecruitError(responseError: FetchResponseError): Promise<ParsedZohoServerError>;
|
|
36
36
|
export declare function parseZohoRecruitServerErrorResponseData(errorResponseData: ZohoServerErrorResponseData, responseError: FetchResponseError): ParsedZohoServerError;
|
|
37
37
|
export declare const interceptZohoRecruit200StatusWithErrorResponse: import("@dereekb/util/fetch").FetchJsonInterceptJsonResponseFunction;
|
|
38
38
|
export declare const handleZohoRecruitErrorFetch: import("../zoho.error.api").HandleZohoErrorFetchFactory;
|
|
39
|
+
/**
|
|
40
|
+
* @deprecated Use assertZohoRecruitRecordDataArrayResultHasContent instead.
|
|
41
|
+
*/
|
|
42
|
+
export declare const assertRecordDataArrayResultHasContent: typeof assertZohoRecruitRecordDataArrayResultHasContent;
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { type Maybe, type PrimativeKey } from '@dereekb/util';
|
|
2
|
+
/**
|
|
3
|
+
* Encoded criteria string.
|
|
4
|
+
*/
|
|
5
|
+
export type ZohoSearchRecordsCriteriaString = string;
|
|
6
|
+
/**
|
|
7
|
+
* Can search up to 10 criteria at a time.
|
|
8
|
+
*
|
|
9
|
+
* https://www.zoho.com/crm/developer/docs/api/v8/search-records.html
|
|
10
|
+
* https://www.zoho.com/recruit/developer-guide/apiv2/search-records.html
|
|
11
|
+
*
|
|
12
|
+
* "You can search for a maximum of 10 criteria (with the same or different column) with equals and starts_with conditions."
|
|
13
|
+
*/
|
|
14
|
+
export declare const MAX_ZOHO_SEARCH_MODULE_RECORDS_CRITERIA = 10;
|
|
15
|
+
/**
|
|
16
|
+
* Creates a ZohoSearchRecordsCriteriaString from a ZohoSearchRecordsCriteriaTree.
|
|
17
|
+
*
|
|
18
|
+
* If the input tree is empty, returns undefined.
|
|
19
|
+
*/
|
|
20
|
+
export declare function zohoSearchRecordsCriteriaString<T = any>(input: Maybe<ZohoSearchRecordsCriteriaTreeElement<T>>): Maybe<ZohoSearchRecordsCriteriaString>;
|
|
21
|
+
export declare function zohoSearchRecordsCriteriaStringForTree<T = any>(tree: ZohoSearchRecordsCriteriaTree<T>): Maybe<ZohoSearchRecordsCriteriaString>;
|
|
22
|
+
/**
|
|
23
|
+
* Tree items
|
|
24
|
+
*
|
|
25
|
+
* If both AND and OR values are provided at the root tree, then the will be merged together with AND.
|
|
26
|
+
*/
|
|
27
|
+
export interface ZohoSearchRecordsCriteriaTree<T = any> {
|
|
28
|
+
/**
|
|
29
|
+
* Items to AND with eachother
|
|
30
|
+
*/
|
|
31
|
+
readonly and?: Maybe<ZohoSearchRecordsCriteriaTreeElement<T>[]>;
|
|
32
|
+
/**
|
|
33
|
+
* Items to OR with eachother
|
|
34
|
+
*/
|
|
35
|
+
readonly or?: Maybe<ZohoSearchRecordsCriteriaTreeElement<T>[]>;
|
|
36
|
+
}
|
|
37
|
+
export type ZohoSearchRecordsCriteriaTreeElement<T = any> = ZohoSearchRecordsCriteriaEntryArray<T> | ZohoSearchRecordsCriteriaTree<T> | ZohoSearchRecordsCriteriaString;
|
|
38
|
+
export type ZohoSearchRecordsCriteriaFilterType = 'starts_with' | 'equals' | 'contains';
|
|
39
|
+
export type ZohoSearchRecordsCriteriaEntryArray<T = any> = ZohoSearchRecordsCriteriaEntry<T>[];
|
|
40
|
+
export interface ZohoSearchRecordsCriteriaEntry<T = any> {
|
|
41
|
+
readonly field: keyof T extends PrimativeKey ? keyof T : PrimativeKey;
|
|
42
|
+
readonly filter: ZohoSearchRecordsCriteriaFilterType;
|
|
43
|
+
readonly value: string;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Escape used for ZohoSearchRecordsCriteriaString
|
|
47
|
+
*/
|
|
48
|
+
export declare const escapeZohoFieldValueForCriteriaString: import("@dereekb/util").EscapeStringCharactersFunction;
|
|
49
|
+
/**
|
|
50
|
+
* Converts the input entry to a ZohoSearchRecordsCriteriaString. Properly escapes any parenthesis or commas.
|
|
51
|
+
*
|
|
52
|
+
* @param entry
|
|
53
|
+
* @returns
|
|
54
|
+
*/
|
|
55
|
+
export declare function zohoSearchRecordsCriteriaEntryToCriteriaString<T = any>(entry: ZohoSearchRecordsCriteriaEntry<T>): ZohoSearchRecordsCriteriaString;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { type ArrayOrValue, type EmailAddress, type PrimativeKey } from '@dereekb/util';
|
|
2
|
+
import { type ZohoSearchRecordsCriteriaEntryArray } from './criteria';
|
|
3
|
+
/**
|
|
4
|
+
* Creates a ZohoSearchRecordsCriteriaEntryArray from an array of emails.
|
|
5
|
+
*
|
|
6
|
+
* @param emails Email or array of emails to search for.
|
|
7
|
+
* @param field Optional field name to use. Defaults to 'Email'.
|
|
8
|
+
* @returns Array of ZohoSearchRecordsCriteriaEntry
|
|
9
|
+
*/
|
|
10
|
+
export declare function zohoSearchRecordsCriteriaEntriesForEmails<T = any>(emails: ArrayOrValue<EmailAddress>, field?: keyof T extends PrimativeKey ? PrimativeKey & keyof T : PrimativeKey): ZohoSearchRecordsCriteriaEntryArray<T>;
|