@wix/auto_sdk_referral_programs 1.0.12 → 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.
- package/build/index.d.mts +81 -0
- package/build/index.d.ts +81 -0
- package/build/index.js +991 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +939 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/index.d.mts +93 -0
- package/build/internal/index.d.ts +93 -0
- package/build/internal/index.js +991 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +939 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{cjs/src/loyalty-referral-v1-program-programs.types.d.ts → internal/loyalty-referral-v1-program-programs.universal-C3JvbwiY.d.mts} +205 -143
- package/build/internal/{cjs/src/loyalty-referral-v1-program-programs.types.d.ts → loyalty-referral-v1-program-programs.universal-C3JvbwiY.d.ts} +205 -143
- package/build/internal/meta.d.mts +357 -0
- package/build/internal/meta.d.ts +357 -0
- package/build/internal/meta.js +606 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +572 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{es/src/loyalty-referral-v1-program-programs.types.d.ts → loyalty-referral-v1-program-programs.universal-BCsb8iST.d.mts} +205 -143
- package/build/{internal/es/src/loyalty-referral-v1-program-programs.types.d.ts → loyalty-referral-v1-program-programs.universal-BCsb8iST.d.ts} +205 -143
- package/build/meta.d.mts +357 -0
- package/build/meta.d.ts +357 -0
- package/build/meta.js +606 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +572 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/loyalty-referral-v1-program-programs.context.d.ts +0 -17
- package/build/cjs/src/loyalty-referral-v1-program-programs.context.js +0 -42
- package/build/cjs/src/loyalty-referral-v1-program-programs.context.js.map +0 -1
- package/build/cjs/src/loyalty-referral-v1-program-programs.http.d.ts +0 -39
- package/build/cjs/src/loyalty-referral-v1-program-programs.http.js +0 -450
- package/build/cjs/src/loyalty-referral-v1-program-programs.http.js.map +0 -1
- package/build/cjs/src/loyalty-referral-v1-program-programs.meta.d.ts +0 -20
- package/build/cjs/src/loyalty-referral-v1-program-programs.meta.js +0 -180
- package/build/cjs/src/loyalty-referral-v1-program-programs.meta.js.map +0 -1
- package/build/cjs/src/loyalty-referral-v1-program-programs.public.d.ts +0 -69
- package/build/cjs/src/loyalty-referral-v1-program-programs.public.js +0 -114
- package/build/cjs/src/loyalty-referral-v1-program-programs.public.js.map +0 -1
- package/build/cjs/src/loyalty-referral-v1-program-programs.types.js +0 -284
- package/build/cjs/src/loyalty-referral-v1-program-programs.types.js.map +0 -1
- package/build/cjs/src/loyalty-referral-v1-program-programs.universal.d.ts +0 -1725
- package/build/cjs/src/loyalty-referral-v1-program-programs.universal.js +0 -581
- package/build/cjs/src/loyalty-referral-v1-program-programs.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/loyalty-referral-v1-program-programs.context.d.ts +0 -17
- package/build/es/src/loyalty-referral-v1-program-programs.context.js +0 -19
- package/build/es/src/loyalty-referral-v1-program-programs.context.js.map +0 -1
- package/build/es/src/loyalty-referral-v1-program-programs.http.d.ts +0 -39
- package/build/es/src/loyalty-referral-v1-program-programs.http.js +0 -439
- package/build/es/src/loyalty-referral-v1-program-programs.http.js.map +0 -1
- package/build/es/src/loyalty-referral-v1-program-programs.meta.d.ts +0 -20
- package/build/es/src/loyalty-referral-v1-program-programs.meta.js +0 -146
- package/build/es/src/loyalty-referral-v1-program-programs.meta.js.map +0 -1
- package/build/es/src/loyalty-referral-v1-program-programs.public.d.ts +0 -69
- package/build/es/src/loyalty-referral-v1-program-programs.public.js +0 -83
- package/build/es/src/loyalty-referral-v1-program-programs.public.js.map +0 -1
- package/build/es/src/loyalty-referral-v1-program-programs.types.js +0 -281
- package/build/es/src/loyalty-referral-v1-program-programs.types.js.map +0 -1
- package/build/es/src/loyalty-referral-v1-program-programs.universal.d.ts +0 -1725
- package/build/es/src/loyalty-referral-v1-program-programs.universal.js +0 -547
- package/build/es/src/loyalty-referral-v1-program-programs.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.context.d.ts +0 -19
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.context.js +0 -42
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.context.js.map +0 -1
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.http.d.ts +0 -39
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.http.js +0 -450
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.http.js.map +0 -1
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.meta.d.ts +0 -20
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.meta.js +0 -180
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.meta.js.map +0 -1
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.public.d.ts +0 -79
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.public.js +0 -114
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.public.js.map +0 -1
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.types.js +0 -284
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.types.js.map +0 -1
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.universal.d.ts +0 -1737
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.universal.js +0 -581
- package/build/internal/cjs/src/loyalty-referral-v1-program-programs.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/loyalty-referral-v1-program-programs.context.d.ts +0 -19
- package/build/internal/es/src/loyalty-referral-v1-program-programs.context.js +0 -19
- package/build/internal/es/src/loyalty-referral-v1-program-programs.context.js.map +0 -1
- package/build/internal/es/src/loyalty-referral-v1-program-programs.http.d.ts +0 -39
- package/build/internal/es/src/loyalty-referral-v1-program-programs.http.js +0 -439
- package/build/internal/es/src/loyalty-referral-v1-program-programs.http.js.map +0 -1
- package/build/internal/es/src/loyalty-referral-v1-program-programs.meta.d.ts +0 -20
- package/build/internal/es/src/loyalty-referral-v1-program-programs.meta.js +0 -146
- package/build/internal/es/src/loyalty-referral-v1-program-programs.meta.js.map +0 -1
- package/build/internal/es/src/loyalty-referral-v1-program-programs.public.d.ts +0 -79
- package/build/internal/es/src/loyalty-referral-v1-program-programs.public.js +0 -83
- package/build/internal/es/src/loyalty-referral-v1-program-programs.public.js.map +0 -1
- package/build/internal/es/src/loyalty-referral-v1-program-programs.types.js +0 -281
- package/build/internal/es/src/loyalty-referral-v1-program-programs.types.js.map +0 -1
- package/build/internal/es/src/loyalty-referral-v1-program-programs.universal.d.ts +0 -1737
- package/build/internal/es/src/loyalty-referral-v1-program-programs.universal.js +0 -547
- package/build/internal/es/src/loyalty-referral-v1-program-programs.universal.js.map +0 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
interface ReferralProgram {
|
|
2
2
|
/**
|
|
3
3
|
* Referral program name.
|
|
4
4
|
* @minLength 2
|
|
@@ -17,12 +17,12 @@ export interface ReferralProgram {
|
|
|
17
17
|
* Date and time the program was created.
|
|
18
18
|
* @readonly
|
|
19
19
|
*/
|
|
20
|
-
|
|
20
|
+
_createdDate?: Date | null;
|
|
21
21
|
/**
|
|
22
22
|
* Date and time the program was last updated.
|
|
23
23
|
* @readonly
|
|
24
24
|
*/
|
|
25
|
-
|
|
25
|
+
_updatedDate?: Date | null;
|
|
26
26
|
/**
|
|
27
27
|
* Reward configuration for the referred friend.
|
|
28
28
|
* Specifies the reward given to a new customer who was referred to the business.
|
|
@@ -47,7 +47,7 @@ export interface ReferralProgram {
|
|
|
47
47
|
premiumFeatures?: PremiumFeatures;
|
|
48
48
|
}
|
|
49
49
|
/** Status of the referral program. */
|
|
50
|
-
|
|
50
|
+
declare enum ProgramStatus {
|
|
51
51
|
/** Unknown program status. */
|
|
52
52
|
UNKNOWN = "UNKNOWN",
|
|
53
53
|
/** Referral program is in a draft state and is being modified. It is not yet active. */
|
|
@@ -58,8 +58,8 @@ export declare enum ProgramStatus {
|
|
|
58
58
|
PAUSED = "PAUSED"
|
|
59
59
|
}
|
|
60
60
|
/** @enumType */
|
|
61
|
-
|
|
62
|
-
|
|
61
|
+
type ProgramStatusWithLiterals = ProgramStatus | 'UNKNOWN' | 'DRAFT' | 'ACTIVE' | 'PAUSED';
|
|
62
|
+
interface Reward extends RewardOptionsOneOf {
|
|
63
63
|
/** Options for coupon reward type. */
|
|
64
64
|
couponOptions?: Coupon;
|
|
65
65
|
/** Options for the Loyalty points reward type. */
|
|
@@ -68,13 +68,13 @@ export interface Reward extends RewardOptionsOneOf {
|
|
|
68
68
|
type?: TypeWithLiterals;
|
|
69
69
|
}
|
|
70
70
|
/** @oneof */
|
|
71
|
-
|
|
71
|
+
interface RewardOptionsOneOf {
|
|
72
72
|
/** Options for coupon reward type. */
|
|
73
73
|
couponOptions?: Coupon;
|
|
74
74
|
/** Options for the Loyalty points reward type. */
|
|
75
75
|
loyaltyPointsOptions?: LoyaltyPoints;
|
|
76
76
|
}
|
|
77
|
-
|
|
77
|
+
declare enum Type {
|
|
78
78
|
/** Unknown reward type. */
|
|
79
79
|
UNKNOWN = "UNKNOWN",
|
|
80
80
|
/** Coupon reward type. */
|
|
@@ -85,8 +85,8 @@ export declare enum Type {
|
|
|
85
85
|
NOTHING = "NOTHING"
|
|
86
86
|
}
|
|
87
87
|
/** @enumType */
|
|
88
|
-
|
|
89
|
-
|
|
88
|
+
type TypeWithLiterals = Type | 'UNKNOWN' | 'COUPON' | 'LOYALTY_POINTS' | 'NOTHING';
|
|
89
|
+
interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
|
|
90
90
|
/** Options for fixed amount discount. */
|
|
91
91
|
fixedAmountOptions?: FixedAmountDiscount;
|
|
92
92
|
/** Options for percentage discounts. */
|
|
@@ -123,20 +123,20 @@ export interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMin
|
|
|
123
123
|
discountedCycleCount?: number | null;
|
|
124
124
|
}
|
|
125
125
|
/** @oneof */
|
|
126
|
-
|
|
126
|
+
interface CouponDiscountTypeOptionsOneOf {
|
|
127
127
|
/** Options for fixed amount discount. */
|
|
128
128
|
fixedAmountOptions?: FixedAmountDiscount;
|
|
129
129
|
/** Options for percentage discounts. */
|
|
130
130
|
percentageOptions?: PercentageDiscount;
|
|
131
131
|
}
|
|
132
132
|
/** @oneof */
|
|
133
|
-
|
|
133
|
+
interface CouponScopeOrMinSubtotalOneOf {
|
|
134
134
|
/** Limit the coupon to carts with a subtotal above this number. */
|
|
135
135
|
minimumSubtotal?: number;
|
|
136
136
|
/** 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). */
|
|
137
137
|
scope?: CouponScope;
|
|
138
138
|
}
|
|
139
|
-
|
|
139
|
+
declare enum DiscountType {
|
|
140
140
|
/** Unknown discount type. */
|
|
141
141
|
UNKNOWN = "UNKNOWN",
|
|
142
142
|
/** Discount as a fixed amount. */
|
|
@@ -147,31 +147,31 @@ export declare enum DiscountType {
|
|
|
147
147
|
FREE_SHIPPING = "FREE_SHIPPING"
|
|
148
148
|
}
|
|
149
149
|
/** @enumType */
|
|
150
|
-
|
|
151
|
-
|
|
150
|
+
type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN' | 'FIXED_AMOUNT' | 'PERCENTAGE' | 'FREE_SHIPPING';
|
|
151
|
+
interface FixedAmountDiscount {
|
|
152
152
|
/** Amount of the discount as a fixed value. */
|
|
153
153
|
amount?: number;
|
|
154
154
|
}
|
|
155
|
-
|
|
155
|
+
interface PercentageDiscount {
|
|
156
156
|
/**
|
|
157
157
|
* Percentage of discount.
|
|
158
158
|
* @max 100
|
|
159
159
|
*/
|
|
160
160
|
percentage?: number;
|
|
161
161
|
}
|
|
162
|
-
|
|
162
|
+
interface CouponScope {
|
|
163
163
|
/** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
|
|
164
164
|
namespace?: string;
|
|
165
165
|
/** Coupon scope's applied group, for example, Event or ticket in Wix Events. */
|
|
166
166
|
group?: Group;
|
|
167
167
|
}
|
|
168
|
-
|
|
168
|
+
interface Group {
|
|
169
169
|
/** Name of the group. */
|
|
170
170
|
name?: string;
|
|
171
171
|
/** Entity ID of the group. */
|
|
172
172
|
entityId?: string | null;
|
|
173
173
|
}
|
|
174
|
-
|
|
174
|
+
interface LoyaltyPoints {
|
|
175
175
|
/**
|
|
176
176
|
* Number of loyalty points to give.
|
|
177
177
|
* @min 1
|
|
@@ -179,7 +179,7 @@ export interface LoyaltyPoints {
|
|
|
179
179
|
*/
|
|
180
180
|
amount?: number;
|
|
181
181
|
}
|
|
182
|
-
|
|
182
|
+
declare enum Action {
|
|
183
183
|
/** Unknown action. */
|
|
184
184
|
UNKNOWN = "UNKNOWN",
|
|
185
185
|
/** Referred friend ordered and paid for an order in a store. */
|
|
@@ -196,8 +196,8 @@ export declare enum Action {
|
|
|
196
196
|
ONLINE_PROGRAM_JOINED = "ONLINE_PROGRAM_JOINED"
|
|
197
197
|
}
|
|
198
198
|
/** @enumType */
|
|
199
|
-
|
|
200
|
-
|
|
199
|
+
type ActionWithLiterals = Action | 'UNKNOWN' | 'STORE_ORDER_PLACED' | 'PLAN_ORDERED' | 'TICKET_ORDERED' | 'SESSION_BOOKED' | 'RESTAURANT_ORDER_PLACED' | 'ONLINE_PROGRAM_JOINED';
|
|
200
|
+
interface Emails {
|
|
201
201
|
/** Configures email invitations to encourage customers to refer their friends. Select the apps for which this feature is enabled. */
|
|
202
202
|
encourageToReferFriends?: AppWithLiterals[];
|
|
203
203
|
/**
|
|
@@ -206,7 +206,7 @@ export interface Emails {
|
|
|
206
206
|
*/
|
|
207
207
|
notifyCustomersAboutReward?: boolean;
|
|
208
208
|
}
|
|
209
|
-
|
|
209
|
+
declare enum App {
|
|
210
210
|
/** Unknown app. */
|
|
211
211
|
UNKNOWN = "UNKNOWN",
|
|
212
212
|
/** Send an email to customers who've placed an order with stores. */
|
|
@@ -223,27 +223,27 @@ export declare enum App {
|
|
|
223
223
|
ONLINE_PROGRAMS = "ONLINE_PROGRAMS"
|
|
224
224
|
}
|
|
225
225
|
/** @enumType */
|
|
226
|
-
|
|
227
|
-
|
|
226
|
+
type AppWithLiterals = App | 'UNKNOWN' | 'STORES' | 'PRICING_PLANS' | 'EVENTS' | 'BOOKINGS' | 'RESTAURANTS' | 'ONLINE_PROGRAMS';
|
|
227
|
+
interface PremiumFeatures {
|
|
228
228
|
/**
|
|
229
229
|
* Whether the site owner has access to the referral program feature.
|
|
230
230
|
* @readonly
|
|
231
231
|
*/
|
|
232
232
|
referralProgram?: boolean;
|
|
233
233
|
}
|
|
234
|
-
|
|
234
|
+
interface GetReferralProgramRequest {
|
|
235
235
|
}
|
|
236
|
-
|
|
236
|
+
interface GetReferralProgramResponse {
|
|
237
237
|
/** Retrieved referral program. */
|
|
238
238
|
referralProgram?: ReferralProgram;
|
|
239
239
|
}
|
|
240
|
-
|
|
240
|
+
interface BulkGetReferralProgramRequest {
|
|
241
241
|
}
|
|
242
|
-
|
|
242
|
+
interface BulkGetReferralProgramResponse {
|
|
243
243
|
/** Retrieved referral programs. */
|
|
244
244
|
programInSites?: ProgramInSite[];
|
|
245
245
|
}
|
|
246
|
-
|
|
246
|
+
interface ProgramInSite {
|
|
247
247
|
/**
|
|
248
248
|
* Metasite ID.
|
|
249
249
|
* @format GUID
|
|
@@ -252,34 +252,34 @@ export interface ProgramInSite {
|
|
|
252
252
|
/** Retrieved referral program. */
|
|
253
253
|
referralProgram?: ReferralProgram;
|
|
254
254
|
}
|
|
255
|
-
|
|
255
|
+
interface UpdateReferralProgramRequest {
|
|
256
256
|
/** Referral program to update. Include the latest `revision` for a successful update. */
|
|
257
257
|
referralProgram: ReferralProgram;
|
|
258
258
|
}
|
|
259
|
-
|
|
259
|
+
interface UpdateReferralProgramResponse {
|
|
260
260
|
/** Updated referral program. */
|
|
261
261
|
referralProgram?: ReferralProgram;
|
|
262
262
|
}
|
|
263
|
-
|
|
263
|
+
interface ActivateReferralProgramRequest {
|
|
264
264
|
}
|
|
265
|
-
|
|
265
|
+
interface ActivateReferralProgramResponse {
|
|
266
266
|
/** Activated referral program. */
|
|
267
267
|
referralProgram?: ReferralProgram;
|
|
268
268
|
}
|
|
269
|
-
|
|
269
|
+
interface PauseReferralProgramRequest {
|
|
270
270
|
}
|
|
271
|
-
|
|
271
|
+
interface PauseReferralProgramResponse {
|
|
272
272
|
/** Paused referral program. */
|
|
273
273
|
referralProgram?: ReferralProgram;
|
|
274
274
|
}
|
|
275
|
-
|
|
275
|
+
interface GetAISocialMediaPostsSuggestionsRequest {
|
|
276
276
|
/**
|
|
277
277
|
* Topic to generate social media post suggestions for. For example, fitness, education, or technology.
|
|
278
278
|
* @maxLength 512
|
|
279
279
|
*/
|
|
280
280
|
topic?: string;
|
|
281
281
|
}
|
|
282
|
-
|
|
282
|
+
interface GetAISocialMediaPostsSuggestionsResponse {
|
|
283
283
|
/**
|
|
284
284
|
* Generated social media post suggestions.
|
|
285
285
|
* @maxSize 3
|
|
@@ -291,7 +291,7 @@ export interface GetAISocialMediaPostsSuggestionsResponse {
|
|
|
291
291
|
*/
|
|
292
292
|
referFriendsPageUrl?: string | null;
|
|
293
293
|
}
|
|
294
|
-
|
|
294
|
+
interface AISocialMediaPostSuggestion {
|
|
295
295
|
/**
|
|
296
296
|
* Suggested post content.
|
|
297
297
|
* @maxLength 4096
|
|
@@ -304,14 +304,14 @@ export interface AISocialMediaPostSuggestion {
|
|
|
304
304
|
*/
|
|
305
305
|
hashtags?: string[];
|
|
306
306
|
}
|
|
307
|
-
|
|
307
|
+
interface GenerateAISocialMediaPostsSuggestionsRequest {
|
|
308
308
|
/**
|
|
309
309
|
* Topic to generate social media post suggestions for. For example, fitness, education, or technology.
|
|
310
310
|
* @maxLength 512
|
|
311
311
|
*/
|
|
312
312
|
topic?: string;
|
|
313
313
|
}
|
|
314
|
-
|
|
314
|
+
interface GenerateAISocialMediaPostsSuggestionsResponse {
|
|
315
315
|
/**
|
|
316
316
|
* Generated social media post suggestions.
|
|
317
317
|
* @maxSize 3
|
|
@@ -323,22 +323,22 @@ export interface GenerateAISocialMediaPostsSuggestionsResponse {
|
|
|
323
323
|
*/
|
|
324
324
|
referFriendsPageUrl?: string | null;
|
|
325
325
|
}
|
|
326
|
-
|
|
326
|
+
interface GetReferralProgramPremiumFeaturesRequest {
|
|
327
327
|
}
|
|
328
|
-
|
|
328
|
+
interface GetReferralProgramPremiumFeaturesResponse {
|
|
329
329
|
/**
|
|
330
330
|
* Whether the site has the referral program feature enabled.
|
|
331
331
|
* @readonly
|
|
332
332
|
*/
|
|
333
333
|
referralProgram?: boolean;
|
|
334
334
|
}
|
|
335
|
-
|
|
335
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
336
336
|
createdEvent?: EntityCreatedEvent;
|
|
337
337
|
updatedEvent?: EntityUpdatedEvent;
|
|
338
338
|
deletedEvent?: EntityDeletedEvent;
|
|
339
339
|
actionEvent?: ActionEvent;
|
|
340
340
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
341
|
-
|
|
341
|
+
_id?: string;
|
|
342
342
|
/**
|
|
343
343
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
344
344
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -367,38 +367,36 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
367
367
|
entityEventSequence?: string | null;
|
|
368
368
|
}
|
|
369
369
|
/** @oneof */
|
|
370
|
-
|
|
370
|
+
interface DomainEventBodyOneOf {
|
|
371
371
|
createdEvent?: EntityCreatedEvent;
|
|
372
372
|
updatedEvent?: EntityUpdatedEvent;
|
|
373
373
|
deletedEvent?: EntityDeletedEvent;
|
|
374
374
|
actionEvent?: ActionEvent;
|
|
375
375
|
}
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
379
|
-
restoreInfo?: RestoreInfo;
|
|
376
|
+
interface EntityCreatedEvent {
|
|
377
|
+
entity?: string;
|
|
380
378
|
}
|
|
381
|
-
|
|
379
|
+
interface RestoreInfo {
|
|
382
380
|
deletedDate?: Date | null;
|
|
383
381
|
}
|
|
384
|
-
|
|
382
|
+
interface EntityUpdatedEvent {
|
|
385
383
|
/**
|
|
386
384
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
387
385
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
388
386
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
389
387
|
*/
|
|
390
|
-
|
|
388
|
+
currentEntity?: string;
|
|
391
389
|
}
|
|
392
|
-
|
|
390
|
+
interface EntityDeletedEvent {
|
|
393
391
|
/** Entity that was deleted. */
|
|
394
|
-
|
|
392
|
+
deletedEntity?: string | null;
|
|
395
393
|
}
|
|
396
|
-
|
|
397
|
-
|
|
394
|
+
interface ActionEvent {
|
|
395
|
+
body?: string;
|
|
398
396
|
}
|
|
399
|
-
|
|
397
|
+
interface Empty {
|
|
400
398
|
}
|
|
401
|
-
|
|
399
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
402
400
|
/** Emitted on a meta site creation. */
|
|
403
401
|
siteCreated?: SiteCreated;
|
|
404
402
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -464,7 +462,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
464
462
|
assets?: Asset[];
|
|
465
463
|
}
|
|
466
464
|
/** @oneof */
|
|
467
|
-
|
|
465
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
468
466
|
/** Emitted on a meta site creation. */
|
|
469
467
|
siteCreated?: SiteCreated;
|
|
470
468
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -514,7 +512,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
514
512
|
/** Emitted when Picasso is detached. */
|
|
515
513
|
picassoUnassigned?: PicassoUnassigned;
|
|
516
514
|
}
|
|
517
|
-
|
|
515
|
+
interface Asset {
|
|
518
516
|
/**
|
|
519
517
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
520
518
|
* @maxLength 36
|
|
@@ -528,7 +526,7 @@ export interface Asset {
|
|
|
528
526
|
/** An application state. */
|
|
529
527
|
state?: StateWithLiterals;
|
|
530
528
|
}
|
|
531
|
-
|
|
529
|
+
declare enum State {
|
|
532
530
|
UNKNOWN = "UNKNOWN",
|
|
533
531
|
ENABLED = "ENABLED",
|
|
534
532
|
DISABLED = "DISABLED",
|
|
@@ -536,8 +534,8 @@ export declare enum State {
|
|
|
536
534
|
DEMO = "DEMO"
|
|
537
535
|
}
|
|
538
536
|
/** @enumType */
|
|
539
|
-
|
|
540
|
-
|
|
537
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
538
|
+
interface SiteCreated {
|
|
541
539
|
/**
|
|
542
540
|
* A template identifier (empty if not created from a template).
|
|
543
541
|
* @maxLength 36
|
|
@@ -566,7 +564,7 @@ export interface SiteCreated {
|
|
|
566
564
|
/** A namespace. */
|
|
567
565
|
namespace?: NamespaceWithLiterals;
|
|
568
566
|
}
|
|
569
|
-
|
|
567
|
+
declare enum SiteCreatedContext {
|
|
570
568
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
571
569
|
OTHER = "OTHER",
|
|
572
570
|
/** A meta site was created from template. */
|
|
@@ -581,8 +579,8 @@ export declare enum SiteCreatedContext {
|
|
|
581
579
|
FLASH = "FLASH"
|
|
582
580
|
}
|
|
583
581
|
/** @enumType */
|
|
584
|
-
|
|
585
|
-
|
|
582
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
583
|
+
declare enum Namespace {
|
|
586
584
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
587
585
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
588
586
|
WIX = "WIX",
|
|
@@ -665,9 +663,9 @@ export declare enum Namespace {
|
|
|
665
663
|
MIMIR = "MIMIR"
|
|
666
664
|
}
|
|
667
665
|
/** @enumType */
|
|
668
|
-
|
|
666
|
+
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';
|
|
669
667
|
/** Site transferred to another user. */
|
|
670
|
-
|
|
668
|
+
interface SiteTransferred {
|
|
671
669
|
/**
|
|
672
670
|
* A previous owner id (user that transfers meta site).
|
|
673
671
|
* @format GUID
|
|
@@ -680,11 +678,11 @@ export interface SiteTransferred {
|
|
|
680
678
|
newOwnerId?: string;
|
|
681
679
|
}
|
|
682
680
|
/** Soft deletion of the meta site. Could be restored. */
|
|
683
|
-
|
|
681
|
+
interface SiteDeleted {
|
|
684
682
|
/** A deletion context. */
|
|
685
683
|
deleteContext?: DeleteContext;
|
|
686
684
|
}
|
|
687
|
-
|
|
685
|
+
interface DeleteContext {
|
|
688
686
|
/** When the meta site was deleted. */
|
|
689
687
|
dateDeleted?: Date | null;
|
|
690
688
|
/** A status. */
|
|
@@ -700,7 +698,7 @@ export interface DeleteContext {
|
|
|
700
698
|
*/
|
|
701
699
|
initiatorId?: string | null;
|
|
702
700
|
}
|
|
703
|
-
|
|
701
|
+
declare enum DeleteStatus {
|
|
704
702
|
UNKNOWN = "UNKNOWN",
|
|
705
703
|
TRASH = "TRASH",
|
|
706
704
|
DELETED = "DELETED",
|
|
@@ -708,14 +706,14 @@ export declare enum DeleteStatus {
|
|
|
708
706
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
709
707
|
}
|
|
710
708
|
/** @enumType */
|
|
711
|
-
|
|
709
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
712
710
|
/** Restoration of the meta site. */
|
|
713
|
-
|
|
711
|
+
interface SiteUndeleted {
|
|
714
712
|
}
|
|
715
713
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
716
|
-
|
|
714
|
+
interface SitePublished {
|
|
717
715
|
}
|
|
718
|
-
|
|
716
|
+
interface SiteUnpublished {
|
|
719
717
|
/**
|
|
720
718
|
* A list of URLs previously associated with the meta site.
|
|
721
719
|
* @maxLength 4000
|
|
@@ -723,9 +721,9 @@ export interface SiteUnpublished {
|
|
|
723
721
|
*/
|
|
724
722
|
urls?: string[];
|
|
725
723
|
}
|
|
726
|
-
|
|
724
|
+
interface SiteMarkedAsTemplate {
|
|
727
725
|
}
|
|
728
|
-
|
|
726
|
+
interface SiteMarkedAsWixSite {
|
|
729
727
|
}
|
|
730
728
|
/**
|
|
731
729
|
* Represents a service provisioned a site.
|
|
@@ -742,7 +740,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
742
740
|
* changes made to the original template afterward.
|
|
743
741
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
744
742
|
*/
|
|
745
|
-
|
|
743
|
+
interface ServiceProvisioned {
|
|
746
744
|
/**
|
|
747
745
|
* Either UUID or EmbeddedServiceType.
|
|
748
746
|
* @maxLength 36
|
|
@@ -769,7 +767,7 @@ export interface ServiceProvisioned {
|
|
|
769
767
|
*/
|
|
770
768
|
originMetaSiteId?: string | null;
|
|
771
769
|
}
|
|
772
|
-
|
|
770
|
+
interface ServiceRemoved {
|
|
773
771
|
/**
|
|
774
772
|
* Either UUID or EmbeddedServiceType.
|
|
775
773
|
* @maxLength 36
|
|
@@ -787,7 +785,7 @@ export interface ServiceRemoved {
|
|
|
787
785
|
version?: string | null;
|
|
788
786
|
}
|
|
789
787
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
790
|
-
|
|
788
|
+
interface SiteRenamed {
|
|
791
789
|
/**
|
|
792
790
|
* A new meta site name (URL slug).
|
|
793
791
|
* @maxLength 20
|
|
@@ -804,21 +802,21 @@ export interface SiteRenamed {
|
|
|
804
802
|
*
|
|
805
803
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
806
804
|
*/
|
|
807
|
-
|
|
805
|
+
interface SiteHardDeleted {
|
|
808
806
|
/** A deletion context. */
|
|
809
807
|
deleteContext?: DeleteContext;
|
|
810
808
|
}
|
|
811
|
-
|
|
809
|
+
interface NamespaceChanged {
|
|
812
810
|
/** A previous namespace. */
|
|
813
811
|
oldNamespace?: NamespaceWithLiterals;
|
|
814
812
|
/** A new namespace. */
|
|
815
813
|
newNamespace?: NamespaceWithLiterals;
|
|
816
814
|
}
|
|
817
815
|
/** Assigned Studio editor */
|
|
818
|
-
|
|
816
|
+
interface StudioAssigned {
|
|
819
817
|
}
|
|
820
818
|
/** Unassigned Studio editor */
|
|
821
|
-
|
|
819
|
+
interface StudioUnassigned {
|
|
822
820
|
}
|
|
823
821
|
/**
|
|
824
822
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -828,13 +826,13 @@ export interface StudioUnassigned {
|
|
|
828
826
|
*
|
|
829
827
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
830
828
|
*/
|
|
831
|
-
|
|
829
|
+
interface SiteUrlChanged {
|
|
832
830
|
}
|
|
833
831
|
/**
|
|
834
832
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
835
833
|
* Consumed by other teams to remove relevant data.
|
|
836
834
|
*/
|
|
837
|
-
|
|
835
|
+
interface SitePurgedExternally {
|
|
838
836
|
/**
|
|
839
837
|
* @maxLength 2048
|
|
840
838
|
* @maxSize 100
|
|
@@ -844,18 +842,18 @@ export interface SitePurgedExternally {
|
|
|
844
842
|
appDefId?: string[];
|
|
845
843
|
}
|
|
846
844
|
/** Assigned Odeditor */
|
|
847
|
-
|
|
845
|
+
interface OdeditorAssigned {
|
|
848
846
|
}
|
|
849
847
|
/** Unassigned Odeditor */
|
|
850
|
-
|
|
848
|
+
interface OdeditorUnassigned {
|
|
851
849
|
}
|
|
852
850
|
/** Assigned Picasso editor */
|
|
853
|
-
|
|
851
|
+
interface PicassoAssigned {
|
|
854
852
|
}
|
|
855
853
|
/** Unassigned Picasso */
|
|
856
|
-
|
|
854
|
+
interface PicassoUnassigned {
|
|
857
855
|
}
|
|
858
|
-
|
|
856
|
+
interface HtmlSitePublished {
|
|
859
857
|
/**
|
|
860
858
|
* Application instance ID
|
|
861
859
|
* @maxLength 50
|
|
@@ -885,14 +883,14 @@ export interface HtmlSitePublished {
|
|
|
885
883
|
/** Site's publish date */
|
|
886
884
|
publishDate?: string;
|
|
887
885
|
}
|
|
888
|
-
|
|
886
|
+
interface Page {
|
|
889
887
|
/**
|
|
890
888
|
* Page's Id
|
|
891
889
|
* @maxLength 100
|
|
892
890
|
*/
|
|
893
|
-
|
|
891
|
+
_id?: string;
|
|
894
892
|
}
|
|
895
|
-
|
|
893
|
+
interface SubscriptionEvent extends SubscriptionEventEventOneOf {
|
|
896
894
|
/** Triggered when a subscription is created. */
|
|
897
895
|
created?: SubscriptionCreated;
|
|
898
896
|
/**
|
|
@@ -950,7 +948,7 @@ export interface SubscriptionEvent extends SubscriptionEventEventOneOf {
|
|
|
950
948
|
eventDate?: Date | null;
|
|
951
949
|
}
|
|
952
950
|
/** @oneof */
|
|
953
|
-
|
|
951
|
+
interface SubscriptionEventEventOneOf {
|
|
954
952
|
/** Triggered when a subscription is created. */
|
|
955
953
|
created?: SubscriptionCreated;
|
|
956
954
|
/**
|
|
@@ -997,7 +995,7 @@ export interface SubscriptionEventEventOneOf {
|
|
|
997
995
|
recurringChargeAttemptFailed?: RecurringChargeAttemptFailed;
|
|
998
996
|
}
|
|
999
997
|
/** Triggered when a subscription is created. */
|
|
1000
|
-
|
|
998
|
+
interface SubscriptionCreated {
|
|
1001
999
|
/** Created subscription. */
|
|
1002
1000
|
subscription?: Subscription;
|
|
1003
1001
|
/** Metadata for the `created` event. */
|
|
@@ -1013,12 +1011,12 @@ export interface SubscriptionCreated {
|
|
|
1013
1011
|
* A subscription holds information about a Premium product that a Wix account
|
|
1014
1012
|
* owner has purchased including details about the billing.
|
|
1015
1013
|
*/
|
|
1016
|
-
|
|
1014
|
+
interface Subscription {
|
|
1017
1015
|
/**
|
|
1018
1016
|
* ID of the subscription.
|
|
1019
1017
|
* @format GUID
|
|
1020
1018
|
*/
|
|
1021
|
-
|
|
1019
|
+
_id?: string;
|
|
1022
1020
|
/**
|
|
1023
1021
|
* ID of the Wix account that purchased the subscription.
|
|
1024
1022
|
* @format GUID
|
|
@@ -1100,7 +1098,7 @@ export interface Subscription {
|
|
|
1100
1098
|
*/
|
|
1101
1099
|
countryCode?: string | null;
|
|
1102
1100
|
}
|
|
1103
|
-
|
|
1101
|
+
interface BillingReference {
|
|
1104
1102
|
/**
|
|
1105
1103
|
* Name of the billing system that manages the subscription.
|
|
1106
1104
|
*
|
|
@@ -1116,7 +1114,7 @@ export interface BillingReference {
|
|
|
1116
1114
|
/** Previous provider reference IDs. Used for when a subscription is extended, specifically for domains. */
|
|
1117
1115
|
previousProviderReferenceIds?: string[];
|
|
1118
1116
|
}
|
|
1119
|
-
|
|
1117
|
+
declare enum ProviderName {
|
|
1120
1118
|
UNKNOWN = "UNKNOWN",
|
|
1121
1119
|
SBS = "SBS",
|
|
1122
1120
|
LICENSER = "LICENSER",
|
|
@@ -1125,27 +1123,27 @@ export declare enum ProviderName {
|
|
|
1125
1123
|
RECURRING_INVOICES = "RECURRING_INVOICES"
|
|
1126
1124
|
}
|
|
1127
1125
|
/** @enumType */
|
|
1128
|
-
|
|
1129
|
-
|
|
1126
|
+
type ProviderNameWithLiterals = ProviderName | 'UNKNOWN' | 'SBS' | 'LICENSER' | 'BASS' | 'RESELLER' | 'RECURRING_INVOICES';
|
|
1127
|
+
interface Cycle extends CycleCycleSelectorOneOf {
|
|
1130
1128
|
/** repetitive interval */
|
|
1131
1129
|
interval?: Interval;
|
|
1132
1130
|
/** one time */
|
|
1133
1131
|
oneTime?: OneTime;
|
|
1134
1132
|
}
|
|
1135
1133
|
/** @oneof */
|
|
1136
|
-
|
|
1134
|
+
interface CycleCycleSelectorOneOf {
|
|
1137
1135
|
/** repetitive interval */
|
|
1138
1136
|
interval?: Interval;
|
|
1139
1137
|
/** one time */
|
|
1140
1138
|
oneTime?: OneTime;
|
|
1141
1139
|
}
|
|
1142
|
-
|
|
1140
|
+
interface Interval {
|
|
1143
1141
|
/** interval unit of measure */
|
|
1144
1142
|
unit?: IntervalUnitWithLiterals;
|
|
1145
1143
|
/** number of interval */
|
|
1146
1144
|
count?: number;
|
|
1147
1145
|
}
|
|
1148
|
-
|
|
1146
|
+
declare enum IntervalUnit {
|
|
1149
1147
|
/** unknown interval unit */
|
|
1150
1148
|
UNKNOWN = "UNKNOWN",
|
|
1151
1149
|
/** day */
|
|
@@ -1158,10 +1156,10 @@ export declare enum IntervalUnit {
|
|
|
1158
1156
|
YEAR = "YEAR"
|
|
1159
1157
|
}
|
|
1160
1158
|
/** @enumType */
|
|
1161
|
-
|
|
1162
|
-
|
|
1159
|
+
type IntervalUnitWithLiterals = IntervalUnit | 'UNKNOWN' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
1160
|
+
interface OneTime {
|
|
1163
1161
|
}
|
|
1164
|
-
|
|
1162
|
+
declare enum SubscriptionStatus {
|
|
1165
1163
|
UNKNOWN = "UNKNOWN",
|
|
1166
1164
|
AUTO_RENEW_ON = "AUTO_RENEW_ON",
|
|
1167
1165
|
AUTO_RENEW_OFF = "AUTO_RENEW_OFF",
|
|
@@ -1170,9 +1168,9 @@ export declare enum SubscriptionStatus {
|
|
|
1170
1168
|
TRANSFERRED = "TRANSFERRED"
|
|
1171
1169
|
}
|
|
1172
1170
|
/** @enumType */
|
|
1173
|
-
|
|
1171
|
+
type SubscriptionStatusWithLiterals = SubscriptionStatus | 'UNKNOWN' | 'AUTO_RENEW_ON' | 'AUTO_RENEW_OFF' | 'MANUAL_RECURRING' | 'CANCELLED' | 'TRANSFERRED';
|
|
1174
1172
|
/** Triggered when a subscription is reactivated. */
|
|
1175
|
-
|
|
1173
|
+
interface ReactivationData {
|
|
1176
1174
|
reactivationReason?: ReactivationReasonEnumWithLiterals;
|
|
1177
1175
|
/**
|
|
1178
1176
|
* In the event of reactivation after chargeback dispute, the subscription may be extended according to the
|
|
@@ -1185,7 +1183,7 @@ export interface ReactivationData {
|
|
|
1185
1183
|
differenceInDays?: number | null;
|
|
1186
1184
|
}
|
|
1187
1185
|
/** Reason for subscription reactivation */
|
|
1188
|
-
|
|
1186
|
+
declare enum ReactivationReasonEnum {
|
|
1189
1187
|
UNKNOWN = "UNKNOWN",
|
|
1190
1188
|
/**
|
|
1191
1189
|
* Subscription was reactivated due to billing status change from CANCELED to ACTIVE, for example if it was incorrectly
|
|
@@ -1196,12 +1194,12 @@ export declare enum ReactivationReasonEnum {
|
|
|
1196
1194
|
REACTIVATED_AFTER_CHARGEBACK = "REACTIVATED_AFTER_CHARGEBACK"
|
|
1197
1195
|
}
|
|
1198
1196
|
/** @enumType */
|
|
1199
|
-
|
|
1197
|
+
type ReactivationReasonEnumWithLiterals = ReactivationReasonEnum | 'UNKNOWN' | 'BILLING_STATUS_CHANGE' | 'REACTIVATED_AFTER_CHARGEBACK';
|
|
1200
1198
|
/**
|
|
1201
1199
|
* Triggered when a subscription is assigned to a Wix site, including the initial
|
|
1202
1200
|
* assignment of a floating subscription or a re-assignement from a different site.
|
|
1203
1201
|
*/
|
|
1204
|
-
|
|
1202
|
+
interface SubscriptionAssigned {
|
|
1205
1203
|
/** Assigned subscription. */
|
|
1206
1204
|
subscription?: Subscription;
|
|
1207
1205
|
/**
|
|
@@ -1211,7 +1209,7 @@ export interface SubscriptionAssigned {
|
|
|
1211
1209
|
previousMetaSiteId?: string | null;
|
|
1212
1210
|
}
|
|
1213
1211
|
/** Triggered when a subscription is canceled. */
|
|
1214
|
-
|
|
1212
|
+
interface SubscriptionCancelled {
|
|
1215
1213
|
/** Canceled subscription. */
|
|
1216
1214
|
subscription?: Subscription;
|
|
1217
1215
|
/** Details about the cancellation including who canceled the subscription and why. */
|
|
@@ -1226,7 +1224,7 @@ export interface SubscriptionCancelled {
|
|
|
1226
1224
|
canceledInFreeTrial?: boolean;
|
|
1227
1225
|
}
|
|
1228
1226
|
/** Information about the cancellation flow including who canceled the subscription and why it was canceled. */
|
|
1229
|
-
|
|
1227
|
+
interface CancellationDetails {
|
|
1230
1228
|
/**
|
|
1231
1229
|
* Cancellation code.
|
|
1232
1230
|
*
|
|
@@ -1267,16 +1265,16 @@ export interface CancellationDetails {
|
|
|
1267
1265
|
*/
|
|
1268
1266
|
initiator?: InitiatorWithLiterals;
|
|
1269
1267
|
}
|
|
1270
|
-
|
|
1268
|
+
declare enum Initiator {
|
|
1271
1269
|
UNKNOWN = "UNKNOWN",
|
|
1272
1270
|
USER_REQUESTED = "USER_REQUESTED",
|
|
1273
1271
|
APP_MANAGED = "APP_MANAGED",
|
|
1274
1272
|
PASSIVE = "PASSIVE"
|
|
1275
1273
|
}
|
|
1276
1274
|
/** @enumType */
|
|
1277
|
-
|
|
1275
|
+
type InitiatorWithLiterals = Initiator | 'UNKNOWN' | 'USER_REQUESTED' | 'APP_MANAGED' | 'PASSIVE';
|
|
1278
1276
|
/** Triggered when the subscription's auto renew is turned on. */
|
|
1279
|
-
|
|
1277
|
+
interface SubscriptionAutoRenewTurnedOn {
|
|
1280
1278
|
/** Subscription for which auto renew is turned on. */
|
|
1281
1279
|
subscription?: Subscription;
|
|
1282
1280
|
/**
|
|
@@ -1289,7 +1287,7 @@ export interface SubscriptionAutoRenewTurnedOn {
|
|
|
1289
1287
|
initiator?: string | null;
|
|
1290
1288
|
}
|
|
1291
1289
|
/** Triggered when the subscription's auto renew is turned off. */
|
|
1292
|
-
|
|
1290
|
+
interface SubscriptionAutoRenewTurnedOff {
|
|
1293
1291
|
/** Subscription for which auto renew is turned off. */
|
|
1294
1292
|
subscription?: Subscription;
|
|
1295
1293
|
/** Details about the cancellation including who canceled the subscription and why. */
|
|
@@ -1305,7 +1303,7 @@ export interface SubscriptionAutoRenewTurnedOff {
|
|
|
1305
1303
|
* Triggered when a subscription is unassigned from a Wix site and becomes
|
|
1306
1304
|
* floating.
|
|
1307
1305
|
*/
|
|
1308
|
-
|
|
1306
|
+
interface SubscriptionUnassigned {
|
|
1309
1307
|
/** Unassigned subscription. */
|
|
1310
1308
|
subscription?: Subscription;
|
|
1311
1309
|
/**
|
|
@@ -1322,27 +1320,27 @@ export interface SubscriptionUnassigned {
|
|
|
1322
1320
|
*/
|
|
1323
1321
|
unassignReason?: UnassignReasonWithLiterals;
|
|
1324
1322
|
}
|
|
1325
|
-
|
|
1323
|
+
declare enum UnassignReason {
|
|
1326
1324
|
UNKNOWN = "UNKNOWN",
|
|
1327
1325
|
USER_REQUESTED = "USER_REQUESTED",
|
|
1328
1326
|
REPLACED_BY_ANOTHER_SUBSCRIPTION = "REPLACED_BY_ANOTHER_SUBSCRIPTION"
|
|
1329
1327
|
}
|
|
1330
1328
|
/** @enumType */
|
|
1331
|
-
|
|
1329
|
+
type UnassignReasonWithLiterals = UnassignReason | 'UNKNOWN' | 'USER_REQUESTED' | 'REPLACED_BY_ANOTHER_SUBSCRIPTION';
|
|
1332
1330
|
/**
|
|
1333
1331
|
* Triggered when a subscription is transferred from one Wix account to another.
|
|
1334
1332
|
* A transfer includes cancelling the original subscription and creating a new
|
|
1335
1333
|
* subscription for the target account. The event returns both the original
|
|
1336
1334
|
* and the new subscription.
|
|
1337
1335
|
*/
|
|
1338
|
-
|
|
1336
|
+
interface SubscriptionTransferred {
|
|
1339
1337
|
/** Original subscription that was canceled for the transfer. */
|
|
1340
1338
|
originSubscription?: Subscription;
|
|
1341
1339
|
/** Newly created subscription for the target account. */
|
|
1342
1340
|
targetSubscription?: Subscription;
|
|
1343
1341
|
}
|
|
1344
1342
|
/** Triggered when a recurring charge succeeds for a subscription. */
|
|
1345
|
-
|
|
1343
|
+
interface RecurringChargeSucceeded {
|
|
1346
1344
|
/** Subscription for which the recurring charge has succeeded. */
|
|
1347
1345
|
subscription?: Subscription;
|
|
1348
1346
|
/** Indication that there was a successful charge at the end of the free trial period */
|
|
@@ -1352,7 +1350,7 @@ export interface RecurringChargeSucceeded {
|
|
|
1352
1350
|
* Triggered when a subscription was updated including when its product has been
|
|
1353
1351
|
* up- or downgraded or the billing cycle is changed.
|
|
1354
1352
|
*/
|
|
1355
|
-
|
|
1353
|
+
interface ContractSwitched {
|
|
1356
1354
|
/** Updated subscription. */
|
|
1357
1355
|
subscription?: Subscription;
|
|
1358
1356
|
/** Billing cycle before the update. */
|
|
@@ -1408,7 +1406,7 @@ export interface ContractSwitched {
|
|
|
1408
1406
|
productAdjustment?: ProductAdjustmentWithLiterals;
|
|
1409
1407
|
}
|
|
1410
1408
|
/** Copied from SBS */
|
|
1411
|
-
|
|
1409
|
+
declare enum ContractSwitchType {
|
|
1412
1410
|
NOT_APPLICABLE = "NOT_APPLICABLE",
|
|
1413
1411
|
ADDITIONAL_QUANTITY = "ADDITIONAL_QUANTITY",
|
|
1414
1412
|
CREDIT_UNUSED_PERIOD = "CREDIT_UNUSED_PERIOD",
|
|
@@ -1421,15 +1419,15 @@ export declare enum ContractSwitchType {
|
|
|
1421
1419
|
DOWNGRADE_RENEWAL = "DOWNGRADE_RENEWAL"
|
|
1422
1420
|
}
|
|
1423
1421
|
/** @enumType */
|
|
1424
|
-
|
|
1425
|
-
|
|
1422
|
+
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';
|
|
1423
|
+
declare enum ContractSwitchReason {
|
|
1426
1424
|
EXTERNAL_PROVIDER_TRIGGER = "EXTERNAL_PROVIDER_TRIGGER",
|
|
1427
1425
|
PRICE_INCREASE = "PRICE_INCREASE"
|
|
1428
1426
|
}
|
|
1429
1427
|
/** @enumType */
|
|
1430
|
-
|
|
1428
|
+
type ContractSwitchReasonWithLiterals = ContractSwitchReason | 'EXTERNAL_PROVIDER_TRIGGER' | 'PRICE_INCREASE';
|
|
1431
1429
|
/** Triggered when a subscription's price is increased. */
|
|
1432
|
-
|
|
1430
|
+
interface ProductPriceIncreaseData {
|
|
1433
1431
|
/**
|
|
1434
1432
|
* Price of the subscription before the update.
|
|
1435
1433
|
* @format DECIMAL_VALUE
|
|
@@ -1443,27 +1441,27 @@ export interface ProductPriceIncreaseData {
|
|
|
1443
1441
|
priceIncreaseTrigger?: PriceIncreaseTriggerWithLiterals;
|
|
1444
1442
|
}
|
|
1445
1443
|
/** Reason for Price Increase Trigger */
|
|
1446
|
-
|
|
1444
|
+
declare enum PriceIncreaseTrigger {
|
|
1447
1445
|
NEAR_RENEWAL = "NEAR_RENEWAL",
|
|
1448
1446
|
RECURRING_SUCCESS = "RECURRING_SUCCESS",
|
|
1449
1447
|
MANUAL = "MANUAL"
|
|
1450
1448
|
}
|
|
1451
1449
|
/** @enumType */
|
|
1452
|
-
|
|
1450
|
+
type PriceIncreaseTriggerWithLiterals = PriceIncreaseTrigger | 'NEAR_RENEWAL' | 'RECURRING_SUCCESS' | 'MANUAL';
|
|
1453
1451
|
/** Triggered when a subscription's product is adusted. */
|
|
1454
|
-
|
|
1452
|
+
declare enum ProductAdjustment {
|
|
1455
1453
|
/** flag to show that the ContractSwitchedEvent is not applicable / needed */
|
|
1456
1454
|
NOT_APPLICABLE = "NOT_APPLICABLE",
|
|
1457
1455
|
/** flag to show that the ContractSwitchedEvent is a Downgrade */
|
|
1458
1456
|
DOWNGRADE = "DOWNGRADE"
|
|
1459
1457
|
}
|
|
1460
1458
|
/** @enumType */
|
|
1461
|
-
|
|
1459
|
+
type ProductAdjustmentWithLiterals = ProductAdjustment | 'NOT_APPLICABLE' | 'DOWNGRADE';
|
|
1462
1460
|
/**
|
|
1463
1461
|
* Triggered when a subscription gets close to the end of its billing cycle.
|
|
1464
1462
|
* The exact number of days is defined in the billing system.
|
|
1465
1463
|
*/
|
|
1466
|
-
|
|
1464
|
+
interface SubscriptionNearEndOfPeriod {
|
|
1467
1465
|
/** Subscription that got close to the end of its billing cycle. */
|
|
1468
1466
|
subscription?: Subscription;
|
|
1469
1467
|
/** Whether the subscription is within the free trial period. */
|
|
@@ -1473,16 +1471,16 @@ export interface SubscriptionNearEndOfPeriod {
|
|
|
1473
1471
|
* Triggered when a subscription is updated and the change doesn't happen
|
|
1474
1472
|
* immediately but at the end of the current billing cycle.
|
|
1475
1473
|
*/
|
|
1476
|
-
|
|
1474
|
+
interface SubscriptionPendingChange {
|
|
1477
1475
|
/** Subscription for which a pending update is triggered. */
|
|
1478
1476
|
subscription?: Subscription;
|
|
1479
1477
|
}
|
|
1480
1478
|
/** Triggered when a recurring charge attempt failed for a subscription. */
|
|
1481
|
-
|
|
1479
|
+
interface RecurringChargeAttemptFailed {
|
|
1482
1480
|
/** Subscription for which the recurring charge attempt has failed. */
|
|
1483
1481
|
subscription?: Subscription;
|
|
1484
1482
|
}
|
|
1485
|
-
|
|
1483
|
+
interface MessageEnvelope {
|
|
1486
1484
|
/**
|
|
1487
1485
|
* App instance ID.
|
|
1488
1486
|
* @format GUID
|
|
@@ -1498,7 +1496,7 @@ export interface MessageEnvelope {
|
|
|
1498
1496
|
/** Stringify payload. */
|
|
1499
1497
|
data?: string;
|
|
1500
1498
|
}
|
|
1501
|
-
|
|
1499
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1502
1500
|
/**
|
|
1503
1501
|
* ID of a site visitor that has not logged in to the site.
|
|
1504
1502
|
* @format GUID
|
|
@@ -1523,7 +1521,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1523
1521
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1524
1522
|
}
|
|
1525
1523
|
/** @oneof */
|
|
1526
|
-
|
|
1524
|
+
interface IdentificationDataIdOneOf {
|
|
1527
1525
|
/**
|
|
1528
1526
|
* ID of a site visitor that has not logged in to the site.
|
|
1529
1527
|
* @format GUID
|
|
@@ -1545,7 +1543,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1545
1543
|
*/
|
|
1546
1544
|
appId?: string;
|
|
1547
1545
|
}
|
|
1548
|
-
|
|
1546
|
+
declare enum WebhookIdentityType {
|
|
1549
1547
|
UNKNOWN = "UNKNOWN",
|
|
1550
1548
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1551
1549
|
MEMBER = "MEMBER",
|
|
@@ -1553,4 +1551,68 @@ export declare enum WebhookIdentityType {
|
|
|
1553
1551
|
APP = "APP"
|
|
1554
1552
|
}
|
|
1555
1553
|
/** @enumType */
|
|
1556
|
-
|
|
1554
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1555
|
+
interface BaseEventMetadata {
|
|
1556
|
+
/**
|
|
1557
|
+
* App instance ID.
|
|
1558
|
+
* @format GUID
|
|
1559
|
+
*/
|
|
1560
|
+
instanceId?: string | null;
|
|
1561
|
+
/**
|
|
1562
|
+
* Event type.
|
|
1563
|
+
* @maxLength 150
|
|
1564
|
+
*/
|
|
1565
|
+
eventType?: string;
|
|
1566
|
+
/** The identification type and identity data. */
|
|
1567
|
+
identity?: IdentificationData;
|
|
1568
|
+
}
|
|
1569
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1570
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1571
|
+
_id?: string;
|
|
1572
|
+
/**
|
|
1573
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1574
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1575
|
+
*/
|
|
1576
|
+
entityFqdn?: string;
|
|
1577
|
+
/**
|
|
1578
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1579
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1580
|
+
*/
|
|
1581
|
+
slug?: string;
|
|
1582
|
+
/** ID of the entity associated with the event. */
|
|
1583
|
+
entityId?: string;
|
|
1584
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1585
|
+
eventTime?: Date | null;
|
|
1586
|
+
/**
|
|
1587
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1588
|
+
* (for example, GDPR).
|
|
1589
|
+
*/
|
|
1590
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1591
|
+
/** If present, indicates the action that triggered the event. */
|
|
1592
|
+
originatedFrom?: string | null;
|
|
1593
|
+
/**
|
|
1594
|
+
* 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.
|
|
1595
|
+
* 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.
|
|
1596
|
+
*/
|
|
1597
|
+
entityEventSequence?: string | null;
|
|
1598
|
+
}
|
|
1599
|
+
interface ProgramUpdatedEnvelope {
|
|
1600
|
+
entity: ReferralProgram;
|
|
1601
|
+
metadata: EventMetadata;
|
|
1602
|
+
}
|
|
1603
|
+
interface GetAiSocialMediaPostsSuggestionsOptions {
|
|
1604
|
+
/**
|
|
1605
|
+
* Topic to generate social media post suggestions for. For example, fitness, education, or technology.
|
|
1606
|
+
* @maxLength 512
|
|
1607
|
+
*/
|
|
1608
|
+
topic?: string;
|
|
1609
|
+
}
|
|
1610
|
+
interface GenerateAiSocialMediaPostsSuggestionsOptions {
|
|
1611
|
+
/**
|
|
1612
|
+
* Topic to generate social media post suggestions for. For example, fitness, education, or technology.
|
|
1613
|
+
* @maxLength 512
|
|
1614
|
+
*/
|
|
1615
|
+
topic?: string;
|
|
1616
|
+
}
|
|
1617
|
+
|
|
1618
|
+
export { type GetReferralProgramPremiumFeaturesRequest as $, type ActivateReferralProgramResponse as A, type BulkGetReferralProgramResponse as B, ContractSwitchType as C, DiscountType as D, type Group as E, type FixedAmountDiscount as F, type GetReferralProgramResponse as G, type Emails as H, IntervalUnit as I, type PremiumFeatures as J, type GetReferralProgramRequest as K, type LoyaltyPoints as L, type BulkGetReferralProgramRequest as M, Namespace as N, type ProgramInSite as O, type PauseReferralProgramResponse as P, type UpdateReferralProgramRequest as Q, type ReferralProgram as R, State as S, Type as T, type UpdateReferralProgramResponse as U, type ActivateReferralProgramRequest as V, WebhookIdentityType as W, type PauseReferralProgramRequest as X, type GetAISocialMediaPostsSuggestionsRequest as Y, type AISocialMediaPostSuggestion as Z, type GenerateAISocialMediaPostsSuggestionsRequest as _, type GetAiSocialMediaPostsSuggestionsOptions as a, type DomainEvent as a0, type DomainEventBodyOneOf as a1, type EntityCreatedEvent as a2, type RestoreInfo as a3, type EntityUpdatedEvent as a4, type EntityDeletedEvent as a5, type ActionEvent as a6, type Empty as a7, type MetaSiteSpecialEvent as a8, type MetaSiteSpecialEventPayloadOneOf as a9, type SubscriptionEventEventOneOf as aA, type SubscriptionCreated as aB, type Subscription as aC, type BillingReference as aD, type Cycle as aE, type CycleCycleSelectorOneOf as aF, type Interval as aG, type OneTime as aH, type ReactivationData as aI, type SubscriptionAssigned as aJ, type SubscriptionCancelled as aK, type CancellationDetails as aL, type SubscriptionAutoRenewTurnedOn as aM, type SubscriptionAutoRenewTurnedOff as aN, type SubscriptionUnassigned as aO, type SubscriptionTransferred as aP, type RecurringChargeSucceeded as aQ, type ContractSwitched as aR, type ProductPriceIncreaseData as aS, type SubscriptionNearEndOfPeriod as aT, type SubscriptionPendingChange as aU, type RecurringChargeAttemptFailed as aV, type MessageEnvelope as aW, type IdentificationData as aX, type IdentificationDataIdOneOf as aY, type BaseEventMetadata as aZ, type EventMetadata as a_, type Asset as aa, type SiteCreated as ab, type SiteTransferred as ac, type SiteDeleted as ad, type DeleteContext as ae, type SiteUndeleted as af, type SitePublished as ag, type SiteUnpublished as ah, type SiteMarkedAsTemplate as ai, type SiteMarkedAsWixSite as aj, type ServiceProvisioned as ak, type ServiceRemoved as al, type SiteRenamed as am, type SiteHardDeleted as an, type NamespaceChanged as ao, type StudioAssigned as ap, type StudioUnassigned as aq, type SiteUrlChanged as ar, type SitePurgedExternally as as, type OdeditorAssigned as at, type OdeditorUnassigned as au, type PicassoAssigned as av, type PicassoUnassigned as aw, type HtmlSitePublished as ax, type Page as ay, type SubscriptionEvent as az, type GetAISocialMediaPostsSuggestionsResponse as b, type GenerateAiSocialMediaPostsSuggestionsOptions as c, type GenerateAISocialMediaPostsSuggestionsResponse as d, type GetReferralProgramPremiumFeaturesResponse as e, type ProgramUpdatedEnvelope as f, ProgramStatus as g, Action as h, App as i, SiteCreatedContext as j, DeleteStatus as k, ProviderName as l, SubscriptionStatus as m, ReactivationReasonEnum as n, Initiator as o, UnassignReason as p, ContractSwitchReason as q, PriceIncreaseTrigger as r, ProductAdjustment as s, type Reward as t, type RewardOptionsOneOf as u, type Coupon as v, type CouponDiscountTypeOptionsOneOf as w, type CouponScopeOrMinSubtotalOneOf as x, type PercentageDiscount as y, type CouponScope as z };
|