@wix/crm 1.0.159 → 1.0.161
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/package.json +5 -5
- package/type-bundles/context.bundle.d.ts +312 -334
- package/type-bundles/index.bundle.d.ts +312 -334
- package/type-bundles/meta.bundle.d.ts +252 -304
|
@@ -1,39 +1,40 @@
|
|
|
1
1
|
interface ContactAttachment$1 extends ContactAttachmentMediaOneOf$1 {
|
|
2
|
-
/**
|
|
2
|
+
/** Image details when the attachment type is `IMAGE`. */
|
|
3
3
|
image?: Image$2;
|
|
4
|
-
/**
|
|
4
|
+
/** Document details when the attachment type is `OTHER`. */
|
|
5
5
|
document?: Document;
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Attachment ID.
|
|
8
8
|
* @readonly
|
|
9
9
|
*/
|
|
10
10
|
id?: string;
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Details of the preview image reduced size when the attachment is of type `IMAGE`.
|
|
13
13
|
* @readonly
|
|
14
14
|
*/
|
|
15
15
|
previewImage?: Image$2;
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* Name of the attachment file.
|
|
18
18
|
* @readonly
|
|
19
19
|
*/
|
|
20
20
|
fileName?: string;
|
|
21
21
|
/**
|
|
22
|
-
*
|
|
22
|
+
* Mime type of the attachment. See supported mime types
|
|
23
|
+
* ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
|
|
23
24
|
* @readonly
|
|
24
25
|
*/
|
|
25
26
|
mimeType?: string;
|
|
26
27
|
/**
|
|
27
|
-
*
|
|
28
|
+
* Type of the attachment.
|
|
28
29
|
* @readonly
|
|
29
30
|
*/
|
|
30
31
|
attachmentType?: AttachmentType$1;
|
|
31
32
|
}
|
|
32
33
|
/** @oneof */
|
|
33
34
|
interface ContactAttachmentMediaOneOf$1 {
|
|
34
|
-
/**
|
|
35
|
+
/** Image details when the attachment type is `IMAGE`. */
|
|
35
36
|
image?: Image$2;
|
|
36
|
-
/**
|
|
37
|
+
/** Document details when the attachment type is `OTHER`. */
|
|
37
38
|
document?: Document;
|
|
38
39
|
}
|
|
39
40
|
interface Image$2 {
|
|
@@ -54,7 +55,7 @@ interface Image$2 {
|
|
|
54
55
|
/** Image alt text. Optional. */
|
|
55
56
|
altText?: string | null;
|
|
56
57
|
/**
|
|
57
|
-
* Image URL expiration date
|
|
58
|
+
* Image URL expiration date when relevant.
|
|
58
59
|
* @readonly
|
|
59
60
|
*/
|
|
60
61
|
urlExpirationDate?: Date | null;
|
|
@@ -65,22 +66,29 @@ interface Document {
|
|
|
65
66
|
/** Document URL. */
|
|
66
67
|
url?: string;
|
|
67
68
|
/**
|
|
68
|
-
* Document URL expiration date
|
|
69
|
+
* Document URL expiration date when relevant.
|
|
69
70
|
* @readonly
|
|
70
71
|
*/
|
|
71
72
|
urlExpirationDate?: Date | null;
|
|
72
73
|
}
|
|
73
74
|
declare enum AttachmentType$1 {
|
|
75
|
+
/** Unknown attachment type. */
|
|
74
76
|
UNKNOWN = "UNKNOWN",
|
|
77
|
+
/** Attachment is an image file. */
|
|
75
78
|
IMAGE = "IMAGE",
|
|
79
|
+
/** Attachment is a document or any non-image file type. */
|
|
76
80
|
OTHER = "OTHER"
|
|
77
81
|
}
|
|
78
82
|
interface GenerateAttachmentUploadUrlRequest$1 {
|
|
79
|
-
/** ID of the contact
|
|
83
|
+
/** ID of the contact for whom the attachment is being uploaded. */
|
|
80
84
|
contactId: string;
|
|
81
|
-
/** File name including the extension
|
|
85
|
+
/** File name of the attachment including the extension, for example, `contact-cv.pdf`. */
|
|
82
86
|
fileName: string;
|
|
83
|
-
/**
|
|
87
|
+
/**
|
|
88
|
+
* Mime type of the attachment file, for example, `application/pdf`.
|
|
89
|
+
* See supported mime types ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|
|
|
90
|
+
* [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
|
|
91
|
+
*/
|
|
84
92
|
mimeType: string;
|
|
85
93
|
}
|
|
86
94
|
interface GenerateAttachmentUploadUrlResponse$1 {
|
|
@@ -88,49 +96,54 @@ interface GenerateAttachmentUploadUrlResponse$1 {
|
|
|
88
96
|
uploadUrl?: string;
|
|
89
97
|
}
|
|
90
98
|
interface ListAttachmentsRequest$1 {
|
|
91
|
-
/** Contact ID */
|
|
99
|
+
/** Contact ID for the attachments to be listed. */
|
|
92
100
|
contactId: string;
|
|
93
101
|
/** Allow paginating, default: limit = 100 and offset = 0 */
|
|
94
102
|
paging?: Paging$7;
|
|
95
103
|
}
|
|
96
104
|
interface Paging$7 {
|
|
97
|
-
/**
|
|
105
|
+
/**
|
|
106
|
+
* Number of items to return.
|
|
107
|
+
*
|
|
108
|
+
* Default: `100`
|
|
109
|
+
* Max: `100`
|
|
110
|
+
*/
|
|
98
111
|
limit?: number | null;
|
|
99
|
-
/**
|
|
112
|
+
/** Number of items to skip in the current sort order. */
|
|
100
113
|
offset?: number | null;
|
|
101
114
|
}
|
|
102
115
|
interface ListAttachmentsResponse$1 {
|
|
103
|
-
/**
|
|
116
|
+
/** Liss of attachments for the specified contact. */
|
|
104
117
|
attachments?: ContactAttachment$1[];
|
|
105
|
-
/** Metadata for the
|
|
118
|
+
/** Metadata for the paginated results. */
|
|
106
119
|
metadata?: PagingMetadata$7;
|
|
107
120
|
}
|
|
108
121
|
interface PagingMetadata$7 {
|
|
109
|
-
/**
|
|
122
|
+
/** Number of items returned in the response. */
|
|
110
123
|
count?: number | null;
|
|
111
|
-
/**
|
|
124
|
+
/** Offset that was requested. */
|
|
112
125
|
offset?: number | null;
|
|
113
|
-
/**
|
|
126
|
+
/** Total number of items that match the query. */
|
|
114
127
|
total?: number | null;
|
|
115
|
-
/**
|
|
128
|
+
/** Whether the server failed to calculate the `total` field. */
|
|
116
129
|
tooManyToCount?: boolean | null;
|
|
117
130
|
}
|
|
118
131
|
interface DeleteAttachmentRequest$1 {
|
|
119
|
-
/** Contact ID */
|
|
132
|
+
/** Contact ID for the attachment to delete. */
|
|
120
133
|
contactId: string;
|
|
121
|
-
/** Attachment ID. */
|
|
134
|
+
/** Attachment ID to delete. */
|
|
122
135
|
attachmentId: string;
|
|
123
136
|
}
|
|
124
137
|
interface DeleteAttachmentResponse$1 {
|
|
125
138
|
}
|
|
126
139
|
interface GetAttachmentRequest$1 {
|
|
127
|
-
/** Contact ID */
|
|
140
|
+
/** Contact ID for the attachment to retrieve. */
|
|
128
141
|
contactId: string;
|
|
129
|
-
/** Attachment ID. */
|
|
142
|
+
/** Attachment ID to retrieve. */
|
|
130
143
|
attachmentId: string;
|
|
131
144
|
}
|
|
132
145
|
interface GetAttachmentResponse$1 {
|
|
133
|
-
/** The requested attachment */
|
|
146
|
+
/** The requested attachment. */
|
|
134
147
|
attachment?: ContactAttachment$1;
|
|
135
148
|
}
|
|
136
149
|
interface GenerateAttachmentUploadUrlResponseNonNullableFields$1 {
|
|
@@ -165,54 +178,62 @@ interface GetAttachmentResponseNonNullableFields$1 {
|
|
|
165
178
|
}
|
|
166
179
|
|
|
167
180
|
interface ContactAttachment extends ContactAttachmentMediaOneOf {
|
|
168
|
-
/**
|
|
181
|
+
/** Image details when the attachment type is `IMAGE`. */
|
|
169
182
|
image?: string;
|
|
170
|
-
/**
|
|
183
|
+
/** Document details when the attachment type is `OTHER`. */
|
|
171
184
|
document?: string;
|
|
172
185
|
/**
|
|
173
|
-
*
|
|
186
|
+
* Attachment ID.
|
|
174
187
|
* @readonly
|
|
175
188
|
*/
|
|
176
189
|
_id?: string;
|
|
177
190
|
/**
|
|
178
|
-
*
|
|
191
|
+
* Details of the preview image reduced size when the attachment is of type `IMAGE`.
|
|
179
192
|
* @readonly
|
|
180
193
|
*/
|
|
181
194
|
previewImage?: string;
|
|
182
195
|
/**
|
|
183
|
-
*
|
|
196
|
+
* Name of the attachment file.
|
|
184
197
|
* @readonly
|
|
185
198
|
*/
|
|
186
199
|
fileName?: string;
|
|
187
200
|
/**
|
|
188
|
-
*
|
|
201
|
+
* Mime type of the attachment. See supported mime types
|
|
202
|
+
* ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
|
|
189
203
|
* @readonly
|
|
190
204
|
*/
|
|
191
205
|
mimeType?: string;
|
|
192
206
|
/**
|
|
193
|
-
*
|
|
207
|
+
* Type of the attachment.
|
|
194
208
|
* @readonly
|
|
195
209
|
*/
|
|
196
210
|
attachmentType?: AttachmentType;
|
|
197
211
|
}
|
|
198
212
|
/** @oneof */
|
|
199
213
|
interface ContactAttachmentMediaOneOf {
|
|
200
|
-
/**
|
|
214
|
+
/** Image details when the attachment type is `IMAGE`. */
|
|
201
215
|
image?: string;
|
|
202
|
-
/**
|
|
216
|
+
/** Document details when the attachment type is `OTHER`. */
|
|
203
217
|
document?: string;
|
|
204
218
|
}
|
|
205
219
|
declare enum AttachmentType {
|
|
220
|
+
/** Unknown attachment type. */
|
|
206
221
|
UNKNOWN = "UNKNOWN",
|
|
222
|
+
/** Attachment is an image file. */
|
|
207
223
|
IMAGE = "IMAGE",
|
|
224
|
+
/** Attachment is a document or any non-image file type. */
|
|
208
225
|
OTHER = "OTHER"
|
|
209
226
|
}
|
|
210
227
|
interface GenerateAttachmentUploadUrlRequest {
|
|
211
|
-
/** ID of the contact
|
|
228
|
+
/** ID of the contact for whom the attachment is being uploaded. */
|
|
212
229
|
contactId: string;
|
|
213
|
-
/** File name including the extension
|
|
230
|
+
/** File name of the attachment including the extension, for example, `contact-cv.pdf`. */
|
|
214
231
|
fileName: string;
|
|
215
|
-
/**
|
|
232
|
+
/**
|
|
233
|
+
* Mime type of the attachment file, for example, `application/pdf`.
|
|
234
|
+
* See supported mime types ([REST](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/attachments/attachment-v4/supported-mime-types)|
|
|
235
|
+
* [SDK](https://dev.wix.com/docs/sdk/backend-modules/crm/attachments/supported-mime-types)).
|
|
236
|
+
*/
|
|
216
237
|
mimeType: string;
|
|
217
238
|
}
|
|
218
239
|
interface GenerateAttachmentUploadUrlResponse {
|
|
@@ -220,49 +241,54 @@ interface GenerateAttachmentUploadUrlResponse {
|
|
|
220
241
|
uploadUrl?: string;
|
|
221
242
|
}
|
|
222
243
|
interface ListAttachmentsRequest {
|
|
223
|
-
/** Contact ID */
|
|
244
|
+
/** Contact ID for the attachments to be listed. */
|
|
224
245
|
contactId: string;
|
|
225
246
|
/** Allow paginating, default: limit = 100 and offset = 0 */
|
|
226
247
|
paging?: Paging$6;
|
|
227
248
|
}
|
|
228
249
|
interface Paging$6 {
|
|
229
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* Number of items to return.
|
|
252
|
+
*
|
|
253
|
+
* Default: `100`
|
|
254
|
+
* Max: `100`
|
|
255
|
+
*/
|
|
230
256
|
limit?: number | null;
|
|
231
|
-
/**
|
|
257
|
+
/** Number of items to skip in the current sort order. */
|
|
232
258
|
offset?: number | null;
|
|
233
259
|
}
|
|
234
260
|
interface ListAttachmentsResponse {
|
|
235
|
-
/**
|
|
261
|
+
/** Liss of attachments for the specified contact. */
|
|
236
262
|
attachments?: ContactAttachment[];
|
|
237
|
-
/** Metadata for the
|
|
263
|
+
/** Metadata for the paginated results. */
|
|
238
264
|
metadata?: PagingMetadata$6;
|
|
239
265
|
}
|
|
240
266
|
interface PagingMetadata$6 {
|
|
241
|
-
/**
|
|
267
|
+
/** Number of items returned in the response. */
|
|
242
268
|
count?: number | null;
|
|
243
|
-
/**
|
|
269
|
+
/** Offset that was requested. */
|
|
244
270
|
offset?: number | null;
|
|
245
|
-
/**
|
|
271
|
+
/** Total number of items that match the query. */
|
|
246
272
|
total?: number | null;
|
|
247
|
-
/**
|
|
273
|
+
/** Whether the server failed to calculate the `total` field. */
|
|
248
274
|
tooManyToCount?: boolean | null;
|
|
249
275
|
}
|
|
250
276
|
interface DeleteAttachmentRequest {
|
|
251
|
-
/** Contact ID */
|
|
277
|
+
/** Contact ID for the attachment to delete. */
|
|
252
278
|
contactId: string;
|
|
253
|
-
/** Attachment ID. */
|
|
279
|
+
/** Attachment ID to delete. */
|
|
254
280
|
attachmentId: string;
|
|
255
281
|
}
|
|
256
282
|
interface DeleteAttachmentResponse {
|
|
257
283
|
}
|
|
258
284
|
interface GetAttachmentRequest {
|
|
259
|
-
/** Contact ID */
|
|
285
|
+
/** Contact ID for the attachment to retrieve. */
|
|
260
286
|
contactId: string;
|
|
261
|
-
/** Attachment ID. */
|
|
287
|
+
/** Attachment ID to retrieve. */
|
|
262
288
|
attachmentId: string;
|
|
263
289
|
}
|
|
264
290
|
interface GetAttachmentResponse {
|
|
265
|
-
/** The requested attachment */
|
|
291
|
+
/** The requested attachment. */
|
|
266
292
|
attachment?: ContactAttachment;
|
|
267
293
|
}
|
|
268
294
|
interface GenerateAttachmentUploadUrlResponseNonNullableFields {
|
|
@@ -328,7 +354,7 @@ interface Contact$1 {
|
|
|
328
354
|
/**
|
|
329
355
|
* Revision number, which increments by 1 each time the contact is updated.
|
|
330
356
|
* To prevent conflicting changes,
|
|
331
|
-
* the existing `revision` must be
|
|
357
|
+
* the existing `revision` must be specified when updating a contact.
|
|
332
358
|
* @readonly
|
|
333
359
|
*/
|
|
334
360
|
revision?: number;
|
|
@@ -396,95 +422,91 @@ declare enum ContactSourceType$1 {
|
|
|
396
422
|
interface ContactActivity$1 {
|
|
397
423
|
/** Date and time of the last action. */
|
|
398
424
|
activityDate?: Date | null;
|
|
399
|
-
/**
|
|
400
|
-
* Contact's last action in the site.
|
|
401
|
-
*
|
|
402
|
-
* For descriptions of each value, see
|
|
403
|
-
* [Last Activity Types](https://dev.wix.com/docs/rest/crm/members-contacts/contacts/contacts/contact-v4/last-activity-types).
|
|
404
|
-
*/
|
|
425
|
+
/** Contact's last action in the site. */
|
|
405
426
|
activityType?: ContactActivityType$1;
|
|
406
427
|
}
|
|
407
428
|
declare enum ContactActivityType$1 {
|
|
408
|
-
/**
|
|
429
|
+
/** Visited the site. */
|
|
409
430
|
GENERAL = "GENERAL",
|
|
410
|
-
/**
|
|
431
|
+
/** Became a new contact. */
|
|
411
432
|
CONTACT_CREATED = "CONTACT_CREATED",
|
|
412
|
-
/**
|
|
433
|
+
/** Logged in. */
|
|
413
434
|
MEMBER_LOGIN = "MEMBER_LOGIN",
|
|
414
|
-
/**
|
|
435
|
+
/** Requested a site membership. */
|
|
415
436
|
MEMBER_REGISTER = "MEMBER_REGISTER",
|
|
416
|
-
/**
|
|
437
|
+
/** Was approved, blocked, or unblocked. */
|
|
417
438
|
MEMBER_STATUS_CHANGED = "MEMBER_STATUS_CHANGED",
|
|
418
|
-
/**
|
|
439
|
+
/** Submitted a form. */
|
|
419
440
|
FORM_SUBMITTED = "FORM_SUBMITTED",
|
|
420
|
-
/**
|
|
441
|
+
/** Started a chat. */
|
|
421
442
|
INBOX_FORM_SUBMITTED = "INBOX_FORM_SUBMITTED",
|
|
422
|
-
/**
|
|
443
|
+
/** Paid a payment request. */
|
|
423
444
|
INBOX_PAYMENT_REQUEST_PAID = "INBOX_PAYMENT_REQUEST_PAID",
|
|
424
|
-
/**
|
|
445
|
+
/** Received a message from the site. */
|
|
425
446
|
INBOX_MESSAGE_TO_CUSTOMER = "INBOX_MESSAGE_TO_CUSTOMER",
|
|
426
|
-
/**
|
|
447
|
+
/** Sent a new message to the site. */
|
|
427
448
|
INBOX_MESSAGE_FROM_CUSTOMER = "INBOX_MESSAGE_FROM_CUSTOMER",
|
|
428
|
-
/**
|
|
449
|
+
/** Subscribed to a site newsletter through a form. */
|
|
429
450
|
NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = "NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED",
|
|
430
|
-
/**
|
|
451
|
+
/** Unsubscribed from a site newsletter. */
|
|
431
452
|
NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE",
|
|
432
|
-
/**
|
|
453
|
+
/** Made a purchase. */
|
|
433
454
|
ECOM_PURCHASE = "ECOM_PURCHASE",
|
|
434
|
-
/**
|
|
455
|
+
/** Abandoned a shopping cart. */
|
|
435
456
|
ECOM_CART_ABANDON = "ECOM_CART_ABANDON",
|
|
436
|
-
/**
|
|
457
|
+
/** Checked out shopping cart and submitted buyer info (but didn’t complete the purchase yet). */
|
|
437
458
|
ECOM_CHECKOUT_BUYER = "ECOM_CHECKOUT_BUYER",
|
|
438
|
-
/**
|
|
459
|
+
/** Booked an appointment. */
|
|
439
460
|
BOOKINGS_APPOINTMENT = "BOOKINGS_APPOINTMENT",
|
|
440
|
-
/**
|
|
461
|
+
/** Made a Wix Hotels reservation. */
|
|
441
462
|
HOTELS_RESERVATION = "HOTELS_RESERVATION",
|
|
442
|
-
/**
|
|
463
|
+
/** Paid for a Wix Hotels reservation. */
|
|
443
464
|
HOTELS_PURCHASE = "HOTELS_PURCHASE",
|
|
444
|
-
/**
|
|
465
|
+
/** Confirmed a Wix Hotels reservation. */
|
|
445
466
|
HOTELS_CONFIRMATION = "HOTELS_CONFIRMATION",
|
|
446
|
-
/**
|
|
467
|
+
/** Canceled a Wix Hotels reservation. */
|
|
447
468
|
HOTELS_CANCEL = "HOTELS_CANCEL",
|
|
448
|
-
/**
|
|
469
|
+
/** Purchased a video. */
|
|
449
470
|
VIDEO_PURCHASE = "VIDEO_PURCHASE",
|
|
450
|
-
/**
|
|
471
|
+
/** Rented a video. */
|
|
451
472
|
VIDEO_RENT = "VIDEO_RENT",
|
|
452
|
-
/**
|
|
473
|
+
/** Made a purchase with a pay button. */
|
|
453
474
|
CASHIER_BUTTON_PURCHASE = "CASHIER_BUTTON_PURCHASE",
|
|
454
|
-
/**
|
|
475
|
+
/** Became a new Wix Marketplace lead. */
|
|
455
476
|
ARENA_NEW_LEAD = "ARENA_NEW_LEAD",
|
|
456
|
-
/**
|
|
477
|
+
/** RSVP'd to an event. */
|
|
457
478
|
EVENTS_RSVP = "EVENTS_RSVP",
|
|
458
|
-
/**
|
|
479
|
+
/** Paid an invoice. */
|
|
459
480
|
INVOICE_PAY = "INVOICE_PAY",
|
|
460
|
-
/**
|
|
481
|
+
/** An invoice is now overdue. */
|
|
461
482
|
INVOICE_OVERDUE = "INVOICE_OVERDUE",
|
|
462
|
-
/**
|
|
483
|
+
/** Accepted a price quote. */
|
|
463
484
|
PRICE_QUOTE_ACCEPT = "PRICE_QUOTE_ACCEPT",
|
|
464
|
-
/**
|
|
485
|
+
/** A price quote has expired. */
|
|
465
486
|
PRICE_QUOTE_EXPIRE = "PRICE_QUOTE_EXPIRE",
|
|
466
|
-
/**
|
|
487
|
+
/** Ordered food with Wix Restaurants. */
|
|
467
488
|
RESTAURANTS_ORDER = "RESTAURANTS_ORDER",
|
|
468
|
-
/**
|
|
489
|
+
/** Made a Wix Restaurants reservation. */
|
|
469
490
|
RESTAURANTS_RESERVATION = "RESTAURANTS_RESERVATION",
|
|
470
|
-
/**
|
|
491
|
+
/** Opened an email from the site. */
|
|
471
492
|
SHOUTOUT_OPEN = "SHOUTOUT_OPEN",
|
|
472
|
-
/**
|
|
493
|
+
/** Clicked a link in an email from the site. */
|
|
473
494
|
SHOUTOUT_CLICK = "SHOUTOUT_CLICK",
|
|
495
|
+
/** Merged with another contact. */
|
|
474
496
|
CONTACT_MERGED = "CONTACT_MERGED",
|
|
475
|
-
/**
|
|
497
|
+
/** Subscribed to a site newsletter. */
|
|
476
498
|
NEWSLETTER_SUBSCRIPTION_SUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_SUBSCRIBE",
|
|
477
|
-
/**
|
|
499
|
+
/** Subscription status to site newsletters is pending confirmation. */
|
|
478
500
|
NEWSLETTER_SUBSCRIPTION_PENDING = "NEWSLETTER_SUBSCRIPTION_PENDING",
|
|
479
|
-
/**
|
|
501
|
+
/** Subscription status to site newsletters is not set. */
|
|
480
502
|
NEWSLETTER_SUBSCRIPTION_NOT_SET = "NEWSLETTER_SUBSCRIPTION_NOT_SET",
|
|
481
|
-
/**
|
|
503
|
+
/** Subscribed to phone notifications. */
|
|
482
504
|
PHONE_SUBSCRIPTION_SUBSCRIBE = "PHONE_SUBSCRIPTION_SUBSCRIBE",
|
|
483
|
-
/**
|
|
505
|
+
/** Subscription to phone notificatons is pending confirmation. */
|
|
484
506
|
PHONE_SUBSCRIPTION_PENDING = "PHONE_SUBSCRIPTION_PENDING",
|
|
485
|
-
/**
|
|
507
|
+
/** Subscription to phone notificatons is not set. */
|
|
486
508
|
PHONE_SUBSCRIPTION_NOT_SET = "PHONE_SUBSCRIPTION_NOT_SET",
|
|
487
|
-
/**
|
|
509
|
+
/** Subscribed to phone notifications. */
|
|
488
510
|
PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
|
|
489
511
|
}
|
|
490
512
|
interface PrimaryContactInfo$1 {
|
|
@@ -517,10 +539,10 @@ interface Image$1 {
|
|
|
517
539
|
height?: number;
|
|
518
540
|
/** Width of the original image. */
|
|
519
541
|
width?: number;
|
|
520
|
-
/** Image alt text
|
|
542
|
+
/** Image alt text (optional). */
|
|
521
543
|
altText?: string | null;
|
|
522
544
|
/**
|
|
523
|
-
* Image URL expiration date (
|
|
545
|
+
* Image URL expiration date (optional).
|
|
524
546
|
* @readonly
|
|
525
547
|
*/
|
|
526
548
|
urlExpirationDate?: Date | null;
|
|
@@ -536,10 +558,7 @@ interface ContactInfo$5 {
|
|
|
536
558
|
addresses?: ContactAddressesWrapper$3;
|
|
537
559
|
/** Contact's company name. */
|
|
538
560
|
company?: string | null;
|
|
539
|
-
/**
|
|
540
|
-
* Contact's job title.
|
|
541
|
-
* Corresponds to the **Position** field in the Dashboard.
|
|
542
|
-
*/
|
|
561
|
+
/** Contact's job title. */
|
|
543
562
|
jobTitle?: string | null;
|
|
544
563
|
/** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
|
|
545
564
|
birthdate?: string | null;
|
|
@@ -553,21 +572,15 @@ interface ContactInfo$5 {
|
|
|
553
572
|
locale?: string | null;
|
|
554
573
|
/**
|
|
555
574
|
* List of contact's labels.
|
|
556
|
-
* Labels are used to organize contacts.
|
|
557
|
-
* When setting the `labelKeys` property,
|
|
558
|
-
* only labels that already exist in the site's Contacts List can be used.
|
|
559
|
-
* Labels can be added and removed using
|
|
560
|
-
* [Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
|
|
561
|
-
* [Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),
|
|
562
|
-
* respectively.
|
|
563
575
|
*
|
|
564
|
-
*
|
|
565
|
-
*
|
|
576
|
+
* Labels are used to organize contacts. Labels can be
|
|
577
|
+
* added and removed using Label Contact and Unlabel Contact, respectively.
|
|
578
|
+
*
|
|
579
|
+
* To view or manage contact labels, use the Labels API.
|
|
566
580
|
*/
|
|
567
581
|
labelKeys?: LabelsWrapper$3;
|
|
568
582
|
/**
|
|
569
583
|
* Additional custom fields.
|
|
570
|
-
* This includes fields managed by Wix, by 3rd-party apps, and by the site.
|
|
571
584
|
*
|
|
572
585
|
* Empty fields are not returned.
|
|
573
586
|
*/
|
|
@@ -603,7 +616,7 @@ interface ContactEmail$3 {
|
|
|
603
616
|
* Indicates whether this is the contact's primary email address.
|
|
604
617
|
* When changing `primary` to `true` for an email,
|
|
605
618
|
* the contact's other emails become `false`.
|
|
606
|
-
*
|
|
619
|
+
* Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
|
|
607
620
|
*/
|
|
608
621
|
primary?: boolean | null;
|
|
609
622
|
}
|
|
@@ -641,10 +654,10 @@ interface ContactPhone$3 {
|
|
|
641
654
|
*/
|
|
642
655
|
e164Phone?: string | null;
|
|
643
656
|
/**
|
|
644
|
-
*
|
|
657
|
+
* Indicates whether this is the contact's primary phone number.
|
|
645
658
|
* When changing `primary` to `true` for a phone,
|
|
646
659
|
* the contact's `primary` field for other phones becomes `false`.
|
|
647
|
-
*
|
|
660
|
+
* Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
|
|
648
661
|
*/
|
|
649
662
|
primary?: boolean | null;
|
|
650
663
|
}
|
|
@@ -738,14 +751,9 @@ declare enum SubdivisionType {
|
|
|
738
751
|
interface LabelsWrapper$3 {
|
|
739
752
|
/**
|
|
740
753
|
* List of contact label keys.
|
|
741
|
-
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
742
|
-
* help categorize contacts.
|
|
743
754
|
*
|
|
744
|
-
* Label keys must exist to be added to the contact.
|
|
745
|
-
* Contact labels can be created or retrieved with
|
|
746
|
-
* [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
|
|
747
|
-
* or
|
|
748
|
-
* [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
|
|
755
|
+
* Contact labels help categorize contacts. Label keys must exist to be added to the contact.
|
|
756
|
+
* Contact labels can be created or retrieved with Find or Create Label or List Labels.
|
|
749
757
|
*/
|
|
750
758
|
items?: string[];
|
|
751
759
|
}
|
|
@@ -755,8 +763,7 @@ interface ExtendedFieldsWrapper$3 {
|
|
|
755
763
|
* where each key is the field key,
|
|
756
764
|
* and each value is the field's value for the contact.
|
|
757
765
|
*
|
|
758
|
-
* To view and manage extended fields, use the
|
|
759
|
-
* [Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).
|
|
766
|
+
* To view and manage extended fields, use the Extended Fields API.
|
|
760
767
|
*/
|
|
761
768
|
items?: Record<string, any>;
|
|
762
769
|
}
|
|
@@ -871,12 +878,12 @@ interface MergeContactsRequest$1 {
|
|
|
871
878
|
/**
|
|
872
879
|
* Target contact revision number, which increments by 1 each time the contact is updated.
|
|
873
880
|
* To prevent conflicting changes,
|
|
874
|
-
* the target contact's current revision must be
|
|
881
|
+
* the target contact's current `revision` must be specified.
|
|
875
882
|
*/
|
|
876
883
|
targetContactRevision: number | null;
|
|
877
884
|
/**
|
|
878
885
|
* IDs of up to 5 contacts to merge into the target contact.
|
|
879
|
-
*
|
|
886
|
+
* When you merge more than one source contact,
|
|
880
887
|
* the first source is given precedence, then the second, and so on.
|
|
881
888
|
*/
|
|
882
889
|
sourceContactIds?: string[];
|
|
@@ -898,10 +905,7 @@ interface LabelContactRequest$1 {
|
|
|
898
905
|
* List of label keys to add to the contact.
|
|
899
906
|
*
|
|
900
907
|
* Label keys must exist to be added to the contact.
|
|
901
|
-
*
|
|
902
|
-
* [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
|
|
903
|
-
* or
|
|
904
|
-
* [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels).
|
|
908
|
+
* Use the Labels API to create or retrieve labels.
|
|
905
909
|
*/
|
|
906
910
|
labelKeys: string[];
|
|
907
911
|
}
|
|
@@ -944,9 +948,9 @@ declare enum SortOrder$7 {
|
|
|
944
948
|
}
|
|
945
949
|
interface Paging$5 {
|
|
946
950
|
/**
|
|
947
|
-
* Number of items to return.
|
|
951
|
+
* Number of items to return. Learn more about pagination in API Query Language([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language)|[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging).
|
|
948
952
|
*
|
|
949
|
-
*
|
|
953
|
+
* Default: `50`. <br>
|
|
950
954
|
* Maximum: `1000`.
|
|
951
955
|
*/
|
|
952
956
|
limit?: number | null;
|
|
@@ -964,13 +968,13 @@ declare enum ContactFieldSet$1 {
|
|
|
964
968
|
FULL = "FULL"
|
|
965
969
|
}
|
|
966
970
|
interface PagingMetadata$5 {
|
|
967
|
-
/** The number of items returned in this response */
|
|
971
|
+
/** The number of items returned in this response. */
|
|
968
972
|
count?: number | null;
|
|
969
|
-
/** The offset which was requested */
|
|
973
|
+
/** The offset which was requested. */
|
|
970
974
|
offset?: number | null;
|
|
971
|
-
/** The total number of items that match the query */
|
|
975
|
+
/** The total number of items that match the query. */
|
|
972
976
|
total?: number | null;
|
|
973
|
-
/** A flag that indicates the server failed to calculate 'total' field */
|
|
977
|
+
/** A flag that indicates the server failed to calculate 'total' field. */
|
|
974
978
|
tooManyToCount?: boolean | null;
|
|
975
979
|
}
|
|
976
980
|
interface QueryContactsRequest$1 {
|
|
@@ -1074,21 +1078,15 @@ interface GetContactRequest$1 {
|
|
|
1074
1078
|
interface GetContactResponse$1 {
|
|
1075
1079
|
/** The requested contact. */
|
|
1076
1080
|
contact?: Contact$1;
|
|
1077
|
-
/**
|
|
1078
|
-
* Contact response type.
|
|
1079
|
-
*
|
|
1080
|
-
* - `REGULAR`: The specified contact was returned.
|
|
1081
|
-
* - `IMPLICIT`: Not used.
|
|
1082
|
-
* - `MERGED`: The specified contact was previously merged with another contact, and the new contact was
|
|
1083
|
-
*/
|
|
1081
|
+
/** Contact response type. */
|
|
1084
1082
|
responseType?: GetContactResponseType$1;
|
|
1085
1083
|
}
|
|
1086
1084
|
declare enum GetContactResponseType$1 {
|
|
1087
|
-
/**
|
|
1085
|
+
/** The specified contact was returned. */
|
|
1088
1086
|
REGULAR = "REGULAR",
|
|
1089
|
-
/**
|
|
1087
|
+
/** Not used. */
|
|
1090
1088
|
IMPLICIT = "IMPLICIT",
|
|
1091
|
-
/**
|
|
1089
|
+
/** The specified contact was previously merged with another contact and the new contact was returned. */
|
|
1092
1090
|
MERGED = "MERGED"
|
|
1093
1091
|
}
|
|
1094
1092
|
interface ContactSourceNonNullableFields$1 {
|
|
@@ -1236,7 +1234,7 @@ interface Contact {
|
|
|
1236
1234
|
/**
|
|
1237
1235
|
* Revision number, which increments by 1 each time the contact is updated.
|
|
1238
1236
|
* To prevent conflicting changes,
|
|
1239
|
-
* the existing `revision` must be
|
|
1237
|
+
* the existing `revision` must be specified when updating a contact.
|
|
1240
1238
|
* @readonly
|
|
1241
1239
|
*/
|
|
1242
1240
|
revision?: number;
|
|
@@ -1262,8 +1260,6 @@ interface Contact {
|
|
|
1262
1260
|
lastActivity?: ContactActivity;
|
|
1263
1261
|
/**
|
|
1264
1262
|
* Contact's primary phone and email.
|
|
1265
|
-
*
|
|
1266
|
-
* This property reflects the email address in `contactInfo.emails` where `primary` is `true`.
|
|
1267
1263
|
* @readonly
|
|
1268
1264
|
*/
|
|
1269
1265
|
primaryInfo?: PrimaryContactInfo;
|
|
@@ -1306,90 +1302,91 @@ declare enum ContactSourceType {
|
|
|
1306
1302
|
interface ContactActivity {
|
|
1307
1303
|
/** Date and time of the last action. */
|
|
1308
1304
|
activityDate?: Date | null;
|
|
1309
|
-
/**
|
|
1305
|
+
/** Contact's last action in the site. */
|
|
1310
1306
|
activityType?: ContactActivityType;
|
|
1311
1307
|
}
|
|
1312
1308
|
declare enum ContactActivityType {
|
|
1313
|
-
/**
|
|
1309
|
+
/** Visited the site. */
|
|
1314
1310
|
GENERAL = "GENERAL",
|
|
1315
|
-
/**
|
|
1311
|
+
/** Became a new contact. */
|
|
1316
1312
|
CONTACT_CREATED = "CONTACT_CREATED",
|
|
1317
|
-
/**
|
|
1313
|
+
/** Logged in. */
|
|
1318
1314
|
MEMBER_LOGIN = "MEMBER_LOGIN",
|
|
1319
|
-
/**
|
|
1315
|
+
/** Requested a site membership. */
|
|
1320
1316
|
MEMBER_REGISTER = "MEMBER_REGISTER",
|
|
1321
|
-
/**
|
|
1317
|
+
/** Was approved, blocked, or unblocked. */
|
|
1322
1318
|
MEMBER_STATUS_CHANGED = "MEMBER_STATUS_CHANGED",
|
|
1323
|
-
/**
|
|
1319
|
+
/** Submitted a form. */
|
|
1324
1320
|
FORM_SUBMITTED = "FORM_SUBMITTED",
|
|
1325
|
-
/**
|
|
1321
|
+
/** Started a chat. */
|
|
1326
1322
|
INBOX_FORM_SUBMITTED = "INBOX_FORM_SUBMITTED",
|
|
1327
|
-
/**
|
|
1323
|
+
/** Paid a payment request. */
|
|
1328
1324
|
INBOX_PAYMENT_REQUEST_PAID = "INBOX_PAYMENT_REQUEST_PAID",
|
|
1329
|
-
/**
|
|
1325
|
+
/** Received a message from the site. */
|
|
1330
1326
|
INBOX_MESSAGE_TO_CUSTOMER = "INBOX_MESSAGE_TO_CUSTOMER",
|
|
1331
|
-
/**
|
|
1327
|
+
/** Sent a new message to the site. */
|
|
1332
1328
|
INBOX_MESSAGE_FROM_CUSTOMER = "INBOX_MESSAGE_FROM_CUSTOMER",
|
|
1333
|
-
/**
|
|
1329
|
+
/** Subscribed to a site newsletter through a form. */
|
|
1334
1330
|
NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED = "NEWSLETTER_SUBSCRIPTION_FORM_SUBMITTED",
|
|
1335
|
-
/**
|
|
1331
|
+
/** Unsubscribed from a site newsletter. */
|
|
1336
1332
|
NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_UNSUBSCRIBE",
|
|
1337
|
-
/**
|
|
1333
|
+
/** Made a purchase. */
|
|
1338
1334
|
ECOM_PURCHASE = "ECOM_PURCHASE",
|
|
1339
|
-
/**
|
|
1335
|
+
/** Abandoned a shopping cart. */
|
|
1340
1336
|
ECOM_CART_ABANDON = "ECOM_CART_ABANDON",
|
|
1341
|
-
/**
|
|
1337
|
+
/** Checked out shopping cart and submitted buyer info (but didn’t complete the purchase yet). */
|
|
1342
1338
|
ECOM_CHECKOUT_BUYER = "ECOM_CHECKOUT_BUYER",
|
|
1343
|
-
/**
|
|
1339
|
+
/** Booked an appointment. */
|
|
1344
1340
|
BOOKINGS_APPOINTMENT = "BOOKINGS_APPOINTMENT",
|
|
1345
|
-
/**
|
|
1341
|
+
/** Made a Wix Hotels reservation. */
|
|
1346
1342
|
HOTELS_RESERVATION = "HOTELS_RESERVATION",
|
|
1347
|
-
/**
|
|
1343
|
+
/** Paid for a Wix Hotels reservation. */
|
|
1348
1344
|
HOTELS_PURCHASE = "HOTELS_PURCHASE",
|
|
1349
|
-
/**
|
|
1345
|
+
/** Confirmed a Wix Hotels reservation. */
|
|
1350
1346
|
HOTELS_CONFIRMATION = "HOTELS_CONFIRMATION",
|
|
1351
|
-
/**
|
|
1347
|
+
/** Canceled a Wix Hotels reservation. */
|
|
1352
1348
|
HOTELS_CANCEL = "HOTELS_CANCEL",
|
|
1353
|
-
/**
|
|
1349
|
+
/** Purchased a video. */
|
|
1354
1350
|
VIDEO_PURCHASE = "VIDEO_PURCHASE",
|
|
1355
|
-
/**
|
|
1351
|
+
/** Rented a video. */
|
|
1356
1352
|
VIDEO_RENT = "VIDEO_RENT",
|
|
1357
|
-
/**
|
|
1353
|
+
/** Made a purchase with a pay button. */
|
|
1358
1354
|
CASHIER_BUTTON_PURCHASE = "CASHIER_BUTTON_PURCHASE",
|
|
1359
|
-
/**
|
|
1355
|
+
/** Became a new Wix Marketplace lead. */
|
|
1360
1356
|
ARENA_NEW_LEAD = "ARENA_NEW_LEAD",
|
|
1361
|
-
/**
|
|
1357
|
+
/** RSVP'd to an event. */
|
|
1362
1358
|
EVENTS_RSVP = "EVENTS_RSVP",
|
|
1363
|
-
/**
|
|
1359
|
+
/** Paid an invoice. */
|
|
1364
1360
|
INVOICE_PAY = "INVOICE_PAY",
|
|
1365
|
-
/**
|
|
1361
|
+
/** An invoice is now overdue. */
|
|
1366
1362
|
INVOICE_OVERDUE = "INVOICE_OVERDUE",
|
|
1367
|
-
/**
|
|
1363
|
+
/** Accepted a price quote. */
|
|
1368
1364
|
PRICE_QUOTE_ACCEPT = "PRICE_QUOTE_ACCEPT",
|
|
1369
|
-
/**
|
|
1365
|
+
/** A price quote has expired. */
|
|
1370
1366
|
PRICE_QUOTE_EXPIRE = "PRICE_QUOTE_EXPIRE",
|
|
1371
|
-
/**
|
|
1367
|
+
/** Ordered food with Wix Restaurants. */
|
|
1372
1368
|
RESTAURANTS_ORDER = "RESTAURANTS_ORDER",
|
|
1373
|
-
/**
|
|
1369
|
+
/** Made a Wix Restaurants reservation. */
|
|
1374
1370
|
RESTAURANTS_RESERVATION = "RESTAURANTS_RESERVATION",
|
|
1375
|
-
/**
|
|
1371
|
+
/** Opened an email from the site. */
|
|
1376
1372
|
SHOUTOUT_OPEN = "SHOUTOUT_OPEN",
|
|
1377
|
-
/**
|
|
1373
|
+
/** Clicked a link in an email from the site. */
|
|
1378
1374
|
SHOUTOUT_CLICK = "SHOUTOUT_CLICK",
|
|
1375
|
+
/** Merged with another contact. */
|
|
1379
1376
|
CONTACT_MERGED = "CONTACT_MERGED",
|
|
1380
|
-
/**
|
|
1377
|
+
/** Subscribed to a site newsletter. */
|
|
1381
1378
|
NEWSLETTER_SUBSCRIPTION_SUBSCRIBE = "NEWSLETTER_SUBSCRIPTION_SUBSCRIBE",
|
|
1382
|
-
/**
|
|
1379
|
+
/** Subscription status to site newsletters is pending confirmation. */
|
|
1383
1380
|
NEWSLETTER_SUBSCRIPTION_PENDING = "NEWSLETTER_SUBSCRIPTION_PENDING",
|
|
1384
|
-
/**
|
|
1381
|
+
/** Subscription status to site newsletters is not set. */
|
|
1385
1382
|
NEWSLETTER_SUBSCRIPTION_NOT_SET = "NEWSLETTER_SUBSCRIPTION_NOT_SET",
|
|
1386
|
-
/**
|
|
1383
|
+
/** Subscribed to phone notifications. */
|
|
1387
1384
|
PHONE_SUBSCRIPTION_SUBSCRIBE = "PHONE_SUBSCRIPTION_SUBSCRIBE",
|
|
1388
|
-
/**
|
|
1385
|
+
/** Subscription to phone notificatons is pending confirmation. */
|
|
1389
1386
|
PHONE_SUBSCRIPTION_PENDING = "PHONE_SUBSCRIPTION_PENDING",
|
|
1390
|
-
/**
|
|
1387
|
+
/** Subscription to phone notificatons is not set. */
|
|
1391
1388
|
PHONE_SUBSCRIPTION_NOT_SET = "PHONE_SUBSCRIPTION_NOT_SET",
|
|
1392
|
-
/**
|
|
1389
|
+
/** Subscribed to phone notifications. */
|
|
1393
1390
|
PHONE_SUBSCRIPTION_UNSUBSCRIBE = "PHONE_SUBSCRIPTION_UNSUBSCRIBE"
|
|
1394
1391
|
}
|
|
1395
1392
|
interface PrimaryContactInfo {
|
|
@@ -1404,7 +1401,8 @@ interface PrimaryContactInfo {
|
|
|
1404
1401
|
/**
|
|
1405
1402
|
* Primary phone number.
|
|
1406
1403
|
*
|
|
1407
|
-
* This property reflects the phone number in `
|
|
1404
|
+
* This property reflects the phone number in `info.phones`
|
|
1405
|
+
* where `primary` is `true`.
|
|
1408
1406
|
* @readonly
|
|
1409
1407
|
*/
|
|
1410
1408
|
phone?: string | null;
|
|
@@ -1420,10 +1418,7 @@ interface ContactInfo$4 {
|
|
|
1420
1418
|
addresses?: ContactAddressesWrapper$2;
|
|
1421
1419
|
/** Contact's company name. */
|
|
1422
1420
|
company?: string | null;
|
|
1423
|
-
/**
|
|
1424
|
-
* Contact's job title.
|
|
1425
|
-
* Corresponds to the **Position** field in the Dashboard.
|
|
1426
|
-
*/
|
|
1421
|
+
/** Contact's job title. */
|
|
1427
1422
|
jobTitle?: string | null;
|
|
1428
1423
|
/** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
|
|
1429
1424
|
birthdate?: string | null;
|
|
@@ -1436,18 +1431,16 @@ interface ContactInfo$4 {
|
|
|
1436
1431
|
*/
|
|
1437
1432
|
locale?: string | null;
|
|
1438
1433
|
/**
|
|
1439
|
-
* List of
|
|
1434
|
+
* List of contact's labels.
|
|
1440
1435
|
*
|
|
1441
|
-
*
|
|
1442
|
-
*
|
|
1443
|
-
* `findOrCreateLabel()` function. You can use the
|
|
1444
|
-
* `queryLabels()` function to view the currently existing labels.
|
|
1436
|
+
* Labels are used to organize contacts. Labels can be
|
|
1437
|
+
* added and removed using Label Contact and Unlabel Contact, respectively.
|
|
1445
1438
|
*
|
|
1439
|
+
* To view or manage contact labels, use the Labels API.
|
|
1446
1440
|
*/
|
|
1447
1441
|
labelKeys?: LabelsWrapper$2;
|
|
1448
1442
|
/**
|
|
1449
1443
|
* Additional custom fields.
|
|
1450
|
-
* This includes fields managed by Wix, by 3rd-party apps, and by the site.
|
|
1451
1444
|
*
|
|
1452
1445
|
* Empty fields are not returned.
|
|
1453
1446
|
*/
|
|
@@ -1474,7 +1467,7 @@ interface ContactEmail$2 {
|
|
|
1474
1467
|
/**
|
|
1475
1468
|
* Email type.
|
|
1476
1469
|
*
|
|
1477
|
-
* `
|
|
1470
|
+
* `UNTAGGED` is shown as "Other" in the Contact List.
|
|
1478
1471
|
*/
|
|
1479
1472
|
tag?: EmailTag$2;
|
|
1480
1473
|
/** Email address. */
|
|
@@ -1483,7 +1476,7 @@ interface ContactEmail$2 {
|
|
|
1483
1476
|
* Indicates whether this is the contact's primary email address.
|
|
1484
1477
|
* When changing `primary` to `true` for an email,
|
|
1485
1478
|
* the contact's other emails become `false`.
|
|
1486
|
-
*
|
|
1479
|
+
* Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
|
|
1487
1480
|
*/
|
|
1488
1481
|
primary?: boolean | null;
|
|
1489
1482
|
}
|
|
@@ -1506,7 +1499,7 @@ interface ContactPhone$2 {
|
|
|
1506
1499
|
/**
|
|
1507
1500
|
* Phone type.
|
|
1508
1501
|
*
|
|
1509
|
-
* `
|
|
1502
|
+
* `UNTAGGED` is shown as "Other" in the Contact List.
|
|
1510
1503
|
*/
|
|
1511
1504
|
tag?: PhoneTag$2;
|
|
1512
1505
|
/** [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. */
|
|
@@ -1521,10 +1514,10 @@ interface ContactPhone$2 {
|
|
|
1521
1514
|
*/
|
|
1522
1515
|
e164Phone?: string | null;
|
|
1523
1516
|
/**
|
|
1524
|
-
*
|
|
1517
|
+
* Indicates whether this is the contact's primary phone number.
|
|
1525
1518
|
* When changing `primary` to `true` for a phone,
|
|
1526
1519
|
* the contact's `primary` field for other phones becomes `false`.
|
|
1527
|
-
*
|
|
1520
|
+
* Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
|
|
1528
1521
|
*/
|
|
1529
1522
|
primary?: boolean | null;
|
|
1530
1523
|
}
|
|
@@ -1548,10 +1541,7 @@ interface ContactAddress$2 {
|
|
|
1548
1541
|
_id?: string | null;
|
|
1549
1542
|
/**
|
|
1550
1543
|
* Address type.
|
|
1551
|
-
*
|
|
1552
|
-
* `"UNTAGGED"` is shown as "Other" in the Contact List.
|
|
1553
|
-
*
|
|
1554
|
-
*
|
|
1544
|
+
* `UNTAGGED` is shown as "Other" in the Contact List.
|
|
1555
1545
|
*/
|
|
1556
1546
|
tag?: AddressTag$2;
|
|
1557
1547
|
/** Street address. */
|
|
@@ -1606,27 +1596,19 @@ interface StreetAddress$2 {
|
|
|
1606
1596
|
interface LabelsWrapper$2 {
|
|
1607
1597
|
/**
|
|
1608
1598
|
* List of contact label keys.
|
|
1609
|
-
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
1610
|
-
* help categorize contacts.
|
|
1611
1599
|
*
|
|
1612
|
-
* Label keys must exist to be added to the contact.
|
|
1613
|
-
* Contact labels can be created or retrieved with
|
|
1614
|
-
* [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
|
|
1615
|
-
* or
|
|
1616
|
-
* [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
|
|
1600
|
+
* Contact labels help categorize contacts. Label keys must exist to be added to the contact.
|
|
1601
|
+
* Contact labels can be created or retrieved with Find or Create Label or List Labels.
|
|
1617
1602
|
*/
|
|
1618
1603
|
items?: string[];
|
|
1619
1604
|
}
|
|
1620
1605
|
interface ExtendedFieldsWrapper$2 {
|
|
1621
1606
|
/**
|
|
1622
|
-
*
|
|
1623
|
-
*
|
|
1624
|
-
*
|
|
1607
|
+
* Contact's extended fields,
|
|
1608
|
+
* where each key is the field key,
|
|
1609
|
+
* and each value is the field's value for the contact.
|
|
1625
1610
|
*
|
|
1626
|
-
*
|
|
1627
|
-
* `findOrCreateExtendedField()`,
|
|
1628
|
-
* `getExtendedField()`, or
|
|
1629
|
-
* `queryExtendedFields()` in the Extended Fields API.
|
|
1611
|
+
* To view and manage extended fields, use the Extended Fields API.
|
|
1630
1612
|
*/
|
|
1631
1613
|
items?: Record<string, any>;
|
|
1632
1614
|
}
|
|
@@ -1741,12 +1723,12 @@ interface MergeContactsRequest {
|
|
|
1741
1723
|
/**
|
|
1742
1724
|
* Target contact revision number, which increments by 1 each time the contact is updated.
|
|
1743
1725
|
* To prevent conflicting changes,
|
|
1744
|
-
* the target contact's current revision must be
|
|
1726
|
+
* the target contact's current `revision` must be specified.
|
|
1745
1727
|
*/
|
|
1746
1728
|
targetContactRevision: number | null;
|
|
1747
1729
|
/**
|
|
1748
1730
|
* IDs of up to 5 contacts to merge into the target contact.
|
|
1749
|
-
*
|
|
1731
|
+
* When you merge more than one source contact,
|
|
1750
1732
|
* the first source is given precedence, then the second, and so on.
|
|
1751
1733
|
*/
|
|
1752
1734
|
sourceContactIds?: string[];
|
|
@@ -1768,10 +1750,7 @@ interface LabelContactRequest {
|
|
|
1768
1750
|
* List of label keys to add to the contact.
|
|
1769
1751
|
*
|
|
1770
1752
|
* Label keys must exist to be added to the contact.
|
|
1771
|
-
*
|
|
1772
|
-
* `findOrCreateLabel()` function. You can use the
|
|
1773
|
-
* `queryLabels()` function to view the currently existing labels.
|
|
1774
|
-
*
|
|
1753
|
+
* Use the Labels API to create or retrieve labels.
|
|
1775
1754
|
*/
|
|
1776
1755
|
labelKeys: string[];
|
|
1777
1756
|
}
|
|
@@ -1813,7 +1792,12 @@ declare enum SortOrder$6 {
|
|
|
1813
1792
|
DESC = "DESC"
|
|
1814
1793
|
}
|
|
1815
1794
|
interface Paging$4 {
|
|
1816
|
-
/**
|
|
1795
|
+
/**
|
|
1796
|
+
* Number of items to return. Learn more about pagination in API Query Language([SDK](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/api-query-language)|[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging).
|
|
1797
|
+
*
|
|
1798
|
+
* Default: `50`. <br>
|
|
1799
|
+
* Maximum: `1000`.
|
|
1800
|
+
*/
|
|
1817
1801
|
limit?: number | null;
|
|
1818
1802
|
/** Number of items to skip in the current sort order. */
|
|
1819
1803
|
offset?: number | null;
|
|
@@ -1829,13 +1813,13 @@ declare enum ContactFieldSet {
|
|
|
1829
1813
|
FULL = "FULL"
|
|
1830
1814
|
}
|
|
1831
1815
|
interface PagingMetadata$4 {
|
|
1832
|
-
/** The number of items returned in this response */
|
|
1816
|
+
/** The number of items returned in this response. */
|
|
1833
1817
|
count?: number | null;
|
|
1834
|
-
/** The offset which was requested */
|
|
1818
|
+
/** The offset which was requested. */
|
|
1835
1819
|
offset?: number | null;
|
|
1836
|
-
/** The total number of items that match the query */
|
|
1820
|
+
/** The total number of items that match the query. */
|
|
1837
1821
|
total?: number | null;
|
|
1838
|
-
/** A flag that indicates the server failed to calculate 'total' field */
|
|
1822
|
+
/** A flag that indicates the server failed to calculate 'total' field. */
|
|
1839
1823
|
tooManyToCount?: boolean | null;
|
|
1840
1824
|
}
|
|
1841
1825
|
interface QueryContactsRequest {
|
|
@@ -1934,21 +1918,15 @@ interface GetContactRequest {
|
|
|
1934
1918
|
interface GetContactResponse {
|
|
1935
1919
|
/** The requested contact. */
|
|
1936
1920
|
contact?: Contact;
|
|
1937
|
-
/**
|
|
1938
|
-
* Contact response type.
|
|
1939
|
-
*
|
|
1940
|
-
* - `REGULAR`: The specified contact was returned.
|
|
1941
|
-
* - `IMPLICIT`: Not used.
|
|
1942
|
-
* - `MERGED`: The specified contact was previously merged with another contact, and the new contact was
|
|
1943
|
-
*/
|
|
1921
|
+
/** Contact response type. */
|
|
1944
1922
|
responseType?: GetContactResponseType;
|
|
1945
1923
|
}
|
|
1946
1924
|
declare enum GetContactResponseType {
|
|
1947
|
-
/**
|
|
1925
|
+
/** The specified contact was returned. */
|
|
1948
1926
|
REGULAR = "REGULAR",
|
|
1949
|
-
/**
|
|
1927
|
+
/** Not used. */
|
|
1950
1928
|
IMPLICIT = "IMPLICIT",
|
|
1951
|
-
/**
|
|
1929
|
+
/** The specified contact was previously merged with another contact and the new contact was returned. */
|
|
1952
1930
|
MERGED = "MERGED"
|
|
1953
1931
|
}
|
|
1954
1932
|
interface ContactSourceNonNullableFields {
|
|
@@ -3116,10 +3094,7 @@ interface ContactInfo$3 {
|
|
|
3116
3094
|
addresses?: ContactAddressesWrapper$1;
|
|
3117
3095
|
/** Contact's company name. */
|
|
3118
3096
|
company?: string | null;
|
|
3119
|
-
/**
|
|
3120
|
-
* Contact's job title.
|
|
3121
|
-
* Corresponds to the **Position** field in the Dashboard.
|
|
3122
|
-
*/
|
|
3097
|
+
/** Contact's job title. */
|
|
3123
3098
|
jobTitle?: string | null;
|
|
3124
3099
|
/** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
|
|
3125
3100
|
birthdate?: string | null;
|
|
@@ -3133,21 +3108,15 @@ interface ContactInfo$3 {
|
|
|
3133
3108
|
locale?: string | null;
|
|
3134
3109
|
/**
|
|
3135
3110
|
* List of contact's labels.
|
|
3136
|
-
* Labels are used to organize contacts.
|
|
3137
|
-
* When setting the `labelKeys` property,
|
|
3138
|
-
* only labels that already exist in the site's Contacts List can be used.
|
|
3139
|
-
* Labels can be added and removed using
|
|
3140
|
-
* [Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
|
|
3141
|
-
* [Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),
|
|
3142
|
-
* respectively.
|
|
3143
3111
|
*
|
|
3144
|
-
*
|
|
3145
|
-
*
|
|
3112
|
+
* Labels are used to organize contacts. Labels can be
|
|
3113
|
+
* added and removed using Label Contact and Unlabel Contact, respectively.
|
|
3114
|
+
*
|
|
3115
|
+
* To view or manage contact labels, use the Labels API.
|
|
3146
3116
|
*/
|
|
3147
3117
|
labelKeys?: LabelsWrapper$1;
|
|
3148
3118
|
/**
|
|
3149
3119
|
* Additional custom fields.
|
|
3150
|
-
* This includes fields managed by Wix, by 3rd-party apps, and by the site.
|
|
3151
3120
|
*
|
|
3152
3121
|
* Empty fields are not returned.
|
|
3153
3122
|
*/
|
|
@@ -3183,7 +3152,7 @@ interface ContactEmail$1 {
|
|
|
3183
3152
|
* Indicates whether this is the contact's primary email address.
|
|
3184
3153
|
* When changing `primary` to `true` for an email,
|
|
3185
3154
|
* the contact's other emails become `false`.
|
|
3186
|
-
*
|
|
3155
|
+
* Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
|
|
3187
3156
|
*/
|
|
3188
3157
|
primary?: boolean | null;
|
|
3189
3158
|
}
|
|
@@ -3221,10 +3190,10 @@ interface ContactPhone$1 {
|
|
|
3221
3190
|
*/
|
|
3222
3191
|
e164Phone?: string | null;
|
|
3223
3192
|
/**
|
|
3224
|
-
*
|
|
3193
|
+
* Indicates whether this is the contact's primary phone number.
|
|
3225
3194
|
* When changing `primary` to `true` for a phone,
|
|
3226
3195
|
* the contact's `primary` field for other phones becomes `false`.
|
|
3227
|
-
*
|
|
3196
|
+
* Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
|
|
3228
3197
|
*/
|
|
3229
3198
|
primary?: boolean | null;
|
|
3230
3199
|
}
|
|
@@ -3303,14 +3272,9 @@ interface StreetAddress$1 {
|
|
|
3303
3272
|
interface LabelsWrapper$1 {
|
|
3304
3273
|
/**
|
|
3305
3274
|
* List of contact label keys.
|
|
3306
|
-
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
3307
|
-
* help categorize contacts.
|
|
3308
3275
|
*
|
|
3309
|
-
* Label keys must exist to be added to the contact.
|
|
3310
|
-
* Contact labels can be created or retrieved with
|
|
3311
|
-
* [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
|
|
3312
|
-
* or
|
|
3313
|
-
* [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
|
|
3276
|
+
* Contact labels help categorize contacts. Label keys must exist to be added to the contact.
|
|
3277
|
+
* Contact labels can be created or retrieved with Find or Create Label or List Labels.
|
|
3314
3278
|
*/
|
|
3315
3279
|
items?: string[];
|
|
3316
3280
|
}
|
|
@@ -3320,8 +3284,7 @@ interface ExtendedFieldsWrapper$1 {
|
|
|
3320
3284
|
* where each key is the field key,
|
|
3321
3285
|
* and each value is the field's value for the contact.
|
|
3322
3286
|
*
|
|
3323
|
-
* To view and manage extended fields, use the
|
|
3324
|
-
* [Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).
|
|
3287
|
+
* To view and manage extended fields, use the Extended Fields API.
|
|
3325
3288
|
*/
|
|
3326
3289
|
items?: Record<string, any>;
|
|
3327
3290
|
}
|
|
@@ -3345,10 +3308,10 @@ interface Image {
|
|
|
3345
3308
|
height?: number;
|
|
3346
3309
|
/** Width of the original image. */
|
|
3347
3310
|
width?: number;
|
|
3348
|
-
/** Image alt text
|
|
3311
|
+
/** Image alt text (optional). */
|
|
3349
3312
|
altText?: string | null;
|
|
3350
3313
|
/**
|
|
3351
|
-
* Image URL expiration date (
|
|
3314
|
+
* Image URL expiration date (optional).
|
|
3352
3315
|
* @readonly
|
|
3353
3316
|
*/
|
|
3354
3317
|
urlExpirationDate?: Date | null;
|
|
@@ -3421,10 +3384,7 @@ interface ContactInfo$2 {
|
|
|
3421
3384
|
addresses?: ContactAddressesWrapper;
|
|
3422
3385
|
/** Contact's company name. */
|
|
3423
3386
|
company?: string | null;
|
|
3424
|
-
/**
|
|
3425
|
-
* Contact's job title.
|
|
3426
|
-
* Corresponds to the **Position** field in the Dashboard.
|
|
3427
|
-
*/
|
|
3387
|
+
/** Contact's job title. */
|
|
3428
3388
|
jobTitle?: string | null;
|
|
3429
3389
|
/** Birth date in `YYYY-MM-DD` format. For example, `2020-03-15`. */
|
|
3430
3390
|
birthdate?: string | null;
|
|
@@ -3438,21 +3398,15 @@ interface ContactInfo$2 {
|
|
|
3438
3398
|
locale?: string | null;
|
|
3439
3399
|
/**
|
|
3440
3400
|
* List of contact's labels.
|
|
3441
|
-
* Labels are used to organize contacts.
|
|
3442
|
-
* When setting the `labelKeys` property,
|
|
3443
|
-
* only labels that already exist in the site's Contacts List can be used.
|
|
3444
|
-
* Labels can be added and removed using
|
|
3445
|
-
* [Label Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/label-contact) and
|
|
3446
|
-
* [Unlabel Contact](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/unlabel-contact),
|
|
3447
|
-
* respectively.
|
|
3448
3401
|
*
|
|
3449
|
-
*
|
|
3450
|
-
*
|
|
3402
|
+
* Labels are used to organize contacts. Labels can be
|
|
3403
|
+
* added and removed using Label Contact and Unlabel Contact, respectively.
|
|
3404
|
+
*
|
|
3405
|
+
* To view or manage contact labels, use the Labels API.
|
|
3451
3406
|
*/
|
|
3452
3407
|
labelKeys?: LabelsWrapper;
|
|
3453
3408
|
/**
|
|
3454
3409
|
* Additional custom fields.
|
|
3455
|
-
* This includes fields managed by Wix, by 3rd-party apps, and by the site.
|
|
3456
3410
|
*
|
|
3457
3411
|
* Empty fields are not returned.
|
|
3458
3412
|
*/
|
|
@@ -3488,7 +3442,7 @@ interface ContactEmail {
|
|
|
3488
3442
|
* Indicates whether this is the contact's primary email address.
|
|
3489
3443
|
* When changing `primary` to `true` for an email,
|
|
3490
3444
|
* the contact's other emails become `false`.
|
|
3491
|
-
*
|
|
3445
|
+
* Changing the primary email of a contact also affects the subscription status to marketing emails that are decided based on the primary email.
|
|
3492
3446
|
*/
|
|
3493
3447
|
primary?: boolean | null;
|
|
3494
3448
|
}
|
|
@@ -3526,10 +3480,10 @@ interface ContactPhone {
|
|
|
3526
3480
|
*/
|
|
3527
3481
|
e164Phone?: string | null;
|
|
3528
3482
|
/**
|
|
3529
|
-
*
|
|
3483
|
+
* Indicates whether this is the contact's primary phone number.
|
|
3530
3484
|
* When changing `primary` to `true` for a phone,
|
|
3531
3485
|
* the contact's `primary` field for other phones becomes `false`.
|
|
3532
|
-
*
|
|
3486
|
+
* Changing the primary phone number also affects the subscription status to SMS messages that are decided based on the primary phone.
|
|
3533
3487
|
*/
|
|
3534
3488
|
primary?: boolean | null;
|
|
3535
3489
|
}
|
|
@@ -3608,14 +3562,9 @@ interface StreetAddress {
|
|
|
3608
3562
|
interface LabelsWrapper {
|
|
3609
3563
|
/**
|
|
3610
3564
|
* List of contact label keys.
|
|
3611
|
-
* [Contact labels](https://support.wix.com/en/article/adding-labels-to-contacts-in-your-contact-list)
|
|
3612
|
-
* help categorize contacts.
|
|
3613
3565
|
*
|
|
3614
|
-
* Label keys must exist to be added to the contact.
|
|
3615
|
-
* Contact labels can be created or retrieved with
|
|
3616
|
-
* [Find or Create Label](https://dev.wix.com/api/rest/contacts/labels/find-or-create-label)
|
|
3617
|
-
* or
|
|
3618
|
-
* [List Labels](https://dev.wix.com/api/rest/contacts/labels/list-labels)
|
|
3566
|
+
* Contact labels help categorize contacts. Label keys must exist to be added to the contact.
|
|
3567
|
+
* Contact labels can be created or retrieved with Find or Create Label or List Labels.
|
|
3619
3568
|
*/
|
|
3620
3569
|
items?: string[];
|
|
3621
3570
|
}
|
|
@@ -3625,8 +3574,7 @@ interface ExtendedFieldsWrapper {
|
|
|
3625
3574
|
* where each key is the field key,
|
|
3626
3575
|
* and each value is the field's value for the contact.
|
|
3627
3576
|
*
|
|
3628
|
-
* To view and manage extended fields, use the
|
|
3629
|
-
* [Extended Fields API](https://dev.wix.com/api/rest/contacts/extended-fields).
|
|
3577
|
+
* To view and manage extended fields, use the Extended Fields API.
|
|
3630
3578
|
*/
|
|
3631
3579
|
items?: Record<string, any>;
|
|
3632
3580
|
}
|