@dereekb/zoho 11.0.9 → 11.0.11
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.esm.js +6 -0
- package/nestjs/CHANGELOG.md +8 -0
- package/nestjs/package.json +1 -1
- package/nestjs/src/lib/recruit/recruit.api.d.ts +3 -3
- package/package.json +1 -1
- package/src/lib/recruit/recruit.api.d.ts +39 -25
- package/src/lib/recruit/recruit.d.ts +15 -11
- package/src/lib/zoho.api.page.d.ts +2 -2
package/index.esm.js
CHANGED
|
@@ -1601,6 +1601,9 @@ const ZOHO_RECRUIT_CANDIDATES_MODULE = 'Candidates';
|
|
|
1601
1601
|
*/
|
|
1602
1602
|
|
|
1603
1603
|
// MARK: Zoho Recruit Record
|
|
1604
|
+
/**
|
|
1605
|
+
* Base Zoho Recruit field data type.
|
|
1606
|
+
*/
|
|
1604
1607
|
|
|
1605
1608
|
/**
|
|
1606
1609
|
* A ZohoRecruit record containing the corresponding record's id.
|
|
@@ -3172,6 +3175,9 @@ function insertRecord(context) {
|
|
|
3172
3175
|
}
|
|
3173
3176
|
|
|
3174
3177
|
// MARK: Upsert Record
|
|
3178
|
+
/**
|
|
3179
|
+
* Upsert function that can do either an insert or and update ased on the input.
|
|
3180
|
+
*/
|
|
3175
3181
|
|
|
3176
3182
|
/**
|
|
3177
3183
|
* Updates or inserts one or more records in Recruit.
|
package/nestjs/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
|
|
4
4
|
|
|
5
|
+
## [11.0.11](https://github.com/dereekb/dbx-components/compare/v11.0.10-dev...v11.0.11) (2024-11-24)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
## [11.0.10](https://github.com/dereekb/dbx-components/compare/v11.0.9-dev...v11.0.10) (2024-11-24)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
5
13
|
## [11.0.9](https://github.com/dereekb/dbx-components/compare/v11.0.8-dev...v11.0.9) (2024-11-23)
|
|
6
14
|
|
|
7
15
|
|
package/nestjs/package.json
CHANGED
|
@@ -7,13 +7,13 @@ export declare class ZohoRecruitApi {
|
|
|
7
7
|
readonly zohoRecruit: ZohoRecruit;
|
|
8
8
|
get recruitContext(): ZohoRecruitContext;
|
|
9
9
|
constructor(config: ZohoRecruitServiceConfig, zohoAccountsApi: ZohoAccountsApi);
|
|
10
|
-
get insertRecord(): import("@dereekb/zoho").
|
|
10
|
+
get insertRecord(): import("@dereekb/zoho").ZohoRecruitCreateRecordLikeFunction;
|
|
11
11
|
get upsertRecord(): import("@dereekb/zoho").ZohoRecruitUpsertRecordFunction;
|
|
12
|
-
get updateRecord(): import("@dereekb/zoho").
|
|
12
|
+
get updateRecord(): import("@dereekb/zoho").ZohoRecruitUpdateRecordLikeFunction;
|
|
13
13
|
get getRecordById(): import("@dereekb/zoho").ZohoRecruitGetRecordByIdFunction;
|
|
14
14
|
get getRecords(): import("@dereekb/zoho").ZohoRecruitGetRecordsFunction;
|
|
15
15
|
get searchRecords(): import("@dereekb/zoho").ZohoRecruitSearchRecordsFunction;
|
|
16
|
-
get searchRecordsPageFactory(): import("@dereekb/zoho").SearchRecordsPageFactory
|
|
16
|
+
get searchRecordsPageFactory(): import("@dereekb/zoho").SearchRecordsPageFactory;
|
|
17
17
|
get createNotes(): (input: import("@dereekb/zoho").ZohoRecruitCreateNotesRequest) => Promise<import("@dereekb/zoho").ZohoRecruitMultiRecordResult<import("@dereekb/zoho").NewZohoRecruitNoteData, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoRecruitChangeObjectDetails>, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseErrorEntry>>;
|
|
18
18
|
get deleteNotes(): (input: import("@dereekb/zoho").ZohoRecruitDeleteNotesRequest) => Promise<import("@dereekb/zoho").ZohoRecruitMultiRecordResult<string, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseSuccessEntry<import("@dereekb/zoho").ZohoRecruitChangeObjectDetails>, import("@dereekb/zoho").ZohoRecruitChangeObjectResponseErrorEntry>>;
|
|
19
19
|
get createNotesForRecord(): import("@dereekb/zoho").ZohoRecruitCreateNotesForRecordFunction;
|
package/package.json
CHANGED
|
@@ -1,22 +1,33 @@
|
|
|
1
1
|
import { ZohoDataArrayResultRef, ZohoPageFilter, ZohoPageResult } from './../zoho.api.page';
|
|
2
|
-
import { FetchJsonBody, FetchJsonInput, FetchPageFactory, makeUrlSearchParams } from '@dereekb/util/fetch';
|
|
2
|
+
import { FetchJsonBody, FetchJsonInput, FetchPage, FetchPageFactory, FetchPageFactoryOptions, makeUrlSearchParams } from '@dereekb/util/fetch';
|
|
3
3
|
import { ZohoRecruitContext } from './recruit.config';
|
|
4
|
-
import { NewZohoRecruitNoteData,
|
|
5
|
-
import { ArrayOrValue, EmailAddress, Maybe, PhoneNumber, SortingOrder } from '@dereekb/util';
|
|
4
|
+
import { NewZohoRecruitNoteData, ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleNameRef, ZohoRecruitChangeObjectDetails, ZohoRecruitRecord, ZohoRecruitRecordId, ZohoRecruitRecordNote, ZohoRecruitSearchRecordsCriteriaTreeElement, ZohoRecruitTerritoryId, ZohoRecruitTrueFalseBoth, ZohoRecruitNoteId } from './recruit';
|
|
5
|
+
import { ArrayOrValue, EmailAddress, Maybe, PhoneNumber, SortingOrder, UniqueModelWithId } from '@dereekb/util';
|
|
6
6
|
import { ZohoServerErrorDataWithDetails, ZohoServerErrorStatus, ZohoServerSuccessCode, ZohoServerSuccessStatus } from '../zoho.error.api';
|
|
7
|
-
export type ZohoRecruitUpdateRecordResult<
|
|
7
|
+
export type ZohoRecruitUpdateRecordResult<T> = ZohoRecruitMultiRecordResult<T, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
|
|
8
8
|
export type ZohoRecruitUpdateRecordResponse = ZohoRecruitChangeObjectResponse;
|
|
9
|
-
export type
|
|
10
|
-
export interface
|
|
11
|
-
readonly data:
|
|
9
|
+
export type ZohoRecruitCreateRecordData<T> = Omit<T, 'id'>;
|
|
10
|
+
export interface ZohoRecruitCreateSingleRecordInput<T> extends ZohoRecruitModuleNameRef {
|
|
11
|
+
readonly data: ZohoRecruitCreateRecordData<T>;
|
|
12
12
|
}
|
|
13
|
-
export interface
|
|
14
|
-
readonly data:
|
|
13
|
+
export interface ZohoRecruitCreateMultiRecordInput<T> extends ZohoRecruitModuleNameRef {
|
|
14
|
+
readonly data: ZohoRecruitCreateRecordData<T>[];
|
|
15
15
|
}
|
|
16
|
-
export type
|
|
17
|
-
export type
|
|
18
|
-
export type
|
|
19
|
-
export type
|
|
16
|
+
export type ZohoRecruitCreateRecordLikeFunction = ZohoRecruitCreateMultiRecordFunction & ZohoRecruitCreateSingleRecordFunction;
|
|
17
|
+
export type ZohoRecruitCreateSingleRecordFunction = <T>(input: ZohoRecruitCreateSingleRecordInput<T>) => Promise<ZohoRecruitChangeObjectDetails>;
|
|
18
|
+
export type ZohoRecruitCreateMultiRecordFunction = <T>(input: ZohoRecruitCreateMultiRecordInput<T>) => Promise<ZohoRecruitUpdateRecordResult<T>>;
|
|
19
|
+
export type ZohoRecruitUpdateRecordInput<T> = ZohoRecruitUpdateSingleRecordInput<T> | ZohoRecruitUpdateMultiRecordInput<T>;
|
|
20
|
+
export type ZohoRecruitUpdateRecordData<T> = UniqueModelWithId & Partial<T>;
|
|
21
|
+
export interface ZohoRecruitUpdateSingleRecordInput<T> extends ZohoRecruitModuleNameRef {
|
|
22
|
+
readonly data: ZohoRecruitUpdateRecordData<T>;
|
|
23
|
+
}
|
|
24
|
+
export interface ZohoRecruitUpdateMultiRecordInput<T> extends ZohoRecruitModuleNameRef {
|
|
25
|
+
readonly data: ZohoRecruitUpdateRecordData<T>[];
|
|
26
|
+
}
|
|
27
|
+
export type ZohoRecruitUpdateRecordLikeFunction = ZohoRecruitUpdateMultiRecordFunction & ZohoRecruitUpdateSingleRecordFunction;
|
|
28
|
+
export type ZohoRecruitUpdateMultiRecordFunction = <T>(input: ZohoRecruitUpdateMultiRecordInput<T>) => Promise<ZohoRecruitUpdateRecordResult<T>>;
|
|
29
|
+
export type ZohoRecruitUpdateSingleRecordFunction = <T>(input: ZohoRecruitUpdateSingleRecordInput<T>) => Promise<ZohoRecruitChangeObjectDetails>;
|
|
30
|
+
export type ZohoRecruitInsertRecordFunction = ZohoRecruitCreateRecordLikeFunction;
|
|
20
31
|
/**
|
|
21
32
|
* Inserts one or more records into Recruit.
|
|
22
33
|
*
|
|
@@ -26,7 +37,10 @@ export type ZohoRecruitInsertRecordFunction = ZohoRecruitUpdateRecordLikeFunctio
|
|
|
26
37
|
* @returns
|
|
27
38
|
*/
|
|
28
39
|
export declare function insertRecord(context: ZohoRecruitContext): ZohoRecruitInsertRecordFunction;
|
|
29
|
-
|
|
40
|
+
/**
|
|
41
|
+
* Upsert function that can do either an insert or and update ased on the input.
|
|
42
|
+
*/
|
|
43
|
+
export type ZohoRecruitUpsertRecordFunction = ZohoRecruitCreateRecordLikeFunction & ZohoRecruitUpdateRecordLikeFunction;
|
|
30
44
|
/**
|
|
31
45
|
* Updates or inserts one or more records in Recruit.
|
|
32
46
|
*
|
|
@@ -36,7 +50,7 @@ export type ZohoRecruitUpsertRecordFunction = ZohoRecruitUpdateRecordLikeFunctio
|
|
|
36
50
|
* @returns
|
|
37
51
|
*/
|
|
38
52
|
export declare function upsertRecord(context: ZohoRecruitContext): ZohoRecruitUpsertRecordFunction;
|
|
39
|
-
export type ZohoRecruitUpdateRecordFunction = ZohoRecruitUpdateRecordLikeFunction
|
|
53
|
+
export type ZohoRecruitUpdateRecordFunction = ZohoRecruitUpdateRecordLikeFunction;
|
|
40
54
|
/**
|
|
41
55
|
* Updates one or more records in Recruit.
|
|
42
56
|
*
|
|
@@ -49,9 +63,9 @@ export declare function updateRecord(context: ZohoRecruitContext): ZohoRecruitUp
|
|
|
49
63
|
export interface ZohoRecruitGetRecordByIdInput extends ZohoRecruitModuleNameRef {
|
|
50
64
|
readonly id: ZohoRecruitRecordId;
|
|
51
65
|
}
|
|
52
|
-
export type ZohoRecruitGetRecordByIdResponse = ZohoDataArrayResultRef<
|
|
53
|
-
export type ZohoRecruitGetRecordByIdResult<T
|
|
54
|
-
export type ZohoRecruitGetRecordByIdFunction = <T
|
|
66
|
+
export type ZohoRecruitGetRecordByIdResponse<T = ZohoRecruitRecord> = ZohoDataArrayResultRef<T>;
|
|
67
|
+
export type ZohoRecruitGetRecordByIdResult<T = ZohoRecruitRecord> = T;
|
|
68
|
+
export type ZohoRecruitGetRecordByIdFunction = <T = ZohoRecruitRecord>(input: ZohoRecruitGetRecordByIdInput) => Promise<ZohoRecruitGetRecordByIdResult<T>>;
|
|
55
69
|
/**
|
|
56
70
|
* Retrieves a specific record from the given module.
|
|
57
71
|
*
|
|
@@ -74,8 +88,8 @@ export interface ZohoRecruitGetRecordsInput extends ZohoRecruitModuleNameRef, Zo
|
|
|
74
88
|
readonly include_child?: boolean;
|
|
75
89
|
readonly $state?: ZohoRecruitDraftOrSaveState;
|
|
76
90
|
}
|
|
77
|
-
export type ZohoRecruitGetRecordsResponse<T
|
|
78
|
-
export type ZohoRecruitGetRecordsFunction = <T
|
|
91
|
+
export type ZohoRecruitGetRecordsResponse<T = ZohoRecruitRecord> = ZohoPageResult<T>;
|
|
92
|
+
export type ZohoRecruitGetRecordsFunction = <T = ZohoRecruitRecord>(input: ZohoRecruitGetRecordsInput) => Promise<ZohoRecruitGetRecordsResponse<T>>;
|
|
79
93
|
/**
|
|
80
94
|
* Retrieves records from the given module. Used for paginating across all records.
|
|
81
95
|
*
|
|
@@ -90,14 +104,14 @@ export declare function getRecords(context: ZohoRecruitContext): ZohoRecruitGetR
|
|
|
90
104
|
*
|
|
91
105
|
* Only criteria, email, phone, or word will be used at a single time.
|
|
92
106
|
*/
|
|
93
|
-
export interface ZohoRecruitSearchRecordsInput<T
|
|
107
|
+
export interface ZohoRecruitSearchRecordsInput<T = ZohoRecruitRecord> extends ZohoRecruitModuleNameRef, ZohoRecruitGetRecordsPageFilter {
|
|
94
108
|
readonly criteria?: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>>;
|
|
95
109
|
readonly email?: Maybe<EmailAddress>;
|
|
96
110
|
readonly phone?: Maybe<PhoneNumber>;
|
|
97
111
|
readonly word?: Maybe<string>;
|
|
98
112
|
}
|
|
99
|
-
export type ZohoRecruitSearchRecordsResponse<T
|
|
100
|
-
export type ZohoRecruitSearchRecordsFunction = <T
|
|
113
|
+
export type ZohoRecruitSearchRecordsResponse<T = ZohoRecruitRecord> = ZohoRecruitGetRecordsResponse<T>;
|
|
114
|
+
export type ZohoRecruitSearchRecordsFunction = <T = ZohoRecruitRecord>(input: ZohoRecruitSearchRecordsInput<T>) => Promise<ZohoRecruitSearchRecordsResponse<T>>;
|
|
101
115
|
/**
|
|
102
116
|
* Searches records from the given module.
|
|
103
117
|
*
|
|
@@ -107,8 +121,8 @@ export type ZohoRecruitSearchRecordsFunction = <T extends ZohoRecruitRecordField
|
|
|
107
121
|
* @returns
|
|
108
122
|
*/
|
|
109
123
|
export declare function searchRecords(context: ZohoRecruitContext): ZohoRecruitSearchRecordsFunction;
|
|
110
|
-
export type SearchRecordsPageFactory<T
|
|
111
|
-
export declare function searchRecordsPageFactory
|
|
124
|
+
export type SearchRecordsPageFactory = <T = ZohoRecruitRecord>(input: ZohoRecruitSearchRecordsInput<T>, options?: Maybe<FetchPageFactoryOptions<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>>) => FetchPage<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>;
|
|
125
|
+
export declare function searchRecordsPageFactory(context: ZohoRecruitContext): SearchRecordsPageFactory;
|
|
112
126
|
export interface ZohoRecruitCreateNotesRequest {
|
|
113
127
|
readonly data: ZohoRecruitCreateNotesRequestEntry[];
|
|
114
128
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CommaSeparatedString, ISO8601DateString, Maybe, UniqueModelWithId, WebsiteUrl } from '@dereekb/util';
|
|
1
|
+
import { CommaSeparatedString, ISO8601DateString, Maybe, UniqueModelWithId, WebsiteUrl, PrimativeKey } from '@dereekb/util';
|
|
2
2
|
/**
|
|
3
3
|
* Zoho Recruit module name.
|
|
4
4
|
*
|
|
@@ -78,7 +78,11 @@ export interface ZohoRecruitChangeObjectDetails {
|
|
|
78
78
|
Created_Time: ISO8601DateString;
|
|
79
79
|
Created_By: ZohoRecruitCreatedByData;
|
|
80
80
|
}
|
|
81
|
-
|
|
81
|
+
/**
|
|
82
|
+
* Base Zoho Recruit field data type.
|
|
83
|
+
*/
|
|
84
|
+
export interface ZohoRecruitRecordFieldsData {
|
|
85
|
+
}
|
|
82
86
|
export interface ZohoRecordDraftStateData {
|
|
83
87
|
/**
|
|
84
88
|
* Used to update a draft record or to convert a draft to a normal record.
|
|
@@ -87,7 +91,7 @@ export interface ZohoRecordDraftStateData {
|
|
|
87
91
|
*/
|
|
88
92
|
$state?: ZohoRecruitDraftOrSaveState;
|
|
89
93
|
}
|
|
90
|
-
export type NewZohoRecruitRecordData = ZohoRecruitRecordFieldsData & ZohoRecordDraftStateData;
|
|
94
|
+
export type NewZohoRecruitRecordData<T = ZohoRecruitRecordFieldsData> = T & ZohoRecordDraftStateData;
|
|
91
95
|
/**
|
|
92
96
|
* A ZohoRecruit record containing the corresponding record's id.
|
|
93
97
|
*/
|
|
@@ -115,14 +119,14 @@ export type ZohoRecruitSearchRecordsCriteriaString = string;
|
|
|
115
119
|
*
|
|
116
120
|
* If the input tree is empty, returns undefined.
|
|
117
121
|
*/
|
|
118
|
-
export declare function zohoRecruitSearchRecordsCriteriaString<T
|
|
119
|
-
export declare function zohoRecruitSearchRecordsCriteriaStringForTree<T
|
|
122
|
+
export declare function zohoRecruitSearchRecordsCriteriaString<T = any>(input: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
|
|
123
|
+
export declare function zohoRecruitSearchRecordsCriteriaStringForTree<T = any>(tree: ZohoRecruitSearchRecordsCriteriaTree<T>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
|
|
120
124
|
/**
|
|
121
125
|
* Tree items
|
|
122
126
|
*
|
|
123
127
|
* If both AND and OR values are provided at the root tree, then the will be merged together with AND.
|
|
124
128
|
*/
|
|
125
|
-
export interface ZohoRecruitSearchRecordsCriteriaTree<T
|
|
129
|
+
export interface ZohoRecruitSearchRecordsCriteriaTree<T = any> {
|
|
126
130
|
/**
|
|
127
131
|
* Items to AND with eachother
|
|
128
132
|
*/
|
|
@@ -132,11 +136,11 @@ export interface ZohoRecruitSearchRecordsCriteriaTree<T extends ZohoRecruitRecor
|
|
|
132
136
|
*/
|
|
133
137
|
readonly or?: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>[]>;
|
|
134
138
|
}
|
|
135
|
-
export type ZohoRecruitSearchRecordsCriteriaTreeElement<T
|
|
139
|
+
export type ZohoRecruitSearchRecordsCriteriaTreeElement<T = any> = ZohoRecruitSearchRecordsCriteriaEntryArray<T> | ZohoRecruitSearchRecordsCriteriaTree | ZohoRecruitSearchRecordsCriteriaString;
|
|
136
140
|
export type ZohoRecruitSearchRecordsCriteriaFilterType = 'starts_with' | 'equals' | 'contains';
|
|
137
|
-
export type ZohoRecruitSearchRecordsCriteriaEntryArray<T
|
|
138
|
-
export interface ZohoRecruitSearchRecordsCriteriaEntry<T
|
|
139
|
-
readonly field: keyof T extends
|
|
141
|
+
export type ZohoRecruitSearchRecordsCriteriaEntryArray<T = any> = ZohoRecruitSearchRecordsCriteriaEntry<T>[];
|
|
142
|
+
export interface ZohoRecruitSearchRecordsCriteriaEntry<T = any> {
|
|
143
|
+
readonly field: keyof T extends PrimativeKey ? keyof T : PrimativeKey;
|
|
140
144
|
readonly filter: ZohoRecruitSearchRecordsCriteriaFilterType;
|
|
141
145
|
readonly value: string;
|
|
142
146
|
}
|
|
@@ -150,7 +154,7 @@ export declare const escapeZohoFieldValueForCriteriaString: import("@dereekb/uti
|
|
|
150
154
|
* @param entry
|
|
151
155
|
* @returns
|
|
152
156
|
*/
|
|
153
|
-
export declare function zohoRecruitSearchRecordsCriteriaEntryToCriteriaString<T
|
|
157
|
+
export declare function zohoRecruitSearchRecordsCriteriaEntryToCriteriaString<T = any>(entry: ZohoRecruitSearchRecordsCriteriaEntry<T>): ZohoRecruitSearchRecordsCriteriaString;
|
|
154
158
|
export type ZohoRecruitNoteId = string;
|
|
155
159
|
export interface ZohoRecruitNoteAction {
|
|
156
160
|
$is_system_action: boolean;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { PageNumber } from '@dereekb/util';
|
|
1
|
+
import { Maybe, PageNumber } from '@dereekb/util';
|
|
2
2
|
import { FetchPageFactoryConfigDefaults } from '@dereekb/util/fetch';
|
|
3
3
|
/**
|
|
4
4
|
* Base page filter
|
|
@@ -57,4 +57,4 @@ export type ZohoFetchPageFetchFunction<I extends ZohoPageFilter, R extends ZohoP
|
|
|
57
57
|
* @param defaults
|
|
58
58
|
* @returns
|
|
59
59
|
*/
|
|
60
|
-
export declare function zohoFetchPageFactory<I extends ZohoPageFilter, R extends ZohoPageResult<any>>(fetch: ZohoFetchPageFetchFunction<I, R>, defaults?: FetchPageFactoryConfigDefaults): import("@dereekb/util/fetch").FetchPageFactory<I, R>;
|
|
60
|
+
export declare function zohoFetchPageFactory<I extends ZohoPageFilter, R extends ZohoPageResult<any>>(fetch: ZohoFetchPageFetchFunction<I, R>, defaults?: Maybe<FetchPageFactoryConfigDefaults>): import("@dereekb/util/fetch").FetchPageFactory<I, R>;
|