@munchi_oy/core 2.0.6 → 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 +1570 -27
- 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 +2187 -27
- 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
|
|
@@ -3602,6 +3872,25 @@ export interface CreateInvoiceCompanyDto {
|
|
|
3602
3872
|
*/
|
|
3603
3873
|
'address'?: string;
|
|
3604
3874
|
}
|
|
3875
|
+
/**
|
|
3876
|
+
*
|
|
3877
|
+
* @export
|
|
3878
|
+
* @interface CreateKdsStationsDto
|
|
3879
|
+
*/
|
|
3880
|
+
export interface CreateKdsStationsDto {
|
|
3881
|
+
/**
|
|
3882
|
+
* The Munchi venue id (orderingBusinessId) the stations are created at
|
|
3883
|
+
* @type {number}
|
|
3884
|
+
* @memberof CreateKdsStationsDto
|
|
3885
|
+
*/
|
|
3886
|
+
'businessId': number;
|
|
3887
|
+
/**
|
|
3888
|
+
* The stations to create, at least one; all are created, or none
|
|
3889
|
+
* @type {Array<NewKdsStationDto>}
|
|
3890
|
+
* @memberof CreateKdsStationsDto
|
|
3891
|
+
*/
|
|
3892
|
+
'stations': Array<NewKdsStationDto>;
|
|
3893
|
+
}
|
|
3605
3894
|
/**
|
|
3606
3895
|
*
|
|
3607
3896
|
* @export
|
|
@@ -4281,13 +4570,13 @@ export interface CreateOnboardingSessionDto {
|
|
|
4281
4570
|
*/
|
|
4282
4571
|
export interface CreatePaymentMethodDto {
|
|
4283
4572
|
/**
|
|
4284
|
-
* Attach
|
|
4573
|
+
* Attach a built-in method, or one of the venue\'s own custom methods, by its code (mutually exclusive with name+type).
|
|
4285
4574
|
* @type {string}
|
|
4286
4575
|
* @memberof CreatePaymentMethodDto
|
|
4287
4576
|
*/
|
|
4288
4577
|
'code'?: string;
|
|
4289
4578
|
/**
|
|
4290
|
-
* 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.
|
|
4291
4580
|
* @type {string}
|
|
4292
4581
|
* @memberof CreatePaymentMethodDto
|
|
4293
4582
|
*/
|
|
@@ -4438,6 +4727,73 @@ export interface CreateRefundPlanDto {
|
|
|
4438
4727
|
}
|
|
4439
4728
|
|
|
4440
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
|
+
}
|
|
4441
4797
|
/**
|
|
4442
4798
|
*
|
|
4443
4799
|
* @export
|
|
@@ -5878,7 +6234,7 @@ export interface DisconnectedDeliveryPlatformDto {
|
|
|
5878
6234
|
*/
|
|
5879
6235
|
'channel': DeliveryPlatformOpsConnect;
|
|
5880
6236
|
/**
|
|
5881
|
-
* The store ids of the rows
|
|
6237
|
+
* The store ids of the rows deleted: one, unless rows were written by hand under several
|
|
5882
6238
|
* @type {Array<string>}
|
|
5883
6239
|
* @memberof DisconnectedDeliveryPlatformDto
|
|
5884
6240
|
*/
|
|
@@ -6219,7 +6575,7 @@ export interface DispatchPosOrderResponseDto {
|
|
|
6219
6575
|
*/
|
|
6220
6576
|
'ticketId': object | null;
|
|
6221
6577
|
/**
|
|
6222
|
-
* Number of that ticket:
|
|
6578
|
+
* Number of that ticket: its order\'s own number. null when no ticket was written.
|
|
6223
6579
|
* @type {object}
|
|
6224
6580
|
* @memberof DispatchPosOrderResponseDto
|
|
6225
6581
|
*/
|
|
@@ -10634,6 +10990,45 @@ export interface KdsRevertOrderResponseDtoOrder {
|
|
|
10634
10990
|
}
|
|
10635
10991
|
|
|
10636
10992
|
|
|
10993
|
+
/**
|
|
10994
|
+
*
|
|
10995
|
+
* @export
|
|
10996
|
+
* @interface KdsStationDto
|
|
10997
|
+
*/
|
|
10998
|
+
export interface KdsStationDto {
|
|
10999
|
+
/**
|
|
11000
|
+
* The station\'s id in kds-service (its KDS profile id)
|
|
11001
|
+
* @type {string}
|
|
11002
|
+
* @memberof KdsStationDto
|
|
11003
|
+
*/
|
|
11004
|
+
'id': string;
|
|
11005
|
+
/**
|
|
11006
|
+
* The venue the station belongs to (orderingBusinessId)
|
|
11007
|
+
* @type {number}
|
|
11008
|
+
* @memberof KdsStationDto
|
|
11009
|
+
*/
|
|
11010
|
+
'businessId': number;
|
|
11011
|
+
/**
|
|
11012
|
+
* The station\'s name, as the venue set it
|
|
11013
|
+
* @type {string}
|
|
11014
|
+
* @memberof KdsStationDto
|
|
11015
|
+
*/
|
|
11016
|
+
'name': string;
|
|
11017
|
+
/**
|
|
11018
|
+
*
|
|
11019
|
+
* @type {SystemProfileType}
|
|
11020
|
+
* @memberof KdsStationDto
|
|
11021
|
+
*/
|
|
11022
|
+
'systemType': SystemProfileType | null;
|
|
11023
|
+
/**
|
|
11024
|
+
* The ids of the venue\'s menu categories whose items this station shows, as text; an item of a subcategory goes to the station of its nearest category listed here. A category is on one station only: listing it here takes it off the station that had it. An empty list makes the station show the items no station lists
|
|
11025
|
+
* @type {Array<string>}
|
|
11026
|
+
* @memberof KdsStationDto
|
|
11027
|
+
*/
|
|
11028
|
+
'categoryIds': Array<string>;
|
|
11029
|
+
}
|
|
11030
|
+
|
|
11031
|
+
|
|
10637
11032
|
/**
|
|
10638
11033
|
*
|
|
10639
11034
|
* @export
|
|
@@ -13447,6 +13842,25 @@ export interface NetsTransactionSuccessResponseDto {
|
|
|
13447
13842
|
*/
|
|
13448
13843
|
'result': Array<NetsTransactionResultDto>;
|
|
13449
13844
|
}
|
|
13845
|
+
/**
|
|
13846
|
+
*
|
|
13847
|
+
* @export
|
|
13848
|
+
* @interface NewKdsStationDto
|
|
13849
|
+
*/
|
|
13850
|
+
export interface NewKdsStationDto {
|
|
13851
|
+
/**
|
|
13852
|
+
* The new station\'s name
|
|
13853
|
+
* @type {string}
|
|
13854
|
+
* @memberof NewKdsStationDto
|
|
13855
|
+
*/
|
|
13856
|
+
'name': string;
|
|
13857
|
+
/**
|
|
13858
|
+
* The ids of the venue\'s menu categories whose items this station shows, as text; an item of a subcategory goes to the station of its nearest category listed here. A category is on one station only: listing it here takes it off the station that had it. An empty list makes the station show the items no station lists
|
|
13859
|
+
* @type {Array<string>}
|
|
13860
|
+
* @memberof NewKdsStationDto
|
|
13861
|
+
*/
|
|
13862
|
+
'categoryIds': Array<string>;
|
|
13863
|
+
}
|
|
13450
13864
|
/**
|
|
13451
13865
|
*
|
|
13452
13866
|
* @export
|
|
@@ -16163,7 +16577,7 @@ export interface ParkPosOrderResponseDto {
|
|
|
16163
16577
|
*/
|
|
16164
16578
|
'ticketId': object | null;
|
|
16165
16579
|
/**
|
|
16166
|
-
* Number of that ticket:
|
|
16580
|
+
* Number of that ticket: its order\'s own number. null when no ticket was written.
|
|
16167
16581
|
* @type {object}
|
|
16168
16582
|
* @memberof ParkPosOrderResponseDto
|
|
16169
16583
|
*/
|
|
@@ -18158,6 +18572,20 @@ export interface PaymentStatusDtoTransaction {
|
|
|
18158
18572
|
}
|
|
18159
18573
|
|
|
18160
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
|
+
|
|
18161
18589
|
/**
|
|
18162
18590
|
*
|
|
18163
18591
|
* @export
|
|
@@ -18745,6 +19173,18 @@ export interface PosDiscountDto {
|
|
|
18745
19173
|
* @memberof PosDiscountDto
|
|
18746
19174
|
*/
|
|
18747
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;
|
|
18748
19188
|
}
|
|
18749
19189
|
|
|
18750
19190
|
|
|
@@ -20625,6 +21065,18 @@ export interface PosOrderItemDtoDiscount {
|
|
|
20625
21065
|
* @memberof PosOrderItemDtoDiscount
|
|
20626
21066
|
*/
|
|
20627
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;
|
|
20628
21080
|
}
|
|
20629
21081
|
|
|
20630
21082
|
|
|
@@ -24316,6 +24768,254 @@ export interface RequestSessionTokenResponseDto {
|
|
|
24316
24768
|
*/
|
|
24317
24769
|
'sessionChannel': string;
|
|
24318
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
|
+
}
|
|
24319
25019
|
/**
|
|
24320
25020
|
*
|
|
24321
25021
|
* @export
|
|
@@ -24371,6 +25071,12 @@ export interface ReservationAvailabilitySlotDto {
|
|
|
24371
25071
|
* @memberof ReservationAvailabilitySlotDto
|
|
24372
25072
|
*/
|
|
24373
25073
|
'availableTables': number;
|
|
25074
|
+
/**
|
|
25075
|
+
* Minutes left until closing when the turn (turnTimeMins) would run past it, the duration to book so the booking ends at closing under the venue\'s last seating; absent when the whole turn fits. The tables are still checked free for the whole turn
|
|
25076
|
+
* @type {number}
|
|
25077
|
+
* @memberof ReservationAvailabilitySlotDto
|
|
25078
|
+
*/
|
|
25079
|
+
'durationMins'?: number;
|
|
24374
25080
|
}
|
|
24375
25081
|
/**
|
|
24376
25082
|
*
|
|
@@ -30995,6 +31701,31 @@ export interface UpdateInvoiceCompanyDto {
|
|
|
30995
31701
|
*/
|
|
30996
31702
|
'address'?: string;
|
|
30997
31703
|
}
|
|
31704
|
+
/**
|
|
31705
|
+
*
|
|
31706
|
+
* @export
|
|
31707
|
+
* @interface UpdateKdsStationDto
|
|
31708
|
+
*/
|
|
31709
|
+
export interface UpdateKdsStationDto {
|
|
31710
|
+
/**
|
|
31711
|
+
* The Munchi venue id (orderingBusinessId) the station belongs to
|
|
31712
|
+
* @type {number}
|
|
31713
|
+
* @memberof UpdateKdsStationDto
|
|
31714
|
+
*/
|
|
31715
|
+
'businessId': number;
|
|
31716
|
+
/**
|
|
31717
|
+
* The station\'s new name; absent keeps its name
|
|
31718
|
+
* @type {string}
|
|
31719
|
+
* @memberof UpdateKdsStationDto
|
|
31720
|
+
*/
|
|
31721
|
+
'name'?: string;
|
|
31722
|
+
/**
|
|
31723
|
+
* The station\'s complete new list of categories: it replaces the list it had. The ids of the venue\'s menu categories whose items this station shows, as text; an item of a subcategory goes to the station of its nearest category listed here. A category is on one station only: listing it here takes it off the station that had it. An empty list makes the station show the items no station lists
|
|
31724
|
+
* @type {Array<string>}
|
|
31725
|
+
* @memberof UpdateKdsStationDto
|
|
31726
|
+
*/
|
|
31727
|
+
'categoryIds': Array<string>;
|
|
31728
|
+
}
|
|
30998
31729
|
/**
|
|
30999
31730
|
*
|
|
31000
31731
|
* @export
|
|
@@ -31238,7 +31969,7 @@ export interface UpdateReservationPolicyDto {
|
|
|
31238
31969
|
*/
|
|
31239
31970
|
'maxHorizonDays'?: number;
|
|
31240
31971
|
/**
|
|
31241
|
-
* The last seating:
|
|
31972
|
+
* The last seating: slots start until this many minutes before each opening closes, and a slot whose turn would run past closing answers durationMins, the minutes left until closing; 0 (no last seating: the turn and its buffer must fit before closing) on create when absent
|
|
31242
31973
|
* @type {number}
|
|
31243
31974
|
* @memberof UpdateReservationPolicyDto
|
|
31244
31975
|
*/
|
|
@@ -31350,6 +32081,32 @@ export interface UpdateTableStatusDto {
|
|
|
31350
32081
|
}
|
|
31351
32082
|
|
|
31352
32083
|
|
|
32084
|
+
/**
|
|
32085
|
+
*
|
|
32086
|
+
* @export
|
|
32087
|
+
* @interface UpdateVenueProvidersDto
|
|
32088
|
+
*/
|
|
32089
|
+
export interface UpdateVenueProvidersDto {
|
|
32090
|
+
/**
|
|
32091
|
+
* One entry per channel to change, each asking at least one change. A channel named twice is refused. Every row of the venue on the channel changes, active or not, except that isActive true on a platform (Wolt, WoltStorefront, UberEats, Foodora, Bolt, ResQ) turns on only its newest row
|
|
32092
|
+
* @type {Array<VenueProviderChangeDto>}
|
|
32093
|
+
* @memberof UpdateVenueProvidersDto
|
|
32094
|
+
*/
|
|
32095
|
+
'providers': Array<VenueProviderChangeDto>;
|
|
32096
|
+
}
|
|
32097
|
+
/**
|
|
32098
|
+
*
|
|
32099
|
+
* @export
|
|
32100
|
+
* @interface UpdatedVenueProvidersDto
|
|
32101
|
+
*/
|
|
32102
|
+
export interface UpdatedVenueProvidersDto {
|
|
32103
|
+
/**
|
|
32104
|
+
* One entry per channel sent, in the order sent
|
|
32105
|
+
* @type {Array<VenueProviderOutcomeDto>}
|
|
32106
|
+
* @memberof UpdatedVenueProvidersDto
|
|
32107
|
+
*/
|
|
32108
|
+
'providers': Array<VenueProviderOutcomeDto>;
|
|
32109
|
+
}
|
|
31353
32110
|
/**
|
|
31354
32111
|
*
|
|
31355
32112
|
* @export
|
|
@@ -31891,17 +32648,23 @@ export interface UpsertProvidersDto {
|
|
|
31891
32648
|
*/
|
|
31892
32649
|
'sourceCode'?: string;
|
|
31893
32650
|
/**
|
|
31894
|
-
* 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.
|
|
31895
32652
|
* @type {number}
|
|
31896
32653
|
* @memberof UpsertProvidersDto
|
|
31897
32654
|
*/
|
|
31898
32655
|
'rate'?: number;
|
|
31899
32656
|
/**
|
|
31900
|
-
* 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.
|
|
31901
32658
|
* @type {number}
|
|
31902
32659
|
* @memberof UpsertProvidersDto
|
|
31903
32660
|
*/
|
|
31904
32661
|
'additionalAmount'?: number;
|
|
32662
|
+
/**
|
|
32663
|
+
*
|
|
32664
|
+
* @type {PaymentSurchargePaidBy}
|
|
32665
|
+
* @memberof UpsertProvidersDto
|
|
32666
|
+
*/
|
|
32667
|
+
'surchargePaidBy'?: PaymentSurchargePaidBy;
|
|
31905
32668
|
/**
|
|
31906
32669
|
* Nets / Stripe / Worldline secret key. Absent keeps the stored value.
|
|
31907
32670
|
* @type {string}
|
|
@@ -32036,6 +32799,12 @@ export interface UpsertVivaDto {
|
|
|
32036
32799
|
* @memberof UpsertVivaDto
|
|
32037
32800
|
*/
|
|
32038
32801
|
'isActive'?: boolean;
|
|
32802
|
+
/**
|
|
32803
|
+
*
|
|
32804
|
+
* @type {PaymentSurchargePaidBy}
|
|
32805
|
+
* @memberof UpsertVivaDto
|
|
32806
|
+
*/
|
|
32807
|
+
'surchargePaidBy'?: PaymentSurchargePaidBy;
|
|
32039
32808
|
/**
|
|
32040
32809
|
*
|
|
32041
32810
|
* @type {UpsertVivaDtoConfig}
|
|
@@ -32043,6 +32812,8 @@ export interface UpsertVivaDto {
|
|
|
32043
32812
|
*/
|
|
32044
32813
|
'config'?: UpsertVivaDtoConfig;
|
|
32045
32814
|
}
|
|
32815
|
+
|
|
32816
|
+
|
|
32046
32817
|
/**
|
|
32047
32818
|
* The Viva settings, merged over the stored ones: a key sent replaces the stored key, a key absent keeps it.
|
|
32048
32819
|
* @export
|
|
@@ -32050,7 +32821,7 @@ export interface UpsertVivaDto {
|
|
|
32050
32821
|
*/
|
|
32051
32822
|
export interface UpsertVivaDtoConfig {
|
|
32052
32823
|
/**
|
|
32053
|
-
* 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.
|
|
32054
32825
|
* @type {number}
|
|
32055
32826
|
* @memberof UpsertVivaDtoConfig
|
|
32056
32827
|
*/
|
|
@@ -32068,7 +32839,7 @@ export interface UpsertVivaDtoConfig {
|
|
|
32068
32839
|
*/
|
|
32069
32840
|
'sourceCode'?: string;
|
|
32070
32841
|
/**
|
|
32071
|
-
* 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.
|
|
32072
32843
|
* @type {number}
|
|
32073
32844
|
* @memberof UpsertVivaDtoConfig
|
|
32074
32845
|
*/
|
|
@@ -32455,6 +33226,136 @@ export interface VenueListEntryDto {
|
|
|
32455
33226
|
*/
|
|
32456
33227
|
'businessName': string;
|
|
32457
33228
|
}
|
|
33229
|
+
/**
|
|
33230
|
+
*
|
|
33231
|
+
* @export
|
|
33232
|
+
* @interface VenueProviderChangeDto
|
|
33233
|
+
*/
|
|
33234
|
+
export interface VenueProviderChangeDto {
|
|
33235
|
+
/**
|
|
33236
|
+
*
|
|
33237
|
+
* @type {ProviderEnum}
|
|
33238
|
+
* @memberof VenueProviderChangeDto
|
|
33239
|
+
*/
|
|
33240
|
+
'channel': ProviderEnum;
|
|
33241
|
+
/**
|
|
33242
|
+
*
|
|
33243
|
+
* @type {VenueProviderChangeDtoIntegrations}
|
|
33244
|
+
* @memberof VenueProviderChangeDto
|
|
33245
|
+
*/
|
|
33246
|
+
'integrations'?: VenueProviderChangeDtoIntegrations;
|
|
33247
|
+
/**
|
|
33248
|
+
* false turns the channel off at the venue (its rows stay, never deleted); true turns it on. Absent: left as it is
|
|
33249
|
+
* @type {boolean}
|
|
33250
|
+
* @memberof VenueProviderChangeDto
|
|
33251
|
+
*/
|
|
33252
|
+
'isActive'?: boolean;
|
|
33253
|
+
/**
|
|
33254
|
+
* Whether the channel\'s orders are accepted without the till. Absent: left as it is
|
|
33255
|
+
* @type {boolean}
|
|
33256
|
+
* @memberof VenueProviderChangeDto
|
|
33257
|
+
*/
|
|
33258
|
+
'autoAccept'?: boolean;
|
|
33259
|
+
}
|
|
33260
|
+
|
|
33261
|
+
|
|
33262
|
+
/**
|
|
33263
|
+
* Integrations to switch on (true) or off (false) on the channel\'s rows, by IntegrationType. An integration left out keeps its state; absent: none changes
|
|
33264
|
+
* @export
|
|
33265
|
+
* @interface VenueProviderChangeDtoIntegrations
|
|
33266
|
+
*/
|
|
33267
|
+
export interface VenueProviderChangeDtoIntegrations {
|
|
33268
|
+
/**
|
|
33269
|
+
*
|
|
33270
|
+
* @type {boolean}
|
|
33271
|
+
* @memberof VenueProviderChangeDtoIntegrations
|
|
33272
|
+
*/
|
|
33273
|
+
'ORDERS'?: boolean;
|
|
33274
|
+
/**
|
|
33275
|
+
*
|
|
33276
|
+
* @type {boolean}
|
|
33277
|
+
* @memberof VenueProviderChangeDtoIntegrations
|
|
33278
|
+
*/
|
|
33279
|
+
'MENU'?: boolean;
|
|
33280
|
+
/**
|
|
33281
|
+
*
|
|
33282
|
+
* @type {boolean}
|
|
33283
|
+
* @memberof VenueProviderChangeDtoIntegrations
|
|
33284
|
+
*/
|
|
33285
|
+
'VENUE'?: boolean;
|
|
33286
|
+
/**
|
|
33287
|
+
*
|
|
33288
|
+
* @type {boolean}
|
|
33289
|
+
* @memberof VenueProviderChangeDtoIntegrations
|
|
33290
|
+
*/
|
|
33291
|
+
'KDS'?: boolean;
|
|
33292
|
+
/**
|
|
33293
|
+
*
|
|
33294
|
+
* @type {boolean}
|
|
33295
|
+
* @memberof VenueProviderChangeDtoIntegrations
|
|
33296
|
+
*/
|
|
33297
|
+
'AYCE'?: boolean;
|
|
33298
|
+
}
|
|
33299
|
+
/**
|
|
33300
|
+
*
|
|
33301
|
+
* @export
|
|
33302
|
+
* @enum {string}
|
|
33303
|
+
*/
|
|
33304
|
+
|
|
33305
|
+
export const VenueProviderOutcome = {
|
|
33306
|
+
Created: 'created',
|
|
33307
|
+
Updated: 'updated',
|
|
33308
|
+
Unchanged: 'unchanged'
|
|
33309
|
+
} as const;
|
|
33310
|
+
|
|
33311
|
+
export type VenueProviderOutcome = typeof VenueProviderOutcome[keyof typeof VenueProviderOutcome];
|
|
33312
|
+
|
|
33313
|
+
|
|
33314
|
+
/**
|
|
33315
|
+
*
|
|
33316
|
+
* @export
|
|
33317
|
+
* @interface VenueProviderOutcomeDto
|
|
33318
|
+
*/
|
|
33319
|
+
export interface VenueProviderOutcomeDto {
|
|
33320
|
+
/**
|
|
33321
|
+
*
|
|
33322
|
+
* @type {ProviderEnum}
|
|
33323
|
+
* @memberof VenueProviderOutcomeDto
|
|
33324
|
+
*/
|
|
33325
|
+
'channel': ProviderEnum;
|
|
33326
|
+
/**
|
|
33327
|
+
*
|
|
33328
|
+
* @type {VenueProviderOutcome}
|
|
33329
|
+
* @memberof VenueProviderOutcomeDto
|
|
33330
|
+
*/
|
|
33331
|
+
'outcome': VenueProviderOutcome;
|
|
33332
|
+
/**
|
|
33333
|
+
* How many of the venue\'s rows on the channel changed or were added; a venue may have several rows on one channel
|
|
33334
|
+
* @type {number}
|
|
33335
|
+
* @memberof VenueProviderOutcomeDto
|
|
33336
|
+
*/
|
|
33337
|
+
'rowsChanged': number;
|
|
33338
|
+
/**
|
|
33339
|
+
* Whether the channel is on, as its row reads after the change: the first active row, else the first row, by store id
|
|
33340
|
+
* @type {boolean}
|
|
33341
|
+
* @memberof VenueProviderOutcomeDto
|
|
33342
|
+
*/
|
|
33343
|
+
'isActive': boolean;
|
|
33344
|
+
/**
|
|
33345
|
+
* Whether the channel\'s orders are accepted without the till, as the same row reads after the change
|
|
33346
|
+
* @type {boolean}
|
|
33347
|
+
* @memberof VenueProviderOutcomeDto
|
|
33348
|
+
*/
|
|
33349
|
+
'autoAccept': boolean;
|
|
33350
|
+
/**
|
|
33351
|
+
* The integrations the same row takes after the change
|
|
33352
|
+
* @type {Array<IntegrationType>}
|
|
33353
|
+
* @memberof VenueProviderOutcomeDto
|
|
33354
|
+
*/
|
|
33355
|
+
'integrations': Array<IntegrationType>;
|
|
33356
|
+
}
|
|
33357
|
+
|
|
33358
|
+
|
|
32458
33359
|
/**
|
|
32459
33360
|
*
|
|
32460
33361
|
* @export
|
|
@@ -32867,7 +33768,7 @@ export interface VivaCancelTransactionDto {
|
|
|
32867
33768
|
*/
|
|
32868
33769
|
export interface VivaConfigDto {
|
|
32869
33770
|
/**
|
|
32870
|
-
* 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.
|
|
32871
33772
|
* @type {number}
|
|
32872
33773
|
* @memberof VivaConfigDto
|
|
32873
33774
|
*/
|
|
@@ -32885,7 +33786,7 @@ export interface VivaConfigDto {
|
|
|
32885
33786
|
*/
|
|
32886
33787
|
'sourceCode'?: string;
|
|
32887
33788
|
/**
|
|
32888
|
-
* 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.
|
|
32889
33790
|
* @type {number}
|
|
32890
33791
|
* @memberof VivaConfigDto
|
|
32891
33792
|
*/
|
|
@@ -40337,6 +41238,230 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
40337
41238
|
}
|
|
40338
41239
|
|
|
40339
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
|
+
|
|
40340
41465
|
/**
|
|
40341
41466
|
* CoursesApi - axios parameter creator
|
|
40342
41467
|
* @export
|
|
@@ -45301,6 +46426,91 @@ export class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompaniesApiI
|
|
|
45301
46426
|
*/
|
|
45302
46427
|
export const KDSApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
45303
46428
|
return {
|
|
46429
|
+
/**
|
|
46430
|
+
* Written in kds-service in one transaction: every station is created, or none is. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46431
|
+
* @summary Create several kitchen stations at once, each with its categories
|
|
46432
|
+
* @param {CreateKdsStationsDto} createKdsStationsDto The venue and the stations to create
|
|
46433
|
+
* @param {*} [options] Override http request option.
|
|
46434
|
+
* @throws {RequiredError}
|
|
46435
|
+
*/
|
|
46436
|
+
createKdsStations: async (createKdsStationsDto: CreateKdsStationsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
46437
|
+
// verify required parameter 'createKdsStationsDto' is not null or undefined
|
|
46438
|
+
assertParamExists('createKdsStations', 'createKdsStationsDto', createKdsStationsDto)
|
|
46439
|
+
const localVarPath = `/api/v2/kds/stations`;
|
|
46440
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46441
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
46442
|
+
let baseOptions;
|
|
46443
|
+
if (configuration) {
|
|
46444
|
+
baseOptions = configuration.baseOptions;
|
|
46445
|
+
}
|
|
46446
|
+
|
|
46447
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
46448
|
+
const localVarHeaderParameter = {} as any;
|
|
46449
|
+
const localVarQueryParameter = {} as any;
|
|
46450
|
+
|
|
46451
|
+
// authentication JWT-auth required
|
|
46452
|
+
// http bearer authentication required
|
|
46453
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
46454
|
+
|
|
46455
|
+
|
|
46456
|
+
|
|
46457
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
46458
|
+
|
|
46459
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
46460
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
46461
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
46462
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createKdsStationsDto, localVarRequestOptions, configuration)
|
|
46463
|
+
|
|
46464
|
+
return {
|
|
46465
|
+
url: toPathString(localVarUrlObj),
|
|
46466
|
+
options: localVarRequestOptions,
|
|
46467
|
+
};
|
|
46468
|
+
},
|
|
46469
|
+
/**
|
|
46470
|
+
* kds-service soft-deletes the station: it receives no more tickets and leaves every list. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46471
|
+
* @summary Delete a kitchen station
|
|
46472
|
+
* @param {string} stationId The station\'s id in kds-service (its KDS profile id)
|
|
46473
|
+
* @param {number} businessId The Munchi venue id (orderingBusinessId)
|
|
46474
|
+
* @param {*} [options] Override http request option.
|
|
46475
|
+
* @throws {RequiredError}
|
|
46476
|
+
*/
|
|
46477
|
+
deleteKdsStation: async (stationId: string, businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
46478
|
+
// verify required parameter 'stationId' is not null or undefined
|
|
46479
|
+
assertParamExists('deleteKdsStation', 'stationId', stationId)
|
|
46480
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
46481
|
+
assertParamExists('deleteKdsStation', 'businessId', businessId)
|
|
46482
|
+
const localVarPath = `/api/v2/kds/stations/{stationId}`
|
|
46483
|
+
.replace(`{${"stationId"}}`, encodeURIComponent(String(stationId)));
|
|
46484
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46485
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
46486
|
+
let baseOptions;
|
|
46487
|
+
if (configuration) {
|
|
46488
|
+
baseOptions = configuration.baseOptions;
|
|
46489
|
+
}
|
|
46490
|
+
|
|
46491
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
46492
|
+
const localVarHeaderParameter = {} as any;
|
|
46493
|
+
const localVarQueryParameter = {} as any;
|
|
46494
|
+
|
|
46495
|
+
// authentication JWT-auth required
|
|
46496
|
+
// http bearer authentication required
|
|
46497
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
46498
|
+
|
|
46499
|
+
if (businessId !== undefined) {
|
|
46500
|
+
localVarQueryParameter['businessId'] = businessId;
|
|
46501
|
+
}
|
|
46502
|
+
|
|
46503
|
+
|
|
46504
|
+
|
|
46505
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
46506
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
46507
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
46508
|
+
|
|
46509
|
+
return {
|
|
46510
|
+
url: toPathString(localVarUrlObj),
|
|
46511
|
+
options: localVarRequestOptions,
|
|
46512
|
+
};
|
|
46513
|
+
},
|
|
45304
46514
|
/**
|
|
45305
46515
|
* Read from kds-service. The status is passed on as sent: the kitchen screen asks for IN_PROGRESS and READY.
|
|
45306
46516
|
* @summary List one station\'s kitchen orders in one state, a page at a time
|
|
@@ -45545,6 +46755,91 @@ export const KDSApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
45545
46755
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
45546
46756
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
45547
46757
|
|
|
46758
|
+
return {
|
|
46759
|
+
url: toPathString(localVarUrlObj),
|
|
46760
|
+
options: localVarRequestOptions,
|
|
46761
|
+
};
|
|
46762
|
+
},
|
|
46763
|
+
/**
|
|
46764
|
+
* Read from kds-service: the venue\'s active stations, each with the menu categories it shows. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46765
|
+
* @summary List the venue\'s kitchen stations with their categories
|
|
46766
|
+
* @param {number} businessId The Munchi venue id (orderingBusinessId)
|
|
46767
|
+
* @param {*} [options] Override http request option.
|
|
46768
|
+
* @throws {RequiredError}
|
|
46769
|
+
*/
|
|
46770
|
+
listKdsStations: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
46771
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
46772
|
+
assertParamExists('listKdsStations', 'businessId', businessId)
|
|
46773
|
+
const localVarPath = `/api/v2/kds/stations`;
|
|
46774
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46775
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
46776
|
+
let baseOptions;
|
|
46777
|
+
if (configuration) {
|
|
46778
|
+
baseOptions = configuration.baseOptions;
|
|
46779
|
+
}
|
|
46780
|
+
|
|
46781
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
46782
|
+
const localVarHeaderParameter = {} as any;
|
|
46783
|
+
const localVarQueryParameter = {} as any;
|
|
46784
|
+
|
|
46785
|
+
// authentication JWT-auth required
|
|
46786
|
+
// http bearer authentication required
|
|
46787
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
46788
|
+
|
|
46789
|
+
if (businessId !== undefined) {
|
|
46790
|
+
localVarQueryParameter['businessId'] = businessId;
|
|
46791
|
+
}
|
|
46792
|
+
|
|
46793
|
+
|
|
46794
|
+
|
|
46795
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
46796
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
46797
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
46798
|
+
|
|
46799
|
+
return {
|
|
46800
|
+
url: toPathString(localVarUrlObj),
|
|
46801
|
+
options: localVarRequestOptions,
|
|
46802
|
+
};
|
|
46803
|
+
},
|
|
46804
|
+
/**
|
|
46805
|
+
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46806
|
+
* @summary Rename a kitchen station and replace its categories
|
|
46807
|
+
* @param {string} stationId The station\'s id in kds-service (its KDS profile id)
|
|
46808
|
+
* @param {UpdateKdsStationDto} updateKdsStationDto The venue, and the station\'s new name and categories
|
|
46809
|
+
* @param {*} [options] Override http request option.
|
|
46810
|
+
* @throws {RequiredError}
|
|
46811
|
+
*/
|
|
46812
|
+
updateKdsStation: async (stationId: string, updateKdsStationDto: UpdateKdsStationDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
46813
|
+
// verify required parameter 'stationId' is not null or undefined
|
|
46814
|
+
assertParamExists('updateKdsStation', 'stationId', stationId)
|
|
46815
|
+
// verify required parameter 'updateKdsStationDto' is not null or undefined
|
|
46816
|
+
assertParamExists('updateKdsStation', 'updateKdsStationDto', updateKdsStationDto)
|
|
46817
|
+
const localVarPath = `/api/v2/kds/stations/{stationId}`
|
|
46818
|
+
.replace(`{${"stationId"}}`, encodeURIComponent(String(stationId)));
|
|
46819
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46820
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
46821
|
+
let baseOptions;
|
|
46822
|
+
if (configuration) {
|
|
46823
|
+
baseOptions = configuration.baseOptions;
|
|
46824
|
+
}
|
|
46825
|
+
|
|
46826
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
46827
|
+
const localVarHeaderParameter = {} as any;
|
|
46828
|
+
const localVarQueryParameter = {} as any;
|
|
46829
|
+
|
|
46830
|
+
// authentication JWT-auth required
|
|
46831
|
+
// http bearer authentication required
|
|
46832
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
46833
|
+
|
|
46834
|
+
|
|
46835
|
+
|
|
46836
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
46837
|
+
|
|
46838
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
46839
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
46840
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
46841
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateKdsStationDto, localVarRequestOptions, configuration)
|
|
46842
|
+
|
|
45548
46843
|
return {
|
|
45549
46844
|
url: toPathString(localVarUrlObj),
|
|
45550
46845
|
options: localVarRequestOptions,
|
|
@@ -45560,6 +46855,29 @@ export const KDSApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
45560
46855
|
export const KDSApiFp = function(configuration?: Configuration) {
|
|
45561
46856
|
const localVarAxiosParamCreator = KDSApiAxiosParamCreator(configuration)
|
|
45562
46857
|
return {
|
|
46858
|
+
/**
|
|
46859
|
+
* Written in kds-service in one transaction: every station is created, or none is. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46860
|
+
* @summary Create several kitchen stations at once, each with its categories
|
|
46861
|
+
* @param {CreateKdsStationsDto} createKdsStationsDto The venue and the stations to create
|
|
46862
|
+
* @param {*} [options] Override http request option.
|
|
46863
|
+
* @throws {RequiredError}
|
|
46864
|
+
*/
|
|
46865
|
+
async createKdsStations(createKdsStationsDto: CreateKdsStationsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<KdsStationDto>>> {
|
|
46866
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createKdsStations(createKdsStationsDto, options);
|
|
46867
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46868
|
+
},
|
|
46869
|
+
/**
|
|
46870
|
+
* kds-service soft-deletes the station: it receives no more tickets and leaves every list. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46871
|
+
* @summary Delete a kitchen station
|
|
46872
|
+
* @param {string} stationId The station\'s id in kds-service (its KDS profile id)
|
|
46873
|
+
* @param {number} businessId The Munchi venue id (orderingBusinessId)
|
|
46874
|
+
* @param {*} [options] Override http request option.
|
|
46875
|
+
* @throws {RequiredError}
|
|
46876
|
+
*/
|
|
46877
|
+
async deleteKdsStation(stationId: string, businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KdsStationDto>> {
|
|
46878
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteKdsStation(stationId, businessId, options);
|
|
46879
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46880
|
+
},
|
|
45563
46881
|
/**
|
|
45564
46882
|
* Read from kds-service. The status is passed on as sent: the kitchen screen asks for IN_PROGRESS and READY.
|
|
45565
46883
|
* @summary List one station\'s kitchen orders in one state, a page at a time
|
|
@@ -45625,6 +46943,29 @@ export const KDSApiFp = function(configuration?: Configuration) {
|
|
|
45625
46943
|
const localVarAxiosArgs = await localVarAxiosParamCreator.kdsRevertOrder(id, options);
|
|
45626
46944
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
45627
46945
|
},
|
|
46946
|
+
/**
|
|
46947
|
+
* Read from kds-service: the venue\'s active stations, each with the menu categories it shows. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46948
|
+
* @summary List the venue\'s kitchen stations with their categories
|
|
46949
|
+
* @param {number} businessId The Munchi venue id (orderingBusinessId)
|
|
46950
|
+
* @param {*} [options] Override http request option.
|
|
46951
|
+
* @throws {RequiredError}
|
|
46952
|
+
*/
|
|
46953
|
+
async listKdsStations(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<KdsStationDto>>> {
|
|
46954
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listKdsStations(businessId, options);
|
|
46955
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46956
|
+
},
|
|
46957
|
+
/**
|
|
46958
|
+
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46959
|
+
* @summary Rename a kitchen station and replace its categories
|
|
46960
|
+
* @param {string} stationId The station\'s id in kds-service (its KDS profile id)
|
|
46961
|
+
* @param {UpdateKdsStationDto} updateKdsStationDto The venue, and the station\'s new name and categories
|
|
46962
|
+
* @param {*} [options] Override http request option.
|
|
46963
|
+
* @throws {RequiredError}
|
|
46964
|
+
*/
|
|
46965
|
+
async updateKdsStation(stationId: string, updateKdsStationDto: UpdateKdsStationDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KdsStationDto>> {
|
|
46966
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateKdsStation(stationId, updateKdsStationDto, options);
|
|
46967
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46968
|
+
},
|
|
45628
46969
|
}
|
|
45629
46970
|
};
|
|
45630
46971
|
|
|
@@ -45635,6 +46976,27 @@ export const KDSApiFp = function(configuration?: Configuration) {
|
|
|
45635
46976
|
export const KDSApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
45636
46977
|
const localVarFp = KDSApiFp(configuration)
|
|
45637
46978
|
return {
|
|
46979
|
+
/**
|
|
46980
|
+
* Written in kds-service in one transaction: every station is created, or none is. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46981
|
+
* @summary Create several kitchen stations at once, each with its categories
|
|
46982
|
+
* @param {CreateKdsStationsDto} createKdsStationsDto The venue and the stations to create
|
|
46983
|
+
* @param {*} [options] Override http request option.
|
|
46984
|
+
* @throws {RequiredError}
|
|
46985
|
+
*/
|
|
46986
|
+
createKdsStations(createKdsStationsDto: CreateKdsStationsDto, options?: any): AxiosPromise<Array<KdsStationDto>> {
|
|
46987
|
+
return localVarFp.createKdsStations(createKdsStationsDto, options).then((request) => request(axios, basePath));
|
|
46988
|
+
},
|
|
46989
|
+
/**
|
|
46990
|
+
* kds-service soft-deletes the station: it receives no more tickets and leaves every list. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46991
|
+
* @summary Delete a kitchen station
|
|
46992
|
+
* @param {string} stationId The station\'s id in kds-service (its KDS profile id)
|
|
46993
|
+
* @param {number} businessId The Munchi venue id (orderingBusinessId)
|
|
46994
|
+
* @param {*} [options] Override http request option.
|
|
46995
|
+
* @throws {RequiredError}
|
|
46996
|
+
*/
|
|
46997
|
+
deleteKdsStation(stationId: string, businessId: number, options?: any): AxiosPromise<KdsStationDto> {
|
|
46998
|
+
return localVarFp.deleteKdsStation(stationId, businessId, options).then((request) => request(axios, basePath));
|
|
46999
|
+
},
|
|
45638
47000
|
/**
|
|
45639
47001
|
* Read from kds-service. The status is passed on as sent: the kitchen screen asks for IN_PROGRESS and READY.
|
|
45640
47002
|
* @summary List one station\'s kitchen orders in one state, a page at a time
|
|
@@ -45695,6 +47057,27 @@ export const KDSApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
45695
47057
|
kdsRevertOrder(id: string, options?: any): AxiosPromise<KdsRevertOrderResponseDto> {
|
|
45696
47058
|
return localVarFp.kdsRevertOrder(id, options).then((request) => request(axios, basePath));
|
|
45697
47059
|
},
|
|
47060
|
+
/**
|
|
47061
|
+
* Read from kds-service: the venue\'s active stations, each with the menu categories it shows. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
47062
|
+
* @summary List the venue\'s kitchen stations with their categories
|
|
47063
|
+
* @param {number} businessId The Munchi venue id (orderingBusinessId)
|
|
47064
|
+
* @param {*} [options] Override http request option.
|
|
47065
|
+
* @throws {RequiredError}
|
|
47066
|
+
*/
|
|
47067
|
+
listKdsStations(businessId: number, options?: any): AxiosPromise<Array<KdsStationDto>> {
|
|
47068
|
+
return localVarFp.listKdsStations(businessId, options).then((request) => request(axios, basePath));
|
|
47069
|
+
},
|
|
47070
|
+
/**
|
|
47071
|
+
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
47072
|
+
* @summary Rename a kitchen station and replace its categories
|
|
47073
|
+
* @param {string} stationId The station\'s id in kds-service (its KDS profile id)
|
|
47074
|
+
* @param {UpdateKdsStationDto} updateKdsStationDto The venue, and the station\'s new name and categories
|
|
47075
|
+
* @param {*} [options] Override http request option.
|
|
47076
|
+
* @throws {RequiredError}
|
|
47077
|
+
*/
|
|
47078
|
+
updateKdsStation(stationId: string, updateKdsStationDto: UpdateKdsStationDto, options?: any): AxiosPromise<KdsStationDto> {
|
|
47079
|
+
return localVarFp.updateKdsStation(stationId, updateKdsStationDto, options).then((request) => request(axios, basePath));
|
|
47080
|
+
},
|
|
45698
47081
|
};
|
|
45699
47082
|
};
|
|
45700
47083
|
|
|
@@ -45704,6 +47087,27 @@ export const KDSApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
45704
47087
|
* @interface KDSApi
|
|
45705
47088
|
*/
|
|
45706
47089
|
export interface KDSApiInterface {
|
|
47090
|
+
/**
|
|
47091
|
+
* Written in kds-service in one transaction: every station is created, or none is. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
47092
|
+
* @summary Create several kitchen stations at once, each with its categories
|
|
47093
|
+
* @param {CreateKdsStationsDto} createKdsStationsDto The venue and the stations to create
|
|
47094
|
+
* @param {*} [options] Override http request option.
|
|
47095
|
+
* @throws {RequiredError}
|
|
47096
|
+
* @memberof KDSApiInterface
|
|
47097
|
+
*/
|
|
47098
|
+
createKdsStations(createKdsStationsDto: CreateKdsStationsDto, options?: AxiosRequestConfig): AxiosPromise<Array<KdsStationDto>>;
|
|
47099
|
+
|
|
47100
|
+
/**
|
|
47101
|
+
* kds-service soft-deletes the station: it receives no more tickets and leaves every list. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
47102
|
+
* @summary Delete a kitchen station
|
|
47103
|
+
* @param {string} stationId The station\'s id in kds-service (its KDS profile id)
|
|
47104
|
+
* @param {number} businessId The Munchi venue id (orderingBusinessId)
|
|
47105
|
+
* @param {*} [options] Override http request option.
|
|
47106
|
+
* @throws {RequiredError}
|
|
47107
|
+
* @memberof KDSApiInterface
|
|
47108
|
+
*/
|
|
47109
|
+
deleteKdsStation(stationId: string, businessId: number, options?: AxiosRequestConfig): AxiosPromise<KdsStationDto>;
|
|
47110
|
+
|
|
45707
47111
|
/**
|
|
45708
47112
|
* Read from kds-service. The status is passed on as sent: the kitchen screen asks for IN_PROGRESS and READY.
|
|
45709
47113
|
* @summary List one station\'s kitchen orders in one state, a page at a time
|
|
@@ -45764,6 +47168,27 @@ export interface KDSApiInterface {
|
|
|
45764
47168
|
*/
|
|
45765
47169
|
kdsRevertOrder(id: string, options?: AxiosRequestConfig): AxiosPromise<KdsRevertOrderResponseDto>;
|
|
45766
47170
|
|
|
47171
|
+
/**
|
|
47172
|
+
* Read from kds-service: the venue\'s active stations, each with the menu categories it shows. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
47173
|
+
* @summary List the venue\'s kitchen stations with their categories
|
|
47174
|
+
* @param {number} businessId The Munchi venue id (orderingBusinessId)
|
|
47175
|
+
* @param {*} [options] Override http request option.
|
|
47176
|
+
* @throws {RequiredError}
|
|
47177
|
+
* @memberof KDSApiInterface
|
|
47178
|
+
*/
|
|
47179
|
+
listKdsStations(businessId: number, options?: AxiosRequestConfig): AxiosPromise<Array<KdsStationDto>>;
|
|
47180
|
+
|
|
47181
|
+
/**
|
|
47182
|
+
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
47183
|
+
* @summary Rename a kitchen station and replace its categories
|
|
47184
|
+
* @param {string} stationId The station\'s id in kds-service (its KDS profile id)
|
|
47185
|
+
* @param {UpdateKdsStationDto} updateKdsStationDto The venue, and the station\'s new name and categories
|
|
47186
|
+
* @param {*} [options] Override http request option.
|
|
47187
|
+
* @throws {RequiredError}
|
|
47188
|
+
* @memberof KDSApiInterface
|
|
47189
|
+
*/
|
|
47190
|
+
updateKdsStation(stationId: string, updateKdsStationDto: UpdateKdsStationDto, options?: AxiosRequestConfig): AxiosPromise<KdsStationDto>;
|
|
47191
|
+
|
|
45767
47192
|
}
|
|
45768
47193
|
|
|
45769
47194
|
/**
|
|
@@ -45773,6 +47198,31 @@ export interface KDSApiInterface {
|
|
|
45773
47198
|
* @extends {BaseAPI}
|
|
45774
47199
|
*/
|
|
45775
47200
|
export class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
47201
|
+
/**
|
|
47202
|
+
* Written in kds-service in one transaction: every station is created, or none is. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
47203
|
+
* @summary Create several kitchen stations at once, each with its categories
|
|
47204
|
+
* @param {CreateKdsStationsDto} createKdsStationsDto The venue and the stations to create
|
|
47205
|
+
* @param {*} [options] Override http request option.
|
|
47206
|
+
* @throws {RequiredError}
|
|
47207
|
+
* @memberof KDSApi
|
|
47208
|
+
*/
|
|
47209
|
+
public createKdsStations(createKdsStationsDto: CreateKdsStationsDto, options?: AxiosRequestConfig) {
|
|
47210
|
+
return KDSApiFp(this.configuration).createKdsStations(createKdsStationsDto, options).then((request) => request(this.axios, this.basePath));
|
|
47211
|
+
}
|
|
47212
|
+
|
|
47213
|
+
/**
|
|
47214
|
+
* kds-service soft-deletes the station: it receives no more tickets and leaves every list. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
47215
|
+
* @summary Delete a kitchen station
|
|
47216
|
+
* @param {string} stationId The station\'s id in kds-service (its KDS profile id)
|
|
47217
|
+
* @param {number} businessId The Munchi venue id (orderingBusinessId)
|
|
47218
|
+
* @param {*} [options] Override http request option.
|
|
47219
|
+
* @throws {RequiredError}
|
|
47220
|
+
* @memberof KDSApi
|
|
47221
|
+
*/
|
|
47222
|
+
public deleteKdsStation(stationId: string, businessId: number, options?: AxiosRequestConfig) {
|
|
47223
|
+
return KDSApiFp(this.configuration).deleteKdsStation(stationId, businessId, options).then((request) => request(this.axios, this.basePath));
|
|
47224
|
+
}
|
|
47225
|
+
|
|
45776
47226
|
/**
|
|
45777
47227
|
* Read from kds-service. The status is passed on as sent: the kitchen screen asks for IN_PROGRESS and READY.
|
|
45778
47228
|
* @summary List one station\'s kitchen orders in one state, a page at a time
|
|
@@ -45842,6 +47292,31 @@ export class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
|
45842
47292
|
public kdsRevertOrder(id: string, options?: AxiosRequestConfig) {
|
|
45843
47293
|
return KDSApiFp(this.configuration).kdsRevertOrder(id, options).then((request) => request(this.axios, this.basePath));
|
|
45844
47294
|
}
|
|
47295
|
+
|
|
47296
|
+
/**
|
|
47297
|
+
* Read from kds-service: the venue\'s active stations, each with the menu categories it shows. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
47298
|
+
* @summary List the venue\'s kitchen stations with their categories
|
|
47299
|
+
* @param {number} businessId The Munchi venue id (orderingBusinessId)
|
|
47300
|
+
* @param {*} [options] Override http request option.
|
|
47301
|
+
* @throws {RequiredError}
|
|
47302
|
+
* @memberof KDSApi
|
|
47303
|
+
*/
|
|
47304
|
+
public listKdsStations(businessId: number, options?: AxiosRequestConfig) {
|
|
47305
|
+
return KDSApiFp(this.configuration).listKdsStations(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
47306
|
+
}
|
|
47307
|
+
|
|
47308
|
+
/**
|
|
47309
|
+
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
47310
|
+
* @summary Rename a kitchen station and replace its categories
|
|
47311
|
+
* @param {string} stationId The station\'s id in kds-service (its KDS profile id)
|
|
47312
|
+
* @param {UpdateKdsStationDto} updateKdsStationDto The venue, and the station\'s new name and categories
|
|
47313
|
+
* @param {*} [options] Override http request option.
|
|
47314
|
+
* @throws {RequiredError}
|
|
47315
|
+
* @memberof KDSApi
|
|
47316
|
+
*/
|
|
47317
|
+
public updateKdsStation(stationId: string, updateKdsStationDto: UpdateKdsStationDto, options?: AxiosRequestConfig) {
|
|
47318
|
+
return KDSApiFp(this.configuration).updateKdsStation(stationId, updateKdsStationDto, options).then((request) => request(this.axios, this.basePath));
|
|
47319
|
+
}
|
|
45845
47320
|
}
|
|
45846
47321
|
|
|
45847
47322
|
|
|
@@ -48426,7 +49901,7 @@ export const OpsApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
48426
49901
|
};
|
|
48427
49902
|
},
|
|
48428
49903
|
/**
|
|
48429
|
-
*
|
|
49904
|
+
* Deletes the venue\'s active rows of the platform. The venue\'s cached providers are cleared after the commit. Uber Eats, Wolt and ResQ are disconnected through their onboarding (DELETE provider/onboarding/{channel}/{businessId}).
|
|
48430
49905
|
* @summary Disconnect a venue from Foodora or Bolt
|
|
48431
49906
|
* @param {number} venueId The Munchi venue id
|
|
48432
49907
|
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
@@ -48547,7 +50022,7 @@ export const OpsApiFp = function(configuration?: Configuration) {
|
|
|
48547
50022
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48548
50023
|
},
|
|
48549
50024
|
/**
|
|
48550
|
-
*
|
|
50025
|
+
* Deletes the venue\'s active rows of the platform. The venue\'s cached providers are cleared after the commit. Uber Eats, Wolt and ResQ are disconnected through their onboarding (DELETE provider/onboarding/{channel}/{businessId}).
|
|
48551
50026
|
* @summary Disconnect a venue from Foodora or Bolt
|
|
48552
50027
|
* @param {number} venueId The Munchi venue id
|
|
48553
50028
|
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
@@ -48602,7 +50077,7 @@ export const OpsApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
48602
50077
|
return localVarFp.devicesOfVenue(venueId, options).then((request) => request(axios, basePath));
|
|
48603
50078
|
},
|
|
48604
50079
|
/**
|
|
48605
|
-
*
|
|
50080
|
+
* Deletes the venue\'s active rows of the platform. The venue\'s cached providers are cleared after the commit. Uber Eats, Wolt and ResQ are disconnected through their onboarding (DELETE provider/onboarding/{channel}/{businessId}).
|
|
48606
50081
|
* @summary Disconnect a venue from Foodora or Bolt
|
|
48607
50082
|
* @param {number} venueId The Munchi venue id
|
|
48608
50083
|
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
@@ -48654,7 +50129,7 @@ export interface OpsApiInterface {
|
|
|
48654
50129
|
devicesOfVenue(venueId: number, options?: AxiosRequestConfig): AxiosPromise<VenueDevicesDto>;
|
|
48655
50130
|
|
|
48656
50131
|
/**
|
|
48657
|
-
*
|
|
50132
|
+
* Deletes the venue\'s active rows of the platform. The venue\'s cached providers are cleared after the commit. Uber Eats, Wolt and ResQ are disconnected through their onboarding (DELETE provider/onboarding/{channel}/{businessId}).
|
|
48658
50133
|
* @summary Disconnect a venue from Foodora or Bolt
|
|
48659
50134
|
* @param {number} venueId The Munchi venue id
|
|
48660
50135
|
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
@@ -48710,7 +50185,7 @@ export class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
|
48710
50185
|
}
|
|
48711
50186
|
|
|
48712
50187
|
/**
|
|
48713
|
-
*
|
|
50188
|
+
* Deletes the venue\'s active rows of the platform. The venue\'s cached providers are cleared after the commit. Uber Eats, Wolt and ResQ are disconnected through their onboarding (DELETE provider/onboarding/{channel}/{businessId}).
|
|
48714
50189
|
* @summary Disconnect a venue from Foodora or Bolt
|
|
48715
50190
|
* @param {number} venueId The Munchi venue id
|
|
48716
50191
|
* @param {DeliveryPlatformOpsConnect} channel Foodora or Bolt
|
|
@@ -52071,7 +53546,7 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
52071
53546
|
};
|
|
52072
53547
|
},
|
|
52073
53548
|
/**
|
|
52074
|
-
* 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.
|
|
52075
53550
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
52076
53551
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52077
53552
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -52157,7 +53632,7 @@ export const PaymentMethodsApiAxiosParamCreator = function (configuration?: Conf
|
|
|
52157
53632
|
};
|
|
52158
53633
|
},
|
|
52159
53634
|
/**
|
|
52160
|
-
* 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.
|
|
52161
53636
|
* @summary List the catalog methods a venue can still add on one channel
|
|
52162
53637
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52163
53638
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -52447,7 +53922,7 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
|
|
|
52447
53922
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
52448
53923
|
},
|
|
52449
53924
|
/**
|
|
52450
|
-
* 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.
|
|
52451
53926
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
52452
53927
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52453
53928
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -52473,7 +53948,7 @@ export const PaymentMethodsApiFp = function(configuration?: Configuration) {
|
|
|
52473
53948
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
52474
53949
|
},
|
|
52475
53950
|
/**
|
|
52476
|
-
* 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.
|
|
52477
53952
|
* @summary List the catalog methods a venue can still add on one channel
|
|
52478
53953
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52479
53954
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -52585,7 +54060,7 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
|
|
|
52585
54060
|
return localVarFp.changePaymentMethodOption(businessId, channel, id, changePaymentMethodOptionDto, options).then((request) => request(axios, basePath));
|
|
52586
54061
|
},
|
|
52587
54062
|
/**
|
|
52588
|
-
* 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.
|
|
52589
54064
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
52590
54065
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52591
54066
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -52609,7 +54084,7 @@ export const PaymentMethodsApiFactory = function (configuration?: Configuration,
|
|
|
52609
54084
|
return localVarFp.deletePaymentMethodOption(businessId, channel, id, options).then((request) => request(axios, basePath));
|
|
52610
54085
|
},
|
|
52611
54086
|
/**
|
|
52612
|
-
* 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.
|
|
52613
54088
|
* @summary List the catalog methods a venue can still add on one channel
|
|
52614
54089
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52615
54090
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -52714,7 +54189,7 @@ export interface PaymentMethodsApiInterface {
|
|
|
52714
54189
|
changePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
52715
54190
|
|
|
52716
54191
|
/**
|
|
52717
|
-
* 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.
|
|
52718
54193
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
52719
54194
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52720
54195
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -52738,7 +54213,7 @@ export interface PaymentMethodsApiInterface {
|
|
|
52738
54213
|
deletePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
52739
54214
|
|
|
52740
54215
|
/**
|
|
52741
|
-
* 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.
|
|
52742
54217
|
* @summary List the catalog methods a venue can still add on one channel
|
|
52743
54218
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52744
54219
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -52847,7 +54322,7 @@ export class PaymentMethodsApi extends BaseAPI implements PaymentMethodsApiInter
|
|
|
52847
54322
|
}
|
|
52848
54323
|
|
|
52849
54324
|
/**
|
|
52850
|
-
* 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.
|
|
52851
54326
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
52852
54327
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52853
54328
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -52875,7 +54350,7 @@ export class PaymentMethodsApi extends BaseAPI implements PaymentMethodsApiInter
|
|
|
52875
54350
|
}
|
|
52876
54351
|
|
|
52877
54352
|
/**
|
|
52878
|
-
* 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.
|
|
52879
54354
|
* @summary List the catalog methods a venue can still add on one channel
|
|
52880
54355
|
* @param {number} businessId The venue\'s ordering business id.
|
|
52881
54356
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -56013,6 +57488,50 @@ export const ProviderApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
56013
57488
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
56014
57489
|
localVarRequestOptions.data = serializeDataIfNeeded(updateProviderSettingsDto, localVarRequestOptions, configuration)
|
|
56015
57490
|
|
|
57491
|
+
return {
|
|
57492
|
+
url: toPathString(localVarUrlObj),
|
|
57493
|
+
options: localVarRequestOptions,
|
|
57494
|
+
};
|
|
57495
|
+
},
|
|
57496
|
+
/**
|
|
57497
|
+
* Each entry changes one channel: only the fields it sends. Every row of the venue on the channel changes, active or not, except that isActive true on Wolt, WoltStorefront, UberEats, Foodora, Bolt or ResQ turns on only the channel\'s newest row; none is deleted. MunchiPos, MunchiKiosk and Storefront get a row when the venue has none (open, active, integrations ORDERS, VENUE and MENU, then the entry\'s changes). Wolt, WoltStorefront, UberEats, Foodora, Bolt and ResQ change only a row their own connection added. Whether a channel is open is not changed here. Every change commits together, or none does; the venue\'s cached providers are cleared after the commit.
|
|
57498
|
+
* @summary Turn a venue\'s channels on or off, and change their auto-accept and integrations
|
|
57499
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57500
|
+
* @param {UpdateVenueProvidersDto} updateVenueProvidersDto
|
|
57501
|
+
* @param {*} [options] Override http request option.
|
|
57502
|
+
* @throws {RequiredError}
|
|
57503
|
+
*/
|
|
57504
|
+
updateVenueProviders: async (businessId: number, updateVenueProvidersDto: UpdateVenueProvidersDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57505
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
57506
|
+
assertParamExists('updateVenueProviders', 'businessId', businessId)
|
|
57507
|
+
// verify required parameter 'updateVenueProvidersDto' is not null or undefined
|
|
57508
|
+
assertParamExists('updateVenueProviders', 'updateVenueProvidersDto', updateVenueProvidersDto)
|
|
57509
|
+
const localVarPath = `/api/v2/venues/{businessId}/providers`
|
|
57510
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
57511
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57512
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57513
|
+
let baseOptions;
|
|
57514
|
+
if (configuration) {
|
|
57515
|
+
baseOptions = configuration.baseOptions;
|
|
57516
|
+
}
|
|
57517
|
+
|
|
57518
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
57519
|
+
const localVarHeaderParameter = {} as any;
|
|
57520
|
+
const localVarQueryParameter = {} as any;
|
|
57521
|
+
|
|
57522
|
+
// authentication JWT-auth required
|
|
57523
|
+
// http bearer authentication required
|
|
57524
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
57525
|
+
|
|
57526
|
+
|
|
57527
|
+
|
|
57528
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
57529
|
+
|
|
57530
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57531
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57532
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57533
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateVenueProvidersDto, localVarRequestOptions, configuration)
|
|
57534
|
+
|
|
56016
57535
|
return {
|
|
56017
57536
|
url: toPathString(localVarUrlObj),
|
|
56018
57537
|
options: localVarRequestOptions,
|
|
@@ -56112,6 +57631,18 @@ export const ProviderApiFp = function(configuration?: Configuration) {
|
|
|
56112
57631
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateProviderSettings(businessId, updateProviderSettingsDto, options);
|
|
56113
57632
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
56114
57633
|
},
|
|
57634
|
+
/**
|
|
57635
|
+
* Each entry changes one channel: only the fields it sends. Every row of the venue on the channel changes, active or not, except that isActive true on Wolt, WoltStorefront, UberEats, Foodora, Bolt or ResQ turns on only the channel\'s newest row; none is deleted. MunchiPos, MunchiKiosk and Storefront get a row when the venue has none (open, active, integrations ORDERS, VENUE and MENU, then the entry\'s changes). Wolt, WoltStorefront, UberEats, Foodora, Bolt and ResQ change only a row their own connection added. Whether a channel is open is not changed here. Every change commits together, or none does; the venue\'s cached providers are cleared after the commit.
|
|
57636
|
+
* @summary Turn a venue\'s channels on or off, and change their auto-accept and integrations
|
|
57637
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57638
|
+
* @param {UpdateVenueProvidersDto} updateVenueProvidersDto
|
|
57639
|
+
* @param {*} [options] Override http request option.
|
|
57640
|
+
* @throws {RequiredError}
|
|
57641
|
+
*/
|
|
57642
|
+
async updateVenueProviders(businessId: number, updateVenueProvidersDto: UpdateVenueProvidersDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatedVenueProvidersDto>> {
|
|
57643
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateVenueProviders(businessId, updateVenueProvidersDto, options);
|
|
57644
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57645
|
+
},
|
|
56115
57646
|
}
|
|
56116
57647
|
};
|
|
56117
57648
|
|
|
@@ -56199,6 +57730,17 @@ export const ProviderApiFactory = function (configuration?: Configuration, baseP
|
|
|
56199
57730
|
updateProviderSettings(businessId: number, updateProviderSettingsDto: UpdateProviderSettingsDto, options?: any): AxiosPromise<UpdateProviderSettingsDto> {
|
|
56200
57731
|
return localVarFp.updateProviderSettings(businessId, updateProviderSettingsDto, options).then((request) => request(axios, basePath));
|
|
56201
57732
|
},
|
|
57733
|
+
/**
|
|
57734
|
+
* Each entry changes one channel: only the fields it sends. Every row of the venue on the channel changes, active or not, except that isActive true on Wolt, WoltStorefront, UberEats, Foodora, Bolt or ResQ turns on only the channel\'s newest row; none is deleted. MunchiPos, MunchiKiosk and Storefront get a row when the venue has none (open, active, integrations ORDERS, VENUE and MENU, then the entry\'s changes). Wolt, WoltStorefront, UberEats, Foodora, Bolt and ResQ change only a row their own connection added. Whether a channel is open is not changed here. Every change commits together, or none does; the venue\'s cached providers are cleared after the commit.
|
|
57735
|
+
* @summary Turn a venue\'s channels on or off, and change their auto-accept and integrations
|
|
57736
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57737
|
+
* @param {UpdateVenueProvidersDto} updateVenueProvidersDto
|
|
57738
|
+
* @param {*} [options] Override http request option.
|
|
57739
|
+
* @throws {RequiredError}
|
|
57740
|
+
*/
|
|
57741
|
+
updateVenueProviders(businessId: number, updateVenueProvidersDto: UpdateVenueProvidersDto, options?: any): AxiosPromise<UpdatedVenueProvidersDto> {
|
|
57742
|
+
return localVarFp.updateVenueProviders(businessId, updateVenueProvidersDto, options).then((request) => request(axios, basePath));
|
|
57743
|
+
},
|
|
56202
57744
|
};
|
|
56203
57745
|
};
|
|
56204
57746
|
|
|
@@ -56285,6 +57827,17 @@ export interface ProviderApiInterface {
|
|
|
56285
57827
|
*/
|
|
56286
57828
|
updateProviderSettings(businessId: number, updateProviderSettingsDto: UpdateProviderSettingsDto, options?: AxiosRequestConfig): AxiosPromise<UpdateProviderSettingsDto>;
|
|
56287
57829
|
|
|
57830
|
+
/**
|
|
57831
|
+
* Each entry changes one channel: only the fields it sends. Every row of the venue on the channel changes, active or not, except that isActive true on Wolt, WoltStorefront, UberEats, Foodora, Bolt or ResQ turns on only the channel\'s newest row; none is deleted. MunchiPos, MunchiKiosk and Storefront get a row when the venue has none (open, active, integrations ORDERS, VENUE and MENU, then the entry\'s changes). Wolt, WoltStorefront, UberEats, Foodora, Bolt and ResQ change only a row their own connection added. Whether a channel is open is not changed here. Every change commits together, or none does; the venue\'s cached providers are cleared after the commit.
|
|
57832
|
+
* @summary Turn a venue\'s channels on or off, and change their auto-accept and integrations
|
|
57833
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57834
|
+
* @param {UpdateVenueProvidersDto} updateVenueProvidersDto
|
|
57835
|
+
* @param {*} [options] Override http request option.
|
|
57836
|
+
* @throws {RequiredError}
|
|
57837
|
+
* @memberof ProviderApiInterface
|
|
57838
|
+
*/
|
|
57839
|
+
updateVenueProviders(businessId: number, updateVenueProvidersDto: UpdateVenueProvidersDto, options?: AxiosRequestConfig): AxiosPromise<UpdatedVenueProvidersDto>;
|
|
57840
|
+
|
|
56288
57841
|
}
|
|
56289
57842
|
|
|
56290
57843
|
/**
|
|
@@ -56384,6 +57937,19 @@ export class ProviderApi extends BaseAPI implements ProviderApiInterface {
|
|
|
56384
57937
|
public updateProviderSettings(businessId: number, updateProviderSettingsDto: UpdateProviderSettingsDto, options?: AxiosRequestConfig) {
|
|
56385
57938
|
return ProviderApiFp(this.configuration).updateProviderSettings(businessId, updateProviderSettingsDto, options).then((request) => request(this.axios, this.basePath));
|
|
56386
57939
|
}
|
|
57940
|
+
|
|
57941
|
+
/**
|
|
57942
|
+
* Each entry changes one channel: only the fields it sends. Every row of the venue on the channel changes, active or not, except that isActive true on Wolt, WoltStorefront, UberEats, Foodora, Bolt or ResQ turns on only the channel\'s newest row; none is deleted. MunchiPos, MunchiKiosk and Storefront get a row when the venue has none (open, active, integrations ORDERS, VENUE and MENU, then the entry\'s changes). Wolt, WoltStorefront, UberEats, Foodora, Bolt and ResQ change only a row their own connection added. Whether a channel is open is not changed here. Every change commits together, or none does; the venue\'s cached providers are cleared after the commit.
|
|
57943
|
+
* @summary Turn a venue\'s channels on or off, and change their auto-accept and integrations
|
|
57944
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57945
|
+
* @param {UpdateVenueProvidersDto} updateVenueProvidersDto
|
|
57946
|
+
* @param {*} [options] Override http request option.
|
|
57947
|
+
* @throws {RequiredError}
|
|
57948
|
+
* @memberof ProviderApi
|
|
57949
|
+
*/
|
|
57950
|
+
public updateVenueProviders(businessId: number, updateVenueProvidersDto: UpdateVenueProvidersDto, options?: AxiosRequestConfig) {
|
|
57951
|
+
return ProviderApiFp(this.configuration).updateVenueProviders(businessId, updateVenueProvidersDto, options).then((request) => request(this.axios, this.basePath));
|
|
57952
|
+
}
|
|
56387
57953
|
}
|
|
56388
57954
|
|
|
56389
57955
|
|
|
@@ -58157,6 +59723,600 @@ export class ReportV6Api extends BaseAPI implements ReportV6ApiInterface {
|
|
|
58157
59723
|
}
|
|
58158
59724
|
|
|
58159
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
|
+
|
|
58160
60320
|
/**
|
|
58161
60321
|
* ReservationsApi - axios parameter creator
|
|
58162
60322
|
* @export
|