@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/generated/api.ts
CHANGED
|
@@ -502,6 +502,18 @@ export interface BusinessConfigResponseDto {
|
|
|
502
502
|
* @memberof BusinessConfigResponseDto
|
|
503
503
|
*/
|
|
504
504
|
'currency': CurrencyCode;
|
|
505
|
+
/**
|
|
506
|
+
* 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
|
|
507
|
+
* @type {string}
|
|
508
|
+
* @memberof BusinessConfigResponseDto
|
|
509
|
+
*/
|
|
510
|
+
'countryCode'?: string | null;
|
|
511
|
+
/**
|
|
512
|
+
* 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
|
|
513
|
+
* @type {string}
|
|
514
|
+
* @memberof BusinessConfigResponseDto
|
|
515
|
+
*/
|
|
516
|
+
'locale'?: string | null;
|
|
505
517
|
/**
|
|
506
518
|
*
|
|
507
519
|
* @type {BusinessConfigResponseDtoBusiness}
|
|
@@ -2352,6 +2364,52 @@ export interface ChangePaymentMethodOptionDto {
|
|
|
2352
2364
|
*/
|
|
2353
2365
|
'enable'?: boolean;
|
|
2354
2366
|
}
|
|
2367
|
+
/**
|
|
2368
|
+
*
|
|
2369
|
+
* @export
|
|
2370
|
+
* @interface ChangePosOrdersStatusInBulkDto
|
|
2371
|
+
*/
|
|
2372
|
+
export interface ChangePosOrdersStatusInBulkDto {
|
|
2373
|
+
/**
|
|
2374
|
+
* The venue whose tickets and orders the till moves, by its venue id
|
|
2375
|
+
* @type {number}
|
|
2376
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2377
|
+
*/
|
|
2378
|
+
'orderingBusinessId': number;
|
|
2379
|
+
/**
|
|
2380
|
+
* The ids in Firestore of the till\'s tickets and orders to move, each once, 1 to 100 of them
|
|
2381
|
+
* @type {Array<string>}
|
|
2382
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2383
|
+
*/
|
|
2384
|
+
'orderIds': Array<string>;
|
|
2385
|
+
/**
|
|
2386
|
+
*
|
|
2387
|
+
* @type {PosBulkOrderStatus}
|
|
2388
|
+
* @memberof ChangePosOrdersStatusInBulkDto
|
|
2389
|
+
*/
|
|
2390
|
+
'status': PosBulkOrderStatus;
|
|
2391
|
+
}
|
|
2392
|
+
|
|
2393
|
+
|
|
2394
|
+
/**
|
|
2395
|
+
*
|
|
2396
|
+
* @export
|
|
2397
|
+
* @interface ChangePosOrdersStatusInBulkResponseDto
|
|
2398
|
+
*/
|
|
2399
|
+
export interface ChangePosOrdersStatusInBulkResponseDto {
|
|
2400
|
+
/**
|
|
2401
|
+
* The ids of the tickets and orders moved to the status, in the order the till sent them; empty when none could be
|
|
2402
|
+
* @type {Array<string>}
|
|
2403
|
+
* @memberof ChangePosOrdersStatusInBulkResponseDto
|
|
2404
|
+
*/
|
|
2405
|
+
'moved': Array<string>;
|
|
2406
|
+
/**
|
|
2407
|
+
* The ids left as they are, each with the reason, in the order the till sent them; empty when every one moved
|
|
2408
|
+
* @type {Array<PosOrderLeftAsItIsDto>}
|
|
2409
|
+
* @memberof ChangePosOrdersStatusInBulkResponseDto
|
|
2410
|
+
*/
|
|
2411
|
+
'skipped': Array<PosOrderLeftAsItIsDto>;
|
|
2412
|
+
}
|
|
2355
2413
|
/**
|
|
2356
2414
|
*
|
|
2357
2415
|
* @export
|
|
@@ -2887,6 +2945,18 @@ export interface ConfigDto {
|
|
|
2887
2945
|
* @memberof ConfigDto
|
|
2888
2946
|
*/
|
|
2889
2947
|
'currency': CurrencyCode;
|
|
2948
|
+
/**
|
|
2949
|
+
* 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
|
|
2950
|
+
* @type {string}
|
|
2951
|
+
* @memberof ConfigDto
|
|
2952
|
+
*/
|
|
2953
|
+
'countryCode'?: string | null;
|
|
2954
|
+
/**
|
|
2955
|
+
* 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
|
|
2956
|
+
* @type {string}
|
|
2957
|
+
* @memberof ConfigDto
|
|
2958
|
+
*/
|
|
2959
|
+
'locale'?: string | null;
|
|
2890
2960
|
/**
|
|
2891
2961
|
* Creation date and time in ISO 8601 format
|
|
2892
2962
|
* @type {string}
|
|
@@ -3017,7 +3087,7 @@ export interface ConfigManagementResponseDto {
|
|
|
3017
3087
|
*/
|
|
3018
3088
|
'message'?: string;
|
|
3019
3089
|
/**
|
|
3020
|
-
* 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.
|
|
3090
|
+
* 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.
|
|
3021
3091
|
* @type {object}
|
|
3022
3092
|
* @memberof ConfigManagementResponseDto
|
|
3023
3093
|
*/
|
|
@@ -4460,7 +4530,141 @@ export const CurrencyCode = {
|
|
|
4460
4530
|
Mdl: 'MDL',
|
|
4461
4531
|
Bam: 'BAM',
|
|
4462
4532
|
Aed: 'AED',
|
|
4463
|
-
Usd: 'USD'
|
|
4533
|
+
Usd: 'USD',
|
|
4534
|
+
Afn: 'AFN',
|
|
4535
|
+
Amd: 'AMD',
|
|
4536
|
+
Aoa: 'AOA',
|
|
4537
|
+
Ars: 'ARS',
|
|
4538
|
+
Aud: 'AUD',
|
|
4539
|
+
Awg: 'AWG',
|
|
4540
|
+
Azn: 'AZN',
|
|
4541
|
+
Bbd: 'BBD',
|
|
4542
|
+
Bdt: 'BDT',
|
|
4543
|
+
Bhd: 'BHD',
|
|
4544
|
+
Bif: 'BIF',
|
|
4545
|
+
Bmd: 'BMD',
|
|
4546
|
+
Bnd: 'BND',
|
|
4547
|
+
Bob: 'BOB',
|
|
4548
|
+
Brl: 'BRL',
|
|
4549
|
+
Bsd: 'BSD',
|
|
4550
|
+
Btn: 'BTN',
|
|
4551
|
+
Bwp: 'BWP',
|
|
4552
|
+
Byn: 'BYN',
|
|
4553
|
+
Bzd: 'BZD',
|
|
4554
|
+
Cad: 'CAD',
|
|
4555
|
+
Cdf: 'CDF',
|
|
4556
|
+
Clp: 'CLP',
|
|
4557
|
+
Cny: 'CNY',
|
|
4558
|
+
Cop: 'COP',
|
|
4559
|
+
Crc: 'CRC',
|
|
4560
|
+
Cup: 'CUP',
|
|
4561
|
+
Cve: 'CVE',
|
|
4562
|
+
Djf: 'DJF',
|
|
4563
|
+
Dop: 'DOP',
|
|
4564
|
+
Dzd: 'DZD',
|
|
4565
|
+
Egp: 'EGP',
|
|
4566
|
+
Ern: 'ERN',
|
|
4567
|
+
Etb: 'ETB',
|
|
4568
|
+
Fjd: 'FJD',
|
|
4569
|
+
Fkp: 'FKP',
|
|
4570
|
+
Gel: 'GEL',
|
|
4571
|
+
Ghs: 'GHS',
|
|
4572
|
+
Gip: 'GIP',
|
|
4573
|
+
Gmd: 'GMD',
|
|
4574
|
+
Gnf: 'GNF',
|
|
4575
|
+
Gtq: 'GTQ',
|
|
4576
|
+
Gyd: 'GYD',
|
|
4577
|
+
Hkd: 'HKD',
|
|
4578
|
+
Hnl: 'HNL',
|
|
4579
|
+
Htg: 'HTG',
|
|
4580
|
+
Idr: 'IDR',
|
|
4581
|
+
Ils: 'ILS',
|
|
4582
|
+
Inr: 'INR',
|
|
4583
|
+
Iqd: 'IQD',
|
|
4584
|
+
Irr: 'IRR',
|
|
4585
|
+
Jmd: 'JMD',
|
|
4586
|
+
Jod: 'JOD',
|
|
4587
|
+
Jpy: 'JPY',
|
|
4588
|
+
Kes: 'KES',
|
|
4589
|
+
Kgs: 'KGS',
|
|
4590
|
+
Khr: 'KHR',
|
|
4591
|
+
Kmf: 'KMF',
|
|
4592
|
+
Kpw: 'KPW',
|
|
4593
|
+
Krw: 'KRW',
|
|
4594
|
+
Kwd: 'KWD',
|
|
4595
|
+
Kyd: 'KYD',
|
|
4596
|
+
Kzt: 'KZT',
|
|
4597
|
+
Lak: 'LAK',
|
|
4598
|
+
Lbp: 'LBP',
|
|
4599
|
+
Lkr: 'LKR',
|
|
4600
|
+
Lrd: 'LRD',
|
|
4601
|
+
Lsl: 'LSL',
|
|
4602
|
+
Lyd: 'LYD',
|
|
4603
|
+
Mad: 'MAD',
|
|
4604
|
+
Mga: 'MGA',
|
|
4605
|
+
Mmk: 'MMK',
|
|
4606
|
+
Mnt: 'MNT',
|
|
4607
|
+
Mop: 'MOP',
|
|
4608
|
+
Mru: 'MRU',
|
|
4609
|
+
Mur: 'MUR',
|
|
4610
|
+
Mvr: 'MVR',
|
|
4611
|
+
Mwk: 'MWK',
|
|
4612
|
+
Mxn: 'MXN',
|
|
4613
|
+
Myr: 'MYR',
|
|
4614
|
+
Mzn: 'MZN',
|
|
4615
|
+
Nad: 'NAD',
|
|
4616
|
+
Ngn: 'NGN',
|
|
4617
|
+
Nio: 'NIO',
|
|
4618
|
+
Npr: 'NPR',
|
|
4619
|
+
Nzd: 'NZD',
|
|
4620
|
+
Omr: 'OMR',
|
|
4621
|
+
Pab: 'PAB',
|
|
4622
|
+
Pen: 'PEN',
|
|
4623
|
+
Pgk: 'PGK',
|
|
4624
|
+
Php: 'PHP',
|
|
4625
|
+
Pkr: 'PKR',
|
|
4626
|
+
Pyg: 'PYG',
|
|
4627
|
+
Qar: 'QAR',
|
|
4628
|
+
Rwf: 'RWF',
|
|
4629
|
+
Sar: 'SAR',
|
|
4630
|
+
Sbd: 'SBD',
|
|
4631
|
+
Scr: 'SCR',
|
|
4632
|
+
Sdg: 'SDG',
|
|
4633
|
+
Sgd: 'SGD',
|
|
4634
|
+
Shp: 'SHP',
|
|
4635
|
+
Sle: 'SLE',
|
|
4636
|
+
Sos: 'SOS',
|
|
4637
|
+
Srd: 'SRD',
|
|
4638
|
+
Ssp: 'SSP',
|
|
4639
|
+
Stn: 'STN',
|
|
4640
|
+
Svc: 'SVC',
|
|
4641
|
+
Syp: 'SYP',
|
|
4642
|
+
Szl: 'SZL',
|
|
4643
|
+
Thb: 'THB',
|
|
4644
|
+
Tjs: 'TJS',
|
|
4645
|
+
Tmt: 'TMT',
|
|
4646
|
+
Tnd: 'TND',
|
|
4647
|
+
Top: 'TOP',
|
|
4648
|
+
Ttd: 'TTD',
|
|
4649
|
+
Twd: 'TWD',
|
|
4650
|
+
Tzs: 'TZS',
|
|
4651
|
+
Ugx: 'UGX',
|
|
4652
|
+
Uyu: 'UYU',
|
|
4653
|
+
Uzs: 'UZS',
|
|
4654
|
+
Ved: 'VED',
|
|
4655
|
+
Ves: 'VES',
|
|
4656
|
+
Vnd: 'VND',
|
|
4657
|
+
Vuv: 'VUV',
|
|
4658
|
+
Wst: 'WST',
|
|
4659
|
+
Xaf: 'XAF',
|
|
4660
|
+
Xcd: 'XCD',
|
|
4661
|
+
Xcg: 'XCG',
|
|
4662
|
+
Xof: 'XOF',
|
|
4663
|
+
Xpf: 'XPF',
|
|
4664
|
+
Yer: 'YER',
|
|
4665
|
+
Zar: 'ZAR',
|
|
4666
|
+
Zmw: 'ZMW',
|
|
4667
|
+
Zwg: 'ZWG'
|
|
4464
4668
|
} as const;
|
|
4465
4669
|
|
|
4466
4670
|
export type CurrencyCode = typeof CurrencyCode[keyof typeof CurrencyCode];
|
|
@@ -6268,13 +6472,13 @@ export interface EpassiCredentialsSavedDto {
|
|
|
6268
6472
|
*/
|
|
6269
6473
|
'accessKeyEnding': string;
|
|
6270
6474
|
/**
|
|
6271
|
-
*
|
|
6475
|
+
* 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.
|
|
6272
6476
|
* @type {string}
|
|
6273
6477
|
* @memberof EpassiCredentialsSavedDto
|
|
6274
6478
|
*/
|
|
6275
6479
|
'publicKey': string;
|
|
6276
6480
|
/**
|
|
6277
|
-
*
|
|
6481
|
+
* 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.
|
|
6278
6482
|
* @type {boolean}
|
|
6279
6483
|
* @memberof EpassiCredentialsSavedDto
|
|
6280
6484
|
*/
|
|
@@ -6697,6 +6901,18 @@ export interface ExternalBusinessConfigDto {
|
|
|
6697
6901
|
* @memberof ExternalBusinessConfigDto
|
|
6698
6902
|
*/
|
|
6699
6903
|
'currency': CurrencyCode;
|
|
6904
|
+
/**
|
|
6905
|
+
* 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
|
|
6906
|
+
* @type {string}
|
|
6907
|
+
* @memberof ExternalBusinessConfigDto
|
|
6908
|
+
*/
|
|
6909
|
+
'countryCode'?: string | null;
|
|
6910
|
+
/**
|
|
6911
|
+
* 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
|
|
6912
|
+
* @type {string}
|
|
6913
|
+
* @memberof ExternalBusinessConfigDto
|
|
6914
|
+
*/
|
|
6915
|
+
'locale'?: string | null;
|
|
6700
6916
|
/**
|
|
6701
6917
|
*
|
|
6702
6918
|
* @type {PaymentProvider}
|
|
@@ -6863,6 +7079,18 @@ export interface ExternalBusinessConfigResponseDtoConfig {
|
|
|
6863
7079
|
* @memberof ExternalBusinessConfigResponseDtoConfig
|
|
6864
7080
|
*/
|
|
6865
7081
|
'currency': CurrencyCode;
|
|
7082
|
+
/**
|
|
7083
|
+
* 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
|
|
7084
|
+
* @type {string}
|
|
7085
|
+
* @memberof ExternalBusinessConfigResponseDtoConfig
|
|
7086
|
+
*/
|
|
7087
|
+
'countryCode'?: string | null;
|
|
7088
|
+
/**
|
|
7089
|
+
* 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
|
|
7090
|
+
* @type {string}
|
|
7091
|
+
* @memberof ExternalBusinessConfigResponseDtoConfig
|
|
7092
|
+
*/
|
|
7093
|
+
'locale'?: string | null;
|
|
6866
7094
|
/**
|
|
6867
7095
|
*
|
|
6868
7096
|
* @type {PaymentProvider}
|
|
@@ -7468,13 +7696,13 @@ export interface GiftCardInfoDto {
|
|
|
7468
7696
|
*/
|
|
7469
7697
|
'title': string;
|
|
7470
7698
|
/**
|
|
7471
|
-
* What is left on the card, in euros
|
|
7699
|
+
* What is left on the card, in units of its currency (euros for EUR, not cents)
|
|
7472
7700
|
* @type {number}
|
|
7473
7701
|
* @memberof GiftCardInfoDto
|
|
7474
7702
|
*/
|
|
7475
7703
|
'balance': number;
|
|
7476
7704
|
/**
|
|
7477
|
-
* The card\'s currency code;
|
|
7705
|
+
* The card\'s currency code; the venue\'s currency when Luckiefun sends none
|
|
7478
7706
|
* @type {string}
|
|
7479
7707
|
* @memberof GiftCardInfoDto
|
|
7480
7708
|
*/
|
|
@@ -8376,6 +8604,21 @@ export const KDSEVENTNAME = {
|
|
|
8376
8604
|
export type KDSEVENTNAME = typeof KDSEVENTNAME[keyof typeof KDSEVENTNAME];
|
|
8377
8605
|
|
|
8378
8606
|
|
|
8607
|
+
/**
|
|
8608
|
+
*
|
|
8609
|
+
* @export
|
|
8610
|
+
* @enum {string}
|
|
8611
|
+
*/
|
|
8612
|
+
|
|
8613
|
+
export const KdsBulkReadySkipReason = {
|
|
8614
|
+
Found: 'NOT_FOUND',
|
|
8615
|
+
Pos: 'NOT_POS',
|
|
8616
|
+
InProgress: 'NOT_IN_PROGRESS'
|
|
8617
|
+
} as const;
|
|
8618
|
+
|
|
8619
|
+
export type KdsBulkReadySkipReason = typeof KdsBulkReadySkipReason[keyof typeof KdsBulkReadySkipReason];
|
|
8620
|
+
|
|
8621
|
+
|
|
8379
8622
|
/**
|
|
8380
8623
|
*
|
|
8381
8624
|
* @export
|
|
@@ -8582,6 +8825,31 @@ export interface KdsLocationDtoCoordinates {
|
|
|
8582
8825
|
*/
|
|
8583
8826
|
'lon': number | null;
|
|
8584
8827
|
}
|
|
8828
|
+
/**
|
|
8829
|
+
*
|
|
8830
|
+
* @export
|
|
8831
|
+
* @interface KdsMarkOrdersReadyDto
|
|
8832
|
+
*/
|
|
8833
|
+
export interface KdsMarkOrdersReadyDto {
|
|
8834
|
+
/**
|
|
8835
|
+
* The venue\'s orderingBusinessId
|
|
8836
|
+
* @type {number}
|
|
8837
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8838
|
+
*/
|
|
8839
|
+
'businessId': number;
|
|
8840
|
+
/**
|
|
8841
|
+
* The id of the station (KDS profile) whose orders are marked ready
|
|
8842
|
+
* @type {string}
|
|
8843
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8844
|
+
*/
|
|
8845
|
+
'profileId': string;
|
|
8846
|
+
/**
|
|
8847
|
+
* The KDS orders\' ids in kds-service, each once, 1 to 100 of them
|
|
8848
|
+
* @type {Array<string>}
|
|
8849
|
+
* @memberof KdsMarkOrdersReadyDto
|
|
8850
|
+
*/
|
|
8851
|
+
'orderIds': Array<string>;
|
|
8852
|
+
}
|
|
8585
8853
|
/**
|
|
8586
8854
|
*
|
|
8587
8855
|
* @export
|
|
@@ -8962,6 +9230,27 @@ export interface KdsOrderItemDto {
|
|
|
8962
9230
|
}
|
|
8963
9231
|
|
|
8964
9232
|
|
|
9233
|
+
/**
|
|
9234
|
+
*
|
|
9235
|
+
* @export
|
|
9236
|
+
* @interface KdsOrderLeftAsItIsDto
|
|
9237
|
+
*/
|
|
9238
|
+
export interface KdsOrderLeftAsItIsDto {
|
|
9239
|
+
/**
|
|
9240
|
+
* The id of a KDS order kds-service did not mark ready
|
|
9241
|
+
* @type {string}
|
|
9242
|
+
* @memberof KdsOrderLeftAsItIsDto
|
|
9243
|
+
*/
|
|
9244
|
+
'orderId': string;
|
|
9245
|
+
/**
|
|
9246
|
+
*
|
|
9247
|
+
* @type {KdsBulkReadySkipReason}
|
|
9248
|
+
* @memberof KdsOrderLeftAsItIsDto
|
|
9249
|
+
*/
|
|
9250
|
+
'reason': KdsBulkReadySkipReason;
|
|
9251
|
+
}
|
|
9252
|
+
|
|
9253
|
+
|
|
8965
9254
|
/**
|
|
8966
9255
|
*
|
|
8967
9256
|
* @export
|
|
@@ -9730,6 +10019,43 @@ export interface KdsReadyOrderResponseDtoOrder {
|
|
|
9730
10019
|
}
|
|
9731
10020
|
|
|
9732
10021
|
|
|
10022
|
+
/**
|
|
10023
|
+
*
|
|
10024
|
+
* @export
|
|
10025
|
+
* @interface KdsReadyOrdersResponseDto
|
|
10026
|
+
*/
|
|
10027
|
+
export interface KdsReadyOrdersResponseDto {
|
|
10028
|
+
/**
|
|
10029
|
+
* The ids of the KDS orders marked ready; empty when none were
|
|
10030
|
+
* @type {Array<string>}
|
|
10031
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
10032
|
+
*/
|
|
10033
|
+
'ready': Array<string>;
|
|
10034
|
+
/**
|
|
10035
|
+
* The ids kds-service left as they are, each with its reason; empty when none were
|
|
10036
|
+
* @type {Array<KdsOrderLeftAsItIsDto>}
|
|
10037
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
10038
|
+
*/
|
|
10039
|
+
'skipped': Array<KdsOrderLeftAsItIsDto>;
|
|
10040
|
+
/**
|
|
10041
|
+
* 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
|
|
10042
|
+
* @type {Array<string>}
|
|
10043
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
10044
|
+
*/
|
|
10045
|
+
'notAnnounced'?: Array<string>;
|
|
10046
|
+
/**
|
|
10047
|
+
* true when kds-service answered; false when it refused or could not be reached, and then nothing is listed
|
|
10048
|
+
* @type {boolean}
|
|
10049
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
10050
|
+
*/
|
|
10051
|
+
'status': boolean;
|
|
10052
|
+
/**
|
|
10053
|
+
* Human-readable status message
|
|
10054
|
+
* @type {string}
|
|
10055
|
+
* @memberof KdsReadyOrdersResponseDto
|
|
10056
|
+
*/
|
|
10057
|
+
'message': string;
|
|
10058
|
+
}
|
|
9733
10059
|
/**
|
|
9734
10060
|
*
|
|
9735
10061
|
* @export
|
|
@@ -13399,6 +13725,12 @@ export interface OrderHistoryPosResponseDtoV2Summary {
|
|
|
13399
13725
|
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
13400
13726
|
*/
|
|
13401
13727
|
'totalTipAmount'?: number;
|
|
13728
|
+
/**
|
|
13729
|
+
* 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.
|
|
13730
|
+
* @type {{ [key: string]: number; }}
|
|
13731
|
+
* @memberof OrderHistoryPosResponseDtoV2Summary
|
|
13732
|
+
*/
|
|
13733
|
+
'totalsByCurrency'?: { [key: string]: number; };
|
|
13402
13734
|
}
|
|
13403
13735
|
/**
|
|
13404
13736
|
*
|
|
@@ -17764,6 +18096,36 @@ export interface PosActionPasscodeDto {
|
|
|
17764
18096
|
*/
|
|
17765
18097
|
'pinHash': string;
|
|
17766
18098
|
}
|
|
18099
|
+
/**
|
|
18100
|
+
*
|
|
18101
|
+
* @export
|
|
18102
|
+
* @enum {string}
|
|
18103
|
+
*/
|
|
18104
|
+
|
|
18105
|
+
export const PosBulkOrderStatus = {
|
|
18106
|
+
Ready: 'ready',
|
|
18107
|
+
Delivered: 'delivered'
|
|
18108
|
+
} as const;
|
|
18109
|
+
|
|
18110
|
+
export type PosBulkOrderStatus = typeof PosBulkOrderStatus[keyof typeof PosBulkOrderStatus];
|
|
18111
|
+
|
|
18112
|
+
|
|
18113
|
+
/**
|
|
18114
|
+
*
|
|
18115
|
+
* @export
|
|
18116
|
+
* @enum {string}
|
|
18117
|
+
*/
|
|
18118
|
+
|
|
18119
|
+
export const PosBulkStatusSkipReason = {
|
|
18120
|
+
NotFound: 'NOT_FOUND',
|
|
18121
|
+
NotInProgress: 'NOT_IN_PROGRESS',
|
|
18122
|
+
KitchenControlled: 'KITCHEN_CONTROLLED',
|
|
18123
|
+
NotReady: 'NOT_READY'
|
|
18124
|
+
} as const;
|
|
18125
|
+
|
|
18126
|
+
export type PosBulkStatusSkipReason = typeof PosBulkStatusSkipReason[keyof typeof PosBulkStatusSkipReason];
|
|
18127
|
+
|
|
18128
|
+
|
|
17767
18129
|
/**
|
|
17768
18130
|
*
|
|
17769
18131
|
* @export
|
|
@@ -19986,6 +20348,27 @@ export interface PosOrderItemSplitSeatDto {
|
|
|
19986
20348
|
*/
|
|
19987
20349
|
'assignments': Array<PosOrderItemSplitSeatAssignmentDto>;
|
|
19988
20350
|
}
|
|
20351
|
+
/**
|
|
20352
|
+
*
|
|
20353
|
+
* @export
|
|
20354
|
+
* @interface PosOrderLeftAsItIsDto
|
|
20355
|
+
*/
|
|
20356
|
+
export interface PosOrderLeftAsItIsDto {
|
|
20357
|
+
/**
|
|
20358
|
+
* The id the till sent of a ticket or an order that was not moved
|
|
20359
|
+
* @type {string}
|
|
20360
|
+
* @memberof PosOrderLeftAsItIsDto
|
|
20361
|
+
*/
|
|
20362
|
+
'orderId': string;
|
|
20363
|
+
/**
|
|
20364
|
+
*
|
|
20365
|
+
* @type {PosBulkStatusSkipReason}
|
|
20366
|
+
* @memberof PosOrderLeftAsItIsDto
|
|
20367
|
+
*/
|
|
20368
|
+
'reason': PosBulkStatusSkipReason;
|
|
20369
|
+
}
|
|
20370
|
+
|
|
20371
|
+
|
|
19989
20372
|
/**
|
|
19990
20373
|
*
|
|
19991
20374
|
* @export
|
|
@@ -20091,6 +20474,49 @@ export interface PosOrderSuboptionDto {
|
|
|
20091
20474
|
*/
|
|
20092
20475
|
'value_pos_id': string | null;
|
|
20093
20476
|
}
|
|
20477
|
+
/**
|
|
20478
|
+
*
|
|
20479
|
+
* @export
|
|
20480
|
+
* @interface PosOrderSummaryDto
|
|
20481
|
+
*/
|
|
20482
|
+
export interface PosOrderSummaryDto {
|
|
20483
|
+
/**
|
|
20484
|
+
* 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.
|
|
20485
|
+
* @type {number}
|
|
20486
|
+
* @memberof PosOrderSummaryDto
|
|
20487
|
+
*/
|
|
20488
|
+
'totalOrders': number;
|
|
20489
|
+
/**
|
|
20490
|
+
* 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.
|
|
20491
|
+
* @type {number}
|
|
20492
|
+
* @memberof PosOrderSummaryDto
|
|
20493
|
+
*/
|
|
20494
|
+
'rejectedOrders': number;
|
|
20495
|
+
/**
|
|
20496
|
+
* 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.
|
|
20497
|
+
* @type {number}
|
|
20498
|
+
* @memberof PosOrderSummaryDto
|
|
20499
|
+
*/
|
|
20500
|
+
'totalSales': number;
|
|
20501
|
+
/**
|
|
20502
|
+
* 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.
|
|
20503
|
+
* @type {number}
|
|
20504
|
+
* @memberof PosOrderSummaryDto
|
|
20505
|
+
*/
|
|
20506
|
+
'rejectedSales': number;
|
|
20507
|
+
/**
|
|
20508
|
+
* POS history only: the tips of the orders on this page, in cents. Absent from the online history.
|
|
20509
|
+
* @type {number}
|
|
20510
|
+
* @memberof PosOrderSummaryDto
|
|
20511
|
+
*/
|
|
20512
|
+
'totalTipAmount'?: number;
|
|
20513
|
+
/**
|
|
20514
|
+
* 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.
|
|
20515
|
+
* @type {{ [key: string]: number; }}
|
|
20516
|
+
* @memberof PosOrderSummaryDto
|
|
20517
|
+
*/
|
|
20518
|
+
'totalsByCurrency'?: { [key: string]: number; };
|
|
20519
|
+
}
|
|
20094
20520
|
/**
|
|
20095
20521
|
*
|
|
20096
20522
|
* @export
|
|
@@ -22751,13 +23177,13 @@ export interface RedeemGiftCardResponseDto {
|
|
|
22751
23177
|
*/
|
|
22752
23178
|
'redeemedAmount'?: number;
|
|
22753
23179
|
/**
|
|
22754
|
-
* On success: what is left on the card, in euros
|
|
23180
|
+
* 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
|
|
22755
23181
|
* @type {number}
|
|
22756
23182
|
* @memberof RedeemGiftCardResponseDto
|
|
22757
23183
|
*/
|
|
22758
23184
|
'remainingBalance'?: number;
|
|
22759
23185
|
/**
|
|
22760
|
-
* On success: the card\'s currency code;
|
|
23186
|
+
* On success: the card\'s currency code; the venue\'s currency when the provider does not say
|
|
22761
23187
|
* @type {string}
|
|
22762
23188
|
* @memberof RedeemGiftCardResponseDto
|
|
22763
23189
|
*/
|
|
@@ -23259,6 +23685,87 @@ export interface RejectOrderDto {
|
|
|
23259
23685
|
}
|
|
23260
23686
|
|
|
23261
23687
|
|
|
23688
|
+
/**
|
|
23689
|
+
*
|
|
23690
|
+
* @export
|
|
23691
|
+
* @enum {string}
|
|
23692
|
+
*/
|
|
23693
|
+
|
|
23694
|
+
export const ReportApp = {
|
|
23695
|
+
Pos: 'pos',
|
|
23696
|
+
Kiosk: 'kiosk',
|
|
23697
|
+
Storefront: 'storefront',
|
|
23698
|
+
Mobile: 'mobile'
|
|
23699
|
+
} as const;
|
|
23700
|
+
|
|
23701
|
+
export type ReportApp = typeof ReportApp[keyof typeof ReportApp];
|
|
23702
|
+
|
|
23703
|
+
|
|
23704
|
+
/**
|
|
23705
|
+
*
|
|
23706
|
+
* @export
|
|
23707
|
+
* @enum {string}
|
|
23708
|
+
*/
|
|
23709
|
+
|
|
23710
|
+
export const ReportBaselineLeftOut = {
|
|
23711
|
+
IsTheBaseline: 'is_the_baseline',
|
|
23712
|
+
OtherCurrency: 'other_currency'
|
|
23713
|
+
} as const;
|
|
23714
|
+
|
|
23715
|
+
export type ReportBaselineLeftOut = typeof ReportBaselineLeftOut[keyof typeof ReportBaselineLeftOut];
|
|
23716
|
+
|
|
23717
|
+
|
|
23718
|
+
/**
|
|
23719
|
+
*
|
|
23720
|
+
* @export
|
|
23721
|
+
* @enum {string}
|
|
23722
|
+
*/
|
|
23723
|
+
|
|
23724
|
+
export const ReportBreakdown = {
|
|
23725
|
+
None: 'none',
|
|
23726
|
+
Venue: 'venue',
|
|
23727
|
+
App: 'app',
|
|
23728
|
+
VenueApp: 'venue_app'
|
|
23729
|
+
} as const;
|
|
23730
|
+
|
|
23731
|
+
export type ReportBreakdown = typeof ReportBreakdown[keyof typeof ReportBreakdown];
|
|
23732
|
+
|
|
23733
|
+
|
|
23734
|
+
/**
|
|
23735
|
+
*
|
|
23736
|
+
* @export
|
|
23737
|
+
* @enum {string}
|
|
23738
|
+
*/
|
|
23739
|
+
|
|
23740
|
+
export const ReportChangeField = {
|
|
23741
|
+
SalesReportTotalQuantity: 'salesReport.totalQuantity',
|
|
23742
|
+
SalesReportTotalWithTax: 'salesReport.totalWithTax',
|
|
23743
|
+
SalesReportTotalTaxAmount: 'salesReport.totalTaxAmount',
|
|
23744
|
+
SalesReportTotalWithoutTax: 'salesReport.totalWithoutTax',
|
|
23745
|
+
SalesReportDeliveryFee: 'salesReport.deliveryFee',
|
|
23746
|
+
SalesReportDeliveryTax: 'salesReport.deliveryTax',
|
|
23747
|
+
PaymentReportSummarySalesAndRevenue: 'paymentReport.summary.salesAndRevenue',
|
|
23748
|
+
PaymentReportSummaryGrossAmount: 'paymentReport.summary.grossAmount',
|
|
23749
|
+
PaymentReportSummaryTotalCount: 'paymentReport.summary.totalCount',
|
|
23750
|
+
PaymentReportSummaryTotalAmount: 'paymentReport.summary.totalAmount',
|
|
23751
|
+
PaymentReportSummaryCardsCount: 'paymentReport.summary.cardsCount',
|
|
23752
|
+
PaymentReportSummaryCardsAmount: 'paymentReport.summary.cardsAmount',
|
|
23753
|
+
PaymentReportSummaryEdenredVoucherCount: 'paymentReport.summary.edenredVoucherCount',
|
|
23754
|
+
PaymentReportSummaryEdenredVoucherAmount: 'paymentReport.summary.edenredVoucherAmount',
|
|
23755
|
+
PaymentReportSummarySmartumVoucherCount: 'paymentReport.summary.smartumVoucherCount',
|
|
23756
|
+
PaymentReportSummarySmartumVoucherAmount: 'paymentReport.summary.smartumVoucherAmount',
|
|
23757
|
+
PaymentReportSummaryTotalCoupons: 'paymentReport.summary.totalCoupons',
|
|
23758
|
+
PaymentReportSummaryTotalVoucherForfeited: 'paymentReport.summary.totalVoucherForfeited',
|
|
23759
|
+
PaymentReportSummaryTotalTipAmount: 'paymentReport.summary.totalTipAmount',
|
|
23760
|
+
PaymentReportSummaryTotalSurchargeAmount: 'paymentReport.summary.totalSurchargeAmount',
|
|
23761
|
+
PaymentReportSummaryTotalRefunds: 'paymentReport.summary.totalRefunds',
|
|
23762
|
+
PaymentReportSummaryRefundCount: 'paymentReport.summary.refundCount',
|
|
23763
|
+
PaymentReportTotalDiscounts: 'paymentReport.totalDiscounts'
|
|
23764
|
+
} as const;
|
|
23765
|
+
|
|
23766
|
+
export type ReportChangeField = typeof ReportChangeField[keyof typeof ReportChangeField];
|
|
23767
|
+
|
|
23768
|
+
|
|
23262
23769
|
/**
|
|
23263
23770
|
*
|
|
23264
23771
|
* @export
|
|
@@ -23273,6 +23780,23 @@ export const ReportLanguage = {
|
|
|
23273
23780
|
export type ReportLanguage = typeof ReportLanguage[keyof typeof ReportLanguage];
|
|
23274
23781
|
|
|
23275
23782
|
|
|
23783
|
+
/**
|
|
23784
|
+
*
|
|
23785
|
+
* @export
|
|
23786
|
+
* @enum {string}
|
|
23787
|
+
*/
|
|
23788
|
+
|
|
23789
|
+
export const ReportPart = {
|
|
23790
|
+
Summary: 'summary',
|
|
23791
|
+
Items: 'items',
|
|
23792
|
+
Vat: 'vat',
|
|
23793
|
+
Payments: 'payments',
|
|
23794
|
+
Discounts: 'discounts'
|
|
23795
|
+
} as const;
|
|
23796
|
+
|
|
23797
|
+
export type ReportPart = typeof ReportPart[keyof typeof ReportPart];
|
|
23798
|
+
|
|
23799
|
+
|
|
23276
23800
|
/**
|
|
23277
23801
|
*
|
|
23278
23802
|
* @export
|
|
@@ -23543,261 +24067,1275 @@ export interface ReservationResponseDto {
|
|
|
23543
24067
|
* @type {string}
|
|
23544
24068
|
* @memberof ReservationResponseDto
|
|
23545
24069
|
*/
|
|
23546
|
-
'cancelledAt': string | null;
|
|
24070
|
+
'cancelledAt': string | null;
|
|
24071
|
+
/**
|
|
24072
|
+
* When the booking was stored
|
|
24073
|
+
* @type {string}
|
|
24074
|
+
* @memberof ReservationResponseDto
|
|
24075
|
+
*/
|
|
24076
|
+
'createdAt': string;
|
|
24077
|
+
/**
|
|
24078
|
+
* When the booking last changed
|
|
24079
|
+
* @type {string}
|
|
24080
|
+
* @memberof ReservationResponseDto
|
|
24081
|
+
*/
|
|
24082
|
+
'updatedAt': string;
|
|
24083
|
+
}
|
|
24084
|
+
|
|
24085
|
+
|
|
24086
|
+
/**
|
|
24087
|
+
*
|
|
24088
|
+
* @export
|
|
24089
|
+
* @enum {string}
|
|
24090
|
+
*/
|
|
24091
|
+
|
|
24092
|
+
export const ReservationSource = {
|
|
24093
|
+
WalkIn: 'WALK_IN',
|
|
24094
|
+
Pos: 'POS',
|
|
24095
|
+
ReservationsApp: 'RESERVATIONS_APP',
|
|
24096
|
+
OnlineWidget: 'ONLINE_WIDGET',
|
|
24097
|
+
Phone: 'PHONE'
|
|
24098
|
+
} as const;
|
|
24099
|
+
|
|
24100
|
+
export type ReservationSource = typeof ReservationSource[keyof typeof ReservationSource];
|
|
24101
|
+
|
|
24102
|
+
|
|
24103
|
+
/**
|
|
24104
|
+
*
|
|
24105
|
+
* @export
|
|
24106
|
+
* @enum {string}
|
|
24107
|
+
*/
|
|
24108
|
+
|
|
24109
|
+
export const ReservationStatus = {
|
|
24110
|
+
Requested: 'REQUESTED',
|
|
24111
|
+
Confirmed: 'CONFIRMED',
|
|
24112
|
+
Waitlist: 'WAITLIST',
|
|
24113
|
+
Seated: 'SEATED',
|
|
24114
|
+
NoShow: 'NO_SHOW',
|
|
24115
|
+
Completed: 'COMPLETED',
|
|
24116
|
+
Cancelled: 'CANCELLED'
|
|
24117
|
+
} as const;
|
|
24118
|
+
|
|
24119
|
+
export type ReservationStatus = typeof ReservationStatus[keyof typeof ReservationStatus];
|
|
24120
|
+
|
|
24121
|
+
|
|
24122
|
+
/**
|
|
24123
|
+
*
|
|
24124
|
+
* @export
|
|
24125
|
+
* @interface ResetEodDto
|
|
24126
|
+
*/
|
|
24127
|
+
export interface ResetEodDto {
|
|
24128
|
+
/**
|
|
24129
|
+
* The id of the venue\'s end-of-day reset, as the Cloud Task carries it
|
|
24130
|
+
* @type {string}
|
|
24131
|
+
* @memberof ResetEodDto
|
|
24132
|
+
*/
|
|
24133
|
+
'bindingId': string;
|
|
24134
|
+
}
|
|
24135
|
+
/**
|
|
24136
|
+
*
|
|
24137
|
+
* @export
|
|
24138
|
+
* @interface ResolveChoiceDto
|
|
24139
|
+
*/
|
|
24140
|
+
export interface ResolveChoiceDto {
|
|
24141
|
+
/**
|
|
24142
|
+
* The originalPaymentEventId of the payment source chosen by the user.
|
|
24143
|
+
* @type {string}
|
|
24144
|
+
* @memberof ResolveChoiceDto
|
|
24145
|
+
*/
|
|
24146
|
+
'chosenPaymentEventId': string;
|
|
24147
|
+
}
|
|
24148
|
+
/**
|
|
24149
|
+
*
|
|
24150
|
+
* @export
|
|
24151
|
+
* @interface ResolvedPerkDto
|
|
24152
|
+
*/
|
|
24153
|
+
export interface ResolvedPerkDto {
|
|
24154
|
+
/**
|
|
24155
|
+
* Wallet item ID (null for unclaimed catalog items)
|
|
24156
|
+
* @type {object}
|
|
24157
|
+
* @memberof ResolvedPerkDto
|
|
24158
|
+
*/
|
|
24159
|
+
'walletId': object | null;
|
|
24160
|
+
/**
|
|
24161
|
+
* Catalog ID
|
|
24162
|
+
* @type {object}
|
|
24163
|
+
* @memberof ResolvedPerkDto
|
|
24164
|
+
*/
|
|
24165
|
+
'catalogId': object | null;
|
|
24166
|
+
/**
|
|
24167
|
+
* The perk\'s name
|
|
24168
|
+
* @type {string}
|
|
24169
|
+
* @memberof ResolvedPerkDto
|
|
24170
|
+
*/
|
|
24171
|
+
'name': string;
|
|
24172
|
+
/**
|
|
24173
|
+
*
|
|
24174
|
+
* @type {LoyaltyPerkStatus}
|
|
24175
|
+
* @memberof ResolvedPerkDto
|
|
24176
|
+
*/
|
|
24177
|
+
'walletStatus': LoyaltyPerkStatus;
|
|
24178
|
+
/**
|
|
24179
|
+
* Whether the perk applies to this cart
|
|
24180
|
+
* @type {boolean}
|
|
24181
|
+
* @memberof ResolvedPerkDto
|
|
24182
|
+
*/
|
|
24183
|
+
'applicable': boolean;
|
|
24184
|
+
/**
|
|
24185
|
+
* False while AI validation is pending
|
|
24186
|
+
* @type {boolean}
|
|
24187
|
+
* @memberof ResolvedPerkDto
|
|
24188
|
+
*/
|
|
24189
|
+
'resolved': boolean;
|
|
24190
|
+
/**
|
|
24191
|
+
*
|
|
24192
|
+
* @type {PromotionDiscountType}
|
|
24193
|
+
* @memberof ResolvedPerkDto
|
|
24194
|
+
*/
|
|
24195
|
+
'discountType': PromotionDiscountType | null;
|
|
24196
|
+
/**
|
|
24197
|
+
* 0 to 100 for PERCENTAGE, cents for FIXED; null when the perk does not apply
|
|
24198
|
+
* @type {object}
|
|
24199
|
+
* @memberof ResolvedPerkDto
|
|
24200
|
+
*/
|
|
24201
|
+
'discountValue': object | null;
|
|
24202
|
+
/**
|
|
24203
|
+
*
|
|
24204
|
+
* @type {DiscountScope}
|
|
24205
|
+
* @memberof ResolvedPerkDto
|
|
24206
|
+
*/
|
|
24207
|
+
'scope': DiscountScope | null;
|
|
24208
|
+
/**
|
|
24209
|
+
* The cart line an ITEM perk applies to; null otherwise
|
|
24210
|
+
* @type {object}
|
|
24211
|
+
* @memberof ResolvedPerkDto
|
|
24212
|
+
*/
|
|
24213
|
+
'targetLineItemId': object | null;
|
|
24214
|
+
}
|
|
24215
|
+
|
|
24216
|
+
|
|
24217
|
+
/**
|
|
24218
|
+
*
|
|
24219
|
+
* @export
|
|
24220
|
+
* @interface RestoreLoyaltyRedemptionDto
|
|
24221
|
+
*/
|
|
24222
|
+
export interface RestoreLoyaltyRedemptionDto {
|
|
24223
|
+
/**
|
|
24224
|
+
* The venue (business id) the order belongs to; it must be on the ticket\'s account
|
|
24225
|
+
* @type {number}
|
|
24226
|
+
* @memberof RestoreLoyaltyRedemptionDto
|
|
24227
|
+
*/
|
|
24228
|
+
'businessId': number;
|
|
24229
|
+
/**
|
|
24230
|
+
* The id of the POS or kiosk order that carries the redemption
|
|
24231
|
+
* @type {string}
|
|
24232
|
+
* @memberof RestoreLoyaltyRedemptionDto
|
|
24233
|
+
*/
|
|
24234
|
+
'orderId': string;
|
|
24235
|
+
/**
|
|
24236
|
+
* The loyalty entry to restore: the key of the redemption in the order\'s loyalty.redemptions
|
|
24237
|
+
* @type {string}
|
|
24238
|
+
* @memberof RestoreLoyaltyRedemptionDto
|
|
24239
|
+
*/
|
|
24240
|
+
'loyaltyEntryId': string;
|
|
24241
|
+
}
|
|
24242
|
+
/**
|
|
24243
|
+
*
|
|
24244
|
+
* @export
|
|
24245
|
+
* @interface RestoreLoyaltyRedemptionResponseDto
|
|
24246
|
+
*/
|
|
24247
|
+
export interface RestoreLoyaltyRedemptionResponseDto {
|
|
24248
|
+
/**
|
|
24249
|
+
*
|
|
24250
|
+
* @type {LoyaltyRestoreRequestStatus}
|
|
24251
|
+
* @memberof RestoreLoyaltyRedemptionResponseDto
|
|
24252
|
+
*/
|
|
24253
|
+
'status': LoyaltyRestoreRequestStatus;
|
|
24254
|
+
/**
|
|
24255
|
+
* Loyalty transaction the restore was asked against
|
|
24256
|
+
* @type {string}
|
|
24257
|
+
* @memberof RestoreLoyaltyRedemptionResponseDto
|
|
24258
|
+
*/
|
|
24259
|
+
'transactionId': string | null;
|
|
24260
|
+
/**
|
|
24261
|
+
* Reversal already recorded against the entry, when there is one; null when the restore was just requested
|
|
24262
|
+
* @type {string}
|
|
24263
|
+
* @memberof RestoreLoyaltyRedemptionResponseDto
|
|
24264
|
+
*/
|
|
24265
|
+
'reversalTransactionId': string | null;
|
|
24266
|
+
}
|
|
24267
|
+
|
|
24268
|
+
|
|
24269
|
+
/**
|
|
24270
|
+
*
|
|
24271
|
+
* @export
|
|
24272
|
+
* @interface RetryWorldlineReversalDto
|
|
24273
|
+
*/
|
|
24274
|
+
export interface RetryWorldlineReversalDto {
|
|
24275
|
+
/**
|
|
24276
|
+
* Session id of the SALE whose reversal was refused and is being asked for again.
|
|
24277
|
+
* @type {string}
|
|
24278
|
+
* @memberof RetryWorldlineReversalDto
|
|
24279
|
+
*/
|
|
24280
|
+
'parentSessionId': string;
|
|
24281
|
+
}
|
|
24282
|
+
/**
|
|
24283
|
+
*
|
|
24284
|
+
* @export
|
|
24285
|
+
* @interface ReverseSessionDto
|
|
24286
|
+
*/
|
|
24287
|
+
export interface ReverseSessionDto {
|
|
24288
|
+
/**
|
|
24289
|
+
* The payment session\'s sessionId (id B) — the same value stored as the order paymentEvent referenceId. Use it to void/refund a recorded payment (the clientToken is only held during the live pay flow).
|
|
24290
|
+
* @type {string}
|
|
24291
|
+
* @memberof ReverseSessionDto
|
|
24292
|
+
*/
|
|
24293
|
+
'sessionId': string;
|
|
24294
|
+
/**
|
|
24295
|
+
* Amount to refund in cents for a partial / item refund. Must be > 0 and <= the session\'s paid amount. Omit to refund the full session amount.
|
|
24296
|
+
* @type {number}
|
|
24297
|
+
* @memberof ReverseSessionDto
|
|
24298
|
+
*/
|
|
24299
|
+
'amount'?: number;
|
|
24300
|
+
}
|
|
24301
|
+
/**
|
|
24302
|
+
*
|
|
24303
|
+
* @export
|
|
24304
|
+
* @enum {string}
|
|
24305
|
+
*/
|
|
24306
|
+
|
|
24307
|
+
export const SYNCKEY = {
|
|
24308
|
+
Menu: 'MENU',
|
|
24309
|
+
Products: 'PRODUCTS',
|
|
24310
|
+
Discounts: 'DISCOUNTS',
|
|
24311
|
+
LoyaltySettings: 'LOYALTY_SETTINGS',
|
|
24312
|
+
BusinessConfig: 'BUSINESS_CONFIG',
|
|
24313
|
+
BusinessProviderSupportedIntegrations: 'BUSINESS_PROVIDER_SUPPORTED_INTEGRATIONS',
|
|
24314
|
+
PosSession: 'POS_SESSION',
|
|
24315
|
+
InvoiceCompanies: 'INVOICE_COMPANIES',
|
|
24316
|
+
BusinessTax: 'BUSINESS_TAX',
|
|
24317
|
+
Transaction: 'TRANSACTION',
|
|
24318
|
+
PaymentMethods: 'PAYMENT_METHODS',
|
|
24319
|
+
ReceiptFooter: 'RECEIPT_FOOTER'
|
|
24320
|
+
} as const;
|
|
24321
|
+
|
|
24322
|
+
export type SYNCKEY = typeof SYNCKEY[keyof typeof SYNCKEY];
|
|
24323
|
+
|
|
24324
|
+
|
|
24325
|
+
/**
|
|
24326
|
+
*
|
|
24327
|
+
* @export
|
|
24328
|
+
* @interface SalesReportCategoryDto
|
|
24329
|
+
*/
|
|
24330
|
+
export interface SalesReportCategoryDto {
|
|
24331
|
+
/**
|
|
24332
|
+
* The category\'s name
|
|
24333
|
+
* @type {string}
|
|
24334
|
+
* @memberof SalesReportCategoryDto
|
|
24335
|
+
*/
|
|
24336
|
+
'categoryName': string;
|
|
24337
|
+
/**
|
|
24338
|
+
* How many of its items were sold
|
|
24339
|
+
* @type {number}
|
|
24340
|
+
* @memberof SalesReportCategoryDto
|
|
24341
|
+
*/
|
|
24342
|
+
'totalQuantity': number;
|
|
24343
|
+
/**
|
|
24344
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24345
|
+
* @type {number}
|
|
24346
|
+
* @memberof SalesReportCategoryDto
|
|
24347
|
+
*/
|
|
24348
|
+
'totalWithTax': number;
|
|
24349
|
+
/**
|
|
24350
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24351
|
+
* @type {number}
|
|
24352
|
+
* @memberof SalesReportCategoryDto
|
|
24353
|
+
*/
|
|
24354
|
+
'taxAmount': number;
|
|
24355
|
+
/**
|
|
24356
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24357
|
+
* @type {number}
|
|
24358
|
+
* @memberof SalesReportCategoryDto
|
|
24359
|
+
*/
|
|
24360
|
+
'totalWithoutTax': number;
|
|
24361
|
+
/**
|
|
24362
|
+
* Its items
|
|
24363
|
+
* @type {Array<SalesReportItemDto>}
|
|
24364
|
+
* @memberof SalesReportCategoryDto
|
|
24365
|
+
*/
|
|
24366
|
+
'items': Array<SalesReportItemDto>;
|
|
24367
|
+
}
|
|
24368
|
+
/**
|
|
24369
|
+
*
|
|
24370
|
+
* @export
|
|
24371
|
+
* @interface SalesReportChangeDto
|
|
24372
|
+
*/
|
|
24373
|
+
export interface SalesReportChangeDto {
|
|
24374
|
+
/**
|
|
24375
|
+
*
|
|
24376
|
+
* @type {ReportChangeField}
|
|
24377
|
+
* @memberof SalesReportChangeDto
|
|
24378
|
+
*/
|
|
24379
|
+
'field': ReportChangeField;
|
|
24380
|
+
/**
|
|
24381
|
+
* 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)
|
|
24382
|
+
* @type {number}
|
|
24383
|
+
* @memberof SalesReportChangeDto
|
|
24384
|
+
*/
|
|
24385
|
+
'current': number;
|
|
24386
|
+
/**
|
|
24387
|
+
* 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)
|
|
24388
|
+
* @type {number}
|
|
24389
|
+
* @memberof SalesReportChangeDto
|
|
24390
|
+
*/
|
|
24391
|
+
'previous': number;
|
|
24392
|
+
/**
|
|
24393
|
+
* 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
|
|
24394
|
+
* @type {number}
|
|
24395
|
+
* @memberof SalesReportChangeDto
|
|
24396
|
+
*/
|
|
24397
|
+
'difference': number;
|
|
24398
|
+
/**
|
|
24399
|
+
* difference as a percent of previous, rounded half away from zero to 2 decimals; negative when the total fell. Null when previous is 0
|
|
24400
|
+
* @type {object}
|
|
24401
|
+
* @memberof SalesReportChangeDto
|
|
24402
|
+
*/
|
|
24403
|
+
'percent': object | null;
|
|
24404
|
+
}
|
|
24405
|
+
|
|
24406
|
+
|
|
24407
|
+
/**
|
|
24408
|
+
*
|
|
24409
|
+
* @export
|
|
24410
|
+
* @interface SalesReportComparisonDto
|
|
24411
|
+
*/
|
|
24412
|
+
export interface SalesReportComparisonDto {
|
|
24413
|
+
/**
|
|
24414
|
+
* The first instant of the compared period, ISO 8601 in UTC
|
|
24415
|
+
* @type {string}
|
|
24416
|
+
* @memberof SalesReportComparisonDto
|
|
24417
|
+
*/
|
|
24418
|
+
'reportDateStart': string;
|
|
24419
|
+
/**
|
|
24420
|
+
* The last instant of the compared period, ISO 8601 in UTC; now, when the period ends later
|
|
24421
|
+
* @type {string}
|
|
24422
|
+
* @memberof SalesReportComparisonDto
|
|
24423
|
+
*/
|
|
24424
|
+
'reportDateEnd': string;
|
|
24425
|
+
/**
|
|
24426
|
+
* The first business day compared, YYYY-MM-DD, in the report\'s time zone
|
|
24427
|
+
* @type {string}
|
|
24428
|
+
* @memberof SalesReportComparisonDto
|
|
24429
|
+
*/
|
|
24430
|
+
'firstBusinessDay': string;
|
|
24431
|
+
/**
|
|
24432
|
+
* The last business day compared, YYYY-MM-DD, inclusive
|
|
24433
|
+
* @type {string}
|
|
24434
|
+
* @memberof SalesReportComparisonDto
|
|
24435
|
+
*/
|
|
24436
|
+
'lastBusinessDay': string;
|
|
24437
|
+
/**
|
|
24438
|
+
*
|
|
24439
|
+
* @type {SalesReportComparisonDtoSalesReport}
|
|
24440
|
+
* @memberof SalesReportComparisonDto
|
|
24441
|
+
*/
|
|
24442
|
+
'salesReport'?: SalesReportComparisonDtoSalesReport;
|
|
24443
|
+
/**
|
|
24444
|
+
*
|
|
24445
|
+
* @type {SalesReportComparisonDtoPaymentReport}
|
|
24446
|
+
* @memberof SalesReportComparisonDto
|
|
24447
|
+
*/
|
|
24448
|
+
'paymentReport'?: SalesReportComparisonDtoPaymentReport;
|
|
24449
|
+
/**
|
|
24450
|
+
* The compared period\'s days that sold, oldest first, as the group\'s own dailyBreakdown: present when it is
|
|
24451
|
+
* @type {Array<SalesReportDayDto>}
|
|
24452
|
+
* @memberof SalesReportComparisonDto
|
|
24453
|
+
*/
|
|
24454
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
24455
|
+
/**
|
|
24456
|
+
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
24457
|
+
* @type {Array<SalesReportChangeDto>}
|
|
24458
|
+
* @memberof SalesReportComparisonDto
|
|
24459
|
+
*/
|
|
24460
|
+
'changes': Array<SalesReportChangeDto>;
|
|
24461
|
+
}
|
|
24462
|
+
/**
|
|
24463
|
+
* The compared period\'s paymentReport, as the group\'s own: present when it is
|
|
24464
|
+
* @export
|
|
24465
|
+
* @interface SalesReportComparisonDtoPaymentReport
|
|
24466
|
+
*/
|
|
24467
|
+
export interface SalesReportComparisonDtoPaymentReport {
|
|
24468
|
+
/**
|
|
24469
|
+
* Part payments: one row per payment method
|
|
24470
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
24471
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
24472
|
+
*/
|
|
24473
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
24474
|
+
/**
|
|
24475
|
+
*
|
|
24476
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
24477
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
24478
|
+
*/
|
|
24479
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
24480
|
+
/**
|
|
24481
|
+
* Part discounts: one row per discount
|
|
24482
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
24483
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
24484
|
+
*/
|
|
24485
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
24486
|
+
/**
|
|
24487
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
24488
|
+
* @type {number}
|
|
24489
|
+
* @memberof SalesReportComparisonDtoPaymentReport
|
|
24490
|
+
*/
|
|
24491
|
+
'totalDiscounts'?: number;
|
|
24492
|
+
}
|
|
24493
|
+
/**
|
|
24494
|
+
* The compared period\'s salesReport, as the group\'s own: present when it is
|
|
24495
|
+
* @export
|
|
24496
|
+
* @interface SalesReportComparisonDtoSalesReport
|
|
24497
|
+
*/
|
|
24498
|
+
export interface SalesReportComparisonDtoSalesReport {
|
|
24499
|
+
/**
|
|
24500
|
+
* Part items: the categories with their items
|
|
24501
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
24502
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24503
|
+
*/
|
|
24504
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
24505
|
+
/**
|
|
24506
|
+
* Part vat: one row per VAT rate, lowest first
|
|
24507
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
24508
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24509
|
+
*/
|
|
24510
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
24511
|
+
/**
|
|
24512
|
+
* Part summary: how many items were sold
|
|
24513
|
+
* @type {number}
|
|
24514
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24515
|
+
*/
|
|
24516
|
+
'totalQuantity'?: number;
|
|
24517
|
+
/**
|
|
24518
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24519
|
+
* @type {number}
|
|
24520
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24521
|
+
*/
|
|
24522
|
+
'totalWithTax'?: number;
|
|
24523
|
+
/**
|
|
24524
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24525
|
+
* @type {number}
|
|
24526
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24527
|
+
*/
|
|
24528
|
+
'totalTaxAmount'?: number;
|
|
24529
|
+
/**
|
|
24530
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24531
|
+
* @type {number}
|
|
24532
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24533
|
+
*/
|
|
24534
|
+
'totalWithoutTax'?: number;
|
|
24535
|
+
/**
|
|
24536
|
+
* 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
|
|
24537
|
+
* @type {number}
|
|
24538
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24539
|
+
*/
|
|
24540
|
+
'deliveryFee'?: number;
|
|
24541
|
+
/**
|
|
24542
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
24543
|
+
* @type {number}
|
|
24544
|
+
* @memberof SalesReportComparisonDtoSalesReport
|
|
24545
|
+
*/
|
|
24546
|
+
'deliveryTax'?: number;
|
|
24547
|
+
}
|
|
24548
|
+
/**
|
|
24549
|
+
*
|
|
24550
|
+
* @export
|
|
24551
|
+
* @interface SalesReportDayDto
|
|
24552
|
+
*/
|
|
24553
|
+
export interface SalesReportDayDto {
|
|
24554
|
+
/**
|
|
24555
|
+
* The business day, YYYY-MM-DD, in the venue\'s own time zone
|
|
24556
|
+
* @type {string}
|
|
24557
|
+
* @memberof SalesReportDayDto
|
|
24558
|
+
*/
|
|
24559
|
+
'date': string;
|
|
24560
|
+
/**
|
|
24561
|
+
* How many orders were sold that day
|
|
24562
|
+
* @type {number}
|
|
24563
|
+
* @memberof SalesReportDayDto
|
|
24564
|
+
*/
|
|
24565
|
+
'orders': number;
|
|
24566
|
+
/**
|
|
24567
|
+
* How many items were sold that day
|
|
24568
|
+
* @type {number}
|
|
24569
|
+
* @memberof SalesReportDayDto
|
|
24570
|
+
*/
|
|
24571
|
+
'quantity': number;
|
|
24572
|
+
/**
|
|
24573
|
+
* What was paid, before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
24574
|
+
* @type {number}
|
|
24575
|
+
* @memberof SalesReportDayDto
|
|
24576
|
+
*/
|
|
24577
|
+
'sales': number;
|
|
24578
|
+
/**
|
|
24579
|
+
* Refunds of that day\'s orders, in the major unit of the group\'s currency (euros for EUR)
|
|
24580
|
+
* @type {number}
|
|
24581
|
+
* @memberof SalesReportDayDto
|
|
24582
|
+
*/
|
|
24583
|
+
'refunds': number;
|
|
24584
|
+
/**
|
|
24585
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
24586
|
+
* @type {number}
|
|
24587
|
+
* @memberof SalesReportDayDto
|
|
24588
|
+
*/
|
|
24589
|
+
'net': number;
|
|
24590
|
+
/**
|
|
24591
|
+
* Discounts given that day, in the major unit of the group\'s currency (euros for EUR)
|
|
24592
|
+
* @type {number}
|
|
24593
|
+
* @memberof SalesReportDayDto
|
|
24594
|
+
*/
|
|
24595
|
+
'discounts': number;
|
|
24596
|
+
/**
|
|
24597
|
+
* The VAT of the items sold that day, in the major unit of the group\'s currency (euros for EUR)
|
|
24598
|
+
* @type {number}
|
|
24599
|
+
* @memberof SalesReportDayDto
|
|
24600
|
+
*/
|
|
24601
|
+
'taxAmount': number;
|
|
24602
|
+
}
|
|
24603
|
+
/**
|
|
24604
|
+
*
|
|
24605
|
+
* @export
|
|
24606
|
+
* @interface SalesReportDiscountDto
|
|
24607
|
+
*/
|
|
24608
|
+
export interface SalesReportDiscountDto {
|
|
24609
|
+
/**
|
|
24610
|
+
* The discount\'s name
|
|
24611
|
+
* @type {string}
|
|
24612
|
+
* @memberof SalesReportDiscountDto
|
|
24613
|
+
*/
|
|
24614
|
+
'discountName': string;
|
|
24615
|
+
/**
|
|
24616
|
+
* How many times it was given
|
|
24617
|
+
* @type {number}
|
|
24618
|
+
* @memberof SalesReportDiscountDto
|
|
24619
|
+
*/
|
|
24620
|
+
'count': number;
|
|
24621
|
+
/**
|
|
24622
|
+
* What it took off, in the major unit of the group\'s currency (euros for EUR)
|
|
24623
|
+
* @type {number}
|
|
24624
|
+
* @memberof SalesReportDiscountDto
|
|
24625
|
+
*/
|
|
24626
|
+
'amount': number;
|
|
24627
|
+
}
|
|
24628
|
+
/**
|
|
24629
|
+
*
|
|
24630
|
+
* @export
|
|
24631
|
+
* @interface SalesReportGroupDto
|
|
24632
|
+
*/
|
|
24633
|
+
export interface SalesReportGroupDto {
|
|
24634
|
+
/**
|
|
24635
|
+
* The venue\'s business id; null when the breakdown adds venues together (none, app)
|
|
24636
|
+
* @type {object}
|
|
24637
|
+
* @memberof SalesReportGroupDto
|
|
24638
|
+
*/
|
|
24639
|
+
'businessId': object | null;
|
|
24640
|
+
/**
|
|
24641
|
+
*
|
|
24642
|
+
* @type {ReportApp}
|
|
24643
|
+
* @memberof SalesReportGroupDto
|
|
24644
|
+
*/
|
|
24645
|
+
'app': ReportApp | null;
|
|
24646
|
+
/**
|
|
24647
|
+
*
|
|
24648
|
+
* @type {CurrencyCode}
|
|
24649
|
+
* @memberof SalesReportGroupDto
|
|
24650
|
+
*/
|
|
24651
|
+
'currency': CurrencyCode;
|
|
24652
|
+
/**
|
|
24653
|
+
* The currency\'s ISO 4217 minor digits: EUR 2, ISK 0, BHD 3
|
|
24654
|
+
* @type {number}
|
|
24655
|
+
* @memberof SalesReportGroupDto
|
|
24656
|
+
*/
|
|
24657
|
+
'minorDigits': number;
|
|
24658
|
+
/**
|
|
24659
|
+
*
|
|
24660
|
+
* @type {SalesReportGroupDtoSalesReport}
|
|
24661
|
+
* @memberof SalesReportGroupDto
|
|
24662
|
+
*/
|
|
24663
|
+
'salesReport'?: SalesReportGroupDtoSalesReport;
|
|
24664
|
+
/**
|
|
24665
|
+
*
|
|
24666
|
+
* @type {SalesReportGroupDtoPaymentReport}
|
|
24667
|
+
* @memberof SalesReportGroupDto
|
|
24668
|
+
*/
|
|
24669
|
+
'paymentReport'?: SalesReportGroupDtoPaymentReport;
|
|
24670
|
+
/**
|
|
24671
|
+
* Part summary: one row per business day that sold, oldest first. POS leaves it out when no day sold
|
|
24672
|
+
* @type {Array<SalesReportDayDto>}
|
|
24673
|
+
* @memberof SalesReportGroupDto
|
|
24674
|
+
*/
|
|
24675
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
24676
|
+
/**
|
|
24677
|
+
*
|
|
24678
|
+
* @type {SalesReportGroupDtoComparison}
|
|
24679
|
+
* @memberof SalesReportGroupDto
|
|
24680
|
+
*/
|
|
24681
|
+
'comparison'?: SalesReportGroupDtoComparison;
|
|
24682
|
+
/**
|
|
24683
|
+
* 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
|
|
24684
|
+
* @type {Array<SalesReportChangeDto>}
|
|
24685
|
+
* @memberof SalesReportGroupDto
|
|
24686
|
+
*/
|
|
24687
|
+
'changesFromBaseline'?: Array<SalesReportChangeDto>;
|
|
24688
|
+
/**
|
|
24689
|
+
*
|
|
24690
|
+
* @type {ReportBaselineLeftOut}
|
|
24691
|
+
* @memberof SalesReportGroupDto
|
|
24692
|
+
*/
|
|
24693
|
+
'changesFromBaselineLeftOut'?: ReportBaselineLeftOut;
|
|
24694
|
+
}
|
|
24695
|
+
|
|
24696
|
+
|
|
24697
|
+
/**
|
|
24698
|
+
* With compareStart and compareEnd: the same group\'s report of those days and the change of each total. Left out without them
|
|
24699
|
+
* @export
|
|
24700
|
+
* @interface SalesReportGroupDtoComparison
|
|
24701
|
+
*/
|
|
24702
|
+
export interface SalesReportGroupDtoComparison {
|
|
24703
|
+
/**
|
|
24704
|
+
* The first instant of the compared period, ISO 8601 in UTC
|
|
24705
|
+
* @type {string}
|
|
24706
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24707
|
+
*/
|
|
24708
|
+
'reportDateStart': string;
|
|
24709
|
+
/**
|
|
24710
|
+
* The last instant of the compared period, ISO 8601 in UTC; now, when the period ends later
|
|
24711
|
+
* @type {string}
|
|
24712
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24713
|
+
*/
|
|
24714
|
+
'reportDateEnd': string;
|
|
24715
|
+
/**
|
|
24716
|
+
* The first business day compared, YYYY-MM-DD, in the report\'s time zone
|
|
24717
|
+
* @type {string}
|
|
24718
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24719
|
+
*/
|
|
24720
|
+
'firstBusinessDay': string;
|
|
24721
|
+
/**
|
|
24722
|
+
* The last business day compared, YYYY-MM-DD, inclusive
|
|
24723
|
+
* @type {string}
|
|
24724
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24725
|
+
*/
|
|
24726
|
+
'lastBusinessDay': string;
|
|
24727
|
+
/**
|
|
24728
|
+
*
|
|
24729
|
+
* @type {SalesReportComparisonDtoSalesReport}
|
|
24730
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24731
|
+
*/
|
|
24732
|
+
'salesReport'?: SalesReportComparisonDtoSalesReport;
|
|
24733
|
+
/**
|
|
24734
|
+
*
|
|
24735
|
+
* @type {SalesReportComparisonDtoPaymentReport}
|
|
24736
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24737
|
+
*/
|
|
24738
|
+
'paymentReport'?: SalesReportComparisonDtoPaymentReport;
|
|
24739
|
+
/**
|
|
24740
|
+
* The compared period\'s days that sold, oldest first, as the group\'s own dailyBreakdown: present when it is
|
|
24741
|
+
* @type {Array<SalesReportDayDto>}
|
|
24742
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24743
|
+
*/
|
|
24744
|
+
'dailyBreakdown'?: Array<SalesReportDayDto>;
|
|
24745
|
+
/**
|
|
24746
|
+
* The change of each total either period answers, in ReportChangeField\'s order; empty when part summary was not asked
|
|
24747
|
+
* @type {Array<SalesReportChangeDto>}
|
|
24748
|
+
* @memberof SalesReportGroupDtoComparison
|
|
24749
|
+
*/
|
|
24750
|
+
'changes': Array<SalesReportChangeDto>;
|
|
24751
|
+
}
|
|
24752
|
+
/**
|
|
24753
|
+
* The portal\'s paymentReport for the group: present when part summary, payments or discounts was asked
|
|
24754
|
+
* @export
|
|
24755
|
+
* @interface SalesReportGroupDtoPaymentReport
|
|
24756
|
+
*/
|
|
24757
|
+
export interface SalesReportGroupDtoPaymentReport {
|
|
24758
|
+
/**
|
|
24759
|
+
* Part payments: one row per payment method
|
|
24760
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
24761
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24762
|
+
*/
|
|
24763
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
24764
|
+
/**
|
|
24765
|
+
*
|
|
24766
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
24767
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24768
|
+
*/
|
|
24769
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
24770
|
+
/**
|
|
24771
|
+
* Part discounts: one row per discount
|
|
24772
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
24773
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24774
|
+
*/
|
|
24775
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
24776
|
+
/**
|
|
24777
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
24778
|
+
* @type {number}
|
|
24779
|
+
* @memberof SalesReportGroupDtoPaymentReport
|
|
24780
|
+
*/
|
|
24781
|
+
'totalDiscounts'?: number;
|
|
24782
|
+
}
|
|
24783
|
+
/**
|
|
24784
|
+
* 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
|
|
24785
|
+
* @export
|
|
24786
|
+
* @interface SalesReportGroupDtoSalesReport
|
|
24787
|
+
*/
|
|
24788
|
+
export interface SalesReportGroupDtoSalesReport {
|
|
24789
|
+
/**
|
|
24790
|
+
* Part items: the categories with their items
|
|
24791
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
24792
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24793
|
+
*/
|
|
24794
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
24795
|
+
/**
|
|
24796
|
+
* Part vat: one row per VAT rate, lowest first
|
|
24797
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
24798
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24799
|
+
*/
|
|
24800
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
24801
|
+
/**
|
|
24802
|
+
* Part summary: how many items were sold
|
|
24803
|
+
* @type {number}
|
|
24804
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24805
|
+
*/
|
|
24806
|
+
'totalQuantity'?: number;
|
|
24807
|
+
/**
|
|
24808
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24809
|
+
* @type {number}
|
|
24810
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24811
|
+
*/
|
|
24812
|
+
'totalWithTax'?: number;
|
|
24813
|
+
/**
|
|
24814
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24815
|
+
* @type {number}
|
|
24816
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24817
|
+
*/
|
|
24818
|
+
'totalTaxAmount'?: number;
|
|
24819
|
+
/**
|
|
24820
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24821
|
+
* @type {number}
|
|
24822
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24823
|
+
*/
|
|
24824
|
+
'totalWithoutTax'?: number;
|
|
24825
|
+
/**
|
|
24826
|
+
* 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
|
|
24827
|
+
* @type {number}
|
|
24828
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24829
|
+
*/
|
|
24830
|
+
'deliveryFee'?: number;
|
|
24831
|
+
/**
|
|
24832
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
24833
|
+
* @type {number}
|
|
24834
|
+
* @memberof SalesReportGroupDtoSalesReport
|
|
24835
|
+
*/
|
|
24836
|
+
'deliveryTax'?: number;
|
|
24837
|
+
}
|
|
24838
|
+
/**
|
|
24839
|
+
*
|
|
24840
|
+
* @export
|
|
24841
|
+
* @interface SalesReportItemDto
|
|
24842
|
+
*/
|
|
24843
|
+
export interface SalesReportItemDto {
|
|
24844
|
+
/**
|
|
24845
|
+
* The item\'s name. POS: its first sale\'s name and VAT rate, as the portal shows it
|
|
24846
|
+
* @type {object}
|
|
24847
|
+
* @memberof SalesReportItemDto
|
|
24848
|
+
*/
|
|
24849
|
+
'name': object | null;
|
|
24850
|
+
/**
|
|
24851
|
+
* The product\'s id; null when the sale carried none
|
|
24852
|
+
* @type {object}
|
|
24853
|
+
* @memberof SalesReportItemDto
|
|
24854
|
+
*/
|
|
24855
|
+
'productId': object | null;
|
|
24856
|
+
/**
|
|
24857
|
+
* How many were sold
|
|
24858
|
+
* @type {number}
|
|
24859
|
+
* @memberof SalesReportItemDto
|
|
24860
|
+
*/
|
|
24861
|
+
'quantity': number;
|
|
24862
|
+
/**
|
|
24863
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24864
|
+
* @type {number}
|
|
24865
|
+
* @memberof SalesReportItemDto
|
|
24866
|
+
*/
|
|
24867
|
+
'totalWithTax': number;
|
|
24868
|
+
/**
|
|
24869
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24870
|
+
* @type {number}
|
|
24871
|
+
* @memberof SalesReportItemDto
|
|
24872
|
+
*/
|
|
24873
|
+
'taxAmount': number;
|
|
24874
|
+
/**
|
|
24875
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24876
|
+
* @type {number}
|
|
24877
|
+
* @memberof SalesReportItemDto
|
|
24878
|
+
*/
|
|
24879
|
+
'totalWithoutTax': number;
|
|
24880
|
+
/**
|
|
24881
|
+
* The VAT rate in percent; null when none was recorded
|
|
24882
|
+
* @type {object}
|
|
24883
|
+
* @memberof SalesReportItemDto
|
|
24884
|
+
*/
|
|
24885
|
+
'taxRate': object | null;
|
|
24886
|
+
/**
|
|
24887
|
+
* The options sold with the item; left out when none was
|
|
24888
|
+
* @type {Array<SalesReportOptionDto>}
|
|
24889
|
+
* @memberof SalesReportItemDto
|
|
24890
|
+
*/
|
|
24891
|
+
'subOptions'?: Array<SalesReportOptionDto>;
|
|
24892
|
+
}
|
|
24893
|
+
/**
|
|
24894
|
+
*
|
|
24895
|
+
* @export
|
|
24896
|
+
* @interface SalesReportOptionDto
|
|
24897
|
+
*/
|
|
24898
|
+
export interface SalesReportOptionDto {
|
|
24899
|
+
/**
|
|
24900
|
+
* The option\'s name
|
|
24901
|
+
* @type {string}
|
|
24902
|
+
* @memberof SalesReportOptionDto
|
|
24903
|
+
*/
|
|
24904
|
+
'name': string;
|
|
24905
|
+
/**
|
|
24906
|
+
* How many were sold
|
|
24907
|
+
* @type {number}
|
|
24908
|
+
* @memberof SalesReportOptionDto
|
|
24909
|
+
*/
|
|
24910
|
+
'quantity': number;
|
|
24911
|
+
/**
|
|
24912
|
+
* Sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24913
|
+
* @type {number}
|
|
24914
|
+
* @memberof SalesReportOptionDto
|
|
24915
|
+
*/
|
|
24916
|
+
'totalWithTax': number;
|
|
24917
|
+
/**
|
|
24918
|
+
* The VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24919
|
+
* @type {number}
|
|
24920
|
+
* @memberof SalesReportOptionDto
|
|
24921
|
+
*/
|
|
24922
|
+
'taxAmount': number;
|
|
24923
|
+
/**
|
|
24924
|
+
* Sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
24925
|
+
* @type {number}
|
|
24926
|
+
* @memberof SalesReportOptionDto
|
|
24927
|
+
*/
|
|
24928
|
+
'totalWithoutTax': number;
|
|
24929
|
+
/**
|
|
24930
|
+
* The VAT rate in percent; null when none was recorded
|
|
24931
|
+
* @type {object}
|
|
24932
|
+
* @memberof SalesReportOptionDto
|
|
24933
|
+
*/
|
|
24934
|
+
'taxRate': object | null;
|
|
24935
|
+
}
|
|
24936
|
+
/**
|
|
24937
|
+
*
|
|
24938
|
+
* @export
|
|
24939
|
+
* @interface SalesReportPaymentMethodDto
|
|
24940
|
+
*/
|
|
24941
|
+
export interface SalesReportPaymentMethodDto {
|
|
24942
|
+
/**
|
|
24943
|
+
* The payment method, as the app records it
|
|
24944
|
+
* @type {string}
|
|
24945
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24946
|
+
*/
|
|
24947
|
+
'paymentMethod': string;
|
|
24948
|
+
/**
|
|
24949
|
+
* How many payments were made with it
|
|
24950
|
+
* @type {number}
|
|
24951
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24952
|
+
*/
|
|
24953
|
+
'count': number;
|
|
24954
|
+
/**
|
|
24955
|
+
* What was paid with it, in the major unit of the group\'s currency (euros for EUR)
|
|
24956
|
+
* @type {number}
|
|
24957
|
+
* @memberof SalesReportPaymentMethodDto
|
|
24958
|
+
*/
|
|
24959
|
+
'amount': number;
|
|
24960
|
+
}
|
|
24961
|
+
/**
|
|
24962
|
+
*
|
|
24963
|
+
* @export
|
|
24964
|
+
* @interface SalesReportPaymentSummaryDto
|
|
24965
|
+
*/
|
|
24966
|
+
export interface SalesReportPaymentSummaryDto {
|
|
24967
|
+
/**
|
|
24968
|
+
* Tips, in the major unit of the group\'s currency (euros for EUR)
|
|
24969
|
+
* @type {number}
|
|
24970
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24971
|
+
*/
|
|
24972
|
+
'totalTipAmount': number;
|
|
24973
|
+
/**
|
|
24974
|
+
* Surcharges, in the major unit of the group\'s currency (euros for EUR)
|
|
24975
|
+
* @type {number}
|
|
24976
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24977
|
+
*/
|
|
24978
|
+
'totalSurchargeAmount': number;
|
|
24979
|
+
/**
|
|
24980
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
24981
|
+
* @type {number}
|
|
24982
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24983
|
+
*/
|
|
24984
|
+
'salesAndRevenue': number;
|
|
24985
|
+
/**
|
|
24986
|
+
* How many card payments were made
|
|
24987
|
+
* @type {number}
|
|
24988
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24989
|
+
*/
|
|
24990
|
+
'cardsCount': number;
|
|
24991
|
+
/**
|
|
24992
|
+
* What was paid by card, in the major unit of the group\'s currency (euros for EUR)
|
|
24993
|
+
* @type {number}
|
|
24994
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
24995
|
+
*/
|
|
24996
|
+
'cardsAmount': number;
|
|
24997
|
+
/**
|
|
24998
|
+
* How many Edenred vouchers were paid with
|
|
24999
|
+
* @type {number}
|
|
25000
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25001
|
+
*/
|
|
25002
|
+
'edenredVoucherCount': number;
|
|
25003
|
+
/**
|
|
25004
|
+
* What was paid with Edenred vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
25005
|
+
* @type {number}
|
|
25006
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25007
|
+
*/
|
|
25008
|
+
'edenredVoucherAmount': number;
|
|
25009
|
+
/**
|
|
25010
|
+
* How many Smartum vouchers were paid with
|
|
25011
|
+
* @type {number}
|
|
25012
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25013
|
+
*/
|
|
25014
|
+
'smartumVoucherCount': number;
|
|
25015
|
+
/**
|
|
25016
|
+
* What was paid with Smartum vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
25017
|
+
* @type {number}
|
|
25018
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25019
|
+
*/
|
|
25020
|
+
'smartumVoucherAmount': number;
|
|
25021
|
+
/**
|
|
25022
|
+
* How many payments were made
|
|
25023
|
+
* @type {number}
|
|
25024
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25025
|
+
*/
|
|
25026
|
+
'totalCount': number;
|
|
25027
|
+
/**
|
|
25028
|
+
* The same as salesAndRevenue, in the major unit of the group\'s currency (euros for EUR)
|
|
25029
|
+
* @type {number}
|
|
25030
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25031
|
+
*/
|
|
25032
|
+
'totalAmount': number;
|
|
25033
|
+
/**
|
|
25034
|
+
* Always 0: no app records coupons here
|
|
25035
|
+
* @type {number}
|
|
25036
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25037
|
+
*/
|
|
25038
|
+
'totalCoupons': number;
|
|
25039
|
+
/**
|
|
25040
|
+
* Vouchers\' leftover that was not given back, in the major unit of the group\'s currency (euros for EUR)
|
|
25041
|
+
* @type {number}
|
|
25042
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25043
|
+
*/
|
|
25044
|
+
'totalVoucherForfeited': number;
|
|
25045
|
+
/**
|
|
25046
|
+
* POS only: what was paid before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
25047
|
+
* @type {number}
|
|
25048
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
25049
|
+
*/
|
|
25050
|
+
'grossAmount'?: number;
|
|
23547
25051
|
/**
|
|
23548
|
-
*
|
|
23549
|
-
* @type {
|
|
23550
|
-
* @memberof
|
|
25052
|
+
* Refunds, in the major unit of the group\'s currency (euros for EUR), on the day of the order they refund
|
|
25053
|
+
* @type {number}
|
|
25054
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
23551
25055
|
*/
|
|
23552
|
-
'
|
|
25056
|
+
'totalRefunds': number;
|
|
23553
25057
|
/**
|
|
23554
|
-
*
|
|
23555
|
-
* @type {
|
|
23556
|
-
* @memberof
|
|
25058
|
+
* How many refunds were made
|
|
25059
|
+
* @type {number}
|
|
25060
|
+
* @memberof SalesReportPaymentSummaryDto
|
|
23557
25061
|
*/
|
|
23558
|
-
'
|
|
25062
|
+
'refundCount': number;
|
|
23559
25063
|
}
|
|
23560
|
-
|
|
23561
|
-
|
|
23562
|
-
/**
|
|
23563
|
-
*
|
|
23564
|
-
* @export
|
|
23565
|
-
* @enum {string}
|
|
23566
|
-
*/
|
|
23567
|
-
|
|
23568
|
-
export const ReservationSource = {
|
|
23569
|
-
WalkIn: 'WALK_IN',
|
|
23570
|
-
Pos: 'POS',
|
|
23571
|
-
ReservationsApp: 'RESERVATIONS_APP',
|
|
23572
|
-
OnlineWidget: 'ONLINE_WIDGET',
|
|
23573
|
-
Phone: 'PHONE'
|
|
23574
|
-
} as const;
|
|
23575
|
-
|
|
23576
|
-
export type ReservationSource = typeof ReservationSource[keyof typeof ReservationSource];
|
|
23577
|
-
|
|
23578
|
-
|
|
23579
25064
|
/**
|
|
23580
25065
|
*
|
|
23581
25066
|
* @export
|
|
23582
|
-
* @
|
|
23583
|
-
*/
|
|
23584
|
-
|
|
23585
|
-
export const ReservationStatus = {
|
|
23586
|
-
Requested: 'REQUESTED',
|
|
23587
|
-
Confirmed: 'CONFIRMED',
|
|
23588
|
-
Waitlist: 'WAITLIST',
|
|
23589
|
-
Seated: 'SEATED',
|
|
23590
|
-
NoShow: 'NO_SHOW',
|
|
23591
|
-
Completed: 'COMPLETED',
|
|
23592
|
-
Cancelled: 'CANCELLED'
|
|
23593
|
-
} as const;
|
|
23594
|
-
|
|
23595
|
-
export type ReservationStatus = typeof ReservationStatus[keyof typeof ReservationStatus];
|
|
23596
|
-
|
|
23597
|
-
|
|
23598
|
-
/**
|
|
23599
|
-
*
|
|
23600
|
-
* @export
|
|
23601
|
-
* @interface ResetEodDto
|
|
25067
|
+
* @interface SalesReportPaymentsDto
|
|
23602
25068
|
*/
|
|
23603
|
-
export interface
|
|
25069
|
+
export interface SalesReportPaymentsDto {
|
|
23604
25070
|
/**
|
|
23605
|
-
*
|
|
23606
|
-
* @type {
|
|
23607
|
-
* @memberof
|
|
25071
|
+
* Part payments: one row per payment method
|
|
25072
|
+
* @type {Array<SalesReportPaymentMethodDto>}
|
|
25073
|
+
* @memberof SalesReportPaymentsDto
|
|
23608
25074
|
*/
|
|
23609
|
-
'
|
|
23610
|
-
}
|
|
23611
|
-
/**
|
|
23612
|
-
*
|
|
23613
|
-
* @export
|
|
23614
|
-
* @interface ResolveChoiceDto
|
|
23615
|
-
*/
|
|
23616
|
-
export interface ResolveChoiceDto {
|
|
25075
|
+
'paymentMethods'?: Array<SalesReportPaymentMethodDto>;
|
|
23617
25076
|
/**
|
|
23618
|
-
*
|
|
23619
|
-
* @type {
|
|
23620
|
-
* @memberof
|
|
25077
|
+
*
|
|
25078
|
+
* @type {SalesReportPaymentsDtoSummary}
|
|
25079
|
+
* @memberof SalesReportPaymentsDto
|
|
23621
25080
|
*/
|
|
23622
|
-
'
|
|
25081
|
+
'summary'?: SalesReportPaymentsDtoSummary;
|
|
25082
|
+
/**
|
|
25083
|
+
* Part discounts: one row per discount
|
|
25084
|
+
* @type {Array<SalesReportDiscountDto>}
|
|
25085
|
+
* @memberof SalesReportPaymentsDto
|
|
25086
|
+
*/
|
|
25087
|
+
'discounts'?: Array<SalesReportDiscountDto>;
|
|
25088
|
+
/**
|
|
25089
|
+
* Part summary: every discount given, in the major unit of the group\'s currency (euros for EUR)
|
|
25090
|
+
* @type {number}
|
|
25091
|
+
* @memberof SalesReportPaymentsDto
|
|
25092
|
+
*/
|
|
25093
|
+
'totalDiscounts'?: number;
|
|
23623
25094
|
}
|
|
23624
25095
|
/**
|
|
23625
|
-
*
|
|
25096
|
+
* Part summary: the payment totals
|
|
23626
25097
|
* @export
|
|
23627
|
-
* @interface
|
|
25098
|
+
* @interface SalesReportPaymentsDtoSummary
|
|
23628
25099
|
*/
|
|
23629
|
-
export interface
|
|
25100
|
+
export interface SalesReportPaymentsDtoSummary {
|
|
23630
25101
|
/**
|
|
23631
|
-
*
|
|
23632
|
-
* @type {
|
|
23633
|
-
* @memberof
|
|
25102
|
+
* Tips, in the major unit of the group\'s currency (euros for EUR)
|
|
25103
|
+
* @type {number}
|
|
25104
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
23634
25105
|
*/
|
|
23635
|
-
'
|
|
25106
|
+
'totalTipAmount': number;
|
|
23636
25107
|
/**
|
|
23637
|
-
*
|
|
23638
|
-
* @type {
|
|
23639
|
-
* @memberof
|
|
25108
|
+
* Surcharges, in the major unit of the group\'s currency (euros for EUR)
|
|
25109
|
+
* @type {number}
|
|
25110
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
23640
25111
|
*/
|
|
23641
|
-
'
|
|
25112
|
+
'totalSurchargeAmount': number;
|
|
23642
25113
|
/**
|
|
23643
|
-
*
|
|
23644
|
-
* @type {
|
|
23645
|
-
* @memberof
|
|
25114
|
+
* What was paid, refunds taken off, in the major unit of the group\'s currency (euros for EUR)
|
|
25115
|
+
* @type {number}
|
|
25116
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
23646
25117
|
*/
|
|
23647
|
-
'
|
|
25118
|
+
'salesAndRevenue': number;
|
|
23648
25119
|
/**
|
|
23649
|
-
*
|
|
23650
|
-
* @type {
|
|
23651
|
-
* @memberof
|
|
25120
|
+
* How many card payments were made
|
|
25121
|
+
* @type {number}
|
|
25122
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
23652
25123
|
*/
|
|
23653
|
-
'
|
|
25124
|
+
'cardsCount': number;
|
|
23654
25125
|
/**
|
|
23655
|
-
*
|
|
23656
|
-
* @type {
|
|
23657
|
-
* @memberof
|
|
25126
|
+
* What was paid by card, in the major unit of the group\'s currency (euros for EUR)
|
|
25127
|
+
* @type {number}
|
|
25128
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
23658
25129
|
*/
|
|
23659
|
-
'
|
|
25130
|
+
'cardsAmount': number;
|
|
23660
25131
|
/**
|
|
23661
|
-
*
|
|
23662
|
-
* @type {
|
|
23663
|
-
* @memberof
|
|
25132
|
+
* How many Edenred vouchers were paid with
|
|
25133
|
+
* @type {number}
|
|
25134
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
23664
25135
|
*/
|
|
23665
|
-
'
|
|
25136
|
+
'edenredVoucherCount': number;
|
|
23666
25137
|
/**
|
|
23667
|
-
*
|
|
23668
|
-
* @type {
|
|
23669
|
-
* @memberof
|
|
25138
|
+
* What was paid with Edenred vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
25139
|
+
* @type {number}
|
|
25140
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
23670
25141
|
*/
|
|
23671
|
-
'
|
|
25142
|
+
'edenredVoucherAmount': number;
|
|
23672
25143
|
/**
|
|
23673
|
-
*
|
|
23674
|
-
* @type {
|
|
23675
|
-
* @memberof
|
|
25144
|
+
* How many Smartum vouchers were paid with
|
|
25145
|
+
* @type {number}
|
|
25146
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
23676
25147
|
*/
|
|
23677
|
-
'
|
|
25148
|
+
'smartumVoucherCount': number;
|
|
23678
25149
|
/**
|
|
23679
|
-
*
|
|
23680
|
-
* @type {
|
|
23681
|
-
* @memberof
|
|
25150
|
+
* What was paid with Smartum vouchers, in the major unit of the group\'s currency (euros for EUR)
|
|
25151
|
+
* @type {number}
|
|
25152
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
23682
25153
|
*/
|
|
23683
|
-
'
|
|
25154
|
+
'smartumVoucherAmount': number;
|
|
23684
25155
|
/**
|
|
23685
|
-
*
|
|
23686
|
-
* @type {
|
|
23687
|
-
* @memberof
|
|
25156
|
+
* How many payments were made
|
|
25157
|
+
* @type {number}
|
|
25158
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
23688
25159
|
*/
|
|
23689
|
-
'
|
|
25160
|
+
'totalCount': number;
|
|
25161
|
+
/**
|
|
25162
|
+
* The same as salesAndRevenue, in the major unit of the group\'s currency (euros for EUR)
|
|
25163
|
+
* @type {number}
|
|
25164
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25165
|
+
*/
|
|
25166
|
+
'totalAmount': number;
|
|
25167
|
+
/**
|
|
25168
|
+
* Always 0: no app records coupons here
|
|
25169
|
+
* @type {number}
|
|
25170
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25171
|
+
*/
|
|
25172
|
+
'totalCoupons': number;
|
|
25173
|
+
/**
|
|
25174
|
+
* Vouchers\' leftover that was not given back, in the major unit of the group\'s currency (euros for EUR)
|
|
25175
|
+
* @type {number}
|
|
25176
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25177
|
+
*/
|
|
25178
|
+
'totalVoucherForfeited': number;
|
|
25179
|
+
/**
|
|
25180
|
+
* POS only: what was paid before refunds, in the major unit of the group\'s currency (euros for EUR)
|
|
25181
|
+
* @type {number}
|
|
25182
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25183
|
+
*/
|
|
25184
|
+
'grossAmount'?: number;
|
|
25185
|
+
/**
|
|
25186
|
+
* Refunds, in the major unit of the group\'s currency (euros for EUR), on the day of the order they refund
|
|
25187
|
+
* @type {number}
|
|
25188
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25189
|
+
*/
|
|
25190
|
+
'totalRefunds': number;
|
|
25191
|
+
/**
|
|
25192
|
+
* How many refunds were made
|
|
25193
|
+
* @type {number}
|
|
25194
|
+
* @memberof SalesReportPaymentsDtoSummary
|
|
25195
|
+
*/
|
|
25196
|
+
'refundCount': number;
|
|
23690
25197
|
}
|
|
23691
|
-
|
|
23692
|
-
|
|
23693
25198
|
/**
|
|
23694
25199
|
*
|
|
23695
25200
|
* @export
|
|
23696
|
-
* @interface
|
|
25201
|
+
* @interface SalesReportResponseDto
|
|
23697
25202
|
*/
|
|
23698
|
-
export interface
|
|
25203
|
+
export interface SalesReportResponseDto {
|
|
23699
25204
|
/**
|
|
23700
|
-
* The
|
|
23701
|
-
* @type {
|
|
23702
|
-
* @memberof
|
|
25205
|
+
* The first instant of the period, ISO 8601 in UTC
|
|
25206
|
+
* @type {string}
|
|
25207
|
+
* @memberof SalesReportResponseDto
|
|
23703
25208
|
*/
|
|
23704
|
-
'
|
|
25209
|
+
'reportDateStart': string;
|
|
23705
25210
|
/**
|
|
23706
|
-
* The
|
|
25211
|
+
* The last instant of the period, ISO 8601 in UTC; now, when the period ends later
|
|
23707
25212
|
* @type {string}
|
|
23708
|
-
* @memberof
|
|
25213
|
+
* @memberof SalesReportResponseDto
|
|
23709
25214
|
*/
|
|
23710
|
-
'
|
|
25215
|
+
'reportDateEnd': string;
|
|
23711
25216
|
/**
|
|
23712
|
-
*
|
|
25217
|
+
* When the report was answered, ISO 8601 in UTC
|
|
23713
25218
|
* @type {string}
|
|
23714
|
-
* @memberof
|
|
25219
|
+
* @memberof SalesReportResponseDto
|
|
23715
25220
|
*/
|
|
23716
|
-
'
|
|
23717
|
-
}
|
|
23718
|
-
/**
|
|
23719
|
-
*
|
|
23720
|
-
* @export
|
|
23721
|
-
* @interface RestoreLoyaltyRedemptionResponseDto
|
|
23722
|
-
*/
|
|
23723
|
-
export interface RestoreLoyaltyRedemptionResponseDto {
|
|
25221
|
+
'reportGeneratedAt': string;
|
|
23724
25222
|
/**
|
|
23725
|
-
*
|
|
23726
|
-
* @type {
|
|
23727
|
-
* @memberof
|
|
25223
|
+
* The time zone the period was read in: the request\'s, or else the first venue\'s
|
|
25224
|
+
* @type {string}
|
|
25225
|
+
* @memberof SalesReportResponseDto
|
|
23728
25226
|
*/
|
|
23729
|
-
'
|
|
25227
|
+
'timezone': string;
|
|
23730
25228
|
/**
|
|
23731
|
-
*
|
|
25229
|
+
* The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
|
|
23732
25230
|
* @type {string}
|
|
23733
|
-
* @memberof
|
|
25231
|
+
* @memberof SalesReportResponseDto
|
|
23734
25232
|
*/
|
|
23735
|
-
'
|
|
25233
|
+
'firstBusinessDay': string;
|
|
23736
25234
|
/**
|
|
23737
|
-
*
|
|
25235
|
+
* The last business day added up, YYYY-MM-DD, inclusive
|
|
23738
25236
|
* @type {string}
|
|
23739
|
-
* @memberof
|
|
25237
|
+
* @memberof SalesReportResponseDto
|
|
23740
25238
|
*/
|
|
23741
|
-
'
|
|
25239
|
+
'lastBusinessDay': string;
|
|
25240
|
+
/**
|
|
25241
|
+
* 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
|
|
25242
|
+
* @type {object}
|
|
25243
|
+
* @memberof SalesReportResponseDto
|
|
25244
|
+
*/
|
|
25245
|
+
'dataUntil': object | null;
|
|
25246
|
+
/**
|
|
25247
|
+
* One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
|
|
25248
|
+
* @type {Array<SalesReportGroupDto>}
|
|
25249
|
+
* @memberof SalesReportResponseDto
|
|
25250
|
+
*/
|
|
25251
|
+
'reports': Array<SalesReportGroupDto>;
|
|
23742
25252
|
}
|
|
23743
|
-
|
|
23744
|
-
|
|
23745
25253
|
/**
|
|
23746
25254
|
*
|
|
23747
25255
|
* @export
|
|
23748
|
-
* @interface
|
|
25256
|
+
* @interface SalesReportSalesDto
|
|
23749
25257
|
*/
|
|
23750
|
-
export interface
|
|
25258
|
+
export interface SalesReportSalesDto {
|
|
23751
25259
|
/**
|
|
23752
|
-
*
|
|
23753
|
-
* @type {
|
|
23754
|
-
* @memberof
|
|
25260
|
+
* Part items: the categories with their items
|
|
25261
|
+
* @type {Array<SalesReportCategoryDto>}
|
|
25262
|
+
* @memberof SalesReportSalesDto
|
|
23755
25263
|
*/
|
|
23756
|
-
'
|
|
25264
|
+
'categories'?: Array<SalesReportCategoryDto>;
|
|
25265
|
+
/**
|
|
25266
|
+
* Part vat: one row per VAT rate, lowest first
|
|
25267
|
+
* @type {Array<SalesReportVatRateDto>}
|
|
25268
|
+
* @memberof SalesReportSalesDto
|
|
25269
|
+
*/
|
|
25270
|
+
'taxSummary'?: Array<SalesReportVatRateDto>;
|
|
25271
|
+
/**
|
|
25272
|
+
* Part summary: how many items were sold
|
|
25273
|
+
* @type {number}
|
|
25274
|
+
* @memberof SalesReportSalesDto
|
|
25275
|
+
*/
|
|
25276
|
+
'totalQuantity'?: number;
|
|
25277
|
+
/**
|
|
25278
|
+
* Part summary: sales with VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
25279
|
+
* @type {number}
|
|
25280
|
+
* @memberof SalesReportSalesDto
|
|
25281
|
+
*/
|
|
25282
|
+
'totalWithTax'?: number;
|
|
25283
|
+
/**
|
|
25284
|
+
* Part summary: the VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
25285
|
+
* @type {number}
|
|
25286
|
+
* @memberof SalesReportSalesDto
|
|
25287
|
+
*/
|
|
25288
|
+
'totalTaxAmount'?: number;
|
|
25289
|
+
/**
|
|
25290
|
+
* Part summary: sales without VAT, in the major unit of the group\'s currency (euros for EUR)
|
|
25291
|
+
* @type {number}
|
|
25292
|
+
* @memberof SalesReportSalesDto
|
|
25293
|
+
*/
|
|
25294
|
+
'totalWithoutTax'?: number;
|
|
25295
|
+
/**
|
|
25296
|
+
* 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
|
|
25297
|
+
* @type {number}
|
|
25298
|
+
* @memberof SalesReportSalesDto
|
|
25299
|
+
*/
|
|
25300
|
+
'deliveryFee'?: number;
|
|
25301
|
+
/**
|
|
25302
|
+
* Part summary, with deliveryFee: the VAT of the delivery fees, in the major unit of the group\'s currency (euros for EUR)
|
|
25303
|
+
* @type {number}
|
|
25304
|
+
* @memberof SalesReportSalesDto
|
|
25305
|
+
*/
|
|
25306
|
+
'deliveryTax'?: number;
|
|
23757
25307
|
}
|
|
23758
25308
|
/**
|
|
23759
25309
|
*
|
|
23760
25310
|
* @export
|
|
23761
|
-
* @interface
|
|
25311
|
+
* @interface SalesReportVatRateDto
|
|
23762
25312
|
*/
|
|
23763
|
-
export interface
|
|
25313
|
+
export interface SalesReportVatRateDto {
|
|
23764
25314
|
/**
|
|
23765
|
-
* The
|
|
23766
|
-
* @type {
|
|
23767
|
-
* @memberof
|
|
25315
|
+
* The VAT rate in percent
|
|
25316
|
+
* @type {number}
|
|
25317
|
+
* @memberof SalesReportVatRateDto
|
|
23768
25318
|
*/
|
|
23769
|
-
'
|
|
25319
|
+
'taxRate': number;
|
|
23770
25320
|
/**
|
|
23771
|
-
*
|
|
25321
|
+
* Sales with VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
23772
25322
|
* @type {number}
|
|
23773
|
-
* @memberof
|
|
25323
|
+
* @memberof SalesReportVatRateDto
|
|
23774
25324
|
*/
|
|
23775
|
-
'
|
|
25325
|
+
'totalWithTax': number;
|
|
25326
|
+
/**
|
|
25327
|
+
* The VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
25328
|
+
* @type {number}
|
|
25329
|
+
* @memberof SalesReportVatRateDto
|
|
25330
|
+
*/
|
|
25331
|
+
'taxAmount': number;
|
|
25332
|
+
/**
|
|
25333
|
+
* Sales without VAT at this rate, in the major unit of the group\'s currency (euros for EUR)
|
|
25334
|
+
* @type {number}
|
|
25335
|
+
* @memberof SalesReportVatRateDto
|
|
25336
|
+
*/
|
|
25337
|
+
'totalWithoutTax': number;
|
|
23776
25338
|
}
|
|
23777
|
-
/**
|
|
23778
|
-
*
|
|
23779
|
-
* @export
|
|
23780
|
-
* @enum {string}
|
|
23781
|
-
*/
|
|
23782
|
-
|
|
23783
|
-
export const SYNCKEY = {
|
|
23784
|
-
Menu: 'MENU',
|
|
23785
|
-
Products: 'PRODUCTS',
|
|
23786
|
-
Discounts: 'DISCOUNTS',
|
|
23787
|
-
LoyaltySettings: 'LOYALTY_SETTINGS',
|
|
23788
|
-
BusinessConfig: 'BUSINESS_CONFIG',
|
|
23789
|
-
BusinessProviderSupportedIntegrations: 'BUSINESS_PROVIDER_SUPPORTED_INTEGRATIONS',
|
|
23790
|
-
PosSession: 'POS_SESSION',
|
|
23791
|
-
InvoiceCompanies: 'INVOICE_COMPANIES',
|
|
23792
|
-
BusinessTax: 'BUSINESS_TAX',
|
|
23793
|
-
Transaction: 'TRANSACTION',
|
|
23794
|
-
PaymentMethods: 'PAYMENT_METHODS',
|
|
23795
|
-
ReceiptFooter: 'RECEIPT_FOOTER'
|
|
23796
|
-
} as const;
|
|
23797
|
-
|
|
23798
|
-
export type SYNCKEY = typeof SYNCKEY[keyof typeof SYNCKEY];
|
|
23799
|
-
|
|
23800
|
-
|
|
23801
25339
|
/**
|
|
23802
25340
|
*
|
|
23803
25341
|
* @export
|
|
@@ -24042,11 +25580,11 @@ export interface SendCashReportDto {
|
|
|
24042
25580
|
*/
|
|
24043
25581
|
'recipient': string;
|
|
24044
25582
|
/**
|
|
24045
|
-
* The IANA timezone the report\'s times are printed in
|
|
25583
|
+
* The IANA timezone the report\'s times are printed in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
24046
25584
|
* @type {string}
|
|
24047
25585
|
* @memberof SendCashReportDto
|
|
24048
25586
|
*/
|
|
24049
|
-
'timezone'
|
|
25587
|
+
'timezone'?: string;
|
|
24050
25588
|
}
|
|
24051
25589
|
/**
|
|
24052
25590
|
*
|
|
@@ -28533,13 +30071,13 @@ export interface UnifiedProductDto {
|
|
|
28533
30071
|
*/
|
|
28534
30072
|
'quantity': number;
|
|
28535
30073
|
/**
|
|
28536
|
-
* Unit price of the product, in
|
|
30074
|
+
* 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
|
|
28537
30075
|
* @type {number}
|
|
28538
30076
|
* @memberof UnifiedProductDto
|
|
28539
30077
|
*/
|
|
28540
30078
|
'unitPrice': number;
|
|
28541
30079
|
/**
|
|
28542
|
-
* Actual paid price of the product, in
|
|
30080
|
+
* 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
|
|
28543
30081
|
* @type {number}
|
|
28544
30082
|
* @memberof UnifiedProductDto
|
|
28545
30083
|
*/
|
|
@@ -28708,13 +30246,13 @@ export interface UnifiedSubOptionDto {
|
|
|
28708
30246
|
*/
|
|
28709
30247
|
'name': string;
|
|
28710
30248
|
/**
|
|
28711
|
-
* Unit price of the sub-option, in
|
|
30249
|
+
* Unit price of the sub-option, in the order\'s currency (not minor units)
|
|
28712
30250
|
* @type {number}
|
|
28713
30251
|
* @memberof UnifiedSubOptionDto
|
|
28714
30252
|
*/
|
|
28715
30253
|
'unitPrice': number;
|
|
28716
30254
|
/**
|
|
28717
|
-
* Actual paid price of the sub-option, in
|
|
30255
|
+
* 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
|
|
28718
30256
|
* @type {number}
|
|
28719
30257
|
* @memberof UnifiedSubOptionDto
|
|
28720
30258
|
*/
|
|
@@ -29231,6 +30769,30 @@ export interface UpdateReservationPolicyDto {
|
|
|
29231
30769
|
* @memberof UpdateReservationPolicyDto
|
|
29232
30770
|
*/
|
|
29233
30771
|
'maxOnlinePartySize'?: number;
|
|
30772
|
+
/**
|
|
30773
|
+
* The smallest party offered slots online; 1 on create when absent
|
|
30774
|
+
* @type {number}
|
|
30775
|
+
* @memberof UpdateReservationPolicyDto
|
|
30776
|
+
*/
|
|
30777
|
+
'minPartySize'?: number;
|
|
30778
|
+
/**
|
|
30779
|
+
* How many days after today a guest may book: a later day offers no slots; 60 on create when absent
|
|
30780
|
+
* @type {number}
|
|
30781
|
+
* @memberof UpdateReservationPolicyDto
|
|
30782
|
+
*/
|
|
30783
|
+
'maxHorizonDays'?: number;
|
|
30784
|
+
/**
|
|
30785
|
+
* 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
|
|
30786
|
+
* @type {number}
|
|
30787
|
+
* @memberof UpdateReservationPolicyDto
|
|
30788
|
+
*/
|
|
30789
|
+
'cutoffMins'?: number;
|
|
30790
|
+
/**
|
|
30791
|
+
* 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
|
|
30792
|
+
* @type {{ [key: string]: number; }}
|
|
30793
|
+
* @memberof UpdateReservationPolicyDto
|
|
30794
|
+
*/
|
|
30795
|
+
'turnTimeByPartySize'?: { [key: string]: number; };
|
|
29234
30796
|
}
|
|
29235
30797
|
/**
|
|
29236
30798
|
*
|
|
@@ -30183,13 +31745,13 @@ export interface ValidateGiftCardResponseDtoCardInfo {
|
|
|
30183
31745
|
*/
|
|
30184
31746
|
'title': string;
|
|
30185
31747
|
/**
|
|
30186
|
-
* What is left on the card, in euros
|
|
31748
|
+
* What is left on the card, in units of its currency (euros for EUR, not cents)
|
|
30187
31749
|
* @type {number}
|
|
30188
31750
|
* @memberof ValidateGiftCardResponseDtoCardInfo
|
|
30189
31751
|
*/
|
|
30190
31752
|
'balance': number;
|
|
30191
31753
|
/**
|
|
30192
|
-
* The card\'s currency code;
|
|
31754
|
+
* The card\'s currency code; the venue\'s currency when Luckiefun sends none
|
|
30193
31755
|
* @type {string}
|
|
30194
31756
|
* @memberof ValidateGiftCardResponseDtoCardInfo
|
|
30195
31757
|
*/
|
|
@@ -30298,6 +31860,18 @@ export interface VendureSellerUpsertDto {
|
|
|
30298
31860
|
* @memberof VendureSellerUpsertDto
|
|
30299
31861
|
*/
|
|
30300
31862
|
'timezone'?: string | null;
|
|
31863
|
+
/**
|
|
31864
|
+
* 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
|
|
31865
|
+
* @type {string}
|
|
31866
|
+
* @memberof VendureSellerUpsertDto
|
|
31867
|
+
*/
|
|
31868
|
+
'country_code'?: string | null;
|
|
31869
|
+
/**
|
|
31870
|
+
* 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
|
|
31871
|
+
* @type {string}
|
|
31872
|
+
* @memberof VendureSellerUpsertDto
|
|
31873
|
+
*/
|
|
31874
|
+
'currency'?: string | null;
|
|
30301
31875
|
/**
|
|
30302
31876
|
* Whether the venue is in use. Vendure sends false when the seller is deleted
|
|
30303
31877
|
* @type {boolean}
|
|
@@ -34354,12 +35928,13 @@ export const BusinessApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
34354
35928
|
};
|
|
34355
35929
|
},
|
|
34356
35930
|
/**
|
|
34357
|
-
* Read from Vendure
|
|
35931
|
+
* 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.
|
|
34358
35932
|
* @summary List the enabled tax rates
|
|
35933
|
+
* @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
|
|
34359
35934
|
* @param {*} [options] Override http request option.
|
|
34360
35935
|
* @throws {RequiredError}
|
|
34361
35936
|
*/
|
|
34362
|
-
getBusinessTax: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
35937
|
+
getBusinessTax: async (businessId?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
34363
35938
|
const localVarPath = `/api/v1/business/tax`;
|
|
34364
35939
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
34365
35940
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -34376,6 +35951,10 @@ export const BusinessApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
34376
35951
|
// http bearer authentication required
|
|
34377
35952
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
34378
35953
|
|
|
35954
|
+
if (businessId !== undefined) {
|
|
35955
|
+
localVarQueryParameter['businessId'] = businessId;
|
|
35956
|
+
}
|
|
35957
|
+
|
|
34379
35958
|
|
|
34380
35959
|
|
|
34381
35960
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -34703,13 +36282,14 @@ export const BusinessApiFp = function(configuration?: Configuration) {
|
|
|
34703
36282
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
34704
36283
|
},
|
|
34705
36284
|
/**
|
|
34706
|
-
* Read from Vendure
|
|
36285
|
+
* 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.
|
|
34707
36286
|
* @summary List the enabled tax rates
|
|
36287
|
+
* @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
|
|
34708
36288
|
* @param {*} [options] Override http request option.
|
|
34709
36289
|
* @throws {RequiredError}
|
|
34710
36290
|
*/
|
|
34711
|
-
async getBusinessTax(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BusinessTaxResponseDto>>> {
|
|
34712
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusinessTax(options);
|
|
36291
|
+
async getBusinessTax(businessId?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BusinessTaxResponseDto>>> {
|
|
36292
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBusinessTax(businessId, options);
|
|
34713
36293
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
34714
36294
|
},
|
|
34715
36295
|
/**
|
|
@@ -34890,13 +36470,14 @@ export const BusinessApiFactory = function (configuration?: Configuration, baseP
|
|
|
34890
36470
|
return localVarFp.getBusinessProviderStatus(businessId, options).then((request) => request(axios, basePath));
|
|
34891
36471
|
},
|
|
34892
36472
|
/**
|
|
34893
|
-
* Read from Vendure
|
|
36473
|
+
* 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.
|
|
34894
36474
|
* @summary List the enabled tax rates
|
|
36475
|
+
* @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
|
|
34895
36476
|
* @param {*} [options] Override http request option.
|
|
34896
36477
|
* @throws {RequiredError}
|
|
34897
36478
|
*/
|
|
34898
|
-
getBusinessTax(options?: any): AxiosPromise<Array<BusinessTaxResponseDto>> {
|
|
34899
|
-
return localVarFp.getBusinessTax(options).then((request) => request(axios, basePath));
|
|
36479
|
+
getBusinessTax(businessId?: number, options?: any): AxiosPromise<Array<BusinessTaxResponseDto>> {
|
|
36480
|
+
return localVarFp.getBusinessTax(businessId, options).then((request) => request(axios, basePath));
|
|
34900
36481
|
},
|
|
34901
36482
|
/**
|
|
34902
36483
|
* 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.
|
|
@@ -35071,13 +36652,14 @@ export interface BusinessApiInterface {
|
|
|
35071
36652
|
getBusinessProviderStatus(businessId: string, options?: AxiosRequestConfig): AxiosPromise<Array<ProviderStatusResponseDto>>;
|
|
35072
36653
|
|
|
35073
36654
|
/**
|
|
35074
|
-
* Read from Vendure
|
|
36655
|
+
* 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.
|
|
35075
36656
|
* @summary List the enabled tax rates
|
|
36657
|
+
* @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
|
|
35076
36658
|
* @param {*} [options] Override http request option.
|
|
35077
36659
|
* @throws {RequiredError}
|
|
35078
36660
|
* @memberof BusinessApiInterface
|
|
35079
36661
|
*/
|
|
35080
|
-
getBusinessTax(options?: AxiosRequestConfig): AxiosPromise<Array<BusinessTaxResponseDto>>;
|
|
36662
|
+
getBusinessTax(businessId?: number, options?: AxiosRequestConfig): AxiosPromise<Array<BusinessTaxResponseDto>>;
|
|
35081
36663
|
|
|
35082
36664
|
/**
|
|
35083
36665
|
* 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.
|
|
@@ -35274,14 +36856,15 @@ export class BusinessApi extends BaseAPI implements BusinessApiInterface {
|
|
|
35274
36856
|
}
|
|
35275
36857
|
|
|
35276
36858
|
/**
|
|
35277
|
-
* Read from Vendure
|
|
36859
|
+
* 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.
|
|
35278
36860
|
* @summary List the enabled tax rates
|
|
36861
|
+
* @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
|
|
35279
36862
|
* @param {*} [options] Override http request option.
|
|
35280
36863
|
* @throws {RequiredError}
|
|
35281
36864
|
* @memberof BusinessApi
|
|
35282
36865
|
*/
|
|
35283
|
-
public getBusinessTax(options?: AxiosRequestConfig) {
|
|
35284
|
-
return BusinessApiFp(this.configuration).getBusinessTax(options).then((request) => request(this.axios, this.basePath));
|
|
36866
|
+
public getBusinessTax(businessId?: number, options?: AxiosRequestConfig) {
|
|
36867
|
+
return BusinessApiFp(this.configuration).getBusinessTax(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
35285
36868
|
}
|
|
35286
36869
|
|
|
35287
36870
|
/**
|
|
@@ -35534,7 +37117,7 @@ export const CashManagementApiAxiosParamCreator = function (configuration?: Conf
|
|
|
35534
37117
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
35535
37118
|
* @param {number} [page] The page to read, from 1
|
|
35536
37119
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
35537
|
-
* @param {string} [timezone] IANA timezone the period is read in
|
|
37120
|
+
* @param {string} [timezone] IANA timezone the period is read in. Absent: the venue\'s own time zone (Business.timeZone)
|
|
35538
37121
|
* @param {*} [options] Override http request option.
|
|
35539
37122
|
* @throws {RequiredError}
|
|
35540
37123
|
*/
|
|
@@ -35801,7 +37384,7 @@ export const CashManagementApiFp = function(configuration?: Configuration) {
|
|
|
35801
37384
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
35802
37385
|
* @param {number} [page] The page to read, from 1
|
|
35803
37386
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
35804
|
-
* @param {string} [timezone] IANA timezone the period is read in
|
|
37387
|
+
* @param {string} [timezone] IANA timezone the period is read in. Absent: the venue\'s own time zone (Business.timeZone)
|
|
35805
37388
|
* @param {*} [options] Override http request option.
|
|
35806
37389
|
* @throws {RequiredError}
|
|
35807
37390
|
*/
|
|
@@ -35888,7 +37471,7 @@ export const CashManagementApiFactory = function (configuration?: Configuration,
|
|
|
35888
37471
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
35889
37472
|
* @param {number} [page] The page to read, from 1
|
|
35890
37473
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
35891
|
-
* @param {string} [timezone] IANA timezone the period is read in
|
|
37474
|
+
* @param {string} [timezone] IANA timezone the period is read in. Absent: the venue\'s own time zone (Business.timeZone)
|
|
35892
37475
|
* @param {*} [options] Override http request option.
|
|
35893
37476
|
* @throws {RequiredError}
|
|
35894
37477
|
*/
|
|
@@ -35969,7 +37552,7 @@ export interface CashManagementApiInterface {
|
|
|
35969
37552
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
35970
37553
|
* @param {number} [page] The page to read, from 1
|
|
35971
37554
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
35972
|
-
* @param {string} [timezone] IANA timezone the period is read in
|
|
37555
|
+
* @param {string} [timezone] IANA timezone the period is read in. Absent: the venue\'s own time zone (Business.timeZone)
|
|
35973
37556
|
* @param {*} [options] Override http request option.
|
|
35974
37557
|
* @throws {RequiredError}
|
|
35975
37558
|
* @memberof CashManagementApiInterface
|
|
@@ -36052,7 +37635,7 @@ export class CashManagementApi extends BaseAPI implements CashManagementApiInter
|
|
|
36052
37635
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
36053
37636
|
* @param {number} [page] The page to read, from 1
|
|
36054
37637
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
36055
|
-
* @param {string} [timezone] IANA timezone the period is read in
|
|
37638
|
+
* @param {string} [timezone] IANA timezone the period is read in. Absent: the venue\'s own time zone (Business.timeZone)
|
|
36056
37639
|
* @param {*} [options] Override http request option.
|
|
36057
37640
|
* @throws {RequiredError}
|
|
36058
37641
|
* @memberof CashManagementApi
|
|
@@ -36131,7 +37714,7 @@ export const CashManagementV6ApiAxiosParamCreator = function (configuration?: Co
|
|
|
36131
37714
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
36132
37715
|
* @param {number} [page] The page to read, from 1
|
|
36133
37716
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
36134
|
-
* @param {string} [timezone] Timezone of the period asked for
|
|
37717
|
+
* @param {string} [timezone] Timezone of the period asked for. Absent: the venue\'s own time zone (Business.timeZone)
|
|
36135
37718
|
* @param {*} [options] Override http request option.
|
|
36136
37719
|
* @throws {RequiredError}
|
|
36137
37720
|
*/
|
|
@@ -36209,7 +37792,7 @@ export const CashManagementV6ApiFp = function(configuration?: Configuration) {
|
|
|
36209
37792
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
36210
37793
|
* @param {number} [page] The page to read, from 1
|
|
36211
37794
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
36212
|
-
* @param {string} [timezone] Timezone of the period asked for
|
|
37795
|
+
* @param {string} [timezone] Timezone of the period asked for. Absent: the venue\'s own time zone (Business.timeZone)
|
|
36213
37796
|
* @param {*} [options] Override http request option.
|
|
36214
37797
|
* @throws {RequiredError}
|
|
36215
37798
|
*/
|
|
@@ -36236,7 +37819,7 @@ export const CashManagementV6ApiFactory = function (configuration?: Configuratio
|
|
|
36236
37819
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
36237
37820
|
* @param {number} [page] The page to read, from 1
|
|
36238
37821
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
36239
|
-
* @param {string} [timezone] Timezone of the period asked for
|
|
37822
|
+
* @param {string} [timezone] Timezone of the period asked for. Absent: the venue\'s own time zone (Business.timeZone)
|
|
36240
37823
|
* @param {*} [options] Override http request option.
|
|
36241
37824
|
* @throws {RequiredError}
|
|
36242
37825
|
*/
|
|
@@ -36261,7 +37844,7 @@ export interface CashManagementV6ApiInterface {
|
|
|
36261
37844
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
36262
37845
|
* @param {number} [page] The page to read, from 1
|
|
36263
37846
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
36264
|
-
* @param {string} [timezone] Timezone of the period asked for
|
|
37847
|
+
* @param {string} [timezone] Timezone of the period asked for. Absent: the venue\'s own time zone (Business.timeZone)
|
|
36265
37848
|
* @param {*} [options] Override http request option.
|
|
36266
37849
|
* @throws {RequiredError}
|
|
36267
37850
|
* @memberof CashManagementV6ApiInterface
|
|
@@ -36286,7 +37869,7 @@ export class CashManagementV6Api extends BaseAPI implements CashManagementV6ApiI
|
|
|
36286
37869
|
* @param {string} [end] The period\'s end, ISO 8601. Required when timeSpan is CUSTOM; an end after now reads until now.
|
|
36287
37870
|
* @param {number} [page] The page to read, from 1
|
|
36288
37871
|
* @param {number} [rowPerPage] How many entries a page holds
|
|
36289
|
-
* @param {string} [timezone] Timezone of the period asked for
|
|
37872
|
+
* @param {string} [timezone] Timezone of the period asked for. Absent: the venue\'s own time zone (Business.timeZone)
|
|
36290
37873
|
* @param {*} [options] Override http request option.
|
|
36291
37874
|
* @throws {RequiredError}
|
|
36292
37875
|
* @memberof CashManagementV6Api
|
|
@@ -37016,7 +38599,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
37016
38599
|
};
|
|
37017
38600
|
},
|
|
37018
38601
|
/**
|
|
37019
|
-
* 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.
|
|
38602
|
+
* 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.
|
|
37020
38603
|
* @summary Create or update a venue
|
|
37021
38604
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37022
38605
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -37060,7 +38643,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
37060
38643
|
};
|
|
37061
38644
|
},
|
|
37062
38645
|
/**
|
|
37063
|
-
* A new config is saved in Europe/Helsinki unless the body says otherwise.
|
|
38646
|
+
* 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.
|
|
37064
38647
|
* @summary Create or update a channel\'s config
|
|
37065
38648
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37066
38649
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
@@ -37162,7 +38745,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
37162
38745
|
};
|
|
37163
38746
|
},
|
|
37164
38747
|
/**
|
|
37165
|
-
* The secret is stored encrypted. A new program needs name, apiBaseUrl and secretKey. The venue\'s cached config and loyalty settings are cleared.
|
|
38748
|
+
* 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.
|
|
37166
38749
|
* @summary Create or update a loyalty program and link it to a venue
|
|
37167
38750
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37168
38751
|
* @param {UpsertLoyaltyDto} upsertLoyaltyDto
|
|
@@ -37535,7 +39118,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
37535
39118
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
37536
39119
|
},
|
|
37537
39120
|
/**
|
|
37538
|
-
* 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.
|
|
39121
|
+
* 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.
|
|
37539
39122
|
* @summary Create or update a venue
|
|
37540
39123
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37541
39124
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -37547,7 +39130,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
37547
39130
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
37548
39131
|
},
|
|
37549
39132
|
/**
|
|
37550
|
-
* A new config is saved in Europe/Helsinki unless the body says otherwise.
|
|
39133
|
+
* 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.
|
|
37551
39134
|
* @summary Create or update a channel\'s config
|
|
37552
39135
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37553
39136
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
@@ -37573,7 +39156,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
37573
39156
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
37574
39157
|
},
|
|
37575
39158
|
/**
|
|
37576
|
-
* The secret is stored encrypted. A new program needs name, apiBaseUrl and secretKey. The venue\'s cached config and loyalty settings are cleared.
|
|
39159
|
+
* 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.
|
|
37577
39160
|
* @summary Create or update a loyalty program and link it to a venue
|
|
37578
39161
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37579
39162
|
* @param {UpsertLoyaltyDto} upsertLoyaltyDto
|
|
@@ -37719,7 +39302,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
37719
39302
|
return localVarFp.configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options).then((request) => request(axios, basePath));
|
|
37720
39303
|
},
|
|
37721
39304
|
/**
|
|
37722
|
-
* 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.
|
|
39305
|
+
* 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.
|
|
37723
39306
|
* @summary Create or update a venue
|
|
37724
39307
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37725
39308
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -37730,7 +39313,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
37730
39313
|
return localVarFp.configUpsertBusiness(businessId, upsertBusinessDto, options).then((request) => request(axios, basePath));
|
|
37731
39314
|
},
|
|
37732
39315
|
/**
|
|
37733
|
-
* A new config is saved in Europe/Helsinki unless the body says otherwise.
|
|
39316
|
+
* 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.
|
|
37734
39317
|
* @summary Create or update a channel\'s config
|
|
37735
39318
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37736
39319
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
@@ -37754,7 +39337,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
37754
39337
|
return localVarFp.configUpsertGiftCard(businessId, xAppX, upsertGiftCardDto, options).then((request) => request(axios, basePath));
|
|
37755
39338
|
},
|
|
37756
39339
|
/**
|
|
37757
|
-
* The secret is stored encrypted. A new program needs name, apiBaseUrl and secretKey. The venue\'s cached config and loyalty settings are cleared.
|
|
39340
|
+
* 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.
|
|
37758
39341
|
* @summary Create or update a loyalty program and link it to a venue
|
|
37759
39342
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37760
39343
|
* @param {UpsertLoyaltyDto} upsertLoyaltyDto
|
|
@@ -37893,7 +39476,7 @@ export interface ConfigManagementApiInterface {
|
|
|
37893
39476
|
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
37894
39477
|
|
|
37895
39478
|
/**
|
|
37896
|
-
* 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.
|
|
39479
|
+
* 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.
|
|
37897
39480
|
* @summary Create or update a venue
|
|
37898
39481
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37899
39482
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -37904,7 +39487,7 @@ export interface ConfigManagementApiInterface {
|
|
|
37904
39487
|
configUpsertBusiness(businessId: number, upsertBusinessDto: UpsertBusinessDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
37905
39488
|
|
|
37906
39489
|
/**
|
|
37907
|
-
* A new config is saved in Europe/Helsinki unless the body says otherwise.
|
|
39490
|
+
* 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.
|
|
37908
39491
|
* @summary Create or update a channel\'s config
|
|
37909
39492
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37910
39493
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
@@ -37928,7 +39511,7 @@ export interface ConfigManagementApiInterface {
|
|
|
37928
39511
|
configUpsertGiftCard(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay', upsertGiftCardDto: UpsertGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
37929
39512
|
|
|
37930
39513
|
/**
|
|
37931
|
-
* The secret is stored encrypted. A new program needs name, apiBaseUrl and secretKey. The venue\'s cached config and loyalty settings are cleared.
|
|
39514
|
+
* 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.
|
|
37932
39515
|
* @summary Create or update a loyalty program and link it to a venue
|
|
37933
39516
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
37934
39517
|
* @param {UpsertLoyaltyDto} upsertLoyaltyDto
|
|
@@ -38077,7 +39660,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
38077
39660
|
}
|
|
38078
39661
|
|
|
38079
39662
|
/**
|
|
38080
|
-
* 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.
|
|
39663
|
+
* 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.
|
|
38081
39664
|
* @summary Create or update a venue
|
|
38082
39665
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38083
39666
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -38090,7 +39673,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
38090
39673
|
}
|
|
38091
39674
|
|
|
38092
39675
|
/**
|
|
38093
|
-
* A new config is saved in Europe/Helsinki unless the body says otherwise.
|
|
39676
|
+
* 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.
|
|
38094
39677
|
* @summary Create or update a channel\'s config
|
|
38095
39678
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38096
39679
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay'} xAppX The app channel whose config is read or written
|
|
@@ -38118,7 +39701,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
38118
39701
|
}
|
|
38119
39702
|
|
|
38120
39703
|
/**
|
|
38121
|
-
* The secret is stored encrypted. A new program needs name, apiBaseUrl and secretKey. The venue\'s cached config and loyalty settings are cleared.
|
|
39704
|
+
* 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.
|
|
38122
39705
|
* @summary Create or update a loyalty program and link it to a venue
|
|
38123
39706
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
38124
39707
|
* @param {UpsertLoyaltyDto} upsertLoyaltyDto
|
|
@@ -40482,7 +42065,7 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
40482
42065
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
40483
42066
|
* @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.
|
|
40484
42067
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
40485
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42068
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
40486
42069
|
* @param {*} [options] Override http request option.
|
|
40487
42070
|
* @deprecated
|
|
40488
42071
|
* @throws {RequiredError}
|
|
@@ -40589,7 +42172,7 @@ export const HistoryApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
40589
42172
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
40590
42173
|
* @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.
|
|
40591
42174
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
40592
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42175
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
40593
42176
|
* @param {*} [options] Override http request option.
|
|
40594
42177
|
* @throws {RequiredError}
|
|
40595
42178
|
*/
|
|
@@ -40705,7 +42288,7 @@ export const HistoryApiFp = function(configuration?: Configuration) {
|
|
|
40705
42288
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
40706
42289
|
* @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.
|
|
40707
42290
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
40708
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42291
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
40709
42292
|
* @param {*} [options] Override http request option.
|
|
40710
42293
|
* @deprecated
|
|
40711
42294
|
* @throws {RequiredError}
|
|
@@ -40730,7 +42313,7 @@ export const HistoryApiFp = function(configuration?: Configuration) {
|
|
|
40730
42313
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
40731
42314
|
* @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.
|
|
40732
42315
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
40733
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42316
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
40734
42317
|
* @param {*} [options] Override http request option.
|
|
40735
42318
|
* @throws {RequiredError}
|
|
40736
42319
|
*/
|
|
@@ -40764,7 +42347,7 @@ export const HistoryApiFactory = function (configuration?: Configuration, basePa
|
|
|
40764
42347
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
40765
42348
|
* @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.
|
|
40766
42349
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
40767
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42350
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
40768
42351
|
* @param {*} [options] Override http request option.
|
|
40769
42352
|
* @deprecated
|
|
40770
42353
|
* @throws {RequiredError}
|
|
@@ -40788,7 +42371,7 @@ export const HistoryApiFactory = function (configuration?: Configuration, basePa
|
|
|
40788
42371
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
40789
42372
|
* @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.
|
|
40790
42373
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
40791
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42374
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
40792
42375
|
* @param {*} [options] Override http request option.
|
|
40793
42376
|
* @throws {RequiredError}
|
|
40794
42377
|
*/
|
|
@@ -40820,7 +42403,7 @@ export interface HistoryApiInterface {
|
|
|
40820
42403
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
40821
42404
|
* @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.
|
|
40822
42405
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
40823
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42406
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
40824
42407
|
* @param {*} [options] Override http request option.
|
|
40825
42408
|
* @deprecated
|
|
40826
42409
|
* @throws {RequiredError}
|
|
@@ -40844,7 +42427,7 @@ export interface HistoryApiInterface {
|
|
|
40844
42427
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
40845
42428
|
* @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.
|
|
40846
42429
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
40847
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42430
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
40848
42431
|
* @param {*} [options] Override http request option.
|
|
40849
42432
|
* @throws {RequiredError}
|
|
40850
42433
|
* @memberof HistoryApiInterface
|
|
@@ -40876,7 +42459,7 @@ export class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
40876
42459
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
40877
42460
|
* @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.
|
|
40878
42461
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
40879
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42462
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
40880
42463
|
* @param {*} [options] Override http request option.
|
|
40881
42464
|
* @deprecated
|
|
40882
42465
|
* @throws {RequiredError}
|
|
@@ -40902,7 +42485,7 @@ export class HistoryApi extends BaseAPI implements HistoryApiInterface {
|
|
|
40902
42485
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
40903
42486
|
* @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.
|
|
40904
42487
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
40905
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42488
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
40906
42489
|
* @param {*} [options] Override http request option.
|
|
40907
42490
|
* @throws {RequiredError}
|
|
40908
42491
|
* @memberof HistoryApi
|
|
@@ -40935,7 +42518,7 @@ export const HistoryV6ApiAxiosParamCreator = function (configuration?: Configura
|
|
|
40935
42518
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
40936
42519
|
* @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.
|
|
40937
42520
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
40938
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42521
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
40939
42522
|
* @param {*} [options] Override http request option.
|
|
40940
42523
|
* @throws {RequiredError}
|
|
40941
42524
|
*/
|
|
@@ -41037,7 +42620,7 @@ export const HistoryV6ApiAxiosParamCreator = function (configuration?: Configura
|
|
|
41037
42620
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41038
42621
|
* @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.
|
|
41039
42622
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41040
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42623
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41041
42624
|
* @param {*} [options] Override http request option.
|
|
41042
42625
|
* @throws {RequiredError}
|
|
41043
42626
|
*/
|
|
@@ -41143,7 +42726,7 @@ export const HistoryV6ApiAxiosParamCreator = function (configuration?: Configura
|
|
|
41143
42726
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41144
42727
|
* @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.
|
|
41145
42728
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41146
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42729
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41147
42730
|
* @param {*} [options] Override http request option.
|
|
41148
42731
|
* @throws {RequiredError}
|
|
41149
42732
|
*/
|
|
@@ -41259,7 +42842,7 @@ export const HistoryV6ApiFp = function(configuration?: Configuration) {
|
|
|
41259
42842
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41260
42843
|
* @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.
|
|
41261
42844
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41262
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42845
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41263
42846
|
* @param {*} [options] Override http request option.
|
|
41264
42847
|
* @throws {RequiredError}
|
|
41265
42848
|
*/
|
|
@@ -41283,7 +42866,7 @@ export const HistoryV6ApiFp = function(configuration?: Configuration) {
|
|
|
41283
42866
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41284
42867
|
* @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.
|
|
41285
42868
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41286
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42869
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41287
42870
|
* @param {*} [options] Override http request option.
|
|
41288
42871
|
* @throws {RequiredError}
|
|
41289
42872
|
*/
|
|
@@ -41307,7 +42890,7 @@ export const HistoryV6ApiFp = function(configuration?: Configuration) {
|
|
|
41307
42890
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41308
42891
|
* @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.
|
|
41309
42892
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41310
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42893
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41311
42894
|
* @param {*} [options] Override http request option.
|
|
41312
42895
|
* @throws {RequiredError}
|
|
41313
42896
|
*/
|
|
@@ -41341,7 +42924,7 @@ export const HistoryV6ApiFactory = function (configuration?: Configuration, base
|
|
|
41341
42924
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41342
42925
|
* @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.
|
|
41343
42926
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41344
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42927
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41345
42928
|
* @param {*} [options] Override http request option.
|
|
41346
42929
|
* @throws {RequiredError}
|
|
41347
42930
|
*/
|
|
@@ -41364,7 +42947,7 @@ export const HistoryV6ApiFactory = function (configuration?: Configuration, base
|
|
|
41364
42947
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41365
42948
|
* @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.
|
|
41366
42949
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41367
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42950
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41368
42951
|
* @param {*} [options] Override http request option.
|
|
41369
42952
|
* @throws {RequiredError}
|
|
41370
42953
|
*/
|
|
@@ -41387,7 +42970,7 @@ export const HistoryV6ApiFactory = function (configuration?: Configuration, base
|
|
|
41387
42970
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41388
42971
|
* @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.
|
|
41389
42972
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41390
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
42973
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41391
42974
|
* @param {*} [options] Override http request option.
|
|
41392
42975
|
* @throws {RequiredError}
|
|
41393
42976
|
*/
|
|
@@ -41419,7 +43002,7 @@ export interface HistoryV6ApiInterface {
|
|
|
41419
43002
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41420
43003
|
* @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.
|
|
41421
43004
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41422
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
43005
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41423
43006
|
* @param {*} [options] Override http request option.
|
|
41424
43007
|
* @throws {RequiredError}
|
|
41425
43008
|
* @memberof HistoryV6ApiInterface
|
|
@@ -41442,7 +43025,7 @@ export interface HistoryV6ApiInterface {
|
|
|
41442
43025
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41443
43026
|
* @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.
|
|
41444
43027
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41445
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
43028
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41446
43029
|
* @param {*} [options] Override http request option.
|
|
41447
43030
|
* @throws {RequiredError}
|
|
41448
43031
|
* @memberof HistoryV6ApiInterface
|
|
@@ -41465,7 +43048,7 @@ export interface HistoryV6ApiInterface {
|
|
|
41465
43048
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41466
43049
|
* @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.
|
|
41467
43050
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41468
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
43051
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41469
43052
|
* @param {*} [options] Override http request option.
|
|
41470
43053
|
* @throws {RequiredError}
|
|
41471
43054
|
* @memberof HistoryV6ApiInterface
|
|
@@ -41497,7 +43080,7 @@ export class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterface {
|
|
|
41497
43080
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41498
43081
|
* @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.
|
|
41499
43082
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41500
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
43083
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41501
43084
|
* @param {*} [options] Override http request option.
|
|
41502
43085
|
* @throws {RequiredError}
|
|
41503
43086
|
* @memberof HistoryV6Api
|
|
@@ -41522,7 +43105,7 @@ export class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterface {
|
|
|
41522
43105
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41523
43106
|
* @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.
|
|
41524
43107
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41525
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
43108
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41526
43109
|
* @param {*} [options] Override http request option.
|
|
41527
43110
|
* @throws {RequiredError}
|
|
41528
43111
|
* @memberof HistoryV6Api
|
|
@@ -41547,7 +43130,7 @@ export class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterface {
|
|
|
41547
43130
|
* @param {Array<OrderType>} [orderType] Keep the orders of these types. Absent: every type.
|
|
41548
43131
|
* @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.
|
|
41549
43132
|
* @param {string} [invoiceCompanyId] Keep the orders invoiced to this company id. Absent: every order. The online order history does not read it.
|
|
41550
|
-
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent:
|
|
43133
|
+
* @param {string} [timezone] The IANA timezone the period\'s days are counted in. Absent: the venue\'s own time zone (Business.timeZone).
|
|
41551
43134
|
* @param {*} [options] Override http request option.
|
|
41552
43135
|
* @throws {RequiredError}
|
|
41553
43136
|
* @memberof HistoryV6Api
|
|
@@ -41782,7 +43365,7 @@ export const InvoiceCompaniesApiAxiosParamCreator = function (configuration?: Co
|
|
|
41782
43365
|
};
|
|
41783
43366
|
},
|
|
41784
43367
|
/**
|
|
41785
|
-
* 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
|
|
43368
|
+
* 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.
|
|
41786
43369
|
* @summary Update an invoice company
|
|
41787
43370
|
* @param {string} id The company\'s id
|
|
41788
43371
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -41901,7 +43484,7 @@ export const InvoiceCompaniesApiFp = function(configuration?: Configuration) {
|
|
|
41901
43484
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41902
43485
|
},
|
|
41903
43486
|
/**
|
|
41904
|
-
* 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
|
|
43487
|
+
* 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.
|
|
41905
43488
|
* @summary Update an invoice company
|
|
41906
43489
|
* @param {string} id The company\'s id
|
|
41907
43490
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -41977,7 +43560,7 @@ export const InvoiceCompaniesApiFactory = function (configuration?: Configuratio
|
|
|
41977
43560
|
return localVarFp.searchInvoiceCompanies(businessId, search, options).then((request) => request(axios, basePath));
|
|
41978
43561
|
},
|
|
41979
43562
|
/**
|
|
41980
|
-
* 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
|
|
43563
|
+
* 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.
|
|
41981
43564
|
* @summary Update an invoice company
|
|
41982
43565
|
* @param {string} id The company\'s id
|
|
41983
43566
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -42051,7 +43634,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
42051
43634
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): AxiosPromise<Array<InvoiceCompanyResponseDto>>;
|
|
42052
43635
|
|
|
42053
43636
|
/**
|
|
42054
|
-
* 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
|
|
43637
|
+
* 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.
|
|
42055
43638
|
* @summary Update an invoice company
|
|
42056
43639
|
* @param {string} id The company\'s id
|
|
42057
43640
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -42135,7 +43718,7 @@ export class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompaniesApiI
|
|
|
42135
43718
|
}
|
|
42136
43719
|
|
|
42137
43720
|
/**
|
|
42138
|
-
* 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
|
|
43721
|
+
* 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.
|
|
42139
43722
|
* @summary Update an invoice company
|
|
42140
43723
|
* @param {string} id The company\'s id
|
|
42141
43724
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -42327,6 +43910,46 @@ export const KDSApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
42327
43910
|
options: localVarRequestOptions,
|
|
42328
43911
|
};
|
|
42329
43912
|
},
|
|
43913
|
+
/**
|
|
43914
|
+
* 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.
|
|
43915
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
43916
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
43917
|
+
* @param {*} [options] Override http request option.
|
|
43918
|
+
* @throws {RequiredError}
|
|
43919
|
+
*/
|
|
43920
|
+
kdsMarkOrdersReady: async (kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43921
|
+
// verify required parameter 'kdsMarkOrdersReadyDto' is not null or undefined
|
|
43922
|
+
assertParamExists('kdsMarkOrdersReady', 'kdsMarkOrdersReadyDto', kdsMarkOrdersReadyDto)
|
|
43923
|
+
const localVarPath = `/api/v1/kds/orders/ready`;
|
|
43924
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43925
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43926
|
+
let baseOptions;
|
|
43927
|
+
if (configuration) {
|
|
43928
|
+
baseOptions = configuration.baseOptions;
|
|
43929
|
+
}
|
|
43930
|
+
|
|
43931
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
43932
|
+
const localVarHeaderParameter = {} as any;
|
|
43933
|
+
const localVarQueryParameter = {} as any;
|
|
43934
|
+
|
|
43935
|
+
// authentication JWT-auth required
|
|
43936
|
+
// http bearer authentication required
|
|
43937
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
43938
|
+
|
|
43939
|
+
|
|
43940
|
+
|
|
43941
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
43942
|
+
|
|
43943
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43944
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43945
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
43946
|
+
localVarRequestOptions.data = serializeDataIfNeeded(kdsMarkOrdersReadyDto, localVarRequestOptions, configuration)
|
|
43947
|
+
|
|
43948
|
+
return {
|
|
43949
|
+
url: toPathString(localVarUrlObj),
|
|
43950
|
+
options: localVarRequestOptions,
|
|
43951
|
+
};
|
|
43952
|
+
},
|
|
42330
43953
|
/**
|
|
42331
43954
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
42332
43955
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -42418,6 +44041,17 @@ export const KDSApiFp = function(configuration?: Configuration) {
|
|
|
42418
44041
|
const localVarAxiosArgs = await localVarAxiosParamCreator.kdsMarkOrderReady(id, options);
|
|
42419
44042
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
42420
44043
|
},
|
|
44044
|
+
/**
|
|
44045
|
+
* 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.
|
|
44046
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
44047
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
44048
|
+
* @param {*} [options] Override http request option.
|
|
44049
|
+
* @throws {RequiredError}
|
|
44050
|
+
*/
|
|
44051
|
+
async kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KdsReadyOrdersResponseDto>> {
|
|
44052
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.kdsMarkOrdersReady(kdsMarkOrdersReadyDto, options);
|
|
44053
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
44054
|
+
},
|
|
42421
44055
|
/**
|
|
42422
44056
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
42423
44057
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -42479,6 +44113,16 @@ export const KDSApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
42479
44113
|
kdsMarkOrderReady(id: string, options?: any): AxiosPromise<KdsReadyOrderResponseDto> {
|
|
42480
44114
|
return localVarFp.kdsMarkOrderReady(id, options).then((request) => request(axios, basePath));
|
|
42481
44115
|
},
|
|
44116
|
+
/**
|
|
44117
|
+
* 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.
|
|
44118
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
44119
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
44120
|
+
* @param {*} [options] Override http request option.
|
|
44121
|
+
* @throws {RequiredError}
|
|
44122
|
+
*/
|
|
44123
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: any): AxiosPromise<KdsReadyOrdersResponseDto> {
|
|
44124
|
+
return localVarFp.kdsMarkOrdersReady(kdsMarkOrdersReadyDto, options).then((request) => request(axios, basePath));
|
|
44125
|
+
},
|
|
42482
44126
|
/**
|
|
42483
44127
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
42484
44128
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -42538,6 +44182,16 @@ export interface KDSApiInterface {
|
|
|
42538
44182
|
*/
|
|
42539
44183
|
kdsMarkOrderReady(id: string, options?: AxiosRequestConfig): AxiosPromise<KdsReadyOrderResponseDto>;
|
|
42540
44184
|
|
|
44185
|
+
/**
|
|
44186
|
+
* 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.
|
|
44187
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
44188
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
44189
|
+
* @param {*} [options] Override http request option.
|
|
44190
|
+
* @throws {RequiredError}
|
|
44191
|
+
* @memberof KDSApiInterface
|
|
44192
|
+
*/
|
|
44193
|
+
kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig): AxiosPromise<KdsReadyOrdersResponseDto>;
|
|
44194
|
+
|
|
42541
44195
|
/**
|
|
42542
44196
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
42543
44197
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -42603,6 +44257,18 @@ export class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
|
42603
44257
|
return KDSApiFp(this.configuration).kdsMarkOrderReady(id, options).then((request) => request(this.axios, this.basePath));
|
|
42604
44258
|
}
|
|
42605
44259
|
|
|
44260
|
+
/**
|
|
44261
|
+
* 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.
|
|
44262
|
+
* @summary Mark several of a station\'s kitchen orders ready
|
|
44263
|
+
* @param {KdsMarkOrdersReadyDto} kdsMarkOrdersReadyDto The venue, the station, and the ids of its KDS orders to mark ready
|
|
44264
|
+
* @param {*} [options] Override http request option.
|
|
44265
|
+
* @throws {RequiredError}
|
|
44266
|
+
* @memberof KDSApi
|
|
44267
|
+
*/
|
|
44268
|
+
public kdsMarkOrdersReady(kdsMarkOrdersReadyDto: KdsMarkOrdersReadyDto, options?: AxiosRequestConfig) {
|
|
44269
|
+
return KDSApiFp(this.configuration).kdsMarkOrdersReady(kdsMarkOrdersReadyDto, options).then((request) => request(this.axios, this.basePath));
|
|
44270
|
+
}
|
|
44271
|
+
|
|
42606
44272
|
/**
|
|
42607
44273
|
* Written in kds-service. A failure there is answered with 200 and status false.
|
|
42608
44274
|
* @summary Revert a station\'s kitchen order back to in progress
|
|
@@ -45639,6 +47305,42 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
45639
47305
|
options: localVarRequestOptions,
|
|
45640
47306
|
};
|
|
45641
47307
|
},
|
|
47308
|
+
/**
|
|
47309
|
+
* 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.
|
|
47310
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
47311
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
47312
|
+
* @param {*} [options] Override http request option.
|
|
47313
|
+
* @throws {RequiredError}
|
|
47314
|
+
*/
|
|
47315
|
+
changePosOrdersStatusInBulk: async (changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
47316
|
+
// verify required parameter 'changePosOrdersStatusInBulkDto' is not null or undefined
|
|
47317
|
+
assertParamExists('changePosOrdersStatusInBulk', 'changePosOrdersStatusInBulkDto', changePosOrdersStatusInBulkDto)
|
|
47318
|
+
const localVarPath = `/api/v2/orders/pos/bulk-status`;
|
|
47319
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47320
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
47321
|
+
let baseOptions;
|
|
47322
|
+
if (configuration) {
|
|
47323
|
+
baseOptions = configuration.baseOptions;
|
|
47324
|
+
}
|
|
47325
|
+
|
|
47326
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
47327
|
+
const localVarHeaderParameter = {} as any;
|
|
47328
|
+
const localVarQueryParameter = {} as any;
|
|
47329
|
+
|
|
47330
|
+
|
|
47331
|
+
|
|
47332
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
47333
|
+
|
|
47334
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
47335
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
47336
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
47337
|
+
localVarRequestOptions.data = serializeDataIfNeeded(changePosOrdersStatusInBulkDto, localVarRequestOptions, configuration)
|
|
47338
|
+
|
|
47339
|
+
return {
|
|
47340
|
+
url: toPathString(localVarUrlObj),
|
|
47341
|
+
options: localVarRequestOptions,
|
|
47342
|
+
};
|
|
47343
|
+
},
|
|
45642
47344
|
/**
|
|
45643
47345
|
* 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.
|
|
45644
47346
|
* @summary Confirm a pre-order
|
|
@@ -45712,7 +47414,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
45712
47414
|
};
|
|
45713
47415
|
},
|
|
45714
47416
|
/**
|
|
45715
|
-
* 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
|
|
47417
|
+
* 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.
|
|
45716
47418
|
* @summary Mark an order as delivered to customer or picked-up by driver
|
|
45717
47419
|
* @param {DeliveredOrderDto} deliveredOrderDto
|
|
45718
47420
|
* @param {*} [options] Override http request option.
|
|
@@ -46195,6 +47897,17 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
46195
47897
|
const localVarAxiosArgs = await localVarAxiosParamCreator.acceptOrder(acceptOrderDto, options);
|
|
46196
47898
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46197
47899
|
},
|
|
47900
|
+
/**
|
|
47901
|
+
* 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.
|
|
47902
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
47903
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
47904
|
+
* @param {*} [options] Override http request option.
|
|
47905
|
+
* @throws {RequiredError}
|
|
47906
|
+
*/
|
|
47907
|
+
async changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ChangePosOrdersStatusInBulkResponseDto>> {
|
|
47908
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto, options);
|
|
47909
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
47910
|
+
},
|
|
46198
47911
|
/**
|
|
46199
47912
|
* 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.
|
|
46200
47913
|
* @summary Confirm a pre-order
|
|
@@ -46218,7 +47931,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
46218
47931
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46219
47932
|
},
|
|
46220
47933
|
/**
|
|
46221
|
-
* 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
|
|
47934
|
+
* 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.
|
|
46222
47935
|
* @summary Mark an order as delivered to customer or picked-up by driver
|
|
46223
47936
|
* @param {DeliveredOrderDto} deliveredOrderDto
|
|
46224
47937
|
* @param {*} [options] Override http request option.
|
|
@@ -46375,6 +48088,16 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
46375
48088
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: any): AxiosPromise<OrderStatusResponseDto> {
|
|
46376
48089
|
return localVarFp.acceptOrder(acceptOrderDto, options).then((request) => request(axios, basePath));
|
|
46377
48090
|
},
|
|
48091
|
+
/**
|
|
48092
|
+
* 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.
|
|
48093
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
48094
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
48095
|
+
* @param {*} [options] Override http request option.
|
|
48096
|
+
* @throws {RequiredError}
|
|
48097
|
+
*/
|
|
48098
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: any): AxiosPromise<ChangePosOrdersStatusInBulkResponseDto> {
|
|
48099
|
+
return localVarFp.changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto, options).then((request) => request(axios, basePath));
|
|
48100
|
+
},
|
|
46378
48101
|
/**
|
|
46379
48102
|
* 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.
|
|
46380
48103
|
* @summary Confirm a pre-order
|
|
@@ -46396,7 +48119,7 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
46396
48119
|
return localVarFp.deletePosParkedOrderV2(deletePosOrderDto, options).then((request) => request(axios, basePath));
|
|
46397
48120
|
},
|
|
46398
48121
|
/**
|
|
46399
|
-
* 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
|
|
48122
|
+
* 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.
|
|
46400
48123
|
* @summary Mark an order as delivered to customer or picked-up by driver
|
|
46401
48124
|
* @param {DeliveredOrderDto} deliveredOrderDto
|
|
46402
48125
|
* @param {*} [options] Override http request option.
|
|
@@ -46540,6 +48263,16 @@ export interface OrdersApiInterface {
|
|
|
46540
48263
|
*/
|
|
46541
48264
|
acceptOrder(acceptOrderDto: AcceptOrderDto, options?: AxiosRequestConfig): AxiosPromise<OrderStatusResponseDto>;
|
|
46542
48265
|
|
|
48266
|
+
/**
|
|
48267
|
+
* 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.
|
|
48268
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
48269
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
48270
|
+
* @param {*} [options] Override http request option.
|
|
48271
|
+
* @throws {RequiredError}
|
|
48272
|
+
* @memberof OrdersApiInterface
|
|
48273
|
+
*/
|
|
48274
|
+
changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig): AxiosPromise<ChangePosOrdersStatusInBulkResponseDto>;
|
|
48275
|
+
|
|
46543
48276
|
/**
|
|
46544
48277
|
* 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.
|
|
46545
48278
|
* @summary Confirm a pre-order
|
|
@@ -46561,7 +48294,7 @@ export interface OrdersApiInterface {
|
|
|
46561
48294
|
deletePosParkedOrderV2(deletePosOrderDto: DeletePosOrderDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
46562
48295
|
|
|
46563
48296
|
/**
|
|
46564
|
-
* 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
|
|
48297
|
+
* 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.
|
|
46565
48298
|
* @summary Mark an order as delivered to customer or picked-up by driver
|
|
46566
48299
|
* @param {DeliveredOrderDto} deliveredOrderDto
|
|
46567
48300
|
* @param {*} [options] Override http request option.
|
|
@@ -46707,6 +48440,18 @@ export class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
46707
48440
|
return OrdersApiFp(this.configuration).acceptOrder(acceptOrderDto, options).then((request) => request(this.axios, this.basePath));
|
|
46708
48441
|
}
|
|
46709
48442
|
|
|
48443
|
+
/**
|
|
48444
|
+
* 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.
|
|
48445
|
+
* @summary Move the till\'s tickets and orders of one column to the next status
|
|
48446
|
+
* @param {ChangePosOrdersStatusInBulkDto} changePosOrdersStatusInBulkDto The venue, the ids of its tickets and orders, and the status to move them to
|
|
48447
|
+
* @param {*} [options] Override http request option.
|
|
48448
|
+
* @throws {RequiredError}
|
|
48449
|
+
* @memberof OrdersApi
|
|
48450
|
+
*/
|
|
48451
|
+
public changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto: ChangePosOrdersStatusInBulkDto, options?: AxiosRequestConfig) {
|
|
48452
|
+
return OrdersApiFp(this.configuration).changePosOrdersStatusInBulk(changePosOrdersStatusInBulkDto, options).then((request) => request(this.axios, this.basePath));
|
|
48453
|
+
}
|
|
48454
|
+
|
|
46710
48455
|
/**
|
|
46711
48456
|
* 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.
|
|
46712
48457
|
* @summary Confirm a pre-order
|
|
@@ -46732,7 +48477,7 @@ export class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
46732
48477
|
}
|
|
46733
48478
|
|
|
46734
48479
|
/**
|
|
46735
|
-
* 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
|
|
48480
|
+
* 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.
|
|
46736
48481
|
* @summary Mark an order as delivered to customer or picked-up by driver
|
|
46737
48482
|
* @param {DeliveredOrderDto} deliveredOrderDto
|
|
46738
48483
|
* @param {*} [options] Override http request option.
|
|
@@ -51734,7 +53479,7 @@ export const ProductApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
51734
53479
|
* @summary Get a product\'s stock and on/off for every channel
|
|
51735
53480
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
51736
53481
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
51737
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53482
|
+
* @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
|
|
51738
53483
|
* @param {*} [options] Override http request option.
|
|
51739
53484
|
* @throws {RequiredError}
|
|
51740
53485
|
*/
|
|
@@ -51776,7 +53521,7 @@ export const ProductApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
51776
53521
|
* @summary Save a product\'s stock and on/off for several channels at once
|
|
51777
53522
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
51778
53523
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
51779
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53524
|
+
* @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
|
|
51780
53525
|
* @param {UpdateChannelInventoryDto} updateChannelInventoryDto The channels to save
|
|
51781
53526
|
* @param {*} [options] Override http request option.
|
|
51782
53527
|
* @throws {RequiredError}
|
|
@@ -51824,7 +53569,7 @@ export const ProductApiAxiosParamCreator = function (configuration?: Configurati
|
|
|
51824
53569
|
* @summary Save a product\'s SKU (label code)
|
|
51825
53570
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
51826
53571
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
51827
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53572
|
+
* @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
|
|
51828
53573
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
51829
53574
|
* @param {*} [options] Override http request option.
|
|
51830
53575
|
* @throws {RequiredError}
|
|
@@ -51882,7 +53627,7 @@ export const ProductApiFp = function(configuration?: Configuration) {
|
|
|
51882
53627
|
* @summary Get a product\'s stock and on/off for every channel
|
|
51883
53628
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
51884
53629
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
51885
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53630
|
+
* @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
|
|
51886
53631
|
* @param {*} [options] Override http request option.
|
|
51887
53632
|
* @throws {RequiredError}
|
|
51888
53633
|
*/
|
|
@@ -51895,7 +53640,7 @@ export const ProductApiFp = function(configuration?: Configuration) {
|
|
|
51895
53640
|
* @summary Save a product\'s stock and on/off for several channels at once
|
|
51896
53641
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
51897
53642
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
51898
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53643
|
+
* @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
|
|
51899
53644
|
* @param {UpdateChannelInventoryDto} updateChannelInventoryDto The channels to save
|
|
51900
53645
|
* @param {*} [options] Override http request option.
|
|
51901
53646
|
* @throws {RequiredError}
|
|
@@ -51909,7 +53654,7 @@ export const ProductApiFp = function(configuration?: Configuration) {
|
|
|
51909
53654
|
* @summary Save a product\'s SKU (label code)
|
|
51910
53655
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
51911
53656
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
51912
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53657
|
+
* @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
|
|
51913
53658
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
51914
53659
|
* @param {*} [options] Override http request option.
|
|
51915
53660
|
* @throws {RequiredError}
|
|
@@ -51933,7 +53678,7 @@ export const ProductApiFactory = function (configuration?: Configuration, basePa
|
|
|
51933
53678
|
* @summary Get a product\'s stock and on/off for every channel
|
|
51934
53679
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
51935
53680
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
51936
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53681
|
+
* @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
|
|
51937
53682
|
* @param {*} [options] Override http request option.
|
|
51938
53683
|
* @throws {RequiredError}
|
|
51939
53684
|
*/
|
|
@@ -51945,7 +53690,7 @@ export const ProductApiFactory = function (configuration?: Configuration, basePa
|
|
|
51945
53690
|
* @summary Save a product\'s stock and on/off for several channels at once
|
|
51946
53691
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
51947
53692
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
51948
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53693
|
+
* @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
|
|
51949
53694
|
* @param {UpdateChannelInventoryDto} updateChannelInventoryDto The channels to save
|
|
51950
53695
|
* @param {*} [options] Override http request option.
|
|
51951
53696
|
* @throws {RequiredError}
|
|
@@ -51958,7 +53703,7 @@ export const ProductApiFactory = function (configuration?: Configuration, basePa
|
|
|
51958
53703
|
* @summary Save a product\'s SKU (label code)
|
|
51959
53704
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
51960
53705
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
51961
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53706
|
+
* @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
|
|
51962
53707
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
51963
53708
|
* @param {*} [options] Override http request option.
|
|
51964
53709
|
* @throws {RequiredError}
|
|
@@ -51980,7 +53725,7 @@ export interface ProductApiInterface {
|
|
|
51980
53725
|
* @summary Get a product\'s stock and on/off for every channel
|
|
51981
53726
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
51982
53727
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
51983
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53728
|
+
* @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
|
|
51984
53729
|
* @param {*} [options] Override http request option.
|
|
51985
53730
|
* @throws {RequiredError}
|
|
51986
53731
|
* @memberof ProductApiInterface
|
|
@@ -51992,7 +53737,7 @@ export interface ProductApiInterface {
|
|
|
51992
53737
|
* @summary Save a product\'s stock and on/off for several channels at once
|
|
51993
53738
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
51994
53739
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
51995
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53740
|
+
* @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
|
|
51996
53741
|
* @param {UpdateChannelInventoryDto} updateChannelInventoryDto The channels to save
|
|
51997
53742
|
* @param {*} [options] Override http request option.
|
|
51998
53743
|
* @throws {RequiredError}
|
|
@@ -52005,7 +53750,7 @@ export interface ProductApiInterface {
|
|
|
52005
53750
|
* @summary Save a product\'s SKU (label code)
|
|
52006
53751
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
52007
53752
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
52008
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53753
|
+
* @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
|
|
52009
53754
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
52010
53755
|
* @param {*} [options] Override http request option.
|
|
52011
53756
|
* @throws {RequiredError}
|
|
@@ -52027,7 +53772,7 @@ export class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
52027
53772
|
* @summary Get a product\'s stock and on/off for every channel
|
|
52028
53773
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
52029
53774
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
52030
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53775
|
+
* @param {string} productId The product\'s id in Vendure: a whole number from 1, with no leading zero; anything else is refused with 400 before Vendure is asked
|
|
52031
53776
|
* @param {*} [options] Override http request option.
|
|
52032
53777
|
* @throws {RequiredError}
|
|
52033
53778
|
* @memberof ProductApi
|
|
@@ -52041,7 +53786,7 @@ export class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
52041
53786
|
* @summary Save a product\'s stock and on/off for several channels at once
|
|
52042
53787
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
52043
53788
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
52044
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53789
|
+
* @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
|
|
52045
53790
|
* @param {UpdateChannelInventoryDto} updateChannelInventoryDto The channels to save
|
|
52046
53791
|
* @param {*} [options] Override http request option.
|
|
52047
53792
|
* @throws {RequiredError}
|
|
@@ -52056,7 +53801,7 @@ export class ProductApi extends BaseAPI implements ProductApiInterface {
|
|
|
52056
53801
|
* @summary Save a product\'s SKU (label code)
|
|
52057
53802
|
* @param {string} businessId The venue\'s id; the ticket must cover it
|
|
52058
53803
|
* @param {string} categoryId The product\'s category id. Not checked against the product: it is copied into each answered row as category_id
|
|
52059
|
-
* @param {string} productId The product\'s id in Vendure
|
|
53804
|
+
* @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
|
|
52060
53805
|
* @param {UpdateProductSkuDto} updateProductSkuDto The SKU to save
|
|
52061
53806
|
* @param {*} [options] Override http request option.
|
|
52062
53807
|
* @throws {RequiredError}
|
|
@@ -53693,7 +55438,7 @@ export const ReportApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
53693
55438
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
53694
55439
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
53695
55440
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
53696
|
-
* @param {string} [timezone] Timezone
|
|
55441
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
53697
55442
|
* @param {ProviderEnum} [provider] Order source provider (default is MunchiPos)
|
|
53698
55443
|
* @param {*} [options] Override http request option.
|
|
53699
55444
|
* @throws {RequiredError}
|
|
@@ -53739,6 +55484,102 @@ export const ReportApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
53739
55484
|
|
|
53740
55485
|
|
|
53741
55486
|
|
|
55487
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
55488
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
55489
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
55490
|
+
|
|
55491
|
+
return {
|
|
55492
|
+
url: toPathString(localVarUrlObj),
|
|
55493
|
+
options: localVarRequestOptions,
|
|
55494
|
+
};
|
|
55495
|
+
},
|
|
55496
|
+
/**
|
|
55497
|
+
* 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.
|
|
55498
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
55499
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
55500
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
55501
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55502
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55503
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
55504
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
55505
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
55506
|
+
* @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
|
|
55507
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
55508
|
+
* @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
|
|
55509
|
+
* @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
|
|
55510
|
+
* @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
|
|
55511
|
+
* @param {*} [options] Override http request option.
|
|
55512
|
+
* @throws {RequiredError}
|
|
55513
|
+
*/
|
|
55514
|
+
getSalesReport: async (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, baseline?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
55515
|
+
// verify required parameter 'businessIds' is not null or undefined
|
|
55516
|
+
assertParamExists('getSalesReport', 'businessIds', businessIds)
|
|
55517
|
+
const localVarPath = `/api/v6/report/sales`;
|
|
55518
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
55519
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
55520
|
+
let baseOptions;
|
|
55521
|
+
if (configuration) {
|
|
55522
|
+
baseOptions = configuration.baseOptions;
|
|
55523
|
+
}
|
|
55524
|
+
|
|
55525
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
55526
|
+
const localVarHeaderParameter = {} as any;
|
|
55527
|
+
const localVarQueryParameter = {} as any;
|
|
55528
|
+
|
|
55529
|
+
// authentication JWT-auth required
|
|
55530
|
+
// http bearer authentication required
|
|
55531
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
55532
|
+
|
|
55533
|
+
if (timeSpan !== undefined) {
|
|
55534
|
+
localVarQueryParameter['timeSpan'] = timeSpan;
|
|
55535
|
+
}
|
|
55536
|
+
|
|
55537
|
+
if (start !== undefined) {
|
|
55538
|
+
localVarQueryParameter['start'] = start;
|
|
55539
|
+
}
|
|
55540
|
+
|
|
55541
|
+
if (end !== undefined) {
|
|
55542
|
+
localVarQueryParameter['end'] = end;
|
|
55543
|
+
}
|
|
55544
|
+
|
|
55545
|
+
if (businessIds) {
|
|
55546
|
+
localVarQueryParameter['businessIds'] = businessIds;
|
|
55547
|
+
}
|
|
55548
|
+
|
|
55549
|
+
if (timezone !== undefined) {
|
|
55550
|
+
localVarQueryParameter['timezone'] = timezone;
|
|
55551
|
+
}
|
|
55552
|
+
|
|
55553
|
+
if (apps) {
|
|
55554
|
+
localVarQueryParameter['apps'] = apps;
|
|
55555
|
+
}
|
|
55556
|
+
|
|
55557
|
+
if (parts) {
|
|
55558
|
+
localVarQueryParameter['parts'] = parts;
|
|
55559
|
+
}
|
|
55560
|
+
|
|
55561
|
+
if (breakdown !== undefined) {
|
|
55562
|
+
localVarQueryParameter['breakdown'] = breakdown;
|
|
55563
|
+
}
|
|
55564
|
+
|
|
55565
|
+
if (language !== undefined) {
|
|
55566
|
+
localVarQueryParameter['language'] = language;
|
|
55567
|
+
}
|
|
55568
|
+
|
|
55569
|
+
if (compareStart !== undefined) {
|
|
55570
|
+
localVarQueryParameter['compareStart'] = compareStart;
|
|
55571
|
+
}
|
|
55572
|
+
|
|
55573
|
+
if (compareEnd !== undefined) {
|
|
55574
|
+
localVarQueryParameter['compareEnd'] = compareEnd;
|
|
55575
|
+
}
|
|
55576
|
+
|
|
55577
|
+
if (baseline !== undefined) {
|
|
55578
|
+
localVarQueryParameter['baseline'] = baseline;
|
|
55579
|
+
}
|
|
55580
|
+
|
|
55581
|
+
|
|
55582
|
+
|
|
53742
55583
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
53743
55584
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
53744
55585
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -53835,7 +55676,7 @@ export const ReportApiFp = function(configuration?: Configuration) {
|
|
|
53835
55676
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
53836
55677
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
53837
55678
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
53838
|
-
* @param {string} [timezone] Timezone
|
|
55679
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
53839
55680
|
* @param {ProviderEnum} [provider] Order source provider (default is MunchiPos)
|
|
53840
55681
|
* @param {*} [options] Override http request option.
|
|
53841
55682
|
* @throws {RequiredError}
|
|
@@ -53844,6 +55685,28 @@ export const ReportApiFp = function(configuration?: Configuration) {
|
|
|
53844
55685
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options);
|
|
53845
55686
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
53846
55687
|
},
|
|
55688
|
+
/**
|
|
55689
|
+
* 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.
|
|
55690
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
55691
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
55692
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
55693
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55694
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55695
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
55696
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
55697
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
55698
|
+
* @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
|
|
55699
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
55700
|
+
* @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
|
|
55701
|
+
* @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
|
|
55702
|
+
* @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
|
|
55703
|
+
* @param {*} [options] Override http request option.
|
|
55704
|
+
* @throws {RequiredError}
|
|
55705
|
+
*/
|
|
55706
|
+
async getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, baseline?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SalesReportResponseDto>> {
|
|
55707
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSalesReport(businessIds, timeSpan, start, end, timezone, apps, parts, breakdown, language, compareStart, compareEnd, baseline, options);
|
|
55708
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
55709
|
+
},
|
|
53847
55710
|
/**
|
|
53848
55711
|
*
|
|
53849
55712
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -53878,7 +55741,7 @@ export const ReportApiFactory = function (configuration?: Configuration, basePat
|
|
|
53878
55741
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
53879
55742
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
53880
55743
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
53881
|
-
* @param {string} [timezone] Timezone
|
|
55744
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
53882
55745
|
* @param {ProviderEnum} [provider] Order source provider (default is MunchiPos)
|
|
53883
55746
|
* @param {*} [options] Override http request option.
|
|
53884
55747
|
* @throws {RequiredError}
|
|
@@ -53886,6 +55749,27 @@ export const ReportApiFactory = function (configuration?: Configuration, basePat
|
|
|
53886
55749
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: any): AxiosPromise<EndOfDayReportDtoV4> {
|
|
53887
55750
|
return localVarFp.getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options).then((request) => request(axios, basePath));
|
|
53888
55751
|
},
|
|
55752
|
+
/**
|
|
55753
|
+
* 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.
|
|
55754
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
55755
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
55756
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
55757
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55758
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55759
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
55760
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
55761
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
55762
|
+
* @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
|
|
55763
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
55764
|
+
* @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
|
|
55765
|
+
* @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
|
|
55766
|
+
* @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
|
|
55767
|
+
* @param {*} [options] Override http request option.
|
|
55768
|
+
* @throws {RequiredError}
|
|
55769
|
+
*/
|
|
55770
|
+
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> {
|
|
55771
|
+
return localVarFp.getSalesReport(businessIds, timeSpan, start, end, timezone, apps, parts, breakdown, language, compareStart, compareEnd, baseline, options).then((request) => request(axios, basePath));
|
|
55772
|
+
},
|
|
53889
55773
|
/**
|
|
53890
55774
|
*
|
|
53891
55775
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -53918,7 +55802,7 @@ export interface ReportApiInterface {
|
|
|
53918
55802
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
53919
55803
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
53920
55804
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
53921
|
-
* @param {string} [timezone] Timezone
|
|
55805
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
53922
55806
|
* @param {ProviderEnum} [provider] Order source provider (default is MunchiPos)
|
|
53923
55807
|
* @param {*} [options] Override http request option.
|
|
53924
55808
|
* @throws {RequiredError}
|
|
@@ -53926,6 +55810,27 @@ export interface ReportApiInterface {
|
|
|
53926
55810
|
*/
|
|
53927
55811
|
getEndOfDayReportV5(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): AxiosPromise<EndOfDayReportDtoV4>;
|
|
53928
55812
|
|
|
55813
|
+
/**
|
|
55814
|
+
* 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.
|
|
55815
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
55816
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
55817
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
55818
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55819
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55820
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
55821
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
55822
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
55823
|
+
* @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
|
|
55824
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
55825
|
+
* @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
|
|
55826
|
+
* @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
|
|
55827
|
+
* @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
|
|
55828
|
+
* @param {*} [options] Override http request option.
|
|
55829
|
+
* @throws {RequiredError}
|
|
55830
|
+
* @memberof ReportApiInterface
|
|
55831
|
+
*/
|
|
55832
|
+
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>;
|
|
55833
|
+
|
|
53929
55834
|
/**
|
|
53930
55835
|
*
|
|
53931
55836
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -53958,7 +55863,7 @@ export class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
53958
55863
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
53959
55864
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
53960
55865
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
53961
|
-
* @param {string} [timezone] Timezone
|
|
55866
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
53962
55867
|
* @param {ProviderEnum} [provider] Order source provider (default is MunchiPos)
|
|
53963
55868
|
* @param {*} [options] Override http request option.
|
|
53964
55869
|
* @throws {RequiredError}
|
|
@@ -53968,6 +55873,29 @@ export class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
53968
55873
|
return ReportApiFp(this.configuration).getEndOfDayReportV5(businessIds, timeSpan, start, end, timezone, provider, options).then((request) => request(this.axios, this.basePath));
|
|
53969
55874
|
}
|
|
53970
55875
|
|
|
55876
|
+
/**
|
|
55877
|
+
* 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.
|
|
55878
|
+
* @summary Sales report of the venues and apps, whole business days, from the daily rows
|
|
55879
|
+
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
55880
|
+
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
55881
|
+
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55882
|
+
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
55883
|
+
* @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\'s own (Business.timeZone)
|
|
55884
|
+
* @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
|
|
55885
|
+
* @param {Array<ReportPart>} [parts] The parts to answer, the parameter repeated or a JSON list; only their daily tables are read. Absent: all five
|
|
55886
|
+
* @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
|
|
55887
|
+
* @param {string} [language] Accepted and not read, so a request copied from the portal\'s report works: the report has no text to translate
|
|
55888
|
+
* @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
|
|
55889
|
+
* @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
|
|
55890
|
+
* @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
|
|
55891
|
+
* @param {*} [options] Override http request option.
|
|
55892
|
+
* @throws {RequiredError}
|
|
55893
|
+
* @memberof ReportApi
|
|
55894
|
+
*/
|
|
55895
|
+
public getSalesReport(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, parts?: Array<ReportPart>, breakdown?: ReportBreakdown, language?: string, compareStart?: string, compareEnd?: string, baseline?: string, options?: AxiosRequestConfig) {
|
|
55896
|
+
return ReportApiFp(this.configuration).getSalesReport(businessIds, timeSpan, start, end, timezone, apps, parts, breakdown, language, compareStart, compareEnd, baseline, options).then((request) => request(this.axios, this.basePath));
|
|
55897
|
+
}
|
|
55898
|
+
|
|
53971
55899
|
/**
|
|
53972
55900
|
*
|
|
53973
55901
|
* @summary Send end-of-day report via email (V5)
|
|
@@ -54001,7 +55929,7 @@ export const ReportV6ApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
54001
55929
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
54002
55930
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54003
55931
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54004
|
-
* @param {string} [timezone] Timezone of the period
|
|
55932
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
54005
55933
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
54006
55934
|
* @param {*} [options] Override http request option.
|
|
54007
55935
|
* @throws {RequiredError}
|
|
@@ -54068,7 +55996,7 @@ export const ReportV6ApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
54068
55996
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
54069
55997
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54070
55998
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54071
|
-
* @param {string} [timezone] Timezone of the period
|
|
55999
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
54072
56000
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
54073
56001
|
* @param {*} [options] Override http request option.
|
|
54074
56002
|
* @throws {RequiredError}
|
|
@@ -54149,7 +56077,7 @@ export const ReportV6ApiFp = function(configuration?: Configuration) {
|
|
|
54149
56077
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
54150
56078
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54151
56079
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54152
|
-
* @param {string} [timezone] Timezone of the period
|
|
56080
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
54153
56081
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
54154
56082
|
* @param {*} [options] Override http request option.
|
|
54155
56083
|
* @throws {RequiredError}
|
|
@@ -54166,7 +56094,7 @@ export const ReportV6ApiFp = function(configuration?: Configuration) {
|
|
|
54166
56094
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
54167
56095
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54168
56096
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54169
|
-
* @param {string} [timezone] Timezone of the period
|
|
56097
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
54170
56098
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
54171
56099
|
* @param {*} [options] Override http request option.
|
|
54172
56100
|
* @throws {RequiredError}
|
|
@@ -54192,7 +56120,7 @@ export const ReportV6ApiFactory = function (configuration?: Configuration, baseP
|
|
|
54192
56120
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
54193
56121
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54194
56122
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54195
|
-
* @param {string} [timezone] Timezone of the period
|
|
56123
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
54196
56124
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
54197
56125
|
* @param {*} [options] Override http request option.
|
|
54198
56126
|
* @throws {RequiredError}
|
|
@@ -54208,7 +56136,7 @@ export const ReportV6ApiFactory = function (configuration?: Configuration, baseP
|
|
|
54208
56136
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
54209
56137
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54210
56138
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54211
|
-
* @param {string} [timezone] Timezone of the period
|
|
56139
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
54212
56140
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
54213
56141
|
* @param {*} [options] Override http request option.
|
|
54214
56142
|
* @throws {RequiredError}
|
|
@@ -54232,7 +56160,7 @@ export interface ReportV6ApiInterface {
|
|
|
54232
56160
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
54233
56161
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54234
56162
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54235
|
-
* @param {string} [timezone] Timezone of the period
|
|
56163
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
54236
56164
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
54237
56165
|
* @param {*} [options] Override http request option.
|
|
54238
56166
|
* @throws {RequiredError}
|
|
@@ -54248,7 +56176,7 @@ export interface ReportV6ApiInterface {
|
|
|
54248
56176
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
54249
56177
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54250
56178
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54251
|
-
* @param {string} [timezone] Timezone of the period
|
|
56179
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
54252
56180
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
54253
56181
|
* @param {*} [options] Override http request option.
|
|
54254
56182
|
* @throws {RequiredError}
|
|
@@ -54272,7 +56200,7 @@ export class ReportV6Api extends BaseAPI implements ReportV6ApiInterface {
|
|
|
54272
56200
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
54273
56201
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54274
56202
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54275
|
-
* @param {string} [timezone] Timezone of the period
|
|
56203
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
54276
56204
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
54277
56205
|
* @param {*} [options] Override http request option.
|
|
54278
56206
|
* @throws {RequiredError}
|
|
@@ -54290,7 +56218,7 @@ export class ReportV6Api extends BaseAPI implements ReportV6ApiInterface {
|
|
|
54290
56218
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
54291
56219
|
* @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54292
56220
|
* @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
|
|
54293
|
-
* @param {string} [timezone] Timezone of the period
|
|
56221
|
+
* @param {string} [timezone] Timezone of the period. Absent: the venue\'s own time zone (Business.timeZone)
|
|
54294
56222
|
* @param {ProviderEnum} [provider] Order source (default MunchiPos)
|
|
54295
56223
|
* @param {*} [options] Override http request option.
|
|
54296
56224
|
* @throws {RequiredError}
|