@dereekb/zoho 11.0.9 → 11.0.10

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.
Files changed (7) hide show
  1. package/index.esm.js +3 -0
  2. package/nestjs/CHANGELOG.md +4 -0
  3. package/nestjs/package.json +1 -1
  4. package/nestjs/src/lib/recruit/recruit.api.d.ts +3 -3
  5. package/package.json +1 -1
  6. package/src/lib/recruit/recruit.api.d.ts +25 -14
  7. package/src/lib/recruit/recruit.d.ts +15 -11
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.
package/nestjs/CHANGELOG.md CHANGED
@@ -2,6 +2,10 @@
2
2
 
3
3
  This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
4
4
 
5
+ ## [11.0.10](https://github.com/dereekb/dbx-components/compare/v11.0.9-dev...v11.0.10) (2024-11-24)
6
+
7
+
8
+
5
9
  ## [11.0.9](https://github.com/dereekb/dbx-components/compare/v11.0.8-dev...v11.0.9) (2024-11-23)
6
10
 
7
11
 
package/nestjs/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dereekb/zoho/nestjs",
3
- "version": "11.0.9",
3
+ "version": "11.0.10",
4
4
  "type": "commonjs",
5
5
  "main": "./src/index.js"
6
6
  }
package/nestjs/src/lib/recruit/recruit.api.d.ts 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").ZohoRecruitInsertRecordFunction;
10
+ get insertRecord(): import("@dereekb/zoho").ZohoRecruitCreateRecordLikeFunction;
11
11
  get upsertRecord(): import("@dereekb/zoho").ZohoRecruitUpsertRecordFunction;
12
- get updateRecord(): import("@dereekb/zoho").ZohoRecruitUpdateRecordFunction;
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<import("@dereekb/zoho").ZohoRecruitRecord>;
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,6 +1,6 @@
1
1
  {
2
2
  "name": "@dereekb/zoho",
3
- "version": "11.0.9",
3
+ "version": "11.0.10",
4
4
  "exports": {
5
5
  ".": {
6
6
  "types": "./src/index.d.ts",
package/src/lib/recruit/recruit.api.d.ts 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, NewZohoRecruitRecordData, UpdateZohoRecruitRecordData, ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleNameRef, ZohoRecruitChangeObjectDetails, ZohoRecruitRecord, ZohoRecruitRecordFieldsData, ZohoRecruitRecordId, ZohoRecruitRecordNote, ZohoRecruitSearchRecordsCriteriaTreeElement, ZohoRecruitTerritoryId, ZohoRecruitTrueFalseBoth, ZohoRecruitNoteId } from './recruit';
5
- import { ArrayOrValue, EmailAddress, Maybe, PhoneNumber, SortingOrder } from '@dereekb/util';
4
+ import { NewZohoRecruitNoteData, ZohoRecruitCommaSeparateFieldNames, ZohoRecruitCustomViewId, ZohoRecruitDraftOrSaveState, ZohoRecruitFieldName, ZohoRecruitModuleNameRef, ZohoRecruitChangeObjectDetails, ZohoRecruitRecord, ZohoRecruitRecordFieldsData, 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
7
  export type ZohoRecruitUpdateRecordResult<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = ZohoRecruitMultiRecordResult<RECORD_INPUT_TYPE, ZohoRecruitChangeObjectResponseSuccessEntry, ZohoRecruitChangeObjectResponseErrorEntry>;
8
8
  export type ZohoRecruitUpdateRecordResponse = ZohoRecruitChangeObjectResponse;
9
+ export type ZohoRecruitCreateRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = ZohoRecruitCreateSingleRecordInput<RECORD_INPUT_TYPE> | ZohoRecruitCreateMultiRecordInput<RECORD_INPUT_TYPE>;
10
+ export interface ZohoRecruitCreateSingleRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> extends ZohoRecruitModuleNameRef {
11
+ readonly data: RECORD_INPUT_TYPE;
12
+ }
13
+ export interface ZohoRecruitCreateMultiRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> extends ZohoRecruitModuleNameRef {
14
+ readonly data: RECORD_INPUT_TYPE[];
15
+ }
16
+ export type ZohoRecruitCreateRecordLikeFunction = ZohoRecruitCreateMultiRecordFunction & ZohoRecruitCreateSingleRecordFunction;
17
+ export type ZohoRecruitCreateSingleRecordFunction = <RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData>(input: ZohoRecruitCreateSingleRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitChangeObjectDetails>;
18
+ export type ZohoRecruitCreateMultiRecordFunction = <RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData>(input: ZohoRecruitCreateMultiRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitUpdateRecordResult<RECORD_INPUT_TYPE>>;
9
19
  export type ZohoRecruitUpdateRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = ZohoRecruitUpdateSingleRecordInput<RECORD_INPUT_TYPE> | ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE>;
20
+ export type ZohoRecruitUpdateRecordData<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = UniqueModelWithId & Partial<RECORD_INPUT_TYPE>;
10
21
  export interface ZohoRecruitUpdateSingleRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> extends ZohoRecruitModuleNameRef {
11
- readonly data: RECORD_INPUT_TYPE;
22
+ readonly data: ZohoRecruitUpdateRecordData<RECORD_INPUT_TYPE>;
12
23
  }
13
24
  export interface ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> extends ZohoRecruitModuleNameRef {
14
- readonly data: RECORD_INPUT_TYPE[];
25
+ readonly data: ZohoRecruitUpdateRecordData<RECORD_INPUT_TYPE>[];
15
26
  }
16
- export type ZohoRecruitUpdateRecordLikeFunction<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = ZohoRecruitUpdateMultiRecordFunction<RECORD_INPUT_TYPE> & ZohoRecruitUpdateSingleRecordFunction<RECORD_INPUT_TYPE>;
17
- export type ZohoRecruitUpdateSingleRecordFunction<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = (input: ZohoRecruitUpdateSingleRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitChangeObjectDetails>;
18
- export type ZohoRecruitUpdateMultiRecordFunction<RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData> = (input: ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitUpdateRecordResult<RECORD_INPUT_TYPE>>;
19
- export type ZohoRecruitInsertRecordFunction = ZohoRecruitUpdateRecordLikeFunction<NewZohoRecruitRecordData>;
27
+ export type ZohoRecruitUpdateRecordLikeFunction = ZohoRecruitUpdateMultiRecordFunction & ZohoRecruitUpdateSingleRecordFunction;
28
+ export type ZohoRecruitUpdateMultiRecordFunction = <RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData>(input: ZohoRecruitUpdateMultiRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitUpdateRecordResult<RECORD_INPUT_TYPE>>;
29
+ export type ZohoRecruitUpdateSingleRecordFunction = <RECORD_INPUT_TYPE extends ZohoRecruitRecordFieldsData>(input: ZohoRecruitUpdateSingleRecordInput<RECORD_INPUT_TYPE>) => Promise<ZohoRecruitChangeObjectDetails>;
30
+ export type ZohoRecruitInsertRecordFunction = ZohoRecruitCreateRecordLikeFunction;
20
31
  /**
21
32
  * Inserts one or more records into Recruit.
22
33
  *
@@ -26,7 +37,7 @@ export type ZohoRecruitInsertRecordFunction = ZohoRecruitUpdateRecordLikeFunctio
26
37
  * @returns
27
38
  */
28
39
  export declare function insertRecord(context: ZohoRecruitContext): ZohoRecruitInsertRecordFunction;
29
- export type ZohoRecruitUpsertRecordFunction = ZohoRecruitUpdateRecordLikeFunction<NewZohoRecruitRecordData | ZohoRecruitRecordFieldsData>;
40
+ export type ZohoRecruitUpsertRecordFunction = ZohoRecruitCreateRecordLikeFunction & ZohoRecruitUpdateRecordLikeFunction;
30
41
  /**
31
42
  * Updates or inserts one or more records in Recruit.
32
43
  *
@@ -36,7 +47,7 @@ export type ZohoRecruitUpsertRecordFunction = ZohoRecruitUpdateRecordLikeFunctio
36
47
  * @returns
37
48
  */
38
49
  export declare function upsertRecord(context: ZohoRecruitContext): ZohoRecruitUpsertRecordFunction;
39
- export type ZohoRecruitUpdateRecordFunction = ZohoRecruitUpdateRecordLikeFunction<UpdateZohoRecruitRecordData>;
50
+ export type ZohoRecruitUpdateRecordFunction = ZohoRecruitUpdateRecordLikeFunction;
40
51
  /**
41
52
  * Updates one or more records in Recruit.
42
53
  *
@@ -49,7 +60,7 @@ export declare function updateRecord(context: ZohoRecruitContext): ZohoRecruitUp
49
60
  export interface ZohoRecruitGetRecordByIdInput extends ZohoRecruitModuleNameRef {
50
61
  readonly id: ZohoRecruitRecordId;
51
62
  }
52
- export type ZohoRecruitGetRecordByIdResponse = ZohoDataArrayResultRef<ZohoRecruitRecord>;
63
+ export type ZohoRecruitGetRecordByIdResponse<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> = ZohoDataArrayResultRef<T>;
53
64
  export type ZohoRecruitGetRecordByIdResult<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> = T;
54
65
  export type ZohoRecruitGetRecordByIdFunction = <T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord>(input: ZohoRecruitGetRecordByIdInput) => Promise<ZohoRecruitGetRecordByIdResult<T>>;
55
66
  /**
@@ -107,8 +118,8 @@ export type ZohoRecruitSearchRecordsFunction = <T extends ZohoRecruitRecordField
107
118
  * @returns
108
119
  */
109
120
  export declare function searchRecords(context: ZohoRecruitContext): ZohoRecruitSearchRecordsFunction;
110
- export type SearchRecordsPageFactory<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord> = FetchPageFactory<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>;
111
- export declare function searchRecordsPageFactory<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord>(context: ZohoRecruitContext): SearchRecordsPageFactory<T>;
121
+ export type SearchRecordsPageFactory = <T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecord>(input: ZohoRecruitSearchRecordsInput<T>, options?: FetchPageFactoryOptions<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>) => FetchPage<ZohoRecruitSearchRecordsInput<T>, ZohoRecruitSearchRecordsResponse<T>>;
122
+ export declare function searchRecordsPageFactory(context: ZohoRecruitContext): SearchRecordsPageFactory;
112
123
  export interface ZohoRecruitCreateNotesRequest {
113
124
  readonly data: ZohoRecruitCreateNotesRequestEntry[];
114
125
  }
package/src/lib/recruit/recruit.d.ts CHANGED
@@ -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
- export type ZohoRecruitRecordFieldsData = Record<ZohoRecruitFieldName, any>;
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 extends ZohoRecruitRecordFieldsData = 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 extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData>(input: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
119
- export declare function zohoRecruitSearchRecordsCriteriaStringForTree<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData>(tree: ZohoRecruitSearchRecordsCriteriaTree<T>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
122
+ export declare function zohoRecruitSearchRecordsCriteriaString<T extends ZohoRecruitRecordFieldsData = any>(input: Maybe<ZohoRecruitSearchRecordsCriteriaTreeElement<T>>): Maybe<ZohoRecruitSearchRecordsCriteriaString>;
123
+ export declare function zohoRecruitSearchRecordsCriteriaStringForTree<T extends ZohoRecruitRecordFieldsData = 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 extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData> {
129
+ export interface ZohoRecruitSearchRecordsCriteriaTree<T extends ZohoRecruitRecordFieldsData = 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 extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData> = ZohoRecruitSearchRecordsCriteriaEntryArray<T> | ZohoRecruitSearchRecordsCriteriaTree | ZohoRecruitSearchRecordsCriteriaString;
139
+ export type ZohoRecruitSearchRecordsCriteriaTreeElement<T extends ZohoRecruitRecordFieldsData = any> = ZohoRecruitSearchRecordsCriteriaEntryArray<T> | ZohoRecruitSearchRecordsCriteriaTree | ZohoRecruitSearchRecordsCriteriaString;
136
140
  export type ZohoRecruitSearchRecordsCriteriaFilterType = 'starts_with' | 'equals' | 'contains';
137
- export type ZohoRecruitSearchRecordsCriteriaEntryArray<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData> = ZohoRecruitSearchRecordsCriteriaEntry<T>[];
138
- export interface ZohoRecruitSearchRecordsCriteriaEntry<T extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData> {
139
- readonly field: keyof T extends string ? keyof T : never;
141
+ export type ZohoRecruitSearchRecordsCriteriaEntryArray<T extends ZohoRecruitRecordFieldsData = any> = ZohoRecruitSearchRecordsCriteriaEntry<T>[];
142
+ export interface ZohoRecruitSearchRecordsCriteriaEntry<T extends ZohoRecruitRecordFieldsData = 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 extends ZohoRecruitRecordFieldsData = ZohoRecruitRecordFieldsData>(entry: ZohoRecruitSearchRecordsCriteriaEntry<T>): ZohoRecruitSearchRecordsCriteriaString;
157
+ export declare function zohoRecruitSearchRecordsCriteriaEntryToCriteriaString<T extends ZohoRecruitRecordFieldsData = any>(entry: ZohoRecruitSearchRecordsCriteriaEntry<T>): ZohoRecruitSearchRecordsCriteriaString;
154
158
  export type ZohoRecruitNoteId = string;
155
159
  export interface ZohoRecruitNoteAction {
156
160
  $is_system_action: boolean;