@wix/auto_sdk_loyalty_programs 1.0.13 → 1.0.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/index.d.mts +101 -0
- package/build/index.d.ts +101 -0
- package/build/index.js +874 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +833 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/index.d.mts +101 -0
- package/build/internal/index.d.ts +101 -0
- package/build/internal/index.js +874 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +833 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{cjs/src/loyalty-v1-program-programs.types.d.ts → internal/loyalty-v1-program-programs.universal-CCZ90Kwf.d.mts} +172 -209
- package/build/internal/{cjs/src/loyalty-v1-program-programs.types.d.ts → loyalty-v1-program-programs.universal-CCZ90Kwf.d.ts} +172 -209
- package/build/internal/meta.d.mts +226 -0
- package/build/internal/meta.d.ts +226 -0
- package/build/internal/meta.js +557 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +523 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{internal/es/src/loyalty-v1-program-programs.types.d.ts → loyalty-v1-program-programs.universal-CCZ90Kwf.d.mts} +172 -209
- package/build/{es/src/loyalty-v1-program-programs.types.d.ts → loyalty-v1-program-programs.universal-CCZ90Kwf.d.ts} +172 -209
- package/build/meta.d.mts +226 -0
- package/build/meta.d.ts +226 -0
- package/build/meta.js +557 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +523 -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-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 -1516
- 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/package.json +0 -3
- 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 -1516
- 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.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-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 -1516
- 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 -1516
- 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. */
|
|
@@ -95,7 +72,7 @@ export declare enum ProgramStatus {
|
|
|
95
72
|
/** Program was manually disabled by the user. This action can be reverted, meaning the user can set it to be active again. */
|
|
96
73
|
PAUSED = "PAUSED"
|
|
97
74
|
}
|
|
98
|
-
|
|
75
|
+
interface PointsExpiration {
|
|
99
76
|
/**
|
|
100
77
|
* Status of the points expiration feature.
|
|
101
78
|
* @readonly
|
|
@@ -114,7 +91,7 @@ export interface PointsExpiration {
|
|
|
114
91
|
*/
|
|
115
92
|
expiringPointsPercentage?: number;
|
|
116
93
|
}
|
|
117
|
-
|
|
94
|
+
declare enum Status {
|
|
118
95
|
/** Unknown points expiration status. This value is not used. */
|
|
119
96
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
120
97
|
/** Points expiration feature is disabled. */
|
|
@@ -122,7 +99,7 @@ export declare enum Status {
|
|
|
122
99
|
/** Points expiration feature is enabled. */
|
|
123
100
|
ENABLED = "ENABLED"
|
|
124
101
|
}
|
|
125
|
-
|
|
102
|
+
interface PremiumFeatures {
|
|
126
103
|
/**
|
|
127
104
|
* Whether there are any loyalty program premium features.
|
|
128
105
|
* @readonly
|
|
@@ -139,14 +116,14 @@ export interface PremiumFeatures {
|
|
|
139
116
|
*/
|
|
140
117
|
pointsExpiration?: boolean;
|
|
141
118
|
}
|
|
142
|
-
|
|
119
|
+
interface SocialMediaSettings {
|
|
143
120
|
/**
|
|
144
121
|
* List of social media channels
|
|
145
122
|
* @maxSize 5
|
|
146
123
|
*/
|
|
147
124
|
channels?: SocialMediaChannel[];
|
|
148
125
|
}
|
|
149
|
-
|
|
126
|
+
interface SocialMediaChannel {
|
|
150
127
|
/** Social media channel type */
|
|
151
128
|
type?: Type;
|
|
152
129
|
/** Enable or disable social media channel */
|
|
@@ -156,7 +133,7 @@ export interface SocialMediaChannel {
|
|
|
156
133
|
* @minLength 1
|
|
157
134
|
* @maxLength 255
|
|
158
135
|
*/
|
|
159
|
-
|
|
136
|
+
_id?: string;
|
|
160
137
|
/**
|
|
161
138
|
* Social media channel URL
|
|
162
139
|
* @readonly
|
|
@@ -164,7 +141,7 @@ export interface SocialMediaChannel {
|
|
|
164
141
|
*/
|
|
165
142
|
url?: string | null;
|
|
166
143
|
}
|
|
167
|
-
|
|
144
|
+
declare enum Type {
|
|
168
145
|
/** Unknown social media channel type. */
|
|
169
146
|
UNKNOWN_CHANNEL = "UNKNOWN_CHANNEL",
|
|
170
147
|
/** Facebook social media channel. */
|
|
@@ -178,19 +155,19 @@ export declare enum Type {
|
|
|
178
155
|
/** TikTok social media channel. */
|
|
179
156
|
TIKTOK = "TIKTOK"
|
|
180
157
|
}
|
|
181
|
-
|
|
158
|
+
interface GetLoyaltyProgramRequest {
|
|
182
159
|
}
|
|
183
|
-
|
|
160
|
+
interface GetLoyaltyProgramResponse {
|
|
184
161
|
/** Retrieved loyalty program. */
|
|
185
162
|
loyaltyProgram?: LoyaltyProgram;
|
|
186
163
|
}
|
|
187
|
-
|
|
164
|
+
interface BulkGetLoyaltyProgramRequest {
|
|
188
165
|
}
|
|
189
|
-
|
|
166
|
+
interface BulkGetLoyaltyProgramResponse {
|
|
190
167
|
/** Retrieved loyalty programs. */
|
|
191
168
|
programInSites?: ProgramInSite[];
|
|
192
169
|
}
|
|
193
|
-
|
|
170
|
+
interface ProgramInSite {
|
|
194
171
|
/**
|
|
195
172
|
* Metasite ID.
|
|
196
173
|
* @format GUID
|
|
@@ -199,54 +176,54 @@ export interface ProgramInSite {
|
|
|
199
176
|
/** Loyalty program. */
|
|
200
177
|
loyaltyProgram?: LoyaltyProgram;
|
|
201
178
|
}
|
|
202
|
-
|
|
179
|
+
interface UpdateLoyaltyProgramRequest {
|
|
203
180
|
/** Loyalty program fields to update. */
|
|
204
181
|
loyaltyProgram: LoyaltyProgram;
|
|
205
182
|
}
|
|
206
|
-
|
|
183
|
+
interface UpdateLoyaltyProgramResponse {
|
|
207
184
|
/** Updated loyalty program. */
|
|
208
185
|
loyaltyProgram?: LoyaltyProgram;
|
|
209
186
|
}
|
|
210
|
-
|
|
187
|
+
interface PointsExpirationConfigurationChanged {
|
|
211
188
|
/** Loyalty program. */
|
|
212
189
|
loyaltyProgram?: LoyaltyProgram;
|
|
213
190
|
/** Points expiration configuration changes */
|
|
214
191
|
pointsExpirationChanges?: PointsExpirationChanges;
|
|
215
192
|
}
|
|
216
|
-
|
|
193
|
+
interface PointsExpirationChanges {
|
|
217
194
|
monthsOfInactivity?: number | null;
|
|
218
195
|
expiringPointsPercentage?: number | null;
|
|
219
196
|
}
|
|
220
|
-
|
|
197
|
+
interface ActivateLoyaltyProgramRequest {
|
|
221
198
|
}
|
|
222
|
-
|
|
199
|
+
interface ActivateLoyaltyProgramResponse {
|
|
223
200
|
/** Activated loyalty program. */
|
|
224
201
|
loyaltyProgram?: LoyaltyProgram;
|
|
225
202
|
}
|
|
226
|
-
|
|
203
|
+
interface LoyaltyProgramActivated {
|
|
227
204
|
/** Activated loyalty program. */
|
|
228
205
|
loyaltyProgram?: LoyaltyProgram;
|
|
229
206
|
}
|
|
230
|
-
|
|
207
|
+
interface PauseLoyaltyProgramRequest {
|
|
231
208
|
}
|
|
232
|
-
|
|
209
|
+
interface PauseLoyaltyProgramResponse {
|
|
233
210
|
/** Paused loyalty program. */
|
|
234
211
|
loyaltyProgram?: LoyaltyProgram;
|
|
235
212
|
}
|
|
236
|
-
|
|
213
|
+
interface GetLoyaltyProgramDescriptionRequest {
|
|
237
214
|
/**
|
|
238
215
|
* List of description fields to retrieve. Supported values: `description`, `updatedDate`.
|
|
239
216
|
* @maxSize 2
|
|
240
217
|
*/
|
|
241
218
|
fields?: string[];
|
|
242
219
|
}
|
|
243
|
-
|
|
220
|
+
interface GetLoyaltyProgramDescriptionResponse {
|
|
244
221
|
/** Retrieved loyalty program description. */
|
|
245
222
|
description?: string | null;
|
|
246
223
|
/** Date and time of the latest description update. */
|
|
247
|
-
|
|
224
|
+
_updatedDate?: Date | null;
|
|
248
225
|
}
|
|
249
|
-
|
|
226
|
+
interface UpdateLoyaltyProgramDescriptionRequest {
|
|
250
227
|
/**
|
|
251
228
|
* Loyalty program description to update.
|
|
252
229
|
* @minLength 1
|
|
@@ -254,13 +231,13 @@ export interface UpdateLoyaltyProgramDescriptionRequest {
|
|
|
254
231
|
*/
|
|
255
232
|
description?: string;
|
|
256
233
|
}
|
|
257
|
-
|
|
234
|
+
interface UpdateLoyaltyProgramDescriptionResponse {
|
|
258
235
|
}
|
|
259
|
-
|
|
236
|
+
interface LoyaltyProgramDescriptionUpdated {
|
|
260
237
|
}
|
|
261
|
-
|
|
238
|
+
interface GetLoyaltyProgramPremiumFeaturesRequest {
|
|
262
239
|
}
|
|
263
|
-
|
|
240
|
+
interface GetLoyaltyProgramPremiumFeaturesResponse {
|
|
264
241
|
/**
|
|
265
242
|
* Whether there are any loyalty program premium features.
|
|
266
243
|
* @readonly
|
|
@@ -277,27 +254,27 @@ export interface GetLoyaltyProgramPremiumFeaturesResponse {
|
|
|
277
254
|
*/
|
|
278
255
|
pointsExpiration?: boolean;
|
|
279
256
|
}
|
|
280
|
-
|
|
257
|
+
interface EnablePointsExpirationRequest {
|
|
281
258
|
}
|
|
282
|
-
|
|
259
|
+
interface EnablePointsExpirationResponse {
|
|
283
260
|
/** Loyalty program with enabled points expiration feature. */
|
|
284
261
|
loyaltyProgram?: LoyaltyProgram;
|
|
285
262
|
}
|
|
286
|
-
|
|
263
|
+
interface PointsExpirationEnabled {
|
|
287
264
|
/** Loyalty program. */
|
|
288
265
|
loyaltyProgram?: LoyaltyProgram;
|
|
289
266
|
}
|
|
290
|
-
|
|
267
|
+
interface DisablePointsExpirationRequest {
|
|
291
268
|
}
|
|
292
|
-
|
|
269
|
+
interface DisablePointsExpirationResponse {
|
|
293
270
|
/** Loyalty program with disabled points expiration feature. */
|
|
294
271
|
loyaltyProgram?: LoyaltyProgram;
|
|
295
272
|
}
|
|
296
|
-
|
|
273
|
+
interface PointsExpirationDisabled {
|
|
297
274
|
/** Loyalty program. */
|
|
298
275
|
loyaltyProgram?: LoyaltyProgram;
|
|
299
276
|
}
|
|
300
|
-
|
|
277
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
301
278
|
/** Emitted on a meta site creation. */
|
|
302
279
|
siteCreated?: SiteCreated;
|
|
303
280
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -355,7 +332,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
355
332
|
assets?: Asset[];
|
|
356
333
|
}
|
|
357
334
|
/** @oneof */
|
|
358
|
-
|
|
335
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
359
336
|
/** Emitted on a meta site creation. */
|
|
360
337
|
siteCreated?: SiteCreated;
|
|
361
338
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -397,7 +374,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
397
374
|
/** Site is marked as PurgedExternally */
|
|
398
375
|
sitePurgedExternally?: SitePurgedExternally;
|
|
399
376
|
}
|
|
400
|
-
|
|
377
|
+
interface Asset {
|
|
401
378
|
/**
|
|
402
379
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
403
380
|
* @maxLength 36
|
|
@@ -411,14 +388,14 @@ export interface Asset {
|
|
|
411
388
|
/** An application state. */
|
|
412
389
|
state?: State;
|
|
413
390
|
}
|
|
414
|
-
|
|
391
|
+
declare enum State {
|
|
415
392
|
UNKNOWN = "UNKNOWN",
|
|
416
393
|
ENABLED = "ENABLED",
|
|
417
394
|
DISABLED = "DISABLED",
|
|
418
395
|
PENDING = "PENDING",
|
|
419
396
|
DEMO = "DEMO"
|
|
420
397
|
}
|
|
421
|
-
|
|
398
|
+
interface SiteCreated {
|
|
422
399
|
/**
|
|
423
400
|
* A template identifier (empty if not created from a template).
|
|
424
401
|
* @maxLength 36
|
|
@@ -447,7 +424,7 @@ export interface SiteCreated {
|
|
|
447
424
|
/** A namespace. */
|
|
448
425
|
namespace?: Namespace;
|
|
449
426
|
}
|
|
450
|
-
|
|
427
|
+
declare enum SiteCreatedContext {
|
|
451
428
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
452
429
|
OTHER = "OTHER",
|
|
453
430
|
/** A meta site was created from template. */
|
|
@@ -461,7 +438,7 @@ export declare enum SiteCreatedContext {
|
|
|
461
438
|
/** deprecated A meta site was created for Flash editor. */
|
|
462
439
|
FLASH = "FLASH"
|
|
463
440
|
}
|
|
464
|
-
|
|
441
|
+
declare enum Namespace {
|
|
465
442
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
466
443
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
467
444
|
WIX = "WIX",
|
|
@@ -544,7 +521,7 @@ export declare enum Namespace {
|
|
|
544
521
|
MIMIR = "MIMIR"
|
|
545
522
|
}
|
|
546
523
|
/** Site transferred to another user. */
|
|
547
|
-
|
|
524
|
+
interface SiteTransferred {
|
|
548
525
|
/**
|
|
549
526
|
* A previous owner id (user that transfers meta site).
|
|
550
527
|
* @format GUID
|
|
@@ -557,11 +534,11 @@ export interface SiteTransferred {
|
|
|
557
534
|
newOwnerId?: string;
|
|
558
535
|
}
|
|
559
536
|
/** Soft deletion of the meta site. Could be restored. */
|
|
560
|
-
|
|
537
|
+
interface SiteDeleted {
|
|
561
538
|
/** A deletion context. */
|
|
562
539
|
deleteContext?: DeleteContext;
|
|
563
540
|
}
|
|
564
|
-
|
|
541
|
+
interface DeleteContext {
|
|
565
542
|
/** When the meta site was deleted. */
|
|
566
543
|
dateDeleted?: Date | null;
|
|
567
544
|
/** A status. */
|
|
@@ -577,7 +554,7 @@ export interface DeleteContext {
|
|
|
577
554
|
*/
|
|
578
555
|
initiatorId?: string | null;
|
|
579
556
|
}
|
|
580
|
-
|
|
557
|
+
declare enum DeleteStatus {
|
|
581
558
|
UNKNOWN = "UNKNOWN",
|
|
582
559
|
TRASH = "TRASH",
|
|
583
560
|
DELETED = "DELETED",
|
|
@@ -585,12 +562,12 @@ export declare enum DeleteStatus {
|
|
|
585
562
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
586
563
|
}
|
|
587
564
|
/** Restoration of the meta site. */
|
|
588
|
-
|
|
565
|
+
interface SiteUndeleted {
|
|
589
566
|
}
|
|
590
567
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
591
|
-
|
|
568
|
+
interface SitePublished {
|
|
592
569
|
}
|
|
593
|
-
|
|
570
|
+
interface SiteUnpublished {
|
|
594
571
|
/**
|
|
595
572
|
* A list of URLs previously associated with the meta site.
|
|
596
573
|
* @maxLength 4000
|
|
@@ -598,9 +575,9 @@ export interface SiteUnpublished {
|
|
|
598
575
|
*/
|
|
599
576
|
urls?: string[];
|
|
600
577
|
}
|
|
601
|
-
|
|
578
|
+
interface SiteMarkedAsTemplate {
|
|
602
579
|
}
|
|
603
|
-
|
|
580
|
+
interface SiteMarkedAsWixSite {
|
|
604
581
|
}
|
|
605
582
|
/**
|
|
606
583
|
* Represents a service provisioned a site.
|
|
@@ -617,7 +594,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
617
594
|
* changes made to the original template afterward.
|
|
618
595
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
619
596
|
*/
|
|
620
|
-
|
|
597
|
+
interface ServiceProvisioned {
|
|
621
598
|
/**
|
|
622
599
|
* Either UUID or EmbeddedServiceType.
|
|
623
600
|
* @maxLength 36
|
|
@@ -644,7 +621,7 @@ export interface ServiceProvisioned {
|
|
|
644
621
|
*/
|
|
645
622
|
originMetaSiteId?: string | null;
|
|
646
623
|
}
|
|
647
|
-
|
|
624
|
+
interface ServiceRemoved {
|
|
648
625
|
/**
|
|
649
626
|
* Either UUID or EmbeddedServiceType.
|
|
650
627
|
* @maxLength 36
|
|
@@ -662,7 +639,7 @@ export interface ServiceRemoved {
|
|
|
662
639
|
version?: string | null;
|
|
663
640
|
}
|
|
664
641
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
665
|
-
|
|
642
|
+
interface SiteRenamed {
|
|
666
643
|
/**
|
|
667
644
|
* A new meta site name (URL slug).
|
|
668
645
|
* @maxLength 20
|
|
@@ -679,21 +656,21 @@ export interface SiteRenamed {
|
|
|
679
656
|
*
|
|
680
657
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
681
658
|
*/
|
|
682
|
-
|
|
659
|
+
interface SiteHardDeleted {
|
|
683
660
|
/** A deletion context. */
|
|
684
661
|
deleteContext?: DeleteContext;
|
|
685
662
|
}
|
|
686
|
-
|
|
663
|
+
interface NamespaceChanged {
|
|
687
664
|
/** A previous namespace. */
|
|
688
665
|
oldNamespace?: Namespace;
|
|
689
666
|
/** A new namespace. */
|
|
690
667
|
newNamespace?: Namespace;
|
|
691
668
|
}
|
|
692
669
|
/** Assigned Studio editor */
|
|
693
|
-
|
|
670
|
+
interface StudioAssigned {
|
|
694
671
|
}
|
|
695
672
|
/** Unassigned Studio editor */
|
|
696
|
-
|
|
673
|
+
interface StudioUnassigned {
|
|
697
674
|
}
|
|
698
675
|
/**
|
|
699
676
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -703,13 +680,13 @@ export interface StudioUnassigned {
|
|
|
703
680
|
*
|
|
704
681
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
705
682
|
*/
|
|
706
|
-
|
|
683
|
+
interface SiteUrlChanged {
|
|
707
684
|
}
|
|
708
685
|
/**
|
|
709
686
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
710
687
|
* Consumed by other teams to remove relevant data.
|
|
711
688
|
*/
|
|
712
|
-
|
|
689
|
+
interface SitePurgedExternally {
|
|
713
690
|
/**
|
|
714
691
|
* @maxLength 2048
|
|
715
692
|
* @maxSize 100
|
|
@@ -718,9 +695,9 @@ export interface SitePurgedExternally {
|
|
|
718
695
|
*/
|
|
719
696
|
appDefId?: string[];
|
|
720
697
|
}
|
|
721
|
-
|
|
698
|
+
interface Empty {
|
|
722
699
|
}
|
|
723
|
-
|
|
700
|
+
interface FeatureEvent extends FeatureEventEventOneOf {
|
|
724
701
|
/**
|
|
725
702
|
* Information about an event that makes a feature eligible to the user.
|
|
726
703
|
* Triggered for example, for new features or when a feature is reassigned
|
|
@@ -754,7 +731,7 @@ export interface FeatureEvent extends FeatureEventEventOneOf {
|
|
|
754
731
|
timestamp?: Date | null;
|
|
755
732
|
}
|
|
756
733
|
/** @oneof */
|
|
757
|
-
|
|
734
|
+
interface FeatureEventEventOneOf {
|
|
758
735
|
/**
|
|
759
736
|
* Information about an event that makes a feature eligible to the user.
|
|
760
737
|
* Triggered for example, for new features or when a feature is reassigned
|
|
@@ -783,7 +760,7 @@ export interface FeatureEventEventOneOf {
|
|
|
783
760
|
cancelled?: FeatureCancelled;
|
|
784
761
|
}
|
|
785
762
|
/** Feature created or enabled after disabled state */
|
|
786
|
-
|
|
763
|
+
interface FeatureEnabled extends FeatureEnabledReasonOneOf {
|
|
787
764
|
/** Information about a transfer from another account. */
|
|
788
765
|
transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
|
|
789
766
|
/** Information about a transfer from another site. */
|
|
@@ -814,7 +791,7 @@ export interface FeatureEnabled extends FeatureEnabledReasonOneOf {
|
|
|
814
791
|
reassignedFromMetasite?: string | null;
|
|
815
792
|
}
|
|
816
793
|
/** @oneof */
|
|
817
|
-
|
|
794
|
+
interface FeatureEnabledReasonOneOf {
|
|
818
795
|
/** Information about a transfer from another account. */
|
|
819
796
|
transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
|
|
820
797
|
/** Information about a transfer from another site. */
|
|
@@ -830,7 +807,7 @@ export interface FeatureEnabledReasonOneOf {
|
|
|
830
807
|
/** Information about a feature that was migrated from legacy. */
|
|
831
808
|
migratedFromLegacy?: MigratedFromLegacyReason;
|
|
832
809
|
}
|
|
833
|
-
|
|
810
|
+
interface Feature extends FeatureQuantityInfoOneOf {
|
|
834
811
|
/**
|
|
835
812
|
* Deprecated. Use `enabled` instead.
|
|
836
813
|
* @deprecated
|
|
@@ -847,7 +824,7 @@ export interface Feature extends FeatureQuantityInfoOneOf {
|
|
|
847
824
|
* `{"id": "DEFAULT"}`. Use `uniqueName` as unique identifier for a feature.
|
|
848
825
|
* @readonly
|
|
849
826
|
*/
|
|
850
|
-
|
|
827
|
+
_id?: string;
|
|
851
828
|
/**
|
|
852
829
|
* Unique name of the feature. Only lower case letters, numbers, and dashes
|
|
853
830
|
* `-` are supported. Used in the endpoints of the
|
|
@@ -911,7 +888,7 @@ export interface Feature extends FeatureQuantityInfoOneOf {
|
|
|
911
888
|
metadata?: Record<string, string>;
|
|
912
889
|
}
|
|
913
890
|
/** @oneof */
|
|
914
|
-
|
|
891
|
+
interface FeatureQuantityInfoOneOf {
|
|
915
892
|
/**
|
|
916
893
|
* Deprecated. Use `enabled` instead.
|
|
917
894
|
* @deprecated
|
|
@@ -928,7 +905,7 @@ export interface FeatureQuantityInfoOneOf {
|
|
|
928
905
|
* Note: Do not confuse with feature scope which is configured in the product catalog
|
|
929
906
|
* and defines in which context the product can be used
|
|
930
907
|
*/
|
|
931
|
-
|
|
908
|
+
interface FeatureContext {
|
|
932
909
|
/**
|
|
933
910
|
* ID of the Wix account that the feature instance belongs to.
|
|
934
911
|
* Available for both site and account level feature instances.
|
|
@@ -948,10 +925,10 @@ export interface FeatureContext {
|
|
|
948
925
|
* 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).
|
|
949
926
|
* A boolean feature is similar to a quantitive feature with a default limit of 0 and UNLIMITED premium limit (although a bit simplified).
|
|
950
927
|
*/
|
|
951
|
-
|
|
928
|
+
interface BooleanFeature {
|
|
952
929
|
}
|
|
953
930
|
/** 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. */
|
|
954
|
-
|
|
931
|
+
interface QuotaFeature {
|
|
955
932
|
/** Default (or Freemium) quota limitation. if left undefined the free feature has unlimited amount. */
|
|
956
933
|
limit?: string | null;
|
|
957
934
|
/** Periodic time-frame to reset the usage counter. You may use NO_PERIOD if counter shouldn't be reset. */
|
|
@@ -960,7 +937,7 @@ export interface QuotaFeature {
|
|
|
960
937
|
units?: string | null;
|
|
961
938
|
}
|
|
962
939
|
/** Determines the reset cycle of the feature usage. */
|
|
963
|
-
|
|
940
|
+
declare enum FeaturePeriod {
|
|
964
941
|
NO_PERIOD = "NO_PERIOD",
|
|
965
942
|
MILLISECOND = "MILLISECOND",
|
|
966
943
|
SECOND = "SECOND",
|
|
@@ -971,7 +948,7 @@ export declare enum FeaturePeriod {
|
|
|
971
948
|
MONTH = "MONTH",
|
|
972
949
|
YEAR = "YEAR"
|
|
973
950
|
}
|
|
974
|
-
|
|
951
|
+
interface QuotaInfo {
|
|
975
952
|
/**
|
|
976
953
|
* How often the customer is allowed to use the feature during the specified
|
|
977
954
|
* period. `null` means that the customer has unlimited access to the feature.
|
|
@@ -996,7 +973,7 @@ export interface QuotaInfo {
|
|
|
996
973
|
remainingUsage?: string | null;
|
|
997
974
|
}
|
|
998
975
|
/** Subscription transferred from another account, features on the current account were enabled. */
|
|
999
|
-
|
|
976
|
+
interface TransferredFromAnotherAccountReason {
|
|
1000
977
|
/**
|
|
1001
978
|
* Information about a transfer from another account.
|
|
1002
979
|
* @format GUID
|
|
@@ -1004,7 +981,7 @@ export interface TransferredFromAnotherAccountReason {
|
|
|
1004
981
|
transferredFromAccount?: string;
|
|
1005
982
|
}
|
|
1006
983
|
/** Subscription moved from one site to another in the same account, features enabled on the target site */
|
|
1007
|
-
|
|
984
|
+
interface ReassignedFromSiteReason {
|
|
1008
985
|
/**
|
|
1009
986
|
* Information about a transfer from another site.
|
|
1010
987
|
* @format GUID
|
|
@@ -1012,22 +989,22 @@ export interface ReassignedFromSiteReason {
|
|
|
1012
989
|
reassignedFromMetasite?: string;
|
|
1013
990
|
}
|
|
1014
991
|
/** Subscription was floating and assigned to site, features enabled on the target site */
|
|
1015
|
-
|
|
992
|
+
interface AssignedFromFloatingReason {
|
|
1016
993
|
}
|
|
1017
994
|
/** New subscription created and features created as enabled */
|
|
1018
|
-
|
|
995
|
+
interface NewFeatureReason {
|
|
1019
996
|
}
|
|
1020
997
|
/** Subscription was upgraded or downgraded, as a result new features enabled, missing features disabled , quantities are updated */
|
|
1021
|
-
|
|
998
|
+
interface ContractSwitchedReason {
|
|
1022
999
|
}
|
|
1023
1000
|
/** a call to CreateFeature in features-writer, creates feature that is not attached to subscription */
|
|
1024
|
-
|
|
1001
|
+
interface ManualFeatureCreationReason {
|
|
1025
1002
|
}
|
|
1026
1003
|
/** Subscription created due to migration from old premium model */
|
|
1027
|
-
|
|
1004
|
+
interface MigratedFromLegacyReason {
|
|
1028
1005
|
}
|
|
1029
1006
|
/** Feature disabled and can be enabled in the future */
|
|
1030
|
-
|
|
1007
|
+
interface FeatureDisabled extends FeatureDisabledReasonOneOf {
|
|
1031
1008
|
/** Information about a feature that's no longer assigned to a site. */
|
|
1032
1009
|
unassingedToFloating?: UnAssingedToFloatingReason;
|
|
1033
1010
|
/**
|
|
@@ -1052,7 +1029,7 @@ export interface FeatureDisabled extends FeatureDisabledReasonOneOf {
|
|
|
1052
1029
|
metaSiteId?: string | null;
|
|
1053
1030
|
}
|
|
1054
1031
|
/** @oneof */
|
|
1055
|
-
|
|
1032
|
+
interface FeatureDisabledReasonOneOf {
|
|
1056
1033
|
/** Information about a feature that's no longer assigned to a site. */
|
|
1057
1034
|
unassingedToFloating?: UnAssingedToFloatingReason;
|
|
1058
1035
|
/**
|
|
@@ -1067,13 +1044,13 @@ export interface FeatureDisabledReasonOneOf {
|
|
|
1067
1044
|
reassignedToAnotherSite?: ReassignedToAnotherSiteReason;
|
|
1068
1045
|
}
|
|
1069
1046
|
/** Subscription was unassigned from the site and moved into floating state */
|
|
1070
|
-
|
|
1047
|
+
interface UnAssingedToFloatingReason {
|
|
1071
1048
|
}
|
|
1072
1049
|
/** Another subscription was assigned to the site, causing existing features on this site to be disabled */
|
|
1073
|
-
|
|
1050
|
+
interface ReplacedByAnotherSubscriptionReason {
|
|
1074
1051
|
}
|
|
1075
1052
|
/** Subscription was assigned to another site, causing features on the origin site to be disabled. */
|
|
1076
|
-
|
|
1053
|
+
interface ReassignedToAnotherSiteReason {
|
|
1077
1054
|
/**
|
|
1078
1055
|
* Information about a transfer to the site.
|
|
1079
1056
|
* @format GUID
|
|
@@ -1081,7 +1058,7 @@ export interface ReassignedToAnotherSiteReason {
|
|
|
1081
1058
|
reassignedToMetasite?: string;
|
|
1082
1059
|
}
|
|
1083
1060
|
/** Feature updated, for example Quota was increased due to upgrade */
|
|
1084
|
-
|
|
1061
|
+
interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf, FeatureUpdatedReasonOneOf {
|
|
1085
1062
|
/** Information about a feature that doesn't have a usage quota. */
|
|
1086
1063
|
booleanFeature?: BooleanFeature;
|
|
1087
1064
|
/** Information about a feature that has a usage quota. */
|
|
@@ -1095,19 +1072,19 @@ export interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf,
|
|
|
1095
1072
|
feature?: Feature;
|
|
1096
1073
|
}
|
|
1097
1074
|
/** @oneof */
|
|
1098
|
-
|
|
1075
|
+
interface FeatureUpdatedPreviousQuantityInfoOneOf {
|
|
1099
1076
|
/** Information about a feature that doesn't have a usage quota. */
|
|
1100
1077
|
booleanFeature?: BooleanFeature;
|
|
1101
1078
|
/** Information about a feature that has a usage quota. */
|
|
1102
1079
|
quotaFeature?: QuotaFeature;
|
|
1103
1080
|
}
|
|
1104
1081
|
/** @oneof */
|
|
1105
|
-
|
|
1082
|
+
interface FeatureUpdatedReasonOneOf {
|
|
1106
1083
|
/** Information about the contract switch. */
|
|
1107
1084
|
contractSwitched?: ContractSwitchedReason;
|
|
1108
1085
|
}
|
|
1109
1086
|
/** Feature was permanently cancelled */
|
|
1110
|
-
|
|
1087
|
+
interface FeatureCancelled extends FeatureCancelledReasonOneOf {
|
|
1111
1088
|
/** Information about a transfer to the account. */
|
|
1112
1089
|
transferredToAnotherAccount?: TransferredToAnotherAccountReason;
|
|
1113
1090
|
/** Information about the contract switch. */
|
|
@@ -1124,7 +1101,7 @@ export interface FeatureCancelled extends FeatureCancelledReasonOneOf {
|
|
|
1124
1101
|
transferredToAccount?: string | null;
|
|
1125
1102
|
}
|
|
1126
1103
|
/** @oneof */
|
|
1127
|
-
|
|
1104
|
+
interface FeatureCancelledReasonOneOf {
|
|
1128
1105
|
/** Information about a transfer to the account. */
|
|
1129
1106
|
transferredToAnotherAccount?: TransferredToAnotherAccountReason;
|
|
1130
1107
|
/** Information about the contract switch. */
|
|
@@ -1133,7 +1110,7 @@ export interface FeatureCancelledReasonOneOf {
|
|
|
1133
1110
|
cancelRequest?: CancelRequestedReason;
|
|
1134
1111
|
}
|
|
1135
1112
|
/** Subscription was transferred to another account, features in the origin account were cancelled */
|
|
1136
|
-
|
|
1113
|
+
interface TransferredToAnotherAccountReason {
|
|
1137
1114
|
/**
|
|
1138
1115
|
* Information about a transfer to the account.
|
|
1139
1116
|
* @format GUID
|
|
@@ -1141,9 +1118,9 @@ export interface TransferredToAnotherAccountReason {
|
|
|
1141
1118
|
transferredToAccount?: string;
|
|
1142
1119
|
}
|
|
1143
1120
|
/** Cancellation was requested from the subscription manager api, might be a result of billing event, or direct call */
|
|
1144
|
-
|
|
1121
|
+
interface CancelRequestedReason {
|
|
1145
1122
|
}
|
|
1146
|
-
|
|
1123
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1147
1124
|
createdEvent?: EntityCreatedEvent;
|
|
1148
1125
|
updatedEvent?: EntityUpdatedEvent;
|
|
1149
1126
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1152,7 +1129,7 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1152
1129
|
* Unique event ID.
|
|
1153
1130
|
* Allows clients to ignore duplicate webhooks.
|
|
1154
1131
|
*/
|
|
1155
|
-
|
|
1132
|
+
_id?: string;
|
|
1156
1133
|
/**
|
|
1157
1134
|
* Assumes actions are also always typed to an entity_type
|
|
1158
1135
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -1186,36 +1163,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1186
1163
|
entityEventSequence?: string | null;
|
|
1187
1164
|
}
|
|
1188
1165
|
/** @oneof */
|
|
1189
|
-
|
|
1166
|
+
interface DomainEventBodyOneOf {
|
|
1190
1167
|
createdEvent?: EntityCreatedEvent;
|
|
1191
1168
|
updatedEvent?: EntityUpdatedEvent;
|
|
1192
1169
|
deletedEvent?: EntityDeletedEvent;
|
|
1193
1170
|
actionEvent?: ActionEvent;
|
|
1194
1171
|
}
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1198
|
-
restoreInfo?: RestoreInfo;
|
|
1172
|
+
interface EntityCreatedEvent {
|
|
1173
|
+
entity?: string;
|
|
1199
1174
|
}
|
|
1200
|
-
|
|
1175
|
+
interface RestoreInfo {
|
|
1201
1176
|
deletedDate?: Date | null;
|
|
1202
1177
|
}
|
|
1203
|
-
|
|
1178
|
+
interface EntityUpdatedEvent {
|
|
1204
1179
|
/**
|
|
1205
1180
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1206
1181
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1207
1182
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1208
1183
|
*/
|
|
1209
|
-
|
|
1184
|
+
currentEntity?: string;
|
|
1210
1185
|
}
|
|
1211
|
-
|
|
1186
|
+
interface EntityDeletedEvent {
|
|
1212
1187
|
/** Entity that was deleted */
|
|
1213
|
-
|
|
1188
|
+
deletedEntity?: string | null;
|
|
1214
1189
|
}
|
|
1215
|
-
|
|
1216
|
-
|
|
1190
|
+
interface ActionEvent {
|
|
1191
|
+
body?: string;
|
|
1217
1192
|
}
|
|
1218
|
-
|
|
1193
|
+
interface MessageEnvelope {
|
|
1219
1194
|
/**
|
|
1220
1195
|
* App instance ID.
|
|
1221
1196
|
* @format GUID
|
|
@@ -1231,7 +1206,7 @@ export interface MessageEnvelope {
|
|
|
1231
1206
|
/** Stringify payload. */
|
|
1232
1207
|
data?: string;
|
|
1233
1208
|
}
|
|
1234
|
-
|
|
1209
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1235
1210
|
/**
|
|
1236
1211
|
* ID of a site visitor that has not logged in to the site.
|
|
1237
1212
|
* @format GUID
|
|
@@ -1256,7 +1231,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1256
1231
|
identityType?: WebhookIdentityType;
|
|
1257
1232
|
}
|
|
1258
1233
|
/** @oneof */
|
|
1259
|
-
|
|
1234
|
+
interface IdentificationDataIdOneOf {
|
|
1260
1235
|
/**
|
|
1261
1236
|
* ID of a site visitor that has not logged in to the site.
|
|
1262
1237
|
* @format GUID
|
|
@@ -1278,80 +1253,68 @@ export interface IdentificationDataIdOneOf {
|
|
|
1278
1253
|
*/
|
|
1279
1254
|
appId?: string;
|
|
1280
1255
|
}
|
|
1281
|
-
|
|
1256
|
+
declare enum WebhookIdentityType {
|
|
1282
1257
|
UNKNOWN = "UNKNOWN",
|
|
1283
1258
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1284
1259
|
MEMBER = "MEMBER",
|
|
1285
1260
|
WIX_USER = "WIX_USER",
|
|
1286
1261
|
APP = "APP"
|
|
1287
1262
|
}
|
|
1288
|
-
interface
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
}
|
|
1302
|
-
interface PointsExpirationNonNullableFields {
|
|
1303
|
-
status: Status;
|
|
1304
|
-
monthsOfInactivity: number;
|
|
1305
|
-
expiringPointsPercentage: number;
|
|
1306
|
-
}
|
|
1307
|
-
interface PremiumFeaturesNonNullableFields {
|
|
1308
|
-
loyaltyProgram: boolean;
|
|
1309
|
-
tiers: boolean;
|
|
1310
|
-
pointsExpiration: boolean;
|
|
1311
|
-
}
|
|
1312
|
-
interface SocialMediaChannelNonNullableFields {
|
|
1313
|
-
type: Type;
|
|
1314
|
-
enabled: boolean;
|
|
1315
|
-
id: string;
|
|
1316
|
-
}
|
|
1317
|
-
interface SocialMediaSettingsNonNullableFields {
|
|
1318
|
-
channels: SocialMediaChannelNonNullableFields[];
|
|
1319
|
-
}
|
|
1320
|
-
interface LoyaltyProgramNonNullableFields {
|
|
1321
|
-
pointDefinition?: PointDefinitionNonNullableFields;
|
|
1322
|
-
status: ProgramStatus;
|
|
1323
|
-
pointsExpiration?: PointsExpirationNonNullableFields;
|
|
1324
|
-
premiumFeatures?: PremiumFeaturesNonNullableFields;
|
|
1325
|
-
socialMediaSettings?: SocialMediaSettingsNonNullableFields;
|
|
1326
|
-
}
|
|
1327
|
-
export interface GetLoyaltyProgramResponseNonNullableFields {
|
|
1328
|
-
loyaltyProgram?: LoyaltyProgramNonNullableFields;
|
|
1329
|
-
}
|
|
1330
|
-
interface ProgramInSiteNonNullableFields {
|
|
1331
|
-
metaSiteId: string;
|
|
1332
|
-
loyaltyProgram?: LoyaltyProgramNonNullableFields;
|
|
1333
|
-
}
|
|
1334
|
-
export interface BulkGetLoyaltyProgramResponseNonNullableFields {
|
|
1335
|
-
programInSites: ProgramInSiteNonNullableFields[];
|
|
1336
|
-
}
|
|
1337
|
-
export interface UpdateLoyaltyProgramResponseNonNullableFields {
|
|
1338
|
-
loyaltyProgram?: LoyaltyProgramNonNullableFields;
|
|
1339
|
-
}
|
|
1340
|
-
export interface ActivateLoyaltyProgramResponseNonNullableFields {
|
|
1341
|
-
loyaltyProgram?: LoyaltyProgramNonNullableFields;
|
|
1342
|
-
}
|
|
1343
|
-
export interface PauseLoyaltyProgramResponseNonNullableFields {
|
|
1344
|
-
loyaltyProgram?: LoyaltyProgramNonNullableFields;
|
|
1345
|
-
}
|
|
1346
|
-
export interface GetLoyaltyProgramPremiumFeaturesResponseNonNullableFields {
|
|
1347
|
-
loyaltyProgram: boolean;
|
|
1348
|
-
tiers: boolean;
|
|
1349
|
-
pointsExpiration: boolean;
|
|
1263
|
+
interface BaseEventMetadata {
|
|
1264
|
+
/**
|
|
1265
|
+
* App instance ID.
|
|
1266
|
+
* @format GUID
|
|
1267
|
+
*/
|
|
1268
|
+
instanceId?: string | null;
|
|
1269
|
+
/**
|
|
1270
|
+
* Event type.
|
|
1271
|
+
* @maxLength 150
|
|
1272
|
+
*/
|
|
1273
|
+
eventType?: string;
|
|
1274
|
+
/** The identification type and identity data. */
|
|
1275
|
+
identity?: IdentificationData;
|
|
1350
1276
|
}
|
|
1351
|
-
|
|
1352
|
-
|
|
1277
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1278
|
+
/**
|
|
1279
|
+
* Unique event ID.
|
|
1280
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1281
|
+
*/
|
|
1282
|
+
_id?: string;
|
|
1283
|
+
/**
|
|
1284
|
+
* Assumes actions are also always typed to an entity_type
|
|
1285
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1286
|
+
*/
|
|
1287
|
+
entityFqdn?: string;
|
|
1288
|
+
/**
|
|
1289
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1290
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1291
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1292
|
+
*/
|
|
1293
|
+
slug?: string;
|
|
1294
|
+
/** ID of the entity associated with the event. */
|
|
1295
|
+
entityId?: string;
|
|
1296
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1297
|
+
eventTime?: Date | null;
|
|
1298
|
+
/**
|
|
1299
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1300
|
+
* (for example, GDPR).
|
|
1301
|
+
*/
|
|
1302
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1303
|
+
/** If present, indicates the action that triggered the event. */
|
|
1304
|
+
originatedFrom?: string | null;
|
|
1305
|
+
/**
|
|
1306
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1307
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1308
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1309
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1310
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1311
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1312
|
+
*/
|
|
1313
|
+
entityEventSequence?: string | null;
|
|
1353
1314
|
}
|
|
1354
|
-
|
|
1355
|
-
|
|
1315
|
+
interface ProgramUpdatedEnvelope {
|
|
1316
|
+
entity: LoyaltyProgram;
|
|
1317
|
+
metadata: EventMetadata;
|
|
1356
1318
|
}
|
|
1357
|
-
|
|
1319
|
+
|
|
1320
|
+
export { type SiteMarkedAsTemplate as $, type ActivateLoyaltyProgramResponse as A, type BulkGetLoyaltyProgramResponse as B, type EnablePointsExpirationRequest as C, type DisablePointsExpirationResponse as D, type EnablePointsExpirationResponse as E, FeaturePeriod as F, type GetLoyaltyProgramResponse as G, type PointsExpirationEnabled as H, type DisablePointsExpirationRequest as I, type PointsExpirationDisabled as J, type MetaSiteSpecialEventPayloadOneOf as K, type LoyaltyProgram as L, type MetaSiteSpecialEvent as M, Namespace as N, type Asset as O, type PauseLoyaltyProgramResponse as P, type SiteCreated as Q, type SiteTransferred as R, Status as S, Type as T, type UpdateLoyaltyProgramResponse as U, type SiteDeleted as V, WebhookIdentityType as W, type DeleteContext as X, type SiteUndeleted as Y, type SitePublished as Z, type SiteUnpublished as _, type GetLoyaltyProgramPremiumFeaturesResponse as a, type SiteMarkedAsWixSite as a0, type ServiceProvisioned as a1, type ServiceRemoved as a2, type SiteRenamed as a3, type SiteHardDeleted as a4, type NamespaceChanged as a5, type StudioAssigned as a6, type StudioUnassigned as a7, type SiteUrlChanged as a8, type SitePurgedExternally as a9, type FeatureCancelled as aA, type FeatureCancelledReasonOneOf as aB, type TransferredToAnotherAccountReason as aC, type CancelRequestedReason as aD, type DomainEvent as aE, type DomainEventBodyOneOf as aF, type EntityCreatedEvent as aG, type RestoreInfo as aH, type EntityUpdatedEvent as aI, type EntityDeletedEvent as aJ, type ActionEvent as aK, type MessageEnvelope as aL, type IdentificationData as aM, type IdentificationDataIdOneOf as aN, type BaseEventMetadata as aO, type EventMetadata as aP, type ProgramUpdatedEnvelope as aQ, type Empty as aa, type FeatureEvent as ab, type FeatureEventEventOneOf as ac, type FeatureEnabled as ad, type FeatureEnabledReasonOneOf as ae, type Feature as af, type FeatureQuantityInfoOneOf as ag, type FeatureContext as ah, type BooleanFeature as ai, type QuotaFeature as aj, type QuotaInfo as ak, type TransferredFromAnotherAccountReason as al, type ReassignedFromSiteReason as am, type AssignedFromFloatingReason as an, type NewFeatureReason as ao, type ContractSwitchedReason as ap, type ManualFeatureCreationReason as aq, type MigratedFromLegacyReason as ar, type FeatureDisabled as as, type FeatureDisabledReasonOneOf as at, type UnAssingedToFloatingReason as au, type ReplacedByAnotherSubscriptionReason as av, type ReassignedToAnotherSiteReason as aw, type FeatureUpdated as ax, type FeatureUpdatedPreviousQuantityInfoOneOf as ay, type FeatureUpdatedReasonOneOf as az, ProgramStatus as b, State as c, SiteCreatedContext as d, DeleteStatus as e, type PointDefinition as f, type FocalPoint as g, type PointsExpiration as h, type PremiumFeatures as i, type SocialMediaSettings as j, type SocialMediaChannel as k, type GetLoyaltyProgramRequest as l, type BulkGetLoyaltyProgramRequest as m, type ProgramInSite as n, type UpdateLoyaltyProgramRequest as o, type PointsExpirationConfigurationChanged as p, type PointsExpirationChanges as q, type ActivateLoyaltyProgramRequest as r, type LoyaltyProgramActivated as s, type PauseLoyaltyProgramRequest as t, type GetLoyaltyProgramDescriptionRequest as u, type GetLoyaltyProgramDescriptionResponse as v, type UpdateLoyaltyProgramDescriptionRequest as w, type UpdateLoyaltyProgramDescriptionResponse as x, type LoyaltyProgramDescriptionUpdated as y, type GetLoyaltyProgramPremiumFeaturesRequest as z };
|