@munchi_oy/core 2.0.1 → 2.0.3
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 +1839 -115
- 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 +2226 -298
- package/package.json +1 -1
- package/src/version.ts +1 -1
- package/generated/.gitignore +0 -4
- package/generated/.npmignore +0 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -467,6 +467,18 @@ export interface BusinessConfigResponseDto {
|
|
|
467
467
|
* @memberof BusinessConfigResponseDto
|
|
468
468
|
*/
|
|
469
469
|
'currency': CurrencyCode;
|
|
470
|
+
/**
|
|
471
|
+
* The venue\'s country, ISO 3166-1 alpha-2, from the seller\'s address in Vendure; null until Vendure\'s seller sync has sent it
|
|
472
|
+
* @type {string}
|
|
473
|
+
* @memberof BusinessConfigResponseDto
|
|
474
|
+
*/
|
|
475
|
+
'countryCode'?: string | null;
|
|
476
|
+
/**
|
|
477
|
+
* The venue\'s BCP 47 locale: its country\'s main language and the country (FI is fi-FI); null until Vendure\'s seller sync has sent the country
|
|
478
|
+
* @type {string}
|
|
479
|
+
* @memberof BusinessConfigResponseDto
|
|
480
|
+
*/
|
|
481
|
+
'locale'?: string | null;
|
|
470
482
|
/**
|
|
471
483
|
*
|
|
472
484
|
* @type {BusinessConfigResponseDtoBusiness}
|
|
@@ -2263,6 +2275,50 @@ export interface ChangePaymentMethodOptionDto {
|
|
|
2263
2275
|
*/
|
|
2264
2276
|
'enable'?: boolean;
|
|
2265
2277
|
}
|
|
2278
|
+
/**
|
|
2279
|
+
*
|
|
2280
|
+
* @export
|
|
2281
|
+
* @interface ChangePosOrdersStatusInBulkDto
|
|
2282
|
+
*/
|
|
2283
|
+
export interface ChangePosOrdersStatusInBulkDto {
|
|
2284
|
+
/**
|
|
2285
|
+
* The venue whose tickets and orders the till moves, by its venue id
|
|
2286
|
+
* @type {number}
|
|
2287
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2288
|
+
*/
|
|
2289
|
+
'orderingBusinessId': number;
|
|
2290
|
+
/**
|
|
2291
|
+
* The ids in Firestore of the till\'s tickets and orders to move, each once, 1 to 100 of them
|
|
2292
|
+
* @type {Array<string>}
|
|
2293
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2294
|
+
*/
|
|
2295
|
+
'orderIds': Array<string>;
|
|
2296
|
+
/**
|
|
2297
|
+
*
|
|
2298
|
+
* @type {PosBulkOrderStatus}
|
|
2299
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2300
|
+
*/
|
|
2301
|
+
'status': PosBulkOrderStatus;
|
|
2302
|
+
}
|
|
2303
|
+
/**
|
|
2304
|
+
*
|
|
2305
|
+
* @export
|
|
2306
|
+
* @interface ChangePosOrdersStatusInBulkResponseDto
|
|
2307
|
+
*/
|
|
2308
|
+
export interface ChangePosOrdersStatusInBulkResponseDto {
|
|
2309
|
+
/**
|
|
2310
|
+
* The ids of the tickets and orders moved to the status, in the order the till sent them; empty when none could be
|
|
2311
|
+
* @type {Array<string>}
|
|
2312
|
+
* @memberof ChangePosOrdersStatusInBulkResponseDto
|
|
2313
|
+
*/
|
|
2314
|
+
'moved': Array<string>;
|
|
2315
|
+
/**
|
|
2316
|
+
* The ids left as they are, each with the reason, in the order the till sent them; empty when every one moved
|
|
2317
|
+
* @type {Array<PosOrderLeftAsItIsDto>}
|
|
2318
|
+
* @memberof ChangePosOrdersStatusInBulkResponseDto
|
|
2319
|
+
*/
|
|
2320
|
+
'skipped': Array<PosOrderLeftAsItIsDto>;
|
|
2321
|
+
}
|
|
2266
2322
|
/**
|
|
2267
2323
|
*
|
|
2268
2324
|
* @export
|
|
@@ -2772,6 +2828,18 @@ export interface ConfigDto {
|
|
|
2772
2828
|
* @memberof ConfigDto
|
|
2773
2829
|
*/
|
|
2774
2830
|
'currency': CurrencyCode;
|
|
2831
|
+
/**
|
|
2832
|
+
* The venue\'s country, ISO 3166-1 alpha-2, from the seller\'s address in Vendure; null until Vendure\'s seller sync has sent it
|
|
2833
|
+
* @type {string}
|
|
2834
|
+
* @memberof ConfigDto
|
|
2835
|
+
*/
|
|
2836
|
+
'countryCode'?: string | null;
|
|
2837
|
+
/**
|
|
2838
|
+
* The venue\'s BCP 47 locale: its country\'s main language and the country (FI is fi-FI); null until Vendure\'s seller sync has sent the country
|
|
2839
|
+
* @type {string}
|
|
2840
|
+
* @memberof ConfigDto
|
|
2841
|
+
*/
|
|
2842
|
+
'locale'?: string | null;
|
|
2775
2843
|
/**
|
|
2776
2844
|
* Creation date and time in ISO 8601 format
|
|
2777
2845
|
* @type {string}
|
|
@@ -2900,7 +2968,7 @@ export interface ConfigManagementResponseDto {
|
|
|
2900
2968
|
*/
|
|
2901
2969
|
'message'?: string;
|
|
2902
2970
|
/**
|
|
2903
|
-
* What was saved, as the database wrote it: the venue, the config, the provider\'s config without its secrets, the options, the integration (the third-party gift card\'s credentials without the password), { program, businessId } for loyalty, { businessId, keys } for a sync, { id, removed } for a removed option.
|
|
2971
|
+
* What was saved, as the database wrote it: the venue, the config, the provider\'s config without its secrets, the options, the integration (the third-party gift card\'s credentials without the password), { program, businessId } for loyalty (the program\'s secretKey answered null), { businessId, keys } for a sync, { id, removed } for a removed option.
|
|
2904
2972
|
* @type {object}
|
|
2905
2973
|
* @memberof ConfigManagementResponseDto
|
|
2906
2974
|
*/
|
|
@@ -4305,6 +4373,140 @@ export declare const CurrencyCode: {
|
|
|
4305
4373
|
readonly Bam: "BAM";
|
|
4306
4374
|
readonly Aed: "AED";
|
|
4307
4375
|
readonly Usd: "USD";
|
|
4376
|
+
readonly Afn: "AFN";
|
|
4377
|
+
readonly Amd: "AMD";
|
|
4378
|
+
readonly Aoa: "AOA";
|
|
4379
|
+
readonly Ars: "ARS";
|
|
4380
|
+
readonly Aud: "AUD";
|
|
4381
|
+
readonly Awg: "AWG";
|
|
4382
|
+
readonly Azn: "AZN";
|
|
4383
|
+
readonly Bbd: "BBD";
|
|
4384
|
+
readonly Bdt: "BDT";
|
|
4385
|
+
readonly Bhd: "BHD";
|
|
4386
|
+
readonly Bif: "BIF";
|
|
4387
|
+
readonly Bmd: "BMD";
|
|
4388
|
+
readonly Bnd: "BND";
|
|
4389
|
+
readonly Bob: "BOB";
|
|
4390
|
+
readonly Brl: "BRL";
|
|
4391
|
+
readonly Bsd: "BSD";
|
|
4392
|
+
readonly Btn: "BTN";
|
|
4393
|
+
readonly Bwp: "BWP";
|
|
4394
|
+
readonly Byn: "BYN";
|
|
4395
|
+
readonly Bzd: "BZD";
|
|
4396
|
+
readonly Cad: "CAD";
|
|
4397
|
+
readonly Cdf: "CDF";
|
|
4398
|
+
readonly Clp: "CLP";
|
|
4399
|
+
readonly Cny: "CNY";
|
|
4400
|
+
readonly Cop: "COP";
|
|
4401
|
+
readonly Crc: "CRC";
|
|
4402
|
+
readonly Cup: "CUP";
|
|
4403
|
+
readonly Cve: "CVE";
|
|
4404
|
+
readonly Djf: "DJF";
|
|
4405
|
+
readonly Dop: "DOP";
|
|
4406
|
+
readonly Dzd: "DZD";
|
|
4407
|
+
readonly Egp: "EGP";
|
|
4408
|
+
readonly Ern: "ERN";
|
|
4409
|
+
readonly Etb: "ETB";
|
|
4410
|
+
readonly Fjd: "FJD";
|
|
4411
|
+
readonly Fkp: "FKP";
|
|
4412
|
+
readonly Gel: "GEL";
|
|
4413
|
+
readonly Ghs: "GHS";
|
|
4414
|
+
readonly Gip: "GIP";
|
|
4415
|
+
readonly Gmd: "GMD";
|
|
4416
|
+
readonly Gnf: "GNF";
|
|
4417
|
+
readonly Gtq: "GTQ";
|
|
4418
|
+
readonly Gyd: "GYD";
|
|
4419
|
+
readonly Hkd: "HKD";
|
|
4420
|
+
readonly Hnl: "HNL";
|
|
4421
|
+
readonly Htg: "HTG";
|
|
4422
|
+
readonly Idr: "IDR";
|
|
4423
|
+
readonly Ils: "ILS";
|
|
4424
|
+
readonly Inr: "INR";
|
|
4425
|
+
readonly Iqd: "IQD";
|
|
4426
|
+
readonly Irr: "IRR";
|
|
4427
|
+
readonly Jmd: "JMD";
|
|
4428
|
+
readonly Jod: "JOD";
|
|
4429
|
+
readonly Jpy: "JPY";
|
|
4430
|
+
readonly Kes: "KES";
|
|
4431
|
+
readonly Kgs: "KGS";
|
|
4432
|
+
readonly Khr: "KHR";
|
|
4433
|
+
readonly Kmf: "KMF";
|
|
4434
|
+
readonly Kpw: "KPW";
|
|
4435
|
+
readonly Krw: "KRW";
|
|
4436
|
+
readonly Kwd: "KWD";
|
|
4437
|
+
readonly Kyd: "KYD";
|
|
4438
|
+
readonly Kzt: "KZT";
|
|
4439
|
+
readonly Lak: "LAK";
|
|
4440
|
+
readonly Lbp: "LBP";
|
|
4441
|
+
readonly Lkr: "LKR";
|
|
4442
|
+
readonly Lrd: "LRD";
|
|
4443
|
+
readonly Lsl: "LSL";
|
|
4444
|
+
readonly Lyd: "LYD";
|
|
4445
|
+
readonly Mad: "MAD";
|
|
4446
|
+
readonly Mga: "MGA";
|
|
4447
|
+
readonly Mmk: "MMK";
|
|
4448
|
+
readonly Mnt: "MNT";
|
|
4449
|
+
readonly Mop: "MOP";
|
|
4450
|
+
readonly Mru: "MRU";
|
|
4451
|
+
readonly Mur: "MUR";
|
|
4452
|
+
readonly Mvr: "MVR";
|
|
4453
|
+
readonly Mwk: "MWK";
|
|
4454
|
+
readonly Mxn: "MXN";
|
|
4455
|
+
readonly Myr: "MYR";
|
|
4456
|
+
readonly Mzn: "MZN";
|
|
4457
|
+
readonly Nad: "NAD";
|
|
4458
|
+
readonly Ngn: "NGN";
|
|
4459
|
+
readonly Nio: "NIO";
|
|
4460
|
+
readonly Npr: "NPR";
|
|
4461
|
+
readonly Nzd: "NZD";
|
|
4462
|
+
readonly Omr: "OMR";
|
|
4463
|
+
readonly Pab: "PAB";
|
|
4464
|
+
readonly Pen: "PEN";
|
|
4465
|
+
readonly Pgk: "PGK";
|
|
4466
|
+
readonly Php: "PHP";
|
|
4467
|
+
readonly Pkr: "PKR";
|
|
4468
|
+
readonly Pyg: "PYG";
|
|
4469
|
+
readonly Qar: "QAR";
|
|
4470
|
+
readonly Rwf: "RWF";
|
|
4471
|
+
readonly Sar: "SAR";
|
|
4472
|
+
readonly Sbd: "SBD";
|
|
4473
|
+
readonly Scr: "SCR";
|
|
4474
|
+
readonly Sdg: "SDG";
|
|
4475
|
+
readonly Sgd: "SGD";
|
|
4476
|
+
readonly Shp: "SHP";
|
|
4477
|
+
readonly Sle: "SLE";
|
|
4478
|
+
readonly Sos: "SOS";
|
|
4479
|
+
readonly Srd: "SRD";
|
|
4480
|
+
readonly Ssp: "SSP";
|
|
4481
|
+
readonly Stn: "STN";
|
|
4482
|
+
readonly Svc: "SVC";
|
|
4483
|
+
readonly Syp: "SYP";
|
|
4484
|
+
readonly Szl: "SZL";
|
|
4485
|
+
readonly Thb: "THB";
|
|
4486
|
+
readonly Tjs: "TJS";
|
|
4487
|
+
readonly Tmt: "TMT";
|
|
4488
|
+
readonly Tnd: "TND";
|
|
4489
|
+
readonly Top: "TOP";
|
|
4490
|
+
readonly Ttd: "TTD";
|
|
4491
|
+
readonly Twd: "TWD";
|
|
4492
|
+
readonly Tzs: "TZS";
|
|
4493
|
+
readonly Ugx: "UGX";
|
|
4494
|
+
readonly Uyu: "UYU";
|
|
4495
|
+
readonly Uzs: "UZS";
|
|
4496
|
+
readonly Ved: "VED";
|
|
4497
|
+
readonly Ves: "VES";
|
|
4498
|
+
readonly Vnd: "VND";
|
|
4499
|
+
readonly Vuv: "VUV";
|
|
4500
|
+
readonly Wst: "WST";
|
|
4501
|
+
readonly Xaf: "XAF";
|
|
4502
|
+
readonly Xcd: "XCD";
|
|
4503
|
+
readonly Xcg: "XCG";
|
|
4504
|
+
readonly Xof: "XOF";
|
|
4505
|
+
readonly Xpf: "XPF";
|
|
4506
|
+
readonly Yer: "YER";
|
|
4507
|
+
readonly Zar: "ZAR";
|
|
4508
|
+
readonly Zmw: "ZMW";
|
|
4509
|
+
readonly Zwg: "ZWG";
|
|
4308
4510
|
};
|
|
4309
4511
|
export type CurrencyCode = typeof CurrencyCode[keyof typeof CurrencyCode];
|
|
4310
4512
|
/**
|
|
@@ -6030,13 +6232,13 @@ export interface EpassiCredentialsSavedDto {
|
|
|
6030
6232
|
*/
|
|
6031
6233
|
'accessKeyEnding': string;
|
|
6032
6234
|
/**
|
|
6033
|
-
*
|
|
6235
|
+
* Munchi\'s 2048-bit RSA public key for this environment, in PEM format: the key Epassi verifies every venue\'s requests with. It is the same for every venue; the private half never leaves the server.
|
|
6034
6236
|
* @type {string}
|
|
6035
6237
|
* @memberof EpassiCredentialsSavedDto
|
|
6036
6238
|
*/
|
|
6037
6239
|
'publicKey': string;
|
|
6038
6240
|
/**
|
|
6039
|
-
*
|
|
6241
|
+
* Always false: every venue signs with the environment\'s key, which Epassi already holds, so a save never makes a key pair. Kept for the clients that read it.
|
|
6040
6242
|
* @type {boolean}
|
|
6041
6243
|
* @memberof EpassiCredentialsSavedDto
|
|
6042
6244
|
*/
|
|
@@ -6455,6 +6657,18 @@ export interface ExternalBusinessConfigDto {
|
|
|
6455
6657
|
* @memberof ExternalBusinessConfigDto
|
|
6456
6658
|
*/
|
|
6457
6659
|
'currency': CurrencyCode;
|
|
6660
|
+
/**
|
|
6661
|
+
* The venue\'s country, ISO 3166-1 alpha-2, from the seller\'s address in Vendure; null until Vendure\'s seller sync has sent it
|
|
6662
|
+
* @type {string}
|
|
6663
|
+
* @memberof ExternalBusinessConfigDto
|
|
6664
|
+
*/
|
|
6665
|
+
'countryCode'?: string | null;
|
|
6666
|
+
/**
|
|
6667
|
+
* The venue\'s BCP 47 locale: its country\'s main language and the country (FI is fi-FI); null until Vendure\'s seller sync has sent the country
|
|
6668
|
+
* @type {string}
|
|
6669
|
+
* @memberof ExternalBusinessConfigDto
|
|
6670
|
+
*/
|
|
6671
|
+
'locale'?: string | null;
|
|
6458
6672
|
/**
|
|
6459
6673
|
*
|
|
6460
6674
|
* @type {PaymentProvider}
|
|
@@ -6619,6 +6833,18 @@ export interface ExternalBusinessConfigResponseDtoConfig {
|
|
|
6619
6833
|
* @memberof ExternalBusinessConfigResponseDtoConfig
|
|
6620
6834
|
*/
|
|
6621
6835
|
'currency': CurrencyCode;
|
|
6836
|
+
/**
|
|
6837
|
+
* The venue\'s country, ISO 3166-1 alpha-2, from the seller\'s address in Vendure; null until Vendure\'s seller sync has sent it
|
|
6838
|
+
* @type {string}
|
|
6839
|
+
* @memberof ExternalBusinessConfigResponseDtoConfig
|
|
6840
|
+
*/
|
|
6841
|
+
'countryCode'?: string | null;
|
|
6842
|
+
/**
|
|
6843
|
+
* The venue\'s BCP 47 locale: its country\'s main language and the country (FI is fi-FI); null until Vendure\'s seller sync has sent the country
|
|
6844
|
+
* @type {string}
|
|
6845
|
+
* @memberof ExternalBusinessConfigResponseDtoConfig
|
|
6846
|
+
*/
|
|
6847
|
+
'locale'?: string | null;
|
|
6622
6848
|
/**
|
|
6623
6849
|
*
|
|
6624
6850
|
* @type {PaymentProvider}
|
|
@@ -7201,13 +7427,13 @@ export interface GiftCardInfoDto {
|
|
|
7201
7427
|
*/
|
|
7202
7428
|
'title': string;
|
|
7203
7429
|
/**
|
|
7204
|
-
* What is left on the card, in euros
|
|
7430
|
+
* What is left on the card, in units of its currency (euros for EUR, not cents)
|
|
7205
7431
|
* @type {number}
|
|
7206
7432
|
* @memberof GiftCardInfoDto
|
|
7207
7433
|
*/
|
|
7208
7434
|
'balance': number;
|
|
7209
7435
|
/**
|
|
7210
|
-
* The card\'s currency code;
|
|
7436
|
+
* The card\'s currency code; the venue\'s currency when Luckiefun sends none
|
|
7211
7437
|
* @type {string}
|
|
7212
7438
|
* @memberof GiftCardInfoDto
|
|
7213
7439
|
*/
|
|
@@ -8093,6 +8319,17 @@ export declare const KDSEVENTNAME: {
|
|
|
8093
8319
|
readonly PrintingOrder: "printing.order";
|
|
8094
8320
|
};
|
|
8095
8321
|
export type KDSEVENTNAME = typeof KDSEVENTNAME[keyof typeof KDSEVENTNAME];
|
|
8322
|
+
/**
|
|
8323
|
+
*
|
|
8324
|
+
* @export
|
|
8325
|
+
* @enum {string}
|
|
8326
|
+
*/
|
|
8327
|
+
export declare const KdsBulkReadySkipReason: {
|
|
8328
|
+
readonly Found: "NOT_FOUND";
|
|
8329
|
+
readonly Pos: "NOT_POS";
|
|
8330
|
+
readonly InProgress: "NOT_IN_PROGRESS";
|
|
8331
|
+
};
|
|
8332
|
+
export type KdsBulkReadySkipReason = typeof KdsBulkReadySkipReason[keyof typeof KdsBulkReadySkipReason];
|
|
8096
8333
|
/**
|
|
8097
8334
|
*
|
|
8098
8335
|
* @export
|
|
@@ -8297,6 +8534,31 @@ export interface KdsLocationDtoCoordinates {
|
|
|
8297
8534
|
*/
|
|
8298
8535
|
'lon': number | null;
|
|
8299
8536
|
}
|
|
8537
|
+
/**
|
|
8538
|
+
*
|
|
8539
|
+
* @export
|
|
8540
|
+
* @interface KdsMarkOrdersReadyDto
|
|
8541
|
+
*/
|
|
8542
|
+
export interface KdsMarkOrdersReadyDto {
|
|
8543
|
+
/**
|
|
8544
|
+
* The venue\'s orderingBusinessId
|
|
8545
|
+
* @type {number}
|
|
8546
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8547
|
+
*/
|
|
8548
|
+
'businessId': number;
|
|
8549
|
+
/**
|
|
8550
|
+
* The id of the station (KDS profile) whose orders are marked ready
|
|
8551
|
+
* @type {string}
|
|
8552
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8553
|
+
*/
|
|
8554
|
+
'profileId': string;
|
|
8555
|
+
/**
|
|
8556
|
+
* The KDS orders\' ids in kds-service, each once, 1 to 100 of them
|
|
8557
|
+
* @type {Array<string>}
|
|
8558
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8559
|
+
*/
|
|
8560
|
+
'orderIds': Array<string>;
|
|
8561
|
+
}
|
|
8300
8562
|
/**
|
|
8301
8563
|
*
|
|
8302
8564
|
* @export
|
|
@@ -8669,6 +8931,25 @@ export interface KdsOrderItemDto {
|
|
|
8669
8931
|
*/
|
|
8670
8932
|
'options': Array<KdsOrderOptionDto>;
|
|
8671
8933
|
}
|
|
8934
|
+
/**
|
|
8935
|
+
*
|
|
8936
|
+
* @export
|
|
8937
|
+
* @interface KdsOrderLeftAsItIsDto
|
|
8938
|
+
*/
|
|
8939
|
+
export interface KdsOrderLeftAsItIsDto {
|
|
8940
|
+
/**
|
|
8941
|
+
* The id of a KDS order kds-service did not mark ready
|
|
8942
|
+
* @type {string}
|
|
8943
|
+
* @memberof KdsOrderLeftAsItIsDto
|
|
8944
|
+
*/
|
|
8945
|
+
'orderId': string;
|
|
8946
|
+
/**
|
|
8947
|
+
*
|
|
8948
|
+
* @type {KdsBulkReadySkipReason}
|
|
8949
|
+
* @memberof KdsOrderLeftAsItIsDto
|
|
8950
|
+
*/
|
|
8951
|
+
'reason': KdsBulkReadySkipReason;
|
|
8952
|
+
}
|
|
8672
8953
|
/**
|
|
8673
8954
|
*
|
|
8674
8955
|
* @export
|
|
@@ -9419,6 +9700,43 @@ export interface KdsReadyOrderResponseDtoOrder {
|
|
|
9419
9700
|
*/
|
|
9420
9701
|
'items': Array<KdsOrderItemDto>;
|
|
9421
9702
|
}
|
|
9703
|
+
/**
|
|
9704
|
+
*
|
|
9705
|
+
* @export
|
|
9706
|
+
* @interface KdsReadyOrdersResponseDto
|
|
9707
|
+
*/
|
|
9708
|
+
export interface KdsReadyOrdersResponseDto {
|
|
9709
|
+
/**
|
|
9710
|
+
* The ids of the KDS orders marked ready; empty when none were
|
|
9711
|
+
* @type {Array<string>}
|
|
9712
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
9713
|
+
*/
|
|
9714
|
+
'ready': Array<string>;
|
|
9715
|
+
/**
|
|
9716
|
+
* The ids kds-service left as they are, each with its reason; empty when none were
|
|
9717
|
+
* @type {Array<KdsOrderLeftAsItIsDto>}
|
|
9718
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
9719
|
+
*/
|
|
9720
|
+
'skipped': Array<KdsOrderLeftAsItIsDto>;
|
|
9721
|
+
/**
|
|
9722
|
+
* 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
|
|
9723
|
+
* @type {Array<string>}
|
|
9724
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
9725
|
+
*/
|
|
9726
|
+
'notAnnounced'?: Array<string>;
|
|
9727
|
+
/**
|
|
9728
|
+
* true when kds-service answered; false when it refused or could not be reached, and then nothing is listed
|
|
9729
|
+
* @type {boolean}
|
|
9730
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
9731
|
+
*/
|
|
9732
|
+
'status': boolean;
|
|
9733
|
+
/**
|
|
9734
|
+
* Human-readable status message
|
|
9735
|
+
* @type {string}
|
|
9736
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
9737
|
+
*/
|
|
9738
|
+
'message': string;
|
|
9739
|
+
}
|
|
9422
9740
|
/**
|
|
9423
9741
|
*
|
|
9424
9742
|
* @export
|
|
@@ -12976,6 +13294,14 @@ export interface OrderHistoryPosResponseDtoV2Summary {
|
|
|
12976
13294
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
12977
13295
|
*/
|
|
12978
13296
|
'totalTipAmount'?: number;
|
|
13297
|
+
/**
|
|
13298
|
+
* Each currency\'s sales of the period, in that currency\'s units (not minor units), keyed by its ISO 4217 code. Present only when the period\'s orders are in more than one currency; totalSales then holds the venue currency\'s sales alone, as amounts of two currencies are never added.
|
|
13299
|
+
* @type {{ [key: string]: number; }}
|
|
13300
|
+
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
13301
|
+
*/
|
|
13302
|
+
'totalsByCurrency'?: {
|
|
13303
|
+
[key: string]: number;
|
|
13304
|
+
};
|
|
12979
13305
|
}
|
|
12980
13306
|
/**
|
|
12981
13307
|
*
|
|
@@ -17215,6 +17541,28 @@ export interface PosActionPasscodeDto {
|
|
|
17215
17541
|
*/
|
|
17216
17542
|
'pinHash': string;
|
|
17217
17543
|
}
|
|
17544
|
+
/**
|
|
17545
|
+
*
|
|
17546
|
+
* @export
|
|
17547
|
+
* @enum {string}
|
|
17548
|
+
*/
|
|
17549
|
+
export declare const PosBulkOrderStatus: {
|
|
17550
|
+
readonly Ready: "ready";
|
|
17551
|
+
readonly Delivered: "delivered";
|
|
17552
|
+
};
|
|
17553
|
+
export type PosBulkOrderStatus = typeof PosBulkOrderStatus[keyof typeof PosBulkOrderStatus];
|
|
17554
|
+
/**
|
|
17555
|
+
*
|
|
17556
|
+
* @export
|
|
17557
|
+
* @enum {string}
|
|
17558
|
+
*/
|
|
17559
|
+
export declare const PosBulkStatusSkipReason: {
|
|
17560
|
+
readonly NotFound: "NOT_FOUND";
|
|
17561
|
+
readonly NotInProgress: "NOT_IN_PROGRESS";
|
|
17562
|
+
readonly KitchenControlled: "KITCHEN_CONTROLLED";
|
|
17563
|
+
readonly NotReady: "NOT_READY";
|
|
17564
|
+
};
|
|
17565
|
+
export type PosBulkStatusSkipReason = typeof PosBulkStatusSkipReason[keyof typeof PosBulkStatusSkipReason];
|
|
17218
17566
|
/**
|
|
17219
17567
|
*
|
|
17220
17568
|
* @export
|
|
@@ -19417,6 +19765,25 @@ export interface PosOrderItemSplitSeatDto {
|
|
|
19417
19765
|
*/
|
|
19418
19766
|
'assignments': Array<PosOrderItemSplitSeatAssignmentDto>;
|
|
19419
19767
|
}
|
|
19768
|
+
/**
|
|
19769
|
+
*
|
|
19770
|
+
* @export
|
|
19771
|
+
* @interface PosOrderLeftAsItIsDto
|
|
19772
|
+
*/
|
|
19773
|
+
export interface PosOrderLeftAsItIsDto {
|
|
19774
|
+
/**
|
|
19775
|
+
* The id the till sent of a ticket or an order that was not moved
|
|
19776
|
+
* @type {string}
|
|
19777
|
+
* @memberof PosOrderLeftAsItIsDto
|
|
19778
|
+
*/
|
|
19779
|
+
'orderId': string;
|
|
19780
|
+
/**
|
|
19781
|
+
*
|
|
19782
|
+
* @type {PosBulkStatusSkipReason}
|
|
19783
|
+
* @memberof PosOrderLeftAsItIsDto
|
|
19784
|
+
*/
|
|
19785
|
+
'reason': PosBulkStatusSkipReason;
|
|
19786
|
+
}
|
|
19420
19787
|
/**
|
|
19421
19788
|
*
|
|
19422
19789
|
* @export
|
|
@@ -19522,6 +19889,51 @@ export interface PosOrderSuboptionDto {
|
|
|
19522
19889
|
*/
|
|
19523
19890
|
'value_pos_id': string | null;
|
|
19524
19891
|
}
|
|
19892
|
+
/**
|
|
19893
|
+
*
|
|
19894
|
+
* @export
|
|
19895
|
+
* @interface PosOrderSummaryDto
|
|
19896
|
+
*/
|
|
19897
|
+
export interface PosOrderSummaryDto {
|
|
19898
|
+
/**
|
|
19899
|
+
* How many orders of the period count: online, every order not rejected; POS, every order not fully refunded (with a payment filter, only those with a matching payment). 0 when the person on the till may not see it.
|
|
19900
|
+
* @type {number}
|
|
19901
|
+
* @memberof PosOrderSummaryDto
|
|
19902
|
+
*/
|
|
19903
|
+
'totalOrders': number;
|
|
19904
|
+
/**
|
|
19905
|
+
* How many orders of the period were rejected. Always 0 in the POS history. 0 when the person on the till may not see it.
|
|
19906
|
+
* @type {number}
|
|
19907
|
+
* @memberof PosOrderSummaryDto
|
|
19908
|
+
*/
|
|
19909
|
+
'rejectedOrders': number;
|
|
19910
|
+
/**
|
|
19911
|
+
* The period\'s sales in euros (not cents): online, the net total of the orders not rejected; POS, the payments less successful refunds. 0 when the person on the till may not see it.
|
|
19912
|
+
* @type {number}
|
|
19913
|
+
* @memberof PosOrderSummaryDto
|
|
19914
|
+
*/
|
|
19915
|
+
'totalSales': number;
|
|
19916
|
+
/**
|
|
19917
|
+
* The net total of the period\'s rejected orders, in euros. Always 0 in the POS history. 0 when the person on the till may not see it.
|
|
19918
|
+
* @type {number}
|
|
19919
|
+
* @memberof PosOrderSummaryDto
|
|
19920
|
+
*/
|
|
19921
|
+
'rejectedSales': number;
|
|
19922
|
+
/**
|
|
19923
|
+
* POS history only: the tips of the orders on this page, in cents. Absent from the online history.
|
|
19924
|
+
* @type {number}
|
|
19925
|
+
* @memberof PosOrderSummaryDto
|
|
19926
|
+
*/
|
|
19927
|
+
'totalTipAmount'?: number;
|
|
19928
|
+
/**
|
|
19929
|
+
* Each currency\'s sales of the period, in that currency\'s units (not minor units), keyed by its ISO 4217 code. Present only when the period\'s orders are in more than one currency; totalSales then holds the venue currency\'s sales alone, as amounts of two currencies are never added.
|
|
19930
|
+
* @type {{ [key: string]: number; }}
|
|
19931
|
+
* @memberof PosOrderSummaryDto
|
|
19932
|
+
*/
|
|
19933
|
+
'totalsByCurrency'?: {
|
|
19934
|
+
[key: string]: number;
|
|
19935
|
+
};
|
|
19936
|
+
}
|
|
19525
19937
|
/**
|
|
19526
19938
|
*
|
|
19527
19939
|
* @export
|
|
@@ -22078,13 +22490,13 @@ export interface RedeemGiftCardResponseDto {
|
|
|
22078
22490
|
*/
|
|
22079
22491
|
'redeemedAmount'?: number;
|
|
22080
22492
|
/**
|
|
22081
|
-
* On success: what is left on the card, in euros
|
|
22493
|
+
* On success: what is left on the card, in units of its currency (euros for EUR, not cents); 0 when the provider does not say
|
|
22082
22494
|
* @type {number}
|
|
22083
22495
|
* @memberof RedeemGiftCardResponseDto
|
|
22084
22496
|
*/
|
|
22085
22497
|
'remainingBalance'?: number;
|
|
22086
22498
|
/**
|
|
22087
|
-
* On success: the card\'s currency code;
|
|
22499
|
+
* On success: the card\'s currency code; the venue\'s currency when the provider does not say
|
|
22088
22500
|
* @type {string}
|
|
22089
22501
|
* @memberof RedeemGiftCardResponseDto
|
|
22090
22502
|
*/
|
|
@@ -22558,6 +22970,71 @@ export interface RejectOrderDto {
|
|
|
22558
22970
|
*/
|
|
22559
22971
|
'reason': string;
|
|
22560
22972
|
}
|
|
22973
|
+
/**
|
|
22974
|
+
*
|
|
22975
|
+
* @export
|
|
22976
|
+
* @enum {string}
|
|
22977
|
+
*/
|
|
22978
|
+
export declare const ReportApp: {
|
|
22979
|
+
readonly Pos: "pos";
|
|
22980
|
+
readonly Kiosk: "kiosk";
|
|
22981
|
+
readonly Storefront: "storefront";
|
|
22982
|
+
readonly Mobile: "mobile";
|
|
22983
|
+
};
|
|
22984
|
+
export type ReportApp = typeof ReportApp[keyof typeof ReportApp];
|
|
22985
|
+
/**
|
|
22986
|
+
*
|
|
22987
|
+
* @export
|
|
22988
|
+
* @enum {string}
|
|
22989
|
+
*/
|
|
22990
|
+
export declare const ReportBaselineLeftOut: {
|
|
22991
|
+
readonly IsTheBaseline: "is_the_baseline";
|
|
22992
|
+
readonly OtherCurrency: "other_currency";
|
|
22993
|
+
};
|
|
22994
|
+
export type ReportBaselineLeftOut = typeof ReportBaselineLeftOut[keyof typeof ReportBaselineLeftOut];
|
|
22995
|
+
/**
|
|
22996
|
+
*
|
|
22997
|
+
* @export
|
|
22998
|
+
* @enum {string}
|
|
22999
|
+
*/
|
|
23000
|
+
export declare const ReportBreakdown: {
|
|
23001
|
+
readonly None: "none";
|
|
23002
|
+
readonly Venue: "venue";
|
|
23003
|
+
readonly App: "app";
|
|
23004
|
+
readonly VenueApp: "venue_app";
|
|
23005
|
+
};
|
|
23006
|
+
export type ReportBreakdown = typeof ReportBreakdown[keyof typeof ReportBreakdown];
|
|
23007
|
+
/**
|
|
23008
|
+
*
|
|
23009
|
+
* @export
|
|
23010
|
+
* @enum {string}
|
|
23011
|
+
*/
|
|
23012
|
+
export declare const ReportChangeField: {
|
|
23013
|
+
readonly SalesReportTotalQuantity: "salesReport.totalQuantity";
|
|
23014
|
+
readonly SalesReportTotalWithTax: "salesReport.totalWithTax";
|
|
23015
|
+
readonly SalesReportTotalTaxAmount: "salesReport.totalTaxAmount";
|
|
23016
|
+
readonly SalesReportTotalWithoutTax: "salesReport.totalWithoutTax";
|
|
23017
|
+
readonly SalesReportDeliveryFee: "salesReport.deliveryFee";
|
|
23018
|
+
readonly SalesReportDeliveryTax: "salesReport.deliveryTax";
|
|
23019
|
+
readonly PaymentReportSummarySalesAndRevenue: "paymentReport.summary.salesAndRevenue";
|
|
23020
|
+
readonly PaymentReportSummaryGrossAmount: "paymentReport.summary.grossAmount";
|
|
23021
|
+
readonly PaymentReportSummaryTotalCount: "paymentReport.summary.totalCount";
|
|
23022
|
+
readonly PaymentReportSummaryTotalAmount: "paymentReport.summary.totalAmount";
|
|
23023
|
+
readonly PaymentReportSummaryCardsCount: "paymentReport.summary.cardsCount";
|
|
23024
|
+
readonly PaymentReportSummaryCardsAmount: "paymentReport.summary.cardsAmount";
|
|
23025
|
+
readonly PaymentReportSummaryEdenredVoucherCount: "paymentReport.summary.edenredVoucherCount";
|
|
23026
|
+
readonly PaymentReportSummaryEdenredVoucherAmount: "paymentReport.summary.edenredVoucherAmount";
|
|
23027
|
+
readonly PaymentReportSummarySmartumVoucherCount: "paymentReport.summary.smartumVoucherCount";
|
|
23028
|
+
readonly PaymentReportSummarySmartumVoucherAmount: "paymentReport.summary.smartumVoucherAmount";
|
|
23029
|
+
readonly PaymentReportSummaryTotalCoupons: "paymentReport.summary.totalCoupons";
|
|
23030
|
+
readonly PaymentReportSummaryTotalVoucherForfeited: "paymentReport.summary.totalVoucherForfeited";
|
|
23031
|
+
readonly PaymentReportSummaryTotalTipAmount: "paymentReport.summary.totalTipAmount";
|
|
23032
|
+
readonly PaymentReportSummaryTotalSurchargeAmount: "paymentReport.summary.totalSurchargeAmount";
|
|
23033
|
+
readonly PaymentReportSummaryTotalRefunds: "paymentReport.summary.totalRefunds";
|
|
23034
|
+
readonly PaymentReportSummaryRefundCount: "paymentReport.summary.refundCount";
|
|
23035
|
+
readonly PaymentReportTotalDiscounts: "paymentReport.totalDiscounts";
|
|
23036
|
+
};
|
|
23037
|
+
export type ReportChangeField = typeof ReportChangeField[keyof typeof ReportChangeField];
|
|
22561
23038
|
/**
|
|
22562
23039
|
*
|
|
22563
23040
|
* @export
|
|
@@ -22568,6 +23045,19 @@ export declare const ReportLanguage: {
|
|
|
22568
23045
|
readonly En: "en";
|
|
22569
23046
|
};
|
|
22570
23047
|
export type ReportLanguage = typeof ReportLanguage[keyof typeof ReportLanguage];
|
|
23048
|
+
/**
|
|
23049
|
+
*
|
|
23050
|
+
* @export
|
|
23051
|
+
* @enum {string}
|
|
23052
|
+
*/
|
|
23053
|
+
export declare const ReportPart: {
|
|
23054
|
+
readonly Summary: "summary";
|
|
23055
|
+
readonly Items: "items";
|
|
23056
|
+
readonly Vat: "vat";
|
|
23057
|
+
readonly Payments: "payments";
|
|
23058
|
+
readonly Discounts: "discounts";
|
|
23059
|
+
};
|
|
23060
|
+
export type ReportPart = typeof ReportPart[keyof typeof ReportPart];
|
|
22571
23061
|
/**
|
|
22572
23062
|
*
|
|
22573
23063
|
* @export
|
|
@@ -23073,6 +23563,1016 @@ export declare const SYNCKEY: {
|
|
|
23073
23563
|
readonly ReceiptFooter: "RECEIPT_FOOTER";
|
|
23074
23564
|
};
|
|
23075
23565
|
export type SYNCKEY = typeof SYNCKEY[keyof typeof SYNCKEY];
|
|
23566
|
+
/**
|
|
23567
|
+
*
|
|
23568
|
+
* @export
|
|
23569
|
+
* @interface SalesReportCategoryDto
|
|
23570
|
+
*/
|
|
23571
|
+
export interface SalesReportCategoryDto {
|
|
23572
|
+
/**
|
|
23573
|
+
* The category\'s name
|
|
23574
|
+
* @type {string}
|
|
23575
|
+
* @memberof SalesReportCategoryDto
|
|
23576
|
+
*/
|
|
23577
|
+
'categoryName': string;
|
|
23578
|
+
/**
|
|
23579
|
+
* How many of its items were sold
|
|
23580
|
+
* @type {number}
|
|
23581
|
+
* @memberof SalesReportCategoryDto
|
|
23582
|
+
*/
|
|
23583
|
+
'totalQuantity': number;
|
|
23584
|
+
/**
|
|
23585
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23586
|
+
* @type {number}
|
|
23587
|
+
* @memberof SalesReportCategoryDto
|
|
23588
|
+
*/
|
|
23589
|
+
'totalWithTax': number;
|
|
23590
|
+
/**
|
|
23591
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23592
|
+
* @type {number}
|
|
23593
|
+
* @memberof SalesReportCategoryDto
|
|
23594
|
+
*/
|
|
23595
|
+
'taxAmount': number;
|
|
23596
|
+
/**
|
|
23597
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23598
|
+
* @type {number}
|
|
23599
|
+
* @memberof SalesReportCategoryDto
|
|
23600
|
+
*/
|
|
23601
|
+
'totalWithoutTax': number;
|
|
23602
|
+
/**
|
|
23603
|
+
* Its items
|
|
23604
|
+
* @type {Array<SalesReportItemDto>}
|
|
23605
|
+
* @memberof SalesReportCategoryDto
|
|
23606
|
+
*/
|
|
23607
|
+
'items': Array<SalesReportItemDto>;
|
|
23608
|
+
}
|
|
23609
|
+
/**
|
|
23610
|
+
*
|
|
23611
|
+
* @export
|
|
23612
|
+
* @interface SalesReportChangeDto
|
|
23613
|
+
*/
|
|
23614
|
+
export interface SalesReportChangeDto {
|
|
23615
|
+
/**
|
|
23616
|
+
*
|
|
23617
|
+
* @type {ReportChangeField}
|
|
23618
|
+
* @memberof SalesReportChangeDto
|
|
23619
|
+
*/
|
|
23620
|
+
'field': ReportChangeField;
|
|
23621
|
+
/**
|
|
23622
|
+
* 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)
|
|
23623
|
+
* @type {number}
|
|
23624
|
+
* @memberof SalesReportChangeDto
|
|
23625
|
+
*/
|
|
23626
|
+
'current': number;
|
|
23627
|
+
/**
|
|
23628
|
+
* 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)
|
|
23629
|
+
* @type {number}
|
|
23630
|
+
* @memberof SalesReportChangeDto
|
|
23631
|
+
*/
|
|
23632
|
+
'previous': number;
|
|
23633
|
+
/**
|
|
23634
|
+
* 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
|
|
23635
|
+
* @type {number}
|
|
23636
|
+
* @memberof SalesReportChangeDto
|
|
23637
|
+
*/
|
|
23638
|
+
'difference': number;
|
|
23639
|
+
/**
|
|
23640
|
+
* difference as a percent of previous, rounded half away from zero to 2 decimals; negative when the total fell. Null when previous is 0
|
|
23641
|
+
* @type {object}
|
|
23642
|
+
* @memberof SalesReportChangeDto
|
|
23643
|
+
*/
|
|
23644
|
+
'percent': object | null;
|
|
23645
|
+
}
|
|
23646
|
+
/**
|
|
23647
|
+
*
|
|
23648
|
+
* @export
|
|
23649
|
+
* @interface SalesReportComparisonDto
|
|
23650
|
+
*/
|
|
23651
|
+
export interface SalesReportComparisonDto {
|
|
23652
|
+
/**
|
|
23653
|
+
* The first instant of the compared period, ISO 8601 in UTC
|
|
23654
|
+
* @type {string}
|
|
23655
|
+
* @memberof SalesReportComparisonDto
|
|
23656
|
+
*/
|
|
23657
|
+
'reportDateStart': string;
|
|
23658
|
+
/**
|
|
23659
|
+
* The last instant of the compared period, ISO 8601 in UTC; now, when the period ends later
|
|
23660
|
+
* @type {string}
|
|
23661
|
+
* @memberof SalesReportComparisonDto
|
|
23662
|
+
*/
|
|
23663
|
+
'reportDateEnd': string;
|
|
23664
|
+
/**
|
|
23665
|
+
* The first business day compared, YYYY-MM-DD, in the report\'s time zone
|
|
23666
|
+
* @type {string}
|
|
23667
|
+
* @memberof SalesReportComparisonDto
|
|
23668
|
+
*/
|
|
23669
|
+
'firstBusinessDay': string;
|
|
23670
|
+
/**
|
|
23671
|
+
* The last business day compared, YYYY-MM-DD, inclusive
|
|
23672
|
+
* @type {string}
|
|
23673
|
+
* @memberof SalesReportComparisonDto
|
|
23674
|
+
*/
|
|
23675
|
+
'lastBusinessDay': string;
|
|
23676
|
+
/**
|
|
23677
|
+
*
|
|
23678
|
+
* @type {SalesReportComparisonDtoSalesReport}
|
|
23679
|
+
* @memberof SalesReportComparisonDto
|
|
23680
|
+
*/
|
|
23681
|
+
'salesReport'?: SalesReportComparisonDtoSalesReport;
|
|
23682
|
+
/**
|
|
23683
|
+
*
|
|
23684
|
+
* @type {SalesReportComparisonDtoPaymentReport}
|
|
23685
|
+
* @memberof SalesReportComparisonDto
|
|
23686
|
+
*/
|
|
23687
|
+
'paymentReport'?: SalesReportComparisonDtoPaymentReport;
|
|
23688
|
+
/**
|
|
23689
|
+
* The compared period\'s days that sold, oldest first, as the group\'s own dailyBreakdown: present when it is
|
|
23690
|
+
* @type {Array<SalesReportDayDto>}
|
|
23691
|
+
* @memberof SalesReportComparisonDto
|
|
23692
|
+
*/
|
|
23693
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
23694
|
+
/**
|
|
23695
|
+
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
23696
|
+
* @type {Array<SalesReportChangeDto>}
|
|
23697
|
+
* @memberof SalesReportComparisonDto
|
|
23698
|
+
*/
|
|
23699
|
+
'changes': Array<SalesReportChangeDto>;
|
|
23700
|
+
}
|
|
23701
|
+
/**
|
|
23702
|
+
* The compared period\'s paymentReport, as the group\'s own: present when it is
|
|
23703
|
+
* @export
|
|
23704
|
+
* @interface SalesReportComparisonDtoPaymentReport
|
|
23705
|
+
*/
|
|
23706
|
+
export interface SalesReportComparisonDtoPaymentReport {
|
|
23707
|
+
/**
|
|
23708
|
+
* Part payments: one row per payment method
|
|
23709
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
23710
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
23711
|
+
*/
|
|
23712
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
23713
|
+
/**
|
|
23714
|
+
*
|
|
23715
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
23716
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
23717
|
+
*/
|
|
23718
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
23719
|
+
/**
|
|
23720
|
+
* Part discounts: one row per discount
|
|
23721
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
23722
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
23723
|
+
*/
|
|
23724
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
23725
|
+
/**
|
|
23726
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
23727
|
+
* @type {number}
|
|
23728
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
23729
|
+
*/
|
|
23730
|
+
'totalDiscounts'?: number;
|
|
23731
|
+
}
|
|
23732
|
+
/**
|
|
23733
|
+
* The compared period\'s salesReport, as the group\'s own: present when it is
|
|
23734
|
+
* @export
|
|
23735
|
+
* @interface SalesReportComparisonDtoSalesReport
|
|
23736
|
+
*/
|
|
23737
|
+
export interface SalesReportComparisonDtoSalesReport {
|
|
23738
|
+
/**
|
|
23739
|
+
* Part items: the categories with their items
|
|
23740
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
23741
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23742
|
+
*/
|
|
23743
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
23744
|
+
/**
|
|
23745
|
+
* Part vat: one row per VAT rate, lowest first
|
|
23746
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
23747
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23748
|
+
*/
|
|
23749
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
23750
|
+
/**
|
|
23751
|
+
* Part summary: how many items were sold
|
|
23752
|
+
* @type {number}
|
|
23753
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23754
|
+
*/
|
|
23755
|
+
'totalQuantity'?: number;
|
|
23756
|
+
/**
|
|
23757
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23758
|
+
* @type {number}
|
|
23759
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23760
|
+
*/
|
|
23761
|
+
'totalWithTax'?: number;
|
|
23762
|
+
/**
|
|
23763
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23764
|
+
* @type {number}
|
|
23765
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23766
|
+
*/
|
|
23767
|
+
'totalTaxAmount'?: number;
|
|
23768
|
+
/**
|
|
23769
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
23770
|
+
* @type {number}
|
|
23771
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23772
|
+
*/
|
|
23773
|
+
'totalWithoutTax'?: number;
|
|
23774
|
+
/**
|
|
23775
|
+
* 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
|
|
23776
|
+
* @type {number}
|
|
23777
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23778
|
+
*/
|
|
23779
|
+
'deliveryFee'?: number;
|
|
23780
|
+
/**
|
|
23781
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
23782
|
+
* @type {number}
|
|
23783
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
23784
|
+
*/
|
|
23785
|
+
'deliveryTax'?: number;
|
|
23786
|
+
}
|
|
23787
|
+
/**
|
|
23788
|
+
*
|
|
23789
|
+
* @export
|
|
23790
|
+
* @interface SalesReportDayDto
|
|
23791
|
+
*/
|
|
23792
|
+
export interface SalesReportDayDto {
|
|
23793
|
+
/**
|
|
23794
|
+
* The business day, YYYY-MM-DD, in the venue\'s own time zone
|
|
23795
|
+
* @type {string}
|
|
23796
|
+
* @memberof SalesReportDayDto
|
|
23797
|
+
*/
|
|
23798
|
+
'date': string;
|
|
23799
|
+
/**
|
|
23800
|
+
* How many orders were sold that day
|
|
23801
|
+
* @type {number}
|
|
23802
|
+
* @memberof SalesReportDayDto
|
|
23803
|
+
*/
|
|
23804
|
+
'orders': number;
|
|
23805
|
+
/**
|
|
23806
|
+
* How many items were sold that day
|
|
23807
|
+
* @type {number}
|
|
23808
|
+
* @memberof SalesReportDayDto
|
|
23809
|
+
*/
|
|
23810
|
+
'quantity': number;
|
|
23811
|
+
/**
|
|
23812
|
+
* What was paid, before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
23813
|
+
* @type {number}
|
|
23814
|
+
* @memberof SalesReportDayDto
|
|
23815
|
+
*/
|
|
23816
|
+
'sales': number;
|
|
23817
|
+
/**
|
|
23818
|
+
* Refunds of that day\'s orders, in the major unit of the group\'s currency (euros for EUR)
|
|
23819
|
+
* @type {number}
|
|
23820
|
+
* @memberof SalesReportDayDto
|
|
23821
|
+
*/
|
|
23822
|
+
'refunds': number;
|
|
23823
|
+
/**
|
|
23824
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
23825
|
+
* @type {number}
|
|
23826
|
+
* @memberof SalesReportDayDto
|
|
23827
|
+
*/
|
|
23828
|
+
'net': number;
|
|
23829
|
+
/**
|
|
23830
|
+
* Discounts given that day, in the major unit of the group\'s currency (euros for EUR)
|
|
23831
|
+
* @type {number}
|
|
23832
|
+
* @memberof SalesReportDayDto
|
|
23833
|
+
*/
|
|
23834
|
+
'discounts': number;
|
|
23835
|
+
/**
|
|
23836
|
+
* The VAT of the items sold that day, in the major unit of the group\'s currency (euros for EUR)
|
|
23837
|
+
* @type {number}
|
|
23838
|
+
* @memberof SalesReportDayDto
|
|
23839
|
+
*/
|
|
23840
|
+
'taxAmount': number;
|
|
23841
|
+
}
|
|
23842
|
+
/**
|
|
23843
|
+
*
|
|
23844
|
+
* @export
|
|
23845
|
+
* @interface SalesReportDiscountDto
|
|
23846
|
+
*/
|
|
23847
|
+
export interface SalesReportDiscountDto {
|
|
23848
|
+
/**
|
|
23849
|
+
* The discount\'s name
|
|
23850
|
+
* @type {string}
|
|
23851
|
+
* @memberof SalesReportDiscountDto
|
|
23852
|
+
*/
|
|
23853
|
+
'discountName': string;
|
|
23854
|
+
/**
|
|
23855
|
+
* How many times it was given
|
|
23856
|
+
* @type {number}
|
|
23857
|
+
* @memberof SalesReportDiscountDto
|
|
23858
|
+
*/
|
|
23859
|
+
'count': number;
|
|
23860
|
+
/**
|
|
23861
|
+
* What it took off, in the major unit of the group\'s currency (euros for EUR)
|
|
23862
|
+
* @type {number}
|
|
23863
|
+
* @memberof SalesReportDiscountDto
|
|
23864
|
+
*/
|
|
23865
|
+
'amount': number;
|
|
23866
|
+
}
|
|
23867
|
+
/**
|
|
23868
|
+
*
|
|
23869
|
+
* @export
|
|
23870
|
+
* @interface SalesReportGroupDto
|
|
23871
|
+
*/
|
|
23872
|
+
export interface SalesReportGroupDto {
|
|
23873
|
+
/**
|
|
23874
|
+
* The venue\'s business id; null when the breakdown adds venues together (none, app)
|
|
23875
|
+
* @type {object}
|
|
23876
|
+
* @memberof SalesReportGroupDto
|
|
23877
|
+
*/
|
|
23878
|
+
'businessId': object | null;
|
|
23879
|
+
/**
|
|
23880
|
+
*
|
|
23881
|
+
* @type {ReportApp}
|
|
23882
|
+
* @memberof SalesReportGroupDto
|
|
23883
|
+
*/
|
|
23884
|
+
'app': ReportApp | null;
|
|
23885
|
+
/**
|
|
23886
|
+
*
|
|
23887
|
+
* @type {CurrencyCode}
|
|
23888
|
+
* @memberof SalesReportGroupDto
|
|
23889
|
+
*/
|
|
23890
|
+
'currency': CurrencyCode;
|
|
23891
|
+
/**
|
|
23892
|
+
* The currency\'s ISO 4217 minor digits: EUR 2, ISK 0, BHD 3
|
|
23893
|
+
* @type {number}
|
|
23894
|
+
* @memberof SalesReportGroupDto
|
|
23895
|
+
*/
|
|
23896
|
+
'minorDigits': number;
|
|
23897
|
+
/**
|
|
23898
|
+
*
|
|
23899
|
+
* @type {SalesReportGroupDtoSalesReport}
|
|
23900
|
+
* @memberof SalesReportGroupDto
|
|
23901
|
+
*/
|
|
23902
|
+
'salesReport'?: SalesReportGroupDtoSalesReport;
|
|
23903
|
+
/**
|
|
23904
|
+
*
|
|
23905
|
+
* @type {SalesReportGroupDtoPaymentReport}
|
|
23906
|
+
* @memberof SalesReportGroupDto
|
|
23907
|
+
*/
|
|
23908
|
+
'paymentReport'?: SalesReportGroupDtoPaymentReport;
|
|
23909
|
+
/**
|
|
23910
|
+
* Part summary: one row per business day that sold, oldest first. POS leaves it out when no day sold
|
|
23911
|
+
* @type {Array<SalesReportDayDto>}
|
|
23912
|
+
* @memberof SalesReportGroupDto
|
|
23913
|
+
*/
|
|
23914
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
23915
|
+
/**
|
|
23916
|
+
*
|
|
23917
|
+
* @type {SalesReportGroupDtoComparison}
|
|
23918
|
+
* @memberof SalesReportGroupDto
|
|
23919
|
+
*/
|
|
23920
|
+
'comparison'?: SalesReportGroupDtoComparison;
|
|
23921
|
+
/**
|
|
23922
|
+
* 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
|
|
23923
|
+
* @type {Array<SalesReportChangeDto>}
|
|
23924
|
+
* @memberof SalesReportGroupDto
|
|
23925
|
+
*/
|
|
23926
|
+
'changesFromBaseline'?: Array<SalesReportChangeDto>;
|
|
23927
|
+
/**
|
|
23928
|
+
*
|
|
23929
|
+
* @type {ReportBaselineLeftOut}
|
|
23930
|
+
* @memberof SalesReportGroupDto
|
|
23931
|
+
*/
|
|
23932
|
+
'changesFromBaselineLeftOut'?: ReportBaselineLeftOut;
|
|
23933
|
+
}
|
|
23934
|
+
/**
|
|
23935
|
+
* With compareStart and compareEnd: the same group\'s report of those days and the change of each total. Left out without them
|
|
23936
|
+
* @export
|
|
23937
|
+
* @interface SalesReportGroupDtoComparison
|
|
23938
|
+
*/
|
|
23939
|
+
export interface SalesReportGroupDtoComparison {
|
|
23940
|
+
/**
|
|
23941
|
+
* The first instant of the compared period, ISO 8601 in UTC
|
|
23942
|
+
* @type {string}
|
|
23943
|
+
* @memberof SalesReportGroupDtoComparison
|
|
23944
|
+
*/
|
|
23945
|
+
'reportDateStart': string;
|
|
23946
|
+
/**
|
|
23947
|
+
* The last instant of the compared period, ISO 8601 in UTC; now, when the period ends later
|
|
23948
|
+
* @type {string}
|
|
23949
|
+
* @memberof SalesReportGroupDtoComparison
|
|
23950
|
+
*/
|
|
23951
|
+
'reportDateEnd': string;
|
|
23952
|
+
/**
|
|
23953
|
+
* The first business day compared, YYYY-MM-DD, in the report\'s time zone
|
|
23954
|
+
* @type {string}
|
|
23955
|
+
* @memberof SalesReportGroupDtoComparison
|
|
23956
|
+
*/
|
|
23957
|
+
'firstBusinessDay': string;
|
|
23958
|
+
/**
|
|
23959
|
+
* The last business day compared, YYYY-MM-DD, inclusive
|
|
23960
|
+
* @type {string}
|
|
23961
|
+
* @memberof SalesReportGroupDtoComparison
|
|
23962
|
+
*/
|
|
23963
|
+
'lastBusinessDay': string;
|
|
23964
|
+
/**
|
|
23965
|
+
*
|
|
23966
|
+
* @type {SalesReportComparisonDtoSalesReport}
|
|
23967
|
+
* @memberof SalesReportGroupDtoComparison
|
|
23968
|
+
*/
|
|
23969
|
+
'salesReport'?: SalesReportComparisonDtoSalesReport;
|
|
23970
|
+
/**
|
|
23971
|
+
*
|
|
23972
|
+
* @type {SalesReportComparisonDtoPaymentReport}
|
|
23973
|
+
* @memberof SalesReportGroupDtoComparison
|
|
23974
|
+
*/
|
|
23975
|
+
'paymentReport'?: SalesReportComparisonDtoPaymentReport;
|
|
23976
|
+
/**
|
|
23977
|
+
* The compared period\'s days that sold, oldest first, as the group\'s own dailyBreakdown: present when it is
|
|
23978
|
+
* @type {Array<SalesReportDayDto>}
|
|
23979
|
+
* @memberof SalesReportGroupDtoComparison
|
|
23980
|
+
*/
|
|
23981
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
23982
|
+
/**
|
|
23983
|
+
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
23984
|
+
* @type {Array<SalesReportChangeDto>}
|
|
23985
|
+
* @memberof SalesReportGroupDtoComparison
|
|
23986
|
+
*/
|
|
23987
|
+
'changes': Array<SalesReportChangeDto>;
|
|
23988
|
+
}
|
|
23989
|
+
/**
|
|
23990
|
+
* The portal\'s paymentReport for the group: present when part summary, payments or discounts was asked
|
|
23991
|
+
* @export
|
|
23992
|
+
* @interface SalesReportGroupDtoPaymentReport
|
|
23993
|
+
*/
|
|
23994
|
+
export interface SalesReportGroupDtoPaymentReport {
|
|
23995
|
+
/**
|
|
23996
|
+
* Part payments: one row per payment method
|
|
23997
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
23998
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
23999
|
+
*/
|
|
24000
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
24001
|
+
/**
|
|
24002
|
+
*
|
|
24003
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
24004
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24005
|
+
*/
|
|
24006
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
24007
|
+
/**
|
|
24008
|
+
* Part discounts: one row per discount
|
|
24009
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
24010
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24011
|
+
*/
|
|
24012
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
24013
|
+
/**
|
|
24014
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
24015
|
+
* @type {number}
|
|
24016
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24017
|
+
*/
|
|
24018
|
+
'totalDiscounts'?: number;
|
|
24019
|
+
}
|
|
24020
|
+
/**
|
|
24021
|
+
* 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
|
|
24022
|
+
* @export
|
|
24023
|
+
* @interface SalesReportGroupDtoSalesReport
|
|
24024
|
+
*/
|
|
24025
|
+
export interface SalesReportGroupDtoSalesReport {
|
|
24026
|
+
/**
|
|
24027
|
+
* Part items: the categories with their items
|
|
24028
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
24029
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24030
|
+
*/
|
|
24031
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
24032
|
+
/**
|
|
24033
|
+
* Part vat: one row per VAT rate, lowest first
|
|
24034
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
24035
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24036
|
+
*/
|
|
24037
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
24038
|
+
/**
|
|
24039
|
+
* Part summary: how many items were sold
|
|
24040
|
+
* @type {number}
|
|
24041
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24042
|
+
*/
|
|
24043
|
+
'totalQuantity'?: number;
|
|
24044
|
+
/**
|
|
24045
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24046
|
+
* @type {number}
|
|
24047
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24048
|
+
*/
|
|
24049
|
+
'totalWithTax'?: number;
|
|
24050
|
+
/**
|
|
24051
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24052
|
+
* @type {number}
|
|
24053
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24054
|
+
*/
|
|
24055
|
+
'totalTaxAmount'?: number;
|
|
24056
|
+
/**
|
|
24057
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24058
|
+
* @type {number}
|
|
24059
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24060
|
+
*/
|
|
24061
|
+
'totalWithoutTax'?: number;
|
|
24062
|
+
/**
|
|
24063
|
+
* 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
|
|
24064
|
+
* @type {number}
|
|
24065
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24066
|
+
*/
|
|
24067
|
+
'deliveryFee'?: number;
|
|
24068
|
+
/**
|
|
24069
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
24070
|
+
* @type {number}
|
|
24071
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24072
|
+
*/
|
|
24073
|
+
'deliveryTax'?: number;
|
|
24074
|
+
}
|
|
24075
|
+
/**
|
|
24076
|
+
*
|
|
24077
|
+
* @export
|
|
24078
|
+
* @interface SalesReportItemDto
|
|
24079
|
+
*/
|
|
24080
|
+
export interface SalesReportItemDto {
|
|
24081
|
+
/**
|
|
24082
|
+
* The item\'s name. POS: its first sale\'s name and VAT rate, as the portal shows it
|
|
24083
|
+
* @type {object}
|
|
24084
|
+
* @memberof SalesReportItemDto
|
|
24085
|
+
*/
|
|
24086
|
+
'name': object | null;
|
|
24087
|
+
/**
|
|
24088
|
+
* The product\'s id; null when the sale carried none
|
|
24089
|
+
* @type {object}
|
|
24090
|
+
* @memberof SalesReportItemDto
|
|
24091
|
+
*/
|
|
24092
|
+
'productId': object | null;
|
|
24093
|
+
/**
|
|
24094
|
+
* How many were sold
|
|
24095
|
+
* @type {number}
|
|
24096
|
+
* @memberof SalesReportItemDto
|
|
24097
|
+
*/
|
|
24098
|
+
'quantity': number;
|
|
24099
|
+
/**
|
|
24100
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24101
|
+
* @type {number}
|
|
24102
|
+
* @memberof SalesReportItemDto
|
|
24103
|
+
*/
|
|
24104
|
+
'totalWithTax': number;
|
|
24105
|
+
/**
|
|
24106
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24107
|
+
* @type {number}
|
|
24108
|
+
* @memberof SalesReportItemDto
|
|
24109
|
+
*/
|
|
24110
|
+
'taxAmount': number;
|
|
24111
|
+
/**
|
|
24112
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24113
|
+
* @type {number}
|
|
24114
|
+
* @memberof SalesReportItemDto
|
|
24115
|
+
*/
|
|
24116
|
+
'totalWithoutTax': number;
|
|
24117
|
+
/**
|
|
24118
|
+
* The VAT rate in percent; null when none was recorded
|
|
24119
|
+
* @type {object}
|
|
24120
|
+
* @memberof SalesReportItemDto
|
|
24121
|
+
*/
|
|
24122
|
+
'taxRate': object | null;
|
|
24123
|
+
/**
|
|
24124
|
+
* The options sold with the item; left out when none was
|
|
24125
|
+
* @type {Array<SalesReportOptionDto>}
|
|
24126
|
+
* @memberof SalesReportItemDto
|
|
24127
|
+
*/
|
|
24128
|
+
'subOptions'?: Array<SalesReportOptionDto>;
|
|
24129
|
+
}
|
|
24130
|
+
/**
|
|
24131
|
+
*
|
|
24132
|
+
* @export
|
|
24133
|
+
* @interface SalesReportOptionDto
|
|
24134
|
+
*/
|
|
24135
|
+
export interface SalesReportOptionDto {
|
|
24136
|
+
/**
|
|
24137
|
+
* The option\'s name
|
|
24138
|
+
* @type {string}
|
|
24139
|
+
* @memberof SalesReportOptionDto
|
|
24140
|
+
*/
|
|
24141
|
+
'name': string;
|
|
24142
|
+
/**
|
|
24143
|
+
* How many were sold
|
|
24144
|
+
* @type {number}
|
|
24145
|
+
* @memberof SalesReportOptionDto
|
|
24146
|
+
*/
|
|
24147
|
+
'quantity': number;
|
|
24148
|
+
/**
|
|
24149
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24150
|
+
* @type {number}
|
|
24151
|
+
* @memberof SalesReportOptionDto
|
|
24152
|
+
*/
|
|
24153
|
+
'totalWithTax': number;
|
|
24154
|
+
/**
|
|
24155
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24156
|
+
* @type {number}
|
|
24157
|
+
* @memberof SalesReportOptionDto
|
|
24158
|
+
*/
|
|
24159
|
+
'taxAmount': number;
|
|
24160
|
+
/**
|
|
24161
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24162
|
+
* @type {number}
|
|
24163
|
+
* @memberof SalesReportOptionDto
|
|
24164
|
+
*/
|
|
24165
|
+
'totalWithoutTax': number;
|
|
24166
|
+
/**
|
|
24167
|
+
* The VAT rate in percent; null when none was recorded
|
|
24168
|
+
* @type {object}
|
|
24169
|
+
* @memberof SalesReportOptionDto
|
|
24170
|
+
*/
|
|
24171
|
+
'taxRate': object | null;
|
|
24172
|
+
}
|
|
24173
|
+
/**
|
|
24174
|
+
*
|
|
24175
|
+
* @export
|
|
24176
|
+
* @interface SalesReportPaymentMethodDto
|
|
24177
|
+
*/
|
|
24178
|
+
export interface SalesReportPaymentMethodDto {
|
|
24179
|
+
/**
|
|
24180
|
+
* The payment method, as the app records it
|
|
24181
|
+
* @type {string}
|
|
24182
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24183
|
+
*/
|
|
24184
|
+
'paymentMethod': string;
|
|
24185
|
+
/**
|
|
24186
|
+
* How many payments were made with it
|
|
24187
|
+
* @type {number}
|
|
24188
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24189
|
+
*/
|
|
24190
|
+
'count': number;
|
|
24191
|
+
/**
|
|
24192
|
+
* What was paid with it, in the major unit of the group\'s currency (euros for EUR)
|
|
24193
|
+
* @type {number}
|
|
24194
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24195
|
+
*/
|
|
24196
|
+
'amount': number;
|
|
24197
|
+
}
|
|
24198
|
+
/**
|
|
24199
|
+
*
|
|
24200
|
+
* @export
|
|
24201
|
+
* @interface SalesReportPaymentSummaryDto
|
|
24202
|
+
*/
|
|
24203
|
+
export interface SalesReportPaymentSummaryDto {
|
|
24204
|
+
/**
|
|
24205
|
+
* Tips, in the major unit of the group\'s currency (euros for EUR)
|
|
24206
|
+
* @type {number}
|
|
24207
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24208
|
+
*/
|
|
24209
|
+
'totalTipAmount': number;
|
|
24210
|
+
/**
|
|
24211
|
+
* Surcharges, in the major unit of the group\'s currency (euros for EUR)
|
|
24212
|
+
* @type {number}
|
|
24213
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24214
|
+
*/
|
|
24215
|
+
'totalSurchargeAmount': number;
|
|
24216
|
+
/**
|
|
24217
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
24218
|
+
* @type {number}
|
|
24219
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24220
|
+
*/
|
|
24221
|
+
'salesAndRevenue': number;
|
|
24222
|
+
/**
|
|
24223
|
+
* How many card payments were made
|
|
24224
|
+
* @type {number}
|
|
24225
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24226
|
+
*/
|
|
24227
|
+
'cardsCount': number;
|
|
24228
|
+
/**
|
|
24229
|
+
* What was paid by card, in the major unit of the group\'s currency (euros for EUR)
|
|
24230
|
+
* @type {number}
|
|
24231
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24232
|
+
*/
|
|
24233
|
+
'cardsAmount': number;
|
|
24234
|
+
/**
|
|
24235
|
+
* How many Edenred vouchers were paid with
|
|
24236
|
+
* @type {number}
|
|
24237
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24238
|
+
*/
|
|
24239
|
+
'edenredVoucherCount': number;
|
|
24240
|
+
/**
|
|
24241
|
+
* What was paid with Edenred vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
24242
|
+
* @type {number}
|
|
24243
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24244
|
+
*/
|
|
24245
|
+
'edenredVoucherAmount': number;
|
|
24246
|
+
/**
|
|
24247
|
+
* How many Smartum vouchers were paid with
|
|
24248
|
+
* @type {number}
|
|
24249
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24250
|
+
*/
|
|
24251
|
+
'smartumVoucherCount': number;
|
|
24252
|
+
/**
|
|
24253
|
+
* What was paid with Smartum vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
24254
|
+
* @type {number}
|
|
24255
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24256
|
+
*/
|
|
24257
|
+
'smartumVoucherAmount': number;
|
|
24258
|
+
/**
|
|
24259
|
+
* How many payments were made
|
|
24260
|
+
* @type {number}
|
|
24261
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24262
|
+
*/
|
|
24263
|
+
'totalCount': number;
|
|
24264
|
+
/**
|
|
24265
|
+
* The same as salesAndRevenue, in the major unit of the group\'s currency (euros for EUR)
|
|
24266
|
+
* @type {number}
|
|
24267
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24268
|
+
*/
|
|
24269
|
+
'totalAmount': number;
|
|
24270
|
+
/**
|
|
24271
|
+
* Always 0: no app records coupons here
|
|
24272
|
+
* @type {number}
|
|
24273
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24274
|
+
*/
|
|
24275
|
+
'totalCoupons': number;
|
|
24276
|
+
/**
|
|
24277
|
+
* Vouchers\' leftover that was not given back, in the major unit of the group\'s currency (euros for EUR)
|
|
24278
|
+
* @type {number}
|
|
24279
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24280
|
+
*/
|
|
24281
|
+
'totalVoucherForfeited': number;
|
|
24282
|
+
/**
|
|
24283
|
+
* POS only: what was paid before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
24284
|
+
* @type {number}
|
|
24285
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24286
|
+
*/
|
|
24287
|
+
'grossAmount'?: number;
|
|
24288
|
+
/**
|
|
24289
|
+
* Refunds, in the major unit of the group\'s currency (euros for EUR), on the day of the order they refund
|
|
24290
|
+
* @type {number}
|
|
24291
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24292
|
+
*/
|
|
24293
|
+
'totalRefunds': number;
|
|
24294
|
+
/**
|
|
24295
|
+
* How many refunds were made
|
|
24296
|
+
* @type {number}
|
|
24297
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24298
|
+
*/
|
|
24299
|
+
'refundCount': number;
|
|
24300
|
+
}
|
|
24301
|
+
/**
|
|
24302
|
+
*
|
|
24303
|
+
* @export
|
|
24304
|
+
* @interface SalesReportPaymentsDto
|
|
24305
|
+
*/
|
|
24306
|
+
export interface SalesReportPaymentsDto {
|
|
24307
|
+
/**
|
|
24308
|
+
* Part payments: one row per payment method
|
|
24309
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
24310
|
+
* @memberof SalesReportPaymentsDto
|
|
24311
|
+
*/
|
|
24312
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
24313
|
+
/**
|
|
24314
|
+
*
|
|
24315
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
24316
|
+
* @memberof SalesReportPaymentsDto
|
|
24317
|
+
*/
|
|
24318
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
24319
|
+
/**
|
|
24320
|
+
* Part discounts: one row per discount
|
|
24321
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
24322
|
+
* @memberof SalesReportPaymentsDto
|
|
24323
|
+
*/
|
|
24324
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
24325
|
+
/**
|
|
24326
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
24327
|
+
* @type {number}
|
|
24328
|
+
* @memberof SalesReportPaymentsDto
|
|
24329
|
+
*/
|
|
24330
|
+
'totalDiscounts'?: number;
|
|
24331
|
+
}
|
|
24332
|
+
/**
|
|
24333
|
+
* Part summary: the payment totals
|
|
24334
|
+
* @export
|
|
24335
|
+
* @interface SalesReportPaymentsDtoSummary
|
|
24336
|
+
*/
|
|
24337
|
+
export interface SalesReportPaymentsDtoSummary {
|
|
24338
|
+
/**
|
|
24339
|
+
* Tips, in the major unit of the group\'s currency (euros for EUR)
|
|
24340
|
+
* @type {number}
|
|
24341
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24342
|
+
*/
|
|
24343
|
+
'totalTipAmount': number;
|
|
24344
|
+
/**
|
|
24345
|
+
* Surcharges, in the major unit of the group\'s currency (euros for EUR)
|
|
24346
|
+
* @type {number}
|
|
24347
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24348
|
+
*/
|
|
24349
|
+
'totalSurchargeAmount': number;
|
|
24350
|
+
/**
|
|
24351
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
24352
|
+
* @type {number}
|
|
24353
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24354
|
+
*/
|
|
24355
|
+
'salesAndRevenue': number;
|
|
24356
|
+
/**
|
|
24357
|
+
* How many card payments were made
|
|
24358
|
+
* @type {number}
|
|
24359
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24360
|
+
*/
|
|
24361
|
+
'cardsCount': number;
|
|
24362
|
+
/**
|
|
24363
|
+
* What was paid by card, in the major unit of the group\'s currency (euros for EUR)
|
|
24364
|
+
* @type {number}
|
|
24365
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24366
|
+
*/
|
|
24367
|
+
'cardsAmount': number;
|
|
24368
|
+
/**
|
|
24369
|
+
* How many Edenred vouchers were paid with
|
|
24370
|
+
* @type {number}
|
|
24371
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24372
|
+
*/
|
|
24373
|
+
'edenredVoucherCount': number;
|
|
24374
|
+
/**
|
|
24375
|
+
* What was paid with Edenred vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
24376
|
+
* @type {number}
|
|
24377
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24378
|
+
*/
|
|
24379
|
+
'edenredVoucherAmount': number;
|
|
24380
|
+
/**
|
|
24381
|
+
* How many Smartum vouchers were paid with
|
|
24382
|
+
* @type {number}
|
|
24383
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24384
|
+
*/
|
|
24385
|
+
'smartumVoucherCount': number;
|
|
24386
|
+
/**
|
|
24387
|
+
* What was paid with Smartum vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
24388
|
+
* @type {number}
|
|
24389
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24390
|
+
*/
|
|
24391
|
+
'smartumVoucherAmount': number;
|
|
24392
|
+
/**
|
|
24393
|
+
* How many payments were made
|
|
24394
|
+
* @type {number}
|
|
24395
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24396
|
+
*/
|
|
24397
|
+
'totalCount': number;
|
|
24398
|
+
/**
|
|
24399
|
+
* The same as salesAndRevenue, in the major unit of the group\'s currency (euros for EUR)
|
|
24400
|
+
* @type {number}
|
|
24401
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24402
|
+
*/
|
|
24403
|
+
'totalAmount': number;
|
|
24404
|
+
/**
|
|
24405
|
+
* Always 0: no app records coupons here
|
|
24406
|
+
* @type {number}
|
|
24407
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24408
|
+
*/
|
|
24409
|
+
'totalCoupons': number;
|
|
24410
|
+
/**
|
|
24411
|
+
* Vouchers\' leftover that was not given back, in the major unit of the group\'s currency (euros for EUR)
|
|
24412
|
+
* @type {number}
|
|
24413
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24414
|
+
*/
|
|
24415
|
+
'totalVoucherForfeited': number;
|
|
24416
|
+
/**
|
|
24417
|
+
* POS only: what was paid before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
24418
|
+
* @type {number}
|
|
24419
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24420
|
+
*/
|
|
24421
|
+
'grossAmount'?: number;
|
|
24422
|
+
/**
|
|
24423
|
+
* Refunds, in the major unit of the group\'s currency (euros for EUR), on the day of the order they refund
|
|
24424
|
+
* @type {number}
|
|
24425
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24426
|
+
*/
|
|
24427
|
+
'totalRefunds': number;
|
|
24428
|
+
/**
|
|
24429
|
+
* How many refunds were made
|
|
24430
|
+
* @type {number}
|
|
24431
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
24432
|
+
*/
|
|
24433
|
+
'refundCount': number;
|
|
24434
|
+
}
|
|
24435
|
+
/**
|
|
24436
|
+
*
|
|
24437
|
+
* @export
|
|
24438
|
+
* @interface SalesReportResponseDto
|
|
24439
|
+
*/
|
|
24440
|
+
export interface SalesReportResponseDto {
|
|
24441
|
+
/**
|
|
24442
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
24443
|
+
* @type {string}
|
|
24444
|
+
* @memberof SalesReportResponseDto
|
|
24445
|
+
*/
|
|
24446
|
+
'reportDateStart': string;
|
|
24447
|
+
/**
|
|
24448
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
24449
|
+
* @type {string}
|
|
24450
|
+
* @memberof SalesReportResponseDto
|
|
24451
|
+
*/
|
|
24452
|
+
'reportDateEnd': string;
|
|
24453
|
+
/**
|
|
24454
|
+
* When the report was answered, ISO 8601 in UTC
|
|
24455
|
+
* @type {string}
|
|
24456
|
+
* @memberof SalesReportResponseDto
|
|
24457
|
+
*/
|
|
24458
|
+
'reportGeneratedAt': string;
|
|
24459
|
+
/**
|
|
24460
|
+
* The time zone the period was read in: the request\'s, or else the first venue\'s
|
|
24461
|
+
* @type {string}
|
|
24462
|
+
* @memberof SalesReportResponseDto
|
|
24463
|
+
*/
|
|
24464
|
+
'timezone': string;
|
|
24465
|
+
/**
|
|
24466
|
+
* The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
|
|
24467
|
+
* @type {string}
|
|
24468
|
+
* @memberof SalesReportResponseDto
|
|
24469
|
+
*/
|
|
24470
|
+
'firstBusinessDay': string;
|
|
24471
|
+
/**
|
|
24472
|
+
* The last business day added up, YYYY-MM-DD, inclusive
|
|
24473
|
+
* @type {string}
|
|
24474
|
+
* @memberof SalesReportResponseDto
|
|
24475
|
+
*/
|
|
24476
|
+
'lastBusinessDay': string;
|
|
24477
|
+
/**
|
|
24478
|
+
* 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
|
|
24479
|
+
* @type {object}
|
|
24480
|
+
* @memberof SalesReportResponseDto
|
|
24481
|
+
*/
|
|
24482
|
+
'dataUntil': object | null;
|
|
24483
|
+
/**
|
|
24484
|
+
* One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
|
|
24485
|
+
* @type {Array<SalesReportGroupDto>}
|
|
24486
|
+
* @memberof SalesReportResponseDto
|
|
24487
|
+
*/
|
|
24488
|
+
'reports': Array<SalesReportGroupDto>;
|
|
24489
|
+
}
|
|
24490
|
+
/**
|
|
24491
|
+
*
|
|
24492
|
+
* @export
|
|
24493
|
+
* @interface SalesReportSalesDto
|
|
24494
|
+
*/
|
|
24495
|
+
export interface SalesReportSalesDto {
|
|
24496
|
+
/**
|
|
24497
|
+
* Part items: the categories with their items
|
|
24498
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
24499
|
+
* @memberof SalesReportSalesDto
|
|
24500
|
+
*/
|
|
24501
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
24502
|
+
/**
|
|
24503
|
+
* Part vat: one row per VAT rate, lowest first
|
|
24504
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
24505
|
+
* @memberof SalesReportSalesDto
|
|
24506
|
+
*/
|
|
24507
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
24508
|
+
/**
|
|
24509
|
+
* Part summary: how many items were sold
|
|
24510
|
+
* @type {number}
|
|
24511
|
+
* @memberof SalesReportSalesDto
|
|
24512
|
+
*/
|
|
24513
|
+
'totalQuantity'?: number;
|
|
24514
|
+
/**
|
|
24515
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24516
|
+
* @type {number}
|
|
24517
|
+
* @memberof SalesReportSalesDto
|
|
24518
|
+
*/
|
|
24519
|
+
'totalWithTax'?: number;
|
|
24520
|
+
/**
|
|
24521
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24522
|
+
* @type {number}
|
|
24523
|
+
* @memberof SalesReportSalesDto
|
|
24524
|
+
*/
|
|
24525
|
+
'totalTaxAmount'?: number;
|
|
24526
|
+
/**
|
|
24527
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24528
|
+
* @type {number}
|
|
24529
|
+
* @memberof SalesReportSalesDto
|
|
24530
|
+
*/
|
|
24531
|
+
'totalWithoutTax'?: number;
|
|
24532
|
+
/**
|
|
24533
|
+
* 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
|
|
24534
|
+
* @type {number}
|
|
24535
|
+
* @memberof SalesReportSalesDto
|
|
24536
|
+
*/
|
|
24537
|
+
'deliveryFee'?: number;
|
|
24538
|
+
/**
|
|
24539
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
24540
|
+
* @type {number}
|
|
24541
|
+
* @memberof SalesReportSalesDto
|
|
24542
|
+
*/
|
|
24543
|
+
'deliveryTax'?: number;
|
|
24544
|
+
}
|
|
24545
|
+
/**
|
|
24546
|
+
*
|
|
24547
|
+
* @export
|
|
24548
|
+
* @interface SalesReportVatRateDto
|
|
24549
|
+
*/
|
|
24550
|
+
export interface SalesReportVatRateDto {
|
|
24551
|
+
/**
|
|
24552
|
+
* The VAT rate in percent
|
|
24553
|
+
* @type {number}
|
|
24554
|
+
* @memberof SalesReportVatRateDto
|
|
24555
|
+
*/
|
|
24556
|
+
'taxRate': number;
|
|
24557
|
+
/**
|
|
24558
|
+
* Sales with VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
24559
|
+
* @type {number}
|
|
24560
|
+
* @memberof SalesReportVatRateDto
|
|
24561
|
+
*/
|
|
24562
|
+
'totalWithTax': number;
|
|
24563
|
+
/**
|
|
24564
|
+
* The VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
24565
|
+
* @type {number}
|
|
24566
|
+
* @memberof SalesReportVatRateDto
|
|
24567
|
+
*/
|
|
24568
|
+
'taxAmount': number;
|
|
24569
|
+
/**
|
|
24570
|
+
* Sales without VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
24571
|
+
* @type {number}
|
|
24572
|
+
* @memberof SalesReportVatRateDto
|
|
24573
|
+
*/
|
|
24574
|
+
'totalWithoutTax': number;
|
|
24575
|
+
}
|
|
23076
24576
|
/**
|
|
23077
24577
|
*
|
|
23078
24578
|
* @export
|
|
@@ -23313,11 +24813,11 @@ export interface SendCashReportDto {
|
|
|
23313
24813
|
*/
|
|
23314
24814
|
'recipient': string;
|
|
23315
24815
|
/**
|
|
23316
|
-
* The IANA timezone the report\'s times are printed in
|
|
24816
|
+
* The IANA timezone the report\'s times are printed in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
23317
24817
|
* @type {string}
|
|
23318
24818
|
* @memberof SendCashReportDto
|
|
23319
24819
|
*/
|
|
23320
|
-
'timezone'
|
|
24820
|
+
'timezone'?: string;
|
|
23321
24821
|
}
|
|
23322
24822
|
/**
|
|
23323
24823
|
*
|
|
@@ -27682,13 +29182,13 @@ export interface UnifiedProductDto {
|
|
|
27682
29182
|
*/
|
|
27683
29183
|
'quantity': number;
|
|
27684
29184
|
/**
|
|
27685
|
-
* Unit price of the product, in
|
|
29185
|
+
* Unit price of the product, in the order\'s currency (not minor units): as the channel sent it on a platform order, the base price without options on a till order
|
|
27686
29186
|
* @type {number}
|
|
27687
29187
|
* @memberof UnifiedProductDto
|
|
27688
29188
|
*/
|
|
27689
29189
|
'unitPrice': number;
|
|
27690
29190
|
/**
|
|
27691
|
-
* Actual paid price of the product, in
|
|
29191
|
+
* Actual paid price of the product, in the order\'s currency (not minor units): as the channel reported it on a platform order (for most channels the whole line), the unit price with options before discounts on a till order
|
|
27692
29192
|
* @type {number}
|
|
27693
29193
|
* @memberof UnifiedProductDto
|
|
27694
29194
|
*/
|
|
@@ -27853,13 +29353,13 @@ export interface UnifiedSubOptionDto {
|
|
|
27853
29353
|
*/
|
|
27854
29354
|
'name': string;
|
|
27855
29355
|
/**
|
|
27856
|
-
* Unit price of the sub-option, in
|
|
29356
|
+
* Unit price of the sub-option, in the order\'s currency (not minor units)
|
|
27857
29357
|
* @type {number}
|
|
27858
29358
|
* @memberof UnifiedSubOptionDto
|
|
27859
29359
|
*/
|
|
27860
29360
|
'unitPrice': number;
|
|
27861
29361
|
/**
|
|
27862
|
-
* Actual paid price of the sub-option, in
|
|
29362
|
+
* Actual paid price of the sub-option, in the order\'s currency (not minor units): as the channel reported it on a platform order, the unit price on a till order
|
|
27863
29363
|
* @type {number}
|
|
27864
29364
|
* @memberof UnifiedSubOptionDto
|
|
27865
29365
|
*/
|
|
@@ -28366,6 +29866,32 @@ export interface UpdateReservationPolicyDto {
|
|
|
28366
29866
|
* @memberof UpdateReservationPolicyDto
|
|
28367
29867
|
*/
|
|
28368
29868
|
'maxOnlinePartySize'?: number;
|
|
29869
|
+
/**
|
|
29870
|
+
* The smallest party offered slots online; 1 on create when absent
|
|
29871
|
+
* @type {number}
|
|
29872
|
+
* @memberof UpdateReservationPolicyDto
|
|
29873
|
+
*/
|
|
29874
|
+
'minPartySize'?: number;
|
|
29875
|
+
/**
|
|
29876
|
+
* How many days after today a guest may book: a later day offers no slots; 60 on create when absent
|
|
29877
|
+
* @type {number}
|
|
29878
|
+
* @memberof UpdateReservationPolicyDto
|
|
29879
|
+
*/
|
|
29880
|
+
'maxHorizonDays'?: number;
|
|
29881
|
+
/**
|
|
29882
|
+
* 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
|
|
29883
|
+
* @type {number}
|
|
29884
|
+
* @memberof UpdateReservationPolicyDto
|
|
29885
|
+
*/
|
|
29886
|
+
'cutoffMins'?: number;
|
|
29887
|
+
/**
|
|
29888
|
+
* 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
|
|
29889
|
+
* @type {{ [key: string]: number; }}
|
|
29890
|
+
* @memberof UpdateReservationPolicyDto
|
|
29891
|
+
*/
|
|
29892
|
+
'turnTimeByPartySize'?: {
|
|
29893
|
+
[key: string]: number;
|
|
29894
|
+
};
|
|
28369
29895
|
}
|
|
28370
29896
|
/**
|
|
28371
29897
|
*
|
|
@@ -29294,13 +30820,13 @@ export interface ValidateGiftCardResponseDtoCardInfo {
|
|
|
29294
30820
|
*/
|
|
29295
30821
|
'title': string;
|
|
29296
30822
|
/**
|
|
29297
|
-
* What is left on the card, in euros
|
|
30823
|
+
* What is left on the card, in units of its currency (euros for EUR, not cents)
|
|
29298
30824
|
* @type {number}
|
|
29299
30825
|
* @memberof ValidateGiftCardResponseDtoCardInfo
|
|
29300
30826
|
*/
|
|
29301
30827
|
'balance': number;
|
|
29302
30828
|
/**
|
|
29303
|
-
* The card\'s currency code;
|
|
30829
|
+
* The card\'s currency code; the venue\'s currency when Luckiefun sends none
|
|
29304
30830
|
* @type {string}
|
|
29305
30831
|
* @memberof ValidateGiftCardResponseDtoCardInfo
|
|
29306
30832
|
*/
|
|
@@ -29409,6 +30935,18 @@ export interface VendureSellerUpsertDto {
|
|
|
29409
30935
|
* @memberof VendureSellerUpsertDto
|
|
29410
30936
|
*/
|
|
29411
30937
|
'timezone'?: string | null;
|
|
30938
|
+
/**
|
|
30939
|
+
* The venue\'s country, ISO 3166-1 alpha-2 in any case, from the seller\'s address. Saved on the venue\'s BusinessConfig (created when the venue has none) with the country\'s locale, its main language and the country (FI is fi-FI). Any country is accepted. Null, absent, or a code that names no country keeps the stored one; a code that names none is logged
|
|
30940
|
+
* @type {string}
|
|
30941
|
+
* @memberof VendureSellerUpsertDto
|
|
30942
|
+
*/
|
|
30943
|
+
'country_code'?: string | null;
|
|
30944
|
+
/**
|
|
30945
|
+
* The currency the venue sells in, ISO 4217 in any case: the default currency of the seller\'s channels. Saved as the venue\'s currency, which the config answers, payments and reports read. A retired code is saved as its successor (ANG as XCG, SLL as SLE, ZWL as ZWG). Null, absent, or a code no currency has (CUC) keeps the stored one; an unknown code is logged
|
|
30946
|
+
* @type {string}
|
|
30947
|
+
* @memberof VendureSellerUpsertDto
|
|
30948
|
+
*/
|
|
30949
|
+
'currency'?: string | null;
|
|
29412
30950
|
/**
|
|
29413
30951
|
* Whether the venue is in use. Vendure sends false when the seller is deleted
|
|
29414
30952
|
* @type {boolean}
|
|
@@ -32816,12 +34354,13 @@ export declare const BusinessApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
32816
34354
|
*/
|
|
32817
34355
|
getBusinessProviderStatus: (businessId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32818
34356
|
/**
|
|
32819
|
-
* Read from Vendure
|
|
34357
|
+
* Read from Vendure. The venue named by businessId, or else the one venue a ticket covers, is answered the rates of its own tax zone, kept per venue and cleared by its seller sync; a venue with no tax of its own zone yet, and any other caller, every zone\'s enabled taxes, as before, so a till never gets an empty list. Kept 15 minutes, since Vendure announces no tax change yet; a failed read is not kept.
|
|
32820
34358
|
* @summary List the enabled tax rates
|
|
34359
|
+
* @param {number} [businessId] The venue whose taxes are asked, its venue id: the rates of its own tax zone in Vendure. It must be on the signed-in ticket. Absent, a ticket of one venue is answered that venue\'s taxes, and any other caller every zone\'s enabled taxes, as before
|
|
32821
34360
|
* @param {*} [options] Override http request option.
|
|
32822
34361
|
* @throws {RequiredError}
|
|
32823
34362
|
*/
|
|
32824
|
-
getBusinessTax: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34363
|
+
getBusinessTax: (businessId?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32825
34364
|
/**
|
|
32826
34365
|
* Kept 30 days per venue and invalidated when a venue\'s providers change. One cache read for all the venues, and one database read for the venues not kept. Each venue asked for is answered once, in the order asked; a venue with no active provider is answered with an empty list, which is kept too.
|
|
32827
34366
|
* @summary List the active providers of several venues with the integrations each supports
|
|
@@ -32962,12 +34501,13 @@ export declare const BusinessApiFp: (configuration?: Configuration) => {
|
|
|
32962
34501
|
*/
|
|
32963
34502
|
getBusinessProviderStatus(businessId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ProviderStatusResponseDto>>>;
|
|
32964
34503
|
/**
|
|
32965
|
-
* Read from Vendure
|
|
34504
|
+
* Read from Vendure. The venue named by businessId, or else the one venue a ticket covers, is answered the rates of its own tax zone, kept per venue and cleared by its seller sync; a venue with no tax of its own zone yet, and any other caller, every zone\'s enabled taxes, as before, so a till never gets an empty list. Kept 15 minutes, since Vendure announces no tax change yet; a failed read is not kept.
|
|
32966
34505
|
* @summary List the enabled tax rates
|
|
34506
|
+
* @param {number} [businessId] The venue whose taxes are asked, its venue id: the rates of its own tax zone in Vendure. It must be on the signed-in ticket. Absent, a ticket of one venue is answered that venue\'s taxes, and any other caller every zone\'s enabled taxes, as before
|
|
32967
34507
|
* @param {*} [options] Override http request option.
|
|
32968
34508
|
* @throws {RequiredError}
|
|
32969
34509
|
*/
|
|
32970
|
-
getBusinessTax(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BusinessTaxResponseDto>>>;
|
|
34510
|
+
getBusinessTax(businessId?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BusinessTaxResponseDto>>>;
|
|
32971
34511
|
/**
|
|
32972
34512
|
* Kept 30 days per venue and invalidated when a venue\'s providers change. One cache read for all the venues, and one database read for the venues not kept. Each venue asked for is answered once, in the order asked; a venue with no active provider is answered with an empty list, which is kept too.
|
|
32973
34513
|
* @summary List the active providers of several venues with the integrations each supports
|
|
@@ -33108,12 +34648,13 @@ export declare const BusinessApiFactory: (configuration?: Configuration, basePat
|
|
|
33108
34648
|
*/
|
|
33109
34649
|
getBusinessProviderStatus(businessId: string, options?: any): AxiosPromise<Array<ProviderStatusResponseDto>>;
|
|
33110
34650
|
/**
|
|
33111
|
-
* Read from Vendure
|
|
34651
|
+
* Read from Vendure. The venue named by businessId, or else the one venue a ticket covers, is answered the rates of its own tax zone, kept per venue and cleared by its seller sync; a venue with no tax of its own zone yet, and any other caller, every zone\'s enabled taxes, as before, so a till never gets an empty list. Kept 15 minutes, since Vendure announces no tax change yet; a failed read is not kept.
|
|
33112
34652
|
* @summary List the enabled tax rates
|
|
34653
|
+
* @param {number} [businessId] The venue whose taxes are asked, its venue id: the rates of its own tax zone in Vendure. It must be on the signed-in ticket. Absent, a ticket of one venue is answered that venue\'s taxes, and any other caller every zone\'s enabled taxes, as before
|
|
33113
34654
|
* @param {*} [options] Override http request option.
|
|
33114
34655
|
* @throws {RequiredError}
|
|
33115
34656
|
*/
|
|
33116
|
-
getBusinessTax(options?: any): AxiosPromise<Array<BusinessTaxResponseDto>>;
|
|
34657
|
+
getBusinessTax(businessId?: number, options?: any): AxiosPromise<Array<BusinessTaxResponseDto>>;
|
|
33117
34658
|
/**
|
|
33118
34659
|
* Kept 30 days per venue and invalidated when a venue\'s providers change. One cache read for all the venues, and one database read for the venues not kept. Each venue asked for is answered once, in the order asked; a venue with no active provider is answered with an empty list, which is kept too.
|
|
33119
34660
|
* @summary List the active providers of several venues with the integrations each supports
|
|
@@ -33266,13 +34807,14 @@ export interface BusinessApiInterface {
|
|
|
33266
34807
|
*/
|
|
33267
34808
|
getBusinessProviderStatus(businessId: string, options?: AxiosRequestConfig): AxiosPromise<Array<ProviderStatusResponseDto>>;
|
|
33268
34809
|
/**
|
|
33269
|
-
* Read from Vendure
|
|
34810
|
+
* Read from Vendure. The venue named by businessId, or else the one venue a ticket covers, is answered the rates of its own tax zone, kept per venue and cleared by its seller sync; a venue with no tax of its own zone yet, and any other caller, every zone\'s enabled taxes, as before, so a till never gets an empty list. Kept 15 minutes, since Vendure announces no tax change yet; a failed read is not kept.
|
|
33270
34811
|
* @summary List the enabled tax rates
|
|
34812
|
+
* @param {number} [businessId] The venue whose taxes are asked, its venue id: the rates of its own tax zone in Vendure. It must be on the signed-in ticket. Absent, a ticket of one venue is answered that venue\'s taxes, and any other caller every zone\'s enabled taxes, as before
|
|
33271
34813
|
* @param {*} [options] Override http request option.
|
|
33272
34814
|
* @throws {RequiredError}
|
|
33273
34815
|
* @memberof BusinessApiInterface
|
|
33274
34816
|
*/
|
|
33275
|
-
getBusinessTax(options?: AxiosRequestConfig): AxiosPromise<Array<BusinessTaxResponseDto>>;
|
|
34817
|
+
getBusinessTax(businessId?: number, options?: AxiosRequestConfig): AxiosPromise<Array<BusinessTaxResponseDto>>;
|
|
33276
34818
|
/**
|
|
33277
34819
|
* Kept 30 days per venue and invalidated when a venue\'s providers change. One cache read for all the venues, and one database read for the venues not kept. Each venue asked for is answered once, in the order asked; a venue with no active provider is answered with an empty list, which is kept too.
|
|
33278
34820
|
* @summary List the active providers of several venues with the integrations each supports
|
|
@@ -33430,13 +34972,14 @@ export declare class BusinessApi extends BaseAPI implements BusinessApiInterface
|
|
|
33430
34972
|
*/
|
|
33431
34973
|
getBusinessProviderStatus(businessId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProviderStatusResponseDto[], any, {}>>;
|
|
33432
34974
|
/**
|
|
33433
|
-
* Read from Vendure
|
|
34975
|
+
* Read from Vendure. The venue named by businessId, or else the one venue a ticket covers, is answered the rates of its own tax zone, kept per venue and cleared by its seller sync; a venue with no tax of its own zone yet, and any other caller, every zone\'s enabled taxes, as before, so a till never gets an empty list. Kept 15 minutes, since Vendure announces no tax change yet; a failed read is not kept.
|
|
33434
34976
|
* @summary List the enabled tax rates
|
|
34977
|
+
* @param {number} [businessId] The venue whose taxes are asked, its venue id: the rates of its own tax zone in Vendure. It must be on the signed-in ticket. Absent, a ticket of one venue is answered that venue\'s taxes, and any other caller every zone\'s enabled taxes, as before
|
|
33435
34978
|
* @param {*} [options] Override http request option.
|
|
33436
34979
|
* @throws {RequiredError}
|
|
33437
34980
|
* @memberof BusinessApi
|
|
33438
34981
|
*/
|
|
33439
|
-
getBusinessTax(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BusinessTaxResponseDto[], any, {}>>;
|
|
34982
|
+
getBusinessTax(businessId?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BusinessTaxResponseDto[], any, {}>>;
|
|
33440
34983
|
/**
|
|
33441
34984
|
* Kept 30 days per venue and invalidated when a venue\'s providers change. One cache read for all the venues, and one database read for the venues not kept. Each venue asked for is answered once, in the order asked; a venue with no active provider is answered with an empty list, which is kept too.
|
|
33442
34985
|
* @summary List the active providers of several venues with the integrations each supports
|
|
@@ -33581,7 +35124,7 @@ export declare const CashManagementApiAxiosParamCreator: (configuration?: Config
|
|
|
33581
35124
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
33582
35125
|
* @param {number} [page] The page to read, from 1
|
|
33583
35126
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
33584
|
-
* @param {string} [timezone] IANA timezone the period is read in
|
|
35127
|
+
* @param {string} [timezone] IANA timezone the period is read in. Absent: the venue\'s own time zone (Business.timeZone)
|
|
33585
35128
|
* @param {*} [options] Override http request option.
|
|
33586
35129
|
* @throws {RequiredError}
|
|
33587
35130
|
*/
|
|
@@ -33647,7 +35190,7 @@ export declare const CashManagementApiFp: (configuration?: Configuration) => {
|
|
|
33647
35190
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
33648
35191
|
* @param {number} [page] The page to read, from 1
|
|
33649
35192
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
33650
|
-
* @param {string} [timezone] IANA timezone the period is read in
|
|
35193
|
+
* @param {string} [timezone] IANA timezone the period is read in. Absent: the venue\'s own time zone (Business.timeZone)
|
|
33651
35194
|
* @param {*} [options] Override http request option.
|
|
33652
35195
|
* @throws {RequiredError}
|
|
33653
35196
|
*/
|
|
@@ -33713,7 +35256,7 @@ export declare const CashManagementApiFactory: (configuration?: Configuration, b
|
|
|
33713
35256
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
33714
35257
|
* @param {number} [page] The page to read, from 1
|
|
33715
35258
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
33716
|
-
* @param {string} [timezone] IANA timezone the period is read in
|
|
35259
|
+
* @param {string} [timezone] IANA timezone the period is read in. Absent: the venue\'s own time zone (Business.timeZone)
|
|
33717
35260
|
* @param {*} [options] Override http request option.
|
|
33718
35261
|
* @throws {RequiredError}
|
|
33719
35262
|
*/
|
|
@@ -33781,7 +35324,7 @@ export interface CashManagementApiInterface {
|
|
|
33781
35324
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
33782
35325
|
* @param {number} [page] The page to read, from 1
|
|
33783
35326
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
33784
|
-
* @param {string} [timezone] IANA timezone the period is read in
|
|
35327
|
+
* @param {string} [timezone] IANA timezone the period is read in. Absent: the venue\'s own time zone (Business.timeZone)
|
|
33785
35328
|
* @param {*} [options] Override http request option.
|
|
33786
35329
|
* @throws {RequiredError}
|
|
33787
35330
|
* @memberof CashManagementApiInterface
|
|
@@ -33855,7 +35398,7 @@ export declare class CashManagementApi extends BaseAPI implements CashManagement
|
|
|
33855
35398
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
33856
35399
|
* @param {number} [page] The page to read, from 1
|
|
33857
35400
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
33858
|
-
* @param {string} [timezone] IANA timezone the period is read in
|
|
35401
|
+
* @param {string} [timezone] IANA timezone the period is read in. Absent: the venue\'s own time zone (Business.timeZone)
|
|
33859
35402
|
* @param {*} [options] Override http request option.
|
|
33860
35403
|
* @throws {RequiredError}
|
|
33861
35404
|
* @memberof CashManagementApi
|
|
@@ -33917,7 +35460,7 @@ export declare const CashManagementV6ApiAxiosParamCreator: (configuration?: Conf
|
|
|
33917
35460
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
33918
35461
|
* @param {number} [page] The page to read, from 1
|
|
33919
35462
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
33920
|
-
* @param {string} [timezone] Timezone of the period asked for
|
|
35463
|
+
* @param {string} [timezone] Timezone of the period asked for. Absent: the venue\'s own time zone (Business.timeZone)
|
|
33921
35464
|
* @param {*} [options] Override http request option.
|
|
33922
35465
|
* @throws {RequiredError}
|
|
33923
35466
|
*/
|
|
@@ -33937,7 +35480,7 @@ export declare const CashManagementV6ApiFp: (configuration?: Configuration) => {
|
|
|
33937
35480
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
33938
35481
|
* @param {number} [page] The page to read, from 1
|
|
33939
35482
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
33940
|
-
* @param {string} [timezone] Timezone of the period asked for
|
|
35483
|
+
* @param {string} [timezone] Timezone of the period asked for. Absent: the venue\'s own time zone (Business.timeZone)
|
|
33941
35484
|
* @param {*} [options] Override http request option.
|
|
33942
35485
|
* @throws {RequiredError}
|
|
33943
35486
|
*/
|
|
@@ -33957,7 +35500,7 @@ export declare const CashManagementV6ApiFactory: (configuration?: Configuration,
|
|
|
33957
35500
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
33958
35501
|
* @param {number} [page] The page to read, from 1
|
|
33959
35502
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
33960
|
-
* @param {string} [timezone] Timezone of the period asked for
|
|
35503
|
+
* @param {string} [timezone] Timezone of the period asked for. Absent: the venue\'s own time zone (Business.timeZone)
|
|
33961
35504
|
* @param {*} [options] Override http request option.
|
|
33962
35505
|
* @throws {RequiredError}
|
|
33963
35506
|
*/
|
|
@@ -33978,7 +35521,7 @@ export interface CashManagementV6ApiInterface {
|
|
|
33978
35521
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
33979
35522
|
* @param {number} [page] The page to read, from 1
|
|
33980
35523
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
33981
|
-
* @param {string} [timezone] Timezone of the period asked for
|
|
35524
|
+
* @param {string} [timezone] Timezone of the period asked for. Absent: the venue\'s own time zone (Business.timeZone)
|
|
33982
35525
|
* @param {*} [options] Override http request option.
|
|
33983
35526
|
* @throws {RequiredError}
|
|
33984
35527
|
* @memberof CashManagementV6ApiInterface
|
|
@@ -34001,7 +35544,7 @@ export declare class CashManagementV6Api extends BaseAPI implements CashManageme
|
|
|
34001
35544
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
34002
35545
|
* @param {number} [page] The page to read, from 1
|
|
34003
35546
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
34004
|
-
* @param {string} [timezone] Timezone of the period asked for
|
|
35547
|
+
* @param {string} [timezone] Timezone of the period asked for. Absent: the venue\'s own time zone (Business.timeZone)
|
|
34005
35548
|
* @param {*} [options] Override http request option.
|
|
34006
35549
|
* @throws {RequiredError}
|
|
34007
35550
|
* @memberof CashManagementV6Api
|
|
@@ -34327,7 +35870,7 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
34327
35870
|
*/
|
|
34328
35871
|
configSaveEpassiCredentials: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34329
35872
|
/**
|
|
34330
|
-
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license.
|
|
35873
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
34331
35874
|
* @summary Create or update a venue
|
|
34332
35875
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34333
35876
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -34336,7 +35879,7 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
34336
35879
|
*/
|
|
34337
35880
|
configUpsertBusiness: (businessId: number, upsertBusinessDto: UpsertBusinessDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34338
35881
|
/**
|
|
34339
|
-
* A new config is saved in Europe/Helsinki unless the body says otherwise.
|
|
35882
|
+
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
34340
35883
|
* @summary Create or update a channel\'s config
|
|
34341
35884
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34342
35885
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
@@ -34356,7 +35899,7 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
34356
35899
|
*/
|
|
34357
35900
|
configUpsertGiftCard: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34358
35901
|
/**
|
|
34359
|
-
* The secret is stored encrypted. A new program needs name, apiBaseUrl and secretKey. The venue\'s cached config and loyalty settings are cleared.
|
|
35902
|
+
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
34360
35903
|
* @summary Create or update a loyalty program and link it to a venue
|
|
34361
35904
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34362
35905
|
* @param {UpsertLoyaltyDto} upsertLoyaltyDto
|
|
@@ -34470,7 +36013,7 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
34470
36013
|
*/
|
|
34471
36014
|
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EpassiCredentialsSavedDto>>;
|
|
34472
36015
|
/**
|
|
34473
|
-
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license.
|
|
36016
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
34474
36017
|
* @summary Create or update a venue
|
|
34475
36018
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34476
36019
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -34479,7 +36022,7 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
34479
36022
|
*/
|
|
34480
36023
|
configUpsertBusiness(businessId: number, upsertBusinessDto: UpsertBusinessDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
34481
36024
|
/**
|
|
34482
|
-
* A new config is saved in Europe/Helsinki unless the body says otherwise.
|
|
36025
|
+
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
34483
36026
|
* @summary Create or update a channel\'s config
|
|
34484
36027
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34485
36028
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
@@ -34499,7 +36042,7 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
34499
36042
|
*/
|
|
34500
36043
|
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
34501
36044
|
/**
|
|
34502
|
-
* The secret is stored encrypted. A new program needs name, apiBaseUrl and secretKey. The venue\'s cached config and loyalty settings are cleared.
|
|
36045
|
+
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
34503
36046
|
* @summary Create or update a loyalty program and link it to a venue
|
|
34504
36047
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34505
36048
|
* @param {UpsertLoyaltyDto} upsertLoyaltyDto
|
|
@@ -34613,7 +36156,7 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
34613
36156
|
*/
|
|
34614
36157
|
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: any): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
34615
36158
|
/**
|
|
34616
|
-
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license.
|
|
36159
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
34617
36160
|
* @summary Create or update a venue
|
|
34618
36161
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34619
36162
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -34622,7 +36165,7 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
34622
36165
|
*/
|
|
34623
36166
|
configUpsertBusiness(businessId: number, upsertBusinessDto: UpsertBusinessDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
34624
36167
|
/**
|
|
34625
|
-
* A new config is saved in Europe/Helsinki unless the body says otherwise.
|
|
36168
|
+
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
34626
36169
|
* @summary Create or update a channel\'s config
|
|
34627
36170
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34628
36171
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
@@ -34642,7 +36185,7 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
34642
36185
|
*/
|
|
34643
36186
|
configUpsertGiftCard(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay", upsertGiftCardDto: UpsertGiftCardDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
34644
36187
|
/**
|
|
34645
|
-
* The secret is stored encrypted. A new program needs name, apiBaseUrl and secretKey. The venue\'s cached config and loyalty settings are cleared.
|
|
36188
|
+
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
34646
36189
|
* @summary Create or update a loyalty program and link it to a venue
|
|
34647
36190
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34648
36191
|
* @param {UpsertLoyaltyDto} upsertLoyaltyDto
|
|
@@ -34762,7 +36305,7 @@ export interface ConfigManagementApiInterface {
|
|
|
34762
36305
|
*/
|
|
34763
36306
|
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
34764
36307
|
/**
|
|
34765
|
-
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license.
|
|
36308
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
34766
36309
|
* @summary Create or update a venue
|
|
34767
36310
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34768
36311
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -34772,7 +36315,7 @@ export interface ConfigManagementApiInterface {
|
|
|
34772
36315
|
*/
|
|
34773
36316
|
configUpsertBusiness(businessId: number, upsertBusinessDto: UpsertBusinessDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
34774
36317
|
/**
|
|
34775
|
-
* A new config is saved in Europe/Helsinki unless the body says otherwise.
|
|
36318
|
+
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
34776
36319
|
* @summary Create or update a channel\'s config
|
|
34777
36320
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34778
36321
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
@@ -34794,7 +36337,7 @@ export interface ConfigManagementApiInterface {
|
|
|
34794
36337
|
*/
|
|
34795
36338
|
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
34796
36339
|
/**
|
|
34797
|
-
* The secret is stored encrypted. A new program needs name, apiBaseUrl and secretKey. The venue\'s cached config and loyalty settings are cleared.
|
|
36340
|
+
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
34798
36341
|
* @summary Create or update a loyalty program and link it to a venue
|
|
34799
36342
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34800
36343
|
* @param {UpsertLoyaltyDto} upsertLoyaltyDto
|
|
@@ -34921,7 +36464,7 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
34921
36464
|
*/
|
|
34922
36465
|
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EpassiCredentialsSavedDto, any, {}>>;
|
|
34923
36466
|
/**
|
|
34924
|
-
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license.
|
|
36467
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
34925
36468
|
* @summary Create or update a venue
|
|
34926
36469
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34927
36470
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -34931,7 +36474,7 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
34931
36474
|
*/
|
|
34932
36475
|
configUpsertBusiness(businessId: number, upsertBusinessDto: UpsertBusinessDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
34933
36476
|
/**
|
|
34934
|
-
* A new config is saved in Europe/Helsinki unless the body says otherwise.
|
|
36477
|
+
* A new config is saved in Europe/Helsinki unless the body says otherwise. The fields below are written as sent; any other field is dropped and its name logged. A venue with no merchant switched to Team or PIN lock gets its own merchant, named after it, in the same transaction. The venue\'s cached config and POS session are cleared.
|
|
34935
36478
|
* @summary Create or update a channel\'s config
|
|
34936
36479
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34937
36480
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
@@ -34953,7 +36496,7 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
34953
36496
|
*/
|
|
34954
36497
|
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
34955
36498
|
/**
|
|
34956
|
-
* The secret is stored encrypted. A new program needs name, apiBaseUrl and secretKey. The venue\'s cached config and loyalty settings are cleared.
|
|
36499
|
+
* The secret is stored encrypted and never answered: secretKey is null in the answer. A new program needs name, apiBaseUrl and secretKey; apiBaseUrl must be https on the Munchi loyalty server\'s host. A signed-in ticket may write only a programme that serves no venue off its account; the programme and the venue\'s link are written together. The venue\'s cached config and loyalty settings are cleared.
|
|
34957
36500
|
* @summary Create or update a loyalty program and link it to a venue
|
|
34958
36501
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
34959
36502
|
* @param {UpsertLoyaltyDto} upsertLoyaltyDto
|
|
@@ -36250,7 +37793,7 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
36250
37793
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36251
37794
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36252
37795
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36253
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
37796
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36254
37797
|
* @param {*} [options] Override http request option.
|
|
36255
37798
|
* @deprecated
|
|
36256
37799
|
* @throws {RequiredError}
|
|
@@ -36272,7 +37815,7 @@ export declare const HistoryApiAxiosParamCreator: (configuration?: Configuration
|
|
|
36272
37815
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36273
37816
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36274
37817
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36275
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
37818
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36276
37819
|
* @param {*} [options] Override http request option.
|
|
36277
37820
|
* @throws {RequiredError}
|
|
36278
37821
|
*/
|
|
@@ -36299,7 +37842,7 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
36299
37842
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36300
37843
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36301
37844
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36302
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
37845
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36303
37846
|
* @param {*} [options] Override http request option.
|
|
36304
37847
|
* @deprecated
|
|
36305
37848
|
* @throws {RequiredError}
|
|
@@ -36321,7 +37864,7 @@ export declare const HistoryApiFp: (configuration?: Configuration) => {
|
|
|
36321
37864
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36322
37865
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36323
37866
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36324
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
37867
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36325
37868
|
* @param {*} [options] Override http request option.
|
|
36326
37869
|
* @throws {RequiredError}
|
|
36327
37870
|
*/
|
|
@@ -36348,7 +37891,7 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
36348
37891
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36349
37892
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36350
37893
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36351
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
37894
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36352
37895
|
* @param {*} [options] Override http request option.
|
|
36353
37896
|
* @deprecated
|
|
36354
37897
|
* @throws {RequiredError}
|
|
@@ -36370,7 +37913,7 @@ export declare const HistoryApiFactory: (configuration?: Configuration, basePath
|
|
|
36370
37913
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36371
37914
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36372
37915
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36373
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
37916
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36374
37917
|
* @param {*} [options] Override http request option.
|
|
36375
37918
|
* @throws {RequiredError}
|
|
36376
37919
|
*/
|
|
@@ -36398,7 +37941,7 @@ export interface HistoryApiInterface {
|
|
|
36398
37941
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36399
37942
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36400
37943
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36401
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
37944
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36402
37945
|
* @param {*} [options] Override http request option.
|
|
36403
37946
|
* @deprecated
|
|
36404
37947
|
* @throws {RequiredError}
|
|
@@ -36421,7 +37964,7 @@ export interface HistoryApiInterface {
|
|
|
36421
37964
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36422
37965
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36423
37966
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36424
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
37967
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36425
37968
|
* @param {*} [options] Override http request option.
|
|
36426
37969
|
* @throws {RequiredError}
|
|
36427
37970
|
* @memberof HistoryApiInterface
|
|
@@ -36451,7 +37994,7 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
36451
37994
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36452
37995
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36453
37996
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36454
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
37997
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36455
37998
|
* @param {*} [options] Override http request option.
|
|
36456
37999
|
* @deprecated
|
|
36457
38000
|
* @throws {RequiredError}
|
|
@@ -36474,7 +38017,7 @@ export declare class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
36474
38017
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36475
38018
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36476
38019
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36477
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38020
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36478
38021
|
* @param {*} [options] Override http request option.
|
|
36479
38022
|
* @throws {RequiredError}
|
|
36480
38023
|
* @memberof HistoryApi
|
|
@@ -36502,7 +38045,7 @@ export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configurati
|
|
|
36502
38045
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36503
38046
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36504
38047
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36505
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38048
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36506
38049
|
* @param {*} [options] Override http request option.
|
|
36507
38050
|
* @throws {RequiredError}
|
|
36508
38051
|
*/
|
|
@@ -36523,7 +38066,7 @@ export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configurati
|
|
|
36523
38066
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36524
38067
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36525
38068
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36526
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38069
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36527
38070
|
* @param {*} [options] Override http request option.
|
|
36528
38071
|
* @throws {RequiredError}
|
|
36529
38072
|
*/
|
|
@@ -36544,7 +38087,7 @@ export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configurati
|
|
|
36544
38087
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36545
38088
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36546
38089
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36547
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38090
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36548
38091
|
* @param {*} [options] Override http request option.
|
|
36549
38092
|
* @throws {RequiredError}
|
|
36550
38093
|
*/
|
|
@@ -36571,7 +38114,7 @@ export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
|
36571
38114
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36572
38115
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36573
38116
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36574
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38117
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36575
38118
|
* @param {*} [options] Override http request option.
|
|
36576
38119
|
* @throws {RequiredError}
|
|
36577
38120
|
*/
|
|
@@ -36592,7 +38135,7 @@ export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
|
36592
38135
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36593
38136
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36594
38137
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36595
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38138
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36596
38139
|
* @param {*} [options] Override http request option.
|
|
36597
38140
|
* @throws {RequiredError}
|
|
36598
38141
|
*/
|
|
@@ -36613,7 +38156,7 @@ export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
|
36613
38156
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36614
38157
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36615
38158
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36616
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38159
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36617
38160
|
* @param {*} [options] Override http request option.
|
|
36618
38161
|
* @throws {RequiredError}
|
|
36619
38162
|
*/
|
|
@@ -36640,7 +38183,7 @@ export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePa
|
|
|
36640
38183
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36641
38184
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36642
38185
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36643
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38186
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36644
38187
|
* @param {*} [options] Override http request option.
|
|
36645
38188
|
* @throws {RequiredError}
|
|
36646
38189
|
*/
|
|
@@ -36661,7 +38204,7 @@ export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePa
|
|
|
36661
38204
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36662
38205
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36663
38206
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36664
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38207
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36665
38208
|
* @param {*} [options] Override http request option.
|
|
36666
38209
|
* @throws {RequiredError}
|
|
36667
38210
|
*/
|
|
@@ -36682,7 +38225,7 @@ export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePa
|
|
|
36682
38225
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36683
38226
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36684
38227
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36685
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38228
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36686
38229
|
* @param {*} [options] Override http request option.
|
|
36687
38230
|
* @throws {RequiredError}
|
|
36688
38231
|
*/
|
|
@@ -36710,7 +38253,7 @@ export interface HistoryV6ApiInterface {
|
|
|
36710
38253
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36711
38254
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36712
38255
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36713
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38256
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36714
38257
|
* @param {*} [options] Override http request option.
|
|
36715
38258
|
* @throws {RequiredError}
|
|
36716
38259
|
* @memberof HistoryV6ApiInterface
|
|
@@ -36732,7 +38275,7 @@ export interface HistoryV6ApiInterface {
|
|
|
36732
38275
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36733
38276
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36734
38277
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36735
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38278
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36736
38279
|
* @param {*} [options] Override http request option.
|
|
36737
38280
|
* @throws {RequiredError}
|
|
36738
38281
|
* @memberof HistoryV6ApiInterface
|
|
@@ -36754,7 +38297,7 @@ export interface HistoryV6ApiInterface {
|
|
|
36754
38297
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36755
38298
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36756
38299
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36757
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38300
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36758
38301
|
* @param {*} [options] Override http request option.
|
|
36759
38302
|
* @throws {RequiredError}
|
|
36760
38303
|
* @memberof HistoryV6ApiInterface
|
|
@@ -36784,7 +38327,7 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
36784
38327
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36785
38328
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36786
38329
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36787
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38330
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36788
38331
|
* @param {*} [options] Override http request option.
|
|
36789
38332
|
* @throws {RequiredError}
|
|
36790
38333
|
* @memberof HistoryV6Api
|
|
@@ -36806,7 +38349,7 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
36806
38349
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36807
38350
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36808
38351
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36809
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38352
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36810
38353
|
* @param {*} [options] Override http request option.
|
|
36811
38354
|
* @throws {RequiredError}
|
|
36812
38355
|
* @memberof HistoryV6Api
|
|
@@ -36828,7 +38371,7 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
36828
38371
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
36829
38372
|
* @param {Array<PaymentMethod>} [paymentTypePos] Keep the orders with a payment of these methods; in the POS order history Card also keeps Debit and Credit, and the totals count only those payments. Absent: every method. The online order history does not read it.
|
|
36830
38373
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
36831
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
38374
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
36832
38375
|
* @param {*} [options] Override http request option.
|
|
36833
38376
|
* @throws {RequiredError}
|
|
36834
38377
|
* @memberof HistoryV6Api
|
|
@@ -36884,7 +38427,7 @@ export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Conf
|
|
|
36884
38427
|
*/
|
|
36885
38428
|
searchInvoiceCompanies: (businessId: number, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
36886
38429
|
/**
|
|
36887
|
-
* Changes the fields sent and keeps the others, for munchi-dashboard-server, on behalf of the portal; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is
|
|
38430
|
+
* Changes the fields sent and keeps the others, for munchi-dashboard-server, on behalf of the portal; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is answered as the change wrote it. A body with no field changes nothing and answers the company as it is.
|
|
36888
38431
|
* @summary Update an invoice company
|
|
36889
38432
|
* @param {string} id The company\'s id
|
|
36890
38433
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -36943,7 +38486,7 @@ export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
|
36943
38486
|
*/
|
|
36944
38487
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceCompanyResponseDto>>>;
|
|
36945
38488
|
/**
|
|
36946
|
-
* Changes the fields sent and keeps the others, for munchi-dashboard-server, on behalf of the portal; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is
|
|
38489
|
+
* Changes the fields sent and keeps the others, for munchi-dashboard-server, on behalf of the portal; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is answered as the change wrote it. A body with no field changes nothing and answers the company as it is.
|
|
36947
38490
|
* @summary Update an invoice company
|
|
36948
38491
|
* @param {string} id The company\'s id
|
|
36949
38492
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -37002,7 +38545,7 @@ export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration,
|
|
|
37002
38545
|
*/
|
|
37003
38546
|
searchInvoiceCompanies(businessId: number, search?: string, options?: any): AxiosPromise<Array<InvoiceCompanyResponseDto>>;
|
|
37004
38547
|
/**
|
|
37005
|
-
* Changes the fields sent and keeps the others, for munchi-dashboard-server, on behalf of the portal; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is
|
|
38548
|
+
* Changes the fields sent and keeps the others, for munchi-dashboard-server, on behalf of the portal; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is answered as the change wrote it. A body with no field changes nothing and answers the company as it is.
|
|
37006
38549
|
* @summary Update an invoice company
|
|
37007
38550
|
* @param {string} id The company\'s id
|
|
37008
38551
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -37067,7 +38610,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
37067
38610
|
*/
|
|
37068
38611
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): AxiosPromise<Array<InvoiceCompanyResponseDto>>;
|
|
37069
38612
|
/**
|
|
37070
|
-
* Changes the fields sent and keeps the others, for munchi-dashboard-server, on behalf of the portal; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is
|
|
38613
|
+
* Changes the fields sent and keeps the others, for munchi-dashboard-server, on behalf of the portal; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is answered as the change wrote it. A body with no field changes nothing and answers the company as it is.
|
|
37071
38614
|
* @summary Update an invoice company
|
|
37072
38615
|
* @param {string} id The company\'s id
|
|
37073
38616
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -37134,7 +38677,7 @@ export declare class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompa
|
|
|
37134
38677
|
*/
|
|
37135
38678
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceCompanyResponseDto[], any, {}>>;
|
|
37136
38679
|
/**
|
|
37137
|
-
* Changes the fields sent and keeps the others, for munchi-dashboard-server, on behalf of the portal; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is
|
|
38680
|
+
* Changes the fields sent and keeps the others, for munchi-dashboard-server, on behalf of the portal; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is answered as the change wrote it. A body with no field changes nothing and answers the company as it is.
|
|
37138
38681
|
* @summary Update an invoice company
|
|
37139
38682
|
* @param {string} id The company\'s id
|
|
37140
38683
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -37184,6 +38727,14 @@ export declare const KDSApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
37184
38727
|
* @throws {RequiredError}
|
|
37185
38728
|
*/
|
|
37186
38729
|
kdsMarkOrderReady: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38730
|
+
/**
|
|
38731
|
+
* 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.
|
|
38732
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
38733
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
38734
|
+
* @param {*} [options] Override http request option.
|
|
38735
|
+
* @throws {RequiredError}
|
|
38736
|
+
*/
|
|
38737
|
+
kdsMarkOrdersReady: (kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37187
38738
|
/**
|
|
37188
38739
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
37189
38740
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -37232,6 +38783,14 @@ export declare const KDSApiFp: (configuration?: Configuration) => {
|
|
|
37232
38783
|
* @throws {RequiredError}
|
|
37233
38784
|
*/
|
|
37234
38785
|
kdsMarkOrderReady(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KdsReadyOrderResponseDto>>;
|
|
38786
|
+
/**
|
|
38787
|
+
* 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.
|
|
38788
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
38789
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
38790
|
+
* @param {*} [options] Override http request option.
|
|
38791
|
+
* @throws {RequiredError}
|
|
38792
|
+
*/
|
|
38793
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KdsReadyOrdersResponseDto>>;
|
|
37235
38794
|
/**
|
|
37236
38795
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
37237
38796
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -37280,6 +38839,14 @@ export declare const KDSApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
37280
38839
|
* @throws {RequiredError}
|
|
37281
38840
|
*/
|
|
37282
38841
|
kdsMarkOrderReady(id: string, options?: any): AxiosPromise<KdsReadyOrderResponseDto>;
|
|
38842
|
+
/**
|
|
38843
|
+
* 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.
|
|
38844
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
38845
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
38846
|
+
* @param {*} [options] Override http request option.
|
|
38847
|
+
* @throws {RequiredError}
|
|
38848
|
+
*/
|
|
38849
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: any): AxiosPromise<KdsReadyOrdersResponseDto>;
|
|
37283
38850
|
/**
|
|
37284
38851
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
37285
38852
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -37332,6 +38899,15 @@ export interface KDSApiInterface {
|
|
|
37332
38899
|
* @memberof KDSApiInterface
|
|
37333
38900
|
*/
|
|
37334
38901
|
kdsMarkOrderReady(id: string, options?: AxiosRequestConfig): AxiosPromise<KdsReadyOrderResponseDto>;
|
|
38902
|
+
/**
|
|
38903
|
+
* 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.
|
|
38904
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
38905
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
38906
|
+
* @param {*} [options] Override http request option.
|
|
38907
|
+
* @throws {RequiredError}
|
|
38908
|
+
* @memberof KDSApiInterface
|
|
38909
|
+
*/
|
|
38910
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig): AxiosPromise<KdsReadyOrdersResponseDto>;
|
|
37335
38911
|
/**
|
|
37336
38912
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
37337
38913
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -37386,6 +38962,15 @@ export declare class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
|
37386
38962
|
* @memberof KDSApi
|
|
37387
38963
|
*/
|
|
37388
38964
|
kdsMarkOrderReady(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<KdsReadyOrderResponseDto, any, {}>>;
|
|
38965
|
+
/**
|
|
38966
|
+
* 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.
|
|
38967
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
38968
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
38969
|
+
* @param {*} [options] Override http request option.
|
|
38970
|
+
* @throws {RequiredError}
|
|
38971
|
+
* @memberof KDSApi
|
|
38972
|
+
*/
|
|
38973
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<KdsReadyOrdersResponseDto, any, {}>>;
|
|
37389
38974
|
/**
|
|
37390
38975
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
37391
38976
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -39027,6 +40612,14 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
39027
40612
|
* @throws {RequiredError}
|
|
39028
40613
|
*/
|
|
39029
40614
|
acceptOrder: (acceptOrderDto: AcceptOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40615
|
+
/**
|
|
40616
|
+
* 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.
|
|
40617
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
40618
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
40619
|
+
* @param {*} [options] Override http request option.
|
|
40620
|
+
* @throws {RequiredError}
|
|
40621
|
+
*/
|
|
40622
|
+
changePosOrdersStatusInBulk: (changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39030
40623
|
/**
|
|
39031
40624
|
* 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.
|
|
39032
40625
|
* @summary Confirm a pre-order
|
|
@@ -39044,7 +40637,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
39044
40637
|
*/
|
|
39045
40638
|
deletePosParkedOrderV2: (deletePosOrderDto: DeletePosOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39046
40639
|
/**
|
|
39047
|
-
* The till\'s Order Manager hands a platform order over. A delivery order becomes pick_up_by_driver; a pickup or dine-in order becomes delivered. The status is stored in Postgres
|
|
40640
|
+
* The till\'s Order Manager hands a platform order over. A delivery order becomes pick_up_by_driver; a pickup or dine-in order becomes delivered. The status is stored in Postgres and the answer leaves; after it, the platform or the order\'s Firestore document is told, then the venue\'s tills; a failure to tell it is logged and does not change the answer.
|
|
39048
40641
|
* @summary Mark an order as delivered to customer or picked-up by driver
|
|
39049
40642
|
* @param {DeliveredOrderDto} deliveredOrderDto
|
|
39050
40643
|
* @param {*} [options] Override http request option.
|
|
@@ -39159,6 +40752,14 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
39159
40752
|
* @throws {RequiredError}
|
|
39160
40753
|
*/
|
|
39161
40754
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderStatusResponseDto>>;
|
|
40755
|
+
/**
|
|
40756
|
+
* 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.
|
|
40757
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
40758
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
40759
|
+
* @param {*} [options] Override http request option.
|
|
40760
|
+
* @throws {RequiredError}
|
|
40761
|
+
*/
|
|
40762
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangePosOrdersStatusInBulkResponseDto>>;
|
|
39162
40763
|
/**
|
|
39163
40764
|
* 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.
|
|
39164
40765
|
* @summary Confirm a pre-order
|
|
@@ -39176,7 +40777,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
39176
40777
|
*/
|
|
39177
40778
|
deletePosParkedOrderV2(deletePosOrderDto: DeletePosOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
39178
40779
|
/**
|
|
39179
|
-
* The till\'s Order Manager hands a platform order over. A delivery order becomes pick_up_by_driver; a pickup or dine-in order becomes delivered. The status is stored in Postgres
|
|
40780
|
+
* The till\'s Order Manager hands a platform order over. A delivery order becomes pick_up_by_driver; a pickup or dine-in order becomes delivered. The status is stored in Postgres and the answer leaves; after it, the platform or the order\'s Firestore document is told, then the venue\'s tills; a failure to tell it is logged and does not change the answer.
|
|
39180
40781
|
* @summary Mark an order as delivered to customer or picked-up by driver
|
|
39181
40782
|
* @param {DeliveredOrderDto} deliveredOrderDto
|
|
39182
40783
|
* @param {*} [options] Override http request option.
|
|
@@ -39291,6 +40892,14 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
39291
40892
|
* @throws {RequiredError}
|
|
39292
40893
|
*/
|
|
39293
40894
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: any): AxiosPromise<OrderStatusResponseDto>;
|
|
40895
|
+
/**
|
|
40896
|
+
* 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.
|
|
40897
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
40898
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
40899
|
+
* @param {*} [options] Override http request option.
|
|
40900
|
+
* @throws {RequiredError}
|
|
40901
|
+
*/
|
|
40902
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: any): AxiosPromise<ChangePosOrdersStatusInBulkResponseDto>;
|
|
39294
40903
|
/**
|
|
39295
40904
|
* 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.
|
|
39296
40905
|
* @summary Confirm a pre-order
|
|
@@ -39308,7 +40917,7 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
|
|
|
39308
40917
|
*/
|
|
39309
40918
|
deletePosParkedOrderV2(deletePosOrderDto: DeletePosOrderDto, options?: any): AxiosPromise<void>;
|
|
39310
40919
|
/**
|
|
39311
|
-
* The till\'s Order Manager hands a platform order over. A delivery order becomes pick_up_by_driver; a pickup or dine-in order becomes delivered. The status is stored in Postgres
|
|
40920
|
+
* The till\'s Order Manager hands a platform order over. A delivery order becomes pick_up_by_driver; a pickup or dine-in order becomes delivered. The status is stored in Postgres and the answer leaves; after it, the platform or the order\'s Firestore document is told, then the venue\'s tills; a failure to tell it is logged and does not change the answer.
|
|
39312
40921
|
* @summary Mark an order as delivered to customer or picked-up by driver
|
|
39313
40922
|
* @param {DeliveredOrderDto} deliveredOrderDto
|
|
39314
40923
|
* @param {*} [options] Override http request option.
|
|
@@ -39425,6 +41034,15 @@ export interface OrdersApiInterface {
|
|
|
39425
41034
|
* @memberof OrdersApiInterface
|
|
39426
41035
|
*/
|
|
39427
41036
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: AxiosRequestConfig): AxiosPromise<OrderStatusResponseDto>;
|
|
41037
|
+
/**
|
|
41038
|
+
* 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.
|
|
41039
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
41040
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
41041
|
+
* @param {*} [options] Override http request option.
|
|
41042
|
+
* @throws {RequiredError}
|
|
41043
|
+
* @memberof OrdersApiInterface
|
|
41044
|
+
*/
|
|
41045
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig): AxiosPromise<ChangePosOrdersStatusInBulkResponseDto>;
|
|
39428
41046
|
/**
|
|
39429
41047
|
* 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.
|
|
39430
41048
|
* @summary Confirm a pre-order
|
|
@@ -39444,7 +41062,7 @@ export interface OrdersApiInterface {
|
|
|
39444
41062
|
*/
|
|
39445
41063
|
deletePosParkedOrderV2(deletePosOrderDto: DeletePosOrderDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
39446
41064
|
/**
|
|
39447
|
-
* The till\'s Order Manager hands a platform order over. A delivery order becomes pick_up_by_driver; a pickup or dine-in order becomes delivered. The status is stored in Postgres
|
|
41065
|
+
* The till\'s Order Manager hands a platform order over. A delivery order becomes pick_up_by_driver; a pickup or dine-in order becomes delivered. The status is stored in Postgres and the answer leaves; after it, the platform or the order\'s Firestore document is told, then the venue\'s tills; a failure to tell it is logged and does not change the answer.
|
|
39448
41066
|
* @summary Mark an order as delivered to customer or picked-up by driver
|
|
39449
41067
|
* @param {DeliveredOrderDto} deliveredOrderDto
|
|
39450
41068
|
* @param {*} [options] Override http request option.
|
|
@@ -39574,6 +41192,15 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
39574
41192
|
* @memberof OrdersApi
|
|
39575
41193
|
*/
|
|
39576
41194
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderStatusResponseDto, any, {}>>;
|
|
41195
|
+
/**
|
|
41196
|
+
* 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.
|
|
41197
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
41198
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
41199
|
+
* @param {*} [options] Override http request option.
|
|
41200
|
+
* @throws {RequiredError}
|
|
41201
|
+
* @memberof OrdersApi
|
|
41202
|
+
*/
|
|
41203
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ChangePosOrdersStatusInBulkResponseDto, any, {}>>;
|
|
39577
41204
|
/**
|
|
39578
41205
|
* 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.
|
|
39579
41206
|
* @summary Confirm a pre-order
|
|
@@ -39593,7 +41220,7 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
39593
41220
|
*/
|
|
39594
41221
|
deletePosParkedOrderV2(deletePosOrderDto: DeletePosOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
39595
41222
|
/**
|
|
39596
|
-
* The till\'s Order Manager hands a platform order over. A delivery order becomes pick_up_by_driver; a pickup or dine-in order becomes delivered. The status is stored in Postgres
|
|
41223
|
+
* The till\'s Order Manager hands a platform order over. A delivery order becomes pick_up_by_driver; a pickup or dine-in order becomes delivered. The status is stored in Postgres and the answer leaves; after it, the platform or the order\'s Firestore document is told, then the venue\'s tills; a failure to tell it is logged and does not change the answer.
|
|
39597
41224
|
* @summary Mark an order as delivered to customer or picked-up by driver
|
|
39598
41225
|
* @param {DeliveredOrderDto} deliveredOrderDto
|
|
39599
41226
|
* @param {*} [options] Override http request option.
|
|
@@ -42371,7 +43998,7 @@ export declare const ProductApiAxiosParamCreator: (configuration?: Configuration
|
|
|
42371
43998
|
* @summary Get a product\'s stock and on/off for every channel
|
|
42372
43999
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42373
44000
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42374
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44001
|
+
* @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
|
|
42375
44002
|
* @param {*} [options] Override http request option.
|
|
42376
44003
|
* @throws {RequiredError}
|
|
42377
44004
|
*/
|
|
@@ -42381,7 +44008,7 @@ export declare const ProductApiAxiosParamCreator: (configuration?: Configuration
|
|
|
42381
44008
|
* @summary Save a product\'s stock and on/off for several channels at once
|
|
42382
44009
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42383
44010
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42384
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44011
|
+
* @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
|
|
42385
44012
|
* @param {UpdateChannelInventoryDto} updateChannelInventoryDto The channels to save
|
|
42386
44013
|
* @param {*} [options] Override http request option.
|
|
42387
44014
|
* @throws {RequiredError}
|
|
@@ -42392,7 +44019,7 @@ export declare const ProductApiAxiosParamCreator: (configuration?: Configuration
|
|
|
42392
44019
|
* @summary Save a product\'s SKU (label code)
|
|
42393
44020
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42394
44021
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42395
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44022
|
+
* @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
|
|
42396
44023
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
42397
44024
|
* @param {*} [options] Override http request option.
|
|
42398
44025
|
* @throws {RequiredError}
|
|
@@ -42409,7 +44036,7 @@ export declare const ProductApiFp: (configuration?: Configuration) => {
|
|
|
42409
44036
|
* @summary Get a product\'s stock and on/off for every channel
|
|
42410
44037
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42411
44038
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42412
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44039
|
+
* @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
|
|
42413
44040
|
* @param {*} [options] Override http request option.
|
|
42414
44041
|
* @throws {RequiredError}
|
|
42415
44042
|
*/
|
|
@@ -42419,7 +44046,7 @@ export declare const ProductApiFp: (configuration?: Configuration) => {
|
|
|
42419
44046
|
* @summary Save a product\'s stock and on/off for several channels at once
|
|
42420
44047
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42421
44048
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42422
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44049
|
+
* @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
|
|
42423
44050
|
* @param {UpdateChannelInventoryDto} updateChannelInventoryDto The channels to save
|
|
42424
44051
|
* @param {*} [options] Override http request option.
|
|
42425
44052
|
* @throws {RequiredError}
|
|
@@ -42430,7 +44057,7 @@ export declare const ProductApiFp: (configuration?: Configuration) => {
|
|
|
42430
44057
|
* @summary Save a product\'s SKU (label code)
|
|
42431
44058
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42432
44059
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42433
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44060
|
+
* @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
|
|
42434
44061
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
42435
44062
|
* @param {*} [options] Override http request option.
|
|
42436
44063
|
* @throws {RequiredError}
|
|
@@ -42447,7 +44074,7 @@ export declare const ProductApiFactory: (configuration?: Configuration, basePath
|
|
|
42447
44074
|
* @summary Get a product\'s stock and on/off for every channel
|
|
42448
44075
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42449
44076
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42450
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44077
|
+
* @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
|
|
42451
44078
|
* @param {*} [options] Override http request option.
|
|
42452
44079
|
* @throws {RequiredError}
|
|
42453
44080
|
*/
|
|
@@ -42457,7 +44084,7 @@ export declare const ProductApiFactory: (configuration?: Configuration, basePath
|
|
|
42457
44084
|
* @summary Save a product\'s stock and on/off for several channels at once
|
|
42458
44085
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42459
44086
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42460
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44087
|
+
* @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
|
|
42461
44088
|
* @param {UpdateChannelInventoryDto} updateChannelInventoryDto The channels to save
|
|
42462
44089
|
* @param {*} [options] Override http request option.
|
|
42463
44090
|
* @throws {RequiredError}
|
|
@@ -42468,7 +44095,7 @@ export declare const ProductApiFactory: (configuration?: Configuration, basePath
|
|
|
42468
44095
|
* @summary Save a product\'s SKU (label code)
|
|
42469
44096
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42470
44097
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42471
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44098
|
+
* @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
|
|
42472
44099
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
42473
44100
|
* @param {*} [options] Override http request option.
|
|
42474
44101
|
* @throws {RequiredError}
|
|
@@ -42486,7 +44113,7 @@ export interface ProductApiInterface {
|
|
|
42486
44113
|
* @summary Get a product\'s stock and on/off for every channel
|
|
42487
44114
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42488
44115
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42489
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44116
|
+
* @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
|
|
42490
44117
|
* @param {*} [options] Override http request option.
|
|
42491
44118
|
* @throws {RequiredError}
|
|
42492
44119
|
* @memberof ProductApiInterface
|
|
@@ -42497,7 +44124,7 @@ export interface ProductApiInterface {
|
|
|
42497
44124
|
* @summary Save a product\'s stock and on/off for several channels at once
|
|
42498
44125
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42499
44126
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42500
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44127
|
+
* @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
|
|
42501
44128
|
* @param {UpdateChannelInventoryDto} updateChannelInventoryDto The channels to save
|
|
42502
44129
|
* @param {*} [options] Override http request option.
|
|
42503
44130
|
* @throws {RequiredError}
|
|
@@ -42509,7 +44136,7 @@ export interface ProductApiInterface {
|
|
|
42509
44136
|
* @summary Save a product\'s SKU (label code)
|
|
42510
44137
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42511
44138
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42512
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44139
|
+
* @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
|
|
42513
44140
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
42514
44141
|
* @param {*} [options] Override http request option.
|
|
42515
44142
|
* @throws {RequiredError}
|
|
@@ -42529,7 +44156,7 @@ export declare class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
42529
44156
|
* @summary Get a product\'s stock and on/off for every channel
|
|
42530
44157
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42531
44158
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42532
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44159
|
+
* @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
|
|
42533
44160
|
* @param {*} [options] Override http request option.
|
|
42534
44161
|
* @throws {RequiredError}
|
|
42535
44162
|
* @memberof ProductApi
|
|
@@ -42540,7 +44167,7 @@ export declare class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
42540
44167
|
* @summary Save a product\'s stock and on/off for several channels at once
|
|
42541
44168
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42542
44169
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42543
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44170
|
+
* @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
|
|
42544
44171
|
* @param {UpdateChannelInventoryDto} updateChannelInventoryDto The channels to save
|
|
42545
44172
|
* @param {*} [options] Override http request option.
|
|
42546
44173
|
* @throws {RequiredError}
|
|
@@ -42552,7 +44179,7 @@ export declare class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
42552
44179
|
* @summary Save a product\'s SKU (label code)
|
|
42553
44180
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
42554
44181
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
42555
|
-
* @param {string} productId The product\'s id in Vendure
|
|
44182
|
+
* @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
|
|
42556
44183
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
42557
44184
|
* @param {*} [options] Override http request option.
|
|
42558
44185
|
* @throws {RequiredError}
|
|
@@ -43473,12 +45100,31 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
43473
45100
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43474
45101
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43475
45102
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43476
|
-
* @param {string} [timezone] Timezone
|
|
45103
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43477
45104
|
* @param {ProviderEnum} [provider] Order source provider (default is MunchiPos)
|
|
43478
45105
|
* @param {*} [options] Override http request option.
|
|
43479
45106
|
* @throws {RequiredError}
|
|
43480
45107
|
*/
|
|
43481
45108
|
getEndOfDayReportV5: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45109
|
+
/**
|
|
45110
|
+
* 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.
|
|
45111
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
45112
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45113
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
45114
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45115
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45116
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
45117
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
45118
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
45119
|
+
* @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
|
|
45120
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
45121
|
+
* @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
|
|
45122
|
+
* @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
|
|
45123
|
+
* @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
|
|
45124
|
+
* @param {*} [options] Override http request option.
|
|
45125
|
+
* @throws {RequiredError}
|
|
45126
|
+
*/
|
|
45127
|
+
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<RequestArgs>;
|
|
43482
45128
|
/**
|
|
43483
45129
|
*
|
|
43484
45130
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -43506,12 +45152,31 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
43506
45152
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43507
45153
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43508
45154
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43509
|
-
* @param {string} [timezone] Timezone
|
|
45155
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43510
45156
|
* @param {ProviderEnum} [provider] Order source provider (default is MunchiPos)
|
|
43511
45157
|
* @param {*} [options] Override http request option.
|
|
43512
45158
|
* @throws {RequiredError}
|
|
43513
45159
|
*/
|
|
43514
45160
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EndOfDayReportDtoV4>>;
|
|
45161
|
+
/**
|
|
45162
|
+
* 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.
|
|
45163
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
45164
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45165
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
45166
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45167
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45168
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
45169
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
45170
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
45171
|
+
* @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
|
|
45172
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
45173
|
+
* @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
|
|
45174
|
+
* @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
|
|
45175
|
+
* @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
|
|
45176
|
+
* @param {*} [options] Override http request option.
|
|
45177
|
+
* @throws {RequiredError}
|
|
45178
|
+
*/
|
|
45179
|
+
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>>;
|
|
43515
45180
|
/**
|
|
43516
45181
|
*
|
|
43517
45182
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -43539,12 +45204,31 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
43539
45204
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43540
45205
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43541
45206
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43542
|
-
* @param {string} [timezone] Timezone
|
|
45207
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43543
45208
|
* @param {ProviderEnum} [provider] Order source provider (default is MunchiPos)
|
|
43544
45209
|
* @param {*} [options] Override http request option.
|
|
43545
45210
|
* @throws {RequiredError}
|
|
43546
45211
|
*/
|
|
43547
45212
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: any): AxiosPromise<EndOfDayReportDtoV4>;
|
|
45213
|
+
/**
|
|
45214
|
+
* 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.
|
|
45215
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
45216
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45217
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
45218
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45219
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45220
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
45221
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
45222
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
45223
|
+
* @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
|
|
45224
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
45225
|
+
* @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
|
|
45226
|
+
* @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
|
|
45227
|
+
* @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
|
|
45228
|
+
* @param {*} [options] Override http request option.
|
|
45229
|
+
* @throws {RequiredError}
|
|
45230
|
+
*/
|
|
45231
|
+
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>;
|
|
43548
45232
|
/**
|
|
43549
45233
|
*
|
|
43550
45234
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -43573,13 +45257,33 @@ export interface ReportApiInterface {
|
|
|
43573
45257
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43574
45258
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43575
45259
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43576
|
-
* @param {string} [timezone] Timezone
|
|
45260
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43577
45261
|
* @param {ProviderEnum} [provider] Order source provider (default is MunchiPos)
|
|
43578
45262
|
* @param {*} [options] Override http request option.
|
|
43579
45263
|
* @throws {RequiredError}
|
|
43580
45264
|
* @memberof ReportApiInterface
|
|
43581
45265
|
*/
|
|
43582
45266
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportDtoV4>;
|
|
45267
|
+
/**
|
|
45268
|
+
* 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.
|
|
45269
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
45270
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45271
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
45272
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45273
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45274
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
45275
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
45276
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
45277
|
+
* @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
|
|
45278
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
45279
|
+
* @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
|
|
45280
|
+
* @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
|
|
45281
|
+
* @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
|
|
45282
|
+
* @param {*} [options] Override http request option.
|
|
45283
|
+
* @throws {RequiredError}
|
|
45284
|
+
* @memberof ReportApiInterface
|
|
45285
|
+
*/
|
|
45286
|
+
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>;
|
|
43583
45287
|
/**
|
|
43584
45288
|
*
|
|
43585
45289
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -43610,13 +45314,33 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
43610
45314
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43611
45315
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43612
45316
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43613
|
-
* @param {string} [timezone] Timezone
|
|
45317
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43614
45318
|
* @param {ProviderEnum} [provider] Order source provider (default is MunchiPos)
|
|
43615
45319
|
* @param {*} [options] Override http request option.
|
|
43616
45320
|
* @throws {RequiredError}
|
|
43617
45321
|
* @memberof ReportApi
|
|
43618
45322
|
*/
|
|
43619
45323
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EndOfDayReportDtoV4, any, {}>>;
|
|
45324
|
+
/**
|
|
45325
|
+
* 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.
|
|
45326
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
45327
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45328
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
45329
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45330
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
45331
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
45332
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
45333
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
45334
|
+
* @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
|
|
45335
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
45336
|
+
* @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
|
|
45337
|
+
* @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
|
|
45338
|
+
* @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
|
|
45339
|
+
* @param {*} [options] Override http request option.
|
|
45340
|
+
* @throws {RequiredError}
|
|
45341
|
+
* @memberof ReportApi
|
|
45342
|
+
*/
|
|
45343
|
+
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<import("axios").AxiosResponse<SalesReportResponseDto, any, {}>>;
|
|
43620
45344
|
/**
|
|
43621
45345
|
*
|
|
43622
45346
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -43645,7 +45369,7 @@ export declare const ReportV6ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
43645
45369
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43646
45370
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43647
45371
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43648
|
-
* @param {string} [timezone] Timezone of the period
|
|
45372
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43649
45373
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
43650
45374
|
* @param {*} [options] Override http request option.
|
|
43651
45375
|
* @throws {RequiredError}
|
|
@@ -43659,7 +45383,7 @@ export declare const ReportV6ApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
43659
45383
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43660
45384
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43661
45385
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43662
|
-
* @param {string} [timezone] Timezone of the period
|
|
45386
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43663
45387
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
43664
45388
|
* @param {*} [options] Override http request option.
|
|
43665
45389
|
* @throws {RequiredError}
|
|
@@ -43678,7 +45402,7 @@ export declare const ReportV6ApiFp: (configuration?: Configuration) => {
|
|
|
43678
45402
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43679
45403
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43680
45404
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43681
|
-
* @param {string} [timezone] Timezone of the period
|
|
45405
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43682
45406
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
43683
45407
|
* @param {*} [options] Override http request option.
|
|
43684
45408
|
* @throws {RequiredError}
|
|
@@ -43692,7 +45416,7 @@ export declare const ReportV6ApiFp: (configuration?: Configuration) => {
|
|
|
43692
45416
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43693
45417
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43694
45418
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43695
|
-
* @param {string} [timezone] Timezone of the period
|
|
45419
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43696
45420
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
43697
45421
|
* @param {*} [options] Override http request option.
|
|
43698
45422
|
* @throws {RequiredError}
|
|
@@ -43711,7 +45435,7 @@ export declare const ReportV6ApiFactory: (configuration?: Configuration, basePat
|
|
|
43711
45435
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43712
45436
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43713
45437
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43714
|
-
* @param {string} [timezone] Timezone of the period
|
|
45438
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43715
45439
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
43716
45440
|
* @param {*} [options] Override http request option.
|
|
43717
45441
|
* @throws {RequiredError}
|
|
@@ -43725,7 +45449,7 @@ export declare const ReportV6ApiFactory: (configuration?: Configuration, basePat
|
|
|
43725
45449
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43726
45450
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43727
45451
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43728
|
-
* @param {string} [timezone] Timezone of the period
|
|
45452
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43729
45453
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
43730
45454
|
* @param {*} [options] Override http request option.
|
|
43731
45455
|
* @throws {RequiredError}
|
|
@@ -43745,7 +45469,7 @@ export interface ReportV6ApiInterface {
|
|
|
43745
45469
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43746
45470
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43747
45471
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43748
|
-
* @param {string} [timezone] Timezone of the period
|
|
45472
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43749
45473
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
43750
45474
|
* @param {*} [options] Override http request option.
|
|
43751
45475
|
* @throws {RequiredError}
|
|
@@ -43760,7 +45484,7 @@ export interface ReportV6ApiInterface {
|
|
|
43760
45484
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43761
45485
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43762
45486
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43763
|
-
* @param {string} [timezone] Timezone of the period
|
|
45487
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43764
45488
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
43765
45489
|
* @param {*} [options] Override http request option.
|
|
43766
45490
|
* @throws {RequiredError}
|
|
@@ -43782,7 +45506,7 @@ export declare class ReportV6Api extends BaseAPI implements ReportV6ApiInterface
|
|
|
43782
45506
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43783
45507
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43784
45508
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43785
|
-
* @param {string} [timezone] Timezone of the period
|
|
45509
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43786
45510
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
43787
45511
|
* @param {*} [options] Override http request option.
|
|
43788
45512
|
* @throws {RequiredError}
|
|
@@ -43797,7 +45521,7 @@ export declare class ReportV6Api extends BaseAPI implements ReportV6ApiInterface
|
|
|
43797
45521
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
43798
45522
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43799
45523
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
43800
|
-
* @param {string} [timezone] Timezone of the period
|
|
45524
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
43801
45525
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
43802
45526
|
* @param {*} [options] Override http request option.
|
|
43803
45527
|
* @throws {RequiredError}
|