@wix/auto_sdk_loyalty_programs 1.0.2 → 1.0.4

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 (33) hide show
  1. package/build/cjs/src/loyalty-v1-program-programs.http.d.ts +3 -3
  2. package/build/cjs/src/loyalty-v1-program-programs.http.js +3 -3
  3. package/build/cjs/src/loyalty-v1-program-programs.public.d.ts +3 -3
  4. package/build/cjs/src/loyalty-v1-program-programs.types.d.ts +194 -44
  5. package/build/cjs/src/loyalty-v1-program-programs.types.js.map +1 -1
  6. package/build/cjs/src/loyalty-v1-program-programs.universal.d.ts +205 -49
  7. package/build/cjs/src/loyalty-v1-program-programs.universal.js +3 -3
  8. package/build/cjs/src/loyalty-v1-program-programs.universal.js.map +1 -1
  9. package/build/es/src/loyalty-v1-program-programs.http.d.ts +3 -3
  10. package/build/es/src/loyalty-v1-program-programs.http.js +3 -3
  11. package/build/es/src/loyalty-v1-program-programs.public.d.ts +3 -3
  12. package/build/es/src/loyalty-v1-program-programs.types.d.ts +194 -44
  13. package/build/es/src/loyalty-v1-program-programs.types.js.map +1 -1
  14. package/build/es/src/loyalty-v1-program-programs.universal.d.ts +205 -49
  15. package/build/es/src/loyalty-v1-program-programs.universal.js +3 -3
  16. package/build/es/src/loyalty-v1-program-programs.universal.js.map +1 -1
  17. package/build/internal/cjs/src/loyalty-v1-program-programs.http.d.ts +3 -3
  18. package/build/internal/cjs/src/loyalty-v1-program-programs.http.js +3 -3
  19. package/build/internal/cjs/src/loyalty-v1-program-programs.public.d.ts +3 -3
  20. package/build/internal/cjs/src/loyalty-v1-program-programs.types.d.ts +194 -44
  21. package/build/internal/cjs/src/loyalty-v1-program-programs.types.js.map +1 -1
  22. package/build/internal/cjs/src/loyalty-v1-program-programs.universal.d.ts +205 -49
  23. package/build/internal/cjs/src/loyalty-v1-program-programs.universal.js +3 -3
  24. package/build/internal/cjs/src/loyalty-v1-program-programs.universal.js.map +1 -1
  25. package/build/internal/es/src/loyalty-v1-program-programs.http.d.ts +3 -3
  26. package/build/internal/es/src/loyalty-v1-program-programs.http.js +3 -3
  27. package/build/internal/es/src/loyalty-v1-program-programs.public.d.ts +3 -3
  28. package/build/internal/es/src/loyalty-v1-program-programs.types.d.ts +194 -44
  29. package/build/internal/es/src/loyalty-v1-program-programs.types.js.map +1 -1
  30. package/build/internal/es/src/loyalty-v1-program-programs.universal.d.ts +205 -49
  31. package/build/internal/es/src/loyalty-v1-program-programs.universal.js +3 -3
  32. package/build/internal/es/src/loyalty-v1-program-programs.universal.js.map +1 -1
  33. package/package.json +2 -2
@@ -16,7 +16,7 @@ export declare function bulkGetLoyaltyProgram(payload: object): RequestOptionsFa
16
16
  *
17
17
  * The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.
18
18
  *
19
- * With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](wix-loyalty-v2/programs/activateloyaltyprogram) function.
19
+ * With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/activate-loyalty-program) function.
20
20
  *
21
21
  * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.
22
22
  */
@@ -28,10 +28,10 @@ export declare function updateLoyaltyProgram(payload: object): RequestOptionsFac
28
28
  *
29
29
  * Before you begin, a Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). Initially when a loyalty program is installed, the status is set to `"DRAFT"`. You can change the program's status to `"ACTIVE"` with this function or through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). A site's customers can only earn or redeem points while the program status is `"ACTIVE"`.
30
30
  *
31
- * This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](wix-loyalty-v2/programs/updateloyaltyprogram) function.
31
+ * This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/update-loyalty-program) function.
32
32
  *
33
33
  * To temporarily pause your loyalty program you must follow three steps:
34
- * 1. Remove all [`earnPoints()`](wix-loyalty-v2/accounts/earnpoints) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
34
+ * 1. Remove all [`earnPoints()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/accounts/earn-points) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
35
35
  * 1. Hide the loyalty page from your site.
36
36
  * 1. Delete the My Rewards page from the Member pages.
37
37
  * See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.
@@ -173,7 +173,7 @@ exports.bulkGetLoyaltyProgram = bulkGetLoyaltyProgram;
173
173
  *
174
174
  * The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.
175
175
  *
176
- * With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](wix-loyalty-v2/programs/activateloyaltyprogram) function.
176
+ * With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/activate-loyalty-program) function.
177
177
  *
178
178
  * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.
179
179
  */
@@ -237,10 +237,10 @@ exports.updateLoyaltyProgram = updateLoyaltyProgram;
237
237
  *
238
238
  * Before you begin, a Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). Initially when a loyalty program is installed, the status is set to `"DRAFT"`. You can change the program's status to `"ACTIVE"` with this function or through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). A site's customers can only earn or redeem points while the program status is `"ACTIVE"`.
239
239
  *
240
- * This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](wix-loyalty-v2/programs/updateloyaltyprogram) function.
240
+ * This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/update-loyalty-program) function.
241
241
  *
242
242
  * To temporarily pause your loyalty program you must follow three steps:
243
- * 1. Remove all [`earnPoints()`](wix-loyalty-v2/accounts/earnpoints) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
243
+ * 1. Remove all [`earnPoints()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/accounts/earn-points) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
244
244
  * 1. Hide the loyalty page from your site.
245
245
  * 1. Delete the My Rewards page from the Member pages.
246
246
  * See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.
@@ -28,7 +28,7 @@ interface UpdateLoyaltyProgramSignature {
28
28
  *
29
29
  * The `updateLoyaltyProgram()` function returns a Promise that resolves when the loyalty program is updated.
30
30
  *
31
- * With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](wix-loyalty-v2/programs/activateloyaltyprogram) function.
31
+ * With the `updateLoyaltyProgram()` function you can update the name of the loyalty program and the details of the collectible points unit. To activate the loyalty program use the [`activateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/activate-loyalty-program) function.
32
32
  *
33
33
  * >**Note:** Only visitors with **Manage Loyalty** [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update a loyalty program. You can override the permissions with the `wix-auth` [`elevate()`](wix-auth/elevate) function.
34
34
  * @param - Loyalty program fields to update.
@@ -44,10 +44,10 @@ interface ActivateLoyaltyProgramSignature {
44
44
  *
45
45
  * Before you begin, a Wix Loyalty Program must first be installed through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or through the [Wix App Market](https://www.wix.com/app-market/loyalty). Initially when a loyalty program is installed, the status is set to `"DRAFT"`. You can change the program's status to `"ACTIVE"` with this function or through your [dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/). A site's customers can only earn or redeem points while the program status is `"ACTIVE"`.
46
46
  *
47
- * This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](wix-loyalty-v2/programs/updateloyaltyprogram) function.
47
+ * This function updates only the status of a loyalty program, to make other updates to the program, use the [`updateLoyaltyProgram()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/programs/update-loyalty-program) function.
48
48
  *
49
49
  * To temporarily pause your loyalty program you must follow three steps:
50
- * 1. Remove all [`earnPoints()`](wix-loyalty-v2/accounts/earnpoints) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
50
+ * 1. Remove all [`earnPoints()`](https://dev.wix.com/docs/sdk/backend-modules/loyalty/accounts/earn-points) functions and switch off all the "Earn Points" and "Rewards" toggles in the [Loyalty Program dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Open%20Loyalty%20Program&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/loyalty-accounts/).
51
51
  * 1. Hide the loyalty page from your site.
52
52
  * 1. Delete the My Rewards page from the Member pages.
53
53
  * See [Pausing Your Loyalty Program](https://support.wix.com/en/article/wix-loyalty-program-pausing-your-loyalty-program) for more information.
@@ -4,7 +4,11 @@
4
4
  * [this overview](https://support.wix.com/en/article/wix-loyalty-program-an-overview).
5
5
  */
6
6
  export interface LoyaltyProgram {
7
- /** Program name. */
7
+ /**
8
+ * Program name.
9
+ * @minLength 2
10
+ * @maxLength 50
11
+ */
8
12
  name?: string | null;
9
13
  /** Details about the program's collectible unit. */
10
14
  pointDefinition?: PointDefinition;
@@ -42,6 +46,7 @@ export interface PointDefinition {
42
46
  * In contrast to a custom name, the default `"Points"` name is translated and adjusted to singular based on circumstances.
43
47
  *
44
48
  * Default: `Points`.
49
+ * @maxLength 20
45
50
  */
46
51
  customName?: string | null;
47
52
  /** Details about the points icon. */
@@ -96,9 +101,17 @@ export interface PointsExpiration {
96
101
  * @readonly
97
102
  */
98
103
  status?: Status;
99
- /** How many months a member should be inactive to lose the collected points. */
104
+ /**
105
+ * How many months a member should be inactive to lose the collected points.
106
+ * @min 1
107
+ * @max 12
108
+ */
100
109
  monthsOfInactivity?: number;
101
- /** Percentage of points that a member loses after being inactive. */
110
+ /**
111
+ * Percentage of points that a member loses after being inactive.
112
+ * @min 1
113
+ * @max 100
114
+ */
102
115
  expiringPointsPercentage?: number;
103
116
  }
104
117
  export declare enum Status {
@@ -127,7 +140,10 @@ export interface PremiumFeatures {
127
140
  pointsExpiration?: boolean;
128
141
  }
129
142
  export interface SocialMediaSettings {
130
- /** List of social media channels */
143
+ /**
144
+ * List of social media channels
145
+ * @maxSize 5
146
+ */
131
147
  channels?: SocialMediaChannel[];
132
148
  }
133
149
  export interface SocialMediaChannel {
@@ -135,11 +151,16 @@ export interface SocialMediaChannel {
135
151
  type?: Type;
136
152
  /** Enable or disable social media channel */
137
153
  enabled?: boolean;
138
- /** Social media channel ID. For example, Instagram username. */
154
+ /**
155
+ * Social media channel ID. For example, Instagram username.
156
+ * @minLength 1
157
+ * @maxLength 255
158
+ */
139
159
  id?: string;
140
160
  /**
141
161
  * Social media channel URL
142
162
  * @readonly
163
+ * @format WEB_URL
143
164
  */
144
165
  url?: string | null;
145
166
  }
@@ -170,7 +191,10 @@ export interface BulkGetLoyaltyProgramResponse {
170
191
  programInSites?: ProgramInSite[];
171
192
  }
172
193
  export interface ProgramInSite {
173
- /** Metasite ID. */
194
+ /**
195
+ * Metasite ID.
196
+ * @format GUID
197
+ */
174
198
  metaSiteId?: string;
175
199
  /** Loyalty program. */
176
200
  loyaltyProgram?: LoyaltyProgram;
@@ -210,7 +234,10 @@ export interface PauseLoyaltyProgramResponse {
210
234
  loyaltyProgram?: LoyaltyProgram;
211
235
  }
212
236
  export interface GetLoyaltyProgramDescriptionRequest {
213
- /** List of description fields to retrieve. Supported values: `description`, `updatedDate`. */
237
+ /**
238
+ * List of description fields to retrieve. Supported values: `description`, `updatedDate`.
239
+ * @maxSize 2
240
+ */
214
241
  fields?: string[];
215
242
  }
216
243
  export interface GetLoyaltyProgramDescriptionResponse {
@@ -220,7 +247,11 @@ export interface GetLoyaltyProgramDescriptionResponse {
220
247
  updatedDate?: Date | null;
221
248
  }
222
249
  export interface UpdateLoyaltyProgramDescriptionRequest {
223
- /** Loyalty program description to update. */
250
+ /**
251
+ * Loyalty program description to update.
252
+ * @minLength 1
253
+ * @maxLength 1000000
254
+ */
224
255
  description?: string;
225
256
  }
226
257
  export interface UpdateLoyaltyProgramDescriptionResponse {
@@ -297,7 +328,10 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
297
328
  studioAssigned?: StudioAssigned;
298
329
  /** Emitted when Studio is detached. */
299
330
  studioUnassigned?: StudioUnassigned;
300
- /** A meta site id. */
331
+ /**
332
+ * A meta site id.
333
+ * @format GUID
334
+ */
301
335
  metaSiteId?: string;
302
336
  /** A meta site version. Monotonically increasing. */
303
337
  version?: string;
@@ -306,6 +340,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
306
340
  /**
307
341
  * TODO(meta-site): Change validation once validations are disabled for consumers
308
342
  * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
343
+ * @maxSize 4000
309
344
  */
310
345
  assets?: Asset[];
311
346
  }
@@ -343,9 +378,15 @@ export interface MetaSiteSpecialEventPayloadOneOf {
343
378
  studioUnassigned?: StudioUnassigned;
344
379
  }
345
380
  export interface Asset {
346
- /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
381
+ /**
382
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
383
+ * @maxLength 36
384
+ */
347
385
  appDefId?: string;
348
- /** An instance id. For legacy reasons may be UUID or a string. */
386
+ /**
387
+ * An instance id. For legacy reasons may be UUID or a string.
388
+ * @maxLength 200
389
+ */
349
390
  instanceId?: string;
350
391
  /** An application state. */
351
392
  state?: State;
@@ -358,9 +399,15 @@ export declare enum State {
358
399
  DEMO = "DEMO"
359
400
  }
360
401
  export interface SiteCreated {
361
- /** A template identifier (empty if not created from a template). */
402
+ /**
403
+ * A template identifier (empty if not created from a template).
404
+ * @maxLength 36
405
+ */
362
406
  originTemplateId?: string;
363
- /** An account id of the owner. */
407
+ /**
408
+ * An account id of the owner.
409
+ * @format GUID
410
+ */
364
411
  ownerId?: string;
365
412
  /** A context in which meta site was created. */
366
413
  context?: SiteCreatedContext;
@@ -369,9 +416,13 @@ export interface SiteCreated {
369
416
  *
370
417
  * In case of a creation from a template it's a template id.
371
418
  * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
419
+ * @format GUID
372
420
  */
373
421
  originMetaSiteId?: string | null;
374
- /** A meta site name (URL slug). */
422
+ /**
423
+ * A meta site name (URL slug).
424
+ * @maxLength 20
425
+ */
375
426
  siteName?: string;
376
427
  /** A namespace. */
377
428
  namespace?: Namespace;
@@ -468,9 +519,15 @@ export declare enum Namespace {
468
519
  }
469
520
  /** Site transferred to another user. */
470
521
  export interface SiteTransferred {
471
- /** A previous owner id (user that transfers meta site). */
522
+ /**
523
+ * A previous owner id (user that transfers meta site).
524
+ * @format GUID
525
+ */
472
526
  oldOwnerId?: string;
473
- /** A new owner id (user that accepts meta site). */
527
+ /**
528
+ * A new owner id (user that accepts meta site).
529
+ * @format GUID
530
+ */
474
531
  newOwnerId?: string;
475
532
  }
476
533
  /** Soft deletion of the meta site. Could be restored. */
@@ -483,9 +540,15 @@ export interface DeleteContext {
483
540
  dateDeleted?: Date | null;
484
541
  /** A status. */
485
542
  deleteStatus?: DeleteStatus;
486
- /** A reason (flow). */
543
+ /**
544
+ * A reason (flow).
545
+ * @maxLength 255
546
+ */
487
547
  deleteOrigin?: string;
488
- /** A service that deleted it. */
548
+ /**
549
+ * A service that deleted it.
550
+ * @maxLength 255
551
+ */
489
552
  initiatorId?: string | null;
490
553
  }
491
554
  export declare enum DeleteStatus {
@@ -501,7 +564,11 @@ export interface SiteUndeleted {
501
564
  export interface SitePublished {
502
565
  }
503
566
  export interface SiteUnpublished {
504
- /** A list of URLs previously associated with the meta site. */
567
+ /**
568
+ * A list of URLs previously associated with the meta site.
569
+ * @maxLength 4000
570
+ * @maxSize 10000
571
+ */
505
572
  urls?: string[];
506
573
  }
507
574
  export interface SiteMarkedAsTemplate {
@@ -524,30 +591,60 @@ export interface SiteMarkedAsWixSite {
524
591
  * To ensure this, the TPA on the template gets a new instance_id.
525
592
  */
526
593
  export interface ServiceProvisioned {
527
- /** Either UUID or EmbeddedServiceType. */
594
+ /**
595
+ * Either UUID or EmbeddedServiceType.
596
+ * @maxLength 36
597
+ */
528
598
  appDefId?: string;
529
- /** Not only UUID. Something here could be something weird. */
599
+ /**
600
+ * Not only UUID. Something here could be something weird.
601
+ * @maxLength 36
602
+ */
530
603
  instanceId?: string;
531
- /** An instance id from which this instance is originated. */
604
+ /**
605
+ * An instance id from which this instance is originated.
606
+ * @maxLength 36
607
+ */
532
608
  originInstanceId?: string;
533
- /** A version. */
609
+ /**
610
+ * A version.
611
+ * @maxLength 500
612
+ */
534
613
  version?: string | null;
535
- /** The origin meta site id */
614
+ /**
615
+ * The origin meta site id
616
+ * @format GUID
617
+ */
536
618
  originMetaSiteId?: string | null;
537
619
  }
538
620
  export interface ServiceRemoved {
539
- /** Either UUID or EmbeddedServiceType. */
621
+ /**
622
+ * Either UUID or EmbeddedServiceType.
623
+ * @maxLength 36
624
+ */
540
625
  appDefId?: string;
541
- /** Not only UUID. Something here could be something weird. */
626
+ /**
627
+ * Not only UUID. Something here could be something weird.
628
+ * @maxLength 36
629
+ */
542
630
  instanceId?: string;
543
- /** A version. */
631
+ /**
632
+ * A version.
633
+ * @maxLength 500
634
+ */
544
635
  version?: string | null;
545
636
  }
546
637
  /** Rename of the site. Meaning, free public url has been changed as well. */
547
638
  export interface SiteRenamed {
548
- /** A new meta site name (URL slug). */
639
+ /**
640
+ * A new meta site name (URL slug).
641
+ * @maxLength 20
642
+ */
549
643
  newSiteName?: string;
550
- /** A previous meta site name (URL slug). */
644
+ /**
645
+ * A previous meta site name (URL slug).
646
+ * @maxLength 255
647
+ */
551
648
  oldSiteName?: string;
552
649
  }
553
650
  /**
@@ -656,11 +753,13 @@ export interface FeatureEnabled extends FeatureEnabledReasonOneOf {
656
753
  /**
657
754
  * Information about a transfer from another account.
658
755
  * __Deprecated__. Use `reason.transferred_from_another_account` instead.
756
+ * @format GUID
659
757
  */
660
758
  transferredFromAccount?: string | null;
661
759
  /**
662
760
  * Information about a transfer from another site.
663
761
  * __Deprecated__. Use `reason.reassigned_from_site` instead.
762
+ * @format GUID
664
763
  */
665
764
  reassignedFromMetasite?: string | null;
666
765
  }
@@ -709,6 +808,8 @@ export interface Feature extends FeatureQuantityInfoOneOf {
709
808
  *
710
809
  * Min: 2 characters
711
810
  * Max: 50 characters
811
+ * @minLength 2
812
+ * @maxLength 50
712
813
  */
713
814
  uniqueName?: string;
714
815
  /**
@@ -747,6 +848,7 @@ export interface Feature extends FeatureQuantityInfoOneOf {
747
848
  /**
748
849
  * ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)
749
850
  * to which the feature instance belongs.
851
+ * @format GUID
750
852
  */
751
853
  subscriptionId?: string | null;
752
854
  /**
@@ -780,6 +882,7 @@ export interface FeatureContext {
780
882
  /**
781
883
  * ID of the Wix account that the feature instance belongs to.
782
884
  * Available for both site and account level feature instances.
885
+ * @format GUID
783
886
  */
784
887
  userId?: string;
785
888
  /**
@@ -787,6 +890,7 @@ export interface FeatureContext {
787
890
  * Only available for site level feature instances that are assigned to a Wix
788
891
  * site. Not available for account level and unassigned site level feature
789
892
  * instances.
893
+ * @format GUID
790
894
  */
791
895
  metaSiteId?: string | null;
792
896
  }
@@ -843,12 +947,18 @@ export interface QuotaInfo {
843
947
  }
844
948
  /** Subscription transferred from another account, features on the current account were enabled. */
845
949
  export interface TransferredFromAnotherAccountReason {
846
- /** Information about a transfer from another account. */
950
+ /**
951
+ * Information about a transfer from another account.
952
+ * @format GUID
953
+ */
847
954
  transferredFromAccount?: string;
848
955
  }
849
956
  /** Subscription moved from one site to another in the same account, features enabled on the target site */
850
957
  export interface ReassignedFromSiteReason {
851
- /** Information about a transfer from another site. */
958
+ /**
959
+ * Information about a transfer from another site.
960
+ * @format GUID
961
+ */
852
962
  reassignedFromMetasite?: string;
853
963
  }
854
964
  /** Subscription was floating and assigned to site, features enabled on the target site */
@@ -885,7 +995,10 @@ export interface FeatureDisabled extends FeatureDisabledReasonOneOf {
885
995
  * possibly its new context.
886
996
  */
887
997
  feature?: Feature;
888
- /** ID of the meta site for which the feature has been disabled. */
998
+ /**
999
+ * ID of the meta site for which the feature has been disabled.
1000
+ * @format GUID
1001
+ */
889
1002
  metaSiteId?: string | null;
890
1003
  }
891
1004
  /** @oneof */
@@ -911,7 +1024,10 @@ export interface ReplacedByAnotherSubscriptionReason {
911
1024
  }
912
1025
  /** Subscription was assigned to another site, causing features on the origin site to be disabled. */
913
1026
  export interface ReassignedToAnotherSiteReason {
914
- /** Information about a transfer to the site. */
1027
+ /**
1028
+ * Information about a transfer to the site.
1029
+ * @format GUID
1030
+ */
915
1031
  reassignedToMetasite?: string;
916
1032
  }
917
1033
  /** Feature updated, for example Quota was increased due to upgrade */
@@ -953,6 +1069,7 @@ export interface FeatureCancelled extends FeatureCancelledReasonOneOf {
953
1069
  /**
954
1070
  * Information about a transfer to the account.
955
1071
  * __Deprecated__. Use `reason.transferred_to_account` instead.
1072
+ * @format GUID
956
1073
  */
957
1074
  transferredToAccount?: string | null;
958
1075
  }
@@ -967,7 +1084,10 @@ export interface FeatureCancelledReasonOneOf {
967
1084
  }
968
1085
  /** Subscription was transferred to another account, features in the origin account were cancelled */
969
1086
  export interface TransferredToAnotherAccountReason {
970
- /** Information about a transfer to the account. */
1087
+ /**
1088
+ * Information about a transfer to the account.
1089
+ * @format GUID
1090
+ */
971
1091
  transferredToAccount?: string;
972
1092
  }
973
1093
  /** Cancellation was requested from the subscription manager api, might be a result of billing event, or direct call */
@@ -1046,9 +1166,15 @@ export interface ActionEvent {
1046
1166
  bodyAsJson?: string;
1047
1167
  }
1048
1168
  export interface MessageEnvelope {
1049
- /** App instance ID. */
1169
+ /**
1170
+ * App instance ID.
1171
+ * @format GUID
1172
+ */
1050
1173
  instanceId?: string | null;
1051
- /** Event type. */
1174
+ /**
1175
+ * Event type.
1176
+ * @maxLength 150
1177
+ */
1052
1178
  eventType?: string;
1053
1179
  /** The identification type and identity data. */
1054
1180
  identity?: IdentificationData;
@@ -1056,26 +1182,50 @@ export interface MessageEnvelope {
1056
1182
  data?: string;
1057
1183
  }
1058
1184
  export interface IdentificationData extends IdentificationDataIdOneOf {
1059
- /** ID of a site visitor that has not logged in to the site. */
1185
+ /**
1186
+ * ID of a site visitor that has not logged in to the site.
1187
+ * @format GUID
1188
+ */
1060
1189
  anonymousVisitorId?: string;
1061
- /** ID of a site visitor that has logged in to the site. */
1190
+ /**
1191
+ * ID of a site visitor that has logged in to the site.
1192
+ * @format GUID
1193
+ */
1062
1194
  memberId?: string;
1063
- /** ID of a Wix user (site owner, contributor, etc.). */
1195
+ /**
1196
+ * ID of a Wix user (site owner, contributor, etc.).
1197
+ * @format GUID
1198
+ */
1064
1199
  wixUserId?: string;
1065
- /** ID of an app. */
1200
+ /**
1201
+ * ID of an app.
1202
+ * @format GUID
1203
+ */
1066
1204
  appId?: string;
1067
1205
  /** @readonly */
1068
1206
  identityType?: WebhookIdentityType;
1069
1207
  }
1070
1208
  /** @oneof */
1071
1209
  export interface IdentificationDataIdOneOf {
1072
- /** ID of a site visitor that has not logged in to the site. */
1210
+ /**
1211
+ * ID of a site visitor that has not logged in to the site.
1212
+ * @format GUID
1213
+ */
1073
1214
  anonymousVisitorId?: string;
1074
- /** ID of a site visitor that has logged in to the site. */
1215
+ /**
1216
+ * ID of a site visitor that has logged in to the site.
1217
+ * @format GUID
1218
+ */
1075
1219
  memberId?: string;
1076
- /** ID of a Wix user (site owner, contributor, etc.). */
1220
+ /**
1221
+ * ID of a Wix user (site owner, contributor, etc.).
1222
+ * @format GUID
1223
+ */
1077
1224
  wixUserId?: string;
1078
- /** ID of an app. */
1225
+ /**
1226
+ * ID of an app.
1227
+ * @format GUID
1228
+ */
1079
1229
  appId?: string;
1080
1230
  }
1081
1231
  export declare enum WebhookIdentityType {
@@ -1 +1 @@
1
- {"version":3,"file":"loyalty-v1-program-programs.types.js","sourceRoot":"","sources":["../../../src/loyalty-v1-program-programs.types.ts"],"names":[],"mappings":";;;AAsFA,IAAY,aASX;AATD,WAAY,aAAa;IACvB,8BAA8B;IAC9B,oCAAmB,CAAA;IACnB,kDAAkD;IAClD,gCAAe,CAAA;IACf,yBAAyB;IACzB,kCAAiB,CAAA;IACjB,8HAA8H;IAC9H,kCAAiB,CAAA;AACnB,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB;AAcD,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,gEAAgE;IAChE,2CAAiC,CAAA;IACjC,6CAA6C;IAC7C,+BAAqB,CAAA;IACrB,4CAA4C;IAC5C,6BAAmB,CAAA;AACrB,CAAC,EAPW,MAAM,sBAAN,MAAM,QAOjB;AAuCD,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AAwND,IAAY,KAMX;AAND,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;IACnB,8BAAqB,CAAA;IACrB,4BAAmB,CAAA;IACnB,sBAAa,CAAA;AACf,CAAC,EANW,KAAK,qBAAL,KAAK,QAMhB;AAsBD,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,6EAA6E;IAC7E,qCAAe,CAAA;IACf,6CAA6C;IAC7C,qDAA+B,CAAA;IAC/B,wEAAwE;IACxE,+EAAyD,CAAA;IACzD,oCAAoC;IACpC,6CAAuB,CAAA;IACvB,wGAAwG;IACxG,6DAAuC,CAAA;IACvC,2DAA2D;IAC3D,qCAAe,CAAA;AACjB,CAAC,EAbW,kBAAkB,kCAAlB,kBAAkB,QAa7B;AAED,IAAY,SA2EX;AA3ED,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,qHAAqH;IACrH,wBAAW,CAAA;IACX,6KAA6K;IAC7K,oCAAuB,CAAA;IACvB,0KAA0K;IAC1K,8BAAiB,CAAA;IACjB,6RAA6R;IAC7R,4DAA+C,CAAA;IAC/C,wHAAwH;IACxH,8BAAiB,CAAA;IACjB,kJAAkJ;IAClJ,4BAAe,CAAA;IACf,2HAA2H;IAC3H,kDAAqC,CAAA;IACrC,iIAAiI;IACjI,kCAAqB,CAAA;IACrB,sJAAsJ;IACtJ,4BAAe,CAAA;IACf,wJAAwJ;IACxJ,wCAA2B,CAAA;IAC3B,0FAA0F;IAC1F,oDAAuC,CAAA;IACvC,0FAA0F;IAC1F,sDAAyC,CAAA;IACzC;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,oDAAuC,CAAA;IACvC,oGAAoG;IACpG,gDAAmC,CAAA;IACnC,sDAAsD;IACtD,gDAAmC,CAAA;IACnC,2CAA2C;IAC3C,kCAAqB,CAAA;IACrB,uDAAuD;IACvD,kCAAqB,CAAA;IACrB;;;OAGG;IACH,sDAAyC,CAAA;IACzC,2EAA2E;IAC3E,0BAAa,CAAA;IACb;;;;OAIG;IACH,4CAA+B,CAAA;IAC/B,0EAA0E;IAC1E,8BAAiB,CAAA;IACjB;;;OAGG;IACH,0CAA6B,CAAA;IAC7B,2BAA2B;IAC3B,4BAAe,CAAA;IACf,gCAAgC;IAChC,0DAA6C,CAAA;IAC7C;;;OAGG;IACH,8DAAiD,CAAA;AACnD,CAAC,EA3EW,SAAS,yBAAT,SAAS,QA2EpB;AA2BD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,+CAA+B,CAAA;AACjC,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAuUD,uDAAuD;AACvD,IAAY,aAUX;AAVD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,4CAA2B,CAAA;IAC3B,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,8BAAa,CAAA;IACb,4BAAW,CAAA;IACX,8BAAa,CAAA;IACb,gCAAe,CAAA;IACf,8BAAa,CAAA;AACf,CAAC,EAVW,aAAa,6BAAb,aAAa,QAUxB;AA+RD,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"}
1
+ {"version":3,"file":"loyalty-v1-program-programs.types.js","sourceRoot":"","sources":["../../../src/loyalty-v1-program-programs.types.ts"],"names":[],"mappings":";;;AA2FA,IAAY,aASX;AATD,WAAY,aAAa;IACvB,8BAA8B;IAC9B,oCAAmB,CAAA;IACnB,kDAAkD;IAClD,gCAAe,CAAA;IACf,yBAAyB;IACzB,kCAAiB,CAAA;IACjB,8HAA8H;IAC9H,kCAAiB,CAAA;AACnB,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB;AAsBD,IAAY,MAOX;AAPD,WAAY,MAAM;IAChB,gEAAgE;IAChE,2CAAiC,CAAA;IACjC,6CAA6C;IAC7C,+BAAqB,CAAA;IACrB,4CAA4C;IAC5C,6BAAmB,CAAA;AACrB,CAAC,EAPW,MAAM,sBAAN,MAAM,QAOjB;AA+CD,IAAY,IAaX;AAbD,WAAY,IAAI;IACd,yCAAyC;IACzC,2CAAmC,CAAA;IACnC,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,sCAAsC;IACtC,+BAAuB,CAAA;IACvB,qCAAqC;IACrC,6BAAqB,CAAA;IACrB,8BAA8B;IAC9B,eAAO,CAAA;IACP,mCAAmC;IACnC,yBAAiB,CAAA;AACnB,CAAC,EAbW,IAAI,oBAAJ,IAAI,QAaf;AA4OD,IAAY,KAMX;AAND,WAAY,KAAK;IACf,4BAAmB,CAAA;IACnB,4BAAmB,CAAA;IACnB,8BAAqB,CAAA;IACrB,4BAAmB,CAAA;IACnB,sBAAa,CAAA;AACf,CAAC,EANW,KAAK,qBAAL,KAAK,QAMhB;AAgCD,IAAY,kBAaX;AAbD,WAAY,kBAAkB;IAC5B,6EAA6E;IAC7E,qCAAe,CAAA;IACf,6CAA6C;IAC7C,qDAA+B,CAAA;IAC/B,wEAAwE;IACxE,+EAAyD,CAAA;IACzD,oCAAoC;IACpC,6CAAuB,CAAA;IACvB,wGAAwG;IACxG,6DAAuC,CAAA;IACvC,2DAA2D;IAC3D,qCAAe,CAAA;AACjB,CAAC,EAbW,kBAAkB,kCAAlB,kBAAkB,QAa7B;AAED,IAAY,SA2EX;AA3ED,WAAY,SAAS;IACnB,oDAAuC,CAAA;IACvC,qHAAqH;IACrH,wBAAW,CAAA;IACX,6KAA6K;IAC7K,oCAAuB,CAAA;IACvB,0KAA0K;IAC1K,8BAAiB,CAAA;IACjB,6RAA6R;IAC7R,4DAA+C,CAAA;IAC/C,wHAAwH;IACxH,8BAAiB,CAAA;IACjB,kJAAkJ;IAClJ,4BAAe,CAAA;IACf,2HAA2H;IAC3H,kDAAqC,CAAA;IACrC,iIAAiI;IACjI,kCAAqB,CAAA;IACrB,sJAAsJ;IACtJ,4BAAe,CAAA;IACf,wJAAwJ;IACxJ,wCAA2B,CAAA;IAC3B,0FAA0F;IAC1F,oDAAuC,CAAA;IACvC,0FAA0F;IAC1F,sDAAyC,CAAA;IACzC;;;;OAIG;IACH,sCAAyB,CAAA;IACzB;;;;OAIG;IACH,oDAAuC,CAAA;IACvC,oGAAoG;IACpG,gDAAmC,CAAA;IACnC,sDAAsD;IACtD,gDAAmC,CAAA;IACnC,2CAA2C;IAC3C,kCAAqB,CAAA;IACrB,uDAAuD;IACvD,kCAAqB,CAAA;IACrB;;;OAGG;IACH,sDAAyC,CAAA;IACzC,2EAA2E;IAC3E,0BAAa,CAAA;IACb;;;;OAIG;IACH,4CAA+B,CAAA;IAC/B,0EAA0E;IAC1E,8BAAiB,CAAA;IACjB;;;OAGG;IACH,0CAA6B,CAAA;IAC7B,2BAA2B;IAC3B,4BAAe,CAAA;IACf,gCAAgC;IAChC,0DAA6C,CAAA;IAC7C;;;OAGG;IACH,8DAAiD,CAAA;AACnD,CAAC,EA3EW,SAAS,yBAAT,SAAS,QA2EpB;AAuCD,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,+CAA+B,CAAA;AACjC,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAgXD,uDAAuD;AACvD,IAAY,aAUX;AAVD,WAAY,aAAa;IACvB,wCAAuB,CAAA;IACvB,4CAA2B,CAAA;IAC3B,kCAAiB,CAAA;IACjB,kCAAiB,CAAA;IACjB,8BAAa,CAAA;IACb,4BAAW,CAAA;IACX,8BAAa,CAAA;IACb,gCAAe,CAAA;IACf,8BAAa,CAAA;AACf,CAAC,EAVW,aAAa,6BAAb,aAAa,QAUxB;AA6UD,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"}