@wix/auto_sdk_crm_labels 1.0.15 → 1.0.17

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.
Files changed (130) hide show
  1. package/build/{internal/cjs/src/contacts-v4-label-labels.universal.d.ts → contacts-v4-label-labels.universal-BD_OhruE.d.mts} +57 -306
  2. package/build/{cjs/src/contacts-v4-label-labels.universal.d.ts → contacts-v4-label-labels.universal-BD_OhruE.d.ts} +57 -306
  3. package/build/{internal/es/src/contacts-v4-label-labels.public.d.ts → index.d.mts} +32 -14
  4. package/build/{cjs/src/contacts-v4-label-labels.public.d.ts → index.d.ts} +32 -14
  5. package/build/index.js +517 -0
  6. package/build/index.js.map +1 -0
  7. package/build/index.mjs +483 -0
  8. package/build/index.mjs.map +1 -0
  9. package/build/{es/src/contacts-v4-label-labels.universal.d.ts → internal/contacts-v4-label-labels.universal-BD_OhruE.d.mts} +57 -306
  10. package/build/internal/{es/src/contacts-v4-label-labels.universal.d.ts → contacts-v4-label-labels.universal-BD_OhruE.d.ts} +57 -306
  11. package/build/{es/src/contacts-v4-label-labels.public.d.ts → internal/index.d.mts} +32 -14
  12. package/build/internal/{cjs/src/contacts-v4-label-labels.public.d.ts → index.d.ts} +32 -14
  13. package/build/internal/index.js +517 -0
  14. package/build/internal/index.js.map +1 -0
  15. package/build/internal/index.mjs +483 -0
  16. package/build/internal/index.mjs.map +1 -0
  17. package/build/internal/meta.d.mts +253 -0
  18. package/build/internal/meta.d.ts +253 -0
  19. package/build/internal/meta.js +311 -0
  20. package/build/internal/meta.js.map +1 -0
  21. package/build/internal/meta.mjs +280 -0
  22. package/build/internal/meta.mjs.map +1 -0
  23. package/build/meta.d.mts +253 -0
  24. package/build/meta.d.ts +253 -0
  25. package/build/meta.js +311 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +280 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/contacts-v4-label-labels.context.d.ts +0 -25
  40. package/build/cjs/src/contacts-v4-label-labels.context.js +0 -31
  41. package/build/cjs/src/contacts-v4-label-labels.context.js.map +0 -1
  42. package/build/cjs/src/contacts-v4-label-labels.http.d.ts +0 -41
  43. package/build/cjs/src/contacts-v4-label-labels.http.js +0 -223
  44. package/build/cjs/src/contacts-v4-label-labels.http.js.map +0 -1
  45. package/build/cjs/src/contacts-v4-label-labels.meta.d.ts +0 -23
  46. package/build/cjs/src/contacts-v4-label-labels.meta.js +0 -123
  47. package/build/cjs/src/contacts-v4-label-labels.meta.js.map +0 -1
  48. package/build/cjs/src/contacts-v4-label-labels.public.js +0 -74
  49. package/build/cjs/src/contacts-v4-label-labels.public.js.map +0 -1
  50. package/build/cjs/src/contacts-v4-label-labels.types.d.ts +0 -470
  51. package/build/cjs/src/contacts-v4-label-labels.types.js +0 -28
  52. package/build/cjs/src/contacts-v4-label-labels.types.js.map +0 -1
  53. package/build/cjs/src/contacts-v4-label-labels.universal.js +0 -360
  54. package/build/cjs/src/contacts-v4-label-labels.universal.js.map +0 -1
  55. package/build/es/index.d.ts +0 -1
  56. package/build/es/index.js +0 -2
  57. package/build/es/index.js.map +0 -1
  58. package/build/es/index.typings.d.ts +0 -1
  59. package/build/es/index.typings.js +0 -2
  60. package/build/es/index.typings.js.map +0 -1
  61. package/build/es/meta.d.ts +0 -1
  62. package/build/es/meta.js +0 -2
  63. package/build/es/meta.js.map +0 -1
  64. package/build/es/package.json +0 -3
  65. package/build/es/src/contacts-v4-label-labels.context.d.ts +0 -25
  66. package/build/es/src/contacts-v4-label-labels.context.js +0 -25
  67. package/build/es/src/contacts-v4-label-labels.context.js.map +0 -1
  68. package/build/es/src/contacts-v4-label-labels.http.d.ts +0 -41
  69. package/build/es/src/contacts-v4-label-labels.http.js +0 -215
  70. package/build/es/src/contacts-v4-label-labels.http.js.map +0 -1
  71. package/build/es/src/contacts-v4-label-labels.meta.d.ts +0 -23
  72. package/build/es/src/contacts-v4-label-labels.meta.js +0 -92
  73. package/build/es/src/contacts-v4-label-labels.meta.js.map +0 -1
  74. package/build/es/src/contacts-v4-label-labels.public.js +0 -63
  75. package/build/es/src/contacts-v4-label-labels.public.js.map +0 -1
  76. package/build/es/src/contacts-v4-label-labels.types.d.ts +0 -470
  77. package/build/es/src/contacts-v4-label-labels.types.js +0 -25
  78. package/build/es/src/contacts-v4-label-labels.types.js.map +0 -1
  79. package/build/es/src/contacts-v4-label-labels.universal.js +0 -329
  80. package/build/es/src/contacts-v4-label-labels.universal.js.map +0 -1
  81. package/build/internal/cjs/index.d.ts +0 -1
  82. package/build/internal/cjs/index.js +0 -18
  83. package/build/internal/cjs/index.js.map +0 -1
  84. package/build/internal/cjs/index.typings.d.ts +0 -1
  85. package/build/internal/cjs/index.typings.js +0 -18
  86. package/build/internal/cjs/index.typings.js.map +0 -1
  87. package/build/internal/cjs/meta.d.ts +0 -1
  88. package/build/internal/cjs/meta.js +0 -18
  89. package/build/internal/cjs/meta.js.map +0 -1
  90. package/build/internal/cjs/src/contacts-v4-label-labels.context.d.ts +0 -25
  91. package/build/internal/cjs/src/contacts-v4-label-labels.context.js +0 -31
  92. package/build/internal/cjs/src/contacts-v4-label-labels.context.js.map +0 -1
  93. package/build/internal/cjs/src/contacts-v4-label-labels.http.d.ts +0 -41
  94. package/build/internal/cjs/src/contacts-v4-label-labels.http.js +0 -223
  95. package/build/internal/cjs/src/contacts-v4-label-labels.http.js.map +0 -1
  96. package/build/internal/cjs/src/contacts-v4-label-labels.meta.d.ts +0 -23
  97. package/build/internal/cjs/src/contacts-v4-label-labels.meta.js +0 -123
  98. package/build/internal/cjs/src/contacts-v4-label-labels.meta.js.map +0 -1
  99. package/build/internal/cjs/src/contacts-v4-label-labels.public.js +0 -74
  100. package/build/internal/cjs/src/contacts-v4-label-labels.public.js.map +0 -1
  101. package/build/internal/cjs/src/contacts-v4-label-labels.types.d.ts +0 -470
  102. package/build/internal/cjs/src/contacts-v4-label-labels.types.js +0 -28
  103. package/build/internal/cjs/src/contacts-v4-label-labels.types.js.map +0 -1
  104. package/build/internal/cjs/src/contacts-v4-label-labels.universal.js +0 -360
  105. package/build/internal/cjs/src/contacts-v4-label-labels.universal.js.map +0 -1
  106. package/build/internal/es/index.d.ts +0 -1
  107. package/build/internal/es/index.js +0 -2
  108. package/build/internal/es/index.js.map +0 -1
  109. package/build/internal/es/index.typings.d.ts +0 -1
  110. package/build/internal/es/index.typings.js +0 -2
  111. package/build/internal/es/index.typings.js.map +0 -1
  112. package/build/internal/es/meta.d.ts +0 -1
  113. package/build/internal/es/meta.js +0 -2
  114. package/build/internal/es/meta.js.map +0 -1
  115. package/build/internal/es/src/contacts-v4-label-labels.context.d.ts +0 -25
  116. package/build/internal/es/src/contacts-v4-label-labels.context.js +0 -25
  117. package/build/internal/es/src/contacts-v4-label-labels.context.js.map +0 -1
  118. package/build/internal/es/src/contacts-v4-label-labels.http.d.ts +0 -41
  119. package/build/internal/es/src/contacts-v4-label-labels.http.js +0 -215
  120. package/build/internal/es/src/contacts-v4-label-labels.http.js.map +0 -1
  121. package/build/internal/es/src/contacts-v4-label-labels.meta.d.ts +0 -23
  122. package/build/internal/es/src/contacts-v4-label-labels.meta.js +0 -92
  123. package/build/internal/es/src/contacts-v4-label-labels.meta.js.map +0 -1
  124. package/build/internal/es/src/contacts-v4-label-labels.public.js +0 -63
  125. package/build/internal/es/src/contacts-v4-label-labels.public.js.map +0 -1
  126. package/build/internal/es/src/contacts-v4-label-labels.types.d.ts +0 -470
  127. package/build/internal/es/src/contacts-v4-label-labels.types.js +0 -25
  128. package/build/internal/es/src/contacts-v4-label-labels.types.js.map +0 -1
  129. package/build/internal/es/src/contacts-v4-label-labels.universal.js +0 -329
  130. 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
- export interface ContactLabel {
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
- export declare enum LabelType {
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,9 +59,9 @@ export declare enum LabelType {
60
59
  WIX_APP_DEFINED = "WIX_APP_DEFINED"
61
60
  }
62
61
  /** @enumType */
63
- export type LabelTypeWithLiterals = LabelType | 'SYSTEM' | 'USER_DEFINED' | 'WIX_APP_DEFINED';
62
+ type LabelTypeWithLiterals = LabelType | 'SYSTEM' | 'USER_DEFINED' | 'WIX_APP_DEFINED';
64
63
  /** Label filter options. */
65
- export interface ListLabelsRequest {
64
+ interface ListLabelsRequest {
66
65
  /** Filter for labels of the specified type. */
67
66
  labelType?: LabelTypeWithLiterals;
68
67
  /**
@@ -84,7 +83,7 @@ export interface ListLabelsRequest {
84
83
  /** @format LANGUAGE */
85
84
  language?: string | null;
86
85
  }
87
- export interface Sorting {
86
+ interface Sorting {
88
87
  /**
89
88
  * Name of the field to sort by.
90
89
  * @maxLength 3000
@@ -97,15 +96,15 @@ export interface Sorting {
97
96
  */
98
97
  order?: SortOrderWithLiterals;
99
98
  }
100
- export declare enum SortOrder {
99
+ declare enum SortOrder {
101
100
  /** Sort by ascending order. */
102
101
  ASC = "ASC",
103
102
  /** Sort by descending order. */
104
103
  DESC = "DESC"
105
104
  }
106
105
  /** @enumType */
107
- export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
108
- export interface Paging {
106
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
107
+ interface Paging {
109
108
  /**
110
109
  * Number of items to return.
111
110
  *
@@ -117,13 +116,13 @@ export interface Paging {
117
116
  offset?: number | null;
118
117
  }
119
118
  /** List of labels. */
120
- export interface ListLabelsResponse {
119
+ interface ListLabelsResponse {
121
120
  /** List of labels. */
122
121
  labels?: ContactLabel[];
123
122
  /** Metadata for the page of results. */
124
123
  metadata?: PagingMetadata;
125
124
  }
126
- export interface PagingMetadata {
125
+ interface PagingMetadata {
127
126
  /** Number of items returned. */
128
127
  count?: number | null;
129
128
  /** Requested offset. */
@@ -137,7 +136,7 @@ export interface PagingMetadata {
137
136
  tooManyToCount?: boolean | null;
138
137
  }
139
138
  /** Label to find or create. */
140
- export interface FindOrCreateLabelRequest {
139
+ interface FindOrCreateLabelRequest {
141
140
  /**
142
141
  * Display name to retrieve or create.
143
142
  *
@@ -157,7 +156,7 @@ export interface FindOrCreateLabelRequest {
157
156
  language?: string | null;
158
157
  }
159
158
  /** Label that was found or created. */
160
- export interface FindOrCreateLabelResponse {
159
+ interface FindOrCreateLabelResponse {
161
160
  /** Label that was found or created. */
162
161
  label?: ContactLabel;
163
162
  /**
@@ -167,24 +166,24 @@ export interface FindOrCreateLabelResponse {
167
166
  */
168
167
  newLabel?: boolean;
169
168
  }
170
- export interface LabelsQuotaReached {
169
+ interface LabelsQuotaReached {
171
170
  /** The maximum number of labels allowed for the site. */
172
171
  labelsQuota?: string | null;
173
172
  /** The current total number of labels on the site. */
174
173
  labelsCurrentTotal?: string | null;
175
174
  }
176
- export interface ListLabelNamespacesRequest {
175
+ interface ListLabelNamespacesRequest {
177
176
  /**
178
177
  * Language for localization
179
178
  * @format LANGUAGE
180
179
  */
181
180
  language?: string | null;
182
181
  }
183
- export interface ListLabelNamespacesResponse {
182
+ interface ListLabelNamespacesResponse {
184
183
  /** List of namespaces */
185
184
  namespaces?: ContactLabelNamespace[];
186
185
  }
187
- export interface ContactLabelNamespace {
186
+ interface ContactLabelNamespace {
188
187
  /**
189
188
  * Namespace key
190
189
  * @readonly
@@ -200,7 +199,7 @@ export interface ContactLabelNamespace {
200
199
  */
201
200
  displayName?: string | null;
202
201
  }
203
- export interface GetLabelRequest {
202
+ interface GetLabelRequest {
204
203
  /**
205
204
  * Label key.
206
205
  *
@@ -218,11 +217,11 @@ export interface GetLabelRequest {
218
217
  language?: string | null;
219
218
  }
220
219
  /** The specified label. */
221
- export interface GetLabelResponse {
220
+ interface GetLabelResponse {
222
221
  /** The specified label. */
223
222
  label?: ContactLabel;
224
223
  }
225
- export interface GetLabelByLegacyIdRequest {
224
+ interface GetLabelByLegacyIdRequest {
226
225
  /**
227
226
  * Legacy id of the label
228
227
  * @format GUID
@@ -234,11 +233,11 @@ export interface GetLabelByLegacyIdRequest {
234
233
  */
235
234
  language?: string | null;
236
235
  }
237
- export interface GetLabelByLegacyIdResponse {
236
+ interface GetLabelByLegacyIdResponse {
238
237
  /** Requested label */
239
238
  label?: ContactLabel;
240
239
  }
241
- export interface UpdateLabelRequest {
240
+ interface UpdateLabelRequest {
242
241
  /** Label to rename. */
243
242
  label?: ContactLabel;
244
243
  /**
@@ -249,11 +248,11 @@ export interface UpdateLabelRequest {
249
248
  language?: string | null;
250
249
  }
251
250
  /** Updated label. */
252
- export interface UpdateLabelResponse {
251
+ interface UpdateLabelResponse {
253
252
  /** Renamed label. */
254
253
  label?: ContactLabel;
255
254
  }
256
- export interface DeleteLabelRequest {
255
+ interface DeleteLabelRequest {
257
256
  /**
258
257
  * Label key to delete.
259
258
  * @minLength 1
@@ -261,9 +260,9 @@ export interface DeleteLabelRequest {
261
260
  */
262
261
  key: string;
263
262
  }
264
- export interface DeleteLabelResponse {
263
+ interface DeleteLabelResponse {
265
264
  }
266
- export interface PurgeRequest {
265
+ interface PurgeRequest {
267
266
  /**
268
267
  * Contacts Instance ID of the site.
269
268
  * @format GUID
@@ -276,22 +275,22 @@ export interface PurgeRequest {
276
275
  */
277
276
  exludingLabelKeys?: string[];
278
277
  }
279
- export interface PurgeResponse {
278
+ interface PurgeResponse {
280
279
  /** Number of deleted items */
281
280
  deletedItems?: number;
282
281
  }
283
- export interface GdprListRequest {
282
+ interface GdprListRequest {
284
283
  /**
285
284
  * Contacts Instance ID of the site.
286
285
  * @format GUID
287
286
  */
288
287
  instanceId?: string;
289
288
  }
290
- export interface GdprListResponse {
289
+ interface GdprListResponse {
291
290
  /** List of labels */
292
291
  labels?: ContactLabel[];
293
292
  }
294
- export interface QueryLabelsRequest {
293
+ interface QueryLabelsRequest {
295
294
  /** Query options. */
296
295
  query?: Query;
297
296
  /**
@@ -301,7 +300,7 @@ export interface QueryLabelsRequest {
301
300
  */
302
301
  language?: string | null;
303
302
  }
304
- export interface Query {
303
+ interface Query {
305
304
  /**
306
305
  * ilter object.
307
306
  *
@@ -327,13 +326,13 @@ export interface Query {
327
326
  /** Pagination options. */
328
327
  paging?: Paging;
329
328
  }
330
- export interface QueryLabelsResponse {
329
+ interface QueryLabelsResponse {
331
330
  /** List of labels */
332
331
  labels?: ContactLabel[];
333
332
  /** Details on the paged set of results returned. */
334
333
  pagingMetadata?: PagingMetadata;
335
334
  }
336
- export interface DomainEvent extends DomainEventBodyOneOf {
335
+ interface DomainEvent extends DomainEventBodyOneOf {
337
336
  createdEvent?: EntityCreatedEvent;
338
337
  updatedEvent?: EntityUpdatedEvent;
339
338
  deletedEvent?: EntityDeletedEvent;
@@ -368,19 +367,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
368
367
  entityEventSequence?: string | null;
369
368
  }
370
369
  /** @oneof */
371
- export interface DomainEventBodyOneOf {
370
+ interface DomainEventBodyOneOf {
372
371
  createdEvent?: EntityCreatedEvent;
373
372
  updatedEvent?: EntityUpdatedEvent;
374
373
  deletedEvent?: EntityDeletedEvent;
375
374
  actionEvent?: ActionEvent;
376
375
  }
377
- export interface EntityCreatedEvent {
376
+ interface EntityCreatedEvent {
378
377
  entity?: string;
379
378
  }
380
- export interface RestoreInfo {
379
+ interface RestoreInfo {
381
380
  deletedDate?: Date | null;
382
381
  }
383
- export interface EntityUpdatedEvent {
382
+ interface EntityUpdatedEvent {
384
383
  /**
385
384
  * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
386
385
  * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
@@ -388,14 +387,14 @@ export interface EntityUpdatedEvent {
388
387
  */
389
388
  currentEntity?: string;
390
389
  }
391
- export interface EntityDeletedEvent {
390
+ interface EntityDeletedEvent {
392
391
  /** Entity that was deleted. */
393
392
  deletedEntity?: string | null;
394
393
  }
395
- export interface ActionEvent {
394
+ interface ActionEvent {
396
395
  body?: string;
397
396
  }
398
- export interface MessageEnvelope {
397
+ interface MessageEnvelope {
399
398
  /**
400
399
  * App instance ID.
401
400
  * @format GUID
@@ -411,7 +410,7 @@ export interface MessageEnvelope {
411
410
  /** Stringify payload. */
412
411
  data?: string;
413
412
  }
414
- export interface IdentificationData extends IdentificationDataIdOneOf {
413
+ interface IdentificationData extends IdentificationDataIdOneOf {
415
414
  /**
416
415
  * ID of a site visitor that has not logged in to the site.
417
416
  * @format GUID
@@ -436,7 +435,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
436
435
  identityType?: WebhookIdentityTypeWithLiterals;
437
436
  }
438
437
  /** @oneof */
439
- export interface IdentificationDataIdOneOf {
438
+ interface IdentificationDataIdOneOf {
440
439
  /**
441
440
  * ID of a site visitor that has not logged in to the site.
442
441
  * @format GUID
@@ -458,7 +457,7 @@ export interface IdentificationDataIdOneOf {
458
457
  */
459
458
  appId?: string;
460
459
  }
461
- export declare enum WebhookIdentityType {
460
+ declare enum WebhookIdentityType {
462
461
  UNKNOWN = "UNKNOWN",
463
462
  ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
464
463
  MEMBER = "MEMBER",
@@ -466,8 +465,8 @@ export declare enum WebhookIdentityType {
466
465
  APP = "APP"
467
466
  }
468
467
  /** @enumType */
469
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
470
- export interface BaseEventMetadata {
468
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
469
+ interface BaseEventMetadata {
471
470
  /**
472
471
  * App instance ID.
473
472
  * @format GUID
@@ -481,7 +480,7 @@ export interface BaseEventMetadata {
481
480
  /** The identification type and identity data. */
482
481
  identity?: IdentificationData;
483
482
  }
484
- export interface EventMetadata extends BaseEventMetadata {
483
+ interface EventMetadata extends BaseEventMetadata {
485
484
  /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
486
485
  _id?: string;
487
486
  /**
@@ -511,144 +510,18 @@ export interface EventMetadata extends BaseEventMetadata {
511
510
  */
512
511
  entityEventSequence?: string | null;
513
512
  }
514
- export interface LabelCreatedEnvelope {
513
+ interface LabelCreatedEnvelope {
515
514
  entity: ContactLabel;
516
515
  metadata: EventMetadata;
517
516
  }
518
- /**
519
- * Triggered when a label is created.
520
- * @permissionScope Manage Stores
521
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
522
- * @permissionScope Manage Bookings Services and Settings
523
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
524
- * @permissionScope Manage Contact Labels
525
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
526
- * @permissionScope Manage Events
527
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
528
- * @permissionScope Manage Challenges
529
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
530
- * @permissionScope Manage Portfolio
531
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
532
- * @permissionScope Access Verticals by Automations
533
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
534
- * @permissionScope Manage Restaurants - all permissions
535
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
536
- * @permissionScope Set Up Automations
537
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
538
- * @permissionScope Manage Members and Contacts - all permissions
539
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
540
- * @permissionId CONTACTS_LABELS.VIEW
541
- * @webhook
542
- * @eventType wix.contacts.v4.label_created
543
- * @serviceIdentifier com.wixpress.contacts.labels.v4.ContactLabelsServiceV4
544
- * @slug created
545
- */
546
- export declare function onLabelCreated(handler: (event: LabelCreatedEnvelope) => void | Promise<void>): void;
547
- export interface LabelDeletedEnvelope {
517
+ interface LabelDeletedEnvelope {
548
518
  metadata: EventMetadata;
549
519
  }
550
- /**
551
- * Triggered when a label is deleted.
552
- * @permissionScope Manage Stores
553
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
554
- * @permissionScope Manage Bookings Services and Settings
555
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
556
- * @permissionScope Manage Contact Labels
557
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
558
- * @permissionScope Manage Events
559
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
560
- * @permissionScope Manage Challenges
561
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
562
- * @permissionScope Manage Portfolio
563
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
564
- * @permissionScope Access Verticals by Automations
565
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
566
- * @permissionScope Manage Restaurants - all permissions
567
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
568
- * @permissionScope Set Up Automations
569
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
570
- * @permissionScope Manage Members and Contacts - all permissions
571
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
572
- * @permissionId CONTACTS_LABELS.VIEW
573
- * @webhook
574
- * @eventType wix.contacts.v4.label_deleted
575
- * @serviceIdentifier com.wixpress.contacts.labels.v4.ContactLabelsServiceV4
576
- * @slug deleted
577
- */
578
- export declare function onLabelDeleted(handler: (event: LabelDeletedEnvelope) => void | Promise<void>): void;
579
- export interface LabelUpdatedEnvelope {
520
+ interface LabelUpdatedEnvelope {
580
521
  entity: ContactLabel;
581
522
  metadata: EventMetadata;
582
523
  }
583
- /**
584
- * Triggered when a label is updated.
585
- * @permissionScope Manage Stores
586
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
587
- * @permissionScope Manage Bookings Services and Settings
588
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
589
- * @permissionScope Manage Contact Labels
590
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
591
- * @permissionScope Manage Events
592
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
593
- * @permissionScope Manage Challenges
594
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
595
- * @permissionScope Manage Portfolio
596
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
597
- * @permissionScope Access Verticals by Automations
598
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
599
- * @permissionScope Manage Restaurants - all permissions
600
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
601
- * @permissionScope Set Up Automations
602
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
603
- * @permissionScope Manage Members and Contacts - all permissions
604
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
605
- * @permissionId CONTACTS_LABELS.VIEW
606
- * @webhook
607
- * @eventType wix.contacts.v4.label_updated
608
- * @serviceIdentifier com.wixpress.contacts.labels.v4.ContactLabelsServiceV4
609
- * @slug updated
610
- */
611
- export declare function onLabelUpdated(handler: (event: LabelUpdatedEnvelope) => void | Promise<void>): void;
612
- type LabelNonNullablePaths = `key` | `displayName` | `labelType`;
613
- /**
614
- * Retrieves a label with a specified name, or creates one if it doesn't exist.
615
- *
616
- * Successful calls to this method always return a label,
617
- * which can be specified in subsequent calls.
618
- *
619
- * For example, in the Contacts API, Label Contact and Unlabel Contact
620
- * calls will fail if you include a non-existent label.
621
- * To ensure successful calls, you can call this method first,
622
- * and then use the response in the Label Contact and Unlabel Contact calls.
623
- *
624
- * To find an existing label without potentially creating a new one, call
625
- * Get Label or Query Labels.
626
- * @param displayName - Display name to retrieve or create.
627
- *
628
- * If an existing label is an exact match
629
- * for the specified display name,
630
- * the existing label is returned.
631
- * If not, a new label is created and returned.
632
- * @public
633
- * @requiredField displayName
634
- * @param options - Language options.
635
- * @permissionId CONTACTS_LABELS.MODIFY
636
- * @permissionScope Manage Stores
637
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
638
- * @permissionScope Manage Contact Labels
639
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
640
- * @permissionScope Manage Challenges
641
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
642
- * @permissionScope Manage Members and Contacts - all permissions
643
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
644
- * @applicableIdentity APP
645
- * @returns Label that was found or created.
646
- * @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.FindOrCreateLabel
647
- */
648
- export declare function findOrCreateLabel(displayName: string, options?: FindOrCreateLabelOptions): Promise<NonNullablePaths<FindOrCreateLabelResponse, {
649
- [P in LabelNonNullablePaths]: `label.${P}`;
650
- }[LabelNonNullablePaths] | `newLabel`>>;
651
- export interface FindOrCreateLabelOptions {
524
+ interface FindOrCreateLabelOptions {
652
525
  /**
653
526
  * Language for localization.
654
527
  * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
@@ -656,42 +529,7 @@ export interface FindOrCreateLabelOptions {
656
529
  */
657
530
  language?: string | null;
658
531
  }
659
- /**
660
- * Retrieves a label by the specified label key.
661
- * @param key - Label key.
662
- *
663
- * `key` is generated when the label is created.
664
- * It can't be modified, even if `displayName` is updated.
665
- * @public
666
- * @requiredField key
667
- * @param options - Language options.
668
- * @permissionId CONTACTS_LABELS.VIEW
669
- * @permissionScope Manage Stores
670
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
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 {
532
+ interface GetLabelOptions {
695
533
  /**
696
534
  * Language for localization.
697
535
  * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
@@ -699,33 +537,7 @@ export interface GetLabelOptions {
699
537
  */
700
538
  language?: string | null;
701
539
  }
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 Stores
716
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
717
- * @permissionScope Manage Contact Labels
718
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
719
- * @permissionScope Manage Challenges
720
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
721
- * @permissionScope Manage Members and Contacts - all permissions
722
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
723
- * @applicableIdentity APP
724
- * @returns Renamed label.
725
- * @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.UpdateLabel
726
- */
727
- export declare function renameLabel(key: string, label: NonNullablePaths<RenameLabel, `displayName`>, options?: RenameLabelOptions): Promise<NonNullablePaths<ContactLabel, LabelNonNullablePaths>>;
728
- export interface RenameLabel {
540
+ interface RenameLabel {
729
541
  /**
730
542
  * Label namespace.
731
543
  *
@@ -766,7 +578,7 @@ export interface RenameLabel {
766
578
  */
767
579
  _updatedDate?: Date | null;
768
580
  }
769
- export interface RenameLabelOptions {
581
+ interface RenameLabelOptions {
770
582
  /**
771
583
  * Language for localization.
772
584
  * 2-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format.
@@ -774,69 +586,7 @@ export interface RenameLabelOptions {
774
586
  */
775
587
  language?: string | null;
776
588
  }
777
- /**
778
- * Deletes the specified label from a site and removes it from the contacts it applies to.
779
- * @param key - Label key to delete.
780
- * @public
781
- * @requiredField key
782
- * @permissionId CONTACTS_LABELS.MODIFY
783
- * @permissionScope Manage Stores
784
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
785
- * @permissionScope Manage Contact Labels
786
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
787
- * @permissionScope Manage Challenges
788
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
789
- * @permissionScope Manage Members and Contacts - all permissions
790
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
791
- * @applicableIdentity APP
792
- * @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.DeleteLabel
793
- */
794
- export declare function deleteLabel(key: string): Promise<void>;
795
- /**
796
- * Creates a query to retrieve a list of labels.
797
- *
798
- * The `queryLabels()` method builds a query to retrieve a list of labels and returns a `LabelsQueryBuilder` object.
799
- *
800
- * The returned object contains the query definition, which is used to call the query using the `find()` method.
801
- *
802
- * 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.
803
- *
804
- * `queryLabels()` is called with the following `LabelsQueryBuilder` defaults, which you can override:
805
- * - `skip(0)`
806
- * - `limit(50)`
807
- * - `descending('_createdDate')`
808
- *
809
- * 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`.
810
- *
811
- *
812
- * @public
813
- * @param options - Language options.
814
- * @permissionScope Manage Stores
815
- * @permissionScopeId SCOPE.STORES.MANAGE-STORES
816
- * @permissionScope Manage Bookings Services and Settings
817
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
818
- * @permissionScope Manage Contact Labels
819
- * @permissionScopeId SCOPE.DC-CONTACTS.MANAGE-LABELS
820
- * @permissionScope Manage Events
821
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
822
- * @permissionScope Manage Challenges
823
- * @permissionScopeId SCOPE.CHALLENGES.MANAGE
824
- * @permissionScope Manage Portfolio
825
- * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO
826
- * @permissionScope Access Verticals by Automations
827
- * @permissionScopeId SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS
828
- * @permissionScope Manage Restaurants - all permissions
829
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
830
- * @permissionScope Set Up Automations
831
- * @permissionScopeId SCOPE.CRM.SETUP-AUTOMATIONS
832
- * @permissionScope Manage Members and Contacts - all permissions
833
- * @permissionScopeId SCOPE.DC-CONTACTS-MEGA.MANAGE-MEMBERS-CONTACTS
834
- * @permissionId CONTACTS_LABELS.VIEW
835
- * @applicableIdentity APP
836
- * @fqn com.wixpress.contacts.labels.v4.ContactLabelsServiceV4.QueryLabels
837
- */
838
- export declare function queryLabels(options?: QueryLabelsOptions): LabelsQueryBuilder;
839
- export interface QueryLabelsOptions {
589
+ interface QueryLabelsOptions {
840
590
  /**
841
591
  * Language for localization.
842
592
  *
@@ -855,13 +605,13 @@ interface QueryOffsetResult {
855
605
  length: number;
856
606
  pageSize: number;
857
607
  }
858
- export interface LabelsQueryResult extends QueryOffsetResult {
608
+ interface LabelsQueryResult extends QueryOffsetResult {
859
609
  items: ContactLabel[];
860
610
  query: LabelsQueryBuilder;
861
611
  next: () => Promise<LabelsQueryResult>;
862
612
  prev: () => Promise<LabelsQueryResult>;
863
613
  }
864
- export interface LabelsQueryBuilder {
614
+ interface LabelsQueryBuilder {
865
615
  /** @param propertyName - Property whose value is compared with `value`.
866
616
  * @param value - Value to compare against.
867
617
  */
@@ -901,4 +651,5 @@ export interface LabelsQueryBuilder {
901
651
  skip: (skip: number) => LabelsQueryBuilder;
902
652
  find: () => Promise<LabelsQueryResult>;
903
653
  }
904
- export {};
654
+
655
+ export { type Query as A, type QueryLabelsResponse as B, type ContactLabel as C, type DeleteLabelRequest as D, type DomainEvent as E, type FindOrCreateLabelOptions as F, type GetLabelOptions as G, type DomainEventBodyOneOf as H, type EntityCreatedEvent as I, type RestoreInfo as J, type EntityUpdatedEvent as K, type LabelsQueryBuilder as L, type EntityDeletedEvent as M, type ActionEvent as N, type MessageEnvelope as O, type Paging as P, type QueryLabelsOptions as Q, type RenameLabel as R, SortOrder as S, type IdentificationData as T, type UpdateLabelRequest as U, type IdentificationDataIdOneOf as V, WebhookIdentityType as W, type BaseEventMetadata as X, type EventMetadata as Y, type LabelsQueryResult as Z, type FindOrCreateLabelResponse as a, type RenameLabelOptions as b, type LabelCreatedEnvelope as c, type LabelDeletedEnvelope as d, type LabelUpdatedEnvelope as e, LabelType as f, type ListLabelsRequest as g, type Sorting as h, type ListLabelsResponse as i, type PagingMetadata as j, type FindOrCreateLabelRequest as k, type LabelsQuotaReached as l, type ListLabelNamespacesRequest as m, type ListLabelNamespacesResponse as n, type ContactLabelNamespace as o, type GetLabelRequest as p, type GetLabelResponse as q, type GetLabelByLegacyIdRequest as r, type GetLabelByLegacyIdResponse as s, type UpdateLabelResponse as t, type DeleteLabelResponse as u, type PurgeRequest as v, type PurgeResponse as w, type GdprListRequest as x, type GdprListResponse as y, type QueryLabelsRequest as z };