@wix/referral 1.0.3 → 1.0.4

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.
@@ -1,1254 +1,3 @@
1
- /** ReferralProgram is the main entity of ReferralPrograms that can be used to manage the program. */
2
- interface ReferralProgram$1 {
3
- /** Referral program name. */
4
- name?: string | null;
5
- /**
6
- * Referral program status.
7
- * @readonly
8
- */
9
- status?: ProgramStatus$1;
10
- /** Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision. */
11
- revision?: string | null;
12
- /**
13
- * Program's creation date and time.
14
- * @readonly
15
- */
16
- createdDate?: Date;
17
- /**
18
- * Program's last update date and time
19
- * @readonly
20
- */
21
- updatedDate?: Date;
22
- /** Referred friend reward configuration. */
23
- referredFriendReward?: Reward$3;
24
- /** Referring customer reward configuration. */
25
- referringCustomerReward?: Reward$3;
26
- /** List of actions that complete referral. */
27
- successfulReferralActions?: Action$1[];
28
- /**
29
- * Set to true if user has required plan to activate program.
30
- * @readonly
31
- * @deprecated Set to true if user has required plan to activate program.
32
- * @replacedBy GetReferralProgramPremiumFeatures
33
- * @removalDate 2024-09-01
34
- */
35
- isPremium?: boolean;
36
- /** Emails configuration. */
37
- emails?: Emails$1;
38
- }
39
- declare enum ProgramStatus$1 {
40
- /** unknown status. */
41
- UNKNOWN = "UNKNOWN",
42
- /** initial program status (program was created but was not enabled yet). */
43
- DRAFT = "DRAFT",
44
- /** program is active. */
45
- ACTIVE = "ACTIVE",
46
- /** program was manually disabled by the user (this action can be reverted, meaning user can set it to be active again). */
47
- PAUSED = "PAUSED"
48
- }
49
- interface Reward$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;
56
- }
57
- /** @oneof */
58
- interface RewardOptionsOneOf$1 {
59
- /** Options for coupon reward type. */
60
- couponOptions?: Coupon$3;
61
- /** Options for Loyalty points reward type. */
62
- loyaltyPointsOptions?: LoyaltyPoints$3;
63
- }
64
- declare enum Type$1 {
65
- /** Unknown reward type. */
66
- UNKNOWN = "UNKNOWN",
67
- /** Coupon reward type. */
68
- COUPON = "COUPON",
69
- /** Loyalty points reward type. */
70
- LOYALTY_POINTS = "LOYALTY_POINTS",
71
- /** No reward type. */
72
- NOTHING = "NOTHING"
73
- }
74
- interface Coupon$3 extends CouponDiscountTypeOptionsOneOf$3, CouponScopeOrMinSubtotalOneOf$3 {
75
- /** Options for fixed amount discount type. */
76
- fixedAmountOptions?: FixedAmountDiscount$3;
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;
137
- }
138
- interface LoyaltyPoints$3 {
139
- /** Amount of points to give. */
140
- amount?: number;
141
- }
142
- declare enum Action$1 {
143
- /** Unknown action. */
144
- UNKNOWN = "UNKNOWN",
145
- /** Store order placed. */
146
- STORE_ORDER_PLACED = "STORE_ORDER_PLACED",
147
- /** Pricing plan ordered. */
148
- PLAN_ORDERED = "PLAN_ORDERED",
149
- /** Wix events ticket ordered. */
150
- TICKET_ORDERED = "TICKET_ORDERED",
151
- /** Bookings session booked. */
152
- SESSION_BOOKED = "SESSION_BOOKED",
153
- /** Restaurant order placed. */
154
- RESTAURANT_ORDER_PLACED = "RESTAURANT_ORDER_PLACED"
155
- }
156
- interface Emails$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. */
184
- query: CursorQuery$7;
185
- }
186
- interface CursorQuery$7 extends CursorQueryPagingMethodOneOf$7 {
187
- /** 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`. */
188
- cursorPaging?: CursorPaging$7;
189
- /**
190
- * Filter object in the following format:
191
- * `"filter" : {
192
- * "fieldName1": "value1",
193
- * "fieldName2":{"$operator":"value2"}
194
- * }`
195
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
196
- */
197
- filter?: Record<string, any> | null;
198
- /**
199
- * Sort object in the following format:
200
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
201
- */
202
- sort?: Sorting$7[];
203
- }
204
- /** @oneof */
205
- interface CursorQueryPagingMethodOneOf$7 {
206
- /** 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`. */
207
- cursorPaging?: CursorPaging$7;
208
- }
209
- interface Sorting$7 {
210
- /** Name of the field to sort by. */
211
- fieldName?: string;
212
- /** Sort order. */
213
- order?: SortOrder$7;
214
- }
215
- declare enum SortOrder$7 {
216
- ASC = "ASC",
217
- DESC = "DESC"
218
- }
219
- interface CursorPaging$7 {
220
- /** Maximum number of items to return in the results. */
221
- limit?: number | null;
222
- /**
223
- * Pointer to the next or previous page in the list of results.
224
- *
225
- * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
226
- * Not relevant for the first request.
227
- */
228
- cursor?: string | null;
229
- }
230
- interface QueryReferralProgramsResponse$1 {
231
- /** ReferralPrograms that match the query. */
232
- referralPrograms?: ReferralProgram$1[];
233
- /** Paging metadata. */
234
- pagingMetadata?: CursorPagingMetadata$7;
235
- }
236
- interface CursorPagingMetadata$7 {
237
- /** Number of items returned in the response. */
238
- count?: number | null;
239
- /** Cursor strings that point to the next page, previous page, or both. */
240
- cursors?: Cursors$7;
241
- /**
242
- * Whether there are more pages to retrieve following the current page.
243
- *
244
- * + `true`: Another page of results can be retrieved.
245
- * + `false`: This is the last page.
246
- */
247
- hasNext?: boolean | null;
248
- }
249
- interface Cursors$7 {
250
- /** Cursor string pointing to the next page in the list of results. */
251
- next?: string | null;
252
- /** Cursor pointing to the previous page in the list of results. */
253
- prev?: string | null;
254
- }
255
- interface UpdateReferralProgramRequest$1 {
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;
274
- }
275
- interface GetAISocialMediaPostsSuggestionsRequest$1 {
276
- /** The topic to generate suggestions for. */
277
- topic?: string;
278
- }
279
- interface GetAISocialMediaPostsSuggestionsResponse$1 {
280
- /** The generated suggestions. */
281
- suggestions?: AISocialMediaPostSuggestion$1[];
282
- /** The refer friends page URL. */
283
- referFriendsPageUrl?: string | null;
284
- }
285
- interface AISocialMediaPostSuggestion$1 {
286
- /** The suggested post content. */
287
- postContent?: string;
288
- /** The suggested hashtags. */
289
- hashtags?: string[];
290
- }
291
- interface GenerateAISocialMediaPostsSuggestionsRequest$1 {
292
- /** The topic to generate suggestions for. */
293
- topic?: string;
294
- }
295
- interface GenerateAISocialMediaPostsSuggestionsResponse$1 {
296
- /** The generated suggestions. */
297
- suggestions?: AISocialMediaPostSuggestion$1[];
298
- /** The refer friends page URL. */
299
- referFriendsPageUrl?: string | null;
300
- }
301
- interface GetReferralProgramPremiumFeaturesRequest$1 {
302
- }
303
- interface GetReferralProgramPremiumFeaturesResponse$1 {
304
- /**
305
- * Set to true if user has referral program feature.
306
- * @readonly
307
- */
308
- referralProgram?: boolean;
309
- }
310
- interface GetReferralProgramResponseNonNullableFields$1 {
311
- referralProgram?: {
312
- status: ProgramStatus$1;
313
- referredFriendReward?: {
314
- couponOptions?: {
315
- fixedAmountOptions?: {
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;
609
- }
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;
615
- /**
616
- * Referral program status.
617
- * @readonly
618
- */
619
- status?: ProgramStatus;
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;
622
- /**
623
- * Program's creation date and time.
624
- * @readonly
625
- */
626
- _createdDate?: Date;
627
- /**
628
- * Program's last update date and time
629
- * @readonly
630
- */
631
- _updatedDate?: Date;
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[];
638
- /**
639
- * Set to true if user has required plan to activate program.
640
- * @readonly
641
- * @deprecated Set to true if user has required plan to activate program.
642
- * @replacedBy GetReferralProgramPremiumFeatures
643
- * @removalDate 2024-09-01
644
- */
645
- isPremium?: boolean;
646
- /** Emails configuration. */
647
- emails?: Emails;
648
- }
649
- declare enum ProgramStatus {
650
- /** unknown status. */
651
- UNKNOWN = "UNKNOWN",
652
- /** initial program status (program was created but was not enabled yet). */
653
- DRAFT = "DRAFT",
654
- /** program is active. */
655
- ACTIVE = "ACTIVE",
656
- /** program was manually disabled by the user (this action can be reverted, meaning user can set it to be active again). */
657
- PAUSED = "PAUSED"
658
- }
659
- interface Reward$2 extends RewardOptionsOneOf {
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"
683
- }
684
- interface Coupon$2 extends CouponDiscountTypeOptionsOneOf$2, CouponScopeOrMinSubtotalOneOf$2 {
685
- /** Options for fixed amount discount type. */
686
- fixedAmountOptions?: FixedAmountDiscount$2;
687
- /** Options for percentage discount type. */
688
- percentageOptions?: PercentageDiscount$2;
689
- /** Limit the coupon to carts with a subtotal above this number. */
690
- minimumSubtotal?: number;
691
- /** Specifies the type of line items this coupon will apply to. */
692
- scope?: CouponScope$2;
693
- /** Coupon name. */
694
- name?: string;
695
- /** Coupon discount type. */
696
- discountType?: DiscountType$2;
697
- /** Limit the coupon to only apply to one item in cart. */
698
- limitedToOneItem?: boolean | null;
699
- /** If true, coupon also applies to subscriptions. */
700
- appliesToSubscriptions?: boolean | null;
701
- /** Specifies the amount of discounted cycles for subscription item. See Stores Coupons documentation for more info. */
702
- discountedCycleCount?: number | null;
703
- }
704
- /** @oneof */
705
- interface CouponDiscountTypeOptionsOneOf$2 {
706
- /** Options for fixed amount discount type. */
707
- fixedAmountOptions?: FixedAmountDiscount$2;
708
- /** Options for percentage discount type. */
709
- percentageOptions?: PercentageDiscount$2;
710
- }
711
- /** @oneof */
712
- interface CouponScopeOrMinSubtotalOneOf$2 {
713
- /** Limit the coupon to carts with a subtotal above this number. */
714
- minimumSubtotal?: number;
715
- /** Specifies the type of line items this coupon will apply to. */
716
- scope?: CouponScope$2;
717
- }
718
- declare enum DiscountType$2 {
719
- /** Unknown discount type. */
720
- UNKNOWN = "UNKNOWN",
721
- /** Discount as a fixed amount. */
722
- FIXED_AMOUNT = "FIXED_AMOUNT",
723
- /** Discount as a percentage. */
724
- PERCENTAGE = "PERCENTAGE",
725
- /** Free shipping. */
726
- FREE_SHIPPING = "FREE_SHIPPING"
727
- }
728
- interface FixedAmountDiscount$2 {
729
- /** Fixed amount to discount. */
730
- amount?: number;
731
- }
732
- interface PercentageDiscount$2 {
733
- /** Percentage to discount. */
734
- percentage?: number;
735
- }
736
- interface CouponScope$2 {
737
- /** Namespace of the coupon scope. */
738
- namespace?: string;
739
- /** Group of the coupon scope. */
740
- group?: Group$2;
741
- }
742
- interface Group$2 {
743
- /** Name of the group. */
744
- name?: string;
745
- /** Entity ID of the group. */
746
- entityId?: string | null;
747
- }
748
- interface LoyaltyPoints$2 {
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;
851
- /**
852
- * Whether there are more pages to retrieve following the current page.
853
- *
854
- * + `true`: Another page of results can be retrieved.
855
- * + `false`: This is the last page.
856
- */
857
- hasNext?: boolean | null;
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 {
914
- /**
915
- * Set to true if user has referral program feature.
916
- * @readonly
917
- */
918
- referralProgram?: boolean;
919
- }
920
- interface GetReferralProgramResponseNonNullableFields {
921
- referralProgram?: {
922
- status: ProgramStatus;
923
- referredFriendReward?: {
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;
945
- };
946
- referringCustomerReward?: {
947
- couponOptions?: {
948
- fixedAmountOptions?: {
949
- amount: number;
950
- };
951
- percentageOptions?: {
952
- percentage: number;
953
- };
954
- minimumSubtotal: number;
955
- scope?: {
956
- namespace: string;
957
- group?: {
958
- name: string;
959
- };
960
- };
961
- name: string;
962
- discountType: DiscountType$2;
963
- };
964
- loyaltyPointsOptions?: {
965
- amount: number;
966
- };
967
- type: Type;
968
- };
969
- successfulReferralActions: Action[];
970
- isPremium: boolean;
971
- emails?: {
972
- encourageToReferFriends: App[];
973
- notifyCustomersAboutReward: boolean;
974
- };
975
- };
976
- }
977
- interface QueryReferralProgramsResponseNonNullableFields {
978
- referralPrograms: {
979
- status: ProgramStatus;
980
- referredFriendReward?: {
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;
1002
- };
1003
- referringCustomerReward?: {
1004
- couponOptions?: {
1005
- fixedAmountOptions?: {
1006
- amount: number;
1007
- };
1008
- percentageOptions?: {
1009
- percentage: number;
1010
- };
1011
- minimumSubtotal: number;
1012
- scope?: {
1013
- namespace: string;
1014
- group?: {
1015
- name: string;
1016
- };
1017
- };
1018
- name: string;
1019
- discountType: DiscountType$2;
1020
- };
1021
- loyaltyPointsOptions?: {
1022
- amount: number;
1023
- };
1024
- type: Type;
1025
- };
1026
- successfulReferralActions: Action[];
1027
- isPremium: boolean;
1028
- emails?: {
1029
- encourageToReferFriends: App[];
1030
- notifyCustomersAboutReward: boolean;
1031
- };
1032
- }[];
1033
- }
1034
- interface UpdateReferralProgramResponseNonNullableFields {
1035
- referralProgram?: {
1036
- status: ProgramStatus;
1037
- referredFriendReward?: {
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
- };
1090
- }
1091
- interface ActivateReferralProgramResponseNonNullableFields {
1092
- referralProgram?: {
1093
- status: ProgramStatus;
1094
- referredFriendReward?: {
1095
- couponOptions?: {
1096
- fixedAmountOptions?: {
1097
- amount: number;
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
- };
1147
- }
1148
- interface PauseReferralProgramResponseNonNullableFields {
1149
- referralProgram?: {
1150
- status: ProgramStatus;
1151
- referredFriendReward?: {
1152
- couponOptions?: {
1153
- fixedAmountOptions?: {
1154
- amount: number;
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?: {
1176
- fixedAmountOptions?: {
1177
- amount: number;
1178
- };
1179
- percentageOptions?: {
1180
- percentage: number;
1181
- };
1182
- minimumSubtotal: number;
1183
- scope?: {
1184
- namespace: string;
1185
- group?: {
1186
- name: string;
1187
- };
1188
- };
1189
- name: string;
1190
- discountType: DiscountType$2;
1191
- };
1192
- loyaltyPointsOptions?: {
1193
- amount: number;
1194
- };
1195
- type: Type;
1196
- };
1197
- successfulReferralActions: Action[];
1198
- isPremium: boolean;
1199
- emails?: {
1200
- encourageToReferFriends: App[];
1201
- notifyCustomersAboutReward: boolean;
1202
- };
1203
- };
1204
- }
1205
- interface GetAISocialMediaPostsSuggestionsResponseNonNullableFields {
1206
- suggestions: {
1207
- postContent: string;
1208
- hashtags: string[];
1209
- }[];
1210
- }
1211
- interface GenerateAISocialMediaPostsSuggestionsResponseNonNullableFields {
1212
- suggestions: {
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 };
1250
- }
1251
-
1252
1
  /** ReferralEvent. */
1253
2
  interface ReferralEvent$1 extends ReferralEventEventTypeOneOf$1 {
1254
3
  /** ReferredFriendSignupEvent is an event that is triggered when a referred friend signs up. */
@@ -1589,17 +338,17 @@ declare enum Status$3 {
1589
338
  DELETED = "DELETED"
1590
339
  }
1591
340
  interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSubtotalOneOf$1 {
1592
- /** Options for fixed amount discount type. */
341
+ /** Options for fixed amount discount type */
1593
342
  fixedAmountOptions?: FixedAmountDiscount$1;
1594
- /** Options for percentage discount type. */
343
+ /** Options for percentage discount type */
1595
344
  percentageOptions?: PercentageDiscount$1;
1596
345
  /** Limit the coupon to carts with a subtotal above this number. */
1597
346
  minimumSubtotal?: number;
1598
347
  /** Specifies the type of line items this coupon will apply to. */
1599
348
  scope?: CouponScope$1;
1600
- /** Coupon name. */
349
+ /** Coupon name */
1601
350
  name?: string;
1602
- /** Coupon discount type. */
351
+ /** Coupon discount type */
1603
352
  discountType?: DiscountType$1;
1604
353
  /** Limit the coupon to only apply to one item in cart. */
1605
354
  limitedToOneItem?: boolean | null;
@@ -1610,9 +359,9 @@ interface Coupon$1 extends CouponDiscountTypeOptionsOneOf$1, CouponScopeOrMinSub
1610
359
  }
1611
360
  /** @oneof */
1612
361
  interface CouponDiscountTypeOptionsOneOf$1 {
1613
- /** Options for fixed amount discount type. */
362
+ /** Options for fixed amount discount type */
1614
363
  fixedAmountOptions?: FixedAmountDiscount$1;
1615
- /** Options for percentage discount type. */
364
+ /** Options for percentage discount type */
1616
365
  percentageOptions?: PercentageDiscount$1;
1617
366
  }
1618
367
  /** @oneof */
@@ -1623,33 +372,27 @@ interface CouponScopeOrMinSubtotalOneOf$1 {
1623
372
  scope?: CouponScope$1;
1624
373
  }
1625
374
  declare enum DiscountType$1 {
1626
- /** Unknown discount type. */
1627
375
  UNKNOWN = "UNKNOWN",
1628
- /** Discount as a fixed amount. */
376
+ /** Discount as a fixed amount */
1629
377
  FIXED_AMOUNT = "FIXED_AMOUNT",
1630
- /** Discount as a percentage. */
378
+ /** Discount as a percentage */
1631
379
  PERCENTAGE = "PERCENTAGE",
1632
- /** Free shipping. */
380
+ /** Free shipping */
1633
381
  FREE_SHIPPING = "FREE_SHIPPING"
1634
382
  }
1635
383
  interface FixedAmountDiscount$1 {
1636
- /** Fixed amount to discount. */
384
+ /** Fixed amount to discount */
1637
385
  amount?: number;
1638
386
  }
1639
387
  interface PercentageDiscount$1 {
1640
- /** Percentage to discount. */
1641
388
  percentage?: number;
1642
389
  }
1643
390
  interface CouponScope$1 {
1644
- /** Namespace of the coupon scope. */
1645
391
  namespace?: string;
1646
- /** Group of the coupon scope. */
1647
392
  group?: Group$1;
1648
393
  }
1649
394
  interface Group$1 {
1650
- /** Name of the group. */
1651
395
  name?: string;
1652
- /** Entity ID of the group. */
1653
396
  entityId?: string | null;
1654
397
  }
1655
398
  interface LoyaltyPoints$1 {
@@ -2108,17 +851,17 @@ declare enum Status$2 {
2108
851
  DELETED = "DELETED"
2109
852
  }
2110
853
  interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtotalOneOf {
2111
- /** Options for fixed amount discount type. */
854
+ /** Options for fixed amount discount type */
2112
855
  fixedAmountOptions?: FixedAmountDiscount;
2113
- /** Options for percentage discount type. */
856
+ /** Options for percentage discount type */
2114
857
  percentageOptions?: PercentageDiscount;
2115
858
  /** Limit the coupon to carts with a subtotal above this number. */
2116
859
  minimumSubtotal?: number;
2117
860
  /** Specifies the type of line items this coupon will apply to. */
2118
861
  scope?: CouponScope;
2119
- /** Coupon name. */
862
+ /** Coupon name */
2120
863
  name?: string;
2121
- /** Coupon discount type. */
864
+ /** Coupon discount type */
2122
865
  discountType?: DiscountType;
2123
866
  /** Limit the coupon to only apply to one item in cart. */
2124
867
  limitedToOneItem?: boolean | null;
@@ -2129,9 +872,9 @@ interface Coupon extends CouponDiscountTypeOptionsOneOf, CouponScopeOrMinSubtota
2129
872
  }
2130
873
  /** @oneof */
2131
874
  interface CouponDiscountTypeOptionsOneOf {
2132
- /** Options for fixed amount discount type. */
875
+ /** Options for fixed amount discount type */
2133
876
  fixedAmountOptions?: FixedAmountDiscount;
2134
- /** Options for percentage discount type. */
877
+ /** Options for percentage discount type */
2135
878
  percentageOptions?: PercentageDiscount;
2136
879
  }
2137
880
  /** @oneof */
@@ -2142,33 +885,27 @@ interface CouponScopeOrMinSubtotalOneOf {
2142
885
  scope?: CouponScope;
2143
886
  }
2144
887
  declare enum DiscountType {
2145
- /** Unknown discount type. */
2146
888
  UNKNOWN = "UNKNOWN",
2147
- /** Discount as a fixed amount. */
889
+ /** Discount as a fixed amount */
2148
890
  FIXED_AMOUNT = "FIXED_AMOUNT",
2149
- /** Discount as a percentage. */
891
+ /** Discount as a percentage */
2150
892
  PERCENTAGE = "PERCENTAGE",
2151
- /** Free shipping. */
893
+ /** Free shipping */
2152
894
  FREE_SHIPPING = "FREE_SHIPPING"
2153
895
  }
2154
896
  interface FixedAmountDiscount {
2155
- /** Fixed amount to discount. */
897
+ /** Fixed amount to discount */
2156
898
  amount?: number;
2157
899
  }
2158
900
  interface PercentageDiscount {
2159
- /** Percentage to discount. */
2160
901
  percentage?: number;
2161
902
  }
2162
903
  interface CouponScope {
2163
- /** Namespace of the coupon scope. */
2164
904
  namespace?: string;
2165
- /** Group of the coupon scope. */
2166
905
  group?: Group;
2167
906
  }
2168
907
  interface Group {
2169
- /** Name of the group. */
2170
908
  name?: string;
2171
- /** Entity ID of the group. */
2172
909
  entityId?: string | null;
2173
910
  }
2174
911
  interface LoyaltyPoints {
@@ -3099,4 +1836,4 @@ declare namespace meta {
3099
1836
  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
1837
  }
3101
1838
 
3102
- export { meta as customers, meta$1 as friends, meta$3 as programs, meta$2 as tracker };
1839
+ export { meta as customers, meta$1 as friends, meta$2 as tracker };