@munchi_oy/core 1.9.131 → 1.9.132
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/api.d.ts +2241 -2
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +2876 -3
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -83,6 +83,7 @@ export declare const EntityTypeEnum: {
|
|
|
83
83
|
readonly Role: "role";
|
|
84
84
|
readonly Shift: "shift";
|
|
85
85
|
readonly Employee: "employee";
|
|
86
|
+
readonly ActionPasscode: "action_passcode";
|
|
86
87
|
readonly Config: "config";
|
|
87
88
|
readonly Business: "business";
|
|
88
89
|
readonly Suboption: "suboption";
|
|
@@ -120,6 +121,19 @@ export interface AcceptOrderDto {
|
|
|
120
121
|
*/
|
|
121
122
|
'preparedIn'?: number;
|
|
122
123
|
}
|
|
124
|
+
/**
|
|
125
|
+
*
|
|
126
|
+
* @export
|
|
127
|
+
* @interface ActionApprovalResponseDto
|
|
128
|
+
*/
|
|
129
|
+
export interface ActionApprovalResponseDto {
|
|
130
|
+
/**
|
|
131
|
+
* Send in the x-action-approval header of the protected request
|
|
132
|
+
* @type {string}
|
|
133
|
+
* @memberof ActionApprovalResponseDto
|
|
134
|
+
*/
|
|
135
|
+
'actionApproval': string;
|
|
136
|
+
}
|
|
123
137
|
/**
|
|
124
138
|
*
|
|
125
139
|
* @export
|
|
@@ -203,6 +217,16 @@ export interface ActivateKioskOfferDto {
|
|
|
203
217
|
*/
|
|
204
218
|
'catalogId': number;
|
|
205
219
|
}
|
|
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];
|
|
206
230
|
/**
|
|
207
231
|
*
|
|
208
232
|
* @export
|
|
@@ -443,6 +467,16 @@ export interface AmountDto {
|
|
|
443
467
|
*/
|
|
444
468
|
'currency': string;
|
|
445
469
|
}
|
|
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];
|
|
446
480
|
/**
|
|
447
481
|
*
|
|
448
482
|
* @export
|
|
@@ -2418,6 +2452,101 @@ export interface CatalogMethodDtoCapabilities {
|
|
|
2418
2452
|
*/
|
|
2419
2453
|
'checkoutOnly': boolean;
|
|
2420
2454
|
}
|
|
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];
|
|
2421
2550
|
/**
|
|
2422
2551
|
*
|
|
2423
2552
|
* @export
|
|
@@ -3599,7 +3728,7 @@ export interface CreateManualSessionDto {
|
|
|
3599
3728
|
*/
|
|
3600
3729
|
'order': CreateManualSessionDtoOrder;
|
|
3601
3730
|
/**
|
|
3602
|
-
*
|
|
3731
|
+
* Staff to name on the cash log (staffId, staffName). A cash payment is recorded in the business\'s open cash session whether or not this is sent; enabled and sessionId are no longer read.
|
|
3603
3732
|
* @type {object}
|
|
3604
3733
|
* @memberof CreateManualSessionDto
|
|
3605
3734
|
*/
|
|
@@ -5655,6 +5784,183 @@ export interface EndOfDayReportDtoV4TaxBreakdown {
|
|
|
5655
5784
|
*/
|
|
5656
5785
|
'totalTaxAmount': number;
|
|
5657
5786
|
}
|
|
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
|
+
}
|
|
5658
5964
|
/**
|
|
5659
5965
|
*
|
|
5660
5966
|
* @export
|
|
@@ -5669,6 +5975,7 @@ export declare const EntityType: {
|
|
|
5669
5975
|
readonly Role: "role";
|
|
5670
5976
|
readonly Shift: "shift";
|
|
5671
5977
|
readonly Employee: "employee";
|
|
5978
|
+
readonly ActionPasscode: "action_passcode";
|
|
5672
5979
|
readonly Config: "config";
|
|
5673
5980
|
readonly Business: "business";
|
|
5674
5981
|
readonly Suboption: "suboption";
|
|
@@ -7362,6 +7669,57 @@ export interface InvoiceCompanyResponseDto {
|
|
|
7362
7669
|
*/
|
|
7363
7670
|
'updatedAt': string;
|
|
7364
7671
|
}
|
|
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
|
+
}
|
|
7365
7723
|
/**
|
|
7366
7724
|
*
|
|
7367
7725
|
* @export
|
|
@@ -7516,6 +7874,98 @@ export interface ItemPriceDto {
|
|
|
7516
7874
|
*/
|
|
7517
7875
|
'priceBreakdown': ItemPriceBreakdownDto;
|
|
7518
7876
|
}
|
|
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
|
+
}
|
|
7519
7969
|
/**
|
|
7520
7970
|
*
|
|
7521
7971
|
* @export
|
|
@@ -10002,6 +10452,62 @@ export interface LoyaltyUserInfoResponseDto {
|
|
|
10002
10452
|
[key: string]: LoyaltyInfoResponseDtoLinksValue;
|
|
10003
10453
|
};
|
|
10004
10454
|
}
|
|
10455
|
+
/**
|
|
10456
|
+
*
|
|
10457
|
+
* @export
|
|
10458
|
+
* @interface LoyaltyWalletRewardDto
|
|
10459
|
+
*/
|
|
10460
|
+
export interface LoyaltyWalletRewardDto {
|
|
10461
|
+
/**
|
|
10462
|
+
*
|
|
10463
|
+
* @type {number}
|
|
10464
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10465
|
+
*/
|
|
10466
|
+
'wallet_id': number;
|
|
10467
|
+
/**
|
|
10468
|
+
*
|
|
10469
|
+
* @type {number}
|
|
10470
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10471
|
+
*/
|
|
10472
|
+
'catalog_id': number;
|
|
10473
|
+
/**
|
|
10474
|
+
*
|
|
10475
|
+
* @type {string}
|
|
10476
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10477
|
+
*/
|
|
10478
|
+
'name': string | null;
|
|
10479
|
+
/**
|
|
10480
|
+
* When the reward stops being usable. A claim made before claims expired has none.
|
|
10481
|
+
* @type {string}
|
|
10482
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10483
|
+
*/
|
|
10484
|
+
'expires_at': string | null;
|
|
10485
|
+
}
|
|
10486
|
+
/**
|
|
10487
|
+
*
|
|
10488
|
+
* @export
|
|
10489
|
+
* @interface LoyaltyWalletRewardsDto
|
|
10490
|
+
*/
|
|
10491
|
+
export interface LoyaltyWalletRewardsDto {
|
|
10492
|
+
/**
|
|
10493
|
+
*
|
|
10494
|
+
* @type {number}
|
|
10495
|
+
* @memberof LoyaltyWalletRewardsDto
|
|
10496
|
+
*/
|
|
10497
|
+
'user_id': number;
|
|
10498
|
+
/**
|
|
10499
|
+
* Rewards the member activated whose window is still open, soonest to expire first
|
|
10500
|
+
* @type {Array<LoyaltyWalletRewardDto>}
|
|
10501
|
+
* @memberof LoyaltyWalletRewardsDto
|
|
10502
|
+
*/
|
|
10503
|
+
'activated': Array<LoyaltyWalletRewardDto>;
|
|
10504
|
+
/**
|
|
10505
|
+
* Rewards the member claimed and has not activated, newest first
|
|
10506
|
+
* @type {Array<LoyaltyWalletRewardDto>}
|
|
10507
|
+
* @memberof LoyaltyWalletRewardsDto
|
|
10508
|
+
*/
|
|
10509
|
+
'claimed': Array<LoyaltyWalletRewardDto>;
|
|
10510
|
+
}
|
|
10005
10511
|
/**
|
|
10006
10512
|
*
|
|
10007
10513
|
* @export
|
|
@@ -15800,6 +16306,118 @@ export interface PermissionDto {
|
|
|
15800
16306
|
*/
|
|
15801
16307
|
'enabled': boolean;
|
|
15802
16308
|
}
|
|
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];
|
|
15803
16421
|
/**
|
|
15804
16422
|
*
|
|
15805
16423
|
* @export
|
|
@@ -15819,6 +16437,31 @@ export interface PermissionRuleDto {
|
|
|
15819
16437
|
*/
|
|
15820
16438
|
'enabled': boolean;
|
|
15821
16439
|
}
|
|
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
|
+
}
|
|
15822
16465
|
/**
|
|
15823
16466
|
*
|
|
15824
16467
|
* @export
|
|
@@ -15972,6 +16615,31 @@ export interface PosActionPasscodeDto {
|
|
|
15972
16615
|
*/
|
|
15973
16616
|
'pinHash': string;
|
|
15974
16617
|
}
|
|
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
|
+
}
|
|
15975
16643
|
/**
|
|
15976
16644
|
*
|
|
15977
16645
|
* @export
|
|
@@ -16257,6 +16925,37 @@ export interface PosEmployeeDto {
|
|
|
16257
16925
|
*/
|
|
16258
16926
|
'pinHash': string;
|
|
16259
16927
|
}
|
|
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
|
+
}
|
|
16260
16959
|
/**
|
|
16261
16960
|
*
|
|
16262
16961
|
* @export
|
|
@@ -17562,6 +18261,259 @@ export interface PosOrderDtoTaxSummary {
|
|
|
17562
18261
|
*/
|
|
17563
18262
|
'grandTotal': number;
|
|
17564
18263
|
}
|
|
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
|
+
}
|
|
17565
18517
|
/**
|
|
17566
18518
|
*
|
|
17567
18519
|
* @export
|
|
@@ -17649,6 +18601,68 @@ export interface PosOrderEqualSplitStateDto {
|
|
|
17649
18601
|
*/
|
|
17650
18602
|
'parts': Array<PosOrderEqualSplitPartDto>;
|
|
17651
18603
|
}
|
|
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
|
+
}
|
|
17652
18666
|
/**
|
|
17653
18667
|
*
|
|
17654
18668
|
* @export
|
|
@@ -17843,6 +18857,157 @@ export interface PosOrderItemDtoReportingCategory {
|
|
|
17843
18857
|
*/
|
|
17844
18858
|
'updated_at': string;
|
|
17845
18859
|
}
|
|
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
|
+
}
|
|
17846
19011
|
/**
|
|
17847
19012
|
*
|
|
17848
19013
|
* @export
|
|
@@ -18269,6 +19434,56 @@ export interface PosOrderPriceDto {
|
|
|
18269
19434
|
*/
|
|
18270
19435
|
'total': MoneyDto;
|
|
18271
19436
|
}
|
|
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
|
+
}
|
|
18272
19487
|
/**
|
|
18273
19488
|
*
|
|
18274
19489
|
* @export
|
|
@@ -18324,6 +19539,43 @@ export interface PosOrderSuboptionDto {
|
|
|
18324
19539
|
*/
|
|
18325
19540
|
'value_pos_id': string | null;
|
|
18326
19541
|
}
|
|
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
|
+
}
|
|
18327
19579
|
/**
|
|
18328
19580
|
*
|
|
18329
19581
|
* @export
|
|
@@ -18405,6 +19657,15 @@ export declare const PosPermission: {
|
|
|
18405
19657
|
readonly CashSendReport: "Cash::SendReport";
|
|
18406
19658
|
readonly Transaction: "Transaction::*";
|
|
18407
19659
|
readonly TransactionRefund: "Transaction::Refund";
|
|
19660
|
+
readonly TransactionViewAll: "Transaction::ViewAll";
|
|
19661
|
+
readonly TransactionViewTips: "Transaction::ViewTips";
|
|
19662
|
+
readonly TransactionViewSurcharges: "Transaction::ViewSurcharges";
|
|
19663
|
+
readonly TransactionViewDiscounts: "Transaction::ViewDiscounts";
|
|
19664
|
+
readonly TransactionTotals: "TransactionTotals::*";
|
|
19665
|
+
readonly TransactionTotalsOrders: "TransactionTotals::Orders";
|
|
19666
|
+
readonly TransactionTotalsSales: "TransactionTotals::Sales";
|
|
19667
|
+
readonly TransactionTotalsRejectedOrders: "TransactionTotals::RejectedOrders";
|
|
19668
|
+
readonly TransactionTotalsRejectedSales: "TransactionTotals::RejectedSales";
|
|
18408
19669
|
readonly Order: "Order::*";
|
|
18409
19670
|
readonly OrderSendReceipt: "Order::SendReceipt";
|
|
18410
19671
|
readonly OpenOrdersDelete: "OpenOrders::Delete";
|
|
@@ -18420,6 +19681,22 @@ export declare const PosPermission: {
|
|
|
18420
19681
|
readonly SettingsEditProfile: "Settings::EditProfile";
|
|
18421
19682
|
readonly Report: "Report::*";
|
|
18422
19683
|
readonly ReportSendEmail: "Report::SendEmail";
|
|
19684
|
+
readonly ReportViewAll: "Report::ViewAll";
|
|
19685
|
+
readonly ReportViewSalesSummary: "Report::ViewSalesSummary";
|
|
19686
|
+
readonly ReportViewPaymentMethods: "Report::ViewPaymentMethods";
|
|
19687
|
+
readonly ReportViewItemSales: "Report::ViewItemSales";
|
|
19688
|
+
readonly ReportViewCashLogs: "Report::ViewCashLogs";
|
|
19689
|
+
readonly ReportTotals: "ReportTotals::*";
|
|
19690
|
+
readonly ReportTotalsOrders: "ReportTotals::Orders";
|
|
19691
|
+
readonly ReportTotalsSales: "ReportTotals::Sales";
|
|
19692
|
+
readonly ReportTotalsTips: "ReportTotals::Tips";
|
|
19693
|
+
readonly ReportTotalsSurcharges: "ReportTotals::Surcharges";
|
|
19694
|
+
readonly ReportTotalsRejectedOrders: "ReportTotals::RejectedOrders";
|
|
19695
|
+
readonly ReportTotalsRejectedSales: "ReportTotals::RejectedSales";
|
|
19696
|
+
readonly ReportTotalsAverageSale: "ReportTotals::AverageSale";
|
|
19697
|
+
readonly ReportTotalsItems: "ReportTotals::Items";
|
|
19698
|
+
readonly ReportTotalsRefunds: "ReportTotals::Refunds";
|
|
19699
|
+
readonly ReportTotalsDiscounts: "ReportTotals::Discounts";
|
|
18423
19700
|
};
|
|
18424
19701
|
export type PosPermission = typeof PosPermission[keyof typeof PosPermission];
|
|
18425
19702
|
/**
|
|
@@ -18447,6 +19724,31 @@ export interface PosRoleDto {
|
|
|
18447
19724
|
*/
|
|
18448
19725
|
'permissionRules': Array<PermissionRuleResponseDto>;
|
|
18449
19726
|
}
|
|
19727
|
+
/**
|
|
19728
|
+
*
|
|
19729
|
+
* @export
|
|
19730
|
+
* @interface PosRoleDtoV6
|
|
19731
|
+
*/
|
|
19732
|
+
export interface PosRoleDtoV6 {
|
|
19733
|
+
/**
|
|
19734
|
+
*
|
|
19735
|
+
* @type {string}
|
|
19736
|
+
* @memberof PosRoleDtoV6
|
|
19737
|
+
*/
|
|
19738
|
+
'id': string;
|
|
19739
|
+
/**
|
|
19740
|
+
*
|
|
19741
|
+
* @type {string}
|
|
19742
|
+
* @memberof PosRoleDtoV6
|
|
19743
|
+
*/
|
|
19744
|
+
'name': string;
|
|
19745
|
+
/**
|
|
19746
|
+
*
|
|
19747
|
+
* @type {Array<PermissionRuleDtoV6>}
|
|
19748
|
+
* @memberof PosRoleDtoV6
|
|
19749
|
+
*/
|
|
19750
|
+
'permissionRules': Array<PermissionRuleDtoV6>;
|
|
19751
|
+
}
|
|
18450
19752
|
/**
|
|
18451
19753
|
*
|
|
18452
19754
|
* @export
|
|
@@ -18509,6 +19811,31 @@ export interface PosSessionResponseDto {
|
|
|
18509
19811
|
*/
|
|
18510
19812
|
'actionPasscodes': Array<PosActionPasscodeDto>;
|
|
18511
19813
|
}
|
|
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
|
+
}
|
|
18512
19839
|
/**
|
|
18513
19840
|
*
|
|
18514
19841
|
* @export
|
|
@@ -21031,6 +22358,44 @@ export interface RejectOrderDto {
|
|
|
21031
22358
|
*/
|
|
21032
22359
|
'reason': string;
|
|
21033
22360
|
}
|
|
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
|
+
}
|
|
21034
22399
|
/**
|
|
21035
22400
|
*
|
|
21036
22401
|
* @export
|
|
@@ -21666,6 +23031,109 @@ export interface SalesSummaryDtoV2 {
|
|
|
21666
23031
|
*/
|
|
21667
23032
|
'totalSurchargeAmount': number;
|
|
21668
23033
|
}
|
|
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
|
+
}
|
|
21669
23137
|
/**
|
|
21670
23138
|
*
|
|
21671
23139
|
* @export
|
|
@@ -21737,6 +23205,55 @@ export declare const ScheduleType: {
|
|
|
21737
23205
|
readonly Physical: "PHYSICAL";
|
|
21738
23206
|
};
|
|
21739
23207
|
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
|
+
}
|
|
21740
23257
|
/**
|
|
21741
23258
|
*
|
|
21742
23259
|
* @export
|
|
@@ -28506,7 +30023,7 @@ export interface VoidManualSessionDto {
|
|
|
28506
30023
|
*/
|
|
28507
30024
|
'orderId': string;
|
|
28508
30025
|
/**
|
|
28509
|
-
*
|
|
30026
|
+
* Staff to name on the REFUND cash log (staffId, staffName). Reverting a cash payment is recorded in the business\'s open cash session whether or not this is sent; enabled and sessionId are no longer read.
|
|
28510
30027
|
* @type {object}
|
|
28511
30028
|
* @memberof VoidManualSessionDto
|
|
28512
30029
|
*/
|
|
@@ -29067,6 +30584,244 @@ export declare class AblyApi extends BaseAPI implements AblyApiInterface {
|
|
|
29067
30584
|
*/
|
|
29068
30585
|
requestSettings(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
29069
30586
|
}
|
|
30587
|
+
/**
|
|
30588
|
+
* AccessControlApi - axios parameter creator
|
|
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
|
|
30775
|
+
* @export
|
|
30776
|
+
* @class AccessControlApi
|
|
30777
|
+
* @extends {BaseAPI}
|
|
30778
|
+
*/
|
|
30779
|
+
export declare class AccessControlApi extends BaseAPI implements AccessControlApiInterface {
|
|
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, {}>>;
|
|
30815
|
+
/**
|
|
30816
|
+
* 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.
|
|
30817
|
+
* @summary Renew a scoped token with its renewal ticket
|
|
30818
|
+
* @param {RenewScopedTokenDto} renewScopedTokenDto
|
|
30819
|
+
* @param {*} [options] Override http request option.
|
|
30820
|
+
* @throws {RequiredError}
|
|
30821
|
+
* @memberof AccessControlApi
|
|
30822
|
+
*/
|
|
30823
|
+
renewScopedTokenV1(renewScopedTokenDto: RenewScopedTokenDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ScopedTokenResponseDto, any, {}>>;
|
|
30824
|
+
}
|
|
29070
30825
|
/**
|
|
29071
30826
|
* ActionPasscodesApi - axios parameter creator
|
|
29072
30827
|
* @export
|
|
@@ -30759,6 +32514,20 @@ export declare const CashManagementApiAxiosParamCreator: (configuration?: Config
|
|
|
30759
32514
|
* @throws {RequiredError}
|
|
30760
32515
|
*/
|
|
30761
32516
|
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>;
|
|
30762
32531
|
/**
|
|
30763
32532
|
*
|
|
30764
32533
|
* @param {string} businessId
|
|
@@ -30819,6 +32588,20 @@ export declare const CashManagementApiFp: (configuration?: Configuration) => {
|
|
|
30819
32588
|
* @throws {RequiredError}
|
|
30820
32589
|
*/
|
|
30821
32590
|
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>>;
|
|
30822
32605
|
/**
|
|
30823
32606
|
*
|
|
30824
32607
|
* @param {string} businessId
|
|
@@ -30879,6 +32662,20 @@ export declare const CashManagementApiFactory: (configuration?: Configuration, b
|
|
|
30879
32662
|
* @throws {RequiredError}
|
|
30880
32663
|
*/
|
|
30881
32664
|
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>;
|
|
30882
32679
|
/**
|
|
30883
32680
|
*
|
|
30884
32681
|
* @param {string} businessId
|
|
@@ -30942,6 +32739,21 @@ export interface CashManagementApiInterface {
|
|
|
30942
32739
|
* @memberof CashManagementApiInterface
|
|
30943
32740
|
*/
|
|
30944
32741
|
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>;
|
|
30945
32757
|
/**
|
|
30946
32758
|
*
|
|
30947
32759
|
* @param {string} businessId
|
|
@@ -31010,6 +32822,21 @@ export declare class CashManagementApi extends BaseAPI implements CashManagement
|
|
|
31010
32822
|
* @memberof CashManagementApi
|
|
31011
32823
|
*/
|
|
31012
32824
|
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, {}>>;
|
|
31013
32840
|
/**
|
|
31014
32841
|
*
|
|
31015
32842
|
* @param {string} businessId
|
|
@@ -33232,6 +35059,26 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
33232
35059
|
* @throws {RequiredError}
|
|
33233
35060
|
*/
|
|
33234
35061
|
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
|
+
/**
|
|
35063
|
+
* Online orders carry no employee, so the list needs Transaction::ViewAll. Totals are always included.
|
|
35064
|
+
* @summary Online order history of the token\'s venue
|
|
35065
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35066
|
+
* @param {string} [start] Start date
|
|
35067
|
+
* @param {string} [end] End date
|
|
35068
|
+
* @param {number} [page] Page number
|
|
35069
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
35070
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
35071
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
35072
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
35073
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
35074
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
35075
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35076
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35077
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35078
|
+
* @param {*} [options] Override http request option.
|
|
35079
|
+
* @throws {RequiredError}
|
|
35080
|
+
*/
|
|
35081
|
+
getOnlineOrderHistoryV6: (timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33235
35082
|
/**
|
|
33236
35083
|
*
|
|
33237
35084
|
* @summary Get order history
|
|
@@ -33295,6 +35142,26 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
33295
35142
|
* @throws {RequiredError}
|
|
33296
35143
|
*/
|
|
33297
35144
|
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>;
|
|
35145
|
+
/**
|
|
35146
|
+
* An employee without Transaction::ViewAll receives only their own orders, filtered in the database; the summary is computed from those orders. Fields the token\'s visibility keys do not allow are omitted.
|
|
35147
|
+
* @summary POS order history of the token\'s venue
|
|
35148
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35149
|
+
* @param {string} [start] Start date
|
|
35150
|
+
* @param {string} [end] End date
|
|
35151
|
+
* @param {number} [page] Page number
|
|
35152
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
35153
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
35154
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
35155
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
35156
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
35157
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
35158
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35159
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35160
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35161
|
+
* @param {*} [options] Override http request option.
|
|
35162
|
+
* @throws {RequiredError}
|
|
35163
|
+
*/
|
|
35164
|
+
getPosOrderHistoryV6: (timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33298
35165
|
};
|
|
33299
35166
|
/**
|
|
33300
35167
|
* HistoryApi - functional programming interface
|
|
@@ -33322,6 +35189,26 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
33322
35189
|
* @throws {RequiredError}
|
|
33323
35190
|
*/
|
|
33324
35191
|
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>>;
|
|
35192
|
+
/**
|
|
35193
|
+
* Online orders carry no employee, so the list needs Transaction::ViewAll. Totals are always included.
|
|
35194
|
+
* @summary Online order history of the token\'s venue
|
|
35195
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35196
|
+
* @param {string} [start] Start date
|
|
35197
|
+
* @param {string} [end] End date
|
|
35198
|
+
* @param {number} [page] Page number
|
|
35199
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
35200
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
35201
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
35202
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
35203
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
35204
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
35205
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35206
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35207
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35208
|
+
* @param {*} [options] Override http request option.
|
|
35209
|
+
* @throws {RequiredError}
|
|
35210
|
+
*/
|
|
35211
|
+
getOnlineOrderHistoryV6(timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderHistoryResponseDto>>;
|
|
33325
35212
|
/**
|
|
33326
35213
|
*
|
|
33327
35214
|
* @summary Get order history
|
|
@@ -33385,6 +35272,26 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
33385
35272
|
* @throws {RequiredError}
|
|
33386
35273
|
*/
|
|
33387
35274
|
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>>;
|
|
35275
|
+
/**
|
|
35276
|
+
* An employee without Transaction::ViewAll receives only their own orders, filtered in the database; the summary is computed from those orders. Fields the token\'s visibility keys do not allow are omitted.
|
|
35277
|
+
* @summary POS order history of the token\'s venue
|
|
35278
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35279
|
+
* @param {string} [start] Start date
|
|
35280
|
+
* @param {string} [end] End date
|
|
35281
|
+
* @param {number} [page] Page number
|
|
35282
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
35283
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
35284
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
35285
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
35286
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
35287
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
35288
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35289
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35290
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35291
|
+
* @param {*} [options] Override http request option.
|
|
35292
|
+
* @throws {RequiredError}
|
|
35293
|
+
*/
|
|
35294
|
+
getPosOrderHistoryV6(timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosOrderHistoryResponseDtoV6>>;
|
|
33388
35295
|
};
|
|
33389
35296
|
/**
|
|
33390
35297
|
* HistoryApi - factory interface
|
|
@@ -33412,6 +35319,26 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
33412
35319
|
* @throws {RequiredError}
|
|
33413
35320
|
*/
|
|
33414
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?: any): AxiosPromise<OrderHistoryResponseDto>;
|
|
35322
|
+
/**
|
|
35323
|
+
* Online orders carry no employee, so the list needs Transaction::ViewAll. Totals are always included.
|
|
35324
|
+
* @summary Online order history of the token\'s venue
|
|
35325
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35326
|
+
* @param {string} [start] Start date
|
|
35327
|
+
* @param {string} [end] End date
|
|
35328
|
+
* @param {number} [page] Page number
|
|
35329
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
35330
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
35331
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
35332
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
35333
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
35334
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
35335
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35336
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35337
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35338
|
+
* @param {*} [options] Override http request option.
|
|
35339
|
+
* @throws {RequiredError}
|
|
35340
|
+
*/
|
|
35341
|
+
getOnlineOrderHistoryV6(timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: any): AxiosPromise<OrderHistoryResponseDto>;
|
|
33415
35342
|
/**
|
|
33416
35343
|
*
|
|
33417
35344
|
* @summary Get order history
|
|
@@ -33475,6 +35402,26 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
33475
35402
|
* @throws {RequiredError}
|
|
33476
35403
|
*/
|
|
33477
35404
|
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>;
|
|
35405
|
+
/**
|
|
35406
|
+
* An employee without Transaction::ViewAll receives only their own orders, filtered in the database; the summary is computed from those orders. Fields the token\'s visibility keys do not allow are omitted.
|
|
35407
|
+
* @summary POS order history of the token\'s venue
|
|
35408
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35409
|
+
* @param {string} [start] Start date
|
|
35410
|
+
* @param {string} [end] End date
|
|
35411
|
+
* @param {number} [page] Page number
|
|
35412
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
35413
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
35414
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
35415
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
35416
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
35417
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
35418
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35419
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35420
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35421
|
+
* @param {*} [options] Override http request option.
|
|
35422
|
+
* @throws {RequiredError}
|
|
35423
|
+
*/
|
|
35424
|
+
getPosOrderHistoryV6(timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: any): AxiosPromise<PosOrderHistoryResponseDtoV6>;
|
|
33478
35425
|
};
|
|
33479
35426
|
/**
|
|
33480
35427
|
* HistoryApi - interface
|
|
@@ -33504,6 +35451,27 @@ export interface HistoryApiInterface {
|
|
|
33504
35451
|
* @memberof HistoryApiInterface
|
|
33505
35452
|
*/
|
|
33506
35453
|
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>;
|
|
35454
|
+
/**
|
|
35455
|
+
* Online orders carry no employee, so the list needs Transaction::ViewAll. Totals are always included.
|
|
35456
|
+
* @summary Online order history of the token\'s venue
|
|
35457
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35458
|
+
* @param {string} [start] Start date
|
|
35459
|
+
* @param {string} [end] End date
|
|
35460
|
+
* @param {number} [page] Page number
|
|
35461
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
35462
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
35463
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
35464
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
35465
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
35466
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
35467
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35468
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35469
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35470
|
+
* @param {*} [options] Override http request option.
|
|
35471
|
+
* @throws {RequiredError}
|
|
35472
|
+
* @memberof HistoryApiInterface
|
|
35473
|
+
*/
|
|
35474
|
+
getOnlineOrderHistoryV6(timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<OrderHistoryResponseDto>;
|
|
33507
35475
|
/**
|
|
33508
35476
|
*
|
|
33509
35477
|
* @summary Get order history
|
|
@@ -33570,6 +35538,27 @@ export interface HistoryApiInterface {
|
|
|
33570
35538
|
* @memberof HistoryApiInterface
|
|
33571
35539
|
*/
|
|
33572
35540
|
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>;
|
|
35541
|
+
/**
|
|
35542
|
+
* An employee without Transaction::ViewAll receives only their own orders, filtered in the database; the summary is computed from those orders. Fields the token\'s visibility keys do not allow are omitted.
|
|
35543
|
+
* @summary POS order history of the token\'s venue
|
|
35544
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35545
|
+
* @param {string} [start] Start date
|
|
35546
|
+
* @param {string} [end] End date
|
|
35547
|
+
* @param {number} [page] Page number
|
|
35548
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
35549
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
35550
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
35551
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
35552
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
35553
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
35554
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35555
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35556
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35557
|
+
* @param {*} [options] Override http request option.
|
|
35558
|
+
* @throws {RequiredError}
|
|
35559
|
+
* @memberof HistoryApiInterface
|
|
35560
|
+
*/
|
|
35561
|
+
getPosOrderHistoryV6(timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<PosOrderHistoryResponseDtoV6>;
|
|
33573
35562
|
}
|
|
33574
35563
|
/**
|
|
33575
35564
|
* HistoryApi - object-oriented interface
|
|
@@ -33600,6 +35589,27 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
33600
35589
|
* @memberof HistoryApi
|
|
33601
35590
|
*/
|
|
33602
35591
|
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, {}>>;
|
|
35592
|
+
/**
|
|
35593
|
+
* Online orders carry no employee, so the list needs Transaction::ViewAll. Totals are always included.
|
|
35594
|
+
* @summary Online order history of the token\'s venue
|
|
35595
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35596
|
+
* @param {string} [start] Start date
|
|
35597
|
+
* @param {string} [end] End date
|
|
35598
|
+
* @param {number} [page] Page number
|
|
35599
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
35600
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
35601
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
35602
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
35603
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
35604
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
35605
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35606
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35607
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35608
|
+
* @param {*} [options] Override http request option.
|
|
35609
|
+
* @throws {RequiredError}
|
|
35610
|
+
* @memberof HistoryApi
|
|
35611
|
+
*/
|
|
35612
|
+
getOnlineOrderHistoryV6(timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderHistoryResponseDto, any, {}>>;
|
|
33603
35613
|
/**
|
|
33604
35614
|
*
|
|
33605
35615
|
* @summary Get order history
|
|
@@ -33666,6 +35676,27 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
33666
35676
|
* @memberof HistoryApi
|
|
33667
35677
|
*/
|
|
33668
35678
|
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, {}>>;
|
|
35679
|
+
/**
|
|
35680
|
+
* An employee without Transaction::ViewAll receives only their own orders, filtered in the database; the summary is computed from those orders. Fields the token\'s visibility keys do not allow are omitted.
|
|
35681
|
+
* @summary POS order history of the token\'s venue
|
|
35682
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
35683
|
+
* @param {string} [start] Start date
|
|
35684
|
+
* @param {string} [end] End date
|
|
35685
|
+
* @param {number} [page] Page number
|
|
35686
|
+
* @param {number} [rowPerPage] Number of rows per page
|
|
35687
|
+
* @param {Array<ProviderEnum>} [provider] Provider
|
|
35688
|
+
* @param {Array<PaymentTypeEnum>} [paymentType] Payment type
|
|
35689
|
+
* @param {Array<OrderStatusEnum>} [orderStatus] Order status
|
|
35690
|
+
* @param {Array<PaymentStatus>} [paymentStatus] Payment status
|
|
35691
|
+
* @param {Array<OrderType>} [orderType] Order type
|
|
35692
|
+
* @param {Array<PaymentMethod>} [paymentTypePos] Payment type POS
|
|
35693
|
+
* @param {string} [invoiceCompanyId] Filter by invoice company ID
|
|
35694
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
35695
|
+
* @param {*} [options] Override http request option.
|
|
35696
|
+
* @throws {RequiredError}
|
|
35697
|
+
* @memberof HistoryApi
|
|
35698
|
+
*/
|
|
35699
|
+
getPosOrderHistoryV6(timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosOrderHistoryResponseDtoV6, any, {}>>;
|
|
33669
35700
|
}
|
|
33670
35701
|
/**
|
|
33671
35702
|
* InvoiceCompaniesApi - axios parameter creator
|
|
@@ -34631,6 +36662,15 @@ export declare const LoyaltyIntegerationsApiAxiosParamCreator: (configuration?:
|
|
|
34631
36662
|
* @throws {RequiredError}
|
|
34632
36663
|
*/
|
|
34633
36664
|
getUserWallet: (businessId: number, userId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36665
|
+
/**
|
|
36666
|
+
*
|
|
36667
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
36668
|
+
* @param {number} businessId
|
|
36669
|
+
* @param {number} userId
|
|
36670
|
+
* @param {*} [options] Override http request option.
|
|
36671
|
+
* @throws {RequiredError}
|
|
36672
|
+
*/
|
|
36673
|
+
getWalletRewards: (businessId: number, userId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34634
36674
|
/**
|
|
34635
36675
|
*
|
|
34636
36676
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -34753,6 +36793,15 @@ export declare const LoyaltyIntegerationsApiFp: (configuration?: Configuration)
|
|
|
34753
36793
|
* @throws {RequiredError}
|
|
34754
36794
|
*/
|
|
34755
36795
|
getUserWallet(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWalletResponseDto>>;
|
|
36796
|
+
/**
|
|
36797
|
+
*
|
|
36798
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
36799
|
+
* @param {number} businessId
|
|
36800
|
+
* @param {number} userId
|
|
36801
|
+
* @param {*} [options] Override http request option.
|
|
36802
|
+
* @throws {RequiredError}
|
|
36803
|
+
*/
|
|
36804
|
+
getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoyaltyWalletRewardsDto>>;
|
|
34756
36805
|
/**
|
|
34757
36806
|
*
|
|
34758
36807
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -34875,6 +36924,15 @@ export declare const LoyaltyIntegerationsApiFactory: (configuration?: Configurat
|
|
|
34875
36924
|
* @throws {RequiredError}
|
|
34876
36925
|
*/
|
|
34877
36926
|
getUserWallet(businessId: number, userId: number, options?: any): AxiosPromise<UserWalletResponseDto>;
|
|
36927
|
+
/**
|
|
36928
|
+
*
|
|
36929
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
36930
|
+
* @param {number} businessId
|
|
36931
|
+
* @param {number} userId
|
|
36932
|
+
* @param {*} [options] Override http request option.
|
|
36933
|
+
* @throws {RequiredError}
|
|
36934
|
+
*/
|
|
36935
|
+
getWalletRewards(businessId: number, userId: number, options?: any): AxiosPromise<LoyaltyWalletRewardsDto>;
|
|
34878
36936
|
/**
|
|
34879
36937
|
*
|
|
34880
36938
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -35006,6 +37064,16 @@ export interface LoyaltyIntegerationsApiInterface {
|
|
|
35006
37064
|
* @memberof LoyaltyIntegerationsApiInterface
|
|
35007
37065
|
*/
|
|
35008
37066
|
getUserWallet(businessId: number, userId: number, options?: AxiosRequestConfig): AxiosPromise<UserWalletResponseDto>;
|
|
37067
|
+
/**
|
|
37068
|
+
*
|
|
37069
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
37070
|
+
* @param {number} businessId
|
|
37071
|
+
* @param {number} userId
|
|
37072
|
+
* @param {*} [options] Override http request option.
|
|
37073
|
+
* @throws {RequiredError}
|
|
37074
|
+
* @memberof LoyaltyIntegerationsApiInterface
|
|
37075
|
+
*/
|
|
37076
|
+
getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig): AxiosPromise<LoyaltyWalletRewardsDto>;
|
|
35009
37077
|
/**
|
|
35010
37078
|
*
|
|
35011
37079
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -35143,6 +37211,16 @@ export declare class LoyaltyIntegerationsApi extends BaseAPI implements LoyaltyI
|
|
|
35143
37211
|
* @memberof LoyaltyIntegerationsApi
|
|
35144
37212
|
*/
|
|
35145
37213
|
getUserWallet(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserWalletResponseDto, any, {}>>;
|
|
37214
|
+
/**
|
|
37215
|
+
*
|
|
37216
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
37217
|
+
* @param {number} businessId
|
|
37218
|
+
* @param {number} userId
|
|
37219
|
+
* @param {*} [options] Override http request option.
|
|
37220
|
+
* @throws {RequiredError}
|
|
37221
|
+
* @memberof LoyaltyIntegerationsApi
|
|
37222
|
+
*/
|
|
37223
|
+
getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LoyaltyWalletRewardsDto, any, {}>>;
|
|
35146
37224
|
/**
|
|
35147
37225
|
*
|
|
35148
37226
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -36939,6 +39017,14 @@ export declare const POSSessionApiAxiosParamCreator: (configuration?: Configurat
|
|
|
36939
39017
|
* @throws {RequiredError}
|
|
36940
39018
|
*/
|
|
36941
39019
|
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>;
|
|
36942
39028
|
};
|
|
36943
39029
|
/**
|
|
36944
39030
|
* POSSessionApi - functional programming interface
|
|
@@ -36960,6 +39046,14 @@ export declare const POSSessionApiFp: (configuration?: Configuration) => {
|
|
|
36960
39046
|
* @throws {RequiredError}
|
|
36961
39047
|
*/
|
|
36962
39048
|
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>>;
|
|
36963
39057
|
};
|
|
36964
39058
|
/**
|
|
36965
39059
|
* POSSessionApi - factory interface
|
|
@@ -36981,6 +39075,14 @@ export declare const POSSessionApiFactory: (configuration?: Configuration, baseP
|
|
|
36981
39075
|
* @throws {RequiredError}
|
|
36982
39076
|
*/
|
|
36983
39077
|
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>;
|
|
36984
39086
|
};
|
|
36985
39087
|
/**
|
|
36986
39088
|
* POSSessionApi - interface
|
|
@@ -37005,6 +39107,15 @@ export interface POSSessionApiInterface {
|
|
|
37005
39107
|
* @memberof POSSessionApiInterface
|
|
37006
39108
|
*/
|
|
37007
39109
|
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>;
|
|
37008
39119
|
}
|
|
37009
39120
|
/**
|
|
37010
39121
|
* POSSessionApi - object-oriented interface
|
|
@@ -37030,6 +39141,15 @@ export declare class POSSessionApi extends BaseAPI implements POSSessionApiInter
|
|
|
37030
39141
|
* @memberof POSSessionApi
|
|
37031
39142
|
*/
|
|
37032
39143
|
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, {}>>;
|
|
37033
39153
|
}
|
|
37034
39154
|
/**
|
|
37035
39155
|
* PayTerminalApi - axios parameter creator
|
|
@@ -41215,6 +43335,17 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
41215
43335
|
* @throws {RequiredError}
|
|
41216
43336
|
*/
|
|
41217
43337
|
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>;
|
|
41218
43349
|
/**
|
|
41219
43350
|
*
|
|
41220
43351
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -41254,6 +43385,18 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
41254
43385
|
* @throws {RequiredError}
|
|
41255
43386
|
*/
|
|
41256
43387
|
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>;
|
|
41257
43400
|
};
|
|
41258
43401
|
/**
|
|
41259
43402
|
* ReportApi - functional programming interface
|
|
@@ -41273,6 +43416,17 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
41273
43416
|
* @throws {RequiredError}
|
|
41274
43417
|
*/
|
|
41275
43418
|
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>>;
|
|
41276
43430
|
/**
|
|
41277
43431
|
*
|
|
41278
43432
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -41312,6 +43466,18 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
41312
43466
|
* @throws {RequiredError}
|
|
41313
43467
|
*/
|
|
41314
43468
|
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>>;
|
|
41315
43481
|
};
|
|
41316
43482
|
/**
|
|
41317
43483
|
* ReportApi - factory interface
|
|
@@ -41331,6 +43497,17 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
41331
43497
|
* @throws {RequiredError}
|
|
41332
43498
|
*/
|
|
41333
43499
|
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>;
|
|
41334
43511
|
/**
|
|
41335
43512
|
*
|
|
41336
43513
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -41370,6 +43547,18 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
41370
43547
|
* @throws {RequiredError}
|
|
41371
43548
|
*/
|
|
41372
43549
|
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>;
|
|
41373
43562
|
};
|
|
41374
43563
|
/**
|
|
41375
43564
|
* ReportApi - interface
|
|
@@ -41391,6 +43580,18 @@ export interface ReportApiInterface {
|
|
|
41391
43580
|
* @memberof ReportApiInterface
|
|
41392
43581
|
*/
|
|
41393
43582
|
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>;
|
|
41394
43595
|
/**
|
|
41395
43596
|
*
|
|
41396
43597
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -41433,6 +43634,19 @@ export interface ReportApiInterface {
|
|
|
41433
43634
|
* @memberof ReportApiInterface
|
|
41434
43635
|
*/
|
|
41435
43636
|
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>;
|
|
41436
43650
|
}
|
|
41437
43651
|
/**
|
|
41438
43652
|
* ReportApi - object-oriented interface
|
|
@@ -41455,6 +43669,18 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
41455
43669
|
* @memberof ReportApi
|
|
41456
43670
|
*/
|
|
41457
43671
|
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, {}>>;
|
|
41458
43684
|
/**
|
|
41459
43685
|
*
|
|
41460
43686
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -41497,6 +43723,19 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
41497
43723
|
* @memberof ReportApi
|
|
41498
43724
|
*/
|
|
41499
43725
|
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, {}>>;
|
|
43726
|
+
/**
|
|
43727
|
+
* 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.
|
|
43728
|
+
* @summary Email the end-of-day report of the token\'s venue
|
|
43729
|
+
* @param {SendReportEmailDto} sendReportEmailDto
|
|
43730
|
+
* @param {TimeSpan} [timeSpan] Time span
|
|
43731
|
+
* @param {string} [start] Start date
|
|
43732
|
+
* @param {string} [end] End date
|
|
43733
|
+
* @param {string} [timezone] Default \"UTC\"
|
|
43734
|
+
* @param {*} [options] Override http request option.
|
|
43735
|
+
* @throws {RequiredError}
|
|
43736
|
+
* @memberof ReportApi
|
|
43737
|
+
*/
|
|
43738
|
+
sendReportEmailV6(sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportEmailResponseDtoV6, any, {}>>;
|
|
41500
43739
|
}
|
|
41501
43740
|
/**
|
|
41502
43741
|
* ReservationsApi - axios parameter creator
|