@wix/auto_sdk_crm_labels 1.0.6 → 1.0.7
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/{internal/cjs/src/contacts-v4-label-labels.universal.d.ts → contacts-v4-label-labels.universal-DsdJJYu9.d.mts} +54 -287
- package/build/{cjs/src/contacts-v4-label-labels.universal.d.ts → contacts-v4-label-labels.universal-DsdJJYu9.d.ts} +54 -287
- package/build/{cjs/src/contacts-v4-label-labels.public.d.ts → index.d.mts} +30 -14
- package/build/{internal/es/src/contacts-v4-label-labels.public.d.ts → index.d.ts} +30 -14
- package/build/index.js +514 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +480 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/contacts-v4-label-labels.universal.d.ts → internal/contacts-v4-label-labels.universal-DsdJJYu9.d.mts} +54 -287
- package/build/internal/{es/src/contacts-v4-label-labels.universal.d.ts → contacts-v4-label-labels.universal-DsdJJYu9.d.ts} +54 -287
- package/build/{es/src/contacts-v4-label-labels.public.d.ts → internal/index.d.mts} +30 -14
- package/build/internal/{cjs/src/contacts-v4-label-labels.public.d.ts → index.d.ts} +30 -14
- package/build/internal/index.js +514 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +480 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +249 -0
- package/build/internal/meta.d.ts +249 -0
- package/build/internal/meta.js +311 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +280 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +249 -0
- package/build/meta.d.ts +249 -0
- package/build/meta.js +311 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +280 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/contacts-v4-label-labels.context.d.ts +0 -25
- package/build/cjs/src/contacts-v4-label-labels.context.js +0 -31
- package/build/cjs/src/contacts-v4-label-labels.context.js.map +0 -1
- package/build/cjs/src/contacts-v4-label-labels.http.d.ts +0 -41
- package/build/cjs/src/contacts-v4-label-labels.http.js +0 -223
- package/build/cjs/src/contacts-v4-label-labels.http.js.map +0 -1
- package/build/cjs/src/contacts-v4-label-labels.meta.d.ts +0 -23
- package/build/cjs/src/contacts-v4-label-labels.meta.js +0 -123
- package/build/cjs/src/contacts-v4-label-labels.meta.js.map +0 -1
- package/build/cjs/src/contacts-v4-label-labels.public.js +0 -74
- package/build/cjs/src/contacts-v4-label-labels.public.js.map +0 -1
- package/build/cjs/src/contacts-v4-label-labels.types.d.ts +0 -472
- package/build/cjs/src/contacts-v4-label-labels.types.js +0 -28
- package/build/cjs/src/contacts-v4-label-labels.types.js.map +0 -1
- package/build/cjs/src/contacts-v4-label-labels.universal.js +0 -348
- package/build/cjs/src/contacts-v4-label-labels.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/contacts-v4-label-labels.context.d.ts +0 -25
- package/build/es/src/contacts-v4-label-labels.context.js +0 -25
- package/build/es/src/contacts-v4-label-labels.context.js.map +0 -1
- package/build/es/src/contacts-v4-label-labels.http.d.ts +0 -41
- package/build/es/src/contacts-v4-label-labels.http.js +0 -215
- package/build/es/src/contacts-v4-label-labels.http.js.map +0 -1
- package/build/es/src/contacts-v4-label-labels.meta.d.ts +0 -23
- package/build/es/src/contacts-v4-label-labels.meta.js +0 -92
- package/build/es/src/contacts-v4-label-labels.meta.js.map +0 -1
- package/build/es/src/contacts-v4-label-labels.public.js +0 -63
- package/build/es/src/contacts-v4-label-labels.public.js.map +0 -1
- package/build/es/src/contacts-v4-label-labels.types.d.ts +0 -472
- package/build/es/src/contacts-v4-label-labels.types.js +0 -25
- package/build/es/src/contacts-v4-label-labels.types.js.map +0 -1
- package/build/es/src/contacts-v4-label-labels.universal.js +0 -317
- package/build/es/src/contacts-v4-label-labels.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-label-labels.context.d.ts +0 -25
- package/build/internal/cjs/src/contacts-v4-label-labels.context.js +0 -31
- package/build/internal/cjs/src/contacts-v4-label-labels.context.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-label-labels.http.d.ts +0 -41
- package/build/internal/cjs/src/contacts-v4-label-labels.http.js +0 -223
- package/build/internal/cjs/src/contacts-v4-label-labels.http.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-label-labels.meta.d.ts +0 -23
- package/build/internal/cjs/src/contacts-v4-label-labels.meta.js +0 -123
- package/build/internal/cjs/src/contacts-v4-label-labels.meta.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-label-labels.public.js +0 -74
- package/build/internal/cjs/src/contacts-v4-label-labels.public.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-label-labels.types.d.ts +0 -472
- package/build/internal/cjs/src/contacts-v4-label-labels.types.js +0 -28
- package/build/internal/cjs/src/contacts-v4-label-labels.types.js.map +0 -1
- package/build/internal/cjs/src/contacts-v4-label-labels.universal.js +0 -348
- package/build/internal/cjs/src/contacts-v4-label-labels.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/contacts-v4-label-labels.context.d.ts +0 -25
- package/build/internal/es/src/contacts-v4-label-labels.context.js +0 -25
- package/build/internal/es/src/contacts-v4-label-labels.context.js.map +0 -1
- package/build/internal/es/src/contacts-v4-label-labels.http.d.ts +0 -41
- package/build/internal/es/src/contacts-v4-label-labels.http.js +0 -215
- package/build/internal/es/src/contacts-v4-label-labels.http.js.map +0 -1
- package/build/internal/es/src/contacts-v4-label-labels.meta.d.ts +0 -23
- package/build/internal/es/src/contacts-v4-label-labels.meta.js +0 -92
- package/build/internal/es/src/contacts-v4-label-labels.meta.js.map +0 -1
- package/build/internal/es/src/contacts-v4-label-labels.public.js +0 -63
- package/build/internal/es/src/contacts-v4-label-labels.public.js.map +0 -1
- package/build/internal/es/src/contacts-v4-label-labels.types.d.ts +0 -472
- package/build/internal/es/src/contacts-v4-label-labels.types.js +0 -25
- package/build/internal/es/src/contacts-v4-label-labels.types.js.map +0 -1
- package/build/internal/es/src/contacts-v4-label-labels.universal.js +0 -317
- package/build/internal/es/src/contacts-v4-label-labels.universal.js.map +0 -1
|
@@ -1,6 +1,5 @@
|
|
|
1
|
-
import { NonNullablePaths } from '@wix/sdk-types';
|
|
2
1
|
/** Label that was found or created. */
|
|
3
|
-
|
|
2
|
+
interface ContactLabel {
|
|
4
3
|
/**
|
|
5
4
|
* Label namespace.
|
|
6
5
|
*
|
|
@@ -51,7 +50,7 @@ export interface ContactLabel {
|
|
|
51
50
|
*/
|
|
52
51
|
_updatedDate?: Date | null;
|
|
53
52
|
}
|
|
54
|
-
|
|
53
|
+
declare enum LabelType {
|
|
55
54
|
/** Default system label for the contact list. */
|
|
56
55
|
SYSTEM = "SYSTEM",
|
|
57
56
|
/** Label created by calling the Find Or Create Label method. */
|
|
@@ -60,7 +59,7 @@ export declare enum LabelType {
|
|
|
60
59
|
WIX_APP_DEFINED = "WIX_APP_DEFINED"
|
|
61
60
|
}
|
|
62
61
|
/** Label filter options. */
|
|
63
|
-
|
|
62
|
+
interface ListLabelsRequest {
|
|
64
63
|
/** Filter for labels of the specified type. */
|
|
65
64
|
labelType?: LabelType;
|
|
66
65
|
/**
|
|
@@ -82,7 +81,7 @@ export interface ListLabelsRequest {
|
|
|
82
81
|
/** @format LANGUAGE */
|
|
83
82
|
language?: string | null;
|
|
84
83
|
}
|
|
85
|
-
|
|
84
|
+
interface Sorting {
|
|
86
85
|
/**
|
|
87
86
|
* Name of the field to sort by.
|
|
88
87
|
* @maxLength 3000
|
|
@@ -95,13 +94,13 @@ export interface Sorting {
|
|
|
95
94
|
*/
|
|
96
95
|
order?: SortOrder;
|
|
97
96
|
}
|
|
98
|
-
|
|
97
|
+
declare enum SortOrder {
|
|
99
98
|
/** Sort by ascending order. */
|
|
100
99
|
ASC = "ASC",
|
|
101
100
|
/** Sort by descending order. */
|
|
102
101
|
DESC = "DESC"
|
|
103
102
|
}
|
|
104
|
-
|
|
103
|
+
interface Paging {
|
|
105
104
|
/**
|
|
106
105
|
* Number of items to return.
|
|
107
106
|
*
|
|
@@ -113,13 +112,13 @@ export interface Paging {
|
|
|
113
112
|
offset?: number | null;
|
|
114
113
|
}
|
|
115
114
|
/** List of labels. */
|
|
116
|
-
|
|
115
|
+
interface ListLabelsResponse {
|
|
117
116
|
/** List of labels. */
|
|
118
117
|
labels?: ContactLabel[];
|
|
119
118
|
/** Metadata for the page of results. */
|
|
120
119
|
metadata?: PagingMetadata;
|
|
121
120
|
}
|
|
122
|
-
|
|
121
|
+
interface PagingMetadata {
|
|
123
122
|
/** Number of items returned. */
|
|
124
123
|
count?: number | null;
|
|
125
124
|
/** Requested offset. */
|
|
@@ -133,7 +132,7 @@ export interface PagingMetadata {
|
|
|
133
132
|
tooManyToCount?: boolean | null;
|
|
134
133
|
}
|
|
135
134
|
/** Label to find or create. */
|
|
136
|
-
|
|
135
|
+
interface FindOrCreateLabelRequest {
|
|
137
136
|
/**
|
|
138
137
|
* Display name to retrieve or create.
|
|
139
138
|
*
|
|
@@ -153,7 +152,7 @@ export interface FindOrCreateLabelRequest {
|
|
|
153
152
|
language?: string | null;
|
|
154
153
|
}
|
|
155
154
|
/** Label that was found or created. */
|
|
156
|
-
|
|
155
|
+
interface FindOrCreateLabelResponse {
|
|
157
156
|
/** Label that was found or created. */
|
|
158
157
|
label?: ContactLabel;
|
|
159
158
|
/**
|
|
@@ -163,24 +162,24 @@ export interface FindOrCreateLabelResponse {
|
|
|
163
162
|
*/
|
|
164
163
|
newLabel?: boolean;
|
|
165
164
|
}
|
|
166
|
-
|
|
165
|
+
interface LabelsQuotaReached {
|
|
167
166
|
/** The maximum number of labels allowed for the site. */
|
|
168
167
|
labelsQuota?: string | null;
|
|
169
168
|
/** The current total number of labels on the site. */
|
|
170
169
|
labelsCurrentTotal?: string | null;
|
|
171
170
|
}
|
|
172
|
-
|
|
171
|
+
interface ListLabelNamespacesRequest {
|
|
173
172
|
/**
|
|
174
173
|
* Language for localization
|
|
175
174
|
* @format LANGUAGE
|
|
176
175
|
*/
|
|
177
176
|
language?: string | null;
|
|
178
177
|
}
|
|
179
|
-
|
|
178
|
+
interface ListLabelNamespacesResponse {
|
|
180
179
|
/** List of namespaces */
|
|
181
180
|
namespaces?: ContactLabelNamespace[];
|
|
182
181
|
}
|
|
183
|
-
|
|
182
|
+
interface ContactLabelNamespace {
|
|
184
183
|
/**
|
|
185
184
|
* Namespace key
|
|
186
185
|
* @readonly
|
|
@@ -196,7 +195,7 @@ export interface ContactLabelNamespace {
|
|
|
196
195
|
*/
|
|
197
196
|
displayName?: string | null;
|
|
198
197
|
}
|
|
199
|
-
|
|
198
|
+
interface GetLabelRequest {
|
|
200
199
|
/**
|
|
201
200
|
* Label key.
|
|
202
201
|
*
|
|
@@ -214,11 +213,11 @@ export interface GetLabelRequest {
|
|
|
214
213
|
language?: string | null;
|
|
215
214
|
}
|
|
216
215
|
/** The specified label. */
|
|
217
|
-
|
|
216
|
+
interface GetLabelResponse {
|
|
218
217
|
/** The specified label. */
|
|
219
218
|
label?: ContactLabel;
|
|
220
219
|
}
|
|
221
|
-
|
|
220
|
+
interface GetLabelByLegacyIdRequest {
|
|
222
221
|
/**
|
|
223
222
|
* Legacy id of the label
|
|
224
223
|
* @format GUID
|
|
@@ -230,11 +229,11 @@ export interface GetLabelByLegacyIdRequest {
|
|
|
230
229
|
*/
|
|
231
230
|
language?: string | null;
|
|
232
231
|
}
|
|
233
|
-
|
|
232
|
+
interface GetLabelByLegacyIdResponse {
|
|
234
233
|
/** Requested label */
|
|
235
234
|
label?: ContactLabel;
|
|
236
235
|
}
|
|
237
|
-
|
|
236
|
+
interface UpdateLabelRequest {
|
|
238
237
|
/** Label to rename. */
|
|
239
238
|
label?: ContactLabel;
|
|
240
239
|
/**
|
|
@@ -245,11 +244,11 @@ export interface UpdateLabelRequest {
|
|
|
245
244
|
language?: string | null;
|
|
246
245
|
}
|
|
247
246
|
/** Updated label. */
|
|
248
|
-
|
|
247
|
+
interface UpdateLabelResponse {
|
|
249
248
|
/** Renamed label. */
|
|
250
249
|
label?: ContactLabel;
|
|
251
250
|
}
|
|
252
|
-
|
|
251
|
+
interface DeleteLabelRequest {
|
|
253
252
|
/**
|
|
254
253
|
* Label key to delete.
|
|
255
254
|
* @minLength 1
|
|
@@ -257,9 +256,9 @@ export interface DeleteLabelRequest {
|
|
|
257
256
|
*/
|
|
258
257
|
key: string;
|
|
259
258
|
}
|
|
260
|
-
|
|
259
|
+
interface DeleteLabelResponse {
|
|
261
260
|
}
|
|
262
|
-
|
|
261
|
+
interface PurgeRequest {
|
|
263
262
|
/**
|
|
264
263
|
* Contacts Instance ID of the site.
|
|
265
264
|
* @format GUID
|
|
@@ -272,22 +271,22 @@ export interface PurgeRequest {
|
|
|
272
271
|
*/
|
|
273
272
|
exludingLabelKeys?: string[];
|
|
274
273
|
}
|
|
275
|
-
|
|
274
|
+
interface PurgeResponse {
|
|
276
275
|
/** Number of deleted items */
|
|
277
276
|
deletedItems?: number;
|
|
278
277
|
}
|
|
279
|
-
|
|
278
|
+
interface GdprListRequest {
|
|
280
279
|
/**
|
|
281
280
|
* Contacts Instance ID of the site.
|
|
282
281
|
* @format GUID
|
|
283
282
|
*/
|
|
284
283
|
instanceId?: string;
|
|
285
284
|
}
|
|
286
|
-
|
|
285
|
+
interface GdprListResponse {
|
|
287
286
|
/** List of labels */
|
|
288
287
|
labels?: ContactLabel[];
|
|
289
288
|
}
|
|
290
|
-
|
|
289
|
+
interface QueryLabelsRequest {
|
|
291
290
|
/** Query options. */
|
|
292
291
|
query?: Query;
|
|
293
292
|
/**
|
|
@@ -297,7 +296,7 @@ export interface QueryLabelsRequest {
|
|
|
297
296
|
*/
|
|
298
297
|
language?: string | null;
|
|
299
298
|
}
|
|
300
|
-
|
|
299
|
+
interface Query {
|
|
301
300
|
/**
|
|
302
301
|
* ilter object.
|
|
303
302
|
*
|
|
@@ -323,13 +322,13 @@ export interface Query {
|
|
|
323
322
|
/** Pagination options. */
|
|
324
323
|
paging?: Paging;
|
|
325
324
|
}
|
|
326
|
-
|
|
325
|
+
interface QueryLabelsResponse {
|
|
327
326
|
/** List of labels */
|
|
328
327
|
labels?: ContactLabel[];
|
|
329
328
|
/** Details on the paged set of results returned. */
|
|
330
329
|
pagingMetadata?: PagingMetadata;
|
|
331
330
|
}
|
|
332
|
-
|
|
331
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
333
332
|
createdEvent?: EntityCreatedEvent;
|
|
334
333
|
updatedEvent?: EntityUpdatedEvent;
|
|
335
334
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -372,19 +371,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
372
371
|
entityEventSequence?: string | null;
|
|
373
372
|
}
|
|
374
373
|
/** @oneof */
|
|
375
|
-
|
|
374
|
+
interface DomainEventBodyOneOf {
|
|
376
375
|
createdEvent?: EntityCreatedEvent;
|
|
377
376
|
updatedEvent?: EntityUpdatedEvent;
|
|
378
377
|
deletedEvent?: EntityDeletedEvent;
|
|
379
378
|
actionEvent?: ActionEvent;
|
|
380
379
|
}
|
|
381
|
-
|
|
380
|
+
interface EntityCreatedEvent {
|
|
382
381
|
entity?: string;
|
|
383
382
|
}
|
|
384
|
-
|
|
383
|
+
interface RestoreInfo {
|
|
385
384
|
deletedDate?: Date | null;
|
|
386
385
|
}
|
|
387
|
-
|
|
386
|
+
interface EntityUpdatedEvent {
|
|
388
387
|
/**
|
|
389
388
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
390
389
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -392,14 +391,14 @@ export interface EntityUpdatedEvent {
|
|
|
392
391
|
*/
|
|
393
392
|
currentEntity?: string;
|
|
394
393
|
}
|
|
395
|
-
|
|
394
|
+
interface EntityDeletedEvent {
|
|
396
395
|
/** Entity that was deleted */
|
|
397
396
|
deletedEntity?: string | null;
|
|
398
397
|
}
|
|
399
|
-
|
|
398
|
+
interface ActionEvent {
|
|
400
399
|
body?: string;
|
|
401
400
|
}
|
|
402
|
-
|
|
401
|
+
interface MessageEnvelope {
|
|
403
402
|
/**
|
|
404
403
|
* App instance ID.
|
|
405
404
|
* @format GUID
|
|
@@ -415,7 +414,7 @@ export interface MessageEnvelope {
|
|
|
415
414
|
/** Stringify payload. */
|
|
416
415
|
data?: string;
|
|
417
416
|
}
|
|
418
|
-
|
|
417
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
419
418
|
/**
|
|
420
419
|
* ID of a site visitor that has not logged in to the site.
|
|
421
420
|
* @format GUID
|
|
@@ -440,7 +439,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
440
439
|
identityType?: WebhookIdentityType;
|
|
441
440
|
}
|
|
442
441
|
/** @oneof */
|
|
443
|
-
|
|
442
|
+
interface IdentificationDataIdOneOf {
|
|
444
443
|
/**
|
|
445
444
|
* ID of a site visitor that has not logged in to the site.
|
|
446
445
|
* @format GUID
|
|
@@ -462,14 +461,14 @@ export interface IdentificationDataIdOneOf {
|
|
|
462
461
|
*/
|
|
463
462
|
appId?: string;
|
|
464
463
|
}
|
|
465
|
-
|
|
464
|
+
declare enum WebhookIdentityType {
|
|
466
465
|
UNKNOWN = "UNKNOWN",
|
|
467
466
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
468
467
|
MEMBER = "MEMBER",
|
|
469
468
|
WIX_USER = "WIX_USER",
|
|
470
469
|
APP = "APP"
|
|
471
470
|
}
|
|
472
|
-
|
|
471
|
+
interface BaseEventMetadata {
|
|
473
472
|
/**
|
|
474
473
|
* App instance ID.
|
|
475
474
|
* @format GUID
|
|
@@ -483,7 +482,7 @@ export interface BaseEventMetadata {
|
|
|
483
482
|
/** The identification type and identity data. */
|
|
484
483
|
identity?: IdentificationData;
|
|
485
484
|
}
|
|
486
|
-
|
|
485
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
487
486
|
/**
|
|
488
487
|
* Unique event ID.
|
|
489
488
|
* Allows clients to ignore duplicate webhooks.
|
|
@@ -521,136 +520,18 @@ export interface EventMetadata extends BaseEventMetadata {
|
|
|
521
520
|
*/
|
|
522
521
|
entityEventSequence?: string | null;
|
|
523
522
|
}
|
|
524
|
-
|
|
523
|
+
interface LabelCreatedEnvelope {
|
|
525
524
|
entity: ContactLabel;
|
|
526
525
|
metadata: EventMetadata;
|
|
527
526
|
}
|
|
528
|
-
|
|
529
|
-
* Triggered when a label is created.
|
|
530
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
531
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
532
|
-
* @permissionScope Manage Contact Labels
|
|
533
|
-
* @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
|
|
534
|
-
* @permissionScope Manage Events
|
|
535
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
536
|
-
* @permissionScope Manage Challenges
|
|
537
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
538
|
-
* @permissionScope Manage Portfolio
|
|
539
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
540
|
-
* @permissionScope Access Verticals by Automations
|
|
541
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
542
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
543
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
544
|
-
* @permissionScope Set Up Automations
|
|
545
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
546
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
547
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
548
|
-
* @permissionId CONTACTS_LABELS.VIEW
|
|
549
|
-
* @webhook
|
|
550
|
-
* @eventType wix.contacts.v4.label_created
|
|
551
|
-
* @serviceIdentifier com.wixpress.contacts.labels.v4.ContactLabelsServiceV4
|
|
552
|
-
* @slug created
|
|
553
|
-
*/
|
|
554
|
-
export declare function onLabelCreated(handler: (event: LabelCreatedEnvelope) => void | Promise<void>): void;
|
|
555
|
-
export interface LabelDeletedEnvelope {
|
|
527
|
+
interface LabelDeletedEnvelope {
|
|
556
528
|
metadata: EventMetadata;
|
|
557
529
|
}
|
|
558
|
-
|
|
559
|
-
* Triggered when a label is deleted.
|
|
560
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
561
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
562
|
-
* @permissionScope Manage Contact Labels
|
|
563
|
-
* @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
|
|
564
|
-
* @permissionScope Manage Events
|
|
565
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
566
|
-
* @permissionScope Manage Challenges
|
|
567
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
568
|
-
* @permissionScope Manage Portfolio
|
|
569
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
570
|
-
* @permissionScope Access Verticals by Automations
|
|
571
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
572
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
573
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
574
|
-
* @permissionScope Set Up Automations
|
|
575
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
576
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
577
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
578
|
-
* @permissionId CONTACTS_LABELS.VIEW
|
|
579
|
-
* @webhook
|
|
580
|
-
* @eventType wix.contacts.v4.label_deleted
|
|
581
|
-
* @serviceIdentifier com.wixpress.contacts.labels.v4.ContactLabelsServiceV4
|
|
582
|
-
* @slug deleted
|
|
583
|
-
*/
|
|
584
|
-
export declare function onLabelDeleted(handler: (event: LabelDeletedEnvelope) => void | Promise<void>): void;
|
|
585
|
-
export interface LabelUpdatedEnvelope {
|
|
530
|
+
interface LabelUpdatedEnvelope {
|
|
586
531
|
entity: ContactLabel;
|
|
587
532
|
metadata: EventMetadata;
|
|
588
533
|
}
|
|
589
|
-
|
|
590
|
-
* Triggered when a label is updated.
|
|
591
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
592
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
593
|
-
* @permissionScope Manage Contact Labels
|
|
594
|
-
* @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
|
|
595
|
-
* @permissionScope Manage Events
|
|
596
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
597
|
-
* @permissionScope Manage Challenges
|
|
598
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
599
|
-
* @permissionScope Manage Portfolio
|
|
600
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
601
|
-
* @permissionScope Access Verticals by Automations
|
|
602
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
603
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
604
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
605
|
-
* @permissionScope Set Up Automations
|
|
606
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
607
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
608
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
609
|
-
* @permissionId CONTACTS_LABELS.VIEW
|
|
610
|
-
* @webhook
|
|
611
|
-
* @eventType wix.contacts.v4.label_updated
|
|
612
|
-
* @serviceIdentifier com.wixpress.contacts.labels.v4.ContactLabelsServiceV4
|
|
613
|
-
* @slug updated
|
|
614
|
-
*/
|
|
615
|
-
export declare function onLabelUpdated(handler: (event: LabelUpdatedEnvelope) => void | Promise<void>): void;
|
|
616
|
-
type LabelNonNullablePaths = `key` | `displayName` | `labelType`;
|
|
617
|
-
/**
|
|
618
|
-
* Retrieves a label with a specified name, or creates one if it doesn't exist.
|
|
619
|
-
*
|
|
620
|
-
* Successful calls to this method always return a label,
|
|
621
|
-
* which can be specified in subsequent calls.
|
|
622
|
-
*
|
|
623
|
-
* For example, in the Contacts API, Label Contact and Unlabel Contact
|
|
624
|
-
* calls will fail if you include a non-existent label.
|
|
625
|
-
* To ensure successful calls, you can call this method first,
|
|
626
|
-
* and then use the response in the Label Contact and Unlabel Contact calls.
|
|
627
|
-
*
|
|
628
|
-
* To find an existing label without potentially creating a new one, call
|
|
629
|
-
* Get Label or Query Labels.
|
|
630
|
-
* @param displayName - Display name to retrieve or create.
|
|
631
|
-
*
|
|
632
|
-
* If an existing label is an exact match
|
|
633
|
-
* for the specified display name,
|
|
634
|
-
* the existing label is returned.
|
|
635
|
-
* If not, a new label is created and returned.
|
|
636
|
-
* @public
|
|
637
|
-
* @requiredField displayName
|
|
638
|
-
* @param options - Language options.
|
|
639
|
-
* @permissionId CONTACTS_LABELS.MODIFY
|
|
640
|
-
* @permissionScope Manage Contact Labels
|
|
641
|
-
* @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
|
|
642
|
-
* @permissionScope Manage Challenges
|
|
643
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
644
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
645
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
646
|
-
* @applicableIdentity APP
|
|
647
|
-
* @returns Label that was found or created.
|
|
648
|
-
* @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.FindOrCreateLabel
|
|
649
|
-
*/
|
|
650
|
-
export declare function findOrCreateLabel(displayName: string, options?: FindOrCreateLabelOptions): Promise<NonNullablePaths<FindOrCreateLabelResponse, {
|
|
651
|
-
[P in LabelNonNullablePaths]: `label.${P}`;
|
|
652
|
-
}[LabelNonNullablePaths] | `newLabel`>>;
|
|
653
|
-
export interface FindOrCreateLabelOptions {
|
|
534
|
+
interface FindOrCreateLabelOptions {
|
|
654
535
|
/**
|
|
655
536
|
* Language for localization.
|
|
656
537
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
@@ -658,40 +539,7 @@ export interface FindOrCreateLabelOptions {
|
|
|
658
539
|
*/
|
|
659
540
|
language?: string | null;
|
|
660
541
|
}
|
|
661
|
-
|
|
662
|
-
* Retrieves a label by the specified label key.
|
|
663
|
-
* @param key - Label key.
|
|
664
|
-
*
|
|
665
|
-
* `key` is generated when the label is created.
|
|
666
|
-
* It can't be modified, even if `displayName` is updated.
|
|
667
|
-
* @public
|
|
668
|
-
* @requiredField key
|
|
669
|
-
* @param options - Language options.
|
|
670
|
-
* @permissionId CONTACTS_LABELS.VIEW
|
|
671
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
672
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
673
|
-
* @permissionScope Manage Contact Labels
|
|
674
|
-
* @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
|
|
675
|
-
* @permissionScope Manage Events
|
|
676
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
677
|
-
* @permissionScope Manage Challenges
|
|
678
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
679
|
-
* @permissionScope Manage Portfolio
|
|
680
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
681
|
-
* @permissionScope Access Verticals by Automations
|
|
682
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
683
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
684
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
685
|
-
* @permissionScope Set Up Automations
|
|
686
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
687
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
688
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
689
|
-
* @applicableIdentity APP
|
|
690
|
-
* @returns The specified label.
|
|
691
|
-
* @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.GetLabel
|
|
692
|
-
*/
|
|
693
|
-
export declare function getLabel(key: string, options?: GetLabelOptions): Promise<NonNullablePaths<ContactLabel, LabelNonNullablePaths>>;
|
|
694
|
-
export interface GetLabelOptions {
|
|
542
|
+
interface GetLabelOptions {
|
|
695
543
|
/**
|
|
696
544
|
* Language for localization.
|
|
697
545
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
@@ -699,31 +547,7 @@ export interface GetLabelOptions {
|
|
|
699
547
|
*/
|
|
700
548
|
language?: string | null;
|
|
701
549
|
}
|
|
702
|
-
|
|
703
|
-
* Renames a label.
|
|
704
|
-
* @param key - Label key.
|
|
705
|
-
*
|
|
706
|
-
* `key` is generated when the label is created.
|
|
707
|
-
* It can't be modified, even if `displayName` is updated.
|
|
708
|
-
* @public
|
|
709
|
-
* @requiredField key
|
|
710
|
-
* @requiredField label
|
|
711
|
-
* @requiredField label.displayName
|
|
712
|
-
* @param options - Language options.
|
|
713
|
-
* @param label - Label to rename.
|
|
714
|
-
* @permissionId CONTACTS_LABELS.MODIFY
|
|
715
|
-
* @permissionScope Manage Contact Labels
|
|
716
|
-
* @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
|
|
717
|
-
* @permissionScope Manage Challenges
|
|
718
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
719
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
720
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
721
|
-
* @applicableIdentity APP
|
|
722
|
-
* @returns Renamed label.
|
|
723
|
-
* @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.UpdateLabel
|
|
724
|
-
*/
|
|
725
|
-
export declare function renameLabel(key: string, label: NonNullablePaths<RenameLabel, `displayName`>, options?: RenameLabelOptions): Promise<NonNullablePaths<ContactLabel, LabelNonNullablePaths>>;
|
|
726
|
-
export interface RenameLabel {
|
|
550
|
+
interface RenameLabel {
|
|
727
551
|
/**
|
|
728
552
|
* Label namespace.
|
|
729
553
|
*
|
|
@@ -764,7 +588,7 @@ export interface RenameLabel {
|
|
|
764
588
|
*/
|
|
765
589
|
_updatedDate?: Date | null;
|
|
766
590
|
}
|
|
767
|
-
|
|
591
|
+
interface RenameLabelOptions {
|
|
768
592
|
/**
|
|
769
593
|
* Language for localization.
|
|
770
594
|
* 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
|
|
@@ -772,65 +596,7 @@ export interface RenameLabelOptions {
|
|
|
772
596
|
*/
|
|
773
597
|
language?: string | null;
|
|
774
598
|
}
|
|
775
|
-
|
|
776
|
-
* Deletes the specified label from a site and removes it from the contacts it applies to.
|
|
777
|
-
* @param key - Label key to delete.
|
|
778
|
-
* @public
|
|
779
|
-
* @requiredField key
|
|
780
|
-
* @permissionId CONTACTS_LABELS.MODIFY
|
|
781
|
-
* @permissionScope Manage Contact Labels
|
|
782
|
-
* @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
|
|
783
|
-
* @permissionScope Manage Challenges
|
|
784
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
785
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
786
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
787
|
-
* @applicableIdentity APP
|
|
788
|
-
* @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.DeleteLabel
|
|
789
|
-
*/
|
|
790
|
-
export declare function deleteLabel(key: string): Promise<void>;
|
|
791
|
-
/**
|
|
792
|
-
* Creates a query to retrieve a list of labels.
|
|
793
|
-
*
|
|
794
|
-
* The `queryLabels()` method builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` object.
|
|
795
|
-
*
|
|
796
|
-
* The returned object contains the query definition, which is used to call the query using the `find()` method.
|
|
797
|
-
*
|
|
798
|
-
* You can refine the query by chaining `LabelsQueryBuilder` methods onto the query. `LabelsQueryBuilder` methods enable you to filter, sort, and control the response that `queryLabels()` returns.
|
|
799
|
-
*
|
|
800
|
-
* `queryLabels()` is called with the following `LabelsQueryBuilder` defaults, which you can override:
|
|
801
|
-
* - `skip(0)`
|
|
802
|
-
* - `limit(50)`
|
|
803
|
-
* - `descending('_createdDate')`
|
|
804
|
-
*
|
|
805
|
-
* The following `LabelsQueryBuilder` methods are supported for `queryLabels()`. For a full description of the `Labels` object, see the object returned for the `items` field in `LabelsQueryResult`.
|
|
806
|
-
*
|
|
807
|
-
*
|
|
808
|
-
* @public
|
|
809
|
-
* @param options - Language options.
|
|
810
|
-
* @permissionScope Manage Bookings Services and Settings
|
|
811
|
-
* @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
|
|
812
|
-
* @permissionScope Manage Contact Labels
|
|
813
|
-
* @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
|
|
814
|
-
* @permissionScope Manage Events
|
|
815
|
-
* @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
|
|
816
|
-
* @permissionScope Manage Challenges
|
|
817
|
-
* @permissionScopeId SCOPE.CHALLENGES.MANAGE
|
|
818
|
-
* @permissionScope Manage Portfolio
|
|
819
|
-
* @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
|
|
820
|
-
* @permissionScope Access Verticals by Automations
|
|
821
|
-
* @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
|
|
822
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
823
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
824
|
-
* @permissionScope Set Up Automations
|
|
825
|
-
* @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
|
|
826
|
-
* @permissionScope Manage Members and Contacts - all permissions
|
|
827
|
-
* @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
|
|
828
|
-
* @permissionId CONTACTS_LABELS.VIEW
|
|
829
|
-
* @applicableIdentity APP
|
|
830
|
-
* @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.QueryLabels
|
|
831
|
-
*/
|
|
832
|
-
export declare function queryLabels(options?: QueryLabelsOptions): LabelsQueryBuilder;
|
|
833
|
-
export interface QueryLabelsOptions {
|
|
599
|
+
interface QueryLabelsOptions {
|
|
834
600
|
/**
|
|
835
601
|
* Language for localization.
|
|
836
602
|
*
|
|
@@ -849,13 +615,13 @@ interface QueryOffsetResult {
|
|
|
849
615
|
length: number;
|
|
850
616
|
pageSize: number;
|
|
851
617
|
}
|
|
852
|
-
|
|
618
|
+
interface LabelsQueryResult extends QueryOffsetResult {
|
|
853
619
|
items: ContactLabel[];
|
|
854
620
|
query: LabelsQueryBuilder;
|
|
855
621
|
next: () => Promise<LabelsQueryResult>;
|
|
856
622
|
prev: () => Promise<LabelsQueryResult>;
|
|
857
623
|
}
|
|
858
|
-
|
|
624
|
+
interface LabelsQueryBuilder {
|
|
859
625
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
860
626
|
* @param value - Value to compare against.
|
|
861
627
|
*/
|
|
@@ -895,4 +661,5 @@ export interface LabelsQueryBuilder {
|
|
|
895
661
|
skip: (skip: number) => LabelsQueryBuilder;
|
|
896
662
|
find: () => Promise<LabelsQueryResult>;
|
|
897
663
|
}
|
|
898
|
-
|
|
664
|
+
|
|
665
|
+
export { type DomainEventBodyOneOf as A, type RestoreInfo as B, type ContactLabel as C, type DeleteLabelRequest as D, type EntityCreatedEvent as E, type FindOrCreateLabelOptions as F, type GetLabelOptions as G, type EntityUpdatedEvent as H, type EntityDeletedEvent as I, type ActionEvent as J, type IdentificationData as K, type LabelsQueryBuilder as L, type MessageEnvelope as M, type IdentificationDataIdOneOf as N, type BaseEventMetadata as O, type Paging as P, type QueryLabelsOptions as Q, type RenameLabel as R, SortOrder as S, type EventMetadata as T, type UpdateLabelRequest as U, type LabelCreatedEnvelope as V, WebhookIdentityType as W, type LabelDeletedEnvelope as X, type LabelUpdatedEnvelope as Y, type LabelsQueryResult as Z, type FindOrCreateLabelResponse as a, type RenameLabelOptions as b, LabelType as c, type ListLabelsRequest as d, type Sorting as e, type ListLabelsResponse as f, type PagingMetadata as g, type FindOrCreateLabelRequest as h, type LabelsQuotaReached as i, type ListLabelNamespacesRequest as j, type ListLabelNamespacesResponse as k, type ContactLabelNamespace as l, type GetLabelRequest as m, type GetLabelResponse as n, type GetLabelByLegacyIdRequest as o, type GetLabelByLegacyIdResponse as p, type UpdateLabelResponse as q, type DeleteLabelResponse as r, type PurgeRequest as s, type PurgeResponse as t, type GdprListRequest as u, type GdprListResponse as v, type QueryLabelsRequest as w, type Query as x, type QueryLabelsResponse as y, type DomainEvent as z };
|