@wix/auto_sdk_loyalty_programs 1.0.20 → 1.0.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +101 -1
- package/build/cjs/index.js +871 -15
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/{src/loyalty-v1-program-programs.types.d.ts → loyalty-v1-program-programs.universal-CEkDSoxz.d.ts} +180 -155
- package/build/cjs/meta.d.ts +230 -1
- package/build/cjs/meta.js +554 -15
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +101 -0
- package/build/es/index.mjs +833 -0
- package/build/es/index.mjs.map +1 -0
- package/build/{internal/cjs/src/loyalty-v1-program-programs.types.d.ts → es/loyalty-v1-program-programs.universal-CEkDSoxz.d.mts} +180 -155
- package/build/es/meta.d.mts +230 -0
- package/build/es/meta.mjs +523 -0
- package/build/es/meta.mjs.map +1 -0
- package/build/internal/cjs/index.d.ts +101 -1
- package/build/internal/cjs/index.js +871 -15
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/{es/src/loyalty-v1-program-programs.types.d.ts → cjs/loyalty-v1-program-programs.universal-CEkDSoxz.d.ts} +180 -155
- package/build/internal/cjs/meta.d.ts +230 -1
- package/build/internal/cjs/meta.js +554 -15
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +101 -0
- package/build/internal/es/index.mjs +833 -0
- package/build/internal/es/index.mjs.map +1 -0
- package/build/{es/src/loyalty-v1-program-programs.types.d.ts → internal/es/loyalty-v1-program-programs.universal-CEkDSoxz.d.mts} +180 -155
- package/build/internal/es/meta.d.mts +230 -0
- package/build/internal/es/meta.mjs +523 -0
- package/build/internal/es/meta.mjs.map +1 -0
- package/package.json +10 -9
- 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/src/loyalty-v1-program-programs.context.d.ts +0 -18
- package/build/cjs/src/loyalty-v1-program-programs.context.js +0 -30
- package/build/cjs/src/loyalty-v1-program-programs.context.js.map +0 -1
- package/build/cjs/src/loyalty-v1-program-programs.http.d.ts +0 -49
- package/build/cjs/src/loyalty-v1-program-programs.http.js +0 -417
- package/build/cjs/src/loyalty-v1-program-programs.http.js.map +0 -1
- package/build/cjs/src/loyalty-v1-program-programs.meta.d.ts +0 -20
- package/build/cjs/src/loyalty-v1-program-programs.meta.js +0 -180
- package/build/cjs/src/loyalty-v1-program-programs.meta.js.map +0 -1
- package/build/cjs/src/loyalty-v1-program-programs.public.d.ts +0 -88
- package/build/cjs/src/loyalty-v1-program-programs.public.js +0 -83
- package/build/cjs/src/loyalty-v1-program-programs.public.js.map +0 -1
- package/build/cjs/src/loyalty-v1-program-programs.types.js +0 -174
- package/build/cjs/src/loyalty-v1-program-programs.types.js.map +0 -1
- package/build/cjs/src/loyalty-v1-program-programs.universal.d.ts +0 -1510
- package/build/cjs/src/loyalty-v1-program-programs.universal.js +0 -537
- package/build/cjs/src/loyalty-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/src/loyalty-v1-program-programs.context.d.ts +0 -18
- package/build/es/src/loyalty-v1-program-programs.context.js +0 -18
- package/build/es/src/loyalty-v1-program-programs.context.js.map +0 -1
- package/build/es/src/loyalty-v1-program-programs.http.d.ts +0 -49
- package/build/es/src/loyalty-v1-program-programs.http.js +0 -406
- package/build/es/src/loyalty-v1-program-programs.http.js.map +0 -1
- package/build/es/src/loyalty-v1-program-programs.meta.d.ts +0 -20
- package/build/es/src/loyalty-v1-program-programs.meta.js +0 -146
- package/build/es/src/loyalty-v1-program-programs.meta.js.map +0 -1
- package/build/es/src/loyalty-v1-program-programs.public.d.ts +0 -88
- package/build/es/src/loyalty-v1-program-programs.public.js +0 -63
- package/build/es/src/loyalty-v1-program-programs.public.js.map +0 -1
- package/build/es/src/loyalty-v1-program-programs.types.js +0 -171
- package/build/es/src/loyalty-v1-program-programs.types.js.map +0 -1
- package/build/es/src/loyalty-v1-program-programs.universal.d.ts +0 -1510
- package/build/es/src/loyalty-v1-program-programs.universal.js +0 -503
- package/build/es/src/loyalty-v1-program-programs.universal.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/src/loyalty-v1-program-programs.context.d.ts +0 -18
- package/build/internal/cjs/src/loyalty-v1-program-programs.context.js +0 -30
- package/build/internal/cjs/src/loyalty-v1-program-programs.context.js.map +0 -1
- package/build/internal/cjs/src/loyalty-v1-program-programs.http.d.ts +0 -49
- package/build/internal/cjs/src/loyalty-v1-program-programs.http.js +0 -417
- package/build/internal/cjs/src/loyalty-v1-program-programs.http.js.map +0 -1
- package/build/internal/cjs/src/loyalty-v1-program-programs.meta.d.ts +0 -20
- package/build/internal/cjs/src/loyalty-v1-program-programs.meta.js +0 -180
- package/build/internal/cjs/src/loyalty-v1-program-programs.meta.js.map +0 -1
- package/build/internal/cjs/src/loyalty-v1-program-programs.public.d.ts +0 -88
- package/build/internal/cjs/src/loyalty-v1-program-programs.public.js +0 -83
- package/build/internal/cjs/src/loyalty-v1-program-programs.public.js.map +0 -1
- package/build/internal/cjs/src/loyalty-v1-program-programs.types.js +0 -174
- package/build/internal/cjs/src/loyalty-v1-program-programs.types.js.map +0 -1
- package/build/internal/cjs/src/loyalty-v1-program-programs.universal.d.ts +0 -1510
- package/build/internal/cjs/src/loyalty-v1-program-programs.universal.js +0 -537
- package/build/internal/cjs/src/loyalty-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-v1-program-programs.context.d.ts +0 -18
- package/build/internal/es/src/loyalty-v1-program-programs.context.js +0 -18
- package/build/internal/es/src/loyalty-v1-program-programs.context.js.map +0 -1
- package/build/internal/es/src/loyalty-v1-program-programs.http.d.ts +0 -49
- package/build/internal/es/src/loyalty-v1-program-programs.http.js +0 -406
- package/build/internal/es/src/loyalty-v1-program-programs.http.js.map +0 -1
- package/build/internal/es/src/loyalty-v1-program-programs.meta.d.ts +0 -20
- package/build/internal/es/src/loyalty-v1-program-programs.meta.js +0 -146
- package/build/internal/es/src/loyalty-v1-program-programs.meta.js.map +0 -1
- package/build/internal/es/src/loyalty-v1-program-programs.public.d.ts +0 -88
- package/build/internal/es/src/loyalty-v1-program-programs.public.js +0 -63
- package/build/internal/es/src/loyalty-v1-program-programs.public.js.map +0 -1
- package/build/internal/es/src/loyalty-v1-program-programs.types.js +0 -171
- package/build/internal/es/src/loyalty-v1-program-programs.types.js.map +0 -1
- package/build/internal/es/src/loyalty-v1-program-programs.universal.d.ts +0 -1510
- package/build/internal/es/src/loyalty-v1-program-programs.universal.js +0 -503
- package/build/internal/es/src/loyalty-v1-program-programs.universal.js.map +0 -1
|
@@ -3,14 +3,14 @@
|
|
|
3
3
|
* loyalty program to increase customer retention. Read more about the loyalty program in
|
|
4
4
|
* [this overview](https://support.wix.com/en/article/wix-loyalty-program-an-overview).
|
|
5
5
|
*/
|
|
6
|
-
|
|
6
|
+
interface LoyaltyProgram {
|
|
7
7
|
/**
|
|
8
8
|
* Program name.
|
|
9
9
|
* @minLength 2
|
|
10
10
|
* @maxLength 50
|
|
11
11
|
*/
|
|
12
12
|
name?: string | null;
|
|
13
|
-
/**
|
|
13
|
+
/** Information about the program's collectible entity. */
|
|
14
14
|
pointDefinition?: PointDefinition;
|
|
15
15
|
/**
|
|
16
16
|
* Program status. Customers can only earn or redeem points while the program is `ACTIVE`.
|
|
@@ -23,12 +23,12 @@ export interface LoyaltyProgram {
|
|
|
23
23
|
* Date and time the program was created.
|
|
24
24
|
* @readonly
|
|
25
25
|
*/
|
|
26
|
-
|
|
26
|
+
_createdDate?: Date | null;
|
|
27
27
|
/**
|
|
28
28
|
* Date and time the program was updated.
|
|
29
29
|
* @readonly
|
|
30
30
|
*/
|
|
31
|
-
|
|
31
|
+
_updatedDate?: Date | null;
|
|
32
32
|
/** Configuration for the points expiration feature. */
|
|
33
33
|
pointsExpiration?: PointsExpiration;
|
|
34
34
|
/**
|
|
@@ -37,7 +37,7 @@ export interface LoyaltyProgram {
|
|
|
37
37
|
*/
|
|
38
38
|
premiumFeatures?: PremiumFeatures;
|
|
39
39
|
}
|
|
40
|
-
|
|
40
|
+
interface PointDefinition {
|
|
41
41
|
/**
|
|
42
42
|
* Display name for the program's collectible unit.
|
|
43
43
|
*
|
|
@@ -49,33 +49,10 @@ export interface PointDefinition {
|
|
|
49
49
|
* @maxLength 20
|
|
50
50
|
*/
|
|
51
51
|
customName?: string | null;
|
|
52
|
-
/**
|
|
53
|
-
icon?:
|
|
52
|
+
/** Image URL. See [Image]($w/image/introduction) for more information on URL formats for images. */
|
|
53
|
+
icon?: string;
|
|
54
54
|
}
|
|
55
|
-
|
|
56
|
-
/** WixMedia image ID. */
|
|
57
|
-
id?: string;
|
|
58
|
-
/** Image URL. */
|
|
59
|
-
url?: string;
|
|
60
|
-
/**
|
|
61
|
-
* Original image height.
|
|
62
|
-
* @readonly
|
|
63
|
-
*/
|
|
64
|
-
height?: number;
|
|
65
|
-
/**
|
|
66
|
-
* Original image width.
|
|
67
|
-
* @readonly
|
|
68
|
-
*/
|
|
69
|
-
width?: number;
|
|
70
|
-
/** Image alt text. */
|
|
71
|
-
altText?: string | null;
|
|
72
|
-
/**
|
|
73
|
-
* Image filename.
|
|
74
|
-
* @readonly
|
|
75
|
-
*/
|
|
76
|
-
filename?: string | null;
|
|
77
|
-
}
|
|
78
|
-
export interface FocalPoint {
|
|
55
|
+
interface FocalPoint {
|
|
79
56
|
/** X-coordinate of the focal point. */
|
|
80
57
|
x?: number;
|
|
81
58
|
/** Y-coordinate of the focal point. */
|
|
@@ -85,7 +62,7 @@ export interface FocalPoint {
|
|
|
85
62
|
/** crop by width */
|
|
86
63
|
width?: number | null;
|
|
87
64
|
}
|
|
88
|
-
|
|
65
|
+
declare enum ProgramStatus {
|
|
89
66
|
/** Unknown program status. */
|
|
90
67
|
UNKNOWN = "UNKNOWN",
|
|
91
68
|
/** Program was created but is not enabled yet. */
|
|
@@ -96,8 +73,8 @@ export declare enum ProgramStatus {
|
|
|
96
73
|
PAUSED = "PAUSED"
|
|
97
74
|
}
|
|
98
75
|
/** @enumType */
|
|
99
|
-
|
|
100
|
-
|
|
76
|
+
type ProgramStatusWithLiterals = ProgramStatus | 'UNKNOWN' | 'DRAFT' | 'ACTIVE' | 'PAUSED';
|
|
77
|
+
interface PointsExpiration {
|
|
101
78
|
/**
|
|
102
79
|
* Status of the points expiration feature.
|
|
103
80
|
* @readonly
|
|
@@ -116,7 +93,7 @@ export interface PointsExpiration {
|
|
|
116
93
|
*/
|
|
117
94
|
expiringPointsPercentage?: number;
|
|
118
95
|
}
|
|
119
|
-
|
|
96
|
+
declare enum Status {
|
|
120
97
|
/** Unknown points expiration status. This value is not used. */
|
|
121
98
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
122
99
|
/** Points expiration feature is disabled. */
|
|
@@ -125,8 +102,8 @@ export declare enum Status {
|
|
|
125
102
|
ENABLED = "ENABLED"
|
|
126
103
|
}
|
|
127
104
|
/** @enumType */
|
|
128
|
-
|
|
129
|
-
|
|
105
|
+
type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'DISABLED' | 'ENABLED';
|
|
106
|
+
interface PremiumFeatures {
|
|
130
107
|
/**
|
|
131
108
|
* Whether there are any loyalty program premium features.
|
|
132
109
|
* @readonly
|
|
@@ -143,14 +120,14 @@ export interface PremiumFeatures {
|
|
|
143
120
|
*/
|
|
144
121
|
pointsExpiration?: boolean;
|
|
145
122
|
}
|
|
146
|
-
|
|
123
|
+
interface SocialMediaSettings {
|
|
147
124
|
/**
|
|
148
125
|
* List of social media channels
|
|
149
126
|
* @maxSize 5
|
|
150
127
|
*/
|
|
151
128
|
channels?: SocialMediaChannel[];
|
|
152
129
|
}
|
|
153
|
-
|
|
130
|
+
interface SocialMediaChannel {
|
|
154
131
|
/** Social media channel type */
|
|
155
132
|
type?: TypeWithLiterals;
|
|
156
133
|
/** Enable or disable social media channel */
|
|
@@ -160,7 +137,7 @@ export interface SocialMediaChannel {
|
|
|
160
137
|
* @minLength 1
|
|
161
138
|
* @maxLength 255
|
|
162
139
|
*/
|
|
163
|
-
|
|
140
|
+
_id?: string;
|
|
164
141
|
/**
|
|
165
142
|
* Social media channel URL
|
|
166
143
|
* @readonly
|
|
@@ -168,7 +145,7 @@ export interface SocialMediaChannel {
|
|
|
168
145
|
*/
|
|
169
146
|
url?: string | null;
|
|
170
147
|
}
|
|
171
|
-
|
|
148
|
+
declare enum Type {
|
|
172
149
|
/** Unknown social media channel type. */
|
|
173
150
|
UNKNOWN_CHANNEL = "UNKNOWN_CHANNEL",
|
|
174
151
|
/** Facebook social media channel. */
|
|
@@ -183,20 +160,20 @@ export declare enum Type {
|
|
|
183
160
|
TIKTOK = "TIKTOK"
|
|
184
161
|
}
|
|
185
162
|
/** @enumType */
|
|
186
|
-
|
|
187
|
-
|
|
163
|
+
type TypeWithLiterals = Type | 'UNKNOWN_CHANNEL' | 'FACEBOOK' | 'INSTAGRAM' | 'LINKEDIN' | 'X' | 'TIKTOK';
|
|
164
|
+
interface GetLoyaltyProgramRequest {
|
|
188
165
|
}
|
|
189
|
-
|
|
166
|
+
interface GetLoyaltyProgramResponse {
|
|
190
167
|
/** Retrieved loyalty program. */
|
|
191
168
|
loyaltyProgram?: LoyaltyProgram;
|
|
192
169
|
}
|
|
193
|
-
|
|
170
|
+
interface BulkGetLoyaltyProgramRequest {
|
|
194
171
|
}
|
|
195
|
-
|
|
172
|
+
interface BulkGetLoyaltyProgramResponse {
|
|
196
173
|
/** Retrieved loyalty programs. */
|
|
197
174
|
programInSites?: ProgramInSite[];
|
|
198
175
|
}
|
|
199
|
-
|
|
176
|
+
interface ProgramInSite {
|
|
200
177
|
/**
|
|
201
178
|
* Metasite ID.
|
|
202
179
|
* @format GUID
|
|
@@ -205,54 +182,54 @@ export interface ProgramInSite {
|
|
|
205
182
|
/** Loyalty program. */
|
|
206
183
|
loyaltyProgram?: LoyaltyProgram;
|
|
207
184
|
}
|
|
208
|
-
|
|
185
|
+
interface UpdateLoyaltyProgramRequest {
|
|
209
186
|
/** Loyalty program fields to update. */
|
|
210
187
|
loyaltyProgram: LoyaltyProgram;
|
|
211
188
|
}
|
|
212
|
-
|
|
189
|
+
interface UpdateLoyaltyProgramResponse {
|
|
213
190
|
/** Updated loyalty program. */
|
|
214
191
|
loyaltyProgram?: LoyaltyProgram;
|
|
215
192
|
}
|
|
216
|
-
|
|
193
|
+
interface PointsExpirationConfigurationChanged {
|
|
217
194
|
/** Loyalty program. */
|
|
218
195
|
loyaltyProgram?: LoyaltyProgram;
|
|
219
196
|
/** Points expiration configuration changes */
|
|
220
197
|
pointsExpirationChanges?: PointsExpirationChanges;
|
|
221
198
|
}
|
|
222
|
-
|
|
199
|
+
interface PointsExpirationChanges {
|
|
223
200
|
monthsOfInactivity?: number | null;
|
|
224
201
|
expiringPointsPercentage?: number | null;
|
|
225
202
|
}
|
|
226
|
-
|
|
203
|
+
interface ActivateLoyaltyProgramRequest {
|
|
227
204
|
}
|
|
228
|
-
|
|
205
|
+
interface ActivateLoyaltyProgramResponse {
|
|
229
206
|
/** Activated loyalty program. */
|
|
230
207
|
loyaltyProgram?: LoyaltyProgram;
|
|
231
208
|
}
|
|
232
|
-
|
|
209
|
+
interface LoyaltyProgramActivated {
|
|
233
210
|
/** Activated loyalty program. */
|
|
234
211
|
loyaltyProgram?: LoyaltyProgram;
|
|
235
212
|
}
|
|
236
|
-
|
|
213
|
+
interface PauseLoyaltyProgramRequest {
|
|
237
214
|
}
|
|
238
|
-
|
|
215
|
+
interface PauseLoyaltyProgramResponse {
|
|
239
216
|
/** Paused loyalty program. */
|
|
240
217
|
loyaltyProgram?: LoyaltyProgram;
|
|
241
218
|
}
|
|
242
|
-
|
|
219
|
+
interface GetLoyaltyProgramDescriptionRequest {
|
|
243
220
|
/**
|
|
244
221
|
* List of description fields to retrieve. Supported values: `description`, `updatedDate`.
|
|
245
222
|
* @maxSize 2
|
|
246
223
|
*/
|
|
247
224
|
fields?: string[];
|
|
248
225
|
}
|
|
249
|
-
|
|
226
|
+
interface GetLoyaltyProgramDescriptionResponse {
|
|
250
227
|
/** Retrieved loyalty program description. */
|
|
251
228
|
description?: string | null;
|
|
252
229
|
/** Date and time of the latest description update. */
|
|
253
|
-
|
|
230
|
+
_updatedDate?: Date | null;
|
|
254
231
|
}
|
|
255
|
-
|
|
232
|
+
interface UpdateLoyaltyProgramDescriptionRequest {
|
|
256
233
|
/**
|
|
257
234
|
* Loyalty program description to update.
|
|
258
235
|
* @minLength 1
|
|
@@ -260,13 +237,13 @@ export interface UpdateLoyaltyProgramDescriptionRequest {
|
|
|
260
237
|
*/
|
|
261
238
|
description?: string;
|
|
262
239
|
}
|
|
263
|
-
|
|
240
|
+
interface UpdateLoyaltyProgramDescriptionResponse {
|
|
264
241
|
}
|
|
265
|
-
|
|
242
|
+
interface LoyaltyProgramDescriptionUpdated {
|
|
266
243
|
}
|
|
267
|
-
|
|
244
|
+
interface GetLoyaltyProgramPremiumFeaturesRequest {
|
|
268
245
|
}
|
|
269
|
-
|
|
246
|
+
interface GetLoyaltyProgramPremiumFeaturesResponse {
|
|
270
247
|
/**
|
|
271
248
|
* Whether there are any loyalty program premium features.
|
|
272
249
|
* @readonly
|
|
@@ -283,27 +260,27 @@ export interface GetLoyaltyProgramPremiumFeaturesResponse {
|
|
|
283
260
|
*/
|
|
284
261
|
pointsExpiration?: boolean;
|
|
285
262
|
}
|
|
286
|
-
|
|
263
|
+
interface EnablePointsExpirationRequest {
|
|
287
264
|
}
|
|
288
|
-
|
|
265
|
+
interface EnablePointsExpirationResponse {
|
|
289
266
|
/** Loyalty program with enabled points expiration feature. */
|
|
290
267
|
loyaltyProgram?: LoyaltyProgram;
|
|
291
268
|
}
|
|
292
|
-
|
|
269
|
+
interface PointsExpirationEnabled {
|
|
293
270
|
/** Loyalty program. */
|
|
294
271
|
loyaltyProgram?: LoyaltyProgram;
|
|
295
272
|
}
|
|
296
|
-
|
|
273
|
+
interface DisablePointsExpirationRequest {
|
|
297
274
|
}
|
|
298
|
-
|
|
275
|
+
interface DisablePointsExpirationResponse {
|
|
299
276
|
/** Loyalty program with disabled points expiration feature. */
|
|
300
277
|
loyaltyProgram?: LoyaltyProgram;
|
|
301
278
|
}
|
|
302
|
-
|
|
279
|
+
interface PointsExpirationDisabled {
|
|
303
280
|
/** Loyalty program. */
|
|
304
281
|
loyaltyProgram?: LoyaltyProgram;
|
|
305
282
|
}
|
|
306
|
-
|
|
283
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
307
284
|
/** Emitted on a meta site creation. */
|
|
308
285
|
siteCreated?: SiteCreated;
|
|
309
286
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -369,7 +346,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
369
346
|
assets?: Asset[];
|
|
370
347
|
}
|
|
371
348
|
/** @oneof */
|
|
372
|
-
|
|
349
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
373
350
|
/** Emitted on a meta site creation. */
|
|
374
351
|
siteCreated?: SiteCreated;
|
|
375
352
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -419,7 +396,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
419
396
|
/** Emitted when Picasso is detached. */
|
|
420
397
|
picassoUnassigned?: PicassoUnassigned;
|
|
421
398
|
}
|
|
422
|
-
|
|
399
|
+
interface Asset {
|
|
423
400
|
/**
|
|
424
401
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
425
402
|
* @maxLength 36
|
|
@@ -433,7 +410,7 @@ export interface Asset {
|
|
|
433
410
|
/** An application state. */
|
|
434
411
|
state?: StateWithLiterals;
|
|
435
412
|
}
|
|
436
|
-
|
|
413
|
+
declare enum State {
|
|
437
414
|
UNKNOWN = "UNKNOWN",
|
|
438
415
|
ENABLED = "ENABLED",
|
|
439
416
|
DISABLED = "DISABLED",
|
|
@@ -441,8 +418,8 @@ export declare enum State {
|
|
|
441
418
|
DEMO = "DEMO"
|
|
442
419
|
}
|
|
443
420
|
/** @enumType */
|
|
444
|
-
|
|
445
|
-
|
|
421
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
422
|
+
interface SiteCreated {
|
|
446
423
|
/**
|
|
447
424
|
* A template identifier (empty if not created from a template).
|
|
448
425
|
* @maxLength 36
|
|
@@ -471,7 +448,7 @@ export interface SiteCreated {
|
|
|
471
448
|
/** A namespace. */
|
|
472
449
|
namespace?: NamespaceWithLiterals;
|
|
473
450
|
}
|
|
474
|
-
|
|
451
|
+
declare enum SiteCreatedContext {
|
|
475
452
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
476
453
|
OTHER = "OTHER",
|
|
477
454
|
/** A meta site was created from template. */
|
|
@@ -486,8 +463,8 @@ export declare enum SiteCreatedContext {
|
|
|
486
463
|
FLASH = "FLASH"
|
|
487
464
|
}
|
|
488
465
|
/** @enumType */
|
|
489
|
-
|
|
490
|
-
|
|
466
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
467
|
+
declare enum Namespace {
|
|
491
468
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
492
469
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
493
470
|
WIX = "WIX",
|
|
@@ -570,9 +547,9 @@ export declare enum Namespace {
|
|
|
570
547
|
MIMIR = "MIMIR"
|
|
571
548
|
}
|
|
572
549
|
/** @enumType */
|
|
573
|
-
|
|
550
|
+
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';
|
|
574
551
|
/** Site transferred to another user. */
|
|
575
|
-
|
|
552
|
+
interface SiteTransferred {
|
|
576
553
|
/**
|
|
577
554
|
* A previous owner id (user that transfers meta site).
|
|
578
555
|
* @format GUID
|
|
@@ -585,11 +562,11 @@ export interface SiteTransferred {
|
|
|
585
562
|
newOwnerId?: string;
|
|
586
563
|
}
|
|
587
564
|
/** Soft deletion of the meta site. Could be restored. */
|
|
588
|
-
|
|
565
|
+
interface SiteDeleted {
|
|
589
566
|
/** A deletion context. */
|
|
590
567
|
deleteContext?: DeleteContext;
|
|
591
568
|
}
|
|
592
|
-
|
|
569
|
+
interface DeleteContext {
|
|
593
570
|
/** When the meta site was deleted. */
|
|
594
571
|
dateDeleted?: Date | null;
|
|
595
572
|
/** A status. */
|
|
@@ -605,7 +582,7 @@ export interface DeleteContext {
|
|
|
605
582
|
*/
|
|
606
583
|
initiatorId?: string | null;
|
|
607
584
|
}
|
|
608
|
-
|
|
585
|
+
declare enum DeleteStatus {
|
|
609
586
|
UNKNOWN = "UNKNOWN",
|
|
610
587
|
TRASH = "TRASH",
|
|
611
588
|
DELETED = "DELETED",
|
|
@@ -613,14 +590,14 @@ export declare enum DeleteStatus {
|
|
|
613
590
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
614
591
|
}
|
|
615
592
|
/** @enumType */
|
|
616
|
-
|
|
593
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
617
594
|
/** Restoration of the meta site. */
|
|
618
|
-
|
|
595
|
+
interface SiteUndeleted {
|
|
619
596
|
}
|
|
620
597
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
621
|
-
|
|
598
|
+
interface SitePublished {
|
|
622
599
|
}
|
|
623
|
-
|
|
600
|
+
interface SiteUnpublished {
|
|
624
601
|
/**
|
|
625
602
|
* A list of URLs previously associated with the meta site.
|
|
626
603
|
* @maxLength 4000
|
|
@@ -628,9 +605,9 @@ export interface SiteUnpublished {
|
|
|
628
605
|
*/
|
|
629
606
|
urls?: string[];
|
|
630
607
|
}
|
|
631
|
-
|
|
608
|
+
interface SiteMarkedAsTemplate {
|
|
632
609
|
}
|
|
633
|
-
|
|
610
|
+
interface SiteMarkedAsWixSite {
|
|
634
611
|
}
|
|
635
612
|
/**
|
|
636
613
|
* Represents a service provisioned a site.
|
|
@@ -647,7 +624,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
647
624
|
* changes made to the original template afterward.
|
|
648
625
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
649
626
|
*/
|
|
650
|
-
|
|
627
|
+
interface ServiceProvisioned {
|
|
651
628
|
/**
|
|
652
629
|
* Either UUID or EmbeddedServiceType.
|
|
653
630
|
* @maxLength 36
|
|
@@ -674,7 +651,7 @@ export interface ServiceProvisioned {
|
|
|
674
651
|
*/
|
|
675
652
|
originMetaSiteId?: string | null;
|
|
676
653
|
}
|
|
677
|
-
|
|
654
|
+
interface ServiceRemoved {
|
|
678
655
|
/**
|
|
679
656
|
* Either UUID or EmbeddedServiceType.
|
|
680
657
|
* @maxLength 36
|
|
@@ -692,7 +669,7 @@ export interface ServiceRemoved {
|
|
|
692
669
|
version?: string | null;
|
|
693
670
|
}
|
|
694
671
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
695
|
-
|
|
672
|
+
interface SiteRenamed {
|
|
696
673
|
/**
|
|
697
674
|
* A new meta site name (URL slug).
|
|
698
675
|
* @maxLength 20
|
|
@@ -709,21 +686,21 @@ export interface SiteRenamed {
|
|
|
709
686
|
*
|
|
710
687
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
711
688
|
*/
|
|
712
|
-
|
|
689
|
+
interface SiteHardDeleted {
|
|
713
690
|
/** A deletion context. */
|
|
714
691
|
deleteContext?: DeleteContext;
|
|
715
692
|
}
|
|
716
|
-
|
|
693
|
+
interface NamespaceChanged {
|
|
717
694
|
/** A previous namespace. */
|
|
718
695
|
oldNamespace?: NamespaceWithLiterals;
|
|
719
696
|
/** A new namespace. */
|
|
720
697
|
newNamespace?: NamespaceWithLiterals;
|
|
721
698
|
}
|
|
722
699
|
/** Assigned Studio editor */
|
|
723
|
-
|
|
700
|
+
interface StudioAssigned {
|
|
724
701
|
}
|
|
725
702
|
/** Unassigned Studio editor */
|
|
726
|
-
|
|
703
|
+
interface StudioUnassigned {
|
|
727
704
|
}
|
|
728
705
|
/**
|
|
729
706
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -733,13 +710,13 @@ export interface StudioUnassigned {
|
|
|
733
710
|
*
|
|
734
711
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
735
712
|
*/
|
|
736
|
-
|
|
713
|
+
interface SiteUrlChanged {
|
|
737
714
|
}
|
|
738
715
|
/**
|
|
739
716
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
740
717
|
* Consumed by other teams to remove relevant data.
|
|
741
718
|
*/
|
|
742
|
-
|
|
719
|
+
interface SitePurgedExternally {
|
|
743
720
|
/**
|
|
744
721
|
* @maxLength 2048
|
|
745
722
|
* @maxSize 100
|
|
@@ -749,20 +726,20 @@ export interface SitePurgedExternally {
|
|
|
749
726
|
appDefId?: string[];
|
|
750
727
|
}
|
|
751
728
|
/** Assigned Odeditor */
|
|
752
|
-
|
|
729
|
+
interface OdeditorAssigned {
|
|
753
730
|
}
|
|
754
731
|
/** Unassigned Odeditor */
|
|
755
|
-
|
|
732
|
+
interface OdeditorUnassigned {
|
|
756
733
|
}
|
|
757
734
|
/** Assigned Picasso editor */
|
|
758
|
-
|
|
735
|
+
interface PicassoAssigned {
|
|
759
736
|
}
|
|
760
737
|
/** Unassigned Picasso */
|
|
761
|
-
|
|
738
|
+
interface PicassoUnassigned {
|
|
762
739
|
}
|
|
763
|
-
|
|
740
|
+
interface Empty {
|
|
764
741
|
}
|
|
765
|
-
|
|
742
|
+
interface FeatureEvent extends FeatureEventEventOneOf {
|
|
766
743
|
/**
|
|
767
744
|
* Information about an event that makes a feature eligible to the user.
|
|
768
745
|
* Triggered for example, for new features or when a feature is reassigned
|
|
@@ -796,7 +773,7 @@ export interface FeatureEvent extends FeatureEventEventOneOf {
|
|
|
796
773
|
timestamp?: Date | null;
|
|
797
774
|
}
|
|
798
775
|
/** @oneof */
|
|
799
|
-
|
|
776
|
+
interface FeatureEventEventOneOf {
|
|
800
777
|
/**
|
|
801
778
|
* Information about an event that makes a feature eligible to the user.
|
|
802
779
|
* Triggered for example, for new features or when a feature is reassigned
|
|
@@ -825,7 +802,7 @@ export interface FeatureEventEventOneOf {
|
|
|
825
802
|
cancelled?: FeatureCancelled;
|
|
826
803
|
}
|
|
827
804
|
/** Feature created or enabled after disabled state */
|
|
828
|
-
|
|
805
|
+
interface FeatureEnabled extends FeatureEnabledReasonOneOf {
|
|
829
806
|
/** Information about a transfer from another account. */
|
|
830
807
|
transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
|
|
831
808
|
/** Information about a transfer from another site. */
|
|
@@ -856,7 +833,7 @@ export interface FeatureEnabled extends FeatureEnabledReasonOneOf {
|
|
|
856
833
|
reassignedFromMetasite?: string | null;
|
|
857
834
|
}
|
|
858
835
|
/** @oneof */
|
|
859
|
-
|
|
836
|
+
interface FeatureEnabledReasonOneOf {
|
|
860
837
|
/** Information about a transfer from another account. */
|
|
861
838
|
transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
|
|
862
839
|
/** Information about a transfer from another site. */
|
|
@@ -872,7 +849,7 @@ export interface FeatureEnabledReasonOneOf {
|
|
|
872
849
|
/** Information about a feature that was migrated from legacy. */
|
|
873
850
|
migratedFromLegacy?: MigratedFromLegacyReason;
|
|
874
851
|
}
|
|
875
|
-
|
|
852
|
+
interface Feature extends FeatureQuantityInfoOneOf {
|
|
876
853
|
/**
|
|
877
854
|
* Deprecated. Use `enabled` instead.
|
|
878
855
|
* @deprecated
|
|
@@ -889,7 +866,7 @@ export interface Feature extends FeatureQuantityInfoOneOf {
|
|
|
889
866
|
* `{"id": "DEFAULT"}`. Use `uniqueName` as unique identifier for a feature.
|
|
890
867
|
* @readonly
|
|
891
868
|
*/
|
|
892
|
-
|
|
869
|
+
_id?: string;
|
|
893
870
|
/**
|
|
894
871
|
* Unique name of the feature. Only lower case letters, numbers, and dashes
|
|
895
872
|
* `-` are supported. Used in the endpoints of the
|
|
@@ -953,7 +930,7 @@ export interface Feature extends FeatureQuantityInfoOneOf {
|
|
|
953
930
|
metadata?: Record<string, string>;
|
|
954
931
|
}
|
|
955
932
|
/** @oneof */
|
|
956
|
-
|
|
933
|
+
interface FeatureQuantityInfoOneOf {
|
|
957
934
|
/**
|
|
958
935
|
* Deprecated. Use `enabled` instead.
|
|
959
936
|
* @deprecated
|
|
@@ -970,7 +947,7 @@ export interface FeatureQuantityInfoOneOf {
|
|
|
970
947
|
* Note: Do not confuse with feature scope which is configured in the product catalog
|
|
971
948
|
* and defines in which context the product can be used
|
|
972
949
|
*/
|
|
973
|
-
|
|
950
|
+
interface FeatureContext {
|
|
974
951
|
/**
|
|
975
952
|
* ID of the Wix account that the feature instance belongs to.
|
|
976
953
|
* Available for both site and account level feature instances.
|
|
@@ -990,10 +967,10 @@ export interface FeatureContext {
|
|
|
990
967
|
* A feature that can be either "enabled" or "disabled". The default/freemium setting is always OFF, and the premium setting is always ON (meaning, unlimited usage without tracking).
|
|
991
968
|
* A boolean feature is similar to a quantitive feature with a default limit of 0 and UNLIMITED premium limit (although a bit simplified).
|
|
992
969
|
*/
|
|
993
|
-
|
|
970
|
+
interface BooleanFeature {
|
|
994
971
|
}
|
|
995
972
|
/** A feature with a periodic usage limitation. The default limit is defined in the Feature Spec, the Premium limits are defined in the respective ProductFeature. */
|
|
996
|
-
|
|
973
|
+
interface QuotaFeature {
|
|
997
974
|
/** Default (or Freemium) quota limitation. if left undefined the free feature has unlimited amount. */
|
|
998
975
|
limit?: string | null;
|
|
999
976
|
/** Periodic time-frame to reset the usage counter. You may use NO_PERIOD if counter shouldn't be reset. */
|
|
@@ -1002,7 +979,7 @@ export interface QuotaFeature {
|
|
|
1002
979
|
units?: string | null;
|
|
1003
980
|
}
|
|
1004
981
|
/** Determines the reset cycle of the feature usage. */
|
|
1005
|
-
|
|
982
|
+
declare enum FeaturePeriod {
|
|
1006
983
|
NO_PERIOD = "NO_PERIOD",
|
|
1007
984
|
MILLISECOND = "MILLISECOND",
|
|
1008
985
|
SECOND = "SECOND",
|
|
@@ -1014,8 +991,8 @@ export declare enum FeaturePeriod {
|
|
|
1014
991
|
YEAR = "YEAR"
|
|
1015
992
|
}
|
|
1016
993
|
/** @enumType */
|
|
1017
|
-
|
|
1018
|
-
|
|
994
|
+
type FeaturePeriodWithLiterals = FeaturePeriod | 'NO_PERIOD' | 'MILLISECOND' | 'SECOND' | 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
995
|
+
interface QuotaInfo {
|
|
1019
996
|
/**
|
|
1020
997
|
* How often the customer is allowed to use the feature during the specified
|
|
1021
998
|
* period. `null` means that the customer has unlimited access to the feature.
|
|
@@ -1046,7 +1023,7 @@ export interface QuotaInfo {
|
|
|
1046
1023
|
remainingUsage?: string | null;
|
|
1047
1024
|
}
|
|
1048
1025
|
/** Subscription transferred from another account, features on the current account were enabled. */
|
|
1049
|
-
|
|
1026
|
+
interface TransferredFromAnotherAccountReason {
|
|
1050
1027
|
/**
|
|
1051
1028
|
* Information about a transfer from another account.
|
|
1052
1029
|
* @format GUID
|
|
@@ -1054,7 +1031,7 @@ export interface TransferredFromAnotherAccountReason {
|
|
|
1054
1031
|
transferredFromAccount?: string;
|
|
1055
1032
|
}
|
|
1056
1033
|
/** Subscription moved from one site to another in the same account, features enabled on the target site */
|
|
1057
|
-
|
|
1034
|
+
interface ReassignedFromSiteReason {
|
|
1058
1035
|
/**
|
|
1059
1036
|
* Information about a transfer from another site.
|
|
1060
1037
|
* @format GUID
|
|
@@ -1062,22 +1039,22 @@ export interface ReassignedFromSiteReason {
|
|
|
1062
1039
|
reassignedFromMetasite?: string;
|
|
1063
1040
|
}
|
|
1064
1041
|
/** Subscription was floating and assigned to site, features enabled on the target site */
|
|
1065
|
-
|
|
1042
|
+
interface AssignedFromFloatingReason {
|
|
1066
1043
|
}
|
|
1067
1044
|
/** New subscription created and features created as enabled */
|
|
1068
|
-
|
|
1045
|
+
interface NewFeatureReason {
|
|
1069
1046
|
}
|
|
1070
1047
|
/** Subscription was upgraded or downgraded, as a result new features enabled, missing features disabled , quantities are updated */
|
|
1071
|
-
|
|
1048
|
+
interface ContractSwitchedReason {
|
|
1072
1049
|
}
|
|
1073
1050
|
/** a call to CreateFeature in features-writer, creates feature that is not attached to subscription */
|
|
1074
|
-
|
|
1051
|
+
interface ManualFeatureCreationReason {
|
|
1075
1052
|
}
|
|
1076
1053
|
/** Subscription created due to migration from old premium model */
|
|
1077
|
-
|
|
1054
|
+
interface MigratedFromLegacyReason {
|
|
1078
1055
|
}
|
|
1079
1056
|
/** Feature disabled and can be enabled in the future */
|
|
1080
|
-
|
|
1057
|
+
interface FeatureDisabled extends FeatureDisabledReasonOneOf {
|
|
1081
1058
|
/** Information about a feature that's no longer assigned to a site. */
|
|
1082
1059
|
unassingedToFloating?: UnAssingedToFloatingReason;
|
|
1083
1060
|
/**
|
|
@@ -1102,7 +1079,7 @@ export interface FeatureDisabled extends FeatureDisabledReasonOneOf {
|
|
|
1102
1079
|
metaSiteId?: string | null;
|
|
1103
1080
|
}
|
|
1104
1081
|
/** @oneof */
|
|
1105
|
-
|
|
1082
|
+
interface FeatureDisabledReasonOneOf {
|
|
1106
1083
|
/** Information about a feature that's no longer assigned to a site. */
|
|
1107
1084
|
unassingedToFloating?: UnAssingedToFloatingReason;
|
|
1108
1085
|
/**
|
|
@@ -1117,13 +1094,13 @@ export interface FeatureDisabledReasonOneOf {
|
|
|
1117
1094
|
reassignedToAnotherSite?: ReassignedToAnotherSiteReason;
|
|
1118
1095
|
}
|
|
1119
1096
|
/** Subscription was unassigned from the site and moved into floating state */
|
|
1120
|
-
|
|
1097
|
+
interface UnAssingedToFloatingReason {
|
|
1121
1098
|
}
|
|
1122
1099
|
/** Another subscription was assigned to the site, causing existing features on this site to be disabled */
|
|
1123
|
-
|
|
1100
|
+
interface ReplacedByAnotherSubscriptionReason {
|
|
1124
1101
|
}
|
|
1125
1102
|
/** Subscription was assigned to another site, causing features on the origin site to be disabled. */
|
|
1126
|
-
|
|
1103
|
+
interface ReassignedToAnotherSiteReason {
|
|
1127
1104
|
/**
|
|
1128
1105
|
* Information about a transfer to the site.
|
|
1129
1106
|
* @format GUID
|
|
@@ -1131,7 +1108,7 @@ export interface ReassignedToAnotherSiteReason {
|
|
|
1131
1108
|
reassignedToMetasite?: string;
|
|
1132
1109
|
}
|
|
1133
1110
|
/** Feature updated, for example Quota was increased due to upgrade */
|
|
1134
|
-
|
|
1111
|
+
interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf, FeatureUpdatedReasonOneOf {
|
|
1135
1112
|
/** Information about a feature that doesn't have a usage quota. */
|
|
1136
1113
|
booleanFeature?: BooleanFeature;
|
|
1137
1114
|
/** Information about a feature that has a usage quota. */
|
|
@@ -1145,19 +1122,19 @@ export interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf,
|
|
|
1145
1122
|
feature?: Feature;
|
|
1146
1123
|
}
|
|
1147
1124
|
/** @oneof */
|
|
1148
|
-
|
|
1125
|
+
interface FeatureUpdatedPreviousQuantityInfoOneOf {
|
|
1149
1126
|
/** Information about a feature that doesn't have a usage quota. */
|
|
1150
1127
|
booleanFeature?: BooleanFeature;
|
|
1151
1128
|
/** Information about a feature that has a usage quota. */
|
|
1152
1129
|
quotaFeature?: QuotaFeature;
|
|
1153
1130
|
}
|
|
1154
1131
|
/** @oneof */
|
|
1155
|
-
|
|
1132
|
+
interface FeatureUpdatedReasonOneOf {
|
|
1156
1133
|
/** Information about the contract switch. */
|
|
1157
1134
|
contractSwitched?: ContractSwitchedReason;
|
|
1158
1135
|
}
|
|
1159
1136
|
/** Feature was permanently cancelled */
|
|
1160
|
-
|
|
1137
|
+
interface FeatureCancelled extends FeatureCancelledReasonOneOf {
|
|
1161
1138
|
/** Information about a transfer to the account. */
|
|
1162
1139
|
transferredToAnotherAccount?: TransferredToAnotherAccountReason;
|
|
1163
1140
|
/** Information about the contract switch. */
|
|
@@ -1174,7 +1151,7 @@ export interface FeatureCancelled extends FeatureCancelledReasonOneOf {
|
|
|
1174
1151
|
transferredToAccount?: string | null;
|
|
1175
1152
|
}
|
|
1176
1153
|
/** @oneof */
|
|
1177
|
-
|
|
1154
|
+
interface FeatureCancelledReasonOneOf {
|
|
1178
1155
|
/** Information about a transfer to the account. */
|
|
1179
1156
|
transferredToAnotherAccount?: TransferredToAnotherAccountReason;
|
|
1180
1157
|
/** Information about the contract switch. */
|
|
@@ -1183,7 +1160,7 @@ export interface FeatureCancelledReasonOneOf {
|
|
|
1183
1160
|
cancelRequest?: CancelRequestedReason;
|
|
1184
1161
|
}
|
|
1185
1162
|
/** Subscription was transferred to another account, features in the origin account were cancelled */
|
|
1186
|
-
|
|
1163
|
+
interface TransferredToAnotherAccountReason {
|
|
1187
1164
|
/**
|
|
1188
1165
|
* Information about a transfer to the account.
|
|
1189
1166
|
* @format GUID
|
|
@@ -1191,15 +1168,15 @@ export interface TransferredToAnotherAccountReason {
|
|
|
1191
1168
|
transferredToAccount?: string;
|
|
1192
1169
|
}
|
|
1193
1170
|
/** Cancellation was requested from the subscription manager api, might be a result of billing event, or direct call */
|
|
1194
|
-
|
|
1171
|
+
interface CancelRequestedReason {
|
|
1195
1172
|
}
|
|
1196
|
-
|
|
1173
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1197
1174
|
createdEvent?: EntityCreatedEvent;
|
|
1198
1175
|
updatedEvent?: EntityUpdatedEvent;
|
|
1199
1176
|
deletedEvent?: EntityDeletedEvent;
|
|
1200
1177
|
actionEvent?: ActionEvent;
|
|
1201
1178
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1202
|
-
|
|
1179
|
+
_id?: string;
|
|
1203
1180
|
/**
|
|
1204
1181
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1205
1182
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -1228,36 +1205,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1228
1205
|
entityEventSequence?: string | null;
|
|
1229
1206
|
}
|
|
1230
1207
|
/** @oneof */
|
|
1231
|
-
|
|
1208
|
+
interface DomainEventBodyOneOf {
|
|
1232
1209
|
createdEvent?: EntityCreatedEvent;
|
|
1233
1210
|
updatedEvent?: EntityUpdatedEvent;
|
|
1234
1211
|
deletedEvent?: EntityDeletedEvent;
|
|
1235
1212
|
actionEvent?: ActionEvent;
|
|
1236
1213
|
}
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1240
|
-
restoreInfo?: RestoreInfo;
|
|
1214
|
+
interface EntityCreatedEvent {
|
|
1215
|
+
entity?: string;
|
|
1241
1216
|
}
|
|
1242
|
-
|
|
1217
|
+
interface RestoreInfo {
|
|
1243
1218
|
deletedDate?: Date | null;
|
|
1244
1219
|
}
|
|
1245
|
-
|
|
1220
|
+
interface EntityUpdatedEvent {
|
|
1246
1221
|
/**
|
|
1247
1222
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1248
1223
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1249
1224
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1250
1225
|
*/
|
|
1251
|
-
|
|
1226
|
+
currentEntity?: string;
|
|
1252
1227
|
}
|
|
1253
|
-
|
|
1228
|
+
interface EntityDeletedEvent {
|
|
1254
1229
|
/** Entity that was deleted. */
|
|
1255
|
-
|
|
1230
|
+
deletedEntity?: string | null;
|
|
1256
1231
|
}
|
|
1257
|
-
|
|
1258
|
-
|
|
1232
|
+
interface ActionEvent {
|
|
1233
|
+
body?: string;
|
|
1259
1234
|
}
|
|
1260
|
-
|
|
1235
|
+
interface MessageEnvelope {
|
|
1261
1236
|
/**
|
|
1262
1237
|
* App instance ID.
|
|
1263
1238
|
* @format GUID
|
|
@@ -1273,7 +1248,7 @@ export interface MessageEnvelope {
|
|
|
1273
1248
|
/** Stringify payload. */
|
|
1274
1249
|
data?: string;
|
|
1275
1250
|
}
|
|
1276
|
-
|
|
1251
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1277
1252
|
/**
|
|
1278
1253
|
* ID of a site visitor that has not logged in to the site.
|
|
1279
1254
|
* @format GUID
|
|
@@ -1298,7 +1273,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1298
1273
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1299
1274
|
}
|
|
1300
1275
|
/** @oneof */
|
|
1301
|
-
|
|
1276
|
+
interface IdentificationDataIdOneOf {
|
|
1302
1277
|
/**
|
|
1303
1278
|
* ID of a site visitor that has not logged in to the site.
|
|
1304
1279
|
* @format GUID
|
|
@@ -1320,7 +1295,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
1320
1295
|
*/
|
|
1321
1296
|
appId?: string;
|
|
1322
1297
|
}
|
|
1323
|
-
|
|
1298
|
+
declare enum WebhookIdentityType {
|
|
1324
1299
|
UNKNOWN = "UNKNOWN",
|
|
1325
1300
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1326
1301
|
MEMBER = "MEMBER",
|
|
@@ -1328,4 +1303,54 @@ export declare enum WebhookIdentityType {
|
|
|
1328
1303
|
APP = "APP"
|
|
1329
1304
|
}
|
|
1330
1305
|
/** @enumType */
|
|
1331
|
-
|
|
1306
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1307
|
+
interface BaseEventMetadata {
|
|
1308
|
+
/**
|
|
1309
|
+
* App instance ID.
|
|
1310
|
+
* @format GUID
|
|
1311
|
+
*/
|
|
1312
|
+
instanceId?: string | null;
|
|
1313
|
+
/**
|
|
1314
|
+
* Event type.
|
|
1315
|
+
* @maxLength 150
|
|
1316
|
+
*/
|
|
1317
|
+
eventType?: string;
|
|
1318
|
+
/** The identification type and identity data. */
|
|
1319
|
+
identity?: IdentificationData;
|
|
1320
|
+
}
|
|
1321
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1322
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1323
|
+
_id?: string;
|
|
1324
|
+
/**
|
|
1325
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1326
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1327
|
+
*/
|
|
1328
|
+
entityFqdn?: string;
|
|
1329
|
+
/**
|
|
1330
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1331
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1332
|
+
*/
|
|
1333
|
+
slug?: string;
|
|
1334
|
+
/** ID of the entity associated with the event. */
|
|
1335
|
+
entityId?: string;
|
|
1336
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1337
|
+
eventTime?: Date | null;
|
|
1338
|
+
/**
|
|
1339
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1340
|
+
* (for example, GDPR).
|
|
1341
|
+
*/
|
|
1342
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1343
|
+
/** If present, indicates the action that triggered the event. */
|
|
1344
|
+
originatedFrom?: string | null;
|
|
1345
|
+
/**
|
|
1346
|
+
* 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.
|
|
1347
|
+
* 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.
|
|
1348
|
+
*/
|
|
1349
|
+
entityEventSequence?: string | null;
|
|
1350
|
+
}
|
|
1351
|
+
interface ProgramUpdatedEnvelope {
|
|
1352
|
+
entity: LoyaltyProgram;
|
|
1353
|
+
metadata: EventMetadata;
|
|
1354
|
+
}
|
|
1355
|
+
|
|
1356
|
+
export { type SiteUnpublished as $, type ActivateLoyaltyProgramResponse as A, type BulkGetLoyaltyProgramResponse as B, type GetLoyaltyProgramPremiumFeaturesRequest as C, type DisablePointsExpirationResponse as D, type EnablePointsExpirationResponse as E, FeaturePeriod as F, type GetLoyaltyProgramResponse as G, type EnablePointsExpirationRequest as H, type PointsExpirationEnabled as I, type DisablePointsExpirationRequest as J, type PointsExpirationDisabled as K, type LoyaltyProgram as L, type MetaSiteSpecialEvent as M, Namespace as N, type MetaSiteSpecialEventPayloadOneOf as O, type PauseLoyaltyProgramResponse as P, type Asset as Q, type SiteCreated as R, Status as S, Type as T, type UpdateLoyaltyProgramResponse as U, type SiteTransferred as V, WebhookIdentityType as W, type SiteDeleted as X, type DeleteContext as Y, type SiteUndeleted as Z, type SitePublished as _, type GetLoyaltyProgramPremiumFeaturesResponse as a, type SiteMarkedAsTemplate as a0, type SiteMarkedAsWixSite as a1, type ServiceProvisioned as a2, type ServiceRemoved as a3, type SiteRenamed as a4, type SiteHardDeleted as a5, type NamespaceChanged as a6, type StudioAssigned as a7, type StudioUnassigned as a8, type SiteUrlChanged as a9, type ReplacedByAnotherSubscriptionReason as aA, type ReassignedToAnotherSiteReason as aB, type FeatureUpdated as aC, type FeatureUpdatedPreviousQuantityInfoOneOf as aD, type FeatureUpdatedReasonOneOf as aE, type FeatureCancelled as aF, type FeatureCancelledReasonOneOf as aG, type TransferredToAnotherAccountReason as aH, type CancelRequestedReason as aI, type DomainEvent as aJ, type DomainEventBodyOneOf as aK, type EntityCreatedEvent as aL, type RestoreInfo as aM, type EntityUpdatedEvent as aN, type EntityDeletedEvent as aO, type ActionEvent as aP, type MessageEnvelope as aQ, type IdentificationData as aR, type IdentificationDataIdOneOf as aS, type BaseEventMetadata as aT, type EventMetadata as aU, type SitePurgedExternally as aa, type OdeditorAssigned as ab, type OdeditorUnassigned as ac, type PicassoAssigned as ad, type PicassoUnassigned as ae, type Empty as af, type FeatureEvent as ag, type FeatureEventEventOneOf as ah, type FeatureEnabled as ai, type FeatureEnabledReasonOneOf as aj, type Feature as ak, type FeatureQuantityInfoOneOf as al, type FeatureContext as am, type BooleanFeature as an, type QuotaFeature as ao, type QuotaInfo as ap, type TransferredFromAnotherAccountReason as aq, type ReassignedFromSiteReason as ar, type AssignedFromFloatingReason as as, type NewFeatureReason as at, type ContractSwitchedReason as au, type ManualFeatureCreationReason as av, type MigratedFromLegacyReason as aw, type FeatureDisabled as ax, type FeatureDisabledReasonOneOf as ay, type UnAssingedToFloatingReason as az, type ProgramUpdatedEnvelope as b, ProgramStatus as c, State as d, SiteCreatedContext as e, DeleteStatus as f, type PointDefinition as g, type FocalPoint as h, type PointsExpiration as i, type PremiumFeatures as j, type SocialMediaSettings as k, type SocialMediaChannel as l, type GetLoyaltyProgramRequest as m, type BulkGetLoyaltyProgramRequest as n, type ProgramInSite as o, type UpdateLoyaltyProgramRequest as p, type PointsExpirationConfigurationChanged as q, type PointsExpirationChanges as r, type ActivateLoyaltyProgramRequest as s, type LoyaltyProgramActivated as t, type PauseLoyaltyProgramRequest as u, type GetLoyaltyProgramDescriptionRequest as v, type GetLoyaltyProgramDescriptionResponse as w, type UpdateLoyaltyProgramDescriptionRequest as x, type UpdateLoyaltyProgramDescriptionResponse as y, type LoyaltyProgramDescriptionUpdated as z };
|