@wix/referral 1.0.3 → 1.0.5
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 -1
- package/build/cjs/context.js +2 -2
- package/build/cjs/context.js.map +1 -1
- package/build/cjs/index.d.ts +1 -1
- package/build/cjs/index.js +2 -2
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/meta.d.ts +1 -1
- package/build/cjs/meta.js +2 -2
- package/build/cjs/meta.js.map +1 -1
- package/build/es/context.d.ts +1 -1
- package/build/es/context.js +1 -1
- package/build/es/context.js.map +1 -1
- package/build/es/index.d.ts +1 -1
- package/build/es/index.js +1 -1
- package/build/es/index.js.map +1 -1
- package/build/es/meta.d.ts +1 -1
- package/build/es/meta.js +1 -1
- package/build/es/meta.js.map +1 -1
- package/package.json +4 -4
- package/type-bundles/context.bundle.d.ts +652 -963
- package/type-bundles/index.bundle.d.ts +880 -2113
- package/type-bundles/meta.bundle.d.ts +863 -1469
|
@@ -1,186 +1,121 @@
|
|
|
1
|
-
/**
|
|
2
|
-
interface
|
|
3
|
-
/**
|
|
4
|
-
|
|
1
|
+
/** ReferralEvent. */
|
|
2
|
+
interface ReferralEvent$1 extends ReferralEventEventTypeOneOf$1 {
|
|
3
|
+
/** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
|
|
4
|
+
referredFriendSignupEvent?: ReferredFriendSignupEvent$1;
|
|
5
|
+
/** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
|
|
6
|
+
successfulReferralEvent?: V1SuccessfulReferralEvent$1;
|
|
7
|
+
/** ActionEvent is an event that is triggered when an action is performed. */
|
|
8
|
+
actionEvent?: V1ActionEvent$1;
|
|
9
|
+
/** RewardEvent is an event that is triggered when a reward is given. */
|
|
10
|
+
rewardEvent?: RewardEvent$1;
|
|
5
11
|
/**
|
|
6
|
-
*
|
|
12
|
+
* ReferralEvent ID.
|
|
7
13
|
* @readonly
|
|
8
14
|
*/
|
|
9
|
-
|
|
15
|
+
id?: string | null;
|
|
10
16
|
/** 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
17
|
revision?: string | null;
|
|
12
18
|
/**
|
|
13
|
-
*
|
|
19
|
+
* Represents the time this ReferralEvent was created.
|
|
14
20
|
* @readonly
|
|
15
21
|
*/
|
|
16
22
|
createdDate?: Date;
|
|
17
23
|
/**
|
|
18
|
-
*
|
|
24
|
+
* Represents the time this ReferralEvent was last updated.
|
|
19
25
|
* @readonly
|
|
20
26
|
*/
|
|
21
27
|
updatedDate?: Date;
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
+
}
|
|
29
|
+
/** @oneof */
|
|
30
|
+
interface ReferralEventEventTypeOneOf$1 {
|
|
31
|
+
/** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
|
|
32
|
+
referredFriendSignupEvent?: ReferredFriendSignupEvent$1;
|
|
33
|
+
/** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
|
|
34
|
+
successfulReferralEvent?: V1SuccessfulReferralEvent$1;
|
|
35
|
+
/** ActionEvent is an event that is triggered when an action is performed. */
|
|
36
|
+
actionEvent?: V1ActionEvent$1;
|
|
37
|
+
/** RewardEvent is an event that is triggered when a reward is given. */
|
|
38
|
+
rewardEvent?: RewardEvent$1;
|
|
39
|
+
}
|
|
40
|
+
interface ReferredFriendSignupEvent$1 {
|
|
41
|
+
/** The referred friend ID. */
|
|
42
|
+
referredFriendId?: string;
|
|
43
|
+
}
|
|
44
|
+
interface V1SuccessfulReferralEvent$1 {
|
|
45
|
+
/** The referred friend ID. */
|
|
46
|
+
referredFriendId?: string;
|
|
47
|
+
/** The referring customer ID. */
|
|
48
|
+
referringCustomerId?: string;
|
|
49
|
+
}
|
|
50
|
+
interface V1ActionEvent$1 {
|
|
51
|
+
/** The referred friend ID. */
|
|
52
|
+
referredFriendId?: string;
|
|
53
|
+
/** The referring customer ID. */
|
|
54
|
+
referringCustomerId?: string;
|
|
55
|
+
/** The trigger of the action. */
|
|
56
|
+
trigger?: V1Trigger$1;
|
|
57
|
+
/** Amount. */
|
|
58
|
+
amount?: string | null;
|
|
59
|
+
/** Currency. */
|
|
60
|
+
currency?: string | null;
|
|
61
|
+
/** Order ID. */
|
|
62
|
+
orderId?: string | null;
|
|
63
|
+
}
|
|
64
|
+
interface V1Trigger$1 {
|
|
65
|
+
/** The app id of the app that triggered the event. */
|
|
66
|
+
appId?: string;
|
|
67
|
+
/** The activity type that triggered the event. */
|
|
68
|
+
activityType?: string;
|
|
69
|
+
}
|
|
70
|
+
interface RewardEvent$1 extends RewardEventReceiverOneOf$1 {
|
|
28
71
|
/**
|
|
29
|
-
*
|
|
72
|
+
* The referring customer ID.
|
|
30
73
|
* @readonly
|
|
31
|
-
* @deprecated Set to true if user has required plan to activate program.
|
|
32
|
-
* @replacedBy GetReferralProgramPremiumFeatures
|
|
33
|
-
* @removalDate 2024-09-01
|
|
34
74
|
*/
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
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$3 extends RewardOptionsOneOf$1 {
|
|
50
|
-
/** Options for coupon reward type. */
|
|
51
|
-
couponOptions?: Coupon$3;
|
|
52
|
-
/** Options for Loyalty points reward type. */
|
|
53
|
-
loyaltyPointsOptions?: LoyaltyPoints$3;
|
|
54
|
-
/** Type of the reward. */
|
|
55
|
-
type?: Type$1;
|
|
75
|
+
rewardedReferringCustomerId?: string;
|
|
76
|
+
/**
|
|
77
|
+
* The referred friend ID.
|
|
78
|
+
* @readonly
|
|
79
|
+
*/
|
|
80
|
+
rewardedReferredFriendId?: string;
|
|
81
|
+
/** The referral reward ID. */
|
|
82
|
+
referralRewardId?: string;
|
|
83
|
+
/** The reward type. */
|
|
84
|
+
rewardType?: Reward$1;
|
|
56
85
|
}
|
|
57
86
|
/** @oneof */
|
|
58
|
-
interface
|
|
59
|
-
/**
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
87
|
+
interface RewardEventReceiverOneOf$1 {
|
|
88
|
+
/**
|
|
89
|
+
* The referring customer ID.
|
|
90
|
+
* @readonly
|
|
91
|
+
*/
|
|
92
|
+
rewardedReferringCustomerId?: string;
|
|
93
|
+
/**
|
|
94
|
+
* The referred friend ID.
|
|
95
|
+
* @readonly
|
|
96
|
+
*/
|
|
97
|
+
rewardedReferredFriendId?: string;
|
|
63
98
|
}
|
|
64
|
-
declare enum
|
|
99
|
+
declare enum Reward$1 {
|
|
65
100
|
/** Unknown reward type. */
|
|
66
101
|
UNKNOWN = "UNKNOWN",
|
|
67
|
-
/**
|
|
102
|
+
/** Reward is a coupon. */
|
|
68
103
|
COUPON = "COUPON",
|
|
69
|
-
/**
|
|
104
|
+
/** Reward is loyalty points. */
|
|
70
105
|
LOYALTY_POINTS = "LOYALTY_POINTS",
|
|
71
|
-
/** No reward
|
|
106
|
+
/** No reward. */
|
|
72
107
|
NOTHING = "NOTHING"
|
|
73
108
|
}
|
|
74
|
-
interface
|
|
75
|
-
/**
|
|
76
|
-
|
|
77
|
-
/** Options for percentage discount type. */
|
|
78
|
-
percentageOptions?: PercentageDiscount$3;
|
|
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$3;
|
|
83
|
-
/** Coupon name. */
|
|
84
|
-
name?: string;
|
|
85
|
-
/** Coupon discount type. */
|
|
86
|
-
discountType?: DiscountType$3;
|
|
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$3 {
|
|
96
|
-
/** Options for fixed amount discount type. */
|
|
97
|
-
fixedAmountOptions?: FixedAmountDiscount$3;
|
|
98
|
-
/** Options for percentage discount type. */
|
|
99
|
-
percentageOptions?: PercentageDiscount$3;
|
|
100
|
-
}
|
|
101
|
-
/** @oneof */
|
|
102
|
-
interface CouponScopeOrMinSubtotalOneOf$3 {
|
|
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$3;
|
|
107
|
-
}
|
|
108
|
-
declare enum DiscountType$3 {
|
|
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$3 {
|
|
119
|
-
/** Fixed amount to discount. */
|
|
120
|
-
amount?: number;
|
|
121
|
-
}
|
|
122
|
-
interface PercentageDiscount$3 {
|
|
123
|
-
/** Percentage to discount. */
|
|
124
|
-
percentage?: number;
|
|
125
|
-
}
|
|
126
|
-
interface CouponScope$3 {
|
|
127
|
-
/** Namespace of the coupon scope. */
|
|
128
|
-
namespace?: string;
|
|
129
|
-
/** Group of the coupon scope. */
|
|
130
|
-
group?: Group$3;
|
|
131
|
-
}
|
|
132
|
-
interface Group$3 {
|
|
133
|
-
/** Name of the group. */
|
|
134
|
-
name?: string;
|
|
135
|
-
/** Entity ID of the group. */
|
|
136
|
-
entityId?: string | null;
|
|
109
|
+
interface GetReferralEventRequest$1 {
|
|
110
|
+
/** Id of the ReferralEvent to retrieve */
|
|
111
|
+
referralEventId: string;
|
|
137
112
|
}
|
|
138
|
-
interface
|
|
139
|
-
/**
|
|
140
|
-
|
|
113
|
+
interface GetReferralEventResponse$1 {
|
|
114
|
+
/** The retrieved ReferralEvent */
|
|
115
|
+
referralEvent?: ReferralEvent$1;
|
|
141
116
|
}
|
|
142
|
-
|
|
143
|
-
/**
|
|
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$1 {
|
|
157
|
-
/** Encourage customers to refer their friends email. Select for which apps to enable. */
|
|
158
|
-
encourageToReferFriends?: App$1[];
|
|
159
|
-
/** Notify customers about their referral reward email. Set true to enable email. */
|
|
160
|
-
notifyCustomersAboutReward?: boolean;
|
|
161
|
-
}
|
|
162
|
-
declare enum App$1 {
|
|
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$1 {
|
|
177
|
-
}
|
|
178
|
-
interface GetReferralProgramResponse$1 {
|
|
179
|
-
/** The retrieved ReferralProgram. */
|
|
180
|
-
referralProgram?: ReferralProgram$1;
|
|
181
|
-
}
|
|
182
|
-
interface QueryReferralProgramsRequest$1 {
|
|
183
|
-
/** Query to filter ReferralPrograms. */
|
|
117
|
+
interface QueryReferralEventRequest$1 {
|
|
118
|
+
/** Query to filter ReferralEvents. */
|
|
184
119
|
query: CursorQuery$7;
|
|
185
120
|
}
|
|
186
121
|
interface CursorQuery$7 extends CursorQueryPagingMethodOneOf$7 {
|
|
@@ -227,11 +162,11 @@ interface CursorPaging$7 {
|
|
|
227
162
|
*/
|
|
228
163
|
cursor?: string | null;
|
|
229
164
|
}
|
|
230
|
-
interface
|
|
231
|
-
/**
|
|
232
|
-
|
|
165
|
+
interface QueryReferralEventResponse$1 {
|
|
166
|
+
/** List of ReferralEvents that match the query. */
|
|
167
|
+
referralEvents?: ReferralEvent$1[];
|
|
233
168
|
/** Paging metadata. */
|
|
234
|
-
|
|
169
|
+
metadata?: CursorPagingMetadata$7;
|
|
235
170
|
}
|
|
236
171
|
interface CursorPagingMetadata$7 {
|
|
237
172
|
/** Number of items returned in the response. */
|
|
@@ -252,448 +187,169 @@ interface Cursors$7 {
|
|
|
252
187
|
/** Cursor pointing to the previous page in the list of results. */
|
|
253
188
|
prev?: string | null;
|
|
254
189
|
}
|
|
255
|
-
interface
|
|
256
|
-
/** ReferralProgram to be updated, may be partial. */
|
|
257
|
-
referralProgram: ReferralProgram$1;
|
|
258
|
-
}
|
|
259
|
-
interface UpdateReferralProgramResponse$1 {
|
|
260
|
-
/** The updated ReferralProgram. */
|
|
261
|
-
referralProgram?: ReferralProgram$1;
|
|
262
|
-
}
|
|
263
|
-
interface ActivateReferralProgramRequest$1 {
|
|
264
|
-
}
|
|
265
|
-
interface ActivateReferralProgramResponse$1 {
|
|
266
|
-
/** The activated ReferralProgram. */
|
|
267
|
-
referralProgram?: ReferralProgram$1;
|
|
268
|
-
}
|
|
269
|
-
interface PauseReferralProgramRequest$1 {
|
|
270
|
-
}
|
|
271
|
-
interface PauseReferralProgramResponse$1 {
|
|
272
|
-
/** The paused ReferralProgram. */
|
|
273
|
-
referralProgram?: ReferralProgram$1;
|
|
190
|
+
interface GetReferralStatisticsRequest$1 {
|
|
274
191
|
}
|
|
275
|
-
interface
|
|
276
|
-
/**
|
|
277
|
-
|
|
192
|
+
interface GetReferralStatisticsResponse$1 {
|
|
193
|
+
/** Total sign ups completed by referred friends */
|
|
194
|
+
totalSignUpsCompleted?: number;
|
|
195
|
+
/** Total actions completed by referred friends */
|
|
196
|
+
totalActionsCompleted?: number;
|
|
197
|
+
/** Total amount of purchases made by referred friends */
|
|
198
|
+
totalAmountGenerated?: string;
|
|
278
199
|
}
|
|
279
|
-
interface
|
|
280
|
-
/**
|
|
281
|
-
|
|
282
|
-
/**
|
|
283
|
-
|
|
200
|
+
interface QueryReferringCustomerTotalsRequest$1 {
|
|
201
|
+
/** Query to filter ReferringCustomerTotals. */
|
|
202
|
+
query?: CursorQuery$7;
|
|
203
|
+
/** List of contact ids to filter ReferringCustomerTotals. */
|
|
204
|
+
contactIds?: string[];
|
|
284
205
|
}
|
|
285
|
-
interface
|
|
286
|
-
/**
|
|
287
|
-
|
|
288
|
-
/**
|
|
289
|
-
|
|
206
|
+
interface QueryReferringCustomerTotalsResponse$1 {
|
|
207
|
+
/** List of ReferringCustomerTotals that match the query. */
|
|
208
|
+
referringCustomerTotals?: ReferringCustomerTotal$1[];
|
|
209
|
+
/** Paging metadata. */
|
|
210
|
+
metadata?: CursorPagingMetadata$7;
|
|
290
211
|
}
|
|
291
|
-
interface
|
|
292
|
-
/**
|
|
293
|
-
|
|
212
|
+
interface ReferringCustomerTotal$1 {
|
|
213
|
+
/**
|
|
214
|
+
* Referring customer id.
|
|
215
|
+
* @readonly
|
|
216
|
+
*/
|
|
217
|
+
referringCustomerId?: string;
|
|
218
|
+
/**
|
|
219
|
+
* Contact id.
|
|
220
|
+
* @readonly
|
|
221
|
+
*/
|
|
222
|
+
contactId?: string;
|
|
223
|
+
/**
|
|
224
|
+
* Last successful referral date.
|
|
225
|
+
* @readonly
|
|
226
|
+
*/
|
|
227
|
+
lastSuccessfulReferral?: Date;
|
|
228
|
+
/**
|
|
229
|
+
* Total successful referrals made by this customer.
|
|
230
|
+
* @readonly
|
|
231
|
+
*/
|
|
232
|
+
totalSuccessfulReferrals?: number;
|
|
233
|
+
/**
|
|
234
|
+
* Total amount generated by friends referred by this customer.
|
|
235
|
+
* @readonly
|
|
236
|
+
*/
|
|
237
|
+
totalAmountGenerated?: string;
|
|
238
|
+
/**
|
|
239
|
+
* Last friend action date.
|
|
240
|
+
* @readonly
|
|
241
|
+
*/
|
|
242
|
+
lastFriendAction?: Date;
|
|
243
|
+
/**
|
|
244
|
+
* Total friends that have actions done.
|
|
245
|
+
* @readonly
|
|
246
|
+
*/
|
|
247
|
+
totalFriendsWithActions?: number;
|
|
294
248
|
}
|
|
295
|
-
interface
|
|
296
|
-
/**
|
|
297
|
-
|
|
298
|
-
/**
|
|
299
|
-
|
|
249
|
+
interface QueryReferredFriendActionsRequest$1 {
|
|
250
|
+
/** Query to filter ReferredFriendActions. */
|
|
251
|
+
query?: CursorQuery$7;
|
|
252
|
+
/** List of contact ids to filter ReferredFriendActions. */
|
|
253
|
+
contactIds?: string[];
|
|
300
254
|
}
|
|
301
|
-
interface
|
|
255
|
+
interface QueryReferredFriendActionsResponse$1 {
|
|
256
|
+
/** List of ReferredFriendActions that match the query. */
|
|
257
|
+
referredFriendActions?: ReferredFriendAction$1[];
|
|
258
|
+
/** Paging metadata. */
|
|
259
|
+
metadata?: CursorPagingMetadata$7;
|
|
302
260
|
}
|
|
303
|
-
interface
|
|
261
|
+
interface ReferredFriendAction$1 extends ReferredFriendActionRewardTypeOptionsOneOf$1 {
|
|
262
|
+
/** Coupon reward type options. */
|
|
263
|
+
coupon?: V1Coupon$3;
|
|
264
|
+
/** Loyalty points reward type options. */
|
|
265
|
+
loyaltyPoints?: LoyaltyPoints$1;
|
|
266
|
+
/**
|
|
267
|
+
* Referred friend id.
|
|
268
|
+
* @readonly
|
|
269
|
+
*/
|
|
270
|
+
referredFriendId?: string;
|
|
304
271
|
/**
|
|
305
|
-
*
|
|
272
|
+
* Contact id.
|
|
273
|
+
* @readonly
|
|
274
|
+
*/
|
|
275
|
+
contactId?: string;
|
|
276
|
+
/**
|
|
277
|
+
* First action trigger.
|
|
278
|
+
* @readonly
|
|
279
|
+
*/
|
|
280
|
+
trigger?: V1Trigger$1;
|
|
281
|
+
/**
|
|
282
|
+
* First action date.
|
|
283
|
+
* @readonly
|
|
284
|
+
*/
|
|
285
|
+
actionDate?: Date;
|
|
286
|
+
/** Issued reward type. */
|
|
287
|
+
rewardType?: Reward$1;
|
|
288
|
+
/** Total number of actions. */
|
|
289
|
+
totalActions?: number;
|
|
290
|
+
/**
|
|
291
|
+
* Total amount spent by this referred friend.
|
|
292
|
+
* @readonly
|
|
293
|
+
*/
|
|
294
|
+
totalAmountSpent?: string;
|
|
295
|
+
/**
|
|
296
|
+
* friend signup date.
|
|
306
297
|
* @readonly
|
|
307
298
|
*/
|
|
308
|
-
|
|
299
|
+
signupDate?: Date;
|
|
309
300
|
}
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
amount: number;
|
|
317
|
-
};
|
|
318
|
-
percentageOptions?: {
|
|
319
|
-
percentage: number;
|
|
320
|
-
};
|
|
321
|
-
minimumSubtotal: number;
|
|
322
|
-
scope?: {
|
|
323
|
-
namespace: string;
|
|
324
|
-
group?: {
|
|
325
|
-
name: string;
|
|
326
|
-
};
|
|
327
|
-
};
|
|
328
|
-
name: string;
|
|
329
|
-
discountType: DiscountType$3;
|
|
330
|
-
};
|
|
331
|
-
loyaltyPointsOptions?: {
|
|
332
|
-
amount: number;
|
|
333
|
-
};
|
|
334
|
-
type: Type$1;
|
|
335
|
-
};
|
|
336
|
-
referringCustomerReward?: {
|
|
337
|
-
couponOptions?: {
|
|
338
|
-
fixedAmountOptions?: {
|
|
339
|
-
amount: number;
|
|
340
|
-
};
|
|
341
|
-
percentageOptions?: {
|
|
342
|
-
percentage: number;
|
|
343
|
-
};
|
|
344
|
-
minimumSubtotal: number;
|
|
345
|
-
scope?: {
|
|
346
|
-
namespace: string;
|
|
347
|
-
group?: {
|
|
348
|
-
name: string;
|
|
349
|
-
};
|
|
350
|
-
};
|
|
351
|
-
name: string;
|
|
352
|
-
discountType: DiscountType$3;
|
|
353
|
-
};
|
|
354
|
-
loyaltyPointsOptions?: {
|
|
355
|
-
amount: number;
|
|
356
|
-
};
|
|
357
|
-
type: Type$1;
|
|
358
|
-
};
|
|
359
|
-
successfulReferralActions: Action$1[];
|
|
360
|
-
isPremium: boolean;
|
|
361
|
-
emails?: {
|
|
362
|
-
encourageToReferFriends: App$1[];
|
|
363
|
-
notifyCustomersAboutReward: boolean;
|
|
364
|
-
};
|
|
365
|
-
};
|
|
366
|
-
}
|
|
367
|
-
interface QueryReferralProgramsResponseNonNullableFields$1 {
|
|
368
|
-
referralPrograms: {
|
|
369
|
-
status: ProgramStatus$1;
|
|
370
|
-
referredFriendReward?: {
|
|
371
|
-
couponOptions?: {
|
|
372
|
-
fixedAmountOptions?: {
|
|
373
|
-
amount: number;
|
|
374
|
-
};
|
|
375
|
-
percentageOptions?: {
|
|
376
|
-
percentage: number;
|
|
377
|
-
};
|
|
378
|
-
minimumSubtotal: number;
|
|
379
|
-
scope?: {
|
|
380
|
-
namespace: string;
|
|
381
|
-
group?: {
|
|
382
|
-
name: string;
|
|
383
|
-
};
|
|
384
|
-
};
|
|
385
|
-
name: string;
|
|
386
|
-
discountType: DiscountType$3;
|
|
387
|
-
};
|
|
388
|
-
loyaltyPointsOptions?: {
|
|
389
|
-
amount: number;
|
|
390
|
-
};
|
|
391
|
-
type: Type$1;
|
|
392
|
-
};
|
|
393
|
-
referringCustomerReward?: {
|
|
394
|
-
couponOptions?: {
|
|
395
|
-
fixedAmountOptions?: {
|
|
396
|
-
amount: number;
|
|
397
|
-
};
|
|
398
|
-
percentageOptions?: {
|
|
399
|
-
percentage: number;
|
|
400
|
-
};
|
|
401
|
-
minimumSubtotal: number;
|
|
402
|
-
scope?: {
|
|
403
|
-
namespace: string;
|
|
404
|
-
group?: {
|
|
405
|
-
name: string;
|
|
406
|
-
};
|
|
407
|
-
};
|
|
408
|
-
name: string;
|
|
409
|
-
discountType: DiscountType$3;
|
|
410
|
-
};
|
|
411
|
-
loyaltyPointsOptions?: {
|
|
412
|
-
amount: number;
|
|
413
|
-
};
|
|
414
|
-
type: Type$1;
|
|
415
|
-
};
|
|
416
|
-
successfulReferralActions: Action$1[];
|
|
417
|
-
isPremium: boolean;
|
|
418
|
-
emails?: {
|
|
419
|
-
encourageToReferFriends: App$1[];
|
|
420
|
-
notifyCustomersAboutReward: boolean;
|
|
421
|
-
};
|
|
422
|
-
}[];
|
|
423
|
-
}
|
|
424
|
-
interface UpdateReferralProgramResponseNonNullableFields$1 {
|
|
425
|
-
referralProgram?: {
|
|
426
|
-
status: ProgramStatus$1;
|
|
427
|
-
referredFriendReward?: {
|
|
428
|
-
couponOptions?: {
|
|
429
|
-
fixedAmountOptions?: {
|
|
430
|
-
amount: number;
|
|
431
|
-
};
|
|
432
|
-
percentageOptions?: {
|
|
433
|
-
percentage: number;
|
|
434
|
-
};
|
|
435
|
-
minimumSubtotal: number;
|
|
436
|
-
scope?: {
|
|
437
|
-
namespace: string;
|
|
438
|
-
group?: {
|
|
439
|
-
name: string;
|
|
440
|
-
};
|
|
441
|
-
};
|
|
442
|
-
name: string;
|
|
443
|
-
discountType: DiscountType$3;
|
|
444
|
-
};
|
|
445
|
-
loyaltyPointsOptions?: {
|
|
446
|
-
amount: number;
|
|
447
|
-
};
|
|
448
|
-
type: Type$1;
|
|
449
|
-
};
|
|
450
|
-
referringCustomerReward?: {
|
|
451
|
-
couponOptions?: {
|
|
452
|
-
fixedAmountOptions?: {
|
|
453
|
-
amount: number;
|
|
454
|
-
};
|
|
455
|
-
percentageOptions?: {
|
|
456
|
-
percentage: number;
|
|
457
|
-
};
|
|
458
|
-
minimumSubtotal: number;
|
|
459
|
-
scope?: {
|
|
460
|
-
namespace: string;
|
|
461
|
-
group?: {
|
|
462
|
-
name: string;
|
|
463
|
-
};
|
|
464
|
-
};
|
|
465
|
-
name: string;
|
|
466
|
-
discountType: DiscountType$3;
|
|
467
|
-
};
|
|
468
|
-
loyaltyPointsOptions?: {
|
|
469
|
-
amount: number;
|
|
470
|
-
};
|
|
471
|
-
type: Type$1;
|
|
472
|
-
};
|
|
473
|
-
successfulReferralActions: Action$1[];
|
|
474
|
-
isPremium: boolean;
|
|
475
|
-
emails?: {
|
|
476
|
-
encourageToReferFriends: App$1[];
|
|
477
|
-
notifyCustomersAboutReward: boolean;
|
|
478
|
-
};
|
|
479
|
-
};
|
|
480
|
-
}
|
|
481
|
-
interface ActivateReferralProgramResponseNonNullableFields$1 {
|
|
482
|
-
referralProgram?: {
|
|
483
|
-
status: ProgramStatus$1;
|
|
484
|
-
referredFriendReward?: {
|
|
485
|
-
couponOptions?: {
|
|
486
|
-
fixedAmountOptions?: {
|
|
487
|
-
amount: number;
|
|
488
|
-
};
|
|
489
|
-
percentageOptions?: {
|
|
490
|
-
percentage: number;
|
|
491
|
-
};
|
|
492
|
-
minimumSubtotal: number;
|
|
493
|
-
scope?: {
|
|
494
|
-
namespace: string;
|
|
495
|
-
group?: {
|
|
496
|
-
name: string;
|
|
497
|
-
};
|
|
498
|
-
};
|
|
499
|
-
name: string;
|
|
500
|
-
discountType: DiscountType$3;
|
|
501
|
-
};
|
|
502
|
-
loyaltyPointsOptions?: {
|
|
503
|
-
amount: number;
|
|
504
|
-
};
|
|
505
|
-
type: Type$1;
|
|
506
|
-
};
|
|
507
|
-
referringCustomerReward?: {
|
|
508
|
-
couponOptions?: {
|
|
509
|
-
fixedAmountOptions?: {
|
|
510
|
-
amount: number;
|
|
511
|
-
};
|
|
512
|
-
percentageOptions?: {
|
|
513
|
-
percentage: number;
|
|
514
|
-
};
|
|
515
|
-
minimumSubtotal: number;
|
|
516
|
-
scope?: {
|
|
517
|
-
namespace: string;
|
|
518
|
-
group?: {
|
|
519
|
-
name: string;
|
|
520
|
-
};
|
|
521
|
-
};
|
|
522
|
-
name: string;
|
|
523
|
-
discountType: DiscountType$3;
|
|
524
|
-
};
|
|
525
|
-
loyaltyPointsOptions?: {
|
|
526
|
-
amount: number;
|
|
527
|
-
};
|
|
528
|
-
type: Type$1;
|
|
529
|
-
};
|
|
530
|
-
successfulReferralActions: Action$1[];
|
|
531
|
-
isPremium: boolean;
|
|
532
|
-
emails?: {
|
|
533
|
-
encourageToReferFriends: App$1[];
|
|
534
|
-
notifyCustomersAboutReward: boolean;
|
|
535
|
-
};
|
|
536
|
-
};
|
|
537
|
-
}
|
|
538
|
-
interface PauseReferralProgramResponseNonNullableFields$1 {
|
|
539
|
-
referralProgram?: {
|
|
540
|
-
status: ProgramStatus$1;
|
|
541
|
-
referredFriendReward?: {
|
|
542
|
-
couponOptions?: {
|
|
543
|
-
fixedAmountOptions?: {
|
|
544
|
-
amount: number;
|
|
545
|
-
};
|
|
546
|
-
percentageOptions?: {
|
|
547
|
-
percentage: number;
|
|
548
|
-
};
|
|
549
|
-
minimumSubtotal: number;
|
|
550
|
-
scope?: {
|
|
551
|
-
namespace: string;
|
|
552
|
-
group?: {
|
|
553
|
-
name: string;
|
|
554
|
-
};
|
|
555
|
-
};
|
|
556
|
-
name: string;
|
|
557
|
-
discountType: DiscountType$3;
|
|
558
|
-
};
|
|
559
|
-
loyaltyPointsOptions?: {
|
|
560
|
-
amount: number;
|
|
561
|
-
};
|
|
562
|
-
type: Type$1;
|
|
563
|
-
};
|
|
564
|
-
referringCustomerReward?: {
|
|
565
|
-
couponOptions?: {
|
|
566
|
-
fixedAmountOptions?: {
|
|
567
|
-
amount: number;
|
|
568
|
-
};
|
|
569
|
-
percentageOptions?: {
|
|
570
|
-
percentage: number;
|
|
571
|
-
};
|
|
572
|
-
minimumSubtotal: number;
|
|
573
|
-
scope?: {
|
|
574
|
-
namespace: string;
|
|
575
|
-
group?: {
|
|
576
|
-
name: string;
|
|
577
|
-
};
|
|
578
|
-
};
|
|
579
|
-
name: string;
|
|
580
|
-
discountType: DiscountType$3;
|
|
581
|
-
};
|
|
582
|
-
loyaltyPointsOptions?: {
|
|
583
|
-
amount: number;
|
|
584
|
-
};
|
|
585
|
-
type: Type$1;
|
|
586
|
-
};
|
|
587
|
-
successfulReferralActions: Action$1[];
|
|
588
|
-
isPremium: boolean;
|
|
589
|
-
emails?: {
|
|
590
|
-
encourageToReferFriends: App$1[];
|
|
591
|
-
notifyCustomersAboutReward: boolean;
|
|
592
|
-
};
|
|
593
|
-
};
|
|
594
|
-
}
|
|
595
|
-
interface GetAISocialMediaPostsSuggestionsResponseNonNullableFields$1 {
|
|
596
|
-
suggestions: {
|
|
597
|
-
postContent: string;
|
|
598
|
-
hashtags: string[];
|
|
599
|
-
}[];
|
|
600
|
-
}
|
|
601
|
-
interface GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields$1 {
|
|
602
|
-
suggestions: {
|
|
603
|
-
postContent: string;
|
|
604
|
-
hashtags: string[];
|
|
605
|
-
}[];
|
|
606
|
-
}
|
|
607
|
-
interface GetReferralProgramPremiumFeaturesResponseNonNullableFields$1 {
|
|
608
|
-
referralProgram: boolean;
|
|
301
|
+
/** @oneof */
|
|
302
|
+
interface ReferredFriendActionRewardTypeOptionsOneOf$1 {
|
|
303
|
+
/** Coupon reward type options. */
|
|
304
|
+
coupon?: V1Coupon$3;
|
|
305
|
+
/** Loyalty points reward type options. */
|
|
306
|
+
loyaltyPoints?: LoyaltyPoints$1;
|
|
609
307
|
}
|
|
610
|
-
|
|
611
|
-
/** ReferralProgram is the main entity of ReferralPrograms that can be used to manage the program. */
|
|
612
|
-
interface ReferralProgram {
|
|
613
|
-
/** Referral program name. */
|
|
614
|
-
name?: string | null;
|
|
308
|
+
interface V1Coupon$3 {
|
|
615
309
|
/**
|
|
616
|
-
*
|
|
310
|
+
* Coupon ID.
|
|
617
311
|
* @readonly
|
|
618
312
|
*/
|
|
619
|
-
|
|
620
|
-
/** 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. */
|
|
621
|
-
revision?: string | null;
|
|
313
|
+
id?: string;
|
|
622
314
|
/**
|
|
623
|
-
*
|
|
315
|
+
* Coupon code.
|
|
624
316
|
* @readonly
|
|
625
317
|
*/
|
|
626
|
-
|
|
318
|
+
code?: string;
|
|
627
319
|
/**
|
|
628
|
-
*
|
|
320
|
+
* Coupon status.
|
|
629
321
|
* @readonly
|
|
630
322
|
*/
|
|
631
|
-
|
|
632
|
-
/** Referred friend reward configuration. */
|
|
633
|
-
referredFriendReward?: Reward$2;
|
|
634
|
-
/** Referring customer reward configuration. */
|
|
635
|
-
referringCustomerReward?: Reward$2;
|
|
636
|
-
/** List of actions that complete referral. */
|
|
637
|
-
successfulReferralActions?: Action[];
|
|
323
|
+
status?: Status$5;
|
|
638
324
|
/**
|
|
639
|
-
*
|
|
325
|
+
* Coupon specification.
|
|
640
326
|
* @readonly
|
|
641
|
-
* @deprecated Set to true if user has required plan to activate program.
|
|
642
|
-
* @replacedBy GetReferralProgramPremiumFeatures
|
|
643
|
-
* @removalDate 2024-09-01
|
|
644
327
|
*/
|
|
645
|
-
|
|
646
|
-
/** Emails configuration. */
|
|
647
|
-
emails?: Emails;
|
|
328
|
+
couponSpecification?: Coupon$3;
|
|
648
329
|
}
|
|
649
|
-
declare enum
|
|
650
|
-
/**
|
|
330
|
+
declare enum Status$5 {
|
|
331
|
+
/** Unknown coupon status. */
|
|
651
332
|
UNKNOWN = "UNKNOWN",
|
|
652
|
-
/**
|
|
653
|
-
DRAFT = "DRAFT",
|
|
654
|
-
/** program is active. */
|
|
333
|
+
/** Coupon is active and can be applied. */
|
|
655
334
|
ACTIVE = "ACTIVE",
|
|
656
|
-
/**
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
/** Options for coupon reward type. */
|
|
661
|
-
couponOptions?: Coupon$2;
|
|
662
|
-
/** Options for Loyalty points reward type. */
|
|
663
|
-
loyaltyPointsOptions?: LoyaltyPoints$2;
|
|
664
|
-
/** Type of the reward. */
|
|
665
|
-
type?: Type;
|
|
666
|
-
}
|
|
667
|
-
/** @oneof */
|
|
668
|
-
interface RewardOptionsOneOf {
|
|
669
|
-
/** Options for coupon reward type. */
|
|
670
|
-
couponOptions?: Coupon$2;
|
|
671
|
-
/** Options for Loyalty points reward type. */
|
|
672
|
-
loyaltyPointsOptions?: LoyaltyPoints$2;
|
|
673
|
-
}
|
|
674
|
-
declare enum Type {
|
|
675
|
-
/** Unknown reward type. */
|
|
676
|
-
UNKNOWN = "UNKNOWN",
|
|
677
|
-
/** Coupon reward type. */
|
|
678
|
-
COUPON = "COUPON",
|
|
679
|
-
/** Loyalty points reward type. */
|
|
680
|
-
LOYALTY_POINTS = "LOYALTY_POINTS",
|
|
681
|
-
/** No reward type. */
|
|
682
|
-
NOTHING = "NOTHING"
|
|
335
|
+
/** Coupon was already applied and can not be used anymore. */
|
|
336
|
+
APPLIED = "APPLIED",
|
|
337
|
+
/** Coupon was deleted. */
|
|
338
|
+
DELETED = "DELETED"
|
|
683
339
|
}
|
|
684
|
-
interface Coupon$
|
|
685
|
-
/** Options for fixed amount discount type
|
|
686
|
-
fixedAmountOptions?: FixedAmountDiscount$
|
|
687
|
-
/** Options for percentage discount type
|
|
688
|
-
percentageOptions?: PercentageDiscount$
|
|
340
|
+
interface Coupon$3 extends CouponDiscountTypeOptionsOneOf$3, CouponScopeOrMinSubtotalOneOf$3 {
|
|
341
|
+
/** Options for fixed amount discount type */
|
|
342
|
+
fixedAmountOptions?: FixedAmountDiscount$3;
|
|
343
|
+
/** Options for percentage discount type */
|
|
344
|
+
percentageOptions?: PercentageDiscount$3;
|
|
689
345
|
/** Limit the coupon to carts with a subtotal above this number. */
|
|
690
346
|
minimumSubtotal?: number;
|
|
691
347
|
/** Specifies the type of line items this coupon will apply to. */
|
|
692
|
-
scope?: CouponScope$
|
|
693
|
-
/** Coupon name
|
|
348
|
+
scope?: CouponScope$3;
|
|
349
|
+
/** Coupon name */
|
|
694
350
|
name?: string;
|
|
695
|
-
/** Coupon discount type
|
|
696
|
-
discountType?: DiscountType$
|
|
351
|
+
/** Coupon discount type */
|
|
352
|
+
discountType?: DiscountType$3;
|
|
697
353
|
/** Limit the coupon to only apply to one item in cart. */
|
|
698
354
|
limitedToOneItem?: boolean | null;
|
|
699
355
|
/** If true, coupon also applies to subscriptions. */
|
|
@@ -702,477 +358,126 @@ interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSub
|
|
|
702
358
|
discountedCycleCount?: number | null;
|
|
703
359
|
}
|
|
704
360
|
/** @oneof */
|
|
705
|
-
interface CouponDiscountTypeOptionsOneOf$
|
|
706
|
-
/** Options for fixed amount discount type
|
|
707
|
-
fixedAmountOptions?: FixedAmountDiscount$
|
|
708
|
-
/** Options for percentage discount type
|
|
709
|
-
percentageOptions?: PercentageDiscount$
|
|
361
|
+
interface CouponDiscountTypeOptionsOneOf$3 {
|
|
362
|
+
/** Options for fixed amount discount type */
|
|
363
|
+
fixedAmountOptions?: FixedAmountDiscount$3;
|
|
364
|
+
/** Options for percentage discount type */
|
|
365
|
+
percentageOptions?: PercentageDiscount$3;
|
|
710
366
|
}
|
|
711
367
|
/** @oneof */
|
|
712
|
-
interface CouponScopeOrMinSubtotalOneOf$
|
|
368
|
+
interface CouponScopeOrMinSubtotalOneOf$3 {
|
|
713
369
|
/** Limit the coupon to carts with a subtotal above this number. */
|
|
714
370
|
minimumSubtotal?: number;
|
|
715
371
|
/** Specifies the type of line items this coupon will apply to. */
|
|
716
|
-
scope?: CouponScope$
|
|
372
|
+
scope?: CouponScope$3;
|
|
717
373
|
}
|
|
718
|
-
declare enum DiscountType$
|
|
719
|
-
/** Unknown discount type. */
|
|
374
|
+
declare enum DiscountType$3 {
|
|
720
375
|
UNKNOWN = "UNKNOWN",
|
|
721
|
-
/** Discount as a fixed amount
|
|
376
|
+
/** Discount as a fixed amount */
|
|
722
377
|
FIXED_AMOUNT = "FIXED_AMOUNT",
|
|
723
|
-
/** Discount as a percentage
|
|
378
|
+
/** Discount as a percentage */
|
|
724
379
|
PERCENTAGE = "PERCENTAGE",
|
|
725
|
-
/** Free shipping
|
|
380
|
+
/** Free shipping */
|
|
726
381
|
FREE_SHIPPING = "FREE_SHIPPING"
|
|
727
382
|
}
|
|
728
|
-
interface FixedAmountDiscount$
|
|
729
|
-
/** Fixed amount to discount
|
|
383
|
+
interface FixedAmountDiscount$3 {
|
|
384
|
+
/** Fixed amount to discount */
|
|
730
385
|
amount?: number;
|
|
731
386
|
}
|
|
732
|
-
interface PercentageDiscount$
|
|
733
|
-
/** Percentage to discount. */
|
|
387
|
+
interface PercentageDiscount$3 {
|
|
734
388
|
percentage?: number;
|
|
735
389
|
}
|
|
736
|
-
interface CouponScope$
|
|
737
|
-
/** Namespace of the coupon scope. */
|
|
390
|
+
interface CouponScope$3 {
|
|
738
391
|
namespace?: string;
|
|
739
|
-
|
|
740
|
-
group?: Group$2;
|
|
392
|
+
group?: Group$3;
|
|
741
393
|
}
|
|
742
|
-
interface Group$
|
|
743
|
-
/** Name of the group. */
|
|
394
|
+
interface Group$3 {
|
|
744
395
|
name?: string;
|
|
745
|
-
/** Entity ID of the group. */
|
|
746
396
|
entityId?: string | null;
|
|
747
397
|
}
|
|
748
|
-
interface LoyaltyPoints$
|
|
749
|
-
/** Amount of points to give. */
|
|
750
|
-
amount?: number;
|
|
751
|
-
}
|
|
752
|
-
declare enum Action {
|
|
753
|
-
/** Unknown action. */
|
|
754
|
-
UNKNOWN = "UNKNOWN",
|
|
755
|
-
/** Store order placed. */
|
|
756
|
-
STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
|
|
757
|
-
/** Pricing plan ordered. */
|
|
758
|
-
PLAN_ORDERED = "PLAN_ORDERED",
|
|
759
|
-
/** Wix events ticket ordered. */
|
|
760
|
-
TICKET_ORDERED = "TICKET_ORDERED",
|
|
761
|
-
/** Bookings session booked. */
|
|
762
|
-
SESSION_BOOKED = "SESSION_BOOKED",
|
|
763
|
-
/** Restaurant order placed. */
|
|
764
|
-
RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
|
|
765
|
-
}
|
|
766
|
-
interface Emails {
|
|
767
|
-
/** Encourage customers to refer their friends email. Select for which apps to enable. */
|
|
768
|
-
encourageToReferFriends?: App[];
|
|
769
|
-
/** Notify customers about their referral reward email. Set true to enable email. */
|
|
770
|
-
notifyCustomersAboutReward?: boolean;
|
|
771
|
-
}
|
|
772
|
-
declare enum App {
|
|
773
|
-
/** Unknown app. */
|
|
774
|
-
UNKNOWN = "UNKNOWN",
|
|
775
|
-
/** Wix stores. */
|
|
776
|
-
STORES = "STORES",
|
|
777
|
-
/** Wix pricing plans. */
|
|
778
|
-
PRICING_PLANS = "PRICING_PLANS",
|
|
779
|
-
/** Wix events. */
|
|
780
|
-
EVENTS = "EVENTS",
|
|
781
|
-
/** Wix bookings. */
|
|
782
|
-
BOOKINGS = "BOOKINGS",
|
|
783
|
-
/** Wix restaurants. */
|
|
784
|
-
RESTAURANTS = "RESTAURANTS"
|
|
785
|
-
}
|
|
786
|
-
interface GetReferralProgramRequest {
|
|
787
|
-
}
|
|
788
|
-
interface GetReferralProgramResponse {
|
|
789
|
-
/** The retrieved ReferralProgram. */
|
|
790
|
-
referralProgram?: ReferralProgram;
|
|
791
|
-
}
|
|
792
|
-
interface QueryReferralProgramsRequest {
|
|
793
|
-
/** Query to filter ReferralPrograms. */
|
|
794
|
-
query: CursorQuery$6;
|
|
795
|
-
}
|
|
796
|
-
interface CursorQuery$6 extends CursorQueryPagingMethodOneOf$6 {
|
|
797
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
798
|
-
cursorPaging?: CursorPaging$6;
|
|
799
|
-
/**
|
|
800
|
-
* Filter object in the following format:
|
|
801
|
-
* `"filter" : {
|
|
802
|
-
* "fieldName1": "value1",
|
|
803
|
-
* "fieldName2":{"$operator":"value2"}
|
|
804
|
-
* }`
|
|
805
|
-
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
806
|
-
*/
|
|
807
|
-
filter?: Record<string, any> | null;
|
|
808
|
-
/**
|
|
809
|
-
* Sort object in the following format:
|
|
810
|
-
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
811
|
-
*/
|
|
812
|
-
sort?: Sorting$6[];
|
|
813
|
-
}
|
|
814
|
-
/** @oneof */
|
|
815
|
-
interface CursorQueryPagingMethodOneOf$6 {
|
|
816
|
-
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
817
|
-
cursorPaging?: CursorPaging$6;
|
|
818
|
-
}
|
|
819
|
-
interface Sorting$6 {
|
|
820
|
-
/** Name of the field to sort by. */
|
|
821
|
-
fieldName?: string;
|
|
822
|
-
/** Sort order. */
|
|
823
|
-
order?: SortOrder$6;
|
|
824
|
-
}
|
|
825
|
-
declare enum SortOrder$6 {
|
|
826
|
-
ASC = "ASC",
|
|
827
|
-
DESC = "DESC"
|
|
828
|
-
}
|
|
829
|
-
interface CursorPaging$6 {
|
|
830
|
-
/** Maximum number of items to return in the results. */
|
|
831
|
-
limit?: number | null;
|
|
832
|
-
/**
|
|
833
|
-
* Pointer to the next or previous page in the list of results.
|
|
834
|
-
*
|
|
835
|
-
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
836
|
-
* Not relevant for the first request.
|
|
837
|
-
*/
|
|
838
|
-
cursor?: string | null;
|
|
839
|
-
}
|
|
840
|
-
interface QueryReferralProgramsResponse {
|
|
841
|
-
/** ReferralPrograms that match the query. */
|
|
842
|
-
referralPrograms?: ReferralProgram[];
|
|
843
|
-
/** Paging metadata. */
|
|
844
|
-
pagingMetadata?: CursorPagingMetadata$6;
|
|
845
|
-
}
|
|
846
|
-
interface CursorPagingMetadata$6 {
|
|
847
|
-
/** Number of items returned in the response. */
|
|
848
|
-
count?: number | null;
|
|
849
|
-
/** Cursor strings that point to the next page, previous page, or both. */
|
|
850
|
-
cursors?: Cursors$6;
|
|
398
|
+
interface LoyaltyPoints$1 {
|
|
851
399
|
/**
|
|
852
|
-
*
|
|
853
|
-
*
|
|
854
|
-
* + `true`: Another page of results can be retrieved.
|
|
855
|
-
* + `false`: This is the last page.
|
|
400
|
+
* Loyalty transaction ID.
|
|
401
|
+
* @readonly
|
|
856
402
|
*/
|
|
857
|
-
|
|
858
|
-
}
|
|
859
|
-
interface Cursors$6 {
|
|
860
|
-
/** Cursor string pointing to the next page in the list of results. */
|
|
861
|
-
next?: string | null;
|
|
862
|
-
/** Cursor pointing to the previous page in the list of results. */
|
|
863
|
-
prev?: string | null;
|
|
864
|
-
}
|
|
865
|
-
interface UpdateReferralProgramRequest {
|
|
866
|
-
/** ReferralProgram to be updated, may be partial. */
|
|
867
|
-
referralProgram: ReferralProgram;
|
|
868
|
-
}
|
|
869
|
-
interface UpdateReferralProgramResponse {
|
|
870
|
-
/** The updated ReferralProgram. */
|
|
871
|
-
referralProgram?: ReferralProgram;
|
|
872
|
-
}
|
|
873
|
-
interface ActivateReferralProgramRequest {
|
|
874
|
-
}
|
|
875
|
-
interface ActivateReferralProgramResponse {
|
|
876
|
-
/** The activated ReferralProgram. */
|
|
877
|
-
referralProgram?: ReferralProgram;
|
|
878
|
-
}
|
|
879
|
-
interface PauseReferralProgramRequest {
|
|
880
|
-
}
|
|
881
|
-
interface PauseReferralProgramResponse {
|
|
882
|
-
/** The paused ReferralProgram. */
|
|
883
|
-
referralProgram?: ReferralProgram;
|
|
884
|
-
}
|
|
885
|
-
interface GetAISocialMediaPostsSuggestionsRequest {
|
|
886
|
-
/** The topic to generate suggestions for. */
|
|
887
|
-
topic?: string;
|
|
888
|
-
}
|
|
889
|
-
interface GetAISocialMediaPostsSuggestionsResponse {
|
|
890
|
-
/** The generated suggestions. */
|
|
891
|
-
suggestions?: AISocialMediaPostSuggestion[];
|
|
892
|
-
/** The refer friends page URL. */
|
|
893
|
-
referFriendsPageUrl?: string | null;
|
|
894
|
-
}
|
|
895
|
-
interface AISocialMediaPostSuggestion {
|
|
896
|
-
/** The suggested post content. */
|
|
897
|
-
postContent?: string;
|
|
898
|
-
/** The suggested hashtags. */
|
|
899
|
-
hashtags?: string[];
|
|
900
|
-
}
|
|
901
|
-
interface GenerateAISocialMediaPostsSuggestionsRequest {
|
|
902
|
-
/** The topic to generate suggestions for. */
|
|
903
|
-
topic?: string;
|
|
904
|
-
}
|
|
905
|
-
interface GenerateAISocialMediaPostsSuggestionsResponse {
|
|
906
|
-
/** The generated suggestions. */
|
|
907
|
-
suggestions?: AISocialMediaPostSuggestion[];
|
|
908
|
-
/** The refer friends page URL. */
|
|
909
|
-
referFriendsPageUrl?: string | null;
|
|
910
|
-
}
|
|
911
|
-
interface GetReferralProgramPremiumFeaturesRequest {
|
|
912
|
-
}
|
|
913
|
-
interface GetReferralProgramPremiumFeaturesResponse {
|
|
403
|
+
transactionId?: string;
|
|
914
404
|
/**
|
|
915
|
-
*
|
|
405
|
+
* Loyalty points amount given.
|
|
916
406
|
* @readonly
|
|
917
407
|
*/
|
|
918
|
-
|
|
408
|
+
amount?: number;
|
|
919
409
|
}
|
|
920
|
-
interface
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
couponOptions?: {
|
|
925
|
-
fixedAmountOptions?: {
|
|
926
|
-
amount: number;
|
|
927
|
-
};
|
|
928
|
-
percentageOptions?: {
|
|
929
|
-
percentage: number;
|
|
930
|
-
};
|
|
931
|
-
minimumSubtotal: number;
|
|
932
|
-
scope?: {
|
|
933
|
-
namespace: string;
|
|
934
|
-
group?: {
|
|
935
|
-
name: string;
|
|
936
|
-
};
|
|
937
|
-
};
|
|
938
|
-
name: string;
|
|
939
|
-
discountType: DiscountType$2;
|
|
940
|
-
};
|
|
941
|
-
loyaltyPointsOptions?: {
|
|
942
|
-
amount: number;
|
|
943
|
-
};
|
|
944
|
-
type: Type;
|
|
410
|
+
interface GetReferralEventResponseNonNullableFields$1 {
|
|
411
|
+
referralEvent?: {
|
|
412
|
+
referredFriendSignupEvent?: {
|
|
413
|
+
referredFriendId: string;
|
|
945
414
|
};
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
namespace: string;
|
|
957
|
-
group?: {
|
|
958
|
-
name: string;
|
|
959
|
-
};
|
|
960
|
-
};
|
|
961
|
-
name: string;
|
|
962
|
-
discountType: DiscountType$2;
|
|
963
|
-
};
|
|
964
|
-
loyaltyPointsOptions?: {
|
|
965
|
-
amount: number;
|
|
415
|
+
successfulReferralEvent?: {
|
|
416
|
+
referredFriendId: string;
|
|
417
|
+
referringCustomerId: string;
|
|
418
|
+
};
|
|
419
|
+
actionEvent?: {
|
|
420
|
+
referredFriendId: string;
|
|
421
|
+
referringCustomerId: string;
|
|
422
|
+
trigger?: {
|
|
423
|
+
appId: string;
|
|
424
|
+
activityType: string;
|
|
966
425
|
};
|
|
967
|
-
type: Type;
|
|
968
426
|
};
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
427
|
+
rewardEvent?: {
|
|
428
|
+
rewardedReferringCustomerId: string;
|
|
429
|
+
rewardedReferredFriendId: string;
|
|
430
|
+
referralRewardId: string;
|
|
431
|
+
rewardType: Reward$1;
|
|
974
432
|
};
|
|
975
433
|
};
|
|
976
434
|
}
|
|
977
|
-
interface
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
couponOptions?: {
|
|
982
|
-
fixedAmountOptions?: {
|
|
983
|
-
amount: number;
|
|
984
|
-
};
|
|
985
|
-
percentageOptions?: {
|
|
986
|
-
percentage: number;
|
|
987
|
-
};
|
|
988
|
-
minimumSubtotal: number;
|
|
989
|
-
scope?: {
|
|
990
|
-
namespace: string;
|
|
991
|
-
group?: {
|
|
992
|
-
name: string;
|
|
993
|
-
};
|
|
994
|
-
};
|
|
995
|
-
name: string;
|
|
996
|
-
discountType: DiscountType$2;
|
|
997
|
-
};
|
|
998
|
-
loyaltyPointsOptions?: {
|
|
999
|
-
amount: number;
|
|
1000
|
-
};
|
|
1001
|
-
type: Type;
|
|
435
|
+
interface QueryReferralEventResponseNonNullableFields$1 {
|
|
436
|
+
referralEvents: {
|
|
437
|
+
referredFriendSignupEvent?: {
|
|
438
|
+
referredFriendId: string;
|
|
1002
439
|
};
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
namespace: string;
|
|
1014
|
-
group?: {
|
|
1015
|
-
name: string;
|
|
1016
|
-
};
|
|
1017
|
-
};
|
|
1018
|
-
name: string;
|
|
1019
|
-
discountType: DiscountType$2;
|
|
1020
|
-
};
|
|
1021
|
-
loyaltyPointsOptions?: {
|
|
1022
|
-
amount: number;
|
|
440
|
+
successfulReferralEvent?: {
|
|
441
|
+
referredFriendId: string;
|
|
442
|
+
referringCustomerId: string;
|
|
443
|
+
};
|
|
444
|
+
actionEvent?: {
|
|
445
|
+
referredFriendId: string;
|
|
446
|
+
referringCustomerId: string;
|
|
447
|
+
trigger?: {
|
|
448
|
+
appId: string;
|
|
449
|
+
activityType: string;
|
|
1023
450
|
};
|
|
1024
|
-
type: Type;
|
|
1025
451
|
};
|
|
1026
|
-
|
|
1027
|
-
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
452
|
+
rewardEvent?: {
|
|
453
|
+
rewardedReferringCustomerId: string;
|
|
454
|
+
rewardedReferredFriendId: string;
|
|
455
|
+
referralRewardId: string;
|
|
456
|
+
rewardType: Reward$1;
|
|
1031
457
|
};
|
|
1032
458
|
}[];
|
|
1033
459
|
}
|
|
1034
|
-
interface
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
couponOptions?: {
|
|
1039
|
-
fixedAmountOptions?: {
|
|
1040
|
-
amount: number;
|
|
1041
|
-
};
|
|
1042
|
-
percentageOptions?: {
|
|
1043
|
-
percentage: number;
|
|
1044
|
-
};
|
|
1045
|
-
minimumSubtotal: number;
|
|
1046
|
-
scope?: {
|
|
1047
|
-
namespace: string;
|
|
1048
|
-
group?: {
|
|
1049
|
-
name: string;
|
|
1050
|
-
};
|
|
1051
|
-
};
|
|
1052
|
-
name: string;
|
|
1053
|
-
discountType: DiscountType$2;
|
|
1054
|
-
};
|
|
1055
|
-
loyaltyPointsOptions?: {
|
|
1056
|
-
amount: number;
|
|
1057
|
-
};
|
|
1058
|
-
type: Type;
|
|
1059
|
-
};
|
|
1060
|
-
referringCustomerReward?: {
|
|
1061
|
-
couponOptions?: {
|
|
1062
|
-
fixedAmountOptions?: {
|
|
1063
|
-
amount: number;
|
|
1064
|
-
};
|
|
1065
|
-
percentageOptions?: {
|
|
1066
|
-
percentage: number;
|
|
1067
|
-
};
|
|
1068
|
-
minimumSubtotal: number;
|
|
1069
|
-
scope?: {
|
|
1070
|
-
namespace: string;
|
|
1071
|
-
group?: {
|
|
1072
|
-
name: string;
|
|
1073
|
-
};
|
|
1074
|
-
};
|
|
1075
|
-
name: string;
|
|
1076
|
-
discountType: DiscountType$2;
|
|
1077
|
-
};
|
|
1078
|
-
loyaltyPointsOptions?: {
|
|
1079
|
-
amount: number;
|
|
1080
|
-
};
|
|
1081
|
-
type: Type;
|
|
1082
|
-
};
|
|
1083
|
-
successfulReferralActions: Action[];
|
|
1084
|
-
isPremium: boolean;
|
|
1085
|
-
emails?: {
|
|
1086
|
-
encourageToReferFriends: App[];
|
|
1087
|
-
notifyCustomersAboutReward: boolean;
|
|
1088
|
-
};
|
|
1089
|
-
};
|
|
460
|
+
interface GetReferralStatisticsResponseNonNullableFields$1 {
|
|
461
|
+
totalSignUpsCompleted: number;
|
|
462
|
+
totalActionsCompleted: number;
|
|
463
|
+
totalAmountGenerated: string;
|
|
1090
464
|
}
|
|
1091
|
-
interface
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
percentageOptions?: {
|
|
1100
|
-
percentage: number;
|
|
1101
|
-
};
|
|
1102
|
-
minimumSubtotal: number;
|
|
1103
|
-
scope?: {
|
|
1104
|
-
namespace: string;
|
|
1105
|
-
group?: {
|
|
1106
|
-
name: string;
|
|
1107
|
-
};
|
|
1108
|
-
};
|
|
1109
|
-
name: string;
|
|
1110
|
-
discountType: DiscountType$2;
|
|
1111
|
-
};
|
|
1112
|
-
loyaltyPointsOptions?: {
|
|
1113
|
-
amount: number;
|
|
1114
|
-
};
|
|
1115
|
-
type: Type;
|
|
1116
|
-
};
|
|
1117
|
-
referringCustomerReward?: {
|
|
1118
|
-
couponOptions?: {
|
|
1119
|
-
fixedAmountOptions?: {
|
|
1120
|
-
amount: number;
|
|
1121
|
-
};
|
|
1122
|
-
percentageOptions?: {
|
|
1123
|
-
percentage: number;
|
|
1124
|
-
};
|
|
1125
|
-
minimumSubtotal: number;
|
|
1126
|
-
scope?: {
|
|
1127
|
-
namespace: string;
|
|
1128
|
-
group?: {
|
|
1129
|
-
name: string;
|
|
1130
|
-
};
|
|
1131
|
-
};
|
|
1132
|
-
name: string;
|
|
1133
|
-
discountType: DiscountType$2;
|
|
1134
|
-
};
|
|
1135
|
-
loyaltyPointsOptions?: {
|
|
1136
|
-
amount: number;
|
|
1137
|
-
};
|
|
1138
|
-
type: Type;
|
|
1139
|
-
};
|
|
1140
|
-
successfulReferralActions: Action[];
|
|
1141
|
-
isPremium: boolean;
|
|
1142
|
-
emails?: {
|
|
1143
|
-
encourageToReferFriends: App[];
|
|
1144
|
-
notifyCustomersAboutReward: boolean;
|
|
1145
|
-
};
|
|
1146
|
-
};
|
|
465
|
+
interface QueryReferringCustomerTotalsResponseNonNullableFields$1 {
|
|
466
|
+
referringCustomerTotals: {
|
|
467
|
+
referringCustomerId: string;
|
|
468
|
+
contactId: string;
|
|
469
|
+
totalSuccessfulReferrals: number;
|
|
470
|
+
totalAmountGenerated: string;
|
|
471
|
+
totalFriendsWithActions: number;
|
|
472
|
+
}[];
|
|
1147
473
|
}
|
|
1148
|
-
interface
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
};
|
|
1156
|
-
percentageOptions?: {
|
|
1157
|
-
percentage: number;
|
|
1158
|
-
};
|
|
1159
|
-
minimumSubtotal: number;
|
|
1160
|
-
scope?: {
|
|
1161
|
-
namespace: string;
|
|
1162
|
-
group?: {
|
|
1163
|
-
name: string;
|
|
1164
|
-
};
|
|
1165
|
-
};
|
|
1166
|
-
name: string;
|
|
1167
|
-
discountType: DiscountType$2;
|
|
1168
|
-
};
|
|
1169
|
-
loyaltyPointsOptions?: {
|
|
1170
|
-
amount: number;
|
|
1171
|
-
};
|
|
1172
|
-
type: Type;
|
|
1173
|
-
};
|
|
1174
|
-
referringCustomerReward?: {
|
|
1175
|
-
couponOptions?: {
|
|
474
|
+
interface QueryReferredFriendActionsResponseNonNullableFields$1 {
|
|
475
|
+
referredFriendActions: {
|
|
476
|
+
coupon?: {
|
|
477
|
+
id: string;
|
|
478
|
+
code: string;
|
|
479
|
+
status: Status$5;
|
|
480
|
+
couponSpecification?: {
|
|
1176
481
|
fixedAmountOptions?: {
|
|
1177
482
|
amount: number;
|
|
1178
483
|
};
|
|
@@ -1187,124 +492,81 @@ interface PauseReferralProgramResponseNonNullableFields {
|
|
|
1187
492
|
};
|
|
1188
493
|
};
|
|
1189
494
|
name: string;
|
|
1190
|
-
discountType: DiscountType$
|
|
1191
|
-
};
|
|
1192
|
-
loyaltyPointsOptions?: {
|
|
1193
|
-
amount: number;
|
|
495
|
+
discountType: DiscountType$3;
|
|
1194
496
|
};
|
|
1195
|
-
type: Type;
|
|
1196
497
|
};
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
|
|
1200
|
-
encourageToReferFriends: App[];
|
|
1201
|
-
notifyCustomersAboutReward: boolean;
|
|
498
|
+
loyaltyPoints?: {
|
|
499
|
+
transactionId: string;
|
|
500
|
+
amount: number;
|
|
1202
501
|
};
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
|
|
1213
|
-
postContent: string;
|
|
1214
|
-
hashtags: string[];
|
|
1215
|
-
}[];
|
|
1216
|
-
}
|
|
1217
|
-
interface GetReferralProgramPremiumFeaturesResponseNonNullableFields {
|
|
1218
|
-
referralProgram: boolean;
|
|
1219
|
-
}
|
|
1220
|
-
|
|
1221
|
-
type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1222
|
-
getUrl: (context: any) => string;
|
|
1223
|
-
httpMethod: K;
|
|
1224
|
-
path: string;
|
|
1225
|
-
pathParams: M;
|
|
1226
|
-
__requestType: T;
|
|
1227
|
-
__originalRequestType: S;
|
|
1228
|
-
__responseType: Q;
|
|
1229
|
-
__originalResponseType: R;
|
|
1230
|
-
};
|
|
1231
|
-
declare function getReferralProgram(): __PublicMethodMetaInfo$3<'GET', {}, GetReferralProgramRequest, GetReferralProgramRequest$1, GetReferralProgramResponse & GetReferralProgramResponseNonNullableFields, GetReferralProgramResponse$1 & GetReferralProgramResponseNonNullableFields$1>;
|
|
1232
|
-
declare function queryReferralPrograms(): __PublicMethodMetaInfo$3<'POST', {}, QueryReferralProgramsRequest, QueryReferralProgramsRequest$1, QueryReferralProgramsResponse & QueryReferralProgramsResponseNonNullableFields, QueryReferralProgramsResponse$1 & QueryReferralProgramsResponseNonNullableFields$1>;
|
|
1233
|
-
declare function updateReferralProgram(): __PublicMethodMetaInfo$3<'PATCH', {}, UpdateReferralProgramRequest, UpdateReferralProgramRequest$1, UpdateReferralProgramResponse & UpdateReferralProgramResponseNonNullableFields, UpdateReferralProgramResponse$1 & UpdateReferralProgramResponseNonNullableFields$1>;
|
|
1234
|
-
declare function activateReferralProgram(): __PublicMethodMetaInfo$3<'PATCH', {}, ActivateReferralProgramRequest, ActivateReferralProgramRequest$1, ActivateReferralProgramResponse & ActivateReferralProgramResponseNonNullableFields, ActivateReferralProgramResponse$1 & ActivateReferralProgramResponseNonNullableFields$1>;
|
|
1235
|
-
declare function pauseReferralProgram(): __PublicMethodMetaInfo$3<'PATCH', {}, PauseReferralProgramRequest, PauseReferralProgramRequest$1, PauseReferralProgramResponse & PauseReferralProgramResponseNonNullableFields, PauseReferralProgramResponse$1 & PauseReferralProgramResponseNonNullableFields$1>;
|
|
1236
|
-
declare function getAiSocialMediaPostsSuggestions(): __PublicMethodMetaInfo$3<'GET', {}, GetAISocialMediaPostsSuggestionsRequest, GetAISocialMediaPostsSuggestionsRequest$1, GetAISocialMediaPostsSuggestionsResponse & GetAISocialMediaPostsSuggestionsResponseNonNullableFields, GetAISocialMediaPostsSuggestionsResponse$1 & GetAISocialMediaPostsSuggestionsResponseNonNullableFields$1>;
|
|
1237
|
-
declare function generateAiSocialMediaPostsSuggestions(): __PublicMethodMetaInfo$3<'POST', {}, GenerateAISocialMediaPostsSuggestionsRequest, GenerateAISocialMediaPostsSuggestionsRequest$1, GenerateAISocialMediaPostsSuggestionsResponse & GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields, GenerateAISocialMediaPostsSuggestionsResponse$1 & GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields$1>;
|
|
1238
|
-
declare function getReferralProgramPremiumFeatures(): __PublicMethodMetaInfo$3<'GET', {}, GetReferralProgramPremiumFeaturesRequest, GetReferralProgramPremiumFeaturesRequest$1, GetReferralProgramPremiumFeaturesResponse & GetReferralProgramPremiumFeaturesResponseNonNullableFields, GetReferralProgramPremiumFeaturesResponse$1 & GetReferralProgramPremiumFeaturesResponseNonNullableFields$1>;
|
|
1239
|
-
|
|
1240
|
-
declare const meta$3_activateReferralProgram: typeof activateReferralProgram;
|
|
1241
|
-
declare const meta$3_generateAiSocialMediaPostsSuggestions: typeof generateAiSocialMediaPostsSuggestions;
|
|
1242
|
-
declare const meta$3_getAiSocialMediaPostsSuggestions: typeof getAiSocialMediaPostsSuggestions;
|
|
1243
|
-
declare const meta$3_getReferralProgram: typeof getReferralProgram;
|
|
1244
|
-
declare const meta$3_getReferralProgramPremiumFeatures: typeof getReferralProgramPremiumFeatures;
|
|
1245
|
-
declare const meta$3_pauseReferralProgram: typeof pauseReferralProgram;
|
|
1246
|
-
declare const meta$3_queryReferralPrograms: typeof queryReferralPrograms;
|
|
1247
|
-
declare const meta$3_updateReferralProgram: typeof updateReferralProgram;
|
|
1248
|
-
declare namespace meta$3 {
|
|
1249
|
-
export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_activateReferralProgram as activateReferralProgram, meta$3_generateAiSocialMediaPostsSuggestions as generateAiSocialMediaPostsSuggestions, meta$3_getAiSocialMediaPostsSuggestions as getAiSocialMediaPostsSuggestions, meta$3_getReferralProgram as getReferralProgram, meta$3_getReferralProgramPremiumFeatures as getReferralProgramPremiumFeatures, meta$3_pauseReferralProgram as pauseReferralProgram, meta$3_queryReferralPrograms as queryReferralPrograms, meta$3_updateReferralProgram as updateReferralProgram };
|
|
502
|
+
referredFriendId: string;
|
|
503
|
+
contactId: string;
|
|
504
|
+
trigger?: {
|
|
505
|
+
appId: string;
|
|
506
|
+
activityType: string;
|
|
507
|
+
};
|
|
508
|
+
rewardType: Reward$1;
|
|
509
|
+
totalActions: number;
|
|
510
|
+
totalAmountSpent: string;
|
|
511
|
+
}[];
|
|
1250
512
|
}
|
|
1251
513
|
|
|
1252
514
|
/** ReferralEvent. */
|
|
1253
|
-
interface ReferralEvent
|
|
515
|
+
interface ReferralEvent extends ReferralEventEventTypeOneOf {
|
|
1254
516
|
/** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
|
|
1255
|
-
referredFriendSignupEvent?: ReferredFriendSignupEvent
|
|
517
|
+
referredFriendSignupEvent?: ReferredFriendSignupEvent;
|
|
1256
518
|
/** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
|
|
1257
|
-
successfulReferralEvent?: V1SuccessfulReferralEvent
|
|
519
|
+
successfulReferralEvent?: V1SuccessfulReferralEvent;
|
|
1258
520
|
/** ActionEvent is an event that is triggered when an action is performed. */
|
|
1259
|
-
actionEvent?: V1ActionEvent
|
|
521
|
+
actionEvent?: V1ActionEvent;
|
|
1260
522
|
/** RewardEvent is an event that is triggered when a reward is given. */
|
|
1261
|
-
rewardEvent?: RewardEvent
|
|
523
|
+
rewardEvent?: RewardEvent;
|
|
1262
524
|
/**
|
|
1263
525
|
* ReferralEvent ID.
|
|
1264
526
|
* @readonly
|
|
1265
527
|
*/
|
|
1266
|
-
|
|
528
|
+
_id?: string | null;
|
|
1267
529
|
/** 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. */
|
|
1268
530
|
revision?: string | null;
|
|
1269
531
|
/**
|
|
1270
532
|
* Represents the time this ReferralEvent was created.
|
|
1271
533
|
* @readonly
|
|
1272
534
|
*/
|
|
1273
|
-
|
|
535
|
+
_createdDate?: Date;
|
|
1274
536
|
/**
|
|
1275
537
|
* Represents the time this ReferralEvent was last updated.
|
|
1276
538
|
* @readonly
|
|
1277
539
|
*/
|
|
1278
|
-
|
|
540
|
+
_updatedDate?: Date;
|
|
1279
541
|
}
|
|
1280
542
|
/** @oneof */
|
|
1281
|
-
interface ReferralEventEventTypeOneOf
|
|
543
|
+
interface ReferralEventEventTypeOneOf {
|
|
1282
544
|
/** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
|
|
1283
|
-
referredFriendSignupEvent?: ReferredFriendSignupEvent
|
|
545
|
+
referredFriendSignupEvent?: ReferredFriendSignupEvent;
|
|
1284
546
|
/** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
|
|
1285
|
-
successfulReferralEvent?: V1SuccessfulReferralEvent
|
|
547
|
+
successfulReferralEvent?: V1SuccessfulReferralEvent;
|
|
1286
548
|
/** ActionEvent is an event that is triggered when an action is performed. */
|
|
1287
|
-
actionEvent?: V1ActionEvent
|
|
549
|
+
actionEvent?: V1ActionEvent;
|
|
1288
550
|
/** RewardEvent is an event that is triggered when a reward is given. */
|
|
1289
|
-
rewardEvent?: RewardEvent
|
|
551
|
+
rewardEvent?: RewardEvent;
|
|
1290
552
|
}
|
|
1291
|
-
interface ReferredFriendSignupEvent
|
|
553
|
+
interface ReferredFriendSignupEvent {
|
|
1292
554
|
/** The referred friend ID. */
|
|
1293
555
|
referredFriendId?: string;
|
|
1294
556
|
}
|
|
1295
|
-
interface V1SuccessfulReferralEvent
|
|
557
|
+
interface V1SuccessfulReferralEvent {
|
|
1296
558
|
/** The referred friend ID. */
|
|
1297
559
|
referredFriendId?: string;
|
|
1298
560
|
/** The referring customer ID. */
|
|
1299
561
|
referringCustomerId?: string;
|
|
1300
562
|
}
|
|
1301
|
-
interface V1ActionEvent
|
|
563
|
+
interface V1ActionEvent {
|
|
1302
564
|
/** The referred friend ID. */
|
|
1303
565
|
referredFriendId?: string;
|
|
1304
566
|
/** The referring customer ID. */
|
|
1305
567
|
referringCustomerId?: string;
|
|
1306
568
|
/** The trigger of the action. */
|
|
1307
|
-
trigger?: V1Trigger
|
|
569
|
+
trigger?: V1Trigger;
|
|
1308
570
|
/** Amount. */
|
|
1309
571
|
amount?: string | null;
|
|
1310
572
|
/** Currency. */
|
|
@@ -1312,13 +574,13 @@ interface V1ActionEvent$1 {
|
|
|
1312
574
|
/** Order ID. */
|
|
1313
575
|
orderId?: string | null;
|
|
1314
576
|
}
|
|
1315
|
-
interface V1Trigger
|
|
577
|
+
interface V1Trigger {
|
|
1316
578
|
/** The app id of the app that triggered the event. */
|
|
1317
579
|
appId?: string;
|
|
1318
580
|
/** The activity type that triggered the event. */
|
|
1319
581
|
activityType?: string;
|
|
1320
582
|
}
|
|
1321
|
-
interface RewardEvent
|
|
583
|
+
interface RewardEvent extends RewardEventReceiverOneOf {
|
|
1322
584
|
/**
|
|
1323
585
|
* The referring customer ID.
|
|
1324
586
|
* @readonly
|
|
@@ -1332,10 +594,10 @@ interface RewardEvent$1 extends RewardEventReceiverOneOf$1 {
|
|
|
1332
594
|
/** The referral reward ID. */
|
|
1333
595
|
referralRewardId?: string;
|
|
1334
596
|
/** The reward type. */
|
|
1335
|
-
rewardType?: Reward
|
|
597
|
+
rewardType?: Reward;
|
|
1336
598
|
}
|
|
1337
599
|
/** @oneof */
|
|
1338
|
-
interface RewardEventReceiverOneOf
|
|
600
|
+
interface RewardEventReceiverOneOf {
|
|
1339
601
|
/**
|
|
1340
602
|
* The referring customer ID.
|
|
1341
603
|
* @readonly
|
|
@@ -1347,7 +609,7 @@ interface RewardEventReceiverOneOf$1 {
|
|
|
1347
609
|
*/
|
|
1348
610
|
rewardedReferredFriendId?: string;
|
|
1349
611
|
}
|
|
1350
|
-
declare enum Reward
|
|
612
|
+
declare enum Reward {
|
|
1351
613
|
/** Unknown reward type. */
|
|
1352
614
|
UNKNOWN = "UNKNOWN",
|
|
1353
615
|
/** Reward is a coupon. */
|
|
@@ -1357,21 +619,21 @@ declare enum Reward$1 {
|
|
|
1357
619
|
/** No reward. */
|
|
1358
620
|
NOTHING = "NOTHING"
|
|
1359
621
|
}
|
|
1360
|
-
interface GetReferralEventRequest
|
|
622
|
+
interface GetReferralEventRequest {
|
|
1361
623
|
/** Id of the ReferralEvent to retrieve */
|
|
1362
624
|
referralEventId: string;
|
|
1363
625
|
}
|
|
1364
|
-
interface GetReferralEventResponse
|
|
626
|
+
interface GetReferralEventResponse {
|
|
1365
627
|
/** The retrieved ReferralEvent */
|
|
1366
|
-
referralEvent?: ReferralEvent
|
|
628
|
+
referralEvent?: ReferralEvent;
|
|
1367
629
|
}
|
|
1368
|
-
interface QueryReferralEventRequest
|
|
630
|
+
interface QueryReferralEventRequest {
|
|
1369
631
|
/** Query to filter ReferralEvents. */
|
|
1370
|
-
query: CursorQuery$
|
|
632
|
+
query: CursorQuery$6;
|
|
1371
633
|
}
|
|
1372
|
-
interface CursorQuery$
|
|
634
|
+
interface CursorQuery$6 extends CursorQueryPagingMethodOneOf$6 {
|
|
1373
635
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1374
|
-
cursorPaging?: CursorPaging$
|
|
636
|
+
cursorPaging?: CursorPaging$6;
|
|
1375
637
|
/**
|
|
1376
638
|
* Filter object in the following format:
|
|
1377
639
|
* `"filter" : {
|
|
@@ -1385,24 +647,24 @@ interface CursorQuery$5 extends CursorQueryPagingMethodOneOf$5 {
|
|
|
1385
647
|
* Sort object in the following format:
|
|
1386
648
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1387
649
|
*/
|
|
1388
|
-
sort?: Sorting$
|
|
650
|
+
sort?: Sorting$6[];
|
|
1389
651
|
}
|
|
1390
652
|
/** @oneof */
|
|
1391
|
-
interface CursorQueryPagingMethodOneOf$
|
|
653
|
+
interface CursorQueryPagingMethodOneOf$6 {
|
|
1392
654
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1393
|
-
cursorPaging?: CursorPaging$
|
|
655
|
+
cursorPaging?: CursorPaging$6;
|
|
1394
656
|
}
|
|
1395
|
-
interface Sorting$
|
|
657
|
+
interface Sorting$6 {
|
|
1396
658
|
/** Name of the field to sort by. */
|
|
1397
659
|
fieldName?: string;
|
|
1398
660
|
/** Sort order. */
|
|
1399
|
-
order?: SortOrder$
|
|
661
|
+
order?: SortOrder$6;
|
|
1400
662
|
}
|
|
1401
|
-
declare enum SortOrder$
|
|
663
|
+
declare enum SortOrder$6 {
|
|
1402
664
|
ASC = "ASC",
|
|
1403
665
|
DESC = "DESC"
|
|
1404
666
|
}
|
|
1405
|
-
interface CursorPaging$
|
|
667
|
+
interface CursorPaging$6 {
|
|
1406
668
|
/** Maximum number of items to return in the results. */
|
|
1407
669
|
limit?: number | null;
|
|
1408
670
|
/**
|
|
@@ -1413,17 +675,17 @@ interface CursorPaging$5 {
|
|
|
1413
675
|
*/
|
|
1414
676
|
cursor?: string | null;
|
|
1415
677
|
}
|
|
1416
|
-
interface QueryReferralEventResponse
|
|
678
|
+
interface QueryReferralEventResponse {
|
|
1417
679
|
/** List of ReferralEvents that match the query. */
|
|
1418
|
-
referralEvents?: ReferralEvent
|
|
680
|
+
referralEvents?: ReferralEvent[];
|
|
1419
681
|
/** Paging metadata. */
|
|
1420
|
-
metadata?: CursorPagingMetadata$
|
|
682
|
+
metadata?: CursorPagingMetadata$6;
|
|
1421
683
|
}
|
|
1422
|
-
interface CursorPagingMetadata$
|
|
684
|
+
interface CursorPagingMetadata$6 {
|
|
1423
685
|
/** Number of items returned in the response. */
|
|
1424
686
|
count?: number | null;
|
|
1425
687
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
1426
|
-
cursors?: Cursors$
|
|
688
|
+
cursors?: Cursors$6;
|
|
1427
689
|
/**
|
|
1428
690
|
* Whether there are more pages to retrieve following the current page.
|
|
1429
691
|
*
|
|
@@ -1432,15 +694,15 @@ interface CursorPagingMetadata$5 {
|
|
|
1432
694
|
*/
|
|
1433
695
|
hasNext?: boolean | null;
|
|
1434
696
|
}
|
|
1435
|
-
interface Cursors$
|
|
697
|
+
interface Cursors$6 {
|
|
1436
698
|
/** Cursor string pointing to the next page in the list of results. */
|
|
1437
699
|
next?: string | null;
|
|
1438
700
|
/** Cursor pointing to the previous page in the list of results. */
|
|
1439
701
|
prev?: string | null;
|
|
1440
702
|
}
|
|
1441
|
-
interface GetReferralStatisticsRequest
|
|
703
|
+
interface GetReferralStatisticsRequest {
|
|
1442
704
|
}
|
|
1443
|
-
interface GetReferralStatisticsResponse
|
|
705
|
+
interface GetReferralStatisticsResponse {
|
|
1444
706
|
/** Total sign ups completed by referred friends */
|
|
1445
707
|
totalSignUpsCompleted?: number;
|
|
1446
708
|
/** Total actions completed by referred friends */
|
|
@@ -1448,19 +710,19 @@ interface GetReferralStatisticsResponse$1 {
|
|
|
1448
710
|
/** Total amount of purchases made by referred friends */
|
|
1449
711
|
totalAmountGenerated?: string;
|
|
1450
712
|
}
|
|
1451
|
-
interface QueryReferringCustomerTotalsRequest
|
|
713
|
+
interface QueryReferringCustomerTotalsRequest {
|
|
1452
714
|
/** Query to filter ReferringCustomerTotals. */
|
|
1453
|
-
query?: CursorQuery$
|
|
715
|
+
query?: CursorQuery$6;
|
|
1454
716
|
/** List of contact ids to filter ReferringCustomerTotals. */
|
|
1455
717
|
contactIds?: string[];
|
|
1456
718
|
}
|
|
1457
|
-
interface QueryReferringCustomerTotalsResponse
|
|
719
|
+
interface QueryReferringCustomerTotalsResponse {
|
|
1458
720
|
/** List of ReferringCustomerTotals that match the query. */
|
|
1459
|
-
referringCustomerTotals?: ReferringCustomerTotal
|
|
721
|
+
referringCustomerTotals?: ReferringCustomerTotal[];
|
|
1460
722
|
/** Paging metadata. */
|
|
1461
|
-
metadata?: CursorPagingMetadata$
|
|
723
|
+
metadata?: CursorPagingMetadata$6;
|
|
1462
724
|
}
|
|
1463
|
-
interface ReferringCustomerTotal
|
|
725
|
+
interface ReferringCustomerTotal {
|
|
1464
726
|
/**
|
|
1465
727
|
* Referring customer id.
|
|
1466
728
|
* @readonly
|
|
@@ -1497,23 +759,23 @@ interface ReferringCustomerTotal$1 {
|
|
|
1497
759
|
*/
|
|
1498
760
|
totalFriendsWithActions?: number;
|
|
1499
761
|
}
|
|
1500
|
-
interface QueryReferredFriendActionsRequest
|
|
762
|
+
interface QueryReferredFriendActionsRequest {
|
|
1501
763
|
/** Query to filter ReferredFriendActions. */
|
|
1502
|
-
query?: CursorQuery$
|
|
764
|
+
query?: CursorQuery$6;
|
|
1503
765
|
/** List of contact ids to filter ReferredFriendActions. */
|
|
1504
766
|
contactIds?: string[];
|
|
1505
767
|
}
|
|
1506
|
-
interface QueryReferredFriendActionsResponse
|
|
768
|
+
interface QueryReferredFriendActionsResponse {
|
|
1507
769
|
/** List of ReferredFriendActions that match the query. */
|
|
1508
|
-
referredFriendActions?: ReferredFriendAction
|
|
770
|
+
referredFriendActions?: ReferredFriendAction[];
|
|
1509
771
|
/** Paging metadata. */
|
|
1510
|
-
metadata?: CursorPagingMetadata$
|
|
772
|
+
metadata?: CursorPagingMetadata$6;
|
|
1511
773
|
}
|
|
1512
|
-
interface ReferredFriendAction
|
|
774
|
+
interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneOf {
|
|
1513
775
|
/** Coupon reward type options. */
|
|
1514
|
-
coupon?: V1Coupon$
|
|
776
|
+
coupon?: V1Coupon$2;
|
|
1515
777
|
/** Loyalty points reward type options. */
|
|
1516
|
-
loyaltyPoints?: LoyaltyPoints
|
|
778
|
+
loyaltyPoints?: LoyaltyPoints;
|
|
1517
779
|
/**
|
|
1518
780
|
* Referred friend id.
|
|
1519
781
|
* @readonly
|
|
@@ -1528,14 +790,14 @@ interface ReferredFriendAction$1 extends ReferredFriendActionRewardTypeOptionsOn
|
|
|
1528
790
|
* First action trigger.
|
|
1529
791
|
* @readonly
|
|
1530
792
|
*/
|
|
1531
|
-
trigger?: V1Trigger
|
|
793
|
+
trigger?: V1Trigger;
|
|
1532
794
|
/**
|
|
1533
795
|
* First action date.
|
|
1534
796
|
* @readonly
|
|
1535
797
|
*/
|
|
1536
798
|
actionDate?: Date;
|
|
1537
799
|
/** Issued reward type. */
|
|
1538
|
-
rewardType?: Reward
|
|
800
|
+
rewardType?: Reward;
|
|
1539
801
|
/** Total number of actions. */
|
|
1540
802
|
totalActions?: number;
|
|
1541
803
|
/**
|
|
@@ -1550,18 +812,18 @@ interface ReferredFriendAction$1 extends ReferredFriendActionRewardTypeOptionsOn
|
|
|
1550
812
|
signupDate?: Date;
|
|
1551
813
|
}
|
|
1552
814
|
/** @oneof */
|
|
1553
|
-
interface ReferredFriendActionRewardTypeOptionsOneOf
|
|
815
|
+
interface ReferredFriendActionRewardTypeOptionsOneOf {
|
|
1554
816
|
/** Coupon reward type options. */
|
|
1555
|
-
coupon?: V1Coupon$
|
|
817
|
+
coupon?: V1Coupon$2;
|
|
1556
818
|
/** Loyalty points reward type options. */
|
|
1557
|
-
loyaltyPoints?: LoyaltyPoints
|
|
819
|
+
loyaltyPoints?: LoyaltyPoints;
|
|
1558
820
|
}
|
|
1559
|
-
interface V1Coupon$
|
|
821
|
+
interface V1Coupon$2 {
|
|
1560
822
|
/**
|
|
1561
823
|
* Coupon ID.
|
|
1562
824
|
* @readonly
|
|
1563
825
|
*/
|
|
1564
|
-
|
|
826
|
+
_id?: string;
|
|
1565
827
|
/**
|
|
1566
828
|
* Coupon code.
|
|
1567
829
|
* @readonly
|
|
@@ -1571,14 +833,14 @@ interface V1Coupon$1 {
|
|
|
1571
833
|
* Coupon status.
|
|
1572
834
|
* @readonly
|
|
1573
835
|
*/
|
|
1574
|
-
status?: Status$
|
|
836
|
+
status?: Status$4;
|
|
1575
837
|
/**
|
|
1576
838
|
* Coupon specification.
|
|
1577
839
|
* @readonly
|
|
1578
840
|
*/
|
|
1579
|
-
couponSpecification?: Coupon$
|
|
841
|
+
couponSpecification?: Coupon$2;
|
|
1580
842
|
}
|
|
1581
|
-
declare enum Status$
|
|
843
|
+
declare enum Status$4 {
|
|
1582
844
|
/** Unknown coupon status. */
|
|
1583
845
|
UNKNOWN = "UNKNOWN",
|
|
1584
846
|
/** Coupon is active and can be applied. */
|
|
@@ -1588,19 +850,19 @@ declare enum Status$3 {
|
|
|
1588
850
|
/** Coupon was deleted. */
|
|
1589
851
|
DELETED = "DELETED"
|
|
1590
852
|
}
|
|
1591
|
-
interface Coupon$
|
|
1592
|
-
/** Options for fixed amount discount type
|
|
1593
|
-
fixedAmountOptions?: FixedAmountDiscount$
|
|
1594
|
-
/** Options for percentage discount type
|
|
1595
|
-
percentageOptions?: PercentageDiscount$
|
|
853
|
+
interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSubtotalOneOf$2 {
|
|
854
|
+
/** Options for fixed amount discount type */
|
|
855
|
+
fixedAmountOptions?: FixedAmountDiscount$2;
|
|
856
|
+
/** Options for percentage discount type */
|
|
857
|
+
percentageOptions?: PercentageDiscount$2;
|
|
1596
858
|
/** Limit the coupon to carts with a subtotal above this number. */
|
|
1597
859
|
minimumSubtotal?: number;
|
|
1598
860
|
/** Specifies the type of line items this coupon will apply to. */
|
|
1599
|
-
scope?: CouponScope$
|
|
1600
|
-
/** Coupon name
|
|
861
|
+
scope?: CouponScope$2;
|
|
862
|
+
/** Coupon name */
|
|
1601
863
|
name?: string;
|
|
1602
|
-
/** Coupon discount type
|
|
1603
|
-
discountType?: DiscountType$
|
|
864
|
+
/** Coupon discount type */
|
|
865
|
+
discountType?: DiscountType$2;
|
|
1604
866
|
/** Limit the coupon to only apply to one item in cart. */
|
|
1605
867
|
limitedToOneItem?: boolean | null;
|
|
1606
868
|
/** If true, coupon also applies to subscriptions. */
|
|
@@ -1609,50 +871,44 @@ interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSub
|
|
|
1609
871
|
discountedCycleCount?: number | null;
|
|
1610
872
|
}
|
|
1611
873
|
/** @oneof */
|
|
1612
|
-
interface CouponDiscountTypeOptionsOneOf$
|
|
1613
|
-
/** Options for fixed amount discount type
|
|
1614
|
-
fixedAmountOptions?: FixedAmountDiscount$
|
|
1615
|
-
/** Options for percentage discount type
|
|
1616
|
-
percentageOptions?: PercentageDiscount$
|
|
874
|
+
interface CouponDiscountTypeOptionsOneOf$2 {
|
|
875
|
+
/** Options for fixed amount discount type */
|
|
876
|
+
fixedAmountOptions?: FixedAmountDiscount$2;
|
|
877
|
+
/** Options for percentage discount type */
|
|
878
|
+
percentageOptions?: PercentageDiscount$2;
|
|
1617
879
|
}
|
|
1618
880
|
/** @oneof */
|
|
1619
|
-
interface CouponScopeOrMinSubtotalOneOf$
|
|
881
|
+
interface CouponScopeOrMinSubtotalOneOf$2 {
|
|
1620
882
|
/** Limit the coupon to carts with a subtotal above this number. */
|
|
1621
883
|
minimumSubtotal?: number;
|
|
1622
884
|
/** Specifies the type of line items this coupon will apply to. */
|
|
1623
|
-
scope?: CouponScope$
|
|
885
|
+
scope?: CouponScope$2;
|
|
1624
886
|
}
|
|
1625
|
-
declare enum DiscountType$
|
|
1626
|
-
/** Unknown discount type. */
|
|
887
|
+
declare enum DiscountType$2 {
|
|
1627
888
|
UNKNOWN = "UNKNOWN",
|
|
1628
|
-
/** Discount as a fixed amount
|
|
889
|
+
/** Discount as a fixed amount */
|
|
1629
890
|
FIXED_AMOUNT = "FIXED_AMOUNT",
|
|
1630
|
-
/** Discount as a percentage
|
|
891
|
+
/** Discount as a percentage */
|
|
1631
892
|
PERCENTAGE = "PERCENTAGE",
|
|
1632
|
-
/** Free shipping
|
|
893
|
+
/** Free shipping */
|
|
1633
894
|
FREE_SHIPPING = "FREE_SHIPPING"
|
|
1634
895
|
}
|
|
1635
|
-
interface FixedAmountDiscount$
|
|
1636
|
-
/** Fixed amount to discount
|
|
896
|
+
interface FixedAmountDiscount$2 {
|
|
897
|
+
/** Fixed amount to discount */
|
|
1637
898
|
amount?: number;
|
|
1638
899
|
}
|
|
1639
|
-
interface PercentageDiscount$
|
|
1640
|
-
/** Percentage to discount. */
|
|
900
|
+
interface PercentageDiscount$2 {
|
|
1641
901
|
percentage?: number;
|
|
1642
902
|
}
|
|
1643
|
-
interface CouponScope$
|
|
1644
|
-
/** Namespace of the coupon scope. */
|
|
903
|
+
interface CouponScope$2 {
|
|
1645
904
|
namespace?: string;
|
|
1646
|
-
|
|
1647
|
-
group?: Group$1;
|
|
905
|
+
group?: Group$2;
|
|
1648
906
|
}
|
|
1649
|
-
interface Group$
|
|
1650
|
-
/** Name of the group. */
|
|
907
|
+
interface Group$2 {
|
|
1651
908
|
name?: string;
|
|
1652
|
-
/** Entity ID of the group. */
|
|
1653
909
|
entityId?: string | null;
|
|
1654
910
|
}
|
|
1655
|
-
interface LoyaltyPoints
|
|
911
|
+
interface LoyaltyPoints {
|
|
1656
912
|
/**
|
|
1657
913
|
* Loyalty transaction ID.
|
|
1658
914
|
* @readonly
|
|
@@ -1664,7 +920,7 @@ interface LoyaltyPoints$1 {
|
|
|
1664
920
|
*/
|
|
1665
921
|
amount?: number;
|
|
1666
922
|
}
|
|
1667
|
-
interface GetReferralEventResponseNonNullableFields
|
|
923
|
+
interface GetReferralEventResponseNonNullableFields {
|
|
1668
924
|
referralEvent?: {
|
|
1669
925
|
referredFriendSignupEvent?: {
|
|
1670
926
|
referredFriendId: string;
|
|
@@ -1685,11 +941,11 @@ interface GetReferralEventResponseNonNullableFields$1 {
|
|
|
1685
941
|
rewardedReferringCustomerId: string;
|
|
1686
942
|
rewardedReferredFriendId: string;
|
|
1687
943
|
referralRewardId: string;
|
|
1688
|
-
rewardType: Reward
|
|
944
|
+
rewardType: Reward;
|
|
1689
945
|
};
|
|
1690
946
|
};
|
|
1691
947
|
}
|
|
1692
|
-
interface QueryReferralEventResponseNonNullableFields
|
|
948
|
+
interface QueryReferralEventResponseNonNullableFields {
|
|
1693
949
|
referralEvents: {
|
|
1694
950
|
referredFriendSignupEvent?: {
|
|
1695
951
|
referredFriendId: string;
|
|
@@ -1710,16 +966,16 @@ interface QueryReferralEventResponseNonNullableFields$1 {
|
|
|
1710
966
|
rewardedReferringCustomerId: string;
|
|
1711
967
|
rewardedReferredFriendId: string;
|
|
1712
968
|
referralRewardId: string;
|
|
1713
|
-
rewardType: Reward
|
|
969
|
+
rewardType: Reward;
|
|
1714
970
|
};
|
|
1715
971
|
}[];
|
|
1716
972
|
}
|
|
1717
|
-
interface GetReferralStatisticsResponseNonNullableFields
|
|
973
|
+
interface GetReferralStatisticsResponseNonNullableFields {
|
|
1718
974
|
totalSignUpsCompleted: number;
|
|
1719
975
|
totalActionsCompleted: number;
|
|
1720
976
|
totalAmountGenerated: string;
|
|
1721
977
|
}
|
|
1722
|
-
interface QueryReferringCustomerTotalsResponseNonNullableFields
|
|
978
|
+
interface QueryReferringCustomerTotalsResponseNonNullableFields {
|
|
1723
979
|
referringCustomerTotals: {
|
|
1724
980
|
referringCustomerId: string;
|
|
1725
981
|
contactId: string;
|
|
@@ -1728,12 +984,12 @@ interface QueryReferringCustomerTotalsResponseNonNullableFields$1 {
|
|
|
1728
984
|
totalFriendsWithActions: number;
|
|
1729
985
|
}[];
|
|
1730
986
|
}
|
|
1731
|
-
interface QueryReferredFriendActionsResponseNonNullableFields
|
|
987
|
+
interface QueryReferredFriendActionsResponseNonNullableFields {
|
|
1732
988
|
referredFriendActions: {
|
|
1733
989
|
coupon?: {
|
|
1734
|
-
|
|
990
|
+
_id: string;
|
|
1735
991
|
code: string;
|
|
1736
|
-
status: Status$
|
|
992
|
+
status: Status$4;
|
|
1737
993
|
couponSpecification?: {
|
|
1738
994
|
fixedAmountOptions?: {
|
|
1739
995
|
amount: number;
|
|
@@ -1749,7 +1005,7 @@ interface QueryReferredFriendActionsResponseNonNullableFields$1 {
|
|
|
1749
1005
|
};
|
|
1750
1006
|
};
|
|
1751
1007
|
name: string;
|
|
1752
|
-
discountType: DiscountType$
|
|
1008
|
+
discountType: DiscountType$2;
|
|
1753
1009
|
};
|
|
1754
1010
|
};
|
|
1755
1011
|
loyaltyPoints?: {
|
|
@@ -1762,135 +1018,224 @@ interface QueryReferredFriendActionsResponseNonNullableFields$1 {
|
|
|
1762
1018
|
appId: string;
|
|
1763
1019
|
activityType: string;
|
|
1764
1020
|
};
|
|
1765
|
-
rewardType: Reward
|
|
1766
|
-
totalActions: number;
|
|
1767
|
-
totalAmountSpent: string;
|
|
1768
|
-
}[];
|
|
1769
|
-
}
|
|
1770
|
-
|
|
1771
|
-
/** ReferralEvent. */
|
|
1772
|
-
interface ReferralEvent extends ReferralEventEventTypeOneOf {
|
|
1773
|
-
/** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
|
|
1774
|
-
referredFriendSignupEvent?: ReferredFriendSignupEvent;
|
|
1775
|
-
/** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
|
|
1776
|
-
successfulReferralEvent?: V1SuccessfulReferralEvent;
|
|
1777
|
-
/** ActionEvent is an event that is triggered when an action is performed. */
|
|
1778
|
-
actionEvent?: V1ActionEvent;
|
|
1779
|
-
/** RewardEvent is an event that is triggered when a reward is given. */
|
|
1780
|
-
rewardEvent?: RewardEvent;
|
|
1781
|
-
/**
|
|
1782
|
-
* ReferralEvent ID.
|
|
1783
|
-
* @readonly
|
|
1784
|
-
*/
|
|
1785
|
-
_id?: string | null;
|
|
1786
|
-
/** 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. */
|
|
1787
|
-
revision?: string | null;
|
|
1788
|
-
/**
|
|
1789
|
-
* Represents the time this ReferralEvent was created.
|
|
1790
|
-
* @readonly
|
|
1791
|
-
*/
|
|
1792
|
-
_createdDate?: Date;
|
|
1793
|
-
/**
|
|
1794
|
-
* Represents the time this ReferralEvent was last updated.
|
|
1795
|
-
* @readonly
|
|
1796
|
-
*/
|
|
1797
|
-
_updatedDate?: Date;
|
|
1798
|
-
}
|
|
1799
|
-
/** @oneof */
|
|
1800
|
-
interface ReferralEventEventTypeOneOf {
|
|
1801
|
-
/** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
|
|
1802
|
-
referredFriendSignupEvent?: ReferredFriendSignupEvent;
|
|
1803
|
-
/** SuccessfulReferralEvent is an event that is triggered when a referral is successful. */
|
|
1804
|
-
successfulReferralEvent?: V1SuccessfulReferralEvent;
|
|
1805
|
-
/** ActionEvent is an event that is triggered when an action is performed. */
|
|
1806
|
-
actionEvent?: V1ActionEvent;
|
|
1807
|
-
/** RewardEvent is an event that is triggered when a reward is given. */
|
|
1808
|
-
rewardEvent?: RewardEvent;
|
|
1809
|
-
}
|
|
1810
|
-
interface ReferredFriendSignupEvent {
|
|
1811
|
-
/** The referred friend ID. */
|
|
1812
|
-
referredFriendId?: string;
|
|
1813
|
-
}
|
|
1814
|
-
interface V1SuccessfulReferralEvent {
|
|
1815
|
-
/** The referred friend ID. */
|
|
1816
|
-
referredFriendId?: string;
|
|
1817
|
-
/** The referring customer ID. */
|
|
1818
|
-
referringCustomerId?: string;
|
|
1819
|
-
}
|
|
1820
|
-
interface V1ActionEvent {
|
|
1821
|
-
/** The referred friend ID. */
|
|
1822
|
-
referredFriendId?: string;
|
|
1823
|
-
/** The referring customer ID. */
|
|
1824
|
-
referringCustomerId?: string;
|
|
1825
|
-
/** The trigger of the action. */
|
|
1826
|
-
trigger?: V1Trigger;
|
|
1827
|
-
/** Amount. */
|
|
1828
|
-
amount?: string | null;
|
|
1829
|
-
/** Currency. */
|
|
1830
|
-
currency?: string | null;
|
|
1831
|
-
/** Order ID. */
|
|
1832
|
-
orderId?: string | null;
|
|
1833
|
-
}
|
|
1834
|
-
interface V1Trigger {
|
|
1835
|
-
/** The app id of the app that triggered the event. */
|
|
1836
|
-
appId?: string;
|
|
1837
|
-
/** The activity type that triggered the event. */
|
|
1838
|
-
activityType?: string;
|
|
1021
|
+
rewardType: Reward;
|
|
1022
|
+
totalActions: number;
|
|
1023
|
+
totalAmountSpent: string;
|
|
1024
|
+
}[];
|
|
1839
1025
|
}
|
|
1840
|
-
|
|
1026
|
+
|
|
1027
|
+
type __PublicMethodMetaInfo$3<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
1028
|
+
getUrl: (context: any) => string;
|
|
1029
|
+
httpMethod: K;
|
|
1030
|
+
path: string;
|
|
1031
|
+
pathParams: M;
|
|
1032
|
+
__requestType: T;
|
|
1033
|
+
__originalRequestType: S;
|
|
1034
|
+
__responseType: Q;
|
|
1035
|
+
__originalResponseType: R;
|
|
1036
|
+
};
|
|
1037
|
+
declare function getReferralEvent(): __PublicMethodMetaInfo$3<'GET', {
|
|
1038
|
+
referralEventId: string;
|
|
1039
|
+
}, GetReferralEventRequest, GetReferralEventRequest$1, GetReferralEventResponse & GetReferralEventResponseNonNullableFields, GetReferralEventResponse$1 & GetReferralEventResponseNonNullableFields$1>;
|
|
1040
|
+
declare function queryReferralEvent(): __PublicMethodMetaInfo$3<'POST', {}, QueryReferralEventRequest, QueryReferralEventRequest$1, QueryReferralEventResponse & QueryReferralEventResponseNonNullableFields, QueryReferralEventResponse$1 & QueryReferralEventResponseNonNullableFields$1>;
|
|
1041
|
+
declare function getReferralStatistics(): __PublicMethodMetaInfo$3<'GET', {}, GetReferralStatisticsRequest, GetReferralStatisticsRequest$1, GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields, GetReferralStatisticsResponse$1 & GetReferralStatisticsResponseNonNullableFields$1>;
|
|
1042
|
+
declare function queryReferringCustomerTotals(): __PublicMethodMetaInfo$3<'POST', {}, QueryReferringCustomerTotalsRequest, QueryReferringCustomerTotalsRequest$1, QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields, QueryReferringCustomerTotalsResponse$1 & QueryReferringCustomerTotalsResponseNonNullableFields$1>;
|
|
1043
|
+
declare function queryReferredFriendActions(): __PublicMethodMetaInfo$3<'POST', {}, QueryReferredFriendActionsRequest, QueryReferredFriendActionsRequest$1, QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields, QueryReferredFriendActionsResponse$1 & QueryReferredFriendActionsResponseNonNullableFields$1>;
|
|
1044
|
+
|
|
1045
|
+
declare const meta$3_getReferralEvent: typeof getReferralEvent;
|
|
1046
|
+
declare const meta$3_getReferralStatistics: typeof getReferralStatistics;
|
|
1047
|
+
declare const meta$3_queryReferralEvent: typeof queryReferralEvent;
|
|
1048
|
+
declare const meta$3_queryReferredFriendActions: typeof queryReferredFriendActions;
|
|
1049
|
+
declare const meta$3_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
|
|
1050
|
+
declare namespace meta$3 {
|
|
1051
|
+
export { type __PublicMethodMetaInfo$3 as __PublicMethodMetaInfo, meta$3_getReferralEvent as getReferralEvent, meta$3_getReferralStatistics as getReferralStatistics, meta$3_queryReferralEvent as queryReferralEvent, meta$3_queryReferredFriendActions as queryReferredFriendActions, meta$3_queryReferringCustomerTotals as queryReferringCustomerTotals };
|
|
1052
|
+
}
|
|
1053
|
+
|
|
1054
|
+
/** ReferralReward is the main entity of ReferralRewards that can be used for lorem ipsum dolor */
|
|
1055
|
+
interface ReferralReward$1 extends ReferralRewardReceiverOneOf$1, ReferralRewardRewardTypeOptionsOneOf$1 {
|
|
1841
1056
|
/**
|
|
1842
|
-
*
|
|
1057
|
+
* Referring customer ID.
|
|
1843
1058
|
* @readonly
|
|
1844
1059
|
*/
|
|
1845
1060
|
rewardedReferringCustomerId?: string;
|
|
1846
1061
|
/**
|
|
1847
|
-
*
|
|
1062
|
+
* Referred friend ID.
|
|
1848
1063
|
* @readonly
|
|
1849
1064
|
*/
|
|
1850
1065
|
rewardedReferredFriendId?: string;
|
|
1851
|
-
/**
|
|
1852
|
-
|
|
1853
|
-
/**
|
|
1854
|
-
|
|
1066
|
+
/** Coupon reward type options. */
|
|
1067
|
+
coupon?: V1Coupon$1;
|
|
1068
|
+
/** Loyalty points reward type options. */
|
|
1069
|
+
loyaltyPoints?: V1LoyaltyPoints$1;
|
|
1070
|
+
/**
|
|
1071
|
+
* ReferralReward ID.
|
|
1072
|
+
* @readonly
|
|
1073
|
+
*/
|
|
1074
|
+
id?: string | null;
|
|
1075
|
+
/** 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. */
|
|
1076
|
+
revision?: string | null;
|
|
1077
|
+
/**
|
|
1078
|
+
* Represents the time this ReferralReward was created.
|
|
1079
|
+
* @readonly
|
|
1080
|
+
*/
|
|
1081
|
+
createdDate?: Date;
|
|
1082
|
+
/**
|
|
1083
|
+
* Represents the time this ReferralReward was last updated.
|
|
1084
|
+
* @readonly
|
|
1085
|
+
*/
|
|
1086
|
+
updatedDate?: Date;
|
|
1087
|
+
/** Reward type. */
|
|
1088
|
+
rewardType?: RewardTypeType$1;
|
|
1855
1089
|
}
|
|
1856
1090
|
/** @oneof */
|
|
1857
|
-
interface
|
|
1091
|
+
interface ReferralRewardReceiverOneOf$1 {
|
|
1858
1092
|
/**
|
|
1859
|
-
*
|
|
1093
|
+
* Referring customer ID.
|
|
1860
1094
|
* @readonly
|
|
1861
1095
|
*/
|
|
1862
1096
|
rewardedReferringCustomerId?: string;
|
|
1863
1097
|
/**
|
|
1864
|
-
*
|
|
1098
|
+
* Referred friend ID.
|
|
1865
1099
|
* @readonly
|
|
1866
1100
|
*/
|
|
1867
1101
|
rewardedReferredFriendId?: string;
|
|
1868
1102
|
}
|
|
1869
|
-
|
|
1103
|
+
/** @oneof */
|
|
1104
|
+
interface ReferralRewardRewardTypeOptionsOneOf$1 {
|
|
1105
|
+
/** Coupon reward type options. */
|
|
1106
|
+
coupon?: V1Coupon$1;
|
|
1107
|
+
/** Loyalty points reward type options. */
|
|
1108
|
+
loyaltyPoints?: V1LoyaltyPoints$1;
|
|
1109
|
+
}
|
|
1110
|
+
declare enum RewardTypeType$1 {
|
|
1870
1111
|
/** Unknown reward type. */
|
|
1871
1112
|
UNKNOWN = "UNKNOWN",
|
|
1872
|
-
/**
|
|
1113
|
+
/** Coupon reward type. */
|
|
1873
1114
|
COUPON = "COUPON",
|
|
1874
|
-
/**
|
|
1115
|
+
/** Loyalty points reward type. */
|
|
1875
1116
|
LOYALTY_POINTS = "LOYALTY_POINTS",
|
|
1876
1117
|
/** No reward. */
|
|
1877
1118
|
NOTHING = "NOTHING"
|
|
1878
1119
|
}
|
|
1879
|
-
interface
|
|
1880
|
-
/**
|
|
1881
|
-
|
|
1120
|
+
interface V1Coupon$1 {
|
|
1121
|
+
/**
|
|
1122
|
+
* Coupon ID.
|
|
1123
|
+
* @readonly
|
|
1124
|
+
*/
|
|
1125
|
+
id?: string;
|
|
1126
|
+
/**
|
|
1127
|
+
* Coupon code.
|
|
1128
|
+
* @readonly
|
|
1129
|
+
*/
|
|
1130
|
+
code?: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* Coupon status.
|
|
1133
|
+
* @readonly
|
|
1134
|
+
*/
|
|
1135
|
+
status?: Status$3;
|
|
1136
|
+
/**
|
|
1137
|
+
* Coupon specification.
|
|
1138
|
+
* @readonly
|
|
1139
|
+
*/
|
|
1140
|
+
couponSpecification?: Coupon$1;
|
|
1882
1141
|
}
|
|
1883
|
-
|
|
1884
|
-
/**
|
|
1885
|
-
|
|
1142
|
+
declare enum Status$3 {
|
|
1143
|
+
/** Unknown coupon status. */
|
|
1144
|
+
UNKNOWN = "UNKNOWN",
|
|
1145
|
+
/** Coupon is active and can be applied. */
|
|
1146
|
+
ACTIVE = "ACTIVE",
|
|
1147
|
+
/** Coupon was already applied and can not be used anymore. */
|
|
1148
|
+
APPLIED = "APPLIED",
|
|
1149
|
+
/** Coupon was deleted. */
|
|
1150
|
+
DELETED = "DELETED"
|
|
1886
1151
|
}
|
|
1887
|
-
interface
|
|
1888
|
-
/**
|
|
1889
|
-
|
|
1152
|
+
interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
|
|
1153
|
+
/** Options for fixed amount discount type */
|
|
1154
|
+
fixedAmountOptions?: FixedAmountDiscount$1;
|
|
1155
|
+
/** Options for percentage discount type */
|
|
1156
|
+
percentageOptions?: PercentageDiscount$1;
|
|
1157
|
+
/** Limit the coupon to carts with a subtotal above this number. */
|
|
1158
|
+
minimumSubtotal?: number;
|
|
1159
|
+
/** Specifies the type of line items this coupon will apply to. */
|
|
1160
|
+
scope?: CouponScope$1;
|
|
1161
|
+
/** Coupon name */
|
|
1162
|
+
name?: string;
|
|
1163
|
+
/** Coupon discount type */
|
|
1164
|
+
discountType?: DiscountType$1;
|
|
1165
|
+
/** Limit the coupon to only apply to one item in cart. */
|
|
1166
|
+
limitedToOneItem?: boolean | null;
|
|
1167
|
+
/** If true, coupon also applies to subscriptions. */
|
|
1168
|
+
appliesToSubscriptions?: boolean | null;
|
|
1169
|
+
/** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
|
|
1170
|
+
discountedCycleCount?: number | null;
|
|
1890
1171
|
}
|
|
1891
|
-
|
|
1172
|
+
/** @oneof */
|
|
1173
|
+
interface CouponDiscountTypeOptionsOneOf$1 {
|
|
1174
|
+
/** Options for fixed amount discount type */
|
|
1175
|
+
fixedAmountOptions?: FixedAmountDiscount$1;
|
|
1176
|
+
/** Options for percentage discount type */
|
|
1177
|
+
percentageOptions?: PercentageDiscount$1;
|
|
1178
|
+
}
|
|
1179
|
+
/** @oneof */
|
|
1180
|
+
interface CouponScopeOrMinSubtotalOneOf$1 {
|
|
1181
|
+
/** Limit the coupon to carts with a subtotal above this number. */
|
|
1182
|
+
minimumSubtotal?: number;
|
|
1183
|
+
/** Specifies the type of line items this coupon will apply to. */
|
|
1184
|
+
scope?: CouponScope$1;
|
|
1185
|
+
}
|
|
1186
|
+
declare enum DiscountType$1 {
|
|
1187
|
+
UNKNOWN = "UNKNOWN",
|
|
1188
|
+
/** Discount as a fixed amount */
|
|
1189
|
+
FIXED_AMOUNT = "FIXED_AMOUNT",
|
|
1190
|
+
/** Discount as a percentage */
|
|
1191
|
+
PERCENTAGE = "PERCENTAGE",
|
|
1192
|
+
/** Free shipping */
|
|
1193
|
+
FREE_SHIPPING = "FREE_SHIPPING"
|
|
1194
|
+
}
|
|
1195
|
+
interface FixedAmountDiscount$1 {
|
|
1196
|
+
/** Fixed amount to discount */
|
|
1197
|
+
amount?: number;
|
|
1198
|
+
}
|
|
1199
|
+
interface PercentageDiscount$1 {
|
|
1200
|
+
percentage?: number;
|
|
1201
|
+
}
|
|
1202
|
+
interface CouponScope$1 {
|
|
1203
|
+
namespace?: string;
|
|
1204
|
+
group?: Group$1;
|
|
1205
|
+
}
|
|
1206
|
+
interface Group$1 {
|
|
1207
|
+
name?: string;
|
|
1208
|
+
entityId?: string | null;
|
|
1209
|
+
}
|
|
1210
|
+
interface V1LoyaltyPoints$1 {
|
|
1211
|
+
/**
|
|
1212
|
+
* Loyalty transaction ID.
|
|
1213
|
+
* @readonly
|
|
1214
|
+
*/
|
|
1215
|
+
transactionId?: string;
|
|
1216
|
+
/**
|
|
1217
|
+
* Loyalty points amount given.
|
|
1218
|
+
* @readonly
|
|
1219
|
+
*/
|
|
1220
|
+
amount?: number;
|
|
1221
|
+
}
|
|
1222
|
+
interface GetReferralRewardRequest$1 {
|
|
1223
|
+
/** Id of the ReferralReward to retrieve. */
|
|
1224
|
+
id: string;
|
|
1225
|
+
}
|
|
1226
|
+
interface GetReferralRewardResponse$1 {
|
|
1227
|
+
/** The retrieved ReferralReward. */
|
|
1228
|
+
referralReward?: ReferralReward$1;
|
|
1229
|
+
}
|
|
1230
|
+
interface QueryReferralRewardsRequest$1 {
|
|
1231
|
+
/** Query to filter ReferralRewards. */
|
|
1232
|
+
query: CursorQuery$5;
|
|
1233
|
+
/** Filter by contact id or set to "me" for current identity's rewards. */
|
|
1234
|
+
contactId?: string | null;
|
|
1235
|
+
}
|
|
1236
|
+
interface CursorQuery$5 extends CursorQueryPagingMethodOneOf$5 {
|
|
1892
1237
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1893
|
-
cursorPaging?: CursorPaging$
|
|
1238
|
+
cursorPaging?: CursorPaging$5;
|
|
1894
1239
|
/**
|
|
1895
1240
|
* Filter object in the following format:
|
|
1896
1241
|
* `"filter" : {
|
|
@@ -1904,24 +1249,24 @@ interface CursorQuery$4 extends CursorQueryPagingMethodOneOf$4 {
|
|
|
1904
1249
|
* Sort object in the following format:
|
|
1905
1250
|
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1906
1251
|
*/
|
|
1907
|
-
sort?: Sorting$
|
|
1252
|
+
sort?: Sorting$5[];
|
|
1908
1253
|
}
|
|
1909
1254
|
/** @oneof */
|
|
1910
|
-
interface CursorQueryPagingMethodOneOf$
|
|
1255
|
+
interface CursorQueryPagingMethodOneOf$5 {
|
|
1911
1256
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1912
|
-
cursorPaging?: CursorPaging$
|
|
1257
|
+
cursorPaging?: CursorPaging$5;
|
|
1913
1258
|
}
|
|
1914
|
-
interface Sorting$
|
|
1259
|
+
interface Sorting$5 {
|
|
1915
1260
|
/** Name of the field to sort by. */
|
|
1916
1261
|
fieldName?: string;
|
|
1917
1262
|
/** Sort order. */
|
|
1918
|
-
order?: SortOrder$
|
|
1263
|
+
order?: SortOrder$5;
|
|
1919
1264
|
}
|
|
1920
|
-
declare enum SortOrder$
|
|
1265
|
+
declare enum SortOrder$5 {
|
|
1921
1266
|
ASC = "ASC",
|
|
1922
1267
|
DESC = "DESC"
|
|
1923
1268
|
}
|
|
1924
|
-
interface CursorPaging$
|
|
1269
|
+
interface CursorPaging$5 {
|
|
1925
1270
|
/** Maximum number of items to return in the results. */
|
|
1926
1271
|
limit?: number | null;
|
|
1927
1272
|
/**
|
|
@@ -1932,17 +1277,17 @@ interface CursorPaging$4 {
|
|
|
1932
1277
|
*/
|
|
1933
1278
|
cursor?: string | null;
|
|
1934
1279
|
}
|
|
1935
|
-
interface
|
|
1936
|
-
/**
|
|
1937
|
-
|
|
1938
|
-
/**
|
|
1939
|
-
metadata?: CursorPagingMetadata$
|
|
1280
|
+
interface QueryReferralRewardsResponse$1 {
|
|
1281
|
+
/** The retrieved ReferralRewards. */
|
|
1282
|
+
referralRewards?: ReferralReward$1[];
|
|
1283
|
+
/** Metadata for paging. */
|
|
1284
|
+
metadata?: CursorPagingMetadata$5;
|
|
1940
1285
|
}
|
|
1941
|
-
interface CursorPagingMetadata$
|
|
1286
|
+
interface CursorPagingMetadata$5 {
|
|
1942
1287
|
/** Number of items returned in the response. */
|
|
1943
1288
|
count?: number | null;
|
|
1944
1289
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
1945
|
-
cursors?: Cursors$
|
|
1290
|
+
cursors?: Cursors$5;
|
|
1946
1291
|
/**
|
|
1947
1292
|
* Whether there are more pages to retrieve following the current page.
|
|
1948
1293
|
*
|
|
@@ -1951,129 +1296,144 @@ interface CursorPagingMetadata$4 {
|
|
|
1951
1296
|
*/
|
|
1952
1297
|
hasNext?: boolean | null;
|
|
1953
1298
|
}
|
|
1954
|
-
interface Cursors$
|
|
1299
|
+
interface Cursors$5 {
|
|
1955
1300
|
/** Cursor string pointing to the next page in the list of results. */
|
|
1956
1301
|
next?: string | null;
|
|
1957
1302
|
/** Cursor pointing to the previous page in the list of results. */
|
|
1958
1303
|
prev?: string | null;
|
|
1959
1304
|
}
|
|
1960
|
-
interface
|
|
1961
|
-
|
|
1962
|
-
|
|
1963
|
-
|
|
1964
|
-
|
|
1965
|
-
|
|
1966
|
-
|
|
1967
|
-
|
|
1968
|
-
|
|
1969
|
-
|
|
1970
|
-
|
|
1971
|
-
|
|
1972
|
-
|
|
1973
|
-
|
|
1974
|
-
|
|
1305
|
+
interface GetReferralRewardResponseNonNullableFields$1 {
|
|
1306
|
+
referralReward?: {
|
|
1307
|
+
rewardedReferringCustomerId: string;
|
|
1308
|
+
rewardedReferredFriendId: string;
|
|
1309
|
+
coupon?: {
|
|
1310
|
+
id: string;
|
|
1311
|
+
code: string;
|
|
1312
|
+
status: Status$3;
|
|
1313
|
+
couponSpecification?: {
|
|
1314
|
+
fixedAmountOptions?: {
|
|
1315
|
+
amount: number;
|
|
1316
|
+
};
|
|
1317
|
+
percentageOptions?: {
|
|
1318
|
+
percentage: number;
|
|
1319
|
+
};
|
|
1320
|
+
minimumSubtotal: number;
|
|
1321
|
+
scope?: {
|
|
1322
|
+
namespace: string;
|
|
1323
|
+
group?: {
|
|
1324
|
+
name: string;
|
|
1325
|
+
};
|
|
1326
|
+
};
|
|
1327
|
+
name: string;
|
|
1328
|
+
discountType: DiscountType$1;
|
|
1329
|
+
};
|
|
1330
|
+
};
|
|
1331
|
+
loyaltyPoints?: {
|
|
1332
|
+
transactionId: string;
|
|
1333
|
+
amount: number;
|
|
1334
|
+
};
|
|
1335
|
+
rewardType: RewardTypeType$1;
|
|
1336
|
+
};
|
|
1975
1337
|
}
|
|
1976
|
-
interface
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
|
|
1338
|
+
interface QueryReferralRewardsResponseNonNullableFields$1 {
|
|
1339
|
+
referralRewards: {
|
|
1340
|
+
rewardedReferringCustomerId: string;
|
|
1341
|
+
rewardedReferredFriendId: string;
|
|
1342
|
+
coupon?: {
|
|
1343
|
+
id: string;
|
|
1344
|
+
code: string;
|
|
1345
|
+
status: Status$3;
|
|
1346
|
+
couponSpecification?: {
|
|
1347
|
+
fixedAmountOptions?: {
|
|
1348
|
+
amount: number;
|
|
1349
|
+
};
|
|
1350
|
+
percentageOptions?: {
|
|
1351
|
+
percentage: number;
|
|
1352
|
+
};
|
|
1353
|
+
minimumSubtotal: number;
|
|
1354
|
+
scope?: {
|
|
1355
|
+
namespace: string;
|
|
1356
|
+
group?: {
|
|
1357
|
+
name: string;
|
|
1358
|
+
};
|
|
1359
|
+
};
|
|
1360
|
+
name: string;
|
|
1361
|
+
discountType: DiscountType$1;
|
|
1362
|
+
};
|
|
1363
|
+
};
|
|
1364
|
+
loyaltyPoints?: {
|
|
1365
|
+
transactionId: string;
|
|
1366
|
+
amount: number;
|
|
1367
|
+
};
|
|
1368
|
+
rewardType: RewardTypeType$1;
|
|
1369
|
+
}[];
|
|
1981
1370
|
}
|
|
1982
|
-
|
|
1983
|
-
|
|
1984
|
-
|
|
1985
|
-
* @readonly
|
|
1986
|
-
*/
|
|
1987
|
-
referringCustomerId?: string;
|
|
1988
|
-
/**
|
|
1989
|
-
* Contact id.
|
|
1990
|
-
* @readonly
|
|
1991
|
-
*/
|
|
1992
|
-
contactId?: string;
|
|
1993
|
-
/**
|
|
1994
|
-
* Last successful referral date.
|
|
1995
|
-
* @readonly
|
|
1996
|
-
*/
|
|
1997
|
-
lastSuccessfulReferral?: Date;
|
|
1998
|
-
/**
|
|
1999
|
-
* Total successful referrals made by this customer.
|
|
2000
|
-
* @readonly
|
|
2001
|
-
*/
|
|
2002
|
-
totalSuccessfulReferrals?: number;
|
|
2003
|
-
/**
|
|
2004
|
-
* Total amount generated by friends referred by this customer.
|
|
2005
|
-
* @readonly
|
|
2006
|
-
*/
|
|
2007
|
-
totalAmountGenerated?: string;
|
|
1371
|
+
|
|
1372
|
+
/** ReferralReward is the main entity of ReferralRewards that can be used for lorem ipsum dolor */
|
|
1373
|
+
interface ReferralReward extends ReferralRewardReceiverOneOf, ReferralRewardRewardTypeOptionsOneOf {
|
|
2008
1374
|
/**
|
|
2009
|
-
*
|
|
1375
|
+
* Referring customer ID.
|
|
2010
1376
|
* @readonly
|
|
2011
1377
|
*/
|
|
2012
|
-
|
|
1378
|
+
rewardedReferringCustomerId?: string;
|
|
2013
1379
|
/**
|
|
2014
|
-
*
|
|
1380
|
+
* Referred friend ID.
|
|
2015
1381
|
* @readonly
|
|
2016
1382
|
*/
|
|
2017
|
-
|
|
2018
|
-
}
|
|
2019
|
-
interface QueryReferredFriendActionsRequest {
|
|
2020
|
-
/** Query to filter ReferredFriendActions. */
|
|
2021
|
-
query?: CursorQuery$4;
|
|
2022
|
-
/** List of contact ids to filter ReferredFriendActions. */
|
|
2023
|
-
contactIds?: string[];
|
|
2024
|
-
}
|
|
2025
|
-
interface QueryReferredFriendActionsResponse {
|
|
2026
|
-
/** List of ReferredFriendActions that match the query. */
|
|
2027
|
-
referredFriendActions?: ReferredFriendAction[];
|
|
2028
|
-
/** Paging metadata. */
|
|
2029
|
-
metadata?: CursorPagingMetadata$4;
|
|
2030
|
-
}
|
|
2031
|
-
interface ReferredFriendAction extends ReferredFriendActionRewardTypeOptionsOneOf {
|
|
1383
|
+
rewardedReferredFriendId?: string;
|
|
2032
1384
|
/** Coupon reward type options. */
|
|
2033
1385
|
coupon?: V1Coupon;
|
|
2034
1386
|
/** Loyalty points reward type options. */
|
|
2035
|
-
loyaltyPoints?:
|
|
2036
|
-
/**
|
|
2037
|
-
* Referred friend id.
|
|
2038
|
-
* @readonly
|
|
2039
|
-
*/
|
|
2040
|
-
referredFriendId?: string;
|
|
1387
|
+
loyaltyPoints?: V1LoyaltyPoints;
|
|
2041
1388
|
/**
|
|
2042
|
-
*
|
|
1389
|
+
* ReferralReward ID.
|
|
2043
1390
|
* @readonly
|
|
2044
1391
|
*/
|
|
2045
|
-
|
|
1392
|
+
_id?: string | null;
|
|
1393
|
+
/** 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. */
|
|
1394
|
+
revision?: string | null;
|
|
2046
1395
|
/**
|
|
2047
|
-
*
|
|
1396
|
+
* Represents the time this ReferralReward was created.
|
|
2048
1397
|
* @readonly
|
|
2049
1398
|
*/
|
|
2050
|
-
|
|
1399
|
+
_createdDate?: Date;
|
|
2051
1400
|
/**
|
|
2052
|
-
*
|
|
1401
|
+
* Represents the time this ReferralReward was last updated.
|
|
2053
1402
|
* @readonly
|
|
2054
1403
|
*/
|
|
2055
|
-
|
|
2056
|
-
/**
|
|
2057
|
-
rewardType?:
|
|
2058
|
-
|
|
2059
|
-
|
|
1404
|
+
_updatedDate?: Date;
|
|
1405
|
+
/** Reward type. */
|
|
1406
|
+
rewardType?: RewardTypeType;
|
|
1407
|
+
}
|
|
1408
|
+
/** @oneof */
|
|
1409
|
+
interface ReferralRewardReceiverOneOf {
|
|
2060
1410
|
/**
|
|
2061
|
-
*
|
|
1411
|
+
* Referring customer ID.
|
|
2062
1412
|
* @readonly
|
|
2063
1413
|
*/
|
|
2064
|
-
|
|
1414
|
+
rewardedReferringCustomerId?: string;
|
|
2065
1415
|
/**
|
|
2066
|
-
* friend
|
|
1416
|
+
* Referred friend ID.
|
|
2067
1417
|
* @readonly
|
|
2068
1418
|
*/
|
|
2069
|
-
|
|
1419
|
+
rewardedReferredFriendId?: string;
|
|
2070
1420
|
}
|
|
2071
1421
|
/** @oneof */
|
|
2072
|
-
interface
|
|
1422
|
+
interface ReferralRewardRewardTypeOptionsOneOf {
|
|
2073
1423
|
/** Coupon reward type options. */
|
|
2074
1424
|
coupon?: V1Coupon;
|
|
2075
1425
|
/** Loyalty points reward type options. */
|
|
2076
|
-
loyaltyPoints?:
|
|
1426
|
+
loyaltyPoints?: V1LoyaltyPoints;
|
|
1427
|
+
}
|
|
1428
|
+
declare enum RewardTypeType {
|
|
1429
|
+
/** Unknown reward type. */
|
|
1430
|
+
UNKNOWN = "UNKNOWN",
|
|
1431
|
+
/** Coupon reward type. */
|
|
1432
|
+
COUPON = "COUPON",
|
|
1433
|
+
/** Loyalty points reward type. */
|
|
1434
|
+
LOYALTY_POINTS = "LOYALTY_POINTS",
|
|
1435
|
+
/** No reward. */
|
|
1436
|
+
NOTHING = "NOTHING"
|
|
2077
1437
|
}
|
|
2078
1438
|
interface V1Coupon {
|
|
2079
1439
|
/**
|
|
@@ -2108,17 +1468,17 @@ declare enum Status$2 {
|
|
|
2108
1468
|
DELETED = "DELETED"
|
|
2109
1469
|
}
|
|
2110
1470
|
interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
|
|
2111
|
-
/** Options for fixed amount discount type
|
|
1471
|
+
/** Options for fixed amount discount type */
|
|
2112
1472
|
fixedAmountOptions?: FixedAmountDiscount;
|
|
2113
|
-
/** Options for percentage discount type
|
|
1473
|
+
/** Options for percentage discount type */
|
|
2114
1474
|
percentageOptions?: PercentageDiscount;
|
|
2115
1475
|
/** Limit the coupon to carts with a subtotal above this number. */
|
|
2116
1476
|
minimumSubtotal?: number;
|
|
2117
1477
|
/** Specifies the type of line items this coupon will apply to. */
|
|
2118
1478
|
scope?: CouponScope;
|
|
2119
|
-
/** Coupon name
|
|
1479
|
+
/** Coupon name */
|
|
2120
1480
|
name?: string;
|
|
2121
|
-
/** Coupon discount type
|
|
1481
|
+
/** Coupon discount type */
|
|
2122
1482
|
discountType?: DiscountType;
|
|
2123
1483
|
/** Limit the coupon to only apply to one item in cart. */
|
|
2124
1484
|
limitedToOneItem?: boolean | null;
|
|
@@ -2129,9 +1489,9 @@ interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtota
|
|
|
2129
1489
|
}
|
|
2130
1490
|
/** @oneof */
|
|
2131
1491
|
interface CouponDiscountTypeOptionsOneOf {
|
|
2132
|
-
/** Options for fixed amount discount type
|
|
1492
|
+
/** Options for fixed amount discount type */
|
|
2133
1493
|
fixedAmountOptions?: FixedAmountDiscount;
|
|
2134
|
-
/** Options for percentage discount type
|
|
1494
|
+
/** Options for percentage discount type */
|
|
2135
1495
|
percentageOptions?: PercentageDiscount;
|
|
2136
1496
|
}
|
|
2137
1497
|
/** @oneof */
|
|
@@ -2142,36 +1502,30 @@ interface CouponScopeOrMinSubtotalOneOf {
|
|
|
2142
1502
|
scope?: CouponScope;
|
|
2143
1503
|
}
|
|
2144
1504
|
declare enum DiscountType {
|
|
2145
|
-
/** Unknown discount type. */
|
|
2146
1505
|
UNKNOWN = "UNKNOWN",
|
|
2147
|
-
/** Discount as a fixed amount
|
|
1506
|
+
/** Discount as a fixed amount */
|
|
2148
1507
|
FIXED_AMOUNT = "FIXED_AMOUNT",
|
|
2149
|
-
/** Discount as a percentage
|
|
1508
|
+
/** Discount as a percentage */
|
|
2150
1509
|
PERCENTAGE = "PERCENTAGE",
|
|
2151
|
-
/** Free shipping
|
|
1510
|
+
/** Free shipping */
|
|
2152
1511
|
FREE_SHIPPING = "FREE_SHIPPING"
|
|
2153
1512
|
}
|
|
2154
1513
|
interface FixedAmountDiscount {
|
|
2155
|
-
/** Fixed amount to discount
|
|
1514
|
+
/** Fixed amount to discount */
|
|
2156
1515
|
amount?: number;
|
|
2157
1516
|
}
|
|
2158
1517
|
interface PercentageDiscount {
|
|
2159
|
-
/** Percentage to discount. */
|
|
2160
1518
|
percentage?: number;
|
|
2161
1519
|
}
|
|
2162
1520
|
interface CouponScope {
|
|
2163
|
-
/** Namespace of the coupon scope. */
|
|
2164
1521
|
namespace?: string;
|
|
2165
|
-
/** Group of the coupon scope. */
|
|
2166
1522
|
group?: Group;
|
|
2167
1523
|
}
|
|
2168
1524
|
interface Group {
|
|
2169
|
-
/** Name of the group. */
|
|
2170
1525
|
name?: string;
|
|
2171
|
-
/** Entity ID of the group. */
|
|
2172
1526
|
entityId?: string | null;
|
|
2173
1527
|
}
|
|
2174
|
-
interface
|
|
1528
|
+
interface V1LoyaltyPoints {
|
|
2175
1529
|
/**
|
|
2176
1530
|
* Loyalty transaction ID.
|
|
2177
1531
|
* @readonly
|
|
@@ -2183,72 +1537,93 @@ interface LoyaltyPoints {
|
|
|
2183
1537
|
*/
|
|
2184
1538
|
amount?: number;
|
|
2185
1539
|
}
|
|
2186
|
-
interface
|
|
2187
|
-
|
|
2188
|
-
|
|
2189
|
-
referredFriendId: string;
|
|
2190
|
-
};
|
|
2191
|
-
successfulReferralEvent?: {
|
|
2192
|
-
referredFriendId: string;
|
|
2193
|
-
referringCustomerId: string;
|
|
2194
|
-
};
|
|
2195
|
-
actionEvent?: {
|
|
2196
|
-
referredFriendId: string;
|
|
2197
|
-
referringCustomerId: string;
|
|
2198
|
-
trigger?: {
|
|
2199
|
-
appId: string;
|
|
2200
|
-
activityType: string;
|
|
2201
|
-
};
|
|
2202
|
-
};
|
|
2203
|
-
rewardEvent?: {
|
|
2204
|
-
rewardedReferringCustomerId: string;
|
|
2205
|
-
rewardedReferredFriendId: string;
|
|
2206
|
-
referralRewardId: string;
|
|
2207
|
-
rewardType: Reward;
|
|
2208
|
-
};
|
|
2209
|
-
};
|
|
1540
|
+
interface GetReferralRewardRequest {
|
|
1541
|
+
/** Id of the ReferralReward to retrieve. */
|
|
1542
|
+
_id: string;
|
|
2210
1543
|
}
|
|
2211
|
-
interface
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
referredFriendId: string;
|
|
2215
|
-
};
|
|
2216
|
-
successfulReferralEvent?: {
|
|
2217
|
-
referredFriendId: string;
|
|
2218
|
-
referringCustomerId: string;
|
|
2219
|
-
};
|
|
2220
|
-
actionEvent?: {
|
|
2221
|
-
referredFriendId: string;
|
|
2222
|
-
referringCustomerId: string;
|
|
2223
|
-
trigger?: {
|
|
2224
|
-
appId: string;
|
|
2225
|
-
activityType: string;
|
|
2226
|
-
};
|
|
2227
|
-
};
|
|
2228
|
-
rewardEvent?: {
|
|
2229
|
-
rewardedReferringCustomerId: string;
|
|
2230
|
-
rewardedReferredFriendId: string;
|
|
2231
|
-
referralRewardId: string;
|
|
2232
|
-
rewardType: Reward;
|
|
2233
|
-
};
|
|
2234
|
-
}[];
|
|
1544
|
+
interface GetReferralRewardResponse {
|
|
1545
|
+
/** The retrieved ReferralReward. */
|
|
1546
|
+
referralReward?: ReferralReward;
|
|
2235
1547
|
}
|
|
2236
|
-
interface
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
|
|
1548
|
+
interface QueryReferralRewardsRequest {
|
|
1549
|
+
/** Query to filter ReferralRewards. */
|
|
1550
|
+
query: CursorQuery$4;
|
|
1551
|
+
/** Filter by contact id or set to "me" for current identity's rewards. */
|
|
1552
|
+
contactId?: string | null;
|
|
2240
1553
|
}
|
|
2241
|
-
interface
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
2245
|
-
|
|
2246
|
-
|
|
2247
|
-
|
|
2248
|
-
|
|
1554
|
+
interface CursorQuery$4 extends CursorQueryPagingMethodOneOf$4 {
|
|
1555
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1556
|
+
cursorPaging?: CursorPaging$4;
|
|
1557
|
+
/**
|
|
1558
|
+
* Filter object in the following format:
|
|
1559
|
+
* `"filter" : {
|
|
1560
|
+
* "fieldName1": "value1",
|
|
1561
|
+
* "fieldName2":{"$operator":"value2"}
|
|
1562
|
+
* }`
|
|
1563
|
+
* Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
|
|
1564
|
+
*/
|
|
1565
|
+
filter?: Record<string, any> | null;
|
|
1566
|
+
/**
|
|
1567
|
+
* Sort object in the following format:
|
|
1568
|
+
* `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
|
|
1569
|
+
*/
|
|
1570
|
+
sort?: Sorting$4[];
|
|
2249
1571
|
}
|
|
2250
|
-
|
|
2251
|
-
|
|
1572
|
+
/** @oneof */
|
|
1573
|
+
interface CursorQueryPagingMethodOneOf$4 {
|
|
1574
|
+
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
1575
|
+
cursorPaging?: CursorPaging$4;
|
|
1576
|
+
}
|
|
1577
|
+
interface Sorting$4 {
|
|
1578
|
+
/** Name of the field to sort by. */
|
|
1579
|
+
fieldName?: string;
|
|
1580
|
+
/** Sort order. */
|
|
1581
|
+
order?: SortOrder$4;
|
|
1582
|
+
}
|
|
1583
|
+
declare enum SortOrder$4 {
|
|
1584
|
+
ASC = "ASC",
|
|
1585
|
+
DESC = "DESC"
|
|
1586
|
+
}
|
|
1587
|
+
interface CursorPaging$4 {
|
|
1588
|
+
/** Maximum number of items to return in the results. */
|
|
1589
|
+
limit?: number | null;
|
|
1590
|
+
/**
|
|
1591
|
+
* Pointer to the next or previous page in the list of results.
|
|
1592
|
+
*
|
|
1593
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
1594
|
+
* Not relevant for the first request.
|
|
1595
|
+
*/
|
|
1596
|
+
cursor?: string | null;
|
|
1597
|
+
}
|
|
1598
|
+
interface QueryReferralRewardsResponse {
|
|
1599
|
+
/** The retrieved ReferralRewards. */
|
|
1600
|
+
referralRewards?: ReferralReward[];
|
|
1601
|
+
/** Metadata for paging. */
|
|
1602
|
+
metadata?: CursorPagingMetadata$4;
|
|
1603
|
+
}
|
|
1604
|
+
interface CursorPagingMetadata$4 {
|
|
1605
|
+
/** Number of items returned in the response. */
|
|
1606
|
+
count?: number | null;
|
|
1607
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
1608
|
+
cursors?: Cursors$4;
|
|
1609
|
+
/**
|
|
1610
|
+
* Whether there are more pages to retrieve following the current page.
|
|
1611
|
+
*
|
|
1612
|
+
* + `true`: Another page of results can be retrieved.
|
|
1613
|
+
* + `false`: This is the last page.
|
|
1614
|
+
*/
|
|
1615
|
+
hasNext?: boolean | null;
|
|
1616
|
+
}
|
|
1617
|
+
interface Cursors$4 {
|
|
1618
|
+
/** Cursor string pointing to the next page in the list of results. */
|
|
1619
|
+
next?: string | null;
|
|
1620
|
+
/** Cursor pointing to the previous page in the list of results. */
|
|
1621
|
+
prev?: string | null;
|
|
1622
|
+
}
|
|
1623
|
+
interface GetReferralRewardResponseNonNullableFields {
|
|
1624
|
+
referralReward?: {
|
|
1625
|
+
rewardedReferringCustomerId: string;
|
|
1626
|
+
rewardedReferredFriendId: string;
|
|
2252
1627
|
coupon?: {
|
|
2253
1628
|
_id: string;
|
|
2254
1629
|
code: string;
|
|
@@ -2275,15 +1650,40 @@ interface QueryReferredFriendActionsResponseNonNullableFields {
|
|
|
2275
1650
|
transactionId: string;
|
|
2276
1651
|
amount: number;
|
|
2277
1652
|
};
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
|
|
2281
|
-
|
|
2282
|
-
|
|
1653
|
+
rewardType: RewardTypeType;
|
|
1654
|
+
};
|
|
1655
|
+
}
|
|
1656
|
+
interface QueryReferralRewardsResponseNonNullableFields {
|
|
1657
|
+
referralRewards: {
|
|
1658
|
+
rewardedReferringCustomerId: string;
|
|
1659
|
+
rewardedReferredFriendId: string;
|
|
1660
|
+
coupon?: {
|
|
1661
|
+
_id: string;
|
|
1662
|
+
code: string;
|
|
1663
|
+
status: Status$2;
|
|
1664
|
+
couponSpecification?: {
|
|
1665
|
+
fixedAmountOptions?: {
|
|
1666
|
+
amount: number;
|
|
1667
|
+
};
|
|
1668
|
+
percentageOptions?: {
|
|
1669
|
+
percentage: number;
|
|
1670
|
+
};
|
|
1671
|
+
minimumSubtotal: number;
|
|
1672
|
+
scope?: {
|
|
1673
|
+
namespace: string;
|
|
1674
|
+
group?: {
|
|
1675
|
+
name: string;
|
|
1676
|
+
};
|
|
1677
|
+
};
|
|
1678
|
+
name: string;
|
|
1679
|
+
discountType: DiscountType;
|
|
1680
|
+
};
|
|
2283
1681
|
};
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
|
|
1682
|
+
loyaltyPoints?: {
|
|
1683
|
+
transactionId: string;
|
|
1684
|
+
amount: number;
|
|
1685
|
+
};
|
|
1686
|
+
rewardType: RewardTypeType;
|
|
2287
1687
|
}[];
|
|
2288
1688
|
}
|
|
2289
1689
|
|
|
@@ -2297,21 +1697,15 @@ type __PublicMethodMetaInfo$2<K = string, M = unknown, T = unknown, S = unknown,
|
|
|
2297
1697
|
__responseType: Q;
|
|
2298
1698
|
__originalResponseType: R;
|
|
2299
1699
|
};
|
|
2300
|
-
declare function
|
|
2301
|
-
|
|
2302
|
-
},
|
|
2303
|
-
declare function
|
|
2304
|
-
declare function getReferralStatistics(): __PublicMethodMetaInfo$2<'GET', {}, GetReferralStatisticsRequest, GetReferralStatisticsRequest$1, GetReferralStatisticsResponse & GetReferralStatisticsResponseNonNullableFields, GetReferralStatisticsResponse$1 & GetReferralStatisticsResponseNonNullableFields$1>;
|
|
2305
|
-
declare function queryReferringCustomerTotals(): __PublicMethodMetaInfo$2<'POST', {}, QueryReferringCustomerTotalsRequest, QueryReferringCustomerTotalsRequest$1, QueryReferringCustomerTotalsResponse & QueryReferringCustomerTotalsResponseNonNullableFields, QueryReferringCustomerTotalsResponse$1 & QueryReferringCustomerTotalsResponseNonNullableFields$1>;
|
|
2306
|
-
declare function queryReferredFriendActions(): __PublicMethodMetaInfo$2<'POST', {}, QueryReferredFriendActionsRequest, QueryReferredFriendActionsRequest$1, QueryReferredFriendActionsResponse & QueryReferredFriendActionsResponseNonNullableFields, QueryReferredFriendActionsResponse$1 & QueryReferredFriendActionsResponseNonNullableFields$1>;
|
|
1700
|
+
declare function getReferralReward(): __PublicMethodMetaInfo$2<'GET', {
|
|
1701
|
+
id: string;
|
|
1702
|
+
}, GetReferralRewardRequest, GetReferralRewardRequest$1, GetReferralRewardResponse & GetReferralRewardResponseNonNullableFields, GetReferralRewardResponse$1 & GetReferralRewardResponseNonNullableFields$1>;
|
|
1703
|
+
declare function queryReferralRewards(): __PublicMethodMetaInfo$2<'POST', {}, QueryReferralRewardsRequest, QueryReferralRewardsRequest$1, QueryReferralRewardsResponse & QueryReferralRewardsResponseNonNullableFields, QueryReferralRewardsResponse$1 & QueryReferralRewardsResponseNonNullableFields$1>;
|
|
2307
1704
|
|
|
2308
|
-
declare const meta$
|
|
2309
|
-
declare const meta$
|
|
2310
|
-
declare const meta$2_queryReferralEvent: typeof queryReferralEvent;
|
|
2311
|
-
declare const meta$2_queryReferredFriendActions: typeof queryReferredFriendActions;
|
|
2312
|
-
declare const meta$2_queryReferringCustomerTotals: typeof queryReferringCustomerTotals;
|
|
1705
|
+
declare const meta$2_getReferralReward: typeof getReferralReward;
|
|
1706
|
+
declare const meta$2_queryReferralRewards: typeof queryReferralRewards;
|
|
2313
1707
|
declare namespace meta$2 {
|
|
2314
|
-
export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$
|
|
1708
|
+
export { type __PublicMethodMetaInfo$2 as __PublicMethodMetaInfo, meta$2_getReferralReward as getReferralReward, meta$2_queryReferralRewards as queryReferralRewards };
|
|
2315
1709
|
}
|
|
2316
1710
|
|
|
2317
1711
|
/** ReferredFriend is the main entity of ReferredFriends that can be used for lorem ipsum dolor */
|
|
@@ -3099,4 +2493,4 @@ declare namespace meta {
|
|
|
3099
2493
|
export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_deleteReferringCustomer as deleteReferringCustomer, meta_generateReferringCustomerForContact as generateReferringCustomerForContact, meta_getReferringCustomer as getReferringCustomer, meta_getReferringCustomerByReferralCode as getReferringCustomerByReferralCode, meta_queryReferringCustomers as queryReferringCustomers };
|
|
3100
2494
|
}
|
|
3101
2495
|
|
|
3102
|
-
export { meta as customers, meta$1 as friends, meta$
|
|
2496
|
+
export { meta as customers, meta$1 as friends, meta$2 as rewards, meta$3 as tracker };
|