@wix/crm 1.0.61 → 1.0.63
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-contact.public.d.ts +9 -1
- package/build/cjs/src/contacts-v4-contact.types.d.ts +24 -45
- package/build/cjs/src/contacts-v4-contact.types.js.map +1 -1
- package/build/cjs/src/contacts-v4-contact.universal.d.ts +90 -49
- package/build/cjs/src/contacts-v4-contact.universal.js +14 -0
- package/build/cjs/src/contacts-v4-contact.universal.js.map +1 -1
- package/build/cjs/src/crm-tasks-v1-task.universal.d.ts +0 -10
- package/build/cjs/src/crm-tasks-v1-task.universal.js +0 -10
- package/build/cjs/src/crm-tasks-v1-task.universal.js.map +1 -1
- package/build/es/src/contacts-v4-contact.public.d.ts +9 -1
- package/build/es/src/contacts-v4-contact.types.d.ts +24 -45
- package/build/es/src/contacts-v4-contact.types.js.map +1 -1
- package/build/es/src/contacts-v4-contact.universal.d.ts +90 -49
- package/build/es/src/contacts-v4-contact.universal.js +14 -0
- package/build/es/src/contacts-v4-contact.universal.js.map +1 -1
- package/build/es/src/crm-tasks-v1-task.universal.d.ts +0 -10
- package/build/es/src/crm-tasks-v1-task.universal.js +0 -10
- package/build/es/src/crm-tasks-v1-task.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -290,8 +290,6 @@ export interface DeleteTaskResponseNonNullableFields {
|
|
|
290
290
|
* @documentationMaturity preview
|
|
291
291
|
* @requiredField _id
|
|
292
292
|
* @param _id - Task ID.
|
|
293
|
-
* @permissionScope Manage Tasks
|
|
294
|
-
* @applicableIdentity APP
|
|
295
293
|
*/
|
|
296
294
|
export declare function getTask(_id: string): Promise<GetTaskResponse & GetTaskResponseNonNullableFields>;
|
|
297
295
|
/**
|
|
@@ -305,8 +303,6 @@ export declare function getTask(_id: string): Promise<GetTaskResponse & GetTaskR
|
|
|
305
303
|
* @documentationMaturity preview
|
|
306
304
|
* @requiredField task
|
|
307
305
|
* @param task - Task information.
|
|
308
|
-
* @permissionScope Manage Tasks
|
|
309
|
-
* @applicableIdentity APP
|
|
310
306
|
*/
|
|
311
307
|
export declare function createTask(task: TaskData): Promise<CreateTaskResponse & CreateTaskResponseNonNullableFields>;
|
|
312
308
|
/**
|
|
@@ -326,8 +322,6 @@ export declare function createTask(task: TaskData): Promise<CreateTaskResponse &
|
|
|
326
322
|
* @param _id - Task ID.
|
|
327
323
|
* @param task - Task information.
|
|
328
324
|
* @param fields - Required fields.
|
|
329
|
-
* @permissionScope Manage Tasks
|
|
330
|
-
* @applicableIdentity APP
|
|
331
325
|
*/
|
|
332
326
|
export declare function updateTaskFields(_id: string, fields: string[], task: TaskData): Promise<UpdateTaskResponse & UpdateTaskResponseNonNullableFields>;
|
|
333
327
|
/**
|
|
@@ -341,8 +335,6 @@ export declare function updateTaskFields(_id: string, fields: string[], task: Ta
|
|
|
341
335
|
* @requiredField isCompleted
|
|
342
336
|
* @param _id - Task ID.
|
|
343
337
|
* @param isCompleted - Indicates whether the task is completed.
|
|
344
|
-
* @permissionScope Manage Tasks
|
|
345
|
-
* @applicableIdentity APP
|
|
346
338
|
*/
|
|
347
339
|
export declare function updateTaskStatus(_id: string, isCompleted: boolean | null): Promise<CompleteTaskResponse & CompleteTaskResponseNonNullableFields>;
|
|
348
340
|
/**
|
|
@@ -354,7 +346,5 @@ export declare function updateTaskStatus(_id: string, isCompleted: boolean | nul
|
|
|
354
346
|
* @documentationMaturity preview
|
|
355
347
|
* @requiredField _id
|
|
356
348
|
* @param _id - Task ID.
|
|
357
|
-
* @permissionScope Manage Tasks
|
|
358
|
-
* @applicableIdentity APP
|
|
359
349
|
*/
|
|
360
350
|
export declare function removeTask(_id: string): Promise<DeleteTaskResponse & DeleteTaskResponseNonNullableFields>;
|
|
@@ -82,8 +82,6 @@ const _updateTaskResponse = {};
|
|
|
82
82
|
* @documentationMaturity preview
|
|
83
83
|
* @requiredField _id
|
|
84
84
|
* @param _id - Task ID.
|
|
85
|
-
* @permissionScope Manage Tasks
|
|
86
|
-
* @applicableIdentity APP
|
|
87
85
|
*/
|
|
88
86
|
function getTask(_id) {
|
|
89
87
|
var _a, _b, _c;
|
|
@@ -140,8 +138,6 @@ exports.getTask = getTask;
|
|
|
140
138
|
* @documentationMaturity preview
|
|
141
139
|
* @requiredField task
|
|
142
140
|
* @param task - Task information.
|
|
143
|
-
* @permissionScope Manage Tasks
|
|
144
|
-
* @applicableIdentity APP
|
|
145
141
|
*/
|
|
146
142
|
function createTask(task) {
|
|
147
143
|
var _a, _b, _c;
|
|
@@ -204,8 +200,6 @@ exports.createTask = createTask;
|
|
|
204
200
|
* @param _id - Task ID.
|
|
205
201
|
* @param task - Task information.
|
|
206
202
|
* @param fields - Required fields.
|
|
207
|
-
* @permissionScope Manage Tasks
|
|
208
|
-
* @applicableIdentity APP
|
|
209
203
|
*/
|
|
210
204
|
function updateTaskFields(_id, fields, task) {
|
|
211
205
|
var _a, _b, _c;
|
|
@@ -264,8 +258,6 @@ exports.updateTaskFields = updateTaskFields;
|
|
|
264
258
|
* @requiredField isCompleted
|
|
265
259
|
* @param _id - Task ID.
|
|
266
260
|
* @param isCompleted - Indicates whether the task is completed.
|
|
267
|
-
* @permissionScope Manage Tasks
|
|
268
|
-
* @applicableIdentity APP
|
|
269
261
|
*/
|
|
270
262
|
function updateTaskStatus(_id, isCompleted) {
|
|
271
263
|
var _a, _b, _c;
|
|
@@ -321,8 +313,6 @@ exports.updateTaskStatus = updateTaskStatus;
|
|
|
321
313
|
* @documentationMaturity preview
|
|
322
314
|
* @requiredField _id
|
|
323
315
|
* @param _id - Task ID.
|
|
324
|
-
* @permissionScope Manage Tasks
|
|
325
|
-
* @applicableIdentity APP
|
|
326
316
|
*/
|
|
327
317
|
function removeTask(_id) {
|
|
328
318
|
var _a, _b, _c;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"crm-tasks-v1-task.universal.js","sourceRoot":"","sources":["../../../src/crm-tasks-v1-task.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,sFAAwE;AAExE,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;AAoC5B,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,0BAAW,CAAA;AACb,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAmCD,IAAY,OAKX;AALD,WAAY,OAAO;IACjB,uBAAuB;IACvB,gCAAqB,CAAA;IACrB,2BAA2B;IAC3B,sCAA2B,CAAA;AAC7B,CAAC,EALW,OAAO,GAAP,eAAO,KAAP,eAAO,QAKlB;AA+ED,IAAY,OAGX;AAHD,WAAY,OAAO;IACjB,0BAAe,CAAA;IACf,kCAAuB,CAAA;AACzB,CAAC,EAHW,OAAO,GAAP,eAAO,KAAP,eAAO,QAGlB;AAmJD,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B
|
|
1
|
+
{"version":3,"file":"crm-tasks-v1-task.universal.js","sourceRoot":"","sources":["../../../src/crm-tasks-v1-task.universal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAqE;AAErE,sFAAwE;AAExE,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;AAoC5B,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,4BAAa,CAAA;IACb,0BAAW,CAAA;AACb,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAmCD,IAAY,OAKX;AALD,WAAY,OAAO;IACjB,uBAAuB;IACvB,gCAAqB,CAAA;IACrB,2BAA2B;IAC3B,sCAA2B,CAAA;AAC7B,CAAC,EALW,OAAO,GAAP,eAAO,KAAP,eAAO,QAKlB;AA+ED,IAAY,OAGX;AAHD,WAAY,OAAO;IACjB,0BAAe,CAAA;IACf,kCAAuB,CAAA;AACzB,CAAC,EAHW,OAAO,GAAP,eAAO,KAAP,eAAO,QAGlB;AAmJD,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,eAAe,GAAG,EAAE,CAAC;AAC3B,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAE/B;;;;;;;;;GASG;AACH,SAAsB,OAAO,CAC3B,GAAW;;;QAEX,MAAM,qBAAqB,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;QAC7C,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,eAAe;YAC3B,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,gBAAgB;YAC5B,UAAU,EAAE,EAAE;YACd,kBAAkB,EAAE;gBAClB,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,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,GAAG,2BAA2B,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAE7D,KAAK,CAAC,mCAAmC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE/D,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;AApDD,0BAoDC;AAED;;;;;;;;;;;GAWG;AACH,SAAsB,UAAU,CAC9B,IAAc;;;QAEd,MAAM,qBAAqB,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC/C,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,kBAAkB;YAC9B,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,mBAAmB;YAC/B,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,IAAI,CAAC,CAAC,CAAC;QAE5C,MAAM,OAAO,GAAG,2BAA2B,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhE,KAAK,CAAC,sCAAsC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAElE,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,MAAM;aACP,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AApDD,gCAoDC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAsB,gBAAgB,CACpC,GAAW,EACX,MAAgB,EAChB,IAAc;;;QAEd,MAAM,qBAAqB,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;QAC3E,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,kBAAkB;YAC9B,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,mBAAmB;YAC/B,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,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;QAEzD,MAAM,OAAO,GAAG,2BAA2B,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhE,KAAK,CAAC,sCAAsC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAElE,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,QAAQ;gBACR,MAAM;aACP,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAxDD,4CAwDC;AAED;;;;;;;;;;;GAWG;AACH,SAAsB,gBAAgB,CACpC,GAAW,EACX,WAA2B;;;QAE3B,MAAM,qBAAqB,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC;QAClE,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,oBAAoB;YAChC,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,qBAAqB;YACjC,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,EAAE,WAAW,CAAC,CAAC,CAAC;QAExD,MAAM,OAAO,GAAG,2BAA2B,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAExE,KAAK,CAAC,8CAA8C,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAE1E,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,aAAa;aACd,CAAC,CAAC;YACH,MAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,+CAApB,WAAW,EAAY,GAAG,CAAC,CAAC;YAE5B,MAAM,gBAAgB,CAAC;SACxB;;CACF;AAtDD,4CAsDC;AAED;;;;;;;;;GASG;AACH,SAAsB,UAAU,CAC9B,GAAW;;;QAEX,MAAM,qBAAqB,GAAG,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC;QAC7C,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,kBAAkB;YAC9B,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,mBAAmB;YAC/B,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,GAAG,2BAA2B,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAEhE,KAAK,CAAC,sCAAsC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAElE,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;AApDD,gCAoDC"}
|
|
@@ -44,6 +44,14 @@ export declare function getContact(httpClient: HttpClient): (_id: string, option
|
|
|
44
44
|
image: string;
|
|
45
45
|
} | undefined;
|
|
46
46
|
} | undefined;
|
|
47
|
+
primaryEmail?: {
|
|
48
|
+
subscriptionStatus: import("./contacts-v4-contact.universal").SubscriptionStatus;
|
|
49
|
+
deliverabilityStatus: import("./contacts-v4-contact.universal").EmailDeliverabilityStatus;
|
|
50
|
+
} | undefined;
|
|
51
|
+
primaryPhone?: {
|
|
52
|
+
subscriptionStatus: import("./contacts-v4-contact.universal").SubscriptionStatus;
|
|
53
|
+
deliverabilityStatus: import("./contacts-v4-contact.universal").PhoneDeliverabilityStatus;
|
|
54
|
+
} | undefined;
|
|
47
55
|
}>;
|
|
48
56
|
export { ContactSourceType, ContactActivityType, EmailTag, PhoneTag, AddressTag, SubdivisionType, ImageProvider, SubscriptionStatus, EmailDeliverabilityStatus, PhoneDeliverabilityStatus, SortOrder, ContactFieldSet, ContactsFacetType, Action, UpsertContactResponseAction, GetContactResponseType, SubmitOperation, Mode, } from './contacts-v4-contact.universal';
|
|
49
|
-
export { Contact, ContactSource, ContactActivity, PrimaryContactInfo, ContactInfo, ContactName, ContactEmailsWrapper, ContactEmail, ContactPhonesWrapper, ContactPhone, ContactAddressesWrapper, ContactAddress, Address, AddressStreetOneOf, StreetAddress, AddressLocation, Subdivision, AssigneesWrapper, LabelsWrapper, ExtendedFieldsWrapper, LocationsWrapper, ContactPicture, SegmentsWrapper, PrimaryEmail, PrimaryPhone,
|
|
57
|
+
export { Contact, ContactSource, ContactActivity, PrimaryContactInfo, ContactInfo, ContactName, ContactEmailsWrapper, ContactEmail, ContactPhonesWrapper, ContactPhone, ContactAddressesWrapper, ContactAddress, Address, AddressStreetOneOf, StreetAddress, AddressLocation, Subdivision, AssigneesWrapper, LabelsWrapper, ExtendedFieldsWrapper, LocationsWrapper, ContactPicture, SegmentsWrapper, PrimaryEmail, PrimaryPhone, ContactSubmitted, ContactChanged, ContactEmailSubscriptionUpdated, ContactPhoneSubscriptionUpdated, ContactPrimaryInfoUpdated, CreateContactRequest, CreateContactResponse, DuplicateContactExists, UpdateContactRequest, UpdateContactResponse, MergeContactsRequest, MergeContactsResponse, ContactMerged, PreviewMergeContactsRequest, PreviewMergeContactsResponse, DeleteContactRequest, DeleteContactResponse, LabelContactRequest, LabelContactResponse, UnlabelContactRequest, UnlabelContactResponse, LabelAndUnlabelContactRequest, LabelAndUnlabelContactResponse, ListContactsRequest, Sorting, Paging, ListContactsResponse, PagingMetadata, QueryContactsRequest, Query, QueryContactsResponse, ListFacetsRequest, ListFacetsResponse, ContactsFacet, QueryFacetsRequest, QueryFacetsResponse, BulkDeleteContactsRequest, BulkDeleteContactsResponse, BulkUpdateContactsRequest, BulkUpdateContactsResponse, BulkLabelAndUnlabelContactsRequest, BulkLabelAndUnlabelContactsResponse, BulkUpsertContactsRequest, BulkUpsertContactsResponse, Error, Metadata, Item, BulkUpsertContactsResponseMetadata, UpsertContactRequest, UpsertContactResponse, GeneratePictureUploadUrlRequest, GeneratePictureUploadUrlResponse, GetContactRequest, GetContactResponse, SyncSubmitContactRequest, SyncSubmitContactResponse, CountContactsRequest, CountContactsResponse, SearchContactsRequest, Search, SearchPagingMethodOneOf, SearchDetails, CursorPaging, SearchContactsResponse, PagingMetadataV2, Cursors, BulkAddSegmentToContactsRequest, BulkAddSegmentToContactsResponse, ItemMetadata, ApplicationError, BulkActionMetadata, ContactAddedToSegment, BulkRemoveSegmentFromContactsRequest, BulkRemoveSegmentFromContactsResponse, ContactRemovedFromSegment, CreateContactResponseNonNullableFields, UpdateContactResponseNonNullableFields, MergeContactsResponseNonNullableFields, LabelContactResponseNonNullableFields, UnlabelContactResponseNonNullableFields, GetContactResponseNonNullableFields, CreateContactOptions, UpdateContactOptions, MergeContactsOptions, GetContactOptions, } from './contacts-v4-contact.universal';
|
|
@@ -50,6 +50,16 @@ export interface Contact {
|
|
|
50
50
|
picture?: Image;
|
|
51
51
|
/** Contact's details. */
|
|
52
52
|
info?: ContactInfo;
|
|
53
|
+
/**
|
|
54
|
+
* Contact's primary email details.
|
|
55
|
+
* @readonly
|
|
56
|
+
*/
|
|
57
|
+
primaryEmail?: PrimaryEmail;
|
|
58
|
+
/**
|
|
59
|
+
* Contact's primary phone details.
|
|
60
|
+
* @readonly
|
|
61
|
+
*/
|
|
62
|
+
primaryPhone?: PrimaryPhone;
|
|
53
63
|
}
|
|
54
64
|
export interface ContactSource {
|
|
55
65
|
/**
|
|
@@ -557,9 +567,7 @@ export interface PrimaryPhone {
|
|
|
557
567
|
*/
|
|
558
568
|
e164Phone?: string | null;
|
|
559
569
|
/**
|
|
560
|
-
*
|
|
561
|
-
* Automatically generated using `phone` and `countryCode`,
|
|
562
|
-
* as long as both of those values are valid.
|
|
570
|
+
* Formatted phone. Automatically generated using phone and countryCode.
|
|
563
571
|
* @readonly
|
|
564
572
|
*/
|
|
565
573
|
formattedPhone?: string | null;
|
|
@@ -580,38 +588,6 @@ export declare enum PhoneDeliverabilityStatus {
|
|
|
580
588
|
/** Deliverability status is not set. */
|
|
581
589
|
NOT_SET = "NOT_SET"
|
|
582
590
|
}
|
|
583
|
-
export interface EstimateFilterSizeRequest {
|
|
584
|
-
/** Contacts filter expression. */
|
|
585
|
-
filter?: Record<string, any> | null;
|
|
586
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
587
|
-
activeContactsOnly?: boolean;
|
|
588
|
-
/** Contacts plain text search expression (searches in name, phone and email fields). */
|
|
589
|
-
search?: string | null;
|
|
590
|
-
}
|
|
591
|
-
export interface EstimateFilterSizeResponse {
|
|
592
|
-
/** Mailing list size estimation. */
|
|
593
|
-
estimation?: number;
|
|
594
|
-
}
|
|
595
|
-
export interface EstimateAudienceSizeRequest {
|
|
596
|
-
/** Contact IDs of a campaign audience. */
|
|
597
|
-
contactIds?: string[];
|
|
598
|
-
/** Label IDs of a campaign audience. */
|
|
599
|
-
labelIds?: string[];
|
|
600
|
-
/** Contacts filter expression (json). */
|
|
601
|
-
contactsFilter?: Record<string, any> | null;
|
|
602
|
-
/** Contacts plain text search expression (searches in name, phone and email fields). */
|
|
603
|
-
search?: string | null;
|
|
604
|
-
/** Segment ids of a campaign audience. */
|
|
605
|
-
segmentIds?: string[];
|
|
606
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
607
|
-
activeContactsOnly?: boolean;
|
|
608
|
-
/** Id of a campaign that is to be resent. */
|
|
609
|
-
resendCampaignId?: string | null;
|
|
610
|
-
}
|
|
611
|
-
export interface EstimateAudienceSizeResponse {
|
|
612
|
-
/** Audience size estimation. */
|
|
613
|
-
estimation?: number;
|
|
614
|
-
}
|
|
615
591
|
export interface ContactSubmitted {
|
|
616
592
|
/** Pass through data, submitted with the contact */
|
|
617
593
|
passThroughData?: string | null;
|
|
@@ -827,7 +803,7 @@ export interface ListContactsRequest {
|
|
|
827
803
|
* `id` and `revision` are always returned.
|
|
828
804
|
*
|
|
829
805
|
* Supported properties:
|
|
830
|
-
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
|
|
806
|
+
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`, `primaryEmail`, `primaryPhone`,
|
|
831
807
|
* `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
|
|
832
808
|
* `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
|
|
833
809
|
* `info.labelKeys`, `info.locations`, `info.extendedFields`
|
|
@@ -840,7 +816,7 @@ export interface Sorting {
|
|
|
840
816
|
* Field to sort by.
|
|
841
817
|
*
|
|
842
818
|
* Supported properties:
|
|
843
|
-
* `createdDate`, `lastActivity.activityDate`, `primaryInfo.email`,
|
|
819
|
+
* `createdDate`, `lastActivity.activityDate`, `primaryInfo.email`, `primaryEmail.email`, `primaryPhone.e164Phone`
|
|
844
820
|
* `info.name.first`, `info.name.last`, `info.company`, `info.jobTitle`,
|
|
845
821
|
* `info.birthdate`
|
|
846
822
|
*/
|
|
@@ -935,7 +911,7 @@ export interface Query {
|
|
|
935
911
|
* `id` and `revision` are always returned.
|
|
936
912
|
*
|
|
937
913
|
* Supported properties:
|
|
938
|
-
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
|
|
914
|
+
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`, `primaryEmail`, `primaryPhone`,
|
|
939
915
|
* `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
|
|
940
916
|
* `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
|
|
941
917
|
* `info.labelKeys`, `info.locations`, `info.extendedFields`
|
|
@@ -946,9 +922,9 @@ export interface Query {
|
|
|
946
922
|
* If both `fields` and `fieldsets` are sent in the request,
|
|
947
923
|
* the union of both lists is returned.
|
|
948
924
|
*
|
|
949
|
-
* - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.
|
|
950
|
-
* - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
|
|
951
|
-
* - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.
|
|
925
|
+
* - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`.
|
|
926
|
+
* - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
|
|
927
|
+
* - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`, `info.extendedFields`.
|
|
952
928
|
* - `FULL`: Returns all fields.
|
|
953
929
|
*
|
|
954
930
|
* Default: If `fields` is omitted from the request, `FULL`.
|
|
@@ -1014,6 +990,9 @@ export interface QueryFacetsRequest {
|
|
|
1014
990
|
* #info.extendedFields.emailSubscriptions.effectiveEmail ($exists)
|
|
1015
991
|
* #info.extendedFields.emailSubscriptions.subscriptionStatus ($eq, $ne, $in, $nin)
|
|
1016
992
|
* #info.extendedFields.emailSubscriptions.deliverabilityStatus ($eq, $ne, $in, $nin)
|
|
993
|
+
* #primaryEmail.subscriptionStatus ($eq, $ne, $in, $nin)
|
|
994
|
+
* #primaryEmail.deliverabilityStatus ($eq, $ne, $in, $nin)
|
|
995
|
+
* #primaryPhone.subscriptionStatus ($eq, $ne, $in, $nin)
|
|
1017
996
|
*/
|
|
1018
997
|
filter?: Record<string, any> | null;
|
|
1019
998
|
}
|
|
@@ -1215,7 +1194,7 @@ export interface GetContactRequest {
|
|
|
1215
1194
|
* `id` and `revision` are always returned.
|
|
1216
1195
|
*
|
|
1217
1196
|
* Supported properties:
|
|
1218
|
-
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
|
|
1197
|
+
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`, `primaryEmail`, `primaryPhone`,
|
|
1219
1198
|
* `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
|
|
1220
1199
|
* `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
|
|
1221
1200
|
* `info.labelKeys`, `info.locations`, `info.extendedFields`
|
|
@@ -1226,9 +1205,9 @@ export interface GetContactRequest {
|
|
|
1226
1205
|
* If both `fields` and `fieldsets` are sent in the request,
|
|
1227
1206
|
* the union of both lists is returned.
|
|
1228
1207
|
*
|
|
1229
|
-
* - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.
|
|
1230
|
-
* - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
|
|
1231
|
-
* - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.
|
|
1208
|
+
* - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `primaryEmail`, `primaryPhone`.
|
|
1209
|
+
* - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
|
|
1210
|
+
* - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`, `info.extendedFields`.
|
|
1232
1211
|
* - `FULL`: Returns all fields.
|
|
1233
1212
|
*
|
|
1234
1213
|
* Default: If `fields` is omitted from the request, `FULL`.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts-v4-contact.types.js","sourceRoot":"","sources":["../../../src/contacts-v4-contact.types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"contacts-v4-contact.types.js","sourceRoot":"","sources":["../../../src/contacts-v4-contact.types.ts"],"names":[],"mappings":"AAwFA,MAAM,CAAN,IAAY,iBAoBX;AApBD,WAAY,iBAAiB;IAC3B,oCAAe,CAAA;IACf,oCAAe,CAAA;IACf,wCAAmB,CAAA;IACnB,sCAAiB,CAAA;IACjB,gDAA2B,CAAA;IAC3B,kDAA6B,CAAA;IAC7B,0CAAqB,CAAA;IACrB,gEAA2C,CAAA;IAC3C,8CAAyB,CAAA;IACzB,4CAAuB,CAAA;IACvB,8CAAyB,CAAA;IACzB,8CAAyB,CAAA;IACzB,0DAAqC,CAAA;IACrC,4CAAuB,CAAA;IACvB,wDAAmC,CAAA;IACnC,0DAAqC,CAAA;IACrC,8CAAyB,CAAA;IACzB,0CAAqB,CAAA;IACrB,kCAAa,CAAA;AACf,CAAC,EApBW,iBAAiB,KAAjB,iBAAiB,QAoB5B;AAcD,MAAM,CAAN,IAAY,mBAkFX;AAlFD,WAAY,mBAAmB;IAC7B,qDAAqD;IACrD,0CAAmB,CAAA;IACnB,+EAA+E;IAC/E,0DAAmC,CAAA;IACnC,mBAAmB;IACnB,oDAA6B,CAAA;IAC7B,sBAAsB;IACtB,0DAAmC,CAAA;IACnC,2BAA2B;IAC3B,sEAA+C,CAAA;IAC/C,0EAA0E;IAC1E,wDAAiC,CAAA;IACjC,+BAA+B;IAC/B,oEAA6C,CAAA;IAC7C,kCAAkC;IAClC,gFAAyD,CAAA;IACzD,yDAAyD;IACzD,8EAAuD,CAAA;IACvD,yDAAyD;IACzD,kFAA2D,CAAA;IAC3D,sEAAsE;IACtE,wGAAiF,CAAA;IACjF,4BAA4B;IAC5B,kGAA2E,CAAA;IAC3E,4BAA4B;IAC5B,sDAA+B,CAAA;IAC/B,gCAAgC;IAChC,8DAAuC,CAAA;IACvC,kCAAkC;IAClC,kEAA2C,CAAA;IAC3C,8BAA8B;IAC9B,oEAA6C,CAAA;IAC7C,2BAA2B;IAC3B,gEAAyC,CAAA;IACzC,wBAAwB;IACxB,0DAAmC,CAAA;IACnC,4BAA4B;IAC5B,kEAA2C,CAAA;IAC3C,sBAAsB;IACtB,sDAA+B,CAAA;IAC/B,uBAAuB;IACvB,wDAAiC,CAAA;IACjC,mBAAmB;IACnB,gDAAyB,CAAA;IACzB,gCAAgC;IAChC,0EAAmD,CAAA;IACnD,uBAAuB;IACvB,wDAAiC,CAAA;IACjC,oBAAoB;IACpB,kDAA2B,CAAA;IAC3B,oBAAoB;IACpB,kDAA2B,CAAA;IAC3B,wBAAwB;IACxB,0DAAmC,CAAA;IACnC,2BAA2B;IAC3B,gEAAyC,CAAA;IACzC,2BAA2B;IAC3B,gEAAyC,CAAA;IACzC,0BAA0B;IAC1B,8DAAuC,CAAA;IACvC,gCAAgC;IAChC,0EAAmD,CAAA;IACnD,sBAAsB;IACtB,sDAA+B,CAAA;IAC/B,uBAAuB;IACvB,wDAAiC,CAAA;IACjC,wDAAiC,CAAA;IACjC,0BAA0B;IAC1B,8FAAuE,CAAA;IACvE,qCAAqC;IACrC,0FAAmE,CAAA;IACnE,qCAAqC;IACrC,0FAAmE,CAAA;IACnE,6CAA6C;IAC7C,oFAA6D,CAAA;IAC7D,2CAA2C;IAC3C,gFAAyD,CAAA;IACzD,2CAA2C;IAC3C,gFAAyD,CAAA;IACzD,+CAA+C;IAC/C,wFAAiE,CAAA;AACnE,CAAC,EAlFW,mBAAmB,KAAnB,mBAAmB,QAkF9B;AA+HD,MAAM,CAAN,IAAY,QAKX;AALD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EALW,QAAQ,KAAR,QAAQ,QAKnB;AAuCD,MAAM,CAAN,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,iCAAqB,CAAA;IACrB,yBAAa,CAAA;IACb,yBAAa,CAAA;IACb,6BAAiB,CAAA;IACjB,yBAAa,CAAA;IACb,uBAAW,CAAA;AACb,CAAC,EAPW,QAAQ,KAAR,QAAQ,QAOnB;AAsBD,MAAM,CAAN,IAAY,UAMX;AAND,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,2BAAa,CAAA;IACb,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;AACvB,CAAC,EANW,UAAU,KAAV,UAAU,QAMrB;AA0DD,MAAM,CAAN,IAAY,eAcX;AAdD,WAAY,eAAe;IACzB,wEAAqD,CAAA;IACrD,YAAY;IACZ,8EAA2D,CAAA;IAC3D,aAAa;IACb,8EAA2D,CAAA;IAC3D,gBAAgB;IAChB,8EAA2D,CAAA;IAC3D,2BAA2B;IAC3B,8EAA2D,CAAA;IAC3D,mBAAmB;IACnB,8EAA2D,CAAA;IAC3D,8IAA8I;IAC9I,sCAAmB,CAAA;AACrB,CAAC,EAdW,eAAe,KAAf,eAAe,QAc1B;AAgDD,MAAM,CAAN,IAAY,aAMX;AAND,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,+BAA+B;IAC/B,sCAAqB,CAAA;IACrB,yFAAyF;IACzF,wCAAuB,CAAA;AACzB,CAAC,EANW,aAAa,KAAb,aAAa,QAMxB;AA6BD,MAAM,CAAN,IAAY,kBAUX;AAVD,WAAY,kBAAkB;IAC5B,iFAA2D,CAAA;IAC3D,sCAAsC;IACtC,yCAAmB,CAAA;IACnB,4BAA4B;IAC5B,yCAAmB,CAAA;IACnB,kBAAkB;IAClB,+CAAyB,CAAA;IACzB,oBAAoB;IACpB,mDAA6B,CAAA;AAC/B,CAAC,EAVW,kBAAkB,KAAlB,kBAAkB,QAU7B;AAED,MAAM,CAAN,IAAY,yBAYX;AAZD,WAAY,yBAAyB;IACnC,wGAA2E,CAAA;IAC3E,wCAAwC;IACxC,gDAAmB,CAAA;IACnB,sBAAsB;IACtB,4CAAe,CAAA;IACf,gCAAgC;IAChC,gDAAmB,CAAA;IACnB,sBAAsB;IACtB,8DAAiC,CAAA;IACjC,uCAAuC;IACvC,kDAAqB,CAAA;AACvB,CAAC,EAZW,yBAAyB,KAAzB,yBAAyB,QAYpC;AA+BD,MAAM,CAAN,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACnC,wGAA2E,CAAA;IAC3E,wCAAwC;IACxC,gDAAmB,CAAA;AACrB,CAAC,EAJW,yBAAyB,KAAzB,yBAAyB,QAIpC;AA2QD,MAAM,CAAN,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,wBAAW,CAAA;IACX,0BAAa,CAAA;AACf,CAAC,EAHW,SAAS,KAAT,SAAS,QAGpB;AAcD,MAAM,CAAN,IAAY,eASX;AATD,WAAY,eAAe;IACzB,uCAAuC;IACvC,kCAAe,CAAA;IACf,sCAAsC;IACtC,kEAA+C,CAAA;IAC/C,sDAAsD;IACtD,wCAAqB,CAAA;IACrB,0BAA0B;IAC1B,gCAAa,CAAA;AACf,CAAC,EATW,eAAe,KAAf,eAAe,QAS1B;AAgID,MAAM,CAAN,IAAY,iBAOX;AAPD,WAAY,iBAAiB;IAC3B,wCAAmB,CAAA;IACnB,kDAA6B,CAAA;IAC7B,gDAA2B,CAAA;IAC3B,oCAAe,CAAA;IACf,gEAA2C,CAAA;IAC3C,4DAAuC,CAAA;AACzC,CAAC,EAPW,iBAAiB,KAAjB,iBAAiB,QAO5B;AAiKD,MAAM,CAAN,IAAY,MAIX;AAJD,WAAY,MAAM;IAChB,6BAAmB,CAAA;IACnB,6BAAmB,CAAA;IACnB,6BAAmB,CAAA;AACrB,CAAC,EAJW,MAAM,KAAN,MAAM,QAIjB;AAuCD,MAAM,CAAN,IAAY,2BAIX;AAJD,WAAY,2BAA2B;IACrC,kDAAmB,CAAA;IACnB,kDAAmB,CAAA;IACnB,kDAAmB,CAAA;AACrB,CAAC,EAJW,2BAA2B,KAA3B,2BAA2B,QAItC;AA+DD,MAAM,CAAN,IAAY,sBAOX;AAPD,WAAY,sBAAsB;IAChC,qBAAqB;IACrB,6CAAmB,CAAA;IACnB,qFAAqF;IACrF,+CAAqB,CAAA;IACrB,8CAA8C;IAC9C,2CAAiB,CAAA;AACnB,CAAC,EAPW,sBAAsB,KAAtB,sBAAsB,QAOjC;AAcD,MAAM,CAAN,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,oCAAiB,CAAA;IACjB,oCAAiB,CAAA;AACnB,CAAC,EAJW,eAAe,KAAf,eAAe,QAI1B;AAuED,MAAM,CAAN,IAAY,IAKX;AALD,WAAY,IAAI;IACd,UAAU;IACV,iBAAS,CAAA;IACT,UAAU;IACV,mBAAW,CAAA;AACb,CAAC,EALW,IAAI,KAAJ,IAAI,QAKf"}
|
|
@@ -58,6 +58,16 @@ export interface Contact {
|
|
|
58
58
|
picture?: string;
|
|
59
59
|
/** Contact's details. */
|
|
60
60
|
info?: ContactInfo;
|
|
61
|
+
/**
|
|
62
|
+
* Contact's primary email details.
|
|
63
|
+
* @readonly
|
|
64
|
+
*/
|
|
65
|
+
primaryEmail?: PrimaryEmail;
|
|
66
|
+
/**
|
|
67
|
+
* Contact's primary phone details.
|
|
68
|
+
* @readonly
|
|
69
|
+
*/
|
|
70
|
+
primaryPhone?: PrimaryPhone;
|
|
61
71
|
}
|
|
62
72
|
export interface ContactSource {
|
|
63
73
|
/**
|
|
@@ -587,9 +597,7 @@ export interface PrimaryPhone {
|
|
|
587
597
|
*/
|
|
588
598
|
e164Phone?: string | null;
|
|
589
599
|
/**
|
|
590
|
-
*
|
|
591
|
-
* Automatically generated using `phone` and `countryCode`,
|
|
592
|
-
* as long as both of those values are valid.
|
|
600
|
+
* Formatted phone. Automatically generated using phone and countryCode.
|
|
593
601
|
* @readonly
|
|
594
602
|
*/
|
|
595
603
|
formattedPhone?: string | null;
|
|
@@ -610,38 +618,6 @@ export declare enum PhoneDeliverabilityStatus {
|
|
|
610
618
|
/** Deliverability status is not set. */
|
|
611
619
|
NOT_SET = "NOT_SET"
|
|
612
620
|
}
|
|
613
|
-
export interface EstimateFilterSizeRequest {
|
|
614
|
-
/** Contacts filter expression. */
|
|
615
|
-
filter?: Record<string, any> | null;
|
|
616
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
617
|
-
activeContactsOnly?: boolean;
|
|
618
|
-
/** Contacts plain text search expression (searches in name, phone and email fields). */
|
|
619
|
-
search?: string | null;
|
|
620
|
-
}
|
|
621
|
-
export interface EstimateFilterSizeResponse {
|
|
622
|
-
/** Mailing list size estimation. */
|
|
623
|
-
estimation?: number;
|
|
624
|
-
}
|
|
625
|
-
export interface EstimateAudienceSizeRequest {
|
|
626
|
-
/** Contact IDs of a campaign audience. */
|
|
627
|
-
contactIds?: string[];
|
|
628
|
-
/** Label IDs of a campaign audience. */
|
|
629
|
-
labelIds?: string[];
|
|
630
|
-
/** Contacts filter expression (json). */
|
|
631
|
-
contactsFilter?: Record<string, any> | null;
|
|
632
|
-
/** Contacts plain text search expression (searches in name, phone and email fields). */
|
|
633
|
-
search?: string | null;
|
|
634
|
-
/** Segment ids of a campaign audience. */
|
|
635
|
-
segmentIds?: string[];
|
|
636
|
-
/** Should "inactive" contacts be excluded or not (default value "false"). */
|
|
637
|
-
activeContactsOnly?: boolean;
|
|
638
|
-
/** Id of a campaign that is to be resent. */
|
|
639
|
-
resendCampaignId?: string | null;
|
|
640
|
-
}
|
|
641
|
-
export interface EstimateAudienceSizeResponse {
|
|
642
|
-
/** Audience size estimation. */
|
|
643
|
-
estimation?: number;
|
|
644
|
-
}
|
|
645
621
|
export interface ContactSubmitted {
|
|
646
622
|
/** Pass through data, submitted with the contact */
|
|
647
623
|
passThroughData?: string | null;
|
|
@@ -857,7 +833,7 @@ export interface ListContactsRequest {
|
|
|
857
833
|
* `id` and `revision` are always returned.
|
|
858
834
|
*
|
|
859
835
|
* Supported properties:
|
|
860
|
-
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
|
|
836
|
+
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`, `primaryEmail`, `primaryPhone`,
|
|
861
837
|
* `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
|
|
862
838
|
* `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
|
|
863
839
|
* `info.labelKeys`, `info.locations`, `info.extendedFields`
|
|
@@ -870,7 +846,7 @@ export interface Sorting {
|
|
|
870
846
|
* Field to sort by.
|
|
871
847
|
*
|
|
872
848
|
* Supported properties:
|
|
873
|
-
* `createdDate`, `lastActivity.activityDate`, `primaryInfo.email`,
|
|
849
|
+
* `createdDate`, `lastActivity.activityDate`, `primaryInfo.email`, `primaryEmail.email`, `primaryPhone.e164Phone`
|
|
874
850
|
* `info.name.first`, `info.name.last`, `info.company`, `info.jobTitle`,
|
|
875
851
|
* `info.birthdate`
|
|
876
852
|
*/
|
|
@@ -960,7 +936,7 @@ export interface Query {
|
|
|
960
936
|
* `id` and `revision` are always returned.
|
|
961
937
|
*
|
|
962
938
|
* Supported properties:
|
|
963
|
-
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
|
|
939
|
+
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`, `primaryEmail`, `primaryPhone`,
|
|
964
940
|
* `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
|
|
965
941
|
* `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
|
|
966
942
|
* `info.labelKeys`, `info.locations`, `info.extendedFields`
|
|
@@ -971,9 +947,9 @@ export interface Query {
|
|
|
971
947
|
* If both `fields` and `fieldsets` are sent in the request,
|
|
972
948
|
* the union of both lists is returned.
|
|
973
949
|
*
|
|
974
|
-
* - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.
|
|
975
|
-
* - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
|
|
976
|
-
* - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.
|
|
950
|
+
* - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`.
|
|
951
|
+
* - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
|
|
952
|
+
* - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`, `info.extendedFields`.
|
|
977
953
|
* - `FULL`: Returns all fields.
|
|
978
954
|
*
|
|
979
955
|
* Default: If `fields` is omitted from the request, `FULL`.
|
|
@@ -1039,6 +1015,9 @@ export interface QueryFacetsRequest {
|
|
|
1039
1015
|
* #info.extendedFields.emailSubscriptions.effectiveEmail ($exists)
|
|
1040
1016
|
* #info.extendedFields.emailSubscriptions.subscriptionStatus ($eq, $ne, $in, $nin)
|
|
1041
1017
|
* #info.extendedFields.emailSubscriptions.deliverabilityStatus ($eq, $ne, $in, $nin)
|
|
1018
|
+
* #primaryEmail.subscriptionStatus ($eq, $ne, $in, $nin)
|
|
1019
|
+
* #primaryEmail.deliverabilityStatus ($eq, $ne, $in, $nin)
|
|
1020
|
+
* #primaryPhone.subscriptionStatus ($eq, $ne, $in, $nin)
|
|
1042
1021
|
*/
|
|
1043
1022
|
filter?: Record<string, any> | null;
|
|
1044
1023
|
}
|
|
@@ -1240,7 +1219,7 @@ export interface GetContactRequest {
|
|
|
1240
1219
|
* `id` and `revision` are always returned.
|
|
1241
1220
|
*
|
|
1242
1221
|
* Supported properties:
|
|
1243
|
-
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
|
|
1222
|
+
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`, `primaryEmail`, `primaryPhone`,
|
|
1244
1223
|
* `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
|
|
1245
1224
|
* `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
|
|
1246
1225
|
* `info.labelKeys`, `info.locations`, `info.extendedFields`
|
|
@@ -1251,9 +1230,9 @@ export interface GetContactRequest {
|
|
|
1251
1230
|
* If both `fields` and `fieldsets` are sent in the request,
|
|
1252
1231
|
* the union of both lists is returned.
|
|
1253
1232
|
*
|
|
1254
|
-
* - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.
|
|
1255
|
-
* - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
|
|
1256
|
-
* - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.
|
|
1233
|
+
* - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `primaryEmail`, `primaryPhone`.
|
|
1234
|
+
* - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
|
|
1235
|
+
* - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`, `info.extendedFields`.
|
|
1257
1236
|
* - `FULL`: Returns all fields.
|
|
1258
1237
|
*
|
|
1259
1238
|
* Default: If `fields` is omitted from the request, `FULL`.
|
|
@@ -1497,6 +1476,14 @@ export interface CreateContactResponseNonNullableFields {
|
|
|
1497
1476
|
image: string;
|
|
1498
1477
|
};
|
|
1499
1478
|
};
|
|
1479
|
+
primaryEmail?: {
|
|
1480
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1481
|
+
deliverabilityStatus: EmailDeliverabilityStatus;
|
|
1482
|
+
};
|
|
1483
|
+
primaryPhone?: {
|
|
1484
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1485
|
+
deliverabilityStatus: PhoneDeliverabilityStatus;
|
|
1486
|
+
};
|
|
1500
1487
|
};
|
|
1501
1488
|
}
|
|
1502
1489
|
export interface UpdateContactResponseNonNullableFields {
|
|
@@ -1535,6 +1522,14 @@ export interface UpdateContactResponseNonNullableFields {
|
|
|
1535
1522
|
image: string;
|
|
1536
1523
|
};
|
|
1537
1524
|
};
|
|
1525
|
+
primaryEmail?: {
|
|
1526
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1527
|
+
deliverabilityStatus: EmailDeliverabilityStatus;
|
|
1528
|
+
};
|
|
1529
|
+
primaryPhone?: {
|
|
1530
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1531
|
+
deliverabilityStatus: PhoneDeliverabilityStatus;
|
|
1532
|
+
};
|
|
1538
1533
|
};
|
|
1539
1534
|
}
|
|
1540
1535
|
export interface MergeContactsResponseNonNullableFields {
|
|
@@ -1573,6 +1568,14 @@ export interface MergeContactsResponseNonNullableFields {
|
|
|
1573
1568
|
image: string;
|
|
1574
1569
|
};
|
|
1575
1570
|
};
|
|
1571
|
+
primaryEmail?: {
|
|
1572
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1573
|
+
deliverabilityStatus: EmailDeliverabilityStatus;
|
|
1574
|
+
};
|
|
1575
|
+
primaryPhone?: {
|
|
1576
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1577
|
+
deliverabilityStatus: PhoneDeliverabilityStatus;
|
|
1578
|
+
};
|
|
1576
1579
|
};
|
|
1577
1580
|
}
|
|
1578
1581
|
export interface LabelContactResponseNonNullableFields {
|
|
@@ -1611,6 +1614,14 @@ export interface LabelContactResponseNonNullableFields {
|
|
|
1611
1614
|
image: string;
|
|
1612
1615
|
};
|
|
1613
1616
|
};
|
|
1617
|
+
primaryEmail?: {
|
|
1618
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1619
|
+
deliverabilityStatus: EmailDeliverabilityStatus;
|
|
1620
|
+
};
|
|
1621
|
+
primaryPhone?: {
|
|
1622
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1623
|
+
deliverabilityStatus: PhoneDeliverabilityStatus;
|
|
1624
|
+
};
|
|
1614
1625
|
};
|
|
1615
1626
|
}
|
|
1616
1627
|
export interface UnlabelContactResponseNonNullableFields {
|
|
@@ -1649,6 +1660,14 @@ export interface UnlabelContactResponseNonNullableFields {
|
|
|
1649
1660
|
image: string;
|
|
1650
1661
|
};
|
|
1651
1662
|
};
|
|
1663
|
+
primaryEmail?: {
|
|
1664
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1665
|
+
deliverabilityStatus: EmailDeliverabilityStatus;
|
|
1666
|
+
};
|
|
1667
|
+
primaryPhone?: {
|
|
1668
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1669
|
+
deliverabilityStatus: PhoneDeliverabilityStatus;
|
|
1670
|
+
};
|
|
1652
1671
|
};
|
|
1653
1672
|
}
|
|
1654
1673
|
export interface GetContactResponseNonNullableFields {
|
|
@@ -1687,6 +1706,14 @@ export interface GetContactResponseNonNullableFields {
|
|
|
1687
1706
|
image: string;
|
|
1688
1707
|
};
|
|
1689
1708
|
};
|
|
1709
|
+
primaryEmail?: {
|
|
1710
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1711
|
+
deliverabilityStatus: EmailDeliverabilityStatus;
|
|
1712
|
+
};
|
|
1713
|
+
primaryPhone?: {
|
|
1714
|
+
subscriptionStatus: SubscriptionStatus;
|
|
1715
|
+
deliverabilityStatus: PhoneDeliverabilityStatus;
|
|
1716
|
+
};
|
|
1690
1717
|
};
|
|
1691
1718
|
responseType: GetContactResponseType;
|
|
1692
1719
|
}
|
|
@@ -1718,6 +1745,8 @@ export interface GetContactResponseNonNullableFields {
|
|
|
1718
1745
|
* @documentationMaturity preview
|
|
1719
1746
|
* @requiredField info
|
|
1720
1747
|
* @param options - Create contact options.
|
|
1748
|
+
* @permissionScope Manage Contacts
|
|
1749
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
1721
1750
|
* @applicableIdentity APP
|
|
1722
1751
|
* @returns Contact.
|
|
1723
1752
|
*/
|
|
@@ -1764,6 +1793,8 @@ export interface CreateContactOptions {
|
|
|
1764
1793
|
* @requiredField info
|
|
1765
1794
|
* @requiredField options.revision
|
|
1766
1795
|
* @param options - Contact update options.
|
|
1796
|
+
* @permissionScope Manage Contacts
|
|
1797
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
1767
1798
|
* @applicableIdentity APP
|
|
1768
1799
|
* @returns Updated contact.
|
|
1769
1800
|
*/
|
|
@@ -1830,6 +1861,7 @@ export interface UpdateContactOptions {
|
|
|
1830
1861
|
* @requiredField targetContactRevision
|
|
1831
1862
|
* @param options - Merge contacts options.
|
|
1832
1863
|
* @permissionScope Manage Contacts
|
|
1864
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
1833
1865
|
* @applicableIdentity APP
|
|
1834
1866
|
*/
|
|
1835
1867
|
export declare function mergeContacts(targetContactId: string, targetContactRevision: number | null, options?: MergeContactsOptions): Promise<MergeContactsResponse & MergeContactsResponseNonNullableFields>;
|
|
@@ -1864,6 +1896,8 @@ export interface MergeContactsOptions {
|
|
|
1864
1896
|
* @public
|
|
1865
1897
|
* @documentationMaturity preview
|
|
1866
1898
|
* @requiredField contactId
|
|
1899
|
+
* @permissionScope Manage Contacts
|
|
1900
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
1867
1901
|
* @applicableIdentity APP
|
|
1868
1902
|
*/
|
|
1869
1903
|
export declare function deleteContact(contactId: string): Promise<void>;
|
|
@@ -1895,6 +1929,8 @@ export declare function deleteContact(contactId: string): Promise<void>;
|
|
|
1895
1929
|
* @documentationMaturity preview
|
|
1896
1930
|
* @requiredField contactId
|
|
1897
1931
|
* @requiredField labelKeys
|
|
1932
|
+
* @permissionScope Manage Contacts
|
|
1933
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
1898
1934
|
* @applicableIdentity APP
|
|
1899
1935
|
* @returns Updated contact.
|
|
1900
1936
|
*/
|
|
@@ -1923,6 +1959,8 @@ export declare function labelContact(contactId: string, labelKeys: string[]): Pr
|
|
|
1923
1959
|
* @documentationMaturity preview
|
|
1924
1960
|
* @requiredField contactId
|
|
1925
1961
|
* @requiredField labelKeys
|
|
1962
|
+
* @permissionScope Manage Contacts
|
|
1963
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
1926
1964
|
* @applicableIdentity APP
|
|
1927
1965
|
* @returns Updated contact.
|
|
1928
1966
|
*/
|
|
@@ -1955,6 +1993,9 @@ export declare function unlabelContact(contactId: string, labelKeys: string[]):
|
|
|
1955
1993
|
* @requiredField _id
|
|
1956
1994
|
* @param options - Get contact options.
|
|
1957
1995
|
* @permissionScope Read Contacts
|
|
1996
|
+
* @permissionScope Read Members and Contacts - all read permissions
|
|
1997
|
+
* @permissionScope Manage Contacts
|
|
1998
|
+
* @permissionScope Manage Members and Contacts - all permissions
|
|
1958
1999
|
* @applicableIdentity APP
|
|
1959
2000
|
* @returns The requested contact.
|
|
1960
2001
|
*/
|
|
@@ -1967,7 +2008,7 @@ export interface GetContactOptions {
|
|
|
1967
2008
|
* `id` and `revision` are always returned.
|
|
1968
2009
|
*
|
|
1969
2010
|
* Supported properties:
|
|
1970
|
-
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`,
|
|
2011
|
+
* `source`, `createdDate`, `updatedDate`, `lastActivity`, `primaryInfo`, `primaryEmail`, `primaryPhone`,
|
|
1971
2012
|
* `info.name`, `info.emails`, `info.phones`, `info.addresses`, `info.company`,
|
|
1972
2013
|
* `info.jobTitle`, `info.picture`, `info.birthdate`, `info.locale`,
|
|
1973
2014
|
* `info.labelKeys`, `info.locations`, `info.extendedFields`
|
|
@@ -1978,9 +2019,9 @@ export interface GetContactOptions {
|
|
|
1978
2019
|
* If both `fields` and `fieldsets` are sent in the request,
|
|
1979
2020
|
* the union of both lists is returned.
|
|
1980
2021
|
*
|
|
1981
|
-
* - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`.
|
|
1982
|
-
* - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
|
|
1983
|
-
* - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `info.extendedFields`.
|
|
2022
|
+
* - `BASIC`: Returns `id`, `revision`, `primaryInfo`, `info.name`, `primaryEmail`, `primaryPhone`.
|
|
2023
|
+
* - `COMMUNICATION_DETAILS`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`, `info.emails`, `info.phones`, `info.addresses`.
|
|
2024
|
+
* - `EXTENDED`: Returns `id`, `revision`, `primaryInfo`, `primaryEmail`, `primaryPhone`, `info.name`, `info.extendedFields`.
|
|
1984
2025
|
* - `FULL`: Returns all fields.
|
|
1985
2026
|
*
|
|
1986
2027
|
* Default: If `fields` is omitted from the request, `FULL`.
|