@munchi_oy/core 2.0.2 → 2.0.4
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 +1591 -9
- 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 +1841 -9
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -2364,6 +2364,52 @@ export interface ChangePaymentMethodOptionDto {
|
|
|
2364
2364
|
*/
|
|
2365
2365
|
'enable'?: boolean;
|
|
2366
2366
|
}
|
|
2367
|
+
/**
|
|
2368
|
+
*
|
|
2369
|
+
* @export
|
|
2370
|
+
* @interface ChangePosOrdersStatusInBulkDto
|
|
2371
|
+
*/
|
|
2372
|
+
export interface ChangePosOrdersStatusInBulkDto {
|
|
2373
|
+
/**
|
|
2374
|
+
* The venue whose tickets and orders the till moves, by its venue id
|
|
2375
|
+
* @type {number}
|
|
2376
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2377
|
+
*/
|
|
2378
|
+
'orderingBusinessId': number;
|
|
2379
|
+
/**
|
|
2380
|
+
* The ids in Firestore of the till\'s tickets and orders to move, each once, 1 to 100 of them
|
|
2381
|
+
* @type {Array<string>}
|
|
2382
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2383
|
+
*/
|
|
2384
|
+
'orderIds': Array<string>;
|
|
2385
|
+
/**
|
|
2386
|
+
*
|
|
2387
|
+
* @type {PosBulkOrderStatus}
|
|
2388
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2389
|
+
*/
|
|
2390
|
+
'status': PosBulkOrderStatus;
|
|
2391
|
+
}
|
|
2392
|
+
|
|
2393
|
+
|
|
2394
|
+
/**
|
|
2395
|
+
*
|
|
2396
|
+
* @export
|
|
2397
|
+
* @interface ChangePosOrdersStatusInBulkResponseDto
|
|
2398
|
+
*/
|
|
2399
|
+
export interface ChangePosOrdersStatusInBulkResponseDto {
|
|
2400
|
+
/**
|
|
2401
|
+
* The ids of the tickets and orders moved to the status, in the order the till sent them; empty when none could be
|
|
2402
|
+
* @type {Array<string>}
|
|
2403
|
+
* @memberof ChangePosOrdersStatusInBulkResponseDto
|
|
2404
|
+
*/
|
|
2405
|
+
'moved': Array<string>;
|
|
2406
|
+
/**
|
|
2407
|
+
* The ids left as they are, each with the reason, in the order the till sent them; empty when every one moved
|
|
2408
|
+
* @type {Array<PosOrderLeftAsItIsDto>}
|
|
2409
|
+
* @memberof ChangePosOrdersStatusInBulkResponseDto
|
|
2410
|
+
*/
|
|
2411
|
+
'skipped': Array<PosOrderLeftAsItIsDto>;
|
|
2412
|
+
}
|
|
2367
2413
|
/**
|
|
2368
2414
|
*
|
|
2369
2415
|
* @export
|
|
@@ -6637,9 +6683,10 @@ export interface ExtendedProductDto {
|
|
|
6637
6683
|
*/
|
|
6638
6684
|
'images': string;
|
|
6639
6685
|
/**
|
|
6640
|
-
* SKU of the product
|
|
6686
|
+
* SKU of the product: its first one. Read skus instead
|
|
6641
6687
|
* @type {string}
|
|
6642
6688
|
* @memberof ExtendedProductDto
|
|
6689
|
+
* @deprecated
|
|
6643
6690
|
*/
|
|
6644
6691
|
'sku'?: string | null;
|
|
6645
6692
|
/**
|
|
@@ -6804,6 +6851,12 @@ export interface ExtendedProductDto {
|
|
|
6804
6851
|
* @memberof ExtendedProductDto
|
|
6805
6852
|
*/
|
|
6806
6853
|
'channel_configs': Array<ChannelConfig>;
|
|
6854
|
+
/**
|
|
6855
|
+
* Every SKU of the product, in order, the first being sku; absent where the product\'s SKUs are not read, such as on an order line
|
|
6856
|
+
* @type {Array<string>}
|
|
6857
|
+
* @memberof ExtendedProductDto
|
|
6858
|
+
*/
|
|
6859
|
+
'skus'?: Array<string>;
|
|
6807
6860
|
/**
|
|
6808
6861
|
* Default course ID assigned to this product
|
|
6809
6862
|
* @type {string}
|
|
@@ -8558,6 +8611,21 @@ export const KDSEVENTNAME = {
|
|
|
8558
8611
|
export type KDSEVENTNAME = typeof KDSEVENTNAME[keyof typeof KDSEVENTNAME];
|
|
8559
8612
|
|
|
8560
8613
|
|
|
8614
|
+
/**
|
|
8615
|
+
*
|
|
8616
|
+
* @export
|
|
8617
|
+
* @enum {string}
|
|
8618
|
+
*/
|
|
8619
|
+
|
|
8620
|
+
export const KdsBulkReadySkipReason = {
|
|
8621
|
+
Found: 'NOT_FOUND',
|
|
8622
|
+
Pos: 'NOT_POS',
|
|
8623
|
+
InProgress: 'NOT_IN_PROGRESS'
|
|
8624
|
+
} as const;
|
|
8625
|
+
|
|
8626
|
+
export type KdsBulkReadySkipReason = typeof KdsBulkReadySkipReason[keyof typeof KdsBulkReadySkipReason];
|
|
8627
|
+
|
|
8628
|
+
|
|
8561
8629
|
/**
|
|
8562
8630
|
*
|
|
8563
8631
|
* @export
|
|
@@ -8764,6 +8832,31 @@ export interface KdsLocationDtoCoordinates {
|
|
|
8764
8832
|
*/
|
|
8765
8833
|
'lon': number | null;
|
|
8766
8834
|
}
|
|
8835
|
+
/**
|
|
8836
|
+
*
|
|
8837
|
+
* @export
|
|
8838
|
+
* @interface KdsMarkOrdersReadyDto
|
|
8839
|
+
*/
|
|
8840
|
+
export interface KdsMarkOrdersReadyDto {
|
|
8841
|
+
/**
|
|
8842
|
+
* The venue\'s orderingBusinessId
|
|
8843
|
+
* @type {number}
|
|
8844
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8845
|
+
*/
|
|
8846
|
+
'businessId': number;
|
|
8847
|
+
/**
|
|
8848
|
+
* The id of the station (KDS profile) whose orders are marked ready
|
|
8849
|
+
* @type {string}
|
|
8850
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8851
|
+
*/
|
|
8852
|
+
'profileId': string;
|
|
8853
|
+
/**
|
|
8854
|
+
* The KDS orders\' ids in kds-service, each once, 1 to 100 of them
|
|
8855
|
+
* @type {Array<string>}
|
|
8856
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8857
|
+
*/
|
|
8858
|
+
'orderIds': Array<string>;
|
|
8859
|
+
}
|
|
8767
8860
|
/**
|
|
8768
8861
|
*
|
|
8769
8862
|
* @export
|
|
@@ -9144,6 +9237,27 @@ export interface KdsOrderItemDto {
|
|
|
9144
9237
|
}
|
|
9145
9238
|
|
|
9146
9239
|
|
|
9240
|
+
/**
|
|
9241
|
+
*
|
|
9242
|
+
* @export
|
|
9243
|
+
* @interface KdsOrderLeftAsItIsDto
|
|
9244
|
+
*/
|
|
9245
|
+
export interface KdsOrderLeftAsItIsDto {
|
|
9246
|
+
/**
|
|
9247
|
+
* The id of a KDS order kds-service did not mark ready
|
|
9248
|
+
* @type {string}
|
|
9249
|
+
* @memberof KdsOrderLeftAsItIsDto
|
|
9250
|
+
*/
|
|
9251
|
+
'orderId': string;
|
|
9252
|
+
/**
|
|
9253
|
+
*
|
|
9254
|
+
* @type {KdsBulkReadySkipReason}
|
|
9255
|
+
* @memberof KdsOrderLeftAsItIsDto
|
|
9256
|
+
*/
|
|
9257
|
+
'reason': KdsBulkReadySkipReason;
|
|
9258
|
+
}
|
|
9259
|
+
|
|
9260
|
+
|
|
9147
9261
|
/**
|
|
9148
9262
|
*
|
|
9149
9263
|
* @export
|
|
@@ -9912,6 +10026,43 @@ export interface KdsReadyOrderResponseDtoOrder {
|
|
|
9912
10026
|
}
|
|
9913
10027
|
|
|
9914
10028
|
|
|
10029
|
+
/**
|
|
10030
|
+
*
|
|
10031
|
+
* @export
|
|
10032
|
+
* @interface KdsReadyOrdersResponseDto
|
|
10033
|
+
*/
|
|
10034
|
+
export interface KdsReadyOrdersResponseDto {
|
|
10035
|
+
/**
|
|
10036
|
+
* The ids of the KDS orders marked ready; empty when none were
|
|
10037
|
+
* @type {Array<string>}
|
|
10038
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
10039
|
+
*/
|
|
10040
|
+
'ready': Array<string>;
|
|
10041
|
+
/**
|
|
10042
|
+
* The ids kds-service left as they are, each with its reason; empty when none were
|
|
10043
|
+
* @type {Array<KdsOrderLeftAsItIsDto>}
|
|
10044
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
10045
|
+
*/
|
|
10046
|
+
'skipped': Array<KdsOrderLeftAsItIsDto>;
|
|
10047
|
+
/**
|
|
10048
|
+
* The ids of tickets kds-service marked ready whose status it could not pass on to this server, so the till may not show them ready yet; absent when every one was passed on
|
|
10049
|
+
* @type {Array<string>}
|
|
10050
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
10051
|
+
*/
|
|
10052
|
+
'notAnnounced'?: Array<string>;
|
|
10053
|
+
/**
|
|
10054
|
+
* true when kds-service answered; false when it refused or could not be reached, and then nothing is listed
|
|
10055
|
+
* @type {boolean}
|
|
10056
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
10057
|
+
*/
|
|
10058
|
+
'status': boolean;
|
|
10059
|
+
/**
|
|
10060
|
+
* Human-readable status message
|
|
10061
|
+
* @type {string}
|
|
10062
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
10063
|
+
*/
|
|
10064
|
+
'message': string;
|
|
10065
|
+
}
|
|
9915
10066
|
/**
|
|
9916
10067
|
*
|
|
9917
10068
|
* @export
|
|
@@ -17952,6 +18103,36 @@ export interface PosActionPasscodeDto {
|
|
|
17952
18103
|
*/
|
|
17953
18104
|
'pinHash': string;
|
|
17954
18105
|
}
|
|
18106
|
+
/**
|
|
18107
|
+
*
|
|
18108
|
+
* @export
|
|
18109
|
+
* @enum {string}
|
|
18110
|
+
*/
|
|
18111
|
+
|
|
18112
|
+
export const PosBulkOrderStatus = {
|
|
18113
|
+
Ready: 'ready',
|
|
18114
|
+
Delivered: 'delivered'
|
|
18115
|
+
} as const;
|
|
18116
|
+
|
|
18117
|
+
export type PosBulkOrderStatus = typeof PosBulkOrderStatus[keyof typeof PosBulkOrderStatus];
|
|
18118
|
+
|
|
18119
|
+
|
|
18120
|
+
/**
|
|
18121
|
+
*
|
|
18122
|
+
* @export
|
|
18123
|
+
* @enum {string}
|
|
18124
|
+
*/
|
|
18125
|
+
|
|
18126
|
+
export const PosBulkStatusSkipReason = {
|
|
18127
|
+
NotFound: 'NOT_FOUND',
|
|
18128
|
+
NotInProgress: 'NOT_IN_PROGRESS',
|
|
18129
|
+
KitchenControlled: 'KITCHEN_CONTROLLED',
|
|
18130
|
+
NotReady: 'NOT_READY'
|
|
18131
|
+
} as const;
|
|
18132
|
+
|
|
18133
|
+
export type PosBulkStatusSkipReason = typeof PosBulkStatusSkipReason[keyof typeof PosBulkStatusSkipReason];
|
|
18134
|
+
|
|
18135
|
+
|
|
17955
18136
|
/**
|
|
17956
18137
|
*
|
|
17957
18138
|
* @export
|
|
@@ -18305,9 +18486,10 @@ export interface PosItemDto {
|
|
|
18305
18486
|
*/
|
|
18306
18487
|
'images': string;
|
|
18307
18488
|
/**
|
|
18308
|
-
* SKU of the product
|
|
18489
|
+
* SKU of the product: its first one. Read skus instead
|
|
18309
18490
|
* @type {string}
|
|
18310
18491
|
* @memberof PosItemDto
|
|
18492
|
+
* @deprecated
|
|
18311
18493
|
*/
|
|
18312
18494
|
'sku'?: string | null;
|
|
18313
18495
|
/**
|
|
@@ -18472,6 +18654,12 @@ export interface PosItemDto {
|
|
|
18472
18654
|
* @memberof PosItemDto
|
|
18473
18655
|
*/
|
|
18474
18656
|
'channel_configs': Array<ChannelConfig>;
|
|
18657
|
+
/**
|
|
18658
|
+
* Every SKU of the product, in order, the first being sku; absent where the product\'s SKUs are not read, such as on an order line
|
|
18659
|
+
* @type {Array<string>}
|
|
18660
|
+
* @memberof PosItemDto
|
|
18661
|
+
*/
|
|
18662
|
+
'skus'?: Array<string>;
|
|
18475
18663
|
/**
|
|
18476
18664
|
* Default course ID assigned to this product
|
|
18477
18665
|
* @type {string}
|
|
@@ -18819,11 +19007,18 @@ export interface PosMenuProductDto {
|
|
|
18819
19007
|
*/
|
|
18820
19008
|
'images': string;
|
|
18821
19009
|
/**
|
|
18822
|
-
* The product\'s stock-keeping code, or null when it has none
|
|
19010
|
+
* The product\'s first stock-keeping code, or null when it has none. Read skus instead
|
|
18823
19011
|
* @type {string}
|
|
18824
19012
|
* @memberof PosMenuProductDto
|
|
19013
|
+
* @deprecated
|
|
18825
19014
|
*/
|
|
18826
19015
|
'sku': string | null;
|
|
19016
|
+
/**
|
|
19017
|
+
* Every stock-keeping code of the product, in order, the first being sku; empty when it has none. Absent from an answer cached before the field existed: read sku then
|
|
19018
|
+
* @type {Array<string>}
|
|
19019
|
+
* @memberof PosMenuProductDto
|
|
19020
|
+
*/
|
|
19021
|
+
'skus'?: Array<string>;
|
|
18827
19022
|
/**
|
|
18828
19023
|
* The product\'s barcode, or null when it has none
|
|
18829
19024
|
* @type {string}
|
|
@@ -20174,6 +20369,27 @@ export interface PosOrderItemSplitSeatDto {
|
|
|
20174
20369
|
*/
|
|
20175
20370
|
'assignments': Array<PosOrderItemSplitSeatAssignmentDto>;
|
|
20176
20371
|
}
|
|
20372
|
+
/**
|
|
20373
|
+
*
|
|
20374
|
+
* @export
|
|
20375
|
+
* @interface PosOrderLeftAsItIsDto
|
|
20376
|
+
*/
|
|
20377
|
+
export interface PosOrderLeftAsItIsDto {
|
|
20378
|
+
/**
|
|
20379
|
+
* The id the till sent of a ticket or an order that was not moved
|
|
20380
|
+
* @type {string}
|
|
20381
|
+
* @memberof PosOrderLeftAsItIsDto
|
|
20382
|
+
*/
|
|
20383
|
+
'orderId': string;
|
|
20384
|
+
/**
|
|
20385
|
+
*
|
|
20386
|
+
* @type {PosBulkStatusSkipReason}
|
|
20387
|
+
* @memberof PosOrderLeftAsItIsDto
|
|
20388
|
+
*/
|
|
20389
|
+
'reason': PosBulkStatusSkipReason;
|
|
20390
|
+
}
|
|
20391
|
+
|
|
20392
|
+
|
|
20177
20393
|
/**
|
|
20178
20394
|
*
|
|
20179
20395
|
* @export
|
|
@@ -21428,6 +21644,26 @@ export interface ProductSkuResponseDto {
|
|
|
21428
21644
|
*/
|
|
21429
21645
|
'sku': string;
|
|
21430
21646
|
}
|
|
21647
|
+
/**
|
|
21648
|
+
*
|
|
21649
|
+
* @export
|
|
21650
|
+
* @interface ProductSkusResponseDto
|
|
21651
|
+
*/
|
|
21652
|
+
export interface ProductSkusResponseDto {
|
|
21653
|
+
/**
|
|
21654
|
+
* The first SKU Vendure saved, or null when the product has none. Read skus instead
|
|
21655
|
+
* @type {string}
|
|
21656
|
+
* @memberof ProductSkusResponseDto
|
|
21657
|
+
* @deprecated
|
|
21658
|
+
*/
|
|
21659
|
+
'sku': string | null;
|
|
21660
|
+
/**
|
|
21661
|
+
* Every SKU Vendure saved, trimmed, in order; empty when the product has none
|
|
21662
|
+
* @type {Array<string>}
|
|
21663
|
+
* @memberof ProductSkusResponseDto
|
|
21664
|
+
*/
|
|
21665
|
+
'skus': Array<string>;
|
|
21666
|
+
}
|
|
21431
21667
|
/**
|
|
21432
21668
|
*
|
|
21433
21669
|
* @export
|
|
@@ -23490,6 +23726,87 @@ export interface RejectOrderDto {
|
|
|
23490
23726
|
}
|
|
23491
23727
|
|
|
23492
23728
|
|
|
23729
|
+
/**
|
|
23730
|
+
*
|
|
23731
|
+
* @export
|
|
23732
|
+
* @enum {string}
|
|
23733
|
+
*/
|
|
23734
|
+
|
|
23735
|
+
export const ReportApp = {
|
|
23736
|
+
Pos: 'pos',
|
|
23737
|
+
Kiosk: 'kiosk',
|
|
23738
|
+
Storefront: 'storefront',
|
|
23739
|
+
Mobile: 'mobile'
|
|
23740
|
+
} as const;
|
|
23741
|
+
|
|
23742
|
+
export type ReportApp = typeof ReportApp[keyof typeof ReportApp];
|
|
23743
|
+
|
|
23744
|
+
|
|
23745
|
+
/**
|
|
23746
|
+
*
|
|
23747
|
+
* @export
|
|
23748
|
+
* @enum {string}
|
|
23749
|
+
*/
|
|
23750
|
+
|
|
23751
|
+
export const ReportBaselineLeftOut = {
|
|
23752
|
+
IsTheBaseline: 'is_the_baseline',
|
|
23753
|
+
OtherCurrency: 'other_currency'
|
|
23754
|
+
} as const;
|
|
23755
|
+
|
|
23756
|
+
export type ReportBaselineLeftOut = typeof ReportBaselineLeftOut[keyof typeof ReportBaselineLeftOut];
|
|
23757
|
+
|
|
23758
|
+
|
|
23759
|
+
/**
|
|
23760
|
+
*
|
|
23761
|
+
* @export
|
|
23762
|
+
* @enum {string}
|
|
23763
|
+
*/
|
|
23764
|
+
|
|
23765
|
+
export const ReportBreakdown = {
|
|
23766
|
+
None: 'none',
|
|
23767
|
+
Venue: 'venue',
|
|
23768
|
+
App: 'app',
|
|
23769
|
+
VenueApp: 'venue_app'
|
|
23770
|
+
} as const;
|
|
23771
|
+
|
|
23772
|
+
export type ReportBreakdown = typeof ReportBreakdown[keyof typeof ReportBreakdown];
|
|
23773
|
+
|
|
23774
|
+
|
|
23775
|
+
/**
|
|
23776
|
+
*
|
|
23777
|
+
* @export
|
|
23778
|
+
* @enum {string}
|
|
23779
|
+
*/
|
|
23780
|
+
|
|
23781
|
+
export const ReportChangeField = {
|
|
23782
|
+
SalesReportTotalQuantity: 'salesReport.totalQuantity',
|
|
23783
|
+
SalesReportTotalWithTax: 'salesReport.totalWithTax',
|
|
23784
|
+
SalesReportTotalTaxAmount: 'salesReport.totalTaxAmount',
|
|
23785
|
+
SalesReportTotalWithoutTax: 'salesReport.totalWithoutTax',
|
|
23786
|
+
SalesReportDeliveryFee: 'salesReport.deliveryFee',
|
|
23787
|
+
SalesReportDeliveryTax: 'salesReport.deliveryTax',
|
|
23788
|
+
PaymentReportSummarySalesAndRevenue: 'paymentReport.summary.salesAndRevenue',
|
|
23789
|
+
PaymentReportSummaryGrossAmount: 'paymentReport.summary.grossAmount',
|
|
23790
|
+
PaymentReportSummaryTotalCount: 'paymentReport.summary.totalCount',
|
|
23791
|
+
PaymentReportSummaryTotalAmount: 'paymentReport.summary.totalAmount',
|
|
23792
|
+
PaymentReportSummaryCardsCount: 'paymentReport.summary.cardsCount',
|
|
23793
|
+
PaymentReportSummaryCardsAmount: 'paymentReport.summary.cardsAmount',
|
|
23794
|
+
PaymentReportSummaryEdenredVoucherCount: 'paymentReport.summary.edenredVoucherCount',
|
|
23795
|
+
PaymentReportSummaryEdenredVoucherAmount: 'paymentReport.summary.edenredVoucherAmount',
|
|
23796
|
+
PaymentReportSummarySmartumVoucherCount: 'paymentReport.summary.smartumVoucherCount',
|
|
23797
|
+
PaymentReportSummarySmartumVoucherAmount: 'paymentReport.summary.smartumVoucherAmount',
|
|
23798
|
+
PaymentReportSummaryTotalCoupons: 'paymentReport.summary.totalCoupons',
|
|
23799
|
+
PaymentReportSummaryTotalVoucherForfeited: 'paymentReport.summary.totalVoucherForfeited',
|
|
23800
|
+
PaymentReportSummaryTotalTipAmount: 'paymentReport.summary.totalTipAmount',
|
|
23801
|
+
PaymentReportSummaryTotalSurchargeAmount: 'paymentReport.summary.totalSurchargeAmount',
|
|
23802
|
+
PaymentReportSummaryTotalRefunds: 'paymentReport.summary.totalRefunds',
|
|
23803
|
+
PaymentReportSummaryRefundCount: 'paymentReport.summary.refundCount',
|
|
23804
|
+
PaymentReportTotalDiscounts: 'paymentReport.totalDiscounts'
|
|
23805
|
+
} as const;
|
|
23806
|
+
|
|
23807
|
+
export type ReportChangeField = typeof ReportChangeField[keyof typeof ReportChangeField];
|
|
23808
|
+
|
|
23809
|
+
|
|
23493
23810
|
/**
|
|
23494
23811
|
*
|
|
23495
23812
|
* @export
|
|
@@ -23504,6 +23821,23 @@ export const ReportLanguage = {
|
|
|
23504
23821
|
export type ReportLanguage = typeof ReportLanguage[keyof typeof ReportLanguage];
|
|
23505
23822
|
|
|
23506
23823
|
|
|
23824
|
+
/**
|
|
23825
|
+
*
|
|
23826
|
+
* @export
|
|
23827
|
+
* @enum {string}
|
|
23828
|
+
*/
|
|
23829
|
+
|
|
23830
|
+
export const ReportPart = {
|
|
23831
|
+
Summary: 'summary',
|
|
23832
|
+
Items: 'items',
|
|
23833
|
+
Vat: 'vat',
|
|
23834
|
+
Payments: 'payments',
|
|
23835
|
+
Discounts: 'discounts'
|
|
23836
|
+
} as const;
|
|
23837
|
+
|
|
23838
|
+
export type ReportPart = typeof ReportPart[keyof typeof ReportPart];
|
|
23839
|
+
|
|
23840
|
+
|
|
23507
23841
|
/**
|
|
23508
23842
|
*
|
|
23509
23843
|
* @export
|
|
@@ -24029,6 +24363,1020 @@ export const SYNCKEY = {
|
|
|
24029
24363
|
export type SYNCKEY = typeof SYNCKEY[keyof typeof SYNCKEY];
|
|
24030
24364
|
|
|
24031
24365
|
|
|
24366
|
+
/**
|
|
24367
|
+
*
|
|
24368
|
+
* @export
|
|
24369
|
+
* @interface SalesReportCategoryDto
|
|
24370
|
+
*/
|
|
24371
|
+
export interface SalesReportCategoryDto {
|
|
24372
|
+
/**
|
|
24373
|
+
* The category\'s name
|
|
24374
|
+
* @type {string}
|
|
24375
|
+
* @memberof SalesReportCategoryDto
|
|
24376
|
+
*/
|
|
24377
|
+
'categoryName': string;
|
|
24378
|
+
/**
|
|
24379
|
+
* How many of its items were sold
|
|
24380
|
+
* @type {number}
|
|
24381
|
+
* @memberof SalesReportCategoryDto
|
|
24382
|
+
*/
|
|
24383
|
+
'totalQuantity': number;
|
|
24384
|
+
/**
|
|
24385
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24386
|
+
* @type {number}
|
|
24387
|
+
* @memberof SalesReportCategoryDto
|
|
24388
|
+
*/
|
|
24389
|
+
'totalWithTax': number;
|
|
24390
|
+
/**
|
|
24391
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24392
|
+
* @type {number}
|
|
24393
|
+
* @memberof SalesReportCategoryDto
|
|
24394
|
+
*/
|
|
24395
|
+
'taxAmount': number;
|
|
24396
|
+
/**
|
|
24397
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24398
|
+
* @type {number}
|
|
24399
|
+
* @memberof SalesReportCategoryDto
|
|
24400
|
+
*/
|
|
24401
|
+
'totalWithoutTax': number;
|
|
24402
|
+
/**
|
|
24403
|
+
* Its items
|
|
24404
|
+
* @type {Array<SalesReportItemDto>}
|
|
24405
|
+
* @memberof SalesReportCategoryDto
|
|
24406
|
+
*/
|
|
24407
|
+
'items': Array<SalesReportItemDto>;
|
|
24408
|
+
}
|
|
24409
|
+
/**
|
|
24410
|
+
*
|
|
24411
|
+
* @export
|
|
24412
|
+
* @interface SalesReportChangeDto
|
|
24413
|
+
*/
|
|
24414
|
+
export interface SalesReportChangeDto {
|
|
24415
|
+
/**
|
|
24416
|
+
*
|
|
24417
|
+
* @type {ReportChangeField}
|
|
24418
|
+
* @memberof SalesReportChangeDto
|
|
24419
|
+
*/
|
|
24420
|
+
'field': ReportChangeField;
|
|
24421
|
+
/**
|
|
24422
|
+
* The total of the asked period, as the group answers it; 0 when only the compared period has it. Money in the major unit of the group\'s currency (euros for EUR)
|
|
24423
|
+
* @type {number}
|
|
24424
|
+
* @memberof SalesReportChangeDto
|
|
24425
|
+
*/
|
|
24426
|
+
'current': number;
|
|
24427
|
+
/**
|
|
24428
|
+
* The total of the compared period, as comparison answers it; 0 when only the asked period has it. Money in the major unit of the group\'s currency (euros for EUR)
|
|
24429
|
+
* @type {number}
|
|
24430
|
+
* @memberof SalesReportChangeDto
|
|
24431
|
+
*/
|
|
24432
|
+
'previous': number;
|
|
24433
|
+
/**
|
|
24434
|
+
* current less previous, worked out in exact decimals, so it carries the digits both totals carry and no float error: to the minor unit for POS, every digit of v2\'s exact sums
|
|
24435
|
+
* @type {number}
|
|
24436
|
+
* @memberof SalesReportChangeDto
|
|
24437
|
+
*/
|
|
24438
|
+
'difference': number;
|
|
24439
|
+
/**
|
|
24440
|
+
* difference as a percent of previous, rounded half away from zero to 2 decimals; negative when the total fell. Null when previous is 0
|
|
24441
|
+
* @type {object}
|
|
24442
|
+
* @memberof SalesReportChangeDto
|
|
24443
|
+
*/
|
|
24444
|
+
'percent': object | null;
|
|
24445
|
+
}
|
|
24446
|
+
|
|
24447
|
+
|
|
24448
|
+
/**
|
|
24449
|
+
*
|
|
24450
|
+
* @export
|
|
24451
|
+
* @interface SalesReportComparisonDto
|
|
24452
|
+
*/
|
|
24453
|
+
export interface SalesReportComparisonDto {
|
|
24454
|
+
/**
|
|
24455
|
+
* The first instant of the compared period, ISO 8601 in UTC
|
|
24456
|
+
* @type {string}
|
|
24457
|
+
* @memberof SalesReportComparisonDto
|
|
24458
|
+
*/
|
|
24459
|
+
'reportDateStart': string;
|
|
24460
|
+
/**
|
|
24461
|
+
* The last instant of the compared period, ISO 8601 in UTC; now, when the period ends later
|
|
24462
|
+
* @type {string}
|
|
24463
|
+
* @memberof SalesReportComparisonDto
|
|
24464
|
+
*/
|
|
24465
|
+
'reportDateEnd': string;
|
|
24466
|
+
/**
|
|
24467
|
+
* The first business day compared, YYYY-MM-DD, in the report\'s time zone
|
|
24468
|
+
* @type {string}
|
|
24469
|
+
* @memberof SalesReportComparisonDto
|
|
24470
|
+
*/
|
|
24471
|
+
'firstBusinessDay': string;
|
|
24472
|
+
/**
|
|
24473
|
+
* The last business day compared, YYYY-MM-DD, inclusive
|
|
24474
|
+
* @type {string}
|
|
24475
|
+
* @memberof SalesReportComparisonDto
|
|
24476
|
+
*/
|
|
24477
|
+
'lastBusinessDay': string;
|
|
24478
|
+
/**
|
|
24479
|
+
*
|
|
24480
|
+
* @type {SalesReportComparisonDtoSalesReport}
|
|
24481
|
+
* @memberof SalesReportComparisonDto
|
|
24482
|
+
*/
|
|
24483
|
+
'salesReport'?: SalesReportComparisonDtoSalesReport;
|
|
24484
|
+
/**
|
|
24485
|
+
*
|
|
24486
|
+
* @type {SalesReportComparisonDtoPaymentReport}
|
|
24487
|
+
* @memberof SalesReportComparisonDto
|
|
24488
|
+
*/
|
|
24489
|
+
'paymentReport'?: SalesReportComparisonDtoPaymentReport;
|
|
24490
|
+
/**
|
|
24491
|
+
* The compared period\'s days that sold, oldest first, as the group\'s own dailyBreakdown: present when it is
|
|
24492
|
+
* @type {Array<SalesReportDayDto>}
|
|
24493
|
+
* @memberof SalesReportComparisonDto
|
|
24494
|
+
*/
|
|
24495
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
24496
|
+
/**
|
|
24497
|
+
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
24498
|
+
* @type {Array<SalesReportChangeDto>}
|
|
24499
|
+
* @memberof SalesReportComparisonDto
|
|
24500
|
+
*/
|
|
24501
|
+
'changes': Array<SalesReportChangeDto>;
|
|
24502
|
+
}
|
|
24503
|
+
/**
|
|
24504
|
+
* The compared period\'s paymentReport, as the group\'s own: present when it is
|
|
24505
|
+
* @export
|
|
24506
|
+
* @interface SalesReportComparisonDtoPaymentReport
|
|
24507
|
+
*/
|
|
24508
|
+
export interface SalesReportComparisonDtoPaymentReport {
|
|
24509
|
+
/**
|
|
24510
|
+
* Part payments: one row per payment method
|
|
24511
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
24512
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
24513
|
+
*/
|
|
24514
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
24515
|
+
/**
|
|
24516
|
+
*
|
|
24517
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
24518
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
24519
|
+
*/
|
|
24520
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
24521
|
+
/**
|
|
24522
|
+
* Part discounts: one row per discount
|
|
24523
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
24524
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
24525
|
+
*/
|
|
24526
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
24527
|
+
/**
|
|
24528
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
24529
|
+
* @type {number}
|
|
24530
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
24531
|
+
*/
|
|
24532
|
+
'totalDiscounts'?: number;
|
|
24533
|
+
}
|
|
24534
|
+
/**
|
|
24535
|
+
* The compared period\'s salesReport, as the group\'s own: present when it is
|
|
24536
|
+
* @export
|
|
24537
|
+
* @interface SalesReportComparisonDtoSalesReport
|
|
24538
|
+
*/
|
|
24539
|
+
export interface SalesReportComparisonDtoSalesReport {
|
|
24540
|
+
/**
|
|
24541
|
+
* Part items: the categories with their items
|
|
24542
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
24543
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24544
|
+
*/
|
|
24545
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
24546
|
+
/**
|
|
24547
|
+
* Part vat: one row per VAT rate, lowest first
|
|
24548
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
24549
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24550
|
+
*/
|
|
24551
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
24552
|
+
/**
|
|
24553
|
+
* Part summary: how many items were sold
|
|
24554
|
+
* @type {number}
|
|
24555
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24556
|
+
*/
|
|
24557
|
+
'totalQuantity'?: number;
|
|
24558
|
+
/**
|
|
24559
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24560
|
+
* @type {number}
|
|
24561
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24562
|
+
*/
|
|
24563
|
+
'totalWithTax'?: number;
|
|
24564
|
+
/**
|
|
24565
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24566
|
+
* @type {number}
|
|
24567
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24568
|
+
*/
|
|
24569
|
+
'totalTaxAmount'?: number;
|
|
24570
|
+
/**
|
|
24571
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24572
|
+
* @type {number}
|
|
24573
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24574
|
+
*/
|
|
24575
|
+
'totalWithoutTax'?: number;
|
|
24576
|
+
/**
|
|
24577
|
+
* Part summary, storefront and mobile: the delivery fees charged, in the major unit of the group\'s currency (euros for EUR); left out when none was
|
|
24578
|
+
* @type {number}
|
|
24579
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24580
|
+
*/
|
|
24581
|
+
'deliveryFee'?: number;
|
|
24582
|
+
/**
|
|
24583
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
24584
|
+
* @type {number}
|
|
24585
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24586
|
+
*/
|
|
24587
|
+
'deliveryTax'?: number;
|
|
24588
|
+
}
|
|
24589
|
+
/**
|
|
24590
|
+
*
|
|
24591
|
+
* @export
|
|
24592
|
+
* @interface SalesReportDayDto
|
|
24593
|
+
*/
|
|
24594
|
+
export interface SalesReportDayDto {
|
|
24595
|
+
/**
|
|
24596
|
+
* The business day, YYYY-MM-DD, in the venue\'s own time zone
|
|
24597
|
+
* @type {string}
|
|
24598
|
+
* @memberof SalesReportDayDto
|
|
24599
|
+
*/
|
|
24600
|
+
'date': string;
|
|
24601
|
+
/**
|
|
24602
|
+
* How many orders were sold that day
|
|
24603
|
+
* @type {number}
|
|
24604
|
+
* @memberof SalesReportDayDto
|
|
24605
|
+
*/
|
|
24606
|
+
'orders': number;
|
|
24607
|
+
/**
|
|
24608
|
+
* How many items were sold that day
|
|
24609
|
+
* @type {number}
|
|
24610
|
+
* @memberof SalesReportDayDto
|
|
24611
|
+
*/
|
|
24612
|
+
'quantity': number;
|
|
24613
|
+
/**
|
|
24614
|
+
* What was paid, before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
24615
|
+
* @type {number}
|
|
24616
|
+
* @memberof SalesReportDayDto
|
|
24617
|
+
*/
|
|
24618
|
+
'sales': number;
|
|
24619
|
+
/**
|
|
24620
|
+
* Refunds of that day\'s orders, in the major unit of the group\'s currency (euros for EUR)
|
|
24621
|
+
* @type {number}
|
|
24622
|
+
* @memberof SalesReportDayDto
|
|
24623
|
+
*/
|
|
24624
|
+
'refunds': number;
|
|
24625
|
+
/**
|
|
24626
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
24627
|
+
* @type {number}
|
|
24628
|
+
* @memberof SalesReportDayDto
|
|
24629
|
+
*/
|
|
24630
|
+
'net': number;
|
|
24631
|
+
/**
|
|
24632
|
+
* Discounts given that day, in the major unit of the group\'s currency (euros for EUR)
|
|
24633
|
+
* @type {number}
|
|
24634
|
+
* @memberof SalesReportDayDto
|
|
24635
|
+
*/
|
|
24636
|
+
'discounts': number;
|
|
24637
|
+
/**
|
|
24638
|
+
* The VAT of the items sold that day, in the major unit of the group\'s currency (euros for EUR)
|
|
24639
|
+
* @type {number}
|
|
24640
|
+
* @memberof SalesReportDayDto
|
|
24641
|
+
*/
|
|
24642
|
+
'taxAmount': number;
|
|
24643
|
+
}
|
|
24644
|
+
/**
|
|
24645
|
+
*
|
|
24646
|
+
* @export
|
|
24647
|
+
* @interface SalesReportDiscountDto
|
|
24648
|
+
*/
|
|
24649
|
+
export interface SalesReportDiscountDto {
|
|
24650
|
+
/**
|
|
24651
|
+
* The discount\'s name
|
|
24652
|
+
* @type {string}
|
|
24653
|
+
* @memberof SalesReportDiscountDto
|
|
24654
|
+
*/
|
|
24655
|
+
'discountName': string;
|
|
24656
|
+
/**
|
|
24657
|
+
* How many times it was given
|
|
24658
|
+
* @type {number}
|
|
24659
|
+
* @memberof SalesReportDiscountDto
|
|
24660
|
+
*/
|
|
24661
|
+
'count': number;
|
|
24662
|
+
/**
|
|
24663
|
+
* What it took off, in the major unit of the group\'s currency (euros for EUR)
|
|
24664
|
+
* @type {number}
|
|
24665
|
+
* @memberof SalesReportDiscountDto
|
|
24666
|
+
*/
|
|
24667
|
+
'amount': number;
|
|
24668
|
+
}
|
|
24669
|
+
/**
|
|
24670
|
+
*
|
|
24671
|
+
* @export
|
|
24672
|
+
* @interface SalesReportGroupDto
|
|
24673
|
+
*/
|
|
24674
|
+
export interface SalesReportGroupDto {
|
|
24675
|
+
/**
|
|
24676
|
+
* The venue\'s business id; null when the breakdown adds venues together (none, app)
|
|
24677
|
+
* @type {object}
|
|
24678
|
+
* @memberof SalesReportGroupDto
|
|
24679
|
+
*/
|
|
24680
|
+
'businessId': object | null;
|
|
24681
|
+
/**
|
|
24682
|
+
*
|
|
24683
|
+
* @type {ReportApp}
|
|
24684
|
+
* @memberof SalesReportGroupDto
|
|
24685
|
+
*/
|
|
24686
|
+
'app': ReportApp | null;
|
|
24687
|
+
/**
|
|
24688
|
+
*
|
|
24689
|
+
* @type {CurrencyCode}
|
|
24690
|
+
* @memberof SalesReportGroupDto
|
|
24691
|
+
*/
|
|
24692
|
+
'currency': CurrencyCode;
|
|
24693
|
+
/**
|
|
24694
|
+
* The currency\'s ISO 4217 minor digits: EUR 2, ISK 0, BHD 3
|
|
24695
|
+
* @type {number}
|
|
24696
|
+
* @memberof SalesReportGroupDto
|
|
24697
|
+
*/
|
|
24698
|
+
'minorDigits': number;
|
|
24699
|
+
/**
|
|
24700
|
+
*
|
|
24701
|
+
* @type {SalesReportGroupDtoSalesReport}
|
|
24702
|
+
* @memberof SalesReportGroupDto
|
|
24703
|
+
*/
|
|
24704
|
+
'salesReport'?: SalesReportGroupDtoSalesReport;
|
|
24705
|
+
/**
|
|
24706
|
+
*
|
|
24707
|
+
* @type {SalesReportGroupDtoPaymentReport}
|
|
24708
|
+
* @memberof SalesReportGroupDto
|
|
24709
|
+
*/
|
|
24710
|
+
'paymentReport'?: SalesReportGroupDtoPaymentReport;
|
|
24711
|
+
/**
|
|
24712
|
+
* Part summary: one row per business day that sold, oldest first. POS leaves it out when no day sold
|
|
24713
|
+
* @type {Array<SalesReportDayDto>}
|
|
24714
|
+
* @memberof SalesReportGroupDto
|
|
24715
|
+
*/
|
|
24716
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
24717
|
+
/**
|
|
24718
|
+
*
|
|
24719
|
+
* @type {SalesReportGroupDtoComparison}
|
|
24720
|
+
* @memberof SalesReportGroupDto
|
|
24721
|
+
*/
|
|
24722
|
+
'comparison'?: SalesReportGroupDtoComparison;
|
|
24723
|
+
/**
|
|
24724
|
+
* With baseline, every group but the baseline: the change of each total from the baseline group of the same currency (current: this group; previous: the baseline), of the main period only, worked out exactly
|
|
24725
|
+
* @type {Array<SalesReportChangeDto>}
|
|
24726
|
+
* @memberof SalesReportGroupDto
|
|
24727
|
+
*/
|
|
24728
|
+
'changesFromBaseline'?: Array<SalesReportChangeDto>;
|
|
24729
|
+
/**
|
|
24730
|
+
*
|
|
24731
|
+
* @type {ReportBaselineLeftOut}
|
|
24732
|
+
* @memberof SalesReportGroupDto
|
|
24733
|
+
*/
|
|
24734
|
+
'changesFromBaselineLeftOut'?: ReportBaselineLeftOut;
|
|
24735
|
+
}
|
|
24736
|
+
|
|
24737
|
+
|
|
24738
|
+
/**
|
|
24739
|
+
* With compareStart and compareEnd: the same group\'s report of those days and the change of each total. Left out without them
|
|
24740
|
+
* @export
|
|
24741
|
+
* @interface SalesReportGroupDtoComparison
|
|
24742
|
+
*/
|
|
24743
|
+
export interface SalesReportGroupDtoComparison {
|
|
24744
|
+
/**
|
|
24745
|
+
* The first instant of the compared period, ISO 8601 in UTC
|
|
24746
|
+
* @type {string}
|
|
24747
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24748
|
+
*/
|
|
24749
|
+
'reportDateStart': string;
|
|
24750
|
+
/**
|
|
24751
|
+
* The last instant of the compared period, ISO 8601 in UTC; now, when the period ends later
|
|
24752
|
+
* @type {string}
|
|
24753
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24754
|
+
*/
|
|
24755
|
+
'reportDateEnd': string;
|
|
24756
|
+
/**
|
|
24757
|
+
* The first business day compared, YYYY-MM-DD, in the report\'s time zone
|
|
24758
|
+
* @type {string}
|
|
24759
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24760
|
+
*/
|
|
24761
|
+
'firstBusinessDay': string;
|
|
24762
|
+
/**
|
|
24763
|
+
* The last business day compared, YYYY-MM-DD, inclusive
|
|
24764
|
+
* @type {string}
|
|
24765
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24766
|
+
*/
|
|
24767
|
+
'lastBusinessDay': string;
|
|
24768
|
+
/**
|
|
24769
|
+
*
|
|
24770
|
+
* @type {SalesReportComparisonDtoSalesReport}
|
|
24771
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24772
|
+
*/
|
|
24773
|
+
'salesReport'?: SalesReportComparisonDtoSalesReport;
|
|
24774
|
+
/**
|
|
24775
|
+
*
|
|
24776
|
+
* @type {SalesReportComparisonDtoPaymentReport}
|
|
24777
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24778
|
+
*/
|
|
24779
|
+
'paymentReport'?: SalesReportComparisonDtoPaymentReport;
|
|
24780
|
+
/**
|
|
24781
|
+
* The compared period\'s days that sold, oldest first, as the group\'s own dailyBreakdown: present when it is
|
|
24782
|
+
* @type {Array<SalesReportDayDto>}
|
|
24783
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24784
|
+
*/
|
|
24785
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
24786
|
+
/**
|
|
24787
|
+
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
24788
|
+
* @type {Array<SalesReportChangeDto>}
|
|
24789
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24790
|
+
*/
|
|
24791
|
+
'changes': Array<SalesReportChangeDto>;
|
|
24792
|
+
}
|
|
24793
|
+
/**
|
|
24794
|
+
* The portal\'s paymentReport for the group: present when part summary, payments or discounts was asked
|
|
24795
|
+
* @export
|
|
24796
|
+
* @interface SalesReportGroupDtoPaymentReport
|
|
24797
|
+
*/
|
|
24798
|
+
export interface SalesReportGroupDtoPaymentReport {
|
|
24799
|
+
/**
|
|
24800
|
+
* Part payments: one row per payment method
|
|
24801
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
24802
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24803
|
+
*/
|
|
24804
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
24805
|
+
/**
|
|
24806
|
+
*
|
|
24807
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
24808
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24809
|
+
*/
|
|
24810
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
24811
|
+
/**
|
|
24812
|
+
* Part discounts: one row per discount
|
|
24813
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
24814
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24815
|
+
*/
|
|
24816
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
24817
|
+
/**
|
|
24818
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
24819
|
+
* @type {number}
|
|
24820
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24821
|
+
*/
|
|
24822
|
+
'totalDiscounts'?: number;
|
|
24823
|
+
}
|
|
24824
|
+
/**
|
|
24825
|
+
* The portal\'s salesReport for the group: present when part summary, items or vat was asked. One app answers as its portal report does (POS as report-service, kiosk, storefront and mobile as dashboard v2); several apps added together answer as v2
|
|
24826
|
+
* @export
|
|
24827
|
+
* @interface SalesReportGroupDtoSalesReport
|
|
24828
|
+
*/
|
|
24829
|
+
export interface SalesReportGroupDtoSalesReport {
|
|
24830
|
+
/**
|
|
24831
|
+
* Part items: the categories with their items
|
|
24832
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
24833
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24834
|
+
*/
|
|
24835
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
24836
|
+
/**
|
|
24837
|
+
* Part vat: one row per VAT rate, lowest first
|
|
24838
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
24839
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24840
|
+
*/
|
|
24841
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
24842
|
+
/**
|
|
24843
|
+
* Part summary: how many items were sold
|
|
24844
|
+
* @type {number}
|
|
24845
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24846
|
+
*/
|
|
24847
|
+
'totalQuantity'?: number;
|
|
24848
|
+
/**
|
|
24849
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24850
|
+
* @type {number}
|
|
24851
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24852
|
+
*/
|
|
24853
|
+
'totalWithTax'?: number;
|
|
24854
|
+
/**
|
|
24855
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24856
|
+
* @type {number}
|
|
24857
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24858
|
+
*/
|
|
24859
|
+
'totalTaxAmount'?: number;
|
|
24860
|
+
/**
|
|
24861
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24862
|
+
* @type {number}
|
|
24863
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24864
|
+
*/
|
|
24865
|
+
'totalWithoutTax'?: number;
|
|
24866
|
+
/**
|
|
24867
|
+
* Part summary, storefront and mobile: the delivery fees charged, in the major unit of the group\'s currency (euros for EUR); left out when none was
|
|
24868
|
+
* @type {number}
|
|
24869
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24870
|
+
*/
|
|
24871
|
+
'deliveryFee'?: number;
|
|
24872
|
+
/**
|
|
24873
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
24874
|
+
* @type {number}
|
|
24875
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24876
|
+
*/
|
|
24877
|
+
'deliveryTax'?: number;
|
|
24878
|
+
}
|
|
24879
|
+
/**
|
|
24880
|
+
*
|
|
24881
|
+
* @export
|
|
24882
|
+
* @interface SalesReportItemDto
|
|
24883
|
+
*/
|
|
24884
|
+
export interface SalesReportItemDto {
|
|
24885
|
+
/**
|
|
24886
|
+
* The item\'s name. POS: its first sale\'s name and VAT rate, as the portal shows it
|
|
24887
|
+
* @type {object}
|
|
24888
|
+
* @memberof SalesReportItemDto
|
|
24889
|
+
*/
|
|
24890
|
+
'name': object | null;
|
|
24891
|
+
/**
|
|
24892
|
+
* The product\'s id; null when the sale carried none
|
|
24893
|
+
* @type {object}
|
|
24894
|
+
* @memberof SalesReportItemDto
|
|
24895
|
+
*/
|
|
24896
|
+
'productId': object | null;
|
|
24897
|
+
/**
|
|
24898
|
+
* How many were sold
|
|
24899
|
+
* @type {number}
|
|
24900
|
+
* @memberof SalesReportItemDto
|
|
24901
|
+
*/
|
|
24902
|
+
'quantity': number;
|
|
24903
|
+
/**
|
|
24904
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24905
|
+
* @type {number}
|
|
24906
|
+
* @memberof SalesReportItemDto
|
|
24907
|
+
*/
|
|
24908
|
+
'totalWithTax': number;
|
|
24909
|
+
/**
|
|
24910
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24911
|
+
* @type {number}
|
|
24912
|
+
* @memberof SalesReportItemDto
|
|
24913
|
+
*/
|
|
24914
|
+
'taxAmount': number;
|
|
24915
|
+
/**
|
|
24916
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24917
|
+
* @type {number}
|
|
24918
|
+
* @memberof SalesReportItemDto
|
|
24919
|
+
*/
|
|
24920
|
+
'totalWithoutTax': number;
|
|
24921
|
+
/**
|
|
24922
|
+
* The VAT rate in percent; null when none was recorded
|
|
24923
|
+
* @type {object}
|
|
24924
|
+
* @memberof SalesReportItemDto
|
|
24925
|
+
*/
|
|
24926
|
+
'taxRate': object | null;
|
|
24927
|
+
/**
|
|
24928
|
+
* The options sold with the item; left out when none was
|
|
24929
|
+
* @type {Array<SalesReportOptionDto>}
|
|
24930
|
+
* @memberof SalesReportItemDto
|
|
24931
|
+
*/
|
|
24932
|
+
'subOptions'?: Array<SalesReportOptionDto>;
|
|
24933
|
+
}
|
|
24934
|
+
/**
|
|
24935
|
+
*
|
|
24936
|
+
* @export
|
|
24937
|
+
* @interface SalesReportOptionDto
|
|
24938
|
+
*/
|
|
24939
|
+
export interface SalesReportOptionDto {
|
|
24940
|
+
/**
|
|
24941
|
+
* The option\'s name
|
|
24942
|
+
* @type {string}
|
|
24943
|
+
* @memberof SalesReportOptionDto
|
|
24944
|
+
*/
|
|
24945
|
+
'name': string;
|
|
24946
|
+
/**
|
|
24947
|
+
* How many were sold
|
|
24948
|
+
* @type {number}
|
|
24949
|
+
* @memberof SalesReportOptionDto
|
|
24950
|
+
*/
|
|
24951
|
+
'quantity': number;
|
|
24952
|
+
/**
|
|
24953
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24954
|
+
* @type {number}
|
|
24955
|
+
* @memberof SalesReportOptionDto
|
|
24956
|
+
*/
|
|
24957
|
+
'totalWithTax': number;
|
|
24958
|
+
/**
|
|
24959
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24960
|
+
* @type {number}
|
|
24961
|
+
* @memberof SalesReportOptionDto
|
|
24962
|
+
*/
|
|
24963
|
+
'taxAmount': number;
|
|
24964
|
+
/**
|
|
24965
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24966
|
+
* @type {number}
|
|
24967
|
+
* @memberof SalesReportOptionDto
|
|
24968
|
+
*/
|
|
24969
|
+
'totalWithoutTax': number;
|
|
24970
|
+
/**
|
|
24971
|
+
* The VAT rate in percent; null when none was recorded
|
|
24972
|
+
* @type {object}
|
|
24973
|
+
* @memberof SalesReportOptionDto
|
|
24974
|
+
*/
|
|
24975
|
+
'taxRate': object | null;
|
|
24976
|
+
}
|
|
24977
|
+
/**
|
|
24978
|
+
*
|
|
24979
|
+
* @export
|
|
24980
|
+
* @interface SalesReportPaymentMethodDto
|
|
24981
|
+
*/
|
|
24982
|
+
export interface SalesReportPaymentMethodDto {
|
|
24983
|
+
/**
|
|
24984
|
+
* The payment method, as the app records it
|
|
24985
|
+
* @type {string}
|
|
24986
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24987
|
+
*/
|
|
24988
|
+
'paymentMethod': string;
|
|
24989
|
+
/**
|
|
24990
|
+
* How many payments were made with it
|
|
24991
|
+
* @type {number}
|
|
24992
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24993
|
+
*/
|
|
24994
|
+
'count': number;
|
|
24995
|
+
/**
|
|
24996
|
+
* What was paid with it, in the major unit of the group\'s currency (euros for EUR)
|
|
24997
|
+
* @type {number}
|
|
24998
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24999
|
+
*/
|
|
25000
|
+
'amount': number;
|
|
25001
|
+
}
|
|
25002
|
+
/**
|
|
25003
|
+
*
|
|
25004
|
+
* @export
|
|
25005
|
+
* @interface SalesReportPaymentSummaryDto
|
|
25006
|
+
*/
|
|
25007
|
+
export interface SalesReportPaymentSummaryDto {
|
|
25008
|
+
/**
|
|
25009
|
+
* Tips, in the major unit of the group\'s currency (euros for EUR)
|
|
25010
|
+
* @type {number}
|
|
25011
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25012
|
+
*/
|
|
25013
|
+
'totalTipAmount': number;
|
|
25014
|
+
/**
|
|
25015
|
+
* Surcharges, in the major unit of the group\'s currency (euros for EUR)
|
|
25016
|
+
* @type {number}
|
|
25017
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25018
|
+
*/
|
|
25019
|
+
'totalSurchargeAmount': number;
|
|
25020
|
+
/**
|
|
25021
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
25022
|
+
* @type {number}
|
|
25023
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25024
|
+
*/
|
|
25025
|
+
'salesAndRevenue': number;
|
|
25026
|
+
/**
|
|
25027
|
+
* How many card payments were made
|
|
25028
|
+
* @type {number}
|
|
25029
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25030
|
+
*/
|
|
25031
|
+
'cardsCount': number;
|
|
25032
|
+
/**
|
|
25033
|
+
* What was paid by card, in the major unit of the group\'s currency (euros for EUR)
|
|
25034
|
+
* @type {number}
|
|
25035
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25036
|
+
*/
|
|
25037
|
+
'cardsAmount': number;
|
|
25038
|
+
/**
|
|
25039
|
+
* How many Edenred vouchers were paid with
|
|
25040
|
+
* @type {number}
|
|
25041
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25042
|
+
*/
|
|
25043
|
+
'edenredVoucherCount': number;
|
|
25044
|
+
/**
|
|
25045
|
+
* What was paid with Edenred vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
25046
|
+
* @type {number}
|
|
25047
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25048
|
+
*/
|
|
25049
|
+
'edenredVoucherAmount': number;
|
|
25050
|
+
/**
|
|
25051
|
+
* How many Smartum vouchers were paid with
|
|
25052
|
+
* @type {number}
|
|
25053
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25054
|
+
*/
|
|
25055
|
+
'smartumVoucherCount': number;
|
|
25056
|
+
/**
|
|
25057
|
+
* What was paid with Smartum vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
25058
|
+
* @type {number}
|
|
25059
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25060
|
+
*/
|
|
25061
|
+
'smartumVoucherAmount': number;
|
|
25062
|
+
/**
|
|
25063
|
+
* How many payments were made
|
|
25064
|
+
* @type {number}
|
|
25065
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25066
|
+
*/
|
|
25067
|
+
'totalCount': number;
|
|
25068
|
+
/**
|
|
25069
|
+
* The same as salesAndRevenue, in the major unit of the group\'s currency (euros for EUR)
|
|
25070
|
+
* @type {number}
|
|
25071
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25072
|
+
*/
|
|
25073
|
+
'totalAmount': number;
|
|
25074
|
+
/**
|
|
25075
|
+
* Always 0: no app records coupons here
|
|
25076
|
+
* @type {number}
|
|
25077
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25078
|
+
*/
|
|
25079
|
+
'totalCoupons': number;
|
|
25080
|
+
/**
|
|
25081
|
+
* Vouchers\' leftover that was not given back, in the major unit of the group\'s currency (euros for EUR)
|
|
25082
|
+
* @type {number}
|
|
25083
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25084
|
+
*/
|
|
25085
|
+
'totalVoucherForfeited': number;
|
|
25086
|
+
/**
|
|
25087
|
+
* POS only: what was paid before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
25088
|
+
* @type {number}
|
|
25089
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25090
|
+
*/
|
|
25091
|
+
'grossAmount'?: number;
|
|
25092
|
+
/**
|
|
25093
|
+
* Refunds, in the major unit of the group\'s currency (euros for EUR), on the day of the order they refund
|
|
25094
|
+
* @type {number}
|
|
25095
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25096
|
+
*/
|
|
25097
|
+
'totalRefunds': number;
|
|
25098
|
+
/**
|
|
25099
|
+
* How many refunds were made
|
|
25100
|
+
* @type {number}
|
|
25101
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25102
|
+
*/
|
|
25103
|
+
'refundCount': number;
|
|
25104
|
+
}
|
|
25105
|
+
/**
|
|
25106
|
+
*
|
|
25107
|
+
* @export
|
|
25108
|
+
* @interface SalesReportPaymentsDto
|
|
25109
|
+
*/
|
|
25110
|
+
export interface SalesReportPaymentsDto {
|
|
25111
|
+
/**
|
|
25112
|
+
* Part payments: one row per payment method
|
|
25113
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
25114
|
+
* @memberof SalesReportPaymentsDto
|
|
25115
|
+
*/
|
|
25116
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
25117
|
+
/**
|
|
25118
|
+
*
|
|
25119
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
25120
|
+
* @memberof SalesReportPaymentsDto
|
|
25121
|
+
*/
|
|
25122
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
25123
|
+
/**
|
|
25124
|
+
* Part discounts: one row per discount
|
|
25125
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
25126
|
+
* @memberof SalesReportPaymentsDto
|
|
25127
|
+
*/
|
|
25128
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
25129
|
+
/**
|
|
25130
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
25131
|
+
* @type {number}
|
|
25132
|
+
* @memberof SalesReportPaymentsDto
|
|
25133
|
+
*/
|
|
25134
|
+
'totalDiscounts'?: number;
|
|
25135
|
+
}
|
|
25136
|
+
/**
|
|
25137
|
+
* Part summary: the payment totals
|
|
25138
|
+
* @export
|
|
25139
|
+
* @interface SalesReportPaymentsDtoSummary
|
|
25140
|
+
*/
|
|
25141
|
+
export interface SalesReportPaymentsDtoSummary {
|
|
25142
|
+
/**
|
|
25143
|
+
* Tips, in the major unit of the group\'s currency (euros for EUR)
|
|
25144
|
+
* @type {number}
|
|
25145
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25146
|
+
*/
|
|
25147
|
+
'totalTipAmount': number;
|
|
25148
|
+
/**
|
|
25149
|
+
* Surcharges, in the major unit of the group\'s currency (euros for EUR)
|
|
25150
|
+
* @type {number}
|
|
25151
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25152
|
+
*/
|
|
25153
|
+
'totalSurchargeAmount': number;
|
|
25154
|
+
/**
|
|
25155
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
25156
|
+
* @type {number}
|
|
25157
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25158
|
+
*/
|
|
25159
|
+
'salesAndRevenue': number;
|
|
25160
|
+
/**
|
|
25161
|
+
* How many card payments were made
|
|
25162
|
+
* @type {number}
|
|
25163
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25164
|
+
*/
|
|
25165
|
+
'cardsCount': number;
|
|
25166
|
+
/**
|
|
25167
|
+
* What was paid by card, in the major unit of the group\'s currency (euros for EUR)
|
|
25168
|
+
* @type {number}
|
|
25169
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25170
|
+
*/
|
|
25171
|
+
'cardsAmount': number;
|
|
25172
|
+
/**
|
|
25173
|
+
* How many Edenred vouchers were paid with
|
|
25174
|
+
* @type {number}
|
|
25175
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25176
|
+
*/
|
|
25177
|
+
'edenredVoucherCount': number;
|
|
25178
|
+
/**
|
|
25179
|
+
* What was paid with Edenred vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
25180
|
+
* @type {number}
|
|
25181
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25182
|
+
*/
|
|
25183
|
+
'edenredVoucherAmount': number;
|
|
25184
|
+
/**
|
|
25185
|
+
* How many Smartum vouchers were paid with
|
|
25186
|
+
* @type {number}
|
|
25187
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25188
|
+
*/
|
|
25189
|
+
'smartumVoucherCount': number;
|
|
25190
|
+
/**
|
|
25191
|
+
* What was paid with Smartum vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
25192
|
+
* @type {number}
|
|
25193
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25194
|
+
*/
|
|
25195
|
+
'smartumVoucherAmount': number;
|
|
25196
|
+
/**
|
|
25197
|
+
* How many payments were made
|
|
25198
|
+
* @type {number}
|
|
25199
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25200
|
+
*/
|
|
25201
|
+
'totalCount': number;
|
|
25202
|
+
/**
|
|
25203
|
+
* The same as salesAndRevenue, in the major unit of the group\'s currency (euros for EUR)
|
|
25204
|
+
* @type {number}
|
|
25205
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25206
|
+
*/
|
|
25207
|
+
'totalAmount': number;
|
|
25208
|
+
/**
|
|
25209
|
+
* Always 0: no app records coupons here
|
|
25210
|
+
* @type {number}
|
|
25211
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25212
|
+
*/
|
|
25213
|
+
'totalCoupons': number;
|
|
25214
|
+
/**
|
|
25215
|
+
* Vouchers\' leftover that was not given back, in the major unit of the group\'s currency (euros for EUR)
|
|
25216
|
+
* @type {number}
|
|
25217
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25218
|
+
*/
|
|
25219
|
+
'totalVoucherForfeited': number;
|
|
25220
|
+
/**
|
|
25221
|
+
* POS only: what was paid before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
25222
|
+
* @type {number}
|
|
25223
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25224
|
+
*/
|
|
25225
|
+
'grossAmount'?: number;
|
|
25226
|
+
/**
|
|
25227
|
+
* Refunds, in the major unit of the group\'s currency (euros for EUR), on the day of the order they refund
|
|
25228
|
+
* @type {number}
|
|
25229
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25230
|
+
*/
|
|
25231
|
+
'totalRefunds': number;
|
|
25232
|
+
/**
|
|
25233
|
+
* How many refunds were made
|
|
25234
|
+
* @type {number}
|
|
25235
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25236
|
+
*/
|
|
25237
|
+
'refundCount': number;
|
|
25238
|
+
}
|
|
25239
|
+
/**
|
|
25240
|
+
*
|
|
25241
|
+
* @export
|
|
25242
|
+
* @interface SalesReportResponseDto
|
|
25243
|
+
*/
|
|
25244
|
+
export interface SalesReportResponseDto {
|
|
25245
|
+
/**
|
|
25246
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
25247
|
+
* @type {string}
|
|
25248
|
+
* @memberof SalesReportResponseDto
|
|
25249
|
+
*/
|
|
25250
|
+
'reportDateStart': string;
|
|
25251
|
+
/**
|
|
25252
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
25253
|
+
* @type {string}
|
|
25254
|
+
* @memberof SalesReportResponseDto
|
|
25255
|
+
*/
|
|
25256
|
+
'reportDateEnd': string;
|
|
25257
|
+
/**
|
|
25258
|
+
* When the report was answered, ISO 8601 in UTC
|
|
25259
|
+
* @type {string}
|
|
25260
|
+
* @memberof SalesReportResponseDto
|
|
25261
|
+
*/
|
|
25262
|
+
'reportGeneratedAt': string;
|
|
25263
|
+
/**
|
|
25264
|
+
* The time zone the period was read in: the request\'s, or else the first venue\'s
|
|
25265
|
+
* @type {string}
|
|
25266
|
+
* @memberof SalesReportResponseDto
|
|
25267
|
+
*/
|
|
25268
|
+
'timezone': string;
|
|
25269
|
+
/**
|
|
25270
|
+
* The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
|
|
25271
|
+
* @type {string}
|
|
25272
|
+
* @memberof SalesReportResponseDto
|
|
25273
|
+
*/
|
|
25274
|
+
'firstBusinessDay': string;
|
|
25275
|
+
/**
|
|
25276
|
+
* The last business day added up, YYYY-MM-DD, inclusive
|
|
25277
|
+
* @type {string}
|
|
25278
|
+
* @memberof SalesReportResponseDto
|
|
25279
|
+
*/
|
|
25280
|
+
'lastBusinessDay': string;
|
|
25281
|
+
/**
|
|
25282
|
+
* When the newest daily rows this report reads were rebuilt; a sale after it may not be counted yet (they are rebuilt every 5 minutes). Null when none were ever loaded
|
|
25283
|
+
* @type {object}
|
|
25284
|
+
* @memberof SalesReportResponseDto
|
|
25285
|
+
*/
|
|
25286
|
+
'dataUntil': object | null;
|
|
25287
|
+
/**
|
|
25288
|
+
* One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
|
|
25289
|
+
* @type {Array<SalesReportGroupDto>}
|
|
25290
|
+
* @memberof SalesReportResponseDto
|
|
25291
|
+
*/
|
|
25292
|
+
'reports': Array<SalesReportGroupDto>;
|
|
25293
|
+
}
|
|
25294
|
+
/**
|
|
25295
|
+
*
|
|
25296
|
+
* @export
|
|
25297
|
+
* @interface SalesReportSalesDto
|
|
25298
|
+
*/
|
|
25299
|
+
export interface SalesReportSalesDto {
|
|
25300
|
+
/**
|
|
25301
|
+
* Part items: the categories with their items
|
|
25302
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
25303
|
+
* @memberof SalesReportSalesDto
|
|
25304
|
+
*/
|
|
25305
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
25306
|
+
/**
|
|
25307
|
+
* Part vat: one row per VAT rate, lowest first
|
|
25308
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
25309
|
+
* @memberof SalesReportSalesDto
|
|
25310
|
+
*/
|
|
25311
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
25312
|
+
/**
|
|
25313
|
+
* Part summary: how many items were sold
|
|
25314
|
+
* @type {number}
|
|
25315
|
+
* @memberof SalesReportSalesDto
|
|
25316
|
+
*/
|
|
25317
|
+
'totalQuantity'?: number;
|
|
25318
|
+
/**
|
|
25319
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
25320
|
+
* @type {number}
|
|
25321
|
+
* @memberof SalesReportSalesDto
|
|
25322
|
+
*/
|
|
25323
|
+
'totalWithTax'?: number;
|
|
25324
|
+
/**
|
|
25325
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
25326
|
+
* @type {number}
|
|
25327
|
+
* @memberof SalesReportSalesDto
|
|
25328
|
+
*/
|
|
25329
|
+
'totalTaxAmount'?: number;
|
|
25330
|
+
/**
|
|
25331
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
25332
|
+
* @type {number}
|
|
25333
|
+
* @memberof SalesReportSalesDto
|
|
25334
|
+
*/
|
|
25335
|
+
'totalWithoutTax'?: number;
|
|
25336
|
+
/**
|
|
25337
|
+
* Part summary, storefront and mobile: the delivery fees charged, in the major unit of the group\'s currency (euros for EUR); left out when none was
|
|
25338
|
+
* @type {number}
|
|
25339
|
+
* @memberof SalesReportSalesDto
|
|
25340
|
+
*/
|
|
25341
|
+
'deliveryFee'?: number;
|
|
25342
|
+
/**
|
|
25343
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
25344
|
+
* @type {number}
|
|
25345
|
+
* @memberof SalesReportSalesDto
|
|
25346
|
+
*/
|
|
25347
|
+
'deliveryTax'?: number;
|
|
25348
|
+
}
|
|
25349
|
+
/**
|
|
25350
|
+
*
|
|
25351
|
+
* @export
|
|
25352
|
+
* @interface SalesReportVatRateDto
|
|
25353
|
+
*/
|
|
25354
|
+
export interface SalesReportVatRateDto {
|
|
25355
|
+
/**
|
|
25356
|
+
* The VAT rate in percent
|
|
25357
|
+
* @type {number}
|
|
25358
|
+
* @memberof SalesReportVatRateDto
|
|
25359
|
+
*/
|
|
25360
|
+
'taxRate': number;
|
|
25361
|
+
/**
|
|
25362
|
+
* Sales with VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
25363
|
+
* @type {number}
|
|
25364
|
+
* @memberof SalesReportVatRateDto
|
|
25365
|
+
*/
|
|
25366
|
+
'totalWithTax': number;
|
|
25367
|
+
/**
|
|
25368
|
+
* The VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
25369
|
+
* @type {number}
|
|
25370
|
+
* @memberof SalesReportVatRateDto
|
|
25371
|
+
*/
|
|
25372
|
+
'taxAmount': number;
|
|
25373
|
+
/**
|
|
25374
|
+
* Sales without VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
25375
|
+
* @type {number}
|
|
25376
|
+
* @memberof SalesReportVatRateDto
|
|
25377
|
+
*/
|
|
25378
|
+
'totalWithoutTax': number;
|
|
25379
|
+
}
|
|
24032
25380
|
/**
|
|
24033
25381
|
*
|
|
24034
25382
|
* @export
|
|
@@ -29338,6 +30686,19 @@ export interface UpdateProductSkuDto {
|
|
|
29338
30686
|
*/
|
|
29339
30687
|
'sku': string;
|
|
29340
30688
|
}
|
|
30689
|
+
/**
|
|
30690
|
+
*
|
|
30691
|
+
* @export
|
|
30692
|
+
* @interface UpdateProductSkusDto
|
|
30693
|
+
*/
|
|
30694
|
+
export interface UpdateProductSkusDto {
|
|
30695
|
+
/**
|
|
30696
|
+
* Every SKU (label code) of the product, in order; they replace the ones it has. Each is trimmed, must keep one character and holds at most 255 characters. An empty list removes every SKU. A SKU is unique within the venue, compared without case
|
|
30697
|
+
* @type {Array<string>}
|
|
30698
|
+
* @memberof UpdateProductSkusDto
|
|
30699
|
+
*/
|
|
30700
|
+
'skus': Array<string>;
|
|
30701
|
+
}
|
|
29341
30702
|
/**
|
|
29342
30703
|
*
|
|
29343
30704
|
* @export
|
|
@@ -29462,6 +30823,30 @@ export interface UpdateReservationPolicyDto {
|
|
|
29462
30823
|
* @memberof UpdateReservationPolicyDto
|
|
29463
30824
|
*/
|
|
29464
30825
|
'maxOnlinePartySize'?: number;
|
|
30826
|
+
/**
|
|
30827
|
+
* The smallest party offered slots online; 1 on create when absent
|
|
30828
|
+
* @type {number}
|
|
30829
|
+
* @memberof UpdateReservationPolicyDto
|
|
30830
|
+
*/
|
|
30831
|
+
'minPartySize'?: number;
|
|
30832
|
+
/**
|
|
30833
|
+
* How many days after today a guest may book: a later day offers no slots; 60 on create when absent
|
|
30834
|
+
* @type {number}
|
|
30835
|
+
* @memberof UpdateReservationPolicyDto
|
|
30836
|
+
*/
|
|
30837
|
+
'maxHorizonDays'?: number;
|
|
30838
|
+
/**
|
|
30839
|
+
* The last seating: no slot starts later than this many minutes before each opening closes; 0 (only the turn must fit) on create when absent
|
|
30840
|
+
* @type {number}
|
|
30841
|
+
* @memberof UpdateReservationPolicyDto
|
|
30842
|
+
*/
|
|
30843
|
+
'cutoffMins'?: number;
|
|
30844
|
+
/**
|
|
30845
|
+
* Minutes a table is held, by party size; a party size missing here takes defaultTurnTimeMins. Replaces the whole table when sent, {} clears it; {} on create when absent
|
|
30846
|
+
* @type {{ [key: string]: number; }}
|
|
30847
|
+
* @memberof UpdateReservationPolicyDto
|
|
30848
|
+
*/
|
|
30849
|
+
'turnTimeByPartySize'?: { [key: string]: number; };
|
|
29465
30850
|
}
|
|
29466
30851
|
/**
|
|
29467
30852
|
*
|
|
@@ -30541,12 +31926,6 @@ export interface VendureSellerUpsertDto {
|
|
|
30541
31926
|
* @memberof VendureSellerUpsertDto
|
|
30542
31927
|
*/
|
|
30543
31928
|
'currency'?: string | null;
|
|
30544
|
-
/**
|
|
30545
|
-
* The time the venue\'s business day ends, \"HH:mm\" 24-hour, in the venue\'s time zone: a sale before it counts on the day before in the day\'s report. Kept on the venue\'s MunchiPos config. Null, absent, or text that is not \"HH:mm\" keeps the stored one; a venue with none ends its day at 05:00
|
|
30546
|
-
* @type {string}
|
|
30547
|
-
* @memberof VendureSellerUpsertDto
|
|
30548
|
-
*/
|
|
30549
|
-
'report_time'?: string | null;
|
|
30550
31929
|
/**
|
|
30551
31930
|
* Whether the venue is in use. Vendure sends false when the seller is deleted
|
|
30552
31931
|
* @type {boolean}
|
|
@@ -42585,6 +43964,46 @@ export const KDSApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
42585
43964
|
options: localVarRequestOptions,
|
|
42586
43965
|
};
|
|
42587
43966
|
},
|
|
43967
|
+
/**
|
|
43968
|
+
* Written in kds-service, in one call for every order; kds-service decides each order and leaves untouched any it cannot mark ready. It admits a signed-in ticket, whose venue must be on its account, or the Munchi-internal Clerk API key; never the shared service key. A failure there is answered with 200 and status false; when the call fails after kds-service has written (a dropped connection or a timeout), status is false although some tickets were marked ready, and the station\'s next list shows them.
|
|
43969
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
43970
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
43971
|
+
* @param {*} [options] Override http request option.
|
|
43972
|
+
* @throws {RequiredError}
|
|
43973
|
+
*/
|
|
43974
|
+
kdsMarkOrdersReady: async (kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43975
|
+
// verify required parameter 'kdsMarkOrdersReadyDto' is not null or undefined
|
|
43976
|
+
assertParamExists('kdsMarkOrdersReady', 'kdsMarkOrdersReadyDto', kdsMarkOrdersReadyDto)
|
|
43977
|
+
const localVarPath = `/api/v1/kds/orders/ready`;
|
|
43978
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43979
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43980
|
+
let baseOptions;
|
|
43981
|
+
if (configuration) {
|
|
43982
|
+
baseOptions = configuration.baseOptions;
|
|
43983
|
+
}
|
|
43984
|
+
|
|
43985
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
43986
|
+
const localVarHeaderParameter = {} as any;
|
|
43987
|
+
const localVarQueryParameter = {} as any;
|
|
43988
|
+
|
|
43989
|
+
// authentication JWT-auth required
|
|
43990
|
+
// http bearer authentication required
|
|
43991
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
43992
|
+
|
|
43993
|
+
|
|
43994
|
+
|
|
43995
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
43996
|
+
|
|
43997
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43998
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43999
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
44000
|
+
localVarRequestOptions.data = serializeDataIfNeeded(kdsMarkOrdersReadyDto, localVarRequestOptions, configuration)
|
|
44001
|
+
|
|
44002
|
+
return {
|
|
44003
|
+
url: toPathString(localVarUrlObj),
|
|
44004
|
+
options: localVarRequestOptions,
|
|
44005
|
+
};
|
|
44006
|
+
},
|
|
42588
44007
|
/**
|
|
42589
44008
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
42590
44009
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -42676,6 +44095,17 @@ export const KDSApiFp = function(configuration?: Configuration) {
|
|
|
42676
44095
|
const localVarAxiosArgs = await localVarAxiosParamCreator.kdsMarkOrderReady(id, options);
|
|
42677
44096
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
42678
44097
|
},
|
|
44098
|
+
/**
|
|
44099
|
+
* Written in kds-service, in one call for every order; kds-service decides each order and leaves untouched any it cannot mark ready. It admits a signed-in ticket, whose venue must be on its account, or the Munchi-internal Clerk API key; never the shared service key. A failure there is answered with 200 and status false; when the call fails after kds-service has written (a dropped connection or a timeout), status is false although some tickets were marked ready, and the station\'s next list shows them.
|
|
44100
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
44101
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
44102
|
+
* @param {*} [options] Override http request option.
|
|
44103
|
+
* @throws {RequiredError}
|
|
44104
|
+
*/
|
|
44105
|
+
async kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KdsReadyOrdersResponseDto>> {
|
|
44106
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.kdsMarkOrdersReady(kdsMarkOrdersReadyDto, options);
|
|
44107
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
44108
|
+
},
|
|
42679
44109
|
/**
|
|
42680
44110
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
42681
44111
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -42737,6 +44167,16 @@ export const KDSApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
42737
44167
|
kdsMarkOrderReady(id: string, options?: any): AxiosPromise<KdsReadyOrderResponseDto> {
|
|
42738
44168
|
return localVarFp.kdsMarkOrderReady(id, options).then((request) => request(axios, basePath));
|
|
42739
44169
|
},
|
|
44170
|
+
/**
|
|
44171
|
+
* Written in kds-service, in one call for every order; kds-service decides each order and leaves untouched any it cannot mark ready. It admits a signed-in ticket, whose venue must be on its account, or the Munchi-internal Clerk API key; never the shared service key. A failure there is answered with 200 and status false; when the call fails after kds-service has written (a dropped connection or a timeout), status is false although some tickets were marked ready, and the station\'s next list shows them.
|
|
44172
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
44173
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
44174
|
+
* @param {*} [options] Override http request option.
|
|
44175
|
+
* @throws {RequiredError}
|
|
44176
|
+
*/
|
|
44177
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: any): AxiosPromise<KdsReadyOrdersResponseDto> {
|
|
44178
|
+
return localVarFp.kdsMarkOrdersReady(kdsMarkOrdersReadyDto, options).then((request) => request(axios, basePath));
|
|
44179
|
+
},
|
|
42740
44180
|
/**
|
|
42741
44181
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
42742
44182
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -42796,6 +44236,16 @@ export interface KDSApiInterface {
|
|
|
42796
44236
|
*/
|
|
42797
44237
|
kdsMarkOrderReady(id: string, options?: AxiosRequestConfig): AxiosPromise<KdsReadyOrderResponseDto>;
|
|
42798
44238
|
|
|
44239
|
+
/**
|
|
44240
|
+
* Written in kds-service, in one call for every order; kds-service decides each order and leaves untouched any it cannot mark ready. It admits a signed-in ticket, whose venue must be on its account, or the Munchi-internal Clerk API key; never the shared service key. A failure there is answered with 200 and status false; when the call fails after kds-service has written (a dropped connection or a timeout), status is false although some tickets were marked ready, and the station\'s next list shows them.
|
|
44241
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
44242
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
44243
|
+
* @param {*} [options] Override http request option.
|
|
44244
|
+
* @throws {RequiredError}
|
|
44245
|
+
* @memberof KDSApiInterface
|
|
44246
|
+
*/
|
|
44247
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig): AxiosPromise<KdsReadyOrdersResponseDto>;
|
|
44248
|
+
|
|
42799
44249
|
/**
|
|
42800
44250
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
42801
44251
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -42861,6 +44311,18 @@ export class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
|
42861
44311
|
return KDSApiFp(this.configuration).kdsMarkOrderReady(id, options).then((request) => request(this.axios, this.basePath));
|
|
42862
44312
|
}
|
|
42863
44313
|
|
|
44314
|
+
/**
|
|
44315
|
+
* Written in kds-service, in one call for every order; kds-service decides each order and leaves untouched any it cannot mark ready. It admits a signed-in ticket, whose venue must be on its account, or the Munchi-internal Clerk API key; never the shared service key. A failure there is answered with 200 and status false; when the call fails after kds-service has written (a dropped connection or a timeout), status is false although some tickets were marked ready, and the station\'s next list shows them.
|
|
44316
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
44317
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
44318
|
+
* @param {*} [options] Override http request option.
|
|
44319
|
+
* @throws {RequiredError}
|
|
44320
|
+
* @memberof KDSApi
|
|
44321
|
+
*/
|
|
44322
|
+
public kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig) {
|
|
44323
|
+
return KDSApiFp(this.configuration).kdsMarkOrdersReady(kdsMarkOrdersReadyDto, options).then((request) => request(this.axios, this.basePath));
|
|
44324
|
+
}
|
|
44325
|
+
|
|
42864
44326
|
/**
|
|
42865
44327
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
42866
44328
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -45897,6 +47359,42 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
45897
47359
|
options: localVarRequestOptions,
|
|
45898
47360
|
};
|
|
45899
47361
|
},
|
|
47362
|
+
/**
|
|
47363
|
+
* One tap on a column of the till: Mark all ready (in progress → ready) or Deliver all (ready → delivered). Each id is looked for among the venue\'s tickets, then its orders, all in one Firestore read, and every one that may move is written in the same transaction; the rest are left as they are, each with its reason. Only the till\'s own tickets and orders move, never a channel\'s (Wolt, Foodora, Storefront): their ids are not found. A ticket the kitchen screen owns is never marked ready here, and nothing goes from in progress to delivered. The tills hear the request once: one kitchen_order_sync and one pos_order_change naming every moved id; the integrations hear every moved document in one announcement. Delivered orders earn their members\' loyalty points before the answer, a few at a time; a credit that fails is logged and does not change the answer.
|
|
47364
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
47365
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
47366
|
+
* @param {*} [options] Override http request option.
|
|
47367
|
+
* @throws {RequiredError}
|
|
47368
|
+
*/
|
|
47369
|
+
changePosOrdersStatusInBulk: async (changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47370
|
+
// verify required parameter 'changePosOrdersStatusInBulkDto' is not null or undefined
|
|
47371
|
+
assertParamExists('changePosOrdersStatusInBulk', 'changePosOrdersStatusInBulkDto', changePosOrdersStatusInBulkDto)
|
|
47372
|
+
const localVarPath = `/api/v2/orders/pos/bulk-status`;
|
|
47373
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47374
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
47375
|
+
let baseOptions;
|
|
47376
|
+
if (configuration) {
|
|
47377
|
+
baseOptions = configuration.baseOptions;
|
|
47378
|
+
}
|
|
47379
|
+
|
|
47380
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
47381
|
+
const localVarHeaderParameter = {} as any;
|
|
47382
|
+
const localVarQueryParameter = {} as any;
|
|
47383
|
+
|
|
47384
|
+
|
|
47385
|
+
|
|
47386
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
47387
|
+
|
|
47388
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
47389
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
47390
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
47391
|
+
localVarRequestOptions.data = serializeDataIfNeeded(changePosOrdersStatusInBulkDto, localVarRequestOptions, configuration)
|
|
47392
|
+
|
|
47393
|
+
return {
|
|
47394
|
+
url: toPathString(localVarUrlObj),
|
|
47395
|
+
options: localVarRequestOptions,
|
|
47396
|
+
};
|
|
47397
|
+
},
|
|
45900
47398
|
/**
|
|
45901
47399
|
* The till\'s Order Manager confirms a platform preorder with its preparation time. Its pickup time is stored, and a Foodora preorder also moves into preparation. Then the preorder is marked confirmed and the answer leaves; after it, the platform is told, and a courier or a reminder is booked where the channel needs one. A failure in those steps is logged and does not change the answer.
|
|
45902
47400
|
* @summary Confirm a pre-order
|
|
@@ -46453,6 +47951,17 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
46453
47951
|
const localVarAxiosArgs = await localVarAxiosParamCreator.acceptOrder(acceptOrderDto, options);
|
|
46454
47952
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46455
47953
|
},
|
|
47954
|
+
/**
|
|
47955
|
+
* One tap on a column of the till: Mark all ready (in progress → ready) or Deliver all (ready → delivered). Each id is looked for among the venue\'s tickets, then its orders, all in one Firestore read, and every one that may move is written in the same transaction; the rest are left as they are, each with its reason. Only the till\'s own tickets and orders move, never a channel\'s (Wolt, Foodora, Storefront): their ids are not found. A ticket the kitchen screen owns is never marked ready here, and nothing goes from in progress to delivered. The tills hear the request once: one kitchen_order_sync and one pos_order_change naming every moved id; the integrations hear every moved document in one announcement. Delivered orders earn their members\' loyalty points before the answer, a few at a time; a credit that fails is logged and does not change the answer.
|
|
47956
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
47957
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
47958
|
+
* @param {*} [options] Override http request option.
|
|
47959
|
+
* @throws {RequiredError}
|
|
47960
|
+
*/
|
|
47961
|
+
async changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangePosOrdersStatusInBulkResponseDto>> {
|
|
47962
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto, options);
|
|
47963
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
47964
|
+
},
|
|
46456
47965
|
/**
|
|
46457
47966
|
* The till\'s Order Manager confirms a platform preorder with its preparation time. Its pickup time is stored, and a Foodora preorder also moves into preparation. Then the preorder is marked confirmed and the answer leaves; after it, the platform is told, and a courier or a reminder is booked where the channel needs one. A failure in those steps is logged and does not change the answer.
|
|
46458
47967
|
* @summary Confirm a pre-order
|
|
@@ -46633,6 +48142,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
46633
48142
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: any): AxiosPromise<OrderStatusResponseDto> {
|
|
46634
48143
|
return localVarFp.acceptOrder(acceptOrderDto, options).then((request) => request(axios, basePath));
|
|
46635
48144
|
},
|
|
48145
|
+
/**
|
|
48146
|
+
* One tap on a column of the till: Mark all ready (in progress → ready) or Deliver all (ready → delivered). Each id is looked for among the venue\'s tickets, then its orders, all in one Firestore read, and every one that may move is written in the same transaction; the rest are left as they are, each with its reason. Only the till\'s own tickets and orders move, never a channel\'s (Wolt, Foodora, Storefront): their ids are not found. A ticket the kitchen screen owns is never marked ready here, and nothing goes from in progress to delivered. The tills hear the request once: one kitchen_order_sync and one pos_order_change naming every moved id; the integrations hear every moved document in one announcement. Delivered orders earn their members\' loyalty points before the answer, a few at a time; a credit that fails is logged and does not change the answer.
|
|
48147
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
48148
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
48149
|
+
* @param {*} [options] Override http request option.
|
|
48150
|
+
* @throws {RequiredError}
|
|
48151
|
+
*/
|
|
48152
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: any): AxiosPromise<ChangePosOrdersStatusInBulkResponseDto> {
|
|
48153
|
+
return localVarFp.changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto, options).then((request) => request(axios, basePath));
|
|
48154
|
+
},
|
|
46636
48155
|
/**
|
|
46637
48156
|
* The till\'s Order Manager confirms a platform preorder with its preparation time. Its pickup time is stored, and a Foodora preorder also moves into preparation. Then the preorder is marked confirmed and the answer leaves; after it, the platform is told, and a courier or a reminder is booked where the channel needs one. A failure in those steps is logged and does not change the answer.
|
|
46638
48157
|
* @summary Confirm a pre-order
|
|
@@ -46798,6 +48317,16 @@ export interface OrdersApiInterface {
|
|
|
46798
48317
|
*/
|
|
46799
48318
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: AxiosRequestConfig): AxiosPromise<OrderStatusResponseDto>;
|
|
46800
48319
|
|
|
48320
|
+
/**
|
|
48321
|
+
* One tap on a column of the till: Mark all ready (in progress → ready) or Deliver all (ready → delivered). Each id is looked for among the venue\'s tickets, then its orders, all in one Firestore read, and every one that may move is written in the same transaction; the rest are left as they are, each with its reason. Only the till\'s own tickets and orders move, never a channel\'s (Wolt, Foodora, Storefront): their ids are not found. A ticket the kitchen screen owns is never marked ready here, and nothing goes from in progress to delivered. The tills hear the request once: one kitchen_order_sync and one pos_order_change naming every moved id; the integrations hear every moved document in one announcement. Delivered orders earn their members\' loyalty points before the answer, a few at a time; a credit that fails is logged and does not change the answer.
|
|
48322
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
48323
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
48324
|
+
* @param {*} [options] Override http request option.
|
|
48325
|
+
* @throws {RequiredError}
|
|
48326
|
+
* @memberof OrdersApiInterface
|
|
48327
|
+
*/
|
|
48328
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig): AxiosPromise<ChangePosOrdersStatusInBulkResponseDto>;
|
|
48329
|
+
|
|
46801
48330
|
/**
|
|
46802
48331
|
* The till\'s Order Manager confirms a platform preorder with its preparation time. Its pickup time is stored, and a Foodora preorder also moves into preparation. Then the preorder is marked confirmed and the answer leaves; after it, the platform is told, and a courier or a reminder is booked where the channel needs one. A failure in those steps is logged and does not change the answer.
|
|
46803
48332
|
* @summary Confirm a pre-order
|
|
@@ -46965,6 +48494,18 @@ export class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
46965
48494
|
return OrdersApiFp(this.configuration).acceptOrder(acceptOrderDto, options).then((request) => request(this.axios, this.basePath));
|
|
46966
48495
|
}
|
|
46967
48496
|
|
|
48497
|
+
/**
|
|
48498
|
+
* One tap on a column of the till: Mark all ready (in progress → ready) or Deliver all (ready → delivered). Each id is looked for among the venue\'s tickets, then its orders, all in one Firestore read, and every one that may move is written in the same transaction; the rest are left as they are, each with its reason. Only the till\'s own tickets and orders move, never a channel\'s (Wolt, Foodora, Storefront): their ids are not found. A ticket the kitchen screen owns is never marked ready here, and nothing goes from in progress to delivered. The tills hear the request once: one kitchen_order_sync and one pos_order_change naming every moved id; the integrations hear every moved document in one announcement. Delivered orders earn their members\' loyalty points before the answer, a few at a time; a credit that fails is logged and does not change the answer.
|
|
48499
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
48500
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
48501
|
+
* @param {*} [options] Override http request option.
|
|
48502
|
+
* @throws {RequiredError}
|
|
48503
|
+
* @memberof OrdersApi
|
|
48504
|
+
*/
|
|
48505
|
+
public changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig) {
|
|
48506
|
+
return OrdersApiFp(this.configuration).changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto, options).then((request) => request(this.axios, this.basePath));
|
|
48507
|
+
}
|
|
48508
|
+
|
|
46968
48509
|
/**
|
|
46969
48510
|
* The till\'s Order Manager confirms a platform preorder with its preparation time. Its pickup time is stored, and a Foodora preorder also moves into preparation. Then the preorder is marked confirmed and the answer leaves; after it, the platform is told, and a courier or a reminder is booked where the channel needs one. A failure in those steps is logged and does not change the answer.
|
|
46970
48511
|
* @summary Confirm a pre-order
|
|
@@ -52085,6 +53626,7 @@ export const ProductApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
52085
53626
|
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
52086
53627
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
52087
53628
|
* @param {*} [options] Override http request option.
|
|
53629
|
+
* @deprecated
|
|
52088
53630
|
* @throws {RequiredError}
|
|
52089
53631
|
*/
|
|
52090
53632
|
updateProductSkuV2: async (businessId: string, categoryId: string, productId: string, updateProductSkuDto: UpdateProductSkuDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
@@ -52120,6 +53662,54 @@ export const ProductApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
52120
53662
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
52121
53663
|
localVarRequestOptions.data = serializeDataIfNeeded(updateProductSkuDto, localVarRequestOptions, configuration)
|
|
52122
53664
|
|
|
53665
|
+
return {
|
|
53666
|
+
url: toPathString(localVarUrlObj),
|
|
53667
|
+
options: localVarRequestOptions,
|
|
53668
|
+
};
|
|
53669
|
+
},
|
|
53670
|
+
/**
|
|
53671
|
+
* Saved in Vendure, each trimmed, in the order sent; the first is the product\'s sku. A SKU is unique within the venue; Vendure compares it without case.
|
|
53672
|
+
* @summary Replace every SKU (label code) of a product
|
|
53673
|
+
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
53674
|
+
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
53675
|
+
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
53676
|
+
* @param {UpdateProductSkusDto} updateProductSkusDto Every SKU the product keeps, in order
|
|
53677
|
+
* @param {*} [options] Override http request option.
|
|
53678
|
+
* @throws {RequiredError}
|
|
53679
|
+
*/
|
|
53680
|
+
updateProductSkusV2: async (businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
53681
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
53682
|
+
assertParamExists('updateProductSkusV2', 'businessId', businessId)
|
|
53683
|
+
// verify required parameter 'categoryId' is not null or undefined
|
|
53684
|
+
assertParamExists('updateProductSkusV2', 'categoryId', categoryId)
|
|
53685
|
+
// verify required parameter 'productId' is not null or undefined
|
|
53686
|
+
assertParamExists('updateProductSkusV2', 'productId', productId)
|
|
53687
|
+
// verify required parameter 'updateProductSkusDto' is not null or undefined
|
|
53688
|
+
assertParamExists('updateProductSkusV2', 'updateProductSkusDto', updateProductSkusDto)
|
|
53689
|
+
const localVarPath = `/api/v2/business/{businessId}/categories/{categoryId}/products/{productId}/skus`
|
|
53690
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
53691
|
+
.replace(`{${"categoryId"}}`, encodeURIComponent(String(categoryId)))
|
|
53692
|
+
.replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
|
|
53693
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
53694
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
53695
|
+
let baseOptions;
|
|
53696
|
+
if (configuration) {
|
|
53697
|
+
baseOptions = configuration.baseOptions;
|
|
53698
|
+
}
|
|
53699
|
+
|
|
53700
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
53701
|
+
const localVarHeaderParameter = {} as any;
|
|
53702
|
+
const localVarQueryParameter = {} as any;
|
|
53703
|
+
|
|
53704
|
+
|
|
53705
|
+
|
|
53706
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
53707
|
+
|
|
53708
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
53709
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
53710
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
53711
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateProductSkusDto, localVarRequestOptions, configuration)
|
|
53712
|
+
|
|
52123
53713
|
return {
|
|
52124
53714
|
url: toPathString(localVarUrlObj),
|
|
52125
53715
|
options: localVarRequestOptions,
|
|
@@ -52170,12 +53760,27 @@ export const ProductApiFp = function(configuration?: Configuration) {
|
|
|
52170
53760
|
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
52171
53761
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
52172
53762
|
* @param {*} [options] Override http request option.
|
|
53763
|
+
* @deprecated
|
|
52173
53764
|
* @throws {RequiredError}
|
|
52174
53765
|
*/
|
|
52175
53766
|
async updateProductSkuV2(businessId: string, categoryId: string, productId: string, updateProductSkuDto: UpdateProductSkuDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSkuResponseDto>> {
|
|
52176
53767
|
const localVarAxiosArgs = await localVarAxiosParamCreator.updateProductSkuV2(businessId, categoryId, productId, updateProductSkuDto, options);
|
|
52177
53768
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
52178
53769
|
},
|
|
53770
|
+
/**
|
|
53771
|
+
* Saved in Vendure, each trimmed, in the order sent; the first is the product\'s sku. A SKU is unique within the venue; Vendure compares it without case.
|
|
53772
|
+
* @summary Replace every SKU (label code) of a product
|
|
53773
|
+
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
53774
|
+
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
53775
|
+
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
53776
|
+
* @param {UpdateProductSkusDto} updateProductSkusDto Every SKU the product keeps, in order
|
|
53777
|
+
* @param {*} [options] Override http request option.
|
|
53778
|
+
* @throws {RequiredError}
|
|
53779
|
+
*/
|
|
53780
|
+
async updateProductSkusV2(businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProductSkusResponseDto>> {
|
|
53781
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateProductSkusV2(businessId, categoryId, productId, updateProductSkusDto, options);
|
|
53782
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
53783
|
+
},
|
|
52179
53784
|
}
|
|
52180
53785
|
};
|
|
52181
53786
|
|
|
@@ -52219,11 +53824,25 @@ export const ProductApiFactory = function (configuration?: Configuration, basePa
|
|
|
52219
53824
|
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
52220
53825
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
52221
53826
|
* @param {*} [options] Override http request option.
|
|
53827
|
+
* @deprecated
|
|
52222
53828
|
* @throws {RequiredError}
|
|
52223
53829
|
*/
|
|
52224
53830
|
updateProductSkuV2(businessId: string, categoryId: string, productId: string, updateProductSkuDto: UpdateProductSkuDto, options?: any): AxiosPromise<ProductSkuResponseDto> {
|
|
52225
53831
|
return localVarFp.updateProductSkuV2(businessId, categoryId, productId, updateProductSkuDto, options).then((request) => request(axios, basePath));
|
|
52226
53832
|
},
|
|
53833
|
+
/**
|
|
53834
|
+
* Saved in Vendure, each trimmed, in the order sent; the first is the product\'s sku. A SKU is unique within the venue; Vendure compares it without case.
|
|
53835
|
+
* @summary Replace every SKU (label code) of a product
|
|
53836
|
+
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
53837
|
+
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
53838
|
+
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
53839
|
+
* @param {UpdateProductSkusDto} updateProductSkusDto Every SKU the product keeps, in order
|
|
53840
|
+
* @param {*} [options] Override http request option.
|
|
53841
|
+
* @throws {RequiredError}
|
|
53842
|
+
*/
|
|
53843
|
+
updateProductSkusV2(businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options?: any): AxiosPromise<ProductSkusResponseDto> {
|
|
53844
|
+
return localVarFp.updateProductSkusV2(businessId, categoryId, productId, updateProductSkusDto, options).then((request) => request(axios, basePath));
|
|
53845
|
+
},
|
|
52227
53846
|
};
|
|
52228
53847
|
};
|
|
52229
53848
|
|
|
@@ -52266,11 +53885,25 @@ export interface ProductApiInterface {
|
|
|
52266
53885
|
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
52267
53886
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
52268
53887
|
* @param {*} [options] Override http request option.
|
|
53888
|
+
* @deprecated
|
|
52269
53889
|
* @throws {RequiredError}
|
|
52270
53890
|
* @memberof ProductApiInterface
|
|
52271
53891
|
*/
|
|
52272
53892
|
updateProductSkuV2(businessId: string, categoryId: string, productId: string, updateProductSkuDto: UpdateProductSkuDto, options?: AxiosRequestConfig): AxiosPromise<ProductSkuResponseDto>;
|
|
52273
53893
|
|
|
53894
|
+
/**
|
|
53895
|
+
* Saved in Vendure, each trimmed, in the order sent; the first is the product\'s sku. A SKU is unique within the venue; Vendure compares it without case.
|
|
53896
|
+
* @summary Replace every SKU (label code) of a product
|
|
53897
|
+
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
53898
|
+
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
53899
|
+
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
53900
|
+
* @param {UpdateProductSkusDto} updateProductSkusDto Every SKU the product keeps, in order
|
|
53901
|
+
* @param {*} [options] Override http request option.
|
|
53902
|
+
* @throws {RequiredError}
|
|
53903
|
+
* @memberof ProductApiInterface
|
|
53904
|
+
*/
|
|
53905
|
+
updateProductSkusV2(businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options?: AxiosRequestConfig): AxiosPromise<ProductSkusResponseDto>;
|
|
53906
|
+
|
|
52274
53907
|
}
|
|
52275
53908
|
|
|
52276
53909
|
/**
|
|
@@ -52317,12 +53950,28 @@ export class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
52317
53950
|
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
52318
53951
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
52319
53952
|
* @param {*} [options] Override http request option.
|
|
53953
|
+
* @deprecated
|
|
52320
53954
|
* @throws {RequiredError}
|
|
52321
53955
|
* @memberof ProductApi
|
|
52322
53956
|
*/
|
|
52323
53957
|
public updateProductSkuV2(businessId: string, categoryId: string, productId: string, updateProductSkuDto: UpdateProductSkuDto, options?: AxiosRequestConfig) {
|
|
52324
53958
|
return ProductApiFp(this.configuration).updateProductSkuV2(businessId, categoryId, productId, updateProductSkuDto, options).then((request) => request(this.axios, this.basePath));
|
|
52325
53959
|
}
|
|
53960
|
+
|
|
53961
|
+
/**
|
|
53962
|
+
* Saved in Vendure, each trimmed, in the order sent; the first is the product\'s sku. A SKU is unique within the venue; Vendure compares it without case.
|
|
53963
|
+
* @summary Replace every SKU (label code) of a product
|
|
53964
|
+
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
53965
|
+
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
53966
|
+
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
53967
|
+
* @param {UpdateProductSkusDto} updateProductSkusDto Every SKU the product keeps, in order
|
|
53968
|
+
* @param {*} [options] Override http request option.
|
|
53969
|
+
* @throws {RequiredError}
|
|
53970
|
+
* @memberof ProductApi
|
|
53971
|
+
*/
|
|
53972
|
+
public updateProductSkusV2(businessId: string, categoryId: string, productId: string, updateProductSkusDto: UpdateProductSkusDto, options?: AxiosRequestConfig) {
|
|
53973
|
+
return ProductApiFp(this.configuration).updateProductSkusV2(businessId, categoryId, productId, updateProductSkusDto, options).then((request) => request(this.axios, this.basePath));
|
|
53974
|
+
}
|
|
52326
53975
|
}
|
|
52327
53976
|
|
|
52328
53977
|
|
|
@@ -53997,6 +55646,102 @@ export const ReportApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
53997
55646
|
|
|
53998
55647
|
|
|
53999
55648
|
|
|
55649
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
55650
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
55651
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
55652
|
+
|
|
55653
|
+
return {
|
|
55654
|
+
url: toPathString(localVarUrlObj),
|
|
55655
|
+
options: localVarRequestOptions,
|
|
55656
|
+
};
|
|
55657
|
+
},
|
|
55658
|
+
/**
|
|
55659
|
+
* Adds up each venue\'s finished business days (the calendar date in the venue\'s own time zone) of the apps and parts asked, in one database statement. Each group answers in its app\'s portal shape: POS as report-service, kiosk, storefront and mobile as dashboard v2; several apps added together answer as v2. Amounts of two currencies are never added together: a venue whose sales are in a currency other than its current Business.currency answers a group in each. A person\'s signed-in ticket reads the venues on its account; a Clerk API key of the Munchi-internal organisation (the MCP\'s, D134, D137) reads any venue; the shared key and any other organisation\'s key are refused. A period must cover whole days; today is answered up to dataUntil. With compareStart and compareEnd, each group also answers comparison: the same group over those days, read in the same statement, and the change of each total worked out exactly; a currency only the compared period sold in adds a group of zeros after the others. With baseline, every other group answers changesFromBaseline, its change from the baseline group of its currency.
|
|
55660
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
55661
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
55662
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
55663
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55664
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55665
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
55666
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
55667
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
55668
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
55669
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
55670
|
+
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
55671
|
+
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
55672
|
+
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
55673
|
+
* @param {*} [options] Override http request option.
|
|
55674
|
+
* @throws {RequiredError}
|
|
55675
|
+
*/
|
|
55676
|
+
getSalesReport: async (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, baseline?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
55677
|
+
// verify required parameter 'businessIds' is not null or undefined
|
|
55678
|
+
assertParamExists('getSalesReport', 'businessIds', businessIds)
|
|
55679
|
+
const localVarPath = `/api/v6/report/sales`;
|
|
55680
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
55681
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
55682
|
+
let baseOptions;
|
|
55683
|
+
if (configuration) {
|
|
55684
|
+
baseOptions = configuration.baseOptions;
|
|
55685
|
+
}
|
|
55686
|
+
|
|
55687
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
55688
|
+
const localVarHeaderParameter = {} as any;
|
|
55689
|
+
const localVarQueryParameter = {} as any;
|
|
55690
|
+
|
|
55691
|
+
// authentication JWT-auth required
|
|
55692
|
+
// http bearer authentication required
|
|
55693
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
55694
|
+
|
|
55695
|
+
if (timeSpan !== undefined) {
|
|
55696
|
+
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
55697
|
+
}
|
|
55698
|
+
|
|
55699
|
+
if (start !== undefined) {
|
|
55700
|
+
localVarQueryParameter['start'] = start;
|
|
55701
|
+
}
|
|
55702
|
+
|
|
55703
|
+
if (end !== undefined) {
|
|
55704
|
+
localVarQueryParameter['end'] = end;
|
|
55705
|
+
}
|
|
55706
|
+
|
|
55707
|
+
if (businessIds) {
|
|
55708
|
+
localVarQueryParameter['businessIds'] = businessIds;
|
|
55709
|
+
}
|
|
55710
|
+
|
|
55711
|
+
if (timezone !== undefined) {
|
|
55712
|
+
localVarQueryParameter['timezone'] = timezone;
|
|
55713
|
+
}
|
|
55714
|
+
|
|
55715
|
+
if (apps) {
|
|
55716
|
+
localVarQueryParameter['apps'] = apps;
|
|
55717
|
+
}
|
|
55718
|
+
|
|
55719
|
+
if (parts) {
|
|
55720
|
+
localVarQueryParameter['parts'] = parts;
|
|
55721
|
+
}
|
|
55722
|
+
|
|
55723
|
+
if (breakdown !== undefined) {
|
|
55724
|
+
localVarQueryParameter['breakdown'] = breakdown;
|
|
55725
|
+
}
|
|
55726
|
+
|
|
55727
|
+
if (language !== undefined) {
|
|
55728
|
+
localVarQueryParameter['language'] = language;
|
|
55729
|
+
}
|
|
55730
|
+
|
|
55731
|
+
if (compareStart !== undefined) {
|
|
55732
|
+
localVarQueryParameter['compareStart'] = compareStart;
|
|
55733
|
+
}
|
|
55734
|
+
|
|
55735
|
+
if (compareEnd !== undefined) {
|
|
55736
|
+
localVarQueryParameter['compareEnd'] = compareEnd;
|
|
55737
|
+
}
|
|
55738
|
+
|
|
55739
|
+
if (baseline !== undefined) {
|
|
55740
|
+
localVarQueryParameter['baseline'] = baseline;
|
|
55741
|
+
}
|
|
55742
|
+
|
|
55743
|
+
|
|
55744
|
+
|
|
54000
55745
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
54001
55746
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
54002
55747
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -54102,6 +55847,28 @@ export const ReportApiFp = function(configuration?: Configuration) {
|
|
|
54102
55847
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options);
|
|
54103
55848
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54104
55849
|
},
|
|
55850
|
+
/**
|
|
55851
|
+
* Adds up each venue\'s finished business days (the calendar date in the venue\'s own time zone) of the apps and parts asked, in one database statement. Each group answers in its app\'s portal shape: POS as report-service, kiosk, storefront and mobile as dashboard v2; several apps added together answer as v2. Amounts of two currencies are never added together: a venue whose sales are in a currency other than its current Business.currency answers a group in each. A person\'s signed-in ticket reads the venues on its account; a Clerk API key of the Munchi-internal organisation (the MCP\'s, D134, D137) reads any venue; the shared key and any other organisation\'s key are refused. A period must cover whole days; today is answered up to dataUntil. With compareStart and compareEnd, each group also answers comparison: the same group over those days, read in the same statement, and the change of each total worked out exactly; a currency only the compared period sold in adds a group of zeros after the others. With baseline, every other group answers changesFromBaseline, its change from the baseline group of its currency.
|
|
55852
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
55853
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
55854
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
55855
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55856
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55857
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
55858
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
55859
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
55860
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
55861
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
55862
|
+
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
55863
|
+
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
55864
|
+
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
55865
|
+
* @param {*} [options] Override http request option.
|
|
55866
|
+
* @throws {RequiredError}
|
|
55867
|
+
*/
|
|
55868
|
+
async getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, baseline?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SalesReportResponseDto>> {
|
|
55869
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSalesReport(businessIds, timeSpan, start, end, timezone, apps, parts, breakdown, language, compareStart, compareEnd, baseline, options);
|
|
55870
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
55871
|
+
},
|
|
54105
55872
|
/**
|
|
54106
55873
|
*
|
|
54107
55874
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -54144,6 +55911,27 @@ export const ReportApiFactory = function (configuration?: Configuration, basePat
|
|
|
54144
55911
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: any): AxiosPromise<EndOfDayReportDtoV4> {
|
|
54145
55912
|
return localVarFp.getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options).then((request) => request(axios, basePath));
|
|
54146
55913
|
},
|
|
55914
|
+
/**
|
|
55915
|
+
* Adds up each venue\'s finished business days (the calendar date in the venue\'s own time zone) of the apps and parts asked, in one database statement. Each group answers in its app\'s portal shape: POS as report-service, kiosk, storefront and mobile as dashboard v2; several apps added together answer as v2. Amounts of two currencies are never added together: a venue whose sales are in a currency other than its current Business.currency answers a group in each. A person\'s signed-in ticket reads the venues on its account; a Clerk API key of the Munchi-internal organisation (the MCP\'s, D134, D137) reads any venue; the shared key and any other organisation\'s key are refused. A period must cover whole days; today is answered up to dataUntil. With compareStart and compareEnd, each group also answers comparison: the same group over those days, read in the same statement, and the change of each total worked out exactly; a currency only the compared period sold in adds a group of zeros after the others. With baseline, every other group answers changesFromBaseline, its change from the baseline group of its currency.
|
|
55916
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
55917
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
55918
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
55919
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55920
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55921
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
55922
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
55923
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
55924
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
55925
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
55926
|
+
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
55927
|
+
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
55928
|
+
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
55929
|
+
* @param {*} [options] Override http request option.
|
|
55930
|
+
* @throws {RequiredError}
|
|
55931
|
+
*/
|
|
55932
|
+
getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, baseline?: string, options?: any): AxiosPromise<SalesReportResponseDto> {
|
|
55933
|
+
return localVarFp.getSalesReport(businessIds, timeSpan, start, end, timezone, apps, parts, breakdown, language, compareStart, compareEnd, baseline, options).then((request) => request(axios, basePath));
|
|
55934
|
+
},
|
|
54147
55935
|
/**
|
|
54148
55936
|
*
|
|
54149
55937
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -54184,6 +55972,27 @@ export interface ReportApiInterface {
|
|
|
54184
55972
|
*/
|
|
54185
55973
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportDtoV4>;
|
|
54186
55974
|
|
|
55975
|
+
/**
|
|
55976
|
+
* Adds up each venue\'s finished business days (the calendar date in the venue\'s own time zone) of the apps and parts asked, in one database statement. Each group answers in its app\'s portal shape: POS as report-service, kiosk, storefront and mobile as dashboard v2; several apps added together answer as v2. Amounts of two currencies are never added together: a venue whose sales are in a currency other than its current Business.currency answers a group in each. A person\'s signed-in ticket reads the venues on its account; a Clerk API key of the Munchi-internal organisation (the MCP\'s, D134, D137) reads any venue; the shared key and any other organisation\'s key are refused. A period must cover whole days; today is answered up to dataUntil. With compareStart and compareEnd, each group also answers comparison: the same group over those days, read in the same statement, and the change of each total worked out exactly; a currency only the compared period sold in adds a group of zeros after the others. With baseline, every other group answers changesFromBaseline, its change from the baseline group of its currency.
|
|
55977
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
55978
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
55979
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
55980
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55981
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55982
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
55983
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
55984
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
55985
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
55986
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
55987
|
+
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
55988
|
+
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
55989
|
+
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
55990
|
+
* @param {*} [options] Override http request option.
|
|
55991
|
+
* @throws {RequiredError}
|
|
55992
|
+
* @memberof ReportApiInterface
|
|
55993
|
+
*/
|
|
55994
|
+
getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, baseline?: string, options?: AxiosRequestConfig): AxiosPromise<SalesReportResponseDto>;
|
|
55995
|
+
|
|
54187
55996
|
/**
|
|
54188
55997
|
*
|
|
54189
55998
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -54226,6 +56035,29 @@ export class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
54226
56035
|
return ReportApiFp(this.configuration).getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options).then((request) => request(this.axios, this.basePath));
|
|
54227
56036
|
}
|
|
54228
56037
|
|
|
56038
|
+
/**
|
|
56039
|
+
* Adds up each venue\'s finished business days (the calendar date in the venue\'s own time zone) of the apps and parts asked, in one database statement. Each group answers in its app\'s portal shape: POS as report-service, kiosk, storefront and mobile as dashboard v2; several apps added together answer as v2. Amounts of two currencies are never added together: a venue whose sales are in a currency other than its current Business.currency answers a group in each. A person\'s signed-in ticket reads the venues on its account; a Clerk API key of the Munchi-internal organisation (the MCP\'s, D134, D137) reads any venue; the shared key and any other organisation\'s key are refused. A period must cover whole days; today is answered up to dataUntil. With compareStart and compareEnd, each group also answers comparison: the same group over those days, read in the same statement, and the change of each total worked out exactly; a currency only the compared period sold in adds a group of zeros after the others. With baseline, every other group answers changesFromBaseline, its change from the baseline group of its currency.
|
|
56040
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
56041
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
56042
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
56043
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
56044
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
56045
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
56046
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
56047
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
56048
|
+
* @param {ReportBreakdown} [breakdown] How the venues and apps are split into groups; every currency always splits, and one app asked is never added into several apps. Absent: venue for several venues, none for one
|
|
56049
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
56050
|
+
* @param {string} [compareStart] With compareEnd, compares the report with these whole days: each group then also answers comparison, the same group over them, and the change of every total worked out exactly. The first business day compared, YYYY-MM-DD, in the report\'s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
|
|
56051
|
+
* @param {string} [compareEnd] With compareStart: the last business day compared, YYYY-MM-DD, inclusive; a day later than today is read up to now. Sent without compareStart: refused
|
|
56052
|
+
* @param {string} [baseline] One group of the answer every other group is compared with: venue:<id> with breakdown venue, app:<app> with breakdown app, venue:<id>,app:<app> with breakdown venue_app. Every other group then answers changesFromBaseline (current: the group; previous: the baseline), of the main period only; a group in another currency than the baseline\'s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
|
|
56053
|
+
* @param {*} [options] Override http request option.
|
|
56054
|
+
* @throws {RequiredError}
|
|
56055
|
+
* @memberof ReportApi
|
|
56056
|
+
*/
|
|
56057
|
+
public getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, baseline?: string, options?: AxiosRequestConfig) {
|
|
56058
|
+
return ReportApiFp(this.configuration).getSalesReport(businessIds, timeSpan, start, end, timezone, apps, parts, breakdown, language, compareStart, compareEnd, baseline, options).then((request) => request(this.axios, this.basePath));
|
|
56059
|
+
}
|
|
56060
|
+
|
|
54229
56061
|
/**
|
|
54230
56062
|
*
|
|
54231
56063
|
* @summary Send end-of-day report via email (V5)
|