@wix/crm 1.0.2 → 1.0.3
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.http.d.ts +59 -35
- package/build/cjs/src/contacts-v4-contact.http.js +93 -35
- package/build/cjs/src/contacts-v4-contact.http.js.map +1 -1
- package/build/cjs/src/contacts-v4-contact.public.d.ts +3 -2
- package/build/cjs/src/contacts-v4-contact.public.js +7 -1
- package/build/cjs/src/contacts-v4-contact.public.js.map +1 -1
- package/build/cjs/src/contacts-v4-contact.universal.d.ts +77 -34
- package/build/cjs/src/contacts-v4-contact.universal.js +116 -35
- package/build/cjs/src/contacts-v4-contact.universal.js.map +1 -1
- package/build/es/src/contacts-v4-contact.http.d.ts +59 -35
- package/build/es/src/contacts-v4-contact.http.js +91 -34
- package/build/es/src/contacts-v4-contact.http.js.map +1 -1
- package/build/es/src/contacts-v4-contact.public.d.ts +3 -2
- package/build/es/src/contacts-v4-contact.public.js +6 -1
- package/build/es/src/contacts-v4-contact.public.js.map +1 -1
- package/build/es/src/contacts-v4-contact.universal.d.ts +77 -34
- package/build/es/src/contacts-v4-contact.universal.js +114 -34
- package/build/es/src/contacts-v4-contact.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,19 +1,13 @@
|
|
|
1
1
|
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
|
-
import { CreateContactRequest, CreateContactResponse, DeleteContactRequest, DeleteContactResponse, GetContactRequest, GetContactResponse, LabelContactRequest, LabelContactResponse, MergeContactsRequest, MergeContactsResponse, UnlabelContactRequest, UnlabelContactResponse, UpdateContactRequest, UpdateContactResponse } from './contacts-v4-contact.types';
|
|
2
|
+
import { CreateContactRequest, CreateContactResponse, DeleteContactRequest, DeleteContactResponse, GetContactRequest, GetContactResponse, LabelContactRequest, LabelContactResponse, MergeContactsRequest, MergeContactsResponse, QueryContactsRequest, QueryContactsResponse, UnlabelContactRequest, UnlabelContactResponse, UpdateContactRequest, UpdateContactResponse } from './contacts-v4-contact.types';
|
|
3
3
|
/**
|
|
4
4
|
* Creates a new contact.
|
|
5
5
|
*
|
|
6
6
|
*
|
|
7
7
|
* The `createContact()` function returns a Promise
|
|
8
8
|
* that resolves to the new contact when it is created.
|
|
9
|
-
* > **Note:**
|
|
10
|
-
* > This function replaces the deprecated
|
|
11
|
-
* > `wixCrmBackend.createContact()`.
|
|
12
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
13
|
-
* > To keep any existing code compatible with future changes, see the
|
|
14
|
-
* > [migration instructions](wix-crm-backend/createcontact#migration-instructions).
|
|
15
9
|
*
|
|
16
|
-
* The `
|
|
10
|
+
* The `info` parameter object must include a name, phone number, or email address.
|
|
17
11
|
* If all 3 of these parameters are missing,
|
|
18
12
|
* the contact won't be created.
|
|
19
13
|
*
|
|
@@ -37,13 +31,6 @@ export declare function createContact(payload: CreateContactRequest): RequestOpt
|
|
|
37
31
|
* The `updateContact()` function returns a Promise that resolves
|
|
38
32
|
* when the specified contact's information is updated.
|
|
39
33
|
*
|
|
40
|
-
* > **Note:**
|
|
41
|
-
* > This function replaces the deprecated
|
|
42
|
-
* > `wixCrmBackend.updateContact()`.
|
|
43
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
44
|
-
* > To keep any existing code compatible with future changes, see the
|
|
45
|
-
* > [migration instructions](wix-crm-backend/updatecontact#migration-instructions).
|
|
46
|
-
*
|
|
47
34
|
* Each time the contact is updated,
|
|
48
35
|
* `revision` increments by 1.
|
|
49
36
|
* The existing `revision` must be included when updating the contact.
|
|
@@ -90,9 +77,11 @@ export declare function updateContact(payload: UpdateContactRequest): RequestOpt
|
|
|
90
77
|
*
|
|
91
78
|
* Merging contacts triggers these webhooks:
|
|
92
79
|
*
|
|
93
|
-
* -
|
|
94
|
-
* -
|
|
95
|
-
* -
|
|
80
|
+
* - Contact Merged is triggered.
|
|
81
|
+
* - Contact Updated is triggered for the target contact. `originatedFrom` is set to `merge`.
|
|
82
|
+
* - Contact Deleted is triggered for each source contact. `originatedFrom` is set to `merge`.
|
|
83
|
+
*
|
|
84
|
+
* This function is not a universal function and runs only on the backend.
|
|
96
85
|
*/
|
|
97
86
|
export declare function mergeContacts(payload: MergeContactsRequest): RequestOptionsFactory<MergeContactsResponse>;
|
|
98
87
|
/**
|
|
@@ -100,12 +89,6 @@ export declare function mergeContacts(payload: MergeContactsRequest): RequestOpt
|
|
|
100
89
|
*
|
|
101
90
|
* The `deleteContact()` function returns a Promise
|
|
102
91
|
* that resolves when the specified contact is deleted.
|
|
103
|
-
* > **Note:**
|
|
104
|
-
* > This function replaces the deprecated
|
|
105
|
-
* > `wixCrmBackend.deleteContact()`.
|
|
106
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
107
|
-
* > To keep any existing code compatible with future changes, see the
|
|
108
|
-
* > [migration instructions](wix-crm-backend/deletecontact#migration-instructions).
|
|
109
92
|
*
|
|
110
93
|
* Deleting a contact permanently removes them from your Contact List.
|
|
111
94
|
*
|
|
@@ -128,8 +111,8 @@ export declare function deleteContact(payload: DeleteContactRequest): RequestOpt
|
|
|
128
111
|
*
|
|
129
112
|
* The `labelContact()` function returns a Promise
|
|
130
113
|
* that resolves when the specified labels are added to the contact.
|
|
131
|
-
* - **To create new labels:** Use [`findOrCreateLabel()`](
|
|
132
|
-
* - **To find labels:** Use [`findOrCreateLabel()`](
|
|
114
|
+
* - **To create new labels:** Use [`findOrCreateLabel()`](#contacts/findorcreatelabel).
|
|
115
|
+
* - **To find labels:** Use [`findOrCreateLabel()`](#contacts/findorcreatelabel), [`getLabel()`](#contacts/getlabel), or [`queryLabels()`](#contacts/queryLabels).
|
|
133
116
|
*
|
|
134
117
|
* <!--
|
|
135
118
|
* > **Note:**
|
|
@@ -148,8 +131,8 @@ export declare function labelContact(payload: LabelContactRequest): RequestOptio
|
|
|
148
131
|
*
|
|
149
132
|
* If a label is no longer needed
|
|
150
133
|
* and you want to remove it from all contacts,
|
|
151
|
-
* you can delete it with
|
|
152
|
-
*
|
|
134
|
+
* you can delete it with Labels
|
|
135
|
+
* `deleteLabel()`.
|
|
153
136
|
*
|
|
154
137
|
* <!--
|
|
155
138
|
* > **Note:**
|
|
@@ -160,6 +143,53 @@ export declare function labelContact(payload: LabelContactRequest): RequestOptio
|
|
|
160
143
|
* -->
|
|
161
144
|
*/
|
|
162
145
|
export declare function unlabelContact(payload: UnlabelContactRequest): RequestOptionsFactory<UnlabelContactResponse>;
|
|
146
|
+
/**
|
|
147
|
+
* Creates a query to retrieve a list of contacts.
|
|
148
|
+
*
|
|
149
|
+
* The `queryContacts()` function builds a query to retrieve a list of contacts
|
|
150
|
+
* and returns a
|
|
151
|
+
* [`ContactsQueryBuilder`](wix-crm-backend/contacts/contactsquerybuilder)
|
|
152
|
+
* object.
|
|
153
|
+
*
|
|
154
|
+
* The returned object contains the query definition,
|
|
155
|
+
* which is typically used to run the query using the
|
|
156
|
+
* [`find()`](wix-crm-backend/contacts/contactsquerybuilder/find)
|
|
157
|
+
* function.
|
|
158
|
+
*
|
|
159
|
+
* You can refine the query
|
|
160
|
+
* by chaining `ContactsQueryBuilder` functions onto the query.
|
|
161
|
+
* `ContactsQueryBuilder` functions enable you to sort, filter,
|
|
162
|
+
* and control the results `queryContacts()` returns.
|
|
163
|
+
*
|
|
164
|
+
* `queryContacts()` runs with these `ContactsQueryBuilder` defaults,
|
|
165
|
+
* which you can override:
|
|
166
|
+
*
|
|
167
|
+
* - [`skip(0)`](wix-crm-backend/contacts/contactsquerybuilder/skip)
|
|
168
|
+
* - [`limit(50)`](wix-crm-backend/contacts/contactsquerybuilder/limit)
|
|
169
|
+
* - [`descending("_createdDate")`](wix-crm-backend/contacts/contactsquerybuilder/descending)
|
|
170
|
+
*
|
|
171
|
+
* The functions that are chained to `queryContacts()`
|
|
172
|
+
* are applied in the order they are called.
|
|
173
|
+
* For example, if you apply `ascending('info.company')`
|
|
174
|
+
* and then `descending('info.name.last')`,
|
|
175
|
+
* the results are sorted first by the company name, and then,
|
|
176
|
+
* if there are multiple results with the same company,
|
|
177
|
+
* the items are sorted by last name.
|
|
178
|
+
*
|
|
179
|
+
* <!--
|
|
180
|
+
* > **Note:**
|
|
181
|
+
* > Only visitors with
|
|
182
|
+
* > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
|
|
183
|
+
* > can query contacts.
|
|
184
|
+
* > You can override the permissions by setting the `suppressAuth` option to `true`
|
|
185
|
+
* > in the [`find()`](wix-crm-backend/contacts/contactsquerybuilder/find) function.
|
|
186
|
+
* -->
|
|
187
|
+
*
|
|
188
|
+
* For property support for filters and sorting, see
|
|
189
|
+
* [Query contacts: Supported filters, sorting, and search](wix-crm-backend/contacts/sort-and-filter#query-contacts-supported-filters,-sorting,-and-search).
|
|
190
|
+
*
|
|
191
|
+
*/
|
|
192
|
+
export declare function queryContacts(payload: QueryContactsRequest): RequestOptionsFactory<QueryContactsResponse>;
|
|
163
193
|
/**
|
|
164
194
|
* Retrieves a contact.
|
|
165
195
|
*
|
|
@@ -176,13 +206,7 @@ export declare function unlabelContact(payload: UnlabelContactRequest): RequestO
|
|
|
176
206
|
* This is supported only when calling `getContact()`,
|
|
177
207
|
* and only for merged contacts.
|
|
178
208
|
* Deleted source contact IDs are not supported on any other function.
|
|
179
|
-
*
|
|
180
|
-
* >
|
|
181
|
-
* > - This function replaces the deprecated
|
|
182
|
-
* > `wixCrmBackend.getContactById()`.
|
|
183
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
184
|
-
* > To keep any existing code compatible with future changes, see the
|
|
185
|
-
* > [migration instructions](wix-crm-backend/getcontactbyid#migration-instructions).
|
|
209
|
+
*
|
|
186
210
|
* <!-- > - Only visitors with
|
|
187
211
|
* > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
|
|
188
212
|
* > can retrieve contacts.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.getContact = exports.unlabelContact = exports.labelContact = exports.deleteContact = exports.mergeContacts = exports.updateContact = exports.createContact = void 0;
|
|
3
|
+
exports.getContact = exports.queryContacts = exports.unlabelContact = exports.labelContact = exports.deleteContact = exports.mergeContacts = exports.updateContact = exports.createContact = void 0;
|
|
4
4
|
const metro_runtime_1 = require("@wix/metro-runtime");
|
|
5
5
|
const ambassador_1 = require("@wix/metro-runtime/ambassador");
|
|
6
6
|
const metro_runtime_2 = require("@wix/metro-runtime");
|
|
@@ -35,6 +35,8 @@ const _labelContactRequest = {};
|
|
|
35
35
|
const _labelContactResponse = { contact: '_contact' };
|
|
36
36
|
const _mergeContactsRequest = {};
|
|
37
37
|
const _mergeContactsResponse = { contact: '_contact' };
|
|
38
|
+
const _queryContactsRequest = {};
|
|
39
|
+
const _queryContactsResponse = { contacts: '_contact' };
|
|
38
40
|
const _unlabelContactRequest = {};
|
|
39
41
|
const _unlabelContactResponse = { contact: '_contact' };
|
|
40
42
|
const _updateContactRequest = {
|
|
@@ -105,14 +107,8 @@ function resolveComWixpressContactsCoreApiV4ContactsServiceV4Url(opts) {
|
|
|
105
107
|
*
|
|
106
108
|
* The `createContact()` function returns a Promise
|
|
107
109
|
* that resolves to the new contact when it is created.
|
|
108
|
-
* > **Note:**
|
|
109
|
-
* > This function replaces the deprecated
|
|
110
|
-
* > `wixCrmBackend.createContact()`.
|
|
111
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
112
|
-
* > To keep any existing code compatible with future changes, see the
|
|
113
|
-
* > [migration instructions](wix-crm-backend/createcontact#migration-instructions).
|
|
114
110
|
*
|
|
115
|
-
* The `
|
|
111
|
+
* The `info` parameter object must include a name, phone number, or email address.
|
|
116
112
|
* If all 3 of these parameters are missing,
|
|
117
113
|
* the contact won't be created.
|
|
118
114
|
*
|
|
@@ -176,13 +172,6 @@ exports.createContact = createContact;
|
|
|
176
172
|
* The `updateContact()` function returns a Promise that resolves
|
|
177
173
|
* when the specified contact's information is updated.
|
|
178
174
|
*
|
|
179
|
-
* > **Note:**
|
|
180
|
-
* > This function replaces the deprecated
|
|
181
|
-
* > `wixCrmBackend.updateContact()`.
|
|
182
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
183
|
-
* > To keep any existing code compatible with future changes, see the
|
|
184
|
-
* > [migration instructions](wix-crm-backend/updatecontact#migration-instructions).
|
|
185
|
-
*
|
|
186
175
|
* Each time the contact is updated,
|
|
187
176
|
* `revision` increments by 1.
|
|
188
177
|
* The existing `revision` must be included when updating the contact.
|
|
@@ -269,9 +258,11 @@ exports.updateContact = updateContact;
|
|
|
269
258
|
*
|
|
270
259
|
* Merging contacts triggers these webhooks:
|
|
271
260
|
*
|
|
272
|
-
* -
|
|
273
|
-
* -
|
|
274
|
-
* -
|
|
261
|
+
* - Contact Merged is triggered.
|
|
262
|
+
* - Contact Updated is triggered for the target contact. `originatedFrom` is set to `merge`.
|
|
263
|
+
* - Contact Deleted is triggered for each source contact. `originatedFrom` is set to `merge`.
|
|
264
|
+
*
|
|
265
|
+
* This function is not a universal function and runs only on the backend.
|
|
275
266
|
*/
|
|
276
267
|
function mergeContacts(payload) {
|
|
277
268
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_mergeContactsRequest, {});
|
|
@@ -311,12 +302,6 @@ exports.mergeContacts = mergeContacts;
|
|
|
311
302
|
*
|
|
312
303
|
* The `deleteContact()` function returns a Promise
|
|
313
304
|
* that resolves when the specified contact is deleted.
|
|
314
|
-
* > **Note:**
|
|
315
|
-
* > This function replaces the deprecated
|
|
316
|
-
* > `wixCrmBackend.deleteContact()`.
|
|
317
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
318
|
-
* > To keep any existing code compatible with future changes, see the
|
|
319
|
-
* > [migration instructions](wix-crm-backend/deletecontact#migration-instructions).
|
|
320
305
|
*
|
|
321
306
|
* Deleting a contact permanently removes them from your Contact List.
|
|
322
307
|
*
|
|
@@ -361,8 +346,8 @@ exports.deleteContact = deleteContact;
|
|
|
361
346
|
*
|
|
362
347
|
* The `labelContact()` function returns a Promise
|
|
363
348
|
* that resolves when the specified labels are added to the contact.
|
|
364
|
-
* - **To create new labels:** Use [`findOrCreateLabel()`](
|
|
365
|
-
* - **To find labels:** Use [`findOrCreateLabel()`](
|
|
349
|
+
* - **To create new labels:** Use [`findOrCreateLabel()`](#contacts/findorcreatelabel).
|
|
350
|
+
* - **To find labels:** Use [`findOrCreateLabel()`](#contacts/findorcreatelabel), [`getLabel()`](#contacts/getlabel), or [`queryLabels()`](#contacts/queryLabels).
|
|
366
351
|
*
|
|
367
352
|
* <!--
|
|
368
353
|
* > **Note:**
|
|
@@ -413,8 +398,8 @@ exports.labelContact = labelContact;
|
|
|
413
398
|
*
|
|
414
399
|
* If a label is no longer needed
|
|
415
400
|
* and you want to remove it from all contacts,
|
|
416
|
-
* you can delete it with
|
|
417
|
-
*
|
|
401
|
+
* you can delete it with Labels
|
|
402
|
+
* `deleteLabel()`.
|
|
418
403
|
*
|
|
419
404
|
* <!--
|
|
420
405
|
* > **Note:**
|
|
@@ -457,6 +442,85 @@ function unlabelContact(payload) {
|
|
|
457
442
|
return __unlabelContact;
|
|
458
443
|
}
|
|
459
444
|
exports.unlabelContact = unlabelContact;
|
|
445
|
+
/**
|
|
446
|
+
* Creates a query to retrieve a list of contacts.
|
|
447
|
+
*
|
|
448
|
+
* The `queryContacts()` function builds a query to retrieve a list of contacts
|
|
449
|
+
* and returns a
|
|
450
|
+
* [`ContactsQueryBuilder`](wix-crm-backend/contacts/contactsquerybuilder)
|
|
451
|
+
* object.
|
|
452
|
+
*
|
|
453
|
+
* The returned object contains the query definition,
|
|
454
|
+
* which is typically used to run the query using the
|
|
455
|
+
* [`find()`](wix-crm-backend/contacts/contactsquerybuilder/find)
|
|
456
|
+
* function.
|
|
457
|
+
*
|
|
458
|
+
* You can refine the query
|
|
459
|
+
* by chaining `ContactsQueryBuilder` functions onto the query.
|
|
460
|
+
* `ContactsQueryBuilder` functions enable you to sort, filter,
|
|
461
|
+
* and control the results `queryContacts()` returns.
|
|
462
|
+
*
|
|
463
|
+
* `queryContacts()` runs with these `ContactsQueryBuilder` defaults,
|
|
464
|
+
* which you can override:
|
|
465
|
+
*
|
|
466
|
+
* - [`skip(0)`](wix-crm-backend/contacts/contactsquerybuilder/skip)
|
|
467
|
+
* - [`limit(50)`](wix-crm-backend/contacts/contactsquerybuilder/limit)
|
|
468
|
+
* - [`descending("_createdDate")`](wix-crm-backend/contacts/contactsquerybuilder/descending)
|
|
469
|
+
*
|
|
470
|
+
* The functions that are chained to `queryContacts()`
|
|
471
|
+
* are applied in the order they are called.
|
|
472
|
+
* For example, if you apply `ascending('info.company')`
|
|
473
|
+
* and then `descending('info.name.last')`,
|
|
474
|
+
* the results are sorted first by the company name, and then,
|
|
475
|
+
* if there are multiple results with the same company,
|
|
476
|
+
* the items are sorted by last name.
|
|
477
|
+
*
|
|
478
|
+
* <!--
|
|
479
|
+
* > **Note:**
|
|
480
|
+
* > Only visitors with
|
|
481
|
+
* > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
|
|
482
|
+
* > can query contacts.
|
|
483
|
+
* > You can override the permissions by setting the `suppressAuth` option to `true`
|
|
484
|
+
* > in the [`find()`](wix-crm-backend/contacts/contactsquerybuilder/find) function.
|
|
485
|
+
* -->
|
|
486
|
+
*
|
|
487
|
+
* For property support for filters and sorting, see
|
|
488
|
+
* [Query contacts: Supported filters, sorting, and search](wix-crm-backend/contacts/sort-and-filter#query-contacts-supported-filters,-sorting,-and-search).
|
|
489
|
+
*
|
|
490
|
+
*/
|
|
491
|
+
function queryContacts(payload) {
|
|
492
|
+
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_queryContactsRequest, {});
|
|
493
|
+
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_queryContactsResponse, {
|
|
494
|
+
_address,
|
|
495
|
+
_addressLocation,
|
|
496
|
+
_contact,
|
|
497
|
+
_contactActivity,
|
|
498
|
+
_contactAddress,
|
|
499
|
+
_contactAddressesWrapper,
|
|
500
|
+
_contactInfo,
|
|
501
|
+
_contactPicture,
|
|
502
|
+
_image,
|
|
503
|
+
});
|
|
504
|
+
function __queryContacts({ host }) {
|
|
505
|
+
const serializedData = toReq(payload);
|
|
506
|
+
const metadata = {
|
|
507
|
+
entityFqdn: 'wix.contacts.v4.contact',
|
|
508
|
+
method: 'POST',
|
|
509
|
+
methodFqn: 'com.wixpress.contacts.core.api.v4.ContactsServiceV4.QueryContacts',
|
|
510
|
+
url: resolveComWixpressContactsCoreApiV4ContactsServiceV4Url({
|
|
511
|
+
protoPath: '/v4/contacts/query',
|
|
512
|
+
data: serializedData,
|
|
513
|
+
host,
|
|
514
|
+
}),
|
|
515
|
+
data: serializedData,
|
|
516
|
+
transformResponse: fromRes,
|
|
517
|
+
};
|
|
518
|
+
return metadata;
|
|
519
|
+
}
|
|
520
|
+
__queryContacts.fromReq = fromReq;
|
|
521
|
+
return __queryContacts;
|
|
522
|
+
}
|
|
523
|
+
exports.queryContacts = queryContacts;
|
|
460
524
|
/**
|
|
461
525
|
* Retrieves a contact.
|
|
462
526
|
*
|
|
@@ -473,13 +537,7 @@ exports.unlabelContact = unlabelContact;
|
|
|
473
537
|
* This is supported only when calling `getContact()`,
|
|
474
538
|
* and only for merged contacts.
|
|
475
539
|
* Deleted source contact IDs are not supported on any other function.
|
|
476
|
-
*
|
|
477
|
-
* >
|
|
478
|
-
* > - This function replaces the deprecated
|
|
479
|
-
* > `wixCrmBackend.getContactById()`.
|
|
480
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
481
|
-
* > To keep any existing code compatible with future changes, see the
|
|
482
|
-
* > [migration instructions](wix-crm-backend/getcontactbyid#migration-instructions).
|
|
540
|
+
*
|
|
483
541
|
* <!-- > - Only visitors with
|
|
484
542
|
* > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
|
|
485
543
|
* > can retrieve contacts.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts-v4-contact.http.js","sourceRoot":"","sources":["../../../src/contacts-v4-contact.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;
|
|
1
|
+
{"version":3,"file":"contacts-v4-contact.http.js","sourceRoot":"","sources":["../../../src/contacts-v4-contact.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAsBhD,MAAM,QAAQ,GAAG,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC;AACjD,MAAM,gBAAgB,GAAG;IACvB,QAAQ,EAAE,6BAA6B;IACvC,SAAS,EAAE,6BAA6B;CACzC,CAAC;AACF,MAAM,QAAQ,GAAG;IACf,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;IACxC,YAAY,EAAE,kBAAkB;IAChC,OAAO,EAAE,QAAQ;IACjB,IAAI,EAAE,cAAc;CACrB,CAAC;AACF,MAAM,gBAAgB,GAAG,EAAE,YAAY,EAAE,2BAA2B,EAAE,CAAC;AACvE,MAAM,eAAe,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AAChD,MAAM,wBAAwB,GAAG,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC;AAC9D,MAAM,YAAY,GAAG;IACnB,SAAS,EAAE,0BAA0B;IACrC,OAAO,EAAE,iBAAiB;CAC3B,CAAC;AACF,MAAM,eAAe,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAC5C,MAAM,qBAAqB,GAAG,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC;AACvD,MAAM,sBAAsB,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AACvD,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AACpD,MAAM,MAAM,GAAG,EAAE,iBAAiB,EAAE,2BAA2B,EAAE,CAAC;AAClE,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAChC,MAAM,qBAAqB,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AACtD,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AACvD,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACjC,MAAM,sBAAsB,GAAG,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;AACxD,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AACxD,MAAM,qBAAqB,GAAG;IAC5B,SAAS,EAAE,2BAA2B;IACtC,IAAI,EAAE,cAAc;CACrB,CAAC;AACF,MAAM,sBAAsB,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AAEvD,SAAS,uDAAuD,CAC9D,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,eAAe;gBACxB,QAAQ,EAAE,EAAE;aACb;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,UAAU;aACrB;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,kBAAkB;gBAC3B,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,UAAU;aACrB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,cAAc;aACzB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,UAAU;aACrB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qBAAqB,EACrB;QACE,QAAQ;QACR,gBAAgB;QAChB,eAAe;QACf,wBAAwB;QACxB,YAAY;QACZ,eAAe;QACf,MAAM;KACP,CACF,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,sBAAsB,EAAE;QAC/D,QAAQ;QACR,gBAAgB;QAChB,QAAQ;QACR,gBAAgB;QAChB,eAAe;QACf,wBAAwB;QACxB,YAAY;QACZ,eAAe;QACf,MAAM;KACP,CAAC,CAAC;IAEH,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,mEAAmE;YACrE,GAAG,EAAE,uDAAuD,CAAC;gBAC3D,SAAS,EAAE,cAAc;gBACzB,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IAElC,OAAO,eAAe,CAAC;AACzB,CAAC;AAjDD,sCAiDC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qBAAqB,EACrB;QACE,QAAQ;QACR,gBAAgB;QAChB,eAAe;QACf,wBAAwB;QACxB,YAAY;QACZ,eAAe;QACf,MAAM;KACP,CACF,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,sBAAsB,EAAE;QAC/D,QAAQ;QACR,gBAAgB;QAChB,QAAQ;QACR,gBAAgB;QAChB,eAAe;QACf,wBAAwB;QACxB,YAAY;QACZ,eAAe;QACf,MAAM;KACP,CAAC,CAAC;IAEH,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,OAAc;YACtB,SAAS,EACP,mEAAmE;YACrE,GAAG,EAAE,uDAAuD,CAAC;gBAC3D,SAAS,EAAE,0BAA0B;gBACrC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IAElC,OAAO,eAAe,CAAC;AACzB,CAAC;AAjDD,sCAiDC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,sBAAsB,EAAE;QAC/D,QAAQ;QACR,gBAAgB;QAChB,QAAQ;QACR,gBAAgB;QAChB,eAAe;QACf,wBAAwB;QACxB,YAAY;QACZ,eAAe;QACf,MAAM;KACP,CAAC,CAAC;IAEH,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,mEAAmE;YACrE,GAAG,EAAE,uDAAuD,CAAC;gBAC3D,SAAS,EAAE,sCAAsC;gBACjD,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IAElC,OAAO,eAAe,CAAC;AACzB,CAAC;AAzCD,sCAyCC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;IAErE,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,QAAe;YACvB,SAAS,EACP,mEAAmE;YACrE,GAAG,EAAE,uDAAuD,CAAC;gBAC3D,SAAS,EAAE,0BAA0B;gBACrC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IAElC,OAAO,eAAe,CAAC;AACzB,CAAC;AA/BD,sCA+BC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,YAAY,CAC1B,OAA4B;IAE5B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,oBAAoB,EACpB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,qBAAqB,EAAE;QAC9D,QAAQ;QACR,gBAAgB;QAChB,QAAQ;QACR,gBAAgB;QAChB,eAAe;QACf,wBAAwB;QACxB,YAAY;QACZ,eAAe;QACf,MAAM;KACP,CAAC,CAAC;IAEH,SAAS,cAAc,CAAC,EAAE,IAAI,EAAO;QACnC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,kEAAkE;YACpE,GAAG,EAAE,uDAAuD,CAAC;gBAC3D,SAAS,EAAE,iCAAiC;gBAC5C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,cAAc,CAAC,OAAO,GAAG,OAAO,CAAC;IAEjC,OAAO,cAAc,CAAC;AACxB,CAAC;AAzCD,oCAyCC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,cAAc,CAC5B,OAA8B;IAE9B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,sBAAsB,EACtB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,uBAAuB,EAAE;QAChE,QAAQ;QACR,gBAAgB;QAChB,QAAQ;QACR,gBAAgB;QAChB,eAAe;QACf,wBAAwB;QACxB,YAAY;QACZ,eAAe;QACf,MAAM;KACP,CAAC,CAAC;IAEH,SAAS,gBAAgB,CAAC,EAAE,IAAI,EAAO;QACrC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,QAAe;YACvB,SAAS,EACP,oEAAoE;YACtE,GAAG,EAAE,uDAAuD,CAAC;gBAC3D,SAAS,EAAE,iCAAiC;gBAC5C,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEnC,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAzCD,wCAyCC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,SAAgB,aAAa,CAC3B,OAA6B;IAE7B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,qBAAqB,EACrB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,sBAAsB,EAAE;QAC/D,QAAQ;QACR,gBAAgB;QAChB,QAAQ;QACR,gBAAgB;QAChB,eAAe;QACf,wBAAwB;QACxB,YAAY;QACZ,eAAe;QACf,MAAM;KACP,CAAC,CAAC;IAEH,SAAS,eAAe,CAAC,EAAE,IAAI,EAAO;QACpC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,mEAAmE;YACrE,GAAG,EAAE,uDAAuD,CAAC;gBAC3D,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,eAAe,CAAC,OAAO,GAAG,OAAO,CAAC;IAElC,OAAO,eAAe,CAAC;AACzB,CAAC;AAzCD,sCAyCC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,SAAgB,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,kBAAkB,EAClB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,mBAAmB,EAAE;QAC5D,QAAQ;QACR,gBAAgB;QAChB,QAAQ;QACR,gBAAgB;QAChB,eAAe;QACf,wBAAwB;QACxB,YAAY;QACZ,eAAe;QACf,MAAM;KACP,CAAC,CAAC;IAEH,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,yBAAyB;YACrC,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,gEAAgE;YAClE,GAAG,EAAE,uDAAuD,CAAC;gBAC3D,SAAS,EAAE,mBAAmB;gBAC9B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/B,OAAO,YAAY,CAAC;AACtB,CAAC;AAzCD,gCAyCC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { HttpClient } from '@wix/sdk-types';
|
|
2
|
-
import { ContactInfo, UpdateContactOptions, CreateContactOptions, GetContactOptions, MergeContactsOptions } from './contacts-v4-contact.universal';
|
|
2
|
+
import { ContactInfo, UpdateContactOptions, CreateContactOptions, GetContactOptions, MergeContactsOptions, QueryContactsOptions } from './contacts-v4-contact.universal';
|
|
3
3
|
export declare const __metadata: {
|
|
4
4
|
PACKAGE_NAME: string;
|
|
5
5
|
};
|
|
@@ -9,6 +9,7 @@ export declare function mergeContacts(httpClient: HttpClient): (targetContactId:
|
|
|
9
9
|
export declare function deleteContact(httpClient: HttpClient): (contactId: string) => Promise<void>;
|
|
10
10
|
export declare function labelContact(httpClient: HttpClient): (contactId: string, labelKeys: string[]) => Promise<import("./contacts-v4-contact.universal").LabelContactResponse>;
|
|
11
11
|
export declare function unlabelContact(httpClient: HttpClient): (contactId: string, labelKeys: string[]) => Promise<import("./contacts-v4-contact.universal").UnlabelContactResponse>;
|
|
12
|
+
export declare function queryContacts(httpClient: HttpClient): (options?: QueryContactsOptions | undefined) => Promise<import("./contacts-v4-contact.universal").QueryContactsResponse>;
|
|
12
13
|
export declare function getContact(httpClient: HttpClient): (_id: string, options?: GetContactOptions | undefined) => Promise<import("./contacts-v4-contact.universal").Contact>;
|
|
13
14
|
export { ContactSourceType, ContactActivityType, EmailTag, PhoneTag, AddressTag, SubdivisionType, ImageProvider, SortOrder, ContactFieldSet, ContactsFacetType, Action, UpsertContactResponseAction, GetContactResponseType, SubmitOperation, Mode, } from './contacts-v4-contact.universal';
|
|
14
|
-
export { Contact, ContactSource, ContactActivity, PrimaryContactInfo, ContactInfo, ContactName, ContactEmailsWrapper, ContactEmail, ContactPhonesWrapper, ContactPhone, ContactAddressesWrapper, ContactAddress, Address, AddressStreetOneOf, StreetAddress, AddressLocation, Subdivision, AssigneesWrapper, LabelsWrapper, ExtendedFieldsWrapper, LocationsWrapper, ContactPicture, SegmentsWrapper, EstimateFilterSizeRequest, EstimateFilterSizeResponse, EstimateAudienceSizeRequest, EstimateAudienceSizeResponse, ContactSubmitted, ContactChanged, 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, CreateContactOptions, UpdateContactOptions, MergeContactsOptions, GetContactOptions, } from './contacts-v4-contact.universal';
|
|
15
|
+
export { Contact, ContactSource, ContactActivity, PrimaryContactInfo, ContactInfo, ContactName, ContactEmailsWrapper, ContactEmail, ContactPhonesWrapper, ContactPhone, ContactAddressesWrapper, ContactAddress, Address, AddressStreetOneOf, StreetAddress, AddressLocation, Subdivision, AssigneesWrapper, LabelsWrapper, ExtendedFieldsWrapper, LocationsWrapper, ContactPicture, SegmentsWrapper, EstimateFilterSizeRequest, EstimateFilterSizeResponse, EstimateAudienceSizeRequest, EstimateAudienceSizeResponse, ContactSubmitted, ContactChanged, 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, CreateContactOptions, UpdateContactOptions, MergeContactsOptions, QueryContactsOptions, GetContactOptions, } from './contacts-v4-contact.universal';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.Mode = exports.SubmitOperation = exports.GetContactResponseType = exports.UpsertContactResponseAction = exports.Action = exports.ContactsFacetType = exports.ContactFieldSet = exports.SortOrder = exports.ImageProvider = exports.SubdivisionType = exports.AddressTag = exports.PhoneTag = exports.EmailTag = exports.ContactActivityType = exports.ContactSourceType = exports.getContact = exports.unlabelContact = exports.labelContact = exports.deleteContact = exports.mergeContacts = exports.updateContact = exports.createContact = exports.__metadata = void 0;
|
|
3
|
+
exports.Mode = exports.SubmitOperation = exports.GetContactResponseType = exports.UpsertContactResponseAction = exports.Action = exports.ContactsFacetType = exports.ContactFieldSet = exports.SortOrder = exports.ImageProvider = exports.SubdivisionType = exports.AddressTag = exports.PhoneTag = exports.EmailTag = exports.ContactActivityType = exports.ContactSourceType = exports.getContact = exports.queryContacts = exports.unlabelContact = exports.labelContact = exports.deleteContact = exports.mergeContacts = exports.updateContact = exports.createContact = exports.__metadata = void 0;
|
|
4
4
|
const contacts_v4_contact_universal_1 = require("./contacts-v4-contact.universal");
|
|
5
5
|
exports.__metadata = { PACKAGE_NAME: '@wix/crm' };
|
|
6
6
|
function createContact(httpClient) {
|
|
@@ -39,6 +39,12 @@ function unlabelContact(httpClient) {
|
|
|
39
39
|
{ httpClient });
|
|
40
40
|
}
|
|
41
41
|
exports.unlabelContact = unlabelContact;
|
|
42
|
+
function queryContacts(httpClient) {
|
|
43
|
+
return (options) => (0, contacts_v4_contact_universal_1.queryContacts)(options,
|
|
44
|
+
// @ts-ignore
|
|
45
|
+
{ httpClient });
|
|
46
|
+
}
|
|
47
|
+
exports.queryContacts = queryContacts;
|
|
42
48
|
function getContact(httpClient) {
|
|
43
49
|
return (_id, options) => (0, contacts_v4_contact_universal_1.getContact)(_id, options,
|
|
44
50
|
// @ts-ignore
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts-v4-contact.public.js","sourceRoot":"","sources":["../../../src/contacts-v4-contact.public.ts"],"names":[],"mappings":";;;AACA,
|
|
1
|
+
{"version":3,"file":"contacts-v4-contact.public.js","sourceRoot":"","sources":["../../../src/contacts-v4-contact.public.ts"],"names":[],"mappings":";;;AACA,mFAeyC;AAE5B,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC;AAEvD,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,IAAiB,EAAE,OAA8B,EAAE,EAAE,CAC3D,IAAA,6CAAsB,EACpB,IAAI,EACJ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,sCAQC;AAED,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CACL,SAAiB,EACjB,IAAiB,EACjB,OAA6B,EAC7B,EAAE,CACF,IAAA,6CAAsB,EACpB,SAAS,EACT,IAAI,EACJ,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,sCAaC;AAED,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CACL,eAAuB,EACvB,qBAAoC,EACpC,OAA8B,EAC9B,EAAE,CACF,IAAA,6CAAsB,EACpB,eAAe,EACf,qBAAqB,EACrB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAbD,sCAaC;AAED,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,SAAiB,EAAE,EAAE,CAC3B,IAAA,6CAAsB,EACpB,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sCAOC;AAED,SAAgB,YAAY,CAAC,UAAsB;IACjD,OAAO,CAAC,SAAiB,EAAE,SAAmB,EAAE,EAAE,CAChD,IAAA,4CAAqB,EACnB,SAAS,EACT,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,oCAQC;AAED,SAAgB,cAAc,CAAC,UAAsB;IACnD,OAAO,CAAC,SAAiB,EAAE,SAAmB,EAAE,EAAE,CAChD,IAAA,8CAAuB,EACrB,SAAS,EACT,SAAS;IACT,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,wCAQC;AAED,SAAgB,aAAa,CAAC,UAAsB;IAClD,OAAO,CAAC,OAA8B,EAAE,EAAE,CACxC,IAAA,6CAAsB,EACpB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,sCAOC;AAED,SAAgB,UAAU,CAAC,UAAsB;IAC/C,OAAO,CAAC,GAAW,EAAE,OAA2B,EAAE,EAAE,CAClD,IAAA,0CAAmB,EACjB,GAAG,EACH,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AARD,gCAQC;AAED,iFAgByC;AAfvC,kIAAA,iBAAiB,OAAA;AACjB,oIAAA,mBAAmB,OAAA;AACnB,yHAAA,QAAQ,OAAA;AACR,yHAAA,QAAQ,OAAA;AACR,2HAAA,UAAU,OAAA;AACV,gIAAA,eAAe,OAAA;AACf,8HAAA,aAAa,OAAA;AACb,0HAAA,SAAS,OAAA;AACT,gIAAA,eAAe,OAAA;AACf,kIAAA,iBAAiB,OAAA;AACjB,uHAAA,MAAM,OAAA;AACN,4IAAA,2BAA2B,OAAA;AAC3B,uIAAA,sBAAsB,OAAA;AACtB,gIAAA,eAAe,OAAA;AACf,qHAAA,IAAI,OAAA"}
|
|
@@ -1341,14 +1341,8 @@ export interface ContactRemovedFromSegment {
|
|
|
1341
1341
|
*
|
|
1342
1342
|
* The `createContact()` function returns a Promise
|
|
1343
1343
|
* that resolves to the new contact when it is created.
|
|
1344
|
-
* > **Note:**
|
|
1345
|
-
* > This function replaces the deprecated
|
|
1346
|
-
* > `wixCrmBackend.createContact()`.
|
|
1347
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
1348
|
-
* > To keep any existing code compatible with future changes, see the
|
|
1349
|
-
* > [migration instructions](wix-crm-backend/createcontact#migration-instructions).
|
|
1350
1344
|
*
|
|
1351
|
-
* The `
|
|
1345
|
+
* The `info` parameter object must include a name, phone number, or email address.
|
|
1352
1346
|
* If all 3 of these parameters are missing,
|
|
1353
1347
|
* the contact won't be created.
|
|
1354
1348
|
*
|
|
@@ -1395,13 +1389,6 @@ export interface CreateContactOptions {
|
|
|
1395
1389
|
* The `updateContact()` function returns a Promise that resolves
|
|
1396
1390
|
* when the specified contact's information is updated.
|
|
1397
1391
|
*
|
|
1398
|
-
* > **Note:**
|
|
1399
|
-
* > This function replaces the deprecated
|
|
1400
|
-
* > `wixCrmBackend.updateContact()`.
|
|
1401
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
1402
|
-
* > To keep any existing code compatible with future changes, see the
|
|
1403
|
-
* > [migration instructions](wix-crm-backend/updatecontact#migration-instructions).
|
|
1404
|
-
*
|
|
1405
1392
|
* Each time the contact is updated,
|
|
1406
1393
|
* `revision` increments by 1.
|
|
1407
1394
|
* The existing `revision` must be included when updating the contact.
|
|
@@ -1476,9 +1463,11 @@ export interface UpdateContactOptions {
|
|
|
1476
1463
|
*
|
|
1477
1464
|
* Merging contacts triggers these webhooks:
|
|
1478
1465
|
*
|
|
1479
|
-
* -
|
|
1480
|
-
* -
|
|
1481
|
-
* -
|
|
1466
|
+
* - Contact Merged is triggered.
|
|
1467
|
+
* - Contact Updated is triggered for the target contact. `originatedFrom` is set to `merge`.
|
|
1468
|
+
* - Contact Deleted is triggered for each source contact. `originatedFrom` is set to `merge`.
|
|
1469
|
+
*
|
|
1470
|
+
* This function is not a universal function and runs only on the backend.
|
|
1482
1471
|
*
|
|
1483
1472
|
* This function is not a universal function and runs only on the backend.
|
|
1484
1473
|
* @param targetContactId - Target contact ID.
|
|
@@ -1505,12 +1494,6 @@ export interface MergeContactsOptions {
|
|
|
1505
1494
|
*
|
|
1506
1495
|
* The `deleteContact()` function returns a Promise
|
|
1507
1496
|
* that resolves when the specified contact is deleted.
|
|
1508
|
-
* > **Note:**
|
|
1509
|
-
* > This function replaces the deprecated
|
|
1510
|
-
* > `wixCrmBackend.deleteContact()`.
|
|
1511
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
1512
|
-
* > To keep any existing code compatible with future changes, see the
|
|
1513
|
-
* > [migration instructions](wix-crm-backend/deletecontact#migration-instructions).
|
|
1514
1497
|
*
|
|
1515
1498
|
* Deleting a contact permanently removes them from your Contact List.
|
|
1516
1499
|
*
|
|
@@ -1539,8 +1522,8 @@ export declare function deleteContact(contactId: string): Promise<void>;
|
|
|
1539
1522
|
*
|
|
1540
1523
|
* The `labelContact()` function returns a Promise
|
|
1541
1524
|
* that resolves when the specified labels are added to the contact.
|
|
1542
|
-
* - **To create new labels:** Use [`findOrCreateLabel()`](
|
|
1543
|
-
* - **To find labels:** Use [`findOrCreateLabel()`](
|
|
1525
|
+
* - **To create new labels:** Use [`findOrCreateLabel()`](#contacts/findorcreatelabel).
|
|
1526
|
+
* - **To find labels:** Use [`findOrCreateLabel()`](#contacts/findorcreatelabel), [`getLabel()`](#contacts/getlabel), or [`queryLabels()`](#contacts/queryLabels).
|
|
1544
1527
|
*
|
|
1545
1528
|
* <!--
|
|
1546
1529
|
* > **Note:**
|
|
@@ -1574,8 +1557,8 @@ export declare function labelContact(contactId: string, labelKeys: string[]): Pr
|
|
|
1574
1557
|
*
|
|
1575
1558
|
* If a label is no longer needed
|
|
1576
1559
|
* and you want to remove it from all contacts,
|
|
1577
|
-
* you can delete it with
|
|
1578
|
-
*
|
|
1560
|
+
* you can delete it with Labels
|
|
1561
|
+
* `deleteLabel()`.
|
|
1579
1562
|
*
|
|
1580
1563
|
* <!--
|
|
1581
1564
|
* > **Note:**
|
|
@@ -1595,6 +1578,72 @@ export declare function labelContact(contactId: string, labelKeys: string[]): Pr
|
|
|
1595
1578
|
* @returns Updated contact.
|
|
1596
1579
|
*/
|
|
1597
1580
|
export declare function unlabelContact(contactId: string, labelKeys: string[]): Promise<UnlabelContactResponse>;
|
|
1581
|
+
/**
|
|
1582
|
+
* Creates a query to retrieve a list of contacts.
|
|
1583
|
+
*
|
|
1584
|
+
* The `queryContacts()` function builds a query to retrieve a list of contacts
|
|
1585
|
+
* and returns a
|
|
1586
|
+
* [`ContactsQueryBuilder`](wix-crm-backend/contacts/contactsquerybuilder)
|
|
1587
|
+
* object.
|
|
1588
|
+
*
|
|
1589
|
+
* The returned object contains the query definition,
|
|
1590
|
+
* which is typically used to run the query using the
|
|
1591
|
+
* [`find()`](wix-crm-backend/contacts/contactsquerybuilder/find)
|
|
1592
|
+
* function.
|
|
1593
|
+
*
|
|
1594
|
+
* You can refine the query
|
|
1595
|
+
* by chaining `ContactsQueryBuilder` functions onto the query.
|
|
1596
|
+
* `ContactsQueryBuilder` functions enable you to sort, filter,
|
|
1597
|
+
* and control the results `queryContacts()` returns.
|
|
1598
|
+
*
|
|
1599
|
+
* `queryContacts()` runs with these `ContactsQueryBuilder` defaults,
|
|
1600
|
+
* which you can override:
|
|
1601
|
+
*
|
|
1602
|
+
* - [`skip(0)`](wix-crm-backend/contacts/contactsquerybuilder/skip)
|
|
1603
|
+
* - [`limit(50)`](wix-crm-backend/contacts/contactsquerybuilder/limit)
|
|
1604
|
+
* - [`descending("_createdDate")`](wix-crm-backend/contacts/contactsquerybuilder/descending)
|
|
1605
|
+
*
|
|
1606
|
+
* The functions that are chained to `queryContacts()`
|
|
1607
|
+
* are applied in the order they are called.
|
|
1608
|
+
* For example, if you apply `ascending('info.company')`
|
|
1609
|
+
* and then `descending('info.name.last')`,
|
|
1610
|
+
* the results are sorted first by the company name, and then,
|
|
1611
|
+
* if there are multiple results with the same company,
|
|
1612
|
+
* the items are sorted by last name.
|
|
1613
|
+
*
|
|
1614
|
+
* <!--
|
|
1615
|
+
* > **Note:**
|
|
1616
|
+
* > Only visitors with
|
|
1617
|
+
* > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
|
|
1618
|
+
* > can query contacts.
|
|
1619
|
+
* > You can override the permissions by setting the `suppressAuth` option to `true`
|
|
1620
|
+
* > in the [`find()`](wix-crm-backend/contacts/contactsquerybuilder/find) function.
|
|
1621
|
+
* -->
|
|
1622
|
+
*
|
|
1623
|
+
* For property support for filters and sorting, see
|
|
1624
|
+
* [Query contacts: Supported filters, sorting, and search](wix-crm-backend/contacts/sort-and-filter#query-contacts-supported-filters,-sorting,-and-search).
|
|
1625
|
+
*
|
|
1626
|
+
*
|
|
1627
|
+
* This function is not a universal function and runs only on the backend.
|
|
1628
|
+
* @public
|
|
1629
|
+
* @documentationMaturity preview
|
|
1630
|
+
* @param options - Query contact options.
|
|
1631
|
+
* @returns List of contacts.
|
|
1632
|
+
*/
|
|
1633
|
+
export declare function queryContacts(options?: QueryContactsOptions): Promise<QueryContactsResponse>;
|
|
1634
|
+
export interface QueryContactsOptions {
|
|
1635
|
+
/**
|
|
1636
|
+
* Plain text search for an exact match.
|
|
1637
|
+
*
|
|
1638
|
+
* Supported properties:
|
|
1639
|
+
* `info.name.first`, `info.name.last`, `info.emails.email`, `info.phones.phone`
|
|
1640
|
+
*
|
|
1641
|
+
* Max: 100 characters
|
|
1642
|
+
*/
|
|
1643
|
+
search?: string | null;
|
|
1644
|
+
/** Query options. */
|
|
1645
|
+
query?: Query;
|
|
1646
|
+
}
|
|
1598
1647
|
/**
|
|
1599
1648
|
* Retrieves a contact.
|
|
1600
1649
|
*
|
|
@@ -1611,13 +1660,7 @@ export declare function unlabelContact(contactId: string, labelKeys: string[]):
|
|
|
1611
1660
|
* This is supported only when calling `getContact()`,
|
|
1612
1661
|
* and only for merged contacts.
|
|
1613
1662
|
* Deleted source contact IDs are not supported on any other function.
|
|
1614
|
-
*
|
|
1615
|
-
* >
|
|
1616
|
-
* > - This function replaces the deprecated
|
|
1617
|
-
* > `wixCrmBackend.getContactById()`.
|
|
1618
|
-
* > The deprecated function will continue to work, but it will not receive updates.
|
|
1619
|
-
* > To keep any existing code compatible with future changes, see the
|
|
1620
|
-
* > [migration instructions](wix-crm-backend/getcontactbyid#migration-instructions).
|
|
1663
|
+
*
|
|
1621
1664
|
* <!-- > - Only visitors with
|
|
1622
1665
|
* > **Manage Contacts** [permissions](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Froles-and-permissions)
|
|
1623
1666
|
* > can retrieve contacts.
|