@wix/auto_sdk_referral_programs 1.0.10 → 1.0.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/src/loyalty-referral-v1-program-programs.types.d.ts +71 -39
- package/build/cjs/src/loyalty-referral-v1-program-programs.types.js.map +1 -1
- package/build/cjs/src/loyalty-referral-v1-program-programs.universal.d.ts +79 -55
- package/build/cjs/src/loyalty-referral-v1-program-programs.universal.js.map +1 -1
- package/build/es/src/loyalty-referral-v1-program-programs.types.d.ts +71 -39
- package/build/es/src/loyalty-referral-v1-program-programs.types.js.map +1 -1
- package/build/es/src/loyalty-referral-v1-program-programs.universal.d.ts +79 -55
- package/build/es/src/loyalty-referral-v1-program-programs.universal.js.map +1 -1
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.types.d.ts +71 -39
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.types.js.map +1 -1
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.universal.d.ts +79 -55
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.universal.js.map +1 -1
- package/build/internal/es/src/loyalty-referral-v1-program-programs.types.d.ts +71 -39
- package/build/internal/es/src/loyalty-referral-v1-program-programs.types.js.map +1 -1
- package/build/internal/es/src/loyalty-referral-v1-program-programs.universal.d.ts +79 -55
- package/build/internal/es/src/loyalty-referral-v1-program-programs.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -6,7 +6,7 @@ export interface ReferralProgram {
|
|
|
6
6
|
*/
|
|
7
7
|
name?: string | null;
|
|
8
8
|
/** @readonly */
|
|
9
|
-
status?:
|
|
9
|
+
status?: ProgramStatusWithLiterals;
|
|
10
10
|
/**
|
|
11
11
|
* Revision number, which increments by 1 each time the program is updated.
|
|
12
12
|
* To prevent conflicting changes, the current `revision` must be passed when updating the program.
|
|
@@ -37,7 +37,7 @@ export interface ReferralProgram {
|
|
|
37
37
|
* List of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an item.
|
|
38
38
|
* @maxSize 100
|
|
39
39
|
*/
|
|
40
|
-
successfulReferralActions?:
|
|
40
|
+
successfulReferralActions?: ActionWithLiterals[];
|
|
41
41
|
/** Configures email notifications for the referral program. */
|
|
42
42
|
emails?: Emails;
|
|
43
43
|
/**
|
|
@@ -57,13 +57,15 @@ export declare enum ProgramStatus {
|
|
|
57
57
|
/** Referral program is paused. */
|
|
58
58
|
PAUSED = "PAUSED"
|
|
59
59
|
}
|
|
60
|
+
/** @enumType */
|
|
61
|
+
export type ProgramStatusWithLiterals = ProgramStatus | 'UNKNOWN' | 'DRAFT' | 'ACTIVE' | 'PAUSED';
|
|
60
62
|
export interface Reward extends RewardOptionsOneOf {
|
|
61
63
|
/** Options for coupon reward type. */
|
|
62
64
|
couponOptions?: Coupon;
|
|
63
65
|
/** Options for the Loyalty points reward type. */
|
|
64
66
|
loyaltyPointsOptions?: LoyaltyPoints;
|
|
65
67
|
/** Type of the reward. */
|
|
66
|
-
type?:
|
|
68
|
+
type?: TypeWithLiterals;
|
|
67
69
|
}
|
|
68
70
|
/** @oneof */
|
|
69
71
|
export interface RewardOptionsOneOf {
|
|
@@ -82,6 +84,8 @@ export declare enum Type {
|
|
|
82
84
|
/** No reward type. */
|
|
83
85
|
NOTHING = "NOTHING"
|
|
84
86
|
}
|
|
87
|
+
/** @enumType */
|
|
88
|
+
export type TypeWithLiterals = Type | 'UNKNOWN' | 'COUPON' | 'LOYALTY_POINTS' | 'NOTHING';
|
|
85
89
|
export interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
|
|
86
90
|
/** Options for fixed amount discount. */
|
|
87
91
|
fixedAmountOptions?: FixedAmountDiscount;
|
|
@@ -98,7 +102,7 @@ export interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMin
|
|
|
98
102
|
*/
|
|
99
103
|
name?: string;
|
|
100
104
|
/** Coupon discount type. */
|
|
101
|
-
discountType?:
|
|
105
|
+
discountType?: DiscountTypeWithLiterals;
|
|
102
106
|
/**
|
|
103
107
|
* Whether the coupon is limited to one item.
|
|
104
108
|
* If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.
|
|
@@ -142,6 +146,8 @@ export declare enum DiscountType {
|
|
|
142
146
|
/** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
|
|
143
147
|
FREE_SHIPPING = "FREE_SHIPPING"
|
|
144
148
|
}
|
|
149
|
+
/** @enumType */
|
|
150
|
+
export type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN' | 'FIXED_AMOUNT' | 'PERCENTAGE' | 'FREE_SHIPPING';
|
|
145
151
|
export interface FixedAmountDiscount {
|
|
146
152
|
/** Amount of the discount as a fixed value. */
|
|
147
153
|
amount?: number;
|
|
@@ -189,9 +195,11 @@ export declare enum Action {
|
|
|
189
195
|
/** Referred friend joined an online program. */
|
|
190
196
|
ONLINE_PROGRAM_JOINED = "ONLINE_PROGRAM_JOINED"
|
|
191
197
|
}
|
|
198
|
+
/** @enumType */
|
|
199
|
+
export type ActionWithLiterals = Action | 'UNKNOWN' | 'STORE_ORDER_PLACED' | 'PLAN_ORDERED' | 'TICKET_ORDERED' | 'SESSION_BOOKED' | 'RESTAURANT_ORDER_PLACED' | 'ONLINE_PROGRAM_JOINED';
|
|
192
200
|
export interface Emails {
|
|
193
201
|
/** Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled. */
|
|
194
|
-
encourageToReferFriends?:
|
|
202
|
+
encourageToReferFriends?: AppWithLiterals[];
|
|
195
203
|
/**
|
|
196
204
|
* Whether to send email notifications to referring customers when they receive a referral reward.
|
|
197
205
|
* If true, referring customers will be notified by email when their referred friend completes a qualifying action (for example, placing an order).
|
|
@@ -214,6 +222,8 @@ export declare enum App {
|
|
|
214
222
|
/** Send an email to customers who've joined an online program. */
|
|
215
223
|
ONLINE_PROGRAMS = "ONLINE_PROGRAMS"
|
|
216
224
|
}
|
|
225
|
+
/** @enumType */
|
|
226
|
+
export type AppWithLiterals = App | 'UNKNOWN' | 'STORES' | 'PRICING_PLANS' | 'EVENTS' | 'BOOKINGS' | 'RESTAURANTS' | 'ONLINE_PROGRAMS';
|
|
217
227
|
export interface PremiumFeatures {
|
|
218
228
|
/**
|
|
219
229
|
* Whether the site owner has access to the referral program feature.
|
|
@@ -327,25 +337,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
327
337
|
updatedEvent?: EntityUpdatedEvent;
|
|
328
338
|
deletedEvent?: EntityDeletedEvent;
|
|
329
339
|
actionEvent?: ActionEvent;
|
|
330
|
-
/**
|
|
331
|
-
* Unique event ID.
|
|
332
|
-
* Allows clients to ignore duplicate webhooks.
|
|
333
|
-
*/
|
|
340
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
334
341
|
id?: string;
|
|
335
342
|
/**
|
|
336
|
-
*
|
|
337
|
-
*
|
|
343
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
344
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
338
345
|
*/
|
|
339
346
|
entityFqdn?: string;
|
|
340
347
|
/**
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
* Example: created/updated/deleted/started/completed/email_opened
|
|
348
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
349
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
344
350
|
*/
|
|
345
351
|
slug?: string;
|
|
346
352
|
/** ID of the entity associated with the event. */
|
|
347
353
|
entityId?: string;
|
|
348
|
-
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example
|
|
354
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
349
355
|
eventTime?: Date | null;
|
|
350
356
|
/**
|
|
351
357
|
* Whether the event was triggered as a result of a privacy regulation application
|
|
@@ -355,12 +361,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
355
361
|
/** If present, indicates the action that triggered the event. */
|
|
356
362
|
originatedFrom?: string | null;
|
|
357
363
|
/**
|
|
358
|
-
* A sequence number
|
|
359
|
-
*
|
|
360
|
-
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
361
|
-
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
362
|
-
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
363
|
-
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
364
|
+
* 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.
|
|
365
|
+
* 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.
|
|
364
366
|
*/
|
|
365
367
|
entityEventSequence?: string | null;
|
|
366
368
|
}
|
|
@@ -388,7 +390,7 @@ export interface EntityUpdatedEvent {
|
|
|
388
390
|
currentEntityAsJson?: string;
|
|
389
391
|
}
|
|
390
392
|
export interface EntityDeletedEvent {
|
|
391
|
-
/** Entity that was deleted */
|
|
393
|
+
/** Entity that was deleted. */
|
|
392
394
|
deletedEntityAsJson?: string | null;
|
|
393
395
|
}
|
|
394
396
|
export interface ActionEvent {
|
|
@@ -524,7 +526,7 @@ export interface Asset {
|
|
|
524
526
|
*/
|
|
525
527
|
instanceId?: string;
|
|
526
528
|
/** An application state. */
|
|
527
|
-
state?:
|
|
529
|
+
state?: StateWithLiterals;
|
|
528
530
|
}
|
|
529
531
|
export declare enum State {
|
|
530
532
|
UNKNOWN = "UNKNOWN",
|
|
@@ -533,6 +535,8 @@ export declare enum State {
|
|
|
533
535
|
PENDING = "PENDING",
|
|
534
536
|
DEMO = "DEMO"
|
|
535
537
|
}
|
|
538
|
+
/** @enumType */
|
|
539
|
+
export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
536
540
|
export interface SiteCreated {
|
|
537
541
|
/**
|
|
538
542
|
* A template identifier (empty if not created from a template).
|
|
@@ -545,7 +549,7 @@ export interface SiteCreated {
|
|
|
545
549
|
*/
|
|
546
550
|
ownerId?: string;
|
|
547
551
|
/** A context in which meta site was created. */
|
|
548
|
-
context?:
|
|
552
|
+
context?: SiteCreatedContextWithLiterals;
|
|
549
553
|
/**
|
|
550
554
|
* A meta site id from which this site was created.
|
|
551
555
|
*
|
|
@@ -560,7 +564,7 @@ export interface SiteCreated {
|
|
|
560
564
|
*/
|
|
561
565
|
siteName?: string;
|
|
562
566
|
/** A namespace. */
|
|
563
|
-
namespace?:
|
|
567
|
+
namespace?: NamespaceWithLiterals;
|
|
564
568
|
}
|
|
565
569
|
export declare enum SiteCreatedContext {
|
|
566
570
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
@@ -576,6 +580,8 @@ export declare enum SiteCreatedContext {
|
|
|
576
580
|
/** deprecated A meta site was created for Flash editor. */
|
|
577
581
|
FLASH = "FLASH"
|
|
578
582
|
}
|
|
583
|
+
/** @enumType */
|
|
584
|
+
export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
579
585
|
export declare enum Namespace {
|
|
580
586
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
581
587
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
@@ -658,6 +664,8 @@ export declare enum Namespace {
|
|
|
658
664
|
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
659
665
|
MIMIR = "MIMIR"
|
|
660
666
|
}
|
|
667
|
+
/** @enumType */
|
|
668
|
+
export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
|
|
661
669
|
/** Site transferred to another user. */
|
|
662
670
|
export interface SiteTransferred {
|
|
663
671
|
/**
|
|
@@ -680,7 +688,7 @@ export interface DeleteContext {
|
|
|
680
688
|
/** When the meta site was deleted. */
|
|
681
689
|
dateDeleted?: Date | null;
|
|
682
690
|
/** A status. */
|
|
683
|
-
deleteStatus?:
|
|
691
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
684
692
|
/**
|
|
685
693
|
* A reason (flow).
|
|
686
694
|
* @maxLength 255
|
|
@@ -699,6 +707,8 @@ export declare enum DeleteStatus {
|
|
|
699
707
|
PENDING_PURGE = "PENDING_PURGE",
|
|
700
708
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
701
709
|
}
|
|
710
|
+
/** @enumType */
|
|
711
|
+
export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
702
712
|
/** Restoration of the meta site. */
|
|
703
713
|
export interface SiteUndeleted {
|
|
704
714
|
}
|
|
@@ -800,9 +810,9 @@ export interface SiteHardDeleted {
|
|
|
800
810
|
}
|
|
801
811
|
export interface NamespaceChanged {
|
|
802
812
|
/** A previous namespace. */
|
|
803
|
-
oldNamespace?:
|
|
813
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
804
814
|
/** A new namespace. */
|
|
805
|
-
newNamespace?:
|
|
815
|
+
newNamespace?: NamespaceWithLiterals;
|
|
806
816
|
}
|
|
807
817
|
/** Assigned Studio editor */
|
|
808
818
|
export interface StudioAssigned {
|
|
@@ -1053,7 +1063,7 @@ export interface Subscription {
|
|
|
1053
1063
|
* + `CANCELLED`: Subscription isn't active because it has been canceled.
|
|
1054
1064
|
* + `TRANSFERRED`: Subscription isn't active because it has been transferred to a different account. A different active subscription was created for the target account.
|
|
1055
1065
|
*/
|
|
1056
|
-
status?:
|
|
1066
|
+
status?: SubscriptionStatusWithLiterals;
|
|
1057
1067
|
/**
|
|
1058
1068
|
* Date and time the subscription was last transferred from one Wix account to
|
|
1059
1069
|
* another in
|
|
@@ -1100,7 +1110,7 @@ export interface BillingReference {
|
|
|
1100
1110
|
* + `"BASS"`: [Billing and Subscriptions System](https://dev.wix.com/docs/rest/internal-only/premium/subscriptions-by-billing-by-wix/introduction).
|
|
1101
1111
|
* + `"RESELLER"`: [External Reseller](https://dev.wix.com/api/rest/account-level-apis/resellers/introduction).
|
|
1102
1112
|
*/
|
|
1103
|
-
providerName?:
|
|
1113
|
+
providerName?: ProviderNameWithLiterals;
|
|
1104
1114
|
/** Current provider reference ID. */
|
|
1105
1115
|
providerReferenceId?: string | null;
|
|
1106
1116
|
/** Previous provider reference IDs. Used for when a subscription is extended, specifically for domains. */
|
|
@@ -1114,6 +1124,8 @@ export declare enum ProviderName {
|
|
|
1114
1124
|
RESELLER = "RESELLER",
|
|
1115
1125
|
RECURRING_INVOICES = "RECURRING_INVOICES"
|
|
1116
1126
|
}
|
|
1127
|
+
/** @enumType */
|
|
1128
|
+
export type ProviderNameWithLiterals = ProviderName | 'UNKNOWN' | 'SBS' | 'LICENSER' | 'BASS' | 'RESELLER' | 'RECURRING_INVOICES';
|
|
1117
1129
|
export interface Cycle extends CycleCycleSelectorOneOf {
|
|
1118
1130
|
/** repetitive interval */
|
|
1119
1131
|
interval?: Interval;
|
|
@@ -1129,7 +1141,7 @@ export interface CycleCycleSelectorOneOf {
|
|
|
1129
1141
|
}
|
|
1130
1142
|
export interface Interval {
|
|
1131
1143
|
/** interval unit of measure */
|
|
1132
|
-
unit?:
|
|
1144
|
+
unit?: IntervalUnitWithLiterals;
|
|
1133
1145
|
/** number of interval */
|
|
1134
1146
|
count?: number;
|
|
1135
1147
|
}
|
|
@@ -1145,6 +1157,8 @@ export declare enum IntervalUnit {
|
|
|
1145
1157
|
/** year */
|
|
1146
1158
|
YEAR = "YEAR"
|
|
1147
1159
|
}
|
|
1160
|
+
/** @enumType */
|
|
1161
|
+
export type IntervalUnitWithLiterals = IntervalUnit | 'UNKNOWN' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
1148
1162
|
export interface OneTime {
|
|
1149
1163
|
}
|
|
1150
1164
|
export declare enum SubscriptionStatus {
|
|
@@ -1155,9 +1169,11 @@ export declare enum SubscriptionStatus {
|
|
|
1155
1169
|
CANCELLED = "CANCELLED",
|
|
1156
1170
|
TRANSFERRED = "TRANSFERRED"
|
|
1157
1171
|
}
|
|
1172
|
+
/** @enumType */
|
|
1173
|
+
export type SubscriptionStatusWithLiterals = SubscriptionStatus | 'UNKNOWN' | 'AUTO_RENEW_ON' | 'AUTO_RENEW_OFF' | 'MANUAL_RECURRING' | 'CANCELLED' | 'TRANSFERRED';
|
|
1158
1174
|
/** Triggered when a subscription is reactivated. */
|
|
1159
1175
|
export interface ReactivationData {
|
|
1160
|
-
reactivationReason?:
|
|
1176
|
+
reactivationReason?: ReactivationReasonEnumWithLiterals;
|
|
1161
1177
|
/**
|
|
1162
1178
|
* In the event of reactivation after chargeback dispute, the subscription may be extended according to the
|
|
1163
1179
|
* number of days it was inactive during the time of resolving the dispute
|
|
@@ -1179,6 +1195,8 @@ export declare enum ReactivationReasonEnum {
|
|
|
1179
1195
|
/** Subscription was reactivated after a chargeback dispute */
|
|
1180
1196
|
REACTIVATED_AFTER_CHARGEBACK = "REACTIVATED_AFTER_CHARGEBACK"
|
|
1181
1197
|
}
|
|
1198
|
+
/** @enumType */
|
|
1199
|
+
export type ReactivationReasonEnumWithLiterals = ReactivationReasonEnum | 'UNKNOWN' | 'BILLING_STATUS_CHANGE' | 'REACTIVATED_AFTER_CHARGEBACK';
|
|
1182
1200
|
/**
|
|
1183
1201
|
* Triggered when a subscription is assigned to a Wix site, including the initial
|
|
1184
1202
|
* assignment of a floating subscription or a re-assignement from a different site.
|
|
@@ -1247,7 +1265,7 @@ export interface CancellationDetails {
|
|
|
1247
1265
|
* + `"APP_MANAGED"`: The service provider has canceled the subscription.
|
|
1248
1266
|
* + `"PASSIVE"`: The billing system has canceled the subscription. For example, in case of payment failure or fraud.
|
|
1249
1267
|
*/
|
|
1250
|
-
initiator?:
|
|
1268
|
+
initiator?: InitiatorWithLiterals;
|
|
1251
1269
|
}
|
|
1252
1270
|
export declare enum Initiator {
|
|
1253
1271
|
UNKNOWN = "UNKNOWN",
|
|
@@ -1255,6 +1273,8 @@ export declare enum Initiator {
|
|
|
1255
1273
|
APP_MANAGED = "APP_MANAGED",
|
|
1256
1274
|
PASSIVE = "PASSIVE"
|
|
1257
1275
|
}
|
|
1276
|
+
/** @enumType */
|
|
1277
|
+
export type InitiatorWithLiterals = Initiator | 'UNKNOWN' | 'USER_REQUESTED' | 'APP_MANAGED' | 'PASSIVE';
|
|
1258
1278
|
/** Triggered when the subscription's auto renew is turned on. */
|
|
1259
1279
|
export interface SubscriptionAutoRenewTurnedOn {
|
|
1260
1280
|
/** Subscription for which auto renew is turned on. */
|
|
@@ -1300,13 +1320,15 @@ export interface SubscriptionUnassigned {
|
|
|
1300
1320
|
* + `"USER_REQUESTED"`: The Wix account owner has unassigned the subscription.
|
|
1301
1321
|
* + `"REPLACED_BY_ANOTHER_SUBSCRIPTION"`: A different subscription that replaces this subscription is assigned to the site.
|
|
1302
1322
|
*/
|
|
1303
|
-
unassignReason?:
|
|
1323
|
+
unassignReason?: UnassignReasonWithLiterals;
|
|
1304
1324
|
}
|
|
1305
1325
|
export declare enum UnassignReason {
|
|
1306
1326
|
UNKNOWN = "UNKNOWN",
|
|
1307
1327
|
USER_REQUESTED = "USER_REQUESTED",
|
|
1308
1328
|
REPLACED_BY_ANOTHER_SUBSCRIPTION = "REPLACED_BY_ANOTHER_SUBSCRIPTION"
|
|
1309
1329
|
}
|
|
1330
|
+
/** @enumType */
|
|
1331
|
+
export type UnassignReasonWithLiterals = UnassignReason | 'UNKNOWN' | 'USER_REQUESTED' | 'REPLACED_BY_ANOTHER_SUBSCRIPTION';
|
|
1310
1332
|
/**
|
|
1311
1333
|
* Triggered when a subscription is transferred from one Wix account to another.
|
|
1312
1334
|
* A transfer includes cancelling the original subscription and creating a new
|
|
@@ -1360,7 +1382,7 @@ export interface ContractSwitched {
|
|
|
1360
1382
|
* + `"PENDING_CHANGES"`: The subscription's billing is updated, but the change doesn't apply immediately. Instead, the update becomes effective at the end of current billing cycle.
|
|
1361
1383
|
* + `"DOWNGRADE_RENEWAL"`: The subscription is downgraded because of a declined payment. This prevents subscriptions from churning.
|
|
1362
1384
|
*/
|
|
1363
|
-
contractSwitchType?:
|
|
1385
|
+
contractSwitchType?: ContractSwitchTypeWithLiterals;
|
|
1364
1386
|
/**
|
|
1365
1387
|
* ID of the metasite the subscription has been assigned to previously.
|
|
1366
1388
|
* Available only in case the subscription is assigned to a different site.
|
|
@@ -1373,7 +1395,7 @@ export interface ContractSwitched {
|
|
|
1373
1395
|
* + `"PRICE_INCREASE"`: The subscription's price has been increased.
|
|
1374
1396
|
* + `"EXTERNAL_PROVIDER_TRIGGER"`: Any reason other than a price increase.
|
|
1375
1397
|
*/
|
|
1376
|
-
contractSwitchReason?:
|
|
1398
|
+
contractSwitchReason?: ContractSwitchReasonWithLiterals;
|
|
1377
1399
|
/** Information about the price update. Available only for updates with a price increase. */
|
|
1378
1400
|
productPriceIncreaseData?: ProductPriceIncreaseData;
|
|
1379
1401
|
/**
|
|
@@ -1383,7 +1405,7 @@ export interface ContractSwitched {
|
|
|
1383
1405
|
* + `NOT_APPLICABLE`: There is no information about whether the product has been up- or downgraded.
|
|
1384
1406
|
* + `DOWNGRADE`: The product has been downgraded.
|
|
1385
1407
|
*/
|
|
1386
|
-
productAdjustment?:
|
|
1408
|
+
productAdjustment?: ProductAdjustmentWithLiterals;
|
|
1387
1409
|
}
|
|
1388
1410
|
/** Copied from SBS */
|
|
1389
1411
|
export declare enum ContractSwitchType {
|
|
@@ -1398,10 +1420,14 @@ export declare enum ContractSwitchType {
|
|
|
1398
1420
|
PENDING_CHANGES = "PENDING_CHANGES",
|
|
1399
1421
|
DOWNGRADE_RENEWAL = "DOWNGRADE_RENEWAL"
|
|
1400
1422
|
}
|
|
1423
|
+
/** @enumType */
|
|
1424
|
+
export type ContractSwitchTypeWithLiterals = ContractSwitchType | 'NOT_APPLICABLE' | 'ADDITIONAL_QUANTITY' | 'CREDIT_UNUSED_PERIOD' | 'REFUND_PRICE_DIFF' | 'ADJUST_PERIOD_END' | 'DOWNGRADE_GRACE_PERIOD' | 'FULL_AMOUNT_PERIOD' | 'END_OF_PERIOD' | 'PENDING_CHANGES' | 'DOWNGRADE_RENEWAL';
|
|
1401
1425
|
export declare enum ContractSwitchReason {
|
|
1402
1426
|
EXTERNAL_PROVIDER_TRIGGER = "EXTERNAL_PROVIDER_TRIGGER",
|
|
1403
1427
|
PRICE_INCREASE = "PRICE_INCREASE"
|
|
1404
1428
|
}
|
|
1429
|
+
/** @enumType */
|
|
1430
|
+
export type ContractSwitchReasonWithLiterals = ContractSwitchReason | 'EXTERNAL_PROVIDER_TRIGGER' | 'PRICE_INCREASE';
|
|
1405
1431
|
/** Triggered when a subscription's price is increased. */
|
|
1406
1432
|
export interface ProductPriceIncreaseData {
|
|
1407
1433
|
/**
|
|
@@ -1414,7 +1440,7 @@ export interface ProductPriceIncreaseData {
|
|
|
1414
1440
|
/** Used to differentiate between migration segments. Does not have to be unique per segment. */
|
|
1415
1441
|
segmentName?: string | null;
|
|
1416
1442
|
/** Used to determine how the price increase was triggered. */
|
|
1417
|
-
priceIncreaseTrigger?:
|
|
1443
|
+
priceIncreaseTrigger?: PriceIncreaseTriggerWithLiterals;
|
|
1418
1444
|
}
|
|
1419
1445
|
/** Reason for Price Increase Trigger */
|
|
1420
1446
|
export declare enum PriceIncreaseTrigger {
|
|
@@ -1422,6 +1448,8 @@ export declare enum PriceIncreaseTrigger {
|
|
|
1422
1448
|
RECURRING_SUCCESS = "RECURRING_SUCCESS",
|
|
1423
1449
|
MANUAL = "MANUAL"
|
|
1424
1450
|
}
|
|
1451
|
+
/** @enumType */
|
|
1452
|
+
export type PriceIncreaseTriggerWithLiterals = PriceIncreaseTrigger | 'NEAR_RENEWAL' | 'RECURRING_SUCCESS' | 'MANUAL';
|
|
1425
1453
|
/** Triggered when a subscription's product is adusted. */
|
|
1426
1454
|
export declare enum ProductAdjustment {
|
|
1427
1455
|
/** flag to show that the ContractSwitchedEvent is not applicable / needed */
|
|
@@ -1429,6 +1457,8 @@ export declare enum ProductAdjustment {
|
|
|
1429
1457
|
/** flag to show that the ContractSwitchedEvent is a Downgrade */
|
|
1430
1458
|
DOWNGRADE = "DOWNGRADE"
|
|
1431
1459
|
}
|
|
1460
|
+
/** @enumType */
|
|
1461
|
+
export type ProductAdjustmentWithLiterals = ProductAdjustment | 'NOT_APPLICABLE' | 'DOWNGRADE';
|
|
1432
1462
|
/**
|
|
1433
1463
|
* Triggered when a subscription gets close to the end of its billing cycle.
|
|
1434
1464
|
* The exact number of days is defined in the billing system.
|
|
@@ -1490,7 +1520,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1490
1520
|
*/
|
|
1491
1521
|
appId?: string;
|
|
1492
1522
|
/** @readonly */
|
|
1493
|
-
identityType?:
|
|
1523
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1494
1524
|
}
|
|
1495
1525
|
/** @oneof */
|
|
1496
1526
|
export interface IdentificationDataIdOneOf {
|
|
@@ -1522,3 +1552,5 @@ export declare enum WebhookIdentityType {
|
|
|
1522
1552
|
WIX_USER = "WIX_USER",
|
|
1523
1553
|
APP = "APP"
|
|
1524
1554
|
}
|
|
1555
|
+
/** @enumType */
|
|
1556
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"loyalty-referral-v1-program-programs.types.js","sourceRoot":"","sources":["../../../src/loyalty-referral-v1-program-programs.types.ts"],"names":[],"mappings":";;;AAiDA,sCAAsC;AACtC,IAAY,aASX;AATD,WAAY,aAAa;IACvB,8BAA8B;IAC9B,oCAAmB,CAAA;IACnB,wFAAwF;IACxF,gCAAe,CAAA;IACf,kCAAkC;IAClC,kCAAiB,CAAA;IACjB,kCAAkC;IAClC,kCAAiB,CAAA;AACnB,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB;
|
|
1
|
+
{"version":3,"file":"loyalty-referral-v1-program-programs.types.js","sourceRoot":"","sources":["../../../src/loyalty-referral-v1-program-programs.types.ts"],"names":[],"mappings":";;;AAiDA,sCAAsC;AACtC,IAAY,aASX;AATD,WAAY,aAAa;IACvB,8BAA8B;IAC9B,oCAAmB,CAAA;IACnB,wFAAwF;IACxF,gCAAe,CAAA;IACf,kCAAkC;IAClC,kCAAiB,CAAA;IACjB,kCAAkC;IAClC,kCAAiB,CAAA;AACnB,CAAC,EATW,aAAa,6BAAb,aAAa,QASxB;AA2BD,IAAY,IASX;AATD,WAAY,IAAI;IACd,2BAA2B;IAC3B,2BAAmB,CAAA;IACnB,0BAA0B;IAC1B,yBAAiB,CAAA;IACjB,kCAAkC;IAClC,yCAAiC,CAAA;IACjC,sBAAsB;IACtB,2BAAmB,CAAA;AACrB,CAAC,EATW,IAAI,oBAAJ,IAAI,QASf;AAiED,IAAY,YASX;AATD,WAAY,YAAY;IACtB,6BAA6B;IAC7B,mCAAmB,CAAA;IACnB,kCAAkC;IAClC,6CAA6B,CAAA;IAC7B,gCAAgC;IAChC,yCAAyB,CAAA;IACzB,qFAAqF;IACrF,+CAA+B,CAAA;AACjC,CAAC,EATW,YAAY,4BAAZ,YAAY,QASvB;AA8CD,IAAY,MAeX;AAfD,WAAY,MAAM;IAChB,sBAAsB;IACtB,6BAAmB,CAAA;IACnB,gEAAgE;IAChE,mDAAyC,CAAA;IACzC,mDAAmD;IACnD,uCAA6B,CAAA;IAC7B,qDAAqD;IACrD,2CAAiC,CAAA;IACjC,qDAAqD;IACrD,2CAAiC,CAAA;IACjC,8DAA8D;IAC9D,6DAAmD,CAAA;IACnD,gDAAgD;IAChD,yDAA+C,CAAA;AACjD,CAAC,EAfW,MAAM,sBAAN,MAAM,QAejB;AAuBD,IAAY,GAeX;AAfD,WAAY,GAAG;IACb,mBAAmB;IACnB,0BAAmB,CAAA;IACnB,qEAAqE;IACrE,wBAAiB,CAAA;IACjB,4EAA4E;IAC5E,sCAA+B,CAAA;IAC/B,qEAAqE;IACrE,wBAAiB,CAAA;IACjB,uEAAuE;IACvE,4BAAqB,CAAA;IACrB,0EAA0E;IAC1E,kCAA2B,CAAA;IAC3B,kEAAkE;IAClE,0CAAmC,CAAA;AACrC,CAAC,EAfW,GAAG,mBAAH,GAAG,QAed;AAqVD,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;AAyCD,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;AAYD,IAAY,SAiFX;AAjFD,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;IACjD,uHAAuH;IACvH,kDAAqC,CAAA;IACrC,wHAAwH;IACxH,oDAAuC,CAAA;IACvC,wDAAwD;IACxD,4BAAe,CAAA;AACjB,CAAC,EAjFW,SAAS,yBAAT,SAAS,QAiFpB;AAyED,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,+BAAe,CAAA;IACf,mCAAmB,CAAA;IACnB,+CAA+B,CAAA;IAC/B,uDAAuC,CAAA;AACzC,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AAgbD,IAAY,YAOX;AAPD,WAAY,YAAY;IACtB,mCAAmB,CAAA;IACnB,2BAAW,CAAA;IACX,qCAAqB,CAAA;IACrB,6BAAa,CAAA;IACb,qCAAqB,CAAA;IACrB,yDAAyC,CAAA;AAC3C,CAAC,EAPW,YAAY,4BAAZ,YAAY,QAOvB;AAkCD,IAAY,YAWX;AAXD,WAAY,YAAY;IACtB,4BAA4B;IAC5B,mCAAmB,CAAA;IACnB,UAAU;IACV,2BAAW,CAAA;IACX,WAAW;IACX,6BAAa,CAAA;IACb,YAAY;IACZ,+BAAe,CAAA;IACf,WAAW;IACX,6BAAa,CAAA;AACf,CAAC,EAXW,YAAY,4BAAZ,YAAY,QAWvB;AAaD,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC5B,yCAAmB,CAAA;IACnB,qDAA+B,CAAA;IAC/B,uDAAiC,CAAA;IACjC,2DAAqC,CAAA;IACrC,6CAAuB,CAAA;IACvB,iDAA2B,CAAA;AAC7B,CAAC,EAPW,kBAAkB,kCAAlB,kBAAkB,QAO7B;AA0BD,2CAA2C;AAC3C,IAAY,sBASX;AATD,WAAY,sBAAsB;IAChC,6CAAmB,CAAA;IACnB;;;OAGG;IACH,yEAA+C,CAAA;IAC/C,8DAA8D;IAC9D,uFAA6D,CAAA;AAC/D,CAAC,EATW,sBAAsB,sCAAtB,sBAAsB,QASjC;AAkFD,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,8CAAiC,CAAA;IACjC,wCAA2B,CAAA;IAC3B,gCAAmB,CAAA;AACrB,CAAC,EALW,SAAS,yBAAT,SAAS,QAKpB;AA4DD,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,qCAAmB,CAAA;IACnB,mDAAiC,CAAA;IACjC,uFAAqE,CAAA;AACvE,CAAC,EAJW,cAAc,8BAAd,cAAc,QAIzB;AA0FD,sBAAsB;AACtB,IAAY,kBAWX;AAXD,WAAY,kBAAkB;IAC5B,uDAAiC,CAAA;IACjC,iEAA2C,CAAA;IAC3C,mEAA6C,CAAA;IAC7C,6DAAuC,CAAA;IACvC,6DAAuC,CAAA;IACvC,uEAAiD,CAAA;IACjD,+DAAyC,CAAA;IACzC,qDAA+B,CAAA;IAC/B,yDAAmC,CAAA;IACnC,6DAAuC,CAAA;AACzC,CAAC,EAXW,kBAAkB,kCAAlB,kBAAkB,QAW7B;AAgBD,IAAY,oBAGX;AAHD,WAAY,oBAAoB;IAC9B,+EAAuD,CAAA;IACvD,yDAAiC,CAAA;AACnC,CAAC,EAHW,oBAAoB,oCAApB,oBAAoB,QAG/B;AAuBD,wCAAwC;AACxC,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,qDAA6B,CAAA;IAC7B,+DAAuC,CAAA;IACvC,yCAAiB,CAAA;AACnB,CAAC,EAJW,oBAAoB,oCAApB,oBAAoB,QAI/B;AASD,0DAA0D;AAC1D,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,6EAA6E;IAC7E,sDAAiC,CAAA;IACjC,iEAAiE;IACjE,4CAAuB,CAAA;AACzB,CAAC,EALW,iBAAiB,iCAAjB,iBAAiB,QAK5B;AAoGD,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"}
|