@wix/auto_sdk_loyalty_programs 1.0.16 → 1.0.18
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 +1 -0
- package/build/cjs/index.js +18 -0
- package/build/cjs/index.js.map +1 -0
- package/build/cjs/index.typings.d.ts +1 -0
- package/build/cjs/index.typings.js +18 -0
- package/build/cjs/index.typings.js.map +1 -0
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +18 -0
- package/build/cjs/meta.js.map +1 -0
- package/build/cjs/src/loyalty-v1-program-programs.context.d.ts +18 -0
- package/build/cjs/src/loyalty-v1-program-programs.context.js +30 -0
- package/build/cjs/src/loyalty-v1-program-programs.context.js.map +1 -0
- package/build/cjs/src/loyalty-v1-program-programs.http.d.ts +49 -0
- package/build/cjs/src/loyalty-v1-program-programs.http.js +417 -0
- package/build/cjs/src/loyalty-v1-program-programs.http.js.map +1 -0
- package/build/cjs/src/loyalty-v1-program-programs.meta.d.ts +20 -0
- package/build/cjs/src/loyalty-v1-program-programs.meta.js +180 -0
- package/build/cjs/src/loyalty-v1-program-programs.meta.js.map +1 -0
- package/build/cjs/src/loyalty-v1-program-programs.public.d.ts +88 -0
- package/build/cjs/src/loyalty-v1-program-programs.public.js +83 -0
- package/build/cjs/src/loyalty-v1-program-programs.public.js.map +1 -0
- package/build/{loyalty-v1-program-programs.universal-CCZ90Kwf.d.ts → cjs/src/loyalty-v1-program-programs.types.d.ts} +176 -175
- package/build/cjs/src/loyalty-v1-program-programs.types.js +174 -0
- package/build/cjs/src/loyalty-v1-program-programs.types.js.map +1 -0
- package/build/cjs/src/loyalty-v1-program-programs.universal.d.ts +1508 -0
- package/build/cjs/src/loyalty-v1-program-programs.universal.js +537 -0
- package/build/cjs/src/loyalty-v1-program-programs.universal.js.map +1 -0
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +2 -0
- package/build/es/index.js.map +1 -0
- package/build/es/index.typings.d.ts +1 -0
- package/build/es/index.typings.js +2 -0
- package/build/es/index.typings.js.map +1 -0
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +2 -0
- package/build/es/meta.js.map +1 -0
- package/build/es/package.json +3 -0
- package/build/es/src/loyalty-v1-program-programs.context.d.ts +18 -0
- package/build/es/src/loyalty-v1-program-programs.context.js +18 -0
- package/build/es/src/loyalty-v1-program-programs.context.js.map +1 -0
- package/build/es/src/loyalty-v1-program-programs.http.d.ts +49 -0
- package/build/es/src/loyalty-v1-program-programs.http.js +406 -0
- package/build/es/src/loyalty-v1-program-programs.http.js.map +1 -0
- package/build/es/src/loyalty-v1-program-programs.meta.d.ts +20 -0
- package/build/es/src/loyalty-v1-program-programs.meta.js +146 -0
- package/build/es/src/loyalty-v1-program-programs.meta.js.map +1 -0
- package/build/es/src/loyalty-v1-program-programs.public.d.ts +88 -0
- package/build/es/src/loyalty-v1-program-programs.public.js +63 -0
- package/build/es/src/loyalty-v1-program-programs.public.js.map +1 -0
- package/build/{internal/loyalty-v1-program-programs.universal-CCZ90Kwf.d.mts → es/src/loyalty-v1-program-programs.types.d.ts} +176 -175
- package/build/es/src/loyalty-v1-program-programs.types.js +171 -0
- package/build/es/src/loyalty-v1-program-programs.types.js.map +1 -0
- package/build/es/src/loyalty-v1-program-programs.universal.d.ts +1508 -0
- package/build/es/src/loyalty-v1-program-programs.universal.js +503 -0
- package/build/es/src/loyalty-v1-program-programs.universal.js.map +1 -0
- package/build/internal/cjs/index.d.ts +1 -0
- package/build/internal/cjs/index.js +18 -0
- package/build/internal/cjs/index.js.map +1 -0
- package/build/internal/cjs/index.typings.d.ts +1 -0
- package/build/internal/cjs/index.typings.js +18 -0
- package/build/internal/cjs/index.typings.js.map +1 -0
- package/build/internal/cjs/meta.d.ts +1 -0
- package/build/internal/cjs/meta.js +18 -0
- package/build/internal/cjs/meta.js.map +1 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.context.d.ts +18 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.context.js +30 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.context.js.map +1 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.http.d.ts +49 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.http.js +417 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.http.js.map +1 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.meta.d.ts +20 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.meta.js +180 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.meta.js.map +1 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.public.d.ts +88 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.public.js +83 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.public.js.map +1 -0
- package/build/internal/{loyalty-v1-program-programs.universal-CCZ90Kwf.d.ts → cjs/src/loyalty-v1-program-programs.types.d.ts} +176 -175
- package/build/internal/cjs/src/loyalty-v1-program-programs.types.js +174 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.types.js.map +1 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.universal.d.ts +1508 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.universal.js +537 -0
- package/build/internal/cjs/src/loyalty-v1-program-programs.universal.js.map +1 -0
- package/build/internal/es/index.d.ts +1 -0
- package/build/internal/es/index.js +2 -0
- package/build/internal/es/index.js.map +1 -0
- package/build/internal/es/index.typings.d.ts +1 -0
- package/build/internal/es/index.typings.js +2 -0
- package/build/internal/es/index.typings.js.map +1 -0
- package/build/internal/es/meta.d.ts +1 -0
- package/build/internal/es/meta.js +2 -0
- package/build/internal/es/meta.js.map +1 -0
- package/build/internal/es/src/loyalty-v1-program-programs.context.d.ts +18 -0
- package/build/internal/es/src/loyalty-v1-program-programs.context.js +18 -0
- package/build/internal/es/src/loyalty-v1-program-programs.context.js.map +1 -0
- package/build/internal/es/src/loyalty-v1-program-programs.http.d.ts +49 -0
- package/build/internal/es/src/loyalty-v1-program-programs.http.js +406 -0
- package/build/internal/es/src/loyalty-v1-program-programs.http.js.map +1 -0
- package/build/internal/es/src/loyalty-v1-program-programs.meta.d.ts +20 -0
- package/build/internal/es/src/loyalty-v1-program-programs.meta.js +146 -0
- package/build/internal/es/src/loyalty-v1-program-programs.meta.js.map +1 -0
- package/build/internal/es/src/loyalty-v1-program-programs.public.d.ts +88 -0
- package/build/internal/es/src/loyalty-v1-program-programs.public.js +63 -0
- package/build/internal/es/src/loyalty-v1-program-programs.public.js.map +1 -0
- package/build/{loyalty-v1-program-programs.universal-CCZ90Kwf.d.mts → internal/es/src/loyalty-v1-program-programs.types.d.ts} +176 -175
- package/build/internal/es/src/loyalty-v1-program-programs.types.js +171 -0
- package/build/internal/es/src/loyalty-v1-program-programs.types.js.map +1 -0
- package/build/internal/es/src/loyalty-v1-program-programs.universal.d.ts +1508 -0
- package/build/internal/es/src/loyalty-v1-program-programs.universal.js +503 -0
- package/build/internal/es/src/loyalty-v1-program-programs.universal.js.map +1 -0
- package/package.json +13 -14
- package/build/index.d.mts +0 -101
- package/build/index.d.ts +0 -101
- package/build/index.js +0 -874
- package/build/index.js.map +0 -1
- package/build/index.mjs +0 -833
- package/build/index.mjs.map +0 -1
- package/build/internal/index.d.mts +0 -101
- package/build/internal/index.d.ts +0 -101
- package/build/internal/index.js +0 -874
- package/build/internal/index.js.map +0 -1
- package/build/internal/index.mjs +0 -833
- package/build/internal/index.mjs.map +0 -1
- package/build/internal/meta.d.mts +0 -226
- package/build/internal/meta.d.ts +0 -226
- package/build/internal/meta.js +0 -557
- package/build/internal/meta.js.map +0 -1
- package/build/internal/meta.mjs +0 -523
- package/build/internal/meta.mjs.map +0 -1
- package/build/meta.d.mts +0 -226
- package/build/meta.d.ts +0 -226
- package/build/meta.js +0 -557
- package/build/meta.js.map +0 -1
- package/build/meta.mjs +0 -523
- package/build/meta.mjs.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
|
-
interface LoyaltyProgram {
|
|
6
|
+
export 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
|
+
/** Details about the program's collectible unit. */
|
|
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 @@ 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 @@ interface LoyaltyProgram {
|
|
|
37
37
|
*/
|
|
38
38
|
premiumFeatures?: PremiumFeatures;
|
|
39
39
|
}
|
|
40
|
-
interface PointDefinition {
|
|
40
|
+
export interface PointDefinition {
|
|
41
41
|
/**
|
|
42
42
|
* Display name for the program's collectible unit.
|
|
43
43
|
*
|
|
@@ -49,10 +49,33 @@ interface PointDefinition {
|
|
|
49
49
|
* @maxLength 20
|
|
50
50
|
*/
|
|
51
51
|
customName?: string | null;
|
|
52
|
-
/**
|
|
53
|
-
icon?:
|
|
52
|
+
/** Details about the points icon. */
|
|
53
|
+
icon?: Image;
|
|
54
54
|
}
|
|
55
|
-
interface
|
|
55
|
+
export interface Image {
|
|
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 {
|
|
56
79
|
/** X-coordinate of the focal point. */
|
|
57
80
|
x?: number;
|
|
58
81
|
/** Y-coordinate of the focal point. */
|
|
@@ -62,7 +85,7 @@ interface FocalPoint {
|
|
|
62
85
|
/** crop by width */
|
|
63
86
|
width?: number | null;
|
|
64
87
|
}
|
|
65
|
-
declare enum ProgramStatus {
|
|
88
|
+
export declare enum ProgramStatus {
|
|
66
89
|
/** Unknown program status. */
|
|
67
90
|
UNKNOWN = "UNKNOWN",
|
|
68
91
|
/** Program was created but is not enabled yet. */
|
|
@@ -72,7 +95,7 @@ declare enum ProgramStatus {
|
|
|
72
95
|
/** Program was manually disabled by the user. This action can be reverted, meaning the user can set it to be active again. */
|
|
73
96
|
PAUSED = "PAUSED"
|
|
74
97
|
}
|
|
75
|
-
interface PointsExpiration {
|
|
98
|
+
export interface PointsExpiration {
|
|
76
99
|
/**
|
|
77
100
|
* Status of the points expiration feature.
|
|
78
101
|
* @readonly
|
|
@@ -91,7 +114,7 @@ interface PointsExpiration {
|
|
|
91
114
|
*/
|
|
92
115
|
expiringPointsPercentage?: number;
|
|
93
116
|
}
|
|
94
|
-
declare enum Status {
|
|
117
|
+
export declare enum Status {
|
|
95
118
|
/** Unknown points expiration status. This value is not used. */
|
|
96
119
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
97
120
|
/** Points expiration feature is disabled. */
|
|
@@ -99,7 +122,7 @@ declare enum Status {
|
|
|
99
122
|
/** Points expiration feature is enabled. */
|
|
100
123
|
ENABLED = "ENABLED"
|
|
101
124
|
}
|
|
102
|
-
interface PremiumFeatures {
|
|
125
|
+
export interface PremiumFeatures {
|
|
103
126
|
/**
|
|
104
127
|
* Whether there are any loyalty program premium features.
|
|
105
128
|
* @readonly
|
|
@@ -116,14 +139,14 @@ interface PremiumFeatures {
|
|
|
116
139
|
*/
|
|
117
140
|
pointsExpiration?: boolean;
|
|
118
141
|
}
|
|
119
|
-
interface SocialMediaSettings {
|
|
142
|
+
export interface SocialMediaSettings {
|
|
120
143
|
/**
|
|
121
144
|
* List of social media channels
|
|
122
145
|
* @maxSize 5
|
|
123
146
|
*/
|
|
124
147
|
channels?: SocialMediaChannel[];
|
|
125
148
|
}
|
|
126
|
-
interface SocialMediaChannel {
|
|
149
|
+
export interface SocialMediaChannel {
|
|
127
150
|
/** Social media channel type */
|
|
128
151
|
type?: Type;
|
|
129
152
|
/** Enable or disable social media channel */
|
|
@@ -133,7 +156,7 @@ interface SocialMediaChannel {
|
|
|
133
156
|
* @minLength 1
|
|
134
157
|
* @maxLength 255
|
|
135
158
|
*/
|
|
136
|
-
|
|
159
|
+
id?: string;
|
|
137
160
|
/**
|
|
138
161
|
* Social media channel URL
|
|
139
162
|
* @readonly
|
|
@@ -141,7 +164,7 @@ interface SocialMediaChannel {
|
|
|
141
164
|
*/
|
|
142
165
|
url?: string | null;
|
|
143
166
|
}
|
|
144
|
-
declare enum Type {
|
|
167
|
+
export declare enum Type {
|
|
145
168
|
/** Unknown social media channel type. */
|
|
146
169
|
UNKNOWN_CHANNEL = "UNKNOWN_CHANNEL",
|
|
147
170
|
/** Facebook social media channel. */
|
|
@@ -155,19 +178,19 @@ declare enum Type {
|
|
|
155
178
|
/** TikTok social media channel. */
|
|
156
179
|
TIKTOK = "TIKTOK"
|
|
157
180
|
}
|
|
158
|
-
interface GetLoyaltyProgramRequest {
|
|
181
|
+
export interface GetLoyaltyProgramRequest {
|
|
159
182
|
}
|
|
160
|
-
interface GetLoyaltyProgramResponse {
|
|
183
|
+
export interface GetLoyaltyProgramResponse {
|
|
161
184
|
/** Retrieved loyalty program. */
|
|
162
185
|
loyaltyProgram?: LoyaltyProgram;
|
|
163
186
|
}
|
|
164
|
-
interface BulkGetLoyaltyProgramRequest {
|
|
187
|
+
export interface BulkGetLoyaltyProgramRequest {
|
|
165
188
|
}
|
|
166
|
-
interface BulkGetLoyaltyProgramResponse {
|
|
189
|
+
export interface BulkGetLoyaltyProgramResponse {
|
|
167
190
|
/** Retrieved loyalty programs. */
|
|
168
191
|
programInSites?: ProgramInSite[];
|
|
169
192
|
}
|
|
170
|
-
interface ProgramInSite {
|
|
193
|
+
export interface ProgramInSite {
|
|
171
194
|
/**
|
|
172
195
|
* Metasite ID.
|
|
173
196
|
* @format GUID
|
|
@@ -176,54 +199,54 @@ interface ProgramInSite {
|
|
|
176
199
|
/** Loyalty program. */
|
|
177
200
|
loyaltyProgram?: LoyaltyProgram;
|
|
178
201
|
}
|
|
179
|
-
interface UpdateLoyaltyProgramRequest {
|
|
202
|
+
export interface UpdateLoyaltyProgramRequest {
|
|
180
203
|
/** Loyalty program fields to update. */
|
|
181
204
|
loyaltyProgram: LoyaltyProgram;
|
|
182
205
|
}
|
|
183
|
-
interface UpdateLoyaltyProgramResponse {
|
|
206
|
+
export interface UpdateLoyaltyProgramResponse {
|
|
184
207
|
/** Updated loyalty program. */
|
|
185
208
|
loyaltyProgram?: LoyaltyProgram;
|
|
186
209
|
}
|
|
187
|
-
interface PointsExpirationConfigurationChanged {
|
|
210
|
+
export interface PointsExpirationConfigurationChanged {
|
|
188
211
|
/** Loyalty program. */
|
|
189
212
|
loyaltyProgram?: LoyaltyProgram;
|
|
190
213
|
/** Points expiration configuration changes */
|
|
191
214
|
pointsExpirationChanges?: PointsExpirationChanges;
|
|
192
215
|
}
|
|
193
|
-
interface PointsExpirationChanges {
|
|
216
|
+
export interface PointsExpirationChanges {
|
|
194
217
|
monthsOfInactivity?: number | null;
|
|
195
218
|
expiringPointsPercentage?: number | null;
|
|
196
219
|
}
|
|
197
|
-
interface ActivateLoyaltyProgramRequest {
|
|
220
|
+
export interface ActivateLoyaltyProgramRequest {
|
|
198
221
|
}
|
|
199
|
-
interface ActivateLoyaltyProgramResponse {
|
|
222
|
+
export interface ActivateLoyaltyProgramResponse {
|
|
200
223
|
/** Activated loyalty program. */
|
|
201
224
|
loyaltyProgram?: LoyaltyProgram;
|
|
202
225
|
}
|
|
203
|
-
interface LoyaltyProgramActivated {
|
|
226
|
+
export interface LoyaltyProgramActivated {
|
|
204
227
|
/** Activated loyalty program. */
|
|
205
228
|
loyaltyProgram?: LoyaltyProgram;
|
|
206
229
|
}
|
|
207
|
-
interface PauseLoyaltyProgramRequest {
|
|
230
|
+
export interface PauseLoyaltyProgramRequest {
|
|
208
231
|
}
|
|
209
|
-
interface PauseLoyaltyProgramResponse {
|
|
232
|
+
export interface PauseLoyaltyProgramResponse {
|
|
210
233
|
/** Paused loyalty program. */
|
|
211
234
|
loyaltyProgram?: LoyaltyProgram;
|
|
212
235
|
}
|
|
213
|
-
interface GetLoyaltyProgramDescriptionRequest {
|
|
236
|
+
export interface GetLoyaltyProgramDescriptionRequest {
|
|
214
237
|
/**
|
|
215
238
|
* List of description fields to retrieve. Supported values: `description`, `updatedDate`.
|
|
216
239
|
* @maxSize 2
|
|
217
240
|
*/
|
|
218
241
|
fields?: string[];
|
|
219
242
|
}
|
|
220
|
-
interface GetLoyaltyProgramDescriptionResponse {
|
|
243
|
+
export interface GetLoyaltyProgramDescriptionResponse {
|
|
221
244
|
/** Retrieved loyalty program description. */
|
|
222
245
|
description?: string | null;
|
|
223
246
|
/** Date and time of the latest description update. */
|
|
224
|
-
|
|
247
|
+
updatedDate?: Date | null;
|
|
225
248
|
}
|
|
226
|
-
interface UpdateLoyaltyProgramDescriptionRequest {
|
|
249
|
+
export interface UpdateLoyaltyProgramDescriptionRequest {
|
|
227
250
|
/**
|
|
228
251
|
* Loyalty program description to update.
|
|
229
252
|
* @minLength 1
|
|
@@ -231,13 +254,13 @@ interface UpdateLoyaltyProgramDescriptionRequest {
|
|
|
231
254
|
*/
|
|
232
255
|
description?: string;
|
|
233
256
|
}
|
|
234
|
-
interface UpdateLoyaltyProgramDescriptionResponse {
|
|
257
|
+
export interface UpdateLoyaltyProgramDescriptionResponse {
|
|
235
258
|
}
|
|
236
|
-
interface LoyaltyProgramDescriptionUpdated {
|
|
259
|
+
export interface LoyaltyProgramDescriptionUpdated {
|
|
237
260
|
}
|
|
238
|
-
interface GetLoyaltyProgramPremiumFeaturesRequest {
|
|
261
|
+
export interface GetLoyaltyProgramPremiumFeaturesRequest {
|
|
239
262
|
}
|
|
240
|
-
interface GetLoyaltyProgramPremiumFeaturesResponse {
|
|
263
|
+
export interface GetLoyaltyProgramPremiumFeaturesResponse {
|
|
241
264
|
/**
|
|
242
265
|
* Whether there are any loyalty program premium features.
|
|
243
266
|
* @readonly
|
|
@@ -254,27 +277,27 @@ interface GetLoyaltyProgramPremiumFeaturesResponse {
|
|
|
254
277
|
*/
|
|
255
278
|
pointsExpiration?: boolean;
|
|
256
279
|
}
|
|
257
|
-
interface EnablePointsExpirationRequest {
|
|
280
|
+
export interface EnablePointsExpirationRequest {
|
|
258
281
|
}
|
|
259
|
-
interface EnablePointsExpirationResponse {
|
|
282
|
+
export interface EnablePointsExpirationResponse {
|
|
260
283
|
/** Loyalty program with enabled points expiration feature. */
|
|
261
284
|
loyaltyProgram?: LoyaltyProgram;
|
|
262
285
|
}
|
|
263
|
-
interface PointsExpirationEnabled {
|
|
286
|
+
export interface PointsExpirationEnabled {
|
|
264
287
|
/** Loyalty program. */
|
|
265
288
|
loyaltyProgram?: LoyaltyProgram;
|
|
266
289
|
}
|
|
267
|
-
interface DisablePointsExpirationRequest {
|
|
290
|
+
export interface DisablePointsExpirationRequest {
|
|
268
291
|
}
|
|
269
|
-
interface DisablePointsExpirationResponse {
|
|
292
|
+
export interface DisablePointsExpirationResponse {
|
|
270
293
|
/** Loyalty program with disabled points expiration feature. */
|
|
271
294
|
loyaltyProgram?: LoyaltyProgram;
|
|
272
295
|
}
|
|
273
|
-
interface PointsExpirationDisabled {
|
|
296
|
+
export interface PointsExpirationDisabled {
|
|
274
297
|
/** Loyalty program. */
|
|
275
298
|
loyaltyProgram?: LoyaltyProgram;
|
|
276
299
|
}
|
|
277
|
-
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
300
|
+
export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
278
301
|
/** Emitted on a meta site creation. */
|
|
279
302
|
siteCreated?: SiteCreated;
|
|
280
303
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -315,6 +338,14 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
315
338
|
urlChanged?: SiteUrlChanged;
|
|
316
339
|
/** Site is marked as PurgedExternally */
|
|
317
340
|
sitePurgedExternally?: SitePurgedExternally;
|
|
341
|
+
/** Emitted when Odeditor is attached. */
|
|
342
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
343
|
+
/** Emitted when Odeditor is detached. */
|
|
344
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
345
|
+
/** Emitted when Picasso is attached. */
|
|
346
|
+
picassoAssigned?: PicassoAssigned;
|
|
347
|
+
/** Emitted when Picasso is detached. */
|
|
348
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
318
349
|
/**
|
|
319
350
|
* A meta site id.
|
|
320
351
|
* @format GUID
|
|
@@ -332,7 +363,7 @@ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
332
363
|
assets?: Asset[];
|
|
333
364
|
}
|
|
334
365
|
/** @oneof */
|
|
335
|
-
interface MetaSiteSpecialEventPayloadOneOf {
|
|
366
|
+
export interface MetaSiteSpecialEventPayloadOneOf {
|
|
336
367
|
/** Emitted on a meta site creation. */
|
|
337
368
|
siteCreated?: SiteCreated;
|
|
338
369
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -373,8 +404,16 @@ interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
373
404
|
urlChanged?: SiteUrlChanged;
|
|
374
405
|
/** Site is marked as PurgedExternally */
|
|
375
406
|
sitePurgedExternally?: SitePurgedExternally;
|
|
407
|
+
/** Emitted when Odeditor is attached. */
|
|
408
|
+
odeditorAssigned?: OdeditorAssigned;
|
|
409
|
+
/** Emitted when Odeditor is detached. */
|
|
410
|
+
odeditorUnassigned?: OdeditorUnassigned;
|
|
411
|
+
/** Emitted when Picasso is attached. */
|
|
412
|
+
picassoAssigned?: PicassoAssigned;
|
|
413
|
+
/** Emitted when Picasso is detached. */
|
|
414
|
+
picassoUnassigned?: PicassoUnassigned;
|
|
376
415
|
}
|
|
377
|
-
interface Asset {
|
|
416
|
+
export interface Asset {
|
|
378
417
|
/**
|
|
379
418
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
380
419
|
* @maxLength 36
|
|
@@ -388,14 +427,14 @@ interface Asset {
|
|
|
388
427
|
/** An application state. */
|
|
389
428
|
state?: State;
|
|
390
429
|
}
|
|
391
|
-
declare enum State {
|
|
430
|
+
export declare enum State {
|
|
392
431
|
UNKNOWN = "UNKNOWN",
|
|
393
432
|
ENABLED = "ENABLED",
|
|
394
433
|
DISABLED = "DISABLED",
|
|
395
434
|
PENDING = "PENDING",
|
|
396
435
|
DEMO = "DEMO"
|
|
397
436
|
}
|
|
398
|
-
interface SiteCreated {
|
|
437
|
+
export interface SiteCreated {
|
|
399
438
|
/**
|
|
400
439
|
* A template identifier (empty if not created from a template).
|
|
401
440
|
* @maxLength 36
|
|
@@ -424,7 +463,7 @@ interface SiteCreated {
|
|
|
424
463
|
/** A namespace. */
|
|
425
464
|
namespace?: Namespace;
|
|
426
465
|
}
|
|
427
|
-
declare enum SiteCreatedContext {
|
|
466
|
+
export declare enum SiteCreatedContext {
|
|
428
467
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
429
468
|
OTHER = "OTHER",
|
|
430
469
|
/** A meta site was created from template. */
|
|
@@ -438,7 +477,7 @@ declare enum SiteCreatedContext {
|
|
|
438
477
|
/** deprecated A meta site was created for Flash editor. */
|
|
439
478
|
FLASH = "FLASH"
|
|
440
479
|
}
|
|
441
|
-
declare enum Namespace {
|
|
480
|
+
export declare enum Namespace {
|
|
442
481
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
443
482
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
444
483
|
WIX = "WIX",
|
|
@@ -521,7 +560,7 @@ declare enum Namespace {
|
|
|
521
560
|
MIMIR = "MIMIR"
|
|
522
561
|
}
|
|
523
562
|
/** Site transferred to another user. */
|
|
524
|
-
interface SiteTransferred {
|
|
563
|
+
export interface SiteTransferred {
|
|
525
564
|
/**
|
|
526
565
|
* A previous owner id (user that transfers meta site).
|
|
527
566
|
* @format GUID
|
|
@@ -534,11 +573,11 @@ interface SiteTransferred {
|
|
|
534
573
|
newOwnerId?: string;
|
|
535
574
|
}
|
|
536
575
|
/** Soft deletion of the meta site. Could be restored. */
|
|
537
|
-
interface SiteDeleted {
|
|
576
|
+
export interface SiteDeleted {
|
|
538
577
|
/** A deletion context. */
|
|
539
578
|
deleteContext?: DeleteContext;
|
|
540
579
|
}
|
|
541
|
-
interface DeleteContext {
|
|
580
|
+
export interface DeleteContext {
|
|
542
581
|
/** When the meta site was deleted. */
|
|
543
582
|
dateDeleted?: Date | null;
|
|
544
583
|
/** A status. */
|
|
@@ -554,7 +593,7 @@ interface DeleteContext {
|
|
|
554
593
|
*/
|
|
555
594
|
initiatorId?: string | null;
|
|
556
595
|
}
|
|
557
|
-
declare enum DeleteStatus {
|
|
596
|
+
export declare enum DeleteStatus {
|
|
558
597
|
UNKNOWN = "UNKNOWN",
|
|
559
598
|
TRASH = "TRASH",
|
|
560
599
|
DELETED = "DELETED",
|
|
@@ -562,12 +601,12 @@ declare enum DeleteStatus {
|
|
|
562
601
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
563
602
|
}
|
|
564
603
|
/** Restoration of the meta site. */
|
|
565
|
-
interface SiteUndeleted {
|
|
604
|
+
export interface SiteUndeleted {
|
|
566
605
|
}
|
|
567
606
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
568
|
-
interface SitePublished {
|
|
607
|
+
export interface SitePublished {
|
|
569
608
|
}
|
|
570
|
-
interface SiteUnpublished {
|
|
609
|
+
export interface SiteUnpublished {
|
|
571
610
|
/**
|
|
572
611
|
* A list of URLs previously associated with the meta site.
|
|
573
612
|
* @maxLength 4000
|
|
@@ -575,9 +614,9 @@ interface SiteUnpublished {
|
|
|
575
614
|
*/
|
|
576
615
|
urls?: string[];
|
|
577
616
|
}
|
|
578
|
-
interface SiteMarkedAsTemplate {
|
|
617
|
+
export interface SiteMarkedAsTemplate {
|
|
579
618
|
}
|
|
580
|
-
interface SiteMarkedAsWixSite {
|
|
619
|
+
export interface SiteMarkedAsWixSite {
|
|
581
620
|
}
|
|
582
621
|
/**
|
|
583
622
|
* Represents a service provisioned a site.
|
|
@@ -594,7 +633,7 @@ interface SiteMarkedAsWixSite {
|
|
|
594
633
|
* changes made to the original template afterward.
|
|
595
634
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
596
635
|
*/
|
|
597
|
-
interface ServiceProvisioned {
|
|
636
|
+
export interface ServiceProvisioned {
|
|
598
637
|
/**
|
|
599
638
|
* Either UUID or EmbeddedServiceType.
|
|
600
639
|
* @maxLength 36
|
|
@@ -621,7 +660,7 @@ interface ServiceProvisioned {
|
|
|
621
660
|
*/
|
|
622
661
|
originMetaSiteId?: string | null;
|
|
623
662
|
}
|
|
624
|
-
interface ServiceRemoved {
|
|
663
|
+
export interface ServiceRemoved {
|
|
625
664
|
/**
|
|
626
665
|
* Either UUID or EmbeddedServiceType.
|
|
627
666
|
* @maxLength 36
|
|
@@ -639,7 +678,7 @@ interface ServiceRemoved {
|
|
|
639
678
|
version?: string | null;
|
|
640
679
|
}
|
|
641
680
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
642
|
-
interface SiteRenamed {
|
|
681
|
+
export interface SiteRenamed {
|
|
643
682
|
/**
|
|
644
683
|
* A new meta site name (URL slug).
|
|
645
684
|
* @maxLength 20
|
|
@@ -656,21 +695,21 @@ interface SiteRenamed {
|
|
|
656
695
|
*
|
|
657
696
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
658
697
|
*/
|
|
659
|
-
interface SiteHardDeleted {
|
|
698
|
+
export interface SiteHardDeleted {
|
|
660
699
|
/** A deletion context. */
|
|
661
700
|
deleteContext?: DeleteContext;
|
|
662
701
|
}
|
|
663
|
-
interface NamespaceChanged {
|
|
702
|
+
export interface NamespaceChanged {
|
|
664
703
|
/** A previous namespace. */
|
|
665
704
|
oldNamespace?: Namespace;
|
|
666
705
|
/** A new namespace. */
|
|
667
706
|
newNamespace?: Namespace;
|
|
668
707
|
}
|
|
669
708
|
/** Assigned Studio editor */
|
|
670
|
-
interface StudioAssigned {
|
|
709
|
+
export interface StudioAssigned {
|
|
671
710
|
}
|
|
672
711
|
/** Unassigned Studio editor */
|
|
673
|
-
interface StudioUnassigned {
|
|
712
|
+
export interface StudioUnassigned {
|
|
674
713
|
}
|
|
675
714
|
/**
|
|
676
715
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -680,13 +719,13 @@ interface StudioUnassigned {
|
|
|
680
719
|
*
|
|
681
720
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
682
721
|
*/
|
|
683
|
-
interface SiteUrlChanged {
|
|
722
|
+
export interface SiteUrlChanged {
|
|
684
723
|
}
|
|
685
724
|
/**
|
|
686
725
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
687
726
|
* Consumed by other teams to remove relevant data.
|
|
688
727
|
*/
|
|
689
|
-
interface SitePurgedExternally {
|
|
728
|
+
export interface SitePurgedExternally {
|
|
690
729
|
/**
|
|
691
730
|
* @maxLength 2048
|
|
692
731
|
* @maxSize 100
|
|
@@ -695,9 +734,21 @@ interface SitePurgedExternally {
|
|
|
695
734
|
*/
|
|
696
735
|
appDefId?: string[];
|
|
697
736
|
}
|
|
698
|
-
|
|
737
|
+
/** Assigned Odeditor */
|
|
738
|
+
export interface OdeditorAssigned {
|
|
739
|
+
}
|
|
740
|
+
/** Unassigned Odeditor */
|
|
741
|
+
export interface OdeditorUnassigned {
|
|
742
|
+
}
|
|
743
|
+
/** Assigned Picasso editor */
|
|
744
|
+
export interface PicassoAssigned {
|
|
699
745
|
}
|
|
700
|
-
|
|
746
|
+
/** Unassigned Picasso */
|
|
747
|
+
export interface PicassoUnassigned {
|
|
748
|
+
}
|
|
749
|
+
export interface Empty {
|
|
750
|
+
}
|
|
751
|
+
export interface FeatureEvent extends FeatureEventEventOneOf {
|
|
701
752
|
/**
|
|
702
753
|
* Information about an event that makes a feature eligible to the user.
|
|
703
754
|
* Triggered for example, for new features or when a feature is reassigned
|
|
@@ -731,7 +782,7 @@ interface FeatureEvent extends FeatureEventEventOneOf {
|
|
|
731
782
|
timestamp?: Date | null;
|
|
732
783
|
}
|
|
733
784
|
/** @oneof */
|
|
734
|
-
interface FeatureEventEventOneOf {
|
|
785
|
+
export interface FeatureEventEventOneOf {
|
|
735
786
|
/**
|
|
736
787
|
* Information about an event that makes a feature eligible to the user.
|
|
737
788
|
* Triggered for example, for new features or when a feature is reassigned
|
|
@@ -760,7 +811,7 @@ interface FeatureEventEventOneOf {
|
|
|
760
811
|
cancelled?: FeatureCancelled;
|
|
761
812
|
}
|
|
762
813
|
/** Feature created or enabled after disabled state */
|
|
763
|
-
interface FeatureEnabled extends FeatureEnabledReasonOneOf {
|
|
814
|
+
export interface FeatureEnabled extends FeatureEnabledReasonOneOf {
|
|
764
815
|
/** Information about a transfer from another account. */
|
|
765
816
|
transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
|
|
766
817
|
/** Information about a transfer from another site. */
|
|
@@ -791,7 +842,7 @@ interface FeatureEnabled extends FeatureEnabledReasonOneOf {
|
|
|
791
842
|
reassignedFromMetasite?: string | null;
|
|
792
843
|
}
|
|
793
844
|
/** @oneof */
|
|
794
|
-
interface FeatureEnabledReasonOneOf {
|
|
845
|
+
export interface FeatureEnabledReasonOneOf {
|
|
795
846
|
/** Information about a transfer from another account. */
|
|
796
847
|
transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
|
|
797
848
|
/** Information about a transfer from another site. */
|
|
@@ -807,7 +858,7 @@ interface FeatureEnabledReasonOneOf {
|
|
|
807
858
|
/** Information about a feature that was migrated from legacy. */
|
|
808
859
|
migratedFromLegacy?: MigratedFromLegacyReason;
|
|
809
860
|
}
|
|
810
|
-
interface Feature extends FeatureQuantityInfoOneOf {
|
|
861
|
+
export interface Feature extends FeatureQuantityInfoOneOf {
|
|
811
862
|
/**
|
|
812
863
|
* Deprecated. Use `enabled` instead.
|
|
813
864
|
* @deprecated
|
|
@@ -824,7 +875,7 @@ interface Feature extends FeatureQuantityInfoOneOf {
|
|
|
824
875
|
* `{"id": "DEFAULT"}`. Use `uniqueName` as unique identifier for a feature.
|
|
825
876
|
* @readonly
|
|
826
877
|
*/
|
|
827
|
-
|
|
878
|
+
id?: string;
|
|
828
879
|
/**
|
|
829
880
|
* Unique name of the feature. Only lower case letters, numbers, and dashes
|
|
830
881
|
* `-` are supported. Used in the endpoints of the
|
|
@@ -888,7 +939,7 @@ interface Feature extends FeatureQuantityInfoOneOf {
|
|
|
888
939
|
metadata?: Record<string, string>;
|
|
889
940
|
}
|
|
890
941
|
/** @oneof */
|
|
891
|
-
interface FeatureQuantityInfoOneOf {
|
|
942
|
+
export interface FeatureQuantityInfoOneOf {
|
|
892
943
|
/**
|
|
893
944
|
* Deprecated. Use `enabled` instead.
|
|
894
945
|
* @deprecated
|
|
@@ -905,7 +956,7 @@ interface FeatureQuantityInfoOneOf {
|
|
|
905
956
|
* Note: Do not confuse with feature scope which is configured in the product catalog
|
|
906
957
|
* and defines in which context the product can be used
|
|
907
958
|
*/
|
|
908
|
-
interface FeatureContext {
|
|
959
|
+
export interface FeatureContext {
|
|
909
960
|
/**
|
|
910
961
|
* ID of the Wix account that the feature instance belongs to.
|
|
911
962
|
* Available for both site and account level feature instances.
|
|
@@ -925,10 +976,10 @@ interface FeatureContext {
|
|
|
925
976
|
* 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).
|
|
926
977
|
* A boolean feature is similar to a quantitive feature with a default limit of 0 and UNLIMITED premium limit (although a bit simplified).
|
|
927
978
|
*/
|
|
928
|
-
interface BooleanFeature {
|
|
979
|
+
export interface BooleanFeature {
|
|
929
980
|
}
|
|
930
981
|
/** 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. */
|
|
931
|
-
interface QuotaFeature {
|
|
982
|
+
export interface QuotaFeature {
|
|
932
983
|
/** Default (or Freemium) quota limitation. if left undefined the free feature has unlimited amount. */
|
|
933
984
|
limit?: string | null;
|
|
934
985
|
/** Periodic time-frame to reset the usage counter. You may use NO_PERIOD if counter shouldn't be reset. */
|
|
@@ -937,7 +988,7 @@ interface QuotaFeature {
|
|
|
937
988
|
units?: string | null;
|
|
938
989
|
}
|
|
939
990
|
/** Determines the reset cycle of the feature usage. */
|
|
940
|
-
declare enum FeaturePeriod {
|
|
991
|
+
export declare enum FeaturePeriod {
|
|
941
992
|
NO_PERIOD = "NO_PERIOD",
|
|
942
993
|
MILLISECOND = "MILLISECOND",
|
|
943
994
|
SECOND = "SECOND",
|
|
@@ -948,7 +999,7 @@ declare enum FeaturePeriod {
|
|
|
948
999
|
MONTH = "MONTH",
|
|
949
1000
|
YEAR = "YEAR"
|
|
950
1001
|
}
|
|
951
|
-
interface QuotaInfo {
|
|
1002
|
+
export interface QuotaInfo {
|
|
952
1003
|
/**
|
|
953
1004
|
* How often the customer is allowed to use the feature during the specified
|
|
954
1005
|
* period. `null` means that the customer has unlimited access to the feature.
|
|
@@ -964,16 +1015,22 @@ interface QuotaInfo {
|
|
|
964
1015
|
/**
|
|
965
1016
|
* How often the customer has used the feature during the current
|
|
966
1017
|
* period.
|
|
1018
|
+
* This value is retrieved from the Quota Manager/Rate Limiter system. If the
|
|
1019
|
+
* `exclude_quota_usage` field in the `ListFeaturesRequest` was set to `true`,
|
|
1020
|
+
* this field will contain the value `-1`.
|
|
967
1021
|
*/
|
|
968
1022
|
currentUsage?: string;
|
|
969
1023
|
/**
|
|
970
1024
|
* How often the customer can still use the feature during the current
|
|
971
1025
|
* period. `null` means that the customer has unlimited access to the feature.
|
|
1026
|
+
* This value is retrieved from the Quota Manager/Rate Limiter system. If the
|
|
1027
|
+
* `exclude_quota_usage` field in the `ListFeaturesRequest` was set to `true`,
|
|
1028
|
+
* this field will not be populated.
|
|
972
1029
|
*/
|
|
973
1030
|
remainingUsage?: string | null;
|
|
974
1031
|
}
|
|
975
1032
|
/** Subscription transferred from another account, features on the current account were enabled. */
|
|
976
|
-
interface TransferredFromAnotherAccountReason {
|
|
1033
|
+
export interface TransferredFromAnotherAccountReason {
|
|
977
1034
|
/**
|
|
978
1035
|
* Information about a transfer from another account.
|
|
979
1036
|
* @format GUID
|
|
@@ -981,7 +1038,7 @@ interface TransferredFromAnotherAccountReason {
|
|
|
981
1038
|
transferredFromAccount?: string;
|
|
982
1039
|
}
|
|
983
1040
|
/** Subscription moved from one site to another in the same account, features enabled on the target site */
|
|
984
|
-
interface ReassignedFromSiteReason {
|
|
1041
|
+
export interface ReassignedFromSiteReason {
|
|
985
1042
|
/**
|
|
986
1043
|
* Information about a transfer from another site.
|
|
987
1044
|
* @format GUID
|
|
@@ -989,22 +1046,22 @@ interface ReassignedFromSiteReason {
|
|
|
989
1046
|
reassignedFromMetasite?: string;
|
|
990
1047
|
}
|
|
991
1048
|
/** Subscription was floating and assigned to site, features enabled on the target site */
|
|
992
|
-
interface AssignedFromFloatingReason {
|
|
1049
|
+
export interface AssignedFromFloatingReason {
|
|
993
1050
|
}
|
|
994
1051
|
/** New subscription created and features created as enabled */
|
|
995
|
-
interface NewFeatureReason {
|
|
1052
|
+
export interface NewFeatureReason {
|
|
996
1053
|
}
|
|
997
1054
|
/** Subscription was upgraded or downgraded, as a result new features enabled, missing features disabled , quantities are updated */
|
|
998
|
-
interface ContractSwitchedReason {
|
|
1055
|
+
export interface ContractSwitchedReason {
|
|
999
1056
|
}
|
|
1000
1057
|
/** a call to CreateFeature in features-writer, creates feature that is not attached to subscription */
|
|
1001
|
-
interface ManualFeatureCreationReason {
|
|
1058
|
+
export interface ManualFeatureCreationReason {
|
|
1002
1059
|
}
|
|
1003
1060
|
/** Subscription created due to migration from old premium model */
|
|
1004
|
-
interface MigratedFromLegacyReason {
|
|
1061
|
+
export interface MigratedFromLegacyReason {
|
|
1005
1062
|
}
|
|
1006
1063
|
/** Feature disabled and can be enabled in the future */
|
|
1007
|
-
interface FeatureDisabled extends FeatureDisabledReasonOneOf {
|
|
1064
|
+
export interface FeatureDisabled extends FeatureDisabledReasonOneOf {
|
|
1008
1065
|
/** Information about a feature that's no longer assigned to a site. */
|
|
1009
1066
|
unassingedToFloating?: UnAssingedToFloatingReason;
|
|
1010
1067
|
/**
|
|
@@ -1029,7 +1086,7 @@ interface FeatureDisabled extends FeatureDisabledReasonOneOf {
|
|
|
1029
1086
|
metaSiteId?: string | null;
|
|
1030
1087
|
}
|
|
1031
1088
|
/** @oneof */
|
|
1032
|
-
interface FeatureDisabledReasonOneOf {
|
|
1089
|
+
export interface FeatureDisabledReasonOneOf {
|
|
1033
1090
|
/** Information about a feature that's no longer assigned to a site. */
|
|
1034
1091
|
unassingedToFloating?: UnAssingedToFloatingReason;
|
|
1035
1092
|
/**
|
|
@@ -1044,13 +1101,13 @@ interface FeatureDisabledReasonOneOf {
|
|
|
1044
1101
|
reassignedToAnotherSite?: ReassignedToAnotherSiteReason;
|
|
1045
1102
|
}
|
|
1046
1103
|
/** Subscription was unassigned from the site and moved into floating state */
|
|
1047
|
-
interface UnAssingedToFloatingReason {
|
|
1104
|
+
export interface UnAssingedToFloatingReason {
|
|
1048
1105
|
}
|
|
1049
1106
|
/** Another subscription was assigned to the site, causing existing features on this site to be disabled */
|
|
1050
|
-
interface ReplacedByAnotherSubscriptionReason {
|
|
1107
|
+
export interface ReplacedByAnotherSubscriptionReason {
|
|
1051
1108
|
}
|
|
1052
1109
|
/** Subscription was assigned to another site, causing features on the origin site to be disabled. */
|
|
1053
|
-
interface ReassignedToAnotherSiteReason {
|
|
1110
|
+
export interface ReassignedToAnotherSiteReason {
|
|
1054
1111
|
/**
|
|
1055
1112
|
* Information about a transfer to the site.
|
|
1056
1113
|
* @format GUID
|
|
@@ -1058,7 +1115,7 @@ interface ReassignedToAnotherSiteReason {
|
|
|
1058
1115
|
reassignedToMetasite?: string;
|
|
1059
1116
|
}
|
|
1060
1117
|
/** Feature updated, for example Quota was increased due to upgrade */
|
|
1061
|
-
interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf, FeatureUpdatedReasonOneOf {
|
|
1118
|
+
export interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf, FeatureUpdatedReasonOneOf {
|
|
1062
1119
|
/** Information about a feature that doesn't have a usage quota. */
|
|
1063
1120
|
booleanFeature?: BooleanFeature;
|
|
1064
1121
|
/** Information about a feature that has a usage quota. */
|
|
@@ -1072,19 +1129,19 @@ interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf, Featur
|
|
|
1072
1129
|
feature?: Feature;
|
|
1073
1130
|
}
|
|
1074
1131
|
/** @oneof */
|
|
1075
|
-
interface FeatureUpdatedPreviousQuantityInfoOneOf {
|
|
1132
|
+
export interface FeatureUpdatedPreviousQuantityInfoOneOf {
|
|
1076
1133
|
/** Information about a feature that doesn't have a usage quota. */
|
|
1077
1134
|
booleanFeature?: BooleanFeature;
|
|
1078
1135
|
/** Information about a feature that has a usage quota. */
|
|
1079
1136
|
quotaFeature?: QuotaFeature;
|
|
1080
1137
|
}
|
|
1081
1138
|
/** @oneof */
|
|
1082
|
-
interface FeatureUpdatedReasonOneOf {
|
|
1139
|
+
export interface FeatureUpdatedReasonOneOf {
|
|
1083
1140
|
/** Information about the contract switch. */
|
|
1084
1141
|
contractSwitched?: ContractSwitchedReason;
|
|
1085
1142
|
}
|
|
1086
1143
|
/** Feature was permanently cancelled */
|
|
1087
|
-
interface FeatureCancelled extends FeatureCancelledReasonOneOf {
|
|
1144
|
+
export interface FeatureCancelled extends FeatureCancelledReasonOneOf {
|
|
1088
1145
|
/** Information about a transfer to the account. */
|
|
1089
1146
|
transferredToAnotherAccount?: TransferredToAnotherAccountReason;
|
|
1090
1147
|
/** Information about the contract switch. */
|
|
@@ -1101,7 +1158,7 @@ interface FeatureCancelled extends FeatureCancelledReasonOneOf {
|
|
|
1101
1158
|
transferredToAccount?: string | null;
|
|
1102
1159
|
}
|
|
1103
1160
|
/** @oneof */
|
|
1104
|
-
interface FeatureCancelledReasonOneOf {
|
|
1161
|
+
export interface FeatureCancelledReasonOneOf {
|
|
1105
1162
|
/** Information about a transfer to the account. */
|
|
1106
1163
|
transferredToAnotherAccount?: TransferredToAnotherAccountReason;
|
|
1107
1164
|
/** Information about the contract switch. */
|
|
@@ -1110,7 +1167,7 @@ interface FeatureCancelledReasonOneOf {
|
|
|
1110
1167
|
cancelRequest?: CancelRequestedReason;
|
|
1111
1168
|
}
|
|
1112
1169
|
/** Subscription was transferred to another account, features in the origin account were cancelled */
|
|
1113
|
-
interface TransferredToAnotherAccountReason {
|
|
1170
|
+
export interface TransferredToAnotherAccountReason {
|
|
1114
1171
|
/**
|
|
1115
1172
|
* Information about a transfer to the account.
|
|
1116
1173
|
* @format GUID
|
|
@@ -1118,9 +1175,9 @@ interface TransferredToAnotherAccountReason {
|
|
|
1118
1175
|
transferredToAccount?: string;
|
|
1119
1176
|
}
|
|
1120
1177
|
/** Cancellation was requested from the subscription manager api, might be a result of billing event, or direct call */
|
|
1121
|
-
interface CancelRequestedReason {
|
|
1178
|
+
export interface CancelRequestedReason {
|
|
1122
1179
|
}
|
|
1123
|
-
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1180
|
+
export interface DomainEvent extends DomainEventBodyOneOf {
|
|
1124
1181
|
createdEvent?: EntityCreatedEvent;
|
|
1125
1182
|
updatedEvent?: EntityUpdatedEvent;
|
|
1126
1183
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -1129,7 +1186,7 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1129
1186
|
* Unique event ID.
|
|
1130
1187
|
* Allows clients to ignore duplicate webhooks.
|
|
1131
1188
|
*/
|
|
1132
|
-
|
|
1189
|
+
id?: string;
|
|
1133
1190
|
/**
|
|
1134
1191
|
* Assumes actions are also always typed to an entity_type
|
|
1135
1192
|
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
@@ -1163,34 +1220,36 @@ interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1163
1220
|
entityEventSequence?: string | null;
|
|
1164
1221
|
}
|
|
1165
1222
|
/** @oneof */
|
|
1166
|
-
interface DomainEventBodyOneOf {
|
|
1223
|
+
export interface DomainEventBodyOneOf {
|
|
1167
1224
|
createdEvent?: EntityCreatedEvent;
|
|
1168
1225
|
updatedEvent?: EntityUpdatedEvent;
|
|
1169
1226
|
deletedEvent?: EntityDeletedEvent;
|
|
1170
1227
|
actionEvent?: ActionEvent;
|
|
1171
1228
|
}
|
|
1172
|
-
interface EntityCreatedEvent {
|
|
1173
|
-
|
|
1229
|
+
export interface EntityCreatedEvent {
|
|
1230
|
+
entityAsJson?: string;
|
|
1231
|
+
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1232
|
+
restoreInfo?: RestoreInfo;
|
|
1174
1233
|
}
|
|
1175
|
-
interface RestoreInfo {
|
|
1234
|
+
export interface RestoreInfo {
|
|
1176
1235
|
deletedDate?: Date | null;
|
|
1177
1236
|
}
|
|
1178
|
-
interface EntityUpdatedEvent {
|
|
1237
|
+
export interface EntityUpdatedEvent {
|
|
1179
1238
|
/**
|
|
1180
1239
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1181
1240
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1182
1241
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1183
1242
|
*/
|
|
1184
|
-
|
|
1243
|
+
currentEntityAsJson?: string;
|
|
1185
1244
|
}
|
|
1186
|
-
interface EntityDeletedEvent {
|
|
1245
|
+
export interface EntityDeletedEvent {
|
|
1187
1246
|
/** Entity that was deleted */
|
|
1188
|
-
|
|
1247
|
+
deletedEntityAsJson?: string | null;
|
|
1189
1248
|
}
|
|
1190
|
-
interface ActionEvent {
|
|
1191
|
-
|
|
1249
|
+
export interface ActionEvent {
|
|
1250
|
+
bodyAsJson?: string;
|
|
1192
1251
|
}
|
|
1193
|
-
interface MessageEnvelope {
|
|
1252
|
+
export interface MessageEnvelope {
|
|
1194
1253
|
/**
|
|
1195
1254
|
* App instance ID.
|
|
1196
1255
|
* @format GUID
|
|
@@ -1206,7 +1265,7 @@ interface MessageEnvelope {
|
|
|
1206
1265
|
/** Stringify payload. */
|
|
1207
1266
|
data?: string;
|
|
1208
1267
|
}
|
|
1209
|
-
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1268
|
+
export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1210
1269
|
/**
|
|
1211
1270
|
* ID of a site visitor that has not logged in to the site.
|
|
1212
1271
|
* @format GUID
|
|
@@ -1231,7 +1290,7 @@ interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1231
1290
|
identityType?: WebhookIdentityType;
|
|
1232
1291
|
}
|
|
1233
1292
|
/** @oneof */
|
|
1234
|
-
interface IdentificationDataIdOneOf {
|
|
1293
|
+
export interface IdentificationDataIdOneOf {
|
|
1235
1294
|
/**
|
|
1236
1295
|
* ID of a site visitor that has not logged in to the site.
|
|
1237
1296
|
* @format GUID
|
|
@@ -1253,68 +1312,10 @@ interface IdentificationDataIdOneOf {
|
|
|
1253
1312
|
*/
|
|
1254
1313
|
appId?: string;
|
|
1255
1314
|
}
|
|
1256
|
-
declare enum WebhookIdentityType {
|
|
1315
|
+
export declare enum WebhookIdentityType {
|
|
1257
1316
|
UNKNOWN = "UNKNOWN",
|
|
1258
1317
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1259
1318
|
MEMBER = "MEMBER",
|
|
1260
1319
|
WIX_USER = "WIX_USER",
|
|
1261
1320
|
APP = "APP"
|
|
1262
1321
|
}
|
|
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;
|
|
1276
|
-
}
|
|
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;
|
|
1314
|
-
}
|
|
1315
|
-
interface ProgramUpdatedEnvelope {
|
|
1316
|
-
entity: LoyaltyProgram;
|
|
1317
|
-
metadata: EventMetadata;
|
|
1318
|
-
}
|
|
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 };
|