@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/generated/api.ts
CHANGED
|
@@ -446,6 +446,50 @@ export interface AmountDto {
|
|
|
446
446
|
*/
|
|
447
447
|
'currency': string;
|
|
448
448
|
}
|
|
449
|
+
/**
|
|
450
|
+
*
|
|
451
|
+
* @export
|
|
452
|
+
* @interface AutomaticPromotionDto
|
|
453
|
+
*/
|
|
454
|
+
export interface AutomaticPromotionDto {
|
|
455
|
+
/**
|
|
456
|
+
* The Vendure promotion\'s id
|
|
457
|
+
* @type {number}
|
|
458
|
+
* @memberof AutomaticPromotionDto
|
|
459
|
+
*/
|
|
460
|
+
'id': number;
|
|
461
|
+
/**
|
|
462
|
+
* The promotion\'s name
|
|
463
|
+
* @type {string}
|
|
464
|
+
* @memberof AutomaticPromotionDto
|
|
465
|
+
*/
|
|
466
|
+
'name': string;
|
|
467
|
+
/**
|
|
468
|
+
* When the promotion starts, an ISO date-time; null when it has no start
|
|
469
|
+
* @type {string}
|
|
470
|
+
* @memberof AutomaticPromotionDto
|
|
471
|
+
*/
|
|
472
|
+
'startsAt': string | null;
|
|
473
|
+
/**
|
|
474
|
+
* When the promotion ends, an ISO date-time; null when it has no end
|
|
475
|
+
* @type {string}
|
|
476
|
+
* @memberof AutomaticPromotionDto
|
|
477
|
+
*/
|
|
478
|
+
'endsAt': string | null;
|
|
479
|
+
}
|
|
480
|
+
/**
|
|
481
|
+
*
|
|
482
|
+
* @export
|
|
483
|
+
* @interface AutomaticPromotionsAnswerDto
|
|
484
|
+
*/
|
|
485
|
+
export interface AutomaticPromotionsAnswerDto {
|
|
486
|
+
/**
|
|
487
|
+
* 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
|
|
488
|
+
* @type {Array<AutomaticPromotionDto>}
|
|
489
|
+
* @memberof AutomaticPromotionsAnswerDto
|
|
490
|
+
*/
|
|
491
|
+
'automaticPromotions': Array<AutomaticPromotionDto>;
|
|
492
|
+
}
|
|
449
493
|
/**
|
|
450
494
|
*
|
|
451
495
|
* @export
|
|
@@ -491,6 +535,19 @@ export interface AvailablePaymentMethodDto {
|
|
|
491
535
|
*/
|
|
492
536
|
'requiresCredentials': boolean;
|
|
493
537
|
}
|
|
538
|
+
/**
|
|
539
|
+
*
|
|
540
|
+
* @export
|
|
541
|
+
* @enum {string}
|
|
542
|
+
*/
|
|
543
|
+
|
|
544
|
+
export const BasketNotPricedReason = {
|
|
545
|
+
Unavailable: 'UNAVAILABLE'
|
|
546
|
+
} as const;
|
|
547
|
+
|
|
548
|
+
export type BasketNotPricedReason = typeof BasketNotPricedReason[keyof typeof BasketNotPricedReason];
|
|
549
|
+
|
|
550
|
+
|
|
494
551
|
/**
|
|
495
552
|
*
|
|
496
553
|
* @export
|
|
@@ -6287,7 +6344,7 @@ export interface DiscountDto {
|
|
|
6287
6344
|
*/
|
|
6288
6345
|
'updatedAt': string;
|
|
6289
6346
|
/**
|
|
6290
|
-
* The discount\'s id
|
|
6347
|
+
* 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
|
|
6291
6348
|
* @type {number}
|
|
6292
6349
|
* @memberof DiscountDto
|
|
6293
6350
|
*/
|
|
@@ -6317,13 +6374,13 @@ export interface DiscountDto {
|
|
|
6317
6374
|
*/
|
|
6318
6375
|
'type'?: PromotionDiscountType;
|
|
6319
6376
|
/**
|
|
6320
|
-
* The discount\'s description;
|
|
6377
|
+
* The discount\'s description; an empty string when it has none
|
|
6321
6378
|
* @type {string}
|
|
6322
6379
|
* @memberof DiscountDto
|
|
6323
6380
|
*/
|
|
6324
6381
|
'description'?: string;
|
|
6325
6382
|
/**
|
|
6326
|
-
* Whether the discount is
|
|
6383
|
+
* Whether the discount is switched on; always true, since a switched-off one is not answered
|
|
6327
6384
|
* @type {boolean}
|
|
6328
6385
|
* @memberof DiscountDto
|
|
6329
6386
|
*/
|
|
@@ -6347,7 +6404,7 @@ export interface DiscountDto {
|
|
|
6347
6404
|
*/
|
|
6348
6405
|
'maxUsesPerOrder'?: number | null;
|
|
6349
6406
|
/**
|
|
6350
|
-
*
|
|
6407
|
+
* The Vendure promotion\'s buttonOrder, which a button copied from data-bridge took from the discount\'s priority; 1 when it has none
|
|
6351
6408
|
* @type {number}
|
|
6352
6409
|
* @memberof DiscountDto
|
|
6353
6410
|
*/
|
|
@@ -21851,6 +21908,72 @@ export const PreorderStatus = {
|
|
|
21851
21908
|
export type PreorderStatus = typeof PreorderStatus[keyof typeof PreorderStatus];
|
|
21852
21909
|
|
|
21853
21910
|
|
|
21911
|
+
/**
|
|
21912
|
+
*
|
|
21913
|
+
* @export
|
|
21914
|
+
* @interface PriceBasketAnswerDto
|
|
21915
|
+
*/
|
|
21916
|
+
export interface PriceBasketAnswerDto {
|
|
21917
|
+
/**
|
|
21918
|
+
* true when Vendure priced the basket; false when it could not, and nothing is known of its discounts
|
|
21919
|
+
* @type {boolean}
|
|
21920
|
+
* @memberof PriceBasketAnswerDto
|
|
21921
|
+
*/
|
|
21922
|
+
'priced': boolean;
|
|
21923
|
+
/**
|
|
21924
|
+
*
|
|
21925
|
+
* @type {BasketNotPricedReason}
|
|
21926
|
+
* @memberof PriceBasketAnswerDto
|
|
21927
|
+
*/
|
|
21928
|
+
'reason': BasketNotPricedReason | null;
|
|
21929
|
+
/**
|
|
21930
|
+
* Every line sent, in the order sent, with its discounts; empty when priced is false
|
|
21931
|
+
* @type {Array<PricedLineDto>}
|
|
21932
|
+
* @memberof PriceBasketAnswerDto
|
|
21933
|
+
*/
|
|
21934
|
+
'lines': Array<PricedLineDto>;
|
|
21935
|
+
/**
|
|
21936
|
+
* 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
|
|
21937
|
+
* @type {Array<PricedDiscountDto>}
|
|
21938
|
+
* @memberof PriceBasketAnswerDto
|
|
21939
|
+
*/
|
|
21940
|
+
'orderDiscounts': Array<PricedDiscountDto>;
|
|
21941
|
+
/**
|
|
21942
|
+
* The basket\'s total in cents, VAT included, after the discounts, as Vendure worked it out; null when priced is false
|
|
21943
|
+
* @type {number}
|
|
21944
|
+
* @memberof PriceBasketAnswerDto
|
|
21945
|
+
*/
|
|
21946
|
+
'subTotalWithTax': number | null;
|
|
21947
|
+
}
|
|
21948
|
+
|
|
21949
|
+
|
|
21950
|
+
/**
|
|
21951
|
+
*
|
|
21952
|
+
* @export
|
|
21953
|
+
* @interface PriceBasketDto
|
|
21954
|
+
*/
|
|
21955
|
+
export interface PriceBasketDto {
|
|
21956
|
+
/**
|
|
21957
|
+
*
|
|
21958
|
+
* @type {OrderTypePOS}
|
|
21959
|
+
* @memberof PriceBasketDto
|
|
21960
|
+
*/
|
|
21961
|
+
'orderType': OrderTypePOS;
|
|
21962
|
+
/**
|
|
21963
|
+
* 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
|
|
21964
|
+
* @type {Array<string>}
|
|
21965
|
+
* @memberof PriceBasketDto
|
|
21966
|
+
*/
|
|
21967
|
+
'couponCodes'?: Array<string>;
|
|
21968
|
+
/**
|
|
21969
|
+
* The order\'s lines as they stand, VAT included; priced again whenever the basket changes
|
|
21970
|
+
* @type {Array<PricingBasketLineDto>}
|
|
21971
|
+
* @memberof PriceBasketDto
|
|
21972
|
+
*/
|
|
21973
|
+
'lines': Array<PricingBasketLineDto>;
|
|
21974
|
+
}
|
|
21975
|
+
|
|
21976
|
+
|
|
21854
21977
|
/**
|
|
21855
21978
|
*
|
|
21856
21979
|
* @export
|
|
@@ -21915,6 +22038,119 @@ export const PriceType = {
|
|
|
21915
22038
|
export type PriceType = typeof PriceType[keyof typeof PriceType];
|
|
21916
22039
|
|
|
21917
22040
|
|
|
22041
|
+
/**
|
|
22042
|
+
*
|
|
22043
|
+
* @export
|
|
22044
|
+
* @interface PricedDiscountDto
|
|
22045
|
+
*/
|
|
22046
|
+
export interface PricedDiscountDto {
|
|
22047
|
+
/**
|
|
22048
|
+
*
|
|
22049
|
+
* @type {DiscountSourceType}
|
|
22050
|
+
* @memberof PricedDiscountDto
|
|
22051
|
+
*/
|
|
22052
|
+
'sourceType': DiscountSourceType;
|
|
22053
|
+
/**
|
|
22054
|
+
* The Vendure promotion\'s id, as text
|
|
22055
|
+
* @type {string}
|
|
22056
|
+
* @memberof PricedDiscountDto
|
|
22057
|
+
*/
|
|
22058
|
+
'sourceId': string;
|
|
22059
|
+
/**
|
|
22060
|
+
* The promotion\'s name, in English, else Finnish; shown on the till, the receipt and the reports
|
|
22061
|
+
* @type {string}
|
|
22062
|
+
* @memberof PricedDiscountDto
|
|
22063
|
+
*/
|
|
22064
|
+
'name': string;
|
|
22065
|
+
/**
|
|
22066
|
+
* true when Vendure applies the promotion by itself, with no code; false when one of the basket\'s coupon codes applies it
|
|
22067
|
+
* @type {boolean}
|
|
22068
|
+
* @memberof PricedDiscountDto
|
|
22069
|
+
*/
|
|
22070
|
+
'isAutomatic': boolean;
|
|
22071
|
+
/**
|
|
22072
|
+
* The coupon code as the promotion holds it; null for an automatic promotion
|
|
22073
|
+
* @type {string}
|
|
22074
|
+
* @memberof PricedDiscountDto
|
|
22075
|
+
*/
|
|
22076
|
+
'couponCode': string | null;
|
|
22077
|
+
/**
|
|
22078
|
+
*
|
|
22079
|
+
* @type {DiscountScope}
|
|
22080
|
+
* @memberof PricedDiscountDto
|
|
22081
|
+
*/
|
|
22082
|
+
'scope': DiscountScope;
|
|
22083
|
+
/**
|
|
22084
|
+
* The discount in cents, VAT included, negative, exactly as Vendure worked it out: the cents the till takes off
|
|
22085
|
+
* @type {number}
|
|
22086
|
+
* @memberof PricedDiscountDto
|
|
22087
|
+
*/
|
|
22088
|
+
'amountWithTax': number;
|
|
22089
|
+
/**
|
|
22090
|
+
* The same discount in cents before VAT, negative
|
|
22091
|
+
* @type {number}
|
|
22092
|
+
* @memberof PricedDiscountDto
|
|
22093
|
+
*/
|
|
22094
|
+
'amount': number;
|
|
22095
|
+
}
|
|
22096
|
+
|
|
22097
|
+
|
|
22098
|
+
/**
|
|
22099
|
+
*
|
|
22100
|
+
* @export
|
|
22101
|
+
* @interface PricedLineDto
|
|
22102
|
+
*/
|
|
22103
|
+
export interface PricedLineDto {
|
|
22104
|
+
/**
|
|
22105
|
+
* The line\'s id, as sent
|
|
22106
|
+
* @type {string}
|
|
22107
|
+
* @memberof PricedLineDto
|
|
22108
|
+
*/
|
|
22109
|
+
'lineItemId': string;
|
|
22110
|
+
/**
|
|
22111
|
+
* The discounts on this line, each order discount\'s share included; empty when none reaches it
|
|
22112
|
+
* @type {Array<PricedDiscountDto>}
|
|
22113
|
+
* @memberof PricedLineDto
|
|
22114
|
+
*/
|
|
22115
|
+
'discounts': Array<PricedDiscountDto>;
|
|
22116
|
+
}
|
|
22117
|
+
/**
|
|
22118
|
+
*
|
|
22119
|
+
* @export
|
|
22120
|
+
* @interface PricingBasketLineDto
|
|
22121
|
+
*/
|
|
22122
|
+
export interface PricingBasketLineDto {
|
|
22123
|
+
/**
|
|
22124
|
+
* The line\'s stable id, the one the order\'s discounts point at
|
|
22125
|
+
* @type {string}
|
|
22126
|
+
* @memberof PricingBasketLineDto
|
|
22127
|
+
*/
|
|
22128
|
+
'lineItemId': string;
|
|
22129
|
+
/**
|
|
22130
|
+
* How many of the product the line holds, a whole number
|
|
22131
|
+
* @type {number}
|
|
22132
|
+
* @memberof PricingBasketLineDto
|
|
22133
|
+
*/
|
|
22134
|
+
'quantity': number;
|
|
22135
|
+
/**
|
|
22136
|
+
* The price of one unit as the till charges it, options included, in cents
|
|
22137
|
+
* @type {number}
|
|
22138
|
+
* @memberof PricingBasketLineDto
|
|
22139
|
+
*/
|
|
22140
|
+
'unitAmount': number;
|
|
22141
|
+
/**
|
|
22142
|
+
* 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
|
|
22143
|
+
* @type {number}
|
|
22144
|
+
* @memberof PricingBasketLineDto
|
|
22145
|
+
*/
|
|
22146
|
+
'vatRate'?: number;
|
|
22147
|
+
/**
|
|
22148
|
+
* The product\'s Vendure id: the line\'s posId, as a number
|
|
22149
|
+
* @type {number}
|
|
22150
|
+
* @memberof PricingBasketLineDto
|
|
22151
|
+
*/
|
|
22152
|
+
'productId'?: number;
|
|
22153
|
+
}
|
|
21918
22154
|
/**
|
|
21919
22155
|
*
|
|
21920
22156
|
* @export
|
|
@@ -24642,7 +24878,9 @@ export const ReportChangeField = {
|
|
|
24642
24878
|
PaymentReportSummaryTotalSurchargeAmount: 'paymentReport.summary.totalSurchargeAmount',
|
|
24643
24879
|
PaymentReportSummaryTotalRefunds: 'paymentReport.summary.totalRefunds',
|
|
24644
24880
|
PaymentReportSummaryRefundCount: 'paymentReport.summary.refundCount',
|
|
24645
|
-
PaymentReportTotalDiscounts: 'paymentReport.totalDiscounts'
|
|
24881
|
+
PaymentReportTotalDiscounts: 'paymentReport.totalDiscounts',
|
|
24882
|
+
OrderCount: 'orderCount',
|
|
24883
|
+
AverageOrderValue: 'averageOrderValue'
|
|
24646
24884
|
} as const;
|
|
24647
24885
|
|
|
24648
24886
|
export type ReportChangeField = typeof ReportChangeField[keyof typeof ReportChangeField];
|
|
@@ -25588,6 +25826,18 @@ export interface SalesReportComparisonDto {
|
|
|
25588
25826
|
* @memberof SalesReportComparisonDto
|
|
25589
25827
|
*/
|
|
25590
25828
|
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
25829
|
+
/**
|
|
25830
|
+
* 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
|
|
25831
|
+
* @type {number}
|
|
25832
|
+
* @memberof SalesReportComparisonDto
|
|
25833
|
+
*/
|
|
25834
|
+
'orderCount'?: number;
|
|
25835
|
+
/**
|
|
25836
|
+
* 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
|
|
25837
|
+
* @type {number}
|
|
25838
|
+
* @memberof SalesReportComparisonDto
|
|
25839
|
+
*/
|
|
25840
|
+
'averageOrderValue'?: number | null;
|
|
25591
25841
|
/**
|
|
25592
25842
|
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
25593
25843
|
* @type {Array<SalesReportChangeDto>}
|
|
@@ -25694,7 +25944,7 @@ export interface SalesReportDayDto {
|
|
|
25694
25944
|
*/
|
|
25695
25945
|
'date': string;
|
|
25696
25946
|
/**
|
|
25697
|
-
* How many orders were sold that day
|
|
25947
|
+
* 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
|
|
25698
25948
|
* @type {number}
|
|
25699
25949
|
* @memberof SalesReportDayDto
|
|
25700
25950
|
*/
|
|
@@ -25809,6 +26059,18 @@ export interface SalesReportGroupDto {
|
|
|
25809
26059
|
* @memberof SalesReportGroupDto
|
|
25810
26060
|
*/
|
|
25811
26061
|
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
26062
|
+
/**
|
|
26063
|
+
* 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
|
|
26064
|
+
* @type {number}
|
|
26065
|
+
* @memberof SalesReportGroupDto
|
|
26066
|
+
*/
|
|
26067
|
+
'orderCount'?: number;
|
|
26068
|
+
/**
|
|
26069
|
+
* 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
|
|
26070
|
+
* @type {number}
|
|
26071
|
+
* @memberof SalesReportGroupDto
|
|
26072
|
+
*/
|
|
26073
|
+
'averageOrderValue'?: number | null;
|
|
25812
26074
|
/**
|
|
25813
26075
|
*
|
|
25814
26076
|
* @type {SalesReportGroupDtoComparison}
|
|
@@ -25878,6 +26140,18 @@ export interface SalesReportGroupDtoComparison {
|
|
|
25878
26140
|
* @memberof SalesReportGroupDtoComparison
|
|
25879
26141
|
*/
|
|
25880
26142
|
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
26143
|
+
/**
|
|
26144
|
+
* 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
|
|
26145
|
+
* @type {number}
|
|
26146
|
+
* @memberof SalesReportGroupDtoComparison
|
|
26147
|
+
*/
|
|
26148
|
+
'orderCount'?: number;
|
|
26149
|
+
/**
|
|
26150
|
+
* 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
|
|
26151
|
+
* @type {number}
|
|
26152
|
+
* @memberof SalesReportGroupDtoComparison
|
|
26153
|
+
*/
|
|
26154
|
+
'averageOrderValue'?: number | null;
|
|
25881
26155
|
/**
|
|
25882
26156
|
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
25883
26157
|
* @type {Array<SalesReportChangeDto>}
|
|
@@ -26755,6 +27029,34 @@ export interface SendReportEmailDto {
|
|
|
26755
27029
|
}
|
|
26756
27030
|
|
|
26757
27031
|
|
|
27032
|
+
/**
|
|
27033
|
+
*
|
|
27034
|
+
* @export
|
|
27035
|
+
* @interface ServeMcpRequest403Response
|
|
27036
|
+
*/
|
|
27037
|
+
export interface ServeMcpRequest403Response {
|
|
27038
|
+
/**
|
|
27039
|
+
* Why the person\'s request is refused
|
|
27040
|
+
* @type {string}
|
|
27041
|
+
* @memberof ServeMcpRequest403Response
|
|
27042
|
+
*/
|
|
27043
|
+
'error'?: ErrorEnum;
|
|
27044
|
+
/**
|
|
27045
|
+
* With NOT_STORE_OWNER: each venue a tool call named that the person does not own
|
|
27046
|
+
* @type {Array<any>}
|
|
27047
|
+
* @memberof ServeMcpRequest403Response
|
|
27048
|
+
*/
|
|
27049
|
+
'venueIds'?: Array<any>;
|
|
27050
|
+
}
|
|
27051
|
+
|
|
27052
|
+
export const ErrorEnum = {
|
|
27053
|
+
NoAriAccess: 'NO_ARI_ACCESS',
|
|
27054
|
+
NotStoreOwner: 'NOT_STORE_OWNER',
|
|
27055
|
+
RightsUnavailable: 'RIGHTS_UNAVAILABLE'
|
|
27056
|
+
} as const;
|
|
27057
|
+
|
|
27058
|
+
export type ErrorEnum = typeof ErrorEnum[keyof typeof ErrorEnum];
|
|
27059
|
+
|
|
26758
27060
|
/**
|
|
26759
27061
|
*
|
|
26760
27062
|
* @export
|
|
@@ -36838,7 +37140,7 @@ export class AuthApi extends BaseAPI implements AuthApiInterface {
|
|
|
36838
37140
|
export const BusinessApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36839
37141
|
return {
|
|
36840
37142
|
/**
|
|
36841
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
37143
|
+
* 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.
|
|
36842
37144
|
* @summary Get unified discounts for all business and venue
|
|
36843
37145
|
* @param {string} businessId The venue\'s business id
|
|
36844
37146
|
* @param {*} [options] Override http request option.
|
|
@@ -37562,7 +37864,7 @@ export const BusinessApiFp = function(configuration?: Configuration) {
|
|
|
37562
37864
|
const localVarAxiosParamCreator = BusinessApiAxiosParamCreator(configuration)
|
|
37563
37865
|
return {
|
|
37564
37866
|
/**
|
|
37565
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
37867
|
+
* 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.
|
|
37566
37868
|
* @summary Get unified discounts for all business and venue
|
|
37567
37869
|
* @param {string} businessId The venue\'s business id
|
|
37568
37870
|
* @param {*} [options] Override http request option.
|
|
@@ -37772,7 +38074,7 @@ export const BusinessApiFactory = function (configuration?: Configuration, baseP
|
|
|
37772
38074
|
const localVarFp = BusinessApiFp(configuration)
|
|
37773
38075
|
return {
|
|
37774
38076
|
/**
|
|
37775
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
38077
|
+
* 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.
|
|
37776
38078
|
* @summary Get unified discounts for all business and venue
|
|
37777
38079
|
* @param {string} businessId The venue\'s business id
|
|
37778
38080
|
* @param {*} [options] Override http request option.
|
|
@@ -37964,7 +38266,7 @@ export const BusinessApiFactory = function (configuration?: Configuration, baseP
|
|
|
37964
38266
|
*/
|
|
37965
38267
|
export interface BusinessApiInterface {
|
|
37966
38268
|
/**
|
|
37967
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
38269
|
+
* 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.
|
|
37968
38270
|
* @summary Get unified discounts for all business and venue
|
|
37969
38271
|
* @param {string} businessId The venue\'s business id
|
|
37970
38272
|
* @param {*} [options] Override http request option.
|
|
@@ -38156,7 +38458,7 @@ export interface BusinessApiInterface {
|
|
|
38156
38458
|
*/
|
|
38157
38459
|
export class BusinessApi extends BaseAPI implements BusinessApiInterface {
|
|
38158
38460
|
/**
|
|
38159
|
-
* For the channel the x-app-x header names (any channel when it names none). Kept 30 days per venue and channel;
|
|
38461
|
+
* 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.
|
|
38160
38462
|
* @summary Get unified discounts for all business and venue
|
|
38161
38463
|
* @param {string} businessId The venue\'s business id
|
|
38162
38464
|
* @param {*} [options] Override http request option.
|
|
@@ -44844,7 +45146,7 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
44844
45146
|
};
|
|
44845
45147
|
},
|
|
44846
45148
|
/**
|
|
44847
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
45149
|
+
* 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.
|
|
44848
45150
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
44849
45151
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44850
45152
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44985,7 +45287,7 @@ export const HistoryApiFp = function(configuration?: Configuration) {
|
|
|
44985
45287
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
44986
45288
|
},
|
|
44987
45289
|
/**
|
|
44988
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
45290
|
+
* 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.
|
|
44989
45291
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
44990
45292
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44991
45293
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45043,7 +45345,7 @@ export const HistoryApiFactory = function (configuration?: Configuration, basePa
|
|
|
45043
45345
|
return localVarFp.getOrderHistoryPOSV5(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(axios, basePath));
|
|
45044
45346
|
},
|
|
45045
45347
|
/**
|
|
45046
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
45348
|
+
* 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.
|
|
45047
45349
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
45048
45350
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45049
45351
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45099,7 +45401,7 @@ export interface HistoryApiInterface {
|
|
|
45099
45401
|
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>;
|
|
45100
45402
|
|
|
45101
45403
|
/**
|
|
45102
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
45404
|
+
* 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.
|
|
45103
45405
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
45104
45406
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45105
45407
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45157,7 +45459,7 @@ export class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
45157
45459
|
}
|
|
45158
45460
|
|
|
45159
45461
|
/**
|
|
45160
|
-
* The same answer as GET history/orders/pos, for a service holding the service key.
|
|
45462
|
+
* 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.
|
|
45161
45463
|
* @summary POS order history of the first venue named, for munchi-dashboard-server
|
|
45162
45464
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45163
45465
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45190,7 +45492,7 @@ export class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
45190
45492
|
export const HistoryV6ApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
45191
45493
|
return {
|
|
45192
45494
|
/**
|
|
45193
|
-
* 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.
|
|
45495
|
+
* 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.
|
|
45194
45496
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
45195
45497
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45196
45498
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45514,7 +45816,7 @@ export const HistoryV6ApiFp = function(configuration?: Configuration) {
|
|
|
45514
45816
|
const localVarAxiosParamCreator = HistoryV6ApiAxiosParamCreator(configuration)
|
|
45515
45817
|
return {
|
|
45516
45818
|
/**
|
|
45517
|
-
* 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.
|
|
45819
|
+
* 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.
|
|
45518
45820
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
45519
45821
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45520
45822
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45596,7 +45898,7 @@ export const HistoryV6ApiFactory = function (configuration?: Configuration, base
|
|
|
45596
45898
|
const localVarFp = HistoryV6ApiFp(configuration)
|
|
45597
45899
|
return {
|
|
45598
45900
|
/**
|
|
45599
|
-
* 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.
|
|
45901
|
+
* 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.
|
|
45600
45902
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
45601
45903
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45602
45904
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45674,7 +45976,7 @@ export const HistoryV6ApiFactory = function (configuration?: Configuration, base
|
|
|
45674
45976
|
*/
|
|
45675
45977
|
export interface HistoryV6ApiInterface {
|
|
45676
45978
|
/**
|
|
45677
|
-
* 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.
|
|
45979
|
+
* 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.
|
|
45678
45980
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
45679
45981
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45680
45982
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45752,7 +46054,7 @@ export interface HistoryV6ApiInterface {
|
|
|
45752
46054
|
*/
|
|
45753
46055
|
export class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterface {
|
|
45754
46056
|
/**
|
|
45755
|
-
* 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.
|
|
46057
|
+
* 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.
|
|
45756
46058
|
* @summary Online order history of the venues, for munchi-dashboard-server
|
|
45757
46059
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45758
46060
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -48810,7 +49112,7 @@ export const MCPApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
48810
49112
|
};
|
|
48811
49113
|
},
|
|
48812
49114
|
/**
|
|
48813
|
-
* 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
|
|
49115
|
+
* 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).
|
|
48814
49116
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
48815
49117
|
* @param {object} body A JSON-RPC 2.0 message
|
|
48816
49118
|
* @param {*} [options] Override http request option.
|
|
@@ -48880,7 +49182,7 @@ export const MCPApiFp = function(configuration?: Configuration) {
|
|
|
48880
49182
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
48881
49183
|
},
|
|
48882
49184
|
/**
|
|
48883
|
-
* 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
|
|
49185
|
+
* 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).
|
|
48884
49186
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
48885
49187
|
* @param {object} body A JSON-RPC 2.0 message
|
|
48886
49188
|
* @param {*} [options] Override http request option.
|
|
@@ -48919,7 +49221,7 @@ export const MCPApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
48919
49221
|
return localVarFp.refuseStream(options).then((request) => request(axios, basePath));
|
|
48920
49222
|
},
|
|
48921
49223
|
/**
|
|
48922
|
-
* 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
|
|
49224
|
+
* 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).
|
|
48923
49225
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
48924
49226
|
* @param {object} body A JSON-RPC 2.0 message
|
|
48925
49227
|
* @param {*} [options] Override http request option.
|
|
@@ -48956,7 +49258,7 @@ export interface MCPApiInterface {
|
|
|
48956
49258
|
refuseStream(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
48957
49259
|
|
|
48958
49260
|
/**
|
|
48959
|
-
* 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
|
|
49261
|
+
* 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).
|
|
48960
49262
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
48961
49263
|
* @param {object} body A JSON-RPC 2.0 message
|
|
48962
49264
|
* @param {*} [options] Override http request option.
|
|
@@ -48997,7 +49299,7 @@ export class MCPApi extends BaseAPI implements MCPApiInterface {
|
|
|
48997
49299
|
}
|
|
48998
49300
|
|
|
48999
49301
|
/**
|
|
49000
|
-
* 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
|
|
49302
|
+
* 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).
|
|
49001
49303
|
* @summary The MCP server for Munchi ops (Streamable HTTP, stateless)
|
|
49002
49304
|
* @param {object} body A JSON-RPC 2.0 message
|
|
49003
49305
|
* @param {*} [options] Override http request option.
|
|
@@ -50364,7 +50666,7 @@ export class OrderCompletionApi extends BaseAPI implements OrderCompletionApiInt
|
|
|
50364
50666
|
export const OrderInternalApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
50365
50667
|
return {
|
|
50366
50668
|
/**
|
|
50367
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
50669
|
+
* 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.
|
|
50368
50670
|
* @summary Get order data by external ID for internal microservice communication
|
|
50369
50671
|
* @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
|
|
50370
50672
|
* @param {*} [options] Override http request option.
|
|
@@ -50408,7 +50710,7 @@ export const OrderInternalApiFp = function(configuration?: Configuration) {
|
|
|
50408
50710
|
const localVarAxiosParamCreator = OrderInternalApiAxiosParamCreator(configuration)
|
|
50409
50711
|
return {
|
|
50410
50712
|
/**
|
|
50411
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
50713
|
+
* 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.
|
|
50412
50714
|
* @summary Get order data by external ID for internal microservice communication
|
|
50413
50715
|
* @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
|
|
50414
50716
|
* @param {*} [options] Override http request option.
|
|
@@ -50429,7 +50731,7 @@ export const OrderInternalApiFactory = function (configuration?: Configuration,
|
|
|
50429
50731
|
const localVarFp = OrderInternalApiFp(configuration)
|
|
50430
50732
|
return {
|
|
50431
50733
|
/**
|
|
50432
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
50734
|
+
* 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.
|
|
50433
50735
|
* @summary Get order data by external ID for internal microservice communication
|
|
50434
50736
|
* @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
|
|
50435
50737
|
* @param {*} [options] Override http request option.
|
|
@@ -50448,7 +50750,7 @@ export const OrderInternalApiFactory = function (configuration?: Configuration,
|
|
|
50448
50750
|
*/
|
|
50449
50751
|
export interface OrderInternalApiInterface {
|
|
50450
50752
|
/**
|
|
50451
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
50753
|
+
* 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.
|
|
50452
50754
|
* @summary Get order data by external ID for internal microservice communication
|
|
50453
50755
|
* @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
|
|
50454
50756
|
* @param {*} [options] Override http request option.
|
|
@@ -50467,7 +50769,7 @@ export interface OrderInternalApiInterface {
|
|
|
50467
50769
|
*/
|
|
50468
50770
|
export class OrderInternalApi extends BaseAPI implements OrderInternalApiInterface {
|
|
50469
50771
|
/**
|
|
50470
|
-
* kds-service reads one platform order from Postgres, whole, with the shared service key in x-api-key or as a Bearer token.
|
|
50772
|
+
* 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.
|
|
50471
50773
|
* @summary Get order data by external ID for internal microservice communication
|
|
50472
50774
|
* @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
|
|
50473
50775
|
* @param {*} [options] Override http request option.
|
|
@@ -57215,6 +57517,388 @@ export class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
57215
57517
|
}
|
|
57216
57518
|
|
|
57217
57519
|
|
|
57520
|
+
/**
|
|
57521
|
+
* PromotionsApi - axios parameter creator
|
|
57522
|
+
* @export
|
|
57523
|
+
*/
|
|
57524
|
+
export const PromotionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
57525
|
+
return {
|
|
57526
|
+
/**
|
|
57527
|
+
* 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.
|
|
57528
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
57529
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57530
|
+
* @param {*} [options] Override http request option.
|
|
57531
|
+
* @throws {RequiredError}
|
|
57532
|
+
*/
|
|
57533
|
+
listAutomaticPromotions: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57534
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
57535
|
+
assertParamExists('listAutomaticPromotions', 'businessId', businessId)
|
|
57536
|
+
const localVarPath = `/api/v2/venues/{businessId}/promotions/automatic`
|
|
57537
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
57538
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57539
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57540
|
+
let baseOptions;
|
|
57541
|
+
if (configuration) {
|
|
57542
|
+
baseOptions = configuration.baseOptions;
|
|
57543
|
+
}
|
|
57544
|
+
|
|
57545
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
57546
|
+
const localVarHeaderParameter = {} as any;
|
|
57547
|
+
const localVarQueryParameter = {} as any;
|
|
57548
|
+
|
|
57549
|
+
// authentication JWT-auth required
|
|
57550
|
+
// http bearer authentication required
|
|
57551
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
57552
|
+
|
|
57553
|
+
|
|
57554
|
+
|
|
57555
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57556
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57557
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57558
|
+
|
|
57559
|
+
return {
|
|
57560
|
+
url: toPathString(localVarUrlObj),
|
|
57561
|
+
options: localVarRequestOptions,
|
|
57562
|
+
};
|
|
57563
|
+
},
|
|
57564
|
+
/**
|
|
57565
|
+
* 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.
|
|
57566
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
57567
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57568
|
+
* @param {*} [options] Override http request option.
|
|
57569
|
+
* @throws {RequiredError}
|
|
57570
|
+
*/
|
|
57571
|
+
listKioskAutomaticPromotions: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57572
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
57573
|
+
assertParamExists('listKioskAutomaticPromotions', 'businessId', businessId)
|
|
57574
|
+
const localVarPath = `/api/v2/kiosk/venues/{businessId}/promotions/automatic`
|
|
57575
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
57576
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57577
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57578
|
+
let baseOptions;
|
|
57579
|
+
if (configuration) {
|
|
57580
|
+
baseOptions = configuration.baseOptions;
|
|
57581
|
+
}
|
|
57582
|
+
|
|
57583
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
57584
|
+
const localVarHeaderParameter = {} as any;
|
|
57585
|
+
const localVarQueryParameter = {} as any;
|
|
57586
|
+
|
|
57587
|
+
|
|
57588
|
+
|
|
57589
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57590
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57591
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57592
|
+
|
|
57593
|
+
return {
|
|
57594
|
+
url: toPathString(localVarUrlObj),
|
|
57595
|
+
options: localVarRequestOptions,
|
|
57596
|
+
};
|
|
57597
|
+
},
|
|
57598
|
+
/**
|
|
57599
|
+
* 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.
|
|
57600
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
57601
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57602
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57603
|
+
* @param {*} [options] Override http request option.
|
|
57604
|
+
* @throws {RequiredError}
|
|
57605
|
+
*/
|
|
57606
|
+
priceBasketWithPromotions: async (businessId: number, priceBasketDto: PriceBasketDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57607
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
57608
|
+
assertParamExists('priceBasketWithPromotions', 'businessId', businessId)
|
|
57609
|
+
// verify required parameter 'priceBasketDto' is not null or undefined
|
|
57610
|
+
assertParamExists('priceBasketWithPromotions', 'priceBasketDto', priceBasketDto)
|
|
57611
|
+
const localVarPath = `/api/v2/venues/{businessId}/promotions/price`
|
|
57612
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
57613
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57614
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57615
|
+
let baseOptions;
|
|
57616
|
+
if (configuration) {
|
|
57617
|
+
baseOptions = configuration.baseOptions;
|
|
57618
|
+
}
|
|
57619
|
+
|
|
57620
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
57621
|
+
const localVarHeaderParameter = {} as any;
|
|
57622
|
+
const localVarQueryParameter = {} as any;
|
|
57623
|
+
|
|
57624
|
+
// authentication JWT-auth required
|
|
57625
|
+
// http bearer authentication required
|
|
57626
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
57627
|
+
|
|
57628
|
+
|
|
57629
|
+
|
|
57630
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
57631
|
+
|
|
57632
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57633
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57634
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57635
|
+
localVarRequestOptions.data = serializeDataIfNeeded(priceBasketDto, localVarRequestOptions, configuration)
|
|
57636
|
+
|
|
57637
|
+
return {
|
|
57638
|
+
url: toPathString(localVarUrlObj),
|
|
57639
|
+
options: localVarRequestOptions,
|
|
57640
|
+
};
|
|
57641
|
+
},
|
|
57642
|
+
/**
|
|
57643
|
+
* 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.
|
|
57644
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
57645
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57646
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57647
|
+
* @param {*} [options] Override http request option.
|
|
57648
|
+
* @throws {RequiredError}
|
|
57649
|
+
*/
|
|
57650
|
+
priceKioskBasketWithPromotions: async (businessId: number, priceBasketDto: PriceBasketDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
57651
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
57652
|
+
assertParamExists('priceKioskBasketWithPromotions', 'businessId', businessId)
|
|
57653
|
+
// verify required parameter 'priceBasketDto' is not null or undefined
|
|
57654
|
+
assertParamExists('priceKioskBasketWithPromotions', 'priceBasketDto', priceBasketDto)
|
|
57655
|
+
const localVarPath = `/api/v2/kiosk/venues/{businessId}/promotions/price`
|
|
57656
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
57657
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
57658
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
57659
|
+
let baseOptions;
|
|
57660
|
+
if (configuration) {
|
|
57661
|
+
baseOptions = configuration.baseOptions;
|
|
57662
|
+
}
|
|
57663
|
+
|
|
57664
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
57665
|
+
const localVarHeaderParameter = {} as any;
|
|
57666
|
+
const localVarQueryParameter = {} as any;
|
|
57667
|
+
|
|
57668
|
+
|
|
57669
|
+
|
|
57670
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
57671
|
+
|
|
57672
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57673
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57674
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57675
|
+
localVarRequestOptions.data = serializeDataIfNeeded(priceBasketDto, localVarRequestOptions, configuration)
|
|
57676
|
+
|
|
57677
|
+
return {
|
|
57678
|
+
url: toPathString(localVarUrlObj),
|
|
57679
|
+
options: localVarRequestOptions,
|
|
57680
|
+
};
|
|
57681
|
+
},
|
|
57682
|
+
}
|
|
57683
|
+
};
|
|
57684
|
+
|
|
57685
|
+
/**
|
|
57686
|
+
* PromotionsApi - functional programming interface
|
|
57687
|
+
* @export
|
|
57688
|
+
*/
|
|
57689
|
+
export const PromotionsApiFp = function(configuration?: Configuration) {
|
|
57690
|
+
const localVarAxiosParamCreator = PromotionsApiAxiosParamCreator(configuration)
|
|
57691
|
+
return {
|
|
57692
|
+
/**
|
|
57693
|
+
* 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.
|
|
57694
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
57695
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57696
|
+
* @param {*} [options] Override http request option.
|
|
57697
|
+
* @throws {RequiredError}
|
|
57698
|
+
*/
|
|
57699
|
+
async listAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutomaticPromotionsAnswerDto>> {
|
|
57700
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAutomaticPromotions(businessId, options);
|
|
57701
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57702
|
+
},
|
|
57703
|
+
/**
|
|
57704
|
+
* 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.
|
|
57705
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
57706
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57707
|
+
* @param {*} [options] Override http request option.
|
|
57708
|
+
* @throws {RequiredError}
|
|
57709
|
+
*/
|
|
57710
|
+
async listKioskAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AutomaticPromotionsAnswerDto>> {
|
|
57711
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listKioskAutomaticPromotions(businessId, options);
|
|
57712
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57713
|
+
},
|
|
57714
|
+
/**
|
|
57715
|
+
* 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.
|
|
57716
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
57717
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57718
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57719
|
+
* @param {*} [options] Override http request option.
|
|
57720
|
+
* @throws {RequiredError}
|
|
57721
|
+
*/
|
|
57722
|
+
async priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PriceBasketAnswerDto>> {
|
|
57723
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.priceBasketWithPromotions(businessId, priceBasketDto, options);
|
|
57724
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57725
|
+
},
|
|
57726
|
+
/**
|
|
57727
|
+
* 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.
|
|
57728
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
57729
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57730
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57731
|
+
* @param {*} [options] Override http request option.
|
|
57732
|
+
* @throws {RequiredError}
|
|
57733
|
+
*/
|
|
57734
|
+
async priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PriceBasketAnswerDto>> {
|
|
57735
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.priceKioskBasketWithPromotions(businessId, priceBasketDto, options);
|
|
57736
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57737
|
+
},
|
|
57738
|
+
}
|
|
57739
|
+
};
|
|
57740
|
+
|
|
57741
|
+
/**
|
|
57742
|
+
* PromotionsApi - factory interface
|
|
57743
|
+
* @export
|
|
57744
|
+
*/
|
|
57745
|
+
export const PromotionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
57746
|
+
const localVarFp = PromotionsApiFp(configuration)
|
|
57747
|
+
return {
|
|
57748
|
+
/**
|
|
57749
|
+
* 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.
|
|
57750
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
57751
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57752
|
+
* @param {*} [options] Override http request option.
|
|
57753
|
+
* @throws {RequiredError}
|
|
57754
|
+
*/
|
|
57755
|
+
listAutomaticPromotions(businessId: number, options?: any): AxiosPromise<AutomaticPromotionsAnswerDto> {
|
|
57756
|
+
return localVarFp.listAutomaticPromotions(businessId, options).then((request) => request(axios, basePath));
|
|
57757
|
+
},
|
|
57758
|
+
/**
|
|
57759
|
+
* 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.
|
|
57760
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
57761
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57762
|
+
* @param {*} [options] Override http request option.
|
|
57763
|
+
* @throws {RequiredError}
|
|
57764
|
+
*/
|
|
57765
|
+
listKioskAutomaticPromotions(businessId: number, options?: any): AxiosPromise<AutomaticPromotionsAnswerDto> {
|
|
57766
|
+
return localVarFp.listKioskAutomaticPromotions(businessId, options).then((request) => request(axios, basePath));
|
|
57767
|
+
},
|
|
57768
|
+
/**
|
|
57769
|
+
* 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.
|
|
57770
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
57771
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57772
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57773
|
+
* @param {*} [options] Override http request option.
|
|
57774
|
+
* @throws {RequiredError}
|
|
57775
|
+
*/
|
|
57776
|
+
priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: any): AxiosPromise<PriceBasketAnswerDto> {
|
|
57777
|
+
return localVarFp.priceBasketWithPromotions(businessId, priceBasketDto, options).then((request) => request(axios, basePath));
|
|
57778
|
+
},
|
|
57779
|
+
/**
|
|
57780
|
+
* 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.
|
|
57781
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
57782
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57783
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57784
|
+
* @param {*} [options] Override http request option.
|
|
57785
|
+
* @throws {RequiredError}
|
|
57786
|
+
*/
|
|
57787
|
+
priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: any): AxiosPromise<PriceBasketAnswerDto> {
|
|
57788
|
+
return localVarFp.priceKioskBasketWithPromotions(businessId, priceBasketDto, options).then((request) => request(axios, basePath));
|
|
57789
|
+
},
|
|
57790
|
+
};
|
|
57791
|
+
};
|
|
57792
|
+
|
|
57793
|
+
/**
|
|
57794
|
+
* PromotionsApi - interface
|
|
57795
|
+
* @export
|
|
57796
|
+
* @interface PromotionsApi
|
|
57797
|
+
*/
|
|
57798
|
+
export interface PromotionsApiInterface {
|
|
57799
|
+
/**
|
|
57800
|
+
* 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.
|
|
57801
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
57802
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57803
|
+
* @param {*} [options] Override http request option.
|
|
57804
|
+
* @throws {RequiredError}
|
|
57805
|
+
* @memberof PromotionsApiInterface
|
|
57806
|
+
*/
|
|
57807
|
+
listAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): AxiosPromise<AutomaticPromotionsAnswerDto>;
|
|
57808
|
+
|
|
57809
|
+
/**
|
|
57810
|
+
* 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.
|
|
57811
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
57812
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57813
|
+
* @param {*} [options] Override http request option.
|
|
57814
|
+
* @throws {RequiredError}
|
|
57815
|
+
* @memberof PromotionsApiInterface
|
|
57816
|
+
*/
|
|
57817
|
+
listKioskAutomaticPromotions(businessId: number, options?: AxiosRequestConfig): AxiosPromise<AutomaticPromotionsAnswerDto>;
|
|
57818
|
+
|
|
57819
|
+
/**
|
|
57820
|
+
* 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.
|
|
57821
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
57822
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57823
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57824
|
+
* @param {*} [options] Override http request option.
|
|
57825
|
+
* @throws {RequiredError}
|
|
57826
|
+
* @memberof PromotionsApiInterface
|
|
57827
|
+
*/
|
|
57828
|
+
priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): AxiosPromise<PriceBasketAnswerDto>;
|
|
57829
|
+
|
|
57830
|
+
/**
|
|
57831
|
+
* 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.
|
|
57832
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
57833
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57834
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57835
|
+
* @param {*} [options] Override http request option.
|
|
57836
|
+
* @throws {RequiredError}
|
|
57837
|
+
* @memberof PromotionsApiInterface
|
|
57838
|
+
*/
|
|
57839
|
+
priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig): AxiosPromise<PriceBasketAnswerDto>;
|
|
57840
|
+
|
|
57841
|
+
}
|
|
57842
|
+
|
|
57843
|
+
/**
|
|
57844
|
+
* PromotionsApi - object-oriented interface
|
|
57845
|
+
* @export
|
|
57846
|
+
* @class PromotionsApi
|
|
57847
|
+
* @extends {BaseAPI}
|
|
57848
|
+
*/
|
|
57849
|
+
export class PromotionsApi extends BaseAPI implements PromotionsApiInterface {
|
|
57850
|
+
/**
|
|
57851
|
+
* 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.
|
|
57852
|
+
* @summary List the venue\'s automatic promotions running now on the POS
|
|
57853
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57854
|
+
* @param {*} [options] Override http request option.
|
|
57855
|
+
* @throws {RequiredError}
|
|
57856
|
+
* @memberof PromotionsApi
|
|
57857
|
+
*/
|
|
57858
|
+
public listAutomaticPromotions(businessId: number, options?: AxiosRequestConfig) {
|
|
57859
|
+
return PromotionsApiFp(this.configuration).listAutomaticPromotions(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
57860
|
+
}
|
|
57861
|
+
|
|
57862
|
+
/**
|
|
57863
|
+
* 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.
|
|
57864
|
+
* @summary List the venue\'s automatic promotions running now on the kiosk
|
|
57865
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57866
|
+
* @param {*} [options] Override http request option.
|
|
57867
|
+
* @throws {RequiredError}
|
|
57868
|
+
* @memberof PromotionsApi
|
|
57869
|
+
*/
|
|
57870
|
+
public listKioskAutomaticPromotions(businessId: number, options?: AxiosRequestConfig) {
|
|
57871
|
+
return PromotionsApiFp(this.configuration).listKioskAutomaticPromotions(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
57872
|
+
}
|
|
57873
|
+
|
|
57874
|
+
/**
|
|
57875
|
+
* 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.
|
|
57876
|
+
* @summary Price a till\'s basket with the venue\'s promotions
|
|
57877
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
57878
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57879
|
+
* @param {*} [options] Override http request option.
|
|
57880
|
+
* @throws {RequiredError}
|
|
57881
|
+
* @memberof PromotionsApi
|
|
57882
|
+
*/
|
|
57883
|
+
public priceBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig) {
|
|
57884
|
+
return PromotionsApiFp(this.configuration).priceBasketWithPromotions(businessId, priceBasketDto, options).then((request) => request(this.axios, this.basePath));
|
|
57885
|
+
}
|
|
57886
|
+
|
|
57887
|
+
/**
|
|
57888
|
+
* 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.
|
|
57889
|
+
* @summary Price a kiosk\'s basket with the venue\'s promotions
|
|
57890
|
+
* @param {number} businessId The venue\'s orderingBusinessId, the kiosk\'s own venue
|
|
57891
|
+
* @param {PriceBasketDto} priceBasketDto
|
|
57892
|
+
* @param {*} [options] Override http request option.
|
|
57893
|
+
* @throws {RequiredError}
|
|
57894
|
+
* @memberof PromotionsApi
|
|
57895
|
+
*/
|
|
57896
|
+
public priceKioskBasketWithPromotions(businessId: number, priceBasketDto: PriceBasketDto, options?: AxiosRequestConfig) {
|
|
57897
|
+
return PromotionsApiFp(this.configuration).priceKioskBasketWithPromotions(businessId, priceBasketDto, options).then((request) => request(this.axios, this.basePath));
|
|
57898
|
+
}
|
|
57899
|
+
}
|
|
57900
|
+
|
|
57901
|
+
|
|
57218
57902
|
/**
|
|
57219
57903
|
* ProviderApi - axios parameter creator
|
|
57220
57904
|
* @export
|