@munchi_oy/core 2.0.7 → 2.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/api.d.ts +1084 -20
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +1475 -20
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -2443,6 +2443,55 @@ export interface ChangePosOrdersStatusInBulkResponseDto {
|
|
|
2443
2443
|
*/
|
|
2444
2444
|
'skipped': Array<PosOrderLeftAsItIsDto>;
|
|
2445
2445
|
}
|
|
2446
|
+
/**
|
|
2447
|
+
*
|
|
2448
|
+
* @export
|
|
2449
|
+
* @interface ChangeResQOfferDto
|
|
2450
|
+
*/
|
|
2451
|
+
export interface ChangeResQOfferDto {
|
|
2452
|
+
/**
|
|
2453
|
+
* The offer\'s new name. Left out, the name stays
|
|
2454
|
+
* @type {string}
|
|
2455
|
+
* @memberof ChangeResQOfferDto
|
|
2456
|
+
*/
|
|
2457
|
+
'name'?: string;
|
|
2458
|
+
/**
|
|
2459
|
+
* The offer\'s new description. Left out, the description stays
|
|
2460
|
+
* @type {string}
|
|
2461
|
+
* @memberof ChangeResQOfferDto
|
|
2462
|
+
*/
|
|
2463
|
+
'description'?: string;
|
|
2464
|
+
/**
|
|
2465
|
+
* How many are for sale from now on. Left out, the quantity stays
|
|
2466
|
+
* @type {number}
|
|
2467
|
+
* @memberof ChangeResQOfferDto
|
|
2468
|
+
*/
|
|
2469
|
+
'quantity'?: number;
|
|
2470
|
+
/**
|
|
2471
|
+
* When ordering starts, an ISO 8601 date-time. Left out, it stays
|
|
2472
|
+
* @type {string}
|
|
2473
|
+
* @memberof ChangeResQOfferDto
|
|
2474
|
+
*/
|
|
2475
|
+
'orderStart'?: string;
|
|
2476
|
+
/**
|
|
2477
|
+
* When ordering ends, an ISO 8601 date-time. Left out, it stays
|
|
2478
|
+
* @type {string}
|
|
2479
|
+
* @memberof ChangeResQOfferDto
|
|
2480
|
+
*/
|
|
2481
|
+
'orderEnd'?: string;
|
|
2482
|
+
/**
|
|
2483
|
+
* When pick-up starts, an ISO 8601 date-time. Left out, it stays
|
|
2484
|
+
* @type {string}
|
|
2485
|
+
* @memberof ChangeResQOfferDto
|
|
2486
|
+
*/
|
|
2487
|
+
'fetchStart'?: string;
|
|
2488
|
+
/**
|
|
2489
|
+
* When pick-up ends, an ISO 8601 date-time. Left out, it stays
|
|
2490
|
+
* @type {string}
|
|
2491
|
+
* @memberof ChangeResQOfferDto
|
|
2492
|
+
*/
|
|
2493
|
+
'fetchEnd'?: string;
|
|
2494
|
+
}
|
|
2446
2495
|
/**
|
|
2447
2496
|
*
|
|
2448
2497
|
* @export
|
|
@@ -2712,6 +2761,37 @@ export interface CheckActionPasscodeDto {
|
|
|
2712
2761
|
*/
|
|
2713
2762
|
'key': PosPermission;
|
|
2714
2763
|
}
|
|
2764
|
+
/**
|
|
2765
|
+
*
|
|
2766
|
+
* @export
|
|
2767
|
+
* @interface CheckCouponDto
|
|
2768
|
+
*/
|
|
2769
|
+
export interface CheckCouponDto {
|
|
2770
|
+
/**
|
|
2771
|
+
* The coupon\'s code, as typed or scanned, in any letter case
|
|
2772
|
+
* @type {string}
|
|
2773
|
+
* @memberof CheckCouponDto
|
|
2774
|
+
*/
|
|
2775
|
+
'couponCode': string;
|
|
2776
|
+
/**
|
|
2777
|
+
*
|
|
2778
|
+
* @type {OrderTypePOS}
|
|
2779
|
+
* @memberof CheckCouponDto
|
|
2780
|
+
*/
|
|
2781
|
+
'orderType': OrderTypePOS;
|
|
2782
|
+
/**
|
|
2783
|
+
* 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.
|
|
2784
|
+
* @type {string}
|
|
2785
|
+
* @memberof CheckCouponDto
|
|
2786
|
+
*/
|
|
2787
|
+
'customerPhone'?: string;
|
|
2788
|
+
/**
|
|
2789
|
+
* The order\'s lines as they stand; checked again whenever the basket changes
|
|
2790
|
+
* @type {Array<CouponBasketLineDto>}
|
|
2791
|
+
* @memberof CheckCouponDto
|
|
2792
|
+
*/
|
|
2793
|
+
'lines': Array<CouponBasketLineDto>;
|
|
2794
|
+
}
|
|
2715
2795
|
/**
|
|
2716
2796
|
*
|
|
2717
2797
|
* @export
|
|
@@ -3260,6 +3340,186 @@ export interface CoordinateDto {
|
|
|
3260
3340
|
*/
|
|
3261
3341
|
'lon': number;
|
|
3262
3342
|
}
|
|
3343
|
+
/**
|
|
3344
|
+
*
|
|
3345
|
+
* @export
|
|
3346
|
+
* @interface CouponBasketLineDto
|
|
3347
|
+
*/
|
|
3348
|
+
export interface CouponBasketLineDto {
|
|
3349
|
+
/**
|
|
3350
|
+
* The line\'s stable id, the one the order\'s discounts point at
|
|
3351
|
+
* @type {string}
|
|
3352
|
+
* @memberof CouponBasketLineDto
|
|
3353
|
+
*/
|
|
3354
|
+
'lineItemId': string;
|
|
3355
|
+
/**
|
|
3356
|
+
* The product\'s Vendure id: the line\'s posId, as a number
|
|
3357
|
+
* @type {number}
|
|
3358
|
+
* @memberof CouponBasketLineDto
|
|
3359
|
+
*/
|
|
3360
|
+
'productId': number;
|
|
3361
|
+
/**
|
|
3362
|
+
* How many of the product the line holds, a whole number
|
|
3363
|
+
* @type {number}
|
|
3364
|
+
* @memberof CouponBasketLineDto
|
|
3365
|
+
*/
|
|
3366
|
+
'quantity': number;
|
|
3367
|
+
/**
|
|
3368
|
+
* The price of one unit as the till charges it, options included, in cents
|
|
3369
|
+
* @type {number}
|
|
3370
|
+
* @memberof CouponBasketLineDto
|
|
3371
|
+
*/
|
|
3372
|
+
'unitAmount': number;
|
|
3373
|
+
/**
|
|
3374
|
+
* 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
|
|
3375
|
+
* @type {number}
|
|
3376
|
+
* @memberof CouponBasketLineDto
|
|
3377
|
+
*/
|
|
3378
|
+
'vatRate'?: number;
|
|
3379
|
+
}
|
|
3380
|
+
/**
|
|
3381
|
+
*
|
|
3382
|
+
* @export
|
|
3383
|
+
* @interface CouponCheckAnswerDto
|
|
3384
|
+
*/
|
|
3385
|
+
export interface CouponCheckAnswerDto {
|
|
3386
|
+
/**
|
|
3387
|
+
* true when the coupon applies to this basket; false when it does not
|
|
3388
|
+
* @type {boolean}
|
|
3389
|
+
* @memberof CouponCheckAnswerDto
|
|
3390
|
+
*/
|
|
3391
|
+
'valid': boolean;
|
|
3392
|
+
/**
|
|
3393
|
+
* The discounts to add to the order, one per application; empty when valid is false
|
|
3394
|
+
* @type {Array<CouponDiscountDto>}
|
|
3395
|
+
* @memberof CouponCheckAnswerDto
|
|
3396
|
+
*/
|
|
3397
|
+
'discounts': Array<CouponDiscountDto>;
|
|
3398
|
+
/**
|
|
3399
|
+
* 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
|
|
3400
|
+
* @type {Array<CouponRewardNotAppliedDto>}
|
|
3401
|
+
* @memberof CouponCheckAnswerDto
|
|
3402
|
+
*/
|
|
3403
|
+
'notApplied': Array<CouponRewardNotAppliedDto>;
|
|
3404
|
+
/**
|
|
3405
|
+
*
|
|
3406
|
+
* @type {CouponRefusal}
|
|
3407
|
+
* @memberof CouponCheckAnswerDto
|
|
3408
|
+
*/
|
|
3409
|
+
'reason': CouponRefusal | null;
|
|
3410
|
+
/**
|
|
3411
|
+
* What to tell the person at the till or the kiosk; null when valid is true
|
|
3412
|
+
* @type {string}
|
|
3413
|
+
* @memberof CouponCheckAnswerDto
|
|
3414
|
+
*/
|
|
3415
|
+
'message': string | null;
|
|
3416
|
+
}
|
|
3417
|
+
/**
|
|
3418
|
+
*
|
|
3419
|
+
* @export
|
|
3420
|
+
* @interface CouponDiscountDto
|
|
3421
|
+
*/
|
|
3422
|
+
export interface CouponDiscountDto {
|
|
3423
|
+
/**
|
|
3424
|
+
*
|
|
3425
|
+
* @type {DiscountType}
|
|
3426
|
+
* @memberof CouponDiscountDto
|
|
3427
|
+
*/
|
|
3428
|
+
'type': DiscountType;
|
|
3429
|
+
/**
|
|
3430
|
+
* A percentage for PERCENTAGE (10 is 10%), cents for FIXED
|
|
3431
|
+
* @type {number}
|
|
3432
|
+
* @memberof CouponDiscountDto
|
|
3433
|
+
*/
|
|
3434
|
+
'value': number;
|
|
3435
|
+
/**
|
|
3436
|
+
*
|
|
3437
|
+
* @type {DiscountScope}
|
|
3438
|
+
* @memberof CouponDiscountDto
|
|
3439
|
+
*/
|
|
3440
|
+
'scope': DiscountScope;
|
|
3441
|
+
/**
|
|
3442
|
+
* The line it discounts, for an ITEM discount; null for a CART discount
|
|
3443
|
+
* @type {string}
|
|
3444
|
+
* @memberof CouponDiscountDto
|
|
3445
|
+
*/
|
|
3446
|
+
'lineItemId': string | null;
|
|
3447
|
+
/**
|
|
3448
|
+
* How many units of the line it covers; absent means the whole line
|
|
3449
|
+
* @type {number}
|
|
3450
|
+
* @memberof CouponDiscountDto
|
|
3451
|
+
*/
|
|
3452
|
+
'units'?: number;
|
|
3453
|
+
/**
|
|
3454
|
+
*
|
|
3455
|
+
* @type {DiscountSourceType}
|
|
3456
|
+
* @memberof CouponDiscountDto
|
|
3457
|
+
*/
|
|
3458
|
+
'sourceType': DiscountSourceType;
|
|
3459
|
+
/**
|
|
3460
|
+
* The Vendure promotion\'s id, as text
|
|
3461
|
+
* @type {string}
|
|
3462
|
+
* @memberof CouponDiscountDto
|
|
3463
|
+
*/
|
|
3464
|
+
'sourceId': string;
|
|
3465
|
+
/**
|
|
3466
|
+
* The coupon\'s code, as the promotion holds it
|
|
3467
|
+
* @type {string}
|
|
3468
|
+
* @memberof CouponDiscountDto
|
|
3469
|
+
*/
|
|
3470
|
+
'couponCode': string;
|
|
3471
|
+
/**
|
|
3472
|
+
* The promotion\'s name, shown on the till and the receipt
|
|
3473
|
+
* @type {string}
|
|
3474
|
+
* @memberof CouponDiscountDto
|
|
3475
|
+
*/
|
|
3476
|
+
'name': string;
|
|
3477
|
+
/**
|
|
3478
|
+
* 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
|
|
3479
|
+
* @type {string}
|
|
3480
|
+
* @memberof CouponDiscountDto
|
|
3481
|
+
*/
|
|
3482
|
+
'couponCustomerPhone'?: string;
|
|
3483
|
+
}
|
|
3484
|
+
/**
|
|
3485
|
+
*
|
|
3486
|
+
* @export
|
|
3487
|
+
* @enum {string}
|
|
3488
|
+
*/
|
|
3489
|
+
export declare const CouponRefusal: {
|
|
3490
|
+
readonly NotFound: "NOT_FOUND";
|
|
3491
|
+
readonly NotStarted: "NOT_STARTED";
|
|
3492
|
+
readonly Expired: "EXPIRED";
|
|
3493
|
+
readonly Disabled: "DISABLED";
|
|
3494
|
+
readonly NotForThisApp: "NOT_FOR_THIS_APP";
|
|
3495
|
+
readonly NotForThisOrderType: "NOT_FOR_THIS_ORDER_TYPE";
|
|
3496
|
+
readonly ConditionsNotMet: "CONDITIONS_NOT_MET";
|
|
3497
|
+
readonly UsageLimitReached: "USAGE_LIMIT_REACHED";
|
|
3498
|
+
readonly CustomerLimitReached: "CUSTOMER_LIMIT_REACHED";
|
|
3499
|
+
readonly NotFirstOrder: "NOT_FIRST_ORDER";
|
|
3500
|
+
readonly CustomerPhoneRequired: "CUSTOMER_PHONE_REQUIRED";
|
|
3501
|
+
readonly CouponsUnavailable: "COUPONS_UNAVAILABLE";
|
|
3502
|
+
};
|
|
3503
|
+
export type CouponRefusal = typeof CouponRefusal[keyof typeof CouponRefusal];
|
|
3504
|
+
/**
|
|
3505
|
+
*
|
|
3506
|
+
* @export
|
|
3507
|
+
* @interface CouponRewardNotAppliedDto
|
|
3508
|
+
*/
|
|
3509
|
+
export interface CouponRewardNotAppliedDto {
|
|
3510
|
+
/**
|
|
3511
|
+
* The promotion\'s reward that was left out, in Vendure\'s words
|
|
3512
|
+
* @type {string}
|
|
3513
|
+
* @memberof CouponRewardNotAppliedDto
|
|
3514
|
+
*/
|
|
3515
|
+
'reward': string;
|
|
3516
|
+
/**
|
|
3517
|
+
* Why Vendure left it out
|
|
3518
|
+
* @type {string}
|
|
3519
|
+
* @memberof CouponRewardNotAppliedDto
|
|
3520
|
+
*/
|
|
3521
|
+
'reason': string;
|
|
3522
|
+
}
|
|
3263
3523
|
/**
|
|
3264
3524
|
*
|
|
3265
3525
|
* @export
|
|
@@ -4153,13 +4413,13 @@ export interface CreateOnboardingSessionDto {
|
|
|
4153
4413
|
*/
|
|
4154
4414
|
export interface CreatePaymentMethodDto {
|
|
4155
4415
|
/**
|
|
4156
|
-
* Attach
|
|
4416
|
+
* Attach a built-in method, or one of the venue\'s own custom methods, by its code (mutually exclusive with name+type).
|
|
4157
4417
|
* @type {string}
|
|
4158
4418
|
* @memberof CreatePaymentMethodDto
|
|
4159
4419
|
*/
|
|
4160
4420
|
'code'?: string;
|
|
4161
4421
|
/**
|
|
4162
|
-
* Display name for a new custom method; required with type when code is absent.
|
|
4422
|
+
* Display name for a new custom method of this venue only; required with type when code is absent.
|
|
4163
4423
|
* @type {string}
|
|
4164
4424
|
* @memberof CreatePaymentMethodDto
|
|
4165
4425
|
*/
|
|
@@ -4306,6 +4566,73 @@ export interface CreateRefundPlanDto {
|
|
|
4306
4566
|
*/
|
|
4307
4567
|
'lineItems'?: Array<RefundRequestItemDto>;
|
|
4308
4568
|
}
|
|
4569
|
+
/**
|
|
4570
|
+
*
|
|
4571
|
+
* @export
|
|
4572
|
+
* @interface CreateResQOfferDto
|
|
4573
|
+
*/
|
|
4574
|
+
export interface CreateResQOfferDto {
|
|
4575
|
+
/**
|
|
4576
|
+
* The offer\'s name, as ResQ\'s customers see it
|
|
4577
|
+
* @type {string}
|
|
4578
|
+
* @memberof CreateResQOfferDto
|
|
4579
|
+
*/
|
|
4580
|
+
'name': string;
|
|
4581
|
+
/**
|
|
4582
|
+
* What the offer holds, as ResQ\'s customers see it. Left out, the offer has none
|
|
4583
|
+
* @type {string}
|
|
4584
|
+
* @memberof CreateResQOfferDto
|
|
4585
|
+
*/
|
|
4586
|
+
'description'?: string;
|
|
4587
|
+
/**
|
|
4588
|
+
* An https address of the offer\'s picture. Left out, ResQ shows none
|
|
4589
|
+
* @type {string}
|
|
4590
|
+
* @memberof CreateResQOfferDto
|
|
4591
|
+
*/
|
|
4592
|
+
'imageUrl'?: string;
|
|
4593
|
+
/**
|
|
4594
|
+
* 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
|
|
4595
|
+
* @type {number}
|
|
4596
|
+
* @memberof CreateResQOfferDto
|
|
4597
|
+
*/
|
|
4598
|
+
'price': number;
|
|
4599
|
+
/**
|
|
4600
|
+
* How many are for sale
|
|
4601
|
+
* @type {number}
|
|
4602
|
+
* @memberof CreateResQOfferDto
|
|
4603
|
+
*/
|
|
4604
|
+
'quantity': number;
|
|
4605
|
+
/**
|
|
4606
|
+
* When customers can start ordering it, an ISO 8601 date-time
|
|
4607
|
+
* @type {string}
|
|
4608
|
+
* @memberof CreateResQOfferDto
|
|
4609
|
+
*/
|
|
4610
|
+
'orderStart': string;
|
|
4611
|
+
/**
|
|
4612
|
+
* When ordering it ends, an ISO 8601 date-time
|
|
4613
|
+
* @type {string}
|
|
4614
|
+
* @memberof CreateResQOfferDto
|
|
4615
|
+
*/
|
|
4616
|
+
'orderEnd': string;
|
|
4617
|
+
/**
|
|
4618
|
+
* When customers can start picking it up at the venue, an ISO 8601 date-time
|
|
4619
|
+
* @type {string}
|
|
4620
|
+
* @memberof CreateResQOfferDto
|
|
4621
|
+
*/
|
|
4622
|
+
'fetchStart': string;
|
|
4623
|
+
/**
|
|
4624
|
+
* When pick-up ends, an ISO 8601 date-time
|
|
4625
|
+
* @type {string}
|
|
4626
|
+
* @memberof CreateResQOfferDto
|
|
4627
|
+
*/
|
|
4628
|
+
'fetchEnd': string;
|
|
4629
|
+
/**
|
|
4630
|
+
* The kinds of offer ResQ files it under, at least one
|
|
4631
|
+
* @type {Array<ResQOfferTag>}
|
|
4632
|
+
* @memberof CreateResQOfferDto
|
|
4633
|
+
*/
|
|
4634
|
+
'tags': Array<ResQOfferTag>;
|
|
4635
|
+
}
|
|
4309
4636
|
/**
|
|
4310
4637
|
*
|
|
4311
4638
|
* @export
|
|
@@ -5990,7 +6317,7 @@ export interface DispatchPosOrderResponseDto {
|
|
|
5990
6317
|
*/
|
|
5991
6318
|
'ticketId': object | null;
|
|
5992
6319
|
/**
|
|
5993
|
-
* Number of that ticket:
|
|
6320
|
+
* Number of that ticket: its order\'s own number. null when no ticket was written.
|
|
5994
6321
|
* @type {object}
|
|
5995
6322
|
* @memberof DispatchPosOrderResponseDto
|
|
5996
6323
|
*/
|
|
@@ -15751,7 +16078,7 @@ export interface ParkPosOrderResponseDto {
|
|
|
15751
16078
|
*/
|
|
15752
16079
|
'ticketId': object | null;
|
|
15753
16080
|
/**
|
|
15754
|
-
* Number of that ticket:
|
|
16081
|
+
* Number of that ticket: its order\'s own number. null when no ticket was written.
|
|
15755
16082
|
* @type {object}
|
|
15756
16083
|
* @memberof ParkPosOrderResponseDto
|
|
15757
16084
|
*/
|
|
@@ -17670,6 +17997,16 @@ export interface PaymentStatusDtoTransaction {
|
|
|
17670
17997
|
*/
|
|
17671
17998
|
'fees'?: TransactionDtoFees | null;
|
|
17672
17999
|
}
|
|
18000
|
+
/**
|
|
18001
|
+
*
|
|
18002
|
+
* @export
|
|
18003
|
+
* @enum {string}
|
|
18004
|
+
*/
|
|
18005
|
+
export declare const PaymentSurchargePaidBy: {
|
|
18006
|
+
readonly Business: "BUSINESS";
|
|
18007
|
+
readonly Customer: "CUSTOMER";
|
|
18008
|
+
};
|
|
18009
|
+
export type PaymentSurchargePaidBy = typeof PaymentSurchargePaidBy[keyof typeof PaymentSurchargePaidBy];
|
|
17673
18010
|
/**
|
|
17674
18011
|
*
|
|
17675
18012
|
* @export
|
|
@@ -18239,6 +18576,18 @@ export interface PosDiscountDto {
|
|
|
18239
18576
|
* @memberof PosDiscountDto
|
|
18240
18577
|
*/
|
|
18241
18578
|
'units'?: number;
|
|
18579
|
+
/**
|
|
18580
|
+
* 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.
|
|
18581
|
+
* @type {string}
|
|
18582
|
+
* @memberof PosDiscountDto
|
|
18583
|
+
*/
|
|
18584
|
+
'couponCode'?: string;
|
|
18585
|
+
/**
|
|
18586
|
+
* 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.
|
|
18587
|
+
* @type {string}
|
|
18588
|
+
* @memberof PosDiscountDto
|
|
18589
|
+
*/
|
|
18590
|
+
'couponCustomerPhone'?: string;
|
|
18242
18591
|
}
|
|
18243
18592
|
/**
|
|
18244
18593
|
* 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 +20450,18 @@ export interface PosOrderItemDtoDiscount {
|
|
|
20101
20450
|
* @memberof PosOrderItemDtoDiscount
|
|
20102
20451
|
*/
|
|
20103
20452
|
'units'?: number;
|
|
20453
|
+
/**
|
|
20454
|
+
* 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.
|
|
20455
|
+
* @type {string}
|
|
20456
|
+
* @memberof PosOrderItemDtoDiscount
|
|
20457
|
+
*/
|
|
20458
|
+
'couponCode'?: string;
|
|
20459
|
+
/**
|
|
20460
|
+
* 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.
|
|
20461
|
+
* @type {string}
|
|
20462
|
+
* @memberof PosOrderItemDtoDiscount
|
|
20463
|
+
*/
|
|
20464
|
+
'couponCustomerPhone'?: string;
|
|
20104
20465
|
}
|
|
20105
20466
|
/**
|
|
20106
20467
|
* Reporting category details
|
|
@@ -23632,6 +23993,250 @@ export interface RequestSessionTokenResponseDto {
|
|
|
23632
23993
|
*/
|
|
23633
23994
|
'sessionChannel': string;
|
|
23634
23995
|
}
|
|
23996
|
+
/**
|
|
23997
|
+
*
|
|
23998
|
+
* @export
|
|
23999
|
+
* @interface ResQOfferDto
|
|
24000
|
+
*/
|
|
24001
|
+
export interface ResQOfferDto {
|
|
24002
|
+
/**
|
|
24003
|
+
* The offer\'s id at ResQ
|
|
24004
|
+
* @type {string}
|
|
24005
|
+
* @memberof ResQOfferDto
|
|
24006
|
+
*/
|
|
24007
|
+
'id': string;
|
|
24008
|
+
/**
|
|
24009
|
+
* The offer\'s name. Absent when ResQ did not send it
|
|
24010
|
+
* @type {string}
|
|
24011
|
+
* @memberof ResQOfferDto
|
|
24012
|
+
*/
|
|
24013
|
+
'name'?: string;
|
|
24014
|
+
/**
|
|
24015
|
+
* 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
|
|
24016
|
+
* @type {boolean}
|
|
24017
|
+
* @memberof ResQOfferDto
|
|
24018
|
+
*/
|
|
24019
|
+
'active'?: boolean;
|
|
24020
|
+
/**
|
|
24021
|
+
* The price of one, in cents of the venue\'s currency. Absent when ResQ did not send it
|
|
24022
|
+
* @type {number}
|
|
24023
|
+
* @memberof ResQOfferDto
|
|
24024
|
+
*/
|
|
24025
|
+
'price'?: number;
|
|
24026
|
+
/**
|
|
24027
|
+
* When ordering starts, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
24028
|
+
* @type {string}
|
|
24029
|
+
* @memberof ResQOfferDto
|
|
24030
|
+
*/
|
|
24031
|
+
'orderStart'?: string;
|
|
24032
|
+
/**
|
|
24033
|
+
* When ordering ends, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
24034
|
+
* @type {string}
|
|
24035
|
+
* @memberof ResQOfferDto
|
|
24036
|
+
*/
|
|
24037
|
+
'orderEnd'?: string;
|
|
24038
|
+
}
|
|
24039
|
+
/**
|
|
24040
|
+
*
|
|
24041
|
+
* @export
|
|
24042
|
+
* @enum {string}
|
|
24043
|
+
*/
|
|
24044
|
+
export declare const ResQOfferTag: {
|
|
24045
|
+
readonly Meal: "meal";
|
|
24046
|
+
readonly Snack: "snack";
|
|
24047
|
+
readonly Ingredients: "ingredients";
|
|
24048
|
+
readonly GroceryBag: "grocery-bag";
|
|
24049
|
+
readonly Dessert: "dessert";
|
|
24050
|
+
readonly Flowers: "flowers";
|
|
24051
|
+
readonly Fee: "fee";
|
|
24052
|
+
readonly Wholesale: "wholesale";
|
|
24053
|
+
readonly HomeCosmetics: "home-cosmetics";
|
|
24054
|
+
};
|
|
24055
|
+
export type ResQOfferTag = typeof ResQOfferTag[keyof typeof ResQOfferTag];
|
|
24056
|
+
/**
|
|
24057
|
+
*
|
|
24058
|
+
* @export
|
|
24059
|
+
* @interface ResQOffersPageDto
|
|
24060
|
+
*/
|
|
24061
|
+
export interface ResQOffersPageDto {
|
|
24062
|
+
/**
|
|
24063
|
+
* The venue\'s offers on this page, as ResQ orders them
|
|
24064
|
+
* @type {Array<ResQOfferDto>}
|
|
24065
|
+
* @memberof ResQOffersPageDto
|
|
24066
|
+
*/
|
|
24067
|
+
'offers': Array<ResQOfferDto>;
|
|
24068
|
+
/**
|
|
24069
|
+
* This page\'s number, from 1
|
|
24070
|
+
* @type {number}
|
|
24071
|
+
* @memberof ResQOffersPageDto
|
|
24072
|
+
*/
|
|
24073
|
+
'page': number;
|
|
24074
|
+
/**
|
|
24075
|
+
* How many pages there are
|
|
24076
|
+
* @type {number}
|
|
24077
|
+
* @memberof ResQOffersPageDto
|
|
24078
|
+
*/
|
|
24079
|
+
'pages': number;
|
|
24080
|
+
/**
|
|
24081
|
+
* How many offers the venue has, on every page
|
|
24082
|
+
* @type {number}
|
|
24083
|
+
* @memberof ResQOffersPageDto
|
|
24084
|
+
*/
|
|
24085
|
+
'count': number;
|
|
24086
|
+
}
|
|
24087
|
+
/**
|
|
24088
|
+
*
|
|
24089
|
+
* @export
|
|
24090
|
+
* @interface ResQOrderDto
|
|
24091
|
+
*/
|
|
24092
|
+
export interface ResQOrderDto {
|
|
24093
|
+
/**
|
|
24094
|
+
* The order\'s id at ResQ
|
|
24095
|
+
* @type {string}
|
|
24096
|
+
* @memberof ResQOrderDto
|
|
24097
|
+
*/
|
|
24098
|
+
'id': string;
|
|
24099
|
+
/**
|
|
24100
|
+
* The order\'s status in ResQ\'s own words, passed on as ResQ answered it
|
|
24101
|
+
* @type {string}
|
|
24102
|
+
* @memberof ResQOrderDto
|
|
24103
|
+
*/
|
|
24104
|
+
'status': string;
|
|
24105
|
+
/**
|
|
24106
|
+
* Whether ResQ counts the order as a sale
|
|
24107
|
+
* @type {boolean}
|
|
24108
|
+
* @memberof ResQOrderDto
|
|
24109
|
+
*/
|
|
24110
|
+
'sold': boolean;
|
|
24111
|
+
/**
|
|
24112
|
+
* The customer\'s first name; null when ResQ gave none
|
|
24113
|
+
* @type {string}
|
|
24114
|
+
* @memberof ResQOrderDto
|
|
24115
|
+
*/
|
|
24116
|
+
'customerFirstName': string | null;
|
|
24117
|
+
/**
|
|
24118
|
+
* When pick-up starts, an ISO 8601 date-time; null when ResQ gave none
|
|
24119
|
+
* @type {string}
|
|
24120
|
+
* @memberof ResQOrderDto
|
|
24121
|
+
*/
|
|
24122
|
+
'fetchStart': string | null;
|
|
24123
|
+
/**
|
|
24124
|
+
* When pick-up ends, an ISO 8601 date-time; null when ResQ gave none
|
|
24125
|
+
* @type {string}
|
|
24126
|
+
* @memberof ResQOrderDto
|
|
24127
|
+
*/
|
|
24128
|
+
'fetchEnd': string | null;
|
|
24129
|
+
/**
|
|
24130
|
+
* Whether the customer has picked the order up; null when ResQ did not say
|
|
24131
|
+
* @type {boolean}
|
|
24132
|
+
* @memberof ResQOrderDto
|
|
24133
|
+
*/
|
|
24134
|
+
'pickedUp': boolean | null;
|
|
24135
|
+
/**
|
|
24136
|
+
* When the customer picked the order up, an ISO 8601 date-time; null when not picked up or ResQ did not say
|
|
24137
|
+
* @type {string}
|
|
24138
|
+
* @memberof ResQOrderDto
|
|
24139
|
+
*/
|
|
24140
|
+
'pickedUpAt': string | null;
|
|
24141
|
+
/**
|
|
24142
|
+
* How many the customer ordered; null when ResQ gave none
|
|
24143
|
+
* @type {number}
|
|
24144
|
+
* @memberof ResQOrderDto
|
|
24145
|
+
*/
|
|
24146
|
+
'quantity': number | null;
|
|
24147
|
+
/**
|
|
24148
|
+
* What the order sold for, in cents of its currency; null when ResQ gave none
|
|
24149
|
+
* @type {number}
|
|
24150
|
+
* @memberof ResQOrderDto
|
|
24151
|
+
*/
|
|
24152
|
+
'sales': number | null;
|
|
24153
|
+
/**
|
|
24154
|
+
* The order\'s currency, an ISO 4217 code; null when ResQ gave none
|
|
24155
|
+
* @type {string}
|
|
24156
|
+
* @memberof ResQOrderDto
|
|
24157
|
+
*/
|
|
24158
|
+
'currency': string | null;
|
|
24159
|
+
}
|
|
24160
|
+
/**
|
|
24161
|
+
*
|
|
24162
|
+
* @export
|
|
24163
|
+
* @interface ResQOrderSummaryDto
|
|
24164
|
+
*/
|
|
24165
|
+
export interface ResQOrderSummaryDto {
|
|
24166
|
+
/**
|
|
24167
|
+
* The order\'s id at ResQ
|
|
24168
|
+
* @type {string}
|
|
24169
|
+
* @memberof ResQOrderSummaryDto
|
|
24170
|
+
*/
|
|
24171
|
+
'id': string;
|
|
24172
|
+
/**
|
|
24173
|
+
* The order\'s status in ResQ\'s own words, passed on as ResQ answered it
|
|
24174
|
+
* @type {string}
|
|
24175
|
+
* @memberof ResQOrderSummaryDto
|
|
24176
|
+
*/
|
|
24177
|
+
'status': string;
|
|
24178
|
+
/**
|
|
24179
|
+
* Whether ResQ counts the order as a sale
|
|
24180
|
+
* @type {boolean}
|
|
24181
|
+
* @memberof ResQOrderSummaryDto
|
|
24182
|
+
*/
|
|
24183
|
+
'sold': boolean;
|
|
24184
|
+
/**
|
|
24185
|
+
* When the customer ordered, an ISO 8601 date-time as ResQ answered it. Absent when ResQ did not send it
|
|
24186
|
+
* @type {string}
|
|
24187
|
+
* @memberof ResQOrderSummaryDto
|
|
24188
|
+
*/
|
|
24189
|
+
'createdAt'?: string;
|
|
24190
|
+
/**
|
|
24191
|
+
* How many the customer ordered. Absent when ResQ did not send it
|
|
24192
|
+
* @type {number}
|
|
24193
|
+
* @memberof ResQOrderSummaryDto
|
|
24194
|
+
*/
|
|
24195
|
+
'quantity'?: number;
|
|
24196
|
+
/**
|
|
24197
|
+
* What the order sold for, in cents of its currency. Absent when ResQ did not send it
|
|
24198
|
+
* @type {number}
|
|
24199
|
+
* @memberof ResQOrderSummaryDto
|
|
24200
|
+
*/
|
|
24201
|
+
'sales'?: number;
|
|
24202
|
+
/**
|
|
24203
|
+
* The order\'s currency, an ISO 4217 code. Absent when ResQ did not send it
|
|
24204
|
+
* @type {string}
|
|
24205
|
+
* @memberof ResQOrderSummaryDto
|
|
24206
|
+
*/
|
|
24207
|
+
'currency'?: string;
|
|
24208
|
+
}
|
|
24209
|
+
/**
|
|
24210
|
+
*
|
|
24211
|
+
* @export
|
|
24212
|
+
* @interface ResQOrdersPageDto
|
|
24213
|
+
*/
|
|
24214
|
+
export interface ResQOrdersPageDto {
|
|
24215
|
+
/**
|
|
24216
|
+
* The venue\'s ResQ orders on this page, as ResQ orders them
|
|
24217
|
+
* @type {Array<ResQOrderSummaryDto>}
|
|
24218
|
+
* @memberof ResQOrdersPageDto
|
|
24219
|
+
*/
|
|
24220
|
+
'orders': Array<ResQOrderSummaryDto>;
|
|
24221
|
+
/**
|
|
24222
|
+
* This page\'s number, from 1
|
|
24223
|
+
* @type {number}
|
|
24224
|
+
* @memberof ResQOrdersPageDto
|
|
24225
|
+
*/
|
|
24226
|
+
'page': number;
|
|
24227
|
+
/**
|
|
24228
|
+
* How many pages there are
|
|
24229
|
+
* @type {number}
|
|
24230
|
+
* @memberof ResQOrdersPageDto
|
|
24231
|
+
*/
|
|
24232
|
+
'pages': number;
|
|
24233
|
+
/**
|
|
24234
|
+
* How many orders the venue has, on every page
|
|
24235
|
+
* @type {number}
|
|
24236
|
+
* @memberof ResQOrdersPageDto
|
|
24237
|
+
*/
|
|
24238
|
+
'count': number;
|
|
24239
|
+
}
|
|
23635
24240
|
/**
|
|
23636
24241
|
*
|
|
23637
24242
|
* @export
|
|
@@ -31086,17 +31691,23 @@ export interface UpsertProvidersDto {
|
|
|
31086
31691
|
*/
|
|
31087
31692
|
'sourceCode'?: string;
|
|
31088
31693
|
/**
|
|
31089
|
-
* Viva ISV commission rate, in percent, at most two decimals. A change is saved on the license server first.
|
|
31694
|
+
* 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
31695
|
* @type {number}
|
|
31091
31696
|
* @memberof UpsertProvidersDto
|
|
31092
31697
|
*/
|
|
31093
31698
|
'rate'?: number;
|
|
31094
31699
|
/**
|
|
31095
|
-
* Viva ISV fixed fee per payment, in cents. A change is saved on the license server first.
|
|
31700
|
+
* 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
31701
|
* @type {number}
|
|
31097
31702
|
* @memberof UpsertProvidersDto
|
|
31098
31703
|
*/
|
|
31099
31704
|
'additionalAmount'?: number;
|
|
31705
|
+
/**
|
|
31706
|
+
*
|
|
31707
|
+
* @type {PaymentSurchargePaidBy}
|
|
31708
|
+
* @memberof UpsertProvidersDto
|
|
31709
|
+
*/
|
|
31710
|
+
'surchargePaidBy'?: PaymentSurchargePaidBy;
|
|
31100
31711
|
/**
|
|
31101
31712
|
* Nets / Stripe / Worldline secret key. Absent keeps the stored value.
|
|
31102
31713
|
* @type {string}
|
|
@@ -31227,6 +31838,12 @@ export interface UpsertVivaDto {
|
|
|
31227
31838
|
* @memberof UpsertVivaDto
|
|
31228
31839
|
*/
|
|
31229
31840
|
'isActive'?: boolean;
|
|
31841
|
+
/**
|
|
31842
|
+
*
|
|
31843
|
+
* @type {PaymentSurchargePaidBy}
|
|
31844
|
+
* @memberof UpsertVivaDto
|
|
31845
|
+
*/
|
|
31846
|
+
'surchargePaidBy'?: PaymentSurchargePaidBy;
|
|
31230
31847
|
/**
|
|
31231
31848
|
*
|
|
31232
31849
|
* @type {UpsertVivaDtoConfig}
|
|
@@ -31241,7 +31858,7 @@ export interface UpsertVivaDto {
|
|
|
31241
31858
|
*/
|
|
31242
31859
|
export interface UpsertVivaDtoConfig {
|
|
31243
31860
|
/**
|
|
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.
|
|
31861
|
+
* 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
31862
|
* @type {number}
|
|
31246
31863
|
* @memberof UpsertVivaDtoConfig
|
|
31247
31864
|
*/
|
|
@@ -31259,7 +31876,7 @@ export interface UpsertVivaDtoConfig {
|
|
|
31259
31876
|
*/
|
|
31260
31877
|
'sourceCode'?: string;
|
|
31261
31878
|
/**
|
|
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.
|
|
31879
|
+
* 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
31880
|
* @type {number}
|
|
31264
31881
|
* @memberof UpsertVivaDtoConfig
|
|
31265
31882
|
*/
|
|
@@ -32164,7 +32781,7 @@ export interface VivaCancelTransactionDto {
|
|
|
32164
32781
|
*/
|
|
32165
32782
|
export interface VivaConfigDto {
|
|
32166
32783
|
/**
|
|
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.
|
|
32784
|
+
* 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
32785
|
* @type {number}
|
|
32169
32786
|
* @memberof VivaConfigDto
|
|
32170
32787
|
*/
|
|
@@ -32182,7 +32799,7 @@ export interface VivaConfigDto {
|
|
|
32182
32799
|
*/
|
|
32183
32800
|
'sourceCode'?: string;
|
|
32184
32801
|
/**
|
|
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.
|
|
32802
|
+
* 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
32803
|
* @type {number}
|
|
32187
32804
|
* @memberof VivaConfigDto
|
|
32188
32805
|
*/
|
|
@@ -37308,6 +37925,133 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
37308
37925
|
*/
|
|
37309
37926
|
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
37927
|
}
|
|
37928
|
+
/**
|
|
37929
|
+
* CouponsApi - axios parameter creator
|
|
37930
|
+
* @export
|
|
37931
|
+
*/
|
|
37932
|
+
export declare const CouponsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
37933
|
+
/**
|
|
37934
|
+
* 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.
|
|
37935
|
+
* @summary Check a coupon against a till\'s basket
|
|
37936
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37937
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
37938
|
+
* @param {*} [options] Override http request option.
|
|
37939
|
+
* @throws {RequiredError}
|
|
37940
|
+
*/
|
|
37941
|
+
checkCoupon: (businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37942
|
+
/**
|
|
37943
|
+
* 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.
|
|
37944
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
37945
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
37946
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
37947
|
+
* @param {*} [options] Override http request option.
|
|
37948
|
+
* @throws {RequiredError}
|
|
37949
|
+
*/
|
|
37950
|
+
checkKioskCoupon: (businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37951
|
+
};
|
|
37952
|
+
/**
|
|
37953
|
+
* CouponsApi - functional programming interface
|
|
37954
|
+
* @export
|
|
37955
|
+
*/
|
|
37956
|
+
export declare const CouponsApiFp: (configuration?: Configuration) => {
|
|
37957
|
+
/**
|
|
37958
|
+
* 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.
|
|
37959
|
+
* @summary Check a coupon against a till\'s basket
|
|
37960
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37961
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
37962
|
+
* @param {*} [options] Override http request option.
|
|
37963
|
+
* @throws {RequiredError}
|
|
37964
|
+
*/
|
|
37965
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CouponCheckAnswerDto>>;
|
|
37966
|
+
/**
|
|
37967
|
+
* 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.
|
|
37968
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
37969
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
37970
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
37971
|
+
* @param {*} [options] Override http request option.
|
|
37972
|
+
* @throws {RequiredError}
|
|
37973
|
+
*/
|
|
37974
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CouponCheckAnswerDto>>;
|
|
37975
|
+
};
|
|
37976
|
+
/**
|
|
37977
|
+
* CouponsApi - factory interface
|
|
37978
|
+
* @export
|
|
37979
|
+
*/
|
|
37980
|
+
export declare const CouponsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
37981
|
+
/**
|
|
37982
|
+
* 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.
|
|
37983
|
+
* @summary Check a coupon against a till\'s basket
|
|
37984
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37985
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
37986
|
+
* @param {*} [options] Override http request option.
|
|
37987
|
+
* @throws {RequiredError}
|
|
37988
|
+
*/
|
|
37989
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: any): AxiosPromise<CouponCheckAnswerDto>;
|
|
37990
|
+
/**
|
|
37991
|
+
* 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.
|
|
37992
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
37993
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
37994
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
37995
|
+
* @param {*} [options] Override http request option.
|
|
37996
|
+
* @throws {RequiredError}
|
|
37997
|
+
*/
|
|
37998
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: any): AxiosPromise<CouponCheckAnswerDto>;
|
|
37999
|
+
};
|
|
38000
|
+
/**
|
|
38001
|
+
* CouponsApi - interface
|
|
38002
|
+
* @export
|
|
38003
|
+
* @interface CouponsApi
|
|
38004
|
+
*/
|
|
38005
|
+
export interface CouponsApiInterface {
|
|
38006
|
+
/**
|
|
38007
|
+
* 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.
|
|
38008
|
+
* @summary Check a coupon against a till\'s basket
|
|
38009
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
38010
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38011
|
+
* @param {*} [options] Override http request option.
|
|
38012
|
+
* @throws {RequiredError}
|
|
38013
|
+
* @memberof CouponsApiInterface
|
|
38014
|
+
*/
|
|
38015
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): AxiosPromise<CouponCheckAnswerDto>;
|
|
38016
|
+
/**
|
|
38017
|
+
* 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.
|
|
38018
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
38019
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
38020
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38021
|
+
* @param {*} [options] Override http request option.
|
|
38022
|
+
* @throws {RequiredError}
|
|
38023
|
+
* @memberof CouponsApiInterface
|
|
38024
|
+
*/
|
|
38025
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): AxiosPromise<CouponCheckAnswerDto>;
|
|
38026
|
+
}
|
|
38027
|
+
/**
|
|
38028
|
+
* CouponsApi - object-oriented interface
|
|
38029
|
+
* @export
|
|
38030
|
+
* @class CouponsApi
|
|
38031
|
+
* @extends {BaseAPI}
|
|
38032
|
+
*/
|
|
38033
|
+
export declare class CouponsApi extends BaseAPI implements CouponsApiInterface {
|
|
38034
|
+
/**
|
|
38035
|
+
* 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.
|
|
38036
|
+
* @summary Check a coupon against a till\'s basket
|
|
38037
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
38038
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38039
|
+
* @param {*} [options] Override http request option.
|
|
38040
|
+
* @throws {RequiredError}
|
|
38041
|
+
* @memberof CouponsApi
|
|
38042
|
+
*/
|
|
38043
|
+
checkCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CouponCheckAnswerDto, any, {}>>;
|
|
38044
|
+
/**
|
|
38045
|
+
* 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.
|
|
38046
|
+
* @summary Check a coupon against a kiosk\'s basket
|
|
38047
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
38048
|
+
* @param {CheckCouponDto} checkCouponDto
|
|
38049
|
+
* @param {*} [options] Override http request option.
|
|
38050
|
+
* @throws {RequiredError}
|
|
38051
|
+
* @memberof CouponsApi
|
|
38052
|
+
*/
|
|
38053
|
+
checkKioskCoupon(businessId: number, checkCouponDto: CheckCouponDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CouponCheckAnswerDto, any, {}>>;
|
|
38054
|
+
}
|
|
37311
38055
|
/**
|
|
37312
38056
|
* CoursesApi - axios parameter creator
|
|
37313
38057
|
* @export
|
|
@@ -43810,7 +44554,7 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
43810
44554
|
*/
|
|
43811
44555
|
changePaymentMethodOption: (businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43812
44556
|
/**
|
|
43813
|
-
* Attaches a
|
|
44557
|
+
* 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
44558
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
43815
44559
|
* @param {number} businessId The venue\'s ordering business id.
|
|
43816
44560
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -43830,7 +44574,7 @@ export declare const PaymentMethodsApiAxiosParamCreator: (configuration?: Config
|
|
|
43830
44574
|
*/
|
|
43831
44575
|
deletePaymentMethodOption: (businessId: number, channel: ProviderEnum, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43832
44576
|
/**
|
|
43833
|
-
* The dashboard\'s add-method picker: every method of the
|
|
44577
|
+
* 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
44578
|
* @summary List the catalog methods a venue can still add on one channel
|
|
43835
44579
|
* @param {number} businessId The venue\'s ordering business id.
|
|
43836
44580
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -43916,7 +44660,7 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
43916
44660
|
*/
|
|
43917
44661
|
changePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
43918
44662
|
/**
|
|
43919
|
-
* Attaches a
|
|
44663
|
+
* 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
44664
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
43921
44665
|
* @param {number} businessId The venue\'s ordering business id.
|
|
43922
44666
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -43936,7 +44680,7 @@ export declare const PaymentMethodsApiFp: (configuration?: Configuration) => {
|
|
|
43936
44680
|
*/
|
|
43937
44681
|
deletePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
43938
44682
|
/**
|
|
43939
|
-
* The dashboard\'s add-method picker: every method of the
|
|
44683
|
+
* 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
44684
|
* @summary List the catalog methods a venue can still add on one channel
|
|
43941
44685
|
* @param {number} businessId The venue\'s ordering business id.
|
|
43942
44686
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44022,7 +44766,7 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
44022
44766
|
*/
|
|
44023
44767
|
changePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: any): AxiosPromise<void>;
|
|
44024
44768
|
/**
|
|
44025
|
-
* Attaches a
|
|
44769
|
+
* 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
44770
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
44027
44771
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44028
44772
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44042,7 +44786,7 @@ export declare const PaymentMethodsApiFactory: (configuration?: Configuration, b
|
|
|
44042
44786
|
*/
|
|
44043
44787
|
deletePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, options?: any): AxiosPromise<void>;
|
|
44044
44788
|
/**
|
|
44045
|
-
* The dashboard\'s add-method picker: every method of the
|
|
44789
|
+
* 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
44790
|
* @summary List the catalog methods a venue can still add on one channel
|
|
44047
44791
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44048
44792
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44131,7 +44875,7 @@ export interface PaymentMethodsApiInterface {
|
|
|
44131
44875
|
*/
|
|
44132
44876
|
changePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
44133
44877
|
/**
|
|
44134
|
-
* Attaches a
|
|
44878
|
+
* 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
44879
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
44136
44880
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44137
44881
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44153,7 +44897,7 @@ export interface PaymentMethodsApiInterface {
|
|
|
44153
44897
|
*/
|
|
44154
44898
|
deletePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
44155
44899
|
/**
|
|
44156
|
-
* The dashboard\'s add-method picker: every method of the
|
|
44900
|
+
* 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
44901
|
* @summary List the catalog methods a venue can still add on one channel
|
|
44158
44902
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44159
44903
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44249,7 +44993,7 @@ export declare class PaymentMethodsApi extends BaseAPI implements PaymentMethods
|
|
|
44249
44993
|
*/
|
|
44250
44994
|
changePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, changePaymentMethodOptionDto: ChangePaymentMethodOptionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
44251
44995
|
/**
|
|
44252
|
-
* Attaches a
|
|
44996
|
+
* 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
44997
|
* @summary Add a payment method to a venue\'s list on one channel
|
|
44254
44998
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44255
44999
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -44271,7 +45015,7 @@ export declare class PaymentMethodsApi extends BaseAPI implements PaymentMethods
|
|
|
44271
45015
|
*/
|
|
44272
45016
|
deletePaymentMethodOption(businessId: number, channel: ProviderEnum, id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
44273
45017
|
/**
|
|
44274
|
-
* The dashboard\'s add-method picker: every method of the
|
|
45018
|
+
* 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
45019
|
* @summary List the catalog methods a venue can still add on one channel
|
|
44276
45020
|
* @param {number} businessId The venue\'s ordering business id.
|
|
44277
45021
|
* @param {ProviderEnum} channel The channel whose list it is; the till\'s is MunchiPos.
|
|
@@ -47245,6 +47989,326 @@ export declare class ReportV6Api extends BaseAPI implements ReportV6ApiInterface
|
|
|
47245
47989
|
*/
|
|
47246
47990
|
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
47991
|
}
|
|
47992
|
+
/**
|
|
47993
|
+
* ResQApi - axios parameter creator
|
|
47994
|
+
* @export
|
|
47995
|
+
*/
|
|
47996
|
+
export declare const ResQApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
47997
|
+
/**
|
|
47998
|
+
* 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.
|
|
47999
|
+
* @summary Change a venue\'s ResQ offer
|
|
48000
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48001
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48002
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
48003
|
+
* @param {*} [options] Override http request option.
|
|
48004
|
+
* @throws {RequiredError}
|
|
48005
|
+
*/
|
|
48006
|
+
changeResQOffer: (businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48007
|
+
/**
|
|
48008
|
+
* 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.
|
|
48009
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
48010
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48011
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
48012
|
+
* @param {*} [options] Override http request option.
|
|
48013
|
+
* @throws {RequiredError}
|
|
48014
|
+
*/
|
|
48015
|
+
createResQOffer: (businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48016
|
+
/**
|
|
48017
|
+
* 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.
|
|
48018
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
48019
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48020
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48021
|
+
* @param {*} [options] Override http request option.
|
|
48022
|
+
* @throws {RequiredError}
|
|
48023
|
+
*/
|
|
48024
|
+
deactivateResQOffer: (businessId: number, offerId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48025
|
+
/**
|
|
48026
|
+
* 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.
|
|
48027
|
+
* @summary Read one ResQ order of a venue
|
|
48028
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48029
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
48030
|
+
* @param {*} [options] Override http request option.
|
|
48031
|
+
* @throws {RequiredError}
|
|
48032
|
+
*/
|
|
48033
|
+
getResQOrder: (businessId: number, orderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48034
|
+
/**
|
|
48035
|
+
* 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.
|
|
48036
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
48037
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48038
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48039
|
+
* @param {*} [options] Override http request option.
|
|
48040
|
+
* @throws {RequiredError}
|
|
48041
|
+
*/
|
|
48042
|
+
listResQOffers: (businessId: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48043
|
+
/**
|
|
48044
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
48045
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
48046
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48047
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48048
|
+
* @param {*} [options] Override http request option.
|
|
48049
|
+
* @throws {RequiredError}
|
|
48050
|
+
*/
|
|
48051
|
+
listResQOrders: (businessId: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48052
|
+
};
|
|
48053
|
+
/**
|
|
48054
|
+
* ResQApi - functional programming interface
|
|
48055
|
+
* @export
|
|
48056
|
+
*/
|
|
48057
|
+
export declare const ResQApiFp: (configuration?: Configuration) => {
|
|
48058
|
+
/**
|
|
48059
|
+
* 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.
|
|
48060
|
+
* @summary Change a venue\'s ResQ offer
|
|
48061
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48062
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48063
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
48064
|
+
* @param {*} [options] Override http request option.
|
|
48065
|
+
* @throws {RequiredError}
|
|
48066
|
+
*/
|
|
48067
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOfferDto>>;
|
|
48068
|
+
/**
|
|
48069
|
+
* 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.
|
|
48070
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
48071
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48072
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
48073
|
+
* @param {*} [options] Override http request option.
|
|
48074
|
+
* @throws {RequiredError}
|
|
48075
|
+
*/
|
|
48076
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOfferDto>>;
|
|
48077
|
+
/**
|
|
48078
|
+
* 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.
|
|
48079
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
48080
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48081
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48082
|
+
* @param {*} [options] Override http request option.
|
|
48083
|
+
* @throws {RequiredError}
|
|
48084
|
+
*/
|
|
48085
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
48086
|
+
/**
|
|
48087
|
+
* 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.
|
|
48088
|
+
* @summary Read one ResQ order of a venue
|
|
48089
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48090
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
48091
|
+
* @param {*} [options] Override http request option.
|
|
48092
|
+
* @throws {RequiredError}
|
|
48093
|
+
*/
|
|
48094
|
+
getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOrderDto>>;
|
|
48095
|
+
/**
|
|
48096
|
+
* 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.
|
|
48097
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
48098
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48099
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48100
|
+
* @param {*} [options] Override http request option.
|
|
48101
|
+
* @throws {RequiredError}
|
|
48102
|
+
*/
|
|
48103
|
+
listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOffersPageDto>>;
|
|
48104
|
+
/**
|
|
48105
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
48106
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
48107
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48108
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48109
|
+
* @param {*} [options] Override http request option.
|
|
48110
|
+
* @throws {RequiredError}
|
|
48111
|
+
*/
|
|
48112
|
+
listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResQOrdersPageDto>>;
|
|
48113
|
+
};
|
|
48114
|
+
/**
|
|
48115
|
+
* ResQApi - factory interface
|
|
48116
|
+
* @export
|
|
48117
|
+
*/
|
|
48118
|
+
export declare const ResQApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
48119
|
+
/**
|
|
48120
|
+
* 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.
|
|
48121
|
+
* @summary Change a venue\'s ResQ offer
|
|
48122
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48123
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48124
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
48125
|
+
* @param {*} [options] Override http request option.
|
|
48126
|
+
* @throws {RequiredError}
|
|
48127
|
+
*/
|
|
48128
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: any): AxiosPromise<ResQOfferDto>;
|
|
48129
|
+
/**
|
|
48130
|
+
* 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.
|
|
48131
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
48132
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48133
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
48134
|
+
* @param {*} [options] Override http request option.
|
|
48135
|
+
* @throws {RequiredError}
|
|
48136
|
+
*/
|
|
48137
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: any): AxiosPromise<ResQOfferDto>;
|
|
48138
|
+
/**
|
|
48139
|
+
* 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.
|
|
48140
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
48141
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48142
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48143
|
+
* @param {*} [options] Override http request option.
|
|
48144
|
+
* @throws {RequiredError}
|
|
48145
|
+
*/
|
|
48146
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: any): AxiosPromise<void>;
|
|
48147
|
+
/**
|
|
48148
|
+
* 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.
|
|
48149
|
+
* @summary Read one ResQ order of a venue
|
|
48150
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48151
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
48152
|
+
* @param {*} [options] Override http request option.
|
|
48153
|
+
* @throws {RequiredError}
|
|
48154
|
+
*/
|
|
48155
|
+
getResQOrder(businessId: number, orderId: string, options?: any): AxiosPromise<ResQOrderDto>;
|
|
48156
|
+
/**
|
|
48157
|
+
* 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.
|
|
48158
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
48159
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48160
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48161
|
+
* @param {*} [options] Override http request option.
|
|
48162
|
+
* @throws {RequiredError}
|
|
48163
|
+
*/
|
|
48164
|
+
listResQOffers(businessId: number, page?: number, options?: any): AxiosPromise<ResQOffersPageDto>;
|
|
48165
|
+
/**
|
|
48166
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
48167
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
48168
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48169
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48170
|
+
* @param {*} [options] Override http request option.
|
|
48171
|
+
* @throws {RequiredError}
|
|
48172
|
+
*/
|
|
48173
|
+
listResQOrders(businessId: number, page?: number, options?: any): AxiosPromise<ResQOrdersPageDto>;
|
|
48174
|
+
};
|
|
48175
|
+
/**
|
|
48176
|
+
* ResQApi - interface
|
|
48177
|
+
* @export
|
|
48178
|
+
* @interface ResQApi
|
|
48179
|
+
*/
|
|
48180
|
+
export interface ResQApiInterface {
|
|
48181
|
+
/**
|
|
48182
|
+
* 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.
|
|
48183
|
+
* @summary Change a venue\'s ResQ offer
|
|
48184
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48185
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48186
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
48187
|
+
* @param {*} [options] Override http request option.
|
|
48188
|
+
* @throws {RequiredError}
|
|
48189
|
+
* @memberof ResQApiInterface
|
|
48190
|
+
*/
|
|
48191
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig): AxiosPromise<ResQOfferDto>;
|
|
48192
|
+
/**
|
|
48193
|
+
* 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.
|
|
48194
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
48195
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48196
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
48197
|
+
* @param {*} [options] Override http request option.
|
|
48198
|
+
* @throws {RequiredError}
|
|
48199
|
+
* @memberof ResQApiInterface
|
|
48200
|
+
*/
|
|
48201
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig): AxiosPromise<ResQOfferDto>;
|
|
48202
|
+
/**
|
|
48203
|
+
* 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.
|
|
48204
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
48205
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48206
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48207
|
+
* @param {*} [options] Override http request option.
|
|
48208
|
+
* @throws {RequiredError}
|
|
48209
|
+
* @memberof ResQApiInterface
|
|
48210
|
+
*/
|
|
48211
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
48212
|
+
/**
|
|
48213
|
+
* 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.
|
|
48214
|
+
* @summary Read one ResQ order of a venue
|
|
48215
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48216
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
48217
|
+
* @param {*} [options] Override http request option.
|
|
48218
|
+
* @throws {RequiredError}
|
|
48219
|
+
* @memberof ResQApiInterface
|
|
48220
|
+
*/
|
|
48221
|
+
getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig): AxiosPromise<ResQOrderDto>;
|
|
48222
|
+
/**
|
|
48223
|
+
* 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.
|
|
48224
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
48225
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48226
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48227
|
+
* @param {*} [options] Override http request option.
|
|
48228
|
+
* @throws {RequiredError}
|
|
48229
|
+
* @memberof ResQApiInterface
|
|
48230
|
+
*/
|
|
48231
|
+
listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig): AxiosPromise<ResQOffersPageDto>;
|
|
48232
|
+
/**
|
|
48233
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
48234
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
48235
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48236
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48237
|
+
* @param {*} [options] Override http request option.
|
|
48238
|
+
* @throws {RequiredError}
|
|
48239
|
+
* @memberof ResQApiInterface
|
|
48240
|
+
*/
|
|
48241
|
+
listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig): AxiosPromise<ResQOrdersPageDto>;
|
|
48242
|
+
}
|
|
48243
|
+
/**
|
|
48244
|
+
* ResQApi - object-oriented interface
|
|
48245
|
+
* @export
|
|
48246
|
+
* @class ResQApi
|
|
48247
|
+
* @extends {BaseAPI}
|
|
48248
|
+
*/
|
|
48249
|
+
export declare class ResQApi extends BaseAPI implements ResQApiInterface {
|
|
48250
|
+
/**
|
|
48251
|
+
* 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.
|
|
48252
|
+
* @summary Change a venue\'s ResQ offer
|
|
48253
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48254
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48255
|
+
* @param {ChangeResQOfferDto} changeResQOfferDto
|
|
48256
|
+
* @param {*} [options] Override http request option.
|
|
48257
|
+
* @throws {RequiredError}
|
|
48258
|
+
* @memberof ResQApi
|
|
48259
|
+
*/
|
|
48260
|
+
changeResQOffer(businessId: number, offerId: string, changeResQOfferDto: ChangeResQOfferDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResQOfferDto, any, {}>>;
|
|
48261
|
+
/**
|
|
48262
|
+
* 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.
|
|
48263
|
+
* @summary Put a new offer on sale on ResQ for a venue
|
|
48264
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48265
|
+
* @param {CreateResQOfferDto} createResQOfferDto
|
|
48266
|
+
* @param {*} [options] Override http request option.
|
|
48267
|
+
* @throws {RequiredError}
|
|
48268
|
+
* @memberof ResQApi
|
|
48269
|
+
*/
|
|
48270
|
+
createResQOffer(businessId: number, createResQOfferDto: CreateResQOfferDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResQOfferDto, any, {}>>;
|
|
48271
|
+
/**
|
|
48272
|
+
* 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.
|
|
48273
|
+
* @summary Switch off a venue\'s ResQ offer for good
|
|
48274
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48275
|
+
* @param {string} offerId The ResQ offer\'s id, as the offer list answered it
|
|
48276
|
+
* @param {*} [options] Override http request option.
|
|
48277
|
+
* @throws {RequiredError}
|
|
48278
|
+
* @memberof ResQApi
|
|
48279
|
+
*/
|
|
48280
|
+
deactivateResQOffer(businessId: number, offerId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
48281
|
+
/**
|
|
48282
|
+
* 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.
|
|
48283
|
+
* @summary Read one ResQ order of a venue
|
|
48284
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48285
|
+
* @param {string} orderId The ResQ order\'s id, as the order list answered it
|
|
48286
|
+
* @param {*} [options] Override http request option.
|
|
48287
|
+
* @throws {RequiredError}
|
|
48288
|
+
* @memberof ResQApi
|
|
48289
|
+
*/
|
|
48290
|
+
getResQOrder(businessId: number, orderId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResQOrderDto, any, {}>>;
|
|
48291
|
+
/**
|
|
48292
|
+
* 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.
|
|
48293
|
+
* @summary List a venue\'s ResQ offers, a page at a time
|
|
48294
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48295
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48296
|
+
* @param {*} [options] Override http request option.
|
|
48297
|
+
* @throws {RequiredError}
|
|
48298
|
+
* @memberof ResQApi
|
|
48299
|
+
*/
|
|
48300
|
+
listResQOffers(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResQOffersPageDto, any, {}>>;
|
|
48301
|
+
/**
|
|
48302
|
+
* resq-service reads the venue\'s orders from ResQ with the venue\'s own ResQ access; nothing is kept here.
|
|
48303
|
+
* @summary List the ResQ orders of a venue, a page at a time
|
|
48304
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
48305
|
+
* @param {number} [page] The page to read, from 1. Left out, resq-service answers its first page
|
|
48306
|
+
* @param {*} [options] Override http request option.
|
|
48307
|
+
* @throws {RequiredError}
|
|
48308
|
+
* @memberof ResQApi
|
|
48309
|
+
*/
|
|
48310
|
+
listResQOrders(businessId: number, page?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResQOrdersPageDto, any, {}>>;
|
|
48311
|
+
}
|
|
47248
48312
|
/**
|
|
47249
48313
|
* ReservationsApi - axios parameter creator
|
|
47250
48314
|
* @export
|