@wix/auto_sdk_loyalty_programs 1.0.19 → 1.0.21
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-CEkDSoxz.d.mts} +201 -158
- package/build/internal/{cjs/src/loyalty-v1-program-programs.types.d.ts → loyalty-v1-program-programs.universal-CEkDSoxz.d.ts} +201 -158
- package/build/internal/meta.d.mts +230 -0
- package/build/internal/meta.d.ts +230 -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-CEkDSoxz.d.mts} +201 -158
- package/build/{es/src/loyalty-v1-program-programs.types.d.ts → loyalty-v1-program-programs.universal-CEkDSoxz.d.ts} +201 -158
- package/build/meta.d.mts +230 -0
- package/build/meta.d.ts +230 -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 -1492
- 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 -1492
- 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 -1492
- 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 -1492
- 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`.
|
|
@@ -18,17 +18,17 @@ export interface LoyaltyProgram {
|
|
|
18
18
|
* Default: `"DRAFT"`
|
|
19
19
|
* @readonly
|
|
20
20
|
*/
|
|
21
|
-
status?:
|
|
21
|
+
status?: ProgramStatusWithLiterals;
|
|
22
22
|
/**
|
|
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,12 +72,14 @@ 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
|
+
/** @enumType */
|
|
76
|
+
type ProgramStatusWithLiterals = ProgramStatus | 'UNKNOWN' | 'DRAFT' | 'ACTIVE' | 'PAUSED';
|
|
77
|
+
interface PointsExpiration {
|
|
99
78
|
/**
|
|
100
79
|
* Status of the points expiration feature.
|
|
101
80
|
* @readonly
|
|
102
81
|
*/
|
|
103
|
-
status?:
|
|
82
|
+
status?: StatusWithLiterals;
|
|
104
83
|
/**
|
|
105
84
|
* How many months a member should be inactive to lose the collected points.
|
|
106
85
|
* @min 1
|
|
@@ -114,7 +93,7 @@ export interface PointsExpiration {
|
|
|
114
93
|
*/
|
|
115
94
|
expiringPointsPercentage?: number;
|
|
116
95
|
}
|
|
117
|
-
|
|
96
|
+
declare enum Status {
|
|
118
97
|
/** Unknown points expiration status. This value is not used. */
|
|
119
98
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
120
99
|
/** Points expiration feature is disabled. */
|
|
@@ -122,7 +101,9 @@ export declare enum Status {
|
|
|
122
101
|
/** Points expiration feature is enabled. */
|
|
123
102
|
ENABLED = "ENABLED"
|
|
124
103
|
}
|
|
125
|
-
|
|
104
|
+
/** @enumType */
|
|
105
|
+
type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'DISABLED' | 'ENABLED';
|
|
106
|
+
interface PremiumFeatures {
|
|
126
107
|
/**
|
|
127
108
|
* Whether there are any loyalty program premium features.
|
|
128
109
|
* @readonly
|
|
@@ -139,16 +120,16 @@ export interface PremiumFeatures {
|
|
|
139
120
|
*/
|
|
140
121
|
pointsExpiration?: boolean;
|
|
141
122
|
}
|
|
142
|
-
|
|
123
|
+
interface SocialMediaSettings {
|
|
143
124
|
/**
|
|
144
125
|
* List of social media channels
|
|
145
126
|
* @maxSize 5
|
|
146
127
|
*/
|
|
147
128
|
channels?: SocialMediaChannel[];
|
|
148
129
|
}
|
|
149
|
-
|
|
130
|
+
interface SocialMediaChannel {
|
|
150
131
|
/** Social media channel type */
|
|
151
|
-
type?:
|
|
132
|
+
type?: TypeWithLiterals;
|
|
152
133
|
/** Enable or disable social media channel */
|
|
153
134
|
enabled?: boolean;
|
|
154
135
|
/**
|
|
@@ -156,7 +137,7 @@ export interface SocialMediaChannel {
|
|
|
156
137
|
* @minLength 1
|
|
157
138
|
* @maxLength 255
|
|
158
139
|
*/
|
|
159
|
-
|
|
140
|
+
_id?: string;
|
|
160
141
|
/**
|
|
161
142
|
* Social media channel URL
|
|
162
143
|
* @readonly
|
|
@@ -164,7 +145,7 @@ export interface SocialMediaChannel {
|
|
|
164
145
|
*/
|
|
165
146
|
url?: string | null;
|
|
166
147
|
}
|
|
167
|
-
|
|
148
|
+
declare enum Type {
|
|
168
149
|
/** Unknown social media channel type. */
|
|
169
150
|
UNKNOWN_CHANNEL = "UNKNOWN_CHANNEL",
|
|
170
151
|
/** Facebook social media channel. */
|
|
@@ -178,19 +159,21 @@ export declare enum Type {
|
|
|
178
159
|
/** TikTok social media channel. */
|
|
179
160
|
TIKTOK = "TIKTOK"
|
|
180
161
|
}
|
|
181
|
-
|
|
162
|
+
/** @enumType */
|
|
163
|
+
type TypeWithLiterals = Type | 'UNKNOWN_CHANNEL' | 'FACEBOOK' | 'INSTAGRAM' | 'LINKEDIN' | 'X' | 'TIKTOK';
|
|
164
|
+
interface GetLoyaltyProgramRequest {
|
|
182
165
|
}
|
|
183
|
-
|
|
166
|
+
interface GetLoyaltyProgramResponse {
|
|
184
167
|
/** Retrieved loyalty program. */
|
|
185
168
|
loyaltyProgram?: LoyaltyProgram;
|
|
186
169
|
}
|
|
187
|
-
|
|
170
|
+
interface BulkGetLoyaltyProgramRequest {
|
|
188
171
|
}
|
|
189
|
-
|
|
172
|
+
interface BulkGetLoyaltyProgramResponse {
|
|
190
173
|
/** Retrieved loyalty programs. */
|
|
191
174
|
programInSites?: ProgramInSite[];
|
|
192
175
|
}
|
|
193
|
-
|
|
176
|
+
interface ProgramInSite {
|
|
194
177
|
/**
|
|
195
178
|
* Metasite ID.
|
|
196
179
|
* @format GUID
|
|
@@ -199,54 +182,54 @@ export interface ProgramInSite {
|
|
|
199
182
|
/** Loyalty program. */
|
|
200
183
|
loyaltyProgram?: LoyaltyProgram;
|
|
201
184
|
}
|
|
202
|
-
|
|
185
|
+
interface UpdateLoyaltyProgramRequest {
|
|
203
186
|
/** Loyalty program fields to update. */
|
|
204
187
|
loyaltyProgram: LoyaltyProgram;
|
|
205
188
|
}
|
|
206
|
-
|
|
189
|
+
interface UpdateLoyaltyProgramResponse {
|
|
207
190
|
/** Updated loyalty program. */
|
|
208
191
|
loyaltyProgram?: LoyaltyProgram;
|
|
209
192
|
}
|
|
210
|
-
|
|
193
|
+
interface PointsExpirationConfigurationChanged {
|
|
211
194
|
/** Loyalty program. */
|
|
212
195
|
loyaltyProgram?: LoyaltyProgram;
|
|
213
196
|
/** Points expiration configuration changes */
|
|
214
197
|
pointsExpirationChanges?: PointsExpirationChanges;
|
|
215
198
|
}
|
|
216
|
-
|
|
199
|
+
interface PointsExpirationChanges {
|
|
217
200
|
monthsOfInactivity?: number | null;
|
|
218
201
|
expiringPointsPercentage?: number | null;
|
|
219
202
|
}
|
|
220
|
-
|
|
203
|
+
interface ActivateLoyaltyProgramRequest {
|
|
221
204
|
}
|
|
222
|
-
|
|
205
|
+
interface ActivateLoyaltyProgramResponse {
|
|
223
206
|
/** Activated loyalty program. */
|
|
224
207
|
loyaltyProgram?: LoyaltyProgram;
|
|
225
208
|
}
|
|
226
|
-
|
|
209
|
+
interface LoyaltyProgramActivated {
|
|
227
210
|
/** Activated loyalty program. */
|
|
228
211
|
loyaltyProgram?: LoyaltyProgram;
|
|
229
212
|
}
|
|
230
|
-
|
|
213
|
+
interface PauseLoyaltyProgramRequest {
|
|
231
214
|
}
|
|
232
|
-
|
|
215
|
+
interface PauseLoyaltyProgramResponse {
|
|
233
216
|
/** Paused loyalty program. */
|
|
234
217
|
loyaltyProgram?: LoyaltyProgram;
|
|
235
218
|
}
|
|
236
|
-
|
|
219
|
+
interface GetLoyaltyProgramDescriptionRequest {
|
|
237
220
|
/**
|
|
238
221
|
* List of description fields to retrieve. Supported values: `description`, `updatedDate`.
|
|
239
222
|
* @maxSize 2
|
|
240
223
|
*/
|
|
241
224
|
fields?: string[];
|
|
242
225
|
}
|
|
243
|
-
|
|
226
|
+
interface GetLoyaltyProgramDescriptionResponse {
|
|
244
227
|
/** Retrieved loyalty program description. */
|
|
245
228
|
description?: string | null;
|
|
246
229
|
/** Date and time of the latest description update. */
|
|
247
|
-
|
|
230
|
+
_updatedDate?: Date | null;
|
|
248
231
|
}
|
|
249
|
-
|
|
232
|
+
interface UpdateLoyaltyProgramDescriptionRequest {
|
|
250
233
|
/**
|
|
251
234
|
* Loyalty program description to update.
|
|
252
235
|
* @minLength 1
|
|
@@ -254,13 +237,13 @@ export interface UpdateLoyaltyProgramDescriptionRequest {
|
|
|
254
237
|
*/
|
|
255
238
|
description?: string;
|
|
256
239
|
}
|
|
257
|
-
|
|
240
|
+
interface UpdateLoyaltyProgramDescriptionResponse {
|
|
258
241
|
}
|
|
259
|
-
|
|
242
|
+
interface LoyaltyProgramDescriptionUpdated {
|
|
260
243
|
}
|
|
261
|
-
|
|
244
|
+
interface GetLoyaltyProgramPremiumFeaturesRequest {
|
|
262
245
|
}
|
|
263
|
-
|
|
246
|
+
interface GetLoyaltyProgramPremiumFeaturesResponse {
|
|
264
247
|
/**
|
|
265
248
|
* Whether there are any loyalty program premium features.
|
|
266
249
|
* @readonly
|
|
@@ -277,27 +260,27 @@ export interface GetLoyaltyProgramPremiumFeaturesResponse {
|
|
|
277
260
|
*/
|
|
278
261
|
pointsExpiration?: boolean;
|
|
279
262
|
}
|
|
280
|
-
|
|
263
|
+
interface EnablePointsExpirationRequest {
|
|
281
264
|
}
|
|
282
|
-
|
|
265
|
+
interface EnablePointsExpirationResponse {
|
|
283
266
|
/** Loyalty program with enabled points expiration feature. */
|
|
284
267
|
loyaltyProgram?: LoyaltyProgram;
|
|
285
268
|
}
|
|
286
|
-
|
|
269
|
+
interface PointsExpirationEnabled {
|
|
287
270
|
/** Loyalty program. */
|
|
288
271
|
loyaltyProgram?: LoyaltyProgram;
|
|
289
272
|
}
|
|
290
|
-
|
|
273
|
+
interface DisablePointsExpirationRequest {
|
|
291
274
|
}
|
|
292
|
-
|
|
275
|
+
interface DisablePointsExpirationResponse {
|
|
293
276
|
/** Loyalty program with disabled points expiration feature. */
|
|
294
277
|
loyaltyProgram?: LoyaltyProgram;
|
|
295
278
|
}
|
|
296
|
-
|
|
279
|
+
interface PointsExpirationDisabled {
|
|
297
280
|
/** Loyalty program. */
|
|
298
281
|
loyaltyProgram?: LoyaltyProgram;
|
|
299
282
|
}
|
|
300
|
-
|
|
283
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
301
284
|
/** Emitted on a meta site creation. */
|
|
302
285
|
siteCreated?: SiteCreated;
|
|
303
286
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -363,7 +346,7 @@ export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
|
363
346
|
assets?: Asset[];
|
|
364
347
|
}
|
|
365
348
|
/** @oneof */
|
|
366
|
-
|
|
349
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
367
350
|
/** Emitted on a meta site creation. */
|
|
368
351
|
siteCreated?: SiteCreated;
|
|
369
352
|
/** Emitted on a meta site transfer completion. */
|
|
@@ -413,7 +396,7 @@ export interface MetaSiteSpecialEventPayloadOneOf {
|
|
|
413
396
|
/** Emitted when Picasso is detached. */
|
|
414
397
|
picassoUnassigned?: PicassoUnassigned;
|
|
415
398
|
}
|
|
416
|
-
|
|
399
|
+
interface Asset {
|
|
417
400
|
/**
|
|
418
401
|
* An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
|
|
419
402
|
* @maxLength 36
|
|
@@ -425,16 +408,18 @@ export interface Asset {
|
|
|
425
408
|
*/
|
|
426
409
|
instanceId?: string;
|
|
427
410
|
/** An application state. */
|
|
428
|
-
state?:
|
|
411
|
+
state?: StateWithLiterals;
|
|
429
412
|
}
|
|
430
|
-
|
|
413
|
+
declare enum State {
|
|
431
414
|
UNKNOWN = "UNKNOWN",
|
|
432
415
|
ENABLED = "ENABLED",
|
|
433
416
|
DISABLED = "DISABLED",
|
|
434
417
|
PENDING = "PENDING",
|
|
435
418
|
DEMO = "DEMO"
|
|
436
419
|
}
|
|
437
|
-
|
|
420
|
+
/** @enumType */
|
|
421
|
+
type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
|
|
422
|
+
interface SiteCreated {
|
|
438
423
|
/**
|
|
439
424
|
* A template identifier (empty if not created from a template).
|
|
440
425
|
* @maxLength 36
|
|
@@ -446,7 +431,7 @@ export interface SiteCreated {
|
|
|
446
431
|
*/
|
|
447
432
|
ownerId?: string;
|
|
448
433
|
/** A context in which meta site was created. */
|
|
449
|
-
context?:
|
|
434
|
+
context?: SiteCreatedContextWithLiterals;
|
|
450
435
|
/**
|
|
451
436
|
* A meta site id from which this site was created.
|
|
452
437
|
*
|
|
@@ -461,9 +446,9 @@ export interface SiteCreated {
|
|
|
461
446
|
*/
|
|
462
447
|
siteName?: string;
|
|
463
448
|
/** A namespace. */
|
|
464
|
-
namespace?:
|
|
449
|
+
namespace?: NamespaceWithLiterals;
|
|
465
450
|
}
|
|
466
|
-
|
|
451
|
+
declare enum SiteCreatedContext {
|
|
467
452
|
/** A valid option, we don't expose all reasons why site might be created. */
|
|
468
453
|
OTHER = "OTHER",
|
|
469
454
|
/** A meta site was created from template. */
|
|
@@ -477,7 +462,9 @@ export declare enum SiteCreatedContext {
|
|
|
477
462
|
/** deprecated A meta site was created for Flash editor. */
|
|
478
463
|
FLASH = "FLASH"
|
|
479
464
|
}
|
|
480
|
-
|
|
465
|
+
/** @enumType */
|
|
466
|
+
type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
|
|
467
|
+
declare enum Namespace {
|
|
481
468
|
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
482
469
|
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
483
470
|
WIX = "WIX",
|
|
@@ -559,8 +546,10 @@ export declare enum Namespace {
|
|
|
559
546
|
/** MIMIR - Siteless account for MIMIR Ai Job runner. */
|
|
560
547
|
MIMIR = "MIMIR"
|
|
561
548
|
}
|
|
549
|
+
/** @enumType */
|
|
550
|
+
type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
|
|
562
551
|
/** Site transferred to another user. */
|
|
563
|
-
|
|
552
|
+
interface SiteTransferred {
|
|
564
553
|
/**
|
|
565
554
|
* A previous owner id (user that transfers meta site).
|
|
566
555
|
* @format GUID
|
|
@@ -573,15 +562,15 @@ export interface SiteTransferred {
|
|
|
573
562
|
newOwnerId?: string;
|
|
574
563
|
}
|
|
575
564
|
/** Soft deletion of the meta site. Could be restored. */
|
|
576
|
-
|
|
565
|
+
interface SiteDeleted {
|
|
577
566
|
/** A deletion context. */
|
|
578
567
|
deleteContext?: DeleteContext;
|
|
579
568
|
}
|
|
580
|
-
|
|
569
|
+
interface DeleteContext {
|
|
581
570
|
/** When the meta site was deleted. */
|
|
582
571
|
dateDeleted?: Date | null;
|
|
583
572
|
/** A status. */
|
|
584
|
-
deleteStatus?:
|
|
573
|
+
deleteStatus?: DeleteStatusWithLiterals;
|
|
585
574
|
/**
|
|
586
575
|
* A reason (flow).
|
|
587
576
|
* @maxLength 255
|
|
@@ -593,20 +582,22 @@ export interface DeleteContext {
|
|
|
593
582
|
*/
|
|
594
583
|
initiatorId?: string | null;
|
|
595
584
|
}
|
|
596
|
-
|
|
585
|
+
declare enum DeleteStatus {
|
|
597
586
|
UNKNOWN = "UNKNOWN",
|
|
598
587
|
TRASH = "TRASH",
|
|
599
588
|
DELETED = "DELETED",
|
|
600
589
|
PENDING_PURGE = "PENDING_PURGE",
|
|
601
590
|
PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
|
|
602
591
|
}
|
|
592
|
+
/** @enumType */
|
|
593
|
+
type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
|
|
603
594
|
/** Restoration of the meta site. */
|
|
604
|
-
|
|
595
|
+
interface SiteUndeleted {
|
|
605
596
|
}
|
|
606
597
|
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
607
|
-
|
|
598
|
+
interface SitePublished {
|
|
608
599
|
}
|
|
609
|
-
|
|
600
|
+
interface SiteUnpublished {
|
|
610
601
|
/**
|
|
611
602
|
* A list of URLs previously associated with the meta site.
|
|
612
603
|
* @maxLength 4000
|
|
@@ -614,9 +605,9 @@ export interface SiteUnpublished {
|
|
|
614
605
|
*/
|
|
615
606
|
urls?: string[];
|
|
616
607
|
}
|
|
617
|
-
|
|
608
|
+
interface SiteMarkedAsTemplate {
|
|
618
609
|
}
|
|
619
|
-
|
|
610
|
+
interface SiteMarkedAsWixSite {
|
|
620
611
|
}
|
|
621
612
|
/**
|
|
622
613
|
* Represents a service provisioned a site.
|
|
@@ -633,7 +624,7 @@ export interface SiteMarkedAsWixSite {
|
|
|
633
624
|
* changes made to the original template afterward.
|
|
634
625
|
* To ensure this, the TPA on the template gets a new instance_id.
|
|
635
626
|
*/
|
|
636
|
-
|
|
627
|
+
interface ServiceProvisioned {
|
|
637
628
|
/**
|
|
638
629
|
* Either UUID or EmbeddedServiceType.
|
|
639
630
|
* @maxLength 36
|
|
@@ -660,7 +651,7 @@ export interface ServiceProvisioned {
|
|
|
660
651
|
*/
|
|
661
652
|
originMetaSiteId?: string | null;
|
|
662
653
|
}
|
|
663
|
-
|
|
654
|
+
interface ServiceRemoved {
|
|
664
655
|
/**
|
|
665
656
|
* Either UUID or EmbeddedServiceType.
|
|
666
657
|
* @maxLength 36
|
|
@@ -678,7 +669,7 @@ export interface ServiceRemoved {
|
|
|
678
669
|
version?: string | null;
|
|
679
670
|
}
|
|
680
671
|
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
681
|
-
|
|
672
|
+
interface SiteRenamed {
|
|
682
673
|
/**
|
|
683
674
|
* A new meta site name (URL slug).
|
|
684
675
|
* @maxLength 20
|
|
@@ -695,21 +686,21 @@ export interface SiteRenamed {
|
|
|
695
686
|
*
|
|
696
687
|
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
697
688
|
*/
|
|
698
|
-
|
|
689
|
+
interface SiteHardDeleted {
|
|
699
690
|
/** A deletion context. */
|
|
700
691
|
deleteContext?: DeleteContext;
|
|
701
692
|
}
|
|
702
|
-
|
|
693
|
+
interface NamespaceChanged {
|
|
703
694
|
/** A previous namespace. */
|
|
704
|
-
oldNamespace?:
|
|
695
|
+
oldNamespace?: NamespaceWithLiterals;
|
|
705
696
|
/** A new namespace. */
|
|
706
|
-
newNamespace?:
|
|
697
|
+
newNamespace?: NamespaceWithLiterals;
|
|
707
698
|
}
|
|
708
699
|
/** Assigned Studio editor */
|
|
709
|
-
|
|
700
|
+
interface StudioAssigned {
|
|
710
701
|
}
|
|
711
702
|
/** Unassigned Studio editor */
|
|
712
|
-
|
|
703
|
+
interface StudioUnassigned {
|
|
713
704
|
}
|
|
714
705
|
/**
|
|
715
706
|
* Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
|
|
@@ -719,13 +710,13 @@ export interface StudioUnassigned {
|
|
|
719
710
|
*
|
|
720
711
|
* https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
|
|
721
712
|
*/
|
|
722
|
-
|
|
713
|
+
interface SiteUrlChanged {
|
|
723
714
|
}
|
|
724
715
|
/**
|
|
725
716
|
* Used at the end of the deletion flow for both draft sites and when a user deletes a site.
|
|
726
717
|
* Consumed by other teams to remove relevant data.
|
|
727
718
|
*/
|
|
728
|
-
|
|
719
|
+
interface SitePurgedExternally {
|
|
729
720
|
/**
|
|
730
721
|
* @maxLength 2048
|
|
731
722
|
* @maxSize 100
|
|
@@ -735,20 +726,20 @@ export interface SitePurgedExternally {
|
|
|
735
726
|
appDefId?: string[];
|
|
736
727
|
}
|
|
737
728
|
/** Assigned Odeditor */
|
|
738
|
-
|
|
729
|
+
interface OdeditorAssigned {
|
|
739
730
|
}
|
|
740
731
|
/** Unassigned Odeditor */
|
|
741
|
-
|
|
732
|
+
interface OdeditorUnassigned {
|
|
742
733
|
}
|
|
743
734
|
/** Assigned Picasso editor */
|
|
744
|
-
|
|
735
|
+
interface PicassoAssigned {
|
|
745
736
|
}
|
|
746
737
|
/** Unassigned Picasso */
|
|
747
|
-
|
|
738
|
+
interface PicassoUnassigned {
|
|
748
739
|
}
|
|
749
|
-
|
|
740
|
+
interface Empty {
|
|
750
741
|
}
|
|
751
|
-
|
|
742
|
+
interface FeatureEvent extends FeatureEventEventOneOf {
|
|
752
743
|
/**
|
|
753
744
|
* Information about an event that makes a feature eligible to the user.
|
|
754
745
|
* Triggered for example, for new features or when a feature is reassigned
|
|
@@ -782,7 +773,7 @@ export interface FeatureEvent extends FeatureEventEventOneOf {
|
|
|
782
773
|
timestamp?: Date | null;
|
|
783
774
|
}
|
|
784
775
|
/** @oneof */
|
|
785
|
-
|
|
776
|
+
interface FeatureEventEventOneOf {
|
|
786
777
|
/**
|
|
787
778
|
* Information about an event that makes a feature eligible to the user.
|
|
788
779
|
* Triggered for example, for new features or when a feature is reassigned
|
|
@@ -811,7 +802,7 @@ export interface FeatureEventEventOneOf {
|
|
|
811
802
|
cancelled?: FeatureCancelled;
|
|
812
803
|
}
|
|
813
804
|
/** Feature created or enabled after disabled state */
|
|
814
|
-
|
|
805
|
+
interface FeatureEnabled extends FeatureEnabledReasonOneOf {
|
|
815
806
|
/** Information about a transfer from another account. */
|
|
816
807
|
transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
|
|
817
808
|
/** Information about a transfer from another site. */
|
|
@@ -842,7 +833,7 @@ export interface FeatureEnabled extends FeatureEnabledReasonOneOf {
|
|
|
842
833
|
reassignedFromMetasite?: string | null;
|
|
843
834
|
}
|
|
844
835
|
/** @oneof */
|
|
845
|
-
|
|
836
|
+
interface FeatureEnabledReasonOneOf {
|
|
846
837
|
/** Information about a transfer from another account. */
|
|
847
838
|
transferredFromAnotherAccount?: TransferredFromAnotherAccountReason;
|
|
848
839
|
/** Information about a transfer from another site. */
|
|
@@ -858,7 +849,7 @@ export interface FeatureEnabledReasonOneOf {
|
|
|
858
849
|
/** Information about a feature that was migrated from legacy. */
|
|
859
850
|
migratedFromLegacy?: MigratedFromLegacyReason;
|
|
860
851
|
}
|
|
861
|
-
|
|
852
|
+
interface Feature extends FeatureQuantityInfoOneOf {
|
|
862
853
|
/**
|
|
863
854
|
* Deprecated. Use `enabled` instead.
|
|
864
855
|
* @deprecated
|
|
@@ -875,7 +866,7 @@ export interface Feature extends FeatureQuantityInfoOneOf {
|
|
|
875
866
|
* `{"id": "DEFAULT"}`. Use `uniqueName` as unique identifier for a feature.
|
|
876
867
|
* @readonly
|
|
877
868
|
*/
|
|
878
|
-
|
|
869
|
+
_id?: string;
|
|
879
870
|
/**
|
|
880
871
|
* Unique name of the feature. Only lower case letters, numbers, and dashes
|
|
881
872
|
* `-` are supported. Used in the endpoints of the
|
|
@@ -939,7 +930,7 @@ export interface Feature extends FeatureQuantityInfoOneOf {
|
|
|
939
930
|
metadata?: Record<string, string>;
|
|
940
931
|
}
|
|
941
932
|
/** @oneof */
|
|
942
|
-
|
|
933
|
+
interface FeatureQuantityInfoOneOf {
|
|
943
934
|
/**
|
|
944
935
|
* Deprecated. Use `enabled` instead.
|
|
945
936
|
* @deprecated
|
|
@@ -956,7 +947,7 @@ export interface FeatureQuantityInfoOneOf {
|
|
|
956
947
|
* Note: Do not confuse with feature scope which is configured in the product catalog
|
|
957
948
|
* and defines in which context the product can be used
|
|
958
949
|
*/
|
|
959
|
-
|
|
950
|
+
interface FeatureContext {
|
|
960
951
|
/**
|
|
961
952
|
* ID of the Wix account that the feature instance belongs to.
|
|
962
953
|
* Available for both site and account level feature instances.
|
|
@@ -976,19 +967,19 @@ export interface FeatureContext {
|
|
|
976
967
|
* A feature that can be either "enabled" or "disabled". The default/freemium setting is always OFF, and the premium setting is always ON (meaning, unlimited usage without tracking).
|
|
977
968
|
* A boolean feature is similar to a quantitive feature with a default limit of 0 and UNLIMITED premium limit (although a bit simplified).
|
|
978
969
|
*/
|
|
979
|
-
|
|
970
|
+
interface BooleanFeature {
|
|
980
971
|
}
|
|
981
972
|
/** A feature with a periodic usage limitation. The default limit is defined in the Feature Spec, the Premium limits are defined in the respective ProductFeature. */
|
|
982
|
-
|
|
973
|
+
interface QuotaFeature {
|
|
983
974
|
/** Default (or Freemium) quota limitation. if left undefined the free feature has unlimited amount. */
|
|
984
975
|
limit?: string | null;
|
|
985
976
|
/** Periodic time-frame to reset the usage counter. You may use NO_PERIOD if counter shouldn't be reset. */
|
|
986
|
-
period?:
|
|
977
|
+
period?: FeaturePeriodWithLiterals;
|
|
987
978
|
/** Usage measurement units (seconds? MBs? unitless?). Usage reported will be counted in multiples of this basic unit. */
|
|
988
979
|
units?: string | null;
|
|
989
980
|
}
|
|
990
981
|
/** Determines the reset cycle of the feature usage. */
|
|
991
|
-
|
|
982
|
+
declare enum FeaturePeriod {
|
|
992
983
|
NO_PERIOD = "NO_PERIOD",
|
|
993
984
|
MILLISECOND = "MILLISECOND",
|
|
994
985
|
SECOND = "SECOND",
|
|
@@ -999,7 +990,9 @@ export declare enum FeaturePeriod {
|
|
|
999
990
|
MONTH = "MONTH",
|
|
1000
991
|
YEAR = "YEAR"
|
|
1001
992
|
}
|
|
1002
|
-
|
|
993
|
+
/** @enumType */
|
|
994
|
+
type FeaturePeriodWithLiterals = FeaturePeriod | 'NO_PERIOD' | 'MILLISECOND' | 'SECOND' | 'MINUTE' | 'HOUR' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
995
|
+
interface QuotaInfo {
|
|
1003
996
|
/**
|
|
1004
997
|
* How often the customer is allowed to use the feature during the specified
|
|
1005
998
|
* period. `null` means that the customer has unlimited access to the feature.
|
|
@@ -1011,7 +1004,7 @@ export interface QuotaInfo {
|
|
|
1011
1004
|
* You may still manually call
|
|
1012
1005
|
* [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter).
|
|
1013
1006
|
*/
|
|
1014
|
-
period?:
|
|
1007
|
+
period?: FeaturePeriodWithLiterals;
|
|
1015
1008
|
/**
|
|
1016
1009
|
* How often the customer has used the feature during the current
|
|
1017
1010
|
* period.
|
|
@@ -1030,7 +1023,7 @@ export interface QuotaInfo {
|
|
|
1030
1023
|
remainingUsage?: string | null;
|
|
1031
1024
|
}
|
|
1032
1025
|
/** Subscription transferred from another account, features on the current account were enabled. */
|
|
1033
|
-
|
|
1026
|
+
interface TransferredFromAnotherAccountReason {
|
|
1034
1027
|
/**
|
|
1035
1028
|
* Information about a transfer from another account.
|
|
1036
1029
|
* @format GUID
|
|
@@ -1038,7 +1031,7 @@ export interface TransferredFromAnotherAccountReason {
|
|
|
1038
1031
|
transferredFromAccount?: string;
|
|
1039
1032
|
}
|
|
1040
1033
|
/** Subscription moved from one site to another in the same account, features enabled on the target site */
|
|
1041
|
-
|
|
1034
|
+
interface ReassignedFromSiteReason {
|
|
1042
1035
|
/**
|
|
1043
1036
|
* Information about a transfer from another site.
|
|
1044
1037
|
* @format GUID
|
|
@@ -1046,22 +1039,22 @@ export interface ReassignedFromSiteReason {
|
|
|
1046
1039
|
reassignedFromMetasite?: string;
|
|
1047
1040
|
}
|
|
1048
1041
|
/** Subscription was floating and assigned to site, features enabled on the target site */
|
|
1049
|
-
|
|
1042
|
+
interface AssignedFromFloatingReason {
|
|
1050
1043
|
}
|
|
1051
1044
|
/** New subscription created and features created as enabled */
|
|
1052
|
-
|
|
1045
|
+
interface NewFeatureReason {
|
|
1053
1046
|
}
|
|
1054
1047
|
/** Subscription was upgraded or downgraded, as a result new features enabled, missing features disabled , quantities are updated */
|
|
1055
|
-
|
|
1048
|
+
interface ContractSwitchedReason {
|
|
1056
1049
|
}
|
|
1057
1050
|
/** a call to CreateFeature in features-writer, creates feature that is not attached to subscription */
|
|
1058
|
-
|
|
1051
|
+
interface ManualFeatureCreationReason {
|
|
1059
1052
|
}
|
|
1060
1053
|
/** Subscription created due to migration from old premium model */
|
|
1061
|
-
|
|
1054
|
+
interface MigratedFromLegacyReason {
|
|
1062
1055
|
}
|
|
1063
1056
|
/** Feature disabled and can be enabled in the future */
|
|
1064
|
-
|
|
1057
|
+
interface FeatureDisabled extends FeatureDisabledReasonOneOf {
|
|
1065
1058
|
/** Information about a feature that's no longer assigned to a site. */
|
|
1066
1059
|
unassingedToFloating?: UnAssingedToFloatingReason;
|
|
1067
1060
|
/**
|
|
@@ -1086,7 +1079,7 @@ export interface FeatureDisabled extends FeatureDisabledReasonOneOf {
|
|
|
1086
1079
|
metaSiteId?: string | null;
|
|
1087
1080
|
}
|
|
1088
1081
|
/** @oneof */
|
|
1089
|
-
|
|
1082
|
+
interface FeatureDisabledReasonOneOf {
|
|
1090
1083
|
/** Information about a feature that's no longer assigned to a site. */
|
|
1091
1084
|
unassingedToFloating?: UnAssingedToFloatingReason;
|
|
1092
1085
|
/**
|
|
@@ -1101,13 +1094,13 @@ export interface FeatureDisabledReasonOneOf {
|
|
|
1101
1094
|
reassignedToAnotherSite?: ReassignedToAnotherSiteReason;
|
|
1102
1095
|
}
|
|
1103
1096
|
/** Subscription was unassigned from the site and moved into floating state */
|
|
1104
|
-
|
|
1097
|
+
interface UnAssingedToFloatingReason {
|
|
1105
1098
|
}
|
|
1106
1099
|
/** Another subscription was assigned to the site, causing existing features on this site to be disabled */
|
|
1107
|
-
|
|
1100
|
+
interface ReplacedByAnotherSubscriptionReason {
|
|
1108
1101
|
}
|
|
1109
1102
|
/** Subscription was assigned to another site, causing features on the origin site to be disabled. */
|
|
1110
|
-
|
|
1103
|
+
interface ReassignedToAnotherSiteReason {
|
|
1111
1104
|
/**
|
|
1112
1105
|
* Information about a transfer to the site.
|
|
1113
1106
|
* @format GUID
|
|
@@ -1115,7 +1108,7 @@ export interface ReassignedToAnotherSiteReason {
|
|
|
1115
1108
|
reassignedToMetasite?: string;
|
|
1116
1109
|
}
|
|
1117
1110
|
/** Feature updated, for example Quota was increased due to upgrade */
|
|
1118
|
-
|
|
1111
|
+
interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf, FeatureUpdatedReasonOneOf {
|
|
1119
1112
|
/** Information about a feature that doesn't have a usage quota. */
|
|
1120
1113
|
booleanFeature?: BooleanFeature;
|
|
1121
1114
|
/** Information about a feature that has a usage quota. */
|
|
@@ -1129,19 +1122,19 @@ export interface FeatureUpdated extends FeatureUpdatedPreviousQuantityInfoOneOf,
|
|
|
1129
1122
|
feature?: Feature;
|
|
1130
1123
|
}
|
|
1131
1124
|
/** @oneof */
|
|
1132
|
-
|
|
1125
|
+
interface FeatureUpdatedPreviousQuantityInfoOneOf {
|
|
1133
1126
|
/** Information about a feature that doesn't have a usage quota. */
|
|
1134
1127
|
booleanFeature?: BooleanFeature;
|
|
1135
1128
|
/** Information about a feature that has a usage quota. */
|
|
1136
1129
|
quotaFeature?: QuotaFeature;
|
|
1137
1130
|
}
|
|
1138
1131
|
/** @oneof */
|
|
1139
|
-
|
|
1132
|
+
interface FeatureUpdatedReasonOneOf {
|
|
1140
1133
|
/** Information about the contract switch. */
|
|
1141
1134
|
contractSwitched?: ContractSwitchedReason;
|
|
1142
1135
|
}
|
|
1143
1136
|
/** Feature was permanently cancelled */
|
|
1144
|
-
|
|
1137
|
+
interface FeatureCancelled extends FeatureCancelledReasonOneOf {
|
|
1145
1138
|
/** Information about a transfer to the account. */
|
|
1146
1139
|
transferredToAnotherAccount?: TransferredToAnotherAccountReason;
|
|
1147
1140
|
/** Information about the contract switch. */
|
|
@@ -1158,7 +1151,7 @@ export interface FeatureCancelled extends FeatureCancelledReasonOneOf {
|
|
|
1158
1151
|
transferredToAccount?: string | null;
|
|
1159
1152
|
}
|
|
1160
1153
|
/** @oneof */
|
|
1161
|
-
|
|
1154
|
+
interface FeatureCancelledReasonOneOf {
|
|
1162
1155
|
/** Information about a transfer to the account. */
|
|
1163
1156
|
transferredToAnotherAccount?: TransferredToAnotherAccountReason;
|
|
1164
1157
|
/** Information about the contract switch. */
|
|
@@ -1167,7 +1160,7 @@ export interface FeatureCancelledReasonOneOf {
|
|
|
1167
1160
|
cancelRequest?: CancelRequestedReason;
|
|
1168
1161
|
}
|
|
1169
1162
|
/** Subscription was transferred to another account, features in the origin account were cancelled */
|
|
1170
|
-
|
|
1163
|
+
interface TransferredToAnotherAccountReason {
|
|
1171
1164
|
/**
|
|
1172
1165
|
* Information about a transfer to the account.
|
|
1173
1166
|
* @format GUID
|
|
@@ -1175,15 +1168,15 @@ export interface TransferredToAnotherAccountReason {
|
|
|
1175
1168
|
transferredToAccount?: string;
|
|
1176
1169
|
}
|
|
1177
1170
|
/** Cancellation was requested from the subscription manager api, might be a result of billing event, or direct call */
|
|
1178
|
-
|
|
1171
|
+
interface CancelRequestedReason {
|
|
1179
1172
|
}
|
|
1180
|
-
|
|
1173
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
1181
1174
|
createdEvent?: EntityCreatedEvent;
|
|
1182
1175
|
updatedEvent?: EntityUpdatedEvent;
|
|
1183
1176
|
deletedEvent?: EntityDeletedEvent;
|
|
1184
1177
|
actionEvent?: ActionEvent;
|
|
1185
1178
|
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1186
|
-
|
|
1179
|
+
_id?: string;
|
|
1187
1180
|
/**
|
|
1188
1181
|
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1189
1182
|
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
@@ -1212,36 +1205,34 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
1212
1205
|
entityEventSequence?: string | null;
|
|
1213
1206
|
}
|
|
1214
1207
|
/** @oneof */
|
|
1215
|
-
|
|
1208
|
+
interface DomainEventBodyOneOf {
|
|
1216
1209
|
createdEvent?: EntityCreatedEvent;
|
|
1217
1210
|
updatedEvent?: EntityUpdatedEvent;
|
|
1218
1211
|
deletedEvent?: EntityDeletedEvent;
|
|
1219
1212
|
actionEvent?: ActionEvent;
|
|
1220
1213
|
}
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
/** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
|
|
1224
|
-
restoreInfo?: RestoreInfo;
|
|
1214
|
+
interface EntityCreatedEvent {
|
|
1215
|
+
entity?: string;
|
|
1225
1216
|
}
|
|
1226
|
-
|
|
1217
|
+
interface RestoreInfo {
|
|
1227
1218
|
deletedDate?: Date | null;
|
|
1228
1219
|
}
|
|
1229
|
-
|
|
1220
|
+
interface EntityUpdatedEvent {
|
|
1230
1221
|
/**
|
|
1231
1222
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
1232
1223
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
1233
1224
|
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
1234
1225
|
*/
|
|
1235
|
-
|
|
1226
|
+
currentEntity?: string;
|
|
1236
1227
|
}
|
|
1237
|
-
|
|
1228
|
+
interface EntityDeletedEvent {
|
|
1238
1229
|
/** Entity that was deleted. */
|
|
1239
|
-
|
|
1230
|
+
deletedEntity?: string | null;
|
|
1240
1231
|
}
|
|
1241
|
-
|
|
1242
|
-
|
|
1232
|
+
interface ActionEvent {
|
|
1233
|
+
body?: string;
|
|
1243
1234
|
}
|
|
1244
|
-
|
|
1235
|
+
interface MessageEnvelope {
|
|
1245
1236
|
/**
|
|
1246
1237
|
* App instance ID.
|
|
1247
1238
|
* @format GUID
|
|
@@ -1257,7 +1248,7 @@ export interface MessageEnvelope {
|
|
|
1257
1248
|
/** Stringify payload. */
|
|
1258
1249
|
data?: string;
|
|
1259
1250
|
}
|
|
1260
|
-
|
|
1251
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
1261
1252
|
/**
|
|
1262
1253
|
* ID of a site visitor that has not logged in to the site.
|
|
1263
1254
|
* @format GUID
|
|
@@ -1279,10 +1270,10 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1279
1270
|
*/
|
|
1280
1271
|
appId?: string;
|
|
1281
1272
|
/** @readonly */
|
|
1282
|
-
identityType?:
|
|
1273
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1283
1274
|
}
|
|
1284
1275
|
/** @oneof */
|
|
1285
|
-
|
|
1276
|
+
interface IdentificationDataIdOneOf {
|
|
1286
1277
|
/**
|
|
1287
1278
|
* ID of a site visitor that has not logged in to the site.
|
|
1288
1279
|
* @format GUID
|
|
@@ -1304,10 +1295,62 @@ export interface IdentificationDataIdOneOf {
|
|
|
1304
1295
|
*/
|
|
1305
1296
|
appId?: string;
|
|
1306
1297
|
}
|
|
1307
|
-
|
|
1298
|
+
declare enum WebhookIdentityType {
|
|
1308
1299
|
UNKNOWN = "UNKNOWN",
|
|
1309
1300
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1310
1301
|
MEMBER = "MEMBER",
|
|
1311
1302
|
WIX_USER = "WIX_USER",
|
|
1312
1303
|
APP = "APP"
|
|
1313
1304
|
}
|
|
1305
|
+
/** @enumType */
|
|
1306
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1307
|
+
interface BaseEventMetadata {
|
|
1308
|
+
/**
|
|
1309
|
+
* App instance ID.
|
|
1310
|
+
* @format GUID
|
|
1311
|
+
*/
|
|
1312
|
+
instanceId?: string | null;
|
|
1313
|
+
/**
|
|
1314
|
+
* Event type.
|
|
1315
|
+
* @maxLength 150
|
|
1316
|
+
*/
|
|
1317
|
+
eventType?: string;
|
|
1318
|
+
/** The identification type and identity data. */
|
|
1319
|
+
identity?: IdentificationData;
|
|
1320
|
+
}
|
|
1321
|
+
interface EventMetadata extends BaseEventMetadata {
|
|
1322
|
+
/** Event ID. With this ID you can easily spot duplicated events and ignore them. */
|
|
1323
|
+
_id?: string;
|
|
1324
|
+
/**
|
|
1325
|
+
* Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
|
|
1326
|
+
* For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
|
|
1327
|
+
*/
|
|
1328
|
+
entityFqdn?: string;
|
|
1329
|
+
/**
|
|
1330
|
+
* Event action name, placed at the top level to make it easier for users to dispatch messages.
|
|
1331
|
+
* For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
|
|
1332
|
+
*/
|
|
1333
|
+
slug?: string;
|
|
1334
|
+
/** ID of the entity associated with the event. */
|
|
1335
|
+
entityId?: string;
|
|
1336
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
|
|
1337
|
+
eventTime?: Date | null;
|
|
1338
|
+
/**
|
|
1339
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1340
|
+
* (for example, GDPR).
|
|
1341
|
+
*/
|
|
1342
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1343
|
+
/** If present, indicates the action that triggered the event. */
|
|
1344
|
+
originatedFrom?: string | null;
|
|
1345
|
+
/**
|
|
1346
|
+
* A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
|
|
1347
|
+
* You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
|
|
1348
|
+
*/
|
|
1349
|
+
entityEventSequence?: string | null;
|
|
1350
|
+
}
|
|
1351
|
+
interface ProgramUpdatedEnvelope {
|
|
1352
|
+
entity: LoyaltyProgram;
|
|
1353
|
+
metadata: EventMetadata;
|
|
1354
|
+
}
|
|
1355
|
+
|
|
1356
|
+
export { type SiteUnpublished as $, type ActivateLoyaltyProgramResponse as A, type BulkGetLoyaltyProgramResponse as B, type GetLoyaltyProgramPremiumFeaturesRequest as C, type DisablePointsExpirationResponse as D, type EnablePointsExpirationResponse as E, FeaturePeriod as F, type GetLoyaltyProgramResponse as G, type EnablePointsExpirationRequest as H, type PointsExpirationEnabled as I, type DisablePointsExpirationRequest as J, type PointsExpirationDisabled as K, type LoyaltyProgram as L, type MetaSiteSpecialEvent as M, Namespace as N, type MetaSiteSpecialEventPayloadOneOf as O, type PauseLoyaltyProgramResponse as P, type Asset as Q, type SiteCreated as R, Status as S, Type as T, type UpdateLoyaltyProgramResponse as U, type SiteTransferred as V, WebhookIdentityType as W, type SiteDeleted as X, type DeleteContext as Y, type SiteUndeleted as Z, type SitePublished as _, type GetLoyaltyProgramPremiumFeaturesResponse as a, type SiteMarkedAsTemplate as a0, type SiteMarkedAsWixSite as a1, type ServiceProvisioned as a2, type ServiceRemoved as a3, type SiteRenamed as a4, type SiteHardDeleted as a5, type NamespaceChanged as a6, type StudioAssigned as a7, type StudioUnassigned as a8, type SiteUrlChanged as a9, type ReplacedByAnotherSubscriptionReason as aA, type ReassignedToAnotherSiteReason as aB, type FeatureUpdated as aC, type FeatureUpdatedPreviousQuantityInfoOneOf as aD, type FeatureUpdatedReasonOneOf as aE, type FeatureCancelled as aF, type FeatureCancelledReasonOneOf as aG, type TransferredToAnotherAccountReason as aH, type CancelRequestedReason as aI, type DomainEvent as aJ, type DomainEventBodyOneOf as aK, type EntityCreatedEvent as aL, type RestoreInfo as aM, type EntityUpdatedEvent as aN, type EntityDeletedEvent as aO, type ActionEvent as aP, type MessageEnvelope as aQ, type IdentificationData as aR, type IdentificationDataIdOneOf as aS, type BaseEventMetadata as aT, type EventMetadata as aU, type SitePurgedExternally as aa, type OdeditorAssigned as ab, type OdeditorUnassigned as ac, type PicassoAssigned as ad, type PicassoUnassigned as ae, type Empty as af, type FeatureEvent as ag, type FeatureEventEventOneOf as ah, type FeatureEnabled as ai, type FeatureEnabledReasonOneOf as aj, type Feature as ak, type FeatureQuantityInfoOneOf as al, type FeatureContext as am, type BooleanFeature as an, type QuotaFeature as ao, type QuotaInfo as ap, type TransferredFromAnotherAccountReason as aq, type ReassignedFromSiteReason as ar, type AssignedFromFloatingReason as as, type NewFeatureReason as at, type ContractSwitchedReason as au, type ManualFeatureCreationReason as av, type MigratedFromLegacyReason as aw, type FeatureDisabled as ax, type FeatureDisabledReasonOneOf as ay, type UnAssingedToFloatingReason as az, type ProgramUpdatedEnvelope as b, ProgramStatus as c, State as d, SiteCreatedContext as e, DeleteStatus as f, type PointDefinition as g, type FocalPoint as h, type PointsExpiration as i, type PremiumFeatures as j, type SocialMediaSettings as k, type SocialMediaChannel as l, type GetLoyaltyProgramRequest as m, type BulkGetLoyaltyProgramRequest as n, type ProgramInSite as o, type UpdateLoyaltyProgramRequest as p, type PointsExpirationConfigurationChanged as q, type PointsExpirationChanges as r, type ActivateLoyaltyProgramRequest as s, type LoyaltyProgramActivated as t, type PauseLoyaltyProgramRequest as u, type GetLoyaltyProgramDescriptionRequest as v, type GetLoyaltyProgramDescriptionResponse as w, type UpdateLoyaltyProgramDescriptionRequest as x, type UpdateLoyaltyProgramDescriptionResponse as y, type LoyaltyProgramDescriptionUpdated as z };
|