@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.esm.js
CHANGED
|
@@ -53,7 +53,7 @@ function _object_spread_props$n(target, source) {
|
|
|
53
53
|
* Creates an empty {@link ZohoPageResult} with no data and `more_records: false`.
|
|
54
54
|
* Useful as a fallback when the API returns `null` instead of an empty result.
|
|
55
55
|
*
|
|
56
|
-
* @returns An empty page result with default pagination info
|
|
56
|
+
* @returns An empty page result with default pagination info.
|
|
57
57
|
*/ function emptyZohoPageResult() {
|
|
58
58
|
return {
|
|
59
59
|
data: [],
|
|
@@ -71,9 +71,9 @@ function _object_spread_props$n(target, source) {
|
|
|
71
71
|
* The factory reads `info.more_records` from each response to determine if additional
|
|
72
72
|
* pages exist, and automatically increments the `page` parameter for subsequent requests.
|
|
73
73
|
*
|
|
74
|
-
* @param fetch - The Zoho fetch function to paginate over
|
|
75
|
-
* @param defaults - Optional default configuration for the page factory
|
|
76
|
-
* @returns A page factory that produces iterable page fetchers
|
|
74
|
+
* @param fetch - The Zoho fetch function to paginate over.
|
|
75
|
+
* @param defaults - Optional default configuration for the page factory.
|
|
76
|
+
* @returns A page factory that produces iterable page fetchers.
|
|
77
77
|
*
|
|
78
78
|
* @example
|
|
79
79
|
* ```typescript
|
|
@@ -86,6 +86,7 @@ function _object_spread_props$n(target, source) {
|
|
|
86
86
|
* const secondPage = await firstPage.fetchNext();
|
|
87
87
|
* }
|
|
88
88
|
* ```
|
|
89
|
+
*
|
|
89
90
|
* @__NO_SIDE_EFFECTS__
|
|
90
91
|
*/ function zohoFetchPageFactory(fetch, defaults) {
|
|
91
92
|
return fetchPageFactory(_object_spread_props$n(_object_spread$o({}, defaults), {
|
|
@@ -113,17 +114,22 @@ function _object_spread_props$n(target, source) {
|
|
|
113
114
|
/**
|
|
114
115
|
* Resolves an environment key or passthrough URL to the full Zoho Recruit API URL.
|
|
115
116
|
*
|
|
116
|
-
* @param input - An environment key ('sandbox' or 'production') or a full API URL
|
|
117
|
-
* @returns The resolved Zoho Recruit API URL
|
|
117
|
+
* @param input - An environment key ('sandbox' or 'production') or a full API URL.
|
|
118
|
+
* @returns The resolved Zoho Recruit API URL.
|
|
118
119
|
*/ function zohoRecruitConfigApiUrl(input) {
|
|
120
|
+
var result;
|
|
119
121
|
switch(input){
|
|
120
122
|
case 'sandbox':
|
|
121
|
-
|
|
123
|
+
result = 'https://recruitsandbox.zoho.com/recruit';
|
|
124
|
+
break;
|
|
122
125
|
case 'production':
|
|
123
|
-
|
|
126
|
+
result = 'https://recruit.zoho.com/recruit';
|
|
127
|
+
break;
|
|
124
128
|
default:
|
|
125
|
-
|
|
129
|
+
result = input;
|
|
130
|
+
break;
|
|
126
131
|
}
|
|
132
|
+
return result;
|
|
127
133
|
}
|
|
128
134
|
|
|
129
135
|
/**
|
|
@@ -166,8 +172,8 @@ function _type_of$6(obj) {
|
|
|
166
172
|
* {@link ZohoSearchRecordsCriteriaTree} with nested AND/OR groups. Returns
|
|
167
173
|
* `undefined` when the input is nullish or empty.
|
|
168
174
|
*
|
|
169
|
-
* @param input - Criteria tree element, entry array, or raw criteria string
|
|
170
|
-
* @returns Compiled criteria string, or `undefined` if input is empty
|
|
175
|
+
* @param input - Criteria tree element, entry array, or raw criteria string.
|
|
176
|
+
* @returns Compiled criteria string, or `undefined` if input is empty.
|
|
171
177
|
*
|
|
172
178
|
* @example
|
|
173
179
|
* ```typescript
|
|
@@ -217,8 +223,8 @@ function _type_of$6(obj) {
|
|
|
217
223
|
* recursively resolving nested AND/OR groups. When both `and` and `or` are
|
|
218
224
|
* present at the same level, the OR group is merged into the AND group.
|
|
219
225
|
*
|
|
220
|
-
* @param tree - Criteria tree containing `and` and/or `or` branches
|
|
221
|
-
* @returns Compiled criteria string, or `undefined` if the tree is empty
|
|
226
|
+
* @param tree - Criteria tree containing `and` and/or `or` branches.
|
|
227
|
+
* @returns Compiled criteria string, or `undefined` if the tree is empty.
|
|
222
228
|
*/ function zohoSearchRecordsCriteriaStringForTree(tree) {
|
|
223
229
|
function convertToString(value) {
|
|
224
230
|
var result;
|
|
@@ -273,7 +279,7 @@ function _type_of$6(obj) {
|
|
|
273
279
|
*
|
|
274
280
|
* Automatically escapes parentheses and commas in the value via {@link escapeZohoFieldValueForCriteriaString}.
|
|
275
281
|
*
|
|
276
|
-
* @param entry - The criteria entry to convert
|
|
282
|
+
* @param entry - The criteria entry to convert.
|
|
277
283
|
* @returns Criteria string in the format `(field:filter:escapedValue)`
|
|
278
284
|
*
|
|
279
285
|
* @example
|
|
@@ -562,8 +568,8 @@ function _ts_generator$b(thisArg, body) {
|
|
|
562
568
|
/**
|
|
563
569
|
* Normalizes a Zoho error response entry into a consistent {@link ZohoServerErrorData} shape, handling both object and string error formats.
|
|
564
570
|
*
|
|
565
|
-
* @param error - The raw error entry, either a structured object or a plain error code string
|
|
566
|
-
* @returns Normalized error data with code and message fields
|
|
571
|
+
* @param error - The raw error entry, either a structured object or a plain error code string.
|
|
572
|
+
* @returns Normalized error data with code and message fields.
|
|
567
573
|
*/ function zohoServerErrorData(error) {
|
|
568
574
|
var errorType = typeof error === "undefined" ? "undefined" : _type_of$5(error);
|
|
569
575
|
var errorData;
|
|
@@ -649,8 +655,9 @@ function _ts_generator$b(thisArg, body) {
|
|
|
649
655
|
* Creates a logZohoServerErrorFunction that logs the error to console.
|
|
650
656
|
*
|
|
651
657
|
* @param zohoApiNamePrefix - Prefix to use when logging (e.g. 'ZohoRecruit', 'ZohoSign')
|
|
652
|
-
* @param options - Optional configuration for controlling which error types are logged
|
|
653
|
-
* @returns
|
|
658
|
+
* @param options - Optional configuration for controlling which error types are logged.
|
|
659
|
+
* @returns Logs Zoho server errors to the console.
|
|
660
|
+
*
|
|
654
661
|
* @__NO_SIDE_EFFECTS__
|
|
655
662
|
*/ function logZohoServerErrorFunction(zohoApiNamePrefix, options) {
|
|
656
663
|
var _ref = options !== null && options !== void 0 ? options : {}, _ref_logDataArrayErrors = _ref.logDataArrayErrors, logDataArrayErrors = _ref_logDataArrayErrors === void 0 ? false : _ref_logDataArrayErrors;
|
|
@@ -674,9 +681,10 @@ function _ts_generator$b(thisArg, body) {
|
|
|
674
681
|
/**
|
|
675
682
|
* Wraps a ConfiguredFetch to support handling errors returned by fetch.
|
|
676
683
|
*
|
|
677
|
-
* @param parseZohoError - Function that parses a fetch response error into a Zoho-specific error
|
|
678
|
-
* @param defaultLogError - Default error logging function used when no custom logger is provided
|
|
679
|
-
* @returns Factory that wraps a ConfiguredFetch with Zoho error handling
|
|
684
|
+
* @param parseZohoError - Function that parses a fetch response error into a Zoho-specific error.
|
|
685
|
+
* @param defaultLogError - Default error logging function used when no custom logger is provided.
|
|
686
|
+
* @returns Factory that wraps a ConfiguredFetch with Zoho error handling.
|
|
687
|
+
*
|
|
680
688
|
* @__NO_SIDE_EFFECTS__
|
|
681
689
|
*/ function handleZohoErrorFetchFactory(parseZohoError, defaultLogError) {
|
|
682
690
|
return function(fetch) {
|
|
@@ -735,8 +743,9 @@ function _ts_generator$b(thisArg, body) {
|
|
|
735
743
|
/**
|
|
736
744
|
* FetchJsonInterceptJsonResponseFunction that intercepts a 200 response that actually contains a ZohoServerError and throws a ZohoServerError for the error handling to catch.
|
|
737
745
|
*
|
|
738
|
-
* @param parseZohoServerErrorResponseData - Function that parses raw error response data into a structured error
|
|
739
|
-
* @returns Interceptor function that detects and throws hidden errors in 200 responses
|
|
746
|
+
* @param parseZohoServerErrorResponseData - Function that parses raw error response data into a structured error.
|
|
747
|
+
* @returns Interceptor function that detects and throws hidden errors in 200 responses.
|
|
748
|
+
*
|
|
740
749
|
* @__NO_SIDE_EFFECTS__
|
|
741
750
|
*/ function interceptZohoErrorResponseFactory(parseZohoServerErrorResponseData) {
|
|
742
751
|
return function(json, response) {
|
|
@@ -838,8 +847,8 @@ var DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD = MS_IN_MINUTE;
|
|
|
838
847
|
/**
|
|
839
848
|
* Extracts rate limit details from Zoho API response headers, returning null if the headers are absent.
|
|
840
849
|
*
|
|
841
|
-
* @param headers - HTTP response headers from a Zoho API call
|
|
842
|
-
* @returns Parsed rate limit details, or null if rate limit headers are missing
|
|
850
|
+
* @param headers - HTTP response headers from a Zoho API call.
|
|
851
|
+
* @returns Parsed rate limit details, or null if rate limit headers are missing.
|
|
843
852
|
*/ function zohoRateLimitHeaderDetails(headers) {
|
|
844
853
|
var limitHeader = headers.get(ZOHO_RATE_LIMIT_LIMIT_HEADER);
|
|
845
854
|
var remainingHeader = headers.get(ZOHO_RATE_LIMIT_REMAINING_HEADER);
|
|
@@ -878,9 +887,9 @@ var ZohoTooManyRequestsError = /*#__PURE__*/ function(ZohoServerFetchResponseErr
|
|
|
878
887
|
/**
|
|
879
888
|
* Function that parses/transforms a ZohoServerErrorResponseData into a general ZohoServerError or other known error type.
|
|
880
889
|
*
|
|
881
|
-
* @param errorResponseData - Raw error response data from the Zoho API
|
|
882
|
-
* @param responseError - The underlying fetch response error
|
|
883
|
-
* @returns A typed Zoho server error, or undefined if no error is found
|
|
890
|
+
* @param errorResponseData - Raw error response data from the Zoho API.
|
|
891
|
+
* @param responseError - The underlying fetch response error.
|
|
892
|
+
* @returns A typed Zoho server error, or undefined if no error is found.
|
|
884
893
|
*/ function parseZohoServerErrorResponseData(errorResponseData, responseError) {
|
|
885
894
|
var result;
|
|
886
895
|
if (isZohoServerErrorResponseDataArrayRef(errorResponseData)) {
|
|
@@ -1223,8 +1232,8 @@ function _ts_generator$a(thisArg, body) {
|
|
|
1223
1232
|
/**
|
|
1224
1233
|
* Creates a typed CRUD error subclass based on the error code returned by the Zoho Recruit API, enabling callers to catch specific failure modes.
|
|
1225
1234
|
*
|
|
1226
|
-
* @param error - Structured error data from the Zoho Recruit API response
|
|
1227
|
-
* @returns A specific CRUD error subclass matching the error code
|
|
1235
|
+
* @param error - Structured error data from the Zoho Recruit API response.
|
|
1236
|
+
* @returns A specific CRUD error subclass matching the error code.
|
|
1228
1237
|
*/ function zohoRecruitRecordCrudError(error) {
|
|
1229
1238
|
var result;
|
|
1230
1239
|
switch(error.code){
|
|
@@ -1253,9 +1262,9 @@ function _ts_generator$a(thisArg, body) {
|
|
|
1253
1262
|
/**
|
|
1254
1263
|
* Returns an assertion function that throws {@link ZohoRecruitRecordNoContentError} when the data array result is empty or null, indicating the requested record does not exist.
|
|
1255
1264
|
*
|
|
1256
|
-
* @param moduleName - Optional module name for the error context
|
|
1257
|
-
* @param recordId - Optional record ID for the error context
|
|
1258
|
-
* @returns Assertion function that validates the data array is non-empty
|
|
1265
|
+
* @param moduleName - Optional module name for the error context.
|
|
1266
|
+
* @param recordId - Optional record ID for the error context.
|
|
1267
|
+
* @returns Assertion function that validates the data array is non-empty.
|
|
1259
1268
|
*/ function assertZohoRecruitRecordDataArrayResultHasContent(moduleName, recordId) {
|
|
1260
1269
|
return function(x) {
|
|
1261
1270
|
var _x_data;
|
|
@@ -1271,8 +1280,8 @@ function _ts_generator$a(thisArg, body) {
|
|
|
1271
1280
|
/**
|
|
1272
1281
|
* Parses the JSON body of a failed Zoho Recruit fetch response into a structured error, returning undefined if the body cannot be parsed.
|
|
1273
1282
|
*
|
|
1274
|
-
* @param responseError - The fetch response error to parse
|
|
1275
|
-
* @returns Parsed Zoho server error, or undefined if parsing fails
|
|
1283
|
+
* @param responseError - The fetch response error to parse.
|
|
1284
|
+
* @returns Parsed Zoho server error, or undefined if parsing fails.
|
|
1276
1285
|
*/ function parseZohoRecruitError(responseError) {
|
|
1277
1286
|
return _async_to_generator$a(function() {
|
|
1278
1287
|
var data, result;
|
|
@@ -1301,9 +1310,9 @@ function _ts_generator$a(thisArg, body) {
|
|
|
1301
1310
|
/**
|
|
1302
1311
|
* 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.
|
|
1303
1312
|
*
|
|
1304
|
-
* @param errorResponseData - Raw error response data from the Zoho Recruit API
|
|
1305
|
-
* @param responseError - The underlying fetch response error
|
|
1306
|
-
* @returns Parsed Zoho server error, or undefined if the data contains no recognizable error
|
|
1313
|
+
* @param errorResponseData - Raw error response data from the Zoho Recruit API.
|
|
1314
|
+
* @param responseError - The underlying fetch response error.
|
|
1315
|
+
* @returns Parsed Zoho server error, or undefined if the data contains no recognizable error.
|
|
1307
1316
|
*/ function parseZohoRecruitServerErrorResponseData(errorResponseData, responseError) {
|
|
1308
1317
|
var result;
|
|
1309
1318
|
var error = tryFindZohoServerErrorData(errorResponseData, responseError);
|
|
@@ -1325,6 +1334,7 @@ function _ts_generator$a(thisArg, body) {
|
|
|
1325
1334
|
* 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).
|
|
1326
1335
|
*/ var handleZohoRecruitErrorFetch = handleZohoErrorFetchFactory(parseZohoRecruitError, logZohoRecruitErrorToConsole);
|
|
1327
1336
|
// MARK: Compat
|
|
1337
|
+
// COMPAT: Deprecated aliases
|
|
1328
1338
|
/**
|
|
1329
1339
|
* @deprecated Use assertZohoRecruitRecordDataArrayResultHasContent instead.
|
|
1330
1340
|
*/ var assertRecordDataArrayResultHasContent = assertZohoRecruitRecordDataArrayResultHasContent;
|
|
@@ -1447,10 +1457,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1447
1457
|
* When a single record is provided, the function returns the change details directly or throws on error.
|
|
1448
1458
|
* When multiple records are provided, it returns a paired success/error result.
|
|
1449
1459
|
*
|
|
1450
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
1460
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
1451
1461
|
* @param fetchUrlPrefix - URL path suffix for the endpoint (empty for insert/update, '/upsert' for upsert)
|
|
1452
|
-
* @param fetchMethod - HTTP method to use for the request
|
|
1453
|
-
* @returns Factory function that inserts, updates, or upserts records
|
|
1462
|
+
* @param fetchMethod - HTTP method to use for the request.
|
|
1463
|
+
* @returns Factory function that inserts, updates, or upserts records.
|
|
1454
1464
|
*/ function updateRecordLikeFunction$1(context, fetchUrlPrefix, fetchMethod) {
|
|
1455
1465
|
return function(param) {
|
|
1456
1466
|
var data = param.data, module = param.module;
|
|
@@ -1483,8 +1493,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1483
1493
|
*
|
|
1484
1494
|
* Maximum of {@link ZOHO_RECRUIT_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
1485
1495
|
*
|
|
1486
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1487
|
-
* @returns Function that inserts records into the specified module
|
|
1496
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1497
|
+
* @returns Function that inserts records into the specified module.
|
|
1498
|
+
*
|
|
1499
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html
|
|
1488
1500
|
*
|
|
1489
1501
|
* @example
|
|
1490
1502
|
* ```typescript
|
|
@@ -1505,8 +1517,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1505
1517
|
* ]
|
|
1506
1518
|
* });
|
|
1507
1519
|
* ```
|
|
1508
|
-
*
|
|
1509
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/insert-records.html
|
|
1510
1520
|
*/ function zohoRecruitInsertRecord(context) {
|
|
1511
1521
|
return updateRecordLikeFunction$1(context, '', 'POST');
|
|
1512
1522
|
}
|
|
@@ -1520,8 +1530,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1520
1530
|
*
|
|
1521
1531
|
* Maximum of {@link ZOHO_RECRUIT_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
1522
1532
|
*
|
|
1523
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1524
|
-
* @returns Function that upserts records in the specified module
|
|
1533
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1534
|
+
* @returns Function that upserts records in the specified module.
|
|
1535
|
+
*
|
|
1536
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html
|
|
1525
1537
|
*
|
|
1526
1538
|
* @example
|
|
1527
1539
|
* ```typescript
|
|
@@ -1548,8 +1560,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1548
1560
|
* ]
|
|
1549
1561
|
* });
|
|
1550
1562
|
* ```
|
|
1551
|
-
*
|
|
1552
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/upsert-records.html
|
|
1553
1563
|
*/ function zohoRecruitUpsertRecord(context) {
|
|
1554
1564
|
return updateRecordLikeFunction$1(context, '/upsert', 'POST');
|
|
1555
1565
|
}
|
|
@@ -1562,8 +1572,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1562
1572
|
*
|
|
1563
1573
|
* Maximum of {@link ZOHO_RECRUIT_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
1564
1574
|
*
|
|
1565
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1566
|
-
* @returns Function that updates records in the specified module
|
|
1575
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1576
|
+
* @returns Function that updates records in the specified module.
|
|
1577
|
+
*
|
|
1578
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/update-records.html
|
|
1567
1579
|
*
|
|
1568
1580
|
* @example
|
|
1569
1581
|
* ```typescript
|
|
@@ -1584,8 +1596,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1584
1596
|
* ]
|
|
1585
1597
|
* });
|
|
1586
1598
|
* ```
|
|
1587
|
-
*
|
|
1588
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/update-records.html
|
|
1589
1599
|
*/ function zohoRecruitUpdateRecord(context) {
|
|
1590
1600
|
return updateRecordLikeFunction$1(context, '', 'PUT');
|
|
1591
1601
|
}
|
|
@@ -1596,8 +1606,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1596
1606
|
* an optional `wf_trigger` flag to execute workflow rules on deletion. Returns
|
|
1597
1607
|
* a response with separated success and error entries.
|
|
1598
1608
|
*
|
|
1599
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1600
|
-
* @returns Function that deletes records from the specified module
|
|
1609
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1610
|
+
* @returns Function that deletes records from the specified module.
|
|
1611
|
+
*
|
|
1612
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-records.html
|
|
1601
1613
|
*
|
|
1602
1614
|
* @example
|
|
1603
1615
|
* ```typescript
|
|
@@ -1608,8 +1620,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1608
1620
|
* ids: candidateId
|
|
1609
1621
|
* });
|
|
1610
1622
|
* ```
|
|
1611
|
-
*
|
|
1612
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-records.html
|
|
1613
1623
|
*/ function zohoRecruitDeleteRecord(context) {
|
|
1614
1624
|
return function(param) {
|
|
1615
1625
|
var ids = param.ids, module = param.module, wf_trigger = param.wf_trigger;
|
|
@@ -1626,8 +1636,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1626
1636
|
* unwrapped from the standard data array, returning the record directly.
|
|
1627
1637
|
* Throws if the record is not found.
|
|
1628
1638
|
*
|
|
1629
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1630
|
-
* @returns Function that retrieves a record by module name and ID
|
|
1639
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1640
|
+
* @returns Function that retrieves a record by module name and ID.
|
|
1641
|
+
*
|
|
1642
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
|
|
1631
1643
|
*
|
|
1632
1644
|
* @example
|
|
1633
1645
|
* ```typescript
|
|
@@ -1638,8 +1650,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1638
1650
|
* id: candidateId
|
|
1639
1651
|
* });
|
|
1640
1652
|
* ```
|
|
1641
|
-
*
|
|
1642
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
|
|
1643
1653
|
*/ function zohoRecruitGetRecordById(context) {
|
|
1644
1654
|
return function(input) {
|
|
1645
1655
|
return context.fetchJson("/v2/".concat(input.module, "/").concat(input.id), zohoRecruitApiFetchJsonInput('GET')).then(assertZohoRecruitRecordDataArrayResultHasContent(input.module)).then(function(x) {
|
|
@@ -1654,8 +1664,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1654
1664
|
* selection, sorting, custom view filtering, territory filtering, and
|
|
1655
1665
|
* conversion/approval status filters via {@link ZohoRecruitGetRecordsInput}.
|
|
1656
1666
|
*
|
|
1657
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1658
|
-
* @returns Function that retrieves paginated records from a module
|
|
1667
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1668
|
+
* @returns Function that retrieves paginated records from a module.
|
|
1669
|
+
*
|
|
1670
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
|
|
1659
1671
|
*
|
|
1660
1672
|
* @example
|
|
1661
1673
|
* ```typescript
|
|
@@ -1666,8 +1678,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1666
1678
|
* per_page: 10
|
|
1667
1679
|
* });
|
|
1668
1680
|
* ```
|
|
1669
|
-
*
|
|
1670
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-records.html
|
|
1671
1681
|
*/ function zohoRecruitGetRecords(context) {
|
|
1672
1682
|
return function(input) {
|
|
1673
1683
|
return context.fetchJson("/v2/".concat(input.module, "?").concat(zohoRecruitUrlSearchParamsMinusModule(input).toString()), zohoRecruitApiFetchJsonInput('GET'));
|
|
@@ -1681,9 +1691,11 @@ function _is_native_reflect_construct$3() {
|
|
|
1681
1691
|
* At least one search parameter must be provided. Returns a paginated result,
|
|
1682
1692
|
* defaulting to an empty data array when no matches are found.
|
|
1683
1693
|
*
|
|
1684
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1685
|
-
* @returns Function that searches records in the specified module
|
|
1686
|
-
* @throws {Error} If none of `criteria`, `email`, `phone`, or `word` are provided
|
|
1694
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1695
|
+
* @returns Function that searches records in the specified module.
|
|
1696
|
+
* @throws {Error} If none of `criteria`, `email`, `phone`, or `word` are provided.
|
|
1697
|
+
*
|
|
1698
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/search-records.html
|
|
1687
1699
|
*
|
|
1688
1700
|
* @example
|
|
1689
1701
|
* ```typescript
|
|
@@ -1702,8 +1714,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1702
1714
|
* word: 'engineer'
|
|
1703
1715
|
* });
|
|
1704
1716
|
* ```
|
|
1705
|
-
*
|
|
1706
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/search-records.html
|
|
1707
1717
|
*/ function zohoRecruitSearchRecords(context) {
|
|
1708
1718
|
function searchRecordsUrlSearchParams(input) {
|
|
1709
1719
|
var baseInput = _object_spread$n({}, input);
|
|
@@ -1735,8 +1745,8 @@ function _is_native_reflect_construct$3() {
|
|
|
1735
1745
|
* Returns a page factory that automatically handles Zoho Recruit's pagination,
|
|
1736
1746
|
* making it easy to iterate through all search results across multiple pages.
|
|
1737
1747
|
*
|
|
1738
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1739
|
-
* @returns Page factory for iterating over search results
|
|
1748
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1749
|
+
* @returns Page factory for iterating over search results.
|
|
1740
1750
|
*
|
|
1741
1751
|
* @example
|
|
1742
1752
|
* ```typescript
|
|
@@ -1751,6 +1761,7 @@ function _is_native_reflect_construct$3() {
|
|
|
1751
1761
|
* const firstPage = await fetchPage.fetchNext();
|
|
1752
1762
|
* const secondPage = await firstPage.fetchNext();
|
|
1753
1763
|
* ```
|
|
1764
|
+
*
|
|
1754
1765
|
* @__NO_SIDE_EFFECTS__
|
|
1755
1766
|
*/ function zohoRecruitSearchRecordsPageFactory(context) {
|
|
1756
1767
|
return zohoFetchPageFactory(zohoRecruitSearchRecords(context));
|
|
@@ -1764,8 +1775,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1764
1775
|
* target module and empty-result behavior. By default, returns an empty page
|
|
1765
1776
|
* result instead of null when no records are found.
|
|
1766
1777
|
*
|
|
1767
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1768
|
-
* @returns Factory that creates typed related-records retrieval functions
|
|
1778
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1779
|
+
* @returns Factory that creates typed related-records retrieval functions.
|
|
1780
|
+
*
|
|
1781
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1769
1782
|
*
|
|
1770
1783
|
* @example
|
|
1771
1784
|
* ```typescript
|
|
@@ -1782,7 +1795,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1782
1795
|
* });
|
|
1783
1796
|
* ```
|
|
1784
1797
|
*
|
|
1785
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1786
1798
|
* @__NO_SIDE_EFFECTS__
|
|
1787
1799
|
*/ function zohoRecruitGetRelatedRecordsFunctionFactory(context) {
|
|
1788
1800
|
return function(config) {
|
|
@@ -1803,8 +1815,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1803
1815
|
* {@link ZohoRecruitRecordEmailMetadata} entries. When no emails exist for the
|
|
1804
1816
|
* record, the result contains an empty data array rather than null.
|
|
1805
1817
|
*
|
|
1806
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1807
|
-
* @returns Function that retrieves emails for a record
|
|
1818
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1819
|
+
* @returns Function that retrieves emails for a record.
|
|
1820
|
+
*
|
|
1821
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1808
1822
|
*
|
|
1809
1823
|
* @example
|
|
1810
1824
|
* ```typescript
|
|
@@ -1815,8 +1829,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1815
1829
|
* module: ZOHO_RECRUIT_CANDIDATES_MODULE
|
|
1816
1830
|
* });
|
|
1817
1831
|
* ```
|
|
1818
|
-
*
|
|
1819
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1820
1832
|
*/ function zohoRecruitGetEmailsForRecord(context) {
|
|
1821
1833
|
return zohoRecruitGetRelatedRecordsFunctionFactory(context)({
|
|
1822
1834
|
targetModule: ZOHO_RECRUIT_EMAILS_MODULE
|
|
@@ -1829,8 +1841,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1829
1841
|
* multiple pages. Wraps {@link zohoRecruitGetEmailsForRecord} with automatic
|
|
1830
1842
|
* pagination handling via {@link zohoFetchPageFactory}.
|
|
1831
1843
|
*
|
|
1832
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1833
|
-
* @returns Page factory for iterating over record emails
|
|
1844
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1845
|
+
* @returns Page factory for iterating over record emails.
|
|
1846
|
+
*
|
|
1847
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1834
1848
|
*
|
|
1835
1849
|
* @example
|
|
1836
1850
|
* ```typescript
|
|
@@ -1849,7 +1863,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1849
1863
|
* }
|
|
1850
1864
|
* ```
|
|
1851
1865
|
*
|
|
1852
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1853
1866
|
* @__NO_SIDE_EFFECTS__
|
|
1854
1867
|
*/ function zohoRecruitGetEmailsForRecordPageFactory(context) {
|
|
1855
1868
|
return zohoFetchPageFactory(zohoRecruitGetEmailsForRecord(context));
|
|
@@ -1866,8 +1879,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1866
1879
|
* Each attachment entry includes a `$type` field that distinguishes between
|
|
1867
1880
|
* directly uploaded attachments (`'Attachment'`) and linked attachments.
|
|
1868
1881
|
*
|
|
1869
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1870
|
-
* @returns Function that retrieves attachments for a record
|
|
1882
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1883
|
+
* @returns Function that retrieves attachments for a record.
|
|
1884
|
+
*
|
|
1885
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1871
1886
|
*
|
|
1872
1887
|
* @example
|
|
1873
1888
|
* ```typescript
|
|
@@ -1881,8 +1896,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1881
1896
|
* // Filter to only directly uploaded attachments (downloadable):
|
|
1882
1897
|
* const downloadable = result.data.filter((x) => x.$type === 'Attachment');
|
|
1883
1898
|
* ```
|
|
1884
|
-
*
|
|
1885
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1886
1899
|
*/ function zohoRecruitGetAttachmentsForRecord(context) {
|
|
1887
1900
|
return zohoRecruitGetRelatedRecordsFunctionFactory(context)({
|
|
1888
1901
|
targetModule: ZOHO_RECRUIT_ATTACHMENTS_MODULE
|
|
@@ -1895,8 +1908,10 @@ function _is_native_reflect_construct$3() {
|
|
|
1895
1908
|
* across multiple pages. Wraps {@link zohoRecruitGetAttachmentsForRecord} with
|
|
1896
1909
|
* automatic pagination handling via {@link zohoFetchPageFactory}.
|
|
1897
1910
|
*
|
|
1898
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1899
|
-
* @returns Page factory for iterating over record attachments
|
|
1911
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1912
|
+
* @returns Page factory for iterating over record attachments.
|
|
1913
|
+
*
|
|
1914
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1900
1915
|
*
|
|
1901
1916
|
* @example
|
|
1902
1917
|
* ```typescript
|
|
@@ -1915,7 +1930,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1915
1930
|
* }
|
|
1916
1931
|
* ```
|
|
1917
1932
|
*
|
|
1918
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-related-records.html
|
|
1919
1933
|
* @__NO_SIDE_EFFECTS__
|
|
1920
1934
|
*/ function zohoRecruitGetAttachmentsForRecordPageFactory(context) {
|
|
1921
1935
|
return zohoFetchPageFactory(zohoRecruitGetAttachmentsForRecord(context));
|
|
@@ -1933,10 +1947,12 @@ function _is_native_reflect_construct$3() {
|
|
|
1933
1947
|
* will fetch the file. An attachment category must be specified by ID or name.
|
|
1934
1948
|
* Maximum file size is {@link ZOHO_RECRUIT_ATTACHMENT_MAX_SIZE} (20MB).
|
|
1935
1949
|
*
|
|
1936
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
1937
|
-
* @returns Function that uploads an attachment to a record
|
|
1938
|
-
* @throws {Error} If neither `file` nor `attachmentUrl` is provided
|
|
1939
|
-
* @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided
|
|
1950
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
1951
|
+
* @returns Function that uploads an attachment to a record.
|
|
1952
|
+
* @throws {Error} If neither `file` nor `attachmentUrl` is provided.
|
|
1953
|
+
* @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided.
|
|
1954
|
+
*
|
|
1955
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/upload-attachment.html
|
|
1940
1956
|
*
|
|
1941
1957
|
* @example
|
|
1942
1958
|
* ```typescript
|
|
@@ -1958,8 +1974,6 @@ function _is_native_reflect_construct$3() {
|
|
|
1958
1974
|
* attachmentCategoryName: 'Others'
|
|
1959
1975
|
* });
|
|
1960
1976
|
* ```
|
|
1961
|
-
*
|
|
1962
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/upload-attachment.html
|
|
1963
1977
|
*/ function zohoRecruitUploadAttachmentForRecord(context) {
|
|
1964
1978
|
return function(input) {
|
|
1965
1979
|
var _urlParams_attachments_category_id, _urlParams_attachments_category;
|
|
@@ -2004,8 +2018,10 @@ function _is_native_reflect_construct$3() {
|
|
|
2004
2018
|
* {@link FetchFileResponse} containing the file data and metadata extracted
|
|
2005
2019
|
* from the response headers.
|
|
2006
2020
|
*
|
|
2007
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2008
|
-
* @returns Function that downloads an attachment by record and attachment ID
|
|
2021
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2022
|
+
* @returns Function that downloads an attachment by record and attachment ID.
|
|
2023
|
+
*
|
|
2024
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/download-attachments.html
|
|
2009
2025
|
*
|
|
2010
2026
|
* @example
|
|
2011
2027
|
* ```typescript
|
|
@@ -2017,8 +2033,6 @@ function _is_native_reflect_construct$3() {
|
|
|
2017
2033
|
* attachment_id: attachmentId
|
|
2018
2034
|
* });
|
|
2019
2035
|
* ```
|
|
2020
|
-
*
|
|
2021
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/download-attachments.html
|
|
2022
2036
|
*/ function zohoRecruitDownloadAttachmentForRecord(context) {
|
|
2023
2037
|
return function(input) {
|
|
2024
2038
|
return context.fetch("/v2/".concat(input.module, "/").concat(input.id, "/").concat(ZOHO_RECRUIT_ATTACHMENTS_MODULE, "/").concat(input.attachment_id), {
|
|
@@ -2032,8 +2046,10 @@ function _is_native_reflect_construct$3() {
|
|
|
2032
2046
|
* Deletes a specific attachment from a record by its attachment ID.
|
|
2033
2047
|
* Returns the raw {@link Response}.
|
|
2034
2048
|
*
|
|
2035
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2036
|
-
* @returns Function that deletes an attachment by record and attachment ID
|
|
2049
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2050
|
+
* @returns Function that deletes an attachment by record and attachment ID.
|
|
2051
|
+
*
|
|
2052
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-attachments.html
|
|
2037
2053
|
*
|
|
2038
2054
|
* @example
|
|
2039
2055
|
* ```typescript
|
|
@@ -2045,8 +2061,6 @@ function _is_native_reflect_construct$3() {
|
|
|
2045
2061
|
* attachment_id: attachmentId
|
|
2046
2062
|
* });
|
|
2047
2063
|
* ```
|
|
2048
|
-
*
|
|
2049
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/delete-attachments.html
|
|
2050
2064
|
*/ function zohoRecruitDeleteAttachmentFromRecord(context) {
|
|
2051
2065
|
return function(input) {
|
|
2052
2066
|
return context.fetch("/v2/".concat(input.module, "/").concat(input.id, "/").concat(ZOHO_RECRUIT_ATTACHMENTS_MODULE, "/").concat(input.attachment_id), {
|
|
@@ -2079,9 +2093,9 @@ function _is_native_reflect_construct$3() {
|
|
|
2079
2093
|
* - There is no documentation for ZohoRecruit specifically, but it seems to behave the same way
|
|
2080
2094
|
* - You will need the following scopes: ZohoRecruit.functions.execute.READ,ZohoRecruit.functions.execute.CREATE
|
|
2081
2095
|
*
|
|
2082
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2083
|
-
* @returns Function that executes serverless functions via the REST API
|
|
2084
|
-
* @throws {ZohoRecruitExecuteRestApiFunctionError} If the function execution fails
|
|
2096
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2097
|
+
* @returns Function that executes serverless functions via the REST API.
|
|
2098
|
+
* @throws {ZohoRecruitExecuteRestApiFunctionError} If the function execution fails.
|
|
2085
2099
|
*
|
|
2086
2100
|
* @example
|
|
2087
2101
|
* ```typescript
|
|
@@ -2103,6 +2117,7 @@ function _is_native_reflect_construct$3() {
|
|
|
2103
2117
|
* apiUrl: 'production'
|
|
2104
2118
|
* });
|
|
2105
2119
|
* ```
|
|
2120
|
+
*
|
|
2106
2121
|
* @__NO_SIDE_EFFECTS__
|
|
2107
2122
|
*/ function zohoRecruitExecuteRestApiFunction(context) {
|
|
2108
2123
|
return function(input) {
|
|
@@ -2125,8 +2140,8 @@ function _is_native_reflect_construct$3() {
|
|
|
2125
2140
|
/**
|
|
2126
2141
|
* Builds URL search params from input objects, omitting the `module` key since it is used in the URL path rather than query string.
|
|
2127
2142
|
*
|
|
2128
|
-
* @param input - One or more objects whose key-value pairs become query parameters
|
|
2129
|
-
* @returns URLSearchParams with the `module` key excluded
|
|
2143
|
+
* @param input - One or more objects whose key-value pairs become query parameters.
|
|
2144
|
+
* @returns URLSearchParams with the `module` key excluded.
|
|
2130
2145
|
*/ function zohoRecruitUrlSearchParamsMinusModule() {
|
|
2131
2146
|
for(var _len = arguments.length, input = new Array(_len), _key = 0; _key < _len; _key++){
|
|
2132
2147
|
input[_key] = arguments[_key];
|
|
@@ -2138,8 +2153,8 @@ function _is_native_reflect_construct$3() {
|
|
|
2138
2153
|
/**
|
|
2139
2154
|
* Builds URL search params from input objects, omitting both `id` and `module` keys since they are used in the URL path.
|
|
2140
2155
|
*
|
|
2141
|
-
* @param input - One or more objects whose key-value pairs become query parameters
|
|
2142
|
-
* @returns URLSearchParams with `id` and `module` keys excluded
|
|
2156
|
+
* @param input - One or more objects whose key-value pairs become query parameters.
|
|
2157
|
+
* @returns URLSearchParams with `id` and `module` keys excluded.
|
|
2143
2158
|
*/ function zohoRecruitUrlSearchParamsMinusIdAndModule() {
|
|
2144
2159
|
for(var _len = arguments.length, input = new Array(_len), _key = 0; _key < _len; _key++){
|
|
2145
2160
|
input[_key] = arguments[_key];
|
|
@@ -2151,15 +2166,12 @@ function _is_native_reflect_construct$3() {
|
|
|
2151
2166
|
]
|
|
2152
2167
|
});
|
|
2153
2168
|
}
|
|
2154
|
-
/**
|
|
2155
|
-
* @deprecated use makeUrlSearchParams instead.
|
|
2156
|
-
*/ var zohoRecruitUrlSearchParams = makeUrlSearchParams;
|
|
2157
2169
|
/**
|
|
2158
2170
|
* Constructs a standard {@link FetchJsonInput} for Zoho Recruit API calls with the given HTTP method and optional body.
|
|
2159
2171
|
*
|
|
2160
|
-
* @param method - HTTP method for the request
|
|
2161
|
-
* @param body - Optional JSON body to include in the request
|
|
2162
|
-
* @returns Configured fetch JSON input
|
|
2172
|
+
* @param method - HTTP method for the request.
|
|
2173
|
+
* @param body - Optional JSON body to include in the request.
|
|
2174
|
+
* @returns Configured fetch JSON input.
|
|
2163
2175
|
*/ function zohoRecruitApiFetchJsonInput(method, body) {
|
|
2164
2176
|
return {
|
|
2165
2177
|
method: method,
|
|
@@ -2176,8 +2188,8 @@ function _is_native_reflect_construct$3() {
|
|
|
2176
2188
|
* Used internally by {@link zohoRecruitDeleteRecord} and similar functions to provide
|
|
2177
2189
|
* convenient access to separated success/error results.
|
|
2178
2190
|
*
|
|
2179
|
-
* @param response - Raw change operation response containing mixed success/error entries
|
|
2180
|
-
* @returns The response augmented with pre-separated `successItems` and `errorItems` arrays
|
|
2191
|
+
* @param response - Raw change operation response containing mixed success/error entries.
|
|
2192
|
+
* @returns The response augmented with pre-separated `successItems` and `errorItems` arrays.
|
|
2181
2193
|
*
|
|
2182
2194
|
* @example
|
|
2183
2195
|
* ```typescript
|
|
@@ -2214,9 +2226,9 @@ function _is_native_reflect_construct$3() {
|
|
|
2214
2226
|
* Used internally by {@link updateRecordLikeFunction} to pair input data with API outcomes
|
|
2215
2227
|
* for insert, update, and upsert operations.
|
|
2216
2228
|
*
|
|
2217
|
-
* @param input - Array of input records that were submitted to the API
|
|
2229
|
+
* @param input - Array of input records that were submitted to the API.
|
|
2218
2230
|
* @param results - Array of per-record results returned by the API, positionally aligned with `input`
|
|
2219
|
-
* @returns Object with `successItems` and `errorItems`, each containing paired `{ input, result }` entries
|
|
2231
|
+
* @returns Object with `successItems` and `errorItems`, each containing paired `{ input, result }` entries.
|
|
2220
2232
|
*/ function zohoRecruitMultiRecordResult(input, results) {
|
|
2221
2233
|
var successItems = [];
|
|
2222
2234
|
var errorItems = [];
|
|
@@ -2240,6 +2252,11 @@ function _is_native_reflect_construct$3() {
|
|
|
2240
2252
|
};
|
|
2241
2253
|
return result;
|
|
2242
2254
|
}
|
|
2255
|
+
// MARK: Compat
|
|
2256
|
+
// COMPAT: Deprecated aliases
|
|
2257
|
+
/**
|
|
2258
|
+
* @deprecated use makeUrlSearchParams instead.
|
|
2259
|
+
*/ var zohoRecruitUrlSearchParams = makeUrlSearchParams;
|
|
2243
2260
|
/**
|
|
2244
2261
|
* @deprecated Use zohoRecruitInsertRecord instead.
|
|
2245
2262
|
*/ var insertRecord = zohoRecruitInsertRecord;
|
|
@@ -2344,10 +2361,10 @@ function _object_spread_props$l(target, source) {
|
|
|
2344
2361
|
*
|
|
2345
2362
|
* The result separates "already associated" errors from other errors, allowing callers to treat duplicate associations as non-fatal.
|
|
2346
2363
|
*
|
|
2347
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2364
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2348
2365
|
* @returns Factory function that associates candidates with job openings
|
|
2349
2366
|
*
|
|
2350
|
-
* https://www.zoho.com/recruit/developer-guide/apiv2/associate-candidate.html
|
|
2367
|
+
* https://www.zoho.com/recruit/developer-guide/apiv2/associate-candidate.html.
|
|
2351
2368
|
*/ function zohoRecruitAssociateCandidateRecordsWithJobOpenings(context) {
|
|
2352
2369
|
return function(input) {
|
|
2353
2370
|
return context.fetchJson("/v2/".concat(ZOHO_RECRUIT_CANDIDATES_MODULE, "/actions/associate"), zohoRecruitApiFetchJsonInput('PUT', {
|
|
@@ -2371,8 +2388,8 @@ function _object_spread_props$l(target, source) {
|
|
|
2371
2388
|
/**
|
|
2372
2389
|
* Searches for records associated with a given candidate or job opening. Returns an empty page result when no records are found.
|
|
2373
2390
|
*
|
|
2374
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2375
|
-
* @returns Factory function that searches for associated records
|
|
2391
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2392
|
+
* @returns Factory function that searches for associated records.
|
|
2376
2393
|
*/ function zohoRecruitSearchAssociatedRecords(context) {
|
|
2377
2394
|
return function(input) {
|
|
2378
2395
|
return context.fetchJson("/v2/".concat(input.module, "/").concat(input.id, "/associate?").concat(zohoRecruitUrlSearchParamsMinusIdAndModule(input).toString()), zohoRecruitApiFetchJsonInput('GET')).then(function(x) {
|
|
@@ -2384,8 +2401,8 @@ function _object_spread_props$l(target, source) {
|
|
|
2384
2401
|
/**
|
|
2385
2402
|
* Searches for job openings associated with a specific candidate.
|
|
2386
2403
|
*
|
|
2387
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2388
|
-
* @returns Factory function that searches for job openings associated with a candidate
|
|
2404
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2405
|
+
* @returns Factory function that searches for job openings associated with a candidate.
|
|
2389
2406
|
*/ function zohoRecruitSearchCandidateAssociatedJobOpeningRecords(context) {
|
|
2390
2407
|
var searchAssociatedRecordsFactory = zohoRecruitSearchAssociatedRecords(context);
|
|
2391
2408
|
return function(input) {
|
|
@@ -2397,8 +2414,9 @@ function _object_spread_props$l(target, source) {
|
|
|
2397
2414
|
/**
|
|
2398
2415
|
* Creates a page factory for paginating over job openings associated with a candidate.
|
|
2399
2416
|
*
|
|
2400
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2401
|
-
* @returns Page factory for iterating through associated job openings
|
|
2417
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2418
|
+
* @returns Page factory for iterating through associated job openings.
|
|
2419
|
+
*
|
|
2402
2420
|
* @__NO_SIDE_EFFECTS__
|
|
2403
2421
|
*/ function zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory(context) {
|
|
2404
2422
|
return zohoFetchPageFactory(zohoRecruitSearchCandidateAssociatedJobOpeningRecords(context));
|
|
@@ -2406,9 +2424,9 @@ function _object_spread_props$l(target, source) {
|
|
|
2406
2424
|
/**
|
|
2407
2425
|
* Searches for candidates associated with a specific job opening.
|
|
2408
2426
|
*
|
|
2409
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2410
|
-
* @param jobOpeningModuleName - Module name for job openings, defaults to the standard module
|
|
2411
|
-
* @returns Factory function that searches for candidates associated with a job opening
|
|
2427
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2428
|
+
* @param jobOpeningModuleName - Module name for job openings, defaults to the standard module.
|
|
2429
|
+
* @returns Factory function that searches for candidates associated with a job opening.
|
|
2412
2430
|
*/ function zohoRecruitSearchJobOpeningAssociatedCandidateRecords(context) {
|
|
2413
2431
|
var jobOpeningModuleName = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : ZOHO_RECRUIT_JOB_OPENINGS_MODULE;
|
|
2414
2432
|
var searchAssociatedRecordsFactory = zohoRecruitSearchAssociatedRecords(context);
|
|
@@ -2421,8 +2439,9 @@ function _object_spread_props$l(target, source) {
|
|
|
2421
2439
|
/**
|
|
2422
2440
|
* Creates a page factory for paginating over candidates associated with a job opening.
|
|
2423
2441
|
*
|
|
2424
|
-
* @param context - Zoho Recruit API context providing fetch and authentication
|
|
2425
|
-
* @returns Page factory for iterating through associated candidates
|
|
2442
|
+
* @param context - Zoho Recruit API context providing fetch and authentication.
|
|
2443
|
+
* @returns Page factory for iterating through associated candidates.
|
|
2444
|
+
*
|
|
2426
2445
|
* @__NO_SIDE_EFFECTS__
|
|
2427
2446
|
*/ function zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory(context) {
|
|
2428
2447
|
return zohoFetchPageFactory(zohoRecruitSearchJobOpeningAssociatedCandidateRecords(context));
|
|
@@ -2484,8 +2503,8 @@ function _object_spread_props$k(target, source) {
|
|
|
2484
2503
|
* Prefer {@link zohoRecruitCreateNotesForRecord} when creating notes linked to a specific
|
|
2485
2504
|
* record, as it handles the module/parent linking automatically.
|
|
2486
2505
|
*
|
|
2487
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2488
|
-
* @returns Function that creates notes in the Notes module
|
|
2506
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2507
|
+
* @returns Function that creates notes in the Notes module.
|
|
2489
2508
|
*
|
|
2490
2509
|
* @example
|
|
2491
2510
|
* ```typescript
|
|
@@ -2515,8 +2534,8 @@ function _object_spread_props$k(target, source) {
|
|
|
2515
2534
|
* Deletes one or more notes by their IDs from the Notes module. Returns a paired
|
|
2516
2535
|
* success/error result for each note ID.
|
|
2517
2536
|
*
|
|
2518
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2519
|
-
* @returns Function that deletes notes by ID
|
|
2537
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2538
|
+
* @returns Function that deletes notes by ID.
|
|
2520
2539
|
*
|
|
2521
2540
|
* @example
|
|
2522
2541
|
* ```typescript
|
|
@@ -2539,8 +2558,8 @@ function _object_spread_props$k(target, source) {
|
|
|
2539
2558
|
* Retrieves notes related to a specific record by targeting the Notes module
|
|
2540
2559
|
* via the related records API. Returns an empty page result when no notes exist.
|
|
2541
2560
|
*
|
|
2542
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2543
|
-
* @returns Function that retrieves notes for a record
|
|
2561
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2562
|
+
* @returns Function that retrieves notes for a record.
|
|
2544
2563
|
*
|
|
2545
2564
|
* @example
|
|
2546
2565
|
* ```typescript
|
|
@@ -2563,8 +2582,9 @@ function _object_spread_props$k(target, source) {
|
|
|
2563
2582
|
* multiple pages. Wraps {@link zohoRecruitGetNotesForRecord} with automatic
|
|
2564
2583
|
* pagination handling via {@link zohoFetchPageFactory}.
|
|
2565
2584
|
*
|
|
2566
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2567
|
-
* @returns Page factory for iterating over record notes
|
|
2585
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2586
|
+
* @returns Page factory for iterating over record notes.
|
|
2587
|
+
*
|
|
2568
2588
|
* @__NO_SIDE_EFFECTS__
|
|
2569
2589
|
*/ function zohoRecruitGetNotesForRecordPageFactory(context) {
|
|
2570
2590
|
return zohoFetchPageFactory(zohoRecruitGetNotesForRecord(context));
|
|
@@ -2576,8 +2596,8 @@ function _object_spread_props$k(target, source) {
|
|
|
2576
2596
|
* `se_module` and `Parent_Id` on each note entry from the request's `module` and `id`,
|
|
2577
2597
|
* then delegates to {@link zohoRecruitCreateNotes}.
|
|
2578
2598
|
*
|
|
2579
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2580
|
-
* @returns Function that creates notes linked to a specific record
|
|
2599
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2600
|
+
* @returns Function that creates notes linked to a specific record.
|
|
2581
2601
|
*
|
|
2582
2602
|
* @example
|
|
2583
2603
|
* ```typescript
|
|
@@ -2608,6 +2628,7 @@ function _object_spread_props$k(target, source) {
|
|
|
2608
2628
|
};
|
|
2609
2629
|
}
|
|
2610
2630
|
// MARK: Compat
|
|
2631
|
+
// COMPAT: Deprecated aliases
|
|
2611
2632
|
/**
|
|
2612
2633
|
* @deprecated Use zohoRecruitCreateNotes instead.
|
|
2613
2634
|
*/ var createNotes = zohoRecruitCreateNotes;
|
|
@@ -2678,8 +2699,8 @@ function _object_spread_props$j(target, source) {
|
|
|
2678
2699
|
* (which are often non-fatal) from other errors, making it easy to handle the common
|
|
2679
2700
|
* case where a tag already exists.
|
|
2680
2701
|
*
|
|
2681
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2682
|
-
* @returns Function that creates tags in the specified module
|
|
2702
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2703
|
+
* @returns Function that creates tags in the specified module.
|
|
2683
2704
|
*
|
|
2684
2705
|
* @example
|
|
2685
2706
|
* ```typescript
|
|
@@ -2719,8 +2740,10 @@ function _object_spread_props$j(target, source) {
|
|
|
2719
2740
|
* Returns the list of tags within a module. Normalizes the non-standard API response
|
|
2720
2741
|
* that returns data under a `tags` key instead of the standard `data` key.
|
|
2721
2742
|
*
|
|
2722
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2723
|
-
* @returns Function that retrieves tags for a module
|
|
2743
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2744
|
+
* @returns Function that retrieves tags for a module.
|
|
2745
|
+
*
|
|
2746
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-tag-list.html
|
|
2724
2747
|
*
|
|
2725
2748
|
* @example
|
|
2726
2749
|
* ```typescript
|
|
@@ -2730,8 +2753,6 @@ function _object_spread_props$j(target, source) {
|
|
|
2730
2753
|
* module: ZOHO_RECRUIT_CANDIDATES_MODULE
|
|
2731
2754
|
* });
|
|
2732
2755
|
* ```
|
|
2733
|
-
*
|
|
2734
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/get-tag-list.html
|
|
2735
2756
|
*/ function zohoRecruitGetTagsForModule(context) {
|
|
2736
2757
|
return function(input) {
|
|
2737
2758
|
return context.fetchJson("/v2/settings/tags?".concat(makeUrlSearchParams({
|
|
@@ -2751,8 +2772,9 @@ function _object_spread_props$j(target, source) {
|
|
|
2751
2772
|
* Returns a page factory for iterating over tags in a module across multiple pages.
|
|
2752
2773
|
* Wraps {@link zohoRecruitGetTagsForModule} with automatic pagination handling.
|
|
2753
2774
|
*
|
|
2754
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2755
|
-
* @returns Page factory for iterating over module tags
|
|
2775
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2776
|
+
* @returns Page factory for iterating over module tags.
|
|
2777
|
+
*
|
|
2756
2778
|
* @__NO_SIDE_EFFECTS__
|
|
2757
2779
|
*/ function zohoRecruitGetTagsForModulePageFactory(context) {
|
|
2758
2780
|
return zohoFetchPageFactory(zohoRecruitGetTagsForModule(context));
|
|
@@ -2767,9 +2789,11 @@ function _object_spread_props$j(target, source) {
|
|
|
2767
2789
|
* Adds one or more tags to one or more records. Returns a paired success/error result
|
|
2768
2790
|
* for each record. Maximum of {@link ZOHO_RECRUIT_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED} (100) record IDs per call.
|
|
2769
2791
|
*
|
|
2770
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2771
|
-
* @returns Function that adds tags to records
|
|
2772
|
-
* @throws {Error} If more than 100 record IDs are provided
|
|
2792
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2793
|
+
* @returns Function that adds tags to records.
|
|
2794
|
+
* @throws {Error} If more than 100 record IDs are provided.
|
|
2795
|
+
*
|
|
2796
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/add-tags.html
|
|
2773
2797
|
*
|
|
2774
2798
|
* @example
|
|
2775
2799
|
* ```typescript
|
|
@@ -2781,8 +2805,6 @@ function _object_spread_props$j(target, source) {
|
|
|
2781
2805
|
* ids: [candidateId1, candidateId2]
|
|
2782
2806
|
* });
|
|
2783
2807
|
* ```
|
|
2784
|
-
*
|
|
2785
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/add-tags.html
|
|
2786
2808
|
*/ function zohoRecruitAddTagsToRecords(context) {
|
|
2787
2809
|
return function(input) {
|
|
2788
2810
|
if (Array.isArray(input.ids) && input.ids.length > ZOHO_RECRUIT_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED) {
|
|
@@ -2809,9 +2831,11 @@ function _object_spread_props$j(target, source) {
|
|
|
2809
2831
|
* Removes one or more tags from one or more records. Returns a paired success/error result
|
|
2810
2832
|
* for each record. Maximum of {@link ZOHO_RECRUIT_REMOVE_TAGS_FROM_RECORDS_MAX_IDS_ALLOWED} (100) record IDs per call.
|
|
2811
2833
|
*
|
|
2812
|
-
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting
|
|
2813
|
-
* @returns Function that removes tags from records
|
|
2814
|
-
* @throws {Error} If more than 100 record IDs are provided
|
|
2834
|
+
* @param context - Authenticated Zoho Recruit context providing fetch and rate limiting.
|
|
2835
|
+
* @returns Function that removes tags from records.
|
|
2836
|
+
* @throws {Error} If more than 100 record IDs are provided.
|
|
2837
|
+
*
|
|
2838
|
+
* @see https://www.zoho.com/recruit/developer-guide/apiv2/remove-tags.html
|
|
2815
2839
|
*
|
|
2816
2840
|
* @example
|
|
2817
2841
|
* ```typescript
|
|
@@ -2823,8 +2847,6 @@ function _object_spread_props$j(target, source) {
|
|
|
2823
2847
|
* ids: candidateId
|
|
2824
2848
|
* });
|
|
2825
2849
|
* ```
|
|
2826
|
-
*
|
|
2827
|
-
* @see https://www.zoho.com/recruit/developer-guide/apiv2/remove-tags.html
|
|
2828
2850
|
*/ function zohoRecruitRemoveTagsFromRecords(context) {
|
|
2829
2851
|
return function(input) {
|
|
2830
2852
|
if (Array.isArray(input.ids) && input.ids.length > ZOHO_RECRUIT_REMOVE_TAGS_FROM_RECORDS_MAX_IDS_ALLOWED) {
|
|
@@ -2842,6 +2864,7 @@ function _object_spread_props$j(target, source) {
|
|
|
2842
2864
|
};
|
|
2843
2865
|
}
|
|
2844
2866
|
// MARK: Compat
|
|
2867
|
+
// COMPAT: Deprecated aliases
|
|
2845
2868
|
/**
|
|
2846
2869
|
* @deprecated Use zohoRecruitCreateTagsForModule instead.
|
|
2847
2870
|
*/ var createTagsForModule = zohoRecruitCreateTagsForModule;
|
|
@@ -3097,8 +3120,8 @@ var logZohoAccountsErrorToConsole = logZohoServerErrorFunction('ZohoAccounts');
|
|
|
3097
3120
|
/**
|
|
3098
3121
|
* Parses a fetch response error into a typed Zoho Accounts server error by extracting and interpreting the JSON error body.
|
|
3099
3122
|
*
|
|
3100
|
-
* @param responseError - The fetch response error to parse
|
|
3101
|
-
* @returns The parsed Zoho server error, or undefined if the response could not be parsed
|
|
3123
|
+
* @param responseError - The fetch response error to parse.
|
|
3124
|
+
* @returns The parsed Zoho server error, or undefined if the response could not be parsed.
|
|
3102
3125
|
*/ function parseZohoAccountsError(responseError) {
|
|
3103
3126
|
return _async_to_generator$9(function() {
|
|
3104
3127
|
var data, result;
|
|
@@ -3127,9 +3150,9 @@ var logZohoAccountsErrorToConsole = logZohoServerErrorFunction('ZohoAccounts');
|
|
|
3127
3150
|
/**
|
|
3128
3151
|
* 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.
|
|
3129
3152
|
*
|
|
3130
|
-
* @param errorResponseData - The raw error response data from the Zoho Accounts API
|
|
3131
|
-
* @param responseError - The original fetch response error for context
|
|
3132
|
-
* @returns The parsed Zoho server error, or undefined if the error could not be classified
|
|
3153
|
+
* @param errorResponseData - The raw error response data from the Zoho Accounts API.
|
|
3154
|
+
* @param responseError - The original fetch response error for context.
|
|
3155
|
+
* @returns The parsed Zoho server error, or undefined if the error could not be classified.
|
|
3133
3156
|
*/ function parseZohoAccountsServerErrorResponseData(errorResponseData, responseError) {
|
|
3134
3157
|
var result;
|
|
3135
3158
|
var error = errorResponseData.error;
|
|
@@ -3281,8 +3304,9 @@ function _ts_generator$8(thisArg, body) {
|
|
|
3281
3304
|
/**
|
|
3282
3305
|
* Generates a new ZohoAccessTokenStringFactory.
|
|
3283
3306
|
*
|
|
3284
|
-
* @param zohoAccessTokenFactory - Factory that produces ZohoAccessToken instances
|
|
3285
|
-
* @returns A factory function that resolves to the access token string
|
|
3307
|
+
* @param zohoAccessTokenFactory - Factory that produces ZohoAccessToken instances.
|
|
3308
|
+
* @returns A factory function that resolves to the access token string.
|
|
3309
|
+
*
|
|
3286
3310
|
* @__NO_SIDE_EFFECTS__
|
|
3287
3311
|
*/ function zohoAccessTokenStringFactory(zohoAccessTokenFactory) {
|
|
3288
3312
|
return function() {
|
|
@@ -3360,7 +3384,7 @@ function _object_spread_props$i(target, source) {
|
|
|
3360
3384
|
/**
|
|
3361
3385
|
* Default handler that logs a warning to the console when the Zoho API rate limit is exceeded.
|
|
3362
3386
|
*
|
|
3363
|
-
* @param details - Rate limit details extracted from the Zoho API response headers
|
|
3387
|
+
* @param details - Rate limit details extracted from the Zoho API response headers.
|
|
3364
3388
|
*/ var DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION = function DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION(details) {
|
|
3365
3389
|
var limit = 'limit' in details ? details.limit : undefined;
|
|
3366
3390
|
var resetAt = 'resetAt' in details ? details.resetAt : undefined;
|
|
@@ -3380,8 +3404,9 @@ function _object_spread_props$i(target, source) {
|
|
|
3380
3404
|
* - On 429 responses, the request is automatically retried after the rate limiter delay
|
|
3381
3405
|
* - The limiter is disabled when responses lack rate limit headers (e.g., error responses)
|
|
3382
3406
|
*
|
|
3383
|
-
* @param config - Configuration including the service-specific header reader, rate limit, reset period, and 429 handling
|
|
3407
|
+
* @param config - Configuration including the service-specific header reader, rate limit, reset period, and 429 handling.
|
|
3384
3408
|
* @returns A rate-limited fetch handler with the underlying rate limiter accessible via `_rateLimiter`
|
|
3409
|
+
*
|
|
3385
3410
|
* @__NO_SIDE_EFFECTS__
|
|
3386
3411
|
*/ function makeZohoRateLimitedFetchHandler(config) {
|
|
3387
3412
|
var _config_onTooManyRequests, _config_maxRateLimit, _config_resetPeriod;
|
|
@@ -3394,9 +3419,9 @@ function _object_spread_props$i(target, source) {
|
|
|
3394
3419
|
* Called once at initialization with `defaultLimit`, and again dynamically
|
|
3395
3420
|
* when the API's response headers report a different limit value.
|
|
3396
3421
|
*
|
|
3397
|
-
* @param limit - Maximum number of requests allowed per reset period
|
|
3398
|
-
* @param resetAt - Optional date when the rate limit window resets
|
|
3399
|
-
* @returns Rate limiter configuration scaled to the given limit
|
|
3422
|
+
* @param limit - Maximum number of requests allowed per reset period.
|
|
3423
|
+
* @param resetAt - Optional date when the rate limit window resets.
|
|
3424
|
+
* @returns Rate limiter configuration scaled to the given limit.
|
|
3400
3425
|
*/ function configForLimit(limit, resetAt) {
|
|
3401
3426
|
return {
|
|
3402
3427
|
limit: limit,
|
|
@@ -3456,7 +3481,7 @@ function _object_spread_props$i(target, source) {
|
|
|
3456
3481
|
* This is a convenience wrapper around {@link makeZohoRateLimitedFetchHandler} pre-configured
|
|
3457
3482
|
* with the standard Zoho rate limit header reader.
|
|
3458
3483
|
*
|
|
3459
|
-
* @param config - Optional configuration for rate limit, reset period, and 429 handling
|
|
3484
|
+
* @param config - Optional configuration for rate limit, reset period, and 429 handling.
|
|
3460
3485
|
* @returns A rate-limited fetch handler with the underlying rate limiter accessible via `_rateLimiter`
|
|
3461
3486
|
*/ function zohoRateLimitedFetchHandler(config) {
|
|
3462
3487
|
return makeZohoRateLimitedFetchHandler(_object_spread_props$i(_object_spread$j({}, config), {
|
|
@@ -3467,8 +3492,8 @@ function _object_spread_props$i(target, source) {
|
|
|
3467
3492
|
* Reads rate limit details from standard Zoho API response headers (`X-RATELIMIT-*`).
|
|
3468
3493
|
* Used by CRM, Recruit, and Sign services.
|
|
3469
3494
|
*
|
|
3470
|
-
* @param headers - HTTP response headers
|
|
3471
|
-
* @returns Parsed rate limit details, or null if headers are absent
|
|
3495
|
+
* @param headers - HTTP response headers.
|
|
3496
|
+
* @returns Parsed rate limit details, or null if headers are absent.
|
|
3472
3497
|
*/ function zohoStandardRateLimitDetailsReader(headers) {
|
|
3473
3498
|
var details = zohoRateLimitHeaderDetails(headers);
|
|
3474
3499
|
var result;
|
|
@@ -3482,6 +3507,7 @@ function _object_spread_props$i(target, source) {
|
|
|
3482
3507
|
return result;
|
|
3483
3508
|
}
|
|
3484
3509
|
// MARK: Compat
|
|
3510
|
+
// COMPAT: Deprecated aliases
|
|
3485
3511
|
/**
|
|
3486
3512
|
* @deprecated use DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION instead.
|
|
3487
3513
|
*/ var DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION = DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION;
|
|
@@ -3677,8 +3703,8 @@ function _ts_generator$7(thisArg, body) {
|
|
|
3677
3703
|
* Each client handles OAuth token refresh on {@link ZohoInvalidTokenError}, rate limiting,
|
|
3678
3704
|
* and Zoho Recruit's non-standard error responses (200 status with error body).
|
|
3679
3705
|
*
|
|
3680
|
-
* @param factoryConfig - Configuration providing account credentials and optional overrides
|
|
3681
|
-
* @returns A factory function that creates authenticated Zoho Recruit clients
|
|
3706
|
+
* @param factoryConfig - Configuration providing account credentials and optional overrides.
|
|
3707
|
+
* @returns A factory function that creates authenticated Zoho Recruit clients.
|
|
3682
3708
|
*
|
|
3683
3709
|
* @example
|
|
3684
3710
|
* ```typescript
|
|
@@ -3693,6 +3719,7 @@ function _ts_generator$7(thisArg, body) {
|
|
|
3693
3719
|
* // Use the recruit context for API calls:
|
|
3694
3720
|
* const { recruitContext } = zohoRecruit;
|
|
3695
3721
|
* ```
|
|
3722
|
+
*
|
|
3696
3723
|
* @__NO_SIDE_EFFECTS__
|
|
3697
3724
|
*/ function zohoRecruitFactory(factoryConfig) {
|
|
3698
3725
|
var accountsContext = factoryConfig.accountsContext;
|
|
@@ -3776,17 +3803,22 @@ function _ts_generator$7(thisArg, body) {
|
|
|
3776
3803
|
/**
|
|
3777
3804
|
* 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.
|
|
3778
3805
|
*
|
|
3779
|
-
* @param input - A well-known environment key or a custom CRM API URL
|
|
3780
|
-
* @returns The resolved full Zoho CRM API base URL
|
|
3806
|
+
* @param input - A well-known environment key or a custom CRM API URL.
|
|
3807
|
+
* @returns The resolved full Zoho CRM API base URL.
|
|
3781
3808
|
*/ function zohoCrmConfigApiUrl(input) {
|
|
3809
|
+
var result;
|
|
3782
3810
|
switch(input){
|
|
3783
3811
|
case 'sandbox':
|
|
3784
|
-
|
|
3812
|
+
result = 'https://crmsandbox.zoho.com/crm';
|
|
3813
|
+
break;
|
|
3785
3814
|
case 'production':
|
|
3786
|
-
|
|
3815
|
+
result = 'https://www.zohoapis.com/crm';
|
|
3816
|
+
break;
|
|
3787
3817
|
default:
|
|
3788
|
-
|
|
3818
|
+
result = input;
|
|
3819
|
+
break;
|
|
3789
3820
|
}
|
|
3821
|
+
return result;
|
|
3790
3822
|
}
|
|
3791
3823
|
|
|
3792
3824
|
/**
|
|
@@ -4140,8 +4172,8 @@ function _ts_generator$6(thisArg, body) {
|
|
|
4140
4172
|
/**
|
|
4141
4173
|
* Maps a Zoho CRM server error to the appropriate typed {@link ZohoCrmRecordCrudError} subclass based on the error code and affected field.
|
|
4142
4174
|
*
|
|
4143
|
-
* @param error - The server error data containing the error code and field details
|
|
4144
|
-
* @returns The appropriate typed CRM CRUD error instance
|
|
4175
|
+
* @param error - The server error data containing the error code and field details.
|
|
4176
|
+
* @returns The appropriate typed CRM CRUD error instance.
|
|
4145
4177
|
*/ function zohoCrmRecordCrudError(error) {
|
|
4146
4178
|
var result;
|
|
4147
4179
|
switch(error.code){
|
|
@@ -4170,9 +4202,9 @@ function _ts_generator$6(thisArg, body) {
|
|
|
4170
4202
|
/**
|
|
4171
4203
|
* Returns an assertion function that throws {@link ZohoCrmRecordNoContentError} when a data array result is empty or null, typically indicating a missing record.
|
|
4172
4204
|
*
|
|
4173
|
-
* @param moduleName - Optional CRM module name for the error context
|
|
4174
|
-
* @param recordId - Optional record ID for the error context
|
|
4175
|
-
* @returns Assertion function that throws if the data array is empty
|
|
4205
|
+
* @param moduleName - Optional CRM module name for the error context.
|
|
4206
|
+
* @param recordId - Optional record ID for the error context.
|
|
4207
|
+
* @returns Assertion function that throws if the data array is empty.
|
|
4176
4208
|
*/ function assertZohoCrmRecordDataArrayResultHasContent(moduleName, recordId) {
|
|
4177
4209
|
return function(x) {
|
|
4178
4210
|
var _x_data;
|
|
@@ -4190,8 +4222,8 @@ function _ts_generator$6(thisArg, body) {
|
|
|
4190
4222
|
/**
|
|
4191
4223
|
* Parses a fetch response error into a typed Zoho CRM server error by extracting and interpreting the JSON error body.
|
|
4192
4224
|
*
|
|
4193
|
-
* @param responseError - The fetch response error to parse
|
|
4194
|
-
* @returns The parsed Zoho server error, or undefined if the response could not be parsed
|
|
4225
|
+
* @param responseError - The fetch response error to parse.
|
|
4226
|
+
* @returns The parsed Zoho server error, or undefined if the response could not be parsed.
|
|
4195
4227
|
*/ function parseZohoCrmError(responseError) {
|
|
4196
4228
|
return _async_to_generator$6(function() {
|
|
4197
4229
|
var data, result;
|
|
@@ -4220,9 +4252,9 @@ function _ts_generator$6(thisArg, body) {
|
|
|
4220
4252
|
/**
|
|
4221
4253
|
* 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.
|
|
4222
4254
|
*
|
|
4223
|
-
* @param errorResponseData - The raw error response data from the Zoho CRM API
|
|
4224
|
-
* @param responseError - The original fetch response error for context
|
|
4225
|
-
* @returns The parsed Zoho server error, or undefined if the error could not be classified
|
|
4255
|
+
* @param errorResponseData - The raw error response data from the Zoho CRM API.
|
|
4256
|
+
* @param responseError - The original fetch response error for context.
|
|
4257
|
+
* @returns The parsed Zoho server error, or undefined if the error could not be classified.
|
|
4226
4258
|
*/ function parseZohoCrmServerErrorResponseData(errorResponseData, responseError) {
|
|
4227
4259
|
var result;
|
|
4228
4260
|
var error = tryFindZohoServerErrorData(errorResponseData, responseError);
|
|
@@ -4370,10 +4402,10 @@ function _is_native_reflect_construct() {
|
|
|
4370
4402
|
* When a single record is provided, the function returns the change details directly or throws on error.
|
|
4371
4403
|
* When multiple records are provided, it returns a paired success/error result.
|
|
4372
4404
|
*
|
|
4373
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
4405
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
4374
4406
|
* @param fetchUrlPrefix - URL path segment appended after the module name (empty string for insert/update, '/upsert' for upsert)
|
|
4375
4407
|
* @param fetchMethod - HTTP method to use for the request (POST for insert/upsert, PUT for update)
|
|
4376
|
-
* @returns Overloaded function handling both single and multi-record operations
|
|
4408
|
+
* @returns Overloaded function handling both single and multi-record operations.
|
|
4377
4409
|
*/ function updateRecordLikeFunction(context, fetchUrlPrefix, fetchMethod) {
|
|
4378
4410
|
return function(param) {
|
|
4379
4411
|
var data = param.data, module = param.module;
|
|
@@ -4406,8 +4438,10 @@ function _is_native_reflect_construct() {
|
|
|
4406
4438
|
*
|
|
4407
4439
|
* Maximum of {@link ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
4408
4440
|
*
|
|
4409
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4410
|
-
* @returns Function that inserts records into the specified module
|
|
4441
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4442
|
+
* @returns Function that inserts records into the specified module.
|
|
4443
|
+
*
|
|
4444
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/insert-records.html
|
|
4411
4445
|
*
|
|
4412
4446
|
* @example
|
|
4413
4447
|
* ```typescript
|
|
@@ -4428,8 +4462,6 @@ function _is_native_reflect_construct() {
|
|
|
4428
4462
|
* ]
|
|
4429
4463
|
* });
|
|
4430
4464
|
* ```
|
|
4431
|
-
*
|
|
4432
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/insert-records.html
|
|
4433
4465
|
*/ function zohoCrmInsertRecord(context) {
|
|
4434
4466
|
return updateRecordLikeFunction(context, '', 'POST');
|
|
4435
4467
|
}
|
|
@@ -4443,8 +4475,10 @@ function _is_native_reflect_construct() {
|
|
|
4443
4475
|
*
|
|
4444
4476
|
* Maximum of {@link ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
4445
4477
|
*
|
|
4446
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4447
|
-
* @returns Function that upserts records in the specified module
|
|
4478
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4479
|
+
* @returns Function that upserts records in the specified module.
|
|
4480
|
+
*
|
|
4481
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/upsert-records.html
|
|
4448
4482
|
*
|
|
4449
4483
|
* @example
|
|
4450
4484
|
* ```typescript
|
|
@@ -4471,8 +4505,6 @@ function _is_native_reflect_construct() {
|
|
|
4471
4505
|
* ]
|
|
4472
4506
|
* });
|
|
4473
4507
|
* ```
|
|
4474
|
-
*
|
|
4475
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/upsert-records.html
|
|
4476
4508
|
*/ function zohoCrmUpsertRecord(context) {
|
|
4477
4509
|
return updateRecordLikeFunction(context, '/upsert', 'POST');
|
|
4478
4510
|
}
|
|
@@ -4485,8 +4517,10 @@ function _is_native_reflect_construct() {
|
|
|
4485
4517
|
*
|
|
4486
4518
|
* Maximum of {@link ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT} records per call.
|
|
4487
4519
|
*
|
|
4488
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4489
|
-
* @returns Function that updates records in the specified module
|
|
4520
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4521
|
+
* @returns Function that updates records in the specified module.
|
|
4522
|
+
*
|
|
4523
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/update-records.html
|
|
4490
4524
|
*
|
|
4491
4525
|
* @example
|
|
4492
4526
|
* ```typescript
|
|
@@ -4507,8 +4541,6 @@ function _is_native_reflect_construct() {
|
|
|
4507
4541
|
* ]
|
|
4508
4542
|
* });
|
|
4509
4543
|
* ```
|
|
4510
|
-
*
|
|
4511
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/update-records.html
|
|
4512
4544
|
*/ function zohoCrmUpdateRecord(context) {
|
|
4513
4545
|
return updateRecordLikeFunction(context, '', 'PUT');
|
|
4514
4546
|
}
|
|
@@ -4519,8 +4551,10 @@ function _is_native_reflect_construct() {
|
|
|
4519
4551
|
* an optional `wf_trigger` flag to execute workflow rules on deletion. Returns
|
|
4520
4552
|
* a response with separated success and error entries.
|
|
4521
4553
|
*
|
|
4522
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4523
|
-
* @returns Function that deletes records from the specified module
|
|
4554
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4555
|
+
* @returns Function that deletes records from the specified module.
|
|
4556
|
+
*
|
|
4557
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/delete-records.html
|
|
4524
4558
|
*
|
|
4525
4559
|
* @example
|
|
4526
4560
|
* ```typescript
|
|
@@ -4531,8 +4565,6 @@ function _is_native_reflect_construct() {
|
|
|
4531
4565
|
* ids: contactId
|
|
4532
4566
|
* });
|
|
4533
4567
|
* ```
|
|
4534
|
-
*
|
|
4535
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/delete-records.html
|
|
4536
4568
|
*/ function zohoCrmDeleteRecord(context) {
|
|
4537
4569
|
return function(param) {
|
|
4538
4570
|
var ids = param.ids, module = param.module, wf_trigger = param.wf_trigger;
|
|
@@ -4549,8 +4581,10 @@ function _is_native_reflect_construct() {
|
|
|
4549
4581
|
* unwrapped from the standard data array, returning the record directly.
|
|
4550
4582
|
* Throws if the record is not found.
|
|
4551
4583
|
*
|
|
4552
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4553
|
-
* @returns Function that retrieves a record by module name and ID
|
|
4584
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4585
|
+
* @returns Function that retrieves a record by module name and ID.
|
|
4586
|
+
*
|
|
4587
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
|
|
4554
4588
|
*
|
|
4555
4589
|
* @example
|
|
4556
4590
|
* ```typescript
|
|
@@ -4561,8 +4595,6 @@ function _is_native_reflect_construct() {
|
|
|
4561
4595
|
* id: contactId
|
|
4562
4596
|
* });
|
|
4563
4597
|
* ```
|
|
4564
|
-
*
|
|
4565
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
|
|
4566
4598
|
*/ function zohoCrmGetRecordById(context) {
|
|
4567
4599
|
return function(input) {
|
|
4568
4600
|
return context.fetchJson("/v8/".concat(input.module, "/").concat(input.id), zohoCrmApiFetchJsonInput('GET')).then(assertZohoCrmRecordDataArrayResultHasContent(input.module)).then(function(x) {
|
|
@@ -4577,8 +4609,10 @@ function _is_native_reflect_construct() {
|
|
|
4577
4609
|
* selection, sorting, custom view filtering, territory filtering, and
|
|
4578
4610
|
* conversion/approval status filters via {@link ZohoCrmGetRecordsInput}.
|
|
4579
4611
|
*
|
|
4580
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4581
|
-
* @returns Function that retrieves paginated records from a module
|
|
4612
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4613
|
+
* @returns Function that retrieves paginated records from a module.
|
|
4614
|
+
*
|
|
4615
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
|
|
4582
4616
|
*
|
|
4583
4617
|
* @example
|
|
4584
4618
|
* ```typescript
|
|
@@ -4590,8 +4624,6 @@ function _is_native_reflect_construct() {
|
|
|
4590
4624
|
* per_page: 10
|
|
4591
4625
|
* });
|
|
4592
4626
|
* ```
|
|
4593
|
-
*
|
|
4594
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-records.html
|
|
4595
4627
|
*/ function zohoCrmGetRecords(context) {
|
|
4596
4628
|
return function(input) {
|
|
4597
4629
|
return context.fetchJson("/v8/".concat(input.module, "?").concat(zohoCrmUrlSearchParamsMinusModule(input).toString()), zohoCrmApiFetchJsonInput('GET'));
|
|
@@ -4605,9 +4637,11 @@ function _is_native_reflect_construct() {
|
|
|
4605
4637
|
* At least one search parameter must be provided. Returns a paginated result,
|
|
4606
4638
|
* defaulting to an empty data array when no matches are found.
|
|
4607
4639
|
*
|
|
4608
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4609
|
-
* @returns Function that searches records in the specified module
|
|
4610
|
-
* @throws {Error} If none of `criteria`, `email`, `phone`, `cvid`, or `word` are provided
|
|
4640
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4641
|
+
* @returns Function that searches records in the specified module.
|
|
4642
|
+
* @throws {Error} If none of `criteria`, `email`, `phone`, `cvid`, or `word` are provided.
|
|
4643
|
+
*
|
|
4644
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/search-records.html
|
|
4611
4645
|
*
|
|
4612
4646
|
* @example
|
|
4613
4647
|
* ```typescript
|
|
@@ -4626,8 +4660,6 @@ function _is_native_reflect_construct() {
|
|
|
4626
4660
|
* word: 'engineer'
|
|
4627
4661
|
* });
|
|
4628
4662
|
* ```
|
|
4629
|
-
*
|
|
4630
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/search-records.html
|
|
4631
4663
|
*/ function zohoCrmSearchRecords(context) {
|
|
4632
4664
|
function searchRecordsUrlSearchParams(input) {
|
|
4633
4665
|
var baseInput = _object_spread$h({}, input);
|
|
@@ -4658,8 +4690,8 @@ function _is_native_reflect_construct() {
|
|
|
4658
4690
|
* Returns a page factory that automatically handles Zoho CRM's pagination,
|
|
4659
4691
|
* making it easy to iterate through all search results across multiple pages.
|
|
4660
4692
|
*
|
|
4661
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4662
|
-
* @returns Page factory for iterating over search results
|
|
4693
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4694
|
+
* @returns Page factory for iterating over search results.
|
|
4663
4695
|
*
|
|
4664
4696
|
* @example
|
|
4665
4697
|
* ```typescript
|
|
@@ -4674,6 +4706,7 @@ function _is_native_reflect_construct() {
|
|
|
4674
4706
|
* const firstPage = await fetchPage.fetchNext();
|
|
4675
4707
|
* const secondPage = await firstPage.fetchNext();
|
|
4676
4708
|
* ```
|
|
4709
|
+
*
|
|
4677
4710
|
* @__NO_SIDE_EFFECTS__
|
|
4678
4711
|
*/ function zohoCrmSearchRecordsPageFactory(context) {
|
|
4679
4712
|
return zohoFetchPageFactory(zohoCrmSearchRecords(context));
|
|
@@ -4687,8 +4720,10 @@ function _is_native_reflect_construct() {
|
|
|
4687
4720
|
* target module and empty-result behavior. By default, returns an empty page
|
|
4688
4721
|
* result instead of null when no records are found.
|
|
4689
4722
|
*
|
|
4690
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4691
|
-
* @returns Factory that creates typed related-records retrieval functions
|
|
4723
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4724
|
+
* @returns Factory that creates typed related-records retrieval functions.
|
|
4725
|
+
*
|
|
4726
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4692
4727
|
*
|
|
4693
4728
|
* @example
|
|
4694
4729
|
* ```typescript
|
|
@@ -4705,7 +4740,6 @@ function _is_native_reflect_construct() {
|
|
|
4705
4740
|
* });
|
|
4706
4741
|
* ```
|
|
4707
4742
|
*
|
|
4708
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4709
4743
|
* @__NO_SIDE_EFFECTS__
|
|
4710
4744
|
*/ function zohoCrmGetRelatedRecordsFunctionFactory(context) {
|
|
4711
4745
|
return function(config) {
|
|
@@ -4726,8 +4760,10 @@ function _is_native_reflect_construct() {
|
|
|
4726
4760
|
* which returns email data under an `Emails` key instead of the standard `data` key.
|
|
4727
4761
|
* Returns a paginated result of {@link ZohoCrmRecordEmailMetadata} entries.
|
|
4728
4762
|
*
|
|
4729
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4730
|
-
* @returns Function that retrieves emails for a record
|
|
4763
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4764
|
+
* @returns Function that retrieves emails for a record.
|
|
4765
|
+
*
|
|
4766
|
+
* @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
|
|
4731
4767
|
*
|
|
4732
4768
|
* @example
|
|
4733
4769
|
* ```typescript
|
|
@@ -4738,8 +4774,6 @@ function _is_native_reflect_construct() {
|
|
|
4738
4774
|
* module: 'Contacts'
|
|
4739
4775
|
* });
|
|
4740
4776
|
* ```
|
|
4741
|
-
*
|
|
4742
|
-
* @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
|
|
4743
4777
|
*/ function zohoCrmGetEmailsForRecord(context) {
|
|
4744
4778
|
var getEmailsFactory = zohoCrmGetRelatedRecordsFunctionFactory(context)({
|
|
4745
4779
|
targetModule: ZOHO_CRM_EMAILS_MODULE
|
|
@@ -4761,8 +4795,10 @@ function _is_native_reflect_construct() {
|
|
|
4761
4795
|
* multiple pages. Wraps {@link zohoCrmGetEmailsForRecord} with automatic
|
|
4762
4796
|
* pagination handling via {@link zohoFetchPageFactory}.
|
|
4763
4797
|
*
|
|
4764
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4765
|
-
* @returns Page factory for iterating over record emails
|
|
4798
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4799
|
+
* @returns Page factory for iterating over record emails.
|
|
4800
|
+
*
|
|
4801
|
+
* @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
|
|
4766
4802
|
*
|
|
4767
4803
|
* @example
|
|
4768
4804
|
* ```typescript
|
|
@@ -4781,7 +4817,6 @@ function _is_native_reflect_construct() {
|
|
|
4781
4817
|
* }
|
|
4782
4818
|
* ```
|
|
4783
4819
|
*
|
|
4784
|
-
* @see https://www.zoho.com/crm/developer/docs/api/v8/get-email-rel-list.html
|
|
4785
4820
|
* @__NO_SIDE_EFFECTS__
|
|
4786
4821
|
*/ function zohoCrmGetEmailsForRecordPageFactory(context) {
|
|
4787
4822
|
return zohoFetchPageFactory(zohoCrmGetEmailsForRecord(context));
|
|
@@ -4795,8 +4830,10 @@ function _is_native_reflect_construct() {
|
|
|
4795
4830
|
* and category information. When no attachments exist for the record, the result
|
|
4796
4831
|
* contains an empty data array rather than null.
|
|
4797
4832
|
*
|
|
4798
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4799
|
-
* @returns Function that retrieves attachments for a record
|
|
4833
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4834
|
+
* @returns Function that retrieves attachments for a record.
|
|
4835
|
+
*
|
|
4836
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4800
4837
|
*
|
|
4801
4838
|
* @example
|
|
4802
4839
|
* ```typescript
|
|
@@ -4808,8 +4845,6 @@ function _is_native_reflect_construct() {
|
|
|
4808
4845
|
* fields: 'File_Name,Size,Created_Time'
|
|
4809
4846
|
* });
|
|
4810
4847
|
* ```
|
|
4811
|
-
*
|
|
4812
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4813
4848
|
*/ function zohoCrmGetAttachmentsForRecord(context) {
|
|
4814
4849
|
return zohoCrmGetRelatedRecordsFunctionFactory(context)({
|
|
4815
4850
|
targetModule: ZOHO_CRM_ATTACHMENTS_MODULE
|
|
@@ -4822,8 +4857,10 @@ function _is_native_reflect_construct() {
|
|
|
4822
4857
|
* across multiple pages. Wraps {@link zohoCrmGetAttachmentsForRecord} with
|
|
4823
4858
|
* automatic pagination handling via {@link zohoFetchPageFactory}.
|
|
4824
4859
|
*
|
|
4825
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4826
|
-
* @returns Page factory for iterating over record attachments
|
|
4860
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4861
|
+
* @returns Page factory for iterating over record attachments.
|
|
4862
|
+
*
|
|
4863
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4827
4864
|
*
|
|
4828
4865
|
* @example
|
|
4829
4866
|
* ```typescript
|
|
@@ -4843,7 +4880,6 @@ function _is_native_reflect_construct() {
|
|
|
4843
4880
|
* }
|
|
4844
4881
|
* ```
|
|
4845
4882
|
*
|
|
4846
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/get-related-records.html
|
|
4847
4883
|
* @__NO_SIDE_EFFECTS__
|
|
4848
4884
|
*/ function zohoCrmGetAttachmentsForRecordPageFactory(context) {
|
|
4849
4885
|
return zohoFetchPageFactory(zohoCrmGetAttachmentsForRecord(context));
|
|
@@ -4860,9 +4896,11 @@ function _is_native_reflect_construct() {
|
|
|
4860
4896
|
* multipart/form-data. An attachment category must be specified by ID or name.
|
|
4861
4897
|
* Maximum file size is {@link ZOHO_CRM_ATTACHMENT_MAX_SIZE} (20MB).
|
|
4862
4898
|
*
|
|
4863
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4864
|
-
* @returns Function that uploads an attachment to a record
|
|
4865
|
-
* @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided
|
|
4899
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4900
|
+
* @returns Function that uploads an attachment to a record.
|
|
4901
|
+
* @throws {Error} If neither `attachmentCategoryId` nor `attachmentCategoryName` is provided.
|
|
4902
|
+
*
|
|
4903
|
+
* @see https://www.zoho.com/crm/developer/docs/api/v2.1/upload-attachment.html
|
|
4866
4904
|
*
|
|
4867
4905
|
* @example
|
|
4868
4906
|
* ```typescript
|
|
@@ -4875,8 +4913,6 @@ function _is_native_reflect_construct() {
|
|
|
4875
4913
|
* attachmentCategoryName: 'Resume'
|
|
4876
4914
|
* });
|
|
4877
4915
|
* ```
|
|
4878
|
-
*
|
|
4879
|
-
* @see https://www.zoho.com/crm/developer/docs/api/v2.1/upload-attachment.html
|
|
4880
4916
|
*/ function zohoCrmUploadAttachmentForRecord(context) {
|
|
4881
4917
|
return function(input) {
|
|
4882
4918
|
var _urlParams_attachments_category_id, _urlParams_attachments_category;
|
|
@@ -4908,8 +4944,10 @@ function _is_native_reflect_construct() {
|
|
|
4908
4944
|
* {@link FetchFileResponse} containing the file data and metadata extracted
|
|
4909
4945
|
* from the response headers.
|
|
4910
4946
|
*
|
|
4911
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4912
|
-
* @returns Function that downloads an attachment by record and attachment ID
|
|
4947
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4948
|
+
* @returns Function that downloads an attachment by record and attachment ID.
|
|
4949
|
+
*
|
|
4950
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/download-attachments.html
|
|
4913
4951
|
*
|
|
4914
4952
|
* @example
|
|
4915
4953
|
* ```typescript
|
|
@@ -4921,8 +4959,6 @@ function _is_native_reflect_construct() {
|
|
|
4921
4959
|
* attachment_id: attachmentId
|
|
4922
4960
|
* });
|
|
4923
4961
|
* ```
|
|
4924
|
-
*
|
|
4925
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/download-attachments.html
|
|
4926
4962
|
*/ function zohoCrmDownloadAttachmentForRecord(context) {
|
|
4927
4963
|
return function(input) {
|
|
4928
4964
|
return context.fetch("/v8/".concat(input.module, "/").concat(input.id, "/").concat(ZOHO_CRM_ATTACHMENTS_MODULE, "/").concat(input.attachment_id), {
|
|
@@ -4936,8 +4972,10 @@ function _is_native_reflect_construct() {
|
|
|
4936
4972
|
* Deletes a specific attachment from a record by its attachment ID.
|
|
4937
4973
|
* Returns the raw {@link Response}.
|
|
4938
4974
|
*
|
|
4939
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4940
|
-
* @returns Function that deletes an attachment by record and attachment ID
|
|
4975
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
4976
|
+
* @returns Function that deletes an attachment by record and attachment ID.
|
|
4977
|
+
*
|
|
4978
|
+
* @see https://www.zoho.com/crm/developer-guide/apiv2/delete-attachments.html
|
|
4941
4979
|
*
|
|
4942
4980
|
* @example
|
|
4943
4981
|
* ```typescript
|
|
@@ -4949,8 +4987,6 @@ function _is_native_reflect_construct() {
|
|
|
4949
4987
|
* attachment_id: attachmentId
|
|
4950
4988
|
* });
|
|
4951
4989
|
* ```
|
|
4952
|
-
*
|
|
4953
|
-
* @see https://www.zoho.com/crm/developer-guide/apiv2/delete-attachments.html
|
|
4954
4990
|
*/ function zohoCrmDeleteAttachmentFromRecord(context) {
|
|
4955
4991
|
return function(input) {
|
|
4956
4992
|
return context.fetch("/v8/".concat(input.module, "/").concat(input.id, "/").concat(ZOHO_CRM_ATTACHMENTS_MODULE, "/").concat(input.attachment_id), {
|
|
@@ -4985,9 +5021,9 @@ function _is_native_reflect_construct() {
|
|
|
4985
5021
|
* - There is no documentation for ZohoCrm specifically, but it seems to behave the same way
|
|
4986
5022
|
* - You will need the following scopes: ZohoCrm.functions.execute.READ,ZohoCrm.functions.execute.CREATE
|
|
4987
5023
|
*
|
|
4988
|
-
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting
|
|
4989
|
-
* @returns Function that executes serverless functions via the REST API
|
|
4990
|
-
* @throws {ZohoCrmExecuteRestApiFunctionError} If the function execution fails
|
|
5024
|
+
* @param context - Authenticated Zoho CRM context providing fetch and rate limiting.
|
|
5025
|
+
* @returns Function that executes serverless functions via the REST API.
|
|
5026
|
+
* @throws {ZohoCrmExecuteRestApiFunctionError} If the function execution fails.
|
|
4991
5027
|
*
|
|
4992
5028
|
* @example
|
|
4993
5029
|
* ```typescript
|
|
@@ -5009,6 +5045,7 @@ function _is_native_reflect_construct() {
|
|
|
5009
5045
|
* apiUrl: 'production'
|
|
5010
5046
|
* });
|
|
5011
5047
|
* ```
|
|
5048
|
+
*
|
|
5012
5049
|
* @__NO_SIDE_EFFECTS__
|
|
5013
5050
|
*/ function zohoCrmExecuteRestApiFunction(context) {
|
|
5014
5051
|
return function(input) {
|
|
@@ -5031,8 +5068,8 @@ function _is_native_reflect_construct() {
|
|
|
5031
5068
|
/**
|
|
5032
5069
|
* 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.
|
|
5033
5070
|
*
|
|
5034
|
-
* @param input - One or more objects to convert into URL search parameters
|
|
5035
|
-
* @returns URL search params string with the `module` key excluded
|
|
5071
|
+
* @param input - One or more objects to convert into URL search parameters.
|
|
5072
|
+
* @returns URL search params string with the `module` key excluded.
|
|
5036
5073
|
*/ function zohoCrmUrlSearchParamsMinusModule() {
|
|
5037
5074
|
for(var _len = arguments.length, input = new Array(_len), _key = 0; _key < _len; _key++){
|
|
5038
5075
|
input[_key] = arguments[_key];
|
|
@@ -5044,8 +5081,8 @@ function _is_native_reflect_construct() {
|
|
|
5044
5081
|
/**
|
|
5045
5082
|
* Builds URL search params from the input objects, omitting both `id` and `module` keys since they are used in the URL path.
|
|
5046
5083
|
*
|
|
5047
|
-
* @param input - One or more objects to convert into URL search parameters
|
|
5048
|
-
* @returns URL search params string with `id` and `module` keys excluded
|
|
5084
|
+
* @param input - One or more objects to convert into URL search parameters.
|
|
5085
|
+
* @returns URL search params string with `id` and `module` keys excluded.
|
|
5049
5086
|
*/ function zohoCrmUrlSearchParamsMinusIdAndModule() {
|
|
5050
5087
|
for(var _len = arguments.length, input = new Array(_len), _key = 0; _key < _len; _key++){
|
|
5051
5088
|
input[_key] = arguments[_key];
|
|
@@ -5057,15 +5094,12 @@ function _is_native_reflect_construct() {
|
|
|
5057
5094
|
]
|
|
5058
5095
|
});
|
|
5059
5096
|
}
|
|
5060
|
-
/**
|
|
5061
|
-
* @deprecated use makeUrlSearchParams instead.
|
|
5062
|
-
*/ var zohoCrmUrlSearchParams = makeUrlSearchParams;
|
|
5063
5097
|
/**
|
|
5064
5098
|
* Constructs the standard FetchJsonInput used by CRM API calls, pairing the HTTP method with an optional body.
|
|
5065
5099
|
*
|
|
5066
|
-
* @param method - HTTP method to use for the request
|
|
5067
|
-
* @param body - Optional request body to include
|
|
5068
|
-
* @returns Configured fetch input for the Zoho CRM API call
|
|
5100
|
+
* @param method - HTTP method to use for the request.
|
|
5101
|
+
* @param body - Optional request body to include.
|
|
5102
|
+
* @returns Configured fetch input for the Zoho CRM API call.
|
|
5069
5103
|
*/ function zohoCrmApiFetchJsonInput(method, body) {
|
|
5070
5104
|
return {
|
|
5071
5105
|
method: method,
|
|
@@ -5078,8 +5112,9 @@ function _is_native_reflect_construct() {
|
|
|
5078
5112
|
*
|
|
5079
5113
|
* Use to catch errors from functions that return ZohoCrmChangeObjectLikeResponse and pass the result to zohoCrmChangeObjectLikeResponseSuccessAndErrorPairs.
|
|
5080
5114
|
*
|
|
5081
|
-
* @param e - The error to catch and potentially convert
|
|
5082
|
-
* @returns The error data array wrapped as a change object response
|
|
5115
|
+
* @param e - The error to catch and potentially convert.
|
|
5116
|
+
* @returns The error data array wrapped as a change object response.
|
|
5117
|
+
* @throws Re-throws `e` when it is not a {@link ZohoServerFetchResponseDataArrayError}.
|
|
5083
5118
|
*/ function zohoCrmCatchZohoCrmChangeObjectLikeResponseError(e) {
|
|
5084
5119
|
var result;
|
|
5085
5120
|
if (_instanceof$4(e, ZohoServerFetchResponseDataArrayError)) {
|
|
@@ -5101,8 +5136,8 @@ function _is_native_reflect_construct() {
|
|
|
5101
5136
|
* Used internally by {@link zohoCrmDeleteRecord} and similar functions to provide
|
|
5102
5137
|
* convenient access to separated success/error results.
|
|
5103
5138
|
*
|
|
5104
|
-
* @param response - Raw change operation response containing mixed success/error entries
|
|
5105
|
-
* @returns The response augmented with pre-separated `successItems` and `errorItems` arrays
|
|
5139
|
+
* @param response - Raw change operation response containing mixed success/error entries.
|
|
5140
|
+
* @returns The response augmented with pre-separated `successItems` and `errorItems` arrays.
|
|
5106
5141
|
*
|
|
5107
5142
|
* @example
|
|
5108
5143
|
* ```typescript
|
|
@@ -5139,9 +5174,9 @@ function _is_native_reflect_construct() {
|
|
|
5139
5174
|
* Used internally by {@link updateRecordLikeFunction} to pair input data with API outcomes
|
|
5140
5175
|
* for insert, update, and upsert operations.
|
|
5141
5176
|
*
|
|
5142
|
-
* @param input - Array of input records that were submitted to the API
|
|
5177
|
+
* @param input - Array of input records that were submitted to the API.
|
|
5143
5178
|
* @param results - Array of per-record results returned by the API, positionally aligned with `input`
|
|
5144
|
-
* @returns Object with `successItems` and `errorItems`, each containing paired `{ input, result }` entries
|
|
5179
|
+
* @returns Object with `successItems` and `errorItems`, each containing paired `{ input, result }` entries.
|
|
5145
5180
|
*/ function zohoCrmMultiRecordResult(input, results) {
|
|
5146
5181
|
var successItems = [];
|
|
5147
5182
|
var errorItems = [];
|
|
@@ -5165,6 +5200,11 @@ function _is_native_reflect_construct() {
|
|
|
5165
5200
|
};
|
|
5166
5201
|
return result;
|
|
5167
5202
|
}
|
|
5203
|
+
// MARK: Compat
|
|
5204
|
+
// COMPAT: Deprecated aliases
|
|
5205
|
+
/**
|
|
5206
|
+
* @deprecated use makeUrlSearchParams instead.
|
|
5207
|
+
*/ var zohoCrmUrlSearchParams = makeUrlSearchParams;
|
|
5168
5208
|
|
|
5169
5209
|
function _define_property$g(obj, key, value) {
|
|
5170
5210
|
if (key in obj) {
|
|
@@ -5218,8 +5258,8 @@ function _object_spread_props$f(target, source) {
|
|
|
5218
5258
|
*
|
|
5219
5259
|
* For creating notes associated with a specific record, prefer {@link zohoCrmCreateNotesForRecord} which handles parent binding automatically.
|
|
5220
5260
|
*
|
|
5221
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5222
|
-
* @returns Function that creates notes in the CRM Notes module
|
|
5261
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5262
|
+
* @returns Function that creates notes in the CRM Notes module.
|
|
5223
5263
|
*/ function zohoCrmCreateNotes(context) {
|
|
5224
5264
|
return function(input) {
|
|
5225
5265
|
return context.fetchJson("/v2/".concat(ZOHO_CRM_NOTES_MODULE), zohoCrmApiFetchJsonInput('POST', {
|
|
@@ -5232,8 +5272,8 @@ function _object_spread_props$f(target, source) {
|
|
|
5232
5272
|
/**
|
|
5233
5273
|
* Deletes one or more notes from the CRM Notes module by their IDs.
|
|
5234
5274
|
*
|
|
5235
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5236
|
-
* @returns Function that deletes notes by their IDs
|
|
5275
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5276
|
+
* @returns Function that deletes notes by their IDs.
|
|
5237
5277
|
*/ function zohoCrmDeleteNotes(context) {
|
|
5238
5278
|
return function(input) {
|
|
5239
5279
|
return context.fetchJson("/v2/".concat(ZOHO_CRM_NOTES_MODULE, "?").concat(makeUrlSearchParams({
|
|
@@ -5246,8 +5286,8 @@ function _object_spread_props$f(target, source) {
|
|
|
5246
5286
|
/**
|
|
5247
5287
|
* Retrieves paginated notes associated with a specific CRM record using the related records API.
|
|
5248
5288
|
*
|
|
5249
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5250
|
-
* @returns Function that retrieves notes for a specific record
|
|
5289
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5290
|
+
* @returns Function that retrieves notes for a specific record.
|
|
5251
5291
|
*/ function zohoCrmGetNotesForRecord(context) {
|
|
5252
5292
|
return zohoCrmGetRelatedRecordsFunctionFactory(context)({
|
|
5253
5293
|
targetModule: ZOHO_CRM_NOTES_MODULE
|
|
@@ -5256,8 +5296,9 @@ function _object_spread_props$f(target, source) {
|
|
|
5256
5296
|
/**
|
|
5257
5297
|
* Creates a page factory for iterating through all notes for a record across multiple pages.
|
|
5258
5298
|
*
|
|
5259
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5260
|
-
* @returns Page factory for paginating through notes for a record
|
|
5299
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5300
|
+
* @returns Page factory for paginating through notes for a record.
|
|
5301
|
+
*
|
|
5261
5302
|
* @__NO_SIDE_EFFECTS__
|
|
5262
5303
|
*/ function zohoCrmGetNotesForRecordPageFactory(context) {
|
|
5263
5304
|
return zohoFetchPageFactory(zohoCrmGetNotesForRecord(context));
|
|
@@ -5267,8 +5308,8 @@ function _object_spread_props$f(target, source) {
|
|
|
5267
5308
|
*
|
|
5268
5309
|
* https://www.zoho.com/crm/developer/docs/api/v8/create-notes.html
|
|
5269
5310
|
*
|
|
5270
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5271
|
-
* @returns Function that creates notes bound to a specific record
|
|
5311
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5312
|
+
* @returns Function that creates notes bound to a specific record.
|
|
5272
5313
|
*/ function zohoCrmCreateNotesForRecord(context) {
|
|
5273
5314
|
var createNotesInstance = zohoCrmCreateNotes(context);
|
|
5274
5315
|
return function(input) {
|
|
@@ -5368,8 +5409,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5368
5409
|
/**
|
|
5369
5410
|
* Creates one or more tags for a CRM module. Duplicate tag errors are separated from other errors in the result to simplify idempotent workflows.
|
|
5370
5411
|
*
|
|
5371
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5372
|
-
* @returns Function that creates tags for a module
|
|
5412
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5413
|
+
* @returns Function that creates tags for a module.
|
|
5373
5414
|
*/ function zohoCrmCreateTagsForModule(context) {
|
|
5374
5415
|
return function(input) {
|
|
5375
5416
|
return context.fetchJson("/v8/settings/tags?".concat(makeUrlSearchParams({
|
|
@@ -5411,8 +5452,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5411
5452
|
*
|
|
5412
5453
|
* https://www.zoho.com/crm/developer/docs/api/v8/delete-tag.html
|
|
5413
5454
|
*
|
|
5414
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5415
|
-
* @returns Function that deletes a tag by ID
|
|
5455
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5456
|
+
* @returns Function that deletes a tag by ID.
|
|
5416
5457
|
*/ function zohoCrmDeleteTag(context) {
|
|
5417
5458
|
return function(input) {
|
|
5418
5459
|
return context.fetchJson("/v8/settings/tags/".concat(input.id), zohoCrmApiFetchJsonInput('DELETE')).then(function(x) {
|
|
@@ -5425,8 +5466,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5425
5466
|
*
|
|
5426
5467
|
* https://www.zoho.com/crm/developer-guide/apiv2/get-tag-list.html
|
|
5427
5468
|
*
|
|
5428
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5429
|
-
* @returns Function that retrieves tags for a module
|
|
5469
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5470
|
+
* @returns Function that retrieves tags for a module.
|
|
5430
5471
|
*/ function zohoCrmGetTagsForModule(context) {
|
|
5431
5472
|
return function(input) {
|
|
5432
5473
|
return context.fetchJson("/v8/settings/tags?".concat(makeUrlSearchParams({
|
|
@@ -5443,8 +5484,9 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5443
5484
|
/**
|
|
5444
5485
|
* Creates a page factory for iterating through all tags in a module across multiple pages.
|
|
5445
5486
|
*
|
|
5446
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5447
|
-
* @returns Page factory for paginating through tags in a module
|
|
5487
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5488
|
+
* @returns Page factory for paginating through tags in a module.
|
|
5489
|
+
*
|
|
5448
5490
|
* @__NO_SIDE_EFFECTS__
|
|
5449
5491
|
*/ function zohoCrmGetTagsForModulePageFactory(context) {
|
|
5450
5492
|
return zohoFetchPageFactory(zohoCrmGetTagsForModule(context));
|
|
@@ -5458,8 +5500,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5458
5500
|
*
|
|
5459
5501
|
* https://www.zoho.com/crm/developer-guide/apiv2/add-tags.html
|
|
5460
5502
|
*
|
|
5461
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5462
|
-
* @returns Function that adds tags to records
|
|
5503
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5504
|
+
* @returns Function that adds tags to records.
|
|
5463
5505
|
*/ function zohoCrmAddTagsToRecords(context) {
|
|
5464
5506
|
return function(input) {
|
|
5465
5507
|
return context.fetchJson("/v8/".concat(input.module, "/actions/add_tags"), zohoCrmApiFetchJsonInput('POST', zohoCrmAddTagsToRecordsRequestBody(input))).then(function(x) {
|
|
@@ -5473,8 +5515,9 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5473
5515
|
/**
|
|
5474
5516
|
* Builds the request body for the add/remove tags endpoints, merging `tag_names` into `tags` and enforcing the max ID limit.
|
|
5475
5517
|
*
|
|
5476
|
-
* @param input - The add/remove tags request containing tag names, tag objects, and record IDs
|
|
5477
|
-
* @returns The formatted request body with merged tags and record IDs
|
|
5518
|
+
* @param input - The add/remove tags request containing tag names, tag objects, and record IDs.
|
|
5519
|
+
* @returns The formatted request body with merged tags and record IDs.
|
|
5520
|
+
* @throws {Error} When `input.ids` exceeds {@link ZOHO_CRM_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED}.
|
|
5478
5521
|
*/ function zohoCrmAddTagsToRecordsRequestBody(input) {
|
|
5479
5522
|
if (Array.isArray(input.ids) && input.ids.length > ZOHO_CRM_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED) {
|
|
5480
5523
|
throw new Error("Cannot add/remove tags from more than ".concat(ZOHO_CRM_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED, " records at once."));
|
|
@@ -5507,8 +5550,8 @@ function _unsupported_iterable_to_array(o, minLen) {
|
|
|
5507
5550
|
*
|
|
5508
5551
|
* https://www.zoho.com/crm/developer-guide/apiv2/remove-tags.html
|
|
5509
5552
|
*
|
|
5510
|
-
* @param context - Authenticated Zoho CRM context for making API calls
|
|
5511
|
-
* @returns Function that removes tags from records
|
|
5553
|
+
* @param context - Authenticated Zoho CRM context for making API calls.
|
|
5554
|
+
* @returns Function that removes tags from records.
|
|
5512
5555
|
*/ function zohoCrmRemoveTagsFromRecords(context) {
|
|
5513
5556
|
return function(input) {
|
|
5514
5557
|
return context.fetchJson("/v8/".concat(input.module, "/actions/remove_tags"), zohoCrmApiFetchJsonInput('POST', zohoCrmAddTagsToRecordsRequestBody(input))).then(function(x) {
|
|
@@ -5711,8 +5754,8 @@ function _ts_generator$5(thisArg, body) {
|
|
|
5711
5754
|
* Each client handles OAuth token refresh on {@link ZohoInvalidTokenError}, rate limiting,
|
|
5712
5755
|
* and Zoho CRM's non-standard error responses (200 status with error body).
|
|
5713
5756
|
*
|
|
5714
|
-
* @param factoryConfig - Configuration providing account credentials and optional overrides
|
|
5715
|
-
* @returns A factory function that creates authenticated Zoho CRM clients
|
|
5757
|
+
* @param factoryConfig - Configuration providing account credentials and optional overrides.
|
|
5758
|
+
* @returns A factory function that creates authenticated Zoho CRM clients.
|
|
5716
5759
|
*
|
|
5717
5760
|
* @example
|
|
5718
5761
|
* ```typescript
|
|
@@ -5727,6 +5770,7 @@ function _ts_generator$5(thisArg, body) {
|
|
|
5727
5770
|
* // Use the CRM context for API calls:
|
|
5728
5771
|
* const { crmContext } = zohoCrm;
|
|
5729
5772
|
* ```
|
|
5773
|
+
*
|
|
5730
5774
|
* @__NO_SIDE_EFFECTS__
|
|
5731
5775
|
*/ function zohoCrmFactory(factoryConfig) {
|
|
5732
5776
|
var accountsContext = factoryConfig.accountsContext;
|
|
@@ -5857,9 +5901,9 @@ function _object_spread_props$c(target, source) {
|
|
|
5857
5901
|
* The factory reads `page_context.has_more_rows` from each response to determine if additional
|
|
5858
5902
|
* pages exist, and automatically advances `start_index` by `row_count` for subsequent requests.
|
|
5859
5903
|
*
|
|
5860
|
-
* @param fetch - The Zoho Sign fetch function to paginate over
|
|
5861
|
-
* @param defaults - Optional default configuration for the page factory
|
|
5862
|
-
* @returns A page factory that produces iterable page fetchers
|
|
5904
|
+
* @param fetch - The Zoho Sign fetch function to paginate over.
|
|
5905
|
+
* @param defaults - Optional default configuration for the page factory.
|
|
5906
|
+
* @returns A page factory that produces iterable page fetchers.
|
|
5863
5907
|
*
|
|
5864
5908
|
* @example
|
|
5865
5909
|
* ```typescript
|
|
@@ -5872,6 +5916,7 @@ function _object_spread_props$c(target, source) {
|
|
|
5872
5916
|
* const secondPage = await firstPage.fetchNext();
|
|
5873
5917
|
* }
|
|
5874
5918
|
* ```
|
|
5919
|
+
*
|
|
5875
5920
|
* @__NO_SIDE_EFFECTS__
|
|
5876
5921
|
*/ function zohoSignFetchPageFactory(fetch, defaults) {
|
|
5877
5922
|
return fetchPageFactory(_object_spread_props$c(_object_spread$d({}, defaults), {
|
|
@@ -5965,9 +6010,9 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
5965
6010
|
/**
|
|
5966
6011
|
* Builds a {@link FetchJsonInput} for Zoho Sign API calls.
|
|
5967
6012
|
*
|
|
5968
|
-
* @param method - HTTP method for the request
|
|
5969
|
-
* @param body - Optional JSON body to include in the request
|
|
5970
|
-
* @returns Configured fetch JSON input
|
|
6013
|
+
* @param method - HTTP method for the request.
|
|
6014
|
+
* @param body - Optional JSON body to include in the request.
|
|
6015
|
+
* @returns Configured fetch JSON input.
|
|
5971
6016
|
*/ function zohoSignApiFetchJsonInput(method, body) {
|
|
5972
6017
|
return {
|
|
5973
6018
|
method: method,
|
|
@@ -5980,16 +6025,16 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
5980
6025
|
* Fetches the full details of a single Zoho Sign request (envelope) by its ID,
|
|
5981
6026
|
* including actions, documents, and field data.
|
|
5982
6027
|
*
|
|
5983
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
5984
|
-
* @returns Function that retrieves a document by request ID
|
|
6028
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6029
|
+
* @returns Function that retrieves a document by request ID.
|
|
6030
|
+
*
|
|
6031
|
+
* @see https://www.zoho.com/sign/api/document-managment/get-details-of-a-particular-document.html
|
|
5985
6032
|
*
|
|
5986
6033
|
* @example
|
|
5987
6034
|
* ```typescript
|
|
5988
6035
|
* const getDocument = zohoSignGetDocument(context);
|
|
5989
6036
|
* const response = await getDocument({ requestId: '12345' });
|
|
5990
6037
|
* ```
|
|
5991
|
-
*
|
|
5992
|
-
* @see https://www.zoho.com/sign/api/document-managment/get-details-of-a-particular-document.html
|
|
5993
6038
|
*/ function zohoSignGetDocument(context) {
|
|
5994
6039
|
return function(param) {
|
|
5995
6040
|
var requestId = param.requestId;
|
|
@@ -6004,16 +6049,16 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6004
6049
|
* Pagination parameters (`start_index`, `row_count`) are serialized as a
|
|
6005
6050
|
* JSON `data` query parameter per the Zoho Sign API convention.
|
|
6006
6051
|
*
|
|
6007
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6008
|
-
* @returns Function that retrieves a paginated list of documents
|
|
6052
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6053
|
+
* @returns Function that retrieves a paginated list of documents.
|
|
6054
|
+
*
|
|
6055
|
+
* @see https://www.zoho.com/sign/api/document-managment/get-document-list.html
|
|
6009
6056
|
*
|
|
6010
6057
|
* @example
|
|
6011
6058
|
* ```typescript
|
|
6012
6059
|
* const getDocuments = zohoSignGetDocuments(context);
|
|
6013
6060
|
* const response = await getDocuments({ start_index: 1, row_count: 10 });
|
|
6014
6061
|
* ```
|
|
6015
|
-
*
|
|
6016
|
-
* @see https://www.zoho.com/sign/api/document-managment/get-document-list.html
|
|
6017
6062
|
*/ function zohoSignGetDocuments(context) {
|
|
6018
6063
|
return function(input) {
|
|
6019
6064
|
var search_columns = input.search_columns, pageFilter = _object_without_properties$8(input, [
|
|
@@ -6039,8 +6084,8 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6039
6084
|
* `start_index`/`row_count` pagination, making it easy to iterate
|
|
6040
6085
|
* through all documents across multiple pages.
|
|
6041
6086
|
*
|
|
6042
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6043
|
-
* @returns Page factory for iterating through documents
|
|
6087
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6088
|
+
* @returns Page factory for iterating through documents.
|
|
6044
6089
|
*
|
|
6045
6090
|
* @example
|
|
6046
6091
|
* ```typescript
|
|
@@ -6050,6 +6095,7 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6050
6095
|
* const firstPage = await fetchPage.fetchNext();
|
|
6051
6096
|
* const secondPage = await firstPage.fetchNext();
|
|
6052
6097
|
* ```
|
|
6098
|
+
*
|
|
6053
6099
|
* @__NO_SIDE_EFFECTS__
|
|
6054
6100
|
*/ function zohoSignGetDocumentsPageFactory(context) {
|
|
6055
6101
|
var getDocuments = zohoSignGetDocuments(context);
|
|
@@ -6062,16 +6108,16 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6062
6108
|
* returns data after all recipients have signed. The response includes
|
|
6063
6109
|
* field labels and values grouped by recipient action.
|
|
6064
6110
|
*
|
|
6065
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6066
|
-
* @returns Function that retrieves form data for a completed document
|
|
6111
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6112
|
+
* @returns Function that retrieves form data for a completed document.
|
|
6113
|
+
*
|
|
6114
|
+
* @see https://www.zoho.com/sign/api/document-managment/get-document-form-data.html
|
|
6067
6115
|
*
|
|
6068
6116
|
* @example
|
|
6069
6117
|
* ```typescript
|
|
6070
6118
|
* const getFormData = zohoSignGetDocumentFormData(context);
|
|
6071
6119
|
* const response = await getFormData({ requestId: '12345' });
|
|
6072
6120
|
* ```
|
|
6073
|
-
*
|
|
6074
|
-
* @see https://www.zoho.com/sign/api/document-managment/get-document-form-data.html
|
|
6075
6121
|
*/ function zohoSignGetDocumentFormData(context) {
|
|
6076
6122
|
return function(param) {
|
|
6077
6123
|
var requestId = param.requestId;
|
|
@@ -6085,16 +6131,16 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6085
6131
|
* that can be placed on documents. Useful for dynamically building document
|
|
6086
6132
|
* templates or validating field configurations.
|
|
6087
6133
|
*
|
|
6088
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6089
|
-
* @returns Function that retrieves all available field types
|
|
6134
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6135
|
+
* @returns Function that retrieves all available field types.
|
|
6136
|
+
*
|
|
6137
|
+
* @see https://www.zoho.com/sign/api/document-managment/retrieve-field-type.html
|
|
6090
6138
|
*
|
|
6091
6139
|
* @example
|
|
6092
6140
|
* ```typescript
|
|
6093
6141
|
* const retrieveFieldTypes = zohoSignRetrieveFieldTypes(context);
|
|
6094
6142
|
* const response = await retrieveFieldTypes();
|
|
6095
6143
|
* ```
|
|
6096
|
-
*
|
|
6097
|
-
* @see https://www.zoho.com/sign/api/document-managment/retrieve-field-type.html
|
|
6098
6144
|
*/ function zohoSignRetrieveFieldTypes(context) {
|
|
6099
6145
|
return function() {
|
|
6100
6146
|
return context.fetchJson("/fieldtypes", zohoSignApiFetchJsonInput('GET'));
|
|
@@ -6109,8 +6155,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6109
6155
|
* completion certificate, merge all documents, or provide a password for
|
|
6110
6156
|
* protected files.
|
|
6111
6157
|
*
|
|
6112
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6113
|
-
* @returns Function that downloads signed PDFs by request ID
|
|
6158
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6159
|
+
* @returns Function that downloads signed PDFs by request ID.
|
|
6160
|
+
*
|
|
6161
|
+
* @see https://www.zoho.com/sign/api/document-managment/download-pdf.html
|
|
6114
6162
|
*
|
|
6115
6163
|
* @example
|
|
6116
6164
|
* ```typescript
|
|
@@ -6125,8 +6173,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6125
6173
|
*
|
|
6126
6174
|
* const blob = await response.blob();
|
|
6127
6175
|
* ```
|
|
6128
|
-
*
|
|
6129
|
-
* @see https://www.zoho.com/sign/api/document-managment/download-pdf.html
|
|
6130
6176
|
*/ function zohoSignDownloadPdf(context) {
|
|
6131
6177
|
return function(_0) {
|
|
6132
6178
|
var requestId = _0.requestId, params = _object_without_properties$8(_0, [
|
|
@@ -6148,8 +6194,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6148
6194
|
* certificate contains an audit trail of the signing process including
|
|
6149
6195
|
* timestamps and recipient details. Returns a raw {@link Response}.
|
|
6150
6196
|
*
|
|
6151
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6152
|
-
* @returns Function that downloads the completion certificate by request ID
|
|
6197
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6198
|
+
* @returns Function that downloads the completion certificate by request ID.
|
|
6199
|
+
*
|
|
6200
|
+
* @see https://www.zoho.com/sign/api/document-managment/download-completion-certificate.html
|
|
6153
6201
|
*
|
|
6154
6202
|
* @example
|
|
6155
6203
|
* ```typescript
|
|
@@ -6157,8 +6205,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6157
6205
|
* const response = await downloadCert({ requestId: '12345' });
|
|
6158
6206
|
* const blob = await response.blob();
|
|
6159
6207
|
* ```
|
|
6160
|
-
*
|
|
6161
|
-
* @see https://www.zoho.com/sign/api/document-managment/download-completion-certificate.html
|
|
6162
6208
|
*/ function zohoSignDownloadCompletionCertificate(context) {
|
|
6163
6209
|
return function(param) {
|
|
6164
6210
|
var requestId = param.requestId;
|
|
@@ -6178,8 +6224,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6178
6224
|
* The created document starts in draft status and must be submitted
|
|
6179
6225
|
* separately via {@link zohoSignSendDocumentForSignature}.
|
|
6180
6226
|
*
|
|
6181
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6182
|
-
* @returns Function that creates a new document draft
|
|
6227
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6228
|
+
* @returns Function that creates a new document draft.
|
|
6229
|
+
*
|
|
6230
|
+
* @see https://www.zoho.com/sign/api/document-managment/create-document.html
|
|
6183
6231
|
*
|
|
6184
6232
|
* @example
|
|
6185
6233
|
* ```typescript
|
|
@@ -6202,8 +6250,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6202
6250
|
*
|
|
6203
6251
|
* const draftId = response.requests.request_id;
|
|
6204
6252
|
* ```
|
|
6205
|
-
*
|
|
6206
|
-
* @see https://www.zoho.com/sign/api/document-managment/create-document.html
|
|
6207
6253
|
*/ function zohoSignCreateDocument(context) {
|
|
6208
6254
|
return function(param) {
|
|
6209
6255
|
var requestData = param.requestData, file = param.file;
|
|
@@ -6232,8 +6278,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6232
6278
|
* expiration settings. Cannot be used on documents that have already been
|
|
6233
6279
|
* submitted for signature.
|
|
6234
6280
|
*
|
|
6235
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6236
|
-
* @returns Function that updates a draft document by request ID
|
|
6281
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6282
|
+
* @returns Function that updates a draft document by request ID.
|
|
6283
|
+
*
|
|
6284
|
+
* @see https://www.zoho.com/sign/api/document-managment/update-document.html
|
|
6237
6285
|
*
|
|
6238
6286
|
* @example
|
|
6239
6287
|
* ```typescript
|
|
@@ -6244,8 +6292,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6244
6292
|
* data: { notes: 'Updated notes for this document' }
|
|
6245
6293
|
* });
|
|
6246
6294
|
* ```
|
|
6247
|
-
*
|
|
6248
|
-
* @see https://www.zoho.com/sign/api/document-managment/update-document.html
|
|
6249
6295
|
*/ function zohoSignUpdateDocument(context) {
|
|
6250
6296
|
return function(param) {
|
|
6251
6297
|
var requestId = param.requestId, data = param.data;
|
|
@@ -6262,8 +6308,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6262
6308
|
* submission. Once submitted, the document transitions from draft to
|
|
6263
6309
|
* "inprogress" status and recipients receive signing notifications.
|
|
6264
6310
|
*
|
|
6265
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6266
|
-
* @returns Function that sends a document for signature by request ID
|
|
6311
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6312
|
+
* @returns Function that sends a document for signature by request ID.
|
|
6313
|
+
*
|
|
6314
|
+
* @see https://www.zoho.com/sign/api/document-managment/send-document-for-signature.html
|
|
6267
6315
|
*
|
|
6268
6316
|
* @example
|
|
6269
6317
|
* ```typescript
|
|
@@ -6278,8 +6326,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6278
6326
|
* data: { expiration_days: 30 }
|
|
6279
6327
|
* });
|
|
6280
6328
|
* ```
|
|
6281
|
-
*
|
|
6282
|
-
* @see https://www.zoho.com/sign/api/document-managment/send-document-for-signature.html
|
|
6283
6329
|
*/ function zohoSignSendDocumentForSignature(context) {
|
|
6284
6330
|
return function(param) {
|
|
6285
6331
|
var requestId = param.requestId, data = param.data;
|
|
@@ -6296,16 +6342,16 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6296
6342
|
* provided as a human-readable string (e.g. "30 November 2024"). Useful for
|
|
6297
6343
|
* giving recipients additional time to complete signing.
|
|
6298
6344
|
*
|
|
6299
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6300
|
-
* @returns Function that extends a document's expiration by request ID
|
|
6345
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6346
|
+
* @returns Function that extends a document's expiration by request ID.
|
|
6347
|
+
*
|
|
6348
|
+
* @see https://www.zoho.com/sign/api/document-managment/extend-document.html
|
|
6301
6349
|
*
|
|
6302
6350
|
* @example
|
|
6303
6351
|
* ```typescript
|
|
6304
6352
|
* const extendDocument = zohoSignExtendDocument(context);
|
|
6305
6353
|
* await extendDocument({ requestId: '12345', expire_by: '30 November 2024' });
|
|
6306
6354
|
* ```
|
|
6307
|
-
*
|
|
6308
|
-
* @see https://www.zoho.com/sign/api/document-managment/extend-document.html
|
|
6309
6355
|
*/ function zohoSignExtendDocument(context) {
|
|
6310
6356
|
return function(param) {
|
|
6311
6357
|
var requestId = param.requestId, expire_by = param.expire_by;
|
|
@@ -6322,8 +6368,10 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6322
6368
|
* from recipients before deletion. An optional `reason` can be provided
|
|
6323
6369
|
* to explain the recall. Sends the parameters as URL-encoded form data.
|
|
6324
6370
|
*
|
|
6325
|
-
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting
|
|
6326
|
-
* @returns Function that deletes a document by request ID
|
|
6371
|
+
* @param context - Authenticated Zoho Sign context providing fetch and rate limiting.
|
|
6372
|
+
* @returns Function that deletes a document by request ID.
|
|
6373
|
+
*
|
|
6374
|
+
* @see https://www.zoho.com/sign/api/document-managment/delete-document.html
|
|
6327
6375
|
*
|
|
6328
6376
|
* @example
|
|
6329
6377
|
* ```typescript
|
|
@@ -6339,8 +6387,6 @@ function _object_without_properties_loose$8(source, excluded) {
|
|
|
6339
6387
|
* reason: 'Contract terms changed'
|
|
6340
6388
|
* });
|
|
6341
6389
|
* ```
|
|
6342
|
-
*
|
|
6343
|
-
* @see https://www.zoho.com/sign/api/document-managment/delete-document.html
|
|
6344
6390
|
*/ function zohoSignDeleteDocument(context) {
|
|
6345
6391
|
return function(param) {
|
|
6346
6392
|
var requestId = param.requestId, recall_inprogress = param.recall_inprogress, reason = param.reason;
|
|
@@ -6368,17 +6414,22 @@ var ZOHO_SIGN_SERVICE_NAME = 'sign';
|
|
|
6368
6414
|
/**
|
|
6369
6415
|
* Resolves an environment key or passthrough URL to the full Zoho Sign API URL.
|
|
6370
6416
|
*
|
|
6371
|
-
* @param input - An environment key ('sandbox' or 'production') or a full API URL
|
|
6372
|
-
* @returns The resolved Zoho Sign API URL
|
|
6417
|
+
* @param input - An environment key ('sandbox' or 'production') or a full API URL.
|
|
6418
|
+
* @returns The resolved Zoho Sign API URL.
|
|
6373
6419
|
*/ function zohoSignConfigApiUrl(input) {
|
|
6420
|
+
var result;
|
|
6374
6421
|
switch(input){
|
|
6375
6422
|
case 'sandbox':
|
|
6376
|
-
|
|
6423
|
+
result = 'https://signsandbox.zoho.com/api/v1';
|
|
6424
|
+
break;
|
|
6377
6425
|
case 'production':
|
|
6378
|
-
|
|
6426
|
+
result = 'https://sign.zoho.com/api/v1';
|
|
6427
|
+
break;
|
|
6379
6428
|
default:
|
|
6380
|
-
|
|
6429
|
+
result = input;
|
|
6430
|
+
break;
|
|
6381
6431
|
}
|
|
6432
|
+
return result;
|
|
6382
6433
|
}
|
|
6383
6434
|
|
|
6384
6435
|
function asyncGeneratorStep$4(gen, resolve, reject, _next, _throw, key, arg) {
|
|
@@ -6515,8 +6566,8 @@ var logZohoSignErrorToConsole = logZohoServerErrorFunction('ZohoSign', {
|
|
|
6515
6566
|
/**
|
|
6516
6567
|
* Parses the JSON body of a failed Zoho Sign fetch response into a structured error, returning undefined if the body cannot be parsed.
|
|
6517
6568
|
*
|
|
6518
|
-
* @param responseError - The fetch response error to parse
|
|
6519
|
-
* @returns Parsed Zoho server error, or undefined if parsing fails
|
|
6569
|
+
* @param responseError - The fetch response error to parse.
|
|
6570
|
+
* @returns Parsed Zoho server error, or undefined if parsing fails.
|
|
6520
6571
|
*/ function parseZohoSignError(responseError) {
|
|
6521
6572
|
return _async_to_generator$4(function() {
|
|
6522
6573
|
var data, result;
|
|
@@ -6545,9 +6596,9 @@ var logZohoSignErrorToConsole = logZohoServerErrorFunction('ZohoSign', {
|
|
|
6545
6596
|
/**
|
|
6546
6597
|
* 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.
|
|
6547
6598
|
*
|
|
6548
|
-
* @param errorResponseData - Raw error response data from the Zoho Sign API
|
|
6549
|
-
* @param responseError - The underlying fetch response error
|
|
6550
|
-
* @returns Parsed Zoho server error, or undefined if the data contains no recognizable error
|
|
6599
|
+
* @param errorResponseData - Raw error response data from the Zoho Sign API.
|
|
6600
|
+
* @param responseError - The underlying fetch response error.
|
|
6601
|
+
* @returns Parsed Zoho server error, or undefined if the data contains no recognizable error.
|
|
6551
6602
|
*/ function parseZohoSignServerErrorResponseData(errorResponseData, responseError) {
|
|
6552
6603
|
var result;
|
|
6553
6604
|
var error = tryFindZohoServerErrorData(errorResponseData, responseError);
|
|
@@ -6756,8 +6807,8 @@ function _ts_generator$3(thisArg, body) {
|
|
|
6756
6807
|
* Each client handles OAuth token refresh on {@link ZohoInvalidTokenError}, rate limiting,
|
|
6757
6808
|
* and Zoho Sign's non-standard error responses (200 status with error body).
|
|
6758
6809
|
*
|
|
6759
|
-
* @param factoryConfig - Configuration providing account credentials and optional overrides
|
|
6760
|
-
* @returns A factory function that creates authenticated Zoho Sign clients
|
|
6810
|
+
* @param factoryConfig - Configuration providing account credentials and optional overrides.
|
|
6811
|
+
* @returns A factory function that creates authenticated Zoho Sign clients.
|
|
6761
6812
|
*
|
|
6762
6813
|
* @example
|
|
6763
6814
|
* ```typescript
|
|
@@ -6772,6 +6823,7 @@ function _ts_generator$3(thisArg, body) {
|
|
|
6772
6823
|
* // Use the sign context for API calls:
|
|
6773
6824
|
* const { signContext } = zohoSign;
|
|
6774
6825
|
* ```
|
|
6826
|
+
*
|
|
6775
6827
|
* @__NO_SIDE_EFFECTS__
|
|
6776
6828
|
*/ function zohoSignFactory(factoryConfig) {
|
|
6777
6829
|
var accountsContext = factoryConfig.accountsContext;
|
|
@@ -6852,8 +6904,8 @@ function _ts_generator$3(thisArg, body) {
|
|
|
6852
6904
|
* Resolves a Desk API URL input to its full base URL. The 'production' key maps to the
|
|
6853
6905
|
* primary Zoho Desk endpoint; custom URLs pass through unchanged.
|
|
6854
6906
|
*
|
|
6855
|
-
* @param input - A well-known environment key or a custom Desk API URL
|
|
6856
|
-
* @returns The resolved full Zoho Desk API base URL
|
|
6907
|
+
* @param input - A well-known environment key or a custom Desk API URL.
|
|
6908
|
+
* @returns The resolved full Zoho Desk API base URL.
|
|
6857
6909
|
*/ function zohoDeskConfigApiUrl(input) {
|
|
6858
6910
|
var result;
|
|
6859
6911
|
switch(input){
|
|
@@ -7005,8 +7057,8 @@ function _ts_generator$2(thisArg, body) {
|
|
|
7005
7057
|
/**
|
|
7006
7058
|
* Parses a fetch response error into a typed Zoho Desk server error by extracting and interpreting the JSON error body.
|
|
7007
7059
|
*
|
|
7008
|
-
* @param responseError - The fetch response error to parse
|
|
7009
|
-
* @returns The parsed Zoho server error, or undefined if the response could not be parsed
|
|
7060
|
+
* @param responseError - The fetch response error to parse.
|
|
7061
|
+
* @returns The parsed Zoho server error, or undefined if the response could not be parsed.
|
|
7010
7062
|
*/ function parseZohoDeskError(responseError) {
|
|
7011
7063
|
return _async_to_generator$2(function() {
|
|
7012
7064
|
var data, result;
|
|
@@ -7036,9 +7088,9 @@ function _ts_generator$2(thisArg, body) {
|
|
|
7036
7088
|
* Parses a Zoho Desk error response body into a typed error. Delegates to Desk-specific
|
|
7037
7089
|
* error code handling before falling back to the generic Zoho error parser.
|
|
7038
7090
|
*
|
|
7039
|
-
* @param errorResponseData - The raw error response data from the Zoho Desk API
|
|
7040
|
-
* @param responseError - The original fetch response error for context
|
|
7041
|
-
* @returns The parsed Zoho server error, or undefined if the error could not be classified
|
|
7091
|
+
* @param errorResponseData - The raw error response data from the Zoho Desk API.
|
|
7092
|
+
* @param responseError - The original fetch response error for context.
|
|
7093
|
+
* @returns The parsed Zoho server error, or undefined if the error could not be classified.
|
|
7042
7094
|
*/ function parseZohoDeskServerErrorResponseData(errorResponseData, responseError) {
|
|
7043
7095
|
var result;
|
|
7044
7096
|
var error = tryFindZohoServerErrorData(errorResponseData, responseError);
|
|
@@ -7128,8 +7180,8 @@ function _object_spread_props$a(target, source) {
|
|
|
7128
7180
|
* Desk uses a credit-based system with `X-Rate-Limit-Remaining-v3` and `Retry-After` (in seconds)
|
|
7129
7181
|
* rather than the `X-RATELIMIT-*` headers used by CRM/Recruit/Sign.
|
|
7130
7182
|
*
|
|
7131
|
-
* @param headers - HTTP response headers from a Zoho Desk API call
|
|
7132
|
-
* @returns Parsed rate limit details, or null if the Desk rate limit headers are absent
|
|
7183
|
+
* @param headers - HTTP response headers from a Zoho Desk API call.
|
|
7184
|
+
* @returns Parsed rate limit details, or null if the Desk rate limit headers are absent.
|
|
7133
7185
|
*/ function zohoDeskRateLimitDetailsReader(headers) {
|
|
7134
7186
|
var remainingHeader = headers.get(ZOHO_DESK_RATE_LIMIT_REMAINING_HEADER);
|
|
7135
7187
|
var result;
|
|
@@ -7159,7 +7211,7 @@ function _object_spread_props$a(target, source) {
|
|
|
7159
7211
|
* with the Desk-specific header reader. Unlike CRM, Desk does not provide a total limit header,
|
|
7160
7212
|
* so the configured `maxRateLimit` (defaulting to {@link DEFAULT_ZOHO_DESK_API_RATE_LIMIT}) is used throughout.
|
|
7161
7213
|
*
|
|
7162
|
-
* @param config - Optional configuration for rate limit, reset period, and 429 handling
|
|
7214
|
+
* @param config - Optional configuration for rate limit, reset period, and 429 handling.
|
|
7163
7215
|
* @returns A rate-limited fetch handler with the underlying rate limiter accessible via `_rateLimiter`
|
|
7164
7216
|
*/ function zohoDeskRateLimitedFetchHandler(config) {
|
|
7165
7217
|
return makeZohoRateLimitedFetchHandler(_object_spread_props$a(_object_spread$a({
|
|
@@ -7363,8 +7415,9 @@ function _ts_generator$1(thisArg, body) {
|
|
|
7363
7415
|
* Unlike CRM/Recruit/Sign, the Desk API requires an `orgId` header on every request.
|
|
7364
7416
|
* This is injected automatically from the config.
|
|
7365
7417
|
*
|
|
7366
|
-
* @param factoryConfig - Configuration providing account credentials and optional overrides
|
|
7367
|
-
* @returns A factory function that creates authenticated Zoho Desk clients
|
|
7418
|
+
* @param factoryConfig - Configuration providing account credentials and optional overrides.
|
|
7419
|
+
* @returns A factory function that creates authenticated Zoho Desk clients.
|
|
7420
|
+
*
|
|
7368
7421
|
* @__NO_SIDE_EFFECTS__
|
|
7369
7422
|
*/ function zohoDeskFactory(factoryConfig) {
|
|
7370
7423
|
var accountsContext = factoryConfig.accountsContext;
|
|
@@ -7495,7 +7548,7 @@ function _object_spread_props$8(target, source) {
|
|
|
7495
7548
|
*/ var ZOHO_DESK_MAX_PAGE_LIMIT = 50;
|
|
7496
7549
|
/**
|
|
7497
7550
|
* Default number of records per page for Zoho Desk list endpoints.
|
|
7498
|
-
*/ var
|
|
7551
|
+
*/ var DEFAULT_ZOHO_DESK_PAGE_LIMIT = 25;
|
|
7499
7552
|
/**
|
|
7500
7553
|
* Creates a page factory that wraps a Zoho Desk fetch function with automatic offset-based pagination.
|
|
7501
7554
|
*
|
|
@@ -7503,9 +7556,9 @@ function _object_spread_props$8(target, source) {
|
|
|
7503
7556
|
* against the requested `limit`. If `data.length >= limit`, more records are assumed to exist.
|
|
7504
7557
|
* The `from` offset is automatically advanced by `limit` for subsequent requests.
|
|
7505
7558
|
*
|
|
7506
|
-
* @param fetch - The Zoho Desk fetch function to paginate over
|
|
7507
|
-
* @param defaults - Optional default configuration for the page factory
|
|
7508
|
-
* @returns A page factory that produces iterable page fetchers
|
|
7559
|
+
* @param fetch - The Zoho Desk fetch function to paginate over.
|
|
7560
|
+
* @param defaults - Optional default configuration for the page factory.
|
|
7561
|
+
* @returns A page factory that produces iterable page fetchers.
|
|
7509
7562
|
*
|
|
7510
7563
|
* @example
|
|
7511
7564
|
* ```typescript
|
|
@@ -7518,6 +7571,7 @@ function _object_spread_props$8(target, source) {
|
|
|
7518
7571
|
* const secondPage = await firstPage.fetchNext();
|
|
7519
7572
|
* }
|
|
7520
7573
|
* ```
|
|
7574
|
+
*
|
|
7521
7575
|
* @__NO_SIDE_EFFECTS__
|
|
7522
7576
|
*/ function zohoDeskFetchPageFactory(fetch, defaults) {
|
|
7523
7577
|
return fetchPageFactory(_object_spread_props$8(_object_spread$8({}, defaults), {
|
|
@@ -7527,12 +7581,12 @@ function _object_spread_props$8(target, source) {
|
|
|
7527
7581
|
var _result_data;
|
|
7528
7582
|
var dataLength = (_ref = (_result_data = result.data) === null || _result_data === void 0 ? void 0 : _result_data.length) !== null && _ref !== void 0 ? _ref : 0;
|
|
7529
7583
|
return {
|
|
7530
|
-
hasNext: dataLength > 0 && dataLength >=
|
|
7584
|
+
hasNext: dataLength > 0 && dataLength >= DEFAULT_ZOHO_DESK_PAGE_LIMIT
|
|
7531
7585
|
};
|
|
7532
7586
|
},
|
|
7533
7587
|
buildInputForNextPage: function buildInputForNextPage(pageResult, input, options) {
|
|
7534
7588
|
var _ref, _options_maxItemsPerPage, _input_from;
|
|
7535
|
-
var limit = (_ref = (_options_maxItemsPerPage = options.maxItemsPerPage) !== null && _options_maxItemsPerPage !== void 0 ? _options_maxItemsPerPage : input.limit) !== null && _ref !== void 0 ? _ref :
|
|
7589
|
+
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;
|
|
7536
7590
|
var previousFrom = (_input_from = input.from) !== null && _input_from !== void 0 ? _input_from : 1;
|
|
7537
7591
|
var nextFrom = previousFrom + limit;
|
|
7538
7592
|
return _object_spread_props$8(_object_spread$8({}, input), {
|
|
@@ -7630,9 +7684,9 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7630
7684
|
/**
|
|
7631
7685
|
* Constructs the standard FetchJsonInput used by Desk API calls, pairing the HTTP method with an optional body.
|
|
7632
7686
|
*
|
|
7633
|
-
* @param method - HTTP method to use for the request
|
|
7634
|
-
* @param body - Optional request body to include
|
|
7635
|
-
* @returns Configured fetch input for the Zoho Desk API call
|
|
7687
|
+
* @param method - HTTP method to use for the request.
|
|
7688
|
+
* @param body - Optional request body to include.
|
|
7689
|
+
* @returns Configured fetch input for the Zoho Desk API call.
|
|
7636
7690
|
*/ function zohoDeskApiFetchJsonInput(method, body) {
|
|
7637
7691
|
return {
|
|
7638
7692
|
method: method,
|
|
@@ -7642,9 +7696,9 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7642
7696
|
/**
|
|
7643
7697
|
* Builds URL search params from the input objects, omitting keys that are used in the URL path.
|
|
7644
7698
|
*
|
|
7645
|
-
* @param input - One or more objects to convert into URL search parameters
|
|
7646
|
-
* @param omitKeys - Keys to exclude from the search params
|
|
7647
|
-
* @returns URL search params string
|
|
7699
|
+
* @param input - One or more objects to convert into URL search parameters.
|
|
7700
|
+
* @param omitKeys - Keys to exclude from the search params.
|
|
7701
|
+
* @returns URL search params string.
|
|
7648
7702
|
*/ function zohoDeskUrlSearchParams(input, omitKeys) {
|
|
7649
7703
|
return makeUrlSearchParams(input, {
|
|
7650
7704
|
omitKeys: omitKeys
|
|
@@ -7653,8 +7707,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7653
7707
|
/**
|
|
7654
7708
|
* Joins include values into a comma-separated string.
|
|
7655
7709
|
*
|
|
7656
|
-
* @param include - Single or array of include values
|
|
7657
|
-
* @returns Comma-separated string, or undefined if no values provided
|
|
7710
|
+
* @param include - Single or array of include values.
|
|
7711
|
+
* @returns Comma-separated string, or undefined if no values provided.
|
|
7658
7712
|
*/ function joinInclude(include) {
|
|
7659
7713
|
var result;
|
|
7660
7714
|
if (include) {
|
|
@@ -7668,8 +7722,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7668
7722
|
* Retrieves a paginated list of tickets from Zoho Desk, with optional filtering by
|
|
7669
7723
|
* department, status, priority, channel, assignee, and view.
|
|
7670
7724
|
*
|
|
7671
|
-
* @param context - Authenticated Zoho Desk context
|
|
7672
|
-
* @returns Function that retrieves paginated tickets
|
|
7725
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7726
|
+
* @returns Function that retrieves paginated tickets.
|
|
7673
7727
|
*/ function zohoDeskGetTickets(context) {
|
|
7674
7728
|
return function(input) {
|
|
7675
7729
|
var include = input.include, rest = _object_without_properties$7(input, [
|
|
@@ -7692,8 +7746,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7692
7746
|
*
|
|
7693
7747
|
* Retrieves a single ticket by its ID, with optional inline expansion of related entities.
|
|
7694
7748
|
*
|
|
7695
|
-
* @param context - Authenticated Zoho Desk context
|
|
7696
|
-
* @returns Function that retrieves a single ticket
|
|
7749
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7750
|
+
* @returns Function that retrieves a single ticket.
|
|
7697
7751
|
*/ function zohoDeskGetTicketById(context) {
|
|
7698
7752
|
return function(input) {
|
|
7699
7753
|
var ticketId = input.ticketId, include = input.include;
|
|
@@ -7713,8 +7767,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7713
7767
|
* Searches for tickets matching the given filter criteria. Supports filtering by
|
|
7714
7768
|
* many fields including subject, email, status, priority, date ranges, and custom fields.
|
|
7715
7769
|
*
|
|
7716
|
-
* @param context - Authenticated Zoho Desk context
|
|
7717
|
-
* @returns Function that searches for tickets
|
|
7770
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7771
|
+
* @returns Function that searches for tickets.
|
|
7718
7772
|
*/ function zohoDeskSearchTickets(context) {
|
|
7719
7773
|
return function(input) {
|
|
7720
7774
|
var params = zohoDeskUrlSearchParams([
|
|
@@ -7730,8 +7784,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7730
7784
|
/**
|
|
7731
7785
|
* Creates a {@link ZohoDeskGetTicketsForContactFunction} bound to the given context.
|
|
7732
7786
|
*
|
|
7733
|
-
* @param context - Authenticated Zoho Desk context
|
|
7734
|
-
* @returns Function that retrieves tickets for a contact
|
|
7787
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7788
|
+
* @returns Function that retrieves tickets for a contact.
|
|
7735
7789
|
*/ function zohoDeskGetTicketsForContact(context) {
|
|
7736
7790
|
return function(input) {
|
|
7737
7791
|
var contactId = input.contactId, include = input.include, rest = _object_without_properties$7(input, [
|
|
@@ -7753,8 +7807,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7753
7807
|
/**
|
|
7754
7808
|
* Creates a {@link ZohoDeskGetTicketsForProductFunction} bound to the given context.
|
|
7755
7809
|
*
|
|
7756
|
-
* @param context - Authenticated Zoho Desk context
|
|
7757
|
-
* @returns Function that retrieves tickets for a product
|
|
7810
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7811
|
+
* @returns Function that retrieves tickets for a product.
|
|
7758
7812
|
*/ function zohoDeskGetTicketsForProduct(context) {
|
|
7759
7813
|
return function(input) {
|
|
7760
7814
|
var productId = input.productId, include = input.include, rest = _object_without_properties$7(input, [
|
|
@@ -7776,8 +7830,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7776
7830
|
/**
|
|
7777
7831
|
* Creates a {@link ZohoDeskGetTicketMetricsFunction} bound to the given context.
|
|
7778
7832
|
*
|
|
7779
|
-
* @param context - Authenticated Zoho Desk context
|
|
7780
|
-
* @returns Function that retrieves ticket metrics
|
|
7833
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7834
|
+
* @returns Function that retrieves ticket metrics.
|
|
7781
7835
|
*/ function zohoDeskGetTicketMetrics(context) {
|
|
7782
7836
|
return function(input) {
|
|
7783
7837
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/metrics"), zohoDeskApiFetchJsonInput('GET'));
|
|
@@ -7786,8 +7840,8 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7786
7840
|
/**
|
|
7787
7841
|
* Creates a {@link ZohoDeskGetAgentsTicketsCountFunction} bound to the given context.
|
|
7788
7842
|
*
|
|
7789
|
-
* @param context - Authenticated Zoho Desk context
|
|
7790
|
-
* @returns Function that retrieves agent ticket counts
|
|
7843
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7844
|
+
* @returns Function that retrieves agent ticket counts.
|
|
7791
7845
|
*/ function zohoDeskGetAgentsTicketsCount(context) {
|
|
7792
7846
|
return function(input) {
|
|
7793
7847
|
var params = zohoDeskUrlSearchParams([
|
|
@@ -7805,8 +7859,9 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7805
7859
|
* Returns a page factory that automatically handles Zoho Desk's offset-based pagination,
|
|
7806
7860
|
* making it easy to iterate through all tickets across multiple pages.
|
|
7807
7861
|
*
|
|
7808
|
-
* @param context - Authenticated Zoho Desk context
|
|
7809
|
-
* @returns Page factory for iterating over ticket results
|
|
7862
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7863
|
+
* @returns Page factory for iterating over ticket results.
|
|
7864
|
+
*
|
|
7810
7865
|
* @__NO_SIDE_EFFECTS__
|
|
7811
7866
|
*/ function zohoDeskGetTicketsPageFactory(context) {
|
|
7812
7867
|
return zohoDeskFetchPageFactory(zohoDeskGetTickets(context));
|
|
@@ -7814,8 +7869,9 @@ function _object_without_properties_loose$7(source, excluded) {
|
|
|
7814
7869
|
/**
|
|
7815
7870
|
* Creates a {@link ZohoDeskSearchTicketsPageFactory} bound to the given context.
|
|
7816
7871
|
*
|
|
7817
|
-
* @param context - Authenticated Zoho Desk context
|
|
7818
|
-
* @returns Page factory for iterating over search results
|
|
7872
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7873
|
+
* @returns Page factory for iterating over search results.
|
|
7874
|
+
*
|
|
7819
7875
|
* @__NO_SIDE_EFFECTS__
|
|
7820
7876
|
*/ function zohoDeskSearchTicketsPageFactory(context) {
|
|
7821
7877
|
return zohoDeskFetchPageFactory(zohoDeskSearchTickets(context));
|
|
@@ -7833,8 +7889,8 @@ function zohoDeskDepartmentApiFetchJsonInput(method) {
|
|
|
7833
7889
|
* Retrieves a paginated list of departments from Zoho Desk, with optional filtering
|
|
7834
7890
|
* by chat status, search string, and enabled state.
|
|
7835
7891
|
*
|
|
7836
|
-
* @param context - Authenticated Zoho Desk context
|
|
7837
|
-
* @returns Function that retrieves paginated departments
|
|
7892
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7893
|
+
* @returns Function that retrieves paginated departments.
|
|
7838
7894
|
*/ function zohoDeskGetDepartments(context) {
|
|
7839
7895
|
return function(input) {
|
|
7840
7896
|
var params = makeUrlSearchParams([
|
|
@@ -7850,8 +7906,8 @@ function zohoDeskDepartmentApiFetchJsonInput(method) {
|
|
|
7850
7906
|
/**
|
|
7851
7907
|
* Creates a {@link ZohoDeskGetDepartmentByIdFunction} bound to the given context.
|
|
7852
7908
|
*
|
|
7853
|
-
* @param context - Authenticated Zoho Desk context
|
|
7854
|
-
* @returns Function that retrieves a single department
|
|
7909
|
+
* @param context - Authenticated Zoho Desk context.
|
|
7910
|
+
* @returns Function that retrieves a single department.
|
|
7855
7911
|
*/ function zohoDeskGetDepartmentById(context) {
|
|
7856
7912
|
return function(input) {
|
|
7857
7913
|
return context.fetchJson("/departments/".concat(input.departmentId), zohoDeskDepartmentApiFetchJsonInput('GET'));
|
|
@@ -7950,8 +8006,8 @@ function zohoDeskContactApiFetchJsonInput(method) {
|
|
|
7950
8006
|
/**
|
|
7951
8007
|
* Joins include values into a comma-separated string.
|
|
7952
8008
|
*
|
|
7953
|
-
* @param include - Single or array of include values
|
|
7954
|
-
* @returns Comma-separated string, or undefined if no values provided
|
|
8009
|
+
* @param include - Single or array of include values.
|
|
8010
|
+
* @returns Comma-separated string, or undefined if no values provided.
|
|
7955
8011
|
*/ function joinContactInclude(include) {
|
|
7956
8012
|
var result;
|
|
7957
8013
|
if (include) {
|
|
@@ -7965,8 +8021,8 @@ function zohoDeskContactApiFetchJsonInput(method) {
|
|
|
7965
8021
|
* Retrieves a paginated list of contacts from Zoho Desk, with optional sorting,
|
|
7966
8022
|
* inline expansion of related entities, and custom view filtering.
|
|
7967
8023
|
*
|
|
7968
|
-
* @param context - Authenticated Zoho Desk context
|
|
7969
|
-
* @returns Function that retrieves paginated contacts
|
|
8024
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8025
|
+
* @returns Function that retrieves paginated contacts.
|
|
7970
8026
|
*/ function zohoDeskGetContacts(context) {
|
|
7971
8027
|
return function(input) {
|
|
7972
8028
|
var include = input.include, rest = _object_without_properties$6(input, [
|
|
@@ -7987,8 +8043,8 @@ function zohoDeskContactApiFetchJsonInput(method) {
|
|
|
7987
8043
|
/**
|
|
7988
8044
|
* Creates a {@link ZohoDeskGetContactByIdFunction} bound to the given context.
|
|
7989
8045
|
*
|
|
7990
|
-
* @param context - Authenticated Zoho Desk context
|
|
7991
|
-
* @returns Function that retrieves a single contact
|
|
8046
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8047
|
+
* @returns Function that retrieves a single contact.
|
|
7992
8048
|
*/ function zohoDeskGetContactById(context) {
|
|
7993
8049
|
return function(input) {
|
|
7994
8050
|
var contactId = input.contactId, include = input.include;
|
|
@@ -8007,8 +8063,8 @@ function zohoDeskContactApiFetchJsonInput(method) {
|
|
|
8007
8063
|
*
|
|
8008
8064
|
* Retrieves multiple contacts in a single request by providing their IDs.
|
|
8009
8065
|
*
|
|
8010
|
-
* @param context - Authenticated Zoho Desk context
|
|
8011
|
-
* @returns Function that retrieves contacts by IDs
|
|
8066
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8067
|
+
* @returns Function that retrieves contacts by IDs.
|
|
8012
8068
|
*/ function zohoDeskGetContactsByIds(context) {
|
|
8013
8069
|
return function(input) {
|
|
8014
8070
|
var params = makeUrlSearchParams([
|
|
@@ -8024,8 +8080,9 @@ function zohoDeskContactApiFetchJsonInput(method) {
|
|
|
8024
8080
|
/**
|
|
8025
8081
|
* Creates a {@link ZohoDeskGetContactsPageFactory} bound to the given context.
|
|
8026
8082
|
*
|
|
8027
|
-
* @param context - Authenticated Zoho Desk context
|
|
8028
|
-
* @returns Page factory for iterating over contact results
|
|
8083
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8084
|
+
* @returns Page factory for iterating over contact results.
|
|
8085
|
+
*
|
|
8029
8086
|
* @__NO_SIDE_EFFECTS__
|
|
8030
8087
|
*/ function zohoDeskGetContactsPageFactory(context) {
|
|
8031
8088
|
return zohoDeskFetchPageFactory(zohoDeskGetContacts(context));
|
|
@@ -8041,8 +8098,8 @@ function zohoDeskTagApiFetchJsonInput(method, body) {
|
|
|
8041
8098
|
/**
|
|
8042
8099
|
* Creates a {@link ZohoDeskGetTicketTagsFunction} bound to the given context.
|
|
8043
8100
|
*
|
|
8044
|
-
* @param context - Authenticated Zoho Desk context
|
|
8045
|
-
* @returns Function that retrieves tags for a ticket
|
|
8101
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8102
|
+
* @returns Function that retrieves tags for a ticket.
|
|
8046
8103
|
*/ function zohoDeskGetTicketTags(context) {
|
|
8047
8104
|
return function(input) {
|
|
8048
8105
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/tags"), zohoDeskTagApiFetchJsonInput('GET')).then(function(x) {
|
|
@@ -8055,8 +8112,8 @@ function zohoDeskTagApiFetchJsonInput(method, body) {
|
|
|
8055
8112
|
*
|
|
8056
8113
|
* Associates one or more tags with a ticket. If the tag does not exist, it will be created.
|
|
8057
8114
|
*
|
|
8058
|
-
* @param context - Authenticated Zoho Desk context
|
|
8059
|
-
* @returns Function that associates tags with a ticket
|
|
8115
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8116
|
+
* @returns Function that associates tags with a ticket.
|
|
8060
8117
|
*/ function zohoDeskAssociateTicketTags(context) {
|
|
8061
8118
|
return function(input) {
|
|
8062
8119
|
var body = {
|
|
@@ -8074,8 +8131,8 @@ function zohoDeskTagApiFetchJsonInput(method, body) {
|
|
|
8074
8131
|
/**
|
|
8075
8132
|
* Creates a {@link ZohoDeskDissociateTicketTagFunction} bound to the given context.
|
|
8076
8133
|
*
|
|
8077
|
-
* @param context - Authenticated Zoho Desk context
|
|
8078
|
-
* @returns Function that removes a tag from a ticket
|
|
8134
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8135
|
+
* @returns Function that removes a tag from a ticket.
|
|
8079
8136
|
*/ function zohoDeskDissociateTicketTag(context) {
|
|
8080
8137
|
return function(input) {
|
|
8081
8138
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/tags/").concat(input.tagId), zohoDeskTagApiFetchJsonInput('DELETE'));
|
|
@@ -8084,8 +8141,8 @@ function zohoDeskTagApiFetchJsonInput(method, body) {
|
|
|
8084
8141
|
/**
|
|
8085
8142
|
* Creates a {@link ZohoDeskSearchTagsFunction} bound to the given context.
|
|
8086
8143
|
*
|
|
8087
|
-
* @param context - Authenticated Zoho Desk context
|
|
8088
|
-
* @returns Function that searches for tags
|
|
8144
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8145
|
+
* @returns Function that searches for tags.
|
|
8089
8146
|
*/ function zohoDeskSearchTags(context) {
|
|
8090
8147
|
return function(input) {
|
|
8091
8148
|
var params = makeUrlSearchParams([
|
|
@@ -8101,8 +8158,8 @@ function zohoDeskTagApiFetchJsonInput(method, body) {
|
|
|
8101
8158
|
/**
|
|
8102
8159
|
* Creates a {@link ZohoDeskGetAllTagsFunction} bound to the given context.
|
|
8103
8160
|
*
|
|
8104
|
-
* @param context - Authenticated Zoho Desk context
|
|
8105
|
-
* @returns Function that retrieves all tags
|
|
8161
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8162
|
+
* @returns Function that retrieves all tags.
|
|
8106
8163
|
*/ function zohoDeskGetAllTags(context) {
|
|
8107
8164
|
return function(input) {
|
|
8108
8165
|
var params = makeUrlSearchParams([
|
|
@@ -8126,8 +8183,8 @@ function zohoDeskFollowerApiFetchJsonInput(method, body) {
|
|
|
8126
8183
|
/**
|
|
8127
8184
|
* Creates a {@link ZohoDeskGetTicketFollowersFunction} bound to the given context.
|
|
8128
8185
|
*
|
|
8129
|
-
* @param context - Authenticated Zoho Desk context
|
|
8130
|
-
* @returns Function that retrieves followers for a ticket
|
|
8186
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8187
|
+
* @returns Function that retrieves followers for a ticket.
|
|
8131
8188
|
*/ function zohoDeskGetTicketFollowers(context) {
|
|
8132
8189
|
return function(input) {
|
|
8133
8190
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/followers"), zohoDeskFollowerApiFetchJsonInput('GET')).then(function(x) {
|
|
@@ -8138,8 +8195,8 @@ function zohoDeskFollowerApiFetchJsonInput(method, body) {
|
|
|
8138
8195
|
/**
|
|
8139
8196
|
* Creates a {@link ZohoDeskAddTicketFollowersFunction} bound to the given context.
|
|
8140
8197
|
*
|
|
8141
|
-
* @param context - Authenticated Zoho Desk context
|
|
8142
|
-
* @returns Function that adds followers to a ticket
|
|
8198
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8199
|
+
* @returns Function that adds followers to a ticket.
|
|
8143
8200
|
*/ function zohoDeskAddTicketFollowers(context) {
|
|
8144
8201
|
return function(input) {
|
|
8145
8202
|
var body = {
|
|
@@ -8151,8 +8208,8 @@ function zohoDeskFollowerApiFetchJsonInput(method, body) {
|
|
|
8151
8208
|
/**
|
|
8152
8209
|
* Creates a {@link ZohoDeskRemoveTicketFollowersFunction} bound to the given context.
|
|
8153
8210
|
*
|
|
8154
|
-
* @param context - Authenticated Zoho Desk context
|
|
8155
|
-
* @returns Function that removes followers from a ticket
|
|
8211
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8212
|
+
* @returns Function that removes followers from a ticket.
|
|
8156
8213
|
*/ function zohoDeskRemoveTicketFollowers(context) {
|
|
8157
8214
|
return function(input) {
|
|
8158
8215
|
var body = {
|
|
@@ -8262,8 +8319,8 @@ function joinAttachmentInclude(include) {
|
|
|
8262
8319
|
/**
|
|
8263
8320
|
* Creates a {@link ZohoDeskGetTicketAttachmentsFunction} bound to the given context.
|
|
8264
8321
|
*
|
|
8265
|
-
* @param context - Authenticated Zoho Desk context
|
|
8266
|
-
* @returns Function that retrieves attachments for a ticket
|
|
8322
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8323
|
+
* @returns Function that retrieves attachments for a ticket.
|
|
8267
8324
|
*/ function zohoDeskGetTicketAttachments(context) {
|
|
8268
8325
|
return function(input) {
|
|
8269
8326
|
var ticketId = input.ticketId, include = input.include, rest = _object_without_properties$5(input, [
|
|
@@ -8285,8 +8342,8 @@ function joinAttachmentInclude(include) {
|
|
|
8285
8342
|
/**
|
|
8286
8343
|
* Creates a {@link ZohoDeskDeleteTicketAttachmentFunction} bound to the given context.
|
|
8287
8344
|
*
|
|
8288
|
-
* @param context - Authenticated Zoho Desk context
|
|
8289
|
-
* @returns Function that deletes a ticket attachment
|
|
8345
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8346
|
+
* @returns Function that deletes a ticket attachment.
|
|
8290
8347
|
*/ function zohoDeskDeleteTicketAttachment(context) {
|
|
8291
8348
|
return function(input) {
|
|
8292
8349
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/attachments/").concat(input.attachmentId), zohoDeskAttachmentApiFetchJsonInput('DELETE'));
|
|
@@ -8393,8 +8450,8 @@ function joinCommentInclude(include) {
|
|
|
8393
8450
|
/**
|
|
8394
8451
|
* Creates a {@link ZohoDeskGetTicketCommentsFunction} bound to the given context.
|
|
8395
8452
|
*
|
|
8396
|
-
* @param context - Authenticated Zoho Desk context
|
|
8397
|
-
* @returns Function that retrieves comments for a ticket
|
|
8453
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8454
|
+
* @returns Function that retrieves comments for a ticket.
|
|
8398
8455
|
*/ function zohoDeskGetTicketComments(context) {
|
|
8399
8456
|
return function(input) {
|
|
8400
8457
|
var ticketId = input.ticketId, include = input.include, rest = _object_without_properties$4(input, [
|
|
@@ -8416,8 +8473,8 @@ function joinCommentInclude(include) {
|
|
|
8416
8473
|
/**
|
|
8417
8474
|
* Creates a {@link ZohoDeskGetTicketCommentByIdFunction} bound to the given context.
|
|
8418
8475
|
*
|
|
8419
|
-
* @param context - Authenticated Zoho Desk context
|
|
8420
|
-
* @returns Function that retrieves a single comment
|
|
8476
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8477
|
+
* @returns Function that retrieves a single comment.
|
|
8421
8478
|
*/ function zohoDeskGetTicketCommentById(context) {
|
|
8422
8479
|
return function(input) {
|
|
8423
8480
|
var ticketId = input.ticketId, commentId = input.commentId, include = input.include;
|
|
@@ -8434,8 +8491,8 @@ function joinCommentInclude(include) {
|
|
|
8434
8491
|
/**
|
|
8435
8492
|
* Creates a {@link ZohoDeskCreateTicketCommentFunction} bound to the given context.
|
|
8436
8493
|
*
|
|
8437
|
-
* @param context - Authenticated Zoho Desk context
|
|
8438
|
-
* @returns Function that creates a comment on a ticket
|
|
8494
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8495
|
+
* @returns Function that creates a comment on a ticket.
|
|
8439
8496
|
*/ function zohoDeskCreateTicketComment(context) {
|
|
8440
8497
|
return function(input) {
|
|
8441
8498
|
var ticketId = input.ticketId, body = _object_without_properties$4(input, [
|
|
@@ -8447,8 +8504,8 @@ function joinCommentInclude(include) {
|
|
|
8447
8504
|
/**
|
|
8448
8505
|
* Creates a {@link ZohoDeskDeleteTicketCommentFunction} bound to the given context.
|
|
8449
8506
|
*
|
|
8450
|
-
* @param context - Authenticated Zoho Desk context
|
|
8451
|
-
* @returns Function that deletes a comment from a ticket
|
|
8507
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8508
|
+
* @returns Function that deletes a comment from a ticket.
|
|
8452
8509
|
*/ function zohoDeskDeleteTicketComment(context) {
|
|
8453
8510
|
return function(input) {
|
|
8454
8511
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/comments/").concat(input.commentId), zohoDeskCommentApiFetchJsonInput('DELETE'));
|
|
@@ -8501,8 +8558,8 @@ function zohoDeskTimeApiFetchJsonInput(method, body) {
|
|
|
8501
8558
|
/**
|
|
8502
8559
|
* Creates a {@link ZohoDeskGetTicketTimerFunction} bound to the given context.
|
|
8503
8560
|
*
|
|
8504
|
-
* @param context - Authenticated Zoho Desk context
|
|
8505
|
-
* @returns Function that retrieves the ticket timer
|
|
8561
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8562
|
+
* @returns Function that retrieves the ticket timer.
|
|
8506
8563
|
*/ function zohoDeskGetTicketTimer(context) {
|
|
8507
8564
|
return function(input) {
|
|
8508
8565
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/timer"), zohoDeskTimeApiFetchJsonInput('GET'));
|
|
@@ -8511,8 +8568,8 @@ function zohoDeskTimeApiFetchJsonInput(method, body) {
|
|
|
8511
8568
|
/**
|
|
8512
8569
|
* Creates a {@link ZohoDeskPerformTicketTimerActionFunction} bound to the given context.
|
|
8513
8570
|
*
|
|
8514
|
-
* @param context - Authenticated Zoho Desk context
|
|
8515
|
-
* @returns Function that performs a timer action on a ticket
|
|
8571
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8572
|
+
* @returns Function that performs a timer action on a ticket.
|
|
8516
8573
|
*/ function zohoDeskPerformTicketTimerAction(context) {
|
|
8517
8574
|
return function(input) {
|
|
8518
8575
|
var ticketId = input.ticketId, body = _object_without_properties$3(input, [
|
|
@@ -8524,8 +8581,8 @@ function zohoDeskTimeApiFetchJsonInput(method, body) {
|
|
|
8524
8581
|
/**
|
|
8525
8582
|
* Creates a {@link ZohoDeskGetTicketTimeEntriesFunction} bound to the given context.
|
|
8526
8583
|
*
|
|
8527
|
-
* @param context - Authenticated Zoho Desk context
|
|
8528
|
-
* @returns Function that retrieves time entries for a ticket
|
|
8584
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8585
|
+
* @returns Function that retrieves time entries for a ticket.
|
|
8529
8586
|
*/ function zohoDeskGetTicketTimeEntries(context) {
|
|
8530
8587
|
return function(input) {
|
|
8531
8588
|
var ticketId = input.ticketId, rest = _object_without_properties$3(input, [
|
|
@@ -8544,8 +8601,8 @@ function zohoDeskTimeApiFetchJsonInput(method, body) {
|
|
|
8544
8601
|
/**
|
|
8545
8602
|
* Creates a {@link ZohoDeskGetTicketTimeEntryByIdFunction} bound to the given context.
|
|
8546
8603
|
*
|
|
8547
|
-
* @param context - Authenticated Zoho Desk context
|
|
8548
|
-
* @returns Function that retrieves a single time entry
|
|
8604
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8605
|
+
* @returns Function that retrieves a single time entry.
|
|
8549
8606
|
*/ function zohoDeskGetTicketTimeEntryById(context) {
|
|
8550
8607
|
return function(input) {
|
|
8551
8608
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/timeEntries/").concat(input.timeEntryId), zohoDeskTimeApiFetchJsonInput('GET'));
|
|
@@ -8554,8 +8611,8 @@ function zohoDeskTimeApiFetchJsonInput(method, body) {
|
|
|
8554
8611
|
/**
|
|
8555
8612
|
* Creates a {@link ZohoDeskGetTicketTimeEntrySummationFunction} bound to the given context.
|
|
8556
8613
|
*
|
|
8557
|
-
* @param context - Authenticated Zoho Desk context
|
|
8558
|
-
* @returns Function that retrieves time entry summation
|
|
8614
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8615
|
+
* @returns Function that retrieves time entry summation.
|
|
8559
8616
|
*/ function zohoDeskGetTicketTimeEntrySummation(context) {
|
|
8560
8617
|
return function(input) {
|
|
8561
8618
|
return context.fetchJson("/tickets/".concat(input.ticketId, "/timeEntries/summation"), zohoDeskTimeApiFetchJsonInput('GET'));
|
|
@@ -8663,8 +8720,8 @@ function joinThreadInclude(include) {
|
|
|
8663
8720
|
*
|
|
8664
8721
|
* Retrieves a paginated list of conversation threads (emails, replies, notes) for a ticket.
|
|
8665
8722
|
*
|
|
8666
|
-
* @param context - Authenticated Zoho Desk context
|
|
8667
|
-
* @returns Function that retrieves threads for a ticket
|
|
8723
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8724
|
+
* @returns Function that retrieves threads for a ticket.
|
|
8668
8725
|
*/ function zohoDeskGetTicketThreads(context) {
|
|
8669
8726
|
return function(input) {
|
|
8670
8727
|
var ticketId = input.ticketId, include = input.include, rest = _object_without_properties$2(input, [
|
|
@@ -8686,8 +8743,8 @@ function joinThreadInclude(include) {
|
|
|
8686
8743
|
/**
|
|
8687
8744
|
* Creates a {@link ZohoDeskGetTicketThreadByIdFunction} bound to the given context.
|
|
8688
8745
|
*
|
|
8689
|
-
* @param context - Authenticated Zoho Desk context
|
|
8690
|
-
* @returns Function that retrieves a single thread
|
|
8746
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8747
|
+
* @returns Function that retrieves a single thread.
|
|
8691
8748
|
*/ function zohoDeskGetTicketThreadById(context) {
|
|
8692
8749
|
return function(input) {
|
|
8693
8750
|
var ticketId = input.ticketId, threadId = input.threadId, include = input.include;
|
|
@@ -8704,8 +8761,9 @@ function joinThreadInclude(include) {
|
|
|
8704
8761
|
/**
|
|
8705
8762
|
* Creates a {@link ZohoDeskGetTicketThreadsPageFactory} bound to the given context.
|
|
8706
8763
|
*
|
|
8707
|
-
* @param context - Authenticated Zoho Desk context
|
|
8708
|
-
* @returns Page factory for iterating over thread results
|
|
8764
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8765
|
+
* @returns Page factory for iterating over thread results.
|
|
8766
|
+
*
|
|
8709
8767
|
* @__NO_SIDE_EFFECTS__
|
|
8710
8768
|
*/ function zohoDeskGetTicketThreadsPageFactory(context) {
|
|
8711
8769
|
return zohoDeskFetchPageFactory(zohoDeskGetTicketThreads(context));
|
|
@@ -8812,8 +8870,8 @@ function joinActivityInclude(include) {
|
|
|
8812
8870
|
*
|
|
8813
8871
|
* Retrieves a paginated list of activities (tasks, events, calls) associated with a ticket.
|
|
8814
8872
|
*
|
|
8815
|
-
* @param context - Authenticated Zoho Desk context
|
|
8816
|
-
* @returns Function that retrieves activities for a ticket
|
|
8873
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8874
|
+
* @returns Function that retrieves activities for a ticket.
|
|
8817
8875
|
*/ function zohoDeskGetTicketActivities(context) {
|
|
8818
8876
|
return function(input) {
|
|
8819
8877
|
var ticketId = input.ticketId, include = input.include, rest = _object_without_properties$1(input, [
|
|
@@ -8835,8 +8893,9 @@ function joinActivityInclude(include) {
|
|
|
8835
8893
|
/**
|
|
8836
8894
|
* Creates a {@link ZohoDeskGetTicketActivitiesPageFactory} bound to the given context.
|
|
8837
8895
|
*
|
|
8838
|
-
* @param context - Authenticated Zoho Desk context
|
|
8839
|
-
* @returns Page factory for iterating over activity results
|
|
8896
|
+
* @param context - Authenticated Zoho Desk context.
|
|
8897
|
+
* @returns Page factory for iterating over activity results.
|
|
8898
|
+
*
|
|
8840
8899
|
* @__NO_SIDE_EFFECTS__
|
|
8841
8900
|
*/ function zohoDeskGetTicketActivitiesPageFactory(context) {
|
|
8842
8901
|
return zohoDeskFetchPageFactory(zohoDeskGetTicketActivities(context));
|
|
@@ -8944,8 +9003,8 @@ function joinAgentInclude(include) {
|
|
|
8944
9003
|
* Retrieves a paginated list of agents, with optional filtering by department and status,
|
|
8945
9004
|
* and inline expansion of related entities (role, profile, departments).
|
|
8946
9005
|
*
|
|
8947
|
-
* @param context - Authenticated Zoho Desk context
|
|
8948
|
-
* @returns Function that retrieves paginated agents
|
|
9006
|
+
* @param context - Authenticated Zoho Desk context.
|
|
9007
|
+
* @returns Function that retrieves paginated agents.
|
|
8949
9008
|
*/ function zohoDeskGetAgents(context) {
|
|
8950
9009
|
return function(input) {
|
|
8951
9010
|
var include = input.include, rest = _object_without_properties(input, [
|
|
@@ -8966,8 +9025,8 @@ function joinAgentInclude(include) {
|
|
|
8966
9025
|
/**
|
|
8967
9026
|
* Creates a {@link ZohoDeskGetAgentByIdFunction} bound to the given context.
|
|
8968
9027
|
*
|
|
8969
|
-
* @param context - Authenticated Zoho Desk context
|
|
8970
|
-
* @returns Function that retrieves a single agent
|
|
9028
|
+
* @param context - Authenticated Zoho Desk context.
|
|
9029
|
+
* @returns Function that retrieves a single agent.
|
|
8971
9030
|
*/ function zohoDeskGetAgentById(context) {
|
|
8972
9031
|
return function(input) {
|
|
8973
9032
|
var agentId = input.agentId, include = input.include;
|
|
@@ -8984,8 +9043,8 @@ function joinAgentInclude(include) {
|
|
|
8984
9043
|
/**
|
|
8985
9044
|
* Creates a {@link ZohoDeskGetAgentsByIdsFunction} bound to the given context.
|
|
8986
9045
|
*
|
|
8987
|
-
* @param context - Authenticated Zoho Desk context
|
|
8988
|
-
* @returns Function that retrieves agents by IDs
|
|
9046
|
+
* @param context - Authenticated Zoho Desk context.
|
|
9047
|
+
* @returns Function that retrieves agents by IDs.
|
|
8989
9048
|
*/ function zohoDeskGetAgentsByIds(context) {
|
|
8990
9049
|
return function(input) {
|
|
8991
9050
|
var params = makeUrlSearchParams([
|
|
@@ -9004,8 +9063,8 @@ function joinAgentInclude(include) {
|
|
|
9004
9063
|
*
|
|
9005
9064
|
* Retrieves the profile of the agent associated with the current OAuth token.
|
|
9006
9065
|
*
|
|
9007
|
-
* @param context - Authenticated Zoho Desk context
|
|
9008
|
-
* @returns Function that retrieves the current agent's info
|
|
9066
|
+
* @param context - Authenticated Zoho Desk context.
|
|
9067
|
+
* @returns Function that retrieves the current agent's info.
|
|
9009
9068
|
*/ function zohoDeskGetMyInfo(context) {
|
|
9010
9069
|
return function() {
|
|
9011
9070
|
return context.fetchJson('/myinfo', zohoDeskAgentApiFetchJsonInput('GET'));
|
|
@@ -9014,8 +9073,9 @@ function joinAgentInclude(include) {
|
|
|
9014
9073
|
/**
|
|
9015
9074
|
* Creates a {@link ZohoDeskGetAgentsPageFactory} bound to the given context.
|
|
9016
9075
|
*
|
|
9017
|
-
* @param context - Authenticated Zoho Desk context
|
|
9018
|
-
* @returns Page factory for iterating over agent results
|
|
9076
|
+
* @param context - Authenticated Zoho Desk context.
|
|
9077
|
+
* @returns Page factory for iterating over agent results.
|
|
9078
|
+
*
|
|
9019
9079
|
* @__NO_SIDE_EFFECTS__
|
|
9020
9080
|
*/ function zohoDeskGetAgentsPageFactory(context) {
|
|
9021
9081
|
return zohoDeskFetchPageFactory(zohoDeskGetAgents(context));
|
|
@@ -9028,8 +9088,10 @@ function joinAgentInclude(include) {
|
|
|
9028
9088
|
* The returned function accepts optional overrides for client credentials and refresh token.
|
|
9029
9089
|
* When omitted, values are read from the {@link ZohoAccountsContext}'s config.
|
|
9030
9090
|
*
|
|
9031
|
-
* @param context - Authenticated Zoho Accounts context providing fetch and config
|
|
9032
|
-
* @returns Function that exchanges a refresh token for an access token
|
|
9091
|
+
* @param context - Authenticated Zoho Accounts context providing fetch and config.
|
|
9092
|
+
* @returns Function that exchanges a refresh token for an access token.
|
|
9093
|
+
*
|
|
9094
|
+
* @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token-expiry.html
|
|
9033
9095
|
*
|
|
9034
9096
|
* @example
|
|
9035
9097
|
* ```typescript
|
|
@@ -9044,8 +9106,6 @@ function joinAgentInclude(include) {
|
|
|
9044
9106
|
* refreshToken: 'other-refresh-token'
|
|
9045
9107
|
* });
|
|
9046
9108
|
* ```
|
|
9047
|
-
*
|
|
9048
|
-
* @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token-expiry.html
|
|
9049
9109
|
*/ function zohoAccountsAccessToken(context) {
|
|
9050
9110
|
return function(input) {
|
|
9051
9111
|
var _ref, _ref1;
|
|
@@ -9077,7 +9137,9 @@ function joinAgentInclude(include) {
|
|
|
9077
9137
|
* the initial authorization request.
|
|
9078
9138
|
*
|
|
9079
9139
|
* @param context - Zoho Accounts context providing fetch and config (clientId/clientSecret)
|
|
9080
|
-
* @returns Function that exchanges an authorization code for tokens
|
|
9140
|
+
* @returns Function that exchanges an authorization code for tokens.
|
|
9141
|
+
*
|
|
9142
|
+
* @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token.html
|
|
9081
9143
|
*
|
|
9082
9144
|
* @example
|
|
9083
9145
|
* ```typescript
|
|
@@ -9088,8 +9150,6 @@ function joinAgentInclude(include) {
|
|
|
9088
9150
|
* redirectUri: 'https://myapp.example.com/oauth/callback'
|
|
9089
9151
|
* });
|
|
9090
9152
|
* ```
|
|
9091
|
-
*
|
|
9092
|
-
* @see https://www.zoho.com/accounts/protocol/oauth/web-apps/access-token.html
|
|
9093
9153
|
*/ function zohoAccountsRefreshTokenFromAuthorizationCode(context) {
|
|
9094
9154
|
return function(input) {
|
|
9095
9155
|
var _ref, _ref1;
|
|
@@ -9110,9 +9170,9 @@ function joinAgentInclude(include) {
|
|
|
9110
9170
|
/**
|
|
9111
9171
|
* Constructs a standard {@link FetchJsonInput} for Zoho Accounts API calls with the given HTTP method and optional body.
|
|
9112
9172
|
*
|
|
9113
|
-
* @param method - HTTP method to use for the request
|
|
9114
|
-
* @param body - Optional request body to include
|
|
9115
|
-
* @returns Configured fetch input for the Zoho Accounts API call
|
|
9173
|
+
* @param method - HTTP method to use for the request.
|
|
9174
|
+
* @param body - Optional request body to include.
|
|
9175
|
+
* @returns Configured fetch input for the Zoho Accounts API call.
|
|
9116
9176
|
*/ function zohoAccountsApiFetchJsonInput(method, body) {
|
|
9117
9177
|
return {
|
|
9118
9178
|
method: method,
|
|
@@ -9126,15 +9186,19 @@ function joinAgentInclude(include) {
|
|
|
9126
9186
|
/**
|
|
9127
9187
|
* 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.
|
|
9128
9188
|
*
|
|
9129
|
-
* @param input - A well-known datacenter key or a custom Zoho Accounts API URL
|
|
9130
|
-
* @returns The resolved full Zoho Accounts API base URL
|
|
9189
|
+
* @param input - A well-known datacenter key or a custom Zoho Accounts API URL.
|
|
9190
|
+
* @returns The resolved full Zoho Accounts API base URL.
|
|
9131
9191
|
*/ function zohoAccountsConfigApiUrl(input) {
|
|
9192
|
+
var result;
|
|
9132
9193
|
switch(input){
|
|
9133
9194
|
case 'us':
|
|
9134
|
-
|
|
9195
|
+
result = ZOHO_ACCOUNTS_US_API_URL;
|
|
9196
|
+
break;
|
|
9135
9197
|
default:
|
|
9136
|
-
|
|
9198
|
+
result = input;
|
|
9199
|
+
break;
|
|
9137
9200
|
}
|
|
9201
|
+
return result;
|
|
9138
9202
|
}
|
|
9139
9203
|
|
|
9140
9204
|
function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
|
|
@@ -9323,9 +9387,9 @@ function _ts_generator(thisArg, body) {
|
|
|
9323
9387
|
* The Accounts client is the foundation for CRM, Recruit, and Sign clients, as it provides
|
|
9324
9388
|
* the {@link ZohoAccountsContext} needed for OAuth token management.
|
|
9325
9389
|
*
|
|
9326
|
-
* @param factoryConfig - Configuration providing optional fetch and logging overrides
|
|
9327
|
-
* @returns A factory function that creates authenticated Zoho Accounts clients
|
|
9328
|
-
* @throws {Error} If `refreshToken`, `clientId`, or `clientSecret` are missing from the config
|
|
9390
|
+
* @param factoryConfig - Configuration providing optional fetch and logging overrides.
|
|
9391
|
+
* @returns A factory function that creates authenticated Zoho Accounts clients.
|
|
9392
|
+
* @throws {Error} If `refreshToken`, `clientId`, or `clientSecret` are missing from the config.
|
|
9329
9393
|
*
|
|
9330
9394
|
* @example
|
|
9331
9395
|
* ```typescript
|
|
@@ -9343,6 +9407,7 @@ function _ts_generator(thisArg, body) {
|
|
|
9343
9407
|
* accountsContext: zohoAccounts.accountsContext
|
|
9344
9408
|
* });
|
|
9345
9409
|
* ```
|
|
9410
|
+
*
|
|
9346
9411
|
* @__NO_SIDE_EFFECTS__
|
|
9347
9412
|
*/ function zohoAccountsFactory(factoryConfig) {
|
|
9348
9413
|
var fetchHandler = zohoRateLimitedFetchHandler();
|
|
@@ -9447,9 +9512,10 @@ function _ts_generator(thisArg, body) {
|
|
|
9447
9512
|
* The returned function also exposes a `resetAccessToken()` method to invalidate
|
|
9448
9513
|
* the current cached token, typically called on {@link ZohoInvalidTokenError}.
|
|
9449
9514
|
*
|
|
9450
|
-
* @param config - Token refresh, caching, and expiration buffer configuration
|
|
9451
|
-
* @returns A token factory function with `resetAccessToken` for cache invalidation
|
|
9452
|
-
* @throws {ZohoAccountsAuthFailureError} If the token refresher fails
|
|
9515
|
+
* @param config - Token refresh, caching, and expiration buffer configuration.
|
|
9516
|
+
* @returns A token factory function with `resetAccessToken` for cache invalidation.
|
|
9517
|
+
* @throws {ZohoAccountsAuthFailureError} If the token refresher fails.
|
|
9518
|
+
*
|
|
9453
9519
|
* @__NO_SIDE_EFFECTS__
|
|
9454
9520
|
*/ function zohoAccountsZohoAccessTokenFactory(config) {
|
|
9455
9521
|
var tokenRefresher = config.tokenRefresher, accessTokenCache = config.accessTokenCache, inputTokenExpirationBuffer = config.tokenExpirationBuffer;
|
|
@@ -9564,7 +9630,7 @@ function safeZohoDateTimeString(date) {
|
|
|
9564
9630
|
* Converts a {@link Date} to a {@link ZohoDateTimeString} by stripping milliseconds
|
|
9565
9631
|
* from the ISO 8601 representation.
|
|
9566
9632
|
*
|
|
9567
|
-
* @param date - Date to convert
|
|
9633
|
+
* @param date - Date to convert.
|
|
9568
9634
|
* @returns Zoho-formatted date-time string (e.g. `'2019-05-02T11:17:33Z'`)
|
|
9569
9635
|
*
|
|
9570
9636
|
* @example
|
|
@@ -9577,4 +9643,4 @@ function safeZohoDateTimeString(date) {
|
|
|
9577
9643
|
return isoDate.substring(0, isoDate.length - 5) + 'Z';
|
|
9578
9644
|
}
|
|
9579
9645
|
|
|
9580
|
-
export { DEFAULT_ZOHO_API_RATE_LIMIT, DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD, DEFAULT_ZOHO_DESK_API_RATE_LIMIT, DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION, DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION, MAX_ZOHO_CRM_SEARCH_MODULE_RECORDS_CRITERIA, MAX_ZOHO_RECRUIT_SEARCH_MODULE_RECORDS_CRITERIA, ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE, ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE, ZOHO_ACCOUNTS_US_API_URL, ZOHO_CRM_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED, ZOHO_CRM_ALREADY_ASSOCIATED_ERROR_CODE, ZOHO_CRM_ATTACHMENTS_MODULE, ZOHO_CRM_ATTACHMENT_MAX_SIZE, ZOHO_CRM_CONTACTS_MODULE, ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT, ZOHO_CRM_EMAILS_MODULE, ZOHO_CRM_LEADS_MODULE, ZOHO_CRM_NOTES_MODULE, ZOHO_CRM_RECORD_ATTACHMENT_METADATA_ATTACH_TYPE_RESUME, ZOHO_CRM_REMOVE_TAGS_FROM_RECORDS_MAX_IDS_ALLOWED, ZOHO_CRM_SERVICE_NAME, ZOHO_CRM_TAG_NAME_MAX_LENGTH, ZOHO_CRM_TASKS_MODULE, ZOHO_DATA_ARRAY_BLANK_ERROR_CODE,
|
|
9646
|
+
export { DEFAULT_ZOHO_API_RATE_LIMIT, DEFAULT_ZOHO_API_RATE_LIMIT_RESET_PERIOD, DEFAULT_ZOHO_DESK_API_RATE_LIMIT, DEFAULT_ZOHO_DESK_PAGE_LIMIT, DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUESTS_LOG_FUNCTION, DEFAULT_ZOHO_RATE_LIMITED_TOO_MANY_REQUETS_LOG_FUNCTION, MAX_ZOHO_CRM_SEARCH_MODULE_RECORDS_CRITERIA, MAX_ZOHO_RECRUIT_SEARCH_MODULE_RECORDS_CRITERIA, ZOHO_ACCOUNTS_INVALID_CLIENT_ERROR_CODE, ZOHO_ACCOUNTS_INVALID_CODE_ERROR_CODE, ZOHO_ACCOUNTS_US_API_URL, ZOHO_CRM_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED, ZOHO_CRM_ALREADY_ASSOCIATED_ERROR_CODE, ZOHO_CRM_ATTACHMENTS_MODULE, ZOHO_CRM_ATTACHMENT_MAX_SIZE, ZOHO_CRM_CONTACTS_MODULE, ZOHO_CRM_CRUD_FUNCTION_MAX_RECORDS_LIMIT, ZOHO_CRM_EMAILS_MODULE, ZOHO_CRM_LEADS_MODULE, ZOHO_CRM_NOTES_MODULE, ZOHO_CRM_RECORD_ATTACHMENT_METADATA_ATTACH_TYPE_RESUME, ZOHO_CRM_REMOVE_TAGS_FROM_RECORDS_MAX_IDS_ALLOWED, ZOHO_CRM_SERVICE_NAME, ZOHO_CRM_TAG_NAME_MAX_LENGTH, ZOHO_CRM_TASKS_MODULE, ZOHO_DATA_ARRAY_BLANK_ERROR_CODE, ZOHO_DESK_MAX_PAGE_LIMIT, ZOHO_DESK_RATE_LIMIT_REMAINING_HEADER, ZOHO_DESK_RATE_LIMIT_WEIGHT_HEADER, ZOHO_DESK_RETRY_AFTER_HEADER, ZOHO_DESK_SERVICE_NAME, ZOHO_DUPLICATE_DATA_ERROR_CODE, ZOHO_ERROR_STATUS, ZOHO_FAILURE_ERROR_CODE, ZOHO_INTERNAL_ERROR_CODE, ZOHO_INVALID_AUTHORIZATION_ERROR_CODE, ZOHO_INVALID_DATA_ERROR_CODE, ZOHO_INVALID_QUERY_ERROR_CODE, ZOHO_INVALID_TOKEN_ERROR_CODE, ZOHO_MANDATORY_NOT_FOUND_ERROR_CODE, ZOHO_RATE_LIMIT_LIMIT_HEADER, ZOHO_RATE_LIMIT_REMAINING_HEADER, ZOHO_RATE_LIMIT_RESET_HEADER, ZOHO_RECRUIT_ADD_TAGS_TO_RECORDS_MAX_IDS_ALLOWED, ZOHO_RECRUIT_ALREADY_ASSOCIATED_ERROR_CODE, ZOHO_RECRUIT_ATTACHMENTS_MODULE, ZOHO_RECRUIT_ATTACHMENT_MAX_SIZE, ZOHO_RECRUIT_CANDIDATES_MODULE, ZOHO_RECRUIT_CRUD_FUNCTION_MAX_RECORDS_LIMIT, ZOHO_RECRUIT_EMAILS_MODULE, ZOHO_RECRUIT_JOB_OPENINGS_MODULE, ZOHO_RECRUIT_NOTES_MODULE, ZOHO_RECRUIT_RECORD_ATTACHMENT_METADATA_ATTACH_TYPE_RESUME, ZOHO_RECRUIT_REMOVE_TAGS_FROM_RECORDS_MAX_IDS_ALLOWED, ZOHO_RECRUIT_SERVICE_NAME, ZOHO_RECRUIT_TAG_NAME_MAX_LENGTH, ZOHO_SIGN_SERVICE_NAME, ZOHO_SUCCESS_CODE, ZOHO_SUCCESS_STATUS, ZOHO_TOO_MANY_REQUESTS_ERROR_CODE, ZOHO_TOO_MANY_REQUESTS_HTTP_STATUS_CODE, ZohoAccountsAccessTokenError, ZohoAccountsAuthFailureError, ZohoCrmExecuteRestApiFunctionError, ZohoCrmRecordCrudDuplicateDataError, ZohoCrmRecordCrudError, ZohoCrmRecordCrudInvalidDataError, ZohoCrmRecordCrudMandatoryFieldNotFoundError, ZohoCrmRecordCrudNoMatchingRecordError, ZohoCrmRecordNoContentError, ZohoInternalError, ZohoInvalidAuthorizationError, ZohoInvalidQueryError, ZohoInvalidTokenError, ZohoRecruitExecuteRestApiFunctionError, ZohoRecruitRecordCrudDuplicateDataError, ZohoRecruitRecordCrudError, ZohoRecruitRecordCrudInvalidDataError, ZohoRecruitRecordCrudMandatoryFieldNotFoundError, ZohoRecruitRecordCrudNoMatchingRecordError, ZohoRecruitRecordNoContentError, ZohoServerError, ZohoServerFetchResponseDataArrayError, ZohoServerFetchResponseError, ZohoTooManyRequestsError, addTagsToRecords, assertRecordDataArrayResultHasContent, assertZohoCrmRecordDataArrayResultHasContent, assertZohoRecruitRecordDataArrayResultHasContent, createNotes, createNotesForRecord, createTagsForModule, deleteAttachmentFromRecord, deleteNotes, deleteRecord, downloadAttachmentForRecord, emptyZohoPageResult, escapeZohoCrmFieldValueForCriteriaString, executeRestApiFunction, getAttachmentsForRecord, getAttachmentsForRecordPageFactory, getEmailsForRecord, getEmailsForRecordPageFactory, getNotesForRecord, getNotesForRecordPageFactory, getRecordById, getRecords, getRelatedRecordsFunctionFactory, getTagsForModule, getTagsForModulePageFactory, handleZohoAccountsErrorFetch, handleZohoCrmErrorFetch, handleZohoDeskErrorFetch, handleZohoErrorFetchFactory, handleZohoRecruitErrorFetch, handleZohoSignErrorFetch, insertRecord, interceptZohoAccounts200StatusWithErrorResponse, interceptZohoCrm200StatusWithErrorResponse, interceptZohoDesk200StatusWithErrorResponse, interceptZohoErrorResponseFactory, interceptZohoRecruit200StatusWithErrorResponse, interceptZohoSign200StatusWithErrorResponse, isZohoCrmValidUrl, isZohoRecruitValidUrl, isZohoServerErrorResponseDataArrayRef, logZohoAccountsErrorToConsole, logZohoCrmErrorToConsole, logZohoDeskErrorToConsole, logZohoRecruitErrorToConsole, logZohoServerErrorFunction, logZohoSignErrorToConsole, makeZohoRateLimitedFetchHandler, parseZohoAccountsError, parseZohoAccountsServerErrorResponseData, parseZohoCrmError, parseZohoCrmServerErrorResponseData, parseZohoDeskError, parseZohoDeskServerErrorResponseData, parseZohoRecruitError, parseZohoRecruitServerErrorResponseData, parseZohoServerErrorResponseData, parseZohoSignError, parseZohoSignServerErrorResponseData, removeTagsFromRecords, safeZohoDateTimeString, searchRecords, searchRecordsPageFactory, tryFindZohoServerErrorData, updateRecord, uploadAttachmentForRecord, upsertRecord, zohoAccessTokenStringFactory, zohoAccountsAccessToken, zohoAccountsApiFetchJsonInput, zohoAccountsConfigApiUrl, zohoAccountsFactory, zohoAccountsRefreshTokenFromAuthorizationCode, zohoAccountsZohoAccessTokenFactory, zohoCrmAddTagsToRecords, zohoCrmAddTagsToRecordsRequestBody, zohoCrmApiFetchJsonInput, zohoCrmCatchZohoCrmChangeObjectLikeResponseError, zohoCrmChangeObjectLikeResponseSuccessAndErrorPairs, zohoCrmConfigApiUrl, zohoCrmCreateNotes, zohoCrmCreateNotesForRecord, zohoCrmCreateTagsForModule, zohoCrmDeleteAttachmentFromRecord, zohoCrmDeleteNotes, zohoCrmDeleteRecord, zohoCrmDeleteTag, zohoCrmDownloadAttachmentForRecord, zohoCrmExecuteRestApiFunction, zohoCrmFactory, zohoCrmGetAttachmentsForRecord, zohoCrmGetAttachmentsForRecordPageFactory, zohoCrmGetEmailsForRecord, zohoCrmGetEmailsForRecordPageFactory, zohoCrmGetNotesForRecord, zohoCrmGetNotesForRecordPageFactory, zohoCrmGetRecordById, zohoCrmGetRecords, zohoCrmGetRelatedRecordsFunctionFactory, zohoCrmGetTagsForModule, zohoCrmGetTagsForModulePageFactory, zohoCrmInsertRecord, zohoCrmMultiRecordResult, zohoCrmRecordCrudError, zohoCrmRemoveTagsFromRecords, zohoCrmSearchRecords, zohoCrmSearchRecordsCriteriaEntryToCriteriaString, zohoCrmSearchRecordsCriteriaString, zohoCrmSearchRecordsCriteriaStringForTree, zohoCrmSearchRecordsPageFactory, zohoCrmUpdateRecord, zohoCrmUploadAttachmentForRecord, zohoCrmUpsertRecord, zohoCrmUrlSearchParams, zohoCrmUrlSearchParamsMinusIdAndModule, zohoCrmUrlSearchParamsMinusModule, zohoDateTimeString, zohoDeskAddTicketFollowers, zohoDeskApiFetchJsonInput, zohoDeskAssociateTicketTags, zohoDeskConfigApiUrl, zohoDeskCreateTicketComment, zohoDeskDeleteTicketAttachment, zohoDeskDeleteTicketComment, zohoDeskDissociateTicketTag, zohoDeskFactory, zohoDeskFetchPageFactory, zohoDeskGetAgentById, zohoDeskGetAgents, zohoDeskGetAgentsByIds, zohoDeskGetAgentsPageFactory, zohoDeskGetAgentsTicketsCount, zohoDeskGetAllTags, zohoDeskGetContactById, zohoDeskGetContacts, zohoDeskGetContactsByIds, zohoDeskGetContactsPageFactory, zohoDeskGetDepartmentById, zohoDeskGetDepartments, zohoDeskGetMyInfo, zohoDeskGetTicketActivities, zohoDeskGetTicketActivitiesPageFactory, zohoDeskGetTicketAttachments, zohoDeskGetTicketById, zohoDeskGetTicketCommentById, zohoDeskGetTicketComments, zohoDeskGetTicketFollowers, zohoDeskGetTicketMetrics, zohoDeskGetTicketTags, zohoDeskGetTicketThreadById, zohoDeskGetTicketThreads, zohoDeskGetTicketThreadsPageFactory, zohoDeskGetTicketTimeEntries, zohoDeskGetTicketTimeEntryById, zohoDeskGetTicketTimeEntrySummation, zohoDeskGetTicketTimer, zohoDeskGetTickets, zohoDeskGetTicketsForContact, zohoDeskGetTicketsForProduct, zohoDeskGetTicketsPageFactory, zohoDeskPerformTicketTimerAction, zohoDeskRateLimitDetailsReader, zohoDeskRateLimitedFetchHandler, zohoDeskRemoveTicketFollowers, zohoDeskSearchTags, zohoDeskSearchTickets, zohoDeskSearchTicketsPageFactory, zohoFetchPageFactory, zohoRateLimitHeaderDetails, zohoRateLimitedFetchHandler, zohoRecruitAddTagsToRecords, zohoRecruitApiFetchJsonInput, zohoRecruitAssociateCandidateRecordsWithJobOpenings, zohoRecruitChangeObjectLikeResponseSuccessAndErrorPairs, zohoRecruitConfigApiUrl, zohoRecruitCreateNotes, zohoRecruitCreateNotesForRecord, zohoRecruitCreateTagsForModule, zohoRecruitDeleteAttachmentFromRecord, zohoRecruitDeleteNotes, zohoRecruitDeleteRecord, zohoRecruitDownloadAttachmentForRecord, zohoRecruitExecuteRestApiFunction, zohoRecruitFactory, zohoRecruitGetAttachmentsForRecord, zohoRecruitGetAttachmentsForRecordPageFactory, zohoRecruitGetEmailsForRecord, zohoRecruitGetEmailsForRecordPageFactory, zohoRecruitGetNotesForRecord, zohoRecruitGetNotesForRecordPageFactory, zohoRecruitGetRecordById, zohoRecruitGetRecords, zohoRecruitGetRelatedRecordsFunctionFactory, zohoRecruitGetTagsForModule, zohoRecruitGetTagsForModulePageFactory, zohoRecruitInsertRecord, zohoRecruitMultiRecordResult, zohoRecruitRecordCrudError, zohoRecruitRemoveTagsFromRecords, zohoRecruitSearchAssociatedRecords, zohoRecruitSearchCandidateAssociatedJobOpeningRecords, zohoRecruitSearchCandidateAssociatedJobOpeningRecordsPageFactory, zohoRecruitSearchJobOpeningAssociatedCandidateRecords, zohoRecruitSearchJobOpeningAssociatedCandidateRecordsPageFactory, zohoRecruitSearchRecords, zohoRecruitSearchRecordsCriteriaEntryToCriteriaString, zohoRecruitSearchRecordsCriteriaString, zohoRecruitSearchRecordsCriteriaStringForTree, zohoRecruitSearchRecordsPageFactory, zohoRecruitUpdateRecord, zohoRecruitUploadAttachmentForRecord, zohoRecruitUpsertRecord, zohoRecruitUrlSearchParams, zohoRecruitUrlSearchParamsMinusIdAndModule, zohoRecruitUrlSearchParamsMinusModule, zohoServerErrorData, zohoSignConfigApiUrl, zohoSignCreateDocument, zohoSignDeleteDocument, zohoSignDownloadCompletionCertificate, zohoSignDownloadPdf, zohoSignExtendDocument, zohoSignFactory, zohoSignFetchPageFactory, zohoSignGetDocument, zohoSignGetDocumentFormData, zohoSignGetDocuments, zohoSignGetDocumentsPageFactory, zohoSignRetrieveFieldTypes, zohoSignSendDocumentForSignature, zohoSignUpdateDocument, zohoStandardRateLimitDetailsReader };
|