@wix/auto_sdk_referral_programs 1.0.13 → 1.0.14

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 (134) hide show
  1. package/build/index.d.mts +81 -0
  2. package/build/index.d.ts +81 -0
  3. package/build/index.js +991 -0
  4. package/build/index.js.map +1 -0
  5. package/build/index.mjs +939 -0
  6. package/build/index.mjs.map +1 -0
  7. package/build/internal/index.d.mts +93 -0
  8. package/build/internal/index.d.ts +93 -0
  9. package/build/internal/index.js +991 -0
  10. package/build/internal/index.js.map +1 -0
  11. package/build/internal/index.mjs +939 -0
  12. package/build/internal/index.mjs.map +1 -0
  13. package/build/{cjs/src/loyalty-referral-v1-program-programs.types.d.ts → internal/loyalty-referral-v1-program-programs.universal-C3JvbwiY.d.mts} +205 -143
  14. package/build/internal/{cjs/src/loyalty-referral-v1-program-programs.types.d.ts → loyalty-referral-v1-program-programs.universal-C3JvbwiY.d.ts} +205 -143
  15. package/build/internal/meta.d.mts +357 -0
  16. package/build/internal/meta.d.ts +357 -0
  17. package/build/internal/meta.js +606 -0
  18. package/build/internal/meta.js.map +1 -0
  19. package/build/internal/meta.mjs +572 -0
  20. package/build/internal/meta.mjs.map +1 -0
  21. package/build/{es/src/loyalty-referral-v1-program-programs.types.d.ts → loyalty-referral-v1-program-programs.universal-BCsb8iST.d.mts} +205 -143
  22. package/build/{internal/es/src/loyalty-referral-v1-program-programs.types.d.ts → loyalty-referral-v1-program-programs.universal-BCsb8iST.d.ts} +205 -143
  23. package/build/meta.d.mts +357 -0
  24. package/build/meta.d.ts +357 -0
  25. package/build/meta.js +606 -0
  26. package/build/meta.js.map +1 -0
  27. package/build/meta.mjs +572 -0
  28. package/build/meta.mjs.map +1 -0
  29. package/package.json +12 -11
  30. package/build/cjs/index.d.ts +0 -1
  31. package/build/cjs/index.js +0 -18
  32. package/build/cjs/index.js.map +0 -1
  33. package/build/cjs/index.typings.d.ts +0 -1
  34. package/build/cjs/index.typings.js +0 -18
  35. package/build/cjs/index.typings.js.map +0 -1
  36. package/build/cjs/meta.d.ts +0 -1
  37. package/build/cjs/meta.js +0 -18
  38. package/build/cjs/meta.js.map +0 -1
  39. package/build/cjs/src/loyalty-referral-v1-program-programs.context.d.ts +0 -17
  40. package/build/cjs/src/loyalty-referral-v1-program-programs.context.js +0 -42
  41. package/build/cjs/src/loyalty-referral-v1-program-programs.context.js.map +0 -1
  42. package/build/cjs/src/loyalty-referral-v1-program-programs.http.d.ts +0 -39
  43. package/build/cjs/src/loyalty-referral-v1-program-programs.http.js +0 -450
  44. package/build/cjs/src/loyalty-referral-v1-program-programs.http.js.map +0 -1
  45. package/build/cjs/src/loyalty-referral-v1-program-programs.meta.d.ts +0 -20
  46. package/build/cjs/src/loyalty-referral-v1-program-programs.meta.js +0 -180
  47. package/build/cjs/src/loyalty-referral-v1-program-programs.meta.js.map +0 -1
  48. package/build/cjs/src/loyalty-referral-v1-program-programs.public.d.ts +0 -69
  49. package/build/cjs/src/loyalty-referral-v1-program-programs.public.js +0 -114
  50. package/build/cjs/src/loyalty-referral-v1-program-programs.public.js.map +0 -1
  51. package/build/cjs/src/loyalty-referral-v1-program-programs.types.js +0 -284
  52. package/build/cjs/src/loyalty-referral-v1-program-programs.types.js.map +0 -1
  53. package/build/cjs/src/loyalty-referral-v1-program-programs.universal.d.ts +0 -1741
  54. package/build/cjs/src/loyalty-referral-v1-program-programs.universal.js +0 -595
  55. package/build/cjs/src/loyalty-referral-v1-program-programs.universal.js.map +0 -1
  56. package/build/es/index.d.ts +0 -1
  57. package/build/es/index.js +0 -2
  58. package/build/es/index.js.map +0 -1
  59. package/build/es/index.typings.d.ts +0 -1
  60. package/build/es/index.typings.js +0 -2
  61. package/build/es/index.typings.js.map +0 -1
  62. package/build/es/meta.d.ts +0 -1
  63. package/build/es/meta.js +0 -2
  64. package/build/es/meta.js.map +0 -1
  65. package/build/es/package.json +0 -3
  66. package/build/es/src/loyalty-referral-v1-program-programs.context.d.ts +0 -17
  67. package/build/es/src/loyalty-referral-v1-program-programs.context.js +0 -19
  68. package/build/es/src/loyalty-referral-v1-program-programs.context.js.map +0 -1
  69. package/build/es/src/loyalty-referral-v1-program-programs.http.d.ts +0 -39
  70. package/build/es/src/loyalty-referral-v1-program-programs.http.js +0 -439
  71. package/build/es/src/loyalty-referral-v1-program-programs.http.js.map +0 -1
  72. package/build/es/src/loyalty-referral-v1-program-programs.meta.d.ts +0 -20
  73. package/build/es/src/loyalty-referral-v1-program-programs.meta.js +0 -146
  74. package/build/es/src/loyalty-referral-v1-program-programs.meta.js.map +0 -1
  75. package/build/es/src/loyalty-referral-v1-program-programs.public.d.ts +0 -69
  76. package/build/es/src/loyalty-referral-v1-program-programs.public.js +0 -83
  77. package/build/es/src/loyalty-referral-v1-program-programs.public.js.map +0 -1
  78. package/build/es/src/loyalty-referral-v1-program-programs.types.js +0 -281
  79. package/build/es/src/loyalty-referral-v1-program-programs.types.js.map +0 -1
  80. package/build/es/src/loyalty-referral-v1-program-programs.universal.d.ts +0 -1741
  81. package/build/es/src/loyalty-referral-v1-program-programs.universal.js +0 -561
  82. package/build/es/src/loyalty-referral-v1-program-programs.universal.js.map +0 -1
  83. package/build/internal/cjs/index.d.ts +0 -1
  84. package/build/internal/cjs/index.js +0 -18
  85. package/build/internal/cjs/index.js.map +0 -1
  86. package/build/internal/cjs/index.typings.d.ts +0 -1
  87. package/build/internal/cjs/index.typings.js +0 -18
  88. package/build/internal/cjs/index.typings.js.map +0 -1
  89. package/build/internal/cjs/meta.d.ts +0 -1
  90. package/build/internal/cjs/meta.js +0 -18
  91. package/build/internal/cjs/meta.js.map +0 -1
  92. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.context.d.ts +0 -19
  93. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.context.js +0 -42
  94. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.context.js.map +0 -1
  95. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.http.d.ts +0 -39
  96. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.http.js +0 -450
  97. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.http.js.map +0 -1
  98. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.meta.d.ts +0 -20
  99. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.meta.js +0 -180
  100. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.meta.js.map +0 -1
  101. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.public.d.ts +0 -79
  102. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.public.js +0 -114
  103. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.public.js.map +0 -1
  104. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.types.js +0 -284
  105. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.types.js.map +0 -1
  106. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.universal.d.ts +0 -1753
  107. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.universal.js +0 -595
  108. package/build/internal/cjs/src/loyalty-referral-v1-program-programs.universal.js.map +0 -1
  109. package/build/internal/es/index.d.ts +0 -1
  110. package/build/internal/es/index.js +0 -2
  111. package/build/internal/es/index.js.map +0 -1
  112. package/build/internal/es/index.typings.d.ts +0 -1
  113. package/build/internal/es/index.typings.js +0 -2
  114. package/build/internal/es/index.typings.js.map +0 -1
  115. package/build/internal/es/meta.d.ts +0 -1
  116. package/build/internal/es/meta.js +0 -2
  117. package/build/internal/es/meta.js.map +0 -1
  118. package/build/internal/es/src/loyalty-referral-v1-program-programs.context.d.ts +0 -19
  119. package/build/internal/es/src/loyalty-referral-v1-program-programs.context.js +0 -19
  120. package/build/internal/es/src/loyalty-referral-v1-program-programs.context.js.map +0 -1
  121. package/build/internal/es/src/loyalty-referral-v1-program-programs.http.d.ts +0 -39
  122. package/build/internal/es/src/loyalty-referral-v1-program-programs.http.js +0 -439
  123. package/build/internal/es/src/loyalty-referral-v1-program-programs.http.js.map +0 -1
  124. package/build/internal/es/src/loyalty-referral-v1-program-programs.meta.d.ts +0 -20
  125. package/build/internal/es/src/loyalty-referral-v1-program-programs.meta.js +0 -146
  126. package/build/internal/es/src/loyalty-referral-v1-program-programs.meta.js.map +0 -1
  127. package/build/internal/es/src/loyalty-referral-v1-program-programs.public.d.ts +0 -79
  128. package/build/internal/es/src/loyalty-referral-v1-program-programs.public.js +0 -83
  129. package/build/internal/es/src/loyalty-referral-v1-program-programs.public.js.map +0 -1
  130. package/build/internal/es/src/loyalty-referral-v1-program-programs.types.js +0 -281
  131. package/build/internal/es/src/loyalty-referral-v1-program-programs.types.js.map +0 -1
  132. package/build/internal/es/src/loyalty-referral-v1-program-programs.universal.d.ts +0 -1753
  133. package/build/internal/es/src/loyalty-referral-v1-program-programs.universal.js +0 -561
  134. package/build/internal/es/src/loyalty-referral-v1-program-programs.universal.js.map +0 -1
@@ -1,1741 +0,0 @@
1
- import { NonNullablePaths } from '@wix/sdk-types';
2
- export interface ReferralProgram {
3
- /**
4
- * Referral program name.
5
- * @minLength 2
6
- * @maxLength 50
7
- */
8
- name?: string | null;
9
- /** @readonly */
10
- status?: ProgramStatusWithLiterals;
11
- /**
12
- * Revision number, which increments by 1 each time the program is updated.
13
- * To prevent conflicting changes, the current `revision` must be passed when updating the program.
14
- * @immutable
15
- */
16
- revision?: string | null;
17
- /**
18
- * Date and time the program was created.
19
- * @readonly
20
- */
21
- _createdDate?: Date | null;
22
- /**
23
- * Date and time the program was last updated.
24
- * @readonly
25
- */
26
- _updatedDate?: Date | null;
27
- /**
28
- * Reward configuration for the referred friend.
29
- * Specifies the reward given to a new customer who was referred to the business.
30
- */
31
- referredFriendReward?: Reward;
32
- /**
33
- * Reward configuration for the referring customer.
34
- * Specifies the reward given to an existing customer who referred a new customer to the business.
35
- */
36
- referringCustomerReward?: Reward;
37
- /**
38
- * List of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an item.
39
- * @maxSize 100
40
- */
41
- successfulReferralActions?: ActionWithLiterals[];
42
- /** Configures email notifications for the referral program. */
43
- emails?: Emails;
44
- /**
45
- * Indicates which premium features are available for the current account.
46
- * @readonly
47
- */
48
- premiumFeatures?: PremiumFeatures;
49
- }
50
- /** Status of the referral program. */
51
- export declare enum ProgramStatus {
52
- /** Unknown program status. */
53
- UNKNOWN = "UNKNOWN",
54
- /** Referral program is in a draft state and is being modified. It is not yet active. */
55
- DRAFT = "DRAFT",
56
- /** Referral program is active. */
57
- ACTIVE = "ACTIVE",
58
- /** Referral program is paused. */
59
- PAUSED = "PAUSED"
60
- }
61
- /** @enumType */
62
- export type ProgramStatusWithLiterals = ProgramStatus | 'UNKNOWN' | 'DRAFT' | 'ACTIVE' | 'PAUSED';
63
- export interface Reward extends RewardOptionsOneOf {
64
- /** Options for coupon reward type. */
65
- couponOptions?: Coupon;
66
- /** Options for the Loyalty points reward type. */
67
- loyaltyPointsOptions?: LoyaltyPoints;
68
- /** Type of the reward. */
69
- type?: TypeWithLiterals;
70
- }
71
- /** @oneof */
72
- export interface RewardOptionsOneOf {
73
- /** Options for coupon reward type. */
74
- couponOptions?: Coupon;
75
- /** Options for the Loyalty points reward type. */
76
- loyaltyPointsOptions?: LoyaltyPoints;
77
- }
78
- export declare enum Type {
79
- /** Unknown reward type. */
80
- UNKNOWN = "UNKNOWN",
81
- /** Coupon reward type. */
82
- COUPON = "COUPON",
83
- /** Loyalty points reward type. */
84
- LOYALTY_POINTS = "LOYALTY_POINTS",
85
- /** No reward type. */
86
- NOTHING = "NOTHING"
87
- }
88
- /** @enumType */
89
- export type TypeWithLiterals = Type | 'UNKNOWN' | 'COUPON' | 'LOYALTY_POINTS' | 'NOTHING';
90
- export interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
91
- /** Options for fixed amount discount. */
92
- fixedAmountOptions?: FixedAmountDiscount;
93
- /** Options for percentage discounts. */
94
- percentageOptions?: PercentageDiscount;
95
- /** Limit the coupon to carts with a subtotal above this number. */
96
- minimumSubtotal?: number;
97
- /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
98
- scope?: CouponScope;
99
- /**
100
- * Coupon name.
101
- * @minLength 1
102
- * @maxLength 50
103
- */
104
- name?: string;
105
- /** Coupon discount type. */
106
- discountType?: DiscountTypeWithLiterals;
107
- /**
108
- * Whether the coupon is limited to one item.
109
- * If `true` and a customer pays for multiple items, the discount applies to only the lowest priced item.
110
- * Coupons with a bookings `scope.namespace` are always limited to one item.
111
- */
112
- limitedToOneItem?: boolean | null;
113
- /** Whether the coupon applies to subscription products. */
114
- appliesToSubscriptions?: boolean | null;
115
- /**
116
- * Specifies the amount of discounted cycles for a subscription item.
117
- *
118
- * - Can only be set when `scope.namespace = pricingPlans`.
119
- * - If `discountedCycleCount` is empty, the coupon applies to all available cycles.
120
- * - `discountedCycleCount` is ignored if `appliesToSubscriptions = true`.
121
- *
122
- * Max: `999`
123
- */
124
- discountedCycleCount?: number | null;
125
- }
126
- /** @oneof */
127
- export interface CouponDiscountTypeOptionsOneOf {
128
- /** Options for fixed amount discount. */
129
- fixedAmountOptions?: FixedAmountDiscount;
130
- /** Options for percentage discounts. */
131
- percentageOptions?: PercentageDiscount;
132
- }
133
- /** @oneof */
134
- export interface CouponScopeOrMinSubtotalOneOf {
135
- /** Limit the coupon to carts with a subtotal above this number. */
136
- minimumSubtotal?: number;
137
- /** Specifies the type of line items this coupon will apply to. See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
138
- scope?: CouponScope;
139
- }
140
- export declare enum DiscountType {
141
- /** Unknown discount type. */
142
- UNKNOWN = "UNKNOWN",
143
- /** Discount as a fixed amount. */
144
- FIXED_AMOUNT = "FIXED_AMOUNT",
145
- /** Discount as a percentage. */
146
- PERCENTAGE = "PERCENTAGE",
147
- /** Free shipping. If `true`, the coupon applies to all items in all `namespaces`. */
148
- FREE_SHIPPING = "FREE_SHIPPING"
149
- }
150
- /** @enumType */
151
- export type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN' | 'FIXED_AMOUNT' | 'PERCENTAGE' | 'FREE_SHIPPING';
152
- export interface FixedAmountDiscount {
153
- /** Amount of the discount as a fixed value. */
154
- amount?: number;
155
- }
156
- export interface PercentageDiscount {
157
- /**
158
- * Percentage of discount.
159
- * @max 100
160
- */
161
- percentage?: number;
162
- }
163
- export interface CouponScope {
164
- /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
165
- namespace?: string;
166
- /** Coupon scope's applied group, for example, Event or ticket in Wix Events. */
167
- group?: Group;
168
- }
169
- export interface Group {
170
- /** Name of the group. */
171
- name?: string;
172
- /** Entity ID of the group. */
173
- entityId?: string | null;
174
- }
175
- export interface LoyaltyPoints {
176
- /**
177
- * Number of loyalty points to give.
178
- * @min 1
179
- * @max 9999999
180
- */
181
- amount?: number;
182
- }
183
- export declare enum Action {
184
- /** Unknown action. */
185
- UNKNOWN = "UNKNOWN",
186
- /** Referred friend ordered and paid for an order in a store. */
187
- STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
188
- /** Referred friend ordered and paid for a plan. */
189
- PLAN_ORDERED = "PLAN_ORDERED",
190
- /** Referred friend ordered and paid for a ticket. */
191
- TICKET_ORDERED = "TICKET_ORDERED",
192
- /** Referred friend booked and paid for a session. */
193
- SESSION_BOOKED = "SESSION_BOOKED",
194
- /** Referred friend placed and paid for a restaurant order. */
195
- RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED",
196
- /** Referred friend joined an online program. */
197
- ONLINE_PROGRAM_JOINED = "ONLINE_PROGRAM_JOINED"
198
- }
199
- /** @enumType */
200
- export type ActionWithLiterals = Action | 'UNKNOWN' | 'STORE_ORDER_PLACED' | 'PLAN_ORDERED' | 'TICKET_ORDERED' | 'SESSION_BOOKED' | 'RESTAURANT_ORDER_PLACED' | 'ONLINE_PROGRAM_JOINED';
201
- export interface Emails {
202
- /** Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled. */
203
- encourageToReferFriends?: AppWithLiterals[];
204
- /**
205
- * Whether to send email notifications to referring customers when they receive a referral reward.
206
- * If true, referring customers will be notified by email when their referred friend completes a qualifying action (for example, placing an order).
207
- */
208
- notifyCustomersAboutReward?: boolean;
209
- }
210
- export declare enum App {
211
- /** Unknown app. */
212
- UNKNOWN = "UNKNOWN",
213
- /** Send an email to customers who've placed an order with stores. */
214
- STORES = "STORES",
215
- /** Send an email to customers who've placed an order with pricing plans. */
216
- PRICING_PLANS = "PRICING_PLANS",
217
- /** Send an email to customers who've placed an order with events. */
218
- EVENTS = "EVENTS",
219
- /** Send an email to customers who've placed an order with bookings. */
220
- BOOKINGS = "BOOKINGS",
221
- /** Send an email to customers who've placed an order with restaurants. */
222
- RESTAURANTS = "RESTAURANTS",
223
- /** Send an email to customers who've joined an online program. */
224
- ONLINE_PROGRAMS = "ONLINE_PROGRAMS"
225
- }
226
- /** @enumType */
227
- export type AppWithLiterals = App | 'UNKNOWN' | 'STORES' | 'PRICING_PLANS' | 'EVENTS' | 'BOOKINGS' | 'RESTAURANTS' | 'ONLINE_PROGRAMS';
228
- export interface PremiumFeatures {
229
- /**
230
- * Whether the site owner has access to the referral program feature.
231
- * @readonly
232
- */
233
- referralProgram?: boolean;
234
- }
235
- export interface GetReferralProgramRequest {
236
- }
237
- export interface GetReferralProgramResponse {
238
- /** Retrieved referral program. */
239
- referralProgram?: ReferralProgram;
240
- }
241
- export interface BulkGetReferralProgramRequest {
242
- }
243
- export interface BulkGetReferralProgramResponse {
244
- /** Retrieved referral programs. */
245
- programInSites?: ProgramInSite[];
246
- }
247
- export interface ProgramInSite {
248
- /**
249
- * Metasite ID.
250
- * @format GUID
251
- */
252
- metaSiteId?: string;
253
- /** Retrieved referral program. */
254
- referralProgram?: ReferralProgram;
255
- }
256
- export interface UpdateReferralProgramRequest {
257
- /** Referral program to update. Include the latest `revision` for a successful update. */
258
- referralProgram: ReferralProgram;
259
- }
260
- export interface UpdateReferralProgramResponse {
261
- /** Updated referral program. */
262
- referralProgram?: ReferralProgram;
263
- }
264
- export interface ActivateReferralProgramRequest {
265
- }
266
- export interface ActivateReferralProgramResponse {
267
- /** Activated referral program. */
268
- referralProgram?: ReferralProgram;
269
- }
270
- export interface PauseReferralProgramRequest {
271
- }
272
- export interface PauseReferralProgramResponse {
273
- /** Paused referral program. */
274
- referralProgram?: ReferralProgram;
275
- }
276
- export interface GetAISocialMediaPostsSuggestionsRequest {
277
- /**
278
- * Topic to generate social media post suggestions for. For example, fitness, education, or technology.
279
- * @maxLength 512
280
- */
281
- topic?: string;
282
- }
283
- export interface GetAISocialMediaPostsSuggestionsResponse {
284
- /**
285
- * Generated social media post suggestions.
286
- * @maxSize 3
287
- */
288
- suggestions?: AISocialMediaPostSuggestion[];
289
- /**
290
- * Referral URL to refer friends.
291
- * @maxLength 2083
292
- */
293
- referFriendsPageUrl?: string | null;
294
- }
295
- export interface AISocialMediaPostSuggestion {
296
- /**
297
- * Suggested post content.
298
- * @maxLength 4096
299
- */
300
- postContent?: string;
301
- /**
302
- * Suggested hashtags.
303
- * @maxLength 256
304
- * @maxSize 256
305
- */
306
- hashtags?: string[];
307
- }
308
- export interface GenerateAISocialMediaPostsSuggestionsRequest {
309
- /**
310
- * Topic to generate social media post suggestions for. For example, fitness, education, or technology.
311
- * @maxLength 512
312
- */
313
- topic?: string;
314
- }
315
- export interface GenerateAISocialMediaPostsSuggestionsResponse {
316
- /**
317
- * Generated social media post suggestions.
318
- * @maxSize 3
319
- */
320
- suggestions?: AISocialMediaPostSuggestion[];
321
- /**
322
- * Referral URL to refer friends.
323
- * @maxLength 2083
324
- */
325
- referFriendsPageUrl?: string | null;
326
- }
327
- export interface GetReferralProgramPremiumFeaturesRequest {
328
- }
329
- export interface GetReferralProgramPremiumFeaturesResponse {
330
- /**
331
- * Whether the site has the referral program feature enabled.
332
- * @readonly
333
- */
334
- referralProgram?: boolean;
335
- }
336
- export interface DomainEvent extends DomainEventBodyOneOf {
337
- createdEvent?: EntityCreatedEvent;
338
- updatedEvent?: EntityUpdatedEvent;
339
- deletedEvent?: EntityDeletedEvent;
340
- actionEvent?: ActionEvent;
341
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
342
- _id?: string;
343
- /**
344
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
345
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
346
- */
347
- entityFqdn?: string;
348
- /**
349
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
350
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
351
- */
352
- slug?: string;
353
- /** ID of the entity associated with the event. */
354
- entityId?: string;
355
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
356
- eventTime?: Date | null;
357
- /**
358
- * Whether the event was triggered as a result of a privacy regulation application
359
- * (for example, GDPR).
360
- */
361
- triggeredByAnonymizeRequest?: boolean | null;
362
- /** If present, indicates the action that triggered the event. */
363
- originatedFrom?: string | null;
364
- /**
365
- * 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.
366
- * 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.
367
- */
368
- entityEventSequence?: string | null;
369
- }
370
- /** @oneof */
371
- export interface DomainEventBodyOneOf {
372
- createdEvent?: EntityCreatedEvent;
373
- updatedEvent?: EntityUpdatedEvent;
374
- deletedEvent?: EntityDeletedEvent;
375
- actionEvent?: ActionEvent;
376
- }
377
- export interface EntityCreatedEvent {
378
- entity?: string;
379
- }
380
- export interface RestoreInfo {
381
- deletedDate?: Date | null;
382
- }
383
- export interface EntityUpdatedEvent {
384
- /**
385
- * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
386
- * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
387
- * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
388
- */
389
- currentEntity?: string;
390
- }
391
- export interface EntityDeletedEvent {
392
- /** Entity that was deleted. */
393
- deletedEntity?: string | null;
394
- }
395
- export interface ActionEvent {
396
- body?: string;
397
- }
398
- export interface Empty {
399
- }
400
- export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
401
- /** Emitted on a meta site creation. */
402
- siteCreated?: SiteCreated;
403
- /** Emitted on a meta site transfer completion. */
404
- siteTransferred?: SiteTransferred;
405
- /** Emitted on a meta site deletion. */
406
- siteDeleted?: SiteDeleted;
407
- /** Emitted on a meta site restoration. */
408
- siteUndeleted?: SiteUndeleted;
409
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
410
- sitePublished?: SitePublished;
411
- /** Emitted on a meta site unpublish. */
412
- siteUnpublished?: SiteUnpublished;
413
- /** Emitted when meta site is marked as template. */
414
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
415
- /** Emitted when meta site is marked as a WixSite. */
416
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
417
- /** Emitted when an application is provisioned (installed). */
418
- serviceProvisioned?: ServiceProvisioned;
419
- /** Emitted when an application is removed (uninstalled). */
420
- serviceRemoved?: ServiceRemoved;
421
- /** Emitted when meta site name (URL slug) is changed. */
422
- siteRenamedPayload?: SiteRenamed;
423
- /** Emitted when meta site was permanently deleted. */
424
- hardDeleted?: SiteHardDeleted;
425
- /** Emitted on a namespace change. */
426
- namespaceChanged?: NamespaceChanged;
427
- /** Emitted when Studio is attached. */
428
- studioAssigned?: StudioAssigned;
429
- /** Emitted when Studio is detached. */
430
- studioUnassigned?: StudioUnassigned;
431
- /**
432
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
433
- * the actual URL.
434
- *
435
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
436
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
437
- */
438
- urlChanged?: SiteUrlChanged;
439
- /** Site is marked as PurgedExternally */
440
- sitePurgedExternally?: SitePurgedExternally;
441
- /** Emitted when Odeditor is attached. */
442
- odeditorAssigned?: OdeditorAssigned;
443
- /** Emitted when Odeditor is detached. */
444
- odeditorUnassigned?: OdeditorUnassigned;
445
- /** Emitted when Picasso is attached. */
446
- picassoAssigned?: PicassoAssigned;
447
- /** Emitted when Picasso is detached. */
448
- picassoUnassigned?: PicassoUnassigned;
449
- /**
450
- * A meta site id.
451
- * @format GUID
452
- */
453
- metaSiteId?: string;
454
- /** A meta site version. Monotonically increasing. */
455
- version?: string;
456
- /** A timestamp of the event. */
457
- timestamp?: string;
458
- /**
459
- * TODO(meta-site): Change validation once validations are disabled for consumers
460
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
461
- * @maxSize 4000
462
- */
463
- assets?: Asset[];
464
- }
465
- /** @oneof */
466
- export interface MetaSiteSpecialEventPayloadOneOf {
467
- /** Emitted on a meta site creation. */
468
- siteCreated?: SiteCreated;
469
- /** Emitted on a meta site transfer completion. */
470
- siteTransferred?: SiteTransferred;
471
- /** Emitted on a meta site deletion. */
472
- siteDeleted?: SiteDeleted;
473
- /** Emitted on a meta site restoration. */
474
- siteUndeleted?: SiteUndeleted;
475
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
476
- sitePublished?: SitePublished;
477
- /** Emitted on a meta site unpublish. */
478
- siteUnpublished?: SiteUnpublished;
479
- /** Emitted when meta site is marked as template. */
480
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
481
- /** Emitted when meta site is marked as a WixSite. */
482
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
483
- /** Emitted when an application is provisioned (installed). */
484
- serviceProvisioned?: ServiceProvisioned;
485
- /** Emitted when an application is removed (uninstalled). */
486
- serviceRemoved?: ServiceRemoved;
487
- /** Emitted when meta site name (URL slug) is changed. */
488
- siteRenamedPayload?: SiteRenamed;
489
- /** Emitted when meta site was permanently deleted. */
490
- hardDeleted?: SiteHardDeleted;
491
- /** Emitted on a namespace change. */
492
- namespaceChanged?: NamespaceChanged;
493
- /** Emitted when Studio is attached. */
494
- studioAssigned?: StudioAssigned;
495
- /** Emitted when Studio is detached. */
496
- studioUnassigned?: StudioUnassigned;
497
- /**
498
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
499
- * the actual URL.
500
- *
501
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
502
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
503
- */
504
- urlChanged?: SiteUrlChanged;
505
- /** Site is marked as PurgedExternally */
506
- sitePurgedExternally?: SitePurgedExternally;
507
- /** Emitted when Odeditor is attached. */
508
- odeditorAssigned?: OdeditorAssigned;
509
- /** Emitted when Odeditor is detached. */
510
- odeditorUnassigned?: OdeditorUnassigned;
511
- /** Emitted when Picasso is attached. */
512
- picassoAssigned?: PicassoAssigned;
513
- /** Emitted when Picasso is detached. */
514
- picassoUnassigned?: PicassoUnassigned;
515
- }
516
- export interface Asset {
517
- /**
518
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
519
- * @maxLength 36
520
- */
521
- appDefId?: string;
522
- /**
523
- * An instance id. For legacy reasons may be UUID or a string.
524
- * @maxLength 200
525
- */
526
- instanceId?: string;
527
- /** An application state. */
528
- state?: StateWithLiterals;
529
- }
530
- export declare enum State {
531
- UNKNOWN = "UNKNOWN",
532
- ENABLED = "ENABLED",
533
- DISABLED = "DISABLED",
534
- PENDING = "PENDING",
535
- DEMO = "DEMO"
536
- }
537
- /** @enumType */
538
- export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
539
- export interface SiteCreated {
540
- /**
541
- * A template identifier (empty if not created from a template).
542
- * @maxLength 36
543
- */
544
- originTemplateId?: string;
545
- /**
546
- * An account id of the owner.
547
- * @format GUID
548
- */
549
- ownerId?: string;
550
- /** A context in which meta site was created. */
551
- context?: SiteCreatedContextWithLiterals;
552
- /**
553
- * A meta site id from which this site was created.
554
- *
555
- * In case of a creation from a template it's a template id.
556
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
557
- * @format GUID
558
- */
559
- originMetaSiteId?: string | null;
560
- /**
561
- * A meta site name (URL slug).
562
- * @maxLength 20
563
- */
564
- siteName?: string;
565
- /** A namespace. */
566
- namespace?: NamespaceWithLiterals;
567
- }
568
- export declare enum SiteCreatedContext {
569
- /** A valid option, we don't expose all reasons why site might be created. */
570
- OTHER = "OTHER",
571
- /** A meta site was created from template. */
572
- FROM_TEMPLATE = "FROM_TEMPLATE",
573
- /** A meta site was created by copying of the transfferred meta site. */
574
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
575
- /** A copy of existing meta site. */
576
- DUPLICATE = "DUPLICATE",
577
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
578
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
579
- /** deprecated A meta site was created for Flash editor. */
580
- FLASH = "FLASH"
581
- }
582
- /** @enumType */
583
- export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
584
- export declare enum Namespace {
585
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
586
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
587
- WIX = "WIX",
588
- /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
589
- SHOUT_OUT = "SHOUT_OUT",
590
- /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
591
- ALBUMS = "ALBUMS",
592
- /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
593
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
594
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
595
- HOTELS = "HOTELS",
596
- /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
597
- CLUBS = "CLUBS",
598
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
599
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
600
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
601
- DEV_SITE = "DEV_SITE",
602
- /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
603
- LOGOS = "LOGOS",
604
- /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
605
- VIDEO_MAKER = "VIDEO_MAKER",
606
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
607
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
608
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
609
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
610
- /**
611
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
612
- *
613
- * Meta site with this namespace will *not* be shown in a user's site list by default.
614
- */
615
- HTML_DRAFT = "HTML_DRAFT",
616
- /**
617
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
618
- * Will be accessible from Site List and will not have a website app.
619
- * Once the user attaches a site, the site will become a regular wixsite.
620
- */
621
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
622
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
623
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
624
- /** It is to be used in the Business First efforts. */
625
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
626
- /** Bookings business flow with no site. */
627
- ANYWHERE = "ANYWHERE",
628
- /** Namespace for Headless Backoffice with no editor */
629
- HEADLESS = "HEADLESS",
630
- /**
631
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
632
- * The site will be used for account level CSM feature for enterprise
633
- */
634
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
635
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
636
- RISE = "RISE",
637
- /**
638
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
639
- * There's a blank site behind the scene but it's blank).
640
- * The Mobile company will be the owner of this namespace.
641
- */
642
- BRANDED_FIRST = "BRANDED_FIRST",
643
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
644
- NOWNIA = "NOWNIA",
645
- /**
646
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
647
- * The Partners company owns this namespace.
648
- */
649
- UGC_TEMPLATE = "UGC_TEMPLATE",
650
- /** Codux Headless Sites */
651
- CODUX = "CODUX",
652
- /** Bobb - AI Design Creator. */
653
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
654
- /**
655
- * Shared Blog Site is a unique single site across Enterprise account,
656
- * This site will hold all Blog posts related to the Marketing product.
657
- */
658
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
659
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
660
- STANDALONE_FORMS = "STANDALONE_FORMS",
661
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
662
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
663
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
664
- MIMIR = "MIMIR"
665
- }
666
- /** @enumType */
667
- 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';
668
- /** Site transferred to another user. */
669
- export interface SiteTransferred {
670
- /**
671
- * A previous owner id (user that transfers meta site).
672
- * @format GUID
673
- */
674
- oldOwnerId?: string;
675
- /**
676
- * A new owner id (user that accepts meta site).
677
- * @format GUID
678
- */
679
- newOwnerId?: string;
680
- }
681
- /** Soft deletion of the meta site. Could be restored. */
682
- export interface SiteDeleted {
683
- /** A deletion context. */
684
- deleteContext?: DeleteContext;
685
- }
686
- export interface DeleteContext {
687
- /** When the meta site was deleted. */
688
- dateDeleted?: Date | null;
689
- /** A status. */
690
- deleteStatus?: DeleteStatusWithLiterals;
691
- /**
692
- * A reason (flow).
693
- * @maxLength 255
694
- */
695
- deleteOrigin?: string;
696
- /**
697
- * A service that deleted it.
698
- * @maxLength 255
699
- */
700
- initiatorId?: string | null;
701
- }
702
- export declare enum DeleteStatus {
703
- UNKNOWN = "UNKNOWN",
704
- TRASH = "TRASH",
705
- DELETED = "DELETED",
706
- PENDING_PURGE = "PENDING_PURGE",
707
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
708
- }
709
- /** @enumType */
710
- export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
711
- /** Restoration of the meta site. */
712
- export interface SiteUndeleted {
713
- }
714
- /** First publish of a meta site. Or subsequent publish after unpublish. */
715
- export interface SitePublished {
716
- }
717
- export interface SiteUnpublished {
718
- /**
719
- * A list of URLs previously associated with the meta site.
720
- * @maxLength 4000
721
- * @maxSize 10000
722
- */
723
- urls?: string[];
724
- }
725
- export interface SiteMarkedAsTemplate {
726
- }
727
- export interface SiteMarkedAsWixSite {
728
- }
729
- /**
730
- * Represents a service provisioned a site.
731
- *
732
- * Note on `origin_instance_id`:
733
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
734
- * This is because of the following scenario:
735
- *
736
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
737
- * such as a product catalog. When you create a site from this template, you inherit this
738
- * default product catalog. However, if the template's product catalog is modified,
739
- * your site will retain the catalog as it was at the time of site creation. This ensures that
740
- * your site remains consistent with what you initially received and does not include any
741
- * changes made to the original template afterward.
742
- * To ensure this, the TPA on the template gets a new instance_id.
743
- */
744
- export interface ServiceProvisioned {
745
- /**
746
- * Either UUID or EmbeddedServiceType.
747
- * @maxLength 36
748
- */
749
- appDefId?: string;
750
- /**
751
- * Not only UUID. Something here could be something weird.
752
- * @maxLength 36
753
- */
754
- instanceId?: string;
755
- /**
756
- * An instance id from which this instance is originated.
757
- * @maxLength 36
758
- */
759
- originInstanceId?: string;
760
- /**
761
- * A version.
762
- * @maxLength 500
763
- */
764
- version?: string | null;
765
- /**
766
- * The origin meta site id
767
- * @format GUID
768
- */
769
- originMetaSiteId?: string | null;
770
- }
771
- export interface ServiceRemoved {
772
- /**
773
- * Either UUID or EmbeddedServiceType.
774
- * @maxLength 36
775
- */
776
- appDefId?: string;
777
- /**
778
- * Not only UUID. Something here could be something weird.
779
- * @maxLength 36
780
- */
781
- instanceId?: string;
782
- /**
783
- * A version.
784
- * @maxLength 500
785
- */
786
- version?: string | null;
787
- }
788
- /** Rename of the site. Meaning, free public url has been changed as well. */
789
- export interface SiteRenamed {
790
- /**
791
- * A new meta site name (URL slug).
792
- * @maxLength 20
793
- */
794
- newSiteName?: string;
795
- /**
796
- * A previous meta site name (URL slug).
797
- * @maxLength 255
798
- */
799
- oldSiteName?: string;
800
- }
801
- /**
802
- * Hard deletion of the meta site.
803
- *
804
- * Could not be restored. Therefore it's desirable to cleanup data.
805
- */
806
- export interface SiteHardDeleted {
807
- /** A deletion context. */
808
- deleteContext?: DeleteContext;
809
- }
810
- export interface NamespaceChanged {
811
- /** A previous namespace. */
812
- oldNamespace?: NamespaceWithLiterals;
813
- /** A new namespace. */
814
- newNamespace?: NamespaceWithLiterals;
815
- }
816
- /** Assigned Studio editor */
817
- export interface StudioAssigned {
818
- }
819
- /** Unassigned Studio editor */
820
- export interface StudioUnassigned {
821
- }
822
- /**
823
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
824
- *
825
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
826
- * with sites and its urls, you need to listen to another topic/event. Read about it:
827
- *
828
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
829
- */
830
- export interface SiteUrlChanged {
831
- }
832
- /**
833
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
834
- * Consumed by other teams to remove relevant data.
835
- */
836
- export interface SitePurgedExternally {
837
- /**
838
- * @maxLength 2048
839
- * @maxSize 100
840
- * @deprecated
841
- * @targetRemovalDate 2025-04-15
842
- */
843
- appDefId?: string[];
844
- }
845
- /** Assigned Odeditor */
846
- export interface OdeditorAssigned {
847
- }
848
- /** Unassigned Odeditor */
849
- export interface OdeditorUnassigned {
850
- }
851
- /** Assigned Picasso editor */
852
- export interface PicassoAssigned {
853
- }
854
- /** Unassigned Picasso */
855
- export interface PicassoUnassigned {
856
- }
857
- export interface HtmlSitePublished {
858
- /**
859
- * Application instance ID
860
- * @maxLength 50
861
- */
862
- appInstanceId?: string;
863
- /**
864
- * Application type
865
- * @maxLength 100
866
- */
867
- appType?: string;
868
- /** Revision */
869
- revision?: string;
870
- /**
871
- * MSID
872
- * @maxLength 100
873
- */
874
- metaSiteId?: string | null;
875
- /**
876
- * optional branch id if publish is done from branch
877
- * @format GUID
878
- */
879
- branchId?: string | null;
880
- /** The site's last transactionId */
881
- lastTransactionId?: string | null;
882
- /** A list of the site's pages */
883
- pages?: Page[];
884
- /** Site's publish date */
885
- publishDate?: string;
886
- }
887
- export interface Page {
888
- /**
889
- * Page's Id
890
- * @maxLength 100
891
- */
892
- _id?: string;
893
- }
894
- export interface SubscriptionEvent extends SubscriptionEventEventOneOf {
895
- /** Triggered when a subscription is created. */
896
- created?: SubscriptionCreated;
897
- /**
898
- * Triggered when a subscription is assigned to a Wix site, including the initial
899
- * assignment of a floating subscription or a re-assignement from a different site.
900
- */
901
- assigned?: SubscriptionAssigned;
902
- /** Triggered when a subscription is canceled. */
903
- cancelled?: SubscriptionCancelled;
904
- /** Triggered when the subscription's auto renew is turned on. */
905
- autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;
906
- /** Triggered when the subscription's auto renew is turned off. */
907
- autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;
908
- /**
909
- * Triggered when a subscription is unassigned from a Wix site and becomes
910
- * floating.
911
- */
912
- unassigned?: SubscriptionUnassigned;
913
- /**
914
- * Triggered when a subscription is transferred from one Wix account to another.
915
- * A transfer includes cancelling the original subscription and creating a new
916
- * subscription for the target account. The event returns both the original
917
- * and the new subscription.
918
- */
919
- transferred?: SubscriptionTransferred;
920
- /** Triggered when a recurring charge succeeds for a subscription. */
921
- recurringChargeSucceeded?: RecurringChargeSucceeded;
922
- /**
923
- * Triggered when a subscription was updated including when its product has been
924
- * up- or downgraded or the billing cycle is changed.
925
- */
926
- contractSwitched?: ContractSwitched;
927
- /**
928
- * Triggered when a subscription gets close to the end of its billing cycle.
929
- * The exact number of days is defined in the billing system.
930
- */
931
- nearEndOfPeriod?: SubscriptionNearEndOfPeriod;
932
- /**
933
- * Triggered when a subscription is updated and the change doesn't happen
934
- * immediately but at the end of the current billing cycle.
935
- */
936
- pendingChange?: SubscriptionPendingChange;
937
- /** Triggered when a recurring charge attempt fails for a subscription. */
938
- recurringChargeAttemptFailed?: RecurringChargeAttemptFailed;
939
- /**
940
- * ID of the subscription's event.
941
- * @format GUID
942
- */
943
- eventId?: string | null;
944
- /**
945
- * Date and time of the event in
946
- * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
947
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
948
- */
949
- eventDate?: Date | null;
950
- }
951
- /** @oneof */
952
- export interface SubscriptionEventEventOneOf {
953
- /** Triggered when a subscription is created. */
954
- created?: SubscriptionCreated;
955
- /**
956
- * Triggered when a subscription is assigned to a Wix site, including the initial
957
- * assignment of a floating subscription or a re-assignement from a different site.
958
- */
959
- assigned?: SubscriptionAssigned;
960
- /** Triggered when a subscription is canceled. */
961
- cancelled?: SubscriptionCancelled;
962
- /** Triggered when the subscription's auto renew is turned on. */
963
- autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;
964
- /** Triggered when the subscription's auto renew is turned off. */
965
- autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;
966
- /**
967
- * Triggered when a subscription is unassigned from a Wix site and becomes
968
- * floating.
969
- */
970
- unassigned?: SubscriptionUnassigned;
971
- /**
972
- * Triggered when a subscription is transferred from one Wix account to another.
973
- * A transfer includes cancelling the original subscription and creating a new
974
- * subscription for the target account. The event returns both the original
975
- * and the new subscription.
976
- */
977
- transferred?: SubscriptionTransferred;
978
- /** Triggered when a recurring charge succeeds for a subscription. */
979
- recurringChargeSucceeded?: RecurringChargeSucceeded;
980
- /**
981
- * Triggered when a subscription was updated including when its product has been
982
- * up- or downgraded or the billing cycle is changed.
983
- */
984
- contractSwitched?: ContractSwitched;
985
- /**
986
- * Triggered when a subscription gets close to the end of its billing cycle.
987
- * The exact number of days is defined in the billing system.
988
- */
989
- nearEndOfPeriod?: SubscriptionNearEndOfPeriod;
990
- /**
991
- * Triggered when a subscription is updated and the change doesn't happen
992
- * immediately but at the end of the current billing cycle.
993
- */
994
- pendingChange?: SubscriptionPendingChange;
995
- /** Triggered when a recurring charge attempt fails for a subscription. */
996
- recurringChargeAttemptFailed?: RecurringChargeAttemptFailed;
997
- }
998
- /** Triggered when a subscription is created. */
999
- export interface SubscriptionCreated {
1000
- /** Created subscription. */
1001
- subscription?: Subscription;
1002
- /** Metadata for the `created` event. */
1003
- metadata?: Record<string, string>;
1004
- /**
1005
- * Subscription reactivation data.
1006
- * A subscription can be reactivated for example if it was incorrectly canceled because of fraud and then reactivated
1007
- * by the billing system
1008
- */
1009
- reactivationData?: ReactivationData;
1010
- }
1011
- /**
1012
- * A subscription holds information about a Premium product that a Wix account
1013
- * owner has purchased including details about the billing.
1014
- */
1015
- export interface Subscription {
1016
- /**
1017
- * ID of the subscription.
1018
- * @format GUID
1019
- */
1020
- _id?: string;
1021
- /**
1022
- * ID of the Wix account that purchased the subscription.
1023
- * @format GUID
1024
- */
1025
- userId?: string;
1026
- /**
1027
- * ID of the [product](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/products/product-object)
1028
- * for which the subscription was purchased.
1029
- * @format GUID
1030
- */
1031
- productId?: string;
1032
- /**
1033
- * Date and time the subscription was created in
1034
- * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
1035
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
1036
- */
1037
- createdAt?: Date | null;
1038
- /**
1039
- * Date and time the subscription was last updated in
1040
- * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
1041
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
1042
- */
1043
- updatedAt?: Date | null;
1044
- /**
1045
- * ID of the metasite that the subscription is assigned to.
1046
- * Available only when the subscription is assigned to a Wix site.
1047
- * Subscriptions for account level products can't be assigned to a Wix site.
1048
- * @format GUID
1049
- */
1050
- metaSiteId?: string | null;
1051
- /** Information about the system that manages the subscription's billing. */
1052
- billingReference?: BillingReference;
1053
- /** Information about the billing cycle of the subscription. */
1054
- cycle?: Cycle;
1055
- /**
1056
- * Subscription status.
1057
- *
1058
- * + `UNKNOWN`: Default status.
1059
- * + `AUTO_RENEW_ON`: Subscription is active and automatically renews at the end of the current billing cycle.
1060
- * + `AUTO_RENEW_OFF`: Subscription is active but expires at the end of the current billing cycle.
1061
- * + `MANUAL_RECURRING`: Subscription is active and renews at the end of the current billing cycle, in case the customer takes an action related to the payment.
1062
- * + `CANCELLED`: Subscription isn't active because it has been canceled.
1063
- * + `TRANSFERRED`: Subscription isn't active because it has been transferred to a different account. A different active subscription was created for the target account.
1064
- */
1065
- status?: SubscriptionStatusWithLiterals;
1066
- /**
1067
- * Date and time the subscription was last transferred from one Wix account to
1068
- * another in
1069
- * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
1070
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
1071
- */
1072
- transferredAt?: Date | null;
1073
- /**
1074
- * ID of the [product type](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/product-types/product-type-object)
1075
- * that the product, for which the subscription was purchased, belongs to.
1076
- * @format GUID
1077
- */
1078
- productTypeId?: string;
1079
- /** Version number, which increments by 1 each time the subscription is updated. */
1080
- version?: number;
1081
- /**
1082
- * Whether the subscription is active. Includes the statuses
1083
- * `"AUTO_RENEW_ON"`, `"AUTO_RENEW_OFF"`, and `"MANUAL_RECURRING"`.
1084
- */
1085
- active?: boolean;
1086
- /**
1087
- * Date and time the subscription was originally created in
1088
- * [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
1089
- * `YYYY-MM-DDThh:mm:ss.sssZ` format.
1090
- * Differs from `createdAt` in case the subscription was originally created for a different Wix account and has been transferred.
1091
- */
1092
- originalCreationDate?: Date | null;
1093
- /** Custom metadata about the subscription. */
1094
- metadata?: Record<string, string>;
1095
- /**
1096
- * 2-letter country code in
1097
- * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
1098
- * format.
1099
- */
1100
- countryCode?: string | null;
1101
- }
1102
- export interface BillingReference {
1103
- /**
1104
- * Name of the billing system that manages the subscription.
1105
- *
1106
- * + `"UNKNOWN"`: Default value.
1107
- * + `"SBS"`: [Wix Billing](https://github.com/wix-p/premium-billing/tree/master/sbs).
1108
- * + `"LICENSER"`:
1109
- * + `"BASS"`: [Billing and Subscriptions System](https://dev.wix.com/docs/rest/internal-only/premium/subscriptions-by-billing-by-wix/introduction).
1110
- * + `"RESELLER"`: [External Reseller](https://dev.wix.com/api/rest/account-level-apis/resellers/introduction).
1111
- */
1112
- providerName?: ProviderNameWithLiterals;
1113
- /** Current provider reference ID. */
1114
- providerReferenceId?: string | null;
1115
- /** Previous provider reference IDs. Used for when a subscription is extended, specifically for domains. */
1116
- previousProviderReferenceIds?: string[];
1117
- }
1118
- export declare enum ProviderName {
1119
- UNKNOWN = "UNKNOWN",
1120
- SBS = "SBS",
1121
- LICENSER = "LICENSER",
1122
- BASS = "BASS",
1123
- RESELLER = "RESELLER",
1124
- RECURRING_INVOICES = "RECURRING_INVOICES"
1125
- }
1126
- /** @enumType */
1127
- export type ProviderNameWithLiterals = ProviderName | 'UNKNOWN' | 'SBS' | 'LICENSER' | 'BASS' | 'RESELLER' | 'RECURRING_INVOICES';
1128
- export interface Cycle extends CycleCycleSelectorOneOf {
1129
- /** repetitive interval */
1130
- interval?: Interval;
1131
- /** one time */
1132
- oneTime?: OneTime;
1133
- }
1134
- /** @oneof */
1135
- export interface CycleCycleSelectorOneOf {
1136
- /** repetitive interval */
1137
- interval?: Interval;
1138
- /** one time */
1139
- oneTime?: OneTime;
1140
- }
1141
- export interface Interval {
1142
- /** interval unit of measure */
1143
- unit?: IntervalUnitWithLiterals;
1144
- /** number of interval */
1145
- count?: number;
1146
- }
1147
- export declare enum IntervalUnit {
1148
- /** unknown interval unit */
1149
- UNKNOWN = "UNKNOWN",
1150
- /** day */
1151
- DAY = "DAY",
1152
- /** week */
1153
- WEEK = "WEEK",
1154
- /** month */
1155
- MONTH = "MONTH",
1156
- /** year */
1157
- YEAR = "YEAR"
1158
- }
1159
- /** @enumType */
1160
- export type IntervalUnitWithLiterals = IntervalUnit | 'UNKNOWN' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
1161
- export interface OneTime {
1162
- }
1163
- export declare enum SubscriptionStatus {
1164
- UNKNOWN = "UNKNOWN",
1165
- AUTO_RENEW_ON = "AUTO_RENEW_ON",
1166
- AUTO_RENEW_OFF = "AUTO_RENEW_OFF",
1167
- MANUAL_RECURRING = "MANUAL_RECURRING",
1168
- CANCELLED = "CANCELLED",
1169
- TRANSFERRED = "TRANSFERRED"
1170
- }
1171
- /** @enumType */
1172
- export type SubscriptionStatusWithLiterals = SubscriptionStatus | 'UNKNOWN' | 'AUTO_RENEW_ON' | 'AUTO_RENEW_OFF' | 'MANUAL_RECURRING' | 'CANCELLED' | 'TRANSFERRED';
1173
- /** Triggered when a subscription is reactivated. */
1174
- export interface ReactivationData {
1175
- reactivationReason?: ReactivationReasonEnumWithLiterals;
1176
- /**
1177
- * In the event of reactivation after chargeback dispute, the subscription may be extended according to the
1178
- * number of days it was inactive during the time of resolving the dispute
1179
- */
1180
- newEndOfPeriod?: Date | null;
1181
- /** The original end date, before the inactive period. */
1182
- oldEndOfPeriod?: Date | null;
1183
- /** The difference in days between the new new_end_of_period and old_end_of_period */
1184
- differenceInDays?: number | null;
1185
- }
1186
- /** Reason for subscription reactivation */
1187
- export declare enum ReactivationReasonEnum {
1188
- UNKNOWN = "UNKNOWN",
1189
- /**
1190
- * Subscription was reactivated due to billing status change from CANCELED to ACTIVE, for example if it was incorrectly
1191
- * canceled because of suspicion of fraud
1192
- */
1193
- BILLING_STATUS_CHANGE = "BILLING_STATUS_CHANGE",
1194
- /** Subscription was reactivated after a chargeback dispute */
1195
- REACTIVATED_AFTER_CHARGEBACK = "REACTIVATED_AFTER_CHARGEBACK"
1196
- }
1197
- /** @enumType */
1198
- export type ReactivationReasonEnumWithLiterals = ReactivationReasonEnum | 'UNKNOWN' | 'BILLING_STATUS_CHANGE' | 'REACTIVATED_AFTER_CHARGEBACK';
1199
- /**
1200
- * Triggered when a subscription is assigned to a Wix site, including the initial
1201
- * assignment of a floating subscription or a re-assignement from a different site.
1202
- */
1203
- export interface SubscriptionAssigned {
1204
- /** Assigned subscription. */
1205
- subscription?: Subscription;
1206
- /**
1207
- * ID of the metasite that the subscription has been assigned to before the update.
1208
- * @format GUID
1209
- */
1210
- previousMetaSiteId?: string | null;
1211
- }
1212
- /** Triggered when a subscription is canceled. */
1213
- export interface SubscriptionCancelled {
1214
- /** Canceled subscription. */
1215
- subscription?: Subscription;
1216
- /** Details about the cancellation including who canceled the subscription and why. */
1217
- cancellationDetails?: CancellationDetails;
1218
- /**
1219
- * Whether the subscription is canceled immediately or expires at the end of the current billing cycle.
1220
- *
1221
- * Default: `false`
1222
- */
1223
- immediateCancel?: boolean;
1224
- /** Whether the subscription was canceled during the free trial period. */
1225
- canceledInFreeTrial?: boolean;
1226
- }
1227
- /** Information about the cancellation flow including who canceled the subscription and why it was canceled. */
1228
- export interface CancellationDetails {
1229
- /**
1230
- * Cancellation code.
1231
- *
1232
- * Values supported for cancellations on behalf of the billing system: `-1`, `-2`, `-3`, `-4`, `-5`, `-6`, `-7`, `-8`.
1233
- * For cancellations on behalf of the site owner or the service provider `cancellationCode`
1234
- * is taken from the request of
1235
- * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
1236
- *
1237
- * + `-1`: The subscription has been cancelled by the billing system but none of the listed cancellation reasons applies.
1238
- * + `-2`: There were payment problems.
1239
- * + `-3`: There was a chargeback.
1240
- * + `-4`: Customer support has canceled the subscription and issued a refund.
1241
- * + `-5`: The site owner has changed their existing subscription.
1242
- * + `-6`: The subscription has been transferred to a different Wix account.
1243
- * + `-7`: The subscription has been canceled because the site owner hasn't manually authenticated the recurring payment during the subscription's grace period. For example, site owners must manually confirm recurring payments within 40 days when paying with boleto.
1244
- * + `-8`: The Wix account that the subscription belonged to has been deleted.
1245
- */
1246
- cancellationCode?: number | null;
1247
- /**
1248
- * Cancellation reason. For cancellations on behalf of the site owner or the service provider `cancellationReason`
1249
- * is taken from the request of
1250
- * [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
1251
- * For cancellations on behalf of the billing system `cancellationReason` is `null` or an empty string.
1252
- */
1253
- cancellationReason?: string | null;
1254
- /**
1255
- * Initiator of the cancellation. For `"USER_REQUESTED"` and `"APP_MANAGED"`,
1256
- * `cancellationCode` and `cancellationReason` are taken from the request of
1257
- * [Cancel Immediately](https://dev.wix.com/docs/rest/account-level/premium/premium-subscriptions-manager/subscription-v1/cancel-immediately)
1258
- * or [Cancel Immediately Offline](https://dev.wix.com/docs/rest/account-level/premium/premium-subscriptions-manager/subscription-v1/cancel-immediately-offline).
1259
- * For `"PASSIVE"`, cancellations `cancellationCode` is automatically calculated and `cancellationReason`
1260
- * is `null` or an empty string.
1261
- *
1262
- * + `"UNKNOWN`: Default value.
1263
- * + `"USER_REQUESTED"`: The Wix account owner has canceled the subscription.
1264
- * + `"APP_MANAGED"`: The service provider has canceled the subscription.
1265
- * + `"PASSIVE"`: The billing system has canceled the subscription. For example, in case of payment failure or fraud.
1266
- */
1267
- initiator?: InitiatorWithLiterals;
1268
- }
1269
- export declare enum Initiator {
1270
- UNKNOWN = "UNKNOWN",
1271
- USER_REQUESTED = "USER_REQUESTED",
1272
- APP_MANAGED = "APP_MANAGED",
1273
- PASSIVE = "PASSIVE"
1274
- }
1275
- /** @enumType */
1276
- export type InitiatorWithLiterals = Initiator | 'UNKNOWN' | 'USER_REQUESTED' | 'APP_MANAGED' | 'PASSIVE';
1277
- /** Triggered when the subscription's auto renew is turned on. */
1278
- export interface SubscriptionAutoRenewTurnedOn {
1279
- /** Subscription for which auto renew is turned on. */
1280
- subscription?: Subscription;
1281
- /**
1282
- * Supported values: `USER`, `APP`.
1283
- *
1284
- * Information about who turned auto renew on.
1285
- * + `"USER"`: The site owner who purchased the subscription has turned auto renew on.
1286
- * + `"APP"`: The service provider has turned auto renew on.
1287
- */
1288
- initiator?: string | null;
1289
- }
1290
- /** Triggered when the subscription's auto renew is turned off. */
1291
- export interface SubscriptionAutoRenewTurnedOff {
1292
- /** Subscription for which auto renew is turned off. */
1293
- subscription?: Subscription;
1294
- /** Details about the cancellation including who canceled the subscription and why. */
1295
- cancellationDetails?: CancellationDetails;
1296
- /**
1297
- * Whether the subscription is immediately canceled or expires at the end of the current billing cycle.
1298
- *
1299
- * Default: `false`
1300
- */
1301
- immediateCancel?: boolean;
1302
- }
1303
- /**
1304
- * Triggered when a subscription is unassigned from a Wix site and becomes
1305
- * floating.
1306
- */
1307
- export interface SubscriptionUnassigned {
1308
- /** Unassigned subscription. */
1309
- subscription?: Subscription;
1310
- /**
1311
- * ID of the metasite that the subscription has been assigned to before the event.
1312
- * @format GUID
1313
- */
1314
- previousMetaSiteId?: string;
1315
- /**
1316
- * Reason why the subscription is unassigned.
1317
- *
1318
- * + `"UNKNOWN"`: Default value.
1319
- * + `"USER_REQUESTED"`: The Wix account owner has unassigned the subscription.
1320
- * + `"REPLACED_BY_ANOTHER_SUBSCRIPTION"`: A different subscription that replaces this subscription is assigned to the site.
1321
- */
1322
- unassignReason?: UnassignReasonWithLiterals;
1323
- }
1324
- export declare enum UnassignReason {
1325
- UNKNOWN = "UNKNOWN",
1326
- USER_REQUESTED = "USER_REQUESTED",
1327
- REPLACED_BY_ANOTHER_SUBSCRIPTION = "REPLACED_BY_ANOTHER_SUBSCRIPTION"
1328
- }
1329
- /** @enumType */
1330
- export type UnassignReasonWithLiterals = UnassignReason | 'UNKNOWN' | 'USER_REQUESTED' | 'REPLACED_BY_ANOTHER_SUBSCRIPTION';
1331
- /**
1332
- * Triggered when a subscription is transferred from one Wix account to another.
1333
- * A transfer includes cancelling the original subscription and creating a new
1334
- * subscription for the target account. The event returns both the original
1335
- * and the new subscription.
1336
- */
1337
- export interface SubscriptionTransferred {
1338
- /** Original subscription that was canceled for the transfer. */
1339
- originSubscription?: Subscription;
1340
- /** Newly created subscription for the target account. */
1341
- targetSubscription?: Subscription;
1342
- }
1343
- /** Triggered when a recurring charge succeeds for a subscription. */
1344
- export interface RecurringChargeSucceeded {
1345
- /** Subscription for which the recurring charge has succeeded. */
1346
- subscription?: Subscription;
1347
- /** Indication that there was a successful charge at the end of the free trial period */
1348
- freeTrialPeriodEnd?: boolean;
1349
- }
1350
- /**
1351
- * Triggered when a subscription was updated including when its product has been
1352
- * up- or downgraded or the billing cycle is changed.
1353
- */
1354
- export interface ContractSwitched {
1355
- /** Updated subscription. */
1356
- subscription?: Subscription;
1357
- /** Billing cycle before the update. */
1358
- previousCycle?: Cycle;
1359
- /**
1360
- * ID of the product belonging to the subscription before the update.
1361
- * @format GUID
1362
- */
1363
- previousProductId?: string;
1364
- /**
1365
- * ID of the product type that the subscription's original product belonged to before the update.
1366
- * @format GUID
1367
- */
1368
- previousProductTypeId?: string;
1369
- /**
1370
- * Update type. __Note__: Doesn't include information about a product adjustment.
1371
- * For that purpose, see `productAdjustment`.
1372
- *
1373
- * + `"NOT_APPLICABLE"`: Default value.
1374
- * + `"ADDITIONAL_QUANTITY"`: An increased usage quota is added to the subscription. For example, a second mailbox is added to a subscription that previously included a single mailbox.
1375
- * + `"CREDIT_UNUSED_PERIOD"`: The subscription is upgraded and the new price is less than the regular price. The new price applies to every billing cycle, not just the first cycle.
1376
- * + `"REFUND_PRICE_DIFF"`: Not implemented.
1377
- * + `"ADJUST_PERIOD_END"`: Not implemented.
1378
- * + `"DOWNGRADE_GRACE_PERIOD"`: For downgrades during the grace period. In this situation, the site owner hasn’t paid yet and must immediately pay for the downgraded subscription.
1379
- * + `"FULL_AMOUNT_PERIOD"`: For upgrades in which the site owner retains unused benefits. For example, site owners upgrading a Facebook Ads subscription retain their unused FB Ads credit. The unused credit is added to the new credit.
1380
- * + `"END_OF_PERIOD"`: The subscription's billing current cycle is extended because of a downgrade.
1381
- * + `"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.
1382
- * + `"DOWNGRADE_RENEWAL"`: The subscription is downgraded because of a declined payment. This prevents subscriptions from churning.
1383
- */
1384
- contractSwitchType?: ContractSwitchTypeWithLiterals;
1385
- /**
1386
- * ID of the metasite the subscription has been assigned to previously.
1387
- * Available only in case the subscription is assigned to a different site.
1388
- * @format GUID
1389
- */
1390
- previousMetaSiteId?: string | null;
1391
- /**
1392
- * Update reason.
1393
- *
1394
- * + `"PRICE_INCREASE"`: The subscription's price has been increased.
1395
- * + `"EXTERNAL_PROVIDER_TRIGGER"`: Any reason other than a price increase.
1396
- */
1397
- contractSwitchReason?: ContractSwitchReasonWithLiterals;
1398
- /** Information about the price update. Available only for updates with a price increase. */
1399
- productPriceIncreaseData?: ProductPriceIncreaseData;
1400
- /**
1401
- * Information about a product adjustment. For example, a downgrade.
1402
- * __Note__: This isn't the same as `contractSwitchType`.
1403
- *
1404
- * + `NOT_APPLICABLE`: There is no information about whether the product has been up- or downgraded.
1405
- * + `DOWNGRADE`: The product has been downgraded.
1406
- */
1407
- productAdjustment?: ProductAdjustmentWithLiterals;
1408
- }
1409
- /** Copied from SBS */
1410
- export declare enum ContractSwitchType {
1411
- NOT_APPLICABLE = "NOT_APPLICABLE",
1412
- ADDITIONAL_QUANTITY = "ADDITIONAL_QUANTITY",
1413
- CREDIT_UNUSED_PERIOD = "CREDIT_UNUSED_PERIOD",
1414
- REFUND_PRICE_DIFF = "REFUND_PRICE_DIFF",
1415
- ADJUST_PERIOD_END = "ADJUST_PERIOD_END",
1416
- DOWNGRADE_GRACE_PERIOD = "DOWNGRADE_GRACE_PERIOD",
1417
- FULL_AMOUNT_PERIOD = "FULL_AMOUNT_PERIOD",
1418
- END_OF_PERIOD = "END_OF_PERIOD",
1419
- PENDING_CHANGES = "PENDING_CHANGES",
1420
- DOWNGRADE_RENEWAL = "DOWNGRADE_RENEWAL"
1421
- }
1422
- /** @enumType */
1423
- 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';
1424
- export declare enum ContractSwitchReason {
1425
- EXTERNAL_PROVIDER_TRIGGER = "EXTERNAL_PROVIDER_TRIGGER",
1426
- PRICE_INCREASE = "PRICE_INCREASE"
1427
- }
1428
- /** @enumType */
1429
- export type ContractSwitchReasonWithLiterals = ContractSwitchReason | 'EXTERNAL_PROVIDER_TRIGGER' | 'PRICE_INCREASE';
1430
- /** Triggered when a subscription's price is increased. */
1431
- export interface ProductPriceIncreaseData {
1432
- /**
1433
- * Price of the subscription before the update.
1434
- * @format DECIMAL_VALUE
1435
- */
1436
- previousPrice?: string | null;
1437
- /** A value that is used in order to select the correct email template to send the user regarding the price increase. */
1438
- emailTemplateSelector?: string | null;
1439
- /** Used to differentiate between migration segments. Does not have to be unique per segment. */
1440
- segmentName?: string | null;
1441
- /** Used to determine how the price increase was triggered. */
1442
- priceIncreaseTrigger?: PriceIncreaseTriggerWithLiterals;
1443
- }
1444
- /** Reason for Price Increase Trigger */
1445
- export declare enum PriceIncreaseTrigger {
1446
- NEAR_RENEWAL = "NEAR_RENEWAL",
1447
- RECURRING_SUCCESS = "RECURRING_SUCCESS",
1448
- MANUAL = "MANUAL"
1449
- }
1450
- /** @enumType */
1451
- export type PriceIncreaseTriggerWithLiterals = PriceIncreaseTrigger | 'NEAR_RENEWAL' | 'RECURRING_SUCCESS' | 'MANUAL';
1452
- /** Triggered when a subscription's product is adusted. */
1453
- export declare enum ProductAdjustment {
1454
- /** flag to show that the ContractSwitchedEvent is not applicable / needed */
1455
- NOT_APPLICABLE = "NOT_APPLICABLE",
1456
- /** flag to show that the ContractSwitchedEvent is a Downgrade */
1457
- DOWNGRADE = "DOWNGRADE"
1458
- }
1459
- /** @enumType */
1460
- export type ProductAdjustmentWithLiterals = ProductAdjustment | 'NOT_APPLICABLE' | 'DOWNGRADE';
1461
- /**
1462
- * Triggered when a subscription gets close to the end of its billing cycle.
1463
- * The exact number of days is defined in the billing system.
1464
- */
1465
- export interface SubscriptionNearEndOfPeriod {
1466
- /** Subscription that got close to the end of its billing cycle. */
1467
- subscription?: Subscription;
1468
- /** Whether the subscription is within the free trial period. */
1469
- inFreeTrial?: boolean;
1470
- }
1471
- /**
1472
- * Triggered when a subscription is updated and the change doesn't happen
1473
- * immediately but at the end of the current billing cycle.
1474
- */
1475
- export interface SubscriptionPendingChange {
1476
- /** Subscription for which a pending update is triggered. */
1477
- subscription?: Subscription;
1478
- }
1479
- /** Triggered when a recurring charge attempt failed for a subscription. */
1480
- export interface RecurringChargeAttemptFailed {
1481
- /** Subscription for which the recurring charge attempt has failed. */
1482
- subscription?: Subscription;
1483
- }
1484
- export interface MessageEnvelope {
1485
- /**
1486
- * App instance ID.
1487
- * @format GUID
1488
- */
1489
- instanceId?: string | null;
1490
- /**
1491
- * Event type.
1492
- * @maxLength 150
1493
- */
1494
- eventType?: string;
1495
- /** The identification type and identity data. */
1496
- identity?: IdentificationData;
1497
- /** Stringify payload. */
1498
- data?: string;
1499
- }
1500
- export interface IdentificationData extends IdentificationDataIdOneOf {
1501
- /**
1502
- * ID of a site visitor that has not logged in to the site.
1503
- * @format GUID
1504
- */
1505
- anonymousVisitorId?: string;
1506
- /**
1507
- * ID of a site visitor that has logged in to the site.
1508
- * @format GUID
1509
- */
1510
- memberId?: string;
1511
- /**
1512
- * ID of a Wix user (site owner, contributor, etc.).
1513
- * @format GUID
1514
- */
1515
- wixUserId?: string;
1516
- /**
1517
- * ID of an app.
1518
- * @format GUID
1519
- */
1520
- appId?: string;
1521
- /** @readonly */
1522
- identityType?: WebhookIdentityTypeWithLiterals;
1523
- }
1524
- /** @oneof */
1525
- export interface IdentificationDataIdOneOf {
1526
- /**
1527
- * ID of a site visitor that has not logged in to the site.
1528
- * @format GUID
1529
- */
1530
- anonymousVisitorId?: string;
1531
- /**
1532
- * ID of a site visitor that has logged in to the site.
1533
- * @format GUID
1534
- */
1535
- memberId?: string;
1536
- /**
1537
- * ID of a Wix user (site owner, contributor, etc.).
1538
- * @format GUID
1539
- */
1540
- wixUserId?: string;
1541
- /**
1542
- * ID of an app.
1543
- * @format GUID
1544
- */
1545
- appId?: string;
1546
- }
1547
- export declare enum WebhookIdentityType {
1548
- UNKNOWN = "UNKNOWN",
1549
- ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1550
- MEMBER = "MEMBER",
1551
- WIX_USER = "WIX_USER",
1552
- APP = "APP"
1553
- }
1554
- /** @enumType */
1555
- export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1556
- export interface BaseEventMetadata {
1557
- /**
1558
- * App instance ID.
1559
- * @format GUID
1560
- */
1561
- instanceId?: string | null;
1562
- /**
1563
- * Event type.
1564
- * @maxLength 150
1565
- */
1566
- eventType?: string;
1567
- /** The identification type and identity data. */
1568
- identity?: IdentificationData;
1569
- }
1570
- export interface EventMetadata extends BaseEventMetadata {
1571
- /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1572
- _id?: string;
1573
- /**
1574
- * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1575
- * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1576
- */
1577
- entityFqdn?: string;
1578
- /**
1579
- * Event action name, placed at the top level to make it easier for users to dispatch messages.
1580
- * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1581
- */
1582
- slug?: string;
1583
- /** ID of the entity associated with the event. */
1584
- entityId?: string;
1585
- /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1586
- eventTime?: Date | null;
1587
- /**
1588
- * Whether the event was triggered as a result of a privacy regulation application
1589
- * (for example, GDPR).
1590
- */
1591
- triggeredByAnonymizeRequest?: boolean | null;
1592
- /** If present, indicates the action that triggered the event. */
1593
- originatedFrom?: string | null;
1594
- /**
1595
- * 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.
1596
- * 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.
1597
- */
1598
- entityEventSequence?: string | null;
1599
- }
1600
- export interface ProgramUpdatedEnvelope {
1601
- entity: ReferralProgram;
1602
- metadata: EventMetadata;
1603
- }
1604
- /**
1605
- * Triggered when a referral program is updated.
1606
- * @permissionScope Manage Restaurants - all permissions
1607
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1608
- * @permissionScope Manage Referrals
1609
- * @permissionScopeId SCOPE.DC-REFERRALS.MANAGE-REFERRALS
1610
- * @permissionId REFERRALS.READ_PROGRAM
1611
- * @webhook
1612
- * @eventType wix.loyalty.referral.v1.program_updated
1613
- * @serviceIdentifier wix.loyalty.referral.program.v1.ReferralPrograms
1614
- * @slug updated
1615
- */
1616
- export declare function onProgramUpdated(handler: (event: ProgramUpdatedEnvelope) => void | Promise<void>): void;
1617
- type ProgramNonNullablePaths = `status` | `referredFriendReward.couponOptions.fixedAmountOptions.amount` | `referredFriendReward.couponOptions.percentageOptions.percentage` | `referredFriendReward.couponOptions.minimumSubtotal` | `referredFriendReward.couponOptions.scope.namespace` | `referredFriendReward.couponOptions.scope.group.name` | `referredFriendReward.couponOptions.name` | `referredFriendReward.couponOptions.discountType` | `referredFriendReward.loyaltyPointsOptions.amount` | `referredFriendReward.type` | `referringCustomerReward.couponOptions.fixedAmountOptions.amount` | `referringCustomerReward.couponOptions.percentageOptions.percentage` | `referringCustomerReward.couponOptions.minimumSubtotal` | `referringCustomerReward.couponOptions.scope.namespace` | `referringCustomerReward.couponOptions.scope.group.name` | `referringCustomerReward.couponOptions.name` | `referringCustomerReward.couponOptions.discountType` | `referringCustomerReward.loyaltyPointsOptions.amount` | `referringCustomerReward.type` | `successfulReferralActions` | `emails.encourageToReferFriends` | `emails.notifyCustomersAboutReward` | `premiumFeatures.referralProgram`;
1618
- /**
1619
- * Retrieves the referral program.
1620
- * @public
1621
- * @permissionId REFERRALS.READ_PROGRAM
1622
- * @permissionScope Manage Restaurants - all permissions
1623
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1624
- * @permissionScope Manage Referrals
1625
- * @permissionScopeId SCOPE.DC-REFERRALS.MANAGE-REFERRALS
1626
- * @applicableIdentity APP
1627
- * @applicableIdentity VISITOR
1628
- * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.GetReferralProgram
1629
- */
1630
- export declare function getReferralProgram(): Promise<NonNullablePaths<GetReferralProgramResponse, {
1631
- [P in ProgramNonNullablePaths]: `referralProgram.${P}`;
1632
- }[ProgramNonNullablePaths]>>;
1633
- /**
1634
- * Updates a referral program. Supports partial updates.
1635
- *
1636
- * Revision number, which increments by 1 each time the referral program is updated.
1637
- * To prevent conflicting changes, the current revision must be passed when updating the referral program.
1638
- * @param referralProgram - Referral program to update. Include the latest `revision` for a successful update.
1639
- * @public
1640
- * @requiredField referralProgram
1641
- * @requiredField referralProgram.revision
1642
- * @permissionId REFERRALS.MANAGE_PROGRAM
1643
- * @permissionScope Manage Restaurants - all permissions
1644
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1645
- * @permissionScope Manage Referrals
1646
- * @permissionScopeId SCOPE.DC-REFERRALS.MANAGE-REFERRALS
1647
- * @applicableIdentity APP
1648
- * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.UpdateReferralProgram
1649
- */
1650
- export declare function updateReferralProgram(referralProgram: NonNullablePaths<ReferralProgram, `revision`>): Promise<NonNullablePaths<UpdateReferralProgramResponse, {
1651
- [P in ProgramNonNullablePaths]: `referralProgram.${P}`;
1652
- }[ProgramNonNullablePaths]>>;
1653
- /**
1654
- * Activates the referral program, changing its status to `ACTIVE`.
1655
- * @public
1656
- * @permissionId REFERRALS.MANAGE_PROGRAM
1657
- * @permissionScope Manage Restaurants - all permissions
1658
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1659
- * @permissionScope Manage Referrals
1660
- * @permissionScopeId SCOPE.DC-REFERRALS.MANAGE-REFERRALS
1661
- * @applicableIdentity APP
1662
- * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.ActivateReferralProgram
1663
- */
1664
- export declare function activateReferralProgram(): Promise<NonNullablePaths<ActivateReferralProgramResponse, {
1665
- [P in ProgramNonNullablePaths]: `referralProgram.${P}`;
1666
- }[ProgramNonNullablePaths]>>;
1667
- /**
1668
- * Pauses the referral program, changing its status to `PAUSED`.
1669
- * @public
1670
- * @permissionId REFERRALS.MANAGE_PROGRAM
1671
- * @permissionScope Manage Restaurants - all permissions
1672
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1673
- * @permissionScope Manage Referrals
1674
- * @permissionScopeId SCOPE.DC-REFERRALS.MANAGE-REFERRALS
1675
- * @applicableIdentity APP
1676
- * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.PauseReferralProgram
1677
- */
1678
- export declare function pauseReferralProgram(): Promise<NonNullablePaths<PauseReferralProgramResponse, {
1679
- [P in ProgramNonNullablePaths]: `referralProgram.${P}`;
1680
- }[ProgramNonNullablePaths]>>;
1681
- /**
1682
- * Retrieves pre-generated AI social media post suggestions for promoting the referral program.
1683
- *
1684
- * This method returns a list of AI-generated social media post suggestions that site owners or members can use to promote the referral program. You can display these suggestions to allow referring customers to easily copy and share them on their preferred social media platforms.
1685
- *
1686
- * >**Note**: This method retrieves existing suggestions. To generate new ones,
1687
- * use Generate AI Social Media Posts Suggestions.
1688
- * @public
1689
- * @permissionId REFERRALS.MANAGE_PROGRAM
1690
- * @permissionScope Manage Restaurants - all permissions
1691
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1692
- * @permissionScope Manage Referrals
1693
- * @permissionScopeId SCOPE.DC-REFERRALS.MANAGE-REFERRALS
1694
- * @applicableIdentity APP
1695
- * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.GetAISocialMediaPostsSuggestions
1696
- */
1697
- export declare function getAiSocialMediaPostsSuggestions(options?: GetAiSocialMediaPostsSuggestionsOptions): Promise<NonNullablePaths<GetAISocialMediaPostsSuggestionsResponse, `suggestions` | `suggestions.${number}.postContent`>>;
1698
- export interface GetAiSocialMediaPostsSuggestionsOptions {
1699
- /**
1700
- * Topic to generate social media post suggestions for. For example, fitness, education, or technology.
1701
- * @maxLength 512
1702
- */
1703
- topic?: string;
1704
- }
1705
- /**
1706
- * Creates new AI-generated social media post suggestions for promoting the referral program.
1707
- *
1708
- * This method generates new AI-powered social media post suggestions for promoting the referral program. Use it to refresh content or create alternatives to existing suggestions.
1709
- *
1710
- * >**Note**: This method generates new suggestions each time it's called. To retrieve existing suggestions without generating new ones, use Get AI Social Media Posts Suggestions.
1711
- * @public
1712
- * @permissionId REFERRALS.MANAGE_PROGRAM
1713
- * @permissionScope Manage Restaurants - all permissions
1714
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1715
- * @permissionScope Manage Referrals
1716
- * @permissionScopeId SCOPE.DC-REFERRALS.MANAGE-REFERRALS
1717
- * @applicableIdentity APP
1718
- * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.GenerateAISocialMediaPostsSuggestions
1719
- */
1720
- export declare function generateAiSocialMediaPostsSuggestions(options?: GenerateAiSocialMediaPostsSuggestionsOptions): Promise<NonNullablePaths<GenerateAISocialMediaPostsSuggestionsResponse, `suggestions` | `suggestions.${number}.postContent`>>;
1721
- export interface GenerateAiSocialMediaPostsSuggestionsOptions {
1722
- /**
1723
- * Topic to generate social media post suggestions for. For example, fitness, education, or technology.
1724
- * @maxLength 512
1725
- */
1726
- topic?: string;
1727
- }
1728
- /**
1729
- * Retrieves information about the enabled premium features for the referral program.
1730
- * @public
1731
- * @permissionId REFERRALS.READ_PROGRAM
1732
- * @permissionScope Manage Restaurants - all permissions
1733
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
1734
- * @permissionScope Manage Referrals
1735
- * @permissionScopeId SCOPE.DC-REFERRALS.MANAGE-REFERRALS
1736
- * @applicableIdentity APP
1737
- * @applicableIdentity VISITOR
1738
- * @fqn wix.loyalty.referral.program.v1.ReferralPrograms.GetReferralProgramPremiumFeatures
1739
- */
1740
- export declare function getReferralProgramPremiumFeatures(): Promise<NonNullablePaths<GetReferralProgramPremiumFeaturesResponse, `referralProgram`>>;
1741
- export {};