@wix/referral 1.0.5 → 1.0.7
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/context.d.ts +1 -0
- package/build/cjs/context.js +2 -1
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +1 -0
- package/build/cjs/index.js +2 -1
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +1 -0
- package/build/cjs/meta.js +2 -1
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +1 -0
- package/build/es/context.js +1 -0
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +1 -0
- package/build/es/index.js +1 -0
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +1 -0
- package/build/es/meta.js +1 -0
- package/build/es/meta.js.map +1 -1
- package/package.json +8 -7
- package/type-bundles/context.bundle.d.ts +3157 -863
- package/type-bundles/index.bundle.d.ts +1798 -461
- package/type-bundles/meta.bundle.d.ts +1114 -425
|
@@ -1,3 +1,1605 @@
|
|
|
1
|
+
/** ReferralProgram is the main entity of ReferralPrograms that can be used to manage the program. */
|
|
2
|
+
interface ReferralProgram {
|
|
3
|
+
/** Referral program name. */
|
|
4
|
+
name?: string | null;
|
|
5
|
+
/**
|
|
6
|
+
* Referral program status.
|
|
7
|
+
* @readonly
|
|
8
|
+
*/
|
|
9
|
+
status?: ProgramStatus;
|
|
10
|
+
/** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision. */
|
|
11
|
+
revision?: string | null;
|
|
12
|
+
/**
|
|
13
|
+
* Program's creation date and time.
|
|
14
|
+
* @readonly
|
|
15
|
+
*/
|
|
16
|
+
_createdDate?: Date;
|
|
17
|
+
/**
|
|
18
|
+
* Program's last update date and time
|
|
19
|
+
* @readonly
|
|
20
|
+
*/
|
|
21
|
+
_updatedDate?: Date;
|
|
22
|
+
/** Referred friend reward configuration. */
|
|
23
|
+
referredFriendReward?: Reward$2;
|
|
24
|
+
/** Referring customer reward configuration. */
|
|
25
|
+
referringCustomerReward?: Reward$2;
|
|
26
|
+
/** List of actions that complete referral. */
|
|
27
|
+
successfulReferralActions?: Action[];
|
|
28
|
+
/**
|
|
29
|
+
* Set to true if user has required plan to activate program.
|
|
30
|
+
* @readonly
|
|
31
|
+
* @deprecated Set to true if user has required plan to activate program.
|
|
32
|
+
* @replacedBy GetReferralProgramPremiumFeatures
|
|
33
|
+
* @targetRemovalDate 2024-09-01
|
|
34
|
+
*/
|
|
35
|
+
isPremium?: boolean;
|
|
36
|
+
/** Emails configuration. */
|
|
37
|
+
emails?: Emails;
|
|
38
|
+
}
|
|
39
|
+
declare enum ProgramStatus {
|
|
40
|
+
/** unknown status. */
|
|
41
|
+
UNKNOWN = "UNKNOWN",
|
|
42
|
+
/** initial program status (program was created but was not enabled yet). */
|
|
43
|
+
DRAFT = "DRAFT",
|
|
44
|
+
/** program is active. */
|
|
45
|
+
ACTIVE = "ACTIVE",
|
|
46
|
+
/** program was manually disabled by the user (this action can be reverted, meaning user can set it to be active again). */
|
|
47
|
+
PAUSED = "PAUSED"
|
|
48
|
+
}
|
|
49
|
+
interface Reward$2 extends RewardOptionsOneOf$1 {
|
|
50
|
+
/** Options for coupon reward type. */
|
|
51
|
+
couponOptions?: Coupon$2;
|
|
52
|
+
/** Options for Loyalty points reward type. */
|
|
53
|
+
loyaltyPointsOptions?: LoyaltyPoints$2;
|
|
54
|
+
/** Type of the reward. */
|
|
55
|
+
type?: Type$1;
|
|
56
|
+
}
|
|
57
|
+
/** @oneof */
|
|
58
|
+
interface RewardOptionsOneOf$1 {
|
|
59
|
+
/** Options for coupon reward type. */
|
|
60
|
+
couponOptions?: Coupon$2;
|
|
61
|
+
/** Options for Loyalty points reward type. */
|
|
62
|
+
loyaltyPointsOptions?: LoyaltyPoints$2;
|
|
63
|
+
}
|
|
64
|
+
declare enum Type$1 {
|
|
65
|
+
/** Unknown reward type. */
|
|
66
|
+
UNKNOWN = "UNKNOWN",
|
|
67
|
+
/** Coupon reward type. */
|
|
68
|
+
COUPON = "COUPON",
|
|
69
|
+
/** Loyalty points reward type. */
|
|
70
|
+
LOYALTY_POINTS = "LOYALTY_POINTS",
|
|
71
|
+
/** No reward type. */
|
|
72
|
+
NOTHING = "NOTHING"
|
|
73
|
+
}
|
|
74
|
+
interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSubtotalOneOf$2 {
|
|
75
|
+
/** Options for fixed amount discount type. */
|
|
76
|
+
fixedAmountOptions?: FixedAmountDiscount$2;
|
|
77
|
+
/** Options for percentage discount type. */
|
|
78
|
+
percentageOptions?: PercentageDiscount$2;
|
|
79
|
+
/** Limit the coupon to carts with a subtotal above this number. */
|
|
80
|
+
minimumSubtotal?: number;
|
|
81
|
+
/** Specifies the type of line items this coupon will apply to. */
|
|
82
|
+
scope?: CouponScope$2;
|
|
83
|
+
/** Coupon name. */
|
|
84
|
+
name?: string;
|
|
85
|
+
/** Coupon discount type. */
|
|
86
|
+
discountType?: DiscountType$2;
|
|
87
|
+
/** Limit the coupon to only apply to one item in cart. */
|
|
88
|
+
limitedToOneItem?: boolean | null;
|
|
89
|
+
/** If true, coupon also applies to subscriptions. */
|
|
90
|
+
appliesToSubscriptions?: boolean | null;
|
|
91
|
+
/** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
|
|
92
|
+
discountedCycleCount?: number | null;
|
|
93
|
+
}
|
|
94
|
+
/** @oneof */
|
|
95
|
+
interface CouponDiscountTypeOptionsOneOf$2 {
|
|
96
|
+
/** Options for fixed amount discount type. */
|
|
97
|
+
fixedAmountOptions?: FixedAmountDiscount$2;
|
|
98
|
+
/** Options for percentage discount type. */
|
|
99
|
+
percentageOptions?: PercentageDiscount$2;
|
|
100
|
+
}
|
|
101
|
+
/** @oneof */
|
|
102
|
+
interface CouponScopeOrMinSubtotalOneOf$2 {
|
|
103
|
+
/** Limit the coupon to carts with a subtotal above this number. */
|
|
104
|
+
minimumSubtotal?: number;
|
|
105
|
+
/** Specifies the type of line items this coupon will apply to. */
|
|
106
|
+
scope?: CouponScope$2;
|
|
107
|
+
}
|
|
108
|
+
declare enum DiscountType$2 {
|
|
109
|
+
/** Unknown discount type. */
|
|
110
|
+
UNKNOWN = "UNKNOWN",
|
|
111
|
+
/** Discount as a fixed amount. */
|
|
112
|
+
FIXED_AMOUNT = "FIXED_AMOUNT",
|
|
113
|
+
/** Discount as a percentage. */
|
|
114
|
+
PERCENTAGE = "PERCENTAGE",
|
|
115
|
+
/** Free shipping. */
|
|
116
|
+
FREE_SHIPPING = "FREE_SHIPPING"
|
|
117
|
+
}
|
|
118
|
+
interface FixedAmountDiscount$2 {
|
|
119
|
+
/** Fixed amount to discount. */
|
|
120
|
+
amount?: number;
|
|
121
|
+
}
|
|
122
|
+
interface PercentageDiscount$2 {
|
|
123
|
+
/** Percentage to discount. */
|
|
124
|
+
percentage?: number;
|
|
125
|
+
}
|
|
126
|
+
interface CouponScope$2 {
|
|
127
|
+
/** Namespace of the coupon scope. */
|
|
128
|
+
namespace?: string;
|
|
129
|
+
/** Group of the coupon scope. */
|
|
130
|
+
group?: Group$2;
|
|
131
|
+
}
|
|
132
|
+
interface Group$2 {
|
|
133
|
+
/** Name of the group. */
|
|
134
|
+
name?: string;
|
|
135
|
+
/** Entity ID of the group. */
|
|
136
|
+
entityId?: string | null;
|
|
137
|
+
}
|
|
138
|
+
interface LoyaltyPoints$2 {
|
|
139
|
+
/** Amount of points to give. */
|
|
140
|
+
amount?: number;
|
|
141
|
+
}
|
|
142
|
+
declare enum Action {
|
|
143
|
+
/** Unknown action. */
|
|
144
|
+
UNKNOWN = "UNKNOWN",
|
|
145
|
+
/** Store order placed. */
|
|
146
|
+
STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
|
|
147
|
+
/** Pricing plan ordered. */
|
|
148
|
+
PLAN_ORDERED = "PLAN_ORDERED",
|
|
149
|
+
/** Wix events ticket ordered. */
|
|
150
|
+
TICKET_ORDERED = "TICKET_ORDERED",
|
|
151
|
+
/** Bookings session booked. */
|
|
152
|
+
SESSION_BOOKED = "SESSION_BOOKED",
|
|
153
|
+
/** Restaurant order placed. */
|
|
154
|
+
RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
|
|
155
|
+
}
|
|
156
|
+
interface Emails {
|
|
157
|
+
/** Encourage customers to refer their friends email. Select for which apps to enable. */
|
|
158
|
+
encourageToReferFriends?: App[];
|
|
159
|
+
/** Notify customers about their referral reward email. Set true to enable email. */
|
|
160
|
+
notifyCustomersAboutReward?: boolean;
|
|
161
|
+
}
|
|
162
|
+
declare enum App {
|
|
163
|
+
/** Unknown app. */
|
|
164
|
+
UNKNOWN = "UNKNOWN",
|
|
165
|
+
/** Wix stores. */
|
|
166
|
+
STORES = "STORES",
|
|
167
|
+
/** Wix pricing plans. */
|
|
168
|
+
PRICING_PLANS = "PRICING_PLANS",
|
|
169
|
+
/** Wix events. */
|
|
170
|
+
EVENTS = "EVENTS",
|
|
171
|
+
/** Wix bookings. */
|
|
172
|
+
BOOKINGS = "BOOKINGS",
|
|
173
|
+
/** Wix restaurants. */
|
|
174
|
+
RESTAURANTS = "RESTAURANTS"
|
|
175
|
+
}
|
|
176
|
+
interface GetReferralProgramRequest {
|
|
177
|
+
}
|
|
178
|
+
interface GetReferralProgramResponse {
|
|
179
|
+
/** The retrieved ReferralProgram. */
|
|
180
|
+
referralProgram?: ReferralProgram;
|
|
181
|
+
}
|
|
182
|
+
interface BulkGetReferralProgramRequest {
|
|
183
|
+
}
|
|
184
|
+
interface BulkGetReferralProgramResponse {
|
|
185
|
+
/** Referral programs. */
|
|
186
|
+
programInSites?: ProgramInSite[];
|
|
187
|
+
}
|
|
188
|
+
interface ProgramInSite {
|
|
189
|
+
/** Metasite ID. */
|
|
190
|
+
metaSiteId?: string;
|
|
191
|
+
/** Referral program. */
|
|
192
|
+
referralProgram?: ReferralProgram;
|
|
193
|
+
}
|
|
194
|
+
interface QueryReferralProgramsRequest {
|
|
195
|
+
/** Query to filter ReferralPrograms. */
|
|
196
|
+
query: CursorQuery$4;
|
|
197
|
+
}
|
|
198
|
+
interface CursorQuery$4 extends CursorQueryPagingMethodOneOf$4 {
|
|
199
|
+
/**
|
|
200
|
+
* Cursor paging options.
|
|
201
|
+
*
|
|
202
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
203
|
+
*/
|
|
204
|
+
cursorPaging?: CursorPaging$4;
|
|
205
|
+
/**
|
|
206
|
+
* Filter object.
|
|
207
|
+
*
|
|
208
|
+
* Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
209
|
+
*/
|
|
210
|
+
filter?: Record<string, any> | null;
|
|
211
|
+
/**
|
|
212
|
+
* Sort object.
|
|
213
|
+
*
|
|
214
|
+
* Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
215
|
+
*/
|
|
216
|
+
sort?: Sorting$4[];
|
|
217
|
+
}
|
|
218
|
+
/** @oneof */
|
|
219
|
+
interface CursorQueryPagingMethodOneOf$4 {
|
|
220
|
+
/**
|
|
221
|
+
* Cursor paging options.
|
|
222
|
+
*
|
|
223
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
224
|
+
*/
|
|
225
|
+
cursorPaging?: CursorPaging$4;
|
|
226
|
+
}
|
|
227
|
+
interface Sorting$4 {
|
|
228
|
+
/** Name of the field to sort by. */
|
|
229
|
+
fieldName?: string;
|
|
230
|
+
/** Sort order. */
|
|
231
|
+
order?: SortOrder$4;
|
|
232
|
+
}
|
|
233
|
+
declare enum SortOrder$4 {
|
|
234
|
+
ASC = "ASC",
|
|
235
|
+
DESC = "DESC"
|
|
236
|
+
}
|
|
237
|
+
interface CursorPaging$4 {
|
|
238
|
+
/** Maximum number of items to return in the results. */
|
|
239
|
+
limit?: number | null;
|
|
240
|
+
/**
|
|
241
|
+
* Pointer to the next or previous page in the list of results.
|
|
242
|
+
*
|
|
243
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
244
|
+
* Not relevant for the first request.
|
|
245
|
+
*/
|
|
246
|
+
cursor?: string | null;
|
|
247
|
+
}
|
|
248
|
+
interface QueryReferralProgramsResponse {
|
|
249
|
+
/** ReferralPrograms that match the query. */
|
|
250
|
+
referralPrograms?: ReferralProgram[];
|
|
251
|
+
/** Paging metadata. */
|
|
252
|
+
pagingMetadata?: CursorPagingMetadata$4;
|
|
253
|
+
}
|
|
254
|
+
interface CursorPagingMetadata$4 {
|
|
255
|
+
/** Number of items returned in the response. */
|
|
256
|
+
count?: number | null;
|
|
257
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
258
|
+
cursors?: Cursors$4;
|
|
259
|
+
/**
|
|
260
|
+
* Whether there are more pages to retrieve following the current page.
|
|
261
|
+
*
|
|
262
|
+
* + `true`: Another page of results can be retrieved.
|
|
263
|
+
* + `false`: This is the last page.
|
|
264
|
+
*/
|
|
265
|
+
hasNext?: boolean | null;
|
|
266
|
+
}
|
|
267
|
+
interface Cursors$4 {
|
|
268
|
+
/** Cursor string pointing to the next page in the list of results. */
|
|
269
|
+
next?: string | null;
|
|
270
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
271
|
+
prev?: string | null;
|
|
272
|
+
}
|
|
273
|
+
interface UpdateReferralProgramRequest {
|
|
274
|
+
/** ReferralProgram to be updated, may be partial. */
|
|
275
|
+
referralProgram: ReferralProgram;
|
|
276
|
+
}
|
|
277
|
+
interface UpdateReferralProgramResponse {
|
|
278
|
+
/** The updated ReferralProgram. */
|
|
279
|
+
referralProgram?: ReferralProgram;
|
|
280
|
+
}
|
|
281
|
+
interface ActivateReferralProgramRequest {
|
|
282
|
+
}
|
|
283
|
+
interface ActivateReferralProgramResponse {
|
|
284
|
+
/** The activated ReferralProgram. */
|
|
285
|
+
referralProgram?: ReferralProgram;
|
|
286
|
+
}
|
|
287
|
+
interface PauseReferralProgramRequest {
|
|
288
|
+
}
|
|
289
|
+
interface PauseReferralProgramResponse {
|
|
290
|
+
/** The paused ReferralProgram. */
|
|
291
|
+
referralProgram?: ReferralProgram;
|
|
292
|
+
}
|
|
293
|
+
interface GetAISocialMediaPostsSuggestionsRequest {
|
|
294
|
+
/** The topic to generate suggestions for. */
|
|
295
|
+
topic?: string;
|
|
296
|
+
}
|
|
297
|
+
interface GetAISocialMediaPostsSuggestionsResponse {
|
|
298
|
+
/** The generated suggestions. */
|
|
299
|
+
suggestions?: AISocialMediaPostSuggestion[];
|
|
300
|
+
/** The refer friends page URL. */
|
|
301
|
+
referFriendsPageUrl?: string | null;
|
|
302
|
+
}
|
|
303
|
+
interface AISocialMediaPostSuggestion {
|
|
304
|
+
/** The suggested post content. */
|
|
305
|
+
postContent?: string;
|
|
306
|
+
/** The suggested hashtags. */
|
|
307
|
+
hashtags?: string[];
|
|
308
|
+
}
|
|
309
|
+
interface GenerateAISocialMediaPostsSuggestionsRequest {
|
|
310
|
+
/** The topic to generate suggestions for. */
|
|
311
|
+
topic?: string;
|
|
312
|
+
}
|
|
313
|
+
interface GenerateAISocialMediaPostsSuggestionsResponse {
|
|
314
|
+
/** The generated suggestions. */
|
|
315
|
+
suggestions?: AISocialMediaPostSuggestion[];
|
|
316
|
+
/** The refer friends page URL. */
|
|
317
|
+
referFriendsPageUrl?: string | null;
|
|
318
|
+
}
|
|
319
|
+
interface GetReferralProgramPremiumFeaturesRequest {
|
|
320
|
+
}
|
|
321
|
+
interface GetReferralProgramPremiumFeaturesResponse {
|
|
322
|
+
/**
|
|
323
|
+
* Set to true if user has referral program feature.
|
|
324
|
+
* @readonly
|
|
325
|
+
*/
|
|
326
|
+
referralProgram?: boolean;
|
|
327
|
+
}
|
|
328
|
+
interface DomainEvent$4 extends DomainEventBodyOneOf$4 {
|
|
329
|
+
createdEvent?: EntityCreatedEvent$4;
|
|
330
|
+
updatedEvent?: EntityUpdatedEvent$4;
|
|
331
|
+
deletedEvent?: EntityDeletedEvent$4;
|
|
332
|
+
actionEvent?: ActionEvent$4;
|
|
333
|
+
/**
|
|
334
|
+
* Unique event ID.
|
|
335
|
+
* Allows clients to ignore duplicate webhooks.
|
|
336
|
+
*/
|
|
337
|
+
_id?: string;
|
|
338
|
+
/**
|
|
339
|
+
* Assumes actions are also always typed to an entity_type
|
|
340
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
341
|
+
*/
|
|
342
|
+
entityFqdn?: string;
|
|
343
|
+
/**
|
|
344
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
345
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
346
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
347
|
+
*/
|
|
348
|
+
slug?: string;
|
|
349
|
+
/** ID of the entity associated with the event. */
|
|
350
|
+
entityId?: string;
|
|
351
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
352
|
+
eventTime?: Date;
|
|
353
|
+
/**
|
|
354
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
355
|
+
* (for example, GDPR).
|
|
356
|
+
*/
|
|
357
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
358
|
+
/** If present, indicates the action that triggered the event. */
|
|
359
|
+
originatedFrom?: string | null;
|
|
360
|
+
/**
|
|
361
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
362
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
363
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
364
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
365
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
366
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
367
|
+
*/
|
|
368
|
+
entityEventSequence?: string | null;
|
|
369
|
+
}
|
|
370
|
+
/** @oneof */
|
|
371
|
+
interface DomainEventBodyOneOf$4 {
|
|
372
|
+
createdEvent?: EntityCreatedEvent$4;
|
|
373
|
+
updatedEvent?: EntityUpdatedEvent$4;
|
|
374
|
+
deletedEvent?: EntityDeletedEvent$4;
|
|
375
|
+
actionEvent?: ActionEvent$4;
|
|
376
|
+
}
|
|
377
|
+
interface EntityCreatedEvent$4 {
|
|
378
|
+
entity?: string;
|
|
379
|
+
}
|
|
380
|
+
interface RestoreInfo {
|
|
381
|
+
deletedDate?: Date;
|
|
382
|
+
}
|
|
383
|
+
interface EntityUpdatedEvent$4 {
|
|
384
|
+
/**
|
|
385
|
+
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
386
|
+
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
387
|
+
* We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
|
|
388
|
+
*/
|
|
389
|
+
currentEntity?: string;
|
|
390
|
+
}
|
|
391
|
+
interface EntityDeletedEvent$4 {
|
|
392
|
+
/** Entity that was deleted */
|
|
393
|
+
deletedEntity?: string | null;
|
|
394
|
+
}
|
|
395
|
+
interface ActionEvent$4 {
|
|
396
|
+
body?: string;
|
|
397
|
+
}
|
|
398
|
+
interface Empty$3 {
|
|
399
|
+
}
|
|
400
|
+
interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
|
|
401
|
+
/** Emitted on a meta site creation. */
|
|
402
|
+
siteCreated?: SiteCreated;
|
|
403
|
+
/** Emitted on a meta site transfer completion. */
|
|
404
|
+
siteTransferred?: SiteTransferred;
|
|
405
|
+
/** Emitted on a meta site deletion. */
|
|
406
|
+
siteDeleted?: SiteDeleted;
|
|
407
|
+
/** Emitted on a meta site restoration. */
|
|
408
|
+
siteUndeleted?: SiteUndeleted;
|
|
409
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
410
|
+
sitePublished?: SitePublished;
|
|
411
|
+
/** Emitted on a meta site unpublish. */
|
|
412
|
+
siteUnpublished?: SiteUnpublished;
|
|
413
|
+
/** Emitted when meta site is marked as template. */
|
|
414
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
415
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
416
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
417
|
+
/** Emitted when an application is provisioned (installed). */
|
|
418
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
419
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
420
|
+
serviceRemoved?: ServiceRemoved;
|
|
421
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
422
|
+
siteRenamedPayload?: SiteRenamed;
|
|
423
|
+
/** Emitted when meta site was permanently deleted. */
|
|
424
|
+
hardDeleted?: SiteHardDeleted;
|
|
425
|
+
/** Emitted on a namespace change. */
|
|
426
|
+
namespaceChanged?: NamespaceChanged;
|
|
427
|
+
/** Emitted when Studio is attached. */
|
|
428
|
+
studioAssigned?: StudioAssigned;
|
|
429
|
+
/** Emitted when Studio is detached. */
|
|
430
|
+
studioUnassigned?: StudioUnassigned;
|
|
431
|
+
/** A meta site id. */
|
|
432
|
+
metaSiteId?: string;
|
|
433
|
+
/** A meta site version. Monotonically increasing. */
|
|
434
|
+
version?: string;
|
|
435
|
+
/** A timestamp of the event. */
|
|
436
|
+
timestamp?: string;
|
|
437
|
+
/** A list of "assets" (applications). The same as MetaSiteContext. */
|
|
438
|
+
assets?: Asset[];
|
|
439
|
+
}
|
|
440
|
+
/** @oneof */
|
|
441
|
+
interface MetaSiteSpecialEventPayloadOneOf {
|
|
442
|
+
/** Emitted on a meta site creation. */
|
|
443
|
+
siteCreated?: SiteCreated;
|
|
444
|
+
/** Emitted on a meta site transfer completion. */
|
|
445
|
+
siteTransferred?: SiteTransferred;
|
|
446
|
+
/** Emitted on a meta site deletion. */
|
|
447
|
+
siteDeleted?: SiteDeleted;
|
|
448
|
+
/** Emitted on a meta site restoration. */
|
|
449
|
+
siteUndeleted?: SiteUndeleted;
|
|
450
|
+
/** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
|
|
451
|
+
sitePublished?: SitePublished;
|
|
452
|
+
/** Emitted on a meta site unpublish. */
|
|
453
|
+
siteUnpublished?: SiteUnpublished;
|
|
454
|
+
/** Emitted when meta site is marked as template. */
|
|
455
|
+
siteMarkedAsTemplate?: SiteMarkedAsTemplate;
|
|
456
|
+
/** Emitted when meta site is marked as a WixSite. */
|
|
457
|
+
siteMarkedAsWixSite?: SiteMarkedAsWixSite;
|
|
458
|
+
/** Emitted when an application is provisioned (installed). */
|
|
459
|
+
serviceProvisioned?: ServiceProvisioned;
|
|
460
|
+
/** Emitted when an application is removed (uninstalled). */
|
|
461
|
+
serviceRemoved?: ServiceRemoved;
|
|
462
|
+
/** Emitted when meta site name (URL slug) is changed. */
|
|
463
|
+
siteRenamedPayload?: SiteRenamed;
|
|
464
|
+
/** Emitted when meta site was permanently deleted. */
|
|
465
|
+
hardDeleted?: SiteHardDeleted;
|
|
466
|
+
/** Emitted on a namespace change. */
|
|
467
|
+
namespaceChanged?: NamespaceChanged;
|
|
468
|
+
/** Emitted when Studio is attached. */
|
|
469
|
+
studioAssigned?: StudioAssigned;
|
|
470
|
+
/** Emitted when Studio is detached. */
|
|
471
|
+
studioUnassigned?: StudioUnassigned;
|
|
472
|
+
}
|
|
473
|
+
interface Asset {
|
|
474
|
+
/** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
|
|
475
|
+
appDefId?: string;
|
|
476
|
+
/** An instance id. For legacy reasons may be UUID or a string. */
|
|
477
|
+
instanceId?: string;
|
|
478
|
+
/** An application state. */
|
|
479
|
+
state?: State;
|
|
480
|
+
}
|
|
481
|
+
declare enum State {
|
|
482
|
+
UNKNOWN = "UNKNOWN",
|
|
483
|
+
ENABLED = "ENABLED",
|
|
484
|
+
DISABLED = "DISABLED",
|
|
485
|
+
PENDING = "PENDING",
|
|
486
|
+
DEMO = "DEMO"
|
|
487
|
+
}
|
|
488
|
+
interface SiteCreated {
|
|
489
|
+
/** A template identifier (empty if not created from a template). */
|
|
490
|
+
originTemplateId?: string;
|
|
491
|
+
/** An account id of the owner. */
|
|
492
|
+
ownerId?: string;
|
|
493
|
+
/** A context in which meta site was created. */
|
|
494
|
+
context?: SiteCreatedContext;
|
|
495
|
+
/**
|
|
496
|
+
* A meta site id from which this site was created.
|
|
497
|
+
*
|
|
498
|
+
* In case of a creation from a template it's a template id.
|
|
499
|
+
* In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
|
|
500
|
+
*/
|
|
501
|
+
originMetaSiteId?: string | null;
|
|
502
|
+
/** A meta site name (URL slug). */
|
|
503
|
+
siteName?: string;
|
|
504
|
+
/** A namespace. */
|
|
505
|
+
namespace?: Namespace;
|
|
506
|
+
}
|
|
507
|
+
declare enum SiteCreatedContext {
|
|
508
|
+
/** A valid option, we don't expose all reasons why site might be created. */
|
|
509
|
+
OTHER = "OTHER",
|
|
510
|
+
/** A meta site was created from template. */
|
|
511
|
+
FROM_TEMPLATE = "FROM_TEMPLATE",
|
|
512
|
+
/** A meta site was created by copying of the transfferred meta site. */
|
|
513
|
+
DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
|
|
514
|
+
/** A copy of existing meta site. */
|
|
515
|
+
DUPLICATE = "DUPLICATE",
|
|
516
|
+
/** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
|
|
517
|
+
OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
|
|
518
|
+
/** deprecated A meta site was created for Flash editor. */
|
|
519
|
+
FLASH = "FLASH"
|
|
520
|
+
}
|
|
521
|
+
declare enum Namespace {
|
|
522
|
+
UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
|
|
523
|
+
/** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
|
|
524
|
+
WIX = "WIX",
|
|
525
|
+
/** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
526
|
+
SHOUT_OUT = "SHOUT_OUT",
|
|
527
|
+
/** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
528
|
+
ALBUMS = "ALBUMS",
|
|
529
|
+
/** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
530
|
+
WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
|
|
531
|
+
/** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
532
|
+
HOTELS = "HOTELS",
|
|
533
|
+
/** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
534
|
+
CLUBS = "CLUBS",
|
|
535
|
+
/** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
536
|
+
ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
|
|
537
|
+
/** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
538
|
+
DEV_SITE = "DEV_SITE",
|
|
539
|
+
/** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
540
|
+
LOGOS = "LOGOS",
|
|
541
|
+
/** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
542
|
+
VIDEO_MAKER = "VIDEO_MAKER",
|
|
543
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
544
|
+
PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
|
|
545
|
+
/** MetaSites with this namespace will *not* be shown in a user's site list by default. */
|
|
546
|
+
DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
|
|
547
|
+
/**
|
|
548
|
+
* A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
|
|
549
|
+
*
|
|
550
|
+
* Meta site with this namespace will *not* be shown in a user's site list by default.
|
|
551
|
+
*/
|
|
552
|
+
HTML_DRAFT = "HTML_DRAFT",
|
|
553
|
+
/**
|
|
554
|
+
* the user-journey for Fitness users who want to start from managing their business instead of designing their website.
|
|
555
|
+
* Will be accessible from Site List and will not have a website app.
|
|
556
|
+
* Once the user attaches a site, the site will become a regular wixsite.
|
|
557
|
+
*/
|
|
558
|
+
SITELESS_BUSINESS = "SITELESS_BUSINESS",
|
|
559
|
+
/** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
|
|
560
|
+
CREATOR_ECONOMY = "CREATOR_ECONOMY",
|
|
561
|
+
/** It is to be used in the Business First efforts. */
|
|
562
|
+
DASHBOARD_FIRST = "DASHBOARD_FIRST",
|
|
563
|
+
/** Bookings business flow with no site. */
|
|
564
|
+
ANYWHERE = "ANYWHERE",
|
|
565
|
+
/** Namespace for Headless Backoffice with no editor */
|
|
566
|
+
HEADLESS = "HEADLESS",
|
|
567
|
+
/**
|
|
568
|
+
* Namespace for master site that will exist in parent account that will be referenced by subaccounts
|
|
569
|
+
* The site will be used for account level CSM feature for enterprise
|
|
570
|
+
*/
|
|
571
|
+
ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
|
|
572
|
+
/** Rise.ai Siteless account management for Gift Cards and Store Credit. */
|
|
573
|
+
RISE = "RISE",
|
|
574
|
+
/**
|
|
575
|
+
* As part of the branded app new funnel, users now can create a meta site that will be branded app first.
|
|
576
|
+
* There's a blank site behind the scene but it's blank).
|
|
577
|
+
* The Mobile company will be the owner of this namespace.
|
|
578
|
+
*/
|
|
579
|
+
BRANDED_FIRST = "BRANDED_FIRST",
|
|
580
|
+
/** Nownia.com Siteless account management for Ai Scheduling Assistant. */
|
|
581
|
+
NOWNIA = "NOWNIA"
|
|
582
|
+
}
|
|
583
|
+
/** Site transferred to another user. */
|
|
584
|
+
interface SiteTransferred {
|
|
585
|
+
/** A previous owner id (user that transfers meta site). */
|
|
586
|
+
oldOwnerId?: string;
|
|
587
|
+
/** A new owner id (user that accepts meta site). */
|
|
588
|
+
newOwnerId?: string;
|
|
589
|
+
}
|
|
590
|
+
/** Soft deletion of the meta site. Could be restored. */
|
|
591
|
+
interface SiteDeleted {
|
|
592
|
+
/** A deletion context. */
|
|
593
|
+
deleteContext?: DeleteContext;
|
|
594
|
+
}
|
|
595
|
+
interface DeleteContext {
|
|
596
|
+
/** When the meta site was deleted. */
|
|
597
|
+
dateDeleted?: Date;
|
|
598
|
+
/** A status. */
|
|
599
|
+
deleteStatus?: DeleteStatus;
|
|
600
|
+
/** A reason (flow). */
|
|
601
|
+
deleteOrigin?: string;
|
|
602
|
+
/** A service that deleted it. */
|
|
603
|
+
initiatorId?: string | null;
|
|
604
|
+
}
|
|
605
|
+
declare enum DeleteStatus {
|
|
606
|
+
UNKNOWN = "UNKNOWN",
|
|
607
|
+
TRASH = "TRASH",
|
|
608
|
+
DELETED = "DELETED",
|
|
609
|
+
PENDING_PURGE = "PENDING_PURGE"
|
|
610
|
+
}
|
|
611
|
+
/** Restoration of the meta site. */
|
|
612
|
+
interface SiteUndeleted {
|
|
613
|
+
}
|
|
614
|
+
/** First publish of a meta site. Or subsequent publish after unpublish. */
|
|
615
|
+
interface SitePublished {
|
|
616
|
+
}
|
|
617
|
+
interface SiteUnpublished {
|
|
618
|
+
/** A list of URLs previously associated with the meta site. */
|
|
619
|
+
urls?: string[];
|
|
620
|
+
}
|
|
621
|
+
interface SiteMarkedAsTemplate {
|
|
622
|
+
}
|
|
623
|
+
interface SiteMarkedAsWixSite {
|
|
624
|
+
}
|
|
625
|
+
interface ServiceProvisioned {
|
|
626
|
+
/** Either UUID or EmbeddedServiceType. */
|
|
627
|
+
appDefId?: string;
|
|
628
|
+
/** Not only UUID. Something here could be something weird. */
|
|
629
|
+
instanceId?: string;
|
|
630
|
+
/** An instance id from which this instance is originated. */
|
|
631
|
+
originInstanceId?: string;
|
|
632
|
+
/** A version. */
|
|
633
|
+
version?: string | null;
|
|
634
|
+
}
|
|
635
|
+
interface ServiceRemoved {
|
|
636
|
+
/** Either UUID or EmbeddedServiceType. */
|
|
637
|
+
appDefId?: string;
|
|
638
|
+
/** Not only UUID. Something here could be something weird. */
|
|
639
|
+
instanceId?: string;
|
|
640
|
+
/** A version. */
|
|
641
|
+
version?: string | null;
|
|
642
|
+
}
|
|
643
|
+
/** Rename of the site. Meaning, free public url has been changed as well. */
|
|
644
|
+
interface SiteRenamed {
|
|
645
|
+
/** A new meta site name (URL slug). */
|
|
646
|
+
newSiteName?: string;
|
|
647
|
+
/** A previous meta site name (URL slug). */
|
|
648
|
+
oldSiteName?: string;
|
|
649
|
+
}
|
|
650
|
+
/**
|
|
651
|
+
* Hard deletion of the meta site.
|
|
652
|
+
*
|
|
653
|
+
* Could not be restored. Therefore it's desirable to cleanup data.
|
|
654
|
+
*/
|
|
655
|
+
interface SiteHardDeleted {
|
|
656
|
+
/** A deletion context. */
|
|
657
|
+
deleteContext?: DeleteContext;
|
|
658
|
+
}
|
|
659
|
+
interface NamespaceChanged {
|
|
660
|
+
/** A previous namespace. */
|
|
661
|
+
oldNamespace?: Namespace;
|
|
662
|
+
/** A new namespace. */
|
|
663
|
+
newNamespace?: Namespace;
|
|
664
|
+
}
|
|
665
|
+
/** Assigned Studio editor */
|
|
666
|
+
interface StudioAssigned {
|
|
667
|
+
}
|
|
668
|
+
/** Unassigned Studio editor */
|
|
669
|
+
interface StudioUnassigned {
|
|
670
|
+
}
|
|
671
|
+
interface HtmlSitePublished {
|
|
672
|
+
/** Application instance ID */
|
|
673
|
+
appInstanceId?: string;
|
|
674
|
+
/** Application type */
|
|
675
|
+
appType?: string;
|
|
676
|
+
/** Revision */
|
|
677
|
+
revision?: string;
|
|
678
|
+
/** MSID */
|
|
679
|
+
metaSiteId?: string | null;
|
|
680
|
+
/** optional branch id if publish is done from branch */
|
|
681
|
+
branchId?: string | null;
|
|
682
|
+
/** The site's last transactionId */
|
|
683
|
+
lastTransactionId?: string | null;
|
|
684
|
+
/** A list of the site's pages */
|
|
685
|
+
pages?: Page[];
|
|
686
|
+
/** Site's publish date */
|
|
687
|
+
publishDate?: string;
|
|
688
|
+
}
|
|
689
|
+
interface Page {
|
|
690
|
+
/** Page's Id */
|
|
691
|
+
_id?: string;
|
|
692
|
+
}
|
|
693
|
+
interface SubscriptionEvent extends SubscriptionEventEventOneOf {
|
|
694
|
+
/** Triggered when a subscription is created. */
|
|
695
|
+
created?: SubscriptionCreated;
|
|
696
|
+
/**
|
|
697
|
+
* Triggered when a subscription is assigned to a Wix site, including the initial
|
|
698
|
+
* assignment of a floating subscription or a re-assignement from a different site.
|
|
699
|
+
*/
|
|
700
|
+
assigned?: SubscriptionAssigned;
|
|
701
|
+
/** Triggered when a subscription is canceled. */
|
|
702
|
+
cancelled?: SubscriptionCancelled;
|
|
703
|
+
/** Triggered when the subscription's auto renew is turned on. */
|
|
704
|
+
autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;
|
|
705
|
+
/** Triggered when the subscription's auto renew is turned off. */
|
|
706
|
+
autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;
|
|
707
|
+
/**
|
|
708
|
+
* Triggered when a subscription is unassigned from a Wix site and becomes
|
|
709
|
+
* floating.
|
|
710
|
+
*/
|
|
711
|
+
unassigned?: SubscriptionUnassigned;
|
|
712
|
+
/**
|
|
713
|
+
* Triggered when a subscription is transferred from one Wix account to another.
|
|
714
|
+
* A transfer includes cancelling the original subscription and creating a new
|
|
715
|
+
* subscription for the target account. The event returns both the original
|
|
716
|
+
* and the new subscription.
|
|
717
|
+
*/
|
|
718
|
+
transferred?: SubscriptionTransferred;
|
|
719
|
+
/** Triggered when a recurring charge succeeds for a subscription. */
|
|
720
|
+
recurringChargeSucceeded?: RecurringChargeSucceeded;
|
|
721
|
+
/**
|
|
722
|
+
* Triggered when a subscription was updated including when its product has been
|
|
723
|
+
* up- or downgraded or the billing cycle is changed.
|
|
724
|
+
*/
|
|
725
|
+
contractSwitched?: ContractSwitched;
|
|
726
|
+
/**
|
|
727
|
+
* Triggered when a subscription gets close to the end of its billing cycle.
|
|
728
|
+
* The exact number of days is defined in the billing system.
|
|
729
|
+
*/
|
|
730
|
+
nearEndOfPeriod?: SubscriptionNearEndOfPeriod;
|
|
731
|
+
/**
|
|
732
|
+
* Triggered when a subscription is updated and the change doesn't happen
|
|
733
|
+
* immediately but at the end of the current billing cycle.
|
|
734
|
+
*/
|
|
735
|
+
pendingChange?: SubscriptionPendingChange;
|
|
736
|
+
/** ID of the subscription's event. */
|
|
737
|
+
eventId?: string | null;
|
|
738
|
+
/**
|
|
739
|
+
* Date and time of the event in
|
|
740
|
+
* [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
|
|
741
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
742
|
+
*/
|
|
743
|
+
eventDate?: Date;
|
|
744
|
+
}
|
|
745
|
+
/** @oneof */
|
|
746
|
+
interface SubscriptionEventEventOneOf {
|
|
747
|
+
/** Triggered when a subscription is created. */
|
|
748
|
+
created?: SubscriptionCreated;
|
|
749
|
+
/**
|
|
750
|
+
* Triggered when a subscription is assigned to a Wix site, including the initial
|
|
751
|
+
* assignment of a floating subscription or a re-assignement from a different site.
|
|
752
|
+
*/
|
|
753
|
+
assigned?: SubscriptionAssigned;
|
|
754
|
+
/** Triggered when a subscription is canceled. */
|
|
755
|
+
cancelled?: SubscriptionCancelled;
|
|
756
|
+
/** Triggered when the subscription's auto renew is turned on. */
|
|
757
|
+
autoRenewTurnedOn?: SubscriptionAutoRenewTurnedOn;
|
|
758
|
+
/** Triggered when the subscription's auto renew is turned off. */
|
|
759
|
+
autoRenewTurnedOff?: SubscriptionAutoRenewTurnedOff;
|
|
760
|
+
/**
|
|
761
|
+
* Triggered when a subscription is unassigned from a Wix site and becomes
|
|
762
|
+
* floating.
|
|
763
|
+
*/
|
|
764
|
+
unassigned?: SubscriptionUnassigned;
|
|
765
|
+
/**
|
|
766
|
+
* Triggered when a subscription is transferred from one Wix account to another.
|
|
767
|
+
* A transfer includes cancelling the original subscription and creating a new
|
|
768
|
+
* subscription for the target account. The event returns both the original
|
|
769
|
+
* and the new subscription.
|
|
770
|
+
*/
|
|
771
|
+
transferred?: SubscriptionTransferred;
|
|
772
|
+
/** Triggered when a recurring charge succeeds for a subscription. */
|
|
773
|
+
recurringChargeSucceeded?: RecurringChargeSucceeded;
|
|
774
|
+
/**
|
|
775
|
+
* Triggered when a subscription was updated including when its product has been
|
|
776
|
+
* up- or downgraded or the billing cycle is changed.
|
|
777
|
+
*/
|
|
778
|
+
contractSwitched?: ContractSwitched;
|
|
779
|
+
/**
|
|
780
|
+
* Triggered when a subscription gets close to the end of its billing cycle.
|
|
781
|
+
* The exact number of days is defined in the billing system.
|
|
782
|
+
*/
|
|
783
|
+
nearEndOfPeriod?: SubscriptionNearEndOfPeriod;
|
|
784
|
+
/**
|
|
785
|
+
* Triggered when a subscription is updated and the change doesn't happen
|
|
786
|
+
* immediately but at the end of the current billing cycle.
|
|
787
|
+
*/
|
|
788
|
+
pendingChange?: SubscriptionPendingChange;
|
|
789
|
+
}
|
|
790
|
+
/** Triggered when a subscription is created. */
|
|
791
|
+
interface SubscriptionCreated {
|
|
792
|
+
/** Created subscription. */
|
|
793
|
+
subscription?: Subscription;
|
|
794
|
+
/** Metadata for the `created` event. */
|
|
795
|
+
metadata?: Record<string, string>;
|
|
796
|
+
/**
|
|
797
|
+
* Subscription reactivation data.
|
|
798
|
+
* A subscription can be reactivated for example if it was incorrectly canceled because of fraud and then reactivated
|
|
799
|
+
* by the billing system
|
|
800
|
+
*/
|
|
801
|
+
reactivationData?: ReactivationData;
|
|
802
|
+
}
|
|
803
|
+
/**
|
|
804
|
+
* A subscription holds information about a Premium product that a Wix account
|
|
805
|
+
* owner has purchased including details about the billing.
|
|
806
|
+
*/
|
|
807
|
+
interface Subscription {
|
|
808
|
+
/** ID of the subscription. */
|
|
809
|
+
_id?: string;
|
|
810
|
+
/** ID of the Wix account that purchased the subscription. */
|
|
811
|
+
userId?: string;
|
|
812
|
+
/**
|
|
813
|
+
* ID of the [product](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/products/product-object)
|
|
814
|
+
* for which the subscription was purchased.
|
|
815
|
+
*/
|
|
816
|
+
productId?: string;
|
|
817
|
+
/**
|
|
818
|
+
* Date and time the subscription was created in
|
|
819
|
+
* [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
|
|
820
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
821
|
+
*/
|
|
822
|
+
createdAt?: Date;
|
|
823
|
+
/**
|
|
824
|
+
* Date and time the subscription was last updated in
|
|
825
|
+
* [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
|
|
826
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
827
|
+
*/
|
|
828
|
+
updatedAt?: Date;
|
|
829
|
+
/**
|
|
830
|
+
* ID of the metasite that the subscription is assigned to.
|
|
831
|
+
* Available only when the subscription is assigned to a Wix site.
|
|
832
|
+
* Subscriptions for account level products can't be assigned to a Wix site.
|
|
833
|
+
*/
|
|
834
|
+
metaSiteId?: string | null;
|
|
835
|
+
/** Information about the system that manages the subscription's billing. */
|
|
836
|
+
billingReference?: BillingReference;
|
|
837
|
+
/** Information about the billing cycle of the subscription. */
|
|
838
|
+
cycle?: Cycle;
|
|
839
|
+
/**
|
|
840
|
+
* Subscription status.
|
|
841
|
+
*
|
|
842
|
+
* + `UNKNOWN`: Default status.
|
|
843
|
+
* + `AUTO_RENEW_ON`: Subscription is active and automatically renews at the end of the current billing cycle.
|
|
844
|
+
* + `AUTO_RENEW_OFF`: Subscription is active but expires at the end of the current billing cycle.
|
|
845
|
+
* + `MANUAL_RECURRING`: Subscription is active and renews at the end of the current billing cycle, in case the customer takes an action related to the payment.
|
|
846
|
+
* + `CANCELLED`: Subscription isn't active because it has been canceled.
|
|
847
|
+
* + `TRANSFERRED`: Subscription isn't active because it has been transferred to a different account. A different active subscription was created for the target account.
|
|
848
|
+
*/
|
|
849
|
+
status?: SubscriptionStatus;
|
|
850
|
+
/**
|
|
851
|
+
* Date and time the subscription was last transferred from one Wix account to
|
|
852
|
+
* another in
|
|
853
|
+
* [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
|
|
854
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
855
|
+
*/
|
|
856
|
+
transferredAt?: Date;
|
|
857
|
+
/**
|
|
858
|
+
* ID of the [product type](https://bo.wix.com/wix-docs/rest/premium/premium-product-catalog-v2/product-types/product-type-object)
|
|
859
|
+
* that the product, for which the subscription was purchased, belongs to.
|
|
860
|
+
*/
|
|
861
|
+
productTypeId?: string;
|
|
862
|
+
/** Version number, which increments by 1 each time the subscription is updated. */
|
|
863
|
+
version?: number;
|
|
864
|
+
/**
|
|
865
|
+
* Whether the subscription is active. Includes the statuses
|
|
866
|
+
* `"AUTO_RENEW_ON"`, `"AUTO_RENEW_OFF"`, and `"MANUAL_RECURRING"`.
|
|
867
|
+
*/
|
|
868
|
+
active?: boolean;
|
|
869
|
+
/**
|
|
870
|
+
* Date and time the subscription was originally created in
|
|
871
|
+
* [UTC datetime](https://en.wikipedia.org/wiki/Coordinated_Universal_Time)
|
|
872
|
+
* `YYYY-MM-DDThh:mm:ss.sssZ` format.
|
|
873
|
+
* Differs from `createdAt` in case the subscription was originally created for a different Wix account and has been transferred.
|
|
874
|
+
*/
|
|
875
|
+
originalCreationDate?: Date;
|
|
876
|
+
/** Custom metadata about the subscription. */
|
|
877
|
+
metadata?: Record<string, string>;
|
|
878
|
+
/**
|
|
879
|
+
* 2-letter country code in
|
|
880
|
+
* [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
|
|
881
|
+
* format.
|
|
882
|
+
*/
|
|
883
|
+
countryCode?: string | null;
|
|
884
|
+
}
|
|
885
|
+
interface BillingReference {
|
|
886
|
+
/**
|
|
887
|
+
* Name of the billing system that manages the subscription.
|
|
888
|
+
*
|
|
889
|
+
* + `"UNKNOWN"`: Default value.
|
|
890
|
+
* + `"SBS"`: [Wix Billing](https://github.com/wix-p/premium-billing/tree/master/sbs).
|
|
891
|
+
* + `"LICENSER"`:
|
|
892
|
+
* + `"BASS"`: [Billing and Subscriptions System](https://dev.wix.com/docs/rest/internal-only/premium/subscriptions-by-billing-by-wix/introduction).
|
|
893
|
+
* + `"RESELLER"`: [External Reseller](https://dev.wix.com/api/rest/account-level-apis/resellers/introduction).
|
|
894
|
+
*/
|
|
895
|
+
providerName?: ProviderName;
|
|
896
|
+
/** Current provider reference ID. */
|
|
897
|
+
providerReferenceId?: string | null;
|
|
898
|
+
/** Previous provider reference IDs. Used for when a subscription is extended, specifically for domains. */
|
|
899
|
+
previousProviderReferenceIds?: string[];
|
|
900
|
+
}
|
|
901
|
+
declare enum ProviderName {
|
|
902
|
+
UNKNOWN = "UNKNOWN",
|
|
903
|
+
SBS = "SBS",
|
|
904
|
+
LICENSER = "LICENSER",
|
|
905
|
+
BASS = "BASS",
|
|
906
|
+
RESELLER = "RESELLER",
|
|
907
|
+
RECURRING_INVOICES = "RECURRING_INVOICES"
|
|
908
|
+
}
|
|
909
|
+
interface Cycle extends CycleCycleSelectorOneOf {
|
|
910
|
+
/** repetitive interval */
|
|
911
|
+
interval?: Interval;
|
|
912
|
+
/** one time */
|
|
913
|
+
oneTime?: OneTime;
|
|
914
|
+
}
|
|
915
|
+
/** @oneof */
|
|
916
|
+
interface CycleCycleSelectorOneOf {
|
|
917
|
+
/** repetitive interval */
|
|
918
|
+
interval?: Interval;
|
|
919
|
+
/** one time */
|
|
920
|
+
oneTime?: OneTime;
|
|
921
|
+
}
|
|
922
|
+
interface Interval {
|
|
923
|
+
/** interval unit of measure */
|
|
924
|
+
unit?: IntervalUnit;
|
|
925
|
+
/** number of interval */
|
|
926
|
+
count?: number;
|
|
927
|
+
}
|
|
928
|
+
declare enum IntervalUnit {
|
|
929
|
+
/** unknown interval unit */
|
|
930
|
+
UNKNOWN = "UNKNOWN",
|
|
931
|
+
/** day */
|
|
932
|
+
DAY = "DAY",
|
|
933
|
+
/** week */
|
|
934
|
+
WEEK = "WEEK",
|
|
935
|
+
/** month */
|
|
936
|
+
MONTH = "MONTH",
|
|
937
|
+
/** year */
|
|
938
|
+
YEAR = "YEAR"
|
|
939
|
+
}
|
|
940
|
+
interface OneTime {
|
|
941
|
+
}
|
|
942
|
+
declare enum SubscriptionStatus {
|
|
943
|
+
UNKNOWN = "UNKNOWN",
|
|
944
|
+
AUTO_RENEW_ON = "AUTO_RENEW_ON",
|
|
945
|
+
AUTO_RENEW_OFF = "AUTO_RENEW_OFF",
|
|
946
|
+
MANUAL_RECURRING = "MANUAL_RECURRING",
|
|
947
|
+
CANCELLED = "CANCELLED",
|
|
948
|
+
TRANSFERRED = "TRANSFERRED"
|
|
949
|
+
}
|
|
950
|
+
/** Triggered when a subscription is reactivated. */
|
|
951
|
+
interface ReactivationData {
|
|
952
|
+
reactivationReason?: ReactivationReasonEnum;
|
|
953
|
+
/**
|
|
954
|
+
* In the event of reactivation after chargeback dispute, the subscription may be extended according to the
|
|
955
|
+
* number of days it was inactive during the time of resolving the dispute
|
|
956
|
+
*/
|
|
957
|
+
newEndOfPeriod?: Date;
|
|
958
|
+
/** The original end date, before the inactive period. */
|
|
959
|
+
oldEndOfPeriod?: Date;
|
|
960
|
+
/** The difference in days between the new new_end_of_period and old_end_of_period */
|
|
961
|
+
differenceInDays?: number | null;
|
|
962
|
+
}
|
|
963
|
+
/** Reason for subscription reactivation */
|
|
964
|
+
declare enum ReactivationReasonEnum {
|
|
965
|
+
UNKNOWN = "UNKNOWN",
|
|
966
|
+
/**
|
|
967
|
+
* Subscription was reactivated due to billing status change from CANCELED to ACTIVE, for example if it was incorrectly
|
|
968
|
+
* canceled because of suspicion of fraud
|
|
969
|
+
*/
|
|
970
|
+
BILLING_STATUS_CHANGE = "BILLING_STATUS_CHANGE",
|
|
971
|
+
/** Subscription was reactivated after a chargeback dispute */
|
|
972
|
+
REACTIVATED_AFTER_CHARGEBACK = "REACTIVATED_AFTER_CHARGEBACK"
|
|
973
|
+
}
|
|
974
|
+
/**
|
|
975
|
+
* Triggered when a subscription is assigned to a Wix site, including the initial
|
|
976
|
+
* assignment of a floating subscription or a re-assignement from a different site.
|
|
977
|
+
*/
|
|
978
|
+
interface SubscriptionAssigned {
|
|
979
|
+
/** Assigned subscription. */
|
|
980
|
+
subscription?: Subscription;
|
|
981
|
+
/** ID of the metasite that the subscription has been assigned to before the update. */
|
|
982
|
+
previousMetaSiteId?: string | null;
|
|
983
|
+
}
|
|
984
|
+
/** Triggered when a subscription is canceled. */
|
|
985
|
+
interface SubscriptionCancelled {
|
|
986
|
+
/** Canceled subscription. */
|
|
987
|
+
subscription?: Subscription;
|
|
988
|
+
/** Details about the cancellation including who canceled the subscription and why. */
|
|
989
|
+
cancellationDetails?: CancellationDetails;
|
|
990
|
+
/**
|
|
991
|
+
* Whether the subscription is canceled immediately or expires at the end of the current billing cycle.
|
|
992
|
+
*
|
|
993
|
+
* Default: `false`
|
|
994
|
+
*/
|
|
995
|
+
immediateCancel?: boolean;
|
|
996
|
+
/** Whether the subscription was canceled during the free trial period. */
|
|
997
|
+
canceledInFreeTrial?: boolean;
|
|
998
|
+
}
|
|
999
|
+
/** Information about the cancellation flow including who canceled the subscription and why it was canceled. */
|
|
1000
|
+
interface CancellationDetails {
|
|
1001
|
+
/**
|
|
1002
|
+
* Cancellation code.
|
|
1003
|
+
*
|
|
1004
|
+
* Values supported for cancellations on behalf of the billing system: `-1`, `-2`, `-3`, `-4`, `-5`, `-6`, `-7`, `-8`.
|
|
1005
|
+
* For cancellations on behalf of the site owner or the service provider `cancellationCode`
|
|
1006
|
+
* is taken from the request of
|
|
1007
|
+
* [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
|
|
1008
|
+
*
|
|
1009
|
+
* + `-1`: The subscription has been cancelled by the billing system but none of the listed cancellation reasons applies.
|
|
1010
|
+
* + `-2`: There were payment problems.
|
|
1011
|
+
* + `-3`: There was a chargeback.
|
|
1012
|
+
* + `-4`: Customer support has canceled the subscription and issued a refund.
|
|
1013
|
+
* + `-5`: The site owner has changed their existing subscription.
|
|
1014
|
+
* + `-6`: The subscription has been transferred to a different Wix account.
|
|
1015
|
+
* + `-7`: The subscription has been canceled because the site owner hasn't manually authenticated the recurring payment during the subscription's grace period. For example, site owners must manually confirm recurring payments within 40 days when paying with boleto.
|
|
1016
|
+
* + `-8`: The Wix account that the subscription belonged to has been deleted.
|
|
1017
|
+
*/
|
|
1018
|
+
cancellationCode?: number | null;
|
|
1019
|
+
/**
|
|
1020
|
+
* Cancellation reason. For cancellations on behalf of the site owner or the service provider `cancellationReason`
|
|
1021
|
+
* is taken from the request of
|
|
1022
|
+
* [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
|
|
1023
|
+
* For cancellations on behalf of the billing system `cancellationReason` is `null` or an empty string.
|
|
1024
|
+
*/
|
|
1025
|
+
cancellationReason?: string | null;
|
|
1026
|
+
/**
|
|
1027
|
+
* Initiator of the cancellation. For `"USER_REQUESTED"` and `"APP_MANAGED"`,
|
|
1028
|
+
* `cancellationCode` and `cancellationReason` are taken from the request of
|
|
1029
|
+
* [Cancel Immediately](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately)
|
|
1030
|
+
* or [Cancel Immediately Offline](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/cancel-immediately-offline).
|
|
1031
|
+
* For `"PASSIVE"`, cancellations `cancellationCode` is automatically calculated and `cancellationReason`
|
|
1032
|
+
* is `null` or an empty string.
|
|
1033
|
+
*
|
|
1034
|
+
* + `"UNKNOWN`: Default value.
|
|
1035
|
+
* + `"USER_REQUESTED"`: The Wix account owner has canceled the subscription.
|
|
1036
|
+
* + `"APP_MANAGED"`: The service provider has canceled the subscription.
|
|
1037
|
+
* + `"PASSIVE"`: The billing system has canceled the subscription. For example, in case of payment failure or fraud.
|
|
1038
|
+
*/
|
|
1039
|
+
initiator?: Initiator;
|
|
1040
|
+
}
|
|
1041
|
+
declare enum Initiator {
|
|
1042
|
+
UNKNOWN = "UNKNOWN",
|
|
1043
|
+
USER_REQUESTED = "USER_REQUESTED",
|
|
1044
|
+
APP_MANAGED = "APP_MANAGED",
|
|
1045
|
+
PASSIVE = "PASSIVE"
|
|
1046
|
+
}
|
|
1047
|
+
/** Triggered when the subscription's auto renew is turned on. */
|
|
1048
|
+
interface SubscriptionAutoRenewTurnedOn {
|
|
1049
|
+
/** Subscription for which auto renew is turned on. */
|
|
1050
|
+
subscription?: Subscription;
|
|
1051
|
+
/**
|
|
1052
|
+
* Supported values: `USER`, `APP`.
|
|
1053
|
+
*
|
|
1054
|
+
* Information about who turned auto renew on.
|
|
1055
|
+
* + `"USER"`: The site owner who purchased the subscription has turned auto renew on.
|
|
1056
|
+
* + `"APP"`: The service provider has turned auto renew on.
|
|
1057
|
+
*/
|
|
1058
|
+
initiator?: string | null;
|
|
1059
|
+
}
|
|
1060
|
+
/** Triggered when the subscription's auto renew is turned off. */
|
|
1061
|
+
interface SubscriptionAutoRenewTurnedOff {
|
|
1062
|
+
/** Subscription for which auto renew is turned off. */
|
|
1063
|
+
subscription?: Subscription;
|
|
1064
|
+
/** Details about the cancellation including who canceled the subscription and why. */
|
|
1065
|
+
cancellationDetails?: CancellationDetails;
|
|
1066
|
+
/**
|
|
1067
|
+
* Whether the subscription is immediately canceled or expires at the end of the current billing cycle.
|
|
1068
|
+
*
|
|
1069
|
+
* Default: `false`
|
|
1070
|
+
*/
|
|
1071
|
+
immediateCancel?: boolean;
|
|
1072
|
+
}
|
|
1073
|
+
/**
|
|
1074
|
+
* Triggered when a subscription is unassigned from a Wix site and becomes
|
|
1075
|
+
* floating.
|
|
1076
|
+
*/
|
|
1077
|
+
interface SubscriptionUnassigned {
|
|
1078
|
+
/** Unassigned subscription. */
|
|
1079
|
+
subscription?: Subscription;
|
|
1080
|
+
/** ID of the metasite that the subscription has been assigned to before the event. */
|
|
1081
|
+
previousMetaSiteId?: string;
|
|
1082
|
+
/**
|
|
1083
|
+
* Reason why the subscription is unassigned.
|
|
1084
|
+
*
|
|
1085
|
+
* + `"UNKNOWN"`: Default value.
|
|
1086
|
+
* + `"USER_REQUESTED"`: The Wix account owner has unassigned the subscription.
|
|
1087
|
+
* + `"REPLACED_BY_ANOTHER_SUBSCRIPTION"`: A different subscription that replaces this subscription is assigned to the site.
|
|
1088
|
+
*/
|
|
1089
|
+
unassignReason?: UnassignReason;
|
|
1090
|
+
}
|
|
1091
|
+
declare enum UnassignReason {
|
|
1092
|
+
UNKNOWN = "UNKNOWN",
|
|
1093
|
+
USER_REQUESTED = "USER_REQUESTED",
|
|
1094
|
+
REPLACED_BY_ANOTHER_SUBSCRIPTION = "REPLACED_BY_ANOTHER_SUBSCRIPTION"
|
|
1095
|
+
}
|
|
1096
|
+
/**
|
|
1097
|
+
* Triggered when a subscription is transferred from one Wix account to another.
|
|
1098
|
+
* A transfer includes cancelling the original subscription and creating a new
|
|
1099
|
+
* subscription for the target account. The event returns both the original
|
|
1100
|
+
* and the new subscription.
|
|
1101
|
+
*/
|
|
1102
|
+
interface SubscriptionTransferred {
|
|
1103
|
+
/** Original subscription that was canceled for the transfer. */
|
|
1104
|
+
originSubscription?: Subscription;
|
|
1105
|
+
/** Newly created subscription for the target account. */
|
|
1106
|
+
targetSubscription?: Subscription;
|
|
1107
|
+
}
|
|
1108
|
+
/** Triggered when a recurring charge succeeds for a subscription. */
|
|
1109
|
+
interface RecurringChargeSucceeded {
|
|
1110
|
+
/** Subscription for which the recurring charge has succeeded. */
|
|
1111
|
+
subscription?: Subscription;
|
|
1112
|
+
/** Indication that there was a successful charge at the end of the free trial period */
|
|
1113
|
+
freeTrialPeriodEnd?: boolean;
|
|
1114
|
+
}
|
|
1115
|
+
/**
|
|
1116
|
+
* Triggered when a subscription was updated including when its product has been
|
|
1117
|
+
* up- or downgraded or the billing cycle is changed.
|
|
1118
|
+
*/
|
|
1119
|
+
interface ContractSwitched {
|
|
1120
|
+
/** Updated subscription. */
|
|
1121
|
+
subscription?: Subscription;
|
|
1122
|
+
/** Billing cycle before the update. */
|
|
1123
|
+
previousCycle?: Cycle;
|
|
1124
|
+
/** ID of the product belonging to the subscription before the update. */
|
|
1125
|
+
previousProductId?: string;
|
|
1126
|
+
/** ID of the product type that the subscription's original product belonged to before the update. */
|
|
1127
|
+
previousProductTypeId?: string;
|
|
1128
|
+
/**
|
|
1129
|
+
* Update type. __Note__: Doesn't include information about a product adjustment.
|
|
1130
|
+
* For that purpose, see `productAdjustment`.
|
|
1131
|
+
*
|
|
1132
|
+
* + `"NOT_APPLICABLE"`: Default value.
|
|
1133
|
+
* + `"ADDITIONAL_QUANTITY"`: An increased usage quota is added to the subscription. For example, a second mailbox is added to a subscription that previously included a single mailbox.
|
|
1134
|
+
* + `"CREDIT_UNUSED_PERIOD"`: The subscription is upgraded and the new price is less than the regular price. The new price applies to every billing cycle, not just the first cycle.
|
|
1135
|
+
* + `"REFUND_PRICE_DIFF"`: Not implemented.
|
|
1136
|
+
* + `"ADJUST_PERIOD_END"`: Not implemented.
|
|
1137
|
+
* + `"DOWNGRADE_GRACE_PERIOD"`: For downgrades during the grace period. In this situation, the site owner hasn’t paid yet and must immediately pay for the downgraded subscription.
|
|
1138
|
+
* + `"FULL_AMOUNT_PERIOD"`: For upgrades in which the site owner retains unused benefits. For example, site owners upgrading a Facebook Ads subscription retain their unused FB Ads credit. The unused credit is added to the new credit.
|
|
1139
|
+
* + `"END_OF_PERIOD"`: The subscription's billing current cycle is extended because of a downgrade.
|
|
1140
|
+
* + `"PENDING_CHANGES"`: The subscription's billing is updated, but the change doesn't apply immediately. Instead, the update becomes effective at the end of current billing cycle.
|
|
1141
|
+
* + `"DOWNGRADE_RENEWAL"`: The subscription is downgraded because of a declined payment. This prevents subscriptions from churning.
|
|
1142
|
+
*/
|
|
1143
|
+
contractSwitchType?: ContractSwitchType;
|
|
1144
|
+
/**
|
|
1145
|
+
* ID of the metasite the subscription has been assigned to previously.
|
|
1146
|
+
* Available only in case the subscription is assigned to a different site.
|
|
1147
|
+
*/
|
|
1148
|
+
previousMetaSiteId?: string | null;
|
|
1149
|
+
/**
|
|
1150
|
+
* Update reason.
|
|
1151
|
+
*
|
|
1152
|
+
* + `"PRICE_INCREASE"`: The subscription's price has been increased.
|
|
1153
|
+
* + `"EXTERNAL_PROVIDER_TRIGGER"`: Any reason other than a price increase.
|
|
1154
|
+
*/
|
|
1155
|
+
contractSwitchReason?: ContractSwitchReason;
|
|
1156
|
+
/** Information about the price update. Available only for updates with a price increase. */
|
|
1157
|
+
productPriceIncreaseData?: ProductPriceIncreaseData;
|
|
1158
|
+
/**
|
|
1159
|
+
* Information about a product adjustment. For example, a downgrade.
|
|
1160
|
+
* __Note__: This isn't the same as `contractSwitchType`.
|
|
1161
|
+
*
|
|
1162
|
+
* + `NOT_APPLICABLE`: There is no information about whether the product has been up- or downgraded.
|
|
1163
|
+
* + `DOWNGRADE`: The product has been downgraded.
|
|
1164
|
+
*/
|
|
1165
|
+
productAdjustment?: ProductAdjustment;
|
|
1166
|
+
}
|
|
1167
|
+
/** Copied from SBS */
|
|
1168
|
+
declare enum ContractSwitchType {
|
|
1169
|
+
NOT_APPLICABLE = "NOT_APPLICABLE",
|
|
1170
|
+
ADDITIONAL_QUANTITY = "ADDITIONAL_QUANTITY",
|
|
1171
|
+
CREDIT_UNUSED_PERIOD = "CREDIT_UNUSED_PERIOD",
|
|
1172
|
+
REFUND_PRICE_DIFF = "REFUND_PRICE_DIFF",
|
|
1173
|
+
ADJUST_PERIOD_END = "ADJUST_PERIOD_END",
|
|
1174
|
+
DOWNGRADE_GRACE_PERIOD = "DOWNGRADE_GRACE_PERIOD",
|
|
1175
|
+
FULL_AMOUNT_PERIOD = "FULL_AMOUNT_PERIOD",
|
|
1176
|
+
END_OF_PERIOD = "END_OF_PERIOD",
|
|
1177
|
+
PENDING_CHANGES = "PENDING_CHANGES",
|
|
1178
|
+
DOWNGRADE_RENEWAL = "DOWNGRADE_RENEWAL"
|
|
1179
|
+
}
|
|
1180
|
+
declare enum ContractSwitchReason {
|
|
1181
|
+
EXTERNAL_PROVIDER_TRIGGER = "EXTERNAL_PROVIDER_TRIGGER",
|
|
1182
|
+
PRICE_INCREASE = "PRICE_INCREASE"
|
|
1183
|
+
}
|
|
1184
|
+
/** Triggered when a subscription's price is increased. */
|
|
1185
|
+
interface ProductPriceIncreaseData {
|
|
1186
|
+
/** Price of the subscription before the update. */
|
|
1187
|
+
previousPrice?: string | null;
|
|
1188
|
+
/** A value that is used in order to select the correct email template to send the user regarding the price increase. */
|
|
1189
|
+
emailTemplateSelector?: string | null;
|
|
1190
|
+
/** Used to differentiate between migration segments. Does not have to be unique per segment. */
|
|
1191
|
+
segmentName?: string | null;
|
|
1192
|
+
/** Used to determine how the price increase was triggered. */
|
|
1193
|
+
priceIncreaseTrigger?: PriceIncreaseTrigger;
|
|
1194
|
+
}
|
|
1195
|
+
/** Reason for Price Increase Trigger */
|
|
1196
|
+
declare enum PriceIncreaseTrigger {
|
|
1197
|
+
NEAR_RENEWAL = "NEAR_RENEWAL",
|
|
1198
|
+
RECURRING_SUCCESS = "RECURRING_SUCCESS",
|
|
1199
|
+
MANUAL = "MANUAL"
|
|
1200
|
+
}
|
|
1201
|
+
/** Triggered when a subscription's product is adusted. */
|
|
1202
|
+
declare enum ProductAdjustment {
|
|
1203
|
+
/** flag to show that the ContractSwitchedEvent is not applicable / needed */
|
|
1204
|
+
NOT_APPLICABLE = "NOT_APPLICABLE",
|
|
1205
|
+
/** flag to show that the ContractSwitchedEvent is a Downgrade */
|
|
1206
|
+
DOWNGRADE = "DOWNGRADE"
|
|
1207
|
+
}
|
|
1208
|
+
/**
|
|
1209
|
+
* Triggered when a subscription gets close to the end of its billing cycle.
|
|
1210
|
+
* The exact number of days is defined in the billing system.
|
|
1211
|
+
*/
|
|
1212
|
+
interface SubscriptionNearEndOfPeriod {
|
|
1213
|
+
/** Subscription that got close to the end of its billing cycle. */
|
|
1214
|
+
subscription?: Subscription;
|
|
1215
|
+
/** Whether the subscription is within the free trial period. */
|
|
1216
|
+
inFreeTrial?: boolean;
|
|
1217
|
+
}
|
|
1218
|
+
/**
|
|
1219
|
+
* Triggered when a subscription is updated and the change doesn't happen
|
|
1220
|
+
* immediately but at the end of the current billing cycle.
|
|
1221
|
+
*/
|
|
1222
|
+
interface SubscriptionPendingChange {
|
|
1223
|
+
/** Subscription for which a pending update is triggered. */
|
|
1224
|
+
subscription?: Subscription;
|
|
1225
|
+
}
|
|
1226
|
+
interface MessageEnvelope$4 {
|
|
1227
|
+
/** App instance ID. */
|
|
1228
|
+
instanceId?: string | null;
|
|
1229
|
+
/** Event type. */
|
|
1230
|
+
eventType?: string;
|
|
1231
|
+
/** The identification type and identity data. */
|
|
1232
|
+
identity?: IdentificationData$4;
|
|
1233
|
+
/** Stringify payload. */
|
|
1234
|
+
data?: string;
|
|
1235
|
+
}
|
|
1236
|
+
interface IdentificationData$4 extends IdentificationDataIdOneOf$4 {
|
|
1237
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1238
|
+
anonymousVisitorId?: string;
|
|
1239
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1240
|
+
memberId?: string;
|
|
1241
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1242
|
+
wixUserId?: string;
|
|
1243
|
+
/** ID of an app. */
|
|
1244
|
+
appId?: string;
|
|
1245
|
+
/** @readonly */
|
|
1246
|
+
identityType?: WebhookIdentityType$4;
|
|
1247
|
+
}
|
|
1248
|
+
/** @oneof */
|
|
1249
|
+
interface IdentificationDataIdOneOf$4 {
|
|
1250
|
+
/** ID of a site visitor that has not logged in to the site. */
|
|
1251
|
+
anonymousVisitorId?: string;
|
|
1252
|
+
/** ID of a site visitor that has logged in to the site. */
|
|
1253
|
+
memberId?: string;
|
|
1254
|
+
/** ID of a Wix user (site owner, contributor, etc.). */
|
|
1255
|
+
wixUserId?: string;
|
|
1256
|
+
/** ID of an app. */
|
|
1257
|
+
appId?: string;
|
|
1258
|
+
}
|
|
1259
|
+
declare enum WebhookIdentityType$4 {
|
|
1260
|
+
UNKNOWN = "UNKNOWN",
|
|
1261
|
+
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
1262
|
+
MEMBER = "MEMBER",
|
|
1263
|
+
WIX_USER = "WIX_USER",
|
|
1264
|
+
APP = "APP"
|
|
1265
|
+
}
|
|
1266
|
+
interface FixedAmountDiscountNonNullableFields$2 {
|
|
1267
|
+
amount: number;
|
|
1268
|
+
}
|
|
1269
|
+
interface PercentageDiscountNonNullableFields$2 {
|
|
1270
|
+
percentage: number;
|
|
1271
|
+
}
|
|
1272
|
+
interface GroupNonNullableFields$2 {
|
|
1273
|
+
name: string;
|
|
1274
|
+
}
|
|
1275
|
+
interface CouponScopeNonNullableFields$2 {
|
|
1276
|
+
namespace: string;
|
|
1277
|
+
group?: GroupNonNullableFields$2;
|
|
1278
|
+
}
|
|
1279
|
+
interface CouponNonNullableFields$2 {
|
|
1280
|
+
fixedAmountOptions?: FixedAmountDiscountNonNullableFields$2;
|
|
1281
|
+
percentageOptions?: PercentageDiscountNonNullableFields$2;
|
|
1282
|
+
minimumSubtotal: number;
|
|
1283
|
+
scope?: CouponScopeNonNullableFields$2;
|
|
1284
|
+
name: string;
|
|
1285
|
+
discountType: DiscountType$2;
|
|
1286
|
+
}
|
|
1287
|
+
interface LoyaltyPointsNonNullableFields$1 {
|
|
1288
|
+
amount: number;
|
|
1289
|
+
}
|
|
1290
|
+
interface RewardNonNullableFields {
|
|
1291
|
+
couponOptions?: CouponNonNullableFields$2;
|
|
1292
|
+
loyaltyPointsOptions?: LoyaltyPointsNonNullableFields$1;
|
|
1293
|
+
type: Type$1;
|
|
1294
|
+
}
|
|
1295
|
+
interface EmailsNonNullableFields {
|
|
1296
|
+
encourageToReferFriends: App[];
|
|
1297
|
+
notifyCustomersAboutReward: boolean;
|
|
1298
|
+
}
|
|
1299
|
+
interface ReferralProgramNonNullableFields {
|
|
1300
|
+
status: ProgramStatus;
|
|
1301
|
+
referredFriendReward?: RewardNonNullableFields;
|
|
1302
|
+
referringCustomerReward?: RewardNonNullableFields;
|
|
1303
|
+
successfulReferralActions: Action[];
|
|
1304
|
+
isPremium: boolean;
|
|
1305
|
+
emails?: EmailsNonNullableFields;
|
|
1306
|
+
}
|
|
1307
|
+
interface GetReferralProgramResponseNonNullableFields {
|
|
1308
|
+
referralProgram?: ReferralProgramNonNullableFields;
|
|
1309
|
+
}
|
|
1310
|
+
interface QueryReferralProgramsResponseNonNullableFields {
|
|
1311
|
+
referralPrograms: ReferralProgramNonNullableFields[];
|
|
1312
|
+
}
|
|
1313
|
+
interface UpdateReferralProgramResponseNonNullableFields {
|
|
1314
|
+
referralProgram?: ReferralProgramNonNullableFields;
|
|
1315
|
+
}
|
|
1316
|
+
interface ActivateReferralProgramResponseNonNullableFields {
|
|
1317
|
+
referralProgram?: ReferralProgramNonNullableFields;
|
|
1318
|
+
}
|
|
1319
|
+
interface PauseReferralProgramResponseNonNullableFields {
|
|
1320
|
+
referralProgram?: ReferralProgramNonNullableFields;
|
|
1321
|
+
}
|
|
1322
|
+
interface AISocialMediaPostSuggestionNonNullableFields {
|
|
1323
|
+
postContent: string;
|
|
1324
|
+
hashtags: string[];
|
|
1325
|
+
}
|
|
1326
|
+
interface GetAISocialMediaPostsSuggestionsResponseNonNullableFields {
|
|
1327
|
+
suggestions: AISocialMediaPostSuggestionNonNullableFields[];
|
|
1328
|
+
}
|
|
1329
|
+
interface GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields {
|
|
1330
|
+
suggestions: AISocialMediaPostSuggestionNonNullableFields[];
|
|
1331
|
+
}
|
|
1332
|
+
interface GetReferralProgramPremiumFeaturesResponseNonNullableFields {
|
|
1333
|
+
referralProgram: boolean;
|
|
1334
|
+
}
|
|
1335
|
+
interface BaseEventMetadata$3 {
|
|
1336
|
+
/** App instance ID. */
|
|
1337
|
+
instanceId?: string | null;
|
|
1338
|
+
/** Event type. */
|
|
1339
|
+
eventType?: string;
|
|
1340
|
+
/** The identification type and identity data. */
|
|
1341
|
+
identity?: IdentificationData$4;
|
|
1342
|
+
}
|
|
1343
|
+
interface EventMetadata$3 extends BaseEventMetadata$3 {
|
|
1344
|
+
/**
|
|
1345
|
+
* Unique event ID.
|
|
1346
|
+
* Allows clients to ignore duplicate webhooks.
|
|
1347
|
+
*/
|
|
1348
|
+
_id?: string;
|
|
1349
|
+
/**
|
|
1350
|
+
* Assumes actions are also always typed to an entity_type
|
|
1351
|
+
* Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
|
|
1352
|
+
*/
|
|
1353
|
+
entityFqdn?: string;
|
|
1354
|
+
/**
|
|
1355
|
+
* This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
|
|
1356
|
+
* This is although the created/updated/deleted notion is duplication of the oneof types
|
|
1357
|
+
* Example: created/updated/deleted/started/completed/email_opened
|
|
1358
|
+
*/
|
|
1359
|
+
slug?: string;
|
|
1360
|
+
/** ID of the entity associated with the event. */
|
|
1361
|
+
entityId?: string;
|
|
1362
|
+
/** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z */
|
|
1363
|
+
eventTime?: Date;
|
|
1364
|
+
/**
|
|
1365
|
+
* Whether the event was triggered as a result of a privacy regulation application
|
|
1366
|
+
* (for example, GDPR).
|
|
1367
|
+
*/
|
|
1368
|
+
triggeredByAnonymizeRequest?: boolean | null;
|
|
1369
|
+
/** If present, indicates the action that triggered the event. */
|
|
1370
|
+
originatedFrom?: string | null;
|
|
1371
|
+
/**
|
|
1372
|
+
* A sequence number defining the order of updates to the underlying entity.
|
|
1373
|
+
* For example, given that some entity was updated at 16:00 and than again at 16:01,
|
|
1374
|
+
* it is guaranteed that the sequence number of the second update is strictly higher than the first.
|
|
1375
|
+
* As the consumer, you can use this value to ensure that you handle messages in the correct order.
|
|
1376
|
+
* To do so, you will need to persist this number on your end, and compare the sequence number from the
|
|
1377
|
+
* message against the one you have stored. Given that the stored number is higher, you should ignore the message.
|
|
1378
|
+
*/
|
|
1379
|
+
entityEventSequence?: string | null;
|
|
1380
|
+
}
|
|
1381
|
+
interface ProgramUpdatedEnvelope {
|
|
1382
|
+
entity: ReferralProgram;
|
|
1383
|
+
metadata: EventMetadata$3;
|
|
1384
|
+
}
|
|
1385
|
+
interface QueryCursorResult$3 {
|
|
1386
|
+
cursors: Cursors$4;
|
|
1387
|
+
hasNext: () => boolean;
|
|
1388
|
+
hasPrev: () => boolean;
|
|
1389
|
+
length: number;
|
|
1390
|
+
pageSize: number;
|
|
1391
|
+
}
|
|
1392
|
+
interface ReferralProgramsQueryResult extends QueryCursorResult$3 {
|
|
1393
|
+
items: ReferralProgram[];
|
|
1394
|
+
query: ReferralProgramsQueryBuilder;
|
|
1395
|
+
next: () => Promise<ReferralProgramsQueryResult>;
|
|
1396
|
+
prev: () => Promise<ReferralProgramsQueryResult>;
|
|
1397
|
+
}
|
|
1398
|
+
interface ReferralProgramsQueryBuilder {
|
|
1399
|
+
/** @param limit - Number of items to return, which is also the `pageSize` of the results object.
|
|
1400
|
+
* @documentationMaturity preview
|
|
1401
|
+
*/
|
|
1402
|
+
limit: (limit: number) => ReferralProgramsQueryBuilder;
|
|
1403
|
+
/** @param cursor - A pointer to specific record
|
|
1404
|
+
* @documentationMaturity preview
|
|
1405
|
+
*/
|
|
1406
|
+
skipTo: (cursor: string) => ReferralProgramsQueryBuilder;
|
|
1407
|
+
/** @documentationMaturity preview */
|
|
1408
|
+
find: () => Promise<ReferralProgramsQueryResult>;
|
|
1409
|
+
}
|
|
1410
|
+
interface GetAiSocialMediaPostsSuggestionsOptions {
|
|
1411
|
+
/** The topic to generate suggestions for. */
|
|
1412
|
+
topic?: string;
|
|
1413
|
+
}
|
|
1414
|
+
interface GenerateAiSocialMediaPostsSuggestionsOptions {
|
|
1415
|
+
/** The topic to generate suggestions for. */
|
|
1416
|
+
topic?: string;
|
|
1417
|
+
}
|
|
1418
|
+
|
|
1419
|
+
type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
|
|
1420
|
+
interface HttpClient {
|
|
1421
|
+
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
1422
|
+
fetchWithAuth: typeof fetch;
|
|
1423
|
+
wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
|
|
1424
|
+
}
|
|
1425
|
+
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
1426
|
+
type HttpResponse<T = any> = {
|
|
1427
|
+
data: T;
|
|
1428
|
+
status: number;
|
|
1429
|
+
statusText: string;
|
|
1430
|
+
headers: any;
|
|
1431
|
+
request?: any;
|
|
1432
|
+
};
|
|
1433
|
+
type RequestOptions<_TResponse = any, Data = any> = {
|
|
1434
|
+
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
1435
|
+
url: string;
|
|
1436
|
+
data?: Data;
|
|
1437
|
+
params?: URLSearchParams;
|
|
1438
|
+
} & APIMetadata;
|
|
1439
|
+
type APIMetadata = {
|
|
1440
|
+
methodFqn?: string;
|
|
1441
|
+
entityFqdn?: string;
|
|
1442
|
+
packageName?: string;
|
|
1443
|
+
};
|
|
1444
|
+
type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
|
|
1445
|
+
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
1446
|
+
__type: 'event-definition';
|
|
1447
|
+
type: Type;
|
|
1448
|
+
isDomainEvent?: boolean;
|
|
1449
|
+
transformations?: (envelope: unknown) => Payload;
|
|
1450
|
+
__payload: Payload;
|
|
1451
|
+
};
|
|
1452
|
+
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
1453
|
+
type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
|
|
1454
|
+
type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
|
|
1455
|
+
|
|
1456
|
+
declare global {
|
|
1457
|
+
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
1458
|
+
interface SymbolConstructor {
|
|
1459
|
+
readonly observable: symbol;
|
|
1460
|
+
}
|
|
1461
|
+
}
|
|
1462
|
+
|
|
1463
|
+
declare function createRESTModule$4<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
1464
|
+
|
|
1465
|
+
declare function createEventModule$3<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
1466
|
+
|
|
1467
|
+
declare const getReferralProgram: ReturnType<typeof createRESTModule$4<typeof publicGetReferralProgram>>;
|
|
1468
|
+
declare const queryReferralPrograms: ReturnType<typeof createRESTModule$4<typeof publicQueryReferralPrograms>>;
|
|
1469
|
+
declare const updateReferralProgram: ReturnType<typeof createRESTModule$4<typeof publicUpdateReferralProgram>>;
|
|
1470
|
+
declare const activateReferralProgram: ReturnType<typeof createRESTModule$4<typeof publicActivateReferralProgram>>;
|
|
1471
|
+
declare const pauseReferralProgram: ReturnType<typeof createRESTModule$4<typeof publicPauseReferralProgram>>;
|
|
1472
|
+
declare const getAiSocialMediaPostsSuggestions: ReturnType<typeof createRESTModule$4<typeof publicGetAiSocialMediaPostsSuggestions>>;
|
|
1473
|
+
declare const generateAiSocialMediaPostsSuggestions: ReturnType<typeof createRESTModule$4<typeof publicGenerateAiSocialMediaPostsSuggestions>>;
|
|
1474
|
+
declare const getReferralProgramPremiumFeatures: ReturnType<typeof createRESTModule$4<typeof publicGetReferralProgramPremiumFeatures>>;
|
|
1475
|
+
declare const onProgramUpdated: ReturnType<typeof createEventModule$3<typeof publicOnProgramUpdated>>;
|
|
1476
|
+
|
|
1477
|
+
type index_d$4_AISocialMediaPostSuggestion = AISocialMediaPostSuggestion;
|
|
1478
|
+
type index_d$4_Action = Action;
|
|
1479
|
+
declare const index_d$4_Action: typeof Action;
|
|
1480
|
+
type index_d$4_ActivateReferralProgramRequest = ActivateReferralProgramRequest;
|
|
1481
|
+
type index_d$4_ActivateReferralProgramResponse = ActivateReferralProgramResponse;
|
|
1482
|
+
type index_d$4_ActivateReferralProgramResponseNonNullableFields = ActivateReferralProgramResponseNonNullableFields;
|
|
1483
|
+
type index_d$4_App = App;
|
|
1484
|
+
declare const index_d$4_App: typeof App;
|
|
1485
|
+
type index_d$4_Asset = Asset;
|
|
1486
|
+
type index_d$4_BillingReference = BillingReference;
|
|
1487
|
+
type index_d$4_BulkGetReferralProgramRequest = BulkGetReferralProgramRequest;
|
|
1488
|
+
type index_d$4_BulkGetReferralProgramResponse = BulkGetReferralProgramResponse;
|
|
1489
|
+
type index_d$4_CancellationDetails = CancellationDetails;
|
|
1490
|
+
type index_d$4_ContractSwitchReason = ContractSwitchReason;
|
|
1491
|
+
declare const index_d$4_ContractSwitchReason: typeof ContractSwitchReason;
|
|
1492
|
+
type index_d$4_ContractSwitchType = ContractSwitchType;
|
|
1493
|
+
declare const index_d$4_ContractSwitchType: typeof ContractSwitchType;
|
|
1494
|
+
type index_d$4_ContractSwitched = ContractSwitched;
|
|
1495
|
+
type index_d$4_Cycle = Cycle;
|
|
1496
|
+
type index_d$4_CycleCycleSelectorOneOf = CycleCycleSelectorOneOf;
|
|
1497
|
+
type index_d$4_DeleteContext = DeleteContext;
|
|
1498
|
+
type index_d$4_DeleteStatus = DeleteStatus;
|
|
1499
|
+
declare const index_d$4_DeleteStatus: typeof DeleteStatus;
|
|
1500
|
+
type index_d$4_Emails = Emails;
|
|
1501
|
+
type index_d$4_GenerateAISocialMediaPostsSuggestionsRequest = GenerateAISocialMediaPostsSuggestionsRequest;
|
|
1502
|
+
type index_d$4_GenerateAISocialMediaPostsSuggestionsResponse = GenerateAISocialMediaPostsSuggestionsResponse;
|
|
1503
|
+
type index_d$4_GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields = GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields;
|
|
1504
|
+
type index_d$4_GenerateAiSocialMediaPostsSuggestionsOptions = GenerateAiSocialMediaPostsSuggestionsOptions;
|
|
1505
|
+
type index_d$4_GetAISocialMediaPostsSuggestionsRequest = GetAISocialMediaPostsSuggestionsRequest;
|
|
1506
|
+
type index_d$4_GetAISocialMediaPostsSuggestionsResponse = GetAISocialMediaPostsSuggestionsResponse;
|
|
1507
|
+
type index_d$4_GetAISocialMediaPostsSuggestionsResponseNonNullableFields = GetAISocialMediaPostsSuggestionsResponseNonNullableFields;
|
|
1508
|
+
type index_d$4_GetAiSocialMediaPostsSuggestionsOptions = GetAiSocialMediaPostsSuggestionsOptions;
|
|
1509
|
+
type index_d$4_GetReferralProgramPremiumFeaturesRequest = GetReferralProgramPremiumFeaturesRequest;
|
|
1510
|
+
type index_d$4_GetReferralProgramPremiumFeaturesResponse = GetReferralProgramPremiumFeaturesResponse;
|
|
1511
|
+
type index_d$4_GetReferralProgramPremiumFeaturesResponseNonNullableFields = GetReferralProgramPremiumFeaturesResponseNonNullableFields;
|
|
1512
|
+
type index_d$4_GetReferralProgramRequest = GetReferralProgramRequest;
|
|
1513
|
+
type index_d$4_GetReferralProgramResponse = GetReferralProgramResponse;
|
|
1514
|
+
type index_d$4_GetReferralProgramResponseNonNullableFields = GetReferralProgramResponseNonNullableFields;
|
|
1515
|
+
type index_d$4_HtmlSitePublished = HtmlSitePublished;
|
|
1516
|
+
type index_d$4_Initiator = Initiator;
|
|
1517
|
+
declare const index_d$4_Initiator: typeof Initiator;
|
|
1518
|
+
type index_d$4_Interval = Interval;
|
|
1519
|
+
type index_d$4_IntervalUnit = IntervalUnit;
|
|
1520
|
+
declare const index_d$4_IntervalUnit: typeof IntervalUnit;
|
|
1521
|
+
type index_d$4_MetaSiteSpecialEvent = MetaSiteSpecialEvent;
|
|
1522
|
+
type index_d$4_MetaSiteSpecialEventPayloadOneOf = MetaSiteSpecialEventPayloadOneOf;
|
|
1523
|
+
type index_d$4_Namespace = Namespace;
|
|
1524
|
+
declare const index_d$4_Namespace: typeof Namespace;
|
|
1525
|
+
type index_d$4_NamespaceChanged = NamespaceChanged;
|
|
1526
|
+
type index_d$4_OneTime = OneTime;
|
|
1527
|
+
type index_d$4_Page = Page;
|
|
1528
|
+
type index_d$4_PauseReferralProgramRequest = PauseReferralProgramRequest;
|
|
1529
|
+
type index_d$4_PauseReferralProgramResponse = PauseReferralProgramResponse;
|
|
1530
|
+
type index_d$4_PauseReferralProgramResponseNonNullableFields = PauseReferralProgramResponseNonNullableFields;
|
|
1531
|
+
type index_d$4_PriceIncreaseTrigger = PriceIncreaseTrigger;
|
|
1532
|
+
declare const index_d$4_PriceIncreaseTrigger: typeof PriceIncreaseTrigger;
|
|
1533
|
+
type index_d$4_ProductAdjustment = ProductAdjustment;
|
|
1534
|
+
declare const index_d$4_ProductAdjustment: typeof ProductAdjustment;
|
|
1535
|
+
type index_d$4_ProductPriceIncreaseData = ProductPriceIncreaseData;
|
|
1536
|
+
type index_d$4_ProgramInSite = ProgramInSite;
|
|
1537
|
+
type index_d$4_ProgramStatus = ProgramStatus;
|
|
1538
|
+
declare const index_d$4_ProgramStatus: typeof ProgramStatus;
|
|
1539
|
+
type index_d$4_ProgramUpdatedEnvelope = ProgramUpdatedEnvelope;
|
|
1540
|
+
type index_d$4_ProviderName = ProviderName;
|
|
1541
|
+
declare const index_d$4_ProviderName: typeof ProviderName;
|
|
1542
|
+
type index_d$4_QueryReferralProgramsRequest = QueryReferralProgramsRequest;
|
|
1543
|
+
type index_d$4_QueryReferralProgramsResponse = QueryReferralProgramsResponse;
|
|
1544
|
+
type index_d$4_QueryReferralProgramsResponseNonNullableFields = QueryReferralProgramsResponseNonNullableFields;
|
|
1545
|
+
type index_d$4_ReactivationData = ReactivationData;
|
|
1546
|
+
type index_d$4_ReactivationReasonEnum = ReactivationReasonEnum;
|
|
1547
|
+
declare const index_d$4_ReactivationReasonEnum: typeof ReactivationReasonEnum;
|
|
1548
|
+
type index_d$4_RecurringChargeSucceeded = RecurringChargeSucceeded;
|
|
1549
|
+
type index_d$4_ReferralProgram = ReferralProgram;
|
|
1550
|
+
type index_d$4_ReferralProgramsQueryBuilder = ReferralProgramsQueryBuilder;
|
|
1551
|
+
type index_d$4_ReferralProgramsQueryResult = ReferralProgramsQueryResult;
|
|
1552
|
+
type index_d$4_RestoreInfo = RestoreInfo;
|
|
1553
|
+
type index_d$4_ServiceProvisioned = ServiceProvisioned;
|
|
1554
|
+
type index_d$4_ServiceRemoved = ServiceRemoved;
|
|
1555
|
+
type index_d$4_SiteCreated = SiteCreated;
|
|
1556
|
+
type index_d$4_SiteCreatedContext = SiteCreatedContext;
|
|
1557
|
+
declare const index_d$4_SiteCreatedContext: typeof SiteCreatedContext;
|
|
1558
|
+
type index_d$4_SiteDeleted = SiteDeleted;
|
|
1559
|
+
type index_d$4_SiteHardDeleted = SiteHardDeleted;
|
|
1560
|
+
type index_d$4_SiteMarkedAsTemplate = SiteMarkedAsTemplate;
|
|
1561
|
+
type index_d$4_SiteMarkedAsWixSite = SiteMarkedAsWixSite;
|
|
1562
|
+
type index_d$4_SitePublished = SitePublished;
|
|
1563
|
+
type index_d$4_SiteRenamed = SiteRenamed;
|
|
1564
|
+
type index_d$4_SiteTransferred = SiteTransferred;
|
|
1565
|
+
type index_d$4_SiteUndeleted = SiteUndeleted;
|
|
1566
|
+
type index_d$4_SiteUnpublished = SiteUnpublished;
|
|
1567
|
+
type index_d$4_State = State;
|
|
1568
|
+
declare const index_d$4_State: typeof State;
|
|
1569
|
+
type index_d$4_StudioAssigned = StudioAssigned;
|
|
1570
|
+
type index_d$4_StudioUnassigned = StudioUnassigned;
|
|
1571
|
+
type index_d$4_Subscription = Subscription;
|
|
1572
|
+
type index_d$4_SubscriptionAssigned = SubscriptionAssigned;
|
|
1573
|
+
type index_d$4_SubscriptionAutoRenewTurnedOff = SubscriptionAutoRenewTurnedOff;
|
|
1574
|
+
type index_d$4_SubscriptionAutoRenewTurnedOn = SubscriptionAutoRenewTurnedOn;
|
|
1575
|
+
type index_d$4_SubscriptionCancelled = SubscriptionCancelled;
|
|
1576
|
+
type index_d$4_SubscriptionCreated = SubscriptionCreated;
|
|
1577
|
+
type index_d$4_SubscriptionEvent = SubscriptionEvent;
|
|
1578
|
+
type index_d$4_SubscriptionEventEventOneOf = SubscriptionEventEventOneOf;
|
|
1579
|
+
type index_d$4_SubscriptionNearEndOfPeriod = SubscriptionNearEndOfPeriod;
|
|
1580
|
+
type index_d$4_SubscriptionPendingChange = SubscriptionPendingChange;
|
|
1581
|
+
type index_d$4_SubscriptionStatus = SubscriptionStatus;
|
|
1582
|
+
declare const index_d$4_SubscriptionStatus: typeof SubscriptionStatus;
|
|
1583
|
+
type index_d$4_SubscriptionTransferred = SubscriptionTransferred;
|
|
1584
|
+
type index_d$4_SubscriptionUnassigned = SubscriptionUnassigned;
|
|
1585
|
+
type index_d$4_UnassignReason = UnassignReason;
|
|
1586
|
+
declare const index_d$4_UnassignReason: typeof UnassignReason;
|
|
1587
|
+
type index_d$4_UpdateReferralProgramRequest = UpdateReferralProgramRequest;
|
|
1588
|
+
type index_d$4_UpdateReferralProgramResponse = UpdateReferralProgramResponse;
|
|
1589
|
+
type index_d$4_UpdateReferralProgramResponseNonNullableFields = UpdateReferralProgramResponseNonNullableFields;
|
|
1590
|
+
declare const index_d$4_activateReferralProgram: typeof activateReferralProgram;
|
|
1591
|
+
declare const index_d$4_generateAiSocialMediaPostsSuggestions: typeof generateAiSocialMediaPostsSuggestions;
|
|
1592
|
+
declare const index_d$4_getAiSocialMediaPostsSuggestions: typeof getAiSocialMediaPostsSuggestions;
|
|
1593
|
+
declare const index_d$4_getReferralProgram: typeof getReferralProgram;
|
|
1594
|
+
declare const index_d$4_getReferralProgramPremiumFeatures: typeof getReferralProgramPremiumFeatures;
|
|
1595
|
+
declare const index_d$4_onProgramUpdated: typeof onProgramUpdated;
|
|
1596
|
+
declare const index_d$4_pauseReferralProgram: typeof pauseReferralProgram;
|
|
1597
|
+
declare const index_d$4_queryReferralPrograms: typeof queryReferralPrograms;
|
|
1598
|
+
declare const index_d$4_updateReferralProgram: typeof updateReferralProgram;
|
|
1599
|
+
declare namespace index_d$4 {
|
|
1600
|
+
export { type index_d$4_AISocialMediaPostSuggestion as AISocialMediaPostSuggestion, index_d$4_Action as Action, type ActionEvent$4 as ActionEvent, type index_d$4_ActivateReferralProgramRequest as ActivateReferralProgramRequest, type index_d$4_ActivateReferralProgramResponse as ActivateReferralProgramResponse, type index_d$4_ActivateReferralProgramResponseNonNullableFields as ActivateReferralProgramResponseNonNullableFields, index_d$4_App as App, type index_d$4_Asset as Asset, type BaseEventMetadata$3 as BaseEventMetadata, type index_d$4_BillingReference as BillingReference, type index_d$4_BulkGetReferralProgramRequest as BulkGetReferralProgramRequest, type index_d$4_BulkGetReferralProgramResponse as BulkGetReferralProgramResponse, type index_d$4_CancellationDetails as CancellationDetails, index_d$4_ContractSwitchReason as ContractSwitchReason, index_d$4_ContractSwitchType as ContractSwitchType, type index_d$4_ContractSwitched as ContractSwitched, type Coupon$2 as Coupon, type CouponDiscountTypeOptionsOneOf$2 as CouponDiscountTypeOptionsOneOf, type CouponScope$2 as CouponScope, type CouponScopeOrMinSubtotalOneOf$2 as CouponScopeOrMinSubtotalOneOf, type CursorPaging$4 as CursorPaging, type CursorPagingMetadata$4 as CursorPagingMetadata, type CursorQuery$4 as CursorQuery, type CursorQueryPagingMethodOneOf$4 as CursorQueryPagingMethodOneOf, type Cursors$4 as Cursors, type index_d$4_Cycle as Cycle, type index_d$4_CycleCycleSelectorOneOf as CycleCycleSelectorOneOf, type index_d$4_DeleteContext as DeleteContext, index_d$4_DeleteStatus as DeleteStatus, DiscountType$2 as DiscountType, type DomainEvent$4 as DomainEvent, type DomainEventBodyOneOf$4 as DomainEventBodyOneOf, type index_d$4_Emails as Emails, type Empty$3 as Empty, type EntityCreatedEvent$4 as EntityCreatedEvent, type EntityDeletedEvent$4 as EntityDeletedEvent, type EntityUpdatedEvent$4 as EntityUpdatedEvent, type EventMetadata$3 as EventMetadata, type FixedAmountDiscount$2 as FixedAmountDiscount, type index_d$4_GenerateAISocialMediaPostsSuggestionsRequest as GenerateAISocialMediaPostsSuggestionsRequest, type index_d$4_GenerateAISocialMediaPostsSuggestionsResponse as GenerateAISocialMediaPostsSuggestionsResponse, type index_d$4_GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields as GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields, type index_d$4_GenerateAiSocialMediaPostsSuggestionsOptions as GenerateAiSocialMediaPostsSuggestionsOptions, type index_d$4_GetAISocialMediaPostsSuggestionsRequest as GetAISocialMediaPostsSuggestionsRequest, type index_d$4_GetAISocialMediaPostsSuggestionsResponse as GetAISocialMediaPostsSuggestionsResponse, type index_d$4_GetAISocialMediaPostsSuggestionsResponseNonNullableFields as GetAISocialMediaPostsSuggestionsResponseNonNullableFields, type index_d$4_GetAiSocialMediaPostsSuggestionsOptions as GetAiSocialMediaPostsSuggestionsOptions, type index_d$4_GetReferralProgramPremiumFeaturesRequest as GetReferralProgramPremiumFeaturesRequest, type index_d$4_GetReferralProgramPremiumFeaturesResponse as GetReferralProgramPremiumFeaturesResponse, type index_d$4_GetReferralProgramPremiumFeaturesResponseNonNullableFields as GetReferralProgramPremiumFeaturesResponseNonNullableFields, type index_d$4_GetReferralProgramRequest as GetReferralProgramRequest, type index_d$4_GetReferralProgramResponse as GetReferralProgramResponse, type index_d$4_GetReferralProgramResponseNonNullableFields as GetReferralProgramResponseNonNullableFields, type Group$2 as Group, type index_d$4_HtmlSitePublished as HtmlSitePublished, type IdentificationData$4 as IdentificationData, type IdentificationDataIdOneOf$4 as IdentificationDataIdOneOf, index_d$4_Initiator as Initiator, type index_d$4_Interval as Interval, index_d$4_IntervalUnit as IntervalUnit, type LoyaltyPoints$2 as LoyaltyPoints, type MessageEnvelope$4 as MessageEnvelope, type index_d$4_MetaSiteSpecialEvent as MetaSiteSpecialEvent, type index_d$4_MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOf, index_d$4_Namespace as Namespace, type index_d$4_NamespaceChanged as NamespaceChanged, type index_d$4_OneTime as OneTime, type index_d$4_Page as Page, type index_d$4_PauseReferralProgramRequest as PauseReferralProgramRequest, type index_d$4_PauseReferralProgramResponse as PauseReferralProgramResponse, type index_d$4_PauseReferralProgramResponseNonNullableFields as PauseReferralProgramResponseNonNullableFields, type PercentageDiscount$2 as PercentageDiscount, index_d$4_PriceIncreaseTrigger as PriceIncreaseTrigger, index_d$4_ProductAdjustment as ProductAdjustment, type index_d$4_ProductPriceIncreaseData as ProductPriceIncreaseData, type index_d$4_ProgramInSite as ProgramInSite, index_d$4_ProgramStatus as ProgramStatus, type index_d$4_ProgramUpdatedEnvelope as ProgramUpdatedEnvelope, index_d$4_ProviderName as ProviderName, type index_d$4_QueryReferralProgramsRequest as QueryReferralProgramsRequest, type index_d$4_QueryReferralProgramsResponse as QueryReferralProgramsResponse, type index_d$4_QueryReferralProgramsResponseNonNullableFields as QueryReferralProgramsResponseNonNullableFields, type index_d$4_ReactivationData as ReactivationData, index_d$4_ReactivationReasonEnum as ReactivationReasonEnum, type index_d$4_RecurringChargeSucceeded as RecurringChargeSucceeded, type index_d$4_ReferralProgram as ReferralProgram, type index_d$4_ReferralProgramsQueryBuilder as ReferralProgramsQueryBuilder, type index_d$4_ReferralProgramsQueryResult as ReferralProgramsQueryResult, type index_d$4_RestoreInfo as RestoreInfo, type Reward$2 as Reward, type RewardOptionsOneOf$1 as RewardOptionsOneOf, type index_d$4_ServiceProvisioned as ServiceProvisioned, type index_d$4_ServiceRemoved as ServiceRemoved, type index_d$4_SiteCreated as SiteCreated, index_d$4_SiteCreatedContext as SiteCreatedContext, type index_d$4_SiteDeleted as SiteDeleted, type index_d$4_SiteHardDeleted as SiteHardDeleted, type index_d$4_SiteMarkedAsTemplate as SiteMarkedAsTemplate, type index_d$4_SiteMarkedAsWixSite as SiteMarkedAsWixSite, type index_d$4_SitePublished as SitePublished, type index_d$4_SiteRenamed as SiteRenamed, type index_d$4_SiteTransferred as SiteTransferred, type index_d$4_SiteUndeleted as SiteUndeleted, type index_d$4_SiteUnpublished as SiteUnpublished, SortOrder$4 as SortOrder, type Sorting$4 as Sorting, index_d$4_State as State, type index_d$4_StudioAssigned as StudioAssigned, type index_d$4_StudioUnassigned as StudioUnassigned, type index_d$4_Subscription as Subscription, type index_d$4_SubscriptionAssigned as SubscriptionAssigned, type index_d$4_SubscriptionAutoRenewTurnedOff as SubscriptionAutoRenewTurnedOff, type index_d$4_SubscriptionAutoRenewTurnedOn as SubscriptionAutoRenewTurnedOn, type index_d$4_SubscriptionCancelled as SubscriptionCancelled, type index_d$4_SubscriptionCreated as SubscriptionCreated, type index_d$4_SubscriptionEvent as SubscriptionEvent, type index_d$4_SubscriptionEventEventOneOf as SubscriptionEventEventOneOf, type index_d$4_SubscriptionNearEndOfPeriod as SubscriptionNearEndOfPeriod, type index_d$4_SubscriptionPendingChange as SubscriptionPendingChange, index_d$4_SubscriptionStatus as SubscriptionStatus, type index_d$4_SubscriptionTransferred as SubscriptionTransferred, type index_d$4_SubscriptionUnassigned as SubscriptionUnassigned, Type$1 as Type, index_d$4_UnassignReason as UnassignReason, type index_d$4_UpdateReferralProgramRequest as UpdateReferralProgramRequest, type index_d$4_UpdateReferralProgramResponse as UpdateReferralProgramResponse, type index_d$4_UpdateReferralProgramResponseNonNullableFields as UpdateReferralProgramResponseNonNullableFields, WebhookIdentityType$4 as WebhookIdentityType, index_d$4_activateReferralProgram as activateReferralProgram, index_d$4_generateAiSocialMediaPostsSuggestions as generateAiSocialMediaPostsSuggestions, index_d$4_getAiSocialMediaPostsSuggestions as getAiSocialMediaPostsSuggestions, index_d$4_getReferralProgram as getReferralProgram, index_d$4_getReferralProgramPremiumFeatures as getReferralProgramPremiumFeatures, index_d$4_onProgramUpdated as onProgramUpdated, index_d$4_pauseReferralProgram as pauseReferralProgram, index_d$4_queryReferralPrograms as queryReferralPrograms, index_d$4_updateReferralProgram as updateReferralProgram };
|
|
1601
|
+
}
|
|
1602
|
+
|
|
1
1603
|
/** ReferralEvent. */
|
|
2
1604
|
interface ReferralEvent extends ReferralEventEventTypeOneOf {
|
|
3
1605
|
/** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
|
|
@@ -346,17 +1948,17 @@ declare enum Status$2 {
|
|
|
346
1948
|
DELETED = "DELETED"
|
|
347
1949
|
}
|
|
348
1950
|
interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
|
|
349
|
-
/** Options for fixed amount discount type */
|
|
1951
|
+
/** Options for fixed amount discount type. */
|
|
350
1952
|
fixedAmountOptions?: FixedAmountDiscount$1;
|
|
351
|
-
/** Options for percentage discount type */
|
|
1953
|
+
/** Options for percentage discount type. */
|
|
352
1954
|
percentageOptions?: PercentageDiscount$1;
|
|
353
1955
|
/** Limit the coupon to carts with a subtotal above this number. */
|
|
354
1956
|
minimumSubtotal?: number;
|
|
355
1957
|
/** Specifies the type of line items this coupon will apply to. */
|
|
356
1958
|
scope?: CouponScope$1;
|
|
357
|
-
/** Coupon name */
|
|
1959
|
+
/** Coupon name. */
|
|
358
1960
|
name?: string;
|
|
359
|
-
/** Coupon discount type */
|
|
1961
|
+
/** Coupon discount type. */
|
|
360
1962
|
discountType?: DiscountType$1;
|
|
361
1963
|
/** Limit the coupon to only apply to one item in cart. */
|
|
362
1964
|
limitedToOneItem?: boolean | null;
|
|
@@ -367,9 +1969,9 @@ interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSub
|
|
|
367
1969
|
}
|
|
368
1970
|
/** @oneof */
|
|
369
1971
|
interface CouponDiscountTypeOptionsOneOf$1 {
|
|
370
|
-
/** Options for fixed amount discount type */
|
|
1972
|
+
/** Options for fixed amount discount type. */
|
|
371
1973
|
fixedAmountOptions?: FixedAmountDiscount$1;
|
|
372
|
-
/** Options for percentage discount type */
|
|
1974
|
+
/** Options for percentage discount type. */
|
|
373
1975
|
percentageOptions?: PercentageDiscount$1;
|
|
374
1976
|
}
|
|
375
1977
|
/** @oneof */
|
|
@@ -380,27 +1982,33 @@ interface CouponScopeOrMinSubtotalOneOf$1 {
|
|
|
380
1982
|
scope?: CouponScope$1;
|
|
381
1983
|
}
|
|
382
1984
|
declare enum DiscountType$1 {
|
|
1985
|
+
/** Unknown discount type. */
|
|
383
1986
|
UNKNOWN = "UNKNOWN",
|
|
384
|
-
/** Discount as a fixed amount */
|
|
1987
|
+
/** Discount as a fixed amount. */
|
|
385
1988
|
FIXED_AMOUNT = "FIXED_AMOUNT",
|
|
386
|
-
/** Discount as a percentage */
|
|
1989
|
+
/** Discount as a percentage. */
|
|
387
1990
|
PERCENTAGE = "PERCENTAGE",
|
|
388
|
-
/** Free shipping */
|
|
1991
|
+
/** Free shipping. */
|
|
389
1992
|
FREE_SHIPPING = "FREE_SHIPPING"
|
|
390
1993
|
}
|
|
391
1994
|
interface FixedAmountDiscount$1 {
|
|
392
|
-
/** Fixed amount to discount */
|
|
1995
|
+
/** Fixed amount to discount. */
|
|
393
1996
|
amount?: number;
|
|
394
1997
|
}
|
|
395
1998
|
interface PercentageDiscount$1 {
|
|
1999
|
+
/** Percentage to discount. */
|
|
396
2000
|
percentage?: number;
|
|
397
2001
|
}
|
|
398
2002
|
interface CouponScope$1 {
|
|
2003
|
+
/** Namespace of the coupon scope. */
|
|
399
2004
|
namespace?: string;
|
|
2005
|
+
/** Group of the coupon scope. */
|
|
400
2006
|
group?: Group$1;
|
|
401
2007
|
}
|
|
402
2008
|
interface Group$1 {
|
|
2009
|
+
/** Name of the group. */
|
|
403
2010
|
name?: string;
|
|
2011
|
+
/** Entity ID of the group. */
|
|
404
2012
|
entityId?: string | null;
|
|
405
2013
|
}
|
|
406
2014
|
interface LoyaltyPoints$1 {
|
|
@@ -566,108 +2174,98 @@ declare enum WebhookIdentityType$3 {
|
|
|
566
2174
|
WIX_USER = "WIX_USER",
|
|
567
2175
|
APP = "APP"
|
|
568
2176
|
}
|
|
2177
|
+
interface ReferredFriendSignupEventNonNullableFields {
|
|
2178
|
+
referredFriendId: string;
|
|
2179
|
+
}
|
|
2180
|
+
interface V1SuccessfulReferralEventNonNullableFields {
|
|
2181
|
+
referredFriendId: string;
|
|
2182
|
+
referringCustomerId: string;
|
|
2183
|
+
}
|
|
2184
|
+
interface V1TriggerNonNullableFields {
|
|
2185
|
+
appId: string;
|
|
2186
|
+
activityType: string;
|
|
2187
|
+
}
|
|
2188
|
+
interface V1ActionEventNonNullableFields {
|
|
2189
|
+
referredFriendId: string;
|
|
2190
|
+
referringCustomerId: string;
|
|
2191
|
+
trigger?: V1TriggerNonNullableFields;
|
|
2192
|
+
}
|
|
2193
|
+
interface RewardEventNonNullableFields {
|
|
2194
|
+
rewardedReferringCustomerId: string;
|
|
2195
|
+
rewardedReferredFriendId: string;
|
|
2196
|
+
referralRewardId: string;
|
|
2197
|
+
rewardType: Reward$1;
|
|
2198
|
+
}
|
|
2199
|
+
interface ReferralEventNonNullableFields {
|
|
2200
|
+
referredFriendSignupEvent?: ReferredFriendSignupEventNonNullableFields;
|
|
2201
|
+
successfulReferralEvent?: V1SuccessfulReferralEventNonNullableFields;
|
|
2202
|
+
actionEvent?: V1ActionEventNonNullableFields;
|
|
2203
|
+
rewardEvent?: RewardEventNonNullableFields;
|
|
2204
|
+
}
|
|
569
2205
|
interface GetReferralEventResponseNonNullableFields {
|
|
570
|
-
referralEvent?:
|
|
571
|
-
referredFriendSignupEvent?: {
|
|
572
|
-
referredFriendId: string;
|
|
573
|
-
};
|
|
574
|
-
successfulReferralEvent?: {
|
|
575
|
-
referredFriendId: string;
|
|
576
|
-
referringCustomerId: string;
|
|
577
|
-
};
|
|
578
|
-
actionEvent?: {
|
|
579
|
-
referredFriendId: string;
|
|
580
|
-
referringCustomerId: string;
|
|
581
|
-
trigger?: {
|
|
582
|
-
appId: string;
|
|
583
|
-
activityType: string;
|
|
584
|
-
};
|
|
585
|
-
};
|
|
586
|
-
rewardEvent?: {
|
|
587
|
-
rewardedReferringCustomerId: string;
|
|
588
|
-
rewardedReferredFriendId: string;
|
|
589
|
-
referralRewardId: string;
|
|
590
|
-
rewardType: Reward$1;
|
|
591
|
-
};
|
|
592
|
-
};
|
|
2206
|
+
referralEvent?: ReferralEventNonNullableFields;
|
|
593
2207
|
}
|
|
594
2208
|
interface QueryReferralEventResponseNonNullableFields {
|
|
595
|
-
referralEvents:
|
|
596
|
-
referredFriendSignupEvent?: {
|
|
597
|
-
referredFriendId: string;
|
|
598
|
-
};
|
|
599
|
-
successfulReferralEvent?: {
|
|
600
|
-
referredFriendId: string;
|
|
601
|
-
referringCustomerId: string;
|
|
602
|
-
};
|
|
603
|
-
actionEvent?: {
|
|
604
|
-
referredFriendId: string;
|
|
605
|
-
referringCustomerId: string;
|
|
606
|
-
trigger?: {
|
|
607
|
-
appId: string;
|
|
608
|
-
activityType: string;
|
|
609
|
-
};
|
|
610
|
-
};
|
|
611
|
-
rewardEvent?: {
|
|
612
|
-
rewardedReferringCustomerId: string;
|
|
613
|
-
rewardedReferredFriendId: string;
|
|
614
|
-
referralRewardId: string;
|
|
615
|
-
rewardType: Reward$1;
|
|
616
|
-
};
|
|
617
|
-
}[];
|
|
2209
|
+
referralEvents: ReferralEventNonNullableFields[];
|
|
618
2210
|
}
|
|
619
2211
|
interface GetReferralStatisticsResponseNonNullableFields {
|
|
620
2212
|
totalSignUpsCompleted: number;
|
|
621
2213
|
totalActionsCompleted: number;
|
|
622
2214
|
totalAmountGenerated: string;
|
|
623
2215
|
}
|
|
2216
|
+
interface ReferringCustomerTotalNonNullableFields {
|
|
2217
|
+
referringCustomerId: string;
|
|
2218
|
+
contactId: string;
|
|
2219
|
+
totalSuccessfulReferrals: number;
|
|
2220
|
+
totalAmountGenerated: string;
|
|
2221
|
+
totalFriendsWithActions: number;
|
|
2222
|
+
}
|
|
624
2223
|
interface QueryReferringCustomerTotalsResponseNonNullableFields {
|
|
625
|
-
referringCustomerTotals:
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
2224
|
+
referringCustomerTotals: ReferringCustomerTotalNonNullableFields[];
|
|
2225
|
+
}
|
|
2226
|
+
interface FixedAmountDiscountNonNullableFields$1 {
|
|
2227
|
+
amount: number;
|
|
2228
|
+
}
|
|
2229
|
+
interface PercentageDiscountNonNullableFields$1 {
|
|
2230
|
+
percentage: number;
|
|
2231
|
+
}
|
|
2232
|
+
interface GroupNonNullableFields$1 {
|
|
2233
|
+
name: string;
|
|
2234
|
+
}
|
|
2235
|
+
interface CouponScopeNonNullableFields$1 {
|
|
2236
|
+
namespace: string;
|
|
2237
|
+
group?: GroupNonNullableFields$1;
|
|
2238
|
+
}
|
|
2239
|
+
interface CouponNonNullableFields$1 {
|
|
2240
|
+
fixedAmountOptions?: FixedAmountDiscountNonNullableFields$1;
|
|
2241
|
+
percentageOptions?: PercentageDiscountNonNullableFields$1;
|
|
2242
|
+
minimumSubtotal: number;
|
|
2243
|
+
scope?: CouponScopeNonNullableFields$1;
|
|
2244
|
+
name: string;
|
|
2245
|
+
discountType: DiscountType$1;
|
|
2246
|
+
}
|
|
2247
|
+
interface V1CouponNonNullableFields$1 {
|
|
2248
|
+
_id: string;
|
|
2249
|
+
code: string;
|
|
2250
|
+
status: Status$2;
|
|
2251
|
+
couponSpecification?: CouponNonNullableFields$1;
|
|
2252
|
+
}
|
|
2253
|
+
interface LoyaltyPointsNonNullableFields {
|
|
2254
|
+
transactionId: string;
|
|
2255
|
+
amount: number;
|
|
2256
|
+
}
|
|
2257
|
+
interface ReferredFriendActionNonNullableFields {
|
|
2258
|
+
coupon?: V1CouponNonNullableFields$1;
|
|
2259
|
+
loyaltyPoints?: LoyaltyPointsNonNullableFields;
|
|
2260
|
+
referredFriendId: string;
|
|
2261
|
+
contactId: string;
|
|
2262
|
+
trigger?: V1TriggerNonNullableFields;
|
|
2263
|
+
rewardType: Reward$1;
|
|
2264
|
+
totalActions: number;
|
|
2265
|
+
totalAmountSpent: string;
|
|
632
2266
|
}
|
|
633
2267
|
interface QueryReferredFriendActionsResponseNonNullableFields {
|
|
634
|
-
referredFriendActions:
|
|
635
|
-
coupon?: {
|
|
636
|
-
_id: string;
|
|
637
|
-
code: string;
|
|
638
|
-
status: Status$2;
|
|
639
|
-
couponSpecification?: {
|
|
640
|
-
fixedAmountOptions?: {
|
|
641
|
-
amount: number;
|
|
642
|
-
};
|
|
643
|
-
percentageOptions?: {
|
|
644
|
-
percentage: number;
|
|
645
|
-
};
|
|
646
|
-
minimumSubtotal: number;
|
|
647
|
-
scope?: {
|
|
648
|
-
namespace: string;
|
|
649
|
-
group?: {
|
|
650
|
-
name: string;
|
|
651
|
-
};
|
|
652
|
-
};
|
|
653
|
-
name: string;
|
|
654
|
-
discountType: DiscountType$1;
|
|
655
|
-
};
|
|
656
|
-
};
|
|
657
|
-
loyaltyPoints?: {
|
|
658
|
-
transactionId: string;
|
|
659
|
-
amount: number;
|
|
660
|
-
};
|
|
661
|
-
referredFriendId: string;
|
|
662
|
-
contactId: string;
|
|
663
|
-
trigger?: {
|
|
664
|
-
appId: string;
|
|
665
|
-
activityType: string;
|
|
666
|
-
};
|
|
667
|
-
rewardType: Reward$1;
|
|
668
|
-
totalActions: number;
|
|
669
|
-
totalAmountSpent: string;
|
|
670
|
-
}[];
|
|
2268
|
+
referredFriendActions: ReferredFriendActionNonNullableFields[];
|
|
671
2269
|
}
|
|
672
2270
|
interface BaseEventMetadata$2 {
|
|
673
2271
|
/** App instance ID. */
|
|
@@ -804,76 +2402,16 @@ interface QueryReferredFriendActionsOptions {
|
|
|
804
2402
|
contactIds?: string[];
|
|
805
2403
|
}
|
|
806
2404
|
|
|
807
|
-
|
|
808
|
-
request<TResponse, TData = any>(req: RequestOptionsFactory$3<TResponse, TData>): Promise<HttpResponse$3<TResponse>>;
|
|
809
|
-
fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
|
|
810
|
-
}
|
|
811
|
-
type RequestOptionsFactory$3<TResponse = any, TData = any> = (context: any) => RequestOptions$3<TResponse, TData>;
|
|
812
|
-
type HttpResponse$3<T = any> = {
|
|
813
|
-
data: T;
|
|
814
|
-
status: number;
|
|
815
|
-
statusText: string;
|
|
816
|
-
headers: any;
|
|
817
|
-
request?: any;
|
|
818
|
-
};
|
|
819
|
-
type RequestOptions$3<_TResponse = any, Data = any> = {
|
|
820
|
-
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
821
|
-
url: string;
|
|
822
|
-
data?: Data;
|
|
823
|
-
params?: URLSearchParams;
|
|
824
|
-
} & APIMetadata$3;
|
|
825
|
-
type APIMetadata$3 = {
|
|
826
|
-
methodFqn?: string;
|
|
827
|
-
entityFqdn?: string;
|
|
828
|
-
packageName?: string;
|
|
829
|
-
};
|
|
830
|
-
type EventDefinition$2<Payload = unknown, Type extends string = string> = {
|
|
831
|
-
__type: 'event-definition';
|
|
832
|
-
type: Type;
|
|
833
|
-
isDomainEvent?: boolean;
|
|
834
|
-
transformations?: (envelope: unknown) => Payload;
|
|
835
|
-
__payload: Payload;
|
|
836
|
-
};
|
|
837
|
-
declare function EventDefinition$2<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$2<Payload, Type>;
|
|
2405
|
+
declare function createRESTModule$3<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
838
2406
|
|
|
839
|
-
declare
|
|
840
|
-
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
841
|
-
interface SymbolConstructor {
|
|
842
|
-
readonly observable: symbol;
|
|
843
|
-
}
|
|
844
|
-
}
|
|
2407
|
+
declare function createEventModule$2<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
845
2408
|
|
|
846
|
-
declare const
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
declare
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
} | undefined;
|
|
853
|
-
successfulReferralEvent?: {
|
|
854
|
-
referredFriendId: string;
|
|
855
|
-
referringCustomerId: string;
|
|
856
|
-
} | undefined;
|
|
857
|
-
actionEvent?: {
|
|
858
|
-
referredFriendId: string;
|
|
859
|
-
referringCustomerId: string;
|
|
860
|
-
trigger?: {
|
|
861
|
-
appId: string;
|
|
862
|
-
activityType: string;
|
|
863
|
-
} | undefined;
|
|
864
|
-
} | undefined;
|
|
865
|
-
rewardEvent?: {
|
|
866
|
-
rewardedReferringCustomerId: string;
|
|
867
|
-
rewardedReferredFriendId: string;
|
|
868
|
-
referralRewardId: string;
|
|
869
|
-
rewardType: Reward$1;
|
|
870
|
-
} | undefined;
|
|
871
|
-
}>;
|
|
872
|
-
declare function queryReferralEvent(httpClient: HttpClient$3): () => ReferralEventsQueryBuilder;
|
|
873
|
-
declare function getReferralStatistics(httpClient: HttpClient$3): () => Promise<GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields>;
|
|
874
|
-
declare function queryReferringCustomerTotals(httpClient: HttpClient$3): (options?: QueryReferringCustomerTotalsOptions) => Promise<QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields>;
|
|
875
|
-
declare function queryReferredFriendActions(httpClient: HttpClient$3): (options?: QueryReferredFriendActionsOptions) => Promise<QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields>;
|
|
876
|
-
declare const onReferralEventCreated: EventDefinition$2<ReferralEventCreatedEnvelope, "wix.loyalty.referral.v1.referral_event_created">;
|
|
2409
|
+
declare const getReferralEvent: ReturnType<typeof createRESTModule$3<typeof publicGetReferralEvent>>;
|
|
2410
|
+
declare const queryReferralEvent: ReturnType<typeof createRESTModule$3<typeof publicQueryReferralEvent>>;
|
|
2411
|
+
declare const getReferralStatistics: ReturnType<typeof createRESTModule$3<typeof publicGetReferralStatistics>>;
|
|
2412
|
+
declare const queryReferringCustomerTotals: ReturnType<typeof createRESTModule$3<typeof publicQueryReferringCustomerTotals>>;
|
|
2413
|
+
declare const queryReferredFriendActions: ReturnType<typeof createRESTModule$3<typeof publicQueryReferredFriendActions>>;
|
|
2414
|
+
declare const onReferralEventCreated: ReturnType<typeof createEventModule$2<typeof publicOnReferralEventCreated>>;
|
|
877
2415
|
|
|
878
2416
|
type index_d$3_CreateReferralEventRequest = CreateReferralEventRequest;
|
|
879
2417
|
type index_d$3_CreateReferralEventResponse = CreateReferralEventResponse;
|
|
@@ -897,6 +2435,7 @@ type index_d$3_QueryReferringCustomerTotalsResponseNonNullableFields = QueryRefe
|
|
|
897
2435
|
type index_d$3_ReferralEvent = ReferralEvent;
|
|
898
2436
|
type index_d$3_ReferralEventCreatedEnvelope = ReferralEventCreatedEnvelope;
|
|
899
2437
|
type index_d$3_ReferralEventEventTypeOneOf = ReferralEventEventTypeOneOf;
|
|
2438
|
+
type index_d$3_ReferralEventNonNullableFields = ReferralEventNonNullableFields;
|
|
900
2439
|
type index_d$3_ReferralEventsQueryBuilder = ReferralEventsQueryBuilder;
|
|
901
2440
|
type index_d$3_ReferralEventsQueryResult = ReferralEventsQueryResult;
|
|
902
2441
|
type index_d$3_ReferredFriendAction = ReferredFriendAction;
|
|
@@ -917,7 +2456,7 @@ declare const index_d$3_queryReferralEvent: typeof queryReferralEvent;
|
|
|
917
2456
|
declare const index_d$3_queryReferredFriendActions: typeof queryReferredFriendActions;
|
|
918
2457
|
declare const index_d$3_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
|
|
919
2458
|
declare namespace index_d$3 {
|
|
920
|
-
export { type ActionEvent$3 as ActionEvent, type BaseEventMetadata$2 as BaseEventMetadata, type Coupon$1 as Coupon, type CouponDiscountTypeOptionsOneOf$1 as CouponDiscountTypeOptionsOneOf, type CouponScope$1 as CouponScope, type CouponScopeOrMinSubtotalOneOf$1 as CouponScopeOrMinSubtotalOneOf, type index_d$3_CreateReferralEventRequest as CreateReferralEventRequest, type index_d$3_CreateReferralEventResponse as CreateReferralEventResponse, type CursorPaging$3 as CursorPaging, type CursorPagingMetadata$3 as CursorPagingMetadata, type CursorQuery$3 as CursorQuery, type CursorQueryPagingMethodOneOf$3 as CursorQueryPagingMethodOneOf, type Cursors$3 as Cursors, DiscountType$1 as DiscountType, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type Empty$2 as Empty, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type FixedAmountDiscount$1 as FixedAmountDiscount, type index_d$3_GetReferralEventRequest as GetReferralEventRequest, type index_d$3_GetReferralEventResponse as GetReferralEventResponse, type index_d$3_GetReferralEventResponseNonNullableFields as GetReferralEventResponseNonNullableFields, type index_d$3_GetReferralStatisticsRequest as GetReferralStatisticsRequest, type index_d$3_GetReferralStatisticsResponse as GetReferralStatisticsResponse, type index_d$3_GetReferralStatisticsResponseNonNullableFields as GetReferralStatisticsResponseNonNullableFields, type Group$1 as Group, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type LoyaltyPoints$1 as LoyaltyPoints, type MessageEnvelope$3 as MessageEnvelope, type PercentageDiscount$1 as PercentageDiscount, type index_d$3_QueryReferralEventRequest as QueryReferralEventRequest, type index_d$3_QueryReferralEventResponse as QueryReferralEventResponse, type index_d$3_QueryReferralEventResponseNonNullableFields as QueryReferralEventResponseNonNullableFields, type index_d$3_QueryReferredFriendActionsOptions as QueryReferredFriendActionsOptions, type index_d$3_QueryReferredFriendActionsRequest as QueryReferredFriendActionsRequest, type index_d$3_QueryReferredFriendActionsResponse as QueryReferredFriendActionsResponse, type index_d$3_QueryReferredFriendActionsResponseNonNullableFields as QueryReferredFriendActionsResponseNonNullableFields, type index_d$3_QueryReferringCustomerTotalsOptions as QueryReferringCustomerTotalsOptions, type index_d$3_QueryReferringCustomerTotalsRequest as QueryReferringCustomerTotalsRequest, type index_d$3_QueryReferringCustomerTotalsResponse as QueryReferringCustomerTotalsResponse, type index_d$3_QueryReferringCustomerTotalsResponseNonNullableFields as QueryReferringCustomerTotalsResponseNonNullableFields, type index_d$3_ReferralEvent as ReferralEvent, type index_d$3_ReferralEventCreatedEnvelope as ReferralEventCreatedEnvelope, type index_d$3_ReferralEventEventTypeOneOf as ReferralEventEventTypeOneOf, type index_d$3_ReferralEventsQueryBuilder as ReferralEventsQueryBuilder, type index_d$3_ReferralEventsQueryResult as ReferralEventsQueryResult, type index_d$3_ReferredFriendAction as ReferredFriendAction, type index_d$3_ReferredFriendActionEvent as ReferredFriendActionEvent, type index_d$3_ReferredFriendActionRewardTypeOptionsOneOf as ReferredFriendActionRewardTypeOptionsOneOf, type ReferredFriendDetails$2 as ReferredFriendDetails, type index_d$3_ReferredFriendSignupEvent as ReferredFriendSignupEvent, type index_d$3_ReferringCustomerTotal as ReferringCustomerTotal, Reward$1 as Reward, type index_d$3_RewardEvent as RewardEvent, type index_d$3_RewardEventReceiverOneOf as RewardEventReceiverOneOf, SortOrder$3 as SortOrder, type Sorting$3 as Sorting, Status$2 as Status, type SuccessfulReferralEvent$2 as SuccessfulReferralEvent, type index_d$3_Trigger as Trigger, type UndeleteInfo$3 as UndeleteInfo, type index_d$3_V1ActionEvent as V1ActionEvent, type V1Coupon$1 as V1Coupon, type index_d$3_V1SuccessfulReferralEvent as V1SuccessfulReferralEvent, type index_d$3_V1Trigger as V1Trigger, WebhookIdentityType$3 as WebhookIdentityType,
|
|
2459
|
+
export { type ActionEvent$3 as ActionEvent, type BaseEventMetadata$2 as BaseEventMetadata, type Coupon$1 as Coupon, type CouponDiscountTypeOptionsOneOf$1 as CouponDiscountTypeOptionsOneOf, type CouponScope$1 as CouponScope, type CouponScopeOrMinSubtotalOneOf$1 as CouponScopeOrMinSubtotalOneOf, type index_d$3_CreateReferralEventRequest as CreateReferralEventRequest, type index_d$3_CreateReferralEventResponse as CreateReferralEventResponse, type CursorPaging$3 as CursorPaging, type CursorPagingMetadata$3 as CursorPagingMetadata, type CursorQuery$3 as CursorQuery, type CursorQueryPagingMethodOneOf$3 as CursorQueryPagingMethodOneOf, type Cursors$3 as Cursors, DiscountType$1 as DiscountType, type DomainEvent$3 as DomainEvent, type DomainEventBodyOneOf$3 as DomainEventBodyOneOf, type Empty$2 as Empty, type EntityCreatedEvent$3 as EntityCreatedEvent, type EntityDeletedEvent$3 as EntityDeletedEvent, type EntityUpdatedEvent$3 as EntityUpdatedEvent, type EventMetadata$2 as EventMetadata, type FixedAmountDiscount$1 as FixedAmountDiscount, type index_d$3_GetReferralEventRequest as GetReferralEventRequest, type index_d$3_GetReferralEventResponse as GetReferralEventResponse, type index_d$3_GetReferralEventResponseNonNullableFields as GetReferralEventResponseNonNullableFields, type index_d$3_GetReferralStatisticsRequest as GetReferralStatisticsRequest, type index_d$3_GetReferralStatisticsResponse as GetReferralStatisticsResponse, type index_d$3_GetReferralStatisticsResponseNonNullableFields as GetReferralStatisticsResponseNonNullableFields, type Group$1 as Group, type IdentificationData$3 as IdentificationData, type IdentificationDataIdOneOf$3 as IdentificationDataIdOneOf, type LoyaltyPoints$1 as LoyaltyPoints, type MessageEnvelope$3 as MessageEnvelope, type PercentageDiscount$1 as PercentageDiscount, type index_d$3_QueryReferralEventRequest as QueryReferralEventRequest, type index_d$3_QueryReferralEventResponse as QueryReferralEventResponse, type index_d$3_QueryReferralEventResponseNonNullableFields as QueryReferralEventResponseNonNullableFields, type index_d$3_QueryReferredFriendActionsOptions as QueryReferredFriendActionsOptions, type index_d$3_QueryReferredFriendActionsRequest as QueryReferredFriendActionsRequest, type index_d$3_QueryReferredFriendActionsResponse as QueryReferredFriendActionsResponse, type index_d$3_QueryReferredFriendActionsResponseNonNullableFields as QueryReferredFriendActionsResponseNonNullableFields, type index_d$3_QueryReferringCustomerTotalsOptions as QueryReferringCustomerTotalsOptions, type index_d$3_QueryReferringCustomerTotalsRequest as QueryReferringCustomerTotalsRequest, type index_d$3_QueryReferringCustomerTotalsResponse as QueryReferringCustomerTotalsResponse, type index_d$3_QueryReferringCustomerTotalsResponseNonNullableFields as QueryReferringCustomerTotalsResponseNonNullableFields, type index_d$3_ReferralEvent as ReferralEvent, type index_d$3_ReferralEventCreatedEnvelope as ReferralEventCreatedEnvelope, type index_d$3_ReferralEventEventTypeOneOf as ReferralEventEventTypeOneOf, type index_d$3_ReferralEventNonNullableFields as ReferralEventNonNullableFields, type index_d$3_ReferralEventsQueryBuilder as ReferralEventsQueryBuilder, type index_d$3_ReferralEventsQueryResult as ReferralEventsQueryResult, type index_d$3_ReferredFriendAction as ReferredFriendAction, type index_d$3_ReferredFriendActionEvent as ReferredFriendActionEvent, type index_d$3_ReferredFriendActionRewardTypeOptionsOneOf as ReferredFriendActionRewardTypeOptionsOneOf, type ReferredFriendDetails$2 as ReferredFriendDetails, type index_d$3_ReferredFriendSignupEvent as ReferredFriendSignupEvent, type index_d$3_ReferringCustomerTotal as ReferringCustomerTotal, Reward$1 as Reward, type index_d$3_RewardEvent as RewardEvent, type index_d$3_RewardEventReceiverOneOf as RewardEventReceiverOneOf, SortOrder$3 as SortOrder, type Sorting$3 as Sorting, Status$2 as Status, type SuccessfulReferralEvent$2 as SuccessfulReferralEvent, type index_d$3_Trigger as Trigger, type UndeleteInfo$3 as UndeleteInfo, type index_d$3_V1ActionEvent as V1ActionEvent, type V1Coupon$1 as V1Coupon, type index_d$3_V1SuccessfulReferralEvent as V1SuccessfulReferralEvent, type index_d$3_V1Trigger as V1Trigger, WebhookIdentityType$3 as WebhookIdentityType, index_d$3_getReferralEvent as getReferralEvent, index_d$3_getReferralStatistics as getReferralStatistics, index_d$3_onReferralEventCreated as onReferralEventCreated, index_d$3_queryReferralEvent as queryReferralEvent, index_d$3_queryReferredFriendActions as queryReferredFriendActions, index_d$3_queryReferringCustomerTotals as queryReferringCustomerTotals };
|
|
921
2460
|
}
|
|
922
2461
|
|
|
923
2462
|
/** ReferralReward is the main entity of ReferralRewards that can be used for lorem ipsum dolor */
|
|
@@ -1350,143 +2889,59 @@ declare enum WebhookIdentityType$2 {
|
|
|
1350
2889
|
WIX_USER = "WIX_USER",
|
|
1351
2890
|
APP = "APP"
|
|
1352
2891
|
}
|
|
2892
|
+
interface FixedAmountDiscountNonNullableFields {
|
|
2893
|
+
amount: number;
|
|
2894
|
+
}
|
|
2895
|
+
interface PercentageDiscountNonNullableFields {
|
|
2896
|
+
percentage: number;
|
|
2897
|
+
}
|
|
2898
|
+
interface GroupNonNullableFields {
|
|
2899
|
+
name: string;
|
|
2900
|
+
}
|
|
2901
|
+
interface CouponScopeNonNullableFields {
|
|
2902
|
+
namespace: string;
|
|
2903
|
+
group?: GroupNonNullableFields;
|
|
2904
|
+
}
|
|
2905
|
+
interface CouponNonNullableFields {
|
|
2906
|
+
fixedAmountOptions?: FixedAmountDiscountNonNullableFields;
|
|
2907
|
+
percentageOptions?: PercentageDiscountNonNullableFields;
|
|
2908
|
+
minimumSubtotal: number;
|
|
2909
|
+
scope?: CouponScopeNonNullableFields;
|
|
2910
|
+
name: string;
|
|
2911
|
+
discountType: DiscountType;
|
|
2912
|
+
}
|
|
2913
|
+
interface V1CouponNonNullableFields {
|
|
2914
|
+
_id: string;
|
|
2915
|
+
code: string;
|
|
2916
|
+
status: Status$1;
|
|
2917
|
+
couponSpecification?: CouponNonNullableFields;
|
|
2918
|
+
}
|
|
2919
|
+
interface V1LoyaltyPointsNonNullableFields {
|
|
2920
|
+
transactionId: string;
|
|
2921
|
+
amount: number;
|
|
2922
|
+
}
|
|
2923
|
+
interface ReferralRewardNonNullableFields {
|
|
2924
|
+
rewardedReferringCustomerId: string;
|
|
2925
|
+
rewardedReferredFriendId: string;
|
|
2926
|
+
coupon?: V1CouponNonNullableFields;
|
|
2927
|
+
loyaltyPoints?: V1LoyaltyPointsNonNullableFields;
|
|
2928
|
+
rewardType: RewardTypeType;
|
|
2929
|
+
}
|
|
1353
2930
|
interface GetReferralRewardResponseNonNullableFields {
|
|
1354
|
-
referralReward?:
|
|
1355
|
-
rewardedReferringCustomerId: string;
|
|
1356
|
-
rewardedReferredFriendId: string;
|
|
1357
|
-
coupon?: {
|
|
1358
|
-
_id: string;
|
|
1359
|
-
code: string;
|
|
1360
|
-
status: Status$1;
|
|
1361
|
-
couponSpecification?: {
|
|
1362
|
-
fixedAmountOptions?: {
|
|
1363
|
-
amount: number;
|
|
1364
|
-
};
|
|
1365
|
-
percentageOptions?: {
|
|
1366
|
-
percentage: number;
|
|
1367
|
-
};
|
|
1368
|
-
minimumSubtotal: number;
|
|
1369
|
-
scope?: {
|
|
1370
|
-
namespace: string;
|
|
1371
|
-
group?: {
|
|
1372
|
-
name: string;
|
|
1373
|
-
};
|
|
1374
|
-
};
|
|
1375
|
-
name: string;
|
|
1376
|
-
discountType: DiscountType;
|
|
1377
|
-
};
|
|
1378
|
-
};
|
|
1379
|
-
loyaltyPoints?: {
|
|
1380
|
-
transactionId: string;
|
|
1381
|
-
amount: number;
|
|
1382
|
-
};
|
|
1383
|
-
rewardType: RewardTypeType;
|
|
1384
|
-
};
|
|
2931
|
+
referralReward?: ReferralRewardNonNullableFields;
|
|
1385
2932
|
}
|
|
1386
2933
|
interface QueryReferralRewardsResponseNonNullableFields {
|
|
1387
|
-
referralRewards:
|
|
1388
|
-
rewardedReferringCustomerId: string;
|
|
1389
|
-
rewardedReferredFriendId: string;
|
|
1390
|
-
coupon?: {
|
|
1391
|
-
_id: string;
|
|
1392
|
-
code: string;
|
|
1393
|
-
status: Status$1;
|
|
1394
|
-
couponSpecification?: {
|
|
1395
|
-
fixedAmountOptions?: {
|
|
1396
|
-
amount: number;
|
|
1397
|
-
};
|
|
1398
|
-
percentageOptions?: {
|
|
1399
|
-
percentage: number;
|
|
1400
|
-
};
|
|
1401
|
-
minimumSubtotal: number;
|
|
1402
|
-
scope?: {
|
|
1403
|
-
namespace: string;
|
|
1404
|
-
group?: {
|
|
1405
|
-
name: string;
|
|
1406
|
-
};
|
|
1407
|
-
};
|
|
1408
|
-
name: string;
|
|
1409
|
-
discountType: DiscountType;
|
|
1410
|
-
};
|
|
1411
|
-
};
|
|
1412
|
-
loyaltyPoints?: {
|
|
1413
|
-
transactionId: string;
|
|
1414
|
-
amount: number;
|
|
1415
|
-
};
|
|
1416
|
-
rewardType: RewardTypeType;
|
|
1417
|
-
}[];
|
|
2934
|
+
referralRewards: ReferralRewardNonNullableFields[];
|
|
1418
2935
|
}
|
|
1419
2936
|
interface QueryReferralRewardsOptions {
|
|
1420
2937
|
/** Filter by contact id or set to "me" for current identity's rewards. */
|
|
1421
2938
|
contactId?: string | null;
|
|
1422
2939
|
}
|
|
1423
2940
|
|
|
1424
|
-
|
|
1425
|
-
request<TResponse, TData = any>(req: RequestOptionsFactory$2<TResponse, TData>): Promise<HttpResponse$2<TResponse>>;
|
|
1426
|
-
fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
|
|
1427
|
-
}
|
|
1428
|
-
type RequestOptionsFactory$2<TResponse = any, TData = any> = (context: any) => RequestOptions$2<TResponse, TData>;
|
|
1429
|
-
type HttpResponse$2<T = any> = {
|
|
1430
|
-
data: T;
|
|
1431
|
-
status: number;
|
|
1432
|
-
statusText: string;
|
|
1433
|
-
headers: any;
|
|
1434
|
-
request?: any;
|
|
1435
|
-
};
|
|
1436
|
-
type RequestOptions$2<_TResponse = any, Data = any> = {
|
|
1437
|
-
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
1438
|
-
url: string;
|
|
1439
|
-
data?: Data;
|
|
1440
|
-
params?: URLSearchParams;
|
|
1441
|
-
} & APIMetadata$2;
|
|
1442
|
-
type APIMetadata$2 = {
|
|
1443
|
-
methodFqn?: string;
|
|
1444
|
-
entityFqdn?: string;
|
|
1445
|
-
packageName?: string;
|
|
1446
|
-
};
|
|
1447
|
-
|
|
1448
|
-
declare global {
|
|
1449
|
-
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
1450
|
-
interface SymbolConstructor {
|
|
1451
|
-
readonly observable: symbol;
|
|
1452
|
-
}
|
|
1453
|
-
}
|
|
2941
|
+
declare function createRESTModule$2<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
1454
2942
|
|
|
1455
|
-
declare const
|
|
1456
|
-
|
|
1457
|
-
};
|
|
1458
|
-
declare function getReferralReward(httpClient: HttpClient$2): (_id: string) => Promise<ReferralReward & {
|
|
1459
|
-
rewardedReferringCustomerId: string;
|
|
1460
|
-
rewardedReferredFriendId: string;
|
|
1461
|
-
coupon?: {
|
|
1462
|
-
_id: string;
|
|
1463
|
-
code: string;
|
|
1464
|
-
status: Status$1;
|
|
1465
|
-
couponSpecification?: {
|
|
1466
|
-
fixedAmountOptions?: {
|
|
1467
|
-
amount: number;
|
|
1468
|
-
} | undefined;
|
|
1469
|
-
percentageOptions?: {
|
|
1470
|
-
percentage: number;
|
|
1471
|
-
} | undefined;
|
|
1472
|
-
minimumSubtotal: number;
|
|
1473
|
-
scope?: {
|
|
1474
|
-
namespace: string;
|
|
1475
|
-
group?: {
|
|
1476
|
-
name: string;
|
|
1477
|
-
} | undefined;
|
|
1478
|
-
} | undefined;
|
|
1479
|
-
name: string;
|
|
1480
|
-
discountType: DiscountType;
|
|
1481
|
-
} | undefined;
|
|
1482
|
-
} | undefined;
|
|
1483
|
-
loyaltyPoints?: {
|
|
1484
|
-
transactionId: string;
|
|
1485
|
-
amount: number;
|
|
1486
|
-
} | undefined;
|
|
1487
|
-
rewardType: RewardTypeType;
|
|
1488
|
-
}>;
|
|
1489
|
-
declare function queryReferralRewards(httpClient: HttpClient$2): (query: CursorQuery$2, options?: QueryReferralRewardsOptions) => Promise<QueryReferralRewardsResponse & QueryReferralRewardsResponseNonNullableFields>;
|
|
2943
|
+
declare const getReferralReward: ReturnType<typeof createRESTModule$2<typeof publicGetReferralReward>>;
|
|
2944
|
+
declare const queryReferralRewards: ReturnType<typeof createRESTModule$2<typeof publicQueryReferralRewards>>;
|
|
1490
2945
|
|
|
1491
2946
|
type index_d$2_BulkGetReferralRewardsRequest = BulkGetReferralRewardsRequest;
|
|
1492
2947
|
type index_d$2_BulkGetReferralRewardsResponse = BulkGetReferralRewardsResponse;
|
|
@@ -1508,6 +2963,7 @@ type index_d$2_QueryReferralRewardsRequest = QueryReferralRewardsRequest;
|
|
|
1508
2963
|
type index_d$2_QueryReferralRewardsResponse = QueryReferralRewardsResponse;
|
|
1509
2964
|
type index_d$2_QueryReferralRewardsResponseNonNullableFields = QueryReferralRewardsResponseNonNullableFields;
|
|
1510
2965
|
type index_d$2_ReferralReward = ReferralReward;
|
|
2966
|
+
type index_d$2_ReferralRewardNonNullableFields = ReferralRewardNonNullableFields;
|
|
1511
2967
|
type index_d$2_ReferralRewardReceiverOneOf = ReferralRewardReceiverOneOf;
|
|
1512
2968
|
type index_d$2_ReferralRewardRewardTypeOptionsOneOf = ReferralRewardRewardTypeOptionsOneOf;
|
|
1513
2969
|
type index_d$2_Reward = Reward;
|
|
@@ -1524,7 +2980,7 @@ type index_d$2_ValidateReferralRewardResponse = ValidateReferralRewardResponse;
|
|
|
1524
2980
|
declare const index_d$2_getReferralReward: typeof getReferralReward;
|
|
1525
2981
|
declare const index_d$2_queryReferralRewards: typeof queryReferralRewards;
|
|
1526
2982
|
declare namespace index_d$2 {
|
|
1527
|
-
export { type ActionEvent$2 as ActionEvent, type index_d$2_BulkGetReferralRewardsRequest as BulkGetReferralRewardsRequest, type index_d$2_BulkGetReferralRewardsResponse as BulkGetReferralRewardsResponse, type index_d$2_Coupon as Coupon, type index_d$2_CouponDiscountTypeOptionsOneOf as CouponDiscountTypeOptionsOneOf, type index_d$2_CouponScope as CouponScope, type index_d$2_CouponScopeOrMinSubtotalOneOf as CouponScopeOrMinSubtotalOneOf, type CursorPaging$2 as CursorPaging, type CursorPagingMetadata$2 as CursorPagingMetadata, type CursorQuery$2 as CursorQuery, type CursorQueryPagingMethodOneOf$2 as CursorQueryPagingMethodOneOf, type Cursors$2 as Cursors, index_d$2_DiscountType as DiscountType, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type Empty$1 as Empty, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type index_d$2_FixedAmountDiscount as FixedAmountDiscount, type index_d$2_GetReferralRewardRequest as GetReferralRewardRequest, type index_d$2_GetReferralRewardResponse as GetReferralRewardResponse, type index_d$2_GetReferralRewardResponseNonNullableFields as GetReferralRewardResponseNonNullableFields, type index_d$2_Group as Group, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type index_d$2_LoyaltyPoints as LoyaltyPoints, type MessageEnvelope$2 as MessageEnvelope, type index_d$2_PercentageDiscount as PercentageDiscount, type index_d$2_QueryReferralRewardsOptions as QueryReferralRewardsOptions, type index_d$2_QueryReferralRewardsRequest as QueryReferralRewardsRequest, type index_d$2_QueryReferralRewardsResponse as QueryReferralRewardsResponse, type index_d$2_QueryReferralRewardsResponseNonNullableFields as QueryReferralRewardsResponseNonNullableFields, type index_d$2_ReferralReward as ReferralReward, type index_d$2_ReferralRewardReceiverOneOf as ReferralRewardReceiverOneOf, type index_d$2_ReferralRewardRewardTypeOptionsOneOf as ReferralRewardRewardTypeOptionsOneOf, type ReferredFriendDetails$1 as ReferredFriendDetails, type index_d$2_Reward as Reward, type index_d$2_RewardOptionsOneOf as RewardOptionsOneOf, index_d$2_RewardTypeType as RewardTypeType, type index_d$2_RewardsInSite as RewardsInSite, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, Status$1 as Status, type SuccessfulReferralEvent$1 as SuccessfulReferralEvent, index_d$2_Type as Type, type UndeleteInfo$2 as UndeleteInfo, type index_d$2_V1Coupon as V1Coupon, type index_d$2_V1LoyaltyPoints as V1LoyaltyPoints, type index_d$2_ValidateReferralRewardRequest as ValidateReferralRewardRequest, type index_d$2_ValidateReferralRewardResponse as ValidateReferralRewardResponse, WebhookIdentityType$2 as WebhookIdentityType,
|
|
2983
|
+
export { type ActionEvent$2 as ActionEvent, type index_d$2_BulkGetReferralRewardsRequest as BulkGetReferralRewardsRequest, type index_d$2_BulkGetReferralRewardsResponse as BulkGetReferralRewardsResponse, type index_d$2_Coupon as Coupon, type index_d$2_CouponDiscountTypeOptionsOneOf as CouponDiscountTypeOptionsOneOf, type index_d$2_CouponScope as CouponScope, type index_d$2_CouponScopeOrMinSubtotalOneOf as CouponScopeOrMinSubtotalOneOf, type CursorPaging$2 as CursorPaging, type CursorPagingMetadata$2 as CursorPagingMetadata, type CursorQuery$2 as CursorQuery, type CursorQueryPagingMethodOneOf$2 as CursorQueryPagingMethodOneOf, type Cursors$2 as Cursors, index_d$2_DiscountType as DiscountType, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type Empty$1 as Empty, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type index_d$2_FixedAmountDiscount as FixedAmountDiscount, type index_d$2_GetReferralRewardRequest as GetReferralRewardRequest, type index_d$2_GetReferralRewardResponse as GetReferralRewardResponse, type index_d$2_GetReferralRewardResponseNonNullableFields as GetReferralRewardResponseNonNullableFields, type index_d$2_Group as Group, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type index_d$2_LoyaltyPoints as LoyaltyPoints, type MessageEnvelope$2 as MessageEnvelope, type index_d$2_PercentageDiscount as PercentageDiscount, type index_d$2_QueryReferralRewardsOptions as QueryReferralRewardsOptions, type index_d$2_QueryReferralRewardsRequest as QueryReferralRewardsRequest, type index_d$2_QueryReferralRewardsResponse as QueryReferralRewardsResponse, type index_d$2_QueryReferralRewardsResponseNonNullableFields as QueryReferralRewardsResponseNonNullableFields, type index_d$2_ReferralReward as ReferralReward, type index_d$2_ReferralRewardNonNullableFields as ReferralRewardNonNullableFields, type index_d$2_ReferralRewardReceiverOneOf as ReferralRewardReceiverOneOf, type index_d$2_ReferralRewardRewardTypeOptionsOneOf as ReferralRewardRewardTypeOptionsOneOf, type ReferredFriendDetails$1 as ReferredFriendDetails, type index_d$2_Reward as Reward, type index_d$2_RewardOptionsOneOf as RewardOptionsOneOf, index_d$2_RewardTypeType as RewardTypeType, type index_d$2_RewardsInSite as RewardsInSite, SortOrder$2 as SortOrder, type Sorting$2 as Sorting, Status$1 as Status, type SuccessfulReferralEvent$1 as SuccessfulReferralEvent, index_d$2_Type as Type, type UndeleteInfo$2 as UndeleteInfo, type index_d$2_V1Coupon as V1Coupon, type index_d$2_V1LoyaltyPoints as V1LoyaltyPoints, type index_d$2_ValidateReferralRewardRequest as ValidateReferralRewardRequest, type index_d$2_ValidateReferralRewardResponse as ValidateReferralRewardResponse, WebhookIdentityType$2 as WebhookIdentityType, index_d$2_getReferralReward as getReferralReward, index_d$2_queryReferralRewards as queryReferralRewards };
|
|
1528
2984
|
}
|
|
1529
2985
|
|
|
1530
2986
|
/** ReferredFriend is the main entity of ReferredFriends that can be used for lorem ipsum dolor */
|
|
@@ -1814,45 +3270,26 @@ declare enum WebhookIdentityType$1 {
|
|
|
1814
3270
|
WIX_USER = "WIX_USER",
|
|
1815
3271
|
APP = "APP"
|
|
1816
3272
|
}
|
|
3273
|
+
interface ReferredFriendNonNullableFields {
|
|
3274
|
+
_id: string;
|
|
3275
|
+
contactId: string;
|
|
3276
|
+
referringCustomerId: string;
|
|
3277
|
+
status: Status;
|
|
3278
|
+
}
|
|
1817
3279
|
interface CreateReferredFriendResponseNonNullableFields {
|
|
1818
|
-
referredFriend?:
|
|
1819
|
-
_id: string;
|
|
1820
|
-
contactId: string;
|
|
1821
|
-
referringCustomerId: string;
|
|
1822
|
-
status: Status;
|
|
1823
|
-
};
|
|
3280
|
+
referredFriend?: ReferredFriendNonNullableFields;
|
|
1824
3281
|
}
|
|
1825
3282
|
interface GetReferredFriendResponseNonNullableFields {
|
|
1826
|
-
referredFriend?:
|
|
1827
|
-
_id: string;
|
|
1828
|
-
contactId: string;
|
|
1829
|
-
referringCustomerId: string;
|
|
1830
|
-
status: Status;
|
|
1831
|
-
};
|
|
3283
|
+
referredFriend?: ReferredFriendNonNullableFields;
|
|
1832
3284
|
}
|
|
1833
3285
|
interface GetReferredFriendByContactIdResponseNonNullableFields {
|
|
1834
|
-
referredFriend?:
|
|
1835
|
-
_id: string;
|
|
1836
|
-
contactId: string;
|
|
1837
|
-
referringCustomerId: string;
|
|
1838
|
-
status: Status;
|
|
1839
|
-
};
|
|
3286
|
+
referredFriend?: ReferredFriendNonNullableFields;
|
|
1840
3287
|
}
|
|
1841
3288
|
interface UpdateReferredFriendResponseNonNullableFields {
|
|
1842
|
-
referredFriend?:
|
|
1843
|
-
_id: string;
|
|
1844
|
-
contactId: string;
|
|
1845
|
-
referringCustomerId: string;
|
|
1846
|
-
status: Status;
|
|
1847
|
-
};
|
|
3289
|
+
referredFriend?: ReferredFriendNonNullableFields;
|
|
1848
3290
|
}
|
|
1849
3291
|
interface QueryReferredFriendResponseNonNullableFields {
|
|
1850
|
-
referredFriends:
|
|
1851
|
-
_id: string;
|
|
1852
|
-
contactId: string;
|
|
1853
|
-
referringCustomerId: string;
|
|
1854
|
-
status: Status;
|
|
1855
|
-
}[];
|
|
3292
|
+
referredFriends: ReferredFriendNonNullableFields[];
|
|
1856
3293
|
}
|
|
1857
3294
|
interface BaseEventMetadata$1 {
|
|
1858
3295
|
/** App instance ID. */
|
|
@@ -2027,67 +3464,19 @@ interface ReferredFriendsQueryBuilder {
|
|
|
2027
3464
|
find: () => Promise<ReferredFriendsQueryResult>;
|
|
2028
3465
|
}
|
|
2029
3466
|
|
|
2030
|
-
|
|
2031
|
-
request<TResponse, TData = any>(req: RequestOptionsFactory$1<TResponse, TData>): Promise<HttpResponse$1<TResponse>>;
|
|
2032
|
-
fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
|
|
2033
|
-
}
|
|
2034
|
-
type RequestOptionsFactory$1<TResponse = any, TData = any> = (context: any) => RequestOptions$1<TResponse, TData>;
|
|
2035
|
-
type HttpResponse$1<T = any> = {
|
|
2036
|
-
data: T;
|
|
2037
|
-
status: number;
|
|
2038
|
-
statusText: string;
|
|
2039
|
-
headers: any;
|
|
2040
|
-
request?: any;
|
|
2041
|
-
};
|
|
2042
|
-
type RequestOptions$1<_TResponse = any, Data = any> = {
|
|
2043
|
-
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
2044
|
-
url: string;
|
|
2045
|
-
data?: Data;
|
|
2046
|
-
params?: URLSearchParams;
|
|
2047
|
-
} & APIMetadata$1;
|
|
2048
|
-
type APIMetadata$1 = {
|
|
2049
|
-
methodFqn?: string;
|
|
2050
|
-
entityFqdn?: string;
|
|
2051
|
-
packageName?: string;
|
|
2052
|
-
};
|
|
2053
|
-
type EventDefinition$1<Payload = unknown, Type extends string = string> = {
|
|
2054
|
-
__type: 'event-definition';
|
|
2055
|
-
type: Type;
|
|
2056
|
-
isDomainEvent?: boolean;
|
|
2057
|
-
transformations?: (envelope: unknown) => Payload;
|
|
2058
|
-
__payload: Payload;
|
|
2059
|
-
};
|
|
2060
|
-
declare function EventDefinition$1<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition$1<Payload, Type>;
|
|
3467
|
+
declare function createRESTModule$1<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
2061
3468
|
|
|
2062
|
-
declare
|
|
2063
|
-
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
2064
|
-
interface SymbolConstructor {
|
|
2065
|
-
readonly observable: symbol;
|
|
2066
|
-
}
|
|
2067
|
-
}
|
|
3469
|
+
declare function createEventModule$1<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
2068
3470
|
|
|
2069
|
-
declare const
|
|
2070
|
-
|
|
2071
|
-
|
|
2072
|
-
declare
|
|
2073
|
-
declare
|
|
2074
|
-
declare
|
|
2075
|
-
|
|
2076
|
-
|
|
2077
|
-
|
|
2078
|
-
status: Status;
|
|
2079
|
-
}>;
|
|
2080
|
-
declare function updateReferredFriend(httpClient: HttpClient$1): (_id: string, referredFriend: UpdateReferredFriend) => Promise<ReferredFriend & {
|
|
2081
|
-
_id: string;
|
|
2082
|
-
contactId: string;
|
|
2083
|
-
referringCustomerId: string;
|
|
2084
|
-
status: Status;
|
|
2085
|
-
}>;
|
|
2086
|
-
declare function deleteReferredFriend(httpClient: HttpClient$1): (referredFriendId: string, options?: DeleteReferredFriendOptions) => Promise<void>;
|
|
2087
|
-
declare function queryReferredFriend(httpClient: HttpClient$1): () => ReferredFriendsQueryBuilder;
|
|
2088
|
-
declare const onReferredFriendCreated: EventDefinition$1<ReferredFriendCreatedEnvelope, "wix.loyalty.referral.v1.referred_friend_created">;
|
|
2089
|
-
declare const onReferredFriendUpdated: EventDefinition$1<ReferredFriendUpdatedEnvelope, "wix.loyalty.referral.v1.referred_friend_updated">;
|
|
2090
|
-
declare const onReferredFriendDeleted: EventDefinition$1<ReferredFriendDeletedEnvelope, "wix.loyalty.referral.v1.referred_friend_deleted">;
|
|
3471
|
+
declare const createReferredFriend: ReturnType<typeof createRESTModule$1<typeof publicCreateReferredFriend>>;
|
|
3472
|
+
declare const getReferredFriend: ReturnType<typeof createRESTModule$1<typeof publicGetReferredFriend>>;
|
|
3473
|
+
declare const getReferredFriendByContactId: ReturnType<typeof createRESTModule$1<typeof publicGetReferredFriendByContactId>>;
|
|
3474
|
+
declare const updateReferredFriend: ReturnType<typeof createRESTModule$1<typeof publicUpdateReferredFriend>>;
|
|
3475
|
+
declare const deleteReferredFriend: ReturnType<typeof createRESTModule$1<typeof publicDeleteReferredFriend>>;
|
|
3476
|
+
declare const queryReferredFriend: ReturnType<typeof createRESTModule$1<typeof publicQueryReferredFriend>>;
|
|
3477
|
+
declare const onReferredFriendCreated: ReturnType<typeof createEventModule$1<typeof publicOnReferredFriendCreated>>;
|
|
3478
|
+
declare const onReferredFriendUpdated: ReturnType<typeof createEventModule$1<typeof publicOnReferredFriendUpdated>>;
|
|
3479
|
+
declare const onReferredFriendDeleted: ReturnType<typeof createEventModule$1<typeof publicOnReferredFriendDeleted>>;
|
|
2091
3480
|
|
|
2092
3481
|
type index_d$1_CreateReferredFriendRequest = CreateReferredFriendRequest;
|
|
2093
3482
|
type index_d$1_CreateReferredFriendResponse = CreateReferredFriendResponse;
|
|
@@ -2109,6 +3498,7 @@ type index_d$1_ReferredFriend = ReferredFriend;
|
|
|
2109
3498
|
type index_d$1_ReferredFriendCreatedEnvelope = ReferredFriendCreatedEnvelope;
|
|
2110
3499
|
type index_d$1_ReferredFriendDeletedEnvelope = ReferredFriendDeletedEnvelope;
|
|
2111
3500
|
type index_d$1_ReferredFriendDetails = ReferredFriendDetails;
|
|
3501
|
+
type index_d$1_ReferredFriendNonNullableFields = ReferredFriendNonNullableFields;
|
|
2112
3502
|
type index_d$1_ReferredFriendUpdatedEnvelope = ReferredFriendUpdatedEnvelope;
|
|
2113
3503
|
type index_d$1_ReferredFriendsQueryBuilder = ReferredFriendsQueryBuilder;
|
|
2114
3504
|
type index_d$1_ReferredFriendsQueryResult = ReferredFriendsQueryResult;
|
|
@@ -2129,7 +3519,7 @@ declare const index_d$1_onReferredFriendUpdated: typeof onReferredFriendUpdated;
|
|
|
2129
3519
|
declare const index_d$1_queryReferredFriend: typeof queryReferredFriend;
|
|
2130
3520
|
declare const index_d$1_updateReferredFriend: typeof updateReferredFriend;
|
|
2131
3521
|
declare namespace index_d$1 {
|
|
2132
|
-
export { type ActionEvent$1 as ActionEvent, type BaseEventMetadata$1 as BaseEventMetadata, type index_d$1_CreateReferredFriendRequest as CreateReferredFriendRequest, type index_d$1_CreateReferredFriendResponse as CreateReferredFriendResponse, type index_d$1_CreateReferredFriendResponseNonNullableFields as CreateReferredFriendResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type CursorQuery$1 as CursorQuery, type CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf, type Cursors$1 as Cursors, type index_d$1_DeleteReferredFriendOptions as DeleteReferredFriendOptions, type index_d$1_DeleteReferredFriendRequest as DeleteReferredFriendRequest, type index_d$1_DeleteReferredFriendResponse as DeleteReferredFriendResponse, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type index_d$1_Empty as Empty, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type index_d$1_GetReferredFriendByContactIdRequest as GetReferredFriendByContactIdRequest, type index_d$1_GetReferredFriendByContactIdResponse as GetReferredFriendByContactIdResponse, type index_d$1_GetReferredFriendByContactIdResponseNonNullableFields as GetReferredFriendByContactIdResponseNonNullableFields, type index_d$1_GetReferredFriendRequest as GetReferredFriendRequest, type index_d$1_GetReferredFriendResponse as GetReferredFriendResponse, type index_d$1_GetReferredFriendResponseNonNullableFields as GetReferredFriendResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type index_d$1_QueryReferredFriendRequest as QueryReferredFriendRequest, type index_d$1_QueryReferredFriendResponse as QueryReferredFriendResponse, type index_d$1_QueryReferredFriendResponseNonNullableFields as QueryReferredFriendResponseNonNullableFields, type index_d$1_ReferredFriend as ReferredFriend, type index_d$1_ReferredFriendCreatedEnvelope as ReferredFriendCreatedEnvelope, type index_d$1_ReferredFriendDeletedEnvelope as ReferredFriendDeletedEnvelope, type index_d$1_ReferredFriendDetails as ReferredFriendDetails, type index_d$1_ReferredFriendUpdatedEnvelope as ReferredFriendUpdatedEnvelope, type index_d$1_ReferredFriendsQueryBuilder as ReferredFriendsQueryBuilder, type index_d$1_ReferredFriendsQueryResult as ReferredFriendsQueryResult, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, index_d$1_Status as Status, type index_d$1_SuccessfulReferralEvent as SuccessfulReferralEvent, type UndeleteInfo$1 as UndeleteInfo, type index_d$1_UpdateReferredFriend as UpdateReferredFriend, type index_d$1_UpdateReferredFriendRequest as UpdateReferredFriendRequest, type index_d$1_UpdateReferredFriendResponse as UpdateReferredFriendResponse, type index_d$1_UpdateReferredFriendResponseNonNullableFields as UpdateReferredFriendResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType,
|
|
3522
|
+
export { type ActionEvent$1 as ActionEvent, type BaseEventMetadata$1 as BaseEventMetadata, type index_d$1_CreateReferredFriendRequest as CreateReferredFriendRequest, type index_d$1_CreateReferredFriendResponse as CreateReferredFriendResponse, type index_d$1_CreateReferredFriendResponseNonNullableFields as CreateReferredFriendResponseNonNullableFields, type CursorPaging$1 as CursorPaging, type CursorPagingMetadata$1 as CursorPagingMetadata, type CursorQuery$1 as CursorQuery, type CursorQueryPagingMethodOneOf$1 as CursorQueryPagingMethodOneOf, type Cursors$1 as Cursors, type index_d$1_DeleteReferredFriendOptions as DeleteReferredFriendOptions, type index_d$1_DeleteReferredFriendRequest as DeleteReferredFriendRequest, type index_d$1_DeleteReferredFriendResponse as DeleteReferredFriendResponse, type DomainEvent$1 as DomainEvent, type DomainEventBodyOneOf$1 as DomainEventBodyOneOf, type index_d$1_Empty as Empty, type EntityCreatedEvent$1 as EntityCreatedEvent, type EntityDeletedEvent$1 as EntityDeletedEvent, type EntityUpdatedEvent$1 as EntityUpdatedEvent, type EventMetadata$1 as EventMetadata, type index_d$1_GetReferredFriendByContactIdRequest as GetReferredFriendByContactIdRequest, type index_d$1_GetReferredFriendByContactIdResponse as GetReferredFriendByContactIdResponse, type index_d$1_GetReferredFriendByContactIdResponseNonNullableFields as GetReferredFriendByContactIdResponseNonNullableFields, type index_d$1_GetReferredFriendRequest as GetReferredFriendRequest, type index_d$1_GetReferredFriendResponse as GetReferredFriendResponse, type index_d$1_GetReferredFriendResponseNonNullableFields as GetReferredFriendResponseNonNullableFields, type IdentificationData$1 as IdentificationData, type IdentificationDataIdOneOf$1 as IdentificationDataIdOneOf, type MessageEnvelope$1 as MessageEnvelope, type index_d$1_QueryReferredFriendRequest as QueryReferredFriendRequest, type index_d$1_QueryReferredFriendResponse as QueryReferredFriendResponse, type index_d$1_QueryReferredFriendResponseNonNullableFields as QueryReferredFriendResponseNonNullableFields, type index_d$1_ReferredFriend as ReferredFriend, type index_d$1_ReferredFriendCreatedEnvelope as ReferredFriendCreatedEnvelope, type index_d$1_ReferredFriendDeletedEnvelope as ReferredFriendDeletedEnvelope, type index_d$1_ReferredFriendDetails as ReferredFriendDetails, type index_d$1_ReferredFriendNonNullableFields as ReferredFriendNonNullableFields, type index_d$1_ReferredFriendUpdatedEnvelope as ReferredFriendUpdatedEnvelope, type index_d$1_ReferredFriendsQueryBuilder as ReferredFriendsQueryBuilder, type index_d$1_ReferredFriendsQueryResult as ReferredFriendsQueryResult, SortOrder$1 as SortOrder, type Sorting$1 as Sorting, index_d$1_Status as Status, type index_d$1_SuccessfulReferralEvent as SuccessfulReferralEvent, type UndeleteInfo$1 as UndeleteInfo, type index_d$1_UpdateReferredFriend as UpdateReferredFriend, type index_d$1_UpdateReferredFriendRequest as UpdateReferredFriendRequest, type index_d$1_UpdateReferredFriendResponse as UpdateReferredFriendResponse, type index_d$1_UpdateReferredFriendResponseNonNullableFields as UpdateReferredFriendResponseNonNullableFields, WebhookIdentityType$1 as WebhookIdentityType, index_d$1_createReferredFriend as createReferredFriend, index_d$1_deleteReferredFriend as deleteReferredFriend, index_d$1_getReferredFriend as getReferredFriend, index_d$1_getReferredFriendByContactId as getReferredFriendByContactId, index_d$1_onReferredFriendCreated as onReferredFriendCreated, index_d$1_onReferredFriendDeleted as onReferredFriendDeleted, index_d$1_onReferredFriendUpdated as onReferredFriendUpdated, index_d$1_queryReferredFriend as queryReferredFriend, index_d$1_updateReferredFriend as updateReferredFriend };
|
|
2133
3523
|
}
|
|
2134
3524
|
|
|
2135
3525
|
/** ReferringCustomer is the main entity of ReferringCustomers. */
|
|
@@ -2377,33 +3767,22 @@ declare enum WebhookIdentityType {
|
|
|
2377
3767
|
WIX_USER = "WIX_USER",
|
|
2378
3768
|
APP = "APP"
|
|
2379
3769
|
}
|
|
3770
|
+
interface ReferringCustomerNonNullableFields {
|
|
3771
|
+
_id: string;
|
|
3772
|
+
contactId: string;
|
|
3773
|
+
referralCode: string;
|
|
3774
|
+
}
|
|
2380
3775
|
interface GenerateReferringCustomerForContactResponseNonNullableFields {
|
|
2381
|
-
referringCustomer?:
|
|
2382
|
-
_id: string;
|
|
2383
|
-
contactId: string;
|
|
2384
|
-
referralCode: string;
|
|
2385
|
-
};
|
|
3776
|
+
referringCustomer?: ReferringCustomerNonNullableFields;
|
|
2386
3777
|
}
|
|
2387
3778
|
interface GetReferringCustomerResponseNonNullableFields {
|
|
2388
|
-
referringCustomer?:
|
|
2389
|
-
_id: string;
|
|
2390
|
-
contactId: string;
|
|
2391
|
-
referralCode: string;
|
|
2392
|
-
};
|
|
3779
|
+
referringCustomer?: ReferringCustomerNonNullableFields;
|
|
2393
3780
|
}
|
|
2394
3781
|
interface GetReferringCustomerByReferralCodeResponseNonNullableFields {
|
|
2395
|
-
referringCustomer?:
|
|
2396
|
-
_id: string;
|
|
2397
|
-
contactId: string;
|
|
2398
|
-
referralCode: string;
|
|
2399
|
-
};
|
|
3782
|
+
referringCustomer?: ReferringCustomerNonNullableFields;
|
|
2400
3783
|
}
|
|
2401
3784
|
interface QueryReferringCustomersResponseNonNullableFields {
|
|
2402
|
-
referringCustomers:
|
|
2403
|
-
_id: string;
|
|
2404
|
-
contactId: string;
|
|
2405
|
-
referralCode: string;
|
|
2406
|
-
}[];
|
|
3785
|
+
referringCustomers: ReferringCustomerNonNullableFields[];
|
|
2407
3786
|
}
|
|
2408
3787
|
interface BaseEventMetadata {
|
|
2409
3788
|
/** App instance ID. */
|
|
@@ -2540,59 +3919,17 @@ interface DeleteReferringCustomerOptions {
|
|
|
2540
3919
|
revision?: string;
|
|
2541
3920
|
}
|
|
2542
3921
|
|
|
2543
|
-
|
|
2544
|
-
request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
|
|
2545
|
-
fetchWithAuth: (url: string | URL, init?: RequestInit) => Promise<Response>;
|
|
2546
|
-
}
|
|
2547
|
-
type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
|
|
2548
|
-
type HttpResponse<T = any> = {
|
|
2549
|
-
data: T;
|
|
2550
|
-
status: number;
|
|
2551
|
-
statusText: string;
|
|
2552
|
-
headers: any;
|
|
2553
|
-
request?: any;
|
|
2554
|
-
};
|
|
2555
|
-
type RequestOptions<_TResponse = any, Data = any> = {
|
|
2556
|
-
method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
|
2557
|
-
url: string;
|
|
2558
|
-
data?: Data;
|
|
2559
|
-
params?: URLSearchParams;
|
|
2560
|
-
} & APIMetadata;
|
|
2561
|
-
type APIMetadata = {
|
|
2562
|
-
methodFqn?: string;
|
|
2563
|
-
entityFqdn?: string;
|
|
2564
|
-
packageName?: string;
|
|
2565
|
-
};
|
|
2566
|
-
type EventDefinition<Payload = unknown, Type extends string = string> = {
|
|
2567
|
-
__type: 'event-definition';
|
|
2568
|
-
type: Type;
|
|
2569
|
-
isDomainEvent?: boolean;
|
|
2570
|
-
transformations?: (envelope: unknown) => Payload;
|
|
2571
|
-
__payload: Payload;
|
|
2572
|
-
};
|
|
2573
|
-
declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
|
|
3922
|
+
declare function createRESTModule<T extends RESTFunctionDescriptor>(descriptor: T, elevated?: boolean): BuildRESTFunction<T> & T;
|
|
2574
3923
|
|
|
2575
|
-
declare
|
|
2576
|
-
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
|
|
2577
|
-
interface SymbolConstructor {
|
|
2578
|
-
readonly observable: symbol;
|
|
2579
|
-
}
|
|
2580
|
-
}
|
|
3924
|
+
declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
|
|
2581
3925
|
|
|
2582
|
-
declare const
|
|
2583
|
-
|
|
2584
|
-
|
|
2585
|
-
declare
|
|
2586
|
-
declare
|
|
2587
|
-
|
|
2588
|
-
|
|
2589
|
-
referralCode: string;
|
|
2590
|
-
}>;
|
|
2591
|
-
declare function getReferringCustomerByReferralCode(httpClient: HttpClient): (referralCode: string) => Promise<GetReferringCustomerByReferralCodeResponse & GetReferringCustomerByReferralCodeResponseNonNullableFields>;
|
|
2592
|
-
declare function queryReferringCustomers(httpClient: HttpClient): () => ReferringCustomersQueryBuilder;
|
|
2593
|
-
declare function deleteReferringCustomer(httpClient: HttpClient): (referringCustomerId: string, options?: DeleteReferringCustomerOptions) => Promise<void>;
|
|
2594
|
-
declare const onReferringCustomerCreated: EventDefinition<ReferringCustomerCreatedEnvelope, "wix.loyalty.referral.v1.referring_customer_created">;
|
|
2595
|
-
declare const onReferringCustomerDeleted: EventDefinition<ReferringCustomerDeletedEnvelope, "wix.loyalty.referral.v1.referring_customer_deleted">;
|
|
3926
|
+
declare const generateReferringCustomerForContact: ReturnType<typeof createRESTModule<typeof publicGenerateReferringCustomerForContact>>;
|
|
3927
|
+
declare const getReferringCustomer: ReturnType<typeof createRESTModule<typeof publicGetReferringCustomer>>;
|
|
3928
|
+
declare const getReferringCustomerByReferralCode: ReturnType<typeof createRESTModule<typeof publicGetReferringCustomerByReferralCode>>;
|
|
3929
|
+
declare const queryReferringCustomers: ReturnType<typeof createRESTModule<typeof publicQueryReferringCustomers>>;
|
|
3930
|
+
declare const deleteReferringCustomer: ReturnType<typeof createRESTModule<typeof publicDeleteReferringCustomer>>;
|
|
3931
|
+
declare const onReferringCustomerCreated: ReturnType<typeof createEventModule<typeof publicOnReferringCustomerCreated>>;
|
|
3932
|
+
declare const onReferringCustomerDeleted: ReturnType<typeof createEventModule<typeof publicOnReferringCustomerDeleted>>;
|
|
2596
3933
|
|
|
2597
3934
|
type index_d_ActionEvent = ActionEvent;
|
|
2598
3935
|
type index_d_BaseEventMetadata = BaseEventMetadata;
|
|
@@ -2628,6 +3965,7 @@ type index_d_QueryReferringCustomersResponseNonNullableFields = QueryReferringCu
|
|
|
2628
3965
|
type index_d_ReferringCustomer = ReferringCustomer;
|
|
2629
3966
|
type index_d_ReferringCustomerCreatedEnvelope = ReferringCustomerCreatedEnvelope;
|
|
2630
3967
|
type index_d_ReferringCustomerDeletedEnvelope = ReferringCustomerDeletedEnvelope;
|
|
3968
|
+
type index_d_ReferringCustomerNonNullableFields = ReferringCustomerNonNullableFields;
|
|
2631
3969
|
type index_d_ReferringCustomersQueryBuilder = ReferringCustomersQueryBuilder;
|
|
2632
3970
|
type index_d_ReferringCustomersQueryResult = ReferringCustomersQueryResult;
|
|
2633
3971
|
type index_d_SortOrder = SortOrder;
|
|
@@ -2636,7 +3974,6 @@ type index_d_Sorting = Sorting;
|
|
|
2636
3974
|
type index_d_UndeleteInfo = UndeleteInfo;
|
|
2637
3975
|
type index_d_WebhookIdentityType = WebhookIdentityType;
|
|
2638
3976
|
declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
|
|
2639
|
-
declare const index_d___metadata: typeof __metadata;
|
|
2640
3977
|
declare const index_d_deleteReferringCustomer: typeof deleteReferringCustomer;
|
|
2641
3978
|
declare const index_d_generateReferringCustomerForContact: typeof generateReferringCustomerForContact;
|
|
2642
3979
|
declare const index_d_getReferringCustomer: typeof getReferringCustomer;
|
|
@@ -2645,7 +3982,7 @@ declare const index_d_onReferringCustomerCreated: typeof onReferringCustomerCrea
|
|
|
2645
3982
|
declare const index_d_onReferringCustomerDeleted: typeof onReferringCustomerDeleted;
|
|
2646
3983
|
declare const index_d_queryReferringCustomers: typeof queryReferringCustomers;
|
|
2647
3984
|
declare namespace index_d {
|
|
2648
|
-
export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_CursorQuery as CursorQuery, type index_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type index_d_Cursors as Cursors, type index_d_DeleteReferringCustomerOptions as DeleteReferringCustomerOptions, type index_d_DeleteReferringCustomerRequest as DeleteReferringCustomerRequest, type index_d_DeleteReferringCustomerResponse as DeleteReferringCustomerResponse, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_GenerateReferringCustomerForContactRequest as GenerateReferringCustomerForContactRequest, type index_d_GenerateReferringCustomerForContactResponse as GenerateReferringCustomerForContactResponse, type index_d_GenerateReferringCustomerForContactResponseNonNullableFields as GenerateReferringCustomerForContactResponseNonNullableFields, type index_d_GetReferringCustomerByReferralCodeRequest as GetReferringCustomerByReferralCodeRequest, type index_d_GetReferringCustomerByReferralCodeResponse as GetReferringCustomerByReferralCodeResponse, type index_d_GetReferringCustomerByReferralCodeResponseNonNullableFields as GetReferringCustomerByReferralCodeResponseNonNullableFields, type index_d_GetReferringCustomerRequest as GetReferringCustomerRequest, type index_d_GetReferringCustomerResponse as GetReferringCustomerResponse, type index_d_GetReferringCustomerResponseNonNullableFields as GetReferringCustomerResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_MessageEnvelope as MessageEnvelope, type index_d_QueryReferringCustomersRequest as QueryReferringCustomersRequest, type index_d_QueryReferringCustomersResponse as QueryReferringCustomersResponse, type index_d_QueryReferringCustomersResponseNonNullableFields as QueryReferringCustomersResponseNonNullableFields, type index_d_ReferringCustomer as ReferringCustomer, type index_d_ReferringCustomerCreatedEnvelope as ReferringCustomerCreatedEnvelope, type index_d_ReferringCustomerDeletedEnvelope as ReferringCustomerDeletedEnvelope, type index_d_ReferringCustomersQueryBuilder as ReferringCustomersQueryBuilder, type index_d_ReferringCustomersQueryResult as ReferringCustomersQueryResult, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, type index_d_UndeleteInfo as UndeleteInfo, index_d_WebhookIdentityType as WebhookIdentityType,
|
|
3985
|
+
export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_CursorQuery as CursorQuery, type index_d_CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOf, type index_d_Cursors as Cursors, type index_d_DeleteReferringCustomerOptions as DeleteReferringCustomerOptions, type index_d_DeleteReferringCustomerRequest as DeleteReferringCustomerRequest, type index_d_DeleteReferringCustomerResponse as DeleteReferringCustomerResponse, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_EventMetadata as EventMetadata, type index_d_GenerateReferringCustomerForContactRequest as GenerateReferringCustomerForContactRequest, type index_d_GenerateReferringCustomerForContactResponse as GenerateReferringCustomerForContactResponse, type index_d_GenerateReferringCustomerForContactResponseNonNullableFields as GenerateReferringCustomerForContactResponseNonNullableFields, type index_d_GetReferringCustomerByReferralCodeRequest as GetReferringCustomerByReferralCodeRequest, type index_d_GetReferringCustomerByReferralCodeResponse as GetReferringCustomerByReferralCodeResponse, type index_d_GetReferringCustomerByReferralCodeResponseNonNullableFields as GetReferringCustomerByReferralCodeResponseNonNullableFields, type index_d_GetReferringCustomerRequest as GetReferringCustomerRequest, type index_d_GetReferringCustomerResponse as GetReferringCustomerResponse, type index_d_GetReferringCustomerResponseNonNullableFields as GetReferringCustomerResponseNonNullableFields, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_MessageEnvelope as MessageEnvelope, type index_d_QueryReferringCustomersRequest as QueryReferringCustomersRequest, type index_d_QueryReferringCustomersResponse as QueryReferringCustomersResponse, type index_d_QueryReferringCustomersResponseNonNullableFields as QueryReferringCustomersResponseNonNullableFields, type index_d_ReferringCustomer as ReferringCustomer, type index_d_ReferringCustomerCreatedEnvelope as ReferringCustomerCreatedEnvelope, type index_d_ReferringCustomerDeletedEnvelope as ReferringCustomerDeletedEnvelope, type index_d_ReferringCustomerNonNullableFields as ReferringCustomerNonNullableFields, type index_d_ReferringCustomersQueryBuilder as ReferringCustomersQueryBuilder, type index_d_ReferringCustomersQueryResult as ReferringCustomersQueryResult, index_d_SortOrder as SortOrder, type index_d_Sorting as Sorting, type index_d_UndeleteInfo as UndeleteInfo, index_d_WebhookIdentityType as WebhookIdentityType, index_d_deleteReferringCustomer as deleteReferringCustomer, index_d_generateReferringCustomerForContact as generateReferringCustomerForContact, index_d_getReferringCustomer as getReferringCustomer, index_d_getReferringCustomerByReferralCode as getReferringCustomerByReferralCode, index_d_onReferringCustomerCreated as onReferringCustomerCreated, index_d_onReferringCustomerDeleted as onReferringCustomerDeleted, index_d_queryReferringCustomers as queryReferringCustomers };
|
|
2649
3986
|
}
|
|
2650
3987
|
|
|
2651
|
-
export { index_d as customers, index_d$1 as friends, index_d$2 as rewards, index_d$3 as tracker };
|
|
3988
|
+
export { index_d as customers, index_d$1 as friends, index_d$4 as programs, index_d$2 as rewards, index_d$3 as tracker };
|