@munchi_oy/core 2.0.8 → 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 +530 -30
- 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 +715 -31
- 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
|
|
@@ -6053,7 +6106,7 @@ export interface DiscountDto {
|
|
|
6053
6106
|
*/
|
|
6054
6107
|
'updatedAt': string;
|
|
6055
6108
|
/**
|
|
6056
|
-
* 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
|
|
6057
6110
|
* @type {number}
|
|
6058
6111
|
* @memberof DiscountDto
|
|
6059
6112
|
*/
|
|
@@ -6083,13 +6136,13 @@ export interface DiscountDto {
|
|
|
6083
6136
|
*/
|
|
6084
6137
|
'type'?: PromotionDiscountType;
|
|
6085
6138
|
/**
|
|
6086
|
-
* The discount\'s description;
|
|
6139
|
+
* The discount\'s description; an empty string when it has none
|
|
6087
6140
|
* @type {string}
|
|
6088
6141
|
* @memberof DiscountDto
|
|
6089
6142
|
*/
|
|
6090
6143
|
'description'?: string;
|
|
6091
6144
|
/**
|
|
6092
|
-
* Whether the discount is
|
|
6145
|
+
* Whether the discount is switched on; always true, since a switched-off one is not answered
|
|
6093
6146
|
* @type {boolean}
|
|
6094
6147
|
* @memberof DiscountDto
|
|
6095
6148
|
*/
|
|
@@ -6113,7 +6166,7 @@ export interface DiscountDto {
|
|
|
6113
6166
|
*/
|
|
6114
6167
|
'maxUsesPerOrder'?: number | null;
|
|
6115
6168
|
/**
|
|
6116
|
-
*
|
|
6169
|
+
* The Vendure promotion\'s buttonOrder, which a button copied from data-bridge took from the discount\'s priority; 1 when it has none
|
|
6117
6170
|
* @type {number}
|
|
6118
6171
|
* @memberof DiscountDto
|
|
6119
6172
|
*/
|
|
@@ -21198,6 +21251,68 @@ export declare const PreorderStatus: {
|
|
|
21198
21251
|
readonly Confirm: "confirm";
|
|
21199
21252
|
};
|
|
21200
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
|
+
}
|
|
21201
21316
|
/**
|
|
21202
21317
|
*
|
|
21203
21318
|
* @export
|
|
@@ -21258,6 +21373,117 @@ export declare const PriceType: {
|
|
|
21258
21373
|
readonly Open: "OPEN";
|
|
21259
21374
|
};
|
|
21260
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
|
+
}
|
|
21261
21487
|
/**
|
|
21262
21488
|
*
|
|
21263
21489
|
* @export
|
|
@@ -23881,6 +24107,8 @@ export declare const ReportChangeField: {
|
|
|
23881
24107
|
readonly PaymentReportSummaryTotalRefunds: "paymentReport.summary.totalRefunds";
|
|
23882
24108
|
readonly PaymentReportSummaryRefundCount: "paymentReport.summary.refundCount";
|
|
23883
24109
|
readonly PaymentReportTotalDiscounts: "paymentReport.totalDiscounts";
|
|
24110
|
+
readonly OrderCount: "orderCount";
|
|
24111
|
+
readonly AverageOrderValue: "averageOrderValue";
|
|
23884
24112
|
};
|
|
23885
24113
|
export type ReportChangeField = typeof ReportChangeField[keyof typeof ReportChangeField];
|
|
23886
24114
|
/**
|
|
@@ -24789,6 +25017,18 @@ export interface SalesReportComparisonDto {
|
|
|
24789
25017
|
* @memberof SalesReportComparisonDto
|
|
24790
25018
|
*/
|
|
24791
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;
|
|
24792
25032
|
/**
|
|
24793
25033
|
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
24794
25034
|
* @type {Array<SalesReportChangeDto>}
|
|
@@ -24895,7 +25135,7 @@ export interface SalesReportDayDto {
|
|
|
24895
25135
|
*/
|
|
24896
25136
|
'date': string;
|
|
24897
25137
|
/**
|
|
24898
|
-
* 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
|
|
24899
25139
|
* @type {number}
|
|
24900
25140
|
* @memberof SalesReportDayDto
|
|
24901
25141
|
*/
|
|
@@ -25010,6 +25250,18 @@ export interface SalesReportGroupDto {
|
|
|
25010
25250
|
* @memberof SalesReportGroupDto
|
|
25011
25251
|
*/
|
|
25012
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;
|
|
25013
25265
|
/**
|
|
25014
25266
|
*
|
|
25015
25267
|
* @type {SalesReportGroupDtoComparison}
|
|
@@ -25077,6 +25329,18 @@ export interface SalesReportGroupDtoComparison {
|
|
|
25077
25329
|
* @memberof SalesReportGroupDtoComparison
|
|
25078
25330
|
*/
|
|
25079
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;
|
|
25080
25344
|
/**
|
|
25081
25345
|
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
25082
25346
|
* @type {Array<SalesReportChangeDto>}
|
|
@@ -25948,6 +26212,31 @@ export interface SendReportEmailDto {
|
|
|
25948
26212
|
*/
|
|
25949
26213
|
'language'?: ReportLanguage;
|
|
25950
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];
|
|
25951
26240
|
/**
|
|
25952
26241
|
*
|
|
25953
26242
|
* @export
|
|
@@ -35579,7 +35868,7 @@ export declare class AuthApi extends BaseAPI implements AuthApiInterface {
|
|
|
35579
35868
|
*/
|
|
35580
35869
|
export declare const BusinessApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
35581
35870
|
/**
|
|
35582
|
-
* 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.
|
|
35583
35872
|
* @summary Get unified discounts for all business and venue
|
|
35584
35873
|
* @param {string} businessId The venue\'s business id
|
|
35585
35874
|
* @param {*} [options] Override http request option.
|
|
@@ -35734,7 +36023,7 @@ export declare const BusinessApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
35734
36023
|
*/
|
|
35735
36024
|
export declare const BusinessApiFp: (configuration?: Configuration) => {
|
|
35736
36025
|
/**
|
|
35737
|
-
* 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.
|
|
35738
36027
|
* @summary Get unified discounts for all business and venue
|
|
35739
36028
|
* @param {string} businessId The venue\'s business id
|
|
35740
36029
|
* @param {*} [options] Override http request option.
|
|
@@ -35889,7 +36178,7 @@ export declare const BusinessApiFp: (configuration?: Configuration) => {
|
|
|
35889
36178
|
*/
|
|
35890
36179
|
export declare const BusinessApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
35891
36180
|
/**
|
|
35892
|
-
* 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.
|
|
35893
36182
|
* @summary Get unified discounts for all business and venue
|
|
35894
36183
|
* @param {string} businessId The venue\'s business id
|
|
35895
36184
|
* @param {*} [options] Override http request option.
|
|
@@ -36045,7 +36334,7 @@ export declare const BusinessApiFactory: (configuration?: Configuration, basePat
|
|
|
36045
36334
|
*/
|
|
36046
36335
|
export interface BusinessApiInterface {
|
|
36047
36336
|
/**
|
|
36048
|
-
* 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.
|
|
36049
36338
|
* @summary Get unified discounts for all business and venue
|
|
36050
36339
|
* @param {string} businessId The venue\'s business id
|
|
36051
36340
|
* @param {*} [options] Override http request option.
|
|
@@ -36219,7 +36508,7 @@ export interface BusinessApiInterface {
|
|
|
36219
36508
|
*/
|
|
36220
36509
|
export declare class BusinessApi extends BaseAPI implements BusinessApiInterface {
|
|
36221
36510
|
/**
|
|
36222
|
-
* 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.
|
|
36223
36512
|
* @summary Get unified discounts for all business and venue
|
|
36224
36513
|
* @param {string} businessId The venue\'s business id
|
|
36225
36514
|
* @param {*} [options] Override http request option.
|
|
@@ -39837,7 +40126,7 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
39837
40126
|
*/
|
|
39838
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>;
|
|
39839
40128
|
/**
|
|
39840
|
-
* 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.
|
|
39841
40130
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
39842
40131
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39843
40132
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39886,7 +40175,7 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
39886
40175
|
*/
|
|
39887
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>>;
|
|
39888
40177
|
/**
|
|
39889
|
-
* 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.
|
|
39890
40179
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
39891
40180
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39892
40181
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39935,7 +40224,7 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
39935
40224
|
*/
|
|
39936
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>;
|
|
39937
40226
|
/**
|
|
39938
|
-
* 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.
|
|
39939
40228
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
39940
40229
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39941
40230
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -39986,7 +40275,7 @@ export interface HistoryApiInterface {
|
|
|
39986
40275
|
*/
|
|
39987
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>;
|
|
39988
40277
|
/**
|
|
39989
|
-
* 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.
|
|
39990
40279
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
39991
40280
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
39992
40281
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -40039,7 +40328,7 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
40039
40328
|
*/
|
|
40040
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, {}>>;
|
|
40041
40330
|
/**
|
|
40042
|
-
* 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.
|
|
40043
40332
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
40044
40333
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
40045
40334
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -40067,7 +40356,7 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
40067
40356
|
*/
|
|
40068
40357
|
export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
40069
40358
|
/**
|
|
40070
|
-
* 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.
|
|
40071
40360
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
40072
40361
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
40073
40362
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -40136,7 +40425,7 @@ export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configurati
|
|
|
40136
40425
|
*/
|
|
40137
40426
|
export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
40138
40427
|
/**
|
|
40139
|
-
* 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.
|
|
40140
40429
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
40141
40430
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
40142
40431
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -40205,7 +40494,7 @@ export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
|
40205
40494
|
*/
|
|
40206
40495
|
export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
40207
40496
|
/**
|
|
40208
|
-
* 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.
|
|
40209
40498
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
40210
40499
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
40211
40500
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -40275,7 +40564,7 @@ export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePa
|
|
|
40275
40564
|
*/
|
|
40276
40565
|
export interface HistoryV6ApiInterface {
|
|
40277
40566
|
/**
|
|
40278
|
-
* 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.
|
|
40279
40568
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
40280
40569
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
40281
40570
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -40349,7 +40638,7 @@ export interface HistoryV6ApiInterface {
|
|
|
40349
40638
|
*/
|
|
40350
40639
|
export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterface {
|
|
40351
40640
|
/**
|
|
40352
|
-
* 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.
|
|
40353
40642
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
40354
40643
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
40355
40644
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -41963,7 +42252,7 @@ export declare const MCPApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
41963
42252
|
*/
|
|
41964
42253
|
refuseStream: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41965
42254
|
/**
|
|
41966
|
-
* 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).
|
|
41967
42256
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
41968
42257
|
* @param {object} body A JSON-RPC 2.0 message
|
|
41969
42258
|
* @param {*} [options] Override http request option.
|
|
@@ -41991,7 +42280,7 @@ export declare const MCPApiFp: (configuration?: Configuration) => {
|
|
|
41991
42280
|
*/
|
|
41992
42281
|
refuseStream(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
41993
42282
|
/**
|
|
41994
|
-
* 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).
|
|
41995
42284
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
41996
42285
|
* @param {object} body A JSON-RPC 2.0 message
|
|
41997
42286
|
* @param {*} [options] Override http request option.
|
|
@@ -42019,7 +42308,7 @@ export declare const MCPApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
42019
42308
|
*/
|
|
42020
42309
|
refuseStream(options?: any): AxiosPromise<void>;
|
|
42021
42310
|
/**
|
|
42022
|
-
* 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).
|
|
42023
42312
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
42024
42313
|
* @param {object} body A JSON-RPC 2.0 message
|
|
42025
42314
|
* @param {*} [options] Override http request option.
|
|
@@ -42050,7 +42339,7 @@ export interface MCPApiInterface {
|
|
|
42050
42339
|
*/
|
|
42051
42340
|
refuseStream(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
42052
42341
|
/**
|
|
42053
|
-
* 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).
|
|
42054
42343
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
42055
42344
|
* @param {object} body A JSON-RPC 2.0 message
|
|
42056
42345
|
* @param {*} [options] Override http request option.
|
|
@@ -42083,7 +42372,7 @@ export declare class MCPApi extends BaseAPI implements MCPApiInterface {
|
|
|
42083
42372
|
*/
|
|
42084
42373
|
refuseStream(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
42085
42374
|
/**
|
|
42086
|
-
* 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).
|
|
42087
42376
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
42088
42377
|
* @param {object} body A JSON-RPC 2.0 message
|
|
42089
42378
|
* @param {*} [options] Override http request option.
|
|
@@ -42839,7 +43128,7 @@ export declare class OrderCompletionApi extends BaseAPI implements OrderCompleti
|
|
|
42839
43128
|
*/
|
|
42840
43129
|
export declare const OrderInternalApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
42841
43130
|
/**
|
|
42842
|
-
* 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.
|
|
42843
43132
|
* @summary Get order data by external ID for internal microservice communication
|
|
42844
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
|
|
42845
43134
|
* @param {*} [options] Override http request option.
|
|
@@ -42853,7 +43142,7 @@ export declare const OrderInternalApiAxiosParamCreator: (configuration?: Configu
|
|
|
42853
43142
|
*/
|
|
42854
43143
|
export declare const OrderInternalApiFp: (configuration?: Configuration) => {
|
|
42855
43144
|
/**
|
|
42856
|
-
* 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.
|
|
42857
43146
|
* @summary Get order data by external ID for internal microservice communication
|
|
42858
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
|
|
42859
43148
|
* @param {*} [options] Override http request option.
|
|
@@ -42867,7 +43156,7 @@ export declare const OrderInternalApiFp: (configuration?: Configuration) => {
|
|
|
42867
43156
|
*/
|
|
42868
43157
|
export declare const OrderInternalApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
42869
43158
|
/**
|
|
42870
|
-
* 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.
|
|
42871
43160
|
* @summary Get order data by external ID for internal microservice communication
|
|
42872
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
|
|
42873
43162
|
* @param {*} [options] Override http request option.
|
|
@@ -42882,7 +43171,7 @@ export declare const OrderInternalApiFactory: (configuration?: Configuration, ba
|
|
|
42882
43171
|
*/
|
|
42883
43172
|
export interface OrderInternalApiInterface {
|
|
42884
43173
|
/**
|
|
42885
|
-
* 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.
|
|
42886
43175
|
* @summary Get order data by external ID for internal microservice communication
|
|
42887
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
|
|
42888
43177
|
* @param {*} [options] Override http request option.
|
|
@@ -42899,7 +43188,7 @@ export interface OrderInternalApiInterface {
|
|
|
42899
43188
|
*/
|
|
42900
43189
|
export declare class OrderInternalApi extends BaseAPI implements OrderInternalApiInterface {
|
|
42901
43190
|
/**
|
|
42902
|
-
* 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.
|
|
42903
43192
|
* @summary Get order data by external ID for internal microservice communication
|
|
42904
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
|
|
42905
43194
|
* @param {*} [options] Override http request option.
|
|
@@ -46600,6 +46889,217 @@ export declare class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
46600
46889
|
*/
|
|
46601
46890
|
updateProductSkusV2(businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProductSkusResponseDto, any, {}>>;
|
|
46602
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
|
+
}
|
|
46603
47103
|
/**
|
|
46604
47104
|
* ProviderApi - axios parameter creator
|
|
46605
47105
|
* @export
|