@munchi_oy/core 2.0.7 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/api.d.ts +1614 -50
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +2285 -146
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -421,6 +421,50 @@ export interface AmountDto {
|
|
|
421
421
|
*/
|
|
422
422
|
'currency': string;
|
|
423
423
|
}
|
|
424
|
+
/**
|
|
425
|
+
*
|
|
426
|
+
* @export
|
|
427
|
+
* @interface AutomaticPromotionDto
|
|
428
|
+
*/
|
|
429
|
+
export interface AutomaticPromotionDto {
|
|
430
|
+
/**
|
|
431
|
+
* The Vendure promotion\'s id
|
|
432
|
+
* @type {number}
|
|
433
|
+
* @memberof AutomaticPromotionDto
|
|
434
|
+
*/
|
|
435
|
+
'id': number;
|
|
436
|
+
/**
|
|
437
|
+
* The promotion\'s name
|
|
438
|
+
* @type {string}
|
|
439
|
+
* @memberof AutomaticPromotionDto
|
|
440
|
+
*/
|
|
441
|
+
'name': string;
|
|
442
|
+
/**
|
|
443
|
+
* When the promotion starts, an ISO date-time; null when it has no start
|
|
444
|
+
* @type {string}
|
|
445
|
+
* @memberof AutomaticPromotionDto
|
|
446
|
+
*/
|
|
447
|
+
'startsAt': string | null;
|
|
448
|
+
/**
|
|
449
|
+
* When the promotion ends, an ISO date-time; null when it has no end
|
|
450
|
+
* @type {string}
|
|
451
|
+
* @memberof AutomaticPromotionDto
|
|
452
|
+
*/
|
|
453
|
+
'endsAt': string | null;
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
*
|
|
457
|
+
* @export
|
|
458
|
+
* @interface AutomaticPromotionsAnswerDto
|
|
459
|
+
*/
|
|
460
|
+
export interface AutomaticPromotionsAnswerDto {
|
|
461
|
+
/**
|
|
462
|
+
* The venue\'s automatic promotions in the caller\'s app that are running now, judged at the moment of the read. Empty: no promotion applies by itself, so the app need not ask for the basket\'s price unless it holds a coupon code. Read again when the venue\'s DISCOUNTS sync arrives
|
|
463
|
+
* @type {Array<AutomaticPromotionDto>}
|
|
464
|
+
* @memberof AutomaticPromotionsAnswerDto
|
|
465
|
+
*/
|
|
466
|
+
'automaticPromotions': Array<AutomaticPromotionDto>;
|
|
467
|
+
}
|
|
424
468
|
/**
|
|
425
469
|
*
|
|
426
470
|
* @export
|
|
@@ -462,6 +506,15 @@ export interface AvailablePaymentMethodDto {
|
|
|
462
506
|
*/
|
|
463
507
|
'requiresCredentials': boolean;
|
|
464
508
|
}
|
|
509
|
+
/**
|
|
510
|
+
*
|
|
511
|
+
* @export
|
|
512
|
+
* @enum {string}
|
|
513
|
+
*/
|
|
514
|
+
export declare const BasketNotPricedReason: {
|
|
515
|
+
readonly Unavailable: "UNAVAILABLE";
|
|
516
|
+
};
|
|
517
|
+
export type BasketNotPricedReason = typeof BasketNotPricedReason[keyof typeof BasketNotPricedReason];
|
|
465
518
|
/**
|
|
466
519
|
*
|
|
467
520
|
* @export
|
|
@@ -2443,6 +2496,55 @@ export interface ChangePosOrdersStatusInBulkResponseDto {
|
|
|
2443
2496
|
*/
|
|
2444
2497
|
'skipped': Array<PosOrderLeftAsItIsDto>;
|
|
2445
2498
|
}
|
|
2499
|
+
/**
|
|
2500
|
+
*
|
|
2501
|
+
* @export
|
|
2502
|
+
* @interface ChangeResQOfferDto
|
|
2503
|
+
*/
|
|
2504
|
+
export interface ChangeResQOfferDto {
|
|
2505
|
+
/**
|
|
2506
|
+
* The offer\'s new name. Left out, the name stays
|
|
2507
|
+
* @type {string}
|
|
2508
|
+
* @memberof ChangeResQOfferDto
|
|
2509
|
+
*/
|
|
2510
|
+
'name'?: string;
|
|
2511
|
+
/**
|
|
2512
|
+
* The offer\'s new description. Left out, the description stays
|
|
2513
|
+
* @type {string}
|
|
2514
|
+
* @memberof ChangeResQOfferDto
|
|
2515
|
+
*/
|
|
2516
|
+
'description'?: string;
|
|
2517
|
+
/**
|
|
2518
|
+
* How many are for sale from now on. Left out, the quantity stays
|
|
2519
|
+
* @type {number}
|
|
2520
|
+
* @memberof ChangeResQOfferDto
|
|
2521
|
+
*/
|
|
2522
|
+
'quantity'?: number;
|
|
2523
|
+
/**
|
|
2524
|
+
* When ordering starts, an ISO 8601 date-time. Left out, it stays
|
|
2525
|
+
* @type {string}
|
|
2526
|
+
* @memberof ChangeResQOfferDto
|
|
2527
|
+
*/
|
|
2528
|
+
'orderStart'?: string;
|
|
2529
|
+
/**
|
|
2530
|
+
* When ordering ends, an ISO 8601 date-time. Left out, it stays
|
|
2531
|
+
* @type {string}
|
|
2532
|
+
* @memberof ChangeResQOfferDto
|
|
2533
|
+
*/
|
|
2534
|
+
'orderEnd'?: string;
|
|
2535
|
+
/**
|
|
2536
|
+
* When pick-up starts, an ISO 8601 date-time. Left out, it stays
|
|
2537
|
+
* @type {string}
|
|
2538
|
+
* @memberof ChangeResQOfferDto
|
|
2539
|
+
*/
|
|
2540
|
+
'fetchStart'?: string;
|
|
2541
|
+
/**
|
|
2542
|
+
* When pick-up ends, an ISO 8601 date-time. Left out, it stays
|
|
2543
|
+
* @type {string}
|
|
2544
|
+
* @memberof ChangeResQOfferDto
|
|
2545
|
+
*/
|
|
2546
|
+
'fetchEnd'?: string;
|
|
2547
|
+
}
|
|
2446
2548
|
/**
|
|
2447
2549
|
*
|
|
2448
2550
|
* @export
|
|
@@ -2712,6 +2814,37 @@ export interface CheckActionPasscodeDto {
|
|
|
2712
2814
|
*/
|
|
2713
2815
|
'key': PosPermission;
|
|
2714
2816
|
}
|
|
2817
|
+
/**
|
|
2818
|
+
*
|
|
2819
|
+
* @export
|
|
2820
|
+
* @interface CheckCouponDto
|
|
2821
|
+
*/
|
|
2822
|
+
export interface CheckCouponDto {
|
|
2823
|
+
/**
|
|
2824
|
+
* The coupon\'s code, as typed or scanned, in any letter case
|
|
2825
|
+
* @type {string}
|
|
2826
|
+
* @memberof CheckCouponDto
|
|
2827
|
+
*/
|
|
2828
|
+
'couponCode': string;
|
|
2829
|
+
/**
|
|
2830
|
+
*
|
|
2831
|
+
* @type {OrderTypePOS}
|
|
2832
|
+
* @memberof CheckCouponDto
|
|
2833
|
+
*/
|
|
2834
|
+
'orderType': OrderTypePOS;
|
|
2835
|
+
/**
|
|
2836
|
+
* 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.
|
|
2837
|
+
* @type {string}
|
|
2838
|
+
* @memberof CheckCouponDto
|
|
2839
|
+
*/
|
|
2840
|
+
'customerPhone'?: string;
|
|
2841
|
+
/**
|
|
2842
|
+
* The order\'s lines as they stand; checked again whenever the basket changes
|
|
2843
|
+
* @type {Array<CouponBasketLineDto>}
|
|
2844
|
+
* @memberof CheckCouponDto
|
|
2845
|
+
*/
|
|
2846
|
+
'lines': Array<CouponBasketLineDto>;
|
|
2847
|
+
}
|
|
2715
2848
|
/**
|
|
2716
2849
|
*
|
|
2717
2850
|
* @export
|
|
@@ -3260,6 +3393,186 @@ export interface CoordinateDto {
|
|
|
3260
3393
|
*/
|
|
3261
3394
|
'lon': number;
|
|
3262
3395
|
}
|
|
3396
|
+
/**
|
|
3397
|
+
*
|
|
3398
|
+
* @export
|
|
3399
|
+
* @interface CouponBasketLineDto
|
|
3400
|
+
*/
|
|
3401
|
+
export interface CouponBasketLineDto {
|
|
3402
|
+
/**
|
|
3403
|
+
* The line\'s stable id, the one the order\'s discounts point at
|
|
3404
|
+
* @type {string}
|
|
3405
|
+
* @memberof CouponBasketLineDto
|
|
3406
|
+
*/
|
|
3407
|
+
'lineItemId': string;
|
|
3408
|
+
/**
|
|
3409
|
+
* The product\'s Vendure id: the line\'s posId, as a number
|
|
3410
|
+
* @type {number}
|
|
3411
|
+
* @memberof CouponBasketLineDto
|
|
3412
|
+
*/
|
|
3413
|
+
'productId': number;
|
|
3414
|
+
/**
|
|
3415
|
+
* How many of the product the line holds, a whole number
|
|
3416
|
+
* @type {number}
|
|
3417
|
+
* @memberof CouponBasketLineDto
|
|
3418
|
+
*/
|
|
3419
|
+
'quantity': number;
|
|
3420
|
+
/**
|
|
3421
|
+
* The price of one unit as the till charges it, options included, in cents
|
|
3422
|
+
* @type {number}
|
|
3423
|
+
* @memberof CouponBasketLineDto
|
|
3424
|
+
*/
|
|
3425
|
+
'unitAmount': number;
|
|
3426
|
+
/**
|
|
3427
|
+
* 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
|
|
3428
|
+
* @type {number}
|
|
3429
|
+
* @memberof CouponBasketLineDto
|
|
3430
|
+
*/
|
|
3431
|
+
'vatRate'?: number;
|
|
3432
|
+
}
|
|
3433
|
+
/**
|
|
3434
|
+
*
|
|
3435
|
+
* @export
|
|
3436
|
+
* @interface CouponCheckAnswerDto
|
|
3437
|
+
*/
|
|
3438
|
+
export interface CouponCheckAnswerDto {
|
|
3439
|
+
/**
|
|
3440
|
+
* true when the coupon applies to this basket; false when it does not
|
|
3441
|
+
* @type {boolean}
|
|
3442
|
+
* @memberof CouponCheckAnswerDto
|
|
3443
|
+
*/
|
|
3444
|
+
'valid': boolean;
|
|
3445
|
+
/**
|
|
3446
|
+
* The discounts to add to the order, one per application; empty when valid is false
|
|
3447
|
+
* @type {Array<CouponDiscountDto>}
|
|
3448
|
+
* @memberof CouponCheckAnswerDto
|
|
3449
|
+
*/
|
|
3450
|
+
'discounts': Array<CouponDiscountDto>;
|
|
3451
|
+
/**
|
|
3452
|
+
* 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
|
|
3453
|
+
* @type {Array<CouponRewardNotAppliedDto>}
|
|
3454
|
+
* @memberof CouponCheckAnswerDto
|
|
3455
|
+
*/
|
|
3456
|
+
'notApplied': Array<CouponRewardNotAppliedDto>;
|
|
3457
|
+
/**
|
|
3458
|
+
*
|
|
3459
|
+
* @type {CouponRefusal}
|
|
3460
|
+
* @memberof CouponCheckAnswerDto
|
|
3461
|
+
*/
|
|
3462
|
+
'reason': CouponRefusal | null;
|
|
3463
|
+
/**
|
|
3464
|
+
* What to tell the person at the till or the kiosk; null when valid is true
|
|
3465
|
+
* @type {string}
|
|
3466
|
+
* @memberof CouponCheckAnswerDto
|
|
3467
|
+
*/
|
|
3468
|
+
'message': string | null;
|
|
3469
|
+
}
|
|
3470
|
+
/**
|
|
3471
|
+
*
|
|
3472
|
+
* @export
|
|
3473
|
+
* @interface CouponDiscountDto
|
|
3474
|
+
*/
|
|
3475
|
+
export interface CouponDiscountDto {
|
|
3476
|
+
/**
|
|
3477
|
+
*
|
|
3478
|
+
* @type {DiscountType}
|
|
3479
|
+
* @memberof CouponDiscountDto
|
|
3480
|
+
*/
|
|
3481
|
+
'type': DiscountType;
|
|
3482
|
+
/**
|
|
3483
|
+
* A percentage for PERCENTAGE (10 is 10%), cents for FIXED
|
|
3484
|
+
* @type {number}
|
|
3485
|
+
* @memberof CouponDiscountDto
|
|
3486
|
+
*/
|
|
3487
|
+
'value': number;
|
|
3488
|
+
/**
|
|
3489
|
+
*
|
|
3490
|
+
* @type {DiscountScope}
|
|
3491
|
+
* @memberof CouponDiscountDto
|
|
3492
|
+
*/
|
|
3493
|
+
'scope': DiscountScope;
|
|
3494
|
+
/**
|
|
3495
|
+
* The line it discounts, for an ITEM discount; null for a CART discount
|
|
3496
|
+
* @type {string}
|
|
3497
|
+
* @memberof CouponDiscountDto
|
|
3498
|
+
*/
|
|
3499
|
+
'lineItemId': string | null;
|
|
3500
|
+
/**
|
|
3501
|
+
* How many units of the line it covers; absent means the whole line
|
|
3502
|
+
* @type {number}
|
|
3503
|
+
* @memberof CouponDiscountDto
|
|
3504
|
+
*/
|
|
3505
|
+
'units'?: number;
|
|
3506
|
+
/**
|
|
3507
|
+
*
|
|
3508
|
+
* @type {DiscountSourceType}
|
|
3509
|
+
* @memberof CouponDiscountDto
|
|
3510
|
+
*/
|
|
3511
|
+
'sourceType': DiscountSourceType;
|
|
3512
|
+
/**
|
|
3513
|
+
* The Vendure promotion\'s id, as text
|
|
3514
|
+
* @type {string}
|
|
3515
|
+
* @memberof CouponDiscountDto
|
|
3516
|
+
*/
|
|
3517
|
+
'sourceId': string;
|
|
3518
|
+
/**
|
|
3519
|
+
* The coupon\'s code, as the promotion holds it
|
|
3520
|
+
* @type {string}
|
|
3521
|
+
* @memberof CouponDiscountDto
|
|
3522
|
+
*/
|
|
3523
|
+
'couponCode': string;
|
|
3524
|
+
/**
|
|
3525
|
+
* The promotion\'s name, shown on the till and the receipt
|
|
3526
|
+
* @type {string}
|
|
3527
|
+
* @memberof CouponDiscountDto
|
|
3528
|
+
*/
|
|
3529
|
+
'name': string;
|
|
3530
|
+
/**
|
|
3531
|
+
* 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
|
|
3532
|
+
* @type {string}
|
|
3533
|
+
* @memberof CouponDiscountDto
|
|
3534
|
+
*/
|
|
3535
|
+
'couponCustomerPhone'?: string;
|
|
3536
|
+
}
|
|
3537
|
+
/**
|
|
3538
|
+
*
|
|
3539
|
+
* @export
|
|
3540
|
+
* @enum {string}
|
|
3541
|
+
*/
|
|
3542
|
+
export declare const CouponRefusal: {
|
|
3543
|
+
readonly NotFound: "NOT_FOUND";
|
|
3544
|
+
readonly NotStarted: "NOT_STARTED";
|
|
3545
|
+
readonly Expired: "EXPIRED";
|
|
3546
|
+
readonly Disabled: "DISABLED";
|
|
3547
|
+
readonly NotForThisApp: "NOT_FOR_THIS_APP";
|
|
3548
|
+
readonly NotForThisOrderType: "NOT_FOR_THIS_ORDER_TYPE";
|
|
3549
|
+
readonly ConditionsNotMet: "CONDITIONS_NOT_MET";
|
|
3550
|
+
readonly UsageLimitReached: "USAGE_LIMIT_REACHED";
|
|
3551
|
+
readonly CustomerLimitReached: "CUSTOMER_LIMIT_REACHED";
|
|
3552
|
+
readonly NotFirstOrder: "NOT_FIRST_ORDER";
|
|
3553
|
+
readonly CustomerPhoneRequired: "CUSTOMER_PHONE_REQUIRED";
|
|
3554
|
+
readonly CouponsUnavailable: "COUPONS_UNAVAILABLE";
|
|
3555
|
+
};
|
|
3556
|
+
export type CouponRefusal = typeof CouponRefusal[keyof typeof CouponRefusal];
|
|
3557
|
+
/**
|
|
3558
|
+
*
|
|
3559
|
+
* @export
|
|
3560
|
+
* @interface CouponRewardNotAppliedDto
|
|
3561
|
+
*/
|
|
3562
|
+
export interface CouponRewardNotAppliedDto {
|
|
3563
|
+
/**
|
|
3564
|
+
* The promotion\'s reward that was left out, in Vendure\'s words
|
|
3565
|
+
* @type {string}
|
|
3566
|
+
* @memberof CouponRewardNotAppliedDto
|
|
3567
|
+
*/
|
|
3568
|
+
'reward': string;
|
|
3569
|
+
/**
|
|
3570
|
+
* Why Vendure left it out
|
|
3571
|
+
* @type {string}
|
|
3572
|
+
* @memberof CouponRewardNotAppliedDto
|
|
3573
|
+
*/
|
|
3574
|
+
'reason': string;
|
|
3575
|
+
}
|
|
3263
3576
|
/**
|
|
3264
3577
|
*
|
|
3265
3578
|
* @export
|
|
@@ -4153,13 +4466,13 @@ export interface CreateOnboardingSessionDto {
|
|
|
4153
4466
|
*/
|
|
4154
4467
|
export interface CreatePaymentMethodDto {
|
|
4155
4468
|
/**
|
|
4156
|
-
* Attach
|
|
4469
|
+
* Attach a built-in method, or one of the venue\'s own custom methods, by its code (mutually exclusive with name+type).
|
|
4157
4470
|
* @type {string}
|
|
4158
4471
|
* @memberof CreatePaymentMethodDto
|
|
4159
4472
|
*/
|
|
4160
4473
|
'code'?: string;
|
|
4161
4474
|
/**
|
|
4162
|
-
* Display name for a new custom method; required with type when code is absent.
|
|
4475
|
+
* Display name for a new custom method of this venue only; required with type when code is absent.
|
|
4163
4476
|
* @type {string}
|
|
4164
4477
|
* @memberof CreatePaymentMethodDto
|
|
4165
4478
|
*/
|
|
@@ -4306,6 +4619,73 @@ export interface CreateRefundPlanDto {
|
|
|
4306
4619
|
*/
|
|
4307
4620
|
'lineItems'?: Array<RefundRequestItemDto>;
|
|
4308
4621
|
}
|
|
4622
|
+
/**
|
|
4623
|
+
*
|
|
4624
|
+
* @export
|
|
4625
|
+
* @interface CreateResQOfferDto
|
|
4626
|
+
*/
|
|
4627
|
+
export interface CreateResQOfferDto {
|
|
4628
|
+
/**
|
|
4629
|
+
* The offer\'s name, as ResQ\'s customers see it
|
|
4630
|
+
* @type {string}
|
|
4631
|
+
* @memberof CreateResQOfferDto
|
|
4632
|
+
*/
|
|
4633
|
+
'name': string;
|
|
4634
|
+
/**
|
|
4635
|
+
* What the offer holds, as ResQ\'s customers see it. Left out, the offer has none
|
|
4636
|
+
* @type {string}
|
|
4637
|
+
* @memberof CreateResQOfferDto
|
|
4638
|
+
*/
|
|
4639
|
+
'description'?: string;
|
|
4640
|
+
/**
|
|
4641
|
+
* An https address of the offer\'s picture. Left out, ResQ shows none
|
|
4642
|
+
* @type {string}
|
|
4643
|
+
* @memberof CreateResQOfferDto
|
|
4644
|
+
*/
|
|
4645
|
+
'imageUrl'?: string;
|
|
4646
|
+
/**
|
|
4647
|
+
* 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
|
|
4648
|
+
* @type {number}
|
|
4649
|
+
* @memberof CreateResQOfferDto
|
|
4650
|
+
*/
|
|
4651
|
+
'price': number;
|
|
4652
|
+
/**
|
|
4653
|
+
* How many are for sale
|
|
4654
|
+
* @type {number}
|
|
4655
|
+
* @memberof CreateResQOfferDto
|
|
4656
|
+
*/
|
|
4657
|
+
'quantity': number;
|
|
4658
|
+
/**
|
|
4659
|
+
* When customers can start ordering it, an ISO 8601 date-time
|
|
4660
|
+
* @type {string}
|
|
4661
|
+
* @memberof CreateResQOfferDto
|
|
4662
|
+
*/
|
|
4663
|
+
'orderStart': string;
|
|
4664
|
+
/**
|
|
4665
|
+
* When ordering it ends, an ISO 8601 date-time
|
|
4666
|
+
* @type {string}
|
|
4667
|
+
* @memberof CreateResQOfferDto
|
|
4668
|
+
*/
|
|
4669
|
+
'orderEnd': string;
|
|
4670
|
+
/**
|
|
4671
|
+
* When customers can start picking it up at the venue, an ISO 8601 date-time
|
|
4672
|
+
* @type {string}
|
|
4673
|
+
* @memberof CreateResQOfferDto
|
|
4674
|
+
*/
|
|
4675
|
+
'fetchStart': string;
|
|
4676
|
+
/**
|
|
4677
|
+
* When pick-up ends, an ISO 8601 date-time
|
|
4678
|
+
* @type {string}
|
|
4679
|
+
* @memberof CreateResQOfferDto
|
|
4680
|
+
*/
|
|
4681
|
+
'fetchEnd': string;
|
|
4682
|
+
/**
|
|
4683
|
+
* The kinds of offer ResQ files it under, at least one
|
|
4684
|
+
* @type {Array<ResQOfferTag>}
|
|
4685
|
+
* @memberof CreateResQOfferDto
|
|
4686
|
+
*/
|
|
4687
|
+
'tags': Array<ResQOfferTag>;
|
|
4688
|
+
}
|
|
4309
4689
|
/**
|
|
4310
4690
|
*
|
|
4311
4691
|
* @export
|
|
@@ -5726,7 +6106,7 @@ export interface DiscountDto {
|
|
|
5726
6106
|
*/
|
|
5727
6107
|
'updatedAt': string;
|
|
5728
6108
|
/**
|
|
5729
|
-
* The discount\'s id
|
|
6109
|
+
* The id the till knows the button by: the data-bridge discount\'s id for a button copied from data-bridge, 1,000,000,000 plus the Vendure promotion\'s id for any other button (one made or duplicated in Vendure), so the two never share an id
|
|
5730
6110
|
* @type {number}
|
|
5731
6111
|
* @memberof DiscountDto
|
|
5732
6112
|
*/
|
|
@@ -5756,13 +6136,13 @@ export interface DiscountDto {
|
|
|
5756
6136
|
*/
|
|
5757
6137
|
'type'?: PromotionDiscountType;
|
|
5758
6138
|
/**
|
|
5759
|
-
* The discount\'s description;
|
|
6139
|
+
* The discount\'s description; an empty string when it has none
|
|
5760
6140
|
* @type {string}
|
|
5761
6141
|
* @memberof DiscountDto
|
|
5762
6142
|
*/
|
|
5763
6143
|
'description'?: string;
|
|
5764
6144
|
/**
|
|
5765
|
-
* Whether the discount is
|
|
6145
|
+
* Whether the discount is switched on; always true, since a switched-off one is not answered
|
|
5766
6146
|
* @type {boolean}
|
|
5767
6147
|
* @memberof DiscountDto
|
|
5768
6148
|
*/
|
|
@@ -5786,7 +6166,7 @@ export interface DiscountDto {
|
|
|
5786
6166
|
*/
|
|
5787
6167
|
'maxUsesPerOrder'?: number | null;
|
|
5788
6168
|
/**
|
|
5789
|
-
*
|
|
6169
|
+
* The Vendure promotion\'s buttonOrder, which a button copied from data-bridge took from the discount\'s priority; 1 when it has none
|
|
5790
6170
|
* @type {number}
|
|
5791
6171
|
* @memberof DiscountDto
|
|
5792
6172
|
*/
|
|
@@ -5990,7 +6370,7 @@ export interface DispatchPosOrderResponseDto {
|
|
|
5990
6370
|
*/
|
|
5991
6371
|
'ticketId': object | null;
|
|
5992
6372
|
/**
|
|
5993
|
-
* Number of that ticket:
|
|
6373
|
+
* Number of that ticket: its order\'s own number. null when no ticket was written.
|
|
5994
6374
|
* @type {object}
|
|
5995
6375
|
* @memberof DispatchPosOrderResponseDto
|
|
5996
6376
|
*/
|
|
@@ -15751,7 +16131,7 @@ export interface ParkPosOrderResponseDto {
|
|
|
15751
16131
|
*/
|
|
15752
16132
|
'ticketId': object | null;
|
|
15753
16133
|
/**
|
|
15754
|
-
* Number of that ticket:
|
|
16134
|
+
* Number of that ticket: its order\'s own number. null when no ticket was written.
|
|
15755
16135
|
* @type {object}
|
|
15756
16136
|
* @memberof ParkPosOrderResponseDto
|
|
15757
16137
|
*/
|
|
@@ -17670,6 +18050,16 @@ export interface PaymentStatusDtoTransaction {
|
|
|
17670
18050
|
*/
|
|
17671
18051
|
'fees'?: TransactionDtoFees | null;
|
|
17672
18052
|
}
|
|
18053
|
+
/**
|
|
18054
|
+
*
|
|
18055
|
+
* @export
|
|
18056
|
+
* @enum {string}
|
|
18057
|
+
*/
|
|
18058
|
+
export declare const PaymentSurchargePaidBy: {
|
|
18059
|
+
readonly Business: "BUSINESS";
|
|
18060
|
+
readonly Customer: "CUSTOMER";
|
|
18061
|
+
};
|
|
18062
|
+
export type PaymentSurchargePaidBy = typeof PaymentSurchargePaidBy[keyof typeof PaymentSurchargePaidBy];
|
|
17673
18063
|
/**
|
|
17674
18064
|
*
|
|
17675
18065
|
* @export
|
|
@@ -18239,6 +18629,18 @@ export interface PosDiscountDto {
|
|
|
18239
18629
|
* @memberof PosDiscountDto
|
|
18240
18630
|
*/
|
|
18241
18631
|
'units'?: number;
|
|
18632
|
+
/**
|
|
18633
|
+
* 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.
|
|
18634
|
+
* @type {string}
|
|
18635
|
+
* @memberof PosDiscountDto
|
|
18636
|
+
*/
|
|
18637
|
+
'couponCode'?: string;
|
|
18638
|
+
/**
|
|
18639
|
+
* 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.
|
|
18640
|
+
* @type {string}
|
|
18641
|
+
* @memberof PosDiscountDto
|
|
18642
|
+
*/
|
|
18643
|
+
'couponCustomerPhone'?: string;
|
|
18242
18644
|
}
|
|
18243
18645
|
/**
|
|
18244
18646
|
* What this application actually took off, after it was clamped to what was still payable; null or absent on orders written before applications recorded it
|
|
@@ -20101,6 +20503,18 @@ export interface PosOrderItemDtoDiscount {
|
|
|
20101
20503
|
* @memberof PosOrderItemDtoDiscount
|
|
20102
20504
|
*/
|
|
20103
20505
|
'units'?: number;
|
|
20506
|
+
/**
|
|
20507
|
+
* 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.
|
|
20508
|
+
* @type {string}
|
|
20509
|
+
* @memberof PosOrderItemDtoDiscount
|
|
20510
|
+
*/
|
|
20511
|
+
'couponCode'?: string;
|
|
20512
|
+
/**
|
|
20513
|
+
* 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.
|
|
20514
|
+
* @type {string}
|
|
20515
|
+
* @memberof PosOrderItemDtoDiscount
|
|
20516
|
+
*/
|
|
20517
|
+
'couponCustomerPhone'?: string;
|
|
20104
20518
|
}
|
|
20105
20519
|
/**
|
|
20106
20520
|
* Reporting category details
|
|
@@ -20837,6 +21251,68 @@ export declare const PreorderStatus: {
|
|
|
20837
21251
|
readonly Confirm: "confirm";
|
|
20838
21252
|
};
|
|
20839
21253
|
export type PreorderStatus = typeof PreorderStatus[keyof typeof PreorderStatus];
|
|
21254
|
+
/**
|
|
21255
|
+
*
|
|
21256
|
+
* @export
|
|
21257
|
+
* @interface PriceBasketAnswerDto
|
|
21258
|
+
*/
|
|
21259
|
+
export interface PriceBasketAnswerDto {
|
|
21260
|
+
/**
|
|
21261
|
+
* true when Vendure priced the basket; false when it could not, and nothing is known of its discounts
|
|
21262
|
+
* @type {boolean}
|
|
21263
|
+
* @memberof PriceBasketAnswerDto
|
|
21264
|
+
*/
|
|
21265
|
+
'priced': boolean;
|
|
21266
|
+
/**
|
|
21267
|
+
*
|
|
21268
|
+
* @type {BasketNotPricedReason}
|
|
21269
|
+
* @memberof PriceBasketAnswerDto
|
|
21270
|
+
*/
|
|
21271
|
+
'reason': BasketNotPricedReason | null;
|
|
21272
|
+
/**
|
|
21273
|
+
* Every line sent, in the order sent, with its discounts; empty when priced is false
|
|
21274
|
+
* @type {Array<PricedLineDto>}
|
|
21275
|
+
* @memberof PriceBasketAnswerDto
|
|
21276
|
+
*/
|
|
21277
|
+
'lines': Array<PricedLineDto>;
|
|
21278
|
+
/**
|
|
21279
|
+
* Each promotion\'s discount over the whole basket, the lines\' shares added up, one per promotion and scope: what the receipt lists. It repeats the lines\' discounts, never adds to them. Empty when none applies or when priced is false
|
|
21280
|
+
* @type {Array<PricedDiscountDto>}
|
|
21281
|
+
* @memberof PriceBasketAnswerDto
|
|
21282
|
+
*/
|
|
21283
|
+
'orderDiscounts': Array<PricedDiscountDto>;
|
|
21284
|
+
/**
|
|
21285
|
+
* The basket\'s total in cents, VAT included, after the discounts, as Vendure worked it out; null when priced is false
|
|
21286
|
+
* @type {number}
|
|
21287
|
+
* @memberof PriceBasketAnswerDto
|
|
21288
|
+
*/
|
|
21289
|
+
'subTotalWithTax': number | null;
|
|
21290
|
+
}
|
|
21291
|
+
/**
|
|
21292
|
+
*
|
|
21293
|
+
* @export
|
|
21294
|
+
* @interface PriceBasketDto
|
|
21295
|
+
*/
|
|
21296
|
+
export interface PriceBasketDto {
|
|
21297
|
+
/**
|
|
21298
|
+
*
|
|
21299
|
+
* @type {OrderTypePOS}
|
|
21300
|
+
* @memberof PriceBasketDto
|
|
21301
|
+
*/
|
|
21302
|
+
'orderType': OrderTypePOS;
|
|
21303
|
+
/**
|
|
21304
|
+
* The coupon codes on the order, as typed or scanned, in any letter case, priced together with the venue\'s automatic promotions. A code is priced only when it is one of the venue\'s coupons in the app; whether it may be used (its limits, the customer\'s phone, a first order) is POST .../coupons/check\'s answer. Absent or empty: no coupon
|
|
21305
|
+
* @type {Array<string>}
|
|
21306
|
+
* @memberof PriceBasketDto
|
|
21307
|
+
*/
|
|
21308
|
+
'couponCodes'?: Array<string>;
|
|
21309
|
+
/**
|
|
21310
|
+
* The order\'s lines as they stand, VAT included; priced again whenever the basket changes
|
|
21311
|
+
* @type {Array<PricingBasketLineDto>}
|
|
21312
|
+
* @memberof PriceBasketDto
|
|
21313
|
+
*/
|
|
21314
|
+
'lines': Array<PricingBasketLineDto>;
|
|
21315
|
+
}
|
|
20840
21316
|
/**
|
|
20841
21317
|
*
|
|
20842
21318
|
* @export
|
|
@@ -20897,6 +21373,117 @@ export declare const PriceType: {
|
|
|
20897
21373
|
readonly Open: "OPEN";
|
|
20898
21374
|
};
|
|
20899
21375
|
export type PriceType = typeof PriceType[keyof typeof PriceType];
|
|
21376
|
+
/**
|
|
21377
|
+
*
|
|
21378
|
+
* @export
|
|
21379
|
+
* @interface PricedDiscountDto
|
|
21380
|
+
*/
|
|
21381
|
+
export interface PricedDiscountDto {
|
|
21382
|
+
/**
|
|
21383
|
+
*
|
|
21384
|
+
* @type {DiscountSourceType}
|
|
21385
|
+
* @memberof PricedDiscountDto
|
|
21386
|
+
*/
|
|
21387
|
+
'sourceType': DiscountSourceType;
|
|
21388
|
+
/**
|
|
21389
|
+
* The Vendure promotion\'s id, as text
|
|
21390
|
+
* @type {string}
|
|
21391
|
+
* @memberof PricedDiscountDto
|
|
21392
|
+
*/
|
|
21393
|
+
'sourceId': string;
|
|
21394
|
+
/**
|
|
21395
|
+
* The promotion\'s name, in English, else Finnish; shown on the till, the receipt and the reports
|
|
21396
|
+
* @type {string}
|
|
21397
|
+
* @memberof PricedDiscountDto
|
|
21398
|
+
*/
|
|
21399
|
+
'name': string;
|
|
21400
|
+
/**
|
|
21401
|
+
* true when Vendure applies the promotion by itself, with no code; false when one of the basket\'s coupon codes applies it
|
|
21402
|
+
* @type {boolean}
|
|
21403
|
+
* @memberof PricedDiscountDto
|
|
21404
|
+
*/
|
|
21405
|
+
'isAutomatic': boolean;
|
|
21406
|
+
/**
|
|
21407
|
+
* The coupon code as the promotion holds it; null for an automatic promotion
|
|
21408
|
+
* @type {string}
|
|
21409
|
+
* @memberof PricedDiscountDto
|
|
21410
|
+
*/
|
|
21411
|
+
'couponCode': string | null;
|
|
21412
|
+
/**
|
|
21413
|
+
*
|
|
21414
|
+
* @type {DiscountScope}
|
|
21415
|
+
* @memberof PricedDiscountDto
|
|
21416
|
+
*/
|
|
21417
|
+
'scope': DiscountScope;
|
|
21418
|
+
/**
|
|
21419
|
+
* The discount in cents, VAT included, negative, exactly as Vendure worked it out: the cents the till takes off
|
|
21420
|
+
* @type {number}
|
|
21421
|
+
* @memberof PricedDiscountDto
|
|
21422
|
+
*/
|
|
21423
|
+
'amountWithTax': number;
|
|
21424
|
+
/**
|
|
21425
|
+
* The same discount in cents before VAT, negative
|
|
21426
|
+
* @type {number}
|
|
21427
|
+
* @memberof PricedDiscountDto
|
|
21428
|
+
*/
|
|
21429
|
+
'amount': number;
|
|
21430
|
+
}
|
|
21431
|
+
/**
|
|
21432
|
+
*
|
|
21433
|
+
* @export
|
|
21434
|
+
* @interface PricedLineDto
|
|
21435
|
+
*/
|
|
21436
|
+
export interface PricedLineDto {
|
|
21437
|
+
/**
|
|
21438
|
+
* The line\'s id, as sent
|
|
21439
|
+
* @type {string}
|
|
21440
|
+
* @memberof PricedLineDto
|
|
21441
|
+
*/
|
|
21442
|
+
'lineItemId': string;
|
|
21443
|
+
/**
|
|
21444
|
+
* The discounts on this line, each order discount\'s share included; empty when none reaches it
|
|
21445
|
+
* @type {Array<PricedDiscountDto>}
|
|
21446
|
+
* @memberof PricedLineDto
|
|
21447
|
+
*/
|
|
21448
|
+
'discounts': Array<PricedDiscountDto>;
|
|
21449
|
+
}
|
|
21450
|
+
/**
|
|
21451
|
+
*
|
|
21452
|
+
* @export
|
|
21453
|
+
* @interface PricingBasketLineDto
|
|
21454
|
+
*/
|
|
21455
|
+
export interface PricingBasketLineDto {
|
|
21456
|
+
/**
|
|
21457
|
+
* The line\'s stable id, the one the order\'s discounts point at
|
|
21458
|
+
* @type {string}
|
|
21459
|
+
* @memberof PricingBasketLineDto
|
|
21460
|
+
*/
|
|
21461
|
+
'lineItemId': string;
|
|
21462
|
+
/**
|
|
21463
|
+
* How many of the product the line holds, a whole number
|
|
21464
|
+
* @type {number}
|
|
21465
|
+
* @memberof PricingBasketLineDto
|
|
21466
|
+
*/
|
|
21467
|
+
'quantity': number;
|
|
21468
|
+
/**
|
|
21469
|
+
* The price of one unit as the till charges it, options included, in cents
|
|
21470
|
+
* @type {number}
|
|
21471
|
+
* @memberof PricingBasketLineDto
|
|
21472
|
+
*/
|
|
21473
|
+
'unitAmount': number;
|
|
21474
|
+
/**
|
|
21475
|
+
* 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
|
|
21476
|
+
* @type {number}
|
|
21477
|
+
* @memberof PricingBasketLineDto
|
|
21478
|
+
*/
|
|
21479
|
+
'vatRate'?: number;
|
|
21480
|
+
/**
|
|
21481
|
+
* The product\'s Vendure id: the line\'s posId, as a number
|
|
21482
|
+
* @type {number}
|
|
21483
|
+
* @memberof PricingBasketLineDto
|
|
21484
|
+
*/
|
|
21485
|
+
'productId'?: number;
|
|
21486
|
+
}
|
|
20900
21487
|
/**
|
|
20901
21488
|
*
|
|
20902
21489
|
* @export
|
|
@@ -23520,6 +24107,8 @@ export declare const ReportChangeField: {
|
|
|
23520
24107
|
readonly PaymentReportSummaryTotalRefunds: "paymentReport.summary.totalRefunds";
|
|
23521
24108
|
readonly PaymentReportSummaryRefundCount: "paymentReport.summary.refundCount";
|
|
23522
24109
|
readonly PaymentReportTotalDiscounts: "paymentReport.totalDiscounts";
|
|
24110
|
+
readonly OrderCount: "orderCount";
|
|
24111
|
+
readonly AverageOrderValue: "averageOrderValue";
|
|
23523
24112
|
};
|
|
23524
24113
|
export type ReportChangeField = typeof ReportChangeField[keyof typeof ReportChangeField];
|
|
23525
24114
|
/**
|
|
@@ -23632,6 +24221,250 @@ export interface RequestSessionTokenResponseDto {
|
|
|
23632
24221
|
*/
|
|
23633
24222
|
'sessionChannel': string;
|
|
23634
24223
|
}
|
|
24224
|
+
/**
|
|
24225
|
+
*
|
|
24226
|
+
* @export
|
|
24227
|
+
* @interface ResQOfferDto
|
|
24228
|
+
*/
|
|
24229
|
+
export interface ResQOfferDto {
|
|
24230
|
+
/**
|
|
24231
|
+
* The offer\'s id at ResQ
|
|
24232
|
+
* @type {string}
|
|
24233
|
+
* @memberof ResQOfferDto
|
|
24234
|
+
*/
|
|
24235
|
+
'id': string;
|
|
24236
|
+
/**
|
|
24237
|
+
* The offer\'s name. Absent when ResQ did not send it
|
|
24238
|
+
* @type {string}
|
|
24239
|
+
* @memberof ResQOfferDto
|
|
24240
|
+
*/
|
|
24241
|
+
'name'?: string;
|
|
24242
|
+
/**
|
|
24243
|
+
* 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
|
|
24244
|
+
* @type {boolean}
|
|
24245
|
+
* @memberof ResQOfferDto
|
|
24246
|
+
*/
|
|
24247
|
+
'active'?: boolean;
|
|
24248
|
+
/**
|
|
24249
|
+
* The price of one, in cents of the venue\'s currency. Absent when ResQ did not send it
|
|
24250
|
+
* @type {number}
|
|
24251
|
+
* @memberof ResQOfferDto
|
|
24252
|
+
*/
|
|
24253
|
+
'price'?: number;
|
|
24254
|
+
/**
|
|
24255
|
+
* When ordering starts, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
24256
|
+
* @type {string}
|
|
24257
|
+
* @memberof ResQOfferDto
|
|
24258
|
+
*/
|
|
24259
|
+
'orderStart'?: string;
|
|
24260
|
+
/**
|
|
24261
|
+
* When ordering ends, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
24262
|
+
* @type {string}
|
|
24263
|
+
* @memberof ResQOfferDto
|
|
24264
|
+
*/
|
|
24265
|
+
'orderEnd'?: string;
|
|
24266
|
+
}
|
|
24267
|
+
/**
|
|
24268
|
+
*
|
|
24269
|
+
* @export
|
|
24270
|
+
* @enum {string}
|
|
24271
|
+
*/
|
|
24272
|
+
export declare const ResQOfferTag: {
|
|
24273
|
+
readonly Meal: "meal";
|
|
24274
|
+
readonly Snack: "snack";
|
|
24275
|
+
readonly Ingredients: "ingredients";
|
|
24276
|
+
readonly GroceryBag: "grocery-bag";
|
|
24277
|
+
readonly Dessert: "dessert";
|
|
24278
|
+
readonly Flowers: "flowers";
|
|
24279
|
+
readonly Fee: "fee";
|
|
24280
|
+
readonly Wholesale: "wholesale";
|
|
24281
|
+
readonly HomeCosmetics: "home-cosmetics";
|
|
24282
|
+
};
|
|
24283
|
+
export type ResQOfferTag = typeof ResQOfferTag[keyof typeof ResQOfferTag];
|
|
24284
|
+
/**
|
|
24285
|
+
*
|
|
24286
|
+
* @export
|
|
24287
|
+
* @interface ResQOffersPageDto
|
|
24288
|
+
*/
|
|
24289
|
+
export interface ResQOffersPageDto {
|
|
24290
|
+
/**
|
|
24291
|
+
* The venue\'s offers on this page, as ResQ orders them
|
|
24292
|
+
* @type {Array<ResQOfferDto>}
|
|
24293
|
+
* @memberof ResQOffersPageDto
|
|
24294
|
+
*/
|
|
24295
|
+
'offers': Array<ResQOfferDto>;
|
|
24296
|
+
/**
|
|
24297
|
+
* This page\'s number, from 1
|
|
24298
|
+
* @type {number}
|
|
24299
|
+
* @memberof ResQOffersPageDto
|
|
24300
|
+
*/
|
|
24301
|
+
'page': number;
|
|
24302
|
+
/**
|
|
24303
|
+
* How many pages there are
|
|
24304
|
+
* @type {number}
|
|
24305
|
+
* @memberof ResQOffersPageDto
|
|
24306
|
+
*/
|
|
24307
|
+
'pages': number;
|
|
24308
|
+
/**
|
|
24309
|
+
* How many offers the venue has, on every page
|
|
24310
|
+
* @type {number}
|
|
24311
|
+
* @memberof ResQOffersPageDto
|
|
24312
|
+
*/
|
|
24313
|
+
'count': number;
|
|
24314
|
+
}
|
|
24315
|
+
/**
|
|
24316
|
+
*
|
|
24317
|
+
* @export
|
|
24318
|
+
* @interface ResQOrderDto
|
|
24319
|
+
*/
|
|
24320
|
+
export interface ResQOrderDto {
|
|
24321
|
+
/**
|
|
24322
|
+
* The order\'s id at ResQ
|
|
24323
|
+
* @type {string}
|
|
24324
|
+
* @memberof ResQOrderDto
|
|
24325
|
+
*/
|
|
24326
|
+
'id': string;
|
|
24327
|
+
/**
|
|
24328
|
+
* The order\'s status in ResQ\'s own words, passed on as ResQ answered it
|
|
24329
|
+
* @type {string}
|
|
24330
|
+
* @memberof ResQOrderDto
|
|
24331
|
+
*/
|
|
24332
|
+
'status': string;
|
|
24333
|
+
/**
|
|
24334
|
+
* Whether ResQ counts the order as a sale
|
|
24335
|
+
* @type {boolean}
|
|
24336
|
+
* @memberof ResQOrderDto
|
|
24337
|
+
*/
|
|
24338
|
+
'sold': boolean;
|
|
24339
|
+
/**
|
|
24340
|
+
* The customer\'s first name; null when ResQ gave none
|
|
24341
|
+
* @type {string}
|
|
24342
|
+
* @memberof ResQOrderDto
|
|
24343
|
+
*/
|
|
24344
|
+
'customerFirstName': string | null;
|
|
24345
|
+
/**
|
|
24346
|
+
* When pick-up starts, an ISO 8601 date-time; null when ResQ gave none
|
|
24347
|
+
* @type {string}
|
|
24348
|
+
* @memberof ResQOrderDto
|
|
24349
|
+
*/
|
|
24350
|
+
'fetchStart': string | null;
|
|
24351
|
+
/**
|
|
24352
|
+
* When pick-up ends, an ISO 8601 date-time; null when ResQ gave none
|
|
24353
|
+
* @type {string}
|
|
24354
|
+
* @memberof ResQOrderDto
|
|
24355
|
+
*/
|
|
24356
|
+
'fetchEnd': string | null;
|
|
24357
|
+
/**
|
|
24358
|
+
* Whether the customer has picked the order up; null when ResQ did not say
|
|
24359
|
+
* @type {boolean}
|
|
24360
|
+
* @memberof ResQOrderDto
|
|
24361
|
+
*/
|
|
24362
|
+
'pickedUp': boolean | null;
|
|
24363
|
+
/**
|
|
24364
|
+
* When the customer picked the order up, an ISO 8601 date-time; null when not picked up or ResQ did not say
|
|
24365
|
+
* @type {string}
|
|
24366
|
+
* @memberof ResQOrderDto
|
|
24367
|
+
*/
|
|
24368
|
+
'pickedUpAt': string | null;
|
|
24369
|
+
/**
|
|
24370
|
+
* How many the customer ordered; null when ResQ gave none
|
|
24371
|
+
* @type {number}
|
|
24372
|
+
* @memberof ResQOrderDto
|
|
24373
|
+
*/
|
|
24374
|
+
'quantity': number | null;
|
|
24375
|
+
/**
|
|
24376
|
+
* What the order sold for, in cents of its currency; null when ResQ gave none
|
|
24377
|
+
* @type {number}
|
|
24378
|
+
* @memberof ResQOrderDto
|
|
24379
|
+
*/
|
|
24380
|
+
'sales': number | null;
|
|
24381
|
+
/**
|
|
24382
|
+
* The order\'s currency, an ISO 4217 code; null when ResQ gave none
|
|
24383
|
+
* @type {string}
|
|
24384
|
+
* @memberof ResQOrderDto
|
|
24385
|
+
*/
|
|
24386
|
+
'currency': string | null;
|
|
24387
|
+
}
|
|
24388
|
+
/**
|
|
24389
|
+
*
|
|
24390
|
+
* @export
|
|
24391
|
+
* @interface ResQOrderSummaryDto
|
|
24392
|
+
*/
|
|
24393
|
+
export interface ResQOrderSummaryDto {
|
|
24394
|
+
/**
|
|
24395
|
+
* The order\'s id at ResQ
|
|
24396
|
+
* @type {string}
|
|
24397
|
+
* @memberof ResQOrderSummaryDto
|
|
24398
|
+
*/
|
|
24399
|
+
'id': string;
|
|
24400
|
+
/**
|
|
24401
|
+
* The order\'s status in ResQ\'s own words, passed on as ResQ answered it
|
|
24402
|
+
* @type {string}
|
|
24403
|
+
* @memberof ResQOrderSummaryDto
|
|
24404
|
+
*/
|
|
24405
|
+
'status': string;
|
|
24406
|
+
/**
|
|
24407
|
+
* Whether ResQ counts the order as a sale
|
|
24408
|
+
* @type {boolean}
|
|
24409
|
+
* @memberof ResQOrderSummaryDto
|
|
24410
|
+
*/
|
|
24411
|
+
'sold': boolean;
|
|
24412
|
+
/**
|
|
24413
|
+
* When the customer ordered, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
24414
|
+
* @type {string}
|
|
24415
|
+
* @memberof ResQOrderSummaryDto
|
|
24416
|
+
*/
|
|
24417
|
+
'createdAt'?: string;
|
|
24418
|
+
/**
|
|
24419
|
+
* How many the customer ordered. Absent when ResQ did not send it
|
|
24420
|
+
* @type {number}
|
|
24421
|
+
* @memberof ResQOrderSummaryDto
|
|
24422
|
+
*/
|
|
24423
|
+
'quantity'?: number;
|
|
24424
|
+
/**
|
|
24425
|
+
* What the order sold for, in cents of its currency. Absent when ResQ did not send it
|
|
24426
|
+
* @type {number}
|
|
24427
|
+
* @memberof ResQOrderSummaryDto
|
|
24428
|
+
*/
|
|
24429
|
+
'sales'?: number;
|
|
24430
|
+
/**
|
|
24431
|
+
* The order\'s currency, an ISO 4217 code. Absent when ResQ did not send it
|
|
24432
|
+
* @type {string}
|
|
24433
|
+
* @memberof ResQOrderSummaryDto
|
|
24434
|
+
*/
|
|
24435
|
+
'currency'?: string;
|
|
24436
|
+
}
|
|
24437
|
+
/**
|
|
24438
|
+
*
|
|
24439
|
+
* @export
|
|
24440
|
+
* @interface ResQOrdersPageDto
|
|
24441
|
+
*/
|
|
24442
|
+
export interface ResQOrdersPageDto {
|
|
24443
|
+
/**
|
|
24444
|
+
* The venue\'s ResQ orders on this page, as ResQ orders them
|
|
24445
|
+
* @type {Array<ResQOrderSummaryDto>}
|
|
24446
|
+
* @memberof ResQOrdersPageDto
|
|
24447
|
+
*/
|
|
24448
|
+
'orders': Array<ResQOrderSummaryDto>;
|
|
24449
|
+
/**
|
|
24450
|
+
* This page\'s number, from 1
|
|
24451
|
+
* @type {number}
|
|
24452
|
+
* @memberof ResQOrdersPageDto
|
|
24453
|
+
*/
|
|
24454
|
+
'page': number;
|
|
24455
|
+
/**
|
|
24456
|
+
* How many pages there are
|
|
24457
|
+
* @type {number}
|
|
24458
|
+
* @memberof ResQOrdersPageDto
|
|
24459
|
+
*/
|
|
24460
|
+
'pages': number;
|
|
24461
|
+
/**
|
|
24462
|
+
* How many orders the venue has, on every page
|
|
24463
|
+
* @type {number}
|
|
24464
|
+
* @memberof ResQOrdersPageDto
|
|
24465
|
+
*/
|
|
24466
|
+
'count': number;
|
|
24467
|
+
}
|
|
23635
24468
|
/**
|
|
23636
24469
|
*
|
|
23637
24470
|
* @export
|
|
@@ -24184,6 +25017,18 @@ export interface SalesReportComparisonDto {
|
|
|
24184
25017
|
* @memberof SalesReportComparisonDto
|
|
24185
25018
|
*/
|
|
24186
25019
|
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
25020
|
+
/**
|
|
25021
|
+
* Part summary: how many orders were sold, the sum of dailyBreakdown[].orders. POS counts orders as the till does, so a split bill counts once; kiosk, storefront and mobile count each of their orders once. A group that adds apps together (breakdown none or venue) adds POS\'s count to the other apps\' counts. Wolt, Foodora and other platform orders are not included. Count orders with this, never with paymentReport.summary.totalCount, which counts payments. Left out without part summary
|
|
25022
|
+
* @type {number}
|
|
25023
|
+
* @memberof SalesReportComparisonDto
|
|
25024
|
+
*/
|
|
25025
|
+
'orderCount'?: number;
|
|
25026
|
+
/**
|
|
25027
|
+
* Part summary: what was paid, refunds taken off (paymentReport.summary.salesAndRevenue), divided by orderCount, rounded half up to the currency\'s minor digits, in the major unit of the group\'s currency (euros for EUR). Null when no order was sold, and then its change is left out of changes and changesFromBaseline. Left out without part summary
|
|
25028
|
+
* @type {number}
|
|
25029
|
+
* @memberof SalesReportComparisonDto
|
|
25030
|
+
*/
|
|
25031
|
+
'averageOrderValue'?: number | null;
|
|
24187
25032
|
/**
|
|
24188
25033
|
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
24189
25034
|
* @type {Array<SalesReportChangeDto>}
|
|
@@ -24290,7 +25135,7 @@ export interface SalesReportDayDto {
|
|
|
24290
25135
|
*/
|
|
24291
25136
|
'date': string;
|
|
24292
25137
|
/**
|
|
24293
|
-
* How many orders were sold that day
|
|
25138
|
+
* How many orders were sold that day. POS counts them as the till\'s end-of-day report does: an order refunded in full is not counted, one refunded in part, unpaid or at 0 is. Kiosk, storefront and mobile count the orders with items not refunded in full, a kiosk order only when paid
|
|
24294
25139
|
* @type {number}
|
|
24295
25140
|
* @memberof SalesReportDayDto
|
|
24296
25141
|
*/
|
|
@@ -24405,6 +25250,18 @@ export interface SalesReportGroupDto {
|
|
|
24405
25250
|
* @memberof SalesReportGroupDto
|
|
24406
25251
|
*/
|
|
24407
25252
|
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
25253
|
+
/**
|
|
25254
|
+
* Part summary: how many orders were sold, the sum of dailyBreakdown[].orders. POS counts orders as the till does, so a split bill counts once; kiosk, storefront and mobile count each of their orders once. A group that adds apps together (breakdown none or venue) adds POS\'s count to the other apps\' counts. Wolt, Foodora and other platform orders are not included. Count orders with this, never with paymentReport.summary.totalCount, which counts payments. Left out without part summary
|
|
25255
|
+
* @type {number}
|
|
25256
|
+
* @memberof SalesReportGroupDto
|
|
25257
|
+
*/
|
|
25258
|
+
'orderCount'?: number;
|
|
25259
|
+
/**
|
|
25260
|
+
* Part summary: what was paid, refunds taken off (paymentReport.summary.salesAndRevenue), divided by orderCount, rounded half up to the currency\'s minor digits, in the major unit of the group\'s currency (euros for EUR). Null when no order was sold, and then its change is left out of changes and changesFromBaseline. Left out without part summary
|
|
25261
|
+
* @type {number}
|
|
25262
|
+
* @memberof SalesReportGroupDto
|
|
25263
|
+
*/
|
|
25264
|
+
'averageOrderValue'?: number | null;
|
|
24408
25265
|
/**
|
|
24409
25266
|
*
|
|
24410
25267
|
* @type {SalesReportGroupDtoComparison}
|
|
@@ -24472,6 +25329,18 @@ export interface SalesReportGroupDtoComparison {
|
|
|
24472
25329
|
* @memberof SalesReportGroupDtoComparison
|
|
24473
25330
|
*/
|
|
24474
25331
|
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
25332
|
+
/**
|
|
25333
|
+
* Part summary: how many orders were sold, the sum of dailyBreakdown[].orders. POS counts orders as the till does, so a split bill counts once; kiosk, storefront and mobile count each of their orders once. A group that adds apps together (breakdown none or venue) adds POS\'s count to the other apps\' counts. Wolt, Foodora and other platform orders are not included. Count orders with this, never with paymentReport.summary.totalCount, which counts payments. Left out without part summary
|
|
25334
|
+
* @type {number}
|
|
25335
|
+
* @memberof SalesReportGroupDtoComparison
|
|
25336
|
+
*/
|
|
25337
|
+
'orderCount'?: number;
|
|
25338
|
+
/**
|
|
25339
|
+
* Part summary: what was paid, refunds taken off (paymentReport.summary.salesAndRevenue), divided by orderCount, rounded half up to the currency\'s minor digits, in the major unit of the group\'s currency (euros for EUR). Null when no order was sold, and then its change is left out of changes and changesFromBaseline. Left out without part summary
|
|
25340
|
+
* @type {number}
|
|
25341
|
+
* @memberof SalesReportGroupDtoComparison
|
|
25342
|
+
*/
|
|
25343
|
+
'averageOrderValue'?: number | null;
|
|
24475
25344
|
/**
|
|
24476
25345
|
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
24477
25346
|
* @type {Array<SalesReportChangeDto>}
|
|
@@ -25343,6 +26212,31 @@ export interface SendReportEmailDto {
|
|
|
25343
26212
|
*/
|
|
25344
26213
|
'language'?: ReportLanguage;
|
|
25345
26214
|
}
|
|
26215
|
+
/**
|
|
26216
|
+
*
|
|
26217
|
+
* @export
|
|
26218
|
+
* @interface ServeMcpRequest403Response
|
|
26219
|
+
*/
|
|
26220
|
+
export interface ServeMcpRequest403Response {
|
|
26221
|
+
/**
|
|
26222
|
+
* Why the person\'s request is refused
|
|
26223
|
+
* @type {string}
|
|
26224
|
+
* @memberof ServeMcpRequest403Response
|
|
26225
|
+
*/
|
|
26226
|
+
'error'?: ErrorEnum;
|
|
26227
|
+
/**
|
|
26228
|
+
* With NOT_STORE_OWNER: each venue a tool call named that the person does not own
|
|
26229
|
+
* @type {Array<any>}
|
|
26230
|
+
* @memberof ServeMcpRequest403Response
|
|
26231
|
+
*/
|
|
26232
|
+
'venueIds'?: Array<any>;
|
|
26233
|
+
}
|
|
26234
|
+
export declare const ErrorEnum: {
|
|
26235
|
+
readonly NoAriAccess: "NO_ARI_ACCESS";
|
|
26236
|
+
readonly NotStoreOwner: "NOT_STORE_OWNER";
|
|
26237
|
+
readonly RightsUnavailable: "RIGHTS_UNAVAILABLE";
|
|
26238
|
+
};
|
|
26239
|
+
export type ErrorEnum = typeof ErrorEnum[keyof typeof ErrorEnum];
|
|
25346
26240
|
/**
|
|
25347
26241
|
*
|
|
25348
26242
|
* @export
|
|
@@ -31086,17 +31980,23 @@ export interface UpsertProvidersDto {
|
|
|
31086
31980
|
*/
|
|
31087
31981
|
'sourceCode'?: string;
|
|
31088
31982
|
/**
|
|
31089
|
-
* Viva ISV commission rate, in percent, at most two decimals. A change is saved on the license server first.
|
|
31983
|
+
* 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.
|
|
31090
31984
|
* @type {number}
|
|
31091
31985
|
* @memberof UpsertProvidersDto
|
|
31092
31986
|
*/
|
|
31093
31987
|
'rate'?: number;
|
|
31094
31988
|
/**
|
|
31095
|
-
* Viva ISV fixed fee per payment, in cents. A change is saved on the license server first.
|
|
31989
|
+
* 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.
|
|
31096
31990
|
* @type {number}
|
|
31097
31991
|
* @memberof UpsertProvidersDto
|
|
31098
31992
|
*/
|
|
31099
31993
|
'additionalAmount'?: number;
|
|
31994
|
+
/**
|
|
31995
|
+
*
|
|
31996
|
+
* @type {PaymentSurchargePaidBy}
|
|
31997
|
+
* @memberof UpsertProvidersDto
|
|
31998
|
+
*/
|
|
31999
|
+
'surchargePaidBy'?: PaymentSurchargePaidBy;
|
|
31100
32000
|
/**
|
|
31101
32001
|
* Nets / Stripe / Worldline secret key. Absent keeps the stored value.
|
|
31102
32002
|
* @type {string}
|
|
@@ -31227,6 +32127,12 @@ export interface UpsertVivaDto {
|
|
|
31227
32127
|
* @memberof UpsertVivaDto
|
|
31228
32128
|
*/
|
|
31229
32129
|
'isActive'?: boolean;
|
|
32130
|
+
/**
|
|
32131
|
+
*
|
|
32132
|
+
* @type {PaymentSurchargePaidBy}
|
|
32133
|
+
* @memberof UpsertVivaDto
|
|
32134
|
+
*/
|
|
32135
|
+
'surchargePaidBy'?: PaymentSurchargePaidBy;
|
|
31230
32136
|
/**
|
|
31231
32137
|
*
|
|
31232
32138
|
* @type {UpsertVivaDtoConfig}
|
|
@@ -31241,7 +32147,7 @@ export interface UpsertVivaDto {
|
|
|
31241
32147
|
*/
|
|
31242
32148
|
export interface UpsertVivaDtoConfig {
|
|
31243
32149
|
/**
|
|
31244
|
-
* 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.
|
|
32150
|
+
* 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.
|
|
31245
32151
|
* @type {number}
|
|
31246
32152
|
* @memberof UpsertVivaDtoConfig
|
|
31247
32153
|
*/
|
|
@@ -31259,7 +32165,7 @@ export interface UpsertVivaDtoConfig {
|
|
|
31259
32165
|
*/
|
|
31260
32166
|
'sourceCode'?: string;
|
|
31261
32167
|
/**
|
|
31262
|
-
* 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.
|
|
32168
|
+
* 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.
|
|
31263
32169
|
* @type {number}
|
|
31264
32170
|
* @memberof UpsertVivaDtoConfig
|
|
31265
32171
|
*/
|
|
@@ -32164,7 +33070,7 @@ export interface VivaCancelTransactionDto {
|
|
|
32164
33070
|
*/
|
|
32165
33071
|
export interface VivaConfigDto {
|
|
32166
33072
|
/**
|
|
32167
|
-
* 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.
|
|
33073
|
+
* 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.
|
|
32168
33074
|
* @type {number}
|
|
32169
33075
|
* @memberof VivaConfigDto
|
|
32170
33076
|
*/
|
|
@@ -32182,7 +33088,7 @@ export interface VivaConfigDto {
|
|
|
32182
33088
|
*/
|
|
32183
33089
|
'sourceCode'?: string;
|
|
32184
33090
|
/**
|
|
32185
|
-
* 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.
|
|
33091
|
+
* 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.
|
|
32186
33092
|
* @type {number}
|
|
32187
33093
|
* @memberof VivaConfigDto
|
|
32188
33094
|
*/
|
|
@@ -34962,7 +35868,7 @@ export declare class AuthApi extends BaseAPI implements AuthApiInterface {
|
|
|
34962
35868
|
*/
|
|
34963
35869
|
export declare const BusinessApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34964
35870
|
/**
|
|
34965
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
35871
|
+
* For the channel the x-app-x header names (any channel when it names none), read from Vendure\'s manual promotions. Kept 30 days per venue and channel; cleared when Vendure announces a change of the venue\'s promotions. A failed read is not kept.
|
|
34966
35872
|
* @summary Get unified discounts for all business and venue
|
|
34967
35873
|
* @param {string} businessId The venue\'s business id
|
|
34968
35874
|
* @param {*} [options] Override http request option.
|
|
@@ -35117,7 +36023,7 @@ export declare const BusinessApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
35117
36023
|
*/
|
|
35118
36024
|
export declare const BusinessApiFp: (configuration?: Configuration) => {
|
|
35119
36025
|
/**
|
|
35120
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
36026
|
+
* For the channel the x-app-x header names (any channel when it names none), read from Vendure\'s manual promotions. Kept 30 days per venue and channel; cleared when Vendure announces a change of the venue\'s promotions. A failed read is not kept.
|
|
35121
36027
|
* @summary Get unified discounts for all business and venue
|
|
35122
36028
|
* @param {string} businessId The venue\'s business id
|
|
35123
36029
|
* @param {*} [options] Override http request option.
|
|
@@ -35272,7 +36178,7 @@ export declare const BusinessApiFp: (configuration?: Configuration) => {
|
|
|
35272
36178
|
*/
|
|
35273
36179
|
export declare const BusinessApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
35274
36180
|
/**
|
|
35275
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
36181
|
+
* For the channel the x-app-x header names (any channel when it names none), read from Vendure\'s manual promotions. Kept 30 days per venue and channel; cleared when Vendure announces a change of the venue\'s promotions. A failed read is not kept.
|
|
35276
36182
|
* @summary Get unified discounts for all business and venue
|
|
35277
36183
|
* @param {string} businessId The venue\'s business id
|
|
35278
36184
|
* @param {*} [options] Override http request option.
|
|
@@ -35428,7 +36334,7 @@ export declare const BusinessApiFactory: (configuration?: Configuration, basePat
|
|
|
35428
36334
|
*/
|
|
35429
36335
|
export interface BusinessApiInterface {
|
|
35430
36336
|
/**
|
|
35431
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
36337
|
+
* For the channel the x-app-x header names (any channel when it names none), read from Vendure\'s manual promotions. Kept 30 days per venue and channel; cleared when Vendure announces a change of the venue\'s promotions. A failed read is not kept.
|
|
35432
36338
|
* @summary Get unified discounts for all business and venue
|
|
35433
36339
|
* @param {string} businessId The venue\'s business id
|
|
35434
36340
|
* @param {*} [options] Override http request option.
|
|
@@ -35602,7 +36508,7 @@ export interface BusinessApiInterface {
|
|
|
35602
36508
|
*/
|
|
35603
36509
|
export declare class BusinessApi extends BaseAPI implements BusinessApiInterface {
|
|
35604
36510
|
/**
|
|
35605
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
36511
|
+
* For the channel the x-app-x header names (any channel when it names none), read from Vendure\'s manual promotions. Kept 30 days per venue and channel; cleared when Vendure announces a change of the venue\'s promotions. A failed read is not kept.
|
|
35606
36512
|
* @summary Get unified discounts for all business and venue
|
|
35607
36513
|
* @param {string} businessId The venue\'s business id
|
|
35608
36514
|
* @param {*} [options] Override http request option.
|
|
@@ -37308,6 +38214,133 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
37308
38214
|
*/
|
|
37309
38215
|
configUpsertViva(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertVivaDto: UpsertVivaDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
37310
38216
|
}
|
|
38217
|
+
/**
|
|
38218
|
+
* CouponsApi - axios parameter creator
|
|
38219
|
+
* @export
|
|
38220
|
+
*/
|
|
38221
|
+
export declare const CouponsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
38222
|
+
/**
|
|
38223
|
+
* 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.
|
|
38224
|
+
* @summary Check a coupon against a till\'s basket
|
|
38225
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
38226
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38227
|
+
* @param {*} [options] Override http request option.
|
|
38228
|
+
* @throws {RequiredError}
|
|
38229
|
+
*/
|
|
38230
|
+
checkCoupon: (businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38231
|
+
/**
|
|
38232
|
+
* 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.
|
|
38233
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
38234
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
38235
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38236
|
+
* @param {*} [options] Override http request option.
|
|
38237
|
+
* @throws {RequiredError}
|
|
38238
|
+
*/
|
|
38239
|
+
checkKioskCoupon: (businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38240
|
+
};
|
|
38241
|
+
/**
|
|
38242
|
+
* CouponsApi - functional programming interface
|
|
38243
|
+
* @export
|
|
38244
|
+
*/
|
|
38245
|
+
export declare const CouponsApiFp: (configuration?: Configuration) => {
|
|
38246
|
+
/**
|
|
38247
|
+
* 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.
|
|
38248
|
+
* @summary Check a coupon against a till\'s basket
|
|
38249
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
38250
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38251
|
+
* @param {*} [options] Override http request option.
|
|
38252
|
+
* @throws {RequiredError}
|
|
38253
|
+
*/
|
|
38254
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CouponCheckAnswerDto>>;
|
|
38255
|
+
/**
|
|
38256
|
+
* 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.
|
|
38257
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
38258
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
38259
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38260
|
+
* @param {*} [options] Override http request option.
|
|
38261
|
+
* @throws {RequiredError}
|
|
38262
|
+
*/
|
|
38263
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CouponCheckAnswerDto>>;
|
|
38264
|
+
};
|
|
38265
|
+
/**
|
|
38266
|
+
* CouponsApi - factory interface
|
|
38267
|
+
* @export
|
|
38268
|
+
*/
|
|
38269
|
+
export declare const CouponsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
38270
|
+
/**
|
|
38271
|
+
* 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.
|
|
38272
|
+
* @summary Check a coupon against a till\'s basket
|
|
38273
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
38274
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38275
|
+
* @param {*} [options] Override http request option.
|
|
38276
|
+
* @throws {RequiredError}
|
|
38277
|
+
*/
|
|
38278
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: any): AxiosPromise<CouponCheckAnswerDto>;
|
|
38279
|
+
/**
|
|
38280
|
+
* 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.
|
|
38281
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
38282
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
38283
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38284
|
+
* @param {*} [options] Override http request option.
|
|
38285
|
+
* @throws {RequiredError}
|
|
38286
|
+
*/
|
|
38287
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: any): AxiosPromise<CouponCheckAnswerDto>;
|
|
38288
|
+
};
|
|
38289
|
+
/**
|
|
38290
|
+
* CouponsApi - interface
|
|
38291
|
+
* @export
|
|
38292
|
+
* @interface CouponsApi
|
|
38293
|
+
*/
|
|
38294
|
+
export interface CouponsApiInterface {
|
|
38295
|
+
/**
|
|
38296
|
+
* 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.
|
|
38297
|
+
* @summary Check a coupon against a till\'s basket
|
|
38298
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
38299
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38300
|
+
* @param {*} [options] Override http request option.
|
|
38301
|
+
* @throws {RequiredError}
|
|
38302
|
+
* @memberof CouponsApiInterface
|
|
38303
|
+
*/
|
|
38304
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): AxiosPromise<CouponCheckAnswerDto>;
|
|
38305
|
+
/**
|
|
38306
|
+
* 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.
|
|
38307
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
38308
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
38309
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38310
|
+
* @param {*} [options] Override http request option.
|
|
38311
|
+
* @throws {RequiredError}
|
|
38312
|
+
* @memberof CouponsApiInterface
|
|
38313
|
+
*/
|
|
38314
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): AxiosPromise<CouponCheckAnswerDto>;
|
|
38315
|
+
}
|
|
38316
|
+
/**
|
|
38317
|
+
* CouponsApi - object-oriented interface
|
|
38318
|
+
* @export
|
|
38319
|
+
* @class CouponsApi
|
|
38320
|
+
* @extends {BaseAPI}
|
|
38321
|
+
*/
|
|
38322
|
+
export declare class CouponsApi extends BaseAPI implements CouponsApiInterface {
|
|
38323
|
+
/**
|
|
38324
|
+
* 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.
|
|
38325
|
+
* @summary Check a coupon against a till\'s basket
|
|
38326
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
38327
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38328
|
+
* @param {*} [options] Override http request option.
|
|
38329
|
+
* @throws {RequiredError}
|
|
38330
|
+
* @memberof CouponsApi
|
|
38331
|
+
*/
|
|
38332
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CouponCheckAnswerDto, any, {}>>;
|
|
38333
|
+
/**
|
|
38334
|
+
* 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.
|
|
38335
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
38336
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
38337
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38338
|
+
* @param {*} [options] Override http request option.
|
|
38339
|
+
* @throws {RequiredError}
|
|
38340
|
+
* @memberof CouponsApi
|
|
38341
|
+
*/
|
|
38342
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CouponCheckAnswerDto, any, {}>>;
|
|
38343
|
+
}
|
|
37311
38344
|
/**
|
|
37312
38345
|
* CoursesApi - axios parameter creator
|
|
37313
38346
|
* @export
|
|
@@ -39093,7 +40126,7 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
39093
40126
|
*/
|
|
39094
40127
|
getOrderHistoryPOSV5: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39095
40128
|
/**
|
|
39096
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
40129
|
+
* The same answer as GET history/orders/pos, for a service holding the service key. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
39097
40130
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
39098
40131
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39099
40132
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39142,7 +40175,7 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
39142
40175
|
*/
|
|
39143
40176
|
getOrderHistoryPOSV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderHistoryPosResponseDtoV2>>;
|
|
39144
40177
|
/**
|
|
39145
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
40178
|
+
* The same answer as GET history/orders/pos, for a service holding the service key. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
39146
40179
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
39147
40180
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39148
40181
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39191,7 +40224,7 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
39191
40224
|
*/
|
|
39192
40225
|
getOrderHistoryPOSV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: any): AxiosPromise<OrderHistoryPosResponseDtoV2>;
|
|
39193
40226
|
/**
|
|
39194
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
40227
|
+
* The same answer as GET history/orders/pos, for a service holding the service key. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
39195
40228
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
39196
40229
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39197
40230
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39242,7 +40275,7 @@ export interface HistoryApiInterface {
|
|
|
39242
40275
|
*/
|
|
39243
40276
|
getOrderHistoryPOSV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<OrderHistoryPosResponseDtoV2>;
|
|
39244
40277
|
/**
|
|
39245
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
40278
|
+
* The same answer as GET history/orders/pos, for a service holding the service key. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
39246
40279
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
39247
40280
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39248
40281
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39295,7 +40328,7 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
39295
40328
|
*/
|
|
39296
40329
|
getOrderHistoryPOSV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderHistoryPosResponseDtoV2, any, {}>>;
|
|
39297
40330
|
/**
|
|
39298
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
40331
|
+
* The same answer as GET history/orders/pos, for a service holding the service key. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
39299
40332
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
39300
40333
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39301
40334
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39323,7 +40356,7 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
39323
40356
|
*/
|
|
39324
40357
|
export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
39325
40358
|
/**
|
|
39326
|
-
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person.
|
|
40359
|
+
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
39327
40360
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
39328
40361
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39329
40362
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39392,7 +40425,7 @@ export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configurati
|
|
|
39392
40425
|
*/
|
|
39393
40426
|
export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
39394
40427
|
/**
|
|
39395
|
-
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person.
|
|
40428
|
+
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
39396
40429
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
39397
40430
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39398
40431
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39461,7 +40494,7 @@ export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
|
39461
40494
|
*/
|
|
39462
40495
|
export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
39463
40496
|
/**
|
|
39464
|
-
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person.
|
|
40497
|
+
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
39465
40498
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
39466
40499
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39467
40500
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39531,7 +40564,7 @@ export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePa
|
|
|
39531
40564
|
*/
|
|
39532
40565
|
export interface HistoryV6ApiInterface {
|
|
39533
40566
|
/**
|
|
39534
|
-
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person.
|
|
40567
|
+
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
39535
40568
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
39536
40569
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39537
40570
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39605,7 +40638,7 @@ export interface HistoryV6ApiInterface {
|
|
|
39605
40638
|
*/
|
|
39606
40639
|
export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterface {
|
|
39607
40640
|
/**
|
|
39608
|
-
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person.
|
|
40641
|
+
* The same answer as v1 GET history/internal/orders, which it replaces for munchi-dashboard-server, for a service holding the service key. Nothing is narrowed to a person. A store\'s owner signed in for Ari (D152) reads it too, only for the venues where they are org:owner.
|
|
39609
40642
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
39610
40643
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39611
40644
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -41219,7 +42252,7 @@ export declare const MCPApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
41219
42252
|
*/
|
|
41220
42253
|
refuseStream: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41221
42254
|
/**
|
|
41222
|
-
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own
|
|
42255
|
+
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own credential, so that route\'s guard and logs decide as for a direct call. A person signed in for Ari with their own Clerk token sees only the read tools, at the stores where they are `org:owner` (D152). A tool\'s answer never carries a credential. Connect with `claude mcp add --transport http munchi-super <host>/api/v1/mcp --header \"Authorization: Bearer ak_…\"` (D137).
|
|
41223
42256
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
41224
42257
|
* @param {object} body A JSON-RPC 2.0 message
|
|
41225
42258
|
* @param {*} [options] Override http request option.
|
|
@@ -41247,7 +42280,7 @@ export declare const MCPApiFp: (configuration?: Configuration) => {
|
|
|
41247
42280
|
*/
|
|
41248
42281
|
refuseStream(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
41249
42282
|
/**
|
|
41250
|
-
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own
|
|
42283
|
+
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own credential, so that route\'s guard and logs decide as for a direct call. A person signed in for Ari with their own Clerk token sees only the read tools, at the stores where they are `org:owner` (D152). A tool\'s answer never carries a credential. Connect with `claude mcp add --transport http munchi-super <host>/api/v1/mcp --header \"Authorization: Bearer ak_…\"` (D137).
|
|
41251
42284
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
41252
42285
|
* @param {object} body A JSON-RPC 2.0 message
|
|
41253
42286
|
* @param {*} [options] Override http request option.
|
|
@@ -41275,7 +42308,7 @@ export declare const MCPApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
41275
42308
|
*/
|
|
41276
42309
|
refuseStream(options?: any): AxiosPromise<void>;
|
|
41277
42310
|
/**
|
|
41278
|
-
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own
|
|
42311
|
+
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own credential, so that route\'s guard and logs decide as for a direct call. A person signed in for Ari with their own Clerk token sees only the read tools, at the stores where they are `org:owner` (D152). A tool\'s answer never carries a credential. Connect with `claude mcp add --transport http munchi-super <host>/api/v1/mcp --header \"Authorization: Bearer ak_…\"` (D137).
|
|
41279
42312
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
41280
42313
|
* @param {object} body A JSON-RPC 2.0 message
|
|
41281
42314
|
* @param {*} [options] Override http request option.
|
|
@@ -41306,7 +42339,7 @@ export interface MCPApiInterface {
|
|
|
41306
42339
|
*/
|
|
41307
42340
|
refuseStream(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
41308
42341
|
/**
|
|
41309
|
-
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own
|
|
42342
|
+
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own credential, so that route\'s guard and logs decide as for a direct call. A person signed in for Ari with their own Clerk token sees only the read tools, at the stores where they are `org:owner` (D152). A tool\'s answer never carries a credential. Connect with `claude mcp add --transport http munchi-super <host>/api/v1/mcp --header \"Authorization: Bearer ak_…\"` (D137).
|
|
41310
42343
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
41311
42344
|
* @param {object} body A JSON-RPC 2.0 message
|
|
41312
42345
|
* @param {*} [options] Override http request option.
|
|
@@ -41339,7 +42372,7 @@ export declare class MCPApi extends BaseAPI implements MCPApiInterface {
|
|
|
41339
42372
|
*/
|
|
41340
42373
|
refuseStream(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
41341
42374
|
/**
|
|
41342
|
-
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own
|
|
42375
|
+
* One JSON-RPC message of the Model Context Protocol: initialize, tools/list or tools/call. Each tool calls super-server\'s own REST route with the caller\'s own credential, so that route\'s guard and logs decide as for a direct call. A person signed in for Ari with their own Clerk token sees only the read tools, at the stores where they are `org:owner` (D152). A tool\'s answer never carries a credential. Connect with `claude mcp add --transport http munchi-super <host>/api/v1/mcp --header \"Authorization: Bearer ak_…\"` (D137).
|
|
41343
42376
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
41344
42377
|
* @param {object} body A JSON-RPC 2.0 message
|
|
41345
42378
|
* @param {*} [options] Override http request option.
|
|
@@ -42095,7 +43128,7 @@ export declare class OrderCompletionApi extends BaseAPI implements OrderCompleti
|
|
|
42095
43128
|
*/
|
|
42096
43129
|
export declare const OrderInternalApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
42097
43130
|
/**
|
|
42098
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
43131
|
+
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token. A store\'s owner signed in for Ari (D152) reads an order of a store they are org:owner of.
|
|
42099
43132
|
* @summary Get order data by external ID for internal microservice communication
|
|
42100
43133
|
* @param {string} externalId The order\'s id on its channel (Order.externalId): the id Wolt, Foodora, Bolt or Uber Eats gave it, or the id our own channels gave it
|
|
42101
43134
|
* @param {*} [options] Override http request option.
|
|
@@ -42109,7 +43142,7 @@ export declare const OrderInternalApiAxiosParamCreator: (configuration?: Configu
|
|
|
42109
43142
|
*/
|
|
42110
43143
|
export declare const OrderInternalApiFp: (configuration?: Configuration) => {
|
|
42111
43144
|
/**
|
|
42112
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
43145
|
+
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token. A store\'s owner signed in for Ari (D152) reads an order of a store they are org:owner of.
|
|
42113
43146
|
* @summary Get order data by external ID for internal microservice communication
|
|
42114
43147
|
* @param {string} externalId The order\'s id on its channel (Order.externalId): the id Wolt, Foodora, Bolt or Uber Eats gave it, or the id our own channels gave it
|
|
42115
43148
|
* @param {*} [options] Override http request option.
|
|
@@ -42123,7 +43156,7 @@ export declare const OrderInternalApiFp: (configuration?: Configuration) => {
|
|
|
42123
43156
|
*/
|
|
42124
43157
|
export declare const OrderInternalApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
42125
43158
|
/**
|
|
42126
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
43159
|
+
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token. A store\'s owner signed in for Ari (D152) reads an order of a store they are org:owner of.
|
|
42127
43160
|
* @summary Get order data by external ID for internal microservice communication
|
|
42128
43161
|
* @param {string} externalId The order\'s id on its channel (Order.externalId): the id Wolt, Foodora, Bolt or Uber Eats gave it, or the id our own channels gave it
|
|
42129
43162
|
* @param {*} [options] Override http request option.
|
|
@@ -42138,7 +43171,7 @@ export declare const OrderInternalApiFactory: (configuration?: Configuration, ba
|
|
|
42138
43171
|
*/
|
|
42139
43172
|
export interface OrderInternalApiInterface {
|
|
42140
43173
|
/**
|
|
42141
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
43174
|
+
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token. A store\'s owner signed in for Ari (D152) reads an order of a store they are org:owner of.
|
|
42142
43175
|
* @summary Get order data by external ID for internal microservice communication
|
|
42143
43176
|
* @param {string} externalId The order\'s id on its channel (Order.externalId): the id Wolt, Foodora, Bolt or Uber Eats gave it, or the id our own channels gave it
|
|
42144
43177
|
* @param {*} [options] Override http request option.
|
|
@@ -42155,7 +43188,7 @@ export interface OrderInternalApiInterface {
|
|
|
42155
43188
|
*/
|
|
42156
43189
|
export declare class OrderInternalApi extends BaseAPI implements OrderInternalApiInterface {
|
|
42157
43190
|
/**
|
|
42158
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
43191
|
+
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token. A store\'s owner signed in for Ari (D152) reads an order of a store they are org:owner of.
|
|
42159
43192
|
* @summary Get order data by external ID for internal microservice communication
|
|
42160
43193
|
* @param {string} externalId The order\'s id on its channel (Order.externalId): the id Wolt, Foodora, Bolt or Uber Eats gave it, or the id our own channels gave it
|
|
42161
43194
|
* @param {*} [options] Override http request option.
|
|
@@ -43810,7 +44843,7 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
43810
44843
|
*/
|
|
43811
44844
|
changePaymentMethodOption: (businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43812
44845
|
/**
|
|
43813
|
-
* Attaches a
|
|
44846
|
+
* 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.
|
|
43814
44847
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
43815
44848
|
* @param {number} businessId The venue\'s ordering business id.
|
|
43816
44849
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -43830,7 +44863,7 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
43830
44863
|
*/
|
|
43831
44864
|
deletePaymentMethodOption: (businessId: number, channel: ProviderEnum, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43832
44865
|
/**
|
|
43833
|
-
* The dashboard\'s add-method picker: every method of the
|
|
44866
|
+
* 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.
|
|
43834
44867
|
* @summary List the catalog methods a venue can still add on one channel
|
|
43835
44868
|
* @param {number} businessId The venue\'s ordering business id.
|
|
43836
44869
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -43916,7 +44949,7 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
43916
44949
|
*/
|
|
43917
44950
|
changePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
43918
44951
|
/**
|
|
43919
|
-
* Attaches a
|
|
44952
|
+
* 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.
|
|
43920
44953
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
43921
44954
|
* @param {number} businessId The venue\'s ordering business id.
|
|
43922
44955
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -43936,7 +44969,7 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
43936
44969
|
*/
|
|
43937
44970
|
deletePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
43938
44971
|
/**
|
|
43939
|
-
* The dashboard\'s add-method picker: every method of the
|
|
44972
|
+
* 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.
|
|
43940
44973
|
* @summary List the catalog methods a venue can still add on one channel
|
|
43941
44974
|
* @param {number} businessId The venue\'s ordering business id.
|
|
43942
44975
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44022,7 +45055,7 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
44022
45055
|
*/
|
|
44023
45056
|
changePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: any): AxiosPromise<void>;
|
|
44024
45057
|
/**
|
|
44025
|
-
* Attaches a
|
|
45058
|
+
* 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.
|
|
44026
45059
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
44027
45060
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44028
45061
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44042,7 +45075,7 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
44042
45075
|
*/
|
|
44043
45076
|
deletePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, options?: any): AxiosPromise<void>;
|
|
44044
45077
|
/**
|
|
44045
|
-
* The dashboard\'s add-method picker: every method of the
|
|
45078
|
+
* 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.
|
|
44046
45079
|
* @summary List the catalog methods a venue can still add on one channel
|
|
44047
45080
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44048
45081
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44131,7 +45164,7 @@ export interface PaymentMethodsApiInterface {
|
|
|
44131
45164
|
*/
|
|
44132
45165
|
changePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
44133
45166
|
/**
|
|
44134
|
-
* Attaches a
|
|
45167
|
+
* 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.
|
|
44135
45168
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
44136
45169
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44137
45170
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44153,7 +45186,7 @@ export interface PaymentMethodsApiInterface {
|
|
|
44153
45186
|
*/
|
|
44154
45187
|
deletePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
44155
45188
|
/**
|
|
44156
|
-
* The dashboard\'s add-method picker: every method of the
|
|
45189
|
+
* 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.
|
|
44157
45190
|
* @summary List the catalog methods a venue can still add on one channel
|
|
44158
45191
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44159
45192
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44249,7 +45282,7 @@ export declare class PaymentMethodsApi extends BaseAPI implements PaymentMethods
|
|
|
44249
45282
|
*/
|
|
44250
45283
|
changePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
44251
45284
|
/**
|
|
44252
|
-
* Attaches a
|
|
45285
|
+
* 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.
|
|
44253
45286
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
44254
45287
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44255
45288
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44271,7 +45304,7 @@ export declare class PaymentMethodsApi extends BaseAPI implements PaymentMethods
|
|
|
44271
45304
|
*/
|
|
44272
45305
|
deletePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
44273
45306
|
/**
|
|
44274
|
-
* The dashboard\'s add-method picker: every method of the
|
|
45307
|
+
* 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.
|
|
44275
45308
|
* @summary List the catalog methods a venue can still add on one channel
|
|
44276
45309
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44277
45310
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -45856,6 +46889,217 @@ export declare class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
45856
46889
|
*/
|
|
45857
46890
|
updateProductSkusV2(businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSkusResponseDto, any, {}>>;
|
|
45858
46891
|
}
|
|
46892
|
+
/**
|
|
46893
|
+
* PromotionsApi - axios parameter creator
|
|
46894
|
+
* @export
|
|
46895
|
+
*/
|
|
46896
|
+
export declare const PromotionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
46897
|
+
/**
|
|
46898
|
+
* The signal that tells the till whether to price its baskets: the venue\'s automatic promotions for the POS that are running at the moment of the read. Empty: the till need not call .../promotions/price unless the order holds a coupon code. Read it again when the venue\'s DISCOUNTS sync arrives.
|
|
46899
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
46900
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
46901
|
+
* @param {*} [options] Override http request option.
|
|
46902
|
+
* @throws {RequiredError}
|
|
46903
|
+
*/
|
|
46904
|
+
listAutomaticPromotions: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46905
|
+
/**
|
|
46906
|
+
* The signal that tells the kiosk whether to price its baskets: the venue\'s automatic promotions for the kiosk that are running at the moment of the read. Empty: the kiosk need not call .../promotions/price unless the order holds a coupon code.
|
|
46907
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
46908
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
46909
|
+
* @param {*} [options] Override http request option.
|
|
46910
|
+
* @throws {RequiredError}
|
|
46911
|
+
*/
|
|
46912
|
+
listKioskAutomaticPromotions: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46913
|
+
/**
|
|
46914
|
+
* Vendure prices the basket as the online store prices a cart: the venue\'s automatic promotions for the POS and the order type, and the basket\'s coupon codes, and answers each discount with the money it takes off. Nothing is stored, reserved or counted. Ask only when the venue has automatic promotions running (GET .../promotions/automatic) or the order holds a coupon code, again whenever the basket changes, and keep the newest answer. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
46915
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
46916
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
46917
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
46918
|
+
* @param {*} [options] Override http request option.
|
|
46919
|
+
* @throws {RequiredError}
|
|
46920
|
+
*/
|
|
46921
|
+
priceBasketWithPromotions: (businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46922
|
+
/**
|
|
46923
|
+
* The kiosk\'s pricing, with the kiosk\'s key: the same pricing as the till\'s, for the kiosk app. Vendure prices the basket with the venue\'s automatic promotions and the basket\'s coupon codes and answers each discount with the money it takes off; nothing is stored, reserved or counted. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
46924
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
46925
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
46926
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
46927
|
+
* @param {*} [options] Override http request option.
|
|
46928
|
+
* @throws {RequiredError}
|
|
46929
|
+
*/
|
|
46930
|
+
priceKioskBasketWithPromotions: (businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46931
|
+
};
|
|
46932
|
+
/**
|
|
46933
|
+
* PromotionsApi - functional programming interface
|
|
46934
|
+
* @export
|
|
46935
|
+
*/
|
|
46936
|
+
export declare const PromotionsApiFp: (configuration?: Configuration) => {
|
|
46937
|
+
/**
|
|
46938
|
+
* The signal that tells the till whether to price its baskets: the venue\'s automatic promotions for the POS that are running at the moment of the read. Empty: the till need not call .../promotions/price unless the order holds a coupon code. Read it again when the venue\'s DISCOUNTS sync arrives.
|
|
46939
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
46940
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
46941
|
+
* @param {*} [options] Override http request option.
|
|
46942
|
+
* @throws {RequiredError}
|
|
46943
|
+
*/
|
|
46944
|
+
listAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutomaticPromotionsAnswerDto>>;
|
|
46945
|
+
/**
|
|
46946
|
+
* The signal that tells the kiosk whether to price its baskets: the venue\'s automatic promotions for the kiosk that are running at the moment of the read. Empty: the kiosk need not call .../promotions/price unless the order holds a coupon code.
|
|
46947
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
46948
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
46949
|
+
* @param {*} [options] Override http request option.
|
|
46950
|
+
* @throws {RequiredError}
|
|
46951
|
+
*/
|
|
46952
|
+
listKioskAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutomaticPromotionsAnswerDto>>;
|
|
46953
|
+
/**
|
|
46954
|
+
* Vendure prices the basket as the online store prices a cart: the venue\'s automatic promotions for the POS and the order type, and the basket\'s coupon codes, and answers each discount with the money it takes off. Nothing is stored, reserved or counted. Ask only when the venue has automatic promotions running (GET .../promotions/automatic) or the order holds a coupon code, again whenever the basket changes, and keep the newest answer. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
46955
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
46956
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
46957
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
46958
|
+
* @param {*} [options] Override http request option.
|
|
46959
|
+
* @throws {RequiredError}
|
|
46960
|
+
*/
|
|
46961
|
+
priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PriceBasketAnswerDto>>;
|
|
46962
|
+
/**
|
|
46963
|
+
* The kiosk\'s pricing, with the kiosk\'s key: the same pricing as the till\'s, for the kiosk app. Vendure prices the basket with the venue\'s automatic promotions and the basket\'s coupon codes and answers each discount with the money it takes off; nothing is stored, reserved or counted. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
46964
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
46965
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
46966
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
46967
|
+
* @param {*} [options] Override http request option.
|
|
46968
|
+
* @throws {RequiredError}
|
|
46969
|
+
*/
|
|
46970
|
+
priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PriceBasketAnswerDto>>;
|
|
46971
|
+
};
|
|
46972
|
+
/**
|
|
46973
|
+
* PromotionsApi - factory interface
|
|
46974
|
+
* @export
|
|
46975
|
+
*/
|
|
46976
|
+
export declare const PromotionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
46977
|
+
/**
|
|
46978
|
+
* The signal that tells the till whether to price its baskets: the venue\'s automatic promotions for the POS that are running at the moment of the read. Empty: the till need not call .../promotions/price unless the order holds a coupon code. Read it again when the venue\'s DISCOUNTS sync arrives.
|
|
46979
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
46980
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
46981
|
+
* @param {*} [options] Override http request option.
|
|
46982
|
+
* @throws {RequiredError}
|
|
46983
|
+
*/
|
|
46984
|
+
listAutomaticPromotions(businessId: number, options?: any): AxiosPromise<AutomaticPromotionsAnswerDto>;
|
|
46985
|
+
/**
|
|
46986
|
+
* The signal that tells the kiosk whether to price its baskets: the venue\'s automatic promotions for the kiosk that are running at the moment of the read. Empty: the kiosk need not call .../promotions/price unless the order holds a coupon code.
|
|
46987
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
46988
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
46989
|
+
* @param {*} [options] Override http request option.
|
|
46990
|
+
* @throws {RequiredError}
|
|
46991
|
+
*/
|
|
46992
|
+
listKioskAutomaticPromotions(businessId: number, options?: any): AxiosPromise<AutomaticPromotionsAnswerDto>;
|
|
46993
|
+
/**
|
|
46994
|
+
* Vendure prices the basket as the online store prices a cart: the venue\'s automatic promotions for the POS and the order type, and the basket\'s coupon codes, and answers each discount with the money it takes off. Nothing is stored, reserved or counted. Ask only when the venue has automatic promotions running (GET .../promotions/automatic) or the order holds a coupon code, again whenever the basket changes, and keep the newest answer. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
46995
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
46996
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
46997
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
46998
|
+
* @param {*} [options] Override http request option.
|
|
46999
|
+
* @throws {RequiredError}
|
|
47000
|
+
*/
|
|
47001
|
+
priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: any): AxiosPromise<PriceBasketAnswerDto>;
|
|
47002
|
+
/**
|
|
47003
|
+
* The kiosk\'s pricing, with the kiosk\'s key: the same pricing as the till\'s, for the kiosk app. Vendure prices the basket with the venue\'s automatic promotions and the basket\'s coupon codes and answers each discount with the money it takes off; nothing is stored, reserved or counted. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
47004
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
47005
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
47006
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
47007
|
+
* @param {*} [options] Override http request option.
|
|
47008
|
+
* @throws {RequiredError}
|
|
47009
|
+
*/
|
|
47010
|
+
priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: any): AxiosPromise<PriceBasketAnswerDto>;
|
|
47011
|
+
};
|
|
47012
|
+
/**
|
|
47013
|
+
* PromotionsApi - interface
|
|
47014
|
+
* @export
|
|
47015
|
+
* @interface PromotionsApi
|
|
47016
|
+
*/
|
|
47017
|
+
export interface PromotionsApiInterface {
|
|
47018
|
+
/**
|
|
47019
|
+
* The signal that tells the till whether to price its baskets: the venue\'s automatic promotions for the POS that are running at the moment of the read. Empty: the till need not call .../promotions/price unless the order holds a coupon code. Read it again when the venue\'s DISCOUNTS sync arrives.
|
|
47020
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
47021
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
47022
|
+
* @param {*} [options] Override http request option.
|
|
47023
|
+
* @throws {RequiredError}
|
|
47024
|
+
* @memberof PromotionsApiInterface
|
|
47025
|
+
*/
|
|
47026
|
+
listAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): AxiosPromise<AutomaticPromotionsAnswerDto>;
|
|
47027
|
+
/**
|
|
47028
|
+
* The signal that tells the kiosk whether to price its baskets: the venue\'s automatic promotions for the kiosk that are running at the moment of the read. Empty: the kiosk need not call .../promotions/price unless the order holds a coupon code.
|
|
47029
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
47030
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
47031
|
+
* @param {*} [options] Override http request option.
|
|
47032
|
+
* @throws {RequiredError}
|
|
47033
|
+
* @memberof PromotionsApiInterface
|
|
47034
|
+
*/
|
|
47035
|
+
listKioskAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): AxiosPromise<AutomaticPromotionsAnswerDto>;
|
|
47036
|
+
/**
|
|
47037
|
+
* Vendure prices the basket as the online store prices a cart: the venue\'s automatic promotions for the POS and the order type, and the basket\'s coupon codes, and answers each discount with the money it takes off. Nothing is stored, reserved or counted. Ask only when the venue has automatic promotions running (GET .../promotions/automatic) or the order holds a coupon code, again whenever the basket changes, and keep the newest answer. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
47038
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
47039
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
47040
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
47041
|
+
* @param {*} [options] Override http request option.
|
|
47042
|
+
* @throws {RequiredError}
|
|
47043
|
+
* @memberof PromotionsApiInterface
|
|
47044
|
+
*/
|
|
47045
|
+
priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): AxiosPromise<PriceBasketAnswerDto>;
|
|
47046
|
+
/**
|
|
47047
|
+
* The kiosk\'s pricing, with the kiosk\'s key: the same pricing as the till\'s, for the kiosk app. Vendure prices the basket with the venue\'s automatic promotions and the basket\'s coupon codes and answers each discount with the money it takes off; nothing is stored, reserved or counted. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
47048
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
47049
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
47050
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
47051
|
+
* @param {*} [options] Override http request option.
|
|
47052
|
+
* @throws {RequiredError}
|
|
47053
|
+
* @memberof PromotionsApiInterface
|
|
47054
|
+
*/
|
|
47055
|
+
priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): AxiosPromise<PriceBasketAnswerDto>;
|
|
47056
|
+
}
|
|
47057
|
+
/**
|
|
47058
|
+
* PromotionsApi - object-oriented interface
|
|
47059
|
+
* @export
|
|
47060
|
+
* @class PromotionsApi
|
|
47061
|
+
* @extends {BaseAPI}
|
|
47062
|
+
*/
|
|
47063
|
+
export declare class PromotionsApi extends BaseAPI implements PromotionsApiInterface {
|
|
47064
|
+
/**
|
|
47065
|
+
* The signal that tells the till whether to price its baskets: the venue\'s automatic promotions for the POS that are running at the moment of the read. Empty: the till need not call .../promotions/price unless the order holds a coupon code. Read it again when the venue\'s DISCOUNTS sync arrives.
|
|
47066
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
47067
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
47068
|
+
* @param {*} [options] Override http request option.
|
|
47069
|
+
* @throws {RequiredError}
|
|
47070
|
+
* @memberof PromotionsApi
|
|
47071
|
+
*/
|
|
47072
|
+
listAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AutomaticPromotionsAnswerDto, any, {}>>;
|
|
47073
|
+
/**
|
|
47074
|
+
* The signal that tells the kiosk whether to price its baskets: the venue\'s automatic promotions for the kiosk that are running at the moment of the read. Empty: the kiosk need not call .../promotions/price unless the order holds a coupon code.
|
|
47075
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
47076
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
47077
|
+
* @param {*} [options] Override http request option.
|
|
47078
|
+
* @throws {RequiredError}
|
|
47079
|
+
* @memberof PromotionsApi
|
|
47080
|
+
*/
|
|
47081
|
+
listKioskAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AutomaticPromotionsAnswerDto, any, {}>>;
|
|
47082
|
+
/**
|
|
47083
|
+
* Vendure prices the basket as the online store prices a cart: the venue\'s automatic promotions for the POS and the order type, and the basket\'s coupon codes, and answers each discount with the money it takes off. Nothing is stored, reserved or counted. Ask only when the venue has automatic promotions running (GET .../promotions/automatic) or the order holds a coupon code, again whenever the basket changes, and keep the newest answer. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
47084
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
47085
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
47086
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
47087
|
+
* @param {*} [options] Override http request option.
|
|
47088
|
+
* @throws {RequiredError}
|
|
47089
|
+
* @memberof PromotionsApi
|
|
47090
|
+
*/
|
|
47091
|
+
priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PriceBasketAnswerDto, any, {}>>;
|
|
47092
|
+
/**
|
|
47093
|
+
* The kiosk\'s pricing, with the kiosk\'s key: the same pricing as the till\'s, for the kiosk app. Vendure prices the basket with the venue\'s automatic promotions and the basket\'s coupon codes and answers each discount with the money it takes off; nothing is stored, reserved or counted. Vendure not answering within 2 seconds is answered 200 with priced false and reason UNAVAILABLE.
|
|
47094
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
47095
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
47096
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
47097
|
+
* @param {*} [options] Override http request option.
|
|
47098
|
+
* @throws {RequiredError}
|
|
47099
|
+
* @memberof PromotionsApi
|
|
47100
|
+
*/
|
|
47101
|
+
priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PriceBasketAnswerDto, any, {}>>;
|
|
47102
|
+
}
|
|
45859
47103
|
/**
|
|
45860
47104
|
* ProviderApi - axios parameter creator
|
|
45861
47105
|
* @export
|
|
@@ -47245,6 +48489,326 @@ export declare class ReportV6Api extends BaseAPI implements ReportV6ApiInterface
|
|
|
47245
48489
|
*/
|
|
47246
48490
|
sendEndOfDayReportForTill(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
47247
48491
|
}
|
|
48492
|
+
/**
|
|
48493
|
+
* ResQApi - axios parameter creator
|
|
48494
|
+
* @export
|
|
48495
|
+
*/
|
|
48496
|
+
export declare const ResQApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
48497
|
+
/**
|
|
48498
|
+
* 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.
|
|
48499
|
+
* @summary Change a venue\'s ResQ offer
|
|
48500
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48501
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48502
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
48503
|
+
* @param {*} [options] Override http request option.
|
|
48504
|
+
* @throws {RequiredError}
|
|
48505
|
+
*/
|
|
48506
|
+
changeResQOffer: (businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48507
|
+
/**
|
|
48508
|
+
* 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.
|
|
48509
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
48510
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48511
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
48512
|
+
* @param {*} [options] Override http request option.
|
|
48513
|
+
* @throws {RequiredError}
|
|
48514
|
+
*/
|
|
48515
|
+
createResQOffer: (businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48516
|
+
/**
|
|
48517
|
+
* 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.
|
|
48518
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
48519
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48520
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48521
|
+
* @param {*} [options] Override http request option.
|
|
48522
|
+
* @throws {RequiredError}
|
|
48523
|
+
*/
|
|
48524
|
+
deactivateResQOffer: (businessId: number, offerId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48525
|
+
/**
|
|
48526
|
+
* 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.
|
|
48527
|
+
* @summary Read one ResQ order of a venue
|
|
48528
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48529
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
48530
|
+
* @param {*} [options] Override http request option.
|
|
48531
|
+
* @throws {RequiredError}
|
|
48532
|
+
*/
|
|
48533
|
+
getResQOrder: (businessId: number, orderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48534
|
+
/**
|
|
48535
|
+
* 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.
|
|
48536
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
48537
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48538
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48539
|
+
* @param {*} [options] Override http request option.
|
|
48540
|
+
* @throws {RequiredError}
|
|
48541
|
+
*/
|
|
48542
|
+
listResQOffers: (businessId: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48543
|
+
/**
|
|
48544
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
48545
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
48546
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48547
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48548
|
+
* @param {*} [options] Override http request option.
|
|
48549
|
+
* @throws {RequiredError}
|
|
48550
|
+
*/
|
|
48551
|
+
listResQOrders: (businessId: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48552
|
+
};
|
|
48553
|
+
/**
|
|
48554
|
+
* ResQApi - functional programming interface
|
|
48555
|
+
* @export
|
|
48556
|
+
*/
|
|
48557
|
+
export declare const ResQApiFp: (configuration?: Configuration) => {
|
|
48558
|
+
/**
|
|
48559
|
+
* 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.
|
|
48560
|
+
* @summary Change a venue\'s ResQ offer
|
|
48561
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48562
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48563
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
48564
|
+
* @param {*} [options] Override http request option.
|
|
48565
|
+
* @throws {RequiredError}
|
|
48566
|
+
*/
|
|
48567
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOfferDto>>;
|
|
48568
|
+
/**
|
|
48569
|
+
* 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.
|
|
48570
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
48571
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48572
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
48573
|
+
* @param {*} [options] Override http request option.
|
|
48574
|
+
* @throws {RequiredError}
|
|
48575
|
+
*/
|
|
48576
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOfferDto>>;
|
|
48577
|
+
/**
|
|
48578
|
+
* 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.
|
|
48579
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
48580
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48581
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48582
|
+
* @param {*} [options] Override http request option.
|
|
48583
|
+
* @throws {RequiredError}
|
|
48584
|
+
*/
|
|
48585
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
48586
|
+
/**
|
|
48587
|
+
* 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.
|
|
48588
|
+
* @summary Read one ResQ order of a venue
|
|
48589
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48590
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
48591
|
+
* @param {*} [options] Override http request option.
|
|
48592
|
+
* @throws {RequiredError}
|
|
48593
|
+
*/
|
|
48594
|
+
getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOrderDto>>;
|
|
48595
|
+
/**
|
|
48596
|
+
* 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.
|
|
48597
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
48598
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48599
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48600
|
+
* @param {*} [options] Override http request option.
|
|
48601
|
+
* @throws {RequiredError}
|
|
48602
|
+
*/
|
|
48603
|
+
listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOffersPageDto>>;
|
|
48604
|
+
/**
|
|
48605
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
48606
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
48607
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48608
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48609
|
+
* @param {*} [options] Override http request option.
|
|
48610
|
+
* @throws {RequiredError}
|
|
48611
|
+
*/
|
|
48612
|
+
listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOrdersPageDto>>;
|
|
48613
|
+
};
|
|
48614
|
+
/**
|
|
48615
|
+
* ResQApi - factory interface
|
|
48616
|
+
* @export
|
|
48617
|
+
*/
|
|
48618
|
+
export declare const ResQApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
48619
|
+
/**
|
|
48620
|
+
* 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.
|
|
48621
|
+
* @summary Change a venue\'s ResQ offer
|
|
48622
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48623
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48624
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
48625
|
+
* @param {*} [options] Override http request option.
|
|
48626
|
+
* @throws {RequiredError}
|
|
48627
|
+
*/
|
|
48628
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: any): AxiosPromise<ResQOfferDto>;
|
|
48629
|
+
/**
|
|
48630
|
+
* 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.
|
|
48631
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
48632
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48633
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
48634
|
+
* @param {*} [options] Override http request option.
|
|
48635
|
+
* @throws {RequiredError}
|
|
48636
|
+
*/
|
|
48637
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: any): AxiosPromise<ResQOfferDto>;
|
|
48638
|
+
/**
|
|
48639
|
+
* 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.
|
|
48640
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
48641
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48642
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48643
|
+
* @param {*} [options] Override http request option.
|
|
48644
|
+
* @throws {RequiredError}
|
|
48645
|
+
*/
|
|
48646
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: any): AxiosPromise<void>;
|
|
48647
|
+
/**
|
|
48648
|
+
* 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.
|
|
48649
|
+
* @summary Read one ResQ order of a venue
|
|
48650
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48651
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
48652
|
+
* @param {*} [options] Override http request option.
|
|
48653
|
+
* @throws {RequiredError}
|
|
48654
|
+
*/
|
|
48655
|
+
getResQOrder(businessId: number, orderId: string, options?: any): AxiosPromise<ResQOrderDto>;
|
|
48656
|
+
/**
|
|
48657
|
+
* 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.
|
|
48658
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
48659
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48660
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48661
|
+
* @param {*} [options] Override http request option.
|
|
48662
|
+
* @throws {RequiredError}
|
|
48663
|
+
*/
|
|
48664
|
+
listResQOffers(businessId: number, page?: number, options?: any): AxiosPromise<ResQOffersPageDto>;
|
|
48665
|
+
/**
|
|
48666
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
48667
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
48668
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48669
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48670
|
+
* @param {*} [options] Override http request option.
|
|
48671
|
+
* @throws {RequiredError}
|
|
48672
|
+
*/
|
|
48673
|
+
listResQOrders(businessId: number, page?: number, options?: any): AxiosPromise<ResQOrdersPageDto>;
|
|
48674
|
+
};
|
|
48675
|
+
/**
|
|
48676
|
+
* ResQApi - interface
|
|
48677
|
+
* @export
|
|
48678
|
+
* @interface ResQApi
|
|
48679
|
+
*/
|
|
48680
|
+
export interface ResQApiInterface {
|
|
48681
|
+
/**
|
|
48682
|
+
* 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.
|
|
48683
|
+
* @summary Change a venue\'s ResQ offer
|
|
48684
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48685
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48686
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
48687
|
+
* @param {*} [options] Override http request option.
|
|
48688
|
+
* @throws {RequiredError}
|
|
48689
|
+
* @memberof ResQApiInterface
|
|
48690
|
+
*/
|
|
48691
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig): AxiosPromise<ResQOfferDto>;
|
|
48692
|
+
/**
|
|
48693
|
+
* 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.
|
|
48694
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
48695
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48696
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
48697
|
+
* @param {*} [options] Override http request option.
|
|
48698
|
+
* @throws {RequiredError}
|
|
48699
|
+
* @memberof ResQApiInterface
|
|
48700
|
+
*/
|
|
48701
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig): AxiosPromise<ResQOfferDto>;
|
|
48702
|
+
/**
|
|
48703
|
+
* 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.
|
|
48704
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
48705
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48706
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48707
|
+
* @param {*} [options] Override http request option.
|
|
48708
|
+
* @throws {RequiredError}
|
|
48709
|
+
* @memberof ResQApiInterface
|
|
48710
|
+
*/
|
|
48711
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
48712
|
+
/**
|
|
48713
|
+
* 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.
|
|
48714
|
+
* @summary Read one ResQ order of a venue
|
|
48715
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48716
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
48717
|
+
* @param {*} [options] Override http request option.
|
|
48718
|
+
* @throws {RequiredError}
|
|
48719
|
+
* @memberof ResQApiInterface
|
|
48720
|
+
*/
|
|
48721
|
+
getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig): AxiosPromise<ResQOrderDto>;
|
|
48722
|
+
/**
|
|
48723
|
+
* 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.
|
|
48724
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
48725
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48726
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48727
|
+
* @param {*} [options] Override http request option.
|
|
48728
|
+
* @throws {RequiredError}
|
|
48729
|
+
* @memberof ResQApiInterface
|
|
48730
|
+
*/
|
|
48731
|
+
listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig): AxiosPromise<ResQOffersPageDto>;
|
|
48732
|
+
/**
|
|
48733
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
48734
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
48735
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48736
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48737
|
+
* @param {*} [options] Override http request option.
|
|
48738
|
+
* @throws {RequiredError}
|
|
48739
|
+
* @memberof ResQApiInterface
|
|
48740
|
+
*/
|
|
48741
|
+
listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig): AxiosPromise<ResQOrdersPageDto>;
|
|
48742
|
+
}
|
|
48743
|
+
/**
|
|
48744
|
+
* ResQApi - object-oriented interface
|
|
48745
|
+
* @export
|
|
48746
|
+
* @class ResQApi
|
|
48747
|
+
* @extends {BaseAPI}
|
|
48748
|
+
*/
|
|
48749
|
+
export declare class ResQApi extends BaseAPI implements ResQApiInterface {
|
|
48750
|
+
/**
|
|
48751
|
+
* 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.
|
|
48752
|
+
* @summary Change a venue\'s ResQ offer
|
|
48753
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48754
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48755
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
48756
|
+
* @param {*} [options] Override http request option.
|
|
48757
|
+
* @throws {RequiredError}
|
|
48758
|
+
* @memberof ResQApi
|
|
48759
|
+
*/
|
|
48760
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResQOfferDto, any, {}>>;
|
|
48761
|
+
/**
|
|
48762
|
+
* 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.
|
|
48763
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
48764
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48765
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
48766
|
+
* @param {*} [options] Override http request option.
|
|
48767
|
+
* @throws {RequiredError}
|
|
48768
|
+
* @memberof ResQApi
|
|
48769
|
+
*/
|
|
48770
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResQOfferDto, any, {}>>;
|
|
48771
|
+
/**
|
|
48772
|
+
* 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.
|
|
48773
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
48774
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48775
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48776
|
+
* @param {*} [options] Override http request option.
|
|
48777
|
+
* @throws {RequiredError}
|
|
48778
|
+
* @memberof ResQApi
|
|
48779
|
+
*/
|
|
48780
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
48781
|
+
/**
|
|
48782
|
+
* 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.
|
|
48783
|
+
* @summary Read one ResQ order of a venue
|
|
48784
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48785
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
48786
|
+
* @param {*} [options] Override http request option.
|
|
48787
|
+
* @throws {RequiredError}
|
|
48788
|
+
* @memberof ResQApi
|
|
48789
|
+
*/
|
|
48790
|
+
getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResQOrderDto, any, {}>>;
|
|
48791
|
+
/**
|
|
48792
|
+
* 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.
|
|
48793
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
48794
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48795
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48796
|
+
* @param {*} [options] Override http request option.
|
|
48797
|
+
* @throws {RequiredError}
|
|
48798
|
+
* @memberof ResQApi
|
|
48799
|
+
*/
|
|
48800
|
+
listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResQOffersPageDto, any, {}>>;
|
|
48801
|
+
/**
|
|
48802
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
48803
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
48804
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48805
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48806
|
+
* @param {*} [options] Override http request option.
|
|
48807
|
+
* @throws {RequiredError}
|
|
48808
|
+
* @memberof ResQApi
|
|
48809
|
+
*/
|
|
48810
|
+
listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResQOrdersPageDto, any, {}>>;
|
|
48811
|
+
}
|
|
47248
48812
|
/**
|
|
47249
48813
|
* ReservationsApi - axios parameter creator
|
|
47250
48814
|
* @export
|