@munchi_oy/core 2.3.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/generated/api.ts CHANGED
@@ -24140,6 +24140,686 @@ export const PubSubTarget = {
24140
24140
  export type PubSubTarget = typeof PubSubTarget[keyof typeof PubSubTarget];
24141
24141
 
24142
24142
 
24143
+ /**
24144
+ *
24145
+ * @export
24146
+ * @interface PublicReportHoursDto
24147
+ */
24148
+ export interface PublicReportHoursDto {
24149
+ /**
24150
+ *
24151
+ * @type {PublicReportHoursDtoPeriod}
24152
+ * @memberof PublicReportHoursDto
24153
+ */
24154
+ 'period': PublicReportHoursDtoPeriod;
24155
+ /**
24156
+ *
24157
+ * @type {PublicReportHoursDtoToday}
24158
+ * @memberof PublicReportHoursDto
24159
+ */
24160
+ 'today': PublicReportHoursDtoToday;
24161
+ /**
24162
+ *
24163
+ * @type {PublicReportHoursDtoNormal}
24164
+ * @memberof PublicReportHoursDto
24165
+ */
24166
+ 'normal': PublicReportHoursDtoNormal;
24167
+ }
24168
+ /**
24169
+ * A normal day: today\'s weekday over the 8 weeks before today, averaged per hour (isoWeekday)
24170
+ * @export
24171
+ * @interface PublicReportHoursDtoNormal
24172
+ */
24173
+ export interface PublicReportHoursDtoNormal {
24174
+ /**
24175
+ * The first instant of the period, ISO 8601 in UTC
24176
+ * @type {string}
24177
+ * @memberof PublicReportHoursDtoNormal
24178
+ */
24179
+ 'reportDateStart': string;
24180
+ /**
24181
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
24182
+ * @type {string}
24183
+ * @memberof PublicReportHoursDtoNormal
24184
+ */
24185
+ 'reportDateEnd': string;
24186
+ /**
24187
+ * The IANA time zone the period\'s days are read in
24188
+ * @type {string}
24189
+ * @memberof PublicReportHoursDtoNormal
24190
+ */
24191
+ 'timezone': string;
24192
+ /**
24193
+ * The first business day, YYYY-MM-DD
24194
+ * @type {string}
24195
+ * @memberof PublicReportHoursDtoNormal
24196
+ */
24197
+ 'firstBusinessDay': string;
24198
+ /**
24199
+ * The last business day, YYYY-MM-DD, inclusive
24200
+ * @type {string}
24201
+ * @memberof PublicReportHoursDtoNormal
24202
+ */
24203
+ 'lastBusinessDay': string;
24204
+ /**
24205
+ * The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
24206
+ * @type {number}
24207
+ * @memberof PublicReportHoursDtoNormal
24208
+ */
24209
+ 'isoWeekday': number | null;
24210
+ /**
24211
+ * 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
24212
+ * @type {number}
24213
+ * @memberof PublicReportHoursDtoNormal
24214
+ */
24215
+ 'daysCounted': number;
24216
+ /**
24217
+ * The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
24218
+ * @type {string}
24219
+ * @memberof PublicReportHoursDtoNormal
24220
+ */
24221
+ 'dataUntil': string | null;
24222
+ /**
24223
+ * One group per venue, app and currency the breakdown keeps
24224
+ * @type {Array<SalesReportHoursGroupDto>}
24225
+ * @memberof PublicReportHoursDtoNormal
24226
+ */
24227
+ 'groups': Array<SalesReportHoursGroupDto>;
24228
+ }
24229
+ /**
24230
+ * The period\'s hours
24231
+ * @export
24232
+ * @interface PublicReportHoursDtoPeriod
24233
+ */
24234
+ export interface PublicReportHoursDtoPeriod {
24235
+ /**
24236
+ * The first instant of the period, ISO 8601 in UTC
24237
+ * @type {string}
24238
+ * @memberof PublicReportHoursDtoPeriod
24239
+ */
24240
+ 'reportDateStart': string;
24241
+ /**
24242
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
24243
+ * @type {string}
24244
+ * @memberof PublicReportHoursDtoPeriod
24245
+ */
24246
+ 'reportDateEnd': string;
24247
+ /**
24248
+ * The IANA time zone the period\'s days are read in
24249
+ * @type {string}
24250
+ * @memberof PublicReportHoursDtoPeriod
24251
+ */
24252
+ 'timezone': string;
24253
+ /**
24254
+ * The first business day, YYYY-MM-DD
24255
+ * @type {string}
24256
+ * @memberof PublicReportHoursDtoPeriod
24257
+ */
24258
+ 'firstBusinessDay': string;
24259
+ /**
24260
+ * The last business day, YYYY-MM-DD, inclusive
24261
+ * @type {string}
24262
+ * @memberof PublicReportHoursDtoPeriod
24263
+ */
24264
+ 'lastBusinessDay': string;
24265
+ /**
24266
+ * The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
24267
+ * @type {number}
24268
+ * @memberof PublicReportHoursDtoPeriod
24269
+ */
24270
+ 'isoWeekday': number | null;
24271
+ /**
24272
+ * 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
24273
+ * @type {number}
24274
+ * @memberof PublicReportHoursDtoPeriod
24275
+ */
24276
+ 'daysCounted': number;
24277
+ /**
24278
+ * The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
24279
+ * @type {string}
24280
+ * @memberof PublicReportHoursDtoPeriod
24281
+ */
24282
+ 'dataUntil': string | null;
24283
+ /**
24284
+ * One group per venue, app and currency the breakdown keeps
24285
+ * @type {Array<SalesReportHoursGroupDto>}
24286
+ * @memberof PublicReportHoursDtoPeriod
24287
+ */
24288
+ 'groups': Array<SalesReportHoursGroupDto>;
24289
+ }
24290
+ /**
24291
+ * Today\'s hours on the side\'s clock, so far
24292
+ * @export
24293
+ * @interface PublicReportHoursDtoToday
24294
+ */
24295
+ export interface PublicReportHoursDtoToday {
24296
+ /**
24297
+ * The first instant of the period, ISO 8601 in UTC
24298
+ * @type {string}
24299
+ * @memberof PublicReportHoursDtoToday
24300
+ */
24301
+ 'reportDateStart': string;
24302
+ /**
24303
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
24304
+ * @type {string}
24305
+ * @memberof PublicReportHoursDtoToday
24306
+ */
24307
+ 'reportDateEnd': string;
24308
+ /**
24309
+ * The IANA time zone the period\'s days are read in
24310
+ * @type {string}
24311
+ * @memberof PublicReportHoursDtoToday
24312
+ */
24313
+ 'timezone': string;
24314
+ /**
24315
+ * The first business day, YYYY-MM-DD
24316
+ * @type {string}
24317
+ * @memberof PublicReportHoursDtoToday
24318
+ */
24319
+ 'firstBusinessDay': string;
24320
+ /**
24321
+ * The last business day, YYYY-MM-DD, inclusive
24322
+ * @type {string}
24323
+ * @memberof PublicReportHoursDtoToday
24324
+ */
24325
+ 'lastBusinessDay': string;
24326
+ /**
24327
+ * The ISO weekday counted, 1 Monday to 7 Sunday, or null for every day
24328
+ * @type {number}
24329
+ * @memberof PublicReportHoursDtoToday
24330
+ */
24331
+ 'isoWeekday': number | null;
24332
+ /**
24333
+ * 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
24334
+ * @type {number}
24335
+ * @memberof PublicReportHoursDtoToday
24336
+ */
24337
+ 'daysCounted': number;
24338
+ /**
24339
+ * The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
24340
+ * @type {string}
24341
+ * @memberof PublicReportHoursDtoToday
24342
+ */
24343
+ 'dataUntil': string | null;
24344
+ /**
24345
+ * One group per venue, app and currency the breakdown keeps
24346
+ * @type {Array<SalesReportHoursGroupDto>}
24347
+ * @memberof PublicReportHoursDtoToday
24348
+ */
24349
+ 'groups': Array<SalesReportHoursGroupDto>;
24350
+ }
24351
+ /**
24352
+ *
24353
+ * @export
24354
+ * @interface PublicReportNumbersDto
24355
+ */
24356
+ export interface PublicReportNumbersDto {
24357
+ /**
24358
+ *
24359
+ * @type {PublicReportNumbersDtoA}
24360
+ * @memberof PublicReportNumbersDto
24361
+ */
24362
+ 'a': PublicReportNumbersDtoA | null;
24363
+ /**
24364
+ *
24365
+ * @type {PublicReportNumbersDtoB}
24366
+ * @memberof PublicReportNumbersDto
24367
+ */
24368
+ 'b'?: PublicReportNumbersDtoB | null;
24369
+ }
24370
+ /**
24371
+ * Side A\'s numbers; null when its stores are none of the report\'s own or it could not be read
24372
+ * @export
24373
+ * @interface PublicReportNumbersDtoA
24374
+ */
24375
+ export interface PublicReportNumbersDtoA {
24376
+ /**
24377
+ * 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
24378
+ * @type {Array<number>}
24379
+ * @memberof PublicReportNumbersDtoA
24380
+ */
24381
+ 'stores': Array<number>;
24382
+ /**
24383
+ *
24384
+ * @type {PublicReportSideNumbersDtoSales}
24385
+ * @memberof PublicReportNumbersDtoA
24386
+ */
24387
+ 'sales': PublicReportSideNumbersDtoSales;
24388
+ /**
24389
+ *
24390
+ * @type {PublicReportSideNumbersDtoTrend}
24391
+ * @memberof PublicReportNumbersDtoA
24392
+ */
24393
+ 'trend'?: PublicReportSideNumbersDtoTrend;
24394
+ /**
24395
+ *
24396
+ * @type {PublicReportSideNumbersDtoYear}
24397
+ * @memberof PublicReportNumbersDtoA
24398
+ */
24399
+ 'year'?: PublicReportSideNumbersDtoYear;
24400
+ /**
24401
+ *
24402
+ * @type {PublicReportSideNumbersDtoHours}
24403
+ * @memberof PublicReportNumbersDtoA
24404
+ */
24405
+ 'hours'?: PublicReportSideNumbersDtoHours;
24406
+ /**
24407
+ *
24408
+ * @type {PublicReportSideNumbersDtoBoughtTogether}
24409
+ * @memberof PublicReportNumbersDtoA
24410
+ */
24411
+ 'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
24412
+ /**
24413
+ *
24414
+ * @type {PublicReportSideNumbersDtoOrderTypes}
24415
+ * @memberof PublicReportNumbersDtoA
24416
+ */
24417
+ 'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
24418
+ }
24419
+ /**
24420
+ * A comparison\'s side B; absent for a report
24421
+ * @export
24422
+ * @interface PublicReportNumbersDtoB
24423
+ */
24424
+ export interface PublicReportNumbersDtoB {
24425
+ /**
24426
+ * 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
24427
+ * @type {Array<number>}
24428
+ * @memberof PublicReportNumbersDtoB
24429
+ */
24430
+ 'stores': Array<number>;
24431
+ /**
24432
+ *
24433
+ * @type {PublicReportSideNumbersDtoSales}
24434
+ * @memberof PublicReportNumbersDtoB
24435
+ */
24436
+ 'sales': PublicReportSideNumbersDtoSales;
24437
+ /**
24438
+ *
24439
+ * @type {PublicReportSideNumbersDtoTrend}
24440
+ * @memberof PublicReportNumbersDtoB
24441
+ */
24442
+ 'trend'?: PublicReportSideNumbersDtoTrend;
24443
+ /**
24444
+ *
24445
+ * @type {PublicReportSideNumbersDtoYear}
24446
+ * @memberof PublicReportNumbersDtoB
24447
+ */
24448
+ 'year'?: PublicReportSideNumbersDtoYear;
24449
+ /**
24450
+ *
24451
+ * @type {PublicReportSideNumbersDtoHours}
24452
+ * @memberof PublicReportNumbersDtoB
24453
+ */
24454
+ 'hours'?: PublicReportSideNumbersDtoHours;
24455
+ /**
24456
+ *
24457
+ * @type {PublicReportSideNumbersDtoBoughtTogether}
24458
+ * @memberof PublicReportNumbersDtoB
24459
+ */
24460
+ 'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
24461
+ /**
24462
+ *
24463
+ * @type {PublicReportSideNumbersDtoOrderTypes}
24464
+ * @memberof PublicReportNumbersDtoB
24465
+ */
24466
+ 'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
24467
+ }
24468
+ /**
24469
+ *
24470
+ * @export
24471
+ * @interface PublicReportSideNumbersDto
24472
+ */
24473
+ export interface PublicReportSideNumbersDto {
24474
+ /**
24475
+ * 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
24476
+ * @type {Array<number>}
24477
+ * @memberof PublicReportSideNumbersDto
24478
+ */
24479
+ 'stores': Array<number>;
24480
+ /**
24481
+ *
24482
+ * @type {PublicReportSideNumbersDtoSales}
24483
+ * @memberof PublicReportSideNumbersDto
24484
+ */
24485
+ 'sales': PublicReportSideNumbersDtoSales;
24486
+ /**
24487
+ *
24488
+ * @type {PublicReportSideNumbersDtoTrend}
24489
+ * @memberof PublicReportSideNumbersDto
24490
+ */
24491
+ 'trend'?: PublicReportSideNumbersDtoTrend;
24492
+ /**
24493
+ *
24494
+ * @type {PublicReportSideNumbersDtoYear}
24495
+ * @memberof PublicReportSideNumbersDto
24496
+ */
24497
+ 'year'?: PublicReportSideNumbersDtoYear;
24498
+ /**
24499
+ *
24500
+ * @type {PublicReportSideNumbersDtoHours}
24501
+ * @memberof PublicReportSideNumbersDto
24502
+ */
24503
+ 'hours'?: PublicReportSideNumbersDtoHours;
24504
+ /**
24505
+ *
24506
+ * @type {PublicReportSideNumbersDtoBoughtTogether}
24507
+ * @memberof PublicReportSideNumbersDto
24508
+ */
24509
+ 'boughtTogether'?: PublicReportSideNumbersDtoBoughtTogether;
24510
+ /**
24511
+ *
24512
+ * @type {PublicReportSideNumbersDtoOrderTypes}
24513
+ * @memberof PublicReportSideNumbersDto
24514
+ */
24515
+ 'orderTypes'?: PublicReportSideNumbersDtoOrderTypes;
24516
+ }
24517
+ /**
24518
+ * Items bought together, as GET /api/v6/report/sales/bought-together; only when a card shows them
24519
+ * @export
24520
+ * @interface PublicReportSideNumbersDtoBoughtTogether
24521
+ */
24522
+ export interface PublicReportSideNumbersDtoBoughtTogether {
24523
+ /**
24524
+ * The first instant of the period, ISO 8601 in UTC
24525
+ * @type {string}
24526
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
24527
+ */
24528
+ 'reportDateStart': string;
24529
+ /**
24530
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
24531
+ * @type {string}
24532
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
24533
+ */
24534
+ 'reportDateEnd': string;
24535
+ /**
24536
+ * The IANA time zone the period\'s days are read in
24537
+ * @type {string}
24538
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
24539
+ */
24540
+ 'timezone': string;
24541
+ /**
24542
+ * The first business day, YYYY-MM-DD
24543
+ * @type {string}
24544
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
24545
+ */
24546
+ 'firstBusinessDay': string;
24547
+ /**
24548
+ * The last business day, YYYY-MM-DD, inclusive
24549
+ * @type {string}
24550
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
24551
+ */
24552
+ 'lastBusinessDay': string;
24553
+ /**
24554
+ * The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
24555
+ * @type {string}
24556
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
24557
+ */
24558
+ 'dataUntil': string | null;
24559
+ /**
24560
+ * One group per venue, app and currency the breakdown keeps
24561
+ * @type {Array<SalesReportBoughtTogetherGroupDto>}
24562
+ * @memberof PublicReportSideNumbersDtoBoughtTogether
24563
+ */
24564
+ 'groups': Array<SalesReportBoughtTogetherGroupDto>;
24565
+ }
24566
+ /**
24567
+ * Sales per hour of the day, as GET /api/v6/report/sales/hours; only when a card shows hours
24568
+ * @export
24569
+ * @interface PublicReportSideNumbersDtoHours
24570
+ */
24571
+ export interface PublicReportSideNumbersDtoHours {
24572
+ /**
24573
+ *
24574
+ * @type {PublicReportHoursDtoPeriod}
24575
+ * @memberof PublicReportSideNumbersDtoHours
24576
+ */
24577
+ 'period': PublicReportHoursDtoPeriod;
24578
+ /**
24579
+ *
24580
+ * @type {PublicReportHoursDtoToday}
24581
+ * @memberof PublicReportSideNumbersDtoHours
24582
+ */
24583
+ 'today': PublicReportHoursDtoToday;
24584
+ /**
24585
+ *
24586
+ * @type {PublicReportHoursDtoNormal}
24587
+ * @memberof PublicReportSideNumbersDtoHours
24588
+ */
24589
+ 'normal': PublicReportHoursDtoNormal;
24590
+ }
24591
+ /**
24592
+ * Sales per order type, as GET /api/v6/report/sales/order-types; only when a card shows them
24593
+ * @export
24594
+ * @interface PublicReportSideNumbersDtoOrderTypes
24595
+ */
24596
+ export interface PublicReportSideNumbersDtoOrderTypes {
24597
+ /**
24598
+ * The first instant of the period, ISO 8601 in UTC
24599
+ * @type {string}
24600
+ * @memberof PublicReportSideNumbersDtoOrderTypes
24601
+ */
24602
+ 'reportDateStart': string;
24603
+ /**
24604
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
24605
+ * @type {string}
24606
+ * @memberof PublicReportSideNumbersDtoOrderTypes
24607
+ */
24608
+ 'reportDateEnd': string;
24609
+ /**
24610
+ * The IANA time zone the period\'s days are read in
24611
+ * @type {string}
24612
+ * @memberof PublicReportSideNumbersDtoOrderTypes
24613
+ */
24614
+ 'timezone': string;
24615
+ /**
24616
+ * The first business day, YYYY-MM-DD
24617
+ * @type {string}
24618
+ * @memberof PublicReportSideNumbersDtoOrderTypes
24619
+ */
24620
+ 'firstBusinessDay': string;
24621
+ /**
24622
+ * The last business day, YYYY-MM-DD, inclusive
24623
+ * @type {string}
24624
+ * @memberof PublicReportSideNumbersDtoOrderTypes
24625
+ */
24626
+ 'lastBusinessDay': string;
24627
+ /**
24628
+ * The newest BigQuery rebuild the rows read, ISO 8601 in UTC; null when none
24629
+ * @type {string}
24630
+ * @memberof PublicReportSideNumbersDtoOrderTypes
24631
+ */
24632
+ 'dataUntil': string | null;
24633
+ /**
24634
+ * One group per venue, app and currency the breakdown keeps
24635
+ * @type {Array<SalesReportOrderTypesGroupDto>}
24636
+ * @memberof PublicReportSideNumbersDtoOrderTypes
24637
+ */
24638
+ 'groups': Array<SalesReportOrderTypesGroupDto>;
24639
+ }
24640
+ /**
24641
+ * 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
24642
+ * @export
24643
+ * @interface PublicReportSideNumbersDtoSales
24644
+ */
24645
+ export interface PublicReportSideNumbersDtoSales {
24646
+ /**
24647
+ * The first instant of the period, ISO 8601 in UTC
24648
+ * @type {string}
24649
+ * @memberof PublicReportSideNumbersDtoSales
24650
+ */
24651
+ 'reportDateStart': string;
24652
+ /**
24653
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
24654
+ * @type {string}
24655
+ * @memberof PublicReportSideNumbersDtoSales
24656
+ */
24657
+ 'reportDateEnd': string;
24658
+ /**
24659
+ * When the report was answered, ISO 8601 in UTC
24660
+ * @type {string}
24661
+ * @memberof PublicReportSideNumbersDtoSales
24662
+ */
24663
+ 'reportGeneratedAt': string;
24664
+ /**
24665
+ * The time zone the period was read in: the request\'s, or else the first venue\'s
24666
+ * @type {string}
24667
+ * @memberof PublicReportSideNumbersDtoSales
24668
+ */
24669
+ 'timezone': string;
24670
+ /**
24671
+ * The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
24672
+ * @type {string}
24673
+ * @memberof PublicReportSideNumbersDtoSales
24674
+ */
24675
+ 'firstBusinessDay': string;
24676
+ /**
24677
+ * The last business day added up, YYYY-MM-DD, inclusive
24678
+ * @type {string}
24679
+ * @memberof PublicReportSideNumbersDtoSales
24680
+ */
24681
+ 'lastBusinessDay': string;
24682
+ /**
24683
+ * 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
24684
+ * @type {object}
24685
+ * @memberof PublicReportSideNumbersDtoSales
24686
+ */
24687
+ 'dataUntil': object | null;
24688
+ /**
24689
+ * One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
24690
+ * @type {Array<SalesReportGroupDto>}
24691
+ * @memberof PublicReportSideNumbersDtoSales
24692
+ */
24693
+ 'reports': Array<SalesReportGroupDto>;
24694
+ /**
24695
+ * 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
24696
+ * @type {Array<SalesReportGroupDto>}
24697
+ * @memberof PublicReportSideNumbersDtoSales
24698
+ */
24699
+ 'totals'?: Array<SalesReportGroupDto>;
24700
+ }
24701
+ /**
24702
+ * 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
24703
+ * @export
24704
+ * @interface PublicReportSideNumbersDtoTrend
24705
+ */
24706
+ export interface PublicReportSideNumbersDtoTrend {
24707
+ /**
24708
+ * The first instant of the period, ISO 8601 in UTC
24709
+ * @type {string}
24710
+ * @memberof PublicReportSideNumbersDtoTrend
24711
+ */
24712
+ 'reportDateStart': string;
24713
+ /**
24714
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
24715
+ * @type {string}
24716
+ * @memberof PublicReportSideNumbersDtoTrend
24717
+ */
24718
+ 'reportDateEnd': string;
24719
+ /**
24720
+ * When the report was answered, ISO 8601 in UTC
24721
+ * @type {string}
24722
+ * @memberof PublicReportSideNumbersDtoTrend
24723
+ */
24724
+ 'reportGeneratedAt': string;
24725
+ /**
24726
+ * The time zone the period was read in: the request\'s, or else the first venue\'s
24727
+ * @type {string}
24728
+ * @memberof PublicReportSideNumbersDtoTrend
24729
+ */
24730
+ 'timezone': string;
24731
+ /**
24732
+ * The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
24733
+ * @type {string}
24734
+ * @memberof PublicReportSideNumbersDtoTrend
24735
+ */
24736
+ 'firstBusinessDay': string;
24737
+ /**
24738
+ * The last business day added up, YYYY-MM-DD, inclusive
24739
+ * @type {string}
24740
+ * @memberof PublicReportSideNumbersDtoTrend
24741
+ */
24742
+ 'lastBusinessDay': string;
24743
+ /**
24744
+ * 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
24745
+ * @type {object}
24746
+ * @memberof PublicReportSideNumbersDtoTrend
24747
+ */
24748
+ 'dataUntil': object | null;
24749
+ /**
24750
+ * One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
24751
+ * @type {Array<SalesReportGroupDto>}
24752
+ * @memberof PublicReportSideNumbersDtoTrend
24753
+ */
24754
+ 'reports': Array<SalesReportGroupDto>;
24755
+ /**
24756
+ * 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
24757
+ * @type {Array<SalesReportGroupDto>}
24758
+ * @memberof PublicReportSideNumbersDtoTrend
24759
+ */
24760
+ 'totals'?: Array<SalesReportGroupDto>;
24761
+ }
24762
+ /**
24763
+ * The summary of the 26 weeks up to today, day by day; only when the report shows the year card
24764
+ * @export
24765
+ * @interface PublicReportSideNumbersDtoYear
24766
+ */
24767
+ export interface PublicReportSideNumbersDtoYear {
24768
+ /**
24769
+ * The first instant of the period, ISO 8601 in UTC
24770
+ * @type {string}
24771
+ * @memberof PublicReportSideNumbersDtoYear
24772
+ */
24773
+ 'reportDateStart': string;
24774
+ /**
24775
+ * The last instant of the period, ISO 8601 in UTC; now, when the period ends later
24776
+ * @type {string}
24777
+ * @memberof PublicReportSideNumbersDtoYear
24778
+ */
24779
+ 'reportDateEnd': string;
24780
+ /**
24781
+ * When the report was answered, ISO 8601 in UTC
24782
+ * @type {string}
24783
+ * @memberof PublicReportSideNumbersDtoYear
24784
+ */
24785
+ 'reportGeneratedAt': string;
24786
+ /**
24787
+ * The time zone the period was read in: the request\'s, or else the first venue\'s
24788
+ * @type {string}
24789
+ * @memberof PublicReportSideNumbersDtoYear
24790
+ */
24791
+ 'timezone': string;
24792
+ /**
24793
+ * The first business day added up, YYYY-MM-DD; each venue\'s rows of that date in its own zone
24794
+ * @type {string}
24795
+ * @memberof PublicReportSideNumbersDtoYear
24796
+ */
24797
+ 'firstBusinessDay': string;
24798
+ /**
24799
+ * The last business day added up, YYYY-MM-DD, inclusive
24800
+ * @type {string}
24801
+ * @memberof PublicReportSideNumbersDtoYear
24802
+ */
24803
+ 'lastBusinessDay': string;
24804
+ /**
24805
+ * 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
24806
+ * @type {object}
24807
+ * @memberof PublicReportSideNumbersDtoYear
24808
+ */
24809
+ 'dataUntil': object | null;
24810
+ /**
24811
+ * One group per venue, app and currency the breakdown keeps; an asked venue that sold nothing answers zeros
24812
+ * @type {Array<SalesReportGroupDto>}
24813
+ * @memberof PublicReportSideNumbersDtoYear
24814
+ */
24815
+ 'reports': Array<SalesReportGroupDto>;
24816
+ /**
24817
+ * 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
24818
+ * @type {Array<SalesReportGroupDto>}
24819
+ * @memberof PublicReportSideNumbersDtoYear
24820
+ */
24821
+ 'totals'?: Array<SalesReportGroupDto>;
24822
+ }
24143
24823
  /**
24144
24824
  *
24145
24825
  * @export
@@ -24188,9 +24868,34 @@ export interface PublicSavedReportDto {
24188
24868
  * @memberof PublicSavedReportDto
24189
24869
  */
24190
24870
  'updatedAt': string;
24871
+ /**
24872
+ *
24873
+ * @type {PublicSavedReportDtoNumbers}
24874
+ * @memberof PublicSavedReportDto
24875
+ */
24876
+ 'numbers': PublicSavedReportDtoNumbers | null;
24191
24877
  }
24192
24878
 
24193
24879
 
24880
+ /**
24881
+ * 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)
24882
+ * @export
24883
+ * @interface PublicSavedReportDtoNumbers
24884
+ */
24885
+ export interface PublicSavedReportDtoNumbers {
24886
+ /**
24887
+ *
24888
+ * @type {PublicReportNumbersDtoA}
24889
+ * @memberof PublicSavedReportDtoNumbers
24890
+ */
24891
+ 'a': PublicReportNumbersDtoA | null;
24892
+ /**
24893
+ *
24894
+ * @type {PublicReportNumbersDtoB}
24895
+ * @memberof PublicSavedReportDtoNumbers
24896
+ */
24897
+ 'b'?: PublicReportNumbersDtoB | null;
24898
+ }
24194
24899
  /**
24195
24900
  *
24196
24901
  * @export
@@ -24254,7 +24959,13 @@ export interface RankedCategoryDto {
24254
24959
  */
24255
24960
 
24256
24961
  export const ReadyMadeReport = {
24257
- Sales: 'sales'
24962
+ Sales: 'sales',
24963
+ ZReport: 'zReport',
24964
+ SalesVat: 'salesVat',
24965
+ Payments: 'payments',
24966
+ ProductSales: 'productSales',
24967
+ CashSessions: 'cashSessions',
24968
+ Staff: 'staff'
24258
24969
  } as const;
24259
24970
 
24260
24971
  export type ReadyMadeReport = typeof ReadyMadeReport[keyof typeof ReadyMadeReport];
@@ -64180,7 +64891,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
64180
64891
  * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
64181
64892
  * @summary Read when a store\'s ready-made report is emailed
64182
64893
  * @param {number} businessId The store\&#39;s orderingBusinessId
64183
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
64894
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
64184
64895
  * @param {*} [options] Override http request option.
64185
64896
  * @throws {RequiredError}
64186
64897
  */
@@ -64365,7 +65076,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
64365
65076
  * 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.
64366
65077
  * @summary List the past runs of a store\'s ready-made report
64367
65078
  * @param {number} businessId The store\&#39;s orderingBusinessId
64368
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65079
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
64369
65080
  * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
64370
65081
  * @param {string} [after] The id of the last run of the page before; the list goes on after it
64371
65082
  * @param {*} [options] Override http request option.
@@ -64466,7 +65177,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
64466
65177
  };
64467
65178
  },
64468
65179
  /**
64469
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65180
+ * 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.
64470
65181
  * @summary Set when an organisation\'s saved report is emailed
64471
65182
  * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
64472
65183
  * @param {string} reportId The saved report\&#39;s id
@@ -64514,10 +65225,10 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
64514
65225
  };
64515
65226
  },
64516
65227
  /**
64517
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65228
+ * 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.
64518
65229
  * @summary Set when a store\'s ready-made report is emailed
64519
65230
  * @param {number} businessId The store\&#39;s orderingBusinessId
64520
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65231
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
64521
65232
  * @param {SetReportScheduleDto} setReportScheduleDto
64522
65233
  * @param {*} [options] Override http request option.
64523
65234
  * @throws {RequiredError}
@@ -64562,7 +65273,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
64562
65273
  };
64563
65274
  },
64564
65275
  /**
64565
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65276
+ * 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.
64566
65277
  * @summary Set when a store\'s saved report is emailed
64567
65278
  * @param {number} businessId The store\&#39;s orderingBusinessId
64568
65279
  * @param {string} reportId The saved report\&#39;s id
@@ -64659,7 +65370,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
64659
65370
  * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
64660
65371
  * @summary Read when a store\'s ready-made report is emailed
64661
65372
  * @param {number} businessId The store\&#39;s orderingBusinessId
64662
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65373
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
64663
65374
  * @param {*} [options] Override http request option.
64664
65375
  * @throws {RequiredError}
64665
65376
  */
@@ -64710,7 +65421,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
64710
65421
  * 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.
64711
65422
  * @summary List the past runs of a store\'s ready-made report
64712
65423
  * @param {number} businessId The store\&#39;s orderingBusinessId
64713
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65424
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
64714
65425
  * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
64715
65426
  * @param {string} [after] The id of the last run of the page before; the list goes on after it
64716
65427
  * @param {*} [options] Override http request option.
@@ -64735,7 +65446,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
64735
65446
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
64736
65447
  },
64737
65448
  /**
64738
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65449
+ * 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.
64739
65450
  * @summary Set when an organisation\'s saved report is emailed
64740
65451
  * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
64741
65452
  * @param {string} reportId The saved report\&#39;s id
@@ -64748,10 +65459,10 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
64748
65459
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
64749
65460
  },
64750
65461
  /**
64751
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65462
+ * 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.
64752
65463
  * @summary Set when a store\'s ready-made report is emailed
64753
65464
  * @param {number} businessId The store\&#39;s orderingBusinessId
64754
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65465
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
64755
65466
  * @param {SetReportScheduleDto} setReportScheduleDto
64756
65467
  * @param {*} [options] Override http request option.
64757
65468
  * @throws {RequiredError}
@@ -64761,7 +65472,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
64761
65472
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
64762
65473
  },
64763
65474
  /**
64764
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65475
+ * 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.
64765
65476
  * @summary Set when a store\'s saved report is emailed
64766
65477
  * @param {number} businessId The store\&#39;s orderingBusinessId
64767
65478
  * @param {string} reportId The saved report\&#39;s id
@@ -64820,7 +65531,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
64820
65531
  * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
64821
65532
  * @summary Read when a store\'s ready-made report is emailed
64822
65533
  * @param {number} businessId The store\&#39;s orderingBusinessId
64823
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65534
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
64824
65535
  * @param {*} [options] Override http request option.
64825
65536
  * @throws {RequiredError}
64826
65537
  */
@@ -64867,7 +65578,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
64867
65578
  * 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.
64868
65579
  * @summary List the past runs of a store\'s ready-made report
64869
65580
  * @param {number} businessId The store\&#39;s orderingBusinessId
64870
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65581
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
64871
65582
  * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
64872
65583
  * @param {string} [after] The id of the last run of the page before; the list goes on after it
64873
65584
  * @param {*} [options] Override http request option.
@@ -64890,7 +65601,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
64890
65601
  return localVarFp.listStoreSavedReportRuns(businessId, reportId, limit, after, options).then((request) => request(axios, basePath));
64891
65602
  },
64892
65603
  /**
64893
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65604
+ * 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.
64894
65605
  * @summary Set when an organisation\'s saved report is emailed
64895
65606
  * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
64896
65607
  * @param {string} reportId The saved report\&#39;s id
@@ -64902,10 +65613,10 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
64902
65613
  return localVarFp.setOrganisationSavedReportSchedule(groupId, reportId, setReportScheduleDto, options).then((request) => request(axios, basePath));
64903
65614
  },
64904
65615
  /**
64905
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65616
+ * 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.
64906
65617
  * @summary Set when a store\'s ready-made report is emailed
64907
65618
  * @param {number} businessId The store\&#39;s orderingBusinessId
64908
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65619
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
64909
65620
  * @param {SetReportScheduleDto} setReportScheduleDto
64910
65621
  * @param {*} [options] Override http request option.
64911
65622
  * @throws {RequiredError}
@@ -64914,7 +65625,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
64914
65625
  return localVarFp.setStoreReadyMadeReportSchedule(businessId, readyMadeReport, setReportScheduleDto, options).then((request) => request(axios, basePath));
64915
65626
  },
64916
65627
  /**
64917
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65628
+ * 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.
64918
65629
  * @summary Set when a store\'s saved report is emailed
64919
65630
  * @param {number} businessId The store\&#39;s orderingBusinessId
64920
65631
  * @param {string} reportId The saved report\&#39;s id
@@ -64971,7 +65682,7 @@ export interface ReportSchedulesApiInterface {
64971
65682
  * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
64972
65683
  * @summary Read when a store\'s ready-made report is emailed
64973
65684
  * @param {number} businessId The store\&#39;s orderingBusinessId
64974
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65685
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
64975
65686
  * @param {*} [options] Override http request option.
64976
65687
  * @throws {RequiredError}
64977
65688
  * @memberof ReportSchedulesApiInterface
@@ -65018,7 +65729,7 @@ export interface ReportSchedulesApiInterface {
65018
65729
  * 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.
65019
65730
  * @summary List the past runs of a store\'s ready-made report
65020
65731
  * @param {number} businessId The store\&#39;s orderingBusinessId
65021
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65732
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
65022
65733
  * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
65023
65734
  * @param {string} [after] The id of the last run of the page before; the list goes on after it
65024
65735
  * @param {*} [options] Override http request option.
@@ -65041,7 +65752,7 @@ export interface ReportSchedulesApiInterface {
65041
65752
  listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<ReportRunListDto>;
65042
65753
 
65043
65754
  /**
65044
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65755
+ * 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.
65045
65756
  * @summary Set when an organisation\'s saved report is emailed
65046
65757
  * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
65047
65758
  * @param {string} reportId The saved report\&#39;s id
@@ -65053,10 +65764,10 @@ export interface ReportSchedulesApiInterface {
65053
65764
  setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
65054
65765
 
65055
65766
  /**
65056
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65767
+ * 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.
65057
65768
  * @summary Set when a store\'s ready-made report is emailed
65058
65769
  * @param {number} businessId The store\&#39;s orderingBusinessId
65059
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65770
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
65060
65771
  * @param {SetReportScheduleDto} setReportScheduleDto
65061
65772
  * @param {*} [options] Override http request option.
65062
65773
  * @throws {RequiredError}
@@ -65065,7 +65776,7 @@ export interface ReportSchedulesApiInterface {
65065
65776
  setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
65066
65777
 
65067
65778
  /**
65068
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65779
+ * 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.
65069
65780
  * @summary Set when a store\'s saved report is emailed
65070
65781
  * @param {number} businessId The store\&#39;s orderingBusinessId
65071
65782
  * @param {string} reportId The saved report\&#39;s id
@@ -65128,7 +65839,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
65128
65839
  * Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
65129
65840
  * @summary Read when a store\'s ready-made report is emailed
65130
65841
  * @param {number} businessId The store\&#39;s orderingBusinessId
65131
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65842
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
65132
65843
  * @param {*} [options] Override http request option.
65133
65844
  * @throws {RequiredError}
65134
65845
  * @memberof ReportSchedulesApi
@@ -65183,7 +65894,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
65183
65894
  * 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.
65184
65895
  * @summary List the past runs of a store\'s ready-made report
65185
65896
  * @param {number} businessId The store\&#39;s orderingBusinessId
65186
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65897
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
65187
65898
  * @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
65188
65899
  * @param {string} [after] The id of the last run of the page before; the list goes on after it
65189
65900
  * @param {*} [options] Override http request option.
@@ -65210,7 +65921,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
65210
65921
  }
65211
65922
 
65212
65923
  /**
65213
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65924
+ * 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.
65214
65925
  * @summary Set when an organisation\'s saved report is emailed
65215
65926
  * @param {string} groupId The organisation\&#39;s id: its group\&#39;s accountId in the licence server
65216
65927
  * @param {string} reportId The saved report\&#39;s id
@@ -65224,10 +65935,10 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
65224
65935
  }
65225
65936
 
65226
65937
  /**
65227
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65938
+ * 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.
65228
65939
  * @summary Set when a store\'s ready-made report is emailed
65229
65940
  * @param {number} businessId The store\&#39;s orderingBusinessId
65230
- * @param {ReadyMadeReport} readyMadeReport The ready-made report
65941
+ * @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\&#39;s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
65231
65942
  * @param {SetReportScheduleDto} setReportScheduleDto
65232
65943
  * @param {*} [options] Override http request option.
65233
65944
  * @throws {RequiredError}
@@ -65238,7 +65949,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
65238
65949
  }
65239
65950
 
65240
65951
  /**
65241
- * Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its PDF and Excel files) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
65952
+ * 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.
65242
65953
  * @summary Set when a store\'s saved report is emailed
65243
65954
  * @param {number} businessId The store\&#39;s orderingBusinessId
65244
65955
  * @param {string} reportId The saved report\&#39;s id
@@ -67454,7 +68165,7 @@ export const SavedReportsApiAxiosParamCreator = function (configuration?: Config
67454
68165
  };
67455
68166
  },
67456
68167
  /**
67457
- * No sign-in. The report\'s name, kind, cards and filters, and the store or organisation whose data it reads; never its data, whose reads stay behind sign-in. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
68168
+ * 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).
67458
68169
  * @summary Read a public report by its link
67459
68170
  * @param {string} token The public link\&#39;s token, 43 characters
67460
68171
  * @param {*} [options] Override http request option.
@@ -67914,7 +68625,7 @@ export const SavedReportsApiFp = function(configuration?: Configuration) {
67914
68625
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
67915
68626
  },
67916
68627
  /**
67917
- * No sign-in. The report\'s name, kind, cards and filters, and the store or organisation whose data it reads; never its data, whose reads stay behind sign-in. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
68628
+ * 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).
67918
68629
  * @summary Read a public report by its link
67919
68630
  * @param {string} token The public link\&#39;s token, 43 characters
67920
68631
  * @param {*} [options] Override http request option.
@@ -68104,7 +68815,7 @@ export const SavedReportsApiFactory = function (configuration?: Configuration, b
68104
68815
  return localVarFp.getOrganisationSavedReport(groupId, reportId, options).then((request) => request(axios, basePath));
68105
68816
  },
68106
68817
  /**
68107
- * No sign-in. The report\'s name, kind, cards and filters, and the store or organisation whose data it reads; never its data, whose reads stay behind sign-in. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
68818
+ * 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).
68108
68819
  * @summary Read a public report by its link
68109
68820
  * @param {string} token The public link\&#39;s token, 43 characters
68110
68821
  * @param {*} [options] Override http request option.
@@ -68285,7 +68996,7 @@ export interface SavedReportsApiInterface {
68285
68996
  getOrganisationSavedReport(groupId: string, reportId: string, options?: AxiosRequestConfig): AxiosPromise<SavedReportDto>;
68286
68997
 
68287
68998
  /**
68288
- * No sign-in. The report\'s name, kind, cards and filters, and the store or organisation whose data it reads; never its data, whose reads stay behind sign-in. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
68999
+ * 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).
68289
69000
  * @summary Read a public report by its link
68290
69001
  * @param {string} token The public link\&#39;s token, 43 characters
68291
69002
  * @param {*} [options] Override http request option.
@@ -68480,7 +69191,7 @@ export class SavedReportsApi extends BaseAPI implements SavedReportsApiInterface
68480
69191
  }
68481
69192
 
68482
69193
  /**
68483
- * No sign-in. The report\'s name, kind, cards and filters, and the store or organisation whose data it reads; never its data, whose reads stay behind sign-in. 404 when no report is public under that token (never made public, made private again, or published again with a new link).
69194
+ * 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).
68484
69195
  * @summary Read a public report by its link
68485
69196
  * @param {string} token The public link\&#39;s token, 43 characters
68486
69197
  * @param {*} [options] Override http request option.