@wix/auto_sdk_crm_labels 1.0.1 → 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-label-labels.types.d.ts +109 -21
- package/build/cjs/src/contacts-v4-label-labels.types.js.map +1 -1
- package/build/cjs/src/contacts-v4-label-labels.universal.d.ts +140 -24
- package/build/cjs/src/contacts-v4-label-labels.universal.js +4 -0
- package/build/cjs/src/contacts-v4-label-labels.universal.js.map +1 -1
- package/build/es/src/contacts-v4-label-labels.types.d.ts +109 -21
- package/build/es/src/contacts-v4-label-labels.types.js.map +1 -1
- package/build/es/src/contacts-v4-label-labels.universal.d.ts +140 -24
- package/build/es/src/contacts-v4-label-labels.universal.js +4 -0
- package/build/es/src/contacts-v4-label-labels.universal.js.map +1 -1
- package/build/internal/cjs/src/contacts-v4-label-labels.types.d.ts +109 -21
- package/build/internal/cjs/src/contacts-v4-label-labels.types.js.map +1 -1
- package/build/internal/cjs/src/contacts-v4-label-labels.universal.d.ts +140 -24
- package/build/internal/cjs/src/contacts-v4-label-labels.universal.js +4 -0
- package/build/internal/cjs/src/contacts-v4-label-labels.universal.js.map +1 -1
- package/build/internal/es/src/contacts-v4-label-labels.types.d.ts +109 -21
- package/build/internal/es/src/contacts-v4-label-labels.types.js.map +1 -1
- package/build/internal/es/src/contacts-v4-label-labels.universal.d.ts +140 -24
- package/build/internal/es/src/contacts-v4-label-labels.universal.js +4 -0
- package/build/internal/es/src/contacts-v4-label-labels.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -6,12 +6,16 @@ export interface ContactLabel {
|
|
|
6
6
|
* Labels created by calling the Find Or Create Label method
|
|
7
7
|
* are automatically assigned to the `custom` namespace.
|
|
8
8
|
* @readonly
|
|
9
|
+
* @minLength 1
|
|
10
|
+
* @maxLength 25
|
|
9
11
|
*/
|
|
10
12
|
namespace?: string | null;
|
|
11
13
|
/**
|
|
12
14
|
* Display name for the namespace,
|
|
13
15
|
* used to organize the list of labels in the site dashboard.
|
|
14
16
|
* @readonly
|
|
17
|
+
* @minLength 1
|
|
18
|
+
* @maxLength 180
|
|
15
19
|
*/
|
|
16
20
|
namespaceDisplayName?: string | null;
|
|
17
21
|
/**
|
|
@@ -20,9 +24,15 @@ export interface ContactLabel {
|
|
|
20
24
|
* `key` is generated when the label is created.
|
|
21
25
|
* It can't be modified, even if `displayName` is updated.
|
|
22
26
|
* @readonly
|
|
27
|
+
* @minLength 1
|
|
28
|
+
* @maxLength 80
|
|
23
29
|
*/
|
|
24
30
|
key?: string;
|
|
25
|
-
/**
|
|
31
|
+
/**
|
|
32
|
+
* Label display name shown in the dashboard.
|
|
33
|
+
* @minLength 1
|
|
34
|
+
* @maxLength 180
|
|
35
|
+
*/
|
|
26
36
|
displayName?: string;
|
|
27
37
|
/**
|
|
28
38
|
* Label type indicating how the label was created.
|
|
@@ -52,18 +62,30 @@ export declare enum LabelType {
|
|
|
52
62
|
export interface ListLabelsRequest {
|
|
53
63
|
/** Filter for labels of the specified type. */
|
|
54
64
|
labelType?: LabelType;
|
|
55
|
-
/**
|
|
65
|
+
/**
|
|
66
|
+
* Filter for labels in the specified namespace.
|
|
67
|
+
* @minLength 3
|
|
68
|
+
* @maxLength 25
|
|
69
|
+
*/
|
|
56
70
|
namespace?: string | null;
|
|
57
|
-
/**
|
|
71
|
+
/**
|
|
72
|
+
* Filter for labels where `displayName` starts with the specified case-sensitive string.
|
|
73
|
+
* @minLength 1
|
|
74
|
+
* @maxLength 180
|
|
75
|
+
*/
|
|
58
76
|
startsWith?: string | null;
|
|
59
77
|
/** Sorting options. */
|
|
60
78
|
sort?: Sorting;
|
|
61
79
|
/** Paging options. */
|
|
62
80
|
paging?: Paging;
|
|
81
|
+
/** @format LANGUAGE */
|
|
63
82
|
language?: string | null;
|
|
64
83
|
}
|
|
65
84
|
export interface Sorting {
|
|
66
|
-
/**
|
|
85
|
+
/**
|
|
86
|
+
* Name of the field to sort by.
|
|
87
|
+
* @maxLength 3000
|
|
88
|
+
*/
|
|
67
89
|
fieldName?: string;
|
|
68
90
|
/**
|
|
69
91
|
* Sort order.
|
|
@@ -118,11 +140,14 @@ export interface FindOrCreateLabelRequest {
|
|
|
118
140
|
* for the specified display name,
|
|
119
141
|
* the existing label is returned.
|
|
120
142
|
* If not, a new label is created and returned.
|
|
143
|
+
* @minLength 1
|
|
144
|
+
* @maxLength 180
|
|
121
145
|
*/
|
|
122
146
|
displayName: string;
|
|
123
147
|
/**
|
|
124
148
|
* Language for localization.
|
|
125
149
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
150
|
+
* @format LANGUAGE
|
|
126
151
|
*/
|
|
127
152
|
language?: string | null;
|
|
128
153
|
}
|
|
@@ -144,7 +169,10 @@ export interface LabelsQuotaReached {
|
|
|
144
169
|
labelsCurrentTotal?: string | null;
|
|
145
170
|
}
|
|
146
171
|
export interface ListLabelNamespacesRequest {
|
|
147
|
-
/**
|
|
172
|
+
/**
|
|
173
|
+
* Language for localization
|
|
174
|
+
* @format LANGUAGE
|
|
175
|
+
*/
|
|
148
176
|
language?: string | null;
|
|
149
177
|
}
|
|
150
178
|
export interface ListLabelNamespacesResponse {
|
|
@@ -155,11 +183,15 @@ export interface ContactLabelNamespace {
|
|
|
155
183
|
/**
|
|
156
184
|
* Namespace key
|
|
157
185
|
* @readonly
|
|
186
|
+
* @minLength 1
|
|
187
|
+
* @maxLength 25
|
|
158
188
|
*/
|
|
159
189
|
key?: string;
|
|
160
190
|
/**
|
|
161
191
|
* Namespace display name
|
|
162
192
|
* @readonly
|
|
193
|
+
* @minLength 1
|
|
194
|
+
* @maxLength 25
|
|
163
195
|
*/
|
|
164
196
|
displayName?: string | null;
|
|
165
197
|
}
|
|
@@ -169,11 +201,14 @@ export interface GetLabelRequest {
|
|
|
169
201
|
*
|
|
170
202
|
* `key` is generated when the label is created.
|
|
171
203
|
* It can't be modified, even if `displayName` is updated.
|
|
204
|
+
* @minLength 1
|
|
205
|
+
* @maxLength 80
|
|
172
206
|
*/
|
|
173
207
|
key: string;
|
|
174
208
|
/**
|
|
175
209
|
* Language for localization.
|
|
176
210
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
211
|
+
* @format LANGUAGE
|
|
177
212
|
*/
|
|
178
213
|
language?: string | null;
|
|
179
214
|
}
|
|
@@ -183,9 +218,15 @@ export interface GetLabelResponse {
|
|
|
183
218
|
label?: ContactLabel;
|
|
184
219
|
}
|
|
185
220
|
export interface GetLabelByLegacyIdRequest {
|
|
186
|
-
/**
|
|
221
|
+
/**
|
|
222
|
+
* Legacy id of the label
|
|
223
|
+
* @format GUID
|
|
224
|
+
*/
|
|
187
225
|
legacyId?: string;
|
|
188
|
-
/**
|
|
226
|
+
/**
|
|
227
|
+
* Language for localization
|
|
228
|
+
* @format LANGUAGE
|
|
229
|
+
*/
|
|
189
230
|
language?: string | null;
|
|
190
231
|
}
|
|
191
232
|
export interface GetLabelByLegacyIdResponse {
|
|
@@ -198,6 +239,7 @@ export interface UpdateLabelRequest {
|
|
|
198
239
|
/**
|
|
199
240
|
* Language for localization.
|
|
200
241
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
242
|
+
* @format LANGUAGE
|
|
201
243
|
*/
|
|
202
244
|
language?: string | null;
|
|
203
245
|
}
|
|
@@ -207,15 +249,26 @@ export interface UpdateLabelResponse {
|
|
|
207
249
|
label?: ContactLabel;
|
|
208
250
|
}
|
|
209
251
|
export interface DeleteLabelRequest {
|
|
210
|
-
/**
|
|
252
|
+
/**
|
|
253
|
+
* Label key to delete.
|
|
254
|
+
* @minLength 1
|
|
255
|
+
* @maxLength 80
|
|
256
|
+
*/
|
|
211
257
|
key: string;
|
|
212
258
|
}
|
|
213
259
|
export interface DeleteLabelResponse {
|
|
214
260
|
}
|
|
215
261
|
export interface PurgeRequest {
|
|
216
|
-
/**
|
|
262
|
+
/**
|
|
263
|
+
* Contacts Instance ID of the site.
|
|
264
|
+
* @format GUID
|
|
265
|
+
*/
|
|
217
266
|
instanceId?: string;
|
|
218
|
-
/**
|
|
267
|
+
/**
|
|
268
|
+
* Labels to exclude from the purge.
|
|
269
|
+
* @maxLength 80
|
|
270
|
+
* @maxSize 80
|
|
271
|
+
*/
|
|
219
272
|
exludingLabelKeys?: string[];
|
|
220
273
|
}
|
|
221
274
|
export interface PurgeResponse {
|
|
@@ -223,7 +276,10 @@ export interface PurgeResponse {
|
|
|
223
276
|
deletedItems?: number;
|
|
224
277
|
}
|
|
225
278
|
export interface GdprListRequest {
|
|
226
|
-
/**
|
|
279
|
+
/**
|
|
280
|
+
* Contacts Instance ID of the site.
|
|
281
|
+
* @format GUID
|
|
282
|
+
*/
|
|
227
283
|
instanceId?: string;
|
|
228
284
|
}
|
|
229
285
|
export interface GdprListResponse {
|
|
@@ -236,6 +292,7 @@ export interface QueryLabelsRequest {
|
|
|
236
292
|
/**
|
|
237
293
|
* Language for localization.
|
|
238
294
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
295
|
+
* @format LANGUAGE
|
|
239
296
|
*/
|
|
240
297
|
language?: string | null;
|
|
241
298
|
}
|
|
@@ -259,6 +316,7 @@ export interface Query {
|
|
|
259
316
|
* Sorting options. For a list of fields that can be sorted, see [sorting and filtering for labels](https://dev.wix.com/api/rest/contacts/labels/sort-and-filter).
|
|
260
317
|
*
|
|
261
318
|
* Example: `{ "sort": [{"fieldName": "displayName", "order": "DESC"}] }`
|
|
319
|
+
* @maxSize 100
|
|
262
320
|
*/
|
|
263
321
|
sort?: Sorting[];
|
|
264
322
|
/** Pagination options. */
|
|
@@ -343,9 +401,15 @@ export interface ActionEvent {
|
|
|
343
401
|
bodyAsJson?: string;
|
|
344
402
|
}
|
|
345
403
|
export interface MessageEnvelope {
|
|
346
|
-
/**
|
|
404
|
+
/**
|
|
405
|
+
* App instance ID.
|
|
406
|
+
* @format GUID
|
|
407
|
+
*/
|
|
347
408
|
instanceId?: string | null;
|
|
348
|
-
/**
|
|
409
|
+
/**
|
|
410
|
+
* Event type.
|
|
411
|
+
* @maxLength 150
|
|
412
|
+
*/
|
|
349
413
|
eventType?: string;
|
|
350
414
|
/** The identification type and identity data. */
|
|
351
415
|
identity?: IdentificationData;
|
|
@@ -353,26 +417,50 @@ export interface MessageEnvelope {
|
|
|
353
417
|
data?: string;
|
|
354
418
|
}
|
|
355
419
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
356
|
-
/**
|
|
420
|
+
/**
|
|
421
|
+
* ID of a site visitor that has not logged in to the site.
|
|
422
|
+
* @format GUID
|
|
423
|
+
*/
|
|
357
424
|
anonymousVisitorId?: string;
|
|
358
|
-
/**
|
|
425
|
+
/**
|
|
426
|
+
* ID of a site visitor that has logged in to the site.
|
|
427
|
+
* @format GUID
|
|
428
|
+
*/
|
|
359
429
|
memberId?: string;
|
|
360
|
-
/**
|
|
430
|
+
/**
|
|
431
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
432
|
+
* @format GUID
|
|
433
|
+
*/
|
|
361
434
|
wixUserId?: string;
|
|
362
|
-
/**
|
|
435
|
+
/**
|
|
436
|
+
* ID of an app.
|
|
437
|
+
* @format GUID
|
|
438
|
+
*/
|
|
363
439
|
appId?: string;
|
|
364
440
|
/** @readonly */
|
|
365
441
|
identityType?: WebhookIdentityType;
|
|
366
442
|
}
|
|
367
443
|
/** @oneof */
|
|
368
444
|
export interface IdentificationDataIdOneOf {
|
|
369
|
-
/**
|
|
445
|
+
/**
|
|
446
|
+
* ID of a site visitor that has not logged in to the site.
|
|
447
|
+
* @format GUID
|
|
448
|
+
*/
|
|
370
449
|
anonymousVisitorId?: string;
|
|
371
|
-
/**
|
|
450
|
+
/**
|
|
451
|
+
* ID of a site visitor that has logged in to the site.
|
|
452
|
+
* @format GUID
|
|
453
|
+
*/
|
|
372
454
|
memberId?: string;
|
|
373
|
-
/**
|
|
455
|
+
/**
|
|
456
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
457
|
+
* @format GUID
|
|
458
|
+
*/
|
|
374
459
|
wixUserId?: string;
|
|
375
|
-
/**
|
|
460
|
+
/**
|
|
461
|
+
* ID of an app.
|
|
462
|
+
* @format GUID
|
|
463
|
+
*/
|
|
376
464
|
appId?: string;
|
|
377
465
|
}
|
|
378
466
|
export declare enum WebhookIdentityType {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contacts-v4-label-labels.types.js","sourceRoot":"","sources":["../../../src/contacts-v4-label-labels.types.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"contacts-v4-label-labels.types.js","sourceRoot":"","sources":["../../../src/contacts-v4-label-labels.types.ts"],"names":[],"mappings":";;;AAqDA,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB,iDAAiD;IACjD,8BAAiB,CAAA;IACjB,gEAAgE;IAChE,0CAA6B,CAAA;IAC7B,4CAA4C;IAC5C,gDAAmC,CAAA;AACrC,CAAC,EAPW,SAAS,yBAAT,SAAS,QAOpB;AAwCD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,+BAA+B;IAC/B,wBAAW,CAAA;IACX,gCAAgC;IAChC,0BAAa,CAAA;AACf,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA8YD,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,8DAAuC,CAAA;IACvC,wCAAiB,CAAA;IACjB,4CAAqB,CAAA;IACrB,kCAAW,CAAA;AACb,CAAC,EANW,mBAAmB,mCAAnB,mBAAmB,QAM9B"}
|
|
@@ -6,12 +6,16 @@ export interface ContactLabel {
|
|
|
6
6
|
* Labels created by calling the Find Or Create Label method
|
|
7
7
|
* are automatically assigned to the `custom` namespace.
|
|
8
8
|
* @readonly
|
|
9
|
+
* @minLength 1
|
|
10
|
+
* @maxLength 25
|
|
9
11
|
*/
|
|
10
12
|
namespace?: string | null;
|
|
11
13
|
/**
|
|
12
14
|
* Display name for the namespace,
|
|
13
15
|
* used to organize the list of labels in the site dashboard.
|
|
14
16
|
* @readonly
|
|
17
|
+
* @minLength 1
|
|
18
|
+
* @maxLength 180
|
|
15
19
|
*/
|
|
16
20
|
namespaceDisplayName?: string | null;
|
|
17
21
|
/**
|
|
@@ -20,9 +24,15 @@ export interface ContactLabel {
|
|
|
20
24
|
* `key` is generated when the label is created.
|
|
21
25
|
* It can't be modified, even if `displayName` is updated.
|
|
22
26
|
* @readonly
|
|
27
|
+
* @minLength 1
|
|
28
|
+
* @maxLength 80
|
|
23
29
|
*/
|
|
24
30
|
key?: string;
|
|
25
|
-
/**
|
|
31
|
+
/**
|
|
32
|
+
* Label display name shown in the dashboard.
|
|
33
|
+
* @minLength 1
|
|
34
|
+
* @maxLength 180
|
|
35
|
+
*/
|
|
26
36
|
displayName?: string;
|
|
27
37
|
/**
|
|
28
38
|
* Label type indicating how the label was created.
|
|
@@ -52,18 +62,30 @@ export declare enum LabelType {
|
|
|
52
62
|
export interface ListLabelsRequest {
|
|
53
63
|
/** Filter for labels of the specified type. */
|
|
54
64
|
labelType?: LabelType;
|
|
55
|
-
/**
|
|
65
|
+
/**
|
|
66
|
+
* Filter for labels in the specified namespace.
|
|
67
|
+
* @minLength 3
|
|
68
|
+
* @maxLength 25
|
|
69
|
+
*/
|
|
56
70
|
namespace?: string | null;
|
|
57
|
-
/**
|
|
71
|
+
/**
|
|
72
|
+
* Filter for labels where `displayName` starts with the specified case-sensitive string.
|
|
73
|
+
* @minLength 1
|
|
74
|
+
* @maxLength 180
|
|
75
|
+
*/
|
|
58
76
|
startsWith?: string | null;
|
|
59
77
|
/** Sorting options. */
|
|
60
78
|
sort?: Sorting;
|
|
61
79
|
/** Paging options. */
|
|
62
80
|
paging?: Paging;
|
|
81
|
+
/** @format LANGUAGE */
|
|
63
82
|
language?: string | null;
|
|
64
83
|
}
|
|
65
84
|
export interface Sorting {
|
|
66
|
-
/**
|
|
85
|
+
/**
|
|
86
|
+
* Name of the field to sort by.
|
|
87
|
+
* @maxLength 3000
|
|
88
|
+
*/
|
|
67
89
|
fieldName?: string;
|
|
68
90
|
/**
|
|
69
91
|
* Sort order.
|
|
@@ -118,11 +140,14 @@ export interface FindOrCreateLabelRequest {
|
|
|
118
140
|
* for the specified display name,
|
|
119
141
|
* the existing label is returned.
|
|
120
142
|
* If not, a new label is created and returned.
|
|
143
|
+
* @minLength 1
|
|
144
|
+
* @maxLength 180
|
|
121
145
|
*/
|
|
122
146
|
displayName: string;
|
|
123
147
|
/**
|
|
124
148
|
* Language for localization.
|
|
125
149
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
150
|
+
* @format LANGUAGE
|
|
126
151
|
*/
|
|
127
152
|
language?: string | null;
|
|
128
153
|
}
|
|
@@ -144,7 +169,10 @@ export interface LabelsQuotaReached {
|
|
|
144
169
|
labelsCurrentTotal?: string | null;
|
|
145
170
|
}
|
|
146
171
|
export interface ListLabelNamespacesRequest {
|
|
147
|
-
/**
|
|
172
|
+
/**
|
|
173
|
+
* Language for localization
|
|
174
|
+
* @format LANGUAGE
|
|
175
|
+
*/
|
|
148
176
|
language?: string | null;
|
|
149
177
|
}
|
|
150
178
|
export interface ListLabelNamespacesResponse {
|
|
@@ -155,11 +183,15 @@ export interface ContactLabelNamespace {
|
|
|
155
183
|
/**
|
|
156
184
|
* Namespace key
|
|
157
185
|
* @readonly
|
|
186
|
+
* @minLength 1
|
|
187
|
+
* @maxLength 25
|
|
158
188
|
*/
|
|
159
189
|
key?: string;
|
|
160
190
|
/**
|
|
161
191
|
* Namespace display name
|
|
162
192
|
* @readonly
|
|
193
|
+
* @minLength 1
|
|
194
|
+
* @maxLength 25
|
|
163
195
|
*/
|
|
164
196
|
displayName?: string | null;
|
|
165
197
|
}
|
|
@@ -169,11 +201,14 @@ export interface GetLabelRequest {
|
|
|
169
201
|
*
|
|
170
202
|
* `key` is generated when the label is created.
|
|
171
203
|
* It can't be modified, even if `displayName` is updated.
|
|
204
|
+
* @minLength 1
|
|
205
|
+
* @maxLength 80
|
|
172
206
|
*/
|
|
173
207
|
key: string;
|
|
174
208
|
/**
|
|
175
209
|
* Language for localization.
|
|
176
210
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
211
|
+
* @format LANGUAGE
|
|
177
212
|
*/
|
|
178
213
|
language?: string | null;
|
|
179
214
|
}
|
|
@@ -183,9 +218,15 @@ export interface GetLabelResponse {
|
|
|
183
218
|
label?: ContactLabel;
|
|
184
219
|
}
|
|
185
220
|
export interface GetLabelByLegacyIdRequest {
|
|
186
|
-
/**
|
|
221
|
+
/**
|
|
222
|
+
* Legacy id of the label
|
|
223
|
+
* @format GUID
|
|
224
|
+
*/
|
|
187
225
|
legacyId?: string;
|
|
188
|
-
/**
|
|
226
|
+
/**
|
|
227
|
+
* Language for localization
|
|
228
|
+
* @format LANGUAGE
|
|
229
|
+
*/
|
|
189
230
|
language?: string | null;
|
|
190
231
|
}
|
|
191
232
|
export interface GetLabelByLegacyIdResponse {
|
|
@@ -198,6 +239,7 @@ export interface UpdateLabelRequest {
|
|
|
198
239
|
/**
|
|
199
240
|
* Language for localization.
|
|
200
241
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
242
|
+
* @format LANGUAGE
|
|
201
243
|
*/
|
|
202
244
|
language?: string | null;
|
|
203
245
|
}
|
|
@@ -207,15 +249,26 @@ export interface UpdateLabelResponse {
|
|
|
207
249
|
label?: ContactLabel;
|
|
208
250
|
}
|
|
209
251
|
export interface DeleteLabelRequest {
|
|
210
|
-
/**
|
|
252
|
+
/**
|
|
253
|
+
* Label key to delete.
|
|
254
|
+
* @minLength 1
|
|
255
|
+
* @maxLength 80
|
|
256
|
+
*/
|
|
211
257
|
key: string;
|
|
212
258
|
}
|
|
213
259
|
export interface DeleteLabelResponse {
|
|
214
260
|
}
|
|
215
261
|
export interface PurgeRequest {
|
|
216
|
-
/**
|
|
262
|
+
/**
|
|
263
|
+
* Contacts Instance ID of the site.
|
|
264
|
+
* @format GUID
|
|
265
|
+
*/
|
|
217
266
|
instanceId?: string;
|
|
218
|
-
/**
|
|
267
|
+
/**
|
|
268
|
+
* Labels to exclude from the purge.
|
|
269
|
+
* @maxLength 80
|
|
270
|
+
* @maxSize 80
|
|
271
|
+
*/
|
|
219
272
|
exludingLabelKeys?: string[];
|
|
220
273
|
}
|
|
221
274
|
export interface PurgeResponse {
|
|
@@ -223,7 +276,10 @@ export interface PurgeResponse {
|
|
|
223
276
|
deletedItems?: number;
|
|
224
277
|
}
|
|
225
278
|
export interface GdprListRequest {
|
|
226
|
-
/**
|
|
279
|
+
/**
|
|
280
|
+
* Contacts Instance ID of the site.
|
|
281
|
+
* @format GUID
|
|
282
|
+
*/
|
|
227
283
|
instanceId?: string;
|
|
228
284
|
}
|
|
229
285
|
export interface GdprListResponse {
|
|
@@ -236,6 +292,7 @@ export interface QueryLabelsRequest {
|
|
|
236
292
|
/**
|
|
237
293
|
* Language for localization.
|
|
238
294
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
295
|
+
* @format LANGUAGE
|
|
239
296
|
*/
|
|
240
297
|
language?: string | null;
|
|
241
298
|
}
|
|
@@ -259,6 +316,7 @@ export interface Query {
|
|
|
259
316
|
* Sorting options. For a list of fields that can be sorted, see [sorting and filtering for labels](https://dev.wix.com/api/rest/contacts/labels/sort-and-filter).
|
|
260
317
|
*
|
|
261
318
|
* Example: `{ "sort": [{"fieldName": "displayName", "order": "DESC"}] }`
|
|
319
|
+
* @maxSize 100
|
|
262
320
|
*/
|
|
263
321
|
sort?: Sorting[];
|
|
264
322
|
/** Pagination options. */
|
|
@@ -341,9 +399,15 @@ export interface ActionEvent {
|
|
|
341
399
|
body?: string;
|
|
342
400
|
}
|
|
343
401
|
export interface MessageEnvelope {
|
|
344
|
-
/**
|
|
402
|
+
/**
|
|
403
|
+
* App instance ID.
|
|
404
|
+
* @format GUID
|
|
405
|
+
*/
|
|
345
406
|
instanceId?: string | null;
|
|
346
|
-
/**
|
|
407
|
+
/**
|
|
408
|
+
* Event type.
|
|
409
|
+
* @maxLength 150
|
|
410
|
+
*/
|
|
347
411
|
eventType?: string;
|
|
348
412
|
/** The identification type and identity data. */
|
|
349
413
|
identity?: IdentificationData;
|
|
@@ -351,26 +415,50 @@ export interface MessageEnvelope {
|
|
|
351
415
|
data?: string;
|
|
352
416
|
}
|
|
353
417
|
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
354
|
-
/**
|
|
418
|
+
/**
|
|
419
|
+
* ID of a site visitor that has not logged in to the site.
|
|
420
|
+
* @format GUID
|
|
421
|
+
*/
|
|
355
422
|
anonymousVisitorId?: string;
|
|
356
|
-
/**
|
|
423
|
+
/**
|
|
424
|
+
* ID of a site visitor that has logged in to the site.
|
|
425
|
+
* @format GUID
|
|
426
|
+
*/
|
|
357
427
|
memberId?: string;
|
|
358
|
-
/**
|
|
428
|
+
/**
|
|
429
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
430
|
+
* @format GUID
|
|
431
|
+
*/
|
|
359
432
|
wixUserId?: string;
|
|
360
|
-
/**
|
|
433
|
+
/**
|
|
434
|
+
* ID of an app.
|
|
435
|
+
* @format GUID
|
|
436
|
+
*/
|
|
361
437
|
appId?: string;
|
|
362
438
|
/** @readonly */
|
|
363
439
|
identityType?: WebhookIdentityType;
|
|
364
440
|
}
|
|
365
441
|
/** @oneof */
|
|
366
442
|
export interface IdentificationDataIdOneOf {
|
|
367
|
-
/**
|
|
443
|
+
/**
|
|
444
|
+
* ID of a site visitor that has not logged in to the site.
|
|
445
|
+
* @format GUID
|
|
446
|
+
*/
|
|
368
447
|
anonymousVisitorId?: string;
|
|
369
|
-
/**
|
|
448
|
+
/**
|
|
449
|
+
* ID of a site visitor that has logged in to the site.
|
|
450
|
+
* @format GUID
|
|
451
|
+
*/
|
|
370
452
|
memberId?: string;
|
|
371
|
-
/**
|
|
453
|
+
/**
|
|
454
|
+
* ID of a Wix user (site owner, contributor, etc.).
|
|
455
|
+
* @format GUID
|
|
456
|
+
*/
|
|
372
457
|
wixUserId?: string;
|
|
373
|
-
/**
|
|
458
|
+
/**
|
|
459
|
+
* ID of an app.
|
|
460
|
+
* @format GUID
|
|
461
|
+
*/
|
|
374
462
|
appId?: string;
|
|
375
463
|
}
|
|
376
464
|
export declare enum WebhookIdentityType {
|
|
@@ -399,9 +487,15 @@ export interface QueryLabelsResponseNonNullableFields {
|
|
|
399
487
|
labels: ContactLabelNonNullableFields[];
|
|
400
488
|
}
|
|
401
489
|
export interface BaseEventMetadata {
|
|
402
|
-
/**
|
|
490
|
+
/**
|
|
491
|
+
* App instance ID.
|
|
492
|
+
* @format GUID
|
|
493
|
+
*/
|
|
403
494
|
instanceId?: string | null;
|
|
404
|
-
/**
|
|
495
|
+
/**
|
|
496
|
+
* Event type.
|
|
497
|
+
* @maxLength 150
|
|
498
|
+
*/
|
|
405
499
|
eventType?: string;
|
|
406
500
|
/** The identification type and identity data. */
|
|
407
501
|
identity?: IdentificationData;
|
|
@@ -462,6 +556,8 @@ export interface LabelCreatedEnvelope {
|
|
|
462
556
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
463
557
|
* @permissionScope Manage Restaurants - all permissions
|
|
464
558
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
559
|
+
* @permissionScope Set Up Automations
|
|
560
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
465
561
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
466
562
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
467
563
|
* @permissionId CONTACTS_LABELS.VIEW
|
|
@@ -488,6 +584,8 @@ export interface LabelDeletedEnvelope {
|
|
|
488
584
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
489
585
|
* @permissionScope Manage Restaurants - all permissions
|
|
490
586
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
587
|
+
* @permissionScope Set Up Automations
|
|
588
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
491
589
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
492
590
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
493
591
|
* @permissionId CONTACTS_LABELS.VIEW
|
|
@@ -515,6 +613,8 @@ export interface LabelUpdatedEnvelope {
|
|
|
515
613
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
516
614
|
* @permissionScope Manage Restaurants - all permissions
|
|
517
615
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
616
|
+
* @permissionScope Set Up Automations
|
|
617
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
518
618
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
519
619
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
520
620
|
* @permissionId CONTACTS_LABELS.VIEW
|
|
@@ -560,6 +660,7 @@ export interface FindOrCreateLabelOptions {
|
|
|
560
660
|
/**
|
|
561
661
|
* Language for localization.
|
|
562
662
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
663
|
+
* @format LANGUAGE
|
|
563
664
|
*/
|
|
564
665
|
language?: string | null;
|
|
565
666
|
}
|
|
@@ -585,6 +686,8 @@ export interface FindOrCreateLabelOptions {
|
|
|
585
686
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
586
687
|
* @permissionScope Manage Restaurants - all permissions
|
|
587
688
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
689
|
+
* @permissionScope Set Up Automations
|
|
690
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
588
691
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
589
692
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
590
693
|
* @applicableIdentity APP
|
|
@@ -596,6 +699,7 @@ export interface GetLabelOptions {
|
|
|
596
699
|
/**
|
|
597
700
|
* Language for localization.
|
|
598
701
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
702
|
+
* @format LANGUAGE
|
|
599
703
|
*/
|
|
600
704
|
language?: string | null;
|
|
601
705
|
}
|
|
@@ -628,15 +732,23 @@ export interface RenameLabel {
|
|
|
628
732
|
* Labels created by calling the Find Or Create Label method
|
|
629
733
|
* are automatically assigned to the `custom` namespace.
|
|
630
734
|
* @readonly
|
|
735
|
+
* @minLength 1
|
|
736
|
+
* @maxLength 25
|
|
631
737
|
*/
|
|
632
738
|
namespace?: string | null;
|
|
633
739
|
/**
|
|
634
740
|
* Display name for the namespace,
|
|
635
741
|
* used to organize the list of labels in the site dashboard.
|
|
636
742
|
* @readonly
|
|
743
|
+
* @minLength 1
|
|
744
|
+
* @maxLength 180
|
|
637
745
|
*/
|
|
638
746
|
namespaceDisplayName?: string | null;
|
|
639
|
-
/**
|
|
747
|
+
/**
|
|
748
|
+
* Label display name shown in the dashboard.
|
|
749
|
+
* @minLength 1
|
|
750
|
+
* @maxLength 180
|
|
751
|
+
*/
|
|
640
752
|
displayName?: string;
|
|
641
753
|
/**
|
|
642
754
|
* Label type indicating how the label was created.
|
|
@@ -658,6 +770,7 @@ export interface RenameLabelOptions {
|
|
|
658
770
|
/**
|
|
659
771
|
* Language for localization.
|
|
660
772
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
773
|
+
* @format LANGUAGE
|
|
661
774
|
*/
|
|
662
775
|
language?: string | null;
|
|
663
776
|
}
|
|
@@ -706,6 +819,8 @@ export declare function deleteLabel(key: string): Promise<void>;
|
|
|
706
819
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
707
820
|
* @permissionScope Manage Restaurants - all permissions
|
|
708
821
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
822
|
+
* @permissionScope Set Up Automations
|
|
823
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
709
824
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
710
825
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
711
826
|
* @permissionId CONTACTS_LABELS.VIEW
|
|
@@ -719,6 +834,7 @@ export interface QueryLabelsOptions {
|
|
|
719
834
|
*
|
|
720
835
|
* 2-letter language code in
|
|
721
836
|
* [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
|
|
837
|
+
* @format LANGUAGE
|
|
722
838
|
*/
|
|
723
839
|
language?: string | null | undefined;
|
|
724
840
|
}
|
|
@@ -133,6 +133,8 @@ exports.findOrCreateLabel = findOrCreateLabel;
|
|
|
133
133
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
134
134
|
* @permissionScope Manage Restaurants - all permissions
|
|
135
135
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
136
|
+
* @permissionScope Set Up Automations
|
|
137
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
136
138
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
137
139
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
138
140
|
* @applicableIdentity APP
|
|
@@ -278,6 +280,8 @@ exports.deleteLabel = deleteLabel;
|
|
|
278
280
|
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
279
281
|
* @permissionScope Manage Restaurants - all permissions
|
|
280
282
|
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
283
|
+
* @permissionScope Set Up Automations
|
|
284
|
+
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
281
285
|
* @permissionScope Manage Members and Contacts - all permissions
|
|
282
286
|
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
283
287
|
* @permissionId CONTACTS_LABELS.VIEW
|