@munchi_oy/core 2.0.7 → 2.0.8
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 +1084 -20
- 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 +1475 -20
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -2536,6 +2536,55 @@ export interface ChangePosOrdersStatusInBulkResponseDto {
|
|
|
2536
2536
|
*/
|
|
2537
2537
|
'skipped': Array<PosOrderLeftAsItIsDto>;
|
|
2538
2538
|
}
|
|
2539
|
+
/**
|
|
2540
|
+
*
|
|
2541
|
+
* @export
|
|
2542
|
+
* @interface ChangeResQOfferDto
|
|
2543
|
+
*/
|
|
2544
|
+
export interface ChangeResQOfferDto {
|
|
2545
|
+
/**
|
|
2546
|
+
* The offer\'s new name. Left out, the name stays
|
|
2547
|
+
* @type {string}
|
|
2548
|
+
* @memberof ChangeResQOfferDto
|
|
2549
|
+
*/
|
|
2550
|
+
'name'?: string;
|
|
2551
|
+
/**
|
|
2552
|
+
* The offer\'s new description. Left out, the description stays
|
|
2553
|
+
* @type {string}
|
|
2554
|
+
* @memberof ChangeResQOfferDto
|
|
2555
|
+
*/
|
|
2556
|
+
'description'?: string;
|
|
2557
|
+
/**
|
|
2558
|
+
* How many are for sale from now on. Left out, the quantity stays
|
|
2559
|
+
* @type {number}
|
|
2560
|
+
* @memberof ChangeResQOfferDto
|
|
2561
|
+
*/
|
|
2562
|
+
'quantity'?: number;
|
|
2563
|
+
/**
|
|
2564
|
+
* When ordering starts, an ISO 8601 date-time. Left out, it stays
|
|
2565
|
+
* @type {string}
|
|
2566
|
+
* @memberof ChangeResQOfferDto
|
|
2567
|
+
*/
|
|
2568
|
+
'orderStart'?: string;
|
|
2569
|
+
/**
|
|
2570
|
+
* When ordering ends, an ISO 8601 date-time. Left out, it stays
|
|
2571
|
+
* @type {string}
|
|
2572
|
+
* @memberof ChangeResQOfferDto
|
|
2573
|
+
*/
|
|
2574
|
+
'orderEnd'?: string;
|
|
2575
|
+
/**
|
|
2576
|
+
* When pick-up starts, an ISO 8601 date-time. Left out, it stays
|
|
2577
|
+
* @type {string}
|
|
2578
|
+
* @memberof ChangeResQOfferDto
|
|
2579
|
+
*/
|
|
2580
|
+
'fetchStart'?: string;
|
|
2581
|
+
/**
|
|
2582
|
+
* When pick-up ends, an ISO 8601 date-time. Left out, it stays
|
|
2583
|
+
* @type {string}
|
|
2584
|
+
* @memberof ChangeResQOfferDto
|
|
2585
|
+
*/
|
|
2586
|
+
'fetchEnd'?: string;
|
|
2587
|
+
}
|
|
2539
2588
|
/**
|
|
2540
2589
|
*
|
|
2541
2590
|
* @export
|
|
@@ -2820,6 +2869,39 @@ export interface CheckActionPasscodeDto {
|
|
|
2820
2869
|
}
|
|
2821
2870
|
|
|
2822
2871
|
|
|
2872
|
+
/**
|
|
2873
|
+
*
|
|
2874
|
+
* @export
|
|
2875
|
+
* @interface CheckCouponDto
|
|
2876
|
+
*/
|
|
2877
|
+
export interface CheckCouponDto {
|
|
2878
|
+
/**
|
|
2879
|
+
* The coupon\'s code, as typed or scanned, in any letter case
|
|
2880
|
+
* @type {string}
|
|
2881
|
+
* @memberof CheckCouponDto
|
|
2882
|
+
*/
|
|
2883
|
+
'couponCode': string;
|
|
2884
|
+
/**
|
|
2885
|
+
*
|
|
2886
|
+
* @type {OrderTypePOS}
|
|
2887
|
+
* @memberof CheckCouponDto
|
|
2888
|
+
*/
|
|
2889
|
+
'orderType': OrderTypePOS;
|
|
2890
|
+
/**
|
|
2891
|
+
* 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.
|
|
2892
|
+
* @type {string}
|
|
2893
|
+
* @memberof CheckCouponDto
|
|
2894
|
+
*/
|
|
2895
|
+
'customerPhone'?: string;
|
|
2896
|
+
/**
|
|
2897
|
+
* The order\'s lines as they stand; checked again whenever the basket changes
|
|
2898
|
+
* @type {Array<CouponBasketLineDto>}
|
|
2899
|
+
* @memberof CheckCouponDto
|
|
2900
|
+
*/
|
|
2901
|
+
'lines': Array<CouponBasketLineDto>;
|
|
2902
|
+
}
|
|
2903
|
+
|
|
2904
|
+
|
|
2823
2905
|
/**
|
|
2824
2906
|
*
|
|
2825
2907
|
* @export
|
|
@@ -3391,6 +3473,194 @@ export interface CoordinateDto {
|
|
|
3391
3473
|
*/
|
|
3392
3474
|
'lon': number;
|
|
3393
3475
|
}
|
|
3476
|
+
/**
|
|
3477
|
+
*
|
|
3478
|
+
* @export
|
|
3479
|
+
* @interface CouponBasketLineDto
|
|
3480
|
+
*/
|
|
3481
|
+
export interface CouponBasketLineDto {
|
|
3482
|
+
/**
|
|
3483
|
+
* The line\'s stable id, the one the order\'s discounts point at
|
|
3484
|
+
* @type {string}
|
|
3485
|
+
* @memberof CouponBasketLineDto
|
|
3486
|
+
*/
|
|
3487
|
+
'lineItemId': string;
|
|
3488
|
+
/**
|
|
3489
|
+
* The product\'s Vendure id: the line\'s posId, as a number
|
|
3490
|
+
* @type {number}
|
|
3491
|
+
* @memberof CouponBasketLineDto
|
|
3492
|
+
*/
|
|
3493
|
+
'productId': number;
|
|
3494
|
+
/**
|
|
3495
|
+
* How many of the product the line holds, a whole number
|
|
3496
|
+
* @type {number}
|
|
3497
|
+
* @memberof CouponBasketLineDto
|
|
3498
|
+
*/
|
|
3499
|
+
'quantity': number;
|
|
3500
|
+
/**
|
|
3501
|
+
* The price of one unit as the till charges it, options included, in cents
|
|
3502
|
+
* @type {number}
|
|
3503
|
+
* @memberof CouponBasketLineDto
|
|
3504
|
+
*/
|
|
3505
|
+
'unitAmount': number;
|
|
3506
|
+
/**
|
|
3507
|
+
* 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
|
|
3508
|
+
* @type {number}
|
|
3509
|
+
* @memberof CouponBasketLineDto
|
|
3510
|
+
*/
|
|
3511
|
+
'vatRate'?: number;
|
|
3512
|
+
}
|
|
3513
|
+
/**
|
|
3514
|
+
*
|
|
3515
|
+
* @export
|
|
3516
|
+
* @interface CouponCheckAnswerDto
|
|
3517
|
+
*/
|
|
3518
|
+
export interface CouponCheckAnswerDto {
|
|
3519
|
+
/**
|
|
3520
|
+
* true when the coupon applies to this basket; false when it does not
|
|
3521
|
+
* @type {boolean}
|
|
3522
|
+
* @memberof CouponCheckAnswerDto
|
|
3523
|
+
*/
|
|
3524
|
+
'valid': boolean;
|
|
3525
|
+
/**
|
|
3526
|
+
* The discounts to add to the order, one per application; empty when valid is false
|
|
3527
|
+
* @type {Array<CouponDiscountDto>}
|
|
3528
|
+
* @memberof CouponCheckAnswerDto
|
|
3529
|
+
*/
|
|
3530
|
+
'discounts': Array<CouponDiscountDto>;
|
|
3531
|
+
/**
|
|
3532
|
+
* 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
|
|
3533
|
+
* @type {Array<CouponRewardNotAppliedDto>}
|
|
3534
|
+
* @memberof CouponCheckAnswerDto
|
|
3535
|
+
*/
|
|
3536
|
+
'notApplied': Array<CouponRewardNotAppliedDto>;
|
|
3537
|
+
/**
|
|
3538
|
+
*
|
|
3539
|
+
* @type {CouponRefusal}
|
|
3540
|
+
* @memberof CouponCheckAnswerDto
|
|
3541
|
+
*/
|
|
3542
|
+
'reason': CouponRefusal | null;
|
|
3543
|
+
/**
|
|
3544
|
+
* What to tell the person at the till or the kiosk; null when valid is true
|
|
3545
|
+
* @type {string}
|
|
3546
|
+
* @memberof CouponCheckAnswerDto
|
|
3547
|
+
*/
|
|
3548
|
+
'message': string | null;
|
|
3549
|
+
}
|
|
3550
|
+
|
|
3551
|
+
|
|
3552
|
+
/**
|
|
3553
|
+
*
|
|
3554
|
+
* @export
|
|
3555
|
+
* @interface CouponDiscountDto
|
|
3556
|
+
*/
|
|
3557
|
+
export interface CouponDiscountDto {
|
|
3558
|
+
/**
|
|
3559
|
+
*
|
|
3560
|
+
* @type {DiscountType}
|
|
3561
|
+
* @memberof CouponDiscountDto
|
|
3562
|
+
*/
|
|
3563
|
+
'type': DiscountType;
|
|
3564
|
+
/**
|
|
3565
|
+
* A percentage for PERCENTAGE (10 is 10%), cents for FIXED
|
|
3566
|
+
* @type {number}
|
|
3567
|
+
* @memberof CouponDiscountDto
|
|
3568
|
+
*/
|
|
3569
|
+
'value': number;
|
|
3570
|
+
/**
|
|
3571
|
+
*
|
|
3572
|
+
* @type {DiscountScope}
|
|
3573
|
+
* @memberof CouponDiscountDto
|
|
3574
|
+
*/
|
|
3575
|
+
'scope': DiscountScope;
|
|
3576
|
+
/**
|
|
3577
|
+
* The line it discounts, for an ITEM discount; null for a CART discount
|
|
3578
|
+
* @type {string}
|
|
3579
|
+
* @memberof CouponDiscountDto
|
|
3580
|
+
*/
|
|
3581
|
+
'lineItemId': string | null;
|
|
3582
|
+
/**
|
|
3583
|
+
* How many units of the line it covers; absent means the whole line
|
|
3584
|
+
* @type {number}
|
|
3585
|
+
* @memberof CouponDiscountDto
|
|
3586
|
+
*/
|
|
3587
|
+
'units'?: number;
|
|
3588
|
+
/**
|
|
3589
|
+
*
|
|
3590
|
+
* @type {DiscountSourceType}
|
|
3591
|
+
* @memberof CouponDiscountDto
|
|
3592
|
+
*/
|
|
3593
|
+
'sourceType': DiscountSourceType;
|
|
3594
|
+
/**
|
|
3595
|
+
* The Vendure promotion\'s id, as text
|
|
3596
|
+
* @type {string}
|
|
3597
|
+
* @memberof CouponDiscountDto
|
|
3598
|
+
*/
|
|
3599
|
+
'sourceId': string;
|
|
3600
|
+
/**
|
|
3601
|
+
* The coupon\'s code, as the promotion holds it
|
|
3602
|
+
* @type {string}
|
|
3603
|
+
* @memberof CouponDiscountDto
|
|
3604
|
+
*/
|
|
3605
|
+
'couponCode': string;
|
|
3606
|
+
/**
|
|
3607
|
+
* The promotion\'s name, shown on the till and the receipt
|
|
3608
|
+
* @type {string}
|
|
3609
|
+
* @memberof CouponDiscountDto
|
|
3610
|
+
*/
|
|
3611
|
+
'name': string;
|
|
3612
|
+
/**
|
|
3613
|
+
* 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
|
|
3614
|
+
* @type {string}
|
|
3615
|
+
* @memberof CouponDiscountDto
|
|
3616
|
+
*/
|
|
3617
|
+
'couponCustomerPhone'?: string;
|
|
3618
|
+
}
|
|
3619
|
+
|
|
3620
|
+
|
|
3621
|
+
/**
|
|
3622
|
+
*
|
|
3623
|
+
* @export
|
|
3624
|
+
* @enum {string}
|
|
3625
|
+
*/
|
|
3626
|
+
|
|
3627
|
+
export const CouponRefusal = {
|
|
3628
|
+
NotFound: 'NOT_FOUND',
|
|
3629
|
+
NotStarted: 'NOT_STARTED',
|
|
3630
|
+
Expired: 'EXPIRED',
|
|
3631
|
+
Disabled: 'DISABLED',
|
|
3632
|
+
NotForThisApp: 'NOT_FOR_THIS_APP',
|
|
3633
|
+
NotForThisOrderType: 'NOT_FOR_THIS_ORDER_TYPE',
|
|
3634
|
+
ConditionsNotMet: 'CONDITIONS_NOT_MET',
|
|
3635
|
+
UsageLimitReached: 'USAGE_LIMIT_REACHED',
|
|
3636
|
+
CustomerLimitReached: 'CUSTOMER_LIMIT_REACHED',
|
|
3637
|
+
NotFirstOrder: 'NOT_FIRST_ORDER',
|
|
3638
|
+
CustomerPhoneRequired: 'CUSTOMER_PHONE_REQUIRED',
|
|
3639
|
+
CouponsUnavailable: 'COUPONS_UNAVAILABLE'
|
|
3640
|
+
} as const;
|
|
3641
|
+
|
|
3642
|
+
export type CouponRefusal = typeof CouponRefusal[keyof typeof CouponRefusal];
|
|
3643
|
+
|
|
3644
|
+
|
|
3645
|
+
/**
|
|
3646
|
+
*
|
|
3647
|
+
* @export
|
|
3648
|
+
* @interface CouponRewardNotAppliedDto
|
|
3649
|
+
*/
|
|
3650
|
+
export interface CouponRewardNotAppliedDto {
|
|
3651
|
+
/**
|
|
3652
|
+
* The promotion\'s reward that was left out, in Vendure\'s words
|
|
3653
|
+
* @type {string}
|
|
3654
|
+
* @memberof CouponRewardNotAppliedDto
|
|
3655
|
+
*/
|
|
3656
|
+
'reward': string;
|
|
3657
|
+
/**
|
|
3658
|
+
* Why Vendure left it out
|
|
3659
|
+
* @type {string}
|
|
3660
|
+
* @memberof CouponRewardNotAppliedDto
|
|
3661
|
+
*/
|
|
3662
|
+
'reason': string;
|
|
3663
|
+
}
|
|
3394
3664
|
/**
|
|
3395
3665
|
*
|
|
3396
3666
|
* @export
|
|
@@ -4300,13 +4570,13 @@ export interface CreateOnboardingSessionDto {
|
|
|
4300
4570
|
*/
|
|
4301
4571
|
export interface CreatePaymentMethodDto {
|
|
4302
4572
|
/**
|
|
4303
|
-
* Attach
|
|
4573
|
+
* Attach a built-in method, or one of the venue\'s own custom methods, by its code (mutually exclusive with name+type).
|
|
4304
4574
|
* @type {string}
|
|
4305
4575
|
* @memberof CreatePaymentMethodDto
|
|
4306
4576
|
*/
|
|
4307
4577
|
'code'?: string;
|
|
4308
4578
|
/**
|
|
4309
|
-
* Display name for a new custom method; required with type when code is absent.
|
|
4579
|
+
* Display name for a new custom method of this venue only; required with type when code is absent.
|
|
4310
4580
|
* @type {string}
|
|
4311
4581
|
* @memberof CreatePaymentMethodDto
|
|
4312
4582
|
*/
|
|
@@ -4457,6 +4727,73 @@ export interface CreateRefundPlanDto {
|
|
|
4457
4727
|
}
|
|
4458
4728
|
|
|
4459
4729
|
|
|
4730
|
+
/**
|
|
4731
|
+
*
|
|
4732
|
+
* @export
|
|
4733
|
+
* @interface CreateResQOfferDto
|
|
4734
|
+
*/
|
|
4735
|
+
export interface CreateResQOfferDto {
|
|
4736
|
+
/**
|
|
4737
|
+
* The offer\'s name, as ResQ\'s customers see it
|
|
4738
|
+
* @type {string}
|
|
4739
|
+
* @memberof CreateResQOfferDto
|
|
4740
|
+
*/
|
|
4741
|
+
'name': string;
|
|
4742
|
+
/**
|
|
4743
|
+
* What the offer holds, as ResQ\'s customers see it. Left out, the offer has none
|
|
4744
|
+
* @type {string}
|
|
4745
|
+
* @memberof CreateResQOfferDto
|
|
4746
|
+
*/
|
|
4747
|
+
'description'?: string;
|
|
4748
|
+
/**
|
|
4749
|
+
* An https address of the offer\'s picture. Left out, ResQ shows none
|
|
4750
|
+
* @type {string}
|
|
4751
|
+
* @memberof CreateResQOfferDto
|
|
4752
|
+
*/
|
|
4753
|
+
'imageUrl'?: string;
|
|
4754
|
+
/**
|
|
4755
|
+
* 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
|
|
4756
|
+
* @type {number}
|
|
4757
|
+
* @memberof CreateResQOfferDto
|
|
4758
|
+
*/
|
|
4759
|
+
'price': number;
|
|
4760
|
+
/**
|
|
4761
|
+
* How many are for sale
|
|
4762
|
+
* @type {number}
|
|
4763
|
+
* @memberof CreateResQOfferDto
|
|
4764
|
+
*/
|
|
4765
|
+
'quantity': number;
|
|
4766
|
+
/**
|
|
4767
|
+
* When customers can start ordering it, an ISO 8601 date-time
|
|
4768
|
+
* @type {string}
|
|
4769
|
+
* @memberof CreateResQOfferDto
|
|
4770
|
+
*/
|
|
4771
|
+
'orderStart': string;
|
|
4772
|
+
/**
|
|
4773
|
+
* When ordering it ends, an ISO 8601 date-time
|
|
4774
|
+
* @type {string}
|
|
4775
|
+
* @memberof CreateResQOfferDto
|
|
4776
|
+
*/
|
|
4777
|
+
'orderEnd': string;
|
|
4778
|
+
/**
|
|
4779
|
+
* When customers can start picking it up at the venue, an ISO 8601 date-time
|
|
4780
|
+
* @type {string}
|
|
4781
|
+
* @memberof CreateResQOfferDto
|
|
4782
|
+
*/
|
|
4783
|
+
'fetchStart': string;
|
|
4784
|
+
/**
|
|
4785
|
+
* When pick-up ends, an ISO 8601 date-time
|
|
4786
|
+
* @type {string}
|
|
4787
|
+
* @memberof CreateResQOfferDto
|
|
4788
|
+
*/
|
|
4789
|
+
'fetchEnd': string;
|
|
4790
|
+
/**
|
|
4791
|
+
* The kinds of offer ResQ files it under, at least one
|
|
4792
|
+
* @type {Array<ResQOfferTag>}
|
|
4793
|
+
* @memberof CreateResQOfferDto
|
|
4794
|
+
*/
|
|
4795
|
+
'tags': Array<ResQOfferTag>;
|
|
4796
|
+
}
|
|
4460
4797
|
/**
|
|
4461
4798
|
*
|
|
4462
4799
|
* @export
|
|
@@ -6238,7 +6575,7 @@ export interface DispatchPosOrderResponseDto {
|
|
|
6238
6575
|
*/
|
|
6239
6576
|
'ticketId': object | null;
|
|
6240
6577
|
/**
|
|
6241
|
-
* Number of that ticket:
|
|
6578
|
+
* Number of that ticket: its order\'s own number. null when no ticket was written.
|
|
6242
6579
|
* @type {object}
|
|
6243
6580
|
* @memberof DispatchPosOrderResponseDto
|
|
6244
6581
|
*/
|
|
@@ -16240,7 +16577,7 @@ export interface ParkPosOrderResponseDto {
|
|
|
16240
16577
|
*/
|
|
16241
16578
|
'ticketId': object | null;
|
|
16242
16579
|
/**
|
|
16243
|
-
* Number of that ticket:
|
|
16580
|
+
* Number of that ticket: its order\'s own number. null when no ticket was written.
|
|
16244
16581
|
* @type {object}
|
|
16245
16582
|
* @memberof ParkPosOrderResponseDto
|
|
16246
16583
|
*/
|
|
@@ -18235,6 +18572,20 @@ export interface PaymentStatusDtoTransaction {
|
|
|
18235
18572
|
}
|
|
18236
18573
|
|
|
18237
18574
|
|
|
18575
|
+
/**
|
|
18576
|
+
*
|
|
18577
|
+
* @export
|
|
18578
|
+
* @enum {string}
|
|
18579
|
+
*/
|
|
18580
|
+
|
|
18581
|
+
export const PaymentSurchargePaidBy = {
|
|
18582
|
+
Business: 'BUSINESS',
|
|
18583
|
+
Customer: 'CUSTOMER'
|
|
18584
|
+
} as const;
|
|
18585
|
+
|
|
18586
|
+
export type PaymentSurchargePaidBy = typeof PaymentSurchargePaidBy[keyof typeof PaymentSurchargePaidBy];
|
|
18587
|
+
|
|
18588
|
+
|
|
18238
18589
|
/**
|
|
18239
18590
|
*
|
|
18240
18591
|
* @export
|
|
@@ -18822,6 +19173,18 @@ export interface PosDiscountDto {
|
|
|
18822
19173
|
* @memberof PosDiscountDto
|
|
18823
19174
|
*/
|
|
18824
19175
|
'units'?: number;
|
|
19176
|
+
/**
|
|
19177
|
+
* 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.
|
|
19178
|
+
* @type {string}
|
|
19179
|
+
* @memberof PosDiscountDto
|
|
19180
|
+
*/
|
|
19181
|
+
'couponCode'?: string;
|
|
19182
|
+
/**
|
|
19183
|
+
* 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.
|
|
19184
|
+
* @type {string}
|
|
19185
|
+
* @memberof PosDiscountDto
|
|
19186
|
+
*/
|
|
19187
|
+
'couponCustomerPhone'?: string;
|
|
18825
19188
|
}
|
|
18826
19189
|
|
|
18827
19190
|
|
|
@@ -20702,6 +21065,18 @@ export interface PosOrderItemDtoDiscount {
|
|
|
20702
21065
|
* @memberof PosOrderItemDtoDiscount
|
|
20703
21066
|
*/
|
|
20704
21067
|
'units'?: number;
|
|
21068
|
+
/**
|
|
21069
|
+
* 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.
|
|
21070
|
+
* @type {string}
|
|
21071
|
+
* @memberof PosOrderItemDtoDiscount
|
|
21072
|
+
*/
|
|
21073
|
+
'couponCode'?: string;
|
|
21074
|
+
/**
|
|
21075
|
+
* 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.
|
|
21076
|
+
* @type {string}
|
|
21077
|
+
* @memberof PosOrderItemDtoDiscount
|
|
21078
|
+
*/
|
|
21079
|
+
'couponCustomerPhone'?: string;
|
|
20705
21080
|
}
|
|
20706
21081
|
|
|
20707
21082
|
|
|
@@ -24393,6 +24768,254 @@ export interface RequestSessionTokenResponseDto {
|
|
|
24393
24768
|
*/
|
|
24394
24769
|
'sessionChannel': string;
|
|
24395
24770
|
}
|
|
24771
|
+
/**
|
|
24772
|
+
*
|
|
24773
|
+
* @export
|
|
24774
|
+
* @interface ResQOfferDto
|
|
24775
|
+
*/
|
|
24776
|
+
export interface ResQOfferDto {
|
|
24777
|
+
/**
|
|
24778
|
+
* The offer\'s id at ResQ
|
|
24779
|
+
* @type {string}
|
|
24780
|
+
* @memberof ResQOfferDto
|
|
24781
|
+
*/
|
|
24782
|
+
'id': string;
|
|
24783
|
+
/**
|
|
24784
|
+
* The offer\'s name. Absent when ResQ did not send it
|
|
24785
|
+
* @type {string}
|
|
24786
|
+
* @memberof ResQOfferDto
|
|
24787
|
+
*/
|
|
24788
|
+
'name'?: string;
|
|
24789
|
+
/**
|
|
24790
|
+
* 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
|
|
24791
|
+
* @type {boolean}
|
|
24792
|
+
* @memberof ResQOfferDto
|
|
24793
|
+
*/
|
|
24794
|
+
'active'?: boolean;
|
|
24795
|
+
/**
|
|
24796
|
+
* The price of one, in cents of the venue\'s currency. Absent when ResQ did not send it
|
|
24797
|
+
* @type {number}
|
|
24798
|
+
* @memberof ResQOfferDto
|
|
24799
|
+
*/
|
|
24800
|
+
'price'?: number;
|
|
24801
|
+
/**
|
|
24802
|
+
* When ordering starts, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
24803
|
+
* @type {string}
|
|
24804
|
+
* @memberof ResQOfferDto
|
|
24805
|
+
*/
|
|
24806
|
+
'orderStart'?: string;
|
|
24807
|
+
/**
|
|
24808
|
+
* When ordering ends, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
24809
|
+
* @type {string}
|
|
24810
|
+
* @memberof ResQOfferDto
|
|
24811
|
+
*/
|
|
24812
|
+
'orderEnd'?: string;
|
|
24813
|
+
}
|
|
24814
|
+
/**
|
|
24815
|
+
*
|
|
24816
|
+
* @export
|
|
24817
|
+
* @enum {string}
|
|
24818
|
+
*/
|
|
24819
|
+
|
|
24820
|
+
export const ResQOfferTag = {
|
|
24821
|
+
Meal: 'meal',
|
|
24822
|
+
Snack: 'snack',
|
|
24823
|
+
Ingredients: 'ingredients',
|
|
24824
|
+
GroceryBag: 'grocery-bag',
|
|
24825
|
+
Dessert: 'dessert',
|
|
24826
|
+
Flowers: 'flowers',
|
|
24827
|
+
Fee: 'fee',
|
|
24828
|
+
Wholesale: 'wholesale',
|
|
24829
|
+
HomeCosmetics: 'home-cosmetics'
|
|
24830
|
+
} as const;
|
|
24831
|
+
|
|
24832
|
+
export type ResQOfferTag = typeof ResQOfferTag[keyof typeof ResQOfferTag];
|
|
24833
|
+
|
|
24834
|
+
|
|
24835
|
+
/**
|
|
24836
|
+
*
|
|
24837
|
+
* @export
|
|
24838
|
+
* @interface ResQOffersPageDto
|
|
24839
|
+
*/
|
|
24840
|
+
export interface ResQOffersPageDto {
|
|
24841
|
+
/**
|
|
24842
|
+
* The venue\'s offers on this page, as ResQ orders them
|
|
24843
|
+
* @type {Array<ResQOfferDto>}
|
|
24844
|
+
* @memberof ResQOffersPageDto
|
|
24845
|
+
*/
|
|
24846
|
+
'offers': Array<ResQOfferDto>;
|
|
24847
|
+
/**
|
|
24848
|
+
* This page\'s number, from 1
|
|
24849
|
+
* @type {number}
|
|
24850
|
+
* @memberof ResQOffersPageDto
|
|
24851
|
+
*/
|
|
24852
|
+
'page': number;
|
|
24853
|
+
/**
|
|
24854
|
+
* How many pages there are
|
|
24855
|
+
* @type {number}
|
|
24856
|
+
* @memberof ResQOffersPageDto
|
|
24857
|
+
*/
|
|
24858
|
+
'pages': number;
|
|
24859
|
+
/**
|
|
24860
|
+
* How many offers the venue has, on every page
|
|
24861
|
+
* @type {number}
|
|
24862
|
+
* @memberof ResQOffersPageDto
|
|
24863
|
+
*/
|
|
24864
|
+
'count': number;
|
|
24865
|
+
}
|
|
24866
|
+
/**
|
|
24867
|
+
*
|
|
24868
|
+
* @export
|
|
24869
|
+
* @interface ResQOrderDto
|
|
24870
|
+
*/
|
|
24871
|
+
export interface ResQOrderDto {
|
|
24872
|
+
/**
|
|
24873
|
+
* The order\'s id at ResQ
|
|
24874
|
+
* @type {string}
|
|
24875
|
+
* @memberof ResQOrderDto
|
|
24876
|
+
*/
|
|
24877
|
+
'id': string;
|
|
24878
|
+
/**
|
|
24879
|
+
* The order\'s status in ResQ\'s own words, passed on as ResQ answered it
|
|
24880
|
+
* @type {string}
|
|
24881
|
+
* @memberof ResQOrderDto
|
|
24882
|
+
*/
|
|
24883
|
+
'status': string;
|
|
24884
|
+
/**
|
|
24885
|
+
* Whether ResQ counts the order as a sale
|
|
24886
|
+
* @type {boolean}
|
|
24887
|
+
* @memberof ResQOrderDto
|
|
24888
|
+
*/
|
|
24889
|
+
'sold': boolean;
|
|
24890
|
+
/**
|
|
24891
|
+
* The customer\'s first name; null when ResQ gave none
|
|
24892
|
+
* @type {string}
|
|
24893
|
+
* @memberof ResQOrderDto
|
|
24894
|
+
*/
|
|
24895
|
+
'customerFirstName': string | null;
|
|
24896
|
+
/**
|
|
24897
|
+
* When pick-up starts, an ISO 8601 date-time; null when ResQ gave none
|
|
24898
|
+
* @type {string}
|
|
24899
|
+
* @memberof ResQOrderDto
|
|
24900
|
+
*/
|
|
24901
|
+
'fetchStart': string | null;
|
|
24902
|
+
/**
|
|
24903
|
+
* When pick-up ends, an ISO 8601 date-time; null when ResQ gave none
|
|
24904
|
+
* @type {string}
|
|
24905
|
+
* @memberof ResQOrderDto
|
|
24906
|
+
*/
|
|
24907
|
+
'fetchEnd': string | null;
|
|
24908
|
+
/**
|
|
24909
|
+
* Whether the customer has picked the order up; null when ResQ did not say
|
|
24910
|
+
* @type {boolean}
|
|
24911
|
+
* @memberof ResQOrderDto
|
|
24912
|
+
*/
|
|
24913
|
+
'pickedUp': boolean | null;
|
|
24914
|
+
/**
|
|
24915
|
+
* When the customer picked the order up, an ISO 8601 date-time; null when not picked up or ResQ did not say
|
|
24916
|
+
* @type {string}
|
|
24917
|
+
* @memberof ResQOrderDto
|
|
24918
|
+
*/
|
|
24919
|
+
'pickedUpAt': string | null;
|
|
24920
|
+
/**
|
|
24921
|
+
* How many the customer ordered; null when ResQ gave none
|
|
24922
|
+
* @type {number}
|
|
24923
|
+
* @memberof ResQOrderDto
|
|
24924
|
+
*/
|
|
24925
|
+
'quantity': number | null;
|
|
24926
|
+
/**
|
|
24927
|
+
* What the order sold for, in cents of its currency; null when ResQ gave none
|
|
24928
|
+
* @type {number}
|
|
24929
|
+
* @memberof ResQOrderDto
|
|
24930
|
+
*/
|
|
24931
|
+
'sales': number | null;
|
|
24932
|
+
/**
|
|
24933
|
+
* The order\'s currency, an ISO 4217 code; null when ResQ gave none
|
|
24934
|
+
* @type {string}
|
|
24935
|
+
* @memberof ResQOrderDto
|
|
24936
|
+
*/
|
|
24937
|
+
'currency': string | null;
|
|
24938
|
+
}
|
|
24939
|
+
/**
|
|
24940
|
+
*
|
|
24941
|
+
* @export
|
|
24942
|
+
* @interface ResQOrderSummaryDto
|
|
24943
|
+
*/
|
|
24944
|
+
export interface ResQOrderSummaryDto {
|
|
24945
|
+
/**
|
|
24946
|
+
* The order\'s id at ResQ
|
|
24947
|
+
* @type {string}
|
|
24948
|
+
* @memberof ResQOrderSummaryDto
|
|
24949
|
+
*/
|
|
24950
|
+
'id': string;
|
|
24951
|
+
/**
|
|
24952
|
+
* The order\'s status in ResQ\'s own words, passed on as ResQ answered it
|
|
24953
|
+
* @type {string}
|
|
24954
|
+
* @memberof ResQOrderSummaryDto
|
|
24955
|
+
*/
|
|
24956
|
+
'status': string;
|
|
24957
|
+
/**
|
|
24958
|
+
* Whether ResQ counts the order as a sale
|
|
24959
|
+
* @type {boolean}
|
|
24960
|
+
* @memberof ResQOrderSummaryDto
|
|
24961
|
+
*/
|
|
24962
|
+
'sold': boolean;
|
|
24963
|
+
/**
|
|
24964
|
+
* When the customer ordered, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
24965
|
+
* @type {string}
|
|
24966
|
+
* @memberof ResQOrderSummaryDto
|
|
24967
|
+
*/
|
|
24968
|
+
'createdAt'?: string;
|
|
24969
|
+
/**
|
|
24970
|
+
* How many the customer ordered. Absent when ResQ did not send it
|
|
24971
|
+
* @type {number}
|
|
24972
|
+
* @memberof ResQOrderSummaryDto
|
|
24973
|
+
*/
|
|
24974
|
+
'quantity'?: number;
|
|
24975
|
+
/**
|
|
24976
|
+
* What the order sold for, in cents of its currency. Absent when ResQ did not send it
|
|
24977
|
+
* @type {number}
|
|
24978
|
+
* @memberof ResQOrderSummaryDto
|
|
24979
|
+
*/
|
|
24980
|
+
'sales'?: number;
|
|
24981
|
+
/**
|
|
24982
|
+
* The order\'s currency, an ISO 4217 code. Absent when ResQ did not send it
|
|
24983
|
+
* @type {string}
|
|
24984
|
+
* @memberof ResQOrderSummaryDto
|
|
24985
|
+
*/
|
|
24986
|
+
'currency'?: string;
|
|
24987
|
+
}
|
|
24988
|
+
/**
|
|
24989
|
+
*
|
|
24990
|
+
* @export
|
|
24991
|
+
* @interface ResQOrdersPageDto
|
|
24992
|
+
*/
|
|
24993
|
+
export interface ResQOrdersPageDto {
|
|
24994
|
+
/**
|
|
24995
|
+
* The venue\'s ResQ orders on this page, as ResQ orders them
|
|
24996
|
+
* @type {Array<ResQOrderSummaryDto>}
|
|
24997
|
+
* @memberof ResQOrdersPageDto
|
|
24998
|
+
*/
|
|
24999
|
+
'orders': Array<ResQOrderSummaryDto>;
|
|
25000
|
+
/**
|
|
25001
|
+
* This page\'s number, from 1
|
|
25002
|
+
* @type {number}
|
|
25003
|
+
* @memberof ResQOrdersPageDto
|
|
25004
|
+
*/
|
|
25005
|
+
'page': number;
|
|
25006
|
+
/**
|
|
25007
|
+
* How many pages there are
|
|
25008
|
+
* @type {number}
|
|
25009
|
+
* @memberof ResQOrdersPageDto
|
|
25010
|
+
*/
|
|
25011
|
+
'pages': number;
|
|
25012
|
+
/**
|
|
25013
|
+
* How many orders the venue has, on every page
|
|
25014
|
+
* @type {number}
|
|
25015
|
+
* @memberof ResQOrdersPageDto
|
|
25016
|
+
*/
|
|
25017
|
+
'count': number;
|
|
25018
|
+
}
|
|
24396
25019
|
/**
|
|
24397
25020
|
*
|
|
24398
25021
|
* @export
|
|
@@ -32025,17 +32648,23 @@ export interface UpsertProvidersDto {
|
|
|
32025
32648
|
*/
|
|
32026
32649
|
'sourceCode'?: string;
|
|
32027
32650
|
/**
|
|
32028
|
-
* Viva ISV commission rate, in percent, at most two decimals. A change is saved on the license server first.
|
|
32651
|
+
* 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
32652
|
* @type {number}
|
|
32030
32653
|
* @memberof UpsertProvidersDto
|
|
32031
32654
|
*/
|
|
32032
32655
|
'rate'?: number;
|
|
32033
32656
|
/**
|
|
32034
|
-
* Viva ISV fixed fee per payment, in cents. A change is saved on the license server first.
|
|
32657
|
+
* 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
32658
|
* @type {number}
|
|
32036
32659
|
* @memberof UpsertProvidersDto
|
|
32037
32660
|
*/
|
|
32038
32661
|
'additionalAmount'?: number;
|
|
32662
|
+
/**
|
|
32663
|
+
*
|
|
32664
|
+
* @type {PaymentSurchargePaidBy}
|
|
32665
|
+
* @memberof UpsertProvidersDto
|
|
32666
|
+
*/
|
|
32667
|
+
'surchargePaidBy'?: PaymentSurchargePaidBy;
|
|
32039
32668
|
/**
|
|
32040
32669
|
* Nets / Stripe / Worldline secret key. Absent keeps the stored value.
|
|
32041
32670
|
* @type {string}
|
|
@@ -32170,6 +32799,12 @@ export interface UpsertVivaDto {
|
|
|
32170
32799
|
* @memberof UpsertVivaDto
|
|
32171
32800
|
*/
|
|
32172
32801
|
'isActive'?: boolean;
|
|
32802
|
+
/**
|
|
32803
|
+
*
|
|
32804
|
+
* @type {PaymentSurchargePaidBy}
|
|
32805
|
+
* @memberof UpsertVivaDto
|
|
32806
|
+
*/
|
|
32807
|
+
'surchargePaidBy'?: PaymentSurchargePaidBy;
|
|
32173
32808
|
/**
|
|
32174
32809
|
*
|
|
32175
32810
|
* @type {UpsertVivaDtoConfig}
|
|
@@ -32177,6 +32812,8 @@ export interface UpsertVivaDto {
|
|
|
32177
32812
|
*/
|
|
32178
32813
|
'config'?: UpsertVivaDtoConfig;
|
|
32179
32814
|
}
|
|
32815
|
+
|
|
32816
|
+
|
|
32180
32817
|
/**
|
|
32181
32818
|
* The Viva settings, merged over the stored ones: a key sent replaces the stored key, a key absent keeps it.
|
|
32182
32819
|
* @export
|
|
@@ -32184,7 +32821,7 @@ export interface UpsertVivaDto {
|
|
|
32184
32821
|
*/
|
|
32185
32822
|
export interface UpsertVivaDtoConfig {
|
|
32186
32823
|
/**
|
|
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.
|
|
32824
|
+
* 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
32825
|
* @type {number}
|
|
32189
32826
|
* @memberof UpsertVivaDtoConfig
|
|
32190
32827
|
*/
|
|
@@ -32202,7 +32839,7 @@ export interface UpsertVivaDtoConfig {
|
|
|
32202
32839
|
*/
|
|
32203
32840
|
'sourceCode'?: string;
|
|
32204
32841
|
/**
|
|
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.
|
|
32842
|
+
* 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
32843
|
* @type {number}
|
|
32207
32844
|
* @memberof UpsertVivaDtoConfig
|
|
32208
32845
|
*/
|
|
@@ -33131,7 +33768,7 @@ export interface VivaCancelTransactionDto {
|
|
|
33131
33768
|
*/
|
|
33132
33769
|
export interface VivaConfigDto {
|
|
33133
33770
|
/**
|
|
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.
|
|
33771
|
+
* 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
33772
|
* @type {number}
|
|
33136
33773
|
* @memberof VivaConfigDto
|
|
33137
33774
|
*/
|
|
@@ -33149,7 +33786,7 @@ export interface VivaConfigDto {
|
|
|
33149
33786
|
*/
|
|
33150
33787
|
'sourceCode'?: string;
|
|
33151
33788
|
/**
|
|
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.
|
|
33789
|
+
* 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
33790
|
* @type {number}
|
|
33154
33791
|
* @memberof VivaConfigDto
|
|
33155
33792
|
*/
|
|
@@ -40601,6 +41238,230 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
40601
41238
|
}
|
|
40602
41239
|
|
|
40603
41240
|
|
|
41241
|
+
/**
|
|
41242
|
+
* CouponsApi - axios parameter creator
|
|
41243
|
+
* @export
|
|
41244
|
+
*/
|
|
41245
|
+
export const CouponsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
41246
|
+
return {
|
|
41247
|
+
/**
|
|
41248
|
+
* 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.
|
|
41249
|
+
* @summary Check a coupon against a till\'s basket
|
|
41250
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41251
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41252
|
+
* @param {*} [options] Override http request option.
|
|
41253
|
+
* @throws {RequiredError}
|
|
41254
|
+
*/
|
|
41255
|
+
checkCoupon: async (businessId: number, checkCouponDto: CheckCouponDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41256
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41257
|
+
assertParamExists('checkCoupon', 'businessId', businessId)
|
|
41258
|
+
// verify required parameter 'checkCouponDto' is not null or undefined
|
|
41259
|
+
assertParamExists('checkCoupon', 'checkCouponDto', checkCouponDto)
|
|
41260
|
+
const localVarPath = `/api/v2/venues/{businessId}/coupons/check`
|
|
41261
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
41262
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41263
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41264
|
+
let baseOptions;
|
|
41265
|
+
if (configuration) {
|
|
41266
|
+
baseOptions = configuration.baseOptions;
|
|
41267
|
+
}
|
|
41268
|
+
|
|
41269
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
41270
|
+
const localVarHeaderParameter = {} as any;
|
|
41271
|
+
const localVarQueryParameter = {} as any;
|
|
41272
|
+
|
|
41273
|
+
// authentication JWT-auth required
|
|
41274
|
+
// http bearer authentication required
|
|
41275
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
41276
|
+
|
|
41277
|
+
|
|
41278
|
+
|
|
41279
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
41280
|
+
|
|
41281
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41282
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41283
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41284
|
+
localVarRequestOptions.data = serializeDataIfNeeded(checkCouponDto, localVarRequestOptions, configuration)
|
|
41285
|
+
|
|
41286
|
+
return {
|
|
41287
|
+
url: toPathString(localVarUrlObj),
|
|
41288
|
+
options: localVarRequestOptions,
|
|
41289
|
+
};
|
|
41290
|
+
},
|
|
41291
|
+
/**
|
|
41292
|
+
* 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.
|
|
41293
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
41294
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
41295
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41296
|
+
* @param {*} [options] Override http request option.
|
|
41297
|
+
* @throws {RequiredError}
|
|
41298
|
+
*/
|
|
41299
|
+
checkKioskCoupon: async (businessId: number, checkCouponDto: CheckCouponDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41300
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
41301
|
+
assertParamExists('checkKioskCoupon', 'businessId', businessId)
|
|
41302
|
+
// verify required parameter 'checkCouponDto' is not null or undefined
|
|
41303
|
+
assertParamExists('checkKioskCoupon', 'checkCouponDto', checkCouponDto)
|
|
41304
|
+
const localVarPath = `/api/v2/kiosk/venues/{businessId}/coupons/check`
|
|
41305
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
41306
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
41307
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
41308
|
+
let baseOptions;
|
|
41309
|
+
if (configuration) {
|
|
41310
|
+
baseOptions = configuration.baseOptions;
|
|
41311
|
+
}
|
|
41312
|
+
|
|
41313
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
41314
|
+
const localVarHeaderParameter = {} as any;
|
|
41315
|
+
const localVarQueryParameter = {} as any;
|
|
41316
|
+
|
|
41317
|
+
|
|
41318
|
+
|
|
41319
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
41320
|
+
|
|
41321
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
41322
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
41323
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
41324
|
+
localVarRequestOptions.data = serializeDataIfNeeded(checkCouponDto, localVarRequestOptions, configuration)
|
|
41325
|
+
|
|
41326
|
+
return {
|
|
41327
|
+
url: toPathString(localVarUrlObj),
|
|
41328
|
+
options: localVarRequestOptions,
|
|
41329
|
+
};
|
|
41330
|
+
},
|
|
41331
|
+
}
|
|
41332
|
+
};
|
|
41333
|
+
|
|
41334
|
+
/**
|
|
41335
|
+
* CouponsApi - functional programming interface
|
|
41336
|
+
* @export
|
|
41337
|
+
*/
|
|
41338
|
+
export const CouponsApiFp = function(configuration?: Configuration) {
|
|
41339
|
+
const localVarAxiosParamCreator = CouponsApiAxiosParamCreator(configuration)
|
|
41340
|
+
return {
|
|
41341
|
+
/**
|
|
41342
|
+
* 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.
|
|
41343
|
+
* @summary Check a coupon against a till\'s basket
|
|
41344
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41345
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41346
|
+
* @param {*} [options] Override http request option.
|
|
41347
|
+
* @throws {RequiredError}
|
|
41348
|
+
*/
|
|
41349
|
+
async checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CouponCheckAnswerDto>> {
|
|
41350
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkCoupon(businessId, checkCouponDto, options);
|
|
41351
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41352
|
+
},
|
|
41353
|
+
/**
|
|
41354
|
+
* 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.
|
|
41355
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
41356
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
41357
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41358
|
+
* @param {*} [options] Override http request option.
|
|
41359
|
+
* @throws {RequiredError}
|
|
41360
|
+
*/
|
|
41361
|
+
async checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CouponCheckAnswerDto>> {
|
|
41362
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkKioskCoupon(businessId, checkCouponDto, options);
|
|
41363
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41364
|
+
},
|
|
41365
|
+
}
|
|
41366
|
+
};
|
|
41367
|
+
|
|
41368
|
+
/**
|
|
41369
|
+
* CouponsApi - factory interface
|
|
41370
|
+
* @export
|
|
41371
|
+
*/
|
|
41372
|
+
export const CouponsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
41373
|
+
const localVarFp = CouponsApiFp(configuration)
|
|
41374
|
+
return {
|
|
41375
|
+
/**
|
|
41376
|
+
* 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.
|
|
41377
|
+
* @summary Check a coupon against a till\'s basket
|
|
41378
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41379
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41380
|
+
* @param {*} [options] Override http request option.
|
|
41381
|
+
* @throws {RequiredError}
|
|
41382
|
+
*/
|
|
41383
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: any): AxiosPromise<CouponCheckAnswerDto> {
|
|
41384
|
+
return localVarFp.checkCoupon(businessId, checkCouponDto, options).then((request) => request(axios, basePath));
|
|
41385
|
+
},
|
|
41386
|
+
/**
|
|
41387
|
+
* 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.
|
|
41388
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
41389
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
41390
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41391
|
+
* @param {*} [options] Override http request option.
|
|
41392
|
+
* @throws {RequiredError}
|
|
41393
|
+
*/
|
|
41394
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: any): AxiosPromise<CouponCheckAnswerDto> {
|
|
41395
|
+
return localVarFp.checkKioskCoupon(businessId, checkCouponDto, options).then((request) => request(axios, basePath));
|
|
41396
|
+
},
|
|
41397
|
+
};
|
|
41398
|
+
};
|
|
41399
|
+
|
|
41400
|
+
/**
|
|
41401
|
+
* CouponsApi - interface
|
|
41402
|
+
* @export
|
|
41403
|
+
* @interface CouponsApi
|
|
41404
|
+
*/
|
|
41405
|
+
export interface CouponsApiInterface {
|
|
41406
|
+
/**
|
|
41407
|
+
* 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.
|
|
41408
|
+
* @summary Check a coupon against a till\'s basket
|
|
41409
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41410
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41411
|
+
* @param {*} [options] Override http request option.
|
|
41412
|
+
* @throws {RequiredError}
|
|
41413
|
+
* @memberof CouponsApiInterface
|
|
41414
|
+
*/
|
|
41415
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): AxiosPromise<CouponCheckAnswerDto>;
|
|
41416
|
+
|
|
41417
|
+
/**
|
|
41418
|
+
* 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.
|
|
41419
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
41420
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
41421
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41422
|
+
* @param {*} [options] Override http request option.
|
|
41423
|
+
* @throws {RequiredError}
|
|
41424
|
+
* @memberof CouponsApiInterface
|
|
41425
|
+
*/
|
|
41426
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): AxiosPromise<CouponCheckAnswerDto>;
|
|
41427
|
+
|
|
41428
|
+
}
|
|
41429
|
+
|
|
41430
|
+
/**
|
|
41431
|
+
* CouponsApi - object-oriented interface
|
|
41432
|
+
* @export
|
|
41433
|
+
* @class CouponsApi
|
|
41434
|
+
* @extends {BaseAPI}
|
|
41435
|
+
*/
|
|
41436
|
+
export class CouponsApi extends BaseAPI implements CouponsApiInterface {
|
|
41437
|
+
/**
|
|
41438
|
+
* 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.
|
|
41439
|
+
* @summary Check a coupon against a till\'s basket
|
|
41440
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
41441
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41442
|
+
* @param {*} [options] Override http request option.
|
|
41443
|
+
* @throws {RequiredError}
|
|
41444
|
+
* @memberof CouponsApi
|
|
41445
|
+
*/
|
|
41446
|
+
public checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig) {
|
|
41447
|
+
return CouponsApiFp(this.configuration).checkCoupon(businessId, checkCouponDto, options).then((request) => request(this.axios, this.basePath));
|
|
41448
|
+
}
|
|
41449
|
+
|
|
41450
|
+
/**
|
|
41451
|
+
* 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.
|
|
41452
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
41453
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
41454
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
41455
|
+
* @param {*} [options] Override http request option.
|
|
41456
|
+
* @throws {RequiredError}
|
|
41457
|
+
* @memberof CouponsApi
|
|
41458
|
+
*/
|
|
41459
|
+
public checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig) {
|
|
41460
|
+
return CouponsApiFp(this.configuration).checkKioskCoupon(businessId, checkCouponDto, options).then((request) => request(this.axios, this.basePath));
|
|
41461
|
+
}
|
|
41462
|
+
}
|
|
41463
|
+
|
|
41464
|
+
|
|
40604
41465
|
/**
|
|
40605
41466
|
* CoursesApi - axios parameter creator
|
|
40606
41467
|
* @export
|
|
@@ -52685,7 +53546,7 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
52685
53546
|
};
|
|
52686
53547
|
},
|
|
52687
53548
|
/**
|
|
52688
|
-
* Attaches a
|
|
53549
|
+
* 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
53550
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
52690
53551
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52691
53552
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -52771,7 +53632,7 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
52771
53632
|
};
|
|
52772
53633
|
},
|
|
52773
53634
|
/**
|
|
52774
|
-
* The dashboard\'s add-method picker: every method of the
|
|
53635
|
+
* 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
53636
|
* @summary List the catalog methods a venue can still add on one channel
|
|
52776
53637
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52777
53638
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53061,7 +53922,7 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
|
|
|
53061
53922
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
53062
53923
|
},
|
|
53063
53924
|
/**
|
|
53064
|
-
* Attaches a
|
|
53925
|
+
* 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
53926
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
53066
53927
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53067
53928
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53087,7 +53948,7 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
|
|
|
53087
53948
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
53088
53949
|
},
|
|
53089
53950
|
/**
|
|
53090
|
-
* The dashboard\'s add-method picker: every method of the
|
|
53951
|
+
* 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
53952
|
* @summary List the catalog methods a venue can still add on one channel
|
|
53092
53953
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53093
53954
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53199,7 +54060,7 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
|
|
|
53199
54060
|
return localVarFp.changePaymentMethodOption(businessId, channel, id, changePaymentMethodOptionDto, options).then((request) => request(axios, basePath));
|
|
53200
54061
|
},
|
|
53201
54062
|
/**
|
|
53202
|
-
* Attaches a
|
|
54063
|
+
* 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
54064
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
53204
54065
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53205
54066
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53223,7 +54084,7 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
|
|
|
53223
54084
|
return localVarFp.deletePaymentMethodOption(businessId, channel, id, options).then((request) => request(axios, basePath));
|
|
53224
54085
|
},
|
|
53225
54086
|
/**
|
|
53226
|
-
* The dashboard\'s add-method picker: every method of the
|
|
54087
|
+
* 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
54088
|
* @summary List the catalog methods a venue can still add on one channel
|
|
53228
54089
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53229
54090
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53328,7 +54189,7 @@ export interface PaymentMethodsApiInterface {
|
|
|
53328
54189
|
changePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
53329
54190
|
|
|
53330
54191
|
/**
|
|
53331
|
-
* Attaches a
|
|
54192
|
+
* 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
54193
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
53333
54194
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53334
54195
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53352,7 +54213,7 @@ export interface PaymentMethodsApiInterface {
|
|
|
53352
54213
|
deletePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
53353
54214
|
|
|
53354
54215
|
/**
|
|
53355
|
-
* The dashboard\'s add-method picker: every method of the
|
|
54216
|
+
* 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
54217
|
* @summary List the catalog methods a venue can still add on one channel
|
|
53357
54218
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53358
54219
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53461,7 +54322,7 @@ export class PaymentMethodsApi extends BaseAPI implements PaymentMethodsApiInter
|
|
|
53461
54322
|
}
|
|
53462
54323
|
|
|
53463
54324
|
/**
|
|
53464
|
-
* Attaches a
|
|
54325
|
+
* 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
54326
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
53466
54327
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53467
54328
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -53489,7 +54350,7 @@ export class PaymentMethodsApi extends BaseAPI implements PaymentMethodsApiInter
|
|
|
53489
54350
|
}
|
|
53490
54351
|
|
|
53491
54352
|
/**
|
|
53492
|
-
* The dashboard\'s add-method picker: every method of the
|
|
54353
|
+
* 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
54354
|
* @summary List the catalog methods a venue can still add on one channel
|
|
53494
54355
|
* @param {number} businessId The venue\'s ordering business id.
|
|
53495
54356
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -58862,6 +59723,600 @@ export class ReportV6Api extends BaseAPI implements ReportV6ApiInterface {
|
|
|
58862
59723
|
}
|
|
58863
59724
|
|
|
58864
59725
|
|
|
59726
|
+
/**
|
|
59727
|
+
* ResQApi - axios parameter creator
|
|
59728
|
+
* @export
|
|
59729
|
+
*/
|
|
59730
|
+
export const ResQApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
59731
|
+
return {
|
|
59732
|
+
/**
|
|
59733
|
+
* 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.
|
|
59734
|
+
* @summary Change a venue\'s ResQ offer
|
|
59735
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59736
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
59737
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
59738
|
+
* @param {*} [options] Override http request option.
|
|
59739
|
+
* @throws {RequiredError}
|
|
59740
|
+
*/
|
|
59741
|
+
changeResQOffer: async (businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59742
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
59743
|
+
assertParamExists('changeResQOffer', 'businessId', businessId)
|
|
59744
|
+
// verify required parameter 'offerId' is not null or undefined
|
|
59745
|
+
assertParamExists('changeResQOffer', 'offerId', offerId)
|
|
59746
|
+
// verify required parameter 'changeResQOfferDto' is not null or undefined
|
|
59747
|
+
assertParamExists('changeResQOffer', 'changeResQOfferDto', changeResQOfferDto)
|
|
59748
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/offers/{offerId}`
|
|
59749
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
59750
|
+
.replace(`{${"offerId"}}`, encodeURIComponent(String(offerId)));
|
|
59751
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59752
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59753
|
+
let baseOptions;
|
|
59754
|
+
if (configuration) {
|
|
59755
|
+
baseOptions = configuration.baseOptions;
|
|
59756
|
+
}
|
|
59757
|
+
|
|
59758
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
59759
|
+
const localVarHeaderParameter = {} as any;
|
|
59760
|
+
const localVarQueryParameter = {} as any;
|
|
59761
|
+
|
|
59762
|
+
// authentication JWT-auth required
|
|
59763
|
+
// http bearer authentication required
|
|
59764
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
59765
|
+
|
|
59766
|
+
|
|
59767
|
+
|
|
59768
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
59769
|
+
|
|
59770
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
59771
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
59772
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
59773
|
+
localVarRequestOptions.data = serializeDataIfNeeded(changeResQOfferDto, localVarRequestOptions, configuration)
|
|
59774
|
+
|
|
59775
|
+
return {
|
|
59776
|
+
url: toPathString(localVarUrlObj),
|
|
59777
|
+
options: localVarRequestOptions,
|
|
59778
|
+
};
|
|
59779
|
+
},
|
|
59780
|
+
/**
|
|
59781
|
+
* 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.
|
|
59782
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
59783
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59784
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
59785
|
+
* @param {*} [options] Override http request option.
|
|
59786
|
+
* @throws {RequiredError}
|
|
59787
|
+
*/
|
|
59788
|
+
createResQOffer: async (businessId: number, createResQOfferDto: CreateResQOfferDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59789
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
59790
|
+
assertParamExists('createResQOffer', 'businessId', businessId)
|
|
59791
|
+
// verify required parameter 'createResQOfferDto' is not null or undefined
|
|
59792
|
+
assertParamExists('createResQOffer', 'createResQOfferDto', createResQOfferDto)
|
|
59793
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/offers`
|
|
59794
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
59795
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59796
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59797
|
+
let baseOptions;
|
|
59798
|
+
if (configuration) {
|
|
59799
|
+
baseOptions = configuration.baseOptions;
|
|
59800
|
+
}
|
|
59801
|
+
|
|
59802
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
59803
|
+
const localVarHeaderParameter = {} as any;
|
|
59804
|
+
const localVarQueryParameter = {} as any;
|
|
59805
|
+
|
|
59806
|
+
// authentication JWT-auth required
|
|
59807
|
+
// http bearer authentication required
|
|
59808
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
59809
|
+
|
|
59810
|
+
|
|
59811
|
+
|
|
59812
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
59813
|
+
|
|
59814
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
59815
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
59816
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
59817
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createResQOfferDto, localVarRequestOptions, configuration)
|
|
59818
|
+
|
|
59819
|
+
return {
|
|
59820
|
+
url: toPathString(localVarUrlObj),
|
|
59821
|
+
options: localVarRequestOptions,
|
|
59822
|
+
};
|
|
59823
|
+
},
|
|
59824
|
+
/**
|
|
59825
|
+
* 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.
|
|
59826
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
59827
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59828
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
59829
|
+
* @param {*} [options] Override http request option.
|
|
59830
|
+
* @throws {RequiredError}
|
|
59831
|
+
*/
|
|
59832
|
+
deactivateResQOffer: async (businessId: number, offerId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59833
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
59834
|
+
assertParamExists('deactivateResQOffer', 'businessId', businessId)
|
|
59835
|
+
// verify required parameter 'offerId' is not null or undefined
|
|
59836
|
+
assertParamExists('deactivateResQOffer', 'offerId', offerId)
|
|
59837
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/offers/{offerId}/deactivate`
|
|
59838
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
59839
|
+
.replace(`{${"offerId"}}`, encodeURIComponent(String(offerId)));
|
|
59840
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59841
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59842
|
+
let baseOptions;
|
|
59843
|
+
if (configuration) {
|
|
59844
|
+
baseOptions = configuration.baseOptions;
|
|
59845
|
+
}
|
|
59846
|
+
|
|
59847
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
59848
|
+
const localVarHeaderParameter = {} as any;
|
|
59849
|
+
const localVarQueryParameter = {} as any;
|
|
59850
|
+
|
|
59851
|
+
// authentication JWT-auth required
|
|
59852
|
+
// http bearer authentication required
|
|
59853
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
59854
|
+
|
|
59855
|
+
|
|
59856
|
+
|
|
59857
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
59858
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
59859
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
59860
|
+
|
|
59861
|
+
return {
|
|
59862
|
+
url: toPathString(localVarUrlObj),
|
|
59863
|
+
options: localVarRequestOptions,
|
|
59864
|
+
};
|
|
59865
|
+
},
|
|
59866
|
+
/**
|
|
59867
|
+
* 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.
|
|
59868
|
+
* @summary Read one ResQ order of a venue
|
|
59869
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59870
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
59871
|
+
* @param {*} [options] Override http request option.
|
|
59872
|
+
* @throws {RequiredError}
|
|
59873
|
+
*/
|
|
59874
|
+
getResQOrder: async (businessId: number, orderId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59875
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
59876
|
+
assertParamExists('getResQOrder', 'businessId', businessId)
|
|
59877
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
59878
|
+
assertParamExists('getResQOrder', 'orderId', orderId)
|
|
59879
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/orders/{orderId}`
|
|
59880
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
59881
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
59882
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59883
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59884
|
+
let baseOptions;
|
|
59885
|
+
if (configuration) {
|
|
59886
|
+
baseOptions = configuration.baseOptions;
|
|
59887
|
+
}
|
|
59888
|
+
|
|
59889
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
59890
|
+
const localVarHeaderParameter = {} as any;
|
|
59891
|
+
const localVarQueryParameter = {} as any;
|
|
59892
|
+
|
|
59893
|
+
// authentication JWT-auth required
|
|
59894
|
+
// http bearer authentication required
|
|
59895
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
59896
|
+
|
|
59897
|
+
|
|
59898
|
+
|
|
59899
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
59900
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
59901
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
59902
|
+
|
|
59903
|
+
return {
|
|
59904
|
+
url: toPathString(localVarUrlObj),
|
|
59905
|
+
options: localVarRequestOptions,
|
|
59906
|
+
};
|
|
59907
|
+
},
|
|
59908
|
+
/**
|
|
59909
|
+
* 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.
|
|
59910
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
59911
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59912
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
59913
|
+
* @param {*} [options] Override http request option.
|
|
59914
|
+
* @throws {RequiredError}
|
|
59915
|
+
*/
|
|
59916
|
+
listResQOffers: async (businessId: number, page?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59917
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
59918
|
+
assertParamExists('listResQOffers', 'businessId', businessId)
|
|
59919
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/offers`
|
|
59920
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
59921
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59922
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59923
|
+
let baseOptions;
|
|
59924
|
+
if (configuration) {
|
|
59925
|
+
baseOptions = configuration.baseOptions;
|
|
59926
|
+
}
|
|
59927
|
+
|
|
59928
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
59929
|
+
const localVarHeaderParameter = {} as any;
|
|
59930
|
+
const localVarQueryParameter = {} as any;
|
|
59931
|
+
|
|
59932
|
+
// authentication JWT-auth required
|
|
59933
|
+
// http bearer authentication required
|
|
59934
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
59935
|
+
|
|
59936
|
+
if (page !== undefined) {
|
|
59937
|
+
localVarQueryParameter['page'] = page;
|
|
59938
|
+
}
|
|
59939
|
+
|
|
59940
|
+
|
|
59941
|
+
|
|
59942
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
59943
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
59944
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
59945
|
+
|
|
59946
|
+
return {
|
|
59947
|
+
url: toPathString(localVarUrlObj),
|
|
59948
|
+
options: localVarRequestOptions,
|
|
59949
|
+
};
|
|
59950
|
+
},
|
|
59951
|
+
/**
|
|
59952
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
59953
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
59954
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59955
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
59956
|
+
* @param {*} [options] Override http request option.
|
|
59957
|
+
* @throws {RequiredError}
|
|
59958
|
+
*/
|
|
59959
|
+
listResQOrders: async (businessId: number, page?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
59960
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
59961
|
+
assertParamExists('listResQOrders', 'businessId', businessId)
|
|
59962
|
+
const localVarPath = `/api/v2/venues/{businessId}/resq/orders`
|
|
59963
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
59964
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59965
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
59966
|
+
let baseOptions;
|
|
59967
|
+
if (configuration) {
|
|
59968
|
+
baseOptions = configuration.baseOptions;
|
|
59969
|
+
}
|
|
59970
|
+
|
|
59971
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
59972
|
+
const localVarHeaderParameter = {} as any;
|
|
59973
|
+
const localVarQueryParameter = {} as any;
|
|
59974
|
+
|
|
59975
|
+
// authentication JWT-auth required
|
|
59976
|
+
// http bearer authentication required
|
|
59977
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
59978
|
+
|
|
59979
|
+
if (page !== undefined) {
|
|
59980
|
+
localVarQueryParameter['page'] = page;
|
|
59981
|
+
}
|
|
59982
|
+
|
|
59983
|
+
|
|
59984
|
+
|
|
59985
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
59986
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
59987
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
59988
|
+
|
|
59989
|
+
return {
|
|
59990
|
+
url: toPathString(localVarUrlObj),
|
|
59991
|
+
options: localVarRequestOptions,
|
|
59992
|
+
};
|
|
59993
|
+
},
|
|
59994
|
+
}
|
|
59995
|
+
};
|
|
59996
|
+
|
|
59997
|
+
/**
|
|
59998
|
+
* ResQApi - functional programming interface
|
|
59999
|
+
* @export
|
|
60000
|
+
*/
|
|
60001
|
+
export const ResQApiFp = function(configuration?: Configuration) {
|
|
60002
|
+
const localVarAxiosParamCreator = ResQApiAxiosParamCreator(configuration)
|
|
60003
|
+
return {
|
|
60004
|
+
/**
|
|
60005
|
+
* 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.
|
|
60006
|
+
* @summary Change a venue\'s ResQ offer
|
|
60007
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60008
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60009
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
60010
|
+
* @param {*} [options] Override http request option.
|
|
60011
|
+
* @throws {RequiredError}
|
|
60012
|
+
*/
|
|
60013
|
+
async changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOfferDto>> {
|
|
60014
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.changeResQOffer(businessId, offerId, changeResQOfferDto, options);
|
|
60015
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60016
|
+
},
|
|
60017
|
+
/**
|
|
60018
|
+
* 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.
|
|
60019
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
60020
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60021
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
60022
|
+
* @param {*} [options] Override http request option.
|
|
60023
|
+
* @throws {RequiredError}
|
|
60024
|
+
*/
|
|
60025
|
+
async createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOfferDto>> {
|
|
60026
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createResQOffer(businessId, createResQOfferDto, options);
|
|
60027
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60028
|
+
},
|
|
60029
|
+
/**
|
|
60030
|
+
* 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.
|
|
60031
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
60032
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60033
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60034
|
+
* @param {*} [options] Override http request option.
|
|
60035
|
+
* @throws {RequiredError}
|
|
60036
|
+
*/
|
|
60037
|
+
async deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
60038
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deactivateResQOffer(businessId, offerId, options);
|
|
60039
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60040
|
+
},
|
|
60041
|
+
/**
|
|
60042
|
+
* 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.
|
|
60043
|
+
* @summary Read one ResQ order of a venue
|
|
60044
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60045
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
60046
|
+
* @param {*} [options] Override http request option.
|
|
60047
|
+
* @throws {RequiredError}
|
|
60048
|
+
*/
|
|
60049
|
+
async getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOrderDto>> {
|
|
60050
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getResQOrder(businessId, orderId, options);
|
|
60051
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60052
|
+
},
|
|
60053
|
+
/**
|
|
60054
|
+
* 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.
|
|
60055
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
60056
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60057
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60058
|
+
* @param {*} [options] Override http request option.
|
|
60059
|
+
* @throws {RequiredError}
|
|
60060
|
+
*/
|
|
60061
|
+
async listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOffersPageDto>> {
|
|
60062
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listResQOffers(businessId, page, options);
|
|
60063
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60064
|
+
},
|
|
60065
|
+
/**
|
|
60066
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
60067
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
60068
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60069
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60070
|
+
* @param {*} [options] Override http request option.
|
|
60071
|
+
* @throws {RequiredError}
|
|
60072
|
+
*/
|
|
60073
|
+
async listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOrdersPageDto>> {
|
|
60074
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listResQOrders(businessId, page, options);
|
|
60075
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
60076
|
+
},
|
|
60077
|
+
}
|
|
60078
|
+
};
|
|
60079
|
+
|
|
60080
|
+
/**
|
|
60081
|
+
* ResQApi - factory interface
|
|
60082
|
+
* @export
|
|
60083
|
+
*/
|
|
60084
|
+
export const ResQApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
60085
|
+
const localVarFp = ResQApiFp(configuration)
|
|
60086
|
+
return {
|
|
60087
|
+
/**
|
|
60088
|
+
* 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.
|
|
60089
|
+
* @summary Change a venue\'s ResQ offer
|
|
60090
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60091
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60092
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
60093
|
+
* @param {*} [options] Override http request option.
|
|
60094
|
+
* @throws {RequiredError}
|
|
60095
|
+
*/
|
|
60096
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: any): AxiosPromise<ResQOfferDto> {
|
|
60097
|
+
return localVarFp.changeResQOffer(businessId, offerId, changeResQOfferDto, options).then((request) => request(axios, basePath));
|
|
60098
|
+
},
|
|
60099
|
+
/**
|
|
60100
|
+
* 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.
|
|
60101
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
60102
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60103
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
60104
|
+
* @param {*} [options] Override http request option.
|
|
60105
|
+
* @throws {RequiredError}
|
|
60106
|
+
*/
|
|
60107
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: any): AxiosPromise<ResQOfferDto> {
|
|
60108
|
+
return localVarFp.createResQOffer(businessId, createResQOfferDto, options).then((request) => request(axios, basePath));
|
|
60109
|
+
},
|
|
60110
|
+
/**
|
|
60111
|
+
* 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.
|
|
60112
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
60113
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60114
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60115
|
+
* @param {*} [options] Override http request option.
|
|
60116
|
+
* @throws {RequiredError}
|
|
60117
|
+
*/
|
|
60118
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: any): AxiosPromise<void> {
|
|
60119
|
+
return localVarFp.deactivateResQOffer(businessId, offerId, options).then((request) => request(axios, basePath));
|
|
60120
|
+
},
|
|
60121
|
+
/**
|
|
60122
|
+
* 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.
|
|
60123
|
+
* @summary Read one ResQ order of a venue
|
|
60124
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60125
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
60126
|
+
* @param {*} [options] Override http request option.
|
|
60127
|
+
* @throws {RequiredError}
|
|
60128
|
+
*/
|
|
60129
|
+
getResQOrder(businessId: number, orderId: string, options?: any): AxiosPromise<ResQOrderDto> {
|
|
60130
|
+
return localVarFp.getResQOrder(businessId, orderId, options).then((request) => request(axios, basePath));
|
|
60131
|
+
},
|
|
60132
|
+
/**
|
|
60133
|
+
* 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.
|
|
60134
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
60135
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60136
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60137
|
+
* @param {*} [options] Override http request option.
|
|
60138
|
+
* @throws {RequiredError}
|
|
60139
|
+
*/
|
|
60140
|
+
listResQOffers(businessId: number, page?: number, options?: any): AxiosPromise<ResQOffersPageDto> {
|
|
60141
|
+
return localVarFp.listResQOffers(businessId, page, options).then((request) => request(axios, basePath));
|
|
60142
|
+
},
|
|
60143
|
+
/**
|
|
60144
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
60145
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
60146
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60147
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60148
|
+
* @param {*} [options] Override http request option.
|
|
60149
|
+
* @throws {RequiredError}
|
|
60150
|
+
*/
|
|
60151
|
+
listResQOrders(businessId: number, page?: number, options?: any): AxiosPromise<ResQOrdersPageDto> {
|
|
60152
|
+
return localVarFp.listResQOrders(businessId, page, options).then((request) => request(axios, basePath));
|
|
60153
|
+
},
|
|
60154
|
+
};
|
|
60155
|
+
};
|
|
60156
|
+
|
|
60157
|
+
/**
|
|
60158
|
+
* ResQApi - interface
|
|
60159
|
+
* @export
|
|
60160
|
+
* @interface ResQApi
|
|
60161
|
+
*/
|
|
60162
|
+
export interface ResQApiInterface {
|
|
60163
|
+
/**
|
|
60164
|
+
* 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.
|
|
60165
|
+
* @summary Change a venue\'s ResQ offer
|
|
60166
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60167
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60168
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
60169
|
+
* @param {*} [options] Override http request option.
|
|
60170
|
+
* @throws {RequiredError}
|
|
60171
|
+
* @memberof ResQApiInterface
|
|
60172
|
+
*/
|
|
60173
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig): AxiosPromise<ResQOfferDto>;
|
|
60174
|
+
|
|
60175
|
+
/**
|
|
60176
|
+
* 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.
|
|
60177
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
60178
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60179
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
60180
|
+
* @param {*} [options] Override http request option.
|
|
60181
|
+
* @throws {RequiredError}
|
|
60182
|
+
* @memberof ResQApiInterface
|
|
60183
|
+
*/
|
|
60184
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig): AxiosPromise<ResQOfferDto>;
|
|
60185
|
+
|
|
60186
|
+
/**
|
|
60187
|
+
* 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.
|
|
60188
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
60189
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60190
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60191
|
+
* @param {*} [options] Override http request option.
|
|
60192
|
+
* @throws {RequiredError}
|
|
60193
|
+
* @memberof ResQApiInterface
|
|
60194
|
+
*/
|
|
60195
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
60196
|
+
|
|
60197
|
+
/**
|
|
60198
|
+
* 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.
|
|
60199
|
+
* @summary Read one ResQ order of a venue
|
|
60200
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60201
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
60202
|
+
* @param {*} [options] Override http request option.
|
|
60203
|
+
* @throws {RequiredError}
|
|
60204
|
+
* @memberof ResQApiInterface
|
|
60205
|
+
*/
|
|
60206
|
+
getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig): AxiosPromise<ResQOrderDto>;
|
|
60207
|
+
|
|
60208
|
+
/**
|
|
60209
|
+
* 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.
|
|
60210
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
60211
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60212
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60213
|
+
* @param {*} [options] Override http request option.
|
|
60214
|
+
* @throws {RequiredError}
|
|
60215
|
+
* @memberof ResQApiInterface
|
|
60216
|
+
*/
|
|
60217
|
+
listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig): AxiosPromise<ResQOffersPageDto>;
|
|
60218
|
+
|
|
60219
|
+
/**
|
|
60220
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
60221
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
60222
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60223
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60224
|
+
* @param {*} [options] Override http request option.
|
|
60225
|
+
* @throws {RequiredError}
|
|
60226
|
+
* @memberof ResQApiInterface
|
|
60227
|
+
*/
|
|
60228
|
+
listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig): AxiosPromise<ResQOrdersPageDto>;
|
|
60229
|
+
|
|
60230
|
+
}
|
|
60231
|
+
|
|
60232
|
+
/**
|
|
60233
|
+
* ResQApi - object-oriented interface
|
|
60234
|
+
* @export
|
|
60235
|
+
* @class ResQApi
|
|
60236
|
+
* @extends {BaseAPI}
|
|
60237
|
+
*/
|
|
60238
|
+
export class ResQApi extends BaseAPI implements ResQApiInterface {
|
|
60239
|
+
/**
|
|
60240
|
+
* 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.
|
|
60241
|
+
* @summary Change a venue\'s ResQ offer
|
|
60242
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60243
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60244
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
60245
|
+
* @param {*} [options] Override http request option.
|
|
60246
|
+
* @throws {RequiredError}
|
|
60247
|
+
* @memberof ResQApi
|
|
60248
|
+
*/
|
|
60249
|
+
public changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig) {
|
|
60250
|
+
return ResQApiFp(this.configuration).changeResQOffer(businessId, offerId, changeResQOfferDto, options).then((request) => request(this.axios, this.basePath));
|
|
60251
|
+
}
|
|
60252
|
+
|
|
60253
|
+
/**
|
|
60254
|
+
* 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.
|
|
60255
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
60256
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60257
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
60258
|
+
* @param {*} [options] Override http request option.
|
|
60259
|
+
* @throws {RequiredError}
|
|
60260
|
+
* @memberof ResQApi
|
|
60261
|
+
*/
|
|
60262
|
+
public createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig) {
|
|
60263
|
+
return ResQApiFp(this.configuration).createResQOffer(businessId, createResQOfferDto, options).then((request) => request(this.axios, this.basePath));
|
|
60264
|
+
}
|
|
60265
|
+
|
|
60266
|
+
/**
|
|
60267
|
+
* 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.
|
|
60268
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
60269
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60270
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
60271
|
+
* @param {*} [options] Override http request option.
|
|
60272
|
+
* @throws {RequiredError}
|
|
60273
|
+
* @memberof ResQApi
|
|
60274
|
+
*/
|
|
60275
|
+
public deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig) {
|
|
60276
|
+
return ResQApiFp(this.configuration).deactivateResQOffer(businessId, offerId, options).then((request) => request(this.axios, this.basePath));
|
|
60277
|
+
}
|
|
60278
|
+
|
|
60279
|
+
/**
|
|
60280
|
+
* 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.
|
|
60281
|
+
* @summary Read one ResQ order of a venue
|
|
60282
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60283
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
60284
|
+
* @param {*} [options] Override http request option.
|
|
60285
|
+
* @throws {RequiredError}
|
|
60286
|
+
* @memberof ResQApi
|
|
60287
|
+
*/
|
|
60288
|
+
public getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig) {
|
|
60289
|
+
return ResQApiFp(this.configuration).getResQOrder(businessId, orderId, options).then((request) => request(this.axios, this.basePath));
|
|
60290
|
+
}
|
|
60291
|
+
|
|
60292
|
+
/**
|
|
60293
|
+
* 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.
|
|
60294
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
60295
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60296
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60297
|
+
* @param {*} [options] Override http request option.
|
|
60298
|
+
* @throws {RequiredError}
|
|
60299
|
+
* @memberof ResQApi
|
|
60300
|
+
*/
|
|
60301
|
+
public listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig) {
|
|
60302
|
+
return ResQApiFp(this.configuration).listResQOffers(businessId, page, options).then((request) => request(this.axios, this.basePath));
|
|
60303
|
+
}
|
|
60304
|
+
|
|
60305
|
+
/**
|
|
60306
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
60307
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
60308
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60309
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
60310
|
+
* @param {*} [options] Override http request option.
|
|
60311
|
+
* @throws {RequiredError}
|
|
60312
|
+
* @memberof ResQApi
|
|
60313
|
+
*/
|
|
60314
|
+
public listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig) {
|
|
60315
|
+
return ResQApiFp(this.configuration).listResQOrders(businessId, page, options).then((request) => request(this.axios, this.basePath));
|
|
60316
|
+
}
|
|
60317
|
+
}
|
|
60318
|
+
|
|
60319
|
+
|
|
58865
60320
|
/**
|
|
58866
60321
|
* ReservationsApi - axios parameter creator
|
|
58867
60322
|
* @export
|