@wix/crm 1.0.29 → 1.0.31
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/build/cjs/src/contacts-v4-extended-field.http.d.ts +8 -8
- package/build/cjs/src/contacts-v4-extended-field.http.js +8 -8
- package/build/cjs/src/contacts-v4-extended-field.public.d.ts +3 -3
- package/build/cjs/src/contacts-v4-extended-field.public.js +1 -1
- package/build/cjs/src/contacts-v4-extended-field.public.js.map +1 -1
- package/build/cjs/src/contacts-v4-extended-field.universal.d.ts +28 -34
- package/build/cjs/src/contacts-v4-extended-field.universal.js +29 -27
- package/build/cjs/src/contacts-v4-extended-field.universal.js.map +1 -1
- package/build/cjs/src/crm-tasks-v1-task.http.d.ts +2 -2
- package/build/cjs/src/crm-tasks-v1-task.http.js +2 -2
- package/build/cjs/src/crm-tasks-v1-task.universal.d.ts +36 -24
- package/build/cjs/src/crm-tasks-v1-task.universal.js +10 -6
- package/build/cjs/src/crm-tasks-v1-task.universal.js.map +1 -1
- package/build/es/src/contacts-v4-extended-field.http.d.ts +8 -8
- package/build/es/src/contacts-v4-extended-field.http.js +8 -8
- package/build/es/src/contacts-v4-extended-field.public.d.ts +3 -3
- package/build/es/src/contacts-v4-extended-field.public.js +1 -1
- package/build/es/src/contacts-v4-extended-field.public.js.map +1 -1
- package/build/es/src/contacts-v4-extended-field.universal.d.ts +28 -34
- package/build/es/src/contacts-v4-extended-field.universal.js +29 -27
- package/build/es/src/contacts-v4-extended-field.universal.js.map +1 -1
- package/build/es/src/crm-tasks-v1-task.http.d.ts +2 -2
- package/build/es/src/crm-tasks-v1-task.http.js +2 -2
- package/build/es/src/crm-tasks-v1-task.universal.d.ts +36 -24
- package/build/es/src/crm-tasks-v1-task.universal.js +10 -6
- package/build/es/src/crm-tasks-v1-task.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -42,19 +42,19 @@ export declare function deleteExtendedField(payload: DeleteExtendedFieldRequest)
|
|
|
42
42
|
/**
|
|
43
43
|
* Creates a query to retrieve a list of extended fields.
|
|
44
44
|
*
|
|
45
|
-
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`
|
|
45
|
+
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`FieldsQueryBuilder`](#fieldsquerybuilder) object.
|
|
46
46
|
*
|
|
47
|
-
* The returned object contains the query definition, which is used to run the query using the [`find()`](#
|
|
47
|
+
* The returned object contains the query definition, which is used to run the query using the [`find()`](#fieldsquerybuilder/find) function.
|
|
48
48
|
*
|
|
49
|
-
* You can refine the query by chaining `
|
|
49
|
+
* You can refine the query by chaining `FieldsQueryBuilder` functions onto the query. `FieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
|
|
50
50
|
*
|
|
51
|
-
* `queryExtendedFields()` runs with these `
|
|
52
|
-
* - [`skip()`](#
|
|
53
|
-
* - [`limit(50)`](#
|
|
54
|
-
* - [`descending('_createdDate')`](#
|
|
51
|
+
* `queryExtendedFields()` runs with these `FieldsQueryBuilder` defaults, which you can override:
|
|
52
|
+
* - [`skip()`](#fieldsquerybuilder/skip)
|
|
53
|
+
* - [`limit(50)`](#fieldsquerybuilder/limit)
|
|
54
|
+
* - [`descending('_createdDate')`](#fieldsquerybuilder/descending)
|
|
55
55
|
*
|
|
56
56
|
* > **Note:** Only visitors with **Manage Contacts** permissions can query extended fields.
|
|
57
57
|
*
|
|
58
|
-
* The following `
|
|
58
|
+
* The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the [`items`](#fieldsqueryresult/items) property in [`FieldsQueryResult`](#fieldsqueryresult).
|
|
59
59
|
*/
|
|
60
60
|
export declare function queryExtendedFields(payload: QueryExtendedFieldsRequest): RequestOptionsFactory<QueryExtendedFieldsResponse>;
|
|
@@ -201,20 +201,20 @@ exports.deleteExtendedField = deleteExtendedField;
|
|
|
201
201
|
/**
|
|
202
202
|
* Creates a query to retrieve a list of extended fields.
|
|
203
203
|
*
|
|
204
|
-
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`
|
|
204
|
+
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`FieldsQueryBuilder`](#fieldsquerybuilder) object.
|
|
205
205
|
*
|
|
206
|
-
* The returned object contains the query definition, which is used to run the query using the [`find()`](#
|
|
206
|
+
* The returned object contains the query definition, which is used to run the query using the [`find()`](#fieldsquerybuilder/find) function.
|
|
207
207
|
*
|
|
208
|
-
* You can refine the query by chaining `
|
|
208
|
+
* You can refine the query by chaining `FieldsQueryBuilder` functions onto the query. `FieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
|
|
209
209
|
*
|
|
210
|
-
* `queryExtendedFields()` runs with these `
|
|
211
|
-
* - [`skip()`](#
|
|
212
|
-
* - [`limit(50)`](#
|
|
213
|
-
* - [`descending('_createdDate')`](#
|
|
210
|
+
* `queryExtendedFields()` runs with these `FieldsQueryBuilder` defaults, which you can override:
|
|
211
|
+
* - [`skip()`](#fieldsquerybuilder/skip)
|
|
212
|
+
* - [`limit(50)`](#fieldsquerybuilder/limit)
|
|
213
|
+
* - [`descending('_createdDate')`](#fieldsquerybuilder/descending)
|
|
214
214
|
*
|
|
215
215
|
* > **Note:** Only visitors with **Manage Contacts** permissions can query extended fields.
|
|
216
216
|
*
|
|
217
|
-
* The following `
|
|
217
|
+
* The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the [`items`](#fieldsqueryresult/items) property in [`FieldsQueryResult`](#fieldsqueryresult).
|
|
218
218
|
*/
|
|
219
219
|
function queryExtendedFields(payload) {
|
|
220
220
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_queryExtendedFieldsRequest, {});
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { HttpClient } from '@wix/sdk-types';
|
|
2
|
-
import {
|
|
2
|
+
import { RenameExtendedField, FieldDataType } from './contacts-v4-extended-field.universal';
|
|
3
3
|
export declare const __metadata: {
|
|
4
4
|
PACKAGE_NAME: string;
|
|
5
5
|
};
|
|
6
|
-
export declare function findOrCreateExtendedField(httpClient: HttpClient): (
|
|
6
|
+
export declare function findOrCreateExtendedField(httpClient: HttpClient): (displayName: string, dataType: FieldDataType) => Promise<import("./contacts-v4-extended-field.universal").FindOrCreateExtendedFieldResponse>;
|
|
7
7
|
export declare function getExtendedField(httpClient: HttpClient): (key: string) => Promise<import("./contacts-v4-extended-field.universal").ExtendedField>;
|
|
8
8
|
export declare function renameExtendedField(httpClient: HttpClient): (key: string, field: RenameExtendedField) => Promise<import("./contacts-v4-extended-field.universal").ExtendedField>;
|
|
9
9
|
export declare function deleteExtendedField(httpClient: HttpClient): (key: string) => Promise<void>;
|
|
10
10
|
export declare function queryExtendedFields(httpClient: HttpClient): () => import("./contacts-v4-extended-field.universal").FieldsQueryBuilder;
|
|
11
11
|
export { FieldDataType, FieldType, SortOrder, } from './contacts-v4-extended-field.universal';
|
|
12
|
-
export { ExtendedField, ListExtendedFieldsRequest, Sorting, Paging, ListExtendedFieldsResponse, PagingMetadata, FindOrCreateExtendedFieldRequest, FindOrCreateExtendedFieldResponse, GetExtendedFieldRequest, GetExtendedFieldResponse, GetExtendedFieldByLegacyIdRequest, GetExtendedFieldByLegacyIdResponse, UpdateExtendedFieldRequest, UpdateExtendedFieldResponse, DeleteExtendedFieldRequest, DeleteExtendedFieldResponse, PurgeRequest, PurgeResponse, GdprListRequest, GdprListResponse, QueryExtendedFieldsRequest, Query, QueryExtendedFieldsResponse,
|
|
12
|
+
export { ExtendedField, ListExtendedFieldsRequest, Sorting, Paging, ListExtendedFieldsResponse, PagingMetadata, FindOrCreateExtendedFieldRequest, FindOrCreateExtendedFieldResponse, GetExtendedFieldRequest, GetExtendedFieldResponse, GetExtendedFieldByLegacyIdRequest, GetExtendedFieldByLegacyIdResponse, UpdateExtendedFieldRequest, UpdateExtendedFieldResponse, DeleteExtendedFieldRequest, DeleteExtendedFieldResponse, PurgeRequest, PurgeResponse, GdprListRequest, GdprListResponse, QueryExtendedFieldsRequest, Query, QueryExtendedFieldsResponse, RenameExtendedField, FieldsQueryResult, FieldsQueryBuilder, } from './contacts-v4-extended-field.universal';
|
|
@@ -4,7 +4,7 @@ exports.SortOrder = exports.FieldType = exports.FieldDataType = exports.queryExt
|
|
|
4
4
|
const contacts_v4_extended_field_universal_1 = require("./contacts-v4-extended-field.universal");
|
|
5
5
|
exports.__metadata = { PACKAGE_NAME: '@wix/crm' };
|
|
6
6
|
function findOrCreateExtendedField(httpClient) {
|
|
7
|
-
return (
|
|
7
|
+
return (displayName, dataType) => (0, contacts_v4_extended_field_universal_1.findOrCreateExtendedField)(displayName, dataType,
|
|
8
8
|
// @ts-ignore
|
|
9
9
|
{ httpClient });
|
|
10
10
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts-v4-extended-field.public.js","sourceRoot":"","sources":["../../../src/contacts-v4-extended-field.public.ts"],"names":[],"mappings":";;;AACA,
|
|
1
|
+
{"version":3,"file":"contacts-v4-extended-field.public.js","sourceRoot":"","sources":["../../../src/contacts-v4-extended-field.public.ts"],"names":[],"mappings":";;;AACA,iGAQgD;AAEnC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC;AAEvD,SAAgB,yBAAyB,CAAC,UAAsB;IAC9D,OAAO,CAAC,WAAmB,EAAE,QAAuB,EAAE,EAAE,CACtD,IAAA,gEAAkC,EAChC,WAAW,EACX,QAAQ;IACR,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,8DAQC;AAED,SAAgB,gBAAgB,CAAC,UAAsB;IACrD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,IAAA,uDAAyB,EACvB,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,4CAOC;AAED,SAAgB,mBAAmB,CAAC,UAAsB;IACxD,OAAO,CAAC,GAAW,EAAE,KAA0B,EAAE,EAAE,CACjD,IAAA,0DAA4B,EAC1B,GAAG,EACH,KAAK;IACL,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,kDAQC;AAED,SAAgB,mBAAmB,CAAC,UAAsB;IACxD,OAAO,CAAC,GAAW,EAAE,EAAE,CACrB,IAAA,0DAA4B,EAC1B,GAAG;IACH,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,kDAOC;AAED,SAAgB,mBAAmB,CAAC,UAAsB;IACxD,OAAO,GAAG,EAAE,CACV,IAAA,0DAA4B;IAC1B,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAND,kDAMC;AAED,+FAIgD;AAH9C,qIAAA,aAAa,OAAA;AACb,iIAAA,SAAS,OAAA;AACT,iIAAA,SAAS,OAAA"}
|
|
@@ -18,7 +18,7 @@ export interface ExtendedField {
|
|
|
18
18
|
* Extended field key.
|
|
19
19
|
*
|
|
20
20
|
* When accessing contact data,
|
|
21
|
-
* extended field data is available at `
|
|
21
|
+
* extended field data is available at `fields[key]`.
|
|
22
22
|
* For example, if the key is "custom.notes",
|
|
23
23
|
* the value can be accessed at `fields["custom.notes"]`.
|
|
24
24
|
*
|
|
@@ -182,7 +182,7 @@ export interface GetExtendedFieldRequest {
|
|
|
182
182
|
* Extended field key.
|
|
183
183
|
*
|
|
184
184
|
* When accessing contact data,
|
|
185
|
-
* extended field values are available at `
|
|
185
|
+
* extended field values are available at `fields[key]`.
|
|
186
186
|
* For example, if the key is "custom.notes",
|
|
187
187
|
* the value can be accessed at `fields["custom.notes"]`.
|
|
188
188
|
*
|
|
@@ -276,6 +276,12 @@ export interface QueryExtendedFieldsResponse {
|
|
|
276
276
|
*
|
|
277
277
|
*
|
|
278
278
|
* This function is not a universal function and runs only on the backend.
|
|
279
|
+
* @param displayName - Display name to find or create.
|
|
280
|
+
*
|
|
281
|
+
* If an existing custom field is an exact match
|
|
282
|
+
* for the specified `displayName`,
|
|
283
|
+
* the existing field is returned.
|
|
284
|
+
* If not, a new field is created and returned.
|
|
279
285
|
* @param dataType - Type of data the field holds.
|
|
280
286
|
* Ignored if an existing field is an exact match
|
|
281
287
|
* for the specified display name. One of:
|
|
@@ -286,24 +292,12 @@ export interface QueryExtendedFieldsResponse {
|
|
|
286
292
|
* - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
|
|
287
293
|
* @public
|
|
288
294
|
* @requiredField dataType
|
|
289
|
-
* @requiredField
|
|
290
|
-
* @requiredField options.displayName
|
|
295
|
+
* @requiredField displayName
|
|
291
296
|
* @permissionScope Manage Contact Extended Fields
|
|
292
297
|
* @applicableIdentity APP
|
|
293
298
|
* @returns Extended field that was found or created.
|
|
294
299
|
*/
|
|
295
|
-
export declare function findOrCreateExtendedField(
|
|
296
|
-
export interface FindOrCreateExtendedFieldOptions {
|
|
297
|
-
/**
|
|
298
|
-
* Display name to find or create.
|
|
299
|
-
*
|
|
300
|
-
* If an existing custom field is an exact match
|
|
301
|
-
* for the specified `displayName`,
|
|
302
|
-
* the existing field is returned.
|
|
303
|
-
* If not, a new field is created and returned.
|
|
304
|
-
*/
|
|
305
|
-
displayName: string;
|
|
306
|
-
}
|
|
300
|
+
export declare function findOrCreateExtendedField(displayName: string, dataType: FieldDataType): Promise<FindOrCreateExtendedFieldResponse>;
|
|
307
301
|
/**
|
|
308
302
|
* Retrieves an extended field.
|
|
309
303
|
*
|
|
@@ -312,16 +306,16 @@ export interface FindOrCreateExtendedFieldOptions {
|
|
|
312
306
|
* >**Note:** Only visitors with **Manage Contacts** permissions can retrieve extended fields.
|
|
313
307
|
*
|
|
314
308
|
* This function is not a universal function and runs only on the backend.
|
|
309
|
+
* @public
|
|
310
|
+
* @requiredField key
|
|
315
311
|
* @param key - Extended field key.
|
|
316
312
|
*
|
|
317
313
|
* When accessing contact data,
|
|
318
|
-
* extended field values are available at `
|
|
314
|
+
* extended field values are available at `fields[key]`.
|
|
319
315
|
* For example, if the key is "custom.notes",
|
|
320
316
|
* the value can be accessed at `fields["custom.notes"]`.
|
|
321
317
|
*
|
|
322
318
|
* Once set, `key` cannot be modified, even if `displayName` changes.
|
|
323
|
-
* @public
|
|
324
|
-
* @requiredField key
|
|
325
319
|
* @permissionScope Manage Contact Extended Fields
|
|
326
320
|
* @applicableIdentity APP
|
|
327
321
|
* @returns The specified field.
|
|
@@ -335,19 +329,19 @@ export declare function getExtendedField(key: string): Promise<ExtendedField>;
|
|
|
335
329
|
* > **Note:** Only visitors with **Manage Contacts** permissions can rename extended fields.
|
|
336
330
|
*
|
|
337
331
|
* This function is not a universal function and runs only on the backend.
|
|
332
|
+
* @public
|
|
333
|
+
* @requiredField field
|
|
334
|
+
* @requiredField field.displayName
|
|
335
|
+
* @requiredField key
|
|
338
336
|
* @param key - Extended field key.
|
|
339
337
|
*
|
|
340
338
|
* When accessing contact data,
|
|
341
|
-
* extended field
|
|
339
|
+
* extended field values are available at `fields[key]`.
|
|
342
340
|
* For example, if the key is "custom.notes",
|
|
343
341
|
* the value can be accessed at `fields["custom.notes"]`.
|
|
344
342
|
*
|
|
345
|
-
* `key`
|
|
346
|
-
*
|
|
347
|
-
* @public
|
|
348
|
-
* @requiredField field
|
|
349
|
-
* @requiredField field.displayName
|
|
350
|
-
* @requiredField key
|
|
343
|
+
* Once set, `key` cannot be modified, even if `displayName` changes.
|
|
344
|
+
* @param options - Extended field display name to rename.
|
|
351
345
|
* @permissionScope Manage Contact Extended Fields
|
|
352
346
|
* @applicableIdentity APP
|
|
353
347
|
* @returns Updated extended field.
|
|
@@ -420,20 +414,20 @@ export declare function deleteExtendedField(key: string): Promise<void>;
|
|
|
420
414
|
/**
|
|
421
415
|
* Creates a query to retrieve a list of extended fields.
|
|
422
416
|
*
|
|
423
|
-
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`
|
|
417
|
+
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`FieldsQueryBuilder`](#fieldsquerybuilder) object.
|
|
424
418
|
*
|
|
425
|
-
* The returned object contains the query definition, which is used to run the query using the [`find()`](#
|
|
419
|
+
* The returned object contains the query definition, which is used to run the query using the [`find()`](#fieldsquerybuilder/find) function.
|
|
426
420
|
*
|
|
427
|
-
* You can refine the query by chaining `
|
|
421
|
+
* You can refine the query by chaining `FieldsQueryBuilder` functions onto the query. `FieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
|
|
428
422
|
*
|
|
429
|
-
* `queryExtendedFields()` runs with these `
|
|
430
|
-
* - [`skip()`](#
|
|
431
|
-
* - [`limit(50)`](#
|
|
432
|
-
* - [`descending('_createdDate')`](#
|
|
423
|
+
* `queryExtendedFields()` runs with these `FieldsQueryBuilder` defaults, which you can override:
|
|
424
|
+
* - [`skip()`](#fieldsquerybuilder/skip)
|
|
425
|
+
* - [`limit(50)`](#fieldsquerybuilder/limit)
|
|
426
|
+
* - [`descending('_createdDate')`](#fieldsquerybuilder/descending)
|
|
433
427
|
*
|
|
434
428
|
* > **Note:** Only visitors with **Manage Contacts** permissions can query extended fields.
|
|
435
429
|
*
|
|
436
|
-
* The following `
|
|
430
|
+
* The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the [`items`](#fieldsqueryresult/items) property in [`FieldsQueryResult`](#fieldsqueryresult).
|
|
437
431
|
*
|
|
438
432
|
* This function is not a universal function and runs only on the backend.
|
|
439
433
|
* @public
|
|
@@ -90,6 +90,12 @@ const _updateExtendedFieldResponse = {};
|
|
|
90
90
|
*
|
|
91
91
|
*
|
|
92
92
|
* This function is not a universal function and runs only on the backend.
|
|
93
|
+
* @param displayName - Display name to find or create.
|
|
94
|
+
*
|
|
95
|
+
* If an existing custom field is an exact match
|
|
96
|
+
* for the specified `displayName`,
|
|
97
|
+
* the existing field is returned.
|
|
98
|
+
* If not, a new field is created and returned.
|
|
93
99
|
* @param dataType - Type of data the field holds.
|
|
94
100
|
* Ignored if an existing field is an exact match
|
|
95
101
|
* for the specified display name. One of:
|
|
@@ -100,19 +106,15 @@ const _updateExtendedFieldResponse = {};
|
|
|
100
106
|
* - `"URL"`: Accepts strings. Prepends `https://` if no protocol is included.
|
|
101
107
|
* @public
|
|
102
108
|
* @requiredField dataType
|
|
103
|
-
* @requiredField
|
|
104
|
-
* @requiredField options.displayName
|
|
109
|
+
* @requiredField displayName
|
|
105
110
|
* @permissionScope Manage Contact Extended Fields
|
|
106
111
|
* @applicableIdentity APP
|
|
107
112
|
* @returns Extended field that was found or created.
|
|
108
113
|
*/
|
|
109
|
-
function findOrCreateExtendedField(
|
|
114
|
+
function findOrCreateExtendedField(displayName, dataType) {
|
|
110
115
|
var _a, _b, _c;
|
|
111
116
|
return __awaiter(this, arguments, void 0, function* () {
|
|
112
|
-
const requestTransformation = {
|
|
113
|
-
dataType: '$[0]',
|
|
114
|
-
displayName: '$[1].displayName',
|
|
115
|
-
};
|
|
117
|
+
const requestTransformation = { displayName: '$[0]', dataType: '$[1]' };
|
|
116
118
|
const responseTransformation = '$';
|
|
117
119
|
// @ts-ignore
|
|
118
120
|
const { httpClient, sideEffects } = arguments[2];
|
|
@@ -134,7 +136,7 @@ function findOrCreateExtendedField(dataType, options) {
|
|
|
134
136
|
},
|
|
135
137
|
customTransformation: responseTransformation,
|
|
136
138
|
});
|
|
137
|
-
const payload = toAmbassadorRequest([
|
|
139
|
+
const payload = toAmbassadorRequest([displayName, dataType]);
|
|
138
140
|
const reqOpts = ambassadorWixContactsV4ExtendedField.findOrCreateExtendedField(payload);
|
|
139
141
|
__log(`"FindOrCreateExtendedField" sending request with: ${__inspect(reqOpts)}`);
|
|
140
142
|
(_a = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onSiteCall) === null || _a === void 0 ? void 0 : _a.call(sideEffects);
|
|
@@ -145,8 +147,8 @@ function findOrCreateExtendedField(dataType, options) {
|
|
|
145
147
|
}
|
|
146
148
|
catch (err) {
|
|
147
149
|
const transformedError = (0, velo_1.transformError)(err, requestTransformation, [
|
|
150
|
+
'displayName',
|
|
148
151
|
'dataType',
|
|
149
|
-
'options',
|
|
150
152
|
]);
|
|
151
153
|
(_c = sideEffects === null || sideEffects === void 0 ? void 0 : sideEffects.onError) === null || _c === void 0 ? void 0 : _c.call(sideEffects, err);
|
|
152
154
|
throw transformedError;
|
|
@@ -162,16 +164,16 @@ exports.findOrCreateExtendedField = findOrCreateExtendedField;
|
|
|
162
164
|
* >**Note:** Only visitors with **Manage Contacts** permissions can retrieve extended fields.
|
|
163
165
|
*
|
|
164
166
|
* This function is not a universal function and runs only on the backend.
|
|
167
|
+
* @public
|
|
168
|
+
* @requiredField key
|
|
165
169
|
* @param key - Extended field key.
|
|
166
170
|
*
|
|
167
171
|
* When accessing contact data,
|
|
168
|
-
* extended field values are available at `
|
|
172
|
+
* extended field values are available at `fields[key]`.
|
|
169
173
|
* For example, if the key is "custom.notes",
|
|
170
174
|
* the value can be accessed at `fields["custom.notes"]`.
|
|
171
175
|
*
|
|
172
176
|
* Once set, `key` cannot be modified, even if `displayName` changes.
|
|
173
|
-
* @public
|
|
174
|
-
* @requiredField key
|
|
175
177
|
* @permissionScope Manage Contact Extended Fields
|
|
176
178
|
* @applicableIdentity APP
|
|
177
179
|
* @returns The specified field.
|
|
@@ -228,19 +230,19 @@ exports.getExtendedField = getExtendedField;
|
|
|
228
230
|
* > **Note:** Only visitors with **Manage Contacts** permissions can rename extended fields.
|
|
229
231
|
*
|
|
230
232
|
* This function is not a universal function and runs only on the backend.
|
|
233
|
+
* @public
|
|
234
|
+
* @requiredField field
|
|
235
|
+
* @requiredField field.displayName
|
|
236
|
+
* @requiredField key
|
|
231
237
|
* @param key - Extended field key.
|
|
232
238
|
*
|
|
233
239
|
* When accessing contact data,
|
|
234
|
-
* extended field
|
|
240
|
+
* extended field values are available at `fields[key]`.
|
|
235
241
|
* For example, if the key is "custom.notes",
|
|
236
242
|
* the value can be accessed at `fields["custom.notes"]`.
|
|
237
243
|
*
|
|
238
|
-
* `key`
|
|
239
|
-
*
|
|
240
|
-
* @public
|
|
241
|
-
* @requiredField field
|
|
242
|
-
* @requiredField field.displayName
|
|
243
|
-
* @requiredField key
|
|
244
|
+
* Once set, `key` cannot be modified, even if `displayName` changes.
|
|
245
|
+
* @param options - Extended field display name to rename.
|
|
244
246
|
* @permissionScope Manage Contact Extended Fields
|
|
245
247
|
* @applicableIdentity APP
|
|
246
248
|
* @returns Updated extended field.
|
|
@@ -353,20 +355,20 @@ exports.deleteExtendedField = deleteExtendedField;
|
|
|
353
355
|
/**
|
|
354
356
|
* Creates a query to retrieve a list of extended fields.
|
|
355
357
|
*
|
|
356
|
-
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`
|
|
358
|
+
* The `queryExtendedFields()` function builds a query to retrieve a list of extended fields and returns an [`FieldsQueryBuilder`](#fieldsquerybuilder) object.
|
|
357
359
|
*
|
|
358
|
-
* The returned object contains the query definition, which is used to run the query using the [`find()`](#
|
|
360
|
+
* The returned object contains the query definition, which is used to run the query using the [`find()`](#fieldsquerybuilder/find) function.
|
|
359
361
|
*
|
|
360
|
-
* You can refine the query by chaining `
|
|
362
|
+
* You can refine the query by chaining `FieldsQueryBuilder` functions onto the query. `FieldsQueryBuilder` functions enable you to filter, sort, and control the results that `queryExtendedFields()` returns.
|
|
361
363
|
*
|
|
362
|
-
* `queryExtendedFields()` runs with these `
|
|
363
|
-
* - [`skip()`](#
|
|
364
|
-
* - [`limit(50)`](#
|
|
365
|
-
* - [`descending('_createdDate')`](#
|
|
364
|
+
* `queryExtendedFields()` runs with these `FieldsQueryBuilder` defaults, which you can override:
|
|
365
|
+
* - [`skip()`](#fieldsquerybuilder/skip)
|
|
366
|
+
* - [`limit(50)`](#fieldsquerybuilder/limit)
|
|
367
|
+
* - [`descending('_createdDate')`](#fieldsquerybuilder/descending)
|
|
366
368
|
*
|
|
367
369
|
* > **Note:** Only visitors with **Manage Contacts** permissions can query extended fields.
|
|
368
370
|
*
|
|
369
|
-
* The following `
|
|
371
|
+
* The following `FieldsQueryBuilder` functions are supported for `queryExtendedFields()`. For a full description of the `Extended Field` object, see the object returned for the [`items`](#fieldsqueryresult/items) property in [`FieldsQueryResult`](#fieldsqueryresult).
|
|
370
372
|
*
|
|
371
373
|
* This function is not a universal function and runs only on the backend.
|
|
372
374
|
* @public
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts-v4-extended-field.universal.js","sourceRoot":"","sources":["../../../src/contacts-v4-extended-field.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAIiC;AAEjC,wGAA0F;AAC1F,aAAa;AACb,4FAA6E;AAE7E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAgE5B,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,wDAAuC,CAAA;IACvC,8BAAa,CAAA;IACb,kCAAiB,CAAA;IACjB,8BAAa,CAAA;IACb,4BAAW,CAAA;AACb,CAAC,EANW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAMxB;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,0CAA6B,CAAA;AAC/B,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB;AA+BD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAgLD,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAC9C,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AAExC
|
|
1
|
+
{"version":3,"file":"contacts-v4-extended-field.universal.js","sourceRoot":"","sources":["../../../src/contacts-v4-extended-field.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAIiC;AAEjC,wGAA0F;AAC1F,aAAa;AACb,4FAA6E;AAE7E,IAAI,SAAS,GAAG,KAAK,CAAC;AAEtB,SAAS,KAAK,CAAC,GAAG,IAAW;IAC3B,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAEY,QAAA,OAAO,GAAG;IACrB,cAAc,EAAE;QACd,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC;QAC5B,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,GAAG,KAAK,CAAC;KAC/B;CACF,CAAC;AACF,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,eAAe,GAAG,GAAG,CAAC;AAgE5B,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,wDAAuC,CAAA;IACvC,8BAAa,CAAA;IACb,kCAAiB,CAAA;IACjB,8BAAa,CAAA;IACb,4BAAW,CAAA;AACb,CAAC,EANW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAMxB;AAED,IAAY,SAIX;AAJD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,0CAA6B,CAAA;AAC/B,CAAC,EAJW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAIpB;AA+BD,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAgLD,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,iCAAiC,GAAG,EAAE,CAAC;AAC7C,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAC9C,MAAM,wBAAwB,GAAG,EAAE,CAAC;AACpC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,SAAsB,yBAAyB,CAC7C,WAAmB,EACnB,QAAuB;;;QAEvB,MAAM,qBAAqB,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;QACxE,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,iCAAiC;YAC7C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,kCAAkC;YAC9C,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACrB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;QAE7D,MAAM,OAAO,GACX,oCAAoC,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;QAE1E,KAAK,CACH,qDAAqD,SAAS,CAAC,OAAO,CAAC,EAAE,CAC1E,CAAC;QAEF,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,aAAa;gBACb,UAAU;aACX,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAzDD,8DAyDC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAsB,gBAAgB,CAAC,GAAW;;;QAChD,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;QAC9C,MAAM,sBAAsB,GAAG,SAAS,CAAC;QAEzC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,wBAAwB;YACpC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,yBAAyB;YACrC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACrB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAE3C,MAAM,OAAO,GACX,oCAAoC,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAEjE,KAAK,CAAC,4CAA4C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAExE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,KAAK;aACN,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAnDD,4CAmDC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,SAAsB,mBAAmB,CACvC,GAAW,EACX,KAA0B;;;QAE1B,MAAM,qBAAqB,GAAG,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC;QACtE,MAAM,sBAAsB,GAAG,SAAS,CAAC;QAEzC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,2BAA2B;YACvC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACrB,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,4BAA4B;YACxC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;gBACrB,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;QAElD,MAAM,OAAO,GACX,oCAAoC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAEpE,KAAK,CAAC,+CAA+C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE3E,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,KAAK;gBACL,OAAO;aACR,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAvDD,kDAuDC;AAkDD;;;;;;;;;;;;;;;GAeG;AACH,SAAsB,mBAAmB,CAAC,GAAW;;;QACnD,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;QAC9C,MAAM,sBAAsB,GAAG,GAAG,CAAC;QAEnC,aAAa;QACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;QAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;YACzC,UAAU,EAAE,2BAA2B;YACvC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,eAAe;aAChC;YACD,oBAAoB,EAAE,qBAAqB;SAC5C,CAAC,CAAC;QAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;YAC9B,UAAU,EAAE,4BAA4B;YACxC,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,EAAE;gBACT,cAAc,EAAE,aAAa;aAC9B;YACD,oBAAoB,EAAE,sBAAsB;SAC7C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QAE3C,MAAM,OAAO,GACX,oCAAoC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAEpE,KAAK,CAAC,+CAA+C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE3E,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAQ,CAAC;SACrC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,EAAE;gBAClE,KAAK;aACN,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAnDD,kDAmDC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,mBAAmB;IACjC,MAAM,qBAAqB,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IAC7D,MAAM,sBAAsB,GAAG;QAC7B,KAAK,EAAE,UAAU;QACjB,cAAc,EAAE,kBAAkB;KACnC,CAAC;IAEF,aAAa;IACb,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,CAAC,CAG9C,CAAC;IAEF,MAAM,EAAE,mBAAmB,EAAE,GAAG,IAAA,iBAAU,EAAC;QACzC,UAAU,EAAE,2BAA2B;QACvC,UAAU,EAAE,EAAE;QACd,kBAAkB,EAAE;YAClB,KAAK,EAAE,EAAE;YACT,cAAc,EAAE,eAAe;SAChC;QACD,oBAAoB,EAAE,qBAAqB;KAC5C,CAAC,CAAC;IAEH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAA,iBAAU,EAAC;QAC9B,UAAU,EAAE,4BAA4B;QACxC,UAAU,EAAE,EAAE;QACd,kBAAkB,EAAE;YAClB,KAAK,EAAE,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC5B,cAAc,EAAE,aAAa;SAC9B;QACD,oBAAoB,EAAE,sBAAsB;KAC7C,CAAC,CAAC;IAEH,OAAO,IAAA,uDAAoB,EAAC;QAC1B,IAAI,EAAE,CAAO,OAAY,EAAE,EAAE;;YAC3B,MAAM,OAAO,GACX,oCAAoC,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAEpE,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,UAAU,+CAAvB,WAAW,CAAgB,CAAC;YAC5B,IAAI;gBACF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACjD,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,SAAS,+CAAtB,WAAW,EAAc,MAAM,CAAC,CAAC;gBACjC,OAAO,MAAM,CAAC;aACf;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;gBAC5B,MAAM,GAAG,CAAC;aACX;QACH,CAAC,CAAA;QACD,kBAAkB,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,mBAAmB,CAAC,IAAI,CAAC;QACjE,mBAAmB,EAAE,CAAC,EAAE,IAAI,EAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;QACtD,gBAAgB,EAAE,CAAC,GAAQ,EAAE,EAAE;YAC7B,MAAM,gBAAgB,GAAG,IAAA,qBAAc,EAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;YAEpE,MAAM,gBAAgB,CAAC;QACzB,CAAC;QACD,YAAY,EAAE,QAAQ;QACtB,mBAAmB,EAAE,IAAA,4CAAqC,EAAC,aAAa,CAAC;KAC1E,CAAC,CAAC,EAAE,4BAA4B,EAAE,IAAI,EAAE,CAAC,CAAC;AAC7C,CAAC;AA1DD,kDA0DC"}
|
|
@@ -11,7 +11,7 @@ export declare function getTask(payload: GetTaskRequest): RequestOptionsFactory<
|
|
|
11
11
|
* Creates a new task.
|
|
12
12
|
*
|
|
13
13
|
*
|
|
14
|
-
* The `createTask()` function returns a Promise that resolves to the ID of the
|
|
14
|
+
* The `createTask()` function returns a Promise that resolves to the ID of the created task.
|
|
15
15
|
*
|
|
16
16
|
* When creating a new task, the specified `task` object must contain a `title` value.
|
|
17
17
|
*/
|
|
@@ -22,7 +22,7 @@ export declare function createTask(payload: CreateTaskRequest): RequestOptionsFa
|
|
|
22
22
|
*
|
|
23
23
|
* The `updateTaskFields()` function returns a Promise that resolves to the ID of the the updated task after it has been successfully updated.
|
|
24
24
|
*
|
|
25
|
-
* Only the properties
|
|
25
|
+
* Only the properties in the `task` object are updated. All other properties remain the same.
|
|
26
26
|
*
|
|
27
27
|
* To remove a value from the task, pass its corresponding property with a value of `null`.
|
|
28
28
|
*/
|
|
@@ -75,7 +75,7 @@ exports.getTask = getTask;
|
|
|
75
75
|
* Creates a new task.
|
|
76
76
|
*
|
|
77
77
|
*
|
|
78
|
-
* The `createTask()` function returns a Promise that resolves to the ID of the
|
|
78
|
+
* The `createTask()` function returns a Promise that resolves to the ID of the created task.
|
|
79
79
|
*
|
|
80
80
|
* When creating a new task, the specified `task` object must contain a `title` value.
|
|
81
81
|
*/
|
|
@@ -110,7 +110,7 @@ exports.createTask = createTask;
|
|
|
110
110
|
*
|
|
111
111
|
* The `updateTaskFields()` function returns a Promise that resolves to the ID of the the updated task after it has been successfully updated.
|
|
112
112
|
*
|
|
113
|
-
* Only the properties
|
|
113
|
+
* Only the properties in the `task` object are updated. All other properties remain the same.
|
|
114
114
|
*
|
|
115
115
|
* To remove a value from the task, pass its corresponding property with a value of `null`.
|
|
116
116
|
*/
|
|
@@ -6,23 +6,23 @@ export declare const __debug: {
|
|
|
6
6
|
};
|
|
7
7
|
export interface Task {
|
|
8
8
|
/**
|
|
9
|
-
* The ID of the task. Should not be
|
|
9
|
+
* The ID of the task. Should not be populated in `createTask`.
|
|
10
10
|
* @readonly
|
|
11
11
|
*/
|
|
12
12
|
taskId?: string;
|
|
13
13
|
/** The ID of the creator of the task. */
|
|
14
14
|
creator?: Creator;
|
|
15
|
-
/**
|
|
15
|
+
/** The title of the task. */
|
|
16
16
|
title?: string;
|
|
17
17
|
/** States if the task is completed */
|
|
18
18
|
isCompleted?: boolean;
|
|
19
|
-
/**
|
|
19
|
+
/** Expected completion date for the task. */
|
|
20
20
|
dueAt?: Date;
|
|
21
|
-
/** Assigned contact ID
|
|
21
|
+
/** Assigned contact ID for the task */
|
|
22
22
|
contactId?: string;
|
|
23
|
-
/** Task
|
|
23
|
+
/** Task version. Incremented on each change. */
|
|
24
24
|
version?: number;
|
|
25
|
-
/** Assigned Wix user ID
|
|
25
|
+
/** Assigned Wix user ID for the task. */
|
|
26
26
|
assigneeId?: string;
|
|
27
27
|
/** The labels assigned to the task */
|
|
28
28
|
labels?: Label[];
|
|
@@ -42,11 +42,15 @@ export declare enum CreatorType {
|
|
|
42
42
|
}
|
|
43
43
|
export interface Label {
|
|
44
44
|
/**
|
|
45
|
-
* The ID of the label. Should not be
|
|
45
|
+
* The ID of the label. Should not be populated in `createTask`.
|
|
46
46
|
* @readonly
|
|
47
47
|
*/
|
|
48
48
|
labelId?: string;
|
|
49
|
-
/**
|
|
49
|
+
/**
|
|
50
|
+
* Label name.
|
|
51
|
+
*
|
|
52
|
+
* Max: 50 characters
|
|
53
|
+
*/
|
|
50
54
|
name?: string;
|
|
51
55
|
/** Label's color. */
|
|
52
56
|
color?: string;
|
|
@@ -56,11 +60,11 @@ export interface GetTaskRequest {
|
|
|
56
60
|
_id: string;
|
|
57
61
|
}
|
|
58
62
|
export interface GetTaskResponse {
|
|
59
|
-
/**
|
|
63
|
+
/** Task information. */
|
|
60
64
|
task?: Task;
|
|
61
65
|
}
|
|
62
66
|
export interface GetTasksListRequest {
|
|
63
|
-
/** Assigned contact ID
|
|
67
|
+
/** Assigned contact ID for the task. Optional. */
|
|
64
68
|
contactId?: string;
|
|
65
69
|
/** Sort key. */
|
|
66
70
|
key?: SortKey;
|
|
@@ -109,7 +113,7 @@ export interface FilterBy {
|
|
|
109
113
|
isCompleted?: boolean | null;
|
|
110
114
|
/** Assignee ID. */
|
|
111
115
|
assigneeId?: string | null;
|
|
112
|
-
/**
|
|
116
|
+
/** The title of the task. */
|
|
113
117
|
title?: string | null;
|
|
114
118
|
/** Task title contains substring */
|
|
115
119
|
subtitle?: string | null;
|
|
@@ -151,17 +155,21 @@ export interface CountTasksResponse {
|
|
|
151
155
|
byRequestedField?: Record<string, number>;
|
|
152
156
|
}
|
|
153
157
|
export interface CreateTaskRequest {
|
|
154
|
-
/** Task
|
|
158
|
+
/** Task information. */
|
|
155
159
|
task?: TaskData;
|
|
156
160
|
}
|
|
157
161
|
export interface TaskData {
|
|
158
|
-
/**
|
|
162
|
+
/**
|
|
163
|
+
* The title of the task.
|
|
164
|
+
*
|
|
165
|
+
* Max: 500 characters.
|
|
166
|
+
*/
|
|
159
167
|
title?: string;
|
|
160
168
|
/** Due Date fot the task. */
|
|
161
169
|
dueAt?: Date;
|
|
162
|
-
/** Assigned contact ID
|
|
170
|
+
/** Assigned contact ID for the task. */
|
|
163
171
|
contactId?: string;
|
|
164
|
-
/**
|
|
172
|
+
/** Assignee ID for the task. */
|
|
165
173
|
assigneeId?: string;
|
|
166
174
|
/** The label IDs assigned to the task. */
|
|
167
175
|
labelIds?: string[];
|
|
@@ -187,9 +195,9 @@ export interface TaskNotification {
|
|
|
187
195
|
export interface UpdateTaskRequest {
|
|
188
196
|
/** Task ID. */
|
|
189
197
|
_id: string;
|
|
190
|
-
/**
|
|
198
|
+
/** Required fields. */
|
|
191
199
|
fields?: string[];
|
|
192
|
-
/** Task
|
|
200
|
+
/** Task information. */
|
|
193
201
|
task?: TaskData;
|
|
194
202
|
}
|
|
195
203
|
export interface UpdateTaskResponse {
|
|
@@ -201,7 +209,7 @@ export interface UpdateTaskResponse {
|
|
|
201
209
|
export interface CompleteTaskRequest {
|
|
202
210
|
/** Task ID. */
|
|
203
211
|
_id: string;
|
|
204
|
-
/**
|
|
212
|
+
/** Indicates whether the task is completed. */
|
|
205
213
|
isCompleted?: boolean | null;
|
|
206
214
|
}
|
|
207
215
|
export interface CompleteTaskResponse {
|
|
@@ -246,6 +254,7 @@ export interface DeleteCompletedResponse {
|
|
|
246
254
|
*
|
|
247
255
|
* This function is not a universal function and runs only on the backend.
|
|
248
256
|
* @public
|
|
257
|
+
* @documentationMaturity preview
|
|
249
258
|
* @requiredField _id
|
|
250
259
|
* @param _id - Task ID.
|
|
251
260
|
*/
|
|
@@ -254,14 +263,15 @@ export declare function getTask(_id: string): Promise<GetTaskResponse>;
|
|
|
254
263
|
* Creates a new task.
|
|
255
264
|
*
|
|
256
265
|
*
|
|
257
|
-
* The `createTask()` function returns a Promise that resolves to the ID of the
|
|
266
|
+
* The `createTask()` function returns a Promise that resolves to the ID of the created task.
|
|
258
267
|
*
|
|
259
268
|
* When creating a new task, the specified `task` object must contain a `title` value.
|
|
260
269
|
*
|
|
261
270
|
* This function is not a universal function and runs only on the backend.
|
|
262
|
-
* @param task - Task object with the creation data
|
|
263
271
|
* @public
|
|
272
|
+
* @documentationMaturity preview
|
|
264
273
|
* @requiredField task
|
|
274
|
+
* @param task - Task information.
|
|
265
275
|
*/
|
|
266
276
|
export declare function createTask(task: TaskData): Promise<CreateTaskResponse>;
|
|
267
277
|
/**
|
|
@@ -270,18 +280,19 @@ export declare function createTask(task: TaskData): Promise<CreateTaskResponse>;
|
|
|
270
280
|
*
|
|
271
281
|
* The `updateTaskFields()` function returns a Promise that resolves to the ID of the the updated task after it has been successfully updated.
|
|
272
282
|
*
|
|
273
|
-
* Only the properties
|
|
283
|
+
* Only the properties in the `task` object are updated. All other properties remain the same.
|
|
274
284
|
*
|
|
275
285
|
* To remove a value from the task, pass its corresponding property with a value of `null`.
|
|
276
286
|
*
|
|
277
287
|
* This function is not a universal function and runs only on the backend.
|
|
278
|
-
* @param fields - Set of desired fields.
|
|
279
|
-
* @param task - Task object with the updated data
|
|
280
288
|
* @public
|
|
289
|
+
* @documentationMaturity preview
|
|
281
290
|
* @requiredField _id
|
|
282
291
|
* @requiredField fields
|
|
283
292
|
* @requiredField task
|
|
284
293
|
* @param _id - Task ID.
|
|
294
|
+
* @param task - Task information.
|
|
295
|
+
* @param fields - Required fields.
|
|
285
296
|
*/
|
|
286
297
|
export declare function updateTaskFields(_id: string, fields: string[], task: TaskData): Promise<UpdateTaskResponse>;
|
|
287
298
|
/**
|
|
@@ -291,12 +302,12 @@ export declare function updateTaskFields(_id: string, fields: string[], task: Ta
|
|
|
291
302
|
* The `updateTaskStatus()` function returns a Promise that resolves to the ID of the task whose completed status was updated.
|
|
292
303
|
*
|
|
293
304
|
* This function is not a universal function and runs only on the backend.
|
|
294
|
-
* @param isCompleted - Indication whether the task is completed
|
|
295
305
|
* @public
|
|
296
306
|
* @documentationMaturity preview
|
|
297
307
|
* @requiredField _id
|
|
298
308
|
* @requiredField isCompleted
|
|
299
309
|
* @param _id - Task ID.
|
|
310
|
+
* @param isCompleted - Indicates whether the task is completed.
|
|
300
311
|
*/
|
|
301
312
|
export declare function updateTaskStatus(_id: string, isCompleted: boolean | null): Promise<CompleteTaskResponse>;
|
|
302
313
|
/**
|
|
@@ -307,6 +318,7 @@ export declare function updateTaskStatus(_id: string, isCompleted: boolean | nul
|
|
|
307
318
|
*
|
|
308
319
|
* This function is not a universal function and runs only on the backend.
|
|
309
320
|
* @public
|
|
321
|
+
* @documentationMaturity preview
|
|
310
322
|
* @requiredField _id
|
|
311
323
|
* @param _id - Task ID.
|
|
312
324
|
*/
|