@wix/auto_sdk_loyalty_programs 1.0.37 → 1.0.39

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.
@@ -78,6 +78,16 @@ interface Image {
78
78
  */
79
79
  filename?: string | null;
80
80
  }
81
+ interface FocalPoint {
82
+ /** X-coordinate of the focal point. */
83
+ x?: number;
84
+ /** Y-coordinate of the focal point. */
85
+ y?: number;
86
+ /** crop by height */
87
+ height?: number | null;
88
+ /** crop by width */
89
+ width?: number | null;
90
+ }
81
91
  declare enum ProgramStatus {
82
92
  /** Unknown program status. */
83
93
  UNKNOWN = "UNKNOWN",
@@ -140,6 +150,47 @@ interface PremiumFeatures {
140
150
  */
141
151
  pointsExpiration?: boolean;
142
152
  }
153
+ interface SocialMediaSettings {
154
+ /**
155
+ * List of social media channels
156
+ * @maxSize 5
157
+ */
158
+ channels?: SocialMediaChannel[];
159
+ }
160
+ interface SocialMediaChannel {
161
+ /** Social media channel type */
162
+ type?: TypeWithLiterals;
163
+ /** Enable or disable social media channel */
164
+ enabled?: boolean;
165
+ /**
166
+ * Social media channel ID. For example, Instagram username.
167
+ * @minLength 1
168
+ * @maxLength 255
169
+ */
170
+ id?: string;
171
+ /**
172
+ * Social media channel URL
173
+ * @readonly
174
+ * @format WEB_URL
175
+ */
176
+ url?: string | null;
177
+ }
178
+ declare enum Type {
179
+ /** Unknown social media channel type. */
180
+ UNKNOWN_CHANNEL = "UNKNOWN_CHANNEL",
181
+ /** Facebook social media channel. */
182
+ FACEBOOK = "FACEBOOK",
183
+ /** Instagram social media channel. */
184
+ INSTAGRAM = "INSTAGRAM",
185
+ /** LinkedIn social media channel. */
186
+ LINKEDIN = "LINKEDIN",
187
+ /** X social media channel. */
188
+ X = "X",
189
+ /** TikTok social media channel. */
190
+ TIKTOK = "TIKTOK"
191
+ }
192
+ /** @enumType */
193
+ type TypeWithLiterals = Type | 'UNKNOWN_CHANNEL' | 'FACEBOOK' | 'INSTAGRAM' | 'LINKEDIN' | 'X' | 'TIKTOK';
143
194
  interface GetLoyaltyProgramRequest {
144
195
  }
145
196
  interface GetLoyaltyProgramResponse {
@@ -169,18 +220,57 @@ interface UpdateLoyaltyProgramResponse {
169
220
  /** Updated loyalty program. */
170
221
  loyaltyProgram?: LoyaltyProgram;
171
222
  }
223
+ interface PointsExpirationConfigurationChanged {
224
+ /** Loyalty program. */
225
+ loyaltyProgram?: LoyaltyProgram;
226
+ /** Points expiration configuration changes */
227
+ pointsExpirationChanges?: PointsExpirationChanges;
228
+ }
229
+ interface PointsExpirationChanges {
230
+ monthsOfInactivity?: number | null;
231
+ expiringPointsPercentage?: number | null;
232
+ }
172
233
  interface ActivateLoyaltyProgramRequest {
173
234
  }
174
235
  interface ActivateLoyaltyProgramResponse {
175
236
  /** Activated loyalty program. */
176
237
  loyaltyProgram?: LoyaltyProgram;
177
238
  }
239
+ interface LoyaltyProgramActivated {
240
+ /** Activated loyalty program. */
241
+ loyaltyProgram?: LoyaltyProgram;
242
+ }
178
243
  interface PauseLoyaltyProgramRequest {
179
244
  }
180
245
  interface PauseLoyaltyProgramResponse {
181
246
  /** Paused loyalty program. */
182
247
  loyaltyProgram?: LoyaltyProgram;
183
248
  }
249
+ interface GetLoyaltyProgramDescriptionRequest {
250
+ /**
251
+ * List of description fields to retrieve. Supported values: `description`, `updatedDate`.
252
+ * @maxSize 2
253
+ */
254
+ fields?: string[];
255
+ }
256
+ interface GetLoyaltyProgramDescriptionResponse {
257
+ /** Retrieved loyalty program description. */
258
+ description?: string | null;
259
+ /** Date and time of the latest description update. */
260
+ updatedDate?: Date | null;
261
+ }
262
+ interface UpdateLoyaltyProgramDescriptionRequest {
263
+ /**
264
+ * Loyalty program description to update.
265
+ * @minLength 1
266
+ * @maxLength 1000000
267
+ */
268
+ description?: string;
269
+ }
270
+ interface UpdateLoyaltyProgramDescriptionResponse {
271
+ }
272
+ interface LoyaltyProgramDescriptionUpdated {
273
+ }
184
274
  interface GetLoyaltyProgramPremiumFeaturesRequest {
185
275
  }
186
276
  interface GetLoyaltyProgramPremiumFeaturesResponse {
@@ -206,12 +296,648 @@ interface EnablePointsExpirationResponse {
206
296
  /** Loyalty program with enabled points expiration feature. */
207
297
  loyaltyProgram?: LoyaltyProgram;
208
298
  }
299
+ interface PointsExpirationEnabled {
300
+ /** Loyalty program. */
301
+ loyaltyProgram?: LoyaltyProgram;
302
+ }
209
303
  interface DisablePointsExpirationRequest {
210
304
  }
211
305
  interface DisablePointsExpirationResponse {
212
306
  /** Loyalty program with disabled points expiration feature. */
213
307
  loyaltyProgram?: LoyaltyProgram;
214
308
  }
309
+ interface PointsExpirationDisabled {
310
+ /** Loyalty program. */
311
+ loyaltyProgram?: LoyaltyProgram;
312
+ }
313
+ interface FeatureEvent extends FeatureEventEventOneOf {
314
+ /**
315
+ * Information about an event that makes a feature eligible to the user.
316
+ * Triggered for example, for new features or when a feature is reassigned
317
+ * to an account or a site.
318
+ */
319
+ enabled?: FeatureEnabled;
320
+ /**
321
+ * Information about an event that disables a feature for the user.
322
+ * Triggered for example, when a feature is unassigned from a site,
323
+ * reassigned to a different site, or the user switched to a different contract.
324
+ */
325
+ disabled?: FeatureDisabled;
326
+ /**
327
+ * Information about an event that updates a feature. An `updated` event
328
+ * is triggered for example by the
329
+ * [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)
330
+ * and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)
331
+ * endpoints.
332
+ */
333
+ updated?: FeatureUpdated;
334
+ /**
335
+ * Information about an event that cancels a feature for the user.
336
+ * Triggered for example, when a feature is canceled, transferred to
337
+ * another account, or the user switched to a different contract.
338
+ */
339
+ cancelled?: FeatureCancelled;
340
+ /**
341
+ * Timestamp of the event in
342
+ * [UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).
343
+ */
344
+ timestamp?: Date | null;
345
+ }
346
+ /** @oneof */
347
+ interface FeatureEventEventOneOf {
348
+ /**
349
+ * Information about an event that makes a feature eligible to the user.
350
+ * Triggered for example, for new features or when a feature is reassigned
351
+ * to an account or a site.
352
+ */
353
+ enabled?: FeatureEnabled;
354
+ /**
355
+ * Information about an event that disables a feature for the user.
356
+ * Triggered for example, when a feature is unassigned from a site,
357
+ * reassigned to a different site, or the user switched to a different contract.
358
+ */
359
+ disabled?: FeatureDisabled;
360
+ /**
361
+ * Information about an event that updates a feature. An `updated` event
362
+ * is triggered for example by the
363
+ * [Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)
364
+ * and [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)
365
+ * endpoints.
366
+ */
367
+ updated?: FeatureUpdated;
368
+ /**
369
+ * Information about an event that cancels a feature for the user.
370
+ * Triggered for example, when a feature is canceled, transferred to
371
+ * another account, or the user switched to a different contract.
372
+ */
373
+ cancelled?: FeatureCancelled;
374
+ }
375
+ /** Feature created or enabled after disabled state */
376
+ interface FeatureEnabled extends FeatureEnabledReasonOneOf {
377
+ /** Information about a transfer from another account. */
378
+ transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
379
+ /** Information about a transfer from another site. */
380
+ reassignedFromSite?: ReassignedFromSiteReason;
381
+ /** Information about a feature that hadn't been assigned to site. */
382
+ assignedFromFloating?: AssignedFromFloatingReason;
383
+ /** Information about the new feature. */
384
+ newFeature?: NewFeatureReason;
385
+ /** Information about the contract switch. */
386
+ contractSwitched?: ContractSwitchedReason;
387
+ /** Information about the manually created features. */
388
+ manualFeatureCreation?: ManualFeatureCreationReason;
389
+ /** Information about a feature that was migrated from legacy. */
390
+ migratedFromLegacy?: MigratedFromLegacyReason;
391
+ /** Enabled feature. */
392
+ feature?: Feature;
393
+ /**
394
+ * Information about a transfer from another account.
395
+ * __Deprecated__. Use `reason.transferred_from_another_account` instead.
396
+ * @format GUID
397
+ */
398
+ transferredFromAccount?: string | null;
399
+ /**
400
+ * Information about a transfer from another site.
401
+ * __Deprecated__. Use `reason.reassigned_from_site` instead.
402
+ * @format GUID
403
+ */
404
+ reassignedFromMetasite?: string | null;
405
+ }
406
+ /** @oneof */
407
+ interface FeatureEnabledReasonOneOf {
408
+ /** Information about a transfer from another account. */
409
+ transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
410
+ /** Information about a transfer from another site. */
411
+ reassignedFromSite?: ReassignedFromSiteReason;
412
+ /** Information about a feature that hadn't been assigned to site. */
413
+ assignedFromFloating?: AssignedFromFloatingReason;
414
+ /** Information about the new feature. */
415
+ newFeature?: NewFeatureReason;
416
+ /** Information about the contract switch. */
417
+ contractSwitched?: ContractSwitchedReason;
418
+ /** Information about the manually created features. */
419
+ manualFeatureCreation?: ManualFeatureCreationReason;
420
+ /** Information about a feature that was migrated from legacy. */
421
+ migratedFromLegacy?: MigratedFromLegacyReason;
422
+ }
423
+ interface Feature extends FeatureQuantityInfoOneOf {
424
+ /**
425
+ * Deprecated. Use `enabled` instead.
426
+ * @deprecated
427
+ */
428
+ booleanFeature?: BooleanFeature;
429
+ /**
430
+ * Deprecated. Use `quotaInfo` instead.
431
+ * @deprecated
432
+ */
433
+ quotaFeature?: QuotaFeature;
434
+ /**
435
+ * ID of the feature. __Note:__ Isn't unique. For example, all features that
436
+ * are available to free Wix accounts or site in some capacity have
437
+ * `{"id": "DEFAULT"}`. Use `uniqueName` as unique identifier for a feature.
438
+ * @readonly
439
+ */
440
+ id?: string;
441
+ /**
442
+ * Unique name of the feature. Only lower case letters, numbers, and dashes
443
+ * `-` are supported. Used in the endpoints of the
444
+ * [Features Manager API](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/introduction)
445
+ * to specify the feature. Not visible to customers. We recommend to start
446
+ * the unique name with a prefix describing your organization or Wix company.
447
+ * For example, `bookings` or `crm`.
448
+ *
449
+ * Min: 2 characters
450
+ * Max: 50 characters
451
+ * @minLength 2
452
+ * @maxLength 50
453
+ */
454
+ uniqueName?: string;
455
+ /**
456
+ * Information about whether the feature belongs to a Wix account or site.
457
+ * Account features have `context.userId`. Site features have `context.metaSiteId` in case
458
+ * they're assigned to a specific site. Site features that aren't assigned to
459
+ * a specific site have neither ID.
460
+ */
461
+ context?: FeatureContext;
462
+ /**
463
+ * Deprecated.
464
+ * @readonly
465
+ * @deprecated
466
+ */
467
+ createdAt?: Date | null;
468
+ /**
469
+ * Deprecated.
470
+ * @readonly
471
+ * @deprecated
472
+ */
473
+ updatedAt?: Date | null;
474
+ /**
475
+ * Aggregated information about how often customers can use the feature.
476
+ * Available only for quota features.
477
+ */
478
+ quotaInfo?: QuotaInfo;
479
+ /**
480
+ * Whether the customer is currently allowed to use the feature.
481
+ * `true` means that the customer can use the feature. This means a boolean
482
+ * feature is active or a quota feature has remaining usage.
483
+ * `false` means that the customer can't use the feature.
484
+ * This means a boolean feature isn't active or a quota feature doesn't
485
+ * have remaining usage.
486
+ */
487
+ enabled?: boolean;
488
+ /**
489
+ * ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)
490
+ * to which the feature instance belongs.
491
+ * @format GUID
492
+ */
493
+ subscriptionId?: string | null;
494
+ /**
495
+ * Metadata of the feature. Wix Premium uses the metadata object to indicate
496
+ * that customers who purchase a product with the feature also get
497
+ * access to an additional product. For these bundled products `metadata`
498
+ * looks like this: `{"tpa": "{"appDefId": "sample-app-def-id-1234567890", "vendorProductId": "sample-productId"}}"`.
499
+ * But you can use the `metadata` property for other purposes, too.
500
+ */
501
+ metadata?: Record<string, string>;
502
+ }
503
+ /** @oneof */
504
+ interface FeatureQuantityInfoOneOf {
505
+ /**
506
+ * Deprecated. Use `enabled` instead.
507
+ * @deprecated
508
+ */
509
+ booleanFeature?: BooleanFeature;
510
+ /**
511
+ * Deprecated. Use `quotaInfo` instead.
512
+ * @deprecated
513
+ */
514
+ quotaFeature?: QuotaFeature;
515
+ }
516
+ /**
517
+ * Context this feature is currently connected to.
518
+ * Note: Do not confuse with feature scope which is configured in the product catalog
519
+ * and defines in which context the product can be used
520
+ */
521
+ interface FeatureContext {
522
+ /**
523
+ * ID of the Wix account that the feature instance belongs to.
524
+ * Available for both site and account level feature instances.
525
+ * @format GUID
526
+ */
527
+ userId?: string;
528
+ /**
529
+ * ID of the meta site that the feature instance is assigned to.
530
+ * Only available for site level feature instances that are assigned to a Wix
531
+ * site. Not available for account level and unassigned site level feature
532
+ * instances.
533
+ * @format GUID
534
+ */
535
+ metaSiteId?: string | null;
536
+ }
537
+ /**
538
+ * A feature that can be either "enabled" or "disabled". The default/freemium setting is always OFF, and the premium setting is always ON (meaning, unlimited usage without tracking).
539
+ * A boolean feature is similar to a quantitive feature with a default limit of 0 and UNLIMITED premium limit (although a bit simplified).
540
+ */
541
+ interface BooleanFeature {
542
+ }
543
+ /** A feature with a periodic usage limitation. The default limit is defined in the Feature Spec, the Premium limits are defined in the respective ProductFeature. */
544
+ interface QuotaFeature {
545
+ /** Default (or Freemium) quota limitation. if left undefined the free feature has unlimited amount. */
546
+ limit?: string | null;
547
+ /** Periodic time-frame to reset the usage counter. You may use NO_PERIOD if counter shouldn't be reset. */
548
+ period?: FeaturePeriodWithLiterals;
549
+ /** Usage measurement units (seconds? MBs? unitless?). Usage reported will be counted in multiples of this basic unit. */
550
+ units?: string | null;
551
+ }
552
+ /** Determines the reset cycle of the feature usage. */
553
+ declare enum FeaturePeriod {
554
+ NO_PERIOD = "NO_PERIOD",
555
+ MILLISECOND = "MILLISECOND",
556
+ SECOND = "SECOND",
557
+ MINUTE = "MINUTE",
558
+ HOUR = "HOUR",
559
+ DAY = "DAY",
560
+ WEEK = "WEEK",
561
+ MONTH = "MONTH",
562
+ YEAR = "YEAR"
563
+ }
564
+ /** @enumType */
565
+ type FeaturePeriodWithLiterals = FeaturePeriod | 'NO_PERIOD' | 'MILLISECOND' | 'SECOND' | 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
566
+ interface QuotaInfo {
567
+ /**
568
+ * Aggregation of how often the customer is allowed to use the feature at the time of the request.
569
+ * `null` means that the customer has unlimited access to the feature.
570
+ */
571
+ limit?: string | null;
572
+ /**
573
+ * Deprecated because a feature can have multiple periods defined. Use `period` in `breakdown` entries instead.
574
+ * Time frame for the usage limitation. `NO_PERIOD` means that `remainingUsage`
575
+ * isn't automatically reset to the feature's `limit` after a specific period.
576
+ * You may still manually call
577
+ * [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter).
578
+ * @deprecated
579
+ * @replacedBy breakdown.period
580
+ * @targetRemovalDate 2026-03-31
581
+ */
582
+ period?: FeaturePeriodWithLiterals;
583
+ /**
584
+ * Aggregation of how often the customer has used the feature.
585
+ * This value is retrieved from the Quota Manager/Rate Limiter system. If the
586
+ * `exclude_quota_usage` field in the `ListFeaturesRequest` was set to `true`,
587
+ * this field will contain the value `-1`.
588
+ */
589
+ currentUsage?: string;
590
+ /**
591
+ * Aggregation of how often the customer can still use the feature.
592
+ * `null` means that the customer has unlimited access to the feature.
593
+ * This value is retrieved from the Quota Manager/Rate Limiter system. If the
594
+ * `exclude_quota_usage` field in the `ListFeaturesRequest` was set to `true`,
595
+ * this field will not be populated.
596
+ */
597
+ remainingUsage?: string | null;
598
+ /**
599
+ * Breakdown of quota information entries, entry per feature instance.
600
+ * @maxSize 100
601
+ */
602
+ breakdown?: QuotaInfoEntry[];
603
+ }
604
+ interface QuotaInfoEntry {
605
+ /**
606
+ * If quota is of free feature, the id would be empty (None).
607
+ * If quota is of premium feature, this is the ID of the feature instance.
608
+ * @format GUID
609
+ */
610
+ featureInstanceId?: string | null;
611
+ /**
612
+ * How often the customer is allowed to use the feature during the specified
613
+ * period. `null` means that the customer has unlimited access to the feature.
614
+ */
615
+ limit?: string | null;
616
+ /**
617
+ * Time frame for the usage limitation. `NO_PERIOD` means that `remainingUsage`
618
+ * isn't automatically reset to the feature's `limit` after a specific period.
619
+ * You may still manually call
620
+ * [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter).
621
+ */
622
+ period?: FeaturePeriodWithLiterals;
623
+ /**
624
+ * How often the customer has used the feature during the current
625
+ * period.
626
+ * This value is retrieved from the Quota Manager/Rate Limiter system. If the
627
+ * `exclude_quota_usage` field in the `ListFeaturesRequest` was set to `true`,
628
+ * this field will contain the value `-1`.
629
+ */
630
+ currentUsage?: string;
631
+ /**
632
+ * How often the customer can still use the feature during the current
633
+ * period. `null` means that the customer has unlimited access to the feature.
634
+ * This value is retrieved from the Quota Manager/Rate Limiter system. If the
635
+ * `exclude_quota_usage` field in the `ListFeaturesRequest` was set to `true`,
636
+ * this field will not be populated.
637
+ */
638
+ remainingUsage?: string | null;
639
+ /**
640
+ * ID of the subscription to which the feature instance belongs.
641
+ * @format GUID
642
+ */
643
+ subscriptionId?: string | null;
644
+ }
645
+ /** Subscription transferred from another account, features on the current account were enabled. */
646
+ interface TransferredFromAnotherAccountReason {
647
+ /**
648
+ * Information about a transfer from another account.
649
+ * @format GUID
650
+ */
651
+ transferredFromAccount?: string;
652
+ }
653
+ /** Subscription moved from one site to another in the same account, features enabled on the target site */
654
+ interface ReassignedFromSiteReason {
655
+ /**
656
+ * Information about a transfer from another site.
657
+ * @format GUID
658
+ */
659
+ reassignedFromMetasite?: string;
660
+ }
661
+ /** Subscription was floating and assigned to site, features enabled on the target site */
662
+ interface AssignedFromFloatingReason {
663
+ }
664
+ /** New subscription created and features created as enabled */
665
+ interface NewFeatureReason {
666
+ }
667
+ /** Subscription was upgraded or downgraded, as a result new features enabled, missing features disabled , quantities are updated */
668
+ interface ContractSwitchedReason {
669
+ }
670
+ /** a call to CreateFeature in features-writer, creates feature that is not attached to subscription */
671
+ interface ManualFeatureCreationReason {
672
+ }
673
+ /** Subscription created due to migration from old premium model */
674
+ interface MigratedFromLegacyReason {
675
+ }
676
+ /** Feature disabled and can be enabled in the future */
677
+ interface FeatureDisabled extends FeatureDisabledReasonOneOf {
678
+ /** Information about a feature that's no longer assigned to a site. */
679
+ unassingedToFloating?: UnAssingedToFloatingReason;
680
+ /**
681
+ * Information about a feature that's been replaced by a feature from a
682
+ * different subscription.
683
+ */
684
+ replacedByAnotherSubscription?: ReplacedByAnotherSubscriptionReason;
685
+ /**
686
+ * Information about a feature that's been reassigned to a different
687
+ * site.
688
+ */
689
+ reassignedToAnotherSite?: ReassignedToAnotherSiteReason;
690
+ /**
691
+ * Disabled feature. Includes information about the feature's new state,
692
+ * possibly its new context.
693
+ */
694
+ feature?: Feature;
695
+ /**
696
+ * ID of the meta site for which the feature has been disabled.
697
+ * @format GUID
698
+ */
699
+ metaSiteId?: string | null;
700
+ }
701
+ /** @oneof */
702
+ interface FeatureDisabledReasonOneOf {
703
+ /** Information about a feature that's no longer assigned to a site. */
704
+ unassingedToFloating?: UnAssingedToFloatingReason;
705
+ /**
706
+ * Information about a feature that's been replaced by a feature from a
707
+ * different subscription.
708
+ */
709
+ replacedByAnotherSubscription?: ReplacedByAnotherSubscriptionReason;
710
+ /**
711
+ * Information about a feature that's been reassigned to a different
712
+ * site.
713
+ */
714
+ reassignedToAnotherSite?: ReassignedToAnotherSiteReason;
715
+ }
716
+ /** Subscription was unassigned from the site and moved into floating state */
717
+ interface UnAssingedToFloatingReason {
718
+ }
719
+ /** Another subscription was assigned to the site, causing existing features on this site to be disabled */
720
+ interface ReplacedByAnotherSubscriptionReason {
721
+ }
722
+ /** Subscription was assigned to another site, causing features on the origin site to be disabled. */
723
+ interface ReassignedToAnotherSiteReason {
724
+ /**
725
+ * Information about a transfer to the site.
726
+ * @format GUID
727
+ */
728
+ reassignedToMetasite?: string;
729
+ }
730
+ /** Feature updated, for example Quota was increased due to upgrade */
731
+ interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf, FeatureUpdatedReasonOneOf {
732
+ /** Information about a feature that doesn't have a usage quota. */
733
+ booleanFeature?: BooleanFeature;
734
+ /** Information about a feature that has a usage quota. */
735
+ quotaFeature?: QuotaFeature;
736
+ /** Information about the contract switch. */
737
+ contractSwitched?: ContractSwitchedReason;
738
+ /**
739
+ * Updated feature. Includes information about the feature's new state and
740
+ * possibly its new context.
741
+ */
742
+ feature?: Feature;
743
+ }
744
+ /** @oneof */
745
+ interface FeatureUpdatedPreviousQuantityInfoOneOf {
746
+ /** Information about a feature that doesn't have a usage quota. */
747
+ booleanFeature?: BooleanFeature;
748
+ /** Information about a feature that has a usage quota. */
749
+ quotaFeature?: QuotaFeature;
750
+ }
751
+ /** @oneof */
752
+ interface FeatureUpdatedReasonOneOf {
753
+ /** Information about the contract switch. */
754
+ contractSwitched?: ContractSwitchedReason;
755
+ }
756
+ /** Feature was permanently cancelled */
757
+ interface FeatureCancelled extends FeatureCancelledReasonOneOf {
758
+ /** Information about a transfer to the account. */
759
+ transferredToAnotherAccount?: TransferredToAnotherAccountReason;
760
+ /** Information about the contract switch. */
761
+ contractSwitched?: ContractSwitchedReason;
762
+ /** Information about the feature cancellation. */
763
+ cancelRequest?: CancelRequestedReason;
764
+ /** Canceled feature. */
765
+ feature?: Feature;
766
+ /**
767
+ * Information about a transfer to the account.
768
+ * __Deprecated__. Use `reason.transferred_to_account` instead.
769
+ * @format GUID
770
+ */
771
+ transferredToAccount?: string | null;
772
+ }
773
+ /** @oneof */
774
+ interface FeatureCancelledReasonOneOf {
775
+ /** Information about a transfer to the account. */
776
+ transferredToAnotherAccount?: TransferredToAnotherAccountReason;
777
+ /** Information about the contract switch. */
778
+ contractSwitched?: ContractSwitchedReason;
779
+ /** Information about the feature cancellation. */
780
+ cancelRequest?: CancelRequestedReason;
781
+ }
782
+ /** Subscription was transferred to another account, features in the origin account were cancelled */
783
+ interface TransferredToAnotherAccountReason {
784
+ /**
785
+ * Information about a transfer to the account.
786
+ * @format GUID
787
+ */
788
+ transferredToAccount?: string;
789
+ }
790
+ /** Cancellation was requested from the subscription manager api, might be a result of billing event, or direct call */
791
+ interface CancelRequestedReason {
792
+ }
793
+ interface Empty {
794
+ }
795
+ interface LoyaltyAppInstallation {
796
+ type?: V1TypeWithLiterals;
797
+ }
798
+ declare enum V1Type {
799
+ UNSPECIFIED = "UNSPECIFIED",
800
+ INSTALLED = "INSTALLED",
801
+ DELETED = "DELETED"
802
+ }
803
+ /** @enumType */
804
+ type V1TypeWithLiterals = V1Type | 'UNSPECIFIED' | 'INSTALLED' | 'DELETED';
805
+ interface DomainEvent extends DomainEventBodyOneOf {
806
+ createdEvent?: EntityCreatedEvent;
807
+ updatedEvent?: EntityUpdatedEvent;
808
+ deletedEvent?: EntityDeletedEvent;
809
+ actionEvent?: ActionEvent;
810
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
811
+ id?: string;
812
+ /**
813
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
814
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
815
+ */
816
+ entityFqdn?: string;
817
+ /**
818
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
819
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
820
+ */
821
+ slug?: string;
822
+ /** ID of the entity associated with the event. */
823
+ entityId?: string;
824
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
825
+ eventTime?: Date | null;
826
+ /**
827
+ * Whether the event was triggered as a result of a privacy regulation application
828
+ * (for example, GDPR).
829
+ */
830
+ triggeredByAnonymizeRequest?: boolean | null;
831
+ /** If present, indicates the action that triggered the event. */
832
+ originatedFrom?: string | null;
833
+ /**
834
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
835
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
836
+ */
837
+ entityEventSequence?: string | null;
838
+ }
839
+ /** @oneof */
840
+ interface DomainEventBodyOneOf {
841
+ createdEvent?: EntityCreatedEvent;
842
+ updatedEvent?: EntityUpdatedEvent;
843
+ deletedEvent?: EntityDeletedEvent;
844
+ actionEvent?: ActionEvent;
845
+ }
846
+ interface EntityCreatedEvent {
847
+ entityAsJson?: string;
848
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
849
+ restoreInfo?: RestoreInfo;
850
+ }
851
+ interface RestoreInfo {
852
+ deletedDate?: Date | null;
853
+ }
854
+ interface EntityUpdatedEvent {
855
+ /**
856
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
857
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
858
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
859
+ */
860
+ currentEntityAsJson?: string;
861
+ }
862
+ interface EntityDeletedEvent {
863
+ /** Entity that was deleted. */
864
+ deletedEntityAsJson?: string | null;
865
+ }
866
+ interface ActionEvent {
867
+ bodyAsJson?: string;
868
+ }
869
+ interface MessageEnvelope {
870
+ /**
871
+ * App instance ID.
872
+ * @format GUID
873
+ */
874
+ instanceId?: string | null;
875
+ /**
876
+ * Event type.
877
+ * @maxLength 150
878
+ */
879
+ eventType?: string;
880
+ /** The identification type and identity data. */
881
+ identity?: IdentificationData;
882
+ /** Stringify payload. */
883
+ data?: string;
884
+ }
885
+ interface IdentificationData extends IdentificationDataIdOneOf {
886
+ /**
887
+ * ID of a site visitor that has not logged in to the site.
888
+ * @format GUID
889
+ */
890
+ anonymousVisitorId?: string;
891
+ /**
892
+ * ID of a site visitor that has logged in to the site.
893
+ * @format GUID
894
+ */
895
+ memberId?: string;
896
+ /**
897
+ * ID of a Wix user (site owner, contributor, etc.).
898
+ * @format GUID
899
+ */
900
+ wixUserId?: string;
901
+ /**
902
+ * ID of an app.
903
+ * @format GUID
904
+ */
905
+ appId?: string;
906
+ /** @readonly */
907
+ identityType?: WebhookIdentityTypeWithLiterals;
908
+ }
909
+ /** @oneof */
910
+ interface IdentificationDataIdOneOf {
911
+ /**
912
+ * ID of a site visitor that has not logged in to the site.
913
+ * @format GUID
914
+ */
915
+ anonymousVisitorId?: string;
916
+ /**
917
+ * ID of a site visitor that has logged in to the site.
918
+ * @format GUID
919
+ */
920
+ memberId?: string;
921
+ /**
922
+ * ID of a Wix user (site owner, contributor, etc.).
923
+ * @format GUID
924
+ */
925
+ wixUserId?: string;
926
+ /**
927
+ * ID of an app.
928
+ * @format GUID
929
+ */
930
+ appId?: string;
931
+ }
932
+ declare enum WebhookIdentityType {
933
+ UNKNOWN = "UNKNOWN",
934
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
935
+ MEMBER = "MEMBER",
936
+ WIX_USER = "WIX_USER",
937
+ APP = "APP"
938
+ }
939
+ /** @enumType */
940
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
215
941
 
216
942
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
217
943
  getUrl: (context: any) => string;
@@ -232,4 +958,4 @@ declare function getLoyaltyProgramPremiumFeatures(): __PublicMethodMetaInfo<'GET
232
958
  declare function enablePointsExpiration(): __PublicMethodMetaInfo<'POST', {}, EnablePointsExpirationRequest$1, EnablePointsExpirationRequest, EnablePointsExpirationResponse$1, EnablePointsExpirationResponse>;
233
959
  declare function disablePointsExpiration(): __PublicMethodMetaInfo<'POST', {}, DisablePointsExpirationRequest$1, DisablePointsExpirationRequest, DisablePointsExpirationResponse$1, DisablePointsExpirationResponse>;
234
960
 
235
- export { type __PublicMethodMetaInfo, activateLoyaltyProgram, bulkGetLoyaltyProgram, disablePointsExpiration, enablePointsExpiration, getLoyaltyProgram, getLoyaltyProgramPremiumFeatures, pauseLoyaltyProgram, updateLoyaltyProgram };
961
+ export { type ActionEvent as ActionEventOriginal, type ActivateLoyaltyProgramRequest as ActivateLoyaltyProgramRequestOriginal, type ActivateLoyaltyProgramResponse as ActivateLoyaltyProgramResponseOriginal, type AssignedFromFloatingReason as AssignedFromFloatingReasonOriginal, type BooleanFeature as BooleanFeatureOriginal, type BulkGetLoyaltyProgramRequest as BulkGetLoyaltyProgramRequestOriginal, type BulkGetLoyaltyProgramResponse as BulkGetLoyaltyProgramResponseOriginal, type CancelRequestedReason as CancelRequestedReasonOriginal, type ContractSwitchedReason as ContractSwitchedReasonOriginal, type DisablePointsExpirationRequest as DisablePointsExpirationRequestOriginal, type DisablePointsExpirationResponse as DisablePointsExpirationResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EnablePointsExpirationRequest as EnablePointsExpirationRequestOriginal, type EnablePointsExpirationResponse as EnablePointsExpirationResponseOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type FeatureCancelled as FeatureCancelledOriginal, type FeatureCancelledReasonOneOf as FeatureCancelledReasonOneOfOriginal, type FeatureContext as FeatureContextOriginal, type FeatureDisabled as FeatureDisabledOriginal, type FeatureDisabledReasonOneOf as FeatureDisabledReasonOneOfOriginal, type FeatureEnabled as FeatureEnabledOriginal, type FeatureEnabledReasonOneOf as FeatureEnabledReasonOneOfOriginal, type FeatureEventEventOneOf as FeatureEventEventOneOfOriginal, type FeatureEvent as FeatureEventOriginal, type Feature as FeatureOriginal, FeaturePeriod as FeaturePeriodOriginal, type FeaturePeriodWithLiterals as FeaturePeriodWithLiteralsOriginal, type FeatureQuantityInfoOneOf as FeatureQuantityInfoOneOfOriginal, type FeatureUpdated as FeatureUpdatedOriginal, type FeatureUpdatedPreviousQuantityInfoOneOf as FeatureUpdatedPreviousQuantityInfoOneOfOriginal, type FeatureUpdatedReasonOneOf as FeatureUpdatedReasonOneOfOriginal, type FocalPoint as FocalPointOriginal, type GetLoyaltyProgramDescriptionRequest as GetLoyaltyProgramDescriptionRequestOriginal, type GetLoyaltyProgramDescriptionResponse as GetLoyaltyProgramDescriptionResponseOriginal, type GetLoyaltyProgramPremiumFeaturesRequest as GetLoyaltyProgramPremiumFeaturesRequestOriginal, type GetLoyaltyProgramPremiumFeaturesResponse as GetLoyaltyProgramPremiumFeaturesResponseOriginal, type GetLoyaltyProgramRequest as GetLoyaltyProgramRequestOriginal, type GetLoyaltyProgramResponse as GetLoyaltyProgramResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type LoyaltyAppInstallation as LoyaltyAppInstallationOriginal, type LoyaltyProgramActivated as LoyaltyProgramActivatedOriginal, type LoyaltyProgramDescriptionUpdated as LoyaltyProgramDescriptionUpdatedOriginal, type LoyaltyProgram as LoyaltyProgramOriginal, type ManualFeatureCreationReason as ManualFeatureCreationReasonOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MigratedFromLegacyReason as MigratedFromLegacyReasonOriginal, type NewFeatureReason as NewFeatureReasonOriginal, type PauseLoyaltyProgramRequest as PauseLoyaltyProgramRequestOriginal, type PauseLoyaltyProgramResponse as PauseLoyaltyProgramResponseOriginal, type PointDefinition as PointDefinitionOriginal, type PointsExpirationChanges as PointsExpirationChangesOriginal, type PointsExpirationConfigurationChanged as PointsExpirationConfigurationChangedOriginal, type PointsExpirationDisabled as PointsExpirationDisabledOriginal, type PointsExpirationEnabled as PointsExpirationEnabledOriginal, type PointsExpiration as PointsExpirationOriginal, type PremiumFeatures as PremiumFeaturesOriginal, type ProgramInSite as ProgramInSiteOriginal, ProgramStatus as ProgramStatusOriginal, type ProgramStatusWithLiterals as ProgramStatusWithLiteralsOriginal, type QuotaFeature as QuotaFeatureOriginal, type QuotaInfoEntry as QuotaInfoEntryOriginal, type QuotaInfo as QuotaInfoOriginal, type ReassignedFromSiteReason as ReassignedFromSiteReasonOriginal, type ReassignedToAnotherSiteReason as ReassignedToAnotherSiteReasonOriginal, type ReplacedByAnotherSubscriptionReason as ReplacedByAnotherSubscriptionReasonOriginal, type RestoreInfo as RestoreInfoOriginal, type SocialMediaChannel as SocialMediaChannelOriginal, type SocialMediaSettings as SocialMediaSettingsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type TransferredFromAnotherAccountReason as TransferredFromAnotherAccountReasonOriginal, type TransferredToAnotherAccountReason as TransferredToAnotherAccountReasonOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UnAssingedToFloatingReason as UnAssingedToFloatingReasonOriginal, type UpdateLoyaltyProgramDescriptionRequest as UpdateLoyaltyProgramDescriptionRequestOriginal, type UpdateLoyaltyProgramDescriptionResponse as UpdateLoyaltyProgramDescriptionResponseOriginal, type UpdateLoyaltyProgramRequest as UpdateLoyaltyProgramRequestOriginal, type UpdateLoyaltyProgramResponse as UpdateLoyaltyProgramResponseOriginal, V1Type as V1TypeOriginal, type V1TypeWithLiterals as V1TypeWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, activateLoyaltyProgram, bulkGetLoyaltyProgram, disablePointsExpiration, enablePointsExpiration, getLoyaltyProgram, getLoyaltyProgramPremiumFeatures, pauseLoyaltyProgram, updateLoyaltyProgram };