@munchi_oy/core 1.9.131 → 1.9.132
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 +2241 -2
- 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 +2876 -3
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -99,6 +99,7 @@ export const EntityTypeEnum = {
|
|
|
99
99
|
Role: 'role',
|
|
100
100
|
Shift: 'shift',
|
|
101
101
|
Employee: 'employee',
|
|
102
|
+
ActionPasscode: 'action_passcode',
|
|
102
103
|
Config: 'config',
|
|
103
104
|
Business: 'business',
|
|
104
105
|
Suboption: 'suboption',
|
|
@@ -140,6 +141,19 @@ export interface AcceptOrderDto {
|
|
|
140
141
|
}
|
|
141
142
|
|
|
142
143
|
|
|
144
|
+
/**
|
|
145
|
+
*
|
|
146
|
+
* @export
|
|
147
|
+
* @interface ActionApprovalResponseDto
|
|
148
|
+
*/
|
|
149
|
+
export interface ActionApprovalResponseDto {
|
|
150
|
+
/**
|
|
151
|
+
* Send in the x-action-approval header of the protected request
|
|
152
|
+
* @type {string}
|
|
153
|
+
* @memberof ActionApprovalResponseDto
|
|
154
|
+
*/
|
|
155
|
+
'actionApproval': string;
|
|
156
|
+
}
|
|
143
157
|
/**
|
|
144
158
|
*
|
|
145
159
|
* @export
|
|
@@ -227,6 +241,20 @@ export interface ActivateKioskOfferDto {
|
|
|
227
241
|
*/
|
|
228
242
|
'catalogId': number;
|
|
229
243
|
}
|
|
244
|
+
/**
|
|
245
|
+
*
|
|
246
|
+
* @export
|
|
247
|
+
* @enum {string}
|
|
248
|
+
*/
|
|
249
|
+
|
|
250
|
+
export const ActorType = {
|
|
251
|
+
Employee: 'employee',
|
|
252
|
+
Tablet: 'tablet'
|
|
253
|
+
} as const;
|
|
254
|
+
|
|
255
|
+
export type ActorType = typeof ActorType[keyof typeof ActorType];
|
|
256
|
+
|
|
257
|
+
|
|
230
258
|
/**
|
|
231
259
|
*
|
|
232
260
|
* @export
|
|
@@ -470,6 +498,20 @@ export interface AmountDto {
|
|
|
470
498
|
*/
|
|
471
499
|
'currency': string;
|
|
472
500
|
}
|
|
501
|
+
/**
|
|
502
|
+
*
|
|
503
|
+
* @export
|
|
504
|
+
* @enum {string}
|
|
505
|
+
*/
|
|
506
|
+
|
|
507
|
+
export const ApprovalKind = {
|
|
508
|
+
Action: 'action',
|
|
509
|
+
Screen: 'screen'
|
|
510
|
+
} as const;
|
|
511
|
+
|
|
512
|
+
export type ApprovalKind = typeof ApprovalKind[keyof typeof ApprovalKind];
|
|
513
|
+
|
|
514
|
+
|
|
473
515
|
/**
|
|
474
516
|
*
|
|
475
517
|
* @export
|
|
@@ -2505,6 +2547,104 @@ export interface CatalogMethodDtoCapabilities {
|
|
|
2505
2547
|
}
|
|
2506
2548
|
|
|
2507
2549
|
|
|
2550
|
+
/**
|
|
2551
|
+
*
|
|
2552
|
+
* @export
|
|
2553
|
+
* @interface CatalogPermissionDto
|
|
2554
|
+
*/
|
|
2555
|
+
export interface CatalogPermissionDto {
|
|
2556
|
+
/**
|
|
2557
|
+
*
|
|
2558
|
+
* @type {string}
|
|
2559
|
+
* @memberof CatalogPermissionDto
|
|
2560
|
+
*/
|
|
2561
|
+
'key': KeyEnum;
|
|
2562
|
+
/**
|
|
2563
|
+
*
|
|
2564
|
+
* @type {string}
|
|
2565
|
+
* @memberof CatalogPermissionDto
|
|
2566
|
+
*/
|
|
2567
|
+
'label': string;
|
|
2568
|
+
/**
|
|
2569
|
+
*
|
|
2570
|
+
* @type {PermissionKind}
|
|
2571
|
+
* @memberof CatalogPermissionDto
|
|
2572
|
+
*/
|
|
2573
|
+
'kind': PermissionKind;
|
|
2574
|
+
}
|
|
2575
|
+
|
|
2576
|
+
export const KeyEnum = {
|
|
2577
|
+
AccessPosApp: 'Access::PosApp',
|
|
2578
|
+
PagePos: 'Page::Pos',
|
|
2579
|
+
PageOpenOrders: 'Page::OpenOrders',
|
|
2580
|
+
PageOrders: 'Page::Orders',
|
|
2581
|
+
PageTransactions: 'Page::Transactions',
|
|
2582
|
+
PageProducts: 'Page::Products',
|
|
2583
|
+
PageReports: 'Page::Reports',
|
|
2584
|
+
PageSettings: 'Page::Settings',
|
|
2585
|
+
PageFloorPlan: 'Page::FloorPlan',
|
|
2586
|
+
Cart: 'Cart::*',
|
|
2587
|
+
CartAddItem: 'Cart::AddItem',
|
|
2588
|
+
CartRemoveItem: 'Cart::RemoveItem',
|
|
2589
|
+
CartApplyDiscount: 'Cart::ApplyDiscount',
|
|
2590
|
+
CartVoidItem: 'Cart::VoidItem',
|
|
2591
|
+
CartClear: 'Cart::Clear',
|
|
2592
|
+
CartRemoveDiscount: 'Cart::RemoveDiscount',
|
|
2593
|
+
CartVoidPayment: 'Cart::VoidPayment',
|
|
2594
|
+
Cash: 'Cash::*',
|
|
2595
|
+
CashOpenDay: 'Cash::OpenDay',
|
|
2596
|
+
CashCloseDay: 'Cash::CloseDay',
|
|
2597
|
+
CashCashIn: 'Cash::CashIn',
|
|
2598
|
+
CashCashOut: 'Cash::CashOut',
|
|
2599
|
+
CashOpenDrawer: 'Cash::OpenDrawer',
|
|
2600
|
+
CashPrintReport: 'Cash::PrintReport',
|
|
2601
|
+
CashSendReport: 'Cash::SendReport',
|
|
2602
|
+
Transaction: 'Transaction::*',
|
|
2603
|
+
TransactionRefund: 'Transaction::Refund',
|
|
2604
|
+
TransactionViewAll: 'Transaction::ViewAll',
|
|
2605
|
+
TransactionViewTips: 'Transaction::ViewTips',
|
|
2606
|
+
TransactionViewSurcharges: 'Transaction::ViewSurcharges',
|
|
2607
|
+
TransactionViewDiscounts: 'Transaction::ViewDiscounts',
|
|
2608
|
+
TransactionTotals: 'TransactionTotals::*',
|
|
2609
|
+
TransactionTotalsOrders: 'TransactionTotals::Orders',
|
|
2610
|
+
TransactionTotalsSales: 'TransactionTotals::Sales',
|
|
2611
|
+
TransactionTotalsRejectedOrders: 'TransactionTotals::RejectedOrders',
|
|
2612
|
+
TransactionTotalsRejectedSales: 'TransactionTotals::RejectedSales',
|
|
2613
|
+
Order: 'Order::*',
|
|
2614
|
+
OrderSendReceipt: 'Order::SendReceipt',
|
|
2615
|
+
OpenOrdersDelete: 'OpenOrders::Delete',
|
|
2616
|
+
OpenOrdersSendToKitchen: 'OpenOrders::SendToKitchen',
|
|
2617
|
+
OpenOrdersFireCourse: 'OpenOrders::FireCourse',
|
|
2618
|
+
Shift: 'Shift::*',
|
|
2619
|
+
ShiftForceClockOut: 'Shift::ForceClockOut',
|
|
2620
|
+
FloorPlan: 'FloorPlan::*',
|
|
2621
|
+
FloorPlanEditLayout: 'FloorPlan::EditLayout',
|
|
2622
|
+
FloorPlanChangeTableStatus: 'FloorPlan::ChangeTableStatus',
|
|
2623
|
+
FloorPlanManageSections: 'FloorPlan::ManageSections',
|
|
2624
|
+
Settings: 'Settings::*',
|
|
2625
|
+
SettingsEditProfile: 'Settings::EditProfile',
|
|
2626
|
+
Report: 'Report::*',
|
|
2627
|
+
ReportSendEmail: 'Report::SendEmail',
|
|
2628
|
+
ReportViewAll: 'Report::ViewAll',
|
|
2629
|
+
ReportViewSalesSummary: 'Report::ViewSalesSummary',
|
|
2630
|
+
ReportViewPaymentMethods: 'Report::ViewPaymentMethods',
|
|
2631
|
+
ReportViewItemSales: 'Report::ViewItemSales',
|
|
2632
|
+
ReportViewCashLogs: 'Report::ViewCashLogs',
|
|
2633
|
+
ReportTotals: 'ReportTotals::*',
|
|
2634
|
+
ReportTotalsOrders: 'ReportTotals::Orders',
|
|
2635
|
+
ReportTotalsSales: 'ReportTotals::Sales',
|
|
2636
|
+
ReportTotalsTips: 'ReportTotals::Tips',
|
|
2637
|
+
ReportTotalsSurcharges: 'ReportTotals::Surcharges',
|
|
2638
|
+
ReportTotalsRejectedOrders: 'ReportTotals::RejectedOrders',
|
|
2639
|
+
ReportTotalsRejectedSales: 'ReportTotals::RejectedSales',
|
|
2640
|
+
ReportTotalsAverageSale: 'ReportTotals::AverageSale',
|
|
2641
|
+
ReportTotalsItems: 'ReportTotals::Items',
|
|
2642
|
+
ReportTotalsRefunds: 'ReportTotals::Refunds',
|
|
2643
|
+
ReportTotalsDiscounts: 'ReportTotals::Discounts'
|
|
2644
|
+
} as const;
|
|
2645
|
+
|
|
2646
|
+
export type KeyEnum = typeof KeyEnum[keyof typeof KeyEnum];
|
|
2647
|
+
|
|
2508
2648
|
/**
|
|
2509
2649
|
*
|
|
2510
2650
|
* @export
|
|
@@ -3724,7 +3864,7 @@ export interface CreateManualSessionDto {
|
|
|
3724
3864
|
*/
|
|
3725
3865
|
'order': CreateManualSessionDtoOrder;
|
|
3726
3866
|
/**
|
|
3727
|
-
*
|
|
3867
|
+
* Staff to name on the cash log (staffId, staffName). A cash payment is recorded in the business\'s open cash session whether or not this is sent; enabled and sessionId are no longer read.
|
|
3728
3868
|
* @type {object}
|
|
3729
3869
|
* @memberof CreateManualSessionDto
|
|
3730
3870
|
*/
|
|
@@ -5864,6 +6004,183 @@ export interface EndOfDayReportDtoV4TaxBreakdown {
|
|
|
5864
6004
|
*/
|
|
5865
6005
|
'totalTaxAmount': number;
|
|
5866
6006
|
}
|
|
6007
|
+
/**
|
|
6008
|
+
*
|
|
6009
|
+
* @export
|
|
6010
|
+
* @interface EndOfDayReportResponseDtoV6
|
|
6011
|
+
*/
|
|
6012
|
+
export interface EndOfDayReportResponseDtoV6 {
|
|
6013
|
+
/**
|
|
6014
|
+
* Report generated at
|
|
6015
|
+
* @type {string}
|
|
6016
|
+
* @memberof EndOfDayReportResponseDtoV6
|
|
6017
|
+
*/
|
|
6018
|
+
'reportGeneratedAt': string;
|
|
6019
|
+
/**
|
|
6020
|
+
* Report date start
|
|
6021
|
+
* @type {string}
|
|
6022
|
+
* @memberof EndOfDayReportResponseDtoV6
|
|
6023
|
+
*/
|
|
6024
|
+
'reportDateStart': string;
|
|
6025
|
+
/**
|
|
6026
|
+
* Report date end
|
|
6027
|
+
* @type {string}
|
|
6028
|
+
* @memberof EndOfDayReportResponseDtoV6
|
|
6029
|
+
*/
|
|
6030
|
+
'reportDateEnd': string;
|
|
6031
|
+
/**
|
|
6032
|
+
* Business ID
|
|
6033
|
+
* @type {number}
|
|
6034
|
+
* @memberof EndOfDayReportResponseDtoV6
|
|
6035
|
+
*/
|
|
6036
|
+
'businessId': number;
|
|
6037
|
+
/**
|
|
6038
|
+
*
|
|
6039
|
+
* @type {EndOfDayReportResponseDtoV6SalesSummary}
|
|
6040
|
+
* @memberof EndOfDayReportResponseDtoV6
|
|
6041
|
+
*/
|
|
6042
|
+
'salesSummary': EndOfDayReportResponseDtoV6SalesSummary;
|
|
6043
|
+
/**
|
|
6044
|
+
* Omitted without Report::ViewPaymentMethods
|
|
6045
|
+
* @type {Array<PaymentDetailsDto>}
|
|
6046
|
+
* @memberof EndOfDayReportResponseDtoV6
|
|
6047
|
+
*/
|
|
6048
|
+
'paymentMethodDetails'?: Array<PaymentDetailsDto>;
|
|
6049
|
+
/**
|
|
6050
|
+
*
|
|
6051
|
+
* @type {EndOfDayReportResponseDtoV6TaxBreakdown}
|
|
6052
|
+
* @memberof EndOfDayReportResponseDtoV6
|
|
6053
|
+
*/
|
|
6054
|
+
'taxBreakdown'?: EndOfDayReportResponseDtoV6TaxBreakdown;
|
|
6055
|
+
/**
|
|
6056
|
+
* Omitted without Report::ViewItemSales
|
|
6057
|
+
* @type {Array<ItemBreakdownDto>}
|
|
6058
|
+
* @memberof EndOfDayReportResponseDtoV6
|
|
6059
|
+
*/
|
|
6060
|
+
'itemBreakdown'?: Array<ItemBreakdownDto>;
|
|
6061
|
+
}
|
|
6062
|
+
/**
|
|
6063
|
+
* Each total is omitted without its ReportTotals key; totalTransactions needs Report::ViewPaymentMethods
|
|
6064
|
+
* @export
|
|
6065
|
+
* @interface EndOfDayReportResponseDtoV6SalesSummary
|
|
6066
|
+
*/
|
|
6067
|
+
export interface EndOfDayReportResponseDtoV6SalesSummary {
|
|
6068
|
+
/**
|
|
6069
|
+
* Total number of orders
|
|
6070
|
+
* @type {number}
|
|
6071
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6072
|
+
*/
|
|
6073
|
+
'totalOrders'?: number;
|
|
6074
|
+
/**
|
|
6075
|
+
* Total sales amount
|
|
6076
|
+
* @type {number}
|
|
6077
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6078
|
+
*/
|
|
6079
|
+
'totalSales'?: number;
|
|
6080
|
+
/**
|
|
6081
|
+
* Net sales amount after adjustments
|
|
6082
|
+
* @type {number}
|
|
6083
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6084
|
+
*/
|
|
6085
|
+
'netSales'?: number;
|
|
6086
|
+
/**
|
|
6087
|
+
* Total amount actually paid
|
|
6088
|
+
* @type {number}
|
|
6089
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6090
|
+
*/
|
|
6091
|
+
'totalPaid'?: number;
|
|
6092
|
+
/**
|
|
6093
|
+
* Total difference
|
|
6094
|
+
* @type {number}
|
|
6095
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6096
|
+
*/
|
|
6097
|
+
'totalDifference'?: number;
|
|
6098
|
+
/**
|
|
6099
|
+
* Total transactions
|
|
6100
|
+
* @type {number}
|
|
6101
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6102
|
+
*/
|
|
6103
|
+
'totalTransactions'?: number;
|
|
6104
|
+
/**
|
|
6105
|
+
* Number of rejected orders
|
|
6106
|
+
* @type {number}
|
|
6107
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6108
|
+
*/
|
|
6109
|
+
'rejectedOrders'?: number;
|
|
6110
|
+
/**
|
|
6111
|
+
* Total rejected sales amount
|
|
6112
|
+
* @type {number}
|
|
6113
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6114
|
+
*/
|
|
6115
|
+
'rejectedSales'?: number;
|
|
6116
|
+
/**
|
|
6117
|
+
* Average sales per order
|
|
6118
|
+
* @type {number}
|
|
6119
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6120
|
+
*/
|
|
6121
|
+
'averageSales'?: number;
|
|
6122
|
+
/**
|
|
6123
|
+
* Total number of items sold
|
|
6124
|
+
* @type {number}
|
|
6125
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6126
|
+
*/
|
|
6127
|
+
'totalItemsCount'?: number;
|
|
6128
|
+
/**
|
|
6129
|
+
* Total refund amount
|
|
6130
|
+
* @type {number}
|
|
6131
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6132
|
+
*/
|
|
6133
|
+
'totalRefunds'?: number;
|
|
6134
|
+
/**
|
|
6135
|
+
* Total discount amount given
|
|
6136
|
+
* @type {number}
|
|
6137
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6138
|
+
*/
|
|
6139
|
+
'totalDiscounts'?: number;
|
|
6140
|
+
/**
|
|
6141
|
+
* Total voucher forfeited amount in cents
|
|
6142
|
+
* @type {number}
|
|
6143
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6144
|
+
*/
|
|
6145
|
+
'totalVoucherForfeited'?: number;
|
|
6146
|
+
/**
|
|
6147
|
+
* Total amount of all payment methods
|
|
6148
|
+
* @type {number}
|
|
6149
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6150
|
+
*/
|
|
6151
|
+
'totalPaymentAmount'?: number;
|
|
6152
|
+
/**
|
|
6153
|
+
* Total tip amount in cents
|
|
6154
|
+
* @type {number}
|
|
6155
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6156
|
+
*/
|
|
6157
|
+
'totalTipAmount'?: number;
|
|
6158
|
+
/**
|
|
6159
|
+
* Total surcharge amount in cents
|
|
6160
|
+
* @type {number}
|
|
6161
|
+
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
6162
|
+
*/
|
|
6163
|
+
'totalSurchargeAmount'?: number;
|
|
6164
|
+
}
|
|
6165
|
+
/**
|
|
6166
|
+
* Omitted without Report::ViewSalesSummary
|
|
6167
|
+
* @export
|
|
6168
|
+
* @interface EndOfDayReportResponseDtoV6TaxBreakdown
|
|
6169
|
+
*/
|
|
6170
|
+
export interface EndOfDayReportResponseDtoV6TaxBreakdown {
|
|
6171
|
+
/**
|
|
6172
|
+
* Tax breakdown by rate
|
|
6173
|
+
* @type {Array<TaxRateItem>}
|
|
6174
|
+
* @memberof EndOfDayReportResponseDtoV6TaxBreakdown
|
|
6175
|
+
*/
|
|
6176
|
+
'taxRates': Array<TaxRateItem>;
|
|
6177
|
+
/**
|
|
6178
|
+
* Total tax amount
|
|
6179
|
+
* @type {number}
|
|
6180
|
+
* @memberof EndOfDayReportResponseDtoV6TaxBreakdown
|
|
6181
|
+
*/
|
|
6182
|
+
'totalTaxAmount': number;
|
|
6183
|
+
}
|
|
5867
6184
|
/**
|
|
5868
6185
|
*
|
|
5869
6186
|
* @export
|
|
@@ -5879,6 +6196,7 @@ export const EntityType = {
|
|
|
5879
6196
|
Role: 'role',
|
|
5880
6197
|
Shift: 'shift',
|
|
5881
6198
|
Employee: 'employee',
|
|
6199
|
+
ActionPasscode: 'action_passcode',
|
|
5882
6200
|
Config: 'config',
|
|
5883
6201
|
Business: 'business',
|
|
5884
6202
|
Suboption: 'suboption',
|
|
@@ -7607,6 +7925,59 @@ export interface InvoiceCompanyResponseDto {
|
|
|
7607
7925
|
*/
|
|
7608
7926
|
'updatedAt': string;
|
|
7609
7927
|
}
|
|
7928
|
+
/**
|
|
7929
|
+
*
|
|
7930
|
+
* @export
|
|
7931
|
+
* @interface IssueActionApprovalDto
|
|
7932
|
+
*/
|
|
7933
|
+
export interface IssueActionApprovalDto {
|
|
7934
|
+
/**
|
|
7935
|
+
* The passcode PIN, 4 to 6 digits
|
|
7936
|
+
* @type {string}
|
|
7937
|
+
* @memberof IssueActionApprovalDto
|
|
7938
|
+
*/
|
|
7939
|
+
'pin': string;
|
|
7940
|
+
/**
|
|
7941
|
+
*
|
|
7942
|
+
* @type {PosPermission}
|
|
7943
|
+
* @memberof IssueActionApprovalDto
|
|
7944
|
+
*/
|
|
7945
|
+
'permissionKey': PosPermission;
|
|
7946
|
+
/**
|
|
7947
|
+
*
|
|
7948
|
+
* @type {ApprovalKind}
|
|
7949
|
+
* @memberof IssueActionApprovalDto
|
|
7950
|
+
*/
|
|
7951
|
+
'kind': ApprovalKind;
|
|
7952
|
+
}
|
|
7953
|
+
|
|
7954
|
+
|
|
7955
|
+
/**
|
|
7956
|
+
*
|
|
7957
|
+
* @export
|
|
7958
|
+
* @interface IssueEmployeeTokenDto
|
|
7959
|
+
*/
|
|
7960
|
+
export interface IssueEmployeeTokenDto {
|
|
7961
|
+
/**
|
|
7962
|
+
* The employee\'s PIN, 4 to 6 digits
|
|
7963
|
+
* @type {string}
|
|
7964
|
+
* @memberof IssueEmployeeTokenDto
|
|
7965
|
+
*/
|
|
7966
|
+
'pin': string;
|
|
7967
|
+
}
|
|
7968
|
+
/**
|
|
7969
|
+
*
|
|
7970
|
+
* @export
|
|
7971
|
+
* @interface IssueTabletTokenDto
|
|
7972
|
+
*/
|
|
7973
|
+
export interface IssueTabletTokenDto {
|
|
7974
|
+
/**
|
|
7975
|
+
* The venue the tablet signs in to
|
|
7976
|
+
* @type {number}
|
|
7977
|
+
* @memberof IssueTabletTokenDto
|
|
7978
|
+
*/
|
|
7979
|
+
'businessId': number;
|
|
7980
|
+
}
|
|
7610
7981
|
/**
|
|
7611
7982
|
*
|
|
7612
7983
|
* @export
|
|
@@ -7761,6 +8132,98 @@ export interface ItemPriceDto {
|
|
|
7761
8132
|
*/
|
|
7762
8133
|
'priceBreakdown': ItemPriceBreakdownDto;
|
|
7763
8134
|
}
|
|
8135
|
+
/**
|
|
8136
|
+
*
|
|
8137
|
+
* @export
|
|
8138
|
+
* @interface ItemPriceDtoV6
|
|
8139
|
+
*/
|
|
8140
|
+
export interface ItemPriceDtoV6 {
|
|
8141
|
+
/**
|
|
8142
|
+
*
|
|
8143
|
+
* @type {MoneyDto}
|
|
8144
|
+
* @memberof ItemPriceDtoV6
|
|
8145
|
+
*/
|
|
8146
|
+
'unitPrice': MoneyDto;
|
|
8147
|
+
/**
|
|
8148
|
+
*
|
|
8149
|
+
* @type {MoneyDto}
|
|
8150
|
+
* @memberof ItemPriceDtoV6
|
|
8151
|
+
*/
|
|
8152
|
+
'basePrice': MoneyDto;
|
|
8153
|
+
/**
|
|
8154
|
+
*
|
|
8155
|
+
* @type {number}
|
|
8156
|
+
* @memberof ItemPriceDtoV6
|
|
8157
|
+
*/
|
|
8158
|
+
'vatPercentage': number;
|
|
8159
|
+
/**
|
|
8160
|
+
*
|
|
8161
|
+
* @type {MoneyDto}
|
|
8162
|
+
* @memberof ItemPriceDtoV6
|
|
8163
|
+
*/
|
|
8164
|
+
'total': MoneyDto;
|
|
8165
|
+
/**
|
|
8166
|
+
*
|
|
8167
|
+
* @type {ItemPriceDtoV6PriceBreakdown}
|
|
8168
|
+
* @memberof ItemPriceDtoV6
|
|
8169
|
+
*/
|
|
8170
|
+
'priceBreakdown'?: ItemPriceDtoV6PriceBreakdown;
|
|
8171
|
+
}
|
|
8172
|
+
/**
|
|
8173
|
+
* Omitted without Transaction::ViewDiscounts
|
|
8174
|
+
* @export
|
|
8175
|
+
* @interface ItemPriceDtoV6PriceBreakdown
|
|
8176
|
+
*/
|
|
8177
|
+
export interface ItemPriceDtoV6PriceBreakdown {
|
|
8178
|
+
/**
|
|
8179
|
+
*
|
|
8180
|
+
* @type {MoneyDto}
|
|
8181
|
+
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
8182
|
+
*/
|
|
8183
|
+
'totalBeforeDiscounts': MoneyDto;
|
|
8184
|
+
/**
|
|
8185
|
+
*
|
|
8186
|
+
* @type {MoneyDto}
|
|
8187
|
+
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
8188
|
+
*/
|
|
8189
|
+
'subtotalItemDiscounts': MoneyDto;
|
|
8190
|
+
/**
|
|
8191
|
+
*
|
|
8192
|
+
* @type {MoneyDto}
|
|
8193
|
+
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
8194
|
+
*/
|
|
8195
|
+
'subtotalBasketDiscounts': MoneyDto;
|
|
8196
|
+
/**
|
|
8197
|
+
*
|
|
8198
|
+
* @type {MoneyDto}
|
|
8199
|
+
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
8200
|
+
*/
|
|
8201
|
+
'totalDiscounts': MoneyDto;
|
|
8202
|
+
/**
|
|
8203
|
+
*
|
|
8204
|
+
* @type {MoneyDto}
|
|
8205
|
+
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
8206
|
+
*/
|
|
8207
|
+
'basePriceBeforeDiscounts': MoneyDto;
|
|
8208
|
+
/**
|
|
8209
|
+
*
|
|
8210
|
+
* @type {MoneyDto}
|
|
8211
|
+
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
8212
|
+
*/
|
|
8213
|
+
'unitPriceBeforeDiscounts': MoneyDto;
|
|
8214
|
+
/**
|
|
8215
|
+
*
|
|
8216
|
+
* @type {MoneyDto}
|
|
8217
|
+
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
8218
|
+
*/
|
|
8219
|
+
'subtotalOptionsBasketDiscounts': MoneyDto;
|
|
8220
|
+
/**
|
|
8221
|
+
*
|
|
8222
|
+
* @type {MoneyDto}
|
|
8223
|
+
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
8224
|
+
*/
|
|
8225
|
+
'subtotalOptionsItemDiscounts': MoneyDto;
|
|
8226
|
+
}
|
|
7764
8227
|
/**
|
|
7765
8228
|
*
|
|
7766
8229
|
* @export
|
|
@@ -10355,6 +10818,62 @@ export interface LoyaltyUserInfoResponseDto {
|
|
|
10355
10818
|
*/
|
|
10356
10819
|
'_links': { [key: string]: LoyaltyInfoResponseDtoLinksValue; };
|
|
10357
10820
|
}
|
|
10821
|
+
/**
|
|
10822
|
+
*
|
|
10823
|
+
* @export
|
|
10824
|
+
* @interface LoyaltyWalletRewardDto
|
|
10825
|
+
*/
|
|
10826
|
+
export interface LoyaltyWalletRewardDto {
|
|
10827
|
+
/**
|
|
10828
|
+
*
|
|
10829
|
+
* @type {number}
|
|
10830
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10831
|
+
*/
|
|
10832
|
+
'wallet_id': number;
|
|
10833
|
+
/**
|
|
10834
|
+
*
|
|
10835
|
+
* @type {number}
|
|
10836
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10837
|
+
*/
|
|
10838
|
+
'catalog_id': number;
|
|
10839
|
+
/**
|
|
10840
|
+
*
|
|
10841
|
+
* @type {string}
|
|
10842
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10843
|
+
*/
|
|
10844
|
+
'name': string | null;
|
|
10845
|
+
/**
|
|
10846
|
+
* When the reward stops being usable. A claim made before claims expired has none.
|
|
10847
|
+
* @type {string}
|
|
10848
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10849
|
+
*/
|
|
10850
|
+
'expires_at': string | null;
|
|
10851
|
+
}
|
|
10852
|
+
/**
|
|
10853
|
+
*
|
|
10854
|
+
* @export
|
|
10855
|
+
* @interface LoyaltyWalletRewardsDto
|
|
10856
|
+
*/
|
|
10857
|
+
export interface LoyaltyWalletRewardsDto {
|
|
10858
|
+
/**
|
|
10859
|
+
*
|
|
10860
|
+
* @type {number}
|
|
10861
|
+
* @memberof LoyaltyWalletRewardsDto
|
|
10862
|
+
*/
|
|
10863
|
+
'user_id': number;
|
|
10864
|
+
/**
|
|
10865
|
+
* Rewards the member activated whose window is still open, soonest to expire first
|
|
10866
|
+
* @type {Array<LoyaltyWalletRewardDto>}
|
|
10867
|
+
* @memberof LoyaltyWalletRewardsDto
|
|
10868
|
+
*/
|
|
10869
|
+
'activated': Array<LoyaltyWalletRewardDto>;
|
|
10870
|
+
/**
|
|
10871
|
+
* Rewards the member claimed and has not activated, newest first
|
|
10872
|
+
* @type {Array<LoyaltyWalletRewardDto>}
|
|
10873
|
+
* @memberof LoyaltyWalletRewardsDto
|
|
10874
|
+
*/
|
|
10875
|
+
'claimed': Array<LoyaltyWalletRewardDto>;
|
|
10876
|
+
}
|
|
10358
10877
|
/**
|
|
10359
10878
|
*
|
|
10360
10879
|
* @export
|
|
@@ -16295,6 +16814,125 @@ export interface PermissionDto {
|
|
|
16295
16814
|
*/
|
|
16296
16815
|
'enabled': boolean;
|
|
16297
16816
|
}
|
|
16817
|
+
/**
|
|
16818
|
+
*
|
|
16819
|
+
* @export
|
|
16820
|
+
* @interface PermissionGroupDto
|
|
16821
|
+
*/
|
|
16822
|
+
export interface PermissionGroupDto {
|
|
16823
|
+
/**
|
|
16824
|
+
*
|
|
16825
|
+
* @type {object}
|
|
16826
|
+
* @memberof PermissionGroupDto
|
|
16827
|
+
*/
|
|
16828
|
+
'id': object;
|
|
16829
|
+
/**
|
|
16830
|
+
*
|
|
16831
|
+
* @type {string}
|
|
16832
|
+
* @memberof PermissionGroupDto
|
|
16833
|
+
*/
|
|
16834
|
+
'label': string;
|
|
16835
|
+
/**
|
|
16836
|
+
* The key that grants every permission in the group at once, if the group has one
|
|
16837
|
+
* @type {string}
|
|
16838
|
+
* @memberof PermissionGroupDto
|
|
16839
|
+
*/
|
|
16840
|
+
'familyKey': FamilyKeyEnum;
|
|
16841
|
+
/**
|
|
16842
|
+
*
|
|
16843
|
+
* @type {Array<CatalogPermissionDto>}
|
|
16844
|
+
* @memberof PermissionGroupDto
|
|
16845
|
+
*/
|
|
16846
|
+
'permissions': Array<CatalogPermissionDto>;
|
|
16847
|
+
}
|
|
16848
|
+
|
|
16849
|
+
export const FamilyKeyEnum = {
|
|
16850
|
+
AccessPosApp: 'Access::PosApp',
|
|
16851
|
+
PagePos: 'Page::Pos',
|
|
16852
|
+
PageOpenOrders: 'Page::OpenOrders',
|
|
16853
|
+
PageOrders: 'Page::Orders',
|
|
16854
|
+
PageTransactions: 'Page::Transactions',
|
|
16855
|
+
PageProducts: 'Page::Products',
|
|
16856
|
+
PageReports: 'Page::Reports',
|
|
16857
|
+
PageSettings: 'Page::Settings',
|
|
16858
|
+
PageFloorPlan: 'Page::FloorPlan',
|
|
16859
|
+
Cart: 'Cart::*',
|
|
16860
|
+
CartAddItem: 'Cart::AddItem',
|
|
16861
|
+
CartRemoveItem: 'Cart::RemoveItem',
|
|
16862
|
+
CartApplyDiscount: 'Cart::ApplyDiscount',
|
|
16863
|
+
CartVoidItem: 'Cart::VoidItem',
|
|
16864
|
+
CartClear: 'Cart::Clear',
|
|
16865
|
+
CartRemoveDiscount: 'Cart::RemoveDiscount',
|
|
16866
|
+
CartVoidPayment: 'Cart::VoidPayment',
|
|
16867
|
+
Cash: 'Cash::*',
|
|
16868
|
+
CashOpenDay: 'Cash::OpenDay',
|
|
16869
|
+
CashCloseDay: 'Cash::CloseDay',
|
|
16870
|
+
CashCashIn: 'Cash::CashIn',
|
|
16871
|
+
CashCashOut: 'Cash::CashOut',
|
|
16872
|
+
CashOpenDrawer: 'Cash::OpenDrawer',
|
|
16873
|
+
CashPrintReport: 'Cash::PrintReport',
|
|
16874
|
+
CashSendReport: 'Cash::SendReport',
|
|
16875
|
+
Transaction: 'Transaction::*',
|
|
16876
|
+
TransactionRefund: 'Transaction::Refund',
|
|
16877
|
+
TransactionViewAll: 'Transaction::ViewAll',
|
|
16878
|
+
TransactionViewTips: 'Transaction::ViewTips',
|
|
16879
|
+
TransactionViewSurcharges: 'Transaction::ViewSurcharges',
|
|
16880
|
+
TransactionViewDiscounts: 'Transaction::ViewDiscounts',
|
|
16881
|
+
TransactionTotals: 'TransactionTotals::*',
|
|
16882
|
+
TransactionTotalsOrders: 'TransactionTotals::Orders',
|
|
16883
|
+
TransactionTotalsSales: 'TransactionTotals::Sales',
|
|
16884
|
+
TransactionTotalsRejectedOrders: 'TransactionTotals::RejectedOrders',
|
|
16885
|
+
TransactionTotalsRejectedSales: 'TransactionTotals::RejectedSales',
|
|
16886
|
+
Order: 'Order::*',
|
|
16887
|
+
OrderSendReceipt: 'Order::SendReceipt',
|
|
16888
|
+
OpenOrdersDelete: 'OpenOrders::Delete',
|
|
16889
|
+
OpenOrdersSendToKitchen: 'OpenOrders::SendToKitchen',
|
|
16890
|
+
OpenOrdersFireCourse: 'OpenOrders::FireCourse',
|
|
16891
|
+
Shift: 'Shift::*',
|
|
16892
|
+
ShiftForceClockOut: 'Shift::ForceClockOut',
|
|
16893
|
+
FloorPlan: 'FloorPlan::*',
|
|
16894
|
+
FloorPlanEditLayout: 'FloorPlan::EditLayout',
|
|
16895
|
+
FloorPlanChangeTableStatus: 'FloorPlan::ChangeTableStatus',
|
|
16896
|
+
FloorPlanManageSections: 'FloorPlan::ManageSections',
|
|
16897
|
+
Settings: 'Settings::*',
|
|
16898
|
+
SettingsEditProfile: 'Settings::EditProfile',
|
|
16899
|
+
Report: 'Report::*',
|
|
16900
|
+
ReportSendEmail: 'Report::SendEmail',
|
|
16901
|
+
ReportViewAll: 'Report::ViewAll',
|
|
16902
|
+
ReportViewSalesSummary: 'Report::ViewSalesSummary',
|
|
16903
|
+
ReportViewPaymentMethods: 'Report::ViewPaymentMethods',
|
|
16904
|
+
ReportViewItemSales: 'Report::ViewItemSales',
|
|
16905
|
+
ReportViewCashLogs: 'Report::ViewCashLogs',
|
|
16906
|
+
ReportTotals: 'ReportTotals::*',
|
|
16907
|
+
ReportTotalsOrders: 'ReportTotals::Orders',
|
|
16908
|
+
ReportTotalsSales: 'ReportTotals::Sales',
|
|
16909
|
+
ReportTotalsTips: 'ReportTotals::Tips',
|
|
16910
|
+
ReportTotalsSurcharges: 'ReportTotals::Surcharges',
|
|
16911
|
+
ReportTotalsRejectedOrders: 'ReportTotals::RejectedOrders',
|
|
16912
|
+
ReportTotalsRejectedSales: 'ReportTotals::RejectedSales',
|
|
16913
|
+
ReportTotalsAverageSale: 'ReportTotals::AverageSale',
|
|
16914
|
+
ReportTotalsItems: 'ReportTotals::Items',
|
|
16915
|
+
ReportTotalsRefunds: 'ReportTotals::Refunds',
|
|
16916
|
+
ReportTotalsDiscounts: 'ReportTotals::Discounts'
|
|
16917
|
+
} as const;
|
|
16918
|
+
|
|
16919
|
+
export type FamilyKeyEnum = typeof FamilyKeyEnum[keyof typeof FamilyKeyEnum];
|
|
16920
|
+
|
|
16921
|
+
/**
|
|
16922
|
+
*
|
|
16923
|
+
* @export
|
|
16924
|
+
* @enum {string}
|
|
16925
|
+
*/
|
|
16926
|
+
|
|
16927
|
+
export const PermissionKind = {
|
|
16928
|
+
Screen: 'screen',
|
|
16929
|
+
Action: 'action',
|
|
16930
|
+
Visibility: 'visibility'
|
|
16931
|
+
} as const;
|
|
16932
|
+
|
|
16933
|
+
export type PermissionKind = typeof PermissionKind[keyof typeof PermissionKind];
|
|
16934
|
+
|
|
16935
|
+
|
|
16298
16936
|
/**
|
|
16299
16937
|
*
|
|
16300
16938
|
* @export
|
|
@@ -16314,6 +16952,33 @@ export interface PermissionRuleDto {
|
|
|
16314
16952
|
*/
|
|
16315
16953
|
'enabled': boolean;
|
|
16316
16954
|
}
|
|
16955
|
+
/**
|
|
16956
|
+
*
|
|
16957
|
+
* @export
|
|
16958
|
+
* @interface PermissionRuleDtoV6
|
|
16959
|
+
*/
|
|
16960
|
+
export interface PermissionRuleDtoV6 {
|
|
16961
|
+
/**
|
|
16962
|
+
*
|
|
16963
|
+
* @type {string}
|
|
16964
|
+
* @memberof PermissionRuleDtoV6
|
|
16965
|
+
*/
|
|
16966
|
+
'id': string;
|
|
16967
|
+
/**
|
|
16968
|
+
*
|
|
16969
|
+
* @type {PosPermission}
|
|
16970
|
+
* @memberof PermissionRuleDtoV6
|
|
16971
|
+
*/
|
|
16972
|
+
'key': PosPermission;
|
|
16973
|
+
/**
|
|
16974
|
+
*
|
|
16975
|
+
* @type {boolean}
|
|
16976
|
+
* @memberof PermissionRuleDtoV6
|
|
16977
|
+
*/
|
|
16978
|
+
'enabled': boolean;
|
|
16979
|
+
}
|
|
16980
|
+
|
|
16981
|
+
|
|
16317
16982
|
/**
|
|
16318
16983
|
*
|
|
16319
16984
|
* @export
|
|
@@ -16469,6 +17134,31 @@ export interface PosActionPasscodeDto {
|
|
|
16469
17134
|
*/
|
|
16470
17135
|
'pinHash': string;
|
|
16471
17136
|
}
|
|
17137
|
+
/**
|
|
17138
|
+
*
|
|
17139
|
+
* @export
|
|
17140
|
+
* @interface PosActionPasscodeDtoV6
|
|
17141
|
+
*/
|
|
17142
|
+
export interface PosActionPasscodeDtoV6 {
|
|
17143
|
+
/**
|
|
17144
|
+
*
|
|
17145
|
+
* @type {string}
|
|
17146
|
+
* @memberof PosActionPasscodeDtoV6
|
|
17147
|
+
*/
|
|
17148
|
+
'id': string;
|
|
17149
|
+
/**
|
|
17150
|
+
*
|
|
17151
|
+
* @type {string}
|
|
17152
|
+
* @memberof PosActionPasscodeDtoV6
|
|
17153
|
+
*/
|
|
17154
|
+
'name': string;
|
|
17155
|
+
/**
|
|
17156
|
+
*
|
|
17157
|
+
* @type {Array<PermissionRuleDtoV6>}
|
|
17158
|
+
* @memberof PosActionPasscodeDtoV6
|
|
17159
|
+
*/
|
|
17160
|
+
'permissionRules': Array<PermissionRuleDtoV6>;
|
|
17161
|
+
}
|
|
16472
17162
|
/**
|
|
16473
17163
|
*
|
|
16474
17164
|
* @export
|
|
@@ -16766,6 +17456,39 @@ export interface PosEmployeeDto {
|
|
|
16766
17456
|
}
|
|
16767
17457
|
|
|
16768
17458
|
|
|
17459
|
+
/**
|
|
17460
|
+
*
|
|
17461
|
+
* @export
|
|
17462
|
+
* @interface PosEmployeeDtoV6
|
|
17463
|
+
*/
|
|
17464
|
+
export interface PosEmployeeDtoV6 {
|
|
17465
|
+
/**
|
|
17466
|
+
*
|
|
17467
|
+
* @type {string}
|
|
17468
|
+
* @memberof PosEmployeeDtoV6
|
|
17469
|
+
*/
|
|
17470
|
+
'id': string;
|
|
17471
|
+
/**
|
|
17472
|
+
*
|
|
17473
|
+
* @type {string}
|
|
17474
|
+
* @memberof PosEmployeeDtoV6
|
|
17475
|
+
*/
|
|
17476
|
+
'name': string;
|
|
17477
|
+
/**
|
|
17478
|
+
*
|
|
17479
|
+
* @type {string}
|
|
17480
|
+
* @memberof PosEmployeeDtoV6
|
|
17481
|
+
*/
|
|
17482
|
+
'roleId': string;
|
|
17483
|
+
/**
|
|
17484
|
+
*
|
|
17485
|
+
* @type {Status}
|
|
17486
|
+
* @memberof PosEmployeeDtoV6
|
|
17487
|
+
*/
|
|
17488
|
+
'status': Status;
|
|
17489
|
+
}
|
|
17490
|
+
|
|
17491
|
+
|
|
16769
17492
|
/**
|
|
16770
17493
|
*
|
|
16771
17494
|
* @export
|
|
@@ -18077,6 +18800,261 @@ export interface PosOrderDtoTaxSummary {
|
|
|
18077
18800
|
*/
|
|
18078
18801
|
'grandTotal': number;
|
|
18079
18802
|
}
|
|
18803
|
+
/**
|
|
18804
|
+
*
|
|
18805
|
+
* @export
|
|
18806
|
+
* @interface PosOrderDtoV6
|
|
18807
|
+
*/
|
|
18808
|
+
export interface PosOrderDtoV6 {
|
|
18809
|
+
/**
|
|
18810
|
+
* Set on tickets whose lines all resolve to sendToOm=false. The ticket stays in_progress so the kitchen screen still receives it; only Order Manager skips it. Absent on documents written before this field existed, which is treated as not hidden.
|
|
18811
|
+
* @type {boolean}
|
|
18812
|
+
* @memberof PosOrderDtoV6
|
|
18813
|
+
*/
|
|
18814
|
+
'hiddenFromOrderManager'?: boolean;
|
|
18815
|
+
/**
|
|
18816
|
+
* True when this fire produced a kitchen ticket, so the kitchen screen owns marking it ready. False when no kitchen ticket exists and a manager must mark it ready. Absent on documents written before this field existed, where clients fall back to the business-level KDS integration check.
|
|
18817
|
+
* @type {boolean}
|
|
18818
|
+
* @memberof PosOrderDtoV6
|
|
18819
|
+
*/
|
|
18820
|
+
'readyControlledByKds'?: boolean;
|
|
18821
|
+
/**
|
|
18822
|
+
*
|
|
18823
|
+
* @type {string}
|
|
18824
|
+
* @memberof PosOrderDtoV6
|
|
18825
|
+
*/
|
|
18826
|
+
'id': string;
|
|
18827
|
+
/**
|
|
18828
|
+
*
|
|
18829
|
+
* @type {string}
|
|
18830
|
+
* @memberof PosOrderDtoV6
|
|
18831
|
+
*/
|
|
18832
|
+
'businessId': string;
|
|
18833
|
+
/**
|
|
18834
|
+
*
|
|
18835
|
+
* @type {ProviderEnum}
|
|
18836
|
+
* @memberof PosOrderDtoV6
|
|
18837
|
+
*/
|
|
18838
|
+
'provider': ProviderEnum;
|
|
18839
|
+
/**
|
|
18840
|
+
*
|
|
18841
|
+
* @type {CurrencyCode}
|
|
18842
|
+
* @memberof PosOrderDtoV6
|
|
18843
|
+
*/
|
|
18844
|
+
'currency': CurrencyCode;
|
|
18845
|
+
/**
|
|
18846
|
+
*
|
|
18847
|
+
* @type {PosBusinessDto}
|
|
18848
|
+
* @memberof PosOrderDtoV6
|
|
18849
|
+
*/
|
|
18850
|
+
'business': PosBusinessDto;
|
|
18851
|
+
/**
|
|
18852
|
+
*
|
|
18853
|
+
* @type {string}
|
|
18854
|
+
* @memberof PosOrderDtoV6
|
|
18855
|
+
*/
|
|
18856
|
+
'createdAt': string;
|
|
18857
|
+
/**
|
|
18858
|
+
*
|
|
18859
|
+
* @type {OrderStatusEnum}
|
|
18860
|
+
* @memberof PosOrderDtoV6
|
|
18861
|
+
*/
|
|
18862
|
+
'status': OrderStatusEnum;
|
|
18863
|
+
/**
|
|
18864
|
+
*
|
|
18865
|
+
* @type {string}
|
|
18866
|
+
* @memberof PosOrderDtoV6
|
|
18867
|
+
*/
|
|
18868
|
+
'updatedAt': string;
|
|
18869
|
+
/**
|
|
18870
|
+
*
|
|
18871
|
+
* @type {string}
|
|
18872
|
+
* @memberof PosOrderDtoV6
|
|
18873
|
+
*/
|
|
18874
|
+
'completedAt'?: string;
|
|
18875
|
+
/**
|
|
18876
|
+
*
|
|
18877
|
+
* @type {string}
|
|
18878
|
+
* @memberof PosOrderDtoV6
|
|
18879
|
+
*/
|
|
18880
|
+
'orderNumber': string;
|
|
18881
|
+
/**
|
|
18882
|
+
*
|
|
18883
|
+
* @type {CheckoutModelEnum}
|
|
18884
|
+
* @memberof PosOrderDtoV6
|
|
18885
|
+
*/
|
|
18886
|
+
'checkoutModel': CheckoutModelEnum;
|
|
18887
|
+
/**
|
|
18888
|
+
*
|
|
18889
|
+
* @type {OrderTypePOS}
|
|
18890
|
+
* @memberof PosOrderDtoV6
|
|
18891
|
+
*/
|
|
18892
|
+
'orderType': OrderTypePOS;
|
|
18893
|
+
/**
|
|
18894
|
+
*
|
|
18895
|
+
* @type {string}
|
|
18896
|
+
* @memberof PosOrderDtoV6
|
|
18897
|
+
*/
|
|
18898
|
+
'spotNumber': string | null;
|
|
18899
|
+
/**
|
|
18900
|
+
* ID of the floor plan dining table linked to this order
|
|
18901
|
+
* @type {string}
|
|
18902
|
+
* @memberof PosOrderDtoV6
|
|
18903
|
+
*/
|
|
18904
|
+
'tableId'?: string | null;
|
|
18905
|
+
/**
|
|
18906
|
+
*
|
|
18907
|
+
* @type {string}
|
|
18908
|
+
* @memberof PosOrderDtoV6
|
|
18909
|
+
*/
|
|
18910
|
+
'comments': string | null;
|
|
18911
|
+
/**
|
|
18912
|
+
*
|
|
18913
|
+
* @type {PosOrderDtoTableService}
|
|
18914
|
+
* @memberof PosOrderDtoV6
|
|
18915
|
+
*/
|
|
18916
|
+
'tableService'?: PosOrderDtoTableService | null;
|
|
18917
|
+
/**
|
|
18918
|
+
*
|
|
18919
|
+
* @type {PosOrderDtoEqualSplitState}
|
|
18920
|
+
* @memberof PosOrderDtoV6
|
|
18921
|
+
*/
|
|
18922
|
+
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
18923
|
+
/**
|
|
18924
|
+
* Id of the staff in shift
|
|
18925
|
+
* @type {string}
|
|
18926
|
+
* @memberof PosOrderDtoV6
|
|
18927
|
+
*/
|
|
18928
|
+
'staffId': string | null;
|
|
18929
|
+
/**
|
|
18930
|
+
* Id of the shift
|
|
18931
|
+
* @type {string}
|
|
18932
|
+
* @memberof PosOrderDtoV6
|
|
18933
|
+
*/
|
|
18934
|
+
'shiftId': string | null;
|
|
18935
|
+
/**
|
|
18936
|
+
*
|
|
18937
|
+
* @type {OrderRefundStatus}
|
|
18938
|
+
* @memberof PosOrderDtoV6
|
|
18939
|
+
*/
|
|
18940
|
+
'orderRefundStatus': OrderRefundStatus;
|
|
18941
|
+
/**
|
|
18942
|
+
*
|
|
18943
|
+
* @type {LocatorType}
|
|
18944
|
+
* @memberof PosOrderDtoV6
|
|
18945
|
+
*/
|
|
18946
|
+
'locatorType': LocatorType;
|
|
18947
|
+
/**
|
|
18948
|
+
*
|
|
18949
|
+
* @type {PosCustomerDto}
|
|
18950
|
+
* @memberof PosOrderDtoV6
|
|
18951
|
+
*/
|
|
18952
|
+
'customer': PosCustomerDto | null;
|
|
18953
|
+
/**
|
|
18954
|
+
*
|
|
18955
|
+
* @type {Array<TransactionDto>}
|
|
18956
|
+
* @memberof PosOrderDtoV6
|
|
18957
|
+
*/
|
|
18958
|
+
'paymentEvents': Array<TransactionDto>;
|
|
18959
|
+
/**
|
|
18960
|
+
*
|
|
18961
|
+
* @type {Array<PaymentRefundDto>}
|
|
18962
|
+
* @memberof PosOrderDtoV6
|
|
18963
|
+
*/
|
|
18964
|
+
'refunds'?: Array<PaymentRefundDto>;
|
|
18965
|
+
/**
|
|
18966
|
+
* Data version code
|
|
18967
|
+
* @type {string}
|
|
18968
|
+
* @memberof PosOrderDtoV6
|
|
18969
|
+
*/
|
|
18970
|
+
'version': string;
|
|
18971
|
+
/**
|
|
18972
|
+
*
|
|
18973
|
+
* @type {OrderFormat}
|
|
18974
|
+
* @memberof PosOrderDtoV6
|
|
18975
|
+
*/
|
|
18976
|
+
'orderFormat'?: OrderFormat;
|
|
18977
|
+
/**
|
|
18978
|
+
* The ID of the loyalty program active during this order.
|
|
18979
|
+
* @type {string}
|
|
18980
|
+
* @memberof PosOrderDtoV6
|
|
18981
|
+
*/
|
|
18982
|
+
'loyaltyProgramId': string | null;
|
|
18983
|
+
/**
|
|
18984
|
+
* An array of loyalty transaction IDs related to this order.
|
|
18985
|
+
* @type {Array<string>}
|
|
18986
|
+
* @memberof PosOrderDtoV6
|
|
18987
|
+
*/
|
|
18988
|
+
'loyaltyTransactionIds': Array<string>;
|
|
18989
|
+
/**
|
|
18990
|
+
*
|
|
18991
|
+
* @type {PosOrderDtoTaxSummary}
|
|
18992
|
+
* @memberof PosOrderDtoV6
|
|
18993
|
+
*/
|
|
18994
|
+
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
18995
|
+
/**
|
|
18996
|
+
* Name of staff member who created the order
|
|
18997
|
+
* @type {string}
|
|
18998
|
+
* @memberof PosOrderDtoV6
|
|
18999
|
+
*/
|
|
19000
|
+
'staffName'?: string | null;
|
|
19001
|
+
/**
|
|
19002
|
+
*
|
|
19003
|
+
* @type {PosOrderDtoInvoiceCompany}
|
|
19004
|
+
* @memberof PosOrderDtoV6
|
|
19005
|
+
*/
|
|
19006
|
+
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
19007
|
+
/**
|
|
19008
|
+
*
|
|
19009
|
+
* @type {object}
|
|
19010
|
+
* @memberof PosOrderDtoV6
|
|
19011
|
+
*/
|
|
19012
|
+
'lastPaymentError'?: object;
|
|
19013
|
+
/**
|
|
19014
|
+
*
|
|
19015
|
+
* @type {Array<OrderFeeDto>}
|
|
19016
|
+
* @memberof PosOrderDtoV6
|
|
19017
|
+
*/
|
|
19018
|
+
'fees'?: Array<OrderFeeDto> | null;
|
|
19019
|
+
/**
|
|
19020
|
+
* Loyalty user ID associated with this order
|
|
19021
|
+
* @type {number}
|
|
19022
|
+
* @memberof PosOrderDtoV6
|
|
19023
|
+
*/
|
|
19024
|
+
'targetUserId'?: number;
|
|
19025
|
+
/**
|
|
19026
|
+
* ID of the table group this order belongs to
|
|
19027
|
+
* @type {string}
|
|
19028
|
+
* @memberof PosOrderDtoV6
|
|
19029
|
+
*/
|
|
19030
|
+
'tableGroupId'?: string | null;
|
|
19031
|
+
/**
|
|
19032
|
+
*
|
|
19033
|
+
* @type {PosOrderDtoLoyalty}
|
|
19034
|
+
* @memberof PosOrderDtoV6
|
|
19035
|
+
*/
|
|
19036
|
+
'loyalty'?: PosOrderDtoLoyalty | null;
|
|
19037
|
+
/**
|
|
19038
|
+
* Omitted without Transaction::ViewDiscounts
|
|
19039
|
+
* @type {Array<PosDiscountDto>}
|
|
19040
|
+
* @memberof PosOrderDtoV6
|
|
19041
|
+
*/
|
|
19042
|
+
'discounts'?: Array<PosDiscountDto>;
|
|
19043
|
+
/**
|
|
19044
|
+
*
|
|
19045
|
+
* @type {PosOrderPriceDtoV6}
|
|
19046
|
+
* @memberof PosOrderDtoV6
|
|
19047
|
+
*/
|
|
19048
|
+
'basketPrice': PosOrderPriceDtoV6;
|
|
19049
|
+
/**
|
|
19050
|
+
*
|
|
19051
|
+
* @type {Array<PosOrderItemDtoV6>}
|
|
19052
|
+
* @memberof PosOrderDtoV6
|
|
19053
|
+
*/
|
|
19054
|
+
'items': Array<PosOrderItemDtoV6>;
|
|
19055
|
+
}
|
|
19056
|
+
|
|
19057
|
+
|
|
18080
19058
|
/**
|
|
18081
19059
|
*
|
|
18082
19060
|
* @export
|
|
@@ -18164,6 +19142,68 @@ export interface PosOrderEqualSplitStateDto {
|
|
|
18164
19142
|
*/
|
|
18165
19143
|
'parts': Array<PosOrderEqualSplitPartDto>;
|
|
18166
19144
|
}
|
|
19145
|
+
/**
|
|
19146
|
+
*
|
|
19147
|
+
* @export
|
|
19148
|
+
* @interface PosOrderHistoryResponseDtoV6
|
|
19149
|
+
*/
|
|
19150
|
+
export interface PosOrderHistoryResponseDtoV6 {
|
|
19151
|
+
/**
|
|
19152
|
+
* Without Transaction::ViewTips or Transaction::ViewSurcharges, fees of that type are left out of fees and paymentEvents
|
|
19153
|
+
* @type {Array<PosOrderDtoV6>}
|
|
19154
|
+
* @memberof PosOrderHistoryResponseDtoV6
|
|
19155
|
+
*/
|
|
19156
|
+
'orders': Array<PosOrderDtoV6>;
|
|
19157
|
+
/**
|
|
19158
|
+
*
|
|
19159
|
+
* @type {PosOrderHistoryResponseDtoV6Summary}
|
|
19160
|
+
* @memberof PosOrderHistoryResponseDtoV6
|
|
19161
|
+
*/
|
|
19162
|
+
'summary': PosOrderHistoryResponseDtoV6Summary;
|
|
19163
|
+
/**
|
|
19164
|
+
*
|
|
19165
|
+
* @type {PaginationDto}
|
|
19166
|
+
* @memberof PosOrderHistoryResponseDtoV6
|
|
19167
|
+
*/
|
|
19168
|
+
'pagination': PaginationDto;
|
|
19169
|
+
}
|
|
19170
|
+
/**
|
|
19171
|
+
* Each total is omitted without its TransactionTotals key; tips need Transaction::ViewTips
|
|
19172
|
+
* @export
|
|
19173
|
+
* @interface PosOrderHistoryResponseDtoV6Summary
|
|
19174
|
+
*/
|
|
19175
|
+
export interface PosOrderHistoryResponseDtoV6Summary {
|
|
19176
|
+
/**
|
|
19177
|
+
* Total orders
|
|
19178
|
+
* @type {number}
|
|
19179
|
+
* @memberof PosOrderHistoryResponseDtoV6Summary
|
|
19180
|
+
*/
|
|
19181
|
+
'totalOrders'?: number;
|
|
19182
|
+
/**
|
|
19183
|
+
* Rejected orders
|
|
19184
|
+
* @type {number}
|
|
19185
|
+
* @memberof PosOrderHistoryResponseDtoV6Summary
|
|
19186
|
+
*/
|
|
19187
|
+
'rejectedOrders'?: number;
|
|
19188
|
+
/**
|
|
19189
|
+
* Total sales
|
|
19190
|
+
* @type {number}
|
|
19191
|
+
* @memberof PosOrderHistoryResponseDtoV6Summary
|
|
19192
|
+
*/
|
|
19193
|
+
'totalSales'?: number;
|
|
19194
|
+
/**
|
|
19195
|
+
* Rejected sales
|
|
19196
|
+
* @type {number}
|
|
19197
|
+
* @memberof PosOrderHistoryResponseDtoV6Summary
|
|
19198
|
+
*/
|
|
19199
|
+
'rejectedSales'?: number;
|
|
19200
|
+
/**
|
|
19201
|
+
* Total tip amount in cents
|
|
19202
|
+
* @type {number}
|
|
19203
|
+
* @memberof PosOrderHistoryResponseDtoV6Summary
|
|
19204
|
+
*/
|
|
19205
|
+
'totalTipAmount'?: number;
|
|
19206
|
+
}
|
|
18167
19207
|
/**
|
|
18168
19208
|
*
|
|
18169
19209
|
* @export
|
|
@@ -18360,6 +19400,159 @@ export interface PosOrderItemDtoReportingCategory {
|
|
|
18360
19400
|
*/
|
|
18361
19401
|
'updated_at': string;
|
|
18362
19402
|
}
|
|
19403
|
+
/**
|
|
19404
|
+
*
|
|
19405
|
+
* @export
|
|
19406
|
+
* @interface PosOrderItemDtoV6
|
|
19407
|
+
*/
|
|
19408
|
+
export interface PosOrderItemDtoV6 {
|
|
19409
|
+
/**
|
|
19410
|
+
*
|
|
19411
|
+
* @type {string}
|
|
19412
|
+
* @memberof PosOrderItemDtoV6
|
|
19413
|
+
*/
|
|
19414
|
+
'id': string;
|
|
19415
|
+
/**
|
|
19416
|
+
*
|
|
19417
|
+
* @type {string}
|
|
19418
|
+
* @memberof PosOrderItemDtoV6
|
|
19419
|
+
*/
|
|
19420
|
+
'lineItemId': string;
|
|
19421
|
+
/**
|
|
19422
|
+
*
|
|
19423
|
+
* @type {string}
|
|
19424
|
+
* @memberof PosOrderItemDtoV6
|
|
19425
|
+
*/
|
|
19426
|
+
'posId': string;
|
|
19427
|
+
/**
|
|
19428
|
+
*
|
|
19429
|
+
* @type {string}
|
|
19430
|
+
* @memberof PosOrderItemDtoV6
|
|
19431
|
+
*/
|
|
19432
|
+
'name': string;
|
|
19433
|
+
/**
|
|
19434
|
+
*
|
|
19435
|
+
* @type {MoneyDto}
|
|
19436
|
+
* @memberof PosOrderItemDtoV6
|
|
19437
|
+
*/
|
|
19438
|
+
'basePrice': MoneyDto;
|
|
19439
|
+
/**
|
|
19440
|
+
*
|
|
19441
|
+
* @type {number}
|
|
19442
|
+
* @memberof PosOrderItemDtoV6
|
|
19443
|
+
*/
|
|
19444
|
+
'taxRate': number;
|
|
19445
|
+
/**
|
|
19446
|
+
*
|
|
19447
|
+
* @type {number}
|
|
19448
|
+
* @memberof PosOrderItemDtoV6
|
|
19449
|
+
*/
|
|
19450
|
+
'quantity': number;
|
|
19451
|
+
/**
|
|
19452
|
+
*
|
|
19453
|
+
* @type {KitchenStatus}
|
|
19454
|
+
* @memberof PosOrderItemDtoV6
|
|
19455
|
+
*/
|
|
19456
|
+
'kitchenStatus': KitchenStatus;
|
|
19457
|
+
/**
|
|
19458
|
+
*
|
|
19459
|
+
* @type {PosPaymentStatus}
|
|
19460
|
+
* @memberof PosOrderItemDtoV6
|
|
19461
|
+
*/
|
|
19462
|
+
'paymentStatus': PosPaymentStatus;
|
|
19463
|
+
/**
|
|
19464
|
+
*
|
|
19465
|
+
* @type {PosDiscountDto}
|
|
19466
|
+
* @memberof PosOrderItemDtoV6
|
|
19467
|
+
*/
|
|
19468
|
+
'discount': PosDiscountDto | null;
|
|
19469
|
+
/**
|
|
19470
|
+
* Every item-scope discount application on this line, in cascade order — including when there is only one.
|
|
19471
|
+
* @type {Array<PosDiscountDto>}
|
|
19472
|
+
* @memberof PosOrderItemDtoV6
|
|
19473
|
+
*/
|
|
19474
|
+
'discountApplications'?: Array<PosDiscountDto>;
|
|
19475
|
+
/**
|
|
19476
|
+
*
|
|
19477
|
+
* @type {boolean}
|
|
19478
|
+
* @memberof PosOrderItemDtoV6
|
|
19479
|
+
*/
|
|
19480
|
+
'isBundleOffer': boolean;
|
|
19481
|
+
/**
|
|
19482
|
+
*
|
|
19483
|
+
* @type {boolean}
|
|
19484
|
+
* @memberof PosOrderItemDtoV6
|
|
19485
|
+
*/
|
|
19486
|
+
'isAlcohol': boolean;
|
|
19487
|
+
/**
|
|
19488
|
+
*
|
|
19489
|
+
* @type {string}
|
|
19490
|
+
* @memberof PosOrderItemDtoV6
|
|
19491
|
+
*/
|
|
19492
|
+
'comments': string | null;
|
|
19493
|
+
/**
|
|
19494
|
+
*
|
|
19495
|
+
* @type {string}
|
|
19496
|
+
* @memberof PosOrderItemDtoV6
|
|
19497
|
+
*/
|
|
19498
|
+
'logo': string | null;
|
|
19499
|
+
/**
|
|
19500
|
+
*
|
|
19501
|
+
* @type {PrinterTypeEnum}
|
|
19502
|
+
* @memberof PosOrderItemDtoV6
|
|
19503
|
+
*/
|
|
19504
|
+
'printerType'?: PrinterTypeEnum;
|
|
19505
|
+
/**
|
|
19506
|
+
* Resolved target printer addresses; empty/absent means print on all kitchen printers
|
|
19507
|
+
* @type {Array<string>}
|
|
19508
|
+
* @memberof PosOrderItemDtoV6
|
|
19509
|
+
*/
|
|
19510
|
+
'printerIds'?: Array<string> | null;
|
|
19511
|
+
/**
|
|
19512
|
+
*
|
|
19513
|
+
* @type {Array<PosOrderOptionDto>}
|
|
19514
|
+
* @memberof PosOrderItemDtoV6
|
|
19515
|
+
*/
|
|
19516
|
+
'options': Array<PosOrderOptionDto>;
|
|
19517
|
+
/**
|
|
19518
|
+
* Whether the product has a display label
|
|
19519
|
+
* @type {boolean}
|
|
19520
|
+
* @memberof PosOrderItemDtoV6
|
|
19521
|
+
*/
|
|
19522
|
+
'display_photo'?: boolean;
|
|
19523
|
+
/**
|
|
19524
|
+
*
|
|
19525
|
+
* @type {PosOrderItemDtoReportingCategory}
|
|
19526
|
+
* @memberof PosOrderItemDtoV6
|
|
19527
|
+
*/
|
|
19528
|
+
'reporting_category'?: PosOrderItemDtoReportingCategory | null;
|
|
19529
|
+
/**
|
|
19530
|
+
* Category ID of the item
|
|
19531
|
+
* @type {number}
|
|
19532
|
+
* @memberof PosOrderItemDtoV6
|
|
19533
|
+
*/
|
|
19534
|
+
'category_id': number | null;
|
|
19535
|
+
/**
|
|
19536
|
+
* Course ID override for this line item
|
|
19537
|
+
* @type {string}
|
|
19538
|
+
* @memberof PosOrderItemDtoV6
|
|
19539
|
+
*/
|
|
19540
|
+
'courseId'?: string | null;
|
|
19541
|
+
/**
|
|
19542
|
+
* Course name override for this line item
|
|
19543
|
+
* @type {string}
|
|
19544
|
+
* @memberof PosOrderItemDtoV6
|
|
19545
|
+
*/
|
|
19546
|
+
'courseName'?: string | null;
|
|
19547
|
+
/**
|
|
19548
|
+
*
|
|
19549
|
+
* @type {ItemPriceDtoV6}
|
|
19550
|
+
* @memberof PosOrderItemDtoV6
|
|
19551
|
+
*/
|
|
19552
|
+
'itemPrice': ItemPriceDtoV6;
|
|
19553
|
+
}
|
|
19554
|
+
|
|
19555
|
+
|
|
18363
19556
|
/**
|
|
18364
19557
|
*
|
|
18365
19558
|
* @export
|
|
@@ -18788,6 +19981,56 @@ export interface PosOrderPriceDto {
|
|
|
18788
19981
|
*/
|
|
18789
19982
|
'total': MoneyDto;
|
|
18790
19983
|
}
|
|
19984
|
+
/**
|
|
19985
|
+
*
|
|
19986
|
+
* @export
|
|
19987
|
+
* @interface PosOrderPriceDtoV6
|
|
19988
|
+
*/
|
|
19989
|
+
export interface PosOrderPriceDtoV6 {
|
|
19990
|
+
/**
|
|
19991
|
+
*
|
|
19992
|
+
* @type {MoneyDto}
|
|
19993
|
+
* @memberof PosOrderPriceDtoV6
|
|
19994
|
+
*/
|
|
19995
|
+
'total': MoneyDto;
|
|
19996
|
+
/**
|
|
19997
|
+
*
|
|
19998
|
+
* @type {PosOrderPriceDtoV6PriceBreakdown}
|
|
19999
|
+
* @memberof PosOrderPriceDtoV6
|
|
20000
|
+
*/
|
|
20001
|
+
'priceBreakdown'?: PosOrderPriceDtoV6PriceBreakdown;
|
|
20002
|
+
}
|
|
20003
|
+
/**
|
|
20004
|
+
* Omitted without Transaction::ViewDiscounts
|
|
20005
|
+
* @export
|
|
20006
|
+
* @interface PosOrderPriceDtoV6PriceBreakdown
|
|
20007
|
+
*/
|
|
20008
|
+
export interface PosOrderPriceDtoV6PriceBreakdown {
|
|
20009
|
+
/**
|
|
20010
|
+
*
|
|
20011
|
+
* @type {MoneyDto}
|
|
20012
|
+
* @memberof PosOrderPriceDtoV6PriceBreakdown
|
|
20013
|
+
*/
|
|
20014
|
+
'totalBeforeDiscounts': MoneyDto;
|
|
20015
|
+
/**
|
|
20016
|
+
*
|
|
20017
|
+
* @type {MoneyDto}
|
|
20018
|
+
* @memberof PosOrderPriceDtoV6PriceBreakdown
|
|
20019
|
+
*/
|
|
20020
|
+
'subtotalItemDiscounts': MoneyDto;
|
|
20021
|
+
/**
|
|
20022
|
+
*
|
|
20023
|
+
* @type {MoneyDto}
|
|
20024
|
+
* @memberof PosOrderPriceDtoV6PriceBreakdown
|
|
20025
|
+
*/
|
|
20026
|
+
'subtotalBasketDiscounts': MoneyDto;
|
|
20027
|
+
/**
|
|
20028
|
+
*
|
|
20029
|
+
* @type {MoneyDto}
|
|
20030
|
+
* @memberof PosOrderPriceDtoV6PriceBreakdown
|
|
20031
|
+
*/
|
|
20032
|
+
'totalDiscounts': MoneyDto;
|
|
20033
|
+
}
|
|
18791
20034
|
/**
|
|
18792
20035
|
*
|
|
18793
20036
|
* @export
|
|
@@ -18843,6 +20086,43 @@ export interface PosOrderSuboptionDto {
|
|
|
18843
20086
|
*/
|
|
18844
20087
|
'value_pos_id': string | null;
|
|
18845
20088
|
}
|
|
20089
|
+
/**
|
|
20090
|
+
*
|
|
20091
|
+
* @export
|
|
20092
|
+
* @interface PosOrderSummaryDtoV6
|
|
20093
|
+
*/
|
|
20094
|
+
export interface PosOrderSummaryDtoV6 {
|
|
20095
|
+
/**
|
|
20096
|
+
* Total orders
|
|
20097
|
+
* @type {number}
|
|
20098
|
+
* @memberof PosOrderSummaryDtoV6
|
|
20099
|
+
*/
|
|
20100
|
+
'totalOrders'?: number;
|
|
20101
|
+
/**
|
|
20102
|
+
* Rejected orders
|
|
20103
|
+
* @type {number}
|
|
20104
|
+
* @memberof PosOrderSummaryDtoV6
|
|
20105
|
+
*/
|
|
20106
|
+
'rejectedOrders'?: number;
|
|
20107
|
+
/**
|
|
20108
|
+
* Total sales
|
|
20109
|
+
* @type {number}
|
|
20110
|
+
* @memberof PosOrderSummaryDtoV6
|
|
20111
|
+
*/
|
|
20112
|
+
'totalSales'?: number;
|
|
20113
|
+
/**
|
|
20114
|
+
* Rejected sales
|
|
20115
|
+
* @type {number}
|
|
20116
|
+
* @memberof PosOrderSummaryDtoV6
|
|
20117
|
+
*/
|
|
20118
|
+
'rejectedSales'?: number;
|
|
20119
|
+
/**
|
|
20120
|
+
* Total tip amount in cents
|
|
20121
|
+
* @type {number}
|
|
20122
|
+
* @memberof PosOrderSummaryDtoV6
|
|
20123
|
+
*/
|
|
20124
|
+
'totalTipAmount'?: number;
|
|
20125
|
+
}
|
|
18846
20126
|
/**
|
|
18847
20127
|
*
|
|
18848
20128
|
* @export
|
|
@@ -18933,6 +20213,15 @@ export const PosPermission = {
|
|
|
18933
20213
|
CashSendReport: 'Cash::SendReport',
|
|
18934
20214
|
Transaction: 'Transaction::*',
|
|
18935
20215
|
TransactionRefund: 'Transaction::Refund',
|
|
20216
|
+
TransactionViewAll: 'Transaction::ViewAll',
|
|
20217
|
+
TransactionViewTips: 'Transaction::ViewTips',
|
|
20218
|
+
TransactionViewSurcharges: 'Transaction::ViewSurcharges',
|
|
20219
|
+
TransactionViewDiscounts: 'Transaction::ViewDiscounts',
|
|
20220
|
+
TransactionTotals: 'TransactionTotals::*',
|
|
20221
|
+
TransactionTotalsOrders: 'TransactionTotals::Orders',
|
|
20222
|
+
TransactionTotalsSales: 'TransactionTotals::Sales',
|
|
20223
|
+
TransactionTotalsRejectedOrders: 'TransactionTotals::RejectedOrders',
|
|
20224
|
+
TransactionTotalsRejectedSales: 'TransactionTotals::RejectedSales',
|
|
18936
20225
|
Order: 'Order::*',
|
|
18937
20226
|
OrderSendReceipt: 'Order::SendReceipt',
|
|
18938
20227
|
OpenOrdersDelete: 'OpenOrders::Delete',
|
|
@@ -18947,7 +20236,23 @@ export const PosPermission = {
|
|
|
18947
20236
|
Settings: 'Settings::*',
|
|
18948
20237
|
SettingsEditProfile: 'Settings::EditProfile',
|
|
18949
20238
|
Report: 'Report::*',
|
|
18950
|
-
ReportSendEmail: 'Report::SendEmail'
|
|
20239
|
+
ReportSendEmail: 'Report::SendEmail',
|
|
20240
|
+
ReportViewAll: 'Report::ViewAll',
|
|
20241
|
+
ReportViewSalesSummary: 'Report::ViewSalesSummary',
|
|
20242
|
+
ReportViewPaymentMethods: 'Report::ViewPaymentMethods',
|
|
20243
|
+
ReportViewItemSales: 'Report::ViewItemSales',
|
|
20244
|
+
ReportViewCashLogs: 'Report::ViewCashLogs',
|
|
20245
|
+
ReportTotals: 'ReportTotals::*',
|
|
20246
|
+
ReportTotalsOrders: 'ReportTotals::Orders',
|
|
20247
|
+
ReportTotalsSales: 'ReportTotals::Sales',
|
|
20248
|
+
ReportTotalsTips: 'ReportTotals::Tips',
|
|
20249
|
+
ReportTotalsSurcharges: 'ReportTotals::Surcharges',
|
|
20250
|
+
ReportTotalsRejectedOrders: 'ReportTotals::RejectedOrders',
|
|
20251
|
+
ReportTotalsRejectedSales: 'ReportTotals::RejectedSales',
|
|
20252
|
+
ReportTotalsAverageSale: 'ReportTotals::AverageSale',
|
|
20253
|
+
ReportTotalsItems: 'ReportTotals::Items',
|
|
20254
|
+
ReportTotalsRefunds: 'ReportTotals::Refunds',
|
|
20255
|
+
ReportTotalsDiscounts: 'ReportTotals::Discounts'
|
|
18951
20256
|
} as const;
|
|
18952
20257
|
|
|
18953
20258
|
export type PosPermission = typeof PosPermission[keyof typeof PosPermission];
|
|
@@ -18978,6 +20283,31 @@ export interface PosRoleDto {
|
|
|
18978
20283
|
*/
|
|
18979
20284
|
'permissionRules': Array<PermissionRuleResponseDto>;
|
|
18980
20285
|
}
|
|
20286
|
+
/**
|
|
20287
|
+
*
|
|
20288
|
+
* @export
|
|
20289
|
+
* @interface PosRoleDtoV6
|
|
20290
|
+
*/
|
|
20291
|
+
export interface PosRoleDtoV6 {
|
|
20292
|
+
/**
|
|
20293
|
+
*
|
|
20294
|
+
* @type {string}
|
|
20295
|
+
* @memberof PosRoleDtoV6
|
|
20296
|
+
*/
|
|
20297
|
+
'id': string;
|
|
20298
|
+
/**
|
|
20299
|
+
*
|
|
20300
|
+
* @type {string}
|
|
20301
|
+
* @memberof PosRoleDtoV6
|
|
20302
|
+
*/
|
|
20303
|
+
'name': string;
|
|
20304
|
+
/**
|
|
20305
|
+
*
|
|
20306
|
+
* @type {Array<PermissionRuleDtoV6>}
|
|
20307
|
+
* @memberof PosRoleDtoV6
|
|
20308
|
+
*/
|
|
20309
|
+
'permissionRules': Array<PermissionRuleDtoV6>;
|
|
20310
|
+
}
|
|
18981
20311
|
/**
|
|
18982
20312
|
*
|
|
18983
20313
|
* @export
|
|
@@ -19042,6 +20372,31 @@ export interface PosSessionResponseDto {
|
|
|
19042
20372
|
}
|
|
19043
20373
|
|
|
19044
20374
|
|
|
20375
|
+
/**
|
|
20376
|
+
*
|
|
20377
|
+
* @export
|
|
20378
|
+
* @interface PosSessionResponseDtoV6
|
|
20379
|
+
*/
|
|
20380
|
+
export interface PosSessionResponseDtoV6 {
|
|
20381
|
+
/**
|
|
20382
|
+
*
|
|
20383
|
+
* @type {Array<PosEmployeeDtoV6>}
|
|
20384
|
+
* @memberof PosSessionResponseDtoV6
|
|
20385
|
+
*/
|
|
20386
|
+
'employees': Array<PosEmployeeDtoV6>;
|
|
20387
|
+
/**
|
|
20388
|
+
*
|
|
20389
|
+
* @type {Array<PosRoleDtoV6>}
|
|
20390
|
+
* @memberof PosSessionResponseDtoV6
|
|
20391
|
+
*/
|
|
20392
|
+
'roles': Array<PosRoleDtoV6>;
|
|
20393
|
+
/**
|
|
20394
|
+
*
|
|
20395
|
+
* @type {Array<PosActionPasscodeDtoV6>}
|
|
20396
|
+
* @memberof PosSessionResponseDtoV6
|
|
20397
|
+
*/
|
|
20398
|
+
'actionPasscodes': Array<PosActionPasscodeDtoV6>;
|
|
20399
|
+
}
|
|
19045
20400
|
/**
|
|
19046
20401
|
*
|
|
19047
20402
|
* @export
|
|
@@ -21668,6 +23023,44 @@ export interface RejectOrderDto {
|
|
|
21668
23023
|
}
|
|
21669
23024
|
|
|
21670
23025
|
|
|
23026
|
+
/**
|
|
23027
|
+
*
|
|
23028
|
+
* @export
|
|
23029
|
+
* @interface RenewScopedTokenDto
|
|
23030
|
+
*/
|
|
23031
|
+
export interface RenewScopedTokenDto {
|
|
23032
|
+
/**
|
|
23033
|
+
* The renewal ticket issued with the token being renewed
|
|
23034
|
+
* @type {string}
|
|
23035
|
+
* @memberof RenewScopedTokenDto
|
|
23036
|
+
*/
|
|
23037
|
+
'renewalTicket': string;
|
|
23038
|
+
}
|
|
23039
|
+
/**
|
|
23040
|
+
*
|
|
23041
|
+
* @export
|
|
23042
|
+
* @interface ReportEmailResponseDtoV6
|
|
23043
|
+
*/
|
|
23044
|
+
export interface ReportEmailResponseDtoV6 {
|
|
23045
|
+
/**
|
|
23046
|
+
*
|
|
23047
|
+
* @type {boolean}
|
|
23048
|
+
* @memberof ReportEmailResponseDtoV6
|
|
23049
|
+
*/
|
|
23050
|
+
'success': boolean;
|
|
23051
|
+
/**
|
|
23052
|
+
*
|
|
23053
|
+
* @type {string}
|
|
23054
|
+
* @memberof ReportEmailResponseDtoV6
|
|
23055
|
+
*/
|
|
23056
|
+
'message': string;
|
|
23057
|
+
/**
|
|
23058
|
+
*
|
|
23059
|
+
* @type {string}
|
|
23060
|
+
* @memberof ReportEmailResponseDtoV6
|
|
23061
|
+
*/
|
|
23062
|
+
'timestamp': string;
|
|
23063
|
+
}
|
|
21671
23064
|
/**
|
|
21672
23065
|
*
|
|
21673
23066
|
* @export
|
|
@@ -22330,6 +23723,109 @@ export interface SalesSummaryDtoV2 {
|
|
|
22330
23723
|
*/
|
|
22331
23724
|
'totalSurchargeAmount': number;
|
|
22332
23725
|
}
|
|
23726
|
+
/**
|
|
23727
|
+
*
|
|
23728
|
+
* @export
|
|
23729
|
+
* @interface SalesSummaryDtoV6
|
|
23730
|
+
*/
|
|
23731
|
+
export interface SalesSummaryDtoV6 {
|
|
23732
|
+
/**
|
|
23733
|
+
* Total number of orders
|
|
23734
|
+
* @type {number}
|
|
23735
|
+
* @memberof SalesSummaryDtoV6
|
|
23736
|
+
*/
|
|
23737
|
+
'totalOrders'?: number;
|
|
23738
|
+
/**
|
|
23739
|
+
* Total sales amount
|
|
23740
|
+
* @type {number}
|
|
23741
|
+
* @memberof SalesSummaryDtoV6
|
|
23742
|
+
*/
|
|
23743
|
+
'totalSales'?: number;
|
|
23744
|
+
/**
|
|
23745
|
+
* Net sales amount after adjustments
|
|
23746
|
+
* @type {number}
|
|
23747
|
+
* @memberof SalesSummaryDtoV6
|
|
23748
|
+
*/
|
|
23749
|
+
'netSales'?: number;
|
|
23750
|
+
/**
|
|
23751
|
+
* Total amount actually paid
|
|
23752
|
+
* @type {number}
|
|
23753
|
+
* @memberof SalesSummaryDtoV6
|
|
23754
|
+
*/
|
|
23755
|
+
'totalPaid'?: number;
|
|
23756
|
+
/**
|
|
23757
|
+
* Total difference
|
|
23758
|
+
* @type {number}
|
|
23759
|
+
* @memberof SalesSummaryDtoV6
|
|
23760
|
+
*/
|
|
23761
|
+
'totalDifference'?: number;
|
|
23762
|
+
/**
|
|
23763
|
+
* Total transactions
|
|
23764
|
+
* @type {number}
|
|
23765
|
+
* @memberof SalesSummaryDtoV6
|
|
23766
|
+
*/
|
|
23767
|
+
'totalTransactions'?: number;
|
|
23768
|
+
/**
|
|
23769
|
+
* Number of rejected orders
|
|
23770
|
+
* @type {number}
|
|
23771
|
+
* @memberof SalesSummaryDtoV6
|
|
23772
|
+
*/
|
|
23773
|
+
'rejectedOrders'?: number;
|
|
23774
|
+
/**
|
|
23775
|
+
* Total rejected sales amount
|
|
23776
|
+
* @type {number}
|
|
23777
|
+
* @memberof SalesSummaryDtoV6
|
|
23778
|
+
*/
|
|
23779
|
+
'rejectedSales'?: number;
|
|
23780
|
+
/**
|
|
23781
|
+
* Average sales per order
|
|
23782
|
+
* @type {number}
|
|
23783
|
+
* @memberof SalesSummaryDtoV6
|
|
23784
|
+
*/
|
|
23785
|
+
'averageSales'?: number;
|
|
23786
|
+
/**
|
|
23787
|
+
* Total number of items sold
|
|
23788
|
+
* @type {number}
|
|
23789
|
+
* @memberof SalesSummaryDtoV6
|
|
23790
|
+
*/
|
|
23791
|
+
'totalItemsCount'?: number;
|
|
23792
|
+
/**
|
|
23793
|
+
* Total refund amount
|
|
23794
|
+
* @type {number}
|
|
23795
|
+
* @memberof SalesSummaryDtoV6
|
|
23796
|
+
*/
|
|
23797
|
+
'totalRefunds'?: number;
|
|
23798
|
+
/**
|
|
23799
|
+
* Total discount amount given
|
|
23800
|
+
* @type {number}
|
|
23801
|
+
* @memberof SalesSummaryDtoV6
|
|
23802
|
+
*/
|
|
23803
|
+
'totalDiscounts'?: number;
|
|
23804
|
+
/**
|
|
23805
|
+
* Total voucher forfeited amount in cents
|
|
23806
|
+
* @type {number}
|
|
23807
|
+
* @memberof SalesSummaryDtoV6
|
|
23808
|
+
*/
|
|
23809
|
+
'totalVoucherForfeited'?: number;
|
|
23810
|
+
/**
|
|
23811
|
+
* Total amount of all payment methods
|
|
23812
|
+
* @type {number}
|
|
23813
|
+
* @memberof SalesSummaryDtoV6
|
|
23814
|
+
*/
|
|
23815
|
+
'totalPaymentAmount'?: number;
|
|
23816
|
+
/**
|
|
23817
|
+
* Total tip amount in cents
|
|
23818
|
+
* @type {number}
|
|
23819
|
+
* @memberof SalesSummaryDtoV6
|
|
23820
|
+
*/
|
|
23821
|
+
'totalTipAmount'?: number;
|
|
23822
|
+
/**
|
|
23823
|
+
* Total surcharge amount in cents
|
|
23824
|
+
* @type {number}
|
|
23825
|
+
* @memberof SalesSummaryDtoV6
|
|
23826
|
+
*/
|
|
23827
|
+
'totalSurchargeAmount'?: number;
|
|
23828
|
+
}
|
|
22333
23829
|
/**
|
|
22334
23830
|
*
|
|
22335
23831
|
* @export
|
|
@@ -22407,6 +23903,57 @@ export const ScheduleType = {
|
|
|
22407
23903
|
export type ScheduleType = typeof ScheduleType[keyof typeof ScheduleType];
|
|
22408
23904
|
|
|
22409
23905
|
|
|
23906
|
+
/**
|
|
23907
|
+
*
|
|
23908
|
+
* @export
|
|
23909
|
+
* @interface ScopedTokenResponseDto
|
|
23910
|
+
*/
|
|
23911
|
+
export interface ScopedTokenResponseDto {
|
|
23912
|
+
/**
|
|
23913
|
+
* Send as the Bearer token on every request, to v1–v5 and v6 routes alike
|
|
23914
|
+
* @type {string}
|
|
23915
|
+
* @memberof ScopedTokenResponseDto
|
|
23916
|
+
*/
|
|
23917
|
+
'scopedToken': string;
|
|
23918
|
+
/**
|
|
23919
|
+
* Single-use; renews this token within 30 days. The response carries the next ticket
|
|
23920
|
+
* @type {string}
|
|
23921
|
+
* @memberof ScopedTokenResponseDto
|
|
23922
|
+
*/
|
|
23923
|
+
'renewalTicket': string;
|
|
23924
|
+
/**
|
|
23925
|
+
* Seconds until the scoped token expires
|
|
23926
|
+
* @type {number}
|
|
23927
|
+
* @memberof ScopedTokenResponseDto
|
|
23928
|
+
*/
|
|
23929
|
+
'expiresIn': number;
|
|
23930
|
+
/**
|
|
23931
|
+
*
|
|
23932
|
+
* @type {ActorType}
|
|
23933
|
+
* @memberof ScopedTokenResponseDto
|
|
23934
|
+
*/
|
|
23935
|
+
'actorType': ActorType;
|
|
23936
|
+
/**
|
|
23937
|
+
*
|
|
23938
|
+
* @type {OperatingMode}
|
|
23939
|
+
* @memberof ScopedTokenResponseDto
|
|
23940
|
+
*/
|
|
23941
|
+
'mode': OperatingMode;
|
|
23942
|
+
/**
|
|
23943
|
+
*
|
|
23944
|
+
* @type {Array<PosPermission>}
|
|
23945
|
+
* @memberof ScopedTokenResponseDto
|
|
23946
|
+
*/
|
|
23947
|
+
'scopes': Array<PosPermission>;
|
|
23948
|
+
/**
|
|
23949
|
+
* PINLOCK: permissions that require an action approval
|
|
23950
|
+
* @type {Array<PosPermission>}
|
|
23951
|
+
* @memberof ScopedTokenResponseDto
|
|
23952
|
+
*/
|
|
23953
|
+
'protectedScopes': Array<PosPermission>;
|
|
23954
|
+
}
|
|
23955
|
+
|
|
23956
|
+
|
|
22410
23957
|
/**
|
|
22411
23958
|
*
|
|
22412
23959
|
* @export
|
|
@@ -29345,7 +30892,7 @@ export interface VoidManualSessionDto {
|
|
|
29345
30892
|
*/
|
|
29346
30893
|
'orderId': string;
|
|
29347
30894
|
/**
|
|
29348
|
-
*
|
|
30895
|
+
* Staff to name on the REFUND cash log (staffId, staffName). Reverting a cash payment is recorded in the business\'s open cash session whether or not this is sent; enabled and sessionId are no longer read.
|
|
29349
30896
|
* @type {object}
|
|
29350
30897
|
* @memberof VoidManualSessionDto
|
|
29351
30898
|
*/
|
|
@@ -29996,6 +31543,437 @@ export class AblyApi extends BaseAPI implements AblyApiInterface {
|
|
|
29996
31543
|
}
|
|
29997
31544
|
|
|
29998
31545
|
|
|
31546
|
+
/**
|
|
31547
|
+
* AccessControlApi - axios parameter creator
|
|
31548
|
+
* @export
|
|
31549
|
+
*/
|
|
31550
|
+
export const AccessControlApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
31551
|
+
return {
|
|
31552
|
+
/**
|
|
31553
|
+
* The backoffice builds its role and passcode checkboxes from this list, so a new permission needs no hand-typed label in the portal. Groups follow POS_PERMISSION_MAP; a group\'s familyKey grants all of its permissions at once.
|
|
31554
|
+
* @summary Every POS permission with its label, group and kind
|
|
31555
|
+
* @param {*} [options] Override http request option.
|
|
31556
|
+
* @throws {RequiredError}
|
|
31557
|
+
*/
|
|
31558
|
+
getPermissionCatalogV1: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31559
|
+
const localVarPath = `/api/v1/access-control/permission-catalog`;
|
|
31560
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31561
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31562
|
+
let baseOptions;
|
|
31563
|
+
if (configuration) {
|
|
31564
|
+
baseOptions = configuration.baseOptions;
|
|
31565
|
+
}
|
|
31566
|
+
|
|
31567
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
31568
|
+
const localVarHeaderParameter = {} as any;
|
|
31569
|
+
const localVarQueryParameter = {} as any;
|
|
31570
|
+
|
|
31571
|
+
|
|
31572
|
+
|
|
31573
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31574
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31575
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31576
|
+
|
|
31577
|
+
return {
|
|
31578
|
+
url: toPathString(localVarUrlObj),
|
|
31579
|
+
options: localVarRequestOptions,
|
|
31580
|
+
};
|
|
31581
|
+
},
|
|
31582
|
+
/**
|
|
31583
|
+
* Only for permissions in the tablet token\'s protectedScopes. An unknown PIN and a passcode that does not grant the permission both return the same 403.
|
|
31584
|
+
* @summary Exchange a PINLOCK passcode PIN for an approval of one protected permission
|
|
31585
|
+
* @param {IssueActionApprovalDto} issueActionApprovalDto
|
|
31586
|
+
* @param {*} [options] Override http request option.
|
|
31587
|
+
* @throws {RequiredError}
|
|
31588
|
+
*/
|
|
31589
|
+
issueActionApprovalV1: async (issueActionApprovalDto: IssueActionApprovalDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31590
|
+
// verify required parameter 'issueActionApprovalDto' is not null or undefined
|
|
31591
|
+
assertParamExists('issueActionApprovalV1', 'issueActionApprovalDto', issueActionApprovalDto)
|
|
31592
|
+
const localVarPath = `/api/v1/access-control/action-approvals`;
|
|
31593
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31594
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31595
|
+
let baseOptions;
|
|
31596
|
+
if (configuration) {
|
|
31597
|
+
baseOptions = configuration.baseOptions;
|
|
31598
|
+
}
|
|
31599
|
+
|
|
31600
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
31601
|
+
const localVarHeaderParameter = {} as any;
|
|
31602
|
+
const localVarQueryParameter = {} as any;
|
|
31603
|
+
|
|
31604
|
+
|
|
31605
|
+
|
|
31606
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
31607
|
+
|
|
31608
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31609
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31610
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31611
|
+
localVarRequestOptions.data = serializeDataIfNeeded(issueActionApprovalDto, localVarRequestOptions, configuration)
|
|
31612
|
+
|
|
31613
|
+
return {
|
|
31614
|
+
url: toPathString(localVarUrlObj),
|
|
31615
|
+
options: localVarRequestOptions,
|
|
31616
|
+
};
|
|
31617
|
+
},
|
|
31618
|
+
/**
|
|
31619
|
+
* TEAM mode only. Accepts the tablet\'s own token, never an employee\'s. An unknown PIN and a PIN whose role lacks Access::PosApp both return the same 403. After 5 refused PINs on one device within 30 seconds, returns 429.
|
|
31620
|
+
* @summary Exchange the tablet token and an employee\'s PIN for the employee\'s scoped token
|
|
31621
|
+
* @param {IssueEmployeeTokenDto} issueEmployeeTokenDto
|
|
31622
|
+
* @param {*} [options] Override http request option.
|
|
31623
|
+
* @throws {RequiredError}
|
|
31624
|
+
*/
|
|
31625
|
+
issueEmployeeTokenV1: async (issueEmployeeTokenDto: IssueEmployeeTokenDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31626
|
+
// verify required parameter 'issueEmployeeTokenDto' is not null or undefined
|
|
31627
|
+
assertParamExists('issueEmployeeTokenV1', 'issueEmployeeTokenDto', issueEmployeeTokenDto)
|
|
31628
|
+
const localVarPath = `/api/v1/access-control/employee-tokens`;
|
|
31629
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31630
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31631
|
+
let baseOptions;
|
|
31632
|
+
if (configuration) {
|
|
31633
|
+
baseOptions = configuration.baseOptions;
|
|
31634
|
+
}
|
|
31635
|
+
|
|
31636
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
31637
|
+
const localVarHeaderParameter = {} as any;
|
|
31638
|
+
const localVarQueryParameter = {} as any;
|
|
31639
|
+
|
|
31640
|
+
|
|
31641
|
+
|
|
31642
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
31643
|
+
|
|
31644
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31645
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31646
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31647
|
+
localVarRequestOptions.data = serializeDataIfNeeded(issueEmployeeTokenDto, localVarRequestOptions, configuration)
|
|
31648
|
+
|
|
31649
|
+
return {
|
|
31650
|
+
url: toPathString(localVarUrlObj),
|
|
31651
|
+
options: localVarRequestOptions,
|
|
31652
|
+
};
|
|
31653
|
+
},
|
|
31654
|
+
/**
|
|
31655
|
+
* Call once per device sign-in, in every operating mode. The client then discards the login token and its refresh token. In TEAM mode the tablet token grants no permissions until an employee signs in through employee-tokens.
|
|
31656
|
+
* @summary Exchange the login token for the tablet\'s scoped token and renewal ticket
|
|
31657
|
+
* @param {IssueTabletTokenDto} issueTabletTokenDto
|
|
31658
|
+
* @param {*} [options] Override http request option.
|
|
31659
|
+
* @throws {RequiredError}
|
|
31660
|
+
*/
|
|
31661
|
+
issueTabletTokenV1: async (issueTabletTokenDto: IssueTabletTokenDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31662
|
+
// verify required parameter 'issueTabletTokenDto' is not null or undefined
|
|
31663
|
+
assertParamExists('issueTabletTokenV1', 'issueTabletTokenDto', issueTabletTokenDto)
|
|
31664
|
+
const localVarPath = `/api/v1/access-control/tablet-tokens`;
|
|
31665
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31666
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31667
|
+
let baseOptions;
|
|
31668
|
+
if (configuration) {
|
|
31669
|
+
baseOptions = configuration.baseOptions;
|
|
31670
|
+
}
|
|
31671
|
+
|
|
31672
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
31673
|
+
const localVarHeaderParameter = {} as any;
|
|
31674
|
+
const localVarQueryParameter = {} as any;
|
|
31675
|
+
|
|
31676
|
+
|
|
31677
|
+
|
|
31678
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
31679
|
+
|
|
31680
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31681
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31682
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31683
|
+
localVarRequestOptions.data = serializeDataIfNeeded(issueTabletTokenDto, localVarRequestOptions, configuration)
|
|
31684
|
+
|
|
31685
|
+
return {
|
|
31686
|
+
url: toPathString(localVarUrlObj),
|
|
31687
|
+
options: localVarRequestOptions,
|
|
31688
|
+
};
|
|
31689
|
+
},
|
|
31690
|
+
/**
|
|
31691
|
+
* Issues a fresh scoped token for the same actor and the next renewal ticket. Each ticket is single-use; presenting a used ticket revokes its chain. 403: the employee can no longer sign in, so the client asks for a PIN. 401: the device must sign in again.
|
|
31692
|
+
* @summary Renew a scoped token with its renewal ticket
|
|
31693
|
+
* @param {RenewScopedTokenDto} renewScopedTokenDto
|
|
31694
|
+
* @param {*} [options] Override http request option.
|
|
31695
|
+
* @throws {RequiredError}
|
|
31696
|
+
*/
|
|
31697
|
+
renewScopedTokenV1: async (renewScopedTokenDto: RenewScopedTokenDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
31698
|
+
// verify required parameter 'renewScopedTokenDto' is not null or undefined
|
|
31699
|
+
assertParamExists('renewScopedTokenV1', 'renewScopedTokenDto', renewScopedTokenDto)
|
|
31700
|
+
const localVarPath = `/api/v1/access-control/token-renewals`;
|
|
31701
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31702
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31703
|
+
let baseOptions;
|
|
31704
|
+
if (configuration) {
|
|
31705
|
+
baseOptions = configuration.baseOptions;
|
|
31706
|
+
}
|
|
31707
|
+
|
|
31708
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
31709
|
+
const localVarHeaderParameter = {} as any;
|
|
31710
|
+
const localVarQueryParameter = {} as any;
|
|
31711
|
+
|
|
31712
|
+
|
|
31713
|
+
|
|
31714
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
31715
|
+
|
|
31716
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31717
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31718
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31719
|
+
localVarRequestOptions.data = serializeDataIfNeeded(renewScopedTokenDto, localVarRequestOptions, configuration)
|
|
31720
|
+
|
|
31721
|
+
return {
|
|
31722
|
+
url: toPathString(localVarUrlObj),
|
|
31723
|
+
options: localVarRequestOptions,
|
|
31724
|
+
};
|
|
31725
|
+
},
|
|
31726
|
+
}
|
|
31727
|
+
};
|
|
31728
|
+
|
|
31729
|
+
/**
|
|
31730
|
+
* AccessControlApi - functional programming interface
|
|
31731
|
+
* @export
|
|
31732
|
+
*/
|
|
31733
|
+
export const AccessControlApiFp = function(configuration?: Configuration) {
|
|
31734
|
+
const localVarAxiosParamCreator = AccessControlApiAxiosParamCreator(configuration)
|
|
31735
|
+
return {
|
|
31736
|
+
/**
|
|
31737
|
+
* The backoffice builds its role and passcode checkboxes from this list, so a new permission needs no hand-typed label in the portal. Groups follow POS_PERMISSION_MAP; a group\'s familyKey grants all of its permissions at once.
|
|
31738
|
+
* @summary Every POS permission with its label, group and kind
|
|
31739
|
+
* @param {*} [options] Override http request option.
|
|
31740
|
+
* @throws {RequiredError}
|
|
31741
|
+
*/
|
|
31742
|
+
async getPermissionCatalogV1(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PermissionGroupDto>>> {
|
|
31743
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPermissionCatalogV1(options);
|
|
31744
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
31745
|
+
},
|
|
31746
|
+
/**
|
|
31747
|
+
* Only for permissions in the tablet token\'s protectedScopes. An unknown PIN and a passcode that does not grant the permission both return the same 403.
|
|
31748
|
+
* @summary Exchange a PINLOCK passcode PIN for an approval of one protected permission
|
|
31749
|
+
* @param {IssueActionApprovalDto} issueActionApprovalDto
|
|
31750
|
+
* @param {*} [options] Override http request option.
|
|
31751
|
+
* @throws {RequiredError}
|
|
31752
|
+
*/
|
|
31753
|
+
async issueActionApprovalV1(issueActionApprovalDto: IssueActionApprovalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionApprovalResponseDto>> {
|
|
31754
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.issueActionApprovalV1(issueActionApprovalDto, options);
|
|
31755
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
31756
|
+
},
|
|
31757
|
+
/**
|
|
31758
|
+
* TEAM mode only. Accepts the tablet\'s own token, never an employee\'s. An unknown PIN and a PIN whose role lacks Access::PosApp both return the same 403. After 5 refused PINs on one device within 30 seconds, returns 429.
|
|
31759
|
+
* @summary Exchange the tablet token and an employee\'s PIN for the employee\'s scoped token
|
|
31760
|
+
* @param {IssueEmployeeTokenDto} issueEmployeeTokenDto
|
|
31761
|
+
* @param {*} [options] Override http request option.
|
|
31762
|
+
* @throws {RequiredError}
|
|
31763
|
+
*/
|
|
31764
|
+
async issueEmployeeTokenV1(issueEmployeeTokenDto: IssueEmployeeTokenDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScopedTokenResponseDto>> {
|
|
31765
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.issueEmployeeTokenV1(issueEmployeeTokenDto, options);
|
|
31766
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
31767
|
+
},
|
|
31768
|
+
/**
|
|
31769
|
+
* Call once per device sign-in, in every operating mode. The client then discards the login token and its refresh token. In TEAM mode the tablet token grants no permissions until an employee signs in through employee-tokens.
|
|
31770
|
+
* @summary Exchange the login token for the tablet\'s scoped token and renewal ticket
|
|
31771
|
+
* @param {IssueTabletTokenDto} issueTabletTokenDto
|
|
31772
|
+
* @param {*} [options] Override http request option.
|
|
31773
|
+
* @throws {RequiredError}
|
|
31774
|
+
*/
|
|
31775
|
+
async issueTabletTokenV1(issueTabletTokenDto: IssueTabletTokenDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScopedTokenResponseDto>> {
|
|
31776
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.issueTabletTokenV1(issueTabletTokenDto, options);
|
|
31777
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
31778
|
+
},
|
|
31779
|
+
/**
|
|
31780
|
+
* Issues a fresh scoped token for the same actor and the next renewal ticket. Each ticket is single-use; presenting a used ticket revokes its chain. 403: the employee can no longer sign in, so the client asks for a PIN. 401: the device must sign in again.
|
|
31781
|
+
* @summary Renew a scoped token with its renewal ticket
|
|
31782
|
+
* @param {RenewScopedTokenDto} renewScopedTokenDto
|
|
31783
|
+
* @param {*} [options] Override http request option.
|
|
31784
|
+
* @throws {RequiredError}
|
|
31785
|
+
*/
|
|
31786
|
+
async renewScopedTokenV1(renewScopedTokenDto: RenewScopedTokenDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScopedTokenResponseDto>> {
|
|
31787
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.renewScopedTokenV1(renewScopedTokenDto, options);
|
|
31788
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
31789
|
+
},
|
|
31790
|
+
}
|
|
31791
|
+
};
|
|
31792
|
+
|
|
31793
|
+
/**
|
|
31794
|
+
* AccessControlApi - factory interface
|
|
31795
|
+
* @export
|
|
31796
|
+
*/
|
|
31797
|
+
export const AccessControlApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
31798
|
+
const localVarFp = AccessControlApiFp(configuration)
|
|
31799
|
+
return {
|
|
31800
|
+
/**
|
|
31801
|
+
* The backoffice builds its role and passcode checkboxes from this list, so a new permission needs no hand-typed label in the portal. Groups follow POS_PERMISSION_MAP; a group\'s familyKey grants all of its permissions at once.
|
|
31802
|
+
* @summary Every POS permission with its label, group and kind
|
|
31803
|
+
* @param {*} [options] Override http request option.
|
|
31804
|
+
* @throws {RequiredError}
|
|
31805
|
+
*/
|
|
31806
|
+
getPermissionCatalogV1(options?: any): AxiosPromise<Array<PermissionGroupDto>> {
|
|
31807
|
+
return localVarFp.getPermissionCatalogV1(options).then((request) => request(axios, basePath));
|
|
31808
|
+
},
|
|
31809
|
+
/**
|
|
31810
|
+
* Only for permissions in the tablet token\'s protectedScopes. An unknown PIN and a passcode that does not grant the permission both return the same 403.
|
|
31811
|
+
* @summary Exchange a PINLOCK passcode PIN for an approval of one protected permission
|
|
31812
|
+
* @param {IssueActionApprovalDto} issueActionApprovalDto
|
|
31813
|
+
* @param {*} [options] Override http request option.
|
|
31814
|
+
* @throws {RequiredError}
|
|
31815
|
+
*/
|
|
31816
|
+
issueActionApprovalV1(issueActionApprovalDto: IssueActionApprovalDto, options?: any): AxiosPromise<ActionApprovalResponseDto> {
|
|
31817
|
+
return localVarFp.issueActionApprovalV1(issueActionApprovalDto, options).then((request) => request(axios, basePath));
|
|
31818
|
+
},
|
|
31819
|
+
/**
|
|
31820
|
+
* TEAM mode only. Accepts the tablet\'s own token, never an employee\'s. An unknown PIN and a PIN whose role lacks Access::PosApp both return the same 403. After 5 refused PINs on one device within 30 seconds, returns 429.
|
|
31821
|
+
* @summary Exchange the tablet token and an employee\'s PIN for the employee\'s scoped token
|
|
31822
|
+
* @param {IssueEmployeeTokenDto} issueEmployeeTokenDto
|
|
31823
|
+
* @param {*} [options] Override http request option.
|
|
31824
|
+
* @throws {RequiredError}
|
|
31825
|
+
*/
|
|
31826
|
+
issueEmployeeTokenV1(issueEmployeeTokenDto: IssueEmployeeTokenDto, options?: any): AxiosPromise<ScopedTokenResponseDto> {
|
|
31827
|
+
return localVarFp.issueEmployeeTokenV1(issueEmployeeTokenDto, options).then((request) => request(axios, basePath));
|
|
31828
|
+
},
|
|
31829
|
+
/**
|
|
31830
|
+
* Call once per device sign-in, in every operating mode. The client then discards the login token and its refresh token. In TEAM mode the tablet token grants no permissions until an employee signs in through employee-tokens.
|
|
31831
|
+
* @summary Exchange the login token for the tablet\'s scoped token and renewal ticket
|
|
31832
|
+
* @param {IssueTabletTokenDto} issueTabletTokenDto
|
|
31833
|
+
* @param {*} [options] Override http request option.
|
|
31834
|
+
* @throws {RequiredError}
|
|
31835
|
+
*/
|
|
31836
|
+
issueTabletTokenV1(issueTabletTokenDto: IssueTabletTokenDto, options?: any): AxiosPromise<ScopedTokenResponseDto> {
|
|
31837
|
+
return localVarFp.issueTabletTokenV1(issueTabletTokenDto, options).then((request) => request(axios, basePath));
|
|
31838
|
+
},
|
|
31839
|
+
/**
|
|
31840
|
+
* Issues a fresh scoped token for the same actor and the next renewal ticket. Each ticket is single-use; presenting a used ticket revokes its chain. 403: the employee can no longer sign in, so the client asks for a PIN. 401: the device must sign in again.
|
|
31841
|
+
* @summary Renew a scoped token with its renewal ticket
|
|
31842
|
+
* @param {RenewScopedTokenDto} renewScopedTokenDto
|
|
31843
|
+
* @param {*} [options] Override http request option.
|
|
31844
|
+
* @throws {RequiredError}
|
|
31845
|
+
*/
|
|
31846
|
+
renewScopedTokenV1(renewScopedTokenDto: RenewScopedTokenDto, options?: any): AxiosPromise<ScopedTokenResponseDto> {
|
|
31847
|
+
return localVarFp.renewScopedTokenV1(renewScopedTokenDto, options).then((request) => request(axios, basePath));
|
|
31848
|
+
},
|
|
31849
|
+
};
|
|
31850
|
+
};
|
|
31851
|
+
|
|
31852
|
+
/**
|
|
31853
|
+
* AccessControlApi - interface
|
|
31854
|
+
* @export
|
|
31855
|
+
* @interface AccessControlApi
|
|
31856
|
+
*/
|
|
31857
|
+
export interface AccessControlApiInterface {
|
|
31858
|
+
/**
|
|
31859
|
+
* The backoffice builds its role and passcode checkboxes from this list, so a new permission needs no hand-typed label in the portal. Groups follow POS_PERMISSION_MAP; a group\'s familyKey grants all of its permissions at once.
|
|
31860
|
+
* @summary Every POS permission with its label, group and kind
|
|
31861
|
+
* @param {*} [options] Override http request option.
|
|
31862
|
+
* @throws {RequiredError}
|
|
31863
|
+
* @memberof AccessControlApiInterface
|
|
31864
|
+
*/
|
|
31865
|
+
getPermissionCatalogV1(options?: AxiosRequestConfig): AxiosPromise<Array<PermissionGroupDto>>;
|
|
31866
|
+
|
|
31867
|
+
/**
|
|
31868
|
+
* Only for permissions in the tablet token\'s protectedScopes. An unknown PIN and a passcode that does not grant the permission both return the same 403.
|
|
31869
|
+
* @summary Exchange a PINLOCK passcode PIN for an approval of one protected permission
|
|
31870
|
+
* @param {IssueActionApprovalDto} issueActionApprovalDto
|
|
31871
|
+
* @param {*} [options] Override http request option.
|
|
31872
|
+
* @throws {RequiredError}
|
|
31873
|
+
* @memberof AccessControlApiInterface
|
|
31874
|
+
*/
|
|
31875
|
+
issueActionApprovalV1(issueActionApprovalDto: IssueActionApprovalDto, options?: AxiosRequestConfig): AxiosPromise<ActionApprovalResponseDto>;
|
|
31876
|
+
|
|
31877
|
+
/**
|
|
31878
|
+
* TEAM mode only. Accepts the tablet\'s own token, never an employee\'s. An unknown PIN and a PIN whose role lacks Access::PosApp both return the same 403. After 5 refused PINs on one device within 30 seconds, returns 429.
|
|
31879
|
+
* @summary Exchange the tablet token and an employee\'s PIN for the employee\'s scoped token
|
|
31880
|
+
* @param {IssueEmployeeTokenDto} issueEmployeeTokenDto
|
|
31881
|
+
* @param {*} [options] Override http request option.
|
|
31882
|
+
* @throws {RequiredError}
|
|
31883
|
+
* @memberof AccessControlApiInterface
|
|
31884
|
+
*/
|
|
31885
|
+
issueEmployeeTokenV1(issueEmployeeTokenDto: IssueEmployeeTokenDto, options?: AxiosRequestConfig): AxiosPromise<ScopedTokenResponseDto>;
|
|
31886
|
+
|
|
31887
|
+
/**
|
|
31888
|
+
* Call once per device sign-in, in every operating mode. The client then discards the login token and its refresh token. In TEAM mode the tablet token grants no permissions until an employee signs in through employee-tokens.
|
|
31889
|
+
* @summary Exchange the login token for the tablet\'s scoped token and renewal ticket
|
|
31890
|
+
* @param {IssueTabletTokenDto} issueTabletTokenDto
|
|
31891
|
+
* @param {*} [options] Override http request option.
|
|
31892
|
+
* @throws {RequiredError}
|
|
31893
|
+
* @memberof AccessControlApiInterface
|
|
31894
|
+
*/
|
|
31895
|
+
issueTabletTokenV1(issueTabletTokenDto: IssueTabletTokenDto, options?: AxiosRequestConfig): AxiosPromise<ScopedTokenResponseDto>;
|
|
31896
|
+
|
|
31897
|
+
/**
|
|
31898
|
+
* Issues a fresh scoped token for the same actor and the next renewal ticket. Each ticket is single-use; presenting a used ticket revokes its chain. 403: the employee can no longer sign in, so the client asks for a PIN. 401: the device must sign in again.
|
|
31899
|
+
* @summary Renew a scoped token with its renewal ticket
|
|
31900
|
+
* @param {RenewScopedTokenDto} renewScopedTokenDto
|
|
31901
|
+
* @param {*} [options] Override http request option.
|
|
31902
|
+
* @throws {RequiredError}
|
|
31903
|
+
* @memberof AccessControlApiInterface
|
|
31904
|
+
*/
|
|
31905
|
+
renewScopedTokenV1(renewScopedTokenDto: RenewScopedTokenDto, options?: AxiosRequestConfig): AxiosPromise<ScopedTokenResponseDto>;
|
|
31906
|
+
|
|
31907
|
+
}
|
|
31908
|
+
|
|
31909
|
+
/**
|
|
31910
|
+
* AccessControlApi - object-oriented interface
|
|
31911
|
+
* @export
|
|
31912
|
+
* @class AccessControlApi
|
|
31913
|
+
* @extends {BaseAPI}
|
|
31914
|
+
*/
|
|
31915
|
+
export class AccessControlApi extends BaseAPI implements AccessControlApiInterface {
|
|
31916
|
+
/**
|
|
31917
|
+
* The backoffice builds its role and passcode checkboxes from this list, so a new permission needs no hand-typed label in the portal. Groups follow POS_PERMISSION_MAP; a group\'s familyKey grants all of its permissions at once.
|
|
31918
|
+
* @summary Every POS permission with its label, group and kind
|
|
31919
|
+
* @param {*} [options] Override http request option.
|
|
31920
|
+
* @throws {RequiredError}
|
|
31921
|
+
* @memberof AccessControlApi
|
|
31922
|
+
*/
|
|
31923
|
+
public getPermissionCatalogV1(options?: AxiosRequestConfig) {
|
|
31924
|
+
return AccessControlApiFp(this.configuration).getPermissionCatalogV1(options).then((request) => request(this.axios, this.basePath));
|
|
31925
|
+
}
|
|
31926
|
+
|
|
31927
|
+
/**
|
|
31928
|
+
* Only for permissions in the tablet token\'s protectedScopes. An unknown PIN and a passcode that does not grant the permission both return the same 403.
|
|
31929
|
+
* @summary Exchange a PINLOCK passcode PIN for an approval of one protected permission
|
|
31930
|
+
* @param {IssueActionApprovalDto} issueActionApprovalDto
|
|
31931
|
+
* @param {*} [options] Override http request option.
|
|
31932
|
+
* @throws {RequiredError}
|
|
31933
|
+
* @memberof AccessControlApi
|
|
31934
|
+
*/
|
|
31935
|
+
public issueActionApprovalV1(issueActionApprovalDto: IssueActionApprovalDto, options?: AxiosRequestConfig) {
|
|
31936
|
+
return AccessControlApiFp(this.configuration).issueActionApprovalV1(issueActionApprovalDto, options).then((request) => request(this.axios, this.basePath));
|
|
31937
|
+
}
|
|
31938
|
+
|
|
31939
|
+
/**
|
|
31940
|
+
* TEAM mode only. Accepts the tablet\'s own token, never an employee\'s. An unknown PIN and a PIN whose role lacks Access::PosApp both return the same 403. After 5 refused PINs on one device within 30 seconds, returns 429.
|
|
31941
|
+
* @summary Exchange the tablet token and an employee\'s PIN for the employee\'s scoped token
|
|
31942
|
+
* @param {IssueEmployeeTokenDto} issueEmployeeTokenDto
|
|
31943
|
+
* @param {*} [options] Override http request option.
|
|
31944
|
+
* @throws {RequiredError}
|
|
31945
|
+
* @memberof AccessControlApi
|
|
31946
|
+
*/
|
|
31947
|
+
public issueEmployeeTokenV1(issueEmployeeTokenDto: IssueEmployeeTokenDto, options?: AxiosRequestConfig) {
|
|
31948
|
+
return AccessControlApiFp(this.configuration).issueEmployeeTokenV1(issueEmployeeTokenDto, options).then((request) => request(this.axios, this.basePath));
|
|
31949
|
+
}
|
|
31950
|
+
|
|
31951
|
+
/**
|
|
31952
|
+
* Call once per device sign-in, in every operating mode. The client then discards the login token and its refresh token. In TEAM mode the tablet token grants no permissions until an employee signs in through employee-tokens.
|
|
31953
|
+
* @summary Exchange the login token for the tablet\'s scoped token and renewal ticket
|
|
31954
|
+
* @param {IssueTabletTokenDto} issueTabletTokenDto
|
|
31955
|
+
* @param {*} [options] Override http request option.
|
|
31956
|
+
* @throws {RequiredError}
|
|
31957
|
+
* @memberof AccessControlApi
|
|
31958
|
+
*/
|
|
31959
|
+
public issueTabletTokenV1(issueTabletTokenDto: IssueTabletTokenDto, options?: AxiosRequestConfig) {
|
|
31960
|
+
return AccessControlApiFp(this.configuration).issueTabletTokenV1(issueTabletTokenDto, options).then((request) => request(this.axios, this.basePath));
|
|
31961
|
+
}
|
|
31962
|
+
|
|
31963
|
+
/**
|
|
31964
|
+
* Issues a fresh scoped token for the same actor and the next renewal ticket. Each ticket is single-use; presenting a used ticket revokes its chain. 403: the employee can no longer sign in, so the client asks for a PIN. 401: the device must sign in again.
|
|
31965
|
+
* @summary Renew a scoped token with its renewal ticket
|
|
31966
|
+
* @param {RenewScopedTokenDto} renewScopedTokenDto
|
|
31967
|
+
* @param {*} [options] Override http request option.
|
|
31968
|
+
* @throws {RequiredError}
|
|
31969
|
+
* @memberof AccessControlApi
|
|
31970
|
+
*/
|
|
31971
|
+
public renewScopedTokenV1(renewScopedTokenDto: RenewScopedTokenDto, options?: AxiosRequestConfig) {
|
|
31972
|
+
return AccessControlApiFp(this.configuration).renewScopedTokenV1(renewScopedTokenDto, options).then((request) => request(this.axios, this.basePath));
|
|
31973
|
+
}
|
|
31974
|
+
}
|
|
31975
|
+
|
|
31976
|
+
|
|
29999
31977
|
/**
|
|
30000
31978
|
* ActionPasscodesApi - axios parameter creator
|
|
30001
31979
|
* @export
|
|
@@ -33275,6 +35253,70 @@ export const CashManagementApiAxiosParamCreator = function (configuration?: Conf
|
|
|
33275
35253
|
|
|
33276
35254
|
|
|
33277
35255
|
|
|
35256
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35257
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35258
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
35259
|
+
|
|
35260
|
+
return {
|
|
35261
|
+
url: toPathString(localVarUrlObj),
|
|
35262
|
+
options: localVarRequestOptions,
|
|
35263
|
+
};
|
|
35264
|
+
},
|
|
35265
|
+
/**
|
|
35266
|
+
* Requires Report::ViewCashLogs. The venue in the path must be the token\'s. An employee without Report::ViewAll receives only the movements recorded under their own name, filtered in the database; movements with no employee on them, such as opening and closing counts, belong to the venue and are not theirs to see.
|
|
35267
|
+
* @summary Cash movements of the token\'s venue, as shown from the Reports screen
|
|
35268
|
+
* @param {number} businessId
|
|
35269
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35270
|
+
* @param {string} [start] Start date
|
|
35271
|
+
* @param {string} [end] End date
|
|
35272
|
+
* @param {number} [page] Page number
|
|
35273
|
+
* @param {number} [rowPerPage] Rows per page
|
|
35274
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35275
|
+
* @param {*} [options] Override http request option.
|
|
35276
|
+
* @throws {RequiredError}
|
|
35277
|
+
*/
|
|
35278
|
+
getCashLogsV6: async (businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35279
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
35280
|
+
assertParamExists('getCashLogsV6', 'businessId', businessId)
|
|
35281
|
+
const localVarPath = `/api/v6/cash-management/{businessId}/logs`
|
|
35282
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
35283
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
35284
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
35285
|
+
let baseOptions;
|
|
35286
|
+
if (configuration) {
|
|
35287
|
+
baseOptions = configuration.baseOptions;
|
|
35288
|
+
}
|
|
35289
|
+
|
|
35290
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
35291
|
+
const localVarHeaderParameter = {} as any;
|
|
35292
|
+
const localVarQueryParameter = {} as any;
|
|
35293
|
+
|
|
35294
|
+
if (timeSpan !== undefined) {
|
|
35295
|
+
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
35296
|
+
}
|
|
35297
|
+
|
|
35298
|
+
if (start !== undefined) {
|
|
35299
|
+
localVarQueryParameter['start'] = start;
|
|
35300
|
+
}
|
|
35301
|
+
|
|
35302
|
+
if (end !== undefined) {
|
|
35303
|
+
localVarQueryParameter['end'] = end;
|
|
35304
|
+
}
|
|
35305
|
+
|
|
35306
|
+
if (page !== undefined) {
|
|
35307
|
+
localVarQueryParameter['page'] = page;
|
|
35308
|
+
}
|
|
35309
|
+
|
|
35310
|
+
if (rowPerPage !== undefined) {
|
|
35311
|
+
localVarQueryParameter['rowPerPage'] = rowPerPage;
|
|
35312
|
+
}
|
|
35313
|
+
|
|
35314
|
+
if (timezone !== undefined) {
|
|
35315
|
+
localVarQueryParameter['timezone'] = timezone;
|
|
35316
|
+
}
|
|
35317
|
+
|
|
35318
|
+
|
|
35319
|
+
|
|
33278
35320
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
33279
35321
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
33280
35322
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -33474,6 +35516,23 @@ export const CashManagementApiFp = function(configuration?: Configuration) {
|
|
|
33474
35516
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getCashLogs(businessId, timezone, timeSpan, start, end, page, rowPerPage, options);
|
|
33475
35517
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
33476
35518
|
},
|
|
35519
|
+
/**
|
|
35520
|
+
* Requires Report::ViewCashLogs. The venue in the path must be the token\'s. An employee without Report::ViewAll receives only the movements recorded under their own name, filtered in the database; movements with no employee on them, such as opening and closing counts, belong to the venue and are not theirs to see.
|
|
35521
|
+
* @summary Cash movements of the token\'s venue, as shown from the Reports screen
|
|
35522
|
+
* @param {number} businessId
|
|
35523
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35524
|
+
* @param {string} [start] Start date
|
|
35525
|
+
* @param {string} [end] End date
|
|
35526
|
+
* @param {number} [page] Page number
|
|
35527
|
+
* @param {number} [rowPerPage] Rows per page
|
|
35528
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35529
|
+
* @param {*} [options] Override http request option.
|
|
35530
|
+
* @throws {RequiredError}
|
|
35531
|
+
*/
|
|
35532
|
+
async getCashLogsV6(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashLogsPaginatedDto>> {
|
|
35533
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCashLogsV6(businessId, timeSpan, start, end, page, rowPerPage, timezone, options);
|
|
35534
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
35535
|
+
},
|
|
33477
35536
|
/**
|
|
33478
35537
|
*
|
|
33479
35538
|
* @param {string} businessId
|
|
@@ -33554,6 +35613,22 @@ export const CashManagementApiFactory = function (configuration?: Configuration,
|
|
|
33554
35613
|
getCashLogs(businessId: string, timezone: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, options?: any): AxiosPromise<CashLogsPaginatedDto> {
|
|
33555
35614
|
return localVarFp.getCashLogs(businessId, timezone, timeSpan, start, end, page, rowPerPage, options).then((request) => request(axios, basePath));
|
|
33556
35615
|
},
|
|
35616
|
+
/**
|
|
35617
|
+
* Requires Report::ViewCashLogs. The venue in the path must be the token\'s. An employee without Report::ViewAll receives only the movements recorded under their own name, filtered in the database; movements with no employee on them, such as opening and closing counts, belong to the venue and are not theirs to see.
|
|
35618
|
+
* @summary Cash movements of the token\'s venue, as shown from the Reports screen
|
|
35619
|
+
* @param {number} businessId
|
|
35620
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35621
|
+
* @param {string} [start] Start date
|
|
35622
|
+
* @param {string} [end] End date
|
|
35623
|
+
* @param {number} [page] Page number
|
|
35624
|
+
* @param {number} [rowPerPage] Rows per page
|
|
35625
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35626
|
+
* @param {*} [options] Override http request option.
|
|
35627
|
+
* @throws {RequiredError}
|
|
35628
|
+
*/
|
|
35629
|
+
getCashLogsV6(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: any): AxiosPromise<CashLogsPaginatedDto> {
|
|
35630
|
+
return localVarFp.getCashLogsV6(businessId, timeSpan, start, end, page, rowPerPage, timezone, options).then((request) => request(axios, basePath));
|
|
35631
|
+
},
|
|
33557
35632
|
/**
|
|
33558
35633
|
*
|
|
33559
35634
|
* @param {string} businessId
|
|
@@ -33629,6 +35704,22 @@ export interface CashManagementApiInterface {
|
|
|
33629
35704
|
*/
|
|
33630
35705
|
getCashLogs(businessId: string, timezone: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, options?: AxiosRequestConfig): AxiosPromise<CashLogsPaginatedDto>;
|
|
33631
35706
|
|
|
35707
|
+
/**
|
|
35708
|
+
* Requires Report::ViewCashLogs. The venue in the path must be the token\'s. An employee without Report::ViewAll receives only the movements recorded under their own name, filtered in the database; movements with no employee on them, such as opening and closing counts, belong to the venue and are not theirs to see.
|
|
35709
|
+
* @summary Cash movements of the token\'s venue, as shown from the Reports screen
|
|
35710
|
+
* @param {number} businessId
|
|
35711
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35712
|
+
* @param {string} [start] Start date
|
|
35713
|
+
* @param {string} [end] End date
|
|
35714
|
+
* @param {number} [page] Page number
|
|
35715
|
+
* @param {number} [rowPerPage] Rows per page
|
|
35716
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35717
|
+
* @param {*} [options] Override http request option.
|
|
35718
|
+
* @throws {RequiredError}
|
|
35719
|
+
* @memberof CashManagementApiInterface
|
|
35720
|
+
*/
|
|
35721
|
+
getCashLogsV6(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<CashLogsPaginatedDto>;
|
|
35722
|
+
|
|
33632
35723
|
/**
|
|
33633
35724
|
*
|
|
33634
35725
|
* @param {string} businessId
|
|
@@ -33708,6 +35799,24 @@ export class CashManagementApi extends BaseAPI implements CashManagementApiInter
|
|
|
33708
35799
|
return CashManagementApiFp(this.configuration).getCashLogs(businessId, timezone, timeSpan, start, end, page, rowPerPage, options).then((request) => request(this.axios, this.basePath));
|
|
33709
35800
|
}
|
|
33710
35801
|
|
|
35802
|
+
/**
|
|
35803
|
+
* Requires Report::ViewCashLogs. The venue in the path must be the token\'s. An employee without Report::ViewAll receives only the movements recorded under their own name, filtered in the database; movements with no employee on them, such as opening and closing counts, belong to the venue and are not theirs to see.
|
|
35804
|
+
* @summary Cash movements of the token\'s venue, as shown from the Reports screen
|
|
35805
|
+
* @param {number} businessId
|
|
35806
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35807
|
+
* @param {string} [start] Start date
|
|
35808
|
+
* @param {string} [end] End date
|
|
35809
|
+
* @param {number} [page] Page number
|
|
35810
|
+
* @param {number} [rowPerPage] Rows per page
|
|
35811
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35812
|
+
* @param {*} [options] Override http request option.
|
|
35813
|
+
* @throws {RequiredError}
|
|
35814
|
+
* @memberof CashManagementApi
|
|
35815
|
+
*/
|
|
35816
|
+
public getCashLogsV6(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: AxiosRequestConfig) {
|
|
35817
|
+
return CashManagementApiFp(this.configuration).getCashLogsV6(businessId, timeSpan, start, end, page, rowPerPage, timezone, options).then((request) => request(this.axios, this.basePath));
|
|
35818
|
+
}
|
|
35819
|
+
|
|
33711
35820
|
/**
|
|
33712
35821
|
*
|
|
33713
35822
|
* @param {string} businessId
|
|
@@ -37890,6 +39999,101 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
37890
39999
|
|
|
37891
40000
|
|
|
37892
40001
|
|
|
40002
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40003
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40004
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
40005
|
+
|
|
40006
|
+
return {
|
|
40007
|
+
url: toPathString(localVarUrlObj),
|
|
40008
|
+
options: localVarRequestOptions,
|
|
40009
|
+
};
|
|
40010
|
+
},
|
|
40011
|
+
/**
|
|
40012
|
+
* Online orders carry no employee, so the list needs Transaction::ViewAll. Totals are always included.
|
|
40013
|
+
* @summary Online order history of the token\'s venue
|
|
40014
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
40015
|
+
* @param {string} [start] Start date
|
|
40016
|
+
* @param {string} [end] End date
|
|
40017
|
+
* @param {number} [page] Page number
|
|
40018
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
40019
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
40020
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
40021
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
40022
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
40023
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
40024
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40025
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40026
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
40027
|
+
* @param {*} [options] Override http request option.
|
|
40028
|
+
* @throws {RequiredError}
|
|
40029
|
+
*/
|
|
40030
|
+
getOnlineOrderHistoryV6: async (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> => {
|
|
40031
|
+
const localVarPath = `/api/v6/history/orders/online`;
|
|
40032
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
40033
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40034
|
+
let baseOptions;
|
|
40035
|
+
if (configuration) {
|
|
40036
|
+
baseOptions = configuration.baseOptions;
|
|
40037
|
+
}
|
|
40038
|
+
|
|
40039
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
40040
|
+
const localVarHeaderParameter = {} as any;
|
|
40041
|
+
const localVarQueryParameter = {} as any;
|
|
40042
|
+
|
|
40043
|
+
if (timeSpan !== undefined) {
|
|
40044
|
+
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
40045
|
+
}
|
|
40046
|
+
|
|
40047
|
+
if (start !== undefined) {
|
|
40048
|
+
localVarQueryParameter['start'] = start;
|
|
40049
|
+
}
|
|
40050
|
+
|
|
40051
|
+
if (end !== undefined) {
|
|
40052
|
+
localVarQueryParameter['end'] = end;
|
|
40053
|
+
}
|
|
40054
|
+
|
|
40055
|
+
if (page !== undefined) {
|
|
40056
|
+
localVarQueryParameter['page'] = page;
|
|
40057
|
+
}
|
|
40058
|
+
|
|
40059
|
+
if (rowPerPage !== undefined) {
|
|
40060
|
+
localVarQueryParameter['rowPerPage'] = rowPerPage;
|
|
40061
|
+
}
|
|
40062
|
+
|
|
40063
|
+
if (provider) {
|
|
40064
|
+
localVarQueryParameter['provider'] = provider;
|
|
40065
|
+
}
|
|
40066
|
+
|
|
40067
|
+
if (paymentType) {
|
|
40068
|
+
localVarQueryParameter['paymentType'] = paymentType;
|
|
40069
|
+
}
|
|
40070
|
+
|
|
40071
|
+
if (orderStatus) {
|
|
40072
|
+
localVarQueryParameter['orderStatus'] = orderStatus;
|
|
40073
|
+
}
|
|
40074
|
+
|
|
40075
|
+
if (paymentStatus) {
|
|
40076
|
+
localVarQueryParameter['paymentStatus'] = paymentStatus;
|
|
40077
|
+
}
|
|
40078
|
+
|
|
40079
|
+
if (orderType) {
|
|
40080
|
+
localVarQueryParameter['orderType'] = orderType;
|
|
40081
|
+
}
|
|
40082
|
+
|
|
40083
|
+
if (paymentTypePos) {
|
|
40084
|
+
localVarQueryParameter['paymentTypePos'] = paymentTypePos;
|
|
40085
|
+
}
|
|
40086
|
+
|
|
40087
|
+
if (invoiceCompanyId !== undefined) {
|
|
40088
|
+
localVarQueryParameter['invoiceCompanyId'] = invoiceCompanyId;
|
|
40089
|
+
}
|
|
40090
|
+
|
|
40091
|
+
if (timezone !== undefined) {
|
|
40092
|
+
localVarQueryParameter['timezone'] = timezone;
|
|
40093
|
+
}
|
|
40094
|
+
|
|
40095
|
+
|
|
40096
|
+
|
|
37893
40097
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
37894
40098
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
37895
40099
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -38204,6 +40408,101 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
38204
40408
|
|
|
38205
40409
|
|
|
38206
40410
|
|
|
40411
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40412
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40413
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
40414
|
+
|
|
40415
|
+
return {
|
|
40416
|
+
url: toPathString(localVarUrlObj),
|
|
40417
|
+
options: localVarRequestOptions,
|
|
40418
|
+
};
|
|
40419
|
+
},
|
|
40420
|
+
/**
|
|
40421
|
+
* An employee without Transaction::ViewAll receives only their own orders, filtered in the database; the summary is computed from those orders. Fields the token\'s visibility keys do not allow are omitted.
|
|
40422
|
+
* @summary POS order history of the token\'s venue
|
|
40423
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
40424
|
+
* @param {string} [start] Start date
|
|
40425
|
+
* @param {string} [end] End date
|
|
40426
|
+
* @param {number} [page] Page number
|
|
40427
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
40428
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
40429
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
40430
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
40431
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
40432
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
40433
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40434
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40435
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
40436
|
+
* @param {*} [options] Override http request option.
|
|
40437
|
+
* @throws {RequiredError}
|
|
40438
|
+
*/
|
|
40439
|
+
getPosOrderHistoryV6: async (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> => {
|
|
40440
|
+
const localVarPath = `/api/v6/history/orders/pos`;
|
|
40441
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
40442
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40443
|
+
let baseOptions;
|
|
40444
|
+
if (configuration) {
|
|
40445
|
+
baseOptions = configuration.baseOptions;
|
|
40446
|
+
}
|
|
40447
|
+
|
|
40448
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
40449
|
+
const localVarHeaderParameter = {} as any;
|
|
40450
|
+
const localVarQueryParameter = {} as any;
|
|
40451
|
+
|
|
40452
|
+
if (timeSpan !== undefined) {
|
|
40453
|
+
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
40454
|
+
}
|
|
40455
|
+
|
|
40456
|
+
if (start !== undefined) {
|
|
40457
|
+
localVarQueryParameter['start'] = start;
|
|
40458
|
+
}
|
|
40459
|
+
|
|
40460
|
+
if (end !== undefined) {
|
|
40461
|
+
localVarQueryParameter['end'] = end;
|
|
40462
|
+
}
|
|
40463
|
+
|
|
40464
|
+
if (page !== undefined) {
|
|
40465
|
+
localVarQueryParameter['page'] = page;
|
|
40466
|
+
}
|
|
40467
|
+
|
|
40468
|
+
if (rowPerPage !== undefined) {
|
|
40469
|
+
localVarQueryParameter['rowPerPage'] = rowPerPage;
|
|
40470
|
+
}
|
|
40471
|
+
|
|
40472
|
+
if (provider) {
|
|
40473
|
+
localVarQueryParameter['provider'] = provider;
|
|
40474
|
+
}
|
|
40475
|
+
|
|
40476
|
+
if (paymentType) {
|
|
40477
|
+
localVarQueryParameter['paymentType'] = paymentType;
|
|
40478
|
+
}
|
|
40479
|
+
|
|
40480
|
+
if (orderStatus) {
|
|
40481
|
+
localVarQueryParameter['orderStatus'] = orderStatus;
|
|
40482
|
+
}
|
|
40483
|
+
|
|
40484
|
+
if (paymentStatus) {
|
|
40485
|
+
localVarQueryParameter['paymentStatus'] = paymentStatus;
|
|
40486
|
+
}
|
|
40487
|
+
|
|
40488
|
+
if (orderType) {
|
|
40489
|
+
localVarQueryParameter['orderType'] = orderType;
|
|
40490
|
+
}
|
|
40491
|
+
|
|
40492
|
+
if (paymentTypePos) {
|
|
40493
|
+
localVarQueryParameter['paymentTypePos'] = paymentTypePos;
|
|
40494
|
+
}
|
|
40495
|
+
|
|
40496
|
+
if (invoiceCompanyId !== undefined) {
|
|
40497
|
+
localVarQueryParameter['invoiceCompanyId'] = invoiceCompanyId;
|
|
40498
|
+
}
|
|
40499
|
+
|
|
40500
|
+
if (timezone !== undefined) {
|
|
40501
|
+
localVarQueryParameter['timezone'] = timezone;
|
|
40502
|
+
}
|
|
40503
|
+
|
|
40504
|
+
|
|
40505
|
+
|
|
38207
40506
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
38208
40507
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
38209
40508
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -38247,6 +40546,29 @@ export const HistoryApiFp = function(configuration?: Configuration) {
|
|
|
38247
40546
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getInternalOrderHistoryOnline(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options);
|
|
38248
40547
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38249
40548
|
},
|
|
40549
|
+
/**
|
|
40550
|
+
* Online orders carry no employee, so the list needs Transaction::ViewAll. Totals are always included.
|
|
40551
|
+
* @summary Online order history of the token\'s venue
|
|
40552
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
40553
|
+
* @param {string} [start] Start date
|
|
40554
|
+
* @param {string} [end] End date
|
|
40555
|
+
* @param {number} [page] Page number
|
|
40556
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
40557
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
40558
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
40559
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
40560
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
40561
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
40562
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40563
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40564
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
40565
|
+
* @param {*} [options] Override http request option.
|
|
40566
|
+
* @throws {RequiredError}
|
|
40567
|
+
*/
|
|
40568
|
+
async getOnlineOrderHistoryV6(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<OrderHistoryResponseDto>> {
|
|
40569
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getOnlineOrderHistoryV6(timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options);
|
|
40570
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
40571
|
+
},
|
|
38250
40572
|
/**
|
|
38251
40573
|
*
|
|
38252
40574
|
* @summary Get order history
|
|
@@ -38319,6 +40641,29 @@ export const HistoryApiFp = function(configuration?: Configuration) {
|
|
|
38319
40641
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderHistoryPOSV5Internal(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options);
|
|
38320
40642
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
38321
40643
|
},
|
|
40644
|
+
/**
|
|
40645
|
+
* An employee without Transaction::ViewAll receives only their own orders, filtered in the database; the summary is computed from those orders. Fields the token\'s visibility keys do not allow are omitted.
|
|
40646
|
+
* @summary POS order history of the token\'s venue
|
|
40647
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
40648
|
+
* @param {string} [start] Start date
|
|
40649
|
+
* @param {string} [end] End date
|
|
40650
|
+
* @param {number} [page] Page number
|
|
40651
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
40652
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
40653
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
40654
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
40655
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
40656
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
40657
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40658
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40659
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
40660
|
+
* @param {*} [options] Override http request option.
|
|
40661
|
+
* @throws {RequiredError}
|
|
40662
|
+
*/
|
|
40663
|
+
async getPosOrderHistoryV6(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<PosOrderHistoryResponseDtoV6>> {
|
|
40664
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPosOrderHistoryV6(timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options);
|
|
40665
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
40666
|
+
},
|
|
38322
40667
|
}
|
|
38323
40668
|
};
|
|
38324
40669
|
|
|
@@ -38352,6 +40697,28 @@ export const HistoryApiFactory = function (configuration?: Configuration, basePa
|
|
|
38352
40697
|
getInternalOrderHistoryOnline(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<OrderHistoryResponseDto> {
|
|
38353
40698
|
return localVarFp.getInternalOrderHistoryOnline(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(axios, basePath));
|
|
38354
40699
|
},
|
|
40700
|
+
/**
|
|
40701
|
+
* Online orders carry no employee, so the list needs Transaction::ViewAll. Totals are always included.
|
|
40702
|
+
* @summary Online order history of the token\'s venue
|
|
40703
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
40704
|
+
* @param {string} [start] Start date
|
|
40705
|
+
* @param {string} [end] End date
|
|
40706
|
+
* @param {number} [page] Page number
|
|
40707
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
40708
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
40709
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
40710
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
40711
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
40712
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
40713
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40714
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40715
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
40716
|
+
* @param {*} [options] Override http request option.
|
|
40717
|
+
* @throws {RequiredError}
|
|
40718
|
+
*/
|
|
40719
|
+
getOnlineOrderHistoryV6(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<OrderHistoryResponseDto> {
|
|
40720
|
+
return localVarFp.getOnlineOrderHistoryV6(timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(axios, basePath));
|
|
40721
|
+
},
|
|
38355
40722
|
/**
|
|
38356
40723
|
*
|
|
38357
40724
|
* @summary Get order history
|
|
@@ -38421,6 +40788,28 @@ export const HistoryApiFactory = function (configuration?: Configuration, basePa
|
|
|
38421
40788
|
getOrderHistoryPOSV5Internal(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> {
|
|
38422
40789
|
return localVarFp.getOrderHistoryPOSV5Internal(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(axios, basePath));
|
|
38423
40790
|
},
|
|
40791
|
+
/**
|
|
40792
|
+
* An employee without Transaction::ViewAll receives only their own orders, filtered in the database; the summary is computed from those orders. Fields the token\'s visibility keys do not allow are omitted.
|
|
40793
|
+
* @summary POS order history of the token\'s venue
|
|
40794
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
40795
|
+
* @param {string} [start] Start date
|
|
40796
|
+
* @param {string} [end] End date
|
|
40797
|
+
* @param {number} [page] Page number
|
|
40798
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
40799
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
40800
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
40801
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
40802
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
40803
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
40804
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40805
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40806
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
40807
|
+
* @param {*} [options] Override http request option.
|
|
40808
|
+
* @throws {RequiredError}
|
|
40809
|
+
*/
|
|
40810
|
+
getPosOrderHistoryV6(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<PosOrderHistoryResponseDtoV6> {
|
|
40811
|
+
return localVarFp.getPosOrderHistoryV6(timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(axios, basePath));
|
|
40812
|
+
},
|
|
38424
40813
|
};
|
|
38425
40814
|
};
|
|
38426
40815
|
|
|
@@ -38453,6 +40842,28 @@ export interface HistoryApiInterface {
|
|
|
38453
40842
|
*/
|
|
38454
40843
|
getInternalOrderHistoryOnline(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<OrderHistoryResponseDto>;
|
|
38455
40844
|
|
|
40845
|
+
/**
|
|
40846
|
+
* Online orders carry no employee, so the list needs Transaction::ViewAll. Totals are always included.
|
|
40847
|
+
* @summary Online order history of the token\'s venue
|
|
40848
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
40849
|
+
* @param {string} [start] Start date
|
|
40850
|
+
* @param {string} [end] End date
|
|
40851
|
+
* @param {number} [page] Page number
|
|
40852
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
40853
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
40854
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
40855
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
40856
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
40857
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
40858
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40859
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40860
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
40861
|
+
* @param {*} [options] Override http request option.
|
|
40862
|
+
* @throws {RequiredError}
|
|
40863
|
+
* @memberof HistoryApiInterface
|
|
40864
|
+
*/
|
|
40865
|
+
getOnlineOrderHistoryV6(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<OrderHistoryResponseDto>;
|
|
40866
|
+
|
|
38456
40867
|
/**
|
|
38457
40868
|
*
|
|
38458
40869
|
* @summary Get order history
|
|
@@ -38522,6 +40933,28 @@ export interface HistoryApiInterface {
|
|
|
38522
40933
|
*/
|
|
38523
40934
|
getOrderHistoryPOSV5Internal(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>;
|
|
38524
40935
|
|
|
40936
|
+
/**
|
|
40937
|
+
* An employee without Transaction::ViewAll receives only their own orders, filtered in the database; the summary is computed from those orders. Fields the token\'s visibility keys do not allow are omitted.
|
|
40938
|
+
* @summary POS order history of the token\'s venue
|
|
40939
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
40940
|
+
* @param {string} [start] Start date
|
|
40941
|
+
* @param {string} [end] End date
|
|
40942
|
+
* @param {number} [page] Page number
|
|
40943
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
40944
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
40945
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
40946
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
40947
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
40948
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
40949
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40950
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40951
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
40952
|
+
* @param {*} [options] Override http request option.
|
|
40953
|
+
* @throws {RequiredError}
|
|
40954
|
+
* @memberof HistoryApiInterface
|
|
40955
|
+
*/
|
|
40956
|
+
getPosOrderHistoryV6(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<PosOrderHistoryResponseDtoV6>;
|
|
40957
|
+
|
|
38525
40958
|
}
|
|
38526
40959
|
|
|
38527
40960
|
/**
|
|
@@ -38556,6 +40989,30 @@ export class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
38556
40989
|
return HistoryApiFp(this.configuration).getInternalOrderHistoryOnline(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(this.axios, this.basePath));
|
|
38557
40990
|
}
|
|
38558
40991
|
|
|
40992
|
+
/**
|
|
40993
|
+
* Online orders carry no employee, so the list needs Transaction::ViewAll. Totals are always included.
|
|
40994
|
+
* @summary Online order history of the token\'s venue
|
|
40995
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
40996
|
+
* @param {string} [start] Start date
|
|
40997
|
+
* @param {string} [end] End date
|
|
40998
|
+
* @param {number} [page] Page number
|
|
40999
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
41000
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
41001
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
41002
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
41003
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
41004
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
41005
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
41006
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
41007
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
41008
|
+
* @param {*} [options] Override http request option.
|
|
41009
|
+
* @throws {RequiredError}
|
|
41010
|
+
* @memberof HistoryApi
|
|
41011
|
+
*/
|
|
41012
|
+
public getOnlineOrderHistoryV6(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) {
|
|
41013
|
+
return HistoryApiFp(this.configuration).getOnlineOrderHistoryV6(timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(this.axios, this.basePath));
|
|
41014
|
+
}
|
|
41015
|
+
|
|
38559
41016
|
/**
|
|
38560
41017
|
*
|
|
38561
41018
|
* @summary Get order history
|
|
@@ -38630,6 +41087,30 @@ export class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
38630
41087
|
public getOrderHistoryPOSV5Internal(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) {
|
|
38631
41088
|
return HistoryApiFp(this.configuration).getOrderHistoryPOSV5Internal(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(this.axios, this.basePath));
|
|
38632
41089
|
}
|
|
41090
|
+
|
|
41091
|
+
/**
|
|
41092
|
+
* An employee without Transaction::ViewAll receives only their own orders, filtered in the database; the summary is computed from those orders. Fields the token\'s visibility keys do not allow are omitted.
|
|
41093
|
+
* @summary POS order history of the token\'s venue
|
|
41094
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
41095
|
+
* @param {string} [start] Start date
|
|
41096
|
+
* @param {string} [end] End date
|
|
41097
|
+
* @param {number} [page] Page number
|
|
41098
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
41099
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
41100
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
41101
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
41102
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
41103
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
41104
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
41105
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
41106
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
41107
|
+
* @param {*} [options] Override http request option.
|
|
41108
|
+
* @throws {RequiredError}
|
|
41109
|
+
* @memberof HistoryApi
|
|
41110
|
+
*/
|
|
41111
|
+
public getPosOrderHistoryV6(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) {
|
|
41112
|
+
return HistoryApiFp(this.configuration).getPosOrderHistoryV6(timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(this.axios, this.basePath));
|
|
41113
|
+
}
|
|
38633
41114
|
}
|
|
38634
41115
|
|
|
38635
41116
|
|
|
@@ -40624,6 +43105,54 @@ export const LoyaltyIntegerationsApiAxiosParamCreator = function (configuration?
|
|
|
40624
43105
|
|
|
40625
43106
|
|
|
40626
43107
|
|
|
43108
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43109
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43110
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
43111
|
+
|
|
43112
|
+
return {
|
|
43113
|
+
url: toPathString(localVarUrlObj),
|
|
43114
|
+
options: localVarRequestOptions,
|
|
43115
|
+
};
|
|
43116
|
+
},
|
|
43117
|
+
/**
|
|
43118
|
+
*
|
|
43119
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
43120
|
+
* @param {number} businessId
|
|
43121
|
+
* @param {number} userId
|
|
43122
|
+
* @param {*} [options] Override http request option.
|
|
43123
|
+
* @throws {RequiredError}
|
|
43124
|
+
*/
|
|
43125
|
+
getWalletRewards: async (businessId: number, userId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43126
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
43127
|
+
assertParamExists('getWalletRewards', 'businessId', businessId)
|
|
43128
|
+
// verify required parameter 'userId' is not null or undefined
|
|
43129
|
+
assertParamExists('getWalletRewards', 'userId', userId)
|
|
43130
|
+
const localVarPath = `/api/v1/loyalty/users/wallet-rewards`;
|
|
43131
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43132
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43133
|
+
let baseOptions;
|
|
43134
|
+
if (configuration) {
|
|
43135
|
+
baseOptions = configuration.baseOptions;
|
|
43136
|
+
}
|
|
43137
|
+
|
|
43138
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
43139
|
+
const localVarHeaderParameter = {} as any;
|
|
43140
|
+
const localVarQueryParameter = {} as any;
|
|
43141
|
+
|
|
43142
|
+
// authentication JWT-auth required
|
|
43143
|
+
// http bearer authentication required
|
|
43144
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
43145
|
+
|
|
43146
|
+
if (businessId !== undefined) {
|
|
43147
|
+
localVarQueryParameter['businessId'] = businessId;
|
|
43148
|
+
}
|
|
43149
|
+
|
|
43150
|
+
if (userId !== undefined) {
|
|
43151
|
+
localVarQueryParameter['userId'] = userId;
|
|
43152
|
+
}
|
|
43153
|
+
|
|
43154
|
+
|
|
43155
|
+
|
|
40627
43156
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40628
43157
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40629
43158
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -40975,6 +43504,18 @@ export const LoyaltyIntegerationsApiFp = function(configuration?: Configuration)
|
|
|
40975
43504
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getUserWallet(businessId, userId, options);
|
|
40976
43505
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
40977
43506
|
},
|
|
43507
|
+
/**
|
|
43508
|
+
*
|
|
43509
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
43510
|
+
* @param {number} businessId
|
|
43511
|
+
* @param {number} userId
|
|
43512
|
+
* @param {*} [options] Override http request option.
|
|
43513
|
+
* @throws {RequiredError}
|
|
43514
|
+
*/
|
|
43515
|
+
async getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoyaltyWalletRewardsDto>> {
|
|
43516
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getWalletRewards(businessId, userId, options);
|
|
43517
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
43518
|
+
},
|
|
40978
43519
|
/**
|
|
40979
43520
|
*
|
|
40980
43521
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -41132,6 +43673,17 @@ export const LoyaltyIntegerationsApiFactory = function (configuration?: Configur
|
|
|
41132
43673
|
getUserWallet(businessId: number, userId: number, options?: any): AxiosPromise<UserWalletResponseDto> {
|
|
41133
43674
|
return localVarFp.getUserWallet(businessId, userId, options).then((request) => request(axios, basePath));
|
|
41134
43675
|
},
|
|
43676
|
+
/**
|
|
43677
|
+
*
|
|
43678
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
43679
|
+
* @param {number} businessId
|
|
43680
|
+
* @param {number} userId
|
|
43681
|
+
* @param {*} [options] Override http request option.
|
|
43682
|
+
* @throws {RequiredError}
|
|
43683
|
+
*/
|
|
43684
|
+
getWalletRewards(businessId: number, userId: number, options?: any): AxiosPromise<LoyaltyWalletRewardsDto> {
|
|
43685
|
+
return localVarFp.getWalletRewards(businessId, userId, options).then((request) => request(axios, basePath));
|
|
43686
|
+
},
|
|
41135
43687
|
/**
|
|
41136
43688
|
*
|
|
41137
43689
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -41283,6 +43835,17 @@ export interface LoyaltyIntegerationsApiInterface {
|
|
|
41283
43835
|
*/
|
|
41284
43836
|
getUserWallet(businessId: number, userId: number, options?: AxiosRequestConfig): AxiosPromise<UserWalletResponseDto>;
|
|
41285
43837
|
|
|
43838
|
+
/**
|
|
43839
|
+
*
|
|
43840
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
43841
|
+
* @param {number} businessId
|
|
43842
|
+
* @param {number} userId
|
|
43843
|
+
* @param {*} [options] Override http request option.
|
|
43844
|
+
* @throws {RequiredError}
|
|
43845
|
+
* @memberof LoyaltyIntegerationsApiInterface
|
|
43846
|
+
*/
|
|
43847
|
+
getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig): AxiosPromise<LoyaltyWalletRewardsDto>;
|
|
43848
|
+
|
|
41286
43849
|
/**
|
|
41287
43850
|
*
|
|
41288
43851
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -41450,6 +44013,19 @@ export class LoyaltyIntegerationsApi extends BaseAPI implements LoyaltyIntegerat
|
|
|
41450
44013
|
return LoyaltyIntegerationsApiFp(this.configuration).getUserWallet(businessId, userId, options).then((request) => request(this.axios, this.basePath));
|
|
41451
44014
|
}
|
|
41452
44015
|
|
|
44016
|
+
/**
|
|
44017
|
+
*
|
|
44018
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
44019
|
+
* @param {number} businessId
|
|
44020
|
+
* @param {number} userId
|
|
44021
|
+
* @param {*} [options] Override http request option.
|
|
44022
|
+
* @throws {RequiredError}
|
|
44023
|
+
* @memberof LoyaltyIntegerationsApi
|
|
44024
|
+
*/
|
|
44025
|
+
public getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig) {
|
|
44026
|
+
return LoyaltyIntegerationsApiFp(this.configuration).getWalletRewards(businessId, userId, options).then((request) => request(this.axios, this.basePath));
|
|
44027
|
+
}
|
|
44028
|
+
|
|
41453
44029
|
/**
|
|
41454
44030
|
*
|
|
41455
44031
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -44713,6 +47289,40 @@ export const POSSessionApiAxiosParamCreator = function (configuration?: Configur
|
|
|
44713
47289
|
|
|
44714
47290
|
|
|
44715
47291
|
|
|
47292
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
47293
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
47294
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
47295
|
+
|
|
47296
|
+
return {
|
|
47297
|
+
url: toPathString(localVarUrlObj),
|
|
47298
|
+
options: localVarRequestOptions,
|
|
47299
|
+
};
|
|
47300
|
+
},
|
|
47301
|
+
/**
|
|
47302
|
+
* Reference data for display. PINs are verified server-side (employee-tokens, action-approvals); the scoped token carries the operating mode and the permissions.
|
|
47303
|
+
* @summary The venue\'s employees, roles and passcodes, without PIN hashes
|
|
47304
|
+
* @param {number} businessId
|
|
47305
|
+
* @param {*} [options] Override http request option.
|
|
47306
|
+
* @throws {RequiredError}
|
|
47307
|
+
*/
|
|
47308
|
+
getPosSessionV6: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47309
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
47310
|
+
assertParamExists('getPosSessionV6', 'businessId', businessId)
|
|
47311
|
+
const localVarPath = `/api/v6/pos-session/{businessId}`
|
|
47312
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
47313
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47314
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
47315
|
+
let baseOptions;
|
|
47316
|
+
if (configuration) {
|
|
47317
|
+
baseOptions = configuration.baseOptions;
|
|
47318
|
+
}
|
|
47319
|
+
|
|
47320
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
47321
|
+
const localVarHeaderParameter = {} as any;
|
|
47322
|
+
const localVarQueryParameter = {} as any;
|
|
47323
|
+
|
|
47324
|
+
|
|
47325
|
+
|
|
44716
47326
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
44717
47327
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
44718
47328
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -44753,6 +47363,17 @@ export const POSSessionApiFp = function(configuration?: Configuration) {
|
|
|
44753
47363
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPosSessionV2(businessId, options);
|
|
44754
47364
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
44755
47365
|
},
|
|
47366
|
+
/**
|
|
47367
|
+
* Reference data for display. PINs are verified server-side (employee-tokens, action-approvals); the scoped token carries the operating mode and the permissions.
|
|
47368
|
+
* @summary The venue\'s employees, roles and passcodes, without PIN hashes
|
|
47369
|
+
* @param {number} businessId
|
|
47370
|
+
* @param {*} [options] Override http request option.
|
|
47371
|
+
* @throws {RequiredError}
|
|
47372
|
+
*/
|
|
47373
|
+
async getPosSessionV6(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosSessionResponseDtoV6>> {
|
|
47374
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPosSessionV6(businessId, options);
|
|
47375
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
47376
|
+
},
|
|
44756
47377
|
}
|
|
44757
47378
|
};
|
|
44758
47379
|
|
|
@@ -44782,6 +47403,16 @@ export const POSSessionApiFactory = function (configuration?: Configuration, bas
|
|
|
44782
47403
|
getPosSessionV2(businessId: number, options?: any): AxiosPromise<PosSessionResponseDto> {
|
|
44783
47404
|
return localVarFp.getPosSessionV2(businessId, options).then((request) => request(axios, basePath));
|
|
44784
47405
|
},
|
|
47406
|
+
/**
|
|
47407
|
+
* Reference data for display. PINs are verified server-side (employee-tokens, action-approvals); the scoped token carries the operating mode and the permissions.
|
|
47408
|
+
* @summary The venue\'s employees, roles and passcodes, without PIN hashes
|
|
47409
|
+
* @param {number} businessId
|
|
47410
|
+
* @param {*} [options] Override http request option.
|
|
47411
|
+
* @throws {RequiredError}
|
|
47412
|
+
*/
|
|
47413
|
+
getPosSessionV6(businessId: number, options?: any): AxiosPromise<PosSessionResponseDtoV6> {
|
|
47414
|
+
return localVarFp.getPosSessionV6(businessId, options).then((request) => request(axios, basePath));
|
|
47415
|
+
},
|
|
44785
47416
|
};
|
|
44786
47417
|
};
|
|
44787
47418
|
|
|
@@ -44810,6 +47441,16 @@ export interface POSSessionApiInterface {
|
|
|
44810
47441
|
*/
|
|
44811
47442
|
getPosSessionV2(businessId: number, options?: AxiosRequestConfig): AxiosPromise<PosSessionResponseDto>;
|
|
44812
47443
|
|
|
47444
|
+
/**
|
|
47445
|
+
* Reference data for display. PINs are verified server-side (employee-tokens, action-approvals); the scoped token carries the operating mode and the permissions.
|
|
47446
|
+
* @summary The venue\'s employees, roles and passcodes, without PIN hashes
|
|
47447
|
+
* @param {number} businessId
|
|
47448
|
+
* @param {*} [options] Override http request option.
|
|
47449
|
+
* @throws {RequiredError}
|
|
47450
|
+
* @memberof POSSessionApiInterface
|
|
47451
|
+
*/
|
|
47452
|
+
getPosSessionV6(businessId: number, options?: AxiosRequestConfig): AxiosPromise<PosSessionResponseDtoV6>;
|
|
47453
|
+
|
|
44813
47454
|
}
|
|
44814
47455
|
|
|
44815
47456
|
/**
|
|
@@ -44841,6 +47482,18 @@ export class POSSessionApi extends BaseAPI implements POSSessionApiInterface {
|
|
|
44841
47482
|
public getPosSessionV2(businessId: number, options?: AxiosRequestConfig) {
|
|
44842
47483
|
return POSSessionApiFp(this.configuration).getPosSessionV2(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
44843
47484
|
}
|
|
47485
|
+
|
|
47486
|
+
/**
|
|
47487
|
+
* Reference data for display. PINs are verified server-side (employee-tokens, action-approvals); the scoped token carries the operating mode and the permissions.
|
|
47488
|
+
* @summary The venue\'s employees, roles and passcodes, without PIN hashes
|
|
47489
|
+
* @param {number} businessId
|
|
47490
|
+
* @param {*} [options] Override http request option.
|
|
47491
|
+
* @throws {RequiredError}
|
|
47492
|
+
* @memberof POSSessionApi
|
|
47493
|
+
*/
|
|
47494
|
+
public getPosSessionV6(businessId: number, options?: AxiosRequestConfig) {
|
|
47495
|
+
return POSSessionApiFp(this.configuration).getPosSessionV6(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
47496
|
+
}
|
|
44844
47497
|
}
|
|
44845
47498
|
|
|
44846
47499
|
|
|
@@ -52637,6 +55290,56 @@ export const ReportApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
52637
55290
|
|
|
52638
55291
|
|
|
52639
55292
|
|
|
55293
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
55294
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
55295
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
55296
|
+
|
|
55297
|
+
return {
|
|
55298
|
+
url: toPathString(localVarUrlObj),
|
|
55299
|
+
options: localVarRequestOptions,
|
|
55300
|
+
};
|
|
55301
|
+
},
|
|
55302
|
+
/**
|
|
55303
|
+
* An employee without Report::ViewAll receives a report of their own orders only, filtered in the database before aggregation. Sections and totals the token\'s visibility keys do not allow are omitted.
|
|
55304
|
+
* @summary End-of-day POS report of the token\'s venue
|
|
55305
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
55306
|
+
* @param {string} [start] Start date
|
|
55307
|
+
* @param {string} [end] End date
|
|
55308
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
55309
|
+
* @param {*} [options] Override http request option.
|
|
55310
|
+
* @throws {RequiredError}
|
|
55311
|
+
*/
|
|
55312
|
+
getEndOfDayReportV6: async (timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
55313
|
+
const localVarPath = `/api/v6/report/end-of-day`;
|
|
55314
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
55315
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
55316
|
+
let baseOptions;
|
|
55317
|
+
if (configuration) {
|
|
55318
|
+
baseOptions = configuration.baseOptions;
|
|
55319
|
+
}
|
|
55320
|
+
|
|
55321
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
55322
|
+
const localVarHeaderParameter = {} as any;
|
|
55323
|
+
const localVarQueryParameter = {} as any;
|
|
55324
|
+
|
|
55325
|
+
if (timeSpan !== undefined) {
|
|
55326
|
+
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
55327
|
+
}
|
|
55328
|
+
|
|
55329
|
+
if (start !== undefined) {
|
|
55330
|
+
localVarQueryParameter['start'] = start;
|
|
55331
|
+
}
|
|
55332
|
+
|
|
55333
|
+
if (end !== undefined) {
|
|
55334
|
+
localVarQueryParameter['end'] = end;
|
|
55335
|
+
}
|
|
55336
|
+
|
|
55337
|
+
if (timezone !== undefined) {
|
|
55338
|
+
localVarQueryParameter['timezone'] = timezone;
|
|
55339
|
+
}
|
|
55340
|
+
|
|
55341
|
+
|
|
55342
|
+
|
|
52640
55343
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
52641
55344
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
52642
55345
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -52826,6 +55529,62 @@ export const ReportApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
52826
55529
|
|
|
52827
55530
|
|
|
52828
55531
|
|
|
55532
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
55533
|
+
|
|
55534
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
55535
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
55536
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
55537
|
+
localVarRequestOptions.data = serializeDataIfNeeded(sendReportEmailDto, localVarRequestOptions, configuration)
|
|
55538
|
+
|
|
55539
|
+
return {
|
|
55540
|
+
url: toPathString(localVarUrlObj),
|
|
55541
|
+
options: localVarRequestOptions,
|
|
55542
|
+
};
|
|
55543
|
+
},
|
|
55544
|
+
/**
|
|
55545
|
+
* Sends the report exactly as the caller may see it: their own orders without Report::ViewAll, and only the sections and totals their keys allow. Cash movements are attached only with Report::ViewCashLogs. Also requires Page::Reports.
|
|
55546
|
+
* @summary Email the end-of-day report of the token\'s venue
|
|
55547
|
+
* @param {SendReportEmailDto} sendReportEmailDto
|
|
55548
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
55549
|
+
* @param {string} [start] Start date
|
|
55550
|
+
* @param {string} [end] End date
|
|
55551
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
55552
|
+
* @param {*} [options] Override http request option.
|
|
55553
|
+
* @throws {RequiredError}
|
|
55554
|
+
*/
|
|
55555
|
+
sendReportEmailV6: async (sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
55556
|
+
// verify required parameter 'sendReportEmailDto' is not null or undefined
|
|
55557
|
+
assertParamExists('sendReportEmailV6', 'sendReportEmailDto', sendReportEmailDto)
|
|
55558
|
+
const localVarPath = `/api/v6/report/email`;
|
|
55559
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
55560
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
55561
|
+
let baseOptions;
|
|
55562
|
+
if (configuration) {
|
|
55563
|
+
baseOptions = configuration.baseOptions;
|
|
55564
|
+
}
|
|
55565
|
+
|
|
55566
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
55567
|
+
const localVarHeaderParameter = {} as any;
|
|
55568
|
+
const localVarQueryParameter = {} as any;
|
|
55569
|
+
|
|
55570
|
+
if (timeSpan !== undefined) {
|
|
55571
|
+
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
55572
|
+
}
|
|
55573
|
+
|
|
55574
|
+
if (start !== undefined) {
|
|
55575
|
+
localVarQueryParameter['start'] = start;
|
|
55576
|
+
}
|
|
55577
|
+
|
|
55578
|
+
if (end !== undefined) {
|
|
55579
|
+
localVarQueryParameter['end'] = end;
|
|
55580
|
+
}
|
|
55581
|
+
|
|
55582
|
+
if (timezone !== undefined) {
|
|
55583
|
+
localVarQueryParameter['timezone'] = timezone;
|
|
55584
|
+
}
|
|
55585
|
+
|
|
55586
|
+
|
|
55587
|
+
|
|
52829
55588
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
52830
55589
|
|
|
52831
55590
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -52864,6 +55623,20 @@ export const ReportApiFp = function(configuration?: Configuration) {
|
|
|
52864
55623
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options);
|
|
52865
55624
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
52866
55625
|
},
|
|
55626
|
+
/**
|
|
55627
|
+
* An employee without Report::ViewAll receives a report of their own orders only, filtered in the database before aggregation. Sections and totals the token\'s visibility keys do not allow are omitted.
|
|
55628
|
+
* @summary End-of-day POS report of the token\'s venue
|
|
55629
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
55630
|
+
* @param {string} [start] Start date
|
|
55631
|
+
* @param {string} [end] End date
|
|
55632
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
55633
|
+
* @param {*} [options] Override http request option.
|
|
55634
|
+
* @throws {RequiredError}
|
|
55635
|
+
*/
|
|
55636
|
+
async getEndOfDayReportV6(timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndOfDayReportResponseDtoV6>> {
|
|
55637
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getEndOfDayReportV6(timeSpan, start, end, timezone, options);
|
|
55638
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
55639
|
+
},
|
|
52867
55640
|
/**
|
|
52868
55641
|
*
|
|
52869
55642
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -52912,6 +55685,21 @@ export const ReportApiFp = function(configuration?: Configuration) {
|
|
|
52912
55685
|
const localVarAxiosArgs = await localVarAxiosParamCreator.sendReportEmailV5(businessIds, timezone, sendReportEmailDto, timeSpan, start, end, provider, options);
|
|
52913
55686
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
52914
55687
|
},
|
|
55688
|
+
/**
|
|
55689
|
+
* Sends the report exactly as the caller may see it: their own orders without Report::ViewAll, and only the sections and totals their keys allow. Cash movements are attached only with Report::ViewCashLogs. Also requires Page::Reports.
|
|
55690
|
+
* @summary Email the end-of-day report of the token\'s venue
|
|
55691
|
+
* @param {SendReportEmailDto} sendReportEmailDto
|
|
55692
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
55693
|
+
* @param {string} [start] Start date
|
|
55694
|
+
* @param {string} [end] End date
|
|
55695
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
55696
|
+
* @param {*} [options] Override http request option.
|
|
55697
|
+
* @throws {RequiredError}
|
|
55698
|
+
*/
|
|
55699
|
+
async sendReportEmailV6(sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportEmailResponseDtoV6>> {
|
|
55700
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.sendReportEmailV6(sendReportEmailDto, timeSpan, start, end, timezone, options);
|
|
55701
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
55702
|
+
},
|
|
52915
55703
|
}
|
|
52916
55704
|
};
|
|
52917
55705
|
|
|
@@ -52937,6 +55725,19 @@ export const ReportApiFactory = function (configuration?: Configuration, basePat
|
|
|
52937
55725
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: any): AxiosPromise<EndOfDayReportDtoV4> {
|
|
52938
55726
|
return localVarFp.getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options).then((request) => request(axios, basePath));
|
|
52939
55727
|
},
|
|
55728
|
+
/**
|
|
55729
|
+
* An employee without Report::ViewAll receives a report of their own orders only, filtered in the database before aggregation. Sections and totals the token\'s visibility keys do not allow are omitted.
|
|
55730
|
+
* @summary End-of-day POS report of the token\'s venue
|
|
55731
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
55732
|
+
* @param {string} [start] Start date
|
|
55733
|
+
* @param {string} [end] End date
|
|
55734
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
55735
|
+
* @param {*} [options] Override http request option.
|
|
55736
|
+
* @throws {RequiredError}
|
|
55737
|
+
*/
|
|
55738
|
+
getEndOfDayReportV6(timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: any): AxiosPromise<EndOfDayReportResponseDtoV6> {
|
|
55739
|
+
return localVarFp.getEndOfDayReportV6(timeSpan, start, end, timezone, options).then((request) => request(axios, basePath));
|
|
55740
|
+
},
|
|
52940
55741
|
/**
|
|
52941
55742
|
*
|
|
52942
55743
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -52982,6 +55783,20 @@ export const ReportApiFactory = function (configuration?: Configuration, basePat
|
|
|
52982
55783
|
sendReportEmailV5(businessIds: Array<number>, timezone: string, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, provider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: any): AxiosPromise<void> {
|
|
52983
55784
|
return localVarFp.sendReportEmailV5(businessIds, timezone, sendReportEmailDto, timeSpan, start, end, provider, options).then((request) => request(axios, basePath));
|
|
52984
55785
|
},
|
|
55786
|
+
/**
|
|
55787
|
+
* Sends the report exactly as the caller may see it: their own orders without Report::ViewAll, and only the sections and totals their keys allow. Cash movements are attached only with Report::ViewCashLogs. Also requires Page::Reports.
|
|
55788
|
+
* @summary Email the end-of-day report of the token\'s venue
|
|
55789
|
+
* @param {SendReportEmailDto} sendReportEmailDto
|
|
55790
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
55791
|
+
* @param {string} [start] Start date
|
|
55792
|
+
* @param {string} [end] End date
|
|
55793
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
55794
|
+
* @param {*} [options] Override http request option.
|
|
55795
|
+
* @throws {RequiredError}
|
|
55796
|
+
*/
|
|
55797
|
+
sendReportEmailV6(sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: any): AxiosPromise<ReportEmailResponseDtoV6> {
|
|
55798
|
+
return localVarFp.sendReportEmailV6(sendReportEmailDto, timeSpan, start, end, timezone, options).then((request) => request(axios, basePath));
|
|
55799
|
+
},
|
|
52985
55800
|
};
|
|
52986
55801
|
};
|
|
52987
55802
|
|
|
@@ -53006,6 +55821,19 @@ export interface ReportApiInterface {
|
|
|
53006
55821
|
*/
|
|
53007
55822
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportDtoV4>;
|
|
53008
55823
|
|
|
55824
|
+
/**
|
|
55825
|
+
* An employee without Report::ViewAll receives a report of their own orders only, filtered in the database before aggregation. Sections and totals the token\'s visibility keys do not allow are omitted.
|
|
55826
|
+
* @summary End-of-day POS report of the token\'s venue
|
|
55827
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
55828
|
+
* @param {string} [start] Start date
|
|
55829
|
+
* @param {string} [end] End date
|
|
55830
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
55831
|
+
* @param {*} [options] Override http request option.
|
|
55832
|
+
* @throws {RequiredError}
|
|
55833
|
+
* @memberof ReportApiInterface
|
|
55834
|
+
*/
|
|
55835
|
+
getEndOfDayReportV6(timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportResponseDtoV6>;
|
|
55836
|
+
|
|
53009
55837
|
/**
|
|
53010
55838
|
*
|
|
53011
55839
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -53051,6 +55879,20 @@ export interface ReportApiInterface {
|
|
|
53051
55879
|
*/
|
|
53052
55880
|
sendReportEmailV5(businessIds: Array<number>, timezone: string, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, provider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
53053
55881
|
|
|
55882
|
+
/**
|
|
55883
|
+
* Sends the report exactly as the caller may see it: their own orders without Report::ViewAll, and only the sections and totals their keys allow. Cash movements are attached only with Report::ViewCashLogs. Also requires Page::Reports.
|
|
55884
|
+
* @summary Email the end-of-day report of the token\'s venue
|
|
55885
|
+
* @param {SendReportEmailDto} sendReportEmailDto
|
|
55886
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
55887
|
+
* @param {string} [start] Start date
|
|
55888
|
+
* @param {string} [end] End date
|
|
55889
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
55890
|
+
* @param {*} [options] Override http request option.
|
|
55891
|
+
* @throws {RequiredError}
|
|
55892
|
+
* @memberof ReportApiInterface
|
|
55893
|
+
*/
|
|
55894
|
+
sendReportEmailV6(sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<ReportEmailResponseDtoV6>;
|
|
55895
|
+
|
|
53054
55896
|
}
|
|
53055
55897
|
|
|
53056
55898
|
/**
|
|
@@ -53077,6 +55919,21 @@ export class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
53077
55919
|
return ReportApiFp(this.configuration).getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options).then((request) => request(this.axios, this.basePath));
|
|
53078
55920
|
}
|
|
53079
55921
|
|
|
55922
|
+
/**
|
|
55923
|
+
* An employee without Report::ViewAll receives a report of their own orders only, filtered in the database before aggregation. Sections and totals the token\'s visibility keys do not allow are omitted.
|
|
55924
|
+
* @summary End-of-day POS report of the token\'s venue
|
|
55925
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
55926
|
+
* @param {string} [start] Start date
|
|
55927
|
+
* @param {string} [end] End date
|
|
55928
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
55929
|
+
* @param {*} [options] Override http request option.
|
|
55930
|
+
* @throws {RequiredError}
|
|
55931
|
+
* @memberof ReportApi
|
|
55932
|
+
*/
|
|
55933
|
+
public getEndOfDayReportV6(timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig) {
|
|
55934
|
+
return ReportApiFp(this.configuration).getEndOfDayReportV6(timeSpan, start, end, timezone, options).then((request) => request(this.axios, this.basePath));
|
|
55935
|
+
}
|
|
55936
|
+
|
|
53080
55937
|
/**
|
|
53081
55938
|
*
|
|
53082
55939
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -53127,6 +55984,22 @@ export class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
53127
55984
|
public sendReportEmailV5(businessIds: Array<number>, timezone: string, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, provider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', options?: AxiosRequestConfig) {
|
|
53128
55985
|
return ReportApiFp(this.configuration).sendReportEmailV5(businessIds, timezone, sendReportEmailDto, timeSpan, start, end, provider, options).then((request) => request(this.axios, this.basePath));
|
|
53129
55986
|
}
|
|
55987
|
+
|
|
55988
|
+
/**
|
|
55989
|
+
* Sends the report exactly as the caller may see it: their own orders without Report::ViewAll, and only the sections and totals their keys allow. Cash movements are attached only with Report::ViewCashLogs. Also requires Page::Reports.
|
|
55990
|
+
* @summary Email the end-of-day report of the token\'s venue
|
|
55991
|
+
* @param {SendReportEmailDto} sendReportEmailDto
|
|
55992
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
55993
|
+
* @param {string} [start] Start date
|
|
55994
|
+
* @param {string} [end] End date
|
|
55995
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
55996
|
+
* @param {*} [options] Override http request option.
|
|
55997
|
+
* @throws {RequiredError}
|
|
55998
|
+
* @memberof ReportApi
|
|
55999
|
+
*/
|
|
56000
|
+
public sendReportEmailV6(sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig) {
|
|
56001
|
+
return ReportApiFp(this.configuration).sendReportEmailV6(sendReportEmailDto, timeSpan, start, end, timezone, options).then((request) => request(this.axios, this.basePath));
|
|
56002
|
+
}
|
|
53130
56003
|
}
|
|
53131
56004
|
|
|
53132
56005
|
|