@munchi_oy/core 2.0.7 → 2.1.0
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/dist/generated/api.d.ts +1614 -50
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +2285 -146
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -446,6 +446,50 @@ export interface AmountDto {
|
|
|
446
446
|
*/
|
|
447
447
|
'currency': string;
|
|
448
448
|
}
|
|
449
|
+
/**
|
|
450
|
+
*
|
|
451
|
+
* @export
|
|
452
|
+
* @interface AutomaticPromotionDto
|
|
453
|
+
*/
|
|
454
|
+
export interface AutomaticPromotionDto {
|
|
455
|
+
/**
|
|
456
|
+
* The Vendure promotion\'s id
|
|
457
|
+
* @type {number}
|
|
458
|
+
* @memberof AutomaticPromotionDto
|
|
459
|
+
*/
|
|
460
|
+
'id': number;
|
|
461
|
+
/**
|
|
462
|
+
* The promotion\'s name
|
|
463
|
+
* @type {string}
|
|
464
|
+
* @memberof AutomaticPromotionDto
|
|
465
|
+
*/
|
|
466
|
+
'name': string;
|
|
467
|
+
/**
|
|
468
|
+
* When the promotion starts, an ISO date-time; null when it has no start
|
|
469
|
+
* @type {string}
|
|
470
|
+
* @memberof AutomaticPromotionDto
|
|
471
|
+
*/
|
|
472
|
+
'startsAt': string | null;
|
|
473
|
+
/**
|
|
474
|
+
* When the promotion ends, an ISO date-time; null when it has no end
|
|
475
|
+
* @type {string}
|
|
476
|
+
* @memberof AutomaticPromotionDto
|
|
477
|
+
*/
|
|
478
|
+
'endsAt': string | null;
|
|
479
|
+
}
|
|
480
|
+
/**
|
|
481
|
+
*
|
|
482
|
+
* @export
|
|
483
|
+
* @interface AutomaticPromotionsAnswerDto
|
|
484
|
+
*/
|
|
485
|
+
export interface AutomaticPromotionsAnswerDto {
|
|
486
|
+
/**
|
|
487
|
+
* The venue\'s automatic promotions in the caller\'s app that are running now, judged at the moment of the read. Empty: no promotion applies by itself, so the app need not ask for the basket\'s price unless it holds a coupon code. Read again when the venue\'s DISCOUNTS sync arrives
|
|
488
|
+
* @type {Array<AutomaticPromotionDto>}
|
|
489
|
+
* @memberof AutomaticPromotionsAnswerDto
|
|
490
|
+
*/
|
|
491
|
+
'automaticPromotions': Array<AutomaticPromotionDto>;
|
|
492
|
+
}
|
|
449
493
|
/**
|
|
450
494
|
*
|
|
451
495
|
* @export
|
|
@@ -491,6 +535,19 @@ export interface AvailablePaymentMethodDto {
|
|
|
491
535
|
*/
|
|
492
536
|
'requiresCredentials': boolean;
|
|
493
537
|
}
|
|
538
|
+
/**
|
|
539
|
+
*
|
|
540
|
+
* @export
|
|
541
|
+
* @enum {string}
|
|
542
|
+
*/
|
|
543
|
+
|
|
544
|
+
export const BasketNotPricedReason = {
|
|
545
|
+
Unavailable: 'UNAVAILABLE'
|
|
546
|
+
} as const;
|
|
547
|
+
|
|
548
|
+
export type BasketNotPricedReason = typeof BasketNotPricedReason[keyof typeof BasketNotPricedReason];
|
|
549
|
+
|
|
550
|
+
|
|
494
551
|
/**
|
|
495
552
|
*
|
|
496
553
|
* @export
|
|
@@ -2536,6 +2593,55 @@ export interface ChangePosOrdersStatusInBulkResponseDto {
|
|
|
2536
2593
|
*/
|
|
2537
2594
|
'skipped': Array<PosOrderLeftAsItIsDto>;
|
|
2538
2595
|
}
|
|
2596
|
+
/**
|
|
2597
|
+
*
|
|
2598
|
+
* @export
|
|
2599
|
+
* @interface ChangeResQOfferDto
|
|
2600
|
+
*/
|
|
2601
|
+
export interface ChangeResQOfferDto {
|
|
2602
|
+
/**
|
|
2603
|
+
* The offer\'s new name. Left out, the name stays
|
|
2604
|
+
* @type {string}
|
|
2605
|
+
* @memberof ChangeResQOfferDto
|
|
2606
|
+
*/
|
|
2607
|
+
'name'?: string;
|
|
2608
|
+
/**
|
|
2609
|
+
* The offer\'s new description. Left out, the description stays
|
|
2610
|
+
* @type {string}
|
|
2611
|
+
* @memberof ChangeResQOfferDto
|
|
2612
|
+
*/
|
|
2613
|
+
'description'?: string;
|
|
2614
|
+
/**
|
|
2615
|
+
* How many are for sale from now on. Left out, the quantity stays
|
|
2616
|
+
* @type {number}
|
|
2617
|
+
* @memberof ChangeResQOfferDto
|
|
2618
|
+
*/
|
|
2619
|
+
'quantity'?: number;
|
|
2620
|
+
/**
|
|
2621
|
+
* When ordering starts, an ISO 8601 date-time. Left out, it stays
|
|
2622
|
+
* @type {string}
|
|
2623
|
+
* @memberof ChangeResQOfferDto
|
|
2624
|
+
*/
|
|
2625
|
+
'orderStart'?: string;
|
|
2626
|
+
/**
|
|
2627
|
+
* When ordering ends, an ISO 8601 date-time. Left out, it stays
|
|
2628
|
+
* @type {string}
|
|
2629
|
+
* @memberof ChangeResQOfferDto
|
|
2630
|
+
*/
|
|
2631
|
+
'orderEnd'?: string;
|
|
2632
|
+
/**
|
|
2633
|
+
* When pick-up starts, an ISO 8601 date-time. Left out, it stays
|
|
2634
|
+
* @type {string}
|
|
2635
|
+
* @memberof ChangeResQOfferDto
|
|
2636
|
+
*/
|
|
2637
|
+
'fetchStart'?: string;
|
|
2638
|
+
/**
|
|
2639
|
+
* When pick-up ends, an ISO 8601 date-time. Left out, it stays
|
|
2640
|
+
* @type {string}
|
|
2641
|
+
* @memberof ChangeResQOfferDto
|
|
2642
|
+
*/
|
|
2643
|
+
'fetchEnd'?: string;
|
|
2644
|
+
}
|
|
2539
2645
|
/**
|
|
2540
2646
|
*
|
|
2541
2647
|
* @export
|
|
@@ -2820,6 +2926,39 @@ export interface CheckActionPasscodeDto {
|
|
|
2820
2926
|
}
|
|
2821
2927
|
|
|
2822
2928
|
|
|
2929
|
+
/**
|
|
2930
|
+
*
|
|
2931
|
+
* @export
|
|
2932
|
+
* @interface CheckCouponDto
|
|
2933
|
+
*/
|
|
2934
|
+
export interface CheckCouponDto {
|
|
2935
|
+
/**
|
|
2936
|
+
* The coupon\'s code, as typed or scanned, in any letter case
|
|
2937
|
+
* @type {string}
|
|
2938
|
+
* @memberof CheckCouponDto
|
|
2939
|
+
*/
|
|
2940
|
+
'couponCode': string;
|
|
2941
|
+
/**
|
|
2942
|
+
*
|
|
2943
|
+
* @type {OrderTypePOS}
|
|
2944
|
+
* @memberof CheckCouponDto
|
|
2945
|
+
*/
|
|
2946
|
+
'orderType': OrderTypePOS;
|
|
2947
|
+
/**
|
|
2948
|
+
* The customer\'s phone number in E.164 (+358401234567). Send it when the coupon is once per customer or for a first order only; Vendure answers CUSTOMER_PHONE_REQUIRED when it is needed and absent. The answer\'s discounts carry it back as couponCustomerPhone, kept on the order so the use is counted for this customer once the order is paid.
|
|
2949
|
+
* @type {string}
|
|
2950
|
+
* @memberof CheckCouponDto
|
|
2951
|
+
*/
|
|
2952
|
+
'customerPhone'?: string;
|
|
2953
|
+
/**
|
|
2954
|
+
* The order\'s lines as they stand; checked again whenever the basket changes
|
|
2955
|
+
* @type {Array<CouponBasketLineDto>}
|
|
2956
|
+
* @memberof CheckCouponDto
|
|
2957
|
+
*/
|
|
2958
|
+
'lines': Array<CouponBasketLineDto>;
|
|
2959
|
+
}
|
|
2960
|
+
|
|
2961
|
+
|
|
2823
2962
|
/**
|
|
2824
2963
|
*
|
|
2825
2964
|
* @export
|
|
@@ -3391,6 +3530,194 @@ export interface CoordinateDto {
|
|
|
3391
3530
|
*/
|
|
3392
3531
|
'lon': number;
|
|
3393
3532
|
}
|
|
3533
|
+
/**
|
|
3534
|
+
*
|
|
3535
|
+
* @export
|
|
3536
|
+
* @interface CouponBasketLineDto
|
|
3537
|
+
*/
|
|
3538
|
+
export interface CouponBasketLineDto {
|
|
3539
|
+
/**
|
|
3540
|
+
* The line\'s stable id, the one the order\'s discounts point at
|
|
3541
|
+
* @type {string}
|
|
3542
|
+
* @memberof CouponBasketLineDto
|
|
3543
|
+
*/
|
|
3544
|
+
'lineItemId': string;
|
|
3545
|
+
/**
|
|
3546
|
+
* The product\'s Vendure id: the line\'s posId, as a number
|
|
3547
|
+
* @type {number}
|
|
3548
|
+
* @memberof CouponBasketLineDto
|
|
3549
|
+
*/
|
|
3550
|
+
'productId': number;
|
|
3551
|
+
/**
|
|
3552
|
+
* How many of the product the line holds, a whole number
|
|
3553
|
+
* @type {number}
|
|
3554
|
+
* @memberof CouponBasketLineDto
|
|
3555
|
+
*/
|
|
3556
|
+
'quantity': number;
|
|
3557
|
+
/**
|
|
3558
|
+
* The price of one unit as the till charges it, options included, in cents
|
|
3559
|
+
* @type {number}
|
|
3560
|
+
* @memberof CouponBasketLineDto
|
|
3561
|
+
*/
|
|
3562
|
+
'unitAmount': number;
|
|
3563
|
+
/**
|
|
3564
|
+
* The line\'s VAT rate in percent (14 is 14%): the item\'s taxRate. Needed when the coupon\'s minimum order is before VAT; absent there, Vendure answers CONDITIONS_NOT_MET
|
|
3565
|
+
* @type {number}
|
|
3566
|
+
* @memberof CouponBasketLineDto
|
|
3567
|
+
*/
|
|
3568
|
+
'vatRate'?: number;
|
|
3569
|
+
}
|
|
3570
|
+
/**
|
|
3571
|
+
*
|
|
3572
|
+
* @export
|
|
3573
|
+
* @interface CouponCheckAnswerDto
|
|
3574
|
+
*/
|
|
3575
|
+
export interface CouponCheckAnswerDto {
|
|
3576
|
+
/**
|
|
3577
|
+
* true when the coupon applies to this basket; false when it does not
|
|
3578
|
+
* @type {boolean}
|
|
3579
|
+
* @memberof CouponCheckAnswerDto
|
|
3580
|
+
*/
|
|
3581
|
+
'valid': boolean;
|
|
3582
|
+
/**
|
|
3583
|
+
* The discounts to add to the order, one per application; empty when valid is false
|
|
3584
|
+
* @type {Array<CouponDiscountDto>}
|
|
3585
|
+
* @memberof CouponCheckAnswerDto
|
|
3586
|
+
*/
|
|
3587
|
+
'discounts': Array<CouponDiscountDto>;
|
|
3588
|
+
/**
|
|
3589
|
+
* Rewards of the promotion that do not apply here, such as free delivery on a dine-in order; empty when none or when valid is false
|
|
3590
|
+
* @type {Array<CouponRewardNotAppliedDto>}
|
|
3591
|
+
* @memberof CouponCheckAnswerDto
|
|
3592
|
+
*/
|
|
3593
|
+
'notApplied': Array<CouponRewardNotAppliedDto>;
|
|
3594
|
+
/**
|
|
3595
|
+
*
|
|
3596
|
+
* @type {CouponRefusal}
|
|
3597
|
+
* @memberof CouponCheckAnswerDto
|
|
3598
|
+
*/
|
|
3599
|
+
'reason': CouponRefusal | null;
|
|
3600
|
+
/**
|
|
3601
|
+
* What to tell the person at the till or the kiosk; null when valid is true
|
|
3602
|
+
* @type {string}
|
|
3603
|
+
* @memberof CouponCheckAnswerDto
|
|
3604
|
+
*/
|
|
3605
|
+
'message': string | null;
|
|
3606
|
+
}
|
|
3607
|
+
|
|
3608
|
+
|
|
3609
|
+
/**
|
|
3610
|
+
*
|
|
3611
|
+
* @export
|
|
3612
|
+
* @interface CouponDiscountDto
|
|
3613
|
+
*/
|
|
3614
|
+
export interface CouponDiscountDto {
|
|
3615
|
+
/**
|
|
3616
|
+
*
|
|
3617
|
+
* @type {DiscountType}
|
|
3618
|
+
* @memberof CouponDiscountDto
|
|
3619
|
+
*/
|
|
3620
|
+
'type': DiscountType;
|
|
3621
|
+
/**
|
|
3622
|
+
* A percentage for PERCENTAGE (10 is 10%), cents for FIXED
|
|
3623
|
+
* @type {number}
|
|
3624
|
+
* @memberof CouponDiscountDto
|
|
3625
|
+
*/
|
|
3626
|
+
'value': number;
|
|
3627
|
+
/**
|
|
3628
|
+
*
|
|
3629
|
+
* @type {DiscountScope}
|
|
3630
|
+
* @memberof CouponDiscountDto
|
|
3631
|
+
*/
|
|
3632
|
+
'scope': DiscountScope;
|
|
3633
|
+
/**
|
|
3634
|
+
* The line it discounts, for an ITEM discount; null for a CART discount
|
|
3635
|
+
* @type {string}
|
|
3636
|
+
* @memberof CouponDiscountDto
|
|
3637
|
+
*/
|
|
3638
|
+
'lineItemId': string | null;
|
|
3639
|
+
/**
|
|
3640
|
+
* How many units of the line it covers; absent means the whole line
|
|
3641
|
+
* @type {number}
|
|
3642
|
+
* @memberof CouponDiscountDto
|
|
3643
|
+
*/
|
|
3644
|
+
'units'?: number;
|
|
3645
|
+
/**
|
|
3646
|
+
*
|
|
3647
|
+
* @type {DiscountSourceType}
|
|
3648
|
+
* @memberof CouponDiscountDto
|
|
3649
|
+
*/
|
|
3650
|
+
'sourceType': DiscountSourceType;
|
|
3651
|
+
/**
|
|
3652
|
+
* The Vendure promotion\'s id, as text
|
|
3653
|
+
* @type {string}
|
|
3654
|
+
* @memberof CouponDiscountDto
|
|
3655
|
+
*/
|
|
3656
|
+
'sourceId': string;
|
|
3657
|
+
/**
|
|
3658
|
+
* The coupon\'s code, as the promotion holds it
|
|
3659
|
+
* @type {string}
|
|
3660
|
+
* @memberof CouponDiscountDto
|
|
3661
|
+
*/
|
|
3662
|
+
'couponCode': string;
|
|
3663
|
+
/**
|
|
3664
|
+
* The promotion\'s name, shown on the till and the receipt
|
|
3665
|
+
* @type {string}
|
|
3666
|
+
* @memberof CouponDiscountDto
|
|
3667
|
+
*/
|
|
3668
|
+
'name': string;
|
|
3669
|
+
/**
|
|
3670
|
+
* The customerPhone the check was sent with, in E.164, for the till to keep on the order\'s discount; absent when the check named no customer
|
|
3671
|
+
* @type {string}
|
|
3672
|
+
* @memberof CouponDiscountDto
|
|
3673
|
+
*/
|
|
3674
|
+
'couponCustomerPhone'?: string;
|
|
3675
|
+
}
|
|
3676
|
+
|
|
3677
|
+
|
|
3678
|
+
/**
|
|
3679
|
+
*
|
|
3680
|
+
* @export
|
|
3681
|
+
* @enum {string}
|
|
3682
|
+
*/
|
|
3683
|
+
|
|
3684
|
+
export const CouponRefusal = {
|
|
3685
|
+
NotFound: 'NOT_FOUND',
|
|
3686
|
+
NotStarted: 'NOT_STARTED',
|
|
3687
|
+
Expired: 'EXPIRED',
|
|
3688
|
+
Disabled: 'DISABLED',
|
|
3689
|
+
NotForThisApp: 'NOT_FOR_THIS_APP',
|
|
3690
|
+
NotForThisOrderType: 'NOT_FOR_THIS_ORDER_TYPE',
|
|
3691
|
+
ConditionsNotMet: 'CONDITIONS_NOT_MET',
|
|
3692
|
+
UsageLimitReached: 'USAGE_LIMIT_REACHED',
|
|
3693
|
+
CustomerLimitReached: 'CUSTOMER_LIMIT_REACHED',
|
|
3694
|
+
NotFirstOrder: 'NOT_FIRST_ORDER',
|
|
3695
|
+
CustomerPhoneRequired: 'CUSTOMER_PHONE_REQUIRED',
|
|
3696
|
+
CouponsUnavailable: 'COUPONS_UNAVAILABLE'
|
|
3697
|
+
} as const;
|
|
3698
|
+
|
|
3699
|
+
export type CouponRefusal = typeof CouponRefusal[keyof typeof CouponRefusal];
|
|
3700
|
+
|
|
3701
|
+
|
|
3702
|
+
/**
|
|
3703
|
+
*
|
|
3704
|
+
* @export
|
|
3705
|
+
* @interface CouponRewardNotAppliedDto
|
|
3706
|
+
*/
|
|
3707
|
+
export interface CouponRewardNotAppliedDto {
|
|
3708
|
+
/**
|
|
3709
|
+
* The promotion\'s reward that was left out, in Vendure\'s words
|
|
3710
|
+
* @type {string}
|
|
3711
|
+
* @memberof CouponRewardNotAppliedDto
|
|
3712
|
+
*/
|
|
3713
|
+
'reward': string;
|
|
3714
|
+
/**
|
|
3715
|
+
* Why Vendure left it out
|
|
3716
|
+
* @type {string}
|
|
3717
|
+
* @memberof CouponRewardNotAppliedDto
|
|
3718
|
+
*/
|
|
3719
|
+
'reason': string;
|
|
3720
|
+
}
|
|
3394
3721
|
/**
|
|
3395
3722
|
*
|
|
3396
3723
|
* @export
|
|
@@ -4300,13 +4627,13 @@ export interface CreateOnboardingSessionDto {
|
|
|
4300
4627
|
*/
|
|
4301
4628
|
export interface CreatePaymentMethodDto {
|
|
4302
4629
|
/**
|
|
4303
|
-
* Attach
|
|
4630
|
+
* Attach a built-in method, or one of the venue\'s own custom methods, by its code (mutually exclusive with name+type).
|
|
4304
4631
|
* @type {string}
|
|
4305
4632
|
* @memberof CreatePaymentMethodDto
|
|
4306
4633
|
*/
|
|
4307
4634
|
'code'?: string;
|
|
4308
4635
|
/**
|
|
4309
|
-
* Display name for a new custom method; required with type when code is absent.
|
|
4636
|
+
* Display name for a new custom method of this venue only; required with type when code is absent.
|
|
4310
4637
|
* @type {string}
|
|
4311
4638
|
* @memberof CreatePaymentMethodDto
|
|
4312
4639
|
*/
|
|
@@ -4457,6 +4784,73 @@ export interface CreateRefundPlanDto {
|
|
|
4457
4784
|
}
|
|
4458
4785
|
|
|
4459
4786
|
|
|
4787
|
+
/**
|
|
4788
|
+
*
|
|
4789
|
+
* @export
|
|
4790
|
+
* @interface CreateResQOfferDto
|
|
4791
|
+
*/
|
|
4792
|
+
export interface CreateResQOfferDto {
|
|
4793
|
+
/**
|
|
4794
|
+
* The offer\'s name, as ResQ\'s customers see it
|
|
4795
|
+
* @type {string}
|
|
4796
|
+
* @memberof CreateResQOfferDto
|
|
4797
|
+
*/
|
|
4798
|
+
'name': string;
|
|
4799
|
+
/**
|
|
4800
|
+
* What the offer holds, as ResQ\'s customers see it. Left out, the offer has none
|
|
4801
|
+
* @type {string}
|
|
4802
|
+
* @memberof CreateResQOfferDto
|
|
4803
|
+
*/
|
|
4804
|
+
'description'?: string;
|
|
4805
|
+
/**
|
|
4806
|
+
* An https address of the offer\'s picture. Left out, ResQ shows none
|
|
4807
|
+
* @type {string}
|
|
4808
|
+
* @memberof CreateResQOfferDto
|
|
4809
|
+
*/
|
|
4810
|
+
'imageUrl'?: string;
|
|
4811
|
+
/**
|
|
4812
|
+
* The price a customer pays for one, in cents of the venue\'s currency. It cannot be changed later: switch the offer off and create a new one
|
|
4813
|
+
* @type {number}
|
|
4814
|
+
* @memberof CreateResQOfferDto
|
|
4815
|
+
*/
|
|
4816
|
+
'price': number;
|
|
4817
|
+
/**
|
|
4818
|
+
* How many are for sale
|
|
4819
|
+
* @type {number}
|
|
4820
|
+
* @memberof CreateResQOfferDto
|
|
4821
|
+
*/
|
|
4822
|
+
'quantity': number;
|
|
4823
|
+
/**
|
|
4824
|
+
* When customers can start ordering it, an ISO 8601 date-time
|
|
4825
|
+
* @type {string}
|
|
4826
|
+
* @memberof CreateResQOfferDto
|
|
4827
|
+
*/
|
|
4828
|
+
'orderStart': string;
|
|
4829
|
+
/**
|
|
4830
|
+
* When ordering it ends, an ISO 8601 date-time
|
|
4831
|
+
* @type {string}
|
|
4832
|
+
* @memberof CreateResQOfferDto
|
|
4833
|
+
*/
|
|
4834
|
+
'orderEnd': string;
|
|
4835
|
+
/**
|
|
4836
|
+
* When customers can start picking it up at the venue, an ISO 8601 date-time
|
|
4837
|
+
* @type {string}
|
|
4838
|
+
* @memberof CreateResQOfferDto
|
|
4839
|
+
*/
|
|
4840
|
+
'fetchStart': string;
|
|
4841
|
+
/**
|
|
4842
|
+
* When pick-up ends, an ISO 8601 date-time
|
|
4843
|
+
* @type {string}
|
|
4844
|
+
* @memberof CreateResQOfferDto
|
|
4845
|
+
*/
|
|
4846
|
+
'fetchEnd': string;
|
|
4847
|
+
/**
|
|
4848
|
+
* The kinds of offer ResQ files it under, at least one
|
|
4849
|
+
* @type {Array<ResQOfferTag>}
|
|
4850
|
+
* @memberof CreateResQOfferDto
|
|
4851
|
+
*/
|
|
4852
|
+
'tags': Array<ResQOfferTag>;
|
|
4853
|
+
}
|
|
4460
4854
|
/**
|
|
4461
4855
|
*
|
|
4462
4856
|
* @export
|
|
@@ -5950,7 +6344,7 @@ export interface DiscountDto {
|
|
|
5950
6344
|
*/
|
|
5951
6345
|
'updatedAt': string;
|
|
5952
6346
|
/**
|
|
5953
|
-
* The discount\'s id
|
|
6347
|
+
* The id the till knows the button by: the data-bridge discount\'s id for a button copied from data-bridge, 1,000,000,000 plus the Vendure promotion\'s id for any other button (one made or duplicated in Vendure), so the two never share an id
|
|
5954
6348
|
* @type {number}
|
|
5955
6349
|
* @memberof DiscountDto
|
|
5956
6350
|
*/
|
|
@@ -5980,13 +6374,13 @@ export interface DiscountDto {
|
|
|
5980
6374
|
*/
|
|
5981
6375
|
'type'?: PromotionDiscountType;
|
|
5982
6376
|
/**
|
|
5983
|
-
* The discount\'s description;
|
|
6377
|
+
* The discount\'s description; an empty string when it has none
|
|
5984
6378
|
* @type {string}
|
|
5985
6379
|
* @memberof DiscountDto
|
|
5986
6380
|
*/
|
|
5987
6381
|
'description'?: string;
|
|
5988
6382
|
/**
|
|
5989
|
-
* Whether the discount is
|
|
6383
|
+
* Whether the discount is switched on; always true, since a switched-off one is not answered
|
|
5990
6384
|
* @type {boolean}
|
|
5991
6385
|
* @memberof DiscountDto
|
|
5992
6386
|
*/
|
|
@@ -6010,7 +6404,7 @@ export interface DiscountDto {
|
|
|
6010
6404
|
*/
|
|
6011
6405
|
'maxUsesPerOrder'?: number | null;
|
|
6012
6406
|
/**
|
|
6013
|
-
*
|
|
6407
|
+
* The Vendure promotion\'s buttonOrder, which a button copied from data-bridge took from the discount\'s priority; 1 when it has none
|
|
6014
6408
|
* @type {number}
|
|
6015
6409
|
* @memberof DiscountDto
|
|
6016
6410
|
*/
|
|
@@ -6238,7 +6632,7 @@ export interface DispatchPosOrderResponseDto {
|
|
|
6238
6632
|
*/
|
|
6239
6633
|
'ticketId': object | null;
|
|
6240
6634
|
/**
|
|
6241
|
-
* Number of that ticket:
|
|
6635
|
+
* Number of that ticket: its order\'s own number. null when no ticket was written.
|
|
6242
6636
|
* @type {object}
|
|
6243
6637
|
* @memberof DispatchPosOrderResponseDto
|
|
6244
6638
|
*/
|
|
@@ -16240,7 +16634,7 @@ export interface ParkPosOrderResponseDto {
|
|
|
16240
16634
|
*/
|
|
16241
16635
|
'ticketId': object | null;
|
|
16242
16636
|
/**
|
|
16243
|
-
* Number of that ticket:
|
|
16637
|
+
* Number of that ticket: its order\'s own number. null when no ticket was written.
|
|
16244
16638
|
* @type {object}
|
|
16245
16639
|
* @memberof ParkPosOrderResponseDto
|
|
16246
16640
|
*/
|
|
@@ -18235,6 +18629,20 @@ export interface PaymentStatusDtoTransaction {
|
|
|
18235
18629
|
}
|
|
18236
18630
|
|
|
18237
18631
|
|
|
18632
|
+
/**
|
|
18633
|
+
*
|
|
18634
|
+
* @export
|
|
18635
|
+
* @enum {string}
|
|
18636
|
+
*/
|
|
18637
|
+
|
|
18638
|
+
export const PaymentSurchargePaidBy = {
|
|
18639
|
+
Business: 'BUSINESS',
|
|
18640
|
+
Customer: 'CUSTOMER'
|
|
18641
|
+
} as const;
|
|
18642
|
+
|
|
18643
|
+
export type PaymentSurchargePaidBy = typeof PaymentSurchargePaidBy[keyof typeof PaymentSurchargePaidBy];
|
|
18644
|
+
|
|
18645
|
+
|
|
18238
18646
|
/**
|
|
18239
18647
|
*
|
|
18240
18648
|
* @export
|
|
@@ -18822,6 +19230,18 @@ export interface PosDiscountDto {
|
|
|
18822
19230
|
* @memberof PosDiscountDto
|
|
18823
19231
|
*/
|
|
18824
19232
|
'units'?: number;
|
|
19233
|
+
/**
|
|
19234
|
+
* The coupon code of a PROMOTION discount the coupon check answered, as the promotion holds it; sourceId is its promotion. Once the order is paid, the coupon\'s use is counted from it. Absent on a discount no coupon gave and on orders written before coupons.
|
|
19235
|
+
* @type {string}
|
|
19236
|
+
* @memberof PosDiscountDto
|
|
19237
|
+
*/
|
|
19238
|
+
'couponCode'?: string;
|
|
19239
|
+
/**
|
|
19240
|
+
* The customer\'s phone in E.164 that the coupon was checked for, when the coupon is once per customer or for a first order only; the use is counted for this customer. Left out when the check named no customer, never sent as empty text.
|
|
19241
|
+
* @type {string}
|
|
19242
|
+
* @memberof PosDiscountDto
|
|
19243
|
+
*/
|
|
19244
|
+
'couponCustomerPhone'?: string;
|
|
18825
19245
|
}
|
|
18826
19246
|
|
|
18827
19247
|
|
|
@@ -20702,6 +21122,18 @@ export interface PosOrderItemDtoDiscount {
|
|
|
20702
21122
|
* @memberof PosOrderItemDtoDiscount
|
|
20703
21123
|
*/
|
|
20704
21124
|
'units'?: number;
|
|
21125
|
+
/**
|
|
21126
|
+
* The coupon code of a PROMOTION discount the coupon check answered, as the promotion holds it; sourceId is its promotion. Once the order is paid, the coupon\'s use is counted from it. Absent on a discount no coupon gave and on orders written before coupons.
|
|
21127
|
+
* @type {string}
|
|
21128
|
+
* @memberof PosOrderItemDtoDiscount
|
|
21129
|
+
*/
|
|
21130
|
+
'couponCode'?: string;
|
|
21131
|
+
/**
|
|
21132
|
+
* The customer\'s phone in E.164 that the coupon was checked for, when the coupon is once per customer or for a first order only; the use is counted for this customer. Left out when the check named no customer, never sent as empty text.
|
|
21133
|
+
* @type {string}
|
|
21134
|
+
* @memberof PosOrderItemDtoDiscount
|
|
21135
|
+
*/
|
|
21136
|
+
'couponCustomerPhone'?: string;
|
|
20705
21137
|
}
|
|
20706
21138
|
|
|
20707
21139
|
|
|
@@ -21476,6 +21908,72 @@ export const PreorderStatus = {
|
|
|
21476
21908
|
export type PreorderStatus = typeof PreorderStatus[keyof typeof PreorderStatus];
|
|
21477
21909
|
|
|
21478
21910
|
|
|
21911
|
+
/**
|
|
21912
|
+
*
|
|
21913
|
+
* @export
|
|
21914
|
+
* @interface PriceBasketAnswerDto
|
|
21915
|
+
*/
|
|
21916
|
+
export interface PriceBasketAnswerDto {
|
|
21917
|
+
/**
|
|
21918
|
+
* true when Vendure priced the basket; false when it could not, and nothing is known of its discounts
|
|
21919
|
+
* @type {boolean}
|
|
21920
|
+
* @memberof PriceBasketAnswerDto
|
|
21921
|
+
*/
|
|
21922
|
+
'priced': boolean;
|
|
21923
|
+
/**
|
|
21924
|
+
*
|
|
21925
|
+
* @type {BasketNotPricedReason}
|
|
21926
|
+
* @memberof PriceBasketAnswerDto
|
|
21927
|
+
*/
|
|
21928
|
+
'reason': BasketNotPricedReason | null;
|
|
21929
|
+
/**
|
|
21930
|
+
* Every line sent, in the order sent, with its discounts; empty when priced is false
|
|
21931
|
+
* @type {Array<PricedLineDto>}
|
|
21932
|
+
* @memberof PriceBasketAnswerDto
|
|
21933
|
+
*/
|
|
21934
|
+
'lines': Array<PricedLineDto>;
|
|
21935
|
+
/**
|
|
21936
|
+
* Each promotion\'s discount over the whole basket, the lines\' shares added up, one per promotion and scope: what the receipt lists. It repeats the lines\' discounts, never adds to them. Empty when none applies or when priced is false
|
|
21937
|
+
* @type {Array<PricedDiscountDto>}
|
|
21938
|
+
* @memberof PriceBasketAnswerDto
|
|
21939
|
+
*/
|
|
21940
|
+
'orderDiscounts': Array<PricedDiscountDto>;
|
|
21941
|
+
/**
|
|
21942
|
+
* The basket\'s total in cents, VAT included, after the discounts, as Vendure worked it out; null when priced is false
|
|
21943
|
+
* @type {number}
|
|
21944
|
+
* @memberof PriceBasketAnswerDto
|
|
21945
|
+
*/
|
|
21946
|
+
'subTotalWithTax': number | null;
|
|
21947
|
+
}
|
|
21948
|
+
|
|
21949
|
+
|
|
21950
|
+
/**
|
|
21951
|
+
*
|
|
21952
|
+
* @export
|
|
21953
|
+
* @interface PriceBasketDto
|
|
21954
|
+
*/
|
|
21955
|
+
export interface PriceBasketDto {
|
|
21956
|
+
/**
|
|
21957
|
+
*
|
|
21958
|
+
* @type {OrderTypePOS}
|
|
21959
|
+
* @memberof PriceBasketDto
|
|
21960
|
+
*/
|
|
21961
|
+
'orderType': OrderTypePOS;
|
|
21962
|
+
/**
|
|
21963
|
+
* The coupon codes on the order, as typed or scanned, in any letter case, priced together with the venue\'s automatic promotions. A code is priced only when it is one of the venue\'s coupons in the app; whether it may be used (its limits, the customer\'s phone, a first order) is POST .../coupons/check\'s answer. Absent or empty: no coupon
|
|
21964
|
+
* @type {Array<string>}
|
|
21965
|
+
* @memberof PriceBasketDto
|
|
21966
|
+
*/
|
|
21967
|
+
'couponCodes'?: Array<string>;
|
|
21968
|
+
/**
|
|
21969
|
+
* The order\'s lines as they stand, VAT included; priced again whenever the basket changes
|
|
21970
|
+
* @type {Array<PricingBasketLineDto>}
|
|
21971
|
+
* @memberof PriceBasketDto
|
|
21972
|
+
*/
|
|
21973
|
+
'lines': Array<PricingBasketLineDto>;
|
|
21974
|
+
}
|
|
21975
|
+
|
|
21976
|
+
|
|
21479
21977
|
/**
|
|
21480
21978
|
*
|
|
21481
21979
|
* @export
|
|
@@ -21540,6 +22038,119 @@ export const PriceType = {
|
|
|
21540
22038
|
export type PriceType = typeof PriceType[keyof typeof PriceType];
|
|
21541
22039
|
|
|
21542
22040
|
|
|
22041
|
+
/**
|
|
22042
|
+
*
|
|
22043
|
+
* @export
|
|
22044
|
+
* @interface PricedDiscountDto
|
|
22045
|
+
*/
|
|
22046
|
+
export interface PricedDiscountDto {
|
|
22047
|
+
/**
|
|
22048
|
+
*
|
|
22049
|
+
* @type {DiscountSourceType}
|
|
22050
|
+
* @memberof PricedDiscountDto
|
|
22051
|
+
*/
|
|
22052
|
+
'sourceType': DiscountSourceType;
|
|
22053
|
+
/**
|
|
22054
|
+
* The Vendure promotion\'s id, as text
|
|
22055
|
+
* @type {string}
|
|
22056
|
+
* @memberof PricedDiscountDto
|
|
22057
|
+
*/
|
|
22058
|
+
'sourceId': string;
|
|
22059
|
+
/**
|
|
22060
|
+
* The promotion\'s name, in English, else Finnish; shown on the till, the receipt and the reports
|
|
22061
|
+
* @type {string}
|
|
22062
|
+
* @memberof PricedDiscountDto
|
|
22063
|
+
*/
|
|
22064
|
+
'name': string;
|
|
22065
|
+
/**
|
|
22066
|
+
* true when Vendure applies the promotion by itself, with no code; false when one of the basket\'s coupon codes applies it
|
|
22067
|
+
* @type {boolean}
|
|
22068
|
+
* @memberof PricedDiscountDto
|
|
22069
|
+
*/
|
|
22070
|
+
'isAutomatic': boolean;
|
|
22071
|
+
/**
|
|
22072
|
+
* The coupon code as the promotion holds it; null for an automatic promotion
|
|
22073
|
+
* @type {string}
|
|
22074
|
+
* @memberof PricedDiscountDto
|
|
22075
|
+
*/
|
|
22076
|
+
'couponCode': string | null;
|
|
22077
|
+
/**
|
|
22078
|
+
*
|
|
22079
|
+
* @type {DiscountScope}
|
|
22080
|
+
* @memberof PricedDiscountDto
|
|
22081
|
+
*/
|
|
22082
|
+
'scope': DiscountScope;
|
|
22083
|
+
/**
|
|
22084
|
+
* The discount in cents, VAT included, negative, exactly as Vendure worked it out: the cents the till takes off
|
|
22085
|
+
* @type {number}
|
|
22086
|
+
* @memberof PricedDiscountDto
|
|
22087
|
+
*/
|
|
22088
|
+
'amountWithTax': number;
|
|
22089
|
+
/**
|
|
22090
|
+
* The same discount in cents before VAT, negative
|
|
22091
|
+
* @type {number}
|
|
22092
|
+
* @memberof PricedDiscountDto
|
|
22093
|
+
*/
|
|
22094
|
+
'amount': number;
|
|
22095
|
+
}
|
|
22096
|
+
|
|
22097
|
+
|
|
22098
|
+
/**
|
|
22099
|
+
*
|
|
22100
|
+
* @export
|
|
22101
|
+
* @interface PricedLineDto
|
|
22102
|
+
*/
|
|
22103
|
+
export interface PricedLineDto {
|
|
22104
|
+
/**
|
|
22105
|
+
* The line\'s id, as sent
|
|
22106
|
+
* @type {string}
|
|
22107
|
+
* @memberof PricedLineDto
|
|
22108
|
+
*/
|
|
22109
|
+
'lineItemId': string;
|
|
22110
|
+
/**
|
|
22111
|
+
* The discounts on this line, each order discount\'s share included; empty when none reaches it
|
|
22112
|
+
* @type {Array<PricedDiscountDto>}
|
|
22113
|
+
* @memberof PricedLineDto
|
|
22114
|
+
*/
|
|
22115
|
+
'discounts': Array<PricedDiscountDto>;
|
|
22116
|
+
}
|
|
22117
|
+
/**
|
|
22118
|
+
*
|
|
22119
|
+
* @export
|
|
22120
|
+
* @interface PricingBasketLineDto
|
|
22121
|
+
*/
|
|
22122
|
+
export interface PricingBasketLineDto {
|
|
22123
|
+
/**
|
|
22124
|
+
* The line\'s stable id, the one the order\'s discounts point at
|
|
22125
|
+
* @type {string}
|
|
22126
|
+
* @memberof PricingBasketLineDto
|
|
22127
|
+
*/
|
|
22128
|
+
'lineItemId': string;
|
|
22129
|
+
/**
|
|
22130
|
+
* How many of the product the line holds, a whole number
|
|
22131
|
+
* @type {number}
|
|
22132
|
+
* @memberof PricingBasketLineDto
|
|
22133
|
+
*/
|
|
22134
|
+
'quantity': number;
|
|
22135
|
+
/**
|
|
22136
|
+
* The price of one unit as the till charges it, options included, in cents
|
|
22137
|
+
* @type {number}
|
|
22138
|
+
* @memberof PricingBasketLineDto
|
|
22139
|
+
*/
|
|
22140
|
+
'unitAmount': number;
|
|
22141
|
+
/**
|
|
22142
|
+
* The line\'s VAT rate in percent (14 is 14%): the item\'s taxRate. Needed when the coupon\'s minimum order is before VAT; absent there, Vendure answers CONDITIONS_NOT_MET
|
|
22143
|
+
* @type {number}
|
|
22144
|
+
* @memberof PricingBasketLineDto
|
|
22145
|
+
*/
|
|
22146
|
+
'vatRate'?: number;
|
|
22147
|
+
/**
|
|
22148
|
+
* The product\'s Vendure id: the line\'s posId, as a number
|
|
22149
|
+
* @type {number}
|
|
22150
|
+
* @memberof PricingBasketLineDto
|
|
22151
|
+
*/
|
|
22152
|
+
'productId'?: number;
|
|
22153
|
+
}
|
|
21543
22154
|
/**
|
|
21544
22155
|
*
|
|
21545
22156
|
* @export
|
|
@@ -24267,7 +24878,9 @@ export const ReportChangeField = {
|
|
|
24267
24878
|
PaymentReportSummaryTotalSurchargeAmount: 'paymentReport.summary.totalSurchargeAmount',
|
|
24268
24879
|
PaymentReportSummaryTotalRefunds: 'paymentReport.summary.totalRefunds',
|
|
24269
24880
|
PaymentReportSummaryRefundCount: 'paymentReport.summary.refundCount',
|
|
24270
|
-
PaymentReportTotalDiscounts: 'paymentReport.totalDiscounts'
|
|
24881
|
+
PaymentReportTotalDiscounts: 'paymentReport.totalDiscounts',
|
|
24882
|
+
OrderCount: 'orderCount',
|
|
24883
|
+
AverageOrderValue: 'averageOrderValue'
|
|
24271
24884
|
} as const;
|
|
24272
24885
|
|
|
24273
24886
|
export type ReportChangeField = typeof ReportChangeField[keyof typeof ReportChangeField];
|
|
@@ -24393,6 +25006,254 @@ export interface RequestSessionTokenResponseDto {
|
|
|
24393
25006
|
*/
|
|
24394
25007
|
'sessionChannel': string;
|
|
24395
25008
|
}
|
|
25009
|
+
/**
|
|
25010
|
+
*
|
|
25011
|
+
* @export
|
|
25012
|
+
* @interface ResQOfferDto
|
|
25013
|
+
*/
|
|
25014
|
+
export interface ResQOfferDto {
|
|
25015
|
+
/**
|
|
25016
|
+
* The offer\'s id at ResQ
|
|
25017
|
+
* @type {string}
|
|
25018
|
+
* @memberof ResQOfferDto
|
|
25019
|
+
*/
|
|
25020
|
+
'id': string;
|
|
25021
|
+
/**
|
|
25022
|
+
* The offer\'s name. Absent when ResQ did not send it
|
|
25023
|
+
* @type {string}
|
|
25024
|
+
* @memberof ResQOfferDto
|
|
25025
|
+
*/
|
|
25026
|
+
'name'?: string;
|
|
25027
|
+
/**
|
|
25028
|
+
* Whether the offer is on sale. An offer switched off stays off: it cannot be turned back on. Absent when ResQ did not send it: read the offer list to know
|
|
25029
|
+
* @type {boolean}
|
|
25030
|
+
* @memberof ResQOfferDto
|
|
25031
|
+
*/
|
|
25032
|
+
'active'?: boolean;
|
|
25033
|
+
/**
|
|
25034
|
+
* The price of one, in cents of the venue\'s currency. Absent when ResQ did not send it
|
|
25035
|
+
* @type {number}
|
|
25036
|
+
* @memberof ResQOfferDto
|
|
25037
|
+
*/
|
|
25038
|
+
'price'?: number;
|
|
25039
|
+
/**
|
|
25040
|
+
* When ordering starts, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
25041
|
+
* @type {string}
|
|
25042
|
+
* @memberof ResQOfferDto
|
|
25043
|
+
*/
|
|
25044
|
+
'orderStart'?: string;
|
|
25045
|
+
/**
|
|
25046
|
+
* When ordering ends, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
25047
|
+
* @type {string}
|
|
25048
|
+
* @memberof ResQOfferDto
|
|
25049
|
+
*/
|
|
25050
|
+
'orderEnd'?: string;
|
|
25051
|
+
}
|
|
25052
|
+
/**
|
|
25053
|
+
*
|
|
25054
|
+
* @export
|
|
25055
|
+
* @enum {string}
|
|
25056
|
+
*/
|
|
25057
|
+
|
|
25058
|
+
export const ResQOfferTag = {
|
|
25059
|
+
Meal: 'meal',
|
|
25060
|
+
Snack: 'snack',
|
|
25061
|
+
Ingredients: 'ingredients',
|
|
25062
|
+
GroceryBag: 'grocery-bag',
|
|
25063
|
+
Dessert: 'dessert',
|
|
25064
|
+
Flowers: 'flowers',
|
|
25065
|
+
Fee: 'fee',
|
|
25066
|
+
Wholesale: 'wholesale',
|
|
25067
|
+
HomeCosmetics: 'home-cosmetics'
|
|
25068
|
+
} as const;
|
|
25069
|
+
|
|
25070
|
+
export type ResQOfferTag = typeof ResQOfferTag[keyof typeof ResQOfferTag];
|
|
25071
|
+
|
|
25072
|
+
|
|
25073
|
+
/**
|
|
25074
|
+
*
|
|
25075
|
+
* @export
|
|
25076
|
+
* @interface ResQOffersPageDto
|
|
25077
|
+
*/
|
|
25078
|
+
export interface ResQOffersPageDto {
|
|
25079
|
+
/**
|
|
25080
|
+
* The venue\'s offers on this page, as ResQ orders them
|
|
25081
|
+
* @type {Array<ResQOfferDto>}
|
|
25082
|
+
* @memberof ResQOffersPageDto
|
|
25083
|
+
*/
|
|
25084
|
+
'offers': Array<ResQOfferDto>;
|
|
25085
|
+
/**
|
|
25086
|
+
* This page\'s number, from 1
|
|
25087
|
+
* @type {number}
|
|
25088
|
+
* @memberof ResQOffersPageDto
|
|
25089
|
+
*/
|
|
25090
|
+
'page': number;
|
|
25091
|
+
/**
|
|
25092
|
+
* How many pages there are
|
|
25093
|
+
* @type {number}
|
|
25094
|
+
* @memberof ResQOffersPageDto
|
|
25095
|
+
*/
|
|
25096
|
+
'pages': number;
|
|
25097
|
+
/**
|
|
25098
|
+
* How many offers the venue has, on every page
|
|
25099
|
+
* @type {number}
|
|
25100
|
+
* @memberof ResQOffersPageDto
|
|
25101
|
+
*/
|
|
25102
|
+
'count': number;
|
|
25103
|
+
}
|
|
25104
|
+
/**
|
|
25105
|
+
*
|
|
25106
|
+
* @export
|
|
25107
|
+
* @interface ResQOrderDto
|
|
25108
|
+
*/
|
|
25109
|
+
export interface ResQOrderDto {
|
|
25110
|
+
/**
|
|
25111
|
+
* The order\'s id at ResQ
|
|
25112
|
+
* @type {string}
|
|
25113
|
+
* @memberof ResQOrderDto
|
|
25114
|
+
*/
|
|
25115
|
+
'id': string;
|
|
25116
|
+
/**
|
|
25117
|
+
* The order\'s status in ResQ\'s own words, passed on as ResQ answered it
|
|
25118
|
+
* @type {string}
|
|
25119
|
+
* @memberof ResQOrderDto
|
|
25120
|
+
*/
|
|
25121
|
+
'status': string;
|
|
25122
|
+
/**
|
|
25123
|
+
* Whether ResQ counts the order as a sale
|
|
25124
|
+
* @type {boolean}
|
|
25125
|
+
* @memberof ResQOrderDto
|
|
25126
|
+
*/
|
|
25127
|
+
'sold': boolean;
|
|
25128
|
+
/**
|
|
25129
|
+
* The customer\'s first name; null when ResQ gave none
|
|
25130
|
+
* @type {string}
|
|
25131
|
+
* @memberof ResQOrderDto
|
|
25132
|
+
*/
|
|
25133
|
+
'customerFirstName': string | null;
|
|
25134
|
+
/**
|
|
25135
|
+
* When pick-up starts, an ISO 8601 date-time; null when ResQ gave none
|
|
25136
|
+
* @type {string}
|
|
25137
|
+
* @memberof ResQOrderDto
|
|
25138
|
+
*/
|
|
25139
|
+
'fetchStart': string | null;
|
|
25140
|
+
/**
|
|
25141
|
+
* When pick-up ends, an ISO 8601 date-time; null when ResQ gave none
|
|
25142
|
+
* @type {string}
|
|
25143
|
+
* @memberof ResQOrderDto
|
|
25144
|
+
*/
|
|
25145
|
+
'fetchEnd': string | null;
|
|
25146
|
+
/**
|
|
25147
|
+
* Whether the customer has picked the order up; null when ResQ did not say
|
|
25148
|
+
* @type {boolean}
|
|
25149
|
+
* @memberof ResQOrderDto
|
|
25150
|
+
*/
|
|
25151
|
+
'pickedUp': boolean | null;
|
|
25152
|
+
/**
|
|
25153
|
+
* When the customer picked the order up, an ISO 8601 date-time; null when not picked up or ResQ did not say
|
|
25154
|
+
* @type {string}
|
|
25155
|
+
* @memberof ResQOrderDto
|
|
25156
|
+
*/
|
|
25157
|
+
'pickedUpAt': string | null;
|
|
25158
|
+
/**
|
|
25159
|
+
* How many the customer ordered; null when ResQ gave none
|
|
25160
|
+
* @type {number}
|
|
25161
|
+
* @memberof ResQOrderDto
|
|
25162
|
+
*/
|
|
25163
|
+
'quantity': number | null;
|
|
25164
|
+
/**
|
|
25165
|
+
* What the order sold for, in cents of its currency; null when ResQ gave none
|
|
25166
|
+
* @type {number}
|
|
25167
|
+
* @memberof ResQOrderDto
|
|
25168
|
+
*/
|
|
25169
|
+
'sales': number | null;
|
|
25170
|
+
/**
|
|
25171
|
+
* The order\'s currency, an ISO 4217 code; null when ResQ gave none
|
|
25172
|
+
* @type {string}
|
|
25173
|
+
* @memberof ResQOrderDto
|
|
25174
|
+
*/
|
|
25175
|
+
'currency': string | null;
|
|
25176
|
+
}
|
|
25177
|
+
/**
|
|
25178
|
+
*
|
|
25179
|
+
* @export
|
|
25180
|
+
* @interface ResQOrderSummaryDto
|
|
25181
|
+
*/
|
|
25182
|
+
export interface ResQOrderSummaryDto {
|
|
25183
|
+
/**
|
|
25184
|
+
* The order\'s id at ResQ
|
|
25185
|
+
* @type {string}
|
|
25186
|
+
* @memberof ResQOrderSummaryDto
|
|
25187
|
+
*/
|
|
25188
|
+
'id': string;
|
|
25189
|
+
/**
|
|
25190
|
+
* The order\'s status in ResQ\'s own words, passed on as ResQ answered it
|
|
25191
|
+
* @type {string}
|
|
25192
|
+
* @memberof ResQOrderSummaryDto
|
|
25193
|
+
*/
|
|
25194
|
+
'status': string;
|
|
25195
|
+
/**
|
|
25196
|
+
* Whether ResQ counts the order as a sale
|
|
25197
|
+
* @type {boolean}
|
|
25198
|
+
* @memberof ResQOrderSummaryDto
|
|
25199
|
+
*/
|
|
25200
|
+
'sold': boolean;
|
|
25201
|
+
/**
|
|
25202
|
+
* When the customer ordered, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
25203
|
+
* @type {string}
|
|
25204
|
+
* @memberof ResQOrderSummaryDto
|
|
25205
|
+
*/
|
|
25206
|
+
'createdAt'?: string;
|
|
25207
|
+
/**
|
|
25208
|
+
* How many the customer ordered. Absent when ResQ did not send it
|
|
25209
|
+
* @type {number}
|
|
25210
|
+
* @memberof ResQOrderSummaryDto
|
|
25211
|
+
*/
|
|
25212
|
+
'quantity'?: number;
|
|
25213
|
+
/**
|
|
25214
|
+
* What the order sold for, in cents of its currency. Absent when ResQ did not send it
|
|
25215
|
+
* @type {number}
|
|
25216
|
+
* @memberof ResQOrderSummaryDto
|
|
25217
|
+
*/
|
|
25218
|
+
'sales'?: number;
|
|
25219
|
+
/**
|
|
25220
|
+
* The order\'s currency, an ISO 4217 code. Absent when ResQ did not send it
|
|
25221
|
+
* @type {string}
|
|
25222
|
+
* @memberof ResQOrderSummaryDto
|
|
25223
|
+
*/
|
|
25224
|
+
'currency'?: string;
|
|
25225
|
+
}
|
|
25226
|
+
/**
|
|
25227
|
+
*
|
|
25228
|
+
* @export
|
|
25229
|
+
* @interface ResQOrdersPageDto
|
|
25230
|
+
*/
|
|
25231
|
+
export interface ResQOrdersPageDto {
|
|
25232
|
+
/**
|
|
25233
|
+
* The venue\'s ResQ orders on this page, as ResQ orders them
|
|
25234
|
+
* @type {Array<ResQOrderSummaryDto>}
|
|
25235
|
+
* @memberof ResQOrdersPageDto
|
|
25236
|
+
*/
|
|
25237
|
+
'orders': Array<ResQOrderSummaryDto>;
|
|
25238
|
+
/**
|
|
25239
|
+
* This page\'s number, from 1
|
|
25240
|
+
* @type {number}
|
|
25241
|
+
* @memberof ResQOrdersPageDto
|
|
25242
|
+
*/
|
|
25243
|
+
'page': number;
|
|
25244
|
+
/**
|
|
25245
|
+
* How many pages there are
|
|
25246
|
+
* @type {number}
|
|
25247
|
+
* @memberof ResQOrdersPageDto
|
|
25248
|
+
*/
|
|
25249
|
+
'pages': number;
|
|
25250
|
+
/**
|
|
25251
|
+
* How many orders the venue has, on every page
|
|
25252
|
+
* @type {number}
|
|
25253
|
+
* @memberof ResQOrdersPageDto
|
|
25254
|
+
*/
|
|
25255
|
+
'count': number;
|
|
25256
|
+
}
|
|
24396
25257
|
/**
|
|
24397
25258
|
*
|
|
24398
25259
|
* @export
|
|
@@ -24965,6 +25826,18 @@ export interface SalesReportComparisonDto {
|
|
|
24965
25826
|
* @memberof SalesReportComparisonDto
|
|
24966
25827
|
*/
|
|
24967
25828
|
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
25829
|
+
/**
|
|
25830
|
+
* Part summary: how many orders were sold, the sum of dailyBreakdown[].orders. POS counts orders as the till does, so a split bill counts once; kiosk, storefront and mobile count each of their orders once. A group that adds apps together (breakdown none or venue) adds POS\'s count to the other apps\' counts. Wolt, Foodora and other platform orders are not included. Count orders with this, never with paymentReport.summary.totalCount, which counts payments. Left out without part summary
|
|
25831
|
+
* @type {number}
|
|
25832
|
+
* @memberof SalesReportComparisonDto
|
|
25833
|
+
*/
|
|
25834
|
+
'orderCount'?: number;
|
|
25835
|
+
/**
|
|
25836
|
+
* Part summary: what was paid, refunds taken off (paymentReport.summary.salesAndRevenue), divided by orderCount, rounded half up to the currency\'s minor digits, in the major unit of the group\'s currency (euros for EUR). Null when no order was sold, and then its change is left out of changes and changesFromBaseline. Left out without part summary
|
|
25837
|
+
* @type {number}
|
|
25838
|
+
* @memberof SalesReportComparisonDto
|
|
25839
|
+
*/
|
|
25840
|
+
'averageOrderValue'?: number | null;
|
|
24968
25841
|
/**
|
|
24969
25842
|
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
24970
25843
|
* @type {Array<SalesReportChangeDto>}
|
|
@@ -25071,7 +25944,7 @@ export interface SalesReportDayDto {
|
|
|
25071
25944
|
*/
|
|
25072
25945
|
'date': string;
|
|
25073
25946
|
/**
|
|
25074
|
-
* How many orders were sold that day
|
|
25947
|
+
* How many orders were sold that day. POS counts them as the till\'s end-of-day report does: an order refunded in full is not counted, one refunded in part, unpaid or at 0 is. Kiosk, storefront and mobile count the orders with items not refunded in full, a kiosk order only when paid
|
|
25075
25948
|
* @type {number}
|
|
25076
25949
|
* @memberof SalesReportDayDto
|
|
25077
25950
|
*/
|
|
@@ -25186,6 +26059,18 @@ export interface SalesReportGroupDto {
|
|
|
25186
26059
|
* @memberof SalesReportGroupDto
|
|
25187
26060
|
*/
|
|
25188
26061
|
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
26062
|
+
/**
|
|
26063
|
+
* Part summary: how many orders were sold, the sum of dailyBreakdown[].orders. POS counts orders as the till does, so a split bill counts once; kiosk, storefront and mobile count each of their orders once. A group that adds apps together (breakdown none or venue) adds POS\'s count to the other apps\' counts. Wolt, Foodora and other platform orders are not included. Count orders with this, never with paymentReport.summary.totalCount, which counts payments. Left out without part summary
|
|
26064
|
+
* @type {number}
|
|
26065
|
+
* @memberof SalesReportGroupDto
|
|
26066
|
+
*/
|
|
26067
|
+
'orderCount'?: number;
|
|
26068
|
+
/**
|
|
26069
|
+
* Part summary: what was paid, refunds taken off (paymentReport.summary.salesAndRevenue), divided by orderCount, rounded half up to the currency\'s minor digits, in the major unit of the group\'s currency (euros for EUR). Null when no order was sold, and then its change is left out of changes and changesFromBaseline. Left out without part summary
|
|
26070
|
+
* @type {number}
|
|
26071
|
+
* @memberof SalesReportGroupDto
|
|
26072
|
+
*/
|
|
26073
|
+
'averageOrderValue'?: number | null;
|
|
25189
26074
|
/**
|
|
25190
26075
|
*
|
|
25191
26076
|
* @type {SalesReportGroupDtoComparison}
|
|
@@ -25255,6 +26140,18 @@ export interface SalesReportGroupDtoComparison {
|
|
|
25255
26140
|
* @memberof SalesReportGroupDtoComparison
|
|
25256
26141
|
*/
|
|
25257
26142
|
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
26143
|
+
/**
|
|
26144
|
+
* Part summary: how many orders were sold, the sum of dailyBreakdown[].orders. POS counts orders as the till does, so a split bill counts once; kiosk, storefront and mobile count each of their orders once. A group that adds apps together (breakdown none or venue) adds POS\'s count to the other apps\' counts. Wolt, Foodora and other platform orders are not included. Count orders with this, never with paymentReport.summary.totalCount, which counts payments. Left out without part summary
|
|
26145
|
+
* @type {number}
|
|
26146
|
+
* @memberof SalesReportGroupDtoComparison
|
|
26147
|
+
*/
|
|
26148
|
+
'orderCount'?: number;
|
|
26149
|
+
/**
|
|
26150
|
+
* Part summary: what was paid, refunds taken off (paymentReport.summary.salesAndRevenue), divided by orderCount, rounded half up to the currency\'s minor digits, in the major unit of the group\'s currency (euros for EUR). Null when no order was sold, and then its change is left out of changes and changesFromBaseline. Left out without part summary
|
|
26151
|
+
* @type {number}
|
|
26152
|
+
* @memberof SalesReportGroupDtoComparison
|
|
26153
|
+
*/
|
|
26154
|
+
'averageOrderValue'?: number | null;
|
|
25258
26155
|
/**
|
|
25259
26156
|
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
25260
26157
|
* @type {Array<SalesReportChangeDto>}
|
|
@@ -26132,6 +27029,34 @@ export interface SendReportEmailDto {
|
|
|
26132
27029
|
}
|
|
26133
27030
|
|
|
26134
27031
|
|
|
27032
|
+
/**
|
|
27033
|
+
*
|
|
27034
|
+
* @export
|
|
27035
|
+
* @interface ServeMcpRequest403Response
|
|
27036
|
+
*/
|
|
27037
|
+
export interface ServeMcpRequest403Response {
|
|
27038
|
+
/**
|
|
27039
|
+
* Why the person\'s request is refused
|
|
27040
|
+
* @type {string}
|
|
27041
|
+
* @memberof ServeMcpRequest403Response
|
|
27042
|
+
*/
|
|
27043
|
+
'error'?: ErrorEnum;
|
|
27044
|
+
/**
|
|
27045
|
+
* With NOT_STORE_OWNER: each venue a tool call named that the person does not own
|
|
27046
|
+
* @type {Array<any>}
|
|
27047
|
+
* @memberof ServeMcpRequest403Response
|
|
27048
|
+
*/
|
|
27049
|
+
'venueIds'?: Array<any>;
|
|
27050
|
+
}
|
|
27051
|
+
|
|
27052
|
+
export const ErrorEnum = {
|
|
27053
|
+
NoAriAccess: 'NO_ARI_ACCESS',
|
|
27054
|
+
NotStoreOwner: 'NOT_STORE_OWNER',
|
|
27055
|
+
RightsUnavailable: 'RIGHTS_UNAVAILABLE'
|
|
27056
|
+
} as const;
|
|
27057
|
+
|
|
27058
|
+
export type ErrorEnum = typeof ErrorEnum[keyof typeof ErrorEnum];
|
|
27059
|
+
|
|
26135
27060
|
/**
|
|
26136
27061
|
*
|
|
26137
27062
|
* @export
|
|
@@ -32025,17 +32950,23 @@ export interface UpsertProvidersDto {
|
|
|
32025
32950
|
*/
|
|
32026
32951
|
'sourceCode'?: string;
|
|
32027
32952
|
/**
|
|
32028
|
-
* Viva ISV commission rate, in percent, at most two decimals. A change is saved on the license server first.
|
|
32953
|
+
* Viva ISV commission rate, in percent, at most two decimals. A change is saved on the license server first. Set by Munchi only: a venue\'s ticket or a partner\'s key that changes it is refused with 403 MUNCHI_ONLY_SETTING, and nothing is saved. The stored rate sent back unchanged is not a change.
|
|
32029
32954
|
* @type {number}
|
|
32030
32955
|
* @memberof UpsertProvidersDto
|
|
32031
32956
|
*/
|
|
32032
32957
|
'rate'?: number;
|
|
32033
32958
|
/**
|
|
32034
|
-
* Viva ISV fixed fee per payment, in cents. A change is saved on the license server first.
|
|
32959
|
+
* Viva ISV fixed fee per payment, in cents. A change is saved on the license server first. Set by Munchi only: a venue\'s ticket or a partner\'s key that changes it is refused with 403 MUNCHI_ONLY_SETTING, and nothing is saved. The stored amount sent back unchanged is not a change.
|
|
32035
32960
|
* @type {number}
|
|
32036
32961
|
* @memberof UpsertProvidersDto
|
|
32037
32962
|
*/
|
|
32038
32963
|
'additionalAmount'?: number;
|
|
32964
|
+
/**
|
|
32965
|
+
*
|
|
32966
|
+
* @type {PaymentSurchargePaidBy}
|
|
32967
|
+
* @memberof UpsertProvidersDto
|
|
32968
|
+
*/
|
|
32969
|
+
'surchargePaidBy'?: PaymentSurchargePaidBy;
|
|
32039
32970
|
/**
|
|
32040
32971
|
* Nets / Stripe / Worldline secret key. Absent keeps the stored value.
|
|
32041
32972
|
* @type {string}
|
|
@@ -32170,6 +33101,12 @@ export interface UpsertVivaDto {
|
|
|
32170
33101
|
* @memberof UpsertVivaDto
|
|
32171
33102
|
*/
|
|
32172
33103
|
'isActive'?: boolean;
|
|
33104
|
+
/**
|
|
33105
|
+
*
|
|
33106
|
+
* @type {PaymentSurchargePaidBy}
|
|
33107
|
+
* @memberof UpsertVivaDto
|
|
33108
|
+
*/
|
|
33109
|
+
'surchargePaidBy'?: PaymentSurchargePaidBy;
|
|
32173
33110
|
/**
|
|
32174
33111
|
*
|
|
32175
33112
|
* @type {UpsertVivaDtoConfig}
|
|
@@ -32177,6 +33114,8 @@ export interface UpsertVivaDto {
|
|
|
32177
33114
|
*/
|
|
32178
33115
|
'config'?: UpsertVivaDtoConfig;
|
|
32179
33116
|
}
|
|
33117
|
+
|
|
33118
|
+
|
|
32180
33119
|
/**
|
|
32181
33120
|
* The Viva settings, merged over the stored ones: a key sent replaces the stored key, a key absent keeps it.
|
|
32182
33121
|
* @export
|
|
@@ -32184,7 +33123,7 @@ export interface UpsertVivaDto {
|
|
|
32184
33123
|
*/
|
|
32185
33124
|
export interface UpsertVivaDtoConfig {
|
|
32186
33125
|
/**
|
|
32187
|
-
* The Viva ISV commission rate, in percent, at most two decimals. A new config sent without one takes the license server\'s rate. A change is saved on the license server first.
|
|
33126
|
+
* The Viva ISV commission rate, in percent, at most two decimals. A new config sent without one takes the license server\'s rate. A change is saved on the license server first. Set by Munchi only: a venue\'s ticket or a partner\'s key that changes it is refused with 403 MUNCHI_ONLY_SETTING, and nothing is saved. The stored rate sent back unchanged is not a change.
|
|
32188
33127
|
* @type {number}
|
|
32189
33128
|
* @memberof UpsertVivaDtoConfig
|
|
32190
33129
|
*/
|
|
@@ -32202,7 +33141,7 @@ export interface UpsertVivaDtoConfig {
|
|
|
32202
33141
|
*/
|
|
32203
33142
|
'sourceCode'?: string;
|
|
32204
33143
|
/**
|
|
32205
|
-
* The fixed Viva ISV fee per payment, in cents. A new config sent without a rate takes the license server\'s amount. A change is saved on the license server first.
|
|
33144
|
+
* The fixed Viva ISV fee per payment, in cents. A new config sent without a rate takes the license server\'s amount. A change is saved on the license server first. Set by Munchi only: a venue\'s ticket or a partner\'s key that changes it is refused with 403 MUNCHI_ONLY_SETTING, and nothing is saved. The stored amount sent back unchanged is not a change.
|
|
32206
33145
|
* @type {number}
|
|
32207
33146
|
* @memberof UpsertVivaDtoConfig
|
|
32208
33147
|
*/
|
|
@@ -33131,7 +34070,7 @@ export interface VivaCancelTransactionDto {
|
|
|
33131
34070
|
*/
|
|
33132
34071
|
export interface VivaConfigDto {
|
|
33133
34072
|
/**
|
|
33134
|
-
* The Viva ISV commission rate, in percent, at most two decimals. A new config sent without one takes the license server\'s rate. A change is saved on the license server first.
|
|
34073
|
+
* The Viva ISV commission rate, in percent, at most two decimals. A new config sent without one takes the license server\'s rate. A change is saved on the license server first. Set by Munchi only: a venue\'s ticket or a partner\'s key that changes it is refused with 403 MUNCHI_ONLY_SETTING, and nothing is saved. The stored rate sent back unchanged is not a change.
|
|
33135
34074
|
* @type {number}
|
|
33136
34075
|
* @memberof VivaConfigDto
|
|
33137
34076
|
*/
|
|
@@ -33149,7 +34088,7 @@ export interface VivaConfigDto {
|
|
|
33149
34088
|
*/
|
|
33150
34089
|
'sourceCode'?: string;
|
|
33151
34090
|
/**
|
|
33152
|
-
* The fixed Viva ISV fee per payment, in cents. A new config sent without a rate takes the license server\'s amount. A change is saved on the license server first.
|
|
34091
|
+
* The fixed Viva ISV fee per payment, in cents. A new config sent without a rate takes the license server\'s amount. A change is saved on the license server first. Set by Munchi only: a venue\'s ticket or a partner\'s key that changes it is refused with 403 MUNCHI_ONLY_SETTING, and nothing is saved. The stored amount sent back unchanged is not a change.
|
|
33153
34092
|
* @type {number}
|
|
33154
34093
|
* @memberof VivaConfigDto
|
|
33155
34094
|
*/
|
|
@@ -36201,7 +37140,7 @@ export class AuthApi extends BaseAPI implements AuthApiInterface {
|
|
|
36201
37140
|
export const BusinessApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36202
37141
|
return {
|
|
36203
37142
|
/**
|
|
36204
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
37143
|
+
* For the channel the x-app-x header names (any channel when it names none), read from Vendure\'s manual promotions. Kept 30 days per venue and channel; cleared when Vendure announces a change of the venue\'s promotions. A failed read is not kept.
|
|
36205
37144
|
* @summary Get unified discounts for all business and venue
|
|
36206
37145
|
* @param {string} businessId The venue\'s business id
|
|
36207
37146
|
* @param {*} [options] Override http request option.
|
|
@@ -36925,7 +37864,7 @@ export const BusinessApiFp = function(configuration?: Configuration) {
|
|
|
36925
37864
|
const localVarAxiosParamCreator = BusinessApiAxiosParamCreator(configuration)
|
|
36926
37865
|
return {
|
|
36927
37866
|
/**
|
|
36928
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
37867
|
+
* For the channel the x-app-x header names (any channel when it names none), read from Vendure\'s manual promotions. Kept 30 days per venue and channel; cleared when Vendure announces a change of the venue\'s promotions. A failed read is not kept.
|
|
36929
37868
|
* @summary Get unified discounts for all business and venue
|
|
36930
37869
|
* @param {string} businessId The venue\'s business id
|
|
36931
37870
|
* @param {*} [options] Override http request option.
|
|
@@ -37135,7 +38074,7 @@ export const BusinessApiFactory = function (configuration?: Configuration, baseP
|
|
|
37135
38074
|
const localVarFp = BusinessApiFp(configuration)
|
|
37136
38075
|
return {
|
|
37137
38076
|
/**
|
|
37138
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
38077
|
+
* For the channel the x-app-x header names (any channel when it names none), read from Vendure\'s manual promotions. Kept 30 days per venue and channel; cleared when Vendure announces a change of the venue\'s promotions. A failed read is not kept.
|
|
37139
38078
|
* @summary Get unified discounts for all business and venue
|
|
37140
38079
|
* @param {string} businessId The venue\'s business id
|
|
37141
38080
|
* @param {*} [options] Override http request option.
|
|
@@ -37327,7 +38266,7 @@ export const BusinessApiFactory = function (configuration?: Configuration, baseP
|
|
|
37327
38266
|
*/
|
|
37328
38267
|
export interface BusinessApiInterface {
|
|
37329
38268
|
/**
|
|
37330
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
38269
|
+
* For the channel the x-app-x header names (any channel when it names none), read from Vendure\'s manual promotions. Kept 30 days per venue and channel; cleared when Vendure announces a change of the venue\'s promotions. A failed read is not kept.
|
|
37331
38270
|
* @summary Get unified discounts for all business and venue
|
|
37332
38271
|
* @param {string} businessId The venue\'s business id
|
|
37333
38272
|
* @param {*} [options] Override http request option.
|
|
@@ -37519,7 +38458,7 @@ export interface BusinessApiInterface {
|
|
|
37519
38458
|
*/
|
|
37520
38459
|
export class BusinessApi extends BaseAPI implements BusinessApiInterface {
|
|
37521
38460
|
/**
|
|
37522
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
38461
|
+
* For the channel the x-app-x header names (any channel when it names none), read from Vendure\'s manual promotions. Kept 30 days per venue and channel; cleared when Vendure announces a change of the venue\'s promotions. A failed read is not kept.
|
|
37523
38462
|
* @summary Get unified discounts for all business and venue
|
|
37524
38463
|
* @param {string} businessId The venue\'s business id
|
|
37525
38464
|
* @param {*} [options] Override http request option.
|
|
@@ -40601,6 +41540,230 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
40601
41540
|
}
|
|
40602
41541
|
|
|
40603
41542
|
|
|
41543
|
+
/**
|
|
41544
|
+
* CouponsApi - axios parameter creator
|
|
41545
|
+
* @export
|
|
41546
|
+
*/
|
|
41547
|
+
export const CouponsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
41548
|
+
return {
|
|
41549
|
+
/**
|
|
41550
|
+
* Vendure checks the coupon for the venue, the app of the ticket, the order type, the customer\'s phone and the basket, and answers its discounts in the till\'s discount shape; nothing is stored or reserved. Check again whenever the basket changes and before payment. The use is counted once the order is paid, from the order\'s discounts. A coupon that does not apply, and Vendure not answering within 2 seconds, are answered 200 with valid false, a reason and a message to show.
|
|
41551
|
+
* @summary Check a coupon against a till\'s basket
|
|
41552
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41553
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41554
|
+
* @param {*} [options] Override http request option.
|
|
41555
|
+
* @throws {RequiredError}
|
|
41556
|
+
*/
|
|
41557
|
+
checkCoupon: async (businessId: number, checkCouponDto: CheckCouponDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41558
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41559
|
+
assertParamExists('checkCoupon', 'businessId', businessId)
|
|
41560
|
+
// verify required parameter 'checkCouponDto' is not null or undefined
|
|
41561
|
+
assertParamExists('checkCoupon', 'checkCouponDto', checkCouponDto)
|
|
41562
|
+
const localVarPath = `/api/v2/venues/{businessId}/coupons/check`
|
|
41563
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
41564
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41565
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41566
|
+
let baseOptions;
|
|
41567
|
+
if (configuration) {
|
|
41568
|
+
baseOptions = configuration.baseOptions;
|
|
41569
|
+
}
|
|
41570
|
+
|
|
41571
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
41572
|
+
const localVarHeaderParameter = {} as any;
|
|
41573
|
+
const localVarQueryParameter = {} as any;
|
|
41574
|
+
|
|
41575
|
+
// authentication JWT-auth required
|
|
41576
|
+
// http bearer authentication required
|
|
41577
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41578
|
+
|
|
41579
|
+
|
|
41580
|
+
|
|
41581
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
41582
|
+
|
|
41583
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41584
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41585
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41586
|
+
localVarRequestOptions.data = serializeDataIfNeeded(checkCouponDto, localVarRequestOptions, configuration)
|
|
41587
|
+
|
|
41588
|
+
return {
|
|
41589
|
+
url: toPathString(localVarUrlObj),
|
|
41590
|
+
options: localVarRequestOptions,
|
|
41591
|
+
};
|
|
41592
|
+
},
|
|
41593
|
+
/**
|
|
41594
|
+
* The kiosk\'s coupon check, with the kiosk\'s key as its order sync: the same check as the till\'s, for the kiosk app. Vendure checks the coupon for the venue, the order type, the customer\'s phone and the basket, and answers its discounts in the order\'s discount shape; nothing is stored or reserved. The use is counted once the order is paid, from the order\'s discounts. A coupon that does not apply, and Vendure not answering within 2 seconds, are answered 200 with valid false, a reason and a message to show.
|
|
41595
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
41596
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
41597
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41598
|
+
* @param {*} [options] Override http request option.
|
|
41599
|
+
* @throws {RequiredError}
|
|
41600
|
+
*/
|
|
41601
|
+
checkKioskCoupon: async (businessId: number, checkCouponDto: CheckCouponDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41602
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41603
|
+
assertParamExists('checkKioskCoupon', 'businessId', businessId)
|
|
41604
|
+
// verify required parameter 'checkCouponDto' is not null or undefined
|
|
41605
|
+
assertParamExists('checkKioskCoupon', 'checkCouponDto', checkCouponDto)
|
|
41606
|
+
const localVarPath = `/api/v2/kiosk/venues/{businessId}/coupons/check`
|
|
41607
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
41608
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41609
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41610
|
+
let baseOptions;
|
|
41611
|
+
if (configuration) {
|
|
41612
|
+
baseOptions = configuration.baseOptions;
|
|
41613
|
+
}
|
|
41614
|
+
|
|
41615
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
41616
|
+
const localVarHeaderParameter = {} as any;
|
|
41617
|
+
const localVarQueryParameter = {} as any;
|
|
41618
|
+
|
|
41619
|
+
|
|
41620
|
+
|
|
41621
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
41622
|
+
|
|
41623
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41624
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41625
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41626
|
+
localVarRequestOptions.data = serializeDataIfNeeded(checkCouponDto, localVarRequestOptions, configuration)
|
|
41627
|
+
|
|
41628
|
+
return {
|
|
41629
|
+
url: toPathString(localVarUrlObj),
|
|
41630
|
+
options: localVarRequestOptions,
|
|
41631
|
+
};
|
|
41632
|
+
},
|
|
41633
|
+
}
|
|
41634
|
+
};
|
|
41635
|
+
|
|
41636
|
+
/**
|
|
41637
|
+
* CouponsApi - functional programming interface
|
|
41638
|
+
* @export
|
|
41639
|
+
*/
|
|
41640
|
+
export const CouponsApiFp = function(configuration?: Configuration) {
|
|
41641
|
+
const localVarAxiosParamCreator = CouponsApiAxiosParamCreator(configuration)
|
|
41642
|
+
return {
|
|
41643
|
+
/**
|
|
41644
|
+
* Vendure checks the coupon for the venue, the app of the ticket, the order type, the customer\'s phone and the basket, and answers its discounts in the till\'s discount shape; nothing is stored or reserved. Check again whenever the basket changes and before payment. The use is counted once the order is paid, from the order\'s discounts. A coupon that does not apply, and Vendure not answering within 2 seconds, are answered 200 with valid false, a reason and a message to show.
|
|
41645
|
+
* @summary Check a coupon against a till\'s basket
|
|
41646
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41647
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41648
|
+
* @param {*} [options] Override http request option.
|
|
41649
|
+
* @throws {RequiredError}
|
|
41650
|
+
*/
|
|
41651
|
+
async checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CouponCheckAnswerDto>> {
|
|
41652
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkCoupon(businessId, checkCouponDto, options);
|
|
41653
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41654
|
+
},
|
|
41655
|
+
/**
|
|
41656
|
+
* The kiosk\'s coupon check, with the kiosk\'s key as its order sync: the same check as the till\'s, for the kiosk app. Vendure checks the coupon for the venue, the order type, the customer\'s phone and the basket, and answers its discounts in the order\'s discount shape; nothing is stored or reserved. The use is counted once the order is paid, from the order\'s discounts. A coupon that does not apply, and Vendure not answering within 2 seconds, are answered 200 with valid false, a reason and a message to show.
|
|
41657
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
41658
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
41659
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41660
|
+
* @param {*} [options] Override http request option.
|
|
41661
|
+
* @throws {RequiredError}
|
|
41662
|
+
*/
|
|
41663
|
+
async checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CouponCheckAnswerDto>> {
|
|
41664
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkKioskCoupon(businessId, checkCouponDto, options);
|
|
41665
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41666
|
+
},
|
|
41667
|
+
}
|
|
41668
|
+
};
|
|
41669
|
+
|
|
41670
|
+
/**
|
|
41671
|
+
* CouponsApi - factory interface
|
|
41672
|
+
* @export
|
|
41673
|
+
*/
|
|
41674
|
+
export const CouponsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
41675
|
+
const localVarFp = CouponsApiFp(configuration)
|
|
41676
|
+
return {
|
|
41677
|
+
/**
|
|
41678
|
+
* Vendure checks the coupon for the venue, the app of the ticket, the order type, the customer\'s phone and the basket, and answers its discounts in the till\'s discount shape; nothing is stored or reserved. Check again whenever the basket changes and before payment. The use is counted once the order is paid, from the order\'s discounts. A coupon that does not apply, and Vendure not answering within 2 seconds, are answered 200 with valid false, a reason and a message to show.
|
|
41679
|
+
* @summary Check a coupon against a till\'s basket
|
|
41680
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41681
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41682
|
+
* @param {*} [options] Override http request option.
|
|
41683
|
+
* @throws {RequiredError}
|
|
41684
|
+
*/
|
|
41685
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: any): AxiosPromise<CouponCheckAnswerDto> {
|
|
41686
|
+
return localVarFp.checkCoupon(businessId, checkCouponDto, options).then((request) => request(axios, basePath));
|
|
41687
|
+
},
|
|
41688
|
+
/**
|
|
41689
|
+
* The kiosk\'s coupon check, with the kiosk\'s key as its order sync: the same check as the till\'s, for the kiosk app. Vendure checks the coupon for the venue, the order type, the customer\'s phone and the basket, and answers its discounts in the order\'s discount shape; nothing is stored or reserved. The use is counted once the order is paid, from the order\'s discounts. A coupon that does not apply, and Vendure not answering within 2 seconds, are answered 200 with valid false, a reason and a message to show.
|
|
41690
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
41691
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
41692
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41693
|
+
* @param {*} [options] Override http request option.
|
|
41694
|
+
* @throws {RequiredError}
|
|
41695
|
+
*/
|
|
41696
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: any): AxiosPromise<CouponCheckAnswerDto> {
|
|
41697
|
+
return localVarFp.checkKioskCoupon(businessId, checkCouponDto, options).then((request) => request(axios, basePath));
|
|
41698
|
+
},
|
|
41699
|
+
};
|
|
41700
|
+
};
|
|
41701
|
+
|
|
41702
|
+
/**
|
|
41703
|
+
* CouponsApi - interface
|
|
41704
|
+
* @export
|
|
41705
|
+
* @interface CouponsApi
|
|
41706
|
+
*/
|
|
41707
|
+
export interface CouponsApiInterface {
|
|
41708
|
+
/**
|
|
41709
|
+
* Vendure checks the coupon for the venue, the app of the ticket, the order type, the customer\'s phone and the basket, and answers its discounts in the till\'s discount shape; nothing is stored or reserved. Check again whenever the basket changes and before payment. The use is counted once the order is paid, from the order\'s discounts. A coupon that does not apply, and Vendure not answering within 2 seconds, are answered 200 with valid false, a reason and a message to show.
|
|
41710
|
+
* @summary Check a coupon against a till\'s basket
|
|
41711
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41712
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41713
|
+
* @param {*} [options] Override http request option.
|
|
41714
|
+
* @throws {RequiredError}
|
|
41715
|
+
* @memberof CouponsApiInterface
|
|
41716
|
+
*/
|
|
41717
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): AxiosPromise<CouponCheckAnswerDto>;
|
|
41718
|
+
|
|
41719
|
+
/**
|
|
41720
|
+
* The kiosk\'s coupon check, with the kiosk\'s key as its order sync: the same check as the till\'s, for the kiosk app. Vendure checks the coupon for the venue, the order type, the customer\'s phone and the basket, and answers its discounts in the order\'s discount shape; nothing is stored or reserved. The use is counted once the order is paid, from the order\'s discounts. A coupon that does not apply, and Vendure not answering within 2 seconds, are answered 200 with valid false, a reason and a message to show.
|
|
41721
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
41722
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
41723
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41724
|
+
* @param {*} [options] Override http request option.
|
|
41725
|
+
* @throws {RequiredError}
|
|
41726
|
+
* @memberof CouponsApiInterface
|
|
41727
|
+
*/
|
|
41728
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): AxiosPromise<CouponCheckAnswerDto>;
|
|
41729
|
+
|
|
41730
|
+
}
|
|
41731
|
+
|
|
41732
|
+
/**
|
|
41733
|
+
* CouponsApi - object-oriented interface
|
|
41734
|
+
* @export
|
|
41735
|
+
* @class CouponsApi
|
|
41736
|
+
* @extends {BaseAPI}
|
|
41737
|
+
*/
|
|
41738
|
+
export class CouponsApi extends BaseAPI implements CouponsApiInterface {
|
|
41739
|
+
/**
|
|
41740
|
+
* Vendure checks the coupon for the venue, the app of the ticket, the order type, the customer\'s phone and the basket, and answers its discounts in the till\'s discount shape; nothing is stored or reserved. Check again whenever the basket changes and before payment. The use is counted once the order is paid, from the order\'s discounts. A coupon that does not apply, and Vendure not answering within 2 seconds, are answered 200 with valid false, a reason and a message to show.
|
|
41741
|
+
* @summary Check a coupon against a till\'s basket
|
|
41742
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41743
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41744
|
+
* @param {*} [options] Override http request option.
|
|
41745
|
+
* @throws {RequiredError}
|
|
41746
|
+
* @memberof CouponsApi
|
|
41747
|
+
*/
|
|
41748
|
+
public checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig) {
|
|
41749
|
+
return CouponsApiFp(this.configuration).checkCoupon(businessId, checkCouponDto, options).then((request) => request(this.axios, this.basePath));
|
|
41750
|
+
}
|
|
41751
|
+
|
|
41752
|
+
/**
|
|
41753
|
+
* The kiosk\'s coupon check, with the kiosk\'s key as its order sync: the same check as the till\'s, for the kiosk app. Vendure checks the coupon for the venue, the order type, the customer\'s phone and the basket, and answers its discounts in the order\'s discount shape; nothing is stored or reserved. The use is counted once the order is paid, from the order\'s discounts. A coupon that does not apply, and Vendure not answering within 2 seconds, are answered 200 with valid false, a reason and a message to show.
|
|
41754
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
41755
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
41756
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41757
|
+
* @param {*} [options] Override http request option.
|
|
41758
|
+
* @throws {RequiredError}
|
|
41759
|
+
* @memberof CouponsApi
|
|
41760
|
+
*/
|
|
41761
|
+
public checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig) {
|
|
41762
|
+
return CouponsApiFp(this.configuration).checkKioskCoupon(businessId, checkCouponDto, options).then((request) => request(this.axios, this.basePath));
|
|
41763
|
+
}
|
|
41764
|
+
}
|
|
41765
|
+
|
|
41766
|
+
|
|
40604
41767
|
/**
|
|
40605
41768
|
* CoursesApi - axios parameter creator
|
|
40606
41769
|
* @export
|
|
@@ -43983,7 +45146,7 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
43983
45146
|
};
|
|
43984
45147
|
},
|
|
43985
45148
|
/**
|
|
43986
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
45149
|
+
* The same answer as GET history/orders/pos, for a service holding the service key. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
43987
45150
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
43988
45151
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
43989
45152
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44124,7 +45287,7 @@ export const HistoryApiFp = function(configuration?: Configuration) {
|
|
|
44124
45287
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
44125
45288
|
},
|
|
44126
45289
|
/**
|
|
44127
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
45290
|
+
* The same answer as GET history/orders/pos, for a service holding the service key. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
44128
45291
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
44129
45292
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44130
45293
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44182,7 +45345,7 @@ export const HistoryApiFactory = function (configuration?: Configuration, basePa
|
|
|
44182
45345
|
return localVarFp.getOrderHistoryPOSV5(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(axios, basePath));
|
|
44183
45346
|
},
|
|
44184
45347
|
/**
|
|
44185
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
45348
|
+
* The same answer as GET history/orders/pos, for a service holding the service key. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
44186
45349
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
44187
45350
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44188
45351
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44238,7 +45401,7 @@ export interface HistoryApiInterface {
|
|
|
44238
45401
|
getOrderHistoryPOSV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<OrderHistoryPosResponseDtoV2>;
|
|
44239
45402
|
|
|
44240
45403
|
/**
|
|
44241
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
45404
|
+
* The same answer as GET history/orders/pos, for a service holding the service key. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
44242
45405
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
44243
45406
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44244
45407
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44296,7 +45459,7 @@ export class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
44296
45459
|
}
|
|
44297
45460
|
|
|
44298
45461
|
/**
|
|
44299
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
45462
|
+
* The same answer as GET history/orders/pos, for a service holding the service key. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
44300
45463
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
44301
45464
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44302
45465
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44329,7 +45492,7 @@ export class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
44329
45492
|
export const HistoryV6ApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
44330
45493
|
return {
|
|
44331
45494
|
/**
|
|
44332
|
-
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person.
|
|
45495
|
+
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
44333
45496
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
44334
45497
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44335
45498
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44653,7 +45816,7 @@ export const HistoryV6ApiFp = function(configuration?: Configuration) {
|
|
|
44653
45816
|
const localVarAxiosParamCreator = HistoryV6ApiAxiosParamCreator(configuration)
|
|
44654
45817
|
return {
|
|
44655
45818
|
/**
|
|
44656
|
-
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person.
|
|
45819
|
+
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
44657
45820
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
44658
45821
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44659
45822
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44735,7 +45898,7 @@ export const HistoryV6ApiFactory = function (configuration?: Configuration, base
|
|
|
44735
45898
|
const localVarFp = HistoryV6ApiFp(configuration)
|
|
44736
45899
|
return {
|
|
44737
45900
|
/**
|
|
44738
|
-
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person.
|
|
45901
|
+
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
44739
45902
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
44740
45903
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44741
45904
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44813,7 +45976,7 @@ export const HistoryV6ApiFactory = function (configuration?: Configuration, base
|
|
|
44813
45976
|
*/
|
|
44814
45977
|
export interface HistoryV6ApiInterface {
|
|
44815
45978
|
/**
|
|
44816
|
-
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person.
|
|
45979
|
+
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
44817
45980
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
44818
45981
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44819
45982
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44891,7 +46054,7 @@ export interface HistoryV6ApiInterface {
|
|
|
44891
46054
|
*/
|
|
44892
46055
|
export class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterface {
|
|
44893
46056
|
/**
|
|
44894
|
-
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person.
|
|
46057
|
+
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
44895
46058
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
44896
46059
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44897
46060
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -47949,7 +49112,7 @@ export const MCPApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
47949
49112
|
};
|
|
47950
49113
|
},
|
|
47951
49114
|
/**
|
|
47952
|
-
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own
|
|
49115
|
+
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own credential, so that route\'s guard and logs decide as for a direct call. A person signed in for Ari with their own Clerk token sees only the read tools, at the stores where they are `org:owner` (D152). A tool\'s answer never carries a credential. Connect with `claude mcp add --transport http munchi-super <host>/api/v1/mcp --header \"Authorization: Bearer ak_…\"` (D137).
|
|
47953
49116
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
47954
49117
|
* @param {object} body A JSON-RPC 2.0 message
|
|
47955
49118
|
* @param {*} [options] Override http request option.
|
|
@@ -48019,7 +49182,7 @@ export const MCPApiFp = function(configuration?: Configuration) {
|
|
|
48019
49182
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48020
49183
|
},
|
|
48021
49184
|
/**
|
|
48022
|
-
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own
|
|
49185
|
+
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own credential, so that route\'s guard and logs decide as for a direct call. A person signed in for Ari with their own Clerk token sees only the read tools, at the stores where they are `org:owner` (D152). A tool\'s answer never carries a credential. Connect with `claude mcp add --transport http munchi-super <host>/api/v1/mcp --header \"Authorization: Bearer ak_…\"` (D137).
|
|
48023
49186
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
48024
49187
|
* @param {object} body A JSON-RPC 2.0 message
|
|
48025
49188
|
* @param {*} [options] Override http request option.
|
|
@@ -48058,7 +49221,7 @@ export const MCPApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
48058
49221
|
return localVarFp.refuseStream(options).then((request) => request(axios, basePath));
|
|
48059
49222
|
},
|
|
48060
49223
|
/**
|
|
48061
|
-
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own
|
|
49224
|
+
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own credential, so that route\'s guard and logs decide as for a direct call. A person signed in for Ari with their own Clerk token sees only the read tools, at the stores where they are `org:owner` (D152). A tool\'s answer never carries a credential. Connect with `claude mcp add --transport http munchi-super <host>/api/v1/mcp --header \"Authorization: Bearer ak_…\"` (D137).
|
|
48062
49225
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
48063
49226
|
* @param {object} body A JSON-RPC 2.0 message
|
|
48064
49227
|
* @param {*} [options] Override http request option.
|
|
@@ -48095,7 +49258,7 @@ export interface MCPApiInterface {
|
|
|
48095
49258
|
refuseStream(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
48096
49259
|
|
|
48097
49260
|
/**
|
|
48098
|
-
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own
|
|
49261
|
+
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own credential, so that route\'s guard and logs decide as for a direct call. A person signed in for Ari with their own Clerk token sees only the read tools, at the stores where they are `org:owner` (D152). A tool\'s answer never carries a credential. Connect with `claude mcp add --transport http munchi-super <host>/api/v1/mcp --header \"Authorization: Bearer ak_…\"` (D137).
|
|
48099
49262
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
48100
49263
|
* @param {object} body A JSON-RPC 2.0 message
|
|
48101
49264
|
* @param {*} [options] Override http request option.
|
|
@@ -48136,7 +49299,7 @@ export class MCPApi extends BaseAPI implements MCPApiInterface {
|
|
|
48136
49299
|
}
|
|
48137
49300
|
|
|
48138
49301
|
/**
|
|
48139
|
-
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own
|
|
49302
|
+
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own credential, so that route\'s guard and logs decide as for a direct call. A person signed in for Ari with their own Clerk token sees only the read tools, at the stores where they are `org:owner` (D152). A tool\'s answer never carries a credential. Connect with `claude mcp add --transport http munchi-super <host>/api/v1/mcp --header \"Authorization: Bearer ak_…\"` (D137).
|
|
48140
49303
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
48141
49304
|
* @param {object} body A JSON-RPC 2.0 message
|
|
48142
49305
|
* @param {*} [options] Override http request option.
|
|
@@ -49503,7 +50666,7 @@ export class OrderCompletionApi extends BaseAPI implements OrderCompletionApiInt
|
|
|
49503
50666
|
export const OrderInternalApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
49504
50667
|
return {
|
|
49505
50668
|
/**
|
|
49506
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
50669
|
+
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token. A store\'s owner signed in for Ari (D152) reads an order of a store they are org:owner of.
|
|
49507
50670
|
* @summary Get order data by external ID for internal microservice communication
|
|
49508
50671
|
* @param {string} externalId The order\'s id on its channel (Order.externalId): the id Wolt, Foodora, Bolt or Uber Eats gave it, or the id our own channels gave it
|
|
49509
50672
|
* @param {*} [options] Override http request option.
|
|
@@ -49547,7 +50710,7 @@ export const OrderInternalApiFp = function(configuration?: Configuration) {
|
|
|
49547
50710
|
const localVarAxiosParamCreator = OrderInternalApiAxiosParamCreator(configuration)
|
|
49548
50711
|
return {
|
|
49549
50712
|
/**
|
|
49550
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
50713
|
+
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token. A store\'s owner signed in for Ari (D152) reads an order of a store they are org:owner of.
|
|
49551
50714
|
* @summary Get order data by external ID for internal microservice communication
|
|
49552
50715
|
* @param {string} externalId The order\'s id on its channel (Order.externalId): the id Wolt, Foodora, Bolt or Uber Eats gave it, or the id our own channels gave it
|
|
49553
50716
|
* @param {*} [options] Override http request option.
|
|
@@ -49568,7 +50731,7 @@ export const OrderInternalApiFactory = function (configuration?: Configuration,
|
|
|
49568
50731
|
const localVarFp = OrderInternalApiFp(configuration)
|
|
49569
50732
|
return {
|
|
49570
50733
|
/**
|
|
49571
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
50734
|
+
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token. A store\'s owner signed in for Ari (D152) reads an order of a store they are org:owner of.
|
|
49572
50735
|
* @summary Get order data by external ID for internal microservice communication
|
|
49573
50736
|
* @param {string} externalId The order\'s id on its channel (Order.externalId): the id Wolt, Foodora, Bolt or Uber Eats gave it, or the id our own channels gave it
|
|
49574
50737
|
* @param {*} [options] Override http request option.
|
|
@@ -49587,7 +50750,7 @@ export const OrderInternalApiFactory = function (configuration?: Configuration,
|
|
|
49587
50750
|
*/
|
|
49588
50751
|
export interface OrderInternalApiInterface {
|
|
49589
50752
|
/**
|
|
49590
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
50753
|
+
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token. A store\'s owner signed in for Ari (D152) reads an order of a store they are org:owner of.
|
|
49591
50754
|
* @summary Get order data by external ID for internal microservice communication
|
|
49592
50755
|
* @param {string} externalId The order\'s id on its channel (Order.externalId): the id Wolt, Foodora, Bolt or Uber Eats gave it, or the id our own channels gave it
|
|
49593
50756
|
* @param {*} [options] Override http request option.
|
|
@@ -49606,7 +50769,7 @@ export interface OrderInternalApiInterface {
|
|
|
49606
50769
|
*/
|
|
49607
50770
|
export class OrderInternalApi extends BaseAPI implements OrderInternalApiInterface {
|
|
49608
50771
|
/**
|
|
49609
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
50772
|
+
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token. A store\'s owner signed in for Ari (D152) reads an order of a store they are org:owner of.
|
|
49610
50773
|
* @summary Get order data by external ID for internal microservice communication
|
|
49611
50774
|
* @param {string} externalId The order\'s id on its channel (Order.externalId): the id Wolt, Foodora, Bolt or Uber Eats gave it, or the id our own channels gave it
|
|
49612
50775
|
* @param {*} [options] Override http request option.
|
|
@@ -52685,7 +53848,7 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
52685
53848
|
};
|
|
52686
53849
|
},
|
|
52687
53850
|
/**
|
|
52688
|
-
* Attaches a
|
|
53851
|
+
* Attaches a built-in method, or one of the venue\'s own custom methods, by `code` (another venue\'s custom code answers 400), or with `name` and `type` mints a custom method of the venue\'s own and attaches it: its code is custom_<businessId>_ and the name\'s slug, with _2, _3… when the venue already has that name, labelled in English with the name, and no other venue\'s picker offers it. It goes after the last method. A CARD-type method brings the venue\'s missing Debit and Credit under it; a lunch voucher goes under LunchVoucher, added when missing. A gift card (GiftCard, MunchiGiftCard) creates or updates the venue\'s gift card integration, on when the method is, with the login sent (a blank field keeps the saved one), and clears the venue\'s cached config. The venue\'s tills on the channel are told over Ably (SYNC, PAYMENT_METHODS) to read the list again. The answer is labelled in the `locale` query parameter (English when absent), and its giftCardCredentials is null.
|
|
52689
53852
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
52690
53853
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52691
53854
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -52771,7 +53934,7 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
52771
53934
|
};
|
|
52772
53935
|
},
|
|
52773
53936
|
/**
|
|
52774
|
-
* The dashboard\'s add-method picker: every method of the
|
|
53937
|
+
* The dashboard\'s add-method picker: every built-in method of the catalog that the venue\'s list on the channel does not have yet, by code, labelled in `locale`; with no config on the channel, every built-in method. The kiosk (MunchiKiosk) is offered only the methods its app can take: Card, Edenred and EPassi. A venue\'s custom methods are its own and never listed here. requiresCredentials marks the third-party gift card, which asks for a login.
|
|
52775
53938
|
* @summary List the catalog methods a venue can still add on one channel
|
|
52776
53939
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52777
53940
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53061,7 +54224,7 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
|
|
|
53061
54224
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
53062
54225
|
},
|
|
53063
54226
|
/**
|
|
53064
|
-
* Attaches a
|
|
54227
|
+
* Attaches a built-in method, or one of the venue\'s own custom methods, by `code` (another venue\'s custom code answers 400), or with `name` and `type` mints a custom method of the venue\'s own and attaches it: its code is custom_<businessId>_ and the name\'s slug, with _2, _3… when the venue already has that name, labelled in English with the name, and no other venue\'s picker offers it. It goes after the last method. A CARD-type method brings the venue\'s missing Debit and Credit under it; a lunch voucher goes under LunchVoucher, added when missing. A gift card (GiftCard, MunchiGiftCard) creates or updates the venue\'s gift card integration, on when the method is, with the login sent (a blank field keeps the saved one), and clears the venue\'s cached config. The venue\'s tills on the channel are told over Ably (SYNC, PAYMENT_METHODS) to read the list again. The answer is labelled in the `locale` query parameter (English when absent), and its giftCardCredentials is null.
|
|
53065
54228
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
53066
54229
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53067
54230
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53087,7 +54250,7 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
|
|
|
53087
54250
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
53088
54251
|
},
|
|
53089
54252
|
/**
|
|
53090
|
-
* The dashboard\'s add-method picker: every method of the
|
|
54253
|
+
* The dashboard\'s add-method picker: every built-in method of the catalog that the venue\'s list on the channel does not have yet, by code, labelled in `locale`; with no config on the channel, every built-in method. The kiosk (MunchiKiosk) is offered only the methods its app can take: Card, Edenred and EPassi. A venue\'s custom methods are its own and never listed here. requiresCredentials marks the third-party gift card, which asks for a login.
|
|
53091
54254
|
* @summary List the catalog methods a venue can still add on one channel
|
|
53092
54255
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53093
54256
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53199,7 +54362,7 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
|
|
|
53199
54362
|
return localVarFp.changePaymentMethodOption(businessId, channel, id, changePaymentMethodOptionDto, options).then((request) => request(axios, basePath));
|
|
53200
54363
|
},
|
|
53201
54364
|
/**
|
|
53202
|
-
* Attaches a
|
|
54365
|
+
* Attaches a built-in method, or one of the venue\'s own custom methods, by `code` (another venue\'s custom code answers 400), or with `name` and `type` mints a custom method of the venue\'s own and attaches it: its code is custom_<businessId>_ and the name\'s slug, with _2, _3… when the venue already has that name, labelled in English with the name, and no other venue\'s picker offers it. It goes after the last method. A CARD-type method brings the venue\'s missing Debit and Credit under it; a lunch voucher goes under LunchVoucher, added when missing. A gift card (GiftCard, MunchiGiftCard) creates or updates the venue\'s gift card integration, on when the method is, with the login sent (a blank field keeps the saved one), and clears the venue\'s cached config. The venue\'s tills on the channel are told over Ably (SYNC, PAYMENT_METHODS) to read the list again. The answer is labelled in the `locale` query parameter (English when absent), and its giftCardCredentials is null.
|
|
53203
54366
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
53204
54367
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53205
54368
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53223,7 +54386,7 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
|
|
|
53223
54386
|
return localVarFp.deletePaymentMethodOption(businessId, channel, id, options).then((request) => request(axios, basePath));
|
|
53224
54387
|
},
|
|
53225
54388
|
/**
|
|
53226
|
-
* The dashboard\'s add-method picker: every method of the
|
|
54389
|
+
* The dashboard\'s add-method picker: every built-in method of the catalog that the venue\'s list on the channel does not have yet, by code, labelled in `locale`; with no config on the channel, every built-in method. The kiosk (MunchiKiosk) is offered only the methods its app can take: Card, Edenred and EPassi. A venue\'s custom methods are its own and never listed here. requiresCredentials marks the third-party gift card, which asks for a login.
|
|
53227
54390
|
* @summary List the catalog methods a venue can still add on one channel
|
|
53228
54391
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53229
54392
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53328,7 +54491,7 @@ export interface PaymentMethodsApiInterface {
|
|
|
53328
54491
|
changePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
53329
54492
|
|
|
53330
54493
|
/**
|
|
53331
|
-
* Attaches a
|
|
54494
|
+
* Attaches a built-in method, or one of the venue\'s own custom methods, by `code` (another venue\'s custom code answers 400), or with `name` and `type` mints a custom method of the venue\'s own and attaches it: its code is custom_<businessId>_ and the name\'s slug, with _2, _3… when the venue already has that name, labelled in English with the name, and no other venue\'s picker offers it. It goes after the last method. A CARD-type method brings the venue\'s missing Debit and Credit under it; a lunch voucher goes under LunchVoucher, added when missing. A gift card (GiftCard, MunchiGiftCard) creates or updates the venue\'s gift card integration, on when the method is, with the login sent (a blank field keeps the saved one), and clears the venue\'s cached config. The venue\'s tills on the channel are told over Ably (SYNC, PAYMENT_METHODS) to read the list again. The answer is labelled in the `locale` query parameter (English when absent), and its giftCardCredentials is null.
|
|
53332
54495
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
53333
54496
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53334
54497
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53352,7 +54515,7 @@ export interface PaymentMethodsApiInterface {
|
|
|
53352
54515
|
deletePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
53353
54516
|
|
|
53354
54517
|
/**
|
|
53355
|
-
* The dashboard\'s add-method picker: every method of the
|
|
54518
|
+
* The dashboard\'s add-method picker: every built-in method of the catalog that the venue\'s list on the channel does not have yet, by code, labelled in `locale`; with no config on the channel, every built-in method. The kiosk (MunchiKiosk) is offered only the methods its app can take: Card, Edenred and EPassi. A venue\'s custom methods are its own and never listed here. requiresCredentials marks the third-party gift card, which asks for a login.
|
|
53356
54519
|
* @summary List the catalog methods a venue can still add on one channel
|
|
53357
54520
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53358
54521
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53461,7 +54624,7 @@ export class PaymentMethodsApi extends BaseAPI implements PaymentMethodsApiInter
|
|
|
53461
54624
|
}
|
|
53462
54625
|
|
|
53463
54626
|
/**
|
|
53464
|
-
* Attaches a
|
|
54627
|
+
* Attaches a built-in method, or one of the venue\'s own custom methods, by `code` (another venue\'s custom code answers 400), or with `name` and `type` mints a custom method of the venue\'s own and attaches it: its code is custom_<businessId>_ and the name\'s slug, with _2, _3… when the venue already has that name, labelled in English with the name, and no other venue\'s picker offers it. It goes after the last method. A CARD-type method brings the venue\'s missing Debit and Credit under it; a lunch voucher goes under LunchVoucher, added when missing. A gift card (GiftCard, MunchiGiftCard) creates or updates the venue\'s gift card integration, on when the method is, with the login sent (a blank field keeps the saved one), and clears the venue\'s cached config. The venue\'s tills on the channel are told over Ably (SYNC, PAYMENT_METHODS) to read the list again. The answer is labelled in the `locale` query parameter (English when absent), and its giftCardCredentials is null.
|
|
53465
54628
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
53466
54629
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53467
54630
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53489,7 +54652,7 @@ export class PaymentMethodsApi extends BaseAPI implements PaymentMethodsApiInter
|
|
|
53489
54652
|
}
|
|
53490
54653
|
|
|
53491
54654
|
/**
|
|
53492
|
-
* The dashboard\'s add-method picker: every method of the
|
|
54655
|
+
* The dashboard\'s add-method picker: every built-in method of the catalog that the venue\'s list on the channel does not have yet, by code, labelled in `locale`; with no config on the channel, every built-in method. The kiosk (MunchiKiosk) is offered only the methods its app can take: Card, Edenred and EPassi. A venue\'s custom methods are its own and never listed here. requiresCredentials marks the third-party gift card, which asks for a login.
|
|
53493
54656
|
* @summary List the catalog methods a venue can still add on one channel
|
|
53494
54657
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53495
54658
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -56355,100 +57518,22 @@ export class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
56355
57518
|
|
|
56356
57519
|
|
|
56357
57520
|
/**
|
|
56358
|
-
*
|
|
57521
|
+
* PromotionsApi - axios parameter creator
|
|
56359
57522
|
* @export
|
|
56360
57523
|
*/
|
|
56361
|
-
export const
|
|
57524
|
+
export const PromotionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
56362
57525
|
return {
|
|
56363
57526
|
/**
|
|
56364
|
-
*
|
|
56365
|
-
* @summary
|
|
56366
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
56367
|
-
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
56368
|
-
* @param {*} [options] Override http request option.
|
|
56369
|
-
* @throws {RequiredError}
|
|
56370
|
-
*/
|
|
56371
|
-
createOnboardingSession: async (channel: ProviderEnum, createOnboardingSessionDto: CreateOnboardingSessionDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56372
|
-
// verify required parameter 'channel' is not null or undefined
|
|
56373
|
-
assertParamExists('createOnboardingSession', 'channel', channel)
|
|
56374
|
-
// verify required parameter 'createOnboardingSessionDto' is not null or undefined
|
|
56375
|
-
assertParamExists('createOnboardingSession', 'createOnboardingSessionDto', createOnboardingSessionDto)
|
|
56376
|
-
const localVarPath = `/api/v1/provider/onboarding/{channel}/sessions`
|
|
56377
|
-
.replace(`{${"channel"}}`, encodeURIComponent(String(channel)));
|
|
56378
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56379
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56380
|
-
let baseOptions;
|
|
56381
|
-
if (configuration) {
|
|
56382
|
-
baseOptions = configuration.baseOptions;
|
|
56383
|
-
}
|
|
56384
|
-
|
|
56385
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
56386
|
-
const localVarHeaderParameter = {} as any;
|
|
56387
|
-
const localVarQueryParameter = {} as any;
|
|
56388
|
-
|
|
56389
|
-
|
|
56390
|
-
|
|
56391
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
56392
|
-
|
|
56393
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56394
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56395
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
56396
|
-
localVarRequestOptions.data = serializeDataIfNeeded(createOnboardingSessionDto, localVarRequestOptions, configuration)
|
|
56397
|
-
|
|
56398
|
-
return {
|
|
56399
|
-
url: toPathString(localVarUrlObj),
|
|
56400
|
-
options: localVarRequestOptions,
|
|
56401
|
-
};
|
|
56402
|
-
},
|
|
56403
|
-
/**
|
|
56404
|
-
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or the message of wolt-service or resq-service.
|
|
56405
|
-
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
56406
|
-
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
57527
|
+
* The signal that tells the till whether to price its baskets: the venue\'s automatic promotions for the POS that are running at the moment of the read. Empty: the till need not call .../promotions/price unless the order holds a coupon code. Read it again when the venue\'s DISCOUNTS sync arrives.
|
|
57528
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
56407
57529
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56408
57530
|
* @param {*} [options] Override http request option.
|
|
56409
57531
|
* @throws {RequiredError}
|
|
56410
57532
|
*/
|
|
56411
|
-
|
|
56412
|
-
// verify required parameter 'channel' is not null or undefined
|
|
56413
|
-
assertParamExists('disconnectOnboarding', 'channel', channel)
|
|
57533
|
+
listAutomaticPromotions: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56414
57534
|
// verify required parameter 'businessId' is not null or undefined
|
|
56415
|
-
assertParamExists('
|
|
56416
|
-
const localVarPath = `/api/
|
|
56417
|
-
.replace(`{${"channel"}}`, encodeURIComponent(String(channel)))
|
|
56418
|
-
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
56419
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56420
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56421
|
-
let baseOptions;
|
|
56422
|
-
if (configuration) {
|
|
56423
|
-
baseOptions = configuration.baseOptions;
|
|
56424
|
-
}
|
|
56425
|
-
|
|
56426
|
-
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
56427
|
-
const localVarHeaderParameter = {} as any;
|
|
56428
|
-
const localVarQueryParameter = {} as any;
|
|
56429
|
-
|
|
56430
|
-
|
|
56431
|
-
|
|
56432
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56433
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56434
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
56435
|
-
|
|
56436
|
-
return {
|
|
56437
|
-
url: toPathString(localVarUrlObj),
|
|
56438
|
-
options: localVarRequestOptions,
|
|
56439
|
-
};
|
|
56440
|
-
},
|
|
56441
|
-
/**
|
|
56442
|
-
* The venue\'s channels that take the menu, so the till can switch a product\'s availability on each. Kept per venue under menu-integrations:<businessId>, an empty list too, and cleared when the venue\'s providers change (SYNC_KEY.BUSINESS_PROVIDER_SUPPORTED_INTEGRATIONS).
|
|
56443
|
-
* @summary Get provider integrations (MENU) for a business
|
|
56444
|
-
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56445
|
-
* @param {*} [options] Override http request option.
|
|
56446
|
-
* @throws {RequiredError}
|
|
56447
|
-
*/
|
|
56448
|
-
getMenuIntegrations: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56449
|
-
// verify required parameter 'businessId' is not null or undefined
|
|
56450
|
-
assertParamExists('getMenuIntegrations', 'businessId', businessId)
|
|
56451
|
-
const localVarPath = `/api/v1/provider/integrations/{businessId}`
|
|
57535
|
+
assertParamExists('listAutomaticPromotions', 'businessId', businessId)
|
|
57536
|
+
const localVarPath = `/api/v2/venues/{businessId}/promotions/automatic`
|
|
56452
57537
|
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
56453
57538
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56454
57539
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -56461,6 +57546,10 @@ export const ProviderApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
56461
57546
|
const localVarHeaderParameter = {} as any;
|
|
56462
57547
|
const localVarQueryParameter = {} as any;
|
|
56463
57548
|
|
|
57549
|
+
// authentication JWT-auth required
|
|
57550
|
+
// http bearer authentication required
|
|
57551
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
57552
|
+
|
|
56464
57553
|
|
|
56465
57554
|
|
|
56466
57555
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -56473,20 +57562,476 @@ export const ProviderApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
56473
57562
|
};
|
|
56474
57563
|
},
|
|
56475
57564
|
/**
|
|
56476
|
-
* The
|
|
56477
|
-
* @summary
|
|
56478
|
-
* @param {
|
|
56479
|
-
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57565
|
+
* The signal that tells the kiosk whether to price its baskets: the venue\'s automatic promotions for the kiosk that are running at the moment of the read. Empty: the kiosk need not call .../promotions/price unless the order holds a coupon code.
|
|
57566
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
57567
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
56480
57568
|
* @param {*} [options] Override http request option.
|
|
56481
57569
|
* @throws {RequiredError}
|
|
56482
57570
|
*/
|
|
56483
|
-
|
|
56484
|
-
// verify required parameter 'channel' is not null or undefined
|
|
56485
|
-
assertParamExists('getOnboardingStatus', 'channel', channel)
|
|
57571
|
+
listKioskAutomaticPromotions: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56486
57572
|
// verify required parameter 'businessId' is not null or undefined
|
|
56487
|
-
assertParamExists('
|
|
56488
|
-
const localVarPath = `/api/
|
|
56489
|
-
.replace(`{${"
|
|
57573
|
+
assertParamExists('listKioskAutomaticPromotions', 'businessId', businessId)
|
|
57574
|
+
const localVarPath = `/api/v2/kiosk/venues/{businessId}/promotions/automatic`
|
|
57575
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
57576
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57577
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57578
|
+
let baseOptions;
|
|
57579
|
+
if (configuration) {
|
|
57580
|
+
baseOptions = configuration.baseOptions;
|
|
57581
|
+
}
|
|
57582
|
+
|
|
57583
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
57584
|
+
const localVarHeaderParameter = {} as any;
|
|
57585
|
+
const localVarQueryParameter = {} as any;
|
|
57586
|
+
|
|
57587
|
+
|
|
57588
|
+
|
|
57589
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57590
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57591
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57592
|
+
|
|
57593
|
+
return {
|
|
57594
|
+
url: toPathString(localVarUrlObj),
|
|
57595
|
+
options: localVarRequestOptions,
|
|
57596
|
+
};
|
|
57597
|
+
},
|
|
57598
|
+
/**
|
|
57599
|
+
* Vendure prices the basket as the online store prices a cart: the venue\'s automatic promotions for the POS and the order type, and the basket\'s coupon codes, and answers each discount with the money it takes off. Nothing is stored, reserved or counted. Ask only when the venue has automatic promotions running (GET .../promotions/automatic) or the order holds a coupon code, again whenever the basket changes, and keep the newest answer. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
57600
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
57601
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57602
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57603
|
+
* @param {*} [options] Override http request option.
|
|
57604
|
+
* @throws {RequiredError}
|
|
57605
|
+
*/
|
|
57606
|
+
priceBasketWithPromotions: async (businessId: number, priceBasketDto: PriceBasketDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57607
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
57608
|
+
assertParamExists('priceBasketWithPromotions', 'businessId', businessId)
|
|
57609
|
+
// verify required parameter 'priceBasketDto' is not null or undefined
|
|
57610
|
+
assertParamExists('priceBasketWithPromotions', 'priceBasketDto', priceBasketDto)
|
|
57611
|
+
const localVarPath = `/api/v2/venues/{businessId}/promotions/price`
|
|
57612
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
57613
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57614
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57615
|
+
let baseOptions;
|
|
57616
|
+
if (configuration) {
|
|
57617
|
+
baseOptions = configuration.baseOptions;
|
|
57618
|
+
}
|
|
57619
|
+
|
|
57620
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
57621
|
+
const localVarHeaderParameter = {} as any;
|
|
57622
|
+
const localVarQueryParameter = {} as any;
|
|
57623
|
+
|
|
57624
|
+
// authentication JWT-auth required
|
|
57625
|
+
// http bearer authentication required
|
|
57626
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
57627
|
+
|
|
57628
|
+
|
|
57629
|
+
|
|
57630
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
57631
|
+
|
|
57632
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57633
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57634
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57635
|
+
localVarRequestOptions.data = serializeDataIfNeeded(priceBasketDto, localVarRequestOptions, configuration)
|
|
57636
|
+
|
|
57637
|
+
return {
|
|
57638
|
+
url: toPathString(localVarUrlObj),
|
|
57639
|
+
options: localVarRequestOptions,
|
|
57640
|
+
};
|
|
57641
|
+
},
|
|
57642
|
+
/**
|
|
57643
|
+
* The kiosk\'s pricing, with the kiosk\'s key: the same pricing as the till\'s, for the kiosk app. Vendure prices the basket with the venue\'s automatic promotions and the basket\'s coupon codes and answers each discount with the money it takes off; nothing is stored, reserved or counted. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
57644
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
57645
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57646
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57647
|
+
* @param {*} [options] Override http request option.
|
|
57648
|
+
* @throws {RequiredError}
|
|
57649
|
+
*/
|
|
57650
|
+
priceKioskBasketWithPromotions: async (businessId: number, priceBasketDto: PriceBasketDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57651
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
57652
|
+
assertParamExists('priceKioskBasketWithPromotions', 'businessId', businessId)
|
|
57653
|
+
// verify required parameter 'priceBasketDto' is not null or undefined
|
|
57654
|
+
assertParamExists('priceKioskBasketWithPromotions', 'priceBasketDto', priceBasketDto)
|
|
57655
|
+
const localVarPath = `/api/v2/kiosk/venues/{businessId}/promotions/price`
|
|
57656
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
57657
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57658
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57659
|
+
let baseOptions;
|
|
57660
|
+
if (configuration) {
|
|
57661
|
+
baseOptions = configuration.baseOptions;
|
|
57662
|
+
}
|
|
57663
|
+
|
|
57664
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
57665
|
+
const localVarHeaderParameter = {} as any;
|
|
57666
|
+
const localVarQueryParameter = {} as any;
|
|
57667
|
+
|
|
57668
|
+
|
|
57669
|
+
|
|
57670
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
57671
|
+
|
|
57672
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57673
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57674
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57675
|
+
localVarRequestOptions.data = serializeDataIfNeeded(priceBasketDto, localVarRequestOptions, configuration)
|
|
57676
|
+
|
|
57677
|
+
return {
|
|
57678
|
+
url: toPathString(localVarUrlObj),
|
|
57679
|
+
options: localVarRequestOptions,
|
|
57680
|
+
};
|
|
57681
|
+
},
|
|
57682
|
+
}
|
|
57683
|
+
};
|
|
57684
|
+
|
|
57685
|
+
/**
|
|
57686
|
+
* PromotionsApi - functional programming interface
|
|
57687
|
+
* @export
|
|
57688
|
+
*/
|
|
57689
|
+
export const PromotionsApiFp = function(configuration?: Configuration) {
|
|
57690
|
+
const localVarAxiosParamCreator = PromotionsApiAxiosParamCreator(configuration)
|
|
57691
|
+
return {
|
|
57692
|
+
/**
|
|
57693
|
+
* The signal that tells the till whether to price its baskets: the venue\'s automatic promotions for the POS that are running at the moment of the read. Empty: the till need not call .../promotions/price unless the order holds a coupon code. Read it again when the venue\'s DISCOUNTS sync arrives.
|
|
57694
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
57695
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57696
|
+
* @param {*} [options] Override http request option.
|
|
57697
|
+
* @throws {RequiredError}
|
|
57698
|
+
*/
|
|
57699
|
+
async listAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutomaticPromotionsAnswerDto>> {
|
|
57700
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAutomaticPromotions(businessId, options);
|
|
57701
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57702
|
+
},
|
|
57703
|
+
/**
|
|
57704
|
+
* The signal that tells the kiosk whether to price its baskets: the venue\'s automatic promotions for the kiosk that are running at the moment of the read. Empty: the kiosk need not call .../promotions/price unless the order holds a coupon code.
|
|
57705
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
57706
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57707
|
+
* @param {*} [options] Override http request option.
|
|
57708
|
+
* @throws {RequiredError}
|
|
57709
|
+
*/
|
|
57710
|
+
async listKioskAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutomaticPromotionsAnswerDto>> {
|
|
57711
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listKioskAutomaticPromotions(businessId, options);
|
|
57712
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57713
|
+
},
|
|
57714
|
+
/**
|
|
57715
|
+
* Vendure prices the basket as the online store prices a cart: the venue\'s automatic promotions for the POS and the order type, and the basket\'s coupon codes, and answers each discount with the money it takes off. Nothing is stored, reserved or counted. Ask only when the venue has automatic promotions running (GET .../promotions/automatic) or the order holds a coupon code, again whenever the basket changes, and keep the newest answer. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
57716
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
57717
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57718
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57719
|
+
* @param {*} [options] Override http request option.
|
|
57720
|
+
* @throws {RequiredError}
|
|
57721
|
+
*/
|
|
57722
|
+
async priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PriceBasketAnswerDto>> {
|
|
57723
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.priceBasketWithPromotions(businessId, priceBasketDto, options);
|
|
57724
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57725
|
+
},
|
|
57726
|
+
/**
|
|
57727
|
+
* The kiosk\'s pricing, with the kiosk\'s key: the same pricing as the till\'s, for the kiosk app. Vendure prices the basket with the venue\'s automatic promotions and the basket\'s coupon codes and answers each discount with the money it takes off; nothing is stored, reserved or counted. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
57728
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
57729
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57730
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57731
|
+
* @param {*} [options] Override http request option.
|
|
57732
|
+
* @throws {RequiredError}
|
|
57733
|
+
*/
|
|
57734
|
+
async priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PriceBasketAnswerDto>> {
|
|
57735
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.priceKioskBasketWithPromotions(businessId, priceBasketDto, options);
|
|
57736
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57737
|
+
},
|
|
57738
|
+
}
|
|
57739
|
+
};
|
|
57740
|
+
|
|
57741
|
+
/**
|
|
57742
|
+
* PromotionsApi - factory interface
|
|
57743
|
+
* @export
|
|
57744
|
+
*/
|
|
57745
|
+
export const PromotionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
57746
|
+
const localVarFp = PromotionsApiFp(configuration)
|
|
57747
|
+
return {
|
|
57748
|
+
/**
|
|
57749
|
+
* The signal that tells the till whether to price its baskets: the venue\'s automatic promotions for the POS that are running at the moment of the read. Empty: the till need not call .../promotions/price unless the order holds a coupon code. Read it again when the venue\'s DISCOUNTS sync arrives.
|
|
57750
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
57751
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57752
|
+
* @param {*} [options] Override http request option.
|
|
57753
|
+
* @throws {RequiredError}
|
|
57754
|
+
*/
|
|
57755
|
+
listAutomaticPromotions(businessId: number, options?: any): AxiosPromise<AutomaticPromotionsAnswerDto> {
|
|
57756
|
+
return localVarFp.listAutomaticPromotions(businessId, options).then((request) => request(axios, basePath));
|
|
57757
|
+
},
|
|
57758
|
+
/**
|
|
57759
|
+
* The signal that tells the kiosk whether to price its baskets: the venue\'s automatic promotions for the kiosk that are running at the moment of the read. Empty: the kiosk need not call .../promotions/price unless the order holds a coupon code.
|
|
57760
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
57761
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57762
|
+
* @param {*} [options] Override http request option.
|
|
57763
|
+
* @throws {RequiredError}
|
|
57764
|
+
*/
|
|
57765
|
+
listKioskAutomaticPromotions(businessId: number, options?: any): AxiosPromise<AutomaticPromotionsAnswerDto> {
|
|
57766
|
+
return localVarFp.listKioskAutomaticPromotions(businessId, options).then((request) => request(axios, basePath));
|
|
57767
|
+
},
|
|
57768
|
+
/**
|
|
57769
|
+
* Vendure prices the basket as the online store prices a cart: the venue\'s automatic promotions for the POS and the order type, and the basket\'s coupon codes, and answers each discount with the money it takes off. Nothing is stored, reserved or counted. Ask only when the venue has automatic promotions running (GET .../promotions/automatic) or the order holds a coupon code, again whenever the basket changes, and keep the newest answer. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
57770
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
57771
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57772
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57773
|
+
* @param {*} [options] Override http request option.
|
|
57774
|
+
* @throws {RequiredError}
|
|
57775
|
+
*/
|
|
57776
|
+
priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: any): AxiosPromise<PriceBasketAnswerDto> {
|
|
57777
|
+
return localVarFp.priceBasketWithPromotions(businessId, priceBasketDto, options).then((request) => request(axios, basePath));
|
|
57778
|
+
},
|
|
57779
|
+
/**
|
|
57780
|
+
* The kiosk\'s pricing, with the kiosk\'s key: the same pricing as the till\'s, for the kiosk app. Vendure prices the basket with the venue\'s automatic promotions and the basket\'s coupon codes and answers each discount with the money it takes off; nothing is stored, reserved or counted. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
57781
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
57782
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57783
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57784
|
+
* @param {*} [options] Override http request option.
|
|
57785
|
+
* @throws {RequiredError}
|
|
57786
|
+
*/
|
|
57787
|
+
priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: any): AxiosPromise<PriceBasketAnswerDto> {
|
|
57788
|
+
return localVarFp.priceKioskBasketWithPromotions(businessId, priceBasketDto, options).then((request) => request(axios, basePath));
|
|
57789
|
+
},
|
|
57790
|
+
};
|
|
57791
|
+
};
|
|
57792
|
+
|
|
57793
|
+
/**
|
|
57794
|
+
* PromotionsApi - interface
|
|
57795
|
+
* @export
|
|
57796
|
+
* @interface PromotionsApi
|
|
57797
|
+
*/
|
|
57798
|
+
export interface PromotionsApiInterface {
|
|
57799
|
+
/**
|
|
57800
|
+
* The signal that tells the till whether to price its baskets: the venue\'s automatic promotions for the POS that are running at the moment of the read. Empty: the till need not call .../promotions/price unless the order holds a coupon code. Read it again when the venue\'s DISCOUNTS sync arrives.
|
|
57801
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
57802
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57803
|
+
* @param {*} [options] Override http request option.
|
|
57804
|
+
* @throws {RequiredError}
|
|
57805
|
+
* @memberof PromotionsApiInterface
|
|
57806
|
+
*/
|
|
57807
|
+
listAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): AxiosPromise<AutomaticPromotionsAnswerDto>;
|
|
57808
|
+
|
|
57809
|
+
/**
|
|
57810
|
+
* The signal that tells the kiosk whether to price its baskets: the venue\'s automatic promotions for the kiosk that are running at the moment of the read. Empty: the kiosk need not call .../promotions/price unless the order holds a coupon code.
|
|
57811
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
57812
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57813
|
+
* @param {*} [options] Override http request option.
|
|
57814
|
+
* @throws {RequiredError}
|
|
57815
|
+
* @memberof PromotionsApiInterface
|
|
57816
|
+
*/
|
|
57817
|
+
listKioskAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): AxiosPromise<AutomaticPromotionsAnswerDto>;
|
|
57818
|
+
|
|
57819
|
+
/**
|
|
57820
|
+
* Vendure prices the basket as the online store prices a cart: the venue\'s automatic promotions for the POS and the order type, and the basket\'s coupon codes, and answers each discount with the money it takes off. Nothing is stored, reserved or counted. Ask only when the venue has automatic promotions running (GET .../promotions/automatic) or the order holds a coupon code, again whenever the basket changes, and keep the newest answer. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
57821
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
57822
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57823
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57824
|
+
* @param {*} [options] Override http request option.
|
|
57825
|
+
* @throws {RequiredError}
|
|
57826
|
+
* @memberof PromotionsApiInterface
|
|
57827
|
+
*/
|
|
57828
|
+
priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): AxiosPromise<PriceBasketAnswerDto>;
|
|
57829
|
+
|
|
57830
|
+
/**
|
|
57831
|
+
* The kiosk\'s pricing, with the kiosk\'s key: the same pricing as the till\'s, for the kiosk app. Vendure prices the basket with the venue\'s automatic promotions and the basket\'s coupon codes and answers each discount with the money it takes off; nothing is stored, reserved or counted. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
57832
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
57833
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57834
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57835
|
+
* @param {*} [options] Override http request option.
|
|
57836
|
+
* @throws {RequiredError}
|
|
57837
|
+
* @memberof PromotionsApiInterface
|
|
57838
|
+
*/
|
|
57839
|
+
priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): AxiosPromise<PriceBasketAnswerDto>;
|
|
57840
|
+
|
|
57841
|
+
}
|
|
57842
|
+
|
|
57843
|
+
/**
|
|
57844
|
+
* PromotionsApi - object-oriented interface
|
|
57845
|
+
* @export
|
|
57846
|
+
* @class PromotionsApi
|
|
57847
|
+
* @extends {BaseAPI}
|
|
57848
|
+
*/
|
|
57849
|
+
export class PromotionsApi extends BaseAPI implements PromotionsApiInterface {
|
|
57850
|
+
/**
|
|
57851
|
+
* The signal that tells the till whether to price its baskets: the venue\'s automatic promotions for the POS that are running at the moment of the read. Empty: the till need not call .../promotions/price unless the order holds a coupon code. Read it again when the venue\'s DISCOUNTS sync arrives.
|
|
57852
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
57853
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57854
|
+
* @param {*} [options] Override http request option.
|
|
57855
|
+
* @throws {RequiredError}
|
|
57856
|
+
* @memberof PromotionsApi
|
|
57857
|
+
*/
|
|
57858
|
+
public listAutomaticPromotions(businessId: number, options?: AxiosRequestConfig) {
|
|
57859
|
+
return PromotionsApiFp(this.configuration).listAutomaticPromotions(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
57860
|
+
}
|
|
57861
|
+
|
|
57862
|
+
/**
|
|
57863
|
+
* The signal that tells the kiosk whether to price its baskets: the venue\'s automatic promotions for the kiosk that are running at the moment of the read. Empty: the kiosk need not call .../promotions/price unless the order holds a coupon code.
|
|
57864
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
57865
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57866
|
+
* @param {*} [options] Override http request option.
|
|
57867
|
+
* @throws {RequiredError}
|
|
57868
|
+
* @memberof PromotionsApi
|
|
57869
|
+
*/
|
|
57870
|
+
public listKioskAutomaticPromotions(businessId: number, options?: AxiosRequestConfig) {
|
|
57871
|
+
return PromotionsApiFp(this.configuration).listKioskAutomaticPromotions(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
57872
|
+
}
|
|
57873
|
+
|
|
57874
|
+
/**
|
|
57875
|
+
* Vendure prices the basket as the online store prices a cart: the venue\'s automatic promotions for the POS and the order type, and the basket\'s coupon codes, and answers each discount with the money it takes off. Nothing is stored, reserved or counted. Ask only when the venue has automatic promotions running (GET .../promotions/automatic) or the order holds a coupon code, again whenever the basket changes, and keep the newest answer. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
57876
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
57877
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57878
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57879
|
+
* @param {*} [options] Override http request option.
|
|
57880
|
+
* @throws {RequiredError}
|
|
57881
|
+
* @memberof PromotionsApi
|
|
57882
|
+
*/
|
|
57883
|
+
public priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig) {
|
|
57884
|
+
return PromotionsApiFp(this.configuration).priceBasketWithPromotions(businessId, priceBasketDto, options).then((request) => request(this.axios, this.basePath));
|
|
57885
|
+
}
|
|
57886
|
+
|
|
57887
|
+
/**
|
|
57888
|
+
* The kiosk\'s pricing, with the kiosk\'s key: the same pricing as the till\'s, for the kiosk app. Vendure prices the basket with the venue\'s automatic promotions and the basket\'s coupon codes and answers each discount with the money it takes off; nothing is stored, reserved or counted. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
57889
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
57890
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57891
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57892
|
+
* @param {*} [options] Override http request option.
|
|
57893
|
+
* @throws {RequiredError}
|
|
57894
|
+
* @memberof PromotionsApi
|
|
57895
|
+
*/
|
|
57896
|
+
public priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig) {
|
|
57897
|
+
return PromotionsApiFp(this.configuration).priceKioskBasketWithPromotions(businessId, priceBasketDto, options).then((request) => request(this.axios, this.basePath));
|
|
57898
|
+
}
|
|
57899
|
+
}
|
|
57900
|
+
|
|
57901
|
+
|
|
57902
|
+
/**
|
|
57903
|
+
* ProviderApi - axios parameter creator
|
|
57904
|
+
* @export
|
|
57905
|
+
*/
|
|
57906
|
+
export const ProviderApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
57907
|
+
return {
|
|
57908
|
+
/**
|
|
57909
|
+
* Asks the channel\'s service (ubereats-service for UberEats, wolt-service for Wolt and WoltStorefront, resq-service for ResQ) for a sign-in session and answers it as that service answered it. Nothing is written here.
|
|
57910
|
+
* @summary Start connecting a venue to Uber Eats, Wolt or ResQ
|
|
57911
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
57912
|
+
* @param {CreateOnboardingSessionDto} createOnboardingSessionDto
|
|
57913
|
+
* @param {*} [options] Override http request option.
|
|
57914
|
+
* @throws {RequiredError}
|
|
57915
|
+
*/
|
|
57916
|
+
createOnboardingSession: async (channel: ProviderEnum, createOnboardingSessionDto: CreateOnboardingSessionDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57917
|
+
// verify required parameter 'channel' is not null or undefined
|
|
57918
|
+
assertParamExists('createOnboardingSession', 'channel', channel)
|
|
57919
|
+
// verify required parameter 'createOnboardingSessionDto' is not null or undefined
|
|
57920
|
+
assertParamExists('createOnboardingSession', 'createOnboardingSessionDto', createOnboardingSessionDto)
|
|
57921
|
+
const localVarPath = `/api/v1/provider/onboarding/{channel}/sessions`
|
|
57922
|
+
.replace(`{${"channel"}}`, encodeURIComponent(String(channel)));
|
|
57923
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57924
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57925
|
+
let baseOptions;
|
|
57926
|
+
if (configuration) {
|
|
57927
|
+
baseOptions = configuration.baseOptions;
|
|
57928
|
+
}
|
|
57929
|
+
|
|
57930
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
57931
|
+
const localVarHeaderParameter = {} as any;
|
|
57932
|
+
const localVarQueryParameter = {} as any;
|
|
57933
|
+
|
|
57934
|
+
|
|
57935
|
+
|
|
57936
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
57937
|
+
|
|
57938
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57939
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57940
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57941
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createOnboardingSessionDto, localVarRequestOptions, configuration)
|
|
57942
|
+
|
|
57943
|
+
return {
|
|
57944
|
+
url: toPathString(localVarUrlObj),
|
|
57945
|
+
options: localVarRequestOptions,
|
|
57946
|
+
};
|
|
57947
|
+
},
|
|
57948
|
+
/**
|
|
57949
|
+
* The channel\'s service disconnects the venue, writes its provider row and announces the change; its answer is passed on as it is: Uber Eats\' disconnected store, or the message of wolt-service or resq-service.
|
|
57950
|
+
* @summary Disconnect a venue from Uber Eats, Wolt or ResQ
|
|
57951
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
57952
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57953
|
+
* @param {*} [options] Override http request option.
|
|
57954
|
+
* @throws {RequiredError}
|
|
57955
|
+
*/
|
|
57956
|
+
disconnectOnboarding: async (channel: ProviderEnum, businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57957
|
+
// verify required parameter 'channel' is not null or undefined
|
|
57958
|
+
assertParamExists('disconnectOnboarding', 'channel', channel)
|
|
57959
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
57960
|
+
assertParamExists('disconnectOnboarding', 'businessId', businessId)
|
|
57961
|
+
const localVarPath = `/api/v1/provider/onboarding/{channel}/{businessId}`
|
|
57962
|
+
.replace(`{${"channel"}}`, encodeURIComponent(String(channel)))
|
|
57963
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
57964
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57965
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57966
|
+
let baseOptions;
|
|
57967
|
+
if (configuration) {
|
|
57968
|
+
baseOptions = configuration.baseOptions;
|
|
57969
|
+
}
|
|
57970
|
+
|
|
57971
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
57972
|
+
const localVarHeaderParameter = {} as any;
|
|
57973
|
+
const localVarQueryParameter = {} as any;
|
|
57974
|
+
|
|
57975
|
+
|
|
57976
|
+
|
|
57977
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57978
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57979
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57980
|
+
|
|
57981
|
+
return {
|
|
57982
|
+
url: toPathString(localVarUrlObj),
|
|
57983
|
+
options: localVarRequestOptions,
|
|
57984
|
+
};
|
|
57985
|
+
},
|
|
57986
|
+
/**
|
|
57987
|
+
* The venue\'s channels that take the menu, so the till can switch a product\'s availability on each. Kept per venue under menu-integrations:<businessId>, an empty list too, and cleared when the venue\'s providers change (SYNC_KEY.BUSINESS_PROVIDER_SUPPORTED_INTEGRATIONS).
|
|
57988
|
+
* @summary Get provider integrations (MENU) for a business
|
|
57989
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57990
|
+
* @param {*} [options] Override http request option.
|
|
57991
|
+
* @throws {RequiredError}
|
|
57992
|
+
*/
|
|
57993
|
+
getMenuIntegrations: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57994
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
57995
|
+
assertParamExists('getMenuIntegrations', 'businessId', businessId)
|
|
57996
|
+
const localVarPath = `/api/v1/provider/integrations/{businessId}`
|
|
57997
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
57998
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57999
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
58000
|
+
let baseOptions;
|
|
58001
|
+
if (configuration) {
|
|
58002
|
+
baseOptions = configuration.baseOptions;
|
|
58003
|
+
}
|
|
58004
|
+
|
|
58005
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
58006
|
+
const localVarHeaderParameter = {} as any;
|
|
58007
|
+
const localVarQueryParameter = {} as any;
|
|
58008
|
+
|
|
58009
|
+
|
|
58010
|
+
|
|
58011
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
58012
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
58013
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
58014
|
+
|
|
58015
|
+
return {
|
|
58016
|
+
url: toPathString(localVarUrlObj),
|
|
58017
|
+
options: localVarRequestOptions,
|
|
58018
|
+
};
|
|
58019
|
+
},
|
|
58020
|
+
/**
|
|
58021
|
+
* The channel\'s service answers, and its answer is passed on as it is: Uber Eats\' shape for UberEats, Wolt\'s for Wolt, WoltStorefront and ResQ. Not cached: the dashboard acts on it.
|
|
58022
|
+
* @summary Whether a venue is connected to Uber Eats, Wolt or ResQ
|
|
58023
|
+
* @param {ProviderEnum} channel The channel to connect: UberEats, Wolt, WoltStorefront or ResQ. Any other channel is answered 400
|
|
58024
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
58025
|
+
* @param {*} [options] Override http request option.
|
|
58026
|
+
* @throws {RequiredError}
|
|
58027
|
+
*/
|
|
58028
|
+
getOnboardingStatus: async (channel: ProviderEnum, businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
58029
|
+
// verify required parameter 'channel' is not null or undefined
|
|
58030
|
+
assertParamExists('getOnboardingStatus', 'channel', channel)
|
|
58031
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
58032
|
+
assertParamExists('getOnboardingStatus', 'businessId', businessId)
|
|
58033
|
+
const localVarPath = `/api/v1/provider/onboarding/{channel}/status/{businessId}`
|
|
58034
|
+
.replace(`{${"channel"}}`, encodeURIComponent(String(channel)))
|
|
56490
58035
|
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
56491
58036
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56492
58037
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -58862,6 +60407,600 @@ export class ReportV6Api extends BaseAPI implements ReportV6ApiInterface {
|
|
|
58862
60407
|
}
|
|
58863
60408
|
|
|
58864
60409
|
|
|
60410
|
+
/**
|
|
60411
|
+
* ResQApi - axios parameter creator
|
|
60412
|
+
* @export
|
|
60413
|
+
*/
|
|
60414
|
+
export const ResQApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
60415
|
+
return {
|
|
60416
|
+
/**
|
|
60417
|
+
* resq-service changes only the fields sent, at ResQ, and answers the offer. The price is not among them: switch the offer off and create a new one.
|
|
60418
|
+
* @summary Change a venue\'s ResQ offer
|
|
60419
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60420
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60421
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
60422
|
+
* @param {*} [options] Override http request option.
|
|
60423
|
+
* @throws {RequiredError}
|
|
60424
|
+
*/
|
|
60425
|
+
changeResQOffer: async (businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
60426
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
60427
|
+
assertParamExists('changeResQOffer', 'businessId', businessId)
|
|
60428
|
+
// verify required parameter 'offerId' is not null or undefined
|
|
60429
|
+
assertParamExists('changeResQOffer', 'offerId', offerId)
|
|
60430
|
+
// verify required parameter 'changeResQOfferDto' is not null or undefined
|
|
60431
|
+
assertParamExists('changeResQOffer', 'changeResQOfferDto', changeResQOfferDto)
|
|
60432
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/offers/{offerId}`
|
|
60433
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
60434
|
+
.replace(`{${"offerId"}}`, encodeURIComponent(String(offerId)));
|
|
60435
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60436
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
60437
|
+
let baseOptions;
|
|
60438
|
+
if (configuration) {
|
|
60439
|
+
baseOptions = configuration.baseOptions;
|
|
60440
|
+
}
|
|
60441
|
+
|
|
60442
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
60443
|
+
const localVarHeaderParameter = {} as any;
|
|
60444
|
+
const localVarQueryParameter = {} as any;
|
|
60445
|
+
|
|
60446
|
+
// authentication JWT-auth required
|
|
60447
|
+
// http bearer authentication required
|
|
60448
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
60449
|
+
|
|
60450
|
+
|
|
60451
|
+
|
|
60452
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
60453
|
+
|
|
60454
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
60455
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
60456
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
60457
|
+
localVarRequestOptions.data = serializeDataIfNeeded(changeResQOfferDto, localVarRequestOptions, configuration)
|
|
60458
|
+
|
|
60459
|
+
return {
|
|
60460
|
+
url: toPathString(localVarUrlObj),
|
|
60461
|
+
options: localVarRequestOptions,
|
|
60462
|
+
};
|
|
60463
|
+
},
|
|
60464
|
+
/**
|
|
60465
|
+
* resq-service creates the offer at ResQ with the venue\'s own ResQ access and answers it. Its price cannot be changed afterwards: switch it off and create a new one.
|
|
60466
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
60467
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60468
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
60469
|
+
* @param {*} [options] Override http request option.
|
|
60470
|
+
* @throws {RequiredError}
|
|
60471
|
+
*/
|
|
60472
|
+
createResQOffer: async (businessId: number, createResQOfferDto: CreateResQOfferDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
60473
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
60474
|
+
assertParamExists('createResQOffer', 'businessId', businessId)
|
|
60475
|
+
// verify required parameter 'createResQOfferDto' is not null or undefined
|
|
60476
|
+
assertParamExists('createResQOffer', 'createResQOfferDto', createResQOfferDto)
|
|
60477
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/offers`
|
|
60478
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
60479
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60480
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
60481
|
+
let baseOptions;
|
|
60482
|
+
if (configuration) {
|
|
60483
|
+
baseOptions = configuration.baseOptions;
|
|
60484
|
+
}
|
|
60485
|
+
|
|
60486
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
60487
|
+
const localVarHeaderParameter = {} as any;
|
|
60488
|
+
const localVarQueryParameter = {} as any;
|
|
60489
|
+
|
|
60490
|
+
// authentication JWT-auth required
|
|
60491
|
+
// http bearer authentication required
|
|
60492
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
60493
|
+
|
|
60494
|
+
|
|
60495
|
+
|
|
60496
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
60497
|
+
|
|
60498
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
60499
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
60500
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
60501
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createResQOfferDto, localVarRequestOptions, configuration)
|
|
60502
|
+
|
|
60503
|
+
return {
|
|
60504
|
+
url: toPathString(localVarUrlObj),
|
|
60505
|
+
options: localVarRequestOptions,
|
|
60506
|
+
};
|
|
60507
|
+
},
|
|
60508
|
+
/**
|
|
60509
|
+
* resq-service takes the offer off sale at ResQ. An offer switched off cannot be turned back on: create a new one. No body: read the list again for the offer as ResQ holds it.
|
|
60510
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
60511
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60512
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60513
|
+
* @param {*} [options] Override http request option.
|
|
60514
|
+
* @throws {RequiredError}
|
|
60515
|
+
*/
|
|
60516
|
+
deactivateResQOffer: async (businessId: number, offerId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
60517
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
60518
|
+
assertParamExists('deactivateResQOffer', 'businessId', businessId)
|
|
60519
|
+
// verify required parameter 'offerId' is not null or undefined
|
|
60520
|
+
assertParamExists('deactivateResQOffer', 'offerId', offerId)
|
|
60521
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/offers/{offerId}/deactivate`
|
|
60522
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
60523
|
+
.replace(`{${"offerId"}}`, encodeURIComponent(String(offerId)));
|
|
60524
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60525
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
60526
|
+
let baseOptions;
|
|
60527
|
+
if (configuration) {
|
|
60528
|
+
baseOptions = configuration.baseOptions;
|
|
60529
|
+
}
|
|
60530
|
+
|
|
60531
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
60532
|
+
const localVarHeaderParameter = {} as any;
|
|
60533
|
+
const localVarQueryParameter = {} as any;
|
|
60534
|
+
|
|
60535
|
+
// authentication JWT-auth required
|
|
60536
|
+
// http bearer authentication required
|
|
60537
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
60538
|
+
|
|
60539
|
+
|
|
60540
|
+
|
|
60541
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
60542
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
60543
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
60544
|
+
|
|
60545
|
+
return {
|
|
60546
|
+
url: toPathString(localVarUrlObj),
|
|
60547
|
+
options: localVarRequestOptions,
|
|
60548
|
+
};
|
|
60549
|
+
},
|
|
60550
|
+
/**
|
|
60551
|
+
* resq-service reads the order from ResQ with the venue\'s own ResQ access, with who picks it up and when; nothing is kept here.
|
|
60552
|
+
* @summary Read one ResQ order of a venue
|
|
60553
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60554
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
60555
|
+
* @param {*} [options] Override http request option.
|
|
60556
|
+
* @throws {RequiredError}
|
|
60557
|
+
*/
|
|
60558
|
+
getResQOrder: async (businessId: number, orderId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
60559
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
60560
|
+
assertParamExists('getResQOrder', 'businessId', businessId)
|
|
60561
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
60562
|
+
assertParamExists('getResQOrder', 'orderId', orderId)
|
|
60563
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/orders/{orderId}`
|
|
60564
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
60565
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
60566
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60567
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
60568
|
+
let baseOptions;
|
|
60569
|
+
if (configuration) {
|
|
60570
|
+
baseOptions = configuration.baseOptions;
|
|
60571
|
+
}
|
|
60572
|
+
|
|
60573
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
60574
|
+
const localVarHeaderParameter = {} as any;
|
|
60575
|
+
const localVarQueryParameter = {} as any;
|
|
60576
|
+
|
|
60577
|
+
// authentication JWT-auth required
|
|
60578
|
+
// http bearer authentication required
|
|
60579
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
60580
|
+
|
|
60581
|
+
|
|
60582
|
+
|
|
60583
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
60584
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
60585
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
60586
|
+
|
|
60587
|
+
return {
|
|
60588
|
+
url: toPathString(localVarUrlObj),
|
|
60589
|
+
options: localVarRequestOptions,
|
|
60590
|
+
};
|
|
60591
|
+
},
|
|
60592
|
+
/**
|
|
60593
|
+
* resq-service reads the venue\'s offers from ResQ with the venue\'s own ResQ access; nothing is kept here. Offers switched off are listed too, with active false.
|
|
60594
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
60595
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60596
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60597
|
+
* @param {*} [options] Override http request option.
|
|
60598
|
+
* @throws {RequiredError}
|
|
60599
|
+
*/
|
|
60600
|
+
listResQOffers: async (businessId: number, page?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
60601
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
60602
|
+
assertParamExists('listResQOffers', 'businessId', businessId)
|
|
60603
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/offers`
|
|
60604
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
60605
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60606
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
60607
|
+
let baseOptions;
|
|
60608
|
+
if (configuration) {
|
|
60609
|
+
baseOptions = configuration.baseOptions;
|
|
60610
|
+
}
|
|
60611
|
+
|
|
60612
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
60613
|
+
const localVarHeaderParameter = {} as any;
|
|
60614
|
+
const localVarQueryParameter = {} as any;
|
|
60615
|
+
|
|
60616
|
+
// authentication JWT-auth required
|
|
60617
|
+
// http bearer authentication required
|
|
60618
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
60619
|
+
|
|
60620
|
+
if (page !== undefined) {
|
|
60621
|
+
localVarQueryParameter['page'] = page;
|
|
60622
|
+
}
|
|
60623
|
+
|
|
60624
|
+
|
|
60625
|
+
|
|
60626
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
60627
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
60628
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
60629
|
+
|
|
60630
|
+
return {
|
|
60631
|
+
url: toPathString(localVarUrlObj),
|
|
60632
|
+
options: localVarRequestOptions,
|
|
60633
|
+
};
|
|
60634
|
+
},
|
|
60635
|
+
/**
|
|
60636
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
60637
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
60638
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60639
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60640
|
+
* @param {*} [options] Override http request option.
|
|
60641
|
+
* @throws {RequiredError}
|
|
60642
|
+
*/
|
|
60643
|
+
listResQOrders: async (businessId: number, page?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
60644
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
60645
|
+
assertParamExists('listResQOrders', 'businessId', businessId)
|
|
60646
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/orders`
|
|
60647
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
60648
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
60649
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
60650
|
+
let baseOptions;
|
|
60651
|
+
if (configuration) {
|
|
60652
|
+
baseOptions = configuration.baseOptions;
|
|
60653
|
+
}
|
|
60654
|
+
|
|
60655
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
60656
|
+
const localVarHeaderParameter = {} as any;
|
|
60657
|
+
const localVarQueryParameter = {} as any;
|
|
60658
|
+
|
|
60659
|
+
// authentication JWT-auth required
|
|
60660
|
+
// http bearer authentication required
|
|
60661
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
60662
|
+
|
|
60663
|
+
if (page !== undefined) {
|
|
60664
|
+
localVarQueryParameter['page'] = page;
|
|
60665
|
+
}
|
|
60666
|
+
|
|
60667
|
+
|
|
60668
|
+
|
|
60669
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
60670
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
60671
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
60672
|
+
|
|
60673
|
+
return {
|
|
60674
|
+
url: toPathString(localVarUrlObj),
|
|
60675
|
+
options: localVarRequestOptions,
|
|
60676
|
+
};
|
|
60677
|
+
},
|
|
60678
|
+
}
|
|
60679
|
+
};
|
|
60680
|
+
|
|
60681
|
+
/**
|
|
60682
|
+
* ResQApi - functional programming interface
|
|
60683
|
+
* @export
|
|
60684
|
+
*/
|
|
60685
|
+
export const ResQApiFp = function(configuration?: Configuration) {
|
|
60686
|
+
const localVarAxiosParamCreator = ResQApiAxiosParamCreator(configuration)
|
|
60687
|
+
return {
|
|
60688
|
+
/**
|
|
60689
|
+
* resq-service changes only the fields sent, at ResQ, and answers the offer. The price is not among them: switch the offer off and create a new one.
|
|
60690
|
+
* @summary Change a venue\'s ResQ offer
|
|
60691
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60692
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60693
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
60694
|
+
* @param {*} [options] Override http request option.
|
|
60695
|
+
* @throws {RequiredError}
|
|
60696
|
+
*/
|
|
60697
|
+
async changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOfferDto>> {
|
|
60698
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.changeResQOffer(businessId, offerId, changeResQOfferDto, options);
|
|
60699
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60700
|
+
},
|
|
60701
|
+
/**
|
|
60702
|
+
* resq-service creates the offer at ResQ with the venue\'s own ResQ access and answers it. Its price cannot be changed afterwards: switch it off and create a new one.
|
|
60703
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
60704
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60705
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
60706
|
+
* @param {*} [options] Override http request option.
|
|
60707
|
+
* @throws {RequiredError}
|
|
60708
|
+
*/
|
|
60709
|
+
async createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOfferDto>> {
|
|
60710
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createResQOffer(businessId, createResQOfferDto, options);
|
|
60711
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60712
|
+
},
|
|
60713
|
+
/**
|
|
60714
|
+
* resq-service takes the offer off sale at ResQ. An offer switched off cannot be turned back on: create a new one. No body: read the list again for the offer as ResQ holds it.
|
|
60715
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
60716
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60717
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60718
|
+
* @param {*} [options] Override http request option.
|
|
60719
|
+
* @throws {RequiredError}
|
|
60720
|
+
*/
|
|
60721
|
+
async deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
60722
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deactivateResQOffer(businessId, offerId, options);
|
|
60723
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60724
|
+
},
|
|
60725
|
+
/**
|
|
60726
|
+
* resq-service reads the order from ResQ with the venue\'s own ResQ access, with who picks it up and when; nothing is kept here.
|
|
60727
|
+
* @summary Read one ResQ order of a venue
|
|
60728
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60729
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
60730
|
+
* @param {*} [options] Override http request option.
|
|
60731
|
+
* @throws {RequiredError}
|
|
60732
|
+
*/
|
|
60733
|
+
async getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOrderDto>> {
|
|
60734
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getResQOrder(businessId, orderId, options);
|
|
60735
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60736
|
+
},
|
|
60737
|
+
/**
|
|
60738
|
+
* resq-service reads the venue\'s offers from ResQ with the venue\'s own ResQ access; nothing is kept here. Offers switched off are listed too, with active false.
|
|
60739
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
60740
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60741
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60742
|
+
* @param {*} [options] Override http request option.
|
|
60743
|
+
* @throws {RequiredError}
|
|
60744
|
+
*/
|
|
60745
|
+
async listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOffersPageDto>> {
|
|
60746
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listResQOffers(businessId, page, options);
|
|
60747
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60748
|
+
},
|
|
60749
|
+
/**
|
|
60750
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
60751
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
60752
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60753
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60754
|
+
* @param {*} [options] Override http request option.
|
|
60755
|
+
* @throws {RequiredError}
|
|
60756
|
+
*/
|
|
60757
|
+
async listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOrdersPageDto>> {
|
|
60758
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listResQOrders(businessId, page, options);
|
|
60759
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60760
|
+
},
|
|
60761
|
+
}
|
|
60762
|
+
};
|
|
60763
|
+
|
|
60764
|
+
/**
|
|
60765
|
+
* ResQApi - factory interface
|
|
60766
|
+
* @export
|
|
60767
|
+
*/
|
|
60768
|
+
export const ResQApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
60769
|
+
const localVarFp = ResQApiFp(configuration)
|
|
60770
|
+
return {
|
|
60771
|
+
/**
|
|
60772
|
+
* resq-service changes only the fields sent, at ResQ, and answers the offer. The price is not among them: switch the offer off and create a new one.
|
|
60773
|
+
* @summary Change a venue\'s ResQ offer
|
|
60774
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60775
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60776
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
60777
|
+
* @param {*} [options] Override http request option.
|
|
60778
|
+
* @throws {RequiredError}
|
|
60779
|
+
*/
|
|
60780
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: any): AxiosPromise<ResQOfferDto> {
|
|
60781
|
+
return localVarFp.changeResQOffer(businessId, offerId, changeResQOfferDto, options).then((request) => request(axios, basePath));
|
|
60782
|
+
},
|
|
60783
|
+
/**
|
|
60784
|
+
* resq-service creates the offer at ResQ with the venue\'s own ResQ access and answers it. Its price cannot be changed afterwards: switch it off and create a new one.
|
|
60785
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
60786
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60787
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
60788
|
+
* @param {*} [options] Override http request option.
|
|
60789
|
+
* @throws {RequiredError}
|
|
60790
|
+
*/
|
|
60791
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: any): AxiosPromise<ResQOfferDto> {
|
|
60792
|
+
return localVarFp.createResQOffer(businessId, createResQOfferDto, options).then((request) => request(axios, basePath));
|
|
60793
|
+
},
|
|
60794
|
+
/**
|
|
60795
|
+
* resq-service takes the offer off sale at ResQ. An offer switched off cannot be turned back on: create a new one. No body: read the list again for the offer as ResQ holds it.
|
|
60796
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
60797
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60798
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60799
|
+
* @param {*} [options] Override http request option.
|
|
60800
|
+
* @throws {RequiredError}
|
|
60801
|
+
*/
|
|
60802
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: any): AxiosPromise<void> {
|
|
60803
|
+
return localVarFp.deactivateResQOffer(businessId, offerId, options).then((request) => request(axios, basePath));
|
|
60804
|
+
},
|
|
60805
|
+
/**
|
|
60806
|
+
* resq-service reads the order from ResQ with the venue\'s own ResQ access, with who picks it up and when; nothing is kept here.
|
|
60807
|
+
* @summary Read one ResQ order of a venue
|
|
60808
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60809
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
60810
|
+
* @param {*} [options] Override http request option.
|
|
60811
|
+
* @throws {RequiredError}
|
|
60812
|
+
*/
|
|
60813
|
+
getResQOrder(businessId: number, orderId: string, options?: any): AxiosPromise<ResQOrderDto> {
|
|
60814
|
+
return localVarFp.getResQOrder(businessId, orderId, options).then((request) => request(axios, basePath));
|
|
60815
|
+
},
|
|
60816
|
+
/**
|
|
60817
|
+
* resq-service reads the venue\'s offers from ResQ with the venue\'s own ResQ access; nothing is kept here. Offers switched off are listed too, with active false.
|
|
60818
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
60819
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60820
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60821
|
+
* @param {*} [options] Override http request option.
|
|
60822
|
+
* @throws {RequiredError}
|
|
60823
|
+
*/
|
|
60824
|
+
listResQOffers(businessId: number, page?: number, options?: any): AxiosPromise<ResQOffersPageDto> {
|
|
60825
|
+
return localVarFp.listResQOffers(businessId, page, options).then((request) => request(axios, basePath));
|
|
60826
|
+
},
|
|
60827
|
+
/**
|
|
60828
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
60829
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
60830
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60831
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60832
|
+
* @param {*} [options] Override http request option.
|
|
60833
|
+
* @throws {RequiredError}
|
|
60834
|
+
*/
|
|
60835
|
+
listResQOrders(businessId: number, page?: number, options?: any): AxiosPromise<ResQOrdersPageDto> {
|
|
60836
|
+
return localVarFp.listResQOrders(businessId, page, options).then((request) => request(axios, basePath));
|
|
60837
|
+
},
|
|
60838
|
+
};
|
|
60839
|
+
};
|
|
60840
|
+
|
|
60841
|
+
/**
|
|
60842
|
+
* ResQApi - interface
|
|
60843
|
+
* @export
|
|
60844
|
+
* @interface ResQApi
|
|
60845
|
+
*/
|
|
60846
|
+
export interface ResQApiInterface {
|
|
60847
|
+
/**
|
|
60848
|
+
* resq-service changes only the fields sent, at ResQ, and answers the offer. The price is not among them: switch the offer off and create a new one.
|
|
60849
|
+
* @summary Change a venue\'s ResQ offer
|
|
60850
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60851
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60852
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
60853
|
+
* @param {*} [options] Override http request option.
|
|
60854
|
+
* @throws {RequiredError}
|
|
60855
|
+
* @memberof ResQApiInterface
|
|
60856
|
+
*/
|
|
60857
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig): AxiosPromise<ResQOfferDto>;
|
|
60858
|
+
|
|
60859
|
+
/**
|
|
60860
|
+
* resq-service creates the offer at ResQ with the venue\'s own ResQ access and answers it. Its price cannot be changed afterwards: switch it off and create a new one.
|
|
60861
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
60862
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60863
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
60864
|
+
* @param {*} [options] Override http request option.
|
|
60865
|
+
* @throws {RequiredError}
|
|
60866
|
+
* @memberof ResQApiInterface
|
|
60867
|
+
*/
|
|
60868
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig): AxiosPromise<ResQOfferDto>;
|
|
60869
|
+
|
|
60870
|
+
/**
|
|
60871
|
+
* resq-service takes the offer off sale at ResQ. An offer switched off cannot be turned back on: create a new one. No body: read the list again for the offer as ResQ holds it.
|
|
60872
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
60873
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60874
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60875
|
+
* @param {*} [options] Override http request option.
|
|
60876
|
+
* @throws {RequiredError}
|
|
60877
|
+
* @memberof ResQApiInterface
|
|
60878
|
+
*/
|
|
60879
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
60880
|
+
|
|
60881
|
+
/**
|
|
60882
|
+
* resq-service reads the order from ResQ with the venue\'s own ResQ access, with who picks it up and when; nothing is kept here.
|
|
60883
|
+
* @summary Read one ResQ order of a venue
|
|
60884
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60885
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
60886
|
+
* @param {*} [options] Override http request option.
|
|
60887
|
+
* @throws {RequiredError}
|
|
60888
|
+
* @memberof ResQApiInterface
|
|
60889
|
+
*/
|
|
60890
|
+
getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig): AxiosPromise<ResQOrderDto>;
|
|
60891
|
+
|
|
60892
|
+
/**
|
|
60893
|
+
* resq-service reads the venue\'s offers from ResQ with the venue\'s own ResQ access; nothing is kept here. Offers switched off are listed too, with active false.
|
|
60894
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
60895
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60896
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60897
|
+
* @param {*} [options] Override http request option.
|
|
60898
|
+
* @throws {RequiredError}
|
|
60899
|
+
* @memberof ResQApiInterface
|
|
60900
|
+
*/
|
|
60901
|
+
listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig): AxiosPromise<ResQOffersPageDto>;
|
|
60902
|
+
|
|
60903
|
+
/**
|
|
60904
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
60905
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
60906
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60907
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60908
|
+
* @param {*} [options] Override http request option.
|
|
60909
|
+
* @throws {RequiredError}
|
|
60910
|
+
* @memberof ResQApiInterface
|
|
60911
|
+
*/
|
|
60912
|
+
listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig): AxiosPromise<ResQOrdersPageDto>;
|
|
60913
|
+
|
|
60914
|
+
}
|
|
60915
|
+
|
|
60916
|
+
/**
|
|
60917
|
+
* ResQApi - object-oriented interface
|
|
60918
|
+
* @export
|
|
60919
|
+
* @class ResQApi
|
|
60920
|
+
* @extends {BaseAPI}
|
|
60921
|
+
*/
|
|
60922
|
+
export class ResQApi extends BaseAPI implements ResQApiInterface {
|
|
60923
|
+
/**
|
|
60924
|
+
* resq-service changes only the fields sent, at ResQ, and answers the offer. The price is not among them: switch the offer off and create a new one.
|
|
60925
|
+
* @summary Change a venue\'s ResQ offer
|
|
60926
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60927
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60928
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
60929
|
+
* @param {*} [options] Override http request option.
|
|
60930
|
+
* @throws {RequiredError}
|
|
60931
|
+
* @memberof ResQApi
|
|
60932
|
+
*/
|
|
60933
|
+
public changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig) {
|
|
60934
|
+
return ResQApiFp(this.configuration).changeResQOffer(businessId, offerId, changeResQOfferDto, options).then((request) => request(this.axios, this.basePath));
|
|
60935
|
+
}
|
|
60936
|
+
|
|
60937
|
+
/**
|
|
60938
|
+
* resq-service creates the offer at ResQ with the venue\'s own ResQ access and answers it. Its price cannot be changed afterwards: switch it off and create a new one.
|
|
60939
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
60940
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60941
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
60942
|
+
* @param {*} [options] Override http request option.
|
|
60943
|
+
* @throws {RequiredError}
|
|
60944
|
+
* @memberof ResQApi
|
|
60945
|
+
*/
|
|
60946
|
+
public createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig) {
|
|
60947
|
+
return ResQApiFp(this.configuration).createResQOffer(businessId, createResQOfferDto, options).then((request) => request(this.axios, this.basePath));
|
|
60948
|
+
}
|
|
60949
|
+
|
|
60950
|
+
/**
|
|
60951
|
+
* resq-service takes the offer off sale at ResQ. An offer switched off cannot be turned back on: create a new one. No body: read the list again for the offer as ResQ holds it.
|
|
60952
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
60953
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60954
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60955
|
+
* @param {*} [options] Override http request option.
|
|
60956
|
+
* @throws {RequiredError}
|
|
60957
|
+
* @memberof ResQApi
|
|
60958
|
+
*/
|
|
60959
|
+
public deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig) {
|
|
60960
|
+
return ResQApiFp(this.configuration).deactivateResQOffer(businessId, offerId, options).then((request) => request(this.axios, this.basePath));
|
|
60961
|
+
}
|
|
60962
|
+
|
|
60963
|
+
/**
|
|
60964
|
+
* resq-service reads the order from ResQ with the venue\'s own ResQ access, with who picks it up and when; nothing is kept here.
|
|
60965
|
+
* @summary Read one ResQ order of a venue
|
|
60966
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60967
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
60968
|
+
* @param {*} [options] Override http request option.
|
|
60969
|
+
* @throws {RequiredError}
|
|
60970
|
+
* @memberof ResQApi
|
|
60971
|
+
*/
|
|
60972
|
+
public getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig) {
|
|
60973
|
+
return ResQApiFp(this.configuration).getResQOrder(businessId, orderId, options).then((request) => request(this.axios, this.basePath));
|
|
60974
|
+
}
|
|
60975
|
+
|
|
60976
|
+
/**
|
|
60977
|
+
* resq-service reads the venue\'s offers from ResQ with the venue\'s own ResQ access; nothing is kept here. Offers switched off are listed too, with active false.
|
|
60978
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
60979
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60980
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60981
|
+
* @param {*} [options] Override http request option.
|
|
60982
|
+
* @throws {RequiredError}
|
|
60983
|
+
* @memberof ResQApi
|
|
60984
|
+
*/
|
|
60985
|
+
public listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig) {
|
|
60986
|
+
return ResQApiFp(this.configuration).listResQOffers(businessId, page, options).then((request) => request(this.axios, this.basePath));
|
|
60987
|
+
}
|
|
60988
|
+
|
|
60989
|
+
/**
|
|
60990
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
60991
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
60992
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60993
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60994
|
+
* @param {*} [options] Override http request option.
|
|
60995
|
+
* @throws {RequiredError}
|
|
60996
|
+
* @memberof ResQApi
|
|
60997
|
+
*/
|
|
60998
|
+
public listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig) {
|
|
60999
|
+
return ResQApiFp(this.configuration).listResQOrders(businessId, page, options).then((request) => request(this.axios, this.basePath));
|
|
61000
|
+
}
|
|
61001
|
+
}
|
|
61002
|
+
|
|
61003
|
+
|
|
58865
61004
|
/**
|
|
58866
61005
|
* ReservationsApi - axios parameter creator
|
|
58867
61006
|
* @export
|