@munchi_oy/core 1.9.132 → 1.9.135
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 +757 -2000
- 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 +1379 -2592
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -83,7 +83,6 @@ export declare const EntityTypeEnum: {
|
|
|
83
83
|
readonly Role: "role";
|
|
84
84
|
readonly Shift: "shift";
|
|
85
85
|
readonly Employee: "employee";
|
|
86
|
-
readonly ActionPasscode: "action_passcode";
|
|
87
86
|
readonly Config: "config";
|
|
88
87
|
readonly Business: "business";
|
|
89
88
|
readonly Suboption: "suboption";
|
|
@@ -124,15 +123,21 @@ export interface AcceptOrderDto {
|
|
|
124
123
|
/**
|
|
125
124
|
*
|
|
126
125
|
* @export
|
|
127
|
-
* @interface
|
|
126
|
+
* @interface ActionPasscodeCheckResponseDto
|
|
128
127
|
*/
|
|
129
|
-
export interface
|
|
128
|
+
export interface ActionPasscodeCheckResponseDto {
|
|
130
129
|
/**
|
|
131
|
-
*
|
|
130
|
+
* The passcode that approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again.
|
|
132
131
|
* @type {string}
|
|
133
|
-
* @memberof
|
|
132
|
+
* @memberof ActionPasscodeCheckResponseDto
|
|
134
133
|
*/
|
|
135
|
-
'
|
|
134
|
+
'passcodeId': string;
|
|
135
|
+
/**
|
|
136
|
+
* The passcode\'s name, as the merchant set it
|
|
137
|
+
* @type {string}
|
|
138
|
+
* @memberof ActionPasscodeCheckResponseDto
|
|
139
|
+
*/
|
|
140
|
+
'name': string;
|
|
136
141
|
}
|
|
137
142
|
/**
|
|
138
143
|
*
|
|
@@ -217,16 +222,6 @@ export interface ActivateKioskOfferDto {
|
|
|
217
222
|
*/
|
|
218
223
|
'catalogId': number;
|
|
219
224
|
}
|
|
220
|
-
/**
|
|
221
|
-
*
|
|
222
|
-
* @export
|
|
223
|
-
* @enum {string}
|
|
224
|
-
*/
|
|
225
|
-
export declare const ActorType: {
|
|
226
|
-
readonly Employee: "employee";
|
|
227
|
-
readonly Tablet: "tablet";
|
|
228
|
-
};
|
|
229
|
-
export type ActorType = typeof ActorType[keyof typeof ActorType];
|
|
230
225
|
/**
|
|
231
226
|
*
|
|
232
227
|
* @export
|
|
@@ -467,16 +462,6 @@ export interface AmountDto {
|
|
|
467
462
|
*/
|
|
468
463
|
'currency': string;
|
|
469
464
|
}
|
|
470
|
-
/**
|
|
471
|
-
*
|
|
472
|
-
* @export
|
|
473
|
-
* @enum {string}
|
|
474
|
-
*/
|
|
475
|
-
export declare const ApprovalKind: {
|
|
476
|
-
readonly Action: "action";
|
|
477
|
-
readonly Screen: "screen";
|
|
478
|
-
};
|
|
479
|
-
export type ApprovalKind = typeof ApprovalKind[keyof typeof ApprovalKind];
|
|
480
465
|
/**
|
|
481
466
|
*
|
|
482
467
|
* @export
|
|
@@ -2452,101 +2437,6 @@ export interface CatalogMethodDtoCapabilities {
|
|
|
2452
2437
|
*/
|
|
2453
2438
|
'checkoutOnly': boolean;
|
|
2454
2439
|
}
|
|
2455
|
-
/**
|
|
2456
|
-
*
|
|
2457
|
-
* @export
|
|
2458
|
-
* @interface CatalogPermissionDto
|
|
2459
|
-
*/
|
|
2460
|
-
export interface CatalogPermissionDto {
|
|
2461
|
-
/**
|
|
2462
|
-
*
|
|
2463
|
-
* @type {string}
|
|
2464
|
-
* @memberof CatalogPermissionDto
|
|
2465
|
-
*/
|
|
2466
|
-
'key': KeyEnum;
|
|
2467
|
-
/**
|
|
2468
|
-
*
|
|
2469
|
-
* @type {string}
|
|
2470
|
-
* @memberof CatalogPermissionDto
|
|
2471
|
-
*/
|
|
2472
|
-
'label': string;
|
|
2473
|
-
/**
|
|
2474
|
-
*
|
|
2475
|
-
* @type {PermissionKind}
|
|
2476
|
-
* @memberof CatalogPermissionDto
|
|
2477
|
-
*/
|
|
2478
|
-
'kind': PermissionKind;
|
|
2479
|
-
}
|
|
2480
|
-
export declare const KeyEnum: {
|
|
2481
|
-
readonly AccessPosApp: "Access::PosApp";
|
|
2482
|
-
readonly PagePos: "Page::Pos";
|
|
2483
|
-
readonly PageOpenOrders: "Page::OpenOrders";
|
|
2484
|
-
readonly PageOrders: "Page::Orders";
|
|
2485
|
-
readonly PageTransactions: "Page::Transactions";
|
|
2486
|
-
readonly PageProducts: "Page::Products";
|
|
2487
|
-
readonly PageReports: "Page::Reports";
|
|
2488
|
-
readonly PageSettings: "Page::Settings";
|
|
2489
|
-
readonly PageFloorPlan: "Page::FloorPlan";
|
|
2490
|
-
readonly Cart: "Cart::*";
|
|
2491
|
-
readonly CartAddItem: "Cart::AddItem";
|
|
2492
|
-
readonly CartRemoveItem: "Cart::RemoveItem";
|
|
2493
|
-
readonly CartApplyDiscount: "Cart::ApplyDiscount";
|
|
2494
|
-
readonly CartVoidItem: "Cart::VoidItem";
|
|
2495
|
-
readonly CartClear: "Cart::Clear";
|
|
2496
|
-
readonly CartRemoveDiscount: "Cart::RemoveDiscount";
|
|
2497
|
-
readonly CartVoidPayment: "Cart::VoidPayment";
|
|
2498
|
-
readonly Cash: "Cash::*";
|
|
2499
|
-
readonly CashOpenDay: "Cash::OpenDay";
|
|
2500
|
-
readonly CashCloseDay: "Cash::CloseDay";
|
|
2501
|
-
readonly CashCashIn: "Cash::CashIn";
|
|
2502
|
-
readonly CashCashOut: "Cash::CashOut";
|
|
2503
|
-
readonly CashOpenDrawer: "Cash::OpenDrawer";
|
|
2504
|
-
readonly CashPrintReport: "Cash::PrintReport";
|
|
2505
|
-
readonly CashSendReport: "Cash::SendReport";
|
|
2506
|
-
readonly Transaction: "Transaction::*";
|
|
2507
|
-
readonly TransactionRefund: "Transaction::Refund";
|
|
2508
|
-
readonly TransactionViewAll: "Transaction::ViewAll";
|
|
2509
|
-
readonly TransactionViewTips: "Transaction::ViewTips";
|
|
2510
|
-
readonly TransactionViewSurcharges: "Transaction::ViewSurcharges";
|
|
2511
|
-
readonly TransactionViewDiscounts: "Transaction::ViewDiscounts";
|
|
2512
|
-
readonly TransactionTotals: "TransactionTotals::*";
|
|
2513
|
-
readonly TransactionTotalsOrders: "TransactionTotals::Orders";
|
|
2514
|
-
readonly TransactionTotalsSales: "TransactionTotals::Sales";
|
|
2515
|
-
readonly TransactionTotalsRejectedOrders: "TransactionTotals::RejectedOrders";
|
|
2516
|
-
readonly TransactionTotalsRejectedSales: "TransactionTotals::RejectedSales";
|
|
2517
|
-
readonly Order: "Order::*";
|
|
2518
|
-
readonly OrderSendReceipt: "Order::SendReceipt";
|
|
2519
|
-
readonly OpenOrdersDelete: "OpenOrders::Delete";
|
|
2520
|
-
readonly OpenOrdersSendToKitchen: "OpenOrders::SendToKitchen";
|
|
2521
|
-
readonly OpenOrdersFireCourse: "OpenOrders::FireCourse";
|
|
2522
|
-
readonly Shift: "Shift::*";
|
|
2523
|
-
readonly ShiftForceClockOut: "Shift::ForceClockOut";
|
|
2524
|
-
readonly FloorPlan: "FloorPlan::*";
|
|
2525
|
-
readonly FloorPlanEditLayout: "FloorPlan::EditLayout";
|
|
2526
|
-
readonly FloorPlanChangeTableStatus: "FloorPlan::ChangeTableStatus";
|
|
2527
|
-
readonly FloorPlanManageSections: "FloorPlan::ManageSections";
|
|
2528
|
-
readonly Settings: "Settings::*";
|
|
2529
|
-
readonly SettingsEditProfile: "Settings::EditProfile";
|
|
2530
|
-
readonly Report: "Report::*";
|
|
2531
|
-
readonly ReportSendEmail: "Report::SendEmail";
|
|
2532
|
-
readonly ReportViewAll: "Report::ViewAll";
|
|
2533
|
-
readonly ReportViewSalesSummary: "Report::ViewSalesSummary";
|
|
2534
|
-
readonly ReportViewPaymentMethods: "Report::ViewPaymentMethods";
|
|
2535
|
-
readonly ReportViewItemSales: "Report::ViewItemSales";
|
|
2536
|
-
readonly ReportViewCashLogs: "Report::ViewCashLogs";
|
|
2537
|
-
readonly ReportTotals: "ReportTotals::*";
|
|
2538
|
-
readonly ReportTotalsOrders: "ReportTotals::Orders";
|
|
2539
|
-
readonly ReportTotalsSales: "ReportTotals::Sales";
|
|
2540
|
-
readonly ReportTotalsTips: "ReportTotals::Tips";
|
|
2541
|
-
readonly ReportTotalsSurcharges: "ReportTotals::Surcharges";
|
|
2542
|
-
readonly ReportTotalsRejectedOrders: "ReportTotals::RejectedOrders";
|
|
2543
|
-
readonly ReportTotalsRejectedSales: "ReportTotals::RejectedSales";
|
|
2544
|
-
readonly ReportTotalsAverageSale: "ReportTotals::AverageSale";
|
|
2545
|
-
readonly ReportTotalsItems: "ReportTotals::Items";
|
|
2546
|
-
readonly ReportTotalsRefunds: "ReportTotals::Refunds";
|
|
2547
|
-
readonly ReportTotalsDiscounts: "ReportTotals::Discounts";
|
|
2548
|
-
};
|
|
2549
|
-
export type KeyEnum = typeof KeyEnum[keyof typeof KeyEnum];
|
|
2550
2440
|
/**
|
|
2551
2441
|
*
|
|
2552
2442
|
* @export
|
|
@@ -2866,6 +2756,19 @@ export interface ChargeStatusResponseDto {
|
|
|
2866
2756
|
*/
|
|
2867
2757
|
'errorCode'?: string | null;
|
|
2868
2758
|
}
|
|
2759
|
+
/**
|
|
2760
|
+
*
|
|
2761
|
+
* @export
|
|
2762
|
+
* @interface CheckActionPasscodeDto
|
|
2763
|
+
*/
|
|
2764
|
+
export interface CheckActionPasscodeDto {
|
|
2765
|
+
/**
|
|
2766
|
+
*
|
|
2767
|
+
* @type {PosPermission}
|
|
2768
|
+
* @memberof CheckActionPasscodeDto
|
|
2769
|
+
*/
|
|
2770
|
+
'key': PosPermission;
|
|
2771
|
+
}
|
|
2869
2772
|
/**
|
|
2870
2773
|
*
|
|
2871
2774
|
* @export
|
|
@@ -5784,183 +5687,6 @@ export interface EndOfDayReportDtoV4TaxBreakdown {
|
|
|
5784
5687
|
*/
|
|
5785
5688
|
'totalTaxAmount': number;
|
|
5786
5689
|
}
|
|
5787
|
-
/**
|
|
5788
|
-
*
|
|
5789
|
-
* @export
|
|
5790
|
-
* @interface EndOfDayReportResponseDtoV6
|
|
5791
|
-
*/
|
|
5792
|
-
export interface EndOfDayReportResponseDtoV6 {
|
|
5793
|
-
/**
|
|
5794
|
-
* Report generated at
|
|
5795
|
-
* @type {string}
|
|
5796
|
-
* @memberof EndOfDayReportResponseDtoV6
|
|
5797
|
-
*/
|
|
5798
|
-
'reportGeneratedAt': string;
|
|
5799
|
-
/**
|
|
5800
|
-
* Report date start
|
|
5801
|
-
* @type {string}
|
|
5802
|
-
* @memberof EndOfDayReportResponseDtoV6
|
|
5803
|
-
*/
|
|
5804
|
-
'reportDateStart': string;
|
|
5805
|
-
/**
|
|
5806
|
-
* Report date end
|
|
5807
|
-
* @type {string}
|
|
5808
|
-
* @memberof EndOfDayReportResponseDtoV6
|
|
5809
|
-
*/
|
|
5810
|
-
'reportDateEnd': string;
|
|
5811
|
-
/**
|
|
5812
|
-
* Business ID
|
|
5813
|
-
* @type {number}
|
|
5814
|
-
* @memberof EndOfDayReportResponseDtoV6
|
|
5815
|
-
*/
|
|
5816
|
-
'businessId': number;
|
|
5817
|
-
/**
|
|
5818
|
-
*
|
|
5819
|
-
* @type {EndOfDayReportResponseDtoV6SalesSummary}
|
|
5820
|
-
* @memberof EndOfDayReportResponseDtoV6
|
|
5821
|
-
*/
|
|
5822
|
-
'salesSummary': EndOfDayReportResponseDtoV6SalesSummary;
|
|
5823
|
-
/**
|
|
5824
|
-
* Omitted without Report::ViewPaymentMethods
|
|
5825
|
-
* @type {Array<PaymentDetailsDto>}
|
|
5826
|
-
* @memberof EndOfDayReportResponseDtoV6
|
|
5827
|
-
*/
|
|
5828
|
-
'paymentMethodDetails'?: Array<PaymentDetailsDto>;
|
|
5829
|
-
/**
|
|
5830
|
-
*
|
|
5831
|
-
* @type {EndOfDayReportResponseDtoV6TaxBreakdown}
|
|
5832
|
-
* @memberof EndOfDayReportResponseDtoV6
|
|
5833
|
-
*/
|
|
5834
|
-
'taxBreakdown'?: EndOfDayReportResponseDtoV6TaxBreakdown;
|
|
5835
|
-
/**
|
|
5836
|
-
* Omitted without Report::ViewItemSales
|
|
5837
|
-
* @type {Array<ItemBreakdownDto>}
|
|
5838
|
-
* @memberof EndOfDayReportResponseDtoV6
|
|
5839
|
-
*/
|
|
5840
|
-
'itemBreakdown'?: Array<ItemBreakdownDto>;
|
|
5841
|
-
}
|
|
5842
|
-
/**
|
|
5843
|
-
* Each total is omitted without its ReportTotals key; totalTransactions needs Report::ViewPaymentMethods
|
|
5844
|
-
* @export
|
|
5845
|
-
* @interface EndOfDayReportResponseDtoV6SalesSummary
|
|
5846
|
-
*/
|
|
5847
|
-
export interface EndOfDayReportResponseDtoV6SalesSummary {
|
|
5848
|
-
/**
|
|
5849
|
-
* Total number of orders
|
|
5850
|
-
* @type {number}
|
|
5851
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5852
|
-
*/
|
|
5853
|
-
'totalOrders'?: number;
|
|
5854
|
-
/**
|
|
5855
|
-
* Total sales amount
|
|
5856
|
-
* @type {number}
|
|
5857
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5858
|
-
*/
|
|
5859
|
-
'totalSales'?: number;
|
|
5860
|
-
/**
|
|
5861
|
-
* Net sales amount after adjustments
|
|
5862
|
-
* @type {number}
|
|
5863
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5864
|
-
*/
|
|
5865
|
-
'netSales'?: number;
|
|
5866
|
-
/**
|
|
5867
|
-
* Total amount actually paid
|
|
5868
|
-
* @type {number}
|
|
5869
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5870
|
-
*/
|
|
5871
|
-
'totalPaid'?: number;
|
|
5872
|
-
/**
|
|
5873
|
-
* Total difference
|
|
5874
|
-
* @type {number}
|
|
5875
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5876
|
-
*/
|
|
5877
|
-
'totalDifference'?: number;
|
|
5878
|
-
/**
|
|
5879
|
-
* Total transactions
|
|
5880
|
-
* @type {number}
|
|
5881
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5882
|
-
*/
|
|
5883
|
-
'totalTransactions'?: number;
|
|
5884
|
-
/**
|
|
5885
|
-
* Number of rejected orders
|
|
5886
|
-
* @type {number}
|
|
5887
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5888
|
-
*/
|
|
5889
|
-
'rejectedOrders'?: number;
|
|
5890
|
-
/**
|
|
5891
|
-
* Total rejected sales amount
|
|
5892
|
-
* @type {number}
|
|
5893
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5894
|
-
*/
|
|
5895
|
-
'rejectedSales'?: number;
|
|
5896
|
-
/**
|
|
5897
|
-
* Average sales per order
|
|
5898
|
-
* @type {number}
|
|
5899
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5900
|
-
*/
|
|
5901
|
-
'averageSales'?: number;
|
|
5902
|
-
/**
|
|
5903
|
-
* Total number of items sold
|
|
5904
|
-
* @type {number}
|
|
5905
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5906
|
-
*/
|
|
5907
|
-
'totalItemsCount'?: number;
|
|
5908
|
-
/**
|
|
5909
|
-
* Total refund amount
|
|
5910
|
-
* @type {number}
|
|
5911
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5912
|
-
*/
|
|
5913
|
-
'totalRefunds'?: number;
|
|
5914
|
-
/**
|
|
5915
|
-
* Total discount amount given
|
|
5916
|
-
* @type {number}
|
|
5917
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5918
|
-
*/
|
|
5919
|
-
'totalDiscounts'?: number;
|
|
5920
|
-
/**
|
|
5921
|
-
* Total voucher forfeited amount in cents
|
|
5922
|
-
* @type {number}
|
|
5923
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5924
|
-
*/
|
|
5925
|
-
'totalVoucherForfeited'?: number;
|
|
5926
|
-
/**
|
|
5927
|
-
* Total amount of all payment methods
|
|
5928
|
-
* @type {number}
|
|
5929
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5930
|
-
*/
|
|
5931
|
-
'totalPaymentAmount'?: number;
|
|
5932
|
-
/**
|
|
5933
|
-
* Total tip amount in cents
|
|
5934
|
-
* @type {number}
|
|
5935
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5936
|
-
*/
|
|
5937
|
-
'totalTipAmount'?: number;
|
|
5938
|
-
/**
|
|
5939
|
-
* Total surcharge amount in cents
|
|
5940
|
-
* @type {number}
|
|
5941
|
-
* @memberof EndOfDayReportResponseDtoV6SalesSummary
|
|
5942
|
-
*/
|
|
5943
|
-
'totalSurchargeAmount'?: number;
|
|
5944
|
-
}
|
|
5945
|
-
/**
|
|
5946
|
-
* Omitted without Report::ViewSalesSummary
|
|
5947
|
-
* @export
|
|
5948
|
-
* @interface EndOfDayReportResponseDtoV6TaxBreakdown
|
|
5949
|
-
*/
|
|
5950
|
-
export interface EndOfDayReportResponseDtoV6TaxBreakdown {
|
|
5951
|
-
/**
|
|
5952
|
-
* Tax breakdown by rate
|
|
5953
|
-
* @type {Array<TaxRateItem>}
|
|
5954
|
-
* @memberof EndOfDayReportResponseDtoV6TaxBreakdown
|
|
5955
|
-
*/
|
|
5956
|
-
'taxRates': Array<TaxRateItem>;
|
|
5957
|
-
/**
|
|
5958
|
-
* Total tax amount
|
|
5959
|
-
* @type {number}
|
|
5960
|
-
* @memberof EndOfDayReportResponseDtoV6TaxBreakdown
|
|
5961
|
-
*/
|
|
5962
|
-
'totalTaxAmount': number;
|
|
5963
|
-
}
|
|
5964
5690
|
/**
|
|
5965
5691
|
*
|
|
5966
5692
|
* @export
|
|
@@ -5975,7 +5701,6 @@ export declare const EntityType: {
|
|
|
5975
5701
|
readonly Role: "role";
|
|
5976
5702
|
readonly Shift: "shift";
|
|
5977
5703
|
readonly Employee: "employee";
|
|
5978
|
-
readonly ActionPasscode: "action_passcode";
|
|
5979
5704
|
readonly Config: "config";
|
|
5980
5705
|
readonly Business: "business";
|
|
5981
5706
|
readonly Suboption: "suboption";
|
|
@@ -7669,57 +7394,6 @@ export interface InvoiceCompanyResponseDto {
|
|
|
7669
7394
|
*/
|
|
7670
7395
|
'updatedAt': string;
|
|
7671
7396
|
}
|
|
7672
|
-
/**
|
|
7673
|
-
*
|
|
7674
|
-
* @export
|
|
7675
|
-
* @interface IssueActionApprovalDto
|
|
7676
|
-
*/
|
|
7677
|
-
export interface IssueActionApprovalDto {
|
|
7678
|
-
/**
|
|
7679
|
-
* The passcode PIN, 4 to 6 digits
|
|
7680
|
-
* @type {string}
|
|
7681
|
-
* @memberof IssueActionApprovalDto
|
|
7682
|
-
*/
|
|
7683
|
-
'pin': string;
|
|
7684
|
-
/**
|
|
7685
|
-
*
|
|
7686
|
-
* @type {PosPermission}
|
|
7687
|
-
* @memberof IssueActionApprovalDto
|
|
7688
|
-
*/
|
|
7689
|
-
'permissionKey': PosPermission;
|
|
7690
|
-
/**
|
|
7691
|
-
*
|
|
7692
|
-
* @type {ApprovalKind}
|
|
7693
|
-
* @memberof IssueActionApprovalDto
|
|
7694
|
-
*/
|
|
7695
|
-
'kind': ApprovalKind;
|
|
7696
|
-
}
|
|
7697
|
-
/**
|
|
7698
|
-
*
|
|
7699
|
-
* @export
|
|
7700
|
-
* @interface IssueEmployeeTokenDto
|
|
7701
|
-
*/
|
|
7702
|
-
export interface IssueEmployeeTokenDto {
|
|
7703
|
-
/**
|
|
7704
|
-
* The employee\'s PIN, 4 to 6 digits
|
|
7705
|
-
* @type {string}
|
|
7706
|
-
* @memberof IssueEmployeeTokenDto
|
|
7707
|
-
*/
|
|
7708
|
-
'pin': string;
|
|
7709
|
-
}
|
|
7710
|
-
/**
|
|
7711
|
-
*
|
|
7712
|
-
* @export
|
|
7713
|
-
* @interface IssueTabletTokenDto
|
|
7714
|
-
*/
|
|
7715
|
-
export interface IssueTabletTokenDto {
|
|
7716
|
-
/**
|
|
7717
|
-
* The venue the tablet signs in to
|
|
7718
|
-
* @type {number}
|
|
7719
|
-
* @memberof IssueTabletTokenDto
|
|
7720
|
-
*/
|
|
7721
|
-
'businessId': number;
|
|
7722
|
-
}
|
|
7723
7397
|
/**
|
|
7724
7398
|
*
|
|
7725
7399
|
* @export
|
|
@@ -7874,98 +7548,6 @@ export interface ItemPriceDto {
|
|
|
7874
7548
|
*/
|
|
7875
7549
|
'priceBreakdown': ItemPriceBreakdownDto;
|
|
7876
7550
|
}
|
|
7877
|
-
/**
|
|
7878
|
-
*
|
|
7879
|
-
* @export
|
|
7880
|
-
* @interface ItemPriceDtoV6
|
|
7881
|
-
*/
|
|
7882
|
-
export interface ItemPriceDtoV6 {
|
|
7883
|
-
/**
|
|
7884
|
-
*
|
|
7885
|
-
* @type {MoneyDto}
|
|
7886
|
-
* @memberof ItemPriceDtoV6
|
|
7887
|
-
*/
|
|
7888
|
-
'unitPrice': MoneyDto;
|
|
7889
|
-
/**
|
|
7890
|
-
*
|
|
7891
|
-
* @type {MoneyDto}
|
|
7892
|
-
* @memberof ItemPriceDtoV6
|
|
7893
|
-
*/
|
|
7894
|
-
'basePrice': MoneyDto;
|
|
7895
|
-
/**
|
|
7896
|
-
*
|
|
7897
|
-
* @type {number}
|
|
7898
|
-
* @memberof ItemPriceDtoV6
|
|
7899
|
-
*/
|
|
7900
|
-
'vatPercentage': number;
|
|
7901
|
-
/**
|
|
7902
|
-
*
|
|
7903
|
-
* @type {MoneyDto}
|
|
7904
|
-
* @memberof ItemPriceDtoV6
|
|
7905
|
-
*/
|
|
7906
|
-
'total': MoneyDto;
|
|
7907
|
-
/**
|
|
7908
|
-
*
|
|
7909
|
-
* @type {ItemPriceDtoV6PriceBreakdown}
|
|
7910
|
-
* @memberof ItemPriceDtoV6
|
|
7911
|
-
*/
|
|
7912
|
-
'priceBreakdown'?: ItemPriceDtoV6PriceBreakdown;
|
|
7913
|
-
}
|
|
7914
|
-
/**
|
|
7915
|
-
* Omitted without Transaction::ViewDiscounts
|
|
7916
|
-
* @export
|
|
7917
|
-
* @interface ItemPriceDtoV6PriceBreakdown
|
|
7918
|
-
*/
|
|
7919
|
-
export interface ItemPriceDtoV6PriceBreakdown {
|
|
7920
|
-
/**
|
|
7921
|
-
*
|
|
7922
|
-
* @type {MoneyDto}
|
|
7923
|
-
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
7924
|
-
*/
|
|
7925
|
-
'totalBeforeDiscounts': MoneyDto;
|
|
7926
|
-
/**
|
|
7927
|
-
*
|
|
7928
|
-
* @type {MoneyDto}
|
|
7929
|
-
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
7930
|
-
*/
|
|
7931
|
-
'subtotalItemDiscounts': MoneyDto;
|
|
7932
|
-
/**
|
|
7933
|
-
*
|
|
7934
|
-
* @type {MoneyDto}
|
|
7935
|
-
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
7936
|
-
*/
|
|
7937
|
-
'subtotalBasketDiscounts': MoneyDto;
|
|
7938
|
-
/**
|
|
7939
|
-
*
|
|
7940
|
-
* @type {MoneyDto}
|
|
7941
|
-
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
7942
|
-
*/
|
|
7943
|
-
'totalDiscounts': MoneyDto;
|
|
7944
|
-
/**
|
|
7945
|
-
*
|
|
7946
|
-
* @type {MoneyDto}
|
|
7947
|
-
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
7948
|
-
*/
|
|
7949
|
-
'basePriceBeforeDiscounts': MoneyDto;
|
|
7950
|
-
/**
|
|
7951
|
-
*
|
|
7952
|
-
* @type {MoneyDto}
|
|
7953
|
-
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
7954
|
-
*/
|
|
7955
|
-
'unitPriceBeforeDiscounts': MoneyDto;
|
|
7956
|
-
/**
|
|
7957
|
-
*
|
|
7958
|
-
* @type {MoneyDto}
|
|
7959
|
-
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
7960
|
-
*/
|
|
7961
|
-
'subtotalOptionsBasketDiscounts': MoneyDto;
|
|
7962
|
-
/**
|
|
7963
|
-
*
|
|
7964
|
-
* @type {MoneyDto}
|
|
7965
|
-
* @memberof ItemPriceDtoV6PriceBreakdown
|
|
7966
|
-
*/
|
|
7967
|
-
'subtotalOptionsItemDiscounts': MoneyDto;
|
|
7968
|
-
}
|
|
7969
7551
|
/**
|
|
7970
7552
|
*
|
|
7971
7553
|
* @export
|
|
@@ -9576,7 +9158,7 @@ export interface LoginResponseDtoUserInfo {
|
|
|
9576
9158
|
*/
|
|
9577
9159
|
export interface LogoutResponseDto {
|
|
9578
9160
|
/**
|
|
9579
|
-
*
|
|
9161
|
+
* Confirmation that the session was deleted; the tokens of that session stop working
|
|
9580
9162
|
* @type {string}
|
|
9581
9163
|
* @memberof LogoutResponseDto
|
|
9582
9164
|
*/
|
|
@@ -16306,118 +15888,6 @@ export interface PermissionDto {
|
|
|
16306
15888
|
*/
|
|
16307
15889
|
'enabled': boolean;
|
|
16308
15890
|
}
|
|
16309
|
-
/**
|
|
16310
|
-
*
|
|
16311
|
-
* @export
|
|
16312
|
-
* @interface PermissionGroupDto
|
|
16313
|
-
*/
|
|
16314
|
-
export interface PermissionGroupDto {
|
|
16315
|
-
/**
|
|
16316
|
-
*
|
|
16317
|
-
* @type {object}
|
|
16318
|
-
* @memberof PermissionGroupDto
|
|
16319
|
-
*/
|
|
16320
|
-
'id': object;
|
|
16321
|
-
/**
|
|
16322
|
-
*
|
|
16323
|
-
* @type {string}
|
|
16324
|
-
* @memberof PermissionGroupDto
|
|
16325
|
-
*/
|
|
16326
|
-
'label': string;
|
|
16327
|
-
/**
|
|
16328
|
-
* The key that grants every permission in the group at once, if the group has one
|
|
16329
|
-
* @type {string}
|
|
16330
|
-
* @memberof PermissionGroupDto
|
|
16331
|
-
*/
|
|
16332
|
-
'familyKey': FamilyKeyEnum;
|
|
16333
|
-
/**
|
|
16334
|
-
*
|
|
16335
|
-
* @type {Array<CatalogPermissionDto>}
|
|
16336
|
-
* @memberof PermissionGroupDto
|
|
16337
|
-
*/
|
|
16338
|
-
'permissions': Array<CatalogPermissionDto>;
|
|
16339
|
-
}
|
|
16340
|
-
export declare const FamilyKeyEnum: {
|
|
16341
|
-
readonly AccessPosApp: "Access::PosApp";
|
|
16342
|
-
readonly PagePos: "Page::Pos";
|
|
16343
|
-
readonly PageOpenOrders: "Page::OpenOrders";
|
|
16344
|
-
readonly PageOrders: "Page::Orders";
|
|
16345
|
-
readonly PageTransactions: "Page::Transactions";
|
|
16346
|
-
readonly PageProducts: "Page::Products";
|
|
16347
|
-
readonly PageReports: "Page::Reports";
|
|
16348
|
-
readonly PageSettings: "Page::Settings";
|
|
16349
|
-
readonly PageFloorPlan: "Page::FloorPlan";
|
|
16350
|
-
readonly Cart: "Cart::*";
|
|
16351
|
-
readonly CartAddItem: "Cart::AddItem";
|
|
16352
|
-
readonly CartRemoveItem: "Cart::RemoveItem";
|
|
16353
|
-
readonly CartApplyDiscount: "Cart::ApplyDiscount";
|
|
16354
|
-
readonly CartVoidItem: "Cart::VoidItem";
|
|
16355
|
-
readonly CartClear: "Cart::Clear";
|
|
16356
|
-
readonly CartRemoveDiscount: "Cart::RemoveDiscount";
|
|
16357
|
-
readonly CartVoidPayment: "Cart::VoidPayment";
|
|
16358
|
-
readonly Cash: "Cash::*";
|
|
16359
|
-
readonly CashOpenDay: "Cash::OpenDay";
|
|
16360
|
-
readonly CashCloseDay: "Cash::CloseDay";
|
|
16361
|
-
readonly CashCashIn: "Cash::CashIn";
|
|
16362
|
-
readonly CashCashOut: "Cash::CashOut";
|
|
16363
|
-
readonly CashOpenDrawer: "Cash::OpenDrawer";
|
|
16364
|
-
readonly CashPrintReport: "Cash::PrintReport";
|
|
16365
|
-
readonly CashSendReport: "Cash::SendReport";
|
|
16366
|
-
readonly Transaction: "Transaction::*";
|
|
16367
|
-
readonly TransactionRefund: "Transaction::Refund";
|
|
16368
|
-
readonly TransactionViewAll: "Transaction::ViewAll";
|
|
16369
|
-
readonly TransactionViewTips: "Transaction::ViewTips";
|
|
16370
|
-
readonly TransactionViewSurcharges: "Transaction::ViewSurcharges";
|
|
16371
|
-
readonly TransactionViewDiscounts: "Transaction::ViewDiscounts";
|
|
16372
|
-
readonly TransactionTotals: "TransactionTotals::*";
|
|
16373
|
-
readonly TransactionTotalsOrders: "TransactionTotals::Orders";
|
|
16374
|
-
readonly TransactionTotalsSales: "TransactionTotals::Sales";
|
|
16375
|
-
readonly TransactionTotalsRejectedOrders: "TransactionTotals::RejectedOrders";
|
|
16376
|
-
readonly TransactionTotalsRejectedSales: "TransactionTotals::RejectedSales";
|
|
16377
|
-
readonly Order: "Order::*";
|
|
16378
|
-
readonly OrderSendReceipt: "Order::SendReceipt";
|
|
16379
|
-
readonly OpenOrdersDelete: "OpenOrders::Delete";
|
|
16380
|
-
readonly OpenOrdersSendToKitchen: "OpenOrders::SendToKitchen";
|
|
16381
|
-
readonly OpenOrdersFireCourse: "OpenOrders::FireCourse";
|
|
16382
|
-
readonly Shift: "Shift::*";
|
|
16383
|
-
readonly ShiftForceClockOut: "Shift::ForceClockOut";
|
|
16384
|
-
readonly FloorPlan: "FloorPlan::*";
|
|
16385
|
-
readonly FloorPlanEditLayout: "FloorPlan::EditLayout";
|
|
16386
|
-
readonly FloorPlanChangeTableStatus: "FloorPlan::ChangeTableStatus";
|
|
16387
|
-
readonly FloorPlanManageSections: "FloorPlan::ManageSections";
|
|
16388
|
-
readonly Settings: "Settings::*";
|
|
16389
|
-
readonly SettingsEditProfile: "Settings::EditProfile";
|
|
16390
|
-
readonly Report: "Report::*";
|
|
16391
|
-
readonly ReportSendEmail: "Report::SendEmail";
|
|
16392
|
-
readonly ReportViewAll: "Report::ViewAll";
|
|
16393
|
-
readonly ReportViewSalesSummary: "Report::ViewSalesSummary";
|
|
16394
|
-
readonly ReportViewPaymentMethods: "Report::ViewPaymentMethods";
|
|
16395
|
-
readonly ReportViewItemSales: "Report::ViewItemSales";
|
|
16396
|
-
readonly ReportViewCashLogs: "Report::ViewCashLogs";
|
|
16397
|
-
readonly ReportTotals: "ReportTotals::*";
|
|
16398
|
-
readonly ReportTotalsOrders: "ReportTotals::Orders";
|
|
16399
|
-
readonly ReportTotalsSales: "ReportTotals::Sales";
|
|
16400
|
-
readonly ReportTotalsTips: "ReportTotals::Tips";
|
|
16401
|
-
readonly ReportTotalsSurcharges: "ReportTotals::Surcharges";
|
|
16402
|
-
readonly ReportTotalsRejectedOrders: "ReportTotals::RejectedOrders";
|
|
16403
|
-
readonly ReportTotalsRejectedSales: "ReportTotals::RejectedSales";
|
|
16404
|
-
readonly ReportTotalsAverageSale: "ReportTotals::AverageSale";
|
|
16405
|
-
readonly ReportTotalsItems: "ReportTotals::Items";
|
|
16406
|
-
readonly ReportTotalsRefunds: "ReportTotals::Refunds";
|
|
16407
|
-
readonly ReportTotalsDiscounts: "ReportTotals::Discounts";
|
|
16408
|
-
};
|
|
16409
|
-
export type FamilyKeyEnum = typeof FamilyKeyEnum[keyof typeof FamilyKeyEnum];
|
|
16410
|
-
/**
|
|
16411
|
-
*
|
|
16412
|
-
* @export
|
|
16413
|
-
* @enum {string}
|
|
16414
|
-
*/
|
|
16415
|
-
export declare const PermissionKind: {
|
|
16416
|
-
readonly Screen: "screen";
|
|
16417
|
-
readonly Action: "action";
|
|
16418
|
-
readonly Visibility: "visibility";
|
|
16419
|
-
};
|
|
16420
|
-
export type PermissionKind = typeof PermissionKind[keyof typeof PermissionKind];
|
|
16421
15891
|
/**
|
|
16422
15892
|
*
|
|
16423
15893
|
* @export
|
|
@@ -16437,31 +15907,6 @@ export interface PermissionRuleDto {
|
|
|
16437
15907
|
*/
|
|
16438
15908
|
'enabled': boolean;
|
|
16439
15909
|
}
|
|
16440
|
-
/**
|
|
16441
|
-
*
|
|
16442
|
-
* @export
|
|
16443
|
-
* @interface PermissionRuleDtoV6
|
|
16444
|
-
*/
|
|
16445
|
-
export interface PermissionRuleDtoV6 {
|
|
16446
|
-
/**
|
|
16447
|
-
*
|
|
16448
|
-
* @type {string}
|
|
16449
|
-
* @memberof PermissionRuleDtoV6
|
|
16450
|
-
*/
|
|
16451
|
-
'id': string;
|
|
16452
|
-
/**
|
|
16453
|
-
*
|
|
16454
|
-
* @type {PosPermission}
|
|
16455
|
-
* @memberof PermissionRuleDtoV6
|
|
16456
|
-
*/
|
|
16457
|
-
'key': PosPermission;
|
|
16458
|
-
/**
|
|
16459
|
-
*
|
|
16460
|
-
* @type {boolean}
|
|
16461
|
-
* @memberof PermissionRuleDtoV6
|
|
16462
|
-
*/
|
|
16463
|
-
'enabled': boolean;
|
|
16464
|
-
}
|
|
16465
15910
|
/**
|
|
16466
15911
|
*
|
|
16467
15912
|
* @export
|
|
@@ -16615,31 +16060,6 @@ export interface PosActionPasscodeDto {
|
|
|
16615
16060
|
*/
|
|
16616
16061
|
'pinHash': string;
|
|
16617
16062
|
}
|
|
16618
|
-
/**
|
|
16619
|
-
*
|
|
16620
|
-
* @export
|
|
16621
|
-
* @interface PosActionPasscodeDtoV6
|
|
16622
|
-
*/
|
|
16623
|
-
export interface PosActionPasscodeDtoV6 {
|
|
16624
|
-
/**
|
|
16625
|
-
*
|
|
16626
|
-
* @type {string}
|
|
16627
|
-
* @memberof PosActionPasscodeDtoV6
|
|
16628
|
-
*/
|
|
16629
|
-
'id': string;
|
|
16630
|
-
/**
|
|
16631
|
-
*
|
|
16632
|
-
* @type {string}
|
|
16633
|
-
* @memberof PosActionPasscodeDtoV6
|
|
16634
|
-
*/
|
|
16635
|
-
'name': string;
|
|
16636
|
-
/**
|
|
16637
|
-
*
|
|
16638
|
-
* @type {Array<PermissionRuleDtoV6>}
|
|
16639
|
-
* @memberof PosActionPasscodeDtoV6
|
|
16640
|
-
*/
|
|
16641
|
-
'permissionRules': Array<PermissionRuleDtoV6>;
|
|
16642
|
-
}
|
|
16643
16063
|
/**
|
|
16644
16064
|
*
|
|
16645
16065
|
* @export
|
|
@@ -16925,37 +16345,6 @@ export interface PosEmployeeDto {
|
|
|
16925
16345
|
*/
|
|
16926
16346
|
'pinHash': string;
|
|
16927
16347
|
}
|
|
16928
|
-
/**
|
|
16929
|
-
*
|
|
16930
|
-
* @export
|
|
16931
|
-
* @interface PosEmployeeDtoV6
|
|
16932
|
-
*/
|
|
16933
|
-
export interface PosEmployeeDtoV6 {
|
|
16934
|
-
/**
|
|
16935
|
-
*
|
|
16936
|
-
* @type {string}
|
|
16937
|
-
* @memberof PosEmployeeDtoV6
|
|
16938
|
-
*/
|
|
16939
|
-
'id': string;
|
|
16940
|
-
/**
|
|
16941
|
-
*
|
|
16942
|
-
* @type {string}
|
|
16943
|
-
* @memberof PosEmployeeDtoV6
|
|
16944
|
-
*/
|
|
16945
|
-
'name': string;
|
|
16946
|
-
/**
|
|
16947
|
-
*
|
|
16948
|
-
* @type {string}
|
|
16949
|
-
* @memberof PosEmployeeDtoV6
|
|
16950
|
-
*/
|
|
16951
|
-
'roleId': string;
|
|
16952
|
-
/**
|
|
16953
|
-
*
|
|
16954
|
-
* @type {Status}
|
|
16955
|
-
* @memberof PosEmployeeDtoV6
|
|
16956
|
-
*/
|
|
16957
|
-
'status': Status;
|
|
16958
|
-
}
|
|
16959
16348
|
/**
|
|
16960
16349
|
*
|
|
16961
16350
|
* @export
|
|
@@ -18261,259 +17650,6 @@ export interface PosOrderDtoTaxSummary {
|
|
|
18261
17650
|
*/
|
|
18262
17651
|
'grandTotal': number;
|
|
18263
17652
|
}
|
|
18264
|
-
/**
|
|
18265
|
-
*
|
|
18266
|
-
* @export
|
|
18267
|
-
* @interface PosOrderDtoV6
|
|
18268
|
-
*/
|
|
18269
|
-
export interface PosOrderDtoV6 {
|
|
18270
|
-
/**
|
|
18271
|
-
* 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.
|
|
18272
|
-
* @type {boolean}
|
|
18273
|
-
* @memberof PosOrderDtoV6
|
|
18274
|
-
*/
|
|
18275
|
-
'hiddenFromOrderManager'?: boolean;
|
|
18276
|
-
/**
|
|
18277
|
-
* 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.
|
|
18278
|
-
* @type {boolean}
|
|
18279
|
-
* @memberof PosOrderDtoV6
|
|
18280
|
-
*/
|
|
18281
|
-
'readyControlledByKds'?: boolean;
|
|
18282
|
-
/**
|
|
18283
|
-
*
|
|
18284
|
-
* @type {string}
|
|
18285
|
-
* @memberof PosOrderDtoV6
|
|
18286
|
-
*/
|
|
18287
|
-
'id': string;
|
|
18288
|
-
/**
|
|
18289
|
-
*
|
|
18290
|
-
* @type {string}
|
|
18291
|
-
* @memberof PosOrderDtoV6
|
|
18292
|
-
*/
|
|
18293
|
-
'businessId': string;
|
|
18294
|
-
/**
|
|
18295
|
-
*
|
|
18296
|
-
* @type {ProviderEnum}
|
|
18297
|
-
* @memberof PosOrderDtoV6
|
|
18298
|
-
*/
|
|
18299
|
-
'provider': ProviderEnum;
|
|
18300
|
-
/**
|
|
18301
|
-
*
|
|
18302
|
-
* @type {CurrencyCode}
|
|
18303
|
-
* @memberof PosOrderDtoV6
|
|
18304
|
-
*/
|
|
18305
|
-
'currency': CurrencyCode;
|
|
18306
|
-
/**
|
|
18307
|
-
*
|
|
18308
|
-
* @type {PosBusinessDto}
|
|
18309
|
-
* @memberof PosOrderDtoV6
|
|
18310
|
-
*/
|
|
18311
|
-
'business': PosBusinessDto;
|
|
18312
|
-
/**
|
|
18313
|
-
*
|
|
18314
|
-
* @type {string}
|
|
18315
|
-
* @memberof PosOrderDtoV6
|
|
18316
|
-
*/
|
|
18317
|
-
'createdAt': string;
|
|
18318
|
-
/**
|
|
18319
|
-
*
|
|
18320
|
-
* @type {OrderStatusEnum}
|
|
18321
|
-
* @memberof PosOrderDtoV6
|
|
18322
|
-
*/
|
|
18323
|
-
'status': OrderStatusEnum;
|
|
18324
|
-
/**
|
|
18325
|
-
*
|
|
18326
|
-
* @type {string}
|
|
18327
|
-
* @memberof PosOrderDtoV6
|
|
18328
|
-
*/
|
|
18329
|
-
'updatedAt': string;
|
|
18330
|
-
/**
|
|
18331
|
-
*
|
|
18332
|
-
* @type {string}
|
|
18333
|
-
* @memberof PosOrderDtoV6
|
|
18334
|
-
*/
|
|
18335
|
-
'completedAt'?: string;
|
|
18336
|
-
/**
|
|
18337
|
-
*
|
|
18338
|
-
* @type {string}
|
|
18339
|
-
* @memberof PosOrderDtoV6
|
|
18340
|
-
*/
|
|
18341
|
-
'orderNumber': string;
|
|
18342
|
-
/**
|
|
18343
|
-
*
|
|
18344
|
-
* @type {CheckoutModelEnum}
|
|
18345
|
-
* @memberof PosOrderDtoV6
|
|
18346
|
-
*/
|
|
18347
|
-
'checkoutModel': CheckoutModelEnum;
|
|
18348
|
-
/**
|
|
18349
|
-
*
|
|
18350
|
-
* @type {OrderTypePOS}
|
|
18351
|
-
* @memberof PosOrderDtoV6
|
|
18352
|
-
*/
|
|
18353
|
-
'orderType': OrderTypePOS;
|
|
18354
|
-
/**
|
|
18355
|
-
*
|
|
18356
|
-
* @type {string}
|
|
18357
|
-
* @memberof PosOrderDtoV6
|
|
18358
|
-
*/
|
|
18359
|
-
'spotNumber': string | null;
|
|
18360
|
-
/**
|
|
18361
|
-
* ID of the floor plan dining table linked to this order
|
|
18362
|
-
* @type {string}
|
|
18363
|
-
* @memberof PosOrderDtoV6
|
|
18364
|
-
*/
|
|
18365
|
-
'tableId'?: string | null;
|
|
18366
|
-
/**
|
|
18367
|
-
*
|
|
18368
|
-
* @type {string}
|
|
18369
|
-
* @memberof PosOrderDtoV6
|
|
18370
|
-
*/
|
|
18371
|
-
'comments': string | null;
|
|
18372
|
-
/**
|
|
18373
|
-
*
|
|
18374
|
-
* @type {PosOrderDtoTableService}
|
|
18375
|
-
* @memberof PosOrderDtoV6
|
|
18376
|
-
*/
|
|
18377
|
-
'tableService'?: PosOrderDtoTableService | null;
|
|
18378
|
-
/**
|
|
18379
|
-
*
|
|
18380
|
-
* @type {PosOrderDtoEqualSplitState}
|
|
18381
|
-
* @memberof PosOrderDtoV6
|
|
18382
|
-
*/
|
|
18383
|
-
'equalSplitState'?: PosOrderDtoEqualSplitState | null;
|
|
18384
|
-
/**
|
|
18385
|
-
* Id of the staff in shift
|
|
18386
|
-
* @type {string}
|
|
18387
|
-
* @memberof PosOrderDtoV6
|
|
18388
|
-
*/
|
|
18389
|
-
'staffId': string | null;
|
|
18390
|
-
/**
|
|
18391
|
-
* Id of the shift
|
|
18392
|
-
* @type {string}
|
|
18393
|
-
* @memberof PosOrderDtoV6
|
|
18394
|
-
*/
|
|
18395
|
-
'shiftId': string | null;
|
|
18396
|
-
/**
|
|
18397
|
-
*
|
|
18398
|
-
* @type {OrderRefundStatus}
|
|
18399
|
-
* @memberof PosOrderDtoV6
|
|
18400
|
-
*/
|
|
18401
|
-
'orderRefundStatus': OrderRefundStatus;
|
|
18402
|
-
/**
|
|
18403
|
-
*
|
|
18404
|
-
* @type {LocatorType}
|
|
18405
|
-
* @memberof PosOrderDtoV6
|
|
18406
|
-
*/
|
|
18407
|
-
'locatorType': LocatorType;
|
|
18408
|
-
/**
|
|
18409
|
-
*
|
|
18410
|
-
* @type {PosCustomerDto}
|
|
18411
|
-
* @memberof PosOrderDtoV6
|
|
18412
|
-
*/
|
|
18413
|
-
'customer': PosCustomerDto | null;
|
|
18414
|
-
/**
|
|
18415
|
-
*
|
|
18416
|
-
* @type {Array<TransactionDto>}
|
|
18417
|
-
* @memberof PosOrderDtoV6
|
|
18418
|
-
*/
|
|
18419
|
-
'paymentEvents': Array<TransactionDto>;
|
|
18420
|
-
/**
|
|
18421
|
-
*
|
|
18422
|
-
* @type {Array<PaymentRefundDto>}
|
|
18423
|
-
* @memberof PosOrderDtoV6
|
|
18424
|
-
*/
|
|
18425
|
-
'refunds'?: Array<PaymentRefundDto>;
|
|
18426
|
-
/**
|
|
18427
|
-
* Data version code
|
|
18428
|
-
* @type {string}
|
|
18429
|
-
* @memberof PosOrderDtoV6
|
|
18430
|
-
*/
|
|
18431
|
-
'version': string;
|
|
18432
|
-
/**
|
|
18433
|
-
*
|
|
18434
|
-
* @type {OrderFormat}
|
|
18435
|
-
* @memberof PosOrderDtoV6
|
|
18436
|
-
*/
|
|
18437
|
-
'orderFormat'?: OrderFormat;
|
|
18438
|
-
/**
|
|
18439
|
-
* The ID of the loyalty program active during this order.
|
|
18440
|
-
* @type {string}
|
|
18441
|
-
* @memberof PosOrderDtoV6
|
|
18442
|
-
*/
|
|
18443
|
-
'loyaltyProgramId': string | null;
|
|
18444
|
-
/**
|
|
18445
|
-
* An array of loyalty transaction IDs related to this order.
|
|
18446
|
-
* @type {Array<string>}
|
|
18447
|
-
* @memberof PosOrderDtoV6
|
|
18448
|
-
*/
|
|
18449
|
-
'loyaltyTransactionIds': Array<string>;
|
|
18450
|
-
/**
|
|
18451
|
-
*
|
|
18452
|
-
* @type {PosOrderDtoTaxSummary}
|
|
18453
|
-
* @memberof PosOrderDtoV6
|
|
18454
|
-
*/
|
|
18455
|
-
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
18456
|
-
/**
|
|
18457
|
-
* Name of staff member who created the order
|
|
18458
|
-
* @type {string}
|
|
18459
|
-
* @memberof PosOrderDtoV6
|
|
18460
|
-
*/
|
|
18461
|
-
'staffName'?: string | null;
|
|
18462
|
-
/**
|
|
18463
|
-
*
|
|
18464
|
-
* @type {PosOrderDtoInvoiceCompany}
|
|
18465
|
-
* @memberof PosOrderDtoV6
|
|
18466
|
-
*/
|
|
18467
|
-
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
18468
|
-
/**
|
|
18469
|
-
*
|
|
18470
|
-
* @type {object}
|
|
18471
|
-
* @memberof PosOrderDtoV6
|
|
18472
|
-
*/
|
|
18473
|
-
'lastPaymentError'?: object;
|
|
18474
|
-
/**
|
|
18475
|
-
*
|
|
18476
|
-
* @type {Array<OrderFeeDto>}
|
|
18477
|
-
* @memberof PosOrderDtoV6
|
|
18478
|
-
*/
|
|
18479
|
-
'fees'?: Array<OrderFeeDto> | null;
|
|
18480
|
-
/**
|
|
18481
|
-
* Loyalty user ID associated with this order
|
|
18482
|
-
* @type {number}
|
|
18483
|
-
* @memberof PosOrderDtoV6
|
|
18484
|
-
*/
|
|
18485
|
-
'targetUserId'?: number;
|
|
18486
|
-
/**
|
|
18487
|
-
* ID of the table group this order belongs to
|
|
18488
|
-
* @type {string}
|
|
18489
|
-
* @memberof PosOrderDtoV6
|
|
18490
|
-
*/
|
|
18491
|
-
'tableGroupId'?: string | null;
|
|
18492
|
-
/**
|
|
18493
|
-
*
|
|
18494
|
-
* @type {PosOrderDtoLoyalty}
|
|
18495
|
-
* @memberof PosOrderDtoV6
|
|
18496
|
-
*/
|
|
18497
|
-
'loyalty'?: PosOrderDtoLoyalty | null;
|
|
18498
|
-
/**
|
|
18499
|
-
* Omitted without Transaction::ViewDiscounts
|
|
18500
|
-
* @type {Array<PosDiscountDto>}
|
|
18501
|
-
* @memberof PosOrderDtoV6
|
|
18502
|
-
*/
|
|
18503
|
-
'discounts'?: Array<PosDiscountDto>;
|
|
18504
|
-
/**
|
|
18505
|
-
*
|
|
18506
|
-
* @type {PosOrderPriceDtoV6}
|
|
18507
|
-
* @memberof PosOrderDtoV6
|
|
18508
|
-
*/
|
|
18509
|
-
'basketPrice': PosOrderPriceDtoV6;
|
|
18510
|
-
/**
|
|
18511
|
-
*
|
|
18512
|
-
* @type {Array<PosOrderItemDtoV6>}
|
|
18513
|
-
* @memberof PosOrderDtoV6
|
|
18514
|
-
*/
|
|
18515
|
-
'items': Array<PosOrderItemDtoV6>;
|
|
18516
|
-
}
|
|
18517
17653
|
/**
|
|
18518
17654
|
*
|
|
18519
17655
|
* @export
|
|
@@ -18601,68 +17737,6 @@ export interface PosOrderEqualSplitStateDto {
|
|
|
18601
17737
|
*/
|
|
18602
17738
|
'parts': Array<PosOrderEqualSplitPartDto>;
|
|
18603
17739
|
}
|
|
18604
|
-
/**
|
|
18605
|
-
*
|
|
18606
|
-
* @export
|
|
18607
|
-
* @interface PosOrderHistoryResponseDtoV6
|
|
18608
|
-
*/
|
|
18609
|
-
export interface PosOrderHistoryResponseDtoV6 {
|
|
18610
|
-
/**
|
|
18611
|
-
* Without Transaction::ViewTips or Transaction::ViewSurcharges, fees of that type are left out of fees and paymentEvents
|
|
18612
|
-
* @type {Array<PosOrderDtoV6>}
|
|
18613
|
-
* @memberof PosOrderHistoryResponseDtoV6
|
|
18614
|
-
*/
|
|
18615
|
-
'orders': Array<PosOrderDtoV6>;
|
|
18616
|
-
/**
|
|
18617
|
-
*
|
|
18618
|
-
* @type {PosOrderHistoryResponseDtoV6Summary}
|
|
18619
|
-
* @memberof PosOrderHistoryResponseDtoV6
|
|
18620
|
-
*/
|
|
18621
|
-
'summary': PosOrderHistoryResponseDtoV6Summary;
|
|
18622
|
-
/**
|
|
18623
|
-
*
|
|
18624
|
-
* @type {PaginationDto}
|
|
18625
|
-
* @memberof PosOrderHistoryResponseDtoV6
|
|
18626
|
-
*/
|
|
18627
|
-
'pagination': PaginationDto;
|
|
18628
|
-
}
|
|
18629
|
-
/**
|
|
18630
|
-
* Each total is omitted without its TransactionTotals key; tips need Transaction::ViewTips
|
|
18631
|
-
* @export
|
|
18632
|
-
* @interface PosOrderHistoryResponseDtoV6Summary
|
|
18633
|
-
*/
|
|
18634
|
-
export interface PosOrderHistoryResponseDtoV6Summary {
|
|
18635
|
-
/**
|
|
18636
|
-
* Total orders
|
|
18637
|
-
* @type {number}
|
|
18638
|
-
* @memberof PosOrderHistoryResponseDtoV6Summary
|
|
18639
|
-
*/
|
|
18640
|
-
'totalOrders'?: number;
|
|
18641
|
-
/**
|
|
18642
|
-
* Rejected orders
|
|
18643
|
-
* @type {number}
|
|
18644
|
-
* @memberof PosOrderHistoryResponseDtoV6Summary
|
|
18645
|
-
*/
|
|
18646
|
-
'rejectedOrders'?: number;
|
|
18647
|
-
/**
|
|
18648
|
-
* Total sales
|
|
18649
|
-
* @type {number}
|
|
18650
|
-
* @memberof PosOrderHistoryResponseDtoV6Summary
|
|
18651
|
-
*/
|
|
18652
|
-
'totalSales'?: number;
|
|
18653
|
-
/**
|
|
18654
|
-
* Rejected sales
|
|
18655
|
-
* @type {number}
|
|
18656
|
-
* @memberof PosOrderHistoryResponseDtoV6Summary
|
|
18657
|
-
*/
|
|
18658
|
-
'rejectedSales'?: number;
|
|
18659
|
-
/**
|
|
18660
|
-
* Total tip amount in cents
|
|
18661
|
-
* @type {number}
|
|
18662
|
-
* @memberof PosOrderHistoryResponseDtoV6Summary
|
|
18663
|
-
*/
|
|
18664
|
-
'totalTipAmount'?: number;
|
|
18665
|
-
}
|
|
18666
17740
|
/**
|
|
18667
17741
|
*
|
|
18668
17742
|
* @export
|
|
@@ -18857,157 +17931,6 @@ export interface PosOrderItemDtoReportingCategory {
|
|
|
18857
17931
|
*/
|
|
18858
17932
|
'updated_at': string;
|
|
18859
17933
|
}
|
|
18860
|
-
/**
|
|
18861
|
-
*
|
|
18862
|
-
* @export
|
|
18863
|
-
* @interface PosOrderItemDtoV6
|
|
18864
|
-
*/
|
|
18865
|
-
export interface PosOrderItemDtoV6 {
|
|
18866
|
-
/**
|
|
18867
|
-
*
|
|
18868
|
-
* @type {string}
|
|
18869
|
-
* @memberof PosOrderItemDtoV6
|
|
18870
|
-
*/
|
|
18871
|
-
'id': string;
|
|
18872
|
-
/**
|
|
18873
|
-
*
|
|
18874
|
-
* @type {string}
|
|
18875
|
-
* @memberof PosOrderItemDtoV6
|
|
18876
|
-
*/
|
|
18877
|
-
'lineItemId': string;
|
|
18878
|
-
/**
|
|
18879
|
-
*
|
|
18880
|
-
* @type {string}
|
|
18881
|
-
* @memberof PosOrderItemDtoV6
|
|
18882
|
-
*/
|
|
18883
|
-
'posId': string;
|
|
18884
|
-
/**
|
|
18885
|
-
*
|
|
18886
|
-
* @type {string}
|
|
18887
|
-
* @memberof PosOrderItemDtoV6
|
|
18888
|
-
*/
|
|
18889
|
-
'name': string;
|
|
18890
|
-
/**
|
|
18891
|
-
*
|
|
18892
|
-
* @type {MoneyDto}
|
|
18893
|
-
* @memberof PosOrderItemDtoV6
|
|
18894
|
-
*/
|
|
18895
|
-
'basePrice': MoneyDto;
|
|
18896
|
-
/**
|
|
18897
|
-
*
|
|
18898
|
-
* @type {number}
|
|
18899
|
-
* @memberof PosOrderItemDtoV6
|
|
18900
|
-
*/
|
|
18901
|
-
'taxRate': number;
|
|
18902
|
-
/**
|
|
18903
|
-
*
|
|
18904
|
-
* @type {number}
|
|
18905
|
-
* @memberof PosOrderItemDtoV6
|
|
18906
|
-
*/
|
|
18907
|
-
'quantity': number;
|
|
18908
|
-
/**
|
|
18909
|
-
*
|
|
18910
|
-
* @type {KitchenStatus}
|
|
18911
|
-
* @memberof PosOrderItemDtoV6
|
|
18912
|
-
*/
|
|
18913
|
-
'kitchenStatus': KitchenStatus;
|
|
18914
|
-
/**
|
|
18915
|
-
*
|
|
18916
|
-
* @type {PosPaymentStatus}
|
|
18917
|
-
* @memberof PosOrderItemDtoV6
|
|
18918
|
-
*/
|
|
18919
|
-
'paymentStatus': PosPaymentStatus;
|
|
18920
|
-
/**
|
|
18921
|
-
*
|
|
18922
|
-
* @type {PosDiscountDto}
|
|
18923
|
-
* @memberof PosOrderItemDtoV6
|
|
18924
|
-
*/
|
|
18925
|
-
'discount': PosDiscountDto | null;
|
|
18926
|
-
/**
|
|
18927
|
-
* Every item-scope discount application on this line, in cascade order — including when there is only one.
|
|
18928
|
-
* @type {Array<PosDiscountDto>}
|
|
18929
|
-
* @memberof PosOrderItemDtoV6
|
|
18930
|
-
*/
|
|
18931
|
-
'discountApplications'?: Array<PosDiscountDto>;
|
|
18932
|
-
/**
|
|
18933
|
-
*
|
|
18934
|
-
* @type {boolean}
|
|
18935
|
-
* @memberof PosOrderItemDtoV6
|
|
18936
|
-
*/
|
|
18937
|
-
'isBundleOffer': boolean;
|
|
18938
|
-
/**
|
|
18939
|
-
*
|
|
18940
|
-
* @type {boolean}
|
|
18941
|
-
* @memberof PosOrderItemDtoV6
|
|
18942
|
-
*/
|
|
18943
|
-
'isAlcohol': boolean;
|
|
18944
|
-
/**
|
|
18945
|
-
*
|
|
18946
|
-
* @type {string}
|
|
18947
|
-
* @memberof PosOrderItemDtoV6
|
|
18948
|
-
*/
|
|
18949
|
-
'comments': string | null;
|
|
18950
|
-
/**
|
|
18951
|
-
*
|
|
18952
|
-
* @type {string}
|
|
18953
|
-
* @memberof PosOrderItemDtoV6
|
|
18954
|
-
*/
|
|
18955
|
-
'logo': string | null;
|
|
18956
|
-
/**
|
|
18957
|
-
*
|
|
18958
|
-
* @type {PrinterTypeEnum}
|
|
18959
|
-
* @memberof PosOrderItemDtoV6
|
|
18960
|
-
*/
|
|
18961
|
-
'printerType'?: PrinterTypeEnum;
|
|
18962
|
-
/**
|
|
18963
|
-
* Resolved target printer addresses; empty/absent means print on all kitchen printers
|
|
18964
|
-
* @type {Array<string>}
|
|
18965
|
-
* @memberof PosOrderItemDtoV6
|
|
18966
|
-
*/
|
|
18967
|
-
'printerIds'?: Array<string> | null;
|
|
18968
|
-
/**
|
|
18969
|
-
*
|
|
18970
|
-
* @type {Array<PosOrderOptionDto>}
|
|
18971
|
-
* @memberof PosOrderItemDtoV6
|
|
18972
|
-
*/
|
|
18973
|
-
'options': Array<PosOrderOptionDto>;
|
|
18974
|
-
/**
|
|
18975
|
-
* Whether the product has a display label
|
|
18976
|
-
* @type {boolean}
|
|
18977
|
-
* @memberof PosOrderItemDtoV6
|
|
18978
|
-
*/
|
|
18979
|
-
'display_photo'?: boolean;
|
|
18980
|
-
/**
|
|
18981
|
-
*
|
|
18982
|
-
* @type {PosOrderItemDtoReportingCategory}
|
|
18983
|
-
* @memberof PosOrderItemDtoV6
|
|
18984
|
-
*/
|
|
18985
|
-
'reporting_category'?: PosOrderItemDtoReportingCategory | null;
|
|
18986
|
-
/**
|
|
18987
|
-
* Category ID of the item
|
|
18988
|
-
* @type {number}
|
|
18989
|
-
* @memberof PosOrderItemDtoV6
|
|
18990
|
-
*/
|
|
18991
|
-
'category_id': number | null;
|
|
18992
|
-
/**
|
|
18993
|
-
* Course ID override for this line item
|
|
18994
|
-
* @type {string}
|
|
18995
|
-
* @memberof PosOrderItemDtoV6
|
|
18996
|
-
*/
|
|
18997
|
-
'courseId'?: string | null;
|
|
18998
|
-
/**
|
|
18999
|
-
* Course name override for this line item
|
|
19000
|
-
* @type {string}
|
|
19001
|
-
* @memberof PosOrderItemDtoV6
|
|
19002
|
-
*/
|
|
19003
|
-
'courseName'?: string | null;
|
|
19004
|
-
/**
|
|
19005
|
-
*
|
|
19006
|
-
* @type {ItemPriceDtoV6}
|
|
19007
|
-
* @memberof PosOrderItemDtoV6
|
|
19008
|
-
*/
|
|
19009
|
-
'itemPrice': ItemPriceDtoV6;
|
|
19010
|
-
}
|
|
19011
17934
|
/**
|
|
19012
17935
|
*
|
|
19013
17936
|
* @export
|
|
@@ -19434,56 +18357,6 @@ export interface PosOrderPriceDto {
|
|
|
19434
18357
|
*/
|
|
19435
18358
|
'total': MoneyDto;
|
|
19436
18359
|
}
|
|
19437
|
-
/**
|
|
19438
|
-
*
|
|
19439
|
-
* @export
|
|
19440
|
-
* @interface PosOrderPriceDtoV6
|
|
19441
|
-
*/
|
|
19442
|
-
export interface PosOrderPriceDtoV6 {
|
|
19443
|
-
/**
|
|
19444
|
-
*
|
|
19445
|
-
* @type {MoneyDto}
|
|
19446
|
-
* @memberof PosOrderPriceDtoV6
|
|
19447
|
-
*/
|
|
19448
|
-
'total': MoneyDto;
|
|
19449
|
-
/**
|
|
19450
|
-
*
|
|
19451
|
-
* @type {PosOrderPriceDtoV6PriceBreakdown}
|
|
19452
|
-
* @memberof PosOrderPriceDtoV6
|
|
19453
|
-
*/
|
|
19454
|
-
'priceBreakdown'?: PosOrderPriceDtoV6PriceBreakdown;
|
|
19455
|
-
}
|
|
19456
|
-
/**
|
|
19457
|
-
* Omitted without Transaction::ViewDiscounts
|
|
19458
|
-
* @export
|
|
19459
|
-
* @interface PosOrderPriceDtoV6PriceBreakdown
|
|
19460
|
-
*/
|
|
19461
|
-
export interface PosOrderPriceDtoV6PriceBreakdown {
|
|
19462
|
-
/**
|
|
19463
|
-
*
|
|
19464
|
-
* @type {MoneyDto}
|
|
19465
|
-
* @memberof PosOrderPriceDtoV6PriceBreakdown
|
|
19466
|
-
*/
|
|
19467
|
-
'totalBeforeDiscounts': MoneyDto;
|
|
19468
|
-
/**
|
|
19469
|
-
*
|
|
19470
|
-
* @type {MoneyDto}
|
|
19471
|
-
* @memberof PosOrderPriceDtoV6PriceBreakdown
|
|
19472
|
-
*/
|
|
19473
|
-
'subtotalItemDiscounts': MoneyDto;
|
|
19474
|
-
/**
|
|
19475
|
-
*
|
|
19476
|
-
* @type {MoneyDto}
|
|
19477
|
-
* @memberof PosOrderPriceDtoV6PriceBreakdown
|
|
19478
|
-
*/
|
|
19479
|
-
'subtotalBasketDiscounts': MoneyDto;
|
|
19480
|
-
/**
|
|
19481
|
-
*
|
|
19482
|
-
* @type {MoneyDto}
|
|
19483
|
-
* @memberof PosOrderPriceDtoV6PriceBreakdown
|
|
19484
|
-
*/
|
|
19485
|
-
'totalDiscounts': MoneyDto;
|
|
19486
|
-
}
|
|
19487
18360
|
/**
|
|
19488
18361
|
*
|
|
19489
18362
|
* @export
|
|
@@ -19539,43 +18412,6 @@ export interface PosOrderSuboptionDto {
|
|
|
19539
18412
|
*/
|
|
19540
18413
|
'value_pos_id': string | null;
|
|
19541
18414
|
}
|
|
19542
|
-
/**
|
|
19543
|
-
*
|
|
19544
|
-
* @export
|
|
19545
|
-
* @interface PosOrderSummaryDtoV6
|
|
19546
|
-
*/
|
|
19547
|
-
export interface PosOrderSummaryDtoV6 {
|
|
19548
|
-
/**
|
|
19549
|
-
* Total orders
|
|
19550
|
-
* @type {number}
|
|
19551
|
-
* @memberof PosOrderSummaryDtoV6
|
|
19552
|
-
*/
|
|
19553
|
-
'totalOrders'?: number;
|
|
19554
|
-
/**
|
|
19555
|
-
* Rejected orders
|
|
19556
|
-
* @type {number}
|
|
19557
|
-
* @memberof PosOrderSummaryDtoV6
|
|
19558
|
-
*/
|
|
19559
|
-
'rejectedOrders'?: number;
|
|
19560
|
-
/**
|
|
19561
|
-
* Total sales
|
|
19562
|
-
* @type {number}
|
|
19563
|
-
* @memberof PosOrderSummaryDtoV6
|
|
19564
|
-
*/
|
|
19565
|
-
'totalSales'?: number;
|
|
19566
|
-
/**
|
|
19567
|
-
* Rejected sales
|
|
19568
|
-
* @type {number}
|
|
19569
|
-
* @memberof PosOrderSummaryDtoV6
|
|
19570
|
-
*/
|
|
19571
|
-
'rejectedSales'?: number;
|
|
19572
|
-
/**
|
|
19573
|
-
* Total tip amount in cents
|
|
19574
|
-
* @type {number}
|
|
19575
|
-
* @memberof PosOrderSummaryDtoV6
|
|
19576
|
-
*/
|
|
19577
|
-
'totalTipAmount'?: number;
|
|
19578
|
-
}
|
|
19579
18415
|
/**
|
|
19580
18416
|
*
|
|
19581
18417
|
* @export
|
|
@@ -19702,52 +18538,128 @@ export type PosPermission = typeof PosPermission[keyof typeof PosPermission];
|
|
|
19702
18538
|
/**
|
|
19703
18539
|
*
|
|
19704
18540
|
* @export
|
|
19705
|
-
* @interface
|
|
18541
|
+
* @interface PosPermissionCatalogResponseDto
|
|
19706
18542
|
*/
|
|
19707
|
-
export interface
|
|
18543
|
+
export interface PosPermissionCatalogResponseDto {
|
|
18544
|
+
/**
|
|
18545
|
+
* Every POS key the server knows, grouped as the POS groups them
|
|
18546
|
+
* @type {Array<PosPermissionGroupDto>}
|
|
18547
|
+
* @memberof PosPermissionCatalogResponseDto
|
|
18548
|
+
*/
|
|
18549
|
+
'groups': Array<PosPermissionGroupDto>;
|
|
18550
|
+
}
|
|
18551
|
+
/**
|
|
18552
|
+
*
|
|
18553
|
+
* @export
|
|
18554
|
+
* @interface PosPermissionDetailDto
|
|
18555
|
+
*/
|
|
18556
|
+
export interface PosPermissionDetailDto {
|
|
19708
18557
|
/**
|
|
19709
18558
|
*
|
|
18559
|
+
* @type {PosPermission}
|
|
18560
|
+
* @memberof PosPermissionDetailDto
|
|
18561
|
+
*/
|
|
18562
|
+
'key': PosPermission;
|
|
18563
|
+
/**
|
|
18564
|
+
* The key\'s name, as the merchant sees it beside its checkbox
|
|
19710
18565
|
* @type {string}
|
|
19711
|
-
* @memberof
|
|
18566
|
+
* @memberof PosPermissionDetailDto
|
|
19712
18567
|
*/
|
|
19713
|
-
'
|
|
18568
|
+
'label': string;
|
|
19714
18569
|
/**
|
|
19715
18570
|
*
|
|
18571
|
+
* @type {PosPermissionKind}
|
|
18572
|
+
* @memberof PosPermissionDetailDto
|
|
18573
|
+
*/
|
|
18574
|
+
'kind': PosPermissionKind;
|
|
18575
|
+
}
|
|
18576
|
+
/**
|
|
18577
|
+
*
|
|
18578
|
+
* @export
|
|
18579
|
+
* @enum {string}
|
|
18580
|
+
*/
|
|
18581
|
+
export declare const PosPermissionGroup: {
|
|
18582
|
+
readonly Access: "Access";
|
|
18583
|
+
readonly Page: "Page";
|
|
18584
|
+
readonly Cart: "Cart";
|
|
18585
|
+
readonly Cash: "Cash";
|
|
18586
|
+
readonly Transaction: "Transaction";
|
|
18587
|
+
readonly TransactionTotals: "TransactionTotals";
|
|
18588
|
+
readonly Order: "Order";
|
|
18589
|
+
readonly OpenOrders: "OpenOrders";
|
|
18590
|
+
readonly Shift: "Shift";
|
|
18591
|
+
readonly FloorPlan: "FloorPlan";
|
|
18592
|
+
readonly Settings: "Settings";
|
|
18593
|
+
readonly Report: "Report";
|
|
18594
|
+
readonly ReportTotals: "ReportTotals";
|
|
18595
|
+
};
|
|
18596
|
+
export type PosPermissionGroup = typeof PosPermissionGroup[keyof typeof PosPermissionGroup];
|
|
18597
|
+
/**
|
|
18598
|
+
*
|
|
18599
|
+
* @export
|
|
18600
|
+
* @interface PosPermissionGroupDto
|
|
18601
|
+
*/
|
|
18602
|
+
export interface PosPermissionGroupDto {
|
|
18603
|
+
/**
|
|
18604
|
+
*
|
|
18605
|
+
* @type {PosPermissionGroup}
|
|
18606
|
+
* @memberof PosPermissionGroupDto
|
|
18607
|
+
*/
|
|
18608
|
+
'group': PosPermissionGroup;
|
|
18609
|
+
/**
|
|
18610
|
+
* The group\'s name, as the merchant sees it
|
|
19716
18611
|
* @type {string}
|
|
19717
|
-
* @memberof
|
|
18612
|
+
* @memberof PosPermissionGroupDto
|
|
19718
18613
|
*/
|
|
19719
|
-
'
|
|
18614
|
+
'label': string;
|
|
19720
18615
|
/**
|
|
19721
18616
|
*
|
|
19722
|
-
* @type {
|
|
19723
|
-
* @memberof
|
|
18617
|
+
* @type {PosPermission}
|
|
18618
|
+
* @memberof PosPermissionGroupDto
|
|
19724
18619
|
*/
|
|
19725
|
-
'
|
|
18620
|
+
'wildcardKey'?: PosPermission;
|
|
18621
|
+
/**
|
|
18622
|
+
* The group\'s keys, in the order the POS lists them, without the wildcard key
|
|
18623
|
+
* @type {Array<PosPermissionDetailDto>}
|
|
18624
|
+
* @memberof PosPermissionGroupDto
|
|
18625
|
+
*/
|
|
18626
|
+
'permissions': Array<PosPermissionDetailDto>;
|
|
19726
18627
|
}
|
|
19727
18628
|
/**
|
|
19728
18629
|
*
|
|
19729
18630
|
* @export
|
|
19730
|
-
* @
|
|
18631
|
+
* @enum {string}
|
|
18632
|
+
*/
|
|
18633
|
+
export declare const PosPermissionKind: {
|
|
18634
|
+
readonly Screen: "screen";
|
|
18635
|
+
readonly Action: "action";
|
|
18636
|
+
readonly Visibility: "visibility";
|
|
18637
|
+
};
|
|
18638
|
+
export type PosPermissionKind = typeof PosPermissionKind[keyof typeof PosPermissionKind];
|
|
18639
|
+
/**
|
|
18640
|
+
*
|
|
18641
|
+
* @export
|
|
18642
|
+
* @interface PosRoleDto
|
|
19731
18643
|
*/
|
|
19732
|
-
export interface
|
|
18644
|
+
export interface PosRoleDto {
|
|
19733
18645
|
/**
|
|
19734
18646
|
*
|
|
19735
18647
|
* @type {string}
|
|
19736
|
-
* @memberof
|
|
18648
|
+
* @memberof PosRoleDto
|
|
19737
18649
|
*/
|
|
19738
18650
|
'id': string;
|
|
19739
18651
|
/**
|
|
19740
18652
|
*
|
|
19741
18653
|
* @type {string}
|
|
19742
|
-
* @memberof
|
|
18654
|
+
* @memberof PosRoleDto
|
|
19743
18655
|
*/
|
|
19744
18656
|
'name': string;
|
|
19745
18657
|
/**
|
|
19746
18658
|
*
|
|
19747
|
-
* @type {Array<
|
|
19748
|
-
* @memberof
|
|
18659
|
+
* @type {Array<PermissionRuleResponseDto>}
|
|
18660
|
+
* @memberof PosRoleDto
|
|
19749
18661
|
*/
|
|
19750
|
-
'permissionRules': Array<
|
|
18662
|
+
'permissionRules': Array<PermissionRuleResponseDto>;
|
|
19751
18663
|
}
|
|
19752
18664
|
/**
|
|
19753
18665
|
*
|
|
@@ -19811,31 +18723,6 @@ export interface PosSessionResponseDto {
|
|
|
19811
18723
|
*/
|
|
19812
18724
|
'actionPasscodes': Array<PosActionPasscodeDto>;
|
|
19813
18725
|
}
|
|
19814
|
-
/**
|
|
19815
|
-
*
|
|
19816
|
-
* @export
|
|
19817
|
-
* @interface PosSessionResponseDtoV6
|
|
19818
|
-
*/
|
|
19819
|
-
export interface PosSessionResponseDtoV6 {
|
|
19820
|
-
/**
|
|
19821
|
-
*
|
|
19822
|
-
* @type {Array<PosEmployeeDtoV6>}
|
|
19823
|
-
* @memberof PosSessionResponseDtoV6
|
|
19824
|
-
*/
|
|
19825
|
-
'employees': Array<PosEmployeeDtoV6>;
|
|
19826
|
-
/**
|
|
19827
|
-
*
|
|
19828
|
-
* @type {Array<PosRoleDtoV6>}
|
|
19829
|
-
* @memberof PosSessionResponseDtoV6
|
|
19830
|
-
*/
|
|
19831
|
-
'roles': Array<PosRoleDtoV6>;
|
|
19832
|
-
/**
|
|
19833
|
-
*
|
|
19834
|
-
* @type {Array<PosActionPasscodeDtoV6>}
|
|
19835
|
-
* @memberof PosSessionResponseDtoV6
|
|
19836
|
-
*/
|
|
19837
|
-
'actionPasscodes': Array<PosActionPasscodeDtoV6>;
|
|
19838
|
-
}
|
|
19839
18726
|
/**
|
|
19840
18727
|
*
|
|
19841
18728
|
* @export
|
|
@@ -22358,44 +21245,6 @@ export interface RejectOrderDto {
|
|
|
22358
21245
|
*/
|
|
22359
21246
|
'reason': string;
|
|
22360
21247
|
}
|
|
22361
|
-
/**
|
|
22362
|
-
*
|
|
22363
|
-
* @export
|
|
22364
|
-
* @interface RenewScopedTokenDto
|
|
22365
|
-
*/
|
|
22366
|
-
export interface RenewScopedTokenDto {
|
|
22367
|
-
/**
|
|
22368
|
-
* The renewal ticket issued with the token being renewed
|
|
22369
|
-
* @type {string}
|
|
22370
|
-
* @memberof RenewScopedTokenDto
|
|
22371
|
-
*/
|
|
22372
|
-
'renewalTicket': string;
|
|
22373
|
-
}
|
|
22374
|
-
/**
|
|
22375
|
-
*
|
|
22376
|
-
* @export
|
|
22377
|
-
* @interface ReportEmailResponseDtoV6
|
|
22378
|
-
*/
|
|
22379
|
-
export interface ReportEmailResponseDtoV6 {
|
|
22380
|
-
/**
|
|
22381
|
-
*
|
|
22382
|
-
* @type {boolean}
|
|
22383
|
-
* @memberof ReportEmailResponseDtoV6
|
|
22384
|
-
*/
|
|
22385
|
-
'success': boolean;
|
|
22386
|
-
/**
|
|
22387
|
-
*
|
|
22388
|
-
* @type {string}
|
|
22389
|
-
* @memberof ReportEmailResponseDtoV6
|
|
22390
|
-
*/
|
|
22391
|
-
'message': string;
|
|
22392
|
-
/**
|
|
22393
|
-
*
|
|
22394
|
-
* @type {string}
|
|
22395
|
-
* @memberof ReportEmailResponseDtoV6
|
|
22396
|
-
*/
|
|
22397
|
-
'timestamp': string;
|
|
22398
|
-
}
|
|
22399
21248
|
/**
|
|
22400
21249
|
*
|
|
22401
21250
|
* @export
|
|
@@ -23031,109 +21880,6 @@ export interface SalesSummaryDtoV2 {
|
|
|
23031
21880
|
*/
|
|
23032
21881
|
'totalSurchargeAmount': number;
|
|
23033
21882
|
}
|
|
23034
|
-
/**
|
|
23035
|
-
*
|
|
23036
|
-
* @export
|
|
23037
|
-
* @interface SalesSummaryDtoV6
|
|
23038
|
-
*/
|
|
23039
|
-
export interface SalesSummaryDtoV6 {
|
|
23040
|
-
/**
|
|
23041
|
-
* Total number of orders
|
|
23042
|
-
* @type {number}
|
|
23043
|
-
* @memberof SalesSummaryDtoV6
|
|
23044
|
-
*/
|
|
23045
|
-
'totalOrders'?: number;
|
|
23046
|
-
/**
|
|
23047
|
-
* Total sales amount
|
|
23048
|
-
* @type {number}
|
|
23049
|
-
* @memberof SalesSummaryDtoV6
|
|
23050
|
-
*/
|
|
23051
|
-
'totalSales'?: number;
|
|
23052
|
-
/**
|
|
23053
|
-
* Net sales amount after adjustments
|
|
23054
|
-
* @type {number}
|
|
23055
|
-
* @memberof SalesSummaryDtoV6
|
|
23056
|
-
*/
|
|
23057
|
-
'netSales'?: number;
|
|
23058
|
-
/**
|
|
23059
|
-
* Total amount actually paid
|
|
23060
|
-
* @type {number}
|
|
23061
|
-
* @memberof SalesSummaryDtoV6
|
|
23062
|
-
*/
|
|
23063
|
-
'totalPaid'?: number;
|
|
23064
|
-
/**
|
|
23065
|
-
* Total difference
|
|
23066
|
-
* @type {number}
|
|
23067
|
-
* @memberof SalesSummaryDtoV6
|
|
23068
|
-
*/
|
|
23069
|
-
'totalDifference'?: number;
|
|
23070
|
-
/**
|
|
23071
|
-
* Total transactions
|
|
23072
|
-
* @type {number}
|
|
23073
|
-
* @memberof SalesSummaryDtoV6
|
|
23074
|
-
*/
|
|
23075
|
-
'totalTransactions'?: number;
|
|
23076
|
-
/**
|
|
23077
|
-
* Number of rejected orders
|
|
23078
|
-
* @type {number}
|
|
23079
|
-
* @memberof SalesSummaryDtoV6
|
|
23080
|
-
*/
|
|
23081
|
-
'rejectedOrders'?: number;
|
|
23082
|
-
/**
|
|
23083
|
-
* Total rejected sales amount
|
|
23084
|
-
* @type {number}
|
|
23085
|
-
* @memberof SalesSummaryDtoV6
|
|
23086
|
-
*/
|
|
23087
|
-
'rejectedSales'?: number;
|
|
23088
|
-
/**
|
|
23089
|
-
* Average sales per order
|
|
23090
|
-
* @type {number}
|
|
23091
|
-
* @memberof SalesSummaryDtoV6
|
|
23092
|
-
*/
|
|
23093
|
-
'averageSales'?: number;
|
|
23094
|
-
/**
|
|
23095
|
-
* Total number of items sold
|
|
23096
|
-
* @type {number}
|
|
23097
|
-
* @memberof SalesSummaryDtoV6
|
|
23098
|
-
*/
|
|
23099
|
-
'totalItemsCount'?: number;
|
|
23100
|
-
/**
|
|
23101
|
-
* Total refund amount
|
|
23102
|
-
* @type {number}
|
|
23103
|
-
* @memberof SalesSummaryDtoV6
|
|
23104
|
-
*/
|
|
23105
|
-
'totalRefunds'?: number;
|
|
23106
|
-
/**
|
|
23107
|
-
* Total discount amount given
|
|
23108
|
-
* @type {number}
|
|
23109
|
-
* @memberof SalesSummaryDtoV6
|
|
23110
|
-
*/
|
|
23111
|
-
'totalDiscounts'?: number;
|
|
23112
|
-
/**
|
|
23113
|
-
* Total voucher forfeited amount in cents
|
|
23114
|
-
* @type {number}
|
|
23115
|
-
* @memberof SalesSummaryDtoV6
|
|
23116
|
-
*/
|
|
23117
|
-
'totalVoucherForfeited'?: number;
|
|
23118
|
-
/**
|
|
23119
|
-
* Total amount of all payment methods
|
|
23120
|
-
* @type {number}
|
|
23121
|
-
* @memberof SalesSummaryDtoV6
|
|
23122
|
-
*/
|
|
23123
|
-
'totalPaymentAmount'?: number;
|
|
23124
|
-
/**
|
|
23125
|
-
* Total tip amount in cents
|
|
23126
|
-
* @type {number}
|
|
23127
|
-
* @memberof SalesSummaryDtoV6
|
|
23128
|
-
*/
|
|
23129
|
-
'totalTipAmount'?: number;
|
|
23130
|
-
/**
|
|
23131
|
-
* Total surcharge amount in cents
|
|
23132
|
-
* @type {number}
|
|
23133
|
-
* @memberof SalesSummaryDtoV6
|
|
23134
|
-
*/
|
|
23135
|
-
'totalSurchargeAmount'?: number;
|
|
23136
|
-
}
|
|
23137
21883
|
/**
|
|
23138
21884
|
*
|
|
23139
21885
|
* @export
|
|
@@ -23205,55 +21951,6 @@ export declare const ScheduleType: {
|
|
|
23205
21951
|
readonly Physical: "PHYSICAL";
|
|
23206
21952
|
};
|
|
23207
21953
|
export type ScheduleType = typeof ScheduleType[keyof typeof ScheduleType];
|
|
23208
|
-
/**
|
|
23209
|
-
*
|
|
23210
|
-
* @export
|
|
23211
|
-
* @interface ScopedTokenResponseDto
|
|
23212
|
-
*/
|
|
23213
|
-
export interface ScopedTokenResponseDto {
|
|
23214
|
-
/**
|
|
23215
|
-
* Send as the Bearer token on every request, to v1–v5 and v6 routes alike
|
|
23216
|
-
* @type {string}
|
|
23217
|
-
* @memberof ScopedTokenResponseDto
|
|
23218
|
-
*/
|
|
23219
|
-
'scopedToken': string;
|
|
23220
|
-
/**
|
|
23221
|
-
* Single-use; renews this token within 30 days. The response carries the next ticket
|
|
23222
|
-
* @type {string}
|
|
23223
|
-
* @memberof ScopedTokenResponseDto
|
|
23224
|
-
*/
|
|
23225
|
-
'renewalTicket': string;
|
|
23226
|
-
/**
|
|
23227
|
-
* Seconds until the scoped token expires
|
|
23228
|
-
* @type {number}
|
|
23229
|
-
* @memberof ScopedTokenResponseDto
|
|
23230
|
-
*/
|
|
23231
|
-
'expiresIn': number;
|
|
23232
|
-
/**
|
|
23233
|
-
*
|
|
23234
|
-
* @type {ActorType}
|
|
23235
|
-
* @memberof ScopedTokenResponseDto
|
|
23236
|
-
*/
|
|
23237
|
-
'actorType': ActorType;
|
|
23238
|
-
/**
|
|
23239
|
-
*
|
|
23240
|
-
* @type {OperatingMode}
|
|
23241
|
-
* @memberof ScopedTokenResponseDto
|
|
23242
|
-
*/
|
|
23243
|
-
'mode': OperatingMode;
|
|
23244
|
-
/**
|
|
23245
|
-
*
|
|
23246
|
-
* @type {Array<PosPermission>}
|
|
23247
|
-
* @memberof ScopedTokenResponseDto
|
|
23248
|
-
*/
|
|
23249
|
-
'scopes': Array<PosPermission>;
|
|
23250
|
-
/**
|
|
23251
|
-
* PINLOCK: permissions that require an action approval
|
|
23252
|
-
* @type {Array<PosPermission>}
|
|
23253
|
-
* @memberof ScopedTokenResponseDto
|
|
23254
|
-
*/
|
|
23255
|
-
'protectedScopes': Array<PosPermission>;
|
|
23256
|
-
}
|
|
23257
21954
|
/**
|
|
23258
21955
|
*
|
|
23259
21956
|
* @export
|
|
@@ -30585,248 +29282,20 @@ export declare class AblyApi extends BaseAPI implements AblyApiInterface {
|
|
|
30585
29282
|
requestSettings(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
30586
29283
|
}
|
|
30587
29284
|
/**
|
|
30588
|
-
*
|
|
30589
|
-
* @export
|
|
30590
|
-
*/
|
|
30591
|
-
export declare const AccessControlApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30592
|
-
/**
|
|
30593
|
-
* 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.
|
|
30594
|
-
* @summary Every POS permission with its label, group and kind
|
|
30595
|
-
* @param {*} [options] Override http request option.
|
|
30596
|
-
* @throws {RequiredError}
|
|
30597
|
-
*/
|
|
30598
|
-
getPermissionCatalogV1: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30599
|
-
/**
|
|
30600
|
-
* 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.
|
|
30601
|
-
* @summary Exchange a PINLOCK passcode PIN for an approval of one protected permission
|
|
30602
|
-
* @param {IssueActionApprovalDto} issueActionApprovalDto
|
|
30603
|
-
* @param {*} [options] Override http request option.
|
|
30604
|
-
* @throws {RequiredError}
|
|
30605
|
-
*/
|
|
30606
|
-
issueActionApprovalV1: (issueActionApprovalDto: IssueActionApprovalDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30607
|
-
/**
|
|
30608
|
-
* 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.
|
|
30609
|
-
* @summary Exchange the tablet token and an employee\'s PIN for the employee\'s scoped token
|
|
30610
|
-
* @param {IssueEmployeeTokenDto} issueEmployeeTokenDto
|
|
30611
|
-
* @param {*} [options] Override http request option.
|
|
30612
|
-
* @throws {RequiredError}
|
|
30613
|
-
*/
|
|
30614
|
-
issueEmployeeTokenV1: (issueEmployeeTokenDto: IssueEmployeeTokenDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30615
|
-
/**
|
|
30616
|
-
* 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.
|
|
30617
|
-
* @summary Exchange the login token for the tablet\'s scoped token and renewal ticket
|
|
30618
|
-
* @param {IssueTabletTokenDto} issueTabletTokenDto
|
|
30619
|
-
* @param {*} [options] Override http request option.
|
|
30620
|
-
* @throws {RequiredError}
|
|
30621
|
-
*/
|
|
30622
|
-
issueTabletTokenV1: (issueTabletTokenDto: IssueTabletTokenDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30623
|
-
/**
|
|
30624
|
-
* 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.
|
|
30625
|
-
* @summary Renew a scoped token with its renewal ticket
|
|
30626
|
-
* @param {RenewScopedTokenDto} renewScopedTokenDto
|
|
30627
|
-
* @param {*} [options] Override http request option.
|
|
30628
|
-
* @throws {RequiredError}
|
|
30629
|
-
*/
|
|
30630
|
-
renewScopedTokenV1: (renewScopedTokenDto: RenewScopedTokenDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30631
|
-
};
|
|
30632
|
-
/**
|
|
30633
|
-
* AccessControlApi - functional programming interface
|
|
30634
|
-
* @export
|
|
30635
|
-
*/
|
|
30636
|
-
export declare const AccessControlApiFp: (configuration?: Configuration) => {
|
|
30637
|
-
/**
|
|
30638
|
-
* 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.
|
|
30639
|
-
* @summary Every POS permission with its label, group and kind
|
|
30640
|
-
* @param {*} [options] Override http request option.
|
|
30641
|
-
* @throws {RequiredError}
|
|
30642
|
-
*/
|
|
30643
|
-
getPermissionCatalogV1(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PermissionGroupDto>>>;
|
|
30644
|
-
/**
|
|
30645
|
-
* 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.
|
|
30646
|
-
* @summary Exchange a PINLOCK passcode PIN for an approval of one protected permission
|
|
30647
|
-
* @param {IssueActionApprovalDto} issueActionApprovalDto
|
|
30648
|
-
* @param {*} [options] Override http request option.
|
|
30649
|
-
* @throws {RequiredError}
|
|
30650
|
-
*/
|
|
30651
|
-
issueActionApprovalV1(issueActionApprovalDto: IssueActionApprovalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionApprovalResponseDto>>;
|
|
30652
|
-
/**
|
|
30653
|
-
* 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.
|
|
30654
|
-
* @summary Exchange the tablet token and an employee\'s PIN for the employee\'s scoped token
|
|
30655
|
-
* @param {IssueEmployeeTokenDto} issueEmployeeTokenDto
|
|
30656
|
-
* @param {*} [options] Override http request option.
|
|
30657
|
-
* @throws {RequiredError}
|
|
30658
|
-
*/
|
|
30659
|
-
issueEmployeeTokenV1(issueEmployeeTokenDto: IssueEmployeeTokenDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScopedTokenResponseDto>>;
|
|
30660
|
-
/**
|
|
30661
|
-
* 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.
|
|
30662
|
-
* @summary Exchange the login token for the tablet\'s scoped token and renewal ticket
|
|
30663
|
-
* @param {IssueTabletTokenDto} issueTabletTokenDto
|
|
30664
|
-
* @param {*} [options] Override http request option.
|
|
30665
|
-
* @throws {RequiredError}
|
|
30666
|
-
*/
|
|
30667
|
-
issueTabletTokenV1(issueTabletTokenDto: IssueTabletTokenDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScopedTokenResponseDto>>;
|
|
30668
|
-
/**
|
|
30669
|
-
* 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.
|
|
30670
|
-
* @summary Renew a scoped token with its renewal ticket
|
|
30671
|
-
* @param {RenewScopedTokenDto} renewScopedTokenDto
|
|
30672
|
-
* @param {*} [options] Override http request option.
|
|
30673
|
-
* @throws {RequiredError}
|
|
30674
|
-
*/
|
|
30675
|
-
renewScopedTokenV1(renewScopedTokenDto: RenewScopedTokenDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ScopedTokenResponseDto>>;
|
|
30676
|
-
};
|
|
30677
|
-
/**
|
|
30678
|
-
* AccessControlApi - factory interface
|
|
30679
|
-
* @export
|
|
30680
|
-
*/
|
|
30681
|
-
export declare const AccessControlApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
30682
|
-
/**
|
|
30683
|
-
* 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.
|
|
30684
|
-
* @summary Every POS permission with its label, group and kind
|
|
30685
|
-
* @param {*} [options] Override http request option.
|
|
30686
|
-
* @throws {RequiredError}
|
|
30687
|
-
*/
|
|
30688
|
-
getPermissionCatalogV1(options?: any): AxiosPromise<Array<PermissionGroupDto>>;
|
|
30689
|
-
/**
|
|
30690
|
-
* 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.
|
|
30691
|
-
* @summary Exchange a PINLOCK passcode PIN for an approval of one protected permission
|
|
30692
|
-
* @param {IssueActionApprovalDto} issueActionApprovalDto
|
|
30693
|
-
* @param {*} [options] Override http request option.
|
|
30694
|
-
* @throws {RequiredError}
|
|
30695
|
-
*/
|
|
30696
|
-
issueActionApprovalV1(issueActionApprovalDto: IssueActionApprovalDto, options?: any): AxiosPromise<ActionApprovalResponseDto>;
|
|
30697
|
-
/**
|
|
30698
|
-
* 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.
|
|
30699
|
-
* @summary Exchange the tablet token and an employee\'s PIN for the employee\'s scoped token
|
|
30700
|
-
* @param {IssueEmployeeTokenDto} issueEmployeeTokenDto
|
|
30701
|
-
* @param {*} [options] Override http request option.
|
|
30702
|
-
* @throws {RequiredError}
|
|
30703
|
-
*/
|
|
30704
|
-
issueEmployeeTokenV1(issueEmployeeTokenDto: IssueEmployeeTokenDto, options?: any): AxiosPromise<ScopedTokenResponseDto>;
|
|
30705
|
-
/**
|
|
30706
|
-
* 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.
|
|
30707
|
-
* @summary Exchange the login token for the tablet\'s scoped token and renewal ticket
|
|
30708
|
-
* @param {IssueTabletTokenDto} issueTabletTokenDto
|
|
30709
|
-
* @param {*} [options] Override http request option.
|
|
30710
|
-
* @throws {RequiredError}
|
|
30711
|
-
*/
|
|
30712
|
-
issueTabletTokenV1(issueTabletTokenDto: IssueTabletTokenDto, options?: any): AxiosPromise<ScopedTokenResponseDto>;
|
|
30713
|
-
/**
|
|
30714
|
-
* 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.
|
|
30715
|
-
* @summary Renew a scoped token with its renewal ticket
|
|
30716
|
-
* @param {RenewScopedTokenDto} renewScopedTokenDto
|
|
30717
|
-
* @param {*} [options] Override http request option.
|
|
30718
|
-
* @throws {RequiredError}
|
|
30719
|
-
*/
|
|
30720
|
-
renewScopedTokenV1(renewScopedTokenDto: RenewScopedTokenDto, options?: any): AxiosPromise<ScopedTokenResponseDto>;
|
|
30721
|
-
};
|
|
30722
|
-
/**
|
|
30723
|
-
* AccessControlApi - interface
|
|
30724
|
-
* @export
|
|
30725
|
-
* @interface AccessControlApi
|
|
30726
|
-
*/
|
|
30727
|
-
export interface AccessControlApiInterface {
|
|
30728
|
-
/**
|
|
30729
|
-
* 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.
|
|
30730
|
-
* @summary Every POS permission with its label, group and kind
|
|
30731
|
-
* @param {*} [options] Override http request option.
|
|
30732
|
-
* @throws {RequiredError}
|
|
30733
|
-
* @memberof AccessControlApiInterface
|
|
30734
|
-
*/
|
|
30735
|
-
getPermissionCatalogV1(options?: AxiosRequestConfig): AxiosPromise<Array<PermissionGroupDto>>;
|
|
30736
|
-
/**
|
|
30737
|
-
* 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.
|
|
30738
|
-
* @summary Exchange a PINLOCK passcode PIN for an approval of one protected permission
|
|
30739
|
-
* @param {IssueActionApprovalDto} issueActionApprovalDto
|
|
30740
|
-
* @param {*} [options] Override http request option.
|
|
30741
|
-
* @throws {RequiredError}
|
|
30742
|
-
* @memberof AccessControlApiInterface
|
|
30743
|
-
*/
|
|
30744
|
-
issueActionApprovalV1(issueActionApprovalDto: IssueActionApprovalDto, options?: AxiosRequestConfig): AxiosPromise<ActionApprovalResponseDto>;
|
|
30745
|
-
/**
|
|
30746
|
-
* 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.
|
|
30747
|
-
* @summary Exchange the tablet token and an employee\'s PIN for the employee\'s scoped token
|
|
30748
|
-
* @param {IssueEmployeeTokenDto} issueEmployeeTokenDto
|
|
30749
|
-
* @param {*} [options] Override http request option.
|
|
30750
|
-
* @throws {RequiredError}
|
|
30751
|
-
* @memberof AccessControlApiInterface
|
|
30752
|
-
*/
|
|
30753
|
-
issueEmployeeTokenV1(issueEmployeeTokenDto: IssueEmployeeTokenDto, options?: AxiosRequestConfig): AxiosPromise<ScopedTokenResponseDto>;
|
|
30754
|
-
/**
|
|
30755
|
-
* 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.
|
|
30756
|
-
* @summary Exchange the login token for the tablet\'s scoped token and renewal ticket
|
|
30757
|
-
* @param {IssueTabletTokenDto} issueTabletTokenDto
|
|
30758
|
-
* @param {*} [options] Override http request option.
|
|
30759
|
-
* @throws {RequiredError}
|
|
30760
|
-
* @memberof AccessControlApiInterface
|
|
30761
|
-
*/
|
|
30762
|
-
issueTabletTokenV1(issueTabletTokenDto: IssueTabletTokenDto, options?: AxiosRequestConfig): AxiosPromise<ScopedTokenResponseDto>;
|
|
30763
|
-
/**
|
|
30764
|
-
* 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.
|
|
30765
|
-
* @summary Renew a scoped token with its renewal ticket
|
|
30766
|
-
* @param {RenewScopedTokenDto} renewScopedTokenDto
|
|
30767
|
-
* @param {*} [options] Override http request option.
|
|
30768
|
-
* @throws {RequiredError}
|
|
30769
|
-
* @memberof AccessControlApiInterface
|
|
30770
|
-
*/
|
|
30771
|
-
renewScopedTokenV1(renewScopedTokenDto: RenewScopedTokenDto, options?: AxiosRequestConfig): AxiosPromise<ScopedTokenResponseDto>;
|
|
30772
|
-
}
|
|
30773
|
-
/**
|
|
30774
|
-
* AccessControlApi - object-oriented interface
|
|
29285
|
+
* ActionPasscodesApi - axios parameter creator
|
|
30775
29286
|
* @export
|
|
30776
|
-
* @class AccessControlApi
|
|
30777
|
-
* @extends {BaseAPI}
|
|
30778
29287
|
*/
|
|
30779
|
-
export declare
|
|
30780
|
-
/**
|
|
30781
|
-
* 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.
|
|
30782
|
-
* @summary Every POS permission with its label, group and kind
|
|
30783
|
-
* @param {*} [options] Override http request option.
|
|
30784
|
-
* @throws {RequiredError}
|
|
30785
|
-
* @memberof AccessControlApi
|
|
30786
|
-
*/
|
|
30787
|
-
getPermissionCatalogV1(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PermissionGroupDto[], any, {}>>;
|
|
30788
|
-
/**
|
|
30789
|
-
* 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.
|
|
30790
|
-
* @summary Exchange a PINLOCK passcode PIN for an approval of one protected permission
|
|
30791
|
-
* @param {IssueActionApprovalDto} issueActionApprovalDto
|
|
30792
|
-
* @param {*} [options] Override http request option.
|
|
30793
|
-
* @throws {RequiredError}
|
|
30794
|
-
* @memberof AccessControlApi
|
|
30795
|
-
*/
|
|
30796
|
-
issueActionApprovalV1(issueActionApprovalDto: IssueActionApprovalDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ActionApprovalResponseDto, any, {}>>;
|
|
30797
|
-
/**
|
|
30798
|
-
* 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.
|
|
30799
|
-
* @summary Exchange the tablet token and an employee\'s PIN for the employee\'s scoped token
|
|
30800
|
-
* @param {IssueEmployeeTokenDto} issueEmployeeTokenDto
|
|
30801
|
-
* @param {*} [options] Override http request option.
|
|
30802
|
-
* @throws {RequiredError}
|
|
30803
|
-
* @memberof AccessControlApi
|
|
30804
|
-
*/
|
|
30805
|
-
issueEmployeeTokenV1(issueEmployeeTokenDto: IssueEmployeeTokenDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScopedTokenResponseDto, any, {}>>;
|
|
30806
|
-
/**
|
|
30807
|
-
* 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.
|
|
30808
|
-
* @summary Exchange the login token for the tablet\'s scoped token and renewal ticket
|
|
30809
|
-
* @param {IssueTabletTokenDto} issueTabletTokenDto
|
|
30810
|
-
* @param {*} [options] Override http request option.
|
|
30811
|
-
* @throws {RequiredError}
|
|
30812
|
-
* @memberof AccessControlApi
|
|
30813
|
-
*/
|
|
30814
|
-
issueTabletTokenV1(issueTabletTokenDto: IssueTabletTokenDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScopedTokenResponseDto, any, {}>>;
|
|
29288
|
+
export declare const ActionPasscodesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30815
29289
|
/**
|
|
30816
|
-
*
|
|
30817
|
-
* @summary
|
|
30818
|
-
* @param {
|
|
29290
|
+
* 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.
|
|
29291
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
29292
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
29293
|
+
* @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.
|
|
29294
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
30819
29295
|
* @param {*} [options] Override http request option.
|
|
30820
29296
|
* @throws {RequiredError}
|
|
30821
|
-
* @memberof AccessControlApi
|
|
30822
29297
|
*/
|
|
30823
|
-
|
|
30824
|
-
}
|
|
30825
|
-
/**
|
|
30826
|
-
* ActionPasscodesApi - axios parameter creator
|
|
30827
|
-
* @export
|
|
30828
|
-
*/
|
|
30829
|
-
export declare const ActionPasscodesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
29298
|
+
checkActionPasscode: (businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30830
29299
|
/**
|
|
30831
29300
|
*
|
|
30832
29301
|
* @summary Create action passcode
|
|
@@ -30858,6 +29327,16 @@ export declare const ActionPasscodesApiAxiosParamCreator: (configuration?: Confi
|
|
|
30858
29327
|
* @export
|
|
30859
29328
|
*/
|
|
30860
29329
|
export declare const ActionPasscodesApiFp: (configuration?: Configuration) => {
|
|
29330
|
+
/**
|
|
29331
|
+
* 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.
|
|
29332
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
29333
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
29334
|
+
* @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.
|
|
29335
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
29336
|
+
* @param {*} [options] Override http request option.
|
|
29337
|
+
* @throws {RequiredError}
|
|
29338
|
+
*/
|
|
29339
|
+
checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionPasscodeCheckResponseDto>>;
|
|
30861
29340
|
/**
|
|
30862
29341
|
*
|
|
30863
29342
|
* @summary Create action passcode
|
|
@@ -30889,6 +29368,16 @@ export declare const ActionPasscodesApiFp: (configuration?: Configuration) => {
|
|
|
30889
29368
|
* @export
|
|
30890
29369
|
*/
|
|
30891
29370
|
export declare const ActionPasscodesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
29371
|
+
/**
|
|
29372
|
+
* 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.
|
|
29373
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
29374
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
29375
|
+
* @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.
|
|
29376
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
29377
|
+
* @param {*} [options] Override http request option.
|
|
29378
|
+
* @throws {RequiredError}
|
|
29379
|
+
*/
|
|
29380
|
+
checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: any): AxiosPromise<ActionPasscodeCheckResponseDto>;
|
|
30892
29381
|
/**
|
|
30893
29382
|
*
|
|
30894
29383
|
* @summary Create action passcode
|
|
@@ -30921,6 +29410,17 @@ export declare const ActionPasscodesApiFactory: (configuration?: Configuration,
|
|
|
30921
29410
|
* @interface ActionPasscodesApi
|
|
30922
29411
|
*/
|
|
30923
29412
|
export interface ActionPasscodesApiInterface {
|
|
29413
|
+
/**
|
|
29414
|
+
* 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.
|
|
29415
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
29416
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
29417
|
+
* @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.
|
|
29418
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
29419
|
+
* @param {*} [options] Override http request option.
|
|
29420
|
+
* @throws {RequiredError}
|
|
29421
|
+
* @memberof ActionPasscodesApiInterface
|
|
29422
|
+
*/
|
|
29423
|
+
checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig): AxiosPromise<ActionPasscodeCheckResponseDto>;
|
|
30924
29424
|
/**
|
|
30925
29425
|
*
|
|
30926
29426
|
* @summary Create action passcode
|
|
@@ -30957,6 +29457,17 @@ export interface ActionPasscodesApiInterface {
|
|
|
30957
29457
|
* @extends {BaseAPI}
|
|
30958
29458
|
*/
|
|
30959
29459
|
export declare class ActionPasscodesApi extends BaseAPI implements ActionPasscodesApiInterface {
|
|
29460
|
+
/**
|
|
29461
|
+
* 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.
|
|
29462
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
29463
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
29464
|
+
* @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.
|
|
29465
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
29466
|
+
* @param {*} [options] Override http request option.
|
|
29467
|
+
* @throws {RequiredError}
|
|
29468
|
+
* @memberof ActionPasscodesApi
|
|
29469
|
+
*/
|
|
29470
|
+
checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ActionPasscodeCheckResponseDto, any, {}>>;
|
|
30960
29471
|
/**
|
|
30961
29472
|
*
|
|
30962
29473
|
* @summary Create action passcode
|
|
@@ -32514,20 +31025,6 @@ export declare const CashManagementApiAxiosParamCreator: (configuration?: Config
|
|
|
32514
31025
|
* @throws {RequiredError}
|
|
32515
31026
|
*/
|
|
32516
31027
|
getCashLogs: (businessId: string, timezone: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32517
|
-
/**
|
|
32518
|
-
* 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.
|
|
32519
|
-
* @summary Cash movements of the token\'s venue, as shown from the Reports screen
|
|
32520
|
-
* @param {number} businessId
|
|
32521
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
32522
|
-
* @param {string} [start] Start date
|
|
32523
|
-
* @param {string} [end] End date
|
|
32524
|
-
* @param {number} [page] Page number
|
|
32525
|
-
* @param {number} [rowPerPage] Rows per page
|
|
32526
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
32527
|
-
* @param {*} [options] Override http request option.
|
|
32528
|
-
* @throws {RequiredError}
|
|
32529
|
-
*/
|
|
32530
|
-
getCashLogsV6: (businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32531
31028
|
/**
|
|
32532
31029
|
*
|
|
32533
31030
|
* @param {string} businessId
|
|
@@ -32588,20 +31085,6 @@ export declare const CashManagementApiFp: (configuration?: Configuration) => {
|
|
|
32588
31085
|
* @throws {RequiredError}
|
|
32589
31086
|
*/
|
|
32590
31087
|
getCashLogs(businessId: string, timezone: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashLogsPaginatedDto>>;
|
|
32591
|
-
/**
|
|
32592
|
-
* 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.
|
|
32593
|
-
* @summary Cash movements of the token\'s venue, as shown from the Reports screen
|
|
32594
|
-
* @param {number} businessId
|
|
32595
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
32596
|
-
* @param {string} [start] Start date
|
|
32597
|
-
* @param {string} [end] End date
|
|
32598
|
-
* @param {number} [page] Page number
|
|
32599
|
-
* @param {number} [rowPerPage] Rows per page
|
|
32600
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
32601
|
-
* @param {*} [options] Override http request option.
|
|
32602
|
-
* @throws {RequiredError}
|
|
32603
|
-
*/
|
|
32604
|
-
getCashLogsV6(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashLogsPaginatedDto>>;
|
|
32605
31088
|
/**
|
|
32606
31089
|
*
|
|
32607
31090
|
* @param {string} businessId
|
|
@@ -32662,20 +31145,6 @@ export declare const CashManagementApiFactory: (configuration?: Configuration, b
|
|
|
32662
31145
|
* @throws {RequiredError}
|
|
32663
31146
|
*/
|
|
32664
31147
|
getCashLogs(businessId: string, timezone: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, options?: any): AxiosPromise<CashLogsPaginatedDto>;
|
|
32665
|
-
/**
|
|
32666
|
-
* 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.
|
|
32667
|
-
* @summary Cash movements of the token\'s venue, as shown from the Reports screen
|
|
32668
|
-
* @param {number} businessId
|
|
32669
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
32670
|
-
* @param {string} [start] Start date
|
|
32671
|
-
* @param {string} [end] End date
|
|
32672
|
-
* @param {number} [page] Page number
|
|
32673
|
-
* @param {number} [rowPerPage] Rows per page
|
|
32674
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
32675
|
-
* @param {*} [options] Override http request option.
|
|
32676
|
-
* @throws {RequiredError}
|
|
32677
|
-
*/
|
|
32678
|
-
getCashLogsV6(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: any): AxiosPromise<CashLogsPaginatedDto>;
|
|
32679
31148
|
/**
|
|
32680
31149
|
*
|
|
32681
31150
|
* @param {string} businessId
|
|
@@ -32739,21 +31208,6 @@ export interface CashManagementApiInterface {
|
|
|
32739
31208
|
* @memberof CashManagementApiInterface
|
|
32740
31209
|
*/
|
|
32741
31210
|
getCashLogs(businessId: string, timezone: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, options?: AxiosRequestConfig): AxiosPromise<CashLogsPaginatedDto>;
|
|
32742
|
-
/**
|
|
32743
|
-
* 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.
|
|
32744
|
-
* @summary Cash movements of the token\'s venue, as shown from the Reports screen
|
|
32745
|
-
* @param {number} businessId
|
|
32746
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
32747
|
-
* @param {string} [start] Start date
|
|
32748
|
-
* @param {string} [end] End date
|
|
32749
|
-
* @param {number} [page] Page number
|
|
32750
|
-
* @param {number} [rowPerPage] Rows per page
|
|
32751
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
32752
|
-
* @param {*} [options] Override http request option.
|
|
32753
|
-
* @throws {RequiredError}
|
|
32754
|
-
* @memberof CashManagementApiInterface
|
|
32755
|
-
*/
|
|
32756
|
-
getCashLogsV6(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<CashLogsPaginatedDto>;
|
|
32757
31211
|
/**
|
|
32758
31212
|
*
|
|
32759
31213
|
* @param {string} businessId
|
|
@@ -32822,21 +31276,6 @@ export declare class CashManagementApi extends BaseAPI implements CashManagement
|
|
|
32822
31276
|
* @memberof CashManagementApi
|
|
32823
31277
|
*/
|
|
32824
31278
|
getCashLogs(businessId: string, timezone: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CashLogsPaginatedDto, any, {}>>;
|
|
32825
|
-
/**
|
|
32826
|
-
* 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.
|
|
32827
|
-
* @summary Cash movements of the token\'s venue, as shown from the Reports screen
|
|
32828
|
-
* @param {number} businessId
|
|
32829
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
32830
|
-
* @param {string} [start] Start date
|
|
32831
|
-
* @param {string} [end] End date
|
|
32832
|
-
* @param {number} [page] Page number
|
|
32833
|
-
* @param {number} [rowPerPage] Rows per page
|
|
32834
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
32835
|
-
* @param {*} [options] Override http request option.
|
|
32836
|
-
* @throws {RequiredError}
|
|
32837
|
-
* @memberof CashManagementApi
|
|
32838
|
-
*/
|
|
32839
|
-
getCashLogsV6(businessId: number, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CashLogsPaginatedDto, any, {}>>;
|
|
32840
31279
|
/**
|
|
32841
31280
|
*
|
|
32842
31281
|
* @param {string} businessId
|
|
@@ -32874,6 +31313,111 @@ export declare class CashManagementApi extends BaseAPI implements CashManagement
|
|
|
32874
31313
|
*/
|
|
32875
31314
|
sendSessionReport(businessId: string, sessionId: string, sendCashReportDto: SendCashReportDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
32876
31315
|
}
|
|
31316
|
+
/**
|
|
31317
|
+
* CashManagementV6Api - axios parameter creator
|
|
31318
|
+
* @export
|
|
31319
|
+
*/
|
|
31320
|
+
export declare const CashManagementV6ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
31321
|
+
/**
|
|
31322
|
+
* The same answer as v1. In team mode, a role without Report::ViewCashLogs gets an empty page, and a role without Report::ViewAll gets only the entries of the person unlocked on the till. A till with nobody unlocked on the server gets the v1 answer unchanged.
|
|
31323
|
+
* @summary Cash logs, narrowed to the person working on the till
|
|
31324
|
+
* @param {string} businessId Id of the venue whose cash logs are read
|
|
31325
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
31326
|
+
* @param {string} [start] Start date
|
|
31327
|
+
* @param {string} [end] End date
|
|
31328
|
+
* @param {number} [page] Page number
|
|
31329
|
+
* @param {number} [rowPerPage] Rows per page
|
|
31330
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
31331
|
+
* @param {*} [options] Override http request option.
|
|
31332
|
+
* @throws {RequiredError}
|
|
31333
|
+
*/
|
|
31334
|
+
listCashLogsForTill: (businessId: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
31335
|
+
};
|
|
31336
|
+
/**
|
|
31337
|
+
* CashManagementV6Api - functional programming interface
|
|
31338
|
+
* @export
|
|
31339
|
+
*/
|
|
31340
|
+
export declare const CashManagementV6ApiFp: (configuration?: Configuration) => {
|
|
31341
|
+
/**
|
|
31342
|
+
* The same answer as v1. In team mode, a role without Report::ViewCashLogs gets an empty page, and a role without Report::ViewAll gets only the entries of the person unlocked on the till. A till with nobody unlocked on the server gets the v1 answer unchanged.
|
|
31343
|
+
* @summary Cash logs, narrowed to the person working on the till
|
|
31344
|
+
* @param {string} businessId Id of the venue whose cash logs are read
|
|
31345
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
31346
|
+
* @param {string} [start] Start date
|
|
31347
|
+
* @param {string} [end] End date
|
|
31348
|
+
* @param {number} [page] Page number
|
|
31349
|
+
* @param {number} [rowPerPage] Rows per page
|
|
31350
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
31351
|
+
* @param {*} [options] Override http request option.
|
|
31352
|
+
* @throws {RequiredError}
|
|
31353
|
+
*/
|
|
31354
|
+
listCashLogsForTill(businessId: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashLogsPaginatedDto>>;
|
|
31355
|
+
};
|
|
31356
|
+
/**
|
|
31357
|
+
* CashManagementV6Api - factory interface
|
|
31358
|
+
* @export
|
|
31359
|
+
*/
|
|
31360
|
+
export declare const CashManagementV6ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
31361
|
+
/**
|
|
31362
|
+
* The same answer as v1. In team mode, a role without Report::ViewCashLogs gets an empty page, and a role without Report::ViewAll gets only the entries of the person unlocked on the till. A till with nobody unlocked on the server gets the v1 answer unchanged.
|
|
31363
|
+
* @summary Cash logs, narrowed to the person working on the till
|
|
31364
|
+
* @param {string} businessId Id of the venue whose cash logs are read
|
|
31365
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
31366
|
+
* @param {string} [start] Start date
|
|
31367
|
+
* @param {string} [end] End date
|
|
31368
|
+
* @param {number} [page] Page number
|
|
31369
|
+
* @param {number} [rowPerPage] Rows per page
|
|
31370
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
31371
|
+
* @param {*} [options] Override http request option.
|
|
31372
|
+
* @throws {RequiredError}
|
|
31373
|
+
*/
|
|
31374
|
+
listCashLogsForTill(businessId: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: any): AxiosPromise<CashLogsPaginatedDto>;
|
|
31375
|
+
};
|
|
31376
|
+
/**
|
|
31377
|
+
* CashManagementV6Api - interface
|
|
31378
|
+
* @export
|
|
31379
|
+
* @interface CashManagementV6Api
|
|
31380
|
+
*/
|
|
31381
|
+
export interface CashManagementV6ApiInterface {
|
|
31382
|
+
/**
|
|
31383
|
+
* The same answer as v1. In team mode, a role without Report::ViewCashLogs gets an empty page, and a role without Report::ViewAll gets only the entries of the person unlocked on the till. A till with nobody unlocked on the server gets the v1 answer unchanged.
|
|
31384
|
+
* @summary Cash logs, narrowed to the person working on the till
|
|
31385
|
+
* @param {string} businessId Id of the venue whose cash logs are read
|
|
31386
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
31387
|
+
* @param {string} [start] Start date
|
|
31388
|
+
* @param {string} [end] End date
|
|
31389
|
+
* @param {number} [page] Page number
|
|
31390
|
+
* @param {number} [rowPerPage] Rows per page
|
|
31391
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
31392
|
+
* @param {*} [options] Override http request option.
|
|
31393
|
+
* @throws {RequiredError}
|
|
31394
|
+
* @memberof CashManagementV6ApiInterface
|
|
31395
|
+
*/
|
|
31396
|
+
listCashLogsForTill(businessId: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<CashLogsPaginatedDto>;
|
|
31397
|
+
}
|
|
31398
|
+
/**
|
|
31399
|
+
* CashManagementV6Api - object-oriented interface
|
|
31400
|
+
* @export
|
|
31401
|
+
* @class CashManagementV6Api
|
|
31402
|
+
* @extends {BaseAPI}
|
|
31403
|
+
*/
|
|
31404
|
+
export declare class CashManagementV6Api extends BaseAPI implements CashManagementV6ApiInterface {
|
|
31405
|
+
/**
|
|
31406
|
+
* The same answer as v1. In team mode, a role without Report::ViewCashLogs gets an empty page, and a role without Report::ViewAll gets only the entries of the person unlocked on the till. A till with nobody unlocked on the server gets the v1 answer unchanged.
|
|
31407
|
+
* @summary Cash logs, narrowed to the person working on the till
|
|
31408
|
+
* @param {string} businessId Id of the venue whose cash logs are read
|
|
31409
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
31410
|
+
* @param {string} [start] Start date
|
|
31411
|
+
* @param {string} [end] End date
|
|
31412
|
+
* @param {number} [page] Page number
|
|
31413
|
+
* @param {number} [rowPerPage] Rows per page
|
|
31414
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
31415
|
+
* @param {*} [options] Override http request option.
|
|
31416
|
+
* @throws {RequiredError}
|
|
31417
|
+
* @memberof CashManagementV6Api
|
|
31418
|
+
*/
|
|
31419
|
+
listCashLogsForTill(businessId: string, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CashLogsPaginatedDto, any, {}>>;
|
|
31420
|
+
}
|
|
32877
31421
|
/**
|
|
32878
31422
|
* ChannelMenuApi - axios parameter creator
|
|
32879
31423
|
* @export
|
|
@@ -35060,8 +33604,9 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
35060
33604
|
*/
|
|
35061
33605
|
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<RequestArgs>;
|
|
35062
33606
|
/**
|
|
35063
|
-
*
|
|
35064
|
-
* @summary
|
|
33607
|
+
*
|
|
33608
|
+
* @summary Get order history
|
|
33609
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
35065
33610
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35066
33611
|
* @param {string} [start] Start date
|
|
35067
33612
|
* @param {string} [end] End date
|
|
@@ -35074,14 +33619,14 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
35074
33619
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35075
33620
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35076
33621
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35077
|
-
* @param {string} [timezone]
|
|
33622
|
+
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35078
33623
|
* @param {*} [options] Override http request option.
|
|
35079
33624
|
* @throws {RequiredError}
|
|
35080
33625
|
*/
|
|
35081
|
-
|
|
33626
|
+
getOrderHistoryOnline: (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>;
|
|
35082
33627
|
/**
|
|
35083
33628
|
*
|
|
35084
|
-
* @summary Get order history
|
|
33629
|
+
* @summary Get order history for POS V5
|
|
35085
33630
|
* @param {Array<number>} businessIds Business ID selected
|
|
35086
33631
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35087
33632
|
* @param {string} [start] Start date
|
|
@@ -35099,7 +33644,7 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
35099
33644
|
* @param {*} [options] Override http request option.
|
|
35100
33645
|
* @throws {RequiredError}
|
|
35101
33646
|
*/
|
|
35102
|
-
|
|
33647
|
+
getOrderHistoryPOSV5: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35103
33648
|
/**
|
|
35104
33649
|
*
|
|
35105
33650
|
* @summary Get order history for POS V5
|
|
@@ -35120,10 +33665,16 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
35120
33665
|
* @param {*} [options] Override http request option.
|
|
35121
33666
|
* @throws {RequiredError}
|
|
35122
33667
|
*/
|
|
35123
|
-
|
|
33668
|
+
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) => Promise<RequestArgs>;
|
|
33669
|
+
};
|
|
33670
|
+
/**
|
|
33671
|
+
* HistoryApi - functional programming interface
|
|
33672
|
+
* @export
|
|
33673
|
+
*/
|
|
33674
|
+
export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
35124
33675
|
/**
|
|
35125
33676
|
*
|
|
35126
|
-
* @summary Get order history
|
|
33677
|
+
* @summary Get order history
|
|
35127
33678
|
* @param {Array<number>} businessIds Business ID selected
|
|
35128
33679
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35129
33680
|
* @param {string} [start] Start date
|
|
@@ -35141,10 +33692,11 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
35141
33692
|
* @param {*} [options] Override http request option.
|
|
35142
33693
|
* @throws {RequiredError}
|
|
35143
33694
|
*/
|
|
35144
|
-
|
|
33695
|
+
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>>;
|
|
35145
33696
|
/**
|
|
35146
|
-
*
|
|
35147
|
-
* @summary
|
|
33697
|
+
*
|
|
33698
|
+
* @summary Get order history
|
|
33699
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
35148
33700
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35149
33701
|
* @param {string} [start] Start date
|
|
35150
33702
|
* @param {string} [end] End date
|
|
@@ -35157,20 +33709,14 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
35157
33709
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35158
33710
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35159
33711
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35160
|
-
* @param {string} [timezone]
|
|
33712
|
+
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35161
33713
|
* @param {*} [options] Override http request option.
|
|
35162
33714
|
* @throws {RequiredError}
|
|
35163
33715
|
*/
|
|
35164
|
-
|
|
35165
|
-
};
|
|
35166
|
-
/**
|
|
35167
|
-
* HistoryApi - functional programming interface
|
|
35168
|
-
* @export
|
|
35169
|
-
*/
|
|
35170
|
-
export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
33716
|
+
getOrderHistoryOnline(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>>;
|
|
35171
33717
|
/**
|
|
35172
33718
|
*
|
|
35173
|
-
* @summary Get order history
|
|
33719
|
+
* @summary Get order history for POS V5
|
|
35174
33720
|
* @param {Array<number>} businessIds Business ID selected
|
|
35175
33721
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35176
33722
|
* @param {string} [start] Start date
|
|
@@ -35188,10 +33734,11 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
35188
33734
|
* @param {*} [options] Override http request option.
|
|
35189
33735
|
* @throws {RequiredError}
|
|
35190
33736
|
*/
|
|
35191
|
-
|
|
33737
|
+
getOrderHistoryPOSV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderHistoryPosResponseDtoV2>>;
|
|
35192
33738
|
/**
|
|
35193
|
-
*
|
|
35194
|
-
* @summary
|
|
33739
|
+
*
|
|
33740
|
+
* @summary Get order history for POS V5
|
|
33741
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
35195
33742
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35196
33743
|
* @param {string} [start] Start date
|
|
35197
33744
|
* @param {string} [end] End date
|
|
@@ -35204,11 +33751,17 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
35204
33751
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35205
33752
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35206
33753
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35207
|
-
* @param {string} [timezone]
|
|
33754
|
+
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35208
33755
|
* @param {*} [options] Override http request option.
|
|
35209
33756
|
* @throws {RequiredError}
|
|
35210
33757
|
*/
|
|
35211
|
-
|
|
33758
|
+
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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderHistoryPosResponseDtoV2>>;
|
|
33759
|
+
};
|
|
33760
|
+
/**
|
|
33761
|
+
* HistoryApi - factory interface
|
|
33762
|
+
* @export
|
|
33763
|
+
*/
|
|
33764
|
+
export declare const HistoryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
35212
33765
|
/**
|
|
35213
33766
|
*
|
|
35214
33767
|
* @summary Get order history
|
|
@@ -35229,10 +33782,10 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
35229
33782
|
* @param {*} [options] Override http request option.
|
|
35230
33783
|
* @throws {RequiredError}
|
|
35231
33784
|
*/
|
|
35232
|
-
|
|
33785
|
+
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>;
|
|
35233
33786
|
/**
|
|
35234
33787
|
*
|
|
35235
|
-
* @summary Get order history
|
|
33788
|
+
* @summary Get order history
|
|
35236
33789
|
* @param {Array<number>} businessIds Business ID selected
|
|
35237
33790
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35238
33791
|
* @param {string} [start] Start date
|
|
@@ -35250,7 +33803,7 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
35250
33803
|
* @param {*} [options] Override http request option.
|
|
35251
33804
|
* @throws {RequiredError}
|
|
35252
33805
|
*/
|
|
35253
|
-
|
|
33806
|
+
getOrderHistoryOnline(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>;
|
|
35254
33807
|
/**
|
|
35255
33808
|
*
|
|
35256
33809
|
* @summary Get order history for POS V5
|
|
@@ -35271,10 +33824,11 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
35271
33824
|
* @param {*} [options] Override http request option.
|
|
35272
33825
|
* @throws {RequiredError}
|
|
35273
33826
|
*/
|
|
35274
|
-
|
|
33827
|
+
getOrderHistoryPOSV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: any): AxiosPromise<OrderHistoryPosResponseDtoV2>;
|
|
35275
33828
|
/**
|
|
35276
|
-
*
|
|
35277
|
-
* @summary
|
|
33829
|
+
*
|
|
33830
|
+
* @summary Get order history for POS V5
|
|
33831
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
35278
33832
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35279
33833
|
* @param {string} [start] Start date
|
|
35280
33834
|
* @param {string} [end] End date
|
|
@@ -35287,17 +33841,18 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
35287
33841
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35288
33842
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35289
33843
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35290
|
-
* @param {string} [timezone]
|
|
33844
|
+
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35291
33845
|
* @param {*} [options] Override http request option.
|
|
35292
33846
|
* @throws {RequiredError}
|
|
35293
33847
|
*/
|
|
35294
|
-
|
|
33848
|
+
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>;
|
|
35295
33849
|
};
|
|
35296
33850
|
/**
|
|
35297
|
-
* HistoryApi -
|
|
33851
|
+
* HistoryApi - interface
|
|
35298
33852
|
* @export
|
|
33853
|
+
* @interface HistoryApi
|
|
35299
33854
|
*/
|
|
35300
|
-
export
|
|
33855
|
+
export interface HistoryApiInterface {
|
|
35301
33856
|
/**
|
|
35302
33857
|
*
|
|
35303
33858
|
* @summary Get order history
|
|
@@ -35317,11 +33872,13 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
35317
33872
|
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35318
33873
|
* @param {*} [options] Override http request option.
|
|
35319
33874
|
* @throws {RequiredError}
|
|
33875
|
+
* @memberof HistoryApiInterface
|
|
35320
33876
|
*/
|
|
35321
|
-
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?:
|
|
33877
|
+
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>;
|
|
35322
33878
|
/**
|
|
35323
|
-
*
|
|
35324
|
-
* @summary
|
|
33879
|
+
*
|
|
33880
|
+
* @summary Get order history
|
|
33881
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
35325
33882
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35326
33883
|
* @param {string} [start] Start date
|
|
35327
33884
|
* @param {string} [end] End date
|
|
@@ -35334,14 +33891,15 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
35334
33891
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35335
33892
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35336
33893
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35337
|
-
* @param {string} [timezone]
|
|
33894
|
+
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35338
33895
|
* @param {*} [options] Override http request option.
|
|
35339
33896
|
* @throws {RequiredError}
|
|
33897
|
+
* @memberof HistoryApiInterface
|
|
35340
33898
|
*/
|
|
35341
|
-
|
|
33899
|
+
getOrderHistoryOnline(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>;
|
|
35342
33900
|
/**
|
|
35343
33901
|
*
|
|
35344
|
-
* @summary Get order history
|
|
33902
|
+
* @summary Get order history for POS V5
|
|
35345
33903
|
* @param {Array<number>} businessIds Business ID selected
|
|
35346
33904
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35347
33905
|
* @param {string} [start] Start date
|
|
@@ -35358,8 +33916,9 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
35358
33916
|
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35359
33917
|
* @param {*} [options] Override http request option.
|
|
35360
33918
|
* @throws {RequiredError}
|
|
33919
|
+
* @memberof HistoryApiInterface
|
|
35361
33920
|
*/
|
|
35362
|
-
|
|
33921
|
+
getOrderHistoryPOSV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<OrderHistoryPosResponseDtoV2>;
|
|
35363
33922
|
/**
|
|
35364
33923
|
*
|
|
35365
33924
|
* @summary Get order history for POS V5
|
|
@@ -35379,11 +33938,20 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
35379
33938
|
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35380
33939
|
* @param {*} [options] Override http request option.
|
|
35381
33940
|
* @throws {RequiredError}
|
|
33941
|
+
* @memberof HistoryApiInterface
|
|
35382
33942
|
*/
|
|
35383
|
-
|
|
33943
|
+
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>;
|
|
33944
|
+
}
|
|
33945
|
+
/**
|
|
33946
|
+
* HistoryApi - object-oriented interface
|
|
33947
|
+
* @export
|
|
33948
|
+
* @class HistoryApi
|
|
33949
|
+
* @extends {BaseAPI}
|
|
33950
|
+
*/
|
|
33951
|
+
export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
35384
33952
|
/**
|
|
35385
33953
|
*
|
|
35386
|
-
* @summary Get order history
|
|
33954
|
+
* @summary Get order history
|
|
35387
33955
|
* @param {Array<number>} businessIds Business ID selected
|
|
35388
33956
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35389
33957
|
* @param {string} [start] Start date
|
|
@@ -35400,11 +33968,13 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
35400
33968
|
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35401
33969
|
* @param {*} [options] Override http request option.
|
|
35402
33970
|
* @throws {RequiredError}
|
|
33971
|
+
* @memberof HistoryApi
|
|
35403
33972
|
*/
|
|
35404
|
-
|
|
33973
|
+
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<import("axios").AxiosResponse<OrderHistoryResponseDto, any, {}>>;
|
|
35405
33974
|
/**
|
|
35406
|
-
*
|
|
35407
|
-
* @summary
|
|
33975
|
+
*
|
|
33976
|
+
* @summary Get order history
|
|
33977
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
35408
33978
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35409
33979
|
* @param {string} [start] Start date
|
|
35410
33980
|
* @param {string} [end] End date
|
|
@@ -35417,21 +33987,15 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
35417
33987
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35418
33988
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35419
33989
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35420
|
-
* @param {string} [timezone]
|
|
33990
|
+
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35421
33991
|
* @param {*} [options] Override http request option.
|
|
35422
33992
|
* @throws {RequiredError}
|
|
33993
|
+
* @memberof HistoryApi
|
|
35423
33994
|
*/
|
|
35424
|
-
|
|
35425
|
-
};
|
|
35426
|
-
/**
|
|
35427
|
-
* HistoryApi - interface
|
|
35428
|
-
* @export
|
|
35429
|
-
* @interface HistoryApi
|
|
35430
|
-
*/
|
|
35431
|
-
export interface HistoryApiInterface {
|
|
33995
|
+
getOrderHistoryOnline(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderHistoryResponseDto, any, {}>>;
|
|
35432
33996
|
/**
|
|
35433
33997
|
*
|
|
35434
|
-
* @summary Get order history
|
|
33998
|
+
* @summary Get order history for POS V5
|
|
35435
33999
|
* @param {Array<number>} businessIds Business ID selected
|
|
35436
34000
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35437
34001
|
* @param {string} [start] Start date
|
|
@@ -35448,12 +34012,13 @@ export interface HistoryApiInterface {
|
|
|
35448
34012
|
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35449
34013
|
* @param {*} [options] Override http request option.
|
|
35450
34014
|
* @throws {RequiredError}
|
|
35451
|
-
* @memberof
|
|
34015
|
+
* @memberof HistoryApi
|
|
35452
34016
|
*/
|
|
35453
|
-
|
|
34017
|
+
getOrderHistoryPOSV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderHistoryPosResponseDtoV2, any, {}>>;
|
|
35454
34018
|
/**
|
|
35455
|
-
*
|
|
35456
|
-
* @summary
|
|
34019
|
+
*
|
|
34020
|
+
* @summary Get order history for POS V5
|
|
34021
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
35457
34022
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35458
34023
|
* @param {string} [start] Start date
|
|
35459
34024
|
* @param {string} [end] End date
|
|
@@ -35466,15 +34031,21 @@ export interface HistoryApiInterface {
|
|
|
35466
34031
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35467
34032
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35468
34033
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35469
|
-
* @param {string} [timezone]
|
|
34034
|
+
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
35470
34035
|
* @param {*} [options] Override http request option.
|
|
35471
34036
|
* @throws {RequiredError}
|
|
35472
|
-
* @memberof
|
|
34037
|
+
* @memberof HistoryApi
|
|
35473
34038
|
*/
|
|
35474
|
-
|
|
34039
|
+
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): Promise<import("axios").AxiosResponse<OrderHistoryPosResponseDtoV2, any, {}>>;
|
|
34040
|
+
}
|
|
34041
|
+
/**
|
|
34042
|
+
* HistoryV6Api - axios parameter creator
|
|
34043
|
+
* @export
|
|
34044
|
+
*/
|
|
34045
|
+
export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
35475
34046
|
/**
|
|
35476
|
-
*
|
|
35477
|
-
* @summary
|
|
34047
|
+
* The same answer as v1. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list. Online orders are listed for everyone, whoever is on the till. A till with nobody unlocked on the server gets the v1 answer unchanged.
|
|
34048
|
+
* @summary Online order history, with what the person working on the till may not see zeroed
|
|
35478
34049
|
* @param {Array<number>} businessIds Business ID selected
|
|
35479
34050
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35480
34051
|
* @param {string} [start] Start date
|
|
@@ -35488,15 +34059,14 @@ export interface HistoryApiInterface {
|
|
|
35488
34059
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35489
34060
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35490
34061
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35491
|
-
* @param {string} [timezone] Timezone (default
|
|
34062
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
35492
34063
|
* @param {*} [options] Override http request option.
|
|
35493
34064
|
* @throws {RequiredError}
|
|
35494
|
-
* @memberof HistoryApiInterface
|
|
35495
34065
|
*/
|
|
35496
|
-
|
|
34066
|
+
listOnlineOrderHistoryForTill: (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>;
|
|
35497
34067
|
/**
|
|
35498
|
-
*
|
|
35499
|
-
* @summary
|
|
34068
|
+
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
34069
|
+
* @summary POS order history, narrowed to the person working on the till
|
|
35500
34070
|
* @param {Array<number>} businessIds Business ID selected
|
|
35501
34071
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35502
34072
|
* @param {string} [start] Start date
|
|
@@ -35510,15 +34080,20 @@ export interface HistoryApiInterface {
|
|
|
35510
34080
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35511
34081
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35512
34082
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35513
|
-
* @param {string} [timezone] Timezone (default
|
|
34083
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
35514
34084
|
* @param {*} [options] Override http request option.
|
|
35515
34085
|
* @throws {RequiredError}
|
|
35516
|
-
* @memberof HistoryApiInterface
|
|
35517
34086
|
*/
|
|
35518
|
-
|
|
34087
|
+
listOrderHistoryForTill: (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>;
|
|
34088
|
+
};
|
|
34089
|
+
/**
|
|
34090
|
+
* HistoryV6Api - functional programming interface
|
|
34091
|
+
* @export
|
|
34092
|
+
*/
|
|
34093
|
+
export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
35519
34094
|
/**
|
|
35520
|
-
*
|
|
35521
|
-
* @summary
|
|
34095
|
+
* The same answer as v1. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list. Online orders are listed for everyone, whoever is on the till. A till with nobody unlocked on the server gets the v1 answer unchanged.
|
|
34096
|
+
* @summary Online order history, with what the person working on the till may not see zeroed
|
|
35522
34097
|
* @param {Array<number>} businessIds Business ID selected
|
|
35523
34098
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35524
34099
|
* @param {string} [start] Start date
|
|
@@ -35532,15 +34107,15 @@ export interface HistoryApiInterface {
|
|
|
35532
34107
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35533
34108
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35534
34109
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35535
|
-
* @param {string} [timezone] Timezone (default
|
|
34110
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
35536
34111
|
* @param {*} [options] Override http request option.
|
|
35537
34112
|
* @throws {RequiredError}
|
|
35538
|
-
* @memberof HistoryApiInterface
|
|
35539
34113
|
*/
|
|
35540
|
-
|
|
34114
|
+
listOnlineOrderHistoryForTill(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>>;
|
|
35541
34115
|
/**
|
|
35542
|
-
*
|
|
35543
|
-
* @summary POS order history
|
|
34116
|
+
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
34117
|
+
* @summary POS order history, narrowed to the person working on the till
|
|
34118
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
35544
34119
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35545
34120
|
* @param {string} [start] Start date
|
|
35546
34121
|
* @param {string} [end] End date
|
|
@@ -35553,23 +34128,20 @@ export interface HistoryApiInterface {
|
|
|
35553
34128
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35554
34129
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35555
34130
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35556
|
-
* @param {string} [timezone]
|
|
34131
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
35557
34132
|
* @param {*} [options] Override http request option.
|
|
35558
34133
|
* @throws {RequiredError}
|
|
35559
|
-
* @memberof HistoryApiInterface
|
|
35560
34134
|
*/
|
|
35561
|
-
|
|
35562
|
-
}
|
|
34135
|
+
listOrderHistoryForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderHistoryPosResponseDtoV2>>;
|
|
34136
|
+
};
|
|
35563
34137
|
/**
|
|
35564
|
-
*
|
|
34138
|
+
* HistoryV6Api - factory interface
|
|
35565
34139
|
* @export
|
|
35566
|
-
* @class HistoryApi
|
|
35567
|
-
* @extends {BaseAPI}
|
|
35568
34140
|
*/
|
|
35569
|
-
export declare
|
|
34141
|
+
export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
35570
34142
|
/**
|
|
35571
|
-
*
|
|
35572
|
-
* @summary
|
|
34143
|
+
* The same answer as v1. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list. Online orders are listed for everyone, whoever is on the till. A till with nobody unlocked on the server gets the v1 answer unchanged.
|
|
34144
|
+
* @summary Online order history, with what the person working on the till may not see zeroed
|
|
35573
34145
|
* @param {Array<number>} businessIds Business ID selected
|
|
35574
34146
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35575
34147
|
* @param {string} [start] Start date
|
|
@@ -35583,15 +34155,15 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
35583
34155
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35584
34156
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35585
34157
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35586
|
-
* @param {string} [timezone] Timezone (default
|
|
34158
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
35587
34159
|
* @param {*} [options] Override http request option.
|
|
35588
34160
|
* @throws {RequiredError}
|
|
35589
|
-
* @memberof HistoryApi
|
|
35590
34161
|
*/
|
|
35591
|
-
|
|
34162
|
+
listOnlineOrderHistoryForTill(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>;
|
|
35592
34163
|
/**
|
|
35593
|
-
*
|
|
35594
|
-
* @summary
|
|
34164
|
+
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
34165
|
+
* @summary POS order history, narrowed to the person working on the till
|
|
34166
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
35595
34167
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35596
34168
|
* @param {string} [start] Start date
|
|
35597
34169
|
* @param {string} [end] End date
|
|
@@ -35604,15 +34176,21 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
35604
34176
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35605
34177
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35606
34178
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35607
|
-
* @param {string} [timezone]
|
|
34179
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
35608
34180
|
* @param {*} [options] Override http request option.
|
|
35609
34181
|
* @throws {RequiredError}
|
|
35610
|
-
* @memberof HistoryApi
|
|
35611
34182
|
*/
|
|
35612
|
-
|
|
34183
|
+
listOrderHistoryForTill(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>;
|
|
34184
|
+
};
|
|
34185
|
+
/**
|
|
34186
|
+
* HistoryV6Api - interface
|
|
34187
|
+
* @export
|
|
34188
|
+
* @interface HistoryV6Api
|
|
34189
|
+
*/
|
|
34190
|
+
export interface HistoryV6ApiInterface {
|
|
35613
34191
|
/**
|
|
35614
|
-
*
|
|
35615
|
-
* @summary
|
|
34192
|
+
* The same answer as v1. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list. Online orders are listed for everyone, whoever is on the till. A till with nobody unlocked on the server gets the v1 answer unchanged.
|
|
34193
|
+
* @summary Online order history, with what the person working on the till may not see zeroed
|
|
35616
34194
|
* @param {Array<number>} businessIds Business ID selected
|
|
35617
34195
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35618
34196
|
* @param {string} [start] Start date
|
|
@@ -35626,15 +34204,15 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
35626
34204
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35627
34205
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35628
34206
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35629
|
-
* @param {string} [timezone] Timezone (default
|
|
34207
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
35630
34208
|
* @param {*} [options] Override http request option.
|
|
35631
34209
|
* @throws {RequiredError}
|
|
35632
|
-
* @memberof
|
|
34210
|
+
* @memberof HistoryV6ApiInterface
|
|
35633
34211
|
*/
|
|
35634
|
-
|
|
34212
|
+
listOnlineOrderHistoryForTill(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>;
|
|
35635
34213
|
/**
|
|
35636
|
-
*
|
|
35637
|
-
* @summary
|
|
34214
|
+
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
34215
|
+
* @summary POS order history, narrowed to the person working on the till
|
|
35638
34216
|
* @param {Array<number>} businessIds Business ID selected
|
|
35639
34217
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35640
34218
|
* @param {string} [start] Start date
|
|
@@ -35648,15 +34226,23 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
35648
34226
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35649
34227
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35650
34228
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35651
|
-
* @param {string} [timezone] Timezone (default
|
|
34229
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
35652
34230
|
* @param {*} [options] Override http request option.
|
|
35653
34231
|
* @throws {RequiredError}
|
|
35654
|
-
* @memberof
|
|
34232
|
+
* @memberof HistoryV6ApiInterface
|
|
35655
34233
|
*/
|
|
35656
|
-
|
|
34234
|
+
listOrderHistoryForTill(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>;
|
|
34235
|
+
}
|
|
34236
|
+
/**
|
|
34237
|
+
* HistoryV6Api - object-oriented interface
|
|
34238
|
+
* @export
|
|
34239
|
+
* @class HistoryV6Api
|
|
34240
|
+
* @extends {BaseAPI}
|
|
34241
|
+
*/
|
|
34242
|
+
export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterface {
|
|
35657
34243
|
/**
|
|
35658
|
-
*
|
|
35659
|
-
* @summary
|
|
34244
|
+
* The same answer as v1. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list. Online orders are listed for everyone, whoever is on the till. A till with nobody unlocked on the server gets the v1 answer unchanged.
|
|
34245
|
+
* @summary Online order history, with what the person working on the till may not see zeroed
|
|
35660
34246
|
* @param {Array<number>} businessIds Business ID selected
|
|
35661
34247
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35662
34248
|
* @param {string} [start] Start date
|
|
@@ -35670,15 +34256,16 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
35670
34256
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35671
34257
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35672
34258
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35673
|
-
* @param {string} [timezone] Timezone (default
|
|
34259
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
35674
34260
|
* @param {*} [options] Override http request option.
|
|
35675
34261
|
* @throws {RequiredError}
|
|
35676
|
-
* @memberof
|
|
34262
|
+
* @memberof HistoryV6Api
|
|
35677
34263
|
*/
|
|
35678
|
-
|
|
34264
|
+
listOnlineOrderHistoryForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderHistoryResponseDto, any, {}>>;
|
|
35679
34265
|
/**
|
|
35680
|
-
*
|
|
35681
|
-
* @summary POS order history
|
|
34266
|
+
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
34267
|
+
* @summary POS order history, narrowed to the person working on the till
|
|
34268
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
35682
34269
|
* @param {TimeSpan} [timeSpan] Time span
|
|
35683
34270
|
* @param {string} [start] Start date
|
|
35684
34271
|
* @param {string} [end] End date
|
|
@@ -35691,12 +34278,12 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
35691
34278
|
* @param {Array<OrderType>} [orderType] Order type
|
|
35692
34279
|
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35693
34280
|
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35694
|
-
* @param {string} [timezone]
|
|
34281
|
+
* @param {string} [timezone] Timezone of the period asked for (default \"UTC\")
|
|
35695
34282
|
* @param {*} [options] Override http request option.
|
|
35696
34283
|
* @throws {RequiredError}
|
|
35697
|
-
* @memberof
|
|
34284
|
+
* @memberof HistoryV6Api
|
|
35698
34285
|
*/
|
|
35699
|
-
|
|
34286
|
+
listOrderHistoryForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderHistoryPosResponseDtoV2, any, {}>>;
|
|
35700
34287
|
}
|
|
35701
34288
|
/**
|
|
35702
34289
|
* InvoiceCompaniesApi - axios parameter creator
|
|
@@ -38997,6 +37584,76 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
38997
37584
|
*/
|
|
38998
37585
|
updatePosOrderV2(posUpdateOrderDto: PosUpdateOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderStatusResponseDto, any, {}>>;
|
|
38999
37586
|
}
|
|
37587
|
+
/**
|
|
37588
|
+
* POSPermissionsApi - axios parameter creator
|
|
37589
|
+
* @export
|
|
37590
|
+
*/
|
|
37591
|
+
export declare const POSPermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
37592
|
+
/**
|
|
37593
|
+
* 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.
|
|
37594
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
37595
|
+
* @param {*} [options] Override http request option.
|
|
37596
|
+
* @throws {RequiredError}
|
|
37597
|
+
*/
|
|
37598
|
+
listPosPermissions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37599
|
+
};
|
|
37600
|
+
/**
|
|
37601
|
+
* POSPermissionsApi - functional programming interface
|
|
37602
|
+
* @export
|
|
37603
|
+
*/
|
|
37604
|
+
export declare const POSPermissionsApiFp: (configuration?: Configuration) => {
|
|
37605
|
+
/**
|
|
37606
|
+
* 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.
|
|
37607
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
37608
|
+
* @param {*} [options] Override http request option.
|
|
37609
|
+
* @throws {RequiredError}
|
|
37610
|
+
*/
|
|
37611
|
+
listPosPermissions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosPermissionCatalogResponseDto>>;
|
|
37612
|
+
};
|
|
37613
|
+
/**
|
|
37614
|
+
* POSPermissionsApi - factory interface
|
|
37615
|
+
* @export
|
|
37616
|
+
*/
|
|
37617
|
+
export declare const POSPermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
37618
|
+
/**
|
|
37619
|
+
* 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.
|
|
37620
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
37621
|
+
* @param {*} [options] Override http request option.
|
|
37622
|
+
* @throws {RequiredError}
|
|
37623
|
+
*/
|
|
37624
|
+
listPosPermissions(options?: any): AxiosPromise<PosPermissionCatalogResponseDto>;
|
|
37625
|
+
};
|
|
37626
|
+
/**
|
|
37627
|
+
* POSPermissionsApi - interface
|
|
37628
|
+
* @export
|
|
37629
|
+
* @interface POSPermissionsApi
|
|
37630
|
+
*/
|
|
37631
|
+
export interface POSPermissionsApiInterface {
|
|
37632
|
+
/**
|
|
37633
|
+
* 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.
|
|
37634
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
37635
|
+
* @param {*} [options] Override http request option.
|
|
37636
|
+
* @throws {RequiredError}
|
|
37637
|
+
* @memberof POSPermissionsApiInterface
|
|
37638
|
+
*/
|
|
37639
|
+
listPosPermissions(options?: AxiosRequestConfig): AxiosPromise<PosPermissionCatalogResponseDto>;
|
|
37640
|
+
}
|
|
37641
|
+
/**
|
|
37642
|
+
* POSPermissionsApi - object-oriented interface
|
|
37643
|
+
* @export
|
|
37644
|
+
* @class POSPermissionsApi
|
|
37645
|
+
* @extends {BaseAPI}
|
|
37646
|
+
*/
|
|
37647
|
+
export declare class POSPermissionsApi extends BaseAPI implements POSPermissionsApiInterface {
|
|
37648
|
+
/**
|
|
37649
|
+
* 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.
|
|
37650
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
37651
|
+
* @param {*} [options] Override http request option.
|
|
37652
|
+
* @throws {RequiredError}
|
|
37653
|
+
* @memberof POSPermissionsApi
|
|
37654
|
+
*/
|
|
37655
|
+
listPosPermissions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosPermissionCatalogResponseDto, any, {}>>;
|
|
37656
|
+
}
|
|
39000
37657
|
/**
|
|
39001
37658
|
* POSSessionApi - axios parameter creator
|
|
39002
37659
|
* @export
|
|
@@ -39017,14 +37674,6 @@ export declare const POSSessionApiAxiosParamCreator: (configuration?: Configurat
|
|
|
39017
37674
|
* @throws {RequiredError}
|
|
39018
37675
|
*/
|
|
39019
37676
|
getPosSessionV2: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39020
|
-
/**
|
|
39021
|
-
* Reference data for display. PINs are verified server-side (employee-tokens, action-approvals); the scoped token carries the operating mode and the permissions.
|
|
39022
|
-
* @summary The venue\'s employees, roles and passcodes, without PIN hashes
|
|
39023
|
-
* @param {number} businessId
|
|
39024
|
-
* @param {*} [options] Override http request option.
|
|
39025
|
-
* @throws {RequiredError}
|
|
39026
|
-
*/
|
|
39027
|
-
getPosSessionV6: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39028
37677
|
};
|
|
39029
37678
|
/**
|
|
39030
37679
|
* POSSessionApi - functional programming interface
|
|
@@ -39046,14 +37695,6 @@ export declare const POSSessionApiFp: (configuration?: Configuration) => {
|
|
|
39046
37695
|
* @throws {RequiredError}
|
|
39047
37696
|
*/
|
|
39048
37697
|
getPosSessionV2(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosSessionResponseDto>>;
|
|
39049
|
-
/**
|
|
39050
|
-
* Reference data for display. PINs are verified server-side (employee-tokens, action-approvals); the scoped token carries the operating mode and the permissions.
|
|
39051
|
-
* @summary The venue\'s employees, roles and passcodes, without PIN hashes
|
|
39052
|
-
* @param {number} businessId
|
|
39053
|
-
* @param {*} [options] Override http request option.
|
|
39054
|
-
* @throws {RequiredError}
|
|
39055
|
-
*/
|
|
39056
|
-
getPosSessionV6(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosSessionResponseDtoV6>>;
|
|
39057
37698
|
};
|
|
39058
37699
|
/**
|
|
39059
37700
|
* POSSessionApi - factory interface
|
|
@@ -39075,14 +37716,6 @@ export declare const POSSessionApiFactory: (configuration?: Configuration, baseP
|
|
|
39075
37716
|
* @throws {RequiredError}
|
|
39076
37717
|
*/
|
|
39077
37718
|
getPosSessionV2(businessId: number, options?: any): AxiosPromise<PosSessionResponseDto>;
|
|
39078
|
-
/**
|
|
39079
|
-
* Reference data for display. PINs are verified server-side (employee-tokens, action-approvals); the scoped token carries the operating mode and the permissions.
|
|
39080
|
-
* @summary The venue\'s employees, roles and passcodes, without PIN hashes
|
|
39081
|
-
* @param {number} businessId
|
|
39082
|
-
* @param {*} [options] Override http request option.
|
|
39083
|
-
* @throws {RequiredError}
|
|
39084
|
-
*/
|
|
39085
|
-
getPosSessionV6(businessId: number, options?: any): AxiosPromise<PosSessionResponseDtoV6>;
|
|
39086
37719
|
};
|
|
39087
37720
|
/**
|
|
39088
37721
|
* POSSessionApi - interface
|
|
@@ -39107,15 +37740,6 @@ export interface POSSessionApiInterface {
|
|
|
39107
37740
|
* @memberof POSSessionApiInterface
|
|
39108
37741
|
*/
|
|
39109
37742
|
getPosSessionV2(businessId: number, options?: AxiosRequestConfig): AxiosPromise<PosSessionResponseDto>;
|
|
39110
|
-
/**
|
|
39111
|
-
* Reference data for display. PINs are verified server-side (employee-tokens, action-approvals); the scoped token carries the operating mode and the permissions.
|
|
39112
|
-
* @summary The venue\'s employees, roles and passcodes, without PIN hashes
|
|
39113
|
-
* @param {number} businessId
|
|
39114
|
-
* @param {*} [options] Override http request option.
|
|
39115
|
-
* @throws {RequiredError}
|
|
39116
|
-
* @memberof POSSessionApiInterface
|
|
39117
|
-
*/
|
|
39118
|
-
getPosSessionV6(businessId: number, options?: AxiosRequestConfig): AxiosPromise<PosSessionResponseDtoV6>;
|
|
39119
37743
|
}
|
|
39120
37744
|
/**
|
|
39121
37745
|
* POSSessionApi - object-oriented interface
|
|
@@ -39141,15 +37765,6 @@ export declare class POSSessionApi extends BaseAPI implements POSSessionApiInter
|
|
|
39141
37765
|
* @memberof POSSessionApi
|
|
39142
37766
|
*/
|
|
39143
37767
|
getPosSessionV2(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosSessionResponseDto, any, {}>>;
|
|
39144
|
-
/**
|
|
39145
|
-
* Reference data for display. PINs are verified server-side (employee-tokens, action-approvals); the scoped token carries the operating mode and the permissions.
|
|
39146
|
-
* @summary The venue\'s employees, roles and passcodes, without PIN hashes
|
|
39147
|
-
* @param {number} businessId
|
|
39148
|
-
* @param {*} [options] Override http request option.
|
|
39149
|
-
* @throws {RequiredError}
|
|
39150
|
-
* @memberof POSSessionApi
|
|
39151
|
-
*/
|
|
39152
|
-
getPosSessionV6(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosSessionResponseDtoV6, any, {}>>;
|
|
39153
37768
|
}
|
|
39154
37769
|
/**
|
|
39155
37770
|
* PayTerminalApi - axios parameter creator
|
|
@@ -43335,17 +41950,6 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
43335
41950
|
* @throws {RequiredError}
|
|
43336
41951
|
*/
|
|
43337
41952
|
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) => Promise<RequestArgs>;
|
|
43338
|
-
/**
|
|
43339
|
-
* 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.
|
|
43340
|
-
* @summary End-of-day POS report of the token\'s venue
|
|
43341
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
43342
|
-
* @param {string} [start] Start date
|
|
43343
|
-
* @param {string} [end] End date
|
|
43344
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
43345
|
-
* @param {*} [options] Override http request option.
|
|
43346
|
-
* @throws {RequiredError}
|
|
43347
|
-
*/
|
|
43348
|
-
getEndOfDayReportV6: (timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43349
41953
|
/**
|
|
43350
41954
|
*
|
|
43351
41955
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -43385,18 +41989,6 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
43385
41989
|
* @throws {RequiredError}
|
|
43386
41990
|
*/
|
|
43387
41991
|
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) => Promise<RequestArgs>;
|
|
43388
|
-
/**
|
|
43389
|
-
* 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.
|
|
43390
|
-
* @summary Email the end-of-day report of the token\'s venue
|
|
43391
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
43392
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
43393
|
-
* @param {string} [start] Start date
|
|
43394
|
-
* @param {string} [end] End date
|
|
43395
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
43396
|
-
* @param {*} [options] Override http request option.
|
|
43397
|
-
* @throws {RequiredError}
|
|
43398
|
-
*/
|
|
43399
|
-
sendReportEmailV6: (sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43400
41992
|
};
|
|
43401
41993
|
/**
|
|
43402
41994
|
* ReportApi - functional programming interface
|
|
@@ -43416,17 +42008,6 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
43416
42008
|
* @throws {RequiredError}
|
|
43417
42009
|
*/
|
|
43418
42010
|
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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndOfDayReportDtoV4>>;
|
|
43419
|
-
/**
|
|
43420
|
-
* 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.
|
|
43421
|
-
* @summary End-of-day POS report of the token\'s venue
|
|
43422
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
43423
|
-
* @param {string} [start] Start date
|
|
43424
|
-
* @param {string} [end] End date
|
|
43425
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
43426
|
-
* @param {*} [options] Override http request option.
|
|
43427
|
-
* @throws {RequiredError}
|
|
43428
|
-
*/
|
|
43429
|
-
getEndOfDayReportV6(timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndOfDayReportResponseDtoV6>>;
|
|
43430
42011
|
/**
|
|
43431
42012
|
*
|
|
43432
42013
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -43466,18 +42047,6 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
43466
42047
|
* @throws {RequiredError}
|
|
43467
42048
|
*/
|
|
43468
42049
|
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): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
43469
|
-
/**
|
|
43470
|
-
* 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.
|
|
43471
|
-
* @summary Email the end-of-day report of the token\'s venue
|
|
43472
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
43473
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
43474
|
-
* @param {string} [start] Start date
|
|
43475
|
-
* @param {string} [end] End date
|
|
43476
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
43477
|
-
* @param {*} [options] Override http request option.
|
|
43478
|
-
* @throws {RequiredError}
|
|
43479
|
-
*/
|
|
43480
|
-
sendReportEmailV6(sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportEmailResponseDtoV6>>;
|
|
43481
42050
|
};
|
|
43482
42051
|
/**
|
|
43483
42052
|
* ReportApi - factory interface
|
|
@@ -43497,17 +42066,6 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
43497
42066
|
* @throws {RequiredError}
|
|
43498
42067
|
*/
|
|
43499
42068
|
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>;
|
|
43500
|
-
/**
|
|
43501
|
-
* 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.
|
|
43502
|
-
* @summary End-of-day POS report of the token\'s venue
|
|
43503
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
43504
|
-
* @param {string} [start] Start date
|
|
43505
|
-
* @param {string} [end] End date
|
|
43506
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
43507
|
-
* @param {*} [options] Override http request option.
|
|
43508
|
-
* @throws {RequiredError}
|
|
43509
|
-
*/
|
|
43510
|
-
getEndOfDayReportV6(timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: any): AxiosPromise<EndOfDayReportResponseDtoV6>;
|
|
43511
42069
|
/**
|
|
43512
42070
|
*
|
|
43513
42071
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -43547,18 +42105,6 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
43547
42105
|
* @throws {RequiredError}
|
|
43548
42106
|
*/
|
|
43549
42107
|
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>;
|
|
43550
|
-
/**
|
|
43551
|
-
* 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.
|
|
43552
|
-
* @summary Email the end-of-day report of the token\'s venue
|
|
43553
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
43554
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
43555
|
-
* @param {string} [start] Start date
|
|
43556
|
-
* @param {string} [end] End date
|
|
43557
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
43558
|
-
* @param {*} [options] Override http request option.
|
|
43559
|
-
* @throws {RequiredError}
|
|
43560
|
-
*/
|
|
43561
|
-
sendReportEmailV6(sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: any): AxiosPromise<ReportEmailResponseDtoV6>;
|
|
43562
42108
|
};
|
|
43563
42109
|
/**
|
|
43564
42110
|
* ReportApi - interface
|
|
@@ -43580,18 +42126,6 @@ export interface ReportApiInterface {
|
|
|
43580
42126
|
* @memberof ReportApiInterface
|
|
43581
42127
|
*/
|
|
43582
42128
|
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>;
|
|
43583
|
-
/**
|
|
43584
|
-
* 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.
|
|
43585
|
-
* @summary End-of-day POS report of the token\'s venue
|
|
43586
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
43587
|
-
* @param {string} [start] Start date
|
|
43588
|
-
* @param {string} [end] End date
|
|
43589
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
43590
|
-
* @param {*} [options] Override http request option.
|
|
43591
|
-
* @throws {RequiredError}
|
|
43592
|
-
* @memberof ReportApiInterface
|
|
43593
|
-
*/
|
|
43594
|
-
getEndOfDayReportV6(timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportResponseDtoV6>;
|
|
43595
42129
|
/**
|
|
43596
42130
|
*
|
|
43597
42131
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -43634,19 +42168,6 @@ export interface ReportApiInterface {
|
|
|
43634
42168
|
* @memberof ReportApiInterface
|
|
43635
42169
|
*/
|
|
43636
42170
|
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>;
|
|
43637
|
-
/**
|
|
43638
|
-
* 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.
|
|
43639
|
-
* @summary Email the end-of-day report of the token\'s venue
|
|
43640
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
43641
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
43642
|
-
* @param {string} [start] Start date
|
|
43643
|
-
* @param {string} [end] End date
|
|
43644
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
43645
|
-
* @param {*} [options] Override http request option.
|
|
43646
|
-
* @throws {RequiredError}
|
|
43647
|
-
* @memberof ReportApiInterface
|
|
43648
|
-
*/
|
|
43649
|
-
sendReportEmailV6(sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<ReportEmailResponseDtoV6>;
|
|
43650
42171
|
}
|
|
43651
42172
|
/**
|
|
43652
42173
|
* ReportApi - object-oriented interface
|
|
@@ -43669,18 +42190,6 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
43669
42190
|
* @memberof ReportApi
|
|
43670
42191
|
*/
|
|
43671
42192
|
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): Promise<import("axios").AxiosResponse<EndOfDayReportDtoV4, any, {}>>;
|
|
43672
|
-
/**
|
|
43673
|
-
* 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.
|
|
43674
|
-
* @summary End-of-day POS report of the token\'s venue
|
|
43675
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
43676
|
-
* @param {string} [start] Start date
|
|
43677
|
-
* @param {string} [end] End date
|
|
43678
|
-
* @param {string} [timezone] Default \"UTC\"
|
|
43679
|
-
* @param {*} [options] Override http request option.
|
|
43680
|
-
* @throws {RequiredError}
|
|
43681
|
-
* @memberof ReportApi
|
|
43682
|
-
*/
|
|
43683
|
-
getEndOfDayReportV6(timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EndOfDayReportResponseDtoV6, any, {}>>;
|
|
43684
42193
|
/**
|
|
43685
42194
|
*
|
|
43686
42195
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -43723,19 +42232,178 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
43723
42232
|
* @memberof ReportApi
|
|
43724
42233
|
*/
|
|
43725
42234
|
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): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
42235
|
+
}
|
|
42236
|
+
/**
|
|
42237
|
+
* ReportV6Api - axios parameter creator
|
|
42238
|
+
* @export
|
|
42239
|
+
*/
|
|
42240
|
+
export declare const ReportV6ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
42241
|
+
/**
|
|
42242
|
+
* The same answer as v5. In team mode, totals and sections the role of the person unlocked on the till may not see are returned as zero or an empty list, and without Report::ViewAll only that person\'s orders and refunds are counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
42243
|
+
* @summary End-of-day report, narrowed to the person working on the till
|
|
42244
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
42245
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
42246
|
+
* @param {string} [start] Start date
|
|
42247
|
+
* @param {string} [end] End date
|
|
42248
|
+
* @param {string} [timezone] Timezone of the period (default \"UTC\")
|
|
42249
|
+
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
42250
|
+
* @param {*} [options] Override http request option.
|
|
42251
|
+
* @throws {RequiredError}
|
|
42252
|
+
*/
|
|
42253
|
+
getEndOfDayReportForTill: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43726
42254
|
/**
|
|
43727
|
-
*
|
|
43728
|
-
* @summary
|
|
42255
|
+
* The same e-mail as v5, with the report narrowed as in v6 end-of-day. The cash-log e-mail goes out only when the person may see cash logs (Report::ViewCashLogs), with only their own entries without Report::ViewAll.
|
|
42256
|
+
* @summary E-mail the end-of-day report, narrowed to the person working on the till
|
|
42257
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
43729
42258
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
43730
42259
|
* @param {TimeSpan} [timeSpan] Time span
|
|
43731
42260
|
* @param {string} [start] Start date
|
|
43732
42261
|
* @param {string} [end] End date
|
|
43733
|
-
* @param {string} [timezone]
|
|
42262
|
+
* @param {string} [timezone] Timezone of the period (default \"UTC\")
|
|
42263
|
+
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
43734
42264
|
* @param {*} [options] Override http request option.
|
|
43735
42265
|
* @throws {RequiredError}
|
|
43736
|
-
* @memberof ReportApi
|
|
43737
42266
|
*/
|
|
43738
|
-
|
|
42267
|
+
sendEndOfDayReportForTill: (businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42268
|
+
};
|
|
42269
|
+
/**
|
|
42270
|
+
* ReportV6Api - functional programming interface
|
|
42271
|
+
* @export
|
|
42272
|
+
*/
|
|
42273
|
+
export declare const ReportV6ApiFp: (configuration?: Configuration) => {
|
|
42274
|
+
/**
|
|
42275
|
+
* The same answer as v5. In team mode, totals and sections the role of the person unlocked on the till may not see are returned as zero or an empty list, and without Report::ViewAll only that person\'s orders and refunds are counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
42276
|
+
* @summary End-of-day report, narrowed to the person working on the till
|
|
42277
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
42278
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
42279
|
+
* @param {string} [start] Start date
|
|
42280
|
+
* @param {string} [end] End date
|
|
42281
|
+
* @param {string} [timezone] Timezone of the period (default \"UTC\")
|
|
42282
|
+
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
42283
|
+
* @param {*} [options] Override http request option.
|
|
42284
|
+
* @throws {RequiredError}
|
|
42285
|
+
*/
|
|
42286
|
+
getEndOfDayReportForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndOfDayReportDtoV4>>;
|
|
42287
|
+
/**
|
|
42288
|
+
* The same e-mail as v5, with the report narrowed as in v6 end-of-day. The cash-log e-mail goes out only when the person may see cash logs (Report::ViewCashLogs), with only their own entries without Report::ViewAll.
|
|
42289
|
+
* @summary E-mail the end-of-day report, narrowed to the person working on the till
|
|
42290
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
42291
|
+
* @param {SendReportEmailDto} sendReportEmailDto
|
|
42292
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
42293
|
+
* @param {string} [start] Start date
|
|
42294
|
+
* @param {string} [end] End date
|
|
42295
|
+
* @param {string} [timezone] Timezone of the period (default \"UTC\")
|
|
42296
|
+
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
42297
|
+
* @param {*} [options] Override http request option.
|
|
42298
|
+
* @throws {RequiredError}
|
|
42299
|
+
*/
|
|
42300
|
+
sendEndOfDayReportForTill(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
42301
|
+
};
|
|
42302
|
+
/**
|
|
42303
|
+
* ReportV6Api - factory interface
|
|
42304
|
+
* @export
|
|
42305
|
+
*/
|
|
42306
|
+
export declare const ReportV6ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
42307
|
+
/**
|
|
42308
|
+
* The same answer as v5. In team mode, totals and sections the role of the person unlocked on the till may not see are returned as zero or an empty list, and without Report::ViewAll only that person\'s orders and refunds are counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
42309
|
+
* @summary End-of-day report, narrowed to the person working on the till
|
|
42310
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
42311
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
42312
|
+
* @param {string} [start] Start date
|
|
42313
|
+
* @param {string} [end] End date
|
|
42314
|
+
* @param {string} [timezone] Timezone of the period (default \"UTC\")
|
|
42315
|
+
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
42316
|
+
* @param {*} [options] Override http request option.
|
|
42317
|
+
* @throws {RequiredError}
|
|
42318
|
+
*/
|
|
42319
|
+
getEndOfDayReportForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: any): AxiosPromise<EndOfDayReportDtoV4>;
|
|
42320
|
+
/**
|
|
42321
|
+
* The same e-mail as v5, with the report narrowed as in v6 end-of-day. The cash-log e-mail goes out only when the person may see cash logs (Report::ViewCashLogs), with only their own entries without Report::ViewAll.
|
|
42322
|
+
* @summary E-mail the end-of-day report, narrowed to the person working on the till
|
|
42323
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
42324
|
+
* @param {SendReportEmailDto} sendReportEmailDto
|
|
42325
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
42326
|
+
* @param {string} [start] Start date
|
|
42327
|
+
* @param {string} [end] End date
|
|
42328
|
+
* @param {string} [timezone] Timezone of the period (default \"UTC\")
|
|
42329
|
+
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
42330
|
+
* @param {*} [options] Override http request option.
|
|
42331
|
+
* @throws {RequiredError}
|
|
42332
|
+
*/
|
|
42333
|
+
sendEndOfDayReportForTill(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: any): AxiosPromise<void>;
|
|
42334
|
+
};
|
|
42335
|
+
/**
|
|
42336
|
+
* ReportV6Api - interface
|
|
42337
|
+
* @export
|
|
42338
|
+
* @interface ReportV6Api
|
|
42339
|
+
*/
|
|
42340
|
+
export interface ReportV6ApiInterface {
|
|
42341
|
+
/**
|
|
42342
|
+
* The same answer as v5. In team mode, totals and sections the role of the person unlocked on the till may not see are returned as zero or an empty list, and without Report::ViewAll only that person\'s orders and refunds are counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
42343
|
+
* @summary End-of-day report, narrowed to the person working on the till
|
|
42344
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
42345
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
42346
|
+
* @param {string} [start] Start date
|
|
42347
|
+
* @param {string} [end] End date
|
|
42348
|
+
* @param {string} [timezone] Timezone of the period (default \"UTC\")
|
|
42349
|
+
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
42350
|
+
* @param {*} [options] Override http request option.
|
|
42351
|
+
* @throws {RequiredError}
|
|
42352
|
+
* @memberof ReportV6ApiInterface
|
|
42353
|
+
*/
|
|
42354
|
+
getEndOfDayReportForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportDtoV4>;
|
|
42355
|
+
/**
|
|
42356
|
+
* The same e-mail as v5, with the report narrowed as in v6 end-of-day. The cash-log e-mail goes out only when the person may see cash logs (Report::ViewCashLogs), with only their own entries without Report::ViewAll.
|
|
42357
|
+
* @summary E-mail the end-of-day report, narrowed to the person working on the till
|
|
42358
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
42359
|
+
* @param {SendReportEmailDto} sendReportEmailDto
|
|
42360
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
42361
|
+
* @param {string} [start] Start date
|
|
42362
|
+
* @param {string} [end] End date
|
|
42363
|
+
* @param {string} [timezone] Timezone of the period (default \"UTC\")
|
|
42364
|
+
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
42365
|
+
* @param {*} [options] Override http request option.
|
|
42366
|
+
* @throws {RequiredError}
|
|
42367
|
+
* @memberof ReportV6ApiInterface
|
|
42368
|
+
*/
|
|
42369
|
+
sendEndOfDayReportForTill(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
42370
|
+
}
|
|
42371
|
+
/**
|
|
42372
|
+
* ReportV6Api - object-oriented interface
|
|
42373
|
+
* @export
|
|
42374
|
+
* @class ReportV6Api
|
|
42375
|
+
* @extends {BaseAPI}
|
|
42376
|
+
*/
|
|
42377
|
+
export declare class ReportV6Api extends BaseAPI implements ReportV6ApiInterface {
|
|
42378
|
+
/**
|
|
42379
|
+
* The same answer as v5. In team mode, totals and sections the role of the person unlocked on the till may not see are returned as zero or an empty list, and without Report::ViewAll only that person\'s orders and refunds are counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
42380
|
+
* @summary End-of-day report, narrowed to the person working on the till
|
|
42381
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
42382
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
42383
|
+
* @param {string} [start] Start date
|
|
42384
|
+
* @param {string} [end] End date
|
|
42385
|
+
* @param {string} [timezone] Timezone of the period (default \"UTC\")
|
|
42386
|
+
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
42387
|
+
* @param {*} [options] Override http request option.
|
|
42388
|
+
* @throws {RequiredError}
|
|
42389
|
+
* @memberof ReportV6Api
|
|
42390
|
+
*/
|
|
42391
|
+
getEndOfDayReportForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EndOfDayReportDtoV4, any, {}>>;
|
|
42392
|
+
/**
|
|
42393
|
+
* The same e-mail as v5, with the report narrowed as in v6 end-of-day. The cash-log e-mail goes out only when the person may see cash logs (Report::ViewCashLogs), with only their own entries without Report::ViewAll.
|
|
42394
|
+
* @summary E-mail the end-of-day report, narrowed to the person working on the till
|
|
42395
|
+
* @param {Array<number>} businessIds Business ID selected
|
|
42396
|
+
* @param {SendReportEmailDto} sendReportEmailDto
|
|
42397
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
42398
|
+
* @param {string} [start] Start date
|
|
42399
|
+
* @param {string} [end] End date
|
|
42400
|
+
* @param {string} [timezone] Timezone of the period (default \"UTC\")
|
|
42401
|
+
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
42402
|
+
* @param {*} [options] Override http request option.
|
|
42403
|
+
* @throws {RequiredError}
|
|
42404
|
+
* @memberof ReportV6Api
|
|
42405
|
+
*/
|
|
42406
|
+
sendEndOfDayReportForTill(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
43739
42407
|
}
|
|
43740
42408
|
/**
|
|
43741
42409
|
* ReservationsApi - axios parameter creator
|
|
@@ -44269,6 +42937,14 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
44269
42937
|
* @throws {RequiredError}
|
|
44270
42938
|
*/
|
|
44271
42939
|
getTodayShift: (businessId: string, employeeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42940
|
+
/**
|
|
42941
|
+
*
|
|
42942
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
42943
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42944
|
+
* @param {*} [options] Override http request option.
|
|
42945
|
+
* @throws {RequiredError}
|
|
42946
|
+
*/
|
|
42947
|
+
lockTill: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44272
42948
|
/**
|
|
44273
42949
|
*
|
|
44274
42950
|
* @param {string} businessId
|
|
@@ -44277,6 +42953,15 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
44277
42953
|
* @throws {RequiredError}
|
|
44278
42954
|
*/
|
|
44279
42955
|
unlock: (businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42956
|
+
/**
|
|
42957
|
+
* 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.
|
|
42958
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
42959
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42960
|
+
* @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.
|
|
42961
|
+
* @param {*} [options] Override http request option.
|
|
42962
|
+
* @throws {RequiredError}
|
|
42963
|
+
*/
|
|
42964
|
+
unlockTillWithPin: (businessId: number, xPosPin: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44280
42965
|
};
|
|
44281
42966
|
/**
|
|
44282
42967
|
* ShiftTrackingApi - functional programming interface
|
|
@@ -44307,6 +42992,14 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
44307
42992
|
* @throws {RequiredError}
|
|
44308
42993
|
*/
|
|
44309
42994
|
getTodayShift(businessId: string, employeeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TodayShiftResponseDto>>;
|
|
42995
|
+
/**
|
|
42996
|
+
*
|
|
42997
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
42998
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
42999
|
+
* @param {*} [options] Override http request option.
|
|
43000
|
+
* @throws {RequiredError}
|
|
43001
|
+
*/
|
|
43002
|
+
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
44310
43003
|
/**
|
|
44311
43004
|
*
|
|
44312
43005
|
* @param {string} businessId
|
|
@@ -44315,6 +43008,15 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
44315
43008
|
* @throws {RequiredError}
|
|
44316
43009
|
*/
|
|
44317
43010
|
unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeSessionResponseDto>>;
|
|
43011
|
+
/**
|
|
43012
|
+
* 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.
|
|
43013
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
43014
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43015
|
+
* @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.
|
|
43016
|
+
* @param {*} [options] Override http request option.
|
|
43017
|
+
* @throws {RequiredError}
|
|
43018
|
+
*/
|
|
43019
|
+
unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeSessionResponseDto>>;
|
|
44318
43020
|
};
|
|
44319
43021
|
/**
|
|
44320
43022
|
* ShiftTrackingApi - factory interface
|
|
@@ -44345,6 +43047,14 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
44345
43047
|
* @throws {RequiredError}
|
|
44346
43048
|
*/
|
|
44347
43049
|
getTodayShift(businessId: string, employeeId: string, options?: any): AxiosPromise<TodayShiftResponseDto>;
|
|
43050
|
+
/**
|
|
43051
|
+
*
|
|
43052
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
43053
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43054
|
+
* @param {*} [options] Override http request option.
|
|
43055
|
+
* @throws {RequiredError}
|
|
43056
|
+
*/
|
|
43057
|
+
lockTill(businessId: number, options?: any): AxiosPromise<void>;
|
|
44348
43058
|
/**
|
|
44349
43059
|
*
|
|
44350
43060
|
* @param {string} businessId
|
|
@@ -44353,6 +43063,15 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
44353
43063
|
* @throws {RequiredError}
|
|
44354
43064
|
*/
|
|
44355
43065
|
unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: any): AxiosPromise<EmployeeSessionResponseDto>;
|
|
43066
|
+
/**
|
|
43067
|
+
* 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.
|
|
43068
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
43069
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43070
|
+
* @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.
|
|
43071
|
+
* @param {*} [options] Override http request option.
|
|
43072
|
+
* @throws {RequiredError}
|
|
43073
|
+
*/
|
|
43074
|
+
unlockTillWithPin(businessId: number, xPosPin: string, options?: any): AxiosPromise<EmployeeSessionResponseDto>;
|
|
44356
43075
|
};
|
|
44357
43076
|
/**
|
|
44358
43077
|
* ShiftTrackingApi - interface
|
|
@@ -44387,6 +43106,15 @@ export interface ShiftTrackingApiInterface {
|
|
|
44387
43106
|
* @memberof ShiftTrackingApiInterface
|
|
44388
43107
|
*/
|
|
44389
43108
|
getTodayShift(businessId: string, employeeId: string, options?: AxiosRequestConfig): AxiosPromise<TodayShiftResponseDto>;
|
|
43109
|
+
/**
|
|
43110
|
+
*
|
|
43111
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
43112
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43113
|
+
* @param {*} [options] Override http request option.
|
|
43114
|
+
* @throws {RequiredError}
|
|
43115
|
+
* @memberof ShiftTrackingApiInterface
|
|
43116
|
+
*/
|
|
43117
|
+
lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
44390
43118
|
/**
|
|
44391
43119
|
*
|
|
44392
43120
|
* @param {string} businessId
|
|
@@ -44396,6 +43124,16 @@ export interface ShiftTrackingApiInterface {
|
|
|
44396
43124
|
* @memberof ShiftTrackingApiInterface
|
|
44397
43125
|
*/
|
|
44398
43126
|
unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeSessionResponseDto>;
|
|
43127
|
+
/**
|
|
43128
|
+
* 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.
|
|
43129
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
43130
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43131
|
+
* @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.
|
|
43132
|
+
* @param {*} [options] Override http request option.
|
|
43133
|
+
* @throws {RequiredError}
|
|
43134
|
+
* @memberof ShiftTrackingApiInterface
|
|
43135
|
+
*/
|
|
43136
|
+
unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig): AxiosPromise<EmployeeSessionResponseDto>;
|
|
44399
43137
|
}
|
|
44400
43138
|
/**
|
|
44401
43139
|
* ShiftTrackingApi - object-oriented interface
|
|
@@ -44431,6 +43169,15 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
44431
43169
|
* @memberof ShiftTrackingApi
|
|
44432
43170
|
*/
|
|
44433
43171
|
getTodayShift(businessId: string, employeeId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TodayShiftResponseDto, any, {}>>;
|
|
43172
|
+
/**
|
|
43173
|
+
*
|
|
43174
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
43175
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43176
|
+
* @param {*} [options] Override http request option.
|
|
43177
|
+
* @throws {RequiredError}
|
|
43178
|
+
* @memberof ShiftTrackingApi
|
|
43179
|
+
*/
|
|
43180
|
+
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
44434
43181
|
/**
|
|
44435
43182
|
*
|
|
44436
43183
|
* @param {string} businessId
|
|
@@ -44440,6 +43187,16 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
44440
43187
|
* @memberof ShiftTrackingApi
|
|
44441
43188
|
*/
|
|
44442
43189
|
unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeSessionResponseDto, any, {}>>;
|
|
43190
|
+
/**
|
|
43191
|
+
* 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.
|
|
43192
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
43193
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43194
|
+
* @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.
|
|
43195
|
+
* @param {*} [options] Override http request option.
|
|
43196
|
+
* @throws {RequiredError}
|
|
43197
|
+
* @memberof ShiftTrackingApi
|
|
43198
|
+
*/
|
|
43199
|
+
unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeSessionResponseDto, any, {}>>;
|
|
44443
43200
|
}
|
|
44444
43201
|
/**
|
|
44445
43202
|
* StationsApi - axios parameter creator
|