@munchi_oy/core 2.3.0 → 2.4.0

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.
@@ -23405,6 +23405,686 @@ export declare const PubSubTarget: {
23405
23405
  readonly Kds: "KDS";
23406
23406
  };
23407
23407
  export type PubSubTarget = typeof PubSubTarget[keyof typeof PubSubTarget];
23408
+ /**
23409
+ *
23410
+ * @export
23411
+ * @interface PublicReportHoursDto
23412
+ */
23413
+ export interface PublicReportHoursDto {
23414
+ /**
23415
+ *
23416
+ * @type {PublicReportHoursDtoPeriod}
23417
+ * @memberof PublicReportHoursDto
23418
+ */
23419
+ 'period': PublicReportHoursDtoPeriod;
23420
+ /**
23421
+ *
23422
+ * @type {PublicReportHoursDtoToday}
23423
+ * @memberof PublicReportHoursDto
23424
+ */
23425
+ 'today': PublicReportHoursDtoToday;
23426
+ /**
23427
+ *
23428
+ * @type {PublicReportHoursDtoNormal}
23429
+ * @memberof PublicReportHoursDto
23430
+ */
23431
+ 'normal': PublicReportHoursDtoNormal;
23432
+ }
23433
+ /**
23434
+ * A normal day: today\'s weekday over the 8 weeks before today, averaged per hour (isoWeekday)
23435
+ * @export
23436
+ * @interface PublicReportHoursDtoNormal
23437
+ */
23438
+ export interface PublicReportHoursDtoNormal {
23439
+ /**
23440
+ * The first instant of the period, ISO 8601 in UTC
23441
+ * @type {string}
23442
+ * @memberof PublicReportHoursDtoNormal
23443
+ */
23444
+ 'reportDateStart': string;
23445
+ /**
23446
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
23447
+ * @type {string}
23448
+ * @memberof PublicReportHoursDtoNormal
23449
+ */
23450
+ 'reportDateEnd': string;
23451
+ /**
23452
+ * The IANA time zone the period\'s days are read in
23453
+ * @type {string}
23454
+ * @memberof PublicReportHoursDtoNormal
23455
+ */
23456
+ 'timezone': string;
23457
+ /**
23458
+ * The first business day, YYYY-MM-DD
23459
+ * @type {string}
23460
+ * @memberof PublicReportHoursDtoNormal
23461
+ */
23462
+ 'firstBusinessDay': string;
23463
+ /**
23464
+ * The last business day, YYYY-MM-DD, inclusive
23465
+ * @type {string}
23466
+ * @memberof PublicReportHoursDtoNormal
23467
+ */
23468
+ 'lastBusinessDay': string;
23469
+ /**
23470
+ * The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
23471
+ * @type {number}
23472
+ * @memberof PublicReportHoursDtoNormal
23473
+ */
23474
+ 'isoWeekday': number | null;
23475
+ /**
23476
+ * The finished calendar days of the period (of isoWeekday, when sent), sold on or not; today, still running, is not one of them. Each group\'s averages divide by its daysAveraged
23477
+ * @type {number}
23478
+ * @memberof PublicReportHoursDtoNormal
23479
+ */
23480
+ 'daysCounted': number;
23481
+ /**
23482
+ * The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
23483
+ * @type {string}
23484
+ * @memberof PublicReportHoursDtoNormal
23485
+ */
23486
+ 'dataUntil': string | null;
23487
+ /**
23488
+ * One group per venue, app and currency the breakdown keeps
23489
+ * @type {Array<SalesReportHoursGroupDto>}
23490
+ * @memberof PublicReportHoursDtoNormal
23491
+ */
23492
+ 'groups': Array<SalesReportHoursGroupDto>;
23493
+ }
23494
+ /**
23495
+ * The period\'s hours
23496
+ * @export
23497
+ * @interface PublicReportHoursDtoPeriod
23498
+ */
23499
+ export interface PublicReportHoursDtoPeriod {
23500
+ /**
23501
+ * The first instant of the period, ISO 8601 in UTC
23502
+ * @type {string}
23503
+ * @memberof PublicReportHoursDtoPeriod
23504
+ */
23505
+ 'reportDateStart': string;
23506
+ /**
23507
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
23508
+ * @type {string}
23509
+ * @memberof PublicReportHoursDtoPeriod
23510
+ */
23511
+ 'reportDateEnd': string;
23512
+ /**
23513
+ * The IANA time zone the period\'s days are read in
23514
+ * @type {string}
23515
+ * @memberof PublicReportHoursDtoPeriod
23516
+ */
23517
+ 'timezone': string;
23518
+ /**
23519
+ * The first business day, YYYY-MM-DD
23520
+ * @type {string}
23521
+ * @memberof PublicReportHoursDtoPeriod
23522
+ */
23523
+ 'firstBusinessDay': string;
23524
+ /**
23525
+ * The last business day, YYYY-MM-DD, inclusive
23526
+ * @type {string}
23527
+ * @memberof PublicReportHoursDtoPeriod
23528
+ */
23529
+ 'lastBusinessDay': string;
23530
+ /**
23531
+ * The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
23532
+ * @type {number}
23533
+ * @memberof PublicReportHoursDtoPeriod
23534
+ */
23535
+ 'isoWeekday': number | null;
23536
+ /**
23537
+ * The finished calendar days of the period (of isoWeekday, when sent), sold on or not; today, still running, is not one of them. Each group\'s averages divide by its daysAveraged
23538
+ * @type {number}
23539
+ * @memberof PublicReportHoursDtoPeriod
23540
+ */
23541
+ 'daysCounted': number;
23542
+ /**
23543
+ * The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
23544
+ * @type {string}
23545
+ * @memberof PublicReportHoursDtoPeriod
23546
+ */
23547
+ 'dataUntil': string | null;
23548
+ /**
23549
+ * One group per venue, app and currency the breakdown keeps
23550
+ * @type {Array<SalesReportHoursGroupDto>}
23551
+ * @memberof PublicReportHoursDtoPeriod
23552
+ */
23553
+ 'groups': Array<SalesReportHoursGroupDto>;
23554
+ }
23555
+ /**
23556
+ * Today\'s hours on the side\'s clock, so far
23557
+ * @export
23558
+ * @interface PublicReportHoursDtoToday
23559
+ */
23560
+ export interface PublicReportHoursDtoToday {
23561
+ /**
23562
+ * The first instant of the period, ISO 8601 in UTC
23563
+ * @type {string}
23564
+ * @memberof PublicReportHoursDtoToday
23565
+ */
23566
+ 'reportDateStart': string;
23567
+ /**
23568
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
23569
+ * @type {string}
23570
+ * @memberof PublicReportHoursDtoToday
23571
+ */
23572
+ 'reportDateEnd': string;
23573
+ /**
23574
+ * The IANA time zone the period\'s days are read in
23575
+ * @type {string}
23576
+ * @memberof PublicReportHoursDtoToday
23577
+ */
23578
+ 'timezone': string;
23579
+ /**
23580
+ * The first business day, YYYY-MM-DD
23581
+ * @type {string}
23582
+ * @memberof PublicReportHoursDtoToday
23583
+ */
23584
+ 'firstBusinessDay': string;
23585
+ /**
23586
+ * The last business day, YYYY-MM-DD, inclusive
23587
+ * @type {string}
23588
+ * @memberof PublicReportHoursDtoToday
23589
+ */
23590
+ 'lastBusinessDay': string;
23591
+ /**
23592
+ * The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
23593
+ * @type {number}
23594
+ * @memberof PublicReportHoursDtoToday
23595
+ */
23596
+ 'isoWeekday': number | null;
23597
+ /**
23598
+ * The finished calendar days of the period (of isoWeekday, when sent), sold on or not; today, still running, is not one of them. Each group\'s averages divide by its daysAveraged
23599
+ * @type {number}
23600
+ * @memberof PublicReportHoursDtoToday
23601
+ */
23602
+ 'daysCounted': number;
23603
+ /**
23604
+ * The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
23605
+ * @type {string}
23606
+ * @memberof PublicReportHoursDtoToday
23607
+ */
23608
+ 'dataUntil': string | null;
23609
+ /**
23610
+ * One group per venue, app and currency the breakdown keeps
23611
+ * @type {Array<SalesReportHoursGroupDto>}
23612
+ * @memberof PublicReportHoursDtoToday
23613
+ */
23614
+ 'groups': Array<SalesReportHoursGroupDto>;
23615
+ }
23616
+ /**
23617
+ *
23618
+ * @export
23619
+ * @interface PublicReportNumbersDto
23620
+ */
23621
+ export interface PublicReportNumbersDto {
23622
+ /**
23623
+ *
23624
+ * @type {PublicReportNumbersDtoA}
23625
+ * @memberof PublicReportNumbersDto
23626
+ */
23627
+ 'a': PublicReportNumbersDtoA | null;
23628
+ /**
23629
+ *
23630
+ * @type {PublicReportNumbersDtoB}
23631
+ * @memberof PublicReportNumbersDto
23632
+ */
23633
+ 'b'?: PublicReportNumbersDtoB | null;
23634
+ }
23635
+ /**
23636
+ * Side A\'s numbers; null when its stores are none of the report\'s own or it could not be read
23637
+ * @export
23638
+ * @interface PublicReportNumbersDtoA
23639
+ */
23640
+ export interface PublicReportNumbersDtoA {
23641
+ /**
23642
+ * The stores read, by orderingBusinessId: the side\'s own, less any that is not the report\'s store or one of its organisation\'s; all of them when the side names none
23643
+ * @type {Array<number>}
23644
+ * @memberof PublicReportNumbersDtoA
23645
+ */
23646
+ 'stores': Array<number>;
23647
+ /**
23648
+ *
23649
+ * @type {PublicReportSideNumbersDtoSales}
23650
+ * @memberof PublicReportNumbersDtoA
23651
+ */
23652
+ 'sales': PublicReportSideNumbersDtoSales;
23653
+ /**
23654
+ *
23655
+ * @type {PublicReportSideNumbersDtoTrend}
23656
+ * @memberof PublicReportNumbersDtoA
23657
+ */
23658
+ 'trend'?: PublicReportSideNumbersDtoTrend;
23659
+ /**
23660
+ *
23661
+ * @type {PublicReportSideNumbersDtoYear}
23662
+ * @memberof PublicReportNumbersDtoA
23663
+ */
23664
+ 'year'?: PublicReportSideNumbersDtoYear;
23665
+ /**
23666
+ *
23667
+ * @type {PublicReportSideNumbersDtoHours}
23668
+ * @memberof PublicReportNumbersDtoA
23669
+ */
23670
+ 'hours'?: PublicReportSideNumbersDtoHours;
23671
+ /**
23672
+ *
23673
+ * @type {PublicReportSideNumbersDtoBoughtTogether}
23674
+ * @memberof PublicReportNumbersDtoA
23675
+ */
23676
+ 'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
23677
+ /**
23678
+ *
23679
+ * @type {PublicReportSideNumbersDtoOrderTypes}
23680
+ * @memberof PublicReportNumbersDtoA
23681
+ */
23682
+ 'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
23683
+ }
23684
+ /**
23685
+ * A comparison\'s side B; absent for a report
23686
+ * @export
23687
+ * @interface PublicReportNumbersDtoB
23688
+ */
23689
+ export interface PublicReportNumbersDtoB {
23690
+ /**
23691
+ * The stores read, by orderingBusinessId: the side\'s own, less any that is not the report\'s store or one of its organisation\'s; all of them when the side names none
23692
+ * @type {Array<number>}
23693
+ * @memberof PublicReportNumbersDtoB
23694
+ */
23695
+ 'stores': Array<number>;
23696
+ /**
23697
+ *
23698
+ * @type {PublicReportSideNumbersDtoSales}
23699
+ * @memberof PublicReportNumbersDtoB
23700
+ */
23701
+ 'sales': PublicReportSideNumbersDtoSales;
23702
+ /**
23703
+ *
23704
+ * @type {PublicReportSideNumbersDtoTrend}
23705
+ * @memberof PublicReportNumbersDtoB
23706
+ */
23707
+ 'trend'?: PublicReportSideNumbersDtoTrend;
23708
+ /**
23709
+ *
23710
+ * @type {PublicReportSideNumbersDtoYear}
23711
+ * @memberof PublicReportNumbersDtoB
23712
+ */
23713
+ 'year'?: PublicReportSideNumbersDtoYear;
23714
+ /**
23715
+ *
23716
+ * @type {PublicReportSideNumbersDtoHours}
23717
+ * @memberof PublicReportNumbersDtoB
23718
+ */
23719
+ 'hours'?: PublicReportSideNumbersDtoHours;
23720
+ /**
23721
+ *
23722
+ * @type {PublicReportSideNumbersDtoBoughtTogether}
23723
+ * @memberof PublicReportNumbersDtoB
23724
+ */
23725
+ 'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
23726
+ /**
23727
+ *
23728
+ * @type {PublicReportSideNumbersDtoOrderTypes}
23729
+ * @memberof PublicReportNumbersDtoB
23730
+ */
23731
+ 'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
23732
+ }
23733
+ /**
23734
+ *
23735
+ * @export
23736
+ * @interface PublicReportSideNumbersDto
23737
+ */
23738
+ export interface PublicReportSideNumbersDto {
23739
+ /**
23740
+ * The stores read, by orderingBusinessId: the side\'s own, less any that is not the report\'s store or one of its organisation\'s; all of them when the side names none
23741
+ * @type {Array<number>}
23742
+ * @memberof PublicReportSideNumbersDto
23743
+ */
23744
+ 'stores': Array<number>;
23745
+ /**
23746
+ *
23747
+ * @type {PublicReportSideNumbersDtoSales}
23748
+ * @memberof PublicReportSideNumbersDto
23749
+ */
23750
+ 'sales': PublicReportSideNumbersDtoSales;
23751
+ /**
23752
+ *
23753
+ * @type {PublicReportSideNumbersDtoTrend}
23754
+ * @memberof PublicReportSideNumbersDto
23755
+ */
23756
+ 'trend'?: PublicReportSideNumbersDtoTrend;
23757
+ /**
23758
+ *
23759
+ * @type {PublicReportSideNumbersDtoYear}
23760
+ * @memberof PublicReportSideNumbersDto
23761
+ */
23762
+ 'year'?: PublicReportSideNumbersDtoYear;
23763
+ /**
23764
+ *
23765
+ * @type {PublicReportSideNumbersDtoHours}
23766
+ * @memberof PublicReportSideNumbersDto
23767
+ */
23768
+ 'hours'?: PublicReportSideNumbersDtoHours;
23769
+ /**
23770
+ *
23771
+ * @type {PublicReportSideNumbersDtoBoughtTogether}
23772
+ * @memberof PublicReportSideNumbersDto
23773
+ */
23774
+ 'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
23775
+ /**
23776
+ *
23777
+ * @type {PublicReportSideNumbersDtoOrderTypes}
23778
+ * @memberof PublicReportSideNumbersDto
23779
+ */
23780
+ 'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
23781
+ }
23782
+ /**
23783
+ * Items bought together, as GET /api/v6/report/sales/bought-together; only when a card shows them
23784
+ * @export
23785
+ * @interface PublicReportSideNumbersDtoBoughtTogether
23786
+ */
23787
+ export interface PublicReportSideNumbersDtoBoughtTogether {
23788
+ /**
23789
+ * The first instant of the period, ISO 8601 in UTC
23790
+ * @type {string}
23791
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
23792
+ */
23793
+ 'reportDateStart': string;
23794
+ /**
23795
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
23796
+ * @type {string}
23797
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
23798
+ */
23799
+ 'reportDateEnd': string;
23800
+ /**
23801
+ * The IANA time zone the period\'s days are read in
23802
+ * @type {string}
23803
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
23804
+ */
23805
+ 'timezone': string;
23806
+ /**
23807
+ * The first business day, YYYY-MM-DD
23808
+ * @type {string}
23809
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
23810
+ */
23811
+ 'firstBusinessDay': string;
23812
+ /**
23813
+ * The last business day, YYYY-MM-DD, inclusive
23814
+ * @type {string}
23815
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
23816
+ */
23817
+ 'lastBusinessDay': string;
23818
+ /**
23819
+ * The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
23820
+ * @type {string}
23821
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
23822
+ */
23823
+ 'dataUntil': string | null;
23824
+ /**
23825
+ * One group per venue, app and currency the breakdown keeps
23826
+ * @type {Array<SalesReportBoughtTogetherGroupDto>}
23827
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
23828
+ */
23829
+ 'groups': Array<SalesReportBoughtTogetherGroupDto>;
23830
+ }
23831
+ /**
23832
+ * Sales per hour of the day, as GET /api/v6/report/sales/hours; only when a card shows hours
23833
+ * @export
23834
+ * @interface PublicReportSideNumbersDtoHours
23835
+ */
23836
+ export interface PublicReportSideNumbersDtoHours {
23837
+ /**
23838
+ *
23839
+ * @type {PublicReportHoursDtoPeriod}
23840
+ * @memberof PublicReportSideNumbersDtoHours
23841
+ */
23842
+ 'period': PublicReportHoursDtoPeriod;
23843
+ /**
23844
+ *
23845
+ * @type {PublicReportHoursDtoToday}
23846
+ * @memberof PublicReportSideNumbersDtoHours
23847
+ */
23848
+ 'today': PublicReportHoursDtoToday;
23849
+ /**
23850
+ *
23851
+ * @type {PublicReportHoursDtoNormal}
23852
+ * @memberof PublicReportSideNumbersDtoHours
23853
+ */
23854
+ 'normal': PublicReportHoursDtoNormal;
23855
+ }
23856
+ /**
23857
+ * Sales per order type, as GET /api/v6/report/sales/order-types; only when a card shows them
23858
+ * @export
23859
+ * @interface PublicReportSideNumbersDtoOrderTypes
23860
+ */
23861
+ export interface PublicReportSideNumbersDtoOrderTypes {
23862
+ /**
23863
+ * The first instant of the period, ISO 8601 in UTC
23864
+ * @type {string}
23865
+ * @memberof PublicReportSideNumbersDtoOrderTypes
23866
+ */
23867
+ 'reportDateStart': string;
23868
+ /**
23869
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
23870
+ * @type {string}
23871
+ * @memberof PublicReportSideNumbersDtoOrderTypes
23872
+ */
23873
+ 'reportDateEnd': string;
23874
+ /**
23875
+ * The IANA time zone the period\'s days are read in
23876
+ * @type {string}
23877
+ * @memberof PublicReportSideNumbersDtoOrderTypes
23878
+ */
23879
+ 'timezone': string;
23880
+ /**
23881
+ * The first business day, YYYY-MM-DD
23882
+ * @type {string}
23883
+ * @memberof PublicReportSideNumbersDtoOrderTypes
23884
+ */
23885
+ 'firstBusinessDay': string;
23886
+ /**
23887
+ * The last business day, YYYY-MM-DD, inclusive
23888
+ * @type {string}
23889
+ * @memberof PublicReportSideNumbersDtoOrderTypes
23890
+ */
23891
+ 'lastBusinessDay': string;
23892
+ /**
23893
+ * The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
23894
+ * @type {string}
23895
+ * @memberof PublicReportSideNumbersDtoOrderTypes
23896
+ */
23897
+ 'dataUntil': string | null;
23898
+ /**
23899
+ * One group per venue, app and currency the breakdown keeps
23900
+ * @type {Array<SalesReportOrderTypesGroupDto>}
23901
+ * @memberof PublicReportSideNumbersDtoOrderTypes
23902
+ */
23903
+ 'groups': Array<SalesReportOrderTypesGroupDto>;
23904
+ }
23905
+ /**
23906
+ * The sales report of the side\'s period, apps and stores (summary, items, payments and discounts), by store and app, with its totals, compared with as many days moved back by whole weeks (the year so far: 364 days), up to the same time of day while the period runs, as dashboard-one\'s Analytics dashboard asks
23907
+ * @export
23908
+ * @interface PublicReportSideNumbersDtoSales
23909
+ */
23910
+ export interface PublicReportSideNumbersDtoSales {
23911
+ /**
23912
+ * The first instant of the period, ISO 8601 in UTC
23913
+ * @type {string}
23914
+ * @memberof PublicReportSideNumbersDtoSales
23915
+ */
23916
+ 'reportDateStart': string;
23917
+ /**
23918
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
23919
+ * @type {string}
23920
+ * @memberof PublicReportSideNumbersDtoSales
23921
+ */
23922
+ 'reportDateEnd': string;
23923
+ /**
23924
+ * When the report was answered, ISO 8601 in UTC
23925
+ * @type {string}
23926
+ * @memberof PublicReportSideNumbersDtoSales
23927
+ */
23928
+ 'reportGeneratedAt': string;
23929
+ /**
23930
+ * The time zone the period was read in: the request\'s, or else the first venue\'s
23931
+ * @type {string}
23932
+ * @memberof PublicReportSideNumbersDtoSales
23933
+ */
23934
+ 'timezone': string;
23935
+ /**
23936
+ * The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
23937
+ * @type {string}
23938
+ * @memberof PublicReportSideNumbersDtoSales
23939
+ */
23940
+ 'firstBusinessDay': string;
23941
+ /**
23942
+ * The last business day added up, YYYY-MM-DD, inclusive
23943
+ * @type {string}
23944
+ * @memberof PublicReportSideNumbersDtoSales
23945
+ */
23946
+ 'lastBusinessDay': string;
23947
+ /**
23948
+ * 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
23949
+ * @type {object}
23950
+ * @memberof PublicReportSideNumbersDtoSales
23951
+ */
23952
+ 'dataUntil': object | null;
23953
+ /**
23954
+ * One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
23955
+ * @type {Array<SalesReportGroupDto>}
23956
+ * @memberof PublicReportSideNumbersDtoSales
23957
+ */
23958
+ 'reports': Array<SalesReportGroupDto>;
23959
+ /**
23960
+ * The short report (GET /api/v6/report/sales/short), when the breakdown splits several venues or apps: their groups added together, one per currency, as breakdown none answers them (comparison and changes too), so the parts and their total come in one answer
23961
+ * @type {Array<SalesReportGroupDto>}
23962
+ * @memberof PublicReportSideNumbersDtoSales
23963
+ */
23964
+ 'totals'?: Array<SalesReportGroupDto>;
23965
+ }
23966
+ /**
23967
+ * A one-day period\'s trend: the summary of the 14 days up to it (to today at the latest), compared with the 14 before; only when the period is one day and a number card shows
23968
+ * @export
23969
+ * @interface PublicReportSideNumbersDtoTrend
23970
+ */
23971
+ export interface PublicReportSideNumbersDtoTrend {
23972
+ /**
23973
+ * The first instant of the period, ISO 8601 in UTC
23974
+ * @type {string}
23975
+ * @memberof PublicReportSideNumbersDtoTrend
23976
+ */
23977
+ 'reportDateStart': string;
23978
+ /**
23979
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
23980
+ * @type {string}
23981
+ * @memberof PublicReportSideNumbersDtoTrend
23982
+ */
23983
+ 'reportDateEnd': string;
23984
+ /**
23985
+ * When the report was answered, ISO 8601 in UTC
23986
+ * @type {string}
23987
+ * @memberof PublicReportSideNumbersDtoTrend
23988
+ */
23989
+ 'reportGeneratedAt': string;
23990
+ /**
23991
+ * The time zone the period was read in: the request\'s, or else the first venue\'s
23992
+ * @type {string}
23993
+ * @memberof PublicReportSideNumbersDtoTrend
23994
+ */
23995
+ 'timezone': string;
23996
+ /**
23997
+ * The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
23998
+ * @type {string}
23999
+ * @memberof PublicReportSideNumbersDtoTrend
24000
+ */
24001
+ 'firstBusinessDay': string;
24002
+ /**
24003
+ * The last business day added up, YYYY-MM-DD, inclusive
24004
+ * @type {string}
24005
+ * @memberof PublicReportSideNumbersDtoTrend
24006
+ */
24007
+ 'lastBusinessDay': string;
24008
+ /**
24009
+ * 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
24010
+ * @type {object}
24011
+ * @memberof PublicReportSideNumbersDtoTrend
24012
+ */
24013
+ 'dataUntil': object | null;
24014
+ /**
24015
+ * One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
24016
+ * @type {Array<SalesReportGroupDto>}
24017
+ * @memberof PublicReportSideNumbersDtoTrend
24018
+ */
24019
+ 'reports': Array<SalesReportGroupDto>;
24020
+ /**
24021
+ * The short report (GET /api/v6/report/sales/short), when the breakdown splits several venues or apps: their groups added together, one per currency, as breakdown none answers them (comparison and changes too), so the parts and their total come in one answer
24022
+ * @type {Array<SalesReportGroupDto>}
24023
+ * @memberof PublicReportSideNumbersDtoTrend
24024
+ */
24025
+ 'totals'?: Array<SalesReportGroupDto>;
24026
+ }
24027
+ /**
24028
+ * The summary of the 26 weeks up to today, day by day; only when the report shows the year card
24029
+ * @export
24030
+ * @interface PublicReportSideNumbersDtoYear
24031
+ */
24032
+ export interface PublicReportSideNumbersDtoYear {
24033
+ /**
24034
+ * The first instant of the period, ISO 8601 in UTC
24035
+ * @type {string}
24036
+ * @memberof PublicReportSideNumbersDtoYear
24037
+ */
24038
+ 'reportDateStart': string;
24039
+ /**
24040
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
24041
+ * @type {string}
24042
+ * @memberof PublicReportSideNumbersDtoYear
24043
+ */
24044
+ 'reportDateEnd': string;
24045
+ /**
24046
+ * When the report was answered, ISO 8601 in UTC
24047
+ * @type {string}
24048
+ * @memberof PublicReportSideNumbersDtoYear
24049
+ */
24050
+ 'reportGeneratedAt': string;
24051
+ /**
24052
+ * The time zone the period was read in: the request\'s, or else the first venue\'s
24053
+ * @type {string}
24054
+ * @memberof PublicReportSideNumbersDtoYear
24055
+ */
24056
+ 'timezone': string;
24057
+ /**
24058
+ * The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
24059
+ * @type {string}
24060
+ * @memberof PublicReportSideNumbersDtoYear
24061
+ */
24062
+ 'firstBusinessDay': string;
24063
+ /**
24064
+ * The last business day added up, YYYY-MM-DD, inclusive
24065
+ * @type {string}
24066
+ * @memberof PublicReportSideNumbersDtoYear
24067
+ */
24068
+ 'lastBusinessDay': string;
24069
+ /**
24070
+ * 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
24071
+ * @type {object}
24072
+ * @memberof PublicReportSideNumbersDtoYear
24073
+ */
24074
+ 'dataUntil': object | null;
24075
+ /**
24076
+ * One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
24077
+ * @type {Array<SalesReportGroupDto>}
24078
+ * @memberof PublicReportSideNumbersDtoYear
24079
+ */
24080
+ 'reports': Array<SalesReportGroupDto>;
24081
+ /**
24082
+ * The short report (GET /api/v6/report/sales/short), when the breakdown splits several venues or apps: their groups added together, one per currency, as breakdown none answers them (comparison and changes too), so the parts and their total come in one answer
24083
+ * @type {Array<SalesReportGroupDto>}
24084
+ * @memberof PublicReportSideNumbersDtoYear
24085
+ */
24086
+ 'totals'?: Array<SalesReportGroupDto>;
24087
+ }
23408
24088
  /**
23409
24089
  *
23410
24090
  * @export
@@ -23453,6 +24133,31 @@ export interface PublicSavedReportDto {
23453
24133
  * @memberof PublicSavedReportDto
23454
24134
  */
23455
24135
  'updatedAt': string;
24136
+ /**
24137
+ *
24138
+ * @type {PublicSavedReportDtoNumbers}
24139
+ * @memberof PublicSavedReportDto
24140
+ */
24141
+ 'numbers': PublicSavedReportDtoNumbers | null;
24142
+ }
24143
+ /**
24144
+ * Each side\'s numbers, read now for the report\'s own store or organisation, its saved period and apps; null when they could not be read (the definition still answers)
24145
+ * @export
24146
+ * @interface PublicSavedReportDtoNumbers
24147
+ */
24148
+ export interface PublicSavedReportDtoNumbers {
24149
+ /**
24150
+ *
24151
+ * @type {PublicReportNumbersDtoA}
24152
+ * @memberof PublicSavedReportDtoNumbers
24153
+ */
24154
+ 'a': PublicReportNumbersDtoA | null;
24155
+ /**
24156
+ *
24157
+ * @type {PublicReportNumbersDtoB}
24158
+ * @memberof PublicSavedReportDtoNumbers
24159
+ */
24160
+ 'b'?: PublicReportNumbersDtoB | null;
23456
24161
  }
23457
24162
  /**
23458
24163
  *
@@ -23517,6 +24222,12 @@ export interface RankedCategoryDto {
23517
24222
  */
23518
24223
  export declare const ReadyMadeReport: {
23519
24224
  readonly Sales: "sales";
24225
+ readonly ZReport: "zReport";
24226
+ readonly SalesVat: "salesVat";
24227
+ readonly Payments: "payments";
24228
+ readonly ProductSales: "productSales";
24229
+ readonly CashSessions: "cashSessions";
24230
+ readonly Staff: "staff";
23520
24231
  };
23521
24232
  export type ReadyMadeReport = typeof ReadyMadeReport[keyof typeof ReadyMadeReport];
23522
24233
  /**
@@ -51534,7 +52245,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
51534
52245
  * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
51535
52246
  * @summary Read when a store\'s ready-made report is emailed
51536
52247
  * @param {number} businessId The store\&#39;s orderingBusinessId
51537
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52248
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51538
52249
  * @param {*} [options] Override http request option.
51539
52250
  * @throws {RequiredError}
51540
52251
  */
@@ -51573,7 +52284,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
51573
52284
  * Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
51574
52285
  * @summary List the past runs of a store\'s ready-made report
51575
52286
  * @param {number} businessId The store\&#39;s orderingBusinessId
51576
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52287
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51577
52288
  * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
51578
52289
  * @param {string} [after] The id of the last run of the page before; the list goes on after it
51579
52290
  * @param {*} [options] Override http request option.
@@ -51592,7 +52303,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
51592
52303
  */
51593
52304
  listStoreSavedReportRuns: (businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51594
52305
  /**
51595
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52306
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
51596
52307
  * @summary Set when an organisation\'s saved report is emailed
51597
52308
  * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
51598
52309
  * @param {string} reportId The saved report\&#39;s id
@@ -51602,17 +52313,17 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
51602
52313
  */
51603
52314
  setOrganisationSavedReportSchedule: (groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51604
52315
  /**
51605
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52316
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
51606
52317
  * @summary Set when a store\'s ready-made report is emailed
51607
52318
  * @param {number} businessId The store\&#39;s orderingBusinessId
51608
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52319
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51609
52320
  * @param {SetReportScheduleDto} setReportScheduleDto
51610
52321
  * @param {*} [options] Override http request option.
51611
52322
  * @throws {RequiredError}
51612
52323
  */
51613
52324
  setStoreReadyMadeReportSchedule: (businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51614
52325
  /**
51615
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52326
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
51616
52327
  * @summary Set when a store\'s saved report is emailed
51617
52328
  * @param {number} businessId The store\&#39;s orderingBusinessId
51618
52329
  * @param {string} reportId The saved report\&#39;s id
@@ -51658,7 +52369,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
51658
52369
  * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
51659
52370
  * @summary Read when a store\'s ready-made report is emailed
51660
52371
  * @param {number} businessId The store\&#39;s orderingBusinessId
51661
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52372
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51662
52373
  * @param {*} [options] Override http request option.
51663
52374
  * @throws {RequiredError}
51664
52375
  */
@@ -51697,7 +52408,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
51697
52408
  * Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
51698
52409
  * @summary List the past runs of a store\'s ready-made report
51699
52410
  * @param {number} businessId The store\&#39;s orderingBusinessId
51700
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52411
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51701
52412
  * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
51702
52413
  * @param {string} [after] The id of the last run of the page before; the list goes on after it
51703
52414
  * @param {*} [options] Override http request option.
@@ -51716,7 +52427,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
51716
52427
  */
51717
52428
  listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportRunListDto>>;
51718
52429
  /**
51719
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52430
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
51720
52431
  * @summary Set when an organisation\'s saved report is emailed
51721
52432
  * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
51722
52433
  * @param {string} reportId The saved report\&#39;s id
@@ -51726,17 +52437,17 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
51726
52437
  */
51727
52438
  setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
51728
52439
  /**
51729
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52440
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
51730
52441
  * @summary Set when a store\'s ready-made report is emailed
51731
52442
  * @param {number} businessId The store\&#39;s orderingBusinessId
51732
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52443
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51733
52444
  * @param {SetReportScheduleDto} setReportScheduleDto
51734
52445
  * @param {*} [options] Override http request option.
51735
52446
  * @throws {RequiredError}
51736
52447
  */
51737
52448
  setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
51738
52449
  /**
51739
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52450
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
51740
52451
  * @summary Set when a store\'s saved report is emailed
51741
52452
  * @param {number} businessId The store\&#39;s orderingBusinessId
51742
52453
  * @param {string} reportId The saved report\&#39;s id
@@ -51782,7 +52493,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
51782
52493
  * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
51783
52494
  * @summary Read when a store\'s ready-made report is emailed
51784
52495
  * @param {number} businessId The store\&#39;s orderingBusinessId
51785
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52496
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51786
52497
  * @param {*} [options] Override http request option.
51787
52498
  * @throws {RequiredError}
51788
52499
  */
@@ -51821,7 +52532,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
51821
52532
  * Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
51822
52533
  * @summary List the past runs of a store\'s ready-made report
51823
52534
  * @param {number} businessId The store\&#39;s orderingBusinessId
51824
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52535
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51825
52536
  * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
51826
52537
  * @param {string} [after] The id of the last run of the page before; the list goes on after it
51827
52538
  * @param {*} [options] Override http request option.
@@ -51840,7 +52551,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
51840
52551
  */
51841
52552
  listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: any): AxiosPromise<ReportRunListDto>;
51842
52553
  /**
51843
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52554
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
51844
52555
  * @summary Set when an organisation\'s saved report is emailed
51845
52556
  * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
51846
52557
  * @param {string} reportId The saved report\&#39;s id
@@ -51850,17 +52561,17 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
51850
52561
  */
51851
52562
  setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: any): AxiosPromise<ReportScheduleDto>;
51852
52563
  /**
51853
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52564
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
51854
52565
  * @summary Set when a store\'s ready-made report is emailed
51855
52566
  * @param {number} businessId The store\&#39;s orderingBusinessId
51856
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52567
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51857
52568
  * @param {SetReportScheduleDto} setReportScheduleDto
51858
52569
  * @param {*} [options] Override http request option.
51859
52570
  * @throws {RequiredError}
51860
52571
  */
51861
52572
  setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: any): AxiosPromise<ReportScheduleDto>;
51862
52573
  /**
51863
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52574
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
51864
52575
  * @summary Set when a store\'s saved report is emailed
51865
52576
  * @param {number} businessId The store\&#39;s orderingBusinessId
51866
52577
  * @param {string} reportId The saved report\&#39;s id
@@ -51910,7 +52621,7 @@ export interface ReportSchedulesApiInterface {
51910
52621
  * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
51911
52622
  * @summary Read when a store\'s ready-made report is emailed
51912
52623
  * @param {number} businessId The store\&#39;s orderingBusinessId
51913
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52624
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51914
52625
  * @param {*} [options] Override http request option.
51915
52626
  * @throws {RequiredError}
51916
52627
  * @memberof ReportSchedulesApiInterface
@@ -51953,7 +52664,7 @@ export interface ReportSchedulesApiInterface {
51953
52664
  * Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
51954
52665
  * @summary List the past runs of a store\'s ready-made report
51955
52666
  * @param {number} businessId The store\&#39;s orderingBusinessId
51956
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52667
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51957
52668
  * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
51958
52669
  * @param {string} [after] The id of the last run of the page before; the list goes on after it
51959
52670
  * @param {*} [options] Override http request option.
@@ -51974,7 +52685,7 @@ export interface ReportSchedulesApiInterface {
51974
52685
  */
51975
52686
  listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<ReportRunListDto>;
51976
52687
  /**
51977
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52688
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
51978
52689
  * @summary Set when an organisation\'s saved report is emailed
51979
52690
  * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
51980
52691
  * @param {string} reportId The saved report\&#39;s id
@@ -51985,10 +52696,10 @@ export interface ReportSchedulesApiInterface {
51985
52696
  */
51986
52697
  setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
51987
52698
  /**
51988
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52699
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
51989
52700
  * @summary Set when a store\'s ready-made report is emailed
51990
52701
  * @param {number} businessId The store\&#39;s orderingBusinessId
51991
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52702
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
51992
52703
  * @param {SetReportScheduleDto} setReportScheduleDto
51993
52704
  * @param {*} [options] Override http request option.
51994
52705
  * @throws {RequiredError}
@@ -51996,7 +52707,7 @@ export interface ReportSchedulesApiInterface {
51996
52707
  */
51997
52708
  setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
51998
52709
  /**
51999
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52710
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52000
52711
  * @summary Set when a store\'s saved report is emailed
52001
52712
  * @param {number} businessId The store\&#39;s orderingBusinessId
52002
52713
  * @param {string} reportId The saved report\&#39;s id
@@ -52048,7 +52759,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
52048
52759
  * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52049
52760
  * @summary Read when a store\'s ready-made report is emailed
52050
52761
  * @param {number} businessId The store\&#39;s orderingBusinessId
52051
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52762
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52052
52763
  * @param {*} [options] Override http request option.
52053
52764
  * @throws {RequiredError}
52054
52765
  * @memberof ReportSchedulesApi
@@ -52091,7 +52802,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
52091
52802
  * Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
52092
52803
  * @summary List the past runs of a store\'s ready-made report
52093
52804
  * @param {number} businessId The store\&#39;s orderingBusinessId
52094
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52805
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52095
52806
  * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52096
52807
  * @param {string} [after] The id of the last run of the page before; the list goes on after it
52097
52808
  * @param {*} [options] Override http request option.
@@ -52112,7 +52823,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
52112
52823
  */
52113
52824
  listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportRunListDto, any, {}>>;
52114
52825
  /**
52115
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52826
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52116
52827
  * @summary Set when an organisation\'s saved report is emailed
52117
52828
  * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52118
52829
  * @param {string} reportId The saved report\&#39;s id
@@ -52123,10 +52834,10 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
52123
52834
  */
52124
52835
  setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
52125
52836
  /**
52126
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52837
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52127
52838
  * @summary Set when a store\'s ready-made report is emailed
52128
52839
  * @param {number} businessId The store\&#39;s orderingBusinessId
52129
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
52840
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52130
52841
  * @param {SetReportScheduleDto} setReportScheduleDto
52131
52842
  * @param {*} [options] Override http request option.
52132
52843
  * @throws {RequiredError}
@@ -52134,7 +52845,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
52134
52845
  */
52135
52846
  setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
52136
52847
  /**
52137
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52848
+ * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and staff, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
52138
52849
  * @summary Set when a store\'s saved report is emailed
52139
52850
  * @param {number} businessId The store\&#39;s orderingBusinessId
52140
52851
  * @param {string} reportId The saved report\&#39;s id
@@ -53211,7 +53922,7 @@ export declare const SavedReportsApiAxiosParamCreator: (configuration?: Configur
53211
53922
  */
53212
53923
  getOrganisationSavedReport: (groupId: string, reportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53213
53924
  /**
53214
- * No sign-in. The report\'s name, kind, cards and filters, and the store or organisation whose data it reads; never its data, whose reads stay behind sign-in. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
53925
+ * No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
53215
53926
  * @summary Read a public report by its link
53216
53927
  * @param {string} token The public link\&#39;s token, 43 characters
53217
53928
  * @param {*} [options] Override http request option.
@@ -53359,7 +54070,7 @@ export declare const SavedReportsApiFp: (configuration?: Configuration) => {
53359
54070
  */
53360
54071
  getOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
53361
54072
  /**
53362
- * No sign-in. The report\'s name, kind, cards and filters, and the store or organisation whose data it reads; never its data, whose reads stay behind sign-in. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
54073
+ * No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
53363
54074
  * @summary Read a public report by its link
53364
54075
  * @param {string} token The public link\&#39;s token, 43 characters
53365
54076
  * @param {*} [options] Override http request option.
@@ -53507,7 +54218,7 @@ export declare const SavedReportsApiFactory: (configuration?: Configuration, bas
53507
54218
  */
53508
54219
  getOrganisationSavedReport(groupId: string, reportId: string, options?: any): AxiosPromise<SavedReportDto>;
53509
54220
  /**
53510
- * No sign-in. The report\'s name, kind, cards and filters, and the store or organisation whose data it reads; never its data, whose reads stay behind sign-in. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
54221
+ * No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
53511
54222
  * @summary Read a public report by its link
53512
54223
  * @param {string} token The public link\&#39;s token, 43 characters
53513
54224
  * @param {*} [options] Override http request option.
@@ -53663,7 +54374,7 @@ export interface SavedReportsApiInterface {
53663
54374
  */
53664
54375
  getOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
53665
54376
  /**
53666
- * No sign-in. The report\'s name, kind, cards and filters, and the store or organisation whose data it reads; never its data, whose reads stay behind sign-in. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
54377
+ * No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
53667
54378
  * @summary Read a public report by its link
53668
54379
  * @param {string} token The public link\&#39;s token, 43 characters
53669
54380
  * @param {*} [options] Override http request option.
@@ -53828,7 +54539,7 @@ export declare class SavedReportsApi extends BaseAPI implements SavedReportsApiI
53828
54539
  */
53829
54540
  getOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
53830
54541
  /**
53831
- * No sign-in. The report\'s name, kind, cards and filters, and the store or organisation whose data it reads; never its data, whose reads stay behind sign-in. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
54542
+ * No sign-in. The report\'s name, kind, cards and filters, the store or organisation whose data it reads, and numbers: what dashboard-one\'s Analytics dashboard reads for the same cards, read now for each side\'s saved period and apps: the sales report (as GET /api/v6/report/sales: summary, items, payments and discounts, by store and app, with totals, compared with the same weekdays before, up to the same time while the period runs) and, when its cards show them, a one-day period\'s 14-day trend, the year\'s 26 weeks, the hours (the period\'s, today\'s and a normal day\'s), items bought together and order types. Aggregates only: no order, person or customer. Answered only while the report\'s owner still manages its store or organisation (404 once they do not). A custom period is read for its last 366 days at most. Never kept by a cache (Cache-Control: no-store). Only the report\'s own store, or its organisation\'s stores as the licence server names them now, are ever read: a store its filters name that is neither is left out. Nothing but the token is taken from the request. numbers is null, and the definition still answers, when they could not be read. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
53832
54543
  * @summary Read a public report by its link
53833
54544
  * @param {string} token The public link\&#39;s token, 43 characters
53834
54545
  * @param {*} [options] Override http request option.