@munchi_oy/core 1.9.132 → 1.9.134
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 +326 -2093
- 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 +678 -2834
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -99,7 +99,6 @@ export const EntityTypeEnum = {
|
|
|
99
99
|
Role: 'role',
|
|
100
100
|
Shift: 'shift',
|
|
101
101
|
Employee: 'employee',
|
|
102
|
-
ActionPasscode: 'action_passcode',
|
|
103
102
|
Config: 'config',
|
|
104
103
|
Business: 'business',
|
|
105
104
|
Suboption: 'suboption',
|
|
@@ -144,15 +143,21 @@ export interface AcceptOrderDto {
|
|
|
144
143
|
/**
|
|
145
144
|
*
|
|
146
145
|
* @export
|
|
147
|
-
* @interface
|
|
146
|
+
* @interface ActionPasscodeCheckResponseDto
|
|
148
147
|
*/
|
|
149
|
-
export interface
|
|
148
|
+
export interface ActionPasscodeCheckResponseDto {
|
|
150
149
|
/**
|
|
151
|
-
*
|
|
150
|
+
* The passcode that approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again.
|
|
152
151
|
* @type {string}
|
|
153
|
-
* @memberof
|
|
152
|
+
* @memberof ActionPasscodeCheckResponseDto
|
|
154
153
|
*/
|
|
155
|
-
'
|
|
154
|
+
'passcodeId': string;
|
|
155
|
+
/**
|
|
156
|
+
* The passcode\'s name, as the merchant set it
|
|
157
|
+
* @type {string}
|
|
158
|
+
* @memberof ActionPasscodeCheckResponseDto
|
|
159
|
+
*/
|
|
160
|
+
'name': string;
|
|
156
161
|
}
|
|
157
162
|
/**
|
|
158
163
|
*
|
|
@@ -241,20 +246,6 @@ export interface ActivateKioskOfferDto {
|
|
|
241
246
|
*/
|
|
242
247
|
'catalogId': number;
|
|
243
248
|
}
|
|
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
|
-
|
|
258
249
|
/**
|
|
259
250
|
*
|
|
260
251
|
* @export
|
|
@@ -498,20 +489,6 @@ export interface AmountDto {
|
|
|
498
489
|
*/
|
|
499
490
|
'currency': string;
|
|
500
491
|
}
|
|
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
|
-
|
|
515
492
|
/**
|
|
516
493
|
*
|
|
517
494
|
* @export
|
|
@@ -2547,104 +2524,6 @@ export interface CatalogMethodDtoCapabilities {
|
|
|
2547
2524
|
}
|
|
2548
2525
|
|
|
2549
2526
|
|
|
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
|
-
|
|
2648
2527
|
/**
|
|
2649
2528
|
*
|
|
2650
2529
|
* @export
|
|
@@ -2981,6 +2860,21 @@ export interface ChargeStatusResponseDto {
|
|
|
2981
2860
|
}
|
|
2982
2861
|
|
|
2983
2862
|
|
|
2863
|
+
/**
|
|
2864
|
+
*
|
|
2865
|
+
* @export
|
|
2866
|
+
* @interface CheckActionPasscodeDto
|
|
2867
|
+
*/
|
|
2868
|
+
export interface CheckActionPasscodeDto {
|
|
2869
|
+
/**
|
|
2870
|
+
*
|
|
2871
|
+
* @type {PosPermission}
|
|
2872
|
+
* @memberof CheckActionPasscodeDto
|
|
2873
|
+
*/
|
|
2874
|
+
'key': PosPermission;
|
|
2875
|
+
}
|
|
2876
|
+
|
|
2877
|
+
|
|
2984
2878
|
/**
|
|
2985
2879
|
*
|
|
2986
2880
|
* @export
|
|
@@ -6004,183 +5898,6 @@ export interface EndOfDayReportDtoV4TaxBreakdown {
|
|
|
6004
5898
|
*/
|
|
6005
5899
|
'totalTaxAmount': number;
|
|
6006
5900
|
}
|
|
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
|
-
}
|
|
6184
5901
|
/**
|
|
6185
5902
|
*
|
|
6186
5903
|
* @export
|
|
@@ -6196,7 +5913,6 @@ export const EntityType = {
|
|
|
6196
5913
|
Role: 'role',
|
|
6197
5914
|
Shift: 'shift',
|
|
6198
5915
|
Employee: 'employee',
|
|
6199
|
-
ActionPasscode: 'action_passcode',
|
|
6200
5916
|
Config: 'config',
|
|
6201
5917
|
Business: 'business',
|
|
6202
5918
|
Suboption: 'suboption',
|
|
@@ -7925,59 +7641,6 @@ export interface InvoiceCompanyResponseDto {
|
|
|
7925
7641
|
*/
|
|
7926
7642
|
'updatedAt': string;
|
|
7927
7643
|
}
|
|
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
|
-
}
|
|
7981
7644
|
/**
|
|
7982
7645
|
*
|
|
7983
7646
|
* @export
|
|
@@ -8132,98 +7795,6 @@ export interface ItemPriceDto {
|
|
|
8132
7795
|
*/
|
|
8133
7796
|
'priceBreakdown': ItemPriceBreakdownDto;
|
|
8134
7797
|
}
|
|
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
|
-
}
|
|
8227
7798
|
/**
|
|
8228
7799
|
*
|
|
8229
7800
|
* @export
|
|
@@ -9882,7 +9453,7 @@ export interface LoginResponseDtoUserInfo {
|
|
|
9882
9453
|
*/
|
|
9883
9454
|
export interface LogoutResponseDto {
|
|
9884
9455
|
/**
|
|
9885
|
-
*
|
|
9456
|
+
* Confirmation that the session was deleted; the tokens of that session stop working
|
|
9886
9457
|
* @type {string}
|
|
9887
9458
|
* @memberof LogoutResponseDto
|
|
9888
9459
|
*/
|
|
@@ -16814,125 +16385,6 @@ export interface PermissionDto {
|
|
|
16814
16385
|
*/
|
|
16815
16386
|
'enabled': boolean;
|
|
16816
16387
|
}
|
|
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
|
-
|
|
16936
16388
|
/**
|
|
16937
16389
|
*
|
|
16938
16390
|
* @export
|
|
@@ -16952,33 +16404,6 @@ export interface PermissionRuleDto {
|
|
|
16952
16404
|
*/
|
|
16953
16405
|
'enabled': boolean;
|
|
16954
16406
|
}
|
|
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
|
-
|
|
16982
16407
|
/**
|
|
16983
16408
|
*
|
|
16984
16409
|
* @export
|
|
@@ -17134,31 +16559,6 @@ export interface PosActionPasscodeDto {
|
|
|
17134
16559
|
*/
|
|
17135
16560
|
'pinHash': string;
|
|
17136
16561
|
}
|
|
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
|
-
}
|
|
17162
16562
|
/**
|
|
17163
16563
|
*
|
|
17164
16564
|
* @export
|
|
@@ -17456,39 +16856,6 @@ export interface PosEmployeeDto {
|
|
|
17456
16856
|
}
|
|
17457
16857
|
|
|
17458
16858
|
|
|
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
|
-
|
|
17492
16859
|
/**
|
|
17493
16860
|
*
|
|
17494
16861
|
* @export
|
|
@@ -18800,261 +18167,6 @@ export interface PosOrderDtoTaxSummary {
|
|
|
18800
18167
|
*/
|
|
18801
18168
|
'grandTotal': number;
|
|
18802
18169
|
}
|
|
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
|
-
|
|
19058
18170
|
/**
|
|
19059
18171
|
*
|
|
19060
18172
|
* @export
|
|
@@ -19142,68 +18254,6 @@ export interface PosOrderEqualSplitStateDto {
|
|
|
19142
18254
|
*/
|
|
19143
18255
|
'parts': Array<PosOrderEqualSplitPartDto>;
|
|
19144
18256
|
}
|
|
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
|
-
}
|
|
19207
18257
|
/**
|
|
19208
18258
|
*
|
|
19209
18259
|
* @export
|
|
@@ -19400,159 +18450,6 @@ export interface PosOrderItemDtoReportingCategory {
|
|
|
19400
18450
|
*/
|
|
19401
18451
|
'updated_at': string;
|
|
19402
18452
|
}
|
|
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
|
-
|
|
19556
18453
|
/**
|
|
19557
18454
|
*
|
|
19558
18455
|
* @export
|
|
@@ -19981,56 +18878,6 @@ export interface PosOrderPriceDto {
|
|
|
19981
18878
|
*/
|
|
19982
18879
|
'total': MoneyDto;
|
|
19983
18880
|
}
|
|
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
|
-
}
|
|
20034
18881
|
/**
|
|
20035
18882
|
*
|
|
20036
18883
|
* @export
|
|
@@ -20086,43 +18933,6 @@ export interface PosOrderSuboptionDto {
|
|
|
20086
18933
|
*/
|
|
20087
18934
|
'value_pos_id': string | null;
|
|
20088
18935
|
}
|
|
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
|
-
}
|
|
20126
18936
|
/**
|
|
20127
18937
|
*
|
|
20128
18938
|
* @export
|
|
@@ -20261,52 +19071,140 @@ export type PosPermission = typeof PosPermission[keyof typeof PosPermission];
|
|
|
20261
19071
|
/**
|
|
20262
19072
|
*
|
|
20263
19073
|
* @export
|
|
20264
|
-
* @interface
|
|
19074
|
+
* @interface PosPermissionCatalogResponseDto
|
|
20265
19075
|
*/
|
|
20266
|
-
export interface
|
|
19076
|
+
export interface PosPermissionCatalogResponseDto {
|
|
19077
|
+
/**
|
|
19078
|
+
* Every POS key the server knows, grouped as the POS groups them
|
|
19079
|
+
* @type {Array<PosPermissionGroupDto>}
|
|
19080
|
+
* @memberof PosPermissionCatalogResponseDto
|
|
19081
|
+
*/
|
|
19082
|
+
'groups': Array<PosPermissionGroupDto>;
|
|
19083
|
+
}
|
|
19084
|
+
/**
|
|
19085
|
+
*
|
|
19086
|
+
* @export
|
|
19087
|
+
* @interface PosPermissionDetailDto
|
|
19088
|
+
*/
|
|
19089
|
+
export interface PosPermissionDetailDto {
|
|
20267
19090
|
/**
|
|
20268
19091
|
*
|
|
19092
|
+
* @type {PosPermission}
|
|
19093
|
+
* @memberof PosPermissionDetailDto
|
|
19094
|
+
*/
|
|
19095
|
+
'key': PosPermission;
|
|
19096
|
+
/**
|
|
19097
|
+
* The key\'s name, as the merchant sees it beside its checkbox
|
|
20269
19098
|
* @type {string}
|
|
20270
|
-
* @memberof
|
|
19099
|
+
* @memberof PosPermissionDetailDto
|
|
20271
19100
|
*/
|
|
20272
|
-
'
|
|
19101
|
+
'label': string;
|
|
19102
|
+
/**
|
|
19103
|
+
*
|
|
19104
|
+
* @type {PosPermissionKind}
|
|
19105
|
+
* @memberof PosPermissionDetailDto
|
|
19106
|
+
*/
|
|
19107
|
+
'kind': PosPermissionKind;
|
|
19108
|
+
}
|
|
19109
|
+
|
|
19110
|
+
|
|
19111
|
+
/**
|
|
19112
|
+
*
|
|
19113
|
+
* @export
|
|
19114
|
+
* @enum {string}
|
|
19115
|
+
*/
|
|
19116
|
+
|
|
19117
|
+
export const PosPermissionGroup = {
|
|
19118
|
+
Access: 'Access',
|
|
19119
|
+
Page: 'Page',
|
|
19120
|
+
Cart: 'Cart',
|
|
19121
|
+
Cash: 'Cash',
|
|
19122
|
+
Transaction: 'Transaction',
|
|
19123
|
+
TransactionTotals: 'TransactionTotals',
|
|
19124
|
+
Order: 'Order',
|
|
19125
|
+
OpenOrders: 'OpenOrders',
|
|
19126
|
+
Shift: 'Shift',
|
|
19127
|
+
FloorPlan: 'FloorPlan',
|
|
19128
|
+
Settings: 'Settings',
|
|
19129
|
+
Report: 'Report',
|
|
19130
|
+
ReportTotals: 'ReportTotals'
|
|
19131
|
+
} as const;
|
|
19132
|
+
|
|
19133
|
+
export type PosPermissionGroup = typeof PosPermissionGroup[keyof typeof PosPermissionGroup];
|
|
19134
|
+
|
|
19135
|
+
|
|
19136
|
+
/**
|
|
19137
|
+
*
|
|
19138
|
+
* @export
|
|
19139
|
+
* @interface PosPermissionGroupDto
|
|
19140
|
+
*/
|
|
19141
|
+
export interface PosPermissionGroupDto {
|
|
20273
19142
|
/**
|
|
20274
19143
|
*
|
|
19144
|
+
* @type {PosPermissionGroup}
|
|
19145
|
+
* @memberof PosPermissionGroupDto
|
|
19146
|
+
*/
|
|
19147
|
+
'group': PosPermissionGroup;
|
|
19148
|
+
/**
|
|
19149
|
+
* The group\'s name, as the merchant sees it
|
|
20275
19150
|
* @type {string}
|
|
20276
|
-
* @memberof
|
|
19151
|
+
* @memberof PosPermissionGroupDto
|
|
20277
19152
|
*/
|
|
20278
|
-
'
|
|
19153
|
+
'label': string;
|
|
20279
19154
|
/**
|
|
20280
19155
|
*
|
|
20281
|
-
* @type {
|
|
20282
|
-
* @memberof
|
|
19156
|
+
* @type {PosPermission}
|
|
19157
|
+
* @memberof PosPermissionGroupDto
|
|
20283
19158
|
*/
|
|
20284
|
-
'
|
|
19159
|
+
'wildcardKey'?: PosPermission;
|
|
19160
|
+
/**
|
|
19161
|
+
* The group\'s keys, in the order the POS lists them, without the wildcard key
|
|
19162
|
+
* @type {Array<PosPermissionDetailDto>}
|
|
19163
|
+
* @memberof PosPermissionGroupDto
|
|
19164
|
+
*/
|
|
19165
|
+
'permissions': Array<PosPermissionDetailDto>;
|
|
20285
19166
|
}
|
|
19167
|
+
|
|
19168
|
+
|
|
19169
|
+
/**
|
|
19170
|
+
*
|
|
19171
|
+
* @export
|
|
19172
|
+
* @enum {string}
|
|
19173
|
+
*/
|
|
19174
|
+
|
|
19175
|
+
export const PosPermissionKind = {
|
|
19176
|
+
Screen: 'screen',
|
|
19177
|
+
Action: 'action',
|
|
19178
|
+
Visibility: 'visibility'
|
|
19179
|
+
} as const;
|
|
19180
|
+
|
|
19181
|
+
export type PosPermissionKind = typeof PosPermissionKind[keyof typeof PosPermissionKind];
|
|
19182
|
+
|
|
19183
|
+
|
|
20286
19184
|
/**
|
|
20287
19185
|
*
|
|
20288
19186
|
* @export
|
|
20289
|
-
* @interface
|
|
19187
|
+
* @interface PosRoleDto
|
|
20290
19188
|
*/
|
|
20291
|
-
export interface
|
|
19189
|
+
export interface PosRoleDto {
|
|
20292
19190
|
/**
|
|
20293
19191
|
*
|
|
20294
19192
|
* @type {string}
|
|
20295
|
-
* @memberof
|
|
19193
|
+
* @memberof PosRoleDto
|
|
20296
19194
|
*/
|
|
20297
19195
|
'id': string;
|
|
20298
19196
|
/**
|
|
20299
19197
|
*
|
|
20300
19198
|
* @type {string}
|
|
20301
|
-
* @memberof
|
|
19199
|
+
* @memberof PosRoleDto
|
|
20302
19200
|
*/
|
|
20303
19201
|
'name': string;
|
|
20304
19202
|
/**
|
|
20305
19203
|
*
|
|
20306
|
-
* @type {Array<
|
|
20307
|
-
* @memberof
|
|
19204
|
+
* @type {Array<PermissionRuleResponseDto>}
|
|
19205
|
+
* @memberof PosRoleDto
|
|
20308
19206
|
*/
|
|
20309
|
-
'permissionRules': Array<
|
|
19207
|
+
'permissionRules': Array<PermissionRuleResponseDto>;
|
|
20310
19208
|
}
|
|
20311
19209
|
/**
|
|
20312
19210
|
*
|
|
@@ -20372,31 +19270,6 @@ export interface PosSessionResponseDto {
|
|
|
20372
19270
|
}
|
|
20373
19271
|
|
|
20374
19272
|
|
|
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
|
-
}
|
|
20400
19273
|
/**
|
|
20401
19274
|
*
|
|
20402
19275
|
* @export
|
|
@@ -23023,44 +21896,6 @@ export interface RejectOrderDto {
|
|
|
23023
21896
|
}
|
|
23024
21897
|
|
|
23025
21898
|
|
|
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
|
-
}
|
|
23064
21899
|
/**
|
|
23065
21900
|
*
|
|
23066
21901
|
* @export
|
|
@@ -23723,109 +22558,6 @@ export interface SalesSummaryDtoV2 {
|
|
|
23723
22558
|
*/
|
|
23724
22559
|
'totalSurchargeAmount': number;
|
|
23725
22560
|
}
|
|
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
|
-
}
|
|
23829
22561
|
/**
|
|
23830
22562
|
*
|
|
23831
22563
|
* @export
|
|
@@ -23903,57 +22635,6 @@ export const ScheduleType = {
|
|
|
23903
22635
|
export type ScheduleType = typeof ScheduleType[keyof typeof ScheduleType];
|
|
23904
22636
|
|
|
23905
22637
|
|
|
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
|
-
|
|
23957
22638
|
/**
|
|
23958
22639
|
*
|
|
23959
22640
|
* @export
|
|
@@ -31544,124 +30225,29 @@ export class AblyApi extends BaseAPI implements AblyApiInterface {
|
|
|
31544
30225
|
|
|
31545
30226
|
|
|
31546
30227
|
/**
|
|
31547
|
-
*
|
|
30228
|
+
* ActionPasscodesApi - axios parameter creator
|
|
31548
30229
|
* @export
|
|
31549
30230
|
*/
|
|
31550
|
-
export const
|
|
30231
|
+
export const ActionPasscodesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
31551
30232
|
return {
|
|
31552
30233
|
/**
|
|
31553
|
-
*
|
|
31554
|
-
* @summary
|
|
30234
|
+
* Answers whether a passcode of the venue or its chain approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again (D102). A key for what a person may see is never approved. After 5 wrong PINs the till waits 60 seconds.
|
|
30235
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
30236
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
30237
|
+
* @param {string} xPosPin The manager\'s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
30238
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
31555
30239
|
* @param {*} [options] Override http request option.
|
|
31556
30240
|
* @throws {RequiredError}
|
|
31557
30241
|
*/
|
|
31558
|
-
|
|
31559
|
-
|
|
31560
|
-
|
|
31561
|
-
|
|
31562
|
-
|
|
31563
|
-
|
|
31564
|
-
|
|
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`;
|
|
30242
|
+
checkActionPasscode: async (businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
30243
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
30244
|
+
assertParamExists('checkActionPasscode', 'businessId', businessId)
|
|
30245
|
+
// verify required parameter 'xPosPin' is not null or undefined
|
|
30246
|
+
assertParamExists('checkActionPasscode', 'xPosPin', xPosPin)
|
|
30247
|
+
// verify required parameter 'checkActionPasscodeDto' is not null or undefined
|
|
30248
|
+
assertParamExists('checkActionPasscode', 'checkActionPasscodeDto', checkActionPasscodeDto)
|
|
30249
|
+
const localVarPath = `/api/v2/businesses/{businessId}/action-passcodes/check`
|
|
30250
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
31665
30251
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
31666
30252
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
31667
30253
|
let baseOptions;
|
|
@@ -31673,42 +30259,14 @@ export const AccessControlApiAxiosParamCreator = function (configuration?: Confi
|
|
|
31673
30259
|
const localVarHeaderParameter = {} as any;
|
|
31674
30260
|
const localVarQueryParameter = {} as any;
|
|
31675
30261
|
|
|
30262
|
+
// authentication JWT-auth required
|
|
30263
|
+
// http bearer authentication required
|
|
30264
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
31676
30265
|
|
|
31677
|
-
|
|
31678
|
-
|
|
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;
|
|
30266
|
+
if (xPosPin != null) {
|
|
30267
|
+
localVarHeaderParameter['X-Pos-Pin'] = String(xPosPin);
|
|
31706
30268
|
}
|
|
31707
30269
|
|
|
31708
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
31709
|
-
const localVarHeaderParameter = {} as any;
|
|
31710
|
-
const localVarQueryParameter = {} as any;
|
|
31711
|
-
|
|
31712
30270
|
|
|
31713
30271
|
|
|
31714
30272
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
@@ -31716,270 +30274,13 @@ export const AccessControlApiAxiosParamCreator = function (configuration?: Confi
|
|
|
31716
30274
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
31717
30275
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
31718
30276
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
31719
|
-
localVarRequestOptions.data = serializeDataIfNeeded(
|
|
30277
|
+
localVarRequestOptions.data = serializeDataIfNeeded(checkActionPasscodeDto, localVarRequestOptions, configuration)
|
|
31720
30278
|
|
|
31721
30279
|
return {
|
|
31722
30280
|
url: toPathString(localVarUrlObj),
|
|
31723
30281
|
options: localVarRequestOptions,
|
|
31724
30282
|
};
|
|
31725
30283
|
},
|
|
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
|
-
|
|
31977
|
-
/**
|
|
31978
|
-
* ActionPasscodesApi - axios parameter creator
|
|
31979
|
-
* @export
|
|
31980
|
-
*/
|
|
31981
|
-
export const ActionPasscodesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
31982
|
-
return {
|
|
31983
30284
|
/**
|
|
31984
30285
|
*
|
|
31985
30286
|
* @summary Create action passcode
|
|
@@ -32112,6 +30413,19 @@ export const ActionPasscodesApiAxiosParamCreator = function (configuration?: Con
|
|
|
32112
30413
|
export const ActionPasscodesApiFp = function(configuration?: Configuration) {
|
|
32113
30414
|
const localVarAxiosParamCreator = ActionPasscodesApiAxiosParamCreator(configuration)
|
|
32114
30415
|
return {
|
|
30416
|
+
/**
|
|
30417
|
+
* Answers whether a passcode of the venue or its chain approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again (D102). A key for what a person may see is never approved. After 5 wrong PINs the till waits 60 seconds.
|
|
30418
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
30419
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
30420
|
+
* @param {string} xPosPin The manager\'s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
30421
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
30422
|
+
* @param {*} [options] Override http request option.
|
|
30423
|
+
* @throws {RequiredError}
|
|
30424
|
+
*/
|
|
30425
|
+
async checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionPasscodeCheckResponseDto>> {
|
|
30426
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkActionPasscode(businessId, xPosPin, checkActionPasscodeDto, options);
|
|
30427
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
30428
|
+
},
|
|
32115
30429
|
/**
|
|
32116
30430
|
*
|
|
32117
30431
|
* @summary Create action passcode
|
|
@@ -32156,6 +30470,18 @@ export const ActionPasscodesApiFp = function(configuration?: Configuration) {
|
|
|
32156
30470
|
export const ActionPasscodesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
32157
30471
|
const localVarFp = ActionPasscodesApiFp(configuration)
|
|
32158
30472
|
return {
|
|
30473
|
+
/**
|
|
30474
|
+
* Answers whether a passcode of the venue or its chain approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again (D102). A key for what a person may see is never approved. After 5 wrong PINs the till waits 60 seconds.
|
|
30475
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
30476
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
30477
|
+
* @param {string} xPosPin The manager\'s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
30478
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
30479
|
+
* @param {*} [options] Override http request option.
|
|
30480
|
+
* @throws {RequiredError}
|
|
30481
|
+
*/
|
|
30482
|
+
checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: any): AxiosPromise<ActionPasscodeCheckResponseDto> {
|
|
30483
|
+
return localVarFp.checkActionPasscode(businessId, xPosPin, checkActionPasscodeDto, options).then((request) => request(axios, basePath));
|
|
30484
|
+
},
|
|
32159
30485
|
/**
|
|
32160
30486
|
*
|
|
32161
30487
|
* @summary Create action passcode
|
|
@@ -32196,6 +30522,18 @@ export const ActionPasscodesApiFactory = function (configuration?: Configuration
|
|
|
32196
30522
|
* @interface ActionPasscodesApi
|
|
32197
30523
|
*/
|
|
32198
30524
|
export interface ActionPasscodesApiInterface {
|
|
30525
|
+
/**
|
|
30526
|
+
* Answers whether a passcode of the venue or its chain approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again (D102). A key for what a person may see is never approved. After 5 wrong PINs the till waits 60 seconds.
|
|
30527
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
30528
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
30529
|
+
* @param {string} xPosPin The manager\'s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
30530
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
30531
|
+
* @param {*} [options] Override http request option.
|
|
30532
|
+
* @throws {RequiredError}
|
|
30533
|
+
* @memberof ActionPasscodesApiInterface
|
|
30534
|
+
*/
|
|
30535
|
+
checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig): AxiosPromise<ActionPasscodeCheckResponseDto>;
|
|
30536
|
+
|
|
32199
30537
|
/**
|
|
32200
30538
|
*
|
|
32201
30539
|
* @summary Create action passcode
|
|
@@ -32236,6 +30574,20 @@ export interface ActionPasscodesApiInterface {
|
|
|
32236
30574
|
* @extends {BaseAPI}
|
|
32237
30575
|
*/
|
|
32238
30576
|
export class ActionPasscodesApi extends BaseAPI implements ActionPasscodesApiInterface {
|
|
30577
|
+
/**
|
|
30578
|
+
* Answers whether a passcode of the venue or its chain approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again (D102). A key for what a person may see is never approved. After 5 wrong PINs the till waits 60 seconds.
|
|
30579
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
30580
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
30581
|
+
* @param {string} xPosPin The manager\'s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
30582
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
30583
|
+
* @param {*} [options] Override http request option.
|
|
30584
|
+
* @throws {RequiredError}
|
|
30585
|
+
* @memberof ActionPasscodesApi
|
|
30586
|
+
*/
|
|
30587
|
+
public checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig) {
|
|
30588
|
+
return ActionPasscodesApiFp(this.configuration).checkActionPasscode(businessId, xPosPin, checkActionPasscodeDto, options).then((request) => request(this.axios, this.basePath));
|
|
30589
|
+
}
|
|
30590
|
+
|
|
32239
30591
|
/**
|
|
32240
30592
|
*
|
|
32241
30593
|
* @summary Create action passcode
|
|
@@ -35253,70 +33605,6 @@ export const CashManagementApiAxiosParamCreator = function (configuration?: Conf
|
|
|
35253
33605
|
|
|
35254
33606
|
|
|
35255
33607
|
|
|
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
|
-
|
|
35320
33608
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
35321
33609
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
35322
33610
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -35516,23 +33804,6 @@ export const CashManagementApiFp = function(configuration?: Configuration) {
|
|
|
35516
33804
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getCashLogs(businessId, timezone, timeSpan, start, end, page, rowPerPage, options);
|
|
35517
33805
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
35518
33806
|
},
|
|
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
|
-
},
|
|
35536
33807
|
/**
|
|
35537
33808
|
*
|
|
35538
33809
|
* @param {string} businessId
|
|
@@ -35613,22 +33884,6 @@ export const CashManagementApiFactory = function (configuration?: Configuration,
|
|
|
35613
33884
|
getCashLogs(businessId: string, timezone: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, options?: any): AxiosPromise<CashLogsPaginatedDto> {
|
|
35614
33885
|
return localVarFp.getCashLogs(businessId, timezone, timeSpan, start, end, page, rowPerPage, options).then((request) => request(axios, basePath));
|
|
35615
33886
|
},
|
|
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
|
-
},
|
|
35632
33887
|
/**
|
|
35633
33888
|
*
|
|
35634
33889
|
* @param {string} businessId
|
|
@@ -35704,22 +33959,6 @@ export interface CashManagementApiInterface {
|
|
|
35704
33959
|
*/
|
|
35705
33960
|
getCashLogs(businessId: string, timezone: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, options?: AxiosRequestConfig): AxiosPromise<CashLogsPaginatedDto>;
|
|
35706
33961
|
|
|
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
|
-
|
|
35723
33962
|
/**
|
|
35724
33963
|
*
|
|
35725
33964
|
* @param {string} businessId
|
|
@@ -35799,24 +34038,6 @@ export class CashManagementApi extends BaseAPI implements CashManagementApiInter
|
|
|
35799
34038
|
return CashManagementApiFp(this.configuration).getCashLogs(businessId, timezone, timeSpan, start, end, page, rowPerPage, options).then((request) => request(this.axios, this.basePath));
|
|
35800
34039
|
}
|
|
35801
34040
|
|
|
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
|
-
|
|
35820
34041
|
/**
|
|
35821
34042
|
*
|
|
35822
34043
|
* @param {string} businessId
|
|
@@ -39999,101 +38220,6 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
39999
38220
|
|
|
40000
38221
|
|
|
40001
38222
|
|
|
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
|
-
|
|
40097
38223
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40098
38224
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40099
38225
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -40206,220 +38332,9 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
40206
38332
|
};
|
|
40207
38333
|
},
|
|
40208
38334
|
/**
|
|
40209
|
-
*
|
|
40210
|
-
* @summary Get order history for POS V5
|
|
40211
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
40212
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
40213
|
-
* @param {string} [start] Start date
|
|
40214
|
-
* @param {string} [end] End date
|
|
40215
|
-
* @param {number} [page] Page number
|
|
40216
|
-
* @param {number} [rowPerPage] Number of rows per page
|
|
40217
|
-
* @param {Array<ProviderEnum>} [provider] Provider
|
|
40218
|
-
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
40219
|
-
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
40220
|
-
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
40221
|
-
* @param {Array<OrderType>} [orderType] Order type
|
|
40222
|
-
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40223
|
-
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40224
|
-
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
40225
|
-
* @param {*} [options] Override http request option.
|
|
40226
|
-
* @throws {RequiredError}
|
|
40227
|
-
*/
|
|
40228
|
-
getOrderHistoryPOSV5: async (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40229
|
-
// verify required parameter 'businessIds' is not null or undefined
|
|
40230
|
-
assertParamExists('getOrderHistoryPOSV5', 'businessIds', businessIds)
|
|
40231
|
-
const localVarPath = `/api/v5/history/orders/pos`;
|
|
40232
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
40233
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40234
|
-
let baseOptions;
|
|
40235
|
-
if (configuration) {
|
|
40236
|
-
baseOptions = configuration.baseOptions;
|
|
40237
|
-
}
|
|
40238
|
-
|
|
40239
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
40240
|
-
const localVarHeaderParameter = {} as any;
|
|
40241
|
-
const localVarQueryParameter = {} as any;
|
|
40242
|
-
|
|
40243
|
-
// authentication JWT-auth required
|
|
40244
|
-
// http bearer authentication required
|
|
40245
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
40246
|
-
|
|
40247
|
-
if (timeSpan !== undefined) {
|
|
40248
|
-
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
40249
|
-
}
|
|
40250
|
-
|
|
40251
|
-
if (start !== undefined) {
|
|
40252
|
-
localVarQueryParameter['start'] = start;
|
|
40253
|
-
}
|
|
40254
|
-
|
|
40255
|
-
if (end !== undefined) {
|
|
40256
|
-
localVarQueryParameter['end'] = end;
|
|
40257
|
-
}
|
|
40258
|
-
|
|
40259
|
-
if (businessIds) {
|
|
40260
|
-
localVarQueryParameter['businessIds'] = businessIds;
|
|
40261
|
-
}
|
|
40262
|
-
|
|
40263
|
-
if (page !== undefined) {
|
|
40264
|
-
localVarQueryParameter['page'] = page;
|
|
40265
|
-
}
|
|
40266
|
-
|
|
40267
|
-
if (rowPerPage !== undefined) {
|
|
40268
|
-
localVarQueryParameter['rowPerPage'] = rowPerPage;
|
|
40269
|
-
}
|
|
40270
|
-
|
|
40271
|
-
if (provider) {
|
|
40272
|
-
localVarQueryParameter['provider'] = provider;
|
|
40273
|
-
}
|
|
40274
|
-
|
|
40275
|
-
if (paymentType) {
|
|
40276
|
-
localVarQueryParameter['paymentType'] = paymentType;
|
|
40277
|
-
}
|
|
40278
|
-
|
|
40279
|
-
if (orderStatus) {
|
|
40280
|
-
localVarQueryParameter['orderStatus'] = orderStatus;
|
|
40281
|
-
}
|
|
40282
|
-
|
|
40283
|
-
if (paymentStatus) {
|
|
40284
|
-
localVarQueryParameter['paymentStatus'] = paymentStatus;
|
|
40285
|
-
}
|
|
40286
|
-
|
|
40287
|
-
if (orderType) {
|
|
40288
|
-
localVarQueryParameter['orderType'] = orderType;
|
|
40289
|
-
}
|
|
40290
|
-
|
|
40291
|
-
if (paymentTypePos) {
|
|
40292
|
-
localVarQueryParameter['paymentTypePos'] = paymentTypePos;
|
|
40293
|
-
}
|
|
40294
|
-
|
|
40295
|
-
if (invoiceCompanyId !== undefined) {
|
|
40296
|
-
localVarQueryParameter['invoiceCompanyId'] = invoiceCompanyId;
|
|
40297
|
-
}
|
|
40298
|
-
|
|
40299
|
-
if (timezone !== undefined) {
|
|
40300
|
-
localVarQueryParameter['timezone'] = timezone;
|
|
40301
|
-
}
|
|
40302
|
-
|
|
40303
|
-
|
|
40304
|
-
|
|
40305
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40306
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40307
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
40308
|
-
|
|
40309
|
-
return {
|
|
40310
|
-
url: toPathString(localVarUrlObj),
|
|
40311
|
-
options: localVarRequestOptions,
|
|
40312
|
-
};
|
|
40313
|
-
},
|
|
40314
|
-
/**
|
|
40315
|
-
*
|
|
40316
|
-
* @summary Get order history for POS V5
|
|
40317
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
40318
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
40319
|
-
* @param {string} [start] Start date
|
|
40320
|
-
* @param {string} [end] End date
|
|
40321
|
-
* @param {number} [page] Page number
|
|
40322
|
-
* @param {number} [rowPerPage] Number of rows per page
|
|
40323
|
-
* @param {Array<ProviderEnum>} [provider] Provider
|
|
40324
|
-
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
40325
|
-
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
40326
|
-
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
40327
|
-
* @param {Array<OrderType>} [orderType] Order type
|
|
40328
|
-
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40329
|
-
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40330
|
-
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
40331
|
-
* @param {*} [options] Override http request option.
|
|
40332
|
-
* @throws {RequiredError}
|
|
40333
|
-
*/
|
|
40334
|
-
getOrderHistoryPOSV5Internal: async (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40335
|
-
// verify required parameter 'businessIds' is not null or undefined
|
|
40336
|
-
assertParamExists('getOrderHistoryPOSV5Internal', 'businessIds', businessIds)
|
|
40337
|
-
const localVarPath = `/api/v5/history/internal/orders/pos`;
|
|
40338
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
40339
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40340
|
-
let baseOptions;
|
|
40341
|
-
if (configuration) {
|
|
40342
|
-
baseOptions = configuration.baseOptions;
|
|
40343
|
-
}
|
|
40344
|
-
|
|
40345
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
40346
|
-
const localVarHeaderParameter = {} as any;
|
|
40347
|
-
const localVarQueryParameter = {} as any;
|
|
40348
|
-
|
|
40349
|
-
// authentication JWT-auth required
|
|
40350
|
-
// http bearer authentication required
|
|
40351
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
40352
|
-
|
|
40353
|
-
if (timeSpan !== undefined) {
|
|
40354
|
-
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
40355
|
-
}
|
|
40356
|
-
|
|
40357
|
-
if (start !== undefined) {
|
|
40358
|
-
localVarQueryParameter['start'] = start;
|
|
40359
|
-
}
|
|
40360
|
-
|
|
40361
|
-
if (end !== undefined) {
|
|
40362
|
-
localVarQueryParameter['end'] = end;
|
|
40363
|
-
}
|
|
40364
|
-
|
|
40365
|
-
if (businessIds) {
|
|
40366
|
-
localVarQueryParameter['businessIds'] = businessIds;
|
|
40367
|
-
}
|
|
40368
|
-
|
|
40369
|
-
if (page !== undefined) {
|
|
40370
|
-
localVarQueryParameter['page'] = page;
|
|
40371
|
-
}
|
|
40372
|
-
|
|
40373
|
-
if (rowPerPage !== undefined) {
|
|
40374
|
-
localVarQueryParameter['rowPerPage'] = rowPerPage;
|
|
40375
|
-
}
|
|
40376
|
-
|
|
40377
|
-
if (provider) {
|
|
40378
|
-
localVarQueryParameter['provider'] = provider;
|
|
40379
|
-
}
|
|
40380
|
-
|
|
40381
|
-
if (paymentType) {
|
|
40382
|
-
localVarQueryParameter['paymentType'] = paymentType;
|
|
40383
|
-
}
|
|
40384
|
-
|
|
40385
|
-
if (orderStatus) {
|
|
40386
|
-
localVarQueryParameter['orderStatus'] = orderStatus;
|
|
40387
|
-
}
|
|
40388
|
-
|
|
40389
|
-
if (paymentStatus) {
|
|
40390
|
-
localVarQueryParameter['paymentStatus'] = paymentStatus;
|
|
40391
|
-
}
|
|
40392
|
-
|
|
40393
|
-
if (orderType) {
|
|
40394
|
-
localVarQueryParameter['orderType'] = orderType;
|
|
40395
|
-
}
|
|
40396
|
-
|
|
40397
|
-
if (paymentTypePos) {
|
|
40398
|
-
localVarQueryParameter['paymentTypePos'] = paymentTypePos;
|
|
40399
|
-
}
|
|
40400
|
-
|
|
40401
|
-
if (invoiceCompanyId !== undefined) {
|
|
40402
|
-
localVarQueryParameter['invoiceCompanyId'] = invoiceCompanyId;
|
|
40403
|
-
}
|
|
40404
|
-
|
|
40405
|
-
if (timezone !== undefined) {
|
|
40406
|
-
localVarQueryParameter['timezone'] = timezone;
|
|
40407
|
-
}
|
|
40408
|
-
|
|
40409
|
-
|
|
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
|
|
38335
|
+
*
|
|
38336
|
+
* @summary Get order history for POS V5
|
|
38337
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
40423
38338
|
* @param {TimeSpan} [timeSpan] Time span
|
|
40424
38339
|
* @param {string} [start] Start date
|
|
40425
38340
|
* @param {string} [end] End date
|
|
@@ -40432,12 +38347,14 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
40432
38347
|
* @param {Array<OrderType>} [orderType] Order type
|
|
40433
38348
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40434
38349
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40435
|
-
* @param {string} [timezone]
|
|
38350
|
+
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
40436
38351
|
* @param {*} [options] Override http request option.
|
|
40437
38352
|
* @throws {RequiredError}
|
|
40438
38353
|
*/
|
|
40439
|
-
|
|
40440
|
-
|
|
38354
|
+
getOrderHistoryPOSV5: async (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38355
|
+
// verify required parameter 'businessIds' is not null or undefined
|
|
38356
|
+
assertParamExists('getOrderHistoryPOSV5', 'businessIds', businessIds)
|
|
38357
|
+
const localVarPath = `/api/v5/history/orders/pos`;
|
|
40441
38358
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
40442
38359
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40443
38360
|
let baseOptions;
|
|
@@ -40449,6 +38366,10 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
40449
38366
|
const localVarHeaderParameter = {} as any;
|
|
40450
38367
|
const localVarQueryParameter = {} as any;
|
|
40451
38368
|
|
|
38369
|
+
// authentication JWT-auth required
|
|
38370
|
+
// http bearer authentication required
|
|
38371
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
38372
|
+
|
|
40452
38373
|
if (timeSpan !== undefined) {
|
|
40453
38374
|
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
40454
38375
|
}
|
|
@@ -40461,6 +38382,10 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
40461
38382
|
localVarQueryParameter['end'] = end;
|
|
40462
38383
|
}
|
|
40463
38384
|
|
|
38385
|
+
if (businessIds) {
|
|
38386
|
+
localVarQueryParameter['businessIds'] = businessIds;
|
|
38387
|
+
}
|
|
38388
|
+
|
|
40464
38389
|
if (page !== undefined) {
|
|
40465
38390
|
localVarQueryParameter['page'] = page;
|
|
40466
38391
|
}
|
|
@@ -40512,19 +38437,9 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
40512
38437
|
options: localVarRequestOptions,
|
|
40513
38438
|
};
|
|
40514
38439
|
},
|
|
40515
|
-
}
|
|
40516
|
-
};
|
|
40517
|
-
|
|
40518
|
-
/**
|
|
40519
|
-
* HistoryApi - functional programming interface
|
|
40520
|
-
* @export
|
|
40521
|
-
*/
|
|
40522
|
-
export const HistoryApiFp = function(configuration?: Configuration) {
|
|
40523
|
-
const localVarAxiosParamCreator = HistoryApiAxiosParamCreator(configuration)
|
|
40524
|
-
return {
|
|
40525
38440
|
/**
|
|
40526
38441
|
*
|
|
40527
|
-
* @summary Get order history
|
|
38442
|
+
* @summary Get order history for POS V5
|
|
40528
38443
|
* @param {Array<number>} businessIds Business ID selected
|
|
40529
38444
|
* @param {TimeSpan} [timeSpan] Time span
|
|
40530
38445
|
* @param {string} [start] Start date
|
|
@@ -40542,13 +38457,106 @@ export const HistoryApiFp = function(configuration?: Configuration) {
|
|
|
40542
38457
|
* @param {*} [options] Override http request option.
|
|
40543
38458
|
* @throws {RequiredError}
|
|
40544
38459
|
*/
|
|
40545
|
-
async
|
|
40546
|
-
|
|
40547
|
-
|
|
38460
|
+
getOrderHistoryPOSV5Internal: async (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
38461
|
+
// verify required parameter 'businessIds' is not null or undefined
|
|
38462
|
+
assertParamExists('getOrderHistoryPOSV5Internal', 'businessIds', businessIds)
|
|
38463
|
+
const localVarPath = `/api/v5/history/internal/orders/pos`;
|
|
38464
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
38465
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
38466
|
+
let baseOptions;
|
|
38467
|
+
if (configuration) {
|
|
38468
|
+
baseOptions = configuration.baseOptions;
|
|
38469
|
+
}
|
|
38470
|
+
|
|
38471
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
38472
|
+
const localVarHeaderParameter = {} as any;
|
|
38473
|
+
const localVarQueryParameter = {} as any;
|
|
38474
|
+
|
|
38475
|
+
// authentication JWT-auth required
|
|
38476
|
+
// http bearer authentication required
|
|
38477
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
38478
|
+
|
|
38479
|
+
if (timeSpan !== undefined) {
|
|
38480
|
+
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
38481
|
+
}
|
|
38482
|
+
|
|
38483
|
+
if (start !== undefined) {
|
|
38484
|
+
localVarQueryParameter['start'] = start;
|
|
38485
|
+
}
|
|
38486
|
+
|
|
38487
|
+
if (end !== undefined) {
|
|
38488
|
+
localVarQueryParameter['end'] = end;
|
|
38489
|
+
}
|
|
38490
|
+
|
|
38491
|
+
if (businessIds) {
|
|
38492
|
+
localVarQueryParameter['businessIds'] = businessIds;
|
|
38493
|
+
}
|
|
38494
|
+
|
|
38495
|
+
if (page !== undefined) {
|
|
38496
|
+
localVarQueryParameter['page'] = page;
|
|
38497
|
+
}
|
|
38498
|
+
|
|
38499
|
+
if (rowPerPage !== undefined) {
|
|
38500
|
+
localVarQueryParameter['rowPerPage'] = rowPerPage;
|
|
38501
|
+
}
|
|
38502
|
+
|
|
38503
|
+
if (provider) {
|
|
38504
|
+
localVarQueryParameter['provider'] = provider;
|
|
38505
|
+
}
|
|
38506
|
+
|
|
38507
|
+
if (paymentType) {
|
|
38508
|
+
localVarQueryParameter['paymentType'] = paymentType;
|
|
38509
|
+
}
|
|
38510
|
+
|
|
38511
|
+
if (orderStatus) {
|
|
38512
|
+
localVarQueryParameter['orderStatus'] = orderStatus;
|
|
38513
|
+
}
|
|
38514
|
+
|
|
38515
|
+
if (paymentStatus) {
|
|
38516
|
+
localVarQueryParameter['paymentStatus'] = paymentStatus;
|
|
38517
|
+
}
|
|
38518
|
+
|
|
38519
|
+
if (orderType) {
|
|
38520
|
+
localVarQueryParameter['orderType'] = orderType;
|
|
38521
|
+
}
|
|
38522
|
+
|
|
38523
|
+
if (paymentTypePos) {
|
|
38524
|
+
localVarQueryParameter['paymentTypePos'] = paymentTypePos;
|
|
38525
|
+
}
|
|
38526
|
+
|
|
38527
|
+
if (invoiceCompanyId !== undefined) {
|
|
38528
|
+
localVarQueryParameter['invoiceCompanyId'] = invoiceCompanyId;
|
|
38529
|
+
}
|
|
38530
|
+
|
|
38531
|
+
if (timezone !== undefined) {
|
|
38532
|
+
localVarQueryParameter['timezone'] = timezone;
|
|
38533
|
+
}
|
|
38534
|
+
|
|
38535
|
+
|
|
38536
|
+
|
|
38537
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
38538
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
38539
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
38540
|
+
|
|
38541
|
+
return {
|
|
38542
|
+
url: toPathString(localVarUrlObj),
|
|
38543
|
+
options: localVarRequestOptions,
|
|
38544
|
+
};
|
|
40548
38545
|
},
|
|
38546
|
+
}
|
|
38547
|
+
};
|
|
38548
|
+
|
|
38549
|
+
/**
|
|
38550
|
+
* HistoryApi - functional programming interface
|
|
38551
|
+
* @export
|
|
38552
|
+
*/
|
|
38553
|
+
export const HistoryApiFp = function(configuration?: Configuration) {
|
|
38554
|
+
const localVarAxiosParamCreator = HistoryApiAxiosParamCreator(configuration)
|
|
38555
|
+
return {
|
|
40549
38556
|
/**
|
|
40550
|
-
*
|
|
40551
|
-
* @summary
|
|
38557
|
+
*
|
|
38558
|
+
* @summary Get order history
|
|
38559
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
40552
38560
|
* @param {TimeSpan} [timeSpan] Time span
|
|
40553
38561
|
* @param {string} [start] Start date
|
|
40554
38562
|
* @param {string} [end] End date
|
|
@@ -40561,12 +38569,12 @@ export const HistoryApiFp = function(configuration?: Configuration) {
|
|
|
40561
38569
|
* @param {Array<OrderType>} [orderType] Order type
|
|
40562
38570
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
40563
38571
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
40564
|
-
* @param {string} [timezone]
|
|
38572
|
+
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
40565
38573
|
* @param {*} [options] Override http request option.
|
|
40566
38574
|
* @throws {RequiredError}
|
|
40567
38575
|
*/
|
|
40568
|
-
async
|
|
40569
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
38576
|
+
async 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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderHistoryResponseDto>> {
|
|
38577
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getInternalOrderHistoryOnline(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options);
|
|
40570
38578
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
40571
38579
|
},
|
|
40572
38580
|
/**
|
|
@@ -40641,29 +38649,6 @@ export const HistoryApiFp = function(configuration?: Configuration) {
|
|
|
40641
38649
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrderHistoryPOSV5Internal(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options);
|
|
40642
38650
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
40643
38651
|
},
|
|
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
|
-
},
|
|
40667
38652
|
}
|
|
40668
38653
|
};
|
|
40669
38654
|
|
|
@@ -40697,28 +38682,6 @@ export const HistoryApiFactory = function (configuration?: Configuration, basePa
|
|
|
40697
38682
|
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> {
|
|
40698
38683
|
return localVarFp.getInternalOrderHistoryOnline(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(axios, basePath));
|
|
40699
38684
|
},
|
|
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
|
-
},
|
|
40722
38685
|
/**
|
|
40723
38686
|
*
|
|
40724
38687
|
* @summary Get order history
|
|
@@ -40788,28 +38751,6 @@ export const HistoryApiFactory = function (configuration?: Configuration, basePa
|
|
|
40788
38751
|
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> {
|
|
40789
38752
|
return localVarFp.getOrderHistoryPOSV5Internal(businessIds, timeSpan, start, end, page, rowPerPage, provider, paymentType, orderStatus, paymentStatus, orderType, paymentTypePos, invoiceCompanyId, timezone, options).then((request) => request(axios, basePath));
|
|
40790
38753
|
},
|
|
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
|
-
},
|
|
40813
38754
|
};
|
|
40814
38755
|
};
|
|
40815
38756
|
|
|
@@ -40842,28 +38783,6 @@ export interface HistoryApiInterface {
|
|
|
40842
38783
|
*/
|
|
40843
38784
|
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>;
|
|
40844
38785
|
|
|
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
|
-
|
|
40867
38786
|
/**
|
|
40868
38787
|
*
|
|
40869
38788
|
* @summary Get order history
|
|
@@ -40933,28 +38852,6 @@ export interface HistoryApiInterface {
|
|
|
40933
38852
|
*/
|
|
40934
38853
|
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>;
|
|
40935
38854
|
|
|
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
|
-
|
|
40958
38855
|
}
|
|
40959
38856
|
|
|
40960
38857
|
/**
|
|
@@ -40989,30 +38886,6 @@ export class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
40989
38886
|
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));
|
|
40990
38887
|
}
|
|
40991
38888
|
|
|
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
|
-
|
|
41016
38889
|
/**
|
|
41017
38890
|
*
|
|
41018
38891
|
* @summary Get order history
|
|
@@ -41087,30 +38960,6 @@ export class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
41087
38960
|
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) {
|
|
41088
38961
|
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));
|
|
41089
38962
|
}
|
|
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
|
-
}
|
|
41114
38963
|
}
|
|
41115
38964
|
|
|
41116
38965
|
|
|
@@ -47226,22 +45075,19 @@ export class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
47226
45075
|
|
|
47227
45076
|
|
|
47228
45077
|
/**
|
|
47229
|
-
*
|
|
45078
|
+
* POSPermissionsApi - axios parameter creator
|
|
47230
45079
|
* @export
|
|
47231
45080
|
*/
|
|
47232
|
-
export const
|
|
45081
|
+
export const POSPermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
47233
45082
|
return {
|
|
47234
45083
|
/**
|
|
47235
|
-
*
|
|
47236
|
-
* @
|
|
45084
|
+
* The back office builds its employee-role and passcode checkboxes from this list, so a key added on the server appears there without a new label in the app. The list is the same for every venue.
|
|
45085
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
47237
45086
|
* @param {*} [options] Override http request option.
|
|
47238
45087
|
* @throws {RequiredError}
|
|
47239
45088
|
*/
|
|
47240
|
-
|
|
47241
|
-
|
|
47242
|
-
assertParamExists('getPosSession', 'businessId', businessId)
|
|
47243
|
-
const localVarPath = `/api/v1/pos-session/{businessId}`
|
|
47244
|
-
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
45089
|
+
listPosPermissions: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
45090
|
+
const localVarPath = `/api/v1/pos-permissions`;
|
|
47245
45091
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47246
45092
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
47247
45093
|
let baseOptions;
|
|
@@ -47253,6 +45099,10 @@ export const POSSessionApiAxiosParamCreator = function (configuration?: Configur
|
|
|
47253
45099
|
const localVarHeaderParameter = {} as any;
|
|
47254
45100
|
const localVarQueryParameter = {} as any;
|
|
47255
45101
|
|
|
45102
|
+
// authentication JWT-auth required
|
|
45103
|
+
// http bearer authentication required
|
|
45104
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
45105
|
+
|
|
47256
45106
|
|
|
47257
45107
|
|
|
47258
45108
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -47264,17 +45114,101 @@ export const POSSessionApiAxiosParamCreator = function (configuration?: Configur
|
|
|
47264
45114
|
options: localVarRequestOptions,
|
|
47265
45115
|
};
|
|
47266
45116
|
},
|
|
45117
|
+
}
|
|
45118
|
+
};
|
|
45119
|
+
|
|
45120
|
+
/**
|
|
45121
|
+
* POSPermissionsApi - functional programming interface
|
|
45122
|
+
* @export
|
|
45123
|
+
*/
|
|
45124
|
+
export const POSPermissionsApiFp = function(configuration?: Configuration) {
|
|
45125
|
+
const localVarAxiosParamCreator = POSPermissionsApiAxiosParamCreator(configuration)
|
|
45126
|
+
return {
|
|
45127
|
+
/**
|
|
45128
|
+
* The back office builds its employee-role and passcode checkboxes from this list, so a key added on the server appears there without a new label in the app. The list is the same for every venue.
|
|
45129
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
45130
|
+
* @param {*} [options] Override http request option.
|
|
45131
|
+
* @throws {RequiredError}
|
|
45132
|
+
*/
|
|
45133
|
+
async listPosPermissions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosPermissionCatalogResponseDto>> {
|
|
45134
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPosPermissions(options);
|
|
45135
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
45136
|
+
},
|
|
45137
|
+
}
|
|
45138
|
+
};
|
|
45139
|
+
|
|
45140
|
+
/**
|
|
45141
|
+
* POSPermissionsApi - factory interface
|
|
45142
|
+
* @export
|
|
45143
|
+
*/
|
|
45144
|
+
export const POSPermissionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
45145
|
+
const localVarFp = POSPermissionsApiFp(configuration)
|
|
45146
|
+
return {
|
|
45147
|
+
/**
|
|
45148
|
+
* The back office builds its employee-role and passcode checkboxes from this list, so a key added on the server appears there without a new label in the app. The list is the same for every venue.
|
|
45149
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
45150
|
+
* @param {*} [options] Override http request option.
|
|
45151
|
+
* @throws {RequiredError}
|
|
45152
|
+
*/
|
|
45153
|
+
listPosPermissions(options?: any): AxiosPromise<PosPermissionCatalogResponseDto> {
|
|
45154
|
+
return localVarFp.listPosPermissions(options).then((request) => request(axios, basePath));
|
|
45155
|
+
},
|
|
45156
|
+
};
|
|
45157
|
+
};
|
|
45158
|
+
|
|
45159
|
+
/**
|
|
45160
|
+
* POSPermissionsApi - interface
|
|
45161
|
+
* @export
|
|
45162
|
+
* @interface POSPermissionsApi
|
|
45163
|
+
*/
|
|
45164
|
+
export interface POSPermissionsApiInterface {
|
|
45165
|
+
/**
|
|
45166
|
+
* The back office builds its employee-role and passcode checkboxes from this list, so a key added on the server appears there without a new label in the app. The list is the same for every venue.
|
|
45167
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
45168
|
+
* @param {*} [options] Override http request option.
|
|
45169
|
+
* @throws {RequiredError}
|
|
45170
|
+
* @memberof POSPermissionsApiInterface
|
|
45171
|
+
*/
|
|
45172
|
+
listPosPermissions(options?: AxiosRequestConfig): AxiosPromise<PosPermissionCatalogResponseDto>;
|
|
45173
|
+
|
|
45174
|
+
}
|
|
45175
|
+
|
|
45176
|
+
/**
|
|
45177
|
+
* POSPermissionsApi - object-oriented interface
|
|
45178
|
+
* @export
|
|
45179
|
+
* @class POSPermissionsApi
|
|
45180
|
+
* @extends {BaseAPI}
|
|
45181
|
+
*/
|
|
45182
|
+
export class POSPermissionsApi extends BaseAPI implements POSPermissionsApiInterface {
|
|
45183
|
+
/**
|
|
45184
|
+
* The back office builds its employee-role and passcode checkboxes from this list, so a key added on the server appears there without a new label in the app. The list is the same for every venue.
|
|
45185
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
45186
|
+
* @param {*} [options] Override http request option.
|
|
45187
|
+
* @throws {RequiredError}
|
|
45188
|
+
* @memberof POSPermissionsApi
|
|
45189
|
+
*/
|
|
45190
|
+
public listPosPermissions(options?: AxiosRequestConfig) {
|
|
45191
|
+
return POSPermissionsApiFp(this.configuration).listPosPermissions(options).then((request) => request(this.axios, this.basePath));
|
|
45192
|
+
}
|
|
45193
|
+
}
|
|
45194
|
+
|
|
45195
|
+
|
|
45196
|
+
/**
|
|
45197
|
+
* POSSessionApi - axios parameter creator
|
|
45198
|
+
* @export
|
|
45199
|
+
*/
|
|
45200
|
+
export const POSSessionApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
45201
|
+
return {
|
|
47267
45202
|
/**
|
|
47268
45203
|
*
|
|
47269
|
-
* @summary Get POS session data for a business
|
|
47270
45204
|
* @param {number} businessId
|
|
47271
45205
|
* @param {*} [options] Override http request option.
|
|
47272
45206
|
* @throws {RequiredError}
|
|
47273
45207
|
*/
|
|
47274
|
-
|
|
45208
|
+
getPosSession: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47275
45209
|
// verify required parameter 'businessId' is not null or undefined
|
|
47276
|
-
assertParamExists('
|
|
47277
|
-
const localVarPath = `/api/
|
|
45210
|
+
assertParamExists('getPosSession', 'businessId', businessId)
|
|
45211
|
+
const localVarPath = `/api/v1/pos-session/{businessId}`
|
|
47278
45212
|
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
47279
45213
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47280
45214
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -47299,16 +45233,16 @@ export const POSSessionApiAxiosParamCreator = function (configuration?: Configur
|
|
|
47299
45233
|
};
|
|
47300
45234
|
},
|
|
47301
45235
|
/**
|
|
47302
|
-
*
|
|
47303
|
-
* @summary
|
|
45236
|
+
*
|
|
45237
|
+
* @summary Get POS session data for a business
|
|
47304
45238
|
* @param {number} businessId
|
|
47305
45239
|
* @param {*} [options] Override http request option.
|
|
47306
45240
|
* @throws {RequiredError}
|
|
47307
45241
|
*/
|
|
47308
|
-
|
|
45242
|
+
getPosSessionV2: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47309
45243
|
// verify required parameter 'businessId' is not null or undefined
|
|
47310
|
-
assertParamExists('
|
|
47311
|
-
const localVarPath = `/api/
|
|
45244
|
+
assertParamExists('getPosSessionV2', 'businessId', businessId)
|
|
45245
|
+
const localVarPath = `/api/v2/pos-session/{businessId}`
|
|
47312
45246
|
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
47313
45247
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47314
45248
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -47363,17 +45297,6 @@ export const POSSessionApiFp = function(configuration?: Configuration) {
|
|
|
47363
45297
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getPosSessionV2(businessId, options);
|
|
47364
45298
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
47365
45299
|
},
|
|
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
|
-
},
|
|
47377
45300
|
}
|
|
47378
45301
|
};
|
|
47379
45302
|
|
|
@@ -47403,16 +45326,6 @@ export const POSSessionApiFactory = function (configuration?: Configuration, bas
|
|
|
47403
45326
|
getPosSessionV2(businessId: number, options?: any): AxiosPromise<PosSessionResponseDto> {
|
|
47404
45327
|
return localVarFp.getPosSessionV2(businessId, options).then((request) => request(axios, basePath));
|
|
47405
45328
|
},
|
|
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
|
-
},
|
|
47416
45329
|
};
|
|
47417
45330
|
};
|
|
47418
45331
|
|
|
@@ -47441,16 +45354,6 @@ export interface POSSessionApiInterface {
|
|
|
47441
45354
|
*/
|
|
47442
45355
|
getPosSessionV2(businessId: number, options?: AxiosRequestConfig): AxiosPromise<PosSessionResponseDto>;
|
|
47443
45356
|
|
|
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
|
-
|
|
47454
45357
|
}
|
|
47455
45358
|
|
|
47456
45359
|
/**
|
|
@@ -47482,18 +45385,6 @@ export class POSSessionApi extends BaseAPI implements POSSessionApiInterface {
|
|
|
47482
45385
|
public getPosSessionV2(businessId: number, options?: AxiosRequestConfig) {
|
|
47483
45386
|
return POSSessionApiFp(this.configuration).getPosSessionV2(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
47484
45387
|
}
|
|
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
|
-
}
|
|
47497
45388
|
}
|
|
47498
45389
|
|
|
47499
45390
|
|
|
@@ -55290,56 +53181,6 @@ export const ReportApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
55290
53181
|
|
|
55291
53182
|
|
|
55292
53183
|
|
|
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
|
-
|
|
55343
53184
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
55344
53185
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
55345
53186
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -55395,136 +53236,66 @@ export const ReportApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
55395
53236
|
localVarQueryParameter['timezone'] = timezone;
|
|
55396
53237
|
}
|
|
55397
53238
|
|
|
55398
|
-
|
|
55399
|
-
|
|
55400
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
55401
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
55402
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
55403
|
-
|
|
55404
|
-
return {
|
|
55405
|
-
url: toPathString(localVarUrlObj),
|
|
55406
|
-
options: localVarRequestOptions,
|
|
55407
|
-
};
|
|
55408
|
-
},
|
|
55409
|
-
/**
|
|
55410
|
-
*
|
|
55411
|
-
* @summary Send end-of-day report via email (V4)
|
|
55412
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
55413
|
-
* @param {string} timezone
|
|
55414
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
55415
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
55416
|
-
* @param {string} [start] Start date
|
|
55417
|
-
* @param {string} [end] End date
|
|
55418
|
-
* @param {*} [options] Override http request option.
|
|
55419
|
-
* @throws {RequiredError}
|
|
55420
|
-
*/
|
|
55421
|
-
sendReportEmailV4: async (businessIds: Array<number>, timezone: string, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
55422
|
-
// verify required parameter 'businessIds' is not null or undefined
|
|
55423
|
-
assertParamExists('sendReportEmailV4', 'businessIds', businessIds)
|
|
55424
|
-
// verify required parameter 'timezone' is not null or undefined
|
|
55425
|
-
assertParamExists('sendReportEmailV4', 'timezone', timezone)
|
|
55426
|
-
// verify required parameter 'sendReportEmailDto' is not null or undefined
|
|
55427
|
-
assertParamExists('sendReportEmailV4', 'sendReportEmailDto', sendReportEmailDto)
|
|
55428
|
-
const localVarPath = `/api/v4/report/email`;
|
|
55429
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
55430
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
55431
|
-
let baseOptions;
|
|
55432
|
-
if (configuration) {
|
|
55433
|
-
baseOptions = configuration.baseOptions;
|
|
55434
|
-
}
|
|
55435
|
-
|
|
55436
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
55437
|
-
const localVarHeaderParameter = {} as any;
|
|
55438
|
-
const localVarQueryParameter = {} as any;
|
|
55439
|
-
|
|
55440
|
-
if (timeSpan !== undefined) {
|
|
55441
|
-
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
55442
|
-
}
|
|
55443
|
-
|
|
55444
|
-
if (start !== undefined) {
|
|
55445
|
-
localVarQueryParameter['start'] = start;
|
|
55446
|
-
}
|
|
55447
|
-
|
|
55448
|
-
if (end !== undefined) {
|
|
55449
|
-
localVarQueryParameter['end'] = end;
|
|
55450
|
-
}
|
|
55451
|
-
|
|
55452
|
-
if (businessIds) {
|
|
55453
|
-
localVarQueryParameter['businessIds'] = businessIds;
|
|
55454
|
-
}
|
|
55455
|
-
|
|
55456
|
-
if (timezone !== undefined) {
|
|
55457
|
-
localVarQueryParameter['timezone'] = timezone;
|
|
55458
|
-
}
|
|
55459
|
-
|
|
55460
|
-
|
|
55461
|
-
|
|
55462
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
55463
|
-
|
|
55464
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
55465
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
55466
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
55467
|
-
localVarRequestOptions.data = serializeDataIfNeeded(sendReportEmailDto, localVarRequestOptions, configuration)
|
|
55468
|
-
|
|
55469
|
-
return {
|
|
55470
|
-
url: toPathString(localVarUrlObj),
|
|
55471
|
-
options: localVarRequestOptions,
|
|
55472
|
-
};
|
|
55473
|
-
},
|
|
55474
|
-
/**
|
|
55475
|
-
*
|
|
55476
|
-
* @summary Send end-of-day report via email (V5)
|
|
55477
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
55478
|
-
* @param {string} timezone
|
|
55479
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
55480
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
55481
|
-
* @param {string} [start] Start date
|
|
55482
|
-
* @param {string} [end] End date
|
|
55483
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} [provider] Order source provider (default is MunchiPos)
|
|
55484
|
-
* @param {*} [options] Override http request option.
|
|
55485
|
-
* @throws {RequiredError}
|
|
55486
|
-
*/
|
|
55487
|
-
sendReportEmailV5: async (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 = {}): Promise<RequestArgs> => {
|
|
55488
|
-
// verify required parameter 'businessIds' is not null or undefined
|
|
55489
|
-
assertParamExists('sendReportEmailV5', 'businessIds', businessIds)
|
|
55490
|
-
// verify required parameter 'timezone' is not null or undefined
|
|
55491
|
-
assertParamExists('sendReportEmailV5', 'timezone', timezone)
|
|
55492
|
-
// verify required parameter 'sendReportEmailDto' is not null or undefined
|
|
55493
|
-
assertParamExists('sendReportEmailV5', 'sendReportEmailDto', sendReportEmailDto)
|
|
55494
|
-
const localVarPath = `/api/v5/report/email`;
|
|
55495
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
55496
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
55497
|
-
let baseOptions;
|
|
55498
|
-
if (configuration) {
|
|
55499
|
-
baseOptions = configuration.baseOptions;
|
|
55500
|
-
}
|
|
55501
|
-
|
|
55502
|
-
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
55503
|
-
const localVarHeaderParameter = {} as any;
|
|
55504
|
-
const localVarQueryParameter = {} as any;
|
|
55505
|
-
|
|
55506
|
-
if (timeSpan !== undefined) {
|
|
55507
|
-
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
55508
|
-
}
|
|
55509
|
-
|
|
55510
|
-
if (start !== undefined) {
|
|
55511
|
-
localVarQueryParameter['start'] = start;
|
|
55512
|
-
}
|
|
55513
|
-
|
|
55514
|
-
if (end !== undefined) {
|
|
55515
|
-
localVarQueryParameter['end'] = end;
|
|
55516
|
-
}
|
|
55517
|
-
|
|
55518
|
-
if (businessIds) {
|
|
55519
|
-
localVarQueryParameter['businessIds'] = businessIds;
|
|
55520
|
-
}
|
|
55521
|
-
|
|
55522
|
-
if (timezone !== undefined) {
|
|
55523
|
-
localVarQueryParameter['timezone'] = timezone;
|
|
55524
|
-
}
|
|
55525
|
-
|
|
55526
|
-
if (provider !== undefined) {
|
|
55527
|
-
localVarQueryParameter['provider'] = provider;
|
|
53239
|
+
|
|
53240
|
+
|
|
53241
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
53242
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
53243
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
53244
|
+
|
|
53245
|
+
return {
|
|
53246
|
+
url: toPathString(localVarUrlObj),
|
|
53247
|
+
options: localVarRequestOptions,
|
|
53248
|
+
};
|
|
53249
|
+
},
|
|
53250
|
+
/**
|
|
53251
|
+
*
|
|
53252
|
+
* @summary Send end-of-day report via email (V4)
|
|
53253
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
53254
|
+
* @param {string} timezone
|
|
53255
|
+
* @param {SendReportEmailDto} sendReportEmailDto
|
|
53256
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
53257
|
+
* @param {string} [start] Start date
|
|
53258
|
+
* @param {string} [end] End date
|
|
53259
|
+
* @param {*} [options] Override http request option.
|
|
53260
|
+
* @throws {RequiredError}
|
|
53261
|
+
*/
|
|
53262
|
+
sendReportEmailV4: async (businessIds: Array<number>, timezone: string, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
53263
|
+
// verify required parameter 'businessIds' is not null or undefined
|
|
53264
|
+
assertParamExists('sendReportEmailV4', 'businessIds', businessIds)
|
|
53265
|
+
// verify required parameter 'timezone' is not null or undefined
|
|
53266
|
+
assertParamExists('sendReportEmailV4', 'timezone', timezone)
|
|
53267
|
+
// verify required parameter 'sendReportEmailDto' is not null or undefined
|
|
53268
|
+
assertParamExists('sendReportEmailV4', 'sendReportEmailDto', sendReportEmailDto)
|
|
53269
|
+
const localVarPath = `/api/v4/report/email`;
|
|
53270
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
53271
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
53272
|
+
let baseOptions;
|
|
53273
|
+
if (configuration) {
|
|
53274
|
+
baseOptions = configuration.baseOptions;
|
|
53275
|
+
}
|
|
53276
|
+
|
|
53277
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
53278
|
+
const localVarHeaderParameter = {} as any;
|
|
53279
|
+
const localVarQueryParameter = {} as any;
|
|
53280
|
+
|
|
53281
|
+
if (timeSpan !== undefined) {
|
|
53282
|
+
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
53283
|
+
}
|
|
53284
|
+
|
|
53285
|
+
if (start !== undefined) {
|
|
53286
|
+
localVarQueryParameter['start'] = start;
|
|
53287
|
+
}
|
|
53288
|
+
|
|
53289
|
+
if (end !== undefined) {
|
|
53290
|
+
localVarQueryParameter['end'] = end;
|
|
53291
|
+
}
|
|
53292
|
+
|
|
53293
|
+
if (businessIds) {
|
|
53294
|
+
localVarQueryParameter['businessIds'] = businessIds;
|
|
53295
|
+
}
|
|
53296
|
+
|
|
53297
|
+
if (timezone !== undefined) {
|
|
53298
|
+
localVarQueryParameter['timezone'] = timezone;
|
|
55528
53299
|
}
|
|
55529
53300
|
|
|
55530
53301
|
|
|
@@ -55542,20 +53313,26 @@ export const ReportApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
55542
53313
|
};
|
|
55543
53314
|
},
|
|
55544
53315
|
/**
|
|
55545
|
-
*
|
|
55546
|
-
* @summary
|
|
53316
|
+
*
|
|
53317
|
+
* @summary Send end-of-day report via email (V5)
|
|
53318
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
53319
|
+
* @param {string} timezone
|
|
55547
53320
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
55548
53321
|
* @param {TimeSpan} [timeSpan] Time span
|
|
55549
53322
|
* @param {string} [start] Start date
|
|
55550
53323
|
* @param {string} [end] End date
|
|
55551
|
-
* @param {
|
|
53324
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} [provider] Order source provider (default is MunchiPos)
|
|
55552
53325
|
* @param {*} [options] Override http request option.
|
|
55553
53326
|
* @throws {RequiredError}
|
|
55554
53327
|
*/
|
|
55555
|
-
|
|
53328
|
+
sendReportEmailV5: async (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 = {}): Promise<RequestArgs> => {
|
|
53329
|
+
// verify required parameter 'businessIds' is not null or undefined
|
|
53330
|
+
assertParamExists('sendReportEmailV5', 'businessIds', businessIds)
|
|
53331
|
+
// verify required parameter 'timezone' is not null or undefined
|
|
53332
|
+
assertParamExists('sendReportEmailV5', 'timezone', timezone)
|
|
55556
53333
|
// verify required parameter 'sendReportEmailDto' is not null or undefined
|
|
55557
|
-
assertParamExists('
|
|
55558
|
-
const localVarPath = `/api/
|
|
53334
|
+
assertParamExists('sendReportEmailV5', 'sendReportEmailDto', sendReportEmailDto)
|
|
53335
|
+
const localVarPath = `/api/v5/report/email`;
|
|
55559
53336
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
55560
53337
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
55561
53338
|
let baseOptions;
|
|
@@ -55579,10 +53356,18 @@ export const ReportApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
55579
53356
|
localVarQueryParameter['end'] = end;
|
|
55580
53357
|
}
|
|
55581
53358
|
|
|
53359
|
+
if (businessIds) {
|
|
53360
|
+
localVarQueryParameter['businessIds'] = businessIds;
|
|
53361
|
+
}
|
|
53362
|
+
|
|
55582
53363
|
if (timezone !== undefined) {
|
|
55583
53364
|
localVarQueryParameter['timezone'] = timezone;
|
|
55584
53365
|
}
|
|
55585
53366
|
|
|
53367
|
+
if (provider !== undefined) {
|
|
53368
|
+
localVarQueryParameter['provider'] = provider;
|
|
53369
|
+
}
|
|
53370
|
+
|
|
55586
53371
|
|
|
55587
53372
|
|
|
55588
53373
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
@@ -55623,20 +53408,6 @@ export const ReportApiFp = function(configuration?: Configuration) {
|
|
|
55623
53408
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options);
|
|
55624
53409
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
55625
53410
|
},
|
|
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
|
-
},
|
|
55640
53411
|
/**
|
|
55641
53412
|
*
|
|
55642
53413
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -55685,21 +53456,6 @@ export const ReportApiFp = function(configuration?: Configuration) {
|
|
|
55685
53456
|
const localVarAxiosArgs = await localVarAxiosParamCreator.sendReportEmailV5(businessIds, timezone, sendReportEmailDto, timeSpan, start, end, provider, options);
|
|
55686
53457
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
55687
53458
|
},
|
|
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
|
-
},
|
|
55703
53459
|
}
|
|
55704
53460
|
};
|
|
55705
53461
|
|
|
@@ -55725,19 +53481,6 @@ export const ReportApiFactory = function (configuration?: Configuration, basePat
|
|
|
55725
53481
|
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> {
|
|
55726
53482
|
return localVarFp.getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options).then((request) => request(axios, basePath));
|
|
55727
53483
|
},
|
|
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
|
-
},
|
|
55741
53484
|
/**
|
|
55742
53485
|
*
|
|
55743
53486
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -55783,20 +53526,6 @@ export const ReportApiFactory = function (configuration?: Configuration, basePat
|
|
|
55783
53526
|
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> {
|
|
55784
53527
|
return localVarFp.sendReportEmailV5(businessIds, timezone, sendReportEmailDto, timeSpan, start, end, provider, options).then((request) => request(axios, basePath));
|
|
55785
53528
|
},
|
|
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
|
-
},
|
|
55800
53529
|
};
|
|
55801
53530
|
};
|
|
55802
53531
|
|
|
@@ -55821,19 +53550,6 @@ export interface ReportApiInterface {
|
|
|
55821
53550
|
*/
|
|
55822
53551
|
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>;
|
|
55823
53552
|
|
|
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
|
-
|
|
55837
53553
|
/**
|
|
55838
53554
|
*
|
|
55839
53555
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -55879,20 +53595,6 @@ export interface ReportApiInterface {
|
|
|
55879
53595
|
*/
|
|
55880
53596
|
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>;
|
|
55881
53597
|
|
|
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
|
-
|
|
55896
53598
|
}
|
|
55897
53599
|
|
|
55898
53600
|
/**
|
|
@@ -55919,21 +53621,6 @@ export class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
55919
53621
|
return ReportApiFp(this.configuration).getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options).then((request) => request(this.axios, this.basePath));
|
|
55920
53622
|
}
|
|
55921
53623
|
|
|
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
|
-
|
|
55937
53624
|
/**
|
|
55938
53625
|
*
|
|
55939
53626
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -55984,22 +53671,6 @@ export class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
55984
53671
|
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) {
|
|
55985
53672
|
return ReportApiFp(this.configuration).sendReportEmailV5(businessIds, timezone, sendReportEmailDto, timeSpan, start, end, provider, options).then((request) => request(this.axios, this.basePath));
|
|
55986
53673
|
}
|
|
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
|
-
}
|
|
56003
53674
|
}
|
|
56004
53675
|
|
|
56005
53676
|
|
|
@@ -57094,6 +54765,44 @@ export const ShiftTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
57094
54765
|
|
|
57095
54766
|
|
|
57096
54767
|
|
|
54768
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
54769
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
54770
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
54771
|
+
|
|
54772
|
+
return {
|
|
54773
|
+
url: toPathString(localVarUrlObj),
|
|
54774
|
+
options: localVarRequestOptions,
|
|
54775
|
+
};
|
|
54776
|
+
},
|
|
54777
|
+
/**
|
|
54778
|
+
*
|
|
54779
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
54780
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54781
|
+
* @param {*} [options] Override http request option.
|
|
54782
|
+
* @throws {RequiredError}
|
|
54783
|
+
*/
|
|
54784
|
+
lockTill: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54785
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
54786
|
+
assertParamExists('lockTill', 'businessId', businessId)
|
|
54787
|
+
const localVarPath = `/api/v2/businesses/{businessId}/shifts/lock`
|
|
54788
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
54789
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54790
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
54791
|
+
let baseOptions;
|
|
54792
|
+
if (configuration) {
|
|
54793
|
+
baseOptions = configuration.baseOptions;
|
|
54794
|
+
}
|
|
54795
|
+
|
|
54796
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
54797
|
+
const localVarHeaderParameter = {} as any;
|
|
54798
|
+
const localVarQueryParameter = {} as any;
|
|
54799
|
+
|
|
54800
|
+
// authentication JWT-auth required
|
|
54801
|
+
// http bearer authentication required
|
|
54802
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
54803
|
+
|
|
54804
|
+
|
|
54805
|
+
|
|
57097
54806
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
57098
54807
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
57099
54808
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -57137,6 +54846,51 @@ export const ShiftTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
57137
54846
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
57138
54847
|
localVarRequestOptions.data = serializeDataIfNeeded(unlockTerminalDto, localVarRequestOptions, configuration)
|
|
57139
54848
|
|
|
54849
|
+
return {
|
|
54850
|
+
url: toPathString(localVarUrlObj),
|
|
54851
|
+
options: localVarRequestOptions,
|
|
54852
|
+
};
|
|
54853
|
+
},
|
|
54854
|
+
/**
|
|
54855
|
+
* Team mode only. The server finds the active staff member of the venue with this PIN, checks that their role may open the POS app, and records them as the person working on this till. The answer carries their open shift at the venue, if any; unlike v1, the shift\'s session is not rotated. After 5 wrong PINs the till waits 60 seconds.
|
|
54856
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
54857
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54858
|
+
* @param {string} xPosPin The staff member\'s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
54859
|
+
* @param {*} [options] Override http request option.
|
|
54860
|
+
* @throws {RequiredError}
|
|
54861
|
+
*/
|
|
54862
|
+
unlockTillWithPin: async (businessId: number, xPosPin: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54863
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
54864
|
+
assertParamExists('unlockTillWithPin', 'businessId', businessId)
|
|
54865
|
+
// verify required parameter 'xPosPin' is not null or undefined
|
|
54866
|
+
assertParamExists('unlockTillWithPin', 'xPosPin', xPosPin)
|
|
54867
|
+
const localVarPath = `/api/v2/businesses/{businessId}/shifts/unlock`
|
|
54868
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
54869
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54870
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
54871
|
+
let baseOptions;
|
|
54872
|
+
if (configuration) {
|
|
54873
|
+
baseOptions = configuration.baseOptions;
|
|
54874
|
+
}
|
|
54875
|
+
|
|
54876
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
54877
|
+
const localVarHeaderParameter = {} as any;
|
|
54878
|
+
const localVarQueryParameter = {} as any;
|
|
54879
|
+
|
|
54880
|
+
// authentication JWT-auth required
|
|
54881
|
+
// http bearer authentication required
|
|
54882
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
54883
|
+
|
|
54884
|
+
if (xPosPin != null) {
|
|
54885
|
+
localVarHeaderParameter['X-Pos-Pin'] = String(xPosPin);
|
|
54886
|
+
}
|
|
54887
|
+
|
|
54888
|
+
|
|
54889
|
+
|
|
54890
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
54891
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
54892
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
54893
|
+
|
|
57140
54894
|
return {
|
|
57141
54895
|
url: toPathString(localVarUrlObj),
|
|
57142
54896
|
options: localVarRequestOptions,
|
|
@@ -57185,6 +54939,17 @@ export const ShiftTrackingApiFp = function(configuration?: Configuration) {
|
|
|
57185
54939
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getTodayShift(businessId, employeeId, options);
|
|
57186
54940
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57187
54941
|
},
|
|
54942
|
+
/**
|
|
54943
|
+
*
|
|
54944
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
54945
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54946
|
+
* @param {*} [options] Override http request option.
|
|
54947
|
+
* @throws {RequiredError}
|
|
54948
|
+
*/
|
|
54949
|
+
async lockTill(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
54950
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.lockTill(businessId, options);
|
|
54951
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54952
|
+
},
|
|
57188
54953
|
/**
|
|
57189
54954
|
*
|
|
57190
54955
|
* @param {string} businessId
|
|
@@ -57196,6 +54961,18 @@ export const ShiftTrackingApiFp = function(configuration?: Configuration) {
|
|
|
57196
54961
|
const localVarAxiosArgs = await localVarAxiosParamCreator.unlock(businessId, unlockTerminalDto, options);
|
|
57197
54962
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
57198
54963
|
},
|
|
54964
|
+
/**
|
|
54965
|
+
* Team mode only. The server finds the active staff member of the venue with this PIN, checks that their role may open the POS app, and records them as the person working on this till. The answer carries their open shift at the venue, if any; unlike v1, the shift\'s session is not rotated. After 5 wrong PINs the till waits 60 seconds.
|
|
54966
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
54967
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54968
|
+
* @param {string} xPosPin The staff member\'s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
54969
|
+
* @param {*} [options] Override http request option.
|
|
54970
|
+
* @throws {RequiredError}
|
|
54971
|
+
*/
|
|
54972
|
+
async unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeSessionResponseDto>> {
|
|
54973
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.unlockTillWithPin(businessId, xPosPin, options);
|
|
54974
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54975
|
+
},
|
|
57199
54976
|
}
|
|
57200
54977
|
};
|
|
57201
54978
|
|
|
@@ -57236,6 +55013,16 @@ export const ShiftTrackingApiFactory = function (configuration?: Configuration,
|
|
|
57236
55013
|
getTodayShift(businessId: string, employeeId: string, options?: any): AxiosPromise<TodayShiftResponseDto> {
|
|
57237
55014
|
return localVarFp.getTodayShift(businessId, employeeId, options).then((request) => request(axios, basePath));
|
|
57238
55015
|
},
|
|
55016
|
+
/**
|
|
55017
|
+
*
|
|
55018
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
55019
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55020
|
+
* @param {*} [options] Override http request option.
|
|
55021
|
+
* @throws {RequiredError}
|
|
55022
|
+
*/
|
|
55023
|
+
lockTill(businessId: number, options?: any): AxiosPromise<void> {
|
|
55024
|
+
return localVarFp.lockTill(businessId, options).then((request) => request(axios, basePath));
|
|
55025
|
+
},
|
|
57239
55026
|
/**
|
|
57240
55027
|
*
|
|
57241
55028
|
* @param {string} businessId
|
|
@@ -57246,6 +55033,17 @@ export const ShiftTrackingApiFactory = function (configuration?: Configuration,
|
|
|
57246
55033
|
unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: any): AxiosPromise<EmployeeSessionResponseDto> {
|
|
57247
55034
|
return localVarFp.unlock(businessId, unlockTerminalDto, options).then((request) => request(axios, basePath));
|
|
57248
55035
|
},
|
|
55036
|
+
/**
|
|
55037
|
+
* Team mode only. The server finds the active staff member of the venue with this PIN, checks that their role may open the POS app, and records them as the person working on this till. The answer carries their open shift at the venue, if any; unlike v1, the shift\'s session is not rotated. After 5 wrong PINs the till waits 60 seconds.
|
|
55038
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
55039
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55040
|
+
* @param {string} xPosPin The staff member\'s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
55041
|
+
* @param {*} [options] Override http request option.
|
|
55042
|
+
* @throws {RequiredError}
|
|
55043
|
+
*/
|
|
55044
|
+
unlockTillWithPin(businessId: number, xPosPin: string, options?: any): AxiosPromise<EmployeeSessionResponseDto> {
|
|
55045
|
+
return localVarFp.unlockTillWithPin(businessId, xPosPin, options).then((request) => request(axios, basePath));
|
|
55046
|
+
},
|
|
57249
55047
|
};
|
|
57250
55048
|
};
|
|
57251
55049
|
|
|
@@ -57285,6 +55083,16 @@ export interface ShiftTrackingApiInterface {
|
|
|
57285
55083
|
*/
|
|
57286
55084
|
getTodayShift(businessId: string, employeeId: string, options?: AxiosRequestConfig): AxiosPromise<TodayShiftResponseDto>;
|
|
57287
55085
|
|
|
55086
|
+
/**
|
|
55087
|
+
*
|
|
55088
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
55089
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55090
|
+
* @param {*} [options] Override http request option.
|
|
55091
|
+
* @throws {RequiredError}
|
|
55092
|
+
* @memberof ShiftTrackingApiInterface
|
|
55093
|
+
*/
|
|
55094
|
+
lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
55095
|
+
|
|
57288
55096
|
/**
|
|
57289
55097
|
*
|
|
57290
55098
|
* @param {string} businessId
|
|
@@ -57295,6 +55103,17 @@ export interface ShiftTrackingApiInterface {
|
|
|
57295
55103
|
*/
|
|
57296
55104
|
unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeSessionResponseDto>;
|
|
57297
55105
|
|
|
55106
|
+
/**
|
|
55107
|
+
* Team mode only. The server finds the active staff member of the venue with this PIN, checks that their role may open the POS app, and records them as the person working on this till. The answer carries their open shift at the venue, if any; unlike v1, the shift\'s session is not rotated. After 5 wrong PINs the till waits 60 seconds.
|
|
55108
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
55109
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55110
|
+
* @param {string} xPosPin The staff member\'s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
55111
|
+
* @param {*} [options] Override http request option.
|
|
55112
|
+
* @throws {RequiredError}
|
|
55113
|
+
* @memberof ShiftTrackingApiInterface
|
|
55114
|
+
*/
|
|
55115
|
+
unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig): AxiosPromise<EmployeeSessionResponseDto>;
|
|
55116
|
+
|
|
57298
55117
|
}
|
|
57299
55118
|
|
|
57300
55119
|
/**
|
|
@@ -57340,6 +55159,18 @@ export class ShiftTrackingApi extends BaseAPI implements ShiftTrackingApiInterfa
|
|
|
57340
55159
|
return ShiftTrackingApiFp(this.configuration).getTodayShift(businessId, employeeId, options).then((request) => request(this.axios, this.basePath));
|
|
57341
55160
|
}
|
|
57342
55161
|
|
|
55162
|
+
/**
|
|
55163
|
+
*
|
|
55164
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
55165
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55166
|
+
* @param {*} [options] Override http request option.
|
|
55167
|
+
* @throws {RequiredError}
|
|
55168
|
+
* @memberof ShiftTrackingApi
|
|
55169
|
+
*/
|
|
55170
|
+
public lockTill(businessId: number, options?: AxiosRequestConfig) {
|
|
55171
|
+
return ShiftTrackingApiFp(this.configuration).lockTill(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
55172
|
+
}
|
|
55173
|
+
|
|
57343
55174
|
/**
|
|
57344
55175
|
*
|
|
57345
55176
|
* @param {string} businessId
|
|
@@ -57351,6 +55182,19 @@ export class ShiftTrackingApi extends BaseAPI implements ShiftTrackingApiInterfa
|
|
|
57351
55182
|
public unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig) {
|
|
57352
55183
|
return ShiftTrackingApiFp(this.configuration).unlock(businessId, unlockTerminalDto, options).then((request) => request(this.axios, this.basePath));
|
|
57353
55184
|
}
|
|
55185
|
+
|
|
55186
|
+
/**
|
|
55187
|
+
* Team mode only. The server finds the active staff member of the venue with this PIN, checks that their role may open the POS app, and records them as the person working on this till. The answer carries their open shift at the venue, if any; unlike v1, the shift\'s session is not rotated. After 5 wrong PINs the till waits 60 seconds.
|
|
55188
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
55189
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55190
|
+
* @param {string} xPosPin The staff member\'s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
55191
|
+
* @param {*} [options] Override http request option.
|
|
55192
|
+
* @throws {RequiredError}
|
|
55193
|
+
* @memberof ShiftTrackingApi
|
|
55194
|
+
*/
|
|
55195
|
+
public unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig) {
|
|
55196
|
+
return ShiftTrackingApiFp(this.configuration).unlockTillWithPin(businessId, xPosPin, options).then((request) => request(this.axios, this.basePath));
|
|
55197
|
+
}
|
|
57354
55198
|
}
|
|
57355
55199
|
|
|
57356
55200
|
|