@munchi_oy/core 1.3.4 → 1.3.5
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 +1378 -1487
- 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 +1473 -2065
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -74,6 +74,8 @@ export declare const EntityTypeEnum: {
|
|
|
74
74
|
readonly Employee: "employee";
|
|
75
75
|
readonly Config: "config";
|
|
76
76
|
readonly Business: "business";
|
|
77
|
+
readonly Suboption: "suboption";
|
|
78
|
+
readonly Site: "site";
|
|
77
79
|
};
|
|
78
80
|
export type EntityTypeEnum = typeof EntityTypeEnum[keyof typeof EntityTypeEnum];
|
|
79
81
|
/**
|
|
@@ -2667,31 +2669,6 @@ export interface CreateEmployeeAssignmentDto {
|
|
|
2667
2669
|
*/
|
|
2668
2670
|
'roleId': string;
|
|
2669
2671
|
}
|
|
2670
|
-
/**
|
|
2671
|
-
*
|
|
2672
|
-
* @export
|
|
2673
|
-
* @interface CreateEmployeeDto
|
|
2674
|
-
*/
|
|
2675
|
-
export interface CreateEmployeeDto {
|
|
2676
|
-
/**
|
|
2677
|
-
* The employee\'s full name
|
|
2678
|
-
* @type {string}
|
|
2679
|
-
* @memberof CreateEmployeeDto
|
|
2680
|
-
*/
|
|
2681
|
-
'name': string;
|
|
2682
|
-
/**
|
|
2683
|
-
* The ID of the merchant this employee belongs to
|
|
2684
|
-
* @type {string}
|
|
2685
|
-
* @memberof CreateEmployeeDto
|
|
2686
|
-
*/
|
|
2687
|
-
'merchantId': string;
|
|
2688
|
-
/**
|
|
2689
|
-
* The 4-digit plain-text PIN for the employee
|
|
2690
|
-
* @type {string}
|
|
2691
|
-
* @memberof CreateEmployeeDto
|
|
2692
|
-
*/
|
|
2693
|
-
'pin': string;
|
|
2694
|
-
}
|
|
2695
2672
|
/**
|
|
2696
2673
|
*
|
|
2697
2674
|
* @export
|
|
@@ -3413,10 +3390,10 @@ export interface DeliveryDto {
|
|
|
3413
3390
|
'selfDelivery': boolean | null;
|
|
3414
3391
|
/**
|
|
3415
3392
|
* Delivery note
|
|
3416
|
-
* @type {
|
|
3393
|
+
* @type {object}
|
|
3417
3394
|
* @memberof DeliveryDto
|
|
3418
3395
|
*/
|
|
3419
|
-
'note':
|
|
3396
|
+
'note': object | null;
|
|
3420
3397
|
/**
|
|
3421
3398
|
*
|
|
3422
3399
|
* @type {DeliveryStatus}
|
|
@@ -3697,43 +3674,6 @@ export interface EmployeeAssignmentResponseDto {
|
|
|
3697
3674
|
*/
|
|
3698
3675
|
'roleId': string;
|
|
3699
3676
|
}
|
|
3700
|
-
/**
|
|
3701
|
-
*
|
|
3702
|
-
* @export
|
|
3703
|
-
* @interface EmployeeResponseDto
|
|
3704
|
-
*/
|
|
3705
|
-
export interface EmployeeResponseDto {
|
|
3706
|
-
/**
|
|
3707
|
-
*
|
|
3708
|
-
* @type {string}
|
|
3709
|
-
* @memberof EmployeeResponseDto
|
|
3710
|
-
*/
|
|
3711
|
-
'id': string;
|
|
3712
|
-
/**
|
|
3713
|
-
*
|
|
3714
|
-
* @type {string}
|
|
3715
|
-
* @memberof EmployeeResponseDto
|
|
3716
|
-
*/
|
|
3717
|
-
'name': string;
|
|
3718
|
-
/**
|
|
3719
|
-
*
|
|
3720
|
-
* @type {string}
|
|
3721
|
-
* @memberof EmployeeResponseDto
|
|
3722
|
-
*/
|
|
3723
|
-
'merchantId': string;
|
|
3724
|
-
/**
|
|
3725
|
-
*
|
|
3726
|
-
* @type {Status}
|
|
3727
|
-
* @memberof EmployeeResponseDto
|
|
3728
|
-
*/
|
|
3729
|
-
'status': Status;
|
|
3730
|
-
/**
|
|
3731
|
-
* The employee\'s plain-text, decrypted PIN
|
|
3732
|
-
* @type {string}
|
|
3733
|
-
* @memberof EmployeeResponseDto
|
|
3734
|
-
*/
|
|
3735
|
-
'pin': string;
|
|
3736
|
-
}
|
|
3737
3677
|
/**
|
|
3738
3678
|
*
|
|
3739
3679
|
* @export
|
|
@@ -3913,257 +3853,6 @@ export interface EmployeeShiftResponseDtoEmployee {
|
|
|
3913
3853
|
*/
|
|
3914
3854
|
'photoUrl': string | null;
|
|
3915
3855
|
}
|
|
3916
|
-
/**
|
|
3917
|
-
*
|
|
3918
|
-
* @export
|
|
3919
|
-
* @interface EndOfDayReportDto
|
|
3920
|
-
*/
|
|
3921
|
-
export interface EndOfDayReportDto {
|
|
3922
|
-
/**
|
|
3923
|
-
* Report generated at
|
|
3924
|
-
* @type {string}
|
|
3925
|
-
* @memberof EndOfDayReportDto
|
|
3926
|
-
*/
|
|
3927
|
-
'reportGeneratedAt': string;
|
|
3928
|
-
/**
|
|
3929
|
-
* Report date start
|
|
3930
|
-
* @type {string}
|
|
3931
|
-
* @memberof EndOfDayReportDto
|
|
3932
|
-
*/
|
|
3933
|
-
'reportDateStart': string;
|
|
3934
|
-
/**
|
|
3935
|
-
* Report date end
|
|
3936
|
-
* @type {string}
|
|
3937
|
-
* @memberof EndOfDayReportDto
|
|
3938
|
-
*/
|
|
3939
|
-
'reportDateEnd': string;
|
|
3940
|
-
/**
|
|
3941
|
-
* Business ID
|
|
3942
|
-
* @type {number}
|
|
3943
|
-
* @memberof EndOfDayReportDto
|
|
3944
|
-
*/
|
|
3945
|
-
'businessId': number;
|
|
3946
|
-
/**
|
|
3947
|
-
* Payment reconciliation
|
|
3948
|
-
* @type {Array<PaymentDetailsDto>}
|
|
3949
|
-
* @memberof EndOfDayReportDto
|
|
3950
|
-
*/
|
|
3951
|
-
'paymentMethodDetails': Array<PaymentDetailsDto>;
|
|
3952
|
-
/**
|
|
3953
|
-
*
|
|
3954
|
-
* @type {EndOfDayReportDtoSalesSummary}
|
|
3955
|
-
* @memberof EndOfDayReportDto
|
|
3956
|
-
*/
|
|
3957
|
-
'salesSummary': EndOfDayReportDtoSalesSummary;
|
|
3958
|
-
/**
|
|
3959
|
-
*
|
|
3960
|
-
* @type {EndOfDayReportDtoTaxBreakdown}
|
|
3961
|
-
* @memberof EndOfDayReportDto
|
|
3962
|
-
*/
|
|
3963
|
-
'taxBreakdown': EndOfDayReportDtoTaxBreakdown;
|
|
3964
|
-
/**
|
|
3965
|
-
* Item breakdown
|
|
3966
|
-
* @type {Array<ItemBreakdownDto>}
|
|
3967
|
-
* @memberof EndOfDayReportDto
|
|
3968
|
-
*/
|
|
3969
|
-
'itemBreakdown': Array<ItemBreakdownDto>;
|
|
3970
|
-
}
|
|
3971
|
-
/**
|
|
3972
|
-
* Sales summary
|
|
3973
|
-
* @export
|
|
3974
|
-
* @interface EndOfDayReportDtoSalesSummary
|
|
3975
|
-
*/
|
|
3976
|
-
export interface EndOfDayReportDtoSalesSummary {
|
|
3977
|
-
/**
|
|
3978
|
-
* Total number of orders
|
|
3979
|
-
* @type {number}
|
|
3980
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
3981
|
-
*/
|
|
3982
|
-
'totalOrders': number;
|
|
3983
|
-
/**
|
|
3984
|
-
* Total sales amount
|
|
3985
|
-
* @type {number}
|
|
3986
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
3987
|
-
*/
|
|
3988
|
-
'totalSales': number;
|
|
3989
|
-
/**
|
|
3990
|
-
* Net sales amount after adjustments
|
|
3991
|
-
* @type {number}
|
|
3992
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
3993
|
-
*/
|
|
3994
|
-
'netSales': number;
|
|
3995
|
-
/**
|
|
3996
|
-
* Total amount actually paid
|
|
3997
|
-
* @type {number}
|
|
3998
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
3999
|
-
*/
|
|
4000
|
-
'totalPaid': number;
|
|
4001
|
-
/**
|
|
4002
|
-
* Total difference
|
|
4003
|
-
* @type {number}
|
|
4004
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
4005
|
-
*/
|
|
4006
|
-
'totalDifference': number;
|
|
4007
|
-
/**
|
|
4008
|
-
* Total transactions
|
|
4009
|
-
* @type {number}
|
|
4010
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
4011
|
-
*/
|
|
4012
|
-
'totalTransactions': number;
|
|
4013
|
-
/**
|
|
4014
|
-
* Number of rejected orders
|
|
4015
|
-
* @type {number}
|
|
4016
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
4017
|
-
*/
|
|
4018
|
-
'rejectedOrders': number;
|
|
4019
|
-
/**
|
|
4020
|
-
* Total rejected sales amount
|
|
4021
|
-
* @type {number}
|
|
4022
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
4023
|
-
*/
|
|
4024
|
-
'rejectedSales': number;
|
|
4025
|
-
/**
|
|
4026
|
-
* Average sales per order
|
|
4027
|
-
* @type {number}
|
|
4028
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
4029
|
-
*/
|
|
4030
|
-
'averageSales': number;
|
|
4031
|
-
/**
|
|
4032
|
-
* Total number of items sold
|
|
4033
|
-
* @type {number}
|
|
4034
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
4035
|
-
*/
|
|
4036
|
-
'totalItemsCount': number;
|
|
4037
|
-
/**
|
|
4038
|
-
* Total refund amount
|
|
4039
|
-
* @type {number}
|
|
4040
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
4041
|
-
*/
|
|
4042
|
-
'totalRefunds': number;
|
|
4043
|
-
/**
|
|
4044
|
-
* Total discount amount given
|
|
4045
|
-
* @type {number}
|
|
4046
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
4047
|
-
*/
|
|
4048
|
-
'totalDiscounts': number;
|
|
4049
|
-
/**
|
|
4050
|
-
* Total voucher forfeited amount in cents
|
|
4051
|
-
* @type {number}
|
|
4052
|
-
* @memberof EndOfDayReportDtoSalesSummary
|
|
4053
|
-
*/
|
|
4054
|
-
'totalVoucherForfeited': number;
|
|
4055
|
-
}
|
|
4056
|
-
/**
|
|
4057
|
-
* Tax breakdown
|
|
4058
|
-
* @export
|
|
4059
|
-
* @interface EndOfDayReportDtoTaxBreakdown
|
|
4060
|
-
*/
|
|
4061
|
-
export interface EndOfDayReportDtoTaxBreakdown {
|
|
4062
|
-
/**
|
|
4063
|
-
* Standard tax amount
|
|
4064
|
-
* @type {number}
|
|
4065
|
-
* @memberof EndOfDayReportDtoTaxBreakdown
|
|
4066
|
-
*/
|
|
4067
|
-
'standardTaxAmount': number;
|
|
4068
|
-
/**
|
|
4069
|
-
* Premium tax amount
|
|
4070
|
-
* @type {number}
|
|
4071
|
-
* @memberof EndOfDayReportDtoTaxBreakdown
|
|
4072
|
-
*/
|
|
4073
|
-
'premiumTaxAmount': number;
|
|
4074
|
-
/**
|
|
4075
|
-
* Total tax amount
|
|
4076
|
-
* @type {number}
|
|
4077
|
-
* @memberof EndOfDayReportDtoTaxBreakdown
|
|
4078
|
-
*/
|
|
4079
|
-
'totalTaxAmount': number;
|
|
4080
|
-
/**
|
|
4081
|
-
* Standard tax rate %
|
|
4082
|
-
* @type {number}
|
|
4083
|
-
* @memberof EndOfDayReportDtoTaxBreakdown
|
|
4084
|
-
*/
|
|
4085
|
-
'standardTaxRate': number;
|
|
4086
|
-
/**
|
|
4087
|
-
* Premium tax rate %
|
|
4088
|
-
* @type {number}
|
|
4089
|
-
* @memberof EndOfDayReportDtoTaxBreakdown
|
|
4090
|
-
*/
|
|
4091
|
-
'premiumTaxRate': number;
|
|
4092
|
-
}
|
|
4093
|
-
/**
|
|
4094
|
-
*
|
|
4095
|
-
* @export
|
|
4096
|
-
* @interface EndOfDayReportDtoV3
|
|
4097
|
-
*/
|
|
4098
|
-
export interface EndOfDayReportDtoV3 {
|
|
4099
|
-
/**
|
|
4100
|
-
* Report generated at
|
|
4101
|
-
* @type {string}
|
|
4102
|
-
* @memberof EndOfDayReportDtoV3
|
|
4103
|
-
*/
|
|
4104
|
-
'reportGeneratedAt': string;
|
|
4105
|
-
/**
|
|
4106
|
-
* Report date start
|
|
4107
|
-
* @type {string}
|
|
4108
|
-
* @memberof EndOfDayReportDtoV3
|
|
4109
|
-
*/
|
|
4110
|
-
'reportDateStart': string;
|
|
4111
|
-
/**
|
|
4112
|
-
* Report date end
|
|
4113
|
-
* @type {string}
|
|
4114
|
-
* @memberof EndOfDayReportDtoV3
|
|
4115
|
-
*/
|
|
4116
|
-
'reportDateEnd': string;
|
|
4117
|
-
/**
|
|
4118
|
-
* Business ID
|
|
4119
|
-
* @type {number}
|
|
4120
|
-
* @memberof EndOfDayReportDtoV3
|
|
4121
|
-
*/
|
|
4122
|
-
'businessId': number;
|
|
4123
|
-
/**
|
|
4124
|
-
* Payment reconciliation
|
|
4125
|
-
* @type {Array<PaymentDetailsDto>}
|
|
4126
|
-
* @memberof EndOfDayReportDtoV3
|
|
4127
|
-
*/
|
|
4128
|
-
'paymentMethodDetails': Array<PaymentDetailsDto>;
|
|
4129
|
-
/**
|
|
4130
|
-
*
|
|
4131
|
-
* @type {EndOfDayReportDtoSalesSummary}
|
|
4132
|
-
* @memberof EndOfDayReportDtoV3
|
|
4133
|
-
*/
|
|
4134
|
-
'salesSummary': EndOfDayReportDtoSalesSummary;
|
|
4135
|
-
/**
|
|
4136
|
-
*
|
|
4137
|
-
* @type {EndOfDayReportDtoV3TaxBreakdown}
|
|
4138
|
-
* @memberof EndOfDayReportDtoV3
|
|
4139
|
-
*/
|
|
4140
|
-
'taxBreakdown': EndOfDayReportDtoV3TaxBreakdown;
|
|
4141
|
-
/**
|
|
4142
|
-
* Item breakdown
|
|
4143
|
-
* @type {Array<ItemBreakdownDto>}
|
|
4144
|
-
* @memberof EndOfDayReportDtoV3
|
|
4145
|
-
*/
|
|
4146
|
-
'itemBreakdown': Array<ItemBreakdownDto>;
|
|
4147
|
-
}
|
|
4148
|
-
/**
|
|
4149
|
-
* Tax breakdown
|
|
4150
|
-
* @export
|
|
4151
|
-
* @interface EndOfDayReportDtoV3TaxBreakdown
|
|
4152
|
-
*/
|
|
4153
|
-
export interface EndOfDayReportDtoV3TaxBreakdown {
|
|
4154
|
-
/**
|
|
4155
|
-
* Tax breakdown by rate
|
|
4156
|
-
* @type {Array<TaxRateItem>}
|
|
4157
|
-
* @memberof EndOfDayReportDtoV3TaxBreakdown
|
|
4158
|
-
*/
|
|
4159
|
-
'taxRates': Array<TaxRateItem>;
|
|
4160
|
-
/**
|
|
4161
|
-
* Total tax amount
|
|
4162
|
-
* @type {number}
|
|
4163
|
-
* @memberof EndOfDayReportDtoV3TaxBreakdown
|
|
4164
|
-
*/
|
|
4165
|
-
'totalTaxAmount': number;
|
|
4166
|
-
}
|
|
4167
3856
|
/**
|
|
4168
3857
|
*
|
|
4169
3858
|
* @export
|
|
@@ -4208,10 +3897,10 @@ export interface EndOfDayReportDtoV4 {
|
|
|
4208
3897
|
'salesSummary': EndOfDayReportDtoV4SalesSummary;
|
|
4209
3898
|
/**
|
|
4210
3899
|
*
|
|
4211
|
-
* @type {
|
|
3900
|
+
* @type {EndOfDayReportDtoV4TaxBreakdown}
|
|
4212
3901
|
* @memberof EndOfDayReportDtoV4
|
|
4213
3902
|
*/
|
|
4214
|
-
'taxBreakdown':
|
|
3903
|
+
'taxBreakdown': EndOfDayReportDtoV4TaxBreakdown;
|
|
4215
3904
|
/**
|
|
4216
3905
|
* Item breakdown
|
|
4217
3906
|
* @type {Array<ItemBreakdownDto>}
|
|
@@ -4310,6 +3999,25 @@ export interface EndOfDayReportDtoV4SalesSummary {
|
|
|
4310
3999
|
*/
|
|
4311
4000
|
'totalPaymentAmount': number;
|
|
4312
4001
|
}
|
|
4002
|
+
/**
|
|
4003
|
+
* Tax breakdown
|
|
4004
|
+
* @export
|
|
4005
|
+
* @interface EndOfDayReportDtoV4TaxBreakdown
|
|
4006
|
+
*/
|
|
4007
|
+
export interface EndOfDayReportDtoV4TaxBreakdown {
|
|
4008
|
+
/**
|
|
4009
|
+
* Tax breakdown by rate
|
|
4010
|
+
* @type {Array<TaxRateItem>}
|
|
4011
|
+
* @memberof EndOfDayReportDtoV4TaxBreakdown
|
|
4012
|
+
*/
|
|
4013
|
+
'taxRates': Array<TaxRateItem>;
|
|
4014
|
+
/**
|
|
4015
|
+
* Total tax amount
|
|
4016
|
+
* @type {number}
|
|
4017
|
+
* @memberof EndOfDayReportDtoV4TaxBreakdown
|
|
4018
|
+
*/
|
|
4019
|
+
'totalTaxAmount': number;
|
|
4020
|
+
}
|
|
4313
4021
|
/**
|
|
4314
4022
|
*
|
|
4315
4023
|
* @export
|
|
@@ -4326,6 +4034,8 @@ export declare const EntityType: {
|
|
|
4326
4034
|
readonly Employee: "employee";
|
|
4327
4035
|
readonly Config: "config";
|
|
4328
4036
|
readonly Business: "business";
|
|
4037
|
+
readonly Suboption: "suboption";
|
|
4038
|
+
readonly Site: "site";
|
|
4329
4039
|
};
|
|
4330
4040
|
export type EntityType = typeof EntityType[keyof typeof EntityType];
|
|
4331
4041
|
/**
|
|
@@ -7509,10 +7219,10 @@ export interface OrderHistoryPosResponseDtoV2Summary {
|
|
|
7509
7219
|
export interface OrderHistoryResponseDto {
|
|
7510
7220
|
/**
|
|
7511
7221
|
* Order details
|
|
7512
|
-
* @type {Array<
|
|
7222
|
+
* @type {Array<UnifiedOrderResponseDto>}
|
|
7513
7223
|
* @memberof OrderHistoryResponseDto
|
|
7514
7224
|
*/
|
|
7515
|
-
'orders': Array<
|
|
7225
|
+
'orders': Array<UnifiedOrderResponseDto>;
|
|
7516
7226
|
/**
|
|
7517
7227
|
*
|
|
7518
7228
|
* @type {OrderHistoryResponseDtoSummary}
|
|
@@ -7585,50 +7295,7 @@ export interface OrderHistoryResponseDtoSummary {
|
|
|
7585
7295
|
/**
|
|
7586
7296
|
*
|
|
7587
7297
|
* @export
|
|
7588
|
-
* @
|
|
7589
|
-
*/
|
|
7590
|
-
export interface OrderPaginationDto {
|
|
7591
|
-
/**
|
|
7592
|
-
* Page number (starts from 1)
|
|
7593
|
-
* @type {number}
|
|
7594
|
-
* @memberof OrderPaginationDto
|
|
7595
|
-
*/
|
|
7596
|
-
'page'?: number;
|
|
7597
|
-
/**
|
|
7598
|
-
* Number of items per page (max 100)
|
|
7599
|
-
* @type {number}
|
|
7600
|
-
* @memberof OrderPaginationDto
|
|
7601
|
-
*/
|
|
7602
|
-
'limit'?: number;
|
|
7603
|
-
/**
|
|
7604
|
-
* Total number of items
|
|
7605
|
-
* @type {number}
|
|
7606
|
-
* @memberof OrderPaginationDto
|
|
7607
|
-
*/
|
|
7608
|
-
'total': number;
|
|
7609
|
-
/**
|
|
7610
|
-
* Total number of pages
|
|
7611
|
-
* @type {number}
|
|
7612
|
-
* @memberof OrderPaginationDto
|
|
7613
|
-
*/
|
|
7614
|
-
'totalPages': number;
|
|
7615
|
-
/**
|
|
7616
|
-
* Whether there is a next page
|
|
7617
|
-
* @type {boolean}
|
|
7618
|
-
* @memberof OrderPaginationDto
|
|
7619
|
-
*/
|
|
7620
|
-
'hasNext': boolean;
|
|
7621
|
-
/**
|
|
7622
|
-
* Whether there is a previous page
|
|
7623
|
-
* @type {boolean}
|
|
7624
|
-
* @memberof OrderPaginationDto
|
|
7625
|
-
*/
|
|
7626
|
-
'hasPrevious': boolean;
|
|
7627
|
-
}
|
|
7628
|
-
/**
|
|
7629
|
-
*
|
|
7630
|
-
* @export
|
|
7631
|
-
* @enum {string}
|
|
7298
|
+
* @enum {string}
|
|
7632
7299
|
*/
|
|
7633
7300
|
export declare const OrderRefundStatus: {
|
|
7634
7301
|
readonly None: "NONE";
|
|
@@ -7953,10 +7620,10 @@ export interface OrderResponseDtoDelivery {
|
|
|
7953
7620
|
'selfDelivery': boolean | null;
|
|
7954
7621
|
/**
|
|
7955
7622
|
* Delivery note
|
|
7956
|
-
* @type {
|
|
7623
|
+
* @type {object}
|
|
7957
7624
|
* @memberof OrderResponseDtoDelivery
|
|
7958
7625
|
*/
|
|
7959
|
-
'note':
|
|
7626
|
+
'note': object | null;
|
|
7960
7627
|
/**
|
|
7961
7628
|
*
|
|
7962
7629
|
* @type {DeliveryStatus}
|
|
@@ -8026,6 +7693,16 @@ export interface OrderResponseDtoPriceSummary {
|
|
|
8026
7693
|
*/
|
|
8027
7694
|
'totalNet': number;
|
|
8028
7695
|
}
|
|
7696
|
+
/**
|
|
7697
|
+
*
|
|
7698
|
+
* @export
|
|
7699
|
+
* @enum {string}
|
|
7700
|
+
*/
|
|
7701
|
+
export declare const OrderSource: {
|
|
7702
|
+
readonly Platform: "PLATFORM";
|
|
7703
|
+
readonly Pos: "POS";
|
|
7704
|
+
};
|
|
7705
|
+
export type OrderSource = typeof OrderSource[keyof typeof OrderSource];
|
|
8029
7706
|
/**
|
|
8030
7707
|
*
|
|
8031
7708
|
* @export
|
|
@@ -8682,87 +8359,6 @@ export interface OrderingItemExtraSubOptionDto {
|
|
|
8682
8359
|
*/
|
|
8683
8360
|
'enabled': boolean;
|
|
8684
8361
|
}
|
|
8685
|
-
/**
|
|
8686
|
-
*
|
|
8687
|
-
* @export
|
|
8688
|
-
* @interface PaginatedEmployeesResponseDto
|
|
8689
|
-
*/
|
|
8690
|
-
export interface PaginatedEmployeesResponseDto {
|
|
8691
|
-
/**
|
|
8692
|
-
*
|
|
8693
|
-
* @type {Array<EmployeeResponseDto>}
|
|
8694
|
-
* @memberof PaginatedEmployeesResponseDto
|
|
8695
|
-
*/
|
|
8696
|
-
'data': Array<EmployeeResponseDto>;
|
|
8697
|
-
/**
|
|
8698
|
-
*
|
|
8699
|
-
* @type {PaginationMetaDto}
|
|
8700
|
-
* @memberof PaginatedEmployeesResponseDto
|
|
8701
|
-
*/
|
|
8702
|
-
'pagination': PaginationMetaDto;
|
|
8703
|
-
}
|
|
8704
|
-
/**
|
|
8705
|
-
*
|
|
8706
|
-
* @export
|
|
8707
|
-
* @interface PaginatedOrderResponseDto
|
|
8708
|
-
*/
|
|
8709
|
-
export interface PaginatedOrderResponseDto {
|
|
8710
|
-
/**
|
|
8711
|
-
* Order details
|
|
8712
|
-
* @type {Array<OrderResponseDto>}
|
|
8713
|
-
* @memberof PaginatedOrderResponseDto
|
|
8714
|
-
*/
|
|
8715
|
-
'orders': Array<OrderResponseDto>;
|
|
8716
|
-
/**
|
|
8717
|
-
*
|
|
8718
|
-
* @type {PaginatedOrderResponseDtoPagination}
|
|
8719
|
-
* @memberof PaginatedOrderResponseDto
|
|
8720
|
-
*/
|
|
8721
|
-
'pagination': PaginatedOrderResponseDtoPagination;
|
|
8722
|
-
}
|
|
8723
|
-
/**
|
|
8724
|
-
* Pagination details
|
|
8725
|
-
* @export
|
|
8726
|
-
* @interface PaginatedOrderResponseDtoPagination
|
|
8727
|
-
*/
|
|
8728
|
-
export interface PaginatedOrderResponseDtoPagination {
|
|
8729
|
-
/**
|
|
8730
|
-
* Page number (starts from 1)
|
|
8731
|
-
* @type {number}
|
|
8732
|
-
* @memberof PaginatedOrderResponseDtoPagination
|
|
8733
|
-
*/
|
|
8734
|
-
'page'?: number;
|
|
8735
|
-
/**
|
|
8736
|
-
* Number of items per page (max 100)
|
|
8737
|
-
* @type {number}
|
|
8738
|
-
* @memberof PaginatedOrderResponseDtoPagination
|
|
8739
|
-
*/
|
|
8740
|
-
'limit'?: number;
|
|
8741
|
-
/**
|
|
8742
|
-
* Total number of items
|
|
8743
|
-
* @type {number}
|
|
8744
|
-
* @memberof PaginatedOrderResponseDtoPagination
|
|
8745
|
-
*/
|
|
8746
|
-
'total': number;
|
|
8747
|
-
/**
|
|
8748
|
-
* Total number of pages
|
|
8749
|
-
* @type {number}
|
|
8750
|
-
* @memberof PaginatedOrderResponseDtoPagination
|
|
8751
|
-
*/
|
|
8752
|
-
'totalPages': number;
|
|
8753
|
-
/**
|
|
8754
|
-
* Whether there is a next page
|
|
8755
|
-
* @type {boolean}
|
|
8756
|
-
* @memberof PaginatedOrderResponseDtoPagination
|
|
8757
|
-
*/
|
|
8758
|
-
'hasNext': boolean;
|
|
8759
|
-
/**
|
|
8760
|
-
* Whether there is a previous page
|
|
8761
|
-
* @type {boolean}
|
|
8762
|
-
* @memberof PaginatedOrderResponseDtoPagination
|
|
8763
|
-
*/
|
|
8764
|
-
'hasPrevious': boolean;
|
|
8765
|
-
}
|
|
8766
8362
|
/**
|
|
8767
8363
|
*
|
|
8768
8364
|
* @export
|
|
@@ -8807,37 +8403,6 @@ export interface PaginationDto {
|
|
|
8807
8403
|
*/
|
|
8808
8404
|
'totalPages': number;
|
|
8809
8405
|
}
|
|
8810
|
-
/**
|
|
8811
|
-
*
|
|
8812
|
-
* @export
|
|
8813
|
-
* @interface PaginationMetaDto
|
|
8814
|
-
*/
|
|
8815
|
-
export interface PaginationMetaDto {
|
|
8816
|
-
/**
|
|
8817
|
-
*
|
|
8818
|
-
* @type {number}
|
|
8819
|
-
* @memberof PaginationMetaDto
|
|
8820
|
-
*/
|
|
8821
|
-
'total': number;
|
|
8822
|
-
/**
|
|
8823
|
-
*
|
|
8824
|
-
* @type {number}
|
|
8825
|
-
* @memberof PaginationMetaDto
|
|
8826
|
-
*/
|
|
8827
|
-
'page': number;
|
|
8828
|
-
/**
|
|
8829
|
-
*
|
|
8830
|
-
* @type {number}
|
|
8831
|
-
* @memberof PaginationMetaDto
|
|
8832
|
-
*/
|
|
8833
|
-
'limit': number;
|
|
8834
|
-
/**
|
|
8835
|
-
*
|
|
8836
|
-
* @type {number}
|
|
8837
|
-
* @memberof PaginationMetaDto
|
|
8838
|
-
*/
|
|
8839
|
-
'totalPages': number;
|
|
8840
|
-
}
|
|
8841
8406
|
/**
|
|
8842
8407
|
*
|
|
8843
8408
|
* @export
|
|
@@ -10169,6 +9734,12 @@ export interface PosBusinessDto {
|
|
|
10169
9734
|
* @memberof PosBusinessDto
|
|
10170
9735
|
*/
|
|
10171
9736
|
'name': string;
|
|
9737
|
+
/**
|
|
9738
|
+
*
|
|
9739
|
+
* @type {string}
|
|
9740
|
+
* @memberof PosBusinessDto
|
|
9741
|
+
*/
|
|
9742
|
+
'logo': string | null;
|
|
10172
9743
|
/**
|
|
10173
9744
|
*
|
|
10174
9745
|
* @type {string}
|
|
@@ -11452,6 +11023,7 @@ export declare const PosPermission: {
|
|
|
11452
11023
|
readonly ShiftForceClockOut: "Shift::ForceClockOut";
|
|
11453
11024
|
readonly Settings: "Settings::*";
|
|
11454
11025
|
readonly SettingsEditProfile: "Settings::EditProfile";
|
|
11026
|
+
readonly OpenOrdersDelete: "OpenOrders::Delete";
|
|
11455
11027
|
};
|
|
11456
11028
|
export type PosPermission = typeof PosPermission[keyof typeof PosPermission];
|
|
11457
11029
|
/**
|
|
@@ -13287,91 +12859,6 @@ export interface RoleResponseDto {
|
|
|
13287
12859
|
*/
|
|
13288
12860
|
'permissionRules': Array<PermissionRuleDto>;
|
|
13289
12861
|
}
|
|
13290
|
-
/**
|
|
13291
|
-
*
|
|
13292
|
-
* @export
|
|
13293
|
-
* @interface SalesSummaryDto
|
|
13294
|
-
*/
|
|
13295
|
-
export interface SalesSummaryDto {
|
|
13296
|
-
/**
|
|
13297
|
-
* Total number of orders
|
|
13298
|
-
* @type {number}
|
|
13299
|
-
* @memberof SalesSummaryDto
|
|
13300
|
-
*/
|
|
13301
|
-
'totalOrders': number;
|
|
13302
|
-
/**
|
|
13303
|
-
* Total sales amount
|
|
13304
|
-
* @type {number}
|
|
13305
|
-
* @memberof SalesSummaryDto
|
|
13306
|
-
*/
|
|
13307
|
-
'totalSales': number;
|
|
13308
|
-
/**
|
|
13309
|
-
* Net sales amount after adjustments
|
|
13310
|
-
* @type {number}
|
|
13311
|
-
* @memberof SalesSummaryDto
|
|
13312
|
-
*/
|
|
13313
|
-
'netSales': number;
|
|
13314
|
-
/**
|
|
13315
|
-
* Total amount actually paid
|
|
13316
|
-
* @type {number}
|
|
13317
|
-
* @memberof SalesSummaryDto
|
|
13318
|
-
*/
|
|
13319
|
-
'totalPaid': number;
|
|
13320
|
-
/**
|
|
13321
|
-
* Total difference
|
|
13322
|
-
* @type {number}
|
|
13323
|
-
* @memberof SalesSummaryDto
|
|
13324
|
-
*/
|
|
13325
|
-
'totalDifference': number;
|
|
13326
|
-
/**
|
|
13327
|
-
* Total transactions
|
|
13328
|
-
* @type {number}
|
|
13329
|
-
* @memberof SalesSummaryDto
|
|
13330
|
-
*/
|
|
13331
|
-
'totalTransactions': number;
|
|
13332
|
-
/**
|
|
13333
|
-
* Number of rejected orders
|
|
13334
|
-
* @type {number}
|
|
13335
|
-
* @memberof SalesSummaryDto
|
|
13336
|
-
*/
|
|
13337
|
-
'rejectedOrders': number;
|
|
13338
|
-
/**
|
|
13339
|
-
* Total rejected sales amount
|
|
13340
|
-
* @type {number}
|
|
13341
|
-
* @memberof SalesSummaryDto
|
|
13342
|
-
*/
|
|
13343
|
-
'rejectedSales': number;
|
|
13344
|
-
/**
|
|
13345
|
-
* Average sales per order
|
|
13346
|
-
* @type {number}
|
|
13347
|
-
* @memberof SalesSummaryDto
|
|
13348
|
-
*/
|
|
13349
|
-
'averageSales': number;
|
|
13350
|
-
/**
|
|
13351
|
-
* Total number of items sold
|
|
13352
|
-
* @type {number}
|
|
13353
|
-
* @memberof SalesSummaryDto
|
|
13354
|
-
*/
|
|
13355
|
-
'totalItemsCount': number;
|
|
13356
|
-
/**
|
|
13357
|
-
* Total refund amount
|
|
13358
|
-
* @type {number}
|
|
13359
|
-
* @memberof SalesSummaryDto
|
|
13360
|
-
*/
|
|
13361
|
-
'totalRefunds': number;
|
|
13362
|
-
/**
|
|
13363
|
-
* Total discount amount given
|
|
13364
|
-
* @type {number}
|
|
13365
|
-
* @memberof SalesSummaryDto
|
|
13366
|
-
*/
|
|
13367
|
-
'totalDiscounts': number;
|
|
13368
|
-
/**
|
|
13369
|
-
* Total voucher forfeited amount in cents
|
|
13370
|
-
* @type {number}
|
|
13371
|
-
* @memberof SalesSummaryDto
|
|
13372
|
-
*/
|
|
13373
|
-
'totalVoucherForfeited': number;
|
|
13374
|
-
}
|
|
13375
12862
|
/**
|
|
13376
12863
|
*
|
|
13377
12864
|
* @export
|
|
@@ -13506,308 +12993,102 @@ export interface SearchUserInfoResponseDto {
|
|
|
13506
12993
|
/**
|
|
13507
12994
|
*
|
|
13508
12995
|
* @export
|
|
13509
|
-
* @interface
|
|
12996
|
+
* @interface SendReportEmailDto
|
|
13510
12997
|
*/
|
|
13511
|
-
export interface
|
|
12998
|
+
export interface SendReportEmailDto {
|
|
13512
12999
|
/**
|
|
13513
|
-
*
|
|
13514
|
-
* @type {
|
|
13515
|
-
* @memberof
|
|
13000
|
+
* Optional custom subject
|
|
13001
|
+
* @type {string}
|
|
13002
|
+
* @memberof SendReportEmailDto
|
|
13516
13003
|
*/
|
|
13517
|
-
'
|
|
13004
|
+
'subject'?: string;
|
|
13518
13005
|
/**
|
|
13519
|
-
*
|
|
13006
|
+
* Additional message for email body
|
|
13520
13007
|
* @type {string}
|
|
13521
|
-
* @memberof
|
|
13008
|
+
* @memberof SendReportEmailDto
|
|
13522
13009
|
*/
|
|
13523
|
-
'
|
|
13010
|
+
'message'?: string;
|
|
13524
13011
|
/**
|
|
13525
|
-
*
|
|
13526
|
-
* @type {
|
|
13527
|
-
* @memberof
|
|
13012
|
+
* Email address to send the report to
|
|
13013
|
+
* @type {string}
|
|
13014
|
+
* @memberof SendReportEmailDto
|
|
13528
13015
|
*/
|
|
13529
|
-
'
|
|
13016
|
+
'email'?: string;
|
|
13017
|
+
}
|
|
13018
|
+
/**
|
|
13019
|
+
*
|
|
13020
|
+
* @export
|
|
13021
|
+
* @interface ShareOrderingBusinessIdPayload
|
|
13022
|
+
*/
|
|
13023
|
+
export interface ShareOrderingBusinessIdPayload {
|
|
13024
|
+
/**
|
|
13025
|
+
* The ordering business ID for this transaction.
|
|
13026
|
+
* @type {number}
|
|
13027
|
+
* @memberof ShareOrderingBusinessIdPayload
|
|
13028
|
+
*/
|
|
13029
|
+
'orderingBusinessId': number;
|
|
13530
13030
|
}
|
|
13531
13031
|
/**
|
|
13532
|
-
*
|
|
13032
|
+
*
|
|
13533
13033
|
* @export
|
|
13534
|
-
* @interface
|
|
13034
|
+
* @interface ShiftEmployeeDto
|
|
13535
13035
|
*/
|
|
13536
|
-
export interface
|
|
13036
|
+
export interface ShiftEmployeeDto {
|
|
13537
13037
|
/**
|
|
13538
13038
|
*
|
|
13539
13039
|
* @type {string}
|
|
13540
|
-
* @memberof
|
|
13040
|
+
* @memberof ShiftEmployeeDto
|
|
13541
13041
|
*/
|
|
13542
13042
|
'id': string;
|
|
13543
13043
|
/**
|
|
13544
13044
|
*
|
|
13545
13045
|
* @type {string}
|
|
13546
|
-
* @memberof
|
|
13046
|
+
* @memberof ShiftEmployeeDto
|
|
13547
13047
|
*/
|
|
13548
|
-
'
|
|
13048
|
+
'name': string;
|
|
13549
13049
|
/**
|
|
13550
13050
|
*
|
|
13551
|
-
* @type {
|
|
13552
|
-
* @memberof
|
|
13051
|
+
* @type {Status}
|
|
13052
|
+
* @memberof ShiftEmployeeDto
|
|
13553
13053
|
*/
|
|
13554
|
-
'
|
|
13054
|
+
'status': Status;
|
|
13555
13055
|
/**
|
|
13556
13056
|
*
|
|
13557
|
-
* @type {
|
|
13558
|
-
* @memberof
|
|
13057
|
+
* @type {string}
|
|
13058
|
+
* @memberof ShiftEmployeeDto
|
|
13559
13059
|
*/
|
|
13560
|
-
'
|
|
13060
|
+
'photoUrl': string | null;
|
|
13061
|
+
}
|
|
13062
|
+
/**
|
|
13063
|
+
*
|
|
13064
|
+
* @export
|
|
13065
|
+
* @enum {string}
|
|
13066
|
+
*/
|
|
13067
|
+
export declare const SimplePaymentStatus: {
|
|
13068
|
+
readonly Pending: "PENDING";
|
|
13069
|
+
readonly Success: "SUCCESS";
|
|
13070
|
+
readonly Failed: "FAILED";
|
|
13071
|
+
};
|
|
13072
|
+
export type SimplePaymentStatus = typeof SimplePaymentStatus[keyof typeof SimplePaymentStatus];
|
|
13073
|
+
/**
|
|
13074
|
+
*
|
|
13075
|
+
* @export
|
|
13076
|
+
* @interface SingleProviderStatusResponseDto
|
|
13077
|
+
*/
|
|
13078
|
+
export interface SingleProviderStatusResponseDto {
|
|
13561
13079
|
/**
|
|
13562
13080
|
*
|
|
13563
|
-
* @type {
|
|
13564
|
-
* @memberof
|
|
13081
|
+
* @type {SingleProviderStatusResponseDtoActiveChannel}
|
|
13082
|
+
* @memberof SingleProviderStatusResponseDto
|
|
13565
13083
|
*/
|
|
13566
|
-
'
|
|
13567
|
-
|
|
13568
|
-
|
|
13569
|
-
|
|
13570
|
-
|
|
13571
|
-
|
|
13572
|
-
|
|
13573
|
-
|
|
13574
|
-
*
|
|
13575
|
-
* @type {string}
|
|
13576
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13577
|
-
*/
|
|
13578
|
-
'updatedAt': string;
|
|
13579
|
-
/**
|
|
13580
|
-
*
|
|
13581
|
-
* @type {string}
|
|
13582
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13583
|
-
*/
|
|
13584
|
-
'orderNumber': string;
|
|
13585
|
-
/**
|
|
13586
|
-
*
|
|
13587
|
-
* @type {OrderTypePOS}
|
|
13588
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13589
|
-
*/
|
|
13590
|
-
'orderType': OrderTypePOS;
|
|
13591
|
-
/**
|
|
13592
|
-
*
|
|
13593
|
-
* @type {string}
|
|
13594
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13595
|
-
*/
|
|
13596
|
-
'spotNumber': string | null;
|
|
13597
|
-
/**
|
|
13598
|
-
*
|
|
13599
|
-
* @type {string}
|
|
13600
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13601
|
-
*/
|
|
13602
|
-
'comments': string | null;
|
|
13603
|
-
/**
|
|
13604
|
-
* Id of the staff in shift
|
|
13605
|
-
* @type {string}
|
|
13606
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13607
|
-
*/
|
|
13608
|
-
'staffId': string | null;
|
|
13609
|
-
/**
|
|
13610
|
-
* Id of the shift
|
|
13611
|
-
* @type {string}
|
|
13612
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13613
|
-
*/
|
|
13614
|
-
'shiftId': string | null;
|
|
13615
|
-
/**
|
|
13616
|
-
*
|
|
13617
|
-
* @type {OrderRefundStatus}
|
|
13618
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13619
|
-
*/
|
|
13620
|
-
'orderRefundStatus': OrderRefundStatus;
|
|
13621
|
-
/**
|
|
13622
|
-
*
|
|
13623
|
-
* @type {LocatorType}
|
|
13624
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13625
|
-
*/
|
|
13626
|
-
'locatorType': LocatorType;
|
|
13627
|
-
/**
|
|
13628
|
-
*
|
|
13629
|
-
* @type {PosOrderPriceDto}
|
|
13630
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13631
|
-
*/
|
|
13632
|
-
'basketPrice': PosOrderPriceDto;
|
|
13633
|
-
/**
|
|
13634
|
-
*
|
|
13635
|
-
* @type {Array<PosOrderItemDto>}
|
|
13636
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13637
|
-
*/
|
|
13638
|
-
'items': Array<PosOrderItemDto>;
|
|
13639
|
-
/**
|
|
13640
|
-
*
|
|
13641
|
-
* @type {Array<PosDiscountDto>}
|
|
13642
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13643
|
-
*/
|
|
13644
|
-
'discounts': Array<PosDiscountDto>;
|
|
13645
|
-
/**
|
|
13646
|
-
*
|
|
13647
|
-
* @type {PosCustomerDto}
|
|
13648
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13649
|
-
*/
|
|
13650
|
-
'customer': PosCustomerDto | null;
|
|
13651
|
-
/**
|
|
13652
|
-
*
|
|
13653
|
-
* @type {Array<TransactionDto>}
|
|
13654
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13655
|
-
*/
|
|
13656
|
-
'paymentEvents': Array<TransactionDto>;
|
|
13657
|
-
/**
|
|
13658
|
-
*
|
|
13659
|
-
* @type {Array<PaymentRefundDto>}
|
|
13660
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13661
|
-
*/
|
|
13662
|
-
'refunds'?: Array<PaymentRefundDto>;
|
|
13663
|
-
/**
|
|
13664
|
-
* Data version code
|
|
13665
|
-
* @type {string}
|
|
13666
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13667
|
-
*/
|
|
13668
|
-
'version': string;
|
|
13669
|
-
/**
|
|
13670
|
-
*
|
|
13671
|
-
* @type {OrderFormat}
|
|
13672
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13673
|
-
*/
|
|
13674
|
-
'orderFormat'?: OrderFormat;
|
|
13675
|
-
/**
|
|
13676
|
-
* The ID of the loyalty program active during this order.
|
|
13677
|
-
* @type {string}
|
|
13678
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13679
|
-
*/
|
|
13680
|
-
'loyaltyProgramId': string | null;
|
|
13681
|
-
/**
|
|
13682
|
-
* An array of loyalty transaction IDs related to this order.
|
|
13683
|
-
* @type {Array<string>}
|
|
13684
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13685
|
-
*/
|
|
13686
|
-
'loyaltyTransactionIds': Array<string>;
|
|
13687
|
-
/**
|
|
13688
|
-
*
|
|
13689
|
-
* @type {PosOrderDtoTaxSummary}
|
|
13690
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13691
|
-
*/
|
|
13692
|
-
'taxSummary'?: PosOrderDtoTaxSummary;
|
|
13693
|
-
/**
|
|
13694
|
-
* Name of staff member who created the order
|
|
13695
|
-
* @type {string}
|
|
13696
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13697
|
-
*/
|
|
13698
|
-
'staffName'?: string | null;
|
|
13699
|
-
/**
|
|
13700
|
-
*
|
|
13701
|
-
* @type {PosOrderDtoInvoiceCompany}
|
|
13702
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13703
|
-
*/
|
|
13704
|
-
'invoiceCompany'?: PosOrderDtoInvoiceCompany | null;
|
|
13705
|
-
/**
|
|
13706
|
-
*
|
|
13707
|
-
* @type {object}
|
|
13708
|
-
* @memberof SendPosOrderTicketDtoData
|
|
13709
|
-
*/
|
|
13710
|
-
'lastPaymentError'?: object;
|
|
13711
|
-
}
|
|
13712
|
-
/**
|
|
13713
|
-
*
|
|
13714
|
-
* @export
|
|
13715
|
-
* @interface SendReportEmailDto
|
|
13716
|
-
*/
|
|
13717
|
-
export interface SendReportEmailDto {
|
|
13718
|
-
/**
|
|
13719
|
-
* Optional custom subject
|
|
13720
|
-
* @type {string}
|
|
13721
|
-
* @memberof SendReportEmailDto
|
|
13722
|
-
*/
|
|
13723
|
-
'subject'?: string;
|
|
13724
|
-
/**
|
|
13725
|
-
* Additional message for email body
|
|
13726
|
-
* @type {string}
|
|
13727
|
-
* @memberof SendReportEmailDto
|
|
13728
|
-
*/
|
|
13729
|
-
'message'?: string;
|
|
13730
|
-
/**
|
|
13731
|
-
* Email address to send the report to
|
|
13732
|
-
* @type {string}
|
|
13733
|
-
* @memberof SendReportEmailDto
|
|
13734
|
-
*/
|
|
13735
|
-
'email'?: string;
|
|
13736
|
-
}
|
|
13737
|
-
/**
|
|
13738
|
-
*
|
|
13739
|
-
* @export
|
|
13740
|
-
* @interface ShareOrderingBusinessIdPayload
|
|
13741
|
-
*/
|
|
13742
|
-
export interface ShareOrderingBusinessIdPayload {
|
|
13743
|
-
/**
|
|
13744
|
-
* The ordering business ID for this transaction.
|
|
13745
|
-
* @type {number}
|
|
13746
|
-
* @memberof ShareOrderingBusinessIdPayload
|
|
13747
|
-
*/
|
|
13748
|
-
'orderingBusinessId': number;
|
|
13749
|
-
}
|
|
13750
|
-
/**
|
|
13751
|
-
*
|
|
13752
|
-
* @export
|
|
13753
|
-
* @interface ShiftEmployeeDto
|
|
13754
|
-
*/
|
|
13755
|
-
export interface ShiftEmployeeDto {
|
|
13756
|
-
/**
|
|
13757
|
-
*
|
|
13758
|
-
* @type {string}
|
|
13759
|
-
* @memberof ShiftEmployeeDto
|
|
13760
|
-
*/
|
|
13761
|
-
'id': string;
|
|
13762
|
-
/**
|
|
13763
|
-
*
|
|
13764
|
-
* @type {string}
|
|
13765
|
-
* @memberof ShiftEmployeeDto
|
|
13766
|
-
*/
|
|
13767
|
-
'name': string;
|
|
13768
|
-
/**
|
|
13769
|
-
*
|
|
13770
|
-
* @type {Status}
|
|
13771
|
-
* @memberof ShiftEmployeeDto
|
|
13772
|
-
*/
|
|
13773
|
-
'status': Status;
|
|
13774
|
-
/**
|
|
13775
|
-
*
|
|
13776
|
-
* @type {string}
|
|
13777
|
-
* @memberof ShiftEmployeeDto
|
|
13778
|
-
*/
|
|
13779
|
-
'photoUrl': string | null;
|
|
13780
|
-
}
|
|
13781
|
-
/**
|
|
13782
|
-
*
|
|
13783
|
-
* @export
|
|
13784
|
-
* @enum {string}
|
|
13785
|
-
*/
|
|
13786
|
-
export declare const SimplePaymentStatus: {
|
|
13787
|
-
readonly Pending: "PENDING";
|
|
13788
|
-
readonly Success: "SUCCESS";
|
|
13789
|
-
readonly Failed: "FAILED";
|
|
13790
|
-
};
|
|
13791
|
-
export type SimplePaymentStatus = typeof SimplePaymentStatus[keyof typeof SimplePaymentStatus];
|
|
13792
|
-
/**
|
|
13793
|
-
*
|
|
13794
|
-
* @export
|
|
13795
|
-
* @interface SingleProviderStatusResponseDto
|
|
13796
|
-
*/
|
|
13797
|
-
export interface SingleProviderStatusResponseDto {
|
|
13798
|
-
/**
|
|
13799
|
-
*
|
|
13800
|
-
* @type {SingleProviderStatusResponseDtoActiveChannel}
|
|
13801
|
-
* @memberof SingleProviderStatusResponseDto
|
|
13802
|
-
*/
|
|
13803
|
-
'activeChannel': SingleProviderStatusResponseDtoActiveChannel | null;
|
|
13804
|
-
}
|
|
13805
|
-
/**
|
|
13806
|
-
* Active channel status
|
|
13807
|
-
* @export
|
|
13808
|
-
* @interface SingleProviderStatusResponseDtoActiveChannel
|
|
13809
|
-
*/
|
|
13810
|
-
export interface SingleProviderStatusResponseDtoActiveChannel {
|
|
13084
|
+
'activeChannel': SingleProviderStatusResponseDtoActiveChannel | null;
|
|
13085
|
+
}
|
|
13086
|
+
/**
|
|
13087
|
+
* Active channel status
|
|
13088
|
+
* @export
|
|
13089
|
+
* @interface SingleProviderStatusResponseDtoActiveChannel
|
|
13090
|
+
*/
|
|
13091
|
+
export interface SingleProviderStatusResponseDtoActiveChannel {
|
|
13811
13092
|
/**
|
|
13812
13093
|
*
|
|
13813
13094
|
* @type {ProviderEnum}
|
|
@@ -14489,43 +13770,6 @@ export interface SyncTerminalDto {
|
|
|
14489
13770
|
*/
|
|
14490
13771
|
'businessId': number;
|
|
14491
13772
|
}
|
|
14492
|
-
/**
|
|
14493
|
-
*
|
|
14494
|
-
* @export
|
|
14495
|
-
* @interface TaxBreakdownDto
|
|
14496
|
-
*/
|
|
14497
|
-
export interface TaxBreakdownDto {
|
|
14498
|
-
/**
|
|
14499
|
-
* Standard tax amount
|
|
14500
|
-
* @type {number}
|
|
14501
|
-
* @memberof TaxBreakdownDto
|
|
14502
|
-
*/
|
|
14503
|
-
'standardTaxAmount': number;
|
|
14504
|
-
/**
|
|
14505
|
-
* Premium tax amount
|
|
14506
|
-
* @type {number}
|
|
14507
|
-
* @memberof TaxBreakdownDto
|
|
14508
|
-
*/
|
|
14509
|
-
'premiumTaxAmount': number;
|
|
14510
|
-
/**
|
|
14511
|
-
* Total tax amount
|
|
14512
|
-
* @type {number}
|
|
14513
|
-
* @memberof TaxBreakdownDto
|
|
14514
|
-
*/
|
|
14515
|
-
'totalTaxAmount': number;
|
|
14516
|
-
/**
|
|
14517
|
-
* Standard tax rate %
|
|
14518
|
-
* @type {number}
|
|
14519
|
-
* @memberof TaxBreakdownDto
|
|
14520
|
-
*/
|
|
14521
|
-
'standardTaxRate': number;
|
|
14522
|
-
/**
|
|
14523
|
-
* Premium tax rate %
|
|
14524
|
-
* @type {number}
|
|
14525
|
-
* @memberof TaxBreakdownDto
|
|
14526
|
-
*/
|
|
14527
|
-
'premiumTaxRate': number;
|
|
14528
|
-
}
|
|
14529
13773
|
/**
|
|
14530
13774
|
*
|
|
14531
13775
|
* @export
|
|
@@ -14957,21 +14201,1225 @@ export type Type = typeof Type[keyof typeof Type];
|
|
|
14957
14201
|
/**
|
|
14958
14202
|
*
|
|
14959
14203
|
* @export
|
|
14960
|
-
* @interface
|
|
14204
|
+
* @interface UnifiedBusinessDto
|
|
14205
|
+
*/
|
|
14206
|
+
export interface UnifiedBusinessDto {
|
|
14207
|
+
/**
|
|
14208
|
+
* Unique identifier of the business
|
|
14209
|
+
* @type {string}
|
|
14210
|
+
* @memberof UnifiedBusinessDto
|
|
14211
|
+
*/
|
|
14212
|
+
'id': string;
|
|
14213
|
+
/**
|
|
14214
|
+
* Display name of the business
|
|
14215
|
+
* @type {string}
|
|
14216
|
+
* @memberof UnifiedBusinessDto
|
|
14217
|
+
*/
|
|
14218
|
+
'name': string;
|
|
14219
|
+
/**
|
|
14220
|
+
* Logo URL of the business
|
|
14221
|
+
* @type {string}
|
|
14222
|
+
* @memberof UnifiedBusinessDto
|
|
14223
|
+
*/
|
|
14224
|
+
'logo'?: string | null;
|
|
14225
|
+
/**
|
|
14226
|
+
* Contact email of the business
|
|
14227
|
+
* @type {string}
|
|
14228
|
+
* @memberof UnifiedBusinessDto
|
|
14229
|
+
*/
|
|
14230
|
+
'email'?: string | null;
|
|
14231
|
+
/**
|
|
14232
|
+
* Physical address of the business
|
|
14233
|
+
* @type {string}
|
|
14234
|
+
* @memberof UnifiedBusinessDto
|
|
14235
|
+
*/
|
|
14236
|
+
'address'?: string | null;
|
|
14237
|
+
/**
|
|
14238
|
+
* Contact phone number of the business
|
|
14239
|
+
* @type {string}
|
|
14240
|
+
* @memberof UnifiedBusinessDto
|
|
14241
|
+
*/
|
|
14242
|
+
'phone'?: string | null;
|
|
14243
|
+
/**
|
|
14244
|
+
* Whether the business is currently enabled
|
|
14245
|
+
* @type {boolean}
|
|
14246
|
+
* @memberof UnifiedBusinessDto
|
|
14247
|
+
*/
|
|
14248
|
+
'enabled'?: boolean | null;
|
|
14249
|
+
/**
|
|
14250
|
+
* Timezone of the business, e.g. Europe/Helsinki. POS only
|
|
14251
|
+
* @type {string}
|
|
14252
|
+
* @memberof UnifiedBusinessDto
|
|
14253
|
+
*/
|
|
14254
|
+
'timezone'?: string | null;
|
|
14255
|
+
/**
|
|
14256
|
+
* BIC/SWIFT code of the business. POS only
|
|
14257
|
+
* @type {string}
|
|
14258
|
+
* @memberof UnifiedBusinessDto
|
|
14259
|
+
*/
|
|
14260
|
+
'bic'?: string | null;
|
|
14261
|
+
/**
|
|
14262
|
+
* Legal company name of the business. POS only
|
|
14263
|
+
* @type {string}
|
|
14264
|
+
* @memberof UnifiedBusinessDto
|
|
14265
|
+
*/
|
|
14266
|
+
'companyName'?: string | null;
|
|
14267
|
+
/**
|
|
14268
|
+
* Company phone number of the business. POS only
|
|
14269
|
+
* @type {string}
|
|
14270
|
+
* @memberof UnifiedBusinessDto
|
|
14271
|
+
*/
|
|
14272
|
+
'companyPhone'?: string | null;
|
|
14273
|
+
/**
|
|
14274
|
+
* Ordering platform business ID. POS only
|
|
14275
|
+
* @type {string}
|
|
14276
|
+
* @memberof UnifiedBusinessDto
|
|
14277
|
+
*/
|
|
14278
|
+
'orderingBusinessId'?: string | null;
|
|
14279
|
+
}
|
|
14280
|
+
/**
|
|
14281
|
+
*
|
|
14282
|
+
* @export
|
|
14283
|
+
* @interface UnifiedCustomerDto
|
|
14284
|
+
*/
|
|
14285
|
+
export interface UnifiedCustomerDto {
|
|
14286
|
+
/**
|
|
14287
|
+
* Unique identifier of the customer
|
|
14288
|
+
* @type {string}
|
|
14289
|
+
* @memberof UnifiedCustomerDto
|
|
14290
|
+
*/
|
|
14291
|
+
'id': string;
|
|
14292
|
+
/**
|
|
14293
|
+
* Full name of the customer
|
|
14294
|
+
* @type {string}
|
|
14295
|
+
* @memberof UnifiedCustomerDto
|
|
14296
|
+
*/
|
|
14297
|
+
'name'?: string | null;
|
|
14298
|
+
/**
|
|
14299
|
+
* Phone number of the customer
|
|
14300
|
+
* @type {string}
|
|
14301
|
+
* @memberof UnifiedCustomerDto
|
|
14302
|
+
*/
|
|
14303
|
+
'phone'?: string | null;
|
|
14304
|
+
/**
|
|
14305
|
+
* Email address of the customer
|
|
14306
|
+
* @type {string}
|
|
14307
|
+
* @memberof UnifiedCustomerDto
|
|
14308
|
+
*/
|
|
14309
|
+
'email'?: string | null;
|
|
14310
|
+
/**
|
|
14311
|
+
* Phone country code of the customer, e.g. +358. POS only
|
|
14312
|
+
* @type {string}
|
|
14313
|
+
* @memberof UnifiedCustomerDto
|
|
14314
|
+
*/
|
|
14315
|
+
'countryCode'?: string | null;
|
|
14316
|
+
/**
|
|
14317
|
+
* Logo URL of the customer. POS only
|
|
14318
|
+
* @type {string}
|
|
14319
|
+
* @memberof UnifiedCustomerDto
|
|
14320
|
+
*/
|
|
14321
|
+
'logo'?: string | null;
|
|
14322
|
+
}
|
|
14323
|
+
/**
|
|
14324
|
+
*
|
|
14325
|
+
* @export
|
|
14326
|
+
* @interface UnifiedDeliveryDto
|
|
14327
|
+
*/
|
|
14328
|
+
export interface UnifiedDeliveryDto {
|
|
14329
|
+
/**
|
|
14330
|
+
* Delivery fee amount in the order currency
|
|
14331
|
+
* @type {number}
|
|
14332
|
+
* @memberof UnifiedDeliveryDto
|
|
14333
|
+
*/
|
|
14334
|
+
'deliveryFee': number;
|
|
14335
|
+
/**
|
|
14336
|
+
*
|
|
14337
|
+
* @type {DeliveryStatus}
|
|
14338
|
+
* @memberof UnifiedDeliveryDto
|
|
14339
|
+
*/
|
|
14340
|
+
'status': DeliveryStatus;
|
|
14341
|
+
/**
|
|
14342
|
+
*
|
|
14343
|
+
* @type {DeliveryType}
|
|
14344
|
+
* @memberof UnifiedDeliveryDto
|
|
14345
|
+
*/
|
|
14346
|
+
'type': DeliveryType;
|
|
14347
|
+
/**
|
|
14348
|
+
* Whether the business handles delivery themselves
|
|
14349
|
+
* @type {boolean}
|
|
14350
|
+
* @memberof UnifiedDeliveryDto
|
|
14351
|
+
*/
|
|
14352
|
+
'selfDelivery'?: boolean | null;
|
|
14353
|
+
/**
|
|
14354
|
+
* Delivery note left by the customer
|
|
14355
|
+
* @type {string}
|
|
14356
|
+
* @memberof UnifiedDeliveryDto
|
|
14357
|
+
*/
|
|
14358
|
+
'note'?: string | null;
|
|
14359
|
+
/**
|
|
14360
|
+
* Formatted delivery address
|
|
14361
|
+
* @type {string}
|
|
14362
|
+
* @memberof UnifiedDeliveryDto
|
|
14363
|
+
*/
|
|
14364
|
+
'formattedAddress'?: string | null;
|
|
14365
|
+
/**
|
|
14366
|
+
* City of the delivery address
|
|
14367
|
+
* @type {string}
|
|
14368
|
+
* @memberof UnifiedDeliveryDto
|
|
14369
|
+
*/
|
|
14370
|
+
'city'?: string | null;
|
|
14371
|
+
/**
|
|
14372
|
+
* Country of the delivery address
|
|
14373
|
+
* @type {string}
|
|
14374
|
+
* @memberof UnifiedDeliveryDto
|
|
14375
|
+
*/
|
|
14376
|
+
'country'?: string | null;
|
|
14377
|
+
}
|
|
14378
|
+
/**
|
|
14379
|
+
*
|
|
14380
|
+
* @export
|
|
14381
|
+
* @interface UnifiedDiscountsResponseDto
|
|
14382
|
+
*/
|
|
14383
|
+
export interface UnifiedDiscountsResponseDto {
|
|
14384
|
+
/**
|
|
14385
|
+
* Venue-level discounts
|
|
14386
|
+
* @type {Array<BusinessDiscountDto>}
|
|
14387
|
+
* @memberof UnifiedDiscountsResponseDto
|
|
14388
|
+
*/
|
|
14389
|
+
'venue': Array<BusinessDiscountDto>;
|
|
14390
|
+
/**
|
|
14391
|
+
* Global (owner-level) discounts applicable to this venue
|
|
14392
|
+
* @type {Array<BusinessDiscountDto>}
|
|
14393
|
+
* @memberof UnifiedDiscountsResponseDto
|
|
14394
|
+
*/
|
|
14395
|
+
'global': Array<BusinessDiscountDto>;
|
|
14396
|
+
}
|
|
14397
|
+
/**
|
|
14398
|
+
*
|
|
14399
|
+
* @export
|
|
14400
|
+
* @interface UnifiedLastPaymentErrorDto
|
|
14401
|
+
*/
|
|
14402
|
+
export interface UnifiedLastPaymentErrorDto {
|
|
14403
|
+
/**
|
|
14404
|
+
*
|
|
14405
|
+
* @type {PaymentFailureCode}
|
|
14406
|
+
* @memberof UnifiedLastPaymentErrorDto
|
|
14407
|
+
*/
|
|
14408
|
+
'code': PaymentFailureCode;
|
|
14409
|
+
/**
|
|
14410
|
+
* Human-readable error message from the payment provider
|
|
14411
|
+
* @type {string}
|
|
14412
|
+
* @memberof UnifiedLastPaymentErrorDto
|
|
14413
|
+
*/
|
|
14414
|
+
'providerMessage': string;
|
|
14415
|
+
/**
|
|
14416
|
+
* Timestamp when the payment error occurred
|
|
14417
|
+
* @type {string}
|
|
14418
|
+
* @memberof UnifiedLastPaymentErrorDto
|
|
14419
|
+
*/
|
|
14420
|
+
'timestamp': string;
|
|
14421
|
+
/**
|
|
14422
|
+
* Whether the payment can be retried after this error
|
|
14423
|
+
* @type {boolean}
|
|
14424
|
+
* @memberof UnifiedLastPaymentErrorDto
|
|
14425
|
+
*/
|
|
14426
|
+
'retryable': boolean;
|
|
14427
|
+
}
|
|
14428
|
+
/**
|
|
14429
|
+
*
|
|
14430
|
+
* @export
|
|
14431
|
+
* @interface UnifiedOptionDto
|
|
14432
|
+
*/
|
|
14433
|
+
export interface UnifiedOptionDto {
|
|
14434
|
+
/**
|
|
14435
|
+
* Unique identifier of the option
|
|
14436
|
+
* @type {string}
|
|
14437
|
+
* @memberof UnifiedOptionDto
|
|
14438
|
+
*/
|
|
14439
|
+
'id': string;
|
|
14440
|
+
/**
|
|
14441
|
+
* External identifier of the option from the ordering platform
|
|
14442
|
+
* @type {string}
|
|
14443
|
+
* @memberof UnifiedOptionDto
|
|
14444
|
+
*/
|
|
14445
|
+
'externalId': string;
|
|
14446
|
+
/**
|
|
14447
|
+
* Display name of the option
|
|
14448
|
+
* @type {string}
|
|
14449
|
+
* @memberof UnifiedOptionDto
|
|
14450
|
+
*/
|
|
14451
|
+
'name': string;
|
|
14452
|
+
/**
|
|
14453
|
+
* Image URL for the option
|
|
14454
|
+
* @type {string}
|
|
14455
|
+
* @memberof UnifiedOptionDto
|
|
14456
|
+
*/
|
|
14457
|
+
'image'?: string | null;
|
|
14458
|
+
/**
|
|
14459
|
+
* List of sub-options selected under this option
|
|
14460
|
+
* @type {Array<UnifiedSubOptionDto>}
|
|
14461
|
+
* @memberof UnifiedOptionDto
|
|
14462
|
+
*/
|
|
14463
|
+
'subOptions': Array<UnifiedSubOptionDto>;
|
|
14464
|
+
}
|
|
14465
|
+
/**
|
|
14466
|
+
*
|
|
14467
|
+
* @export
|
|
14468
|
+
* @interface UnifiedOrderResponseDto
|
|
14469
|
+
*/
|
|
14470
|
+
export interface UnifiedOrderResponseDto {
|
|
14471
|
+
/**
|
|
14472
|
+
*
|
|
14473
|
+
* @type {OrderSource}
|
|
14474
|
+
* @memberof UnifiedOrderResponseDto
|
|
14475
|
+
*/
|
|
14476
|
+
'source': OrderSource;
|
|
14477
|
+
/**
|
|
14478
|
+
* Unique identifier of the order
|
|
14479
|
+
* @type {string}
|
|
14480
|
+
* @memberof UnifiedOrderResponseDto
|
|
14481
|
+
*/
|
|
14482
|
+
'id': string;
|
|
14483
|
+
/**
|
|
14484
|
+
* Human-readable order number shown to staff and customers
|
|
14485
|
+
* @type {string}
|
|
14486
|
+
* @memberof UnifiedOrderResponseDto
|
|
14487
|
+
*/
|
|
14488
|
+
'orderNumber': string;
|
|
14489
|
+
/**
|
|
14490
|
+
*
|
|
14491
|
+
* @type {ProviderEnum}
|
|
14492
|
+
* @memberof UnifiedOrderResponseDto
|
|
14493
|
+
*/
|
|
14494
|
+
'provider': ProviderEnum;
|
|
14495
|
+
/**
|
|
14496
|
+
*
|
|
14497
|
+
* @type {OrderStatusEnum}
|
|
14498
|
+
* @memberof UnifiedOrderResponseDto
|
|
14499
|
+
*/
|
|
14500
|
+
'status': OrderStatusEnum;
|
|
14501
|
+
/**
|
|
14502
|
+
* Ordering platform business ID that owns this order
|
|
14503
|
+
* @type {number}
|
|
14504
|
+
* @memberof UnifiedOrderResponseDto
|
|
14505
|
+
*/
|
|
14506
|
+
'orderingBusinessId': number;
|
|
14507
|
+
/**
|
|
14508
|
+
* Timestamp when the order was created
|
|
14509
|
+
* @type {string}
|
|
14510
|
+
* @memberof UnifiedOrderResponseDto
|
|
14511
|
+
*/
|
|
14512
|
+
'createdAt': string;
|
|
14513
|
+
/**
|
|
14514
|
+
* Timestamp when the order was last updated
|
|
14515
|
+
* @type {string}
|
|
14516
|
+
* @memberof UnifiedOrderResponseDto
|
|
14517
|
+
*/
|
|
14518
|
+
'updatedAt': string;
|
|
14519
|
+
/**
|
|
14520
|
+
*
|
|
14521
|
+
* @type {OrderType}
|
|
14522
|
+
* @memberof UnifiedOrderResponseDto
|
|
14523
|
+
*/
|
|
14524
|
+
'orderType': OrderType;
|
|
14525
|
+
/**
|
|
14526
|
+
* External order identifier from the delivery platform. Platform only
|
|
14527
|
+
* @type {string}
|
|
14528
|
+
* @memberof UnifiedOrderResponseDto
|
|
14529
|
+
*/
|
|
14530
|
+
'externalId'?: string | null;
|
|
14531
|
+
/**
|
|
14532
|
+
*
|
|
14533
|
+
* @type {Type}
|
|
14534
|
+
* @memberof UnifiedOrderResponseDto
|
|
14535
|
+
*/
|
|
14536
|
+
'type'?: Type | null;
|
|
14537
|
+
/**
|
|
14538
|
+
*
|
|
14539
|
+
* @type {PaymentStatus}
|
|
14540
|
+
* @memberof UnifiedOrderResponseDto
|
|
14541
|
+
*/
|
|
14542
|
+
'paymentStatus'?: PaymentStatus | null;
|
|
14543
|
+
/**
|
|
14544
|
+
*
|
|
14545
|
+
* @type {PaymentTypeEnum}
|
|
14546
|
+
* @memberof UnifiedOrderResponseDto
|
|
14547
|
+
*/
|
|
14548
|
+
'paymentType'?: PaymentTypeEnum | null;
|
|
14549
|
+
/**
|
|
14550
|
+
* Preparation time in minutes set when the order was accepted. Platform only
|
|
14551
|
+
* @type {number}
|
|
14552
|
+
* @memberof UnifiedOrderResponseDto
|
|
14553
|
+
*/
|
|
14554
|
+
'preparedIn'?: number | null;
|
|
14555
|
+
/**
|
|
14556
|
+
* Additional comment left by the customer. Platform only
|
|
14557
|
+
* @type {string}
|
|
14558
|
+
* @memberof UnifiedOrderResponseDto
|
|
14559
|
+
*/
|
|
14560
|
+
'customerComment'?: string | null;
|
|
14561
|
+
/**
|
|
14562
|
+
* Dine-in table or seat number. Platform only
|
|
14563
|
+
* @type {string}
|
|
14564
|
+
* @memberof UnifiedOrderResponseDto
|
|
14565
|
+
*/
|
|
14566
|
+
'dineInNumber'?: string | null;
|
|
14567
|
+
/**
|
|
14568
|
+
* Reason provided when the order was rejected. Platform only
|
|
14569
|
+
* @type {string}
|
|
14570
|
+
* @memberof UnifiedOrderResponseDto
|
|
14571
|
+
*/
|
|
14572
|
+
'rejectedReason'?: string | null;
|
|
14573
|
+
/**
|
|
14574
|
+
* Timestamp when the order expires. Platform only
|
|
14575
|
+
* @type {string}
|
|
14576
|
+
* @memberof UnifiedOrderResponseDto
|
|
14577
|
+
*/
|
|
14578
|
+
'expiryDate'?: string | null;
|
|
14579
|
+
/**
|
|
14580
|
+
* Timestamp when the order was accepted. Platform only
|
|
14581
|
+
* @type {string}
|
|
14582
|
+
* @memberof UnifiedOrderResponseDto
|
|
14583
|
+
*/
|
|
14584
|
+
'acceptedAt'?: string | null;
|
|
14585
|
+
/**
|
|
14586
|
+
* Estimated customer pickup time. Platform only
|
|
14587
|
+
* @type {string}
|
|
14588
|
+
* @memberof UnifiedOrderResponseDto
|
|
14589
|
+
*/
|
|
14590
|
+
'pickupEta'?: string | null;
|
|
14591
|
+
/**
|
|
14592
|
+
* Estimated delivery time to the customer. Platform only
|
|
14593
|
+
* @type {string}
|
|
14594
|
+
* @memberof UnifiedOrderResponseDto
|
|
14595
|
+
*/
|
|
14596
|
+
'deliveryEta'?: string | null;
|
|
14597
|
+
/**
|
|
14598
|
+
* Firebase business document ID. POS only
|
|
14599
|
+
* @type {string}
|
|
14600
|
+
* @memberof UnifiedOrderResponseDto
|
|
14601
|
+
*/
|
|
14602
|
+
'businessId'?: string | null;
|
|
14603
|
+
/**
|
|
14604
|
+
*
|
|
14605
|
+
* @type {CurrencyCode}
|
|
14606
|
+
* @memberof UnifiedOrderResponseDto
|
|
14607
|
+
*/
|
|
14608
|
+
'currency'?: CurrencyCode | null;
|
|
14609
|
+
/**
|
|
14610
|
+
* Spot or table number assigned to the order. POS only
|
|
14611
|
+
* @type {string}
|
|
14612
|
+
* @memberof UnifiedOrderResponseDto
|
|
14613
|
+
*/
|
|
14614
|
+
'spotNumber'?: string | null;
|
|
14615
|
+
/**
|
|
14616
|
+
* General comment on the order. POS only
|
|
14617
|
+
* @type {string}
|
|
14618
|
+
* @memberof UnifiedOrderResponseDto
|
|
14619
|
+
*/
|
|
14620
|
+
'comments'?: string | null;
|
|
14621
|
+
/**
|
|
14622
|
+
* ID of the staff member who created or handled the order. POS only
|
|
14623
|
+
* @type {string}
|
|
14624
|
+
* @memberof UnifiedOrderResponseDto
|
|
14625
|
+
*/
|
|
14626
|
+
'staffId'?: string | null;
|
|
14627
|
+
/**
|
|
14628
|
+
* ID of the shift during which the order was created. POS only
|
|
14629
|
+
* @type {string}
|
|
14630
|
+
* @memberof UnifiedOrderResponseDto
|
|
14631
|
+
*/
|
|
14632
|
+
'shiftId'?: string | null;
|
|
14633
|
+
/**
|
|
14634
|
+
* Name of the staff member who created the order. POS only
|
|
14635
|
+
* @type {string}
|
|
14636
|
+
* @memberof UnifiedOrderResponseDto
|
|
14637
|
+
*/
|
|
14638
|
+
'staffName'?: string | null;
|
|
14639
|
+
/**
|
|
14640
|
+
* Data schema version of the POS order document. POS only
|
|
14641
|
+
* @type {string}
|
|
14642
|
+
* @memberof UnifiedOrderResponseDto
|
|
14643
|
+
*/
|
|
14644
|
+
'version'?: string | null;
|
|
14645
|
+
/**
|
|
14646
|
+
*
|
|
14647
|
+
* @type {OrderRefundStatus}
|
|
14648
|
+
* @memberof UnifiedOrderResponseDto
|
|
14649
|
+
*/
|
|
14650
|
+
'orderRefundStatus'?: OrderRefundStatus | null;
|
|
14651
|
+
/**
|
|
14652
|
+
*
|
|
14653
|
+
* @type {LocatorType}
|
|
14654
|
+
* @memberof UnifiedOrderResponseDto
|
|
14655
|
+
*/
|
|
14656
|
+
'locatorType'?: LocatorType | null;
|
|
14657
|
+
/**
|
|
14658
|
+
*
|
|
14659
|
+
* @type {OrderFormat}
|
|
14660
|
+
* @memberof UnifiedOrderResponseDto
|
|
14661
|
+
*/
|
|
14662
|
+
'orderFormat'?: OrderFormat | null;
|
|
14663
|
+
/**
|
|
14664
|
+
* ID of the loyalty program active during this order. POS only
|
|
14665
|
+
* @type {string}
|
|
14666
|
+
* @memberof UnifiedOrderResponseDto
|
|
14667
|
+
*/
|
|
14668
|
+
'loyaltyProgramId'?: string | null;
|
|
14669
|
+
/**
|
|
14670
|
+
* Array of loyalty transaction IDs linked to this order. POS only
|
|
14671
|
+
* @type {Array<string>}
|
|
14672
|
+
* @memberof UnifiedOrderResponseDto
|
|
14673
|
+
*/
|
|
14674
|
+
'loyaltyTransactionIds'?: Array<string>;
|
|
14675
|
+
/**
|
|
14676
|
+
*
|
|
14677
|
+
* @type {UnifiedOrderResponseDtoCustomer}
|
|
14678
|
+
* @memberof UnifiedOrderResponseDto
|
|
14679
|
+
*/
|
|
14680
|
+
'customer'?: UnifiedOrderResponseDtoCustomer | null;
|
|
14681
|
+
/**
|
|
14682
|
+
*
|
|
14683
|
+
* @type {UnifiedOrderResponseDtoBusiness}
|
|
14684
|
+
* @memberof UnifiedOrderResponseDto
|
|
14685
|
+
*/
|
|
14686
|
+
'business'?: UnifiedOrderResponseDtoBusiness | null;
|
|
14687
|
+
/**
|
|
14688
|
+
* List of refunds associated with this order
|
|
14689
|
+
* @type {Array<UnifiedRefundDto>}
|
|
14690
|
+
* @memberof UnifiedOrderResponseDto
|
|
14691
|
+
*/
|
|
14692
|
+
'refunds'?: Array<UnifiedRefundDto>;
|
|
14693
|
+
/**
|
|
14694
|
+
*
|
|
14695
|
+
* @type {UnifiedOrderResponseDtoDelivery}
|
|
14696
|
+
* @memberof UnifiedOrderResponseDto
|
|
14697
|
+
*/
|
|
14698
|
+
'delivery'?: UnifiedOrderResponseDtoDelivery | null;
|
|
14699
|
+
/**
|
|
14700
|
+
*
|
|
14701
|
+
* @type {UnifiedOrderResponseDtoPreorder}
|
|
14702
|
+
* @memberof UnifiedOrderResponseDto
|
|
14703
|
+
*/
|
|
14704
|
+
'preorder'?: UnifiedOrderResponseDtoPreorder | null;
|
|
14705
|
+
/**
|
|
14706
|
+
*
|
|
14707
|
+
* @type {UnifiedOrderResponseDtoPriceSummary}
|
|
14708
|
+
* @memberof UnifiedOrderResponseDto
|
|
14709
|
+
*/
|
|
14710
|
+
'priceSummary'?: UnifiedOrderResponseDtoPriceSummary | null;
|
|
14711
|
+
/**
|
|
14712
|
+
* Discounts applied to the order. Platform only
|
|
14713
|
+
* @type {Array<UnifiedPlatformDiscountDto>}
|
|
14714
|
+
* @memberof UnifiedOrderResponseDto
|
|
14715
|
+
*/
|
|
14716
|
+
'discounts'?: Array<UnifiedPlatformDiscountDto>;
|
|
14717
|
+
/**
|
|
14718
|
+
* Products in the order. Platform only
|
|
14719
|
+
* @type {Array<UnifiedProductDto>}
|
|
14720
|
+
* @memberof UnifiedOrderResponseDto
|
|
14721
|
+
*/
|
|
14722
|
+
'products'?: Array<UnifiedProductDto>;
|
|
14723
|
+
/**
|
|
14724
|
+
*
|
|
14725
|
+
* @type {UnifiedOrderResponseDtoBasketPrice}
|
|
14726
|
+
* @memberof UnifiedOrderResponseDto
|
|
14727
|
+
*/
|
|
14728
|
+
'basketPrice'?: UnifiedOrderResponseDtoBasketPrice | null;
|
|
14729
|
+
/**
|
|
14730
|
+
* Line items in the POS order. POS only
|
|
14731
|
+
* @type {Array<PosOrderItemDto>}
|
|
14732
|
+
* @memberof UnifiedOrderResponseDto
|
|
14733
|
+
*/
|
|
14734
|
+
'items'?: Array<PosOrderItemDto>;
|
|
14735
|
+
/**
|
|
14736
|
+
* Discounts applied in the POS order. POS only
|
|
14737
|
+
* @type {Array<PosDiscountDto>}
|
|
14738
|
+
* @memberof UnifiedOrderResponseDto
|
|
14739
|
+
*/
|
|
14740
|
+
'posDiscounts'?: Array<PosDiscountDto>;
|
|
14741
|
+
/**
|
|
14742
|
+
* Payment transactions recorded for the POS order. POS only
|
|
14743
|
+
* @type {Array<TransactionDto>}
|
|
14744
|
+
* @memberof UnifiedOrderResponseDto
|
|
14745
|
+
*/
|
|
14746
|
+
'paymentEvents'?: Array<TransactionDto>;
|
|
14747
|
+
/**
|
|
14748
|
+
*
|
|
14749
|
+
* @type {UnifiedOrderResponseDtoTaxSummary}
|
|
14750
|
+
* @memberof UnifiedOrderResponseDto
|
|
14751
|
+
*/
|
|
14752
|
+
'taxSummary'?: UnifiedOrderResponseDtoTaxSummary | null;
|
|
14753
|
+
/**
|
|
14754
|
+
*
|
|
14755
|
+
* @type {UnifiedOrderResponseDtoInvoiceCompany}
|
|
14756
|
+
* @memberof UnifiedOrderResponseDto
|
|
14757
|
+
*/
|
|
14758
|
+
'invoiceCompany'?: UnifiedOrderResponseDtoInvoiceCompany | null;
|
|
14759
|
+
/**
|
|
14760
|
+
*
|
|
14761
|
+
* @type {UnifiedOrderResponseDtoLastPaymentError}
|
|
14762
|
+
* @memberof UnifiedOrderResponseDto
|
|
14763
|
+
*/
|
|
14764
|
+
'lastPaymentError'?: UnifiedOrderResponseDtoLastPaymentError | null;
|
|
14765
|
+
}
|
|
14766
|
+
/**
|
|
14767
|
+
* Full price breakdown including discounts and totals. POS only
|
|
14768
|
+
* @export
|
|
14769
|
+
* @interface UnifiedOrderResponseDtoBasketPrice
|
|
14770
|
+
*/
|
|
14771
|
+
export interface UnifiedOrderResponseDtoBasketPrice {
|
|
14772
|
+
/**
|
|
14773
|
+
*
|
|
14774
|
+
* @type {PriceBreakdownDto}
|
|
14775
|
+
* @memberof UnifiedOrderResponseDtoBasketPrice
|
|
14776
|
+
*/
|
|
14777
|
+
'priceBreakdown': PriceBreakdownDto;
|
|
14778
|
+
/**
|
|
14779
|
+
*
|
|
14780
|
+
* @type {MoneyDto}
|
|
14781
|
+
* @memberof UnifiedOrderResponseDtoBasketPrice
|
|
14782
|
+
*/
|
|
14783
|
+
'total': MoneyDto;
|
|
14784
|
+
}
|
|
14785
|
+
/**
|
|
14786
|
+
* Business that received the order
|
|
14787
|
+
* @export
|
|
14788
|
+
* @interface UnifiedOrderResponseDtoBusiness
|
|
14789
|
+
*/
|
|
14790
|
+
export interface UnifiedOrderResponseDtoBusiness {
|
|
14791
|
+
/**
|
|
14792
|
+
* Unique identifier of the business
|
|
14793
|
+
* @type {string}
|
|
14794
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14795
|
+
*/
|
|
14796
|
+
'id': string;
|
|
14797
|
+
/**
|
|
14798
|
+
* Display name of the business
|
|
14799
|
+
* @type {string}
|
|
14800
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14801
|
+
*/
|
|
14802
|
+
'name': string;
|
|
14803
|
+
/**
|
|
14804
|
+
* Logo URL of the business
|
|
14805
|
+
* @type {string}
|
|
14806
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14807
|
+
*/
|
|
14808
|
+
'logo'?: string | null;
|
|
14809
|
+
/**
|
|
14810
|
+
* Contact email of the business
|
|
14811
|
+
* @type {string}
|
|
14812
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14813
|
+
*/
|
|
14814
|
+
'email'?: string | null;
|
|
14815
|
+
/**
|
|
14816
|
+
* Physical address of the business
|
|
14817
|
+
* @type {string}
|
|
14818
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14819
|
+
*/
|
|
14820
|
+
'address'?: string | null;
|
|
14821
|
+
/**
|
|
14822
|
+
* Contact phone number of the business
|
|
14823
|
+
* @type {string}
|
|
14824
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14825
|
+
*/
|
|
14826
|
+
'phone'?: string | null;
|
|
14827
|
+
/**
|
|
14828
|
+
* Whether the business is currently enabled
|
|
14829
|
+
* @type {boolean}
|
|
14830
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14831
|
+
*/
|
|
14832
|
+
'enabled'?: boolean | null;
|
|
14833
|
+
/**
|
|
14834
|
+
* Timezone of the business, e.g. Europe/Helsinki. POS only
|
|
14835
|
+
* @type {string}
|
|
14836
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14837
|
+
*/
|
|
14838
|
+
'timezone'?: string | null;
|
|
14839
|
+
/**
|
|
14840
|
+
* BIC/SWIFT code of the business. POS only
|
|
14841
|
+
* @type {string}
|
|
14842
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14843
|
+
*/
|
|
14844
|
+
'bic'?: string | null;
|
|
14845
|
+
/**
|
|
14846
|
+
* Legal company name of the business. POS only
|
|
14847
|
+
* @type {string}
|
|
14848
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14849
|
+
*/
|
|
14850
|
+
'companyName'?: string | null;
|
|
14851
|
+
/**
|
|
14852
|
+
* Company phone number of the business. POS only
|
|
14853
|
+
* @type {string}
|
|
14854
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14855
|
+
*/
|
|
14856
|
+
'companyPhone'?: string | null;
|
|
14857
|
+
/**
|
|
14858
|
+
* Ordering platform business ID. POS only
|
|
14859
|
+
* @type {string}
|
|
14860
|
+
* @memberof UnifiedOrderResponseDtoBusiness
|
|
14861
|
+
*/
|
|
14862
|
+
'orderingBusinessId'?: string | null;
|
|
14863
|
+
}
|
|
14864
|
+
/**
|
|
14865
|
+
* Customer who placed the order
|
|
14866
|
+
* @export
|
|
14867
|
+
* @interface UnifiedOrderResponseDtoCustomer
|
|
14868
|
+
*/
|
|
14869
|
+
export interface UnifiedOrderResponseDtoCustomer {
|
|
14870
|
+
/**
|
|
14871
|
+
* Unique identifier of the customer
|
|
14872
|
+
* @type {string}
|
|
14873
|
+
* @memberof UnifiedOrderResponseDtoCustomer
|
|
14874
|
+
*/
|
|
14875
|
+
'id': string;
|
|
14876
|
+
/**
|
|
14877
|
+
* Full name of the customer
|
|
14878
|
+
* @type {string}
|
|
14879
|
+
* @memberof UnifiedOrderResponseDtoCustomer
|
|
14880
|
+
*/
|
|
14881
|
+
'name'?: string | null;
|
|
14882
|
+
/**
|
|
14883
|
+
* Phone number of the customer
|
|
14884
|
+
* @type {string}
|
|
14885
|
+
* @memberof UnifiedOrderResponseDtoCustomer
|
|
14886
|
+
*/
|
|
14887
|
+
'phone'?: string | null;
|
|
14888
|
+
/**
|
|
14889
|
+
* Email address of the customer
|
|
14890
|
+
* @type {string}
|
|
14891
|
+
* @memberof UnifiedOrderResponseDtoCustomer
|
|
14892
|
+
*/
|
|
14893
|
+
'email'?: string | null;
|
|
14894
|
+
/**
|
|
14895
|
+
* Phone country code of the customer, e.g. +358. POS only
|
|
14896
|
+
* @type {string}
|
|
14897
|
+
* @memberof UnifiedOrderResponseDtoCustomer
|
|
14898
|
+
*/
|
|
14899
|
+
'countryCode'?: string | null;
|
|
14900
|
+
/**
|
|
14901
|
+
* Logo URL of the customer. POS only
|
|
14902
|
+
* @type {string}
|
|
14903
|
+
* @memberof UnifiedOrderResponseDtoCustomer
|
|
14904
|
+
*/
|
|
14905
|
+
'logo'?: string | null;
|
|
14906
|
+
}
|
|
14907
|
+
/**
|
|
14908
|
+
* Delivery details for the order. Platform only
|
|
14909
|
+
* @export
|
|
14910
|
+
* @interface UnifiedOrderResponseDtoDelivery
|
|
14911
|
+
*/
|
|
14912
|
+
export interface UnifiedOrderResponseDtoDelivery {
|
|
14913
|
+
/**
|
|
14914
|
+
* Delivery fee amount in the order currency
|
|
14915
|
+
* @type {number}
|
|
14916
|
+
* @memberof UnifiedOrderResponseDtoDelivery
|
|
14917
|
+
*/
|
|
14918
|
+
'deliveryFee': number;
|
|
14919
|
+
/**
|
|
14920
|
+
*
|
|
14921
|
+
* @type {DeliveryStatus}
|
|
14922
|
+
* @memberof UnifiedOrderResponseDtoDelivery
|
|
14923
|
+
*/
|
|
14924
|
+
'status': DeliveryStatus;
|
|
14925
|
+
/**
|
|
14926
|
+
*
|
|
14927
|
+
* @type {DeliveryType}
|
|
14928
|
+
* @memberof UnifiedOrderResponseDtoDelivery
|
|
14929
|
+
*/
|
|
14930
|
+
'type': DeliveryType;
|
|
14931
|
+
/**
|
|
14932
|
+
* Whether the business handles delivery themselves
|
|
14933
|
+
* @type {boolean}
|
|
14934
|
+
* @memberof UnifiedOrderResponseDtoDelivery
|
|
14935
|
+
*/
|
|
14936
|
+
'selfDelivery'?: boolean | null;
|
|
14937
|
+
/**
|
|
14938
|
+
* Delivery note left by the customer
|
|
14939
|
+
* @type {string}
|
|
14940
|
+
* @memberof UnifiedOrderResponseDtoDelivery
|
|
14941
|
+
*/
|
|
14942
|
+
'note'?: string | null;
|
|
14943
|
+
/**
|
|
14944
|
+
* Formatted delivery address
|
|
14945
|
+
* @type {string}
|
|
14946
|
+
* @memberof UnifiedOrderResponseDtoDelivery
|
|
14947
|
+
*/
|
|
14948
|
+
'formattedAddress'?: string | null;
|
|
14949
|
+
/**
|
|
14950
|
+
* City of the delivery address
|
|
14951
|
+
* @type {string}
|
|
14952
|
+
* @memberof UnifiedOrderResponseDtoDelivery
|
|
14953
|
+
*/
|
|
14954
|
+
'city'?: string | null;
|
|
14955
|
+
/**
|
|
14956
|
+
* Country of the delivery address
|
|
14957
|
+
* @type {string}
|
|
14958
|
+
* @memberof UnifiedOrderResponseDtoDelivery
|
|
14959
|
+
*/
|
|
14960
|
+
'country'?: string | null;
|
|
14961
|
+
}
|
|
14962
|
+
/**
|
|
14963
|
+
* Invoice company details attached to the POS order. POS only
|
|
14964
|
+
* @export
|
|
14965
|
+
* @interface UnifiedOrderResponseDtoInvoiceCompany
|
|
14966
|
+
*/
|
|
14967
|
+
export interface UnifiedOrderResponseDtoInvoiceCompany {
|
|
14968
|
+
/**
|
|
14969
|
+
*
|
|
14970
|
+
* @type {string}
|
|
14971
|
+
* @memberof UnifiedOrderResponseDtoInvoiceCompany
|
|
14972
|
+
*/
|
|
14973
|
+
'id': string;
|
|
14974
|
+
/**
|
|
14975
|
+
*
|
|
14976
|
+
* @type {number}
|
|
14977
|
+
* @memberof UnifiedOrderResponseDtoInvoiceCompany
|
|
14978
|
+
*/
|
|
14979
|
+
'businessId': number;
|
|
14980
|
+
/**
|
|
14981
|
+
*
|
|
14982
|
+
* @type {string}
|
|
14983
|
+
* @memberof UnifiedOrderResponseDtoInvoiceCompany
|
|
14984
|
+
*/
|
|
14985
|
+
'name': string;
|
|
14986
|
+
/**
|
|
14987
|
+
*
|
|
14988
|
+
* @type {string}
|
|
14989
|
+
* @memberof UnifiedOrderResponseDtoInvoiceCompany
|
|
14990
|
+
*/
|
|
14991
|
+
'email': string;
|
|
14992
|
+
/**
|
|
14993
|
+
*
|
|
14994
|
+
* @type {string}
|
|
14995
|
+
* @memberof UnifiedOrderResponseDtoInvoiceCompany
|
|
14996
|
+
*/
|
|
14997
|
+
'countryCode': string;
|
|
14998
|
+
/**
|
|
14999
|
+
*
|
|
15000
|
+
* @type {string}
|
|
15001
|
+
* @memberof UnifiedOrderResponseDtoInvoiceCompany
|
|
15002
|
+
*/
|
|
15003
|
+
'phone': string;
|
|
15004
|
+
/**
|
|
15005
|
+
*
|
|
15006
|
+
* @type {string}
|
|
15007
|
+
* @memberof UnifiedOrderResponseDtoInvoiceCompany
|
|
15008
|
+
*/
|
|
15009
|
+
'bic'?: string;
|
|
15010
|
+
/**
|
|
15011
|
+
*
|
|
15012
|
+
* @type {string}
|
|
15013
|
+
* @memberof UnifiedOrderResponseDtoInvoiceCompany
|
|
15014
|
+
*/
|
|
15015
|
+
'address'?: string;
|
|
15016
|
+
/**
|
|
15017
|
+
*
|
|
15018
|
+
* @type {string}
|
|
15019
|
+
* @memberof UnifiedOrderResponseDtoInvoiceCompany
|
|
15020
|
+
*/
|
|
15021
|
+
'createdAt': string;
|
|
15022
|
+
/**
|
|
15023
|
+
*
|
|
15024
|
+
* @type {string}
|
|
15025
|
+
* @memberof UnifiedOrderResponseDtoInvoiceCompany
|
|
15026
|
+
*/
|
|
15027
|
+
'updatedAt': string;
|
|
15028
|
+
}
|
|
15029
|
+
/**
|
|
15030
|
+
* Details of the last payment error if the payment failed. POS only
|
|
15031
|
+
* @export
|
|
15032
|
+
* @interface UnifiedOrderResponseDtoLastPaymentError
|
|
15033
|
+
*/
|
|
15034
|
+
export interface UnifiedOrderResponseDtoLastPaymentError {
|
|
15035
|
+
/**
|
|
15036
|
+
*
|
|
15037
|
+
* @type {PaymentFailureCode}
|
|
15038
|
+
* @memberof UnifiedOrderResponseDtoLastPaymentError
|
|
15039
|
+
*/
|
|
15040
|
+
'code': PaymentFailureCode;
|
|
15041
|
+
/**
|
|
15042
|
+
* Human-readable error message from the payment provider
|
|
15043
|
+
* @type {string}
|
|
15044
|
+
* @memberof UnifiedOrderResponseDtoLastPaymentError
|
|
15045
|
+
*/
|
|
15046
|
+
'providerMessage': string;
|
|
15047
|
+
/**
|
|
15048
|
+
* Timestamp when the payment error occurred
|
|
15049
|
+
* @type {string}
|
|
15050
|
+
* @memberof UnifiedOrderResponseDtoLastPaymentError
|
|
15051
|
+
*/
|
|
15052
|
+
'timestamp': string;
|
|
15053
|
+
/**
|
|
15054
|
+
* Whether the payment can be retried after this error
|
|
15055
|
+
* @type {boolean}
|
|
15056
|
+
* @memberof UnifiedOrderResponseDtoLastPaymentError
|
|
15057
|
+
*/
|
|
15058
|
+
'retryable': boolean;
|
|
15059
|
+
}
|
|
15060
|
+
/**
|
|
15061
|
+
* Preorder scheduling details. Platform only
|
|
15062
|
+
* @export
|
|
15063
|
+
* @interface UnifiedOrderResponseDtoPreorder
|
|
15064
|
+
*/
|
|
15065
|
+
export interface UnifiedOrderResponseDtoPreorder {
|
|
15066
|
+
/**
|
|
15067
|
+
* Unique identifier of the preorder
|
|
15068
|
+
* @type {string}
|
|
15069
|
+
* @memberof UnifiedOrderResponseDtoPreorder
|
|
15070
|
+
*/
|
|
15071
|
+
'id': string;
|
|
15072
|
+
/**
|
|
15073
|
+
*
|
|
15074
|
+
* @type {PreorderStatus}
|
|
15075
|
+
* @memberof UnifiedOrderResponseDtoPreorder
|
|
15076
|
+
*/
|
|
15077
|
+
'status': PreorderStatus;
|
|
15078
|
+
/**
|
|
15079
|
+
* Scheduled time for the preorder pickup or delivery
|
|
15080
|
+
* @type {string}
|
|
15081
|
+
* @memberof UnifiedOrderResponseDtoPreorder
|
|
15082
|
+
*/
|
|
15083
|
+
'preorderTime'?: string | null;
|
|
15084
|
+
}
|
|
15085
|
+
/**
|
|
15086
|
+
* Price summary of the order. Platform only
|
|
15087
|
+
* @export
|
|
15088
|
+
* @interface UnifiedOrderResponseDtoPriceSummary
|
|
15089
|
+
*/
|
|
15090
|
+
export interface UnifiedOrderResponseDtoPriceSummary {
|
|
15091
|
+
/**
|
|
15092
|
+
* Unique identifier of the price summary record
|
|
15093
|
+
* @type {string}
|
|
15094
|
+
* @memberof UnifiedOrderResponseDtoPriceSummary
|
|
15095
|
+
*/
|
|
15096
|
+
'id': string;
|
|
15097
|
+
/**
|
|
15098
|
+
* Total net amount of the order
|
|
15099
|
+
* @type {number}
|
|
15100
|
+
* @memberof UnifiedOrderResponseDtoPriceSummary
|
|
15101
|
+
*/
|
|
15102
|
+
'totalNet': number;
|
|
15103
|
+
}
|
|
15104
|
+
/**
|
|
15105
|
+
* Tax breakdown summary for the POS order. POS only
|
|
15106
|
+
* @export
|
|
15107
|
+
* @interface UnifiedOrderResponseDtoTaxSummary
|
|
15108
|
+
*/
|
|
15109
|
+
export interface UnifiedOrderResponseDtoTaxSummary {
|
|
15110
|
+
/**
|
|
15111
|
+
* Tax breakdown by rate
|
|
15112
|
+
* @type {Array<OrderTaxSummaryDto>}
|
|
15113
|
+
* @memberof UnifiedOrderResponseDtoTaxSummary
|
|
15114
|
+
*/
|
|
15115
|
+
'taxSummaries': Array<OrderTaxSummaryDto>;
|
|
15116
|
+
/**
|
|
15117
|
+
* Total without tax in cents
|
|
15118
|
+
* @type {number}
|
|
15119
|
+
* @memberof UnifiedOrderResponseDtoTaxSummary
|
|
15120
|
+
*/
|
|
15121
|
+
'totalWithoutTax': number;
|
|
15122
|
+
/**
|
|
15123
|
+
* Total tax amount in cents
|
|
15124
|
+
* @type {number}
|
|
15125
|
+
* @memberof UnifiedOrderResponseDtoTaxSummary
|
|
15126
|
+
*/
|
|
15127
|
+
'totalTax': number;
|
|
15128
|
+
/**
|
|
15129
|
+
* Grand total in cents
|
|
15130
|
+
* @type {number}
|
|
15131
|
+
* @memberof UnifiedOrderResponseDtoTaxSummary
|
|
15132
|
+
*/
|
|
15133
|
+
'grandTotal': number;
|
|
15134
|
+
}
|
|
15135
|
+
/**
|
|
15136
|
+
*
|
|
15137
|
+
* @export
|
|
15138
|
+
* @interface UnifiedPlatformDiscountDto
|
|
15139
|
+
*/
|
|
15140
|
+
export interface UnifiedPlatformDiscountDto {
|
|
15141
|
+
/**
|
|
15142
|
+
* Unique identifier of the discount
|
|
15143
|
+
* @type {string}
|
|
15144
|
+
* @memberof UnifiedPlatformDiscountDto
|
|
15145
|
+
*/
|
|
15146
|
+
'id': string;
|
|
15147
|
+
/**
|
|
15148
|
+
* Display name of the discount
|
|
15149
|
+
* @type {string}
|
|
15150
|
+
* @memberof UnifiedPlatformDiscountDto
|
|
15151
|
+
*/
|
|
15152
|
+
'discountName': string;
|
|
15153
|
+
/**
|
|
15154
|
+
* Discount amount applied to the order
|
|
15155
|
+
* @type {number}
|
|
15156
|
+
* @memberof UnifiedPlatformDiscountDto
|
|
15157
|
+
*/
|
|
15158
|
+
'discountAmount': number;
|
|
15159
|
+
/**
|
|
15160
|
+
* Timestamp when the discount was created
|
|
15161
|
+
* @type {string}
|
|
15162
|
+
* @memberof UnifiedPlatformDiscountDto
|
|
15163
|
+
*/
|
|
15164
|
+
'createdAt': string;
|
|
15165
|
+
}
|
|
15166
|
+
/**
|
|
15167
|
+
*
|
|
15168
|
+
* @export
|
|
15169
|
+
* @interface UnifiedPreorderDto
|
|
15170
|
+
*/
|
|
15171
|
+
export interface UnifiedPreorderDto {
|
|
15172
|
+
/**
|
|
15173
|
+
* Unique identifier of the preorder
|
|
15174
|
+
* @type {string}
|
|
15175
|
+
* @memberof UnifiedPreorderDto
|
|
15176
|
+
*/
|
|
15177
|
+
'id': string;
|
|
15178
|
+
/**
|
|
15179
|
+
*
|
|
15180
|
+
* @type {PreorderStatus}
|
|
15181
|
+
* @memberof UnifiedPreorderDto
|
|
15182
|
+
*/
|
|
15183
|
+
'status': PreorderStatus;
|
|
15184
|
+
/**
|
|
15185
|
+
* Scheduled time for the preorder pickup or delivery
|
|
15186
|
+
* @type {string}
|
|
15187
|
+
* @memberof UnifiedPreorderDto
|
|
15188
|
+
*/
|
|
15189
|
+
'preorderTime'?: string | null;
|
|
15190
|
+
}
|
|
15191
|
+
/**
|
|
15192
|
+
*
|
|
15193
|
+
* @export
|
|
15194
|
+
* @interface UnifiedPriceSummaryDto
|
|
15195
|
+
*/
|
|
15196
|
+
export interface UnifiedPriceSummaryDto {
|
|
15197
|
+
/**
|
|
15198
|
+
* Unique identifier of the price summary record
|
|
15199
|
+
* @type {string}
|
|
15200
|
+
* @memberof UnifiedPriceSummaryDto
|
|
15201
|
+
*/
|
|
15202
|
+
'id': string;
|
|
15203
|
+
/**
|
|
15204
|
+
* Total net amount of the order
|
|
15205
|
+
* @type {number}
|
|
15206
|
+
* @memberof UnifiedPriceSummaryDto
|
|
15207
|
+
*/
|
|
15208
|
+
'totalNet': number;
|
|
15209
|
+
}
|
|
15210
|
+
/**
|
|
15211
|
+
*
|
|
15212
|
+
* @export
|
|
15213
|
+
* @interface UnifiedProductDto
|
|
15214
|
+
*/
|
|
15215
|
+
export interface UnifiedProductDto {
|
|
15216
|
+
/**
|
|
15217
|
+
* Unique identifier of the product line item
|
|
15218
|
+
* @type {string}
|
|
15219
|
+
* @memberof UnifiedProductDto
|
|
15220
|
+
*/
|
|
15221
|
+
'id': string;
|
|
15222
|
+
/**
|
|
15223
|
+
* External identifier of the product from the ordering platform
|
|
15224
|
+
* @type {string}
|
|
15225
|
+
* @memberof UnifiedProductDto
|
|
15226
|
+
*/
|
|
15227
|
+
'externalId': string;
|
|
15228
|
+
/**
|
|
15229
|
+
* Display name of the product
|
|
15230
|
+
* @type {string}
|
|
15231
|
+
* @memberof UnifiedProductDto
|
|
15232
|
+
*/
|
|
15233
|
+
'name': string;
|
|
15234
|
+
/**
|
|
15235
|
+
* Quantity of this product ordered
|
|
15236
|
+
* @type {number}
|
|
15237
|
+
* @memberof UnifiedProductDto
|
|
15238
|
+
*/
|
|
15239
|
+
'quantity': number;
|
|
15240
|
+
/**
|
|
15241
|
+
* Unit price of the product
|
|
15242
|
+
* @type {number}
|
|
15243
|
+
* @memberof UnifiedProductDto
|
|
15244
|
+
*/
|
|
15245
|
+
'unitPrice': number;
|
|
15246
|
+
/**
|
|
15247
|
+
* Actual paid price of the product
|
|
15248
|
+
* @type {number}
|
|
15249
|
+
* @memberof UnifiedProductDto
|
|
15250
|
+
*/
|
|
15251
|
+
'paidPrice': number;
|
|
15252
|
+
/**
|
|
15253
|
+
* Special instruction or comment for this product
|
|
15254
|
+
* @type {string}
|
|
15255
|
+
* @memberof UnifiedProductDto
|
|
15256
|
+
*/
|
|
15257
|
+
'comment'?: string | null;
|
|
15258
|
+
/**
|
|
15259
|
+
* Current kitchen preparation status of the product
|
|
15260
|
+
* @type {string}
|
|
15261
|
+
* @memberof UnifiedProductDto
|
|
15262
|
+
*/
|
|
15263
|
+
'kitchenStatus'?: string | null;
|
|
15264
|
+
/**
|
|
15265
|
+
* List of options selected for this product
|
|
15266
|
+
* @type {Array<UnifiedOptionDto>}
|
|
15267
|
+
* @memberof UnifiedProductDto
|
|
15268
|
+
*/
|
|
15269
|
+
'options': Array<UnifiedOptionDto>;
|
|
15270
|
+
}
|
|
15271
|
+
/**
|
|
15272
|
+
*
|
|
15273
|
+
* @export
|
|
15274
|
+
* @interface UnifiedRefundDto
|
|
15275
|
+
*/
|
|
15276
|
+
export interface UnifiedRefundDto {
|
|
15277
|
+
/**
|
|
15278
|
+
* Unique internal identifier of the refund record
|
|
15279
|
+
* @type {string}
|
|
15280
|
+
* @memberof UnifiedRefundDto
|
|
15281
|
+
*/
|
|
15282
|
+
'id': string;
|
|
15283
|
+
/**
|
|
15284
|
+
* Refund transaction identifier
|
|
15285
|
+
* @type {string}
|
|
15286
|
+
* @memberof UnifiedRefundDto
|
|
15287
|
+
*/
|
|
15288
|
+
'refundId': string;
|
|
15289
|
+
/**
|
|
15290
|
+
*
|
|
15291
|
+
* @type {PaymentProvider}
|
|
15292
|
+
* @memberof UnifiedRefundDto
|
|
15293
|
+
*/
|
|
15294
|
+
'paymentProvider': PaymentProvider;
|
|
15295
|
+
/**
|
|
15296
|
+
* Amount refunded in the smallest currency unit
|
|
15297
|
+
* @type {number}
|
|
15298
|
+
* @memberof UnifiedRefundDto
|
|
15299
|
+
*/
|
|
15300
|
+
'amount': number;
|
|
15301
|
+
/**
|
|
15302
|
+
* ISO 4217 currency code of the refund, e.g. EUR
|
|
15303
|
+
* @type {string}
|
|
15304
|
+
* @memberof UnifiedRefundDto
|
|
15305
|
+
*/
|
|
15306
|
+
'currency': string;
|
|
15307
|
+
/**
|
|
15308
|
+
*
|
|
15309
|
+
* @type {RefundStatusEnum}
|
|
15310
|
+
* @memberof UnifiedRefundDto
|
|
15311
|
+
*/
|
|
15312
|
+
'status': RefundStatusEnum;
|
|
15313
|
+
/**
|
|
15314
|
+
* Timestamp when the refund was processed
|
|
15315
|
+
* @type {string}
|
|
15316
|
+
* @memberof UnifiedRefundDto
|
|
15317
|
+
*/
|
|
15318
|
+
'processedAt': string;
|
|
15319
|
+
/**
|
|
15320
|
+
* Reason provided for the refund
|
|
15321
|
+
* @type {string}
|
|
15322
|
+
* @memberof UnifiedRefundDto
|
|
15323
|
+
*/
|
|
15324
|
+
'reason'?: string | null;
|
|
15325
|
+
/**
|
|
15326
|
+
*
|
|
15327
|
+
* @type {PaymentMethod}
|
|
15328
|
+
* @memberof UnifiedRefundDto
|
|
15329
|
+
*/
|
|
15330
|
+
'type'?: PaymentMethod | null;
|
|
15331
|
+
/**
|
|
15332
|
+
* Specific line items that were refunded
|
|
15333
|
+
* @type {Array<UnifiedRefundedItemDto>}
|
|
15334
|
+
* @memberof UnifiedRefundDto
|
|
15335
|
+
*/
|
|
15336
|
+
'items'?: Array<UnifiedRefundedItemDto>;
|
|
15337
|
+
}
|
|
15338
|
+
/**
|
|
15339
|
+
*
|
|
15340
|
+
* @export
|
|
15341
|
+
* @interface UnifiedRefundedItemDto
|
|
15342
|
+
*/
|
|
15343
|
+
export interface UnifiedRefundedItemDto {
|
|
15344
|
+
/**
|
|
15345
|
+
* Reference to the unique line item from the original order
|
|
15346
|
+
* @type {string}
|
|
15347
|
+
* @memberof UnifiedRefundedItemDto
|
|
15348
|
+
*/
|
|
15349
|
+
'lineItemId': string;
|
|
15350
|
+
/**
|
|
15351
|
+
* Reference to the general product ID, e.g. SKU or posId
|
|
15352
|
+
* @type {string}
|
|
15353
|
+
* @memberof UnifiedRefundedItemDto
|
|
15354
|
+
*/
|
|
15355
|
+
'itemId': string;
|
|
15356
|
+
/**
|
|
15357
|
+
* Display name of the refunded product
|
|
15358
|
+
* @type {string}
|
|
15359
|
+
* @memberof UnifiedRefundedItemDto
|
|
15360
|
+
*/
|
|
15361
|
+
'name': string;
|
|
15362
|
+
/**
|
|
15363
|
+
* Unit price of the refunded item at time of refund
|
|
15364
|
+
* @type {number}
|
|
15365
|
+
* @memberof UnifiedRefundedItemDto
|
|
15366
|
+
*/
|
|
15367
|
+
'unitPrice': number;
|
|
15368
|
+
/**
|
|
15369
|
+
* Quantity refunded for this item
|
|
15370
|
+
* @type {number}
|
|
15371
|
+
* @memberof UnifiedRefundedItemDto
|
|
15372
|
+
*/
|
|
15373
|
+
'quantity': number;
|
|
15374
|
+
/**
|
|
15375
|
+
* Total amount refunded for this line item
|
|
15376
|
+
* @type {number}
|
|
15377
|
+
* @memberof UnifiedRefundedItemDto
|
|
15378
|
+
*/
|
|
15379
|
+
'amount': number;
|
|
15380
|
+
}
|
|
15381
|
+
/**
|
|
15382
|
+
*
|
|
15383
|
+
* @export
|
|
15384
|
+
* @interface UnifiedSubOptionDto
|
|
14961
15385
|
*/
|
|
14962
|
-
export interface
|
|
15386
|
+
export interface UnifiedSubOptionDto {
|
|
14963
15387
|
/**
|
|
14964
|
-
*
|
|
14965
|
-
* @type {
|
|
14966
|
-
* @memberof
|
|
15388
|
+
* Unique identifier of the sub-option
|
|
15389
|
+
* @type {string}
|
|
15390
|
+
* @memberof UnifiedSubOptionDto
|
|
14967
15391
|
*/
|
|
14968
|
-
'
|
|
15392
|
+
'id': string;
|
|
14969
15393
|
/**
|
|
14970
|
-
*
|
|
14971
|
-
* @type {
|
|
14972
|
-
* @memberof
|
|
15394
|
+
* External identifier of the sub-option from the ordering platform
|
|
15395
|
+
* @type {string}
|
|
15396
|
+
* @memberof UnifiedSubOptionDto
|
|
14973
15397
|
*/
|
|
14974
|
-
'
|
|
15398
|
+
'externalId': string;
|
|
15399
|
+
/**
|
|
15400
|
+
* Display name of the sub-option
|
|
15401
|
+
* @type {string}
|
|
15402
|
+
* @memberof UnifiedSubOptionDto
|
|
15403
|
+
*/
|
|
15404
|
+
'name': string;
|
|
15405
|
+
/**
|
|
15406
|
+
* Unit price of the sub-option
|
|
15407
|
+
* @type {number}
|
|
15408
|
+
* @memberof UnifiedSubOptionDto
|
|
15409
|
+
*/
|
|
15410
|
+
'unitPrice': number;
|
|
15411
|
+
/**
|
|
15412
|
+
* Actual paid price of the sub-option
|
|
15413
|
+
* @type {number}
|
|
15414
|
+
* @memberof UnifiedSubOptionDto
|
|
15415
|
+
*/
|
|
15416
|
+
'paidPrice': number;
|
|
15417
|
+
/**
|
|
15418
|
+
* Quantity of this sub-option selected
|
|
15419
|
+
* @type {number}
|
|
15420
|
+
* @memberof UnifiedSubOptionDto
|
|
15421
|
+
*/
|
|
15422
|
+
'quantity': number;
|
|
14975
15423
|
}
|
|
14976
15424
|
/**
|
|
14977
15425
|
*
|
|
@@ -18490,22 +18938,6 @@ export declare const EmployeesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
18490
18938
|
* @throws {RequiredError}
|
|
18491
18939
|
*/
|
|
18492
18940
|
createAssignment: (businessId: number, createEmployeeAssignmentDto: CreateEmployeeAssignmentDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
18493
|
-
/**
|
|
18494
|
-
*
|
|
18495
|
-
* @param {CreateEmployeeDto} createEmployeeDto
|
|
18496
|
-
* @param {*} [options] Override http request option.
|
|
18497
|
-
* @throws {RequiredError}
|
|
18498
|
-
*/
|
|
18499
|
-
createEmployee: (createEmployeeDto: CreateEmployeeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
18500
|
-
/**
|
|
18501
|
-
*
|
|
18502
|
-
* @param {string} merchantId
|
|
18503
|
-
* @param {number} [limit]
|
|
18504
|
-
* @param {number} [page]
|
|
18505
|
-
* @param {*} [options] Override http request option.
|
|
18506
|
-
* @throws {RequiredError}
|
|
18507
|
-
*/
|
|
18508
|
-
getEmployees: (merchantId: string, limit?: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
18509
18941
|
};
|
|
18510
18942
|
/**
|
|
18511
18943
|
* EmployeesApi - functional programming interface
|
|
@@ -18520,22 +18952,6 @@ export declare const EmployeesApiFp: (configuration?: Configuration) => {
|
|
|
18520
18952
|
* @throws {RequiredError}
|
|
18521
18953
|
*/
|
|
18522
18954
|
createAssignment(businessId: number, createEmployeeAssignmentDto: CreateEmployeeAssignmentDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeAssignmentResponseDto>>;
|
|
18523
|
-
/**
|
|
18524
|
-
*
|
|
18525
|
-
* @param {CreateEmployeeDto} createEmployeeDto
|
|
18526
|
-
* @param {*} [options] Override http request option.
|
|
18527
|
-
* @throws {RequiredError}
|
|
18528
|
-
*/
|
|
18529
|
-
createEmployee(createEmployeeDto: CreateEmployeeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>>;
|
|
18530
|
-
/**
|
|
18531
|
-
*
|
|
18532
|
-
* @param {string} merchantId
|
|
18533
|
-
* @param {number} [limit]
|
|
18534
|
-
* @param {number} [page]
|
|
18535
|
-
* @param {*} [options] Override http request option.
|
|
18536
|
-
* @throws {RequiredError}
|
|
18537
|
-
*/
|
|
18538
|
-
getEmployees(merchantId: string, limit?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedEmployeesResponseDto>>;
|
|
18539
18955
|
};
|
|
18540
18956
|
/**
|
|
18541
18957
|
* EmployeesApi - factory interface
|
|
@@ -18550,22 +18966,6 @@ export declare const EmployeesApiFactory: (configuration?: Configuration, basePa
|
|
|
18550
18966
|
* @throws {RequiredError}
|
|
18551
18967
|
*/
|
|
18552
18968
|
createAssignment(businessId: number, createEmployeeAssignmentDto: CreateEmployeeAssignmentDto, options?: any): AxiosPromise<EmployeeAssignmentResponseDto>;
|
|
18553
|
-
/**
|
|
18554
|
-
*
|
|
18555
|
-
* @param {CreateEmployeeDto} createEmployeeDto
|
|
18556
|
-
* @param {*} [options] Override http request option.
|
|
18557
|
-
* @throws {RequiredError}
|
|
18558
|
-
*/
|
|
18559
|
-
createEmployee(createEmployeeDto: CreateEmployeeDto, options?: any): AxiosPromise<EmployeeResponseDto>;
|
|
18560
|
-
/**
|
|
18561
|
-
*
|
|
18562
|
-
* @param {string} merchantId
|
|
18563
|
-
* @param {number} [limit]
|
|
18564
|
-
* @param {number} [page]
|
|
18565
|
-
* @param {*} [options] Override http request option.
|
|
18566
|
-
* @throws {RequiredError}
|
|
18567
|
-
*/
|
|
18568
|
-
getEmployees(merchantId: string, limit?: number, page?: number, options?: any): AxiosPromise<PaginatedEmployeesResponseDto>;
|
|
18569
18969
|
};
|
|
18570
18970
|
/**
|
|
18571
18971
|
* EmployeesApi - interface
|
|
@@ -18582,24 +18982,6 @@ export interface EmployeesApiInterface {
|
|
|
18582
18982
|
* @memberof EmployeesApiInterface
|
|
18583
18983
|
*/
|
|
18584
18984
|
createAssignment(businessId: number, createEmployeeAssignmentDto: CreateEmployeeAssignmentDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeAssignmentResponseDto>;
|
|
18585
|
-
/**
|
|
18586
|
-
*
|
|
18587
|
-
* @param {CreateEmployeeDto} createEmployeeDto
|
|
18588
|
-
* @param {*} [options] Override http request option.
|
|
18589
|
-
* @throws {RequiredError}
|
|
18590
|
-
* @memberof EmployeesApiInterface
|
|
18591
|
-
*/
|
|
18592
|
-
createEmployee(createEmployeeDto: CreateEmployeeDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
18593
|
-
/**
|
|
18594
|
-
*
|
|
18595
|
-
* @param {string} merchantId
|
|
18596
|
-
* @param {number} [limit]
|
|
18597
|
-
* @param {number} [page]
|
|
18598
|
-
* @param {*} [options] Override http request option.
|
|
18599
|
-
* @throws {RequiredError}
|
|
18600
|
-
* @memberof EmployeesApiInterface
|
|
18601
|
-
*/
|
|
18602
|
-
getEmployees(merchantId: string, limit?: number, page?: number, options?: AxiosRequestConfig): AxiosPromise<PaginatedEmployeesResponseDto>;
|
|
18603
18985
|
}
|
|
18604
18986
|
/**
|
|
18605
18987
|
* EmployeesApi - object-oriented interface
|
|
@@ -18617,24 +18999,6 @@ export declare class EmployeesApi extends BaseAPI implements EmployeesApiInterfa
|
|
|
18617
18999
|
* @memberof EmployeesApi
|
|
18618
19000
|
*/
|
|
18619
19001
|
createAssignment(businessId: number, createEmployeeAssignmentDto: CreateEmployeeAssignmentDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeAssignmentResponseDto, any, {}>>;
|
|
18620
|
-
/**
|
|
18621
|
-
*
|
|
18622
|
-
* @param {CreateEmployeeDto} createEmployeeDto
|
|
18623
|
-
* @param {*} [options] Override http request option.
|
|
18624
|
-
* @throws {RequiredError}
|
|
18625
|
-
* @memberof EmployeesApi
|
|
18626
|
-
*/
|
|
18627
|
-
createEmployee(createEmployeeDto: CreateEmployeeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeResponseDto, any, {}>>;
|
|
18628
|
-
/**
|
|
18629
|
-
*
|
|
18630
|
-
* @param {string} merchantId
|
|
18631
|
-
* @param {number} [limit]
|
|
18632
|
-
* @param {number} [page]
|
|
18633
|
-
* @param {*} [options] Override http request option.
|
|
18634
|
-
* @throws {RequiredError}
|
|
18635
|
-
* @memberof EmployeesApi
|
|
18636
|
-
*/
|
|
18637
|
-
getEmployees(merchantId: string, limit?: number, page?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedEmployeesResponseDto, any, {}>>;
|
|
18638
19002
|
}
|
|
18639
19003
|
/**
|
|
18640
19004
|
* GiftcardApi - axios parameter creator
|
|
@@ -20879,16 +21243,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
20879
21243
|
* @throws {RequiredError}
|
|
20880
21244
|
*/
|
|
20881
21245
|
getAllOrdersV2: (businessIds: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20882
|
-
/**
|
|
20883
|
-
* Returns paginated orders sorted by status-specific logic. Database and POS orders are combined and sorted before pagination is applied.
|
|
20884
|
-
* @summary Get all orders across all statuses with pagination
|
|
20885
|
-
* @param {string} businessIds Comma-separated list of business IDs
|
|
20886
|
-
* @param {number} [limit] Number of items per page (max 100)
|
|
20887
|
-
* @param {number} [page] Page number (starts from 1)
|
|
20888
|
-
* @param {*} [options] Override http request option.
|
|
20889
|
-
* @throws {RequiredError}
|
|
20890
|
-
*/
|
|
20891
|
-
getAllOrdersV3: (businessIds: string, limit?: number, page?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20892
21246
|
/**
|
|
20893
21247
|
*
|
|
20894
21248
|
* @summary Get orders by status
|
|
@@ -20900,19 +21254,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
20900
21254
|
* @throws {RequiredError}
|
|
20901
21255
|
*/
|
|
20902
21256
|
getOrdersV2: (status: "pending" | "in_progress" | "ready" | "delivered" | "rejected" | "pick_up_by_driver" | "preorder" | "accept_by_driver" | "parked" | "refunded" | "draft", businessIds: string, posBusinessId?: string, extraProvider?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20903
|
-
/**
|
|
20904
|
-
* Returns paginated orders filtered by status and sorted by status-specific logic. Database and POS orders are combined and sorted before pagination is applied.
|
|
20905
|
-
* @summary Get orders by status with pagination
|
|
20906
|
-
* @param {'pending' | 'in_progress' | 'ready' | 'delivered' | 'rejected' | 'pick_up_by_driver' | 'preorder' | 'accept_by_driver' | 'parked' | 'refunded' | 'draft'} status Order status filter
|
|
20907
|
-
* @param {string} businessIds Comma-separated list of business IDs
|
|
20908
|
-
* @param {number} [limit] Number of items per page (max 100)
|
|
20909
|
-
* @param {number} [page] Page number (starts from 1)
|
|
20910
|
-
* @param {string} [posBusinessId] Id of the pos
|
|
20911
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [extraProvider] Extra attributes to get POS orders
|
|
20912
|
-
* @param {*} [options] Override http request option.
|
|
20913
|
-
* @throws {RequiredError}
|
|
20914
|
-
*/
|
|
20915
|
-
getOrdersV3: (status: "pending" | "in_progress" | "ready" | "delivered" | "rejected" | "pick_up_by_driver" | "preorder" | "accept_by_driver" | "parked" | "refunded" | "draft", businessIds: string, limit?: number, page?: number, posBusinessId?: string, extraProvider?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20916
21257
|
/**
|
|
20917
21258
|
*
|
|
20918
21259
|
* @summary Get all Pos park order
|
|
@@ -20929,22 +21270,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
20929
21270
|
* @throws {RequiredError}
|
|
20930
21271
|
*/
|
|
20931
21272
|
markOrderAsReady: (readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20932
|
-
/**
|
|
20933
|
-
*
|
|
20934
|
-
* @summary Place an POS order
|
|
20935
|
-
* @param {PosOrderPayloadDto} posOrderPayloadDto
|
|
20936
|
-
* @param {*} [options] Override http request option.
|
|
20937
|
-
* @throws {RequiredError}
|
|
20938
|
-
*/
|
|
20939
|
-
placePosOrderV2: (posOrderPayloadDto: PosOrderPayloadDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20940
|
-
/**
|
|
20941
|
-
*
|
|
20942
|
-
* @summary Place an POS order
|
|
20943
|
-
* @param {PosOrderPayloadDto} posOrderPayloadDto
|
|
20944
|
-
* @param {*} [options] Override http request option.
|
|
20945
|
-
* @throws {RequiredError}
|
|
20946
|
-
*/
|
|
20947
|
-
placePosOrderV3: (posOrderPayloadDto: PosOrderPayloadDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20948
21273
|
/**
|
|
20949
21274
|
*
|
|
20950
21275
|
* @summary Place an POS order
|
|
@@ -20969,14 +21294,6 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
20969
21294
|
* @throws {RequiredError}
|
|
20970
21295
|
*/
|
|
20971
21296
|
rejectOrder: (rejectOrderDto: RejectOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20972
|
-
/**
|
|
20973
|
-
*
|
|
20974
|
-
* @summary Send a POS order ticket
|
|
20975
|
-
* @param {SendPosOrderTicketDto} sendPosOrderTicketDto
|
|
20976
|
-
* @param {*} [options] Override http request option.
|
|
20977
|
-
* @throws {RequiredError}
|
|
20978
|
-
*/
|
|
20979
|
-
sendPosOrderTicketV2: (sendPosOrderTicketDto: SendPosOrderTicketDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
20980
21297
|
/**
|
|
20981
21298
|
*
|
|
20982
21299
|
* @summary Update a POS order status
|
|
@@ -21030,17 +21347,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
21030
21347
|
* @param {*} [options] Override http request option.
|
|
21031
21348
|
* @throws {RequiredError}
|
|
21032
21349
|
*/
|
|
21033
|
-
getAllOrdersV2(businessIds: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
21034
|
-
/**
|
|
21035
|
-
* Returns paginated orders sorted by status-specific logic. Database and POS orders are combined and sorted before pagination is applied.
|
|
21036
|
-
* @summary Get all orders across all statuses with pagination
|
|
21037
|
-
* @param {string} businessIds Comma-separated list of business IDs
|
|
21038
|
-
* @param {number} [limit] Number of items per page (max 100)
|
|
21039
|
-
* @param {number} [page] Page number (starts from 1)
|
|
21040
|
-
* @param {*} [options] Override http request option.
|
|
21041
|
-
* @throws {RequiredError}
|
|
21042
|
-
*/
|
|
21043
|
-
getAllOrdersV3(businessIds: string, limit?: number, page?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedOrderResponseDto>>;
|
|
21350
|
+
getAllOrdersV2(businessIds: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UnifiedOrderResponseDto>>>;
|
|
21044
21351
|
/**
|
|
21045
21352
|
*
|
|
21046
21353
|
* @summary Get orders by status
|
|
@@ -21051,20 +21358,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
21051
21358
|
* @param {*} [options] Override http request option.
|
|
21052
21359
|
* @throws {RequiredError}
|
|
21053
21360
|
*/
|
|
21054
|
-
getOrdersV2(status: "pending" | "in_progress" | "ready" | "delivered" | "rejected" | "pick_up_by_driver" | "preorder" | "accept_by_driver" | "parked" | "refunded" | "draft", businessIds: string, posBusinessId?: string, extraProvider?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<
|
|
21055
|
-
/**
|
|
21056
|
-
* Returns paginated orders filtered by status and sorted by status-specific logic. Database and POS orders are combined and sorted before pagination is applied.
|
|
21057
|
-
* @summary Get orders by status with pagination
|
|
21058
|
-
* @param {'pending' | 'in_progress' | 'ready' | 'delivered' | 'rejected' | 'pick_up_by_driver' | 'preorder' | 'accept_by_driver' | 'parked' | 'refunded' | 'draft'} status Order status filter
|
|
21059
|
-
* @param {string} businessIds Comma-separated list of business IDs
|
|
21060
|
-
* @param {number} [limit] Number of items per page (max 100)
|
|
21061
|
-
* @param {number} [page] Page number (starts from 1)
|
|
21062
|
-
* @param {string} [posBusinessId] Id of the pos
|
|
21063
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [extraProvider] Extra attributes to get POS orders
|
|
21064
|
-
* @param {*} [options] Override http request option.
|
|
21065
|
-
* @throws {RequiredError}
|
|
21066
|
-
*/
|
|
21067
|
-
getOrdersV3(status: "pending" | "in_progress" | "ready" | "delivered" | "rejected" | "pick_up_by_driver" | "preorder" | "accept_by_driver" | "parked" | "refunded" | "draft", businessIds: string, limit?: number, page?: number, posBusinessId?: string, extraProvider?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedOrderResponseDto>>;
|
|
21361
|
+
getOrdersV2(status: "pending" | "in_progress" | "ready" | "delivered" | "rejected" | "pick_up_by_driver" | "preorder" | "accept_by_driver" | "parked" | "refunded" | "draft", businessIds: string, posBusinessId?: string, extraProvider?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UnifiedOrderResponseDto>>>;
|
|
21068
21362
|
/**
|
|
21069
21363
|
*
|
|
21070
21364
|
* @summary Get all Pos park order
|
|
@@ -21081,22 +21375,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
21081
21375
|
* @throws {RequiredError}
|
|
21082
21376
|
*/
|
|
21083
21377
|
markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderStatusResponseDto>>;
|
|
21084
|
-
/**
|
|
21085
|
-
*
|
|
21086
|
-
* @summary Place an POS order
|
|
21087
|
-
* @param {PosOrderPayloadDto} posOrderPayloadDto
|
|
21088
|
-
* @param {*} [options] Override http request option.
|
|
21089
|
-
* @throws {RequiredError}
|
|
21090
|
-
*/
|
|
21091
|
-
placePosOrderV2(posOrderPayloadDto: PosOrderPayloadDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosOrderDto>>;
|
|
21092
|
-
/**
|
|
21093
|
-
*
|
|
21094
|
-
* @summary Place an POS order
|
|
21095
|
-
* @param {PosOrderPayloadDto} posOrderPayloadDto
|
|
21096
|
-
* @param {*} [options] Override http request option.
|
|
21097
|
-
* @throws {RequiredError}
|
|
21098
|
-
*/
|
|
21099
|
-
placePosOrderV3(posOrderPayloadDto: PosOrderPayloadDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosOrderDto>>;
|
|
21100
21378
|
/**
|
|
21101
21379
|
*
|
|
21102
21380
|
* @summary Place an POS order
|
|
@@ -21121,14 +21399,6 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
21121
21399
|
* @throws {RequiredError}
|
|
21122
21400
|
*/
|
|
21123
21401
|
rejectOrder(rejectOrderDto: RejectOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderStatusResponseDto>>;
|
|
21124
|
-
/**
|
|
21125
|
-
*
|
|
21126
|
-
* @summary Send a POS order ticket
|
|
21127
|
-
* @param {SendPosOrderTicketDto} sendPosOrderTicketDto
|
|
21128
|
-
* @param {*} [options] Override http request option.
|
|
21129
|
-
* @throws {RequiredError}
|
|
21130
|
-
*/
|
|
21131
|
-
sendPosOrderTicketV2(sendPosOrderTicketDto: SendPosOrderTicketDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosOrderDto>>;
|
|
21132
21402
|
/**
|
|
21133
21403
|
*
|
|
21134
21404
|
* @summary Update a POS order status
|
|
@@ -21182,17 +21452,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
21182
21452
|
* @param {*} [options] Override http request option.
|
|
21183
21453
|
* @throws {RequiredError}
|
|
21184
21454
|
*/
|
|
21185
|
-
getAllOrdersV2(businessIds: string, options?: any): AxiosPromise<Array<
|
|
21186
|
-
/**
|
|
21187
|
-
* Returns paginated orders sorted by status-specific logic. Database and POS orders are combined and sorted before pagination is applied.
|
|
21188
|
-
* @summary Get all orders across all statuses with pagination
|
|
21189
|
-
* @param {string} businessIds Comma-separated list of business IDs
|
|
21190
|
-
* @param {number} [limit] Number of items per page (max 100)
|
|
21191
|
-
* @param {number} [page] Page number (starts from 1)
|
|
21192
|
-
* @param {*} [options] Override http request option.
|
|
21193
|
-
* @throws {RequiredError}
|
|
21194
|
-
*/
|
|
21195
|
-
getAllOrdersV3(businessIds: string, limit?: number, page?: number, options?: any): AxiosPromise<PaginatedOrderResponseDto>;
|
|
21455
|
+
getAllOrdersV2(businessIds: string, options?: any): AxiosPromise<Array<UnifiedOrderResponseDto>>;
|
|
21196
21456
|
/**
|
|
21197
21457
|
*
|
|
21198
21458
|
* @summary Get orders by status
|
|
@@ -21203,20 +21463,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
21203
21463
|
* @param {*} [options] Override http request option.
|
|
21204
21464
|
* @throws {RequiredError}
|
|
21205
21465
|
*/
|
|
21206
|
-
getOrdersV2(status: "pending" | "in_progress" | "ready" | "delivered" | "rejected" | "pick_up_by_driver" | "preorder" | "accept_by_driver" | "parked" | "refunded" | "draft", businessIds: string, posBusinessId?: string, extraProvider?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront", options?: any): AxiosPromise<Array<
|
|
21207
|
-
/**
|
|
21208
|
-
* Returns paginated orders filtered by status and sorted by status-specific logic. Database and POS orders are combined and sorted before pagination is applied.
|
|
21209
|
-
* @summary Get orders by status with pagination
|
|
21210
|
-
* @param {'pending' | 'in_progress' | 'ready' | 'delivered' | 'rejected' | 'pick_up_by_driver' | 'preorder' | 'accept_by_driver' | 'parked' | 'refunded' | 'draft'} status Order status filter
|
|
21211
|
-
* @param {string} businessIds Comma-separated list of business IDs
|
|
21212
|
-
* @param {number} [limit] Number of items per page (max 100)
|
|
21213
|
-
* @param {number} [page] Page number (starts from 1)
|
|
21214
|
-
* @param {string} [posBusinessId] Id of the pos
|
|
21215
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [extraProvider] Extra attributes to get POS orders
|
|
21216
|
-
* @param {*} [options] Override http request option.
|
|
21217
|
-
* @throws {RequiredError}
|
|
21218
|
-
*/
|
|
21219
|
-
getOrdersV3(status: "pending" | "in_progress" | "ready" | "delivered" | "rejected" | "pick_up_by_driver" | "preorder" | "accept_by_driver" | "parked" | "refunded" | "draft", businessIds: string, limit?: number, page?: number, posBusinessId?: string, extraProvider?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront", options?: any): AxiosPromise<PaginatedOrderResponseDto>;
|
|
21466
|
+
getOrdersV2(status: "pending" | "in_progress" | "ready" | "delivered" | "rejected" | "pick_up_by_driver" | "preorder" | "accept_by_driver" | "parked" | "refunded" | "draft", businessIds: string, posBusinessId?: string, extraProvider?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront", options?: any): AxiosPromise<Array<UnifiedOrderResponseDto>>;
|
|
21220
21467
|
/**
|
|
21221
21468
|
*
|
|
21222
21469
|
* @summary Get all Pos park order
|
|
@@ -21233,22 +21480,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
21233
21480
|
* @throws {RequiredError}
|
|
21234
21481
|
*/
|
|
21235
21482
|
markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: any): AxiosPromise<OrderStatusResponseDto>;
|
|
21236
|
-
/**
|
|
21237
|
-
*
|
|
21238
|
-
* @summary Place an POS order
|
|
21239
|
-
* @param {PosOrderPayloadDto} posOrderPayloadDto
|
|
21240
|
-
* @param {*} [options] Override http request option.
|
|
21241
|
-
* @throws {RequiredError}
|
|
21242
|
-
*/
|
|
21243
|
-
placePosOrderV2(posOrderPayloadDto: PosOrderPayloadDto, options?: any): AxiosPromise<PosOrderDto>;
|
|
21244
|
-
/**
|
|
21245
|
-
*
|
|
21246
|
-
* @summary Place an POS order
|
|
21247
|
-
* @param {PosOrderPayloadDto} posOrderPayloadDto
|
|
21248
|
-
* @param {*} [options] Override http request option.
|
|
21249
|
-
* @throws {RequiredError}
|
|
21250
|
-
*/
|
|
21251
|
-
placePosOrderV3(posOrderPayloadDto: PosOrderPayloadDto, options?: any): AxiosPromise<PosOrderDto>;
|
|
21252
21483
|
/**
|
|
21253
21484
|
*
|
|
21254
21485
|
* @summary Place an POS order
|
|
@@ -21273,14 +21504,6 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
21273
21504
|
* @throws {RequiredError}
|
|
21274
21505
|
*/
|
|
21275
21506
|
rejectOrder(rejectOrderDto: RejectOrderDto, options?: any): AxiosPromise<OrderStatusResponseDto>;
|
|
21276
|
-
/**
|
|
21277
|
-
*
|
|
21278
|
-
* @summary Send a POS order ticket
|
|
21279
|
-
* @param {SendPosOrderTicketDto} sendPosOrderTicketDto
|
|
21280
|
-
* @param {*} [options] Override http request option.
|
|
21281
|
-
* @throws {RequiredError}
|
|
21282
|
-
*/
|
|
21283
|
-
sendPosOrderTicketV2(sendPosOrderTicketDto: SendPosOrderTicketDto, options?: any): AxiosPromise<PosOrderDto>;
|
|
21284
21507
|
/**
|
|
21285
21508
|
*
|
|
21286
21509
|
* @summary Update a POS order status
|
|
@@ -21340,18 +21563,7 @@ export interface OrdersApiInterface {
|
|
|
21340
21563
|
* @throws {RequiredError}
|
|
21341
21564
|
* @memberof OrdersApiInterface
|
|
21342
21565
|
*/
|
|
21343
|
-
getAllOrdersV2(businessIds: string, options?: AxiosRequestConfig): AxiosPromise<Array<
|
|
21344
|
-
/**
|
|
21345
|
-
* Returns paginated orders sorted by status-specific logic. Database and POS orders are combined and sorted before pagination is applied.
|
|
21346
|
-
* @summary Get all orders across all statuses with pagination
|
|
21347
|
-
* @param {string} businessIds Comma-separated list of business IDs
|
|
21348
|
-
* @param {number} [limit] Number of items per page (max 100)
|
|
21349
|
-
* @param {number} [page] Page number (starts from 1)
|
|
21350
|
-
* @param {*} [options] Override http request option.
|
|
21351
|
-
* @throws {RequiredError}
|
|
21352
|
-
* @memberof OrdersApiInterface
|
|
21353
|
-
*/
|
|
21354
|
-
getAllOrdersV3(businessIds: string, limit?: number, page?: number, options?: AxiosRequestConfig): AxiosPromise<PaginatedOrderResponseDto>;
|
|
21566
|
+
getAllOrdersV2(businessIds: string, options?: AxiosRequestConfig): AxiosPromise<Array<UnifiedOrderResponseDto>>;
|
|
21355
21567
|
/**
|
|
21356
21568
|
*
|
|
21357
21569
|
* @summary Get orders by status
|
|
@@ -21363,21 +21575,7 @@ export interface OrdersApiInterface {
|
|
|
21363
21575
|
* @throws {RequiredError}
|
|
21364
21576
|
* @memberof OrdersApiInterface
|
|
21365
21577
|
*/
|
|
21366
|
-
getOrdersV2(status: 'pending' | 'in_progress' | 'ready' | 'delivered' | 'rejected' | 'pick_up_by_driver' | 'preorder' | 'accept_by_driver' | 'parked' | 'refunded' | 'draft', businessIds: string, posBusinessId?: string, extraProvider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront', options?: AxiosRequestConfig): AxiosPromise<Array<
|
|
21367
|
-
/**
|
|
21368
|
-
* Returns paginated orders filtered by status and sorted by status-specific logic. Database and POS orders are combined and sorted before pagination is applied.
|
|
21369
|
-
* @summary Get orders by status with pagination
|
|
21370
|
-
* @param {'pending' | 'in_progress' | 'ready' | 'delivered' | 'rejected' | 'pick_up_by_driver' | 'preorder' | 'accept_by_driver' | 'parked' | 'refunded' | 'draft'} status Order status filter
|
|
21371
|
-
* @param {string} businessIds Comma-separated list of business IDs
|
|
21372
|
-
* @param {number} [limit] Number of items per page (max 100)
|
|
21373
|
-
* @param {number} [page] Page number (starts from 1)
|
|
21374
|
-
* @param {string} [posBusinessId] Id of the pos
|
|
21375
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [extraProvider] Extra attributes to get POS orders
|
|
21376
|
-
* @param {*} [options] Override http request option.
|
|
21377
|
-
* @throws {RequiredError}
|
|
21378
|
-
* @memberof OrdersApiInterface
|
|
21379
|
-
*/
|
|
21380
|
-
getOrdersV3(status: 'pending' | 'in_progress' | 'ready' | 'delivered' | 'rejected' | 'pick_up_by_driver' | 'preorder' | 'accept_by_driver' | 'parked' | 'refunded' | 'draft', businessIds: string, limit?: number, page?: number, posBusinessId?: string, extraProvider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront', options?: AxiosRequestConfig): AxiosPromise<PaginatedOrderResponseDto>;
|
|
21578
|
+
getOrdersV2(status: 'pending' | 'in_progress' | 'ready' | 'delivered' | 'rejected' | 'pick_up_by_driver' | 'preorder' | 'accept_by_driver' | 'parked' | 'refunded' | 'draft', businessIds: string, posBusinessId?: string, extraProvider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront', options?: AxiosRequestConfig): AxiosPromise<Array<UnifiedOrderResponseDto>>;
|
|
21381
21579
|
/**
|
|
21382
21580
|
*
|
|
21383
21581
|
* @summary Get all Pos park order
|
|
@@ -21396,24 +21594,6 @@ export interface OrdersApiInterface {
|
|
|
21396
21594
|
* @memberof OrdersApiInterface
|
|
21397
21595
|
*/
|
|
21398
21596
|
markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig): AxiosPromise<OrderStatusResponseDto>;
|
|
21399
|
-
/**
|
|
21400
|
-
*
|
|
21401
|
-
* @summary Place an POS order
|
|
21402
|
-
* @param {PosOrderPayloadDto} posOrderPayloadDto
|
|
21403
|
-
* @param {*} [options] Override http request option.
|
|
21404
|
-
* @throws {RequiredError}
|
|
21405
|
-
* @memberof OrdersApiInterface
|
|
21406
|
-
*/
|
|
21407
|
-
placePosOrderV2(posOrderPayloadDto: PosOrderPayloadDto, options?: AxiosRequestConfig): AxiosPromise<PosOrderDto>;
|
|
21408
|
-
/**
|
|
21409
|
-
*
|
|
21410
|
-
* @summary Place an POS order
|
|
21411
|
-
* @param {PosOrderPayloadDto} posOrderPayloadDto
|
|
21412
|
-
* @param {*} [options] Override http request option.
|
|
21413
|
-
* @throws {RequiredError}
|
|
21414
|
-
* @memberof OrdersApiInterface
|
|
21415
|
-
*/
|
|
21416
|
-
placePosOrderV3(posOrderPayloadDto: PosOrderPayloadDto, options?: AxiosRequestConfig): AxiosPromise<PosOrderDto>;
|
|
21417
21597
|
/**
|
|
21418
21598
|
*
|
|
21419
21599
|
* @summary Place an POS order
|
|
@@ -21440,16 +21620,7 @@ export interface OrdersApiInterface {
|
|
|
21440
21620
|
* @throws {RequiredError}
|
|
21441
21621
|
* @memberof OrdersApiInterface
|
|
21442
21622
|
*/
|
|
21443
|
-
rejectOrder(rejectOrderDto: RejectOrderDto, options?: AxiosRequestConfig): AxiosPromise<OrderStatusResponseDto>;
|
|
21444
|
-
/**
|
|
21445
|
-
*
|
|
21446
|
-
* @summary Send a POS order ticket
|
|
21447
|
-
* @param {SendPosOrderTicketDto} sendPosOrderTicketDto
|
|
21448
|
-
* @param {*} [options] Override http request option.
|
|
21449
|
-
* @throws {RequiredError}
|
|
21450
|
-
* @memberof OrdersApiInterface
|
|
21451
|
-
*/
|
|
21452
|
-
sendPosOrderTicketV2(sendPosOrderTicketDto: SendPosOrderTicketDto, options?: AxiosRequestConfig): AxiosPromise<PosOrderDto>;
|
|
21623
|
+
rejectOrder(rejectOrderDto: RejectOrderDto, options?: AxiosRequestConfig): AxiosPromise<OrderStatusResponseDto>;
|
|
21453
21624
|
/**
|
|
21454
21625
|
*
|
|
21455
21626
|
* @summary Update a POS order status
|
|
@@ -21511,18 +21682,7 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
21511
21682
|
* @throws {RequiredError}
|
|
21512
21683
|
* @memberof OrdersApi
|
|
21513
21684
|
*/
|
|
21514
|
-
getAllOrdersV2(businessIds: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
21515
|
-
/**
|
|
21516
|
-
* Returns paginated orders sorted by status-specific logic. Database and POS orders are combined and sorted before pagination is applied.
|
|
21517
|
-
* @summary Get all orders across all statuses with pagination
|
|
21518
|
-
* @param {string} businessIds Comma-separated list of business IDs
|
|
21519
|
-
* @param {number} [limit] Number of items per page (max 100)
|
|
21520
|
-
* @param {number} [page] Page number (starts from 1)
|
|
21521
|
-
* @param {*} [options] Override http request option.
|
|
21522
|
-
* @throws {RequiredError}
|
|
21523
|
-
* @memberof OrdersApi
|
|
21524
|
-
*/
|
|
21525
|
-
getAllOrdersV3(businessIds: string, limit?: number, page?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedOrderResponseDto, any, {}>>;
|
|
21685
|
+
getAllOrdersV2(businessIds: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnifiedOrderResponseDto[], any, {}>>;
|
|
21526
21686
|
/**
|
|
21527
21687
|
*
|
|
21528
21688
|
* @summary Get orders by status
|
|
@@ -21534,21 +21694,7 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
21534
21694
|
* @throws {RequiredError}
|
|
21535
21695
|
* @memberof OrdersApi
|
|
21536
21696
|
*/
|
|
21537
|
-
getOrdersV2(status: 'pending' | 'in_progress' | 'ready' | 'delivered' | 'rejected' | 'pick_up_by_driver' | 'preorder' | 'accept_by_driver' | 'parked' | 'refunded' | 'draft', businessIds: string, posBusinessId?: string, extraProvider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
21538
|
-
/**
|
|
21539
|
-
* Returns paginated orders filtered by status and sorted by status-specific logic. Database and POS orders are combined and sorted before pagination is applied.
|
|
21540
|
-
* @summary Get orders by status with pagination
|
|
21541
|
-
* @param {'pending' | 'in_progress' | 'ready' | 'delivered' | 'rejected' | 'pick_up_by_driver' | 'preorder' | 'accept_by_driver' | 'parked' | 'refunded' | 'draft'} status Order status filter
|
|
21542
|
-
* @param {string} businessIds Comma-separated list of business IDs
|
|
21543
|
-
* @param {number} [limit] Number of items per page (max 100)
|
|
21544
|
-
* @param {number} [page] Page number (starts from 1)
|
|
21545
|
-
* @param {string} [posBusinessId] Id of the pos
|
|
21546
|
-
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [extraProvider] Extra attributes to get POS orders
|
|
21547
|
-
* @param {*} [options] Override http request option.
|
|
21548
|
-
* @throws {RequiredError}
|
|
21549
|
-
* @memberof OrdersApi
|
|
21550
|
-
*/
|
|
21551
|
-
getOrdersV3(status: 'pending' | 'in_progress' | 'ready' | 'delivered' | 'rejected' | 'pick_up_by_driver' | 'preorder' | 'accept_by_driver' | 'parked' | 'refunded' | 'draft', businessIds: string, limit?: number, page?: number, posBusinessId?: string, extraProvider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedOrderResponseDto, any, {}>>;
|
|
21697
|
+
getOrdersV2(status: 'pending' | 'in_progress' | 'ready' | 'delivered' | 'rejected' | 'pick_up_by_driver' | 'preorder' | 'accept_by_driver' | 'parked' | 'refunded' | 'draft', businessIds: string, posBusinessId?: string, extraProvider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnifiedOrderResponseDto[], any, {}>>;
|
|
21552
21698
|
/**
|
|
21553
21699
|
*
|
|
21554
21700
|
* @summary Get all Pos park order
|
|
@@ -21567,24 +21713,6 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
21567
21713
|
* @memberof OrdersApi
|
|
21568
21714
|
*/
|
|
21569
21715
|
markOrderAsReady(readyOrderDto: ReadyOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderStatusResponseDto, any, {}>>;
|
|
21570
|
-
/**
|
|
21571
|
-
*
|
|
21572
|
-
* @summary Place an POS order
|
|
21573
|
-
* @param {PosOrderPayloadDto} posOrderPayloadDto
|
|
21574
|
-
* @param {*} [options] Override http request option.
|
|
21575
|
-
* @throws {RequiredError}
|
|
21576
|
-
* @memberof OrdersApi
|
|
21577
|
-
*/
|
|
21578
|
-
placePosOrderV2(posOrderPayloadDto: PosOrderPayloadDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosOrderDto, any, {}>>;
|
|
21579
|
-
/**
|
|
21580
|
-
*
|
|
21581
|
-
* @summary Place an POS order
|
|
21582
|
-
* @param {PosOrderPayloadDto} posOrderPayloadDto
|
|
21583
|
-
* @param {*} [options] Override http request option.
|
|
21584
|
-
* @throws {RequiredError}
|
|
21585
|
-
* @memberof OrdersApi
|
|
21586
|
-
*/
|
|
21587
|
-
placePosOrderV3(posOrderPayloadDto: PosOrderPayloadDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosOrderDto, any, {}>>;
|
|
21588
21716
|
/**
|
|
21589
21717
|
*
|
|
21590
21718
|
* @summary Place an POS order
|
|
@@ -21612,15 +21740,6 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
21612
21740
|
* @memberof OrdersApi
|
|
21613
21741
|
*/
|
|
21614
21742
|
rejectOrder(rejectOrderDto: RejectOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderStatusResponseDto, any, {}>>;
|
|
21615
|
-
/**
|
|
21616
|
-
*
|
|
21617
|
-
* @summary Send a POS order ticket
|
|
21618
|
-
* @param {SendPosOrderTicketDto} sendPosOrderTicketDto
|
|
21619
|
-
* @param {*} [options] Override http request option.
|
|
21620
|
-
* @throws {RequiredError}
|
|
21621
|
-
* @memberof OrdersApi
|
|
21622
|
-
*/
|
|
21623
|
-
sendPosOrderTicketV2(sendPosOrderTicketDto: SendPosOrderTicketDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosOrderDto, any, {}>>;
|
|
21624
21743
|
/**
|
|
21625
21744
|
*
|
|
21626
21745
|
* @summary Update a POS order status
|
|
@@ -24009,38 +24128,17 @@ export declare class RefundsApi extends BaseAPI implements RefundsApiInterface {
|
|
|
24009
24128
|
export declare const ReportApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24010
24129
|
/**
|
|
24011
24130
|
*
|
|
24012
|
-
* @summary Get end-of-day financial report
|
|
24013
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24014
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24015
|
-
* @param {string} [start] Start date
|
|
24016
|
-
* @param {string} [end] End date
|
|
24017
|
-
* @param {*} [options] Override http request option.
|
|
24018
|
-
* @throws {RequiredError}
|
|
24019
|
-
*/
|
|
24020
|
-
getPOSEndOfDayReport: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24021
|
-
/**
|
|
24022
|
-
*
|
|
24023
|
-
* @summary Get end-of-day financial report for POS (V2)
|
|
24024
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24025
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24026
|
-
* @param {string} [start] Start date
|
|
24027
|
-
* @param {string} [end] End date
|
|
24028
|
-
* @param {*} [options] Override http request option.
|
|
24029
|
-
* @throws {RequiredError}
|
|
24030
|
-
*/
|
|
24031
|
-
getPOSEndOfDayReportV2: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24032
|
-
/**
|
|
24033
|
-
*
|
|
24034
|
-
* @summary Get end-of-day financial report for POS (V3)
|
|
24131
|
+
* @summary Get end-of-day financial report (V5)
|
|
24035
24132
|
* @param {Array<number>} businessIds Business ID selected
|
|
24036
24133
|
* @param {TimeSpan} [timeSpan] Time span
|
|
24037
24134
|
* @param {string} [start] Start date
|
|
24038
24135
|
* @param {string} [end] End date
|
|
24039
24136
|
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
24137
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [provider] Order source provider (default is MunchiPos)
|
|
24040
24138
|
* @param {*} [options] Override http request option.
|
|
24041
24139
|
* @throws {RequiredError}
|
|
24042
24140
|
*/
|
|
24043
|
-
|
|
24141
|
+
getEndOfDayReportV5: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24044
24142
|
/**
|
|
24045
24143
|
*
|
|
24046
24144
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -24055,31 +24153,7 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
24055
24153
|
getPOSEndOfDayReportV4: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24056
24154
|
/**
|
|
24057
24155
|
*
|
|
24058
|
-
* @summary Send end-of-day report via email
|
|
24059
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24060
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24061
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24062
|
-
* @param {string} [start] Start date
|
|
24063
|
-
* @param {string} [end] End date
|
|
24064
|
-
* @param {*} [options] Override http request option.
|
|
24065
|
-
* @throws {RequiredError}
|
|
24066
|
-
*/
|
|
24067
|
-
sendReportEmail: (businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24068
|
-
/**
|
|
24069
|
-
*
|
|
24070
|
-
* @summary Send end-of-day report via email (V2)
|
|
24071
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24072
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24073
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24074
|
-
* @param {string} [start] Start date
|
|
24075
|
-
* @param {string} [end] End date
|
|
24076
|
-
* @param {*} [options] Override http request option.
|
|
24077
|
-
* @throws {RequiredError}
|
|
24078
|
-
*/
|
|
24079
|
-
sendReportEmailV2: (businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24080
|
-
/**
|
|
24081
|
-
*
|
|
24082
|
-
* @summary Send end-of-day report via email (V3)
|
|
24156
|
+
* @summary Send end-of-day report via email (V4)
|
|
24083
24157
|
* @param {Array<number>} businessIds Business ID selected
|
|
24084
24158
|
* @param {string} timezone
|
|
24085
24159
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
@@ -24089,20 +24163,21 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
24089
24163
|
* @param {*} [options] Override http request option.
|
|
24090
24164
|
* @throws {RequiredError}
|
|
24091
24165
|
*/
|
|
24092
|
-
|
|
24166
|
+
sendReportEmailV4: (businessIds: Array<number>, timezone: string, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24093
24167
|
/**
|
|
24094
24168
|
*
|
|
24095
|
-
* @summary Send end-of-day report via email (
|
|
24169
|
+
* @summary Send end-of-day report via email (V5)
|
|
24096
24170
|
* @param {Array<number>} businessIds Business ID selected
|
|
24097
24171
|
* @param {string} timezone
|
|
24098
24172
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24099
24173
|
* @param {TimeSpan} [timeSpan] Time span
|
|
24100
24174
|
* @param {string} [start] Start date
|
|
24101
24175
|
* @param {string} [end] End date
|
|
24176
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [provider] Order source provider (default is MunchiPos)
|
|
24102
24177
|
* @param {*} [options] Override http request option.
|
|
24103
24178
|
* @throws {RequiredError}
|
|
24104
24179
|
*/
|
|
24105
|
-
|
|
24180
|
+
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", options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24106
24181
|
};
|
|
24107
24182
|
/**
|
|
24108
24183
|
* ReportApi - functional programming interface
|
|
@@ -24111,38 +24186,17 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
24111
24186
|
export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
24112
24187
|
/**
|
|
24113
24188
|
*
|
|
24114
|
-
* @summary Get end-of-day financial report
|
|
24115
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24116
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24117
|
-
* @param {string} [start] Start date
|
|
24118
|
-
* @param {string} [end] End date
|
|
24119
|
-
* @param {*} [options] Override http request option.
|
|
24120
|
-
* @throws {RequiredError}
|
|
24121
|
-
*/
|
|
24122
|
-
getPOSEndOfDayReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndOfDayReportDto>>;
|
|
24123
|
-
/**
|
|
24124
|
-
*
|
|
24125
|
-
* @summary Get end-of-day financial report for POS (V2)
|
|
24126
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24127
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24128
|
-
* @param {string} [start] Start date
|
|
24129
|
-
* @param {string} [end] End date
|
|
24130
|
-
* @param {*} [options] Override http request option.
|
|
24131
|
-
* @throws {RequiredError}
|
|
24132
|
-
*/
|
|
24133
|
-
getPOSEndOfDayReportV2(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndOfDayReportDto>>;
|
|
24134
|
-
/**
|
|
24135
|
-
*
|
|
24136
|
-
* @summary Get end-of-day financial report for POS (V3)
|
|
24189
|
+
* @summary Get end-of-day financial report (V5)
|
|
24137
24190
|
* @param {Array<number>} businessIds Business ID selected
|
|
24138
24191
|
* @param {TimeSpan} [timeSpan] Time span
|
|
24139
24192
|
* @param {string} [start] Start date
|
|
24140
24193
|
* @param {string} [end] End date
|
|
24141
24194
|
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
24195
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [provider] Order source provider (default is MunchiPos)
|
|
24142
24196
|
* @param {*} [options] Override http request option.
|
|
24143
24197
|
* @throws {RequiredError}
|
|
24144
24198
|
*/
|
|
24145
|
-
|
|
24199
|
+
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndOfDayReportDtoV4>>;
|
|
24146
24200
|
/**
|
|
24147
24201
|
*
|
|
24148
24202
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -24157,31 +24211,7 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
24157
24211
|
getPOSEndOfDayReportV4(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndOfDayReportDtoV4>>;
|
|
24158
24212
|
/**
|
|
24159
24213
|
*
|
|
24160
|
-
* @summary Send end-of-day report via email
|
|
24161
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24162
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24163
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24164
|
-
* @param {string} [start] Start date
|
|
24165
|
-
* @param {string} [end] End date
|
|
24166
|
-
* @param {*} [options] Override http request option.
|
|
24167
|
-
* @throws {RequiredError}
|
|
24168
|
-
*/
|
|
24169
|
-
sendReportEmail(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
24170
|
-
/**
|
|
24171
|
-
*
|
|
24172
|
-
* @summary Send end-of-day report via email (V2)
|
|
24173
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24174
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24175
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24176
|
-
* @param {string} [start] Start date
|
|
24177
|
-
* @param {string} [end] End date
|
|
24178
|
-
* @param {*} [options] Override http request option.
|
|
24179
|
-
* @throws {RequiredError}
|
|
24180
|
-
*/
|
|
24181
|
-
sendReportEmailV2(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
24182
|
-
/**
|
|
24183
|
-
*
|
|
24184
|
-
* @summary Send end-of-day report via email (V3)
|
|
24214
|
+
* @summary Send end-of-day report via email (V4)
|
|
24185
24215
|
* @param {Array<number>} businessIds Business ID selected
|
|
24186
24216
|
* @param {string} timezone
|
|
24187
24217
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
@@ -24191,20 +24221,21 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
24191
24221
|
* @param {*} [options] Override http request option.
|
|
24192
24222
|
* @throws {RequiredError}
|
|
24193
24223
|
*/
|
|
24194
|
-
|
|
24224
|
+
sendReportEmailV4(businessIds: Array<number>, timezone: string, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
24195
24225
|
/**
|
|
24196
24226
|
*
|
|
24197
|
-
* @summary Send end-of-day report via email (
|
|
24227
|
+
* @summary Send end-of-day report via email (V5)
|
|
24198
24228
|
* @param {Array<number>} businessIds Business ID selected
|
|
24199
24229
|
* @param {string} timezone
|
|
24200
24230
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24201
24231
|
* @param {TimeSpan} [timeSpan] Time span
|
|
24202
24232
|
* @param {string} [start] Start date
|
|
24203
24233
|
* @param {string} [end] End date
|
|
24234
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [provider] Order source provider (default is MunchiPos)
|
|
24204
24235
|
* @param {*} [options] Override http request option.
|
|
24205
24236
|
* @throws {RequiredError}
|
|
24206
24237
|
*/
|
|
24207
|
-
|
|
24238
|
+
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", options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
24208
24239
|
};
|
|
24209
24240
|
/**
|
|
24210
24241
|
* ReportApi - factory interface
|
|
@@ -24213,38 +24244,17 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
24213
24244
|
export declare const ReportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
24214
24245
|
/**
|
|
24215
24246
|
*
|
|
24216
|
-
* @summary Get end-of-day financial report
|
|
24217
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24218
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24219
|
-
* @param {string} [start] Start date
|
|
24220
|
-
* @param {string} [end] End date
|
|
24221
|
-
* @param {*} [options] Override http request option.
|
|
24222
|
-
* @throws {RequiredError}
|
|
24223
|
-
*/
|
|
24224
|
-
getPOSEndOfDayReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, options?: any): AxiosPromise<EndOfDayReportDto>;
|
|
24225
|
-
/**
|
|
24226
|
-
*
|
|
24227
|
-
* @summary Get end-of-day financial report for POS (V2)
|
|
24228
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24229
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24230
|
-
* @param {string} [start] Start date
|
|
24231
|
-
* @param {string} [end] End date
|
|
24232
|
-
* @param {*} [options] Override http request option.
|
|
24233
|
-
* @throws {RequiredError}
|
|
24234
|
-
*/
|
|
24235
|
-
getPOSEndOfDayReportV2(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, options?: any): AxiosPromise<EndOfDayReportDto>;
|
|
24236
|
-
/**
|
|
24237
|
-
*
|
|
24238
|
-
* @summary Get end-of-day financial report for POS (V3)
|
|
24247
|
+
* @summary Get end-of-day financial report (V5)
|
|
24239
24248
|
* @param {Array<number>} businessIds Business ID selected
|
|
24240
24249
|
* @param {TimeSpan} [timeSpan] Time span
|
|
24241
24250
|
* @param {string} [start] Start date
|
|
24242
24251
|
* @param {string} [end] End date
|
|
24243
24252
|
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
24253
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [provider] Order source provider (default is MunchiPos)
|
|
24244
24254
|
* @param {*} [options] Override http request option.
|
|
24245
24255
|
* @throws {RequiredError}
|
|
24246
24256
|
*/
|
|
24247
|
-
|
|
24257
|
+
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront", options?: any): AxiosPromise<EndOfDayReportDtoV4>;
|
|
24248
24258
|
/**
|
|
24249
24259
|
*
|
|
24250
24260
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -24259,31 +24269,7 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
24259
24269
|
getPOSEndOfDayReportV4(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: any): AxiosPromise<EndOfDayReportDtoV4>;
|
|
24260
24270
|
/**
|
|
24261
24271
|
*
|
|
24262
|
-
* @summary Send end-of-day report via email
|
|
24263
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24264
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24265
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24266
|
-
* @param {string} [start] Start date
|
|
24267
|
-
* @param {string} [end] End date
|
|
24268
|
-
* @param {*} [options] Override http request option.
|
|
24269
|
-
* @throws {RequiredError}
|
|
24270
|
-
*/
|
|
24271
|
-
sendReportEmail(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: any): AxiosPromise<void>;
|
|
24272
|
-
/**
|
|
24273
|
-
*
|
|
24274
|
-
* @summary Send end-of-day report via email (V2)
|
|
24275
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24276
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24277
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24278
|
-
* @param {string} [start] Start date
|
|
24279
|
-
* @param {string} [end] End date
|
|
24280
|
-
* @param {*} [options] Override http request option.
|
|
24281
|
-
* @throws {RequiredError}
|
|
24282
|
-
*/
|
|
24283
|
-
sendReportEmailV2(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: any): AxiosPromise<void>;
|
|
24284
|
-
/**
|
|
24285
|
-
*
|
|
24286
|
-
* @summary Send end-of-day report via email (V3)
|
|
24272
|
+
* @summary Send end-of-day report via email (V4)
|
|
24287
24273
|
* @param {Array<number>} businessIds Business ID selected
|
|
24288
24274
|
* @param {string} timezone
|
|
24289
24275
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
@@ -24293,20 +24279,21 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
24293
24279
|
* @param {*} [options] Override http request option.
|
|
24294
24280
|
* @throws {RequiredError}
|
|
24295
24281
|
*/
|
|
24296
|
-
|
|
24282
|
+
sendReportEmailV4(businessIds: Array<number>, timezone: string, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: any): AxiosPromise<void>;
|
|
24297
24283
|
/**
|
|
24298
24284
|
*
|
|
24299
|
-
* @summary Send end-of-day report via email (
|
|
24285
|
+
* @summary Send end-of-day report via email (V5)
|
|
24300
24286
|
* @param {Array<number>} businessIds Business ID selected
|
|
24301
24287
|
* @param {string} timezone
|
|
24302
24288
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24303
24289
|
* @param {TimeSpan} [timeSpan] Time span
|
|
24304
24290
|
* @param {string} [start] Start date
|
|
24305
24291
|
* @param {string} [end] End date
|
|
24292
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [provider] Order source provider (default is MunchiPos)
|
|
24306
24293
|
* @param {*} [options] Override http request option.
|
|
24307
24294
|
* @throws {RequiredError}
|
|
24308
24295
|
*/
|
|
24309
|
-
|
|
24296
|
+
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", options?: any): AxiosPromise<void>;
|
|
24310
24297
|
};
|
|
24311
24298
|
/**
|
|
24312
24299
|
* ReportApi - interface
|
|
@@ -24316,41 +24303,18 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
24316
24303
|
export interface ReportApiInterface {
|
|
24317
24304
|
/**
|
|
24318
24305
|
*
|
|
24319
|
-
* @summary Get end-of-day financial report
|
|
24320
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24321
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24322
|
-
* @param {string} [start] Start date
|
|
24323
|
-
* @param {string} [end] End date
|
|
24324
|
-
* @param {*} [options] Override http request option.
|
|
24325
|
-
* @throws {RequiredError}
|
|
24326
|
-
* @memberof ReportApiInterface
|
|
24327
|
-
*/
|
|
24328
|
-
getPOSEndOfDayReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportDto>;
|
|
24329
|
-
/**
|
|
24330
|
-
*
|
|
24331
|
-
* @summary Get end-of-day financial report for POS (V2)
|
|
24332
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24333
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24334
|
-
* @param {string} [start] Start date
|
|
24335
|
-
* @param {string} [end] End date
|
|
24336
|
-
* @param {*} [options] Override http request option.
|
|
24337
|
-
* @throws {RequiredError}
|
|
24338
|
-
* @memberof ReportApiInterface
|
|
24339
|
-
*/
|
|
24340
|
-
getPOSEndOfDayReportV2(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportDto>;
|
|
24341
|
-
/**
|
|
24342
|
-
*
|
|
24343
|
-
* @summary Get end-of-day financial report for POS (V3)
|
|
24306
|
+
* @summary Get end-of-day financial report (V5)
|
|
24344
24307
|
* @param {Array<number>} businessIds Business ID selected
|
|
24345
24308
|
* @param {TimeSpan} [timeSpan] Time span
|
|
24346
24309
|
* @param {string} [start] Start date
|
|
24347
24310
|
* @param {string} [end] End date
|
|
24348
24311
|
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
24312
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [provider] Order source provider (default is MunchiPos)
|
|
24349
24313
|
* @param {*} [options] Override http request option.
|
|
24350
24314
|
* @throws {RequiredError}
|
|
24351
24315
|
* @memberof ReportApiInterface
|
|
24352
24316
|
*/
|
|
24353
|
-
|
|
24317
|
+
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront', options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportDtoV4>;
|
|
24354
24318
|
/**
|
|
24355
24319
|
*
|
|
24356
24320
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -24366,33 +24330,7 @@ export interface ReportApiInterface {
|
|
|
24366
24330
|
getPOSEndOfDayReportV4(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportDtoV4>;
|
|
24367
24331
|
/**
|
|
24368
24332
|
*
|
|
24369
|
-
* @summary Send end-of-day report via email
|
|
24370
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24371
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24372
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24373
|
-
* @param {string} [start] Start date
|
|
24374
|
-
* @param {string} [end] End date
|
|
24375
|
-
* @param {*} [options] Override http request option.
|
|
24376
|
-
* @throws {RequiredError}
|
|
24377
|
-
* @memberof ReportApiInterface
|
|
24378
|
-
*/
|
|
24379
|
-
sendReportEmail(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
24380
|
-
/**
|
|
24381
|
-
*
|
|
24382
|
-
* @summary Send end-of-day report via email (V2)
|
|
24383
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24384
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24385
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24386
|
-
* @param {string} [start] Start date
|
|
24387
|
-
* @param {string} [end] End date
|
|
24388
|
-
* @param {*} [options] Override http request option.
|
|
24389
|
-
* @throws {RequiredError}
|
|
24390
|
-
* @memberof ReportApiInterface
|
|
24391
|
-
*/
|
|
24392
|
-
sendReportEmailV2(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
24393
|
-
/**
|
|
24394
|
-
*
|
|
24395
|
-
* @summary Send end-of-day report via email (V3)
|
|
24333
|
+
* @summary Send end-of-day report via email (V4)
|
|
24396
24334
|
* @param {Array<number>} businessIds Business ID selected
|
|
24397
24335
|
* @param {string} timezone
|
|
24398
24336
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
@@ -24403,21 +24341,22 @@ export interface ReportApiInterface {
|
|
|
24403
24341
|
* @throws {RequiredError}
|
|
24404
24342
|
* @memberof ReportApiInterface
|
|
24405
24343
|
*/
|
|
24406
|
-
|
|
24344
|
+
sendReportEmailV4(businessIds: Array<number>, timezone: string, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
24407
24345
|
/**
|
|
24408
24346
|
*
|
|
24409
|
-
* @summary Send end-of-day report via email (
|
|
24347
|
+
* @summary Send end-of-day report via email (V5)
|
|
24410
24348
|
* @param {Array<number>} businessIds Business ID selected
|
|
24411
24349
|
* @param {string} timezone
|
|
24412
24350
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24413
24351
|
* @param {TimeSpan} [timeSpan] Time span
|
|
24414
24352
|
* @param {string} [start] Start date
|
|
24415
24353
|
* @param {string} [end] End date
|
|
24354
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [provider] Order source provider (default is MunchiPos)
|
|
24416
24355
|
* @param {*} [options] Override http request option.
|
|
24417
24356
|
* @throws {RequiredError}
|
|
24418
24357
|
* @memberof ReportApiInterface
|
|
24419
24358
|
*/
|
|
24420
|
-
|
|
24359
|
+
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', options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
24421
24360
|
}
|
|
24422
24361
|
/**
|
|
24423
24362
|
* ReportApi - object-oriented interface
|
|
@@ -24428,41 +24367,18 @@ export interface ReportApiInterface {
|
|
|
24428
24367
|
export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
24429
24368
|
/**
|
|
24430
24369
|
*
|
|
24431
|
-
* @summary Get end-of-day financial report
|
|
24432
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24433
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24434
|
-
* @param {string} [start] Start date
|
|
24435
|
-
* @param {string} [end] End date
|
|
24436
|
-
* @param {*} [options] Override http request option.
|
|
24437
|
-
* @throws {RequiredError}
|
|
24438
|
-
* @memberof ReportApi
|
|
24439
|
-
*/
|
|
24440
|
-
getPOSEndOfDayReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EndOfDayReportDto, any, {}>>;
|
|
24441
|
-
/**
|
|
24442
|
-
*
|
|
24443
|
-
* @summary Get end-of-day financial report for POS (V2)
|
|
24444
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24445
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24446
|
-
* @param {string} [start] Start date
|
|
24447
|
-
* @param {string} [end] End date
|
|
24448
|
-
* @param {*} [options] Override http request option.
|
|
24449
|
-
* @throws {RequiredError}
|
|
24450
|
-
* @memberof ReportApi
|
|
24451
|
-
*/
|
|
24452
|
-
getPOSEndOfDayReportV2(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EndOfDayReportDto, any, {}>>;
|
|
24453
|
-
/**
|
|
24454
|
-
*
|
|
24455
|
-
* @summary Get end-of-day financial report for POS (V3)
|
|
24370
|
+
* @summary Get end-of-day financial report (V5)
|
|
24456
24371
|
* @param {Array<number>} businessIds Business ID selected
|
|
24457
24372
|
* @param {TimeSpan} [timeSpan] Time span
|
|
24458
24373
|
* @param {string} [start] Start date
|
|
24459
24374
|
* @param {string} [end] End date
|
|
24460
24375
|
* @param {string} [timezone] Timezone (default is \"UTC\")
|
|
24376
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [provider] Order source provider (default is MunchiPos)
|
|
24461
24377
|
* @param {*} [options] Override http request option.
|
|
24462
24378
|
* @throws {RequiredError}
|
|
24463
24379
|
* @memberof ReportApi
|
|
24464
24380
|
*/
|
|
24465
|
-
|
|
24381
|
+
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EndOfDayReportDtoV4, any, {}>>;
|
|
24466
24382
|
/**
|
|
24467
24383
|
*
|
|
24468
24384
|
* @summary Get end-of-day financial report for POS (V4)
|
|
@@ -24478,33 +24394,7 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
24478
24394
|
getPOSEndOfDayReportV4(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EndOfDayReportDtoV4, any, {}>>;
|
|
24479
24395
|
/**
|
|
24480
24396
|
*
|
|
24481
|
-
* @summary Send end-of-day report via email
|
|
24482
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24483
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24484
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24485
|
-
* @param {string} [start] Start date
|
|
24486
|
-
* @param {string} [end] End date
|
|
24487
|
-
* @param {*} [options] Override http request option.
|
|
24488
|
-
* @throws {RequiredError}
|
|
24489
|
-
* @memberof ReportApi
|
|
24490
|
-
*/
|
|
24491
|
-
sendReportEmail(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
24492
|
-
/**
|
|
24493
|
-
*
|
|
24494
|
-
* @summary Send end-of-day report via email (V2)
|
|
24495
|
-
* @param {Array<number>} businessIds Business ID selected
|
|
24496
|
-
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24497
|
-
* @param {TimeSpan} [timeSpan] Time span
|
|
24498
|
-
* @param {string} [start] Start date
|
|
24499
|
-
* @param {string} [end] End date
|
|
24500
|
-
* @param {*} [options] Override http request option.
|
|
24501
|
-
* @throws {RequiredError}
|
|
24502
|
-
* @memberof ReportApi
|
|
24503
|
-
*/
|
|
24504
|
-
sendReportEmailV2(businessIds: Array<number>, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
24505
|
-
/**
|
|
24506
|
-
*
|
|
24507
|
-
* @summary Send end-of-day report via email (V3)
|
|
24397
|
+
* @summary Send end-of-day report via email (V4)
|
|
24508
24398
|
* @param {Array<number>} businessIds Business ID selected
|
|
24509
24399
|
* @param {string} timezone
|
|
24510
24400
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
@@ -24515,21 +24405,22 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
24515
24405
|
* @throws {RequiredError}
|
|
24516
24406
|
* @memberof ReportApi
|
|
24517
24407
|
*/
|
|
24518
|
-
|
|
24408
|
+
sendReportEmailV4(businessIds: Array<number>, timezone: string, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
24519
24409
|
/**
|
|
24520
24410
|
*
|
|
24521
|
-
* @summary Send end-of-day report via email (
|
|
24411
|
+
* @summary Send end-of-day report via email (V5)
|
|
24522
24412
|
* @param {Array<number>} businessIds Business ID selected
|
|
24523
24413
|
* @param {string} timezone
|
|
24524
24414
|
* @param {SendReportEmailDto} sendReportEmailDto
|
|
24525
24415
|
* @param {TimeSpan} [timeSpan] Time span
|
|
24526
24416
|
* @param {string} [start] Start date
|
|
24527
24417
|
* @param {string} [end] End date
|
|
24418
|
+
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront'} [provider] Order source provider (default is MunchiPos)
|
|
24528
24419
|
* @param {*} [options] Override http request option.
|
|
24529
24420
|
* @throws {RequiredError}
|
|
24530
24421
|
* @memberof ReportApi
|
|
24531
24422
|
*/
|
|
24532
|
-
|
|
24423
|
+
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', options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
24533
24424
|
}
|
|
24534
24425
|
/**
|
|
24535
24426
|
* RolesPermissionsApi - axios parameter creator
|