@munchi_oy/core 2.2.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.
@@ -434,6 +434,56 @@ export interface AnalyticsDashboardCardDto {
434
434
  */
435
435
  'id': string;
436
436
  }
437
+ /**
438
+ *
439
+ * @export
440
+ * @interface AnalyticsDashboardFiltersDto
441
+ */
442
+ export interface AnalyticsDashboardFiltersDto {
443
+ /**
444
+ *
445
+ * @type {AnalyticsDashboardFiltersDtoPeriod}
446
+ * @memberof AnalyticsDashboardFiltersDto
447
+ */
448
+ 'period': AnalyticsDashboardFiltersDtoPeriod;
449
+ /**
450
+ * The apps it counts; an empty list counts every app
451
+ * @type {Array<ReportApp>}
452
+ * @memberof AnalyticsDashboardFiltersDto
453
+ */
454
+ 'channels': Array<ReportApp>;
455
+ /**
456
+ * The stores it counts, by orderingBusinessId, at most 200: the dashboard\'s own store, or stores of its organisation. Absent or empty: the dashboard\'s own store, or every store of its organisation.
457
+ * @type {Array<number>}
458
+ * @memberof AnalyticsDashboardFiltersDto
459
+ */
460
+ 'stores'?: Array<number>;
461
+ }
462
+ /**
463
+ * The period it reads
464
+ * @export
465
+ * @interface AnalyticsDashboardFiltersDtoPeriod
466
+ */
467
+ export interface AnalyticsDashboardFiltersDtoPeriod {
468
+ /**
469
+ *
470
+ * @type {PeriodPreset}
471
+ * @memberof AnalyticsDashboardFiltersDtoPeriod
472
+ */
473
+ 'preset': PeriodPreset;
474
+ /**
475
+ * The first day of a custom period, YYYY-MM-DD in the store\'s zone; only with custom (or CUSTOM), refused with any other
476
+ * @type {string}
477
+ * @memberof AnalyticsDashboardFiltersDtoPeriod
478
+ */
479
+ 'startDay'?: string;
480
+ /**
481
+ * The last day of a custom period, inclusive, YYYY-MM-DD, startDay or later; only with custom (or CUSTOM), refused with any other
482
+ * @type {string}
483
+ * @memberof AnalyticsDashboardFiltersDtoPeriod
484
+ */
485
+ 'endDay'?: string;
486
+ }
437
487
  /**
438
488
  *
439
489
  * @export
@@ -471,6 +521,12 @@ export interface AnalyticsDashboardResponseDto {
471
521
  * @memberof AnalyticsDashboardResponseDto
472
522
  */
473
523
  'goals': AnalyticsDashboardResponseDtoGoals;
524
+ /**
525
+ *
526
+ * @type {AnalyticsDashboardResponseDtoFilters}
527
+ * @memberof AnalyticsDashboardResponseDto
528
+ */
529
+ 'filters'?: AnalyticsDashboardResponseDtoFilters;
474
530
  /**
475
531
  * When the dashboard was last saved, ISO 8601 in UTC
476
532
  * @type {string}
@@ -490,6 +546,31 @@ export interface AnalyticsDashboardResponseDto {
490
546
  */
491
547
  'updatedBy': string;
492
548
  }
549
+ /**
550
+ * The period, apps and stores the dashboard reads; absent when no save has set them yet
551
+ * @export
552
+ * @interface AnalyticsDashboardResponseDtoFilters
553
+ */
554
+ export interface AnalyticsDashboardResponseDtoFilters {
555
+ /**
556
+ *
557
+ * @type {AnalyticsDashboardFiltersDtoPeriod}
558
+ * @memberof AnalyticsDashboardResponseDtoFilters
559
+ */
560
+ 'period': AnalyticsDashboardFiltersDtoPeriod;
561
+ /**
562
+ * The apps it counts; an empty list counts every app
563
+ * @type {Array<ReportApp>}
564
+ * @memberof AnalyticsDashboardResponseDtoFilters
565
+ */
566
+ 'channels': Array<ReportApp>;
567
+ /**
568
+ * The stores it counts, by orderingBusinessId, at most 200: the dashboard\'s own store, or stores of its organisation. Absent or empty: the dashboard\'s own store, or every store of its organisation.
569
+ * @type {Array<number>}
570
+ * @memberof AnalyticsDashboardResponseDtoFilters
571
+ */
572
+ 'stores'?: Array<number>;
573
+ }
493
574
  /**
494
575
  * The sales goals, in the minor unit of the store\'s currency; a goal not set is absent
495
576
  * @export
@@ -4841,6 +4922,43 @@ export interface CreateReservationDto {
4841
4922
  */
4842
4923
  'tableIds'?: Array<string>;
4843
4924
  }
4925
+ /**
4926
+ *
4927
+ * @export
4928
+ * @interface CreateSavedReportDto
4929
+ */
4930
+ export interface CreateSavedReportDto {
4931
+ /**
4932
+ *
4933
+ * @type {SavedReportKind}
4934
+ * @memberof CreateSavedReportDto
4935
+ */
4936
+ 'kind': SavedReportKind;
4937
+ /**
4938
+ * The report\'s name, as people wrote it
4939
+ * @type {string}
4940
+ * @memberof CreateSavedReportDto
4941
+ */
4942
+ 'name': string;
4943
+ /**
4944
+ * The cards in the order they are shown, at most 60; dashboard-one\'s own ids, kept as sent
4945
+ * @type {Array<AnalyticsDashboardCardDto>}
4946
+ * @memberof CreateSavedReportDto
4947
+ */
4948
+ 'cards': Array<AnalyticsDashboardCardDto>;
4949
+ /**
4950
+ *
4951
+ * @type {SavedReportDtoFilters}
4952
+ * @memberof CreateSavedReportDto
4953
+ */
4954
+ 'filters': SavedReportDtoFilters;
4955
+ /**
4956
+ *
4957
+ * @type {SavedReportVisibility}
4958
+ * @memberof CreateSavedReportDto
4959
+ */
4960
+ 'visibility'?: SavedReportVisibility;
4961
+ }
4844
4962
  /**
4845
4963
  *
4846
4964
  * @export
@@ -6544,6 +6662,19 @@ export interface DisplayInitResponseDto {
6544
6662
  */
6545
6663
  'ablyTokenRequest': object;
6546
6664
  }
6665
+ /**
6666
+ *
6667
+ * @export
6668
+ * @interface DuplicateSavedReportDto
6669
+ */
6670
+ export interface DuplicateSavedReportDto {
6671
+ /**
6672
+ * The copy\'s name; the copy is private to the person who makes it
6673
+ * @type {string}
6674
+ * @memberof DuplicateSavedReportDto
6675
+ */
6676
+ 'name': string;
6677
+ }
6547
6678
  /**
6548
6679
  *
6549
6680
  * @export
@@ -18355,6 +18486,27 @@ export declare const PaymentTypeEnum: {
18355
18486
  readonly PayOnDelivery: "pay_on_delivery";
18356
18487
  };
18357
18488
  export type PaymentTypeEnum = typeof PaymentTypeEnum[keyof typeof PaymentTypeEnum];
18489
+ /**
18490
+ *
18491
+ * @export
18492
+ * @enum {string}
18493
+ */
18494
+ export declare const PeriodPreset: {
18495
+ readonly Today: "today";
18496
+ readonly Yesterday: "yesterday";
18497
+ readonly ThisWeek: "thisWeek";
18498
+ readonly LastWeek: "lastWeek";
18499
+ readonly ThisMonth: "thisMonth";
18500
+ readonly LastMonth: "lastMonth";
18501
+ readonly ThisYear: "thisYear";
18502
+ readonly CustomDays: "custom";
18503
+ readonly Day: "DAY";
18504
+ readonly Week: "WEEK";
18505
+ readonly Month: "MONTH";
18506
+ readonly Year: "YEAR";
18507
+ readonly Custom: "CUSTOM";
18508
+ };
18509
+ export type PeriodPreset = typeof PeriodPreset[keyof typeof PeriodPreset];
18358
18510
  /**
18359
18511
  *
18360
18512
  * @export
@@ -19333,6 +19485,12 @@ export interface PosMenuIngredientDto {
19333
19485
  * @memberof PosMenuIngredientDto
19334
19486
  */
19335
19487
  'rank': number;
19488
+ /**
19489
+ * True: the app shows it ticked at first, and the customer unticks it to leave it out. False: shown unticked, and the customer ticks it to have it. Either way, an ingredient left unticked is sent as removed. Always sent: true when Vendure says nothing
19490
+ * @type {boolean}
19491
+ * @memberof PosMenuIngredientDto
19492
+ */
19493
+ 'preselected': boolean;
19336
19494
  }
19337
19495
  /**
19338
19496
  *
@@ -19353,7 +19511,7 @@ export interface PosMenuIngredientSectionDto {
19353
19511
  */
19354
19512
  'heading': string | null;
19355
19513
  /**
19356
- * The ingredients the customer may remove, all ticked to start with. Never empty; hidden ones are not sent
19514
+ * The ingredients the customer may leave out, each ticked at first unless its preselected is false. Never empty; hidden ones are not sent
19357
19515
  * @type {Array<PosMenuIngredientDto>}
19358
19516
  * @memberof PosMenuIngredientSectionDto
19359
19517
  */
@@ -19609,7 +19767,7 @@ export interface PosMenuProductDtoIngredientSection {
19609
19767
  */
19610
19768
  'heading': string | null;
19611
19769
  /**
19612
- * The ingredients the customer may remove, all ticked to start with. Never empty; hidden ones are not sent
19770
+ * The ingredients the customer may leave out, each ticked at first unless its preselected is false. Never empty; hidden ones are not sent
19613
19771
  * @type {Array<PosMenuIngredientDto>}
19614
19772
  * @memberof PosMenuProductDtoIngredientSection
19615
19773
  */
@@ -23247,6 +23405,760 @@ export declare const PubSubTarget: {
23247
23405
  readonly Kds: "KDS";
23248
23406
  };
23249
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
+ }
24088
+ /**
24089
+ *
24090
+ * @export
24091
+ * @interface PublicSavedReportDto
24092
+ */
24093
+ export interface PublicSavedReportDto {
24094
+ /**
24095
+ *
24096
+ * @type {SavedReportKind}
24097
+ * @memberof PublicSavedReportDto
24098
+ */
24099
+ 'kind': SavedReportKind;
24100
+ /**
24101
+ * The report\'s name, as people wrote it
24102
+ * @type {string}
24103
+ * @memberof PublicSavedReportDto
24104
+ */
24105
+ 'name': string;
24106
+ /**
24107
+ * The cards in the order they are shown, at most 60; dashboard-one\'s own ids, kept as sent
24108
+ * @type {Array<AnalyticsDashboardCardDto>}
24109
+ * @memberof PublicSavedReportDto
24110
+ */
24111
+ 'cards': Array<AnalyticsDashboardCardDto>;
24112
+ /**
24113
+ *
24114
+ * @type {SavedReportDtoFilters}
24115
+ * @memberof PublicSavedReportDto
24116
+ */
24117
+ 'filters': SavedReportDtoFilters;
24118
+ /**
24119
+ * The store whose data the report reads, by orderingBusinessId; null for an organisation\'s
24120
+ * @type {number}
24121
+ * @memberof PublicSavedReportDto
24122
+ */
24123
+ 'businessId': number | null;
24124
+ /**
24125
+ * The organisation whose stores the report reads; null for a store\'s
24126
+ * @type {string}
24127
+ * @memberof PublicSavedReportDto
24128
+ */
24129
+ 'groupId': string | null;
24130
+ /**
24131
+ * When it was last saved, ISO 8601 in UTC
24132
+ * @type {string}
24133
+ * @memberof PublicSavedReportDto
24134
+ */
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;
24161
+ }
23250
24162
  /**
23251
24163
  *
23252
24164
  * @export
@@ -23303,6 +24215,21 @@ export interface RankedCategoryDto {
23303
24215
  */
23304
24216
  'enabled': boolean;
23305
24217
  }
24218
+ /**
24219
+ *
24220
+ * @export
24221
+ * @enum {string}
24222
+ */
24223
+ export declare const ReadyMadeReport: {
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";
24231
+ };
24232
+ export type ReadyMadeReport = typeof ReadyMadeReport[keyof typeof ReadyMadeReport];
23306
24233
  /**
23307
24234
  *
23308
24235
  * @export
@@ -24309,6 +25236,18 @@ export declare const ReportBreakdown: {
24309
25236
  readonly VenueApp: "venue_app";
24310
25237
  };
24311
25238
  export type ReportBreakdown = typeof ReportBreakdown[keyof typeof ReportBreakdown];
25239
+ /**
25240
+ *
25241
+ * @export
25242
+ * @enum {string}
25243
+ */
25244
+ export declare const ReportCadence: {
25245
+ readonly Daily: "daily";
25246
+ readonly Weekly: "weekly";
25247
+ readonly Monthly: "monthly";
25248
+ readonly Off: "off";
25249
+ };
25250
+ export type ReportCadence = typeof ReportCadence[keyof typeof ReportCadence];
24312
25251
  /**
24313
25252
  *
24314
25253
  * @export
@@ -24342,6 +25281,75 @@ export declare const ReportChangeField: {
24342
25281
  readonly AverageOrderValue: "averageOrderValue";
24343
25282
  };
24344
25283
  export type ReportChangeField = typeof ReportChangeField[keyof typeof ReportChangeField];
25284
+ /**
25285
+ *
25286
+ * @export
25287
+ * @interface ReportFiltersDto
25288
+ */
25289
+ export interface ReportFiltersDto {
25290
+ /**
25291
+ *
25292
+ * @type {ReportFiltersDtoA}
25293
+ * @memberof ReportFiltersDto
25294
+ */
25295
+ 'a': ReportFiltersDtoA;
25296
+ /**
25297
+ *
25298
+ * @type {ReportFiltersDtoB}
25299
+ * @memberof ReportFiltersDto
25300
+ */
25301
+ 'b'?: ReportFiltersDtoB;
25302
+ }
25303
+ /**
25304
+ * Side A: a report\'s only side, a comparison\'s first
25305
+ * @export
25306
+ * @interface ReportFiltersDtoA
25307
+ */
25308
+ export interface ReportFiltersDtoA {
25309
+ /**
25310
+ *
25311
+ * @type {AnalyticsDashboardFiltersDtoPeriod}
25312
+ * @memberof ReportFiltersDtoA
25313
+ */
25314
+ 'period': AnalyticsDashboardFiltersDtoPeriod;
25315
+ /**
25316
+ * The apps it counts; an empty list counts every app
25317
+ * @type {Array<ReportApp>}
25318
+ * @memberof ReportFiltersDtoA
25319
+ */
25320
+ 'channels': Array<ReportApp>;
25321
+ /**
25322
+ * The stores the side counts, by orderingBusinessId, at most 200; an empty list counts the report\'s own store, or every store of its organisation. Each must be the report\'s own store or one of its organisation\'s, checked on save.
25323
+ * @type {Array<number>}
25324
+ * @memberof ReportFiltersDtoA
25325
+ */
25326
+ 'stores': Array<number>;
25327
+ }
25328
+ /**
25329
+ * Side B: a comparison\'s second side; required for a comparison, refused for a report
25330
+ * @export
25331
+ * @interface ReportFiltersDtoB
25332
+ */
25333
+ export interface ReportFiltersDtoB {
25334
+ /**
25335
+ *
25336
+ * @type {AnalyticsDashboardFiltersDtoPeriod}
25337
+ * @memberof ReportFiltersDtoB
25338
+ */
25339
+ 'period': AnalyticsDashboardFiltersDtoPeriod;
25340
+ /**
25341
+ * The apps it counts; an empty list counts every app
25342
+ * @type {Array<ReportApp>}
25343
+ * @memberof ReportFiltersDtoB
25344
+ */
25345
+ 'channels': Array<ReportApp>;
25346
+ /**
25347
+ * The stores the side counts, by orderingBusinessId, at most 200; an empty list counts the report\'s own store, or every store of its organisation. Each must be the report\'s own store or one of its organisation\'s, checked on save.
25348
+ * @type {Array<number>}
25349
+ * @memberof ReportFiltersDtoB
25350
+ */
25351
+ 'stores': Array<number>;
25352
+ }
24345
25353
  /**
24346
25354
  *
24347
25355
  * @export
@@ -24377,6 +25385,318 @@ export declare const ReportPart: {
24377
25385
  readonly Discounts: "discounts";
24378
25386
  };
24379
25387
  export type ReportPart = typeof ReportPart[keyof typeof ReportPart];
25388
+ /**
25389
+ *
25390
+ * @export
25391
+ * @interface ReportPeriodDto
25392
+ */
25393
+ export interface ReportPeriodDto {
25394
+ /**
25395
+ *
25396
+ * @type {PeriodPreset}
25397
+ * @memberof ReportPeriodDto
25398
+ */
25399
+ 'preset': PeriodPreset;
25400
+ /**
25401
+ * The first day of a custom period, YYYY-MM-DD in the store\'s zone; only with custom (or CUSTOM), refused with any other
25402
+ * @type {string}
25403
+ * @memberof ReportPeriodDto
25404
+ */
25405
+ 'startDay'?: string;
25406
+ /**
25407
+ * The last day of a custom period, inclusive, YYYY-MM-DD, startDay or later; only with custom (or CUSTOM), refused with any other
25408
+ * @type {string}
25409
+ * @memberof ReportPeriodDto
25410
+ */
25411
+ 'endDay'?: string;
25412
+ }
25413
+ /**
25414
+ *
25415
+ * @export
25416
+ * @interface ReportRunDto
25417
+ */
25418
+ export interface ReportRunDto {
25419
+ /**
25420
+ * The run\'s id; dashboard-one opens it at /reports/runs/{id}
25421
+ * @type {string}
25422
+ * @memberof ReportRunDto
25423
+ */
25424
+ 'id': string;
25425
+ /**
25426
+ * The first day reported on, YYYY-MM-DD
25427
+ * @type {string}
25428
+ * @memberof ReportRunDto
25429
+ */
25430
+ 'periodStart': string;
25431
+ /**
25432
+ * The last day reported on, inclusive, YYYY-MM-DD
25433
+ * @type {string}
25434
+ * @memberof ReportRunDto
25435
+ */
25436
+ 'periodEnd': string;
25437
+ /**
25438
+ * When the run was made, ISO 8601 in UTC
25439
+ * @type {string}
25440
+ * @memberof ReportRunDto
25441
+ */
25442
+ 'madeAt': string;
25443
+ /**
25444
+ *
25445
+ * @type {ReportRunStatus}
25446
+ * @memberof ReportRunDto
25447
+ */
25448
+ 'status': ReportRunStatus;
25449
+ /**
25450
+ * Who it was sent to; only to those who manage its report, absent for everyone else
25451
+ * @type {Array<string>}
25452
+ * @memberof ReportRunDto
25453
+ */
25454
+ 'recipients'?: Array<string>;
25455
+ /**
25456
+ * The formats it kept a file in, each downloadable: pdf and xlsx for a ready-made report; none for a saved report or comparison, whose run opens the report for its days
25457
+ * @type {Array<FileFormat>}
25458
+ * @memberof ReportRunDto
25459
+ */
25460
+ 'formats': Array<FileFormat>;
25461
+ /**
25462
+ * Why a run kept no file or sent no email, in Munchi\'s words; null when it did both
25463
+ * @type {string}
25464
+ * @memberof ReportRunDto
25465
+ */
25466
+ 'note': string | null;
25467
+ }
25468
+ /**
25469
+ *
25470
+ * @export
25471
+ * @interface ReportRunFileDto
25472
+ */
25473
+ export interface ReportRunFileDto {
25474
+ /**
25475
+ * A signed address that downloads the file, good until expiresAt; needs no sign-in
25476
+ * @type {string}
25477
+ * @memberof ReportRunFileDto
25478
+ */
25479
+ 'url': string;
25480
+ /**
25481
+ * When the address stops working, ISO 8601 in UTC
25482
+ * @type {string}
25483
+ * @memberof ReportRunFileDto
25484
+ */
25485
+ 'expiresAt': string;
25486
+ }
25487
+ /**
25488
+ *
25489
+ * @export
25490
+ * @interface ReportRunListDto
25491
+ */
25492
+ export interface ReportRunListDto {
25493
+ /**
25494
+ * The runs, newest first
25495
+ * @type {Array<ReportRunDto>}
25496
+ * @memberof ReportRunListDto
25497
+ */
25498
+ 'runs': Array<ReportRunDto>;
25499
+ /**
25500
+ * Send as after for the next page; null on the last page
25501
+ * @type {string}
25502
+ * @memberof ReportRunListDto
25503
+ */
25504
+ 'nextAfter': string | null;
25505
+ }
25506
+ /**
25507
+ *
25508
+ * @export
25509
+ * @interface ReportRunOpenedDto
25510
+ */
25511
+ export interface ReportRunOpenedDto {
25512
+ /**
25513
+ * The run\'s id; dashboard-one opens it at /reports/runs/{id}
25514
+ * @type {string}
25515
+ * @memberof ReportRunOpenedDto
25516
+ */
25517
+ 'id': string;
25518
+ /**
25519
+ * The first day reported on, YYYY-MM-DD
25520
+ * @type {string}
25521
+ * @memberof ReportRunOpenedDto
25522
+ */
25523
+ 'periodStart': string;
25524
+ /**
25525
+ * The last day reported on, inclusive, YYYY-MM-DD
25526
+ * @type {string}
25527
+ * @memberof ReportRunOpenedDto
25528
+ */
25529
+ 'periodEnd': string;
25530
+ /**
25531
+ * When the run was made, ISO 8601 in UTC
25532
+ * @type {string}
25533
+ * @memberof ReportRunOpenedDto
25534
+ */
25535
+ 'madeAt': string;
25536
+ /**
25537
+ *
25538
+ * @type {ReportRunStatus}
25539
+ * @memberof ReportRunOpenedDto
25540
+ */
25541
+ 'status': ReportRunStatus;
25542
+ /**
25543
+ * Who it was sent to; only to those who manage its report, absent for everyone else
25544
+ * @type {Array<string>}
25545
+ * @memberof ReportRunOpenedDto
25546
+ */
25547
+ 'recipients'?: Array<string>;
25548
+ /**
25549
+ * The formats it kept a file in, each downloadable: pdf and xlsx for a ready-made report; none for a saved report or comparison, whose run opens the report for its days
25550
+ * @type {Array<FileFormat>}
25551
+ * @memberof ReportRunOpenedDto
25552
+ */
25553
+ 'formats': Array<FileFormat>;
25554
+ /**
25555
+ * Why a run kept no file or sent no email, in Munchi\'s words; null when it did both
25556
+ * @type {string}
25557
+ * @memberof ReportRunOpenedDto
25558
+ */
25559
+ 'note': string | null;
25560
+ /**
25561
+ * The store the run belongs to, by orderingBusinessId; null for an organisation\'s
25562
+ * @type {number}
25563
+ * @memberof ReportRunOpenedDto
25564
+ */
25565
+ 'businessId': number | null;
25566
+ /**
25567
+ * The organisation the run belongs to (its licence server group); null for a store\'s
25568
+ * @type {string}
25569
+ * @memberof ReportRunOpenedDto
25570
+ */
25571
+ 'groupId': string | null;
25572
+ /**
25573
+ * The saved report it sent; null for a ready-made report
25574
+ * @type {string}
25575
+ * @memberof ReportRunOpenedDto
25576
+ */
25577
+ 'savedReportId': string | null;
25578
+ /**
25579
+ *
25580
+ * @type {ReadyMadeReport}
25581
+ * @memberof ReportRunOpenedDto
25582
+ */
25583
+ 'readyMadeReport': ReadyMadeReport | null;
25584
+ }
25585
+ /**
25586
+ *
25587
+ * @export
25588
+ * @enum {string}
25589
+ */
25590
+ export declare const ReportRunStatus: {
25591
+ readonly Making: "making";
25592
+ readonly Sent: "sent";
25593
+ readonly Failed: "failed";
25594
+ };
25595
+ export type ReportRunStatus = typeof ReportRunStatus[keyof typeof ReportRunStatus];
25596
+ /**
25597
+ *
25598
+ * @export
25599
+ * @interface ReportScheduleDto
25600
+ */
25601
+ export interface ReportScheduleDto {
25602
+ /**
25603
+ *
25604
+ * @type {ReportCadence}
25605
+ * @memberof ReportScheduleDto
25606
+ */
25607
+ 'cadence': ReportCadence;
25608
+ /**
25609
+ * The ISO weekday a weekly schedule sends on, 1 Monday to 7 Sunday; only for weekly
25610
+ * @type {number}
25611
+ * @memberof ReportScheduleDto
25612
+ */
25613
+ 'weekday'?: number | null;
25614
+ /**
25615
+ * The time it sends at, HH:MM on the clock of timeZone
25616
+ * @type {string}
25617
+ * @memberof ReportScheduleDto
25618
+ */
25619
+ 'time': string;
25620
+ /**
25621
+ * Who gets an email with a link to each run, any addresses, 0 to 20. An empty list emails nobody: each run is still saved under the report\'s past runs.
25622
+ * @type {Array<string>}
25623
+ * @memberof ReportScheduleDto
25624
+ */
25625
+ 'recipients': Array<string>;
25626
+ /**
25627
+ * The schedule\'s id
25628
+ * @type {string}
25629
+ * @memberof ReportScheduleDto
25630
+ */
25631
+ 'id': string;
25632
+ /**
25633
+ * The saved report it sends; null for a ready-made report
25634
+ * @type {string}
25635
+ * @memberof ReportScheduleDto
25636
+ */
25637
+ 'savedReportId': string | null;
25638
+ /**
25639
+ *
25640
+ * @type {ReadyMadeReport}
25641
+ * @memberof ReportScheduleDto
25642
+ */
25643
+ 'readyMadeReport': ReadyMadeReport | null;
25644
+ /**
25645
+ * The IANA time zone time is read in
25646
+ * @type {string}
25647
+ * @memberof ReportScheduleDto
25648
+ */
25649
+ 'timeZone': string;
25650
+ /**
25651
+ * When it next sends, ISO 8601 in UTC; null while off
25652
+ * @type {string}
25653
+ * @memberof ReportScheduleDto
25654
+ */
25655
+ 'nextRunAt': string | null;
25656
+ /**
25657
+ * 1 when made, one more on each save
25658
+ * @type {number}
25659
+ * @memberof ReportScheduleDto
25660
+ */
25661
+ 'version': number;
25662
+ /**
25663
+ * When it was last saved, ISO 8601 in UTC
25664
+ * @type {string}
25665
+ * @memberof ReportScheduleDto
25666
+ */
25667
+ 'updatedAt': string;
25668
+ /**
25669
+ * The Clerk user id of who last saved it
25670
+ * @type {string}
25671
+ * @memberof ReportScheduleDto
25672
+ */
25673
+ 'updatedBy': string;
25674
+ }
25675
+ /**
25676
+ *
25677
+ * @export
25678
+ * @interface ReportSideDto
25679
+ */
25680
+ export interface ReportSideDto {
25681
+ /**
25682
+ *
25683
+ * @type {AnalyticsDashboardFiltersDtoPeriod}
25684
+ * @memberof ReportSideDto
25685
+ */
25686
+ 'period': AnalyticsDashboardFiltersDtoPeriod;
25687
+ /**
25688
+ * The apps it counts; an empty list counts every app
25689
+ * @type {Array<ReportApp>}
25690
+ * @memberof ReportSideDto
25691
+ */
25692
+ 'channels': Array<ReportApp>;
25693
+ /**
25694
+ * The stores the side counts, by orderingBusinessId, at most 200; an empty list counts the report\'s own store, or every store of its organisation. Each must be the report\'s own store or one of its organisation\'s, checked on save.
25695
+ * @type {Array<number>}
25696
+ * @memberof ReportSideDto
25697
+ */
25698
+ 'stores': Array<number>;
25699
+ }
24380
25700
  /**
24381
25701
  *
24382
25702
  * @export
@@ -25329,7 +26649,7 @@ export interface SalesReportComparisonDto {
25329
26649
  */
25330
26650
  'lastBusinessDay': string;
25331
26651
  /**
25332
- * compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is cut at the same hour of its day, so both sides cover the same hours: the group\'s totals and dailyBreakdown of that day stop there too. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
26652
+ * compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is never cut: the group\'s totals and dailyBreakdown count it up to dataUntil, as without compareSameTime. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
25333
26653
  * @type {string}
25334
26654
  * @memberof SalesReportComparisonDto
25335
26655
  */
@@ -25647,7 +26967,7 @@ export interface SalesReportGroupDtoComparison {
25647
26967
  */
25648
26968
  'lastBusinessDay': string;
25649
26969
  /**
25650
- * compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is cut at the same hour of its day, so both sides cover the same hours: the group\'s totals and dailyBreakdown of that day stop there too. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
26970
+ * compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is never cut: the group\'s totals and dailyBreakdown count it up to dataUntil, as without compareSameTime. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
25651
26971
  * @type {string}
25652
26972
  * @memberof SalesReportGroupDtoComparison
25653
26973
  */
@@ -26719,7 +28039,7 @@ export interface SalesReportShortComparisonDto {
26719
28039
  */
26720
28040
  'lastBusinessDay': string;
26721
28041
  /**
26722
- * compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is cut at the same hour of its day, so both sides cover the same hours: the group\'s totals and dailyBreakdown of that day stop there too. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
28042
+ * compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is never cut: the group\'s totals and dailyBreakdown count it up to dataUntil, as without compareSameTime. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
26723
28043
  * @type {string}
26724
28044
  * @memberof SalesReportShortComparisonDto
26725
28045
  */
@@ -26938,7 +28258,7 @@ export interface SalesReportShortGroupDtoComparison {
26938
28258
  */
26939
28259
  'lastBusinessDay': string;
26940
28260
  /**
26941
- * compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is cut at the same hour of its day, so both sides cover the same hours: the group\'s totals and dailyBreakdown of that day stop there too. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
28261
+ * compareSameTime only: the instant the compared last day was added up to, ISO 8601 in UTC: that day at the last full hour, on the report\'s clock, that both the daily rows and the hours have reached on the report\'s last day (a client says \"until 14:00\"). The report\'s own last day is never cut: the group\'s totals and dailyBreakdown count it up to dataUntil, as without compareSameTime. Present when no venue and app of the group was compared whole that day (one that sold nothing that day counts as cut); absent when compareSameTime was not sent, the report\'s last day is over, or a venue\'s day had no hours yet and was compared whole. In a group of venues in several time zones each venue is cut at its own clock\'s hour of the same instant, which this names in the report\'s time zone
26942
28262
  * @type {string}
26943
28263
  * @memberof SalesReportShortGroupDtoComparison
26944
28264
  */
@@ -27175,6 +28495,166 @@ export interface SalesReportShortSalesDto {
27175
28495
  */
27176
28496
  'topItemsByQuantity'?: Array<SalesReportTopItemDto>;
27177
28497
  }
28498
+ /**
28499
+ *
28500
+ * @export
28501
+ * @interface SalesReportStaffGroupDto
28502
+ */
28503
+ export interface SalesReportStaffGroupDto {
28504
+ /**
28505
+ * The venue\'s orderingBusinessId
28506
+ * @type {number}
28507
+ * @memberof SalesReportStaffGroupDto
28508
+ */
28509
+ 'businessId': number;
28510
+ /**
28511
+ *
28512
+ * @type {CurrencyCode}
28513
+ * @memberof SalesReportStaffGroupDto
28514
+ */
28515
+ 'currency': CurrencyCode;
28516
+ /**
28517
+ * Decimals of the currency\'s minor unit (2 for EUR)
28518
+ * @type {number}
28519
+ * @memberof SalesReportStaffGroupDto
28520
+ */
28521
+ 'minorDigits': number;
28522
+ /**
28523
+ * Every staff member with POS orders in the period, by staffId; the members add up to the venue\'s POS day totals
28524
+ * @type {Array<SalesReportStaffMemberDto>}
28525
+ * @memberof SalesReportStaffGroupDto
28526
+ */
28527
+ 'staff': Array<SalesReportStaffMemberDto>;
28528
+ }
28529
+ /**
28530
+ *
28531
+ * @export
28532
+ * @interface SalesReportStaffMemberDto
28533
+ */
28534
+ export interface SalesReportStaffMemberDto {
28535
+ /**
28536
+ * The staff member\'s id on the POS orders (the order\'s staffId); the empty text is the orders that name nobody
28537
+ * @type {string}
28538
+ * @memberof SalesReportStaffMemberDto
28539
+ */
28540
+ 'staffId': string;
28541
+ /**
28542
+ * Orders not refunded, or refunded in part (the POS app\'s totalOrders)
28543
+ * @type {number}
28544
+ * @memberof SalesReportStaffMemberDto
28545
+ */
28546
+ 'orderCount': number;
28547
+ /**
28548
+ * Every payment not reverted, less its rounding, fully refunded orders included (totalSales), in the major unit
28549
+ * @type {number}
28550
+ * @memberof SalesReportStaffMemberDto
28551
+ */
28552
+ 'sales': number;
28553
+ /**
28554
+ * Every successful refund of the period\'s orders, refunded in part or in full (totalRefunds), in the major unit
28555
+ * @type {number}
28556
+ * @memberof SalesReportStaffMemberDto
28557
+ */
28558
+ 'refunds': number;
28559
+ /**
28560
+ * The baskets\' discounts of orders not refunded in full (totalDiscounts), in the major unit
28561
+ * @type {number}
28562
+ * @memberof SalesReportStaffMemberDto
28563
+ */
28564
+ 'discounts': number;
28565
+ /**
28566
+ * The quantity of every item not cancelled, of orders not refunded in full (totalItemsCount)
28567
+ * @type {number}
28568
+ * @memberof SalesReportStaffMemberDto
28569
+ */
28570
+ 'itemQuantity': number;
28571
+ /**
28572
+ * Tips, in the major unit
28573
+ * @type {number}
28574
+ * @memberof SalesReportStaffMemberDto
28575
+ */
28576
+ 'tips': number;
28577
+ /**
28578
+ * Each payment method the staff member took, by paymentMethod
28579
+ * @type {Array<SalesReportStaffPaymentDto>}
28580
+ * @memberof SalesReportStaffMemberDto
28581
+ */
28582
+ 'payments': Array<SalesReportStaffPaymentDto>;
28583
+ }
28584
+ /**
28585
+ *
28586
+ * @export
28587
+ * @interface SalesReportStaffPaymentDto
28588
+ */
28589
+ export interface SalesReportStaffPaymentDto {
28590
+ /**
28591
+ * The payment method as the POS app\'s end-of-day report keys it: its label, else its type, in lower case with every \'.\' made \'_\'
28592
+ * @type {string}
28593
+ * @memberof SalesReportStaffPaymentDto
28594
+ */
28595
+ 'paymentMethod': string;
28596
+ /**
28597
+ * Payments not reverted, less one for each refund of an order refunded in full (the POS app\'s transactionCount)
28598
+ * @type {number}
28599
+ * @memberof SalesReportStaffPaymentDto
28600
+ */
28601
+ 'transactionCount': number;
28602
+ /**
28603
+ * The payments less their rounding and their refunds, in the major unit
28604
+ * @type {number}
28605
+ * @memberof SalesReportStaffPaymentDto
28606
+ */
28607
+ 'sold': number;
28608
+ /**
28609
+ * As sold, and zero for a voucher, which is no money paid; in the major unit
28610
+ * @type {number}
28611
+ * @memberof SalesReportStaffPaymentDto
28612
+ */
28613
+ 'paid': number;
28614
+ }
28615
+ /**
28616
+ *
28617
+ * @export
28618
+ * @interface SalesReportStaffResponseDto
28619
+ */
28620
+ export interface SalesReportStaffResponseDto {
28621
+ /**
28622
+ * The first instant of the period, ISO 8601 in UTC
28623
+ * @type {string}
28624
+ * @memberof SalesReportStaffResponseDto
28625
+ */
28626
+ 'reportDateStart': string;
28627
+ /**
28628
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
28629
+ * @type {string}
28630
+ * @memberof SalesReportStaffResponseDto
28631
+ */
28632
+ 'reportDateEnd': string;
28633
+ /**
28634
+ * The IANA time zone the period\'s days are read in
28635
+ * @type {string}
28636
+ * @memberof SalesReportStaffResponseDto
28637
+ */
28638
+ 'timezone': string;
28639
+ /**
28640
+ * The first business day, YYYY-MM-DD
28641
+ * @type {string}
28642
+ * @memberof SalesReportStaffResponseDto
28643
+ */
28644
+ 'firstBusinessDay': string;
28645
+ /**
28646
+ * The last business day, YYYY-MM-DD, inclusive
28647
+ * @type {string}
28648
+ * @memberof SalesReportStaffResponseDto
28649
+ */
28650
+ 'lastBusinessDay': string;
28651
+ /**
28652
+ * One group per venue and currency that sold on the POS in the period; a venue with no POS orders answers no group
28653
+ * @type {Array<SalesReportStaffGroupDto>}
28654
+ * @memberof SalesReportStaffResponseDto
28655
+ */
28656
+ 'groups': Array<SalesReportStaffGroupDto>;
28657
+ }
27178
28658
  /**
27179
28659
  *
27180
28660
  * @export
@@ -27358,6 +28838,12 @@ export interface SaveAnalyticsDashboardDto {
27358
28838
  * @memberof SaveAnalyticsDashboardDto
27359
28839
  */
27360
28840
  'goals': SaveAnalyticsDashboardDtoGoals;
28841
+ /**
28842
+ *
28843
+ * @type {SaveAnalyticsDashboardDtoFilters}
28844
+ * @memberof SaveAnalyticsDashboardDto
28845
+ */
28846
+ 'filters'?: SaveAnalyticsDashboardDtoFilters;
27361
28847
  /**
27362
28848
  * The version the dashboard was read at, from its GET. Absent or null only to create the first dashboard; answered 409 when someone saved since, or when one already exists.
27363
28849
  * @type {number}
@@ -27365,6 +28851,31 @@ export interface SaveAnalyticsDashboardDto {
27365
28851
  */
27366
28852
  'expectedVersion'?: number | null;
27367
28853
  }
28854
+ /**
28855
+ * The period, apps and stores the dashboard reads. Absent on a save: the dashboard keeps the ones it has, so a save from before they were kept loses none.
28856
+ * @export
28857
+ * @interface SaveAnalyticsDashboardDtoFilters
28858
+ */
28859
+ export interface SaveAnalyticsDashboardDtoFilters {
28860
+ /**
28861
+ *
28862
+ * @type {AnalyticsDashboardFiltersDtoPeriod}
28863
+ * @memberof SaveAnalyticsDashboardDtoFilters
28864
+ */
28865
+ 'period': AnalyticsDashboardFiltersDtoPeriod;
28866
+ /**
28867
+ * The apps it counts; an empty list counts every app
28868
+ * @type {Array<ReportApp>}
28869
+ * @memberof SaveAnalyticsDashboardDtoFilters
28870
+ */
28871
+ 'channels': Array<ReportApp>;
28872
+ /**
28873
+ * The stores it counts, by orderingBusinessId, at most 200: the dashboard\'s own store, or stores of its organisation. Absent or empty: the dashboard\'s own store, or every store of its organisation.
28874
+ * @type {Array<number>}
28875
+ * @memberof SaveAnalyticsDashboardDtoFilters
28876
+ */
28877
+ 'stores'?: Array<number>;
28878
+ }
27368
28879
  /**
27369
28880
  * The sales goals the cards measure against; an empty object saves none.
27370
28881
  * @export
@@ -27397,6 +28908,156 @@ export interface SaveEpassiCredentialsDto {
27397
28908
  */
27398
28909
  'posName': string;
27399
28910
  }
28911
+ /**
28912
+ *
28913
+ * @export
28914
+ * @interface SavedReportDto
28915
+ */
28916
+ export interface SavedReportDto {
28917
+ /**
28918
+ *
28919
+ * @type {SavedReportKind}
28920
+ * @memberof SavedReportDto
28921
+ */
28922
+ 'kind': SavedReportKind;
28923
+ /**
28924
+ * The report\'s name, as people wrote it
28925
+ * @type {string}
28926
+ * @memberof SavedReportDto
28927
+ */
28928
+ 'name': string;
28929
+ /**
28930
+ * The cards in the order they are shown, at most 60; dashboard-one\'s own ids, kept as sent
28931
+ * @type {Array<AnalyticsDashboardCardDto>}
28932
+ * @memberof SavedReportDto
28933
+ */
28934
+ 'cards': Array<AnalyticsDashboardCardDto>;
28935
+ /**
28936
+ *
28937
+ * @type {SavedReportDtoFilters}
28938
+ * @memberof SavedReportDto
28939
+ */
28940
+ 'filters': SavedReportDtoFilters;
28941
+ /**
28942
+ * The report\'s id
28943
+ * @type {string}
28944
+ * @memberof SavedReportDto
28945
+ */
28946
+ 'id': string;
28947
+ /**
28948
+ * The store it belongs to, by orderingBusinessId; null for an organisation\'s
28949
+ * @type {number}
28950
+ * @memberof SavedReportDto
28951
+ */
28952
+ 'businessId': number | null;
28953
+ /**
28954
+ * The organisation it belongs to (its licence server group); null for a store\'s
28955
+ * @type {string}
28956
+ * @memberof SavedReportDto
28957
+ */
28958
+ 'groupId': string | null;
28959
+ /**
28960
+ *
28961
+ * @type {SavedReportVisibility}
28962
+ * @memberof SavedReportDto
28963
+ */
28964
+ 'visibility': SavedReportVisibility;
28965
+ /**
28966
+ * The link\'s token while the report is public (GET /api/v6/public-reports/{token}); null otherwise
28967
+ * @type {string}
28968
+ * @memberof SavedReportDto
28969
+ */
28970
+ 'publicToken': string | null;
28971
+ /**
28972
+ * The Clerk user id of the person who made it
28973
+ * @type {string}
28974
+ * @memberof SavedReportDto
28975
+ */
28976
+ 'ownerId': string;
28977
+ /**
28978
+ * 1 when made, one more on each save. Send it back as expectedVersion.
28979
+ * @type {number}
28980
+ * @memberof SavedReportDto
28981
+ */
28982
+ 'version': number;
28983
+ /**
28984
+ * When it was made, ISO 8601 in UTC
28985
+ * @type {string}
28986
+ * @memberof SavedReportDto
28987
+ */
28988
+ 'createdAt': string;
28989
+ /**
28990
+ * When it was last saved, ISO 8601 in UTC
28991
+ * @type {string}
28992
+ * @memberof SavedReportDto
28993
+ */
28994
+ 'updatedAt': string;
28995
+ /**
28996
+ * The Clerk user id of who last saved it
28997
+ * @type {string}
28998
+ * @memberof SavedReportDto
28999
+ */
29000
+ 'updatedBy': string;
29001
+ }
29002
+ /**
29003
+ * What the report reads
29004
+ * @export
29005
+ * @interface SavedReportDtoFilters
29006
+ */
29007
+ export interface SavedReportDtoFilters {
29008
+ /**
29009
+ *
29010
+ * @type {ReportFiltersDtoA}
29011
+ * @memberof SavedReportDtoFilters
29012
+ */
29013
+ 'a': ReportFiltersDtoA;
29014
+ /**
29015
+ *
29016
+ * @type {ReportFiltersDtoB}
29017
+ * @memberof SavedReportDtoFilters
29018
+ */
29019
+ 'b'?: ReportFiltersDtoB;
29020
+ }
29021
+ /**
29022
+ *
29023
+ * @export
29024
+ * @enum {string}
29025
+ */
29026
+ export declare const SavedReportKind: {
29027
+ readonly Report: "report";
29028
+ readonly Comparison: "comparison";
29029
+ };
29030
+ export type SavedReportKind = typeof SavedReportKind[keyof typeof SavedReportKind];
29031
+ /**
29032
+ *
29033
+ * @export
29034
+ * @interface SavedReportListDto
29035
+ */
29036
+ export interface SavedReportListDto {
29037
+ /**
29038
+ * The caller\'s own private reports and the shared ones, last saved first
29039
+ * @type {Array<SavedReportDto>}
29040
+ * @memberof SavedReportListDto
29041
+ */
29042
+ 'reports': Array<SavedReportDto>;
29043
+ /**
29044
+ * Send as after for the next page; null on the last page
29045
+ * @type {string}
29046
+ * @memberof SavedReportListDto
29047
+ */
29048
+ 'nextAfter': string | null;
29049
+ }
29050
+ /**
29051
+ *
29052
+ * @export
29053
+ * @enum {string}
29054
+ */
29055
+ export declare const SavedReportVisibility: {
29056
+ readonly Private: "private";
29057
+ readonly Organisation: "organisation";
29058
+ readonly Public: "public";
29059
+ };
29060
+ export type SavedReportVisibility = typeof SavedReportVisibility[keyof typeof SavedReportVisibility];
27400
29061
  /**
27401
29062
  *
27402
29063
  * @export
@@ -27596,6 +29257,68 @@ export interface SetEmployeeRoleDto {
27596
29257
  */
27597
29258
  'roleId': string;
27598
29259
  }
29260
+ /**
29261
+ *
29262
+ * @export
29263
+ * @interface SetReportScheduleDto
29264
+ */
29265
+ export interface SetReportScheduleDto {
29266
+ /**
29267
+ *
29268
+ * @type {ReportCadence}
29269
+ * @memberof SetReportScheduleDto
29270
+ */
29271
+ 'cadence': ReportCadence;
29272
+ /**
29273
+ * The ISO weekday a weekly schedule sends on, 1 Monday to 7 Sunday; only for weekly
29274
+ * @type {number}
29275
+ * @memberof SetReportScheduleDto
29276
+ */
29277
+ 'weekday'?: number | null;
29278
+ /**
29279
+ * The time it sends at, HH:MM on the clock of timeZone
29280
+ * @type {string}
29281
+ * @memberof SetReportScheduleDto
29282
+ */
29283
+ 'time': string;
29284
+ /**
29285
+ * Who gets an email with a link to each run, any addresses, 0 to 20. An empty list emails nobody: each run is still saved under the report\'s past runs.
29286
+ * @type {Array<string>}
29287
+ * @memberof SetReportScheduleDto
29288
+ */
29289
+ 'recipients': Array<string>;
29290
+ /**
29291
+ * The IANA time zone time is read in. A store\'s schedule: absent is the store\'s own zone. An organisation\'s: required.
29292
+ * @type {string}
29293
+ * @memberof SetReportScheduleDto
29294
+ */
29295
+ 'timeZone'?: string;
29296
+ /**
29297
+ * The version the schedule was read at. Absent or null only to make the first; answered 409 when someone saved since, or when one already exists.
29298
+ * @type {number}
29299
+ * @memberof SetReportScheduleDto
29300
+ */
29301
+ 'expectedVersion'?: number | null;
29302
+ }
29303
+ /**
29304
+ *
29305
+ * @export
29306
+ * @interface SetSavedReportVisibilityDto
29307
+ */
29308
+ export interface SetSavedReportVisibilityDto {
29309
+ /**
29310
+ *
29311
+ * @type {SavedReportVisibility}
29312
+ * @memberof SetSavedReportVisibilityDto
29313
+ */
29314
+ 'visibility': SavedReportVisibility;
29315
+ /**
29316
+ * The version the report was read at; answered 409 when someone saved it since
29317
+ * @type {number}
29318
+ * @memberof SetSavedReportVisibilityDto
29319
+ */
29320
+ 'expectedVersion': number;
29321
+ }
27599
29322
  /**
27600
29323
  *
27601
29324
  * @export
@@ -32702,6 +34425,43 @@ export interface UpdateReservationStatusDto {
32702
34425
  */
32703
34426
  'tableIds'?: Array<string>;
32704
34427
  }
34428
+ /**
34429
+ *
34430
+ * @export
34431
+ * @interface UpdateSavedReportDto
34432
+ */
34433
+ export interface UpdateSavedReportDto {
34434
+ /**
34435
+ *
34436
+ * @type {SavedReportKind}
34437
+ * @memberof UpdateSavedReportDto
34438
+ */
34439
+ 'kind': SavedReportKind;
34440
+ /**
34441
+ * The report\'s name, as people wrote it
34442
+ * @type {string}
34443
+ * @memberof UpdateSavedReportDto
34444
+ */
34445
+ 'name': string;
34446
+ /**
34447
+ * The cards in the order they are shown, at most 60; dashboard-one\'s own ids, kept as sent
34448
+ * @type {Array<AnalyticsDashboardCardDto>}
34449
+ * @memberof UpdateSavedReportDto
34450
+ */
34451
+ 'cards': Array<AnalyticsDashboardCardDto>;
34452
+ /**
34453
+ *
34454
+ * @type {SavedReportDtoFilters}
34455
+ * @memberof UpdateSavedReportDto
34456
+ */
34457
+ 'filters': SavedReportDtoFilters;
34458
+ /**
34459
+ * The version the report was read at; answered 409 when someone saved it since
34460
+ * @type {number}
34461
+ * @memberof UpdateSavedReportDto
34462
+ */
34463
+ 'expectedVersion': number;
34464
+ }
32705
34465
  /**
32706
34466
  *
32707
34467
  * @export
@@ -49674,7 +51434,7 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
49674
51434
  * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
49675
51435
  * @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\&#39;s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
49676
51436
  * @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
49677
- * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, both last days, the report\&#39;s and the compared one, are added up only to the last full hour the data has reached, on each venue\&#39;s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\&#39;s and paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
51437
+ * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, the compared last day is added up only to the last full hour the data has reached on the report\&#39;s last day, on each venue\&#39;s own clock (today so far against that day until 14:00); its earlier days stay whole. The report\&#39;s own period is never cut: its totals are those of the same report without compareSameTime, up to dataUntil. Each group whose compared day was cut answers comparison.comparedUntil. Only the compared totals are cut (comparison.salesReport\&#39;s and comparison.paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the compared day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
49678
51438
  * @param {string} [baseline] One group of the answer every other group is compared with: venue:&lt;id&gt; with breakdown venue, app:&lt;app&gt; with breakdown app, venue:&lt;id&gt;,app:&lt;app&gt; 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\&#39;s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
49679
51439
  * @param {*} [options] Override http request option.
49680
51440
  * @throws {RequiredError}
@@ -49725,6 +51485,20 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
49725
51485
  * @throws {RequiredError}
49726
51486
  */
49727
51487
  getSalesReportOrderTypes: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51488
+ /**
51489
+ * The period GET /api/v6/report/sales would read, for the same venues, apps and time zone (the venue\'s own unless timezone is sent), with the same access, from the daily till rows (daily_till_summary, daily_till_payments): each staff member\'s POS orders counted by the POS app\'s own end-of-day rules, added up over the period\'s whole business days. One group per venue and currency; breakdown is not taken, since a staff member is one venue\'s. Only the POS writes these rows, so an asked app other than pos adds nothing.
51490
+ * @summary The POS app\'s report per staff member: orders, sales, refunds, discounts, items, tips and payments by method
51491
+ * @param {Array<number>} businessIds The venues asked about, by business id
51492
+ * @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
51493
+ * @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
51494
+ * @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
51495
+ * @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\&#39;s own (Business.timeZone)
51496
+ * @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
51497
+ * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
51498
+ * @param {*} [options] Override http request option.
51499
+ * @throws {RequiredError}
51500
+ */
51501
+ getSalesReportStaff: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, language?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49728
51502
  /**
49729
51503
  * The report GET /api/v6/report/sales answers for the same query, with the same access, short enough to read whole: the same totals, orderCount, averageOrderValue, days, VAT, payments, discounts, comparison, changes and changesFromBaseline, every amount rounded to the currency\'s minor digits; with part items, each category\'s totals (with and without VAT) without its items, and topItemsBySales and topItemsByQuantity, the 10 best-selling items with an item of the same name in several categories added up once. For every item with its VAT, its net and its options, read GET /api/v6/report/sales.
49730
51504
  * @summary Sales report of the venues and apps, short: totals, categories and best-selling items
@@ -49739,7 +51513,7 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
49739
51513
  * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
49740
51514
  * @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\&#39;s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
49741
51515
  * @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
49742
- * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, both last days, the report\&#39;s and the compared one, are added up only to the last full hour the data has reached, on each venue\&#39;s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\&#39;s and paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
51516
+ * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, the compared last day is added up only to the last full hour the data has reached on the report\&#39;s last day, on each venue\&#39;s own clock (today so far against that day until 14:00); its earlier days stay whole. The report\&#39;s own period is never cut: its totals are those of the same report without compareSameTime, up to dataUntil. Each group whose compared day was cut answers comparison.comparedUntil. Only the compared totals are cut (comparison.salesReport\&#39;s and comparison.paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the compared day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
49743
51517
  * @param {string} [baseline] One group of the answer every other group is compared with: venue:&lt;id&gt; with breakdown venue, app:&lt;app&gt; with breakdown app, venue:&lt;id&gt;,app:&lt;app&gt; 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\&#39;s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
49744
51518
  * @param {*} [options] Override http request option.
49745
51519
  * @throws {RequiredError}
@@ -49823,7 +51597,7 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
49823
51597
  * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
49824
51598
  * @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\&#39;s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
49825
51599
  * @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
49826
- * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, both last days, the report\&#39;s and the compared one, are added up only to the last full hour the data has reached, on each venue\&#39;s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\&#39;s and paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
51600
+ * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, the compared last day is added up only to the last full hour the data has reached on the report\&#39;s last day, on each venue\&#39;s own clock (today so far against that day until 14:00); its earlier days stay whole. The report\&#39;s own period is never cut: its totals are those of the same report without compareSameTime, up to dataUntil. Each group whose compared day was cut answers comparison.comparedUntil. Only the compared totals are cut (comparison.salesReport\&#39;s and comparison.paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the compared day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
49827
51601
  * @param {string} [baseline] One group of the answer every other group is compared with: venue:&lt;id&gt; with breakdown venue, app:&lt;app&gt; with breakdown app, venue:&lt;id&gt;,app:&lt;app&gt; 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\&#39;s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
49828
51602
  * @param {*} [options] Override http request option.
49829
51603
  * @throws {RequiredError}
@@ -49874,6 +51648,20 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
49874
51648
  * @throws {RequiredError}
49875
51649
  */
49876
51650
  getSalesReportOrderTypes(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SalesReportOrderTypesResponseDto>>;
51651
+ /**
51652
+ * The period GET /api/v6/report/sales would read, for the same venues, apps and time zone (the venue\'s own unless timezone is sent), with the same access, from the daily till rows (daily_till_summary, daily_till_payments): each staff member\'s POS orders counted by the POS app\'s own end-of-day rules, added up over the period\'s whole business days. One group per venue and currency; breakdown is not taken, since a staff member is one venue\'s. Only the POS writes these rows, so an asked app other than pos adds nothing.
51653
+ * @summary The POS app\'s report per staff member: orders, sales, refunds, discounts, items, tips and payments by method
51654
+ * @param {Array<number>} businessIds The venues asked about, by business id
51655
+ * @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
51656
+ * @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
51657
+ * @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
51658
+ * @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\&#39;s own (Business.timeZone)
51659
+ * @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
51660
+ * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
51661
+ * @param {*} [options] Override http request option.
51662
+ * @throws {RequiredError}
51663
+ */
51664
+ getSalesReportStaff(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, language?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SalesReportStaffResponseDto>>;
49877
51665
  /**
49878
51666
  * The report GET /api/v6/report/sales answers for the same query, with the same access, short enough to read whole: the same totals, orderCount, averageOrderValue, days, VAT, payments, discounts, comparison, changes and changesFromBaseline, every amount rounded to the currency\'s minor digits; with part items, each category\'s totals (with and without VAT) without its items, and topItemsBySales and topItemsByQuantity, the 10 best-selling items with an item of the same name in several categories added up once. For every item with its VAT, its net and its options, read GET /api/v6/report/sales.
49879
51667
  * @summary Sales report of the venues and apps, short: totals, categories and best-selling items
@@ -49888,7 +51676,7 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
49888
51676
  * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
49889
51677
  * @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\&#39;s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
49890
51678
  * @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
49891
- * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, both last days, the report\&#39;s and the compared one, are added up only to the last full hour the data has reached, on each venue\&#39;s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\&#39;s and paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
51679
+ * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, the compared last day is added up only to the last full hour the data has reached on the report\&#39;s last day, on each venue\&#39;s own clock (today so far against that day until 14:00); its earlier days stay whole. The report\&#39;s own period is never cut: its totals are those of the same report without compareSameTime, up to dataUntil. Each group whose compared day was cut answers comparison.comparedUntil. Only the compared totals are cut (comparison.salesReport\&#39;s and comparison.paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the compared day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
49892
51680
  * @param {string} [baseline] One group of the answer every other group is compared with: venue:&lt;id&gt; with breakdown venue, app:&lt;app&gt; with breakdown app, venue:&lt;id&gt;,app:&lt;app&gt; 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\&#39;s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
49893
51681
  * @param {*} [options] Override http request option.
49894
51682
  * @throws {RequiredError}
@@ -49972,7 +51760,7 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
49972
51760
  * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
49973
51761
  * @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\&#39;s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
49974
51762
  * @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
49975
- * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, both last days, the report\&#39;s and the compared one, are added up only to the last full hour the data has reached, on each venue\&#39;s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\&#39;s and paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
51763
+ * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, the compared last day is added up only to the last full hour the data has reached on the report\&#39;s last day, on each venue\&#39;s own clock (today so far against that day until 14:00); its earlier days stay whole. The report\&#39;s own period is never cut: its totals are those of the same report without compareSameTime, up to dataUntil. Each group whose compared day was cut answers comparison.comparedUntil. Only the compared totals are cut (comparison.salesReport\&#39;s and comparison.paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the compared day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
49976
51764
  * @param {string} [baseline] One group of the answer every other group is compared with: venue:&lt;id&gt; with breakdown venue, app:&lt;app&gt; with breakdown app, venue:&lt;id&gt;,app:&lt;app&gt; 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\&#39;s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
49977
51765
  * @param {*} [options] Override http request option.
49978
51766
  * @throws {RequiredError}
@@ -50023,6 +51811,20 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
50023
51811
  * @throws {RequiredError}
50024
51812
  */
50025
51813
  getSalesReportOrderTypes(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, options?: any): AxiosPromise<SalesReportOrderTypesResponseDto>;
51814
+ /**
51815
+ * The period GET /api/v6/report/sales would read, for the same venues, apps and time zone (the venue\'s own unless timezone is sent), with the same access, from the daily till rows (daily_till_summary, daily_till_payments): each staff member\'s POS orders counted by the POS app\'s own end-of-day rules, added up over the period\'s whole business days. One group per venue and currency; breakdown is not taken, since a staff member is one venue\'s. Only the POS writes these rows, so an asked app other than pos adds nothing.
51816
+ * @summary The POS app\'s report per staff member: orders, sales, refunds, discounts, items, tips and payments by method
51817
+ * @param {Array<number>} businessIds The venues asked about, by business id
51818
+ * @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
51819
+ * @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
51820
+ * @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
51821
+ * @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\&#39;s own (Business.timeZone)
51822
+ * @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
51823
+ * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
51824
+ * @param {*} [options] Override http request option.
51825
+ * @throws {RequiredError}
51826
+ */
51827
+ getSalesReportStaff(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, language?: string, options?: any): AxiosPromise<SalesReportStaffResponseDto>;
50026
51828
  /**
50027
51829
  * The report GET /api/v6/report/sales answers for the same query, with the same access, short enough to read whole: the same totals, orderCount, averageOrderValue, days, VAT, payments, discounts, comparison, changes and changesFromBaseline, every amount rounded to the currency\'s minor digits; with part items, each category\'s totals (with and without VAT) without its items, and topItemsBySales and topItemsByQuantity, the 10 best-selling items with an item of the same name in several categories added up once. For every item with its VAT, its net and its options, read GET /api/v6/report/sales.
50028
51830
  * @summary Sales report of the venues and apps, short: totals, categories and best-selling items
@@ -50037,7 +51839,7 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
50037
51839
  * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
50038
51840
  * @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\&#39;s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
50039
51841
  * @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
50040
- * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, both last days, the report\&#39;s and the compared one, are added up only to the last full hour the data has reached, on each venue\&#39;s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\&#39;s and paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
51842
+ * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, the compared last day is added up only to the last full hour the data has reached on the report\&#39;s last day, on each venue\&#39;s own clock (today so far against that day until 14:00); its earlier days stay whole. The report\&#39;s own period is never cut: its totals are those of the same report without compareSameTime, up to dataUntil. Each group whose compared day was cut answers comparison.comparedUntil. Only the compared totals are cut (comparison.salesReport\&#39;s and comparison.paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the compared day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
50041
51843
  * @param {string} [baseline] One group of the answer every other group is compared with: venue:&lt;id&gt; with breakdown venue, app:&lt;app&gt; with breakdown app, venue:&lt;id&gt;,app:&lt;app&gt; 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\&#39;s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
50042
51844
  * @param {*} [options] Override http request option.
50043
51845
  * @throws {RequiredError}
@@ -50125,7 +51927,7 @@ export interface ReportApiInterface {
50125
51927
  * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
50126
51928
  * @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\&#39;s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
50127
51929
  * @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
50128
- * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, both last days, the report\&#39;s and the compared one, are added up only to the last full hour the data has reached, on each venue\&#39;s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\&#39;s and paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
51930
+ * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, the compared last day is added up only to the last full hour the data has reached on the report\&#39;s last day, on each venue\&#39;s own clock (today so far against that day until 14:00); its earlier days stay whole. The report\&#39;s own period is never cut: its totals are those of the same report without compareSameTime, up to dataUntil. Each group whose compared day was cut answers comparison.comparedUntil. Only the compared totals are cut (comparison.salesReport\&#39;s and comparison.paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the compared day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
50129
51931
  * @param {string} [baseline] One group of the answer every other group is compared with: venue:&lt;id&gt; with breakdown venue, app:&lt;app&gt; with breakdown app, venue:&lt;id&gt;,app:&lt;app&gt; 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\&#39;s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
50130
51932
  * @param {*} [options] Override http request option.
50131
51933
  * @throws {RequiredError}
@@ -50180,6 +51982,21 @@ export interface ReportApiInterface {
50180
51982
  * @memberof ReportApiInterface
50181
51983
  */
50182
51984
  getSalesReportOrderTypes(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, options?: AxiosRequestConfig): AxiosPromise<SalesReportOrderTypesResponseDto>;
51985
+ /**
51986
+ * The period GET /api/v6/report/sales would read, for the same venues, apps and time zone (the venue\'s own unless timezone is sent), with the same access, from the daily till rows (daily_till_summary, daily_till_payments): each staff member\'s POS orders counted by the POS app\'s own end-of-day rules, added up over the period\'s whole business days. One group per venue and currency; breakdown is not taken, since a staff member is one venue\'s. Only the POS writes these rows, so an asked app other than pos adds nothing.
51987
+ * @summary The POS app\'s report per staff member: orders, sales, refunds, discounts, items, tips and payments by method
51988
+ * @param {Array<number>} businessIds The venues asked about, by business id
51989
+ * @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
51990
+ * @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
51991
+ * @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
51992
+ * @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\&#39;s own (Business.timeZone)
51993
+ * @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
51994
+ * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
51995
+ * @param {*} [options] Override http request option.
51996
+ * @throws {RequiredError}
51997
+ * @memberof ReportApiInterface
51998
+ */
51999
+ getSalesReportStaff(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, language?: string, options?: AxiosRequestConfig): AxiosPromise<SalesReportStaffResponseDto>;
50183
52000
  /**
50184
52001
  * The report GET /api/v6/report/sales answers for the same query, with the same access, short enough to read whole: the same totals, orderCount, averageOrderValue, days, VAT, payments, discounts, comparison, changes and changesFromBaseline, every amount rounded to the currency\'s minor digits; with part items, each category\'s totals (with and without VAT) without its items, and topItemsBySales and topItemsByQuantity, the 10 best-selling items with an item of the same name in several categories added up once. For every item with its VAT, its net and its options, read GET /api/v6/report/sales.
50185
52002
  * @summary Sales report of the venues and apps, short: totals, categories and best-selling items
@@ -50194,7 +52011,7 @@ export interface ReportApiInterface {
50194
52011
  * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
50195
52012
  * @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\&#39;s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
50196
52013
  * @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
50197
- * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, both last days, the report\&#39;s and the compared one, are added up only to the last full hour the data has reached, on each venue\&#39;s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\&#39;s and paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
52014
+ * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, the compared last day is added up only to the last full hour the data has reached on the report\&#39;s last day, on each venue\&#39;s own clock (today so far against that day until 14:00); its earlier days stay whole. The report\&#39;s own period is never cut: its totals are those of the same report without compareSameTime, up to dataUntil. Each group whose compared day was cut answers comparison.comparedUntil. Only the compared totals are cut (comparison.salesReport\&#39;s and comparison.paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the compared day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
50198
52015
  * @param {string} [baseline] One group of the answer every other group is compared with: venue:&lt;id&gt; with breakdown venue, app:&lt;app&gt; with breakdown app, venue:&lt;id&gt;,app:&lt;app&gt; 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\&#39;s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
50199
52016
  * @param {*} [options] Override http request option.
50200
52017
  * @throws {RequiredError}
@@ -50285,7 +52102,7 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
50285
52102
  * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
50286
52103
  * @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\&#39;s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
50287
52104
  * @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
50288
- * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, both last days, the report\&#39;s and the compared one, are added up only to the last full hour the data has reached, on each venue\&#39;s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\&#39;s and paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
52105
+ * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, the compared last day is added up only to the last full hour the data has reached on the report\&#39;s last day, on each venue\&#39;s own clock (today so far against that day until 14:00); its earlier days stay whole. The report\&#39;s own period is never cut: its totals are those of the same report without compareSameTime, up to dataUntil. Each group whose compared day was cut answers comparison.comparedUntil. Only the compared totals are cut (comparison.salesReport\&#39;s and comparison.paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the compared day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
50289
52106
  * @param {string} [baseline] One group of the answer every other group is compared with: venue:&lt;id&gt; with breakdown venue, app:&lt;app&gt; with breakdown app, venue:&lt;id&gt;,app:&lt;app&gt; 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\&#39;s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
50290
52107
  * @param {*} [options] Override http request option.
50291
52108
  * @throws {RequiredError}
@@ -50340,6 +52157,21 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
50340
52157
  * @memberof ReportApi
50341
52158
  */
50342
52159
  getSalesReportOrderTypes(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SalesReportOrderTypesResponseDto, any, {}>>;
52160
+ /**
52161
+ * The period GET /api/v6/report/sales would read, for the same venues, apps and time zone (the venue\'s own unless timezone is sent), with the same access, from the daily till rows (daily_till_summary, daily_till_payments): each staff member\'s POS orders counted by the POS app\'s own end-of-day rules, added up over the period\'s whole business days. One group per venue and currency; breakdown is not taken, since a staff member is one venue\'s. Only the POS writes these rows, so an asked app other than pos adds nothing.
52162
+ * @summary The POS app\'s report per staff member: orders, sales, refunds, discounts, items, tips and payments by method
52163
+ * @param {Array<number>} businessIds The venues asked about, by business id
52164
+ * @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
52165
+ * @param {string} [start] The first day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
52166
+ * @param {string} [end] The last day of a CUSTOM period, an ISO 8601 date; required with CUSTOM
52167
+ * @param {string} [timezone] The time zone the period is read in, IANA. Absent: the first venue\&#39;s own (Business.timeZone)
52168
+ * @param {Array<ReportApp>} [apps] The apps to add up, the parameter repeated or a JSON list. Absent: all four
52169
+ * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
52170
+ * @param {*} [options] Override http request option.
52171
+ * @throws {RequiredError}
52172
+ * @memberof ReportApi
52173
+ */
52174
+ getSalesReportStaff(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, language?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SalesReportStaffResponseDto, any, {}>>;
50343
52175
  /**
50344
52176
  * The report GET /api/v6/report/sales answers for the same query, with the same access, short enough to read whole: the same totals, orderCount, averageOrderValue, days, VAT, payments, discounts, comparison, changes and changesFromBaseline, every amount rounded to the currency\'s minor digits; with part items, each category\'s totals (with and without VAT) without its items, and topItemsBySales and topItemsByQuantity, the 10 best-selling items with an item of the same name in several categories added up once. For every item with its VAT, its net and its options, read GET /api/v6/report/sales.
50345
52177
  * @summary Sales report of the venues and apps, short: totals, categories and best-selling items
@@ -50354,7 +52186,7 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
50354
52186
  * @param {string} [language] Accepted and not read, so a request copied from the portal\&#39;s report works: the report has no text to translate
50355
52187
  * @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\&#39;s time zone; not later than today. Neither sent: no comparison, and the answer is as before. Sent without compareEnd: refused
50356
52188
  * @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
50357
- * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, both last days, the report\&#39;s and the compared one, are added up only to the last full hour the data has reached, on each venue\&#39;s own clock (today until 14:00 against that day until 14:00), so neither side counts minutes the other does not; earlier days stay whole. Each group whose compared day was cut answers comparison.comparedUntil. Only totals are cut (salesReport\&#39;s and paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
52189
+ * @param {boolean} [compareSameTime] With compareStart and compareEnd, true compares up to the same time: while the report\&#39;s last day is still running, the compared last day is added up only to the last full hour the data has reached on the report\&#39;s last day, on each venue\&#39;s own clock (today so far against that day until 14:00); its earlier days stay whole. The report\&#39;s own period is never cut: its totals are those of the same report without compareSameTime, up to dataUntil. Each group whose compared day was cut answers comparison.comparedUntil. Only the compared totals are cut (comparison.salesReport\&#39;s and comparison.paymentReport.summary\&#39;s totals, totalDiscounts, orderCount, averageOrderValue, the changes and the compared day\&#39;s dailyBreakdown); the lists (categories, items, VAT rates, payment methods, discounts) of the compared last day stay whole, since the hours hold totals only, not lines per item, payment method, VAT rate or discount. A day without hours yet is compared whole. Absent or false: the comparison is as before
50358
52190
  * @param {string} [baseline] One group of the answer every other group is compared with: venue:&lt;id&gt; with breakdown venue, app:&lt;app&gt; with breakdown app, venue:&lt;id&gt;,app:&lt;app&gt; 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\&#39;s answers changesFromBaselineLeftOut instead. Refused when the breakdown does not split on what it names, or it names a venue or app not asked
50359
52191
  * @param {*} [options] Override http request option.
50360
52192
  * @throws {RequiredError}
@@ -50377,6 +52209,653 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
50377
52209
  */
50378
52210
  sendReportEmailV5(businessIds: Array<number>, timezone: string, sendReportEmailDto: SendReportEmailDto, timeSpan?: TimeSpan, start?: string, end?: string, provider?: ProviderEnum, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
50379
52211
  }
52212
+ /**
52213
+ * ReportSchedulesApi - axios parameter creator
52214
+ * @export
52215
+ */
52216
+ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Configuration) => {
52217
+ /**
52218
+ * A signed address that downloads the run\'s PDF or Excel file for 15 minutes, to whoever opens the run\'s report.
52219
+ * @summary Download a file of a organisation\'s report run
52220
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52221
+ * @param {string} runId The run\&#39;s id
52222
+ * @param {FileFormat} format Which of the run\&#39;s files
52223
+ * @param {*} [options] Override http request option.
52224
+ * @throws {RequiredError}
52225
+ */
52226
+ getOrganisationReportRunFile: (groupId: string, runId: string, format: FileFormat, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52227
+ /**
52228
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52229
+ * @summary Read when an organisation\'s saved report is emailed
52230
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52231
+ * @param {string} reportId The saved report\&#39;s id
52232
+ * @param {*} [options] Override http request option.
52233
+ * @throws {RequiredError}
52234
+ */
52235
+ getOrganisationSavedReportSchedule: (groupId: string, reportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52236
+ /**
52237
+ * dashboard-one\'s /reports/runs/{runId} page: the run\'s days, status, recipients and formats, and the store or organisation it belongs to, read from the run itself, so the page opens there and downloads its files through that scope\'s file route. Answered to whoever opens the run\'s report (a ready-made report\'s runs: its managers); 404 to anyone else.
52238
+ * @summary Read the report run an email links to
52239
+ * @param {string} runId The run\&#39;s id
52240
+ * @param {*} [options] Override http request option.
52241
+ * @throws {RequiredError}
52242
+ */
52243
+ getReportRun: (runId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52244
+ /**
52245
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52246
+ * @summary Read when a store\'s ready-made report is emailed
52247
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52248
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52249
+ * @param {*} [options] Override http request option.
52250
+ * @throws {RequiredError}
52251
+ */
52252
+ getStoreReadyMadeReportSchedule: (businessId: number, readyMadeReport: ReadyMadeReport, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52253
+ /**
52254
+ * A signed address that downloads the run\'s PDF or Excel file for 15 minutes, to whoever opens the run\'s report.
52255
+ * @summary Download a file of a store\'s report run
52256
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52257
+ * @param {string} runId The run\&#39;s id
52258
+ * @param {FileFormat} format Which of the run\&#39;s files
52259
+ * @param {*} [options] Override http request option.
52260
+ * @throws {RequiredError}
52261
+ */
52262
+ getStoreReportRunFile: (businessId: number, runId: string, format: FileFormat, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52263
+ /**
52264
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52265
+ * @summary Read when a store\'s saved report is emailed
52266
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52267
+ * @param {string} reportId The saved report\&#39;s id
52268
+ * @param {*} [options] Override http request option.
52269
+ * @throws {RequiredError}
52270
+ */
52271
+ getStoreSavedReportSchedule: (businessId: number, reportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52272
+ /**
52273
+ * 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.
52274
+ * @summary List the past runs of an organisation\'s saved report
52275
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52276
+ * @param {string} reportId The saved report\&#39;s id
52277
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52278
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52279
+ * @param {*} [options] Override http request option.
52280
+ * @throws {RequiredError}
52281
+ */
52282
+ listOrganisationSavedReportRuns: (groupId: string, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52283
+ /**
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.
52285
+ * @summary List the past runs of a store\'s ready-made report
52286
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52287
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52288
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52289
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52290
+ * @param {*} [options] Override http request option.
52291
+ * @throws {RequiredError}
52292
+ */
52293
+ listStoreReadyMadeReportRuns: (businessId: number, readyMadeReport: ReadyMadeReport, limit?: number, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52294
+ /**
52295
+ * 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.
52296
+ * @summary List the past runs of a store\'s saved report
52297
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52298
+ * @param {string} reportId The saved report\&#39;s id
52299
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52300
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52301
+ * @param {*} [options] Override http request option.
52302
+ * @throws {RequiredError}
52303
+ */
52304
+ listStoreSavedReportRuns: (businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52305
+ /**
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.
52307
+ * @summary Set when an organisation\'s saved report is emailed
52308
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52309
+ * @param {string} reportId The saved report\&#39;s id
52310
+ * @param {SetReportScheduleDto} setReportScheduleDto
52311
+ * @param {*} [options] Override http request option.
52312
+ * @throws {RequiredError}
52313
+ */
52314
+ setOrganisationSavedReportSchedule: (groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52315
+ /**
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.
52317
+ * @summary Set when a store\'s ready-made report is emailed
52318
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52319
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52320
+ * @param {SetReportScheduleDto} setReportScheduleDto
52321
+ * @param {*} [options] Override http request option.
52322
+ * @throws {RequiredError}
52323
+ */
52324
+ setStoreReadyMadeReportSchedule: (businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52325
+ /**
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.
52327
+ * @summary Set when a store\'s saved report is emailed
52328
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52329
+ * @param {string} reportId The saved report\&#39;s id
52330
+ * @param {SetReportScheduleDto} setReportScheduleDto
52331
+ * @param {*} [options] Override http request option.
52332
+ * @throws {RequiredError}
52333
+ */
52334
+ setStoreSavedReportSchedule: (businessId: number, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52335
+ };
52336
+ /**
52337
+ * ReportSchedulesApi - functional programming interface
52338
+ * @export
52339
+ */
52340
+ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
52341
+ /**
52342
+ * A signed address that downloads the run\'s PDF or Excel file for 15 minutes, to whoever opens the run\'s report.
52343
+ * @summary Download a file of a organisation\'s report run
52344
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52345
+ * @param {string} runId The run\&#39;s id
52346
+ * @param {FileFormat} format Which of the run\&#39;s files
52347
+ * @param {*} [options] Override http request option.
52348
+ * @throws {RequiredError}
52349
+ */
52350
+ getOrganisationReportRunFile(groupId: string, runId: string, format: FileFormat, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportRunFileDto>>;
52351
+ /**
52352
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52353
+ * @summary Read when an organisation\'s saved report is emailed
52354
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52355
+ * @param {string} reportId The saved report\&#39;s id
52356
+ * @param {*} [options] Override http request option.
52357
+ * @throws {RequiredError}
52358
+ */
52359
+ getOrganisationSavedReportSchedule(groupId: string, reportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
52360
+ /**
52361
+ * dashboard-one\'s /reports/runs/{runId} page: the run\'s days, status, recipients and formats, and the store or organisation it belongs to, read from the run itself, so the page opens there and downloads its files through that scope\'s file route. Answered to whoever opens the run\'s report (a ready-made report\'s runs: its managers); 404 to anyone else.
52362
+ * @summary Read the report run an email links to
52363
+ * @param {string} runId The run\&#39;s id
52364
+ * @param {*} [options] Override http request option.
52365
+ * @throws {RequiredError}
52366
+ */
52367
+ getReportRun(runId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportRunOpenedDto>>;
52368
+ /**
52369
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52370
+ * @summary Read when a store\'s ready-made report is emailed
52371
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52372
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52373
+ * @param {*} [options] Override http request option.
52374
+ * @throws {RequiredError}
52375
+ */
52376
+ getStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
52377
+ /**
52378
+ * A signed address that downloads the run\'s PDF or Excel file for 15 minutes, to whoever opens the run\'s report.
52379
+ * @summary Download a file of a store\'s report run
52380
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52381
+ * @param {string} runId The run\&#39;s id
52382
+ * @param {FileFormat} format Which of the run\&#39;s files
52383
+ * @param {*} [options] Override http request option.
52384
+ * @throws {RequiredError}
52385
+ */
52386
+ getStoreReportRunFile(businessId: number, runId: string, format: FileFormat, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportRunFileDto>>;
52387
+ /**
52388
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52389
+ * @summary Read when a store\'s saved report is emailed
52390
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52391
+ * @param {string} reportId The saved report\&#39;s id
52392
+ * @param {*} [options] Override http request option.
52393
+ * @throws {RequiredError}
52394
+ */
52395
+ getStoreSavedReportSchedule(businessId: number, reportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
52396
+ /**
52397
+ * 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.
52398
+ * @summary List the past runs of an organisation\'s saved report
52399
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52400
+ * @param {string} reportId The saved report\&#39;s id
52401
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52402
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52403
+ * @param {*} [options] Override http request option.
52404
+ * @throws {RequiredError}
52405
+ */
52406
+ listOrganisationSavedReportRuns(groupId: string, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportRunListDto>>;
52407
+ /**
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.
52409
+ * @summary List the past runs of a store\'s ready-made report
52410
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52411
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52412
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52413
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52414
+ * @param {*} [options] Override http request option.
52415
+ * @throws {RequiredError}
52416
+ */
52417
+ listStoreReadyMadeReportRuns(businessId: number, readyMadeReport: ReadyMadeReport, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportRunListDto>>;
52418
+ /**
52419
+ * 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.
52420
+ * @summary List the past runs of a store\'s saved report
52421
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52422
+ * @param {string} reportId The saved report\&#39;s id
52423
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52424
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52425
+ * @param {*} [options] Override http request option.
52426
+ * @throws {RequiredError}
52427
+ */
52428
+ listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportRunListDto>>;
52429
+ /**
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.
52431
+ * @summary Set when an organisation\'s saved report is emailed
52432
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52433
+ * @param {string} reportId The saved report\&#39;s id
52434
+ * @param {SetReportScheduleDto} setReportScheduleDto
52435
+ * @param {*} [options] Override http request option.
52436
+ * @throws {RequiredError}
52437
+ */
52438
+ setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
52439
+ /**
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.
52441
+ * @summary Set when a store\'s ready-made report is emailed
52442
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52443
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52444
+ * @param {SetReportScheduleDto} setReportScheduleDto
52445
+ * @param {*} [options] Override http request option.
52446
+ * @throws {RequiredError}
52447
+ */
52448
+ setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
52449
+ /**
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.
52451
+ * @summary Set when a store\'s saved report is emailed
52452
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52453
+ * @param {string} reportId The saved report\&#39;s id
52454
+ * @param {SetReportScheduleDto} setReportScheduleDto
52455
+ * @param {*} [options] Override http request option.
52456
+ * @throws {RequiredError}
52457
+ */
52458
+ setStoreSavedReportSchedule(businessId: number, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
52459
+ };
52460
+ /**
52461
+ * ReportSchedulesApi - factory interface
52462
+ * @export
52463
+ */
52464
+ export declare const ReportSchedulesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
52465
+ /**
52466
+ * A signed address that downloads the run\'s PDF or Excel file for 15 minutes, to whoever opens the run\'s report.
52467
+ * @summary Download a file of a organisation\'s report run
52468
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52469
+ * @param {string} runId The run\&#39;s id
52470
+ * @param {FileFormat} format Which of the run\&#39;s files
52471
+ * @param {*} [options] Override http request option.
52472
+ * @throws {RequiredError}
52473
+ */
52474
+ getOrganisationReportRunFile(groupId: string, runId: string, format: FileFormat, options?: any): AxiosPromise<ReportRunFileDto>;
52475
+ /**
52476
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52477
+ * @summary Read when an organisation\'s saved report is emailed
52478
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52479
+ * @param {string} reportId The saved report\&#39;s id
52480
+ * @param {*} [options] Override http request option.
52481
+ * @throws {RequiredError}
52482
+ */
52483
+ getOrganisationSavedReportSchedule(groupId: string, reportId: string, options?: any): AxiosPromise<ReportScheduleDto>;
52484
+ /**
52485
+ * dashboard-one\'s /reports/runs/{runId} page: the run\'s days, status, recipients and formats, and the store or organisation it belongs to, read from the run itself, so the page opens there and downloads its files through that scope\'s file route. Answered to whoever opens the run\'s report (a ready-made report\'s runs: its managers); 404 to anyone else.
52486
+ * @summary Read the report run an email links to
52487
+ * @param {string} runId The run\&#39;s id
52488
+ * @param {*} [options] Override http request option.
52489
+ * @throws {RequiredError}
52490
+ */
52491
+ getReportRun(runId: string, options?: any): AxiosPromise<ReportRunOpenedDto>;
52492
+ /**
52493
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52494
+ * @summary Read when a store\'s ready-made report is emailed
52495
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52496
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52497
+ * @param {*} [options] Override http request option.
52498
+ * @throws {RequiredError}
52499
+ */
52500
+ getStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, options?: any): AxiosPromise<ReportScheduleDto>;
52501
+ /**
52502
+ * A signed address that downloads the run\'s PDF or Excel file for 15 minutes, to whoever opens the run\'s report.
52503
+ * @summary Download a file of a store\'s report run
52504
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52505
+ * @param {string} runId The run\&#39;s id
52506
+ * @param {FileFormat} format Which of the run\&#39;s files
52507
+ * @param {*} [options] Override http request option.
52508
+ * @throws {RequiredError}
52509
+ */
52510
+ getStoreReportRunFile(businessId: number, runId: string, format: FileFormat, options?: any): AxiosPromise<ReportRunFileDto>;
52511
+ /**
52512
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52513
+ * @summary Read when a store\'s saved report is emailed
52514
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52515
+ * @param {string} reportId The saved report\&#39;s id
52516
+ * @param {*} [options] Override http request option.
52517
+ * @throws {RequiredError}
52518
+ */
52519
+ getStoreSavedReportSchedule(businessId: number, reportId: string, options?: any): AxiosPromise<ReportScheduleDto>;
52520
+ /**
52521
+ * 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.
52522
+ * @summary List the past runs of an organisation\'s saved report
52523
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52524
+ * @param {string} reportId The saved report\&#39;s id
52525
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52526
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52527
+ * @param {*} [options] Override http request option.
52528
+ * @throws {RequiredError}
52529
+ */
52530
+ listOrganisationSavedReportRuns(groupId: string, reportId: string, limit?: number, after?: string, options?: any): AxiosPromise<ReportRunListDto>;
52531
+ /**
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.
52533
+ * @summary List the past runs of a store\'s ready-made report
52534
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52535
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52536
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52537
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52538
+ * @param {*} [options] Override http request option.
52539
+ * @throws {RequiredError}
52540
+ */
52541
+ listStoreReadyMadeReportRuns(businessId: number, readyMadeReport: ReadyMadeReport, limit?: number, after?: string, options?: any): AxiosPromise<ReportRunListDto>;
52542
+ /**
52543
+ * 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.
52544
+ * @summary List the past runs of a store\'s saved report
52545
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52546
+ * @param {string} reportId The saved report\&#39;s id
52547
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52548
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52549
+ * @param {*} [options] Override http request option.
52550
+ * @throws {RequiredError}
52551
+ */
52552
+ listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: any): AxiosPromise<ReportRunListDto>;
52553
+ /**
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.
52555
+ * @summary Set when an organisation\'s saved report is emailed
52556
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52557
+ * @param {string} reportId The saved report\&#39;s id
52558
+ * @param {SetReportScheduleDto} setReportScheduleDto
52559
+ * @param {*} [options] Override http request option.
52560
+ * @throws {RequiredError}
52561
+ */
52562
+ setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: any): AxiosPromise<ReportScheduleDto>;
52563
+ /**
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.
52565
+ * @summary Set when a store\'s ready-made report is emailed
52566
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52567
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52568
+ * @param {SetReportScheduleDto} setReportScheduleDto
52569
+ * @param {*} [options] Override http request option.
52570
+ * @throws {RequiredError}
52571
+ */
52572
+ setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: any): AxiosPromise<ReportScheduleDto>;
52573
+ /**
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.
52575
+ * @summary Set when a store\'s saved report is emailed
52576
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52577
+ * @param {string} reportId The saved report\&#39;s id
52578
+ * @param {SetReportScheduleDto} setReportScheduleDto
52579
+ * @param {*} [options] Override http request option.
52580
+ * @throws {RequiredError}
52581
+ */
52582
+ setStoreSavedReportSchedule(businessId: number, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: any): AxiosPromise<ReportScheduleDto>;
52583
+ };
52584
+ /**
52585
+ * ReportSchedulesApi - interface
52586
+ * @export
52587
+ * @interface ReportSchedulesApi
52588
+ */
52589
+ export interface ReportSchedulesApiInterface {
52590
+ /**
52591
+ * A signed address that downloads the run\'s PDF or Excel file for 15 minutes, to whoever opens the run\'s report.
52592
+ * @summary Download a file of a organisation\'s report run
52593
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52594
+ * @param {string} runId The run\&#39;s id
52595
+ * @param {FileFormat} format Which of the run\&#39;s files
52596
+ * @param {*} [options] Override http request option.
52597
+ * @throws {RequiredError}
52598
+ * @memberof ReportSchedulesApiInterface
52599
+ */
52600
+ getOrganisationReportRunFile(groupId: string, runId: string, format: FileFormat, options?: AxiosRequestConfig): AxiosPromise<ReportRunFileDto>;
52601
+ /**
52602
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52603
+ * @summary Read when an organisation\'s saved report is emailed
52604
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52605
+ * @param {string} reportId The saved report\&#39;s id
52606
+ * @param {*} [options] Override http request option.
52607
+ * @throws {RequiredError}
52608
+ * @memberof ReportSchedulesApiInterface
52609
+ */
52610
+ getOrganisationSavedReportSchedule(groupId: string, reportId: string, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
52611
+ /**
52612
+ * dashboard-one\'s /reports/runs/{runId} page: the run\'s days, status, recipients and formats, and the store or organisation it belongs to, read from the run itself, so the page opens there and downloads its files through that scope\'s file route. Answered to whoever opens the run\'s report (a ready-made report\'s runs: its managers); 404 to anyone else.
52613
+ * @summary Read the report run an email links to
52614
+ * @param {string} runId The run\&#39;s id
52615
+ * @param {*} [options] Override http request option.
52616
+ * @throws {RequiredError}
52617
+ * @memberof ReportSchedulesApiInterface
52618
+ */
52619
+ getReportRun(runId: string, options?: AxiosRequestConfig): AxiosPromise<ReportRunOpenedDto>;
52620
+ /**
52621
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52622
+ * @summary Read when a store\'s ready-made report is emailed
52623
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52624
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52625
+ * @param {*} [options] Override http request option.
52626
+ * @throws {RequiredError}
52627
+ * @memberof ReportSchedulesApiInterface
52628
+ */
52629
+ getStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
52630
+ /**
52631
+ * A signed address that downloads the run\'s PDF or Excel file for 15 minutes, to whoever opens the run\'s report.
52632
+ * @summary Download a file of a store\'s report run
52633
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52634
+ * @param {string} runId The run\&#39;s id
52635
+ * @param {FileFormat} format Which of the run\&#39;s files
52636
+ * @param {*} [options] Override http request option.
52637
+ * @throws {RequiredError}
52638
+ * @memberof ReportSchedulesApiInterface
52639
+ */
52640
+ getStoreReportRunFile(businessId: number, runId: string, format: FileFormat, options?: AxiosRequestConfig): AxiosPromise<ReportRunFileDto>;
52641
+ /**
52642
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52643
+ * @summary Read when a store\'s saved report is emailed
52644
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52645
+ * @param {string} reportId The saved report\&#39;s id
52646
+ * @param {*} [options] Override http request option.
52647
+ * @throws {RequiredError}
52648
+ * @memberof ReportSchedulesApiInterface
52649
+ */
52650
+ getStoreSavedReportSchedule(businessId: number, reportId: string, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
52651
+ /**
52652
+ * 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.
52653
+ * @summary List the past runs of an organisation\'s saved report
52654
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52655
+ * @param {string} reportId The saved report\&#39;s id
52656
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52657
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52658
+ * @param {*} [options] Override http request option.
52659
+ * @throws {RequiredError}
52660
+ * @memberof ReportSchedulesApiInterface
52661
+ */
52662
+ listOrganisationSavedReportRuns(groupId: string, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<ReportRunListDto>;
52663
+ /**
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.
52665
+ * @summary List the past runs of a store\'s ready-made report
52666
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52667
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52668
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52669
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52670
+ * @param {*} [options] Override http request option.
52671
+ * @throws {RequiredError}
52672
+ * @memberof ReportSchedulesApiInterface
52673
+ */
52674
+ listStoreReadyMadeReportRuns(businessId: number, readyMadeReport: ReadyMadeReport, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<ReportRunListDto>;
52675
+ /**
52676
+ * 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.
52677
+ * @summary List the past runs of a store\'s saved report
52678
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52679
+ * @param {string} reportId The saved report\&#39;s id
52680
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52681
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52682
+ * @param {*} [options] Override http request option.
52683
+ * @throws {RequiredError}
52684
+ * @memberof ReportSchedulesApiInterface
52685
+ */
52686
+ listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<ReportRunListDto>;
52687
+ /**
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.
52689
+ * @summary Set when an organisation\'s saved report is emailed
52690
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52691
+ * @param {string} reportId The saved report\&#39;s id
52692
+ * @param {SetReportScheduleDto} setReportScheduleDto
52693
+ * @param {*} [options] Override http request option.
52694
+ * @throws {RequiredError}
52695
+ * @memberof ReportSchedulesApiInterface
52696
+ */
52697
+ setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
52698
+ /**
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.
52700
+ * @summary Set when a store\'s ready-made report is emailed
52701
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52702
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52703
+ * @param {SetReportScheduleDto} setReportScheduleDto
52704
+ * @param {*} [options] Override http request option.
52705
+ * @throws {RequiredError}
52706
+ * @memberof ReportSchedulesApiInterface
52707
+ */
52708
+ setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
52709
+ /**
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.
52711
+ * @summary Set when a store\'s saved report is emailed
52712
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52713
+ * @param {string} reportId The saved report\&#39;s id
52714
+ * @param {SetReportScheduleDto} setReportScheduleDto
52715
+ * @param {*} [options] Override http request option.
52716
+ * @throws {RequiredError}
52717
+ * @memberof ReportSchedulesApiInterface
52718
+ */
52719
+ setStoreSavedReportSchedule(businessId: number, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
52720
+ }
52721
+ /**
52722
+ * ReportSchedulesApi - object-oriented interface
52723
+ * @export
52724
+ * @class ReportSchedulesApi
52725
+ * @extends {BaseAPI}
52726
+ */
52727
+ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInterface {
52728
+ /**
52729
+ * A signed address that downloads the run\'s PDF or Excel file for 15 minutes, to whoever opens the run\'s report.
52730
+ * @summary Download a file of a organisation\'s report run
52731
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52732
+ * @param {string} runId The run\&#39;s id
52733
+ * @param {FileFormat} format Which of the run\&#39;s files
52734
+ * @param {*} [options] Override http request option.
52735
+ * @throws {RequiredError}
52736
+ * @memberof ReportSchedulesApi
52737
+ */
52738
+ getOrganisationReportRunFile(groupId: string, runId: string, format: FileFormat, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportRunFileDto, any, {}>>;
52739
+ /**
52740
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52741
+ * @summary Read when an organisation\'s saved report is emailed
52742
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52743
+ * @param {string} reportId The saved report\&#39;s id
52744
+ * @param {*} [options] Override http request option.
52745
+ * @throws {RequiredError}
52746
+ * @memberof ReportSchedulesApi
52747
+ */
52748
+ getOrganisationSavedReportSchedule(groupId: string, reportId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
52749
+ /**
52750
+ * dashboard-one\'s /reports/runs/{runId} page: the run\'s days, status, recipients and formats, and the store or organisation it belongs to, read from the run itself, so the page opens there and downloads its files through that scope\'s file route. Answered to whoever opens the run\'s report (a ready-made report\'s runs: its managers); 404 to anyone else.
52751
+ * @summary Read the report run an email links to
52752
+ * @param {string} runId The run\&#39;s id
52753
+ * @param {*} [options] Override http request option.
52754
+ * @throws {RequiredError}
52755
+ * @memberof ReportSchedulesApi
52756
+ */
52757
+ getReportRun(runId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportRunOpenedDto, any, {}>>;
52758
+ /**
52759
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52760
+ * @summary Read when a store\'s ready-made report is emailed
52761
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52762
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52763
+ * @param {*} [options] Override http request option.
52764
+ * @throws {RequiredError}
52765
+ * @memberof ReportSchedulesApi
52766
+ */
52767
+ getStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
52768
+ /**
52769
+ * A signed address that downloads the run\'s PDF or Excel file for 15 minutes, to whoever opens the run\'s report.
52770
+ * @summary Download a file of a store\'s report run
52771
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52772
+ * @param {string} runId The run\&#39;s id
52773
+ * @param {FileFormat} format Which of the run\&#39;s files
52774
+ * @param {*} [options] Override http request option.
52775
+ * @throws {RequiredError}
52776
+ * @memberof ReportSchedulesApi
52777
+ */
52778
+ getStoreReportRunFile(businessId: number, runId: string, format: FileFormat, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportRunFileDto, any, {}>>;
52779
+ /**
52780
+ * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
52781
+ * @summary Read when a store\'s saved report is emailed
52782
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52783
+ * @param {string} reportId The saved report\&#39;s id
52784
+ * @param {*} [options] Override http request option.
52785
+ * @throws {RequiredError}
52786
+ * @memberof ReportSchedulesApi
52787
+ */
52788
+ getStoreSavedReportSchedule(businessId: number, reportId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
52789
+ /**
52790
+ * 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.
52791
+ * @summary List the past runs of an organisation\'s saved report
52792
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52793
+ * @param {string} reportId The saved report\&#39;s id
52794
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52795
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52796
+ * @param {*} [options] Override http request option.
52797
+ * @throws {RequiredError}
52798
+ * @memberof ReportSchedulesApi
52799
+ */
52800
+ listOrganisationSavedReportRuns(groupId: string, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportRunListDto, any, {}>>;
52801
+ /**
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.
52803
+ * @summary List the past runs of a store\'s ready-made report
52804
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52805
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52806
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52807
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52808
+ * @param {*} [options] Override http request option.
52809
+ * @throws {RequiredError}
52810
+ * @memberof ReportSchedulesApi
52811
+ */
52812
+ listStoreReadyMadeReportRuns(businessId: number, readyMadeReport: ReadyMadeReport, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportRunListDto, any, {}>>;
52813
+ /**
52814
+ * 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.
52815
+ * @summary List the past runs of a store\'s saved report
52816
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52817
+ * @param {string} reportId The saved report\&#39;s id
52818
+ * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
52819
+ * @param {string} [after] The id of the last run of the page before; the list goes on after it
52820
+ * @param {*} [options] Override http request option.
52821
+ * @throws {RequiredError}
52822
+ * @memberof ReportSchedulesApi
52823
+ */
52824
+ listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportRunListDto, any, {}>>;
52825
+ /**
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.
52827
+ * @summary Set when an organisation\'s saved report is emailed
52828
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
52829
+ * @param {string} reportId The saved report\&#39;s id
52830
+ * @param {SetReportScheduleDto} setReportScheduleDto
52831
+ * @param {*} [options] Override http request option.
52832
+ * @throws {RequiredError}
52833
+ * @memberof ReportSchedulesApi
52834
+ */
52835
+ setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
52836
+ /**
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.
52838
+ * @summary Set when a store\'s ready-made report is emailed
52839
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52840
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
52841
+ * @param {SetReportScheduleDto} setReportScheduleDto
52842
+ * @param {*} [options] Override http request option.
52843
+ * @throws {RequiredError}
52844
+ * @memberof ReportSchedulesApi
52845
+ */
52846
+ setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
52847
+ /**
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.
52849
+ * @summary Set when a store\'s saved report is emailed
52850
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52851
+ * @param {string} reportId The saved report\&#39;s id
52852
+ * @param {SetReportScheduleDto} setReportScheduleDto
52853
+ * @param {*} [options] Override http request option.
52854
+ * @throws {RequiredError}
52855
+ * @memberof ReportSchedulesApi
52856
+ */
52857
+ setStoreSavedReportSchedule(businessId: number, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
52858
+ }
50380
52859
  /**
50381
52860
  * ReportV6Api - axios parameter creator
50382
52861
  * @export
@@ -51372,6 +53851,779 @@ export declare class ReservationsApi extends BaseAPI implements ReservationsApiI
51372
53851
  */
51373
53852
  updateReservationStatus(id: string, businessId: number, updateReservationStatusDto: UpdateReservationStatusDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReservationResponseDto, any, {}>>;
51374
53853
  }
53854
+ /**
53855
+ * SavedReportsApi - axios parameter creator
53856
+ * @export
53857
+ */
53858
+ export declare const SavedReportsApiAxiosParamCreator: (configuration?: Configuration) => {
53859
+ /**
53860
+ * Saves a new report (side A) or comparison (sides A and B), owned by the person; private unless visibility says otherwise. Managers only.
53861
+ * @summary Save a report or a comparison of a organisation
53862
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
53863
+ * @param {CreateSavedReportDto} createSavedReportDto
53864
+ * @param {*} [options] Override http request option.
53865
+ * @throws {RequiredError}
53866
+ */
53867
+ createOrganisationSavedReport: (groupId: string, createSavedReportDto: CreateSavedReportDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53868
+ /**
53869
+ * Saves a new report (side A) or comparison (sides A and B), owned by the person; private unless visibility says otherwise. Managers only.
53870
+ * @summary Save a report or a comparison of a store
53871
+ * @param {number} businessId The store\&#39;s orderingBusinessId
53872
+ * @param {CreateSavedReportDto} createSavedReportDto
53873
+ * @param {*} [options] Override http request option.
53874
+ * @throws {RequiredError}
53875
+ */
53876
+ createStoreSavedReport: (businessId: number, createSavedReportDto: CreateSavedReportDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53877
+ /**
53878
+ * Deletes it with its schedule and past runs. Managers only, on a report they see.
53879
+ * @summary Delete a saved report of a organisation
53880
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
53881
+ * @param {string} reportId The saved report\&#39;s id
53882
+ * @param {*} [options] Override http request option.
53883
+ * @throws {RequiredError}
53884
+ */
53885
+ deleteOrganisationSavedReport: (groupId: string, reportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53886
+ /**
53887
+ * Deletes it with its schedule and past runs. Managers only, on a report they see.
53888
+ * @summary Delete a saved report of a store
53889
+ * @param {number} businessId The store\&#39;s orderingBusinessId
53890
+ * @param {string} reportId The saved report\&#39;s id
53891
+ * @param {*} [options] Override http request option.
53892
+ * @throws {RequiredError}
53893
+ */
53894
+ deleteStoreSavedReport: (businessId: number, reportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53895
+ /**
53896
+ * A private copy owned by the person, in the same organisation, under the name sent. Managers only.
53897
+ * @summary Copy a saved report of a organisation
53898
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
53899
+ * @param {string} reportId The saved report\&#39;s id
53900
+ * @param {DuplicateSavedReportDto} duplicateSavedReportDto
53901
+ * @param {*} [options] Override http request option.
53902
+ * @throws {RequiredError}
53903
+ */
53904
+ duplicateOrganisationSavedReport: (groupId: string, reportId: string, duplicateSavedReportDto: DuplicateSavedReportDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53905
+ /**
53906
+ * A private copy owned by the person, in the same store, under the name sent. Managers only.
53907
+ * @summary Copy a saved report of a store
53908
+ * @param {number} businessId The store\&#39;s orderingBusinessId
53909
+ * @param {string} reportId The saved report\&#39;s id
53910
+ * @param {DuplicateSavedReportDto} duplicateSavedReportDto
53911
+ * @param {*} [options] Override http request option.
53912
+ * @throws {RequiredError}
53913
+ */
53914
+ duplicateStoreSavedReport: (businessId: number, reportId: string, duplicateSavedReportDto: DuplicateSavedReportDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53915
+ /**
53916
+ * A report the person sees: their own, or one shared with the organisation.
53917
+ * @summary Read one saved report of a organisation
53918
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
53919
+ * @param {string} reportId The saved report\&#39;s id
53920
+ * @param {*} [options] Override http request option.
53921
+ * @throws {RequiredError}
53922
+ */
53923
+ getOrganisationSavedReport: (groupId: string, reportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53924
+ /**
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).
53926
+ * @summary Read a public report by its link
53927
+ * @param {string} token The public link\&#39;s token, 43 characters
53928
+ * @param {*} [options] Override http request option.
53929
+ * @throws {RequiredError}
53930
+ */
53931
+ getPublicSavedReport: (token: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53932
+ /**
53933
+ * A report the person sees: their own, or one shared with the store.
53934
+ * @summary Read one saved report of a store
53935
+ * @param {number} businessId The store\&#39;s orderingBusinessId
53936
+ * @param {string} reportId The saved report\&#39;s id
53937
+ * @param {*} [options] Override http request option.
53938
+ * @throws {RequiredError}
53939
+ */
53940
+ getStoreSavedReport: (businessId: number, reportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53941
+ /**
53942
+ * The person\'s own private reports and every report shared with the organisation, last saved first, a page at a time.
53943
+ * @summary List the saved reports the person sees of a organisation
53944
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
53945
+ * @param {number} [limit] At most this many reports, 1 to 100. Absent: 50
53946
+ * @param {string} [after] The id of the last report of the page before; the list goes on after it
53947
+ * @param {*} [options] Override http request option.
53948
+ * @throws {RequiredError}
53949
+ */
53950
+ listOrganisationSavedReports: (groupId: string, limit?: number, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53951
+ /**
53952
+ * The person\'s own private reports and every report shared with the store, last saved first, a page at a time.
53953
+ * @summary List the saved reports the person sees of a store
53954
+ * @param {number} businessId The store\&#39;s orderingBusinessId
53955
+ * @param {number} [limit] At most this many reports, 1 to 100. Absent: 50
53956
+ * @param {string} [after] The id of the last report of the page before; the list goes on after it
53957
+ * @param {*} [options] Override http request option.
53958
+ * @throws {RequiredError}
53959
+ */
53960
+ listStoreSavedReports: (businessId: number, limit?: number, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53961
+ /**
53962
+ * private, organisation, or public: a new link every time it is made public, and leaving public ends the link. Saved at the version read. Managers only.
53963
+ * @summary Set who sees a saved report of a organisation
53964
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
53965
+ * @param {string} reportId The saved report\&#39;s id
53966
+ * @param {SetSavedReportVisibilityDto} setSavedReportVisibilityDto
53967
+ * @param {*} [options] Override http request option.
53968
+ * @throws {RequiredError}
53969
+ */
53970
+ setOrganisationSavedReportVisibility: (groupId: string, reportId: string, setSavedReportVisibilityDto: SetSavedReportVisibilityDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53971
+ /**
53972
+ * private, organisation, or public: a new link every time it is made public, and leaving public ends the link. Saved at the version read. Managers only.
53973
+ * @summary Set who sees a saved report of a store
53974
+ * @param {number} businessId The store\&#39;s orderingBusinessId
53975
+ * @param {string} reportId The saved report\&#39;s id
53976
+ * @param {SetSavedReportVisibilityDto} setSavedReportVisibilityDto
53977
+ * @param {*} [options] Override http request option.
53978
+ * @throws {RequiredError}
53979
+ */
53980
+ setStoreSavedReportVisibility: (businessId: number, reportId: string, setSavedReportVisibilityDto: SetSavedReportVisibilityDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53981
+ /**
53982
+ * Saves at the version read; 409 when someone saved since. Managers only, on a report they see.
53983
+ * @summary Replace a saved report\'s name, cards and filters of a organisation
53984
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
53985
+ * @param {string} reportId The saved report\&#39;s id
53986
+ * @param {UpdateSavedReportDto} updateSavedReportDto
53987
+ * @param {*} [options] Override http request option.
53988
+ * @throws {RequiredError}
53989
+ */
53990
+ updateOrganisationSavedReport: (groupId: string, reportId: string, updateSavedReportDto: UpdateSavedReportDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
53991
+ /**
53992
+ * Saves at the version read; 409 when someone saved since. Managers only, on a report they see.
53993
+ * @summary Replace a saved report\'s name, cards and filters of a store
53994
+ * @param {number} businessId The store\&#39;s orderingBusinessId
53995
+ * @param {string} reportId The saved report\&#39;s id
53996
+ * @param {UpdateSavedReportDto} updateSavedReportDto
53997
+ * @param {*} [options] Override http request option.
53998
+ * @throws {RequiredError}
53999
+ */
54000
+ updateStoreSavedReport: (businessId: number, reportId: string, updateSavedReportDto: UpdateSavedReportDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54001
+ };
54002
+ /**
54003
+ * SavedReportsApi - functional programming interface
54004
+ * @export
54005
+ */
54006
+ export declare const SavedReportsApiFp: (configuration?: Configuration) => {
54007
+ /**
54008
+ * Saves a new report (side A) or comparison (sides A and B), owned by the person; private unless visibility says otherwise. Managers only.
54009
+ * @summary Save a report or a comparison of a organisation
54010
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54011
+ * @param {CreateSavedReportDto} createSavedReportDto
54012
+ * @param {*} [options] Override http request option.
54013
+ * @throws {RequiredError}
54014
+ */
54015
+ createOrganisationSavedReport(groupId: string, createSavedReportDto: CreateSavedReportDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
54016
+ /**
54017
+ * Saves a new report (side A) or comparison (sides A and B), owned by the person; private unless visibility says otherwise. Managers only.
54018
+ * @summary Save a report or a comparison of a store
54019
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54020
+ * @param {CreateSavedReportDto} createSavedReportDto
54021
+ * @param {*} [options] Override http request option.
54022
+ * @throws {RequiredError}
54023
+ */
54024
+ createStoreSavedReport(businessId: number, createSavedReportDto: CreateSavedReportDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
54025
+ /**
54026
+ * Deletes it with its schedule and past runs. Managers only, on a report they see.
54027
+ * @summary Delete a saved report of a organisation
54028
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54029
+ * @param {string} reportId The saved report\&#39;s id
54030
+ * @param {*} [options] Override http request option.
54031
+ * @throws {RequiredError}
54032
+ */
54033
+ deleteOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
54034
+ /**
54035
+ * Deletes it with its schedule and past runs. Managers only, on a report they see.
54036
+ * @summary Delete a saved report of a store
54037
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54038
+ * @param {string} reportId The saved report\&#39;s id
54039
+ * @param {*} [options] Override http request option.
54040
+ * @throws {RequiredError}
54041
+ */
54042
+ deleteStoreSavedReport(businessId: number, reportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
54043
+ /**
54044
+ * A private copy owned by the person, in the same organisation, under the name sent. Managers only.
54045
+ * @summary Copy a saved report of a organisation
54046
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54047
+ * @param {string} reportId The saved report\&#39;s id
54048
+ * @param {DuplicateSavedReportDto} duplicateSavedReportDto
54049
+ * @param {*} [options] Override http request option.
54050
+ * @throws {RequiredError}
54051
+ */
54052
+ duplicateOrganisationSavedReport(groupId: string, reportId: string, duplicateSavedReportDto: DuplicateSavedReportDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
54053
+ /**
54054
+ * A private copy owned by the person, in the same store, under the name sent. Managers only.
54055
+ * @summary Copy a saved report of a store
54056
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54057
+ * @param {string} reportId The saved report\&#39;s id
54058
+ * @param {DuplicateSavedReportDto} duplicateSavedReportDto
54059
+ * @param {*} [options] Override http request option.
54060
+ * @throws {RequiredError}
54061
+ */
54062
+ duplicateStoreSavedReport(businessId: number, reportId: string, duplicateSavedReportDto: DuplicateSavedReportDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
54063
+ /**
54064
+ * A report the person sees: their own, or one shared with the organisation.
54065
+ * @summary Read one saved report of a organisation
54066
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54067
+ * @param {string} reportId The saved report\&#39;s id
54068
+ * @param {*} [options] Override http request option.
54069
+ * @throws {RequiredError}
54070
+ */
54071
+ getOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
54072
+ /**
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).
54074
+ * @summary Read a public report by its link
54075
+ * @param {string} token The public link\&#39;s token, 43 characters
54076
+ * @param {*} [options] Override http request option.
54077
+ * @throws {RequiredError}
54078
+ */
54079
+ getPublicSavedReport(token: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicSavedReportDto>>;
54080
+ /**
54081
+ * A report the person sees: their own, or one shared with the store.
54082
+ * @summary Read one saved report of a store
54083
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54084
+ * @param {string} reportId The saved report\&#39;s id
54085
+ * @param {*} [options] Override http request option.
54086
+ * @throws {RequiredError}
54087
+ */
54088
+ getStoreSavedReport(businessId: number, reportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
54089
+ /**
54090
+ * The person\'s own private reports and every report shared with the organisation, last saved first, a page at a time.
54091
+ * @summary List the saved reports the person sees of a organisation
54092
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54093
+ * @param {number} [limit] At most this many reports, 1 to 100. Absent: 50
54094
+ * @param {string} [after] The id of the last report of the page before; the list goes on after it
54095
+ * @param {*} [options] Override http request option.
54096
+ * @throws {RequiredError}
54097
+ */
54098
+ listOrganisationSavedReports(groupId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportListDto>>;
54099
+ /**
54100
+ * The person\'s own private reports and every report shared with the store, last saved first, a page at a time.
54101
+ * @summary List the saved reports the person sees of a store
54102
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54103
+ * @param {number} [limit] At most this many reports, 1 to 100. Absent: 50
54104
+ * @param {string} [after] The id of the last report of the page before; the list goes on after it
54105
+ * @param {*} [options] Override http request option.
54106
+ * @throws {RequiredError}
54107
+ */
54108
+ listStoreSavedReports(businessId: number, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportListDto>>;
54109
+ /**
54110
+ * private, organisation, or public: a new link every time it is made public, and leaving public ends the link. Saved at the version read. Managers only.
54111
+ * @summary Set who sees a saved report of a organisation
54112
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54113
+ * @param {string} reportId The saved report\&#39;s id
54114
+ * @param {SetSavedReportVisibilityDto} setSavedReportVisibilityDto
54115
+ * @param {*} [options] Override http request option.
54116
+ * @throws {RequiredError}
54117
+ */
54118
+ setOrganisationSavedReportVisibility(groupId: string, reportId: string, setSavedReportVisibilityDto: SetSavedReportVisibilityDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
54119
+ /**
54120
+ * private, organisation, or public: a new link every time it is made public, and leaving public ends the link. Saved at the version read. Managers only.
54121
+ * @summary Set who sees a saved report of a store
54122
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54123
+ * @param {string} reportId The saved report\&#39;s id
54124
+ * @param {SetSavedReportVisibilityDto} setSavedReportVisibilityDto
54125
+ * @param {*} [options] Override http request option.
54126
+ * @throws {RequiredError}
54127
+ */
54128
+ setStoreSavedReportVisibility(businessId: number, reportId: string, setSavedReportVisibilityDto: SetSavedReportVisibilityDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
54129
+ /**
54130
+ * Saves at the version read; 409 when someone saved since. Managers only, on a report they see.
54131
+ * @summary Replace a saved report\'s name, cards and filters of a organisation
54132
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54133
+ * @param {string} reportId The saved report\&#39;s id
54134
+ * @param {UpdateSavedReportDto} updateSavedReportDto
54135
+ * @param {*} [options] Override http request option.
54136
+ * @throws {RequiredError}
54137
+ */
54138
+ updateOrganisationSavedReport(groupId: string, reportId: string, updateSavedReportDto: UpdateSavedReportDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
54139
+ /**
54140
+ * Saves at the version read; 409 when someone saved since. Managers only, on a report they see.
54141
+ * @summary Replace a saved report\'s name, cards and filters of a store
54142
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54143
+ * @param {string} reportId The saved report\&#39;s id
54144
+ * @param {UpdateSavedReportDto} updateSavedReportDto
54145
+ * @param {*} [options] Override http request option.
54146
+ * @throws {RequiredError}
54147
+ */
54148
+ updateStoreSavedReport(businessId: number, reportId: string, updateSavedReportDto: UpdateSavedReportDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedReportDto>>;
54149
+ };
54150
+ /**
54151
+ * SavedReportsApi - factory interface
54152
+ * @export
54153
+ */
54154
+ export declare const SavedReportsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
54155
+ /**
54156
+ * Saves a new report (side A) or comparison (sides A and B), owned by the person; private unless visibility says otherwise. Managers only.
54157
+ * @summary Save a report or a comparison of a organisation
54158
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54159
+ * @param {CreateSavedReportDto} createSavedReportDto
54160
+ * @param {*} [options] Override http request option.
54161
+ * @throws {RequiredError}
54162
+ */
54163
+ createOrganisationSavedReport(groupId: string, createSavedReportDto: CreateSavedReportDto, options?: any): AxiosPromise<SavedReportDto>;
54164
+ /**
54165
+ * Saves a new report (side A) or comparison (sides A and B), owned by the person; private unless visibility says otherwise. Managers only.
54166
+ * @summary Save a report or a comparison of a store
54167
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54168
+ * @param {CreateSavedReportDto} createSavedReportDto
54169
+ * @param {*} [options] Override http request option.
54170
+ * @throws {RequiredError}
54171
+ */
54172
+ createStoreSavedReport(businessId: number, createSavedReportDto: CreateSavedReportDto, options?: any): AxiosPromise<SavedReportDto>;
54173
+ /**
54174
+ * Deletes it with its schedule and past runs. Managers only, on a report they see.
54175
+ * @summary Delete a saved report of a organisation
54176
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54177
+ * @param {string} reportId The saved report\&#39;s id
54178
+ * @param {*} [options] Override http request option.
54179
+ * @throws {RequiredError}
54180
+ */
54181
+ deleteOrganisationSavedReport(groupId: string, reportId: string, options?: any): AxiosPromise<void>;
54182
+ /**
54183
+ * Deletes it with its schedule and past runs. Managers only, on a report they see.
54184
+ * @summary Delete a saved report of a store
54185
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54186
+ * @param {string} reportId The saved report\&#39;s id
54187
+ * @param {*} [options] Override http request option.
54188
+ * @throws {RequiredError}
54189
+ */
54190
+ deleteStoreSavedReport(businessId: number, reportId: string, options?: any): AxiosPromise<void>;
54191
+ /**
54192
+ * A private copy owned by the person, in the same organisation, under the name sent. Managers only.
54193
+ * @summary Copy a saved report of a organisation
54194
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54195
+ * @param {string} reportId The saved report\&#39;s id
54196
+ * @param {DuplicateSavedReportDto} duplicateSavedReportDto
54197
+ * @param {*} [options] Override http request option.
54198
+ * @throws {RequiredError}
54199
+ */
54200
+ duplicateOrganisationSavedReport(groupId: string, reportId: string, duplicateSavedReportDto: DuplicateSavedReportDto, options?: any): AxiosPromise<SavedReportDto>;
54201
+ /**
54202
+ * A private copy owned by the person, in the same store, under the name sent. Managers only.
54203
+ * @summary Copy a saved report of a store
54204
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54205
+ * @param {string} reportId The saved report\&#39;s id
54206
+ * @param {DuplicateSavedReportDto} duplicateSavedReportDto
54207
+ * @param {*} [options] Override http request option.
54208
+ * @throws {RequiredError}
54209
+ */
54210
+ duplicateStoreSavedReport(businessId: number, reportId: string, duplicateSavedReportDto: DuplicateSavedReportDto, options?: any): AxiosPromise<SavedReportDto>;
54211
+ /**
54212
+ * A report the person sees: their own, or one shared with the organisation.
54213
+ * @summary Read one saved report of a organisation
54214
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54215
+ * @param {string} reportId The saved report\&#39;s id
54216
+ * @param {*} [options] Override http request option.
54217
+ * @throws {RequiredError}
54218
+ */
54219
+ getOrganisationSavedReport(groupId: string, reportId: string, options?: any): AxiosPromise<SavedReportDto>;
54220
+ /**
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).
54222
+ * @summary Read a public report by its link
54223
+ * @param {string} token The public link\&#39;s token, 43 characters
54224
+ * @param {*} [options] Override http request option.
54225
+ * @throws {RequiredError}
54226
+ */
54227
+ getPublicSavedReport(token: string, options?: any): AxiosPromise<PublicSavedReportDto>;
54228
+ /**
54229
+ * A report the person sees: their own, or one shared with the store.
54230
+ * @summary Read one saved report of a store
54231
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54232
+ * @param {string} reportId The saved report\&#39;s id
54233
+ * @param {*} [options] Override http request option.
54234
+ * @throws {RequiredError}
54235
+ */
54236
+ getStoreSavedReport(businessId: number, reportId: string, options?: any): AxiosPromise<SavedReportDto>;
54237
+ /**
54238
+ * The person\'s own private reports and every report shared with the organisation, last saved first, a page at a time.
54239
+ * @summary List the saved reports the person sees of a organisation
54240
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54241
+ * @param {number} [limit] At most this many reports, 1 to 100. Absent: 50
54242
+ * @param {string} [after] The id of the last report of the page before; the list goes on after it
54243
+ * @param {*} [options] Override http request option.
54244
+ * @throws {RequiredError}
54245
+ */
54246
+ listOrganisationSavedReports(groupId: string, limit?: number, after?: string, options?: any): AxiosPromise<SavedReportListDto>;
54247
+ /**
54248
+ * The person\'s own private reports and every report shared with the store, last saved first, a page at a time.
54249
+ * @summary List the saved reports the person sees of a store
54250
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54251
+ * @param {number} [limit] At most this many reports, 1 to 100. Absent: 50
54252
+ * @param {string} [after] The id of the last report of the page before; the list goes on after it
54253
+ * @param {*} [options] Override http request option.
54254
+ * @throws {RequiredError}
54255
+ */
54256
+ listStoreSavedReports(businessId: number, limit?: number, after?: string, options?: any): AxiosPromise<SavedReportListDto>;
54257
+ /**
54258
+ * private, organisation, or public: a new link every time it is made public, and leaving public ends the link. Saved at the version read. Managers only.
54259
+ * @summary Set who sees a saved report of a organisation
54260
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54261
+ * @param {string} reportId The saved report\&#39;s id
54262
+ * @param {SetSavedReportVisibilityDto} setSavedReportVisibilityDto
54263
+ * @param {*} [options] Override http request option.
54264
+ * @throws {RequiredError}
54265
+ */
54266
+ setOrganisationSavedReportVisibility(groupId: string, reportId: string, setSavedReportVisibilityDto: SetSavedReportVisibilityDto, options?: any): AxiosPromise<SavedReportDto>;
54267
+ /**
54268
+ * private, organisation, or public: a new link every time it is made public, and leaving public ends the link. Saved at the version read. Managers only.
54269
+ * @summary Set who sees a saved report of a store
54270
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54271
+ * @param {string} reportId The saved report\&#39;s id
54272
+ * @param {SetSavedReportVisibilityDto} setSavedReportVisibilityDto
54273
+ * @param {*} [options] Override http request option.
54274
+ * @throws {RequiredError}
54275
+ */
54276
+ setStoreSavedReportVisibility(businessId: number, reportId: string, setSavedReportVisibilityDto: SetSavedReportVisibilityDto, options?: any): AxiosPromise<SavedReportDto>;
54277
+ /**
54278
+ * Saves at the version read; 409 when someone saved since. Managers only, on a report they see.
54279
+ * @summary Replace a saved report\'s name, cards and filters of a organisation
54280
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54281
+ * @param {string} reportId The saved report\&#39;s id
54282
+ * @param {UpdateSavedReportDto} updateSavedReportDto
54283
+ * @param {*} [options] Override http request option.
54284
+ * @throws {RequiredError}
54285
+ */
54286
+ updateOrganisationSavedReport(groupId: string, reportId: string, updateSavedReportDto: UpdateSavedReportDto, options?: any): AxiosPromise<SavedReportDto>;
54287
+ /**
54288
+ * Saves at the version read; 409 when someone saved since. Managers only, on a report they see.
54289
+ * @summary Replace a saved report\'s name, cards and filters of a store
54290
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54291
+ * @param {string} reportId The saved report\&#39;s id
54292
+ * @param {UpdateSavedReportDto} updateSavedReportDto
54293
+ * @param {*} [options] Override http request option.
54294
+ * @throws {RequiredError}
54295
+ */
54296
+ updateStoreSavedReport(businessId: number, reportId: string, updateSavedReportDto: UpdateSavedReportDto, options?: any): AxiosPromise<SavedReportDto>;
54297
+ };
54298
+ /**
54299
+ * SavedReportsApi - interface
54300
+ * @export
54301
+ * @interface SavedReportsApi
54302
+ */
54303
+ export interface SavedReportsApiInterface {
54304
+ /**
54305
+ * Saves a new report (side A) or comparison (sides A and B), owned by the person; private unless visibility says otherwise. Managers only.
54306
+ * @summary Save a report or a comparison of a organisation
54307
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54308
+ * @param {CreateSavedReportDto} createSavedReportDto
54309
+ * @param {*} [options] Override http request option.
54310
+ * @throws {RequiredError}
54311
+ * @memberof SavedReportsApiInterface
54312
+ */
54313
+ createOrganisationSavedReport(groupId: string, createSavedReportDto: CreateSavedReportDto, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
54314
+ /**
54315
+ * Saves a new report (side A) or comparison (sides A and B), owned by the person; private unless visibility says otherwise. Managers only.
54316
+ * @summary Save a report or a comparison of a store
54317
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54318
+ * @param {CreateSavedReportDto} createSavedReportDto
54319
+ * @param {*} [options] Override http request option.
54320
+ * @throws {RequiredError}
54321
+ * @memberof SavedReportsApiInterface
54322
+ */
54323
+ createStoreSavedReport(businessId: number, createSavedReportDto: CreateSavedReportDto, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
54324
+ /**
54325
+ * Deletes it with its schedule and past runs. Managers only, on a report they see.
54326
+ * @summary Delete a saved report of a organisation
54327
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54328
+ * @param {string} reportId The saved report\&#39;s id
54329
+ * @param {*} [options] Override http request option.
54330
+ * @throws {RequiredError}
54331
+ * @memberof SavedReportsApiInterface
54332
+ */
54333
+ deleteOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
54334
+ /**
54335
+ * Deletes it with its schedule and past runs. Managers only, on a report they see.
54336
+ * @summary Delete a saved report of a store
54337
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54338
+ * @param {string} reportId The saved report\&#39;s id
54339
+ * @param {*} [options] Override http request option.
54340
+ * @throws {RequiredError}
54341
+ * @memberof SavedReportsApiInterface
54342
+ */
54343
+ deleteStoreSavedReport(businessId: number, reportId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
54344
+ /**
54345
+ * A private copy owned by the person, in the same organisation, under the name sent. Managers only.
54346
+ * @summary Copy a saved report of a organisation
54347
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54348
+ * @param {string} reportId The saved report\&#39;s id
54349
+ * @param {DuplicateSavedReportDto} duplicateSavedReportDto
54350
+ * @param {*} [options] Override http request option.
54351
+ * @throws {RequiredError}
54352
+ * @memberof SavedReportsApiInterface
54353
+ */
54354
+ duplicateOrganisationSavedReport(groupId: string, reportId: string, duplicateSavedReportDto: DuplicateSavedReportDto, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
54355
+ /**
54356
+ * A private copy owned by the person, in the same store, under the name sent. Managers only.
54357
+ * @summary Copy a saved report of a store
54358
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54359
+ * @param {string} reportId The saved report\&#39;s id
54360
+ * @param {DuplicateSavedReportDto} duplicateSavedReportDto
54361
+ * @param {*} [options] Override http request option.
54362
+ * @throws {RequiredError}
54363
+ * @memberof SavedReportsApiInterface
54364
+ */
54365
+ duplicateStoreSavedReport(businessId: number, reportId: string, duplicateSavedReportDto: DuplicateSavedReportDto, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
54366
+ /**
54367
+ * A report the person sees: their own, or one shared with the organisation.
54368
+ * @summary Read one saved report of a organisation
54369
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54370
+ * @param {string} reportId The saved report\&#39;s id
54371
+ * @param {*} [options] Override http request option.
54372
+ * @throws {RequiredError}
54373
+ * @memberof SavedReportsApiInterface
54374
+ */
54375
+ getOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
54376
+ /**
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).
54378
+ * @summary Read a public report by its link
54379
+ * @param {string} token The public link\&#39;s token, 43 characters
54380
+ * @param {*} [options] Override http request option.
54381
+ * @throws {RequiredError}
54382
+ * @memberof SavedReportsApiInterface
54383
+ */
54384
+ getPublicSavedReport(token: string, options?: AxiosRequestConfig): AxiosPromise<PublicSavedReportDto>;
54385
+ /**
54386
+ * A report the person sees: their own, or one shared with the store.
54387
+ * @summary Read one saved report of a store
54388
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54389
+ * @param {string} reportId The saved report\&#39;s id
54390
+ * @param {*} [options] Override http request option.
54391
+ * @throws {RequiredError}
54392
+ * @memberof SavedReportsApiInterface
54393
+ */
54394
+ getStoreSavedReport(businessId: number, reportId: string, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
54395
+ /**
54396
+ * The person\'s own private reports and every report shared with the organisation, last saved first, a page at a time.
54397
+ * @summary List the saved reports the person sees of a organisation
54398
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54399
+ * @param {number} [limit] At most this many reports, 1 to 100. Absent: 50
54400
+ * @param {string} [after] The id of the last report of the page before; the list goes on after it
54401
+ * @param {*} [options] Override http request option.
54402
+ * @throws {RequiredError}
54403
+ * @memberof SavedReportsApiInterface
54404
+ */
54405
+ listOrganisationSavedReports(groupId: string, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<SavedReportListDto>;
54406
+ /**
54407
+ * The person\'s own private reports and every report shared with the store, last saved first, a page at a time.
54408
+ * @summary List the saved reports the person sees of a store
54409
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54410
+ * @param {number} [limit] At most this many reports, 1 to 100. Absent: 50
54411
+ * @param {string} [after] The id of the last report of the page before; the list goes on after it
54412
+ * @param {*} [options] Override http request option.
54413
+ * @throws {RequiredError}
54414
+ * @memberof SavedReportsApiInterface
54415
+ */
54416
+ listStoreSavedReports(businessId: number, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<SavedReportListDto>;
54417
+ /**
54418
+ * private, organisation, or public: a new link every time it is made public, and leaving public ends the link. Saved at the version read. Managers only.
54419
+ * @summary Set who sees a saved report of a organisation
54420
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54421
+ * @param {string} reportId The saved report\&#39;s id
54422
+ * @param {SetSavedReportVisibilityDto} setSavedReportVisibilityDto
54423
+ * @param {*} [options] Override http request option.
54424
+ * @throws {RequiredError}
54425
+ * @memberof SavedReportsApiInterface
54426
+ */
54427
+ setOrganisationSavedReportVisibility(groupId: string, reportId: string, setSavedReportVisibilityDto: SetSavedReportVisibilityDto, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
54428
+ /**
54429
+ * private, organisation, or public: a new link every time it is made public, and leaving public ends the link. Saved at the version read. Managers only.
54430
+ * @summary Set who sees a saved report of a store
54431
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54432
+ * @param {string} reportId The saved report\&#39;s id
54433
+ * @param {SetSavedReportVisibilityDto} setSavedReportVisibilityDto
54434
+ * @param {*} [options] Override http request option.
54435
+ * @throws {RequiredError}
54436
+ * @memberof SavedReportsApiInterface
54437
+ */
54438
+ setStoreSavedReportVisibility(businessId: number, reportId: string, setSavedReportVisibilityDto: SetSavedReportVisibilityDto, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
54439
+ /**
54440
+ * Saves at the version read; 409 when someone saved since. Managers only, on a report they see.
54441
+ * @summary Replace a saved report\'s name, cards and filters of a organisation
54442
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54443
+ * @param {string} reportId The saved report\&#39;s id
54444
+ * @param {UpdateSavedReportDto} updateSavedReportDto
54445
+ * @param {*} [options] Override http request option.
54446
+ * @throws {RequiredError}
54447
+ * @memberof SavedReportsApiInterface
54448
+ */
54449
+ updateOrganisationSavedReport(groupId: string, reportId: string, updateSavedReportDto: UpdateSavedReportDto, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
54450
+ /**
54451
+ * Saves at the version read; 409 when someone saved since. Managers only, on a report they see.
54452
+ * @summary Replace a saved report\'s name, cards and filters of a store
54453
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54454
+ * @param {string} reportId The saved report\&#39;s id
54455
+ * @param {UpdateSavedReportDto} updateSavedReportDto
54456
+ * @param {*} [options] Override http request option.
54457
+ * @throws {RequiredError}
54458
+ * @memberof SavedReportsApiInterface
54459
+ */
54460
+ updateStoreSavedReport(businessId: number, reportId: string, updateSavedReportDto: UpdateSavedReportDto, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
54461
+ }
54462
+ /**
54463
+ * SavedReportsApi - object-oriented interface
54464
+ * @export
54465
+ * @class SavedReportsApi
54466
+ * @extends {BaseAPI}
54467
+ */
54468
+ export declare class SavedReportsApi extends BaseAPI implements SavedReportsApiInterface {
54469
+ /**
54470
+ * Saves a new report (side A) or comparison (sides A and B), owned by the person; private unless visibility says otherwise. Managers only.
54471
+ * @summary Save a report or a comparison of a organisation
54472
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54473
+ * @param {CreateSavedReportDto} createSavedReportDto
54474
+ * @param {*} [options] Override http request option.
54475
+ * @throws {RequiredError}
54476
+ * @memberof SavedReportsApi
54477
+ */
54478
+ createOrganisationSavedReport(groupId: string, createSavedReportDto: CreateSavedReportDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
54479
+ /**
54480
+ * Saves a new report (side A) or comparison (sides A and B), owned by the person; private unless visibility says otherwise. Managers only.
54481
+ * @summary Save a report or a comparison of a store
54482
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54483
+ * @param {CreateSavedReportDto} createSavedReportDto
54484
+ * @param {*} [options] Override http request option.
54485
+ * @throws {RequiredError}
54486
+ * @memberof SavedReportsApi
54487
+ */
54488
+ createStoreSavedReport(businessId: number, createSavedReportDto: CreateSavedReportDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
54489
+ /**
54490
+ * Deletes it with its schedule and past runs. Managers only, on a report they see.
54491
+ * @summary Delete a saved report of a organisation
54492
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54493
+ * @param {string} reportId The saved report\&#39;s id
54494
+ * @param {*} [options] Override http request option.
54495
+ * @throws {RequiredError}
54496
+ * @memberof SavedReportsApi
54497
+ */
54498
+ deleteOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
54499
+ /**
54500
+ * Deletes it with its schedule and past runs. Managers only, on a report they see.
54501
+ * @summary Delete a saved report of a store
54502
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54503
+ * @param {string} reportId The saved report\&#39;s id
54504
+ * @param {*} [options] Override http request option.
54505
+ * @throws {RequiredError}
54506
+ * @memberof SavedReportsApi
54507
+ */
54508
+ deleteStoreSavedReport(businessId: number, reportId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
54509
+ /**
54510
+ * A private copy owned by the person, in the same organisation, under the name sent. Managers only.
54511
+ * @summary Copy a saved report of a organisation
54512
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54513
+ * @param {string} reportId The saved report\&#39;s id
54514
+ * @param {DuplicateSavedReportDto} duplicateSavedReportDto
54515
+ * @param {*} [options] Override http request option.
54516
+ * @throws {RequiredError}
54517
+ * @memberof SavedReportsApi
54518
+ */
54519
+ duplicateOrganisationSavedReport(groupId: string, reportId: string, duplicateSavedReportDto: DuplicateSavedReportDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
54520
+ /**
54521
+ * A private copy owned by the person, in the same store, under the name sent. Managers only.
54522
+ * @summary Copy a saved report of a store
54523
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54524
+ * @param {string} reportId The saved report\&#39;s id
54525
+ * @param {DuplicateSavedReportDto} duplicateSavedReportDto
54526
+ * @param {*} [options] Override http request option.
54527
+ * @throws {RequiredError}
54528
+ * @memberof SavedReportsApi
54529
+ */
54530
+ duplicateStoreSavedReport(businessId: number, reportId: string, duplicateSavedReportDto: DuplicateSavedReportDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
54531
+ /**
54532
+ * A report the person sees: their own, or one shared with the organisation.
54533
+ * @summary Read one saved report of a organisation
54534
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54535
+ * @param {string} reportId The saved report\&#39;s id
54536
+ * @param {*} [options] Override http request option.
54537
+ * @throws {RequiredError}
54538
+ * @memberof SavedReportsApi
54539
+ */
54540
+ getOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
54541
+ /**
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).
54543
+ * @summary Read a public report by its link
54544
+ * @param {string} token The public link\&#39;s token, 43 characters
54545
+ * @param {*} [options] Override http request option.
54546
+ * @throws {RequiredError}
54547
+ * @memberof SavedReportsApi
54548
+ */
54549
+ getPublicSavedReport(token: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicSavedReportDto, any, {}>>;
54550
+ /**
54551
+ * A report the person sees: their own, or one shared with the store.
54552
+ * @summary Read one saved report of a store
54553
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54554
+ * @param {string} reportId The saved report\&#39;s id
54555
+ * @param {*} [options] Override http request option.
54556
+ * @throws {RequiredError}
54557
+ * @memberof SavedReportsApi
54558
+ */
54559
+ getStoreSavedReport(businessId: number, reportId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
54560
+ /**
54561
+ * The person\'s own private reports and every report shared with the organisation, last saved first, a page at a time.
54562
+ * @summary List the saved reports the person sees of a organisation
54563
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54564
+ * @param {number} [limit] At most this many reports, 1 to 100. Absent: 50
54565
+ * @param {string} [after] The id of the last report of the page before; the list goes on after it
54566
+ * @param {*} [options] Override http request option.
54567
+ * @throws {RequiredError}
54568
+ * @memberof SavedReportsApi
54569
+ */
54570
+ listOrganisationSavedReports(groupId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportListDto, any, {}>>;
54571
+ /**
54572
+ * The person\'s own private reports and every report shared with the store, last saved first, a page at a time.
54573
+ * @summary List the saved reports the person sees of a store
54574
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54575
+ * @param {number} [limit] At most this many reports, 1 to 100. Absent: 50
54576
+ * @param {string} [after] The id of the last report of the page before; the list goes on after it
54577
+ * @param {*} [options] Override http request option.
54578
+ * @throws {RequiredError}
54579
+ * @memberof SavedReportsApi
54580
+ */
54581
+ listStoreSavedReports(businessId: number, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportListDto, any, {}>>;
54582
+ /**
54583
+ * private, organisation, or public: a new link every time it is made public, and leaving public ends the link. Saved at the version read. Managers only.
54584
+ * @summary Set who sees a saved report of a organisation
54585
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54586
+ * @param {string} reportId The saved report\&#39;s id
54587
+ * @param {SetSavedReportVisibilityDto} setSavedReportVisibilityDto
54588
+ * @param {*} [options] Override http request option.
54589
+ * @throws {RequiredError}
54590
+ * @memberof SavedReportsApi
54591
+ */
54592
+ setOrganisationSavedReportVisibility(groupId: string, reportId: string, setSavedReportVisibilityDto: SetSavedReportVisibilityDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
54593
+ /**
54594
+ * private, organisation, or public: a new link every time it is made public, and leaving public ends the link. Saved at the version read. Managers only.
54595
+ * @summary Set who sees a saved report of a store
54596
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54597
+ * @param {string} reportId The saved report\&#39;s id
54598
+ * @param {SetSavedReportVisibilityDto} setSavedReportVisibilityDto
54599
+ * @param {*} [options] Override http request option.
54600
+ * @throws {RequiredError}
54601
+ * @memberof SavedReportsApi
54602
+ */
54603
+ setStoreSavedReportVisibility(businessId: number, reportId: string, setSavedReportVisibilityDto: SetSavedReportVisibilityDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
54604
+ /**
54605
+ * Saves at the version read; 409 when someone saved since. Managers only, on a report they see.
54606
+ * @summary Replace a saved report\'s name, cards and filters of a organisation
54607
+ * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
54608
+ * @param {string} reportId The saved report\&#39;s id
54609
+ * @param {UpdateSavedReportDto} updateSavedReportDto
54610
+ * @param {*} [options] Override http request option.
54611
+ * @throws {RequiredError}
54612
+ * @memberof SavedReportsApi
54613
+ */
54614
+ updateOrganisationSavedReport(groupId: string, reportId: string, updateSavedReportDto: UpdateSavedReportDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
54615
+ /**
54616
+ * Saves at the version read; 409 when someone saved since. Managers only, on a report they see.
54617
+ * @summary Replace a saved report\'s name, cards and filters of a store
54618
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54619
+ * @param {string} reportId The saved report\&#39;s id
54620
+ * @param {UpdateSavedReportDto} updateSavedReportDto
54621
+ * @param {*} [options] Override http request option.
54622
+ * @throws {RequiredError}
54623
+ * @memberof SavedReportsApi
54624
+ */
54625
+ updateStoreSavedReport(businessId: number, reportId: string, updateSavedReportDto: UpdateSavedReportDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedReportDto, any, {}>>;
54626
+ }
51375
54627
  /**
51376
54628
  * ShiftTrackingApi - axios parameter creator
51377
54629
  * @export