@dereekb/zoho 13.11.14 → 13.11.15
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/cli/index.js +5 -5
- package/cli/package.json +7 -7
- package/index.cjs.js +569 -503
- package/index.esm.js +569 -503
- package/nestjs/index.cjs.js +248 -255
- package/nestjs/index.esm.js +248 -255
- package/nestjs/package.json +5 -5
- package/nestjs/src/lib/accounts/accounts.config.d.ts +1 -1
- package/nestjs/src/lib/accounts/accounts.service.d.ts +11 -11
- package/nestjs/src/lib/crm/crm.api.d.ts +31 -31
- package/nestjs/src/lib/crm/crm.config.d.ts +1 -1
- package/nestjs/src/lib/crm/crm.module.d.ts +12 -13
- package/nestjs/src/lib/desk/desk.api.d.ts +48 -48
- package/nestjs/src/lib/desk/desk.config.d.ts +2 -1
- package/nestjs/src/lib/desk/desk.module.d.ts +6 -6
- package/nestjs/src/lib/recruit/recruit.api.d.ts +35 -35
- package/nestjs/src/lib/recruit/recruit.config.d.ts +1 -1
- package/nestjs/src/lib/recruit/recruit.module.d.ts +12 -13
- package/nestjs/src/lib/sign/sign.api.d.ts +16 -16
- package/nestjs/src/lib/sign/sign.module.d.ts +12 -13
- package/nestjs/src/lib/sign/webhook/webhook.zoho.sign.d.ts +2 -2
- package/nestjs/src/lib/sign/webhook/webhook.zoho.sign.module.d.ts +3 -3
- package/nestjs/src/lib/sign/webhook/webhook.zoho.sign.verify.d.ts +2 -2
- package/nestjs/src/lib/zoho.config.d.ts +2 -1
- package/package.json +8 -8
- package/src/lib/accounts/accounts.api.d.ts +10 -10
- package/src/lib/accounts/accounts.config.d.ts +2 -2
- package/src/lib/accounts/accounts.d.ts +3 -2
- package/src/lib/accounts/accounts.error.api.d.ts +5 -5
- package/src/lib/accounts/accounts.factory.d.ts +8 -6
- package/src/lib/crm/crm.api.d.ts +87 -81
- package/src/lib/crm/crm.api.notes.d.ts +11 -10
- package/src/lib/crm/crm.api.tags.d.ts +16 -14
- package/src/lib/crm/crm.config.d.ts +2 -2
- package/src/lib/crm/crm.d.ts +2 -2
- package/src/lib/crm/crm.error.api.d.ts +10 -10
- package/src/lib/crm/crm.factory.d.ts +3 -2
- package/src/lib/crm/crm.notes.d.ts +2 -2
- package/src/lib/desk/desk.agent.d.ts +2 -2
- package/src/lib/desk/desk.api.activities.d.ts +5 -4
- package/src/lib/desk/desk.api.agents.d.ts +11 -10
- package/src/lib/desk/desk.api.attachments.d.ts +4 -4
- package/src/lib/desk/desk.api.comments.d.ts +8 -8
- package/src/lib/desk/desk.api.contacts.d.ts +9 -8
- package/src/lib/desk/desk.api.departments.d.ts +4 -4
- package/src/lib/desk/desk.api.followers.d.ts +6 -6
- package/src/lib/desk/desk.api.page.d.ts +6 -5
- package/src/lib/desk/desk.api.tags.d.ts +10 -10
- package/src/lib/desk/desk.api.threads.d.ts +7 -6
- package/src/lib/desk/desk.api.tickets.d.ts +23 -21
- package/src/lib/desk/desk.api.time.d.ts +10 -10
- package/src/lib/desk/desk.config.d.ts +2 -2
- package/src/lib/desk/desk.error.api.d.ts +5 -5
- package/src/lib/desk/desk.factory.d.ts +3 -2
- package/src/lib/desk/desk.limit.d.ts +3 -3
- package/src/lib/desk/desk.ticket.d.ts +4 -4
- package/src/lib/recruit/recruit.api.candidates.d.ts +15 -13
- package/src/lib/recruit/recruit.api.d.ts +85 -80
- package/src/lib/recruit/recruit.api.notes.d.ts +11 -10
- package/src/lib/recruit/recruit.api.tags.d.ts +19 -18
- package/src/lib/recruit/recruit.config.d.ts +2 -2
- package/src/lib/recruit/recruit.d.ts +2 -2
- package/src/lib/recruit/recruit.error.api.d.ts +10 -10
- package/src/lib/recruit/recruit.factory.d.ts +3 -2
- package/src/lib/recruit/recruit.notes.d.ts +2 -2
- package/src/lib/shared/criteria.d.ts +5 -5
- package/src/lib/shared/criteria.util.d.ts +2 -2
- package/src/lib/sign/sign.api.d.ts +47 -46
- package/src/lib/sign/sign.api.page.d.ts +6 -5
- package/src/lib/sign/sign.config.d.ts +2 -2
- package/src/lib/sign/sign.d.ts +4 -4
- package/src/lib/sign/sign.error.api.d.ts +5 -5
- package/src/lib/sign/sign.factory.d.ts +3 -2
- package/src/lib/zoho.api.page.d.ts +5 -4
- package/src/lib/zoho.error.api.d.ts +17 -14
- package/src/lib/zoho.limit.d.ts +6 -5
- package/src/lib/zoho.type.d.ts +1 -1
package/index.cjs.js
CHANGED
|
@@ -55,7 +55,7 @@ function _object_spread_props$n(target, source) {
|
|
|
55
55
|
* Creates an empty {@link ZohoPageResult} with no data and `more_records: false`.
|
|
56
56
|
* Useful as a fallback when the API returns `null` instead of an empty result.
|
|
57
57
|
*
|
|
58
|
-
* @returns An empty page result with default pagination info
|
|
58
|
+
* @returns An empty page result with default pagination info.
|
|
59
59
|
*/ function emptyZohoPageResult() {
|
|
60
60
|
return {
|
|
61
61
|
data: [],
|
|
@@ -73,9 +73,9 @@ function _object_spread_props$n(target, source) {
|
|
|
73
73
|
* The factory reads `info.more_records` from each response to determine if additional
|
|
74
74
|
* pages exist, and automatically increments the `page` parameter for subsequent requests.
|
|
75
75
|
*
|
|
76
|
-
* @param fetch - The Zoho fetch function to paginate over
|
|
77
|
-
* @param defaults - Optional default configuration for the page factory
|
|
78
|
-
* @returns A page factory that produces iterable page fetchers
|
|
76
|
+
* @param fetch - The Zoho fetch function to paginate over.
|
|
77
|
+
* @param defaults - Optional default configuration for the page factory.
|
|
78
|
+
* @returns A page factory that produces iterable page fetchers.
|
|
79
79
|
*
|
|
80
80
|
* @example
|
|
81
81
|
* ```typescript
|
|
@@ -88,6 +88,7 @@ function _object_spread_props$n(target, source) {
|
|
|
88
88
|
* const secondPage = await firstPage.fetchNext();
|
|
89
89
|
* }
|
|
90
90
|
* ```
|
|
91
|
+
*
|
|
91
92
|
* @__NO_SIDE_EFFECTS__
|
|
92
93
|
*/ function zohoFetchPageFactory(fetch$1, defaults) {
|
|
93
94
|
return fetch.fetchPageFactory(_object_spread_props$n(_object_spread$o({}, defaults), {
|
|
@@ -115,17 +116,22 @@ function _object_spread_props$n(target, source) {
|
|
|
115
116
|
/**
|
|
116
117
|
* Resolves an environment key or passthrough URL to the full Zoho Recruit API URL.
|
|
117
118
|
*
|
|
118
|
-
* @param input - An environment key ('sandbox' or 'production') or a full API URL
|
|
119
|
-
* @returns The resolved Zoho Recruit API URL
|
|
119
|
+
* @param input - An environment key ('sandbox' or 'production') or a full API URL.
|
|
120
|
+
* @returns The resolved Zoho Recruit API URL.
|
|
120
121
|
*/ function zohoRecruitConfigApiUrl(input) {
|
|
122
|
+
var result;
|
|
121
123
|
switch(input){
|
|
122
124
|
case 'sandbox':
|
|
123
|
-
|
|
125
|
+
result = 'https://recruitsandbox.zoho.com/recruit';
|
|
126
|
+
break;
|
|
124
127
|
case 'production':
|
|
125
|
-
|
|
128
|
+
result = 'https://recruit.zoho.com/recruit';
|
|
129
|
+
break;
|
|
126
130
|
default:
|
|
127
|
-
|
|
131
|
+
result = input;
|
|
132
|
+
break;
|
|
128
133
|
}
|
|
134
|
+
return result;
|
|
129
135
|
}
|
|
130
136
|
|
|
131
137
|
/**
|
|
@@ -168,8 +174,8 @@ function _type_of$6(obj) {
|
|
|
168
174
|
* {@link ZohoSearchRecordsCriteriaTree} with nested AND/OR groups. Returns
|
|
169
175
|
* `undefined` when the input is nullish or empty.
|
|
170
176
|
*
|
|
171
|
-
* @param input - Criteria tree element, entry array, or raw criteria string
|
|
172
|
-
* @returns Compiled criteria string, or `undefined` if input is empty
|
|
177
|
+
* @param input - Criteria tree element, entry array, or raw criteria string.
|
|
178
|
+
* @returns Compiled criteria string, or `undefined` if input is empty.
|
|
173
179
|
*
|
|
174
180
|
* @example
|
|
175
181
|
* ```typescript
|
|
@@ -219,8 +225,8 @@ function _type_of$6(obj) {
|
|
|
219
225
|
* recursively resolving nested AND/OR groups. When both `and` and `or` are
|
|
220
226
|
* present at the same level, the OR group is merged into the AND group.
|
|
221
227
|
*
|
|
222
|
-
* @param tree - Criteria tree containing `and` and/or `or` branches
|
|
223
|
-
* @returns Compiled criteria string, or `undefined` if the tree is empty
|
|
228
|
+
* @param tree - Criteria tree containing `and` and/or `or` branches.
|
|
229
|
+
* @returns Compiled criteria string, or `undefined` if the tree is empty.
|
|
224
230
|
*/ function zohoSearchRecordsCriteriaStringForTree(tree) {
|
|
225
231
|
function convertToString(value) {
|
|
226
232
|
var result;
|
|
@@ -275,7 +281,7 @@ function _type_of$6(obj) {
|
|
|
275
281
|
*
|
|
276
282
|
* Automatically escapes parentheses and commas in the value via {@link escapeZohoFieldValueForCriteriaString}.
|
|
277
283
|
*
|
|
278
|
-
* @param entry - The criteria entry to convert
|
|
284
|
+
* @param entry - The criteria entry to convert.
|
|
279
285
|
* @returns Criteria string in the format `(field:filter:escapedValue)`
|
|
280
286
|
*
|
|
281
287
|
* @example
|
|
@@ -564,8 +570,8 @@ function _ts_generator$b(thisArg, body) {
|
|
|
564
570
|
/**
|
|
565
571
|
* Normalizes a Zoho error response entry into a consistent {@link ZohoServerErrorData} shape, handling both object and string error formats.
|
|
566
572
|
*
|
|
567
|
-
* @param error - The raw error entry, either a structured object or a plain error code string
|
|
568
|
-
* @returns Normalized error data with code and message fields
|
|
573
|
+
* @param error - The raw error entry, either a structured object or a plain error code string.
|
|
574
|
+
* @returns Normalized error data with code and message fields.
|
|
569
575
|
*/ function zohoServerErrorData(error) {
|
|
570
576
|
var errorType = typeof error === "undefined" ? "undefined" : _type_of$5(error);
|
|
571
577
|
var errorData;
|
|
@@ -651,8 +657,9 @@ function _ts_generator$b(thisArg, body) {
|
|
|
651
657
|
* Creates a logZohoServerErrorFunction that logs the error to console.
|
|
652
658
|
*
|
|
653
659
|
* @param zohoApiNamePrefix - Prefix to use when logging (e.g. 'ZohoRecruit', 'ZohoSign')
|
|
654
|
-
* @param options - Optional configuration for controlling which error types are logged
|
|
655
|
-
* @returns
|
|
660
|
+
* @param options - Optional configuration for controlling which error types are logged.
|
|
661
|
+
* @returns Logs Zoho server errors to the console.
|
|
662
|
+
*
|
|
656
663
|
* @__NO_SIDE_EFFECTS__
|
|
657
664
|
*/ function logZohoServerErrorFunction(zohoApiNamePrefix, options) {
|
|
658
665
|
var _ref = options !== null && options !== void 0 ? options : {}, _ref_logDataArrayErrors = _ref.logDataArrayErrors, logDataArrayErrors = _ref_logDataArrayErrors === void 0 ? false : _ref_logDataArrayErrors;
|
|
@@ -676,9 +683,10 @@ function _ts_generator$b(thisArg, body) {
|
|
|
676
683
|
/**
|
|
677
684
|
* Wraps a ConfiguredFetch to support handling errors returned by fetch.
|
|
678
685
|
*
|
|
679
|
-
* @param parseZohoError - Function that parses a fetch response error into a Zoho-specific error
|
|
680
|
-
* @param defaultLogError - Default error logging function used when no custom logger is provided
|
|
681
|
-
* @returns Factory that wraps a ConfiguredFetch with Zoho error handling
|
|
686
|
+
* @param parseZohoError - Function that parses a fetch response error into a Zoho-specific error.
|
|
687
|
+
* @param defaultLogError - Default error logging function used when no custom logger is provided.
|
|
688
|
+
* @returns Factory that wraps a ConfiguredFetch with Zoho error handling.
|
|
689
|
+
*
|
|
682
690
|
* @__NO_SIDE_EFFECTS__
|
|
683
691
|
*/ function handleZohoErrorFetchFactory(parseZohoError, defaultLogError) {
|
|
684
692
|
return function(fetch$1) {
|
|
@@ -737,8 +745,9 @@ function _ts_generator$b(thisArg, body) {
|
|
|
737
745
|
/**
|
|
738
746
|
* FetchJsonInterceptJsonResponseFunction that intercepts a 200 response that actually contains a ZohoServerError and throws a ZohoServerError for the error handling to catch.
|
|
739
747
|
*
|
|
740
|
-
* @param parseZohoServerErrorResponseData - Function that parses raw error response data into a structured error
|
|
741
|
-
* @returns Interceptor function that detects and throws hidden errors in 200 responses
|
|
748
|
+
* @param parseZohoServerErrorResponseData - Function that parses raw error response data into a structured error.
|
|
749
|
+
* @returns Interceptor function that detects and throws hidden errors in 200 responses.
|
|
750
|
+
*
|
|
742
751
|
* @__NO_SIDE_EFFECTS__
|
|
743
752
|
*/ function interceptZohoErrorResponseFactory(parseZohoServerErrorResponseData) {
|
|
744
753
|
return function(json, response) {
|
|
@@ -840,8 +849,8 @@ var DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD = util.MS_IN_MINUTE;
|
|
|
840
849
|
/**
|
|
841
850
|
* Extracts rate limit details from Zoho API response headers, returning null if the headers are absent.
|
|
842
851
|
*
|
|
843
|
-
* @param headers - HTTP response headers from a Zoho API call
|
|
844
|
-
* @returns Parsed rate limit details, or null if rate limit headers are missing
|
|
852
|
+
* @param headers - HTTP response headers from a Zoho API call.
|
|
853
|
+
* @returns Parsed rate limit details, or null if rate limit headers are missing.
|
|
845
854
|
*/ function zohoRateLimitHeaderDetails(headers) {
|
|
846
855
|
var limitHeader = headers.get(ZOHO_RATE_LIMIT_LIMIT_HEADER);
|
|
847
856
|
var remainingHeader = headers.get(ZOHO_RATE_LIMIT_REMAINING_HEADER);
|
|
@@ -880,9 +889,9 @@ var ZohoTooManyRequestsError = /*#__PURE__*/ function(ZohoServerFetchResponseErr
|
|
|
880
889
|
/**
|
|
881
890
|
* Function that parses/transforms a ZohoServerErrorResponseData into a general ZohoServerError or other known error type.
|
|
882
891
|
*
|
|
883
|
-
* @param errorResponseData - Raw error response data from the Zoho API
|
|
884
|
-
* @param responseError - The underlying fetch response error
|
|
885
|
-
* @returns A typed Zoho server error, or undefined if no error is found
|
|
892
|
+
* @param errorResponseData - Raw error response data from the Zoho API.
|
|
893
|
+
* @param responseError - The underlying fetch response error.
|
|
894
|
+
* @returns A typed Zoho server error, or undefined if no error is found.
|
|
886
895
|
*/ function parseZohoServerErrorResponseData(errorResponseData, responseError) {
|
|
887
896
|
var result;
|
|
888
897
|
if (isZohoServerErrorResponseDataArrayRef(errorResponseData)) {
|
|
@@ -1225,8 +1234,8 @@ function _ts_generator$a(thisArg, body) {
|
|
|
1225
1234
|
/**
|
|
1226
1235
|
* Creates a typed CRUD error subclass based on the error code returned by the Zoho Recruit API, enabling callers to catch specific failure modes.
|
|
1227
1236
|
*
|
|
1228
|
-
* @param error - Structured error data from the Zoho Recruit API response
|
|
1229
|
-
* @returns A specific CRUD error subclass matching the error code
|
|
1237
|
+
* @param error - Structured error data from the Zoho Recruit API response.
|
|
1238
|
+
* @returns A specific CRUD error subclass matching the error code.
|
|
1230
1239
|
*/ function zohoRecruitRecordCrudError(error) {
|
|
1231
1240
|
var result;
|
|
1232
1241
|
switch(error.code){
|
|
@@ -1255,9 +1264,9 @@ function _ts_generator$a(thisArg, body) {
|
|
|
1255
1264
|
/**
|
|
1256
1265
|
* Returns an assertion function that throws {@link ZohoRecruitRecordNoContentError} when the data array result is empty or null, indicating the requested record does not exist.
|
|
1257
1266
|
*
|
|
1258
|
-
* @param moduleName - Optional module name for the error context
|
|
1259
|
-
* @param recordId - Optional record ID for the error context
|
|
1260
|
-
* @returns Assertion function that validates the data array is non-empty
|
|
1267
|
+
* @param moduleName - Optional module name for the error context.
|
|
1268
|
+
* @param recordId - Optional record ID for the error context.
|
|
1269
|
+
* @returns Assertion function that validates the data array is non-empty.
|
|
1261
1270
|
*/ function assertZohoRecruitRecordDataArrayResultHasContent(moduleName, recordId) {
|
|
1262
1271
|
return function(x) {
|
|
1263
1272
|
var _x_data;
|
|
@@ -1273,8 +1282,8 @@ function _ts_generator$a(thisArg, body) {
|
|
|
1273
1282
|
/**
|
|
1274
1283
|
* Parses the JSON body of a failed Zoho Recruit fetch response into a structured error, returning undefined if the body cannot be parsed.
|
|
1275
1284
|
*
|
|
1276
|
-
* @param responseError - The fetch response error to parse
|
|
1277
|
-
* @returns Parsed Zoho server error, or undefined if parsing fails
|
|
1285
|
+
* @param responseError - The fetch response error to parse.
|
|
1286
|
+
* @returns Parsed Zoho server error, or undefined if parsing fails.
|
|
1278
1287
|
*/ function parseZohoRecruitError(responseError) {
|
|
1279
1288
|
return _async_to_generator$a(function() {
|
|
1280
1289
|
var data, result;
|
|
@@ -1303,9 +1312,9 @@ function _ts_generator$a(thisArg, body) {
|
|
|
1303
1312
|
/**
|
|
1304
1313
|
* Converts raw Zoho Recruit error response data into a parsed error, delegating to Recruit-specific handlers for known error codes and falling back to the shared Zoho parser.
|
|
1305
1314
|
*
|
|
1306
|
-
* @param errorResponseData - Raw error response data from the Zoho Recruit API
|
|
1307
|
-
* @param responseError - The underlying fetch response error
|
|
1308
|
-
* @returns Parsed Zoho server error, or undefined if the data contains no recognizable error
|
|
1315
|
+
* @param errorResponseData - Raw error response data from the Zoho Recruit API.
|
|
1316
|
+
* @param responseError - The underlying fetch response error.
|
|
1317
|
+
* @returns Parsed Zoho server error, or undefined if the data contains no recognizable error.
|
|
1309
1318
|
*/ function parseZohoRecruitServerErrorResponseData(errorResponseData, responseError) {
|
|
1310
1319
|
var result;
|
|
1311
1320
|
var error = tryFindZohoServerErrorData(errorResponseData, responseError);
|
|
@@ -1327,6 +1336,7 @@ function _ts_generator$a(thisArg, body) {
|
|
|
1327
1336
|
* Wraps a fetch client to automatically parse Zoho Recruit error responses, log them, and invoke a custom handler (e.g., for token refresh on authentication failures).
|
|
1328
1337
|
*/ var handleZohoRecruitErrorFetch = handleZohoErrorFetchFactory(parseZohoRecruitError, logZohoRecruitErrorToConsole);
|
|
1329
1338
|
// MARK: Compat
|
|
1339
|
+
// COMPAT: Deprecated aliases
|
|
1330
1340
|
/**
|
|
1331
1341
|
* @deprecated Use assertZohoRecruitRecordDataArrayResultHasContent instead.
|
|
1332
1342
|
*/ var assertRecordDataArrayResultHasContent = assertZohoRecruitRecordDataArrayResultHasContent;
|
|
@@ -1449,10 +1459,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1449
1459
|
* When a single record is provided, the function returns the change details directly or throws on error.
|
|
1450
1460
|
* When multiple records are provided, it returns a paired success/error result.
|
|
1451
1461
|
*
|
|
1452
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
1462
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
1453
1463
|
* @param fetchUrlPrefix - URL path suffix for the endpoint (empty for insert/update, '/upsert' for upsert)
|
|
1454
|
-
* @param fetchMethod - HTTP method to use for the request
|
|
1455
|
-
* @returns Factory function that inserts, updates, or upserts records
|
|
1464
|
+
* @param fetchMethod - HTTP method to use for the request.
|
|
1465
|
+
* @returns Factory function that inserts, updates, or upserts records.
|
|
1456
1466
|
*/ function updateRecordLikeFunction$1(context, fetchUrlPrefix, fetchMethod) {
|
|
1457
1467
|
return function(param) {
|
|
1458
1468
|
var data = param.data, module = param.module;
|
|
@@ -1485,8 +1495,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1485
1495
|
*
|
|
1486
1496
|
* Maximum of {@link ZOHO_RECRUIT_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
1487
1497
|
*
|
|
1488
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1489
|
-
* @returns Function that inserts records into the specified module
|
|
1498
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1499
|
+
* @returns Function that inserts records into the specified module.
|
|
1500
|
+
*
|
|
1501
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html
|
|
1490
1502
|
*
|
|
1491
1503
|
* @example
|
|
1492
1504
|
* ```typescript
|
|
@@ -1507,8 +1519,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1507
1519
|
* ]
|
|
1508
1520
|
* });
|
|
1509
1521
|
* ```
|
|
1510
|
-
*
|
|
1511
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html
|
|
1512
1522
|
*/ function zohoRecruitInsertRecord(context) {
|
|
1513
1523
|
return updateRecordLikeFunction$1(context, '', 'POST');
|
|
1514
1524
|
}
|
|
@@ -1522,8 +1532,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1522
1532
|
*
|
|
1523
1533
|
* Maximum of {@link ZOHO_RECRUIT_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
1524
1534
|
*
|
|
1525
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1526
|
-
* @returns Function that upserts records in the specified module
|
|
1535
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1536
|
+
* @returns Function that upserts records in the specified module.
|
|
1537
|
+
*
|
|
1538
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html
|
|
1527
1539
|
*
|
|
1528
1540
|
* @example
|
|
1529
1541
|
* ```typescript
|
|
@@ -1550,8 +1562,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1550
1562
|
* ]
|
|
1551
1563
|
* });
|
|
1552
1564
|
* ```
|
|
1553
|
-
*
|
|
1554
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html
|
|
1555
1565
|
*/ function zohoRecruitUpsertRecord(context) {
|
|
1556
1566
|
return updateRecordLikeFunction$1(context, '/upsert', 'POST');
|
|
1557
1567
|
}
|
|
@@ -1564,8 +1574,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1564
1574
|
*
|
|
1565
1575
|
* Maximum of {@link ZOHO_RECRUIT_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
1566
1576
|
*
|
|
1567
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1568
|
-
* @returns Function that updates records in the specified module
|
|
1577
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1578
|
+
* @returns Function that updates records in the specified module.
|
|
1579
|
+
*
|
|
1580
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/update-records.html
|
|
1569
1581
|
*
|
|
1570
1582
|
* @example
|
|
1571
1583
|
* ```typescript
|
|
@@ -1586,8 +1598,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1586
1598
|
* ]
|
|
1587
1599
|
* });
|
|
1588
1600
|
* ```
|
|
1589
|
-
*
|
|
1590
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/update-records.html
|
|
1591
1601
|
*/ function zohoRecruitUpdateRecord(context) {
|
|
1592
1602
|
return updateRecordLikeFunction$1(context, '', 'PUT');
|
|
1593
1603
|
}
|
|
@@ -1598,8 +1608,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1598
1608
|
* an optional `wf_trigger` flag to execute workflow rules on deletion. Returns
|
|
1599
1609
|
* a response with separated success and error entries.
|
|
1600
1610
|
*
|
|
1601
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1602
|
-
* @returns Function that deletes records from the specified module
|
|
1611
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1612
|
+
* @returns Function that deletes records from the specified module.
|
|
1613
|
+
*
|
|
1614
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-records.html
|
|
1603
1615
|
*
|
|
1604
1616
|
* @example
|
|
1605
1617
|
* ```typescript
|
|
@@ -1610,8 +1622,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1610
1622
|
* ids: candidateId
|
|
1611
1623
|
* });
|
|
1612
1624
|
* ```
|
|
1613
|
-
*
|
|
1614
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-records.html
|
|
1615
1625
|
*/ function zohoRecruitDeleteRecord(context) {
|
|
1616
1626
|
return function(param) {
|
|
1617
1627
|
var ids = param.ids, module = param.module, wf_trigger = param.wf_trigger;
|
|
@@ -1628,8 +1638,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1628
1638
|
* unwrapped from the standard data array, returning the record directly.
|
|
1629
1639
|
* Throws if the record is not found.
|
|
1630
1640
|
*
|
|
1631
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1632
|
-
* @returns Function that retrieves a record by module name and ID
|
|
1641
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1642
|
+
* @returns Function that retrieves a record by module name and ID.
|
|
1643
|
+
*
|
|
1644
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
|
|
1633
1645
|
*
|
|
1634
1646
|
* @example
|
|
1635
1647
|
* ```typescript
|
|
@@ -1640,8 +1652,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1640
1652
|
* id: candidateId
|
|
1641
1653
|
* });
|
|
1642
1654
|
* ```
|
|
1643
|
-
*
|
|
1644
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
|
|
1645
1655
|
*/ function zohoRecruitGetRecordById(context) {
|
|
1646
1656
|
return function(input) {
|
|
1647
1657
|
return context.fetchJson("/v2/".concat(input.module, "/").concat(input.id), zohoRecruitApiFetchJsonInput('GET')).then(assertZohoRecruitRecordDataArrayResultHasContent(input.module)).then(function(x) {
|
|
@@ -1656,8 +1666,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1656
1666
|
* selection, sorting, custom view filtering, territory filtering, and
|
|
1657
1667
|
* conversion/approval status filters via {@link ZohoRecruitGetRecordsInput}.
|
|
1658
1668
|
*
|
|
1659
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1660
|
-
* @returns Function that retrieves paginated records from a module
|
|
1669
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1670
|
+
* @returns Function that retrieves paginated records from a module.
|
|
1671
|
+
*
|
|
1672
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
|
|
1661
1673
|
*
|
|
1662
1674
|
* @example
|
|
1663
1675
|
* ```typescript
|
|
@@ -1668,8 +1680,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1668
1680
|
* per_page: 10
|
|
1669
1681
|
* });
|
|
1670
1682
|
* ```
|
|
1671
|
-
*
|
|
1672
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
|
|
1673
1683
|
*/ function zohoRecruitGetRecords(context) {
|
|
1674
1684
|
return function(input) {
|
|
1675
1685
|
return context.fetchJson("/v2/".concat(input.module, "?").concat(zohoRecruitUrlSearchParamsMinusModule(input).toString()), zohoRecruitApiFetchJsonInput('GET'));
|
|
@@ -1683,9 +1693,11 @@ function _is_native_reflect_construct$3() {
|
|
|
1683
1693
|
* At least one search parameter must be provided. Returns a paginated result,
|
|
1684
1694
|
* defaulting to an empty data array when no matches are found.
|
|
1685
1695
|
*
|
|
1686
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1687
|
-
* @returns Function that searches records in the specified module
|
|
1688
|
-
* @throws {Error} If none of `criteria`, `email`, `phone`, or `word` are provided
|
|
1696
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1697
|
+
* @returns Function that searches records in the specified module.
|
|
1698
|
+
* @throws {Error} If none of `criteria`, `email`, `phone`, or `word` are provided.
|
|
1699
|
+
*
|
|
1700
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/search-records.html
|
|
1689
1701
|
*
|
|
1690
1702
|
* @example
|
|
1691
1703
|
* ```typescript
|
|
@@ -1704,8 +1716,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1704
1716
|
* word: 'engineer'
|
|
1705
1717
|
* });
|
|
1706
1718
|
* ```
|
|
1707
|
-
*
|
|
1708
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/search-records.html
|
|
1709
1719
|
*/ function zohoRecruitSearchRecords(context) {
|
|
1710
1720
|
function searchRecordsUrlSearchParams(input) {
|
|
1711
1721
|
var baseInput = _object_spread$n({}, input);
|
|
@@ -1737,8 +1747,8 @@ function _is_native_reflect_construct$3() {
|
|
|
1737
1747
|
* Returns a page factory that automatically handles Zoho Recruit's pagination,
|
|
1738
1748
|
* making it easy to iterate through all search results across multiple pages.
|
|
1739
1749
|
*
|
|
1740
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1741
|
-
* @returns Page factory for iterating over search results
|
|
1750
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1751
|
+
* @returns Page factory for iterating over search results.
|
|
1742
1752
|
*
|
|
1743
1753
|
* @example
|
|
1744
1754
|
* ```typescript
|
|
@@ -1753,6 +1763,7 @@ function _is_native_reflect_construct$3() {
|
|
|
1753
1763
|
* const firstPage = await fetchPage.fetchNext();
|
|
1754
1764
|
* const secondPage = await firstPage.fetchNext();
|
|
1755
1765
|
* ```
|
|
1766
|
+
*
|
|
1756
1767
|
* @__NO_SIDE_EFFECTS__
|
|
1757
1768
|
*/ function zohoRecruitSearchRecordsPageFactory(context) {
|
|
1758
1769
|
return zohoFetchPageFactory(zohoRecruitSearchRecords(context));
|
|
@@ -1766,8 +1777,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1766
1777
|
* target module and empty-result behavior. By default, returns an empty page
|
|
1767
1778
|
* result instead of null when no records are found.
|
|
1768
1779
|
*
|
|
1769
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1770
|
-
* @returns Factory that creates typed related-records retrieval functions
|
|
1780
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1781
|
+
* @returns Factory that creates typed related-records retrieval functions.
|
|
1782
|
+
*
|
|
1783
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1771
1784
|
*
|
|
1772
1785
|
* @example
|
|
1773
1786
|
* ```typescript
|
|
@@ -1784,7 +1797,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1784
1797
|
* });
|
|
1785
1798
|
* ```
|
|
1786
1799
|
*
|
|
1787
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1788
1800
|
* @__NO_SIDE_EFFECTS__
|
|
1789
1801
|
*/ function zohoRecruitGetRelatedRecordsFunctionFactory(context) {
|
|
1790
1802
|
return function(config) {
|
|
@@ -1805,8 +1817,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1805
1817
|
* {@link ZohoRecruitRecordEmailMetadata} entries. When no emails exist for the
|
|
1806
1818
|
* record, the result contains an empty data array rather than null.
|
|
1807
1819
|
*
|
|
1808
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1809
|
-
* @returns Function that retrieves emails for a record
|
|
1820
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1821
|
+
* @returns Function that retrieves emails for a record.
|
|
1822
|
+
*
|
|
1823
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1810
1824
|
*
|
|
1811
1825
|
* @example
|
|
1812
1826
|
* ```typescript
|
|
@@ -1817,8 +1831,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1817
1831
|
* module: ZOHO_RECRUIT_CANDIDATES_MODULE
|
|
1818
1832
|
* });
|
|
1819
1833
|
* ```
|
|
1820
|
-
*
|
|
1821
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1822
1834
|
*/ function zohoRecruitGetEmailsForRecord(context) {
|
|
1823
1835
|
return zohoRecruitGetRelatedRecordsFunctionFactory(context)({
|
|
1824
1836
|
targetModule: ZOHO_RECRUIT_EMAILS_MODULE
|
|
@@ -1831,8 +1843,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1831
1843
|
* multiple pages. Wraps {@link zohoRecruitGetEmailsForRecord} with automatic
|
|
1832
1844
|
* pagination handling via {@link zohoFetchPageFactory}.
|
|
1833
1845
|
*
|
|
1834
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1835
|
-
* @returns Page factory for iterating over record emails
|
|
1846
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1847
|
+
* @returns Page factory for iterating over record emails.
|
|
1848
|
+
*
|
|
1849
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1836
1850
|
*
|
|
1837
1851
|
* @example
|
|
1838
1852
|
* ```typescript
|
|
@@ -1851,7 +1865,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1851
1865
|
* }
|
|
1852
1866
|
* ```
|
|
1853
1867
|
*
|
|
1854
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1855
1868
|
* @__NO_SIDE_EFFECTS__
|
|
1856
1869
|
*/ function zohoRecruitGetEmailsForRecordPageFactory(context) {
|
|
1857
1870
|
return zohoFetchPageFactory(zohoRecruitGetEmailsForRecord(context));
|
|
@@ -1868,8 +1881,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1868
1881
|
* Each attachment entry includes a `$type` field that distinguishes between
|
|
1869
1882
|
* directly uploaded attachments (`'Attachment'`) and linked attachments.
|
|
1870
1883
|
*
|
|
1871
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1872
|
-
* @returns Function that retrieves attachments for a record
|
|
1884
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1885
|
+
* @returns Function that retrieves attachments for a record.
|
|
1886
|
+
*
|
|
1887
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1873
1888
|
*
|
|
1874
1889
|
* @example
|
|
1875
1890
|
* ```typescript
|
|
@@ -1883,8 +1898,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1883
1898
|
* // Filter to only directly uploaded attachments (downloadable):
|
|
1884
1899
|
* const downloadable = result.data.filter((x) => x.$type === 'Attachment');
|
|
1885
1900
|
* ```
|
|
1886
|
-
*
|
|
1887
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1888
1901
|
*/ function zohoRecruitGetAttachmentsForRecord(context) {
|
|
1889
1902
|
return zohoRecruitGetRelatedRecordsFunctionFactory(context)({
|
|
1890
1903
|
targetModule: ZOHO_RECRUIT_ATTACHMENTS_MODULE
|
|
@@ -1897,8 +1910,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1897
1910
|
* across multiple pages. Wraps {@link zohoRecruitGetAttachmentsForRecord} with
|
|
1898
1911
|
* automatic pagination handling via {@link zohoFetchPageFactory}.
|
|
1899
1912
|
*
|
|
1900
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1901
|
-
* @returns Page factory for iterating over record attachments
|
|
1913
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1914
|
+
* @returns Page factory for iterating over record attachments.
|
|
1915
|
+
*
|
|
1916
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1902
1917
|
*
|
|
1903
1918
|
* @example
|
|
1904
1919
|
* ```typescript
|
|
@@ -1917,7 +1932,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1917
1932
|
* }
|
|
1918
1933
|
* ```
|
|
1919
1934
|
*
|
|
1920
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1921
1935
|
* @__NO_SIDE_EFFECTS__
|
|
1922
1936
|
*/ function zohoRecruitGetAttachmentsForRecordPageFactory(context) {
|
|
1923
1937
|
return zohoFetchPageFactory(zohoRecruitGetAttachmentsForRecord(context));
|
|
@@ -1935,10 +1949,12 @@ function _is_native_reflect_construct$3() {
|
|
|
1935
1949
|
* will fetch the file. An attachment category must be specified by ID or name.
|
|
1936
1950
|
* Maximum file size is {@link ZOHO_RECRUIT_ATTACHMENT_MAX_SIZE} (20MB).
|
|
1937
1951
|
*
|
|
1938
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1939
|
-
* @returns Function that uploads an attachment to a record
|
|
1940
|
-
* @throws {Error} If neither `file` nor `attachmentUrl` is provided
|
|
1941
|
-
* @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided
|
|
1952
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1953
|
+
* @returns Function that uploads an attachment to a record.
|
|
1954
|
+
* @throws {Error} If neither `file` nor `attachmentUrl` is provided.
|
|
1955
|
+
* @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided.
|
|
1956
|
+
*
|
|
1957
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/upload-attachment.html
|
|
1942
1958
|
*
|
|
1943
1959
|
* @example
|
|
1944
1960
|
* ```typescript
|
|
@@ -1960,8 +1976,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1960
1976
|
* attachmentCategoryName: 'Others'
|
|
1961
1977
|
* });
|
|
1962
1978
|
* ```
|
|
1963
|
-
*
|
|
1964
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/upload-attachment.html
|
|
1965
1979
|
*/ function zohoRecruitUploadAttachmentForRecord(context) {
|
|
1966
1980
|
return function(input) {
|
|
1967
1981
|
var _urlParams_attachments_category_id, _urlParams_attachments_category;
|
|
@@ -2006,8 +2020,10 @@ function _is_native_reflect_construct$3() {
|
|
|
2006
2020
|
* {@link FetchFileResponse} containing the file data and metadata extracted
|
|
2007
2021
|
* from the response headers.
|
|
2008
2022
|
*
|
|
2009
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2010
|
-
* @returns Function that downloads an attachment by record and attachment ID
|
|
2023
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2024
|
+
* @returns Function that downloads an attachment by record and attachment ID.
|
|
2025
|
+
*
|
|
2026
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/download-attachments.html
|
|
2011
2027
|
*
|
|
2012
2028
|
* @example
|
|
2013
2029
|
* ```typescript
|
|
@@ -2019,8 +2035,6 @@ function _is_native_reflect_construct$3() {
|
|
|
2019
2035
|
* attachment_id: attachmentId
|
|
2020
2036
|
* });
|
|
2021
2037
|
* ```
|
|
2022
|
-
*
|
|
2023
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/download-attachments.html
|
|
2024
2038
|
*/ function zohoRecruitDownloadAttachmentForRecord(context) {
|
|
2025
2039
|
return function(input) {
|
|
2026
2040
|
return context.fetch("/v2/".concat(input.module, "/").concat(input.id, "/").concat(ZOHO_RECRUIT_ATTACHMENTS_MODULE, "/").concat(input.attachment_id), {
|
|
@@ -2034,8 +2048,10 @@ function _is_native_reflect_construct$3() {
|
|
|
2034
2048
|
* Deletes a specific attachment from a record by its attachment ID.
|
|
2035
2049
|
* Returns the raw {@link Response}.
|
|
2036
2050
|
*
|
|
2037
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2038
|
-
* @returns Function that deletes an attachment by record and attachment ID
|
|
2051
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2052
|
+
* @returns Function that deletes an attachment by record and attachment ID.
|
|
2053
|
+
*
|
|
2054
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-attachments.html
|
|
2039
2055
|
*
|
|
2040
2056
|
* @example
|
|
2041
2057
|
* ```typescript
|
|
@@ -2047,8 +2063,6 @@ function _is_native_reflect_construct$3() {
|
|
|
2047
2063
|
* attachment_id: attachmentId
|
|
2048
2064
|
* });
|
|
2049
2065
|
* ```
|
|
2050
|
-
*
|
|
2051
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-attachments.html
|
|
2052
2066
|
*/ function zohoRecruitDeleteAttachmentFromRecord(context) {
|
|
2053
2067
|
return function(input) {
|
|
2054
2068
|
return context.fetch("/v2/".concat(input.module, "/").concat(input.id, "/").concat(ZOHO_RECRUIT_ATTACHMENTS_MODULE, "/").concat(input.attachment_id), {
|
|
@@ -2081,9 +2095,9 @@ function _is_native_reflect_construct$3() {
|
|
|
2081
2095
|
* - There is no documentation for ZohoRecruit specifically, but it seems to behave the same way
|
|
2082
2096
|
* - You will need the following scopes: ZohoRecruit.functions.execute.READ,ZohoRecruit.functions.execute.CREATE
|
|
2083
2097
|
*
|
|
2084
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2085
|
-
* @returns Function that executes serverless functions via the REST API
|
|
2086
|
-
* @throws {ZohoRecruitExecuteRestApiFunctionError} If the function execution fails
|
|
2098
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2099
|
+
* @returns Function that executes serverless functions via the REST API.
|
|
2100
|
+
* @throws {ZohoRecruitExecuteRestApiFunctionError} If the function execution fails.
|
|
2087
2101
|
*
|
|
2088
2102
|
* @example
|
|
2089
2103
|
* ```typescript
|
|
@@ -2105,6 +2119,7 @@ function _is_native_reflect_construct$3() {
|
|
|
2105
2119
|
* apiUrl: 'production'
|
|
2106
2120
|
* });
|
|
2107
2121
|
* ```
|
|
2122
|
+
*
|
|
2108
2123
|
* @__NO_SIDE_EFFECTS__
|
|
2109
2124
|
*/ function zohoRecruitExecuteRestApiFunction(context) {
|
|
2110
2125
|
return function(input) {
|
|
@@ -2127,8 +2142,8 @@ function _is_native_reflect_construct$3() {
|
|
|
2127
2142
|
/**
|
|
2128
2143
|
* Builds URL search params from input objects, omitting the `module` key since it is used in the URL path rather than query string.
|
|
2129
2144
|
*
|
|
2130
|
-
* @param input - One or more objects whose key-value pairs become query parameters
|
|
2131
|
-
* @returns URLSearchParams with the `module` key excluded
|
|
2145
|
+
* @param input - One or more objects whose key-value pairs become query parameters.
|
|
2146
|
+
* @returns URLSearchParams with the `module` key excluded.
|
|
2132
2147
|
*/ function zohoRecruitUrlSearchParamsMinusModule() {
|
|
2133
2148
|
for(var _len = arguments.length, input = new Array(_len), _key = 0; _key < _len; _key++){
|
|
2134
2149
|
input[_key] = arguments[_key];
|
|
@@ -2140,8 +2155,8 @@ function _is_native_reflect_construct$3() {
|
|
|
2140
2155
|
/**
|
|
2141
2156
|
* Builds URL search params from input objects, omitting both `id` and `module` keys since they are used in the URL path.
|
|
2142
2157
|
*
|
|
2143
|
-
* @param input - One or more objects whose key-value pairs become query parameters
|
|
2144
|
-
* @returns URLSearchParams with `id` and `module` keys excluded
|
|
2158
|
+
* @param input - One or more objects whose key-value pairs become query parameters.
|
|
2159
|
+
* @returns URLSearchParams with `id` and `module` keys excluded.
|
|
2145
2160
|
*/ function zohoRecruitUrlSearchParamsMinusIdAndModule() {
|
|
2146
2161
|
for(var _len = arguments.length, input = new Array(_len), _key = 0; _key < _len; _key++){
|
|
2147
2162
|
input[_key] = arguments[_key];
|
|
@@ -2153,15 +2168,12 @@ function _is_native_reflect_construct$3() {
|
|
|
2153
2168
|
]
|
|
2154
2169
|
});
|
|
2155
2170
|
}
|
|
2156
|
-
/**
|
|
2157
|
-
* @deprecated use makeUrlSearchParams instead.
|
|
2158
|
-
*/ var zohoRecruitUrlSearchParams = fetch.makeUrlSearchParams;
|
|
2159
2171
|
/**
|
|
2160
2172
|
* Constructs a standard {@link FetchJsonInput} for Zoho Recruit API calls with the given HTTP method and optional body.
|
|
2161
2173
|
*
|
|
2162
|
-
* @param method - HTTP method for the request
|
|
2163
|
-
* @param body - Optional JSON body to include in the request
|
|
2164
|
-
* @returns Configured fetch JSON input
|
|
2174
|
+
* @param method - HTTP method for the request.
|
|
2175
|
+
* @param body - Optional JSON body to include in the request.
|
|
2176
|
+
* @returns Configured fetch JSON input.
|
|
2165
2177
|
*/ function zohoRecruitApiFetchJsonInput(method, body) {
|
|
2166
2178
|
return {
|
|
2167
2179
|
method: method,
|
|
@@ -2178,8 +2190,8 @@ function _is_native_reflect_construct$3() {
|
|
|
2178
2190
|
* Used internally by {@link zohoRecruitDeleteRecord} and similar functions to provide
|
|
2179
2191
|
* convenient access to separated success/error results.
|
|
2180
2192
|
*
|
|
2181
|
-
* @param response - Raw change operation response containing mixed success/error entries
|
|
2182
|
-
* @returns The response augmented with pre-separated `successItems` and `errorItems` arrays
|
|
2193
|
+
* @param response - Raw change operation response containing mixed success/error entries.
|
|
2194
|
+
* @returns The response augmented with pre-separated `successItems` and `errorItems` arrays.
|
|
2183
2195
|
*
|
|
2184
2196
|
* @example
|
|
2185
2197
|
* ```typescript
|
|
@@ -2216,9 +2228,9 @@ function _is_native_reflect_construct$3() {
|
|
|
2216
2228
|
* Used internally by {@link updateRecordLikeFunction} to pair input data with API outcomes
|
|
2217
2229
|
* for insert, update, and upsert operations.
|
|
2218
2230
|
*
|
|
2219
|
-
* @param input - Array of input records that were submitted to the API
|
|
2231
|
+
* @param input - Array of input records that were submitted to the API.
|
|
2220
2232
|
* @param results - Array of per-record results returned by the API, positionally aligned with `input`
|
|
2221
|
-
* @returns Object with `successItems` and `errorItems`, each containing paired `{ input, result }` entries
|
|
2233
|
+
* @returns Object with `successItems` and `errorItems`, each containing paired `{ input, result }` entries.
|
|
2222
2234
|
*/ function zohoRecruitMultiRecordResult(input, results) {
|
|
2223
2235
|
var successItems = [];
|
|
2224
2236
|
var errorItems = [];
|
|
@@ -2242,6 +2254,11 @@ function _is_native_reflect_construct$3() {
|
|
|
2242
2254
|
};
|
|
2243
2255
|
return result;
|
|
2244
2256
|
}
|
|
2257
|
+
// MARK: Compat
|
|
2258
|
+
// COMPAT: Deprecated aliases
|
|
2259
|
+
/**
|
|
2260
|
+
* @deprecated use makeUrlSearchParams instead.
|
|
2261
|
+
*/ var zohoRecruitUrlSearchParams = fetch.makeUrlSearchParams;
|
|
2245
2262
|
/**
|
|
2246
2263
|
* @deprecated Use zohoRecruitInsertRecord instead.
|
|
2247
2264
|
*/ var insertRecord = zohoRecruitInsertRecord;
|
|
@@ -2346,10 +2363,10 @@ function _object_spread_props$l(target, source) {
|
|
|
2346
2363
|
*
|
|
2347
2364
|
* The result separates "already associated" errors from other errors, allowing callers to treat duplicate associations as non-fatal.
|
|
2348
2365
|
*
|
|
2349
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2366
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2350
2367
|
* @returns Factory function that associates candidates with job openings
|
|
2351
2368
|
*
|
|
2352
|
-
* https://www.zoho.com/recruit/developer-guide/apiv2/associate-candidate.html
|
|
2369
|
+
* https://www.zoho.com/recruit/developer-guide/apiv2/associate-candidate.html.
|
|
2353
2370
|
*/ function zohoRecruitAssociateCandidateRecordsWithJobOpenings(context) {
|
|
2354
2371
|
return function(input) {
|
|
2355
2372
|
return context.fetchJson("/v2/".concat(ZOHO_RECRUIT_CANDIDATES_MODULE, "/actions/associate"), zohoRecruitApiFetchJsonInput('PUT', {
|
|
@@ -2373,8 +2390,8 @@ function _object_spread_props$l(target, source) {
|
|
|
2373
2390
|
/**
|
|
2374
2391
|
* Searches for records associated with a given candidate or job opening. Returns an empty page result when no records are found.
|
|
2375
2392
|
*
|
|
2376
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2377
|
-
* @returns Factory function that searches for associated records
|
|
2393
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2394
|
+
* @returns Factory function that searches for associated records.
|
|
2378
2395
|
*/ function zohoRecruitSearchAssociatedRecords(context) {
|
|
2379
2396
|
return function(input) {
|
|
2380
2397
|
return context.fetchJson("/v2/".concat(input.module, "/").concat(input.id, "/associate?").concat(zohoRecruitUrlSearchParamsMinusIdAndModule(input).toString()), zohoRecruitApiFetchJsonInput('GET')).then(function(x) {
|
|
@@ -2386,8 +2403,8 @@ function _object_spread_props$l(target, source) {
|
|
|
2386
2403
|
/**
|
|
2387
2404
|
* Searches for job openings associated with a specific candidate.
|
|
2388
2405
|
*
|
|
2389
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2390
|
-
* @returns Factory function that searches for job openings associated with a candidate
|
|
2406
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2407
|
+
* @returns Factory function that searches for job openings associated with a candidate.
|
|
2391
2408
|
*/ function zohoRecruitSearchCandidateAssociatedJobOpeningRecords(context) {
|
|
2392
2409
|
var searchAssociatedRecordsFactory = zohoRecruitSearchAssociatedRecords(context);
|
|
2393
2410
|
return function(input) {
|
|
@@ -2399,8 +2416,9 @@ function _object_spread_props$l(target, source) {
|
|
|
2399
2416
|
/**
|
|
2400
2417
|
* Creates a page factory for paginating over job openings associated with a candidate.
|
|
2401
2418
|
*
|
|
2402
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2403
|
-
* @returns Page factory for iterating through associated job openings
|
|
2419
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2420
|
+
* @returns Page factory for iterating through associated job openings.
|
|
2421
|
+
*
|
|
2404
2422
|
* @__NO_SIDE_EFFECTS__
|
|
2405
2423
|
*/ function zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory(context) {
|
|
2406
2424
|
return zohoFetchPageFactory(zohoRecruitSearchCandidateAssociatedJobOpeningRecords(context));
|
|
@@ -2408,9 +2426,9 @@ function _object_spread_props$l(target, source) {
|
|
|
2408
2426
|
/**
|
|
2409
2427
|
* Searches for candidates associated with a specific job opening.
|
|
2410
2428
|
*
|
|
2411
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2412
|
-
* @param jobOpeningModuleName - Module name for job openings, defaults to the standard module
|
|
2413
|
-
* @returns Factory function that searches for candidates associated with a job opening
|
|
2429
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2430
|
+
* @param jobOpeningModuleName - Module name for job openings, defaults to the standard module.
|
|
2431
|
+
* @returns Factory function that searches for candidates associated with a job opening.
|
|
2414
2432
|
*/ function zohoRecruitSearchJobOpeningAssociatedCandidateRecords(context) {
|
|
2415
2433
|
var jobOpeningModuleName = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : ZOHO_RECRUIT_JOB_OPENINGS_MODULE;
|
|
2416
2434
|
var searchAssociatedRecordsFactory = zohoRecruitSearchAssociatedRecords(context);
|
|
@@ -2423,8 +2441,9 @@ function _object_spread_props$l(target, source) {
|
|
|
2423
2441
|
/**
|
|
2424
2442
|
* Creates a page factory for paginating over candidates associated with a job opening.
|
|
2425
2443
|
*
|
|
2426
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2427
|
-
* @returns Page factory for iterating through associated candidates
|
|
2444
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2445
|
+
* @returns Page factory for iterating through associated candidates.
|
|
2446
|
+
*
|
|
2428
2447
|
* @__NO_SIDE_EFFECTS__
|
|
2429
2448
|
*/ function zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory(context) {
|
|
2430
2449
|
return zohoFetchPageFactory(zohoRecruitSearchJobOpeningAssociatedCandidateRecords(context));
|
|
@@ -2486,8 +2505,8 @@ function _object_spread_props$k(target, source) {
|
|
|
2486
2505
|
* Prefer {@link zohoRecruitCreateNotesForRecord} when creating notes linked to a specific
|
|
2487
2506
|
* record, as it handles the module/parent linking automatically.
|
|
2488
2507
|
*
|
|
2489
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2490
|
-
* @returns Function that creates notes in the Notes module
|
|
2508
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2509
|
+
* @returns Function that creates notes in the Notes module.
|
|
2491
2510
|
*
|
|
2492
2511
|
* @example
|
|
2493
2512
|
* ```typescript
|
|
@@ -2517,8 +2536,8 @@ function _object_spread_props$k(target, source) {
|
|
|
2517
2536
|
* Deletes one or more notes by their IDs from the Notes module. Returns a paired
|
|
2518
2537
|
* success/error result for each note ID.
|
|
2519
2538
|
*
|
|
2520
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2521
|
-
* @returns Function that deletes notes by ID
|
|
2539
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2540
|
+
* @returns Function that deletes notes by ID.
|
|
2522
2541
|
*
|
|
2523
2542
|
* @example
|
|
2524
2543
|
* ```typescript
|
|
@@ -2541,8 +2560,8 @@ function _object_spread_props$k(target, source) {
|
|
|
2541
2560
|
* Retrieves notes related to a specific record by targeting the Notes module
|
|
2542
2561
|
* via the related records API. Returns an empty page result when no notes exist.
|
|
2543
2562
|
*
|
|
2544
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2545
|
-
* @returns Function that retrieves notes for a record
|
|
2563
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2564
|
+
* @returns Function that retrieves notes for a record.
|
|
2546
2565
|
*
|
|
2547
2566
|
* @example
|
|
2548
2567
|
* ```typescript
|
|
@@ -2565,8 +2584,9 @@ function _object_spread_props$k(target, source) {
|
|
|
2565
2584
|
* multiple pages. Wraps {@link zohoRecruitGetNotesForRecord} with automatic
|
|
2566
2585
|
* pagination handling via {@link zohoFetchPageFactory}.
|
|
2567
2586
|
*
|
|
2568
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2569
|
-
* @returns Page factory for iterating over record notes
|
|
2587
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2588
|
+
* @returns Page factory for iterating over record notes.
|
|
2589
|
+
*
|
|
2570
2590
|
* @__NO_SIDE_EFFECTS__
|
|
2571
2591
|
*/ function zohoRecruitGetNotesForRecordPageFactory(context) {
|
|
2572
2592
|
return zohoFetchPageFactory(zohoRecruitGetNotesForRecord(context));
|
|
@@ -2578,8 +2598,8 @@ function _object_spread_props$k(target, source) {
|
|
|
2578
2598
|
* `se_module` and `Parent_Id` on each note entry from the request's `module` and `id`,
|
|
2579
2599
|
* then delegates to {@link zohoRecruitCreateNotes}.
|
|
2580
2600
|
*
|
|
2581
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2582
|
-
* @returns Function that creates notes linked to a specific record
|
|
2601
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2602
|
+
* @returns Function that creates notes linked to a specific record.
|
|
2583
2603
|
*
|
|
2584
2604
|
* @example
|
|
2585
2605
|
* ```typescript
|
|
@@ -2610,6 +2630,7 @@ function _object_spread_props$k(target, source) {
|
|
|
2610
2630
|
};
|
|
2611
2631
|
}
|
|
2612
2632
|
// MARK: Compat
|
|
2633
|
+
// COMPAT: Deprecated aliases
|
|
2613
2634
|
/**
|
|
2614
2635
|
* @deprecated Use zohoRecruitCreateNotes instead.
|
|
2615
2636
|
*/ var createNotes = zohoRecruitCreateNotes;
|
|
@@ -2680,8 +2701,8 @@ function _object_spread_props$j(target, source) {
|
|
|
2680
2701
|
* (which are often non-fatal) from other errors, making it easy to handle the common
|
|
2681
2702
|
* case where a tag already exists.
|
|
2682
2703
|
*
|
|
2683
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2684
|
-
* @returns Function that creates tags in the specified module
|
|
2704
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2705
|
+
* @returns Function that creates tags in the specified module.
|
|
2685
2706
|
*
|
|
2686
2707
|
* @example
|
|
2687
2708
|
* ```typescript
|
|
@@ -2721,8 +2742,10 @@ function _object_spread_props$j(target, source) {
|
|
|
2721
2742
|
* Returns the list of tags within a module. Normalizes the non-standard API response
|
|
2722
2743
|
* that returns data under a `tags` key instead of the standard `data` key.
|
|
2723
2744
|
*
|
|
2724
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2725
|
-
* @returns Function that retrieves tags for a module
|
|
2745
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2746
|
+
* @returns Function that retrieves tags for a module.
|
|
2747
|
+
*
|
|
2748
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-tag-list.html
|
|
2726
2749
|
*
|
|
2727
2750
|
* @example
|
|
2728
2751
|
* ```typescript
|
|
@@ -2732,8 +2755,6 @@ function _object_spread_props$j(target, source) {
|
|
|
2732
2755
|
* module: ZOHO_RECRUIT_CANDIDATES_MODULE
|
|
2733
2756
|
* });
|
|
2734
2757
|
* ```
|
|
2735
|
-
*
|
|
2736
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-tag-list.html
|
|
2737
2758
|
*/ function zohoRecruitGetTagsForModule(context) {
|
|
2738
2759
|
return function(input) {
|
|
2739
2760
|
return context.fetchJson("/v2/settings/tags?".concat(fetch.makeUrlSearchParams({
|
|
@@ -2753,8 +2774,9 @@ function _object_spread_props$j(target, source) {
|
|
|
2753
2774
|
* Returns a page factory for iterating over tags in a module across multiple pages.
|
|
2754
2775
|
* Wraps {@link zohoRecruitGetTagsForModule} with automatic pagination handling.
|
|
2755
2776
|
*
|
|
2756
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2757
|
-
* @returns Page factory for iterating over module tags
|
|
2777
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2778
|
+
* @returns Page factory for iterating over module tags.
|
|
2779
|
+
*
|
|
2758
2780
|
* @__NO_SIDE_EFFECTS__
|
|
2759
2781
|
*/ function zohoRecruitGetTagsForModulePageFactory(context) {
|
|
2760
2782
|
return zohoFetchPageFactory(zohoRecruitGetTagsForModule(context));
|
|
@@ -2769,9 +2791,11 @@ function _object_spread_props$j(target, source) {
|
|
|
2769
2791
|
* Adds one or more tags to one or more records. Returns a paired success/error result
|
|
2770
2792
|
* for each record. Maximum of {@link ZOHO_RECRUIT_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED} (100) record IDs per call.
|
|
2771
2793
|
*
|
|
2772
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2773
|
-
* @returns Function that adds tags to records
|
|
2774
|
-
* @throws {Error} If more than 100 record IDs are provided
|
|
2794
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2795
|
+
* @returns Function that adds tags to records.
|
|
2796
|
+
* @throws {Error} If more than 100 record IDs are provided.
|
|
2797
|
+
*
|
|
2798
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/add-tags.html
|
|
2775
2799
|
*
|
|
2776
2800
|
* @example
|
|
2777
2801
|
* ```typescript
|
|
@@ -2783,8 +2807,6 @@ function _object_spread_props$j(target, source) {
|
|
|
2783
2807
|
* ids: [candidateId1, candidateId2]
|
|
2784
2808
|
* });
|
|
2785
2809
|
* ```
|
|
2786
|
-
*
|
|
2787
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/add-tags.html
|
|
2788
2810
|
*/ function zohoRecruitAddTagsToRecords(context) {
|
|
2789
2811
|
return function(input) {
|
|
2790
2812
|
if (Array.isArray(input.ids) && input.ids.length > ZOHO_RECRUIT_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED) {
|
|
@@ -2811,9 +2833,11 @@ function _object_spread_props$j(target, source) {
|
|
|
2811
2833
|
* Removes one or more tags from one or more records. Returns a paired success/error result
|
|
2812
2834
|
* for each record. Maximum of {@link ZOHO_RECRUIT_REMOVE_TAGS_FROM_RECORDS_MAX_IDS_ALLOWED} (100) record IDs per call.
|
|
2813
2835
|
*
|
|
2814
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2815
|
-
* @returns Function that removes tags from records
|
|
2816
|
-
* @throws {Error} If more than 100 record IDs are provided
|
|
2836
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2837
|
+
* @returns Function that removes tags from records.
|
|
2838
|
+
* @throws {Error} If more than 100 record IDs are provided.
|
|
2839
|
+
*
|
|
2840
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/remove-tags.html
|
|
2817
2841
|
*
|
|
2818
2842
|
* @example
|
|
2819
2843
|
* ```typescript
|
|
@@ -2825,8 +2849,6 @@ function _object_spread_props$j(target, source) {
|
|
|
2825
2849
|
* ids: candidateId
|
|
2826
2850
|
* });
|
|
2827
2851
|
* ```
|
|
2828
|
-
*
|
|
2829
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/remove-tags.html
|
|
2830
2852
|
*/ function zohoRecruitRemoveTagsFromRecords(context) {
|
|
2831
2853
|
return function(input) {
|
|
2832
2854
|
if (Array.isArray(input.ids) && input.ids.length > ZOHO_RECRUIT_REMOVE_TAGS_FROM_RECORDS_MAX_IDS_ALLOWED) {
|
|
@@ -2844,6 +2866,7 @@ function _object_spread_props$j(target, source) {
|
|
|
2844
2866
|
};
|
|
2845
2867
|
}
|
|
2846
2868
|
// MARK: Compat
|
|
2869
|
+
// COMPAT: Deprecated aliases
|
|
2847
2870
|
/**
|
|
2848
2871
|
* @deprecated Use zohoRecruitCreateTagsForModule instead.
|
|
2849
2872
|
*/ var createTagsForModule = zohoRecruitCreateTagsForModule;
|
|
@@ -3099,8 +3122,8 @@ var logZohoAccountsErrorToConsole = logZohoServerErrorFunction('ZohoAccounts');
|
|
|
3099
3122
|
/**
|
|
3100
3123
|
* Parses a fetch response error into a typed Zoho Accounts server error by extracting and interpreting the JSON error body.
|
|
3101
3124
|
*
|
|
3102
|
-
* @param responseError - The fetch response error to parse
|
|
3103
|
-
* @returns The parsed Zoho server error, or undefined if the response could not be parsed
|
|
3125
|
+
* @param responseError - The fetch response error to parse.
|
|
3126
|
+
* @returns The parsed Zoho server error, or undefined if the response could not be parsed.
|
|
3104
3127
|
*/ function parseZohoAccountsError(responseError) {
|
|
3105
3128
|
return _async_to_generator$9(function() {
|
|
3106
3129
|
var data, result;
|
|
@@ -3129,9 +3152,9 @@ var logZohoAccountsErrorToConsole = logZohoServerErrorFunction('ZohoAccounts');
|
|
|
3129
3152
|
/**
|
|
3130
3153
|
* Parses a Zoho Accounts error response body into a typed error. Handles account-specific error codes before falling back to the generic Zoho error parser.
|
|
3131
3154
|
*
|
|
3132
|
-
* @param errorResponseData - The raw error response data from the Zoho Accounts API
|
|
3133
|
-
* @param responseError - The original fetch response error for context
|
|
3134
|
-
* @returns The parsed Zoho server error, or undefined if the error could not be classified
|
|
3155
|
+
* @param errorResponseData - The raw error response data from the Zoho Accounts API.
|
|
3156
|
+
* @param responseError - The original fetch response error for context.
|
|
3157
|
+
* @returns The parsed Zoho server error, or undefined if the error could not be classified.
|
|
3135
3158
|
*/ function parseZohoAccountsServerErrorResponseData(errorResponseData, responseError) {
|
|
3136
3159
|
var result;
|
|
3137
3160
|
var error = errorResponseData.error;
|
|
@@ -3283,8 +3306,9 @@ function _ts_generator$8(thisArg, body) {
|
|
|
3283
3306
|
/**
|
|
3284
3307
|
* Generates a new ZohoAccessTokenStringFactory.
|
|
3285
3308
|
*
|
|
3286
|
-
* @param zohoAccessTokenFactory - Factory that produces ZohoAccessToken instances
|
|
3287
|
-
* @returns A factory function that resolves to the access token string
|
|
3309
|
+
* @param zohoAccessTokenFactory - Factory that produces ZohoAccessToken instances.
|
|
3310
|
+
* @returns A factory function that resolves to the access token string.
|
|
3311
|
+
*
|
|
3288
3312
|
* @__NO_SIDE_EFFECTS__
|
|
3289
3313
|
*/ function zohoAccessTokenStringFactory(zohoAccessTokenFactory) {
|
|
3290
3314
|
return function() {
|
|
@@ -3362,7 +3386,7 @@ function _object_spread_props$i(target, source) {
|
|
|
3362
3386
|
/**
|
|
3363
3387
|
* Default handler that logs a warning to the console when the Zoho API rate limit is exceeded.
|
|
3364
3388
|
*
|
|
3365
|
-
* @param details - Rate limit details extracted from the Zoho API response headers
|
|
3389
|
+
* @param details - Rate limit details extracted from the Zoho API response headers.
|
|
3366
3390
|
*/ var DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION = function DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION(details) {
|
|
3367
3391
|
var limit = 'limit' in details ? details.limit : undefined;
|
|
3368
3392
|
var resetAt = 'resetAt' in details ? details.resetAt : undefined;
|
|
@@ -3382,8 +3406,9 @@ function _object_spread_props$i(target, source) {
|
|
|
3382
3406
|
* - On 429 responses, the request is automatically retried after the rate limiter delay
|
|
3383
3407
|
* - The limiter is disabled when responses lack rate limit headers (e.g., error responses)
|
|
3384
3408
|
*
|
|
3385
|
-
* @param config - Configuration including the service-specific header reader, rate limit, reset period, and 429 handling
|
|
3409
|
+
* @param config - Configuration including the service-specific header reader, rate limit, reset period, and 429 handling.
|
|
3386
3410
|
* @returns A rate-limited fetch handler with the underlying rate limiter accessible via `_rateLimiter`
|
|
3411
|
+
*
|
|
3387
3412
|
* @__NO_SIDE_EFFECTS__
|
|
3388
3413
|
*/ function makeZohoRateLimitedFetchHandler(config) {
|
|
3389
3414
|
var _config_onTooManyRequests, _config_maxRateLimit, _config_resetPeriod;
|
|
@@ -3396,9 +3421,9 @@ function _object_spread_props$i(target, source) {
|
|
|
3396
3421
|
* Called once at initialization with `defaultLimit`, and again dynamically
|
|
3397
3422
|
* when the API's response headers report a different limit value.
|
|
3398
3423
|
*
|
|
3399
|
-
* @param limit - Maximum number of requests allowed per reset period
|
|
3400
|
-
* @param resetAt - Optional date when the rate limit window resets
|
|
3401
|
-
* @returns Rate limiter configuration scaled to the given limit
|
|
3424
|
+
* @param limit - Maximum number of requests allowed per reset period.
|
|
3425
|
+
* @param resetAt - Optional date when the rate limit window resets.
|
|
3426
|
+
* @returns Rate limiter configuration scaled to the given limit.
|
|
3402
3427
|
*/ function configForLimit(limit, resetAt) {
|
|
3403
3428
|
return {
|
|
3404
3429
|
limit: limit,
|
|
@@ -3458,7 +3483,7 @@ function _object_spread_props$i(target, source) {
|
|
|
3458
3483
|
* This is a convenience wrapper around {@link makeZohoRateLimitedFetchHandler} pre-configured
|
|
3459
3484
|
* with the standard Zoho rate limit header reader.
|
|
3460
3485
|
*
|
|
3461
|
-
* @param config - Optional configuration for rate limit, reset period, and 429 handling
|
|
3486
|
+
* @param config - Optional configuration for rate limit, reset period, and 429 handling.
|
|
3462
3487
|
* @returns A rate-limited fetch handler with the underlying rate limiter accessible via `_rateLimiter`
|
|
3463
3488
|
*/ function zohoRateLimitedFetchHandler(config) {
|
|
3464
3489
|
return makeZohoRateLimitedFetchHandler(_object_spread_props$i(_object_spread$j({}, config), {
|
|
@@ -3469,8 +3494,8 @@ function _object_spread_props$i(target, source) {
|
|
|
3469
3494
|
* Reads rate limit details from standard Zoho API response headers (`X-RATELIMIT-*`).
|
|
3470
3495
|
* Used by CRM, Recruit, and Sign services.
|
|
3471
3496
|
*
|
|
3472
|
-
* @param headers - HTTP response headers
|
|
3473
|
-
* @returns Parsed rate limit details, or null if headers are absent
|
|
3497
|
+
* @param headers - HTTP response headers.
|
|
3498
|
+
* @returns Parsed rate limit details, or null if headers are absent.
|
|
3474
3499
|
*/ function zohoStandardRateLimitDetailsReader(headers) {
|
|
3475
3500
|
var details = zohoRateLimitHeaderDetails(headers);
|
|
3476
3501
|
var result;
|
|
@@ -3484,6 +3509,7 @@ function _object_spread_props$i(target, source) {
|
|
|
3484
3509
|
return result;
|
|
3485
3510
|
}
|
|
3486
3511
|
// MARK: Compat
|
|
3512
|
+
// COMPAT: Deprecated aliases
|
|
3487
3513
|
/**
|
|
3488
3514
|
* @deprecated use DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION instead.
|
|
3489
3515
|
*/ var DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION = DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION;
|
|
@@ -3679,8 +3705,8 @@ function _ts_generator$7(thisArg, body) {
|
|
|
3679
3705
|
* Each client handles OAuth token refresh on {@link ZohoInvalidTokenError}, rate limiting,
|
|
3680
3706
|
* and Zoho Recruit's non-standard error responses (200 status with error body).
|
|
3681
3707
|
*
|
|
3682
|
-
* @param factoryConfig - Configuration providing account credentials and optional overrides
|
|
3683
|
-
* @returns A factory function that creates authenticated Zoho Recruit clients
|
|
3708
|
+
* @param factoryConfig - Configuration providing account credentials and optional overrides.
|
|
3709
|
+
* @returns A factory function that creates authenticated Zoho Recruit clients.
|
|
3684
3710
|
*
|
|
3685
3711
|
* @example
|
|
3686
3712
|
* ```typescript
|
|
@@ -3695,6 +3721,7 @@ function _ts_generator$7(thisArg, body) {
|
|
|
3695
3721
|
* // Use the recruit context for API calls:
|
|
3696
3722
|
* const { recruitContext } = zohoRecruit;
|
|
3697
3723
|
* ```
|
|
3724
|
+
*
|
|
3698
3725
|
* @__NO_SIDE_EFFECTS__
|
|
3699
3726
|
*/ function zohoRecruitFactory(factoryConfig) {
|
|
3700
3727
|
var accountsContext = factoryConfig.accountsContext;
|
|
@@ -3778,17 +3805,22 @@ function _ts_generator$7(thisArg, body) {
|
|
|
3778
3805
|
/**
|
|
3779
3806
|
* Resolves a CRM API URL input to its full base URL. Well-known keys ('sandbox', 'production') map to their respective Zoho CRM endpoints; custom URLs pass through unchanged.
|
|
3780
3807
|
*
|
|
3781
|
-
* @param input - A well-known environment key or a custom CRM API URL
|
|
3782
|
-
* @returns The resolved full Zoho CRM API base URL
|
|
3808
|
+
* @param input - A well-known environment key or a custom CRM API URL.
|
|
3809
|
+
* @returns The resolved full Zoho CRM API base URL.
|
|
3783
3810
|
*/ function zohoCrmConfigApiUrl(input) {
|
|
3811
|
+
var result;
|
|
3784
3812
|
switch(input){
|
|
3785
3813
|
case 'sandbox':
|
|
3786
|
-
|
|
3814
|
+
result = 'https://crmsandbox.zoho.com/crm';
|
|
3815
|
+
break;
|
|
3787
3816
|
case 'production':
|
|
3788
|
-
|
|
3817
|
+
result = 'https://www.zohoapis.com/crm';
|
|
3818
|
+
break;
|
|
3789
3819
|
default:
|
|
3790
|
-
|
|
3820
|
+
result = input;
|
|
3821
|
+
break;
|
|
3791
3822
|
}
|
|
3823
|
+
return result;
|
|
3792
3824
|
}
|
|
3793
3825
|
|
|
3794
3826
|
/**
|
|
@@ -4142,8 +4174,8 @@ function _ts_generator$6(thisArg, body) {
|
|
|
4142
4174
|
/**
|
|
4143
4175
|
* Maps a Zoho CRM server error to the appropriate typed {@link ZohoCrmRecordCrudError} subclass based on the error code and affected field.
|
|
4144
4176
|
*
|
|
4145
|
-
* @param error - The server error data containing the error code and field details
|
|
4146
|
-
* @returns The appropriate typed CRM CRUD error instance
|
|
4177
|
+
* @param error - The server error data containing the error code and field details.
|
|
4178
|
+
* @returns The appropriate typed CRM CRUD error instance.
|
|
4147
4179
|
*/ function zohoCrmRecordCrudError(error) {
|
|
4148
4180
|
var result;
|
|
4149
4181
|
switch(error.code){
|
|
@@ -4172,9 +4204,9 @@ function _ts_generator$6(thisArg, body) {
|
|
|
4172
4204
|
/**
|
|
4173
4205
|
* Returns an assertion function that throws {@link ZohoCrmRecordNoContentError} when a data array result is empty or null, typically indicating a missing record.
|
|
4174
4206
|
*
|
|
4175
|
-
* @param moduleName - Optional CRM module name for the error context
|
|
4176
|
-
* @param recordId - Optional record ID for the error context
|
|
4177
|
-
* @returns Assertion function that throws if the data array is empty
|
|
4207
|
+
* @param moduleName - Optional CRM module name for the error context.
|
|
4208
|
+
* @param recordId - Optional record ID for the error context.
|
|
4209
|
+
* @returns Assertion function that throws if the data array is empty.
|
|
4178
4210
|
*/ function assertZohoCrmRecordDataArrayResultHasContent(moduleName, recordId) {
|
|
4179
4211
|
return function(x) {
|
|
4180
4212
|
var _x_data;
|
|
@@ -4192,8 +4224,8 @@ function _ts_generator$6(thisArg, body) {
|
|
|
4192
4224
|
/**
|
|
4193
4225
|
* Parses a fetch response error into a typed Zoho CRM server error by extracting and interpreting the JSON error body.
|
|
4194
4226
|
*
|
|
4195
|
-
* @param responseError - The fetch response error to parse
|
|
4196
|
-
* @returns The parsed Zoho server error, or undefined if the response could not be parsed
|
|
4227
|
+
* @param responseError - The fetch response error to parse.
|
|
4228
|
+
* @returns The parsed Zoho server error, or undefined if the response could not be parsed.
|
|
4197
4229
|
*/ function parseZohoCrmError(responseError) {
|
|
4198
4230
|
return _async_to_generator$6(function() {
|
|
4199
4231
|
var data, result;
|
|
@@ -4222,9 +4254,9 @@ function _ts_generator$6(thisArg, body) {
|
|
|
4222
4254
|
/**
|
|
4223
4255
|
* Parses a Zoho CRM error response body into a typed error. Delegates to CRM-specific error code handling before falling back to the generic Zoho error parser.
|
|
4224
4256
|
*
|
|
4225
|
-
* @param errorResponseData - The raw error response data from the Zoho CRM API
|
|
4226
|
-
* @param responseError - The original fetch response error for context
|
|
4227
|
-
* @returns The parsed Zoho server error, or undefined if the error could not be classified
|
|
4257
|
+
* @param errorResponseData - The raw error response data from the Zoho CRM API.
|
|
4258
|
+
* @param responseError - The original fetch response error for context.
|
|
4259
|
+
* @returns The parsed Zoho server error, or undefined if the error could not be classified.
|
|
4228
4260
|
*/ function parseZohoCrmServerErrorResponseData(errorResponseData, responseError) {
|
|
4229
4261
|
var result;
|
|
4230
4262
|
var error = tryFindZohoServerErrorData(errorResponseData, responseError);
|
|
@@ -4372,10 +4404,10 @@ function _is_native_reflect_construct() {
|
|
|
4372
4404
|
* When a single record is provided, the function returns the change details directly or throws on error.
|
|
4373
4405
|
* When multiple records are provided, it returns a paired success/error result.
|
|
4374
4406
|
*
|
|
4375
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
4407
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
4376
4408
|
* @param fetchUrlPrefix - URL path segment appended after the module name (empty string for insert/update, '/upsert' for upsert)
|
|
4377
4409
|
* @param fetchMethod - HTTP method to use for the request (POST for insert/upsert, PUT for update)
|
|
4378
|
-
* @returns Overloaded function handling both single and multi-record operations
|
|
4410
|
+
* @returns Overloaded function handling both single and multi-record operations.
|
|
4379
4411
|
*/ function updateRecordLikeFunction(context, fetchUrlPrefix, fetchMethod) {
|
|
4380
4412
|
return function(param) {
|
|
4381
4413
|
var data = param.data, module = param.module;
|
|
@@ -4408,8 +4440,10 @@ function _is_native_reflect_construct() {
|
|
|
4408
4440
|
*
|
|
4409
4441
|
* Maximum of {@link ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
4410
4442
|
*
|
|
4411
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4412
|
-
* @returns Function that inserts records into the specified module
|
|
4443
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4444
|
+
* @returns Function that inserts records into the specified module.
|
|
4445
|
+
*
|
|
4446
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/insert-records.html
|
|
4413
4447
|
*
|
|
4414
4448
|
* @example
|
|
4415
4449
|
* ```typescript
|
|
@@ -4430,8 +4464,6 @@ function _is_native_reflect_construct() {
|
|
|
4430
4464
|
* ]
|
|
4431
4465
|
* });
|
|
4432
4466
|
* ```
|
|
4433
|
-
*
|
|
4434
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/insert-records.html
|
|
4435
4467
|
*/ function zohoCrmInsertRecord(context) {
|
|
4436
4468
|
return updateRecordLikeFunction(context, '', 'POST');
|
|
4437
4469
|
}
|
|
@@ -4445,8 +4477,10 @@ function _is_native_reflect_construct() {
|
|
|
4445
4477
|
*
|
|
4446
4478
|
* Maximum of {@link ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
4447
4479
|
*
|
|
4448
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4449
|
-
* @returns Function that upserts records in the specified module
|
|
4480
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4481
|
+
* @returns Function that upserts records in the specified module.
|
|
4482
|
+
*
|
|
4483
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/upsert-records.html
|
|
4450
4484
|
*
|
|
4451
4485
|
* @example
|
|
4452
4486
|
* ```typescript
|
|
@@ -4473,8 +4507,6 @@ function _is_native_reflect_construct() {
|
|
|
4473
4507
|
* ]
|
|
4474
4508
|
* });
|
|
4475
4509
|
* ```
|
|
4476
|
-
*
|
|
4477
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/upsert-records.html
|
|
4478
4510
|
*/ function zohoCrmUpsertRecord(context) {
|
|
4479
4511
|
return updateRecordLikeFunction(context, '/upsert', 'POST');
|
|
4480
4512
|
}
|
|
@@ -4487,8 +4519,10 @@ function _is_native_reflect_construct() {
|
|
|
4487
4519
|
*
|
|
4488
4520
|
* Maximum of {@link ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
4489
4521
|
*
|
|
4490
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4491
|
-
* @returns Function that updates records in the specified module
|
|
4522
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4523
|
+
* @returns Function that updates records in the specified module.
|
|
4524
|
+
*
|
|
4525
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/update-records.html
|
|
4492
4526
|
*
|
|
4493
4527
|
* @example
|
|
4494
4528
|
* ```typescript
|
|
@@ -4509,8 +4543,6 @@ function _is_native_reflect_construct() {
|
|
|
4509
4543
|
* ]
|
|
4510
4544
|
* });
|
|
4511
4545
|
* ```
|
|
4512
|
-
*
|
|
4513
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/update-records.html
|
|
4514
4546
|
*/ function zohoCrmUpdateRecord(context) {
|
|
4515
4547
|
return updateRecordLikeFunction(context, '', 'PUT');
|
|
4516
4548
|
}
|
|
@@ -4521,8 +4553,10 @@ function _is_native_reflect_construct() {
|
|
|
4521
4553
|
* an optional `wf_trigger` flag to execute workflow rules on deletion. Returns
|
|
4522
4554
|
* a response with separated success and error entries.
|
|
4523
4555
|
*
|
|
4524
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4525
|
-
* @returns Function that deletes records from the specified module
|
|
4556
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4557
|
+
* @returns Function that deletes records from the specified module.
|
|
4558
|
+
*
|
|
4559
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/delete-records.html
|
|
4526
4560
|
*
|
|
4527
4561
|
* @example
|
|
4528
4562
|
* ```typescript
|
|
@@ -4533,8 +4567,6 @@ function _is_native_reflect_construct() {
|
|
|
4533
4567
|
* ids: contactId
|
|
4534
4568
|
* });
|
|
4535
4569
|
* ```
|
|
4536
|
-
*
|
|
4537
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/delete-records.html
|
|
4538
4570
|
*/ function zohoCrmDeleteRecord(context) {
|
|
4539
4571
|
return function(param) {
|
|
4540
4572
|
var ids = param.ids, module = param.module, wf_trigger = param.wf_trigger;
|
|
@@ -4551,8 +4583,10 @@ function _is_native_reflect_construct() {
|
|
|
4551
4583
|
* unwrapped from the standard data array, returning the record directly.
|
|
4552
4584
|
* Throws if the record is not found.
|
|
4553
4585
|
*
|
|
4554
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4555
|
-
* @returns Function that retrieves a record by module name and ID
|
|
4586
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4587
|
+
* @returns Function that retrieves a record by module name and ID.
|
|
4588
|
+
*
|
|
4589
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
|
|
4556
4590
|
*
|
|
4557
4591
|
* @example
|
|
4558
4592
|
* ```typescript
|
|
@@ -4563,8 +4597,6 @@ function _is_native_reflect_construct() {
|
|
|
4563
4597
|
* id: contactId
|
|
4564
4598
|
* });
|
|
4565
4599
|
* ```
|
|
4566
|
-
*
|
|
4567
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
|
|
4568
4600
|
*/ function zohoCrmGetRecordById(context) {
|
|
4569
4601
|
return function(input) {
|
|
4570
4602
|
return context.fetchJson("/v8/".concat(input.module, "/").concat(input.id), zohoCrmApiFetchJsonInput('GET')).then(assertZohoCrmRecordDataArrayResultHasContent(input.module)).then(function(x) {
|
|
@@ -4579,8 +4611,10 @@ function _is_native_reflect_construct() {
|
|
|
4579
4611
|
* selection, sorting, custom view filtering, territory filtering, and
|
|
4580
4612
|
* conversion/approval status filters via {@link ZohoCrmGetRecordsInput}.
|
|
4581
4613
|
*
|
|
4582
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4583
|
-
* @returns Function that retrieves paginated records from a module
|
|
4614
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4615
|
+
* @returns Function that retrieves paginated records from a module.
|
|
4616
|
+
*
|
|
4617
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
|
|
4584
4618
|
*
|
|
4585
4619
|
* @example
|
|
4586
4620
|
* ```typescript
|
|
@@ -4592,8 +4626,6 @@ function _is_native_reflect_construct() {
|
|
|
4592
4626
|
* per_page: 10
|
|
4593
4627
|
* });
|
|
4594
4628
|
* ```
|
|
4595
|
-
*
|
|
4596
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
|
|
4597
4629
|
*/ function zohoCrmGetRecords(context) {
|
|
4598
4630
|
return function(input) {
|
|
4599
4631
|
return context.fetchJson("/v8/".concat(input.module, "?").concat(zohoCrmUrlSearchParamsMinusModule(input).toString()), zohoCrmApiFetchJsonInput('GET'));
|
|
@@ -4607,9 +4639,11 @@ function _is_native_reflect_construct() {
|
|
|
4607
4639
|
* At least one search parameter must be provided. Returns a paginated result,
|
|
4608
4640
|
* defaulting to an empty data array when no matches are found.
|
|
4609
4641
|
*
|
|
4610
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4611
|
-
* @returns Function that searches records in the specified module
|
|
4612
|
-
* @throws {Error} If none of `criteria`, `email`, `phone`, `cvid`, or `word` are provided
|
|
4642
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4643
|
+
* @returns Function that searches records in the specified module.
|
|
4644
|
+
* @throws {Error} If none of `criteria`, `email`, `phone`, `cvid`, or `word` are provided.
|
|
4645
|
+
*
|
|
4646
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/search-records.html
|
|
4613
4647
|
*
|
|
4614
4648
|
* @example
|
|
4615
4649
|
* ```typescript
|
|
@@ -4628,8 +4662,6 @@ function _is_native_reflect_construct() {
|
|
|
4628
4662
|
* word: 'engineer'
|
|
4629
4663
|
* });
|
|
4630
4664
|
* ```
|
|
4631
|
-
*
|
|
4632
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/search-records.html
|
|
4633
4665
|
*/ function zohoCrmSearchRecords(context) {
|
|
4634
4666
|
function searchRecordsUrlSearchParams(input) {
|
|
4635
4667
|
var baseInput = _object_spread$h({}, input);
|
|
@@ -4660,8 +4692,8 @@ function _is_native_reflect_construct() {
|
|
|
4660
4692
|
* Returns a page factory that automatically handles Zoho CRM's pagination,
|
|
4661
4693
|
* making it easy to iterate through all search results across multiple pages.
|
|
4662
4694
|
*
|
|
4663
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4664
|
-
* @returns Page factory for iterating over search results
|
|
4695
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4696
|
+
* @returns Page factory for iterating over search results.
|
|
4665
4697
|
*
|
|
4666
4698
|
* @example
|
|
4667
4699
|
* ```typescript
|
|
@@ -4676,6 +4708,7 @@ function _is_native_reflect_construct() {
|
|
|
4676
4708
|
* const firstPage = await fetchPage.fetchNext();
|
|
4677
4709
|
* const secondPage = await firstPage.fetchNext();
|
|
4678
4710
|
* ```
|
|
4711
|
+
*
|
|
4679
4712
|
* @__NO_SIDE_EFFECTS__
|
|
4680
4713
|
*/ function zohoCrmSearchRecordsPageFactory(context) {
|
|
4681
4714
|
return zohoFetchPageFactory(zohoCrmSearchRecords(context));
|
|
@@ -4689,8 +4722,10 @@ function _is_native_reflect_construct() {
|
|
|
4689
4722
|
* target module and empty-result behavior. By default, returns an empty page
|
|
4690
4723
|
* result instead of null when no records are found.
|
|
4691
4724
|
*
|
|
4692
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4693
|
-
* @returns Factory that creates typed related-records retrieval functions
|
|
4725
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4726
|
+
* @returns Factory that creates typed related-records retrieval functions.
|
|
4727
|
+
*
|
|
4728
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4694
4729
|
*
|
|
4695
4730
|
* @example
|
|
4696
4731
|
* ```typescript
|
|
@@ -4707,7 +4742,6 @@ function _is_native_reflect_construct() {
|
|
|
4707
4742
|
* });
|
|
4708
4743
|
* ```
|
|
4709
4744
|
*
|
|
4710
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4711
4745
|
* @__NO_SIDE_EFFECTS__
|
|
4712
4746
|
*/ function zohoCrmGetRelatedRecordsFunctionFactory(context) {
|
|
4713
4747
|
return function(config) {
|
|
@@ -4728,8 +4762,10 @@ function _is_native_reflect_construct() {
|
|
|
4728
4762
|
* which returns email data under an `Emails` key instead of the standard `data` key.
|
|
4729
4763
|
* Returns a paginated result of {@link ZohoCrmRecordEmailMetadata} entries.
|
|
4730
4764
|
*
|
|
4731
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4732
|
-
* @returns Function that retrieves emails for a record
|
|
4765
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4766
|
+
* @returns Function that retrieves emails for a record.
|
|
4767
|
+
*
|
|
4768
|
+
* @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
|
|
4733
4769
|
*
|
|
4734
4770
|
* @example
|
|
4735
4771
|
* ```typescript
|
|
@@ -4740,8 +4776,6 @@ function _is_native_reflect_construct() {
|
|
|
4740
4776
|
* module: 'Contacts'
|
|
4741
4777
|
* });
|
|
4742
4778
|
* ```
|
|
4743
|
-
*
|
|
4744
|
-
* @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
|
|
4745
4779
|
*/ function zohoCrmGetEmailsForRecord(context) {
|
|
4746
4780
|
var getEmailsFactory = zohoCrmGetRelatedRecordsFunctionFactory(context)({
|
|
4747
4781
|
targetModule: ZOHO_CRM_EMAILS_MODULE
|
|
@@ -4763,8 +4797,10 @@ function _is_native_reflect_construct() {
|
|
|
4763
4797
|
* multiple pages. Wraps {@link zohoCrmGetEmailsForRecord} with automatic
|
|
4764
4798
|
* pagination handling via {@link zohoFetchPageFactory}.
|
|
4765
4799
|
*
|
|
4766
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4767
|
-
* @returns Page factory for iterating over record emails
|
|
4800
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4801
|
+
* @returns Page factory for iterating over record emails.
|
|
4802
|
+
*
|
|
4803
|
+
* @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
|
|
4768
4804
|
*
|
|
4769
4805
|
* @example
|
|
4770
4806
|
* ```typescript
|
|
@@ -4783,7 +4819,6 @@ function _is_native_reflect_construct() {
|
|
|
4783
4819
|
* }
|
|
4784
4820
|
* ```
|
|
4785
4821
|
*
|
|
4786
|
-
* @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
|
|
4787
4822
|
* @__NO_SIDE_EFFECTS__
|
|
4788
4823
|
*/ function zohoCrmGetEmailsForRecordPageFactory(context) {
|
|
4789
4824
|
return zohoFetchPageFactory(zohoCrmGetEmailsForRecord(context));
|
|
@@ -4797,8 +4832,10 @@ function _is_native_reflect_construct() {
|
|
|
4797
4832
|
* and category information. When no attachments exist for the record, the result
|
|
4798
4833
|
* contains an empty data array rather than null.
|
|
4799
4834
|
*
|
|
4800
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4801
|
-
* @returns Function that retrieves attachments for a record
|
|
4835
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4836
|
+
* @returns Function that retrieves attachments for a record.
|
|
4837
|
+
*
|
|
4838
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4802
4839
|
*
|
|
4803
4840
|
* @example
|
|
4804
4841
|
* ```typescript
|
|
@@ -4810,8 +4847,6 @@ function _is_native_reflect_construct() {
|
|
|
4810
4847
|
* fields: 'File_Name,Size,Created_Time'
|
|
4811
4848
|
* });
|
|
4812
4849
|
* ```
|
|
4813
|
-
*
|
|
4814
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4815
4850
|
*/ function zohoCrmGetAttachmentsForRecord(context) {
|
|
4816
4851
|
return zohoCrmGetRelatedRecordsFunctionFactory(context)({
|
|
4817
4852
|
targetModule: ZOHO_CRM_ATTACHMENTS_MODULE
|
|
@@ -4824,8 +4859,10 @@ function _is_native_reflect_construct() {
|
|
|
4824
4859
|
* across multiple pages. Wraps {@link zohoCrmGetAttachmentsForRecord} with
|
|
4825
4860
|
* automatic pagination handling via {@link zohoFetchPageFactory}.
|
|
4826
4861
|
*
|
|
4827
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4828
|
-
* @returns Page factory for iterating over record attachments
|
|
4862
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4863
|
+
* @returns Page factory for iterating over record attachments.
|
|
4864
|
+
*
|
|
4865
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4829
4866
|
*
|
|
4830
4867
|
* @example
|
|
4831
4868
|
* ```typescript
|
|
@@ -4845,7 +4882,6 @@ function _is_native_reflect_construct() {
|
|
|
4845
4882
|
* }
|
|
4846
4883
|
* ```
|
|
4847
4884
|
*
|
|
4848
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4849
4885
|
* @__NO_SIDE_EFFECTS__
|
|
4850
4886
|
*/ function zohoCrmGetAttachmentsForRecordPageFactory(context) {
|
|
4851
4887
|
return zohoFetchPageFactory(zohoCrmGetAttachmentsForRecord(context));
|
|
@@ -4862,9 +4898,11 @@ function _is_native_reflect_construct() {
|
|
|
4862
4898
|
* multipart/form-data. An attachment category must be specified by ID or name.
|
|
4863
4899
|
* Maximum file size is {@link ZOHO_CRM_ATTACHMENT_MAX_SIZE} (20MB).
|
|
4864
4900
|
*
|
|
4865
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4866
|
-
* @returns Function that uploads an attachment to a record
|
|
4867
|
-
* @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided
|
|
4901
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4902
|
+
* @returns Function that uploads an attachment to a record.
|
|
4903
|
+
* @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided.
|
|
4904
|
+
*
|
|
4905
|
+
* @see https://www.zoho.com/crm/developer/docs/api/v2.1/upload-attachment.html
|
|
4868
4906
|
*
|
|
4869
4907
|
* @example
|
|
4870
4908
|
* ```typescript
|
|
@@ -4877,8 +4915,6 @@ function _is_native_reflect_construct() {
|
|
|
4877
4915
|
* attachmentCategoryName: 'Resume'
|
|
4878
4916
|
* });
|
|
4879
4917
|
* ```
|
|
4880
|
-
*
|
|
4881
|
-
* @see https://www.zoho.com/crm/developer/docs/api/v2.1/upload-attachment.html
|
|
4882
4918
|
*/ function zohoCrmUploadAttachmentForRecord(context) {
|
|
4883
4919
|
return function(input) {
|
|
4884
4920
|
var _urlParams_attachments_category_id, _urlParams_attachments_category;
|
|
@@ -4910,8 +4946,10 @@ function _is_native_reflect_construct() {
|
|
|
4910
4946
|
* {@link FetchFileResponse} containing the file data and metadata extracted
|
|
4911
4947
|
* from the response headers.
|
|
4912
4948
|
*
|
|
4913
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4914
|
-
* @returns Function that downloads an attachment by record and attachment ID
|
|
4949
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4950
|
+
* @returns Function that downloads an attachment by record and attachment ID.
|
|
4951
|
+
*
|
|
4952
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/download-attachments.html
|
|
4915
4953
|
*
|
|
4916
4954
|
* @example
|
|
4917
4955
|
* ```typescript
|
|
@@ -4923,8 +4961,6 @@ function _is_native_reflect_construct() {
|
|
|
4923
4961
|
* attachment_id: attachmentId
|
|
4924
4962
|
* });
|
|
4925
4963
|
* ```
|
|
4926
|
-
*
|
|
4927
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/download-attachments.html
|
|
4928
4964
|
*/ function zohoCrmDownloadAttachmentForRecord(context) {
|
|
4929
4965
|
return function(input) {
|
|
4930
4966
|
return context.fetch("/v8/".concat(input.module, "/").concat(input.id, "/").concat(ZOHO_CRM_ATTACHMENTS_MODULE, "/").concat(input.attachment_id), {
|
|
@@ -4938,8 +4974,10 @@ function _is_native_reflect_construct() {
|
|
|
4938
4974
|
* Deletes a specific attachment from a record by its attachment ID.
|
|
4939
4975
|
* Returns the raw {@link Response}.
|
|
4940
4976
|
*
|
|
4941
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4942
|
-
* @returns Function that deletes an attachment by record and attachment ID
|
|
4977
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4978
|
+
* @returns Function that deletes an attachment by record and attachment ID.
|
|
4979
|
+
*
|
|
4980
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/delete-attachments.html
|
|
4943
4981
|
*
|
|
4944
4982
|
* @example
|
|
4945
4983
|
* ```typescript
|
|
@@ -4951,8 +4989,6 @@ function _is_native_reflect_construct() {
|
|
|
4951
4989
|
* attachment_id: attachmentId
|
|
4952
4990
|
* });
|
|
4953
4991
|
* ```
|
|
4954
|
-
*
|
|
4955
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/delete-attachments.html
|
|
4956
4992
|
*/ function zohoCrmDeleteAttachmentFromRecord(context) {
|
|
4957
4993
|
return function(input) {
|
|
4958
4994
|
return context.fetch("/v8/".concat(input.module, "/").concat(input.id, "/").concat(ZOHO_CRM_ATTACHMENTS_MODULE, "/").concat(input.attachment_id), {
|
|
@@ -4987,9 +5023,9 @@ function _is_native_reflect_construct() {
|
|
|
4987
5023
|
* - There is no documentation for ZohoCrm specifically, but it seems to behave the same way
|
|
4988
5024
|
* - You will need the following scopes: ZohoCrm.functions.execute.READ,ZohoCrm.functions.execute.CREATE
|
|
4989
5025
|
*
|
|
4990
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4991
|
-
* @returns Function that executes serverless functions via the REST API
|
|
4992
|
-
* @throws {ZohoCrmExecuteRestApiFunctionError} If the function execution fails
|
|
5026
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
5027
|
+
* @returns Function that executes serverless functions via the REST API.
|
|
5028
|
+
* @throws {ZohoCrmExecuteRestApiFunctionError} If the function execution fails.
|
|
4993
5029
|
*
|
|
4994
5030
|
* @example
|
|
4995
5031
|
* ```typescript
|
|
@@ -5011,6 +5047,7 @@ function _is_native_reflect_construct() {
|
|
|
5011
5047
|
* apiUrl: 'production'
|
|
5012
5048
|
* });
|
|
5013
5049
|
* ```
|
|
5050
|
+
*
|
|
5014
5051
|
* @__NO_SIDE_EFFECTS__
|
|
5015
5052
|
*/ function zohoCrmExecuteRestApiFunction(context) {
|
|
5016
5053
|
return function(input) {
|
|
@@ -5033,8 +5070,8 @@ function _is_native_reflect_construct() {
|
|
|
5033
5070
|
/**
|
|
5034
5071
|
* Builds URL search params from the input objects, omitting the `module` key since it is used in the URL path rather than as a query parameter.
|
|
5035
5072
|
*
|
|
5036
|
-
* @param input - One or more objects to convert into URL search parameters
|
|
5037
|
-
* @returns URL search params string with the `module` key excluded
|
|
5073
|
+
* @param input - One or more objects to convert into URL search parameters.
|
|
5074
|
+
* @returns URL search params string with the `module` key excluded.
|
|
5038
5075
|
*/ function zohoCrmUrlSearchParamsMinusModule() {
|
|
5039
5076
|
for(var _len = arguments.length, input = new Array(_len), _key = 0; _key < _len; _key++){
|
|
5040
5077
|
input[_key] = arguments[_key];
|
|
@@ -5046,8 +5083,8 @@ function _is_native_reflect_construct() {
|
|
|
5046
5083
|
/**
|
|
5047
5084
|
* Builds URL search params from the input objects, omitting both `id` and `module` keys since they are used in the URL path.
|
|
5048
5085
|
*
|
|
5049
|
-
* @param input - One or more objects to convert into URL search parameters
|
|
5050
|
-
* @returns URL search params string with `id` and `module` keys excluded
|
|
5086
|
+
* @param input - One or more objects to convert into URL search parameters.
|
|
5087
|
+
* @returns URL search params string with `id` and `module` keys excluded.
|
|
5051
5088
|
*/ function zohoCrmUrlSearchParamsMinusIdAndModule() {
|
|
5052
5089
|
for(var _len = arguments.length, input = new Array(_len), _key = 0; _key < _len; _key++){
|
|
5053
5090
|
input[_key] = arguments[_key];
|
|
@@ -5059,15 +5096,12 @@ function _is_native_reflect_construct() {
|
|
|
5059
5096
|
]
|
|
5060
5097
|
});
|
|
5061
5098
|
}
|
|
5062
|
-
/**
|
|
5063
|
-
* @deprecated use makeUrlSearchParams instead.
|
|
5064
|
-
*/ var zohoCrmUrlSearchParams = fetch.makeUrlSearchParams;
|
|
5065
5099
|
/**
|
|
5066
5100
|
* Constructs the standard FetchJsonInput used by CRM API calls, pairing the HTTP method with an optional body.
|
|
5067
5101
|
*
|
|
5068
|
-
* @param method - HTTP method to use for the request
|
|
5069
|
-
* @param body - Optional request body to include
|
|
5070
|
-
* @returns Configured fetch input for the Zoho CRM API call
|
|
5102
|
+
* @param method - HTTP method to use for the request.
|
|
5103
|
+
* @param body - Optional request body to include.
|
|
5104
|
+
* @returns Configured fetch input for the Zoho CRM API call.
|
|
5071
5105
|
*/ function zohoCrmApiFetchJsonInput(method, body) {
|
|
5072
5106
|
return {
|
|
5073
5107
|
method: method,
|
|
@@ -5080,8 +5114,9 @@ function _is_native_reflect_construct() {
|
|
|
5080
5114
|
*
|
|
5081
5115
|
* Use to catch errors from functions that return ZohoCrmChangeObjectLikeResponse and pass the result to zohoCrmChangeObjectLikeResponseSuccessAndErrorPairs.
|
|
5082
5116
|
*
|
|
5083
|
-
* @param e - The error to catch and potentially convert
|
|
5084
|
-
* @returns The error data array wrapped as a change object response
|
|
5117
|
+
* @param e - The error to catch and potentially convert.
|
|
5118
|
+
* @returns The error data array wrapped as a change object response.
|
|
5119
|
+
* @throws Re-throws `e` when it is not a {@link ZohoServerFetchResponseDataArrayError}.
|
|
5085
5120
|
*/ function zohoCrmCatchZohoCrmChangeObjectLikeResponseError(e) {
|
|
5086
5121
|
var result;
|
|
5087
5122
|
if (_instanceof$4(e, ZohoServerFetchResponseDataArrayError)) {
|
|
@@ -5103,8 +5138,8 @@ function _is_native_reflect_construct() {
|
|
|
5103
5138
|
* Used internally by {@link zohoCrmDeleteRecord} and similar functions to provide
|
|
5104
5139
|
* convenient access to separated success/error results.
|
|
5105
5140
|
*
|
|
5106
|
-
* @param response - Raw change operation response containing mixed success/error entries
|
|
5107
|
-
* @returns The response augmented with pre-separated `successItems` and `errorItems` arrays
|
|
5141
|
+
* @param response - Raw change operation response containing mixed success/error entries.
|
|
5142
|
+
* @returns The response augmented with pre-separated `successItems` and `errorItems` arrays.
|
|
5108
5143
|
*
|
|
5109
5144
|
* @example
|
|
5110
5145
|
* ```typescript
|
|
@@ -5141,9 +5176,9 @@ function _is_native_reflect_construct() {
|
|
|
5141
5176
|
* Used internally by {@link updateRecordLikeFunction} to pair input data with API outcomes
|
|
5142
5177
|
* for insert, update, and upsert operations.
|
|
5143
5178
|
*
|
|
5144
|
-
* @param input - Array of input records that were submitted to the API
|
|
5179
|
+
* @param input - Array of input records that were submitted to the API.
|
|
5145
5180
|
* @param results - Array of per-record results returned by the API, positionally aligned with `input`
|
|
5146
|
-
* @returns Object with `successItems` and `errorItems`, each containing paired `{ input, result }` entries
|
|
5181
|
+
* @returns Object with `successItems` and `errorItems`, each containing paired `{ input, result }` entries.
|
|
5147
5182
|
*/ function zohoCrmMultiRecordResult(input, results) {
|
|
5148
5183
|
var successItems = [];
|
|
5149
5184
|
var errorItems = [];
|
|
@@ -5167,6 +5202,11 @@ function _is_native_reflect_construct() {
|
|
|
5167
5202
|
};
|
|
5168
5203
|
return result;
|
|
5169
5204
|
}
|
|
5205
|
+
// MARK: Compat
|
|
5206
|
+
// COMPAT: Deprecated aliases
|
|
5207
|
+
/**
|
|
5208
|
+
* @deprecated use makeUrlSearchParams instead.
|
|
5209
|
+
*/ var zohoCrmUrlSearchParams = fetch.makeUrlSearchParams;
|
|
5170
5210
|
|
|
5171
5211
|
function _define_property$g(obj, key, value) {
|
|
5172
5212
|
if (key in obj) {
|
|
@@ -5220,8 +5260,8 @@ function _object_spread_props$f(target, source) {
|
|
|
5220
5260
|
*
|
|
5221
5261
|
* For creating notes associated with a specific record, prefer {@link zohoCrmCreateNotesForRecord} which handles parent binding automatically.
|
|
5222
5262
|
*
|
|
5223
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5224
|
-
* @returns Function that creates notes in the CRM Notes module
|
|
5263
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5264
|
+
* @returns Function that creates notes in the CRM Notes module.
|
|
5225
5265
|
*/ function zohoCrmCreateNotes(context) {
|
|
5226
5266
|
return function(input) {
|
|
5227
5267
|
return context.fetchJson("/v2/".concat(ZOHO_CRM_NOTES_MODULE), zohoCrmApiFetchJsonInput('POST', {
|
|
@@ -5234,8 +5274,8 @@ function _object_spread_props$f(target, source) {
|
|
|
5234
5274
|
/**
|
|
5235
5275
|
* Deletes one or more notes from the CRM Notes module by their IDs.
|
|
5236
5276
|
*
|
|
5237
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5238
|
-
* @returns Function that deletes notes by their IDs
|
|
5277
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5278
|
+
* @returns Function that deletes notes by their IDs.
|
|
5239
5279
|
*/ function zohoCrmDeleteNotes(context) {
|
|
5240
5280
|
return function(input) {
|
|
5241
5281
|
return context.fetchJson("/v2/".concat(ZOHO_CRM_NOTES_MODULE, "?").concat(fetch.makeUrlSearchParams({
|
|
@@ -5248,8 +5288,8 @@ function _object_spread_props$f(target, source) {
|
|
|
5248
5288
|
/**
|
|
5249
5289
|
* Retrieves paginated notes associated with a specific CRM record using the related records API.
|
|
5250
5290
|
*
|
|
5251
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5252
|
-
* @returns Function that retrieves notes for a specific record
|
|
5291
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5292
|
+
* @returns Function that retrieves notes for a specific record.
|
|
5253
5293
|
*/ function zohoCrmGetNotesForRecord(context) {
|
|
5254
5294
|
return zohoCrmGetRelatedRecordsFunctionFactory(context)({
|
|
5255
5295
|
targetModule: ZOHO_CRM_NOTES_MODULE
|
|
@@ -5258,8 +5298,9 @@ function _object_spread_props$f(target, source) {
|
|
|
5258
5298
|
/**
|
|
5259
5299
|
* Creates a page factory for iterating through all notes for a record across multiple pages.
|
|
5260
5300
|
*
|
|
5261
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5262
|
-
* @returns Page factory for paginating through notes for a record
|
|
5301
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5302
|
+
* @returns Page factory for paginating through notes for a record.
|
|
5303
|
+
*
|
|
5263
5304
|
* @__NO_SIDE_EFFECTS__
|
|
5264
5305
|
*/ function zohoCrmGetNotesForRecordPageFactory(context) {
|
|
5265
5306
|
return zohoFetchPageFactory(zohoCrmGetNotesForRecord(context));
|
|
@@ -5269,8 +5310,8 @@ function _object_spread_props$f(target, source) {
|
|
|
5269
5310
|
*
|
|
5270
5311
|
* https://www.zoho.com/crm/developer/docs/api/v8/create-notes.html
|
|
5271
5312
|
*
|
|
5272
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5273
|
-
* @returns Function that creates notes bound to a specific record
|
|
5313
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5314
|
+
* @returns Function that creates notes bound to a specific record.
|
|
5274
5315
|
*/ function zohoCrmCreateNotesForRecord(context) {
|
|
5275
5316
|
var createNotesInstance = zohoCrmCreateNotes(context);
|
|
5276
5317
|
return function(input) {
|
|
@@ -5370,8 +5411,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5370
5411
|
/**
|
|
5371
5412
|
* Creates one or more tags for a CRM module. Duplicate tag errors are separated from other errors in the result to simplify idempotent workflows.
|
|
5372
5413
|
*
|
|
5373
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5374
|
-
* @returns Function that creates tags for a module
|
|
5414
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5415
|
+
* @returns Function that creates tags for a module.
|
|
5375
5416
|
*/ function zohoCrmCreateTagsForModule(context) {
|
|
5376
5417
|
return function(input) {
|
|
5377
5418
|
return context.fetchJson("/v8/settings/tags?".concat(fetch.makeUrlSearchParams({
|
|
@@ -5413,8 +5454,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5413
5454
|
*
|
|
5414
5455
|
* https://www.zoho.com/crm/developer/docs/api/v8/delete-tag.html
|
|
5415
5456
|
*
|
|
5416
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5417
|
-
* @returns Function that deletes a tag by ID
|
|
5457
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5458
|
+
* @returns Function that deletes a tag by ID.
|
|
5418
5459
|
*/ function zohoCrmDeleteTag(context) {
|
|
5419
5460
|
return function(input) {
|
|
5420
5461
|
return context.fetchJson("/v8/settings/tags/".concat(input.id), zohoCrmApiFetchJsonInput('DELETE')).then(function(x) {
|
|
@@ -5427,8 +5468,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5427
5468
|
*
|
|
5428
5469
|
* https://www.zoho.com/crm/developer-guide/apiv2/get-tag-list.html
|
|
5429
5470
|
*
|
|
5430
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5431
|
-
* @returns Function that retrieves tags for a module
|
|
5471
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5472
|
+
* @returns Function that retrieves tags for a module.
|
|
5432
5473
|
*/ function zohoCrmGetTagsForModule(context) {
|
|
5433
5474
|
return function(input) {
|
|
5434
5475
|
return context.fetchJson("/v8/settings/tags?".concat(fetch.makeUrlSearchParams({
|
|
@@ -5445,8 +5486,9 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5445
5486
|
/**
|
|
5446
5487
|
* Creates a page factory for iterating through all tags in a module across multiple pages.
|
|
5447
5488
|
*
|
|
5448
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5449
|
-
* @returns Page factory for paginating through tags in a module
|
|
5489
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5490
|
+
* @returns Page factory for paginating through tags in a module.
|
|
5491
|
+
*
|
|
5450
5492
|
* @__NO_SIDE_EFFECTS__
|
|
5451
5493
|
*/ function zohoCrmGetTagsForModulePageFactory(context) {
|
|
5452
5494
|
return zohoFetchPageFactory(zohoCrmGetTagsForModule(context));
|
|
@@ -5460,8 +5502,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5460
5502
|
*
|
|
5461
5503
|
* https://www.zoho.com/crm/developer-guide/apiv2/add-tags.html
|
|
5462
5504
|
*
|
|
5463
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5464
|
-
* @returns Function that adds tags to records
|
|
5505
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5506
|
+
* @returns Function that adds tags to records.
|
|
5465
5507
|
*/ function zohoCrmAddTagsToRecords(context) {
|
|
5466
5508
|
return function(input) {
|
|
5467
5509
|
return context.fetchJson("/v8/".concat(input.module, "/actions/add_tags"), zohoCrmApiFetchJsonInput('POST', zohoCrmAddTagsToRecordsRequestBody(input))).then(function(x) {
|
|
@@ -5475,8 +5517,9 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5475
5517
|
/**
|
|
5476
5518
|
* Builds the request body for the add/remove tags endpoints, merging `tag_names` into `tags` and enforcing the max ID limit.
|
|
5477
5519
|
*
|
|
5478
|
-
* @param input - The add/remove tags request containing tag names, tag objects, and record IDs
|
|
5479
|
-
* @returns The formatted request body with merged tags and record IDs
|
|
5520
|
+
* @param input - The add/remove tags request containing tag names, tag objects, and record IDs.
|
|
5521
|
+
* @returns The formatted request body with merged tags and record IDs.
|
|
5522
|
+
* @throws {Error} When `input.ids` exceeds {@link ZOHO_CRM_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED}.
|
|
5480
5523
|
*/ function zohoCrmAddTagsToRecordsRequestBody(input) {
|
|
5481
5524
|
if (Array.isArray(input.ids) && input.ids.length > ZOHO_CRM_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED) {
|
|
5482
5525
|
throw new Error("Cannot add/remove tags from more than ".concat(ZOHO_CRM_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED, " records at once."));
|
|
@@ -5509,8 +5552,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5509
5552
|
*
|
|
5510
5553
|
* https://www.zoho.com/crm/developer-guide/apiv2/remove-tags.html
|
|
5511
5554
|
*
|
|
5512
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5513
|
-
* @returns Function that removes tags from records
|
|
5555
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5556
|
+
* @returns Function that removes tags from records.
|
|
5514
5557
|
*/ function zohoCrmRemoveTagsFromRecords(context) {
|
|
5515
5558
|
return function(input) {
|
|
5516
5559
|
return context.fetchJson("/v8/".concat(input.module, "/actions/remove_tags"), zohoCrmApiFetchJsonInput('POST', zohoCrmAddTagsToRecordsRequestBody(input))).then(function(x) {
|
|
@@ -5713,8 +5756,8 @@ function _ts_generator$5(thisArg, body) {
|
|
|
5713
5756
|
* Each client handles OAuth token refresh on {@link ZohoInvalidTokenError}, rate limiting,
|
|
5714
5757
|
* and Zoho CRM's non-standard error responses (200 status with error body).
|
|
5715
5758
|
*
|
|
5716
|
-
* @param factoryConfig - Configuration providing account credentials and optional overrides
|
|
5717
|
-
* @returns A factory function that creates authenticated Zoho CRM clients
|
|
5759
|
+
* @param factoryConfig - Configuration providing account credentials and optional overrides.
|
|
5760
|
+
* @returns A factory function that creates authenticated Zoho CRM clients.
|
|
5718
5761
|
*
|
|
5719
5762
|
* @example
|
|
5720
5763
|
* ```typescript
|
|
@@ -5729,6 +5772,7 @@ function _ts_generator$5(thisArg, body) {
|
|
|
5729
5772
|
* // Use the CRM context for API calls:
|
|
5730
5773
|
* const { crmContext } = zohoCrm;
|
|
5731
5774
|
* ```
|
|
5775
|
+
*
|
|
5732
5776
|
* @__NO_SIDE_EFFECTS__
|
|
5733
5777
|
*/ function zohoCrmFactory(factoryConfig) {
|
|
5734
5778
|
var accountsContext = factoryConfig.accountsContext;
|
|
@@ -5859,9 +5903,9 @@ function _object_spread_props$c(target, source) {
|
|
|
5859
5903
|
* The factory reads `page_context.has_more_rows` from each response to determine if additional
|
|
5860
5904
|
* pages exist, and automatically advances `start_index` by `row_count` for subsequent requests.
|
|
5861
5905
|
*
|
|
5862
|
-
* @param fetch - The Zoho Sign fetch function to paginate over
|
|
5863
|
-
* @param defaults - Optional default configuration for the page factory
|
|
5864
|
-
* @returns A page factory that produces iterable page fetchers
|
|
5906
|
+
* @param fetch - The Zoho Sign fetch function to paginate over.
|
|
5907
|
+
* @param defaults - Optional default configuration for the page factory.
|
|
5908
|
+
* @returns A page factory that produces iterable page fetchers.
|
|
5865
5909
|
*
|
|
5866
5910
|
* @example
|
|
5867
5911
|
* ```typescript
|
|
@@ -5874,6 +5918,7 @@ function _object_spread_props$c(target, source) {
|
|
|
5874
5918
|
* const secondPage = await firstPage.fetchNext();
|
|
5875
5919
|
* }
|
|
5876
5920
|
* ```
|
|
5921
|
+
*
|
|
5877
5922
|
* @__NO_SIDE_EFFECTS__
|
|
5878
5923
|
*/ function zohoSignFetchPageFactory(fetch$1, defaults) {
|
|
5879
5924
|
return fetch.fetchPageFactory(_object_spread_props$c(_object_spread$d({}, defaults), {
|
|
@@ -5967,9 +6012,9 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
5967
6012
|
/**
|
|
5968
6013
|
* Builds a {@link FetchJsonInput} for Zoho Sign API calls.
|
|
5969
6014
|
*
|
|
5970
|
-
* @param method - HTTP method for the request
|
|
5971
|
-
* @param body - Optional JSON body to include in the request
|
|
5972
|
-
* @returns Configured fetch JSON input
|
|
6015
|
+
* @param method - HTTP method for the request.
|
|
6016
|
+
* @param body - Optional JSON body to include in the request.
|
|
6017
|
+
* @returns Configured fetch JSON input.
|
|
5973
6018
|
*/ function zohoSignApiFetchJsonInput(method, body) {
|
|
5974
6019
|
return {
|
|
5975
6020
|
method: method,
|
|
@@ -5982,16 +6027,16 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
5982
6027
|
* Fetches the full details of a single Zoho Sign request (envelope) by its ID,
|
|
5983
6028
|
* including actions, documents, and field data.
|
|
5984
6029
|
*
|
|
5985
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
5986
|
-
* @returns Function that retrieves a document by request ID
|
|
6030
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6031
|
+
* @returns Function that retrieves a document by request ID.
|
|
6032
|
+
*
|
|
6033
|
+
* @see https://www.zoho.com/sign/api/document-managment/get-details-of-a-particular-document.html
|
|
5987
6034
|
*
|
|
5988
6035
|
* @example
|
|
5989
6036
|
* ```typescript
|
|
5990
6037
|
* const getDocument = zohoSignGetDocument(context);
|
|
5991
6038
|
* const response = await getDocument({ requestId: '12345' });
|
|
5992
6039
|
* ```
|
|
5993
|
-
*
|
|
5994
|
-
* @see https://www.zoho.com/sign/api/document-managment/get-details-of-a-particular-document.html
|
|
5995
6040
|
*/ function zohoSignGetDocument(context) {
|
|
5996
6041
|
return function(param) {
|
|
5997
6042
|
var requestId = param.requestId;
|
|
@@ -6006,16 +6051,16 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6006
6051
|
* Pagination parameters (`start_index`, `row_count`) are serialized as a
|
|
6007
6052
|
* JSON `data` query parameter per the Zoho Sign API convention.
|
|
6008
6053
|
*
|
|
6009
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6010
|
-
* @returns Function that retrieves a paginated list of documents
|
|
6054
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6055
|
+
* @returns Function that retrieves a paginated list of documents.
|
|
6056
|
+
*
|
|
6057
|
+
* @see https://www.zoho.com/sign/api/document-managment/get-document-list.html
|
|
6011
6058
|
*
|
|
6012
6059
|
* @example
|
|
6013
6060
|
* ```typescript
|
|
6014
6061
|
* const getDocuments = zohoSignGetDocuments(context);
|
|
6015
6062
|
* const response = await getDocuments({ start_index: 1, row_count: 10 });
|
|
6016
6063
|
* ```
|
|
6017
|
-
*
|
|
6018
|
-
* @see https://www.zoho.com/sign/api/document-managment/get-document-list.html
|
|
6019
6064
|
*/ function zohoSignGetDocuments(context) {
|
|
6020
6065
|
return function(input) {
|
|
6021
6066
|
var search_columns = input.search_columns, pageFilter = _object_without_properties$8(input, [
|
|
@@ -6041,8 +6086,8 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6041
6086
|
* `start_index`/`row_count` pagination, making it easy to iterate
|
|
6042
6087
|
* through all documents across multiple pages.
|
|
6043
6088
|
*
|
|
6044
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6045
|
-
* @returns Page factory for iterating through documents
|
|
6089
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6090
|
+
* @returns Page factory for iterating through documents.
|
|
6046
6091
|
*
|
|
6047
6092
|
* @example
|
|
6048
6093
|
* ```typescript
|
|
@@ -6052,6 +6097,7 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6052
6097
|
* const firstPage = await fetchPage.fetchNext();
|
|
6053
6098
|
* const secondPage = await firstPage.fetchNext();
|
|
6054
6099
|
* ```
|
|
6100
|
+
*
|
|
6055
6101
|
* @__NO_SIDE_EFFECTS__
|
|
6056
6102
|
*/ function zohoSignGetDocumentsPageFactory(context) {
|
|
6057
6103
|
var getDocuments = zohoSignGetDocuments(context);
|
|
@@ -6064,16 +6110,16 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6064
6110
|
* returns data after all recipients have signed. The response includes
|
|
6065
6111
|
* field labels and values grouped by recipient action.
|
|
6066
6112
|
*
|
|
6067
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6068
|
-
* @returns Function that retrieves form data for a completed document
|
|
6113
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6114
|
+
* @returns Function that retrieves form data for a completed document.
|
|
6115
|
+
*
|
|
6116
|
+
* @see https://www.zoho.com/sign/api/document-managment/get-document-form-data.html
|
|
6069
6117
|
*
|
|
6070
6118
|
* @example
|
|
6071
6119
|
* ```typescript
|
|
6072
6120
|
* const getFormData = zohoSignGetDocumentFormData(context);
|
|
6073
6121
|
* const response = await getFormData({ requestId: '12345' });
|
|
6074
6122
|
* ```
|
|
6075
|
-
*
|
|
6076
|
-
* @see https://www.zoho.com/sign/api/document-managment/get-document-form-data.html
|
|
6077
6123
|
*/ function zohoSignGetDocumentFormData(context) {
|
|
6078
6124
|
return function(param) {
|
|
6079
6125
|
var requestId = param.requestId;
|
|
@@ -6087,16 +6133,16 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6087
6133
|
* that can be placed on documents. Useful for dynamically building document
|
|
6088
6134
|
* templates or validating field configurations.
|
|
6089
6135
|
*
|
|
6090
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6091
|
-
* @returns Function that retrieves all available field types
|
|
6136
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6137
|
+
* @returns Function that retrieves all available field types.
|
|
6138
|
+
*
|
|
6139
|
+
* @see https://www.zoho.com/sign/api/document-managment/retrieve-field-type.html
|
|
6092
6140
|
*
|
|
6093
6141
|
* @example
|
|
6094
6142
|
* ```typescript
|
|
6095
6143
|
* const retrieveFieldTypes = zohoSignRetrieveFieldTypes(context);
|
|
6096
6144
|
* const response = await retrieveFieldTypes();
|
|
6097
6145
|
* ```
|
|
6098
|
-
*
|
|
6099
|
-
* @see https://www.zoho.com/sign/api/document-managment/retrieve-field-type.html
|
|
6100
6146
|
*/ function zohoSignRetrieveFieldTypes(context) {
|
|
6101
6147
|
return function() {
|
|
6102
6148
|
return context.fetchJson("/fieldtypes", zohoSignApiFetchJsonInput('GET'));
|
|
@@ -6111,8 +6157,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6111
6157
|
* completion certificate, merge all documents, or provide a password for
|
|
6112
6158
|
* protected files.
|
|
6113
6159
|
*
|
|
6114
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6115
|
-
* @returns Function that downloads signed PDFs by request ID
|
|
6160
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6161
|
+
* @returns Function that downloads signed PDFs by request ID.
|
|
6162
|
+
*
|
|
6163
|
+
* @see https://www.zoho.com/sign/api/document-managment/download-pdf.html
|
|
6116
6164
|
*
|
|
6117
6165
|
* @example
|
|
6118
6166
|
* ```typescript
|
|
@@ -6127,8 +6175,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6127
6175
|
*
|
|
6128
6176
|
* const blob = await response.blob();
|
|
6129
6177
|
* ```
|
|
6130
|
-
*
|
|
6131
|
-
* @see https://www.zoho.com/sign/api/document-managment/download-pdf.html
|
|
6132
6178
|
*/ function zohoSignDownloadPdf(context) {
|
|
6133
6179
|
return function(_0) {
|
|
6134
6180
|
var requestId = _0.requestId, params = _object_without_properties$8(_0, [
|
|
@@ -6150,8 +6196,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6150
6196
|
* certificate contains an audit trail of the signing process including
|
|
6151
6197
|
* timestamps and recipient details. Returns a raw {@link Response}.
|
|
6152
6198
|
*
|
|
6153
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6154
|
-
* @returns Function that downloads the completion certificate by request ID
|
|
6199
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6200
|
+
* @returns Function that downloads the completion certificate by request ID.
|
|
6201
|
+
*
|
|
6202
|
+
* @see https://www.zoho.com/sign/api/document-managment/download-completion-certificate.html
|
|
6155
6203
|
*
|
|
6156
6204
|
* @example
|
|
6157
6205
|
* ```typescript
|
|
@@ -6159,8 +6207,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6159
6207
|
* const response = await downloadCert({ requestId: '12345' });
|
|
6160
6208
|
* const blob = await response.blob();
|
|
6161
6209
|
* ```
|
|
6162
|
-
*
|
|
6163
|
-
* @see https://www.zoho.com/sign/api/document-managment/download-completion-certificate.html
|
|
6164
6210
|
*/ function zohoSignDownloadCompletionCertificate(context) {
|
|
6165
6211
|
return function(param) {
|
|
6166
6212
|
var requestId = param.requestId;
|
|
@@ -6180,8 +6226,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6180
6226
|
* The created document starts in draft status and must be submitted
|
|
6181
6227
|
* separately via {@link zohoSignSendDocumentForSignature}.
|
|
6182
6228
|
*
|
|
6183
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6184
|
-
* @returns Function that creates a new document draft
|
|
6229
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6230
|
+
* @returns Function that creates a new document draft.
|
|
6231
|
+
*
|
|
6232
|
+
* @see https://www.zoho.com/sign/api/document-managment/create-document.html
|
|
6185
6233
|
*
|
|
6186
6234
|
* @example
|
|
6187
6235
|
* ```typescript
|
|
@@ -6204,8 +6252,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6204
6252
|
*
|
|
6205
6253
|
* const draftId = response.requests.request_id;
|
|
6206
6254
|
* ```
|
|
6207
|
-
*
|
|
6208
|
-
* @see https://www.zoho.com/sign/api/document-managment/create-document.html
|
|
6209
6255
|
*/ function zohoSignCreateDocument(context) {
|
|
6210
6256
|
return function(param) {
|
|
6211
6257
|
var requestData = param.requestData, file = param.file;
|
|
@@ -6234,8 +6280,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6234
6280
|
* expiration settings. Cannot be used on documents that have already been
|
|
6235
6281
|
* submitted for signature.
|
|
6236
6282
|
*
|
|
6237
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6238
|
-
* @returns Function that updates a draft document by request ID
|
|
6283
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6284
|
+
* @returns Function that updates a draft document by request ID.
|
|
6285
|
+
*
|
|
6286
|
+
* @see https://www.zoho.com/sign/api/document-managment/update-document.html
|
|
6239
6287
|
*
|
|
6240
6288
|
* @example
|
|
6241
6289
|
* ```typescript
|
|
@@ -6246,8 +6294,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6246
6294
|
* data: { notes: 'Updated notes for this document' }
|
|
6247
6295
|
* });
|
|
6248
6296
|
* ```
|
|
6249
|
-
*
|
|
6250
|
-
* @see https://www.zoho.com/sign/api/document-managment/update-document.html
|
|
6251
6297
|
*/ function zohoSignUpdateDocument(context) {
|
|
6252
6298
|
return function(param) {
|
|
6253
6299
|
var requestId = param.requestId, data = param.data;
|
|
@@ -6264,8 +6310,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6264
6310
|
* submission. Once submitted, the document transitions from draft to
|
|
6265
6311
|
* "inprogress" status and recipients receive signing notifications.
|
|
6266
6312
|
*
|
|
6267
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6268
|
-
* @returns Function that sends a document for signature by request ID
|
|
6313
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6314
|
+
* @returns Function that sends a document for signature by request ID.
|
|
6315
|
+
*
|
|
6316
|
+
* @see https://www.zoho.com/sign/api/document-managment/send-document-for-signature.html
|
|
6269
6317
|
*
|
|
6270
6318
|
* @example
|
|
6271
6319
|
* ```typescript
|
|
@@ -6280,8 +6328,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6280
6328
|
* data: { expiration_days: 30 }
|
|
6281
6329
|
* });
|
|
6282
6330
|
* ```
|
|
6283
|
-
*
|
|
6284
|
-
* @see https://www.zoho.com/sign/api/document-managment/send-document-for-signature.html
|
|
6285
6331
|
*/ function zohoSignSendDocumentForSignature(context) {
|
|
6286
6332
|
return function(param) {
|
|
6287
6333
|
var requestId = param.requestId, data = param.data;
|
|
@@ -6298,16 +6344,16 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6298
6344
|
* provided as a human-readable string (e.g. "30 November 2024"). Useful for
|
|
6299
6345
|
* giving recipients additional time to complete signing.
|
|
6300
6346
|
*
|
|
6301
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6302
|
-
* @returns Function that extends a document's expiration by request ID
|
|
6347
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6348
|
+
* @returns Function that extends a document's expiration by request ID.
|
|
6349
|
+
*
|
|
6350
|
+
* @see https://www.zoho.com/sign/api/document-managment/extend-document.html
|
|
6303
6351
|
*
|
|
6304
6352
|
* @example
|
|
6305
6353
|
* ```typescript
|
|
6306
6354
|
* const extendDocument = zohoSignExtendDocument(context);
|
|
6307
6355
|
* await extendDocument({ requestId: '12345', expire_by: '30 November 2024' });
|
|
6308
6356
|
* ```
|
|
6309
|
-
*
|
|
6310
|
-
* @see https://www.zoho.com/sign/api/document-managment/extend-document.html
|
|
6311
6357
|
*/ function zohoSignExtendDocument(context) {
|
|
6312
6358
|
return function(param) {
|
|
6313
6359
|
var requestId = param.requestId, expire_by = param.expire_by;
|
|
@@ -6324,8 +6370,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6324
6370
|
* from recipients before deletion. An optional `reason` can be provided
|
|
6325
6371
|
* to explain the recall. Sends the parameters as URL-encoded form data.
|
|
6326
6372
|
*
|
|
6327
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6328
|
-
* @returns Function that deletes a document by request ID
|
|
6373
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6374
|
+
* @returns Function that deletes a document by request ID.
|
|
6375
|
+
*
|
|
6376
|
+
* @see https://www.zoho.com/sign/api/document-managment/delete-document.html
|
|
6329
6377
|
*
|
|
6330
6378
|
* @example
|
|
6331
6379
|
* ```typescript
|
|
@@ -6341,8 +6389,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6341
6389
|
* reason: 'Contract terms changed'
|
|
6342
6390
|
* });
|
|
6343
6391
|
* ```
|
|
6344
|
-
*
|
|
6345
|
-
* @see https://www.zoho.com/sign/api/document-managment/delete-document.html
|
|
6346
6392
|
*/ function zohoSignDeleteDocument(context) {
|
|
6347
6393
|
return function(param) {
|
|
6348
6394
|
var requestId = param.requestId, recall_inprogress = param.recall_inprogress, reason = param.reason;
|
|
@@ -6370,17 +6416,22 @@ var ZOHO_SIGN_SERVICE_NAME = 'sign';
|
|
|
6370
6416
|
/**
|
|
6371
6417
|
* Resolves an environment key or passthrough URL to the full Zoho Sign API URL.
|
|
6372
6418
|
*
|
|
6373
|
-
* @param input - An environment key ('sandbox' or 'production') or a full API URL
|
|
6374
|
-
* @returns The resolved Zoho Sign API URL
|
|
6419
|
+
* @param input - An environment key ('sandbox' or 'production') or a full API URL.
|
|
6420
|
+
* @returns The resolved Zoho Sign API URL.
|
|
6375
6421
|
*/ function zohoSignConfigApiUrl(input) {
|
|
6422
|
+
var result;
|
|
6376
6423
|
switch(input){
|
|
6377
6424
|
case 'sandbox':
|
|
6378
|
-
|
|
6425
|
+
result = 'https://signsandbox.zoho.com/api/v1';
|
|
6426
|
+
break;
|
|
6379
6427
|
case 'production':
|
|
6380
|
-
|
|
6428
|
+
result = 'https://sign.zoho.com/api/v1';
|
|
6429
|
+
break;
|
|
6381
6430
|
default:
|
|
6382
|
-
|
|
6431
|
+
result = input;
|
|
6432
|
+
break;
|
|
6383
6433
|
}
|
|
6434
|
+
return result;
|
|
6384
6435
|
}
|
|
6385
6436
|
|
|
6386
6437
|
function asyncGeneratorStep$4(gen, resolve, reject, _next, _throw, key, arg) {
|
|
@@ -6517,8 +6568,8 @@ var logZohoSignErrorToConsole = logZohoServerErrorFunction('ZohoSign', {
|
|
|
6517
6568
|
/**
|
|
6518
6569
|
* Parses the JSON body of a failed Zoho Sign fetch response into a structured error, returning undefined if the body cannot be parsed.
|
|
6519
6570
|
*
|
|
6520
|
-
* @param responseError - The fetch response error to parse
|
|
6521
|
-
* @returns Parsed Zoho server error, or undefined if parsing fails
|
|
6571
|
+
* @param responseError - The fetch response error to parse.
|
|
6572
|
+
* @returns Parsed Zoho server error, or undefined if parsing fails.
|
|
6522
6573
|
*/ function parseZohoSignError(responseError) {
|
|
6523
6574
|
return _async_to_generator$4(function() {
|
|
6524
6575
|
var data, result;
|
|
@@ -6547,9 +6598,9 @@ var logZohoSignErrorToConsole = logZohoServerErrorFunction('ZohoSign', {
|
|
|
6547
6598
|
/**
|
|
6548
6599
|
* Converts raw Zoho Sign error response data into a parsed error, delegating to Sign-specific handlers for known error codes and falling back to the shared Zoho parser.
|
|
6549
6600
|
*
|
|
6550
|
-
* @param errorResponseData - Raw error response data from the Zoho Sign API
|
|
6551
|
-
* @param responseError - The underlying fetch response error
|
|
6552
|
-
* @returns Parsed Zoho server error, or undefined if the data contains no recognizable error
|
|
6601
|
+
* @param errorResponseData - Raw error response data from the Zoho Sign API.
|
|
6602
|
+
* @param responseError - The underlying fetch response error.
|
|
6603
|
+
* @returns Parsed Zoho server error, or undefined if the data contains no recognizable error.
|
|
6553
6604
|
*/ function parseZohoSignServerErrorResponseData(errorResponseData, responseError) {
|
|
6554
6605
|
var result;
|
|
6555
6606
|
var error = tryFindZohoServerErrorData(errorResponseData, responseError);
|
|
@@ -6758,8 +6809,8 @@ function _ts_generator$3(thisArg, body) {
|
|
|
6758
6809
|
* Each client handles OAuth token refresh on {@link ZohoInvalidTokenError}, rate limiting,
|
|
6759
6810
|
* and Zoho Sign's non-standard error responses (200 status with error body).
|
|
6760
6811
|
*
|
|
6761
|
-
* @param factoryConfig - Configuration providing account credentials and optional overrides
|
|
6762
|
-
* @returns A factory function that creates authenticated Zoho Sign clients
|
|
6812
|
+
* @param factoryConfig - Configuration providing account credentials and optional overrides.
|
|
6813
|
+
* @returns A factory function that creates authenticated Zoho Sign clients.
|
|
6763
6814
|
*
|
|
6764
6815
|
* @example
|
|
6765
6816
|
* ```typescript
|
|
@@ -6774,6 +6825,7 @@ function _ts_generator$3(thisArg, body) {
|
|
|
6774
6825
|
* // Use the sign context for API calls:
|
|
6775
6826
|
* const { signContext } = zohoSign;
|
|
6776
6827
|
* ```
|
|
6828
|
+
*
|
|
6777
6829
|
* @__NO_SIDE_EFFECTS__
|
|
6778
6830
|
*/ function zohoSignFactory(factoryConfig) {
|
|
6779
6831
|
var accountsContext = factoryConfig.accountsContext;
|
|
@@ -6854,8 +6906,8 @@ function _ts_generator$3(thisArg, body) {
|
|
|
6854
6906
|
* Resolves a Desk API URL input to its full base URL. The 'production' key maps to the
|
|
6855
6907
|
* primary Zoho Desk endpoint; custom URLs pass through unchanged.
|
|
6856
6908
|
*
|
|
6857
|
-
* @param input - A well-known environment key or a custom Desk API URL
|
|
6858
|
-
* @returns The resolved full Zoho Desk API base URL
|
|
6909
|
+
* @param input - A well-known environment key or a custom Desk API URL.
|
|
6910
|
+
* @returns The resolved full Zoho Desk API base URL.
|
|
6859
6911
|
*/ function zohoDeskConfigApiUrl(input) {
|
|
6860
6912
|
var result;
|
|
6861
6913
|
switch(input){
|
|
@@ -7007,8 +7059,8 @@ function _ts_generator$2(thisArg, body) {
|
|
|
7007
7059
|
/**
|
|
7008
7060
|
* Parses a fetch response error into a typed Zoho Desk server error by extracting and interpreting the JSON error body.
|
|
7009
7061
|
*
|
|
7010
|
-
* @param responseError - The fetch response error to parse
|
|
7011
|
-
* @returns The parsed Zoho server error, or undefined if the response could not be parsed
|
|
7062
|
+
* @param responseError - The fetch response error to parse.
|
|
7063
|
+
* @returns The parsed Zoho server error, or undefined if the response could not be parsed.
|
|
7012
7064
|
*/ function parseZohoDeskError(responseError) {
|
|
7013
7065
|
return _async_to_generator$2(function() {
|
|
7014
7066
|
var data, result;
|
|
@@ -7038,9 +7090,9 @@ function _ts_generator$2(thisArg, body) {
|
|
|
7038
7090
|
* Parses a Zoho Desk error response body into a typed error. Delegates to Desk-specific
|
|
7039
7091
|
* error code handling before falling back to the generic Zoho error parser.
|
|
7040
7092
|
*
|
|
7041
|
-
* @param errorResponseData - The raw error response data from the Zoho Desk API
|
|
7042
|
-
* @param responseError - The original fetch response error for context
|
|
7043
|
-
* @returns The parsed Zoho server error, or undefined if the error could not be classified
|
|
7093
|
+
* @param errorResponseData - The raw error response data from the Zoho Desk API.
|
|
7094
|
+
* @param responseError - The original fetch response error for context.
|
|
7095
|
+
* @returns The parsed Zoho server error, or undefined if the error could not be classified.
|
|
7044
7096
|
*/ function parseZohoDeskServerErrorResponseData(errorResponseData, responseError) {
|
|
7045
7097
|
var result;
|
|
7046
7098
|
var error = tryFindZohoServerErrorData(errorResponseData, responseError);
|
|
@@ -7130,8 +7182,8 @@ function _object_spread_props$a(target, source) {
|
|
|
7130
7182
|
* Desk uses a credit-based system with `X-Rate-Limit-Remaining-v3` and `Retry-After` (in seconds)
|
|
7131
7183
|
* rather than the `X-RATELIMIT-*` headers used by CRM/Recruit/Sign.
|
|
7132
7184
|
*
|
|
7133
|
-
* @param headers - HTTP response headers from a Zoho Desk API call
|
|
7134
|
-
* @returns Parsed rate limit details, or null if the Desk rate limit headers are absent
|
|
7185
|
+
* @param headers - HTTP response headers from a Zoho Desk API call.
|
|
7186
|
+
* @returns Parsed rate limit details, or null if the Desk rate limit headers are absent.
|
|
7135
7187
|
*/ function zohoDeskRateLimitDetailsReader(headers) {
|
|
7136
7188
|
var remainingHeader = headers.get(ZOHO_DESK_RATE_LIMIT_REMAINING_HEADER);
|
|
7137
7189
|
var result;
|
|
@@ -7161,7 +7213,7 @@ function _object_spread_props$a(target, source) {
|
|
|
7161
7213
|
* with the Desk-specific header reader. Unlike CRM, Desk does not provide a total limit header,
|
|
7162
7214
|
* so the configured `maxRateLimit` (defaulting to {@link DEFAULT_ZOHO_DESK_API_RATE_LIMIT}) is used throughout.
|
|
7163
7215
|
*
|
|
7164
|
-
* @param config - Optional configuration for rate limit, reset period, and 429 handling
|
|
7216
|
+
* @param config - Optional configuration for rate limit, reset period, and 429 handling.
|
|
7165
7217
|
* @returns A rate-limited fetch handler with the underlying rate limiter accessible via `_rateLimiter`
|
|
7166
7218
|
*/ function zohoDeskRateLimitedFetchHandler(config) {
|
|
7167
7219
|
return makeZohoRateLimitedFetchHandler(_object_spread_props$a(_object_spread$a({
|
|
@@ -7365,8 +7417,9 @@ function _ts_generator$1(thisArg, body) {
|
|
|
7365
7417
|
* Unlike CRM/Recruit/Sign, the Desk API requires an `orgId` header on every request.
|
|
7366
7418
|
* This is injected automatically from the config.
|
|
7367
7419
|
*
|
|
7368
|
-
* @param factoryConfig - Configuration providing account credentials and optional overrides
|
|
7369
|
-
* @returns A factory function that creates authenticated Zoho Desk clients
|
|
7420
|
+
* @param factoryConfig - Configuration providing account credentials and optional overrides.
|
|
7421
|
+
* @returns A factory function that creates authenticated Zoho Desk clients.
|
|
7422
|
+
*
|
|
7370
7423
|
* @__NO_SIDE_EFFECTS__
|
|
7371
7424
|
*/ function zohoDeskFactory(factoryConfig) {
|
|
7372
7425
|
var accountsContext = factoryConfig.accountsContext;
|
|
@@ -7497,7 +7550,7 @@ function _object_spread_props$8(target, source) {
|
|
|
7497
7550
|
*/ var ZOHO_DESK_MAX_PAGE_LIMIT = 50;
|
|
7498
7551
|
/**
|
|
7499
7552
|
* Default number of records per page for Zoho Desk list endpoints.
|
|
7500
|
-
*/ var
|
|
7553
|
+
*/ var DEFAULT_ZOHO_DESK_PAGE_LIMIT = 25;
|
|
7501
7554
|
/**
|
|
7502
7555
|
* Creates a page factory that wraps a Zoho Desk fetch function with automatic offset-based pagination.
|
|
7503
7556
|
*
|
|
@@ -7505,9 +7558,9 @@ function _object_spread_props$8(target, source) {
|
|
|
7505
7558
|
* against the requested `limit`. If `data.length >= limit`, more records are assumed to exist.
|
|
7506
7559
|
* The `from` offset is automatically advanced by `limit` for subsequent requests.
|
|
7507
7560
|
*
|
|
7508
|
-
* @param fetch - The Zoho Desk fetch function to paginate over
|
|
7509
|
-
* @param defaults - Optional default configuration for the page factory
|
|
7510
|
-
* @returns A page factory that produces iterable page fetchers
|
|
7561
|
+
* @param fetch - The Zoho Desk fetch function to paginate over.
|
|
7562
|
+
* @param defaults - Optional default configuration for the page factory.
|
|
7563
|
+
* @returns A page factory that produces iterable page fetchers.
|
|
7511
7564
|
*
|
|
7512
7565
|
* @example
|
|
7513
7566
|
* ```typescript
|
|
@@ -7520,6 +7573,7 @@ function _object_spread_props$8(target, source) {
|
|
|
7520
7573
|
* const secondPage = await firstPage.fetchNext();
|
|
7521
7574
|
* }
|
|
7522
7575
|
* ```
|
|
7576
|
+
*
|
|
7523
7577
|
* @__NO_SIDE_EFFECTS__
|
|
7524
7578
|
*/ function zohoDeskFetchPageFactory(fetch$1, defaults) {
|
|
7525
7579
|
return fetch.fetchPageFactory(_object_spread_props$8(_object_spread$8({}, defaults), {
|
|
@@ -7529,12 +7583,12 @@ function _object_spread_props$8(target, source) {
|
|
|
7529
7583
|
var _result_data;
|
|
7530
7584
|
var dataLength = (_ref = (_result_data = result.data) === null || _result_data === void 0 ? void 0 : _result_data.length) !== null && _ref !== void 0 ? _ref : 0;
|
|
7531
7585
|
return {
|
|
7532
|
-
hasNext: dataLength > 0 && dataLength >=
|
|
7586
|
+
hasNext: dataLength > 0 && dataLength >= DEFAULT_ZOHO_DESK_PAGE_LIMIT
|
|
7533
7587
|
};
|
|
7534
7588
|
},
|
|
7535
7589
|
buildInputForNextPage: function buildInputForNextPage(pageResult, input, options) {
|
|
7536
7590
|
var _ref, _options_maxItemsPerPage, _input_from;
|
|
7537
|
-
var limit = (_ref = (_options_maxItemsPerPage = options.maxItemsPerPage) !== null && _options_maxItemsPerPage !== void 0 ? _options_maxItemsPerPage : input.limit) !== null && _ref !== void 0 ? _ref :
|
|
7591
|
+
var limit = (_ref = (_options_maxItemsPerPage = options.maxItemsPerPage) !== null && _options_maxItemsPerPage !== void 0 ? _options_maxItemsPerPage : input.limit) !== null && _ref !== void 0 ? _ref : DEFAULT_ZOHO_DESK_PAGE_LIMIT;
|
|
7538
7592
|
var previousFrom = (_input_from = input.from) !== null && _input_from !== void 0 ? _input_from : 1;
|
|
7539
7593
|
var nextFrom = previousFrom + limit;
|
|
7540
7594
|
return _object_spread_props$8(_object_spread$8({}, input), {
|
|
@@ -7632,9 +7686,9 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7632
7686
|
/**
|
|
7633
7687
|
* Constructs the standard FetchJsonInput used by Desk API calls, pairing the HTTP method with an optional body.
|
|
7634
7688
|
*
|
|
7635
|
-
* @param method - HTTP method to use for the request
|
|
7636
|
-
* @param body - Optional request body to include
|
|
7637
|
-
* @returns Configured fetch input for the Zoho Desk API call
|
|
7689
|
+
* @param method - HTTP method to use for the request.
|
|
7690
|
+
* @param body - Optional request body to include.
|
|
7691
|
+
* @returns Configured fetch input for the Zoho Desk API call.
|
|
7638
7692
|
*/ function zohoDeskApiFetchJsonInput(method, body) {
|
|
7639
7693
|
return {
|
|
7640
7694
|
method: method,
|
|
@@ -7644,9 +7698,9 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7644
7698
|
/**
|
|
7645
7699
|
* Builds URL search params from the input objects, omitting keys that are used in the URL path.
|
|
7646
7700
|
*
|
|
7647
|
-
* @param input - One or more objects to convert into URL search parameters
|
|
7648
|
-
* @param omitKeys - Keys to exclude from the search params
|
|
7649
|
-
* @returns URL search params string
|
|
7701
|
+
* @param input - One or more objects to convert into URL search parameters.
|
|
7702
|
+
* @param omitKeys - Keys to exclude from the search params.
|
|
7703
|
+
* @returns URL search params string.
|
|
7650
7704
|
*/ function zohoDeskUrlSearchParams(input, omitKeys) {
|
|
7651
7705
|
return fetch.makeUrlSearchParams(input, {
|
|
7652
7706
|
omitKeys: omitKeys
|
|
@@ -7655,8 +7709,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7655
7709
|
/**
|
|
7656
7710
|
* Joins include values into a comma-separated string.
|
|
7657
7711
|
*
|
|
7658
|
-
* @param include - Single or array of include values
|
|
7659
|
-
* @returns Comma-separated string, or undefined if no values provided
|
|
7712
|
+
* @param include - Single or array of include values.
|
|
7713
|
+
* @returns Comma-separated string, or undefined if no values provided.
|
|
7660
7714
|
*/ function joinInclude(include) {
|
|
7661
7715
|
var result;
|
|
7662
7716
|
if (include) {
|
|
@@ -7670,8 +7724,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7670
7724
|
* Retrieves a paginated list of tickets from Zoho Desk, with optional filtering by
|
|
7671
7725
|
* department, status, priority, channel, assignee, and view.
|
|
7672
7726
|
*
|
|
7673
|
-
* @param context - Authenticated Zoho Desk context
|
|
7674
|
-
* @returns Function that retrieves paginated tickets
|
|
7727
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7728
|
+
* @returns Function that retrieves paginated tickets.
|
|
7675
7729
|
*/ function zohoDeskGetTickets(context) {
|
|
7676
7730
|
return function(input) {
|
|
7677
7731
|
var include = input.include, rest = _object_without_properties$7(input, [
|
|
@@ -7694,8 +7748,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7694
7748
|
*
|
|
7695
7749
|
* Retrieves a single ticket by its ID, with optional inline expansion of related entities.
|
|
7696
7750
|
*
|
|
7697
|
-
* @param context - Authenticated Zoho Desk context
|
|
7698
|
-
* @returns Function that retrieves a single ticket
|
|
7751
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7752
|
+
* @returns Function that retrieves a single ticket.
|
|
7699
7753
|
*/ function zohoDeskGetTicketById(context) {
|
|
7700
7754
|
return function(input) {
|
|
7701
7755
|
var ticketId = input.ticketId, include = input.include;
|
|
@@ -7715,8 +7769,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7715
7769
|
* Searches for tickets matching the given filter criteria. Supports filtering by
|
|
7716
7770
|
* many fields including subject, email, status, priority, date ranges, and custom fields.
|
|
7717
7771
|
*
|
|
7718
|
-
* @param context - Authenticated Zoho Desk context
|
|
7719
|
-
* @returns Function that searches for tickets
|
|
7772
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7773
|
+
* @returns Function that searches for tickets.
|
|
7720
7774
|
*/ function zohoDeskSearchTickets(context) {
|
|
7721
7775
|
return function(input) {
|
|
7722
7776
|
var params = zohoDeskUrlSearchParams([
|
|
@@ -7732,8 +7786,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7732
7786
|
/**
|
|
7733
7787
|
* Creates a {@link ZohoDeskGetTicketsForContactFunction} bound to the given context.
|
|
7734
7788
|
*
|
|
7735
|
-
* @param context - Authenticated Zoho Desk context
|
|
7736
|
-
* @returns Function that retrieves tickets for a contact
|
|
7789
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7790
|
+
* @returns Function that retrieves tickets for a contact.
|
|
7737
7791
|
*/ function zohoDeskGetTicketsForContact(context) {
|
|
7738
7792
|
return function(input) {
|
|
7739
7793
|
var contactId = input.contactId, include = input.include, rest = _object_without_properties$7(input, [
|
|
@@ -7755,8 +7809,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7755
7809
|
/**
|
|
7756
7810
|
* Creates a {@link ZohoDeskGetTicketsForProductFunction} bound to the given context.
|
|
7757
7811
|
*
|
|
7758
|
-
* @param context - Authenticated Zoho Desk context
|
|
7759
|
-
* @returns Function that retrieves tickets for a product
|
|
7812
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7813
|
+
* @returns Function that retrieves tickets for a product.
|
|
7760
7814
|
*/ function zohoDeskGetTicketsForProduct(context) {
|
|
7761
7815
|
return function(input) {
|
|
7762
7816
|
var productId = input.productId, include = input.include, rest = _object_without_properties$7(input, [
|
|
@@ -7778,8 +7832,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7778
7832
|
/**
|
|
7779
7833
|
* Creates a {@link ZohoDeskGetTicketMetricsFunction} bound to the given context.
|
|
7780
7834
|
*
|
|
7781
|
-
* @param context - Authenticated Zoho Desk context
|
|
7782
|
-
* @returns Function that retrieves ticket metrics
|
|
7835
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7836
|
+
* @returns Function that retrieves ticket metrics.
|
|
7783
7837
|
*/ function zohoDeskGetTicketMetrics(context) {
|
|
7784
7838
|
return function(input) {
|
|
7785
7839
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/metrics"), zohoDeskApiFetchJsonInput('GET'));
|
|
@@ -7788,8 +7842,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7788
7842
|
/**
|
|
7789
7843
|
* Creates a {@link ZohoDeskGetAgentsTicketsCountFunction} bound to the given context.
|
|
7790
7844
|
*
|
|
7791
|
-
* @param context - Authenticated Zoho Desk context
|
|
7792
|
-
* @returns Function that retrieves agent ticket counts
|
|
7845
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7846
|
+
* @returns Function that retrieves agent ticket counts.
|
|
7793
7847
|
*/ function zohoDeskGetAgentsTicketsCount(context) {
|
|
7794
7848
|
return function(input) {
|
|
7795
7849
|
var params = zohoDeskUrlSearchParams([
|
|
@@ -7807,8 +7861,9 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7807
7861
|
* Returns a page factory that automatically handles Zoho Desk's offset-based pagination,
|
|
7808
7862
|
* making it easy to iterate through all tickets across multiple pages.
|
|
7809
7863
|
*
|
|
7810
|
-
* @param context - Authenticated Zoho Desk context
|
|
7811
|
-
* @returns Page factory for iterating over ticket results
|
|
7864
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7865
|
+
* @returns Page factory for iterating over ticket results.
|
|
7866
|
+
*
|
|
7812
7867
|
* @__NO_SIDE_EFFECTS__
|
|
7813
7868
|
*/ function zohoDeskGetTicketsPageFactory(context) {
|
|
7814
7869
|
return zohoDeskFetchPageFactory(zohoDeskGetTickets(context));
|
|
@@ -7816,8 +7871,9 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7816
7871
|
/**
|
|
7817
7872
|
* Creates a {@link ZohoDeskSearchTicketsPageFactory} bound to the given context.
|
|
7818
7873
|
*
|
|
7819
|
-
* @param context - Authenticated Zoho Desk context
|
|
7820
|
-
* @returns Page factory for iterating over search results
|
|
7874
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7875
|
+
* @returns Page factory for iterating over search results.
|
|
7876
|
+
*
|
|
7821
7877
|
* @__NO_SIDE_EFFECTS__
|
|
7822
7878
|
*/ function zohoDeskSearchTicketsPageFactory(context) {
|
|
7823
7879
|
return zohoDeskFetchPageFactory(zohoDeskSearchTickets(context));
|
|
@@ -7835,8 +7891,8 @@ function zohoDeskDepartmentApiFetchJsonInput(method) {
|
|
|
7835
7891
|
* Retrieves a paginated list of departments from Zoho Desk, with optional filtering
|
|
7836
7892
|
* by chat status, search string, and enabled state.
|
|
7837
7893
|
*
|
|
7838
|
-
* @param context - Authenticated Zoho Desk context
|
|
7839
|
-
* @returns Function that retrieves paginated departments
|
|
7894
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7895
|
+
* @returns Function that retrieves paginated departments.
|
|
7840
7896
|
*/ function zohoDeskGetDepartments(context) {
|
|
7841
7897
|
return function(input) {
|
|
7842
7898
|
var params = fetch.makeUrlSearchParams([
|
|
@@ -7852,8 +7908,8 @@ function zohoDeskDepartmentApiFetchJsonInput(method) {
|
|
|
7852
7908
|
/**
|
|
7853
7909
|
* Creates a {@link ZohoDeskGetDepartmentByIdFunction} bound to the given context.
|
|
7854
7910
|
*
|
|
7855
|
-
* @param context - Authenticated Zoho Desk context
|
|
7856
|
-
* @returns Function that retrieves a single department
|
|
7911
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7912
|
+
* @returns Function that retrieves a single department.
|
|
7857
7913
|
*/ function zohoDeskGetDepartmentById(context) {
|
|
7858
7914
|
return function(input) {
|
|
7859
7915
|
return context.fetchJson("/departments/".concat(input.departmentId), zohoDeskDepartmentApiFetchJsonInput('GET'));
|
|
@@ -7952,8 +8008,8 @@ function zohoDeskContactApiFetchJsonInput(method) {
|
|
|
7952
8008
|
/**
|
|
7953
8009
|
* Joins include values into a comma-separated string.
|
|
7954
8010
|
*
|
|
7955
|
-
* @param include - Single or array of include values
|
|
7956
|
-
* @returns Comma-separated string, or undefined if no values provided
|
|
8011
|
+
* @param include - Single or array of include values.
|
|
8012
|
+
* @returns Comma-separated string, or undefined if no values provided.
|
|
7957
8013
|
*/ function joinContactInclude(include) {
|
|
7958
8014
|
var result;
|
|
7959
8015
|
if (include) {
|
|
@@ -7967,8 +8023,8 @@ function zohoDeskContactApiFetchJsonInput(method) {
|
|
|
7967
8023
|
* Retrieves a paginated list of contacts from Zoho Desk, with optional sorting,
|
|
7968
8024
|
* inline expansion of related entities, and custom view filtering.
|
|
7969
8025
|
*
|
|
7970
|
-
* @param context - Authenticated Zoho Desk context
|
|
7971
|
-
* @returns Function that retrieves paginated contacts
|
|
8026
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8027
|
+
* @returns Function that retrieves paginated contacts.
|
|
7972
8028
|
*/ function zohoDeskGetContacts(context) {
|
|
7973
8029
|
return function(input) {
|
|
7974
8030
|
var include = input.include, rest = _object_without_properties$6(input, [
|
|
@@ -7989,8 +8045,8 @@ function zohoDeskContactApiFetchJsonInput(method) {
|
|
|
7989
8045
|
/**
|
|
7990
8046
|
* Creates a {@link ZohoDeskGetContactByIdFunction} bound to the given context.
|
|
7991
8047
|
*
|
|
7992
|
-
* @param context - Authenticated Zoho Desk context
|
|
7993
|
-
* @returns Function that retrieves a single contact
|
|
8048
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8049
|
+
* @returns Function that retrieves a single contact.
|
|
7994
8050
|
*/ function zohoDeskGetContactById(context) {
|
|
7995
8051
|
return function(input) {
|
|
7996
8052
|
var contactId = input.contactId, include = input.include;
|
|
@@ -8009,8 +8065,8 @@ function zohoDeskContactApiFetchJsonInput(method) {
|
|
|
8009
8065
|
*
|
|
8010
8066
|
* Retrieves multiple contacts in a single request by providing their IDs.
|
|
8011
8067
|
*
|
|
8012
|
-
* @param context - Authenticated Zoho Desk context
|
|
8013
|
-
* @returns Function that retrieves contacts by IDs
|
|
8068
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8069
|
+
* @returns Function that retrieves contacts by IDs.
|
|
8014
8070
|
*/ function zohoDeskGetContactsByIds(context) {
|
|
8015
8071
|
return function(input) {
|
|
8016
8072
|
var params = fetch.makeUrlSearchParams([
|
|
@@ -8026,8 +8082,9 @@ function zohoDeskContactApiFetchJsonInput(method) {
|
|
|
8026
8082
|
/**
|
|
8027
8083
|
* Creates a {@link ZohoDeskGetContactsPageFactory} bound to the given context.
|
|
8028
8084
|
*
|
|
8029
|
-
* @param context - Authenticated Zoho Desk context
|
|
8030
|
-
* @returns Page factory for iterating over contact results
|
|
8085
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8086
|
+
* @returns Page factory for iterating over contact results.
|
|
8087
|
+
*
|
|
8031
8088
|
* @__NO_SIDE_EFFECTS__
|
|
8032
8089
|
*/ function zohoDeskGetContactsPageFactory(context) {
|
|
8033
8090
|
return zohoDeskFetchPageFactory(zohoDeskGetContacts(context));
|
|
@@ -8043,8 +8100,8 @@ function zohoDeskTagApiFetchJsonInput(method, body) {
|
|
|
8043
8100
|
/**
|
|
8044
8101
|
* Creates a {@link ZohoDeskGetTicketTagsFunction} bound to the given context.
|
|
8045
8102
|
*
|
|
8046
|
-
* @param context - Authenticated Zoho Desk context
|
|
8047
|
-
* @returns Function that retrieves tags for a ticket
|
|
8103
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8104
|
+
* @returns Function that retrieves tags for a ticket.
|
|
8048
8105
|
*/ function zohoDeskGetTicketTags(context) {
|
|
8049
8106
|
return function(input) {
|
|
8050
8107
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/tags"), zohoDeskTagApiFetchJsonInput('GET')).then(function(x) {
|
|
@@ -8057,8 +8114,8 @@ function zohoDeskTagApiFetchJsonInput(method, body) {
|
|
|
8057
8114
|
*
|
|
8058
8115
|
* Associates one or more tags with a ticket. If the tag does not exist, it will be created.
|
|
8059
8116
|
*
|
|
8060
|
-
* @param context - Authenticated Zoho Desk context
|
|
8061
|
-
* @returns Function that associates tags with a ticket
|
|
8117
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8118
|
+
* @returns Function that associates tags with a ticket.
|
|
8062
8119
|
*/ function zohoDeskAssociateTicketTags(context) {
|
|
8063
8120
|
return function(input) {
|
|
8064
8121
|
var body = {
|
|
@@ -8076,8 +8133,8 @@ function zohoDeskTagApiFetchJsonInput(method, body) {
|
|
|
8076
8133
|
/**
|
|
8077
8134
|
* Creates a {@link ZohoDeskDissociateTicketTagFunction} bound to the given context.
|
|
8078
8135
|
*
|
|
8079
|
-
* @param context - Authenticated Zoho Desk context
|
|
8080
|
-
* @returns Function that removes a tag from a ticket
|
|
8136
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8137
|
+
* @returns Function that removes a tag from a ticket.
|
|
8081
8138
|
*/ function zohoDeskDissociateTicketTag(context) {
|
|
8082
8139
|
return function(input) {
|
|
8083
8140
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/tags/").concat(input.tagId), zohoDeskTagApiFetchJsonInput('DELETE'));
|
|
@@ -8086,8 +8143,8 @@ function zohoDeskTagApiFetchJsonInput(method, body) {
|
|
|
8086
8143
|
/**
|
|
8087
8144
|
* Creates a {@link ZohoDeskSearchTagsFunction} bound to the given context.
|
|
8088
8145
|
*
|
|
8089
|
-
* @param context - Authenticated Zoho Desk context
|
|
8090
|
-
* @returns Function that searches for tags
|
|
8146
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8147
|
+
* @returns Function that searches for tags.
|
|
8091
8148
|
*/ function zohoDeskSearchTags(context) {
|
|
8092
8149
|
return function(input) {
|
|
8093
8150
|
var params = fetch.makeUrlSearchParams([
|
|
@@ -8103,8 +8160,8 @@ function zohoDeskTagApiFetchJsonInput(method, body) {
|
|
|
8103
8160
|
/**
|
|
8104
8161
|
* Creates a {@link ZohoDeskGetAllTagsFunction} bound to the given context.
|
|
8105
8162
|
*
|
|
8106
|
-
* @param context - Authenticated Zoho Desk context
|
|
8107
|
-
* @returns Function that retrieves all tags
|
|
8163
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8164
|
+
* @returns Function that retrieves all tags.
|
|
8108
8165
|
*/ function zohoDeskGetAllTags(context) {
|
|
8109
8166
|
return function(input) {
|
|
8110
8167
|
var params = fetch.makeUrlSearchParams([
|
|
@@ -8128,8 +8185,8 @@ function zohoDeskFollowerApiFetchJsonInput(method, body) {
|
|
|
8128
8185
|
/**
|
|
8129
8186
|
* Creates a {@link ZohoDeskGetTicketFollowersFunction} bound to the given context.
|
|
8130
8187
|
*
|
|
8131
|
-
* @param context - Authenticated Zoho Desk context
|
|
8132
|
-
* @returns Function that retrieves followers for a ticket
|
|
8188
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8189
|
+
* @returns Function that retrieves followers for a ticket.
|
|
8133
8190
|
*/ function zohoDeskGetTicketFollowers(context) {
|
|
8134
8191
|
return function(input) {
|
|
8135
8192
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/followers"), zohoDeskFollowerApiFetchJsonInput('GET')).then(function(x) {
|
|
@@ -8140,8 +8197,8 @@ function zohoDeskFollowerApiFetchJsonInput(method, body) {
|
|
|
8140
8197
|
/**
|
|
8141
8198
|
* Creates a {@link ZohoDeskAddTicketFollowersFunction} bound to the given context.
|
|
8142
8199
|
*
|
|
8143
|
-
* @param context - Authenticated Zoho Desk context
|
|
8144
|
-
* @returns Function that adds followers to a ticket
|
|
8200
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8201
|
+
* @returns Function that adds followers to a ticket.
|
|
8145
8202
|
*/ function zohoDeskAddTicketFollowers(context) {
|
|
8146
8203
|
return function(input) {
|
|
8147
8204
|
var body = {
|
|
@@ -8153,8 +8210,8 @@ function zohoDeskFollowerApiFetchJsonInput(method, body) {
|
|
|
8153
8210
|
/**
|
|
8154
8211
|
* Creates a {@link ZohoDeskRemoveTicketFollowersFunction} bound to the given context.
|
|
8155
8212
|
*
|
|
8156
|
-
* @param context - Authenticated Zoho Desk context
|
|
8157
|
-
* @returns Function that removes followers from a ticket
|
|
8213
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8214
|
+
* @returns Function that removes followers from a ticket.
|
|
8158
8215
|
*/ function zohoDeskRemoveTicketFollowers(context) {
|
|
8159
8216
|
return function(input) {
|
|
8160
8217
|
var body = {
|
|
@@ -8264,8 +8321,8 @@ function joinAttachmentInclude(include) {
|
|
|
8264
8321
|
/**
|
|
8265
8322
|
* Creates a {@link ZohoDeskGetTicketAttachmentsFunction} bound to the given context.
|
|
8266
8323
|
*
|
|
8267
|
-
* @param context - Authenticated Zoho Desk context
|
|
8268
|
-
* @returns Function that retrieves attachments for a ticket
|
|
8324
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8325
|
+
* @returns Function that retrieves attachments for a ticket.
|
|
8269
8326
|
*/ function zohoDeskGetTicketAttachments(context) {
|
|
8270
8327
|
return function(input) {
|
|
8271
8328
|
var ticketId = input.ticketId, include = input.include, rest = _object_without_properties$5(input, [
|
|
@@ -8287,8 +8344,8 @@ function joinAttachmentInclude(include) {
|
|
|
8287
8344
|
/**
|
|
8288
8345
|
* Creates a {@link ZohoDeskDeleteTicketAttachmentFunction} bound to the given context.
|
|
8289
8346
|
*
|
|
8290
|
-
* @param context - Authenticated Zoho Desk context
|
|
8291
|
-
* @returns Function that deletes a ticket attachment
|
|
8347
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8348
|
+
* @returns Function that deletes a ticket attachment.
|
|
8292
8349
|
*/ function zohoDeskDeleteTicketAttachment(context) {
|
|
8293
8350
|
return function(input) {
|
|
8294
8351
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/attachments/").concat(input.attachmentId), zohoDeskAttachmentApiFetchJsonInput('DELETE'));
|
|
@@ -8395,8 +8452,8 @@ function joinCommentInclude(include) {
|
|
|
8395
8452
|
/**
|
|
8396
8453
|
* Creates a {@link ZohoDeskGetTicketCommentsFunction} bound to the given context.
|
|
8397
8454
|
*
|
|
8398
|
-
* @param context - Authenticated Zoho Desk context
|
|
8399
|
-
* @returns Function that retrieves comments for a ticket
|
|
8455
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8456
|
+
* @returns Function that retrieves comments for a ticket.
|
|
8400
8457
|
*/ function zohoDeskGetTicketComments(context) {
|
|
8401
8458
|
return function(input) {
|
|
8402
8459
|
var ticketId = input.ticketId, include = input.include, rest = _object_without_properties$4(input, [
|
|
@@ -8418,8 +8475,8 @@ function joinCommentInclude(include) {
|
|
|
8418
8475
|
/**
|
|
8419
8476
|
* Creates a {@link ZohoDeskGetTicketCommentByIdFunction} bound to the given context.
|
|
8420
8477
|
*
|
|
8421
|
-
* @param context - Authenticated Zoho Desk context
|
|
8422
|
-
* @returns Function that retrieves a single comment
|
|
8478
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8479
|
+
* @returns Function that retrieves a single comment.
|
|
8423
8480
|
*/ function zohoDeskGetTicketCommentById(context) {
|
|
8424
8481
|
return function(input) {
|
|
8425
8482
|
var ticketId = input.ticketId, commentId = input.commentId, include = input.include;
|
|
@@ -8436,8 +8493,8 @@ function joinCommentInclude(include) {
|
|
|
8436
8493
|
/**
|
|
8437
8494
|
* Creates a {@link ZohoDeskCreateTicketCommentFunction} bound to the given context.
|
|
8438
8495
|
*
|
|
8439
|
-
* @param context - Authenticated Zoho Desk context
|
|
8440
|
-
* @returns Function that creates a comment on a ticket
|
|
8496
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8497
|
+
* @returns Function that creates a comment on a ticket.
|
|
8441
8498
|
*/ function zohoDeskCreateTicketComment(context) {
|
|
8442
8499
|
return function(input) {
|
|
8443
8500
|
var ticketId = input.ticketId, body = _object_without_properties$4(input, [
|
|
@@ -8449,8 +8506,8 @@ function joinCommentInclude(include) {
|
|
|
8449
8506
|
/**
|
|
8450
8507
|
* Creates a {@link ZohoDeskDeleteTicketCommentFunction} bound to the given context.
|
|
8451
8508
|
*
|
|
8452
|
-
* @param context - Authenticated Zoho Desk context
|
|
8453
|
-
* @returns Function that deletes a comment from a ticket
|
|
8509
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8510
|
+
* @returns Function that deletes a comment from a ticket.
|
|
8454
8511
|
*/ function zohoDeskDeleteTicketComment(context) {
|
|
8455
8512
|
return function(input) {
|
|
8456
8513
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/comments/").concat(input.commentId), zohoDeskCommentApiFetchJsonInput('DELETE'));
|
|
@@ -8503,8 +8560,8 @@ function zohoDeskTimeApiFetchJsonInput(method, body) {
|
|
|
8503
8560
|
/**
|
|
8504
8561
|
* Creates a {@link ZohoDeskGetTicketTimerFunction} bound to the given context.
|
|
8505
8562
|
*
|
|
8506
|
-
* @param context - Authenticated Zoho Desk context
|
|
8507
|
-
* @returns Function that retrieves the ticket timer
|
|
8563
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8564
|
+
* @returns Function that retrieves the ticket timer.
|
|
8508
8565
|
*/ function zohoDeskGetTicketTimer(context) {
|
|
8509
8566
|
return function(input) {
|
|
8510
8567
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/timer"), zohoDeskTimeApiFetchJsonInput('GET'));
|
|
@@ -8513,8 +8570,8 @@ function zohoDeskTimeApiFetchJsonInput(method, body) {
|
|
|
8513
8570
|
/**
|
|
8514
8571
|
* Creates a {@link ZohoDeskPerformTicketTimerActionFunction} bound to the given context.
|
|
8515
8572
|
*
|
|
8516
|
-
* @param context - Authenticated Zoho Desk context
|
|
8517
|
-
* @returns Function that performs a timer action on a ticket
|
|
8573
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8574
|
+
* @returns Function that performs a timer action on a ticket.
|
|
8518
8575
|
*/ function zohoDeskPerformTicketTimerAction(context) {
|
|
8519
8576
|
return function(input) {
|
|
8520
8577
|
var ticketId = input.ticketId, body = _object_without_properties$3(input, [
|
|
@@ -8526,8 +8583,8 @@ function zohoDeskTimeApiFetchJsonInput(method, body) {
|
|
|
8526
8583
|
/**
|
|
8527
8584
|
* Creates a {@link ZohoDeskGetTicketTimeEntriesFunction} bound to the given context.
|
|
8528
8585
|
*
|
|
8529
|
-
* @param context - Authenticated Zoho Desk context
|
|
8530
|
-
* @returns Function that retrieves time entries for a ticket
|
|
8586
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8587
|
+
* @returns Function that retrieves time entries for a ticket.
|
|
8531
8588
|
*/ function zohoDeskGetTicketTimeEntries(context) {
|
|
8532
8589
|
return function(input) {
|
|
8533
8590
|
var ticketId = input.ticketId, rest = _object_without_properties$3(input, [
|
|
@@ -8546,8 +8603,8 @@ function zohoDeskTimeApiFetchJsonInput(method, body) {
|
|
|
8546
8603
|
/**
|
|
8547
8604
|
* Creates a {@link ZohoDeskGetTicketTimeEntryByIdFunction} bound to the given context.
|
|
8548
8605
|
*
|
|
8549
|
-
* @param context - Authenticated Zoho Desk context
|
|
8550
|
-
* @returns Function that retrieves a single time entry
|
|
8606
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8607
|
+
* @returns Function that retrieves a single time entry.
|
|
8551
8608
|
*/ function zohoDeskGetTicketTimeEntryById(context) {
|
|
8552
8609
|
return function(input) {
|
|
8553
8610
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/timeEntries/").concat(input.timeEntryId), zohoDeskTimeApiFetchJsonInput('GET'));
|
|
@@ -8556,8 +8613,8 @@ function zohoDeskTimeApiFetchJsonInput(method, body) {
|
|
|
8556
8613
|
/**
|
|
8557
8614
|
* Creates a {@link ZohoDeskGetTicketTimeEntrySummationFunction} bound to the given context.
|
|
8558
8615
|
*
|
|
8559
|
-
* @param context - Authenticated Zoho Desk context
|
|
8560
|
-
* @returns Function that retrieves time entry summation
|
|
8616
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8617
|
+
* @returns Function that retrieves time entry summation.
|
|
8561
8618
|
*/ function zohoDeskGetTicketTimeEntrySummation(context) {
|
|
8562
8619
|
return function(input) {
|
|
8563
8620
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/timeEntries/summation"), zohoDeskTimeApiFetchJsonInput('GET'));
|
|
@@ -8665,8 +8722,8 @@ function joinThreadInclude(include) {
|
|
|
8665
8722
|
*
|
|
8666
8723
|
* Retrieves a paginated list of conversation threads (emails, replies, notes) for a ticket.
|
|
8667
8724
|
*
|
|
8668
|
-
* @param context - Authenticated Zoho Desk context
|
|
8669
|
-
* @returns Function that retrieves threads for a ticket
|
|
8725
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8726
|
+
* @returns Function that retrieves threads for a ticket.
|
|
8670
8727
|
*/ function zohoDeskGetTicketThreads(context) {
|
|
8671
8728
|
return function(input) {
|
|
8672
8729
|
var ticketId = input.ticketId, include = input.include, rest = _object_without_properties$2(input, [
|
|
@@ -8688,8 +8745,8 @@ function joinThreadInclude(include) {
|
|
|
8688
8745
|
/**
|
|
8689
8746
|
* Creates a {@link ZohoDeskGetTicketThreadByIdFunction} bound to the given context.
|
|
8690
8747
|
*
|
|
8691
|
-
* @param context - Authenticated Zoho Desk context
|
|
8692
|
-
* @returns Function that retrieves a single thread
|
|
8748
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8749
|
+
* @returns Function that retrieves a single thread.
|
|
8693
8750
|
*/ function zohoDeskGetTicketThreadById(context) {
|
|
8694
8751
|
return function(input) {
|
|
8695
8752
|
var ticketId = input.ticketId, threadId = input.threadId, include = input.include;
|
|
@@ -8706,8 +8763,9 @@ function joinThreadInclude(include) {
|
|
|
8706
8763
|
/**
|
|
8707
8764
|
* Creates a {@link ZohoDeskGetTicketThreadsPageFactory} bound to the given context.
|
|
8708
8765
|
*
|
|
8709
|
-
* @param context - Authenticated Zoho Desk context
|
|
8710
|
-
* @returns Page factory for iterating over thread results
|
|
8766
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8767
|
+
* @returns Page factory for iterating over thread results.
|
|
8768
|
+
*
|
|
8711
8769
|
* @__NO_SIDE_EFFECTS__
|
|
8712
8770
|
*/ function zohoDeskGetTicketThreadsPageFactory(context) {
|
|
8713
8771
|
return zohoDeskFetchPageFactory(zohoDeskGetTicketThreads(context));
|
|
@@ -8814,8 +8872,8 @@ function joinActivityInclude(include) {
|
|
|
8814
8872
|
*
|
|
8815
8873
|
* Retrieves a paginated list of activities (tasks, events, calls) associated with a ticket.
|
|
8816
8874
|
*
|
|
8817
|
-
* @param context - Authenticated Zoho Desk context
|
|
8818
|
-
* @returns Function that retrieves activities for a ticket
|
|
8875
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8876
|
+
* @returns Function that retrieves activities for a ticket.
|
|
8819
8877
|
*/ function zohoDeskGetTicketActivities(context) {
|
|
8820
8878
|
return function(input) {
|
|
8821
8879
|
var ticketId = input.ticketId, include = input.include, rest = _object_without_properties$1(input, [
|
|
@@ -8837,8 +8895,9 @@ function joinActivityInclude(include) {
|
|
|
8837
8895
|
/**
|
|
8838
8896
|
* Creates a {@link ZohoDeskGetTicketActivitiesPageFactory} bound to the given context.
|
|
8839
8897
|
*
|
|
8840
|
-
* @param context - Authenticated Zoho Desk context
|
|
8841
|
-
* @returns Page factory for iterating over activity results
|
|
8898
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8899
|
+
* @returns Page factory for iterating over activity results.
|
|
8900
|
+
*
|
|
8842
8901
|
* @__NO_SIDE_EFFECTS__
|
|
8843
8902
|
*/ function zohoDeskGetTicketActivitiesPageFactory(context) {
|
|
8844
8903
|
return zohoDeskFetchPageFactory(zohoDeskGetTicketActivities(context));
|
|
@@ -8946,8 +9005,8 @@ function joinAgentInclude(include) {
|
|
|
8946
9005
|
* Retrieves a paginated list of agents, with optional filtering by department and status,
|
|
8947
9006
|
* and inline expansion of related entities (role, profile, departments).
|
|
8948
9007
|
*
|
|
8949
|
-
* @param context - Authenticated Zoho Desk context
|
|
8950
|
-
* @returns Function that retrieves paginated agents
|
|
9008
|
+
* @param context - Authenticated Zoho Desk context.
|
|
9009
|
+
* @returns Function that retrieves paginated agents.
|
|
8951
9010
|
*/ function zohoDeskGetAgents(context) {
|
|
8952
9011
|
return function(input) {
|
|
8953
9012
|
var include = input.include, rest = _object_without_properties(input, [
|
|
@@ -8968,8 +9027,8 @@ function joinAgentInclude(include) {
|
|
|
8968
9027
|
/**
|
|
8969
9028
|
* Creates a {@link ZohoDeskGetAgentByIdFunction} bound to the given context.
|
|
8970
9029
|
*
|
|
8971
|
-
* @param context - Authenticated Zoho Desk context
|
|
8972
|
-
* @returns Function that retrieves a single agent
|
|
9030
|
+
* @param context - Authenticated Zoho Desk context.
|
|
9031
|
+
* @returns Function that retrieves a single agent.
|
|
8973
9032
|
*/ function zohoDeskGetAgentById(context) {
|
|
8974
9033
|
return function(input) {
|
|
8975
9034
|
var agentId = input.agentId, include = input.include;
|
|
@@ -8986,8 +9045,8 @@ function joinAgentInclude(include) {
|
|
|
8986
9045
|
/**
|
|
8987
9046
|
* Creates a {@link ZohoDeskGetAgentsByIdsFunction} bound to the given context.
|
|
8988
9047
|
*
|
|
8989
|
-
* @param context - Authenticated Zoho Desk context
|
|
8990
|
-
* @returns Function that retrieves agents by IDs
|
|
9048
|
+
* @param context - Authenticated Zoho Desk context.
|
|
9049
|
+
* @returns Function that retrieves agents by IDs.
|
|
8991
9050
|
*/ function zohoDeskGetAgentsByIds(context) {
|
|
8992
9051
|
return function(input) {
|
|
8993
9052
|
var params = fetch.makeUrlSearchParams([
|
|
@@ -9006,8 +9065,8 @@ function joinAgentInclude(include) {
|
|
|
9006
9065
|
*
|
|
9007
9066
|
* Retrieves the profile of the agent associated with the current OAuth token.
|
|
9008
9067
|
*
|
|
9009
|
-
* @param context - Authenticated Zoho Desk context
|
|
9010
|
-
* @returns Function that retrieves the current agent's info
|
|
9068
|
+
* @param context - Authenticated Zoho Desk context.
|
|
9069
|
+
* @returns Function that retrieves the current agent's info.
|
|
9011
9070
|
*/ function zohoDeskGetMyInfo(context) {
|
|
9012
9071
|
return function() {
|
|
9013
9072
|
return context.fetchJson('/myinfo', zohoDeskAgentApiFetchJsonInput('GET'));
|
|
@@ -9016,8 +9075,9 @@ function joinAgentInclude(include) {
|
|
|
9016
9075
|
/**
|
|
9017
9076
|
* Creates a {@link ZohoDeskGetAgentsPageFactory} bound to the given context.
|
|
9018
9077
|
*
|
|
9019
|
-
* @param context - Authenticated Zoho Desk context
|
|
9020
|
-
* @returns Page factory for iterating over agent results
|
|
9078
|
+
* @param context - Authenticated Zoho Desk context.
|
|
9079
|
+
* @returns Page factory for iterating over agent results.
|
|
9080
|
+
*
|
|
9021
9081
|
* @__NO_SIDE_EFFECTS__
|
|
9022
9082
|
*/ function zohoDeskGetAgentsPageFactory(context) {
|
|
9023
9083
|
return zohoDeskFetchPageFactory(zohoDeskGetAgents(context));
|
|
@@ -9030,8 +9090,10 @@ function joinAgentInclude(include) {
|
|
|
9030
9090
|
* The returned function accepts optional overrides for client credentials and refresh token.
|
|
9031
9091
|
* When omitted, values are read from the {@link ZohoAccountsContext}'s config.
|
|
9032
9092
|
*
|
|
9033
|
-
* @param context - Authenticated Zoho Accounts context providing fetch and config
|
|
9034
|
-
* @returns Function that exchanges a refresh token for an access token
|
|
9093
|
+
* @param context - Authenticated Zoho Accounts context providing fetch and config.
|
|
9094
|
+
* @returns Function that exchanges a refresh token for an access token.
|
|
9095
|
+
*
|
|
9096
|
+
* @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token-expiry.html
|
|
9035
9097
|
*
|
|
9036
9098
|
* @example
|
|
9037
9099
|
* ```typescript
|
|
@@ -9046,8 +9108,6 @@ function joinAgentInclude(include) {
|
|
|
9046
9108
|
* refreshToken: 'other-refresh-token'
|
|
9047
9109
|
* });
|
|
9048
9110
|
* ```
|
|
9049
|
-
*
|
|
9050
|
-
* @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token-expiry.html
|
|
9051
9111
|
*/ function zohoAccountsAccessToken(context) {
|
|
9052
9112
|
return function(input) {
|
|
9053
9113
|
var _ref, _ref1;
|
|
@@ -9079,7 +9139,9 @@ function joinAgentInclude(include) {
|
|
|
9079
9139
|
* the initial authorization request.
|
|
9080
9140
|
*
|
|
9081
9141
|
* @param context - Zoho Accounts context providing fetch and config (clientId/clientSecret)
|
|
9082
|
-
* @returns Function that exchanges an authorization code for tokens
|
|
9142
|
+
* @returns Function that exchanges an authorization code for tokens.
|
|
9143
|
+
*
|
|
9144
|
+
* @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token.html
|
|
9083
9145
|
*
|
|
9084
9146
|
* @example
|
|
9085
9147
|
* ```typescript
|
|
@@ -9090,8 +9152,6 @@ function joinAgentInclude(include) {
|
|
|
9090
9152
|
* redirectUri: 'https://myapp.example.com/oauth/callback'
|
|
9091
9153
|
* });
|
|
9092
9154
|
* ```
|
|
9093
|
-
*
|
|
9094
|
-
* @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token.html
|
|
9095
9155
|
*/ function zohoAccountsRefreshTokenFromAuthorizationCode(context) {
|
|
9096
9156
|
return function(input) {
|
|
9097
9157
|
var _ref, _ref1;
|
|
@@ -9112,9 +9172,9 @@ function joinAgentInclude(include) {
|
|
|
9112
9172
|
/**
|
|
9113
9173
|
* Constructs a standard {@link FetchJsonInput} for Zoho Accounts API calls with the given HTTP method and optional body.
|
|
9114
9174
|
*
|
|
9115
|
-
* @param method - HTTP method to use for the request
|
|
9116
|
-
* @param body - Optional request body to include
|
|
9117
|
-
* @returns Configured fetch input for the Zoho Accounts API call
|
|
9175
|
+
* @param method - HTTP method to use for the request.
|
|
9176
|
+
* @param body - Optional request body to include.
|
|
9177
|
+
* @returns Configured fetch input for the Zoho Accounts API call.
|
|
9118
9178
|
*/ function zohoAccountsApiFetchJsonInput(method, body) {
|
|
9119
9179
|
return {
|
|
9120
9180
|
method: method,
|
|
@@ -9128,15 +9188,19 @@ function joinAgentInclude(include) {
|
|
|
9128
9188
|
/**
|
|
9129
9189
|
* Resolves a Zoho Accounts API URL input to the full base URL. The 'us' key maps to the US datacenter; custom URLs pass through unchanged.
|
|
9130
9190
|
*
|
|
9131
|
-
* @param input - A well-known datacenter key or a custom Zoho Accounts API URL
|
|
9132
|
-
* @returns The resolved full Zoho Accounts API base URL
|
|
9191
|
+
* @param input - A well-known datacenter key or a custom Zoho Accounts API URL.
|
|
9192
|
+
* @returns The resolved full Zoho Accounts API base URL.
|
|
9133
9193
|
*/ function zohoAccountsConfigApiUrl(input) {
|
|
9194
|
+
var result;
|
|
9134
9195
|
switch(input){
|
|
9135
9196
|
case 'us':
|
|
9136
|
-
|
|
9197
|
+
result = ZOHO_ACCOUNTS_US_API_URL;
|
|
9198
|
+
break;
|
|
9137
9199
|
default:
|
|
9138
|
-
|
|
9200
|
+
result = input;
|
|
9201
|
+
break;
|
|
9139
9202
|
}
|
|
9203
|
+
return result;
|
|
9140
9204
|
}
|
|
9141
9205
|
|
|
9142
9206
|
function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
|
|
@@ -9325,9 +9389,9 @@ function _ts_generator(thisArg, body) {
|
|
|
9325
9389
|
* The Accounts client is the foundation for CRM, Recruit, and Sign clients, as it provides
|
|
9326
9390
|
* the {@link ZohoAccountsContext} needed for OAuth token management.
|
|
9327
9391
|
*
|
|
9328
|
-
* @param factoryConfig - Configuration providing optional fetch and logging overrides
|
|
9329
|
-
* @returns A factory function that creates authenticated Zoho Accounts clients
|
|
9330
|
-
* @throws {Error} If `refreshToken`, `clientId`, or `clientSecret` are missing from the config
|
|
9392
|
+
* @param factoryConfig - Configuration providing optional fetch and logging overrides.
|
|
9393
|
+
* @returns A factory function that creates authenticated Zoho Accounts clients.
|
|
9394
|
+
* @throws {Error} If `refreshToken`, `clientId`, or `clientSecret` are missing from the config.
|
|
9331
9395
|
*
|
|
9332
9396
|
* @example
|
|
9333
9397
|
* ```typescript
|
|
@@ -9345,6 +9409,7 @@ function _ts_generator(thisArg, body) {
|
|
|
9345
9409
|
* accountsContext: zohoAccounts.accountsContext
|
|
9346
9410
|
* });
|
|
9347
9411
|
* ```
|
|
9412
|
+
*
|
|
9348
9413
|
* @__NO_SIDE_EFFECTS__
|
|
9349
9414
|
*/ function zohoAccountsFactory(factoryConfig) {
|
|
9350
9415
|
var fetchHandler = zohoRateLimitedFetchHandler();
|
|
@@ -9449,9 +9514,10 @@ function _ts_generator(thisArg, body) {
|
|
|
9449
9514
|
* The returned function also exposes a `resetAccessToken()` method to invalidate
|
|
9450
9515
|
* the current cached token, typically called on {@link ZohoInvalidTokenError}.
|
|
9451
9516
|
*
|
|
9452
|
-
* @param config - Token refresh, caching, and expiration buffer configuration
|
|
9453
|
-
* @returns A token factory function with `resetAccessToken` for cache invalidation
|
|
9454
|
-
* @throws {ZohoAccountsAuthFailureError} If the token refresher fails
|
|
9517
|
+
* @param config - Token refresh, caching, and expiration buffer configuration.
|
|
9518
|
+
* @returns A token factory function with `resetAccessToken` for cache invalidation.
|
|
9519
|
+
* @throws {ZohoAccountsAuthFailureError} If the token refresher fails.
|
|
9520
|
+
*
|
|
9455
9521
|
* @__NO_SIDE_EFFECTS__
|
|
9456
9522
|
*/ function zohoAccountsZohoAccessTokenFactory(config) {
|
|
9457
9523
|
var tokenRefresher = config.tokenRefresher, accessTokenCache = config.accessTokenCache, inputTokenExpirationBuffer = config.tokenExpirationBuffer;
|
|
@@ -9566,7 +9632,7 @@ function safeZohoDateTimeString(date) {
|
|
|
9566
9632
|
* Converts a {@link Date} to a {@link ZohoDateTimeString} by stripping milliseconds
|
|
9567
9633
|
* from the ISO 8601 representation.
|
|
9568
9634
|
*
|
|
9569
|
-
* @param date - Date to convert
|
|
9635
|
+
* @param date - Date to convert.
|
|
9570
9636
|
* @returns Zoho-formatted date-time string (e.g. `'2019-05-02T11:17:33Z'`)
|
|
9571
9637
|
*
|
|
9572
9638
|
* @example
|
|
@@ -9582,6 +9648,7 @@ function safeZohoDateTimeString(date) {
|
|
|
9582
9648
|
exports.DEFAULT_ZOHO_API_RATE_LIMIT = DEFAULT_ZOHO_API_RATE_LIMIT;
|
|
9583
9649
|
exports.DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD = DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD;
|
|
9584
9650
|
exports.DEFAULT_ZOHO_DESK_API_RATE_LIMIT = DEFAULT_ZOHO_DESK_API_RATE_LIMIT;
|
|
9651
|
+
exports.DEFAULT_ZOHO_DESK_PAGE_LIMIT = DEFAULT_ZOHO_DESK_PAGE_LIMIT;
|
|
9585
9652
|
exports.DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION = DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION;
|
|
9586
9653
|
exports.DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION = DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION;
|
|
9587
9654
|
exports.MAX_ZOHO_CRM_SEARCH_MODULE_RECORDS_CRITERIA = MAX_ZOHO_CRM_SEARCH_MODULE_RECORDS_CRITERIA;
|
|
@@ -9604,7 +9671,6 @@ exports.ZOHO_CRM_SERVICE_NAME = ZOHO_CRM_SERVICE_NAME;
|
|
|
9604
9671
|
exports.ZOHO_CRM_TAG_NAME_MAX_LENGTH = ZOHO_CRM_TAG_NAME_MAX_LENGTH;
|
|
9605
9672
|
exports.ZOHO_CRM_TASKS_MODULE = ZOHO_CRM_TASKS_MODULE;
|
|
9606
9673
|
exports.ZOHO_DATA_ARRAY_BLANK_ERROR_CODE = ZOHO_DATA_ARRAY_BLANK_ERROR_CODE;
|
|
9607
|
-
exports.ZOHO_DESK_DEFAULT_PAGE_LIMIT = ZOHO_DESK_DEFAULT_PAGE_LIMIT;
|
|
9608
9674
|
exports.ZOHO_DESK_MAX_PAGE_LIMIT = ZOHO_DESK_MAX_PAGE_LIMIT;
|
|
9609
9675
|
exports.ZOHO_DESK_RATE_LIMIT_REMAINING_HEADER = ZOHO_DESK_RATE_LIMIT_REMAINING_HEADER;
|
|
9610
9676
|
exports.ZOHO_DESK_RATE_LIMIT_WEIGHT_HEADER = ZOHO_DESK_RATE_LIMIT_WEIGHT_HEADER;
|